@volcengine/amk-editor 0.0.2-beta.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -0
- package/dist/amk-editor.d.ts +22 -0
- package/dist/api/client.d.ts +22 -0
- package/dist/export-task-polling.d.ts +12 -0
- package/dist/header.d.ts +18 -0
- package/dist/i18n/keys.d.ts +15 -0
- package/dist/index.js +16005 -2506
- package/dist/tos-upload.d.ts +11 -0
- package/dist/types.d.ts +12 -8
- package/dist/veveditor.css +516 -1
- package/package.json +3 -2
package/dist/tos-upload.d.ts
CHANGED
|
@@ -31,12 +31,23 @@ interface RefreshTosMaterialUrlsOptions {
|
|
|
31
31
|
storage: AmkEditorStorageConfig;
|
|
32
32
|
createClient?: UploadFilesToTosOptions['createClient'];
|
|
33
33
|
}
|
|
34
|
+
/** TOS 素材的稳定标识已包含 bucket 与 object key,无需额外持久化内部字段。 */
|
|
35
|
+
export declare function parseTosResourceUrl(value: unknown): {
|
|
36
|
+
bucket: string;
|
|
37
|
+
key: string;
|
|
38
|
+
} | null;
|
|
34
39
|
/** 使用宿主下发的临时 STS 将本地文件直传客户 TOS,并转换为编辑器素材。 */
|
|
35
40
|
export declare function uploadFilesToTos(options: UploadFilesToTosOptions): Promise<MaterialItem[]>;
|
|
36
41
|
/** 为已持久化的私有 TOS 素材重新生成播放签名,供初始化和按需刷新使用。 */
|
|
37
42
|
export declare function refreshTosMaterialUrls(options: RefreshTosMaterialUrlsOptions): Promise<Array<Partial<MaterialItem> & {
|
|
38
43
|
material_id: string;
|
|
39
44
|
}>>;
|
|
45
|
+
/** 将任意任务产物中的 tos:// 地址批量签成浏览器可访问的 HTTP URL。 */
|
|
46
|
+
export declare function signTosResourceUrls(options: {
|
|
47
|
+
urls: unknown[];
|
|
48
|
+
storage: AmkEditorStorageConfig;
|
|
49
|
+
createClient?: UploadFilesToTosOptions['createClient'];
|
|
50
|
+
}): Promise<unknown[]>;
|
|
40
51
|
/** 为资产库导入的 TOS 素材签发播放 URL;稳定身份仍保留在 source_material_id。 */
|
|
41
52
|
export declare function signTosImportedMaterialUrls(options: {
|
|
42
53
|
materials: MaterialItem[];
|
package/dist/types.d.ts
CHANGED
|
@@ -24,13 +24,13 @@ export interface AmkMaterialImportRequestOptions {
|
|
|
24
24
|
onMaterialsImported?: (materials: MaterialItem[]) => void | Promise<void>;
|
|
25
25
|
}
|
|
26
26
|
/**
|
|
27
|
-
*
|
|
28
|
-
*
|
|
27
|
+
* 抽帧产物的稳定存储身份。TOS 产物会保存完整 `tos://bucket/key`,
|
|
28
|
+
* SDK 用它在签名 URL 过期后重新签发;非 TOS 业务仍可使用自定义字段。
|
|
29
29
|
*/
|
|
30
30
|
export interface RecommendedExtractStorageFields {
|
|
31
|
-
/**
|
|
31
|
+
/** 封面图稳定身份;内置 TOS 链路保存 `tos://bucket/key`。 */
|
|
32
32
|
poster_storage_key?: string;
|
|
33
|
-
/**
|
|
33
|
+
/** 与 sprite.storeurls 等长的稳定身份数组;内置 TOS 链路保存 tos:// 地址。 */
|
|
34
34
|
sprite_storage_keys?: string[];
|
|
35
35
|
}
|
|
36
36
|
export interface PersistExtractUrlsResult {
|
|
@@ -70,7 +70,8 @@ export interface MaterialConfig {
|
|
|
70
70
|
* SDK 会先用临时链上屏/落盘,再后台调用本回调换链;失败则保留临时链。
|
|
71
71
|
* 未配置则只落盘临时链;若带 auth_key 且过期,SDK 会自动重抽。
|
|
72
72
|
* 推荐返回 urls + materialPatch,把刷新 URL 所需的 storage key 或其他业务字段写入素材。
|
|
73
|
-
* SDK
|
|
73
|
+
* SDK 不限制其他 materialPatch 字段;poster_storage_key / sprite_storage_keys
|
|
74
|
+
* 中的 `tos://` 地址会作为后续自动重签依据。
|
|
74
75
|
* 兼容只返回 string[],但该形式无法附带业务字段。
|
|
75
76
|
*/
|
|
76
77
|
onPersistExtractUrls?: (params: {
|
|
@@ -86,6 +87,8 @@ export interface AmkEditorHeaderTitleUpdateSuccess {
|
|
|
86
87
|
}
|
|
87
88
|
export interface AmkEditorHeaderConfig {
|
|
88
89
|
show?: boolean;
|
|
90
|
+
/** 是否展示导出任务列表入口,默认开启。 */
|
|
91
|
+
exportTaskList?: boolean;
|
|
89
92
|
/**
|
|
90
93
|
* When set, the header is rendered into this element instead of inside the
|
|
91
94
|
* editor root. Use this to place a full-width header above a host split layout.
|
|
@@ -114,13 +117,14 @@ export interface AmkEditorUploadSTSCredentials {
|
|
|
114
117
|
}
|
|
115
118
|
/**
|
|
116
119
|
* 产物 / 主动上传的存储目标。
|
|
117
|
-
* `media_output_destination` 用于 TOS 直传的 Bucket
|
|
120
|
+
* `media_output_destination` 用于 TOS 直传的 Bucket 定位,并默认写入会产生媒体产物的 AMK tools 请求体。
|
|
118
121
|
* @see https://docs.volcengine.com/docs/6448/2386113
|
|
119
122
|
*/
|
|
120
123
|
export interface AmkEditorStorageConfig {
|
|
121
124
|
/**
|
|
122
|
-
* 处理产物存储目标。支持 `vod://<空间名>` 或 `tos
|
|
123
|
-
* 配置后任务结果中的 url
|
|
125
|
+
* 处理产物存储目标。支持 `vod://<空间名>` 或 `tos://<桶名>/<可选子目录>`。
|
|
126
|
+
* 配置后任务结果中的 url 为对应资源地址,而不是临时下载链;当返回
|
|
127
|
+
* `tos://bucket/key` 且同时配置 getUploadSTS 时,SDK 会自动签成 HTTP 播放地址。
|
|
124
128
|
*/
|
|
125
129
|
media_output_destination?: string;
|
|
126
130
|
/**
|