同局主播连线接入说明
收藏更新记录
时间 | 更新内容 |
2024.11.13 | 创建文档 |
2024.12.09 | 修正「创建主播连线」API 的响应，linker_id 修正为 link_id |
能力介绍
开放平台同局主播连线能力，可支持玩法接入以下接口：
阶段 | 接口名称 | 接口描述 |
对局开始前 | 查询直播间麦位信息(可选) | 1.接口作用：支持查询单个主播直播间麦位信息，方便后续主播选择在麦位嘉宾进入主播连线、开嘉宾玩法 2.调用时机：建议在对局开始前拉取麦位，邀进对局。 |
主播连线前置准备 | 1.接口作用：支持开发者前置判断目标主播是否可参与连线，并做前置准备 2.调用时机：在创建主播连线前，每个直播间都需调用一次 | |
对局开始 | 创建主播连线 | 1.接口作用：建立多主播直播间连线，最多9人，返回连线ID 2.调用时机：建议在主播完成匹配后，到玩法开局前创建连线 |
对局进行中 | 查询主播连线麦位信息 | 1.接口作用：支持开发者根据连线ID查询连线麦位信息 2.调用时机：建议在创建主播连线后定时轮询，感知中途嘉宾/主播上下麦 |
中途单主播离线(可选) | 1.接口作用：支持单个主播直播间离开所在的连线，对应同直播间的嘉宾会离线 2.调用时机：建议主播在玩法内操作「离开对局」时调用 | |
附近语音(可选) | 1.接口作用：实现连线主播间，仅能听到特定用户声音的设计，支持控制用户能听到声源的音量，默认每个用户可听见所有在连线内的用户 2.调用时机：开发者可依据玩法设计来判断是否调用。若需调用，可在玩法开始时初始化音量控制，并根据玩法进程实时更新各主播的语音接收范围 | |
积分上报(可选) | 1.接口作用：支持玩法上报连麦对局内用户积分，同步展示在直播间麦位上 2.调用时机：在对局开始、对 局结束上报一次，对局期间定时上报 | |
对局结束 | 结束主播连线 | 1.接口作用：解除多主播直播间连线 2.调用时机：建议在每局结束后，预留一段时间给主播交流、查看排行榜后，再结束连线 |
接入时序
备注：厂商接入同局主播连线能力需要接入红色箭头API
对局前置流程
备注：【主播邀嘉宾进入玩法】流程仅在同时接入【观众一键同玩能力】时才需关注
对局流程
备注：【中途嘉宾进入玩法】仅在同时接入【观众一键同玩能力】时才需关注
接口明细
