多人麦位
收藏
我的收藏能力介绍
开放直播间麦位基础能力,支持直播间互动玩法与直播间麦位进行联动,主要能力包括:
- 1.支持玩法服务端查询直播间当前麦位信息;
- 2.支持玩法内向玩家发起连麦邀请;
- 3.支持玩法内控制玩家的麦克风与摄像头的开启/关闭权限,当禁用麦克风与摄像头时,玩家将无法操作开启;
- 4.支持玩法内开启/关闭当前玩家的麦克风与摄像头;
接入指南
玩法过程中,直播间麦位变化数据,平台不会主动推送,需要玩法服务端定时轮询获取直播间麦位信息,做玩法进程的动态调整。
服务端
获取直播间麦位信息
获取直播间麦位信息。
频率限制:单个 app_id 调用上限为 100 次/秒。
请求地址
POST https://webcast.bytedance.com/api/linkmic/query
请求参数
- •请求 Headers
字段 | 数据类型 | 必填 | 说明 |
X-Token | string | 是 | 通过接口获取的 access_token |
Content-Type | string | 是 | 必须包含 application/json |
- •请求 Body
字段 | 数据类型 | 必填 | 说明 |
app_id | string | 是 | 应用 ID |
room_id | string | 是 | 直播间 ID |
返回值
- •正确返回的 JSON 数据包
字段 | 数据类型 | 说明 |
base_info | object | 麦位基本信息 |
user_list | list<object> | 麦位上用户的基本信息 |
其中
base_info
的 object 结构如下:字段 | 数据类型 | 说明 |
link_id | string | 本次连麦唯一 ID |
total_count | int32 | 麦位总数 |
free_count | int32 | 麦位剩余数量 |
其中
user_list
的每一个 item 的结构如下:字段 | 数据类型 | 说明 |
open_id | string | 麦上用户的 openId |
sec_avatar_url | string | 麦上用户的加密头像,需要配合 SDK 使用 |
sec_nick_name | string | 麦上用户的加密昵称,需要配合 SDK 使用 |
link_state | int32 | 连麦状态;1-已在麦上;2-邀 请上麦中 |
link_position | int32 | 麦上用户的麦位位置 |
disable_microphone | int32 | 麦上用户是否禁用麦克风;1-未禁用;2-已禁用; 注意:已经在麦上的用户,这个值才有效 |
microphone_state | int32 | 麦上用户麦克风打开/关闭状态;1-已打开;2-已关闭; 注意:已经在麦上的用户有效,这个值才有效 |
disable_camera | int32 | 麦上用户是否禁用摄像头;1-未禁用;2-已禁用; 注意:已经在麦上的用户有效,这个值才有效 |
camera_state | int32 | 麦上用户摄像头打开/关闭状态;1-已打开;2-已关闭; 注意:已经在麦上的用户有效,这个值才有效 |
- •异常返回的 JSON 数据包
字段 | 数据类型 | 说明 |
errcode | int32 | 错误码 |
errmsg | string | 错误信息 |