Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MediaStreamIdSemanticAttribute

https://tools.ietf.org/html/draft-ietf-mmusic-msid-08 - NB: Removed in subsequent drafts, most likely will not be used eventually. Used here for compatibility with Google Chrome and Mozilla Firefox.

A session-level attribute is defined for signalling the semantics associated with an msid grouping.This allows msid groupings with different semantics to coexist.

This OPTIONAL attribute gives the group identifier and its group semantic; it carries the same meaning as the ssrc-group-attr of RFC 5576 section 4.2, but uses the identifier of the group rather than a list of SSRC values.

This attribute MUST be present if "a=msid" is used.

An empty list of identifiers is an indication that the sender supports the indicated semantic, but has no msid groupings of the given type in the present SDP.

An identifier of "" is an indication that all "a=msid" lines in the SDP have this specific semantic. If "" is not used, each msid-id in the SDP MUST appear in one and only one "msid-semantic" line. The name of the attribute is "msid-semantic". The value of the attribute is given by the following ABNF:

msid-semantic-value = msid - semantic msid-list msid-semantic = token ; see RFC 4566 msid-list = (" " msid-id) / " "

The semantic field holds values from the IANA registriy "Semantics for the msid-semantic SDP attribute" (which is defined in Section 6 of https://tools.ietf.org/html/draft-ietf-mmusic-msid-08 ).

An example msid-semantic might look like this, if a semantic LS was registered by IANA for the same purpose as the existing LS grouping semantic:

a= msid-semantic:LS xyzzy forolow

This means that the SDP description has two lip sync groups, with the group identifiers xyzzy and forolow, respectively.

The msid-semantic attribute can occur more than once, but MUST NOT occur more than once with the same msid-semantic value.

Hierarchy

  • Attribute
    • MediaStreamIdSemanticAttribute

Index

Constructors

Properties

Methods

Constructors

constructor

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

    Parameters

    Returns MediaStreamIdSemanticAttribute

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

    Parameters

    Returns MediaStreamIdSemanticAttribute

Properties

Private _msIdList

_msIdList: string
internal

Private _semanticToken

_semanticToken: MediaStreamIdSemanticToken
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

getMsIdList

  • getMsIdList(): string

  • Gets the space-delimited list of msids for which a given semantic is used. An empty list of identifiers is an indication that the sender supports the indicated semantic, but has no msid groupings of the given type in the present SDP.

    An identifier of "" is an indication that all "a=msid" lines in the SDP have this specific semantic. If "" is not used, each msid-id in the SDP MUST appear in one and only one "msid-semantic" line.

    Returns string

Private getSemanticToken

getTypeString

  • getTypeString(): string

  • Returns string

setAttributeType

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

    Parameters

    • value: AttributeType

    Returns void

setMsIdList

  • setMsIdList(value: string): void

  • Sets the space-delimited list of msids for which a given semantic is used. An empty list of identifiers is an indication that the sender supports the indicated semantic, but has no msid groupings of the given type in the present SDP.

    An identifier of "" is an indication that all "a=msid" lines in the SDP have this specific semantic. If "" is not used, each msid-id in the SDP MUST appear in one and only one "msid-semantic" line.

    Parameters

    • value: string

    Returns void

Private setSemanticToken

  • internal

    Parameters

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

    Parameters

    • value: string

      The attribute value.

    Returns MediaStreamIdSemanticAttribute

Static Private getSemanticTokenFromString

  • internal

    Parameters

    • semanticToken: string

    Returns MediaStreamIdSemanticToken

Static Private getSemanticTokenString

  • internal

    Parameters

    Returns string

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