npm 包 vimeo-upload-me 使用教程

阅读时长 9 分钟读完

简介

vimeo-upload-me 是一款基于 Node.js 的 Vimeo 视频上传包,允许开发者使用 Node.js 编写程序自动化地上传视频并管理 Vimeo 帐户。它提供了丰富的配置选项和优秀的兼容性,被广泛的使用于各种前端项目中。

安装

你可以使用 npm 包管理工具来安装 vimeo-upload-me,首先需要全局安装 vimeo-upload-me-cli 工具。

这个工具可以帮助我们更好的使用 vimeo-upload-me 包。

接着,我们可以在我们的项目中使用以下命令安装 vimeo-upload-me 包。

安装成功后,你就可以在你的项目中使用该包了。

使用指南

1. 先决条件

使用 vimeo-upload-me 前,你需要获取以下授权资料:

  • Vimeo API 站点授权令牌
  • Vimeo 用户的授权令牌

获取授权令牌可以在 Vimeo 开发者网站 中进行开发者注册并创建应用程序。创建完毕后即可获得相应的授权令牌。

2. 基本使用

vimeo-upload-me 的使用非常简单,只需要几行代码就可以完成一个视频的上传。

-- -------------------- ---- -------
----- ----- - ---------------------------

-- ----- --- ------
----- -------- - ------------
----- ------------ - ----------------

-- ----- ------
----- ----------- - ---------------

-- --------
----- --------- - ---------------------

-- -------
----- -------- - --- ---------------------- ------------- -------------

----------------------------------------- -- -
  ------------------------- -------------------------------
---

3. 配置选项

以下是 vimeo-upload-me 还提供的一些其他配置选项。

options 选项:

  • tusOptions?: Record<string, unknown> 包含一些 TUS 上传选项的对象。

  • 文件不存在时不报错,自动创建

    • autoCreate?: boolean
  • 使用 chunked 上传

    • useChunks?: boolean
  • chunk size, 默认 10MB

    • chunkSize?: number
  • 上传线程数

    • numThreads?: number
  • 代理配置

    • proxy?: string
  • metadata?: Metadata 视频元数据信息描述的对象

    • name: string 视频名称
    • description: string 视频的描述
    • privacy?: 'anybody' | 'contacts' | 'disable' | 'nobody' | 'password' | 'unlisted' | 'users' 设置隐私级别
    • password?: string 隐私级别为 password 时使用
    • `embed?: { buttons?: { like?: boolean; share?: boolean; watchlater?: boolean; embed?: boolean; hd?: boolean; fullscreen?: boolean; }, logos?: { custom?: { active?: boolean; link?: string; sticky_custom_link?: boolean; sticky_custom_link_hover?: string; sticky_custom_badge_link?: string; sticky_custom_badge_link_hover?: string; }, vimeo?: { active?: boolean; link?: string; sticky_custom_link?: boolean; sticky_custom_link_hover?: string; sticky_custom_badge_link?: string; sticky_custom_badge_link_hover?: string; } }, title?: { name?: string; owner?: string; portrait?: string; url?: string; }, color?: string, playbar?: boolean, speed?: boolean, timeline?: boolean, autoplay?: boolean, loop?: boolean, byline?: boolean, mute?: boolean, portrait?: boolean, title?: boolean, badge?: boolean, spatial?: { stereo?: boolean; stereomode?: unknown; projection?: unknown; start?: unknown; end?: unknown; yaw?: unknown; roll?: unknown; pitch?: unknown; latitude?: unknown; longitude?: unknown; altitude?: unknown; vertical_fov?: unknown; }, uri?: string;

    }` Some settings for the embed of the video

示例

下面是一些使用 vimeo-upload-me 包的示例代码。

上传一个视频

-- -------------------- ---- -------
----- ----- - ---------------------------

-- ----- --- ------
----- -------- - ------------
----- ------------ - ----------------

-- ----- ------
----- ----------- - ---------------

-- --------
----- --------- - ---------------------

-- -------
----- -------- - --- ---------------------- ------------- -------------

----------------------------------------- -- -
  ------------------------- -------------------------------
---

获取视频信息

-- -------------------- ---- -------
----- ----- - ---------------------------

-- ----- --- ------
----- -------- - ------------
----- ------------ - ----------------

-- ----- ------
----- ----------- - ---------------

-- ------ --
----- ------- - ------------

----- -------- - --- ---------------------- ------------- -------------

-- ------
-------------------------------------------------- -- -
  ----------------------
---

删除一个视频

-- -------------------- ---- -------
----- ----- - ---------------------------

-- ----- --- ------
----- -------- - ------------
----- ------------ - ----------------

-- ----- ------
----- ----------- - ---------------

-- ------ --
----- ------- - ------------

----- -------- - --- ---------------------- ------------- -------------

-- ----
------------------------------------- -- -
  ------------------- -------------
---

总结

vimeo-upload-me 是一款较为优秀的 Node.js 视频上传包,使用方便,提供了多种配置选项。它的出现让我们可以更加自动化地管理 Vimeo 视频。希望本文对你有所帮助,愿你在使用 vimeo-upload-me 包时能够顺顺利利。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60065b44c6eb7e50355dbe7b

纠错
反馈