VRChat

The VRChat Documentation Hub

Welcome to the VRChat Documentation hub. You'll find comprehensive guides and documentation to help you start working with VRChat as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

VRC_SyncVideoPlayer

Sync Video Player has various features, including:

  • Allows a Video Player to be synced with others in the instance
  • Allows playlists
  • Accepts YouTube, Vimeo, and DailyMotion URLs

VRChat on Oculus Quest Incompatibility

This component does not work on VRChat on Oculus Quest. If you place this component in a cross-platform world, it will cause errors while it attempts to sync to the PC users in the room and cause the world to misbehave. Remove it from the Quest version.

Requires:

Parameter
Description

Video Count

How many videos are in the playlist

Source

The source of a video.
Url - The source is a URL (This can be a redirect link if you want to change it without having to reupload)
Video Clip - The source is a video clip in the unity project

URL (Appears if it is the selected source)

Where you set the url for the video

Video Clip (Appears if it is the selected source)

The video clip you want to set for the video

Aspect Ratio

The aspect ratio the video should adjusted to.
No Scaling
Fit Vertically
Fit Horizontally
Fit Inside
Fit Outside
Stretch

Playback Speed

How fast the playback of the video(s) should be

RPC's are available via the SendRPC action

RPC
Valid Targets
Description

Play

Owner

Plays the video player

PlayIndex

Owner

Plays the video at the given index of the playlist (starts from 0)

Pause

Owner

Pauses the video player

Stop

Owner

Stops the video player

Previous

Owner

Changes the playing video to the previous video in the playlist

Next

Owner

Changes the playing video to the next video in the playlist

Shuffle (Currently does nothing)

Owner

Shuffles the playlist

Clear

Owner

Clears the playlist

AddURL

Owner

Adds a URL to the playlist (see note)

SpeedUp

Owner

Speeds the video up by 0.1x

SpeedDown

Owner

Slow the video down by 0.1x

AddURL RPC

Adding a URL will only work if a video clip is not present in the playlist. Trying to immediately play the video after adding a URL will likely not work, because the video takes time to load. Induce a delay either via a StateMachine or by using a second button press to allow some time for the URL to resolve and the video to load.

VRC_SyncVideoPlayer


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.