/ fm / liveswitch / VideoEncodingConfig

Class: VideoEncodingConfig

fm.liveswitch.VideoEncodingConfig

Video encoding configuration.

Hierarchy

• EncodingConfig

  ↳ VideoEncodingConfig

Table of contents

Constructors

• constructor

Methods

• deserializeProperties
• fmliveswitchVideoEncodingConfigInit
• getBitrate
• getDeactivated
• getFrameRate
• getRtpStreamId
• getScale
• getSynchronizationSource
• getTypeString
• serializeProperties
• setBitrate
• setDeactivated
• setFrameRate
• setScale
• toJson
• toString
• fromJson
• fromJsonArray
• toJson
• toJsonArray

Constructors

constructor

+ new VideoEncodingConfig(): VideoEncodingConfig

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

Returns: VideoEncodingConfig

Inherited from: EncodingConfig

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoEncodingConfig.ts:20

+ new VideoEncodingConfig(encoding: EncodingInfo): VideoEncodingConfig

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

Parameters:

Name	Type	Description
encoding	EncodingInfo	The encoding.

Returns: VideoEncodingConfig

Inherited from: EncodingConfig

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoEncodingConfig.ts:24

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: EncodingConfig

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoEncodingConfig.ts:113

---

fmliveswitchVideoEncodingConfigInit

▸ PrivatefmliveswitchVideoEncodingConfigInit(): void

Returns: void

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoEncodingConfig.ts:16

---

getBitrate

▸ getBitrate(): number

Gets the bitrate, in kbps.

Returns: number

Inherited from: EncodingConfig

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

---

getDeactivated

▸ getDeactivated(): boolean

Gets whether this encoding is deactivated.

Returns: boolean

Inherited from: EncodingConfig

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

---

getFrameRate

▸ getFrameRate(): number

Gets the frame-rate, in fps.

Returns: number

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoEncodingConfig.ts:133

---

getRtpStreamId

▸ getRtpStreamId(): string

Gets the RTP stream identifier.

Returns: string

Inherited from: EncodingConfig

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

---

getScale

▸ getScale(): number

Gets the target scale.

Returns: number

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoEncodingConfig.ts:143

---

getSynchronizationSource

▸ getSynchronizationSource(): number

Gets the synchronization source.

Returns: number

Inherited from: EncodingConfig

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

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: EncodingConfig

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoEncodingConfig.ts:8

---

serializeProperties

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

Serializes the properties.

Parameters:

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

Returns: void

Overrides: EncodingConfig

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoEncodingConfig.ts:154

---

setBitrate

▸ setBitrate(value: number): void

Sets the bitrate, in kbps.

Parameters:

Name	Type
value	number

Returns: void

Inherited from: EncodingConfig

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

---

setDeactivated

▸ setDeactivated(value: boolean): void

Sets whether this encoding is deactivated.

Parameters:

Name	Type
value	boolean

Returns: void

Inherited from: EncodingConfig

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

---

setFrameRate

▸ setFrameRate(value: number): void

Sets the frame-rate, in fps.

Parameters:

Name	Type
value	number

Returns: void

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoEncodingConfig.ts:170

---

setScale

▸ setScale(value: number): void

Sets the target scale.

Parameters:

Name	Type
value	number

Returns: void

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoEncodingConfig.ts:180

---

toJson

▸ toJson(): string

Serializes this instance to JSON.

Returns: string

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoEncodingConfig.ts:190

---

toString

▸ toString(): string

Returns a string that represents this instance.

Returns: string

A string that represents this instance.

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoEncodingConfig.ts:203

---

fromJson

▸ StaticfromJson(encodingConfigJson: string): VideoEncodingConfig

Deserializes an instance from JSON.

Parameters:

Name	Type	Description
encodingConfigJson	string	The serialized JSON.

Returns: VideoEncodingConfig

The deserialized instance.

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoEncodingConfig.ts:55

---

fromJsonArray

▸ StaticfromJsonArray(encodingConfigsJson: string): VideoEncodingConfig[]

Deserializes an array from JSON.

Parameters:

Name	Type	Description
encodingConfigsJson	string	The serialized JSON.

Returns: VideoEncodingConfig[]

The deserialized array.

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

---

toJson

▸ StatictoJson(encodingConfig: VideoEncodingConfig): string

Serializes an instance to JSON.

Parameters:

Name	Type	Description
encodingConfig	VideoEncodingConfig	The instance to serialize.

Returns: string

The serialized JSON.

Defined in: fm/Generated/TypeScript/fm.liveswitch/VideoEncodingConfig.ts:87

---

toJsonArray

▸ StatictoJsonArray(encodingConfigs: VideoEncodingConfig[]): string

Serializes an array to JSON.

Parameters:

Name	Type	Description
encodingConfigs	VideoEncodingConfig[]	The array to serialize.

Returns: string

The serialized JSON.

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