1. References
  2. Websdk v5
  3. Stream
  4. AudioRenderer
Rate this page:

AudioRenderer

Class that represents an audio renderer.

An instance should be created via the RendererManager.createAudioRenderer method.

Methods

clear

Copy URL
clear(): 
void

Stops playing audio and releases all resources.

Returns

  • type:

    void

getElement

Copy URL
getElement(): 
HTMLAudioElement

Returns a HTMLAudioElement object and starts playing audio.

Returns

setVolume

Copy URL
setVolume(value: 
number
): 
this

Sets the audio volume for the

Setting this value has no effect in iOS.

Parameters

  • value:

    number

    Audio volume. The value should fall between 0 and 1, where 0 is effectively muted and 1 is the loudest possible value.

Returns

  • type:

    this

updateSpeaker

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

Changes the audio renderer output to the specified device id.

Parameters

  • speakerId:

    string

    Output device id

Returns

  • type:

    Promise<void>

updateStream

Copy URL
updateStream(stream: 
Stream
): 
void

Replaces a stream for the renderer.

Parameters

  • stream:

    Stream

    Audio stream to be rendered

Returns

  • type:

    void

Props

currentSpeakerId

Copy URL
currentSpeakerId: 
null | string

Current speaker device id.

type

Copy URL
type: 
MediaRendererType.Audio

Returns the renderer type (audio).