Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MapAttribute

This attribute maps from an RTP payload type number (as used in an "m=" line) to an format name denoting the payload format to be used. It also provides information on the clock rate and format parameters. It is a media-level attribute that is not dependent on charset.

Hierarchy

  • Attribute
    • MapAttribute

Index

Constructors

Properties

Methods

Constructors

constructor

  • new MapAttribute(payloadType: number, formatName: string, clockRate: number): MapAttribute
  • new MapAttribute(): MapAttribute
  • new MapAttribute(payloadType: number, formatName: string, clockRate: number, formatParameters: string): MapAttribute
  • Initializes a new instance of the fm.icelink.sdp.rtp.mapAttribute class.

    Parameters

    • payloadType: number

      The RTP payload type number.

    • formatName: string

      The format name denoting the payload format to be used.

    • clockRate: number

      The payload clock rate.

    Returns MapAttribute

  • Initializes a new instance of the fm.icelink.sdp.rtp.mapAttribute class.
    Initializes a new instance of the fm.icelink.sdp.rtp.mapAttribute class.

    Returns MapAttribute

  • Initializes a new instance of the fm.icelink.sdp.rtp.mapAttribute class.

    Parameters

    • payloadType: number

      The RTP payload type number.

    • formatName: string

      The format name denoting the payload format to be used.

    • clockRate: number

      The payload clock rate.

    • formatParameters: string

      The format parameters for the payload.

    Returns MapAttribute

Properties

Private __relatedRtcpFeedbackAttributes

__relatedRtcpFeedbackAttributes: FeedbackAttributeCollection
internal

Private _clockRate

_clockRate: number
internal

Private _formatName

_formatName: string
internal

Private _formatParameters

_formatParameters: string
internal

Private _payloadType

_payloadType: number
internal

Private _relatedFormatParametersAttribute

_relatedFormatParametersAttribute: FormatParametersAttribute
internal

Methods

addRelatedRtcpFeedbackAttribute

  • addRelatedRtcpFeedbackAttribute(attribute: FeedbackAttribute): void
  • Adds an Rtcp Feedback attribute associated with this Map Attribute.

    Parameters

    • attribute: FeedbackAttribute

    Returns void

getAttributeType

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

    Returns AttributeType

Protected getAttributeValue

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

    Returns string

getClockRate

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

    Returns number

getFormatName

  • getFormatName(): string
  • Gets the format name denoting the payload format to be used.

    Returns string

getFormatParameters

  • getFormatParameters(): string
  • Gets format parameters for the payload.

    Returns string

getPayloadType

  • getPayloadType(): number
  • Gets the RTP payload type number.

    Returns number

getRelatedCcmFirFeedbackAttribute

  • getRelatedCcmFirFeedbackAttribute(): FeedbackAttribute
  • Gets the RTCP "ccm fir" feedback attribute associated with this payload type.

    Returns FeedbackAttribute

getRelatedFormatParametersAttribute

  • getRelatedFormatParametersAttribute(): FormatParametersAttribute
  • Gets Format Parameters attribute associated with this Map Attribute

    Returns FormatParametersAttribute

getRelatedNackFeedbackAttribute

  • getRelatedNackFeedbackAttribute(): FeedbackAttribute
  • Gets the RTCP "nack" feedback attribute associated with this payload type.

    Returns FeedbackAttribute

getRelatedNackPliFeedbackAttribute

  • getRelatedNackPliFeedbackAttribute(): FeedbackAttribute
  • Gets the RTCP "nack pli" feedback attribute associated with this payload type.

    Returns FeedbackAttribute

getRelatedNackRpsiFeedbackAttribute

  • getRelatedNackRpsiFeedbackAttribute(): FeedbackAttribute
  • Gets the RTCP "nack rpsi" feedback attribute associated with this payload type.

    Returns FeedbackAttribute

getRelatedNackSliFeedbackAttribute

  • getRelatedNackSliFeedbackAttribute(): FeedbackAttribute
  • Gets the RTCP "nack sli" feedback attribute associated with this payload type.

    Returns FeedbackAttribute

getRelatedRembFeedbackAttribute

  • getRelatedRembFeedbackAttribute(): FeedbackAttribute
  • Gets the RTCP "goog-remb" feedback attribute associated with this payload type.

    Returns FeedbackAttribute

getRelatedRtcpFeedbackAttribute

  • getRelatedRtcpFeedbackAttribute(payloadType: number, type: string, subType: string): FeedbackAttribute
  • getRelatedRtcpFeedbackAttribute(type: string, subType: string): FeedbackAttribute
  • Gets the RTCP feedback attribute for the given payload type, type and subtype associated with this payload type.

    Parameters

    • payloadType: number

      The payload type.

    • type: string

      The type.

    • subType: string

      The sub-type.

    Returns FeedbackAttribute

  • Gets the RTCP feedback attribute for the given type and subtype associated with this payload type.

    Parameters

    • type: string

      The type.

    • subType: string

      The sub-type.

    Returns FeedbackAttribute

getRelatedRtcpFeedbackAttributes

  • getRelatedRtcpFeedbackAttributes(): FeedbackAttribute[]
  • Gets Rtcp Feedback attributes associated with this Map Attribute.

    Returns FeedbackAttribute[]

getTypeString

  • getTypeString(): string

  • Returns string

removeRelatedRtcpFeedbackAttribute

  • removeRelatedRtcpFeedbackAttribute(attribute: FeedbackAttribute): boolean
  • Removes an Rtcp Feedback attribute associated with this Map Attribute. Returns true if the attribute was reomved; if the attribute was not present, returns false.

    Parameters

    • attribute: FeedbackAttribute

    Returns boolean

resetRtcpFeedbackAttributes

  • resetRtcpFeedbackAttributes(attributes: FeedbackAttribute[]): void
  • Resets Rtcp Feedback attributes associated with this Map Attribute.

    Parameters

    • attributes: FeedbackAttribute[]

    Returns void

setAttributeType

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

    Parameters

    • value: AttributeType

    Returns void

Private setClockRate

  • setClockRate(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

Private setFormatName

  • setFormatName(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

Private setFormatParameters

  • setFormatParameters(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

Private setPayloadType

  • setPayloadType(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

setRelatedFormatParametersAttribute

  • setRelatedFormatParametersAttribute(value: FormatParametersAttribute): void
  • Sets Format Parameters attribute associated with this Map Attribute

    Parameters

    • value: FormatParametersAttribute

    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): MapAttribute
  • Initializes a new instance of the fm.icelink.sdp.rtp.mapAttribute class.

    Parameters

    • value: string

      The attribute value.

    Returns MapAttribute

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