互动直播 API

属性	属性描述
[VHRtcSDK.getInstance()]	互动关键方法
VhallXComponentView	互动显示 view
VHRTCCallback	互动房间回调
imReceiveRoomMessage	房间消息回调
imReceiveChatMessage	聊天消息回调
imReceiveOnlineMessage	接收上下线消息
imReceiveCustomMessage	接收自定义消息

关键方法

方法	方法描述
VHRtcSDK.getInstance().init	连麦初始化直播间信息,成功之后才能进行后续接口调用
VHSaaSDK.getInstance().getLiveInit	主持人获取房间信息
VHSaaSDK.getInstance().loginByRole	嘉宾登录
VHRtcSDK.getInstance().enterRoom	进入互动房间
VHRtcSDK.getInstance().exitRoom	退出互动房间
VHRtcSDK.getInstance().createLocalStream	设置本地流
VHRtcSDK.getInstance().stopLocalPreview	停止本地摄像头采集
VHRtcSDK.getInstance().speak	上麦
VHRtcSDK.getInstance().apply/cancelApply	申请上麦操作
VHRtcSDK.getInstance().agreeInvite	同意上麦申请
VHRtcSDK.getInstance().rejectInvite	拒绝上麦申请
VHRtcSDK.getInstance().setDocPermission	设置主讲人/文档控制权限
VHRtcSDK.getInstance().invite	邀请上麦
VHRtcSDK.getInstance().getSpeakList	获取当前上麦用户列表
VHRtcSDK.getInstance().setHandSup	设置房间举手状态
VHRtcSDK.getInstance().setMainScreen	设置互动模式下直播主画面
VHSaaSDK.getInstance().getKickedList	获取踢出用户列表
VHSaaSDK.getInstance().getBannedList	获取禁言用户列表
VHSaaSDK.getInstance().getSpecialList	获取受限列表
VHSaaSDK.getInstance().getOnlineList	获取在线列表
VHRtcSDK.getInstance().userNoSpeak	下麦
VHRtcSDK.getInstance().agreeApply	允许用户上麦
VHRtcSDK.getInstance().rejectApply	拒绝用户上麦
VHRtcSDK.getInstance().switchCamera	翻转相机
VHRtcSDK.getInstance().publish	开始推流
VHRtcSDK.getInstance().unPublish	停止推流
VHRtcSDK.getInstance().subScribeRemoteView	订阅远端流
VHRtcSDK.getInstance().updateRemoteView	更新远端流画面
VHRtcSDK.getInstance().stopRemoteView	停止订阅远端流
VHRtcSDK.getInstance().stopAllRemoteView	停止订阅所有远端流
VHRtcSDK.getInstance().setVideoEncode	设置本地流分辨率
VHRtcSDK.getInstance().createLocalStream	获取本地流
VHRtcSDK.getInstance().setDeviceStatus	设置房间设备状态
VHRtcSDK.getInstance().muteLocalVideo	设置摄像头开关
VHRtcSDK.getInstance().muteLocalAudio	设置麦克风开关
VHRtcSDK.getInstance().setMirrorType	设置镜像
VHBeautySDK.getInstance().enableCustomVideoProcess	是否开启自定义视频处理。如果使用美颜，需要调用此方法开启并监听回调
VHBeautySDK.getInstance().init	设置美颜
VHRtcSDK.getInstance().getWebinarLiveStart	开始直播
VHRtcSDK.getInstance().getWebinarLiveEnd	结束直播
VHRtcSDK.getInstance().destroy()	销毁互动房间

关键消息

通过IM回调imReceiveRoomMessage监听房间消息

消息	消息描述
MESSAGE_VRTC_CONNECT_INVITE	互动连麦邀请消息
MESSAGE_VRTC_CONNECT_INVITE_AGREE	互动连麦连接邀请同意
MESSAGE_VRTC_CONNECT_INVITE_REFUSED	拒绝互动连麦邀请
MESSAGE_VRTC_CONNECT_APPLY	用户上麦申请
MESSAGE_VRTC_CONNECT_APPLY_CANCEL	用户取消上麦申请
MESSAGE_VRTC_CONNECT_AGREE	互动连麦同意上麦消息
MESSAGE_VRTC_SPEAKER_SWITCH	互动设置主讲人
MESSAGE_VRTC_CONNECT_SUCCESS	用户上麦消息
MESSAGE_VRTC_DISCONNECT_SUCCESS	用户下麦
MESSAGE_VRTC_MUTE	静音某路流
MESSAGE_VRTC_MUTE_CANCEL	取消静音某路流
MESSAGE_VRTC_FRAMES_FORBID	禁止显示某路流的画面
MESSAGE_VRTC_FRAMES_DISPLAY	显示某路流的画面

主持人获取房间信息

接口 API

接口入参

参数名称	是否必须	示例	备注
webinarId	是	234700561	活动 id 在网页上创建
nickName	是	"name"	昵称
email	是	123456	邮箱
VHWatchWebinarInfoCallback	是

代码示例

嘉宾登录

接口 API

接口入参

参数名称	是否必须	示例	备注
webinar_id	是	234700561	活动 id 在网页上创建
password	是	123456	口令
nickName	是	"name"	昵称
avatar	是	头像	头像
type	是	2	类型角色（2-嘉宾）
VHCallBack	是

代码示例

初始化直播间信息

只有正在直播的活动才可以进入成功。初始化成功之后才能创建本地流

接口 API

接口入参

参数名称	是否必须	备注
context	是	应用context
WebinarInfo	是	活动详情
callback	是	链接互动房间成功回调
initCb	是	接口成功失败回调

代码示例

设置本地流

创建本地流。开启摄像头和麦克风采集

接口 API

接口入参

参数名称	是否必须	备注
frontCamera	是	true：前置摄像头；false：后置摄像头
view	是	互动流的显示 view
controller	是

停止本地摄像头采集

停止摄像头采集和麦克风采集

接口 API

进入互动房间

当进需要进行互动连麦时调用此方法，此方法将与互动服务建立起长链接。进入房间成功后才能进行本地推流和远端流订阅

接口 API

代码示例

退出互动房间

当进入互动房间后，如果不再需要拉取互动连麦的音视频，需要调用此方法退出房间。

接口 API

代码示例

上麦

此接口需要在以下两种情况进行使用
1.
主持人向你发起邀请上麦，同意上麦后调用
2.
向主持人发起申请上麦，主持人同意后，接收到同意上麦消息

接口 API

代码示例

申请上麦操作

接口 API

接口入参

参数名称	是否必须	示例	备注
roomId	是	123456789	房间id
callback	是

代码示例

同意上麦申请

接口 API

接口入参

参数名称	是否必须	示例	备注
roomId	是	123456789	房间 id
callback	是

代码示例

拒绝上麦申请

接口 API

接口入参

参数名称	是否必须	示例	备注
roomId	是	123456789	房间 id
callback	是

代码示例

设置主讲人

接口 API

接口入参

参数名称	是否必须	示例	备注
roomId	是	123456789	房间 id
receive_account_id	是	123456789	设置的 id
callback	是

代码示例

邀请上麦

接口 API

接口入参

参数名称	是否必须	示例	备注
roomId	是	123456789	房间 id
receive_account_id	是	123456789	邀请的 id
callback	是

代码示例

获取当前上麦用户列表

接口 API

接口入参

参数名称	是否必须	示例	备注
roomId	是	12345	房间 id
callback	是

代码示例

设置房间举手状态

接口 API

接口入参

参数名称	是否必须	示例	备注
roomId	是	12345	房间 id
status	是	1	举手状态 1允许0禁止
callback	是

代码示例

设置互动模式下直播主画面

接口 API

接口入参

参数名称	是否必须	示例	备注
roomId	是	12345	房间 id
receive_account_id	是	12345	参会用户的uid
callback	是

代码示例

允许用户上麦

接口 API

接口入参

参数名称	是否必须	示例	备注
roomId	是	12345	房间 id
receive_account_id	是	12345	参会用户的uid
callback	是

拒绝用户上麦

接口 API

接口入参

参数名称	是否必须	示例	备注
roomId	是	12345	房间 id
receive_account_id	是	12345	参会用户的uid
callback	是

获取禁言用户列表

接口 API

接口入参

参数名称	是否必须	示例	备注
roomId	是	12345	房间 id
pos	是	1	页码
limit	是	20	获取条目数量，最大 100
group_room_id	是		分组room_id
keyword	是		昵称搜索内容
callback	是

代码示例

获取踢出用户列表

接口 API

接口入参

参数名称	是否必须	示例	备注
roomId	是	12345	房间 id
pos	是	1	页码
limit	是	20	获取条目数量，最大 100
keyword	是		昵称搜索内容
global_kicked	是		获取是否全局 0:房间踢出用户 1:全局踢出用户不传获取全部
order_type	是		1.参会用户最近更新时间倒序
callback	是

代码示例

获取受限列表

接口 API

接口入参

参数名称	是否必须	示例	备注
roomId	是	12345	房间 id
pos	是	1	页码
limit	是	20	获取条目数量，最大 100
callback	是

代码示例

获取在线列表

接口 API

接口入参

参数名称	是否必须	示例	备注
roomId	是	12345	房间 id
pos	是	1	页码
limit	是	20	获取条目数量，最大 100
callback	是

代码示例

自己发送下麦消息

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

接口 API

接口入参

参数名称	是否必须	示例	备注
roomId	是	12345	房间 id
callback	是

代码示例

下麦

被踢出或者被下麦调用--修改自己的互动上麦状态

接口 API

接口入参

参数名称	是否必须	示例	备注
roomId	是	12345	房间 id
receive_account_id	是	12345	被下麦的用户的参会用户的 id
callback	是

代码示例

翻转相机

接口 API

代码示例

开始推流

接口 API

代码示例

停止推流

接口 API

代码示例

订阅远端流

接口 API

接口入参

参数名称	是否必须	备注
stream_id	是	流id,一个音视频流的唯一标识
stream_type	是	流类型
view	是	对应VhallXComponentView设置的id
controller	是	对应VhallXComponentView 回调返回的对象

代码示例

更新远端流画面

接口 API

接口入参

参数名称	是否必须	备注
stream_id	是	流id,一个音视频流的唯一标识
view	是	对应VhallXComponentView设置的id
controller	是	对应VhallXComponentView 回调返回的对象

代码示例

停止订阅远端流

接口 API

接口入参

参数名称	是否必须	示例	备注
stream_id	是		流id,一个音视频流的唯一标识

停止订阅所有远端流

接口 API

设置本地流分辨率

接口 API

接口入参

参数名称	是否必须	示例	备注
profile	是		清晰度
mode	是		横竖屏设置

清晰度说明

枚举值	推流清晰度
VHPushConfigProfile_Resolution_320_180	104
VHPushConfigProfile_Resolution_640_360	108
VHPushConfigProfile_Resolution_960_540	110
VHPushConfigProfile_Resolution_1280_720	112
VHPushConfigProfile_Resolution_1920_1080	114

代码示例

设置房间设备状态

接口 API

接口入参

参数名称	是否必须	示例	备注
roomId	是	12345	房间 id
receive_account_id	是	12345	被选择用户的参会id
device	是	1	设备 1 麦克风 2 摄像头
status	是	1	0关闭 1打开
callback	是

代码示例

设置摄像头开关

接口 API

代码示例

设置麦克风开关

接口 API

代码示例

设置镜像

此方法会触发预览画面与推出的流画面一起镜像

接口 API

接口入参

参数名称	是否必须	示例	备注
mirror	是	false	是否开启镜像 true 开启

代码示例

本地预览填充模式

接口 API

接口入参

参数名称	是否必须	示例	备注
mode	是	VhallRTCVideoFillMode.VHRTCVideoFillMode_Fill	本地预览填充模式

代码示例

适配类型	描述
VhallRTCVideoFillMode.VHRTCVideoFillMode_Fill	填满
VhallRTCVideoFillMode.VHRTCVideoFillMode_Fit	等比缩放

开启自定义视频处理

接口 API

接口入参

参数名称	是否必须	示例	备注
enable	是	true: 开启自定义视频处理。需要监听回调 onCaptureFrame

设置美颜

接口 API

代码示例
基础美颜设置方法

开始直播

接口 API

接口入参

参数名称	是否必须	示例	备注
webinar_id	是	234700561	活动 id 在网页上创建
start_type	是	"2"
live_type	是	"0"	直播类型：0-正式直播（默认）；2-彩排
callback	是

代码示例

结束直播

主持人退出互动房间必须调用

接口 API

接口入参

参数名称	是否必须	示例	备注
webinar_id	是	234700561	活动 id 在网页上创建
end_type	是	"2"
live_type	是	"0"	直播类型：0-正式直播（默认）；2-彩排
callback	是

代码示例

销毁互动房间

退出互动房间必须调用

接口 API

代码示例

互动房间回调

方法	描述
onConnectRoom	链接互动房间成功。进入房间成功后再进行推流拉流操作
onConnectionRoomLost	SDK 与互动服务器的连接已经断开
onReconnectRoom	SDK 正在尝试重新连接互动服务器
onConnectionRecovery	SDK 与互动服务器链接恢复
onError	错误
onWarning	警告事件回调
onPublishStreamSuccess	推流成功回调
onUnPublishStreamSuccess	停止推流回调
onRemoteStreamAdd	远端流加入,之后可以订阅远端用户的音视频流
onRemoteStreamRemoved	远端用户流已停止，可以根据业务销毁渲染窗口
onSubScribeStreamSuccess	订阅远端用户远端流订阅成功
onSubScribeStreamFailed	远端流订阅失败
onUnSubScribeStreamSuccess	取消订阅远端流
onUserVideoAvailable	视频是否可用。根据此回调状态，可以判断当前用户是否推流视频流
onUserAudioAvailable	音频是否可用。根据此回调状态，可以判断当前用户是否推流音频流
onUserStatistics	丢包率统计
onUserAudioVolume	用户的音量
onPublishStreamFailed	推流失败回调
onUnPublishStreamFailed	停止推流失败
onUnSubScribeStreamFailed	取消订阅远端流
onCaptureFrame	自定义采集处理回调

代码示例

互动显示view

方法	类型	描述
xComponentId	string	控件的唯一标识
type	number	rtc类型，固定使用VHRtcSDK.getInstance().getRtcType()方法
componentListener	VHXComponentCallback	回调类，通过此回调获取controller

互动直播API

互动直播 API#

关键方法#

关键消息#

主持人获取房间信息#

嘉宾登录#

初始化直播间信息#

设置本地流#

停止本地摄像头采集#

进入互动房间#

退出互动房间#

上麦#

申请上麦操作#

同意上麦申请#

拒绝上麦申请#

设置主讲人#

邀请上麦#

获取当前上麦用户列表#

设置房间举手状态#

设置互动模式下直播主画面#

允许用户上麦#

拒绝用户上麦#

获取禁言用户列表#

获取踢出用户列表#

获取受限列表#

获取在线列表#

自己发送下麦消息#

下麦#

翻转相机#

开始推流#

停止推流#

订阅远端流#

更新远端流画面#

停止订阅远端流#

停止订阅所有远端流#

设置本地流分辨率#

清晰度说明#

设置房间设备状态#

设置摄像头开关#

设置麦克风开关#

设置镜像#

本地预览填充模式#

开启自定义视频处理#

设置美颜#

开始直播#

结束直播#

销毁互动房间#

互动房间回调#

互动显示view#

互动直播 API

关键方法

关键消息

主持人获取房间信息

嘉宾登录

初始化直播间信息

设置本地流

停止本地摄像头采集

进入互动房间

退出互动房间

上麦

申请上麦操作

同意上麦申请

拒绝上麦申请

设置主讲人

邀请上麦

获取当前上麦用户列表

设置房间举手状态

设置互动模式下直播主画面

允许用户上麦

拒绝用户上麦

获取禁言用户列表

获取踢出用户列表

获取受限列表

获取在线列表

自己发送下麦消息

下麦

翻转相机

开始推流

停止推流

订阅远端流

更新远端流画面

停止订阅远端流

停止订阅所有远端流

设置本地流分辨率

清晰度说明

设置房间设备状态

设置摄像头开关

设置麦克风开关

设置镜像

本地预览填充模式

开启自定义视频处理

设置美颜

开始直播

结束直播

销毁互动房间

互动房间回调

互动显示view