# 发布和订阅 (/zh-CN/api-reference/rtc/electron/publishnsubscribe)

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

<a id="toc_publishnsubscribe"></a>

<a id="api_irtcengine_enabledualstreammode3"></a>

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

## enableDualStreamMode [#enabledualstreammode]

在发送端开启或关闭双流模式并设置视频小流。

<a id="api_irtcengine_enabledualstreammode3__prototype"></a>

```ts
abstract enableDualStreamMode(
    enabled: boolean,
    streamConfig?: SimulcastStreamConfig
  ): number;
```

<a id="api_irtcengine_enabledualstreammode3__detailed_desc"></a>

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

:::error[废弃]
弃用： 从 v4.2.0 起废弃，请改用 [setDualStreamMode](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_setdualstreammode2)。
:::

你可以在发流端调用该方法开启或关闭双流模式。双流指视频大流和视频小流：

- 视频大流：高分辨率、高帧率的视频流。
- 视频小流：低分辨率、低帧率的视频流。

开启双流模式后，你可以在收流端调用 [setRemoteVideoStreamType](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_setremotevideostreamtype) 选择接收视频大流或视频小流。

:::note
注：

- 该方法适用于发送端发送的所有类型的流，包括且不限于来自摄像头采集的视频流、屏幕共享流、自定义采集的视频流。
- 如果需要在多频道场景下开启视频双流，可以调用 [enableDualStreamModeEx](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengineex_enabledualstreammodeex) 方法。
- 该方法可以在加入频道前后调用。
:::

<a id="api_irtcengine_enabledualstreammode3__parameters"></a>

### 参数 [#参数]

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

是否开启双流模式：

- true: 开启双流模式。
- false: (默认) 关闭双流模式。

</Parameter>
<a id="streamconfig"></a>
<Parameter name="streamConfig">

视频小流的配置。详见 [SimulcastStreamConfig](/zh-CN/api-reference/rtc/electron/class-simulcaststreamconfig)。

:::note
注： 当设置 `mode` 为 `DisableSimulcastStream` 时，再设置 `streamConfig` 不会生效。
:::

</Parameter>
</ParameterList>

<a id="api_irtcengine_enabledualstreammode3__return_values"></a>

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

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

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

- [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine)

<a id="api_irtcengineex_enabledualstreammodeex"></a>

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

## enableDualStreamModeEx [#enabledualstreammodeex]

在发送端开启或关闭双流模式。

<a id="api_irtcengineex_enabledualstreammodeex__prototype"></a>

```ts
abstract enableDualStreamModeEx(
    enabled: boolean,
    streamConfig: SimulcastStreamConfig,
    connection: RtcConnection
  ): number;
```

<a id="api_irtcengineex_enabledualstreammodeex__detailed_desc"></a>

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

:::error[废弃]
弃用： 从 v4.2.0 起废弃，请改用 [setDualStreamModeEx](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengineex_setdualstreammodeex)。
:::

你可以在发流端调用该方法开启或关闭双流模式。双流指视频大流和视频小流：

- 视频大流：高分辨率、高帧率的视频流。
- 视频小流：低分辨率、低帧率的视频流。

开启双流模式后，你可以在收流端调用 [setRemoteVideoStreamType](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_setremotevideostreamtype) 选择接收视频大流或视频小流。

:::note
注： 该方法适用于发送端发送的所有类型的流，包括且不限于来自摄像头采集的视频流、屏幕共享流、自定义采集的视频流。
:::

<a id="api_irtcengineex_enabledualstreammodeex__parameters"></a>

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

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

是否开启双流模式：

- true: 开启双流模式。
- false: (默认) 关闭双流模式。

</Parameter>
<a id="streamconfig-1"></a>
<Parameter name="streamConfig">

视频小流的配置。详见 [SimulcastStreamConfig](/zh-CN/api-reference/rtc/electron/class-simulcaststreamconfig)。

:::note
注： 当设置 `mode` 为 `DisableSimulcastStream` 时，再设置 `streamConfig` 不会生效。
:::

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

Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/electron/class-rtcconnection)。

</Parameter>
</ParameterList>

<a id="api_irtcengineex_enabledualstreammodeex__return_values"></a>

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

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

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

- [IRtcEngineEx](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengineex)

<a id="api_irtcengine_muteallremoteaudiostreams"></a>

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

## muteAllRemoteAudioStreams [#muteallremoteaudiostreams]

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

<a id="api_irtcengine_muteallremoteaudiostreams__prototype"></a>

```ts
abstract muteAllRemoteAudioStreams(mute: boolean): number;
```

<a id="api_irtcengine_muteallremoteaudiostreams__detailed_desc"></a>

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

:::note
注： SDK 默认在加入频道时订阅所有远端用户的音频流，如果要修改此行为，可以在调用 [joinChannel](/zh-CN/api-reference/rtc/electron/channel#api_irtcengine_joinchannel2) 加入频道时设置 `autoSubscribeAudio` 为 false，即可在加入频道时取消订阅所有用户的音频流。
如果在调用该方法之后又调用了 [enableAudio](/zh-CN/api-reference/rtc/electron/audio/audio-basic#api_irtcengine_enableaudio) 或 [disableAudio](/zh-CN/api-reference/rtc/electron/audio/audio-basic#api_irtcengine_disableaudio)，则后调用的方法会生效。
:::

<a id="api_irtcengine_muteallremoteaudiostreams__timing"></a>

### 调用时机 [#调用时机]

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

<a id="api_irtcengine_muteallremoteaudiostreams__parameters"></a>

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

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

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

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

</Parameter>
</ParameterList>

<a id="api_irtcengine_muteallremoteaudiostreams__return_values"></a>

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

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

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

- [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine)

<a id="api_irtcengineex_muteallremoteaudiostreamsex"></a>

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

## muteAllRemoteAudioStreamsEx [#muteallremoteaudiostreamsex]

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

<a id="api_irtcengineex_muteallremoteaudiostreamsex__prototype"></a>

```ts
abstract muteAllRemoteAudioStreamsEx(
    mute: boolean,
    connection: RtcConnection
  ): number;
```

<a id="api_irtcengineex_muteallremoteaudiostreamsex__detailed_desc"></a>

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

:::note
注：

- 该方法需要在加入频道后调用。
- 如果需要在加入频道前设置默认不订阅远端用户音频流，可以在调用 [joinChannel](/zh-CN/api-reference/rtc/electron/channel#api_irtcengine_joinchannel2) 加入频道时设置 `autoSubscribeAudio` 为 false。
:::

<a id="api_irtcengineex_muteallremoteaudiostreamsex__parameters"></a>

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

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

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

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

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

Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/electron/class-rtcconnection)。

</Parameter>
</ParameterList>

<a id="api_irtcengineex_muteallremoteaudiostreamsex__return_values"></a>

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

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

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

- [IRtcEngineEx](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengineex)

<a id="api_irtcengine_muteallremotevideostreams"></a>

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

## muteAllRemoteVideoStreams [#muteallremotevideostreams]

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

<a id="api_irtcengine_muteallremotevideostreams__prototype"></a>

```ts
abstract muteAllRemoteVideoStreams(mute: boolean): number;
```

<a id="api_irtcengine_muteallremotevideostreams__detailed_desc"></a>

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

:::note
注： SDK 默认在加入频道时订阅所有远端用户的视频流，如果要修改此行为，可以在调用 [joinChannel](/zh-CN/api-reference/rtc/electron/channel#api_irtcengine_joinchannel2) 加入频道时设置 `autoSubscribeVideo` 为 false，即可在加入频道时取消订阅所有用户的视频流。
如果在调用该方法之后又调用了 [enableVideo](/zh-CN/api-reference/rtc/electron/video/video-basic#api_irtcengine_enablevideo) 或 [disableVideo](/zh-CN/api-reference/rtc/electron/video/video-basic#api_irtcengine_disablevideo)，则后调用的方法会生效。
:::

<a id="api_irtcengine_muteallremotevideostreams__timing"></a>

### 调用时机 [#调用时机-1]

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

<a id="api_irtcengine_muteallremotevideostreams__parameters"></a>

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

<ParameterList>
<a id="mute-2"></a>
<Parameter name="mute">

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

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

</Parameter>
</ParameterList>

<a id="api_irtcengine_muteallremotevideostreams__return_values"></a>

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

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

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

- [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine)

<a id="api_irtcengineex_muteallremotevideostreamsex"></a>

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

## muteAllRemoteVideoStreamsEx [#muteallremotevideostreamsex]

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

<a id="api_irtcengineex_muteallremotevideostreamsex__prototype"></a>

```ts
abstract muteAllRemoteVideoStreamsEx(
    mute: boolean,
    connection: RtcConnection
  ): number;
```

<a id="api_irtcengineex_muteallremotevideostreamsex__detailed_desc"></a>

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

<a id="api_irtcengineex_muteallremotevideostreamsex__parameters"></a>

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

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

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

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

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

Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/electron/class-rtcconnection)。

</Parameter>
</ParameterList>

<a id="api_irtcengineex_muteallremotevideostreamsex__return_values"></a>

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

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

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

- [IRtcEngineEx](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengineex)

<a id="api_irtcengine_mutelocalaudiostream"></a>

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

## muteLocalAudioStream [#mutelocalaudiostream]

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

<a id="api_irtcengine_mutelocalaudiostream__prototype"></a>

```ts
abstract muteLocalAudioStream(mute: boolean): number;
```

<a id="api_irtcengine_mutelocalaudiostream__detailed_desc"></a>

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

<a id="api_irtcengine_mutelocalaudiostream__timing"></a>

### 调用时机 [#调用时机-2]

加入频道前后均可调用。

<a id="api_irtcengine_mutelocalaudiostream__related"></a>

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

成功调用该方法后，本地会触发 [onAudioPublishStateChanged](/zh-CN/api-reference/rtc/electron/publishnsubscribe#callback_irtcengineeventhandler_onaudiopublishstatechanged) 回调；远端会触发 [onUserMuteAudio](/zh-CN/api-reference/rtc/electron/audio/audio-basic#callback_irtcengineeventhandler_onusermuteaudio) 回调和 [onRemoteAudioStateChanged](/zh-CN/api-reference/rtc/electron/audio/audio-basic#callback_irtcengineeventhandler_onremoteaudiostatechanged) 回调。

<a id="api_irtcengine_mutelocalaudiostream__parameters"></a>

### 参数 [#参数-6]

<ParameterList>
<a id="mute-4"></a>
<Parameter name="mute">

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

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

</Parameter>
</ParameterList>

<a id="api_irtcengine_mutelocalaudiostream__return_values"></a>

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

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

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

- [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine)

<a id="api_irtcengineex_mutelocalaudiostreamex"></a>

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

## muteLocalAudioStreamEx [#mutelocalaudiostreamex]

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

<a id="api_irtcengineex_mutelocalaudiostreamex__prototype"></a>

```ts
abstract muteLocalAudioStreamEx(
    mute: boolean,
    connection: RtcConnection
  ): number;
```

<a id="api_irtcengineex_mutelocalaudiostreamex__detailed_desc"></a>

成功调用该方法后，远端会触发 [onUserMuteAudio](/zh-CN/api-reference/rtc/electron/audio/audio-basic#callback_irtcengineeventhandler_onusermuteaudio) 回调和 [onRemoteAudioStateChanged](/zh-CN/api-reference/rtc/electron/audio/audio-basic#callback_irtcengineeventhandler_onremoteaudiostatechanged) 回调。

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

<a id="api_irtcengineex_mutelocalaudiostreamex__parameters"></a>

### 参数 [#参数-7]

<ParameterList>
<a id="mute-5"></a>
<Parameter name="mute">

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

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

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

Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/electron/class-rtcconnection)。

</Parameter>
</ParameterList>

<a id="api_irtcengineex_mutelocalaudiostreamex__return_values"></a>

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

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

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

- [IRtcEngineEx](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengineex)

<a id="api_irtcengine_mutelocalvideostream"></a>

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

## muteLocalVideoStream [#mutelocalvideostream]

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

<a id="api_irtcengine_mutelocalvideostream__prototype"></a>

```ts
abstract muteLocalVideoStream(mute: boolean): number;
```

<a id="api_irtcengine_mutelocalvideostream__detailed_desc"></a>

该方法用于控制是否发布本地采集的视频流。如果不发布本地采集的视频流，也不会禁用视频采集设备，所以不影响视频的采集状态。
相比于调用 [enableLocalVideo](/zh-CN/api-reference/rtc/electron/video/video-basic#api_irtcengine_enablelocalvideo)(false) 关闭本地视频流采集、从而取消发布本地视频流的方法，该方法响应速度更快。

<a id="api_irtcengine_mutelocalvideostream__timing"></a>

### 调用时机 [#调用时机-3]

加入频道前后均可调用。

<a id="api_irtcengine_mutelocalvideostream__related"></a>

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

成功调用该方法后，本地会触发 [onVideoPublishStateChanged](/zh-CN/api-reference/rtc/electron/video/video-basic#callback_irtcengineeventhandler_onvideopublishstatechanged) 回调；远端会触发 [onUserMuteVideo](/zh-CN/api-reference/rtc/electron/video/video-basic#callback_irtcengineeventhandler_onusermutevideo) 回调和 [onRemoteVideoStateChanged](/zh-CN/api-reference/rtc/electron/video/video-basic#callback_irtcengineeventhandler_onremotevideostatechanged) 回调。

<a id="api_irtcengine_mutelocalvideostream__parameters"></a>

### 参数 [#参数-8]

<ParameterList>
<a id="mute-6"></a>
<Parameter name="mute">

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

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

</Parameter>
</ParameterList>

<a id="api_irtcengine_mutelocalvideostream__return_values"></a>

### 返回值 [#返回值-8]

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

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

- [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine)

<a id="api_irtcengineex_mutelocalvideostreamex"></a>

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

## muteLocalVideoStreamEx [#mutelocalvideostreamex]

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

<a id="api_irtcengineex_mutelocalvideostreamex__prototype"></a>

```ts
abstract muteLocalVideoStreamEx(
    mute: boolean,
    connection: RtcConnection
  ): number;
```

<a id="api_irtcengineex_mutelocalvideostreamex__detailed_desc"></a>

成功调用该方法后，远端会触发 [onUserMuteVideo](/zh-CN/api-reference/rtc/electron/video/video-basic#callback_irtcengineeventhandler_onusermutevideo) 回调。

:::note
注：

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

<a id="api_irtcengineex_mutelocalvideostreamex__parameters"></a>

### 参数 [#参数-9]

<ParameterList>
<a id="mute-7"></a>
<Parameter name="mute">

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

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

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

Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/electron/class-rtcconnection)。

</Parameter>
</ParameterList>

<a id="api_irtcengineex_mutelocalvideostreamex__return_values"></a>

### 返回值 [#返回值-9]

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

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

- [IRtcEngineEx](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengineex)

<a id="api_irtcengine_muteremoteaudiostream"></a>

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

## muteRemoteAudioStream [#muteremoteaudiostream]

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

<a id="api_irtcengine_muteremoteaudiostream__prototype"></a>

```ts
abstract muteRemoteAudioStream(uid: number, mute: boolean): number;
```

<a id="api_irtcengine_muteremoteaudiostream__detailed_desc"></a>

<a id="api_irtcengine_muteremoteaudiostream__timing"></a>

### 调用时机 [#调用时机-4]

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

<a id="api_irtcengine_muteremoteaudiostream__related"></a>

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

成功调用该方法后，本地会触发 [onAudioSubscribeStateChanged](/zh-CN/api-reference/rtc/electron/publishnsubscribe#callback_irtcengineeventhandler_onaudiosubscribestatechanged) 回调。

<a id="api_irtcengine_muteremoteaudiostream__parameters"></a>

### 参数 [#参数-10]

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

指定用户的用户 ID。

</Parameter>
<a id="mute-8"></a>
<Parameter name="mute">

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

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

</Parameter>
</ParameterList>

<a id="api_irtcengine_muteremoteaudiostream__return_values"></a>

### 返回值 [#返回值-10]

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

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

- [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine)

<a id="api_irtcengineex_muteremoteaudiostreamex"></a>

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

## muteRemoteAudioStreamEx [#muteremoteaudiostreamex]

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

<a id="api_irtcengineex_muteremoteaudiostreamex__prototype"></a>

```ts
abstract muteRemoteAudioStreamEx(
    uid: number,
    mute: boolean,
    connection: RtcConnection
  ): number;
```

<a id="api_irtcengineex_muteremoteaudiostreamex__detailed_desc"></a>

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

<a id="api_irtcengineex_muteremoteaudiostreamex__parameters"></a>

### 参数 [#参数-11]

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

指定用户的 ID。

</Parameter>
<a id="mute-9"></a>
<Parameter name="mute">

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

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

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

Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/electron/class-rtcconnection)。

</Parameter>
</ParameterList>

<a id="api_irtcengineex_muteremoteaudiostreamex__return_values"></a>

### 返回值 [#返回值-11]

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

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

- [IRtcEngineEx](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengineex)

<a id="api_irtcengine_muteremotevideostream"></a>

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

## muteRemoteVideoStream [#muteremotevideostream]

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

<a id="api_irtcengine_muteremotevideostream__prototype"></a>

```ts
abstract muteRemoteVideoStream(uid: number, mute: boolean): number;
```

<a id="api_irtcengine_muteremotevideostream__detailed_desc"></a>

<a id="api_irtcengine_muteremotevideostream__timing"></a>

### 调用时机 [#调用时机-5]

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

<a id="api_irtcengine_muteremotevideostream__related"></a>

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

成功调用该方法后，本地会触发 [onVideoSubscribeStateChanged](/zh-CN/api-reference/rtc/electron/publishnsubscribe#callback_irtcengineeventhandler_onvideosubscribestatechanged) 回调。

<a id="api_irtcengine_muteremotevideostream__parameters"></a>

### 参数 [#参数-12]

<ParameterList>
<a id="uid-2"></a>
<Parameter name="uid">

指定用户的用户 ID。

</Parameter>
<a id="mute-10"></a>
<Parameter name="mute">

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

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

</Parameter>
</ParameterList>

<a id="api_irtcengine_muteremotevideostream__return_values"></a>

### 返回值 [#返回值-12]

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

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

- [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine)

<a id="api_irtcengineex_muteremotevideostreamex"></a>

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

## muteRemoteVideoStreamEx [#muteremotevideostreamex]

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

<a id="api_irtcengineex_muteremotevideostreamex__prototype"></a>

```ts
abstract muteRemoteVideoStreamEx(
    uid: number,
    mute: boolean,
    connection: RtcConnection
  ): number;
```

<a id="api_irtcengineex_muteremotevideostreamex__detailed_desc"></a>

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

<a id="api_irtcengineex_muteremotevideostreamex__parameters"></a>

### 参数 [#参数-13]

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

远端用户的 ID。

</Parameter>
<a id="mute-11"></a>
<Parameter name="mute">

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

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

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

Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/electron/class-rtcconnection)。

</Parameter>
</ParameterList>

<a id="api_irtcengineex_muteremotevideostreamex__return_values"></a>

### 返回值 [#返回值-13]

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

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

- [IRtcEngineEx](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengineex)

<a id="api_irtcengine_setdualstreammode2"></a>

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

## setDualStreamMode [#setdualstreammode]

在发送端设置双流模式并设置视频小流。

<a id="api_irtcengine_setdualstreammode2__prototype"></a>

```ts
abstract setDualStreamMode(
    mode: SimulcastStreamMode,
    streamConfig?: SimulcastStreamConfig
  ): number;
```

<a id="api_irtcengine_setdualstreammode2__detailed_desc"></a>

SDK 默认在发送端开启小流自适应模式 (`AutoSimulcastStream`)，即发送端不主动发送小流，主播身份的接收端可以调用 [setRemoteVideoStreamType](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_setremotevideostreamtype) 发起小流申请，发送端收到申请后开始自动发送小流。

- 如果你想修改此行为，可以调用该方法并修改 `mode` 为 `DisableSimulcastStream`（始终不发送小流）或 `EnableSimulcastStream`（始终发送小流）。
- 如果你在进行修改后又想恢复该默认行为，可重新调用该方法，并将 `mode` 设置为 `AutoSimulcastStream`。

:::note
注： 该方法和 [enableDualStreamMode](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_enabledualstreammode3) 的区别与联系如下：

- 调用该方法并设置 `mode` 为 `DisableSimulcastStream` 时，跟调用 [enableDualStreamMode](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_enabledualstreammode3) 并设置 `enabled` 为 false 的效果相同。
- 调用该方法并设置 `mode` 为 `EnableSimulcastStream` 时，跟调用 [enableDualStreamMode](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_enabledualstreammode3) 并设置 `enabled` 为 true 的效果相同。
- 两种方法均可在加入频道前后调用，若同时使用，则以后调用的方法中的设置为准。
:::

<a id="api_irtcengine_setdualstreammode2__parameters"></a>

### 参数 [#参数-14]

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

发送视频流的模式。详见 [SimulcastStreamMode](/zh-CN/api-reference/rtc/electron/enum-simulcaststreammode)。

</Parameter>
<a id="streamconfig-2"></a>
<Parameter name="streamConfig">

视频小流的配置。详见 [SimulcastStreamConfig](/zh-CN/api-reference/rtc/electron/class-simulcaststreamconfig)。

:::note
注： 当设置 `mode` 为 `DisableSimulcastStream` 时，再设置 `streamConfig` 不会生效。
:::

</Parameter>
</ParameterList>

<a id="api_irtcengine_setdualstreammode2__return_values"></a>

### 返回值 [#返回值-14]

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

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

- [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine)

<a id="api_irtcengineex_setdualstreammodeex"></a>

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

## setDualStreamModeEx [#setdualstreammodeex]

在发送端设置双流模式。

<a id="api_irtcengineex_setdualstreammodeex__prototype"></a>

```ts
abstract setDualStreamModeEx(
    mode: SimulcastStreamMode,
    streamConfig: SimulcastStreamConfig,
    connection: RtcConnection
  ): number;
```

<a id="api_irtcengineex_setdualstreammodeex__detailed_desc"></a>

SDK 默认在发送端开启小流自适应模式 (`AutoSimulcastStream`)，即发送端不主动发送小流，主播身份的接收端可以调用 [setRemoteVideoStreamTypeEx](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengineex_setremotevideostreamtypeex) 发起小流申请，发送端收到申请后开始自动发送小流。

- 如果你想修改此行为，可以调用该方法并修改 `mode` 为 `DisableSimulcastStream`（始终不发送小流）或 `EnableSimulcastStream`（始终发送小流）。
- 如果你在进行修改后又想恢复该默认行为，可重新调用该方法，并将 `mode` 设置为 `AutoSimulcastStream`。

:::note
注： 该方法和 [enableDualStreamModeEx](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengineex_enabledualstreammodeex) 的区别与联系如下：

- 调用该方法并设置 `mode` 为 `DisableSimulcastStream` 时，跟 `enableDualStreamModeEx(false)` 的效果相同。
- 调用该方法并设置 `mode` 为 `EnableSimulcastStream` 时，跟 `enableDualStreamModeEx(true)` 的效果相同。
- 两种方法均可在加入频道前后调用，若同时使用，则以后调用的方法中的设置为准。
:::

<a id="api_irtcengineex_setdualstreammodeex__parameters"></a>

### 参数 [#参数-15]

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

发送视频流的模式。详见 [SimulcastStreamMode](/zh-CN/api-reference/rtc/electron/enum-simulcaststreammode)。

</Parameter>
<a id="streamconfig-3"></a>
<Parameter name="streamConfig">

视频小流的配置。详见 [SimulcastStreamConfig](/zh-CN/api-reference/rtc/electron/class-simulcaststreamconfig)。

:::note
注： 当设置 `mode` 为 `DisableSimulcastStream` 时，再设置 `streamConfig` 不会生效。
:::

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

Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/electron/class-rtcconnection)。

</Parameter>
</ParameterList>

<a id="api_irtcengineex_setdualstreammodeex__return_values"></a>

### 返回值 [#返回值-15]

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

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

- [IRtcEngineEx](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengineex)

<a id="api_irtcengine_setremotedefaultvideostreamtype"></a>

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

## setRemoteDefaultVideoStreamType [#setremotedefaultvideostreamtype]

设置默认订阅的视频流类型。

<a id="api_irtcengine_setremotedefaultvideostreamtype__prototype"></a>

```ts
abstract setRemoteDefaultVideoStreamType(streamType: VideoStreamType): number;
```

<a id="api_irtcengine_setremotedefaultvideostreamtype__detailed_desc"></a>

取决于发送端的默认行为和调用 [setDualStreamMode](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_setdualstreammode2) 的具体设置，接收端调用该方法分为以下几种情况：

- SDK 默认在发送端开启小流自适应模式 (`AutoSimulcastStream`)，即：发送端仅发送大流，仅主播身份的接收端可以调用该方法发起小流申请，发送端收到申请后开始自动发送小流，此时频道内所有用户均可调用该方法切换到小流订阅模式。
- 当发送端调用 [setDualStreamMode](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_setdualstreammode2) 并将 `mode` 设置为 `DisableSimulcastStream`（始终不发送小流），则调用该方法不生效。
- 当发送端调用 [setDualStreamMode](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_setdualstreammode2) 并将 `mode` 设置为 `EnableSimulcastStream`（始终发送小流），则主播或观众身份的接收端均可调用该方法切换到小流订阅模式。

在接收视频小流时，SDK 会根据视频窗口的大小动态调整对应视频流的大小，以节约带宽和计算资源。视频小流默认的宽高比和视频大流的宽高比一致。根据当前大流的宽高比，系统会自动分配小流的分辨率、帧率及码率。

:::note
注： 如果你既调用了该方法，也调用了 [setRemoteVideoStreamType](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_setremotevideostreamtype)，则 SDK 以 [setRemoteVideoStreamType](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_setremotevideostreamtype) 中的设置为准。
:::

<a id="api_irtcengine_setremotedefaultvideostreamtype__timing"></a>

### 调用时机 [#调用时机-6]

该方法只能在加入频道前调用。SDK 不支持你在加入频道后修改默认订阅的视频流类型。

<a id="api_irtcengine_setremotedefaultvideostreamtype__parameters"></a>

### 参数 [#参数-16]

<ParameterList>
<a id="streamtype"></a>
<Parameter name="streamType">

默认订阅的视频流类型: [VideoStreamType](/zh-CN/api-reference/rtc/electron/enum-videostreamtype)。

</Parameter>
</ParameterList>

<a id="api_irtcengine_setremotedefaultvideostreamtype__return_values"></a>

### 返回值 [#返回值-16]

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

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

- [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine)

<a id="api_irtcengine_setremotevideostreamtype"></a>

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

## setRemoteVideoStreamType [#setremotevideostreamtype]

设置订阅的视频流类型。

<a id="api_irtcengine_setremotevideostreamtype__prototype"></a>

```ts
abstract setRemoteVideoStreamType(
    uid: number,
    streamType: VideoStreamType
  ): number;
```

<a id="api_irtcengine_setremotevideostreamtype__detailed_desc"></a>

取决于发送端的默认行为和调用 [setDualStreamMode](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_setdualstreammode2) 的具体设置，接收端调用该方法分为以下几种情况：

- SDK 默认在发送端开启小流自适应模式 (`AutoSimulcastStream`)，即：发送端仅发送大流，仅主播身份的接收端可以调用该方法发起小流申请，发送端收到申请后开始自动发送小流，此时频道内所有用户均可调用该方法切换到小流订阅模式。
- 当发送端调用 [setDualStreamMode](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_setdualstreammode2) 并将 `mode` 设置为 `DisableSimulcastStream`（始终不发送小流），则调用该方法不生效。
- 当发送端调用 [setDualStreamMode](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_setdualstreammode2) 并将 `mode` 设置为 `EnableSimulcastStream`（始终发送小流），则主播或观众身份的接收端均可调用该方法切换到小流订阅模式。

在接收视频小流时，SDK 会根据视频窗口的大小动态调整对应视频流的大小，以节约带宽和计算资源。视频小流默认的宽高比和视频大流的宽高比一致。根据当前大流的宽高比，系统会自动分配小流的分辨率、帧率及码率。

:::note
注：

- 该方法在加入频道前后都能调用。
- 如果既调用了该方法，也调用了 [setRemoteDefaultVideoStreamType](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_setremotedefaultvideostreamtype)，则 SDK 以该方法中的设置为准。
:::

<a id="api_irtcengine_setremotevideostreamtype__parameters"></a>

### 参数 [#参数-17]

<ParameterList>
<a id="uid-4"></a>
<Parameter name="uid">

用户 ID。

</Parameter>
<a id="streamtype-1"></a>
<Parameter name="streamType">

视频流类型: [VideoStreamType](/zh-CN/api-reference/rtc/electron/enum-videostreamtype)。

</Parameter>
</ParameterList>

<a id="api_irtcengine_setremotevideostreamtype__return_values"></a>

### 返回值 [#返回值-17]

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

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

- [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine)

<a id="api_irtcengineex_setremotevideostreamtypeex"></a>

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

## setRemoteVideoStreamTypeEx [#setremotevideostreamtypeex]

设置订阅的视频流类型。

<a id="api_irtcengineex_setremotevideostreamtypeex__prototype"></a>

```ts
abstract setRemoteVideoStreamTypeEx(
    uid: number,
    streamType: VideoStreamType,
    connection: RtcConnection
  ): number;
```

<a id="api_irtcengineex_setremotevideostreamtypeex__detailed_desc"></a>

取决于发送端的默认行为和调用 [setDualStreamMode](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_setdualstreammode2) 的具体设置，接收端调用该方法分为以下几种情况：

- SDK 默认在发送端开启小流自适应模式 (`AutoSimulcastStream`)，即：发送端仅发送大流，仅主播身份的接收端可以调用该方法发起小流申请，发送端收到申请后开始自动发送小流，此时频道内所有用户均可调用该方法切换到小流订阅模式。
- 当发送端调用 [setDualStreamMode](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_setdualstreammode2) 并将 `mode` 设置为 `DisableSimulcastStream`（始终不发送小流），则调用该方法不生效。
- 当发送端调用 [setDualStreamMode](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_setdualstreammode2) 并将 `mode` 设置为 `EnableSimulcastStream`（始终发送小流），则主播或观众身份的接收端均可调用该方法切换到小流订阅模式。

在接收视频小流时，SDK 会根据视频窗口的大小动态调整对应视频流的大小，以节约带宽和计算资源。视频小流默认的宽高比和视频大流的宽高比一致。根据当前大流的宽高比，系统会自动分配小流的分辨率、帧率及码率。

:::note
注： 如果发送端已调用 [setDualStreamModeEx](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengineex_setdualstreammodeex) 并将 `mode` 设置为 `DisableSimulcastStream`（始终不发送小流），则调用该方法不生效，你需要在发送端重新调用 [setDualStreamModeEx](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengineex_setdualstreammodeex) 修改设置。
:::

<a id="api_irtcengineex_setremotevideostreamtypeex__parameters"></a>

### 参数 [#参数-18]

<ParameterList>
<a id="uid-5"></a>
<Parameter name="uid">

用户 ID。

</Parameter>
<a id="streamtype-2"></a>
<Parameter name="streamType">

视频流类型: [VideoStreamType](/zh-CN/api-reference/rtc/electron/enum-videostreamtype)。

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

Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/electron/class-rtcconnection)。

</Parameter>
</ParameterList>

<a id="api_irtcengineex_setremotevideostreamtypeex__return_values"></a>

### 返回值 [#返回值-18]

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

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

- [IRtcEngineEx](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengineex)

<a id="api_irtcengine_setremotevideosubscriptionoptions"></a>

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

## setRemoteVideoSubscriptionOptions [#setremotevideosubscriptionoptions]

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

<a id="api_irtcengine_setremotevideosubscriptionoptions__prototype"></a>

```ts
abstract setRemoteVideoSubscriptionOptions(
    uid: number,
    options: VideoSubscriptionOptions
  ): number;
```

<a id="api_irtcengine_setremotevideosubscriptionoptions__detailed_desc"></a>

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

- 如果注册的是 [IVideoFrameObserver](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_ivideoframeobserver) 观测器，则默认订阅原始数据和编码后的数据。
- 如果注册的是 [IVideoEncodedFrameObserver](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_ivideoencodedframeobserver) 观测器，则默认仅订阅编码后的数据。
- 如果注册了两种观测器，则默认跟随后注册的视频观测器。举例来说，如果后注册的是 [IVideoFrameObserver](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_ivideoframeobserver) 观测器，则默认订阅原始数据和编码后的数据。

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

<a id="api_irtcengine_setremotevideosubscriptionoptions__parameters"></a>

### 参数 [#参数-19]

<ParameterList>
<a id="uid-6"></a>
<Parameter name="uid">

远端用户 ID。

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

视频流的订阅设置，详见 [VideoSubscriptionOptions](/zh-CN/api-reference/rtc/electron/class-videosubscriptionoptions)。

</Parameter>
</ParameterList>

<a id="api_irtcengine_setremotevideosubscriptionoptions__return_values"></a>

### 返回值 [#返回值-19]

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

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

- [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine)

<a id="api_irtcengineex_setremotevideosubscriptionoptionsex"></a>

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

## setRemoteVideoSubscriptionOptionsEx [#setremotevideosubscriptionoptionsex]

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

<a id="api_irtcengineex_setremotevideosubscriptionoptionsex__prototype"></a>

```ts
abstract setRemoteVideoSubscriptionOptionsEx(
    uid: number,
    options: VideoSubscriptionOptions,
    connection: RtcConnection
  ): number;
```

<a id="api_irtcengineex_setremotevideosubscriptionoptionsex__detailed_desc"></a>

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

<a id="api_irtcengineex_setremotevideosubscriptionoptionsex__parameters"></a>

### 参数 [#参数-20]

<ParameterList>
<a id="uid-7"></a>
<Parameter name="uid">

远端用户 ID。

</Parameter>
<a id="options-1"></a>
<Parameter name="options">

视频流的订阅设置，详见 [VideoSubscriptionOptions](/zh-CN/api-reference/rtc/electron/class-videosubscriptionoptions)。

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

Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/electron/class-rtcconnection)。

</Parameter>
</ParameterList>

<a id="api_irtcengineex_setremotevideosubscriptionoptionsex__return_values"></a>

### 返回值 [#返回值-20]

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

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

- [IRtcEngineEx](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengineex)

<a id="api_irtcengine_setsubscribeaudioallowlist"></a>

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

## setSubscribeAudioAllowlist [#setsubscribeaudioallowlist]

设置音频订阅白名单。

<a id="api_irtcengine_setsubscribeaudioallowlist__prototype"></a>

```ts
abstract setSubscribeAudioAllowlist(
    uidList: number[],
    uidNumber: number
  ): number;
```

<a id="api_irtcengine_setsubscribeaudioallowlist__detailed_desc"></a>

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

:::note
注：

- 该方法在加入频道前后均可调用。
- 音频订阅白名单不受 [muteRemoteAudioStream](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_muteremoteaudiostream)、[muteAllRemoteAudioStreams](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_muteallremoteaudiostreams) 以及 [ChannelMediaOptions](/zh-CN/api-reference/rtc/electron/class-channelmediaoptions) 中的 `autoSubscribeAudio` 的影响。
- 设置订阅白名单后，如果离开当前频道后再重新加入频道，白名单依然生效。
- 如果某个用户同时在音频订阅黑名单和白名单中，仅订阅黑名单生效。
:::

<a id="api_irtcengine_setsubscribeaudioallowlist__parameters"></a>

### 参数 [#参数-21]

<ParameterList>
<a id="uidlist"></a>
<Parameter name="uidList">

音频订阅白名单的用户 ID 列表。
如果你想指定订阅某一发流用户的音频流，将该用户的 ID 加入此列表中。如果你想要将某一用户从订阅白名单中移除，需要重新调用 [setSubscribeAudioAllowlist](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_setsubscribeaudioallowlist) 方法更新音频订阅白名单的用户 ID 列表，使其不包含你想移除的用户的 `uid`。

</Parameter>
<a id="uidnumber"></a>
<Parameter name="uidNumber">

白名单用户 ID 列表中的用户数量。

</Parameter>
</ParameterList>

<a id="api_irtcengine_setsubscribeaudioallowlist__return_values"></a>

### 返回值 [#返回值-21]

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

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

- [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine)

<a id="api_irtcengineex_setsubscribeaudioallowlistex"></a>

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

## setSubscribeAudioAllowlistEx [#setsubscribeaudioallowlistex]

设置音频订阅白名单。

<a id="api_irtcengineex_setsubscribeaudioallowlistex__prototype"></a>

```ts
abstract setSubscribeAudioAllowlistEx(
    uidList: number[],
    uidNumber: number,
    connection: RtcConnection
  ): number;
```

<a id="api_irtcengineex_setsubscribeaudioallowlistex__detailed_desc"></a>

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

:::note
注：

- 该方法在加入频道前后均可调用。
- 音频订阅白名单不受 [muteRemoteAudioStream](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_muteremoteaudiostream)、[muteAllRemoteAudioStreams](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_muteallremoteaudiostreams) 以及 [ChannelMediaOptions](/zh-CN/api-reference/rtc/electron/class-channelmediaoptions) 中的 `autoSubscribeAudio` 的影响。
- 设置订阅白名单后，如果离开当前频道后再重新加入频道，白名单依然生效。
- 如果某个用户同时在音频订阅黑名单和白名单中，仅订阅黑名单生效。
:::

<a id="api_irtcengineex_setsubscribeaudioallowlistex__parameters"></a>

### 参数 [#参数-22]

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

音频订阅白名单的用户 ID 列表。
如果你想指定订阅某一发流用户的音频流，将该用户的 ID 加入此列表中。如果你想要将某一用户从订阅白名单中移除，需要重新调用 [setSubscribeAudioAllowlist](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_setsubscribeaudioallowlist) 方法更新音频订阅白名单的用户 ID 列表，使其不包含你想移除的用户的 `uid`。

</Parameter>
<a id="uidnumber-1"></a>
<Parameter name="uidNumber">

白名单用户 ID 列表中的用户数量。

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

Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/electron/class-rtcconnection)。

</Parameter>
</ParameterList>

<a id="api_irtcengineex_setsubscribeaudioallowlistex__return_values"></a>

### 返回值 [#返回值-22]

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

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

- [IRtcEngineEx](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengineex)

<a id="api_irtcengine_setsubscribeaudioblocklist"></a>

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

## setSubscribeAudioBlocklist [#setsubscribeaudioblocklist]

设置音频订阅黑名单。

<a id="api_irtcengine_setsubscribeaudioblocklist__prototype"></a>

```ts
abstract setSubscribeAudioBlocklist(
    uidList: number[],
    uidNumber: number
  ): number;
```

<a id="api_irtcengine_setsubscribeaudioblocklist__detailed_desc"></a>

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

:::note
注：

- 该方法在加入频道前后均可调用。
- 黑名单设置实时生效。将已订阅用户加入黑名单后，该用户的音频流也会停止订阅。
- 音频订阅黑名单不受 [muteRemoteAudioStream](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_muteremoteaudiostream)、[muteAllRemoteAudioStreams](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_muteallremoteaudiostreams) 以及 [ChannelMediaOptions](/zh-CN/api-reference/rtc/electron/class-channelmediaoptions) 中的 `autoSubscribeAudio` 影响。
- 设置订阅黑名单后，如果离开当前频道后再重新加入频道，黑名单依然生效。
- 如果某个用户同时在音频订阅黑名单和白名单中，仅订阅黑名单生效。
:::

<a id="api_irtcengine_setsubscribeaudioblocklist__parameters"></a>

### 参数 [#参数-23]

<ParameterList>
<a id="uidlist-2"></a>
<Parameter name="uidList">

订阅黑名单的用户 ID 列表。
如果你想指定不订阅某一发流用户的音频流，将该用户的 ID 加入此列表中。如果你想要将某一用户从订阅黑名单中移除，需要重新调用 [setSubscribeAudioBlocklist](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_setsubscribeaudioblocklist) 方法更新订阅黑名单的用户 ID 列表，使其不包含你想移除的用户的 `uid`。

</Parameter>
<a id="uidnumber-2"></a>
<Parameter name="uidNumber">

黑名单用户 ID 列表中的用户数量。

</Parameter>
</ParameterList>

<a id="api_irtcengine_setsubscribeaudioblocklist__return_values"></a>

### 返回值 [#返回值-23]

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

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

- [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine)

<a id="api_irtcengineex_setsubscribeaudioblocklistex"></a>

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

## setSubscribeAudioBlocklistEx [#setsubscribeaudioblocklistex]

设置音频订阅黑名单。

<a id="api_irtcengineex_setsubscribeaudioblocklistex__prototype"></a>

```ts
abstract setSubscribeAudioBlocklistEx(
    uidList: number[],
    uidNumber: number,
    connection: RtcConnection
  ): number;
```

<a id="api_irtcengineex_setsubscribeaudioblocklistex__detailed_desc"></a>

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

:::note
注：

- 该方法在加入频道前后均可调用。
- 黑名单设置实时生效。将已订阅用户加入黑名单后，该用户的音频流也会停止订阅。
- 音频订阅黑名单不受 [muteRemoteAudioStream](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_muteremoteaudiostream)、[muteAllRemoteAudioStreams](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_muteallremoteaudiostreams) 以及 [ChannelMediaOptions](/zh-CN/api-reference/rtc/electron/class-channelmediaoptions) 中的 `autoSubscribeAudio` 影响。
- 设置订阅黑名单后，如果离开当前频道后再重新加入频道，黑名单依然生效。
- 如果某个用户同时在音频订阅黑名单和白名单中，仅订阅黑名单生效。
:::

<a id="api_irtcengineex_setsubscribeaudioblocklistex__parameters"></a>

### 参数 [#参数-24]

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

订阅黑名单的用户 ID 列表。
如果你想指定不订阅某一发流用户的音频流，将该用户的 ID 加入此列表中。如果你想要将某一用户从订阅黑名单中移除，需要重新调用 [setSubscribeAudioBlocklist](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_setsubscribeaudioblocklist) 方法更新订阅黑名单的用户 ID 列表，使其不包含你想移除的用户的 `uid`。

</Parameter>
<a id="uidnumber-3"></a>
<Parameter name="uidNumber">

黑名单用户 ID 列表中的用户数量。

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

Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/electron/class-rtcconnection)。

</Parameter>
</ParameterList>

<a id="api_irtcengineex_setsubscribeaudioblocklistex__return_values"></a>

### 返回值 [#返回值-24]

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

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

- [IRtcEngineEx](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengineex)

<a id="api_irtcengine_setsubscribevideoallowlist"></a>

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

## setSubscribeVideoAllowlist [#setsubscribevideoallowlist]

设置视频订阅白名单。

<a id="api_irtcengine_setsubscribevideoallowlist__prototype"></a>

```ts
abstract setSubscribeVideoAllowlist(
    uidList: number[],
    uidNumber: number
  ): number;
```

<a id="api_irtcengine_setsubscribevideoallowlist__detailed_desc"></a>

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

:::note
注：

- 该方法在加入频道前后均可调用。
- 视频订阅白名单不受 [muteRemoteVideoStream](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_muteremotevideostream)、[muteAllRemoteVideoStreams](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_muteallremotevideostreams) 以及 [ChannelMediaOptions](/zh-CN/api-reference/rtc/electron/class-channelmediaoptions) 中的 `autoSubscribeVideo` 的影响。
- 设置订阅白名单后，如果离开当前频道后再重新加入频道，白名单依然生效。
- 如果某个用户同时在音频订阅黑名单和白名单中，仅订阅黑名单生效。
:::

<a id="api_irtcengine_setsubscribevideoallowlist__parameters"></a>

### 参数 [#参数-25]

<ParameterList>
<a id="uidlist-4"></a>
<Parameter name="uidList">

视频订阅白名单的用户 ID 列表。
如果你想指定仅订阅某一发流用户的视频流，将该用户的 ID 加入此列表中。如果你想要将某一用户从订阅白名单中移除，需要重新调用 [setSubscribeVideoAllowlist](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_setsubscribevideoallowlist) 方法更新音频订阅白名单的用户 ID 列表，使其不包含你想移除的用户的 `uid`。

</Parameter>
<a id="uidnumber-4"></a>
<Parameter name="uidNumber">

白名单用户 ID 列表中的用户数量。

</Parameter>
</ParameterList>

<a id="api_irtcengine_setsubscribevideoallowlist__return_values"></a>

### 返回值 [#返回值-25]

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

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

- [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine)

<a id="api_irtcengineex_setsubscribevideoallowlistex"></a>

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

## setSubscribeVideoAllowlistEx [#setsubscribevideoallowlistex]

设置视频订阅白名单。

<a id="api_irtcengineex_setsubscribevideoallowlistex__prototype"></a>

```ts
abstract setSubscribeVideoAllowlistEx(
    uidList: number[],
    uidNumber: number,
    connection: RtcConnection
  ): number;
```

<a id="api_irtcengineex_setsubscribevideoallowlistex__detailed_desc"></a>

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

:::note
注：

- 该方法在加入频道前后均可调用。
- 视频订阅白名单不受 [muteRemoteVideoStream](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_muteremotevideostream)、[muteAllRemoteVideoStreams](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_muteallremotevideostreams) 以及 [ChannelMediaOptions](/zh-CN/api-reference/rtc/electron/class-channelmediaoptions) 中的 `autoSubscribeVideo` 的影响。
- 设置订阅白名单后，如果离开当前频道后再重新加入频道，白名单依然生效。
- 如果某个用户同时在音频订阅黑名单和白名单中，仅订阅黑名单生效。
:::

<a id="api_irtcengineex_setsubscribevideoallowlistex__parameters"></a>

### 参数 [#参数-26]

<ParameterList>
<a id="uidlist-5"></a>
<Parameter name="uidList">

视频订阅白名单的用户 ID 列表。
如果你想指定仅订阅某一发流用户的视频流，将该用户的 ID 加入此列表中。如果你想要将某一用户从订阅白名单中移除，需要重新调用 [setSubscribeVideoAllowlist](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_setsubscribevideoallowlist) 方法更新音频订阅白名单的用户 ID 列表，使其不包含你想移除的用户的 `uid`。

</Parameter>
<a id="uidnumber-5"></a>
<Parameter name="uidNumber">

白名单用户 ID 列表中的用户数量。

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

Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/electron/class-rtcconnection)。

</Parameter>
</ParameterList>

<a id="api_irtcengineex_setsubscribevideoallowlistex__return_values"></a>

### 返回值 [#返回值-26]

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

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

- [IRtcEngineEx](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengineex)

<a id="api_irtcengine_setsubscribevideoblocklist"></a>

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

## setSubscribeVideoBlocklist [#setsubscribevideoblocklist]

设置视频订阅黑名单。

<a id="api_irtcengine_setsubscribevideoblocklist__prototype"></a>

```ts
abstract setSubscribeVideoBlocklist(
    uidList: number[],
    uidNumber: number
  ): number;
```

<a id="api_irtcengine_setsubscribevideoblocklist__detailed_desc"></a>

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

:::note
注：

- 该方法在加入频道前后均可调用。
- 黑名单设置实时生效。将已订阅用户加入黑名单后，该用户的视频流也会停止订阅。
- 视频订阅黑名单不受 [muteRemoteVideoStream](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_muteremotevideostream)、[muteAllRemoteVideoStreams](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_muteallremotevideostreams) 以及 [ChannelMediaOptions](/zh-CN/api-reference/rtc/electron/class-channelmediaoptions) 中的 `autoSubscribeVideo` 的影响。
- 设置订阅黑名单后，如果离开当前频道后再重新加入频道，黑名单依然生效。
- 如果某个用户同时在音频订阅黑名单和白名单中，仅订阅黑名单生效。
:::

<a id="api_irtcengine_setsubscribevideoblocklist__parameters"></a>

### 参数 [#参数-27]

<ParameterList>
<a id="uidlist-6"></a>
<Parameter name="uidList">

视频订阅黑名单的用户 ID 列表。
如果你想指定不订阅某一发流用户的视频流，将该用户的 ID 加入此列表中。如果你想要将某一用户从订阅黑名单中移除，需要重新调用 [setSubscribeVideoBlocklist](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_setsubscribevideoblocklist) 方法更新订阅黑名单的用户 ID 列表，使其不包含你想移除的用户的 `uid`。

</Parameter>
<a id="uidnumber-6"></a>
<Parameter name="uidNumber">

黑名单用户 ID 列表中的用户数量。

</Parameter>
</ParameterList>

<a id="api_irtcengine_setsubscribevideoblocklist__return_values"></a>

### 返回值 [#返回值-27]

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

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

- [IRtcEngine](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengine)

<a id="api_irtcengineex_setsubscribevideoblocklistex"></a>

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

## setSubscribeVideoBlocklistEx [#setsubscribevideoblocklistex]

设置视频订阅黑名单。

<a id="api_irtcengineex_setsubscribevideoblocklistex__prototype"></a>

```ts
abstract setSubscribeVideoBlocklistEx(
    uidList: number[],
    uidNumber: number,
    connection: RtcConnection
  ): number;
```

<a id="api_irtcengineex_setsubscribevideoblocklistex__detailed_desc"></a>

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

:::note
注：

- 该方法在加入频道前后均可调用。
- 黑名单设置实时生效。将已订阅用户加入黑名单后，该用户的视频流也会停止订阅。
- 视频订阅黑名单不受 [muteRemoteVideoStream](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_muteremotevideostream)、[muteAllRemoteVideoStreams](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_muteallremotevideostreams) 以及 [ChannelMediaOptions](/zh-CN/api-reference/rtc/electron/class-channelmediaoptions) 中的 `autoSubscribeVideo` 的影响。
- 设置订阅黑名单后，如果离开当前频道后再重新加入频道，黑名单依然生效。
- 如果某个用户同时在音频订阅黑名单和白名单中，仅订阅黑名单生效。
:::

<a id="api_irtcengineex_setsubscribevideoblocklistex__parameters"></a>

### 参数 [#参数-28]

<ParameterList>
<a id="uidlist-7"></a>
<Parameter name="uidList">

视频订阅黑名单的用户 ID 列表。
如果你想指定不订阅某一发流用户的视频流，将该用户的 ID 加入此列表中。如果你想要将某一用户从订阅黑名单中移除，需要重新调用 [setSubscribeVideoBlocklist](/zh-CN/api-reference/rtc/electron/publishnsubscribe#api_irtcengine_setsubscribevideoblocklist) 方法更新订阅黑名单的用户 ID 列表，使其不包含你想移除的用户的 `uid`。

</Parameter>
<a id="uidnumber-7"></a>
<Parameter name="uidNumber">

黑名单用户 ID 列表中的用户数量。

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

Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/electron/class-rtcconnection)。

</Parameter>
</ParameterList>

<a id="api_irtcengineex_setsubscribevideoblocklistex__return_values"></a>

### 返回值 [#返回值-28]

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

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

- [IRtcEngineEx](/zh-CN/api-reference/rtc/electron/rtc-interface-class#class_irtcengineex)

<a id="callback_irtcengineeventhandler_onaudiopublishstatechanged"></a>

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

## onAudioPublishStateChanged [#onaudiopublishstatechanged]

音频发布状态改变回调。

<a id="callback_irtcengineeventhandler_onaudiopublishstatechanged__prototype"></a>

```ts
onAudioPublishStateChanged?(
    channel: string,
    oldState: StreamPublishState,
    newState: StreamPublishState,
    elapseSinceLastState: number
  ): void;
```

<a id="callback_irtcengineeventhandler_onaudiopublishstatechanged__detailed_desc"></a>

<a id="callback_irtcengineeventhandler_onaudiopublishstatechanged__parameters"></a>

### 参数 [#参数-29]

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

频道名。

</Parameter>
<a id="oldstate"></a>
<Parameter name="oldState">

之前的发布状态，详见 [StreamPublishState](/zh-CN/api-reference/rtc/electron/enum-streampublishstate)。

</Parameter>
<a id="newstate"></a>
<Parameter name="newState">

当前的发布状态，详见 [StreamPublishState](/zh-CN/api-reference/rtc/electron/enum-streampublishstate)。

</Parameter>
<a id="elapsesincelaststate"></a>
<Parameter name="elapseSinceLastState">

两次状态变化时间间隔（毫秒）。

</Parameter>
</ParameterList>

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

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

<a id="callback_irtcengineeventhandler_onaudiosubscribestatechanged"></a>

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

## onAudioSubscribeStateChanged [#onaudiosubscribestatechanged]

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

<a id="callback_irtcengineeventhandler_onaudiosubscribestatechanged__prototype"></a>

```ts
onAudioSubscribeStateChanged?(
    channel: string,
    uid: number,
    oldState: StreamSubscribeState,
    newState: StreamSubscribeState,
    elapseSinceLastState: number
  ): void;
```

<a id="callback_irtcengineeventhandler_onaudiosubscribestatechanged__detailed_desc"></a>

<a id="callback_irtcengineeventhandler_onaudiosubscribestatechanged__parameters"></a>

### 参数 [#参数-30]

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

频道名。

</Parameter>
<a id="uid-8"></a>
<Parameter name="uid">

远端用户的 ID。

</Parameter>
<a id="oldstate-1"></a>
<Parameter name="oldState">

之前的订阅状态，详见 [StreamSubscribeState](/zh-CN/api-reference/rtc/electron/enum-streamsubscribestate)。

</Parameter>
<a id="newstate-1"></a>
<Parameter name="newState">

当前的订阅状态，详见 [StreamSubscribeState](/zh-CN/api-reference/rtc/electron/enum-streamsubscribestate)。

</Parameter>
<a id="elapsesincelaststate-1"></a>
<Parameter name="elapseSinceLastState">

两次状态变化时间间隔（毫秒）。

</Parameter>
</ParameterList>

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

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

<a id="callback_irtcengineeventhandler_onvideosubscribestatechanged"></a>

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

## onVideoSubscribeStateChanged [#onvideosubscribestatechanged]

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

<a id="callback_irtcengineeventhandler_onvideosubscribestatechanged__prototype"></a>

```ts
onVideoSubscribeStateChanged?(
    channel: string,
    uid: number,
    oldState: StreamSubscribeState,
    newState: StreamSubscribeState,
    elapseSinceLastState: number
  ): void;
```

<a id="callback_irtcengineeventhandler_onvideosubscribestatechanged__detailed_desc"></a>

<a id="callback_irtcengineeventhandler_onvideosubscribestatechanged__parameters"></a>

### 参数 [#参数-31]

<ParameterList>
<a id="channel-2"></a>
<Parameter name="channel">

频道名。

</Parameter>
<a id="uid-9"></a>
<Parameter name="uid">

远端用户的 ID。

</Parameter>
<a id="oldstate-2"></a>
<Parameter name="oldState">

之前的订阅状态，详见 [StreamSubscribeState](/zh-CN/api-reference/rtc/electron/enum-streamsubscribestate)。

</Parameter>
<a id="newstate-2"></a>
<Parameter name="newState">

当前的订阅状态，详见 [StreamSubscribeState](/zh-CN/api-reference/rtc/electron/enum-streamsubscribestate)。

</Parameter>
<a id="elapsesincelaststate-2"></a>
<Parameter name="elapseSinceLastState">

两次状态变化时间间隔（毫秒）。

</Parameter>
</ParameterList>

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

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