/ fm / liveswitch / BitrateRequest

Class: BitrateRequest

fm.liveswitch.BitrateRequest

A bitrate request.

Table of contents

Constructors

• constructor

Methods

• deserializeProperty
• fmliveswitchBitrateRequestInit
• getBitrate
• getMediaDescriptionId
• getRtpStreamId
• getSenderSynchronizationSource
• getSynchronizationSource
• getTypeString
• serializeProperties
• setBitrate
• setMediaDescriptionId
• setRtpStreamId
• setSenderSynchronizationSource
• setSynchronizationSource
• toJson
• fromJson
• fromJsonArray
• toJson
• toJsonArray

Constructors

constructor

+ new BitrateRequest(): BitrateRequest

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

Returns: BitrateRequest

Defined in: Generated/TypeScript/fm.liveswitch/BitrateRequest.ts:28

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/BitrateRequest.ts:124

---

fmliveswitchBitrateRequestInit

▸ PrivatefmliveswitchBitrateRequestInit(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/BitrateRequest.ts:23

---

getBitrate

▸ getBitrate(): number

Gets the bitrate (in kbps).

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/BitrateRequest.ts:157

---

getMediaDescriptionId

▸ getMediaDescriptionId(): string

Gets the media description ID.

Returns: string

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

---

getRtpStreamId

▸ getRtpStreamId(): string

Gets the RTP stream ID.

Returns: string

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

---

getSenderSynchronizationSource

▸ getSenderSynchronizationSource(): number

Gets the sender synchronization source.

Returns: number

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

---

getSynchronizationSource

▸ getSynchronizationSource(): number

Gets the synchronization source.

Returns: number

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

---

getTypeString

▸ getTypeString(): string

Returns: string

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

---

setBitrate

▸ setBitrate(value: number): void

Sets the bitrate (in kbps).

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/BitrateRequest.ts:244

---

setMediaDescriptionId

▸ setMediaDescriptionId(value: string): void

Sets the media description ID.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/BitrateRequest.ts:257

---

setRtpStreamId

▸ setRtpStreamId(value: string): void

Sets the RTP stream ID.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/BitrateRequest.ts:269

---

setSenderSynchronizationSource

▸ setSenderSynchronizationSource(value: number): void

Sets the sender synchronization source.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/BitrateRequest.ts:281

---

setSynchronizationSource

▸ setSynchronizationSource(value: number): void

Sets the synchronization source.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/BitrateRequest.ts:294

---

toJson

▸ toJson(): string

Serializes this instance to JSON.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/BitrateRequest.ts:307

---

fromJson

▸ StaticfromJson(bitrateRequestJson: string): BitrateRequest

Deserializes an instance from JSON.

Parameters:

Name	Type	Description
bitrateRequestJson	string	The instance in JSON format.

Returns: BitrateRequest

The instance.

Defined in: Generated/TypeScript/fm.liveswitch/BitrateRequest.ts:58

---

fromJsonArray

▸ StaticfromJsonArray(bitrateRequestsJson: string): BitrateRequest[]

Deserializes an array from JSON.

Parameters:

Name	Type	Description
bitrateRequestsJson	string	The array in JSON format.

Returns: BitrateRequest[]

The array.

Defined in: Generated/TypeScript/fm.liveswitch/BitrateRequest.ts:76

---

toJson

▸ StatictoJson(bitrateRequest: BitrateRequest): string

Serializes an instance to JSON.

Parameters:

Name	Type	Description
bitrateRequest	BitrateRequest	The instance.

Returns: string

The instance in JSON format.

Defined in: Generated/TypeScript/fm.liveswitch/BitrateRequest.ts:94

---

toJsonArray

▸ StatictoJsonArray(bitrateRequests: BitrateRequest[]): string

Serializes an array to JSON.

Parameters:

Name	Type	Description
bitrateRequests	BitrateRequest[]	The array.

Returns: string

The array in JSON format.

Defined in: Generated/TypeScript/fm.liveswitch/BitrateRequest.ts:110