VideoLib

模组

· 作者 Igrium

一个用于在 Minecraft 中实现视频播放的库

0 本站下载 0 关注 更新于 2 年前

最新 0.1.0 · 1.18.2 · Fabric

一键开服(送7天)

本库适用于 Minecraft 1.18.2。其他版本的移植版本将陆续推出。如果您希望自行移植,欢迎提交拉取请求!

VideoLib

自诞生以来,Minecraft 的引擎……至少可以说有些“有趣”。它似乎缺乏许多标准功能,例如 GPU 网格缓存,以及在本案中提到的简单视频播放。本模组旨在解决这一问题,为模组开发者提供一个干净的 API,以便在他们的模组中使用预渲染的视频播放功能。

注意:本模组本身不提供任何功能。它仅作为供其他模组使用的库。

设置

一旦 Maven 依赖项配置完成,将会提供安装指南。值得注意的是,默认实现要求用户的系统上安装 VLC Media Player。

用法

要使用 VideoLib,您必须获取对 VideoManager 的引用。该视频管理器是所有与库交互的基础,对于模组的功能至关重要:

VideoManager videoManager = VideoLib.getInstance().getVideoManager();

VideoManager 可用于创建多个 VideoPlayer。由于视频播放存在性能开销,每个视频播放器都会使用唯一的 ID 向视频管理器注册。只有视频管理器才能创建新的 VideoPlayer 实例。

VideoPlayer videoPlayer = videoManager.getOrCreate(new Identifier("mymod", "my_video_player"));

每个 VideoPlayer 都有一个 getTexture() 函数,该函数返回一个 Minecraft 纹理标识符,可在实体渲染器(或任何其他使用非图集纹理的地方)中使用。此纹理会针对视频的每一帧自动更新,并且可以像其他任何纹理一样应用。

Identifier texture = videoPlayer.getTexture();
VertexConsumer consumer = vertexConsumers.getBuffer(RenderLayer.getEntityCutout(texture));

// 以任何您想要的方式渲染几何体

视频句柄

有多种方法可以让视频播放器开始播放,但大多数都围绕 VideoHandle 展开。视频句柄本质上是指向存储在外部位置的视频文件的指针,无论是在本地磁盘上还是互联网上的某个地方。要创建 VideoHandle,您需要一个 VideoHandleFactory。这可以从 VideoManager 中获取。

需要注意的是,并非所有视频句柄都能与所有视频管理器配合使用。请确保仅使用视频管理器工厂提供的视频句柄。(大多数 API 函数已经做到了这一点)。

VideoHandleFactory factory = videoManager.getVideoHandleFactory();

VideoHandleFactory 提供了两个主要功能:getVideoHandle(Identifier) 和 getVideoHandle(URL)。

  • getVideoHandle(Identifier) 期望来自任何模组的视频文件的资源标识符。该文件必须位于您的资源包的 videos 文件夹中。(例如:mymod:videos/myvideo.mp4)

  • getVideoHandle(URL) 期望找到视频的 URL。这可能是在互联网上,也可能在本地文件系统上。(例如:http://mywebsite.com/myvideo.mp4)。此文件必须可以通过 GET 请求直接访问。不允许使用 Google Drive 链接或其他需要用户导航下载页面的服务。

然后可以将视频句柄传递给视频播放器进行播放。

VideoHandle idHandle = factory.getVideoHandle(new Identifier("mymod", "videos/myvideo.mp4"))
VideoHandle urlHandle = factory.getVideoHandle(new URL("http://mywebsite.com/myvideo.mp4"));


videoPlayer.getMediaInterface().play(idHandle);

媒体播放器还提供接受标识符和 URL 的直接重载 play() 方法。这些只是创建视频句柄并播放它们的快捷方式。

播放控制

视频播放器提供了一组接口,允许更精细地控制媒体播放:MediaInterface、ControlsInterface 和 CodecInterface。可以通过以下方式访问它们:

MediaInterface mediaInterface = videoPlayer.getMediaInterface();
ControlsInterface controlsInterface = videoPlayer.getControlsInterface();
CodecInterface codecInterface = videoPlayer.getCodecInterface();

这三个接口提供了多种基本功能,例如 pause、play 和 setTime。有关这些 API 功能的详细信息,请参阅 javadoc。

事件

VideoLib 提供了一系列回调,会在视频播放期间的特定事件触发时调用。无论它们在原生代码中的何处触发,所有事件监听器都会在 Minecraft 客户端线程上调用。

VideoEvents events = videoPlayer.getEvents();
events.onBuffering(e -> {
    LogManager.getLogger().info("Buffering!");
})

与播放界面类似,事件函数的详细信息也在 javadoc 中说明。

关于许可证的说明

VideoLib 的默认实现依赖于 VLCJ,其许可协议为 GNU GPL。这意味着 vlc 包中的所有代码均在 GPL 下授权。然而,仓库的其余部分(只要不直接依赖 vlc 包)则在 MIT 许可下授权。此外,vlc 包不被视为公共 API 的一部分,未来可能会移至单独的 Gradle 项目中。

计划中的功能

  • 音频控制。

    • 目前,VLC 直接将音频传输到您的操作系统,完全绕过 Minecraft。我打算对此进行更改。
  • 标准化支持的格式。

  • 当 VideoLib 初始化失败时警告用户(通常是由于缺少原生库)。

  • 渲染实用函数。

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源