互动直播 API

属性	属性描述
InterActive	互动关键方法
VHRenderView	互动显示 view
Stream	互动流
RoomCallback	互动房间回调
MessageServer#Callback	房间消息回调
ChatServer#Callback	聊天消息回调

关键方法

方法	方法描述
initBroadcast()	主持人获取房间信息
joinWebinar	嘉宾登录
InterActive()	初始化互动
interactive.init	连麦初始化直播间信息
interactive.broadCastRoom	互动推流
interactive.setMixLayoutMode	修改混流布局
interactive.setLocalView	设置本地流
interactive.enterRoom	进入互动房间
interactive.publish	上麦
interactive.sendQuestion	发送问答消息
interactive.onRaiseHand	申请上麦/取消申请上麦操作
interactive.replyInvitation	回应互动邀请
interactive.agreeApply	同意上麦申请
interactive.rejectApply	拒绝上麦申请
interactive.getDocList	获取文档列表
interactive.setMainSpeaker	设置主讲人
interactive.invite	邀请上麦
interactive.getLimitUserList	获取受限列表（禁言/踢出）
interactive.invite	获取在线列表
interactive.setKickOut	踢人
interactive.setBanned	禁言
interactive.acquireChatRecord	获取历史聊天记录
interactive.unpublish	自己发送下麦消息
interactive.unpublished	下麦
interactive.switchCamera	翻转相机
interactive.setDefinition	设置本地流分辨率
interactive.getLocalStream	获取本地流
interactive.switchDevice	发送摄像头/麦克风开关消息
Stream.muteVideo/unmuteVideo	设置摄像头开关
Stream.muteAudio/unmuteAudio	设置麦克风开关
VHRenderView.setMirror	设置镜像
VHRenderView.setScalingMode	本地预览填充模式
interactive.sendMsg	发送聊天
interactive.sendCustom	发送自定义消息
interactive.startDocCloudRender	开启文档融屏
interactive.stopDocCloudRender	关闭文档融屏
Stream.setBeautifyLevel	设置美颜
interactive.setListener	设置互动监听
VhallSDK.finishBroadcast	结束直播
interactive.onDestroy	销毁互动房间

主持人获取房间信息

接口 API

接口入参

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

代码示例

嘉宾登录

接口 API

接口入参

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

代码示例

初始化互动

只有正在直播的活动才可以进入成功

接口 API

接口入参

参数名称	是否必须	示例	备注
Context	是	context	上下问对象
RoomCallback	是		互动房间回调
ChatServer.Callback	否		聊天监听
MessageServer.Callback	否		消息监听

代码示例

初始化直播间信息

只有正在直播的活动才可以进入成功

接口 API

接口入参

参数名称	是否必须	示例	备注
WebinarInfo	是		活动详情
round	否		当前是互动还是轮巡

接口入参

参数名称	是否必须	示例	备注
id	是	234700561	活动 id 在网页上创建
email	否	123456	邮箱
nickName	否	" name"	昵称
password	否	123	密码/k 值
k_id	否	123	k_id 值

代码示例

互动混流

接口 API

接口入参

参数名称	是否必须	示例	备注
type	是	1	1-发直播 2 结束直播
layoutType	否	VHInteractive.CANVAS_LAYOUT_PATTERN_GRID_1	当前布局
rehearsal	否	false	当前活动是不是彩排默认直播

layoutType

可配置旁路画面布局	说明
CANVAS_LAYOUT_PATTERN_GRID_1	一人铺满
CANVAS_LAYOUT_PATTERN_GRID_2_H	左右两格
CANVAS_LAYOUT_PATTERN_GRID_3_E	正品字
CANVAS_LAYOUT_PATTERN_GRID_3_D	倒品字
CANVAS_LAYOUT_PATTERN_GRID_4_M	2 行 x2 列
CANVAS_LAYOUT_PATTERN_GRID_5_D	2 行，上 2 下 3
CANVAS_LAYOUT_PATTERN_GRID_6_E	2 行 x3 列
CANVAS_LAYOUT_PATTERN_GRID_9_E	3 行 x3 列
CANVAS_LAYOUT_PATTERN_FLOAT_2_1DR	主次悬浮，大屏铺满，小屏悬浮右下角 (小窗宽=画布宽度/5，比例
CANVAS_LAYOUT_PATTERN_FLOAT_2_1DL	主次悬浮，大屏铺满，小屏悬浮左下角 (小窗宽=画布宽度/5，比例
CANVAS_LAYOUT_PATTERN_FLOAT_3_2DL	大屏铺满，2 小屏悬浮右上角 (小窗宽=画布宽度/6，比例为 4:3)
CANVAS_LAYOUT_PATTERN_FLOAT_6_5D	主次悬浮，大屏铺满，一行 5 个悬浮于下面(小窗宽=画布宽度/5，比例为 4:3)
CANVAS_LAYOUT_PATTERN_FLOAT_6_5T	主次悬浮，大屏铺满，一行 5 个悬浮于上面(小窗宽=画布宽度/5，比例为 4:3)
CANVAS_LAYOUT_PATTERN_TILED_5_1T4D	主次平铺，一行 4 个位于底部
CANVAS_LAYOUT_PATTERN_TILED_5_1D4T	主次平铺，一行 4 个位于顶部
CANVAS_LAYOUT_PATTERN_TILED_5_1L4R	主次平铺，一列 4 个位于右边
CANVAS_LAYOUT_PATTERN_TILED_5_1R4L	主次平铺，一列 4 个位于左边
CANVAS_LAYOUT_PATTERN_TILED_6_1T5D	主次平铺，一行 5 个位于底部
CANVAS_LAYOUT_PATTERN_TILED_6_1D5T	主次平铺，一行 5 个位于顶部
CANVAS_LAYOUT_PATTERN_TILED_9_1L8R	主次平铺，右边为（2 列 x4 行=8 个块）
CANVAS_LAYOUT_PATTERN_TILED_9_1R8L	主次平铺，左边为（2 列 x4 行=8 个块）
CANVAS_LAYOUT_PATTERN_TILED_13_1L12R	主次平铺，右边为（3 列 x4 行=12 个块）
CANVAS_LAYOUT_PATTERN_TILED_17_1TL16GRID	主次平铺，1V16，主屏在左上角
CANVAS_LAYOUT_PATTERN_TILED_9_1D8T	主次平铺，主屏在下，8 个（2 行 x4 列）在上
CANVAS_LAYOUT_PATTERN_TILED_13_1TL12GRID	主次平铺，主屏在左上角，其余 12 个均铺于其他剩余区域
CANVAS_LAYOUT_PATTERN_TILED_17_1TL16GRID_E	主次平铺，主屏在左上角，其余 16 个均铺于其他剩余区域
CANVAS_LAYOUT_PATTERN_CUSTOM	自定义，当使用坐标布局接口时，请使用此
CANVAS_LAYOUT_EX_PATTERN_GRID_12_E	3 行 4 列等分布局
CANVAS_LAYOUT_EX_PATTERN_GRID_16_E	4 行 4 列等分布局
CANVAS_LAYOUT_EX_PATTERN_FLOAT_2_1TR	主次悬浮，大屏铺满，小屏悬浮右上角(小窗宽=画布宽度/5，比例为 4:3)支持竖版布局，参考 PaaS 需求： paas pm
CANVAS_LAYOUT_EX_PATTERN_FLOAT_2_1TL	主次悬浮，大屏铺满，小屏悬浮左上角(小窗宽=画布宽度/5，比例为 4:3)支持竖版布局，参考 PaaS 需求： paas pm
CANVAS_ADAPTIVE_LAYOUT_GRID_MODE	均分布局
CANVAS_ADAPTIVE_LAYOUT_TILED_MODE	平铺模式
CANVAS_ADAPTIVE_LAYOUT_FLOAT_MODE	悬浮模式
CANVAS_ADAPTIVE_LAYOUT_TILED_TOP_MAX16	文档布局模式, 窗格位于主屏上方，最多 16 窗格

代码示例

修改混流布局

接口 API

接口入参

参数名称	是否必须	示例	备注
layoutType	是	VHInteractive.CANVAS_LAYOUT_PATTERN_GRID_1	当前布局(建议使用 pc 端设置的布局) 活动详情

代码示例

设置本地流

自己的互动画面

接口 API

接口入参

参数名称	是否必须	示例	备注
VHRenderView	否		互动流的显示 view
Stream.VhallStreamType	是	123456	邮箱
attributes	否		互动流之前传递的内容通过 stream.getAttributes()获取

Stream.VhallStreamType

适配类型	描述
Stream.VhallStreamType.VhallStreamTypeOnlyAudio	互动流只有音频
Stream.VhallStreamType.VhallStreamTypeOnlyVideo	互动流只有视频
Stream.VhallStreamType.VhallStreamTypeAudioAndVideo	互动流有音视频
Stream.VhallStreamType.VhallStreamTypeScreen	屏幕共享流
Stream.VhallStreamType.VhallStreamTypeFile	插播视频流
Stream.VhallStreamType.VhallStreamTypeVideoPatrol	轮巡流

代码示例

Stream.StreamDelegate

本地流回调，主要是相机使用情况回调

Stream#VhallStreamEventType

适配类型	描述
Stream.VhallStreamEventType.VhallStreamEventTypeCameraError	互动流只有音频
Stream.VhallStreamEventType.CameraDisconnected	互动流只有视频
Stream.VhallStreamEventType.CameraFreezed	互动流有音视频
Stream.VhallStreamEventType.CameraOpening	屏幕共享流
Stream.VhallStreamEventType.CameraFirstFrameAvailable	插播视频流
Stream.VhallStreamEventType.CameraClosed	轮巡流

代码示例

进入互动房间

接口 API

代码示例

上麦

有人邀请，你同意

你申请主持人同意

接口 API

代码示例

发送问答消息

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

接口 API

接口入参

参数名称	是否必须	示例	备注
content	是	问题	提问的问题内容

代码示例

申请上麦/取消申请上麦操作

接口 API

接口入参

参数名称	是否必须	示例	备注
webinarId	是	123456789	活动 id
type	是	1	类型 1 申请 2 取消申请

代码示例

回应互动邀请

接口 API

接口入参

参数名称	是否必须	示例	备注
webinarId	是	123456789	活动 id
type	是	1	类型 1 接受，2 拒绝，3 超时失败

代码示例

同意上麦申请

接口 API

接口入参

参数名称	是否必须	示例	备注
receive_account_id	是	123456789	申请人的 id

代码示例

拒绝上麦申请

接口 API

接口入参

参数名称	是否必须	示例	备注
receive_account_id	是	123456789	申请人的 id

代码示例

获取文档列表

接口 API

接口入参

参数名称	是否必须	示例	备注
page	是	1	页码从 1 开始
limit	否	20	获取条目数量，最大 100
keyword	否		检索使用
DocListInfoData			返回数据

DocListInfoData

参数名称	备注
total	总数
List#DetailBean	列表数据

DocListInfoData#DetailBean

参数名称	备注
document_id	文档 id
file_name	文档名称
page	页数
ext	文档类型 doc、docx、ppt、pptx、xlsx、xls
size	文档大小
created_at	时间
document_id	文档 id
file_name	文档名称

代码示例

设置主讲人

接口 API

接口入参

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

代码示例

邀请上麦

接口 API

接口入参

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

代码示例

获取受限列表

接口 API

接口入参

参数名称	是否必须	示例	备注
page	是	1	页码
limit	是	20	获取条目数量，最大 100
UserStateListData			返回数据

代码示例

获取在线列表

接口 API

接口入参

参数名称	是否必须	示例	备注
page	是	1	页码
limit	是	20	获取条目数量，最大 100
UserStateListData			返回数据

代码示例

踢人

接口 API

接口入参

参数名称	是否必须	示例	备注
receive_account_id	是	123456789	邀请的 id
status	是	1	1 踢出 0 取消踢出

代码示例

禁言

接口 API

接口入参

参数名称	是否必须	示例	备注
receive_account_id	是	123456789	邀请的 id
status	是	1	1 禁言 0 取消禁言

代码示例

获取历史聊天记录

接口 API

接口入参

参数名称	是否必须	示例	备注
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

代码示例

自己发送下麦消息

接口成功之后在消息监听里面接收自己下麦的消息，操作下麦

接口 API

代码示例

下麦

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

接口 API

代码示例

翻转相机

接口 API

代码示例

设置本地流分辨率

建议 6.5.1 之后不再设置清晰度

若需要使用自动切换清晰度功能，则在创建 InterActive 对象时不要主动调用 setDefinition(int)方法：

InterActive#setDefinition(int)方法调用后，动态清晰度立即失效。

接口 API

接口入参

参数名称	是否必须	示例	备注
definition	是	3

清晰度说明

数字	推流清晰度
0	192x144
1	240x160
2	320x240
3	480x360
4	570x432
5	640x480

代码示例

获取本地流

获取自己之前设置的本地流

接口 API

代码示例

发送摄像头/麦克风开关消息

接口成功之后在消息监听里面接收自己的消息,然后自己设置对应的设备开关

接口 API

接口入参

参数名称	是否必须	示例	备注
device	是	1	设备 1 麦克风 2 摄像头
type	是	1	0 关闭 1 开启

代码示例

设置摄像头开关

接口 API

代码示例

设置麦克风开关

接口 API

代码示例

设置镜像

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

接口 API

接口入参

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

代码示例

设置预览画面镜像

接口 API

接口入参

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

代码示例

本地预览填充模式

接口 API

接口入参

参数名称	是否必须	示例	备注
scalingMode	是	SurfaceViewRenderer.VHRenderViewScalingMode.kVHRenderViewScalingModeAspectFit	本地预览填充模式

代码示例

适配类型	描述
SurfaceViewRenderer.VHRenderViewScalingMode.kVHRenderViewScalingModeNone	默认
SurfaceViewRenderer.VHRenderViewScalingMode.kVHRenderViewScalingModeAspectFit	自适应居中
SurfaceViewRenderer.VHRenderViewScalingMode.kVHRenderViewScalingModeAspectFill	铺满全屏

发送聊天

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

接口 API

接口入参

参数名称	是否必须	示例	备注
msg	是	消息内容	消息内容
type	否	VHIM.TYPE_TEXT	可以不写

代码示例

发送自定义消息

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

接口 API

接口入参

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

代码示例

开启文档融屏

建议主持人/主讲人在活动开启了融屏，并且当前有文档演示，并且文档对观众可见的时候开启

接口 API

代码示例

关闭文档融屏

接口 API

代码示例

设置美颜

接口 API

接口入参

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

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

设置互动监听

接口 API

互动特殊事件通知

参数字段	描述
ERROR_LOGIN_MORE	被其他人踢出

代码示例

结束直播

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

接口 API

接口入参

参数名称	是否必须	示例	备注
id	是	234700561	活动 id 在网页上创建
accessToken	否	" name"	昵称
broadcast	否	123456	邮箱
rehearsal	否	false	当前是否是彩排

代码示例

销毁互动房间

退出互动房间必须调用

接口 API

代码示例

互动房间回调

方法	描述
onDidConnect	进入房间成功
onDidError	进入房间失败
onDidPublishStream	自己推流成功
onDidUnPublishStream	自己下麦暂停推流
onDidSubscribeStream	收到其他人的流加入
onDidRoomStatus	房间状态改动
onDidRemoveStream	其他人的流移除
onDidInternalStreamAdded	开启文档融屏后，收到文档流 6.9.0 文档融屏新增
onDidInternalStreamRemoved	关闭文档融屏后，文档流移除 6.9.0 文档融屏新增
onDidInternalStreamFailed	融屏失败回调 6.9.0 文档融屏新增

代码示例

互动显示 view

stream-关键方法

方法	描述
removeAllRenderView	清空绑定的 view
addRenderView	设置显示的 view
getAttributes	获取创建本地流时候设置的 Attributes 可用于获取昵称角色等
muteStream	获取本地流的设备状态摄像头和麦克风
remoteMuteStream	获取远端流的设备状态摄像头和麦克风
setMixLayoutMainScreen	设置当前流为混流布局中的大画面（主持人和主讲人才可以设置）
VhallStreamType	当前的流类型，创建直播的时候必穿参数

Stream.VhallStreamType

适配类型	描述
Stream.VhallStreamType.VhallStreamTypeOnlyAudio	互动流只有音频
Stream.VhallStreamType.VhallStreamTypeOnlyVideo	互动流只有视频
Stream.VhallStreamType.VhallStreamTypeAudioAndVideo	互动流有音视频
Stream.VhallStreamType.VhallStreamTypeScreen	屏幕共享流
Stream.VhallStreamType.VhallStreamTypeFile	插播视频流
Stream.VhallStreamType.VhallStreamTypeVideoPatrol	轮巡流

互动直播API

互动直播 API#

关键方法#

主持人获取房间信息#

嘉宾登录#

初始化互动#

初始化直播间信息#

互动混流#

layoutType#

修改混流布局#

设置本地流#

Stream.VhallStreamType#

Stream.StreamDelegate#

进入互动房间#

上麦#

发送问答消息#

申请上麦/取消申请上麦操作#

回应互动邀请#

同意上麦申请#

拒绝上麦申请#

获取文档列表#

DocListInfoData#

DocListInfoData#DetailBean#

设置主讲人#

邀请上麦#

获取受限列表#

获取在线列表#

踢人#

禁言#

获取历史聊天记录#

自己发送下麦消息#

自己发送下麦消息#

下麦#

翻转相机#

设置本地流分辨率#

清晰度说明#

获取本地流#

发送摄像头/麦克风开关消息#

设置摄像头开关#

设置麦克风开关#

设置镜像#

设置预览画面镜像#

本地预览填充模式#

发送聊天#

发送自定义消息#

开启文档融屏#

关闭文档融屏#

设置美颜#

设置互动监听#

互动特殊事件通知#

结束直播#

销毁互动房间#

互动房间回调#

互动显示 view#

stream-关键方法#

互动直播 API

关键方法

主持人获取房间信息

嘉宾登录

初始化互动

初始化直播间信息

互动混流

layoutType

修改混流布局

设置本地流

Stream.VhallStreamType

Stream.StreamDelegate

进入互动房间

上麦

发送问答消息

申请上麦/取消申请上麦操作

回应互动邀请

同意上麦申请

拒绝上麦申请

获取文档列表

DocListInfoData

DocListInfoData#DetailBean

设置主讲人

邀请上麦

获取受限列表

获取在线列表

踢人

禁言

获取历史聊天记录

自己发送下麦消息

自己发送下麦消息

下麦

翻转相机

设置本地流分辨率

清晰度说明

获取本地流

发送摄像头/麦克风开关消息

设置摄像头开关

设置麦克风开关

设置镜像

设置预览画面镜像

本地预览填充模式

发送聊天

发送自定义消息

开启文档融屏

关闭文档融屏

设置美颜

设置互动监听

互动特殊事件通知

结束直播

销毁互动房间

互动房间回调

互动显示 view

stream-关键方法