# 跨频道媒体流转发 (/zh-CN/api-reference/rtc/android/cloud-media-relay/channel-media-relay)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

<a id="toc_channel_media_relay"></a>

<a id="api_irtcengine_pauseallchannelmediarelay"></a>

<a id="ariaid-title2"></a>

## pauseAllChannelMediaRelay [#pauseallchannelmediarelay]

暂停向所有目标频道的跨频道媒体流转发。

<a id="api_irtcengine_pauseallchannelmediarelay__prototype"></a>

```java
public abstract int pauseAllChannelMediaRelay();
```

<a id="api_irtcengine_pauseallchannelmediarelay__detailed_desc"></a>

你可以调用该方法暂停向所有目标频道转发媒体流。如需恢复转发，请调用 [resumeAllChannelMediaRelay](/zh-CN/api-reference/rtc/android/cloud-media-relay/channel-media-relay#api_irtcengine_resumeallchannelmediarelay) 方法。

:::note
注： 请在调用 [startOrUpdateChannelMediaRelay](/zh-CN/api-reference/rtc/android/cloud-media-relay/channel-media-relay#api_irtcengine_startorupdatechannelmediarelay) 方法之后调用该方法。
:::

<a id="api_irtcengine_pauseallchannelmediarelay__return_values"></a>

### 返回值 [#返回值]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

  - -5：调用被拒绝，当前没有正在进行的跨频道媒体流转发。

### 所属接口类 [#所属接口类]

- [RtcEngine](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengine)

<a id="api_irtcengineex_pauseallchannelmediarelayex"></a>

<a id="ariaid-title3"></a>

## pauseAllChannelMediaRelayEx [#pauseallchannelmediarelayex]

暂停向所有目标频道的跨频道媒体流转发。

<a id="api_irtcengineex_pauseallchannelmediarelayex__prototype"></a>

```java
public abstract int pauseAllChannelMediaRelayEx(RtcConnection connection);
```

<a id="api_irtcengineex_pauseallchannelmediarelayex__detailed_desc"></a>

<a id="废弃"></a>

:::error[废弃]
自 v4.2.0 版本废弃，请改用 [startOrUpdateChannelMediaRelayEx](/zh-CN/api-reference/rtc/android/cloud-media-relay/channel-media-relay#api_irtcengineex_startorupdatechannelmediarelayex)。
:::

你可以调用该方法暂停向所有目标频道转发媒体流。如需恢复转发，请调用 [resumeAllChannelMediaRelay](/zh-CN/api-reference/rtc/android/cloud-media-relay/channel-media-relay#api_irtcengine_resumeallchannelmediarelay) 方法。

:::note
注： 请在调用 [startOrUpdateChannelMediaRelayEx](/zh-CN/api-reference/rtc/android/cloud-media-relay/channel-media-relay#api_irtcengineex_startorupdatechannelmediarelayex) 方法后调用此方法。
:::

<a id="api_irtcengineex_pauseallchannelmediarelayex__scenario"></a>

### 适用场景 [#适用场景]

该方法适用于多频道场景。

<a id="api_irtcengineex_pauseallchannelmediarelayex__parameters"></a>

### 参数 [#参数]

<ParameterList>
<a id="connection"></a>
<Parameter name="connection">

连接信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/android/class-rtcconnection)。

</Parameter>
</ParameterList>

<a id="api_irtcengineex_pauseallchannelmediarelayex__return_values"></a>

### 返回值 [#返回值-1]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

  - -5：调用被拒绝，当前没有正在进行的跨频道媒体流转发。

### 所属接口类 [#所属接口类-1]

- [RtcEngineEx](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengineex)

<a id="api_irtcengine_resumeallchannelmediarelay"></a>

<a id="ariaid-title4"></a>

## resumeAllChannelMediaRelay [#resumeallchannelmediarelay]

恢复向所有目标频道的跨频道媒体流转发。

<a id="api_irtcengine_resumeallchannelmediarelay__prototype"></a>

```java
public abstract int resumeAllChannelMediaRelay();
```

<a id="api_irtcengine_resumeallchannelmediarelay__detailed_desc"></a>

调用 [pauseAllChannelMediaRelay](/zh-CN/api-reference/rtc/android/cloud-media-relay/channel-media-relay#api_irtcengine_pauseallchannelmediarelay) 后，你可以调用该方法恢复媒体流的转发。

:::note
注： 请在调用 [pauseAllChannelMediaRelay](/zh-CN/api-reference/rtc/android/cloud-media-relay/channel-media-relay#api_irtcengine_pauseallchannelmediarelay) 后再调用该方法。
:::

<a id="api_irtcengine_resumeallchannelmediarelay__return_values"></a>

### 返回值 [#返回值-2]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

  - -5：调用被拒绝，当前没有已暂停的跨频道媒体流转发。

### 所属接口类 [#所属接口类-2]

- [RtcEngine](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengine)

<a id="api_irtcengineex_resumeallchannelmediarelayex"></a>

<a id="ariaid-title5"></a>

## resumeAllChannelMediaRelayEx [#resumeallchannelmediarelayex]

恢复向所有目标频道的跨频道媒体流转发。

<a id="api_irtcengineex_resumeallchannelmediarelayex__prototype"></a>

```java
public abstract int resumeAllChannelMediaRelayEx(RtcConnection connection);
```

<a id="api_irtcengineex_resumeallchannelmediarelayex__detailed_desc"></a>

调用 [pauseAllChannelMediaRelayEx](/zh-CN/api-reference/rtc/android/cloud-media-relay/channel-media-relay#api_irtcengineex_pauseallchannelmediarelayex) 后，可以调用此方法恢复媒体流的转发。

:::note
注： 请在调用 [pauseAllChannelMediaRelayEx](/zh-CN/api-reference/rtc/android/cloud-media-relay/channel-media-relay#api_irtcengineex_pauseallchannelmediarelayex) 方法后再调用此方法。
:::

<a id="api_irtcengineex_resumeallchannelmediarelayex__scenario"></a>

### 适用场景 [#适用场景-1]

该方法适用于多频道场景。

<a id="api_irtcengineex_resumeallchannelmediarelayex__parameters"></a>

### 参数 [#参数-1]

<ParameterList>
<a id="connection-1"></a>
<Parameter name="connection">

连接信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/android/class-rtcconnection)。

</Parameter>
</ParameterList>

<a id="api_irtcengineex_resumeallchannelmediarelayex__return_values"></a>

### 返回值 [#返回值-3]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

  - -5：调用被拒绝，当前没有处于暂停状态的跨频道媒体流转发。

### 所属接口类 [#所属接口类-3]

- [RtcEngineEx](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengineex)

<a id="api_irtcengine_startorupdatechannelmediarelay"></a>

<a id="ariaid-title6"></a>

## startOrUpdateChannelMediaRelay [#startorupdatechannelmediarelay]

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

<a id="api_irtcengine_startorupdatechannelmediarelay__prototype"></a>

```java
public abstract int startOrUpdateChannelMediaRelay(ChannelMediaRelayConfiguration channelMediaRelayConfiguration);
```

<a id="api_irtcengine_startorupdatechannelmediarelay__detailed_desc"></a>

:::info[自从]
自 v4.2.0 版本新增。
:::

首次成功调用该方法会将媒体流从源频道转发到目标频道。若需将媒体流转发到其他频道，或退出当前的某个媒体流转发，可再次调用该方法以更新目标频道。该功能最多支持将媒体流转发到六个目标频道。

:::note
注： 请在加入频道后调用该方法。该方法仅在你是直播频道中的主播时生效。跨频道媒体流转发功能需[联系技术支持](https://ticket.shengwang.cn/)开启。该 API 不支持字符串用户 User Account。
:::

<a id="api_irtcengine_startorupdatechannelmediarelay__related"></a>

### 相关回调 [#相关回调]

成功调用该方法后，SDK 会触发 [onChannelMediaRelayStateChanged](/zh-CN/api-reference/rtc/android/cloud-media-relay/channel-media-relay#callback_irtcengineeventhandler_onchannelmediarelaystatechanged) 回调报告媒体流转发的状态。

- 如果 [onChannelMediaRelayStateChanged](/zh-CN/api-reference/rtc/android/cloud-media-relay/channel-media-relay#callback_irtcengineeventhandler_onchannelmediarelaystatechanged) 回调返回 `RELAY_STATE_RUNNING`（2）和 `RELAY_OK`（0），表示 SDK 成功开始将媒体流从源频道转发到目标频道。
- 如果回调返回 `RELAY_STATE_FAILURE`（3），表示媒体流转发过程中发生异常。

<a id="api_irtcengine_startorupdatechannelmediarelay__parameters"></a>

### 参数 [#参数-2]

<ParameterList>
<a id="channelmediarelayconfiguration"></a>
<Parameter name="channelMediaRelayConfiguration">

媒体流转发的配置。详见 [ChannelMediaRelayConfiguration](/zh-CN/api-reference/rtc/android/class-channelmediarelayconfiguration)。

</Parameter>
</ParameterList>

<a id="api_irtcengine_startorupdatechannelmediarelay__return_values"></a>

### 返回值 [#返回值-4]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

  - -1：发生通用错误（无明确原因）。
  - -2：参数无效。
  - -8：内部状态错误，可能是因为用户不是主播。

### 所属接口类 [#所属接口类-4]

- [RtcEngine](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengine)

<a id="api_irtcengineex_startorupdatechannelmediarelayex"></a>

<a id="ariaid-title7"></a>

## startOrUpdateChannelMediaRelayEx [#startorupdatechannelmediarelayex]

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

<a id="api_irtcengineex_startorupdatechannelmediarelayex__prototype"></a>

```java
public abstract int startOrUpdateChannelMediaRelayEx(ChannelMediaRelayConfiguration channelMediaRelayConfiguration, RtcConnection connection);
```

<a id="api_irtcengineex_startorupdatechannelmediarelayex__detailed_desc"></a>

:::info[自从]
自 v4.2.0 版本新增。
:::

首次成功调用该方法会将媒体流从源频道转发到目标频道。若需将媒体流转发到其他频道，或退出当前的某个媒体流转发，可再次调用该方法以更新目标频道。该功能最多支持将媒体流转发到六个目标频道。

:::note
注：

- 请在加入频道后调用该方法。
- 该方法仅在你是直播频道中的主播时有效。
- 跨频道媒体流转发功能需[联系技术支持](https://ticket.shengwang.cn/)开启。
- 该 API 不支持字符串用户 User Account。
:::

<a id="api_irtcengineex_startorupdatechannelmediarelayex__scenario"></a>

### 适用场景 [#适用场景-2]

该方法适用于多频道场景。

<a id="api_irtcengineex_startorupdatechannelmediarelayex__related"></a>

### 相关回调 [#相关回调-1]

成功调用该方法后，SDK 会触发 [onChannelMediaRelayStateChanged](/zh-CN/api-reference/rtc/android/cloud-media-relay/channel-media-relay#callback_irtcengineeventhandler_onchannelmediarelaystatechanged) 回调报告媒体流转发的状态。

- 若回调返回 `RELAY_STATE_RUNNING`（2）和 `RELAY_OK`（0），表示 SDK 成功开始将媒体流从源频道转发到目标频道。
- 若回调返回 `RELAY_STATE_FAILURE`（3），表示媒体流转发过程中发生异常。

<a id="api_irtcengineex_startorupdatechannelmediarelayex__parameters"></a>

### 参数 [#参数-3]

<ParameterList>
<a id="channelmediarelayconfiguration-1"></a>
<Parameter name="channelMediaRelayConfiguration">

媒体流转发的配置。详见 [ChannelMediaRelayConfiguration](/zh-CN/api-reference/rtc/android/class-channelmediarelayconfiguration)。

</Parameter>
<a id="connection-2"></a>
<Parameter name="connection">

连接信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/android/class-rtcconnection)。

</Parameter>
</ParameterList>

<a id="api_irtcengineex_startorupdatechannelmediarelayex__return_values"></a>

### 返回值 [#返回值-5]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

  - -1：发生通用错误（无明确原因）。
  - -2：参数无效。
  - -8：内部状态错误，可能是因为用户不是主播。

### 所属接口类 [#所属接口类-5]

- [RtcEngineEx](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengineex)

<a id="api_irtcengine_stopchannelmediarelay"></a>

<a id="ariaid-title8"></a>

## stopChannelMediaRelay [#stopchannelmediarelay]

停止跨频道媒体流转发。

<a id="api_irtcengine_stopchannelmediarelay__prototype"></a>

```java
public abstract int stopChannelMediaRelay();
```

<a id="api_irtcengine_stopchannelmediarelay__detailed_desc"></a>

调用该方法后，主播会退出所有目标频道。

:::note
注： 如果方法调用失败，SDK 会通过 [onChannelMediaRelayStateChanged](/zh-CN/api-reference/rtc/android/cloud-media-relay/channel-media-relay#callback_irtcengineeventhandler_onchannelmediarelaystatechanged) 回调报告 `RELAY_ERROR_SERVER_NO_RESPONSE`（2）或 `RELAY_ERROR_SERVER_CONNECTION_LOST`（8）错误码。你也可以调用 `leaveChannel` 方法离开频道，媒体流转发会自动停止。
:::

<a id="api_irtcengine_stopchannelmediarelay__return_values"></a>

### 返回值 [#返回值-6]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

  - -5：调用被拒绝，当前没有正在进行的跨频道媒体流转发。

### 所属接口类 [#所属接口类-6]

- [RtcEngine](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengine)

<a id="api_irtcengineex_stopchannelmediarelayex"></a>

<a id="ariaid-title9"></a>

## stopChannelMediaRelayEx [#stopchannelmediarelayex]

停止跨频道媒体流转发。

<a id="api_irtcengineex_stopchannelmediarelayex__prototype"></a>

```java
public abstract int stopChannelMediaRelayEx(RtcConnection connection);
```

<a id="api_irtcengineex_stopchannelmediarelayex__detailed_desc"></a>

调用该方法停止跨频道媒体流转发。一旦转发停止，主播会退出所有目标频道。

:::note
注： 如果方法调用失败，SDK 会通过 [onChannelMediaRelayStateChanged](/zh-CN/api-reference/rtc/android/cloud-media-relay/channel-media-relay#callback_irtcengineeventhandler_onchannelmediarelaystatechanged) 回调报告 `RELAY_ERROR_SERVER_NO_RESPONSE`（2）或 `RELAY_ERROR_SERVER_CONNECTION_LOST`（8）错误码。你可以调用 `leaveChannel` 方法离开频道，媒体流转发会自动停止。
:::

<a id="api_irtcengineex_stopchannelmediarelayex__scenario"></a>

### 适用场景 [#适用场景-3]

该方法适用于多频道场景。

<a id="api_irtcengineex_stopchannelmediarelayex__parameters"></a>

### 参数 [#参数-4]

<ParameterList>
<a id="connection-3"></a>
<Parameter name="connection">

连接信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/android/class-rtcconnection)。

</Parameter>
</ParameterList>

<a id="api_irtcengineex_stopchannelmediarelayex__return_values"></a>

### 返回值 [#返回值-7]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

  - -5：调用被拒绝，当前没有正在进行的跨频道媒体流转发。

### 所属接口类 [#所属接口类-7]

- [RtcEngineEx](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengineex)

<a id="callback_irtcengineeventhandler_onchannelmediarelaystatechanged"></a>

<a id="ariaid-title10"></a>

## onChannelMediaRelayStateChanged [#onchannelmediarelaystatechanged]

跨频道媒体流转发状态发生变化回调。

<a id="callback_irtcengineeventhandler_onchannelmediarelaystatechanged__prototype"></a>

```java
public void onChannelMediaRelayStateChanged(int state, int code)
```

<a id="callback_irtcengineeventhandler_onchannelmediarelaystatechanged__detailed_desc"></a>

该回调返回当前跨频道媒体流转发的错误信息。

<a id="callback_irtcengineeventhandler_onchannelmediarelaystatechanged__timing"></a>

### 触发时机 [#触发时机]

该回调在跨频道媒体流转发状态发生变化时被触发。

<a id="callback_irtcengineeventhandler_onchannelmediarelaystatechanged__parameters"></a>

### 参数 [#参数-5]

<ParameterList>
<a id="state"></a>
<Parameter name="state">

跨频道媒体流转发的状态码：

- `RELAY_STATE_IDLE`：SDK 正在初始化。
- `RELAY_STATE_CONNECTING`：SDK 尝试将媒体流转发到目标频道。
- `RELAY_STATE_RUNNING`：SDK 成功将媒体流转发到目标频道。
- `RELAY_STATE_FAILURE`：发生错误，详见 [code](/zh-CN/api-reference/rtc/android/play/rte-player#api_error_code)。

</Parameter>
<a id="code"></a>
<Parameter name="code">

跨频道媒体流转发的错误码：

- `RELAY_OK`：一切正常。
- `RELAY_ERROR_SERVER_ERROR_RESPONSE`：服务器响应出错。
- `RELAY_ERROR_SERVER_NO_RESPONSE`：服务器无响应。该错误可能由网络连接不佳引起。如果在启动跨频道媒体流转发时出现该错误，可以稍后重试；如果在转发过程中出现该错误，可以调用 `leaveChannel` 离开频道。该错误也可能是项目未启用跨频道媒体流转发服务导致的。你可以[联系技术支持](https://ticket.shengwang.cn/)启用该服务。
- `RELAY_ERROR_NO_RESOURCE_AVAILABLE`：SDK 无法访问服务，可能由于服务器资源有限。
- `RELAY_ERROR_FAILED_JOIN_SRC`：服务器无法发送转发请求。
- `RELAY_ERROR_FAILED_JOIN_DEST`：服务器无法接受转发请求。
- `RELAY_ERROR_FAILED_PACKET_RECEIVED_FROM_SRC`：服务器无法接收媒体流。
- `RELAY_ERROR_FAILED_PACKET_SENT_TO_DEST`：服务器无法发送媒体流。
- `RELAY_ERROR_SERVER_CONNECTION_LOST`：由于网络连接不佳，SDK 与服务器断开连接。你可以调用 `leaveChannel` 离开频道。
- `RELAY_ERROR_INTERNAL_ERROR`：服务器内部发生错误。
- `RELAY_ERROR_SRC_TOKEN_EXPIRED`：源频道的 Token 已过期。
- `RELAY_ERROR_DEST_TOKEN_EXPIRED`：目标频道的 Token 已过期。

</Parameter>
</ParameterList>

### 所属接口类 [#所属接口类-8]

- [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengineeventhandler)