native_audiorenderer.h
概述
声明音频渲染的相关接口。
引用文件： <ohaudio/native_audiorenderer.h>
库： libohaudio.so
系统能力： SystemCapability.Multimedia.Audio.Core
起始版本： 10
相关模块： OHAudio
汇总
函数
函数说明
OH_AudioRenderer_Release()
OH_AudioStream_Result OH_AudioRenderer_Release(OH_AudioRenderer* renderer)
描述
释放输出音频流。
起始版本： 10
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioStream_Result | AUDIOSTREAM_SUCCESS：函数执行成功。 AUDIOSTREAM_ERROR_INVALID_PARAM：参数renderer为nullptr。 AUDIOSTREAM_ERROR_ILLEGAL_STATE：执行状态异常。 |
OH_AudioRenderer_Start()
OH_AudioStream_Result OH_AudioRenderer_Start(OH_AudioRenderer* renderer)
描述
开始输出音频数据。
起始版本： 10
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioStream_Result | AUDIOSTREAM_SUCCESS：函数执行成功。 AUDIOSTREAM_ERROR_INVALID_PARAM：参数renderer为nullptr。 AUDIOSTREAM_ERROR_ILLEGAL_STATE：执行状态异常。 |
OH_AudioRenderer_Pause()
OH_AudioStream_Result OH_AudioRenderer_Pause(OH_AudioRenderer* renderer)
描述
暂停输出音频流。
起始版本： 10
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
返回：
| 类型 | 说明 |
|---|---|
| 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
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioStream_Result | AUDIOSTREAM_SUCCESS：函数执行成功。 AUDIOSTREAM_ERROR_INVALID_PARAM：参数renderer为nullptr。 AUDIOSTREAM_ERROR_ILLEGAL_STATE：执行状态异常。 |
OH_AudioRenderer_Flush()
OH_AudioStream_Result OH_AudioRenderer_Flush(OH_AudioRenderer* renderer)
描述
清空缓冲区的音频数据。
起始版本： 10
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioStream_Result | AUDIOSTREAM_SUCCESS：函数执行成功。 AUDIOSTREAM_ERROR_INVALID_PARAM：参数renderer为nullptr。 AUDIOSTREAM_ERROR_ILLEGAL_STATE：执行状态异常。 |
OH_AudioRenderer_GetCurrentState()
OH_AudioStream_Result OH_AudioRenderer_GetCurrentState(OH_AudioRenderer* renderer, OH_AudioStream_State* state)
描述
查询当前输出音频流状态。
起始版本： 10
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
| OH_AudioStream_State* state | 指向一个用来接收音频流状态的变量。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioStream_Result | AUDIOSTREAM_SUCCESS：函数执行成功。 AUDIOSTREAM_ERROR_INVALID_PARAM：参数renderer为nullptr。 |
OH_AudioRenderer_GetSamplingRate()
OH_AudioStream_Result OH_AudioRenderer_GetSamplingRate(OH_AudioRenderer* renderer, int32_t* rate)
描述
查询当前输出音频流采样率。
起始版本： 10
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
| int32_t* rate | 指向一个用来接收音频流采样率的变量。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioStream_Result | AUDIOSTREAM_SUCCESS：函数执行成功。 AUDIOSTREAM_ERROR_INVALID_PARAM：参数renderer为nullptr。 |
OH_AudioRenderer_GetStreamId()
OH_AudioStream_Result OH_AudioRenderer_GetStreamId(OH_AudioRenderer* renderer, uint32_t* streamId)
描述
查询当前输出音频流ID。
起始版本： 10
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
| uint32_t* streamId | 指向一个用来接收音频流ID的变量。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioStream_Result | AUDIOSTREAM_SUCCESS：函数执行成功。 AUDIOSTREAM_ERROR_INVALID_PARAM：参数renderer为nullptr。 |
OH_AudioRenderer_GetChannelCount()
OH_AudioStream_Result OH_AudioRenderer_GetChannelCount(OH_AudioRenderer* renderer, int32_t* channelCount)
描述
查询当前输出音频流通道数。
起始版本： 10
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
| int32_t* channelCount | 指向一个用来接收音频流通道数的变量。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioStream_Result | AUDIOSTREAM_SUCCESS：函数执行成功。 AUDIOSTREAM_ERROR_INVALID_PARAM：参数renderer为nullptr。 |
OH_AudioRenderer_GetSampleFormat()
OH_AudioStream_Result OH_AudioRenderer_GetSampleFormat(OH_AudioRenderer* renderer, OH_AudioStream_SampleFormat* sampleFormat)
描述
查询当前输出音频流采样格式。
起始版本： 10
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
| OH_AudioStream_SampleFormat* sampleFormat | 指向一个用来接收音频流采样格式的变量。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioStream_Result | AUDIOSTREAM_SUCCESS：函数执行成功。 AUDIOSTREAM_ERROR_INVALID_PARAM：参数renderer为nullptr。 |
OH_AudioRenderer_GetLatencyMode()
OH_AudioStream_Result OH_AudioRenderer_GetLatencyMode(OH_AudioRenderer* renderer, OH_AudioStream_LatencyMode* latencyMode)
描述
查询当前输出音频流时延模式。
起始版本： 10
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
| OH_AudioStream_LatencyMode* latencyMode | 指向一个用来接收音频流时延模式的变量。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioStream_Result | AUDIOSTREAM_SUCCESS：函数执行成功。 AUDIOSTREAM_ERROR_INVALID_PARAM：参数renderer为nullptr。 |
OH_AudioRenderer_GetRendererInfo()
OH_AudioStream_Result OH_AudioRenderer_GetRendererInfo(OH_AudioRenderer* renderer, OH_AudioStream_Usage* usage)
描述
查询当前输出音频流的使用类型。
起始版本： 10
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
| OH_AudioStream_Usage* usage | 指向一个用来接收输出类型音频流的使用类型的变量。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioStream_Result | AUDIOSTREAM_SUCCESS：函数执行成功。 AUDIOSTREAM_ERROR_INVALID_PARAM：参数renderer为nullptr。 |
OH_AudioRenderer_GetEncodingType()
OH_AudioStream_Result OH_AudioRenderer_GetEncodingType(OH_AudioRenderer* renderer, OH_AudioStream_EncodingType* encodingType)
描述
查询当前输出音频流编码类型。
起始版本： 10
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
| OH_AudioStream_EncodingType* encodingType | 指向一个用来接收音频流编码类型的变量。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioStream_Result | AUDIOSTREAM_SUCCESS：函数执行成功。 AUDIOSTREAM_ERROR_INVALID_PARAM：参数renderer为nullptr。 |
OH_AudioRenderer_GetFramesWritten()
OH_AudioStream_Result OH_AudioRenderer_GetFramesWritten(OH_AudioRenderer* renderer, int64_t* frames)
描述
查询自创建流以来已写入的帧数。
起始版本： 10
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
| int64_t* frames | 指向将为帧计数设置的变量的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioStream_Result | AUDIOSTREAM_SUCCESS：函数执行成功。 AUDIOSTREAM_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一次。频繁调用可能会带来功耗问题，因此在能保证音画同步效果的情况下，不需要频繁地查询时间戳。
- 当实际播放位置（framePosition）为0时，时间戳（timestamp）是固定值，直到流真正跑起来时才会更新。
- 当调用Flush接口时实际播放位置也会被重置。
起始版本： 10
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
| clockid_t clockId | 时钟标识符，使用CLOCK_MONOTONIC。 |
| int64_t* framePosition | 指向要接收位置的变量的指针。 |
| int64_t* timestamp | 指向接收时间戳的变量的指针，单位为纳秒。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioStream_Result | AUDIOSTREAM_SUCCESS：函数执行成功。 AUDIOSTREAM_ERROR_INVALID_PARAM： 1. 参数renderer为nullptr； 2. 参数clockId无效。 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
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
| int64_t* framePosition | 指向要接收位置的变量的指针。 |
| int64_t* timestamp | 指向接收时间戳的变量的指针，单位为纳秒。 |
返回：
| 类型 | 说明 |
|---|---|
| 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_GetFrameSizeInCallback()
OH_AudioStream_Result OH_AudioRenderer_GetFrameSizeInCallback(OH_AudioRenderer* renderer, int32_t* frameSize)
描述
在回调中查询帧大小，它是一个固定的长度，每次回调都要填充流。
起始版本： 10
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
| int32_t* frameSize | 指向将为帧大小设置的变量的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| 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
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
| float* speed | 指向接收播放倍速值的变量的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| 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
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
| float speed | 设置播放的倍速值（倍速范围：[0.25, 4.0]）。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioStream_Result | AUDIOSTREAM_SUCCESS：函数执行成功。 AUDIOSTREAM_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
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
| uint32_t samplePos | 设置目标标记位置。 |
| OH_AudioRenderer_OnMarkReachedCallback callback | 当到达目标标记位置时回调。 |
| void* userData | 指向通过回调函数传递的应用数据指针。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioStream_Result | AUDIOSTREAM_SUCCESS：函数执行成功。 AUDIOSTREAM_ERROR_INVALID_PARAM： 1. 参数renderer为nullptr； 2. 参数samplePos无效。 AUDIOSTREAM_ERROR_ILLEGAL_STATE：执行状态异常。 AUDIOSTREAM_ERROR_SYSTEM：出现系统错误。 |
OH_AudioRenderer_CancelMark()
OH_AudioStream_Result OH_AudioRenderer_CancelMark(OH_AudioRenderer* renderer)
描述
取消由OH_AudioRenderer_SetMarkPosition设置的标记。
起始版本： 12
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioStream_Result | AUDIOSTREAM_SUCCESS：函数执行成功。 AUDIOSTREAM_ERROR_INVALID_PARAM：参数renderer为nullptr。 |
OH_AudioRenderer_SetVolume()
OH_AudioStream_Result OH_AudioRenderer_SetVolume(OH_AudioRenderer* renderer, float volume)
描述
设置当前音频流音量值。
起始版本： 12
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
| float volume | 设置当前音频流音量，音量值范围[0.0, 1.0]。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioStream_Result | AUDIOSTREAM_SUCCESS：函数执行成功。 AUDIOSTREAM_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)
描述
在指定时间范围内使用渐变更改音量。
起始版本： 12
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
| float volume | 目标音量值，取值范围[0.0, 1.0]。 |
| int32_t durationMs | 音量渐变的持续时间，以毫秒为单位。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioStream_Result | AUDIOSTREAM_SUCCESS：函数执行成功。 AUDIOSTREAM_ERROR_INVALID_PARAM： 1. 参数renderer为nullptr； 2. 参数volume无效。 AUDIOSTREAM_ERROR_ILLEGAL_STATE：执行状态异常。 AUDIOSTREAM_ERROR_SYSTEM：出现系统错误。 |
OH_AudioRenderer_GetVolume()
OH_AudioStream_Result OH_AudioRenderer_GetVolume(OH_AudioRenderer* renderer, float* volume)
描述
获取当前音频流音量值。
起始版本： 12
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
| float* volume | 指向一个获取当前音频流音量值的指针。音量值的范围是[0.0, 1.0]。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioStream_Result | AUDIOSTREAM_SUCCESS：函数执行成功。 AUDIOSTREAM_ERROR_INVALID_PARAM： 1. 参数renderer为nullptr； 2. 参数volume为nullptr。 |
OH_AudioRenderer_GetUnderflowCount()
OH_AudioStream_Result OH_AudioRenderer_GetUnderflowCount(OH_AudioRenderer* renderer, uint32_t* count)
描述
获取当前播放音频流欠载数。
起始版本： 12
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
| uint32_t* count | 指向一个用来接收音频流欠载数的变量的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioStream_Result | AUDIOSTREAM_SUCCESS：函数执行成功。 AUDIOSTREAM_ERROR_INVALID_PARAM： 1. 参数renderer为nullptr； 2. 参数count为nullptr。 |
OH_AudioRenderer_GetChannelLayout()
OH_AudioStream_Result OH_AudioRenderer_GetChannelLayout(OH_AudioRenderer* renderer, OH_AudioChannelLayout* channelLayout)
描述
查询当前音频流声道布局。
起始版本： 12
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
| OH_AudioChannelLayout* channelLayout | 指向一个用来接收音频流声道布局的变量的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioStream_Result | AUDIOSTREAM_SUCCESS：函数执行成功。 AUDIOSTREAM_ERROR_INVALID_PARAM：参数renderer为nullptr。 |
OH_AudioRenderer_GetEffectMode()
OH_AudioStream_Result OH_AudioRenderer_GetEffectMode(OH_AudioRenderer* renderer, OH_AudioStream_AudioEffectMode* effectMode)
描述
查询当前音频流音效模式。
起始版本： 12
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
| OH_AudioStream_AudioEffectMode* effectMode | 指向一个用来接收音频流音效模式的变量的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioStream_Result | AUDIOSTREAM_SUCCESS：函数执行成功。 AUDIOSTREAM_ERROR_INVALID_PARAM：参数renderer为nullptr。 |
OH_AudioRenderer_SetEffectMode()
OH_AudioStream_Result OH_AudioRenderer_SetEffectMode(OH_AudioRenderer* renderer, OH_AudioStream_AudioEffectMode effectMode)
描述
设置当前音频流音效模式。
起始版本： 12
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
| OH_AudioStream_AudioEffectMode effectMode | 设置当前音频流的目标音效模式。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioStream_Result | AUDIOSTREAM_SUCCESS：函数执行成功。 AUDIOSTREAM_ERROR_INVALID_PARAM：参数renderer为nullptr。 |
OH_AudioRenderer_GetRendererPrivacy()
OH_AudioStream_Result OH_AudioRenderer_GetRendererPrivacy(OH_AudioRenderer* renderer, OH_AudioStream_PrivacyType* privacy)
描述
查询当前播放音频流是否会被其它应用录制。
起始版本： 12
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
| OH_AudioStream_PrivacyType* privacy | 用于返回当前流的内录策略。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioStream_Result | AUDIOSTREAM_SUCCESS：函数执行成功。 AUDIOSTREAM_ERROR_INVALID_PARAM：参数renderer为nullptr。 |
OH_AudioRenderer_SetSilentModeAndMixWithOthers()
OH_AudioStream_Result OH_AudioRenderer_SetSilentModeAndMixWithOthers(OH_AudioRenderer* renderer, bool on)
描述
设置静音并发播放模式。
当设置为true，打开静音并发播放模式，系统将让此音频流静音播放，并且不会打断其他音频流。设置为false，将关闭静音并发播放，音频流可根据系统焦点策略抢占焦点。
起始版本： 12
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
| bool on | 设置当前音频流的静音并发状态。 true：设置当前播放的音频流静音播放，并且不会打断其它音频流播放。 false：取消当前播放的音频流静音播放，音频流可根据系统焦点策略抢占焦点。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioStream_Result | AUDIOSTREAM_SUCCESS：函数执行成功。 AUDIOSTREAM_ERROR_INVALID_PARAM：参数renderer为nullptr。 |
OH_AudioRenderer_GetSilentModeAndMixWithOthers()
OH_AudioStream_Result OH_AudioRenderer_GetSilentModeAndMixWithOthers(OH_AudioRenderer* renderer, bool* on)
描述
获取当前音频流是否开启静音并发播放。
起始版本： 12
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
| bool* on | 用于返回当前流的静音并发状态。返回true表示打开，返回false表示关闭。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioStream_Result | AUDIOSTREAM_SUCCESS：函数执行成功。 AUDIOSTREAM_ERROR_INVALID_PARAM：参数renderer为nullptr。 |
OH_AudioRenderer_SetDefaultOutputDevice()
OH_AudioStream_Result OH_AudioRenderer_SetDefaultOutputDevice(OH_AudioRenderer* renderer, OH_AudioDevice_Type deviceType)
描述
设置默认本机内置发声设备。
本接口仅适用于音频流类型OH_AudioStream_Usage为语音消息、VoIP语音通话或者VoIP视频通话的场景使用，以及可选的设备类型为听筒、扬声器和系统默认设备。
本接口允许在AudioRenderer创建以后的任何时间被调用，系统会记录应用设置的默认本机内置发声设备。在应用启动播放时，若有外接设备如蓝牙耳机/有线耳机接入，系统优先从外接设备发声；否则系统遵循应用设置的默认本机内置发声设备发声。
设备行为差异： 当该接口在无听筒的设备上设置默认发声设备为听筒时，将继续从扬声器发声。
起始版本： 12
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
| OH_AudioDevice_Type deviceType | 指向OH_AudioDevice_Type用于设置发声设备类型。可设置的设备类型包括: AUDIO_DEVICE_TYPE_EARPIECE：听筒 AUDIO_DEVICE_TYPE_SPEAKER：扬声器 AUDIO_DEVICE_TYPE_DEFAULT：系统默认设备 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioStream_Result | AUDIOSTREAM_SUCCESS：函数执行成功。 AUDIOSTREAM_ERROR_INVALID_PARAM： 1. 参数renderer为nullptr; 2. 参数deviceType无效。 AUDIOSTREAM_ERROR_ILLEGAL_STATE：执行状态异常。 AUDIOSTREAM_ERROR_SYSTEM：出现系统错误。 |
OH_AudioRenderer_OnInterruptCallback()
typedef void (*OH_AudioRenderer_OnInterruptCallback)(OH_AudioRenderer* renderer, void* userData, OH_AudioInterrupt_ForceType type, OH_AudioInterrupt_Hint hint)
描述
音频流中断事件回调函数。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
| void* userData | 指向应用自定义的数据存储区域。 |
| OH_AudioInterrupt_ForceType type | 音频流中断类型。 |
| OH_AudioInterrupt_Hint hint | 音频流中断提示类型。 |
OH_AudioRenderer_OnErrorCallback()
typedef void (*OH_AudioRenderer_OnErrorCallback)(OH_AudioRenderer* renderer, void* userData, OH_AudioStream_Result error)
描述
音频流错误事件回调函数。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
| void* userData | 指向应用自定义的数据存储区域。 |
| OH_AudioStream_Result error | 音频流播放错误结果。 |
OH_AudioRenderer_GetFastStatus()
OH_AudioStream_Result OH_AudioRenderer_GetFastStatus(OH_AudioRenderer* renderer, OH_AudioStream_FastStatus* status)
描述
获取音频播放过程中的运行状态，是否在低时延状态下工作。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
| OH_AudioStream_FastStatus* status | 指向接收低时延状态的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioStream_Result | AUDIOSTREAM_SUCCESS：函数执行成功。 AUDIOSTREAM_ERROR_INVALID_PARAM：参数renderer为nullptr。 AUDIOSTREAM_ERROR_ILLEGAL_STATE：执行状态异常，仅在释放状态之前可用。 |
OH_AudioRenderer_OnFastStatusChange()
typedef void (*OH_AudioRenderer_OnFastStatusChange)(OH_AudioRenderer* renderer, void* userData, OH_AudioStream_FastStatus status
)
描述
音频播放过程中低时延状态改变事件的回调函数。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
| void* userData | 指向应用自定义的数据存储区域。 |
| OH_AudioStream_FastStatus status | 返回当前低时延状态。 |
OH_AudioRenderer_SetLoudnessGain()
OH_AudioStream_Result OH_AudioRenderer_SetLoudnessGain(OH_AudioRenderer* renderer, float loudnessGain)
描述
设置音频播放的响度值。默认的响度值是0.0dB。音频流播放类型必须是音乐OH_AudioStream_Usage.AUDIOSTREAM_USAGE_MUSIC，
电影或视频OH_AudioStream_Usage.AUDIOSTREAM_USAGE_MOVIE，
有声读物（包括听书、相声、评书）、听新闻、播客等OH_AudioStream_Usage.AUDIOSTREAM_USAGE_AUDIOBOOK。
音频流的时延模式必须是普通时延OH_AudioStream_LatencyMode.AUDIOSTREAM_LATENCY_MODE_NORMAL。
本接口不支持通过高清通路播放的音频流设置响度。
由于音频框架与硬件之间存在缓冲区，响度调节实际生效存在延迟，时长取决于缓冲区长度。
建议在不同音频开始播放前预先设置响度，以实现最佳均衡效果。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
| float loudnessGain | 设置播放的响度值（响度值范围为[-90.0, 24.0]，单位为dB）。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioStream_Result | AUDIOSTREAM_SUCCESS：函数执行成功。 AUDIOSTREAM_ERROR_INVALID_PARAM： 1. 参数renderer为nullptr，或音频流不支持设置响度； 2. 参数loudnessGain不在响度值范围内。 |
OH_AudioRenderer_GetLoudnessGain()
OH_AudioStream_Result OH_AudioRenderer_GetLoudnessGain(OH_AudioRenderer* renderer, float* loudnessGain)
描述
获取音频流的响度值。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
| float* loudnessGain | 指向接收播放响度值的变量的指针，单位为分贝。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioStream_Result | AUDIOSTREAM_SUCCESS：函数执行成功。 AUDIOSTREAM_ERROR_INVALID_PARAM： 1. 参数renderer为nullptr； 2. 参数loudnessGain为nullptr。 |
OH_AudioRenderer_OnWriteDataCallbackAdvanced()
typedef int32_t (*OH_AudioRenderer_OnWriteDataCallbackAdvanced)(OH_AudioRenderer* renderer, void* userData, void* audioData, int32_t audioDataSize)
描述
该函数指针将指向用于写入音频数据的回调函数。不同于OH_AudioRenderer_OnWriteDataCallback，此函数允许应用填充[0, audioDataSize]长度的数据。
其中audioDataSize为回调buffer的长度。调用方通过返回值告知系统写入的数据长度。
如果返回0，回调线程将会sleep一段时间。
否则，系统可能会立刻进行下一次回调。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向发生回调的实例。 |
| void* userData | 指向通过回调函数传递的应用数据指针。 |
| void* audioData | 指向让应用填充音频数据的指针。 |
| int32_t audioDataSize | 应用应写入音频数据的数据长度，以字节为单位。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 应用实际填充有效音频数据的长度。返回值必须在[0, audioDataSize]范围内。 如果返回值小于0，系统将调整为0。 并且，如果返回值大于audioDataSize，系统将其调整到audioDataSize。 注意返回值必须是单个采样点大小的整数倍。 比如，双声道s16格式的音频数据，必须是4(2 * 16 / 8)的整数倍。 否则，可能造成播放杂音。 |
OH_AudioRenderer_GetLatency()
OH_AudioStream_Result OH_AudioRenderer_GetLatency(OH_AudioRenderer* renderer, OH_AudioStream_LatencyType type, int32_t* latencyMs)
描述
获取当前音频路由的估算时延（单位：毫秒）。无线连接的音频设备，时延估算可能存在误差，结果仅供参考。
由于时延未计入实时缓冲区，建议仅在音频播放开始时获取，避免频繁调用，否则可能因路由切换而阻塞该接口调用。
当音频数据输出到硬件后，建议使用OH_AudioRenderer_GetAudioTimestampInfo进行音视频同步。
起始版本： 23
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioRenderer* renderer | 指向OH_AudioStreamBuilder_GenerateRenderer创建的音频流实例。 |
| OH_AudioStream_LatencyType type | 要获取的时延类型。 |
| int32_t* latencyMs | 指向用于接收时延（毫秒）变量的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioStream_Result | AUDIOSTREAM_SUCCESS：函数执行成功。 AUDIOSTREAM_ERROR_INVALID_PARAM： 1. 参数renderer为nullptr； 2. 参数latencyMs为nullptr； 3. 参数type无效。 AUDIOSTREAM_ERROR_SYSTEM：系统内部错误，例如音频服务异常。 |