startOrUpdateChannelMediaRelay abstract method

Future<void> startOrUpdateChannelMediaRelay(
  1. ChannelMediaRelayConfiguration configuration
)

开始或更新跨频道媒体流转发。

首次成功调用该方法将开始跨频道转发媒体流。如需将流转发到多个目标频道,或退出当前的转发频道,可以再次调用该方法添加或移除转发的目标频道。该功能最多支持将媒体流转发至 6 个目标频道。 成功调用该方法后,SDK 会触发 onChannelMediaRelayStateChanged 回调,报告当前的跨频道媒体流转发状态。常见状态如下: 如果 onChannelMediaRelayStateChanged 回调报告 relayStateRunning (2) 和 relayOk (0), 则表示 SDK 开始在源频道和目标频道之间转发媒体流。 如果 onChannelMediaRelayStateChanged 回调报告 relayStateFailure (3), 则表示跨频道媒体流转发出现异常。 请在成功加入频道后调用该方法。 在直播场景中,只有角色为主播的用户才能调用该方法。 跨频道媒体流转发功能需要联系技术支持开通。 该功能不支持 String 型 UID。

  • configuration 跨频道媒体流转发参数配置。详见 ChannelMediaRelayConfiguration 。

Returns 方法成功调用时,无返回值;方法调用失败时,会抛出 AgoraRtcException 异常,你需要捕获异常并进行处理。详见错误码了解详情和解决建议。 < 0:方法调用失败。详见错误码了解详情和解决建议。 -1: 一般性的错误(未明确归类)。 -2: 参数无效。 -8:内部状态错误。可能因为用户角色不是主播。

Implementation

Future<void> startOrUpdateChannelMediaRelay(
    ChannelMediaRelayConfiguration configuration);