/ fm / liveswitch / PluginConnection

Class: PluginConnection

fm.liveswitch.PluginConnection

Hierarchy

• Dynamic

  ↳ PluginConnection

Implements

• IConnection<PluginConnection, PluginStream, PluginAudioStream, PluginVideoStream, PluginDataStream>
• IInternalConnection

Table of contents

Constructors

• constructor

Properties

• _gatheringState
• _iceConnectionState
• _signallingState
• _state

Methods

• addIceServer
• addIceServers
• addOnExternalIdChange
• addOnGatheringStateChange
• addOnIceConnectionStateChange
• addOnLocalCandidate
• addOnLocalDescription
• addOnRemoteCandidate
• addOnRemoteDescription
• addOnSignallingStateChange
• addOnStateChange
• addRemoteCandidate
• close
• createAnswer
• createOffer
• getAudioStream
• getAudioStreams
• getBundlePolicy
• getCanonicalName
• getDataStream
• getDataStreams
• getDeadStreamTimeout
• getDynamicProperties
• getDynamicValue
• getError
• getExternalId
• getGatheringState
• getHasAudio
• getHasData
• getHasVideo
• getIceConnectionState
• getIceGatherPolicy
• getIceServer
• getIceServers
• getId
• getLegacyTimeout
• getLocalDescription
• getRemoteDescription
• getSignallingState
• getState
• getStats
• getStreams
• getTieBreaker
• getTimeout
• getTrickleIcePolicy
• getTypeString
• getVideoStream
• getVideoStreams
• removeIceServer
• removeIceServers
• removeOnExternalIdChange
• removeOnGatheringStateChange
• removeOnIceConnectionStateChange
• removeOnLocalCandidate
• removeOnLocalDescription
• removeOnRemoteCandidate
• removeOnRemoteDescription
• removeOnSignallingStateChange
• removeOnStateChange
• setBundlePolicy
• setDeadStreamTimeout
• setDynamicValue
• setError
• setExternalId
• setIceGatherPolicy
• setIceServer
• setIceServers
• setLegacyTimeout
• setLocalDescription
• setRemoteDescription
• setTieBreaker
• setTimeout
• setTrickleIcePolicy
• unsetDynamicValue

Constructors

constructor

+ new PluginConnection(external: IExternalConnection, streams: PluginStream[]): PluginConnection

Parameters:

Name	Type
external	IExternalConnection
streams	PluginStream[]

Returns: PluginConnection

Inherited from: Dynamic

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:50

Properties

_gatheringState

• Private _gatheringState: IceGatheringState

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:47

---

_iceConnectionState

• Private _iceConnectionState: IceConnectionState

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:48

---

_signallingState

• Private _signallingState: SignallingState

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:49

---

_state

• Private _state: ConnectionState

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:50

Methods

addIceServer

▸ addIceServer(iceServer: IceServer): void

Parameters:

Name	Type
iceServer	IceServer

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:140

---

addIceServers

▸ addIceServers(iceServers: IceServer[]): void

Parameters:

Name	Type
iceServers	IceServer[]

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:143

---

addOnExternalIdChange

▸ addOnExternalIdChange(value: IAction2<string, string>): void

Parameters:

Name	Type
value	IAction2<string, string>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:149

---

addOnGatheringStateChange

▸ addOnGatheringStateChange(value: IAction1<PluginConnection>): void

Parameters:

Name	Type
value	IAction1<PluginConnection>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:155

---

addOnIceConnectionStateChange

▸ addOnIceConnectionStateChange(value: IAction1<PluginConnection>): void

Parameters:

Name	Type
value	IAction1<PluginConnection>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:152

---

addOnLocalCandidate

▸ addOnLocalCandidate(value: IAction2<PluginConnection, Candidate>): void

Parameters:

Name	Type
value	IAction2<PluginConnection, Candidate>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:146

---

addOnLocalDescription

▸ addOnLocalDescription(value: IAction2<PluginConnection, SessionDescription>): void

Parameters:

Name	Type
value	IAction2<PluginConnection, SessionDescription>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:158

---

addOnRemoteCandidate

▸ addOnRemoteCandidate(value: IAction2<PluginConnection, Candidate>): void

Parameters:

Name	Type
value	IAction2<PluginConnection, Candidate>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:161

---

addOnRemoteDescription

▸ addOnRemoteDescription(value: IAction2<PluginConnection, SessionDescription>): void

Parameters:

Name	Type
value	IAction2<PluginConnection, SessionDescription>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:164

---

addOnSignallingStateChange

▸ addOnSignallingStateChange(value: IAction1<PluginConnection>): void

Parameters:

Name	Type
value	IAction1<PluginConnection>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:167

---

addOnStateChange

▸ addOnStateChange(value: IAction1<PluginConnection>): void

Parameters:

Name	Type
value	IAction1<PluginConnection>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:170

---

addRemoteCandidate

▸ addRemoteCandidate(remoteCandidate: Candidate): Future<Candidate>

Parameters:

Name	Type
remoteCandidate	Candidate

Returns: Future<Candidate>

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:173

---

close

▸ close(): boolean

Returns: boolean

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:184

---

createAnswer

▸ createAnswer(): Future<SessionDescription>

Returns: Future<SessionDescription>

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:187

---

createOffer

▸ createOffer(): Future<SessionDescription>

Returns: Future<SessionDescription>

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:198

---

getAudioStream

▸ getAudioStream(): PluginAudioStream

Returns: PluginAudioStream

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:218

---

getAudioStreams

▸ getAudioStreams(): PluginAudioStream[]

Returns: PluginAudioStream[]

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:221

---

getBundlePolicy

▸ getBundlePolicy(): BundlePolicy

Returns: BundlePolicy

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:266

---

getCanonicalName

▸ getCanonicalName(): string

Returns: string

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:278

---

getDataStream

▸ getDataStream(): PluginDataStream

Returns: PluginDataStream

Implementation of: IInternalConnection

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

---

getDataStreams

▸ getDataStreams(): PluginDataStream[]

Returns: PluginDataStream[]

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:245

---

getDeadStreamTimeout

▸ getDeadStreamTimeout(): number

Returns: number

Implementation of: IInternalConnection

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

---

getDynamicProperties

▸ getDynamicProperties(): Hash<string, Object>

Gets all dynamic properties on this instance.

Returns: Hash<string, Object>

Inherited from: Dynamic

Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:37

---

getDynamicValue

▸ getDynamicValue(key: string): Object

Gets a property value from the local cache.

Parameters:

Name	Type	Description
key	string	The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

Returns: Object

The stored value, if found; otherwise null.

Inherited from: Dynamic

Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:58

---

getError

▸ getError(): Error

Returns: Error

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:260

---

getExternalId

▸ getExternalId(): string

Returns: string

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:257

---

getGatheringState

▸ getGatheringState(): IceGatheringState

Returns: IceGatheringState

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:322

---

getHasAudio

▸ getHasAudio(): boolean

Returns: boolean

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:209

---

getHasData

▸ getHasData(): boolean

Returns: boolean

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:215

---

getHasVideo

▸ getHasVideo(): boolean

Returns: boolean

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:212

---

getIceConnectionState

▸ getIceConnectionState(): IceConnectionState

Returns: IceConnectionState

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:319

---

getIceGatherPolicy

▸ getIceGatherPolicy(): IceGatherPolicy

Returns: IceGatherPolicy

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:263

---

getIceServer

▸ getIceServer(): IceServer

Returns: IceServer

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:269

---

getIceServers

▸ getIceServers(): IceServer[]

Returns: IceServer[]

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:272

---

getId

▸ getId(): string

Returns: string

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:275

---

getLegacyTimeout

▸ getLegacyTimeout(): boolean

Returns: boolean

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:313

---

getLocalDescription

▸ getLocalDescription(): SessionDescription

Returns: SessionDescription

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:281

---

getRemoteDescription

▸ getRemoteDescription(): SessionDescription

Returns: SessionDescription

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:284

---

getSignallingState

▸ getSignallingState(): SignallingState

Returns: SignallingState

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:287

---

getState

▸ getState(): ConnectionState

Returns: ConnectionState

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:290

---

getStats

▸ getStats(): Future<ConnectionStats>

Returns: Future<ConnectionStats>

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:293

---

getStreams

▸ getStreams(): PluginStream[]

Returns: PluginStream[]

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:304

---

getTieBreaker

▸ getTieBreaker(): string

Returns: string

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:307

---

getTimeout

▸ getTimeout(): number

Returns: number

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:310

---

getTrickleIcePolicy

▸ getTrickleIcePolicy(): TrickleIcePolicy

Returns: TrickleIcePolicy

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:316

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Dynamic

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:7

---

getVideoStream

▸ getVideoStream(): PluginVideoStream

Returns: PluginVideoStream

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:230

---

getVideoStreams

▸ getVideoStreams(): PluginVideoStream[]

Returns: PluginVideoStream[]

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:233

---

removeIceServer

▸ removeIceServer(iceServer: IceServer): void

Parameters:

Name	Type
iceServer	IceServer

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:325

---

removeIceServers

▸ removeIceServers(iceServers: IceServer[]): void

Parameters:

Name	Type
iceServers	IceServer[]

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:328

---

removeOnExternalIdChange

▸ removeOnExternalIdChange(value: IAction2<string, string>): void

Parameters:

Name	Type
value	IAction2<string, string>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:337

---

removeOnGatheringStateChange

▸ removeOnGatheringStateChange(value: IAction1<PluginConnection>): void

Parameters:

Name	Type
value	IAction1<PluginConnection>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:340

---

removeOnIceConnectionStateChange

▸ removeOnIceConnectionStateChange(value: IAction1<PluginConnection>): void

Parameters:

Name	Type
value	IAction1<PluginConnection>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:334

---

removeOnLocalCandidate

▸ removeOnLocalCandidate(value: IAction2<PluginConnection, Candidate>): void

Parameters:

Name	Type
value	IAction2<PluginConnection, Candidate>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:331

---

removeOnLocalDescription

▸ removeOnLocalDescription(value: IAction2<PluginConnection, SessionDescription>): void

Parameters:

Name	Type
value	IAction2<PluginConnection, SessionDescription>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:343

---

removeOnRemoteCandidate

▸ removeOnRemoteCandidate(value: IAction2<PluginConnection, Candidate>): void

Parameters:

Name	Type
value	IAction2<PluginConnection, Candidate>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:346

---

removeOnRemoteDescription

▸ removeOnRemoteDescription(value: IAction2<PluginConnection, SessionDescription>): void

Parameters:

Name	Type
value	IAction2<PluginConnection, SessionDescription>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:349

---

removeOnSignallingStateChange

▸ removeOnSignallingStateChange(value: IAction1<PluginConnection>): void

Parameters:

Name	Type
value	IAction1<PluginConnection>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:352

---

removeOnStateChange

▸ removeOnStateChange(value: IAction1<PluginConnection>): void

Parameters:

Name	Type
value	IAction1<PluginConnection>

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:355

---

setBundlePolicy

▸ setBundlePolicy(value: BundlePolicy): void

Parameters:

Name	Type
value	BundlePolicy

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:370

---

setDeadStreamTimeout

▸ setDeadStreamTimeout(value: number): void

Parameters:

Name	Type
value	number

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:358

---

setDynamicValue

▸ setDynamicValue(key: string, value: Object): void

Sets a property value in the local cache.

Parameters:

Name	Type	Description
key	string	The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.
value	Object	The property value. This can be any object that needs to be stored for future use.

Returns: void

Inherited from: Dynamic

Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:95

---

setError

▸ setError(value: Error): void

Parameters:

Name	Type
value	Error

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:364

---

setExternalId

▸ setExternalId(value: string): void

Parameters:

Name	Type
value	string

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:361

---

setIceGatherPolicy

▸ setIceGatherPolicy(value: IceGatherPolicy): void

Parameters:

Name	Type
value	IceGatherPolicy

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:367

---

setIceServer

▸ setIceServer(value: IceServer): void

Parameters:

Name	Type
value	IceServer

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:373

---

setIceServers

▸ setIceServers(value: IceServer[]): void

Parameters:

Name	Type
value	IceServer[]

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:376

---

setLegacyTimeout

▸ setLegacyTimeout(value: boolean): void

Parameters:

Name	Type
value	boolean

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:379

---

setLocalDescription

▸ setLocalDescription(localDescription: SessionDescription): Future<SessionDescription>

Parameters:

Name	Type
localDescription	SessionDescription

Returns: Future<SessionDescription>

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:385

---

setRemoteDescription

▸ setRemoteDescription(remoteDescription: SessionDescription): Future<SessionDescription>

Parameters:

Name	Type
remoteDescription	SessionDescription

Returns: Future<SessionDescription>

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:396

---

setTieBreaker

▸ setTieBreaker(value: string): void

Parameters:

Name	Type
value	string

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:382

---

setTimeout

▸ setTimeout(value: number): void

Parameters:

Name	Type
value	number

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:407

---

setTrickleIcePolicy

▸ setTrickleIcePolicy(value: TrickleIcePolicy): void

Parameters:

Name	Type
value	TrickleIcePolicy

Returns: void

Implementation of: IInternalConnection

Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:410

---

unsetDynamicValue

▸ unsetDynamicValue(key: string): boolean

Removes a property value from the local cache. Returns true if the value was removed and returns false otherwise.

Parameters:

Name	Type	Description
key	string	The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

Returns: boolean

true if the value was removed; otherwise, false.

Inherited from: Dynamic

Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:122