1. References
  2. Web SDK v5
  3. Stream
  4. RendererManager
Rate this page:

RendererManager

Class that provides API for creating and managing audio and video renderers.

Methods

createAudioRenderer

Copy URL
createAudioRenderer(stream: 
Stream
): 
AudioRenderer

Create an audio renderer for a stream.

Parameters

Returns

createVideoRenderer

Copy URL
createVideoRenderer(stream: 
Stream
): 
VideoRenderer

Creates a video renderer for a stream.

Parameters

Returns

removeByStreamId

Copy URL
removeByStreamId(id: 
string
): 
void

Removes a renderer by the id of the stream that the renderer currently renders.

Parameters

  • id:

    string

    Stream id

Returns

  • type:

    void

updateSpeaker

Copy URL
updateSpeaker(streamId: 
string
, speakerId: 
string
): 
Promise<void>

Changes the audio renderer output to the specified device id.

Parameters

  • streamId:

    string

    Id of the stream which renderer should change the output

  • speakerId:

    string

    Output device id

Returns

  • type:

    Promise<void>

updateStream

Copy URL
updateStream(oldStreamId: 
string
, newStream: 
Stream
): 
void

Replaces a stream for a renderer.

Parameters

  • oldStreamId:

    string

    Stream that is currently rendered

  • newStream:

    Stream

    Stream that should be rendered in the renderer that renders a stream with oldStreamId

Returns

  • type:

    void

Props

renderers

Copy URL
renderers: 
ReadonlyWatchable<Map<string, null | Renderer>>

Watchable property that allows getting audio and video renderers.

Audio and video renderers are stored in a map which keys are stream ids associated with a renderer.