RemoteStream

Interface that represents a remote audio, video, or screen sharing stream.

Methods

addEventListener(eventName: StreamEvent.Ended, listener: (event: StreamEnded) => void | Promise<void>, options: ListenerOptions): void

Registers a handler for the specified event.

One event can have more than one handler; handlers are executed in order of their registration.

eventName:
StreamEvent.Ended
Event name
listener:
(event: StreamEnded) => void | Promise<void>
Handler function that is triggered when an event of the specified type occurs
options:
ListenerOptions
Object that specifies characteristics about the event listener

removeEventListener(eventName: StreamEvent.Ended, listener: (event: StreamEnded) => void | Promise<void>, options: ListenerOptions): void

Registers a handler for the specified event.

One event can have more than one handler; handlers are executed in order of their registration.

eventName:
StreamEvent.Ended
Event name
listener:
(event: StreamEnded) => void | Promise<void>
Handler function that is triggered when an event of the specified type occurs
options:
ListenerOptions
Object that specifies characteristics about the event listener

id: string

Stream id.

isReceiving: Watchable<boolean>

Watchable property that allows getting and setting video receiving status and observe its changes.

For the remote streams in a conference, changes the value when one of the following events is triggered:

For remote stream in a call, it is always true.

source: "remote"

Stream source type (remote).

sourceStream: MediaStream

track: MediaStreamTrack

type: StreamType

Stream type.