Rate this page:

VideoRenderer

Class that represents an audio renderer.

An instance should be created via the RendererManager.createVideoRenderer method

Methods

clear
Copy URL
clear(): 

void

Stops playing audio and releases all resources.

Returns

  • type:

    void

enablePIPControl
Since ver. 5.3.0
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(): 

HTMLVideoElement

Returns a HTMLVideoElement object and starts playing video.

Returns

mirror
Copy URL
mirror(): 

this

Mirrors the current video element.

Returns

  • type:

    this

setElementClasses
Copy URL
setElementClasses(classes: 

string[]

):

this

Updates the collection of the class attributes of the video element with the provided ones.

Parameters

  • classes:

    string[]

    Array of class attributes

Returns

  • type:

    this

setElementId
Copy URL
setElementId(elementId: 

string

):

this

Sets the HTML id attribute to the video element.

Parameters

  • elementId:

    string

    Id attribute

Returns

  • type:

    this

setStyles
Copy URL
setStyles(styles: 

PlainStyles

):

this

Parameters

Returns

  • type:

    this

updateStream
Copy URL
updateStream(stream: 

Stream

):

void

Replaces a stream for the renderer.

Parameters

  • stream:

    Stream

    Video stream to be rendered

Returns

  • type:

    void

Props

type
Copy URL
type: 

MediaRendererType.Video

Returns the renderer type (video).

Rate this page: