Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RtpPacketHeader

The header of an Rtp packet.

Hierarchy

  • RtpPacketHeader

Index

Constructors

Properties

Methods

Constructors

constructor

  • Creates a new instance of the Packet Header.

    Returns RtpPacketHeader

Properties

Private _contributingSourceCount

_contributingSourceCount: number
internal

Private _contributingSources

_contributingSources: number[]
internal

Private _extension

_extension: boolean
internal

Private _headerExtension

_headerExtension: IRtpHeaderExtension
internal

Private _marker

_marker: boolean
internal

Private _padding

_padding: boolean
internal

Private _paddingLength

_paddingLength: number
internal

Private _payloadType

_payloadType: number
internal

Private _sequenceNumber

_sequenceNumber: number
internal

Private _synchronizationSource

_synchronizationSource: number
internal

Private _timestamp

_timestamp: number
internal

Private _version

_version: number
internal

Methods

calculateHeaderLength

  • calculateHeaderLength(): number
  • Calculates the length of the header. At least 12 bytes.

    Returns number

clone

  • clone(): RtpPacketHeader
  • Clones this RtpPacketHeader instance.

    Returns RtpPacketHeader

getContributingSourceCount

  • getContributingSourceCount(): number
  • Gets the number of contributing sources added to this rtp packet.

    Returns number

getContributingSources

  • getContributingSources(): number[]
  • Gets the contributing sources in this rtp packet.

    Returns number[]

getExtension

  • getExtension(): boolean
  • Gets if there is an extension added to this rtp packet.

    Returns boolean

getHeaderExtension

  • getHeaderExtension(): IRtpHeaderExtension
  • Gets the header extension.

    Returns IRtpHeaderExtension

getMarker

  • getMarker(): boolean
  • Gets if the marker bit is set.

    Returns boolean

getPadding

  • getPadding(): boolean
  • Gets if this rtp packet has padding.

    Returns boolean

getPaddingLength

  • getPaddingLength(): number
  • Gets the number of bytes of padding of the decoded rtp packet.

    Returns number

getPayloadType

  • getPayloadType(): number
  • Gets the payload type of this rtp packet.

    Returns number

getSequenceNumber

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

    Returns number

getSynchronizationSource

  • getSynchronizationSource(): number
  • Gets the synchronization source source of the packet.

    Returns number

getTimestamp

  • getTimestamp(): number
  • Gets the timestamp of the packet.

    Returns number

getTypeString

  • getTypeString(): string

  • Returns string

getVersion

  • getVersion(): number
  • Gets the version of the rtp packet. Should be 2.

    Returns number

setContributingSourceCount

  • setContributingSourceCount(value: number): void
  • Sets the number of contributing sources added to this rtp packet.

    Parameters

    • value: number

    Returns void

setContributingSources

  • setContributingSources(value: number[]): void
  • Sets the contributing sources in this rtp packet.

    Parameters

    • value: number[]

    Returns void

Private setExtension

  • setExtension(value: boolean): void
  • internal

    Parameters

    • value: boolean

    Returns void

setHeaderExtension

  • setHeaderExtension(value: IRtpHeaderExtension): void
  • Sets the header extension.

    Parameters

    • value: IRtpHeaderExtension

    Returns void

setMarker

  • setMarker(value: boolean): void
  • Sets if the marker bit is set.

    Parameters

    • value: boolean

    Returns void

setPadding

  • setPadding(value: boolean): void
  • Sets if this rtp packet has padding.

    Parameters

    • value: boolean

    Returns void

Private setPaddingLength

  • setPaddingLength(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

setPayloadType

  • setPayloadType(value: number): void
  • Sets the payload type of this rtp packet.

    Parameters

    • value: number

    Returns void

setSequenceNumber

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

    Parameters

    • value: number

    Returns void

setSynchronizationSource

  • setSynchronizationSource(value: number): void
  • Sets the synchronization source source of the packet.

    Parameters

    • value: number

    Returns void

setTimestamp

  • setTimestamp(value: number): void
  • Sets the timestamp of the packet.

    Parameters

    • value: number

    Returns void

setVersion

  • setVersion(value: number): void
  • Sets the version of the rtp packet. Should be 2.

    Parameters

    • value: number

    Returns void

writeTo

  • writeTo(buffer: DataBuffer, offset: number): void
  • Writes this Rtp packet to a DataBuffer starting at the offset.

    Parameters

    • buffer: DataBuffer
    • offset: number

    Returns void

Static getFixedHeaderLength

  • getFixedHeaderLength(): number
  • Gets the length of the fixed header.

    Returns number