Class default

Hierarchy

EventEmitter<PeerEvents>
- default

Constructors

constructor

new default(options?): default
Parameters
- Optional options: SimplePeerOptions
Returns default
Overrides EventEmitter<PeerEvents>.constructor
- Defined in src/index.ts:31

Properties

`Private` #candidates

#candidates: RTCIceCandidateInit[] = []

`Private` #channelQueue

#channelQueue: {
dataChannelDict?: RTCDataChannelInit;
label: string;
}[] = []

Type declaration

Optional dataChannelDict?: RTCDataChannelInit
label: string

`Private` #dataChannels

#dataChannels: Record<string, RTCDataChannel> = {}

`Private` #ignoringOffer

#ignoringOffer: boolean = false

`Private` #isSettingRemoteAnswerPending

#isSettingRemoteAnswerPending: boolean = false

`Private` #makingOffer

#makingOffer: boolean = false

`Private` #negotiated

#negotiated: boolean = false

`Private` #options

#options: {
rtc: undefined | RTCConfiguration;
timeout: number;
}

Type declaration

rtc: undefined | RTCConfiguration
timeout: number

`Private` #pc

#pc: RTCPeerConnection

`Private` #polite

#polite: boolean = false

`Private` #sc

#sc: RTCDataChannel

`Private` #streamQueue

#streamQueue: {
name: string;
stream: MediaStream;
}[] = []

Type declaration

name: string
stream: MediaStream

`Private` #streams

#streams: Record<string, {
name?: string;
stream?: MediaStream;
}> = {}

Type declaration

Optional name?: string
Optional stream?: MediaStream

`Private` `Optional` #timeout

#timeout?: Timeout

`Static` prefixed

prefixed: string | boolean

Accessors

canSignal

get canSignal(): boolean
Whether the signaling channel's readyState is open

Returns boolean
- Defined in src/index.ts:222

isOpen

get isOpen(): boolean
Whether the RTCPeerConnection's signalingState is not closed

Returns boolean
- Defined in src/index.ts:208

isPolite

get isPolite(): boolean
Whether the peer is polite

If the peer is polite it will concede when a signal collision occurs

Returns boolean
- Defined in src/index.ts:231

`Private` readyForOffer

get readyForOffer(): boolean
Returns boolean
- Defined in src/index.ts:243

stable

get stable(): boolean
Whether the RTCPeerConnection's signalingState is stable

Returns boolean
- Defined in src/index.ts:215

streamNames

get streamNames(): (undefined | string)[]
An array of incoming MediaStream names

Returns (undefined | string)[]
- Defined in src/index.ts:201

streams

get streams(): {
name?: string;
stream?: MediaStream;
}[]
An array of incoming MediaStreams

Returns {
name?: string;
stream?: MediaStream;
}[]
- Defined in src/index.ts:194

Methods

`Private` #addStream

#addStream(name, stream): void
Parameters
- name: string
- stream: MediaStream
Returns void
- Defined in src/index.ts:139

`Private` #createDataChannel

#createDataChannel(label, dataChannelDict?): void
Parameters
- label: string
- Optional dataChannelDict: RTCDataChannelInit
Returns void
- Defined in src/index.ts:56

addListener

addListener<T>(event, fn, context?): this
Type Parameters
- T extends keyof PeerEvents
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<PeerEvents>[Extract<T, keyof PeerEvents>]
      Returns void
- Optional context: any
Returns this
Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

addStream

addStream(name, stream): void
Add a MediaStream to the RTCPeerConnection for streaming audio and video.
Parameters
- name: string
- stream: MediaStream
Returns void
- Defined in src/index.ts:126

close

close(): void
Close the RTCPeerConnection

Returns void
- Defined in src/index.ts:82

`Private` createConnection

createConnection(polite?): void
Parameters
- polite: boolean = false
Returns void
- Defined in src/index.ts:431

createDataChannel

createDataChannel(label, dataChannelDict?): void
Creates a new data channel with the given label for streaming data across the WebRTC Connection.

MDN Reference
Parameters
- label: string
- Optional dataChannelDict: RTCDataChannelInit
Returns void
- Defined in src/index.ts:47

emit

emit<T>(event, ...args): boolean
Type Parameters
- T extends keyof PeerEvents
Parameters
- event: T
- Rest ...args: ArgumentMap<PeerEvents>[Extract<T, keyof PeerEvents>]
Returns boolean
Overrides EventEmitter.emit
- Defined in src/index.ts:235

eventNames

eventNames(): (keyof PeerEvents)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (keyof PeerEvents)[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

getDataChannel

getDataChannel(label): RTCDataChannel
Retrieve the RTCDataChannel with the given label.
Parameters
- label: string
  The label of the data channel to retrieve
Returns RTCDataChannel
The RTCDataChannel with the given label
- Defined in src/index.ts:93

`Private` handleAddStream

handleAddStream(newStream, local?): void
Parameters
- newStream: MediaStream
- local: boolean = false
Returns void
- Defined in src/index.ts:157

`Private` handleChannelStateChange

handleChannelStateChange(state): void
Parameters
- state: RTCDataChannelState
Returns void
- Defined in src/index.ts:404

`Private` handleClose

handleClose(): void
Returns void
- Defined in src/index.ts:97

`Private` handleConnectionStateChange

handleConnectionStateChange(state): void
Parameters
- state: RTCPeerConnectionState
Returns void
- Defined in src/index.ts:321

`Private` handleDataChannel

handleDataChannel(channel): undefined | boolean
Parameters
- channel: RTCDataChannel
Returns undefined | boolean
- Defined in src/index.ts:408

`Private` handleIceConnectionStateChange

handleIceConnectionStateChange(state): void
Parameters
- state: RTCIceConnectionState
Returns void
- Defined in src/index.ts:425

`Private` handleNegotiation

handleNegotiation(): Promise<void>
Returns Promise<void>
- Defined in src/index.ts:365

`Private` handleRemoveStream

handleRemoveStream(stream, local?): void
Parameters
- stream: MediaStream
- local: boolean = false
Returns void
- Defined in src/index.ts:174

handleSignal

handleSignal(signal): Promise<void>
Processes the signals received from the signaling server.
Parameters
- signal: PeerSignal
Returns Promise<void>
- Defined in src/index.ts:254

`Private` handleSignalingStateChange

handleSignalingStateChange(state): void
Parameters
- state: RTCSignalingState
Returns void
- Defined in src/index.ts:327

listenerCount

listenerCount(event): number
Return the number of listeners listening to a given event.
Parameters
- event: keyof PeerEvents
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T>(event): ((...args) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends keyof PeerEvents
Parameters
- event: T
Returns ((...args) => void)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20

off

off<T>(event, fn?, context?, once?): this
Type Parameters
- T extends keyof PeerEvents
Parameters
- event: T
- Optional fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<PeerEvents>[Extract<T, keyof PeerEvents>]
      Returns void
- Optional context: any
- Optional once: boolean
Returns this
Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:69

on

on<T>(event, fn, context?): this
Add a listener for a given event.
Type Parameters
- T extends keyof PeerEvents
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<PeerEvents>[Extract<T, keyof PeerEvents>]
      Returns void
- Optional context: any
Returns this
Inherited from EventEmitter.on
- Defined in node_modules/eventemitter3/index.d.ts:40

once

once<T>(event, fn, context?): this
Add a one-time listener for a given event.
Type Parameters
- T extends keyof PeerEvents
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<PeerEvents>[Extract<T, keyof PeerEvents>]
      Returns void
- Optional context: any
Returns this
Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:54

open

open(): void
Open the RTCPeerConnection and begin negotiation.

Returns void
- Defined in src/index.ts:65

removeAllListeners

removeAllListeners(event?): this
Remove all listeners, or those of the specified event.
Parameters
- Optional event: keyof PeerEvents
Returns this
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T>(event, fn?, context?, once?): this
Remove the listeners of a given event.
Type Parameters
- T extends keyof PeerEvents
Parameters
- event: T
- Optional fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<PeerEvents>[Extract<T, keyof PeerEvents>]
      Returns void
- Optional context: any
- Optional once: boolean
Returns this
Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

removeStream

removeStream(stream): void
Remove a MediaStream from the RTCPeerConnection.

This will stop local and remote playback.
Parameters
- stream: MediaStream
Returns void
- Defined in src/index.ts:152

`Private` sendSignal

sendSignal(signal): undefined | boolean
Parameters
- signal: PeerSignal
Returns undefined | boolean
- Defined in src/index.ts:384

`Private` startTimeout

startTimeout(): void
Returns void
- Defined in src/index.ts:353

`Private` stopTimeout

stopTimeout(): void
Returns void
- Defined in src/index.ts:359

Class default

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns default

Properties

Private #candidates

Private #channelQueue

Type declaration

Optional dataChannelDict?: RTCDataChannelInit

label: string

Private #dataChannels

Private #ignoringOffer

Private #isSettingRemoteAnswerPending

Private #makingOffer

Private #negotiated

Private #options

Type declaration

rtc: undefined | RTCConfiguration

timeout: number

Private #pc

Private #polite

Private #sc

Private #streamQueue

Type declaration

name: string

stream: MediaStream

Private #streams

Type declaration

Optional name?: string

Optional stream?: MediaStream

Private Optional #timeout

Static prefixed

Accessors

canSignal

Returns boolean

isOpen

Returns boolean

isPolite

Returns boolean

Private readyForOffer

Returns boolean

stable

Returns boolean

streamNames

Returns (undefined | string)[]

streams

Returns { name?: string; stream?: MediaStream; }[]

Methods

Private #addStream

Parameters

Returns void

Private #createDataChannel

Parameters

Returns void

addListener

Type Parameters

Parameters

Parameters

Returns void

Returns this

addStream

Parameters

Returns void

close

Returns void

Private createConnection

Parameters

Returns void

createDataChannel

Parameters

Returns void

emit

Type Parameters

`Private` #candidates

`Private` #channelQueue

`Optional` dataChannelDict?: RTCDataChannelInit

`Private` #dataChannels

`Private` #ignoringOffer

`Private` #isSettingRemoteAnswerPending

`Private` #makingOffer

`Private` #negotiated

`Private` #options

`Private` #pc

`Private` #polite

`Private` #sc

`Private` #streamQueue

`Private` #streams

`Optional` name?: string

`Optional` stream?: MediaStream

`Private` `Optional` #timeout

`Static` prefixed

`Private` readyForOffer

Returns {
name?: string;
stream?: MediaStream;
}[]

`Private` #addStream

`Private` #createDataChannel

`Private` createConnection

`Private` handleAddStream

`Private` handleChannelStateChange

`Private` handleClose

`Private` handleConnectionStateChange

`Private` handleDataChannel

`Private` handleIceConnectionStateChange

`Private` handleNegotiation

`Private` handleRemoveStream

`Private` handleSignalingStateChange