/ fm / liveswitch / sdp / ice / CandidateAttribute

Class: CandidateAttribute

sdp.ice.CandidateAttribute

The candidate attribute is a media-level attribute only. It contains a transport address for a candidate that can be used for connectivity checks.

Hierarchy

Table of contents

Constructors

Methods

Constructors

constructor

+ new CandidateAttribute(): CandidateAttribute

Returns: CandidateAttribute

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/CandidateAttribute.ts:42

+ new CandidateAttribute(foundation: string, priority: number, connectionAddress: string, port: number, candidateType: string, componentId: number): CandidateAttribute

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

Parameters:

Name Type Description
foundation string The candidate's foundation.
priority number The priority of the candidate.
connectionAddress string The IP address of the candidate.
port number The port of the candidate.
candidateType string The type of the candidate. See [[fm.liveswitch.sdp.ice.candidateAttribute.candidateType]] for possible values.
componentId number The component identifier.

Returns: CandidateAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/CandidateAttribute.ts:43

+ new CandidateAttribute(foundation: string, priority: number, connectionAddress: string, port: number, candidateType: string, relatedAddress: string, relatedPort: number, protocol: string, componentId: number): CandidateAttribute

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

Parameters:

Name Type Description
foundation string The candidate's foundation.
priority number The priority of the candidate.
connectionAddress string The IP address of the candidate.
port number The port of the candidate.
candidateType string The type of the candidate. See [[fm.liveswitch.sdp.ice.candidateAttribute.candidateType]] for possible values.
relatedAddress string The IP address related to the candidate.
relatedPort number The port related to the candidate.
protocol string The protocol.
componentId number The ID of the component for which this is a candidate.

Returns: CandidateAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/CandidateAttribute.ts:55

Methods

fmliveswitchsdpiceCandidateAttributeInit

▸ PrivatefmliveswitchsdpiceCandidateAttributeInit(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/CandidateAttribute.ts:36

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/CandidateAttribute.ts:236

getCandidateType

▸ getCandidateType(): string

Gets the type of the candidate. See [[fm.liveswitch.sdp.ice.candidateAttribute.candidateType]] for possible values.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/CandidateAttribute.ts:280

getComponentId

▸ getComponentId(): number

Gets the ID of the component for which this is a candidate.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/CandidateAttribute.ts:292

getConnectionAddress

▸ getConnectionAddress(): string

Gets the IP address of the candidate.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/CandidateAttribute.ts:304

getExtensions

▸ getExtensions(): Hash<string, string>

Gets the extensions.

Returns: Hash<string, string>

Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/CandidateAttribute.ts:316

getFoundation

▸ getFoundation(): string

Gets the candidate's foundation.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/CandidateAttribute.ts:328

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 port of the candidate.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/CandidateAttribute.ts:340

getPriority

▸ getPriority(): number

Gets the priority of the candidate.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/CandidateAttribute.ts:352

getProtocol

▸ getProtocol(): string

Gets the protocol of this candidate.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/CandidateAttribute.ts:364

getRelatedAddress

▸ getRelatedAddress(): string

Gets the IP address related to the candidate.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/CandidateAttribute.ts:376

getRelatedPort

▸ getRelatedPort(): number

Gets the port related to the candidate.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/CandidateAttribute.ts:388

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/CandidateAttribute.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

setCandidateType

▸ setCandidateType(value: string): void

Sets the type of the candidate. See [[fm.liveswitch.sdp.ice.candidateAttribute.candidateType]] for possible values.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/CandidateAttribute.ts:400

setComponentId

▸ setComponentId(value: number): void

Sets the ID of the component for which this is a candidate.

Parameters:

Name Type
value number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/CandidateAttribute.ts:415

setConnectionAddress

▸ setConnectionAddress(value: string): void

Sets the IP address of the candidate.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/CandidateAttribute.ts:428

setFoundation

▸ setFoundation(value: string): void

Sets the candidate's foundation.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/CandidateAttribute.ts:451

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

setPort

▸ setPort(value: number): void

Sets the port of the candidate.

Parameters:

Name Type
value number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/CandidateAttribute.ts:466

setPriority

▸ setPriority(value: number): void

Sets the priority of the candidate.

Parameters:

Name Type
value number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/CandidateAttribute.ts:479

setProtocol

▸ setProtocol(value: string): void

Sets the protocol of this candidate.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/CandidateAttribute.ts:492

setRelatedAddress

▸ setRelatedAddress(value: string): void

Sets the IP address related to the candidate.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/CandidateAttribute.ts:504

setRelatedPort

▸ setRelatedPort(value: number): void

Sets the port related to the candidate.

Parameters:

Name Type
value number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/CandidateAttribute.ts:516

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

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

Parameters:

Name Type Description
value string The attribute as a string.

Returns: CandidateAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/ice/CandidateAttribute.ts:169

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