LocalScreenSharingStream
Interface that represents a local screen sharing stream.
Methods
addEventListener(eventName: , listener: (event: StreamEnded) => void | Promise<void>
, options: ): void
Registers a handler for the specified event.
One event can have more than one handler; handlers are executed in order of their registration.
Parameters
eventName:
Event name
listener:
(event: StreamEnded) => void | Promise<void>
Handler function that is triggered when an event of the specified type occurs
options:
Object that specifies characteristics about the event listener
Returns
type:
void
close(): void
Stops capturing media and releases all resources.
Returns
type:
void
removeEventListener(eventName: , listener: (event: StreamEnded) => void | Promise<void>
, options: ): void
Registers a handler for the specified event.
One event can have more than one handler; handlers are executed in order of their registration.
Parameters
eventName:
Event name
listener:
(event: StreamEnded) => void | Promise<void>
Handler function that is triggered when an event of the specified type occurs
options:
Object that specifies characteristics about the event listener
Returns
type:
void
Props
config: id: string
Stream id.
source: "local"
Stream source type (local).
sourceDeviceId: null | string
Media device id that produces media data for the local stream.