Rate this page:

LocalStream

Interface that represents any local stream.

Methods

addEventListener

Copy URL

Registers a handler for the specified event.

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

Parameters

  • Event name

  • listener:

    (event: StreamEnded) => void | Promise<void>

    Handler function that is triggered when an event of the specified type occurs

  • Object that specifies characteristics about the event listener

Returns

  • type:

    void

close

Copy URL

Stops capturing media and releases all resources.

Returns

  • type:

    void

removeEventListener

Copy URL

Registers a handler for the specified event.

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

Parameters

  • Event name

  • listener:

    (event: StreamEnded) => void | Promise<void>

    Handler function that is triggered when an event of the specified type occurs

  • Object that specifies characteristics about the event listener

Returns

  • type:

    void

Props

id

Copy URL

Stream id.

source

Copy URL

Stream source type (local).

sourceDeviceId

Copy URL

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

sourceStream

Copy URL

MediaStream object.

track

Copy URL

type

Copy URL

Stream type.