# 跨频道媒体流转发 (/zh-CN/api-reference/rtc/macos/cloud-media-relay/channel-media-relay)
> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).
## pauseAllChannelMediaRelay [#pauseallchannelmediarelay]
暂停向所有目标频道的跨频道媒体流转发。
```objc
- (int)pauseAllChannelMediaRelay NS_SWIFT_NAME(pauseAllChannelMediaRelay());
```
跨频道媒体流转发开始后,你可以调用此方法暂停向所有目标频道转发媒体流。如需恢复转发,请调用 [resumeAllChannelMediaRelay](/zh-CN/api-reference/rtc/macos/cloud-media-relay/channel-media-relay#api_irtcengine_resumeallchannelmediarelay) 方法。
:::note
注: 请在调用 [startOrUpdateChannelMediaRelay:](/zh-CN/api-reference/rtc/macos/cloud-media-relay/channel-media-relay#api_irtcengine_startorupdatechannelmediarelay) 方法之后调用此方法。
:::
### 返回值 [#返回值]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
- -5:调用被拒绝,当前没有正在进行的跨频道媒体流转发。
### 所属接口类 [#所属接口类]
- [AgoraRtcEngineKit](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_irtcengine)
## pauseAllChannelMediaRelayEx: [#pauseallchannelmediarelayex]
暂停向所有目标频道的跨频道媒体流转发。
```objc
- (int)pauseAllChannelMediaRelayEx:(AgoraRtcConnection * _Nonnull)connection NS_SWIFT_NAME(pauseAllChannelMediaRelayEx(_:));
```
你可以调用该方法暂停向所有目标频道转发媒体流。如需恢复转发,请调用 [resumeAllChannelMediaRelay](/zh-CN/api-reference/rtc/macos/cloud-media-relay/channel-media-relay#api_irtcengine_resumeallchannelmediarelay) 方法。
:::note
注: 请在调用 `startOrUpdateChannelMediaRelayEx` 方法之后调用该方法。
:::
### 适用场景 [#适用场景]
该方法适用于多频道场景。
### 参数 [#参数]
连接信息。详见 [AgoraRtcConnection](/zh-CN/api-reference/rtc/macos/class-rtcconnection)。
### 返回值 [#返回值-1]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
- -5:调用被拒绝,当前没有正在进行的跨频道媒体流转发。
### 所属接口类 [#所属接口类-1]
- [AgoraRtcEngineKit(Ex)](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_irtcengineex)
## resumeAllChannelMediaRelay [#resumeallchannelmediarelay]
恢复向所有目标频道的跨频道媒体流转发。
```objc
- (int)resumeAllChannelMediaRelay NS_SWIFT_NAME(resumeAllChannelMediaRelay());
```
调用 [pauseAllChannelMediaRelay](/zh-CN/api-reference/rtc/macos/cloud-media-relay/channel-media-relay#api_irtcengine_pauseallchannelmediarelay) 方法后,可以调用此方法恢复向所有目标频道转发媒体流。
:::note
注: 请在调用 [pauseAllChannelMediaRelay](/zh-CN/api-reference/rtc/macos/cloud-media-relay/channel-media-relay#api_irtcengine_pauseallchannelmediarelay) 方法后调用此方法。
:::
### 返回值 [#返回值-2]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
- -5:方法调用被拒绝,当前没有已暂停的跨频道媒体流转发。
### 所属接口类 [#所属接口类-2]
- [AgoraRtcEngineKit](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_irtcengine)
## resumeAllChannelMediaRelayEx: [#resumeallchannelmediarelayex]
恢复向所有目标频道的跨频道媒体流转发。
```objc
- (int)resumeAllChannelMediaRelayEx:(AgoraRtcConnection * _Nonnull)connection NS_SWIFT_NAME(resumeAllChannelMediaRelayEx(_:));
```
调用 [pauseAllChannelMediaRelayEx:](/zh-CN/api-reference/rtc/macos/cloud-media-relay/channel-media-relay#api_irtcengineex_pauseallchannelmediarelayex) 方法后,可以调用该方法恢复向所有目标频道转发媒体流。
:::note
注: 请在调用 [pauseAllChannelMediaRelayEx:](/zh-CN/api-reference/rtc/macos/cloud-media-relay/channel-media-relay#api_irtcengineex_pauseallchannelmediarelayex) 方法后再调用此方法。
:::
### 适用场景 [#适用场景-1]
该方法适用于多频道场景。
### 参数 [#参数-1]
连接信息。详见 [AgoraRtcConnection](/zh-CN/api-reference/rtc/macos/class-rtcconnection)。
### 返回值 [#返回值-3]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
- -5:调用被拒绝,当前没有已暂停的跨频道媒体流转发。
### 所属接口类 [#所属接口类-3]
- [AgoraRtcEngineKit(Ex)](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_irtcengineex)
## startOrUpdateChannelMediaRelay: [#startorupdatechannelmediarelay]
开始或更新跨频道媒体流转发。
```objc
- (int)startOrUpdateChannelMediaRelay:(AgoraChannelMediaRelayConfiguration * _Nonnull)config NS_SWIFT_NAME(startOrUpdateChannelMediaRelay(_:));
```
:::info[自从]
自 v4.2.0 版本新增。
:::
首次成功调用该方法会开始将媒体流从源频道转发到目标频道。若需将媒体流转发到其他频道,或退出当前的某个媒体流转发,可再次调用该方法更新目标频道。该功能最多支持将媒体流转发到六个目标频道。
调用该方法成功后,SDK 会触发 [rtcEngine\:channelMediaRelayStateDidChange\:error:](/zh-CN/api-reference/rtc/macos/cloud-media-relay/channel-media-relay#callback_irtcengineeventhandler_onchannelmediarelaystatechanged) 回调,报告媒体流转发的状态。
- 若该回调返回 `AgoraChannelMediaRelayStateRunning`(2)和 `AgoraChannelMediaRelayErrorNone`(0),表示媒体流转发已成功启动。
- 若该回调返回 `AgoraChannelMediaRelayStateFailure`(3),表示媒体流转发过程中发生异常。
:::note
注:
- 请在加入频道后调用该方法。
- 该方法仅在你是直播频道中的主播时生效。
- 跨频道媒体流转发功能需[联系技术支持](https://ticket.shengwang.cn/)开启。
- 该 API 不支持字符串用户 User Account。
:::
### 参数 [#参数-2]
媒体流转发的配置。详见 [AgoraChannelMediaRelayConfiguration](/zh-CN/api-reference/rtc/macos/class-channelmediarelayconfiguration)。
### 返回值 [#返回值-4]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
- -1:发生通用错误(无明确原因)。
- -2:参数无效。
- -8:内部状态错误,可能是因为用户不是主播。
### 所属接口类 [#所属接口类-4]
- [AgoraRtcEngineKit](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_irtcengine)
## startOrUpdateChannelMediaRelayEx\:connection: [#startorupdatechannelmediarelayexconnection]
开始或更新跨频道媒体流转发。
```objc
- (int)startOrUpdateChannelMediaRelayEx:(AgoraChannelMediaRelayConfiguration * _Nonnull)config connection:(AgoraRtcConnection * _Nonnull)connection NS_SWIFT_NAME(startOrUpdateChannelMediaRelayEx(_:connection:));
```
:::info[自从]
自 v4.2.0 版本新增。
:::
首次成功调用该方法会开始将媒体流从源频道转发到目标频道。若需将媒体流转发到其他频道,或退出当前的某个媒体流转发,可再次调用该方法更新目标频道。该功能最多支持将媒体流转发到六个目标频道。
:::note
注:
- 请在加入频道后调用该方法。
- 该方法仅在你是直播频道中的主播时生效。
- 跨频道媒体流转发功能需[联系技术支持](https://ticket.shengwang.cn/)开启。
- 该 API 不支持字符串用户 User Account。
:::
### 适用场景 [#适用场景-2]
该方法适用于多频道场景。
### 相关回调 [#相关回调]
成功调用该方法后,SDK 会触发 [rtcEngine\:channelMediaRelayStateDidChange\:error:](/zh-CN/api-reference/rtc/macos/cloud-media-relay/channel-media-relay#callback_irtcengineeventhandler_onchannelmediarelaystatechanged) 回调报告媒体流转发的状态。常见状态如下:
- 若回调返回 `AgoraChannelMediaRelayStateRunning`(2)和 `AgoraChannelMediaRelayErrorNone`(0),表示 SDK 成功开始将媒体流从源频道转发到目标频道。
- 若回调返回 `AgoraChannelMediaRelayStateFailure`(3),表示媒体流转发过程中发生异常。
### 参数 [#参数-3]
媒体流转发的配置。详见 [AgoraChannelMediaRelayConfiguration](/zh-CN/api-reference/rtc/macos/class-channelmediarelayconfiguration)。
连接信息。详见 [AgoraRtcConnection](/zh-CN/api-reference/rtc/macos/class-rtcconnection)。
### 返回值 [#返回值-5]
0:方法调用成功。
< 0:方法调用失败。
- -1:发生通用错误(无明确原因)。
- -2:参数无效。
- -8:内部状态错误,可能是因为用户不是主播。
### 所属接口类 [#所属接口类-5]
- [AgoraRtcEngineKit(Ex)](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_irtcengineex)
## stopChannelMediaRelay [#stopchannelmediarelay]
停止跨频道媒体流转发。
```objc
- (int)stopChannelMediaRelay NS_SWIFT_NAME(stopChannelMediaRelay());
```
调用该方法停止跨频道媒体流转发。调用成功后,主播会退出所有目标频道。SDK 会触发 [rtcEngine\:channelMediaRelayStateDidChange\:error:](/zh-CN/api-reference/rtc/macos/cloud-media-relay/channel-media-relay#callback_irtcengineeventhandler_onchannelmediarelaystatechanged) 回调。如果该回调返回 `AgoraChannelMediaRelayStateIdle`(0)和 `AgoraChannelMediaRelayErrorNone`(0),表示主播成功停止转发。
:::note
注: 如果方法调用失败,SDK 会通过 [rtcEngine\:channelMediaRelayStateDidChange\:error:](/zh-CN/api-reference/rtc/macos/cloud-media-relay/channel-media-relay#callback_irtcengineeventhandler_onchannelmediarelaystatechanged) 回调返回 `AgoraChannelMediaRelayErrorServerNoResponse`(2)或 `AgoraChannelMediaRelayErrorServerConnectionLost`(8)错误码。你可以调用 `leaveChannel` 方法离开频道,跨频道媒体流转发会自动停止。
:::
### 返回值 [#返回值-6]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
- -5:调用被拒绝,当前没有正在进行的跨频道媒体流转发。
### 所属接口类 [#所属接口类-6]
- [AgoraRtcEngineKit](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_irtcengine)
## stopChannelMediaRelayEx: [#stopchannelmediarelayex]
停止跨频道媒体流转发。
```objc
- (int)stopChannelMediaRelayEx:(AgoraRtcConnection * _Nonnull)connection NS_SWIFT_NAME(stopChannelMediaRelayEx(_:));
```
调用该方法停止跨频道媒体流转发。调用成功后,主播会退出所有目标频道,SDK 会触发 [rtcEngine\:channelMediaRelayStateDidChange\:error:](/zh-CN/api-reference/rtc/macos/cloud-media-relay/channel-media-relay#callback_irtcengineeventhandler_onchannelmediarelaystatechanged) 回调。如果该回调返回 `AgoraChannelMediaRelayStateIdle`(0)和 `AgoraChannelMediaRelayErrorNone`(0),表示主播已成功停止转发。
:::note
注: 如果方法调用失败,SDK 会通过 [rtcEngine\:channelMediaRelayStateDidChange\:error:](/zh-CN/api-reference/rtc/macos/cloud-media-relay/channel-media-relay#callback_irtcengineeventhandler_onchannelmediarelaystatechanged) 回调报告 `AgoraChannelMediaRelayErrorServerNoResponse`(2)或 `AgoraChannelMediaRelayErrorServerConnectionLost`(8)错误码。你可以调用 [leaveChannel\:leaveChannelBlock:](/zh-CN/api-reference/rtc/macos/channel#api_irtcengine_leavechannel2) 方法离开频道,媒体流转发会自动停止。
:::
### 适用场景 [#适用场景-3]
该方法适用于多频道场景。
### 参数 [#参数-4]
连接信息。详见 [AgoraRtcConnection](/zh-CN/api-reference/rtc/macos/class-rtcconnection)。
### 返回值 [#返回值-7]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
- -5:调用被拒绝,当前没有正在进行的跨频道媒体流转发。
### 所属接口类 [#所属接口类-7]
- [AgoraRtcEngineKit(Ex)](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_irtcengineex)
## rtcEngine\:channelMediaRelayStateDidChange\:error: [#rtcenginechannelmediarelaystatedidchangeerror]
跨频道媒体流转发状态发生变化回调。
```objc
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
channelMediaRelayStateDidChange:(AgoraChannelMediaRelayState)state
error:(AgoraChannelMediaRelayError)error NS_SWIFT_NAME(rtcEngine(_:channelMediaRelayStateDidChange:error:));
```
该回调返回当前跨频道媒体流转发的状态及错误码。
### 触发时机 [#触发时机]
该回调在跨频道媒体流转发状态发生变化时触发。
### 参数 [#参数-5]
[AgoraRtcEngineKit](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_irtcengine) 对象,详见 [AgoraRtcEngineKit](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_irtcengine)。
跨频道媒体流转发的状态码,详见 [AgoraChannelMediaRelayState](/zh-CN/api-reference/rtc/macos/enum-channelmediarelaystate)。
跨频道媒体流转发的错误码,详见 [AgoraChannelMediaRelayError](/zh-CN/api-reference/rtc/macos/enum-channelmediarelayerror)。
### 所属接口类 [#所属接口类-8]
- [AgoraRtcEngineDelegate](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_irtcengineeventhandler)