Rate this page:

StreamManager

Interface for extended management of local audio/video streams.

Methods

get

Copy URL
get(): 

StreamManager

Get the StreamManager instance

Returns

getLocalMediaRenderers

Copy URL
getLocalMediaRenderers(): 

MediaRenderer[]

List of currently used containers for local audio and video streams.

Returns

getUserMedia

Copy URL
getUserMedia(constraints: 

MediaStreamConstraints

):

Promise<MediaStream>

Parameters

  • constraints:

    MediaStreamConstraints

Returns

  • type:

    Promise<MediaStream>

hideLocalVideo

Copy URL
hideLocalVideo(): 

Promise<void>

Turn off local video. Use the showLocalVideo method to turn on local video.

Returns

  • type:

    Promise<void>

off

Copy URL
off(event: 

HardwareEvents

,
handler:

Function

):

void

Remove a handler for the specified event. The method is a shorter equivalent for removeEventListener. If a number of events has the same function as a handler, the method can be called multiple times with the same handler argument.

Parameters

Returns

  • type:

    void

on

Copy URL
on(event: 

HardwareEvents

,
handler:

Function

,
options:

EventListenerOption

):

void

Register a handler for the specified event. The method is a shorter equivalent for addEventListener. One event can have more than one handler; handlers are executed in order of registration. Use the StreamManager.off method to delete a handler.

Parameters

Returns

  • type:

    void

showLocalVideo

Copy URL
showLocalVideo(placeOnDom: 

boolean

):

Promise<MediaRenderer>

Turn on local video. The container for local video elements must be specified via in the Config.localVideoContainerId field in the Client.init config. If it's not specified, local videos will be appended to end of the element. Use the hideLocalVideo method to turn off local video.

Parameters

  • placeOnDom:

    boolean

    Defaults on:  true

Returns

updateLocalVideo

Copy URL
updateLocalVideo(): 

void

Returns

  • type:

    void

Props

isLocalVideoRequested

Copy URL
isLocalVideoRequested: 

boolean