未验证 提交 e06665f6 编写于 作者: L liyan 提交者: Gitee

update zh-cn/device-dev/reference/hdi-apis/_audio_attribute.md.

Signed-off-by: Nli-yan339 <liyan339@h-partners.com>
Signed-off-by: Nliyan <liyan339@h-partners.com>
上级 277a44b2
...@@ -5,7 +5,7 @@ ...@@ -5,7 +5,7 @@
AudioAttribute音频属性接口。 AudioAttribute音频属性接口。
提供音频播放(render)或录音(capture)需要的公共属性驱动能力,包括获取帧(frame)信息、设置采样属性等。 提供音频播放(Render)或录音(Capture)需要的公共属性驱动能力,包括获取帧(frame)信息、设置采样属性等。
**Since:** **Since:**
...@@ -34,8 +34,8 @@ AudioAttribute音频属性接口。 ...@@ -34,8 +34,8 @@ AudioAttribute音频属性接口。
| ([GetCurrentChannelId](#getcurrentchannelid))(AudioHandle&nbsp;handle,&nbsp;uint32_t&nbsp;\*channelId) | 获取音频的数据通道ID | | ([GetCurrentChannelId](#getcurrentchannelid))(AudioHandle&nbsp;handle,&nbsp;uint32_t&nbsp;\*channelId) | 获取音频的数据通道ID |
| ([SetExtraParams](#setextraparams))(AudioHandle&nbsp;handle,&nbsp;const&nbsp;char&nbsp;\*keyValueList) | 设置音频拓展参数 | | ([SetExtraParams](#setextraparams))(AudioHandle&nbsp;handle,&nbsp;const&nbsp;char&nbsp;\*keyValueList) | 设置音频拓展参数 |
| ([GetExtraParams](#getextraparams))(AudioHandle&nbsp;handle,&nbsp;char&nbsp;\*keyValueList) | 获取音频拓展参数 | | ([GetExtraParams](#getextraparams))(AudioHandle&nbsp;handle,&nbsp;char&nbsp;\*keyValueList) | 获取音频拓展参数 |
| ([ReqMmapBuffer](#reqmmapbuffer))(AudioHandle&nbsp;handle,&nbsp;int32_t&nbsp;reqSize,&nbsp;struct&nbsp;AudioMmapBufferDescripter&nbsp;\*desc) | 请求mmap缓冲区 | | ([ReqMmapBuffer](#reqmmapbuffer))(AudioHandle&nbsp;handle,&nbsp;int32_t&nbsp;reqSize,&nbsp;struct&nbsp;AudioMmapBufferDescripter&nbsp;\*desc) | 请求Mmap缓冲区 |
| ([GetMmapPosition](#getmmapposition))(AudioHandle&nbsp;handle,&nbsp;uint64_t&nbsp;\*frames,&nbsp;struct&nbsp;AudioTimeStamp&nbsp;\*time) | 获取当前mmap的读/写位置 | | ([GetMmapPosition](#getmmapposition))(AudioHandle&nbsp;handle,&nbsp;uint64_t&nbsp;\*frames,&nbsp;struct&nbsp;AudioTimeStamp&nbsp;\*time) | 获取当前Mmap的读/写位置 |
| ([AddAudioEffect](#addaudioeffect))(AudioHandle&nbsp;handle,&nbsp;uint64_t&nbsp;effectid) | 添加音频效果算法实例 | | ([AddAudioEffect](#addaudioeffect))(AudioHandle&nbsp;handle,&nbsp;uint64_t&nbsp;effectid) | 添加音频效果算法实例 |
| ([RemoveAudioEffect](#removeaudioeffect))(AudioHandle&nbsp;handle,&nbsp;uint64_t&nbsp;effectid) | 移除音频效果算法实例 | | ([RemoveAudioEffect](#removeaudioeffect))(AudioHandle&nbsp;handle,&nbsp;uint64_t&nbsp;effectid) | 移除音频效果算法实例 |
| ([GetFrameBufferSize](#getframebuffersize))(AudioHandle&nbsp;handle,&nbsp;uint64_t&nbsp;\*bufferSize) | 获取播放或录音的缓冲区大小 | | ([GetFrameBufferSize](#getframebuffersize))(AudioHandle&nbsp;handle,&nbsp;uint64_t&nbsp;\*bufferSize) | 获取播放或录音的缓冲区大小 |
...@@ -53,7 +53,7 @@ int32_t (*AudioAttribute::AddAudioEffect)(AudioHandle handle, uint64_t effectid) ...@@ -53,7 +53,7 @@ int32_t (*AudioAttribute::AddAudioEffect)(AudioHandle handle, uint64_t effectid)
**描述:** **描述:**
添加音频效果算法实例 添加音频效果算法实例
**参数:** **参数:**
...@@ -64,7 +64,7 @@ int32_t (*AudioAttribute::AddAudioEffect)(AudioHandle handle, uint64_t effectid) ...@@ -64,7 +64,7 @@ int32_t (*AudioAttribute::AddAudioEffect)(AudioHandle handle, uint64_t effectid)
**返回:** **返回:**
成功返回值0,失败返回负值 成功返回值0,失败返回负值
### GetCurrentChannelId ### GetCurrentChannelId
...@@ -76,18 +76,18 @@ int32_t(* AudioAttribute::GetCurrentChannelId) (AudioHandle handle, uint32_t *ch ...@@ -76,18 +76,18 @@ int32_t(* AudioAttribute::GetCurrentChannelId) (AudioHandle handle, uint32_t *ch
**描述:** **描述:**
获取音频的数据通道ID 获取音频的数据通道ID
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| handle | 待操作的音频句柄 | | handle | 输入参数,待操作的音频句柄。 |
| channelId | 获取的通道ID保存到channelId中 | | channelId | 输出参数,获取的通道ID保存到channelId中。 |
**返回:** **返回:**
成功返回值0,失败返回负值 成功返回值0,失败返回负值
### GetExtraParams ### GetExtraParams
...@@ -99,18 +99,18 @@ int32_t(* AudioAttribute::GetExtraParams) (AudioHandle handle, char *keyValueLis ...@@ -99,18 +99,18 @@ int32_t(* AudioAttribute::GetExtraParams) (AudioHandle handle, char *keyValueLis
**描述:** **描述:**
获取音频拓展参数 获取音频拓展参数
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| handle | 待操作的音频句柄 | | handle | 输入参数,待操作的音频句柄。 |
| keyValueList | 拓展参数键值对字符串列表,格式为key=value,多个键值对通过分号分割 | | keyValueList | 输出参数,拓展参数键值对字符串列表,格式为key=value,多个键值对通过分号分割。 |
**返回:** **返回:**
成功返回值0,失败返回负值 成功返回值0,失败返回负值
### GetFrameBufferSize ### GetFrameBufferSize
...@@ -122,7 +122,7 @@ int32_t (*AudioAttribute::GetFrameBufferSize)(AudioHandle handle, uint64_t *buff ...@@ -122,7 +122,7 @@ int32_t (*AudioAttribute::GetFrameBufferSize)(AudioHandle handle, uint64_t *buff
**描述:** **描述:**
获取播放或录音的缓冲区大小 获取播放或录音的缓冲区大小
**参数:** **参数:**
...@@ -145,18 +145,18 @@ int32_t(* AudioAttribute::GetFrameCount) (AudioHandle handle, uint64_t *count) ...@@ -145,18 +145,18 @@ int32_t(* AudioAttribute::GetFrameCount) (AudioHandle handle, uint64_t *count)
**描述:** **描述:**
获取音频buffer中的音频帧数 获取音频buffer中的音频帧数
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| handle | 待操作的音频句柄 | | handle | 输入参数,待操作的音频句柄。 |
| count | 一个音频buffer中包含的音频帧数,获取后保存到count中 | | count | 输出参数,一个音频buffer中包含的音频帧数,获取后保存到count中。 |
**返回:** **返回:**
成功返回值0,失败返回负值 成功返回值0,失败返回负值
### GetFrameSize ### GetFrameSize
...@@ -168,20 +168,18 @@ int32_t(* AudioAttribute::GetFrameSize) (AudioHandle handle, uint64_t *size) ...@@ -168,20 +168,18 @@ int32_t(* AudioAttribute::GetFrameSize) (AudioHandle handle, uint64_t *size)
**描述:** **描述:**
获取音频帧(frame)的大小 获取音频帧(frame)的大小,即一帧音频数据的长度(字节数)。
获取一帧音频数据的长度(字节数)
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| handle | 待操作的音频句柄 | | handle | 输入参数,待操作的音频句柄。 |
| size | 获取的音频帧大小(字节数)保存到size中 | | size | 输出参数,获取的音频帧大小(字节数)保存到size中。 |
**返回:** **返回:**
成功返回值0,失败返回负值 成功返回值0,失败返回负值
### GetMmapPosition ### GetMmapPosition
...@@ -193,19 +191,19 @@ int32_t(* AudioAttribute::GetMmapPosition) (AudioHandle handle, uint64_t *frames ...@@ -193,19 +191,19 @@ int32_t(* AudioAttribute::GetMmapPosition) (AudioHandle handle, uint64_t *frames
**描述:** **描述:**
获取当前mmap的读/写位置 获取当前Mmap的读/写位置。
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| handle | 待操作的音频句柄 | | handle | 输入参数,待操作的音频句柄。 |
| frames | 获取的音频帧计数保存到frames中 | | frames | 输出参数,获取的音频帧计数保存到frames中。 |
| time | 获取的关联时间戳保存到time中 | | time | 输出参数,获取的关联时间戳保存到time中。 |
**返回:** **返回:**
成功返回值0,失败返回负值 成功返回值0,失败返回负值
### GetSampleAttributes ### GetSampleAttributes
...@@ -217,14 +215,14 @@ int32_t(* AudioAttribute::GetSampleAttributes) (AudioHandle handle, struct Audio ...@@ -217,14 +215,14 @@ int32_t(* AudioAttribute::GetSampleAttributes) (AudioHandle handle, struct Audio
**描述:** **描述:**
获取音频采样的属性参数 获取音频采样的属性参数
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| handle | 待操作的音频句柄 | | handle | 输入参数,待操作的音频句柄。 |
| attrs | 获取的音频采样属性(例如采样频率、采样精度、通道)保存到attrs中 | | attrs | 输出参数,获取的音频采样属性(例如采样频率、采样精度、通道)保存到attrs中。 |
**返回:** **返回:**
...@@ -244,7 +242,7 @@ int32_t (*AudioAttribute::RemoveAudioEffect)(AudioHandle handle, uint64_t effect ...@@ -244,7 +242,7 @@ int32_t (*AudioAttribute::RemoveAudioEffect)(AudioHandle handle, uint64_t effect
**描述:** **描述:**
移除音频效果算法实例 移除音频效果算法实例
**参数:** **参数:**
...@@ -267,19 +265,19 @@ int32_t(* AudioAttribute::ReqMmapBuffer) (AudioHandle handle, int32_t reqSize, s ...@@ -267,19 +265,19 @@ int32_t(* AudioAttribute::ReqMmapBuffer) (AudioHandle handle, int32_t reqSize, s
**描述:** **描述:**
请求mmap缓冲区 请求Mmap缓冲区。
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| handle | 待操作的音频句柄 | | handle | 输入参数,待操作的音频句柄。 |
| reqSize | 请求缓冲区的大小 | | reqSize | 输入参数,请求缓冲区的大小。 |
| desc | 缓冲区描述符 | | desc | 输出参数,缓冲区描述符。 |
**返回:** **返回:**
成功返回值0,失败返回负值 成功返回值0,失败返回负值
### SetExtraParams ### SetExtraParams
...@@ -291,18 +289,18 @@ int32_t(* AudioAttribute::SetExtraParams) (AudioHandle handle, const char *keyVa ...@@ -291,18 +289,18 @@ int32_t(* AudioAttribute::SetExtraParams) (AudioHandle handle, const char *keyVa
**描述:** **描述:**
设置音频拓展参数 设置音频拓展参数
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| handle | 待操作的音频句柄 | | handle | 输入参数,待操作的音频句柄。 |
| keyValueList | 拓展参数键值对字符串列表,格式为key=value,多个键值对通过分号分割 | | keyValueList | 输入参数,拓展参数键值对字符串列表,格式为key=value,多个键值对通过分号分割。 |
**返回:** **返回:**
成功返回值0,失败返回负值 成功返回值0,失败返回负值
### SetSampleAttributes ### SetSampleAttributes
...@@ -314,18 +312,18 @@ int32_t(* AudioAttribute::SetSampleAttributes) (AudioHandle handle, const struct ...@@ -314,18 +312,18 @@ int32_t(* AudioAttribute::SetSampleAttributes) (AudioHandle handle, const struct
**描述:** **描述:**
设置音频采样的属性参数 设置音频采样的属性参数
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| handle | 待操作的音频句柄 | | handle | 输入参数,待操作的音频句柄。 |
| attrs | 待设置的音频采样属性,例如采样频率、采样精度、通道 | | attrs | 输入参数,待设置的音频采样属性,例如采样频率、采样精度、通道。 |
**返回:** **返回:**
成功返回值0,失败返回负值 成功返回值0,失败返回负值
**参见:** **参见:**
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册