/ fm / liveswitch / sdp / rtp / SimulcastAttribute

Class: SimulcastAttribute

sdp.rtp.SimulcastAttribute

The SDP media attribute "simulcast" describes, independently for send and receive directions, the number of simulcast RTP streams as well as potential alternative formats for each simulcast RTP stream.

Hierarchy

• Attribute

  ↳ SimulcastAttribute

Table of contents

Constructors

• constructor

Methods

• fmliveswitchsdprtpSimulcastAttributeInit
• getAttributeType
• getAttributeValue
• getDescription1
• getDescription2
• getDraftVersion
• getMultiplexingCategory
• getReceiveDescription
• getSendDescription
• getTypeString
• setAttributeType
• setDraftVersion
• setMultiplexingCategory
• toString
• createAttribute
• fromAttributeValue
• getTypeName
• isMediaLevel
• isSessionLevel
• parse

Constructors

constructor

+ new SimulcastAttribute(): SimulcastAttribute

Returns: SimulcastAttribute

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/SimulcastAttribute.ts:25

+ new SimulcastAttribute(description: SimulcastStreamDescription): SimulcastAttribute

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

Parameters:

Name	Type	Description
description	SimulcastStreamDescription	The description.

Returns: SimulcastAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/SimulcastAttribute.ts:26

+ new SimulcastAttribute(description1: SimulcastStreamDescription, description2: SimulcastStreamDescription): SimulcastAttribute

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

Parameters:

Name	Type	Description
description1	SimulcastStreamDescription	The first description.
description2	SimulcastStreamDescription	The second description.

Returns: SimulcastAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/SimulcastAttribute.ts:33

Methods

fmliveswitchsdprtpSimulcastAttributeInit

▸ PrivatefmliveswitchsdprtpSimulcastAttributeInit(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/SimulcastAttribute.ts:22

---

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/SimulcastAttribute.ts:215

---

getDescription1

▸ getDescription1(): SimulcastStreamDescription

Gets the first description.

Returns: SimulcastStreamDescription

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/SimulcastAttribute.ts:251

---

getDescription2

▸ getDescription2(): SimulcastStreamDescription

Gets the second description.

Returns: SimulcastStreamDescription

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/SimulcastAttribute.ts:263

---

getDraftVersion

▸ getDraftVersion(): number

Gets the version of the IETF draft to comply with. https://tools.ietf.org/html/draft-ietf-mmusic-sdp-simulcast

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/SimulcastAttribute.ts:276

---

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

---

getReceiveDescription

▸ getReceiveDescription(): SimulcastStreamDescription

Gets the 'receive' description.

Returns: SimulcastStreamDescription

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/SimulcastAttribute.ts:288

---

getSendDescription

▸ getSendDescription(): SimulcastStreamDescription

Gets the 'send' description.

Returns: SimulcastStreamDescription

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/SimulcastAttribute.ts:300

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/SimulcastAttribute.ts:12

---

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

---

setDraftVersion

▸ setDraftVersion(value: number): void

Sets the version of the IETF draft to comply with. https://tools.ietf.org/html/draft-ietf-mmusic-sdp-simulcast

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/SimulcastAttribute.ts:329

---

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

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

Parameters:

Name	Type	Description
value	string	The attribute value.

Returns: SimulcastAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/rtp/SimulcastAttribute.ts:107

---

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