/ fm / liveswitch / MediaSourceInfo

Class: MediaSourceInfo

fm.liveswitch.MediaSourceInfo

Media source information.

Hierarchy

• Info

  ↳ MediaSourceInfo

Table of contents

Constructors

• constructor

Methods

• deserializeProperties
• getId
• getInputId
• getInputName
• getLabel
• getMuted
• getOutputFormat
• getTag
• getTypeString
• serializeProperties
• setId
• setInputId
• setInputName
• setLabel
• setMuted
• setOutputFormat
• setTag
• toJson
• fromJson
• fromJsonArray
• processArray
• processBoolean
• processBooleanArray
• processDouble
• processFloat
• processFloatArray
• processInteger
• processIntegerArray
• processLong
• processLongArray
• processObject
• processShort
• processShortArray
• processString
• toJson
• toJsonArray

Constructors

constructor

+ new MediaSourceInfo(): MediaSourceInfo

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

Returns: MediaSourceInfo

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceInfo.ts:24

+ new MediaSourceInfo(stats: MediaSourceStats, lastStats: MediaSourceStats): MediaSourceInfo

Parameters:

Name	Type
stats	MediaSourceStats
lastStats	MediaSourceStats

Returns: MediaSourceInfo

Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceInfo.ts:31

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/MediaSourceInfo.ts:131

---

getId

▸ getId(): string

Gets the identifier.

Returns: string

Inherited from: Info

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

---

getInputId

▸ getInputId(): string

Gets the media source input identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceInfo.ts:169

---

getInputName

▸ getInputName(): string

Gets the media source input name.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceInfo.ts:181

---

getLabel

▸ getLabel(): string

Gets the media source label.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceInfo.ts:193

---

getMuted

▸ getMuted(): boolean

Gets the whether the media source is muted.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceInfo.ts:205

---

getOutputFormat

▸ getOutputFormat(): FormatInfo

Gets the media source output format.

Returns: FormatInfo

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

---

getTag

▸ getTag(): string

Gets the media source tag.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceInfo.ts:229

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Info

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

---

setInputId

▸ setInputId(value: string): void

Sets the media source input identifier.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceInfo.ts:272

---

setInputName

▸ setInputName(value: string): void

Sets the media source input name.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceInfo.ts:284

---

setLabel

▸ setLabel(value: string): void

Sets the media source label.

Parameters:

Name	Type
value	string

Returns: void

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

---

setMuted

▸ setMuted(value: boolean): void

Sets the whether the media source is muted.

Parameters:

Name	Type
value	boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceInfo.ts:308

---

setOutputFormat

▸ setOutputFormat(value: FormatInfo): void

Sets the media source output format.

Parameters:

Name	Type
value	FormatInfo

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceInfo.ts:320

---

setTag

▸ setTag(value: string): void

Sets the media source tag.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceInfo.ts:332

---

toJson

▸ toJson(): string

Serializes this instance to JSON.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceInfo.ts:344

---

fromJson

▸ StaticfromJson(mediaSourceInfoJson: string): MediaSourceInfo

Deserializes an instance from JSON.

Parameters:

Name	Type	Description
mediaSourceInfoJson	string	The serialized JSON.

Returns: MediaSourceInfo

The deserialized instance.

Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceInfo.ts:65

---

fromJsonArray

▸ StaticfromJsonArray(mediaSourceInfosJson: string): MediaSourceInfo[]

Deserializes an array from JSON.

Parameters:

Name	Type	Description
mediaSourceInfosJson	string	The serialized JSON.

Returns: MediaSourceInfo[]

The deserialized array.

Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceInfo.ts:83

---

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(mediaSourceInfo: MediaSourceInfo): string

Serializes an instance to JSON.

Parameters:

Name	Type	Description
mediaSourceInfo	MediaSourceInfo	The instance to serialize.

Returns: string

The serialized JSON.

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

---

toJsonArray

▸ StatictoJsonArray(mediaSourceInfos: MediaSourceInfo[]): string

Serializes an array to JSON.

Parameters:

Name	Type	Description
mediaSourceInfos	MediaSourceInfo[]	The array to serialize.

Returns: string

The serialized JSON.

Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceInfo.ts:117