Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MediaBuffer<TFormat, TBuffer>

A media buffer.
The type of the format.The type of the buffer.

Type parameters

  • TFormat: MediaFormat<TFormat>

  • TBuffer: MediaBuffer<TFormat, TBuffer>

Hierarchy

  • Dynamic
    • MediaBuffer

Index

Constructors

Properties

Methods

Constructors

constructor

  • new MediaBuffer(dataBuffers: DataBuffer[], format: TFormat): MediaBuffer
  • new MediaBuffer(dataBuffer: DataBuffer, format: TFormat): MediaBuffer
  • new MediaBuffer(): MediaBuffer
  • Initializes a new instance of the fm.icelink.mediaBuffer class.

    Parameters

    • dataBuffers: DataBuffer[]

      The data buffers.

    • format: TFormat

      The format.

    Returns MediaBuffer

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

    Parameters

    • dataBuffer: DataBuffer

      The data buffer.

    • format: TFormat

      The format.

    Returns MediaBuffer

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

    Returns MediaBuffer

Properties

Private _dataBuffers

_dataBuffers: DataBuffer[]
internal

Private _format

_format: TFormat
internal

Private _recoveredByFec

_recoveredByFec: boolean
internal

Private _rtpHeaders

_rtpHeaders: RtpPacketHeader[]
internal

Private _sequenceNumbers

_sequenceNumbers: number[]
internal

Private _sourceId

_sourceId: string
internal

Methods

clone

  • clone(): TBuffer
  • Clones this instance.

    Returns TBuffer

Protected Abstract createInstance

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

    Returns TBuffer

free

  • free(): void
  • Frees the data buffers referenced by this instance.

    Returns void

getDataBuffer

  • getDataBuffer(): DataBuffer
  • Gets the data buffer.

    Returns DataBuffer

getDataBuffers

  • getDataBuffers(): DataBuffer[]
  • Gets the data buffers.

    Returns DataBuffer[]

getDynamicProperties

  • getDynamicProperties(): Hash<string, Object>
  • Gets the dynamic properties on this instance.

    Returns Hash<string, Object>

getDynamicValue

  • getDynamicValue(key: string): Object
  • Gets a property value from the local cache.

    Parameters

    • key: string

      The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

    Returns Object

    The stored value, if found; otherwise null.

getFormat

  • getFormat(): TFormat
  • Gets the format.

    Returns TFormat

getIsDirty

  • getIsDirty(): boolean
  • Gets a value indicating whether this instance is dirty.
    internal

    Returns boolean

Abstract getIsMuted

  • getIsMuted(): boolean
  • Gets a value indicating whether this instance has been muted.

    Returns boolean

getIsPacketized

  • getIsPacketized(): boolean
  • internal

    Returns boolean

getIsSerialized

  • getIsSerialized(): boolean

getLastSequenceNumber

  • getLastSequenceNumber(): number
  • Gets the last sequence number.

    Returns number

getRecoveredByFec

  • getRecoveredByFec(): boolean
  • Gets a value indicating whether this buffer contains data recovered by forward error correction (FEC).

    Returns boolean

getRtpHeader

  • getRtpHeader(): RtpPacketHeader
  • Gets the Rtp Packet Header for this media buffer.

    Returns RtpPacketHeader

getRtpHeaders

  • getRtpHeaders(): RtpPacketHeader[]
  • Gets the Rtp Packet Headers for this media buffer.

    Returns RtpPacketHeader[]

getRtpSequenceNumber

  • getRtpSequenceNumber(): number
  • Gets the RTP sequence number.

    Returns number

getRtpSequenceNumbers

  • getRtpSequenceNumbers(): number[]
  • Gets the RTP sequence numbers.

    Returns number[]

getSequenceNumber

  • getSequenceNumber(): number
  • Gets the sequence number.

    Returns number

getSequenceNumbers

  • getSequenceNumbers(): number[]
  • Gets the sequence numbers.

    Returns number[]

getSerialized

  • getSerialized(): string

getSourceId

  • getSourceId(): string
  • Gets the source identifier.

    Returns string

getTypeString

  • getTypeString(): string

keep

  • keep(): void
  • Keeps the data buffers referenced by this instance.

    Returns void

Abstract mute

  • mute(): boolean
  • Mutes this instance. This is a one-way operation that clears the underlying data buffer. If the buffer has an unsupported format, this method will return false.

    Returns boolean

setDataBuffer

  • setDataBuffer(value: DataBuffer): void
  • Sets the data buffer.

    Parameters

    • value: DataBuffer

    Returns void

setDataBuffers

  • setDataBuffers(value: DataBuffer[]): void
  • Sets the data buffers.

    Parameters

    • value: DataBuffer[]

    Returns void

setDynamicProperties

  • setDynamicProperties(value: Hash<string, Object>): void
  • internal

    Parameters

    • value: Hash<string, Object>

    Returns void

setDynamicValue

  • setDynamicValue(key: string, value: Object): void
  • Sets a property value in the local cache.

    Parameters

    • key: string

      The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

    • value: Object

      The property value. This can be any object that needs to be stored for future use.

    Returns void

setFormat

  • setFormat(value: TFormat): void
  • Sets the format.

    Parameters

    • value: TFormat

    Returns void

setIsDirty

  • setIsDirty(value: boolean): void
  • Sets a value indicating whether this instance is dirty.
    internal

    Parameters

    • value: boolean

    Returns void

setIsSerialized

  • setIsSerialized(value: boolean): void
  • internal

    Parameters

    • value: boolean

    Returns void

setRecoveredByFec

  • setRecoveredByFec(value: boolean): void
  • Sets a value indicating whether this buffer contains data recovered by forward error correction (FEC).

    Parameters

    • value: boolean

    Returns void

setRtpHeader

  • setRtpHeader(value: RtpPacketHeader): void
  • Sets the Rtp Packet Header for this media buffer.

    Parameters

    • value: RtpPacketHeader

    Returns void

setRtpHeaders

  • setRtpHeaders(value: RtpPacketHeader[]): void
  • Sets the Rtp Packet Headers for this media buffer.

    Parameters

    • value: RtpPacketHeader[]

    Returns void

setSequenceNumber

  • setSequenceNumber(value: number): void
  • Sets the sequence number.

    Parameters

    • value: number

    Returns void

setSequenceNumbers

  • setSequenceNumbers(value: number[]): void
  • Sets the sequence numbers.

    Parameters

    • value: number[]

    Returns void

setSerialized

  • setSerialized(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

setSourceId

  • setSourceId(value: string): void
  • Sets the source identifier.

    Parameters

    • value: string

    Returns void

toString

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

    Returns string

unsetDynamicValue

  • unsetDynamicValue(key: string): boolean
  • Unsets a property value in the local cache.

    Parameters

    • key: string

      The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

    Returns boolean

    true if the value was removed; otherwise, false.