Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MediaFormat<TFormat>

A media format.

Type parameters

  • TFormat: MediaFormat<TFormat>

Hierarchy

  • MediaFormat

Index

Constructors

Properties

Methods

Constructors

constructor

  • Initializes a new instance of the fm.icelink.mediaFormat class.

    Returns MediaFormat

  • Initializes a new instance of the fm.icelink.mediaFormat class.

    Parameters

    • name: string

      The name.

    • clockRate: number

      The clock rate.

    Returns MediaFormat

Properties

Private _clockRate

_clockRate: number
internal

Private _isEncrypted

_isEncrypted: boolean
internal

Private _isInjected

_isInjected: boolean
internal

Private _isPacketized

_isPacketized: boolean
internal

Private _name

_name: string
internal

Private _registeredPayloadType

_registeredPayloadType: number
internal

Private _staticPayloadType

_staticPayloadType: number
internal

Methods

clone

  • clone(): TFormat
  • Clones this instance.

    Returns TFormat

Protected Abstract createInstance

  • createInstance(): TFormat
  • Creates a new instance.

    Returns TFormat

getClockRate

  • getClockRate(): number
  • Gets the clock rate.

    Returns number

getFullName

  • getFullName(): string
  • Gets the full name, including clock rate and encoding parameters.

    Returns string

getIsEncrypted

  • getIsEncrypted(): boolean
  • Gets a value indicating that the data is encrypted.

    Returns boolean

getIsInjected

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

    Returns boolean

getIsPacketized

  • getIsPacketized(): boolean
  • Gets a value indicating that the data is packetized for network transmission.

    Returns boolean

getName

  • getName(): string
  • Gets the name.

    Returns string

Abstract getParameters

  • getParameters(): string
  • Gets the parameters.

    Returns string

getRegisteredPayloadType

  • getRegisteredPayloadType(): number
  • internal

    Returns number

getStaticPayloadType

  • getStaticPayloadType(): number
  • Gets the static payload type, if this format has a static payload type registered with IANA.

    Returns number

getTypeString

  • getTypeString(): string

  • Returns string

isEquivalent

  • isEquivalent(format: TFormat, ignoreIsPacketized: boolean): boolean
  • Determines whether the specified format is equivalent.

    Parameters

    • format: TFormat

      The format.

    • ignoreIsPacketized: boolean

      Whether to ignore if the two formats differ in whether they are packetized.

    Returns boolean

setClockRate

  • setClockRate(value: number): void
  • Sets the clock rate.

    Parameters

    • value: number

    Returns void

setIsEncrypted

  • setIsEncrypted(value: boolean): void
  • Sets a value indicating that the data is encrypted.

    Parameters

    • value: boolean

    Returns void

setIsInjected

  • setIsInjected(value: boolean): void
  • Sets a value indicating that the data is injected into the primary media stream (e.g. DTMF).

    Parameters

    • value: boolean

    Returns void

setIsPacketized

  • setIsPacketized(value: boolean): void
  • Sets a value indicating that the data is packetized for network transmission.

    Parameters

    • value: boolean

    Returns void

setName

  • setName(value: string): void
  • Sets the name.

    Parameters

    • value: string

    Returns void

setRegisteredPayloadType

  • setRegisteredPayloadType(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

Protected setStaticPayloadType

  • setStaticPayloadType(value: number): void
  • Sets the static payload type, if this format has a static payload type registered with IANA.

    Parameters

    • value: number

    Returns void

toString

  • toString(): string
  • Returns a string that represents this instance.

    Returns string

Static getRedName

  • getRedName(): string
  • Gets the name of the RED media format.

    Returns string

Static getUlpFecName

  • getUlpFecName(): string
  • Gets the name of the ULPFEC media format.

    Returns string