JS SDK 使用更新时间:2020-01-15 19:08:49
注意事项
- 必须打开浏览器麦克风权限。
- 使用https方式推流, http方式可能会获取不到设备名称导致推流不成功。
- 当与文档SDK同时集成使用时,必须先实例化成功此SDK后再实例化文档SDK。
接口使用
创建实例
// 传入参数
var option = {
appId:"xxx", // 应用ID
accountId:"xxx", // 第三方用户ID
token:"xxx", // access_token,必填
roomId:"xxx", // 直播房间ID,必填
videoNode:"xxx" // 视频容器,必填
}
var interface;
//成功回调
var success = function(res){
interface = res.interface;
}
//失败回调
var failure = function(err){
console.log(err);
}
VhallLivePusher.createInstance(option ,success , failure )
获取设备列表
var videoArr = interface.getDevices("video");
var audioArr = interface.getDevices("audio");
console.log(videoArr); // 视频设备列表
console.log(audioArr); // 音频设备列表
开始推流
// 传入参数
var option = {
video:interface.getDevices("video")[0], // 视频设备选择,选填 *(不填则推纯音频)。
audio:interface.getDevices("audio")[0], // 音频设备选择,选填 *(不填为默认音频设备)。
profile: VhallLivePusher.PROFILE.VIDEO_PROFILE_720P_1, // 视频分辨率参数,选填。
}
// 成功回调
var success = funciton(){}
// 失败回调
var failure = function(err){
console.log(err);
}
interface.startPush(option , success , failure);
- 在新版SDK(v2.1.0以上)中,如不传入profile参数,则推送视频设备支持的最佳分辨率。
停止推流
// 预留参数
var opt = {};
// 成功回调
var success = function(){};
// 失败回调
var failure = function(){};
interface.stopPush(opt , success , failure);
全局定义
直播流分辨率参考表
| 可选值 |
宽高比 |
分辨率(宽x高) |
| VhallLivePusher.PROFILE.VIDEO_PROFILE_120P_0 |
4:3 |
160x120 |
| VhallLivePusher.PROFILE.VIDEO_PROFILE_120P_1 |
16:9 |
160x90 |
| VhallLivePusher.PROFILE.VIDEO_PROFILE_180P_0 |
4:3 |
240x180 |
| VhallLivePusher.PROFILE.VIDEO_PROFILE_180P_1 |
16:9 |
320x180 |
| VhallLivePusher.PROFILE.VIDEO_PROFILE_240P_0 |
4:3 |
320x240 |
| VhallLivePusher.PROFILE.VIDEO_PROFILE_240P_1 |
16:9 |
424x240 |
| VhallLivePusher.PROFILE.VIDEO_PROFILE_360P_0 |
4:3 |
480x360 |
| VhallLivePusher.PROFILE.VIDEO_PROFILE_360P_1 |
16:9 |
640x360 |
| VhallLivePusher.PROFILE.VIDEO_PROFILE_480P_0 |
4:3 |
640x480 |
| VhallLivePusher.PROFILE.VIDEO_PROFILE_480P_1 |
16:9 |
848x480 |
| VhallLivePusher.PROFILE.VIDEO_PROFILE_720P_0 |
4:3 |
960x720 |
| VhallLivePusher.PROFILE.VIDEO_PROFILE_720P_1 |
16:9 |
1280x720 |
| VhallLivePusher.PROFILE.VIDEO_PROFILE_1080P_0 |
4:3 |
1440x1080 |
| VhallLivePusher.PROFILE.VIDEO_PROFILE_1080P_1 |
16:9 |
1920x1080 |
错误码对照表
| code |
说明 |
| 211002 |
roomId不能为空 |
| 211003 |
当前浏览器版本,在http协议下,不支持获取设备信息 |
| 211004 |
推流地址错误,请先初始化,再推流 |
| 211005 |
获取房间信息失败 |
| 211006 |
网络错误 |
| 211007 |
活动已发起 |
| 211008 |
获取推流设备出错 |
| 211010 |
推流token验证失败 |
| 211011 |
流名在黑名单 |
| 211013 |
被管理者踢出 |