Rate this page:

Renderer

Base interface for audio and video renderers.

See: AudioRenderer, VideoRenderer

Methods

clear
Copy URL
clear(): 

void

Stops playing media and releases all resources.

Returns

  • type:

    void

enablePIPControl
Since ver. 5.3.0
Optional
Copy URL
enablePIPControl(enabled: 

boolean

):

void

Enables or disables Picture-in-Picture browser native control for the video element.

Picture-in-Picture control is disabled by default.

Parameters

  • enabled:

    boolean

    Whether Picture-in-Picture control is allowed

Returns

  • type:

    void

getElement
Copy URL
getElement(): 

HTMLAudioElement | HTMLVideoElement

Returns an HTML element.

updateSpeaker
Optional
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 a renderer.

Parameters

  • stream:

    Stream

    Stream to be rendered

Returns

  • type:

    void

Props

type
Copy URL
type: 

MediaRendererType

Render type.

Rate this page: