/ fm / liveswitch / EncodingConfig

Class: EncodingConfig

fm.liveswitch.EncodingConfig

Encoding configuration.

Hierarchy

• EncodingConfig

  ↳ AudioEncodingConfig

  ↳ VideoEncodingConfig

Table of contents

Constructors

• constructor

Methods

• deserializeProperties
• fmliveswitchEncodingConfigInit
• getBitrate
• getDeactivated
• getRtpStreamId
• getSynchronizationSource
• getTypeString
• serializeProperties
• setBitrate
• setDeactivated

Constructors

constructor

+ new EncodingConfig(): EncodingConfig

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

Returns: EncodingConfig

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

+ new EncodingConfig(encoding: EncodingInfo): EncodingConfig

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

Parameters:

Name	Type	Description
encoding	EncodingInfo	The encoding.

Returns: EncodingConfig

Defined in: Generated/TypeScript/fm.liveswitch/EncodingConfig.ts:32

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

Defined in: Generated/TypeScript/fm.liveswitch/EncodingConfig.ts:71

---

fmliveswitchEncodingConfigInit

▸ PrivatefmliveswitchEncodingConfigInit(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/EncodingConfig.ts:21

---

getBitrate

▸ getBitrate(): number

Gets the bitrate, in kbps.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/EncodingConfig.ts:100

---

getDeactivated

▸ getDeactivated(): boolean

Gets whether this encoding is deactivated.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/EncodingConfig.ts:112

---

getRtpStreamId

▸ getRtpStreamId(): string

Gets the RTP stream identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/EncodingConfig.ts:124

---

getSynchronizationSource

▸ getSynchronizationSource(): number

Gets the synchronization source.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/EncodingConfig.ts:136

---

getTypeString

▸ getTypeString(): string

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/EncodingConfig.ts:9

---

serializeProperties

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

Serializes the properties.

Parameters:

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

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/EncodingConfig.ts:149

---

setBitrate

▸ setBitrate(value: number): void

Sets the bitrate, in kbps.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/EncodingConfig.ts:172

---

setDeactivated

▸ setDeactivated(value: boolean): void

Sets whether this encoding is deactivated.

Parameters:

Name	Type
value	boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/EncodingConfig.ts:185