ezuikit-js v8.1.7

EZUIKit-JavaScript-npm

轻应用 npm 版本，降低接入难度，适配自定义 UI，适配主流框架

低延时预览，云存储回放，SD 卡回放

功能 API 丰富，如：播放控制，音频控制，视频截图，实时获取视频 OSDTime，视频录制，设备对讲，电子放大，全屏等

从 v8.1.2 开始支持 ESM, 支持按需加载

获取 ezuikit-js

# npm
npm install ezuikit-js

# yarn

yarn add ezuikit-js

# pnpm

pnpm add ezuikit-js

引入 ezuikit-js

// >= v8.1.2  ESM
import { EZUIKitPlayer } from "ezuikit-js";

// < v8.1.2
import EZUIKit from "ezuikit-js";

如果你使用原生方法,可以通过标签引用

<!-- umd -->
<script src="./ezuikit.js"></script>

<script>
const player = new EZUIKit.EZUIKitPlayer({
  id: "video-container", // 视频容器ID
  accessToken:
    "at.3bvmj4ycamlgdwgw1ig1jruma0wpohl6-48zifyb39c-13t5am6-yukyi86mz",
  url: "ezopen://open.ys7.com/BD3957004/1.live",
  width: 600,
  height: 400,
  handleError: (err) => {
    if (err.type === "handleRunTimeInfoError" && err.data.nErrorCode === 5) {
      // 加密设备密码错误
    }
  },
});
<script>

开始使用 - 初始化

基本使用

创建 DOM

<div id="video-container"></div>

播放器初始化

直播

import { EZUIKitPlayer } from "ezuikit-js";

const player = new EZUIKitPlayer({
  id: "video-container", // 视频容器ID
  accessToken:
    "at.3bvmj4ycamlgdwgw1ig1jruma0wpohl6-48zifyb39c-13t5am6-yukyi86mz",
  url: "ezopen://open.ys7.com/BD3957004/1.live",
  width: 600,
  height: 400,
  handleError: (err) => {
    if (err.type === "handleRunTimeInfoError" && err.data.nErrorCode === 5) {
      // 加密设备密码错误
    }
  },
});

回放

import { EZUIKitPlayer } from "ezuikit-js";

const player = new EZUIKitPlayer({
  id: "video-container", // 视频容器ID
  width: 600,
  height: 400,
  accessToken:
    "at.3bvmj4ycamlgdwgw1ig1jruma0wpohl6-48zifyb39c-13t5am6-yukyi86mz",
  url: "ezopen://open.ys7.com/BD3957004/1.rec",
});

非正式版说明

alpha（功能测试）、beta（集成测试）为我们的非正式版本，可能存在功能或使用上的问题，若您遇到了任何问题，欢迎向我们反馈。

非正式版本没有 CDN 资源，使用时需要配置 staticPath，引用本地的解码库资源。

使用示例

如果使用原生 js，可参考 demos => base-demo

如果使用 react，可参考 demos => react-demo

如果使用 react + vite，可参考 demos => with-react-vite

如果使用 vue2，可参考 demos => vue-demo

如果使用 vue3，可参考 demos => vue3-demo

tips

为方便开发者快速接入

我们提供了测试 accessToken,测试播放地址，并提供了几种常用场景使用示例。你可以通过使用示例，使用测试播放地址，测试 accessToken，在你的应用快速接入。

测试播放地址： ezopen://open.ys7.com/BD3957004/1.live

你可以通过以下地址获取到测试 accessToken 获取测试 accessToken 用来播放上述测试播放地址。 当前设备有可能下线或被移除了， 如果自己有设备优先使用自己的设备进行测试。

轻应用 - 海外版本

轻应用支持向接入萤石云海外环境的设备发起取流播放，需要在初始化时配置海外服务域名，示例：

import { EZUIKitPlayer } from "ezuikit-js";

const player = new EZUIKitPlayer({
  id: "playWind",
  width: 600,
  height: 400,
  template: "pcLive",
  url: "",
  accessToken: "",
  env: {
    domain: "https://iusopen.ezvizlife.com", // 北美地区
  },
});

各地区的域名分别为：

最佳实践 tips

1. 我们在 v0.6.2 及以上版本持用户通过开启谷歌实验室特性启动多线程解码，多线程模式将大大提升解码效率，降低解码内存消耗。

开启多线程方式 1(https://open.ys7.com/help/384)

开启多线程方式 2(https://open.ys7.com/help/385)

2. 视频解码库默认从开放平台远程拉取，你可以将解码库放到本地或者你的服务内，可以提升加载解码库速度。

使用本地解码库提升加载速度 开发者需要自己设置静态资源文件地址， 参考 staticPath的配置

使用示例

1. 快速创建视频播放页面

    基本使用： 基本使用示例

2. 前往开放平台轻应用模板管理页创建一个主题，可以动态配置你的播放主题，控件，示例展示了获取一个主题后使用示例。

    自定义主题： 自定义主题示例

3. 你可以本地创建一个主题配置，可以本地配置你的播放主题，控件，示例展示了本地配置项使用示例。

    本地主题配置： 本地主题配置示例

4. 我们提供了一些通用场景的主题，PC 端预览，PC 端回放，移动端预览，移动端回放，你也可以直接使用。

    PC 端预览-固定主题： PC 端预览-固定主题示例

    PC 端回放-固定主题： PC 端回放-固定主题示例

    移动端预览-固定主题： 移动端预览-固定主题示例

    移动端回放-固定主题： 移动端回放-固定主题示例

同一个页面播放多个视频，可以参考：

    单页面多实例(视频多窗口)： 单页面多实例(视频多窗口)示例

附录： 初始化参数说明

直播

标清

ezopen://open.ys7.com/${设备序列号}/{通道号}.live

高清

ezopen://open.ys7.com/${设备序列号}/{通道号}.hd.live

回放

sd 卡回放

初始化参数 url 值为： ezopen://open.ys7.com/${设备序列号}/{通道号}.rec?begin=yyyyMMddhhmmss

云存储回放

初始化参数 url 值为： ezopen://open.ys7.com/${设备序列号}/{通道号}.cloud.rec?begin=yyyyMMddhhmmss 视频 ezopen 协议播放地址 详见：ezopen 协议 Y

配置示例：

方法调用

同步方法（方式 1） 方法支持通过 promise 回调，可通过回调方式执行下一步动作（方式 2）。

开始播放

// 方式1
player.play();
// 方式2
player.play().then(() => {
  console.log("执行播放成功后其他动作");
});

停止播放

// 方式1
player.stop();
// 方式2
player.stop().then(() => {
  console.log("执行停止成功后其他动作");
});

开启声音

// 方式1
player.openSound();
// 方式2
player.openSound().then(() => {
  console.log("执行开启声音成功后其他动作");
});

关闭声音

// 方式1
player.closeSound();

开始录制

因录制解码库加载限制，录制库加载需要 3S 秒左右，请保证录制时长需要大于 5 秒。 录制文件需要使用播放器，播放器下载地址 播放器下载

// 方式1
player.startSave("唯一文件名");
// 方式2
player.startSave("唯一文件名").then(() => {
  console.log("执行开始录制成功后其他动作");
});

停止录制并下载文件

// 方式1
player.stopSave();
// 方式2
player.stopSave().then(() => {
  console.log("执行停止录制成功后其他动作");
});

抓图

// 方式1 - 下载到本地
player.capturePicture("文件名");
// 方式2 - 返回base64格式
const capCallback = (data) => {
  console.log("data", data);
};
player.capturePicture("default", capCallback);

开始对讲

player.startTalk();

结束对讲

player.stopTalk();

对讲设置麦克风增益

// 设置音频增益系数 0 ~ 10
player.setVolumeGain(volume);

获取麦克风权限

player.getMicrophonePermission().then((data) => {
  if (data.code === 0) {
    // 成功....
  }
});

获取麦克风列表

// 需要在麦克风已授权的情况下调用，才能获取到麦克风列表，可以和getMicrophonePermission配合使用，或在初始化后先调用getMicrophonePermission获取授权
player.getMicrophonesList().then((data) => {
  if (data.code === 0) {
    // 成功....
  }
});

切换麦克风

// microphoneId 为获取到的麦克风列表中的deviceId，如果当前处于对讲中，调用setProfile会先关闭，重新发起对讲
player.setProfile({ microphoneId });

监听麦克风音量变化

player.eventEmitter.on("volumeChange", ({ data }) => {
  // 动态显示音柱,100ms触发一次
  console.log(`${data * 100}%`);
});

全屏

player.fullScreen();

取消全屏

player.cancelFullScreen();

获取 OSD 时间

player.getOSDTime().then((time) => {
  console.log("获取到的当前播放时间", time);
});

切换地址播放

可用于在播放中切换设备，切换播放参数，以及直播切换回放等。请注意，频繁切换可能导致异常，切换间隔至少需要 1 秒

player.changePlayUrl(options).then(() => {
  console.log("切换成功");
});

options 参数说明

切换模板主题

可用于在播放中切换模板主题，请切换播放地址成功后调用

player.Theme.changeTheme(template);

// 预览切回放场景示例
player.changePlayUrl({ type: "rec" }).then(() => {
  console.log("地址切换成功，开始切换模板主题");
  player.Theme.changeTheme("pcRec");
});

template 参数说明

开启电子放大

建议使用模板，模板中的电子放大功能更全

// 方式1
player.enableZoom();
// 方式2
player.enableZoom().then(() => {
  console.log("开启电子放大成功");
});

关闭电子放大

// 方式1
player.closeZoom();
// 方式2
player.closeZoom().then(() => {
  console.log("关闭电子放大成功");
});

重置画面宽高

player.reSize(width, height);

销毁实例

player.destroy()

鱼眼矫正（软解 开启 SharedArrayBuffer）

// {1, 0}  壁装鱼眼 不矫正
// {1, 1}  壁装360°全景
// {1, 2}  壁装4分屏
// {1, 4}  壁装广角
// {3, 0}  顶装鱼眼 不矫正
// {3, 1}  顶装360°全景
// {3, 4}  顶装4分屏
// {3, 5}  顶装柱状
// 顶装4分屏
player.setFECCorrectType({place: 3 , type：4}, "cavnas1,canvas2,canvas3") // cavnas1,canvas2,canvas3 是分屏是需要的