harmony 鸿蒙native_audio_routing_manager.h

2025-06-12
浏览 (6)

native_audio_routing_manager.h

概述

声明与音频路由管理器相关的接口。

包含用于创建audioRoutingManager，设备连接状态发生变化时的注册和注销功能，以及存储设备信息的指针数组的释放。

库： libohaudio.so

引用文件：

系统能力： SystemCapability.Multimedia.Audio.Core

起始版本： 12

相关模块： OHAudio

汇总

结构体

|名称|typedef关键字|描述| |–|–|–| |OH_AudioRoutingManager|OH_AudioRoutingManager|声明音频路由管理器，用于路由和设备相关功能的音频路由管理器的句柄。|

函数

函数说明

OH_AudioRoutingManager_OnDeviceChangedCallback()

typedef int32_t (*OH_AudioRoutingManager_OnDeviceChangedCallback)(OH_AudioDevice_ChangeType type,OH_AudioDeviceDescriptorArray *audioDeviceDescriptorArray
)

描述

此函数指针将指向用于返回更改的音频设备描述符的回调函数，可能返回多个音频设备描述符。

起始版本： 12

参数：

|参数项|描述| |–|–| |OH_AudioDevice_ChangeType type |设备连接状态类型。 OH_AudioDevice_ChangeType已连接或断开。 | |OH_AudioDeviceDescriptorArray *audioDeviceDescriptorArray|音频设备描述符数组，指向OH_AudioDeviceDescriptorArray设置音频设备描述符值的指针变量，不要单独释放audioDeviceDescriptorArray指针，而是调用OH_AudioRoutingManager_ReleaseDevices来释放DeviceDescriptor数组。|

OH_AudioManager_GetAudioRoutingManager()

OH_AudioCommon_Result OH_AudioManager_GetAudioRoutingManager(OH_AudioRoutingManager **audioRoutingManager)

描述

查询音频路由管理器句柄，该句柄应设置为路由相关函数中的第一个参数。

起始版本： 12

参数：

|参数项|描述| |–|–| |OH_AudioRoutingManager **audioRoutingManager|音频路由管理器句柄。通过OH_AudioManager_GetAudioRoutingManager获取句柄。|

返回：

|类型|说明 | |–|——————————————————–| |OH_AudioCommon_Result|AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。|

OH_AudioRoutingManager_GetDevices()

OH_AudioCommon_Result OH_AudioRoutingManager_GetDevices(OH_AudioRoutingManager *audioRoutingManager,OH_AudioDevice_Flag deviceFlag,OH_AudioDeviceDescriptorArray **audioDeviceDescriptorArray)

描述

根据输入的deviceFlag查询可用的设备。

起始版本： 12

参数：

返回：

|类型|说明| |–|–| |OH_AudioCommon_Result|AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。
AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：
1. 参数audioRoutingManager为nullptr；
2. 参数deviceFlag无效；
3. 参数audioDeviceDescriptorArray为nullptr。
AUDIOCOMMON_RESULT_ERROR_NO_MEMORY：内存不足。|

OH_AudioRoutingManager_GetAvailableDevices()

OH_AudioCommon_Result OH_AudioRoutingManager_GetAvailableDevices(OH_AudioRoutingManager *audioRoutingManager,OH_AudioDevice_Usage deviceUsage, OH_AudioDeviceDescriptorArray **audioDeviceDescriptorArray)

描述

获取音频可选设备列表。

起始版本： 12

参数：

返回：

|类型|说明| |–|–| |OH_AudioCommon_Result| AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。
AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：
1.参数audioRoutingManager为nullptr；
2.参数deviceUsage无效;
3.参数audioDeviceDescriptorArray为nullptr。
AUDIOCOMMON_RESULT_ERROR_NO_MEMORY：内存不足。|

OH_AudioRoutingManager_GetPreferredOutputDevice()

OH_AudioCommon_Result OH_AudioRoutingManager_GetPreferredOutputDevice(OH_AudioRoutingManager *audioRoutingManager,OH_AudioStream_Usage streamUsage, OH_AudioDeviceDescriptorArray **audioDeviceDescriptorArray)

描述

根据音频输出流的使用场景，获取优先级最高的输出设备。

起始版本： 12

参数：

返回：

|类型|说明| |–|–| |OH_AudioCommon_Result| AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。
AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：
1.参数audioRoutingManager为nullptr;
2.参数streamUsage无效;
3.参数audioDeviceDescriptorArray为nullptr。
AUDIOCOMMON_RESULT_ERROR_NO_MEMORY：内存不足。|

OH_AudioRoutingManager_GetPreferredInputDevice()

OH_AudioCommon_Result OH_AudioRoutingManager_GetPreferredInputDevice(OH_AudioRoutingManager *audioRoutingManager,OH_AudioStream_SourceType sourceType, OH_AudioDeviceDescriptorArray **audioDeviceDescriptorArray)

描述

根据音频输入流的使用场景，获取优先级最高的输入设备。

起始版本： 12

参数：

返回：

|类型|说明| |–|–| |OH_AudioCommon_Result| AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。
AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：
1.参数audioRoutingManager为nullptr;
2.参数sourceType无效;
3.参数audioDeviceDescriptorArray为nullptr。
AUDIOCOMMON_RESULT_ERROR_NO_MEMORY：内存不足。|

OH_AudioRoutingManager_RegisterDeviceChangeCallback()

OH_AudioCommon_Result OH_AudioRoutingManager_RegisterDeviceChangeCallback(OH_AudioRoutingManager *audioRoutingManager, OH_AudioDevice_Flag deviceFlag,OH_AudioRoutingManager_OnDeviceChangedCallback callback)

描述

注册音频路由管理器的设备更改回调。

起始版本： 12

参数：

返回：

|类型|说明| |–|–| |OH_AudioCommon_Result| AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。
AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：
1. 参数audioRoutingManager为nullptr；
2. 参数deviceFlag无效；
3. 参数callback为nullptr。|

OH_AudioRoutingManager_UnregisterDeviceChangeCallback()

OH_AudioCommon_Result OH_AudioRoutingManager_UnregisterDeviceChangeCallback(OH_AudioRoutingManager *audioRoutingManager,OH_AudioRoutingManager_OnDeviceChangedCallback callback)

描述

取消注册音频路由管理器的设备更改回调。

起始版本： 12

参数：

|参数项|描述| |–|–| |OH_AudioRoutingManager *audioRoutingManager|音频路由管理器句柄。通过OH_AudioManager_GetAudioRoutingManager获取句柄。| |OH_AudioRoutingManager_OnDeviceChangedCallback callback|函数指针将指向用于返回更改的音频设备描述符的回调函数。|

返回：

|类型|说明| |–|–| |OH_AudioCommon_Result| AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。
AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：
1. 参数audioRoutingManager为nullptr；
2. 参数callback为nullptr。|

OH_AudioRoutingManager_ReleaseDevices()

OH_AudioCommon_Result OH_AudioRoutingManager_ReleaseDevices(OH_AudioRoutingManager *audioRoutingManager,OH_AudioDeviceDescriptorArray *audioDeviceDescriptorArray)

描述

释放音频设备描述符数组对象。

起始版本： 12

参数：

|参数项|描述| |–|–| |OH_AudioRoutingManager *audioRoutingManager|音频路由管理器句柄。通过OH_AudioManager_GetAudioRoutingManager获取句柄。| |OH_AudioDeviceDescriptorArray *audioDeviceDescriptorArray|音频设备描述符数组应当被释放，获取请调用OH_AudioRoutingManager_GetDevices接口。|

返回：

|类型|说明| |–|–| |OH_AudioCommon_Result| AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。
AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：
1. 参数audioRoutingManager为nullptr；
2. 参数audioDeviceDescriptorArray为nullptr。|

OH_AudioRoutingManager_OnDeviceBlockStatusCallback()

typedef void (*OH_AudioRoutingManager_OnDeviceBlockStatusCallback)(OH_AudioDeviceDescriptorArray *audioDeviceDescriptorArray,OH_AudioDevice_BlockStatus status,void *userData)

描述

此函数指针将指向用于返回音频设备堵塞状态的回调函数，可能返回多个音频设备描述符。

起始版本： 13

参数：

OH_AudioRoutingManager_IsMicBlockDetectionSupported()

OH_AudioCommon_Result OH_AudioRoutingManager_IsMicBlockDetectionSupported(OH_AudioRoutingManager *audioRoutingManager,bool *supported)

描述

查询当前设备是否支持麦克风堵塞状态检测。

起始版本： 13

参数：

|参数项|描述| |–|–| |OH_AudioRoutingManager *audioRoutingManager|音频路由管理器句柄。通过OH_AudioManager_GetAudioRoutingManager获取句柄。| |bool *supported|查询结果。|

返回：

|类型|说明| |–|–| |OH_AudioCommon_Result| AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。
AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：
1.参数audioRoutingManager为nullptr；
2.参数supported为nullptr。|

OH_AudioRoutingManager_SetMicBlockStatusCallback()

OH_AudioCommon_Result OH_AudioRoutingManager_SetMicBlockStatusCallback(OH_AudioRoutingManager *audioRoutingManager,OH_AudioRoutingManager_OnDeviceBlockStatusCallback callback,void *userData)

描述

设置麦克风是否堵塞状态回调。

在使用此功能之前，用户应查询当前设备是否支持检测，应用只有在使用麦克风录音时，并且所使用的麦克风的堵塞状态发生改变，才会收到回调，目前此检测功能仅支持麦克风位于本地设备上。

起始版本： 13

参数：

返回：

|类型|说明| |–|–| |OH_AudioCommon_Result| AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。
AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：
1.参数audioRoutingManager为nullptr；
2.参数callback为nullptr。|