/ fm / liveswitch / IInternalConnection

Interface: IInternalConnection

fm.liveswitch.IInternalConnection

Hierarchy

• IConnection<IInternalConnection, IInternalStream, IInternalAudioStream, IInternalVideoStream, IInternalDataStream>

• IInternal<IExternalConnection>

  ↳ IInternalConnection

Implemented by

• PluginConnection
• WebRtcConnection
• WssWebSocketConnection

Table of contents

Methods

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

Methods

addIceServer

▸ addIceServer(iceServer: IceServer): void

Parameters:

Name	Type
iceServer	IceServer

Returns: void

Inherited from: IConnection

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

---

addIceServers

▸ addIceServers(iceServers: IceServer[]): void

Parameters:

Name	Type
iceServers	IceServer[]

Returns: void

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:10

---

addOnExternalIdChange

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

Parameters:

Name	Type
value	IAction2<string, string>

Returns: void

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:11

---

addOnGatheringStateChange

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

Parameters:

Name	Type
value	IAction1<IInternalConnection>

Returns: void

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:12

---

addOnIceConnectionStateChange

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

Parameters:

Name	Type
value	IAction1<IInternalConnection>

Returns: void

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:13

---

addOnLocalCandidate

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

Parameters:

Name	Type
value	IAction2<IInternalConnection, Candidate>

Returns: void

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:14

---

addOnLocalDescription

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

Parameters:

Name	Type
value	IAction2<IInternalConnection, SessionDescription>

Returns: void

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:15

---

addOnRemoteCandidate

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

Parameters:

Name	Type
value	IAction2<IInternalConnection, Candidate>

Returns: void

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:16

---

addOnRemoteDescription

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

Parameters:

Name	Type
value	IAction2<IInternalConnection, SessionDescription>

Returns: void

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:17

---

addOnSignallingStateChange

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

Parameters:

Name	Type
value	IAction1<IInternalConnection>

Returns: void

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:18

---

addOnStateChange

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

Parameters:

Name	Type
value	IAction1<IInternalConnection>

Returns: void

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:19

---

addRemoteCandidate

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

Parameters:

Name	Type
remoteCandidate	Candidate

Returns: Future<Candidate>

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:20

---

addToWebSocketConnection

▸ addToWebSocketConnection(openArgs: WssServiceOpenArgs): void

Parameters:

Name	Type
openArgs	WssServiceOpenArgs

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/IInternalConnection.ts:3

---

close

▸ close(): boolean

Returns: boolean

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:21

---

createAnswer

▸ createAnswer(): Future<SessionDescription>

Returns: Future<SessionDescription>

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:22

---

createOffer

▸ createOffer(): Future<SessionDescription>

Returns: Future<SessionDescription>

Inherited from: IConnection

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

---

getAudioStream

▸ getAudioStream(): IInternalAudioStream

Returns: IInternalAudioStream

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:24

---

getAudioStreams

▸ getAudioStreams(): IInternalAudioStream[]

Returns: IInternalAudioStream[]

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:25

---

getBundlePolicy

▸ getBundlePolicy(): BundlePolicy

Returns: BundlePolicy

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:26

---

getCanonicalName

▸ getCanonicalName(): string

Returns: string

Inherited from: IConnection

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

---

getDataStream

▸ getDataStream(): IInternalDataStream

Returns: IInternalDataStream

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:28

---

getDataStreams

▸ getDataStreams(): IInternalDataStream[]

Returns: IInternalDataStream[]

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:29

---

getDeadStreamTimeout

▸ getDeadStreamTimeout(): number

Returns: number

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:30

---

getError

▸ getError(): Error

Returns: Error

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:31

---

getExternalId

▸ getExternalId(): string

Returns: string

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:32

---

getGatheringState

▸ getGatheringState(): IceGatheringState

Returns: IceGatheringState

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:33

---

getHasAudio

▸ getHasAudio(): boolean

Returns: boolean

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:34

---

getHasData

▸ getHasData(): boolean

Returns: boolean

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:35

---

getHasVideo

▸ getHasVideo(): boolean

Returns: boolean

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:36

---

getIceConnectionState

▸ getIceConnectionState(): IceConnectionState

Returns: IceConnectionState

Inherited from: IConnection

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

---

getIceGatherPolicy

▸ getIceGatherPolicy(): IceGatherPolicy

Returns: IceGatherPolicy

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:38

---

getIceServer

▸ getIceServer(): IceServer

Returns: IceServer

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:39

---

getIceServers

▸ getIceServers(): IceServer[]

Returns: IceServer[]

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:40

---

getId

▸ getId(): string

Returns: string

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:41

---

getLegacyTimeout

▸ getLegacyTimeout(): boolean

Returns: boolean

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:42

---

getLocalDescription

▸ getLocalDescription(): SessionDescription

Returns: SessionDescription

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:43

---

getMediaProtocol

▸ getMediaProtocol(): MediaProtocol

Returns: MediaProtocol

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:44

---

getRemoteDescription

▸ getRemoteDescription(): SessionDescription

Returns: SessionDescription

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:45

---

getSignallingState

▸ getSignallingState(): SignallingState

Returns: SignallingState

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:46

---

getState

▸ getState(): ConnectionState

Returns: ConnectionState

Inherited from: IConnection

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

---

getStats

▸ getStats(): Future<ConnectionStats>

Returns: Future<ConnectionStats>

Inherited from: IConnection

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

---

getStreams

▸ getStreams(): IInternalStream[]

Returns: IInternalStream[]

Inherited from: IConnection

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

---

getTieBreaker

▸ getTieBreaker(): string

Returns: string

Inherited from: IConnection

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

---

getTimeout

▸ getTimeout(): number

Returns: number

Inherited from: IConnection

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

---

getTrickleIcePolicy

▸ getTrickleIcePolicy(): TrickleIcePolicy

Returns: TrickleIcePolicy

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:52

---

getVideoEnabledUpdateConnectionPolicy

▸ getVideoEnabledUpdateConnectionPolicy(): IFunction1<number, number>

Returns: IFunction1<number, number>

Defined in: Generated/TypeScript/fm.liveswitch/IInternalConnection.ts:8

---

getVideoRetentionPolicy

▸ getVideoRetentionPolicy(): VideoRetentionPolicy

Returns: VideoRetentionPolicy

Defined in: Generated/TypeScript/fm.liveswitch/IInternalConnection.ts:6

---

getVideoStream

▸ getVideoStream(): IInternalVideoStream

Returns: IInternalVideoStream

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:53

---

getVideoStreams

▸ getVideoStreams(): IInternalVideoStream[]

Returns: IInternalVideoStream[]

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:54

---

removeIceServer

▸ removeIceServer(iceServer: IceServer): void

Parameters:

Name	Type
iceServer	IceServer

Returns: void

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:55

---

removeIceServers

▸ removeIceServers(iceServers: IceServer[]): void

Parameters:

Name	Type
iceServers	IceServer[]

Returns: void

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:56

---

removeOnExternalIdChange

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

Parameters:

Name	Type
value	IAction2<string, string>

Returns: void

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:57

---

removeOnGatheringStateChange

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

Parameters:

Name	Type
value	IAction1<IInternalConnection>

Returns: void

Inherited from: IConnection

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

---

removeOnIceConnectionStateChange

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

Parameters:

Name	Type
value	IAction1<IInternalConnection>

Returns: void

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:59

---

removeOnLocalCandidate

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

Parameters:

Name	Type
value	IAction2<IInternalConnection, Candidate>

Returns: void

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:60

---

removeOnLocalDescription

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

Parameters:

Name	Type
value	IAction2<IInternalConnection, SessionDescription>

Returns: void

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:61

---

removeOnRemoteCandidate

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

Parameters:

Name	Type
value	IAction2<IInternalConnection, Candidate>

Returns: void

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:62

---

removeOnRemoteDescription

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

Parameters:

Name	Type
value	IAction2<IInternalConnection, SessionDescription>

Returns: void

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:63

---

removeOnSignallingStateChange

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

Parameters:

Name	Type
value	IAction1<IInternalConnection>

Returns: void

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:64

---

removeOnStateChange

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

Parameters:

Name	Type
value	IAction1<IInternalConnection>

Returns: void

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:65

---

setBundlePolicy

▸ setBundlePolicy(value: BundlePolicy): void

Parameters:

Name	Type
value	BundlePolicy

Returns: void

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:66

---

setDeadStreamTimeout

▸ setDeadStreamTimeout(value: number): void

Parameters:

Name	Type
value	number

Returns: void

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:67

---

setError

▸ setError(value: Error): void

Parameters:

Name	Type
value	Error

Returns: void

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:68

---

setExternalId

▸ setExternalId(value: string): void

Parameters:

Name	Type
value	string

Returns: void

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:69

---

setIceGatherPolicy

▸ setIceGatherPolicy(value: IceGatherPolicy): void

Parameters:

Name	Type
value	IceGatherPolicy

Returns: void

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:70

---

setIceServer

▸ setIceServer(value: IceServer): void

Parameters:

Name	Type
value	IceServer

Returns: void

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:71

---

setIceServers

▸ setIceServers(value: IceServer[]): void

Parameters:

Name	Type
value	IceServer[]

Returns: void

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:72

---

setLegacyTimeout

▸ setLegacyTimeout(value: boolean): void

Parameters:

Name	Type
value	boolean

Returns: void

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:73

---

setLocalDescription

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

Parameters:

Name	Type
localDescription	SessionDescription

Returns: Future<SessionDescription>

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:74

---

setRemoteDescription

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

Parameters:

Name	Type
remoteDescription	SessionDescription

Returns: Future<SessionDescription>

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:75

---

setState

▸ setState(state: ConnectionState): void

Parameters:

Name	Type
state	ConnectionState

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/IInternalConnection.ts:5

---

setTieBreaker

▸ setTieBreaker(value: string): void

Parameters:

Name	Type
value	string

Returns: void

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:76

---

setTimeout

▸ setTimeout(value: number): void

Parameters:

Name	Type
value	number

Returns: void

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:77

---

setTrickleIcePolicy

▸ setTrickleIcePolicy(value: TrickleIcePolicy): void

Parameters:

Name	Type
value	TrickleIcePolicy

Returns: void

Inherited from: IConnection

Defined in: Generated/TypeScript/fm.liveswitch/IConnection.ts:78

---

setVideoEnabledUpdateConnectionPolicy

▸ setVideoEnabledUpdateConnectionPolicy(value: IFunction1<number, number>): void

Parameters:

Name	Type
value	IFunction1<number, number>

Returns: void

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

---

setVideoRetentionPolicy

▸ setVideoRetentionPolicy(value: VideoRetentionPolicy): void

Parameters:

Name	Type
value	VideoRetentionPolicy

Returns: void

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

---

updateWebSocketConnection

▸ updateWebSocketConnection(config: ConnectionConfig, promise: Promise<object>): void

Parameters:

Name	Type
config	ConnectionConfig
promise	Promise<object>

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/IInternalConnection.ts:4