@polyv/live-watch-sdk
v1.11.0
Published
SDK for creating a live stream viewing page using Polyv's services.
Downloads
136
Readme
保利威观看页 SDK
介绍
保利威观看页 SDK 是由保利威开发团队提供的直播观看页软件开发工具包,它包含直播观看应用的常见功能模块,如播放器、聊天室、连麦等。
需要注意的是,该 SDK 是一个 逻辑层 SDK,仅提供底层逻辑的封装,与具体的框架或界面无关。这意味着它可以在任何框架中使用,如 Vue.js、React、AngularJS 等。
优点
- 保利威 SaaS 直播观看页也是基于观看页 SDK 进行开发,故观看页 SDK 的功能是完整的。
- 采用现代化前端工程理念进行开发,提供 TypeScript 类型声明文件。
- 提供功能完整的开源项目(基于 Vue.js 2.7 开发),开发人员可以基于该项目进行二次开发。
使用方式
观看页 SDK 提供 npm、CDN 两种方式引入,开发者可根据自身需求选择其中一种方式引入 SDK 到项目中。
方式一:npm(推荐)
安装 SDK
npm install @polyv/live-watch-sdk --save
引入 SDK
import { createWatchCore } from '@polyv/live-watch-sdk';
方式二:CDN
安装 SDK
<!-- 通过版本号引入 -->
<script src="https://websdk.videocc.net/live-watch-sdk/{version}/lib/polyv-live-watch.umd.js"></script>
<!-- 使用最新版本引入 -->
<script src="https://websdk.videocc.net/live-watch-sdk/latest/lib/polyv-live-watch.umd.js"></script>
引入 SDK
通过 CDN 引入观看页 SDK 后,会挂在一个 window 全局对象 PolyvLiveWatchSDK
,通过该全局对象获取观看页 SDK 暴露的 Api。
<script>
const { createWatchCore } = window.PolyvLiveWatchSDK;
</script>