发起视频直播

功能介绍

SDK具有视频直播发起的能力，需要完成直播间的初始化、开始推流后方可开启一场视频直播。

注意事项

推流需要麦克风和摄像头权限，否则推的会是黑流

支持发起竖屏、横屏两种直播，请勿颠倒使用，会造成观看端效果不佳。

发起直播步骤

初始化直播间信息- initBroadcast

初始化推流实例-Broadcast.build()

设置房间详情- broadcast.setWebinarInfo()（只设置一次）

开始直播- broadcast.start() （发送聊天等可以在这一步调用）

结束直播- finishBroadcast

销毁直播间-broadcast.destroy() （退出房间必须调用，只设置一次）

核心类

属性	属性描述
Broadcast	发直播核心类
VHLivePushConfig	推流配置参数
VHPlayerListener	直播事件回调
MessageServer#Callback	房间消息回调
ChatServer#Callback	聊天消息回调

关键方法

方法	方法描述
initBroadcast	初始化直播间信息
VHLivePushConfig	推流配置参数
Broadcast.build()	初始化推流实例
setWebinarInfo()	设置房间详情
changeCamera()	V1版本切换摄像头
changeCameraV2()	V2版本切换摄像头
setCameraDrawMode	本地预览填充模式
setMirror	镜像视频画面
setBeautyLevel	设置美颜
setMute	设置麦克风静音
setVideoCapture	设置摄像头开关
start()	开始直播
sendChat	发送聊天
sendCustom	发送自定义消息
acquireChatRecord	获取历史聊天记录
setVolumeAmplificateSize	设置声音增益的大小
finishBroadcast	结束直播
broadcast.destroy()	销毁直播间
VHPlayerListener	直播事件回调

初始化直播间信息

接口API

接口入参

参数名称	是否必须	示例	备注
id	是	234700561	活动id 在网页上创建
nickName	否	" name"	昵称
email	否	123456	邮箱
accessToken	否	ee	老活动需要
onlyNewInteractive	是	true	主持人互动需要true
LoadWebinarInfoCallback#WebinarInfo			活动详情

代码示例

推流参数配置

VHLivePushConfig

接口API

视频分辨率类型

参数字段	描述
VHLivePushFormat.PUSH_MODE_HD	640*480
VHLivePushFormat.PUSH_MODE_XHD	1280*720
VHLivePushFormat.PUSH_MODE_XXHD	1920*1080

内部变量说明

参数字段	描述	默认值
videoFrameRate	视频帧率	15（10-30）
videoBitrate	视频码率	800*1000 b/s（与视频清晰度相关）
screenOri	横竖屏	横屏 VHLivePushFormat.SCREEN_ORI_LANDSPACE
pushTimeout	推流超时时长	5*1000 ms
pushReconnectTimes	重连次数	5
streamType	推流类型	音视频 VHLivePushFormat.STREAM_TYPE_AV

直播间横竖屏参数-screenOri

参数字段	描述
VHLivePushFormat.SCREEN_ORI_LANDSPACE	横屏
VHLivePushFormat.SCREEN_ORI_PORTRAIT	竖屏

推流类型-streamType

参数字段	描述
VHLivePushFormat.STREAM_TYPE_NONE	推流内容
VHLivePushFormat.STREAM_TYPE_AV	音视频
VHLivePushFormat.STREAM_TYPE_V	纯视频
VHLivePushFormat.STREAM_TYPE_A	纯音频

初始化推流实例V1

备注：直播推流 V1 版本，无使用限制，无需单独开通。

接口API

内部变量说明

参数名称	是否必须	示例	备注
VHVideoCaptureView	是	VHVideoCaptureView	推流回显view
VHAudioCapture	否	new VHAudioCapture()	视频码率
VHPlayerListener	是		播放器回调
VHLivePushConfig	是		初始化推流参数
ChatServer.Callback	否		聊天监听
MessageServer.Callback	否		消息监听
denoise	否	false	降噪

代码示例

初始化推流实例V2

备注：直播推流 V2 版本相较 V1，推流稳定性大幅提升，卡顿、断流更少；抗弱网能力也更强，网络波动时依旧能流畅开播。想体验更可靠的直播？联系技术支持了解开通详情吧～

接口API

内部变量说明

参数名称	是否必须	示例	备注
VHVideoCaptureView	是	VHVideoCaptureView	推流回显view
VHAudioCapture	否	new VHAudioCapture()	视频码率
VHPlayerListener	是		播放器回调
VHLivePushConfig	是		初始化推流参数
ChatServer.Callback	否		聊天监听
MessageServer.Callback	否		消息监听
setContext	是	Activity	上下文
isBuildV2	是	true	是否为V2版本
setLicenseKey	否	如果isBuildV2是true则参数必填	直播licenseKey
setContext	否	如果isBuildV2是true则参数必填	直播licenseUrl

代码示例

设置房间详情

备注：只设置一次，不能多次设置

接口API

代码示例

切换摄像头V1

备注：V1版本使用。

接口API

代码示例

切换摄像头V2

备注：V2版本使用，默认开启摄像头为前置摄像头。

接口API

代码示例

本地预览填充模式

推流播放器初始化成功后设置生效

接口API

Broadcast#setCameraDrawMode

接口入参

参数名称	是否必须	示例	备注
mode	是	VHLivePushFormat.DRAW_MODE_ASPECTFIT	本地相机预览填充模式

代码示例

适配类型	描述
VHLivePushFormat.DRAW_MODE_NONE	默认
VHLivePushFormat.DRAW_MODE_ASPECTFIT	自适应居中
VHLivePushFormat.DRAW_MODE_ASPECTFILL	铺满全屏

镜像视频画面

推流播放器初始化成功后设置生效

接口API

Broadcast#setMirror

接口入参

参数名称	是否必须	示例	备注
mirror	是	true	镜像视频画面预览画面和流都是镜像状态

代码示例

摄像头开关

接口API

Broadcast#setVideoCapture

接口入参

参数名称	是否必须	示例	备注
enable	是	true	开启

代码示例

麦克风开关

接口API

Broadcast#setMute

接口入参

参数名称	是否必须	示例	备注
mute	是	true	静音

代码示例

设置美颜

接口API
VHVideoCaptureView#setBeautyLevel

接口入参

参数名称	是否必须	示例	备注
level	是	1-5	美颜等级

代码示例

开始直播

接口API
Broadcast#start

接口入参

参数名称	是否必须	示例	备注
rehearsal	否	lss123345	是否发起彩排活动

代码示例

发送聊天

备注：接口成功之后在消息监听里面接收自己的消息

接口API
Broadcast#sendChat

接口入参

参数名称	是否必须	示例	备注
content	是	消息内容	消息内容

代码示例

发送自定义消息

备注：接口成功之后在消息监听里面接收自己的消息

接口API
Broadcast#sendCustom

接口入参

参数名称	是否必须	示例	备注
content	是	JSONObject	消息内容

代码示例

获取历史聊天记录

接口API
Broadcast#acquireChatRecord

接口入参

参数名称	是否必须	示例	备注
show_all	否	1	true显示所有聊天最条为100条 false 为20条
List#ChatServer.ChatInfo			返回数据类

接口入参

参数名称	是否必须	示例	备注
page	否	1	获取条目节点，默认为1
limit	否	1-100	获取条目数量，最大100
msgId	否	msg_97161	锚点消息id,此参数存在时anchor_path 参数必须存在
anchorPath	否	20	锚点方向，up 向上查找，down 向下查找,此参数存在时 msg_id 参数必须存在
isRole	否	0	0：不筛选主办方 1：筛选主办方默认是0
List#ChatServer.ChatInfo			返回数据类

代码示例

设置声音增益的大小

接口API
Broadcast#setVolumeAmplificateSize

接口入参

参数名称	是否必须	示例	备注
size	是	[0.0 1.0]	设置声音增益的大小
int			返回值 0是成功，非0是失败

代码示例

重新推流

备注：触发媒体推流，当推流异常时通过调用此方法重新推流，不会再次触发开播状态。

接口API
Broadcast#pushStream

结束直播

备注：修改直播间状态

接口API
VhallSDK#finishBroadcast

接口入参

参数名称	是否必须	示例	备注
id	是	234700561	活动id 在网页上创建
accessToken	否	dn313n4242424242	请求API获取的Token 新控制台（化蝶）创建的直播可以不写
broadcast	否		新控制台（化蝶）可以不传
rehearsal	否		是否是彩排

代码示例

销毁直播间

退出直播间必须调用

接口API
broadcast#destroy

代码示例

直播事件回调

VHPlayerListener

状态码说明-onStateChanged

状态码	描述
Constants.State.START	开始推流
Constants.State.BUFFER	推流阻塞
Constants.State.STOP	停止推流

事件码说明-eventCode

事件码	描述
Constants.Event .EVENT_UPLOAD_SPEED	上传速度
Constants.Event .EVENT_NETWORK_OBS	网络阻塞
Constants.Event .EVENT_NETWORK_UNOBS	网络恢复

错误码说明-errorCode

错误码	描述
Constants.ErrorCode.ERROR_NOT_INIT	初始信息错误
Constants.ErrorCode.ERROR_PUSH	推送过程出错
Constants.ErrorCode.ERROR_AUDIO_CAPTURE	音频采集过程出错
Constants.ErrorCode.ERROR_VIDEO_CAPTURE	视频采集过程出错
Constants.ErrorCode.ERROR_V2_DISCONNECTED	V2版本推流异常，推流已中断
Push.ERROR_PLAYING	正在直播、开播失败
Push.ERROR_NOT_INIT	初始化视频信息失败（没有设置活动信息）

代码示例

附加说明

(1)屏幕保持常亮

(2)横竖屏发起视频

(3)设置发起布局

功能介绍#

注意事项#

发起直播步骤#

核心类#

关键方法#

初始化直播间信息#

推流参数配置#

视频分辨率类型#

内部变量说明#

直播间横竖屏参数-screenOri#

推流类型-streamType#

初始化推流实例V1#

内部变量说明#

初始化推流实例V2#

内部变量说明#

设置房间详情#

切换摄像头V1#

切换摄像头V2#

本地预览填充模式#

镜像视频画面#

摄像头开关#

麦克风开关#

设置美颜#

开始直播#

发送聊天#

发送自定义消息#

获取历史聊天记录#

设置声音增益的大小#

重新推流#

结束直播#

销毁直播间#

直播事件回调#

状态码说明-onStateChanged#

事件码说明-eventCode#

错误码说明-errorCode#

附加说明#

功能介绍

注意事项

发起直播步骤

核心类

关键方法

初始化直播间信息

推流参数配置

视频分辨率类型

内部变量说明

直播间横竖屏参数-screenOri

推流类型-streamType

初始化推流实例V1

内部变量说明

初始化推流实例V2

内部变量说明

设置房间详情

切换摄像头V1

切换摄像头V2

本地预览填充模式

镜像视频画面

摄像头开关

麦克风开关

设置美颜

开始直播

发送聊天

发送自定义消息

获取历史聊天记录

设置声音增益的大小

重新推流

结束直播

销毁直播间

直播事件回调

状态码说明-onStateChanged

事件码说明-eventCode

错误码说明-errorCode

附加说明