OHAudio

概述

提供音频模块C接口定义。

开发者可根据实际的开发需求，参考对应的开发指南及样例：

• 使用OHAudio开发音频播放功能
• 使用OHAudio开发音频录制功能
• 使用AudioSession管理应用音频焦点

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

起始版本： 10

汇总

文件

结构体

类型定义

枚举

函数

类型定义说明

OH_AudioCapturer

typedef struct OH_AudioCapturerStruct OH_AudioCapturer

描述 声明输入音频流。

输入音频流的实例被用来获取音频数据。

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

起始版本： 10

OH_AudioCapturer_Callbacks

typedef struct OH_AudioCapturer_Callbacks_Struct OH_AudioCapturer_Callbacks

描述 声明输入音频流的回调函数指针。

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

起始版本： 10

OH_AudioDeviceDescriptor

typedef struct OH_AudioDeviceDescriptor OH_AudioDeviceDescriptor

描述 声明音频设备描述符。

该实例用于获取更多音频设备详细信息属性。

起始版本： 12

OH_AudioDeviceDescriptorArray

typedef struct OH_AudioDeviceDescriptorArray OH_AudioDeviceDescriptorArray

描述 声明音频设备描述符数组。

起始版本： 12

OH_AudioManager

typedef struct OH_AudioManager OH_AudioManager

描述 声明音频管理器。

用于管理音频管理相关功能。

起始版本： 12

OH_AudioRenderer

typedef struct OH_AudioRendererStruct OH_AudioRenderer

描述 声明输出音频流。

输出音频流的实例被用来播放音频数据。

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

起始版本： 10

OH_AudioRenderer_Callbacks

typedef struct OH_AudioRenderer_Callbacks_Struct OH_AudioRenderer_Callbacks

描述 声明输出音频流的回调函数指针。

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

起始版本： 10

OH_AudioRenderer_OnMarkReachedCallback

typedef void (*OH_AudioRenderer_OnMarkReachedCallback)(OH_AudioRenderer *renderer, uint32_t samplePos, void *userData)

描述 到达标记位置时回调。

起始版本： 12

参数:

OH_AudioRenderer_OnWriteDataCallback

typedef OH_AudioData_Callback_Result(* OH_AudioRenderer_OnWriteDataCallback)(OH_AudioRenderer *renderer, void *userData, void *audioData, int32_t audioDataSize)

描述 该函数指针将指向用于写入音频数据的回调函数。

回调函数仅用来写入音频数据，请勿在回调函数中调用AudioRenderer相关接口。

该函数类似于 OH_AudioRenderer_Callbacks_Struct.OH_AudioRenderer_OnWriteData 函数指针。但具有返回值，用于标识音频数据回调结果。 该函数的返回结果表示填充到缓冲区的数据是否有效。如果结果无效，用户填写的数据将不被播放。回调函数结束后，音频服务会把audioData指针数据放入队列里等待播放，因此请勿在回调外再次更改audioData指向的数据, 且务必保证往audioData填满audioDataSize长度的待播放数据, 否则会导致音频服务播放杂音。参数audioDataSize可以通过OH_AudioStreamBuilder_SetFrameSizeInCallBack()设置。

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

起始版本： 12

参数:

返回：

函数返回值OH_AudioData_Callback_Result：

AUDIO_DATA_CALLBACK_RESULT_INVALID：音频数据回调结果无效，且音频数据不播放。

AUDIO_DATA_CALLBACK_RESULT_VALID：音频数据回调结果有效，将播放音频数据。

参见：

OH_AudioRenderer_Callbacks_Struct.OH_AudioRenderer_OnWriteData

OH_AudioRenderer_OutputDeviceChangeCallback

typedef void (*OH_AudioRenderer_OutputDeviceChangeCallback)(OH_AudioRenderer *renderer, void *userData, OH_AudioStream_DeviceChangeReason reason)

描述 输出音频流设备变更的回调函数。

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

起始版本： 11

参数:

OH_AudioRenderer_WriteDataWithMetadataCallback

typedef int32_t (*OH_AudioRenderer_WriteDataWithMetadataCallback)(OH_AudioRenderer *renderer, void *userData, void *audioData, int32_t audioDataSize, void *metadata, int32_t metadataSize)

描述 该函数指针将指向用于同时写入音频数据和元数据的回调函数。

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

起始版本： 12

参数:

返回：

用户返回的回调函数的错误码。

OH_AudioRoutingManager

typedef struct OH_AudioRoutingManager OH_AudioRoutingManager

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

起始版本： 12

OH_AudioRoutingManager_OnDeviceBlockStatusCallback

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

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

起始版本： 13

参数:

OH_AudioRoutingManager_OnDeviceChangedCallback

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

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

起始版本： 12

参数:

OH_AudioSession_DeactivatedCallback

typedef int32_t (*OH_AudioSession_DeactivatedCallback)(OH_AudioSession_DeactivatedEvent event)

描述 这个函数指针将指向用于监听音频会话停用事件的回调函数。

起始版本： 12

参数:

OH_AudioSession_DeactivatedEvent

typedef struct OH_AudioSession_DeactivatedEventOH_AudioSession_DeactivatedEvent

描述 音频会话已停用事件。

起始版本： 12

OH_AudioSession_Strategy

typedef struct OH_AudioSession_Strategy OH_AudioSession_Strategy

描述 音频会话策略。

起始版本： 12

OH_AudioSessionManager

typedef struct OH_AudioSessionManager OH_AudioSessionManager

描述 声明音频会话管理器。

用于管理音频会话相关功能。

起始版本： 12

OH_AudioStreamBuilder

typedef struct OH_AudioStreamBuilderStruct OH_AudioStreamBuilder

描述 声明音频流的构造器。

构造器实例通常被用来设置音频流属性和创建音频流。

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

起始版本： 10

枚举类型说明

OH_AudioCommon_Result

enum OH_AudioCommon_Result

描述 音频错误码。

起始版本： 12

OH_AudioData_Callback_Result

enum OH_AudioData_Callback_Result

描述 定义音频数据回调结果。

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

起始版本： 12

OH_AudioDevice_BlockStatus

enum OH_AudioDevice_BlockStatus

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

起始版本： 13

OH_AudioDevice_ChangeType

enum OH_AudioDevice_ChangeType

描述 定义音频设备更改类型。

起始版本： 12

OH_AudioDevice_Flag

enum OH_AudioDevice_Flag

描述 定义音频设备标志。

起始版本： 12

OH_AudioDevice_Role

enum OH_AudioDevice_Role

描述 定义音频设备角色。

起始版本： 12

OH_AudioDevice_Type

enum OH_AudioDevice_Type

描述 定义音频设备类型。

起始版本： 12

OH_AudioDevice_Usage

enum OH_AudioDevice_Usage

描述 定义可获取的设备种类。

起始版本： 12

OH_AudioInterrupt_ForceType

enum OH_AudioInterrupt_ForceType

描述 定义音频中断类型。

当用户监听到音频中断时，将获取此信息。

此类型表示本次音频打断的操作是否已由系统强制执行，具体操作信息（如音频暂停、停止等）可通过OH_AudioInterrupt_Hint获取。

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

起始版本： 10

OH_AudioInterrupt_Hint

enum OH_AudioInterrupt_Hint

描述 定义音频中断提示类型。

当用户监听到音频中断时，将获取此信息。

此类型表示根据焦点策略，当前需要对音频流的具体操作（如暂停、调整音量等）。可以结合OH_AudioInterrupt_ForceType信息，判断该操作是否已由系统强制执行。

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

起始版本： 10

OH_AudioInterrupt_Mode

enum OH_AudioInterrupt_Mode

描述 定义音频中断模式。

通常用来设置音频中断模式。

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

起始版本： 12

OH_AudioScene

enum OH_AudioScene

描述 定义音频场景。

起始版本： 12

OH_AudioSession_ConcurrencyMode

enum OH_AudioSession_ConcurrencyMode

描述 音频并发模式。

起始版本： 12

OH_AudioSession_DeactivatedReason

enum OH_AudioSession_DeactivatedReason

描述 音频会话停用原因。

起始版本： 12

OH_AudioStream_AudioEffectMode

enum OH_AudioStream_AudioEffectMode

描述 定义音效模式。

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

起始版本： 12

OH_AudioStream_DeviceChangeReason

enum OH_AudioStream_DeviceChangeReason

描述 流设备变更原因。

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

起始版本： 11

OH_AudioStream_EncodingType

enum OH_AudioStream_EncodingType

描述 定义音频流编码类型。

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

起始版本： 10

OH_AudioStream_Event

enum OH_AudioStream_Event

描述 定义音频事件。

通常用来描述音频事件。

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

起始版本： 10

OH_AudioStream_LatencyMode

enum OH_AudioStream_LatencyMode

描述 定义音频时延模式。

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

起始版本： 10

OH_AudioStream_PrivacyType

enum OH_AudioStream_PrivacyType

描述 用于标识对应播放音频流是否支持被其他应用录制。

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

起始版本： 12

OH_AudioStream_Result

enum OH_AudioStream_Result

描述 音频错误码。

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

起始版本： 10

OH_AudioStream_SampleFormat

enum OH_AudioStream_SampleFormat

描述 定义音频流采样格式。

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

起始版本： 10

OH_AudioStream_SourceType

enum OH_AudioStream_SourceType

描述 定义音频流使用场景。

通常用来描述音频输入流的使用场景。

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

起始版本： 10

OH_AudioStream_State

enum OH_AudioStream_State

描述 定义音频流的状态。

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

起始版本： 10

OH_AudioStream_Type

enum OH_AudioStream_Type

描述 音频流类型。

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

起始版本： 10

OH_AudioStream_Usage

enum OH_AudioStream_Usage

描述 定义音频流使用场景。

通常用来描述音频输出流的使用场景。

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

起始版本： 10

OH_AudioStream_VolumeMode

enum OH_AudioStream_VolumeMode

描述

定义音频流音量模式。

起始版本： 18

函数说明

OH_AudioCapturer_Flush()

OH_AudioStream_Result OH_AudioCapturer_Flush(OH_AudioCapturer *capturer)

描述 丢弃获取的音频数据。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数capturer为nullptr。

AUDIOSTREAM_ERROR_ILLEGAL_STATE：执行状态异常。

OH_AudioCapturer_GetCapturerInfo()

OH_AudioStream_Result OH_AudioCapturer_GetCapturerInfo(OH_AudioCapturer *capturer, OH_AudioStream_SourceType *sourceType)

描述 查询当前音频流工作场景类型。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数capturer为nullptr。

OH_AudioCapturer_GetChannelCount()

OH_AudioStream_Result OH_AudioCapturer_GetChannelCount(OH_AudioCapturer *capturer, int32_t *channelCount)

描述 查询当前音频流通道数。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数capturer为nullptr。

OH_AudioCapturer_GetCurrentState()

OH_AudioStream_Result OH_AudioCapturer_GetCurrentState(OH_AudioCapturer *capturer, OH_AudioStream_State *state)

描述 查询当前音频流状态。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数capturer为nullptr。

OH_AudioCapturer_GetEncodingType()

OH_AudioStream_Result OH_AudioCapturer_GetEncodingType(OH_AudioCapturer *capturer, OH_AudioStream_EncodingType *encodingType)

描述 查询当前音频流编码类型。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数capturer为nullptr。

OH_AudioCapturer_GetFrameSizeInCallback()

OH_AudioStream_Result OH_AudioCapturer_GetFrameSizeInCallback(OH_AudioCapturer *capturer, int32_t *frameSize)

描述 在回调中查询帧大小，它是每次回调返回的缓冲区的固定长度。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数capturer为nullptr。

AUDIOSTREAM_ERROR_ILLEGAL_STATE：执行状态异常。

OH_AudioCapturer_GetFramesRead()

OH_AudioStream_Result OH_AudioCapturer_GetFramesRead(OH_AudioCapturer *capturer, int64_t *frames)

描述 查询自创建流以来已读取的帧数。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数capturer为nullptr。

OH_AudioCapturer_GetLatencyMode()

OH_AudioStream_Result OH_AudioCapturer_GetLatencyMode(OH_AudioCapturer *capturer, OH_AudioStream_LatencyMode *latencyMode)

描述 查询当前音频流时延模式。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数capturer为nullptr。

OH_AudioCapturer_GetOverflowCount()

OH_AudioStream_Result OH_AudioCapturer_GetOverflowCount(OH_AudioCapturer *capturer, uint32_t *count)

描述 查询当前录制音频流过载数。

起始版本： 12

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数capturer为nullptr。

OH_AudioCapturer_GetSampleFormat()

OH_AudioStream_Result OH_AudioCapturer_GetSampleFormat(OH_AudioCapturer *capturer, OH_AudioStream_SampleFormat *sampleFormat)

描述 查询当前输入音频流采样格式。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数capturer为nullptr。

OH_AudioCapturer_GetSamplingRate()

OH_AudioStream_Result OH_AudioCapturer_GetSamplingRate(OH_AudioCapturer *capturer, int32_t *rate)

描述 查询当前输入音频流采样率。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数capturer为nullptr。

OH_AudioCapturer_GetStreamId()

OH_AudioStream_Result OH_AudioCapturer_GetStreamId(OH_AudioCapturer *capturer, uint32_t *streamId)

描述 查询当前输入音频流ID。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数capturer为nullptr。

OH_AudioCapturer_GetTimestamp()

OH_AudioStream_Result OH_AudioCapturer_GetTimestamp(OH_AudioCapturer *capturer, clockid_t clockId, int64_t *framePosition, int64_t *timestamp)

描述 获取输入音频流时间戳和位置信息。

该接口可以获取到音频通道实际录制位置（framePosition）以及录制到该位置时候的时间戳（timestamp），时间戳单位为纳秒。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：

1. 参数capturer为nullptr；
2. 参数clockId无效。

AUDIOSTREAM_ERROR_ILLEGAL_STATE：执行状态异常。

OH_AudioCapturer_Pause()

OH_AudioStream_Result OH_AudioCapturer_Pause(OH_AudioCapturer *capturer)

描述 暂停输入音频流。

起始版本： 10

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

参数:

需要权限：

ohos.permission.MICROPHONE

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数capturer为nullptr。

AUDIOSTREAM_ERROR_ILLEGAL_STATE：执行状态异常。

OH_AudioCapturer_Release()

OH_AudioStream_Result OH_AudioCapturer_Release(OH_AudioCapturer *capturer)

描述 释放输入音频流。

起始版本： 10

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

参数:

需要权限：

ohos.permission.MICROPHONE

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数capturer为nullptr。

AUDIOSTREAM_ERROR_ILLEGAL_STATE：执行状态异常。

OH_AudioCapturer_Start()

OH_AudioStream_Result OH_AudioCapturer_Start(OH_AudioCapturer *capturer)

描述 开始获取音频数据。

起始版本： 10

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

参数:

需要权限：

ohos.permission.MICROPHONE

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数capturer为nullptr。

AUDIOSTREAM_ERROR_ILLEGAL_STATE：执行状态异常。

OH_AudioCapturer_Stop()

OH_AudioStream_Result OH_AudioCapturer_Stop(OH_AudioCapturer *capturer)

描述 停止输入音频流。

起始版本： 10

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

参数:

需要权限：

ohos.permission.MICROPHONE

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数capturer为nullptr。

AUDIOSTREAM_ERROR_ILLEGAL_STATE：执行状态异常。

OH_AudioDeviceDescriptor_GetDeviceAddress()

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

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

起始版本： 12

参数:

返回：

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

参数:

返回：

AUDIOCOMMON_RESULT_SUCCESS 或 AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM

OH_AudioDeviceDescriptor_GetDeviceDisplayName()

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

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

起始版本： 12

参数:

返回：

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

参数:

返回：

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

参数:

返回：

AUDIODEVICE_SUCCESS 或 AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM

OH_AudioDeviceDescriptor_GetDeviceName()

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

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

起始版本： 12

参数:

返回：

AUDIOCOMMON_RESULT_SUCCESS 或 AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM

OH_AudioDeviceDescriptor_GetDeviceRole()

OH_AudioCommon_Result OH_AudioDeviceDescriptor_GetDeviceRole(OH_AudioDeviceDescriptor *audioDeviceDescriptor, OH_AudioDevice_Role *deviceRole)

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

起始版本： 12

参数:

返回：

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

参数:

返回：

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

参数:

返回：

AUDIOCOMMON_RESULT_SUCCESS 或 AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM

OH_AudioManager_GetAudioRoutingManager()

OH_AudioCommon_Result OH_AudioManager_GetAudioRoutingManager(OH_AudioRoutingManager **audioRoutingManager)

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

起始版本： 12

参数:

返回：

函数返回值OH_AudioCommon_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

OH_AudioManager_GetAudioSessionManager()

OH_AudioCommon_Result OH_AudioManager_GetAudioSessionManager(OH_AudioSessionManager **audioSessionManager)

描述 获取音频会话管理器。

使用音频会话管理器相关功能，首先需要获取音频会话管理器实例。

起始版本： 12

参数:

返回：

函数返回值OH_AudioCommon_Result：

AUDIOCOMMON_RESULT_SUCCESS 函数执行成功。

OH_AudioRenderer_CancelMark()

OH_AudioStream_Result OH_AudioRenderer_CancelMark(OH_AudioRenderer *renderer)

描述 取消由OH_AudioRenderer_SetMarkPosition设置的标记。

起始版本： 12

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOSTREAM_ERROR_INVALID_PARAM：参数renderer为nullptr。

OH_AudioRenderer_Flush()

OH_AudioStream_Result OH_AudioRenderer_Flush(OH_AudioRenderer *renderer)

描述 丢弃已经写入的音频数据。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数renderer为nullptr。

AUDIOSTREAM_ERROR_ILLEGAL_STATE：执行状态异常。

OH_AudioRenderer_GetAudioTimestampInfo()

OH_AudioStream_Result OH_AudioRenderer_GetAudioTimestampInfo(OH_AudioRenderer* renderer, int64_t* framePosition, int64_t* timestamp)

描述

获取输出音频流时间戳和位置信息，适配倍速接口。

获取输出音频流时间戳和位置信息，通常用于进行音画同步对齐。

注意，当实际播放位置（framePosition）为0时，时间戳（timestamp）是固定值，直到流真正跑起来时才会更新。当调用Flush接口时实际播放位置也会被重置。 当音频流路由(route)变化时，例如设备变化或者输出类型变化时，播放位置也会被重置，但此时时间戳仍会持续增长。

推荐当实际播放位置和时间戳都稳定后再调用该接口获取相应值。

该接口适配倍速接口，例如当播放速度设置为2倍时，实际播放位置也会返回为正常的2倍。

起始版本： 15

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOSTREAM_SUCCESS：函数执行成功。

AUDIOSTREAM_ERROR_INVALID_PARAM：

1. 参数renderer为nullptr。
2. 参数framePosition或timestamp为nullptr。

AUDIOSTREAM_ERROR_ILLEGAL_STATE：当前流状态不为合法状态时返回。

AUDIOSTREAM_ERROR_SYSTEM：

1. 系统进程崩溃或被阻塞。
2. 内部系统其他错误。

OH_AudioRenderer_GetChannelCount()

OH_AudioStream_Result OH_AudioRenderer_GetChannelCount(OH_AudioRenderer *renderer, int32_t *channelCount)

描述 查询当前输出音频流通道数。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数renderer为nullptr。

OH_AudioRenderer_GetChannelLayout()

OH_AudioStream_Result OH_AudioRenderer_GetChannelLayout(OH_AudioRenderer *renderer, OH_AudioChannelLayout *channelLayout)

描述 查询当前音频流声道布局。

起始版本： 12

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数renderer为nullptr。

OH_AudioRenderer_GetCurrentState()

OH_AudioStream_Result OH_AudioRenderer_GetCurrentState(OH_AudioRenderer *renderer, OH_AudioStream_State *state)

描述 查询当前输出音频流状态。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数renderer为nullptr。

OH_AudioRenderer_GetEffectMode()

OH_AudioStream_Result OH_AudioRenderer_GetEffectMode(OH_AudioRenderer *renderer, OH_AudioStream_AudioEffectMode *effectMode)

描述 查询当前音频流音效模式。

起始版本： 12

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数renderer为nullptr。

OH_AudioRenderer_GetEncodingType()

OH_AudioStream_Result OH_AudioRenderer_GetEncodingType(OH_AudioRenderer *renderer, OH_AudioStream_EncodingType *encodingType)

描述 查询当前输出音频流编码类型。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数renderer为nullptr。

OH_AudioRenderer_GetFrameSizeInCallback()

OH_AudioStream_Result OH_AudioRenderer_GetFrameSizeInCallback(OH_AudioRenderer *renderer, int32_t *frameSize)

描述 在回调中查询帧大小，它是一个固定的长度，每次回调都要填充流。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数renderer为nullptr。

OH_AudioRenderer_GetFramesWritten()

OH_AudioStream_Result OH_AudioRenderer_GetFramesWritten(OH_AudioRenderer *renderer, int64_t *frames)

描述 查询自创建流以来已写入的帧数。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数renderer为nullptr。

OH_AudioRenderer_GetLatencyMode()

OH_AudioStream_Result OH_AudioRenderer_GetLatencyMode(OH_AudioRenderer *renderer, OH_AudioStream_LatencyMode *latencyMode)

描述 查询当前输出音频流时延模式。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数renderer为nullptr。

OH_AudioRenderer_GetRendererInfo()

OH_AudioStream_Result OH_AudioRenderer_GetRendererInfo(OH_AudioRenderer *renderer, OH_AudioStream_Usage *usage)

描述 查询当前输出音频流工作场景类型。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数renderer为nullptr。

OH_AudioRenderer_GetRendererPrivacy()

OH_AudioStream_Result OH_AudioRenderer_GetRendererPrivacy(OH_AudioRenderer *renderer, OH_AudioStream_PrivacyType *privacy)

描述 查询当前播放音频流是否会被其它应用录制。

起始版本： 12

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数renderer为nullptr。

OH_AudioRenderer_GetSampleFormat()

OH_AudioStream_Result OH_AudioRenderer_GetSampleFormat(OH_AudioRenderer *renderer, OH_AudioStream_SampleFormat *sampleFormat)

描述 查询当前输出音频流采样格式。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数renderer为nullptr。

OH_AudioRenderer_GetSamplingRate()

OH_AudioStream_Result OH_AudioRenderer_GetSamplingRate(OH_AudioRenderer *renderer, int32_t *rate)

描述 查询当前输出音频流采样率。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数renderer为nullptr。

OH_AudioRenderer_GetSilentModeAndMixWithOthers()

OH_AudioStream_Result OH_AudioRenderer_GetSilentModeAndMixWithOthers(OH_AudioRenderer *renderer, bool *on)

描述 查询当前音频流是否开启静音并发播放。

起始版本： 12

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOSTREAM_SUCCESS 函数执行成功。

AUDIOSTREAM_ERROR_INVALID_PARAM 参数renderer为nullptr。

OH_AudioRenderer_GetSpeed()

OH_AudioStream_Result OH_AudioRenderer_GetSpeed(OH_AudioRenderer * renderer, float * speed)

描述 获取音频渲染速率。

起始版本： 11

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数renderer为nullptr。

OH_AudioRenderer_GetStreamId()

OH_AudioStream_Result OH_AudioRenderer_GetStreamId(OH_AudioRenderer *renderer, uint32_t *streamId)

描述 查询当前输出音频流ID。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数renderer为nullptr。

OH_AudioRenderer_GetTimestamp()

OH_AudioStream_Result OH_AudioRenderer_GetTimestamp(OH_AudioRenderer *renderer, clockid_t clockId, int64_t *framePosition, int64_t *timestamp)

描述 获取输出音频流时间戳和位置信息。

该接口可以获取到音频通道实际播放位置（framePosition）以及播放到该位置时的时间戳（timestamp），时间戳单位为纳秒。

当设备切换或暂停恢复时，由于播放通路本身需要一段时间恢复，调用该接口获取的播放位置和时间戳会短暂地保持在切换或暂停前的状态。

该接口一般用来实现音画同步，建议频率不要太频繁，可以每分钟一次，最好不要低于200ms一次。频繁调用可能会带来功耗问题，因此在能保证音画同步效果的情况下，不需要频繁的查询时间戳。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：

1. 参数renderer为nullptr；
2. 参数clockId无效。

AUDIOSTREAM_ERROR_ILLEGAL_STATE：执行状态异常。

OH_AudioRenderer_GetUnderflowCount()

OH_AudioStream_Result OH_AudioRenderer_GetUnderflowCount(OH_AudioRenderer *renderer, uint32_t *count)

描述 查询当前播放音频流欠载数。

起始版本： 12

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：

1. 参数renderer为nullptr；
2. 参数count为nullptr。

OH_AudioRenderer_GetVolume()

OH_AudioStream_Result OH_AudioRenderer_GetVolume(OH_AudioRenderer *renderer, float *volume)

描述 获取当前音频流音量值。

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

起始版本： 12

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：

1. 参数renderer为nullptr；
2. 参数volume为nullptr。

OH_AudioRenderer_Pause()

OH_AudioStream_Result OH_AudioRenderer_Pause(OH_AudioRenderer *renderer)

描述 暂停输出音频流。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数renderer为nullptr。

AUDIOSTREAM_ERROR_ILLEGAL_STATE：执行状态异常。

OH_AudioRenderer_Release()

OH_AudioStream_Result OH_AudioRenderer_Release(OH_AudioRenderer *renderer)

描述 释放输出音频流。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数renderer为nullptr。

AUDIOSTREAM_ERROR_ILLEGAL_STATE：执行状态异常。

OH_AudioRenderer_SetDefaultOutputDevice()

OH_AudioStream_Result OH_AudioRenderer_SetDefaultOutputDevice(OH_AudioRenderer* renderer, OH_AudioDevice_Type deviceType)

描述 设置默认本机内置发声设备。

本接口仅适用于音频流类型OH_AudioStream_Usage为语音消息、VoIP语音通话或者VoIP视频通话的场景使用，以及可选的设备类型为听筒、扬声器和系统默认设备。

本接口允许在AudioRenderer创建以后的任何时间被调用，系统会记录应用设置的默认本机内置发声设备。在应用启动播放时，若有外接设备如蓝牙耳机/有线耳机接入，系统优先从外接设备发声；否则系统遵循应用设置的默认本机内置发声设备发声。

起始版本： 12

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

起始版本： 12

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOSTREAM_ERROR_INVALID_PARAM:

1. 参数renderer为nullptr;
2. 参数deviceType无效。

AUDIOSTREAM_ERROR_ILLEGAL_STATE：执行状态异常。

AUDIOSTREAM_ERROR_SYSTEM：出现系统错误。

OH_AudioRenderer_SetEffectMode()

OH_AudioStream_Result OH_AudioRenderer_SetEffectMode(OH_AudioRenderer *renderer, OH_AudioStream_AudioEffectMode effectMode)

描述 设置当前音频流音效模式。

起始版本： 12

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数renderer为nullptr。

OH_AudioRenderer_SetMarkPosition()

OH_AudioStream_Result OH_AudioRenderer_SetMarkPosition(OH_AudioRenderer *renderer, uint32_t samplePos, OH_AudioRenderer_OnMarkReachedCallback callback, void *userData)

描述 在当前渲染器上设置标记位置。调用此函数将覆盖已设置的标记位置。

起始版本： 12

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：

1. 参数renderer为nullptr；
2. 参数samplePos无效。

AUDIOSTREAM_ERROR_ILLEGAL_STATE：执行状态异常。

AUDIOSTREAM_ERROR_SYSTEM：出现系统错误。

OH_AudioRenderer_SetSilentModeAndMixWithOthers()

OH_AudioStream_Result OH_AudioRenderer_SetSilentModeAndMixWithOthers(OH_AudioRenderer *renderer, bool on)

描述 设置静音并发播放模式。

起始版本： 12

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOSTREAM_SUCCESS：函数执行成功。

AUDIOSTREAM_ERROR_INVALID_PARAM：参数renderer为nullptr。

OH_AudioRenderer_SetSpeed()

OH_AudioStream_Result OH_AudioRenderer_SetSpeed(OH_AudioRenderer *renderer, float speed)

描述 设置音频渲染速率。

起始版本： 11

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数renderer为nullptr。

OH_AudioRenderer_SetVolume()

OH_AudioStream_Result OH_AudioRenderer_SetVolume(OH_AudioRenderer *renderer, float volume)

描述 设置当前音频流音量值。

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

起始版本： 12

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：

1. 参数renderer为nullptr；
2. 参数volume无效。

AUDIOSTREAM_ERROR_ILLEGAL_STATE：执行状态异常。

AUDIOSTREAM_ERROR_SYSTEM：出现系统错误。

OH_AudioRenderer_SetVolumeWithRamp()

OH_AudioStream_Result OH_AudioRenderer_SetVolumeWithRamp(OH_AudioRenderer *renderer, float volume, int32_t durationMs)

描述 在指定时间范围内使用渐变更改音量。

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

起始版本： 12

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：

1. 参数renderer为nullptr；
2. 参数volume无效。

AUDIOSTREAM_ERROR_ILLEGAL_STATE：执行状态异常。

AUDIOSTREAM_ERROR_SYSTEM：出现系统错误。

OH_AudioRenderer_Start()

OH_AudioStream_Result OH_AudioRenderer_Start(OH_AudioRenderer *renderer)

描述 开始输出音频数据。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOSTREAM_SUCCESS：函数执行成功。

AUDIOSTREAM_ERROR_INVALID_PARAM：参数renderer为nullptr。

AUDIOSTREAM_ERROR_ILLEGAL_STATE：执行状态异常。

OH_AudioRenderer_Stop()

OH_AudioStream_Result OH_AudioRenderer_Stop(OH_AudioRenderer *renderer)

描述 停止输出音频流。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数renderer为nullptr。

AUDIOSTREAM_ERROR_ILLEGAL_STATE：执行状态异常。

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_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_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_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_IsMicBlockDetectionSupported()

OH_AudioCommon_Result OH_AudioRoutingManager_IsMicBlockDetectionSupported(OH_AudioRoutingManager *audioRoutingManager, bool *supported)

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

起始版本： 13

参数:

返回：

函数返回值OH_AudioCommon_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：

1. 参数audioRoutingManager为nullptr；
2. 参数supported为nullptr。

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_ReleaseDevices()

OH_AudioCommon_Result OH_AudioRoutingManager_ReleaseDevices(OH_AudioRoutingManager *audioRoutingManager, OH_AudioDeviceDescriptorArray *audioDeviceDescriptorArray)

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

起始版本： 12

参数:

返回：

函数返回值OH_AudioCommon_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：

1. 参数audioRoutingManager为nullptr；
2. 参数audioDeviceDescriptorArray为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。

OH_AudioRoutingManager_UnregisterDeviceChangeCallback()

OH_AudioCommon_Result OH_AudioRoutingManager_UnregisterDeviceChangeCallback(OH_AudioRoutingManager *audioRoutingManager, OH_AudioRoutingManager_OnDeviceChangedCallback callback)

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

起始版本： 12

参数:

返回：

函数返回值OH_AudioCommon_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：

1. 参数audioRoutingManager为nullptr；
2. 参数callback为nullptr。

OH_AudioSessionManager_ActivateAudioSession()

OH_AudioCommon_Result OH_AudioSessionManager_ActivateAudioSession(OH_AudioSessionManager *audioSessionManager, const OH_AudioSession_Strategy *strategy)

描述 激活音频会话。

起始版本： 12

参数:

返回：

函数返回值OH_AudioCommon_Result：

AUDIOCOMMON_RESULT_SUCCESS 函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：

1. 参数audioSessionManager为nullptr；
2. 参数strategy无效。 AUDIOCOMMON_RESULT_ERROR_ILLEGAL_STATE 非法状态。

OH_AudioSessionManager_DeactivateAudioSession()

OH_AudioCommon_Result OH_AudioSessionManager_DeactivateAudioSession(OH_AudioSessionManager *audioSessionManager)

描述 停用音频会话。

起始版本： 12

参数:

返回：

函数返回值OH_AudioCommon_Result：

AUDIOCOMMON_RESULT_SUCCESS 函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数audioSessionManager为nullptr。

AUDIOCOMMON_RESULT_ERROR_ILLEGAL_STATE 非法状态。

OH_AudioSessionManager_IsAudioSessionActivated()

bool OH_AudioSessionManager_IsAudioSessionActivated(OH_AudioSessionManager *audioSessionManager)

描述 检查音频会话是否已激活。

起始版本： 12

参数:

返回：

用于返回当前应用的音频会话是否已激活，true表示已激活，false表示已停用。

OH_AudioSessionManager_RegisterSessionDeactivatedCallback()

OH_AudioCommon_Result OH_AudioSessionManager_RegisterSessionDeactivatedCallback(OH_AudioSessionManager *audioSessionManager, OH_AudioSession_DeactivatedCallback callback)

描述 注册音频会话停用事件回调。

起始版本： 12

参数:

返回：

函数返回值OH_AudioCommon_Result：

AUDIOCOMMON_RESULT_SUCCESS 函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：

1. 参数audioSessionManager为nullptr；
2. 参数callback为nullptr。

OH_AudioSessionManager_UnregisterSessionDeactivatedCallback()

OH_AudioCommon_Result OH_AudioSessionManager_UnregisterSessionDeactivatedCallback(OH_AudioSessionManager *audioSessionManager, OH_AudioSession_DeactivatedCallback callback)

描述 取消注册音频会话停用事件回调。

起始版本： 12

参数:

返回：

函数返回值OH_AudioCommon_Result：

AUDIOCOMMON_RESULT_SUCCESS 函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：

1. 参数audioSessionManager为nullptr；
2. 参数callback为nullptr。

OH_AudioStreamBuilder_Create()

OH_AudioStream_Result OH_AudioStreamBuilder_Create(OH_AudioStreamBuilder **builder, OH_AudioStream_Type type)

描述 创建一个输入或者输出类型的音频流构造器。

当构造器不再使用时，需要调用OH_AudioStreamBuilder_Destroy()销毁它。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

OH_AudioStreamBuilder_Destroy()

OH_AudioStream_Result OH_AudioStreamBuilder_Destroy(OH_AudioStreamBuilder *builder)

描述 销毁一个音频流构造器。

当构造器不再使用时，需要调用该函数销毁它。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOSTREAM_ERROR_INVALID_PARAM：参数builder为nullptr。

AUDIOSTREAM_ERROR_ILLEGAL_STATE：执行状态异常。

OH_AudioStreamBuilder_GenerateCapturer()

OH_AudioStream_Result OH_AudioStreamBuilder_GenerateCapturer(OH_AudioStreamBuilder *builder, OH_AudioCapturer **audioCapturer)

描述 创建输入音频流实例。

起始版本： 10

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

参数:

需要权限：

ohos.permission.MICROPHONE

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOSTREAM_ERROR_INVALID_PARAM：

1. 参数builder为nullptr；
2. StreamType无效；
3. 创建OHAudioCapturer失败。

OH_AudioStreamBuilder_GenerateRenderer()

OH_AudioStream_Result OH_AudioStreamBuilder_GenerateRenderer(OH_AudioStreamBuilder *builder, OH_AudioRenderer **audioRenderer)

描述 创建输出音频流实例。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOSTREAM_ERROR_INVALID_PARAM：

1. 参数builder为nullptr；
2. StreamType无效；
3. 创建OHAudioRenderer失败。

OH_AudioStreamBuilder_SetCapturerCallback()

OH_AudioStream_Result OH_AudioStreamBuilder_SetCapturerCallback(OH_AudioStreamBuilder *builder, OH_AudioCapturer_Callbacks callbacks, void *userData)

描述 设置输入音频流的回调。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOSTREAM_ERROR_INVALID_PARAM：

1. 参数builder为nullptr；
2. StreamType无效。

OH_AudioStreamBuilder_SetCapturerInfo()

OH_AudioStream_Result OH_AudioStreamBuilder_SetCapturerInfo(OH_AudioStreamBuilder *builder, OH_AudioStream_SourceType sourceType)

描述 设置输入音频流的工作场景。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOSTREAM_ERROR_INVALID_PARAM：

1. 参数builder为nullptr；
2. 参数sourceType无效。

OH_AudioStreamBuilder_SetChannelCount()

OH_AudioStream_Result OH_AudioStreamBuilder_SetChannelCount(OH_AudioStreamBuilder *builder, int32_t channelCount)

描述 设置音频流的通道数属性。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOSTREAM_ERROR_INVALID_PARAM：

1. 参数builder为nullptr；
2. 参数channelCount无效。

OH_AudioStreamBuilder_SetChannelLayout()

OH_AudioStream_Result OH_AudioStreamBuilder_SetChannelLayout(OH_AudioStreamBuilder *builder, OH_AudioChannelLayout channelLayout)

描述 设置音频流的声道布局。

起始版本： 12

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOSTREAM_ERROR_INVALID_PARAM：参数builder为nullptr。

OH_AudioStreamBuilder_SetEncodingType()

OH_AudioStream_Result OH_AudioStreamBuilder_SetEncodingType(OH_AudioStreamBuilder *builder, OH_AudioStream_EncodingType encodingType)

描述 设置音频流的编码类型属性。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOSTREAM_ERROR_INVALID_PARAM：参数builder为nullptr。

OH_AudioStreamBuilder_SetFrameSizeInCallback()

OH_AudioStream_Result OH_AudioStreamBuilder_SetFrameSizeInCallback(OH_AudioStreamBuilder *builder, int32_t frameSize)

描述 用于播放时设置每次回调的帧长，帧长至少为音频硬件一次处理的数据大小，并且小于内部缓冲容量的一半。

• 低时延播放：frameSize可设置为5ms、10ms、15ms、20ms音频数据对应的帧长。
• 普通通路播放：frameSize可设置为20ms-100ms音频数据对应的帧长。

起始版本： 11

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOSTREAM_ERROR_INVALID_PARAM：参数builder为nullptr。

OH_AudioStreamBuilder_SetLatencyMode()

OH_AudioStream_Result OH_AudioStreamBuilder_SetLatencyMode(OH_AudioStreamBuilder *builder, OH_AudioStream_LatencyMode latencyMode)

描述 设置音频流的时延模式。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOSTREAM_ERROR_INVALID_PARAM：参数builder为nullptr。

OH_AudioStreamBuilder_SetRendererCallback()

OH_AudioStream_Result OH_AudioStreamBuilder_SetRendererCallback(OH_AudioStreamBuilder *builder, OH_AudioRenderer_Callbacks callbacks, void *userData)

描述 设置输出音频流的回调。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOSTREAM_ERROR_INVALID_PARAM：

1. 参数builder为nullptr；
2. StreamType无效。

OH_AudioStreamBuilder_SetRendererInfo()

OH_AudioStream_Result OH_AudioStreamBuilder_SetRendererInfo(OH_AudioStreamBuilder *builder, OH_AudioStream_Usage usage)

描述 设置输出音频流的工作场景。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOSTREAM_ERROR_INVALID_PARAM：

1. 参数builder为nullptr；
2. 参数usage无效。

OH_AudioStreamBuilder_SetRendererInterruptMode()

OH_AudioStream_Result OH_AudioStreamBuilder_SetRendererInterruptMode(OH_AudioStreamBuilder *builder, OH_AudioInterrupt_Mode mode)

描述 设置流客户端的中断模式。

起始版本： 12

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOSTREAM_ERROR_INVALID_PARAM：

1. 参数builder为nullptr；
2. 参数mode无效；
3. StreamType无效。

OH_AudioStreamBuilder_SetRendererOutputDeviceChangeCallback()

OH_AudioStream_Result OH_AudioStreamBuilder_SetRendererOutputDeviceChangeCallback(OH_AudioStreamBuilder * builder, OH_AudioRenderer_OutputDeviceChangeCallback callback, void * userData)

描述 设置输出音频流设备变更的回调。

起始版本： 11

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOSTREAM_ERROR_INVALID_PARAM：

1. 参数builder为nullptr；
2. StreamType无效。

OH_AudioStreamBuilder_SetRendererPrivacy()

OH_AudioStream_Result OH_AudioStreamBuilder_SetRendererPrivacy(OH_AudioStreamBuilder * builder, OH_AudioStream_PrivacyType privacy)

描述 设置当前播放音频流是否会被其它应用录制。

起始版本： 12

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOSTREAM_ERROR_INVALID_PARAM：

1. 参数builder为nullptr；
2. StreamType无效。

OH_AudioStreamBuilder_SetRendererWriteDataCallback()

OH_AudioStream_Result OH_AudioStreamBuilder_SetRendererWriteDataCallback(OH_AudioStreamBuilder *builder, OH_AudioRenderer_OnWriteDataCallback callback, void *userData)

描述 设置写入音频数据的回调。

该函数类似于 OH_AudioStreamBuilder_SetRendererCallback。只有通过 OH_AudioStreamBuilder_SetRendererCallback或者此函数设置的最后一个回调函数才会被调用。

起始版本： 12

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOSTREAM_SUCCESS：函数执行成功。

AUDIOSTREAM_ERROR_INVALID_PARAM：

1. 参数builder为nullptr；
2. StreamType无效。

OH_AudioStreamBuilder_SetSampleFormat()

OH_AudioStream_Result OH_AudioStreamBuilder_SetSampleFormat(OH_AudioStreamBuilder *builder, OH_AudioStream_SampleFormat format)

描述 设置音频流的采样格式属性。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOSTREAM_ERROR_INVALID_PARAM：参数builder为nullptr。

OH_AudioStreamBuilder_SetSamplingRate()

OH_AudioStream_Result OH_AudioStreamBuilder_SetSamplingRate(OH_AudioStreamBuilder *builder, int32_t rate)

描述 设置音频流的采样率属性。

起始版本： 10

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOSTREAM_ERROR_INVALID_PARAM：

1. 参数builder为nullptr。
2. 参数rate无效。

OH_AudioStreamBuilder_SetVolumeMode()

OH_AudioStream_Result OH_AudioStreamBuilder_SetVolumeMode(OH_AudioStreamBuilder* builder, OH_AudioStream_VolumeMode volumeMode);

描述

设置音频流音量模式。

起始版本： 18

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOSTREAM_SUCCESS：函数执行成功。

AUDIOSTREAM_ERROR_INVALID_PARAM：

1. 参数builder为nullptr。
2. 参数volumeMode无效。

OH_AudioStreamBuilder_SetWriteDataWithMetadataCallback()

OH_AudioStream_Result OH_AudioStreamBuilder_SetWriteDataWithMetadataCallback(OH_AudioStreamBuilder *builder, OH_AudioRenderer_WriteDataWithMetadataCallback callback, void *userData)

描述 设置同时写入音频数据和元数据的回调。

起始版本： 12

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

参数:

返回：

函数返回值OH_AudioStream_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOSTREAM_ERROR_INVALID_PARAM：

1. 参数builder为nullptr；
2. StreamType无效。

OH_GetAudioManager()

OH_AudioCommon_Result OH_GetAudioManager(OH_AudioManager ** audioManager)

描述 获取音频管理器。

使用音频管理器相关功能，首先需要获取音频管理器实例。

起始版本： 12

参数:

返回：

函数返回值OH_AudioCommon_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：参数audioManager为nullptr。

OH_GetAudioScene()

OH_AudioCommon_Result OH_GetAudioScene(OH_AudioManager * manager, OH_AudioScene * scene)

描述 获取音频场景模式。

起始版本： 12

参数:

返回：

函数返回值OH_AudioCommon_Result：

AUDIOCOMMON_RESULT_SUCCESS：函数执行成功。

AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM：

1. 参数audioManager为nullptr;
2. 参数scene为nullptr。