/ fm / liveswitch / sdp / sctp / MapAttribute
Class: MapAttribute
AB: Legacy attribute. To be removed when Firefox and Chrome stop using it. The sctpmap attribute maps from a port number (as used in an "m=" line) to an encoding name denoting the payload format to be used on top of the SCTP association or the actual protocol running on top of it. Last appears in https://tools.ietf.org/html/draft-ietf-mmusic-sctp-sdp-06#page-6 Has been replaced in subsequent drafts but is used in Firefox and Chrome for now.
Hierarchy
-
↳ MapAttribute
Table of contents
Constructors
Methods
- fmliveswitchsdpsctpMapAttributeInit
- getAttributeType
- getAttributeValue
- getMultiplexingCategory
- getPort
- getSctpProtocol
- getStreams
- getTypeString
- setAttributeType
- setMultiplexingCategory
- toString
- createAttribute
- fromAttributeValue
- getTypeName
- isMediaLevel
- isSessionLevel
- parse
Constructors
constructor
+ new MapAttribute(): MapAttribute
Returns: MapAttribute
Inherited from: Attribute
Defined in: Generated/TypeScript/fm.liveswitch/sdp/sctp/MapAttribute.ts:29
+ new MapAttribute(port: number, protocol: string, streams: number): MapAttribute
Initializes a new instance of the [[fm.liveswitch.sdp.sctp.portAttribute]] class.
Parameters:
| Name | Type | Description |
|---|---|---|
port |
number | The SCTP port. |
protocol |
string | The protocol. |
streams |
number | The streams. |
Returns: MapAttribute
Defined in: Generated/TypeScript/fm.liveswitch/sdp/sctp/MapAttribute.ts:30
Methods
fmliveswitchsdpsctpMapAttributeInit
▸ PrivatefmliveswitchsdpsctpMapAttributeInit(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/sdp/sctp/MapAttribute.ts:25
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/sctp/MapAttribute.ts:95
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
getPort
▸ getPort(): number
Gets the SCTP port.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/sdp/sctp/MapAttribute.ts:113
getSctpProtocol
▸ getSctpProtocol(): string
Gets the SCTP sub-protocol (association usage).
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/sdp/sctp/MapAttribute.ts:125
getStreams
▸ getStreams(): number
Gets the number of incoming streams.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/sdp/sctp/MapAttribute.ts:137
getTypeString
▸ getTypeString(): string
Returns: string
Overrides: Attribute
Defined in: Generated/TypeScript/fm.liveswitch/sdp/sctp/MapAttribute.ts:15
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
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.sctp.portAttribute]] class.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string | The attribute value. |
Returns: MapAttribute
Defined in: Generated/TypeScript/fm.liveswitch/sdp/sctp/MapAttribute.ts:75
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