/ fm / liveswitch / sdp / rtp / MapAttribute

Class: MapAttribute

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

Table of contents

Constructors

Methods

Constructors

constructor

+ new MapAttribute(): MapAttribute

Returns: MapAttribute

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/MapAttribute.ts:36

+ new MapAttribute(payloadType: number, formatName: string, clockRate: number): MapAttribute

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

Parameters:

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

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/MapAttribute.ts:37

+ new MapAttribute(payloadType: number, formatName: string, clockRate: number, formatParameters: string): MapAttribute

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

Parameters:

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

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

Methods

addRelatedRtcpFeedbackAttribute

▸ addRelatedRtcpFeedbackAttribute(attribute: FeedbackAttribute): void

Adds an Rtcp Feedback attribute associated with this Map Attribute.

Parameters:

Name Type
attribute FeedbackAttribute

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/MapAttribute.ts:185

fmliveswitchsdprtpMapAttributeInit

▸ PrivatefmliveswitchsdprtpMapAttributeInit(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/MapAttribute.ts:32

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/MapAttribute.ts:197

getClockRate

▸ getClockRate(): number

Gets the payload clock rate.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/MapAttribute.ts:219

getFormatName

▸ getFormatName(): string

Gets the format name denoting the payload format to be used.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/MapAttribute.ts:231

getFormatParameters

▸ getFormatParameters(): string

Gets format parameters for the payload.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/MapAttribute.ts:243

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

getPayloadType

▸ getPayloadType(): number

Gets the RTP payload type number.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/MapAttribute.ts:255

getRelatedCcmFirFeedbackAttribute

▸ getRelatedCcmFirFeedbackAttribute(): FeedbackAttribute

Gets the RTCP "ccm fir" feedback attribute associated with this payload type.

Returns: FeedbackAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/MapAttribute.ts:267

getRelatedCcmLrrFeedbackAttribute

▸ getRelatedCcmLrrFeedbackAttribute(): FeedbackAttribute

Gets the RTCP "ccm lrr" feedback attribute associated with this payload type.

Returns: FeedbackAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/MapAttribute.ts:279

getRelatedCcmTmmbnFeedbackAttribute

▸ getRelatedCcmTmmbnFeedbackAttribute(): FeedbackAttribute

Gets the RTCP "ccm tmmbn" feedback attribute associated with this payload type.

Returns: FeedbackAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/MapAttribute.ts:291

getRelatedCcmTmmbrFeedbackAttribute

▸ getRelatedCcmTmmbrFeedbackAttribute(): FeedbackAttribute

Gets the RTCP "ccm tmmbr" feedback attribute associated with this payload type.

Returns: FeedbackAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/MapAttribute.ts:303

getRelatedFormatParametersAttribute

▸ getRelatedFormatParametersAttribute(): FormatParametersAttribute

Gets Format Parameters attribute associated with this Map Attribute

Returns: FormatParametersAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/MapAttribute.ts:315

getRelatedNackFeedbackAttribute

▸ getRelatedNackFeedbackAttribute(): FeedbackAttribute

Gets the RTCP "nack" feedback attribute associated with this payload type.

Returns: FeedbackAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/MapAttribute.ts:327

getRelatedNackPliFeedbackAttribute

▸ getRelatedNackPliFeedbackAttribute(): FeedbackAttribute

Gets the RTCP "nack pli" feedback attribute associated with this payload type.

Returns: FeedbackAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/MapAttribute.ts:339

getRelatedNackRpsiFeedbackAttribute

▸ getRelatedNackRpsiFeedbackAttribute(): FeedbackAttribute

Gets the RTCP "nack rpsi" feedback attribute associated with this payload type.

Returns: FeedbackAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/MapAttribute.ts:351

getRelatedNackSliFeedbackAttribute

▸ getRelatedNackSliFeedbackAttribute(): FeedbackAttribute

Gets the RTCP "nack sli" feedback attribute associated with this payload type.

Returns: FeedbackAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/MapAttribute.ts:363

getRelatedRembFeedbackAttribute

▸ getRelatedRembFeedbackAttribute(): FeedbackAttribute

Gets the RTCP "goog-remb" feedback attribute associated with this payload type.

Returns: FeedbackAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/MapAttribute.ts:375

getRelatedRtcpFeedbackAttribute

▸ getRelatedRtcpFeedbackAttribute(payloadType: number, type: string, subType: string): FeedbackAttribute

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

Parameters:

Name Type Description
payloadType number The payload type.
type string The type.
subType string The sub-type.

Returns: FeedbackAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/MapAttribute.ts:390

▸ getRelatedRtcpFeedbackAttribute(type: string, subType: string): FeedbackAttribute

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

Parameters:

Name Type Description
type string The type.
subType string The sub-type.

Returns: FeedbackAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/MapAttribute.ts:398

getRelatedRtcpFeedbackAttributes

▸ getRelatedRtcpFeedbackAttributes(): FeedbackAttribute[]

Gets Rtcp Feedback attributes associated with this Map Attribute.

Returns: FeedbackAttribute[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/MapAttribute.ts:428

getRelatedTransportCCFeedbackAttribute

▸ getRelatedTransportCCFeedbackAttribute(): FeedbackAttribute

Gets the RTCP "transport-cc" feedback attribute associated with this payload type.

Returns: FeedbackAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/MapAttribute.ts:440

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/MapAttribute.ts:14

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:

Name Type
attribute FeedbackAttribute

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/MapAttribute.ts:454

resetRtcpFeedbackAttributes

▸ resetRtcpFeedbackAttributes(attributes: FeedbackAttribute[]): void

Resets Rtcp Feedback attributes associated with this Map Attribute.

Parameters:

Name Type
attributes FeedbackAttribute[]

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/MapAttribute.ts:466

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

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

setPayloadType

▸ setPayloadType(value: number): void

Sets the RTP payload type number.

Parameters:

Name Type
value number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/MapAttribute.ts:506

setRelatedFormatParametersAttribute

▸ setRelatedFormatParametersAttribute(value: FormatParametersAttribute): void

Sets Format Parameters attribute associated with this Map Attribute

Parameters:

Name Type
value FormatParametersAttribute

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/MapAttribute.ts:519

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

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

Parameters:

Name Type Description
value string The attribute value.

Returns: MapAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/MapAttribute.ts:132

getIanaMapAttribute

▸ StaticgetIanaMapAttribute(payloadType: number): MapAttribute

Gets the RTP map attribute for an IANA-reserved payload type.

Parameters:

Name Type Description
payloadType number The payload type.

Returns: MapAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/MapAttribute.ts:166

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