编辑器包

Editor SDK

编辑器包

编辑器包面向画布编辑、视频编辑和高级编辑器业务。它们属于底层 SDK，不建议新同事或普通业务页面从这里开始接入。

何时使用

场景	推荐
做普通业务页面	不推荐，优先看基础 UI 或业务组件
做画布编辑能力	查看 @mbjia/ve-canvas-editor
做视频轨道、模板编辑、下载上传工具	查看 @mbjia/ve-video-editor
只需要素材选择或上传	优先使用 @mbjia/components

@mbjia/ve-canvas-editor

画布编辑器底层能力，包含：

• 数学与仿射变换
• Canvas 图层
• Canvas 工具
• 文本输入
• 事件管理
• 关键帧动画
• 光标管理

入口导出按模块分组：

模块	导出路径	说明
数学	Math/3DMaths、Math/Affine、Math/Types、Math/ConvexOverlap	3D 数学、仿射变换、几何重叠判断。
初始化	CanvasInitOptions	画布初始化配置。
工具	Tools/*	选择、多选、锚点、变换、文本输入和工具管理。
事件	Event/*、KeyboardShortcut	画布事件数据、事件处理、快捷键。
动画	Animation/*	插值器、关键帧、关键帧轨道和轨道管理。
图层	CanvasLayer、CanvasLayerGroup、CanvasLayerCollection	图层、图层组和图层集合。
视图	CanvasEditorView、CanvasEditorStyle、CanvasEditorTypes	编辑器视图、样式和类型。
绘制	CanvasBGPainter、Painter	背景绘制和通用绘制能力。
光标	CanvasCursor、Cursor、CursorManager	光标样式和管理。
其他	Utils、Flags	工具函数和标记位。

@mbjia/ve-video-editor

视频编辑器能力，包含：

• 素材管理
• 模板 API
• 轨道编辑器
• 命令撤销
• 视频编辑 API
• 下载和上传工具

这两个包属于高级 SDK，不建议新手直接从这里开始。

入口导出按模块分组：

模块	导出路径	说明
数学	lib/MathLib3D/3DMaths、Affine、Types	视频编辑中使用的 3D 数学和变换类型。
素材源	SXSource	编辑器素材源能力。
上传下载	Upload、sxDownload	编辑器相关上传和下载。
色彩	hexAndRgba	颜色格式转换。
分片请求	request/chunk	分片请求能力。
模板 API	template/ve-template-api	模板编辑接口。
素材	ve-asset	视频编辑素材模型和操作。
命令	ve-command	编辑器命令系统，通常用于撤销/重做链路。
编辑 API	ve-editor-api	视频编辑器 API。
轨道	ve-track-editor	轨道编辑能力。

接入示例

画布编辑器：

import { CanvasLayer, CanvasEditorView } from '@mbjia/ve-canvas-editor'

视频编辑器：

import { SXSource } from '@mbjia/ve-video-editor'

这两个包通常需要结合现有编辑器页面、素材模型和渲染链路使用。新页面如果只是做素材选择、上传或弹窗流程，优先使用 @mbjia/components。

接入提醒

• 编辑器包通常对业务上下文、素材模型、渲染流程和性能要求更高。
• 使用前建议先确认已有页面是否可以通过业务组件完成。
• 如果需要写编辑器能力文档，应单独按模块补充 API、事件、数据结构和示例。