harmony 鸿蒙AudioRender

  • 2022-08-09
  • 浏览 (511)

AudioRender

概述

AudioRender音频播放接口。

提供音频播放支持的驱动能力,包括音频控制、音频属性、音频场景、音频音量、获取硬件延迟时间、播放音频帧数据(Render frame)等。

Since:

1.0

Version:

1.0

相关模块:

Audio

参见:

AudioControl

AudioAttribute

AudioScene

AudioVolume

汇总

Public 属性

名称 描述
control 音频控制能力接口,详情参考AudioControl
attr 音频属性能力接口,详情参考AudioAttribute
scene 音频场景能力接口,详情参考AudioScene
volume 音频音量能力接口,详情参考AudioVolume
(GetLatency)(struct AudioRender *render, uint32_t *ms) 获取音频硬件驱动估计的延迟时间。
(RenderFrame)(struct AudioRender *render, const void *frame, uint64_t requestBytes, uint64_t *replyBytes) 往音频驱动中播放(Render)一帧输出数据(放音,音频下行数据)。
(GetRenderPosition)(struct AudioRender *render, uint64_t *frames, struct AudioTimeStamp *time) 获取音频输出帧数的上一次计数。
(SetRenderSpeed)(struct AudioRender *render, float speed) 设置一个音频的播放速度。
(GetRenderSpeed)(struct AudioRender *render, float *speed) 获取一个音频当前的播放速度。
(SetChannelMode)(struct AudioRender *render, enum AudioChannelMode mode) 设置音频播放的通道模式。
(GetChannelMode)(struct AudioRender *render, enum AudioChannelMode *mode) 获取音频播放当前的通道模式。
(RegCallback )(struct AudioRender *render, RenderCallback callback, void *cookie) 注册音频回调函数,用于放音过程中缓冲区数据写、DrainBuffer完成通知。
(DrainBuffer)(struct AudioRender *render, enum AudioDrainNotifyType *type) 排空缓冲区中的数据。

类成员变量说明

DrainBuffer

int32_t(* AudioRender::DrainBuffer) (struct AudioRender *render, enum AudioDrainNotifyType *type)

描述:

排空缓冲区中的数据。

参数:

名称 描述
render 输入参数,待操作的音频播放接口对象。
type 输入参数,DrainBuffer的操作类型,详情请参考AudioDrainNotifyType

返回:

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

参见:

RegCallback

GetChannelMode

int32_t(* AudioRender::GetChannelMode) (struct AudioRender *render, enum AudioChannelMode *mode)

描述:

获取音频播放当前的通道模式。

参数:

名称 描述
render 输入参数,待操作的音频播放接口对象。
mode 输出参数,获取的通道模式保存到mode中。

返回:

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

参见:

SetChannelMode

GetLatency

int32_t(* AudioRender::GetLatency) (struct AudioRender *render, uint32_t *ms)

描述:

获取音频硬件驱动估计的延迟时间。

参数:

名称 描述
render 输入参数,待操作的音频播放接口对象。
ms 输出参数,获取的延迟时间(单位:毫秒)保存到ms中。

返回:

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

GetRenderPosition

int32_t(* AudioRender::GetRenderPosition) (struct AudioRender *render, uint64_t *frames, struct AudioTimeStamp *time)

描述:

获取音频输出帧数的上一次计数。

参数:

名称 描述
render 输入参数,待操作的音频播放接口对象。
frames 输出参数,获取的音频帧计数保存到frames中。
time 输出参数,获取的关联时间戳保存到time中。

返回:

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

参见:

RenderFrame

GetRenderSpeed

int32_t(* AudioRender::GetRenderSpeed) (struct AudioRender *render, float *speed)

描述:

获取一个音频当前的播放速度。

参数:

名称 描述
render 输入参数,待操作的音频播放接口对象。
speed 输出参数,获取的播放速度保存到speed中。

返回:

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

参见:

SetRenderSpeed

RegCallback

int32_t(* AudioRender::RegCallback) (struct AudioRender *render, RenderCallback callback, void *cookie)

描述:

注册音频回调函数,用于放音过程中缓冲区数据写、DrainBuffer完成通知。

参数:

名称 描述
render 输入参数,待操作的音频播放接口对象。
callback 输入参数,注册的回调函数。
cookie 输入参数,回调函数的入参。

返回:

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

参见:

RegCallback

RenderFrame

int32_t(* AudioRender::RenderFrame) (struct AudioRender *render, const void *frame, uint64_t requestBytes, uint64_t *replyBytes)

描述:

向音频驱动中播放(Render)一帧输出数据(放音,音频下行数据)。

参数:

名称 描述
render 输入参数,待操作的音频播放接口对象。
frame 输入参数,待写入的输出数据的音频frame。
requestBytes 输入参数,待写入的输出数据的音频frame大小(字节数)。
replyBytes 输出参数,实际写入的音频数据长度(字节数),获取后保存到replyBytes中。

返回:

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

SetChannelMode

int32_t(* AudioRender::SetChannelMode) (struct AudioRender *render, enum AudioChannelMode mode)

描述:

设置音频播放的通道模式。

参数:

名称 描述
render 输入参数,待操作的音频播放接口对象。
speed 输入参数,待设置的通道模式。

返回:

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

参见:

GetChannelMode

SetRenderSpeed

int32_t(* AudioRender::SetRenderSpeed) (struct AudioRender *render, float speed)

描述:

设置一个音频的播放速度。

参数:

名称 描述
render 输入参数,待操作的音频播放接口对象。
speed 输入参数,待设置的播放速度。

返回:

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

参见:

GetRenderSpeed

你可能感兴趣的鸿蒙文章

harmony 鸿蒙HDI 参数参考

harmony 鸿蒙ActRecognitionEvent

harmony 鸿蒙Alignment

harmony 鸿蒙AllocInfo

harmony 鸿蒙Audio

harmony 鸿蒙AudioAdapter

harmony 鸿蒙AudioAdapterDescriptor

harmony 鸿蒙AudioAttribute

harmony 鸿蒙AudioCapture

harmony 鸿蒙AudioControl

0  赞