Video component
The Video component allows you to add video playback to entities in your scene. Videos can be displayed on 2D surfaces, projected onto geometry, and configured with various playback, audio, and display settings.
The Media Source setting determines how the video is played and whether it is shared across multiple entities. Options include:
- This Player: The entity plays its own video source.
- Sync With Other: The entity syncs with another Video component’s media source, optimizing performance by reducing redundant video streams.
If This Player is selected, additional playback settings are available.
When using This Player, the following settings allow you to customize how the video is played back:
A text field for specifying a media URL. You can:
- Enter a URL manually.
- Drag and drop a video file from the Assets panel, which will populate the URL automatically.
- Add multiple source paths by clicking +.
A slider that controls playback volume, ranging from 0 (silent) to 10 (maximum).
- Synchronize Client Playback (enabled by default): Ensures video playback is synced across all users.
- Autoplay: Starts playback automatically when the scene loads.
- Mute in Editor: Disables video playback inside the Studio editor.
Determines how the video plays:
- Single: Plays the selected file once.
- Random: Randomly selects a file from the Source Paths.
- Loop: Repeats the video continuously.
- SingleLoop: Repeats the currently playing track indefinitely.
The Audio Mode setting determines how the video's sound is emitted in the scene. Options include:
- Positional: The audio emanates from a specific location in the scene and changes volume based on the listener's position.
- Ambient: The audio is heard evenly throughout the entire scene.
If Positional is selected, additional spatial settings are available.
These settings control how the sound behaves in 3D space.
Property | Description |
|---|---|
Distance Model | Defines how the audio volume decreases over distance. Options include: Linear, Inverse, and Exponential. |
Rolloff Factor | Adjusts the rate at which the audio volume decreases according to the selected distance model. A higher value results in a steeper volume drop over distance. |
Max Distance | The maximum distance (in meters) at which the audio can be heard. Beyond this distance, the audio is silent. |
Cone Inner Angle | The angle (in degrees) of the inner cone where the audio is at full volume. This represents the area directly in front of the audio source. |
Cone Outer Angle | The angle (in degrees) of the outer cone where the audio begins to decrease in volume. Outside this angle, the sound fades according to the Cone Outer Gain. |
Cone Outer Gain | A value between 0.0 and 1.0 that determines the volume outside the outer cone. A value of 0.0 means the audio is silent outside the cone, while 1.0 means no decrease in volume. |
The following settings control how the video appears when displayed on an entity.
Defines how the video scales within its display surface:
- Contain: Scales the video to fit within the canvas without cropping.
- Cover: Scales the video to cover the entire canvas, cropping any excess parts.
- Vertical: Adjusts the video to fit vertically within the canvas.
- Horizontal: Adjusts the video to fit horizontally within the canvas.
Determines how the video is mapped onto a surface:
- Flat: Displays the video on a standard 2D surface.
- Equirectangular360: Projects the video onto a spherical surface, suitable for 360-degree videos.
Controls which sides of the surface the video is visible on:
- Front: Displays the video on the front-facing side.
- Back: Displays the video on the back-facing side.
- Double (default): Displays the video on both sides.
Adjusts the width (X) and height (Y) of the video surface.
Shifts the video texture on the surface:
- X: Moves the video horizontally.
- Y: Moves the video vertically.
Scales the video texture:
- X: Adjusts horizontal scaling.
- Y: Adjusts vertical scaling.
Defines how the video repeats across the surface:
- Clamp: Prevents tiling and keeps the video constrained to the surface.
- Repeat: Tiles the video across the surface.
- Mirrored Repeat: Tiles the video with a mirroring effect.
A checkbox that enables transparency in the video. Enable allows parts of the video to be transparent based on its alpha channel.
This option allows the video entity to sync with another video source, optimizing performance by reducing redundant streaming. Sync With Other inherits all audio-related configurations from This Player, ensuring synchronized playback across multiple video screens.
