harmony 鸿蒙native_audio_device_base.h

2025-06-12
浏览 (3)

native_audio_device_base.h

概述

定义音频设备参数的类型以及获取每个设备参数的接口。

库： libohaudio.so

引用文件：

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

起始版本： 12

相关模块： OHAudio

汇总

结构体

|名称|typedef关键字|描述| |–|–|–| |OH_AudioDeviceDescriptorArray|OH_AudioDeviceDescriptorArray|声明音频设备描述符数组。| |OH_AudioDeviceDescriptor|OH_AudioDeviceDescriptor|声明音频设备描述符。该实例用于获取更多音频设备详细信息属性。|

枚举

函数

枚举类型说明

OH_AudioDevice_ChangeType

enum OH_AudioDevice_ChangeType

描述

定义音频设备更改类型。

起始版本： 12

|枚举项|描述| |–|–| |AUDIO_DEVICE_CHANGE_TYPE_CONNECT = 0|设备连接。| |AUDIO_DEVICE_CHANGE_TYPE_DISCONNECT = 1|设备断开。|

OH_AudioDevice_Role

enum OH_AudioDevice_Role

描述

定义音频设备角色。

起始版本： 12

|枚举项|描述| |–|–| |AUDIO_DEVICE_ROLE_INPUT = 1|输入设备。| |AUDIO_DEVICE_ROLE_OUTPUT = 2|输出设备。|

OH_AudioDevice_Type

enum OH_AudioDevice_Type

描述

定义音频设备类型。

起始版本： 12

OH_AudioDevice_Flag

enum OH_AudioDevice_Flag

描述

定义音频设备标志。

起始版本： 12

|枚举项|描述| |–|–| |AUDIO_DEVICE_FLAG_NONE = 0|无设备。| |AUDIO_DEVICE_FLAG_OUTPUT = 1|输出设备。| |AUDIO_DEVICE_FLAG_INPUT = 2|输入设备。| |AUDIO_DEVICE_FLAG_ALL = 3|所有设备。|

OH_AudioDevice_Usage

enum OH_AudioDevice_Usage

描述

定义可获取的设备种类。

起始版本： 12

OH_AudioDevice_BlockStatus

enum OH_AudioDevice_BlockStatus

描述

声明音频设备的堵塞状态。默认情况下，音频设备被视为未堵塞。

起始版本： 13

|枚举项|描述| |–|–| |AUDIO_DEVICE_UNBLOCKED = 0|音频设备未被堵塞。| |AUDIO_DEVICE_BLOCKED = 1|音频设备被堵塞。|

函数说明

OH_AudioDeviceDescriptor_GetDeviceRole()

OH_AudioCommon_Result OH_AudioDeviceDescriptor_GetDeviceRole(OH_AudioDeviceDescriptor *audioDeviceDescriptor,OH_AudioDevice_Role *deviceRole)

描述

查询目标音频设备描述符的设备角色。

起始版本： 12

参数：

返回：

|类型|说明| |–|–| |OH_AudioCommon_Result|AUDIOCOMMON_RESULT_SUCCESS或AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM。|

OH_AudioDeviceDescriptor_GetDeviceType()

OH_AudioCommon_Result OH_AudioDeviceDescriptor_GetDeviceType(OH_AudioDeviceDescriptor *audioDeviceDescriptor,OH_AudioDevice_Type *deviceType)

描述

查询目标音频设备描述符的设备类型。

起始版本： 12

参数：

返回：

|类型|说明| |–|–| |OH_AudioCommon_Result|AUDIOCOMMON_RESULT_SUCCESS或AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM。|

OH_AudioDeviceDescriptor_GetDeviceId()

OH_AudioCommon_Result OH_AudioDeviceDescriptor_GetDeviceId(OH_AudioDeviceDescriptor *audioDeviceDescriptor,uint32_t *id)

描述

查询目标音频设备描述符的设备id。

起始版本： 12

参数：

返回：

|类型|说明| |–|–| |OH_AudioCommon_Result|AUDIODEVICE_SUCCESS 或 AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM。|

OH_AudioDeviceDescriptor_GetDeviceName()

OH_AudioCommon_Result OH_AudioDeviceDescriptor_GetDeviceName(OH_AudioDeviceDescriptor *audioDeviceDescriptor,char **name)

描述

查询目标音频设备描述符的设备名称。

起始版本： 12

参数：

|参数项|描述| |–|–| |OH_AudioDeviceDescriptor *audioDeviceDescriptor|音频设备描述符。通过 OH_AudioRoutingManager_GetDevices 或者OH_AudioRoutingManager_OnDeviceChangedCallback获取。| |char **name|设备名称指针，将设置设备名称值的变量。
不要单独释放音频设备名称指针，而是调用OH_AudioRoutingManager_ReleaseDevices，以便在不再使用时释放所有DeviceDescriptor数组。|

返回：

|类型|说明| |–|–| |OH_AudioCommon_Result|AUDIOCOMMON_RESULT_SUCCESS或AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM。|

OH_AudioDeviceDescriptor_GetDeviceAddress()

OH_AudioCommon_Result OH_AudioDeviceDescriptor_GetDeviceAddress(OH_AudioDeviceDescriptor *audioDeviceDescriptor,char **address)

描述

查询目标音频设备描述符的设备地址。

起始版本： 12

参数：

|参数项|描述| |–|–| |OH_AudioDeviceDescriptor *audioDeviceDescriptor|音频设备描述符。通过 OH_AudioRoutingManager_GetDevices 或者OH_AudioRoutingManager_OnDeviceChangedCallback获取。| |char **address|设备MAC地址指针，将设置设备MAC地址值的变量。
不要单独释放音频设备MAC地址指针，而是调用OH_AudioRoutingManager_ReleaseDevices，以便在不再使用时释放所有DeviceDescriptor数组。|

返回：

|类型|说明| |–|–| |OH_AudioCommon_Result|AUDIOCOMMON_RESULT_SUCCESS或AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM。|

OH_AudioDeviceDescriptor_GetDeviceSampleRates()

OH_AudioCommon_Result OH_AudioDeviceDescriptor_GetDeviceSampleRates(OH_AudioDeviceDescriptor *audioDeviceDescriptor,uint32_t **sampleRates, uint32_t *size)

描述

查询目标音频设备描述符的采样率数组。

起始版本： 12

参数：

返回：

|类型|说明| |–|–| |OH_AudioCommon_Result|AUDIOCOMMON_RESULT_SUCCESS或AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM。|

OH_AudioDeviceDescriptor_GetDeviceChannelCounts()

OH_AudioCommon_Result OH_AudioDeviceDescriptor_GetDeviceChannelCounts(OH_AudioDeviceDescriptor *audioDeviceDescriptor,uint32_t **channelCounts, uint32_t *size)

描述

查询目标音频设备描述符的设备通道计数数组。

起始版本： 12

参数：

返回：

|类型|说明| |–|–| |OH_AudioCommon_Result|AUDIOCOMMON_RESULT_SUCCESS或AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM。|

OH_AudioDeviceDescriptor_GetDeviceDisplayName()

OH_AudioCommon_Result OH_AudioDeviceDescriptor_GetDeviceDisplayName(OH_AudioDeviceDescriptor *audioDeviceDescriptor,char **displayName)

描述

查询目标音频设备描述符的显示名称。

起始版本： 12

参数：

|参数项|描述| |–|–| |OH_AudioDeviceDescriptor *audioDeviceDescriptor|音频设备描述符。通过 OH_AudioRoutingManager_GetDevices 或者OH_AudioRoutingManager_OnDeviceChangedCallback获取。| |char **displayName|设置显示名称值的指针变量。
不要单独释放音频设备显示名称指针，而是调用OH_AudioRoutingManager_ReleaseDevices，以便在不再使用时释放所有DeviceDescriptor数组。|

返回：

|类型|说明| |–|–| |OH_AudioCommon_Result|AUDIOCOMMON_RESULT_SUCCESS或AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM。|

OH_AudioDeviceDescriptor_GetDeviceEncodingTypes()

OH_AudioCommon_Result OH_AudioDeviceDescriptor_GetDeviceEncodingTypes(OH_AudioDeviceDescriptor *audioDeviceDescriptor,OH_AudioStream_EncodingType **encodingTypes, uint32_t *size)

描述

查询目标音频设备描述符的编码类型数组。

起始版本： 12

参数：

返回：

|类型|说明| |–|–| |OH_AudioCommon_Result|AUDIOCOMMON_RESULT_SUCCESS或AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM。|