Rate this page:

VideoRenderer

Class that represents an audio renderer.

An instance should be created via the RendererManager.createVideoRenderer method

Methods

clear

Copy URL

void

clear()

Stops playing audio and releases all resources.

Returns

  • type:

    void

getElement

Copy URL

HTMLVideoElement

getElement()

Returns a HTMLVideoElement object and starts playing video.

Returns

mirror

Copy URL

this

mirror()

Mirrors the current video element.

Returns

  • type:

    this

setElementClasses

Copy URL

this

setElementClasses(

string[]

classes
)

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

this

setElementId(

string

elementId
)

Sets the HTML id attribute to the video element.

Parameters

  • elementId:

    string

    Id attribute

Returns

  • type:

    this

setStyles

Copy URL

this

setStyles(

PlainStyles

styles
)

Parameters

Returns

  • type:

    this

updateStream

Copy URL

void

updateStream(

Stream

stream
)

Replaces a stream for the renderer.

Parameters

  • stream:

    Stream

    Video stream to be rendered

Returns

  • type:

    void

Props

type

Copy URL
 type

Returns the renderer type (video).