Class Peer

Hierarchy

EventEmitter<PeerEvents>
- Peer

Index

Constructors

constructor

new Peer(options?: PeerOptions): Peer
Parameters
- options: PeerOptions = {}
Returns Peer
Overrides EventEmitter<PeerEvents>.constructor
- Defined in Peer.ts:91

Methods

addTrack

addTrack(track: MediaStreamTrack): RTCRtpSender
Parameters
- track: MediaStreamTrack
Returns RTCRtpSender
- Defined in Peer.ts:309

addTransceiverFromKind

addTransceiverFromKind(
kind: string,
init?: RTCRtpTransceiverInit,
): null | RTCRtpTransceiver
Parameters
- kind: string
- Optionalinit: RTCRtpTransceiverInit
Returns null | RTCRtpTransceiver
- Defined in Peer.ts:289

close

close(): Peer
Returns Peer
- Defined in Peer.ts:162

closed

closed(): Promise<void>
Returns Promise<void>
- Defined in Peer.ts:149

data

data(): Promise<string | Blob | ArrayBuffer | Uint8Array<ArrayBufferLike>>
Returns Promise<string | Blob | ArrayBuffer | Uint8Array<ArrayBufferLike>>
- Defined in Peer.ts:145

getChannel

getChannel(): undefined | RTCDataChannel
Returns undefined | RTCDataChannel
- Defined in Peer.ts:126

getConnection

getConnection(): undefined | RTCPeerConnection
Returns undefined | RTCPeerConnection
- Defined in Peer.ts:122

getId

getId(): string
Returns string
- Defined in Peer.ts:118

init

init(): Peer
Returns Peer
- Defined in Peer.ts:157

isClosed

isClosed(): boolean
Returns boolean
- Defined in Peer.ts:134

isInitiator

isInitiator(): boolean
Returns boolean
- Defined in Peer.ts:153

isReady

isReady(): undefined | boolean
Returns undefined | boolean
- Defined in Peer.ts:130

negotiate

negotiate(): Promise<Peer>
Returns Promise<Peer>
- Defined in Peer.ts:330

readableStream

readableStream(): ReadableStream<string | Blob | ArrayBuffer>
Returns ReadableStream<string | Blob | ArrayBuffer>
- Defined in Peer.ts:188

ready

ready(): Promise<void>
Returns Promise<void>
- Defined in Peer.ts:138

removeTrack

removeTrack(sender: RTCRtpSender): Peer
Parameters
- sender: RTCRtpSender
Returns Peer
- Defined in Peer.ts:317

send

send(
chunk: string | Blob | ArrayBuffer | ArrayBufferView<ArrayBufferLike>,
): Peer
Parameters
- chunk: string | Blob | ArrayBuffer | ArrayBufferView<ArrayBufferLike>
Returns Peer
- Defined in Peer.ts:166

signal

signal(message: SignalMessage): Promise<Peer>
Parameters
- message: SignalMessage
Returns Promise<Peer>
- Defined in Peer.ts:195

waitOnce

waitOnce<K extends keyof PeerEvents>(
event: K,
): Promise<EventEmitterReturnType<ArgumentMap<PeerEvents>[K]>>
Type Parameters
- K extends keyof PeerEvents
Parameters
- event: K
Returns Promise<EventEmitterReturnType<ArgumentMap<PeerEvents>[K]>>
- Defined in Peer.ts:269

writableStream

writableStream(): WritableStream<
    string
    | Blob
    | ArrayBuffer
    | ArrayBufferView<ArrayBufferLike>,
>
Returns WritableStream<string | Blob | ArrayBuffer | ArrayBufferView<ArrayBufferLike>>
- Defined in Peer.ts:181

write

write(
chunk: string | Blob | ArrayBuffer | ArrayBufferView<ArrayBufferLike>,
): void
Parameters
- chunk: string | Blob | ArrayBuffer | ArrayBufferView<ArrayBufferLike>
Returns void
- Defined in Peer.ts:174