/ fm / liveswitch / SimulcastNotification
Class: SimulcastNotification
fm.liveswitch.SimulcastNotification
A simulcast notification.
Table of contents
Constructors
Methods
- deserializeProperty
- fmliveswitchSimulcastNotificationInit
- getMediaDescriptionId
- getRtpStreamId
- getStreamState
- getSynchronizationSource
- getTypeString
- serializeProperties
- setMediaDescriptionId
- setRtpStreamId
- setStreamState
- setSynchronizationSource
- toJson
- fromJson
- fromJsonArray
- toJson
- toJsonArray
Constructors
constructor
+ new SimulcastNotification(): SimulcastNotification
Initializes a new instance of the [[fm.liveswitch.simulcastNotification]] class.
Returns: SimulcastNotification
Defined in: Generated/TypeScript/fm.liveswitch/SimulcastNotification.ts:24
Methods
deserializeProperty
▸ ProtecteddeserializeProperty(key: string, valueJson: string): void
Deserializes a property from JSON.
Parameters:
| Name | Type | Description |
|---|---|---|
key |
string | The property key. |
valueJson |
string | The property value in JSON format. |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/SimulcastNotification.ts:119
fmliveswitchSimulcastNotificationInit
▸ PrivatefmliveswitchSimulcastNotificationInit(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/SimulcastNotification.ts:21
getMediaDescriptionId
▸ getMediaDescriptionId(): string
Gets the media description ID.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/SimulcastNotification.ts:148
getRtpStreamId
▸ getRtpStreamId(): string
Gets the RTP stream ID.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/SimulcastNotification.ts:160
getStreamState
▸ getStreamState(): SimulcastStreamState
Gets the simulcast stream's state
Returns: SimulcastStreamState
Defined in: Generated/TypeScript/fm.liveswitch/SimulcastNotification.ts:172
getSynchronizationSource
▸ getSynchronizationSource(): number
Gets the synchronization source.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/SimulcastNotification.ts:184
getTypeString
▸ getTypeString(): string
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/SimulcastNotification.ts:9
serializeProperties
▸ ProtectedserializeProperties(jsonObject: Hash<string, string>): void
Serializes properties to JSON.
Parameters:
| Name | Type | Description |
|---|---|---|
jsonObject |
Hash<string, string> | The JSON target. |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/SimulcastNotification.ts:197
setMediaDescriptionId
▸ setMediaDescriptionId(value: string): void
Sets the media description ID.
Parameters:
| Name | Type |
|---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/SimulcastNotification.ts:218
setRtpStreamId
▸ setRtpStreamId(value: string): void
Sets the RTP stream ID.
Parameters:
| Name | Type |
|---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/SimulcastNotification.ts:230
setStreamState
▸ setStreamState(value: SimulcastStreamState): void
Sets the simulcast stream's state
Parameters:
| Name | Type |
|---|---|
value |
SimulcastStreamState |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/SimulcastNotification.ts:242
setSynchronizationSource
▸ setSynchronizationSource(value: number): void
Sets the synchronization source.
Parameters:
| Name | Type |
|---|---|
value |
number |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/SimulcastNotification.ts:254
toJson
▸ toJson(): string
Serializes this instance to JSON.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/SimulcastNotification.ts:303
fromJson
▸ StaticfromJson(simulcastNotificationJson: string): SimulcastNotification
Deserializes an instance from JSON.
Parameters:
| Name | Type | Description |
|---|---|---|
simulcastNotificationJson |
string | The instance in JSON format. |
Returns: SimulcastNotification
The instance.
Defined in: Generated/TypeScript/fm.liveswitch/SimulcastNotification.ts:53
fromJsonArray
▸ StaticfromJsonArray(simulcastNotificationJson: string): SimulcastNotification[]
Deserializes an array from JSON.
Parameters:
| Name | Type | Description |
|---|---|---|
simulcastNotificationJson |
string | The array in JSON format. |
Returns: SimulcastNotification[]
The array.
Defined in: Generated/TypeScript/fm.liveswitch/SimulcastNotification.ts:71
toJson
▸ StatictoJson(simulcastNotification: SimulcastNotification): string
Serializes an instance to JSON.
Parameters:
| Name | Type | Description |
|---|---|---|
simulcastNotification |
SimulcastNotification | The instance. |
Returns: string
The instance in JSON format.
Defined in: Generated/TypeScript/fm.liveswitch/SimulcastNotification.ts:89
toJsonArray
▸ StatictoJsonArray(simulcastNotifications: SimulcastNotification[]): string
Serializes an array to JSON.
Parameters:
| Name | Type | Description |
|---|---|---|
simulcastNotifications |
SimulcastNotification[] | The array. |
Returns: string
The array in JSON format.
Defined in: Generated/TypeScript/fm.liveswitch/SimulcastNotification.ts:105