Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
d398236b
D
Docs
项目概览
OpenHarmony
/
Docs
大约 1 年 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
d398236b
编写于
10月 14, 2022
作者:
O
openharmony_ci
提交者:
Gitee
10月 14, 2022
浏览文件
操作
浏览文件
下载
差异文件
!10628 修改大小写、标点符号、删除多余信息等。
Merge pull request !10628 from liyan/master
上级
84b2fc10
d6f2731d
变更
17
隐藏空白更改
内联
并排
Showing
17 changed file
with
227 addition
and
234 deletion
+227
-234
zh-cn/device-dev/reference/hdi-apis/_alloc_info.md
zh-cn/device-dev/reference/hdi-apis/_alloc_info.md
+1
-1
zh-cn/device-dev/reference/hdi-apis/_audio_adapter.md
zh-cn/device-dev/reference/hdi-apis/_audio_adapter.md
+27
-27
zh-cn/device-dev/reference/hdi-apis/_audio_attribute.md
zh-cn/device-dev/reference/hdi-apis/_audio_attribute.md
+44
-46
zh-cn/device-dev/reference/hdi-apis/_audio_capture.md
zh-cn/device-dev/reference/hdi-apis/_audio_capture.md
+12
-12
zh-cn/device-dev/reference/hdi-apis/_audio_control.md
zh-cn/device-dev/reference/hdi-apis/_audio_control.md
+22
-22
zh-cn/device-dev/reference/hdi-apis/_audio_manager.md
zh-cn/device-dev/reference/hdi-apis/_audio_manager.md
+17
-17
zh-cn/device-dev/reference/hdi-apis/_audio_mmap_buffer_descripter.md
...e-dev/reference/hdi-apis/_audio_mmap_buffer_descripter.md
+3
-3
zh-cn/device-dev/reference/hdi-apis/_audio_render.md
zh-cn/device-dev/reference/hdi-apis/_audio_render.md
+42
-42
zh-cn/device-dev/reference/hdi-apis/_audio_scene.md
zh-cn/device-dev/reference/hdi-apis/_audio_scene.md
+12
-12
zh-cn/device-dev/reference/hdi-apis/_audio_volume.md
zh-cn/device-dev/reference/hdi-apis/_audio_volume.md
+30
-30
zh-cn/device-dev/reference/hdi-apis/_ext_data_handle.md
zh-cn/device-dev/reference/hdi-apis/_ext_data_handle.md
+1
-1
zh-cn/device-dev/reference/hdi-apis/_i_wlan_interface_8idl.md
...n/device-dev/reference/hdi-apis/_i_wlan_interface_8idl.md
+1
-3
zh-cn/device-dev/reference/hdi-apis/_wlan_types_8idl.md
zh-cn/device-dev/reference/hdi-apis/_wlan_types_8idl.md
+0
-2
zh-cn/device-dev/reference/hdi-apis/codec__component__type_h.md
...device-dev/reference/hdi-apis/codec__component__type_h.md
+0
-1
zh-cn/device-dev/reference/hdi-apis/display__type_8h.md
zh-cn/device-dev/reference/hdi-apis/display__type_8h.md
+1
-1
zh-cn/device-dev/reference/hdi-apis/input__type_8h.md
zh-cn/device-dev/reference/hdi-apis/input__type_8h.md
+11
-11
zh-cn/device-dev/reference/hdi-apis/sensor.md
zh-cn/device-dev/reference/hdi-apis/sensor.md
+3
-3
未找到文件。
zh-cn/device-dev/reference/hdi-apis/_alloc_info.md
浏览文件 @
d398236b
...
...
@@ -3,7 +3,7 @@
## **概述**
定义
关于要
分配的内存的信息。
定义
待
分配的内存的信息。
**相关模块:**
...
...
zh-cn/device-dev/reference/hdi-apis/_audio_adapter.md
浏览文件 @
d398236b
...
...
@@ -5,7 +5,7 @@
AudioAdapter音频适配器接口。
提供音频适配器(声卡)对外支持的驱动能力,包括初始化端口、创建
render、创建c
apture、获取端口能力集等。
提供音频适配器(声卡)对外支持的驱动能力,包括初始化端口、创建
Render、创建C
apture、获取端口能力集等。
**Since:**
...
...
@@ -34,15 +34,15 @@ AudioAdapter音频适配器接口。
| 名称 | 描述 |
| -------- | -------- |
| (
[
InitAllPorts
](
#initallports
)
)(struct
AudioAdapter
\*
adapter) | 初始化一个音频适配器所有的端口驱动 |
| (
[
CreateRender
](
#createrender
)
)(struct
AudioAdapter
\*adapter,
const
struct
AudioDeviceDescriptor
\*desc,
const
struct
AudioSampleAttributes
\*attrs,
struct
AudioRender
\*\*
render) | 创建一个音频播放(
r
ender)接口的对象 |
| (
[
DestroyRender
](
#destroyrender
)
)(struct
AudioAdapter
\*adapter,
struct
AudioRender
\*
render) | 销毁一个音频播放(
r
ender)接口的对象 |
| (
[
CreateCapture
](
#createcapture
)
)(struct
AudioAdapter
\*adapter,
const
struct
AudioDeviceDescriptor
\*desc,
const
struct
AudioSampleAttributes
\*attrs,
struct
AudioCapture
\*\*
capture) | 创建一个音频录音(
c
apture)接口的对象 |
| (
[
DestroyCapture
](
#destroycapture
)
)(struct
AudioAdapter
\*adapter,
struct
AudioCapture
\*
capture) | 销毁一个音频录音(
c
apture)接口的对象 |
| (
[
CreateRender
](
#createrender
)
)(struct
AudioAdapter
\*adapter,
const
struct
AudioDeviceDescriptor
\*desc,
const
struct
AudioSampleAttributes
\*attrs,
struct
AudioRender
\*\*
render) | 创建一个音频播放(
R
ender)接口的对象 |
| (
[
DestroyRender
](
#destroyrender
)
)(struct
AudioAdapter
\*adapter,
struct
AudioRender
\*
render) | 销毁一个音频播放(
R
ender)接口的对象 |
| (
[
CreateCapture
](
#createcapture
)
)(struct
AudioAdapter
\*adapter,
const
struct
AudioDeviceDescriptor
\*desc,
const
struct
AudioSampleAttributes
\*attrs,
struct
AudioCapture
\*\*
capture) | 创建一个音频录音(
C
apture)接口的对象 |
| (
[
DestroyCapture
](
#destroycapture
)
)(struct
AudioAdapter
\*adapter,
struct
AudioCapture
\*
capture) | 销毁一个音频录音(
C
apture)接口的对象 |
| (
[
GetPortCapability
](
#getportcapability
)
)(struct
AudioAdapter
\*adapter,
struct
AudioPort
\*port,
struct
AudioPortCapability
\*
capability) | 获取一个音频适配器的端口驱动的能力集 |
| (
[
SetPassthroughMode
](
#setpassthroughmode
)
)(struct
AudioAdapter
\*adapter,
struct
AudioPort
\*port,
enum
AudioPortPassthroughMode
mode) | 设置音频端口驱动的数据透传模式 |
| (
[
GetPassthroughMode
](
#getpassthroughmode
)
)(struct
AudioAdapter
\*adapter,
struct
AudioPort
\*port,
enum
AudioPortPassthroughMode
\*
mode) | 获取音频端口驱动的数据透传模式 |
| (
[
UpdateAudioRoute
](
#updateaudioroute
)
)(struct
AudioAdapter
\*adapter,
const
struct
AudioRoute
\*route,
int32_t
\*
routeHandle) | 更新一个或多个发送端和接受端之间的路由 |
| (
[
ReleaseAudioRoute
](
#releaseaudioroute
)
)(struct
AudioAdapter
\*adapter,
int32_t
routeHandle) | 释放一个音频路由
.
|
| (
[
ReleaseAudioRoute
](
#releaseaudioroute
)
)(struct
AudioAdapter
\*adapter,
int32_t
routeHandle) | 释放一个音频路由 |
## **类成员变量说明**
...
...
@@ -57,7 +57,7 @@ int32_t(* AudioAdapter::CreateCapture) (struct AudioAdapter *adapter, const stru
**描述:**
创建一个音频录音(
capture)接口的对象
创建一个音频录音(
Capture)接口的对象。
**参数:**
...
...
@@ -70,7 +70,7 @@ int32_t(* AudioAdapter::CreateCapture) (struct AudioAdapter *adapter, const stru
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
**参见:**
...
...
@@ -88,7 +88,7 @@ int32_t(* AudioAdapter::CreateRender) (struct AudioAdapter *adapter, const struc
**描述:**
创建一个音频播放(
render)接口的对象
创建一个音频播放(
Render)接口的对象。
**参数:**
...
...
@@ -101,7 +101,7 @@ int32_t(* AudioAdapter::CreateRender) (struct AudioAdapter *adapter, const struc
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
**参见:**
...
...
@@ -119,7 +119,7 @@ int32_t(* AudioAdapter::DestroyCapture) (struct AudioAdapter *adapter, struct Au
**描述:**
销毁一个音频录音(
capture)接口的对象
销毁一个音频录音(
Capture)接口的对象。
**参数:**
...
...
@@ -130,11 +130,11 @@ int32_t(* AudioAdapter::DestroyCapture) (struct AudioAdapter *adapter, struct Au
**注意:**
在音频录音过程中,不能销毁该接口对象
在音频录音过程中,不能销毁该接口对象
。
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
**参见:**
...
...
@@ -150,7 +150,7 @@ int32_t(* AudioAdapter::DestroyRender) (struct AudioAdapter *adapter, struct Aud
**描述:**
销毁一个音频播放(
render)接口的对象
销毁一个音频播放(
Render)接口的对象。
**参数:**
...
...
@@ -165,7 +165,7 @@ int32_t(* AudioAdapter::DestroyRender) (struct AudioAdapter *adapter, struct Aud
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
**参见:**
...
...
@@ -181,7 +181,7 @@ int(* AudioAdapter::GetPassthroughMode) (struct AudioAdapter *adapter, struct Au
**描述:**
获取音频端口驱动的数据透传模式
获取音频端口驱动的数据透传模式
。
**参数:**
...
...
@@ -193,7 +193,7 @@ int(* AudioAdapter::GetPassthroughMode) (struct AudioAdapter *adapter, struct Au
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
**参见:**
...
...
@@ -209,7 +209,7 @@ int(* AudioAdapter::GetPortCapability) (struct AudioAdapter *adapter, struct Aud
**描述:**
获取一个音频适配器的端口驱动的能力集
获取一个音频适配器的端口驱动的能力集
。
**参数:**
...
...
@@ -221,7 +221,7 @@ int(* AudioAdapter::GetPortCapability) (struct AudioAdapter *adapter, struct Aud
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
### InitAllPorts
...
...
@@ -249,7 +249,7 @@ int(* AudioAdapter::InitAllPorts) (struct AudioAdapter *adapter)
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
### ReleaseAudioRoute
...
...
@@ -261,18 +261,18 @@ int32_t(* AudioAdapter::ReleaseAudioRoute) (struct AudioAdapter *adapter, int32_
**描述:**
释放一个音频路由
.
释放一个音频路由
。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| adapter | 待操作的音频适配器对象 |
| routeHandle | 待释放的路由句柄
.
|
| routeHandle | 待释放的路由句柄 |
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
### SetPassthroughMode
...
...
@@ -284,7 +284,7 @@ int(* AudioAdapter::SetPassthroughMode) (struct AudioAdapter *adapter, struct Au
**描述:**
设置音频端口驱动的数据透传模式
设置音频端口驱动的数据透传模式
。
**参数:**
...
...
@@ -296,7 +296,7 @@ int(* AudioAdapter::SetPassthroughMode) (struct AudioAdapter *adapter, struct Au
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
**参见:**
...
...
@@ -312,7 +312,7 @@ int32_t(* AudioAdapter::UpdateAudioRoute) (struct AudioAdapter *adapter, const s
**描述:**
更新一个或多个发送端和接受端之间的路由
更新一个或多个发送端和接受端之间的路由
。
**参数:**
...
...
@@ -324,4 +324,4 @@ int32_t(* AudioAdapter::UpdateAudioRoute) (struct AudioAdapter *adapter, const s
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
zh-cn/device-dev/reference/hdi-apis/_audio_attribute.md
浏览文件 @
d398236b
...
...
@@ -5,7 +5,7 @@
AudioAttribute音频属性接口。
提供音频播放(
render)或录音(c
apture)需要的公共属性驱动能力,包括获取帧(frame)信息、设置采样属性等。
提供音频播放(
Render)或录音(C
apture)需要的公共属性驱动能力,包括获取帧(frame)信息、设置采样属性等。
**Since:**
...
...
@@ -34,8 +34,8 @@ AudioAttribute音频属性接口。
| (
[
GetCurrentChannelId
](
#getcurrentchannelid
)
)(AudioHandle
handle,
uint32_t
\*
channelId) | 获取音频的数据通道ID |
| (
[
SetExtraParams
](
#setextraparams
)
)(AudioHandle
handle,
const
char
\*
keyValueList) | 设置音频拓展参数 |
| (
[
GetExtraParams
](
#getextraparams
)
)(AudioHandle
handle,
char
\*
keyValueList) | 获取音频拓展参数 |
| (
[
ReqMmapBuffer
](
#reqmmapbuffer
)
)(AudioHandle
handle,
int32_t
reqSize,
struct
AudioMmapBufferDescripter
\*
desc) | 请求
m
map缓冲区 |
| (
[
GetMmapPosition
](
#getmmapposition
)
)(AudioHandle
handle,
uint64_t
\*frames,
struct
AudioTimeStamp
\*
time) | 获取当前
m
map的读/写位置 |
| (
[
ReqMmapBuffer
](
#reqmmapbuffer
)
)(AudioHandle
handle,
int32_t
reqSize,
struct
AudioMmapBufferDescripter
\*
desc) | 请求
M
map缓冲区 |
| (
[
GetMmapPosition
](
#getmmapposition
)
)(AudioHandle
handle,
uint64_t
\*frames,
struct
AudioTimeStamp
\*
time) | 获取当前
M
map的读/写位置 |
| (
[
AddAudioEffect
](
#addaudioeffect
)
)(AudioHandle
handle,
uint64_t
effectid) | 添加音频效果算法实例 |
| (
[
RemoveAudioEffect
](
#removeaudioeffect
)
)(AudioHandle
handle,
uint64_t
effectid) | 移除音频效果算法实例 |
| (
[
GetFrameBufferSize
](
#getframebuffersize
)
)(AudioHandle
handle,
uint64_t
\*
bufferSize) | 获取播放或录音的缓冲区大小 |
...
...
@@ -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)
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
### GetCurrentChannelId
...
...
@@ -76,18 +76,18 @@ int32_t(* AudioAttribute::GetCurrentChannelId) (AudioHandle handle, uint32_t *ch
**描述:**
获取音频的数据通道ID
获取音频的数据通道ID
。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle |
待操作的音频句柄
|
| channelId |
获取的通道ID保存到channelId中
|
| handle |
输入参数,待操作的音频句柄。
|
| channelId |
输出参数,获取的通道ID保存到channelId中。
|
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
### GetExtraParams
...
...
@@ -99,18 +99,18 @@ int32_t(* AudioAttribute::GetExtraParams) (AudioHandle handle, char *keyValueLis
**描述:**
获取音频拓展参数
获取音频拓展参数
。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle |
待操作的音频句柄
|
| keyValueList |
拓展参数键值对字符串列表,格式为key=value,多个键值对通过分号分割
|
| handle |
输入参数,待操作的音频句柄。
|
| keyValueList |
输出参数,拓展参数键值对字符串列表,格式为key=value,多个键值对通过分号分割。
|
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
### GetFrameBufferSize
...
...
@@ -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)
**描述:**
获取音频buffer中的音频帧数
获取音频buffer中的音频帧数
。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle |
待操作的音频句柄
|
| count |
一个音频buffer中包含的音频帧数,获取后保存到count中
|
| handle |
输入参数,待操作的音频句柄。
|
| count |
输出参数,一个音频buffer中包含的音频帧数,获取后保存到count中。
|
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
### GetFrameSize
...
...
@@ -168,20 +168,18 @@ int32_t(* AudioAttribute::GetFrameSize) (AudioHandle handle, uint64_t *size)
**描述:**
获取音频帧(frame)的大小
获取一帧音频数据的长度(字节数)
获取音频帧(frame)的大小,即一帧音频数据的长度(字节数)。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle |
待操作的音频句柄
|
| size |
获取的音频帧大小(字节数)保存到size中
|
| handle |
输入参数,待操作的音频句柄。
|
| size |
输出参数,获取的音频帧大小(字节数)保存到size中。
|
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
### GetMmapPosition
...
...
@@ -193,19 +191,19 @@ int32_t(* AudioAttribute::GetMmapPosition) (AudioHandle handle, uint64_t *frames
**描述:**
获取当前
mmap的读/写位置
获取当前
Mmap的读/写位置。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle |
待操作的音频句柄
|
| frames |
获取的音频帧计数保存到frames中
|
| time |
获取的关联时间戳保存到time中
|
| handle |
输入参数,待操作的音频句柄。
|
| frames |
输出参数,获取的音频帧计数保存到frames中。
|
| time |
输出参数,获取的关联时间戳保存到time中。
|
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
### GetSampleAttributes
...
...
@@ -217,14 +215,14 @@ int32_t(* AudioAttribute::GetSampleAttributes) (AudioHandle handle, struct Audio
**描述:**
获取音频采样的属性参数
获取音频采样的属性参数
。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle |
待操作的音频句柄
|
| attrs |
获取的音频采样属性(例如采样频率、采样精度、通道)保存到attrs中
|
| handle |
输入参数,待操作的音频句柄。
|
| attrs |
输出参数,获取的音频采样属性(例如采样频率、采样精度、通道)保存到attrs中。
|
**返回:**
...
...
@@ -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
**描述:**
请求
mmap缓冲区
请求
Mmap缓冲区。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle |
待操作的音频句柄
|
| reqSize |
请求缓冲区的大小
|
| desc |
缓冲区描述符
|
| handle |
输入参数,待操作的音频句柄。
|
| reqSize |
输入参数,请求缓冲区的大小。
|
| desc |
输出参数,缓冲区描述符。
|
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
### SetExtraParams
...
...
@@ -291,18 +289,18 @@ int32_t(* AudioAttribute::SetExtraParams) (AudioHandle handle, const char *keyVa
**描述:**
设置音频拓展参数
设置音频拓展参数
。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle |
待操作的音频句柄
|
| keyValueList |
拓展参数键值对字符串列表,格式为key=value,多个键值对通过分号分割
|
| handle |
输入参数,待操作的音频句柄。
|
| keyValueList |
输入参数,拓展参数键值对字符串列表,格式为key=value,多个键值对通过分号分割。
|
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
### SetSampleAttributes
...
...
@@ -314,18 +312,18 @@ int32_t(* AudioAttribute::SetSampleAttributes) (AudioHandle handle, const struct
**描述:**
设置音频采样的属性参数
设置音频采样的属性参数
。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle |
待操作的音频句柄
|
| attrs |
待设置的音频采样属性,例如采样频率、采样精度、通道
|
| handle |
输入参数,待操作的音频句柄。
|
| attrs |
输入参数,待设置的音频采样属性,例如采样频率、采样精度、通道。
|
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
**参见:**
...
...
zh-cn/device-dev/reference/hdi-apis/_audio_capture.md
浏览文件 @
d398236b
...
...
@@ -21,7 +21,7 @@ AudioCapture录音接口。
| attr | 音频属性能力接口,详情参考
[
AudioAttribute
](
_audio_attribute.md
)
。 |
| scene | 音频场景能力接口,详情参考
[
AudioScene
](
_audio_scene.md
)
。 |
| volume | 音频音量能力接口,详情参考
[
AudioVolume
](
_audio_volume.md
)
。 |
| (
[
CaptureFrame
](
#captureframe
)
)(struct
AudioCapture
\*capture,
void
\*frame,
uint64_t
requestBytes,
uint64_t
\*
replyBytes) | 从音频驱动中录制(
c
apture)一帧输入数据(录音,音频上行数据)。 |
| (
[
CaptureFrame
](
#captureframe
)
)(struct
AudioCapture
\*capture,
void
\*frame,
uint64_t
requestBytes,
uint64_t
\*
replyBytes) | 从音频驱动中录制(
C
apture)一帧输入数据(录音,音频上行数据)。 |
| (
[
GetCapturePosition
](
#getcaptureposition
)
)(struct
AudioCapture
\*capture,
uint64_t
\*frames,
struct
AudioTimeStamp
\*
time) | 获取音频输入帧数的上一次计数。 |
...
...
@@ -37,20 +37,20 @@ int32_t(* AudioCapture::CaptureFrame) (struct AudioCapture *capture, void *frame
**描述:**
从音频驱动中录制(
capture)一帧输入数据(录音,音频上行数据)
从音频驱动中录制(
Capture)一帧输入数据(录音,音频上行数据)。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| capture |
待操作的音频录音接口对象
|
| frame |
待存放输入数据的音频frame
|
| requestBytes |
待存放输入数据的音频frame大小(字节数)
|
| replyBytes |
实际读取到的音频数据长度(字节数),获取后保存到replyBytes中
|
| capture |
输入参数,待操作的音频录音接口对象。
|
| frame |
输入参数,待存放输入数据的音频frame。
|
| requestBytes |
输入参数,待存放输入数据的音频frame大小(字节数)。
|
| replyBytes |
输出参数,实际读取到的音频数据长度(字节数),获取后保存到replyBytes中。
|
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
### GetCapturePosition
...
...
@@ -62,19 +62,19 @@ int32_t(* AudioCapture::GetCapturePosition) (struct AudioCapture *capture, uint6
**描述:**
获取音频输入帧数的上一次计数
获取音频输入帧数的上一次计数
。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| capture |
待操作的音频录音接口对象
|
| frames |
获取的音频帧计数保存到frames中
|
| time |
获取的关联时间戳保存到time中
|
| capture |
输入参数,待操作的音频录音接口对象。
|
| frames |
输出参数,获取的音频帧计数保存到frames中。
|
| time |
输出参数,获取的关联时间戳保存到time中。
|
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
**参见:**
...
...
zh-cn/device-dev/reference/hdi-apis/_audio_control.md
浏览文件 @
d398236b
...
...
@@ -3,9 +3,9 @@
## **概述**
AudioControl音频控制接口
AudioControl音频控制接口
。
提供音频播放(
render)或录音(c
apture)需要的公共控制驱动能力,包括Start、Stop、Pause、Resume、Flush等。
提供音频播放(
Render)或录音(C
apture)需要的公共控制驱动能力,包括Start、Stop、Pause、Resume、Flush等。
**Since:**
...
...
@@ -27,13 +27,13 @@ AudioControl音频控制接口
| 名称 | 描述 |
| -------- | -------- |
| (
[
Start
](
#start
)
)(AudioHandle
handle) | 启动一个音频播放(
render)或录音(capture)处理
|
| (
[
Stop
](
#stop
)
)(AudioHandle
handle) | 停止一个音频播放(
render)或录音(capture)处理
|
| (
[
Pause
](
#pause
)
)(AudioHandle
handle) | 暂停一个音频播放(
render)或录音(capture)处理
|
| (
[
Resume
](
#resume
)
)(AudioHandle
handle) | 恢复一个音频播放(
render)或录音(capture)处理
|
| (
[
Flush
](
#flush
)
)(AudioHandle
handle) | 刷新音频缓冲区buffer中的数据 |
| (
[
TurnStandbyMode
](
#turnstandbymode
)
)(AudioHandle
handle) | 设置或去设置设备的待机模式 |
| (
[
AudioDevDump
](
#audiodevdump
)
)(AudioHandle
handle,
int32_t
range,
int32_t
fd) | Dump音频设备信息 |
| (
[
Start
](
#start
)
)(AudioHandle
handle) | 启动一个音频播放(
Render)或录音(Capture)处理。
|
| (
[
Stop
](
#stop
)
)(AudioHandle
handle) | 停止一个音频播放(
Render)或录音(Capture)处理。
|
| (
[
Pause
](
#pause
)
)(AudioHandle
handle) | 暂停一个音频播放(
Render)或录音(Capture)处理。
|
| (
[
Resume
](
#resume
)
)(AudioHandle
handle) | 恢复一个音频播放(
Render)或录音(Capture)处理。
|
| (
[
Flush
](
#flush
)
)(AudioHandle
handle) | 刷新音频缓冲区buffer中的数据
。
|
| (
[
TurnStandbyMode
](
#turnstandbymode
)
)(AudioHandle
handle) | 设置或去设置设备的待机模式
。
|
| (
[
AudioDevDump
](
#audiodevdump
)
)(AudioHandle
handle,
int32_t
range,
int32_t
fd) | Dump音频设备信息
。
|
## **类成员变量说明**
...
...
@@ -48,7 +48,7 @@ int32_t(* AudioControl::AudioDevDump) (AudioHandle handle, int32_t range, int32_
**描述:**
Dump音频设备信息
Dump音频设备信息
。
**参数:**
...
...
@@ -60,7 +60,7 @@ Dump音频设备信息
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
### Flush
...
...
@@ -72,7 +72,7 @@ int32_t(* AudioControl::Flush) (AudioHandle handle)
**描述:**
刷新音频缓冲区buffer中的数据
刷新音频缓冲区buffer中的数据
。
**参数:**
...
...
@@ -82,7 +82,7 @@ int32_t(* AudioControl::Flush) (AudioHandle handle)
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
### Pause
...
...
@@ -94,7 +94,7 @@ int32_t(* AudioControl::Pause) (AudioHandle handle)
**描述:**
暂停一个音频播放(
render)或录音(capture)处理
暂停一个音频播放(
Render)或录音(Capture)处理。
**参数:**
...
...
@@ -104,7 +104,7 @@ int32_t(* AudioControl::Pause) (AudioHandle handle)
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
**参见:**
...
...
@@ -120,7 +120,7 @@ int32_t(* AudioControl::Resume) (AudioHandle handle)
**描述:**
恢复一个音频播放(
render)或录音(capture)处理
恢复一个音频播放(
Render)或录音(Capture)处理。
**参数:**
...
...
@@ -130,7 +130,7 @@ int32_t(* AudioControl::Resume) (AudioHandle handle)
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
**参见:**
...
...
@@ -146,7 +146,7 @@ int32_t(* AudioControl::Start) (AudioHandle handle)
**描述:**
启动一个音频播放(
render)或录音(capture)处理
启动一个音频播放(
Render)或录音(Capture)处理。
**参数:**
...
...
@@ -156,7 +156,7 @@ int32_t(* AudioControl::Start) (AudioHandle handle)
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
**参见:**
...
...
@@ -172,7 +172,7 @@ int32_t(* AudioControl::Stop) (AudioHandle handle)
**描述:**
停止一个音频播放(
render)或录音(capture)处理
停止一个音频播放(
Render)或录音(Capture)处理。
**参数:**
...
...
@@ -182,7 +182,7 @@ int32_t(* AudioControl::Stop) (AudioHandle handle)
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
**参见:**
...
...
@@ -198,7 +198,7 @@ int32_t(* AudioControl::TurnStandbyMode) (AudioHandle handle)
**描述:**
设置或去设置设备的待机模式
设置或去设置设备的待机模式
。
**参数:**
...
...
zh-cn/device-dev/reference/hdi-apis/_audio_manager.md
浏览文件 @
d398236b
...
...
@@ -49,19 +49,19 @@ int(* AudioManager::GetAllAdapters) (struct AudioAdapterManager *manager, struct
**描述:**
获取音频驱动中支持的所有适配器的列表
获取音频驱动中支持的所有适配器的列表
。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| manager |
待操作的音频管理接口对象
|
| descs |
获取到的音频适配器列表保存到descs中
|
| size |
获取到的音频适配器列表的长度保存到size中
|
| manager |
输入参数,待操作的音频管理接口对象。
|
| descs |
输出参数,获取到的音频适配器列表保存到descs中。
|
| size |
输出参数,获取到的音频适配器列表的长度保存到size中。
|
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
**参见:**
...
...
@@ -77,21 +77,21 @@ int(* AudioManager::LoadAdapter) (struct AudioAdapterManager *manager, const str
**描述:**
加载一个音频适配器(声卡)的驱动
加载一个音频适配器(声卡)的驱动
。
加载一个具体的音频驱动,例如
usb驱动,在具体实现中可能加载的是一个动态链接库(
\*
.so)
加载一个具体的音频驱动,例如
USB驱动,在具体实现中可能加载的是一个动态链接库(
\*
.so)。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| manager |
待操作的音频管理接口对象
|
| desc |
待加载的音频适配器描述符
|
| adapter |
获取的音频适配器接口的对象实例保存到adapter中
|
| manager |
输入参数,待操作的音频管理接口对象。
|
| desc |
输入参数,待加载的音频适配器描述符。
|
| adapter |
输出参数,获取的音频适配器接口的对象实例保存到adapter中。
|
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
**参见:**
...
...
@@ -109,17 +109,17 @@ bool(* AudioManager::ReleaseAudioManagerObject) (struct AudioManager *object)
**描述:**
释放音频管理接口对象
释放音频管理接口对象
。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
|
待操作的音频管理接口对象 |
|
|
object | 输入参数,待操作的音频管理接口对象。
|
**返回:**
成功返回true,失败返回false
成功返回true,失败返回false
。
### UnloadAdapter
...
...
@@ -131,14 +131,14 @@ void(* AudioManager::UnloadAdapter) (struct AudioAdapterManager *manager, struct
**描述:**
卸载音频适配器(声卡)的驱动
卸载音频适配器(声卡)的驱动
。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| manager |
待操作的音频管理接口对象
|
| adapter |
待卸载的音频适配器接口的对象
|
| manager |
输入参数,待操作的音频管理接口对象。
|
| adapter |
输入参数,待卸载的音频适配器接口的对象。
|
**参见:**
...
...
zh-cn/device-dev/reference/hdi-apis/_audio_mmap_buffer_descripter.md
浏览文件 @
d398236b
...
...
@@ -17,8 +17,8 @@ Mmap缓冲区描述符。
| 名称 | 描述 |
| -------- | -------- |
|
[
memoryAddress
](
_audio.md#memoryaddress
)
| 指向
m
map缓冲区的指针 |
|
[
memoryFd
](
_audio.md#memoryfd
)
|
m
map缓冲区的文件描述符 |
|
[
memoryAddress
](
_audio.md#memoryaddress
)
| 指向
M
map缓冲区的指针 |
|
[
memoryFd
](
_audio.md#memoryfd
)
|
M
map缓冲区的文件描述符 |
|
[
totalBufferFrames
](
_audio.md#totalbufferframes
)
| 缓冲区总大小,单位:帧 |
|
[
transferFrameSize
](
_audio.md#transferframesize
)
| 传输大小,单位:帧 |
|
[
isShareable
](
_audio.md#isshareable
)
|
m
map缓冲区是否可以在进程间共享 |
|
[
isShareable
](
_audio.md#isshareable
)
|
M
map缓冲区是否可以在进程间共享 |
zh-cn/device-dev/reference/hdi-apis/_audio_render.md
浏览文件 @
d398236b
...
...
@@ -5,7 +5,7 @@
AudioRender音频播放接口。
提供音频播放支持的驱动能力,包括音频控制、音频属性、音频场景、音频音量、获取硬件延迟时间、播放音频帧数据(
r
ender frame)等。
提供音频播放支持的驱动能力,包括音频控制、音频属性、音频场景、音频音量、获取硬件延迟时间、播放音频帧数据(
R
ender 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) | 往音频驱动中播放(
r
ender)一帧输出数据(放音,音频下行数据)。 |
| (
[
RenderFrame
](
#renderframe
)
)(struct
AudioRender
\*render,
const
void
\*frame,
uint64_t
requestBytes,
uint64_t
\*
replyBytes) | 往音频驱动中播放(
R
ender)一帧输出数据(放音,音频下行数据)。 |
| (
[
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,失败返回负值
。
**参见:**
...
...
zh-cn/device-dev/reference/hdi-apis/_audio_scene.md
浏览文件 @
d398236b
...
...
@@ -43,19 +43,19 @@ int32_t(* AudioScene::CheckSceneCapability) (AudioHandle handle, const struct Au
**描述:**
是否支持某个音频场景的配置
是否支持某个音频场景的配置
。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle |
待操作的音频句柄
|
| scene |
待获取的音频场景描述符
|
| supported |
是否支持的状态保存到supported中,true表示支持,false表示不支持
|
| handle |
输入参数,待操作的音频句柄。
|
| scene |
输入参数,待获取的音频场景描述符。
|
| supported |
输出参数,是否支持的状态保存到supported中,true表示支持,false表示不支持。
|
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
**参见:**
...
...
@@ -71,26 +71,26 @@ int32_t(* AudioScene::SelectScene) (AudioHandle handle, const struct AudioSceneD
**描述:**
选择音频场景
选择音频场景
。
-
1. 选择一个非常具体的音频场景(应用场景和输出设备的组合),例如同样是使用手机中的喇叭作为输出设备
-
选择一个非常具体的音频场景(应用场景和输出设备的组合),例如同样是使用手机中的喇叭作为输出设备:
-
在媒体播放场景scene为media_speaker
-
在语音通话免提场景scene为voice_speaker
-
2. 只是选择一个音频场景,例如使用场景为媒体播放(media)、电影播放(movie)、游戏播放(game)
-
只是选择一个音频场景,例如使用场景为媒体播放(media)、电影播放(movie)、游戏播放(game)。
-
3. 只是选择一个音频输出设备,例如输出设备为听筒(receiver)、喇叭(speaker)、有线耳机(headset)
-
只是选择一个音频输出设备,例如输出设备为听筒(receiver)、喇叭(speaker)、有线耳机(headset)。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle |
待操作的音频句柄
|
| scene |
待设置的音频场景描述符
|
| handle |
输入参数,待操作的音频句柄。
|
| scene |
输入参数,待设置的音频场景描述符。
|
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
**参见:**
...
...
zh-cn/device-dev/reference/hdi-apis/_audio_volume.md
浏览文件 @
d398236b
...
...
@@ -5,7 +5,7 @@
AudioVolume音频音量接口。
提供音频播放(
render)或录音(c
apture)需要的公共音量驱动能力,包括静音操作、设置音量、设置增益等。
提供音频播放(
Render)或录音(C
apture)需要的公共音量驱动能力,包括静音操作、设置音量、设置增益等。
**Since:**
...
...
@@ -48,18 +48,18 @@ int32_t(* AudioVolume::GetGain) (AudioHandle handle, float *gain)
**描述:**
获取音频流的增益
获取音频流的增益
。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle |
待操作的音频句柄
|
| gain |
保存当前获取到的增益到gain中
|
| handle |
输入参数,待操作的音频句柄。
|
| gain |
输出参数,保存当前获取到的增益到gain中。
|
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
**参见:**
...
...
@@ -77,7 +77,7 @@ int32_t(* AudioVolume::GetGainThreshold) (AudioHandle handle, float *min, float
**描述:**
获取音频流增益的阈值
获取音频流增益的阈值
。
在具体的功能实现中,可以根据芯片平台的实际情况来进行处理:
...
...
@@ -89,13 +89,13 @@ int32_t(* AudioVolume::GetGainThreshold) (AudioHandle handle, float *min, float
| 名称 | 描述 |
| -------- | -------- |
| handle |
待操作的音频句柄
|
| min |
获取的音频增益的阈值下限保存到min中
|
| max |
获取的音频增益的阈值上限保存到max中
|
| handle |
输入参数,待操作的音频句柄。
|
| min |
输出参数,获取的音频增益的阈值下限保存到min中。
|
| max |
输出参数,获取的音频增益的阈值上限保存到max中。
|
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
**参见:**
...
...
@@ -113,18 +113,18 @@ int32_t(* AudioVolume::GetMute) (AudioHandle handle, bool *mute)
**描述:**
获取音频的静音状态
获取音频的静音状态
。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle |
待操作的音频句柄
|
| mute |
获取的静音状态保存到mute中,true表示静音操作、false表示取消静音操作
|
| handle |
输入参数,待操作的音频句柄。
|
| mute |
输出参数,获取的静音状态保存到mute中,true表示静音操作,false表示取消静音操作。
|
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
**参见:**
...
...
@@ -140,18 +140,18 @@ int32_t(* AudioVolume::GetVolume) (AudioHandle handle, float *volume)
**描述:**
获取一个音频流的音量
获取一个音频流的音量
。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle |
待操作的音频句柄
|
| volume |
获取的音量保存到volume中,范围0.0~1.0
|
| handle |
输入参数,待操作的音频句柄。
|
| volume |
输出参数,获取的音量保存到volume中,范围0.0~1.0。
|
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
**参见:**
...
...
@@ -167,18 +167,18 @@ int32_t(* AudioVolume::SetGain) (AudioHandle handle, float gain)
**描述:**
设置音频流的增益
设置音频流的增益
。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle |
待操作的音频句柄
|
| gain |
gain
待设置的增益
|
| handle |
输入参数,待操作的音频句柄。
|
| gain |
输入参数,待设置的增益。
|
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
**参见:**
...
...
@@ -196,18 +196,18 @@ int32_t(* AudioVolume::SetMute) (AudioHandle handle, bool mute)
**描述:**
设置音频的静音状态
设置音频的静音状态
。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle |
待操作的音频句柄
|
| mute |
待设置的静音状态,true表示静音操作、false表示取消静音操作
|
| handle |
输入参数,待操作的音频句柄。
|
| mute |
输入参数,待设置的静音状态,true表示静音操作,false表示取消静音操作。
|
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
**参见:**
...
...
@@ -225,15 +225,15 @@ int32_t(* AudioVolume::SetVolume) (AudioHandle handle, float volume)
设置一个音频流的音量。
音量的取值范围是0.0~1.0,如果音频服务中的音量等级为15级(0 ~ 15),
则音量的映射关系为0.0表示静音,1.0表示最大音量等级(15)。
音量的取值范围是0.0~1.0,如果音频服务中的音量等级为15级(0 ~ 15),则音量的映射关系为0.0表示静音,1.0表示最大音量等级(15)。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle |
待操作的音频句柄
|
| volume |
待设置的音量,范围0.0~1.0
|
| handle |
输入参数,待操作的音频句柄。
|
| volume |
输入参数,待设置的音量,范围0.0~1.0。
|
**返回:**
成功返回值0,失败返回负值
成功返回值0,失败返回负值
。
zh-cn/device-dev/reference/hdi-apis/_ext_data_handle.md
浏览文件 @
d398236b
...
...
@@ -17,6 +17,6 @@
| 名称 | 描述 |
| -------- | -------- |
|
[
fd
](
_display.md#fd
)
| 句柄
fd,
-1代表不支持。 |
|
[
fd
](
_display.md#fd
)
| 句柄
fd,
-1代表不支持。 |
|
[
reserveInts
](
_display.md#reserveints
)
| reserve数组的个数。 |
|
[
reserve
](
_display.md#reserve
)
[0] | reserve数组。 |
zh-cn/device-dev/reference/hdi-apis/_i_wlan_interface_8idl.md
浏览文件 @
d398236b
...
...
@@ -3,9 +3,7 @@
## **概述**
建立/关闭WLAN热点,扫描/关联/去关联WLAN热点,设置国家码,管理网络设备等操作的接口。
上层服务调用相关的接口实现:建立/关闭WLAN热点,扫描/关联/去关联WLAN热点,设置国家码,管理网络设备等功能。
WLAN模块操作接口,上层服务调用相关的接口可实现:建立/关闭WLAN热点,扫描/关联/去关联WLAN热点,设置国家码,管理网络设备等功能。
**Since:**
...
...
zh-cn/device-dev/reference/hdi-apis/_wlan_types_8idl.md
浏览文件 @
d398236b
...
...
@@ -3,8 +3,6 @@
## **概述**
WLAN模块相关的数据类型。
WLAN模块中使用的数据类型,包括feature对象信息、STA信息、扫描信息、网络设备信息等。
**Since:**
...
...
zh-cn/device-dev/reference/hdi-apis/codec__component__type_h.md
浏览文件 @
d398236b
...
...
@@ -3,7 +3,6 @@
## **概述**
Codec模块接口定义中使用的自定义数据类型。
Codec模块接口定义中使用的自定义数据类型,包括编解码类型、音视频参数、buffer定义等。
...
...
zh-cn/device-dev/reference/hdi-apis/display__type_8h.md
浏览文件 @
d398236b
...
...
@@ -52,7 +52,7 @@
| 名称 | 描述 |
| -------- | -------- |
|
[
PROPERTY_NAME_LEN
](
_display.md#property
namelen
)
50 | 属性名字长度。 |
|
[
PROPERTY_NAME_LEN
](
_display.md#property
_name_len
)
50 | 属性名字长度。 |
### 枚举
...
...
zh-cn/device-dev/reference/hdi-apis/input__type_8h.md
浏览文件 @
d398236b
...
...
@@ -44,17 +44,17 @@ Input设备相关的类型定义。
| 名称 | 描述 |
| -------- | -------- |
|
[
MAX_INPUT_DEV_NUM
](
input.md#max
inputdev
num
)
32 | Input设备数量的最大值。 |
|
[
CHIP_INFO_LEN
](
input.md#chip
info
len
)
10 | 芯片信息长度。 |
|
[
CHIP_NAME_LEN
](
input.md#chip
name
len
)
10 | 芯片名称长度。 |
|
[
VENDOR_NAME_LEN
](
input.md#vendor
name
len
)
10 | 厂商名称长度。 |
|
[
DEV_NAME_LEN
](
input.md#dev
name
len
)
64 | Input设备名称长度。 |
|
[
SELF_TEST_RESULT_LEN
](
input.md#self
testresult
len
)
20 | 自测结果长度。 |
|
[
DEV_MANAGER_SERVICE_NAME
](
input.md#dev
managerservice
name
)
"hdf_input_host" | Input设备节点服务名称。 |
|
[
DIV_ROUND_UP
](
input.md#div
round
up
)(
nr, d
)
(((nr)
+
(d)
-
1)
/
(d)) | 向上取整计算公式。 |
|
[
BYTE_HAS_BITS
](
input.md#byte
has
bits
)
8 | 一个字节所包含的比特数。 |
|
[
BITS_TO_UINT64
](
input.md#bits
touint64
)(
count
)
[DIV_ROUND_UP](input.md#divroundup)(count,
[BYTE_HAS_BITS](input.md#bytehas
bits)
\*
sizeof(uint64_t)) | 比特与64位无符号整数的转换公式。 |
|
[
HDF_FF_CNT
](
input.md#hdf
ff
cnt
)
(0x7f
+
1) | Input设备发送力反馈命令的数量最大值。 |
|
[
MAX_INPUT_DEV_NUM
](
input.md#max
_input_dev_
num
)
32 | Input设备数量的最大值。 |
|
[
CHIP_INFO_LEN
](
input.md#chip
_info_
len
)
10 | 芯片信息长度。 |
|
[
CHIP_NAME_LEN
](
input.md#chip
_name_
len
)
10 | 芯片名称长度。 |
|
[
VENDOR_NAME_LEN
](
input.md#vendor
_name_
len
)
10 | 厂商名称长度。 |
|
[
DEV_NAME_LEN
](
input.md#dev
_name_
len
)
64 | Input设备名称长度。 |
|
[
SELF_TEST_RESULT_LEN
](
input.md#self
_test_result_
len
)
20 | 自测结果长度。 |
|
[
DEV_MANAGER_SERVICE_NAME
](
input.md#dev
_manager_service_
name
)
"hdf_input_host" | Input设备节点服务名称。 |
|
[
DIV_ROUND_UP
](
input.md#div
_round_
up
)(
nr, d
)
(((nr)
+
(d)
-
1)
/
(d)) | 向上取整计算公式。 |
|
[
BYTE_HAS_BITS
](
input.md#byte
_has_
bits
)
8 | 一个字节所包含的比特数。 |
|
[
BITS_TO_UINT64
](
input.md#bits
_to_uint64
)(
count
)
[DIV_ROUND_UP](input.md#div_round_up)(count,
[BYTE_HAS_BITS](input.md#byte_has_
bits)
\*
sizeof(uint64_t)) | 比特与64位无符号整数的转换公式。 |
|
[
HDF_FF_CNT
](
input.md#hdf
_ff_
cnt
)
(0x7f
+
1) | Input设备发送力反馈命令的数量最大值。 |
### 枚举
...
...
zh-cn/device-dev/reference/hdi-apis/sensor.md
浏览文件 @
d398236b
...
...
@@ -3,9 +3,9 @@
## **概述**
提供休眠/唤醒操作、订阅休眠/唤醒状态、运行锁管理的接口
。
传感器设备驱动对传感器服务提供通用的接口能力
。
电源模块为电源服务提供的休眠/唤醒操作、订阅休眠/唤醒状态和运行锁管理的接口。 服务获取此模块的对象或代理后,可以调用相关的接口对设备进行休眠/唤醒、订阅休眠/唤醒状态和管理运行锁
。
模块提供传感器服务对传感器驱动访问统一接口,服务获取驱动对象或者代理后,通过其提供的各类方法,以传感器ID区分访问不同类型传感器设备,实现获取传感器设备信息、订阅/取消订阅传感器数据、 使能/去使能传感器、设置传感器模式、设置传感器精度、量程等可选配置等
。
**Since**
:
...
...
@@ -24,7 +24,7 @@
| 名称 | 描述 |
| -------- | -------- |
|
[
ISensorCallback.idl
](
_i_sensor_callback_8idl.md
)
| Sensor模块为Sensor服务提供数据上报的回调函数。 |
|
[
ISensorInterface.idl
](
_i_sensor_interface_8idl.md
)
| Sensor模块对外通用的接口声明文件,提供获取传感器设备信息、订阅/取消订阅传感器数据、
使能/去使能传感器、设置传感器模式、设置传感器精度,量程等可选配置接口定义。 |
|
[
ISensorInterface.idl
](
_i_sensor_interface_8idl.md
)
| Sensor模块对外通用的接口声明文件,提供获取传感器设备信息、订阅/取消订阅传感器数据、使能/去使能传感器、设置传感器模式、设置传感器精度,量程等可选配置接口定义。 |
|
[
SensorTypes.idl
](
_sensor_types_8idl.md
)
| 定义传感器模块所使用的传感器类型,传感器信息,传感器数据结构等数据类型。 |
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录