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.
CloseFor 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.
Closevalue | The instance of the VideoPlayer that invoked the event. |
The VideoPlayer invokes this event when the video is ready for playback.
The VideoPlayer uses VideoPlayer.Prepare to ready a video for playback. When the preparation finishes, the VideoPlayer invokes this callback. If you start playback after this callback is invoked, frames become available instantly.
If you call VideoPlayer.Play without using VideoPlayer.Prepare first, the VideoPlayer invokes Prepare()
anyway. If preparation succeeds, the VideoPlayer still invokes this event.
Additional resources: VideoPlayer.Prepare, EventHandler.
// In this script, you can only interact with the button to play the video after the VideoPlayer // finishes its preparation of the video. To start the preparation process, press Spacebar in Play mode.
// Attach this script to the GameObject you want to play a video clip on. // Attach a VideoPlayer component with a video clip and assign a Button in the Inspector.
using UnityEngine; using UnityEngine.UI; using UnityEngine.Video;
public class PrepareExample: MonoBehaviour { VideoPlayer videoPlayer; public Button playButton;
private void Awake() { // Get the VideoPlayer component from GameObject with this script attached. videoPlayer = GetComponent<VideoPlayer>(); // Attach the event handler, which triggers when the VideoPlayer finishes its preparation. videoPlayer.prepareCompleted += OnPrepareCompleted; videoPlayer.playOnAwake = false; playButton.interactable = false; }
// Event handler for when VideoPlayer finishes the preparation process. void OnPrepareCompleted(VideoPlayer vp) { Debug.Log("Preparation complete. You can now play the video."); // Preparation is complete so allow interactions with the play button. playButton.interactable = true; playButton.onClick.AddListener(OnPlayButtonClicked); }
void OnPlayButtonClicked() { // If the play button is clicked and the preparation is done, play the video. if (videoPlayer.isPrepared) { videoPlayer.Play(); } }
private void Update() { // Press Spacebar to prepare the video. if (Input.GetKeyDown("space")) { if (!videoPlayer.isPrepared) { videoPlayer.Prepare(); } } } }
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.