openharmony 鸿蒙 capi-native-audio-routing-manager-h

2025-06-12 浏览 (1)

native_audio_routing_manager.h

概述

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

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

库： libohaudio.so

引用文件： <ohaudio/native_audio_routing_manager.h>

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

起始版本： 12

相关模块： OHAudio

汇总

结构体

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

函数

名称typedef关键字描述
typedef int32_t (*OH_AudioRoutingManager_OnDeviceChangedCallback)(OH_AudioDevice_ChangeType type,OH_AudioDeviceDescriptorArray *audioDeviceDescriptorArray)OH_AudioRoutingManager_OnDeviceChangedCallback此函数指针将指向用于返回更改的音频设备描述符的回调函数，可能返回多个音频设备描述符。
OH_AudioCommon_Result OH_AudioManager_GetAudioRoutingManager(OH_AudioRoutingManager **audioRoutingManager)-查询音频路由管理器句柄，该句柄应设置为路由相关函数中的第一个参数。
OH_AudioCommon_Result OH_AudioRoutingManager_GetDevices(OH_AudioRoutingManager *audioRoutingManager,OH_AudioDevice_Flag deviceFlag,OH_AudioDeviceDescriptorArray **audioDeviceDescriptorArray)-根据输入的deviceFlag查询可用的设备。
OH_AudioCommon_Result OH_AudioRoutingManager_GetAvailableDevices(OH_AudioRoutingManager *audioRoutingManager,OH_AudioDevice_Usage deviceUsage, OH_AudioDeviceDescriptorArray **audioDeviceDescriptorArray)-获取音频可选设备列表。
OH_AudioCommon_Result OH_AudioRoutingManager_GetPreferredOutputDevice(OH_AudioRoutingManager *audioRoutingManager,OH_AudioStream_Usage streamUsage, OH_AudioDeviceDescriptorArray **audioDeviceDescriptorArray)-根据音频输出流的使用场景，获取优先级最高的输出设备。
OH_AudioCommon_Result OH_AudioRoutingManager_GetPreferredInputDevice(OH_AudioRoutingManager *audioRoutingManager,OH_AudioStream_SourceType sourceType, OH_AudioDeviceDescriptorArray **audioDeviceDescriptorArray)-根据音频输入流的使用场景，获取优先级最高的输入设备。
OH_AudioCommon_Result OH_AudioRoutingManager_RegisterDeviceChangeCallback(OH_AudioRoutingManager *audioRoutingManager, OH_AudioDevice_Flag deviceFlag,OH_AudioRoutingManager_OnDeviceChangedCallback callback)-注册音频路由管理器的设备更改回调。
OH_AudioCommon_Result OH_AudioRoutingManager_UnregisterDeviceChangeCallback(OH_AudioRoutingManager *audioRoutingManager,OH_AudioRoutingManager_OnDeviceChangedCallback callback)-取消注册音频路由管理器的设备更改回调。
OH_AudioCommon_Result OH_AudioRoutingManager_ReleaseDevices(OH_AudioRoutingManager *audioRoutingManager,OH_AudioDeviceDescriptorArray *audioDeviceDescriptorArray)-释放音频设备描述符数组对象。
typedef void (*OH_AudioRoutingManager_OnDeviceBlockStatusCallback)(OH_AudioDeviceDescriptorArray *audioDeviceDescriptorArray,OH_AudioDevice_BlockStatus status,void *userData)OH_AudioRoutingManager_OnDeviceBlockStatusCallback此函数指针将指向用于返回音频设备堵塞状态的回调函数，可能返回多个音频设备描述符。
OH_AudioCommon_Result OH_AudioRoutingManager_IsMicBlockDetectionSupported(OH_AudioRoutingManager *audioRoutingManager,bool *supported)-查询当前设备是否支持麦克风堵塞状态检测。
OH_AudioCommon_Result OH_AudioRoutingManager_SetMicBlockStatusCallback(OH_AudioRoutingManager *audioRoutingManager,OH_AudioRoutingManager_OnDeviceBlockStatusCallback callback,void *userData)-设置麦克风是否堵塞状态回调。
在使用此功能之前，用户应查询当前设备是否支持检测，应用只有在使用麦克风录音时，并且所使用的麦克风的堵塞状态发生改变，才会收到回调，目前此检测功能仅支持麦克风位于本地设备上。

函数说明

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_ResultAUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

OH_AudioRoutingManager_GetDevices()

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

描述

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

起始版本： 12

参数：

参数项描述
OH_AudioRoutingManager *audioRoutingManager音频路由管理器句柄。通过OH_AudioManager_GetAudioRoutingManager获取句柄。
OH_AudioDevice_Flag deviceFlag音频设备标志，用于选择目标设备的滤波器参数。
OH_AudioDeviceDescriptorArray **audioDeviceDescriptorArray音频设备描述符数组。设置音频设备描述符值的指针变量，不要单独释放audioDeviceDescriptorArray指针，而是调用OH_AudioRoutingManager_ReleaseDevices来释放DeviceDescriptor数组。

返回：

类型说明
OH_AudioCommon_ResultAUDIOCOMMON_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_AudioRoutingManager *audioRoutingManager音频路由管理器句柄。通过OH_AudioManager_GetAudioRoutingManager获取句柄。
OH_AudioDevice_Usage deviceUsage指向OH_AudioDevice_Usage用于设置要获取的设备种类。
OH_AudioDeviceDescriptorArray **audioDeviceDescriptorArray音频设备描述符数组。设置音频设备描述符值的指针变量，不要单独释放audioDeviceDescriptorArray指针，而是调用OH_AudioRoutingManager_ReleaseDevices来释放DeviceDescriptor数组。

返回：

类型说明
OH_AudioCommon_ResultAUDIOCOMMON_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_AudioRoutingManager *audioRoutingManager指向OH_AudioManager_GetAudioRoutingManager创建的音频路由管理器实例：OH_AudioRoutingManager。
OH_AudioStream_Usage streamUsage指向OH_AudioStream_Usage用于设置音频输出流的使用场景。
OH_AudioDeviceDescriptorArray **audioDeviceDescriptorArray音频设备描述符数组。设置音频设备描述符值的指针变量，不要单独释放audioDeviceDescriptorArray指针，而是调用OH_AudioRoutingManager_ReleaseDevices来释放DeviceDescriptor数组。

返回：

类型说明
OH_AudioCommon_ResultAUDIOCOMMON_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_AudioRoutingManager *audioRoutingManager指向OH_AudioManager_GetAudioRoutingManager创建的音频路由管理器实例：OH_AudioRoutingManager。
OH_AudioStream_SourceType sourceType指向OH_AudioStream_SourceType用于设置音频输入流的使用场景。
OH_AudioDeviceDescriptorArray **audioDeviceDescriptorArray音频设备描述符数组。设置音频设备描述符值的指针变量，不要单独释放audioDeviceDescriptorArray指针，而是调用OH_AudioRoutingManager_ReleaseDevices来释放DeviceDescriptor数组。

返回：

类型说明
OH_AudioCommon_ResultAUDIOCOMMON_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_AudioRoutingManager *audioRoutingManager音频路由管理器句柄。通过OH_AudioManager_GetAudioRoutingManager获取句柄。
OH_AudioDevice_Flag deviceFlag音频设备标志，用来注册回调。
OH_AudioRoutingManager_OnDeviceChangedCallback callback函数指针将指向用于返回更改的音频设备描述符的回调函数。

返回：

类型说明
OH_AudioCommon_ResultAUDIOCOMMON_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_ResultAUDIOCOMMON_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_ResultAUDIOCOMMON_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_AudioDeviceDescriptorArray *audioDeviceDescriptorArray音频设备描述符数组应当被释放，获取请调用OH_AudioRoutingManager_GetDevices接口。设置音频设备描述符值的指针变量，不要单独释放audioDeviceDescriptorArray指针，而是调用OH_AudioRoutingManager_ReleaseDevices来释放DeviceDescriptor数组。
OH_AudioDevice_BlockStatus status音频设备的堵塞状态。
void *userData用户自定义数据指针。

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_ResultAUDIOCOMMON_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_AudioRoutingManager *audioRoutingManager音频路由管理器句柄。通过OH_AudioManager_GetAudioRoutingManager获取句柄。
OH_AudioRoutingManager_OnDeviceBlockStatusCallback callback函数指针将指向用于返回接受设备麦克风堵塞状态OH_AudioRoutingManager_OnDeviceBlockStatusCallback。
void *userData用户自定义数据指针。

返回：

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

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Audio Kit（音频服务）

harmony 鸿蒙Interface (AudioCapturer)

harmony 鸿蒙Interface (AudioManager)

harmony 鸿蒙Interface (AudioRenderer)

harmony 鸿蒙Interface (AudioRoutingManager)

harmony 鸿蒙Interface (AudioSessionManager)

harmony 鸿蒙Interface (AudioSpatializationManager)

harmony 鸿蒙Interface (AudioStreamManager)

harmony 鸿蒙Interface (AudioVolumeGroupManager)

harmony 鸿蒙Interface (AudioVolumeManager)

  • 所属分类： 后端技术
  • 本文标签： 软件 鸿蒙
  • 版权声明： 本文链接 https://seaxiang.com/blog/iWFQfi