/ fm / liveswitch / MediaSinkStats

Class: MediaSinkStats

fm.liveswitch.MediaSinkStats

Media sink stats.

Hierarchy

• BaseStats

  ↳ MediaSinkStats

Implements

• IEquivalent<MediaSinkStats>

Table of contents

Constructors

• constructor

Methods

• deserializeProperties
• fmliveswitchMediaSinkStatsInit
• getId
• getInputFormat
• getLabel
• getMuted
• getOutputId
• getOutputName
• getTag
• getTimestamp
• getTypeString
• isEquivalent
• serializeProperties
• setInputFormat
• setLabel
• setMuted
• setOutputId
• setOutputName
• setTag
• toJson
• fromJson
• fromJsonArray
• toJson
• toJsonArray

Constructors

constructor

+ new MediaSinkStats(): MediaSinkStats

Returns: MediaSinkStats

Inherited from: BaseStats

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

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkStats.ts:115

---

fmliveswitchMediaSinkStatsInit

▸ PrivatefmliveswitchMediaSinkStatsInit(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkStats.ts:26

---

getId

▸ getId(): string

Gets the identifier of the object generating these stats.

Returns: string

Inherited from: BaseStats

Defined in: Generated/TypeScript/fm.liveswitch/BaseStats.ts:57

---

getInputFormat

▸ getInputFormat(): FormatInfo

Gets the input format.

Returns: FormatInfo

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkStats.ts:153

---

getLabel

▸ getLabel(): string

Gets the label.

Returns: string

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

---

getMuted

▸ getMuted(): boolean

Gets the muted flag.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkStats.ts:177

---

getOutputId

▸ getOutputId(): string

Gets the output identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkStats.ts:189

---

getOutputName

▸ getOutputName(): string

Gets the output name.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkStats.ts:201

---

getTag

▸ getTag(): string

Gets the tag.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkStats.ts:213

---

getTimestamp

▸ getTimestamp(): DateTime

Gets the timestamp when these stats were generated.

Returns: DateTime

Inherited from: BaseStats

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

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: BaseStats

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

---

isEquivalent

▸ isEquivalent(instance: MediaSinkStats): boolean

Checks if a source is equivalent to this one.

Parameters:

Name	Type	Description
instance	MediaSinkStats	The source.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkStats.ts:226

---

serializeProperties

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

Serializes the properties.

Parameters:

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

Returns: void

Overrides: BaseStats

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkStats.ts:245

---

setInputFormat

▸ setInputFormat(value: FormatInfo): void

Sets the input format.

Parameters:

Name	Type
value	FormatInfo

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkStats.ts:273

---

setLabel

▸ setLabel(value: string): void

Sets the label.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkStats.ts:285

---

setMuted

▸ setMuted(value: boolean): void

Sets the muted flag.

Parameters:

Name	Type
value	boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkStats.ts:297

---

setOutputId

▸ setOutputId(value: string): void

Sets the output identifier.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkStats.ts:309

---

setOutputName

▸ setOutputName(value: string): void

Sets the output name.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkStats.ts:321

---

setTag

▸ setTag(value: string): void

Sets the tag.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkStats.ts:333

---

toJson

▸ toJson(): string

Serializes this instance to JSON.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkStats.ts:345

---

fromJson

▸ StaticfromJson(instanceJson: string): MediaSinkStats

Deserializes an instance from JSON.

Parameters:

Name	Type	Description
instanceJson	string	The serialized JSON.

Returns: MediaSinkStats

The deserialized instance.

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkStats.ts:49

---

fromJsonArray

▸ StaticfromJsonArray(arrayJson: string): MediaSinkStats[]

Deserializes an array from JSON.

Parameters:

Name	Type	Description
arrayJson	string	The serialized JSON.

Returns: MediaSinkStats[]

The deserialized array.

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkStats.ts:67

---

toJson

▸ StatictoJson(instance: MediaSinkStats): string

Serializes an instance to JSON.

Parameters:

Name	Type	Description
instance	MediaSinkStats	The instance to serialize.

Returns: string

Serialized JSON.

Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkStats.ts:85

---

toJsonArray

▸ StatictoJsonArray(array: MediaSinkStats[]): string

Serializes an array to JSON.

Parameters:

Name	Type	Description
array	MediaSinkStats[]	The array to serialize.

Returns: string

The serialized JSON.

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