Unity 6.3
0 онлайн 2 гостей 3 в системе
Вход

VideoPlayer

класс в UnityEngine.Video

Наследуется от:Behaviour

Выполнено в:UnityEngine.VideoModule

Описание

Проигрывание видеоконтента на конечном объекте.

Содержимое может быть либо VideoClip импортированным ассетом, либо URL, таким как file:// или http://. Видеоконтент будет проецироваться на один из поддерживаемых объектов, таких как фон камеры или RenderTexture. Если видеоконтент содержит прозрачность, эта прозрачность будет присутствовать в объекте, позволяя видеть объекты за видеоцелевым объектом. Когда данные VideoPlayer.source установлены на URL, аудио- и видеоописания воспроизводимого будут инициализированы только после завершения подготовки VideoPlayer. Вы можете проверить это с помощью VideoPlayer.isPrepared.

См. Совместимость видеофайлов для получения дополнительной информации о поддерживаемых форматах видеофайлов.

Ниже приведены некоторые особенности VideoPlayer:

// Examples of VideoPlayer function

using UnityEngine; using UnityEngine.Video;

public class Example : MonoBehaviour { void Start() { // Will attach a VideoPlayer to the main camera. GameObject camera = GameObject.Find("Main Camera");

// VideoPlayer automatically targets the camera backplane when it is added // to a camera object, no need to change videoPlayer.targetCamera. var videoPlayer = camera.AddComponent<UnityEngine.Video.VideoPlayer>();

// Play on awake defaults to true. Set it to false to avoid the url set // below to auto-start playback since we're in Start(). videoPlayer.playOnAwake = false;

// By default, VideoPlayers added to a camera will use the far plane. // Let's target the near plane instead. videoPlayer.renderMode = UnityEngine.Video.VideoRenderMode.CameraNearPlane;

// This will cause our Scene to be visible through the video being played. videoPlayer.targetCameraAlpha = 0.5F;

// Set the video to play. URL supports local absolute or relative paths. // Here, using absolute. videoPlayer.url = "/Users/graham/movie.mov";

// Skip the first 100 frames. videoPlayer.frame = 100;

// Restart from beginning when done. videoPlayer.isLooping = true;

// Each time we reach the end, we slow down the playback by a factor of 10. videoPlayer.loopPointReached += EndReached;

// Start playback. This means the VideoPlayer may have to prepare (reserve // resources, pre-load a few frames, etc.). To better control the delays // associated with this preparation one can use videoPlayer.Prepare() along with // its prepareCompleted event. videoPlayer.Play(); }

void EndReached(UnityEngine.Video.VideoPlayer vp) { vp.playbackSpeed = vp.playbackSpeed / 10.0F; } }

Статические свойства

Свойство Описание
controlledAudioTrackMaxCountМаксимальное число аудиотреков, которые могут быть управляемыми. (только для чтения)

Свойства

Свойство Описание
aspectRatioОпределяет, как содержимое видео будет растянуто, чтобы заполнить целевую область.
audioOutputModeМесто назначения для аудио, встроенного в видео.
audioTrackCountЧисло аудиотреков, найденных в текущем настроенном источнике данных. (только для чтения)
canSetDirectAudioVolumeПоддерживаются ли регуляторы громкости прямого выхода для текущей платформы и формата видео. (только для чтения)
canSetPlaybackSpeedМожно ли изменить скорость воспроизведения. (только для чтения)
canSetSkipOnDropМожно ли управлять пропусками кадров для поддержания синхронизации. (только для чтения)
canSetTimeМожно ли изменить текущее время с помощью свойств VideoPlayer.time или VideoPlayer.frame. (Только для чтения)
canSetTimeUpdateModeМожно ли изменить источник времени, за которым следует VideoPlayer. (только для чтения)
canStepВозвращает true, если VideoPlayer может продвигаться вперед по видеоконтенту. (только для чтения)
clipКлип воспроизводится VideoPlayer.
clockTimeВремя, которое VideoPlayer использует для расписания своих проб. Время выражено в секундах. (Только для чтения)
controlledAudioTrackCountЧисло аудио треков, которые будет контролировать этот VideoPlayer.
externalReferenceTimeРеферентное время внешних часов, используемых VideoPlayer для коррекции своего дрейфа.
frameИндекс кадра текущего доступного кадра в VideoPlayer.texture.
frameCountКоличество кадров в текущем видеоконтенте. (только для чтения)
frameRateЧастота кадров клипа или URL в кадрах в секунду. (только для чтения)
heightВысота изображений в VideoClip или URL в пикселях. (только для чтения)
isLoopingОпределяет, перезапускается ли VideoPlayer с начала, когда он достигает конца клипа.
isPausedПриостановлено ли воспроизведение. (только для чтения)
isPlayingВозвращает информацию о том, воспроизводит ли VideoPlayer содержимое в данный момент.
isPreparedВозвращает, успешно ли VideoPlayer подготовил контент для воспроизведения.
lengthДлина VideoClip или URL в секундах. (только для чтения)
pixelAspectRatioDenominatorЗнаменатель соотношения сторон пикселей (num:den) для VideoClip или URL. (только для чтения)
pixelAspectRatioNumeratorЧиситель соотношения сторон пикселей (num:den) для VideoClip или URL. (только для чтения)
playbackSpeedКоэффициент, на который будет умножена базовая скорость воспроизведения.
playOnAwakeНачинается ли воспроизведение содержимого сразу же после пробуждения компонента.
renderModeГде будет рисоваться видеоконтент.
sendFrameReadyEventsВключает события frameReady.
skipOnDropРазрешено ли VideoPlayer пропускать кадры, чтобы догнать текущее время.
sourceИсточник, который VideoPlayer использует для воспроизведения.
targetCameraКомпонент Camera для рисования, когда VideoPlayer.renderMode установлен на VideoRenderMode.CameraFarPlane или VideoRenderMode.CameraNearPlane.
targetCamera3DLayoutТип контента 3D, содержащегося в исходном видеоматериале.
targetCameraAlphaОбщий уровень прозрачности видео в целевой камере.
targetMaterialPropertyСвойство текстуры материала, которое используется, когда VideoPlayer.renderMode установлено на Video.VideoTarget.MaterialOverride.
targetMaterialRendererРендерер, который используется, когда VideoPlayer.renderMode установлен на Video.VideoTarget.MaterialOverride
targetTextureRenderTexture для рисования, когда VideoPlayer.renderMode установлен на VideoRenderMode.RenderTexture.
textureВнутренняя текстура, в которую помещается видеоконтент. (только для чтения)
timeВремя представления текущего доступного кадра в VideoPlayer.texture в секундах.
timeReferenceЧасы, которые VideoPlayer наблюдает для обнаружения и корректировки дрейфа.
timeUpdateModeИсточник часов, используемый VideoPlayer для получения текущего времени.
urlФайл URL или веб URL, из которого VideoPlayer читает содержимое.
waitForFirstFrameОпределяет, будет ли VideoPlayer ждать, пока первый кадр будет загружен в текстуру, прежде чем начать воспроизведение, когда VideoPlayer.playOnAwake включен.
widthШирина изображений в VideoClip или URL в пикселях. (только для чтения)

Открытые методы

Метод Описание
EnableAudioTrackВключить/выключить декодирование аудиотрека. Действует только когда VideoPlayer не играет в данный момент.
GetAudioChannelCountКоличество аудиоканалов в указанной аудиодорожке.
GetAudioLanguageCodeВозвращает код языка, если таковой имеется, для указанной дорожки.
GetAudioSampleRateПолучает частоту дискретизации аудиотрека в Герцах.
GetDirectAudioMuteПолучить состояние выключения звука прямого выхода для указанной дорожки.
GetDirectAudioVolumeВозвращает громкость прямого выхода для указанной дорожки.
GetTargetAudioSourceПолучает AudioSource, который будет получать аудиосемплы для указанной дорожки, если VideoPlayer.audioOutputMode установлен на VideoAudioOutputMode.AudioSource.
IsAudioTrackEnabledВключено ли декодирование для указанной аудиодорожки. См. VideoPlayer.EnableAudioTrack для отличия от mute.
PauseПриостанавливает воспроизведение и оставляет текущее время неизменным.
PlayЗапускает или возобновляет воспроизведение видео.
PrepareПодготавливает движок воспроизведения, чтобы он был готов к воспроизведению.
SetDirectAudioMuteУстанавливает состояние заглушения прямого аудиовывода для указанной дорожки.
SetDirectAudioVolumeУстанавливает громкость прямого аудиовывода для указанной дорожки.
SetTargetAudioSourceУстанавливает AudioSource, который будет получать аудио-семплы для указанной дорожки, если эта аудио-целя выбрана с помощью VideoPlayer.audioOutputMode.
StepForwardНемедленно перенести текущее время на один кадр вперед.
StopОстанавливает воспроизведение и устанавливает текущее время в 0.

Мероприятия

Мероприятие Описание
clockResyncOccurredВызывается, когда часы VideoPlayer синхронизируются с VideoTimeReference.
errorReceivedVideoPlayer использует этот обратный вызов для сообщения о различных типах ошибок.
frameDroppedВызывается, когда видеодекодер не производит кадр согласно источнику времени во время воспроизведения.
frameReadyVideoPlayer вызывает это событие, когда новый кадр готов для отображения.
loopPointReachedVideoPlayer отправляет это событие, когда видео достигает конца своего проигрывания.
prepareCompletedVideoPlayer вызывает это событие, когда видео готово для воспроизведения.
seekCompletedВызов после завершения поиска.
startedVideoPlayer отправляет это событие, когда видео начинает воспроизводиться.

Делегаты

делегат Описание
ErrorEventHandlerТип делегирования для событий VideoPlayer, содержащих сообщение об ошибке.
EventHandlerТип делегирования для всех событий без параметров, выданных VideoPlayers.
FrameReadyEventHandlerТип делегирования для событий VideoPlayer, которые несут номер кадра.
TimeEventHandlerТип делегирования для событий VideoPlayer, которые несут позицию времени.
Унаследованные члены 4

Свойства

СвойствоОписание
enabledTrue, если это Поведение включено, в противном случае false.
isActiveAndEnabledПроверяет, включён ли компонент, прикреплен ли он к GameObject, который активен в иерархии, и вызван ли OnEnable компонента.
gameObjectGameObject, к которому прикреплен данный компонент. Компонент всегда прикрепляется к игровому объекту.
tagТег этого игрового объекта.
transformTransform прикреплен к этому GameObject.
transformHandleTransformHandle этого GameObject.
hideFlagsДолжен ли объект быть скрытым, сохраняться с Scene или изменяться пользователем?
nameИмя объекта.

Открытые методы

МетодОписание
BroadcastMessageВызывает метод с именем methodName на каждом MonoBehaviour в этом игровом объекте или любом из его дочерей.
CompareTagПроверяет тег GameObject на соответствие определенному тегу.
GetComponentПолучает ссылку на компонент типа T на том же GameObject, что и указанный компонент.
GetComponentInChildrenПолучает ссылку на компонент типа T на том же GameObject, что и указанный компонент, или на любого ребенка GameObject.
GetComponentIndexПолучает индекс компонента на его родительском GameObject.
GetComponentInParentПолучает ссылку на компонент типа T на том же GameObject, что и указанный компонент, или на любой родитель GameObject.
GetComponentsПолучает ссылки на все компоненты типа T на том же GameObject, что и указанный компонент.
GetComponentsInChildrenПолучает ссылки на все компоненты типа T на том же GameObject, что и указанный компонент, и на любого ребенка GameObject.
GetComponentsInParentПолучает ссылки на все компоненты типа T на том же GameObject, что и указанный компонент, и любой родитель GameObject.
SendMessageВызывает метод с именем methodName на каждом MonoBehaviour в этом игровом объекте.
SendMessageUpwardsВызывает метод с именем methodName на каждом MonoBehaviour в этом игровом объекте и на каждом предшественнике поведения.
TryGetComponentПолучает компонент указанного типа, если он существует.
GetInstanceIDПолучает экземпляр ID объекта.
ToStringВозвращает имя объекта.

Статические методы

МетодОписание
DestroyУдаляет GameObject, компонент или ресурс.
DestroyImmediateНемедленно уничтожает указанный объект. Используйте с осторожностью и только в режиме редактирования.
DontDestroyOnLoadНе уничтожать целевой Объект при загрузке нового Scene.
FindAnyObjectByTypeПолучает любой активный загруженный объект типа Type.
FindFirstObjectByTypeПолучает первый активный загруженный объект типа Type.
FindObjectsByTypeПолучает список всех загруженных объектов типа Type.
InstantiateКлонирует исходный объект и возвращает клон.
InstantiateAsyncЗахватывает моментальный снимок первоначального объекта (который должен быть связан с каким-либо GameObject) и возвращает AsyncInstantiateOperation.

Операторы

ОператорОписание
boolСуществует ли объект?
оператор!=Сравнивает, если два объекта ссылаются на разные объекты.
оператор ==Сравнение двух ссылок на объекты для определения того, относятся ли они к одному и тому же объекту.