Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IExternalConnection

Hierarchy

  • IConnection<IExternalConnection, IExternalStream, IExternalAudioStream, IExternalVideoStream, IExternalDataStream>
  • IExternal<IInternalConnection>
    • IExternalConnection

Index

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<IExternalConnection>): void
  • Parameters

    • value: IAction1<IExternalConnection>

    Returns void

addOnIceConnectionStateChange

  • addOnIceConnectionStateChange(value: IAction1<IExternalConnection>): void
  • Parameters

    • value: IAction1<IExternalConnection>

    Returns void

addOnLocalCandidate

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

    • value: IAction2<IExternalConnection, Candidate>

    Returns void

addOnLocalDescription

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

    • value: IAction2<IExternalConnection, SessionDescription>

    Returns void

addOnRemoteCandidate

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

    • value: IAction2<IExternalConnection, Candidate>

    Returns void

addOnRemoteDescription

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

    • value: IAction2<IExternalConnection, SessionDescription>

    Returns void

addOnSignallingStateChange

  • addOnSignallingStateChange(value: IAction1<IExternalConnection>): void
  • Parameters

    • value: IAction1<IExternalConnection>

    Returns void

addOnStateChange

  • addOnStateChange(value: IAction1<IExternalConnection>): void
  • Parameters

    • value: IAction1<IExternalConnection>

    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>

getAudioStream

  • getAudioStream(): IExternalAudioStream
  • Returns IExternalAudioStream

getAudioStreams

  • getAudioStreams(): IExternalAudioStream[]
  • Returns IExternalAudioStream[]

getDataStream

  • getDataStream(): IExternalDataStream
  • Returns IExternalDataStream

getDataStreams

  • getDataStreams(): IExternalDataStream[]
  • Returns IExternalDataStream[]

getDeadStreamTimeout

  • getDeadStreamTimeout(): number

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

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

  • getStreams(): IExternalStream[]
  • Returns IExternalStream[]

getTieBreaker

  • getTieBreaker(): string
  • Returns string

getTimeout

  • getTimeout(): number
  • Returns number

getTrickleIcePolicy

  • getTrickleIcePolicy(): TrickleIcePolicy
  • Returns TrickleIcePolicy

getVideoStream

  • getVideoStream(): IExternalVideoStream
  • Returns IExternalVideoStream

getVideoStreams

  • getVideoStreams(): IExternalVideoStream[]
  • Returns IExternalVideoStream[]

removeIceServer

  • removeIceServer(iceServer: IceServer): void
  • Parameters

    • iceServer: IceServer

    Returns void

removeIceServers

  • removeIceServers(iceServers: IceServer[]): void
  • Parameters

    • iceServers: IceServer[]

    Returns void

removeOnGatheringStateChange

  • removeOnGatheringStateChange(value: IAction1<IExternalConnection>): void
  • Parameters

    • value: IAction1<IExternalConnection>

    Returns void

removeOnIceConnectionStateChange

  • removeOnIceConnectionStateChange(value: IAction1<IExternalConnection>): void
  • Parameters

    • value: IAction1<IExternalConnection>

    Returns void

removeOnLocalCandidate

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

    • value: IAction2<IExternalConnection, Candidate>

    Returns void

removeOnLocalDescription

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

    • value: IAction2<IExternalConnection, SessionDescription>

    Returns void

removeOnRemoteCandidate

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

    • value: IAction2<IExternalConnection, Candidate>

    Returns void

removeOnRemoteDescription

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

    • value: IAction2<IExternalConnection, SessionDescription>

    Returns void

removeOnSignallingStateChange

  • removeOnSignallingStateChange(value: IAction1<IExternalConnection>): void
  • Parameters

    • value: IAction1<IExternalConnection>

    Returns void

removeOnStateChange

  • removeOnStateChange(value: IAction1<IExternalConnection>): void
  • Parameters

    • value: IAction1<IExternalConnection>

    Returns void

setDeadStreamTimeout

  • setDeadStreamTimeout(value: number): void
  • Parameters

    • value: number

    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

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

    • value: string

    Returns void

setTimeout

  • setTimeout(value: number): void
  • Parameters

    • value: number

    Returns void

setTrickleIcePolicy

  • setTrickleIcePolicy(value: TrickleIcePolicy): void
  • Parameters

    • value: TrickleIcePolicy

    Returns void