@creatomate/preview

中文文档
1.6.1发布于 2026/09/03MITTypeScriptCommonJS零依赖近 30 天下载 9.3万

在通过API创建最后的MP4,GIF,JPEG或PNG之前,在您的网络应用中进行渲染视频和图像预览.

中文使用文档
文档目录6 节
  1. 使用量
  2. 安装
  3. 演示
  4. 兼容性
  5. 问题和评论
  6. 许可证

宝石预览 SDK

这个 预览 SDK 让您在通过 API 创建最终 MP4 、 GIF 、 JPEG 或 PNG 之前, 在您的网络应用中显示视频和图像预览 。 这在开发基于网络的编辑器或自定义器工具时有用,并想在浏览器中显示实时渲染.

这个软件包用于基于浏览器的应用程序,它与任何框架如React,Angular,Vue,以及平版Javascript. 对于使用Node.js创建视频和图像,请参见: creatomate 相反,一个不同的国家预防机制软件包 此处可见。 。 。 .

胡萝卜 是媒体生成的API,用于使用代码来编辑和渲染视频和图像. 该平台使用模板和JSON生成 马普4, (中文(简体) ), 全球投资框架, (中文(简体) ), JPEG 组合 或者说 巴布亚新几内亚 文档。 所有处理都由Creatomate的云基础设施处理,所以不需要维护自己的服务器.

使用量

安装

使用下列命令安装软件包:

npm install @creatomate/preview

现在可以装入视频模板(或 贾森)如下:

import { Preview } from '@creatomate/preview';

// The following assumes that you have a HTML element like this: <div id="container"></div>
const containerElement = document.getElementById('container');

// Initialize a preview to be spawned within the container
const preview = new Preview(containerElement, 'player', 'YOUR_VIDEO_PLAYER_TOKEN');

// Once the SDK is ready, load a template from the project
preview.onReady = async () => {
  await preview.loadTemplate('YOUR_TEMPLATE_ID');
  
  // You can also load a video from JSON:
  // await preview.setSource({ /* Your JSON here */ });
};

请检查下面提供的演示码, 以了解一个更全面的例子 .

演示

此处可见预览 SDK 操作 : 视频预览Demo

兼容性

由于现场视频渲染对设备的硬件要求很高,因此这个库只在现代桌面网页浏览器上工作,如克罗姆,Firefox,Edge,Opera,和Safari等. 不支持移动设备。 通过API渲染出一个MP4预览以支持智能手机设备. 提示: 使用 调制大小( c) API参数(10%至100%)生成低分辨率预览而无需更改组成或模板.

问题和评论

如果您遇到图书馆或Creatomate API的任何问题,请联系我们 支持@ creatomate.com。 。 。 .

许可证

"Creatomate Preview SDK"获得麻省理工学院许可. 请参看 自由主义 更多信息.

版本与发布记录

@creatomate/preview 共发布 11 个版本,首次发布于 2023/05/19;过去 12 个月发布了 1 个版本。

版本发布日期距今
1.6.1latest2026/09/032 个月前
1.6.02025/04/021.6 年前
1.5.02024/05/172 年前
1.4.12024/03/252 年前
1.4.02024/01/022 年前
1.3.02023/11/112 年前

关于 @creatomate/preview 的常见问题

@creatomate/preview 是什么?

在通过API创建最后的MP4,GIF,JPEG或PNG之前,在您的网络应用中进行渲染视频和图像预览.

如何安装 @creatomate/preview?

在项目目录运行 npm install @creatomate/preview,或使用 pnpm add / yarn add / bun add。

@creatomate/preview 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@creatomate/preview 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@creatomate/preview 可以商用吗?

@creatomate/preview 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@creatomate/preview 的下载量有多少?

根据 npm 官方下载统计,@creatomate/preview 在 2026/10/11 – 2026/11/09 这 30 天内被下载 92,801 次,日均约 3,093 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@creatomate/preview 还在维护吗?

最新版本 1.6.1 发布于 2026/09/03(2 个月前);至今共发布 11 个版本,其中过去 12 个月发布了 1 个;首次发布于 2023/05/19。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。