VideoPlayer

描述

将视频内容播放到目标上。

内容可以是 VideoClip 导入资源，也可以是 URL（例如 file:// 或 http://）。视频内容将投射到一个受支持的目标上，例如摄像机背景或 RenderTexture。 如果视频内容包括透明度，此透明度将出现在目标中，允许视频目标后面的对象可见。当数据 VideoPlayer.source 设置为 URL 时，只有在 VideoPlayer 准备完成后才会初始化正在播放的内容的音频和视频描述。这可以通过 VideoPlayer.isPrepared 进行测试。

**电影文件格式支持说明**

VideoPlayer 在其实现中使用原生音频和视频解码库，您有责任使用符合目标平台要求的视频。VideoClipImporter 提供了一个将 VideoClip 资源转码为 H.264 或 VP8 视频编解码器的选项，以及一些实验性选项（例如 Resolution）。这会将匹配的编解码器用于音频轨道：分别是 AAC 和 Vorbis。

另请参阅：VideoClipImporter.SetTargetSettings 和 VideoImporterTargetSettings.enableTranscoding。

您可以选择忽略此转码，而是改用已知受目标系统支持的视频，同时使用外部程序更精确地控制编码过程。在使用过程中，VideoClipImporter 编辑器会提供指导和警告，以更好地帮助您做出正确的格式和编码选择。

目前，必须遵循供应商建议，而且在旧版移动平台上尤其受到约束。例如，您在 Web 中找到的视频通常需要经过检查和相关操作，才能在运行在多个设备上的游戏环境中可靠地使用。以下是一些建议和已知限制的示例：

***** Android：支持的媒体格式：。请参阅下方的附加说明。\ ***** Windows：H.264 视频解码器（请参阅“格式约束”）\ ***** iPhone 6-7：比较 iPhone 型号（请参阅“电视和视频”）

可用于硬件加速的本机支持的最优视频编解码器是 H.264，同时 VP8 作为可以在需要时使用的软件解码解决方案。在 Android 上，VP8 还支持使用本机库，因此也可以根据型号对硬件进行辅助。要在编码参数中查找的键值：

***** Video Codec：H.264 或 VP8。\ ***** Resolution：例如：1280 x 720。\ ***** Profile：适用于 H.264。配置文件是一组功能和约束；供应商通常会指定此配置文件，例如“Baseline”或“Main”。请参阅here.\ ***** Profile Level：适用于 H.264。在一个给定配置文件中，级别会指定某些性能要求，例如“Baseline 3.1”。请参阅here.\ ***** Audio Codec：通常是 AAC（适用于使用 H.264 的 mp4 视频）或 Vorbis（适用于使用 VP8 的 webm 视频）。\ ***** Audio Channels：取决于平台。例如，针对 Android 的建议是立体声文件，但很多设备都接受 5.1。

**关于 Android 的注意事项**

***** 并非所有设备都支持高于 640 x 360 的分辨率。执行运行时检查来验证这一点，未遵循此要求将导致电影无法播放。\ ***** 对于 Jelly Bean/MR1，由于操作系统库中存在错误，分辨率高于 1280 x 720 或拥有 2 个以上音频轨道的电影将无法播放。\ ***** 对于 Lollipop 及以上版本，可以尝试播放任何分辨率或拥有任何数量音频轨道的电影，但会受到设备功能的限制。\ ***** 目前尚不支持 Vulkan 图形 API。\ ***** 格式兼容性问题将在 adb logcat 输出中报告，并始终以 AndroidVideoMedia 为前缀。\ ***** 还需注意特定于设备的错误消息（位于 Unity 错误消息附近）：它们对于引擎来说不可用，但通常会说明兼容性问题。\ ***** 只有直接从磁盘读取的非压缩包支持从资源包中播放。

**以下部分演示了 VideoPlayer 的一些功能：**

// Examples of VideoPlayer function

using UnityEngine;

public class Example : MonoBehaviour
{
    void Start()
    {
        // Will attach a VideoPlayer to the main camera.
        GameObject camera = GameObject.Find("Main Camera");

        // VideoPlayer automatically targets the camera backplane when it is added
        // to a camera object, no need to change videoPlayer.targetCamera.
        var videoPlayer = camera.AddComponent<UnityEngine.Video.VideoPlayer>();

        // Play on awake defaults to true. Set it to false to avoid the url set
        // below to auto-start playback since we're in Start().
        videoPlayer.playOnAwake = false;

        // By default, VideoPlayers added to a camera will use the far plane.
        // Let's target the near plane instead.
        videoPlayer.renderMode = UnityEngine.Video.VideoRenderMode.CameraNearPlane;

        // This will cause our Scene to be visible through the video being played.
        videoPlayer.targetCameraAlpha = 0.5F;

        // Set the video to play. URL supports local absolute or relative paths.
        // Here, using absolute.
        videoPlayer.url = "/Users/graham/movie.mov";

        // Skip the first 100 frames.
        videoPlayer.frame = 100;

        // Restart from beginning when done.
        videoPlayer.isLooping = true;

        // Each time we reach the end, we slow down the playback by a factor of 10.
        videoPlayer.loopPointReached += EndReached;

        // Start playback. This means the VideoPlayer may have to prepare (reserve
        // resources, pre-load a few frames, etc.). To better control the delays
        // associated with this preparation one can use videoPlayer.Prepare() along with
        // its prepareCompleted event.
        videoPlayer.Play();
    }

    void EndReached(UnityEngine.Video.VideoPlayer vp)
    {
        vp.playbackSpeed = vp.playbackSpeed / 10.0F;
    }
}

**MovieTexture 迁移注意事项**

由于 VideoPlayer 与传统电影播放解决方案 MovieTexture 存在根本的不同，我们提供了一些示例来帮助您使用 MovieTexture 将项目迁移到新的 VideoPlayer 解决方案。

**播放电影示例**：

MovieTexture：

using UnityEngine;

public class PlayMovieMT : MonoBehaviour
{
    public AudioClip movieAudioClip;
    public MovieTexture movieTexture;

    void Start()
    {
        var audioSource = gameObject.AddComponent<AudioSource>();
        audioSource.clip = movieAudioClip;
    }

    void Update()
    {
        if (Input.GetButtonDown("Jump"))
        {
            var audioSource = GetComponent<AudioSource>();
            GetComponent<Renderer>().material.mainTexture = movieTexture;

            if (movieTexture.isPlaying)
            {
                movieTexture.Pause();
                audioSource.Pause();
            }
            else
            {
                movieTexture.Play();
                audioSource.Play();
            }
        }
    }
}

VideoPlayer：

using UnityEngine;

public class PlayMovieVP : MonoBehaviour
{
    public UnityEngine.Video.VideoClip videoClip;

    void Start()
    {
        var videoPlayer = gameObject.AddComponent<UnityEngine.Video.VideoPlayer>();
        var audioSource = gameObject.AddComponent<AudioSource>();

        videoPlayer.playOnAwake = false;
        videoPlayer.clip = videoClip;
        videoPlayer.renderMode = UnityEngine.Video.VideoRenderMode.MaterialOverride;
        videoPlayer.targetMaterialRenderer = GetComponent<Renderer>();
        videoPlayer.targetMaterialProperty = "_MainTex";
        videoPlayer.audioOutputMode = UnityEngine.Video.VideoAudioOutputMode.AudioSource;
        videoPlayer.SetTargetAudioSource(0, audioSource);
    }

    void Update()
    {
        if (Input.GetButtonDown("Jump"))
        {
            var vp = GetComponent<UnityEngine.Video.VideoPlayer>();

            if (vp.isPlaying)
            {
                vp.Pause();
            }
            else
            {
                vp.Play();
            }
        }
    }
}

**下载电影示例**：

MovieTexture：

using UnityEngine;

public class DownloadMovieMT : MonoBehaviour
{
    void Start()
    {
        StartCoroutine(GetMovieTexture());
    }

    IEnumerator GetMovieTexture()
    {
        using (var uwr = UnityWebRequestMultimedia.GetMovieTexture("http://myserver.com/mymovie.ogv"))
        {
            yield return uwr.SendWebRequest();
            if (uwr.isNetworkError || uwr.isHttpError)
            {
                Debug.LogError(uwr.error);
                yield break;
            }

            MovieTexture movie = DownloadHandlerMovieTexture.GetContent(uwr);

            GetComponent<Renderer>().material.mainTexture = movie;
            movie.loop = true;
            movie.Play();
        }
    }
}

VideoPlayer：

using UnityEngine;

public class DownloadMovieVP : MonoBehaviour
{
    void Start()
    {
        var vp = gameObject.AddComponent<UnityEngine.Video.VideoPlayer>();
        vp.url = "http://myserver.com/mymovie.mp4";

        vp.isLooping = true;
        vp.renderMode = UnityEngine.Video.VideoRenderMode.MaterialOverride;
        vp.targetMaterialRenderer = GetComponent<Renderer>();
        vp.targetMaterialProperty = "_MainTex";

        vp.Play();
    }
}

静态变量

变量

公共函数

Events

委托

继承的成员