/ fm / liveswitch / Candidate

Class: Candidate

fm.liveswitch.Candidate

A candidate.

Table of contents

Constructors

Methods

Constructors

constructor

+ new Candidate(): Candidate

Returns: Candidate

Defined in: Generated/TypeScript/fm.liveswitch/Candidate.ts:27

Methods

fmliveswitchCandidateInit

▸ PrivatefmliveswitchCandidateInit(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Candidate.ts:23

getDispatched

▸ getDispatched(): boolean

Gets a value indicating whether this candidate has been already been dispatched as a part of a session description.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/Candidate.ts:109

getRelayProtocol

▸ getRelayProtocol(): ProtocolType

Gets the relay protocol, the protocol used by this candidate to communicate with the relay (TURN) server.

Returns: ProtocolType

Defined in: Generated/TypeScript/fm.liveswitch/Candidate.ts:130

getSdpCandidateAttribute

▸ getSdpCandidateAttribute(): CandidateAttribute

Gets the SDP candidate attribute.

Returns: CandidateAttribute

Defined in: Generated/TypeScript/fm.liveswitch/Candidate.ts:142

getSdpMediaIndex

▸ getSdpMediaIndex(): number

Gets the media index.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/Candidate.ts:154

getTurnTransportProtocol

▸ getTurnTransportProtocol(): ProtocolType

Gets the relay protocol, the protocol used by this candidate to communicate with the relay (TURN) server.

deprecated Use RelayProtocol instead.

Returns: ProtocolType

Defined in: Generated/TypeScript/fm.liveswitch/Candidate.ts:168

getTypeString

▸ getTypeString(): string

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Candidate.ts:9

setDispatched

▸ setDispatched(value: boolean): void

Sets a value indicating whether this candidate has been already been dispatched as a part of a session description.

Parameters:

Name Type
value boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Candidate.ts:181

setRelayProtocol

▸ setRelayProtocol(value: ProtocolType): void

Sets the relay protocol, the protocol used by this candidate to communicate with the relay (TURN) server.

Parameters:

Name Type
value ProtocolType

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Candidate.ts:202

setSdpCandidateAttribute

▸ setSdpCandidateAttribute(value: CandidateAttribute): void

Sets the SDP candidate attribute.

Parameters:

Name Type
value CandidateAttribute

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Candidate.ts:214

setSdpMediaIndex

▸ setSdpMediaIndex(value: number): void

Sets the media index.

Parameters:

Name Type
value number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Candidate.ts:227

setTurnTransportProtocol

▸ setTurnTransportProtocol(value: ProtocolType): void

Sets the relay protocol, the protocol used by this candidate to communicate with the relay (TURN) server.

deprecated Use RelayProtocol instead.

Parameters:

Name Type
value ProtocolType

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/Candidate.ts:242

toJson

▸ toJson(): string

Serializes this instance to JSON.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/Candidate.ts:254

fromJson

▸ StaticfromJson(candidateJson: string): Candidate

Deserializes an instance from JSON.

Parameters:

Name Type Description
candidateJson string The JSON to deserialize.

Returns: Candidate

The deserialized candidate.

Defined in: Generated/TypeScript/fm.liveswitch/Candidate.ts:51

toJson

▸ StatictoJson(candidate: Candidate): string

Serializes an instance to JSON.

Parameters:

Name Type Description
candidate Candidate The candidate to serialize.

Returns: string

The serialized JSON.

Defined in: Generated/TypeScript/fm.liveswitch/Candidate.ts:86