IAudioAdapter

概述

AudioAdapter音频适配器接口。

package ohos.hdi.audio.v1_0;

提供音频适配器（声卡）对外支持的驱动能力，包括初始化端口、创建放音、创建录音、获取端口能力集等。

参见

IAudioRender

IAudioCapture

起始版本： 4.0

相关模块：HdiAudio

汇总

Public 成员函数

成员函数说明

CreateCapture()

IAudioAdapter::CreateCapture ([in] struct AudioDeviceDescriptor desc, [in] struct AudioSampleAttributes attrs, [out] IAudioCapture capture, [out] unsigned int captureId )

描述

创建一个音频录音接口的对象。

起始版本： 4.0

参数:

返回：

成功返回值0，失败返回负值。

参见：

GetPortCapability

DestroyCapture

CreateRender()

IAudioAdapter::CreateRender ([in] struct AudioDeviceDescriptor desc, [in] struct AudioSampleAttributes attrs, [out] IAudioRender render, [out] unsigned int renderId )

描述

创建一个音频播放接口的对象。

起始版本： 4.0

参数:

返回：

成功返回值0，失败返回负值。

参见：

GetPortCapability

DestroyRender

DestroyCapture()

IAudioAdapter::DestroyCapture ([in] unsigned int captureId)

描述

销毁一个音频录音接口的对象。

起始版本： 4.0

参数:

注意：

在音频录音过程中，不能销毁该接口对象。

返回：

成功返回值0，失败返回负值。

参见：

CreateCapture

DestroyRender()

IAudioAdapter::DestroyRender ([in] unsigned int renderId)

描述

销毁一个音频播放接口的对象。

起始版本： 4.0

参数:

注意：

在音频播放过程中，不能销毁该接口对象。

返回：

成功返回值0，失败返回负值。

参见：

CreateRender

GetDeviceStatus()

IAudioAdapter::GetDeviceStatus ([out] struct AudioDeviceStatus status)

描述

获取一个音频适配器的设备状态。

起始版本： 4.0

参数:

返回：

成功返回值0，失败返回负值。

GetExtraParams()

IAudioAdapter::GetExtraParams ([in] enum AudioExtParamKey key, [in] String condition, [out] String value )

描述

根据指定条件获取音频扩展参数的取值。

condition为多个键值对组成的字符串，多个键值对之间通过分号分割，键值对的格式为"keytype=keyvalue"。 当输入的key值为AudioExtParamKey::AUDIO_EXT_PARAM_KEY_VOLUME时，condition的格式必须为： "EVENT_TYPE=xxx;VOLUME_GROUP_ID=xxx;AUDIO_VOLUME_TYPE=xxx;"

• EVENT_TYPE 表示音量事件类型：其中1表示设置音量，4表示设置静音。

• VOLUME_GROUP_ID 表示待查询的音频扩展参数相关的音量组。

• AUDIO_VOLUME_TYPE 表示待查询的音频扩展参数相关的音量类型。

起始版本： 4.0

参数:

返回：

成功返回值0，失败返回负值。

GetMicMute()

IAudioAdapter::GetMicMute ([out] boolean mute)

描述

获取音频静音状态。

起始版本： 4.0

参数:

返回：

成功返回值0，失败返回负值。

参见：

GetMicMute

GetPassthroughMode()

IAudioAdapter::GetPassthroughMode ([in] struct AudioPort port, [out] enum AudioPortPassthroughMode mode )

描述

获取音频端口驱动的数据透传模式。

起始版本： 4.0

参数:

返回：

成功返回值0，失败返回负值。

参见：

SetPassthroughMode

GetPortCapability()

IAudioAdapter::GetPortCapability ([in] struct AudioPort port, [out] struct AudioPortCapability capability )

描述

获取一个音频适配器的端口驱动的能力集。

起始版本： 4.0

参数:

返回：

成功返回值0，失败返回负值。

InitAllPorts()

IAudioAdapter::InitAllPorts ()

描述

初始化一个音频适配器所有的端口驱动。 在音频服务中，调用其他驱动接口前需要先调用该接口检查端口是否已经初始化完成，如果端口没有初始化完成， 则需要等待一段时间（例如100ms）后重新进行检查，直到端口初始化完成后再继续操作。

起始版本： 4.0

参数:

返回：

初始化完成返回值0，初始化失败返回负值。

RegExtraParamObserver()

IAudioAdapter::RegExtraParamObserver ([in] IAudioCallback audioCallback, [in] byte cookie )

描述

注册扩展参数回调函数。

起始版本： 3.2

参数:

返回：

成功返回值0，失败返回负值。

ReleaseAudioRoute()

IAudioAdapter::ReleaseAudioRoute ([in] int routeHandle)

描述

释放音频路由。

起始版本： 4.0

参数:

返回：

成功返回值0，失败返回负值。

SetExtraParams()

IAudioAdapter::SetExtraParams ([in] enum AudioExtParamKey key, [in] String condition, [in] String value )

描述

根据指定的条件设置音频拓展参数。

condition为多个键值对组成的字符串，多个键值对之间通过分号分割，键值对的格式为"keytype=keyvalue"。 当输入的key值为AudioExtParamKey::AUDIO_EXT_PARAM_KEY_VOLUME时，condition的格式必须为： "EVENT_TYPE=xxx;VOLUME_GROUP_ID=xxx;AUDIO_VOLUME_TYPE=xxx;"

• EVENT_TYPE 表示音量事件类型：其中1表示设置音量，4表示设置静音。

• VOLUME_GROUP_ID 表示待设置的音频扩展参数相关的音量组。

• AUDIO_VOLUME_TYPE 表示待设置的音频扩展参数相关的音量类型。

起始版本： 4.0

参数:

返回：

成功返回值0，失败返回负值。

SetMicMute()

IAudioAdapter::SetMicMute ([in] boolean mute)

描述

设置音频静音。

起始版本： 4.0

参数:

返回：

成功返回值0，失败返回负值。

参见：

SetMicMute

SetPassthroughMode()

IAudioAdapter::SetPassthroughMode ([in] struct AudioPort port, [in] enum AudioPortPassthroughMode mode )

描述

设置音频端口驱动的数据透传模式。

起始版本： 4.0

参数:

返回：

成功返回值0，失败返回负值。

参见：

GetPassthroughMode

SetVoiceVolume()

IAudioAdapter::SetVoiceVolume ([in] float volume)

描述

设置语音呼叫的音量。

音量范围从0.0到1.0。如果音频服务中的音量水平在0到15的范围内， 0.0表示音频静音，1.0指示最大音量级别（15）。

起始版本： 4.0

参数:

返回：

成功返回值0，失败返回负值。

参见：

GetVolume

UpdateAudioRoute()

IAudioAdapter::UpdateAudioRoute ([in] struct AudioRoute route, [out] int routeHandle )

描述

更新音频路由。

起始版本： 4.0

参数:

返回：

成功返回值0，失败返回负值。