/ fm / liveswitch / sdp / ice / RemoteCandidatesAttribute

Class: RemoteCandidatesAttribute

sdp.ice.RemoteCandidatesAttribute

The attribute contains a connection-address and port for each component. The ordering of components is irrelevant. However, a value MUST be present for each component of a media stream. This attribute MUST be included in an offer by a controlling agent for a media stream that is Completed, and MUST NOT be included in any other case.

Hierarchy

• Attribute

  ↳ RemoteCandidatesAttribute

Table of contents

Constructors

• constructor

Methods

• getAttributeType
• getAttributeValue
• getCandidates
• getMultiplexingCategory
• getTypeString
• setAttributeType
• setMultiplexingCategory
• toString
• createAttribute
• fromAttributeValue
• getTypeName
• isMediaLevel
• isSessionLevel
• parse

Constructors

constructor

+ new RemoteCandidatesAttribute(): RemoteCandidatesAttribute

Returns: RemoteCandidatesAttribute

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/RemoteCandidatesAttribute.ts:19

+ new RemoteCandidatesAttribute(candidates: RemoteCandidate[]): RemoteCandidatesAttribute

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

Parameters:

Name	Type	Description
candidates	RemoteCandidate[]	The array of remote candidates.

Returns: RemoteCandidatesAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/RemoteCandidatesAttribute.ts:21

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 value of the attribute.

Returns: string

Overrides: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/RemoteCandidatesAttribute.ts:80

---

getCandidates

▸ getCandidates(): RemoteCandidate[]

Gets the array of remote candidates.

Returns: RemoteCandidate[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/RemoteCandidatesAttribute.ts:96

---

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/ice/RemoteCandidatesAttribute.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): RemoteCandidatesAttribute

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

Parameters:

Name	Type	Description
value	string	The attribute value.

Returns: RemoteCandidatesAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/RemoteCandidatesAttribute.ts:61

---

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