提交 0910fe0b 编写于 作者: D duangavin123

hdi api

Signed-off-by: Nduangavin123 <duanxichao@huawei.com>
上级 248e6194
# DAC
## **汇总**
### 文件
| 文件 | 描述 |
| -------- | -------- |
| [dac_if.h](dac__if_8h.md) | 声明标准DAC接口函数。 |
### 类
| 类 | 描述 |
| -------- | -------- |
| [DacIoMsg](_dac_io_msg.md) | DAC设备信息传输结构体&nbsp;[更多...](_dac_io_msg.md) |
### 函数
| 函数 | 描述 |
| -------- | -------- |
| [DacOpen](#dacopen)&nbsp;(uint32_t&nbsp;number) | 获取DAC控制器的句柄。&nbsp;[更多...](#dacopen) |
| [DacClose](#dacclose)&nbsp;(DevHandle&nbsp;handle) | 释放DAC控制器的句柄。&nbsp;[更多...](#dacclose) |
| [DacWrite](#dacwrite)&nbsp;(DevHandle&nbsp;handle,&nbsp;uint32_t&nbsp;channel,&nbsp;uint32_t&nbsp;val) | 启动DAC设备进行传输,将目标值写入指定的DAC通道。&nbsp;[更多...](#dacwrite) |
### 变量
| 变量&nbsp;名称 | 描述 |
| -------- | -------- |
| [DacIoMsg::number](#number) | DAC设备号 |
| [DacIoMsg::channel](#channel) | DAC设备通道号 |
## **详细描述**
提供数模转换器 (DAC) 接口。
该模块允许驱动程序在DAC控制器上执行操作以访问DAC通道上的设备,包括创建和销毁DAC控制器句柄和写入数据。
**Since:**
3.1
## **函数说明**
### DacClose()
```
void DacClose (DevHandle handle)
```
**描述:**
释放DAC控制器的句柄。
如果不再需要访问DAC控制器,则应调用该函数关闭其句柄,以释放未使用的内存资源。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 表示指向DAC控制器的设备句柄的指针。 |
**Since:**
3.1
### DacOpen()
```
DevHandle DacOpen (uint32_t number)
```
**描述:**
获取DAC控制器的句柄。
您必须在访问DAC设备之前调用此函数。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| number | 表示DAC控制器ID。 |
**返回:**
DAC控制器的DevHandle指针 表示操作成功。
NULL 表示操作失败。
**Since:**
3.1
### DacWrite()
```
int32_t DacWrite (DevHandle handle, uint32_t channel, uint32_t val )
```
**描述:**
启动DAC设备进行传输,将目标值写入指定的DAC通道。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 表示通过DacOpen获取的DAC控制器设备句柄的指针。 |
| channel | 表示DAC传输消息所通过的通道。 |
| val | 表示设定的目标值。 |
**返回:**
0 表示操作成功。
负值 表示操作失败。
**Since:**
3.1
## **变量说明**
### channel
```
uint32_t DacIoMsg::channel
```
**描述:**
DAC设备通道号
### number
```
uint32_t DacIoMsg::number
```
**描述:**
DAC设备号
# DacIoMsg
## **概述**
**所属模块:**
[DAC](_d_a_c.md)
## **汇总**
### Public 属性
| Public&nbsp;属性 | 描述 |
| -------- | -------- |
| [number](_d_a_c.md#number) | DAC设备号 |
| [channel](_d_a_c.md#channel) | DAC设备通道号 |
## **详细描述**
DAC设备信息传输结构体。
# dac_if.h
## **概述**
**所属模块:**
[DAC](_d_a_c.md)
## **汇总**
### 类
| 类 | 描述 |
| -------- | -------- |
| [DacIoMsg](_dac_io_msg.md) | DAC设备信息传输结构体&nbsp;[更多...](_dac_io_msg.md) |
### 函数
| 函数 | 描述 |
| -------- | -------- |
| [DacOpen](_d_a_c.md#dacopen)&nbsp;(uint32_t&nbsp;number) | 获取DAC控制器的句柄。&nbsp;[更多...](_d_a_c.md#dacopen) |
| [DacClose](_d_a_c.md#dacclose)&nbsp;(DevHandle&nbsp;handle) | 释放DAC控制器的句柄。&nbsp;[更多...](_d_a_c.md#dacclose) |
| [DacWrite](_d_a_c.md#dacwrite)&nbsp;(DevHandle&nbsp;handle,&nbsp;uint32_t&nbsp;channel,&nbsp;uint32_t&nbsp;val) | 启动DAC设备进行传输,将目标值写入指定的DAC通道。&nbsp;[更多...](_d_a_c.md#dacwrite) |
## **详细描述**
声明标准DAC接口函数。
**Since:**
3.1
# Native API参数参考 # HDI 接口参考
- NativeAPI参考 - 模块
- [Audio](_audio.md) - [Audio](_audio.md)
- [Battery](battery.md) - [Battery](battery.md)
- [Camera](_camera.md) - [Camera](_camera.md)
- [Codec](_codec.md) - [Codec](_codec.md)
- [Display](_display.md) - [Display](_display.md)
- [DAC](_d_a_c.md)
- [HdfFaceAuth](_hdf_face_auth.md) - [HdfFaceAuth](_hdf_face_auth.md)
- [Input](_input.md) - [Input](_input.md)
- [Light](_light.md) - [Light](_light.md)
...@@ -34,7 +33,6 @@ ...@@ -34,7 +33,6 @@
- [codec_component_if.h](codec__component__if_8h.md) - [codec_component_if.h](codec__component__if_8h.md)
- [codec_component_manager.h](codec__component__manager_8h.md) - [codec_component_manager.h](codec__component__manager_8h.md)
- [codec_component_type.h](codec__component__type_8h.md) - [codec_component_type.h](codec__component__type_8h.md)
- [dac_if.h](dac__if_8h.md)
- [display_device.h](display__device_8h.md) - [display_device.h](display__device_8h.md)
- [display_gfx.h](display__gfx_8h.md) - [display_gfx.h](display__gfx_8h.md)
- [display_gralloc.h](display__gralloc_8h.md) - [display_gralloc.h](display__gralloc_8h.md)
...@@ -123,7 +121,6 @@ ...@@ -123,7 +121,6 @@
- [CodecComponentType](_codec_component_type.md) - [CodecComponentType](_codec_component_type.md)
- [CompVerInfo](_comp_ver_info.md) - [CompVerInfo](_comp_ver_info.md)
- [CredentialInfo](_credential_info.md) - [CredentialInfo](_credential_info.md)
- [DacIoMsg](_dac_io_msg.md)
- [DeviceFuncs](_device_funcs.md) - [DeviceFuncs](_device_funcs.md)
- [DeviceInfo](_device_info.md) - [DeviceInfo](_device_info.md)
- [DisplayCapability](_display_capability.md) - [DisplayCapability](_display_capability.md)
...@@ -131,9 +128,11 @@ ...@@ -131,9 +128,11 @@
- [DisplayModeInfo](_display_mode_info.md) - [DisplayModeInfo](_display_mode_info.md)
- [EnrolledInfo](_enrolled_info.md) - [EnrolledInfo](_enrolled_info.md)
- [EnrollParam](_enroll_param.md) - [EnrollParam](_enroll_param.md)
- [EnrollResultInfo](_enroll_resultinfo.md)
- [EventInfo](_event_info.md) - [EventInfo](_event_info.md)
- [EventPackage](_event_package.md) - [EventPackage](_event_package.md)
- [ExecutorInfo](_executor_info.md) - [ExecutorInfo](_executor_info.md)
- [ExecutorInfo](_user_executor_info.md)
- [ExecutorRegisterInfo](_executor_register_info.md) - [ExecutorRegisterInfo](_executor_register_info.md)
- [ExecutorSendMsg](_executor_send_msg.md) - [ExecutorSendMsg](_executor_send_msg.md)
- [GetBufferHandleUsageParams](_get_buffer_handle_usage_params.md) - [GetBufferHandleUsageParams](_get_buffer_handle_usage_params.md)
......
...@@ -29,6 +29,6 @@ ...@@ -29,6 +29,6 @@
## **详细描述** ## **详细描述**
扩展数据句柄结构体定义 扩展数据句柄结构体定义
YUV描述信息结构体定义 YUV描述信息结构体定义
...@@ -58,7 +58,7 @@ ...@@ -58,7 +58,7 @@
### 枚举 ### 枚举
| 枚举名称 | 描述 | | 枚举 | 描述 |
| -------- | -------- | | -------- | -------- |
| [AudioPortDirection](#audioportdirection)&nbsp;{&nbsp;PORT_OUT&nbsp;=&nbsp;0x1u,&nbsp;PORT_IN&nbsp;=&nbsp;0x2u,&nbsp;PORT_OUT_IN&nbsp;=&nbsp;0x3u&nbsp;} | 音频端口的类型&nbsp;[更多...](#audioportdirection) | | [AudioPortDirection](#audioportdirection)&nbsp;{&nbsp;PORT_OUT&nbsp;=&nbsp;0x1u,&nbsp;PORT_IN&nbsp;=&nbsp;0x2u,&nbsp;PORT_OUT_IN&nbsp;=&nbsp;0x3u&nbsp;} | 音频端口的类型&nbsp;[更多...](#audioportdirection) |
| [AudioPortPin](#audioportpin)&nbsp;{&nbsp;&nbsp;&nbsp;PIN_NONE&nbsp;=&nbsp;0x0u,&nbsp;PIN_OUT_SPEAKER&nbsp;=&nbsp;0x1u,&nbsp;PIN_OUT_HEADSET&nbsp;=&nbsp;0x2u,&nbsp;PIN_OUT_LINEOUT&nbsp;=&nbsp;0x4u,&nbsp;&nbsp;&nbsp;PIN_OUT_HDMI&nbsp;=&nbsp;0x8u,&nbsp;PIN_OUT_USB&nbsp;=&nbsp;0x10u,&nbsp;PIN_OUT_USB_EXT&nbsp;=&nbsp;0x20u,&nbsp;PIN_IN_MIC&nbsp;=&nbsp;0x8000001u,&nbsp;&nbsp;&nbsp;PIN_IN_HS_MIC&nbsp;=&nbsp;0x8000002u,&nbsp;PIN_IN_LINEIN&nbsp;=&nbsp;0x8000004u,&nbsp;PIN_IN_USB_EXT&nbsp;=&nbsp;0x8000008u&nbsp;} | 音频适配器端口的PIN脚&nbsp;[更多...](#audioportpin) | | [AudioPortPin](#audioportpin)&nbsp;{&nbsp;&nbsp;&nbsp;PIN_NONE&nbsp;=&nbsp;0x0u,&nbsp;PIN_OUT_SPEAKER&nbsp;=&nbsp;0x1u,&nbsp;PIN_OUT_HEADSET&nbsp;=&nbsp;0x2u,&nbsp;PIN_OUT_LINEOUT&nbsp;=&nbsp;0x4u,&nbsp;&nbsp;&nbsp;PIN_OUT_HDMI&nbsp;=&nbsp;0x8u,&nbsp;PIN_OUT_USB&nbsp;=&nbsp;0x10u,&nbsp;PIN_OUT_USB_EXT&nbsp;=&nbsp;0x20u,&nbsp;PIN_IN_MIC&nbsp;=&nbsp;0x8000001u,&nbsp;&nbsp;&nbsp;PIN_IN_HS_MIC&nbsp;=&nbsp;0x8000002u,&nbsp;PIN_IN_LINEIN&nbsp;=&nbsp;0x8000004u,&nbsp;PIN_IN_USB_EXT&nbsp;=&nbsp;0x8000008u&nbsp;} | 音频适配器端口的PIN脚&nbsp;[更多...](#audioportpin) |
...@@ -85,7 +85,7 @@ ...@@ -85,7 +85,7 @@
### 变量 ### 变量
| 变量&nbsp;名称 | 描述 | | 变量 | 描述 |
| -------- | -------- | | -------- | -------- |
| [AudioPort::dir](#dir) | 音频端口的类型。 | | [AudioPort::dir](#dir) | 音频端口的类型。 |
| [AudioPort::portId](#portid-14) | 音频端口的ID。 | | [AudioPort::portId](#portid-14) | 音频端口的ID。 |
...@@ -180,7 +180,7 @@ typedef int32_t(* RenderCallback) (enum AudioCallbackType, void *reserved, void ...@@ -180,7 +180,7 @@ typedef int32_t(* RenderCallback) (enum AudioCallbackType, void *reserved, void
**描述:** **描述:**
回调函数指针 回调函数指针
**参数:** **参数:**
...@@ -211,7 +211,7 @@ enum AudioCallbackType ...@@ -211,7 +211,7 @@ enum AudioCallbackType
**描述:** **描述:**
回调函数通知事件类型 回调函数通知事件类型
| 枚举值 | 描述 | | 枚举值 | 描述 |
| -------- | -------- | | -------- | -------- |
...@@ -231,7 +231,7 @@ enum AudioCategory ...@@ -231,7 +231,7 @@ enum AudioCategory
**描述:** **描述:**
音频类型(category) 音频类型(category)
| 枚举值 | 描述 | | 枚举值 | 描述 |
| -------- | -------- | | -------- | -------- |
...@@ -250,9 +250,9 @@ enum AudioChannelMask ...@@ -250,9 +250,9 @@ enum AudioChannelMask
**描述:** **描述:**
音频通道掩码(mask) 音频通道掩码(mask)
定义音频声道的位置 定义音频声道的位置
| 枚举值 | 描述 | | 枚举值 | 描述 |
| -------- | -------- | | -------- | -------- |
...@@ -271,7 +271,7 @@ enum AudioChannelMode ...@@ -271,7 +271,7 @@ enum AudioChannelMode
**描述:** **描述:**
音频播放的通道模式 音频播放的通道模式
> ![icon-notice.gif](public_sys-resources/icon-notice.gif) **须知:** > ![icon-notice.gif](public_sys-resources/icon-notice.gif) **须知:**
> 下面的模式是针对双通道立体声的音频播放而设置,其他不支持。 > 下面的模式是针对双通道立体声的音频播放而设置,其他不支持。
...@@ -297,7 +297,7 @@ enum AudioDrainNotifyType ...@@ -297,7 +297,7 @@ enum AudioDrainNotifyType
**描述:** **描述:**
DrainBuffer函数结束类型 DrainBuffer函数结束类型
| 枚举值 | 描述 | | 枚举值 | 描述 |
| -------- | -------- | | -------- | -------- |
...@@ -314,7 +314,7 @@ enum AudioFormat ...@@ -314,7 +314,7 @@ enum AudioFormat
**描述:** **描述:**
音频格式 音频格式
| 枚举值 | 描述 | | 枚举值 | 描述 |
| -------- | -------- | | -------- | -------- |
...@@ -342,7 +342,7 @@ enum AudioPortDirection ...@@ -342,7 +342,7 @@ enum AudioPortDirection
**描述:** **描述:**
音频端口的类型 音频端口的类型
| 枚举值 | 描述 | | 枚举值 | 描述 |
| -------- | -------- | | -------- | -------- |
...@@ -360,7 +360,7 @@ enum AudioPortPassthroughMode ...@@ -360,7 +360,7 @@ enum AudioPortPassthroughMode
**描述:** **描述:**
音频端口的数据透传模式 音频端口的数据透传模式
| 枚举值 | 描述 | | 枚举值 | 描述 |
| -------- | -------- | | -------- | -------- |
...@@ -379,7 +379,7 @@ enum AudioPortPin ...@@ -379,7 +379,7 @@ enum AudioPortPin
**描述:** **描述:**
音频适配器端口的PIN脚 音频适配器端口的PIN脚
| 枚举值 | 描述 | | 枚举值 | 描述 |
| -------- | -------- | | -------- | -------- |
...@@ -405,7 +405,7 @@ enum AudioPortRole ...@@ -405,7 +405,7 @@ enum AudioPortRole
**描述:** **描述:**
音频端口角色 音频端口角色
| 枚举值 | 描述 | | 枚举值 | 描述 |
| -------- | -------- | | -------- | -------- |
...@@ -442,7 +442,7 @@ enum AudioSampleFormat ...@@ -442,7 +442,7 @@ enum AudioSampleFormat
**描述:** **描述:**
原始音频样本格式 原始音频样本格式
| 枚举值 | 描述 | | 枚举值 | 描述 |
| -------- | -------- | | -------- | -------- |
...@@ -492,7 +492,7 @@ enum AudioSampleRatesMask ...@@ -492,7 +492,7 @@ enum AudioSampleRatesMask
**描述:** **描述:**
音频采样频率MASK 音频采样频率MASK
| 枚举值 | 描述 | | 枚举值 | 描述 |
| -------- | -------- | | -------- | -------- |
...@@ -519,7 +519,7 @@ enum AudioSessionType ...@@ -519,7 +519,7 @@ enum AudioSessionType
**描述:** **描述:**
端口会话类型 端口会话类型
| 枚举值 | 描述 | | 枚举值 | 描述 |
| -------- | -------- | | -------- | -------- |
......
...@@ -15,16 +15,16 @@ ...@@ -15,16 +15,16 @@
| Public&nbsp;属性 | 描述 | | Public&nbsp;属性 | 描述 |
| -------- | -------- | | -------- | -------- |
| (&nbsp;[InitAllPorts](#initallports)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295254292.xml#xref241992660083931,link:zh-cn_topic_0000001295254292.xml](zh-cn_topic_0000001295254292.xml)&nbsp;\*adapter) | 初始化一个音频适配器所有的端口驱动&nbsp;[更多...](#initallports) | | (&nbsp;[InitAllPorts](#initallports)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357342201.xml#xref241992660083931,link:zh-cn_topic_0000001357342201.xml](zh-cn_topic_0000001357342201.xml)&nbsp;\*adapter) | 初始化一个音频适配器所有的端口驱动&nbsp;[更多...](#initallports) |
| (&nbsp;[CreateRender](#createrender)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295254292.xml#xref1249519733083931,link:zh-cn_topic_0000001295254292.xml](zh-cn_topic_0000001295254292.xml)&nbsp;\*adapter,&nbsp;const&nbsp;struct&nbsp;[AudioDeviceDescriptor](_audio_device_descriptor.md)&nbsp;\*desc,&nbsp;const&nbsp;struct&nbsp;[AudioSampleAttributes](_audio_sample_attributes.md)&nbsp;\*attrs,&nbsp;struct&nbsp;[AudioRender](_audio_render.md)&nbsp;\*\*render) | 创建一个音频播放(render)接口的对象&nbsp;[更多...](#createrender) | | (&nbsp;[CreateRender](#createrender)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357342201.xml#xref1249519733083931,link:zh-cn_topic_0000001357342201.xml](zh-cn_topic_0000001357342201.xml)&nbsp;\*adapter,&nbsp;const&nbsp;struct&nbsp;[AudioDeviceDescriptor](_audio_device_descriptor.md)&nbsp;\*desc,&nbsp;const&nbsp;struct&nbsp;[AudioSampleAttributes](_audio_sample_attributes.md)&nbsp;\*attrs,&nbsp;struct&nbsp;[AudioRender](_audio_render.md)&nbsp;\*\*render) | 创建一个音频播放(render)接口的对象&nbsp;[更多...](#createrender) |
| (&nbsp;[DestroyRender](#destroyrender)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295254292.xml#xref194522153083931,link:zh-cn_topic_0000001295254292.xml](zh-cn_topic_0000001295254292.xml)&nbsp;\*adapter,&nbsp;struct&nbsp;[AudioRender](_audio_render.md)&nbsp;\*render) | 销毁一个音频播放(render)接口的对象&nbsp;[更多...](#destroyrender) | | (&nbsp;[DestroyRender](#destroyrender)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357342201.xml#xref194522153083931,link:zh-cn_topic_0000001357342201.xml](zh-cn_topic_0000001357342201.xml)&nbsp;\*adapter,&nbsp;struct&nbsp;[AudioRender](_audio_render.md)&nbsp;\*render) | 销毁一个音频播放(render)接口的对象&nbsp;[更多...](#destroyrender) |
| (&nbsp;[CreateCapture](#createcapture)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295254292.xml#xref933286157083931,link:zh-cn_topic_0000001295254292.xml](zh-cn_topic_0000001295254292.xml)&nbsp;\*adapter,&nbsp;const&nbsp;struct&nbsp;[AudioDeviceDescriptor](_audio_device_descriptor.md)&nbsp;\*desc,&nbsp;const&nbsp;struct&nbsp;[AudioSampleAttributes](_audio_sample_attributes.md)&nbsp;\*attrs,&nbsp;struct&nbsp;[AudioCapture](_audio_capture.md)&nbsp;\*\*capture) | 创建一个音频录音(capture)接口的对象&nbsp;[更多...](#createcapture) | | (&nbsp;[CreateCapture](#createcapture)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357342201.xml#xref933286157083931,link:zh-cn_topic_0000001357342201.xml](zh-cn_topic_0000001357342201.xml)&nbsp;\*adapter,&nbsp;const&nbsp;struct&nbsp;[AudioDeviceDescriptor](_audio_device_descriptor.md)&nbsp;\*desc,&nbsp;const&nbsp;struct&nbsp;[AudioSampleAttributes](_audio_sample_attributes.md)&nbsp;\*attrs,&nbsp;struct&nbsp;[AudioCapture](_audio_capture.md)&nbsp;\*\*capture) | 创建一个音频录音(capture)接口的对象&nbsp;[更多...](#createcapture) |
| (&nbsp;[DestroyCapture](#destroycapture)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295254292.xml#xref145884804083931,link:zh-cn_topic_0000001295254292.xml](zh-cn_topic_0000001295254292.xml)&nbsp;\*adapter,&nbsp;struct&nbsp;[AudioCapture](_audio_capture.md)&nbsp;\*capture) | 销毁一个音频录音(capture)接口的对象&nbsp;[更多...](#destroycapture) | | (&nbsp;[DestroyCapture](#destroycapture)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357342201.xml#xref145884804083931,link:zh-cn_topic_0000001357342201.xml](zh-cn_topic_0000001357342201.xml)&nbsp;\*adapter,&nbsp;struct&nbsp;[AudioCapture](_audio_capture.md)&nbsp;\*capture) | 销毁一个音频录音(capture)接口的对象&nbsp;[更多...](#destroycapture) |
| (&nbsp;[GetPortCapability](#getportcapability)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295254292.xml#xref974312331083931,link:zh-cn_topic_0000001295254292.xml](zh-cn_topic_0000001295254292.xml)&nbsp;\*adapter,&nbsp;struct&nbsp;[AudioPort](_audio_port.md)&nbsp;\*port,&nbsp;struct&nbsp;[AudioPortCapability](_audio_port_capability.md)&nbsp;\*capability) | 获取一个音频适配器的端口驱动的能力集&nbsp;[更多...](#getportcapability) | | (&nbsp;[GetPortCapability](#getportcapability)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357342201.xml#xref974312331083931,link:zh-cn_topic_0000001357342201.xml](zh-cn_topic_0000001357342201.xml)&nbsp;\*adapter,&nbsp;struct&nbsp;[AudioPort](_audio_port.md)&nbsp;\*port,&nbsp;struct&nbsp;[AudioPortCapability](_audio_port_capability.md)&nbsp;\*capability) | 获取一个音频适配器的端口驱动的能力集&nbsp;[更多...](#getportcapability) |
| (&nbsp;[SetPassthroughMode](#setpassthroughmode)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295254292.xml#xref1432990851083931,link:zh-cn_topic_0000001295254292.xml](zh-cn_topic_0000001295254292.xml)&nbsp;\*adapter,&nbsp;struct&nbsp;[AudioPort](_audio_port.md)&nbsp;\*port,&nbsp;enum&nbsp;[AudioPortPassthroughMode](_audio.md#audioportpassthroughmode)&nbsp;mode) | 设置音频端口驱动的数据透传模式&nbsp;[更多...](#setpassthroughmode) | | (&nbsp;[SetPassthroughMode](#setpassthroughmode)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357342201.xml#xref1432990851083931,link:zh-cn_topic_0000001357342201.xml](zh-cn_topic_0000001357342201.xml)&nbsp;\*adapter,&nbsp;struct&nbsp;[AudioPort](_audio_port.md)&nbsp;\*port,&nbsp;enum&nbsp;[AudioPortPassthroughMode](_audio.md#audioportpassthroughmode)&nbsp;mode) | 设置音频端口驱动的数据透传模式&nbsp;[更多...](#setpassthroughmode) |
| (&nbsp;[GetPassthroughMode](#getpassthroughmode)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295254292.xml#xref883432727083931,link:zh-cn_topic_0000001295254292.xml](zh-cn_topic_0000001295254292.xml)&nbsp;\*adapter,&nbsp;struct&nbsp;[AudioPort](_audio_port.md)&nbsp;\*port,&nbsp;enum&nbsp;[AudioPortPassthroughMode](_audio.md#audioportpassthroughmode)&nbsp;\*mode) | 获取音频端口驱动的数据透传模式&nbsp;[更多...](#getpassthroughmode) | | (&nbsp;[GetPassthroughMode](#getpassthroughmode)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357342201.xml#xref883432727083931,link:zh-cn_topic_0000001357342201.xml](zh-cn_topic_0000001357342201.xml)&nbsp;\*adapter,&nbsp;struct&nbsp;[AudioPort](_audio_port.md)&nbsp;\*port,&nbsp;enum&nbsp;[AudioPortPassthroughMode](_audio.md#audioportpassthroughmode)&nbsp;\*mode) | 获取音频端口驱动的数据透传模式&nbsp;[更多...](#getpassthroughmode) |
| (&nbsp;[UpdateAudioRoute](#updateaudioroute)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295254292.xml#xref362795572083931,link:zh-cn_topic_0000001295254292.xml](zh-cn_topic_0000001295254292.xml)&nbsp;\*adapter,&nbsp;const&nbsp;struct&nbsp;[AudioRoute](_audio_route.md)&nbsp;\*route,&nbsp;int32_t&nbsp;\*routeHandle) | 更新一个或多个发送端和接受端之间的路由&nbsp;[更多...](#updateaudioroute) | | (&nbsp;[UpdateAudioRoute](#updateaudioroute)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357342201.xml#xref362795572083931,link:zh-cn_topic_0000001357342201.xml](zh-cn_topic_0000001357342201.xml)&nbsp;\*adapter,&nbsp;const&nbsp;struct&nbsp;[AudioRoute](_audio_route.md)&nbsp;\*route,&nbsp;int32_t&nbsp;\*routeHandle) | 更新一个或多个发送端和接受端之间的路由&nbsp;[更多...](#updateaudioroute) |
| (&nbsp;[ReleaseAudioRoute](#releaseaudioroute)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295254292.xml#xref410918381083931,link:zh-cn_topic_0000001295254292.xml](zh-cn_topic_0000001295254292.xml)&nbsp;\*adapter,&nbsp;int32_t&nbsp;routeHandle) | 释放一个音频路由.&nbsp;[更多...](#releaseaudioroute) | | (&nbsp;[ReleaseAudioRoute](#releaseaudioroute)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357342201.xml#xref410918381083931,link:zh-cn_topic_0000001357342201.xml](zh-cn_topic_0000001357342201.xml)&nbsp;\*adapter,&nbsp;int32_t&nbsp;routeHandle) | 释放一个音频路由.&nbsp;[更多...](#releaseaudioroute) |
## **详细描述** ## **详细描述**
......
...@@ -19,8 +19,8 @@ ...@@ -19,8 +19,8 @@
| attr | 音频属性能力接口,详情参考[AudioAttribute](_audio_attribute.md) | | attr | 音频属性能力接口,详情参考[AudioAttribute](_audio_attribute.md) |
| scene | 音频场景能力接口,详情参考[AudioScene](_audio_scene.md) | | scene | 音频场景能力接口,详情参考[AudioScene](_audio_scene.md) |
| volume | 音频音量能力接口,详情参考[AudioVolume](_audio_volume.md) | | volume | 音频音量能力接口,详情参考[AudioVolume](_audio_volume.md) |
| (&nbsp;[CaptureFrame](#captureframe)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001348293893.xml#xref1398623145083931,link:zh-cn_topic_0000001348293893.xml](zh-cn_topic_0000001348293893.xml)&nbsp;\*capture,&nbsp;void&nbsp;\*frame,&nbsp;uint64_t&nbsp;requestBytes,&nbsp;uint64_t&nbsp;\*replyBytes) | 从音频驱动中录制(capture)一帧输入数据(录音,音频上行数据)&nbsp;[更多...](#captureframe) | | (&nbsp;[CaptureFrame](#captureframe)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357621449.xml#xref1398623145083931,link:zh-cn_topic_0000001357621449.xml](zh-cn_topic_0000001357621449.xml)&nbsp;\*capture,&nbsp;void&nbsp;\*frame,&nbsp;uint64_t&nbsp;requestBytes,&nbsp;uint64_t&nbsp;\*replyBytes) | 从音频驱动中录制(capture)一帧输入数据(录音,音频上行数据)&nbsp;[更多...](#captureframe) |
| (&nbsp;[GetCapturePosition](#getcaptureposition)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001348293893.xml#xref599411735083931,link:zh-cn_topic_0000001348293893.xml](zh-cn_topic_0000001348293893.xml)&nbsp;\*capture,&nbsp;uint64_t&nbsp;\*frames,&nbsp;struct&nbsp;[AudioTimeStamp](_audio_time_stamp.md)&nbsp;\*time) | 获取音频输入帧数的上一次计数&nbsp;[更多...](#getcaptureposition) | | (&nbsp;[GetCapturePosition](#getcaptureposition)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357621449.xml#xref599411735083931,link:zh-cn_topic_0000001357621449.xml](zh-cn_topic_0000001357621449.xml)&nbsp;\*capture,&nbsp;uint64_t&nbsp;\*frames,&nbsp;struct&nbsp;[AudioTimeStamp](_audio_time_stamp.md)&nbsp;\*time) | 获取音频输入帧数的上一次计数&nbsp;[更多...](#getcaptureposition) |
## **详细描述** ## **详细描述**
......
...@@ -18,7 +18,7 @@ ...@@ -18,7 +18,7 @@
| (&nbsp;[GetAllAdapters](#getalladapters)&nbsp;)(struct&nbsp;AudioAdapterManager&nbsp;\*manager,&nbsp;struct&nbsp;[AudioAdapterDescriptor](_audio_adapter_descriptor.md)&nbsp;\*\*descs,&nbsp;int&nbsp;\*size) | 获取音频驱动中支持的所有适配器的列表&nbsp;[更多...](#getalladapters) | | (&nbsp;[GetAllAdapters](#getalladapters)&nbsp;)(struct&nbsp;AudioAdapterManager&nbsp;\*manager,&nbsp;struct&nbsp;[AudioAdapterDescriptor](_audio_adapter_descriptor.md)&nbsp;\*\*descs,&nbsp;int&nbsp;\*size) | 获取音频驱动中支持的所有适配器的列表&nbsp;[更多...](#getalladapters) |
| (&nbsp;[LoadAdapter](#loadadapter)&nbsp;)(struct&nbsp;AudioAdapterManager&nbsp;\*manager,&nbsp;const&nbsp;struct&nbsp;[AudioAdapterDescriptor](_audio_adapter_descriptor.md)&nbsp;\*desc,&nbsp;struct&nbsp;[AudioAdapter](_audio_adapter.md)&nbsp;\*\*adapter) | 加载一个音频适配器(声卡)的驱动&nbsp;[更多...](#loadadapter) | | (&nbsp;[LoadAdapter](#loadadapter)&nbsp;)(struct&nbsp;AudioAdapterManager&nbsp;\*manager,&nbsp;const&nbsp;struct&nbsp;[AudioAdapterDescriptor](_audio_adapter_descriptor.md)&nbsp;\*desc,&nbsp;struct&nbsp;[AudioAdapter](_audio_adapter.md)&nbsp;\*\*adapter) | 加载一个音频适配器(声卡)的驱动&nbsp;[更多...](#loadadapter) |
| (&nbsp;[UnloadAdapter](#unloadadapter)&nbsp;)(struct&nbsp;AudioAdapterManager&nbsp;\*manager,&nbsp;struct&nbsp;[AudioAdapter](_audio_adapter.md)&nbsp;\*adapter) | 卸载音频适配器(声卡)的驱动&nbsp;[更多...](#unloadadapter) | | (&nbsp;[UnloadAdapter](#unloadadapter)&nbsp;)(struct&nbsp;AudioAdapterManager&nbsp;\*manager,&nbsp;struct&nbsp;[AudioAdapter](_audio_adapter.md)&nbsp;\*adapter) | 卸载音频适配器(声卡)的驱动&nbsp;[更多...](#unloadadapter) |
| (&nbsp;[ReleaseAudioManagerObject](#releaseaudiomanagerobject)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001348413505.xml#xref1843940824083931,link:zh-cn_topic_0000001348413505.xml](zh-cn_topic_0000001348413505.xml)&nbsp;\*object) | 释放音频管理接口对象&nbsp;[更多...](#releaseaudiomanagerobject) | | (&nbsp;[ReleaseAudioManagerObject](#releaseaudiomanagerobject)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001304382264.xml#xref1843940824083931,link:zh-cn_topic_0000001304382264.xml](zh-cn_topic_0000001304382264.xml)&nbsp;\*object) | 释放音频管理接口对象&nbsp;[更多...](#releaseaudiomanagerobject) |
## **详细描述** ## **详细描述**
......
...@@ -19,15 +19,15 @@ ...@@ -19,15 +19,15 @@
| attr | 音频属性能力接口,详情参考[AudioAttribute](_audio_attribute.md) | | attr | 音频属性能力接口,详情参考[AudioAttribute](_audio_attribute.md) |
| scene | 音频场景能力接口,详情参考[AudioScene](_audio_scene.md) | | scene | 音频场景能力接口,详情参考[AudioScene](_audio_scene.md) |
| volume | 音频音量能力接口,详情参考[AudioVolume](_audio_volume.md) | | volume | 音频音量能力接口,详情参考[AudioVolume](_audio_volume.md) |
| (&nbsp;[GetLatency](#getlatency)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001348413529.xml#xref1137711430083931,link:zh-cn_topic_0000001348413529.xml](zh-cn_topic_0000001348413529.xml)&nbsp;\*render,&nbsp;uint32_t&nbsp;\*ms) | 获取音频硬件驱动估计的延迟时间&nbsp;[更多...](#getlatency) | | (&nbsp;[GetLatency](#getlatency)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357381989.xml#xref1137711430083931,link:zh-cn_topic_0000001357381989.xml](zh-cn_topic_0000001357381989.xml)&nbsp;\*render,&nbsp;uint32_t&nbsp;\*ms) | 获取音频硬件驱动估计的延迟时间&nbsp;[更多...](#getlatency) |
| (&nbsp;[RenderFrame](#renderframe)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001348413529.xml#xref1032115116083931,link:zh-cn_topic_0000001348413529.xml](zh-cn_topic_0000001348413529.xml)&nbsp;\*render,&nbsp;const&nbsp;void&nbsp;\*frame,&nbsp;uint64_t&nbsp;requestBytes,&nbsp;uint64_t&nbsp;\*replyBytes) | 往音频驱动中播放(render)一帧输出数据(放音,音频下行数据)&nbsp;[更多...](#renderframe) | | (&nbsp;[RenderFrame](#renderframe)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357381989.xml#xref1032115116083931,link:zh-cn_topic_0000001357381989.xml](zh-cn_topic_0000001357381989.xml)&nbsp;\*render,&nbsp;const&nbsp;void&nbsp;\*frame,&nbsp;uint64_t&nbsp;requestBytes,&nbsp;uint64_t&nbsp;\*replyBytes) | 往音频驱动中播放(render)一帧输出数据(放音,音频下行数据)&nbsp;[更多...](#renderframe) |
| (&nbsp;[GetRenderPosition](#getrenderposition)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001348413529.xml#xref1361225145083931,link:zh-cn_topic_0000001348413529.xml](zh-cn_topic_0000001348413529.xml)&nbsp;\*render,&nbsp;uint64_t&nbsp;\*frames,&nbsp;struct&nbsp;[AudioTimeStamp](_audio_time_stamp.md)&nbsp;\*time) | 获取音频输出帧数的上一次计数&nbsp;[更多...](#getrenderposition) | | (&nbsp;[GetRenderPosition](#getrenderposition)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357381989.xml#xref1361225145083931,link:zh-cn_topic_0000001357381989.xml](zh-cn_topic_0000001357381989.xml)&nbsp;\*render,&nbsp;uint64_t&nbsp;\*frames,&nbsp;struct&nbsp;[AudioTimeStamp](_audio_time_stamp.md)&nbsp;\*time) | 获取音频输出帧数的上一次计数&nbsp;[更多...](#getrenderposition) |
| (&nbsp;[SetRenderSpeed](#setrenderspeed)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001348413529.xml#xref298100406083931,link:zh-cn_topic_0000001348413529.xml](zh-cn_topic_0000001348413529.xml)&nbsp;\*render,&nbsp;float&nbsp;speed) | 设置一个音频的播放速度&nbsp;[更多...](#setrenderspeed) | | (&nbsp;[SetRenderSpeed](#setrenderspeed)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357381989.xml#xref298100406083931,link:zh-cn_topic_0000001357381989.xml](zh-cn_topic_0000001357381989.xml)&nbsp;\*render,&nbsp;float&nbsp;speed) | 设置一个音频的播放速度&nbsp;[更多...](#setrenderspeed) |
| (&nbsp;[GetRenderSpeed](#getrenderspeed)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001348413529.xml#xref1265100196083931,link:zh-cn_topic_0000001348413529.xml](zh-cn_topic_0000001348413529.xml)&nbsp;\*render,&nbsp;float&nbsp;\*speed) | 获取一个音频当前的播放速度&nbsp;[更多...](#getrenderspeed) | | (&nbsp;[GetRenderSpeed](#getrenderspeed)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357381989.xml#xref1265100196083931,link:zh-cn_topic_0000001357381989.xml](zh-cn_topic_0000001357381989.xml)&nbsp;\*render,&nbsp;float&nbsp;\*speed) | 获取一个音频当前的播放速度&nbsp;[更多...](#getrenderspeed) |
| (&nbsp;[SetChannelMode](#setchannelmode)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001348413529.xml#xref1614877322083931,link:zh-cn_topic_0000001348413529.xml](zh-cn_topic_0000001348413529.xml)&nbsp;\*render,&nbsp;enum&nbsp;[AudioChannelMode](_audio.md#audiochannelmode)&nbsp;mode) | 设置音频播放的通道模式&nbsp;[更多...](#setchannelmode) | | (&nbsp;[SetChannelMode](#setchannelmode)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357381989.xml#xref1614877322083931,link:zh-cn_topic_0000001357381989.xml](zh-cn_topic_0000001357381989.xml)&nbsp;\*render,&nbsp;enum&nbsp;[AudioChannelMode](_audio.md#audiochannelmode)&nbsp;mode) | 设置音频播放的通道模式&nbsp;[更多...](#setchannelmode) |
| (&nbsp;[GetChannelMode](#getchannelmode)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001348413529.xml#xref1553230681083931,link:zh-cn_topic_0000001348413529.xml](zh-cn_topic_0000001348413529.xml)&nbsp;\*render,&nbsp;enum&nbsp;[AudioChannelMode](_audio.md#audiochannelmode)&nbsp;\*mode) | 获取音频播放当前的通道模式&nbsp;[更多...](#getchannelmode) | | (&nbsp;[GetChannelMode](#getchannelmode)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357381989.xml#xref1553230681083931,link:zh-cn_topic_0000001357381989.xml](zh-cn_topic_0000001357381989.xml)&nbsp;\*render,&nbsp;enum&nbsp;[AudioChannelMode](_audio.md#audiochannelmode)&nbsp;\*mode) | 获取音频播放当前的通道模式&nbsp;[更多...](#getchannelmode) |
| (&nbsp;[RegCallback](#regcallback)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001348413529.xml#xref16984183083931,link:zh-cn_topic_0000001348413529.xml](zh-cn_topic_0000001348413529.xml)&nbsp;\*render,&nbsp;[RenderCallback](_audio.md#rendercallback)&nbsp;callback,&nbsp;void&nbsp;\*cookie) | 注册音频回调函数,用于放音过程中缓冲区数据写、DrainBuffer完成通知&nbsp;[更多...](#regcallback) | | (&nbsp;[RegCallback](#regcallback)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357381989.xml#xref16984183083931,link:zh-cn_topic_0000001357381989.xml](zh-cn_topic_0000001357381989.xml)&nbsp;\*render,&nbsp;[RenderCallback](_audio.md#rendercallback)&nbsp;callback,&nbsp;void&nbsp;\*cookie) | 注册音频回调函数,用于放音过程中缓冲区数据写、DrainBuffer完成通知&nbsp;[更多...](#regcallback) |
| (&nbsp;[DrainBuffer](#drainbuffer)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001348413529.xml#xref1454572723083931,link:zh-cn_topic_0000001348413529.xml](zh-cn_topic_0000001348413529.xml)&nbsp;\*render,&nbsp;enum&nbsp;[AudioDrainNotifyType](_audio.md#audiodrainnotifytype)&nbsp;\*type) | 排空缓冲区中的数据&nbsp;[更多...](#drainbuffer) | | (&nbsp;[DrainBuffer](#drainbuffer)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357381989.xml#xref1454572723083931,link:zh-cn_topic_0000001357381989.xml](zh-cn_topic_0000001357381989.xml)&nbsp;\*render,&nbsp;enum&nbsp;[AudioDrainNotifyType](_audio.md#audiodrainnotifytype)&nbsp;\*type) | 排空缓冲区中的数据&nbsp;[更多...](#drainbuffer) |
## **详细描述** ## **详细描述**
......
...@@ -20,6 +20,7 @@ ...@@ -20,6 +20,7 @@
| [remainTimes](#remaintimes) | 认证方式距离被冻结的可处理认证请求次数。 | | [remainTimes](#remaintimes) | 认证方式距离被冻结的可处理认证请求次数。 |
| [msgs](#msgs) | 执行器发送的消息。 | | [msgs](#msgs) | 执行器发送的消息。 |
| [token](#token) | 用户身份认证令牌。 | | [token](#token) | 用户身份认证令牌。 |
| rootSecret | 保护文件加密密钥的密钥。 |
## **详细描述** ## **详细描述**
...@@ -96,3 +97,15 @@ unsigned char [] AuthResultInfo::token ...@@ -96,3 +97,15 @@ unsigned char [] AuthResultInfo::token
**描述:** **描述:**
用户身份认证令牌。 用户身份认证令牌。
### rootSecret
```
unsigned char [] AuthResultInfo::rootSecret
```
**描述:**
保护文件加密密钥的密钥。
...@@ -18,7 +18,7 @@ ...@@ -18,7 +18,7 @@
| [userId](#userid) | 用户ID。 | | [userId](#userid) | 用户ID。 |
| [authTrustLevel](#authtrustlevel) | 认证结果可信等级。 | | [authTrustLevel](#authtrustlevel) | 认证结果可信等级。 |
| [authType](#authtype) | 用户认证凭据类型AuthType}。 | | [authType](#authtype) | 用户认证凭据类型AuthType}。 |
| [executorId](#executorid) | 既定用户认证凭据类型的执行器ID。 | | [executorSensorHint](#executorsensorhint) | 既定用户认证凭据类型的执行器传感器提示,用于找到对应认证方式的传感器。 |
| [challenge](#challenge) | 挑战值,用于签发认证令牌。 | | [challenge](#challenge) | 挑战值,用于签发认证令牌。 |
...@@ -74,16 +74,16 @@ unsigned char [] AuthSolution::challenge ...@@ -74,16 +74,16 @@ unsigned char [] AuthSolution::challenge
挑战值,用于签发认证令牌。 挑战值,用于签发认证令牌。
### executorId ### executorSensorHint
``` ```
unsigned int AuthSolution::executorId unsigned int AuthSolution::executorSensorHint
``` ```
**描述:** **描述:**
既定用户认证凭据类型的执行器ID 既定用户认证凭据类型的执行器传感器提示,用于找到对应认证方式的传感器
### userId ### userId
......
...@@ -47,7 +47,7 @@ ...@@ -47,7 +47,7 @@
### 枚举 ### 枚举
| 枚举名称 | 描述 | | 枚举 | 描述 |
| -------- | -------- | | -------- | -------- |
| [OHOS::Camera::CamRetCode](#camretcode)&nbsp;:&nbsp;int32_t&nbsp;{&nbsp;&nbsp;&nbsp;OHOS::Camera::NO_ERROR&nbsp;=&nbsp;0,&nbsp;OHOS::Camera::CAMERA_BUSY&nbsp;=&nbsp;-1,&nbsp;OHOS::Camera::INSUFFICIENT_RESOURCES&nbsp;=&nbsp;-2,&nbsp;OHOS::Camera::INVALID_ARGUMENT&nbsp;=&nbsp;-3,&nbsp;&nbsp;&nbsp;OHOS::Camera::METHOD_NOT_SUPPORTED&nbsp;=&nbsp;-4,&nbsp;OHOS::Camera::CAMERA_CLOSED&nbsp;=&nbsp;-5,&nbsp;OHOS::Camera::DEVICE_ERROR&nbsp;=&nbsp;-6&nbsp;} | HDI接口的返回值。&nbsp;[更多...](#camretcode) | | [OHOS::Camera::CamRetCode](#camretcode)&nbsp;:&nbsp;int32_t&nbsp;{&nbsp;&nbsp;&nbsp;OHOS::Camera::NO_ERROR&nbsp;=&nbsp;0,&nbsp;OHOS::Camera::CAMERA_BUSY&nbsp;=&nbsp;-1,&nbsp;OHOS::Camera::INSUFFICIENT_RESOURCES&nbsp;=&nbsp;-2,&nbsp;OHOS::Camera::INVALID_ARGUMENT&nbsp;=&nbsp;-3,&nbsp;&nbsp;&nbsp;OHOS::Camera::METHOD_NOT_SUPPORTED&nbsp;=&nbsp;-4,&nbsp;OHOS::Camera::CAMERA_CLOSED&nbsp;=&nbsp;-5,&nbsp;OHOS::Camera::DEVICE_ERROR&nbsp;=&nbsp;-6&nbsp;} | HDI接口的返回值。&nbsp;[更多...](#camretcode) |
| [OHOS::Camera::ResultCallbackMode](#resultcallbackmode)&nbsp;:&nbsp;int32_t&nbsp;{&nbsp;OHOS::Camera::PER_FRAME,&nbsp;OHOS::Camera::ON_CHANGED&nbsp;} | metadata的上报模式。&nbsp;[更多...](#resultcallbackmode) | | [OHOS::Camera::ResultCallbackMode](#resultcallbackmode)&nbsp;:&nbsp;int32_t&nbsp;{&nbsp;OHOS::Camera::PER_FRAME,&nbsp;OHOS::Camera::ON_CHANGED&nbsp;} | metadata的上报模式。&nbsp;[更多...](#resultcallbackmode) |
...@@ -112,7 +112,7 @@ ...@@ -112,7 +112,7 @@
### 变量 ### 变量
| 变量&nbsp;名称 | 描述 | | 变量 | 描述 |
| -------- | -------- | | -------- | -------- |
| [OHOS::Camera::StreamInfo::streamId_](#streamid-14) | 流的ID,用于在设备内唯一标识一条流。 | | [OHOS::Camera::StreamInfo::streamId_](#streamid-14) | 流的ID,用于在设备内唯一标识一条流。 |
| [OHOS::Camera::StreamInfo::width_](#width-12) | 图像宽度。 | | [OHOS::Camera::StreamInfo::width_](#width-12) | 图像宽度。 |
......
...@@ -53,7 +53,7 @@ ...@@ -53,7 +53,7 @@
### 枚举 ### 枚举
| 枚举名称 | 描述 | | 枚举 | 描述 |
| -------- | -------- | | -------- | -------- |
| [CodecType](#codectype)&nbsp;{&nbsp;VIDEO_DECODER,&nbsp;VIDEO_ENCODER,&nbsp;AUDIO_DECODER,&nbsp;AUDIO_ENCODER,&nbsp;&nbsp;&nbsp;INVALID_TYPE&nbsp;} | 枚举编解码的类型。&nbsp;[更多...](#codectype) | | [CodecType](#codectype)&nbsp;{&nbsp;VIDEO_DECODER,&nbsp;VIDEO_ENCODER,&nbsp;AUDIO_DECODER,&nbsp;AUDIO_ENCODER,&nbsp;&nbsp;&nbsp;INVALID_TYPE&nbsp;} | 枚举编解码的类型。&nbsp;[更多...](#codectype) |
| [Profile](#profile)&nbsp;{&nbsp;INVALID_PROFILE&nbsp;=&nbsp;0,&nbsp;AAC_LC_PROFILE&nbsp;=&nbsp;0x1000,&nbsp;AAC_MAIN_PROFILE,&nbsp;AAC_HE_V1_PROFILE,&nbsp;&nbsp;&nbsp;AAC_HE_V2_PROFILE,&nbsp;AAC_LD_PROFILE,&nbsp;AAC_ELD_PROFILE,&nbsp;AVC_BASELINE_PROFILE&nbsp;=&nbsp;0x2000,&nbsp;&nbsp;&nbsp;AVC_MAIN_PROFILE,&nbsp;AVC_HIGH_PROFILE,&nbsp;HEVC_MAIN_PROFILE&nbsp;=&nbsp;0x3000,&nbsp;HEVC_MAIN_10_PROFILE&nbsp;} | 枚举Codec规格。&nbsp;[更多...](#profile) | | [Profile](#profile)&nbsp;{&nbsp;INVALID_PROFILE&nbsp;=&nbsp;0,&nbsp;AAC_LC_PROFILE&nbsp;=&nbsp;0x1000,&nbsp;AAC_MAIN_PROFILE,&nbsp;AAC_HE_V1_PROFILE,&nbsp;&nbsp;&nbsp;AAC_HE_V2_PROFILE,&nbsp;AAC_LD_PROFILE,&nbsp;AAC_ELD_PROFILE,&nbsp;AVC_BASELINE_PROFILE&nbsp;=&nbsp;0x2000,&nbsp;&nbsp;&nbsp;AVC_MAIN_PROFILE,&nbsp;AVC_HIGH_PROFILE,&nbsp;HEVC_MAIN_PROFILE&nbsp;=&nbsp;0x3000,&nbsp;HEVC_MAIN_10_PROFILE&nbsp;} | 枚举Codec规格。&nbsp;[更多...](#profile) |
...@@ -82,7 +82,7 @@ ...@@ -82,7 +82,7 @@
### 变量 ### 变量
| 变量&nbsp;名称 | 描述 | | 变量 | 描述 |
| -------- | -------- | | -------- | -------- |
| [CodecCallbackType::remote](#remote) | 指向HdfRemoteService的指针。&nbsp;[更多...](#remote) | | [CodecCallbackType::remote](#remote) | 指向HdfRemoteService的指针。&nbsp;[更多...](#remote) |
| (&nbsp;[CodecCallbackType::EventHandler](#eventhandler)&nbsp;)(struct&nbsp;[CodecCallbackType](_codec_callback_type.md)&nbsp;\*self,&nbsp;enum&nbsp;OMX_EVENTTYPE&nbsp;event,&nbsp;struct&nbsp;[EventInfo](_event_info.md)&nbsp;\*info) | 事件上报。&nbsp;[更多...](#eventhandler) | | (&nbsp;[CodecCallbackType::EventHandler](#eventhandler)&nbsp;)(struct&nbsp;[CodecCallbackType](_codec_callback_type.md)&nbsp;\*self,&nbsp;enum&nbsp;OMX_EVENTTYPE&nbsp;event,&nbsp;struct&nbsp;[EventInfo](_event_info.md)&nbsp;\*info) | 事件上报。&nbsp;[更多...](#eventhandler) |
...@@ -128,7 +128,7 @@ Codec模块涉及自定义类型、音视频编解码组件初始化、参数设 ...@@ -128,7 +128,7 @@ Codec模块涉及自定义类型、音视频编解码组件初始化、参数设
### AudioSampleFormat ### AudioSampleFormat
``` ```
enum AudioSampleFormat enum AudioSampleFormat
``` ```
...@@ -141,7 +141,7 @@ enum AudioSampleFormat ...@@ -141,7 +141,7 @@ enum AudioSampleFormat
- 对于packed的采样格式,只使用第一个data,每个声道的数据是交错存储的。 - 对于packed的采样格式,只使用第一个data,每个声道的数据是交错存储的。
| 枚举值 | 描述 | | 枚举值 | 描述 |
| -------- | -------- | | -------- | -------- |
| AUDIO_SAMPLE_FORMAT_S8 | 8bit位宽有符号交织样本。 | | AUDIO_SAMPLE_FORMAT_S8 | 8bit位宽有符号交织样本。 |
| AUDIO_SAMPLE_FORMAT_S8P | 8bit位宽有符号非交织样本。 | | AUDIO_SAMPLE_FORMAT_S8P | 8bit位宽有符号非交织样本。 |
...@@ -182,7 +182,7 @@ enum AudioSampleFormat ...@@ -182,7 +182,7 @@ enum AudioSampleFormat
### AudioSampleRate ### AudioSampleRate
``` ```
enum AudioSampleRate enum AudioSampleRate
``` ```
...@@ -209,7 +209,7 @@ enum AudioSampleRate ...@@ -209,7 +209,7 @@ enum AudioSampleRate
### AvCodecRole ### AvCodecRole
``` ```
enum AvCodecRole enum AvCodecRole
``` ```
...@@ -235,7 +235,7 @@ enum AvCodecRole ...@@ -235,7 +235,7 @@ enum AvCodecRole
### CodecBufferType ### CodecBufferType
``` ```
enum CodecBufferType enum CodecBufferType
``` ```
...@@ -255,7 +255,7 @@ enum CodecBufferType ...@@ -255,7 +255,7 @@ enum CodecBufferType
### CodecCapsMask ### CodecCapsMask
``` ```
enum CodecCapsMask enum CodecCapsMask
``` ```
...@@ -274,7 +274,7 @@ enum CodecCapsMask ...@@ -274,7 +274,7 @@ enum CodecCapsMask
### CodecProcessMode ### CodecProcessMode
``` ```
enum CodecProcessMode enum CodecProcessMode
``` ```
...@@ -295,7 +295,7 @@ enum CodecProcessMode ...@@ -295,7 +295,7 @@ enum CodecProcessMode
### CodecType ### CodecType
``` ```
enum CodecType enum CodecType
``` ```
...@@ -315,7 +315,7 @@ enum CodecType ...@@ -315,7 +315,7 @@ enum CodecType
### OmxIndexCodecExType ### OmxIndexCodecExType
``` ```
enum OmxIndexCodecExType enum OmxIndexCodecExType
``` ```
...@@ -334,7 +334,7 @@ enum OmxIndexCodecExType ...@@ -334,7 +334,7 @@ enum OmxIndexCodecExType
### OmxVideoExType ### OmxVideoExType
``` ```
enum OmxVideoExType enum OmxVideoExType
``` ```
...@@ -350,7 +350,7 @@ enum OmxVideoExType ...@@ -350,7 +350,7 @@ enum OmxVideoExType
### Profile ### Profile
``` ```
enum Profile enum Profile
``` ```
...@@ -377,7 +377,7 @@ enum Profile ...@@ -377,7 +377,7 @@ enum Profile
### ShareMemTypes ### ShareMemTypes
``` ```
enum ShareMemTypes enum ShareMemTypes
``` ```
...@@ -397,7 +397,7 @@ enum ShareMemTypes ...@@ -397,7 +397,7 @@ enum ShareMemTypes
### CodecCallbackTypeGet() ### CodecCallbackTypeGet()
``` ```
struct CodecCallbackType* CodecCallbackTypeGet (struct HdfRemoteService * remote) struct CodecCallbackType* CodecCallbackTypeGet (struct HdfRemoteService * remote)
``` ```
...@@ -423,7 +423,7 @@ struct CodecCallbackType* CodecCallbackTypeGet (struct HdfRemoteService * remote ...@@ -423,7 +423,7 @@ struct CodecCallbackType* CodecCallbackTypeGet (struct HdfRemoteService * remote
### CodecCallbackTypeRelease() ### CodecCallbackTypeRelease()
``` ```
void CodecCallbackTypeRelease (struct CodecCallbackType * instance) void CodecCallbackTypeRelease (struct CodecCallbackType * instance)
``` ```
...@@ -445,7 +445,7 @@ void CodecCallbackTypeRelease (struct CodecCallbackType * instance) ...@@ -445,7 +445,7 @@ void CodecCallbackTypeRelease (struct CodecCallbackType * instance)
### CodecComponentManagerRelease() ### CodecComponentManagerRelease()
``` ```
void CodecComponentManagerRelease (void ) void CodecComponentManagerRelease (void )
``` ```
...@@ -461,7 +461,7 @@ void CodecComponentManagerRelease (void ) ...@@ -461,7 +461,7 @@ void CodecComponentManagerRelease (void )
### CodecComponentTypeGet() ### CodecComponentTypeGet()
``` ```
struct CodecComponentType* CodecComponentTypeGet (struct HdfRemoteService * remote) struct CodecComponentType* CodecComponentTypeGet (struct HdfRemoteService * remote)
``` ```
...@@ -487,7 +487,7 @@ struct CodecComponentType* CodecComponentTypeGet (struct HdfRemoteService * remo ...@@ -487,7 +487,7 @@ struct CodecComponentType* CodecComponentTypeGet (struct HdfRemoteService * remo
### CodecComponentTypeRelease() ### CodecComponentTypeRelease()
``` ```
void CodecComponentTypeRelease (struct CodecComponentType * instance) void CodecComponentTypeRelease (struct CodecComponentType * instance)
``` ```
...@@ -509,7 +509,7 @@ void CodecComponentTypeRelease (struct CodecComponentType * instance) ...@@ -509,7 +509,7 @@ void CodecComponentTypeRelease (struct CodecComponentType * instance)
### GetCodecComponentManager() ### GetCodecComponentManager()
``` ```
struct CodecComponentManager* GetCodecComponentManager (void ) struct CodecComponentManager* GetCodecComponentManager (void )
``` ```
...@@ -532,7 +532,7 @@ struct CodecComponentManager* GetCodecComponentManager (void ) ...@@ -532,7 +532,7 @@ struct CodecComponentManager* GetCodecComponentManager (void )
### AllocateBuffer ### AllocateBuffer
``` ```
int32_t(* CodecComponentType::AllocateBuffer) (struct CodecComponentType *self, uint32_t portIndex, struct OmxCodecBuffer *buffer) int32_t(* CodecComponentType::AllocateBuffer) (struct CodecComponentType *self, uint32_t portIndex, struct OmxCodecBuffer *buffer)
``` ```
...@@ -574,7 +574,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,申请buffer失败。 ...@@ -574,7 +574,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,申请buffer失败。
### ComponentDeInit ### ComponentDeInit
``` ```
int32_t(* CodecComponentType::ComponentDeInit) (struct CodecComponentType *self) int32_t(* CodecComponentType::ComponentDeInit) (struct CodecComponentType *self)
``` ```
...@@ -608,7 +608,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,去初始化失败。 ...@@ -608,7 +608,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,去初始化失败。
### ComponentRoleEnum ### ComponentRoleEnum
``` ```
int32_t(* CodecComponentType::ComponentRoleEnum) (struct CodecComponentType *self, uint8_t *role, uint32_t roleLen, uint32_t index) int32_t(* CodecComponentType::ComponentRoleEnum) (struct CodecComponentType *self, uint8_t *role, uint32_t roleLen, uint32_t index)
``` ```
...@@ -645,7 +645,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,获取角色失败。 ...@@ -645,7 +645,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,获取角色失败。
### ComponentTunnelRequest ### ComponentTunnelRequest
``` ```
int32_t(* CodecComponentType::ComponentTunnelRequest) (struct CodecComponentType *self, uint32_t port, int32_t tunneledComp, uint32_t tunneledPort, struct OMX_TUNNELSETUPTYPE *tunnelSetup) int32_t(* CodecComponentType::ComponentTunnelRequest) (struct CodecComponentType *self, uint32_t port, int32_t tunneledComp, uint32_t tunneledPort, struct OMX_TUNNELSETUPTYPE *tunnelSetup)
``` ```
...@@ -683,7 +683,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,设置失败。 ...@@ -683,7 +683,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,设置失败。
### EmptyBufferDone ### EmptyBufferDone
``` ```
int32_t(* CodecCallbackType::EmptyBufferDone) (struct CodecCallbackType *self, int8_t *appData, uint32_t appDataLen, const struct OmxCodecBuffer *buffer) int32_t(* CodecCallbackType::EmptyBufferDone) (struct CodecCallbackType *self, int8_t *appData, uint32_t appDataLen, const struct OmxCodecBuffer *buffer)
``` ```
...@@ -720,7 +720,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,上报失败。 ...@@ -720,7 +720,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,上报失败。
### EmptyThisBuffer ### EmptyThisBuffer
``` ```
int32_t(* CodecComponentType::EmptyThisBuffer) (struct CodecComponentType *self, const struct OmxCodecBuffer *buffer) int32_t(* CodecComponentType::EmptyThisBuffer) (struct CodecComponentType *self, const struct OmxCodecBuffer *buffer)
``` ```
...@@ -755,7 +755,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,输入buffer失败。 ...@@ -755,7 +755,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,输入buffer失败。
### EventHandler ### EventHandler
``` ```
int32_t(* CodecCallbackType::EventHandler) (struct CodecCallbackType *self, enum OMX_EVENTTYPE event, struct EventInfo *info) int32_t(* CodecCallbackType::EventHandler) (struct CodecCallbackType *self, enum OMX_EVENTTYPE event, struct EventInfo *info)
``` ```
...@@ -803,7 +803,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,事件上报失败。 ...@@ -803,7 +803,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,事件上报失败。
### FillBufferDone ### FillBufferDone
``` ```
int32_t(* CodecCallbackType::FillBufferDone) (struct CodecCallbackType *self, int8_t *appData, uint32_t appDataLen, struct OmxCodecBuffer *buffer) int32_t(* CodecCallbackType::FillBufferDone) (struct CodecCallbackType *self, int8_t *appData, uint32_t appDataLen, struct OmxCodecBuffer *buffer)
``` ```
...@@ -840,7 +840,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,上报失败。 ...@@ -840,7 +840,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,上报失败。
### FillThisBuffer ### FillThisBuffer
``` ```
int32_t(* CodecComponentType::FillThisBuffer) (struct CodecComponentType *self, const struct OmxCodecBuffer *buffer) int32_t(* CodecComponentType::FillThisBuffer) (struct CodecComponentType *self, const struct OmxCodecBuffer *buffer)
``` ```
...@@ -875,7 +875,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,填充buffer失败。 ...@@ -875,7 +875,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,填充buffer失败。
### FreeBuffer ### FreeBuffer
``` ```
int32_t(* CodecComponentType::FreeBuffer) (struct CodecComponentType *self, uint32_t portIndex, const struct OmxCodecBuffer *buffer) int32_t(* CodecComponentType::FreeBuffer) (struct CodecComponentType *self, uint32_t portIndex, const struct OmxCodecBuffer *buffer)
``` ```
...@@ -917,7 +917,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,释放buffer失败。 ...@@ -917,7 +917,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,释放buffer失败。
### GetComponentVersion ### GetComponentVersion
``` ```
int32_t(* CodecComponentType::GetComponentVersion) (struct CodecComponentType *self, struct CompVerInfo *verInfo) int32_t(* CodecComponentType::GetComponentVersion) (struct CodecComponentType *self, struct CompVerInfo *verInfo)
``` ```
...@@ -952,7 +952,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,获取版本号失败。 ...@@ -952,7 +952,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,获取版本号失败。
### GetConfig ### GetConfig
``` ```
int32_t(* CodecComponentType::GetConfig) (struct CodecComponentType *self, uint32_t index, int8_t *cfgStruct, uint32_t cfgStructLen) int32_t(* CodecComponentType::GetConfig) (struct CodecComponentType *self, uint32_t index, int8_t *cfgStruct, uint32_t cfgStructLen)
``` ```
...@@ -989,7 +989,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,获取配置失败。 ...@@ -989,7 +989,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,获取配置失败。
### GetExtensionIndex ### GetExtensionIndex
``` ```
int32_t(* CodecComponentType::GetExtensionIndex) (struct CodecComponentType *self, const char *paramName, uint32_t *indexType) int32_t(* CodecComponentType::GetExtensionIndex) (struct CodecComponentType *self, const char *paramName, uint32_t *indexType)
``` ```
...@@ -1025,7 +1025,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,获取扩展索引失败。 ...@@ -1025,7 +1025,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,获取扩展索引失败。
### GetParameter ### GetParameter
``` ```
int32_t(* CodecComponentType::GetParameter) (struct CodecComponentType *self, uint32_t paramIndex, int8_t *paramStruct, uint32_t paramStructLen) int32_t(* CodecComponentType::GetParameter) (struct CodecComponentType *self, uint32_t paramIndex, int8_t *paramStruct, uint32_t paramStructLen)
``` ```
...@@ -1062,7 +1062,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,获取参数失败。 ...@@ -1062,7 +1062,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,获取参数失败。
### GetState ### GetState
``` ```
int32_t(* CodecComponentType::GetState) (struct CodecComponentType *self, enum OMX_STATETYPE *state) int32_t(* CodecComponentType::GetState) (struct CodecComponentType *self, enum OMX_STATETYPE *state)
``` ```
...@@ -1097,7 +1097,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,获取状态失败。 ...@@ -1097,7 +1097,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,获取状态失败。
### remote ### remote
``` ```
struct HdfRemoteService* CodecCallbackType::remote struct HdfRemoteService* CodecCallbackType::remote
``` ```
...@@ -1113,7 +1113,7 @@ struct HdfRemoteService* CodecCallbackType::remote ...@@ -1113,7 +1113,7 @@ struct HdfRemoteService* CodecCallbackType::remote
### SendCommand ### SendCommand
``` ```
int32_t(* CodecComponentType::SendCommand) (struct CodecComponentType *self, enum OMX_COMMANDTYPE cmd, uint32_t param, int8_t *cmdData, uint32_t cmdDataLen) int32_t(* CodecComponentType::SendCommand) (struct CodecComponentType *self, enum OMX_COMMANDTYPE cmd, uint32_t param, int8_t *cmdData, uint32_t cmdDataLen)
``` ```
...@@ -1151,7 +1151,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,发送命令失败。 ...@@ -1151,7 +1151,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,发送命令失败。
### SetCallbacks ### SetCallbacks
``` ```
int32_t(* CodecComponentType::SetCallbacks) (struct CodecComponentType *self, struct CodecCallbackType *callback, int8_t *appData, uint32_t appDataLen) int32_t(* CodecComponentType::SetCallbacks) (struct CodecComponentType *self, struct CodecCallbackType *callback, int8_t *appData, uint32_t appDataLen)
``` ```
...@@ -1188,7 +1188,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,设置回调失败。 ...@@ -1188,7 +1188,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,设置回调失败。
### SetConfig ### SetConfig
``` ```
int32_t(* CodecComponentType::SetConfig) (struct CodecComponentType *self, uint32_t index, int8_t *cfgStruct, uint32_t cfgStructLen) int32_t(* CodecComponentType::SetConfig) (struct CodecComponentType *self, uint32_t index, int8_t *cfgStruct, uint32_t cfgStructLen)
``` ```
...@@ -1225,7 +1225,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,设置失败。 ...@@ -1225,7 +1225,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,设置失败。
### SetParameter ### SetParameter
``` ```
int32_t(* CodecComponentType::SetParameter) (struct CodecComponentType *self, uint32_t index, int8_t *paramStruct, uint32_t paramStructLen) int32_t(* CodecComponentType::SetParameter) (struct CodecComponentType *self, uint32_t index, int8_t *paramStruct, uint32_t paramStructLen)
``` ```
...@@ -1262,7 +1262,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,设置参数失败。 ...@@ -1262,7 +1262,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,设置参数失败。
### UseBuffer ### UseBuffer
``` ```
int32_t(* CodecComponentType::UseBuffer) (struct CodecComponentType *self, uint32_t portIndex, struct OmxCodecBuffer *buffer) int32_t(* CodecComponentType::UseBuffer) (struct CodecComponentType *self, uint32_t portIndex, struct OmxCodecBuffer *buffer)
``` ```
...@@ -1304,7 +1304,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,指定失败。 ...@@ -1304,7 +1304,7 @@ HDF_ERR_MALLOC_FAIL 表示申请内存失败,指定失败。
### UseEglImage ### UseEglImage
``` ```
int32_t(* CodecComponentType::UseEglImage) (struct CodecComponentType *self, struct OmxCodecBuffer *buffer, uint32_t portIndex, int8_t *eglImage, uint32_t eglImageLen) int32_t(* CodecComponentType::UseEglImage) (struct CodecComponentType *self, struct OmxCodecBuffer *buffer, uint32_t portIndex, int8_t *eglImage, uint32_t eglImageLen)
``` ```
......
...@@ -16,9 +16,9 @@ ...@@ -16,9 +16,9 @@
| Public&nbsp;属性 | 描述 | | Public&nbsp;属性 | 描述 |
| -------- | -------- | | -------- | -------- |
| [remote](_codec.md#remote) | 指向HdfRemoteService的指针。&nbsp;[更多...](_codec.md#remote) | | [remote](_codec.md#remote) | 指向HdfRemoteService的指针。&nbsp;[更多...](_codec.md#remote) |
| (&nbsp;[EventHandler](_codec.md#eventhandler)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295094404.xml#xref452479393083931,link:zh-cn_topic_0000001295094404.xml](zh-cn_topic_0000001295094404.xml)&nbsp;\*self,&nbsp;enum&nbsp;OMX_EVENTTYPE&nbsp;event,&nbsp;struct&nbsp;[EventInfo](_event_info.md)&nbsp;\*info) | 事件上报。&nbsp;[更多...](_codec.md#eventhandler) | | (&nbsp;[EventHandler](_codec.md#eventhandler)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001304382300.xml#xref452479393083931,link:zh-cn_topic_0000001304382300.xml](zh-cn_topic_0000001304382300.xml)&nbsp;\*self,&nbsp;enum&nbsp;OMX_EVENTTYPE&nbsp;event,&nbsp;struct&nbsp;[EventInfo](_event_info.md)&nbsp;\*info) | 事件上报。&nbsp;[更多...](_codec.md#eventhandler) |
| (&nbsp;[EmptyBufferDone](_codec.md#emptybufferdone)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295094404.xml#xref1077915705083931,link:zh-cn_topic_0000001295094404.xml](zh-cn_topic_0000001295094404.xml)&nbsp;\*self,&nbsp;int8_t&nbsp;\*appData,&nbsp;uint32_t&nbsp;appDataLen,&nbsp;const&nbsp;struct&nbsp;[OmxCodecBuffer](_omx_codec_buffer.md)&nbsp;\*buffer) | 上报输入buffer编码或者解码处理完毕。&nbsp;[更多...](_codec.md#emptybufferdone) | | (&nbsp;[EmptyBufferDone](_codec.md#emptybufferdone)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001304382300.xml#xref1077915705083931,link:zh-cn_topic_0000001304382300.xml](zh-cn_topic_0000001304382300.xml)&nbsp;\*self,&nbsp;int8_t&nbsp;\*appData,&nbsp;uint32_t&nbsp;appDataLen,&nbsp;const&nbsp;struct&nbsp;[OmxCodecBuffer](_omx_codec_buffer.md)&nbsp;\*buffer) | 上报输入buffer编码或者解码处理完毕。&nbsp;[更多...](_codec.md#emptybufferdone) |
| (&nbsp;[FillBufferDone](_codec.md#fillbufferdone)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295094404.xml#xref1123615867083931,link:zh-cn_topic_0000001295094404.xml](zh-cn_topic_0000001295094404.xml)&nbsp;\*self,&nbsp;int8_t&nbsp;\*appData,&nbsp;uint32_t&nbsp;appDataLen,&nbsp;struct&nbsp;[OmxCodecBuffer](_omx_codec_buffer.md)&nbsp;\*buffer) | 上报输出buffer填充完毕。&nbsp;[更多...](_codec.md#fillbufferdone) | | (&nbsp;[FillBufferDone](_codec.md#fillbufferdone)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001304382300.xml#xref1123615867083931,link:zh-cn_topic_0000001304382300.xml](zh-cn_topic_0000001304382300.xml)&nbsp;\*self,&nbsp;int8_t&nbsp;\*appData,&nbsp;uint32_t&nbsp;appDataLen,&nbsp;struct&nbsp;[OmxCodecBuffer](_omx_codec_buffer.md)&nbsp;\*buffer) | 上报输出buffer填充完毕。&nbsp;[更多...](_codec.md#fillbufferdone) |
## **详细描述** ## **详细描述**
......
...@@ -15,24 +15,24 @@ ...@@ -15,24 +15,24 @@
| Public&nbsp;属性 | 描述 | | Public&nbsp;属性 | 描述 |
| -------- | -------- | | -------- | -------- |
| (&nbsp;[GetComponentVersion](_codec.md#getcomponentversion)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295573848.xml#xref1521256091083931,link:zh-cn_topic_0000001295573848.xml](zh-cn_topic_0000001295573848.xml)&nbsp;\*self,&nbsp;struct&nbsp;[CompVerInfo](_comp_ver_info.md)&nbsp;\*verInfo) | 获取Codec组件版本号。&nbsp;[更多...](_codec.md#getcomponentversion) | | (&nbsp;[GetComponentVersion](_codec.md#getcomponentversion)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357501829.xml#xref1521256091083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml)&nbsp;\*self,&nbsp;struct&nbsp;[CompVerInfo](_comp_ver_info.md)&nbsp;\*verInfo) | 获取Codec组件版本号。&nbsp;[更多...](_codec.md#getcomponentversion) |
| (&nbsp;[SendCommand](_codec.md#sendcommand)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295573848.xml#xref2020788308083931,link:zh-cn_topic_0000001295573848.xml](zh-cn_topic_0000001295573848.xml)&nbsp;\*self,&nbsp;enum&nbsp;OMX_COMMANDTYPE&nbsp;cmd,&nbsp;uint32_t&nbsp;param,&nbsp;int8_t&nbsp;\*cmdData,&nbsp;uint32_t&nbsp;cmdDataLen) | 发送命令给组件。&nbsp;[更多...](_codec.md#sendcommand) | | (&nbsp;[SendCommand](_codec.md#sendcommand)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357501829.xml#xref2020788308083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml)&nbsp;\*self,&nbsp;enum&nbsp;OMX_COMMANDTYPE&nbsp;cmd,&nbsp;uint32_t&nbsp;param,&nbsp;int8_t&nbsp;\*cmdData,&nbsp;uint32_t&nbsp;cmdDataLen) | 发送命令给组件。&nbsp;[更多...](_codec.md#sendcommand) |
| (&nbsp;[GetParameter](_codec.md#getparameter)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295573848.xml#xref2071182762083931,link:zh-cn_topic_0000001295573848.xml](zh-cn_topic_0000001295573848.xml)&nbsp;\*self,&nbsp;uint32_t&nbsp;paramIndex,&nbsp;int8_t&nbsp;\*paramStruct,&nbsp;uint32_t&nbsp;paramStructLen) | 获取组件参数设置。&nbsp;[更多...](_codec.md#getparameter) | | (&nbsp;[GetParameter](_codec.md#getparameter)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357501829.xml#xref2071182762083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml)&nbsp;\*self,&nbsp;uint32_t&nbsp;paramIndex,&nbsp;int8_t&nbsp;\*paramStruct,&nbsp;uint32_t&nbsp;paramStructLen) | 获取组件参数设置。&nbsp;[更多...](_codec.md#getparameter) |
| (&nbsp;[SetParameter](_codec.md#setparameter)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295573848.xml#xref1874982936083931,link:zh-cn_topic_0000001295573848.xml](zh-cn_topic_0000001295573848.xml)&nbsp;\*self,&nbsp;uint32_t&nbsp;index,&nbsp;int8_t&nbsp;\*paramStruct,&nbsp;uint32_t&nbsp;paramStructLen) | 设置组件需要的参数。&nbsp;[更多...](_codec.md#setparameter) | | (&nbsp;[SetParameter](_codec.md#setparameter)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357501829.xml#xref1874982936083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml)&nbsp;\*self,&nbsp;uint32_t&nbsp;index,&nbsp;int8_t&nbsp;\*paramStruct,&nbsp;uint32_t&nbsp;paramStructLen) | 设置组件需要的参数。&nbsp;[更多...](_codec.md#setparameter) |
| (&nbsp;[GetConfig](_codec.md#getconfig)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295573848.xml#xref921941812083931,link:zh-cn_topic_0000001295573848.xml](zh-cn_topic_0000001295573848.xml)&nbsp;\*self,&nbsp;uint32_t&nbsp;index,&nbsp;int8_t&nbsp;\*cfgStruct,&nbsp;uint32_t&nbsp;cfgStructLen) | 获取组件的配置结构。&nbsp;[更多...](_codec.md#getconfig) | | (&nbsp;[GetConfig](_codec.md#getconfig)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357501829.xml#xref921941812083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml)&nbsp;\*self,&nbsp;uint32_t&nbsp;index,&nbsp;int8_t&nbsp;\*cfgStruct,&nbsp;uint32_t&nbsp;cfgStructLen) | 获取组件的配置结构。&nbsp;[更多...](_codec.md#getconfig) |
| (&nbsp;[SetConfig](_codec.md#setconfig)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295573848.xml#xref1073566491083931,link:zh-cn_topic_0000001295573848.xml](zh-cn_topic_0000001295573848.xml)&nbsp;\*self,&nbsp;uint32_t&nbsp;index,&nbsp;int8_t&nbsp;\*cfgStruct,&nbsp;uint32_t&nbsp;cfgStructLen) | 设置组件的配置。&nbsp;[更多...](_codec.md#setconfig) | | (&nbsp;[SetConfig](_codec.md#setconfig)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357501829.xml#xref1073566491083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml)&nbsp;\*self,&nbsp;uint32_t&nbsp;index,&nbsp;int8_t&nbsp;\*cfgStruct,&nbsp;uint32_t&nbsp;cfgStructLen) | 设置组件的配置。&nbsp;[更多...](_codec.md#setconfig) |
| (&nbsp;[GetExtensionIndex](_codec.md#getextensionindex)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295573848.xml#xref68113596083931,link:zh-cn_topic_0000001295573848.xml](zh-cn_topic_0000001295573848.xml)&nbsp;\*self,&nbsp;const&nbsp;char&nbsp;\*paramName,&nbsp;uint32_t&nbsp;\*indexType) | 根据字符串获取组件的扩展索引。&nbsp;[更多...](_codec.md#getextensionindex) | | (&nbsp;[GetExtensionIndex](_codec.md#getextensionindex)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357501829.xml#xref68113596083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml)&nbsp;\*self,&nbsp;const&nbsp;char&nbsp;\*paramName,&nbsp;uint32_t&nbsp;\*indexType) | 根据字符串获取组件的扩展索引。&nbsp;[更多...](_codec.md#getextensionindex) |
| (&nbsp;[GetState](_codec.md#getstate)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295573848.xml#xref1226754841083931,link:zh-cn_topic_0000001295573848.xml](zh-cn_topic_0000001295573848.xml)&nbsp;\*self,&nbsp;enum&nbsp;OMX_STATETYPE&nbsp;\*state) | 获取组件的当前状态。&nbsp;[更多...](_codec.md#getstate) | | (&nbsp;[GetState](_codec.md#getstate)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357501829.xml#xref1226754841083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml)&nbsp;\*self,&nbsp;enum&nbsp;OMX_STATETYPE&nbsp;\*state) | 获取组件的当前状态。&nbsp;[更多...](_codec.md#getstate) |
| (&nbsp;[ComponentTunnelRequest](_codec.md#componenttunnelrequest)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295573848.xml#xref1739461855083931,link:zh-cn_topic_0000001295573848.xml](zh-cn_topic_0000001295573848.xml)&nbsp;\*self,&nbsp;uint32_t&nbsp;port,&nbsp;int32_t&nbsp;tunneledComp,&nbsp;uint32_t&nbsp;tunneledPort,&nbsp;struct&nbsp;OMX_TUNNELSETUPTYPE&nbsp;\*tunnelSetup) | 设置组件采用Tunnel方式通信。&nbsp;[更多...](_codec.md#componenttunnelrequest) | | (&nbsp;[ComponentTunnelRequest](_codec.md#componenttunnelrequest)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357501829.xml#xref1739461855083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml)&nbsp;\*self,&nbsp;uint32_t&nbsp;port,&nbsp;int32_t&nbsp;tunneledComp,&nbsp;uint32_t&nbsp;tunneledPort,&nbsp;struct&nbsp;OMX_TUNNELSETUPTYPE&nbsp;\*tunnelSetup) | 设置组件采用Tunnel方式通信。&nbsp;[更多...](_codec.md#componenttunnelrequest) |
| (&nbsp;[UseBuffer](_codec.md#usebuffer)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295573848.xml#xref2135329427083931,link:zh-cn_topic_0000001295573848.xml](zh-cn_topic_0000001295573848.xml)&nbsp;\*self,&nbsp;uint32_t&nbsp;portIndex,&nbsp;struct&nbsp;[OmxCodecBuffer](_omx_codec_buffer.md)&nbsp;\*buffer) | 指定组件端口的buffer。&nbsp;[更多...](_codec.md#usebuffer) | | (&nbsp;[UseBuffer](_codec.md#usebuffer)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357501829.xml#xref2135329427083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml)&nbsp;\*self,&nbsp;uint32_t&nbsp;portIndex,&nbsp;struct&nbsp;[OmxCodecBuffer](_omx_codec_buffer.md)&nbsp;\*buffer) | 指定组件端口的buffer。&nbsp;[更多...](_codec.md#usebuffer) |
| (&nbsp;[AllocateBuffer](_codec.md#allocatebuffer)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295573848.xml#xref857621490083931,link:zh-cn_topic_0000001295573848.xml](zh-cn_topic_0000001295573848.xml)&nbsp;\*self,&nbsp;uint32_t&nbsp;portIndex,&nbsp;struct&nbsp;[OmxCodecBuffer](_omx_codec_buffer.md)&nbsp;\*buffer) | 向组件申请端口buffer。&nbsp;[更多...](_codec.md#allocatebuffer) | | (&nbsp;[AllocateBuffer](_codec.md#allocatebuffer)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357501829.xml#xref857621490083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml)&nbsp;\*self,&nbsp;uint32_t&nbsp;portIndex,&nbsp;struct&nbsp;[OmxCodecBuffer](_omx_codec_buffer.md)&nbsp;\*buffer) | 向组件申请端口buffer。&nbsp;[更多...](_codec.md#allocatebuffer) |
| (&nbsp;[FreeBuffer](_codec.md#freebuffer)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295573848.xml#xref1026220701083931,link:zh-cn_topic_0000001295573848.xml](zh-cn_topic_0000001295573848.xml)&nbsp;\*self,&nbsp;uint32_t&nbsp;portIndex,&nbsp;const&nbsp;struct&nbsp;[OmxCodecBuffer](_omx_codec_buffer.md)&nbsp;\*buffer) | 释放buffer。&nbsp;[更多...](_codec.md#freebuffer) | | (&nbsp;[FreeBuffer](_codec.md#freebuffer)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357501829.xml#xref1026220701083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml)&nbsp;\*self,&nbsp;uint32_t&nbsp;portIndex,&nbsp;const&nbsp;struct&nbsp;[OmxCodecBuffer](_omx_codec_buffer.md)&nbsp;\*buffer) | 释放buffer。&nbsp;[更多...](_codec.md#freebuffer) |
| (&nbsp;[EmptyThisBuffer](_codec.md#emptythisbuffer)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295573848.xml#xref1735359869083931,link:zh-cn_topic_0000001295573848.xml](zh-cn_topic_0000001295573848.xml)&nbsp;\*self,&nbsp;const&nbsp;struct&nbsp;[OmxCodecBuffer](_omx_codec_buffer.md)&nbsp;\*buffer) | 编解码输入待处理buffer。&nbsp;[更多...](_codec.md#emptythisbuffer) | | (&nbsp;[EmptyThisBuffer](_codec.md#emptythisbuffer)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357501829.xml#xref1735359869083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml)&nbsp;\*self,&nbsp;const&nbsp;struct&nbsp;[OmxCodecBuffer](_omx_codec_buffer.md)&nbsp;\*buffer) | 编解码输入待处理buffer。&nbsp;[更多...](_codec.md#emptythisbuffer) |
| (&nbsp;[FillThisBuffer](_codec.md#fillthisbuffer)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295573848.xml#xref1574208746083931,link:zh-cn_topic_0000001295573848.xml](zh-cn_topic_0000001295573848.xml)&nbsp;\*self,&nbsp;const&nbsp;struct&nbsp;[OmxCodecBuffer](_omx_codec_buffer.md)&nbsp;\*buffer) | 编解码输出填充buffer。&nbsp;[更多...](_codec.md#fillthisbuffer) | | (&nbsp;[FillThisBuffer](_codec.md#fillthisbuffer)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357501829.xml#xref1574208746083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml)&nbsp;\*self,&nbsp;const&nbsp;struct&nbsp;[OmxCodecBuffer](_omx_codec_buffer.md)&nbsp;\*buffer) | 编解码输出填充buffer。&nbsp;[更多...](_codec.md#fillthisbuffer) |
| (&nbsp;[SetCallbacks](_codec.md#setcallbacks)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295573848.xml#xref1922857471083931,link:zh-cn_topic_0000001295573848.xml](zh-cn_topic_0000001295573848.xml)&nbsp;\*self,&nbsp;struct&nbsp;[CodecCallbackType](_codec_callback_type.md)&nbsp;\*callback,&nbsp;int8_t&nbsp;\*appData,&nbsp;uint32_t&nbsp;appDataLen) | 设置Codec组件的回调函数。&nbsp;[更多...](_codec.md#setcallbacks) | | (&nbsp;[SetCallbacks](_codec.md#setcallbacks)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357501829.xml#xref1922857471083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml)&nbsp;\*self,&nbsp;struct&nbsp;[CodecCallbackType](_codec_callback_type.md)&nbsp;\*callback,&nbsp;int8_t&nbsp;\*appData,&nbsp;uint32_t&nbsp;appDataLen) | 设置Codec组件的回调函数。&nbsp;[更多...](_codec.md#setcallbacks) |
| (&nbsp;[ComponentDeInit](_codec.md#componentdeinit)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295573848.xml#xref1721252790083931,link:zh-cn_topic_0000001295573848.xml](zh-cn_topic_0000001295573848.xml)&nbsp;\*self) | 组件去初始化。&nbsp;[更多...](_codec.md#componentdeinit) | | (&nbsp;[ComponentDeInit](_codec.md#componentdeinit)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357501829.xml#xref1721252790083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml)&nbsp;\*self) | 组件去初始化。&nbsp;[更多...](_codec.md#componentdeinit) |
| (&nbsp;[UseEglImage](_codec.md#useeglimage)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295573848.xml#xref872648430083931,link:zh-cn_topic_0000001295573848.xml](zh-cn_topic_0000001295573848.xml)&nbsp;\*self,&nbsp;struct&nbsp;[OmxCodecBuffer](_omx_codec_buffer.md)&nbsp;\*buffer,&nbsp;uint32_t&nbsp;portIndex,&nbsp;int8_t&nbsp;\*eglImage,&nbsp;uint32_t&nbsp;eglImageLen) | 使用已在EGL中申请的空间。&nbsp;[更多...](_codec.md#useeglimage) | | (&nbsp;[UseEglImage](_codec.md#useeglimage)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357501829.xml#xref872648430083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml)&nbsp;\*self,&nbsp;struct&nbsp;[OmxCodecBuffer](_omx_codec_buffer.md)&nbsp;\*buffer,&nbsp;uint32_t&nbsp;portIndex,&nbsp;int8_t&nbsp;\*eglImage,&nbsp;uint32_t&nbsp;eglImageLen) | 使用已在EGL中申请的空间。&nbsp;[更多...](_codec.md#useeglimage) |
| (&nbsp;[ComponentRoleEnum](_codec.md#componentroleenum)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295573848.xml#xref1661834974083931,link:zh-cn_topic_0000001295573848.xml](zh-cn_topic_0000001295573848.xml)&nbsp;\*self,&nbsp;uint8_t&nbsp;\*role,&nbsp;uint32_t&nbsp;roleLen,&nbsp;uint32_t&nbsp;index) | 获取组件角色。&nbsp;[更多...](_codec.md#componentroleenum) | | (&nbsp;[ComponentRoleEnum](_codec.md#componentroleenum)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357501829.xml#xref1661834974083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml)&nbsp;\*self,&nbsp;uint8_t&nbsp;\*role,&nbsp;uint32_t&nbsp;roleLen,&nbsp;uint32_t&nbsp;index) | 获取组件角色。&nbsp;[更多...](_codec.md#componentroleenum) |
## **详细描述** ## **详细描述**
......
...@@ -18,10 +18,9 @@ ...@@ -18,10 +18,9 @@
| [credentialId](#credentialid) | 认证凭据ID。 | | [credentialId](#credentialid) | 认证凭据ID。 |
| [index](#index) | 用户认证框架的执行器索引。 | | [index](#index) | 用户认证框架的执行器索引。 |
| [templateId](#templateid) | 认证凭据模版ID。 | | [templateId](#templateid) | 认证凭据模版ID。 |
| [authType](#authtype) | 用户认证凭据类型AuthType}。 | | [authType](#authtype) | 用户认证凭据类型AuthType。 |
| [executorType](#executortype) | 执行器类型。 | | [executorMatcher](#executormatcher) | 执行器匹配器。 |
| [executorId](#executorid) | 既定用户认证凭据类型的执行器ID。 | | [executorSensorHint](#executorsensorhint) | 既定用户认证凭据类型的执行器传感器提示,用于找到对应认证方式的传感器。 |
| [extraInfo](#extrainfo) | 其他相关信息,用于支持信息扩展。 |
## **详细描述** ## **详细描述**
...@@ -64,40 +63,28 @@ unsigned long CredentialInfo::credentialId ...@@ -64,40 +63,28 @@ unsigned long CredentialInfo::credentialId
认证凭据ID。 认证凭据ID。
### executorId ### executorSensorHint
``` ```
unsigned int CredentialInfo::executorId unsigned int CredentialInfo::executorSensorHint
``` ```
**描述:** **描述:**
既定用户认证凭据类型的执行器ID 既定用户认证凭据类型的执行器传感器提示,用于找到对应认证方式的传感器
### executorType ### executorMatcher
``` ```
unsigned int CredentialInfo::executorType unsigned int CredentialInfo::executorMatcher
``` ```
**描述:** **描述:**
执行器类型。 执行器匹配器。
### extraInfo
```
unsigned char [] CredentialInfo::extraInfo
```
**描述:**
其他相关信息,用于支持信息扩展。
### index ### index
......
...@@ -63,7 +63,7 @@ ...@@ -63,7 +63,7 @@
### 枚举 ### 枚举
| 枚举名称 | 描述 | | 枚举 | 描述 |
| -------- | -------- | | -------- | -------- |
| [DispErrCode](#disperrcode)&nbsp;{&nbsp;DISPLAY_SUCCESS&nbsp;=&nbsp;0,&nbsp;DISPLAY_FAILURE&nbsp;=&nbsp;-1,&nbsp;DISPLAY_FD_ERR&nbsp;=&nbsp;-2,&nbsp;DISPLAY_PARAM_ERR&nbsp;=&nbsp;-3,&nbsp;&nbsp;&nbsp;DISPLAY_NULL_PTR&nbsp;=&nbsp;-4,&nbsp;DISPLAY_NOT_SUPPORT&nbsp;=&nbsp;-5,&nbsp;DISPLAY_NOMEM&nbsp;=&nbsp;-6,&nbsp;DISPLAY_SYS_BUSY&nbsp;=&nbsp;-7,&nbsp;&nbsp;&nbsp;DISPLAY_NOT_PERM&nbsp;=&nbsp;-8&nbsp;} | 返回值类型定义。&nbsp;[更多...](#disperrcode) | | [DispErrCode](#disperrcode)&nbsp;{&nbsp;DISPLAY_SUCCESS&nbsp;=&nbsp;0,&nbsp;DISPLAY_FAILURE&nbsp;=&nbsp;-1,&nbsp;DISPLAY_FD_ERR&nbsp;=&nbsp;-2,&nbsp;DISPLAY_PARAM_ERR&nbsp;=&nbsp;-3,&nbsp;&nbsp;&nbsp;DISPLAY_NULL_PTR&nbsp;=&nbsp;-4,&nbsp;DISPLAY_NOT_SUPPORT&nbsp;=&nbsp;-5,&nbsp;DISPLAY_NOMEM&nbsp;=&nbsp;-6,&nbsp;DISPLAY_SYS_BUSY&nbsp;=&nbsp;-7,&nbsp;&nbsp;&nbsp;DISPLAY_NOT_PERM&nbsp;=&nbsp;-8&nbsp;} | 返回值类型定义。&nbsp;[更多...](#disperrcode) |
| [LayerType](#layertype)&nbsp;{&nbsp;LAYER_TYPE_GRAPHIC,&nbsp;LAYER_TYPE_OVERLAY,&nbsp;LAYER_TYPE_SDIEBAND,&nbsp;LAYER_TYPE_CURSOR,&nbsp;&nbsp;&nbsp;LAYER_TYPE_BUTT&nbsp;} | 图层类型定义。&nbsp;[更多...](#layertype) | | [LayerType](#layertype)&nbsp;{&nbsp;LAYER_TYPE_GRAPHIC,&nbsp;LAYER_TYPE_OVERLAY,&nbsp;LAYER_TYPE_SDIEBAND,&nbsp;LAYER_TYPE_CURSOR,&nbsp;&nbsp;&nbsp;LAYER_TYPE_BUTT&nbsp;} | 图层类型定义。&nbsp;[更多...](#layertype) |
...@@ -102,7 +102,7 @@ ...@@ -102,7 +102,7 @@
### 变量 ### 变量
| 变量&nbsp;名称 | 描述 | | 变量 | 描述 |
| -------- | -------- | | -------- | -------- |
| (&nbsp;[DeviceFuncs::RegHotPlugCallback](#reghotplugcallback)&nbsp;)([HotPlugCallback](#hotplugcallback)&nbsp;callback,&nbsp;void&nbsp;\*data) | 注册热插拔事件回调。&nbsp;[更多...](#reghotplugcallback) | | (&nbsp;[DeviceFuncs::RegHotPlugCallback](#reghotplugcallback)&nbsp;)([HotPlugCallback](#hotplugcallback)&nbsp;callback,&nbsp;void&nbsp;\*data) | 注册热插拔事件回调。&nbsp;[更多...](#reghotplugcallback) |
| (&nbsp;[DeviceFuncs::RegDisplayVBlankCallback](#regdisplayvblankcallback)&nbsp;)(uint32_t&nbsp;devId,&nbsp;[VBlankCallback](#vblankcallback)&nbsp;callback,&nbsp;void&nbsp;\*data) | 注册VBlank事件回调。&nbsp;[更多...](#regdisplayvblankcallback) | | (&nbsp;[DeviceFuncs::RegDisplayVBlankCallback](#regdisplayvblankcallback)&nbsp;)(uint32_t&nbsp;devId,&nbsp;[VBlankCallback](#vblankcallback)&nbsp;callback,&nbsp;void&nbsp;\*data) | 注册VBlank事件回调。&nbsp;[更多...](#regdisplayvblankcallback) |
...@@ -279,12 +279,11 @@ typedef void(* HotPlugCallback) (uint32_t devId, bool connected, void *data) ...@@ -279,12 +279,11 @@ typedef void(* HotPlugCallback) (uint32_t devId, bool connected, void *data)
当有热插拔事件发生时,会回调该接口,需要通过RegHotPlugCallback注册该回调接口。 当有热插拔事件发生时,会回调该接口,需要通过RegHotPlugCallback注册该回调接口。
\@paramdevId 输入参数,显示设备ID,此ID由HDI实现层生成,并通过当前回调接口传递给图形服务使用,用以标记当前连接的显示设备。
**参数:** **参数:**
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| devId | 输入参数,显示设备ID,此ID由HDI实现层生成,并通过当前回调接口传递给图形服务使用,用以标记当前连接的显示设备。 |
| connected | 输入参数,指明设备的连接状态,ture代表连接,false代表断开。 | | connected | 输入参数,指明设备的连接状态,ture代表连接,false代表断开。 |
| data | 输出参数,图形服务携带的私有数据,该参数携带的是RegHotPlugCallback接口注册时传递的私有数据地址,详情参考&nbsp;RegHotPlugCallback&nbsp;接口注册时传递的地址。 | | data | 输出参数,图形服务携带的私有数据,该参数携带的是RegHotPlugCallback接口注册时传递的私有数据地址,详情参考&nbsp;RegHotPlugCallback&nbsp;接口注册时传递的地址。 |
...@@ -1374,7 +1373,7 @@ int32_t(* DeviceFuncs::CreateVirtualDisplay) (uint32_t width, uint32_t height, i ...@@ -1374,7 +1373,7 @@ int32_t(* DeviceFuncs::CreateVirtualDisplay) (uint32_t width, uint32_t height, i
| -------- | -------- | | -------- | -------- |
| width | 输入参数,指定显示设备的像素宽度。 | | width | 输入参数,指定显示设备的像素宽度。 |
| height | 输入参数,指定显示设备的像素高度。 | | height | 输入参数,指定显示设备的像素高度。 |
| format | 输出参数,指定显示设备的像素格式。&nbsp;详情参考[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295414172.xml#xref738382043153217,link:zh-cn_topic_0000001347985105.xml#ga60883d4958a60b91661e97027a85072a](zh-cn_topic_0000001347985105.xml#ga60883d4958a60b91661e97027a85072a),接口实现层可以根据硬件需求,修改format并返回给图形服务。 | | format | 输出参数,指定显示设备的像素格式。&nbsp;详情参考[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357381993.xml#xref738382043153217,link:zh-cn_topic_0000001347985105.xml#ga60883d4958a60b91661e97027a85072a](zh-cn_topic_0000001347985105.xml#ga60883d4958a60b91661e97027a85072a),接口实现层可以根据硬件需求,修改format并返回给图形服务。 |
| devId | 输出参数,用于接口层返回创建的设备ID。 | | devId | 输出参数,用于接口层返回创建的设备ID。 |
**返回:** **返回:**
......
...@@ -17,12 +17,12 @@ ...@@ -17,12 +17,12 @@
| -------- | -------- | | -------- | -------- |
| [authType](#authtype) | 用户认证凭据类型。 | | [authType](#authtype) | 用户认证凭据类型。 |
| [executorType](#executortype) | 执行器类型。 | | [executorType](#executortype) | 执行器类型。 |
| [executorId](#executorid) | 既定用户认证凭据类型的执行器ID。 | | [executorId](#executorsensorhint) | 既定用户认证凭据类型的执行器传感器提示,用于找到对应认证方式的传感器。 |
## **详细描述** ## **详细描述**
注册认证凭据参数 录入结果信息
**Since:** **Since:**
...@@ -48,16 +48,16 @@ enum AuthType EnrollParam::authType ...@@ -48,16 +48,16 @@ enum AuthType EnrollParam::authType
用户认证凭据类型。 用户认证凭据类型。
### executorId ### executorSensorHint
``` ```
unsigned int EnrollParam::executorId unsigned int EnrollParam::executorSensorHint
``` ```
**描述:** **描述:**
既定用户认证凭据类型的执行器ID 既定用户认证凭据类型的执行器传感器提示,用于找到对应认证方式的传感器
### executorType ### executorType
......
# EnrollResultInfo
## **概述**
**所属模块:**
[HdfUserAuth](_hdf_user_auth.md)
## **汇总**
### Public 属性
| Public&nbsp;属性 | 描述 |
| -------- | -------- |
| [credentialId](#credentialid) | 认证凭据ID。 |
| [oldInfo](#oldinfo) | 旧凭据信息。 |
| [rootSecret](#rootsecret) | 保护文件加密密钥的密钥。 |
## **详细描述**
注册认证凭据参数。
**Since:**
3.2
**Version:**
1.0
## **类成员变量说明**
### credentialId
```
unsigned long EnrollResultInfo::credentialId
```
**描述:**
认证凭据ID。
### oldInfo
```
struct CredentialInfo EnrollParam::oldInfo
```
**描述:**
旧凭据信息{\@link CredentialInfo}。
### rootSecret
```
unsigned char[] EnrollParam::rootSecret
```
**描述:**
保护文件加密密钥的密钥。
...@@ -5,7 +5,7 @@ ...@@ -5,7 +5,7 @@
**所属模块:** **所属模块:**
[HdfFaceAuth](_hdf_face_auth.md) | [HdfPinAuth](_hdf_pin_auth.md) | [HdfUserAuth](_hdf_user_auth.md) [HdfFaceAuth](_hdf_face_auth.md) | [HdfPinAuth](_hdf_pin_auth.md)
## **汇总** ## **汇总**
......
...@@ -17,8 +17,8 @@ ...@@ -17,8 +17,8 @@
| -------- | -------- | | -------- | -------- |
| [authType](#authtype) | 用户认证凭据类型。 | | [authType](#authtype) | 用户认证凭据类型。 |
| [executorRole](#executorrole) | 执行器角色ExecutorRole。 | | [executorRole](#executorrole) | 执行器角色ExecutorRole。 |
| [executorId](#executorid) | 既定用户认证凭据类型的执行器ID。 | | [executorSensorHint](#executorsensorhint) | 既定用户认证凭据类型的执行器ID。 |
| [executorType](#executortype) | 执行器类型,根据执行器支持的认证能力进行分类。 | | [executorMatcher](#executormatcher) | 执行器类型,根据执行器支持的认证能力进行分类。 |
| [esl](#esl) | 执行器安全等级ExecutorSecureLevel。 | | [esl](#esl) | 执行器安全等级ExecutorSecureLevel。 |
| [publicKey](#publickey) | 执行器公钥,用于校验该执行器私钥签名的信息。 | | [publicKey](#publickey) | 执行器公钥,用于校验该执行器私钥签名的信息。 |
...@@ -63,16 +63,16 @@ enum ExecutorSecureLevel ExecutorRegisterInfo::esl ...@@ -63,16 +63,16 @@ enum ExecutorSecureLevel ExecutorRegisterInfo::esl
执行器安全等级ExecutorSecureLevel。 执行器安全等级ExecutorSecureLevel。
### executorId ### executorSensorHint
``` ```
unsigned int ExecutorRegisterInfo::executorId unsigned int ExecutorRegisterInfo::executorSensorHint
``` ```
**描述:** **描述:**
既定用户认证凭据类型的执行器ID 既定用户认证凭据类型的执行器传感器提示,用于找到对应认证方式的传感器
### executorRole ### executorRole
...@@ -87,16 +87,16 @@ enum ExecutorRole ExecutorRegisterInfo::executorRole ...@@ -87,16 +87,16 @@ enum ExecutorRole ExecutorRegisterInfo::executorRole
执行器角色ExecutorRole。 执行器角色ExecutorRole。
### executorType ### executorMatcher
``` ```
unsigned int ExecutorRegisterInfo::executorType unsigned int ExecutorRegisterInfo::executorMatcher
``` ```
**描述:** **描述:**
执行器类型,根据执行器支持的认证能力进行分类。 执行器匹配器,根据执行器支持的认证能力进行分类。
### publicKey ### publicKey
......
...@@ -15,7 +15,8 @@ ...@@ -15,7 +15,8 @@
| Public&nbsp;属性 | 描述 | | Public&nbsp;属性 | 描述 |
| -------- | -------- | | -------- | -------- |
| [index](#index) | 用户认证框架的执行器索引。 | | [executorIndex](#executorindex) | 用户认证框架的执行器索引。 |
| [commandId](#commandid) | 消息命令ID。 |
| [msg](#msg) | 执行器发送的消息。 | | [msg](#msg) | 执行器发送的消息。 |
...@@ -33,11 +34,11 @@ ...@@ -33,11 +34,11 @@
## **类成员变量说明** ## **类成员变量说明**
### index ### executorIndex
``` ```
unsigned int ExecutorSendMsg::index unsigned long ExecutorSendMsg::executorIndex
``` ```
**描述:** **描述:**
...@@ -45,6 +46,18 @@ unsigned int ExecutorSendMsg::index ...@@ -45,6 +46,18 @@ unsigned int ExecutorSendMsg::index
用户认证框架的执行器索引。 用户认证框架的执行器索引。
### commandId
```
unsigned int ExecutorSendMsg::commandId
```
**描述:**
消息命令ID。
### msg ### msg
......
...@@ -21,7 +21,7 @@ ...@@ -21,7 +21,7 @@
### 枚举 ### 枚举
| 枚举名称 | 描述 | | 枚举 | 描述 |
| -------- | -------- | | -------- | -------- |
| [AuthType](_hdf_face_auth.md#authtype)&nbsp;:&nbsp;int&nbsp;{&nbsp;PIN&nbsp;=&nbsp;1,&nbsp;FACE&nbsp;=&nbsp;2,&nbsp;FINGERPRINT&nbsp;=&nbsp;4&nbsp;} | 枚举用户认证凭据类型。&nbsp;[更多...](_hdf_face_auth.md#authtype) | | [AuthType](_hdf_face_auth.md#authtype)&nbsp;:&nbsp;int&nbsp;{&nbsp;PIN&nbsp;=&nbsp;1,&nbsp;FACE&nbsp;=&nbsp;2,&nbsp;FINGERPRINT&nbsp;=&nbsp;4&nbsp;} | 枚举用户认证凭据类型。&nbsp;[更多...](_hdf_face_auth.md#authtype) |
| [ExecutorRole](_hdf_face_auth.md#executorrole)&nbsp;:&nbsp;int&nbsp;{&nbsp;COLLECTOR&nbsp;=&nbsp;1,&nbsp;VERIFIER&nbsp;=&nbsp;2,&nbsp;ALL_IN_ONE&nbsp;=&nbsp;3&nbsp;} | 枚举执行器角色。&nbsp;[更多...](_hdf_face_auth.md#executorrole) | | [ExecutorRole](_hdf_face_auth.md#executorrole)&nbsp;:&nbsp;int&nbsp;{&nbsp;COLLECTOR&nbsp;=&nbsp;1,&nbsp;VERIFIER&nbsp;=&nbsp;2,&nbsp;ALL_IN_ONE&nbsp;=&nbsp;3&nbsp;} | 枚举执行器角色。&nbsp;[更多...](_hdf_face_auth.md#executorrole) |
......
...@@ -27,7 +27,7 @@ ...@@ -27,7 +27,7 @@
### 枚举 ### 枚举
| 枚举名称 | 描述 | | 枚举 | 描述 |
| -------- | -------- | | -------- | -------- |
| [AuthType](#authtype)&nbsp;:&nbsp;int&nbsp;{&nbsp;PIN&nbsp;=&nbsp;1,&nbsp;FACE&nbsp;=&nbsp;2,&nbsp;FINGERPRINT&nbsp;=&nbsp;4&nbsp;} | 枚举用户认证凭据类型。&nbsp;[更多...](#authtype) | | [AuthType](#authtype)&nbsp;:&nbsp;int&nbsp;{&nbsp;PIN&nbsp;=&nbsp;1,&nbsp;FACE&nbsp;=&nbsp;2,&nbsp;FINGERPRINT&nbsp;=&nbsp;4&nbsp;} | 枚举用户认证凭据类型。&nbsp;[更多...](#authtype) |
| [ExecutorRole](#executorrole)&nbsp;:&nbsp;int&nbsp;{&nbsp;COLLECTOR&nbsp;=&nbsp;1,&nbsp;VERIFIER&nbsp;=&nbsp;2,&nbsp;ALL_IN_ONE&nbsp;=&nbsp;3&nbsp;} | 枚举执行器角色。&nbsp;[更多...](#executorrole) | | [ExecutorRole](#executorrole)&nbsp;:&nbsp;int&nbsp;{&nbsp;COLLECTOR&nbsp;=&nbsp;1,&nbsp;VERIFIER&nbsp;=&nbsp;2,&nbsp;ALL_IN_ONE&nbsp;=&nbsp;3&nbsp;} | 枚举执行器角色。&nbsp;[更多...](#executorrole) |
......
...@@ -18,7 +18,7 @@ ...@@ -18,7 +18,7 @@
| -------- | -------- | | -------- | -------- |
| [IUserAuthInterface](interface_i_user_auth_interface.md) | 声明用户认证驱动的API接口。&nbsp;[更多...](interface_i_user_auth_interface.md) | | [IUserAuthInterface](interface_i_user_auth_interface.md) | 声明用户认证驱动的API接口。&nbsp;[更多...](interface_i_user_auth_interface.md) |
| [ExecutorRegisterInfo](_executor_register_info.md) | 执行器注册信息。&nbsp;[更多...](_executor_register_info.md) | | [ExecutorRegisterInfo](_executor_register_info.md) | 执行器注册信息。&nbsp;[更多...](_executor_register_info.md) |
| [ExecutorInfo](_executor_info.md) | 执行器信息。&nbsp;[更多...](_executor_info.md) | | [ExecutorInfo](_user_executor_info.md) | 执行器信息。&nbsp;[更多...](_user_executor_info.md) |
| [ScheduleInfo](_schedule_info.md) | 调度信息。&nbsp;[更多...](_schedule_info.md) | | [ScheduleInfo](_schedule_info.md) | 调度信息。&nbsp;[更多...](_schedule_info.md) |
| [AuthSolution](_auth_solution.md) | 认证方案。&nbsp;[更多...](_auth_solution.md) | | [AuthSolution](_auth_solution.md) | 认证方案。&nbsp;[更多...](_auth_solution.md) |
| [ExecutorSendMsg](_executor_send_msg.md) | 执行器发送的消息。&nbsp;[更多...](_executor_send_msg.md) | | [ExecutorSendMsg](_executor_send_msg.md) | 执行器发送的消息。&nbsp;[更多...](_executor_send_msg.md) |
...@@ -40,7 +40,7 @@ ...@@ -40,7 +40,7 @@
### 变量 ### 变量
| 变量&nbsp;名称 | 描述 | | 变量 | 描述 |
| -------- | -------- | | -------- | -------- |
| package&nbsp;ohos.hdi.user_auth.v1_0 | 用户认证接口的包路径 | | package&nbsp;ohos.hdi.user_auth.v1_0 | 用户认证接口的包路径 |
......
...@@ -15,8 +15,8 @@ ...@@ -15,8 +15,8 @@
| Public&nbsp;属性 | 描述 | | Public&nbsp;属性 | 描述 |
| -------- | -------- | | -------- | -------- |
| (&nbsp;[start](#start)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001348293957.xml#xref459063066083932,link:zh-cn_topic_0000001348293957.xml](zh-cn_topic_0000001348293957.xml)&nbsp;\*iwifi) | 创建HAL和驱动之间的通道及获取驱动网卡信息,该函数调用在创建IWiFi实体后进行。&nbsp;[更多...](#start) | | (&nbsp;[start](#start)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357382009.xml#xref459063066083932,link:zh-cn_topic_0000001357382009.xml](zh-cn_topic_0000001357382009.xml)&nbsp;\*iwifi) | 创建HAL和驱动之间的通道及获取驱动网卡信息,该函数调用在创建IWiFi实体后进行。&nbsp;[更多...](#start) |
| (&nbsp;[stop](#stop)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001348293957.xml#xref1577893620083932,link:zh-cn_topic_0000001348293957.xml](zh-cn_topic_0000001348293957.xml)&nbsp;\*iwifi) | 销毁HAL和驱动之间的通道,该函数调用在销毁IWiFi实体前进行。&nbsp;[更多...](#stop) | | (&nbsp;[stop](#stop)&nbsp;)(struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357382009.xml#xref1577893620083932,link:zh-cn_topic_0000001357382009.xml](zh-cn_topic_0000001357382009.xml)&nbsp;\*iwifi) | 销毁HAL和驱动之间的通道,该函数调用在销毁IWiFi实体前进行。&nbsp;[更多...](#stop) |
| (&nbsp;[getSupportFeature](#getsupportfeature)&nbsp;)(uint8_t&nbsp;\*supType,&nbsp;uint32_t&nbsp;size) | 获取该设备支持的WLAN特性(不考虑当前的使用状态)。&nbsp;[更多...](#getsupportfeature) | | (&nbsp;[getSupportFeature](#getsupportfeature)&nbsp;)(uint8_t&nbsp;\*supType,&nbsp;uint32_t&nbsp;size) | 获取该设备支持的WLAN特性(不考虑当前的使用状态)。&nbsp;[更多...](#getsupportfeature) |
| (&nbsp;[getSupportCombo](#getsupportcombo)&nbsp;)(uint64_t&nbsp;\*combo,&nbsp;uint32_t&nbsp;size) | 获取多网卡共存情况。&nbsp;[更多...](#getsupportcombo) | | (&nbsp;[getSupportCombo](#getsupportcombo)&nbsp;)(uint64_t&nbsp;\*combo,&nbsp;uint32_t&nbsp;size) | 获取多网卡共存情况。&nbsp;[更多...](#getsupportcombo) |
| (&nbsp;[createFeature](#createfeature)&nbsp;)(int32_t&nbsp;type,&nbsp;struct&nbsp;[IWiFiBaseFeature](_i_wi_fi_base_feature.md)&nbsp;\*\*ifeature) | 根据输入类型创建对应的特性[IWiFiBaseFeature](_i_wi_fi_base_feature.md)&nbsp;[更多...](#createfeature) | | (&nbsp;[createFeature](#createfeature)&nbsp;)(int32_t&nbsp;type,&nbsp;struct&nbsp;[IWiFiBaseFeature](_i_wi_fi_base_feature.md)&nbsp;\*\*ifeature) | 根据输入类型创建对应的特性[IWiFiBaseFeature](_i_wi_fi_base_feature.md)&nbsp;[更多...](#createfeature) |
......
...@@ -16,8 +16,8 @@ ...@@ -16,8 +16,8 @@
| Public&nbsp;属性 | 描述 | | Public&nbsp;属性 | 描述 |
| -------- | -------- | | -------- | -------- |
| [baseFeature](#basefeature) | 基本特性。 | | [baseFeature](#basefeature) | 基本特性。 |
| (&nbsp;[getAsscociatedStas](#getasscociatedstas)&nbsp;)(const&nbsp;struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001348174149.xml#xref1123713694083932,link:zh-cn_topic_0000001348174149.xml](zh-cn_topic_0000001348174149.xml)&nbsp;\*apFeature,&nbsp;struct&nbsp;[StaInfo](_sta_info.md)&nbsp;\*staInfo,&nbsp;uint32_t&nbsp;count,&nbsp;uint32_t&nbsp;\*num) | 获取连接上的所有STA的信息(目前只包含MAC地址)。&nbsp;[更多...](#getasscociatedstas) | | (&nbsp;[getAsscociatedStas](#getasscociatedstas)&nbsp;)(const&nbsp;struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001304062480.xml#xref1123713694083932,link:zh-cn_topic_0000001304062480.xml](zh-cn_topic_0000001304062480.xml)&nbsp;\*apFeature,&nbsp;struct&nbsp;[StaInfo](_sta_info.md)&nbsp;\*staInfo,&nbsp;uint32_t&nbsp;count,&nbsp;uint32_t&nbsp;\*num) | 获取连接上的所有STA的信息(目前只包含MAC地址)。&nbsp;[更多...](#getasscociatedstas) |
| (&nbsp;[setCountryCode](#setcountrycode)&nbsp;)(const&nbsp;struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001348174149.xml#xref2129805954083932,link:zh-cn_topic_0000001348174149.xml](zh-cn_topic_0000001348174149.xml)&nbsp;\*apFeature,&nbsp;const&nbsp;char&nbsp;\*code,&nbsp;uint32_t&nbsp;len) | 设置国家码(表示AP射频所在的国家,规定了AP射频特性,包括AP的发送功率、支持的信道等。其目的是为了使AP的射频特性符合不同国家或区域的法律法规要求)。&nbsp;[更多...](#setcountrycode) | | (&nbsp;[setCountryCode](#setcountrycode)&nbsp;)(const&nbsp;struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001304062480.xml#xref2129805954083932,link:zh-cn_topic_0000001304062480.xml](zh-cn_topic_0000001304062480.xml)&nbsp;\*apFeature,&nbsp;const&nbsp;char&nbsp;\*code,&nbsp;uint32_t&nbsp;len) | 设置国家码(表示AP射频所在的国家,规定了AP射频特性,包括AP的发送功率、支持的信道等。其目的是为了使AP的射频特性符合不同国家或区域的法律法规要求)。&nbsp;[更多...](#setcountrycode) |
## **详细描述** ## **详细描述**
...@@ -63,7 +63,7 @@ int32_t(* IWiFiAp::getAsscociatedStas) (const struct IWiFiAp *apFeature, struct ...@@ -63,7 +63,7 @@ int32_t(* IWiFiAp::getAsscociatedStas) (const struct IWiFiAp *apFeature, struct
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| apFeature | 输入参数,AP特性[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001348174149.xml#xref901054971083932,link:zh-cn_topic_0000001348174149.xml](zh-cn_topic_0000001348174149.xml)。 | | apFeature | 输入参数,AP特性[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001304062480.xml#xref901054971083932,link:zh-cn_topic_0000001304062480.xml](zh-cn_topic_0000001304062480.xml)。 |
| staInfo | 输出参数,保存与AP连接的STA的基本信息。 | | staInfo | 输出参数,保存与AP连接的STA的基本信息。 |
| count | 输入参数,staInfo结构体数组的元素个数。 | | count | 输入参数,staInfo结构体数组的元素个数。 |
| num | 输出参数,实际连接的STA的个数。 | | num | 输出参数,实际连接的STA的个数。 |
...@@ -90,7 +90,7 @@ int32_t(* IWiFiAp::setCountryCode) (const struct IWiFiAp *apFeature, const char ...@@ -90,7 +90,7 @@ int32_t(* IWiFiAp::setCountryCode) (const struct IWiFiAp *apFeature, const char
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| apFeature | 输入参数,AP特性[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001348174149.xml#xref1659529054083932,link:zh-cn_topic_0000001348174149.xml](zh-cn_topic_0000001348174149.xml)。 | | apFeature | 输入参数,AP特性[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001304062480.xml#xref1659529054083932,link:zh-cn_topic_0000001304062480.xml](zh-cn_topic_0000001304062480.xml)。 |
| code | 输入参数,设置的国家码。 | | code | 输入参数,设置的国家码。 |
| len | 输入参数,国家码长度。 | | len | 输入参数,国家码长度。 |
......
...@@ -17,13 +17,13 @@ ...@@ -17,13 +17,13 @@
| -------- | -------- | | -------- | -------- |
| [ifName](#ifname)&nbsp;[[IFNAME_MAX_LEN](_w_l_a_n.md#ga63637ece87095ff8d153f650434ecf97)] | 网卡名称。 | | [ifName](#ifname)&nbsp;[[IFNAME_MAX_LEN](_w_l_a_n.md#ga63637ece87095ff8d153f650434ecf97)] | 网卡名称。 |
| **type** | 特性的类型,参考[FeatureType](_w_l_a_n.md#featuretype)。 | | **type** | 特性的类型,参考[FeatureType](_w_l_a_n.md#featuretype)。 |
| (&nbsp;[getNetworkIfaceName](#getnetworkifacename)&nbsp;)(const&nbsp;struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295414160.xml#xref1160037662083932,link:zh-cn_topic_0000001295414160.xml](zh-cn_topic_0000001295414160.xml)&nbsp;\*baseFeature) | 根据基本特性获取网卡名称。&nbsp;[更多...](#getnetworkifacename) | | (&nbsp;[getNetworkIfaceName](#getnetworkifacename)&nbsp;)(const&nbsp;struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357621445.xml#xref1160037662083932,link:zh-cn_topic_0000001357621445.xml](zh-cn_topic_0000001357621445.xml)&nbsp;\*baseFeature) | 根据基本特性获取网卡名称。&nbsp;[更多...](#getnetworkifacename) |
| (&nbsp;[getFeatureType](#getfeaturetype)&nbsp;)(const&nbsp;struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295414160.xml#xref2042681197083932,link:zh-cn_topic_0000001295414160.xml](zh-cn_topic_0000001295414160.xml)&nbsp;\*baseFeature) | 获取基本特性的类型[FeatureType](_w_l_a_n.md#featuretype)&nbsp;[更多...](#getfeaturetype) | | (&nbsp;[getFeatureType](#getfeaturetype)&nbsp;)(const&nbsp;struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357621445.xml#xref2042681197083932,link:zh-cn_topic_0000001357621445.xml](zh-cn_topic_0000001357621445.xml)&nbsp;\*baseFeature) | 获取基本特性的类型[FeatureType](_w_l_a_n.md#featuretype)&nbsp;[更多...](#getfeaturetype) |
| (&nbsp;[setMacAddress](#setmacaddress)&nbsp;)(const&nbsp;struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295414160.xml#xref1120460385083932,link:zh-cn_topic_0000001295414160.xml](zh-cn_topic_0000001295414160.xml)&nbsp;\*baseFeature,&nbsp;unsigned&nbsp;char&nbsp;\*mac,&nbsp;uint8_t&nbsp;len) | 根据传入参数设置对应网卡的MAC地址。&nbsp;[更多...](#setmacaddress) | | (&nbsp;[setMacAddress](#setmacaddress)&nbsp;)(const&nbsp;struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357621445.xml#xref1120460385083932,link:zh-cn_topic_0000001357621445.xml](zh-cn_topic_0000001357621445.xml)&nbsp;\*baseFeature,&nbsp;unsigned&nbsp;char&nbsp;\*mac,&nbsp;uint8_t&nbsp;len) | 根据传入参数设置对应网卡的MAC地址。&nbsp;[更多...](#setmacaddress) |
| (&nbsp;[getDeviceMacAddress](#getdevicemacaddress)&nbsp;)(const&nbsp;struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295414160.xml#xref330712474083932,link:zh-cn_topic_0000001295414160.xml](zh-cn_topic_0000001295414160.xml)&nbsp;\*baseFeature,&nbsp;unsigned&nbsp;char&nbsp;\*mac,&nbsp;uint8_t&nbsp;len) | 获取设备的MAC地址。&nbsp;[更多...](#getdevicemacaddress) | | (&nbsp;[getDeviceMacAddress](#getdevicemacaddress)&nbsp;)(const&nbsp;struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357621445.xml#xref330712474083932,link:zh-cn_topic_0000001357621445.xml](zh-cn_topic_0000001357621445.xml)&nbsp;\*baseFeature,&nbsp;unsigned&nbsp;char&nbsp;\*mac,&nbsp;uint8_t&nbsp;len) | 获取设备的MAC地址。&nbsp;[更多...](#getdevicemacaddress) |
| (&nbsp;[getValidFreqsWithBand](#getvalidfreqswithband)&nbsp;)(const&nbsp;struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295414160.xml#xref1369279207083932,link:zh-cn_topic_0000001295414160.xml](zh-cn_topic_0000001295414160.xml)&nbsp;\*baseFeature,&nbsp;int32_t&nbsp;band,&nbsp;int32_t&nbsp;\*freqs,&nbsp;uint32_t&nbsp;count,&nbsp;uint32_t&nbsp;\*num) | 获取指定频段(2.4G或者5G)下支持的频率。&nbsp;[更多...](#getvalidfreqswithband) | | (&nbsp;[getValidFreqsWithBand](#getvalidfreqswithband)&nbsp;)(const&nbsp;struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357621445.xml#xref1369279207083932,link:zh-cn_topic_0000001357621445.xml](zh-cn_topic_0000001357621445.xml)&nbsp;\*baseFeature,&nbsp;int32_t&nbsp;band,&nbsp;int32_t&nbsp;\*freqs,&nbsp;uint32_t&nbsp;count,&nbsp;uint32_t&nbsp;\*num) | 获取指定频段(2.4G或者5G)下支持的频率。&nbsp;[更多...](#getvalidfreqswithband) |
| (&nbsp;[setTxPower](#settxpower)&nbsp;)(const&nbsp;struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295414160.xml#xref1878860227083932,link:zh-cn_topic_0000001295414160.xml](zh-cn_topic_0000001295414160.xml)&nbsp;\*baseFeature,&nbsp;int32_t&nbsp;power) | 设置发射功率。&nbsp;[更多...](#settxpower) | | (&nbsp;[setTxPower](#settxpower)&nbsp;)(const&nbsp;struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357621445.xml#xref1878860227083932,link:zh-cn_topic_0000001357621445.xml](zh-cn_topic_0000001357621445.xml)&nbsp;\*baseFeature,&nbsp;int32_t&nbsp;power) | 设置发射功率。&nbsp;[更多...](#settxpower) |
| (&nbsp;[getChipId](#getchipid)&nbsp;)(const&nbsp;struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295414160.xml#xref407053875083932,link:zh-cn_topic_0000001295414160.xml](zh-cn_topic_0000001295414160.xml)&nbsp;\*baseFeature,&nbsp;uint8_t&nbsp;\*chipId) | 获得当前驱动的芯片ID。&nbsp;[更多...](#getchipid) | | (&nbsp;[getChipId](#getchipid)&nbsp;)(const&nbsp;struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357621445.xml#xref407053875083932,link:zh-cn_topic_0000001357621445.xml](zh-cn_topic_0000001357621445.xml)&nbsp;\*baseFeature,&nbsp;uint8_t&nbsp;\*chipId) | 获得当前驱动的芯片ID。&nbsp;[更多...](#getchipid) |
| (&nbsp;[getIfNamesByChipId](#getifnamesbychipid)&nbsp;)(const&nbsp;uint8_t&nbsp;chipId,&nbsp;char&nbsp;\*\*ifNames,&nbsp;uint32_t&nbsp;\*num) | 通过芯片ID获得当前芯片所有的网卡名称。&nbsp;[更多...](#getifnamesbychipid) | | (&nbsp;[getIfNamesByChipId](#getifnamesbychipid)&nbsp;)(const&nbsp;uint8_t&nbsp;chipId,&nbsp;char&nbsp;\*\*ifNames,&nbsp;uint32_t&nbsp;\*num) | 通过芯片ID获得当前芯片所有的网卡名称。&nbsp;[更多...](#getifnamesbychipid) |
...@@ -58,7 +58,7 @@ int32_t(* IWiFiBaseFeature::getChipId) (const struct IWiFiBaseFeature *baseFeatu ...@@ -58,7 +58,7 @@ int32_t(* IWiFiBaseFeature::getChipId) (const struct IWiFiBaseFeature *baseFeatu
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| baseFeature | 输入参数,基本特性[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295414160.xml#xref473855951083932,link:zh-cn_topic_0000001295414160.xml](zh-cn_topic_0000001295414160.xml)。 | | baseFeature | 输入参数,基本特性[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357621445.xml#xref473855951083932,link:zh-cn_topic_0000001357621445.xml](zh-cn_topic_0000001357621445.xml)。 |
| chipId | 输出参数,获得的芯片ID。 | | chipId | 输出参数,获得的芯片ID。 |
**返回:** **返回:**
...@@ -83,7 +83,7 @@ int32_t(* IWiFiBaseFeature::getDeviceMacAddress) (const struct IWiFiBaseFeature ...@@ -83,7 +83,7 @@ int32_t(* IWiFiBaseFeature::getDeviceMacAddress) (const struct IWiFiBaseFeature
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| baseFeature | 输入参数,基本特性[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295414160.xml#xref1226402066083932,link:zh-cn_topic_0000001295414160.xml](zh-cn_topic_0000001295414160.xml)。 | | baseFeature | 输入参数,基本特性[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357621445.xml#xref1226402066083932,link:zh-cn_topic_0000001357621445.xml](zh-cn_topic_0000001357621445.xml)。 |
| mac | 输出参数,获得的MAC地址。 | | mac | 输出参数,获得的MAC地址。 |
| len | 输入参数,获得的MAC地址长度。 | | len | 输入参数,获得的MAC地址长度。 |
...@@ -109,7 +109,7 @@ int32_t(*IWiFiBaseFeature::getFeatureType) (const struct IWiFiBaseFeature *baseF ...@@ -109,7 +109,7 @@ int32_t(*IWiFiBaseFeature::getFeatureType) (const struct IWiFiBaseFeature *baseF
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| baseFeature | 输入参数,基本特性[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295414160.xml#xref1934582661083932,link:zh-cn_topic_0000001295414160.xml](zh-cn_topic_0000001295414160.xml)。 | | baseFeature | 输入参数,基本特性[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357621445.xml#xref1934582661083932,link:zh-cn_topic_0000001357621445.xml](zh-cn_topic_0000001357621445.xml)。 |
**返回:** **返回:**
...@@ -159,7 +159,7 @@ const char*(* IWiFiBaseFeature::getNetworkIfaceName) (const struct IWiFiBaseFeat ...@@ -159,7 +159,7 @@ const char*(* IWiFiBaseFeature::getNetworkIfaceName) (const struct IWiFiBaseFeat
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| baseFeature | 输入参数,基本特性[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295414160.xml#xref1207169342083932,link:zh-cn_topic_0000001295414160.xml](zh-cn_topic_0000001295414160.xml)。 | | baseFeature | 输入参数,基本特性[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357621445.xml#xref1207169342083932,link:zh-cn_topic_0000001357621445.xml](zh-cn_topic_0000001357621445.xml)。 |
**返回:** **返回:**
...@@ -183,7 +183,7 @@ int32_t(* IWiFiBaseFeature::getValidFreqsWithBand) (const struct IWiFiBaseFeatur ...@@ -183,7 +183,7 @@ int32_t(* IWiFiBaseFeature::getValidFreqsWithBand) (const struct IWiFiBaseFeatur
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| baseFeature | 输入参数,基本特性[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295414160.xml#xref1345697859083932,link:zh-cn_topic_0000001295414160.xml](zh-cn_topic_0000001295414160.xml)。 | | baseFeature | 输入参数,基本特性[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357621445.xml#xref1345697859083932,link:zh-cn_topic_0000001357621445.xml](zh-cn_topic_0000001357621445.xml)。 |
| band | 输入参数,指定的一个频段。 | | band | 输入参数,指定的一个频段。 |
| freqs | 输出参数,保存支持的频率。 | | freqs | 输出参数,保存支持的频率。 |
| count | 输入参数,频率数组的元素个数。 | | count | 输入参数,频率数组的元素个数。 |
...@@ -223,7 +223,7 @@ int32_t(* IWiFiBaseFeature::setMacAddress) (const struct IWiFiBaseFeature *baseF ...@@ -223,7 +223,7 @@ int32_t(* IWiFiBaseFeature::setMacAddress) (const struct IWiFiBaseFeature *baseF
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| baseFeature | 输入参数,基本特性[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295414160.xml#xref1858718007083932,link:zh-cn_topic_0000001295414160.xml](zh-cn_topic_0000001295414160.xml)。 | | baseFeature | 输入参数,基本特性[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357621445.xml#xref1858718007083932,link:zh-cn_topic_0000001357621445.xml](zh-cn_topic_0000001357621445.xml)。 |
| mac | 输入参数,设置的MAC地址。 | | mac | 输入参数,设置的MAC地址。 |
| len | 输入参数,设置的MAC地址长度。 | | len | 输入参数,设置的MAC地址长度。 |
...@@ -249,7 +249,7 @@ int32_t(* IWiFiBaseFeature::setTxPower) (const struct IWiFiBaseFeature *baseFeat ...@@ -249,7 +249,7 @@ int32_t(* IWiFiBaseFeature::setTxPower) (const struct IWiFiBaseFeature *baseFeat
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| baseFeature | 输入参数,基本特性[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295414160.xml#xref793467134083932,link:zh-cn_topic_0000001295414160.xml](zh-cn_topic_0000001295414160.xml)。 | | baseFeature | 输入参数,基本特性[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001357621445.xml#xref793467134083932,link:zh-cn_topic_0000001357621445.xml](zh-cn_topic_0000001357621445.xml)。 |
| power | 输入参数,设置的发射功率。 | | power | 输入参数,设置的发射功率。 |
**返回:** **返回:**
......
...@@ -16,7 +16,7 @@ ...@@ -16,7 +16,7 @@
| Public&nbsp;属性 | 描述 | | Public&nbsp;属性 | 描述 |
| -------- | -------- | | -------- | -------- |
| [baseFeature](#basefeature) | 基本特性。 | | [baseFeature](#basefeature) | 基本特性。 |
| (&nbsp;[setScanningMacAddress](#setscanningmacaddress)&nbsp;)(const&nbsp;struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295414208.xml#xref1079443811083932,link:zh-cn_topic_0000001295414208.xml](zh-cn_topic_0000001295414208.xml)&nbsp;\*staFeature,&nbsp;unsigned&nbsp;char&nbsp;\*scanMac,&nbsp;uint8_t&nbsp;len) | 设置扫描单个MAC地址。&nbsp;[更多...](#setscanningmacaddress) | | (&nbsp;[setScanningMacAddress](#setscanningmacaddress)&nbsp;)(const&nbsp;struct&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001304541952.xml#xref1079443811083932,link:zh-cn_topic_0000001304541952.xml](zh-cn_topic_0000001304541952.xml)&nbsp;\*staFeature,&nbsp;unsigned&nbsp;char&nbsp;\*scanMac,&nbsp;uint8_t&nbsp;len) | 设置扫描单个MAC地址。&nbsp;[更多...](#setscanningmacaddress) |
| (&nbsp;[startScan](#startscan)&nbsp;)(const&nbsp;char&nbsp;\*ifName,&nbsp;WifiScan&nbsp;\*scan) | 启动扫描。&nbsp;[更多...](#startscan) | | (&nbsp;[startScan](#startscan)&nbsp;)(const&nbsp;char&nbsp;\*ifName,&nbsp;WifiScan&nbsp;\*scan) | 启动扫描。&nbsp;[更多...](#startscan) |
...@@ -63,7 +63,7 @@ int32_t(* IWiFiSta::setScanningMacAddress) (const struct IWiFiSta *staFeature, u ...@@ -63,7 +63,7 @@ int32_t(* IWiFiSta::setScanningMacAddress) (const struct IWiFiSta *staFeature, u
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| staFeature | 输入参数,STA特性[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001295414208.xml#xref557822862083932,link:zh-cn_topic_0000001295414208.xml](zh-cn_topic_0000001295414208.xml)。 | | staFeature | 输入参数,STA特性[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001304541952.xml#xref557822862083932,link:zh-cn_topic_0000001304541952.xml](zh-cn_topic_0000001304541952.xml)。 |
| scanMac | 输入参数,设置STA扫描的MAC地址。 | | scanMac | 输入参数,设置STA扫描的MAC地址。 |
| len | 输入参数,MAC地址的长度。 | | len | 输入参数,MAC地址的长度。 |
......
...@@ -42,7 +42,7 @@ ...@@ -42,7 +42,7 @@
### 枚举 ### 枚举
| 枚举名称 | 描述 | | 枚举 | 描述 |
| -------- | -------- | | -------- | -------- |
| [RetStatus](#retstatus)&nbsp;{&nbsp;INPUT_SUCCESS&nbsp;=&nbsp;0,&nbsp;INPUT_FAILURE&nbsp;=&nbsp;-1,&nbsp;INPUT_INVALID_PARAM&nbsp;=&nbsp;-2,&nbsp;INPUT_NOMEM&nbsp;=&nbsp;-3,&nbsp;&nbsp;&nbsp;INPUT_NULL_PTR&nbsp;=&nbsp;-4,&nbsp;INPUT_TIMEOUT&nbsp;=&nbsp;-5,&nbsp;INPUT_UNSUPPORTED&nbsp;=&nbsp;-6&nbsp;} | 定义返回值类型&nbsp;[更多...](#retstatus) | | [RetStatus](#retstatus)&nbsp;{&nbsp;INPUT_SUCCESS&nbsp;=&nbsp;0,&nbsp;INPUT_FAILURE&nbsp;=&nbsp;-1,&nbsp;INPUT_INVALID_PARAM&nbsp;=&nbsp;-2,&nbsp;INPUT_NOMEM&nbsp;=&nbsp;-3,&nbsp;&nbsp;&nbsp;INPUT_NULL_PTR&nbsp;=&nbsp;-4,&nbsp;INPUT_TIMEOUT&nbsp;=&nbsp;-5,&nbsp;INPUT_UNSUPPORTED&nbsp;=&nbsp;-6&nbsp;} | 定义返回值类型&nbsp;[更多...](#retstatus) |
| [InputDevType](#inputdevtype)&nbsp;{&nbsp;INDEV_TYPE_TOUCH,&nbsp;INDEV_TYPE_KEY,&nbsp;INDEV_TYPE_KEYBOARD,&nbsp;INDEV_TYPE_MOUSE,&nbsp;&nbsp;&nbsp;INDEV_TYPE_BUTTON,&nbsp;INDEV_TYPE_CROWN,&nbsp;INDEV_TYPE_ENCODER,&nbsp;INDEV_TYPE_UNKNOWN&nbsp;} | 定义input设备类型&nbsp;[更多...](#inputdevtype) | | [InputDevType](#inputdevtype)&nbsp;{&nbsp;INDEV_TYPE_TOUCH,&nbsp;INDEV_TYPE_KEY,&nbsp;INDEV_TYPE_KEYBOARD,&nbsp;INDEV_TYPE_MOUSE,&nbsp;&nbsp;&nbsp;INDEV_TYPE_BUTTON,&nbsp;INDEV_TYPE_CROWN,&nbsp;INDEV_TYPE_ENCODER,&nbsp;INDEV_TYPE_UNKNOWN&nbsp;} | 定义input设备类型&nbsp;[更多...](#inputdevtype) |
...@@ -84,7 +84,7 @@ enum CapacitanceTest ...@@ -84,7 +84,7 @@ enum CapacitanceTest
**描述:** **描述:**
定义容值测试类型 定义容值测试类型
| 枚举值 | 描述 | | 枚举值 | 描述 |
| -------- | -------- | | -------- | -------- |
...@@ -104,7 +104,7 @@ enum InputDevType ...@@ -104,7 +104,7 @@ enum InputDevType
**描述:** **描述:**
定义input设备类型 定义Input设备类型。
| 枚举值 | 描述 | | 枚举值 | 描述 |
| -------- | -------- | | -------- | -------- |
...@@ -127,7 +127,7 @@ enum PowerStatus ...@@ -127,7 +127,7 @@ enum PowerStatus
**描述:** **描述:**
定义电源状态 定义电源状态
| 枚举值 | 描述 | | 枚举值 | 描述 |
| -------- | -------- | | -------- | -------- |
...@@ -146,7 +146,7 @@ enum RetStatus ...@@ -146,7 +146,7 @@ enum RetStatus
**描述:** **描述:**
定义返回值类型 定义返回值类型
| 枚举值 | 描述 | | 枚举值 | 描述 |
| -------- | -------- | | -------- | -------- |
...@@ -171,7 +171,7 @@ int32_t GetInputInterface (IInputInterface **interface) ...@@ -171,7 +171,7 @@ int32_t GetInputInterface (IInputInterface **interface)
**描述:** **描述:**
input服务通过调用此接口获取操作input设备的所有接口。 Input服务通过调用此接口获取操作input设备的所有接口。
**参数:** **参数:**
...@@ -181,9 +181,9 @@ input服务通过调用此接口获取操作input设备的所有接口。 ...@@ -181,9 +181,9 @@ input服务通过调用此接口获取操作input设备的所有接口。
**返回:** **返回:**
Returns INPUT_SUCCESS 表示执行成功。 INPUT_SUCCESS 表示执行成功。
Returns 其他值表示执行失败,具体错误码查看**RetSatus** 其他值表示执行失败,具体错误码查看**RetSatus**
**Since:** **Since:**
......
...@@ -24,7 +24,7 @@ ...@@ -24,7 +24,7 @@
### 枚举 ### 枚举
| 枚举名称 | 描述 | | 枚举 | 描述 |
| -------- | -------- | | -------- | -------- |
| [LightStatus](#lightstatus)&nbsp;{&nbsp;LIGHT_SUCCESS&nbsp;=&nbsp;0,&nbsp;LIGHT_NOT_SUPPORT&nbsp;=&nbsp;-1,&nbsp;LIGHT_NOT_FLASH&nbsp;=&nbsp;-2,&nbsp;LIGHT_NOT_BRIGHTNESS&nbsp;=&nbsp;-3&nbsp;} | 枚举灯模块的状态值。&nbsp;[更多...](#lightstatus) | | [LightStatus](#lightstatus)&nbsp;{&nbsp;LIGHT_SUCCESS&nbsp;=&nbsp;0,&nbsp;LIGHT_NOT_SUPPORT&nbsp;=&nbsp;-1,&nbsp;LIGHT_NOT_FLASH&nbsp;=&nbsp;-2,&nbsp;LIGHT_NOT_BRIGHTNESS&nbsp;=&nbsp;-3&nbsp;} | 枚举灯模块的状态值。&nbsp;[更多...](#lightstatus) |
| [LightId](#lightid)&nbsp;{&nbsp;LIGHT_ID_NONE&nbsp;=&nbsp;0,&nbsp;LIGHT_ID_BATTERY&nbsp;=&nbsp;1,&nbsp;LIGHT_ID_NOTIFICATIONS&nbsp;=&nbsp;2,&nbsp;LIGHT_ID_ATTENTION&nbsp;=&nbsp;3,&nbsp;&nbsp;&nbsp;LIGHT_ID_BUTT&nbsp;=&nbsp;4&nbsp;} | 枚举灯类型&nbsp;[更多...](#lightid) | | [LightId](#lightid)&nbsp;{&nbsp;LIGHT_ID_NONE&nbsp;=&nbsp;0,&nbsp;LIGHT_ID_BATTERY&nbsp;=&nbsp;1,&nbsp;LIGHT_ID_NOTIFICATIONS&nbsp;=&nbsp;2,&nbsp;LIGHT_ID_ATTENTION&nbsp;=&nbsp;3,&nbsp;&nbsp;&nbsp;LIGHT_ID_BUTT&nbsp;=&nbsp;4&nbsp;} | 枚举灯类型&nbsp;[更多...](#lightid) |
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册