提交 35ad3ede 编写于 作者: Z z00524957

update hdi apis

Signed-off-by: Nz00524957 <zengyawen1@huawei.com>
上级 62fe90f9
# ActRecognitionEvent
## **概述**
## 概述
定义行为识别模块使用的数据类型
定义行为事件上报的数据结构
**Since**:
**Since:**
3.2
**Version**:
1.0
**相关模块:**
[HdiActivityRecognition](activity_recognition.md)
[HdiActivityRecognition](_hdi_activity_recognition.md)
## **汇总**
## 汇总
### Public 属性
| 名称 | 描述 |
| -------- | -------- |
| [activity](#activity) | 行为类型 |
| [eventType](#eventtype) | 事件类型 |
| [timestamp](#timestamp) | 时间戳 |
| [confidence](#confidence) | 置信度 |
| [activity](#activity) | int<br/>行为类型,详见[ActRecognitionEventType](_hdi_activity_recognition.md#actrecognitioneventtype) |
| [eventType](#eventtype) | int<br/>事件类型,详见[ActRecognitionEventType](_hdi_activity_recognition.md#actrecognitioneventtype) |
| [timestamp](#timestamp) | long<br/>时间戳 |
| [confidence](#confidence) | int<br/>置信度,100为最可信,0为最不可信,-1为该行为不支持置信度的计算。 |
## **类成员变量说明**
## 类成员变量说明
### activity
......@@ -41,9 +37,9 @@
int ActRecognitionEvent::activity
```
**描述**
**描述:**
行为类型,详见[ActRecognitionEventType](activity_recognition.md#actrecognitioneventtype)
行为类型,详见[ActRecognitionEventType](_hdi_activity_recognition.md#actrecognitioneventtype)
### confidence
......@@ -53,7 +49,7 @@ int ActRecognitionEvent::activity
int ActRecognitionEvent::confidence
```
**描述**
**描述:**
置信度,100为最可信,0为最不可信,-1为该行为不支持置信度的计算。
......@@ -65,9 +61,9 @@ int ActRecognitionEvent::confidence
int ActRecognitionEvent::eventType
```
**描述**
**描述:**
事件类型,详见[ActRecognitionEventType](activity_recognition.md#actrecognitioneventtype)
事件类型,详见[ActRecognitionEventType](_hdi_activity_recognition.md#actrecognitioneventtype)
### timestamp
......@@ -77,6 +73,6 @@ int ActRecognitionEvent::eventType
long ActRecognitionEvent::timestamp
```
**描述**
**描述:**
时间戳
时间戳
# Activation
## 概述
激活类型的算子,所有的激活函数都属于该算子,具体的激活函数类型一句参数来确定。
该算子对应的[NodeType](_n_n_rt.md#nodetype)为NODE_TYPE_ACTIVATION。
输入:
- x,n维张量。
输出:
- 输出x经过激活函数之后的张量。
**Since:**
3.2
**Version:**
1.0
**相关模块:**
[NNRt](_n_n_rt.md)
## 汇总
### Public 属性
| 名称 | 描述 |
| -------- | -------- |
| [activationType](#activationtype) | enum&nbsp;[ActivationType](_n_n_rt.md#activationtype)<br/>激活函数类型。&nbsp; |
| [alpha](#alpha) | float<br/>尺寸因子,用于LeakyReLU和ELU激活函数。&nbsp; |
| [minVal](#minval) | float<br/>最小值,用于HardTanh激活函数。&nbsp; |
| [maxVal](#maxval) | float<br/>最大值,用于HardTanh激活函数。&nbsp; |
| [approximate](#approximate) | boolean<br/>是否使用近似算法,用于GRLU激活函数。&nbsp; |
## 类成员变量说明
### activationType
```
enum ActivationType Activation::activationType
```
**描述:**
激活函数类型。
### alpha
```
float Activation::alpha
```
**描述:**
尺寸因子,用于LeakyReLU和ELU激活函数。
### approximate
```
boolean Activation::approximate
```
**描述:**
是否使用近似算法,用于GRLU激活函数。
### maxVal
```
float Activation::maxVal
```
**描述:**
最大值,用于HardTanh激活函数。
### minVal
```
float Activation::minVal
```
**描述:**
最小值,用于HardTanh激活函数。
# ActivityRecognitionTypes.idl
## **概述**
## 概述
定义行为识别模块使用的数据类型。
**Since**:
**Since:**
3.2
**Version**:
**Version:**
1.0
**相关模块:**
[HdiActivityRecognition](activity_recognition.md)
[HdiActivityRecognition](_hdi_activity_recognition.md)
## **汇总**
## 汇总
### 类
| 名称 | 描述 |
| -------- | -------- |
| [ActRecognitionEvent](_act_recognition_event.md) | 定义行为事件上报的数据结构。 |
| [ActRecognitionEvent](_act_recognition_event.md) | struct<br/>定义行为事件上报的数据结构。 |
### 枚举
| 名称 | 描述 |
| -------- | -------- |
| [ActRecognitionEventType](activity_recognition.md#actrecognitioneventtype)&nbsp;{&nbsp;ACT_RECOGNITION_EVENT_ENTER&nbsp;=&nbsp;0x01,&nbsp;ACT_RECOGNITION_EVENT_EXIT&nbsp;=&nbsp;0x02&nbsp;} | 枚举行为事件的类型。 |
| [ActRecognitionPowerMode](activity_recognition.md#actrecognitionpowermode)&nbsp;{&nbsp;ACT_RECOGNITION_NORMAL_MODE&nbsp;=&nbsp;0,&nbsp;ACT_RECOGNITION_LOW_POWER_MODE&nbsp;=&nbsp;1&nbsp;} | 枚举功耗模式的类型。 |
| [ActRecognitionEventType](_hdi_activity_recognition.md#actrecognitioneventtype)&nbsp;{&nbsp;ACT_RECOGNITION_EVENT_ENTER&nbsp;=&nbsp;0x01&nbsp;,&nbsp;ACT_RECOGNITION_EVENT_EXIT&nbsp;=&nbsp;0x02&nbsp;} | 枚举行为事件的类型。 |
| [ActRecognitionPowerMode](_hdi_activity_recognition.md#actrecognitionpowermode)&nbsp;{&nbsp;ACT_RECOGNITION_NORMAL_MODE&nbsp;=&nbsp;0&nbsp;,&nbsp;ACT_RECOGNITION_LOW_POWER_MODE&nbsp;=&nbsp;1&nbsp;} | 枚举功耗模式的类型。 |
### 关键字
......
# AddFusion
## 概述
输入Tensor逐元素相加, 输出x和y的和,数据形状与输入broadcast之后一样,数据类型与较高精度的输入精度一致。
该算子对应的[NodeType](_n_n_rt.md#nodetype)为NODE_TYPE_ADD_FUSION。
输入:
- x,第一个输入张量。
- y,第二个输入张量,数据类型和第一个张量保持一致。
输出:
- output,x和y逐元素相加, 输出x和y的和,数据形状与输入broadcast之后一样,数据类型与较高精度的输入精度一致。 如果配置了activationType则会在输出之前调用指定的激活函数。
**Since:**
3.2
**Version:**
1.0
**相关模块:**
[NNRt](_n_n_rt.md)
## 汇总
### Public 属性
| 名称 | 描述 |
| -------- | -------- |
| [activationType](#activationtype) | enum&nbsp;[ActivationType](_n_n_rt.md#activationtype)<br/>激活函数类型。详情请参考:[ActivationType](_n_n_rt.md#activationtype) |
## 类成员变量说明
### activationType
```
enum ActivationType AddFusion::activationType
```
**描述:**
激活函数类型。详情请参考:[ActivationType](_n_n_rt.md#activationtype)
# Alignment
## **概述**
## 概述
对齐结构定义,包含宽高的对齐值。
**相关模块:**
[Codec](codec.md)
[Codec](_codec.md)
## **汇总**
## 汇总
### Public 属性
| 名称 | 描述 |
| -------- | -------- |
| [widthAlignment](#widthalignment) | 宽的对齐值。 |
| [heightAlignment](#heightalignment) | 高的对齐值。 |
| [widthAlignment](#widthalignment) | int32_t<br/>宽的对齐值。&nbsp; |
| [heightAlignment](#heightalignment) | int32_t<br/>高的对齐值。&nbsp; |
## **类成员变量说明**
## 类成员变量说明
### heightAlignment
......@@ -30,9 +30,7 @@
```
int32_t Alignment::heightAlignment
```
**描述:**
**描述:**
高的对齐值。
......@@ -42,7 +40,5 @@ int32_t Alignment::heightAlignment
```
int32_t Alignment::widthAlignment
```
**描述:**
**描述:**
宽的对齐值。
# AllocInfo
## **概述**
## 概述
定义分配的内存的信息。
定义关于要分配的内存的信息。
**相关模块:**
[Display](_display.md)
## **汇总**
## 汇总
### Public 属性
| 名称 | 描述 |
| -------- | -------- |
| [width](_display.md#width-69) | 申请内存宽度 |
| [height](_display.md#height-68) | 申请内存高度 |
| [usage](_display.md#usage-12) | 申请内存的使用场景 |
| [format](_display.md#format-12) | 申请内存格式 |
| [expectedSize](_display.md#expectedsize) | 申请内存大小 |
| [width](_display.md#width-69) | uint32_t<br/>申请内存宽度 |
| [height](_display.md#height-68) | uint32_t<br/>申请内存高度 |
| [usage](_display.md#usage-12) | uint64_t<br/>申请内存的使用场景 |
| [format](_display.md#format-12) | [PixelFormat](_display.md#pixelformat)<br/>申请内存格式 |
| [expectedSize](_display.md#expectedsize) | uint32_t<br/>申请内存大小 |
# ApduSimIORequestInfo
## 概述
APDU数据传输请求信息。
**相关模块:**
[Ril](_ril.md)
## 汇总
### Public 属性
| 名称 | 描述 |
| -------- | -------- |
| [serial](#serial) | int<br/>请求的序列号&nbsp; |
| [channelId](#channelid) | int<br/>通道ID&nbsp; |
| [type](#type) | int<br/>APDU指令类型,参考ETSI&nbsp;102&nbsp;221&nbsp;[55]&nbsp; |
| [instruction](#instruction) | int<br/>APDU指令,参考ETSI&nbsp;102&nbsp;221&nbsp;[55]&nbsp; |
| [p1](#p1) | int<br/>SIM数据请求命令参数,参考3GPP&nbsp;TS&nbsp;51.011[28]&nbsp; |
| [p2](#p2) | int<br/>SIM数据请求命令参数2,参考3GPP&nbsp;TS&nbsp;51.011[28]&nbsp; |
| [p3](#p3) | int<br/>SIM数据请求命令参数3,参考3GPP&nbsp;TS&nbsp;51.011[28]&nbsp;如果p3为负值,则会向SIM发送一个4字节的APDU&nbsp; |
| [data](#data) | String<br/>请求传输的数据信息&nbsp; |
## 类成员变量说明
### channelId
```
int ApduSimIORequestInfo::channelId
```
**描述:**
通道ID
### data
```
String ApduSimIORequestInfo::data
```
**描述:**
请求传输的数据信息
### instruction
```
int ApduSimIORequestInfo::instruction
```
**描述:**
APDU指令,参考ETSI 102 221 [55]
### p1
```
int ApduSimIORequestInfo::p1
```
**描述:**
SIM数据请求命令参数,参考3GPP TS 51.011[28]
### p2
```
int ApduSimIORequestInfo::p2
```
**描述:**
SIM数据请求命令参数2,参考3GPP TS 51.011[28]
### p3
```
int ApduSimIORequestInfo::p3
```
**描述:**
SIM数据请求命令参数3,参考3GPP TS 51.011[28] 如果p3为负值,则会向SIM发送一个4字节的APDU
### serial
```
int ApduSimIORequestInfo::serial
```
**描述:**
请求的序列号
### type
```
int ApduSimIORequestInfo::type
```
**描述:**
APDU指令类型,参考ETSI 102 221 [55]
# ArgMaxFusion
## 概述
返回跨轴的tensor前K个索引或者是数值。
该算子对应的[NodeType](_n_n_rt.md#nodetype)为NODE_TYPE_ARGMAX_FUSION。
输入:
- x,n维tensor,输入张量(N,\*),其中\*意味着数量任意的附加维度。
输出:
- output,轴上输入张量最大值的前K个索引或者是数值。
**Since:**
3.2
**Version:**
1.0
**相关模块:**
[NNRt](_n_n_rt.md)
## 汇总
### Public 属性
| 名称 | 描述 |
| -------- | -------- |
| [axis](#axis) | long<br/>指定求最大值索引的维度。&nbsp; |
| [topK](#topk) | long<br/>轴上前K个最大值。&nbsp; |
| [keepDims](#keepdims) | boolean<br/>是否保持输出维度和输入的维度是否相同。&nbsp; |
| [outMaxValue](#outmaxvalue) | boolean<br/>若为false则输出索引,为true则输出数值,默认为false。&nbsp; |
## 类成员变量说明
### axis
```
long ArgMaxFusion::axis
```
**描述:**
指定求最大值索引的维度。
### keepDims
```
boolean ArgMaxFusion::keepDims
```
**描述:**
是否保持输出维度和输入的维度是否相同。
### outMaxValue
```
boolean ArgMaxFusion::outMaxValue
```
**描述:**
若为false则输出索引,为true则输出数值,默认为false。
### topK
```
long ArgMaxFusion::topK
```
**描述:**
轴上前K个最大值。
# AudioAdapter
## **概述**
AudioAdapter音频适配器接口。
提供音频适配器(声卡)对外支持的驱动能力,包括初始化端口、创建Render、创建Capture、获取端口能力集等。
**Since:**
1.0
**Version:**
1.0
**相关模块:**
[Audio](_audio.md)
**参见:**
[AudioRender](_audio_render.md)
[AudioCapture](_audio_capture.md)
## **汇总**
### Public 属性
| 名称 | 描述 |
| -------- | -------- |
| ([InitAllPorts](#initallports))(struct&nbsp;AudioAdapter&nbsp;\*adapter) | 初始化一个音频适配器所有的端口驱动 |
| ([CreateRender](#createrender)&nbsp;)(struct&nbsp;AudioAdapter&nbsp;\*adapter,&nbsp;const&nbsp;struct&nbsp;AudioDeviceDescriptor&nbsp;\*desc,&nbsp;const&nbsp;struct&nbsp;AudioSampleAttributes&nbsp;\*attrs,&nbsp;struct&nbsp;AudioRender&nbsp;\*\*render) | 创建一个音频播放(Render)接口的对象 |
| ([DestroyRender](#destroyrender)&nbsp;)(struct&nbsp;AudioAdapter&nbsp;\*adapter,&nbsp;struct&nbsp;AudioRender&nbsp;\*render) | 销毁一个音频播放(Render)接口的对象 |
| ([CreateCapture](#createcapture))(struct&nbsp;AudioAdapter&nbsp;\*adapter,&nbsp;const&nbsp;struct&nbsp;AudioDeviceDescriptor&nbsp;\*desc,&nbsp;const&nbsp;struct&nbsp;AudioSampleAttributes&nbsp;\*attrs,&nbsp;struct&nbsp;AudioCapture&nbsp;\*\*capture) | 创建一个音频录音(Capture)接口的对象 |
| ([DestroyCapture](#destroycapture))(struct&nbsp;AudioAdapter&nbsp;\*adapter,&nbsp;struct&nbsp;AudioCapture&nbsp;\*capture) | 销毁一个音频录音(Capture)接口的对象 |
| ([GetPortCapability](#getportcapability)&nbsp;)(struct&nbsp;AudioAdapter&nbsp;\*adapter,&nbsp;struct&nbsp;AudioPort&nbsp;\*port,&nbsp;struct&nbsp;AudioPortCapability&nbsp;\*capability) | 获取一个音频适配器的端口驱动的能力集 |
| ([SetPassthroughMode](#setpassthroughmode)&nbsp;)(struct&nbsp;AudioAdapter&nbsp;\*adapter,&nbsp;struct&nbsp;AudioPort&nbsp;\*port,&nbsp;enum&nbsp;AudioPortPassthroughMode&nbsp;mode) | 设置音频端口驱动的数据透传模式 |
| ([GetPassthroughMode](#getpassthroughmode))(struct&nbsp;AudioAdapter&nbsp;\*adapter,&nbsp;struct&nbsp;AudioPort&nbsp;\*port,&nbsp;enum&nbsp;AudioPortPassthroughMode&nbsp;\*mode) | 获取音频端口驱动的数据透传模式 |
| ([UpdateAudioRoute](#updateaudioroute))(struct&nbsp;AudioAdapter&nbsp;\*adapter,&nbsp;const&nbsp;struct&nbsp;AudioRoute&nbsp;\*route,&nbsp;int32_t&nbsp;\*routeHandle) | 更新一个或多个发送端和接受端之间的路由 |
| ([ReleaseAudioRoute](#releaseaudioroute))(struct&nbsp;AudioAdapter&nbsp;\*adapter,&nbsp;int32_t&nbsp;routeHandle) | 释放一个音频路由 |
## **类成员变量说明**
### CreateCapture
```
int32_t(* AudioAdapter::CreateCapture) (struct AudioAdapter *adapter, const struct AudioDeviceDescriptor *desc, const struct AudioSampleAttributes *attrs, struct AudioCapture **capture)
```
**描述:**
创建一个音频录音(Capture)接口的对象。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| adapter | 待操作的音频适配器的指针 |
| desc | 指向要启动的音频适配器的描述符的指针 |
| attrs | 指向要打开的音频采样属性的指针 |
| capture | 指向AudioCapture对象的二级指针 |
**返回:**
成功返回值0,失败返回负值。
**参见:**
[GetPortCapability](#getportcapability)
[DestroyCapture](#destroycapture)
### CreateRender
```
int32_t(* AudioAdapter::CreateRender) (struct AudioAdapter *adapter, const struct AudioDeviceDescriptor *desc, const struct AudioSampleAttributes *attrs, struct AudioRender **render)
```
**描述:**
创建一个音频播放(Render)接口的对象。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| adapter | 待操作的音频适配器对象 |
| desc | 待打开的音频设备描述符 |
| attrs | 待打开的音频采样属性 |
| render | 获取的音频播放接口的对象实例保存到render中 |
**返回:**
成功返回值0,失败返回负值。
**参见:**
[GetPortCapability](#getportcapability)
[DestroyRender](#destroyrender)
### DestroyCapture
```
int32_t(* AudioAdapter::DestroyCapture) (struct AudioAdapter *adapter, struct AudioCapture *capture)
```
**描述:**
销毁一个音频录音(Capture)接口的对象。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| adapter | 待操作的音频适配器对象 |
| capture | 待操作的音频录音接口对象 |
**注意:**
在音频录音过程中,不能销毁该接口对象。
**返回:**
成功返回值0,失败返回负值。
**参见:**
[CreateCapture](#createcapture)
### DestroyRender
```
int32_t(* AudioAdapter::DestroyRender) (struct AudioAdapter *adapter, struct AudioRender *render)
```
**描述:**
销毁一个音频播放(Render)接口的对象。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| adapter | 待操作的音频适配器对象 |
| render | 待操作的音频播放接口对象 |
**注意:**
在音频播放过程中,不能销毁该接口对象
**返回:**
成功返回值0,失败返回负值。
**参见:**
[CreateRender](#createrender)
### GetPassthroughMode
```
int(* AudioAdapter::GetPassthroughMode) (struct AudioAdapter *adapter, struct AudioPort *port, enum AudioPortPassthroughMode *mode)
```
**描述:**
获取音频端口驱动的数据透传模式。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| adapter | 待操作的音频适配器对象 |
| port | 待获取的端口 |
| mode | 获取的传输模式保存到mode中 |
**返回:**
成功返回值0,失败返回负值。
**参见:**
[SetPassthroughMode](#setpassthroughmode)
### GetPortCapability
```
int(* AudioAdapter::GetPortCapability) (struct AudioAdapter *adapter, struct AudioPort *port, struct AudioPortCapability *capability)
```
**描述:**
获取一个音频适配器的端口驱动的能力集。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| adapter | 待操作的音频适配器对象 |
| port | 待获取的端口 |
| capability | 获取的端口能力保存到capability中 |
**返回:**
成功返回值0,失败返回负值。
### InitAllPorts
```
int(* AudioAdapter::InitAllPorts) (struct AudioAdapter *adapter)
```
**描述:**
初始化一个音频适配器所有的端口驱动。
在音频服务中,调用其他驱动接口前需要首先调用该接口检查端口是否已经初始化完成:
- 如果端口驱动初始化完成,则函数返回值0, 否则返回负值。
- 如果端口没有初始化完成,则需要等待一段时间(例如100ms)后重新进行检查,直到端口初始化完成后再继续操作。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| adapter | 待操作的音频适配器对象 |
**返回:**
成功返回值0,失败返回负值。
### ReleaseAudioRoute
```
int32_t(* AudioAdapter::ReleaseAudioRoute) (struct AudioAdapter *adapter, int32_t routeHandle)
```
**描述:**
释放一个音频路由。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| adapter | 待操作的音频适配器对象 |
| routeHandle | 待释放的路由句柄 |
**返回:**
成功返回值0,失败返回负值。
### SetPassthroughMode
```
int(* AudioAdapter::SetPassthroughMode) (struct AudioAdapter *adapter, struct AudioPort *port, enum AudioPortPassthroughMode mode)
```
**描述:**
设置音频端口驱动的数据透传模式。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| adapter | 待操作的音频适配器对象 |
| port | 待设置的端口 |
| mode | 待设置的传输模式 |
**返回:**
成功返回值0,失败返回负值。
**参见:**
[GetPassthroughMode](#getpassthroughmode)
### UpdateAudioRoute
```
int32_t(* AudioAdapter::UpdateAudioRoute) (struct AudioAdapter *adapter, const struct AudioRoute *route, int32_t *routeHandle)
```
**描述:**
更新一个或多个发送端和接受端之间的路由。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| adapter | 待操作的音频适配器对象 |
| route | 路由信息 |
| routeHandle | 生成的路由句柄 |
**返回:**
成功返回值0,失败返回负值。
# AudioAdapterDescriptor
## **概述**
## 概述
音频适配器描述符。
一个音频适配器(adapter)是一个声卡的端口驱动集合,包含输出端口、输入端口, 其中一个端口对应着多个PIN脚,一个PIN脚对应着一个实体的器件(例如喇叭、有线耳机)。
一个音频适配器(Adapter)是一个声卡的端口驱动集合,包含输出端口、输入端口, 其中一个端口对应着多个Pin脚,一个Pin脚对应着一个实体的器件(例如喇叭、有线耳机)。
**Since:**
3.2
**Version:**
1.0
**相关模块:**
[Audio](_audio.md)
## **汇总**
## 汇总
### Public 属性
| 名称 | 描述 |
| -------- | -------- |
| [adapterName](_audio.md#adaptername) | 音频适配器的名称 |
| [portNum](_audio.md#portnum) | 一个音频适配器支持的端口数目 |
| [ports](_audio.md#ports) | 一个音频适配器支持的端口列表 |
| [adapterName](#adaptername) | String<br/>音频适配器的名称。 |
| [ports](#ports) | struct&nbsp;[AudioPort](_audio_port.md)[]<br/>一个音频适配器支持的端口列表,详情参考[AudioPort](_audio_port.md)。 |
## 类成员变量说明
### adapterName
```
String AudioAdapterDescriptor::adapterName
```
**描述:**
音频适配器的名称。
### ports
```
struct AudioPort [] AudioAdapterDescriptor::ports
```
**描述:**
一个音频适配器支持的端口列表,详情参考[AudioPort](_audio_port.md)
# AudioAttribute
## **概述**
AudioAttribute音频属性接口。
提供音频播放(Render)或录音(Capture)需要的公共属性驱动能力,包括获取帧(frame)信息、设置采样属性等。
**Since:**
1.0
**Version:**
1.0
**相关模块:**
[Audio](_audio.md)
## **汇总**
### Public 属性
| 名称 | 描述 |
| -------- | -------- |
| ([GetFrameSize](#getframesize))(AudioHandle&nbsp;handle,&nbsp;uint64_t&nbsp;\*size) | 获取音频帧(frame)的大小 |
| ([GetFrameCount](#getframecount))(AudioHandle&nbsp;handle,&nbsp;uint64_t&nbsp;\*count) | 获取音频buffer中的音频帧数 |
| ([SetSampleAttributes](#setsampleattributes))(AudioHandle&nbsp;handle,&nbsp;const&nbsp;struct&nbsp;AudioSampleAttributes&nbsp;\*attrs) | 设置音频采样的属性参数 |
| ([GetSampleAttributes](#getsampleattributes))(AudioHandle&nbsp;handle,&nbsp;struct&nbsp;AudioSampleAttributes&nbsp;\*attrs) | 获取音频采样的属性参数 |
| ([GetCurrentChannelId](#getcurrentchannelid))(AudioHandle&nbsp;handle,&nbsp;uint32_t&nbsp;\*channelId) | 获取音频的数据通道ID |
| ([SetExtraParams](#setextraparams))(AudioHandle&nbsp;handle,&nbsp;const&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;AudioMmapBufferDescriptor&nbsp;\*desc) | 请求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) | 添加音频效果算法实例 |
| ([RemoveAudioEffect](#removeaudioeffect))(AudioHandle&nbsp;handle,&nbsp;uint64_t&nbsp;effectid) | 移除音频效果算法实例 |
| ([GetFrameBufferSize](#getframebuffersize))(AudioHandle&nbsp;handle,&nbsp;uint64_t&nbsp;\*bufferSize) | 获取播放或录音的缓冲区大小 |
## **类成员变量说明**
### AddAudioEffect
```
int32_t (*AudioAttribute::AddAudioEffect)(AudioHandle handle, uint64_t effectid)
```
**描述:**
添加音频效果算法实例。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 输入参数,待操作的音频句柄。 |
| effectid | 输入参数,待添加的音频效果算法实例ID。 |
**返回:**
成功返回值0,失败返回负值。
### GetCurrentChannelId
```
int32_t(* AudioAttribute::GetCurrentChannelId) (AudioHandle handle, uint32_t *channelId)
```
**描述:**
获取音频的数据通道ID。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 输入参数,待操作的音频句柄。 |
| channelId | 输出参数,获取的通道ID保存到channelId中。 |
**返回:**
成功返回值0,失败返回负值。
### GetExtraParams
```
int32_t(* AudioAttribute::GetExtraParams) (AudioHandle handle, char *keyValueList)
```
**描述:**
获取音频拓展参数。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 输入参数,待操作的音频句柄。 |
| keyValueList | 输出参数,拓展参数键值对字符串列表,格式为key=value,多个键值对通过分号分割。 |
**返回:**
成功返回值0,失败返回负值。
### GetFrameBufferSize
```
int32_t (*AudioAttribute::GetFrameBufferSize)(AudioHandle handle, uint64_t *bufferSize)
```
**描述:**
获取播放或录音的缓冲区大小。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 输入参数,待操作的音频句柄。 |
| bufferSize | 输出参数,获取的缓冲区大小保存到bufferSize中。 |
**返回:**
成功返回值0,失败返回负值。
### GetFrameCount
```
int32_t(* AudioAttribute::GetFrameCount) (AudioHandle handle, uint64_t *count)
```
**描述:**
获取音频buffer中的音频帧数。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 输入参数,待操作的音频句柄。 |
| count | 输出参数,一个音频buffer中包含的音频帧数,获取后保存到count中。 |
**返回:**
成功返回值0,失败返回负值。
### GetFrameSize
```
int32_t(* AudioAttribute::GetFrameSize) (AudioHandle handle, uint64_t *size)
```
**描述:**
获取音频帧(frame)的大小,即一帧音频数据的长度(字节数)。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 输入参数,待操作的音频句柄。 |
| size | 输出参数,获取的音频帧大小(字节数)保存到size中。 |
**返回:**
成功返回值0,失败返回负值。
### GetMmapPosition
```
int32_t(* AudioAttribute::GetMmapPosition) (AudioHandle handle, uint64_t *frames, struct AudioTimeStamp *time)
```
**描述:**
获取当前Mmap的读/写位置。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 输入参数,待操作的音频句柄。 |
| frames | 输出参数,获取的音频帧计数保存到frames中。 |
| time | 输出参数,获取的关联时间戳保存到time中。 |
**返回:**
成功返回值0,失败返回负值。
### GetSampleAttributes
```
int32_t(* AudioAttribute::GetSampleAttributes) (AudioHandle handle, struct AudioSampleAttributes *attrs)
```
**描述:**
获取音频采样的属性参数。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 输入参数,待操作的音频句柄。 |
| attrs | 输出参数,获取的音频采样属性(例如采样频率、采样精度、通道)保存到attrs中。 |
**返回:**
成功返回值0,失败返回负值。
**参见:**
[GetSampleAttributes](#getsampleattributes)
### RemoveAudioEffect
```
int32_t (*AudioAttribute::RemoveAudioEffect)(AudioHandle handle, uint64_t effectid)
```
**描述:**
移除音频效果算法实例。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 输入参数,待操作的音频句柄。 |
| effectid | 输入参数,待移除的音频效果算法实例ID。 |
**返回:**
成功返回值0,失败返回负值。
### ReqMmapBuffer
```
int32_t(* AudioAttribute::ReqMmapBuffer) (AudioHandle handle, int32_t reqSize, struct AudioMmapBufferDescriptor *desc)
```
**描述:**
请求Mmap缓冲区。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 输入参数,待操作的音频句柄。 |
| reqSize | 输入参数,请求缓冲区的大小。 |
| desc | 输出参数,缓冲区描述符。 |
**返回:**
成功返回值0,失败返回负值。
### SetExtraParams
```
int32_t(* AudioAttribute::SetExtraParams) (AudioHandle handle, const char *keyValueList)
```
**描述:**
设置音频拓展参数。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 输入参数,待操作的音频句柄。 |
| keyValueList | 输入参数,拓展参数键值对字符串列表,格式为key=value,多个键值对通过分号分割。 |
**返回:**
成功返回值0,失败返回负值。
### SetSampleAttributes
```
int32_t(* AudioAttribute::SetSampleAttributes) (AudioHandle handle, const struct AudioSampleAttributes *attrs)
```
**描述:**
设置音频采样的属性参数。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 输入参数,待操作的音频句柄。 |
| attrs | 输入参数,待设置的音频采样属性,例如采样频率、采样精度、通道。 |
**返回:**
成功返回值0,失败返回负值。
**参见:**
[GetSampleAttributes](#getsampleattributes)
# AudioCapture
## **概述**
AudioCapture录音接口。
**相关模块:**
[Audio](_audio.md)
## **汇总**
### Public 属性
| 名称 | 描述 |
| -------- | -------- |
| control | 音频控制能力接口,详情参考[AudioControl](_audio_control.md)。 |
| attr | 音频属性能力接口,详情参考[AudioAttribute](_audio_attribute.md)。 |
| scene | 音频场景能力接口,详情参考[AudioScene](_audio_scene.md)。 |
| volume | 音频音量能力接口,详情参考[AudioVolume](_audio_volume.md)。 |
| ([CaptureFrame](#captureframe))(struct&nbsp;AudioCapture&nbsp;\*capture,&nbsp;void&nbsp;\*frame,&nbsp;uint64_t&nbsp;requestBytes,&nbsp;uint64_t&nbsp;\*replyBytes) | 从音频驱动中录制(Capture)一帧输入数据(录音,音频上行数据)。 |
| ([GetCapturePosition](#getcaptureposition))(struct&nbsp;AudioCapture&nbsp;\*capture,&nbsp;uint64_t&nbsp;\*frames,&nbsp;struct&nbsp;AudioTimeStamp&nbsp;\*time) | 获取音频输入帧数的上一次计数。 |
## **类成员变量说明**
### CaptureFrame
```
int32_t(* AudioCapture::CaptureFrame) (struct AudioCapture *capture, void *frame, uint64_t requestBytes, uint64_t *replyBytes)
```
**描述:**
从音频驱动中录制(Capture)一帧输入数据(录音,音频上行数据)。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| capture | 输入参数,待操作的音频录音接口对象。 |
| frame | 输入参数,待存放输入数据的音频frame。 |
| requestBytes | 输入参数,待存放输入数据的音频frame大小(字节数)。 |
| replyBytes | 输出参数,实际读取到的音频数据长度(字节数),获取后保存到replyBytes中。 |
**返回:**
成功返回值0,失败返回负值。
### GetCapturePosition
```
int32_t(* AudioCapture::GetCapturePosition) (struct AudioCapture *capture, uint64_t *frames, struct AudioTimeStamp *time)
```
**描述:**
获取音频输入帧数的上一次计数。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| capture | 输入参数,待操作的音频录音接口对象。|
| frames | 输出参数,获取的音频帧计数保存到frames中。 |
| time | 输出参数,获取的关联时间戳保存到time中。 |
**返回:**
成功返回值0,失败返回负值。
**参见:**
[CaptureFrame](#captureframe)
# AudioControl
## **概述**
AudioControl音频控制接口。
提供音频播放(Render)或录音(Capture)需要的公共控制驱动能力,包括Start、Stop、Pause、Resume、Flush等。
**Since:**
1.0
**Version:**
1.0
**相关模块:**
[Audio](_audio.md)
## **汇总**
### Public 属性
| 名称 | 描述 |
| -------- | -------- |
| ([Start](#start))(AudioHandle&nbsp;handle) | 启动一个音频播放(Render)或录音(Capture)处理。 |
| ([Stop](#stop))(AudioHandle&nbsp;handle) | 停止一个音频播放(Render)或录音(Capture)处理。 |
| ([Pause](#pause))(AudioHandle&nbsp;handle) | 暂停一个音频播放(Render)或录音(Capture)处理。 |
| ([Resume](#resume))(AudioHandle&nbsp;handle) | 恢复一个音频播放(Render)或录音(Capture)处理。 |
| ([Flush](#flush))(AudioHandle&nbsp;handle) | 刷新音频缓冲区buffer中的数据。 |
| ([TurnStandbyMode](#turnstandbymode))(AudioHandle&nbsp;handle) | 设置或去设置设备的待机模式。 |
| ([AudioDevDump](#audiodevdump))(AudioHandle&nbsp;handle,&nbsp;int32_t&nbsp;range,&nbsp;int32_t&nbsp;fd) | Dump音频设备信息。 |
## **类成员变量说明**
### AudioDevDump
```
int32_t(* AudioControl::AudioDevDump) (AudioHandle handle, int32_t range, int32_t fd)
```
**描述:**
Dump音频设备信息。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 待操作的音频句柄 |
| range | Dump信息范围,分为简要信息、全量信息 |
| fd | 指定Dump目标文件 |
**返回:**
成功返回值0,失败返回负值。
### Flush
```
int32_t(* AudioControl::Flush) (AudioHandle handle)
```
**描述:**
刷新音频缓冲区buffer中的数据。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 待操作的音频句柄 |
**返回:**
成功返回值0,失败返回负值。
### Pause
```
int32_t(* AudioControl::Pause) (AudioHandle handle)
```
**描述:**
暂停一个音频播放(Render)或录音(Capture)处理。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 待操作的音频句柄 |
**返回:**
成功返回值0,失败返回负值。
**参见:**
[Resume](#resume)
### Resume
```
int32_t(* AudioControl::Resume) (AudioHandle handle)
```
**描述:**
恢复一个音频播放(Render)或录音(Capture)处理。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 待操作的音频句柄 |
**返回:**
成功返回值0,失败返回负值。
**参见:**
[Pause](#pause)
### Start
```
int32_t(* AudioControl::Start) (AudioHandle handle)
```
**描述:**
启动一个音频播放(Render)或录音(Capture)处理。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 待操作的音频句柄 |
**返回:**
成功返回值0,失败返回负值。
**参见:**
[Stop](#stop)
### Stop
```
int32_t(* AudioControl::Stop) (AudioHandle handle)
```
**描述:**
停止一个音频播放(Render)或录音(Capture)处理。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 待操作的音频句柄 |
**返回:**
成功返回值0,失败返回负值。
**参见:**
[Start](#start)
### TurnStandbyMode
```
int32_t(* AudioControl::TurnStandbyMode) (AudioHandle handle)
```
**描述:**
设置或去设置设备的待机模式。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 待操作的音频句柄 |
**返回:**
设置设备待机模式成功返回值0,再次执行后去设置待机模式成功返回正值,失败返回负值。
# AudioDevExtInfo
## **概述**
## 概述
音频设备拓展信息。
**Since:**
3.2
**Version:**
1.0
**相关模块:**
[Audio](_audio.md)
## **汇总**
## 汇总
### Public 属性
| 名称 | 描述 |
| -------- | -------- |
| [moduleId](_audio.md#moduleid-12) | 音频流绑定的模块ID |
| [type](_audio.md#type-23) | 音频端口上的PIN脚(输出、输入) |
| [desc](_audio.md#desc-55) | 地址描述 |
| [moduleId](#moduleid) | unsigned&nbsp;int<br/>音频流绑定的模块ID。 |
| [type](#type) | enum&nbsp;[AudioPortPin](_audio.md#audioportpin)<br/>音频端口上的Pin脚(输出、输入),详情参考[AudioPortPin](_audio.md#audioportpin)。 |
| [desc](#desc) | String<br/>地址描述。 |
## 类成员变量说明
### desc
```
String AudioDevExtInfo::desc
```
**描述:**
地址描述。
### moduleId
```
unsigned int AudioDevExtInfo::moduleId
```
**描述:**
音频流绑定的模块ID。
### type
```
enum AudioPortPin AudioDevExtInfo::type
```
**描述:**
音频端口上的Pin脚(输出、输入),详情参考[AudioPortPin](_audio.md#audioportpin)
# AudioDeviceDescriptor
## **概述**
## 概述
音频设备描述符
音频设备描述符
**Since:**
3.2
**Version:**
1.0
**相关模块:**
[Audio](_audio.md)
## **汇总**
## 汇总
### Public 属性
| 名称 | 描述 |
| -------- | -------- |
| [portId](_audio.md#portid-24) | 音频端口ID |
| [pins](_audio.md#pins) | 音频端口上的PIN脚(输出、输入) |
| [desc](_audio.md#desc-15) | 以字符串命名的音频设备 |
| [portId](#portid) | unsigned&nbsp;int<br/>音频端口ID。&nbsp; |
| [pins](#pins) | enum&nbsp;[AudioPortPin](_audio.md#audioportpin)<br/>音频端口上的Pin脚(输出、输入),详情参考[AudioPortPin](_audio.md#audioportpin)。&nbsp; |
| [desc](#desc) | String<br/>以字符串命名的音频设备。&nbsp; |
## 类成员变量说明
### desc
```
String AudioDeviceDescriptor::desc
```
**描述:**
以字符串命名的音频设备。
### pins
```
enum AudioPortPin AudioDeviceDescriptor::pins
```
**描述:**
音频端口上的Pin脚(输出、输入),详情参考[AudioPortPin](_audio.md#audioportpin)
### portId
```
unsigned int AudioDeviceDescriptor::portId
```
**描述:**
音频端口ID。
# AudioDeviceStatus
## 概述
音频设备状态。
**Since:**
3.2
**Version:**
1.0
**相关模块:**
[Audio](_audio.md)
## 汇总
### Public 属性
| 名称 | 描述 |
| -------- | -------- |
| [pnpStatus](#pnpstatus) | unsigned&nbsp;int<br/>PnP设备状态,详情参考[AudioDeviceType](_audio.md#audiodevicetype),[AudioEventType](_audio.md#audioeventtype)。&nbsp; |
## 类成员变量说明
### pnpStatus
```
unsigned int AudioDeviceStatus::pnpStatus
```
**描述:**
PnP设备状态,详情参考[AudioDeviceType](_audio.md#audiodevicetype)[AudioEventType](_audio.md#audioeventtype)
# AudioEvent
## 概述
音频事件。
**Since:**
3.2
**Version:**
1.0
**相关模块:**
[Audio](_audio.md)
## 汇总
### Public 属性
| 名称 | 描述 |
| -------- | -------- |
| [eventType](#eventtype) | unsigned&nbsp;int<br/>事件类型,详情参考[AudioEventType](_audio.md#audioeventtype)。 |
| [deviceType](#devicetype) | unsigned&nbsp;int<br/>设备类型,详情参考[AudioDeviceType](_audio.md#audiodevicetype)。 |
## 类成员变量说明
### deviceType
```
unsigned int AudioEvent::deviceType
```
**描述:**
设备类型,详情参考[AudioDeviceType](_audio.md#audiodevicetype)
### eventType
```
unsigned int AudioEvent::eventType
```
**描述:**
事件类型,详情参考[AudioEventType](_audio.md#audioeventtype)
# AudioInfo
## 概述
音频端口特定信息。
**Since:**
3.2
**Version:**
1.0
**相关模块:**
[Audio](_audio.md)
## 汇总
### Public 属性
| 名称 | 描述 |
| -------- | -------- |
| [device](#device) | struct&nbsp;[AudioDevExtInfo](_audio_dev_ext_info.md)<br/>设备特定信息,详情参考[AudioDevExtInfo](_audio_dev_ext_info.md)。&nbsp; |
| [mix](#mix) | struct&nbsp;[AudioMixExtInfo](_audio_mix_ext_info.md)<br/>音轨特定信息,详情参考[AudioMixExtInfo](_audio_mix_ext_info.md)。&nbsp; |
| [session](#session) | struct&nbsp;[AudioSessionExtInfo](_audio_session_ext_info.md)<br/>会话特定信息,详情参考[AudioSessionExtInfo](_audio_session_ext_info.md)。&nbsp; |
## 类成员变量说明
### device
```
struct AudioDevExtInfo AudioInfo::device
```
**描述:**
设备特定信息,详情参考[AudioDevExtInfo](_audio_dev_ext_info.md)
### mix
```
struct AudioMixExtInfo AudioInfo::mix
```
**描述:**
音轨特定信息,详情参考[AudioMixExtInfo](_audio_mix_ext_info.md)
### session
```
struct AudioSessionExtInfo AudioInfo::session
```
**描述:**
会话特定信息,详情参考[AudioSessionExtInfo](_audio_session_ext_info.md)
# AudioMixExtInfo
## **概述**
## 概述
音轨拓展信息。
**Since:**
3.2
**Version:**
1.0
**相关模块:**
[Audio](_audio.md)
## **汇总**
## 汇总
### Public 属性
| 名称 | 描述 |
| -------- | -------- |
| [moduleId](_audio.md#moduleid-22) | 流所属模块标识符 |
| [streamId](_audio.md#streamid-22) | 由调用者传递的Render或Capture标识符 |
| [moduleId](#moduleid) | unsigned&nbsp;int<br/>流所属模块标识符。&nbsp; |
| [streamId](#streamid) | unsigned&nbsp;int<br/>由调用者传递的Render或Capture标识符。&nbsp; |
## 类成员变量说明
### moduleId
```
unsigned int AudioMixExtInfo::moduleId
```
**描述:**
流所属模块标识符。
### streamId
```
unsigned int AudioMixExtInfo::streamId
```
**描述:**
由调用者传递的Render或Capture标识符。
# AudioMmapBufferDescripter
## 概述
mmap缓冲区描述符。
**Since:**
3.2
**Version:**
1.0
**相关模块:**
[Audio](_audio.md)
## 汇总
### Public 属性
| 名称 | 描述 |
| -------- | -------- |
| [memoryAddress](#memoryaddress) | byte[]<br/>指向mmap缓冲区的指针。&nbsp; |
| [memoryFd](#memoryfd) | int<br/>mmap缓冲区的文件描述符。&nbsp; |
| [totalBufferFrames](#totalbufferframes) | int<br/>缓冲区总大小,单位:帧。&nbsp; |
| [transferFrameSize](#transferframesize) | int<br/>传输大小,单位:帧。&nbsp; |
| [isShareable](#isshareable) | int<br/>mmap缓冲区是否可以在进程间共享。&nbsp; |
| [offset](#offset) | unsigned&nbsp;int<br/>文件偏移。&nbsp; |
| [filePath](#filepath) | String<br/>mmap文件路径。&nbsp; |
## 类成员变量说明
### filePath
```
String AudioMmapBufferDescripter::filePath
```
**描述:**
mmap文件路径。
### isShareable
```
int AudioMmapBufferDescripter::isShareable
```
**描述:**
mmap缓冲区是否可以在进程间共享。
### memoryAddress
```
byte [] AudioMmapBufferDescripter::memoryAddress
```
**描述:**
指向mmap缓冲区的指针。
### memoryFd
```
int AudioMmapBufferDescripter::memoryFd
```
**描述:**
mmap缓冲区的文件描述符。
### offset
```
unsigned int AudioMmapBufferDescripter::offset
```
**描述:**
文件偏移。
### totalBufferFrames
```
int AudioMmapBufferDescripter::totalBufferFrames
```
**描述:**
缓冲区总大小,单位:帧。
### transferFrameSize
```
int AudioMmapBufferDescripter::transferFrameSize
```
**描述:**
传输大小,单位:帧。
# AudioMmapBufferDescriptor
## **概述**
Mmap缓冲区描述符。
**相关模块:**
[Audio](_audio.md)
## **汇总**
### Public 属性
| 名称 | 描述 |
| -------- | -------- |
| [memoryAddress](_audio.md#memoryaddress) | 指向Mmap缓冲区的指针 |
| [memoryFd](_audio.md#memoryfd) | Mmap缓冲区的文件描述符 |
| [totalBufferFrames](_audio.md#totalbufferframes) | 缓冲区总大小,单位:帧 |
| [transferFrameSize](_audio.md#transferframesize) | 传输大小,单位:帧 |
| [isShareable](_audio.md#isshareable) | Mmap缓冲区是否可以在进程间共享 |
# AudioPort
## **概述**
## 概述
音频端口。
**Since:**
3.2
**Version:**
1.0
**相关模块:**
[Audio](_audio.md)
## **汇总**
## 汇总
### Public 属性
| 名称 | 描述 |
| -------- | -------- |
| [dir](_audio.md#dir) | 音频端口的类型。 |
| [portId](_audio.md#portid-14) | 音频端口的ID。 |
| [portName](_audio.md#portname) | 音频端口的名称。 |
| [dir](#dir) | enum&nbsp;[AudioPortDirection](_audio.md#audioportdirection)<br/>音频端口的类型,详情参考[AudioPortDirection](_audio.md#audioportdirection)。&nbsp; |
| [portId](#portid) | unsigned&nbsp;int<br/>音频端口的ID。&nbsp; |
| [portName](#portname) | String<br/>音频端口的名称。&nbsp; |
## 类成员变量说明
### dir
```
enum AudioPortDirection AudioPort::dir
```
**描述:**
音频端口的类型,详情参考[AudioPortDirection](_audio.md#audioportdirection)
### portId
```
unsigned int AudioPort::portId
```
**描述:**
音频端口的ID。
### portName
```
String AudioPort::portName
```
**描述:**
音频端口的名称。
# AudioPortCap
## **概述**
## 概述
定义音频编解码能力。
**所属模块:**
**相关模块:**
[Codec](codec.md)
[Codec](_codec.md)
## **汇总**
## 汇总
### Public 属性
| 名称 | 描述 |
| -------- | -------- |
| [sampleFormats](#sampleformats)&nbsp;[SAMPLE_FMT_NUM] | 支持的音频采样格式,详见[AudioSampleFormat](codec.md#audiosampleformat)。 |
| [sampleRate](#samplerate)&nbsp;[SAMPLE_RATE_NUM] | 支持的音频采样率,详见[AudioSampleRate](codec.md#audiosamplerate)。 |
| [channelLayouts](#channellayouts)&nbsp;[CHANNEL_NUM] | 支持的音频通道数channel&nbsp;layouts。 |
| [channelCount](#channelcount)&nbsp;[CHANNEL_NUM] | 支持的音频通道数。 |
| [sampleFormats](#sampleformats)&nbsp;[[SAMPLE_FMT_NUM](_codec.md#sample_fmt_num)] | int32_t<br/>支持的音频采样格式,详见[AudioSampleFormat](_codec.md#audiosampleformat)。 |
| [sampleRate](#samplerate)&nbsp;[[SAMPLE_RATE_NUM](_codec.md#sample_rate_num)] | int32_t<br/>支持的音频采样率,详见[AudioSampleRate](_codec.md#audiosamplerate)。 |
| [channelLayouts](#channellayouts)&nbsp;[[CHANNEL_NUM](_codec.md#channel_num)] | int32_t<br/>支持的音频通道数channel&nbsp;layouts。 |
| [channelCount](#channelcount)&nbsp;[[CHANNEL_NUM](_codec.md#channel_num)] | int32_t<br/>支持的音频通道数。 |
## **详细描述**
定义音频编解码能力。
## **类成员变量说明**
## 类成员变量说明
### channelCount
......@@ -38,9 +33,9 @@
int32_t AudioPortCap::channelCount[CHANNEL_NUM]
```
**描述**
**描述:**
支持的音频通道数
支持的音频通道数
### channelLayouts
......@@ -50,9 +45,9 @@ int32_t AudioPortCap::channelCount[CHANNEL_NUM]
int32_t AudioPortCap::channelLayouts[CHANNEL_NUM]
```
**描述**
**描述:**
支持的音频通道数channel layouts
支持的音频通道数channel layouts
### sampleFormats
......@@ -62,9 +57,9 @@ int32_t AudioPortCap::channelLayouts[CHANNEL_NUM]
int32_t AudioPortCap::sampleFormats[SAMPLE_FMT_NUM]
```
**描述**
**描述:**
支持的音频采样格式,详见[AudioSampleFormat](codec.md#audiosampleformat)
支持的音频采样格式,详见[AudioSampleFormat](_codec.md#audiosampleformat)
### sampleRate
......@@ -74,6 +69,6 @@ int32_t AudioPortCap::sampleFormats[SAMPLE_FMT_NUM]
int32_t AudioPortCap::sampleRate[SAMPLE_RATE_NUM]
```
**描述**
**描述:**
支持的音频采样率,详见[AudioSampleRate](codec.md#audiosamplerate)
支持的音频采样率,详见[AudioSampleRate](_codec.md#audiosamplerate)
# AudioPortCapability
## **概述**
## 概述
音频端口的支持能力。
**Since:**
3.2
**Version:**
1.0
**相关模块:**
[Audio](_audio.md)
## **汇总**
## 汇总
### Public 属性
| 名称 | 描述 |
| -------- | -------- |
| [deviceType](_audio.md#devicetype) | 设备输出、输入类型。 |
| [deviceId](_audio.md#deviceid) | 绑定(bind)设备ID,唯一的设备识别符。 |
| [hardwareMode](_audio.md#hardwaremode) | 是否支持设备绑定处理。 |
| [formatNum](_audio.md#formatnum) | 支持的音频格式数目。 |
| [formats](_audio.md#formats) | 支持的音频格式。 |
| [sampleRateMasks](_audio.md#sampleratemasks) | 支持的音频采样频率(8k、16k、32k、48k)。 |
| [channelMasks](_audio.md#channelmasks) | 设备的声道布局掩码(mask)。 |
| [channelCount](_audio.md#channelcount-22) | 支持的最大声道总数。 |
| [subPortsNum](_audio.md#subportsnum) | 支持的子端口数目(仅用于输出设备)。 |
| [subPorts](_audio.md#subports) | 支持的子端口列表。 |
| [supportSampleFormatNum](_audio.md#supportsampleformatnum) | 支持的音频样本格式数量。 |
| [supportSampleFormats](_audio.md#supportsampleformats) | 支持的音频样本格式。 |
| [deviceType](#devicetype) | unsigned&nbsp;int<br/>设备输出、输入类型。 |
| [deviceId](#deviceid) | unsigned&nbsp;int<br/>设备ID,唯一的设备识别符。 |
| [hardwareMode](#hardwaremode) | boolean<br/>是否支持设备绑定处理。 |
| [formatNum](#formatnum) | unsigned&nbsp;int<br/>支持的音频格式数目。 |
| [channelMasks](#channelmasks) | enum&nbsp;[AudioFormat](_audio.md#audioformat)[]&nbsp;formats&nbsp;unsigned&nbsp;int&nbsp;sampleRateMasks&nbsp;enum&nbsp;[AudioChannelMask](_audio.md#audiochannelmask)<br/>支持的音频格式,详情参考[AudioFormat](_audio.md#audioformat)。 |
| [channelCount](#channelcount) | unsigned&nbsp;int<br/>最大支持的声道总数。 |
| [subPorts](#subports) | struct&nbsp;[AudioSubPortCapability](_audio_sub_port_capability.md)[]<br/>支持的子端口列表,详情参考[AudioSubPortCapability](_audio_sub_port_capability.md)。 |
## 类成员变量说明
### channelCount
```
unsigned int AudioPortCapability::channelCount
```
**描述:**
最大支持的声道总数。
### channelMasks
```
enum AudioFormat [] formats unsigned int sampleRateMasks enum AudioChannelMask AudioPortCapability::channelMasks
```
**描述:**
支持的音频格式,详情参考[AudioFormat](_audio.md#audioformat)
支持的音频采样频率(8k、16k、32k、48k)。 设备的声道布局掩码,详情参考[AudioChannelMask](_audio.md#audiochannelmask)
### deviceId
```
unsigned int AudioPortCapability::deviceId
```
**描述:**
设备ID,唯一的设备识别符。
### deviceType
```
unsigned int AudioPortCapability::deviceType
```
**描述:**
设备输出、输入类型。
### formatNum
```
unsigned int AudioPortCapability::formatNum
```
**描述:**
支持的音频格式数目。
### hardwareMode
```
boolean AudioPortCapability::hardwareMode
```
**描述:**
是否支持设备绑定处理。
### subPorts
```
struct AudioSubPortCapability [] AudioPortCapability::subPorts
```
**描述:**
支持的子端口列表,详情参考[AudioSubPortCapability](_audio_sub_port_capability.md)
# AudioRender
## **概述**
AudioRender音频播放接口。
提供音频播放支持的驱动能力,包括音频控制、音频属性、音频场景、音频音量、获取硬件延迟时间、播放音频帧数据(Render frame)等。
**Since:**
1.0
**Version:**
1.0
**相关模块:**
[Audio](_audio.md)
**参见:**
[AudioControl](_audio_control.md)
[AudioAttribute](_audio_attribute.md)
[AudioScene](_audio_scene.md)
[AudioVolume](_audio_volume.md)
## **汇总**
### Public 属性
| 名称 | 描述 |
| -------- | -------- |
| control | 音频控制能力接口,详情参考[AudioControl](_audio_control.md)。 |
| attr | 音频属性能力接口,详情参考[AudioAttribute](_audio_attribute.md)。 |
| scene | 音频场景能力接口,详情参考[AudioScene](_audio_scene.md)。 |
| volume | 音频音量能力接口,详情参考[AudioVolume](_audio_volume.md)。 |
| ([GetLatency](#getlatency))(struct&nbsp;AudioRender&nbsp;\*render,&nbsp;uint32_t&nbsp;\*ms) | 获取音频硬件驱动估计的延迟时间。 |
| ([RenderFrame](#renderframe))(struct&nbsp;AudioRender&nbsp;\*render,&nbsp;const&nbsp;void&nbsp;\*frame,&nbsp;uint64_t&nbsp;requestBytes,&nbsp;uint64_t&nbsp;\*replyBytes) | 往音频驱动中播放(Render)一帧输出数据(放音,音频下行数据)。 |
| ([GetRenderPosition](#getrenderposition))(struct&nbsp;AudioRender&nbsp;\*render,&nbsp;uint64_t&nbsp;\*frames,&nbsp;struct&nbsp;AudioTimeStamp&nbsp;\*time) | 获取音频输出帧数的上一次计数。 |
| ([SetRenderSpeed](#setrenderspeed))(struct&nbsp;AudioRender&nbsp;\*render,&nbsp;float&nbsp;speed) | 设置一个音频的播放速度。 |
| ([GetRenderSpeed](#getrenderspeed))(struct&nbsp;AudioRender&nbsp;\*render,&nbsp;float&nbsp;\*speed) | 获取一个音频当前的播放速度。 |
| ([SetChannelMode](#setchannelmode))(struct&nbsp;AudioRender&nbsp;\*render,&nbsp;enum&nbsp;AudioChannelMode&nbsp;mode) | 设置音频播放的通道模式。 |
| ([GetChannelMode](#getchannelmode))(struct&nbsp;AudioRender&nbsp;\*render,&nbsp;enum&nbsp;AudioChannelMode&nbsp;\*mode) | 获取音频播放当前的通道模式。 |
| ([RegCallback](#regcallback)&nbsp;)(struct&nbsp;AudioRender&nbsp;\*render,&nbsp;RenderCallback&nbsp;callback,&nbsp;void&nbsp;\*cookie) | 注册音频回调函数,用于放音过程中缓冲区数据写、DrainBuffer完成通知。 |
| ([DrainBuffer](#drainbuffer))(struct&nbsp;AudioRender&nbsp;\*render,&nbsp;enum&nbsp;AudioDrainNotifyType&nbsp;\*type) | 排空缓冲区中的数据。 |
## **类成员变量说明**
### DrainBuffer
```
int32_t(* AudioRender::DrainBuffer) (struct AudioRender *render, enum AudioDrainNotifyType *type)
```
**描述:**
排空缓冲区中的数据。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| render | 输入参数,待操作的音频播放接口对象。 |
| type | 输入参数,DrainBuffer的操作类型,详情请参考[AudioDrainNotifyType](_audio.md#audiodrainnotifytype)。 |
**返回:**
成功返回值0,失败返回负值。
**参见:**
[RegCallback](#regcallback)
### GetChannelMode
```
int32_t(* AudioRender::GetChannelMode) (struct AudioRender *render, enum AudioChannelMode *mode)
```
**描述:**
获取音频播放当前的通道模式。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| render | 输入参数,待操作的音频播放接口对象。|
| mode | 输出参数,获取的通道模式保存到mode中。 |
**返回:**
成功返回值0,失败返回负值。
**参见:**
[SetChannelMode](#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](#renderframe)
### GetRenderSpeed
```
int32_t(* AudioRender::GetRenderSpeed) (struct AudioRender *render, float *speed)
```
**描述:**
获取一个音频当前的播放速度。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| render | 输入参数,待操作的音频播放接口对象。 |
| speed | 输出参数,获取的播放速度保存到speed中。 |
**返回:**
成功返回值0,失败返回负值。
**参见:**
[SetRenderSpeed](#setrenderspeed)
### RegCallback
```
int32_t(* AudioRender::RegCallback) (struct AudioRender *render, RenderCallback callback, void *cookie)
```
**描述:**
注册音频回调函数,用于放音过程中缓冲区数据写、DrainBuffer完成通知。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| render | 输入参数,待操作的音频播放接口对象。 |
| callback | 输入参数,注册的回调函数。 |
| cookie | 输入参数,回调函数的入参。 |
**返回:**
成功返回值0,失败返回负值。
**参见:**
[RegCallback](#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](#getchannelmode)
### SetRenderSpeed
```
int32_t(* AudioRender::SetRenderSpeed) (struct AudioRender *render, float speed)
```
**描述:**
设置一个音频的播放速度。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| render | 输入参数,待操作的音频播放接口对象。 |
| speed | 输入参数,待设置的播放速度。 |
**返回:**
成功返回值0,失败返回负值。
**参见:**
[GetRenderSpeed](#getrenderspeed)
# AudioRoute
## **概述**
## 概述
音频路由信息。
**Since:**
3.2
**Version:**
1.0
**相关模块:**
[Audio](_audio.md)
## **汇总**
## 汇总
### Public 属性
| 名称 | 描述 |
| -------- | -------- |
| [sourcesNum](_audio.md#sourcesnum) | 发送端节点数量。 |
| [sources](_audio.md#sources) | 发送端列表。 |
| [sinksNum](_audio.md#sinksnum) | 接受端节点数量。 |
| [sinks](_audio.md#sinks) | 接受端列表。 |
| [sources](#sources) | struct&nbsp;[AudioRouteNode](_audio_route_node.md)[]<br/>发送端列表,详情参考[AudioRouteNode](_audio_route_node.md)。&nbsp; |
| [sinks](#sinks) | struct&nbsp;[AudioRouteNode](_audio_route_node.md)[]<br/>接受端列表,详情参考[AudioRouteNode](_audio_route_node.md)。&nbsp; |
## 类成员变量说明
### sinks
```
struct AudioRouteNode [] AudioRoute::sinks
```
**描述:**
接受端列表,详情参考[AudioRouteNode](_audio_route_node.md)
### sources
```
struct AudioRouteNode [] AudioRoute::sources
```
**描述:**
发送端列表,详情参考[AudioRouteNode](_audio_route_node.md)
# AudioRouteNode
## **概述**
## 概述
音频路由节点。
**Since:**
3.2
**Version:**
1.0
**相关模块:**
[Audio](_audio.md)
## **汇总**
## 汇总
### Public 属性
| 名称 | 描述 |
| -------- | -------- |
| [portId](_audio.md#portid-44) | 音频端口ID。 |
| [role](_audio.md#role) | 指定端口角色为sink或source。 |
| [type](_audio.md#type-33) | 指定端口类型。 |
| [device](_audio.md#device) | 设备特定信息。 |
| [mix](_audio.md#mix) | 音轨特定信息。 |
| [session](_audio.md#session) | 会话特定信息。 |
| [portId](#portid) | int<br/>音频端口ID。&nbsp; |
| [role](#role) | enum&nbsp;[AudioPortRole](_audio.md#audioportrole)<br/>指定端口角色为发送端或接收端,详情参考[AudioPortRole](_audio.md#audioportrole)。&nbsp; |
| [type](#type) | enum&nbsp;[AudioPortType](_audio.md#audioporttype)<br/>指定端口类型可以为设备类型、复合类型、绘画类型,详情参考[AudioPortType](_audio.md#audioporttype)。&nbsp; |
| [ext](#ext) | struct&nbsp;[AudioInfo](_audio_info.md)<br/>音频端口特定信息,详情参考[AudioInfo](_audio_info.md)。&nbsp; |
## 类成员变量说明
### ext
```
struct AudioInfo AudioRouteNode::ext
```
**描述:**
音频端口特定信息,详情参考[AudioInfo](_audio_info.md)
### portId
```
int AudioRouteNode::portId
```
**描述:**
音频端口ID。
### role
```
enum AudioPortRole AudioRouteNode::role
```
**描述:**
指定端口角色为发送端或接收端,详情参考[AudioPortRole](_audio.md#audioportrole)
### type
```
enum AudioPortType AudioRouteNode::type
```
**描述:**
指定端口类型可以为设备类型、复合类型、绘画类型,详情参考[AudioPortType](_audio.md#audioporttype)
此差异已折叠。
# BiasAdd
## 概述
对给出的输入张量上的各个维度方向上的数据进行偏置。
该算子对应的[NodeType](_n_n_rt.md#nodetype)为NODE_TYPE_BIAS_ADD。
输入:
- x,n维tensor。
- bias,偏置值tensor。
输出:
- 输出张量,根据输入中每个维度方向偏置之后的结果。
**Since:**
3.2
**Version:**
1.0
**相关模块:**
[NNRt](_n_n_rt.md)
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
此差异已折叠。
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册