/ fm / liveswitch / sdp / MediaStreamIdSemanticAttribute

Class: MediaStreamIdSemanticAttribute

liveswitch.sdp.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

Table of contents

Constructors

Methods

Constructors

constructor

+ new MediaStreamIdSemanticAttribute(semanticToken: Wms): MediaStreamIdSemanticAttribute

Initializes a new instance of the [[fm.liveswitch.sdp.mediaStreamIdSemanticAttribute]] class.

Parameters:

Name Type Description
semanticToken Wms The semantic token.

Returns: MediaStreamIdSemanticAttribute

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaStreamIdSemanticAttribute.ts:57

+ new MediaStreamIdSemanticAttribute(semanticToken: Wms, msidList: string): MediaStreamIdSemanticAttribute

Initializes a new instance of the [[fm.liveswitch.sdp.mediaStreamIdSemanticAttribute]] class.

Parameters:

Name Type Description
semanticToken Wms The semantic token.
msidList string The msid list for the given semantic token.

Returns: MediaStreamIdSemanticAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaStreamIdSemanticAttribute.ts:65

Methods

getAttributeType

▸ getAttributeType(): AttributeType

Gets this Attribute's Type.

Returns: AttributeType

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:582

getAttributeValue

▸ ProtectedgetAttributeValue(): string

Gets the internal value of the attribute.

Returns: string

Overrides: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaStreamIdSemanticAttribute.ts:156

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

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaStreamIdSemanticAttribute.ts:178

getMultiplexingCategory

▸ getMultiplexingCategory(): AttributeCategory

Gets the Multiplexing Category of this Attribute.

Returns: AttributeCategory

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:600

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaStreamIdSemanticAttribute.ts:51

setAttributeType

▸ setAttributeType(value: AttributeType): void

Sets this Attribute's Type.

Parameters:

Name Type
value AttributeType

Returns: void

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:612

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:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaStreamIdSemanticAttribute.ts:205

setMultiplexingCategory

▸ ProtectedsetMultiplexingCategory(value: AttributeCategory): void

Sets the Multiplexing Category of this Attribute.

Parameters:

Name Type
value AttributeCategory

Returns: void

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:624

toString

▸ toString(): string

Converts this instance to a string.

Returns: string

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:636

createAttribute

▸ StaticcreateAttribute(name: string, value: string): Attribute

Creates an attribute.

Parameters:

Name Type Description
name string The name.
value string The value.

Returns: Attribute

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:42

fromAttributeValue

▸ StaticfromAttributeValue(value: string): MediaStreamIdSemanticAttribute

Initializes a new instance of the [[fm.liveswitch.sdp.mediaStreamIdSemanticAttribute]] class.

Parameters:

Name Type Description
value string The attribute value.

Returns: MediaStreamIdSemanticAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/MediaStreamIdSemanticAttribute.ts:112

getTypeName

▸ StaticgetTypeName(type: Type): string

Gets the name of the attribute type.

Parameters:

Name Type Description
type Type The attribute type.

Returns: string

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:467

isMediaLevel

▸ StaticisMediaLevel(type: Type): boolean

Determines whether the type applies to media streams.

Parameters:

Name Type Description
type Type The type.

Returns: boolean

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:492

isSessionLevel

▸ StaticisSessionLevel(type: Type): boolean

Determines whether the type applies to sessions.

Parameters:

Name Type Description
type Type The type.

Returns: boolean

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:516

parse

▸ Staticparse(s: string): Attribute

Creates an [[fm.liveswitch.sdp.connectionData]] instance from a string.

Parameters:

Name Type Description
s string The string to parse.

Returns: Attribute

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:540