VideoClip

Info

VideoClip inherits from [Object](/docs/create/lua/API/Object/index.html)

A container for video data.

Members

Properties

Name	Description
VideoClip.audioTrackCount	Number of audio tracks in the clip.
VideoClip.frameCount	The length of the VideoClip in frames. (Read Only).
VideoClip.frameRate	The frame rate of the clip in frames/second. (Read Only).
VideoClip.height	The height of the images in the video clip in pixels. (Read Only).
VideoClip.length	The length of the video clip in seconds. (Read Only).
VideoClip.originalPath	The video clip path in the project's assets. (Read Only).
VideoClip.pixelAspectRatioDenominator	Denominator of the pixel aspect ratio (num:den). (Read Only).
VideoClip.sRGB	Whether the imported clip contains sRGB color data (Read Only).
VideoClip.width	The width of the images in the video clip in pixels. (Read Only).

Methods

Name	Description
VideoClip.GetAudioChannelCount(audioTrackIdx)	The number of channels in the audio track. E.g. 2 for a stereo track.
VideoClip.GetAudioLanguage(audioTrackIdx)	Get the audio track language. Can be unknown.
VideoClip.GetAudioSampleRate(audioTrackIdx)	Get the audio track sampling rate in Hertz.

Inherited Members

Inherited Properties

Name	Description
VideoClip.hideFlags	Should the object be hidden, saved with the Scene or modifiable by the user?
VideoClip.name	The name of the object.

Inherited Methods

Name	Description
VideoClip.GetInstanceID()	Returns the instance id of the object.

Extra Detail

A VideoClip stores the video portion of a movie file using a codec that is appropriate for the target platform. VideoClips are referenced by VideoPlayers to play videos.