跨频道媒体流转发

pauseAllChannelMediaRelay

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

Java
public abstract int pauseAllChannelMediaRelay();

开始跨频道转发媒体流后，如果你需要暂停向所有频道转发媒体流，可以调用该方法；暂停后，如果要恢复跨频道媒体流转发，可以调用 resumeAllChannelMediaRelay 方法。

注意：该方法需要在调用 startOrUpdateChannelMediaRelay 开始跨频道媒体流转发后调用。

返回值

0: 方法调用成功。
< 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

RtcEngine

pauseAllChannelMediaRelayEx

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

Java
public abstract int pauseAllChannelMediaRelayEx(RtcConnection connection);

注意：该方法需要在调用 startOrUpdateChannelMediaRelayEx 开始跨频道媒体流转发后调用。

参数

参数名	描述
connection	Connection 信息。详见 `RtcConnection`。

返回值

0: 方法调用成功。
< 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

RtcEngineEx

resumeAllChannelMediaRelay

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

Java
public abstract int resumeAllChannelMediaRelay();

调用 pauseAllChannelMediaRelay 方法后，如果你需要恢复向所有目标频道转发媒体流，可以调用该方法。

注意：该方法需要在 pauseAllChannelMediaRelay 后调用。

返回值

0：方法调用成功。
< 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

RtcEngine

resumeAllChannelMediaRelayEx

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

Java
public abstract int resumeAllChannelMediaRelayEx(RtcConnection connection);

调用 pauseAllChannelMediaRelayEx 方法后，如果你需要恢复向所有目标频道转发媒体流，可以调用该方法。

注意：该方法需要在 pauseAllChannelMediaRelayEx 后调用。

参数

参数名	描述
connection	Connection 信息。详见 `RtcConnection`。

返回值

0：方法调用成功。
< 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

RtcEngineEx

startChannelMediaRelay

开始跨频道媒体流转发。该方法可用于实现跨频道连麦等场景。

Java
public abstract int startChannelMediaRelay(
      ChannelMediaRelayConfiguration channelMediaRelayConfiguration);

弃用

该方法已废弃。请改用 startOrUpdateChannelMediaRelay 。

成功调用该方法后，SDK 会触发 onChannelMediaRelayStateChanged 和 onChannelMediaRelayEvent 回调，并在回调中报告当前的跨频道媒体流转发状态和事件。

如果 onChannelMediaRelayStateChanged 回调报告 RELAY_STATE_RUNNING (2) 和 RELAY_OK (0)，且 onChannelMediaRelayEvent 回调报告 RELAY_EVENT_PACKET_SENT_TO_DEST_CHANNEL (4)，则表示 SDK 开始在源频道和目标频道之间转发媒体流。
如果 onChannelMediaRelayStateChanged 回调报告 RELAY_STATE_FAILURE (3)，则表示跨频道媒体流转发出现异常。

注意：

请在成功加入频道后调用该方法。
在直播场景中，只有角色为主播的用户才能调用该方法。
成功调用该方法后，若你想再次调用该方法，必须先调用 stopChannelMediaRelay 方法退出当前的转发状态。
跨频道媒体流转发功能需要联系技术支持开通。
该功能不支持 String 型 UID。

参数

参数名	描述
channelMediaRelayConfiguration	跨频道媒体流转发参数配置。详见 `ChannelMediaRelayConfiguration`。

返回值

0：方法调用成功。
< 0：方法调用失败。
- -1: 一般性的错误（未明确归类）。
- -2: 参数无效。
- -7: 方法调用被拒绝。可能因为 SDK 未初始化成功，或用户角色不是主播。
- -8：内部状态错误。可能因为用户角色不是主播。

所属接口类

RtcEngine

startChannelMediaRelayEx

开始跨频道媒体流转发。该方法可用于实现跨频道连麦等场景。

Java
public abstract int startChannelMediaRelayEx(
      ChannelMediaRelayConfiguration channelMediaRelayConfiguration, RtcConnection connection);

弃用

该方法已废弃。请改用 startOrUpdateChannelMediaRelayEx 。

成功调用该方法后，SDK 会触发 onChannelMediaRelayStateChanged 和 onChannelMediaRelayEvent 回调，并在回调中报告当前的跨频道媒体流转发状态和事件。

如果 onChannelMediaRelayStateChanged 回调报告 RELAY_STATE_RUNNING (2) 和 RELAY_OK (0)，且 onChannelMediaRelayEvent 回调报告 RELAY_EVENT_PACKET_SENT_TO_DEST_CHANNEL (4)，则表示 SDK 开始在源频道和目标频道之间转发媒体流。
如果 onChannelMediaRelayStateChanged 回调报告 RELAY_STATE_FAILURE (3)，则表示跨频道媒体流转发出现异常。

注意：

请在成功加入频道后调用该方法。
在直播场景中，只有角色为主播的用户才能调用该方法。
成功调用该方法后，若你想再次调用该方法，必须先调用 stopChannelMediaRelayEx 方法退出当前的转发状态。
跨频道媒体流转发功能需要联系技术支持开通。
该功能不支持 String 型 UID。

参数

参数名	描述
channelMediaRelayConfiguration	跨频道媒体流转发参数配置。详见 `ChannelMediaRelayConfiguration`。
connection	Connection 信息。详见 `RtcConnection`。

返回值

0：方法调用成功。
< 0：方法调用失败。
- -1: 一般性的错误（未明确归类）。
- -2: 参数无效。
- -7: 方法调用被拒绝。可能因为 SDK 未初始化成功，或用户角色不是主播。
- -8：内部状态错误。可能因为用户角色不是主播。

所属接口类

RtcEngineEx

startOrUpdateChannelMediaRelay

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

Java
public abstract int startOrUpdateChannelMediaRelay(
      ChannelMediaRelayConfiguration channelMediaRelayConfiguration);

自从

v4.2.0

首次成功调用该方法将开始跨频道转发媒体流。如需将流转发到多个目标频道，或退出当前的转发频道，可以再次调用该方法添加或移除转发的目标频道。该功能最多支持将媒体流转发至 6 个目标频道。

成功调用该方法后，SDK 会触发 onChannelMediaRelayStateChanged 回调，报告当前的跨频道媒体流转发状态。常见状态如下：

如果 onChannelMediaRelayStateChanged 回调报告 RELAY_STATE_RUNNING (2) 和 RELAY_OK (0)，则表示 SDK 开始在源频道和目标频道之间转发媒体流。
如果 onChannelMediaRelayStateChanged 回调报告 RELAY_STATE_FAILURE (3)，则表示跨频道媒体流转发出现异常。

注意：

请在成功加入频道后调用该方法。
在直播场景中，只有角色为主播的用户才能调用该方法。
跨频道媒体流转发功能需要联系技术支持开通。
该功能不支持 String 型 UID。

参数

参数名	描述
channelMediaRelayConfiguration	跨频道媒体流转发参数配置。详见 `ChannelMediaRelayConfiguration`。

返回值

0：方法调用成功。
< 0：方法调用失败。
- -1: 一般性的错误（未明确归类）。
- -2: 参数无效。
- -7: 方法调用被拒绝。可能因为 SDK 未初始化成功，或用户角色不是主播。
- -8：内部状态错误。可能因为用户角色不是主播。

所属接口类

RtcEngine

startOrUpdateChannelMediaRelayEx

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

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

自从

v4.2.0

成功调用该方法后，SDK 会触发 onChannelMediaRelayStateChanged 回调，报告当前的跨频道媒体流转发状态。常见状态如下：

如果 onChannelMediaRelayStateChanged 回调报告 RELAY_STATE_RUNNING (2) 和 RELAY_OK (0)，则表示 SDK 开始在源频道和目标频道之间转发媒体流。
如果 onChannelMediaRelayStateChanged 回调报告 RELAY_STATE_FAILURE (3)，则表示跨频道媒体流转发出现异常。

注意：

请在成功加入频道后调用该方法。
在直播场景中，只有角色为主播的用户才能调用该方法。
跨频道媒体流转发功能需要联系技术支持开通。
该功能不支持 String 型 UID。

参数

参数名	描述
channelMediaRelayConfiguration	跨频道媒体流转发参数配置。详见 `ChannelMediaRelayConfiguration`。
connection	Connection 信息。详见 `RtcConnection`。

返回值

0：方法调用成功。
< 0：方法调用失败。
- -1: 一般性的错误（未明确归类）。
- -2: 参数无效。
- -7: 方法调用被拒绝。可能因为 SDK 未初始化成功，或用户角色不是主播。
- -8：内部状态错误。可能因为用户角色不是主播。

所属接口类

RtcEngineEx

stopChannelMediaRelay

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

Java
public abstract int stopChannelMediaRelay();

成功调用该方法后，SDK 会触发 onChannelMediaRelayStateChanged 回调。如果报告 RELAY_STATE_IDLE (0) 和 RELAY_OK (0)，则表示已停止转发媒体流。

注意：如果该方法调用不成功，SDK 会触发 onChannelMediaRelayStateChanged 回调，并报告状态码 RELAY_ERROR_SERVER_NO_RESPONSE (2) 或 RELAY_ERROR_SERVER_CONNECTION_LOST (8)。你可以调用 leaveChannel [2/2] 方法离开频道，跨频道媒体流转发会自动停止。

返回值

0：方法调用成功。
< 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

RtcEngine

stopChannelMediaRelayEx

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

Java
public abstract int stopChannelMediaRelayEx(RtcConnection connection);

成功调用该方法后，SDK 会触发 onChannelMediaRelayStateChanged 回调。如果报告 RELAY_STATE_IDLE (0) 和 RELAY_OK (0)，则表示已停止转发媒体流。

参数

参数名	描述
connection	Connection 信息。详见 `RtcConnection`。

返回值

0：方法调用成功。
< 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

RtcEngineEx

updateChannelMediaRelay

更新媒体流转发的频道。

Java
public abstract int updateChannelMediaRelay(
      ChannelMediaRelayConfiguration channelMediaRelayConfiguration);

弃用

该方法已废弃。请改用 startOrUpdateChannelMediaRelay 。

成功开始跨频道转发媒体流后，如果你希望将流转发到多个目标频道，或退出当前的转发频道，可以调用该方法。

成功调用该方法后，SDK 会触发 onChannelMediaRelayEvent 回调，并在回调中报告状态码 RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL (7)。

注意：请在成功调用 startChannelMediaRelay 方法并收到 onChannelMediaRelayStateChanged(RELAY_STATE_RUNNING, RELAY_OK) 后调用该方法；否则，方法调用会失败。

参数

参数名	描述
channelMediaRelayConfiguration	跨频道媒体流转发参数配置。详见 `ChannelMediaRelayConfiguration` 。

返回值

0：方法调用成功。
< 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

RtcEngine

updateChannelMediaRelayEx

更新媒体流转发的频道。

Java
public abstract int updateChannelMediaRelayEx(
      ChannelMediaRelayConfiguration channelMediaRelayConfiguration, RtcConnection connection);

弃用

该方法已废弃。请改用 startOrUpdateChannelMediaRelayEx。

成功开始跨频道转发媒体流后，如果你希望将流转发到多个目标频道，或退出当前的转发频道，可以调用该方法。

成功调用该方法后，SDK 会触发 onChannelMediaRelayEvent 回调，并在回调中报告状态码 RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL (7)。

注意：请在成功调用 startChannelMediaRelayEx 方法并收到 onChannelMediaRelayStateChanged(RELAY_STATE_RUNNING, RELAY_OK) 后调用该方法；否则，方法调用会失败。

参数

参数名	描述
channelMediaRelayConfiguration	跨频道媒体流转发参数配置。详见 `ChannelMediaRelayConfiguration` 。
connection	Connection 信息。详见 `RtcConnection`。

返回值

0：方法调用成功。
< 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

RtcEngineEx

onChannelMediaRelayEvent

跨频道媒体流转发事件回调。

Java
public void onChannelMediaRelayEvent(int code) {}

弃用

该回调已废弃。

参数

参数名描述

参数名	描述
code	跨频道媒体流转发事件码： RELAY_EVENT_NETWORK_DISCONNECTED(0)：网络中断导致用户与服务器连接断开。 RELAY_EVENT_NETWORK_CONNECTED(1)：用户与服务器建立连接。 RELAY_EVENT_PACKET_JOINED_SRC_CHANNEL(2)：用户已加入源频道。 RELAY_EVENT_PACKET_JOINED_DEST_CHANNEL(3)：用户已加入目标频道。 RELAY_EVENT_PACKET_SENT_TO_DEST_CHANNEL(4)：SDK 开始向目标频道发送数据包。 RELAY_EVENT_PACKET_RECEIVED_VIDEO_FROM_SRC(5)：服务器收到了目标频道发送的视频流。 RELAY_EVENT_PACKET_RECEIVED_AUDIO_FROM_SRC(6)：服务器收到了目标频道发送的音频流 RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL(7)：目标频道已更新。 RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_NOT_CHANGE(9)：目标频道未发生改变，即目标频道更新失败。 RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_IS_NULL(10)：目标频道名为 `NULL`。 RELAY_EVENT_VIDEO_PROFILE_UPDATE(11)：视频属性已发送至服务器。 RELAY_EVENT_PAUSE_SEND_PACKET_TO_DEST_CHANNEL_SUCCESS(12)：暂停向目标频道转发媒体流成功。 RELAY_EVENT_PAUSE_SEND_PACKET_TO_DEST_CHANNEL_FAILED(13)：暂停向目标频道转发媒体流失败。 RELAY_EVENT_RESUME_SEND_PACKET_TO_DEST_CHANNEL_SUCCESS(14)：恢复向目标频道转发媒体流成功。 RELAY_EVENT_RESUME_SEND_PACKET_TO_DEST_CHANNEL_FAILED(15)：恢复向目标频道转发媒体流失败。

code

跨频道媒体流转发事件码：

RELAY_EVENT_NETWORK_DISCONNECTED(0)：网络中断导致用户与服务器连接断开。
RELAY_EVENT_NETWORK_CONNECTED(1)：用户与服务器建立连接。
RELAY_EVENT_PACKET_JOINED_SRC_CHANNEL(2)：用户已加入源频道。
RELAY_EVENT_PACKET_JOINED_DEST_CHANNEL(3)：用户已加入目标频道。
RELAY_EVENT_PACKET_SENT_TO_DEST_CHANNEL(4)：SDK 开始向目标频道发送数据包。
RELAY_EVENT_PACKET_RECEIVED_VIDEO_FROM_SRC(5)：服务器收到了目标频道发送的视频流。
RELAY_EVENT_PACKET_RECEIVED_AUDIO_FROM_SRC(6)：服务器收到了目标频道发送的音频流
RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL(7)：目标频道已更新。
RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_NOT_CHANGE(9)：目标频道未发生改变，即目标频道更新失败。
RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_IS_NULL(10)：目标频道名为 NULL。
RELAY_EVENT_VIDEO_PROFILE_UPDATE(11)：视频属性已发送至服务器。
RELAY_EVENT_PAUSE_SEND_PACKET_TO_DEST_CHANNEL_SUCCESS(12)：暂停向目标频道转发媒体流成功。
RELAY_EVENT_PAUSE_SEND_PACKET_TO_DEST_CHANNEL_FAILED(13)：暂停向目标频道转发媒体流失败。
RELAY_EVENT_RESUME_SEND_PACKET_TO_DEST_CHANNEL_SUCCESS(14)：恢复向目标频道转发媒体流成功。
RELAY_EVENT_RESUME_SEND_PACKET_TO_DEST_CHANNEL_FAILED(15)：恢复向目标频道转发媒体流失败。

所属接口类

IRtcEngineEventHandler

onChannelMediaRelayStateChanged

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

Java
public void onChannelMediaRelayStateChanged(int state, int code) {}

当跨频道媒体流转发状态发生改变时，SDK 会触发该回调，并报告当前的转发状态以及相关的错误信息。

参数

参数名描述

参数名	描述
state	跨频道媒体流转发状态： RELAY_STATE_IDLE (0)：SDK 正在初始化。 RELAY_STATE_CONNECTING (1)：SDK 尝试跨频道。 RELAY_STATE_RUNNING (2)：源频道主播成功加入目标频道。 RELAY_STATE_FAILURE (3)：发生异常，详见 `code` 中提示的错误信息。
code	跨频道媒体流转发出错的错误码： RELAY_OK (0)：一切正常。 RELAY_ERROR_SERVER_ERROR_RESPONSE (1)：服务器回应出错。 RELAY_ERROR_SERVER_NO_RESPONSE (2)：服务器无回应。该错误可能是网络状况不佳导致的。如果在发起跨频道连麦时报告该错误，你可以稍后重试；如果在跨频道连麦过程中报告该错误，你可以调用 `leaveChannel [2/2]` 方法离开频道。该错误也可能是由于当前的 App ID 未开启跨频道连麦服务导致的。你可以`联系技术支持`申请开通跨频道连麦服务。 RELAY_ERROR_NO_RESOURCE_AVAILABLE (3)：SDK 无法获取服务，可能是因为服务器资源有限导致。 RELAY_ERROR_FAILED_JOIN_SRC (4)：发起跨频道转发媒体流请求失败。 RELAY_ERROR_FAILED_JOIN_DEST (5)：接受跨频道转发媒体流请求失败。 RELAY_ERROR_FAILED_PACKET_RECEIVED_FROM_SRC (6)：服务器接收跨频道转发媒体流失败。 RELAY_ERROR_FAILED_PACKET_SENT_TO_DEST (7)：服务器发送跨频道转发媒体流失败。 RELAY_ERROR_SERVER_CONNECTION_LOST (8)：SDK 因网络质量不佳与服务器断开。你可以调用 `leaveChannel [2/2]` 方法离开当前频道。 RELAY_ERROR_INTERNAL_ERROR (9)：服务器内部出错。 RELAY_ERROR_SRC_TOKEN_EXPIRED (10)：源频道的 Token 已过期。 RELAY_ERROR_DEST_TOKEN_EXPIRED (11)：目标频道的 Token 已过期。

state

跨频道媒体流转发状态：

RELAY_STATE_IDLE (0)：SDK 正在初始化。
RELAY_STATE_CONNECTING (1)：SDK 尝试跨频道。
RELAY_STATE_RUNNING (2)：源频道主播成功加入目标频道。
RELAY_STATE_FAILURE (3)：发生异常，详见 code 中提示的错误信息。

code

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

RELAY_OK (0)：一切正常。
RELAY_ERROR_SERVER_ERROR_RESPONSE (1)：服务器回应出错。
RELAY_ERROR_SERVER_NO_RESPONSE (2)：服务器无回应。该错误可能是网络状况不佳导致的。如果在发起跨频道连麦时报告该错误，你可以稍后重试；如果在跨频道连麦过程中报告该错误，你可以调用 leaveChannel [2/2] 方法离开频道。该错误也可能是由于当前的 App ID 未开启跨频道连麦服务导致的。你可以联系技术支持申请开通跨频道连麦服务。
RELAY_ERROR_NO_RESOURCE_AVAILABLE (3)：SDK 无法获取服务，可能是因为服务器资源有限导致。
RELAY_ERROR_FAILED_JOIN_SRC (4)：发起跨频道转发媒体流请求失败。
RELAY_ERROR_FAILED_JOIN_DEST (5)：接受跨频道转发媒体流请求失败。
RELAY_ERROR_FAILED_PACKET_RECEIVED_FROM_SRC (6)：服务器接收跨频道转发媒体流失败。
RELAY_ERROR_FAILED_PACKET_SENT_TO_DEST (7)：服务器发送跨频道转发媒体流失败。
RELAY_ERROR_SERVER_CONNECTION_LOST (8)：SDK 因网络质量不佳与服务器断开。你可以调用 leaveChannel [2/2] 方法离开当前频道。
RELAY_ERROR_INTERNAL_ERROR (9)：服务器内部出错。
RELAY_ERROR_SRC_TOKEN_EXPIRED (10)：源频道的 Token 已过期。
RELAY_ERROR_DEST_TOKEN_EXPIRED (11)：目标频道的 Token 已过期。

所属接口类

IRtcEngineEventHandler

pauseAllChannelMediaRelay

返回值​

pauseAllChannelMediaRelayEx

参数​

返回值​

resumeAllChannelMediaRelay

返回值​

resumeAllChannelMediaRelayEx

参数​

返回值​

startChannelMediaRelay

参数​

返回值​

startChannelMediaRelayEx

参数​

返回值​

startOrUpdateChannelMediaRelay

参数​

返回值​

startOrUpdateChannelMediaRelayEx

参数​

返回值​

stopChannelMediaRelay

返回值​

stopChannelMediaRelayEx

参数​

返回值​

updateChannelMediaRelay

参数​

返回值​

updateChannelMediaRelayEx

参数​

返回值​

onChannelMediaRelayEvent

参数​

onChannelMediaRelayStateChanged

参数​

返回值

参数

返回值

返回值

参数

返回值

参数

返回值

参数

返回值

参数

返回值

参数

返回值

返回值

参数

返回值

参数

返回值

参数

返回值

参数

参数