Show / Hide Table of Contents

Class VideoPlayer

Inheritance
Object
Object
Component
Behaviour
VideoPlayer
Inherited Members
Behaviour.enabled
Behaviour.isActiveAndEnabled
Component.transform
Component.gameObject
Component.GetComponent(Type)
Component.GetComponent<T>()
Component.GetComponent(String)
Component.GetComponentInChildren(Type, Boolean)
Component.GetComponentInChildren(Type)
Component.GetComponentInChildren<T>(Boolean)
Component.GetComponentInChildren<T>()
Component.GetComponentsInChildren(Type, Boolean)
Component.GetComponentsInChildren(Type)
Component.GetComponentsInChildren<T>(Boolean)
Component.GetComponentsInChildren<T>(Boolean, List<T>)
Component.GetComponentsInChildren<T>()
Component.GetComponentsInChildren<T>(List<T>)
Component.GetComponentInParent(Type)
Component.GetComponentInParent<T>()
Component.GetComponentsInParent(Type, Boolean)
Component.GetComponentsInParent(Type)
Component.GetComponentsInParent<T>(Boolean)
Component.GetComponentsInParent<T>(Boolean, List<T>)
Component.GetComponentsInParent<T>()
Component.GetComponents(Type)
Component.GetComponents(Type, List<Component>)
Component.GetComponents<T>(List<T>)
Component.tag
Component.GetComponents<T>()
Component.CompareTag(String)
Component.SendMessageUpwards(String, Object, SendMessageOptions)
Component.SendMessageUpwards(String, Object)
Component.SendMessageUpwards(String)
Component.SendMessageUpwards(String, SendMessageOptions)
Component.SendMessage(String, Object)
Component.SendMessage(String)
Component.SendMessage(String, Object, SendMessageOptions)
Component.SendMessage(String, SendMessageOptions)
Component.BroadcastMessage(String, Object, SendMessageOptions)
Component.BroadcastMessage(String, Object)
Component.BroadcastMessage(String)
Component.BroadcastMessage(String, SendMessageOptions)
Object.GetInstanceID()
Object.GetHashCode()
Object.Equals(Object)
Object.name
Object.Instantiate(Object, Vector3, Quaternion)
Object.Instantiate(Object, Vector3, Quaternion, Transform)
Object.Instantiate(Object)
Object.Instantiate(Object, Transform)
Object.Instantiate(Object, Transform, Boolean)
Object.Instantiate<T>(T)
Object.Instantiate<T>(T, Vector3, Quaternion)
Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
Object.Instantiate<T>(T, Transform)
Object.Instantiate<T>(T, Transform, Boolean)
Object.Destroy(Object, Single)
Object.Destroy(Object)
Object.DestroyImmediate(Object, Boolean)
Object.DestroyImmediate(Object)
Object.FindObjectsOfType(Type)
Object.DontDestroyOnLoad(Object)
Object.hideFlags
Object.DestroyObject(Object, Single)
Object.DestroyObject(Object)
Object.FindSceneObjectsOfType(Type)
Object.FindObjectsOfTypeIncludingAssets(Type)
Object.FindObjectsOfType<T>()
Object.FindObjectOfType<T>()
Object.FindObjectsOfTypeAll(Type)
Object.FindObjectOfType(Type)
Object.ToString()
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetType()
Object.MemberwiseClone()
Namespace: UnityEngine.Video
Assembly: UnityEngine.dll
Syntax
[RequireComponent(typeof(Transform))]
public sealed class VideoPlayer : Behaviour

Properties

aspectRatio

Declaration
public VideoAspectRatio aspectRatio { get; set; }
Property Value
Type Description
VideoAspectRatio

audioOutputMode

Declaration
public VideoAudioOutputMode audioOutputMode { get; set; }
Property Value
Type Description
VideoAudioOutputMode

audioTrackCount

Declaration
public ushort audioTrackCount { get; }
Property Value
Type Description
UInt16

canSetDirectAudioVolume

Declaration
public bool canSetDirectAudioVolume { get; }
Property Value
Type Description
Boolean

canSetPlaybackSpeed

Declaration
public bool canSetPlaybackSpeed { get; }
Property Value
Type Description
Boolean

canSetSkipOnDrop

Declaration
public bool canSetSkipOnDrop { get; }
Property Value
Type Description
Boolean

canSetTime

Declaration
public bool canSetTime { get; }
Property Value
Type Description
Boolean

canSetTimeSource

Declaration
public bool canSetTimeSource { get; }
Property Value
Type Description
Boolean

canStep

Declaration
public bool canStep { get; }
Property Value
Type Description
Boolean

clip

Declaration
public VideoClip clip { get; set; }
Property Value
Type Description
VideoClip

clockTime

Declaration
public double clockTime { get; }
Property Value
Type Description
Double
| Improve this Doc View Source

controlledAudioTrackCount

Declaration
public ushort controlledAudioTrackCount { get; set; }
Property Value
Type Description
UInt16

controlledAudioTrackMaxCount

Declaration
public static ushort controlledAudioTrackMaxCount { get; }
Property Value
Type Description
UInt16

externalReferenceTime

Declaration
public double externalReferenceTime { get; set; }
Property Value
Type Description
Double

frame

Declaration
public long frame { get; set; }
Property Value
Type Description
Int64

frameCount

Declaration
public ulong frameCount { get; }
Property Value
Type Description
UInt64

frameRate

Declaration
public float frameRate { get; }
Property Value
Type Description
Single

height

Declaration
public uint height { get; }
Property Value
Type Description
UInt32

isLooping

Declaration
public bool isLooping { get; set; }
Property Value
Type Description
Boolean

isPaused

Declaration
public bool isPaused { get; }
Property Value
Type Description
Boolean

isPlaying

Declaration
public bool isPlaying { get; }
Property Value
Type Description
Boolean

isPrepared

Declaration
public bool isPrepared { get; }
Property Value
Type Description
Boolean

length

Declaration
public double length { get; }
Property Value
Type Description
Double

pixelAspectRatioDenominator

Declaration
public uint pixelAspectRatioDenominator { get; }
Property Value
Type Description
UInt32

pixelAspectRatioNumerator

Declaration
public uint pixelAspectRatioNumerator { get; }
Property Value
Type Description
UInt32

playbackSpeed

Declaration
public float playbackSpeed { get; set; }
Property Value
Type Description
Single

playOnAwake

Declaration
public bool playOnAwake { get; set; }
Property Value
Type Description
Boolean

renderMode

Declaration
public VideoRenderMode renderMode { get; set; }
Property Value
Type Description
VideoRenderMode

sendFrameReadyEvents

Declaration
public bool sendFrameReadyEvents { get; set; }
Property Value
Type Description
Boolean

skipOnDrop

Declaration
public bool skipOnDrop { get; set; }
Property Value
Type Description
Boolean

source

Declaration
public VideoSource source { get; set; }
Property Value
Type Description
VideoSource

targetCamera

Declaration
public Camera targetCamera { get; set; }
Property Value
Type Description
Camera

targetCamera3DLayout

Declaration
public Video3DLayout targetCamera3DLayout { get; set; }
Property Value
Type Description
Video3DLayout

targetCameraAlpha

Declaration
public float targetCameraAlpha { get; set; }
Property Value
Type Description
Single

targetMaterialProperty

Declaration
public string targetMaterialProperty { get; set; }
Property Value
Type Description
String

targetMaterialRenderer

Declaration
public Renderer targetMaterialRenderer { get; set; }
Property Value
Type Description
Renderer

targetTexture

Declaration
public RenderTexture targetTexture { get; set; }
Property Value
Type Description
RenderTexture

texture

Declaration
public Texture texture { get; }
Property Value
Type Description
Texture

time

Declaration
public double time { get; set; }
Property Value
Type Description
Double

timeReference

Declaration
public VideoTimeReference timeReference { get; set; }
Property Value
Type Description
VideoTimeReference

timeSource

Declaration
public VideoTimeSource timeSource { get; set; }
Property Value
Type Description
VideoTimeSource

url

Declaration
public string url { get; set; }
Property Value
Type Description
String

waitForFirstFrame

Declaration
public bool waitForFirstFrame { get; set; }
Property Value
Type Description
Boolean

width

Declaration
public uint width { get; }
Property Value
Type Description
UInt32

Methods

EnableAudioTrack(UInt16, Boolean)

Declaration
public void EnableAudioTrack(ushort trackIndex, bool enabled)
Parameters
Type Name Description
UInt16 trackIndex
Boolean enabled

GetAudioChannelCount(UInt16)

Declaration
public ushort GetAudioChannelCount(ushort trackIndex)
Parameters
Type Name Description
UInt16 trackIndex
Returns
Type Description
UInt16

GetAudioLanguageCode(UInt16)

Declaration
public string GetAudioLanguageCode(ushort trackIndex)
Parameters
Type Name Description
UInt16 trackIndex
Returns
Type Description
String

GetAudioSampleRate(UInt16)

Declaration
public uint GetAudioSampleRate(ushort trackIndex)
Parameters
Type Name Description
UInt16 trackIndex
Returns
Type Description
UInt32

GetDirectAudioMute(UInt16)

Declaration
public bool GetDirectAudioMute(ushort trackIndex)
Parameters
Type Name Description
UInt16 trackIndex
Returns
Type Description
Boolean

GetDirectAudioVolume(UInt16)

Declaration
public float GetDirectAudioVolume(ushort trackIndex)
Parameters
Type Name Description
UInt16 trackIndex
Returns
Type Description
Single

GetTargetAudioSource(UInt16)

Declaration
public AudioSource GetTargetAudioSource(ushort trackIndex)
Parameters
Type Name Description
UInt16 trackIndex
Returns
Type Description
AudioSource

IsAudioTrackEnabled(UInt16)

Declaration
public bool IsAudioTrackEnabled(ushort trackIndex)
Parameters
Type Name Description
UInt16 trackIndex
Returns
Type Description
Boolean

Pause()

Declaration
public void Pause()

Play()

Declaration
public void Play()

Prepare()

Declaration
public void Prepare()

SetDirectAudioMute(UInt16, Boolean)

Declaration
public void SetDirectAudioMute(ushort trackIndex, bool mute)
Parameters
Type Name Description
UInt16 trackIndex
Boolean mute

SetDirectAudioVolume(UInt16, Single)

Declaration
public void SetDirectAudioVolume(ushort trackIndex, float volume)
Parameters
Type Name Description
UInt16 trackIndex
Single volume

SetTargetAudioSource(UInt16, AudioSource)

Declaration
public void SetTargetAudioSource(ushort trackIndex, AudioSource source)
Parameters
Type Name Description
UInt16 trackIndex
AudioSource source

StepForward()

Declaration
public void StepForward()

Stop()

Declaration
public void Stop()

Events

| Improve this Doc View Source

clockResyncOccurred

Declaration
public event VideoPlayer.TimeEventHandler clockResyncOccurred
Event Type
Type Description
VideoPlayer.TimeEventHandler
| Improve this Doc View Source

errorReceived

Declaration
public event VideoPlayer.ErrorEventHandler errorReceived
Event Type
Type Description
VideoPlayer.ErrorEventHandler
| Improve this Doc View Source

frameDropped

Declaration
public event VideoPlayer.EventHandler frameDropped
Event Type
Type Description
VideoPlayer.EventHandler
| Improve this Doc View Source

frameReady

Declaration
public event VideoPlayer.FrameReadyEventHandler frameReady
Event Type
Type Description
VideoPlayer.FrameReadyEventHandler
| Improve this Doc View Source

loopPointReached

Declaration
public event VideoPlayer.EventHandler loopPointReached
Event Type
Type Description
VideoPlayer.EventHandler
| Improve this Doc View Source

prepareCompleted

Declaration
public event VideoPlayer.EventHandler prepareCompleted
Event Type
Type Description
VideoPlayer.EventHandler
| Improve this Doc View Source

seekCompleted

Declaration
public event VideoPlayer.EventHandler seekCompleted
Event Type
Type Description
VideoPlayer.EventHandler
| Improve this Doc View Source

started

Declaration
public event VideoPlayer.EventHandler started
Event Type
Type Description
VideoPlayer.EventHandler

Extension Methods

VideoPlayerExtensions.GetAudioSampleProvider(VideoPlayer, UInt16)
MustExtensions.MustBeEqual<T>(T, T)
MustExtensions.MustBeEqual<T>(T, T, String)
MustExtensions.MustNotBeEqual<T>(T, T)
MustExtensions.MustNotBeEqual<T>(T, T, String)
MustExtensions.MustBeNull<T>(T)
MustExtensions.MustBeNull<T>(T, String)
MustExtensions.MustNotBeNull<T>(T)
MustExtensions.MustNotBeNull<T>(T, String)
  • Improve this Doc
  • View Source
Back to top Generated by DocFX