LocalScreenSharingStream

Interface that represents a local 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

close(): void

Stops capturing media and releases all resources.

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.

source: "local"

Stream source type (local).

sourceDeviceId: null | string

Media device id that produces media data for the local stream.

sourceStream: MediaStream

track: MediaStreamTrack

type: StreamType.ScreenVideo | StreamType.ScreenAudio

Stream type.