/ fm / liveswitch / EncodingInfo

Class: EncodingInfo

fm.liveswitch.EncodingInfo

Encoding information.

Hierarchy

• Info

  ↳ EncodingInfo

Table of contents

Constructors

• constructor

Methods

• deserializeProperties
• fmliveswitchEncodingInfoInit
• getBitrate
• getDeactivated
• getFrameRate
• getHeight
• getId
• getIsEmpty
• getRtpStreamId
• getScale
• getScaledHeight
• getScaledSize
• getScaledWidth
• getSize
• getSynchronizationSource
• getTypeString
• getWidth
• isEquivalent
• serializeProperties
• setBitrate
• setDeactivated
• setFrameRate
• setId
• setRtpStreamId
• setScale
• setSize
• setSynchronizationSource
• toJson
• toSdpRidAttribute
• toString
• fromJson
• fromJsonArray
• fromSdpRidAttribute
• isEquivalent
• max
• min
• processArray
• processBoolean
• processBooleanArray
• processDouble
• processFloat
• processFloatArray
• processInteger
• processIntegerArray
• processLong
• processLongArray
• processObject
• processShort
• processShortArray
• processString
• toJson
• toJsonArray
• toSdpRidAttribute

Constructors

constructor

+ new EncodingInfo(): EncodingInfo

Returns: EncodingInfo

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:37

Methods

deserializeProperties

▸ ProtecteddeserializeProperties(key: string, valueJson: string): void

Deserializes the properties.

Parameters:

Name	Type	Description
key	string	The key.
valueJson	string	The value in JSON format.

Returns: void

Overrides: Info

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:441

---

fmliveswitchEncodingInfoInit

▸ PrivatefmliveswitchEncodingInfoInit(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:30

---

getBitrate

▸ getBitrate(): number

Gets the bitrate, in kbps.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:501

---

getDeactivated

▸ getDeactivated(): boolean

Gets whether this encoding is deactivated.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:513

---

getFrameRate

▸ getFrameRate(): number

Gets the frame-rate, in fps.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:525

---

getHeight

▸ getHeight(): number

Gets the height.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:537

---

getId

▸ getId(): string

Gets the identifier.

Returns: string

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:336

---

getIsEmpty

▸ getIsEmpty(): boolean

Gets whether this encoding is empty.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:553

---

getRtpStreamId

▸ getRtpStreamId(): string

Gets the RTP stream identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:578

---

getScale

▸ getScale(): number

Gets the target scale.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:590

---

getScaledHeight

▸ getScaledHeight(): number

Gets the scaled height.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:602

---

getScaledSize

▸ getScaledSize(): Size

Gets the scaled size.

Returns: Size

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:618

---

getScaledWidth

▸ getScaledWidth(): number

Gets the scaled width.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:638

---

getSize

▸ getSize(): Size

Gets the size.

Returns: Size

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:725

---

getSynchronizationSource

▸ getSynchronizationSource(): number

Gets the synchronization source.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:750

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Info

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:10

---

getWidth

▸ getWidth(): number

Gets the width.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:762

---

isEquivalent

▸ isEquivalent(encoding: EncodingInfo): boolean

Determines whether the specified encoding is equivalent.

Parameters:

Name	Type	Description
encoding	EncodingInfo	The encoding.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:779

▸ isEquivalent(encoding: EncodingInfo, restrictionsOnly: boolean): boolean

Determines whether the specified encoding is equivalent.

Parameters:

Name	Type	Description
encoding	EncodingInfo	The encoding.
restrictionsOnly	boolean	Whether to check restrictions only.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:787

---

serializeProperties

▸ ProtectedserializeProperties(jsonObject: Hash<string, string>): void

Serializes the properties.

Parameters:

Name	Type	Description
jsonObject	Hash<string, string>	The JSON object.

Returns: void

Overrides: Info

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:870

---

setBitrate

▸ setBitrate(value: number): void

Sets the bitrate, in kbps.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:903

---

setDeactivated

▸ setDeactivated(value: boolean): void

Sets whether this encoding is deactivated.

Parameters:

Name	Type
value	boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:916

---

setFrameRate

▸ setFrameRate(value: number): void

Sets the frame-rate, in fps.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:928

---

setId

▸ setId(value: string): void

Sets the identifier.

Parameters:

Name	Type
value	string

Returns: void

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:363

---

setRtpStreamId

▸ setRtpStreamId(value: string): void

Sets the RTP stream identifier.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:940

---

setScale

▸ setScale(value: number): void

Sets the target scale.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:952

---

setSize

▸ setSize(value: Size): void

Sets the size.

Parameters:

Name	Type
value	Size

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:1003

---

setSynchronizationSource

▸ setSynchronizationSource(value: number): void

Sets the synchronization source.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:1015

---

toJson

▸ toJson(): string

Serializes this instance to JSON.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:1028

---

toSdpRidAttribute

▸ toSdpRidAttribute(direction: string): RidAttribute

Converts this instance into an SDP RID attribute.

Parameters:

Name	Type	Description
direction	string	The direction.

Returns: RidAttribute

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:1041

▸ toSdpRidAttribute(direction: string, includeRestrictions: boolean): RidAttribute

Converts this instance into an SDP RID attribute.

Parameters:

Name	Type	Description
direction	string	The direction.
includeRestrictions	boolean	Whether to include restrictions.

Returns: RidAttribute

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:1049

---

toString

▸ toString(): string

Returns a string that represents this instance.

Returns: string

A string that represents this instance.

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:1070

---

fromJson

▸ StaticfromJson(encodingInfoJson: string): EncodingInfo

Deserializes an instance from JSON.

Parameters:

Name	Type	Description
encodingInfoJson	string	The serialized JSON.

Returns: EncodingInfo

The deserialized instance.

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:86

---

fromJsonArray

▸ StaticfromJsonArray(encodingInfosJson: string): EncodingInfo[]

Deserializes an array from JSON.

Parameters:

Name	Type	Description
encodingInfosJson	string	The serialized JSON.

Returns: EncodingInfo[]

The deserialized array.

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:105

---

fromSdpRidAttribute

▸ StaticfromSdpRidAttribute(ridAttribute: RidAttribute): EncodingInfo

Converts an SDP RID attribute into an instance.

Parameters:

Name	Type	Description
ridAttribute	RidAttribute	The SDP RID attribute.

Returns: EncodingInfo

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:123

---

isEquivalent

▸ StaticisEquivalent(encoding1: EncodingInfo, encoding2: EncodingInfo): boolean

Determines whether the two encodings are equivalent.

Parameters:

Name	Type	Description
encoding1	EncodingInfo	The first encoding.
encoding2	EncodingInfo	The second encoding.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:148

▸ StaticisEquivalent(encoding1: EncodingInfo, encoding2: EncodingInfo, restrictionsOnly: boolean): boolean

Determines whether the two encodings are equivalent.

Parameters:

Name	Type	Description
encoding1	EncodingInfo	The first encoding.
encoding2	EncodingInfo	The second encoding.
restrictionsOnly	boolean	Whether to check restrictions only.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:157

---

max

▸ Staticmax(encoding1: EncodingInfo, encoding2: EncodingInfo): EncodingInfo

Returns a new encoding with each value being the maximum of two input encodings.

Parameters:

Name	Type	Description
encoding1	EncodingInfo	The first encoding.
encoding2	EncodingInfo	The second encoding.

Returns: EncodingInfo

A new encoding.

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:197

---

min

▸ Staticmin(encoding1: EncodingInfo, encoding2: EncodingInfo): EncodingInfo

Returns a new encoding with each value being the minimum of two input encodings.

Parameters:

Name	Type	Description
encoding1	EncodingInfo	The first encoding.
encoding2	EncodingInfo	The second encoding.

Returns: EncodingInfo

A new encoding.

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:296

---

processArray

▸ StaticprocessArray<T>(newValues: T[], oldValues: T[]): T[]

Processes an array for an info.

Type parameters:

Name	Type
T	IEquivalent<T, T>

Parameters:

Name	Type	Description
newValues	T[]	The new values.
oldValues	T[]	The old values.

Returns: T[]

The new values, if the new values are not equivalent to the old values; otherwise null.

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:34

---

processBoolean

▸ StaticprocessBoolean(newValue: boolean, oldValue: boolean): boolean

Processes a boolean for an info.

Parameters:

Name	Type	Description
newValue	boolean	The new value.
oldValue	boolean	The old value.

Returns: boolean

The new value, if the new value does not equal the old value; otherwise null.

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:60

---

processBooleanArray

▸ StaticprocessBooleanArray(newValues: boolean[], oldValues: boolean[]): boolean[]

Processes a boolean array for an info.

Parameters:

Name	Type	Description
newValues	boolean[]	The new values.
oldValues	boolean[]	The old values.

Returns: boolean[]

The new values, if the new values do not equal the old values; otherwise null.

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:75

---

processDouble

▸ StaticprocessDouble(newValue: number, oldValue: number): number

Processes a double for an info.

Parameters:

Name	Type	Description
newValue	number	The new value.
oldValue	number	The old value.

Returns: number

The new value, if the new value does not equal the old value; otherwise null.

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:101

---

processFloat

▸ StaticprocessFloat(newValue: number, oldValue: number): number

Processes a float for an info.

Parameters:

Name	Type	Description
newValue	number	The new value.
oldValue	number	The old value.

Returns: number

The new value, if the new value does not equal the old value; otherwise null.

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:116

---

processFloatArray

▸ StaticprocessFloatArray(newValues: number[], oldValues: number[]): number[]

Processes a float array for an info.

Parameters:

Name	Type	Description
newValues	number[]	The new values.
oldValues	number[]	The old values.

Returns: number[]

The new values, if the new values do not equal the old values; otherwise null.

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:131

---

processInteger

▸ StaticprocessInteger(newValue: number, oldValue: number): number

Processes an integer for an info.

Parameters:

Name	Type	Description
newValue	number	The new value.
oldValue	number	The old value.

Returns: number

The new value, if the new value does not equal the old value; otherwise null.

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:157

---

processIntegerArray

▸ StaticprocessIntegerArray(newValues: number[], oldValues: number[]): number[]

Processes a integer array for an info.

Parameters:

Name	Type	Description
newValues	number[]	The new values.
oldValues	number[]	The old values.

Returns: number[]

The new values, if the new values do not equal the old values; otherwise null.

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:174

---

processLong

▸ StaticprocessLong(newValue: number, oldValue: number): number

Processes a long for an info.

Parameters:

Name	Type	Description
newValue	number	The new value.
oldValue	number	The old value.

Returns: number

The new value, if the new value does not equal the old value; otherwise null.

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:200

---

processLongArray

▸ StaticprocessLongArray(newValues: number[], oldValues: number[]): number[]

Processes a long array for an info.

Parameters:

Name	Type	Description
newValues	number[]	The new values.
oldValues	number[]	The old values.

Returns: number[]

The new values, if the new values do not equal the old values; otherwise null.

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:217

---

processObject

▸ StaticprocessObject<T>(newValue: T, oldValue: T): T

Processes an object for an info.

Type parameters:

Name	Type
T	Object & IEquivalent<T, T>

Parameters:

Name	Type	Description
newValue	T	The new value.
oldValue	T	The old value.

Returns: T

The new value, if the new value does not equal the old value; otherwise null.

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:243

---

processShort

▸ StaticprocessShort(newValue: number, oldValue: number): number

Processes a short for an info.

Parameters:

Name	Type	Description
newValue	number	The new value.
oldValue	number	The old value.

Returns: number

The new value, if the new value does not equal the old value; otherwise null.

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:264

---

processShortArray

▸ StaticprocessShortArray(newValues: number[], oldValues: number[]): number[]

Processes a short array for an info.

Parameters:

Name	Type	Description
newValues	number[]	The new values.
oldValues	number[]	The old values.

Returns: number[]

The new values, if the new values do not equal the old values; otherwise null.

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:281

---

processString

▸ StaticprocessString(newValue: string, oldValue: string): string

Processes a string for an info.

Parameters:

Name	Type	Description
newValue	string	The new value.
oldValue	string	The old value.

Returns: string

The new value, if the new value does not equal the old value; otherwise null.

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:307

---

toJson

▸ StatictoJson(encodingInfo: EncodingInfo): string

Serializes an instance to JSON.

Parameters:

Name	Type	Description
encodingInfo	EncodingInfo	The instance to serialize.

Returns: string

The serialized JSON.

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:371

---

toJsonArray

▸ StatictoJsonArray(encodingInfos: EncodingInfo[]): string

Serializes an array to JSON.

Parameters:

Name	Type	Description
encodingInfos	EncodingInfo[]	The array to serialize.

Returns: string

The serialized JSON.

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:388

---

toSdpRidAttribute

▸ StatictoSdpRidAttribute(encoding: EncodingInfo, direction: string): RidAttribute

Converts an instance into an SDP RID attribute.

Parameters:

Name	Type	Description
encoding	EncodingInfo	The encoding.
direction	string	The direction.

Returns: RidAttribute

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:403

▸ StatictoSdpRidAttribute(encoding: EncodingInfo, direction: string, includeRestrictions: boolean): RidAttribute

Converts an instance into an SDP RID attribute.

Parameters:

Name	Type	Description
encoding	EncodingInfo	The encoding.
direction	string	The direction.
includeRestrictions	boolean	Whether to include restrictions.

Returns: RidAttribute

Defined in: Generated/TypeScript/fm.liveswitch/EncodingInfo.ts:412