Search Results for

    / fm / liveswitch / FormatInfo

    Class: FormatInfo

    fm.liveswitch.FormatInfo

    Format information.

    Implements

    • IEquivalent<FormatInfo>

    Table of contents

    Constructors

    • constructor

    Methods

    • fmliveswitchFormatInfoInit
    • getChannelCount
    • getClockRate
    • getCodecName
    • getName
    • getTypeString
    • isEquivalent
    • setChannelCount
    • setClockRate
    • setCodecName
    • setName
    • toJson
    • toString
    • fromJson
    • fromJsonArray
    • fromSdpMediaDescription
    • toJson
    • toJsonArray

    Constructors

    constructor

    + new FormatInfo(): FormatInfo

    Creates a new instance of a FormatInfo.

    Returns: FormatInfo

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

    + new FormatInfo(audioFormat: AudioFormat): FormatInfo

    Creates an instance of a FormatInfo from an AudioFormat.

    Parameters:

    Name Type Description
    audioFormat AudioFormat The audio format.

    Returns: FormatInfo

    Defined in: Generated/TypeScript/fm.liveswitch/FormatInfo.ts:29

    + new FormatInfo(codecName: string, clockRate: number): FormatInfo

    Creates a new instance of a FormatInfo.

    Parameters:

    Name Type Description
    codecName string The codec name.
    clockRate number The clock rate.

    Returns: FormatInfo

    Defined in: Generated/TypeScript/fm.liveswitch/FormatInfo.ts:36

    + new FormatInfo(name: string, clockRate: number, channelCount: number): FormatInfo

    Creates a new instance of a FormatInfo.

    Parameters:

    Name Type Description
    name string The name.
    clockRate number The clock rate.
    channelCount number The channel count.

    Returns: FormatInfo

    Defined in: Generated/TypeScript/fm.liveswitch/FormatInfo.ts:44

    + new FormatInfo(videoFormat: VideoFormat): FormatInfo

    Creates an instance of a FormatInfo from a VideoFormat.

    Parameters:

    Name Type Description
    videoFormat VideoFormat The video format.

    Returns: FormatInfo

    Defined in: Generated/TypeScript/fm.liveswitch/FormatInfo.ts:53

    Methods

    fmliveswitchFormatInfoInit

    ▸ PrivatefmliveswitchFormatInfoInit(): void

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/FormatInfo.ts:19


    getChannelCount

    ▸ getChannelCount(): number

    Gets the channel count if available. Unused for video codecs.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/FormatInfo.ts:256


    getClockRate

    ▸ getClockRate(): number

    Gets the clock rate.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/FormatInfo.ts:268


    getCodecName

    ▸ getCodecName(): string

    Gets the name.

    deprecated Use Name instead.

    Returns: string

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


    getName

    ▸ getName(): string

    Gets the name.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/FormatInfo.ts:293


    getTypeString

    ▸ getTypeString(): string

    Returns: string

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


    isEquivalent

    ▸ isEquivalent(instance: FormatInfo): boolean

    Checks if an instance is equivalent to this one.

    Parameters:

    Name Type Description
    instance FormatInfo The instance.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/FormatInfo.ts:306

    ▸ isEquivalent(name: string, clockRate: number, channelCount: number): boolean

    Tests for equivalency.

    Parameters:

    Name Type Description
    name string The format name.
    clockRate number The clock rate.
    channelCount number The channel count.

    Returns: boolean

    true if equivalent; otherwise, false.

    Defined in: Generated/TypeScript/fm.liveswitch/FormatInfo.ts:317


    setChannelCount

    ▸ setChannelCount(value: number): void

    Sets the channel count if available. Unused for video codecs.

    Parameters:

    Name Type
    value number

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/FormatInfo.ts:336


    setClockRate

    ▸ setClockRate(value: number): void

    Sets the clock rate.

    Parameters:

    Name Type
    value number

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/FormatInfo.ts:349


    setCodecName

    ▸ setCodecName(value: string): void

    Sets the name.

    deprecated Use Name instead.

    Parameters:

    Name Type
    value string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/FormatInfo.ts:363


    setName

    ▸ setName(value: string): void

    Sets the name.

    Parameters:

    Name Type
    value string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/FormatInfo.ts:375


    toJson

    ▸ toJson(): string

    Serializes this instance to Json.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/FormatInfo.ts:387


    toString

    ▸ toString(): string

    Returns a string that represents this instance.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/FormatInfo.ts:399


    fromJson

    ▸ StaticfromJson(formatInfoJson: string): FormatInfo

    Deserializes Json to a FormatInfo.

    Parameters:

    Name Type Description
    formatInfoJson string The serialized Json.

    Returns: FormatInfo

    The deserialized FormatInfo.

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


    fromJsonArray

    ▸ StaticfromJsonArray(formatInfosJson: string): FormatInfo[]

    Derializes an array of format infos from JSON.

    Parameters:

    Name Type Description
    formatInfosJson string The format infos in JSON format.

    Returns: FormatInfo[]

    Defined in: Generated/TypeScript/fm.liveswitch/FormatInfo.ts:179


    fromSdpMediaDescription

    ▸ StaticfromSdpMediaDescription(sdpMediaDescription: MediaDescription): FormatInfo[]

    Converts the RTP map attributes in an SDP media description to an array of FormatInfo objects.

    Parameters:

    Name Type Description
    sdpMediaDescription MediaDescription The SDP media description.

    Returns: FormatInfo[]

    An array of FormatInfo objects.

    Defined in: Generated/TypeScript/fm.liveswitch/FormatInfo.ts:198


    toJson

    ▸ StatictoJson(formatInfo: FormatInfo): string

    Serializes an instance to Json.

    Parameters:

    Name Type Description
    formatInfo FormatInfo The instance to serialize.

    Returns: string

    Serialized Json.

    Defined in: Generated/TypeScript/fm.liveswitch/FormatInfo.ts:225


    toJsonArray

    ▸ StatictoJsonArray(formatInfos: FormatInfo[]): string

    Serializes an array of format infos to JSON.

    Parameters:

    Name Type Description
    formatInfos FormatInfo[] The format infos.

    Returns: string

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

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