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.
CloseReturns whether the VideoPlayer has successfully prepared the content to be played.
A prepared VideoPlayer can play back the content instantly because preliminary parsing and buffering has been done.
A VideoPlayer starts out as not prepared (false
). To prepare the VideoPlayer, you need to use VideoPlayer.Prepare. When preparation is done, the VideoPlayer emits the VideoPlayer.prepareCompleted event, which sets isPrepared
to true
.
The property goes back to false
when you or the VideoPlayer calls VideoPlayer.Stop.
If there are preparation failures, this property might never be set to true
. In this case, Unity sends an error description through the VideoPlayer.errorReceived event.
Additional resources: VideoPlayer.Prepare.
using UnityEngine; using UnityEngine.Video; using System.Collections;
// In the Inspector of your GameObject, attach this script and a VideoPlayer component. // Also, assign a VideoClip to your VideoPlayer component. // Use this script to prepare a video.
public class IsPreparedExample : MonoBehaviour { public IEnumerator Start() { VideoPlayer videoPlayer = GetComponent<VideoPlayer>(); videoPlayer.Prepare(); // Loops until the video is ready. // Then outputs the message to the console when the preparation is done. while (!videoPlayer.isPrepared) { yield return null; } Debug.Log("Preparation completed!"); } }
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.