/ fm / liveswitch / MediaSinkInfo

Class: MediaSinkInfo

fm.liveswitch.MediaSinkInfo

Media sink information.

Hierarchy

• Info

  ↳ MediaSinkInfo

Table of contents

Constructors

• constructor

Methods

• deserializeProperties
• getId
• getInputFormat
• getLabel
• getOutputId
• getOutputName
• getTag
• getTypeString
• serializeProperties
• setId
• setInputFormat
• setLabel
• setOutputId
• setOutputName
• setTag
• toJson
• fromJson
• fromJsonArray
• processArray
• processBoolean
• processBooleanArray
• processDouble
• processFloat
• processFloatArray
• processInteger
• processIntegerArray
• processLong
• processLongArray
• processObject
• processShort
• processShortArray
• processString
• toJson
• toJsonArray

Constructors

constructor

+ new MediaSinkInfo(): MediaSinkInfo

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

Returns: MediaSinkInfo

Inherited from: Info

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

+ new MediaSinkInfo(stats: MediaSinkStats, lastStats: MediaSinkStats): MediaSinkInfo

Parameters:

Name	Type
stats	MediaSinkStats
lastStats	MediaSinkStats

Returns: MediaSinkInfo

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkInfo.ts:29

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/MediaSinkInfo.ts:128

---

getId

▸ getId(): string

Gets the identifier.

Returns: string

Inherited from: Info

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

---

getInputFormat

▸ getInputFormat(): FormatInfo

Gets the media sink input format.

Returns: FormatInfo

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkInfo.ts:162

---

getLabel

▸ getLabel(): string

Gets the media sink label.

Returns: string

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

---

getOutputId

▸ getOutputId(): string

Gets the media sink output id.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkInfo.ts:186

---

getOutputName

▸ getOutputName(): string

Gets the media sink output name.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkInfo.ts:198

---

getTag

▸ getTag(): string

Gets the media sink tag.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkInfo.ts:210

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Info

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkInfo.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/MediaSinkInfo.ts:223

---

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

---

setInputFormat

▸ setInputFormat(value: FormatInfo): void

Sets the media sink input format.

Parameters:

Name	Type
value	FormatInfo

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkInfo.ts:250

---

setLabel

▸ setLabel(value: string): void

Sets the media sink label.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkInfo.ts:262

---

setOutputId

▸ setOutputId(value: string): void

Sets the media sink output id.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkInfo.ts:274

---

setOutputName

▸ setOutputName(value: string): void

Sets the media sink output name.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkInfo.ts:286

---

setTag

▸ setTag(value: string): void

Sets the media sink tag.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkInfo.ts:298

---

toJson

▸ toJson(): string

Serializes this instance to JSON.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkInfo.ts:310

---

fromJson

▸ StaticfromJson(mediaSinkInfoJson: string): MediaSinkInfo

Deserializes an instance from JSON.

Parameters:

Name	Type	Description
mediaSinkInfoJson	string	The serialized JSON.

Returns: MediaSinkInfo

The deserialized instance.

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkInfo.ts:62

---

fromJsonArray

▸ StaticfromJsonArray(mediaSinkInfosJson: string): MediaSinkInfo[]

Deserializes an array from JSON.

Parameters:

Name	Type	Description
mediaSinkInfosJson	string	The serialized JSON.

Returns: MediaSinkInfo[]

The deserialized array.

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkInfo.ts:80

---

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(mediaSinkInfo: MediaSinkInfo): string

Serializes an instance to JSON.

Parameters:

Name	Type	Description
mediaSinkInfo	MediaSinkInfo	The instance to serialize.

Returns: string

The serialized JSON.

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkInfo.ts:98

---

toJsonArray

▸ StatictoJsonArray(mediaSinkInfos: MediaSinkInfo[]): string

Serializes an array to JSON.

Parameters:

Name	Type	Description
mediaSinkInfos	MediaSinkInfo[]	The array to serialize.

Returns: string

The serialized JSON.

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkInfo.ts:114