/ fm / liveswitch / MediaSourceStats
Class: MediaSourceStats
fm.liveswitch.MediaSourceStats
Media source stats.
Hierarchy
-
↳ MediaSourceStats
Implements
Table of contents
Constructors
Methods
- deserializeProperties
- fmliveswitchMediaSourceStatsInit
- getId
- getInputId
- getInputName
- getLabel
- getMuted
- getOutputFormat
- getTag
- getTimestamp
- getTypeString
- isEquivalent
- serializeProperties
- setInputId
- setInputName
- setLabel
- setMuted
- setOutputFormat
- setTag
- toJson
- fromJson
- toJson
Constructors
constructor
+ new MediaSourceStats(): MediaSourceStats
Returns: MediaSourceStats
Inherited from: BaseStats
Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceStats.ts:29
Methods
deserializeProperties
▸ Protected
deserializeProperties(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/MediaSourceStats.ts:83
fmliveswitchMediaSourceStatsInit
▸ Private
fmliveswitchMediaSourceStatsInit(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceStats.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
getInputId
▸ getInputId(): string
Gets the input identifier.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceStats.ts:121
getInputName
▸ getInputName(): string
Gets the input name.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceStats.ts:133
getLabel
▸ getLabel(): string
Gets the label.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceStats.ts:145
getMuted
▸ getMuted(): boolean
Gets the muted flag.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceStats.ts:157
getOutputFormat
▸ getOutputFormat(): FormatInfo
Gets the output format.
Returns: FormatInfo
Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceStats.ts:169
getTag
▸ getTag(): string
Gets the tag.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceStats.ts:181
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/MediaSourceStats.ts:10
isEquivalent
▸ isEquivalent(instance
: MediaSourceStats): boolean
Checks if a source is equivalent to this one.
Parameters:
Name | Type | Description |
---|---|---|
instance |
MediaSourceStats | The source. |
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceStats.ts:194
serializeProperties
▸ Protected
serializeProperties(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/MediaSourceStats.ts:213
setInputId
▸ setInputId(value
: string): void
Sets the input identifier.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceStats.ts:241
setInputName
▸ setInputName(value
: string): void
Sets the input name.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceStats.ts:253
setLabel
▸ setLabel(value
: string): void
Sets the label.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceStats.ts:265
setMuted
▸ setMuted(value
: boolean): void
Sets the muted flag.
Parameters:
Name | Type |
---|---|
value |
boolean |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceStats.ts:277
setOutputFormat
▸ setOutputFormat(value
: FormatInfo): void
Sets the output format.
Parameters:
Name | Type |
---|---|
value |
FormatInfo |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceStats.ts:289
setTag
▸ setTag(value
: string): void
Sets the tag.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceStats.ts:301
toJson
▸ toJson(): string
Serializes this instance to JSON.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceStats.ts:313
fromJson
▸ Static
fromJson(instanceJson
: string): MediaSourceStats
Deserializes an instance from JSON.
Parameters:
Name | Type | Description |
---|---|---|
instanceJson |
string | The serialized Json. |
Returns: MediaSourceStats
The deserialized VideoSourceInfo.
Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceStats.ts:49
toJson
▸ Static
toJson(instance
: MediaSourceStats): string
Serializes an instance to JSON.
Parameters:
Name | Type | Description |
---|---|---|
instance |
MediaSourceStats | The instance to serialize. |
Returns: string
Serialized Json.
Defined in: Generated/TypeScript/fm.liveswitch/MediaSourceStats.ts:67