Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Connection

Hierarchy

  • Dynamic
    • Connection

Implements

  • IConnection<Connection, Stream, AudioStream, VideoStream, DataStream>
  • IExternalConnection

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private _internal

_internal: IInternalConnection
internal

Private _onGatheringStateChangeValues

_onGatheringStateChangeValues: IAction1<Connection>[] = []
internal

Private _onIceConnectionStateChangeValues

_onIceConnectionStateChangeValues: IAction1<Connection>[] = []
internal

Private _onLocalCandidateValues

_onLocalCandidateValues: IAction2<Connection, Candidate>[] = []
internal

Private _onLocalDescriptionValues

_onLocalDescriptionValues: IAction2<Connection, SessionDescription>[] = []
internal

Private _onRemoteCandidateValues

_onRemoteCandidateValues: IAction2<Connection, Candidate>[] = []
internal

Private _onRemoteDescriptionValues

_onRemoteDescriptionValues: IAction2<Connection, SessionDescription>[] = []
internal

Private _onSignallingStateChangeValues

_onSignallingStateChangeValues: IAction1<Connection>[] = []
internal

Private _onStateChangeValues

_onStateChangeValues: IAction1<Connection>[] = []
internal

Private _remoteMedia

_remoteMedia: RemoteMedia
internal

Methods

_getInternal

  • _getInternal(): IInternalConnection
  • internal

    Returns IInternalConnection

addIceServer

  • addIceServer(iceServer: IceServer): void

  • Parameters

    • iceServer: IceServer

    Returns void

addIceServers

  • addIceServers(iceServers: IceServer[]): void

  • Parameters

    • iceServers: IceServer[]

    Returns void

addOnGatheringStateChange

  • addOnGatheringStateChange(value: IAction1<Connection>): void

  • Parameters

    • value: IAction1<Connection>

    Returns void

addOnIceConnectionStateChange

  • addOnIceConnectionStateChange(value: IAction1<Connection>): void

  • Parameters

    • value: IAction1<Connection>

    Returns void

addOnLocalCandidate

  • addOnLocalCandidate(value: IAction2<Connection, Candidate>): void

  • Parameters

    • value: IAction2<Connection, Candidate>

    Returns void

addOnLocalDescription

  • addOnLocalDescription(value: IAction2<Connection, SessionDescription>): void

  • Parameters

    • value: IAction2<Connection, SessionDescription>

    Returns void

addOnRemoteCandidate

  • addOnRemoteCandidate(value: IAction2<Connection, Candidate>): void

  • Parameters

    • value: IAction2<Connection, Candidate>

    Returns void

addOnRemoteDescription

  • addOnRemoteDescription(value: IAction2<Connection, SessionDescription>): void

  • Parameters

    • value: IAction2<Connection, SessionDescription>

    Returns void

addOnSignallingStateChange

  • addOnSignallingStateChange(value: IAction1<Connection>): void

  • Parameters

    • value: IAction1<Connection>

    Returns void

addOnStateChange

  • addOnStateChange(value: IAction1<Connection>): void

  • Parameters

    • value: IAction1<Connection>

    Returns void

addRemoteCandidate

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

  • Parameters

    • remoteCandidate: Candidate

    Returns Future<Candidate>

close

  • close(): void

  • Returns void

createAnswer

  • createAnswer(): Future<SessionDescription>

  • Returns Future<SessionDescription>

createOffer

  • createOffer(): Future<SessionDescription>

  • Returns Future<SessionDescription>

Private externalToInternal

  • externalToInternal(external: IExternalStream): IInternalStream

  • Parameters

    • external: IExternalStream

    Returns IInternalStream

Private externalsToInternals

  • externalsToInternals(externals: IExternalStream[]): IInternalStream[]

  • Parameters

    • externals: IExternalStream[]

    Returns IInternalStream[]

getAudioStream

  • getAudioStream(): AudioStream

  • Returns AudioStream

getAudioStreams

  • getAudioStreams(): AudioStream[]

  • Returns AudioStream[]

getDataStream

  • getDataStream(): DataStream

  • Returns DataStream

getDataStreams

  • getDataStreams(): DataStream[]

  • Returns DataStream[]

getDeadStreamTimeout

  • getDeadStreamTimeout(): number

  • Returns number

getDynamicProperties

  • getDynamicProperties(): Hash<string, Object>
  • Gets the dynamic properties on this instance.

    Returns Hash<string, Object>

getDynamicValue

  • getDynamicValue(key: string): Object
  • Gets a property value from the local cache.

    Parameters

    • 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.

getError

  • getError(): Error

  • Returns Error

getGatheringState

  • getGatheringState(): IceGatheringState

  • Returns IceGatheringState

getHasAudio

  • getHasAudio(): boolean

  • Returns boolean

getHasData

  • getHasData(): boolean

  • Returns boolean

getHasVideo

  • getHasVideo(): boolean

  • Returns boolean

getIceConnectionState

  • getIceConnectionState(): IceConnectionState

  • Returns IceConnectionState

getIceGatherPolicy

  • getIceGatherPolicy(): IceGatherPolicy

  • Returns IceGatherPolicy

getIceServer

  • getIceServer(): IceServer

  • Returns IceServer

getIceServers

  • getIceServers(): IceServer[]

  • Returns IceServer[]

getId

  • getId(): string

  • Returns string

getIsDirty

  • getIsDirty(): boolean
  • Gets a value indicating whether this instance is dirty.
    internal

    Returns boolean

getIsSerialized

  • getIsSerialized(): boolean

getLocalDescription

  • getLocalDescription(): SessionDescription

  • Returns SessionDescription

getRemoteDescription

  • getRemoteDescription(): SessionDescription

  • Returns SessionDescription

getRemoteMedia

  • getRemoteMedia(): RemoteMedia

  • Returns RemoteMedia

getSerialized

  • getSerialized(): string

getSignallingState

  • getSignallingState(): SignallingState

  • Returns SignallingState

getState

  • getState(): ConnectionState

  • Returns ConnectionState

getStats

  • getStats(): Future<ConnectionStats>

  • Returns Future<ConnectionStats>

getStreams

  • getStreams(): Stream[]

  • Returns Stream[]

getTieBreaker

  • getTieBreaker(): string

  • Returns string

getTimeout

  • getTimeout(): number

  • Returns number

getTrickleIcePolicy

  • getTrickleIcePolicy(): TrickleIcePolicy

  • Returns TrickleIcePolicy

getTypeString

  • getTypeString(): string

getVideoStream

  • getVideoStream(): VideoStream

  • Returns VideoStream

getVideoStreams

  • getVideoStreams(): VideoStream[]

  • Returns VideoStream[]

Private internalToExternal

  • internalToExternal(internal: IInternalStream): IExternalStream

  • Parameters

    • internal: IInternalStream

    Returns IExternalStream

Private internalsToExternals

  • internalsToExternals(internals: IInternalStream[]): IExternalStream[]

  • Parameters

    • internals: IInternalStream[]

    Returns IExternalStream[]

removeIceServer

  • removeIceServer(iceServer: IceServer): void

  • Parameters

    • iceServer: IceServer

    Returns void

removeIceServers

  • removeIceServers(iceServers: IceServer[]): void

  • Parameters

    • iceServers: IceServer[]

    Returns void

removeOnGatheringStateChange

  • removeOnGatheringStateChange(value: IAction1<Connection>): void

  • Parameters

    • value: IAction1<Connection>

    Returns void

removeOnIceConnectionStateChange

  • removeOnIceConnectionStateChange(value: IAction1<Connection>): void

  • Parameters

    • value: IAction1<Connection>

    Returns void

removeOnLocalCandidate

  • removeOnLocalCandidate(value: IAction2<Connection, Candidate>): void

  • Parameters

    • value: IAction2<Connection, Candidate>

    Returns void

removeOnLocalDescription

  • removeOnLocalDescription(value: IAction2<Connection, SessionDescription>): void

  • Parameters

    • value: IAction2<Connection, SessionDescription>

    Returns void

removeOnRemoteCandidate

  • removeOnRemoteCandidate(value: IAction2<Connection, Candidate>): void

  • Parameters

    • value: IAction2<Connection, Candidate>

    Returns void

removeOnRemoteDescription

  • removeOnRemoteDescription(value: IAction2<Connection, SessionDescription>): void

  • Parameters

    • value: IAction2<Connection, SessionDescription>

    Returns void

removeOnSignallingStateChange

  • removeOnSignallingStateChange(value: IAction1<Connection>): void

  • Parameters

    • value: IAction1<Connection>

    Returns void

removeOnStateChange

  • removeOnStateChange(value: IAction1<Connection>): void

  • Parameters

    • value: IAction1<Connection>

    Returns void

setDeadStreamTimeout

  • setDeadStreamTimeout(value: number): void

  • Parameters

    • value: number

    Returns void

setDynamicProperties

  • setDynamicProperties(value: Hash<string, Object>): void
  • internal

    Parameters

    • value: Hash<string, Object>

    Returns void

setDynamicValue

  • setDynamicValue(key: string, value: Object): void
  • Sets a property value in the local cache.

    Parameters

    • 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

setIceGatherPolicy

  • setIceGatherPolicy(value: IceGatherPolicy): void

  • Parameters

    • value: IceGatherPolicy

    Returns void

setIceServer

  • setIceServer(value: IceServer): void

  • Parameters

    • value: IceServer

    Returns void

setIceServers

  • setIceServers(value: IceServer[]): void

  • Parameters

    • value: IceServer[]

    Returns void

setId

  • setId(value: string): void

  • Parameters

    • value: string

    Returns void

setIsDirty

  • setIsDirty(value: boolean): void
  • Sets a value indicating whether this instance is dirty.
    internal

    Parameters

    • value: boolean

    Returns void

setIsSerialized

  • setIsSerialized(value: boolean): void
  • internal

    Parameters

    • value: boolean

    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>

setSerialized

  • setSerialized(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

setTieBreaker

  • setTieBreaker(value: string): void

  • Parameters

    • value: string

    Returns void

setTimeout

  • setTimeout(value: number): void

  • Parameters

    • value: number

    Returns void

setTrickleIcePolicy

  • setTrickleIcePolicy(value: TrickleIcePolicy): void

  • Parameters

    • value: TrickleIcePolicy

    Returns void

unsetDynamicValue

  • unsetDynamicValue(key: string): boolean
  • Unsets a property value in the local cache.

    Parameters

    • 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.