This section describes the different time update modes available for the Video Player component and how it interacts with them.
You can use the Video Player component to control how to time video playback relative to other interactive behaviors. For example, you can synchronize video playback with animation or with audio. You can do this through the following time update modes:
The Video Player follows Unity’s capture frame rate (Time.captureFramerate) and capture delta time (Time.captureDeltaTime).
When you specify a capture frame rate, a Video Player’s playback becomes synchronous, which means the Video Player displays all frames at the expected time stamp even if it has to delay the overall game execution. Another advantage of the capture frame rate is that, it also blocks preparation and seek operations, which leads to consistent and accurate results. However, this might slow down game execution especially when the video must remain synchronized with the rest of the sceneA Scene contains the environments and menus of your game. Think of each unique Scene file as a unique level. In each Scene, you place your environments, obstacles, and decorations, essentially designing and building your game in pieces. More info
See in Glossary. For example, Unity Recorder uses this special behavior of time to produce smooth recordings.
The capture frame rate only affects game time. If a Video Player uses unscaled game time or audio DSP clock while capture frame rate is in use, the Video Player ignores the capture frame rate and uses asynchronous playback. That means, the Video Player skips or repeats frames if needed, and preparation or seek tasks are asynchronous to prevent blocking of playback. However, this only happens if you select game time as the time update mode for Video Player.
Note: On WebGLA JavaScript API that renders 2D and 3D graphics in a web browser. The Unity WebGL build option allows Unity to publish content as JavaScript programs which use HTML5 technologies and the WebGL rendering API to run Unity content in a web browser. More info
See in Glossary, Unity’s Video Player doesn’t support synchronous playback with captureFramerate. By default, it uses the normal asynchronous playback that’s described with the Game time update mode.
The audio DSP clock comes from the Audio module. You can access it through AudioSettings.dspTime.
Game time is set in the Time module. You can access it using C# through Time.time. When you use game time, also known as scaled game time, Unity follows the Time Scale value set in the Time window. You can also modify the Time Scale value using C# through Time.timeScale. However, if the capture frame rate or capture delta time have non-zero values, game time changes according to the rules that govern the time managerA Unity Settings Manager that lets you set a number of properties that control timing within your game. More info
See in Glossary’s capture frame rate feature.
Note: Capture delta time is the same as 1 divided by the capture frame rate. It’s another view of the same information.
When you use Unscaled game time, the Video Player ignores the Time Scale value. Unscaled game time comes from the Time module. You can access it using C# through Time.unscaledTime.