diff --git a/zh-cn/device-dev/reference/hdi-apis/_audio_render.md b/zh-cn/device-dev/reference/hdi-apis/_audio_render.md index c4a172ab2af2c546cb3a33363d254dcebd9b5de6..c7aed448a1393871e2325b41f47be8edeae7bfee 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_audio_render.md +++ b/zh-cn/device-dev/reference/hdi-apis/_audio_render.md @@ -5,7 +5,7 @@ AudioRender音频播放接口。 -提供音频播放支持的驱动能力,包括音频控制、音频属性、音频场景、音频音量、获取硬件延迟时间、播放音频帧数据(render frame)等。 +提供音频播放支持的驱动能力,包括音频控制、音频属性、音频场景、音频音量、获取硬件延迟时间、播放音频帧数据(Render frame)等。 **Since:** @@ -42,7 +42,7 @@ AudioRender音频播放接口。 | scene | 音频场景能力接口,详情参考[AudioScene](_audio_scene.md)。 | | volume | 音频音量能力接口,详情参考[AudioVolume](_audio_volume.md)。 | | ([GetLatency](#getlatency))(struct AudioRender \*render, uint32_t \*ms) | 获取音频硬件驱动估计的延迟时间。 | -| ([RenderFrame](#renderframe))(struct AudioRender \*render, const void \*frame, uint64_t requestBytes, uint64_t \*replyBytes) | 往音频驱动中播放(render)一帧输出数据(放音,音频下行数据)。 | +| ([RenderFrame](#renderframe))(struct AudioRender \*render, const void \*frame, uint64_t requestBytes, uint64_t \*replyBytes) | 往音频驱动中播放(Render)一帧输出数据(放音,音频下行数据)。 | | ([GetRenderPosition](#getrenderposition))(struct AudioRender \*render, uint64_t \*frames, struct AudioTimeStamp \*time) | 获取音频输出帧数的上一次计数。 | | ([SetRenderSpeed](#setrenderspeed))(struct AudioRender \*render, float speed) | 设置一个音频的播放速度。 | | ([GetRenderSpeed](#getrenderspeed))(struct AudioRender \*render, float \*speed) | 获取一个音频当前的播放速度。 | @@ -64,18 +64,18 @@ int32_t(* AudioRender::DrainBuffer) (struct AudioRender *render, enum AudioDrain **描述:** -排空缓冲区中的数据 +排空缓冲区中的数据。 **参数:** | 名称 | 描述 | | -------- | -------- | -| render | 待操作的音频播放接口对象 | -| type | DrainBuffer的操作类型,详情请参考[AudioDrainNotifyType](_audio.md#audiodrainnotifytype)。 | +| render | 输入参数,待操作的音频播放接口对象。 | +| type | 输入参数,DrainBuffer的操作类型,详情请参考[AudioDrainNotifyType](_audio.md#audiodrainnotifytype)。 | **返回:** -成功返回值0,失败返回负值 +成功返回值0,失败返回负值。 **参见:** @@ -91,18 +91,18 @@ int32_t(* AudioRender::GetChannelMode) (struct AudioRender *render, enum AudioCh **描述:** -获取音频播放当前的通道模式 +获取音频播放当前的通道模式。 **参数:** | 名称 | 描述 | | -------- | -------- | -| render | 待操作的音频播放接口对象 | -| mode | 获取的通道模式保存到mode中 | +| render | 输入参数,待操作的音频播放接口对象。| +| mode | 输出参数,获取的通道模式保存到mode中。 | **返回:** -成功返回值0,失败返回负值 +成功返回值0,失败返回负值。 **参见:** @@ -118,18 +118,18 @@ int32_t(* AudioRender::GetLatency) (struct AudioRender *render, uint32_t *ms) **描述:** -获取音频硬件驱动估计的延迟时间 +获取音频硬件驱动估计的延迟时间。 **参数:** | 名称 | 描述 | | -------- | -------- | -| render | 待操作的音频播放接口对象 | -| ms | 获取的延迟时间(单位:毫秒)保存到ms中 | +| render | 输入参数,待操作的音频播放接口对象。 | +| ms | 输出参数,获取的延迟时间(单位:毫秒)保存到ms中。 | **返回:** -成功返回值0,失败返回负值 +成功返回值0,失败返回负值。 ### GetRenderPosition @@ -141,19 +141,19 @@ int32_t(* AudioRender::GetRenderPosition) (struct AudioRender *render, uint64_t **描述:** -获取音频输出帧数的上一次计数 +获取音频输出帧数的上一次计数。 **参数:** | 名称 | 描述 | | -------- | -------- | -| render | 待操作的音频播放接口对象 | -| frames | 获取的音频帧计数保存到frames中 | -| time | 获取的关联时间戳保存到time中 | +| render | 输入参数,待操作的音频播放接口对象。 | +| frames | 输出参数,获取的音频帧计数保存到frames中。 | +| time | 输出参数,获取的关联时间戳保存到time中。 | **返回:** -成功返回值0,失败返回负值 +成功返回值0,失败返回负值。 **参见:** @@ -169,18 +169,18 @@ int32_t(* AudioRender::GetRenderSpeed) (struct AudioRender *render, float *speed **描述:** -获取一个音频当前的播放速度 +获取一个音频当前的播放速度。 **参数:** | 名称 | 描述 | | -------- | -------- | -| render | 待操作的音频播放接口对象 | -| speed | 获取的播放速度保存到speed中 | +| render | 输入参数,待操作的音频播放接口对象。 | +| speed | 输出参数,获取的播放速度保存到speed中。 | **返回:** -成功返回值0,失败返回负值 +成功返回值0,失败返回负值。 **参见:** @@ -196,19 +196,19 @@ int32_t(* AudioRender::RegCallback) (struct AudioRender *render, RenderCallback **描述:** -注册音频回调函数,用于放音过程中缓冲区数据写、DrainBuffer完成通知 +注册音频回调函数,用于放音过程中缓冲区数据写、DrainBuffer完成通知。 **参数:** | 名称 | 描述 | | -------- | -------- | -| render | 待操作的音频播放接口对象 | -| callback | 注册的回调函数 | -| cookie | 回调函数的入参 | +| render | 输入参数,待操作的音频播放接口对象。 | +| callback | 输入参数,注册的回调函数。 | +| cookie | 输入参数,回调函数的入参。 | **返回:** -成功返回值0,失败返回负值 +成功返回值0,失败返回负值。 **参见:** @@ -224,20 +224,20 @@ int32_t(* AudioRender::RenderFrame) (struct AudioRender *render, const void *fra **描述:** -往音频驱动中播放(render)一帧输出数据(放音,音频下行数据) +向音频驱动中播放(Render)一帧输出数据(放音,音频下行数据)。 **参数:** | 名称 | 描述 | | -------- | -------- | -| render | 待操作的音频播放接口对象 | -| frame | 待写入的输出数据的音频frame | -| requestBytes | 待写入的输出数据的音频frame大小(字节数) | -| replyBytes | 实际写入的音频数据长度(字节数),获取后保存到replyBytes中 | +| render | 输入参数,待操作的音频播放接口对象。 | +| frame | 输入参数,待写入的输出数据的音频frame。 | +| requestBytes | 输入参数,待写入的输出数据的音频frame大小(字节数)。 | +| replyBytes | 输出参数,实际写入的音频数据长度(字节数),获取后保存到replyBytes中。 | **返回:** -成功返回值0,失败返回负值 +成功返回值0,失败返回负值。 ### SetChannelMode @@ -249,18 +249,18 @@ int32_t(* AudioRender::SetChannelMode) (struct AudioRender *render, enum AudioCh **描述:** -设置音频播放的通道模式 +设置音频播放的通道模式。 **参数:** | 名称 | 描述 | | -------- | -------- | -| render | 待操作的音频播放接口对象 | -| speed | 待设置的通道模式 | +| render | 输入参数,待操作的音频播放接口对象。 | +| speed | 输入参数,待设置的通道模式。 | **返回:** -成功返回值0,失败返回负值 +成功返回值0,失败返回负值。 **参见:** @@ -276,18 +276,18 @@ int32_t(* AudioRender::SetRenderSpeed) (struct AudioRender *render, float speed) **描述:** -设置一个音频的播放速度 +设置一个音频的播放速度。 **参数:** | 名称 | 描述 | | -------- | -------- | -| render | 待操作的音频播放接口对象 | -| speed | 待设置的播放速度 | +| render | 输入参数,待操作的音频播放接口对象。 | +| speed | 输入参数,待设置的播放速度。 | **返回:** -成功返回值0,失败返回负值 +成功返回值0,失败返回负值。 **参见:**