Interface IConnection<TConnection, TStream, TAudioStream, TVideoStream, TDataStream>
Type parameters
-
TConnection
-
TStream
-
TAudioStream
-
TVideoStream
-
TDataStream
Methods
addIceServer
- addIceServer(iceServer: IceServer): void
-
Parameters
Returns void
addIceServers
- addIceServers(iceServers: IceServer[]): void
-
Parameters
Returns void
addOnGatheringStateChange
- addOnGatheringStateChange(value: IAction1<TConnection>): void
-
Parameters
-
value: IAction1<TConnection>
Returns void
addOnIceConnectionStateChange
- addOnIceConnectionStateChange(value: IAction1<TConnection>): void
-
Parameters
-
value: IAction1<TConnection>
Returns void
addOnLocalCandidate
- addOnLocalCandidate(value: IAction2<TConnection, Candidate>): void
-
Parameters
-
value: IAction2<TConnection, Candidate>
Returns void
addOnLocalDescription
- addOnLocalDescription(value: IAction2<TConnection, SessionDescription>): void
-
Parameters
-
value: IAction2<TConnection, SessionDescription>
Returns void
addOnRemoteCandidate
- addOnRemoteCandidate(value: IAction2<TConnection, Candidate>): void
-
Parameters
-
value: IAction2<TConnection, Candidate>
Returns void
addOnRemoteDescription
- addOnRemoteDescription(value: IAction2<TConnection, SessionDescription>): void
-
Parameters
-
value: IAction2<TConnection, SessionDescription>
Returns void
addOnSignallingStateChange
- addOnSignallingStateChange(value: IAction1<TConnection>): void
-
Parameters
-
value: IAction1<TConnection>
Returns void
addOnStateChange
- addOnStateChange(value: IAction1<TConnection>): void
-
Parameters
-
value: IAction1<TConnection>
Returns void
addRemoteCandidate
- addRemoteCandidate(remoteCandidate: Candidate): Future<Candidate>
-
Parameters
-
remoteCandidate: Candidate
Returns Future<Candidate>
close
-
Returns void
createAnswer
- createAnswer(): Future<SessionDescription>
-
Returns Future<SessionDescription>
createOffer
- createOffer(): Future<SessionDescription>
-
Returns Future<SessionDescription>
getAudioStream
- getAudioStream(): TAudioStream
-
Returns TAudioStream
getAudioStreams
- getAudioStreams(): TAudioStream[]
-
Returns TAudioStream[]
getDataStream
- getDataStream(): TDataStream
-
Returns TDataStream
getDataStreams
- getDataStreams(): TDataStream[]
-
Returns TDataStream[]
getDeadStreamTimeout
- getDeadStreamTimeout(): number
-
Returns number
getError
-
Returns Error
getGatheringState
- getGatheringState(): IceGatheringState
-
Returns IceGatheringState
getHasAudio
-
Returns boolean
getHasData
-
Returns boolean
getHasVideo
-
Returns boolean
getIceConnectionState
- getIceConnectionState(): IceConnectionState
-
Returns IceConnectionState
getIceGatherPolicy
- getIceGatherPolicy(): IceGatherPolicy
-
Returns IceGatherPolicy
getIceServer
- getIceServer(): IceServer
-
Returns IceServer
getIceServers
- getIceServers(): IceServer[]
-
Returns IceServer[]
getId
-
Returns string
getLocalDescription
- getLocalDescription(): SessionDescription
-
Returns SessionDescription
getRemoteDescription
- getRemoteDescription(): SessionDescription
-
Returns SessionDescription
getSignallingState
- getSignallingState(): SignallingState
-
Returns SignallingState
getState
- getState(): ConnectionState
-
Returns ConnectionState
getStats
- getStats(): Future<ConnectionStats>
-
Returns Future<ConnectionStats>
getStreams
-
Returns TStream[]
getTieBreaker
-
Returns string
getTimeout
-
Returns number
getTrickleIcePolicy
- getTrickleIcePolicy(): TrickleIcePolicy
-
Returns TrickleIcePolicy
getVideoStream
- getVideoStream(): TVideoStream
-
Returns TVideoStream
getVideoStreams
- getVideoStreams(): TVideoStream[]
-
Returns TVideoStream[]
removeIceServer
- removeIceServer(iceServer: IceServer): void
-
Parameters
Returns void
removeIceServers
- removeIceServers(iceServers: IceServer[]): void
-
Parameters
Returns void
removeOnGatheringStateChange
- removeOnGatheringStateChange(value: IAction1<TConnection>): void
-
Parameters
-
value: IAction1<TConnection>
Returns void
removeOnIceConnectionStateChange
- removeOnIceConnectionStateChange(value: IAction1<TConnection>): void
-
Parameters
-
value: IAction1<TConnection>
Returns void
removeOnLocalCandidate
- removeOnLocalCandidate(value: IAction2<TConnection, Candidate>): void
-
Parameters
-
value: IAction2<TConnection, Candidate>
Returns void
removeOnLocalDescription
- removeOnLocalDescription(value: IAction2<TConnection, SessionDescription>): void
-
Parameters
-
value: IAction2<TConnection, SessionDescription>
Returns void
removeOnRemoteCandidate
- removeOnRemoteCandidate(value: IAction2<TConnection, Candidate>): void
-
Parameters
-
value: IAction2<TConnection, Candidate>
Returns void
removeOnRemoteDescription
- removeOnRemoteDescription(value: IAction2<TConnection, SessionDescription>): void
-
Parameters
-
value: IAction2<TConnection, SessionDescription>
Returns void
removeOnSignallingStateChange
- removeOnSignallingStateChange(value: IAction1<TConnection>): void
-
Parameters
-
value: IAction1<TConnection>
Returns void
removeOnStateChange
- removeOnStateChange(value: IAction1<TConnection>): void
-
Parameters
-
value: IAction1<TConnection>
Returns void
setDeadStreamTimeout
- setDeadStreamTimeout(value: number): void
-
Parameters
Returns void
setIceGatherPolicy
- setIceGatherPolicy(value: IceGatherPolicy): void
-
Parameters
Returns void
setIceServer
- setIceServer(value: IceServer): void
-
Parameters
Returns void
setIceServers
- setIceServers(value: IceServer[]): void
-
Parameters
Returns void
setId
- setId(value: string): void
-
Parameters
Returns void
setLocalDescription
- setLocalDescription(localDescription: SessionDescription): Future<SessionDescription>
-
Parameters
-
localDescription: SessionDescription
Returns Future<SessionDescription>
setRemoteDescription
- setRemoteDescription(remoteDescription: SessionDescription): Future<SessionDescription>
-
Parameters
-
remoteDescription: SessionDescription
Returns Future<SessionDescription>
setTieBreaker
- setTieBreaker(value: string): void
-
Parameters
Returns void
setTimeout
- setTimeout(value: number): void
-
Parameters
Returns void
setTrickleIcePolicy
- setTrickleIcePolicy(value: TrickleIcePolicy): void
-
Parameters
Returns void