直播API文档
1. 初始化推流
VHPublisher.init({
roomId:'lss_22b89748',//房间名称
videoNode:'my-publisher',//推流容器
//调用推流接口后完成事件,注意,是调用接口事件完成,不是推流结束。
complete:function(){
//to do
}
});
注意:
1.此方法必需写在Vhall.ready事件里。
2.roomId获取方式,登陆微吼云>>进入应用管理>>找到对应需要推流的应用>>点“直播管理”>>房间管理>>取得相应房间ID。
3.videoNode,为推流回显容器的Id,需要开发者自己在需要显示回显的地方,创建一个空div,然后给Id命名,再将id名称写入此参数。参考 “直播使用流程step5: 创建推流器对象”
2. 开始推流
此方法既可以不传任何参数来调用(使用默认参数),也可以自定义参数来调用,如下示例:
//简单调用方法
VHPublisher.startPush();
//自定义参数调用方法
VHPublisher.startPush({
camera:'',//摄像头名称,不传值则使用默认摄像头
mic:'',//麦克风名称,不传值则使用默认麦克风
width:'',//推流分辨率的宽度,不传值则使用默认分辨率:853,
height:'',//推流分辨率的高度,不传值则使用默认分辨率:480
//成功回调,非必填
success:function(){
//after success todo
},
//失败回调,非必填
fail:function(){
//after failed todo
}
});
注意: 此方法必需写在Vhall.ready事件里。
3. 停止推流
此方法既可以不传任何参数来调用,也可以自定义参数(设置推流回调)来调用,如下示例:
//简单调用方法
VHPublisher.stopPush();
//自定义参数调用方法
VHPublisher.stopPush({
//停止推流完成事件,非必填
complete:function(){
//todo
}
});
4. 异常处理
VHPublisher.error
VHPublisher.error(function(e){
//返回值 res {code:消息码, msg: 提示}
});
code码说明:
code | 说明 |
---|---|
1001 | 缺少基础类Vhall |
1002 | roomId不能为空 |
1003 | 当前浏览器版本,在http协议下,不支持获取设备信息 |
1004 | 推流地址错误,请先初始化,再推流 |
2001 | flash初始化失败 |
注意事项
- 必须打开浏览器摄像头权限;
- 必须打开浏览器麦克风权限;
- 必须在推流器初始化以后才能调用推流器的相关方法,否则会报错失败;
- Chrome 60+ 建议使用https方式推流, http方式可能会获取不到设备名称导致推流不成功;