/ fm / liveswitch / MediaSenderInfo

Class: MediaSenderInfo

fm.liveswitch.MediaSenderInfo

Media sender information.

Hierarchy

• MediaComponentInfo

  ↳ MediaSenderInfo

Table of contents

Constructors

• constructor

Methods

• deserializeProperties
• getCodec
• getId
• getReport
• getSource
• getSynchronizationSource
• getTrack
• getTypeString
• serializeProperties
• setCodec
• setId
• setReport
• setSource
• setSynchronizationSource
• setTrack
• toJson
• fromJson
• fromJsonArray
• processArray
• processBoolean
• processBooleanArray
• processDouble
• processFloat
• processFloatArray
• processInteger
• processIntegerArray
• processLong
• processLongArray
• processObject
• processShort
• processShortArray
• processString
• toJson
• toJsonArray

Constructors

constructor

+ new MediaSenderInfo(): MediaSenderInfo

Initializes a new instance of the [[fm.liveswitch.mediaSenderInfo]] class.

Returns: MediaSenderInfo

Inherited from: MediaComponentInfo

Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderInfo.ts:16

+ new MediaSenderInfo(stats: MediaSenderStats, lastStats: MediaSenderStats): MediaSenderInfo

Parameters:

Name	Type
stats	MediaSenderStats
lastStats	MediaSenderStats

Returns: MediaSenderInfo

Inherited from: MediaComponentInfo

Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderInfo.ts:23

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: MediaComponentInfo

Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderInfo.ts:118

---

getCodec

▸ getCodec(): CodecInfo

Gets codec.

Returns: CodecInfo

Inherited from: MediaComponentInfo

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

---

getId

▸ getId(): string

Gets the identifier.

Returns: string

Inherited from: MediaComponentInfo

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

---

getReport

▸ getReport(): MediaSenderReport

Gets report.

Returns: MediaSenderReport

Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderInfo.ts:140

---

getSource

▸ getSource(): MediaSourceInfo

Gets source.

Returns: MediaSourceInfo

Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderInfo.ts:152

---

getSynchronizationSource

▸ getSynchronizationSource(): number

Gets synchronization source of media track.

Returns: number

Inherited from: MediaComponentInfo

Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentInfo.ts:113

---

getTrack

▸ getTrack(): MediaTrackInfo

Gets track.

Returns: MediaTrackInfo

Inherited from: MediaComponentInfo

Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentInfo.ts:125

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: MediaComponentInfo

Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderInfo.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: MediaComponentInfo

Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderInfo.ts:165

---

setCodec

▸ setCodec(value: CodecInfo): void

Sets codec.

Parameters:

Name	Type
value	CodecInfo

Returns: void

Inherited from: MediaComponentInfo

Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentInfo.ts:159

---

setId

▸ setId(value: string): void

Sets the identifier.

Parameters:

Name	Type
value	string

Returns: void

Inherited from: MediaComponentInfo

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

---

setReport

▸ setReport(value: MediaSenderReport): void

Sets report.

Parameters:

Name	Type
value	MediaSenderReport

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderInfo.ts:183

---

setSource

▸ setSource(value: MediaSourceInfo): void

Sets source.

Parameters:

Name	Type
value	MediaSourceInfo

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderInfo.ts:195

---

setSynchronizationSource

▸ setSynchronizationSource(value: number): void

Sets synchronization source of media track.

Parameters:

Name	Type
value	number

Returns: void

Inherited from: MediaComponentInfo

Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentInfo.ts:171

---

setTrack

▸ setTrack(value: MediaTrackInfo): void

Sets track.

Parameters:

Name	Type
value	MediaTrackInfo

Returns: void

Inherited from: MediaComponentInfo

Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentInfo.ts:183

---

toJson

▸ toJson(): string

Serializes this instance to JSON.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderInfo.ts:207

---

fromJson

▸ StaticfromJson(mediaSenderJson: string): MediaSenderInfo

Deserializes an instance from JSON.

Parameters:

Name	Type	Description
mediaSenderJson	string	The serialized JSON.

Returns: MediaSenderInfo

The deserialized instance.

Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderInfo.ts:52

---

fromJsonArray

▸ StaticfromJsonArray(mediaSendersJson: string): MediaSenderInfo[]

Deserializes an array from JSON.

Parameters:

Name	Type	Description
mediaSendersJson	string	The serialized JSON.

Returns: MediaSenderInfo[]

The deserialized array.

Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderInfo.ts:70

---

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: MediaComponentInfo

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: MediaComponentInfo

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: MediaComponentInfo

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: MediaComponentInfo

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: MediaComponentInfo

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: MediaComponentInfo

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: MediaComponentInfo

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: MediaComponentInfo

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: MediaComponentInfo

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: MediaComponentInfo

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: MediaComponentInfo

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: MediaComponentInfo

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: MediaComponentInfo

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: MediaComponentInfo

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

---

toJson

▸ StatictoJson(mediaSender: MediaSenderInfo): string

Serializes an instance to JSON.

Parameters:

Name	Type	Description
mediaSender	MediaSenderInfo	The instance to serialize.

Returns: string

The serialized JSON.

Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderInfo.ts:88

---

toJsonArray

▸ StatictoJsonArray(mediaSenders: MediaSenderInfo[]): string

Serializes an array to JSON.

Parameters:

Name	Type	Description
mediaSenders	MediaSenderInfo[]	The array to serialize.

Returns: string

The serialized JSON.

Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderInfo.ts:104