微吼开放平台
平台概述
开发者文档
开发者文档
  • 嵌入指南
  • SDK文档
  • 服务端API
产品功能
产品功能
  • 新手入门
  • 功能介绍
  • 常见问题
微吼官网
平台概述
开发者文档
开发者文档
  • 嵌入指南
  • SDK文档
  • 服务端API
产品功能
产品功能
  • 新手入门
  • 功能介绍
  • 常见问题
微吼官网
  1. web 观播 sdk
  • 示例
  • JS SDK
    • web 观播 sdk
      • 简介
      • 接入必读
      • 对接示例
      • 活动详情
      • 观看直播
      • 文档白板
      • 暖场视频
      • 回放章节
      • 互动连麦
      • 资料下载
      • 观看限制
      • 观看协议
      • 全局事件
      • 互动工具
        • 互动-聊天
        • 互动-抽奖
        • 互动-礼物
        • 互动-签到
        • 互动-问卷
        • 互动-公告
        • 互动-商品
        • 互动-问答
        • 互动-点赞
        • 互动-优惠券
        • 互动-推屏卡片
        • 互动-快问快答
      • 扩展能力
        • 屏蔽观众端画面与音频
          • 屏蔽画面与音频
      • 其他资料
        • 更新记录
        • 全局错误码
    • web 点播上传 sdk
      • 点播SDK
      • 更新记录
  • iOS SDK
    • 简介
    • 快速接入
    • SDK登录
    • 暖场视频
    • 视频轮询
    • 直播彩排
    • 高级美颜
    • 云导播
    • 观看协议
    • 文档白板演示
    • 聊天功能
    • 视频直播
      • 发起视频直播
      • 观看视频直播
    • 互动直播
      • 观众互动
      • 推流摄像头
      • 互动直播API
      • 主播发起互动直播
      • 嘉宾加入互动直播
    • 无延迟直播
      • 主播发起无延迟直播
      • 观众观看无延迟直播
    • 互动工具
      • 互动-抽奖
      • 互动-礼物
      • 互动-签到
      • 互动-问卷
      • 互动-章节打点
      • 互动-公告
      • 互动-商品
      • 互动-计时器
      • 互动-问答
      • 互动-推屏卡片
      • 互动-快问快答
      • 互动-优惠券
      • 互动-点赞
    • 直播间拓展能力
      • 直播间特色功能配置项
      • 文件下载
      • 修改角色昵称
      • 观看权限校验
      • 投屏
      • 虚拟人数
    • 观看回放
      • 观看回放
    • 防录屏
      • 跑马灯
    • 字段说明
      • 互动活动详情字段
      • 错误码说明
      • 常量定义
      • 活动详情字段说明
    • 版本更新说明
      • 版本更新信息
      • 6.5.0
      • v6.4.0
      • v6.3.0
      • v6.2.1
      • v5.0.x 到 v6.0.0
      • v3.2.0 到 v4.0.1
      • v3.0.1 到 v3.2.0 升级说明
      • V2.9.0到v3.0.1升级说明
      • v2.7.0 到 v2.8.0、v2.9.0 升级说明
      • v2.3.0 到 v2.4.0 升级说明
  • Adroid SDK
    • 整体介绍
    • 快速接入
    • 信息采集说明
    • SDK登录
    • 暖场视频
    • 视频轮巡功能
    • 直播彩排
    • 高级美颜
    • 云导播功能
    • 观看协议
    • 文档白板
    • 聊天功能
    • 房间消息
    • 视频直播
      • 发起视频直播
      • 观看视频直播
    • 观看回放
      • 观看回放/点播
    • 互动直播
      • 互动直播API
      • 主播发起互动直播
      • 嘉宾加入互动直播
      • 观众观看互动直播
    • 无延迟直播
      • 主播发起无延迟直播
      • 观众观看无延迟直播
    • 互动工具
      • 互动-抽奖
      • 互动-礼物
      • 互动-签到
      • 互动-问卷
      • 互动-公告
      • 互动-计时器
      • 互动-问答
      • 互动-推屏卡片
      • 互动-快问快答
      • 互动-优惠券
      • 互动-点赞
      • 互动-商品
    • 直播拓展功能
      • 修改角色名称
      • 文件下载
      • 投屏演示
      • 虚拟人数
      • 观看权限校验
      • 直播间特色功能配置项
    • 防录屏
      • 直播水印
      • 跑马灯
    • 字段说明
      • 房间消息字段说明
      • 聊天消息字段说明
      • 活动详情字段说明
    • 版本更新说明
      • v6.3.0
      • v6.2.1
      • v6.2.0
      • v5.0.0
      • v6.4.0
      • v6.2.3
      • v4.0.0
      • v6.1.0
      • v6.0.0
      • v3.3.0
      • v4.1.0
    • 更新记录
      • 更新记录
  • Harmony SDK
    • 整体介绍
    • 快速接入
    • SDK初始化
    • 登录&登出
    • 活动基础信息
    • 观看协议
    • 观看权限校验&预约
    • 开屏海报
    • 暖场视频
    • 观看直播
    • 观看回放/点播
    • 聊天
    • 房间消息
    • 在线人数&热度
    • 文档/白板
    • 版本更新
    • 私聊
    • 播放器错误码
    • 互动工具
      • 互动-问答
      • 互动-问卷
      • 互动-公告
      • 互动-抽奖
      • 互动-签到
      • 互动-计时器
      • 互动-礼物
      • 互动-互动有礼
      • 互动-快问快答
      • 互动-口令红包
      • 互动-推屏卡片
      • 互动-商品
      • 互动-优惠卷
      • 互动-观看有礼
      • 互动-点赞
    • 防录屏
      • 播放器水印&跑马灯
    • 菜单
      • 自定义菜单
      • 文件下载
      • 概要总结
      • 回放列表
      • 邀请卡
    • 互动直播
      • 互动直播
      • 主播发起互动直播
      • 嘉宾加入互动直播
      • 观众观看互动直播
    • 发起视频直播
      • 发起视频直播
  • 微信小程序 SDK
    • 简介
    • 快速接入
    • 签名鉴权说明
    • 版本更新记录
  • 相关协议
    • 微吼直播 SDK 隐私政策
    • 微吼直播 SDK 开发者使用规范
  1. web 观播 sdk

互动连麦

微吼 JS SDK 观众支持加入互动直播,并参与互动连麦,与主持人、嘉宾及其他上麦观众实时交流互动。

兼容性要求#

建议使用 Chrome 74 及以上 与 Safari 13.0.4 及以上版本的浏览器。
浏览器访问链接必须为 https 安全连接。
对于高画质(720P 以上)的视频互动,对计算机硬件与网络要求较高,请斟酌使用。

应用企业防火墙限制#

功能描述#

如要使用微吼直播连麦服务,需要对特定的服务域名和端口开通权限。因此如果你处在有网络访问限制的环境中,则需要执行以下操作。

配置以下域名和端口为白名单#

域名:#

vrtc-signal01.e.vhall.com

vrtc-signal02.e.vhall.com

vrtc-signal41.e.vhall.com

端口:#

协议
目标端口操作
TCP80, 443, 8080, 8081, 3478允许
UDP3478, 50000-50050允许

互动连麦集成说明#

实例化 VhallSDK 之后, 用 vhallSDK 的实例句柄下 interact 模块实现互动连麦功能。通过 interact 可以创建一个音视频互动房间的实例,同时也可以进行本地媒体采集设备调试。

互动连麦业务流程:#

查看大图
互动连麦流程图

方法列表#

序号API 方法说明支持版本
1getMicData获取互动连麦数据3.5.0 及以上
2userAgreeInvite主持人邀请用户上麦,用户同意上麦3.5.0 及以上
3refuseInviteConnect主持人邀请用户上麦,用户拒绝上麦3.5.0 及以上
4speakOff观众下麦3.5.0 及以上
5useApplyMic观众申请上麦3.5.0 及以上
6userCancelApply取消申请上麦3.5.0 及以上
7setDeviceStatus上麦后音/视频开关3.5.0 及以上
8subscribeRemoteStream订阅远端流3.5.0 及以上
9getStreamPacketLoss获取网络信号强度3.5.0 及以上
10getAudioLevel获取麦克风音量强度值3.5.0 及以上
11getCameraList获取本地摄像头设备列表3.5.0 及以上
12getSpeakersList获取本地扬声器设备列表3.5.0 及以上
13getMicrophonesList获取本地麦克风设备列表3.5.0 及以上
14createALocalPreviewInstance创建本地视频流预览实例3.5.0 及以上
15destroyLocalStream销毁本地视频采集流3.5.0 及以上
16mediaSettingsUploadPictures本地图片上传(图片采集流)3.5.0 及以上
17setAudioInput设置音频输入源3.5.0 及以上
18cancelAnalyserUpdates销毁本地麦克风实例3.5.0 及以上
19saveMediaSettings保存媒体设置3.5.0 及以上
20setVideoType设置本地采集设备流的类型3.5.0 及以上

获取互动连麦数据#

方法:getMicData
示例:

主持人邀请用户上麦,用户同意上麦#

方法:userAgreeInvite
示例:
同意上麦成功,将自动进行上麦操作,异常将会在 error 消息中返回

主持人邀请用户上麦,用户拒绝上麦#

方法:refuseInviteConnect
示例:

观众下麦#

方法:speakOff
示例:

观众申请上麦#

方法:useApplyMic
示例:

取消申请上麦#

方法:userCancelApply
示例:

上麦后音/视频开关#

方法:setDeviceStatus
示例:

订阅远端流#

方法:subscribeRemoteStream
示例:
同 3.4.0 及以下版本 subscribe 方法,待删除方法,不建议使用

获取网络信号强度#

方法:getStreamPacketLoss
示例:

获取麦克风音量强度值#

方法:getAudioLevel
示例:

设置音视频设备#

媒体设置方便用户检测本地音/视频设备是否正常,以及互动流切换等。

获取本地摄像头设备列表#

方法:getCameraList
示例:
获取本地摄像头设备列表
该方法返回当前本地摄像头可用设备列表

获取本地扬声器设备列表#

方法:getSpeakersList
示例:
该方法返回当前本地扬声器可用设备列表

获取本地麦克风设备列表#

方法:getMicrophonesList
示例:
支持版本: 3.5.0 及以上
该方法返回当前本地麦克风可用设备列表

创建本地视频流预览实例#

方法:createALocalPreviewInstance
示例:
该方法,需要在 html 中建立占位的标签,id 预设为方法的 videoNode 参数值
应配合 destroyLocalStream 销毁方法一起使用,详见用例

销毁本地视频采集流#

方法:destroyLocalStream
示例:

本地图片上传(图片采集流)#

方法:mediaSettingsUploadPictures
示例:
该方法依赖 input type 类型为 file 的文件域,在 onchange 事件中调用,参数为 event 对象

设置音频输入源#

方法:setAudioInput
示例:

销毁本地麦克风实例#

方法:cancelAnalyserUpdates
示例:

保存媒体设置#

方法:saveMediaSettings
示例:
调用该方法需要用到本地存储(sessionStorage),详见示例。

设置本地采集设备流的类型#

方法:setVideoType
示例:

互动连麦事件消息#

互动连麦事件消息

错误码#

全局错误码
修改于 2026-09-22 07:20:18
上一页
回放章节
下一页
资料下载
Built with