VideoAspectRatio

Description

Use these methods to fit a video into your target area.

This enum gives you several options to manage how the VideoPlayer renders the video to a target area. To do this, the VideoPlayer adjusts or maintains the video's original aspect ratio. If you render a video into a RenderTexture, and the aspect ratio of the RenderTexture doesn't match that of the video being rendered, the VideoPlayer automatically adds black bars around the video. If you render a video into a Camera, any area around the video remains transparent.

// This script switches between the aspect ratios when you press the Spacebar. 
// To set up your project for this script: 
// 1. Attach this script to a GameObject in your Scene. 
// 2. Add a VideoPlayer component to your GameObject.
// 3. Assign a VideoClip to your VideoPlayer. 

using UnityEngine;
using UnityEngine.Video;

public class VideoRenderModeExample : MonoBehaviour
{
    VideoPlayer videoPlayer;
    
    void Start()
    {
        videoPlayer = GetComponent<VideoPlayer>();

        // Make video play over the Scene. 
        videoPlayer.renderMode = VideoRenderMode.CameraNearPlane;
        Camera mainCamera = Camera.main; 
        videoPlayer.targetCamera = mainCamera;

        // Loop the video.
        videoPlayer.isLooping = true;

        // Set the default aspect ratio.
        videoPlayer.aspectRatio = VideoAspectRatio.Stretch;

        // Play the video.
        videoPlayer.Play();
    }

    private void Update()
    {
        // If you press the Spacebar, cycle through the aspect ratios.
        if (Input.GetKeyDown(KeyCode.Space))
        {
            VideoAspectRatio currentAspectRatio = videoPlayer.aspectRatio;

            // Cycle through the enum values and loop back around. 
            int nextAspectRatio = ((int)currentAspectRatio + 1) % System.Enum.GetValues(typeof(VideoAspectRatio)).Length;

            // Apply the new aspect ratio.
            videoPlayer.aspectRatio = (VideoAspectRatio)nextAspectRatio;

            Debug.Log($"Switched aspect ratio to: {videoPlayer.aspectRatio}");
        }
    }
}

Properties