Search Results for

    / fm / liveswitch / MediaFormat

    Class: MediaFormat<TFormat>

    fm.liveswitch.MediaFormat

    A media format.

    Type parameters

    Name Type
    TFormat MediaFormat<TFormat>

    Hierarchy

    • MediaFormat

      ↳ AudioFormat

      ↳ VideoFormat

    Table of contents

    Constructors

    • constructor

    Methods

    • clone
    • createInstance
    • fmliveswitchMediaFormatInit
    • getClockRate
    • getFullName
    • getInfo
    • getIsCompressed
    • getIsEncrypted
    • getIsFixedBitrate
    • getIsInjected
    • getIsPacketized
    • getLevel
    • getLevelIsStrict
    • getMaxBitrate
    • getMaxLevel
    • getMinBitrate
    • getMinLevel
    • getName
    • getPacketizationMode
    • getParameters
    • getProfile
    • getStaticPayloadType
    • getTier
    • getTypeString
    • isCompatible
    • isEquivalent
    • isLevelCompatible
    • isProfileCompatible
    • setClockRate
    • setIsEncrypted
    • setIsFixedBitrate
    • setIsInjected
    • setIsPacketized
    • setLevel
    • setLevelIsStrict
    • setName
    • setPacketizationMode
    • setProfile
    • setStaticPayloadType
    • setTier
    • toString
    • updateLevelIsStrictToCompatible
    • updateLevelToCompatible
    • updateProfileToCompatible
    • updateTierToCompatible
    • getRedName
    • getUlpFecName

    Constructors

    constructor

    + new MediaFormat<TFormat>(): MediaFormat<TFormat>

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

    Type parameters:

    Name Type
    TFormat MediaFormat<TFormat, TFormat>

    Returns: MediaFormat<TFormat>

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:49

    + new MediaFormat<TFormat>(name: string, clockRate: number): MediaFormat<TFormat>

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

    Type parameters:

    Name Type
    TFormat MediaFormat<TFormat, TFormat>

    Parameters:

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

    Returns: MediaFormat<TFormat>

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

    + new MediaFormat<TFormat>(name: string, clockRate: number, packetizationMode: string): MediaFormat<TFormat>

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

    Type parameters:

    Name Type
    TFormat MediaFormat<TFormat, TFormat>

    Parameters:

    Name Type Description
    name string The name.
    clockRate number The clock rate.
    packetizationMode string The packetization mode.

    Returns: MediaFormat<TFormat>

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:63

    + new MediaFormat<TFormat>(name: string, clockRate: number, profile: string, level: string): MediaFormat<TFormat>

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

    Type parameters:

    Name Type
    TFormat MediaFormat<TFormat, TFormat>

    Parameters:

    Name Type Description
    name string The name.
    clockRate number The clock rate.
    profile string The media format profile.
    level string The media format level.

    Returns: MediaFormat<TFormat>

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:72

    + new MediaFormat<TFormat>(name: string, clockRate: number, profile: string, level: string, packetizationMode: string): MediaFormat<TFormat>

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

    Type parameters:

    Name Type
    TFormat MediaFormat<TFormat, TFormat>

    Parameters:

    Name Type Description
    name string The name.
    clockRate number The clock rate.
    profile string The media format profile
    level string The media format level
    packetizationMode string The packetization mode.

    Returns: MediaFormat<TFormat>

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:82

    + new MediaFormat<TFormat>(name: string, clockRate: number, profile: string, level: string, packetizationMode: string, tier: string): MediaFormat<TFormat>

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

    Type parameters:

    Name Type
    TFormat MediaFormat<TFormat, TFormat>

    Parameters:

    Name Type Description
    name string The name.
    clockRate number The clock rate.
    profile string The media format profile
    level string The media format level
    packetizationMode string The packetization mode.
    tier string The media format tier.

    Returns: MediaFormat<TFormat>

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:93

    Methods

    clone

    ▸ clone(): TFormat

    Clones this instance.

    Returns: TFormat

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


    createInstance

    ▸ Protected AbstractcreateInstance(): TFormat

    Creates a new instance.

    Returns: TFormat

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:219


    fmliveswitchMediaFormatInit

    ▸ PrivatefmliveswitchMediaFormatInit(): void

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:39


    getClockRate

    ▸ getClockRate(): number

    Gets the clock rate.

    Returns: number

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


    getFullName

    ▸ getFullName(): string

    Gets the full name, including clock rate and encoding parameters.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:237


    getInfo

    ▸ AbstractgetInfo(): FormatInfo

    Gets this format as an info object.

    Returns: FormatInfo

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


    getIsCompressed

    ▸ AbstractgetIsCompressed(): boolean

    Gets whether this is a compressed format.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:262


    getIsEncrypted

    ▸ getIsEncrypted(): boolean

    Gets a value indicating that the data is encrypted.

    Returns: boolean

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


    getIsFixedBitrate

    ▸ getIsFixedBitrate(): boolean

    Gets a value indicating whether a format only supports fixed bitrate.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:280


    getIsInjected

    ▸ getIsInjected(): boolean

    Gets a value indicating that the data is injected into the primary media stream (e.g. DTMF).

    Returns: boolean

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


    getIsPacketized

    ▸ getIsPacketized(): boolean

    Gets a value indicating whether the data is packetized.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:305


    getLevel

    ▸ getLevel(): string

    Gets the level.

    Returns: string

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


    getLevelIsStrict

    ▸ getLevelIsStrict(): boolean

    Gets a value indicating whether the level is strict.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:329


    getMaxBitrate

    ▸ getMaxBitrate(): number

    Gets the maximum bitrate supported by this format, in kbps.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:341


    getMaxLevel

    ▸ ProtectedgetMaxLevel(level1: string, level2: string): string

    Gets the maximum level.

    Parameters:

    Name Type Description
    level1 string The first level.
    level2 string The second level.

    Returns: string

    The maximum level.

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:356


    getMinBitrate

    ▸ getMinBitrate(): number

    Gets the minimum bitrate supported by this format, in kbps.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:368


    getMinLevel

    ▸ ProtectedgetMinLevel(level1: string, level2: string): string

    Gets the minimum level.

    Parameters:

    Name Type Description
    level1 string The first level.
    level2 string The second level.

    Returns: string

    The minimum level.

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:383


    getName

    ▸ getName(): string

    Gets the name.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:395


    getPacketizationMode

    ▸ getPacketizationMode(): string

    Gets the packetization mode.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:407


    getParameters

    ▸ AbstractgetParameters(): string

    Gets the parameters.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:422


    getProfile

    ▸ getProfile(): string

    Gets the profile.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:428


    getStaticPayloadType

    ▸ getStaticPayloadType(): number

    Gets the static payload type, if this format has a static payload type registered with IANA.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:449


    getTier

    ▸ getTier(): string

    Gets the tier.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:461


    getTypeString

    ▸ getTypeString(): string

    Returns: string

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


    isCompatible

    ▸ isCompatible(format: TFormat): boolean

    Determines whether the specified format is compatible.

    Parameters:

    Name Type Description
    format TFormat The format.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:502


    isEquivalent

    ▸ isEquivalent(format: TFormat, ignoreIsPacketized: boolean): boolean

    Determines whether the specified format is equivalent.

    Parameters:

    Name Type Description
    format TFormat The format.
    ignoreIsPacketized boolean Whether to ignore if the two formats differ in whether they are packetized.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:540


    isLevelCompatible

    ▸ ProtectedisLevelCompatible(level: string): boolean

    Gets whether a level is compatible.

    Parameters:

    Name Type Description
    level string The level.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:597


    isProfileCompatible

    ▸ ProtectedisProfileCompatible(profile: string): boolean

    Gets whether a profile is compatible.

    Parameters:

    Name Type Description
    profile string The profile.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:610


    setClockRate

    ▸ setClockRate(value: number): void

    Sets the clock rate.

    Parameters:

    Name Type
    value number

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:622


    setIsEncrypted

    ▸ setIsEncrypted(value: boolean): void

    Sets a value indicating that the data is encrypted.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:635


    setIsFixedBitrate

    ▸ ProtectedsetIsFixedBitrate(value: boolean): void

    Sets a value indicating whether a format only supports fixed bitrate.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:647


    setIsInjected

    ▸ setIsInjected(value: boolean): void

    Sets a value indicating that the data is injected into the primary media stream (e.g. DTMF).

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:660


    setIsPacketized

    ▸ setIsPacketized(value: boolean): void

    Sets a value indicating whether the data is packetized.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:672


    setLevel

    ▸ setLevel(value: string): void

    Sets the level.

    Parameters:

    Name Type
    value string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:684


    setLevelIsStrict

    ▸ setLevelIsStrict(value: boolean): void

    Sets a value indicating whether the level is strict.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:696


    setName

    ▸ setName(value: string): void

    Sets the name.

    Parameters:

    Name Type
    value string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:708


    setPacketizationMode

    ▸ setPacketizationMode(value: string): void

    Sets the packetization mode.

    Parameters:

    Name Type
    value string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:723


    setProfile

    ▸ setProfile(value: string): void

    Sets the profile.

    Parameters:

    Name Type
    value string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:735


    setStaticPayloadType

    ▸ ProtectedsetStaticPayloadType(value: number): void

    Sets the static payload type, if this format has a static payload type registered with IANA.

    Parameters:

    Name Type
    value number

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:757


    setTier

    ▸ setTier(value: string): void

    Sets the tier.

    Parameters:

    Name Type
    value string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:770


    toString

    ▸ toString(): string

    Returns a string that represents this instance.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:782


    updateLevelIsStrictToCompatible

    ▸ ProtectedupdateLevelIsStrictToCompatible(format: TFormat): void

    Updates the level-is-strict flag to a compatible value.

    Parameters:

    Name Type Description
    format TFormat The format.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:815


    updateLevelToCompatible

    ▸ ProtectedupdateLevelToCompatible(format: TFormat): void

    Updates the level to a compatible value.

    Parameters:

    Name Type Description
    format TFormat The format.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:830


    updateProfileToCompatible

    ▸ ProtectedupdateProfileToCompatible(format: TFormat): void

    Updates the profile to a compatible value.

    Parameters:

    Name Type Description
    format TFormat The format.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:855


    updateTierToCompatible

    ▸ ProtectedupdateTierToCompatible(format: TFormat): void

    Updates the tier to a compatible value.

    Parameters:

    Name Type Description
    format TFormat The format.

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:870


    getRedName

    ▸ StaticgetRedName(): string

    Gets the name of the RED media format.

    Returns: string

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


    getUlpFecName

    ▸ StaticgetUlpFecName(): string

    Gets the name of the ULPFEC media format.

    Returns: string

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

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