在直播场景下,跨频道媒体流转发功能可实现主播角色的媒体流从源频道同时转发进多个目标频道,其中:
该功能因其实时性和互动性,能够丰富直播玩法,尤其适用于连麦 PK、在线合唱等直播场景,为观众带来更好的观看体验的同时,也为主播带来更多的流量和收益。
在开始前,请确保满足以下条件:
参考如下 API 时序图实现相关代码逻辑:
成功加入频道后,可以调用 startChannelMediaRelay
方法转发媒体流。示例代码如下:
// 配置源频道信息
// 推荐将源频道的 uid 设为 0,由 SDK 随机分配一个 uid
// 注意 token 与用户加入源频道时的 token 不同,需要用源频道名和 uid = 0 重新生成
let config = AgoraChannelMediaRelayConfiguration()
config.sourceInfo = AgoraChannelMediaRelayInfo(token: nil)
// 配置目标频道信息
// 你可以将 uid 设为 0,由 SDK 随机分配一个 uid,或自行指定 uid,并确保其与目标频道中的所有 uid 不同
let destinationInfo = AgoraChannelMediaRelayInfo(token: nil)
config.setDestinationInfo(destinationInfo, forChannelName: destinationChannelName)
// 开始跨频道媒体流转发
agoraKit.startChannelMediaRelay(config)
成功调用 startChannelMediaRelay
开始跨频道媒体流转发后,如需添加或移除目标频道,可以调用 updateChannelMediaRelay
方法更新目标频道。
成功调用 startChannelMediaRelay
开始跨频道媒体流转发后,如果想暂停向所有目标频道发送媒体流,可调用 pauseAllChannelMediaRelay
方法,示例代码如下:
isPauseRelaying = true
agoraKit.pauseAllChannelMediaRelay()
暂停跨频道媒体流转发后,如果想恢复向所有目标频道转发媒体流,可调用 resumeAllChannelMediaRelay
方法,示例代码如下:
isPauseRelaying = false
agoraKit.resumeAllChannelMediaRelay()
在成功调用 startChannelMediaRelay
方法开始跨频道媒体流转发后,如需退出当前的转发状态,可以调用 stopChannelMediaRelay
,示例代码如下:
isProcessing = true
isPauseRelaying = false
agoraKit.stopChannelMediaRelay()
pauseRelayButton.isEnabled = false
leaveChannel
方法离开频道,跨频道媒体流转发会自动停止。在跨频道媒体流转发过程中,SDK 会通过 channelMediaRelayStateDidChange
和 didReceiveChannelMediaRelayEvent
回调报告媒体流转发的状态和事件,你可以参考状态码或事件码的含义实现相关的业务逻辑。示例代码如下:
func rtcEngine(_ engine: AgoraRtcEngineKit, channelMediaRelayStateDidChange state: AgoraChannelMediaRelayState, error: AgoraChannelMediaRelayError) {
LogUtils.log(message: "channelMediaRelayStateDidChange: \(state.rawValue) error \(error.rawValue)", level: .info)
isProcessing = false
switch state {
case .running:
isRelaying = true
case .failure:
showAlert(message: "Media Relay Failed: \(error.rawValue)")
isRelaying = false
case .idle:
isRelaying = false
default:break
}
}
主要的状态码和事件码及其对应的媒体流转发状态如下:
媒体流转发状态 | 状态码 | 事件码 |
---|---|---|
源频道开始向目标频道传输数据。 | AgoraChannelMediaRelayStateRunning(2) 和 AgoraChannelMediaRelayErrorNone(0) |
AgoraChannelMediaRelayEventSentToDestinationChannel(4) |
跨频道媒体流转发出现异常。可根据错误码进行排查。 | AgoraChannelMediaRelayStateFailure(3) |
/ |
已停止媒体流转发。 | AgoraChannelMediaRelayStateIdle(0) 和 AgoraChannelMediaRelayErrorNone(0) |
/ |
startChannelMediaRelay
开始跨频道媒体流转发startChannelMediaRelay
必须在成功加入频道后调用,否则会报错startChannelMediaRelay
,SDK 就转发哪个主播的流startChannelMediaRelay
方法后,如果想再次调用该方法,必须先调用 stopChannelMediaRelay
方法退出当前的转发状态uid
,如需使用跨频道连麦功能,则要在普通连麦中也使用 Int 型 uid
,否则跨频道连麦功能无法正常使用我们在 GitHub 提供了开源的跨频道媒体流转发示例项目 ChannelMediaRelay 供参考。