For the complete documentation index, see llms.txt. This page is also available as Markdown.

Video Playback

Learn how to add playable Videos to your VIVERSE Worlds, and to show optional Media Controls


About

PlayCanvas Toolkit comes with an integrated Video Player, allowing creators to place Videos inside their VIVERSE Worlds — both as flat screens and 360 spheres! The Video file can be hosted both inside PlayCanvas project or external URL, and supports autoplay, looping and muting, as well as positional sound. In addition, the Toolkit comes with convenient Media Control component, which enables the Player to control Video playback while experiencing your 3D World.

Usage

Please refer to instructions below to setup a Video Entity in your VIVERSE World, with optional Media Control component:

1

Create Video Entity

  • Create a new empty Entity in your Scene

  • Click Add Viverse Component button and select Rendering > Video Texture

  • If you did everything correctly - you should see a viverseVideoTexture script attached to your Entity

2

Setup Video asset or URL

  • Upload Video asset to your PlayCanvas project

  • Drag and drop it into Asset attribute of viverseVideoTexture script

  • Now you should see the first frame of your Video in PlayCanvas Editor!

  • As alternative, you can use public URL as a Video source

3

Adjust and Test

  • Adjust your Entity's Position, Rotation and Scale to match Video's aspect ratio and desired position / orientation in your Scene

  • Launch your Scene and confirm that the Video is playing as expected

  • Please note that muted Videos can play automatically, but unmuted ones requires user's interaction with the page to start playing

  • Feel free to adjust other attributes like Render Side, Auto Play, Loop, Muted, Volume and Positional Sound, as you see fit

  • Also feel free to experiment with Projection attribute, since it allows playing 360 videos on a spherical surface!

4

Optional: Add Controls

  • With your Entity selected, click Add Viverse Component button and choose Helper > Media Control

  • Relaunch your Scene once again — now when you hover over your Video Entity you can see Media Controls and interact with them!

Last updated

Was this helpful?