# 发布和订阅 (/zh-CN/api-reference/rtc/unity/publishnsubscribe)
> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).
## EnableDualStreamMode [1/2] [#enabledualstreammode-12]
在发送端开启或关闭双流模式。
```csharp
public abstract int EnableDualStreamMode(bool enabled);
```
:::error[废弃]
弃用: 从 v4.2.0 起废弃,请改用 [SetDualStreamMode [1/2]](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_setdualstreammode)。
:::
双流指视频大流和视频小流:
- 视频大流:高分辨率、高帧率的视频流。
- 视频小流:低分辨率、低帧率的视频流。
开启双流模式后,你可以在收流端调用 [SetRemoteVideoStreamType](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_setremotevideostreamtype) 选择接收视频大流或视频小流。
:::note
注:
- 该方法适用于发送端发送的所有类型的流,包括且不限于来自摄像头采集的视频流、屏幕共享流、自定义采集的视频流。
- 如果需要在多频道场景下开启视频双流,可以调用 [EnableDualStreamModeEx](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengineex_enabledualstreammodeex) 方法。
- 该方法可以在加入频道前后调用。
:::
### 参数 [#参数]
是否开启双流模式。
- true: 开启双流模式。
- false: (默认) 关闭双流模式。
### 返回值 [#返回值]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## EnableDualStreamMode [2/2] [#enabledualstreammode-22]
在发送端开启或关闭双流模式并设置视频小流。
```csharp
public abstract int EnableDualStreamMode(bool enabled, SimulcastStreamConfig streamConfig);
```
:::error[废弃]
弃用: 从 v4.2.0 起废弃,请改用 [SetDualStreamMode [2/2]](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_setdualstreammode2)。
:::
你可以在发流端调用该方法开启或关闭双流模式。双流指视频大流和视频小流:
- 视频大流:高分辨率、高帧率的视频流。
- 视频小流:低分辨率、低帧率的视频流。
开启双流模式后,你可以在收流端调用 [SetRemoteVideoStreamType](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_setremotevideostreamtype) 选择接收视频大流或视频小流。
:::note
注:
- 该方法适用于发送端发送的所有类型的流,包括且不限于来自摄像头采集的视频流、屏幕共享流、自定义采集的视频流。
- 如果需要在多频道场景下开启视频双流,可以调用 [EnableDualStreamModeEx](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengineex_enabledualstreammodeex) 方法。
- 该方法可以在加入频道前后调用。
:::
### 参数 [#参数-1]
是否开启双流模式:
- true: 开启双流模式。
- false: (默认) 关闭双流模式。
视频小流的配置。详见 [SimulcastStreamConfig](/zh-CN/api-reference/rtc/unity/class-simulcaststreamconfig)。
:::note
注: 当设置 `mode` 为 `DISABLE_SIMULCAST_STREAM` 时,再设置 `streamConfig` 不会生效。
:::
### 返回值 [#返回值-1]
- 0: 方法调用成功。
- < 0: 方法调用失败。 详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-1]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## EnableDualStreamModeEx [#enabledualstreammodeex]
在发送端开启或关闭双流模式。
```csharp
public abstract int EnableDualStreamModeEx(bool enabled, SimulcastStreamConfig streamConfig, RtcConnection connection);
```
:::error[废弃]
弃用: 从 v4.2.0 起废弃,请改用 [SetDualStreamModeEx](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengineex_setdualstreammodeex)。
:::
你可以在发流端调用该方法开启或关闭双流模式。双流指视频大流和视频小流:
- 视频大流:高分辨率、高帧率的视频流。
- 视频小流:低分辨率、低帧率的视频流。
开启双流模式后,你可以在收流端调用 [SetRemoteVideoStreamType](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_setremotevideostreamtype) 选择接收视频大流或视频小流。
:::note
注: 该方法适用于发送端发送的所有类型的流,包括且不限于来自摄像头采集的视频流、屏幕共享流、自定义采集的视频流。
:::
### 参数 [#参数-2]
是否开启双流模式:
- true: 开启双流模式。
- false: (默认) 关闭双流模式。
视频小流的配置。详见 [SimulcastStreamConfig](/zh-CN/api-reference/rtc/unity/class-simulcaststreamconfig)。
:::note
注: 当设置 `mode` 为 `DISABLE_SIMULCAST_STREAM` 时,再设置 `streamConfig` 不会生效。
:::
Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/unity/class-rtcconnection)。
### 返回值 [#返回值-2]
- 0: 方法调用成功。
- < 0: 方法调用失败。 详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-2]
- [IRtcEngineEx](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengineex)
## MuteAllRemoteAudioStreams [#muteallremoteaudiostreams]
取消或恢复订阅所有远端用户的音频流。
```csharp
public abstract int MuteAllRemoteAudioStreams(bool mute);
```
成功调用该方法后,本地用户会取消或恢复订阅所有远端用户的音频流,包括在调用该方法后加入频道的用户的音频流。
:::note
注: SDK 默认在加入频道时订阅所有远端用户的音频流,如果要修改此行为,可以在调用 [JoinChannel [2/2]](/zh-CN/api-reference/rtc/unity/channel#api_irtcengine_joinchannel2) 加入频道时设置 `autoSubscribeAudio` 为 false,即可在加入频道时取消订阅所有用户的音频流。
如果在调用该方法之后又调用了 [EnableAudio](/zh-CN/api-reference/rtc/unity/audio/audio-basic#api_irtcengine_enableaudio) 或 [DisableAudio](/zh-CN/api-reference/rtc/unity/audio/audio-basic#api_irtcengine_disableaudio),则后调用的方法会生效。
:::
### 调用时机 [#调用时机]
该方法需要在加入频道后调用。
### 参数 [#参数-3]
是否取消订阅所有远端用户的音频流:
- true: 取消订阅所有远端用户的音频流。
- false:(默认)订阅所有远端用户的音频流。
### 返回值 [#返回值-3]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-3]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## MuteAllRemoteAudioStreamsEx [#muteallremoteaudiostreamsex]
取消或恢复订阅所有远端用户的音频流。
```csharp
public abstract int MuteAllRemoteAudioStreamsEx(bool mute, RtcConnection connection);
```
成功调用该方法后,本地用户会取消或恢复订阅远端用户的音频流,包括在调用该方法后加入频道的用户的音频流。
:::note
注:
- 该方法需要在加入频道后调用。
- 如果需要在加入频道前设置默认不订阅远端用户音频流,可以在调用 [JoinChannel [2/2]](/zh-CN/api-reference/rtc/unity/channel#api_irtcengine_joinchannel2) 加入频道时设置 `autoSubscribeAudio` 为 false。
:::
### 参数 [#参数-4]
是否取消订阅所有远端用户的音频流:
- true: 取消订阅所有远端用户的音频流。
- false:(默认)订阅所有远端用户的音频流。
Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/unity/class-rtcconnection)。
### 返回值 [#返回值-4]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-4]
- [IRtcEngineEx](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengineex)
## MuteAllRemoteVideoStreams [#muteallremotevideostreams]
取消或恢复订阅所有远端用户的视频流。
```csharp
public abstract int MuteAllRemoteVideoStreams(bool mute);
```
成功调用该方法后,本地用户会取消或恢复订阅所有远端用户的视频流,包括在调用该方法后加入频道的用户的视频流。
:::note
注: SDK 默认在加入频道时订阅所有远端用户的视频流,如果要修改此行为,可以在调用 [JoinChannel [2/2]](/zh-CN/api-reference/rtc/unity/channel#api_irtcengine_joinchannel2) 加入频道时设置 `autoSubscribeVideo` 为 false,即可在加入频道时取消订阅所有用户的视频流。
如果在调用该方法之后又调用了 [EnableVideo](/zh-CN/api-reference/rtc/unity/video/video-basic#api_irtcengine_enablevideo) 或 [DisableVideo](/zh-CN/api-reference/rtc/unity/video/video-basic#api_irtcengine_disablevideo),则后调用的方法会生效。
:::
### 调用时机 [#调用时机-1]
该方法需要在加入频道后调用。
### 参数 [#参数-5]
是否取消订阅所有远端用户的视频流。
- true: 取消订阅所有用户的视频流。
- false:(默认)订阅所有用户的视频流。
### 返回值 [#返回值-5]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-5]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## MuteAllRemoteVideoStreamsEx [#muteallremotevideostreamsex]
取消或恢复订阅所有远端用户的视频流。
```csharp
public abstract int MuteAllRemoteVideoStreamsEx(bool mute, RtcConnection connection);
```
成功调用该方法后,本地用户会取消或恢复订阅所有远端用户的视频流,包括在调用该方法后加入频道的用户的视频流。
### 参数 [#参数-6]
是否取消订阅所有远端用户的视频流。
- true: 取消订阅所有用户的视频流。
- false:(默认)订阅所有用户的视频流。
Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/unity/class-rtcconnection)。
### 返回值 [#返回值-6]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-6]
- [IRtcEngineEx](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengineex)
## MuteLocalAudioStream [#mutelocalaudiostream]
取消或恢复发布本地音频流。
```csharp
public abstract int MuteLocalAudioStream(bool mute);
```
该方法用于控制是否发布本地采集的音频流。如果不发布本地采集的音频流,也不会禁用音频采集设备,所以不影响音频的采集状态。
### 调用时机 [#调用时机-2]
加入频道前后均可调用。
### 相关回调 [#相关回调]
成功调用该方法后,本地会触发 [OnAudioPublishStateChanged](/zh-CN/api-reference/rtc/unity/publishnsubscribe#callback_irtcengineeventhandler_onaudiopublishstatechanged) 回调;远端会触发 [OnUserMuteAudio](/zh-CN/api-reference/rtc/unity/audio/audio-basic#callback_irtcengineeventhandler_onusermuteaudio) 回调和 [OnRemoteAudioStateChanged](/zh-CN/api-reference/rtc/unity/audio/audio-basic#callback_irtcengineeventhandler_onremoteaudiostatechanged) 回调。
### 参数 [#参数-7]
是否取消发布本地音频流。
- true: 取消发布。
- false:(默认)发布。
### 返回值 [#返回值-7]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-7]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## MuteLocalAudioStreamEx [#mutelocalaudiostreamex]
取消或恢复发布本地音频流。
```csharp
public abstract int MuteLocalAudioStreamEx(bool mute, RtcConnection connection);
```
成功调用该方法后,远端会触发 [OnUserMuteAudio](/zh-CN/api-reference/rtc/unity/audio/audio-basic#callback_irtcengineeventhandler_onusermuteaudio) 回调和 [OnRemoteAudioStateChanged](/zh-CN/api-reference/rtc/unity/audio/audio-basic#callback_irtcengineeventhandler_onremoteaudiostatechanged) 回调。
:::note
注: 该方法不影响音频采集状态,因为没有禁用音频采集设备。
:::
### 参数 [#参数-8]
是否取消发布本地音频流。
- true: 取消发布。
- false:(默认)发布。
Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/unity/class-rtcconnection)。
### 返回值 [#返回值-8]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-8]
- [IRtcEngineEx](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengineex)
## MuteLocalVideoStream [#mutelocalvideostream]
取消或恢复发布本地视频流。
```csharp
public abstract int MuteLocalVideoStream(bool mute);
```
该方法用于控制是否发布本地采集的视频流。如果不发布本地采集的视频流,也不会禁用视频采集设备,所以不影响视频的采集状态。
相比于调用 [EnableLocalVideo](/zh-CN/api-reference/rtc/unity/video/video-basic#api_irtcengine_enablelocalvideo)(false) 关闭本地视频流采集、从而取消发布本地视频流的方法,该方法响应速度更快。
### 调用时机 [#调用时机-3]
加入频道前后均可调用。
### 相关回调 [#相关回调-1]
成功调用该方法后,本地会触发 [OnVideoPublishStateChanged](/zh-CN/api-reference/rtc/unity/video/video-basic#callback_irtcengineeventhandler_onvideopublishstatechanged) 回调;远端会触发 [OnUserMuteVideo](/zh-CN/api-reference/rtc/unity/video/video-basic#callback_irtcengineeventhandler_onusermutevideo) 回调和 [OnRemoteVideoStateChanged](/zh-CN/api-reference/rtc/unity/video/video-basic#callback_irtcengineeventhandler_onremotevideostatechanged) 回调。
### 参数 [#参数-9]
是否取消发送本地视频流。
- true: 取消发送本地视频流。
- false: (默认)发送本地视频流。
### 返回值 [#返回值-9]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-9]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## MuteLocalVideoStreamEx [#mutelocalvideostreamex]
取消或恢复发布本地视频流。
```csharp
public abstract int MuteLocalVideoStreamEx(bool mute, RtcConnection connection);
```
成功调用该方法后,远端会触发 [OnUserMuteVideo](/zh-CN/api-reference/rtc/unity/video/video-basic#callback_irtcengineeventhandler_onusermutevideo) 回调。
:::note
注:
- 该方法不影响视频采集状态,没有禁用摄像头。
:::
### 参数 [#参数-10]
是否取消发送本地视频流。
- true: 取消发送本地视频流。
- false: (默认)发送本地视频流。
Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/unity/class-rtcconnection)。
### 返回值 [#返回值-10]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-10]
- [IRtcEngineEx](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengineex)
## MuteRemoteAudioStream [#muteremoteaudiostream]
取消或恢复订阅指定远端用户的音频流。
```csharp
public abstract int MuteRemoteAudioStream(uint uid, bool mute);
```
### 调用时机 [#调用时机-4]
该方法需要在加入频道后调用。
### 相关回调 [#相关回调-2]
成功调用该方法后,本地会触发 [OnAudioSubscribeStateChanged](/zh-CN/api-reference/rtc/unity/publishnsubscribe#callback_irtcengineeventhandler_onaudiosubscribestatechanged) 回调。
### 参数 [#参数-11]
指定用户的用户 ID。
是否取消订阅指定远端用户的音频流。
- true: 取消订阅指定用户的音频流。
- false:(默认)订阅指定用户的音频流。
### 返回值 [#返回值-11]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-11]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## MuteRemoteAudioStreamEx [#muteremoteaudiostreamex]
停止/恢复接收指定的音频流。
```csharp
public abstract int MuteRemoteAudioStreamEx(uint uid, bool mute, RtcConnection connection);
```
该方法停止/恢复接收某一个指定远端用户的音频流。在加入频道前或后都可以调用。该方法的设置在离开频道后失效。
### 参数 [#参数-12]
指定用户的 ID。
是否停止接收指定音频流:
- true: 停止接收指定音频流。
- false:(默认)继续接收指定音频流。
Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/unity/class-rtcconnection)。
### 返回值 [#返回值-12]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-12]
- [IRtcEngineEx](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengineex)
## MuteRemoteVideoStream [#muteremotevideostream]
取消或恢复订阅指定远端用户的视频流。
```csharp
public abstract int MuteRemoteVideoStream(uint uid, bool mute);
```
### 调用时机 [#调用时机-5]
该方法需要在加入频道后调用。
### 相关回调 [#相关回调-3]
成功调用该方法后,本地会触发 [OnVideoSubscribeStateChanged](/zh-CN/api-reference/rtc/unity/publishnsubscribe#callback_irtcengineeventhandler_onvideosubscribestatechanged) 回调。
### 参数 [#参数-13]
指定用户的用户 ID。
是否取消订阅指定远端用户的视频流。
- true: 取消订阅指定用户的视频流。
- false: (默认)订阅指定用户的视频流。
### 返回值 [#返回值-13]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-13]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## MuteRemoteVideoStreamEx [#muteremotevideostreamex]
停止/恢复接收指定的视频流。
```csharp
public abstract int MuteRemoteVideoStreamEx(uint uid, bool mute, RtcConnection connection);
```
该方法停止/恢复接收某一个指定远端用户的视频流。在加入频道前或后都可以调用。该方法的设置在离开频道后失效。
### 参数 [#参数-14]
远端用户的 ID。
是否停止接收某个远端用户的视频:
- true: 停止接收。
- false: (默认)恢复接收。
Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/unity/class-rtcconnection)。
### 返回值 [#返回值-14]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-14]
- [IRtcEngineEx](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengineex)
## SetDualStreamMode [1/2] [#setdualstreammode-12]
在发送端设置双流模式。
```csharp
public abstract int SetDualStreamMode(SIMULCAST_STREAM_MODE mode);
```
SDK 默认在发送端开启小流自适应模式 (`AUTO_SIMULCAST_STREAM`),即发送端不主动发送小流,主播身份的接收端可以调用 [SetRemoteVideoStreamType](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_setremotevideostreamtype) 发起小流申请,发送端收到申请后开始自动发送小流。
- 如果你想修改此行为,可以调用该方法并修改 `mode` 为 `DISABLE_SIMULCAST_STREAM`(始终不发送小流)或 `ENABLE_SIMULCAST_STREAM`(始终发送小流)。
- 如果你在进行修改后又想恢复该默认行为,可重新调用该方法,并将 `mode` 设置为 `AUTO_SIMULCAST_STREAM`。
:::note
注: 该方法和 [EnableDualStreamMode [1/2]](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_enabledualstreammode) 的区别与联系如下:
- 调用该方法并设置 `mode` 为 `DISABLE_SIMULCAST_STREAM` 时,跟 [EnableDualStreamMode [1/2]](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_enabledualstreammode) 设为 false 的效果相同。
- 调用该方法并设置 `mode` 为 `ENABLE_SIMULCAST_STREAM` 时,跟 [EnableDualStreamMode [1/2]](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_enabledualstreammode) 设为 true 的效果相同。
- 两种方法均可在加入频道前后调用,若同时使用,则以后调用的方法中的设置为准。
:::
### 参数 [#参数-15]
发送视频流的模式。详见 [SIMULCAST_STREAM_MODE](/zh-CN/api-reference/rtc/unity/enum-simulcaststreammode)。
### 返回值 [#返回值-15]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-15]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## SetDualStreamMode [2/2] [#setdualstreammode-22]
在发送端设置双流模式并设置视频小流。
```csharp
public abstract int SetDualStreamMode(SIMULCAST_STREAM_MODE mode, SimulcastStreamConfig streamConfig);
```
SDK 默认在发送端开启小流自适应模式 (`AUTO_SIMULCAST_STREAM`),即发送端不主动发送小流,主播身份的接收端可以调用 [SetRemoteVideoStreamType](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_setremotevideostreamtype) 发起小流申请,发送端收到申请后开始自动发送小流。
- 如果你想修改此行为,可以调用该方法并修改 `mode` 为 `DISABLE_SIMULCAST_STREAM`(始终不发送小流)或 `ENABLE_SIMULCAST_STREAM`(始终发送小流)。
- 如果你在进行修改后又想恢复该默认行为,可重新调用该方法,并将 `mode` 设置为 `AUTO_SIMULCAST_STREAM`。
该方法跟 [SetDualStreamMode [1/2]](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_setdualstreammode) 的区别在于,该方法还可以进行视频小流的配置,SDK 会根据 `streamConfig` 中的配置发送小流。
:::note
注: 该方法和 [EnableDualStreamMode [2/2]](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_enabledualstreammode3) 的区别与联系如下:
- 调用该方法并设置 `mode` 为 `DISABLE_SIMULCAST_STREAM` 时,跟调用 [EnableDualStreamMode [2/2]](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_enabledualstreammode3) 并设置 `enabled` 为 false 的效果相同。
- 调用该方法并设置 `mode` 为 `ENABLE_SIMULCAST_STREAM` 时,跟调用 [EnableDualStreamMode [2/2]](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_enabledualstreammode3) 并设置 `enabled` 为 true 的效果相同。
- 两种方法均可在加入频道前后调用,若同时使用,则以后调用的方法中的设置为准。
:::
### 参数 [#参数-16]
发送视频流的模式。详见 [SIMULCAST_STREAM_MODE](/zh-CN/api-reference/rtc/unity/enum-simulcaststreammode)。
视频小流的配置。详见 [SimulcastStreamConfig](/zh-CN/api-reference/rtc/unity/class-simulcaststreamconfig)。
:::note
注: 当设置 `mode` 为 `DISABLE_SIMULCAST_STREAM` 时,再设置 `streamConfig` 不会生效。
:::
### 返回值 [#返回值-16]
- 0: 方法调用成功。
- < 0: 方法调用失败。 详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-16]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## SetDualStreamModeEx [#setdualstreammodeex]
在发送端设置双流模式。
```csharp
public abstract int SetDualStreamModeEx(SIMULCAST_STREAM_MODE mode, SimulcastStreamConfig streamConfig, RtcConnection connection);
```
SDK 默认在发送端开启小流自适应模式 (`AUTO_SIMULCAST_STREAM`),即发送端不主动发送小流,主播身份的接收端可以调用 [SetRemoteVideoStreamTypeEx](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengineex_setremotevideostreamtypeex) 发起小流申请,发送端收到申请后开始自动发送小流。
- 如果你想修改此行为,可以调用该方法并修改 `mode` 为 `DISABLE_SIMULCAST_STREAM`(始终不发送小流)或 `ENABLE_SIMULCAST_STREAM`(始终发送小流)。
- 如果你在进行修改后又想恢复该默认行为,可重新调用该方法,并将 `mode` 设置为 `AUTO_SIMULCAST_STREAM`。
:::note
注: 该方法和 [EnableDualStreamModeEx](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengineex_enabledualstreammodeex) 的区别与联系如下:
- 调用该方法并设置 `mode` 为 `DISABLE_SIMULCAST_STREAM` 时,跟 `EnableDualStreamModeEx(false)` 的效果相同。
- 调用该方法并设置 `mode` 为 `ENABLE_SIMULCAST_STREAM` 时,跟 `EnableDualStreamModeEx(true)` 的效果相同。
- 两种方法均可在加入频道前后调用,若同时使用,则以后调用的方法中的设置为准。
:::
### 参数 [#参数-17]
发送视频流的模式。详见 [SIMULCAST_STREAM_MODE](/zh-CN/api-reference/rtc/unity/enum-simulcaststreammode)。
视频小流的配置。详见 [SimulcastStreamConfig](/zh-CN/api-reference/rtc/unity/class-simulcaststreamconfig)。
:::note
注: 当设置 `mode` 为 `DISABLE_SIMULCAST_STREAM` 时,再设置 `streamConfig` 不会生效。
:::
Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/unity/class-rtcconnection)。
### 返回值 [#返回值-17]
- 0: 方法调用成功。
- < 0: 方法调用失败。 详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-17]
- [IRtcEngineEx](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengineex)
## SetRemoteDefaultVideoStreamType [#setremotedefaultvideostreamtype]
设置默认订阅的视频流类型。
```csharp
public abstract int SetRemoteDefaultVideoStreamType(VIDEO_STREAM_TYPE streamType);
```
取决于发送端的默认行为和调用 [SetDualStreamMode [2/2]](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_setdualstreammode2) 的具体设置,接收端调用该方法分为以下几种情况:
- SDK 默认在发送端开启小流自适应模式 (`AUTO_SIMULCAST_STREAM`),即:发送端仅发送大流,仅主播身份的接收端可以调用该方法发起小流申请,发送端收到申请后开始自动发送小流,此时频道内所有用户均可调用该方法切换到小流订阅模式。
- 当发送端调用 [SetDualStreamMode [2/2]](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_setdualstreammode2) 并将 `mode` 设置为 `DISABLE_SIMULCAST_STREAM`(始终不发送小流),则调用该方法不生效。
- 当发送端调用 [SetDualStreamMode [2/2]](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_setdualstreammode2) 并将 `mode` 设置为 `ENABLE_SIMULCAST_STREAM`(始终发送小流),则主播或观众身份的接收端均可调用该方法切换到小流订阅模式。
在接收视频小流时,SDK 会根据视频窗口的大小动态调整对应视频流的大小,以节约带宽和计算资源。视频小流默认的宽高比和视频大流的宽高比一致。根据当前大流的宽高比,系统会自动分配小流的分辨率、帧率及码率。
:::note
注: 如果你既调用了该方法,也调用了 [SetRemoteVideoStreamType](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_setremotevideostreamtype),则 SDK 以 [SetRemoteVideoStreamType](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_setremotevideostreamtype) 中的设置为准。
:::
### 调用时机 [#调用时机-6]
该方法只能在加入频道前调用。SDK 不支持你在加入频道后修改默认订阅的视频流类型。
### 参数 [#参数-18]
默认订阅的视频流类型: [VIDEO_STREAM_TYPE](/zh-CN/api-reference/rtc/unity/enum-videostreamtype)。
### 返回值 [#返回值-18]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-18]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## SetRemoteVideoStreamType [#setremotevideostreamtype]
设置订阅的视频流类型。
```csharp
public abstract int SetRemoteVideoStreamType(uint uid, VIDEO_STREAM_TYPE streamType);
```
取决于发送端的默认行为和调用 [SetDualStreamMode [2/2]](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_setdualstreammode2) 的具体设置,接收端调用该方法分为以下几种情况:
- SDK 默认在发送端开启小流自适应模式 (`AUTO_SIMULCAST_STREAM`),即:发送端仅发送大流,仅主播身份的接收端可以调用该方法发起小流申请,发送端收到申请后开始自动发送小流,此时频道内所有用户均可调用该方法切换到小流订阅模式。
- 当发送端调用 [SetDualStreamMode [2/2]](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_setdualstreammode2) 并将 `mode` 设置为 `DISABLE_SIMULCAST_STREAM`(始终不发送小流),则调用该方法不生效。
- 当发送端调用 [SetDualStreamMode [2/2]](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_setdualstreammode2) 并将 `mode` 设置为 `ENABLE_SIMULCAST_STREAM`(始终发送小流),则主播或观众身份的接收端均可调用该方法切换到小流订阅模式。
在接收视频小流时,SDK 会根据视频窗口的大小动态调整对应视频流的大小,以节约带宽和计算资源。视频小流默认的宽高比和视频大流的宽高比一致。根据当前大流的宽高比,系统会自动分配小流的分辨率、帧率及码率。
:::note
注:
- 该方法在加入频道前后都能调用。
- 如果既调用了该方法,也调用了 [SetRemoteDefaultVideoStreamType](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_setremotedefaultvideostreamtype),则 SDK 以该方法中的设置为准。
:::
### 参数 [#参数-19]
用户 ID。
视频流类型: [VIDEO_STREAM_TYPE](/zh-CN/api-reference/rtc/unity/enum-videostreamtype)。
### 返回值 [#返回值-19]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-19]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## SetRemoteVideoStreamTypeEx [#setremotevideostreamtypeex]
设置订阅的视频流类型。
```csharp
public abstract int SetRemoteVideoStreamTypeEx(uint uid, VIDEO_STREAM_TYPE streamType, RtcConnection connection);
```
取决于发送端的默认行为和调用 [SetDualStreamMode [2/2]](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_setdualstreammode2) 的具体设置,接收端调用该方法分为以下几种情况:
- SDK 默认在发送端开启小流自适应模式 (`AUTO_SIMULCAST_STREAM`),即:发送端仅发送大流,仅主播身份的接收端可以调用该方法发起小流申请,发送端收到申请后开始自动发送小流,此时频道内所有用户均可调用该方法切换到小流订阅模式。
- 当发送端调用 [SetDualStreamMode [2/2]](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_setdualstreammode2) 并将 `mode` 设置为 `DISABLE_SIMULCAST_STREAM`(始终不发送小流),则调用该方法不生效。
- 当发送端调用 [SetDualStreamMode [2/2]](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_setdualstreammode2) 并将 `mode` 设置为 `ENABLE_SIMULCAST_STREAM`(始终发送小流),则主播或观众身份的接收端均可调用该方法切换到小流订阅模式。
在接收视频小流时,SDK 会根据视频窗口的大小动态调整对应视频流的大小,以节约带宽和计算资源。视频小流默认的宽高比和视频大流的宽高比一致。根据当前大流的宽高比,系统会自动分配小流的分辨率、帧率及码率。
:::note
注: 如果发送端已调用 [SetDualStreamModeEx](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengineex_setdualstreammodeex) 并将 `mode` 设置为 `DISABLE_SIMULCAST_STREAM`(始终不发送小流),则调用该方法不生效,你需要在发送端重新调用 [SetDualStreamModeEx](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengineex_setdualstreammodeex) 修改设置。
:::
### 参数 [#参数-20]
用户 ID。
视频流类型: [VIDEO_STREAM_TYPE](/zh-CN/api-reference/rtc/unity/enum-videostreamtype)。
Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/unity/class-rtcconnection)。
### 返回值 [#返回值-20]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-20]
- [IRtcEngineEx](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengineex)
## SetRemoteVideoSubscriptionOptions [#setremotevideosubscriptionoptions]
设置远端视频流的订阅选项。
```csharp
public abstract int SetRemoteVideoSubscriptionOptions(uint uid, VideoSubscriptionOptions options);
```
当远端发送双流时,可调用此方法来设置远端视频流的订阅选项。SDK 对远端视频流的默认订阅行为取决于注册的视频观测器类型:
- 如果注册的是 [IVideoFrameObserver](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_ivideoframeobserver) 观测器,则默认订阅原始数据和编码后的数据。
- 如果注册的是 [IVideoEncodedFrameObserver](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_ivideoencodedframeobserver) 观测器,则默认仅订阅编码后的数据。
- 如果注册了两种观测器,则默认跟随后注册的视频观测器。举例来说,如果后注册的是 [IVideoFrameObserver](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_ivideoframeobserver) 观测器,则默认订阅原始数据和编码后的数据。
如果你想修改以上默认行为,或者想针对不同 `uid` 设置不同的订阅选项,可调用该方法设置。
### 参数 [#参数-21]
远端用户 ID。
视频流的订阅设置,详见 [VideoSubscriptionOptions](/zh-CN/api-reference/rtc/unity/class-videosubscriptionoptions)。
### 返回值 [#返回值-21]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-21]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## SetRemoteVideoSubscriptionOptionsEx [#setremotevideosubscriptionoptionsex]
设置远端视频流的订阅选项。
```csharp
public abstract int SetRemoteVideoSubscriptionOptionsEx(uint uid, VideoSubscriptionOptions options, RtcConnection connection);
```
当远端发送双流时,可调用此方法来设置远端视频流的订阅选项。
### 参数 [#参数-22]
远端用户 ID。
视频流的订阅设置,详见 [VideoSubscriptionOptions](/zh-CN/api-reference/rtc/unity/class-videosubscriptionoptions)。
Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/unity/class-rtcconnection)。
### 返回值 [#返回值-22]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-22]
- [IRtcEngineEx](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengineex)
## SetSubscribeAudioAllowlist [#setsubscribeaudioallowlist]
设置音频订阅白名单。
```csharp
public abstract int SetSubscribeAudioAllowlist(uint[] uidList, int uidNumber);
```
你可以调用该方法指定想要订阅的音频流。
:::note
注:
- 该方法在加入频道前后均可调用。
- 音频订阅白名单不受 [MuteRemoteAudioStream](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_muteremoteaudiostream)、[MuteAllRemoteAudioStreams](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_muteallremoteaudiostreams) 以及 [ChannelMediaOptions](/zh-CN/api-reference/rtc/unity/class-channelmediaoptions) 中的 `autoSubscribeAudio` 的影响。
- 设置订阅白名单后,如果离开当前频道后再重新加入频道,白名单依然生效。
- 如果某个用户同时在音频订阅黑名单和白名单中,仅订阅黑名单生效。
:::
### 参数 [#参数-23]
音频订阅白名单的用户 ID 列表。
如果你想指定订阅某一发流用户的音频流,将该用户的 ID 加入此列表中。如果你想要将某一用户从订阅白名单中移除,需要重新调用 [SetSubscribeAudioAllowlist](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_setsubscribeaudioallowlist) 方法更新音频订阅白名单的用户 ID 列表,使其不包含你想移除的用户的 `uid`。
白名单用户 ID 列表中的用户数量。
### 返回值 [#返回值-23]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-23]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## SetSubscribeAudioAllowlistEx [#setsubscribeaudioallowlistex]
设置音频订阅白名单。
```csharp
public abstract int GetCacheDir(out string path, int length);
```
你可以调用该方法指定想要订阅的音频流。
:::note
注:
- 该方法在加入频道前后均可调用。
- 音频订阅白名单不受 [MuteRemoteAudioStream](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_muteremoteaudiostream)、[MuteAllRemoteAudioStreams](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_muteallremoteaudiostreams) 以及 [ChannelMediaOptions](/zh-CN/api-reference/rtc/unity/class-channelmediaoptions) 中的 `autoSubscribeAudio` 的影响。
- 设置订阅白名单后,如果离开当前频道后再重新加入频道,白名单依然生效。
- 如果某个用户同时在音频订阅黑名单和白名单中,仅订阅黑名单生效。
:::
### 参数 [#参数-24]
音频订阅白名单的用户 ID 列表。
如果你想指定订阅某一发流用户的音频流,将该用户的 ID 加入此列表中。如果你想要将某一用户从订阅白名单中移除,需要重新调用 [SetSubscribeAudioAllowlist](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_setsubscribeaudioallowlist) 方法更新音频订阅白名单的用户 ID 列表,使其不包含你想移除的用户的 `uid`。
白名单用户 ID 列表中的用户数量。
Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/unity/class-rtcconnection)。
### 返回值 [#返回值-24]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-24]
- [IRtcEngineEx](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengineex)
## SetSubscribeAudioBlocklist [#setsubscribeaudioblocklist]
设置音频订阅黑名单。
```csharp
public abstract int SetSubscribeAudioBlocklist(uint[] uidList, int uidNumber);
```
你可以调用该方法指定不订阅的音频流。
:::note
注:
- 该方法在加入频道前后均可调用。
- 黑名单设置实时生效。将已订阅用户加入黑名单后,该用户的音频流也会停止订阅。
- 音频订阅黑名单不受 [MuteRemoteAudioStream](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_muteremoteaudiostream)、[MuteAllRemoteAudioStreams](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_muteallremoteaudiostreams) 以及 [ChannelMediaOptions](/zh-CN/api-reference/rtc/unity/class-channelmediaoptions) 中的 `autoSubscribeAudio` 影响。
- 设置订阅黑名单后,如果离开当前频道后再重新加入频道,黑名单依然生效。
- 如果某个用户同时在音频订阅黑名单和白名单中,仅订阅黑名单生效。
:::
### 参数 [#参数-25]
订阅黑名单的用户 ID 列表。
如果你想指定不订阅某一发流用户的音频流,将该用户的 ID 加入此列表中。如果你想要将某一用户从订阅黑名单中移除,需要重新调用 [SetSubscribeAudioBlocklist](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_setsubscribeaudioblocklist) 方法更新订阅黑名单的用户 ID 列表,使其不包含你想移除的用户的 `uid`。
黑名单用户 ID 列表中的用户数量。
### 返回值 [#返回值-25]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-25]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## SetSubscribeAudioBlocklistEx [#setsubscribeaudioblocklistex]
设置音频订阅黑名单。
```csharp
public abstract int SetSubscribeAudioBlocklistEx(uint[] uidList, int uidNumber, RtcConnection connection);
```
你可以调用该方法指定不订阅的音频流。
:::note
注:
- 该方法在加入频道前后均可调用。
- 黑名单设置实时生效。将已订阅用户加入黑名单后,该用户的音频流也会停止订阅。
- 音频订阅黑名单不受 [MuteRemoteAudioStream](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_muteremoteaudiostream)、[MuteAllRemoteAudioStreams](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_muteallremoteaudiostreams) 以及 [ChannelMediaOptions](/zh-CN/api-reference/rtc/unity/class-channelmediaoptions) 中的 `autoSubscribeAudio` 影响。
- 设置订阅黑名单后,如果离开当前频道后再重新加入频道,黑名单依然生效。
- 如果某个用户同时在音频订阅黑名单和白名单中,仅订阅黑名单生效。
:::
### 参数 [#参数-26]
订阅黑名单的用户 ID 列表。
如果你想指定不订阅某一发流用户的音频流,将该用户的 ID 加入此列表中。如果你想要将某一用户从订阅黑名单中移除,需要重新调用 [SetSubscribeAudioBlocklist](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_setsubscribeaudioblocklist) 方法更新订阅黑名单的用户 ID 列表,使其不包含你想移除的用户的 `uid`。
黑名单用户 ID 列表中的用户数量。
Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/unity/class-rtcconnection)。
### 返回值 [#返回值-26]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-26]
- [IRtcEngineEx](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengineex)
## SetSubscribeVideoAllowlist [#setsubscribevideoallowlist]
设置视频订阅白名单。
```csharp
public abstract int SetSubscribeVideoAllowlist(uint[] uidList, int uidNumber);
```
你可以调用该方法指定想要订阅的视频流。
:::note
注:
- 该方法在加入频道前后均可调用。
- 视频订阅白名单不受 [MuteRemoteVideoStream](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_muteremotevideostream)、[MuteAllRemoteVideoStreams](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_muteallremotevideostreams) 以及 [ChannelMediaOptions](/zh-CN/api-reference/rtc/unity/class-channelmediaoptions) 中的 `autoSubscribeVideo` 的影响。
- 设置订阅白名单后,如果离开当前频道后再重新加入频道,白名单依然生效。
- 如果某个用户同时在音频订阅黑名单和白名单中,仅订阅黑名单生效。
:::
### 参数 [#参数-27]
视频订阅白名单的用户 ID 列表。
如果你想指定仅订阅某一发流用户的视频流,将该用户的 ID 加入此列表中。如果你想要将某一用户从订阅白名单中移除,需要重新调用 [SetSubscribeVideoAllowlist](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_setsubscribevideoallowlist) 方法更新音频订阅白名单的用户 ID 列表,使其不包含你想移除的用户的 `uid`。
白名单用户 ID 列表中的用户数量。
### 返回值 [#返回值-27]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-27]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## SetSubscribeVideoAllowlistEx [#setsubscribevideoallowlistex]
设置视频订阅白名单。
```csharp
public abstract int SetSubscribeVideoAllowlistEx(uint[] uidList, int uidNumber, RtcConnection connection);
```
你可以调用该方法指定想要订阅的视频流。
:::note
注:
- 该方法在加入频道前后均可调用。
- 视频订阅白名单不受 [MuteRemoteVideoStream](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_muteremotevideostream)、[MuteAllRemoteVideoStreams](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_muteallremotevideostreams) 以及 [ChannelMediaOptions](/zh-CN/api-reference/rtc/unity/class-channelmediaoptions) 中的 `autoSubscribeVideo` 的影响。
- 设置订阅白名单后,如果离开当前频道后再重新加入频道,白名单依然生效。
- 如果某个用户同时在音频订阅黑名单和白名单中,仅订阅黑名单生效。
:::
### 参数 [#参数-28]
视频订阅白名单的用户 ID 列表。
如果你想指定仅订阅某一发流用户的视频流,将该用户的 ID 加入此列表中。如果你想要将某一用户从订阅白名单中移除,需要重新调用 [SetSubscribeVideoAllowlist](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_setsubscribevideoallowlist) 方法更新音频订阅白名单的用户 ID 列表,使其不包含你想移除的用户的 `uid`。
白名单用户 ID 列表中的用户数量。
Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/unity/class-rtcconnection)。
### 返回值 [#返回值-28]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-28]
- [IRtcEngineEx](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengineex)
## SetSubscribeVideoBlocklist [#setsubscribevideoblocklist]
设置视频订阅黑名单。
```csharp
public abstract int SetSubscribeVideoBlocklist(uint[] uidList, int uidNumber);
```
你可以调用该方法指定不订阅的视频流。
:::note
注:
- 该方法在加入频道前后均可调用。
- 黑名单设置实时生效。将已订阅用户加入黑名单后,该用户的视频流也会停止订阅。
- 视频订阅黑名单不受 [MuteRemoteVideoStream](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_muteremotevideostream)、[MuteAllRemoteVideoStreams](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_muteallremotevideostreams) 以及 [ChannelMediaOptions](/zh-CN/api-reference/rtc/unity/class-channelmediaoptions) 中的 `autoSubscribeVideo` 的影响。
- 设置订阅黑名单后,如果离开当前频道后再重新加入频道,黑名单依然生效。
- 如果某个用户同时在音频订阅黑名单和白名单中,仅订阅黑名单生效。
:::
### 参数 [#参数-29]
视频订阅黑名单的用户 ID 列表。
如果你想指定不订阅某一发流用户的视频流,将该用户的 ID 加入此列表中。如果你想要将某一用户从订阅黑名单中移除,需要重新调用 [SetSubscribeVideoBlocklist](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_setsubscribevideoblocklist) 方法更新订阅黑名单的用户 ID 列表,使其不包含你想移除的用户的 `uid`。
黑名单用户 ID 列表中的用户数量。
### 返回值 [#返回值-29]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-29]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## SetSubscribeVideoBlocklistEx [#setsubscribevideoblocklistex]
设置视频订阅黑名单。
```csharp
public abstract int SetSubscribeVideoBlocklistEx(uint[] uidList, int uidNumber, RtcConnection connection);
```
你可以调用该方法指定不订阅的视频流。
:::note
注:
- 该方法在加入频道前后均可调用。
- 黑名单设置实时生效。将已订阅用户加入黑名单后,该用户的视频流也会停止订阅。
- 视频订阅黑名单不受 [MuteRemoteVideoStream](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_muteremotevideostream)、[MuteAllRemoteVideoStreams](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_muteallremotevideostreams) 以及 [ChannelMediaOptions](/zh-CN/api-reference/rtc/unity/class-channelmediaoptions) 中的 `autoSubscribeVideo` 的影响。
- 设置订阅黑名单后,如果离开当前频道后再重新加入频道,黑名单依然生效。
- 如果某个用户同时在音频订阅黑名单和白名单中,仅订阅黑名单生效。
:::
### 参数 [#参数-30]
视频订阅黑名单的用户 ID 列表。
如果你想指定不订阅某一发流用户的视频流,将该用户的 ID 加入此列表中。如果你想要将某一用户从订阅黑名单中移除,需要重新调用 [SetSubscribeVideoBlocklist](/zh-CN/api-reference/rtc/unity/publishnsubscribe#api_irtcengine_setsubscribevideoblocklist) 方法更新订阅黑名单的用户 ID 列表,使其不包含你想移除的用户的 `uid`。
黑名单用户 ID 列表中的用户数量。
Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/unity/class-rtcconnection)。
### 返回值 [#返回值-30]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-30]
- [IRtcEngineEx](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengineex)
## OnAudioPublishStateChanged [#onaudiopublishstatechanged]
音频发布状态改变回调。
```csharp
public virtual void OnAudioPublishStateChanged(string channel, STREAM_PUBLISH_STATE oldState,
STREAM_PUBLISH_STATE newState, int elapseSinceLastState)
```
### 参数 [#参数-31]
频道名。
之前的发布状态,详见 [STREAM_PUBLISH_STATE](/zh-CN/api-reference/rtc/unity/enum-streampublishstate)。
当前的发布状态,详见 [STREAM_PUBLISH_STATE](/zh-CN/api-reference/rtc/unity/enum-streampublishstate)。
两次状态变化时间间隔(毫秒)。
### 所属接口类 [#所属接口类-31]
- [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengineeventhandler)
## OnAudioSubscribeStateChanged [#onaudiosubscribestatechanged]
音频订阅状态发生改变回调。
```csharp
public virtual void OnAudioSubscribeStateChanged(string channel, uint uid, STREAM_SUBSCRIBE_STATE oldState,
STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)
```
### 参数 [#参数-32]
频道名。
远端用户的 ID。
之前的订阅状态,详见 [STREAM_SUBSCRIBE_STATE](/zh-CN/api-reference/rtc/unity/enum-streamsubscribestate)。
当前的订阅状态,详见 [STREAM_SUBSCRIBE_STATE](/zh-CN/api-reference/rtc/unity/enum-streamsubscribestate)。
两次状态变化时间间隔(毫秒)。
### 所属接口类 [#所属接口类-32]
- [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengineeventhandler)
## OnVideoSubscribeStateChanged [#onvideosubscribestatechanged]
视频订阅状态发生改变回调。
```csharp
public virtual void OnVideoSubscribeStateChanged(string channel, uint uid, STREAM_SUBSCRIBE_STATE oldState,
STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)
```
### 参数 [#参数-33]
频道名。
远端用户的 ID。
之前的订阅状态,详见 [STREAM_SUBSCRIBE_STATE](/zh-CN/api-reference/rtc/unity/enum-streamsubscribestate)。
当前的订阅状态,详见 [STREAM_SUBSCRIBE_STATE](/zh-CN/api-reference/rtc/unity/enum-streamsubscribestate)。
两次状态变化时间间隔(毫秒)。
### 所属接口类 [#所属接口类-33]
- [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengineeventhandler)