Videocomponent

VideoComponent class

This component is used to display a video in the game.

See VideoComponentData for the data schema used to create a video component

Signature:

export declare class VideoComponent extends Component3D<VideoComponentData> 

Extends: Component3D<VideoComponentData>

Remarks

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the VideoComponent class.

Properties

PropertyModifiersTypeDescription
isPlayingreadonlybooleanReturns true if the video is playing
mutedbooleanReturns true if the video is muted
volumeanyReturns the audio volume, gos from O (muted) to 1 (max volume)

Methods

MethodModifiersDescription
pause()Pause the video
play()Play the video