# 音频路由 (/zh-CN/api-reference/rtc/unreal-blueprint/device-management/audio-route)

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

<a id="toc_audio_route"></a>

<a id="api_irtcengine_isspeakerphoneenabled"></a>

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

## IsSpeakerphoneEnabled [#isspeakerphoneenabled]

检查扬声器状态启用状态。

<a id="api_irtcengine_isspeakerphoneenabled__prototype"></a>

```cpp
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
	bool IsSpeakerphoneEnabled();
```

<a id="api_irtcengine_isspeakerphoneenabled__detailed_desc"></a>

:::caution
注意： 该方法仅适用于 Android 和 iOS。
:::

<a id="api_irtcengine_isspeakerphoneenabled__timing"></a>

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

该方法在加入频道前后都能调用。

<a id="api_irtcengine_isspeakerphoneenabled__restriction"></a>

### 调用限制 [#调用限制]

无。

<a id="api_irtcengine_isspeakerphoneenabled__return_values"></a>

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

- `true`: 扬声器已开启，语音会输出到扬声器。
- `false`: 扬声器未开启，语音会输出到非扬声器（听筒，耳机等）。

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

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

<a id="api_irtcengine_setdefaultaudioroutetospeakerphone"></a>

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

## SetDefaultAudioRouteToSpeakerphone [#setdefaultaudioroutetospeakerphone]

设置默认的音频路由。

<a id="api_irtcengine_setdefaultaudioroutetospeakerphone__prototype"></a>

```cpp
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
	int SetDefaultAudioRouteToSpeakerphone(bool defaultToSpeaker);
```

<a id="api_irtcengine_setdefaultaudioroutetospeakerphone__detailed_desc"></a>

:::caution
注意： 该方法仅适用于 Android 和 iOS 平台。
:::

手机设备一般有两个音频路由，一个是位于顶部的听筒，播放声音偏小；一个是位于底部的扬声器，播放声音偏大。设置默认的音频路由，就是在没有外接设备的前提下，设置系统使用听筒还是扬声器播放音频。

不同场景下，系统默认的音频路由也不同。具体如下：

<a id="api_irtcengine_setdefaultaudioroutetospeakerphone__ul_kq3_tpf_3qb"></a>

- 语音通话：听筒
- 语音直播：扬声器
- 视频通话：扬声器
- 视频直播：扬声器

调用该 API 可以改变上述默认音频路由。

<a id="api_irtcengine_setdefaultaudioroutetospeakerphone__timing"></a>

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

该方法需要在加入频道前调用。如需在加入频道后切换音频路由，请调用 [SetEnableSpeakerphone](/zh-CN/api-reference/rtc/unreal-blueprint/device-management/audio-route#api_irtcengine_setenablespeakerphone)。

<a id="api_irtcengine_setdefaultaudioroutetospeakerphone__restriction"></a>

### 调用限制 [#调用限制-1]

无。

<a id="api_irtcengine_setdefaultaudioroutetospeakerphone__related"></a>

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

成功改变音频路由后，SDK 会触发 [OnAudioRoutingChanged](/zh-CN/api-reference/rtc/unreal-blueprint/device-management/audio-route#callback_irtcengineeventhandler_onaudioroutingchanged) 回调，报告当前的音频路由。

<a id="api_irtcengine_setdefaultaudioroutetospeakerphone__parameters"></a>

### 参数 [#参数]

<ParameterList>
<a id="defaulttospeaker"></a>
<Parameter name="defaultToSpeaker">

是否使用扬声器作为默认的音频路由：

- `true`: 设置默认音频路由为扬声器。
- `false`: 设置默认音频路由为听筒。

</Parameter>
</ParameterList>

<a id="api_irtcengine_setdefaultaudioroutetospeakerphone__return_values"></a>

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

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

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

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

<a id="api_irtcengine_setenablespeakerphone"></a>

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

## SetEnableSpeakerphone [#setenablespeakerphone]

开启或关闭扬声器播放。

<a id="api_irtcengine_setenablespeakerphone__prototype"></a>

```cpp
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
	int SetEnableSpeakerphone(bool speakerOn);
```

<a id="api_irtcengine_setenablespeakerphone__detailed_desc"></a>

:::caution
注意： 该方法仅适用于 Android 和 iOS 平台。
:::

<a id="api_irtcengine_setenablespeakerphone__scenario"></a>

### 适用场景 [#适用场景]

如果 SDK 默认的音频路由或 [SetDefaultAudioRouteToSpeakerphone](/zh-CN/api-reference/rtc/unreal-blueprint/device-management/audio-route#api_irtcengine_setdefaultaudioroutetospeakerphone) 的设置无法满足你的需求，你可以调用该方法切换当前的音频路由。

<a id="api_irtcengine_setenablespeakerphone__timing"></a>

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

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

<a id="api_irtcengine_setenablespeakerphone__restriction"></a>

### 调用限制 [#调用限制-2]

- 该方法只设置用户在当前频道内使用的音频路由，不会影响 SDK 默认的音频路由。如果用户离开当前频道并加入新的频道，则用户还是会使用 SDK 默认的音频路由。
- 如果用户使用了蓝牙耳机、有线耳机等外接音频播放设备，则该方法的设置无效，音频只会通过外接设备播放。当有多个外接设备时，音频会通过最后一个接入的设备播放。

<a id="api_irtcengine_setenablespeakerphone__related"></a>

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

成功改变音频路由后，SDK 会触发 [OnAudioRoutingChanged](/zh-CN/api-reference/rtc/unreal-blueprint/device-management/audio-route#callback_irtcengineeventhandler_onaudioroutingchanged) 回调，报告当前的音频路由。

<a id="api_irtcengine_setenablespeakerphone__parameters"></a>

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

<ParameterList>
<a id="speakeron"></a>
<Parameter name="speakerOn">

设置是否开启扬声器播放：

- `true`: 开启。音频路由为扬声器。
- `false`: 关闭。音频路由为听筒。

</Parameter>
</ParameterList>

<a id="api_irtcengine_setenablespeakerphone__return_values"></a>

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

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

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

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

<a id="api_irtcengine_setrouteincommunicationmode"></a>

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

## SetRouteInCommunicationMode [#setrouteincommunicationmode]

选择通话音量模式下的音频路由。

<a id="api_irtcengine_setrouteincommunicationmode__prototype"></a>

```cpp
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
	int SetRouteInCommunicationMode(int route);
```

<a id="api_irtcengine_setrouteincommunicationmode__detailed_desc"></a>

该方法用于在通话音量模式（[MODE_IN_COMMUNICATION](https://developer.android.google.cn/reference/kotlin/android/media/AudioManager?hl=en#mode_in_communication)）下，将音频路由从蓝牙耳机切换为听筒、有线耳机或扬声器。

:::caution
注意： 该方法仅适用于 Android。
:::

<a id="api_irtcengine_setrouteincommunicationmode__timing"></a>

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

加入频道前后均可调用。

<a id="api_irtcengine_setrouteincommunicationmode__restriction"></a>

### 调用限制 [#调用限制-3]

该方法与 [SetEnableSpeakerphone](/zh-CN/api-reference/rtc/unreal-blueprint/device-management/audio-route#api_irtcengine_setenablespeakerphone) 同时使用时可能引起冲突。声网建议你单独使用 [SetRouteInCommunicationMode](/zh-CN/api-reference/rtc/unreal-blueprint/device-management/audio-route#api_irtcengine_setrouteincommunicationmode)。

<a id="api_irtcengine_setrouteincommunicationmode__related"></a>

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

成功调用该方法后，SDK 会触发 [OnAudioRoutingChanged](/zh-CN/api-reference/rtc/unreal-blueprint/device-management/audio-route#callback_irtcengineeventhandler_onaudioroutingchanged) 回调，报告当前的音频路由。

<a id="api_irtcengine_setrouteincommunicationmode__parameters"></a>

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

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

期望使用的音频路由:

- -1：系统默认的音频路由。
- 0：带麦克风的耳机。
- 1：听筒。
- 2：不带麦克风的耳机。
- 3：设备自带的扬声器。
- 4：（暂不支持）外接的扬声器。
- 5：蓝牙耳机。
- 6：USB 设备。

</Parameter>
</ParameterList>

<a id="api_irtcengine_setrouteincommunicationmode__return_values"></a>

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

无实际意义。

<a id="callback_irtcengineeventhandler_onaudioroutingchanged"></a>

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

## OnAudioRoutingChanged [#onaudioroutingchanged]

音频路由已发生变化回调。

<a id="callback_irtcengineeventhandler_onaudioroutingchanged__prototype"></a>

```cpp
UFUNCTION(BlueprintNativeEvent, Category = "Agora|Event")
	void OnAudioRoutingChanged(int routing);
```

<a id="callback_irtcengineeventhandler_onaudioroutingchanged__detailed_desc"></a>

### 详情 [#详情]

:::note
注：

该回调仅适用于 Android、iOS 和 macOS 平台。
:::

<a id="callback_irtcengineeventhandler_onaudioroutingchanged__parameters"></a>

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

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

当前的音频路由：

- ROUTE_DEFAULT (-1)：使用默认的音频路由。
- ROUTE_HEADSET (0)：音频路由为带麦克风的耳机。
- ROUTE_EARPIECE (1)：音频路由为听筒。
- ROUTE_HEADSETNOMIC (2)：音频路由为不带麦克风的耳机。
- ROUTE_SPEAKERPHONE (3)：音频路由为设备自带的扬声器。
- ROUTE_LOUDSPEAKER (4)：（暂不支持）音频路由为外接的扬声器。
- ROUTE_BLUETOOTH_DEVICE_HFP (5)：音频路由为使用 HFP 协议的蓝牙耳机。
- ROUTE_BLUETOOTH_DEVICE_A2DP (10)：音频路由为使用 A2DP 协议的蓝牙耳机或蓝牙音箱。

</Parameter>
</ParameterList>

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

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