# 跨频道媒体流转发 (/zh-CN/api-reference/rtc/cpp-all-platforms/cloud-media-relay/channel-media-relay) > For AI agents: see the complete documentation index at [llms.txt](/llms.txt). ## pauseAllChannelMediaRelay [#pauseallchannelmediarelay] 暂停向所有目标频道的跨频道媒体流转发。 ```cpp virtual int pauseAllChannelMediaRelay() = 0; ``` 你可以在开始跨频道媒体流转发后调用该方法,以暂停向所有目标频道转发媒体流。如需恢复转发,请调用 [resumeAllChannelMediaRelay](/zh-CN/api-reference/rtc/cpp-all-platforms/cloud-media-relay/channel-media-relay#api_irtcengine_resumeallchannelmediarelay) 方法。 :::note 注: 请在调用 [startOrUpdateChannelMediaRelay](/zh-CN/api-reference/rtc/cpp-all-platforms/cloud-media-relay/channel-media-relay#api_irtcengine_startorupdatechannelmediarelay) 方法之后调用此方法。 ::: ### 返回值 [#返回值] - 0:方法调用成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 - -5:调用被拒绝,当前没有正在进行的跨频道媒体流转发。 ### 所属接口类 [#所属接口类] - [IRtcEngine](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_irtcengine) ## pauseAllChannelMediaRelayEx [#pauseallchannelmediarelayex] 暂停向所有目标频道的跨频道媒体流转发。 ```cpp virtual int pauseAllChannelMediaRelayEx(const RtcConnection& connection) = 0; ``` 你可以在开始跨频道媒体流转发后调用该方法,暂停向所有目标频道转发媒体流。如需恢复转发,请调用 [resumeAllChannelMediaRelay](/zh-CN/api-reference/rtc/cpp-all-platforms/cloud-media-relay/channel-media-relay#api_irtcengine_resumeallchannelmediarelay) 方法。 :::note 注: 请在调用 [startOrUpdateChannelMediaRelayEx](/zh-CN/api-reference/rtc/cpp-all-platforms/cloud-media-relay/channel-media-relay#api_irtcengineex_startorupdatechannelmediarelayex) 方法后调用该方法。 ::: ### 适用场景 [#适用场景] 该方法适用于多频道场景。 ### 参数 [#参数] 连接信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/cpp-all-platforms/class-rtcconnection)。 ### 返回值 [#返回值-1] - 0:方法调用成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 - -5:调用被拒绝,当前没有正在进行的跨频道媒体流转发。 ### 所属接口类 [#所属接口类-1] - [IRtcEngineEx](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_irtcengineex) ## resumeAllChannelMediaRelay [#resumeallchannelmediarelay] 恢复向所有目标频道的跨频道媒体流转发。 ```cpp virtual int resumeAllChannelMediaRelay() = 0; ``` :::note 注: 请在调用 [pauseAllChannelMediaRelay](/zh-CN/api-reference/rtc/cpp-all-platforms/cloud-media-relay/channel-media-relay#api_irtcengine_pauseallchannelmediarelay) 方法后再调用该方法。 ::: ### 返回值 [#返回值-2] - 0:方法调用成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 - -5:调用被拒绝,当前没有已暂停的跨频道媒体流转发。 ### 所属接口类 [#所属接口类-2] - [IRtcEngine](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_irtcengine) ## resumeAllChannelMediaRelayEx [#resumeallchannelmediarelayex] 恢复向所有目标频道的跨频道媒体流转发。 ```cpp virtual int resumeAllChannelMediaRelayEx(const RtcConnection& connection) = 0; ``` :::note 注: 请在调用 [pauseAllChannelMediaRelayEx](/zh-CN/api-reference/rtc/cpp-all-platforms/cloud-media-relay/channel-media-relay#api_irtcengineex_pauseallchannelmediarelayex) 方法后调用该方法。 ::: ### 适用场景 [#适用场景-1] 该方法适用于多频道场景。 ### 参数 [#参数-1] 连接信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/cpp-all-platforms/class-rtcconnection)。 ### 返回值 [#返回值-3] - 0:方法调用成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 - -5:调用被拒绝,当前没有已暂停的跨频道媒体流转发。 ### 所属接口类 [#所属接口类-3] - [IRtcEngineEx](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_irtcengineex) ## startOrUpdateChannelMediaRelay [#startorupdatechannelmediarelay] 开始跨频道媒体流转发,或更新媒体流转发的目标频道。 ```cpp virtual int startOrUpdateChannelMediaRelay(const ChannelMediaRelayConfiguration &configuration) = 0; ``` :::info[自从] 自 v4.2.0 版本新增。 ::: 首次成功调用该方法会将媒体流从源频道转发到目标频道。若需将媒体流转发到其他频道,或停止转发到某个频道,可再次调用该方法更新目标频道。最多支持转发到六个目标频道。 :::note 注: - 请在加入频道后调用该方法。 - 该方法仅在你是直播频道中的主播时有效。 - 跨频道媒体流转发功能需[联系技术支持](https://ticket.shengwang.cn/)启用。 - 该方法不支持字符串用户 User Account。 ::: ### 相关回调 [#相关回调] 成功调用该方法后,SDK 会触发 [onChannelMediaRelayStateChanged](/zh-CN/api-reference/rtc/cpp-all-platforms/cloud-media-relay/channel-media-relay#callback_irtcengineeventhandler_onchannelmediarelaystatechanged) 回调,报告媒体流转发的状态。 常见状态如下: - 如果 [onChannelMediaRelayStateChanged](/zh-CN/api-reference/rtc/cpp-all-platforms/cloud-media-relay/channel-media-relay#callback_irtcengineeventhandler_onchannelmediarelaystatechanged) 回调返回 `RELAY_STATE_RUNNING`(2)和 `RELAY_OK`(0),表示 SDK 成功开始将媒体流从源频道转发到目标频道。 - 如果 [onChannelMediaRelayStateChanged](/zh-CN/api-reference/rtc/cpp-all-platforms/cloud-media-relay/channel-media-relay#callback_irtcengineeventhandler_onchannelmediarelaystatechanged) 回调返回 `RELAY_STATE_FAILURE`(3),表示媒体流转发过程中发生异常。 ### 参数 [#参数-2] 媒体流转发的配置,详见 [ChannelMediaRelayConfiguration](/zh-CN/api-reference/rtc/cpp-all-platforms/class-channelmediarelayconfiguration)。 ### 返回值 [#返回值-4] - 0:方法调用成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 - -1:发生通用错误。 - -2:参数无效。 - -8:内部状态错误,可能是因为用户不是主播。 ### 所属接口类 [#所属接口类-4] - [IRtcEngine](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_irtcengine) ## startOrUpdateChannelMediaRelayEx [#startorupdatechannelmediarelayex] 开始或更新跨频道媒体流转发。 ```cpp virtual int startOrUpdateChannelMediaRelayEx(const ChannelMediaRelayConfiguration& configuration, const RtcConnection& connection) = 0; ``` :::info[自从] 自 v4.2.0 版本新增。 ::: 首次成功调用该方法会开始将媒体流从源频道转发到目标频道。若需将媒体流转发到其他频道,或退出当前的某个媒体流转发,可再次调用该方法以更新目标频道。该功能最多支持将媒体流转发到六个目标频道。调用该方法成功后,SDK 会触发 [onChannelMediaRelayStateChanged](/zh-CN/api-reference/rtc/cpp-all-platforms/cloud-media-relay/channel-media-relay#callback_irtcengineeventhandler_onchannelmediarelaystatechanged) 回调,报告媒体流转发的状态: - 当回调返回 `RELAY_STATE_RUNNING`(2)和 `RELAY_OK`(0)时,表示媒体流已开始从源频道转发到目标频道。 - 当回调返回 `RELAY_STATE_FAILURE`(3)时,表示媒体流转发过程中出现异常。 :::note 注: - 请在加入频道后调用该方法。 - 该方法仅在你是直播频道中的主播时生效。 - 跨频道媒体流转发功能需[联系技术支持](https://ticket.shengwang.cn/)启用。 - 该方法不支持字符串用户 User Account。 ::: ### 适用场景 [#适用场景-2] 该方法适用于多频道场景。 ### 参数 [#参数-3] 媒体流转发的配置。详见 [ChannelMediaRelayConfiguration](/zh-CN/api-reference/rtc/cpp-all-platforms/class-channelmediarelayconfiguration)。 连接信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/cpp-all-platforms/class-rtcconnection)。 ### 返回值 [#返回值-5] - 0:方法调用成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 - -1:发生通用错误(无明确原因)。 - -2:参数无效。 - -8:内部状态错误,可能是因为用户不是主播。 ### 所属接口类 [#所属接口类-5] - [IRtcEngineEx](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_irtcengineex) ## stopChannelMediaRelay [#stopchannelmediarelay] 停止跨频道媒体流转发。 ```cpp virtual int stopChannelMediaRelay() = 0; ``` 调用该方法停止跨频道媒体流转发。一旦转发停止,主播会退出所有目标频道。 :::note 注: 如果方法调用失败,SDK 会触发 [onChannelMediaRelayStateChanged](/zh-CN/api-reference/rtc/cpp-all-platforms/cloud-media-relay/channel-media-relay#callback_irtcengineeventhandler_onchannelmediarelaystatechanged) 回调,并返回 `RELAY_ERROR_SERVER_NO_RESPONSE`(2)或 `RELAY_ERROR_SERVER_CONNECTION_LOST`(8)状态码。你也可以调用 `leaveChannel` 方法离开频道,跨频道媒体流转发将自动停止。 ::: ### 相关回调 [#相关回调-1] 成功调用该方法后,SDK 会触发 [onChannelMediaRelayStateChanged](/zh-CN/api-reference/rtc/cpp-all-platforms/cloud-media-relay/channel-media-relay#callback_irtcengineeventhandler_onchannelmediarelaystatechanged) 回调报告媒体流转发状态。 ### 返回值 [#返回值-6] - 0:方法调用成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 - -5:调用被拒绝,当前没有正在进行的跨频道媒体流转发。 ### 所属接口类 [#所属接口类-6] - [IRtcEngine](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_irtcengine) ## stopChannelMediaRelayEx [#stopchannelmediarelayex] 停止跨频道媒体流转发。 ```cpp virtual int stopChannelMediaRelayEx(const RtcConnection& connection) = 0; ``` 调用该方法可停止跨频道媒体流转发。一旦转发停止,主播会退出所有目标频道。 :::note 注: 如果方法调用失败,SDK 会触发 [onChannelMediaRelayStateChanged](/zh-CN/api-reference/rtc/cpp-all-platforms/cloud-media-relay/channel-media-relay#callback_irtcengineeventhandler_onchannelmediarelaystatechanged) 回调,并返回 `RELAY_ERROR_SERVER_NO_RESPONSE`(2)或 `RELAY_ERROR_SERVER_CONNECTION_LOST`(8)状态码。你也可以调用 `leaveChannel` 方法离开频道,跨频道媒体流转发会自动停止。 ::: ### 适用场景 [#适用场景-3] 该方法适用于多频道场景。 ### 相关回调 [#相关回调-2] 成功调用该方法后,SDK 会触发 [onChannelMediaRelayStateChanged](/zh-CN/api-reference/rtc/cpp-all-platforms/cloud-media-relay/channel-media-relay#callback_irtcengineeventhandler_onchannelmediarelaystatechanged) 回调。如果回调返回 `RELAY_STATE_IDLE`(0)和 `RELAY_OK`(0),表示主播成功停止转发。 ### 参数 [#参数-4] 连接信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/cpp-all-platforms/class-rtcconnection)。 ### 返回值 [#返回值-7] - 0:方法调用成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 - -5:调用被拒绝,当前没有正在进行的跨频道媒体流转发。 ### 所属接口类 [#所属接口类-7] - [IRtcEngineEx](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_irtcengineex) ## onChannelMediaRelayStateChanged [#onchannelmediarelaystatechanged] 跨频道媒体流转发状态变化回调。 ```cpp virtual void onChannelMediaRelayStateChanged(int state, int code) ``` 该回调返回当前跨频道媒体流转发的状态和错误码信息。 ### 参数 [#参数-5] 状态码。详见 [CHANNEL_MEDIA_RELAY_STATE](/zh-CN/api-reference/rtc/cpp-all-platforms/enum-channelmediarelaystate)。 错误码。详见 [CHANNEL_MEDIA_RELAY_ERROR](/zh-CN/api-reference/rtc/cpp-all-platforms/enum-channelmediarelayerror)。 ### 所属接口类 [#所属接口类-8] - [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_irtcengineeventhandler)