音频路由

  • Unreal Blueprint

更新时间不可用

IsSpeakerphoneEnabled

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

C++
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
	bool IsSpeakerphoneEnabled();

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

调用时机

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

调用限制

无。

返回值

  • true: 扬声器已开启,语音会输出到扬声器。
  • false: 扬声器未开启,语音会输出到非扬声器(听筒,耳机等)。

所属接口类

SetDefaultAudioRouteToSpeakerphone

设置默认的音频路由。

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

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

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

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

  • 语音通话:听筒
  • 语音直播:扬声器
  • 视频通话:扬声器
  • 视频直播:扬声器

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

调用时机

该方法需要在加入频道前调用。如需在加入频道后切换音频路由,请调用 SetEnableSpeakerphone。

调用限制

无。

相关回调

成功改变音频路由后,SDK 会触发 OnAudioRoutingChanged 回调,报告当前的音频路由。

参数

参数名描述
defaultToSpeaker

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

  • true: 设置默认音频路由为扬声器。
  • false: 设置默认音频路由为听筒。
表格内容超出当前宽度,可横向滚动查看更多列。

返回值

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

所属接口类

SetEnableSpeakerphone

开启或关闭扬声器播放。

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

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

适用场景

如果 SDK 默认的音频路由或 SetDefaultAudioRouteToSpeakerphone 的设置无法满足你的需求,你可以调用该方法切换当前的音频路由。

调用时机

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

调用限制

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

相关回调

成功改变音频路由后,SDK 会触发 OnAudioRoutingChanged 回调,报告当前的音频路由。

参数

参数名描述
speakerOn

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

  • true: 开启。音频路由为扬声器。
  • false: 关闭。音频路由为听筒。
表格内容超出当前宽度,可横向滚动查看更多列。

返回值

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

所属接口类

SetRouteInCommunicationMode

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

C++
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
	int SetRouteInCommunicationMode(int route);

该方法用于在通话音量模式(MODE_IN_COMMUNICATION)下,将音频路由从蓝牙耳机切换为听筒、有线耳机或扬声器。

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

调用时机

加入频道前后均可调用。

调用限制

该方法与 SetEnableSpeakerphone 同时使用时可能引起冲突。声网建议你单独使用 SetRouteInCommunicationMode。

相关回调

成功调用该方法后,SDK 会触发 OnAudioRoutingChanged 回调,报告当前的音频路由。

参数

参数名描述
route

期望使用的音频路由:

  • -1:系统默认的音频路由。
  • 0:带麦克风的耳机。
  • 1:听筒。
  • 2:不带麦克风的耳机。
  • 3:设备自带的扬声器。
  • 4:(暂不支持)外接的扬声器。
  • 5:蓝牙耳机。
  • 6:USB 设备。
表格内容超出当前宽度,可横向滚动查看更多列。

返回值

无实际意义。

OnAudioRoutingChanged

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

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

详情

注:

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

参数

参数名描述
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 协议的蓝牙耳机或蓝牙音箱。
表格内容超出当前宽度,可横向滚动查看更多列。

所属接口类