发布和订阅

muteAllRemoteAudioStreams

取消或恢复订阅所有远端用户的音频流。

C++
virtual int muteAllRemoteAudioStreams(bool mute) = 0;

成功调用该方法后，本地用户会取消或恢复订阅所有远端用户的音频流，包括在调用该方法后加入频道的用户的音频流。

注意

SDK 默认在加入频道时订阅所有远端用户的音频流，如果要修改此行为，可以在调用 joinChannel [2/2] 加入频道时设置 autoSubscribeAudio 为 false，即可在加入频道时取消订阅所有用户的音频流。

调用时机

该方法需要在加入频道后调用。

调用限制

如果在调用该方法之后又调用了 enableAudio 或 disableAudio，则后调用的方法会生效。

参数

mute

是否取消订阅所有远端用户的音频流：

true: 取消订阅所有远端用户的音频流。
false:（默认）订阅所有远端用户的音频流。

返回值

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

所属接口类

IRtcEngine

muteAllRemoteAudioStreamsEx

取消或恢复订阅所有远端用户的音频流。

C++
virtual int muteAllRemoteAudioStreamsEx(bool mute, const RtcConnection& connection) = 0;

详情

成功调用该方法后，本地用户会取消或恢复订阅远端用户的音频流，包括在调用该方法后加入频道的用户的音频流。

注意

该方法需要在加入频道后调用。
如果需要在加入频道前设置默认不订阅远端用户音频流，可以在调用 joinChannel [2/2] 加入频道时设置 autoSubscribeAudio 为 false。

参数

mute

是否取消订阅所有远端用户的音频流：

true: 取消订阅所有远端用户的音频流。
false:（默认）订阅所有远端用户的音频流。

connection

Connection 信息。详见 RtcConnection。

返回值

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

所属接口类

IRtcEngineEx

muteAllRemoteVideoStreams

取消或恢复订阅所有远端用户的视频流。

C++
virtual int muteAllRemoteVideoStreams(bool mute) = 0;

成功调用该方法后，本地用户会取消或恢复订阅所有远端用户的视频流，包括在调用该方法后加入频道的用户的视频流。

注意

SDK 默认在加入频道时订阅所有远端用户的视频流，如果要修改此行为，可以在调用 joinChannel [2/2] 加入频道时设置 autoSubscribeVideo 为 false，即可在加入频道时取消订阅所有用户的视频流。

调用时机

该方法需要在加入频道后调用。

调用限制

如果在调用该方法之后又调用了 enableVideo 或 disableVideo，则后调用的方法会生效。

参数

mute

是否取消订阅所有远端用户的视频流。

true: 取消订阅所有用户的视频流。
false:（默认）订阅所有用户的视频流。

返回值

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

所属接口类

IRtcEngine

muteAllRemoteVideoStreamsEx

取消或恢复订阅所有远端用户的视频流。

C++
virtual int muteAllRemoteVideoStreamsEx(bool mute, const RtcConnection& connection) = 0;

详情

成功调用该方法后，本地用户会取消或恢复订阅所有远端用户的视频流，包括在调用该方法后加入频道的用户的视频流。

参数

mute

是否取消订阅所有远端用户的视频流。

true: 取消订阅所有用户的视频流。
false:（默认）订阅所有用户的视频流。

connection

Connection 信息。详见 RtcConnection。

返回值

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

所属接口类

IRtcEngineEx

muteLocalAudioStream

取消或恢复发布本地音频流。

C++
virtual int muteLocalAudioStream(bool mute) = 0;

该方法用于控制是否发布本地采集的音频流。如果不发布本地采集的音频流，也不会禁用音频采集设备，所以不影响音频的采集状态。

调用时机

加入频道前后均可调用。

调用限制

无。

参数

mute

是否取消发布本地音频流。

true: 取消发布。
false:（默认）发布。

返回值

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

所属接口类

IRtcEngine

muteLocalAudioStreamEx

取消或恢复发布本地音频流。

C++
virtual int muteLocalAudioStreamEx(bool mute, const RtcConnection& connection) = 0;

详情

注意

该方法不影响音频采集状态，因为没有禁用音频采集设备。

成功调用该方法后，远端会触发 onUserMuteAudio 回调和 onRemoteAudioStateChanged 回调。

参数

mute

是否取消发布本地音频流。

true: 取消发布。
false:（默认）发布。

connection

Connection 信息。详见 RtcConnection。

返回值

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

所属接口类

IRtcEngineEx

muteLocalVideoStream

取消或恢复发布本地视频流。

C++
virtual int muteLocalVideoStream(bool mute) = 0;

该方法用于控制是否发布本地采集的视频流。如果不发布本地采集的视频流，也不会禁用视频采集设备，所以不影响视频的采集状态。

相比于调用 enableLocalVideo(false) 关闭本地视频流采集、从而取消发布本地视频流的方法，该方法响应速度更快。

调用时机

加入频道前后均可调用。

调用限制

无。

参数

mute

是否取消发送本地视频流。

true: 取消发送本地视频流。
false: （默认）发送本地视频流。

返回值

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

所属接口类

IRtcEngine

muteLocalVideoStreamEx

取消或恢复发布本地视频流。

C++
virtual int muteLocalVideoStreamEx(bool mute, const RtcConnection& connection) = 0;

详情

成功调用该方法后，远端会触发 onUserMuteVideo 回调。

注意

该方法不影响视频采集状态，没有禁用摄像头。

参数

mute

是否取消发送本地视频流。

true: 取消发送本地视频流。
false: （默认）发送本地视频流。

connection

Connection 信息。详见 RtcConnection。

返回值

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

所属接口类

IRtcEngineEx

muteRemoteAudioStream

取消或恢复订阅指定远端用户的音频流。

C++
virtual int muteRemoteAudioStream(uid_t uid, bool mute) = 0;

调用时机

该方法需要在加入频道后调用。

调用限制

无。

参数

uid

指定用户的用户 ID。

mute

是否取消订阅指定远端用户的音频流。

true: 取消订阅指定用户的音频流。
false:（默认）订阅指定用户的音频流。

返回值

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

所属接口类

IRtcEngine

muteRemoteAudioStreamEx

停止/恢复接收指定的音频流。

C++
virtual int muteRemoteAudioStreamEx(uid_t uid, bool mute, const RtcConnection& connection) = 0;

详情

该方法停止/恢复接收某一个指定远端用户的音频流。在加入频道前或后都可以调用。该方法的设置在离开频道后失效。

参数

uid

指定用户的 ID。

mute

是否停止接收指定音频流：

true: 停止接收指定音频流。
false:（默认）继续接收指定音频流。

connection

Connection 信息。详见 RtcConnection。

返回值

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

所属接口类

IRtcEngineEx

muteRemoteVideoStream

取消或恢复订阅指定远端用户的视频流。

C++
virtual int muteRemoteVideoStream(uid_t userId, bool mute) = 0;

调用时机

该方法需要在加入频道后调用。

调用限制

无。

参数

userId

指定用户的用户 ID。

mute

是否取消订阅指定远端用户的视频流。

true: 取消订阅指定用户的视频流。
false: （默认）订阅指定用户的视频流。

返回值

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

所属接口类

IRtcEngine

muteRemoteVideoStreamEx

停止/恢复接收指定的视频流。

C++
virtual int muteRemoteVideoStreamEx(uid_t uid, bool mute, const RtcConnection& connection) = 0;

详情

该方法停止/恢复接收某一个指定远端用户的视频流。在加入频道前或后都可以调用。该方法的设置在离开频道后失效。

参数

uid

远端用户的 ID。

mute

是否停止接收某个远端用户的视频：

true: 停止接收。
false: （默认）恢复接收。

connection

Connection 信息。详见 RtcConnection。

返回值

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

所属接口类

IRtcEngineEx

setRemoteVideoSubscriptionOptions

设置远端视频流的订阅选项。

C++
virtual int setRemoteVideoSubscriptionOptions(uid_t uid, const VideoSubscriptionOptions &options) = 0;

详情

当远端发送双流时，可调用此方法来设置远端视频流的订阅选项。SDK 对远端视频流的默认订阅行为取决于注册的视频观测器类型：

如果注册的是 IVideoFrameObserver 观测器，则默认订阅原始数据和编码后的数据。
如果注册的是 IVideoEncodedFrameObserver 观测器，则默认仅订阅编码后的数据。
如果注册了两种观测器，则默认跟随后注册的视频观测器。举例来说，如果后注册的是 IVideoFrameObserver 观测器，则默认订阅原始数据和编码后的数据。

如果你想修改以上默认行为，或者想针对不同 uid 设置不同的订阅选项，可调用该方法设置。

参数

uid: 远端用户 ID。
options: 视频流的订阅设置，详见 VideoSubscriptionOptions。

返回值

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

所属接口类

IRtcEngine

setRemoteVideoSubscriptionOptionsEx

设置远端视频流的订阅选项。

C++
virtual int setRemoteVideoSubscriptionOptionsEx(uid_t uid, const VideoSubscriptionOptions& options, const RtcConnection& connection) = 0;

详情

当远端发送双流时，可调用此方法来设置远端视频流的订阅选项。

参数

uid: 远端用户 ID。
options: 视频流的订阅设置，详见 VideoSubscriptionOptions。
connection: Connection 信息。详见 RtcConnection。

返回值

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

所属接口类

IRtcEngineEx

setSubscribeAudioAllowlist

设置音频订阅白名单。

C++
virtual int setSubscribeAudioAllowlist(uid_t* uidList, int uidNumber) = 0;

详情

你可以调用该方法指定想要订阅的音频流。

信息

该方法在加入频道前后均可调用。
音频订阅白名单不受 muteRemoteAudioStream、muteAllRemoteAudioStreams 以及 ChannelMediaOptions 中的 autoSubscribeAudio 的影响。
设置订阅白名单后，如果离开当前频道后再重新加入频道，白名单依然生效。
如果某个用户同时在音频订阅黑名单和白名单中，仅订阅黑名单生效。

参数

uidList: 音频订阅白名单的用户 ID 列表。

如果你想指定订阅某一发流用户的音频流，将该用户的 ID 加入此列表中。如果你想要将某一用户从订阅白名单中移除，需要重新调用 setSubscribeAudioAllowlist 方法更新音频订阅白名单的用户 ID 列表，使其不包含你想移除的用户的 uid。
uidNumber: 白名单用户 ID 列表中的用户数量。

返回值

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

所属接口类

IRtcEngine

setSubscribeAudioAllowlistEx

设置音频订阅白名单。

C++
virtual int setSubscribeAudioAllowlistEx(uid_t* uidList, int uidNumber, const RtcConnection& connection) = 0;

详情

你可以调用该方法指定想要订阅的音频流。

信息

该方法在加入频道前后均可调用。
音频订阅白名单不受 muteRemoteAudioStream、muteAllRemoteAudioStreams 以及 ChannelMediaOptions 中的 autoSubscribeAudio 的影响。
设置订阅白名单后，如果离开当前频道后再重新加入频道，白名单依然生效。
如果某个用户同时在音频订阅黑名单和白名单中，仅订阅黑名单生效。

参数

uidList: 音频订阅白名单的用户 ID 列表。

如果你想指定订阅某一发流用户的音频流，将该用户的 ID 加入此列表中。如果你想要将某一用户从订阅白名单中移除，需要重新调用 setSubscribeAudioAllowlist 方法更新音频订阅白名单的用户 ID 列表，使其不包含你想移除的用户的 uid。
uidNumber: 白名单用户 ID 列表中的用户数量。
connection: Connection 信息。详见 RtcConnection。

返回值

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

所属接口类

IRtcEngineEx

setSubscribeAudioBlocklist

设置音频订阅黑名单。

C++
virtual int setSubscribeAudioBlocklist(uid_t* uidList, int uidNumber) = 0;

详情

你可以调用该方法指定不订阅的音频流。

注意

该方法在加入频道前后均可调用。
音频订阅黑名单不受 muteRemoteAudioStream、muteAllRemoteAudioStreams 以及 ChannelMediaOptions 中的 autoSubscribeAudio 影响。
设置订阅黑名单后，如果离开当前频道后再重新加入频道，黑名单依然生效。
如果某个用户同时在音频订阅黑名单和白名单中，仅订阅黑名单生效。

参数

uidList: 订阅黑名单的用户 ID 列表。

如果你想指定不订阅某一发流用户的音频流，将该用户的 ID 加入此列表中。如果你想要将某一用户从订阅黑名单中移除，需要重新调用 setSubscribeAudioBlocklist 方法更新订阅黑名单的用户 ID 列表，使其不包含你想移除的用户的 uid。
uidNumber: 黑名单用户 ID 列表中的用户数量。

返回值

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

所属接口类

IRtcEngine

setSubscribeAudioBlocklistEx

设置音频订阅黑名单。

C++
virtual int setSubscribeAudioBlocklistEx(uid_t* uidList, int uidNumber, const RtcConnection& connection) = 0;

详情

你可以调用该方法指定不订阅的音频流。

注意

该方法在加入频道前后均可调用。
音频订阅黑名单不受 muteRemoteAudioStream、muteAllRemoteAudioStreams 以及 ChannelMediaOptions 中的 autoSubscribeAudio 影响。
设置订阅黑名单后，如果离开当前频道后再重新加入频道，黑名单依然生效。
如果某个用户同时在音频订阅黑名单和白名单中，仅订阅黑名单生效。

参数

uidList: 订阅黑名单的用户 ID 列表。

如果你想指定不订阅某一发流用户的音频流，将该用户的 ID 加入此列表中。如果你想要将某一用户从订阅黑名单中移除，需要重新调用 setSubscribeAudioBlocklist 方法更新订阅黑名单的用户 ID 列表，使其不包含你想移除的用户的 uid。
uidNumber: 黑名单用户 ID 列表中的用户数量。
connection: Connection 信息。详见 RtcConnection。

返回值

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

所属接口类

IRtcEngineEx

setSubscribeVideoAllowlist

设置视频订阅白名单。

C++
virtual int setSubscribeVideoAllowlist(uid_t* uidList, int uidNumber) = 0;

详情

你可以调用该方法指定想要订阅的视频流。

信息

该方法在加入频道前后均可调用。
视频订阅白名单不受 muteRemoteVideoStream、muteAllRemoteVideoStreams 以及 ChannelMediaOptions 中的 autoSubscribeVideo 的影响。
设置订阅白名单后，如果离开当前频道后再重新加入频道，白名单依然生效。
如果某个用户同时在音频订阅黑名单和白名单中，仅订阅黑名单生效。

参数

uidList: 视频订阅白名单的用户 ID 列表。

如果你想指定仅订阅某一发流用户的视频流，将该用户的 ID 加入此列表中。如果你想要将某一用户从订阅白名单中移除，需要重新调用 setSubscribeVideoAllowlist 方法更新音频订阅白名单的用户 ID 列表，使其不包含你想移除的用户的 uid。
uidNumber: 白名单用户 ID 列表中的用户数量。

返回值

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

所属接口类

IRtcEngine

setSubscribeVideoAllowlistEx

设置视频订阅白名单。

C++
virtual int setSubscribeVideoAllowlistEx(uid_t* uidList, int uidNumber, const RtcConnection& connection) = 0;

详情

你可以调用该方法指定想要订阅的视频流。

信息

该方法在加入频道前后均可调用。
视频订阅白名单不受 muteRemoteVideoStream、muteAllRemoteVideoStreams 以及 ChannelMediaOptions 中的 autoSubscribeVideo 的影响。
设置订阅白名单后，如果离开当前频道后再重新加入频道，白名单依然生效。
如果某个用户同时在音频订阅黑名单和白名单中，仅订阅黑名单生效。

参数

uidList: 视频订阅白名单的用户 ID 列表。

如果你想指定仅订阅某一发流用户的视频流，将该用户的 ID 加入此列表中。如果你想要将某一用户从订阅白名单中移除，需要重新调用 setSubscribeVideoAllowlist 方法更新音频订阅白名单的用户 ID 列表，使其不包含你想移除的用户的 uid。
uidNumber: 白名单用户 ID 列表中的用户数量。
connection: Connection 信息。详见 RtcConnection。

返回值

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

所属接口类

IRtcEngineEx

setSubscribeVideoBlocklist

设置视频订阅黑名单。

C++
virtual int setSubscribeVideoBlocklist(uid_t* uidList, int uidNumber) = 0;

详情

你可以调用该方法指定不订阅的视频流。

信息

该方法在加入频道前后均可调用。
视频订阅黑名单不受 muteRemoteVideoStream、muteAllRemoteVideoStreams 以及 ChannelMediaOptions 中的 autoSubscribeVideo 的影响。
设置订阅黑名单后，如果离开当前频道后再重新加入频道，黑名单依然生效。
如果某个用户同时在音频订阅黑名单和白名单中，仅订阅黑名单生效。

参数

uidList: 视频订阅黑名单的用户 ID 列表。

如果你想指定不订阅某一发流用户的视频流，将该用户的 ID 加入此列表中。如果你想要将某一用户从订阅黑名单中移除，需要重新调用 setSubscribeVideoBlocklist 方法更新订阅黑名单的用户 ID 列表，使其不包含你想移除的用户的 uid。
uidNumber: 黑名单用户 ID 列表中的用户数量。

返回值

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

所属接口类

IRtcEngine

setSubscribeVideoBlocklistEx

设置视频订阅黑名单。

C++
virtual int setSubscribeVideoBlocklistEx(uid_t* uidList, int uidNumber, const RtcConnection& connection) = 0;

详情

你可以调用该方法指定不订阅的视频流。

信息

该方法在加入频道前后均可调用。
视频订阅黑名单不受 muteRemoteVideoStream、muteAllRemoteVideoStreams 以及 ChannelMediaOptions 中的 autoSubscribeVideo 的影响。
设置订阅黑名单后，如果离开当前频道后再重新加入频道，黑名单依然生效。
如果某个用户同时在音频订阅黑名单和白名单中，仅订阅黑名单生效。

参数

uidList: 视频订阅黑名单的用户 ID 列表。

如果你想指定不订阅某一发流用户的视频流，将该用户的 ID 加入此列表中。如果你想要将某一用户从订阅黑名单中移除，需要重新调用 setSubscribeVideoBlocklist 方法更新订阅黑名单的用户 ID 列表，使其不包含你想移除的用户的 uid。
uidNumber: 黑名单用户 ID 列表中的用户数量。
connection: Connection 信息。详见 RtcConnection。

返回值

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

所属接口类

IRtcEngineEx

onAudioPublishStateChanged

音频发布状态改变回调。

C++
virtual void onAudioPublishStateChanged(const char* channel,
     STREAM_PUBLISH_STATE oldState,
     STREAM_PUBLISH_STATE newState,
     int elapseSinceLastState) {
     (void)channel;
     (void)oldState;
     (void)newState;
     (void)elapseSinceLastState;
     }

参数

channel: 频道名。
oldState: 之前的发布状态，详见 STREAM_PUBLISH_STATE。
newState: 当前的发布状态，详见 STREAM_PUBLISH_STATE。
elapseSinceLastState: 两次状态变化时间间隔（毫秒）。

所属接口类

IRtcEngineEventHandler

onAudioSubscribeStateChanged

音频订阅状态发生改变回调。

C++
virtual void onAudioSubscribeStateChanged(const char* channel,
     uid_t uid,
     STREAM_SUBSCRIBE_STATE oldState,
     STREAM_SUBSCRIBE_STATE newState,
     int elapseSinceLastState) {
     (void)channel;
     (void)uid;
     (void)oldState;
     (void)newState;
     (void)elapseSinceLastState;
     }

参数

channel: 频道名。
uid: 远端用户的 ID。
oldState: 之前的订阅状态，详见 STREAM_SUBSCRIBE_STATE。
newState: 当前的订阅状态，详见 STREAM_SUBSCRIBE_STATE。
elapseSinceLastState: 两次状态变化时间间隔（毫秒）。

所属接口类

IRtcEngineEventHandler

onVideoSubscribeStateChanged

视频订阅状态发生改变回调。

C++
virtual void onVideoSubscribeStateChanged(const char* channel,
     uid_t uid,
     STREAM_SUBSCRIBE_STATE oldState,
     STREAM_SUBSCRIBE_STATE newState,
     int elapseSinceLastState) {
     (void)channel;
     (void)uid;
     (void)oldState;
     (void)newState;
     (void)elapseSinceLastState;
     }

参数

channel: 频道名。
uid: 远端用户的 ID。
oldState: 之前的订阅状态，详见 STREAM_SUBSCRIBE_STATE。
newState: 当前的订阅状态，详见 STREAM_SUBSCRIBE_STATE。
elapseSinceLastState: 两次状态变化时间间隔（毫秒）。

所属接口类

IRtcEngineEventHandler

muteAllRemoteAudioStreams

调用时机

调用限制

参数​

返回值​

muteAllRemoteAudioStreamsEx

详情​

参数​

返回值​

muteAllRemoteVideoStreams

调用时机

调用限制

参数​

返回值​

muteAllRemoteVideoStreamsEx

详情​

参数​

返回值​

muteLocalAudioStream

调用时机

调用限制

相关回调

参数​

返回值​

muteLocalAudioStreamEx

详情​

参数​

返回值​

muteLocalVideoStream

调用时机

调用限制

相关回调

参数​

返回值​

muteLocalVideoStreamEx

详情​

参数​

返回值​

muteRemoteAudioStream

调用时机

调用限制

相关回调

参数​

返回值​

muteRemoteAudioStreamEx

详情​

参数​

返回值​

muteRemoteVideoStream

调用时机

调用限制

相关回调

参数​

返回值​

muteRemoteVideoStreamEx

详情​

参数​

返回值​

setRemoteVideoSubscriptionOptions

详情​

参数​

返回值​

setRemoteVideoSubscriptionOptionsEx

详情​

参数​

返回值​

setSubscribeAudioAllowlist

详情​

参数​

返回值​

setSubscribeAudioAllowlistEx

详情​

参数​

返回值​

setSubscribeAudioBlocklist

详情​

参数​

返回值​

setSubscribeAudioBlocklistEx

详情​

参数

返回值

详情

参数

返回值

参数

返回值

详情

参数

返回值

参数

返回值

详情

参数

返回值

参数

返回值

详情

参数

返回值

参数

返回值

详情

参数

返回值

参数

返回值

详情

参数

返回值

详情

参数

返回值

详情

参数

返回值

详情

参数

返回值

详情

参数

返回值

详情

参数

返回值

详情

参数

返回值

详情

参数

返回值

详情

参数

返回值

详情

参数

返回值

详情

参数

返回值

参数

参数

参数