Search Results for

    / 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: Generated/TypeScript/fm.liveswitch/VideoEncodingConfig.ts:22

    + 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: Generated/TypeScript/fm.liveswitch/VideoEncodingConfig.ts:28

    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: Generated/TypeScript/fm.liveswitch/VideoEncodingConfig.ts:129


    fmliveswitchVideoEncodingConfigInit

    ▸ PrivatefmliveswitchVideoEncodingConfigInit(): void

    Returns: void

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


    getBitrate

    ▸ getBitrate(): number

    Gets the bitrate, in kbps.

    Returns: number

    Inherited from: EncodingConfig

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


    getDeactivated

    ▸ getDeactivated(): boolean

    Gets whether this encoding is deactivated.

    Returns: boolean

    Inherited from: EncodingConfig

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


    getFrameRate

    ▸ getFrameRate(): number

    Gets the frame-rate, in fps.

    Returns: number

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


    getRtpStreamId

    ▸ getRtpStreamId(): string

    Gets the RTP stream identifier.

    Returns: string

    Inherited from: EncodingConfig

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


    getScale

    ▸ getScale(): number

    Gets the target scale.

    Returns: number

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


    getSynchronizationSource

    ▸ getSynchronizationSource(): number

    Gets the synchronization source.

    Returns: number

    Inherited from: EncodingConfig

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


    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Overrides: EncodingConfig

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


    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: Generated/TypeScript/fm.liveswitch/VideoEncodingConfig.ts:176


    setBitrate

    ▸ setBitrate(value: number): void

    Sets the bitrate, in kbps.

    Parameters:

    Name Type
    value number

    Returns: void

    Inherited from: EncodingConfig

    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

    Inherited from: EncodingConfig

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


    setFrameRate

    ▸ setFrameRate(value: number): void

    Sets the frame-rate, in fps.

    Parameters:

    Name Type
    value number

    Returns: void

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


    setScale

    ▸ setScale(value: number): void

    Sets the target scale.

    Parameters:

    Name Type
    value number

    Returns: void

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


    toJson

    ▸ toJson(): string

    Serializes this instance to JSON.

    Returns: string

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


    toString

    ▸ toString(): string

    Returns a string that represents this instance.

    Returns: string

    A string that represents this instance.

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


    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: Generated/TypeScript/fm.liveswitch/VideoEncodingConfig.ts:63


    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: Generated/TypeScript/fm.liveswitch/VideoEncodingConfig.ts:81


    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: Generated/TypeScript/fm.liveswitch/VideoEncodingConfig.ts:99


    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: Generated/TypeScript/fm.liveswitch/VideoEncodingConfig.ts:115

    In This Article
    Back to top Copyright © LiveSwitch Inc. All Rights Reserved. Doc build for LiveSwitch v1.15.0