@msbfe/live-sdk
v0.0.9
Published
## 1. 安装依赖
Downloads
5
Readme
live-sdk
1. 安装依赖
yarn add @msbfe/live-sdk
or
npm i @msbfe/live-sdk
2. 初始化
const liveSDK = LiveSDK.init({
// 通用参数
el: "",
userId: "",
userName: "",
// 保利威参数
appId: "",
channelId: "",
sign: "",
timestamp: "",
avatar: "",
// 获得场景参数
siteid: "",
roomid: "",
});
| 参数 | 默认值 | 描述 | | --------- | ------ | ---------------------------------------------------- | | el | 必填 | 播放器挂载节点。这样允许支持一个页面挂载多个播放器。 | | appId | 必填 | polyv 后台的 appId | | channelId | 必填 | 频道(房间号) Id | | sign | 必填 | 频道验证签名 | | timestamp | 必填 | 毫秒级时间戳 | | siteid | 必填 | 获得场景后台 siteid | | roomid | 必填 | 获得场景房间号 | | userId | 可选 | 用户 ID | | userName | 可选 | 用户名称 | | avatar | 可选 | 用户头像 |
3. 添加事件
3.1 事件列表
| 事件 | 默认值 | | ----------------- | ---------------------------------- | | LIVE_START | 直播开始 | | LIVE_STARTING | 直播中 | | LIVE_END | 直播结束 | | LOGIN_SUCCESS | 登录成功,通常表示播放器初始化完成 | | LOGIN_ERROR | 登录失败 | | SOCKET_CONNECT | 连接成功 | | SOCKET_DISCONNECT | 连接断开 |
3.2 例子
liveSDK.on(LiveSDK.EVNETS.LOGIN_SUCCESS, () => {});
4. 销毁
// 获得场景,在切换账号时,需要先执行 liveSDK.logout()
liveSDK.destroy();