Class PeerConnection

Hierarchy

EventTarget<PeerConnectionEventMap>
- PeerConnection

Index

Constructors

constructor

new PeerConnection(_ctx: PeerConnectionContext, id: string, _signalingClient: SignalingClient, _localStream: LocalStream, _isInitiator: boolean, _turnCredential: TurnCredential, _mediaDirections: MediaDirections, _isDisposable: boolean): PeerConnection
Parameters
- _ctx: PeerConnectionContext
- id: string
- _signalingClient: SignalingClient
- _localStream: LocalStream
- _isInitiator: boolean
- _turnCredential: TurnCredential
- _mediaDirections: MediaDirections
- _isDisposable: boolean
Returns PeerConnection

Overrides EventTarget.constructor

Properties

`Protected` _listeners

_listeners: { answering?: EventListener<{ args: [] }>[]; closed?: EventListener<{ args: [] }>[]; connected?: EventListener<{ args: [] }>[]; iceFailed?: EventListener<{ args: [] }>[]; iceRestartAnswering?: EventListener<{ args: [] }>[]; iceRestartOffering?: EventListener<{ args: [] }>[]; offering?: EventListener<{ args: [] }>[]; reconnecting?: EventListener<{ args: [] }>[]; remoteStream?: EventListener<{ args: [MediaStream] }>[] } = {}

Type declaration

Optional answering?: EventListener<{ args: [] }>[]
Optional closed?: EventListener<{ args: [] }>[]
Optional connected?: EventListener<{ args: [] }>[]
Optional iceFailed?: EventListener<{ args: [] }>[]
Optional iceRestartAnswering?: EventListener<{ args: [] }>[]
Optional iceRestartOffering?: EventListener<{ args: [] }>[]
Optional offering?: EventListener<{ args: [] }>[]
Optional reconnecting?: EventListener<{ args: [] }>[]
Optional remoteStream?: EventListener<{ args: [MediaStream] }>[]

`Readonly` id

id: string

off

off: (<K>(type: K, callback: EventListener<PeerConnectionEventMap[K]>) => void) = ...

Type declaration

- <K>(type: K, callback: EventListener<PeerConnectionEventMap[K]>): void
- Type Parameters
  - K extends keyof PeerConnectionEventMap
  Parameters
  - type: K
  - callback: EventListener<PeerConnectionEventMap[K]>
  Returns void

on

on: (<K>(type: K, callback: EventListener<PeerConnectionEventMap[K]>) => (() => void)) = ...

Type declaration

- <K>(type: K, callback: EventListener<PeerConnectionEventMap[K]>): (() => void)
- Type Parameters
  - K extends keyof PeerConnectionEventMap
  Parameters
  - type: K
  - callback: EventListener<PeerConnectionEventMap[K]>
  Returns (() => void)
  - - (): void
    - Returns void

Accessors

remoteStream

get remoteStream(): MediaStream
Returns MediaStream

rtcConnection

get rtcConnection(): RTCPeerConnection
Returns RTCPeerConnection

signalingClient

get signalingClient(): SignalingClient
Returns SignalingClient

Methods

`Protected` _dispatchEvent

_dispatchEvent<K>(type: K, ...args: ArgsType<PeerConnectionEventMap[K]>): void
Type Parameters
- K extends keyof PeerConnectionEventMap
Parameters
- type: K
- Rest ...args: ArgsType<PeerConnectionEventMap[K]>
Returns void

Inherited from EventTarget._dispatchEvent

addEventListener

addEventListener<K>(type: K, callback: EventListener<PeerConnectionEventMap[K]>): (() => void)
Type Parameters
- K extends keyof PeerConnectionEventMap
Parameters
- type: K
- callback: EventListener<PeerConnectionEventMap[K]>
Returns (() => void)
- - (): void
  - Returns void
Inherited from EventTarget.addEventListener

close

close(): void
Returns void

createOffer

createOffer(): void
Returns void

getCandidateInfo

getCandidateInfo(): Promise<IceConnectionInfo>
Returns Promise<IceConnectionInfo>

getStatsLog

getStatsLog(): Promise<RTCStatsLog>
Returns Promise<RTCStatsLog>

onEvent

onEvent(command: PeerConnectionInternalCommandUnion): void
Parameters
- command: PeerConnectionInternalCommandUnion
Returns void

onLocalStream

onLocalStream(stream: MediaStream): void
Parameters
- stream: MediaStream
Returns void

once

once<K>(type: K, givenCb: EventListener<PeerConnectionEventMap[K]>): (() => void)
Type Parameters
- K extends keyof PeerConnectionEventMap
Parameters
- type: K
- givenCb: EventListener<PeerConnectionEventMap[K]>
Returns (() => void)
- - (): void
  - Returns void
Inherited from EventTarget.once

removeAllEventListeners

removeAllEventListeners(): void
Returns void

Inherited from EventTarget.removeAllEventListeners

removeEventListener

removeEventListener<K>(type: K, callback: EventListener<PeerConnectionEventMap[K]>): void
Type Parameters
- K extends keyof PeerConnectionEventMap
Parameters
- type: K
- callback: EventListener<PeerConnectionEventMap[K]>
Returns void

Inherited from EventTarget.removeEventListener

Class PeerConnection

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

_ctx: PeerConnectionContext

id: string

_signalingClient: SignalingClient

_localStream: LocalStream

_isInitiator: boolean

_turnCredential: TurnCredential

_mediaDirections: MediaDirections

_isDisposable: boolean

Returns PeerConnection

Properties

Protected _listeners

Type declaration

Optional answering?: EventListener<{ args: [] }>[]

Optional closed?: EventListener<{ args: [] }>[]

Optional connected?: EventListener<{ args: [] }>[]

Optional iceFailed?: EventListener<{ args: [] }>[]

Optional iceRestartAnswering?: EventListener<{ args: [] }>[]

Optional iceRestartOffering?: EventListener<{ args: [] }>[]

Optional offering?: EventListener<{ args: [] }>[]

Optional reconnecting?: EventListener<{ args: [] }>[]

Optional remoteStream?: EventListener<{ args: [MediaStream] }>[]

Readonly id

off

Type declaration

Type Parameters

K extends keyof PeerConnectionEventMap

Parameters

type: K

callback: EventListener<PeerConnectionEventMap[K]>

Returns void

on

Type declaration

Type Parameters

K extends keyof PeerConnectionEventMap

Parameters

type: K

callback: EventListener<PeerConnectionEventMap[K]>

Returns (() => void)

Returns void

Accessors

remoteStream

Returns MediaStream

rtcConnection

Returns RTCPeerConnection

signalingClient

Returns SignalingClient

Methods

Protected _dispatchEvent

Type Parameters

K extends keyof PeerConnectionEventMap

Parameters

type: K

Rest ...args: ArgsType<PeerConnectionEventMap[K]>

Returns void

addEventListener

Type Parameters

K extends keyof PeerConnectionEventMap

Parameters

type: K

callback: EventListener<PeerConnectionEventMap[K]>

Returns (() => void)

Returns void

close

Returns void

createOffer

Returns void

getCandidateInfo

Returns Promise<IceConnectionInfo>

getStatsLog

Returns Promise<RTCStatsLog>

`Protected` _listeners

`Optional` answering?: EventListener<{ args: [] }>[]

`Optional` closed?: EventListener<{ args: [] }>[]

`Optional` connected?: EventListener<{ args: [] }>[]

`Optional` iceFailed?: EventListener<{ args: [] }>[]

`Optional` iceRestartAnswering?: EventListener<{ args: [] }>[]

`Optional` iceRestartOffering?: EventListener<{ args: [] }>[]

`Optional` offering?: EventListener<{ args: [] }>[]

`Optional` reconnecting?: EventListener<{ args: [] }>[]

`Optional` remoteStream?: EventListener<{ args: [MediaStream] }>[]

`Readonly` id

`Protected` _dispatchEvent

`Rest` ...args: ArgsType<PeerConnectionEventMap[K]>