Version: 2021.2
LanguageEnglish
  • C#

VideoClip

class in UnityEngine.Video

/

Inherits from:Object

/

Implemented in:UnityEngine.VideoModule

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

A container for video data.

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.

Properties

audioTrackCountNumber of audio tracks in the clip.
frameCountThe length of the VideoClip in frames. (Read Only).
frameRateThe frame rate of the clip in frames/second. (Read Only).
heightThe height of the images in the video clip in pixels. (Read Only).
lengthThe length of the video clip in seconds. (Read Only).
originalPathThe video clip path in the project's assets. (Read Only).
pixelAspectRatioDenominatorDenominator of the pixel aspect ratio (num:den). (Read Only).
pixelAspectRatioNumeratorNumerator of the pixel aspect ratio (num:den). (Read Only).
sRGBWhether the imported clip contains sRGB color data (Read Only).
widthThe width of the images in the video clip in pixels. (Read Only).

Public Methods

GetAudioChannelCountThe number of channels in the audio track. E.g. 2 for a stereo track.
GetAudioLanguageGet the audio track language. Can be unknown.
GetAudioSampleRateGet the audio track sampling rate in Hertz.

Inherited Members

Properties

hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
nameThe name of the object.

Public Methods

GetInstanceIDGets the instance ID of the object.
ToStringReturns the name of the object.

Static Methods

DestroyRemoves a GameObject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsOfTypeGets a list of all loaded objects of Type type.
InstantiateClones the object original and returns the clone.

Operators

boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.