Skip to main content

VideoNode Class

Description:

  A class for creating VideoNode objects.

__call

Type: Metamethod.

Description:

  The constructor function for creating a VideoNode instance.

Signature:

metamethod __call: function(
self: VideoNodeClass,
filename: string,
looped?: boolean --[[false]]
): VideoNode | nil

Parameters:

ParameterTypeDescription
filenamestringThe path to an Ogg (.ogv) file containing a Theora video stream. VideoNode reads it through Dora Content, renders video only, supports Theora 4:2:0/4:2:2/4:4:4, and decodes in software; play audio separately.
loopedboolean[optional] Whether the video should loop. Default is false.

Returns:

Return TypeDescription
VideoNode | nilThe created VideoNode instance. If creation fails, returns nil.