Legacy Documentation: Version 2018.2 (Go to current version)
LanguageEnglish
  • C#

VideoPlayer.isPrepared

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

public bool isPrepared;

Description

Whether the VideoPlayer has successfully prepared the content to be played. (Read Only)

A prepared VideoPlayer can start playing back the associated content instantly, as opposed to the normal delay incurred by starting playback from scratch, which involves acquiring the playback resources and pre-loading some or all of the content.

A VideoPlayer starts out as not prepared (false) and becomes prepared (true) once VideoPlayer.Prepare has been invoked and the VideoPlayer.prepareCompleted event has been emitted. The property goes back to false when VideoPlayer.Stop is invoked.

Preparation failures may lead to this property never becoming true. In this case an error description will be sent through the VideoPlayer.errorReceived event.

Did you find this page useful? Please give it a rating: