跨直播间连麦

功能描述

跨直播间连麦，指主播的媒体流可以同时转发进多个直播频道，实现主播跨频道与其他主播实时互动的场景。其中：

• 频道中的所有主播可以看见彼此，并听到彼此的声音。
• 频道中的观众可以看到所有主播，并听到主播的声音。

该功能因其实时性和互动性，尤其适用于连麦 PK、在线合唱等直播场景，在增加直播趣味的同时，有效吸粉。

实现方法

实现跨频道连麦功能前，请确保你已在项目中实现基本的实时音视频功能，详见开始互动直播。

Agora Web SDK 在 v3.0.0 中新增如下跨频道媒体流转发接口，支持将源频道中的媒体流转发至最多 4 个目标频道，实现跨直播间连麦功能：

• startChannelMediaRelay
• updateChannelMediaRelay
• stopChannelMediaRelay

在跨频道媒体流转发过程中，SDK 会通过 Client.on("channel-media-relay-state") 回调报告媒体流转发的状态码（state）和错误码（code）， Client.on("channel-media-relay-event") 回调报告媒体流转发的事件码，你可以参考如下状态码或事件码的含义实现相关的业务逻辑：

Note：

• 一个频道内可以有多个主播转发媒体流。哪个主播调用 startChannelMediaRelay 方法，SDK 就转发哪个主播的流。
• 调用 startChannelMediaRelay 或 updateChannelMediaRelay 成功跨频道连麦后，目标频道的用户会收到 Client.on("stream-added") 回调。
• 跨频道连麦中，如果目标频道的主播掉线或离开频道，源频道的主播会收到 Client.on("peer-leave") 回调。

示例代码

• 配置跨频道媒体流转发

  var channelMediaConfig = new AgoraRTC.ChannelMediaRelayConfiguration();
  // 设置源频道信息，其中 channelName 使用用户填入的源频道名，uid 需要填为 0
  // 注意 token 和用户加入源频道时的 Token 不一致，需要用 uid = 0 和源频道名重新生成
  channelMediaConfig.setSrcChannelInfo({
   channelName: "srcChannel",
   uid: 0,
   token: "yourSrcToken",
  })
  // 设置目标频道信息，可多次调用，最多设置 4 个目标频道
  channelMediaConfig.setDestChannelInfo("destChannel1", {
   channelName: "destChannel1",
   uid: 123,
   token: "yourDestToken",
  })

• 开始跨频道媒体流转发

  client.startChannelMediaRelay(channelMediaConfig, function(e) {
    if(e) {
      utils.notification(`startChannelMediaRelay failed: ${JSON.stringify(e)}`);
    } else {
      utils.notification(`startChannelMediaRelay success`);
    }
  });

• 更新媒体流转发频道

  // 删除一个目标频道
  channelMediaConfig.removeDestChannelInfo("destChannel1")
  // 更新跨频道媒体流转发设置
  client.updateChannelMediaRelay(channelMediaConfig, function(e) {
    if(e) {
      utils.notification(`updateChannelMediaRelay failed: ${JSON.stringify(e)}`);
    } else {
      utils.notification(`updateChannelMediaRelay success`);
    }
  });

• 停止跨频道媒体流转发

  stopChannelMediaRelay: function() {
    client.stopChannelMediaRelay(function(e) {
      if(e) {
        utils.notification(`stopChannelMediaRelay failed: ${JSON.stringify(e)}`);
      } else {
        utils.notification(`stopChannelMediaRelay success`);
      }
    });
  }

API 参考

• startChannelMediaRelay
• updateChannelMediaRelay
• stopChannelMediaRelay

开发注意事项

• 该功能最多支持将媒体流转发至 4 个目标频道。转发过程中，如果想添加或删除目标频道，可以调用 updateChannelMediaRelay 方法。
• 该功能不支持 String 型用户 ID。

• 在设置源频道信息（setSrcChannelInfo）时，请确保 uid 设置与当前主播的 UID 不同。我们建议将这里的 uid 设置为 0，由服务器随机分配。

• 在成功调用 startChannelMediaRelay 方法后，如果想再次调用该方法，必须先调用 stopChannelMediaRelay 方法退出当前的转发状态。