# 跨频道媒体流转发 (/zh-CN/api-reference/rtc/flutter/cloud-media-relay/channel-media-relay)
> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).
## pauseAllChannelMediaRelay [#pauseallchannelmediarelay]
暂停向所有目标频道转发媒体流。
```dart
Future pauseAllChannelMediaRelay();
```
开始跨频道转发媒体流后,如果你需要暂停向所有频道转发媒体流,可以调用该方法;暂停后,如果要恢复跨频道媒体流转发,可以调用 [resumeAllChannelMediaRelay](/zh-CN/api-reference/rtc/flutter/cloud-media-relay/channel-media-relay#api_irtcengine_resumeallchannelmediarelay) 方法。
:::note
注: 该方法需要在调用 [startOrUpdateChannelMediaRelay](/zh-CN/api-reference/rtc/flutter/cloud-media-relay/channel-media-relay#api_irtcengine_startorupdatechannelmediarelay) 开始跨频道媒体流转发后调用。
:::
### 返回值 [#返回值]
方法成功调用时,无返回值;方法调用失败时,会抛出 [AgoraRtcException](/zh-CN/api-reference/rtc/flutter/class-agorartcexception) 异常,你需要捕获异常并进行处理。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类]
- [RtcEngine](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_irtcengine)
## pauseAllChannelMediaRelayEx [#pauseallchannelmediarelayex]
暂停向所有目标频道转发媒体流。
```dart
Future pauseAllChannelMediaRelayEx(RtcConnection connection);
```
开始跨频道转发媒体流后,如果你需要暂停向所有频道转发媒体流,可以调用该方法;暂停后,如果要恢复跨频道媒体流转发,可以调用 [resumeAllChannelMediaRelay](/zh-CN/api-reference/rtc/flutter/cloud-media-relay/channel-media-relay#api_irtcengine_resumeallchannelmediarelay) 方法。
:::note
注: 该方法需要在调用 [startOrUpdateChannelMediaRelayEx](/zh-CN/api-reference/rtc/flutter/cloud-media-relay/channel-media-relay#api_irtcengineex_startorupdatechannelmediarelayex) 开始跨频道媒体流转发后调用。
:::
### 参数 [#参数]
Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/flutter/class-rtcconnection)。
### 返回值 [#返回值-1]
方法成功调用时,无返回值;方法调用失败时,会抛出 [AgoraRtcException](/zh-CN/api-reference/rtc/flutter/class-agorartcexception) 异常,你需要捕获异常并进行处理。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-1]
- [RtcEngineEx](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_irtcengineex)
## resumeAllChannelMediaRelay [#resumeallchannelmediarelay]
恢复向所有目标频道转发媒体流。
```dart
Future resumeAllChannelMediaRelay();
```
调用 [pauseAllChannelMediaRelay](/zh-CN/api-reference/rtc/flutter/cloud-media-relay/channel-media-relay#api_irtcengine_pauseallchannelmediarelay) 方法后,如果你需要恢复向所有目标频道转发媒体流,可以调用该方法。
:::note
注: 该方法需要在 [pauseAllChannelMediaRelay](/zh-CN/api-reference/rtc/flutter/cloud-media-relay/channel-media-relay#api_irtcengine_pauseallchannelmediarelay) 后调用。
:::
### 返回值 [#返回值-2]
方法成功调用时,无返回值;方法调用失败时,会抛出 [AgoraRtcException](/zh-CN/api-reference/rtc/flutter/class-agorartcexception) 异常,你需要捕获异常并进行处理。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
- -5: 方法调用被拒绝。当前没有暂停的跨频道媒体流转发。
### 所属接口类 [#所属接口类-2]
- [RtcEngine](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_irtcengine)
## resumeAllChannelMediaRelayEx [#resumeallchannelmediarelayex]
恢复向所有目标频道转发媒体流。
```dart
Future resumeAllChannelMediaRelayEx(RtcConnection connection);
```
调用 [pauseAllChannelMediaRelayEx](/zh-CN/api-reference/rtc/flutter/cloud-media-relay/channel-media-relay#api_irtcengineex_pauseallchannelmediarelayex) 方法后,如果你需要恢复向所有目标频道转发媒体流,可以调用该方法。
:::note
注: 该方法需要在 [pauseAllChannelMediaRelayEx](/zh-CN/api-reference/rtc/flutter/cloud-media-relay/channel-media-relay#api_irtcengineex_pauseallchannelmediarelayex) 后调用。
:::
### 参数 [#参数-1]
Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/flutter/class-rtcconnection)。
### 返回值 [#返回值-3]
方法成功调用时,无返回值;方法调用失败时,会抛出 [AgoraRtcException](/zh-CN/api-reference/rtc/flutter/class-agorartcexception) 异常,你需要捕获异常并进行处理。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
- -5: 方法调用被拒绝。当前没有暂停的跨频道媒体流转发。
### 所属接口类 [#所属接口类-3]
- [RtcEngineEx](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_irtcengineex)
## startOrUpdateChannelMediaRelay [#startorupdatechannelmediarelay]
开始或更新跨频道媒体流转发。
```dart
Future startOrUpdateChannelMediaRelay(
ChannelMediaRelayConfiguration configuration);
```
首次成功调用该方法将开始跨频道转发媒体流。如需将流转发到多个目标频道,或退出当前的转发频道,可以再次调用该方法添加或移除转发的目标频道。该功能最多支持将媒体流转发至 6 个目标频道。
成功调用该方法后,SDK 会触发 [onChannelMediaRelayStateChanged](/zh-CN/api-reference/rtc/flutter/cloud-media-relay/channel-media-relay#callback_irtcengineeventhandler_onchannelmediarelaystatechanged) 回调,报告当前的跨频道媒体流转发状态。常见状态如下:
- 如果 [onChannelMediaRelayStateChanged](/zh-CN/api-reference/rtc/flutter/cloud-media-relay/channel-media-relay#callback_irtcengineeventhandler_onchannelmediarelaystatechanged) 回调报告 `relayStateRunning` (2) 和 `relayOk` (0), 则表示 SDK 开始在源频道和目标频道之间转发媒体流。
- 如果 [onChannelMediaRelayStateChanged](/zh-CN/api-reference/rtc/flutter/cloud-media-relay/channel-media-relay#callback_irtcengineeventhandler_onchannelmediarelaystatechanged) 回调报告 `relayStateFailure` (3), 则表示跨频道媒体流转发出现异常。
:::note
注:
- 请在成功加入频道后调用该方法。
- 在直播场景中,只有角色为主播的用户才能调用该方法。
- 跨频道媒体流转发功能需要[联系技术支持](https://ticket.shengwang.cn/)开通。
- 该功能不支持 String 型 UID。
:::
### 参数 [#参数-2]
跨频道媒体流转发参数配置。详见 [ChannelMediaRelayConfiguration](/zh-CN/api-reference/rtc/flutter/class-channelmediarelayconfiguration)。
### 返回值 [#返回值-4]
方法成功调用时,无返回值;方法调用失败时,会抛出 [AgoraRtcException](/zh-CN/api-reference/rtc/flutter/class-agorartcexception) 异常,你需要捕获异常并进行处理。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
- -1: 一般性的错误(未明确归类)。
- -2: 参数无效。
- -8:内部状态错误。可能因为用户角色不是主播。
### 所属接口类 [#所属接口类-4]
- [RtcEngine](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_irtcengine)
## startOrUpdateChannelMediaRelayEx [#startorupdatechannelmediarelayex]
开始或更新跨频道媒体流转发。
```dart
Future startOrUpdateChannelMediaRelayEx(
{required ChannelMediaRelayConfiguration configuration,
required RtcConnection connection});
```
首次成功调用该方法将开始跨频道转发媒体流。如需将流转发到多个目标频道,或退出当前的转发频道,可以再次调用该方法添加或移除转发的目标频道。该功能最多支持将媒体流转发至 6 个目标频道。
成功调用该方法后,SDK 会触发 [onChannelMediaRelayStateChanged](/zh-CN/api-reference/rtc/flutter/cloud-media-relay/channel-media-relay#callback_irtcengineeventhandler_onchannelmediarelaystatechanged) 回调,报告当前的跨频道媒体流转发状态。常见状态如下:
- 如果 [onChannelMediaRelayStateChanged](/zh-CN/api-reference/rtc/flutter/cloud-media-relay/channel-media-relay#callback_irtcengineeventhandler_onchannelmediarelaystatechanged) 回调报告 `relayStateRunning` (2) 和 `relayOk` (0), 则表示 SDK 开始在源频道和目标频道之间转发媒体流。
- 如果 [onChannelMediaRelayStateChanged](/zh-CN/api-reference/rtc/flutter/cloud-media-relay/channel-media-relay#callback_irtcengineeventhandler_onchannelmediarelaystatechanged) 回调报告 `relayStateFailure` (3), 则表示跨频道媒体流转发出现异常。
:::note
注:
- 请在成功加入频道后调用该方法。
- 在直播场景中,只有角色为主播的用户才能调用该方法。
- 跨频道媒体流转发功能需要[联系技术支持](https://ticket.shengwang.cn/)开通。
- 该功能不支持 String 型 UID。
:::
### 参数 [#参数-3]
跨频道媒体流转发参数配置。详见 [ChannelMediaRelayConfiguration](/zh-CN/api-reference/rtc/flutter/class-channelmediarelayconfiguration)。
Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/flutter/class-rtcconnection)。
### 返回值 [#返回值-5]
方法成功调用时,无返回值;方法调用失败时,会抛出 [AgoraRtcException](/zh-CN/api-reference/rtc/flutter/class-agorartcexception) 异常,你需要捕获异常并进行处理。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
- -1: 一般性的错误(未明确归类)。
- -2: 参数无效。
- -8:内部状态错误。可能因为用户角色不是主播。
### 所属接口类 [#所属接口类-5]
- [RtcEngineEx](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_irtcengineex)
## stopChannelMediaRelay [#stopchannelmediarelay]
停止跨频道媒体流转发。一旦停止,主播会退出所有目标频道。
```dart
Future stopChannelMediaRelay();
```
成功调用该方法后,SDK 会触发 [onChannelMediaRelayStateChanged](/zh-CN/api-reference/rtc/flutter/cloud-media-relay/channel-media-relay#callback_irtcengineeventhandler_onchannelmediarelaystatechanged) 回调。如果报告 `relayStateIdle` (0) 和 `relayOk` (0),则表示已停止转发媒体流。
:::note
注: 如果该方法调用不成功,SDK 会触发 [onChannelMediaRelayStateChanged](/zh-CN/api-reference/rtc/flutter/cloud-media-relay/channel-media-relay#callback_irtcengineeventhandler_onchannelmediarelaystatechanged) 回调,并报告状态码 `relayErrorServerNoResponse` (2) 或 `relayErrorServerConnectionLost` (8)。你可以调用 [leaveChannel](/zh-CN/api-reference/rtc/flutter/channel#api_irtcengine_leavechannel2) 方法离开频道,跨频道媒体流转发会自动停止。
:::
### 返回值 [#返回值-6]
方法成功调用时,无返回值;方法调用失败时,会抛出 [AgoraRtcException](/zh-CN/api-reference/rtc/flutter/class-agorartcexception) 异常,你需要捕获异常并进行处理。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
- -5: 方法调用被拒绝。当前没有正在进行的跨频道媒体流转发。
### 所属接口类 [#所属接口类-6]
- [RtcEngine](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_irtcengine)
## stopChannelMediaRelayEx [#stopchannelmediarelayex]
停止跨频道媒体流转发。一旦停止,主播会退出所有目标频道。
```dart
Future stopChannelMediaRelayEx(RtcConnection connection);
```
成功调用该方法后,SDK 会触发 [onChannelMediaRelayStateChanged](/zh-CN/api-reference/rtc/flutter/cloud-media-relay/channel-media-relay#callback_irtcengineeventhandler_onchannelmediarelaystatechanged) 回调。如果报告 `relayStateIdle` (0) 和 `relayOk` (0),则表示已停止转发媒体流。
:::note
注: 如果该方法调用不成功,SDK 会触发 [onChannelMediaRelayStateChanged](/zh-CN/api-reference/rtc/flutter/cloud-media-relay/channel-media-relay#callback_irtcengineeventhandler_onchannelmediarelaystatechanged) 回调,并报告状态码 `relayErrorServerNoResponse` (2) 或 `relayErrorServerConnectionLost` (8)。你可以调用 [leaveChannel](/zh-CN/api-reference/rtc/flutter/channel#api_irtcengine_leavechannel2) 方法离开频道,跨频道媒体流转发会自动停止。
:::
### 参数 [#参数-4]
Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/flutter/class-rtcconnection)。
### 返回值 [#返回值-7]
方法成功调用时,无返回值;方法调用失败时,会抛出 [AgoraRtcException](/zh-CN/api-reference/rtc/flutter/class-agorartcexception) 异常,你需要捕获异常并进行处理。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
- -5: 方法调用被拒绝。当前没有正在进行的跨频道媒体流转发。
### 所属接口类 [#所属接口类-7]
- [RtcEngineEx](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_irtcengineex)
## onChannelMediaRelayStateChanged [#onchannelmediarelaystatechanged]
跨频道媒体流转发状态发生改变回调。
```dart
final void Function(
ChannelMediaRelayState state, ChannelMediaRelayError code)?
onChannelMediaRelayStateChanged;
```
当跨频道媒体流转发状态发生改变时,SDK 会触发该回调,并报告当前的转发状态以及相关的错误信息。
### 参数 [#参数-5]
跨频道媒体流转发状态。详见 [ChannelMediaRelayState](/zh-CN/api-reference/rtc/flutter/enum-channelmediarelaystate)。
跨频道媒体流转发出错的错误码。详见 [ChannelMediaRelayError](/zh-CN/api-reference/rtc/flutter/enum-channelmediarelayerror)。
### 所属接口类 [#所属接口类-8]
- [RtcEngineEventHandler](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_irtcengineeventhandler)