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    



Component Dependency

This component requires another component in the scene to work properly.

For use with VRC_SyncVideoStream.

This component is placed on the MeshRenderer of an object that will display the screen. You may have more than one VideoScreen connected to a SyncVideoStream. The material index and texture property are indicated and the texture will be overridden by the playing video. If a texture is provided, it will be used as the "default" screen when nothing is playing.

The video render path is done in linear space so Gamma correction must be applied in the shader. An example shader is provided that can do this, available under Video/EmissiveGamma. Currently, the video is stretched to fill the extents of the UV space, so a mesh that is not the same aspect will be distorted. This may be mitigated in the future by updating the Gamma shader to handle aspect scaling.

Most streams are broadcast in 16:9 aspect ratio, so we recommend using those dimensions as a standard. Utilizing multiple screens enabled and disabled with Triggers will allow you to switch to 16:10, 4:3, or other aspect ratios if necessary.

Updated about a year ago


Suggested Edits are limited on API Reference Pages

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