/ fm / liveswitch / sdp / rtp / ExtMapAttribute

Class: ExtMapAttribute

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

Table of contents

Constructors

Methods

Constructors

constructor

+ new ExtMapAttribute(): ExtMapAttribute

Returns: ExtMapAttribute

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/ExtMapAttribute.ts:46

+ new ExtMapAttribute(idValue: number, uri: string): ExtMapAttribute

RTP Extension Map Attribute.

Parameters:

Name Type Description
idValue 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

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/ExtMapAttribute.ts:47

+ new ExtMapAttribute(idValue: number, uri: string, direction: StreamDirection): ExtMapAttribute

RTP Extension Map Attribute.

Parameters:

Name Type Description
idValue 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

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/ExtMapAttribute.ts:55

Methods

fmliveswitchsdprtpExtMapAttributeInit

▸ PrivatefmliveswitchsdprtpExtMapAttributeInit(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/ExtMapAttribute.ts:43

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/rtp/ExtMapAttribute.ts:161

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

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/ExtMapAttribute.ts:186

getExtensionAttributes

▸ getExtensionAttributes(): string

Gets extension attributes (optional).

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/ExtMapAttribute.ts:198

getId

▸ getId(): number

Gets the local identifier of this extension.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/ExtMapAttribute.ts:210

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/rtp/ExtMapAttribute.ts:31

getUri

▸ getUri(): string

Gets the well-known URI of this extension

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/ExtMapAttribute.ts:222

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

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:

Name Type
value StreamDirection

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/ExtMapAttribute.ts:234

setExtensionAttributes

▸ setExtensionAttributes(value: string): void

Sets extension attributes (optional).

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/ExtMapAttribute.ts:246

setId

▸ setId(value: number): void

Sets the local identifier of this extension.

Parameters:

Name Type
value number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/ExtMapAttribute.ts:258

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): ExtMapAttribute

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

Parameters:

Name Type Description
value string The attribute value.

Returns: ExtMapAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/ExtMapAttribute.ts:124

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