Videocomponent – V2.ONCYBER

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

Property	Modifiers	Type	Description
autoPlay		boolean	Whether the video should start playing automatically. Defaults to false
curvedAngle		number	The angle of the curved video. Defaults to 180
displayMode		"flat" \| "curved"	Determine the display mode of the video. Defaults to "flat"
isPlaying	`readonly`	boolean	Returns true if the video is playing
muted		boolean	Whether the video should be muted. Defaults to false
opacity		number	Set the opacity of the video. Defaults to 1
volume		number	Volume of the audio, from 0 to 1. Defaults to 1

Methods

Method	Modifiers	Description
_getBBoxImp(target)	`protected`
dispose()	`protected`
init()	`protected`
pause()		Pause the video
play()		Play the video