VRC SDK
This project aims to completely document the VRChat Unity SDK
Loading...
Searching...
No Matches
VRC.SDK3.Video.Components.VRCUnityVideoPlayer Class Reference
Inheritance diagram for VRC.SDK3.Video.Components.VRCUnityVideoPlayer:
Collaboration diagram for VRC.SDK3.Video.Components.VRCUnityVideoPlayer:

Public Member Functions

override void LoadURL (VRCUrl url)
 
override void PlayURL (VRCUrl url)
 
override void Pause ()
 
override void Play ()
 
override float GetDuration ()
 
override float GetTime ()
 
override void SetTime (float value)
 
override void Stop ()
 
- Public Member Functions inherited from VRC.SDK3.Video.Components.Base.BaseVRCVideoPlayer
void SetIndexMarker (float desiredTime)
 
void SetIndexMarker ()
 
virtual void PlayURL (VRCUrl url)
 
virtual void Play ()
 
virtual void SetTime (float value)
 
abstract void LoadURL (VRCUrl url)
 
abstract void Pause ()
 
abstract void Stop ()
 
abstract float GetTime ()
 
abstract float GetDuration ()
 
void OnVideoReady ()
 
void OnVideoError (VideoError videoError)
 
void OnVideoStart ()
 
void OnVideoLoop ()
 
void OnVideoEnd ()
 
void LoadURL (VRCUrl url)
 
void PlayURL (VRCUrl url)
 
void Play ()
 
void Pause ()
 
void Stop ()
 
void SetTime (float value)
 
float GetTime ()
 
float GetDuration ()
 
void OnVideoReady ()
 
void OnVideoError (VideoError videoError)
 
void OnVideoStart ()
 
void OnVideoLoop ()
 
void OnVideoEnd ()
 

Protected Member Functions

override void Start ()
 
virtual void Start ()
 

Properties

static Action< VRCUrl, int, Object, Action< string >, Action< VideoError > > StartResolveURLCoroutine [get, set]
 
VideoPlayer UnityPlayer [get]
 
override bool IsPlaying [get]
 
override bool IsReady [get]
 
override bool Loop [get, set]
 
override int VideoWidth [get]
 
override int VideoHeight [get]
 
- Properties inherited from VRC.SDK3.Video.Components.Base.BaseVRCVideoPlayer
static Action< BaseVRCVideoPlayerInitializeBase [get, set]
 
float SyncIndexTimeSet [get, private set]
 
float SyncIndexPosition [get, private set]
 
abstract bool Loop [get, set]
 
abstract bool IsPlaying [get]
 
abstract bool IsReady [get]
 
abstract int VideoWidth [get]
 
abstract int VideoHeight [get]
 
- Properties inherited from VRC.SDK3.Video.Interfaces.IVRCVideoPlayer
bool Loop [get, set]
 
bool IsPlaying [get]
 
bool IsReady [get]
 
int VideoWidth [get]
 
int VideoHeight [get]
 

Private Types

enum  VideoRenderMode : Enum
 

Private Member Functions

void PlayDefaultVideo ()
 
void SetupVideoPlayer ()
 
IEnumerator PlayDelayCoroutine ()
 
void OnPrepared (VideoPlayer source)
 
IEnumerator OnVideoReadyDelayCoroutine ()
 
void OnError (VideoPlayer source, string message)
 
void OnStarted (VideoPlayer source)
 
void OnLoopPointReached (VideoPlayer source)
 

Private Attributes

VRCUrl videoURL
 
bool autoPlay = true
 
bool loop = true
 
VideoRenderMode renderMode
 
RenderTexture targetTexture
 
Renderer targetMaterialRenderer
 
string targetMaterialProperty
 
VideoAspectRatio aspectRatio = (VideoAspectRatio)2
 
AudioSource[] targetAudioSources = Array.Empty<AudioSource>()
 
int maximumResolution = 720
 

Additional Inherited Members

- Public Attributes inherited from VRC.SDK3.Video.Components.Base.BaseVRCVideoPlayer
bool EnableAutomaticResync
 

Detailed Description

Definition at line 435 of file VRCSDK3.cs.

Member Enumeration Documentation

◆ VideoRenderMode

Definition at line 437 of file VRCSDK3.cs.

Member Function Documentation

◆ GetDuration()

override float VRC.SDK3.Video.Components.VRCUnityVideoPlayer.GetDuration ( )
virtual

Implements VRC.SDK3.Video.Components.Base.BaseVRCVideoPlayer.

Definition at line 670 of file VRCSDK3.cs.

◆ GetTime()

override float VRC.SDK3.Video.Components.VRCUnityVideoPlayer.GetTime ( )
virtual

Implements VRC.SDK3.Video.Components.Base.BaseVRCVideoPlayer.

Definition at line 675 of file VRCSDK3.cs.

◆ LoadURL()

override void VRC.SDK3.Video.Components.VRCUnityVideoPlayer.LoadURL ( VRCUrl  url)
virtual

Implements VRC.SDK3.Video.Components.Base.BaseVRCVideoPlayer.

Definition at line 598 of file VRCSDK3.cs.

Here is the call graph for this function:

◆ OnError()

void VRC.SDK3.Video.Components.VRCUnityVideoPlayer.OnError ( VideoPlayer  source,
string  message 
)
private

Definition at line 713 of file VRCSDK3.cs.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ OnLoopPointReached()

void VRC.SDK3.Video.Components.VRCUnityVideoPlayer.OnLoopPointReached ( VideoPlayer  source)
private

Definition at line 730 of file VRCSDK3.cs.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ OnPrepared()

void VRC.SDK3.Video.Components.VRCUnityVideoPlayer.OnPrepared ( VideoPlayer  source)
private

Definition at line 691 of file VRCSDK3.cs.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ OnStarted()

void VRC.SDK3.Video.Components.VRCUnityVideoPlayer.OnStarted ( VideoPlayer  source)
private

Definition at line 719 of file VRCSDK3.cs.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ OnVideoReadyDelayCoroutine()

IEnumerator VRC.SDK3.Video.Components.VRCUnityVideoPlayer.OnVideoReadyDelayCoroutine ( )
private

Definition at line 706 of file VRCSDK3.cs.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Pause()

override void VRC.SDK3.Video.Components.VRCUnityVideoPlayer.Pause ( )
virtual

Implements VRC.SDK3.Video.Components.Base.BaseVRCVideoPlayer.

Definition at line 635 of file VRCSDK3.cs.

◆ Play()

override void VRC.SDK3.Video.Components.VRCUnityVideoPlayer.Play ( )
virtual

Reimplemented from VRC.SDK3.Video.Components.Base.BaseVRCVideoPlayer.

Definition at line 640 of file VRCSDK3.cs.

Here is the call graph for this function:

◆ PlayDefaultVideo()

void VRC.SDK3.Video.Components.VRCUnityVideoPlayer.PlayDefaultVideo ( )
private

Definition at line 535 of file VRCSDK3.cs.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ PlayDelayCoroutine()

IEnumerator VRC.SDK3.Video.Components.VRCUnityVideoPlayer.PlayDelayCoroutine ( )
private

Definition at line 651 of file VRCSDK3.cs.

Here is the caller graph for this function:

◆ PlayURL()

override void VRC.SDK3.Video.Components.VRCUnityVideoPlayer.PlayURL ( VRCUrl  url)
virtual

Reimplemented from VRC.SDK3.Video.Components.Base.BaseVRCVideoPlayer.

Definition at line 616 of file VRCSDK3.cs.

Here is the call graph for this function:

◆ SetTime()

override void VRC.SDK3.Video.Components.VRCUnityVideoPlayer.SetTime ( float  value)
virtual

Reimplemented from VRC.SDK3.Video.Components.Base.BaseVRCVideoPlayer.

Definition at line 680 of file VRCSDK3.cs.

◆ SetupVideoPlayer()

void VRC.SDK3.Video.Components.VRCUnityVideoPlayer.SetupVideoPlayer ( )
private

Definition at line 555 of file VRCSDK3.cs.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Start()

override void VRC.SDK3.Video.Components.VRCUnityVideoPlayer.Start ( )
protectedvirtual

Reimplemented from VRC.SDK3.Video.Components.Base.BaseVRCVideoPlayer.

Definition at line 528 of file VRCSDK3.cs.

Here is the call graph for this function:

◆ Stop()

override void VRC.SDK3.Video.Components.VRCUnityVideoPlayer.Stop ( )
virtual

Implements VRC.SDK3.Video.Components.Base.BaseVRCVideoPlayer.

Definition at line 686 of file VRCSDK3.cs.

Member Data Documentation

◆ aspectRatio

VideoAspectRatio VRC.SDK3.Video.Components.VRCUnityVideoPlayer.aspectRatio = (VideoAspectRatio)2
private

Definition at line 465 of file VRCSDK3.cs.

◆ autoPlay

bool VRC.SDK3.Video.Components.VRCUnityVideoPlayer.autoPlay = true
private

Definition at line 447 of file VRCSDK3.cs.

◆ loop

bool VRC.SDK3.Video.Components.VRCUnityVideoPlayer.loop = true
private

Definition at line 450 of file VRCSDK3.cs.

◆ maximumResolution

int VRC.SDK3.Video.Components.VRCUnityVideoPlayer.maximumResolution = 720
private

Definition at line 472 of file VRCSDK3.cs.

◆ renderMode

VideoRenderMode VRC.SDK3.Video.Components.VRCUnityVideoPlayer.renderMode
private

Definition at line 453 of file VRCSDK3.cs.

◆ targetAudioSources

AudioSource [] VRC.SDK3.Video.Components.VRCUnityVideoPlayer.targetAudioSources = Array.Empty<AudioSource>()
private

Definition at line 468 of file VRCSDK3.cs.

◆ targetMaterialProperty

string VRC.SDK3.Video.Components.VRCUnityVideoPlayer.targetMaterialProperty
private

Definition at line 462 of file VRCSDK3.cs.

◆ targetMaterialRenderer

Renderer VRC.SDK3.Video.Components.VRCUnityVideoPlayer.targetMaterialRenderer
private

Definition at line 459 of file VRCSDK3.cs.

◆ targetTexture

RenderTexture VRC.SDK3.Video.Components.VRCUnityVideoPlayer.targetTexture
private

Definition at line 456 of file VRCSDK3.cs.

◆ videoURL

VRCUrl VRC.SDK3.Video.Components.VRCUnityVideoPlayer.videoURL
private

Definition at line 444 of file VRCSDK3.cs.

Property Documentation

◆ IsPlaying

override bool VRC.SDK3.Video.Components.VRCUnityVideoPlayer.IsPlaying
get

Implements VRC.SDK3.Video.Interfaces.IVRCVideoPlayer.

Definition at line 506 of file VRCSDK3.cs.

◆ IsReady

override bool VRC.SDK3.Video.Components.VRCUnityVideoPlayer.IsReady
get

Implements VRC.SDK3.Video.Interfaces.IVRCVideoPlayer.

Definition at line 508 of file VRCSDK3.cs.

◆ Loop

override bool VRC.SDK3.Video.Components.VRCUnityVideoPlayer.Loop
getset

Implements VRC.SDK3.Video.Interfaces.IVRCVideoPlayer.

Definition at line 510 of file VRCSDK3.cs.

◆ StartResolveURLCoroutine

Action<VRCUrl, int, Object, Action<string>, Action<VideoError> > VRC.SDK3.Video.Components.VRCUnityVideoPlayer.StartResolveURLCoroutine
staticgetset

Definition at line 485 of file VRCSDK3.cs.

◆ UnityPlayer

VideoPlayer VRC.SDK3.Video.Components.VRCUnityVideoPlayer.UnityPlayer
get

Definition at line 494 of file VRCSDK3.cs.

◆ VideoHeight

override int VRC.SDK3.Video.Components.VRCUnityVideoPlayer.VideoHeight
get

Implements VRC.SDK3.Video.Interfaces.IVRCVideoPlayer.

Definition at line 526 of file VRCSDK3.cs.

◆ VideoWidth

override int VRC.SDK3.Video.Components.VRCUnityVideoPlayer.VideoWidth
get

Implements VRC.SDK3.Video.Interfaces.IVRCVideoPlayer.

Definition at line 523 of file VRCSDK3.cs.


The documentation for this class was generated from the following file: