播放视频

Godot 通过 VideoPlayer 节点支持视频的播放。

支持的播放格式

核心中仅支持 Ogg Theora 格式(请勿与 Ogg Vorbis 音频混淆)。扩展可以支持额外的格式,但是截止到 2022 年 7 月,还没有这种扩展存在。

Godot 核心无法支持 H.264 和 H.265,因为它们都被软件专利所限。AV1 不需要授权,但 CPU 解码仍然很慢,也不是所有 GPU 都已支持硬件解码。

Godot 3.x 核心中支持 WebM,但是会在 4.0 中移除支持,因为 bug 很多难以维护。因此不推荐使用 WebM

备注

你的视频可能使用的是 .ogg 或者 .ogx 扩展名,这是带有数据的 Ogg 容器的通用扩展名。

将这些文件扩展名修改为 .ogv可能可以让视频在 Godot 中导入。不过,并不是所有 .ogg.ogx 扩展名的文件都是视频——有些可能只包含音频。

设置 VideoPlayer

  1. 使用“新建 Node”对话框创建 VideoPlayer 节点。

  2. 在场景树面板上选中 VideoPlayer 节点,到检查器中为 Stream 属性加载 .ogv 文件。

  3. 如果你希望在场景加载时立即播放视频,请在检查器中勾选 Autoplay。否则,请保持 Autoplay 关闭,并在需要时在脚本中调用 VideoPlayer 节点的 play() 开始播放。

处理大小变化及不同的纵横比

Godot 4.0 中在默认情况下,VideoPlayer 会自动调整到与视频分辨率相匹配的大小。你可以让它遵循普通的 Control 大小规则,启用 VideoPlayer 节点的 Expand 即可。

要调整 VideoPlayer 节点的大小随窗口大小改变的方式,请通过 2D 编辑器视口顶部的布局按钮调整锚点。不过,这种设置可能不足以处理所有可能的情况,例如全屏播放视频但不造成形变(需要在边界处留白)。要进行精确的控制,你可以使用专为处理这种情况设计的 AspectRatioContainer 节点:

添加一个 AspectRatioContainer 节点。请确保它不是任何其他容器节点的子节点。选中该 AspectRatioContainer 节点,然后在 2D 编辑器的顶部将布局设置为整个矩形。将 AspectRatioContainer 节点的 Ratio(比例)设置为与你的视频的长宽比匹配的比例。你可以在检查器里直接输入数学公式。请记住要将其中的一个操作数写成浮点形式,否则会得到整数的商。

在编辑器检查器中修改 AspectRatioContainer 的 Ratio 属性

求值会得到(大约)1.777778

配置好 AspectRatioContainer 之后,请将你的 VideoPlayer 节点调整为该 AspectRatioContainer 节点的子节点。请确保禁用了该 VideoPlayer 的 Expand。你的视频现在应该就会自动适应到全屏的大小,不产生变形。

参见

更多在项目中支持不同的长宽比的技巧,请参阅 多分辨率

在 3D 表面上显示视频

使用 VideoPlayer 节点作为 Viewport 节点的子节点,就可以在 3D 表面上显示任何 2D 节点。例如,可以用于显示动态的广告板,帧动画可能花费太多的内存。

可以使用以下步骤实现:

  1. 创建一个 Viewport 节点。将其设置为与你的视频大小相匹配的像素大小。

  2. 创建一个 VideoPlayer 节点作为该 Viewport 节点的子节点,并为其指定一个视频的路径。请确保禁用了 Expand,需要时启用 Autoplay

  3. 创建一个 MeshInstance 节点,将其 Mesh 属性设为 PlaneMesh 或 QuadMesh。将该网格的大小调整到与视频的长宽比一致(否则看上去就会变形)。

  4. 在 GeometryInstance 部分的 Material Override 属性中新建一个 SpatialMaterial 资源。

  5. 在该 SpatialMaterial(底部)的 Resource 部分启用 Local To Scene。这是在 Albedo Texture 属性中使用 ViewportTexture 所必须的

  6. 在该 SpatialMaterial 中,将 Albedo > Texture 属性设置为新建 ViewportTexture。点击编辑这个新的资源,在 Viewport Path 属性中指定指向 Viewport 节点的路径。

  7. 在该 SpatialMaterial 中启用 Albedo Tex Force sRGB,防止颜色变化。

  8. 如果广告板应该自发光,请启用 Flags > Unshaded 提升渲染性能。

更多关于设置的信息,请参阅 使用 Viewport3D GUI 演示

播放限制

Godot 中目前的视频播放实现有一些限制:

  • 不支持将视频跳跃到特定的时间点。

  • 不支持修改播放速度。VideoPlayer 也不会遵循 Engine.time_scale

  • 不支持循环播放,但你可以将 VideoPlayer 的 finished 信号连接到某个函数,在这个函数里重新播放视频。不过,这样会在视频重启时显式一帧黑屏。变通方法是在视频文件的末尾加上淡出到黑屏的效果,或者把视频隐藏一帧,在 TextureRect 上显示视频第一帧的截图,直到视频重启为止。

  • 不支持从 URL 播放视频流。