Files
hypit/docs/zh/guide/packages.md
2026-10-09 22:28:54 +08:00

4.0 KiB
Raw Permalink Blame History

title, description
title description
包与扩展 视频项目如何通过普通包选择组件、模型和服务。

Hypit 把视频需要什么,与哪些代码和服务完成它,分别表达。新的图形、模型或 API 来源可以由包提供,再由项目选择。每个包拥有自己的接口和实现,执行系统负责运行它们组成的依赖图。

各部分的职责

部分 职责 在哪里选择
作者组件 将作者输入转成素材请求、视觉行为或其他图输出 Source 导入
Model 定义明确的生成请求与输出 Source 导入
Provider Endpoint 通过 API 或本地工具执行支持的请求 Runtime Profile
凭据存储 为 Endpoint 解析具名凭据 Runtime Profile
Result 仓库 保留项目的 Build 记录与产物文件 Runtime 实现;Local Runtime 使用项目的 .hypit/results
Distribution 提供可执行应用与官方包 安装的 hypit 版本

例如,Model 描述要生成的视频,Provider 将请求映射到服务;Ranking 组件描述榜单的行为,渲染器将其贡献绘制到最终编排。两者都通过明确输入与输出参与同一个图。

组件随作品需要组织

在适合提取秩序的地方组织空间。Visual Track 可以呈现普通视频或图片;项目组件可以把移动的视频视口、标签和流程图作为一个场景协调起来。独立字幕或叠加层仍可分开。共享行为决定哪些内容属于同一个组件。

对于说话视频,Narrative Projection 可以把 Script Selection 与 Moment 显影成组件消费的绝对 Window 与 Instant;作者主导节奏的动画,则可以在声明的时钟上从秒或帧直接产生相同类型。 Film 与渲染 介绍这些贡献如何组成作品。

新组件通常放在视频项目的 packages/ 中,使用所有者自己的 scope,由项目的普通包管理器声明。需要跨项目复用时,所有者可以把同一个组件发布为有版本的 npm 或私有 Registry 包。使用方安装选定版本,并将 lockfile 与项目一起保存。

安装与 Source 导入

Skill、可执行 Distribution 和视频项目分别安装与更新。@hypit/hypit Distribution 内嵌 Core,将产品选定的默认作者包作为普通 npm 依赖安装,并公开扩展 API。所选 Runtime Adapter 可以通过 hypit runtime up 准备其声明的服务与运行材料。npm 依赖随其所有者安装:Distribution 的依赖随 Distribution 安装,项目组件的依赖由项目管理。

Source 使用 @your-studio/scoreboard@1 这样的逻辑 Module 地址。npm 安装的包版本决定实际实现,逻辑 @1 标识作者接口。视频 Build 使用这些已安装的版本;缺包时会报告安装所需的信息。

升级已有作品前,先阅读目标发行版的迁移说明,再调整可执行程序和组件依赖。 0.3 项目迁移指南 说明旧项目语法与用法的迁移,并链接到 0.3.1 的 SDK 导入调整。迁移与验证时保留已有素材和 Results。

编写与分享扩展

外部包只使用自己实际需要的窄公共所有者,例如 @hypit/hypit/author、@hypit/hypit/producer、@hypit/hypit/admission、@hypit/hypit/markup、@hypit/composition、@hypit/generation/model 或 @hypit/hypit/endpoint。将选定的 @hypit/hypit 版本作为开发依赖,把扩展编译为 JavaScript,分发它自己的代码与素材。package.json 中的 activation 入口描述它提供的能力;加载选中的扩展时,当前 Distribution 提供公开 Hypit API。

精确 SDK 类型与实现示例留在对应包的 README 和仓库源码中;安装后的包提供公开类型与可执行代码。