VideoClip
A container for video assets that can be used in the Vide.VideoPlayer component.
Read time 5 minutesLast updated 8 days ago
Definition
- Type: Class
- Namespace: UnityEngine.Video
- Assembly: UnityEngine.VideoModule
- Inherits from: Object
public sealed class VideoClip : Object
Remarks
A VideoClip stores the video portion of a movie file using a codec that is appropriate for the target platform. The VideoPlayer class references VideoClips.
The following example shows how to assign a video clip to a video player and play it.
Additional Resources: VideoPlayer, class-VideoClip.
Examples
using UnityEngine;using UnityEngine.Video;public class PlayClip : MonoBehaviour{ public VideoClip myVideoClip; public VideoPlayer videoPlayer; void Start() { // Assign the clip to the player videoPlayer.clip = myVideoClip; // Optionally configure video player settings videoPlayer.Play(); }}
Properties
Property | Description |
|---|---|
| audioTrackCount | Gets the number of audio tracks that are embedded in the video clip. (Read Only). |
| frameCount | The length of the video clip in frames. (Read Only). |
| frameRate | The frame rate of the clip in frames per second. (Read Only). |
| height | The height of the images in the video clip in pixels. (Read Only). |
| length | The length of the video clip in seconds. (Read Only). |
| originalPath | Gets the original video clip file path as it was imported into Unity. (Read Only). |
| pixelAspectRatioDenominator | Returns the denominator of the pixel aspect ratio (numerator:denominator). (Read Only). |
| pixelAspectRatioNumerator | Returns the numerator of the pixel aspect ratio (numerator:denominator). (Read Only). |
| sRGB | Whether the imported clip contains sRGB color data (Read Only). |
| width | The width of the images in the video clip in pixels. (Read Only). |
Methods
Method | Description |
|---|---|
| GetAudioChannelCount | Returns the number of channels in the audio track. For example, if the audio track is a stereo track, this function returns 2. |
| GetAudioLanguage | Gets the language of the video clip’s audio tracks, if the audio tracks have an assigned language. |
| GetAudioSampleRate | Get the audio track sampling rate in hertz (Hz). |
Inheritance
Operators
Operator | Description |
|---|---|
| operator == | Compares two object references to see if they refer to the same object. |
| bool | Determines whether the object exists. |
| operator != | Compares if two objects refer to a different object. |