暖场视频

在 SaaS 控制台配置上暖场视频，直播预告状态下观众进入直播间可以查看已配置的视频，提升直播活动预热效果，也可以实现直播的预约功能配合使用。

注意事项

必需登录成功之后才可以进入活动

暖场视频需要 pc 设置才会有

暖场视频底层和回放播放器一样

暖场视频关键步骤

初始化直播间信息 - initWatch（只设置一次）

获取暖场视频详情 - VhallSDK.getWarmInfo

初始化暖场视频实例 - WatchWarmUp.build()（只设置一次）

设置房间详情 - WatchWarmUp.setWebinarInfo（只设置一次）

开始观看 - WatchWarmUp.start （发送聊天等可以在这一步调用）

暂停播放 - WatchWarmUp.stop

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

核心类

类名	描述
WatchWarmUp	暖场视频核心类
VHPlayerListener	暖场视频事件回调
MessageServer#Callback	房间消息回调
ChatServer#Callback	聊天消息回调

关键方法

方法	方法描述
VhallSDK.initWatch	初始化直播间信息
VhallSDK.getWarmInfo	获取暖场视频详情
WatchWarmUp.build()	初始化暖场视频实例
WatchWarmUp.setWebinarInfo	设置直播间详情
WatchWarmUp.setScaleType	本地预览填充模式
WatchWarmUp.setDefinition	设置分辨率
WatchWarmUp.isPlaying	播放状态
WatchWarmUp.start	开始观看
WatchWarmUp.setSpeed	设置观看倍速
WatchWarmUp.getCurrentPosition	获取当前进度时间
WatchWarmUp.getDuration	获取总时长
WatchWarmUp.seekTo	跳转进度
WatchWarmUp.getPlayerState	当前播放器状态
WatchWarmUp.stop	暂停播放
WatchWarmUp.destroy	销毁直播间
VHPlayerListener	直播事件回调

初始化直播间信息

只有正在回放的活动才可以成功

接口 API

接口入参

参数名称	是否必须	示例	备注
id	是	234700561	活动 id 在网页上创建
email	否	123456	邮箱
nickName	否	" name"	昵称
password	否	123	密码/k 值
status	否	WebinarInfo.BESPEAK	活动状态 WebinarInfo.LIVE 看直播/WebinarInf.BESPEAK 看回放不传这个参数可以直接获取活动详情不根据状态过滤
k_id	否	123	k_id 值
LoadWebinarInfoCallback#WebinarInfo			活动详情

代码示例

获取暖场视频详情

只有正在回放的活动才可以成功

接口 API

接口入参

参数名称	是否必须	示例	备注
webinar_id	是	234700561	活动 id 在网页上创建

WarmInfoData 暖场视频信息

参数名称	备注
img_url	暖场视频图片
player_type	1:单次播放 2:循环播放
warm_id	暖场视频 id
webinar_id	活动 id
is_open_warm_video	暖场视频是否开启，0:关闭，1:开启
list	暖场视频对应列表 List#RecordListBean

暖场视频详情

RecordListBean

参数名称	备注
paas_record_id	暖场视频 paas_id
record_name	暖场视频名称
created_at	关联成为暖场视频时间
duration	时长
storage	大小

代码示例

初始化暖场视频实例

接口 API

内部变量说明

参数名称	是否必须	示例	备注
Context	是	watchView.getActivity()	上下文对象
vodPlayerView	是	VodPlayerView	回显视频 view
ChatServer.Callback	否		聊天监听
MessageServer.Callback	否		消息监听
VHPlayerListener	否		播放器消息

代码示例

设置直播间详情

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

接口 API

代码示例

本地预览填充模式

接口 API

接口入参

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

代码示例

适配类型	描述
Constants.DrawMode.kVHallDrawModeNone.getValue()	默认
Constants.DrawMode.kVHallDrawModeAspectFit.getValue()	自适应居中
Constants.DrawMode.kVHallDrawModeAspectFill.getValue()	铺满全屏

设置分辨率

接口 API

接口入参

参数名称	是否必须	示例	备注
definition	是	360	要设置的分辨率

代码示例

播放状态

获取当前播放状态

接口 API

代码示例

开始观看

接口 API

接口入参

参数名称	是否必须	示例	备注
recordBean	是	360	暖场视频信息

代码示例
支持观看暖场视频列表的不同视频

设置观看倍速

接口 API

接口入参

参数名称	是否必须	示例	备注
speed	是	1.5	速度 0.25-2

代码示例

获取当前进度时间

接口 API

代码示例

获取总时长

接口 API

代码示例

跳转进度

接口 API

接口入参

参数名称	是否必须	示例	备注
position	是	0	跳转时间不要超过总时长

代码示例

当前播放器状态

接口 API

返回值

参数名称	备注
Constants.State.NONE	没有开播
Constants.State.IDLE	闲置
Constants.State.START	开始
Constants.State.PAUSE	暂停
Constants.State.STOP	停止
Constants.State.BUFFER	缓冲
Constants.State.END	播放完成

代码示例

暂停播放

接口 API

代码示例

销毁直播间

接口 API

代码示例

直播事件回调

VHPlayerListener

状态码说明-onStateChanged

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

事件码说明-eventCode

事件码	描述
Constants.Event .EVENT_DOWNLOAD_SPEED	下载速度
Constants.Event .EVENT_DPI_CHANGED	分辨率切换
Constants.Event .EVENT_DPI_LIST	支持的分辨率
Constants.Event .EVENT_VIDEO_SIZE_CHANGED	视频的宽高
ErrorCode .ERROR_LOGIN_MORE	被其他人踢出
Watch.EVENT_INIT_PLAYER_SUCCESS	播放器初始化成功

错误码说明-errorCode

错误码	描述
Push.ERROR_NOT_INIT	初始化视频信息失败（没有设置活动信息）

代码示例

附加信息

屏幕保持常亮

设置观看布局

<com.vhall.player.vod.VodPlayerView
        android:id="@+id/surface_view"
        android:layout_width="match_parent"
        android:layout_height="match_parent" />

播放器设置背景
因为回放播放器本身是透明的所以可以直接设置回放播放器父容器的颜色或背景图。

注意事项#

暖场视频关键步骤#

核心类#

关键方法#

初始化直播间信息#

获取暖场视频详情#

WarmInfoData 暖场视频信息#

暖场视频详情#

初始化暖场视频实例#

内部变量说明#

设置直播间详情#

本地预览填充模式#

设置分辨率#

播放状态#

开始观看#

设置观看倍速#

获取当前进度时间#

获取总时长#

跳转进度#

当前播放器状态#

返回值#

暂停播放#

销毁直播间#

直播事件回调#

状态码说明-onStateChanged#

事件码说明-eventCode#

错误码说明-errorCode#

附加信息#

注意事项

暖场视频关键步骤

核心类

关键方法

初始化直播间信息

获取暖场视频详情

WarmInfoData 暖场视频信息

暖场视频详情

初始化暖场视频实例

内部变量说明

设置直播间详情

本地预览填充模式

设置分辨率

播放状态

开始观看

设置观看倍速

获取当前进度时间

获取总时长

跳转进度

当前播放器状态

返回值

暂停播放

销毁直播间

直播事件回调

状态码说明-onStateChanged

事件码说明-eventCode

错误码说明-errorCode

附加信息