微吼直播jssdk接入指引

微吼直播JS SDK 接入指南

微吼直播JS SDK 接入指南

(v1.0.0)

微吼直播JS SDK 接入指南

目录

一、 简介- 3 -

二、 SDK 引入、初始化并注入权限验证- 3 -

1. 依赖库- 3 -

2. 引入JS 文件- 3 -

3. 初始化及权限验证- 4 -

4. 获取用户参会状态- 6 -

三、 功能详细说明- 7 -

1. 主要调用API - 7 -

2. 响应事件API - 8 -

3. SDK 客户端主要错误状态码- 8 -

4. 主要代码示例- 9 -

附录：demo - 15 -

微吼直播JS SDK 接入指南

一、简介

本文档为了指导开发者更快使用微吼直播的“自助式网络直播服务SDK”通过引用JS

的方式开发自己的PC 网页以及H5 来对接微吼直播平台，默认读者了解前端开发同时拥

有JavaScript 基础。

目前支持的功能如下：

分类 功能 描述

聊天 观看端聊天 支持在直播时聊天和观看回放时聊天

注：视频、文档以及问答模块目前仍只能使用网页嵌入的方式。

二、SDK 引入、初始化并注入权限验证

1. 依赖库

本SDK 依赖于JQuery 库，请在需要引入JQuery 的页面插入以下代码进行引入：

type="text/javascript">

2. 引入JS 文件

在需要调用SDK 的页面插入以下代码以引入JS 文件：

目前暂不支持https

注：支持使用AMD/CMD 标准模块加载规范加载

微吼直播JS SDK 接入指南

3. 初始化及权限验证

请使用以下的方法和参数进行SDK 的初始化以及权限的验证

VHALL_SDK.init({

account : '',//必填，唯一用户id

email : '',//参数必填，值可为空，用于与嵌入视频区用户同步

username : '',//必填，用户昵称用以在各模块中显示

roomid :'',//必填，当前聊天所在活动id

appkey :'',//必填，启用服务唯一验证，API/SDK 权限申请后自行生成

signedat :'',//必填，启用服务唯一验证，unix 时间戳

sign :'',//必填，启用服务唯一验证，有效期一小时，见下面的生成规则

facedom :'',//可选，当使用微吼表情时必填，呼出表情弹窗dom 属性 如

('#id','.class'等)

textdom : '',//可选，当使用微吼表情时必填，插入表情文本dom 属性 如

('#id','.class'等)

});

注：为确保嵌入页面的用户与SDK 各模块中的用户是同一个用户，请尽量传入与视

频区嵌入相同的email 参数，否则会被统计成两个不同的用户

参数sign 的生成规则如下：

将account、email、username、roomid、app_key(注意此处参数名为app_key 而不

是init 方法中的appkey) 以及signedat 这些参数：

1 按参数名升序排列

2 然后按参数名1+参数值+参数名2+参数值拼接

3 在首尾各加上secret_key

4 计算md5 作为sign

微吼直播JS SDK 接入指南

$secret_key = "user_secret_key";

$params = [

"roomid"=> "123456789",

"account"=> "ac