/ fm / liveswitch / CodecInfo

Class: CodecInfo

fm.liveswitch.CodecInfo

Codec information.

Hierarchy

• Info

  ↳ CodecInfo

Table of contents

Constructors

• constructor

Methods

• deserializeProperties
• getChannelCount
• getClockRate
• getId
• getName
• getParameters
• getPayloadType
• getTypeString
• serializeProperties
• setChannelCount
• setClockRate
• setId
• setName
• setParameters
• setPayloadType
• toJson
• fromJson
• fromJsonArray
• processArray
• processBoolean
• processBooleanArray
• processDouble
• processFloat
• processFloatArray
• processInteger
• processIntegerArray
• processLong
• processLongArray
• processObject
• processShort
• processShortArray
• processString
• toJson
• toJsonArray

Constructors

constructor

+ new CodecInfo(): CodecInfo

Returns: CodecInfo

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/CodecInfo.ts:22

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/CodecInfo.ts:108

---

getChannelCount

▸ getChannelCount(): number

Gets the codec channel count.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/CodecInfo.ts:142

---

getClockRate

▸ getClockRate(): number

Gets the codec clock rate.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/CodecInfo.ts:154

---

getId

▸ getId(): string

Gets the identifier.

Returns: string

Inherited from: Info

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

---

getName

▸ getName(): string

Gets the codec name.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/CodecInfo.ts:166

---

getParameters

▸ getParameters(): string

Gets the codec parameters.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/CodecInfo.ts:178

---

getPayloadType

▸ getPayloadType(): number

Gets the codec payload type.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/CodecInfo.ts:190

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Info

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

---

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/CodecInfo.ts:203

---

setChannelCount

▸ setChannelCount(value: number): void

Sets the codec channel count.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/CodecInfo.ts:230

---

setClockRate

▸ setClockRate(value: number): void

Sets the codec clock rate.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/CodecInfo.ts:242

---

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

---

setName

▸ setName(value: string): void

Sets the codec name.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/CodecInfo.ts:254

---

setParameters

▸ setParameters(value: string): void

Sets the codec parameters.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/CodecInfo.ts:266

---

setPayloadType

▸ setPayloadType(value: number): void

Sets the codec payload type.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/CodecInfo.ts:278

---

toJson

▸ toJson(): string

Serializes this instance to JSON.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/CodecInfo.ts:290

---

fromJson

▸ StaticfromJson(codecInfoJson: string): CodecInfo

Deserializes an instance from JSON.

Parameters:

Name	Type	Description
codecInfoJson	string	The serialized JSON.

Returns: CodecInfo

The deserialized instance.

Defined in: Generated/TypeScript/fm.liveswitch/CodecInfo.ts:42

---

fromJsonArray

▸ StaticfromJsonArray(codecInfosJson: string): CodecInfo[]

Deserializes an array from JSON.

Parameters:

Name	Type	Description
codecInfosJson	string	The serialized JSON.

Returns: CodecInfo[]

The deserialized array.

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

---

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(codecInfo: CodecInfo): string

Serializes an instance to JSON.

Parameters:

Name	Type	Description
codecInfo	CodecInfo	The instance to serialize.

Returns: string

The serialized JSON.

Defined in: Generated/TypeScript/fm.liveswitch/CodecInfo.ts:78

---

toJsonArray

▸ StatictoJsonArray(codecInfos: CodecInfo[]): string

Serializes an array to JSON.

Parameters:

Name	Type	Description
codecInfos	CodecInfo[]	The array to serialize.

Returns: string

The serialized JSON.

Defined in: Generated/TypeScript/fm.liveswitch/CodecInfo.ts:94