Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ExtMapAttribute

https://tools.ietf.org/html/rfc5285#section-5 Stream or media-level attribute used to indicate the presence of RTP Header Extensions, and the mapping of local identifiers used in the header extension to a larger namespace.

A usable mapping MUST use IDs in the valid range, and each ID in this range MUST be used only once for each media (or only once if the mappings are session level). Mappings that do not conform to these rules MAY be presented, for instance, during offer/answer negotiation as described in the next section, but remapping to conformant values is necessary before they can be applied.

Each extension is named by a URI. Each local identifier potentially used in the stream is mapped to a string using an attribute of the form: a=extmap:VALUE["/"DIRECTION] URI EXTENSIONATTRIBUTES Where URI is a URI, as above, VALUE is the local identifier (ID) of this extension and is an integer in the valid range inclusive (0 is reserved for padding in both forms, and 15 is reserved in the one-byte header form), and direction is one of "sendonly", "recvonly", "sendrecv", or "inactive" (without the quotes). Example:

a=extmap:1 http://example.com/082005/ext.htm#ttime a=extmap:2/sendrecv http://example.com/082005/ext.htm#xmeta short

Hierarchy

  • Attribute
    • ExtMapAttribute

Index

Constructors

constructor

  • RTP Extension Map Attribute.

    Parameters

    • id: number

      Local identifier of this extension and is an integer in the valid range inclusive (0 is reserved for padding in both forms, and 15 is reserved in the one-byte header form.

    • uri: string

      Well known extension identifier.

    Returns ExtMapAttribute

  • RTP Extension Map Attribute.
    RTP Extension Map Attribute.

    Returns ExtMapAttribute

  • RTP Extension Map Attribute.

    Parameters

    • id: number

      Local identifier of this extension and is an integer in the valid range inclusive (0 is reserved for padding in both forms, and 15 is reserved in the one-byte header form.

    • uri: string

      Well known extension identifier.

    • direction: StreamDirection

      Disered direction of this RTP Extension Header.

    Returns ExtMapAttribute

Properties

Private __direction

__direction: StreamDirection
internal

Private _extensionAttributes

_extensionAttributes: string
internal

Private _id

_id: number
internal

Private _uri

_uri: string
internal

Methods

getAttributeType

  • getAttributeType(): AttributeType
  • Gets this Attribute's Type.

    Returns AttributeType

Protected getAttributeValue

  • getAttributeValue(): string
  • Gets the internal value of the attribute.

    Returns string

getDirection

  • getDirection(): StreamDirection
  • Gets the direction of this extension (optional). If not present, stream direction is assumed to be the direction of the extension.

    Returns StreamDirection

getExtensionAttributes

  • getExtensionAttributes(): string
  • Gets extension attributes (optional).

    Returns string

getId

  • getId(): number
  • Gets the local identifier of this extension.

    Returns number

getTypeString

  • getTypeString(): string
  • Returns string

getUri

  • getUri(): string
  • Gets the well-known URI of this extension

    Returns string

setAttributeType

  • setAttributeType(value: AttributeType): void
  • Sets this Attribute's Type.

    Parameters

    • value: AttributeType

    Returns void

setDirection

  • setDirection(value: StreamDirection): void
  • Sets the direction of this extension (optional). If not present, stream direction is assumed to be the direction of the extension.

    Parameters

    • value: StreamDirection

    Returns void

setExtensionAttributes

  • setExtensionAttributes(value: string): void
  • Sets extension attributes (optional).

    Parameters

    • value: string

    Returns void

Private setId

  • setId(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

Private setUri

  • setUri(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

toString

  • toString(): string
  • Converts this instance to a string.

    Returns string

Static createAttribute

  • createAttribute(name: string, value: string): Attribute
  • Creates an attribute.

    Parameters

    • name: string

      The name.

    • value: string

      The value.

    Returns Attribute

Static fromAttributeValue

  • fromAttributeValue(value: string): ExtMapAttribute
  • Initializes a new instance of the fm.icelink.sdp.rtp.mapAttribute class.

    Parameters

    • value: string

      The attribute value.

    Returns ExtMapAttribute

Static getTypeName

  • getTypeName(type: Type): string
  • Gets the name of the attribute type.

    Parameters

    • type: Type

      The attribute type.

    Returns string

Static isMediaLevel

  • isMediaLevel(type: Type): boolean
  • Determines whether the type applies to media streams.

    Parameters

    • type: Type

      The type.

    Returns boolean

Static isSessionLevel

  • isSessionLevel(type: Type): boolean
  • Determines whether the type applies to sessions.

    Parameters

    • type: Type

      The type.

    Returns boolean

Static parse

  • parse(s: string): Attribute
  • Creates an fm.icelink.sdp.connectionData instance from a string.

    Parameters

    • s: string

      The string to parse.

    Returns Attribute