Skip to content

D
Docs

OpenHarmony / Docs
大约 1 年 前同步成功

通知 159
Star 292
Fork 28
D
Docs
未验证 提交 015279a7 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!10538 HDI接口更新【需要同步native仓的翻译】 

Merge pull request !10538 from duangavin123/master
上级 476a7c3a e6d11f66
展开全部 隐藏空白更改
内联 并排
Showing with 17648 addition and 13164 deletion
zh-cn/device-dev/reference/hdi-apis/Readme-CN.md
浏览文件 @ 015279a7
# HDI 接口参考
# HDI 参数参考
- 模块
- [Audio](_audio.md)
- [Battery](battery.md)
- [Camera](_camera.md)
- [Codec](_codec.md)
- [Camera](camera.md)
- [Codec](codec.md)
- [Display](_display.md)
- [HdfFaceAuth](_hdf_face_auth.md)
- [Input](_input.md)
- [Light](_light.md)
- [HdfPinAuth](_hdf_pin_auth.md)
- [HdfUserAuth](_hdf_user_auth.md)
- [HdiActivityRecognition](activity_recognition.md)
- [Input](input.md)
- [Light](light.md)
- [Motion](motion.md)
- [Power](power.md)
- [Sensor](_sensor.md)
- [Sensor](sensor.md)
- [Thermal](thermal.md)
- [USB](_u_s_b.md)
- [HdfUserAuth](_hdf_user_auth.md)
- [Vibrator](_vibrator.md)
- [WLAN](_w_l_a_n.md)
- [USB](usb.md)
- [Vibrator](vibrator.md)
- [WLAN](wlan.md)
- 头文件和结构体
- 头文件
- [audio_adapter.h](audio__adapter_8h.md)
......@@ -28,65 +30,74 @@
- [audio_scene.h](audio__scene_8h.md)
- [audio_types.h](audio__types_8h.md)
- [audio_volume.h](audio__volume_8h.md)
- [codec_callback_if.h](codec__callback__if_8h.md)
- [codec_common_type.h](codec__common__type_8h.md)
- [codec_component_if.h](codec__component__if_8h.md)
- [codec_component_manager.h](codec__component__manager_8h.md)
- [codec_component_type.h](codec__component__type_8h.md)
- [codec_callback_if.h](codec_callback_if_h.md)
- [codec_common_type.h](codec_common_type_h.md)
- [codec_component_if.h](codec_component_if_h.md)
- [codec_component_manager.h](codec__component__manager_h.md)
- [codec_component_type.h](codec__component__type_h.md)
- [display_device.h](display__device_8h.md)
- [display_gfx.h](display__gfx_8h.md)
- [display_gralloc.h](display__gralloc_8h.md)
- [display_layer.h](display__layer_8h.md)
- [display_type.h](display__type_8h.md)
- [icamera_device_callback.h](icamera__device__callback_8h.md)
- [icamera_device.h](icamera__device_8h.md)
- [icamera_host_callback.h](icamera__host__callback_8h.md)
- [icamera_host.h](icamera__host_8h.md)
- [display_vgu.h](display__vgu_8h.md)
- [input_controller.h](input__controller_8h.md)
- [input_manager.h](input__manager_8h.md)
- [input_reporter.h](input__reporter_8h.md)
- [input_type.h](input__type_8h.md)
- [ioffline_stream_operator.h](ioffline__stream__operator_8h.md)
- [istream_operator_callback.h](istream__operator__callback_8h.md)
- [istream_operator.h](istream__operator_8h.md)
- [light_if.h](light__if_8h.md)
- [light_type.h](light_8typeh.md)
- [sensor_if.h](sensor__if_8h.md)
- [sensor_type.h](sensor__type_8h.md)
- [types.h](types_8h.md)
- [usb_info.h](usb__info_8h.md)
- [usbd_client.h](usbd__client_8h.md)
- [usbd_subscriber.h](usbd__subscriber_8h.md)
- [usbd_type.h](usbd__type_8h.md)
- [vibrator_if.h](vibrator__if_8h.md)
- [vibrator_type.h](vibrator__type_8h.md)
- [wifi_hal_ap_feature.h](wifi__hal__ap__feature_8h.md)
- [wifi_hal_base_feature.h](wifi__hal__base__feature_8h.md)
- [wifi_hal_sta_feature.h](wifi__hal__sta__feature_8h.md)
- [wifi_hal.h](wifi__hal_8h.md)
- [ActivityRecognitionTypes.idl](activity_recognition_types_idl.md)
- [Types.idl](battery_types_idl.md)
- [IExecutor.idl](face__auth_2_i_executor_8idl.md)
- [IExecutorCallback.idl](face__auth_2_i_executor_callback_8idl.md)
- [FaceAuthTypes.idl](_face_auth_types_8idl.md)
- [PinAuthTypes.idl](_pin_auth_types_8idl.md)
- [IBatteryCallback.idl](_i_battery_callback_8idl.md)
- [IBatteryInterface.idl](_i_battery_interface_8idl.md)
- [IExecutor.idl](pin__auth_2_i_executor_8idl.md)
- [IExecutorCallback.idl](pin__auth_2_i_executor_callback_8idl.md)
- [IFaceAuthInterface.idl](_i_face_auth_interface_8idl.md)
- [IPinAuthInterface.idl](_i_pin_auth_interface_8idl.md)
- [IUserAuthInterface.idl](_i_user_auth_interface_8idl.md)
- [UserAuthTypes.idl](_user_auth_types_8idl.md)
- [IActivityChangedCallback.idl](_i_activity_changed_callback_8idl.md)
- [IActivityInterface.idl](_i_activity_interface_8idl.md)
- [IBatteryCallback.idl](_i_battery_callback_8idl.md)
- [IBatteryInterface.idl](_i_battery_interface_8idl.md)
- [ICameraDevice.idl](_i_camera_device_8idl.md)
- [ICameraDeviceCallback.idl](_i_camera_device_callback_8idl.md)
- [ICameraHostCallback.idl](_i_camera_host_callback_8idl.md)
- [ICameraHost.idl](_i_camera_host_8idl.md)
- [ILightInterface.idl](_i_light_interface_8idl.md)
- [IMotionCallback.idl](_i_motion_callback_8idl.md)
- [IMotionInterface.idl](_i_motion_interface_8idl.md)
- [IOfflineStreamOperator.idl](_i_offline_stream_operator_8idl.md)
- [IPowerHdiCallback.idl](_i_power_hdi_callback_8idl.md)
- [IPowerInterface.idl](_i_power_interface_8idl.md)
- [IThermalInterface.idl](_i_thermal_interface_8idl.md)
- [ISensorCallback.idl](_i_sensor_callback_8idl.md)
- [ISensorInterface.idl](_i_sensor_interface_8idl.md)
- [IStreamOperator.idl](_i_stream_operator_8idl.md)
- [IStreamOperatorCallback.idl](_i_stream_operator_callback_8idl.md)
- [IThermalCallback.idl](_i_thermal_callback_8idl.md)
- [IUserAuthInterface.idl](_i_user_auth_interface_8idl.md)
- [IThermalInterface.idl](_i_thermal_interface_8idl.md)
- [IUsbdBulkCallback.idl](_i_usbd_bulk_callback_8idl.md)
- [IUsbInterface.idl](_i_usb_interface_8idl.md)
- [IUsbdSubscriber.idl](_i_usbd_subscriber_8idl.md)
- [IVibratorInterface.idl](_i_vibrator_interface_8idl.md)
- [IWlanCallback.idl](_i_wlan_callback_8idl.md)
- [IWlanInterface.idl](_i_wlan_interface_8idl.md)
- [LightTypes.idl](_light_types_8idl.md)
- [MotionTypes.idl](_motion_types_8idl.md)
- [PowerTypes.idl](_power_types_8idl.md)
- [SensorTypes.idl](_sensor_types_8idl.md)
- [ThermalTypes.idl](_thermal_types_8idl.md)
- [Types.idl](_types_8idl.md)
- [UserAuthTypes.idl](_user_auth_types_8idl.md)
- [Types.idl](camera_2v1__0_2_types_8idl.md)
- [UsbTypes.idl](_usb_types_8idl.md)
- [VibratorTypes.idl](_vibrator_types_8idl.md)
- [WlanTypes.idl](_wlan_types_8idl.md)
- 结构体
- [__attribute__](____attribute____.md)
- [Alignment](_alignment.md)
- [YUVDescInfo](_yun_desc_info_.md)
- [ExtDataHandle](_ext_data_handle.md)
- [ActRecognitionEvent](_act_recognition_event.md)
- [AllocInfo](_alloc_info.md)
- [Alignment](_alignment.md)
- [AudioAdapter](_audio_adapter.md)
- [AudioAdapterDescriptor](_audio_adapter_descriptor.md)
- [AudioAttribute](_audio_attribute.md)
......@@ -98,7 +109,7 @@
- [AudioMixExtInfo](_audio_mix_ext_info.md)
- [AudioMmapBufferDescripter](_audio_mmap_buffer_descripter.md)
- [AudioPort](_audio_port.md)
- [AudioPortCap](_audio_port_cap.md)
- [AudioPortCap](audio_portcap.md)
- [AudioPortCapability](_audio_port_capability.md)
- [AudioRender](_audio_render.md)
- [AudioRoute](_audio_route.md)
......@@ -113,12 +124,16 @@
- [AudioVolume](_audio_volume.md)
- [AuthResultInfo](_auth_result_info.md)
- [AuthSolution](_auth_solution.md)
- [BatteryInfo](_battery_info.md)
- [BufferData](_buffer_data.md)
- [BatteryInfo](_battery_info.md)
- [CaptureEndedInfo](_capture_ended_info.md)
- [CaptureErrorInfo](_capture_error_info.md)
- [CaptureInfo](_capture_info.md)
- [CodecCallbackType](_codec_callback_type.md)
- [CodecCompCapability](_codec_comp_capability.md)
- [CodecComponentManager](_codec_component_manager.md)
- [CodecComponentType](_codec_component_type.md)
- [ColorValue](union_color_value.md)
- [CompVerInfo](_comp_ver_info.md)
- [CredentialInfo](_credential_info.md)
- [DeviceFuncs](_device_funcs.md)
......@@ -137,11 +152,33 @@
- [GfxFuncs](_gfx_funcs.md)
- [GfxOpt](_gfx_opt.md)
- [GrallocFuncs](_gralloc_funcs.md)
- [HdfFeatureInfo](_hdf_feature_info.md)
- [HdfLightColor](_hdf_light_color.md)
- [HdfLightEffect](_hdf_light_effect.md)
- [HdfLightFlashEffect](_hdf_light_flash_effect.md)
- [HdfLightInfo](_hdf_light_info.md)
- [HdfMotionEvent](_hdf_motion_event.md)
- [HdfNetDeviceInfo](_hdf_net_device_info.md)
- [HdfNetDeviceInfoResult](_hdf_net_device_info_result.md)
- [HdfSensorEvents](_hdf_sensor_events.md)
- [HdfSensorInformation](_hdf_sensor_information.md)
- [HdfStaInfo](_hdf_sta_info.md)
- [HdfThermalCallbackInfo](_hdf_thermal_callback_info.md)
- [HdfVibratorInfo](_hdf_vibrator_info.md)
- [HdfWifiDriverScanSsid](_hdf_wifi_driver_scan_ssid.md)
- [HdfWifiInfo](_hdf_wifi_info.md)
- [HdfWifiScan](_hdf_wifi_scan.md)
- [HdfWifiScanResult](_hdf_wifi_scan_result.md)
- [HDRCapability](_h_d_r_capability.md)
- [HDRMetaData](_h_d_r_meta_data.md)
- [IActivityChangedCallback](interface_i_activity_changed_callback.md)
- [IActivityInterface](interface_i_activity_interface.md)
- [IBatteryCallback](interface_i_battery_callback.md)
- [IBatteryInterface](interface_i_battery_interface.md)
- [ICameraDevice](interface_i_camera_device.md)
- [ICameraDeviceCallback](interface_i_camera_device_callback.md)
- [ICameraHost](interface_i_camera_host.md)
- [ICameraHostCallback](interface_i_camera_host_callback.md)
- [ICircle](_i_circle.md)
- [IdentifyResultInfo](_identify_result_info.md)
- [IExecutor](interface_i_executor.md)
......@@ -149,77 +186,91 @@
- [IExecutorCallback](interface_i_executor_callback.md)
- [IExecutorCallback](interface_pin_i_executor_callback.md)
- [IFaceAuthInterface](interface_i_face_auth_interface.md)
- [IInputInterface](_i_input_interface.md)
- [ILine](_i_line.md)
- [IInputInterface](_i_input_interface.md)
- [ILightInterface](interface_i_light_interface.md)
- [IMotionCallback](interface_i_motion_callback.md)
- [IMotionInterface](interface_i_motion_interface.md)
- [InputController](_input_controller.md)
- [InputDevAbility](_input_dev_ability.md)
- [InputDevAttr](_input_dev_attr.md)
- [InputDevAttr](_input_dev_attr.md)
- [InputDevDesc](_input_dev_desc.md)
- [InputDeviceInfo](_input_device_info.md)
- [InputDevIdentify](_input_dev_identify.md)
- [InputDeviceInfo](_device_info.md)
- [InputDimensionInfo](_input_dimension_info.md)
- [InputEventCb](_input_report_event_cb.md)
- [InputEventPackage](_event_package.md)
- [InputDimensionInfo](_input_dimension_info.md)
- [InputEventCb](_input_event_cb.md)
- [InputEventPackage](_input_event_package.md)
- [IPowerHdiCallback](interface_i_power_hdi_callback.md)
- [InputExtraCmd](_input_extra_cmd.md)
- [InputHostCb](_input_host_cb.md)
- [InputHotPlugEvent](_input_hotplug_event.md)
- [InputHotPlugEvent](_input_hot_plug_event.md)
- [InputManager](_input_manager.md)
- [InputReporter](_input_reporter.md)
- [IOfflineStreamOperator](interface_i_offline_stream_operator.md)
- [IPinAuthInterface](interface_i_pin_auth_interface.md)
- [IPowerHdiCallback](interface_i_power_hdi_callback.md)
- [IPowerInterface](interface_i_power_interface.md)
- [IRect](_i_rect.md)
- [ISensorCallback](interface_i_sensor_callback.md)
- [ISensorInterface](interface_i_sensor_interface.md)
- [IStreamOperator](interface_i_stream_operator.md)
- [IStreamOperatorCallback](interface_i_stream_operator_callback.md)
- [ISurface](_i_surface.md)
- [IThermalCallback](interface_i_thermal_callback.md)
- [IThermalInterface](interface_i_thermal_interface.md)
- [IUsbdBulkCallback](interface_i_usbd_bulk_callback.md)
- [IUsbdSubscriber](interface_i_usbd_subscriber.md)
- [IUsbInterface](interface_i_usb_interface.md)
- [IUserAuthInterface](interface_i_user_auth_interface.md)
- [IWiFi](_i_wi_fi.md)
- [IWiFiAp](_i_wi_fi_ap.md)
- [IWiFiBaseFeature](_i_wi_fi_base_feature.md)
- [IWiFiSta](_i_wi_fi_sta.md)
- [IVibratorInterface](interface_i_vibrator_interface.md)
- [IWlanCallback](interface_i_wlan_callback.md)
- [IWlanInterface](interface_i_wlan_interface.md)
- [LayerAlpha](_layer_alpha.md)
- [LayerBuffer](_layer_buffer.md)
- [LayerFuncs](_layer_funcs.md)
- [LayerInfo](_layer_info.md)
- [LightEffect](_light_effect.md)
- [LightFlashEffect](_light_flash_effect.md)
- [LightInfo](_light_info.md)
- [LightInterface](_light_interface.md)
- [OHOS::Camera::CaptureEndedInfo](_o_h_o_s_1_1_camera_1_1_capture_ended_info.md)
- [OHOS::Camera::CaptureErrorInfo](_o_h_o_s_1_1_camera_1_1_capture_error_info.md)
- [OHOS::Camera::CaptureInfo](_o_h_o_s_1_1_camera_1_1_capture_info.md)
- [OHOS::Camera::ICameraDevice](_o_h_o_s_1_1_camera_1_1_i_camera_device.md)
- [OHOS::Camera::ICameraDeviceCallback](_o_h_o_s_1_1_camera_1_1_i_camera_device_callback.md)
- [OHOS::Camera::ICameraHost](_o_h_o_s_1_1_camera_1_1_i_camera_host.md)
- [OHOS::Camera::ICameraHostCallback](_o_h_o_s_1_1_camera_1_1_i_camera_host_callback.md)
- [OHOS::Camera::IOfflineStreamOperator](_o_h_o_s_1_1_camera_1_1_i_offline_stream_operator.md)
- [OHOS::Camera::IStreamOperator](_o_h_o_s_1_1_camera_1_1_i_stream_operator.md)
- [OHOS::Camera::IStreamOperatorCallback](_o_h_o_s_1_1_camera_1_1_i_stream_operator_callback.md)
- [OHOS::Camera::StreamAttribute](_o_h_o_s_1_1_camera_1_1_stream_attribute.md)
- [OHOS::Camera::StreamInfo](_o_h_o_s_1_1_camera_1_1_stream_info.md)
- [OHOS::USB::UsbCtrlTransfer](_o_h_o_s_1_1_u_s_b_1_1_usb_ctrl_transfer.md)
- [OHOS::USB::UsbdClient](_o_h_o_s_1_1_u_s_b_1_1_usbd_client.md)
- [OHOS::USB::UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md)
- [OHOS::USB::USBDeviceInfo](_o_h_o_s_1_1_u_s_b_1_1_u_s_b_device_info.md)
- [OHOS::USB::UsbdSubscriber](_o_h_o_s_1_1_u_s_b_1_1_usbd_subscriber.md)
- [OHOS::USB::UsbInfo](_o_h_o_s_1_1_u_s_b_1_1_usb_info.md)
- [OHOS::USB::UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md)
- [MeasChannelParam](_meas_channel_param.md)
- [MeasChannelResult](_meas_channel_result.md)
- [OmxCodecBuffer](_omx_codec_buffer.md)
- [PortCap](union_port_cap.md)
- [PortInfo](_port_info.md)
- [PresentTimestamp](_present_timestamp.md)
- [PropertyObject](_property_object.md)
- [ProjectionScreenCmdParam](_projection_screen_cmd_param.md)
- [RangeValue](_range_value.md)
- [Rect](_rect.md)
- [Rectangle](_rectangle.md)
- [RGBColor](_r_g_b_color.md)
- [ScheduleInfo](_schedule_info.md)
- [SensorEvents](_sensor_events.md)
- [SensorInformation](_sensor_information.md)
- [SensorInterface](_sensor_interface.md)
- [StaInfo](_sta_info.md)
- [StreamAttribute](_stream_attribute.md)
- [StreamInfo](_stream_info.md)
- [SupportBufferType](_support_buffer_type.md)
- [TemplateInfo](_template_info.md)
- [ThermalZoneInfo](_thermal_zone_info.md)
- [UsbCtrlTransfer](_usb_ctrl_transfer.md)
- [UsbDev](_usb_dev.md)
- [USBDeviceInfo](_u_s_b_device_info.md)
- [UsbPipe](_usb_pipe.md)
- [UseBufferType](_use_buffer_type.md)
- [VerifyAllocInfo](_verify_alloc_info.md)
- [VibratorInterface](_vibrator_interface.md)
- [VGUBuffer](_v_g_u_buffer.md)
- [VGUColorStop](_v_g_u_color_stop.md)
- [VGUConic](_v_g_u_conic.md)
- [VGUFillAttr](_v_g_u_fill_attr.md)
- [VGUFuncs](_v_g_u_funcs.md)
- [VGUGradient](_v_g_u_gradient.md)
- [VGUImage](_v_g_u_image.md)
- [VGULinear](_v_g_u_linear.md)
- [VGUMaskLayer](_v_g_u_mask_layer.md)
- [VGUMatrix3](_v_g_u_matrix3.md)
- [VGUPaintStyle](_v_g_u_paint_style.md)
- [VGUPath](_v_g_u_path.md)
- [VGUPattern](_v_g_u_pattern.md)
- [VGUPoint](_v_g_u_point.md)
- [VGURadial](_v_g_u_radial.md)
- [VGURect](_v_g_u_rect.md)
- [VGUSolid](_v_g_u_solid.md)
- [VGUStrokeAttr](_v_g_u_stroke_attr.md)
- [VGUSurface](_v_g_u_surface.md)
- [VideoPortCap](_video_port_cap.md)
- [WifiStationInfo](_wifi_station_info.md)
- [WRGBColor](_w_r_g_b_color.md)
zh-cn/device-dev/reference/hdi-apis/_act_recognition_event.md 0 → 100644
浏览文件 @ 015279a7
# ActRecognitionEvent
## **概述**
定义行为识别模块使用的数据类型。
**Since**:
3.2
**Version**:
1.0
**相关模块:**
[HdiActivityRecognition](activity_recognition.md)
## **汇总**
### Public 属性
| 名称 | 描述 |
| -------- | -------- |
| [activity](#activity) | 行为类型 |
| [eventType](#eventtype) | 事件类型 |
| [timestamp](#timestamp) | 时间戳 |
| [confidence](#confidence) | 置信度 |
## **类成员变量说明**
### activity
```
int ActRecognitionEvent::activity
```
**描述：**
行为类型，详见[ActRecognitionEventType](activity_recognition.md#actrecognitioneventtype)。
### confidence
```
int ActRecognitionEvent::confidence
```
**描述：**
置信度，100为最可信，0为最不可信，-1为该行为不支持置信度的计算。
### eventType
```
int ActRecognitionEvent::eventType
```
**描述：**
事件类型，详见[ActRecognitionEventType](activity_recognition.md#actrecognitioneventtype)。
### timestamp
```
long ActRecognitionEvent::timestamp
```
**描述：**
时间戳。
zh-cn/device-dev/reference/hdi-apis/_alignment.md
浏览文件 @ 015279a7
......@@ -3,9 +3,11 @@
## **概述**
**所属模块:**
对齐结构定义，包含宽高的对齐值。
**相关模块:**
[Codec](_codec.md)
[Codec](codec.md)
## **汇总**
......@@ -13,17 +15,12 @@
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [widthAlignment](#widthalignment) | 宽的对齐值。 |
| [heightAlignment](#heightalignment) | 高的对齐值。 |
## **详细描述**
对齐结构定义，包含宽高的对齐值。
## **类成员变量说明**
......
zh-cn/device-dev/reference/hdi-apis/_alloc_info.md
浏览文件 @ 015279a7
......@@ -3,7 +3,9 @@
## **概述**
**所属模块:**
定义关于要分配的内存的信息。
**相关模块:**
[Display](_display.md)
......@@ -13,15 +15,10 @@
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [width](_display.md#width-67) | 申请内存宽度 |
| [height](_display.md#height-67) | 申请内存高度 |
| [width](_display.md#width-69) | 申请内存宽度 |
| [height](_display.md#height-68) | 申请内存高度 |
| [usage](_display.md#usage-12) | 申请内存的使用场景 |
| [format](_display.md#format-12) | 申请内存格式 |
| [expectedSize](_display.md#expectedsize) | 申请内存大小 |
## **详细描述**
定义关于要分配的内存的信息。
zh-cn/device-dev/reference/hdi-apis/_audio_adapter.md
浏览文件 @ 015279a7
......@@ -3,35 +3,21 @@
## **概述**
**所属模块:**
AudioAdapter音频适配器接口。
[Audio](_audio.md)
## **汇总**
提供音频适配器（声卡）对外支持的驱动能力，包括初始化端口、创建render、创建capture、获取端口能力集等。
**Since:**
### Public 属性
| Public 属性 | 描述 |
| -------- | -------- |
| ( [InitAllPorts](#initallports) )(struct AudioAdapter \*adapter) | 初始化一个音频适配器所有的端口驱动 [更多...](#initallports) |
| ( [CreateRender](#createrender) )(struct AudioAdapter \*adapter, const struct [AudioDeviceDescriptor](_audio_device_descriptor.md) \*desc, const struct [AudioSampleAttributes](_audio_sample_attributes.md) \*attrs, struct [AudioRender](_audio_render.md) \*\*render) | 创建一个音频播放（render）接口的对象 [更多...](#createrender) |
| ( [DestroyRender](#destroyrender) )(struct AudioAdapter \*adapter, struct [AudioRender](_audio_render.md) \*render) | 销毁一个音频播放（render）接口的对象 [更多...](#destroyrender) |
| ( [CreateCapture](#createcapture) )(struct AudioAdapter \*adapter, const struct [AudioDeviceDescriptor](_audio_device_descriptor.md) \*desc, const struct [AudioSampleAttributes](_audio_sample_attributes.md) \*attrs, struct [AudioCapture](_audio_capture.md) \*\*capture) | 创建一个音频录音（capture）接口的对象 [更多...](#createcapture) |
| ( [DestroyCapture](#destroycapture) )(struct AudioAdapter \*adapter, struct [AudioCapture](_audio_capture.md) \*capture) | 销毁一个音频录音（capture）接口的对象 [更多...](#destroycapture) |
| ( [GetPortCapability](#getportcapability) )(struct AudioAdapter \*adapter, struct [AudioPort](_audio_port.md) \*port, struct [AudioPortCapability](_audio_port_capability.md) \*capability) | 获取一个音频适配器的端口驱动的能力集 [更多...](#getportcapability) |
| ( [SetPassthroughMode](#setpassthroughmode) )(struct AudioAdapter \*adapter, struct [AudioPort](_audio_port.md) \*port, enum [AudioPortPassthroughMode](_audio.md#audioportpassthroughmode) mode) | 设置音频端口驱动的数据透传模式 [更多...](#setpassthroughmode) |
| ( [GetPassthroughMode](#getpassthroughmode) )(struct AudioAdapter \*adapter, struct [AudioPort](_audio_port.md) \*port, enum [AudioPortPassthroughMode](_audio.md#audioportpassthroughmode) \*mode) | 获取音频端口驱动的数据透传模式 [更多...](#getpassthroughmode) |
| ( [UpdateAudioRoute](#updateaudioroute) )(struct AudioAdapter \*adapter, const struct [AudioRoute](_audio_route.md) \*route, int32_t \*routeHandle) | 更新一个或多个发送端和接受端之间的路由 [更多...](#updateaudioroute) |
| ( [ReleaseAudioRoute](#releaseaudioroute) )(struct  \*adapter, int32_t routeHandle) | 释放一个音频路由. [更多...](#releaseaudioroute) |
1.0
**Version:**
## **详细描述**
1.0
AudioAdapter音频适配器接口
**相关模块:**
提供音频适配器（声卡）对外支持的驱动能力，包括初始化端口、创建render、创建capture、获取端口能力集等
[Audio](_audio.md)
**参见：**
......@@ -39,13 +25,24 @@ AudioAdapter音频适配器接口
[AudioCapture](_audio_capture.md)
**Since：**
1.0
## **汇总**
**Version：**
1.0
### Public 属性
| 名称 | 描述 |
| -------- | -------- |
| ([InitAllPorts](#initallports))(struct AudioAdapter \*adapter) | 初始化一个音频适配器所有的端口驱动 |
| ([CreateRender](#createrender) )(struct AudioAdapter \*adapter, const struct AudioDeviceDescriptor \*desc, const struct AudioSampleAttributes \*attrs, struct AudioRender \*\*render) | 创建一个音频播放（render）接口的对象 |
| ([DestroyRender](#destroyrender) )(struct AudioAdapter \*adapter, struct AudioRender \*render) | 销毁一个音频播放（render）接口的对象 |
| ([CreateCapture](#createcapture))(struct AudioAdapter \*adapter, const struct AudioDeviceDescriptor \*desc, const struct AudioSampleAttributes \*attrs, struct AudioCapture \*\*capture) | 创建一个音频录音（capture）接口的对象 |
| ([DestroyCapture](#destroycapture))(struct AudioAdapter \*adapter, struct AudioCapture \*capture) | 销毁一个音频录音（capture）接口的对象 |
| ([GetPortCapability](#getportcapability) )(struct AudioAdapter \*adapter, struct AudioPort \*port, struct AudioPortCapability \*capability) | 获取一个音频适配器的端口驱动的能力集 |
| ([SetPassthroughMode](#setpassthroughmode) )(struct AudioAdapter \*adapter, struct AudioPort \*port, enum AudioPortPassthroughMode mode) | 设置音频端口驱动的数据透传模式 |
| ([GetPassthroughMode](#getpassthroughmode))(struct AudioAdapter \*adapter, struct AudioPort \*port, enum AudioPortPassthroughMode \*mode) | 获取音频端口驱动的数据透传模式 |
| ([UpdateAudioRoute](#updateaudioroute))(struct AudioAdapter \*adapter, const struct AudioRoute \*route, int32_t \*routeHandle) | 更新一个或多个发送端和接受端之间的路由 |
| ([ReleaseAudioRoute](#releaseaudioroute))(struct AudioAdapter \*adapter, int32_t routeHandle) | 释放一个音频路由. |
## **类成员变量说明**
......@@ -62,7 +59,7 @@ int32_t(* AudioAdapter::CreateCapture) (struct AudioAdapter *adapter, const stru
创建一个音频录音（capture）接口的对象
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
......@@ -71,11 +68,11 @@ int32_t(* AudioAdapter::CreateCapture) (struct AudioAdapter *adapter, const stru
| attrs | 指向要打开的音频采样属性的指针 |
| capture | 指向AudioCapture对象的二级指针 |
**返回：**
**返回:**
成功返回值0，失败返回负值
**参见：**
**参见:**
[GetPortCapability](#getportcapability)
......@@ -93,7 +90,7 @@ int32_t(* AudioAdapter::CreateRender) (struct AudioAdapter *adapter, const struc
创建一个音频播放（render）接口的对象
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
......@@ -102,11 +99,11 @@ int32_t(* AudioAdapter::CreateRender) (struct AudioAdapter *adapter, const struc
| attrs | 待打开的音频采样属性 |
| render | 获取的音频播放接口的对象实例保存到render中 |
**返回：**
**返回:**
成功返回值0，失败返回负值
**参见：**
**参见:**
[GetPortCapability](#getportcapability)
......@@ -124,7 +121,7 @@ int32_t(* AudioAdapter::DestroyCapture) (struct AudioAdapter *adapter, struct Au
销毁一个音频录音（capture）接口的对象
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
......@@ -135,11 +132,11 @@ int32_t(* AudioAdapter::DestroyCapture) (struct AudioAdapter *adapter, struct Au
在音频录音过程中，不能销毁该接口对象
**返回：**
**返回:**
成功返回值0，失败返回负值
**参见：**
**参见:**
[CreateCapture](#createcapture)
......@@ -155,7 +152,7 @@ int32_t(* AudioAdapter::DestroyRender) (struct AudioAdapter *adapter, struct Aud
销毁一个音频播放（render）接口的对象
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
......@@ -166,11 +163,11 @@ int32_t(* AudioAdapter::DestroyRender) (struct AudioAdapter *adapter, struct Aud
在音频播放过程中，不能销毁该接口对象
**返回：**
**返回:**
成功返回值0，失败返回负值
**参见：**
**参见:**
[CreateRender](#createrender)
......@@ -186,7 +183,7 @@ int(* AudioAdapter::GetPassthroughMode) (struct AudioAdapter *adapter, struct Au
获取音频端口驱动的数据透传模式
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
......@@ -194,11 +191,11 @@ int(* AudioAdapter::GetPassthroughMode) (struct AudioAdapter *adapter, struct Au
| port | 待获取的端口 |
| mode | 获取的传输模式保存到mode中 |
**返回：**
**返回:**
成功返回值0，失败返回负值
**参见：**
**参见:**
[SetPassthroughMode](#setpassthroughmode)
......@@ -214,7 +211,7 @@ int(* AudioAdapter::GetPortCapability) (struct AudioAdapter *adapter, struct Aud
获取一个音频适配器的端口驱动的能力集
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
......@@ -222,7 +219,7 @@ int(* AudioAdapter::GetPortCapability) (struct AudioAdapter *adapter, struct Aud
| port | 待获取的端口 |
| capability | 获取的端口能力保存到capability中 |
**返回：**
**返回:**
成功返回值0，失败返回负值
......@@ -236,17 +233,21 @@ int(* AudioAdapter::InitAllPorts) (struct AudioAdapter *adapter)
**描述：**
初始化一个音频适配器所有的端口驱动
初始化一个音频适配器所有的端口驱动。
在音频服务中，调用其他驱动接口前需要首先调用该接口检查端口是否已经初始化完成，如果端口驱动初始化完成，则函数返回值0， 否则返回负值，如果端口没有初始化完成，则需要等待一段时间（例如100ms）后重新进行检查，直到端口初始化完成后再继续操作
在音频服务中，调用其他驱动接口前需要首先调用该接口检查端口是否已经初始化完成：
**参数：**
- 如果端口驱动初始化完成，则函数返回值0， 否则返回负值。
- 如果端口没有初始化完成，则需要等待一段时间（例如100ms）后重新进行检查，直到端口初始化完成后再继续操作。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| adapter | 待操作的音频适配器对象 |
**返回：**
**返回:**
成功返回值0，失败返回负值
......@@ -262,14 +263,14 @@ int32_t(* AudioAdapter::ReleaseAudioRoute) (struct AudioAdapter *adapter, int32_
释放一个音频路由.
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| adapter | 待操作的音频适配器对象 |
| routeHandle | 待释放的路由句柄. |
**返回：**
**返回:**
成功返回值0，失败返回负值
......@@ -285,7 +286,7 @@ int(* AudioAdapter::SetPassthroughMode) (struct AudioAdapter *adapter, struct Au
设置音频端口驱动的数据透传模式
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
......@@ -293,11 +294,11 @@ int(* AudioAdapter::SetPassthroughMode) (struct AudioAdapter *adapter, struct Au
| port | 待设置的端口 |
| mode | 待设置的传输模式 |
**返回：**
**返回:**
成功返回值0，失败返回负值
**参见：**
**参见:**
[GetPassthroughMode](#getpassthroughmode)
......@@ -313,7 +314,7 @@ int32_t(* AudioAdapter::UpdateAudioRoute) (struct AudioAdapter *adapter, const s
更新一个或多个发送端和接受端之间的路由
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
......@@ -321,6 +322,6 @@ int32_t(* AudioAdapter::UpdateAudioRoute) (struct AudioAdapter *adapter, const s
| route | 路由信息 |
| routeHandle | 生成的路由句柄 |
**返回：**
**返回:**
成功返回值0，失败返回负值
zh-cn/device-dev/reference/hdi-apis/_audio_adapter_descriptor.md
浏览文件 @ 015279a7
......@@ -3,7 +3,11 @@
## **概述**
**所属模块:**
音频适配器描述符。
一个音频适配器（adapter）是一个声卡的端口驱动集合，包含输出端口、输入端口， 其中一个端口对应着多个PIN脚，一个PIN脚对应着一个实体的器件（例如喇叭、有线耳机）。
**相关模块:**
[Audio](_audio.md)
......@@ -13,13 +17,8 @@
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [adapterName](_audio.md#adaptername) | 音频适配器的名称。 |
| [portNum](_audio.md#portnum) | 一个音频适配器支持的端口数目。 |
| [ports](_audio.md#ports) | 一个音频适配器支持的端口列表。 |
## **详细描述**
音频适配器描述符。
| [adapterName](_audio.md#adaptername) | 音频适配器的名称 |
| [portNum](_audio.md#portnum) | 一个音频适配器支持的端口数目 |
| [ports](_audio.md#ports) | 一个音频适配器支持的端口列表 |
zh-cn/device-dev/reference/hdi-apis/_audio_attribute.md
浏览文件 @ 015279a7
......@@ -3,333 +3,330 @@
## **概述**
**所属模块:**
[Audio](_audio.md)
AudioAttribute音频属性接口。
提供音频播放（render）或录音（capture）需要的公共属性驱动能力，包括获取帧（frame）信息、设置采样属性等。
## **汇总**
**Since:**
1.0
### Public 属性
| Public 属性 | 描述 |
| -------- | -------- |
| ( [GetFrameSize](#getframesize) )([AudioHandle](_audio.md#ga18675ddb073465fdeac33a897f675d79) handle, uint64_t \*size) | 获取音频帧（frame）的大小 [更多...](#getframesize) |
| ( [GetFrameCount](#getframecount) )([AudioHandle](_audio.md#ga18675ddb073465fdeac33a897f675d79) handle, uint64_t \*count) | 获取音频buffer中的音频帧数 [更多...](#getframecount) |
| ( [SetSampleAttributes](#setsampleattributes) )([AudioHandle](_audio.md#ga18675ddb073465fdeac33a897f675d79) handle, const struct [AudioSampleAttributes](_audio_sample_attributes.md) \*attrs) | 设置音频采样的属性参数 [更多...](#setsampleattributes) |
| ( [GetSampleAttributes](#getsampleattributes) )([AudioHandle](_audio.md#ga18675ddb073465fdeac33a897f675d79) handle, struct [AudioSampleAttributes](_audio_sample_attributes.md) \*attrs) | 获取音频采样的属性参数 [更多...](#getsampleattributes) |
| ( [GetCurrentChannelId](#getcurrentchannelid) )([AudioHandle](_audio.md#ga18675ddb073465fdeac33a897f675d79) handle, uint32_t \*channelId) | 获取音频的数据通道ID [更多...](#getcurrentchannelid) |
| ( [SetExtraParams](#setextraparams) )([AudioHandle](_audio.md#ga18675ddb073465fdeac33a897f675d79) handle, const char \*keyValueList) | 设置音频拓展参数 [更多...](#setextraparams) |
| ( [GetExtraParams](#getextraparams) )([AudioHandle](_audio.md#ga18675ddb073465fdeac33a897f675d79) handle, char \*keyValueList) | 获取音频拓展参数 [更多...](#getextraparams) |
| ( [ReqMmapBuffer](#reqmmapbuffer) )([AudioHandle](_audio.md#ga18675ddb073465fdeac33a897f675d79) handle, int32_t reqSize, struct [AudioMmapBufferDescripter](_audio_mmap_buffer_descripter.md) \*desc) | 请求mmap缓冲区 [更多...](#reqmmapbuffer) |
| ( [GetMmapPosition](#getmmapposition) )([AudioHandle](_audio.md#ga18675ddb073465fdeac33a897f675d79) handle, uint64_t \*frames, struct [AudioTimeStamp](_audio_time_stamp.md) \*time) | 获取当前mmap的读/写位置 [更多...](#getmmapposition) |
| ( [AddAudioEffect](#addaudioeffect) )([AudioHandle](_audio.md#ga18675ddb073465fdeac33a897f675d79) handle, uint64_t \*effectid) |添加音频效果算法实例 [更多...](#addaudioeffect) |
| ( [RemoveAudioEffect](#removeaudioeffect) )([AudioHandle](_audio.md#ga18675ddb073465fdeac33a897f675d79) handle, uint64_t effectid) |移除音频效果算法实例 [更多...](#removeaudioeffect) |
| ( [GetFrameBufferSize](#getframebuffersize) )([AudioHandle](_audio.md#ga18675ddb073465fdeac33a897f675d79) handle, uint64_t \*effectid) |获取播放或录音的缓冲区大小 [更多...](#getframebuffersize) |
**Version:**
1.0
## **详细描述**
**相关模块:**
AudioAttribute音频属性接口
[Audio](_audio.md)
提供音频播放（render）或录音（capture）需要的公共属性驱动能力，包括获取帧（frame）信息、设置采样属性等。
**Since：**
## **汇总**
1.0
**Version：**
### Public 属性
1.0
| 名称 | 描述 |
| -------- | -------- |
| ([GetFrameSize](#getframesize))(AudioHandle handle, uint64_t \*size) | 获取音频帧（frame）的大小 |
| ([GetFrameCount](#getframecount))(AudioHandle handle, uint64_t \*count) | 获取音频buffer中的音频帧数 |
| ([SetSampleAttributes](#setsampleattributes))(AudioHandle handle, const struct AudioSampleAttributes \*attrs) | 设置音频采样的属性参数 |
| ([GetSampleAttributes](#getsampleattributes))(AudioHandle handle, struct AudioSampleAttributes \*attrs) | 获取音频采样的属性参数 |
| ([GetCurrentChannelId](#getcurrentchannelid))(AudioHandle handle, uint32_t \*channelId) | 获取音频的数据通道ID |
| ([SetExtraParams](#setextraparams))(AudioHandle handle, const char \*keyValueList) | 设置音频拓展参数 |
| ([GetExtraParams](#getextraparams))(AudioHandle handle, char \*keyValueList) | 获取音频拓展参数 |
| ([ReqMmapBuffer](#reqmmapbuffer))(AudioHandle handle, int32_t reqSize, struct AudioMmapBufferDescripter \*desc) | 请求mmap缓冲区 |
| ([GetMmapPosition](#getmmapposition))(AudioHandle handle, uint64_t \*frames, struct AudioTimeStamp \*time) | 获取当前mmap的读/写位置 |
| ([AddAudioEffect](#addaudioeffect))(AudioHandle handle, uint64_t effectid) | 添加音频效果算法实例 |
| ([RemoveAudioEffect](#removeaudioeffect))(AudioHandle handle, uint64_t effectid) | 移除音频效果算法实例 |
| ([GetFrameBufferSize](#getframebuffersize))(AudioHandle handle, uint64_t \*bufferSize) | 获取播放或录音的缓冲区大小 |
## **类成员变量说明**
### GetCurrentChannelId
### AddAudioEffect
```
int32_t(* AudioAttribute::GetCurrentChannelId) (AudioHandle handle, uint32_t *channelId)
int32_t (*AudioAttribute::AddAudioEffect)(AudioHandle handle, uint64_t effectid)
```
**描述：**
获取音频的数据通道ID
添加音频效果算法实例
**参数：**
**参数:**
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| handle | 待操作的音频句柄 |
| channelId | 获取的通道ID保存到channelId中 |
**返回：**
| handle | 输入参数，待操作的音频句柄。 |
| effectid | 输入参数，待添加的音频效果算法实例ID。 |
成功返回值0，失败返回负值。
**返回:**
成功返回值0，失败返回负值
### GetExtraParams
### GetCurrentChannelId
```
int32_t(* AudioAttribute::GetExtraParams) (AudioHandle handle, char *keyValueList)
int32_t(* AudioAttribute::GetCurrentChannelId) (AudioHandle handle, uint32_t *channelId)
```
**描述：**
获取音频拓展参数。
获取音频的数据通道ID
**参数：**
**参数:**
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| handle | 待操作的音频句柄 |
| keyValueList | 拓展参数键值对字符串列表，格式为key=value，多个键值对通过分号分割 |
| handle | 待操作的音频句柄 |
| channelId | 获取的通道ID保存到channelId中 |
**返回：**
**返回:**
成功返回值0，失败返回负值。
成功返回值0，失败返回负值
### GetFrameCount
### GetExtraParams
```
int32_t(* AudioAttribute::GetFrameCount) (AudioHandle handle, uint64_t *count)
int32_t(* AudioAttribute::GetExtraParams) (AudioHandle handle, char *keyValueList)
```
**描述：**
获取音频buffer中的音频帧数。
获取音频拓展参数
**参数：**
**参数:**
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| handle | 待操作的音频句柄 |
| count | 一个音频buffer中包含的音频帧数，获取后保存到count中 |
**返回：**
| handle | 待操作的音频句柄 |
| keyValueList | 拓展参数键值对字符串列表，格式为key=value，多个键值对通过分号分割 |
成功返回值0，失败返回负值。
**返回:**
成功返回值0，失败返回负值
### GetFrameSize
### GetFrameBufferSize
```
int32_t(* AudioAttribute::GetFrameSize) (AudioHandle handle, uint64_t *size)
int32_t (*AudioAttribute::GetFrameBufferSize)(AudioHandle handle, uint64_t *bufferSize)
```
**描述：**
获取音频帧（frame）的大小
获取一帧音频数据的长度（字节数）
获取播放或录音的缓冲区大小
**参数：**
**参数:**
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| handle | 待操作的音频句柄 |
| size | 获取的音频帧大小（字节数）保存到size中 |
| handle | 输入参数，待操作的音频句柄。 |
| bufferSize | 输出参数，获取的缓冲区大小保存到bufferSize中。 |
**返回：**
**返回:**
成功返回值0，失败返回负值。
### GetMmapPosition
### GetFrameCount
```
int32_t(* AudioAttribute::GetMmapPosition) (AudioHandle handle, uint64_t *frames, struct AudioTimeStamp *time)
int32_t(* AudioAttribute::GetFrameCount) (AudioHandle handle, uint64_t *count)
```
**描述：**
获取当前mmap的读/写位置
获取音频buffer中的音频帧数
**参数：**
**参数:**
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| handle | 待操作的音频句柄 |
| frames | 获取的音频帧计数保存到frames中 |
| time | 获取的关联时间戳保存到time中 |
**返回：**
| handle | 待操作的音频句柄 |
| count | 一个音频buffer中包含的音频帧数，获取后保存到count中 |
成功返回值0，失败返回负值。
**返回:**
成功返回值0，失败返回负值
### GetSampleAttributes
### GetFrameSize
```
int32_t(* AudioAttribute::GetSampleAttributes) (AudioHandle handle, struct AudioSampleAttributes *attrs)
int32_t(* AudioAttribute::GetFrameSize) (AudioHandle handle, uint64_t *size)
```
**描述：**
获取音频采样的属性参数。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| handle | 待操作的音频句柄 |
| attrs | 获取的音频采样属性（例如采样频率、采样精度、通道）保存到attrs中 |
获取音频帧（frame）的大小
**返回：**
获取一帧音频数据的长度（字节数）
成功返回值0，失败返回负值。
**参数:**
**参见：**
| 名称 | 描述 |
| -------- | -------- |
| handle | 待操作的音频句柄 |
| size | 获取的音频帧大小（字节数）保存到size中 |
[SetSampleAttributes](#setsampleattributes)
**返回:**
成功返回值0，失败返回负值
### ReqMmapBuffer
### GetMmapPosition
```
int32_t(* AudioAttribute::ReqMmapBuffer) (AudioHandle handle, int32_t reqSize, struct AudioMmapBufferDescripter *desc)
int32_t(* AudioAttribute::GetMmapPosition) (AudioHandle handle, uint64_t *frames, struct AudioTimeStamp *time)
```
**描述：**
请求mmap缓冲区
获取当前mmap的读/写位置
**参数：**
**参数:**
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| handle | 待操作的音频句柄 |
| reqSize | 请求缓冲区的大小 |
| desc | 缓冲区描述符 |
**返回：**
| handle | 待操作的音频句柄 |
| frames | 获取的音频帧计数保存到frames中 |
| time | 获取的关联时间戳保存到time中 |
成功返回值0，失败返回负值。
**返回:**
成功返回值0，失败返回负值
### SetExtraParams
### GetSampleAttributes
```
int32_t(* AudioAttribute::SetExtraParams) (AudioHandle handle, const char *keyValueList)
int32_t(* AudioAttribute::GetSampleAttributes) (AudioHandle handle, struct AudioSampleAttributes *attrs)
```
**描述：**
设置音频拓展参数。
获取音频采样的属性参数
**参数：**
**参数:**
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| handle | 待操作的音频句柄 |
| keyValueList | 拓展参数键值对字符串列表，格式为key=value，多个键值对通过分号分割 |
| handle | 待操作的音频句柄 |
| attrs | 获取的音频采样属性（例如采样频率、采样精度、通道）保存到attrs中 |
**返回：**
**返回:**
成功返回值0，失败返回负值。
**参见:**
### SetSampleAttributes
[GetSampleAttributes](#getsampleattributes)
### RemoveAudioEffect
```
int32_t(* AudioAttribute::SetSampleAttributes) (AudioHandle handle, const struct AudioSampleAttributes *attrs)
int32_t (*AudioAttribute::RemoveAudioEffect)(AudioHandle handle, uint64_t effectid)
```
**描述：**
设置音频采样的属性参数。
移除音频效果算法实例
**参数：**
**参数:**
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| handle | 待操作的音频句柄 |
| attrs | 待设置的音频采样属性，例如采样频率、采样精度、通道 |
| handle | 输入参数，待操作的音频句柄。 |
| effectid | 输入参数，待移除的音频效果算法实例ID。 |
**返回：**
**返回:**
成功返回值0，失败返回负值。
**参见：**
[GetSampleAttributes](#getsampleattributes)
### AddAudioEffect
### ReqMmapBuffer
```
int32_t (* AudioAttribute::AddAudioEffect)(AudioHandle handle, uint64_t effectid)
int32_t(* AudioAttribute::ReqMmapBuffer) (AudioHandle handle, int32_t reqSize, struct AudioMmapBufferDescripter *desc)
```
**描述：**
添加音频效果算法实例。
请求mmap缓冲区
**参数：**
**参数:**
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| handle | 待操作的音频句柄 |
| effectid | 待添加的音频效果算法实例ID |
| handle | 待操作的音频句柄 |
| reqSize | 请求缓冲区的大小 |
| desc | 缓冲区描述符 |
**返回：**
**返回:**
成功返回值0，失败返回负值。
成功返回值0，失败返回负值
### RemoveAudioEffect
### SetExtraParams
```
int32_t (* AudioAttribute::RemoveAudioEffect)(AudioHandle handle, uint64_t effectid)
int32_t(* AudioAttribute::SetExtraParams) (AudioHandle handle, const char *keyValueList)
```
**描述：**
移除音频效果算法实例。
设置音频拓展参数
**参数：**
**参数:**
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| handle | 待操作的音频句柄 |
| effectid | 待移除的音频效果算法实例ID |
| handle | 待操作的音频句柄 |
| keyValueList | 拓展参数键值对字符串列表，格式为key=value，多个键值对通过分号分割 |
**返回：**
成功返回值0，失败返回负值。
**返回:**
成功返回值0，失败返回负值
### GetFrameBufferSize
### SetSampleAttributes
```
int32_t (* AudioAttribute::GetFrameBufferSize)(AudioHandle handle, uint64_t *bufferSize)
int32_t(* AudioAttribute::SetSampleAttributes) (AudioHandle handle, const struct AudioSampleAttributes *attrs)
```
**描述：**
获取播放或录音的缓冲区大小。
设置音频采样的属性参数
**参数：**
**参数:**
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| handle | 待操作的音频句柄 |
| bufferSize | 获取的缓冲区大小保存到bufferSize中 |
| handle | 待操作的音频句柄 |
| attrs | 待设置的音频采样属性，例如采样频率、采样精度、通道 |
**返回：**
**返回:**
成功返回值0，失败返回负值。
成功返回值0，失败返回负值
**参见:**
[GetSampleAttributes](#getsampleattributes)
zh-cn/device-dev/reference/hdi-apis/_audio_capture.md
浏览文件 @ 015279a7
......@@ -3,7 +3,9 @@
## **概述**
**所属模块:**
AudioCapture录音接口。
**相关模块:**
[Audio](_audio.md)
......@@ -13,19 +15,14 @@
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| control | 音频控制能力接口，详情参考[AudioControl](_audio_control.md) |
| attr | 音频属性能力接口，详情参考[AudioAttribute](_audio_attribute.md) |
| scene | 音频场景能力接口，详情参考[AudioScene](_audio_scene.md) |
| volume | 音频音量能力接口，详情参考[AudioVolume](_audio_volume.md) |
| ( [CaptureFrame](#captureframe) )(struct AudioCapture \*capture, void \*frame, uint64_t requestBytes, uint64_t \*replyBytes) | 从音频驱动中录制（capture）一帧输入数据（录音，音频上行数据） [更多...](#captureframe) |
| ( [GetCapturePosition](#getcaptureposition) )(struct AudioCapture \*capture, uint64_t \*frames, struct [AudioTimeStamp](_audio_time_stamp.md) \*time) | 获取音频输入帧数的上一次计数 [更多...](#getcaptureposition) |
## **详细描述**
AudioCapture音频录音接口。
| control | 音频控制能力接口，详情参考[AudioControl](_audio_control.md)。 |
| attr | 音频属性能力接口，详情参考[AudioAttribute](_audio_attribute.md)。 |
| scene | 音频场景能力接口，详情参考[AudioScene](_audio_scene.md)。 |
| volume | 音频音量能力接口，详情参考[AudioVolume](_audio_volume.md)。 |
| ([CaptureFrame](#captureframe))(struct AudioCapture \*capture, void \*frame, uint64_t requestBytes, uint64_t \*replyBytes) | 从音频驱动中录制（capture）一帧输入数据（录音，音频上行数据）。 |
| ([GetCapturePosition](#getcaptureposition))(struct AudioCapture \*capture, uint64_t \*frames, struct AudioTimeStamp \*time) | 获取音频输入帧数的上一次计数。 |
## **类成员变量说明**
......@@ -42,7 +39,7 @@ int32_t(* AudioCapture::CaptureFrame) (struct AudioCapture *capture, void *frame
从音频驱动中录制（capture）一帧输入数据（录音，音频上行数据）
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
......@@ -51,7 +48,7 @@ int32_t(* AudioCapture::CaptureFrame) (struct AudioCapture *capture, void *frame
| requestBytes | 待存放输入数据的音频frame大小（字节数） |
| replyBytes | 实际读取到的音频数据长度（字节数），获取后保存到replyBytes中 |
**返回：**
**返回:**
成功返回值0，失败返回负值
......@@ -67,7 +64,7 @@ int32_t(* AudioCapture::GetCapturePosition) (struct AudioCapture *capture, uint6
获取音频输入帧数的上一次计数
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
......@@ -75,10 +72,10 @@ int32_t(* AudioCapture::GetCapturePosition) (struct AudioCapture *capture, uint6
| frames | 获取的音频帧计数保存到frames中 |
| time | 获取的关联时间戳保存到time中 |
**返回：**
**返回:**
成功返回值0，失败返回负值
**参见：**
**参见:**
[CaptureFrame](#captureframe)
zh-cn/device-dev/reference/hdi-apis/_audio_control.md
浏览文件 @ 015279a7
......@@ -3,40 +3,37 @@
## **概述**
**所属模块:**
AudioControl音频控制接口
[Audio](_audio.md)
## **汇总**
提供音频播放（render）或录音（capture）需要的公共控制驱动能力，包括Start、Stop、Pause、Resume、Flush等。
**Since:**
### Public 属性
1.0
| Public 属性 | 描述 |
| -------- | -------- |
| ( [Start](#start) )([AudioHandle](_audio.md#ga18675ddb073465fdeac33a897f675d79) handle) | 启动一个音频播放（render）或录音（capture）处理 [更多...](#start) |
| ( [Stop](#stop) )([AudioHandle](_audio.md#ga18675ddb073465fdeac33a897f675d79) handle) | 停止一个音频播放（render）或录音（capture）处理 [更多...](#stop) |
| ( [Pause](#pause) )([AudioHandle](_audio.md#ga18675ddb073465fdeac33a897f675d79) handle) | 暂停一个音频播放（render）或录音（capture）处理 [更多...](#pause) |
| ( [Resume](#resume) )([AudioHandle](_audio.md#ga18675ddb073465fdeac33a897f675d79) handle) | 恢复一个音频播放（render）或录音（capture）处理 [更多...](#resume) |
| ( [Flush](#flush) )([AudioHandle](_audio.md#ga18675ddb073465fdeac33a897f675d79) handle) | 刷新音频缓冲区buffer中的数据 [更多...](#flush) |
| ( [TurnStandbyMode](#turnstandbymode) )([AudioHandle](_audio.md#ga18675ddb073465fdeac33a897f675d79) handle) | 设置或去设置设备的待机模式 [更多...](#turnstandbymode) |
| ( [AudioDevDump](#audiodevdump) )([AudioHandle](_audio.md#ga18675ddb073465fdeac33a897f675d79) handle, int32_t range, int32_t fd) | Dump音频设备信息 [更多...](#audiodevdump) |
**Version:**
1.0
## **详细描述**
**相关模块:**
AudioControl音频控制接口。
[Audio](_audio.md)
提供音频播放（render）或录音（capture）需要的公共控制驱动能力，包括Start、Stop、Pause、Resume、Flush等。
**Since：**
## **汇总**
1.0
**Version：**
### Public 属性
1.0
| 名称 | 描述 |
| -------- | -------- |
| ([Start](#start))(AudioHandle handle) | 启动一个音频播放（render）或录音（capture）处理 |
| ([Stop](#stop))(AudioHandle handle) | 停止一个音频播放（render）或录音（capture）处理 |
| ([Pause](#pause))(AudioHandle handle) | 暂停一个音频播放（render）或录音（capture）处理 |
| ([Resume](#resume))(AudioHandle handle) | 恢复一个音频播放（render）或录音（capture）处理 |
| ([Flush](#flush))(AudioHandle handle) | 刷新音频缓冲区buffer中的数据 |
| ([TurnStandbyMode](#turnstandbymode))(AudioHandle handle) | 设置或去设置设备的待机模式 |
| ([AudioDevDump](#audiodevdump))(AudioHandle handle, int32_t range, int32_t fd) | Dump音频设备信息 |
## **类成员变量说明**
......@@ -53,7 +50,7 @@ int32_t(* AudioControl::AudioDevDump) (AudioHandle handle, int32_t range, int32_
Dump音频设备信息
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
......@@ -61,7 +58,7 @@ Dump音频设备信息
| range | Dump信息范围，分为简要信息、全量信息 |
| fd | 指定Dump目标文件 |
**返回：**
**返回:**
成功返回值0，失败返回负值
......@@ -77,13 +74,13 @@ int32_t(* AudioControl::Flush) (AudioHandle handle)
刷新音频缓冲区buffer中的数据
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 待操作的音频句柄 |
**返回：**
**返回:**
成功返回值0，失败返回负值
......@@ -99,17 +96,17 @@ int32_t(* AudioControl::Pause) (AudioHandle handle)
暂停一个音频播放（render）或录音（capture）处理
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 待操作的音频句柄 |
**返回：**
**返回:**
成功返回值0，失败返回负值
**参见：**
**参见:**
[Resume](#resume)
......@@ -125,17 +122,17 @@ int32_t(* AudioControl::Resume) (AudioHandle handle)
恢复一个音频播放（render）或录音（capture）处理
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 待操作的音频句柄 |
**返回：**
**返回:**
成功返回值0，失败返回负值
**参见：**
**参见:**
[Pause](#pause)
......@@ -151,17 +148,17 @@ int32_t(* AudioControl::Start) (AudioHandle handle)
启动一个音频播放（render）或录音（capture）处理
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 待操作的音频句柄 |
**返回：**
**返回:**
成功返回值0，失败返回负值
**参见：**
**参见:**
[Stop](#stop)
......@@ -177,17 +174,17 @@ int32_t(* AudioControl::Stop) (AudioHandle handle)
停止一个音频播放（render）或录音（capture）处理
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 待操作的音频句柄 |
**返回：**
**返回:**
成功返回值0，失败返回负值
**参见：**
**参见:**
[Start](#start)
......@@ -203,12 +200,12 @@ int32_t(* AudioControl::TurnStandbyMode) (AudioHandle handle)
设置或去设置设备的待机模式
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 待操作的音频句柄 |
**返回：**
**返回:**
设置设备待机模式成功返回值0，再次执行后去设置待机模式成功返回正值，失败返回负值
设置设备待机模式成功返回值0，再次执行后去设置待机模式成功返回正值，失败返回负值。
zh-cn/device-dev/reference/hdi-apis/_audio_dev_ext_info.md
浏览文件 @ 015279a7
......@@ -3,7 +3,9 @@
## **概述**
**所属模块:**
音频设备拓展信息。
**相关模块:**
[Audio](_audio.md)
......@@ -13,13 +15,8 @@
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [moduleId](_audio.md#moduleid-12) | 音频流绑定的模块ID。 |
| [type](_audio.md#type-23) | 音频端口上的PIN脚（输出、输入），详情参考[AudioPortPin](_audio.md#audioportpin)。 |
| [desc](_audio.md#desc-55) | 地址描述。 |
## **详细描述**
音频设备拓展信息。
| [moduleId](_audio.md#moduleid-12) | 音频流绑定的模块ID |
| [type](_audio.md#type-23) | 音频端口上的PIN脚（输出、输入） |
| [desc](_audio.md#desc-55) | 地址描述 |
zh-cn/device-dev/reference/hdi-apis/_audio_device_descriptor.md
浏览文件 @ 015279a7
......@@ -3,7 +3,9 @@
## **概述**
**所属模块:**
音频设备描述符
**相关模块:**
[Audio](_audio.md)
......@@ -13,13 +15,8 @@
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [portId](_audio.md#portid-24) | 频端口ID。 |
| [pins](_audio.md#pins) | 音频端口上的PIN脚（输出、输入），详情参考[AudioPortPin](_audio.md#audioportpin)。 |
| [desc](_audio.md#desc-15) | 以字符串命名的音频设备。 |
## **详细描述**
音频场景描述符。
| [portId](_audio.md#portid-24) | 音频端口ID |
| [pins](_audio.md#pins) | 音频端口上的PIN脚（输出、输入） |
| [desc](_audio.md#desc-15) | 以字符串命名的音频设备 |
zh-cn/device-dev/reference/hdi-apis/_audio_manager.md
浏览文件 @ 015279a7
......@@ -3,41 +3,38 @@
## **概述**
**所属模块:**
[Audio](_audio.md)
## **汇总**
AudioManager音频适配器管理接口。
按照音频服务下发的音频适配器（声卡）描述符加载一个具体的音频适配器驱动程序。
### Public 属性
**Since:**
| Public 属性 | 描述 |
| -------- | -------- |
| ( [GetAllAdapters](#getalladapters) )(struct AudioAdapterManager \*manager, struct [AudioAdapterDescriptor](_audio_adapter_descriptor.md) \*\*descs, int \*size) | 获取音频驱动中支持的所有适配器的列表 [更多...](#getalladapters) |
| ( [LoadAdapter](#loadadapter) )(struct AudioAdapterManager \*manager, const struct [AudioAdapterDescriptor](_audio_adapter_descriptor.md) \*desc, struct [AudioAdapter](_audio_adapter.md) \*\*adapter) | 加载一个音频适配器（声卡）的驱动 [更多...](#loadadapter) |
| ( [UnloadAdapter](#unloadadapter) )(struct AudioAdapterManager \*manager, struct [AudioAdapter](_audio_adapter.md) \*adapter) | 卸载音频适配器（声卡）的驱动 [更多...](#unloadadapter) |
| ( [ReleaseAudioManagerObject](#releaseaudiomanagerobject) )(struct AudioManager \*object) | 释放音频管理接口对象 [更多...](#releaseaudiomanagerobject) |
1.0
**Version:**
## **详细描述**
1.0
AudioManager音频适配器管理接口
**相关模块:**
按照音频服务下发的音频适配器（声卡）描述符加载一个具体的音频适配器驱动程序
[Audio](_audio.md)
参见：
**参见：**
[AudioAdapter](_audio_adapter.md)
**Since：**
1.0
## **汇总**
**Version：**
1.0
### Public 属性
| 名称 | 描述 |
| -------- | -------- |
| ([GetAllAdapters](#getalladapters))(struct AudioAdapterManager \*manager, struct AudioAdapterDescriptor \*\*descs, int \*size) | 获取音频驱动中支持的所有适配器的列表 |
| ([LoadAdapter](#loadadapter))(struct AudioAdapterManager \*manager, const struct AudioAdapterDescriptor \*desc, struct AudioAdapter \*\*adapter) | 加载一个音频适配器（声卡）的驱动 |
| ([UnloadAdapter](#unloadadapter))(struct AudioAdapterManager \*manager, struct AudioAdapter \*adapter) | 卸载音频适配器（声卡）的驱动 |
| ([ReleaseAudioManagerObject](#releaseaudiomanagerobject))(struct AudioManager \*object) | 释放音频管理接口对象 |
## **类成员变量说明**
......@@ -54,7 +51,7 @@ int(* AudioManager::GetAllAdapters) (struct AudioAdapterManager *manager, struct
获取音频驱动中支持的所有适配器的列表
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
......@@ -62,11 +59,11 @@ int(* AudioManager::GetAllAdapters) (struct AudioAdapterManager *manager, struct
| descs | 获取到的音频适配器列表保存到descs中 |
| size | 获取到的音频适配器列表的长度保存到size中 |
**返回：**
**返回:**
成功返回值0，失败返回负值
**参见：**
**参见:**
[LoadAdapter](#loadadapter)
......@@ -82,9 +79,9 @@ int(* AudioManager::LoadAdapter) (struct AudioAdapterManager *manager, const str
加载一个音频适配器（声卡）的驱动
加载一个具体的音频驱动，例如USB驱动，在具体实现中可能加载的是一个动态链接库（\*.so）
加载一个具体的音频驱动，例如usb驱动，在具体实现中可能加载的是一个动态链接库（\*.so）
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
......@@ -92,11 +89,11 @@ int(* AudioManager::LoadAdapter) (struct AudioAdapterManager *manager, const str
| desc | 待加载的音频适配器描述符 |
| adapter | 获取的音频适配器接口的对象实例保存到adapter中 |
**返回：**
**返回:**
成功返回值0，失败返回负值
**参见：**
**参见:**
[GetAllAdapters](#getalladapters)
......@@ -114,13 +111,13 @@ bool(* AudioManager::ReleaseAudioManagerObject) (struct AudioManager *object)
释放音频管理接口对象
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| object | 待操作的音频管理接口对象 |
| 待操作的音频管理接口对象 | |
**返回：**
**返回:**
成功返回true，失败返回false
......@@ -136,13 +133,13 @@ void(* AudioManager::UnloadAdapter) (struct AudioAdapterManager *manager, struct
卸载音频适配器（声卡）的驱动
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| manager | 待操作的音频管理接口对象 |
| adapter | 待卸载的音频适配器接口的对象 |
**参见：**
**参见:**
[LoadAdapter](#loadadapter)
zh-cn/device-dev/reference/hdi-apis/_audio_mix_ext_info.md
浏览文件 @ 015279a7
......@@ -3,7 +3,9 @@
## **概述**
**所属模块:**
音轨拓展信息。
**相关模块:**
[Audio](_audio.md)
......@@ -13,12 +15,7 @@
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [moduleId](_audio.md#moduleid-22) | 流所属模块标识符。 |
| [streamId](_audio.md#streamid-22) | 由调用者传递的Render或Capture标识符。 |
## **详细描述**
音轨拓展信息。
| [moduleId](_audio.md#moduleid-22) | 流所属模块标识符 |
| [streamId](_audio.md#streamid-22) | 由调用者传递的Render或Capture标识符 |
zh-cn/device-dev/reference/hdi-apis/_audio_mmap_buffer_descripter.md
浏览文件 @ 015279a7
......@@ -3,7 +3,9 @@
## **概述**
**所属模块:**
Mmap缓冲区描述符。
**相关模块:**
[Audio](_audio.md)
......@@ -13,15 +15,10 @@
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [memoryAddress](_audio.md#memoryaddress) | 指向mmap缓冲区的指针。 |
| [memoryFd](_audio.md#memoryfd) | mmap缓冲区的文件描述符。 |
| [totalBufferFrames](_audio.md#totalbufferframes) | 缓冲区总大小，单位：帧。 |
| [transferFrameSize](_audio.md#transferframesize) | 传输大小，单位：帧。 |
| [isShareable](_audio.md#isshareable) | mmap缓冲区是否可以在进程间共享。 |
## **详细描述**
mmap缓冲区描述符。
| [memoryAddress](_audio.md#memoryaddress) | 指向mmap缓冲区的指针 |
| [memoryFd](_audio.md#memoryfd) | mmap缓冲区的文件描述符 |
| [totalBufferFrames](_audio.md#totalbufferframes) | 缓冲区总大小，单位：帧 |
| [transferFrameSize](_audio.md#transferframesize) | 传输大小，单位：帧 |
| [isShareable](_audio.md#isshareable) | mmap缓冲区是否可以在进程间共享 |
zh-cn/device-dev/reference/hdi-apis/_audio_port.md
浏览文件 @ 015279a7
......@@ -3,7 +3,9 @@
## **概述**
**所属模块:**
音频端口。
**相关模块:**
[Audio](_audio.md)
......@@ -13,13 +15,8 @@
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [dir](_audio.md#dir) | 音频端口的类型，详情参考[AudioPortDirection](_audio.md#audioportdirection)。 |
| [dir](_audio.md#dir) | 音频端口的类型。 |
| [portId](_audio.md#portid-14) | 音频端口的ID。 |
| [portName](_audio.md#portname) | 音频端口的名称。 |
## **详细描述**
音频端口。
zh-cn/device-dev/reference/hdi-apis/_audio_port_capability.md
浏览文件 @ 015279a7
......@@ -3,7 +3,9 @@
## **概述**
**所属模块:**
音频端口的支持能力。
**相关模块:**
[Audio](_audio.md)
......@@ -13,22 +15,17 @@
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [deviceType](_audio.md#devicetype) | 设备输出、输入类型。 |
| [deviceId](_audio.md#deviceid) | 绑定（bind）设备ID，唯一的设备识别符。 |
| [hardwareMode](_audio.md#hardwaremode) | 是否支持设备绑定处理。 |
| [formatNum](_audio.md#formatnum) | 支持的音频格式数目。 |
| [formats](_audio.md#formats) | 支持的音频格式，详情参考[AudioFormat](_audio.md#audioformat)。 |
| [formats](_audio.md#formats) | 支持的音频格式。 |
| [sampleRateMasks](_audio.md#sampleratemasks) | 支持的音频采样频率（8k、16k、32k、48k）。 |
| [channelMasks](_audio.md#channelmasks) | 设备的声道布局掩码（mask），详情参考[AudioChannelMask](_audio.md#audiochannelmask)。 |
| [channelMasks](_audio.md#channelmasks) | 设备的声道布局掩码（mask）。 |
| [channelCount](_audio.md#channelcount-22) | 支持的最大声道总数。 |
| [subPortsNum](_audio.md#subportsnum) | 支持的子端口数目（仅用于输出设备）。 |
| [subPorts](_audio.md#subports) | 支持的子端口列表。 |
| [supportSampleFormatNum](_audio.md#supportsampleformatnum) | 支持的音频样本格式数量。 |
| [supportSampleFormats](_audio.md#supportsampleformats) | 支持的音频样本格式，详请参考[AudioSampleFormat](_audio.md#audiosampleformat)。 |
## **详细描述**
音频端口的支持能力。
| [supportSampleFormats](_audio.md#supportsampleformats) | 支持的音频样本格式。 |
zh-cn/device-dev/reference/hdi-apis/_audio_render.md
浏览文件 @ 015279a7
......@@ -3,38 +3,21 @@
## **概述**
**所属模块:**
AudioRender音频播放接口。
[Audio](_audio.md)
## **汇总**
提供音频播放支持的驱动能力，包括音频控制、音频属性、音频场景、音频音量、获取硬件延迟时间、播放音频帧数据（render frame）等。
**Since：**
### Public 属性
| Public 属性 | 描述 |
| -------- | -------- |
| control | 音频控制能力接口，详情参考[AudioControl](_audio_control.md) |
| attr | 音频属性能力接口，详情参考[AudioAttribute](_audio_attribute.md) |
| scene | 音频场景能力接口，详情参考[AudioScene](_audio_scene.md) |
| volume | 音频音量能力接口，详情参考[AudioVolume](_audio_volume.md) |
| ( [GetLatency](#getlatency) )(struct AudioRender \*render, uint32_t \*ms) | 获取音频硬件驱动估计的延迟时间 [更多...](#getlatency) |
| ( [RenderFrame](#renderframe) )(struct AudioRender \*render, const void \*frame, uint64_t requestBytes, uint64_t \*replyBytes) | 往音频驱动中播放（render）一帧输出数据（放音，音频下行数据） [更多...](#renderframe) |
| ( [GetRenderPosition](#getrenderposition) )(struct AudioRender \*render, uint64_t \*frames, struct [AudioTimeStamp](_audio_time_stamp.md) \*time) | 获取音频输出帧数的上一次计数 [更多...](#getrenderposition) |
| ( [SetRenderSpeed](#setrenderspeed) )(struct AudioRender \*render, float speed) | 设置一个音频的播放速度 [更多...](#setrenderspeed) |
| ( [GetRenderSpeed](#getrenderspeed) )(struct AudioRender \*render, float \*speed) | 获取一个音频当前的播放速度 [更多...](#getrenderspeed) |
| ( [SetChannelMode](#setchannelmode) )(struct AudioRender \*render, enum [AudioChannelMode](_audio.md#audiochannelmode) mode) | 设置音频播放的通道模式 [更多...](#setchannelmode) |
| ( [GetChannelMode](#getchannelmode) )(struct AudioRender \*render, enum [AudioChannelMode](_audio.md#audiochannelmode) \*mode) | 获取音频播放当前的通道模式 [更多...](#getchannelmode) |
| ( [RegCallback](#regcallback) )(struct AudioRender \*render, [RenderCallback](_audio.md#rendercallback) callback, void \*cookie) | 注册音频回调函数，用于放音过程中缓冲区数据写、DrainBuffer完成通知 [更多...](#regcallback) |
| ( [DrainBuffer](#drainbuffer) )(struct AudioRender \*render, enum [AudioDrainNotifyType](_audio.md#audiodrainnotifytype) \*type) | 排空缓冲区中的数据 [更多...](#drainbuffer) |
1.0
**Version：**
## **详细描述**
1.0
AudioRender音频播放接口
**相关模块:**
提供音频播放支持的驱动能力，包括音频控制、音频属性、音频场景、音频音量、获取硬件延迟时间、播放音频帧数据（render frame）等
[Audio](_audio.md)
**参见：**
......@@ -46,13 +29,27 @@ AudioRender音频播放接口
[AudioVolume](_audio_volume.md)
**Since：**
1.0
## **汇总**
**Version：**
1.0
### Public 属性
| 名称 | 描述 |
| -------- | -------- |
| control | 音频控制能力接口，详情参考[AudioControl](_audio_control.md)。 |
| attr | 音频属性能力接口，详情参考[AudioAttribute](_audio_attribute.md)。 |
| scene | 音频场景能力接口，详情参考[AudioScene](_audio_scene.md)。 |
| volume | 音频音量能力接口，详情参考[AudioVolume](_audio_volume.md)。 |
| ([GetLatency](#getlatency))(struct AudioRender \*render, uint32_t \*ms) | 获取音频硬件驱动估计的延迟时间。 |
| ([RenderFrame](#renderframe))(struct AudioRender \*render, const void \*frame, uint64_t requestBytes, uint64_t \*replyBytes) | 往音频驱动中播放（render）一帧输出数据（放音，音频下行数据）。 |
| ([GetRenderPosition](#getrenderposition))(struct AudioRender \*render, uint64_t \*frames, struct AudioTimeStamp \*time) | 获取音频输出帧数的上一次计数。 |
| ([SetRenderSpeed](#setrenderspeed))(struct AudioRender \*render, float speed) | 设置一个音频的播放速度。 |
| ([GetRenderSpeed](#getrenderspeed))(struct AudioRender \*render, float \*speed) | 获取一个音频当前的播放速度。 |
| ([SetChannelMode](#setchannelmode))(struct AudioRender \*render, enum AudioChannelMode mode) | 设置音频播放的通道模式。 |
| ([GetChannelMode](#getchannelmode))(struct AudioRender \*render, enum AudioChannelMode \*mode) | 获取音频播放当前的通道模式。 |
| ([RegCallback](#regcallback) )(struct AudioRender \*render, RenderCallback callback, void \*cookie) | 注册音频回调函数，用于放音过程中缓冲区数据写、DrainBuffer完成通知。 |
| ([DrainBuffer](#drainbuffer))(struct AudioRender \*render, enum AudioDrainNotifyType \*type) | 排空缓冲区中的数据。 |
## **类成员变量说明**
......@@ -69,18 +66,18 @@ int32_t(* AudioRender::DrainBuffer) (struct AudioRender *render, enum AudioDrain
排空缓冲区中的数据
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| render | 待操作的音频播放接口对象 |
| type | DrainBuffer的操作类型，详情请参考[AudioDrainNotifyType](_audio.md#audiodrainnotifytype) |
| type | DrainBuffer的操作类型，详情请参考[AudioDrainNotifyType](_audio.md#audiodrainnotifytype)。 |
**返回：**
**返回:**
成功返回值0，失败返回负值
**参见：**
**参见:**
[RegCallback](#regcallback)
......@@ -96,18 +93,18 @@ int32_t(* AudioRender::GetChannelMode) (struct AudioRender *render, enum AudioCh
获取音频播放当前的通道模式
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| render | 待操作的音频播放接口对象 |
| mode | 获取的通道模式保存到mode中 |
**返回：**
**返回:**
成功返回值0，失败返回负值
**参见：**
**参见:**
[SetChannelMode](#setchannelmode)
......@@ -123,14 +120,14 @@ int32_t(* AudioRender::GetLatency) (struct AudioRender *render, uint32_t *ms)
获取音频硬件驱动估计的延迟时间
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| render | 待操作的音频播放接口对象 |
| ms | 获取的延迟时间（单位：毫秒）保存到ms中 |
**返回：**
**返回:**
成功返回值0，失败返回负值
......@@ -146,7 +143,7 @@ int32_t(* AudioRender::GetRenderPosition) (struct AudioRender *render, uint64_t
获取音频输出帧数的上一次计数
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
......@@ -154,11 +151,11 @@ int32_t(* AudioRender::GetRenderPosition) (struct AudioRender *render, uint64_t
| frames | 获取的音频帧计数保存到frames中 |
| time | 获取的关联时间戳保存到time中 |
**返回：**
**返回:**
成功返回值0，失败返回负值
**参见：**
**参见:**
[RenderFrame](#renderframe)
......@@ -174,18 +171,18 @@ int32_t(* AudioRender::GetRenderSpeed) (struct AudioRender *render, float *speed
获取一个音频当前的播放速度
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| render | 待操作的音频播放接口对象 |
| speed | 获取的播放速度保存到speed中 |
**返回：**
**返回:**
成功返回值0，失败返回负值
**参见：**
**参见:**
[SetRenderSpeed](#setrenderspeed)
......@@ -201,7 +198,7 @@ int32_t(* AudioRender::RegCallback) (struct AudioRender *render, RenderCallback
注册音频回调函数，用于放音过程中缓冲区数据写、DrainBuffer完成通知
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
......@@ -209,11 +206,11 @@ int32_t(* AudioRender::RegCallback) (struct AudioRender *render, RenderCallback
| callback | 注册的回调函数 |
| cookie | 回调函数的入参 |
**返回：**
**返回:**
成功返回值0，失败返回负值
**参见：**
**参见:**
[RegCallback](#regcallback)
......@@ -229,7 +226,7 @@ int32_t(* AudioRender::RenderFrame) (struct AudioRender *render, const void *fra
往音频驱动中播放（render）一帧输出数据（放音，音频下行数据）
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
......@@ -238,7 +235,7 @@ int32_t(* AudioRender::RenderFrame) (struct AudioRender *render, const void *fra
| requestBytes | 待写入的输出数据的音频frame大小（字节数） |
| replyBytes | 实际写入的音频数据长度（字节数），获取后保存到replyBytes中 |
**返回：**
**返回:**
成功返回值0，失败返回负值
......@@ -254,18 +251,18 @@ int32_t(* AudioRender::SetChannelMode) (struct AudioRender *render, enum AudioCh
设置音频播放的通道模式
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| render | 待操作的音频播放接口对象 |
| speed | 待设置的通道模式 |
**返回：**
**返回:**
成功返回值0，失败返回负值
**参见：**
**参见:**
[GetChannelMode](#getchannelmode)
......@@ -281,17 +278,17 @@ int32_t(* AudioRender::SetRenderSpeed) (struct AudioRender *render, float speed)
设置一个音频的播放速度
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| render | 待操作的音频播放接口对象 |
| speed | 待设置的播放速度 |
**返回：**
**返回:**
成功返回值0，失败返回负值
**参见：**
**参见:**
[GetRenderSpeed](#getrenderspeed)
zh-cn/device-dev/reference/hdi-apis/_audio_route.md
浏览文件 @ 015279a7
......@@ -3,7 +3,9 @@
## **概述**
**所属模块:**
音频路由信息。
**相关模块:**
[Audio](_audio.md)
......@@ -13,14 +15,9 @@
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [sourcesNum](_audio.md#sourcesnum) | 发送端节点数量。 |
| [sources](_audio.md#sources) | 发送端列表。 |
| [sinksNum](_audio.md#sinksnum) | 接受端节点数量。 |
| [sinks](_audio.md#sinks) | 接受端列表。 |
## **详细描述**
音频路由信息。
zh-cn/device-dev/reference/hdi-apis/_audio_route_node.md
浏览文件 @ 015279a7
# AudioRouteNode
## **述**
## **概述**
**所属模块:**
音频路由节点。
**相关模块:**
[Audio](_audio.md)
......@@ -13,7 +15,7 @@
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [portId](_audio.md#portid-44) | 音频端口ID。 |
| [role](_audio.md#role) | 指定端口角色为sink或source。 |
......@@ -21,8 +23,3 @@
| [device](_audio.md#device) | 设备特定信息。 |
| [mix](_audio.md#mix) | 音轨特定信息。 |
| [session](_audio.md#session) | 会话特定信息。 |
## **详细描述**
音频路由节点。
zh-cn/device-dev/reference/hdi-apis/_audio_sample_attributes.md
浏览文件 @ 015279a7
......@@ -3,7 +3,9 @@
## **概述**
**所属模块:**
音频采样属性。
**相关模块:**
[Audio](_audio.md)
......@@ -13,11 +15,11 @@
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [type](_audio.md#type-13) | 音频类型，详情参考[AudioCategory](_audio.md#audiocategory)。 |
| [type](_audio.md#type-13) | 音频类型。 |
| [interleaved](_audio.md#interleaved) | 音频数据交织的标记。 |
| [format](_audio.md#format) | 音频数据格式，详情参考[AudioFormat](_audio.md#audioformat)。 |
| [format](_audio.md#format) | 音频数据格式。 |
| [sampleRate](_audio.md#samplerate) | 音频采样频率。 |
| [channelCount](_audio.md#channelcount-12) | 音频通道数目，如单通道（mono）为1、立体声（stereo）为2。 |
| [period](_audio.md#period) | 音频采样周期。 |
......@@ -28,8 +30,3 @@
| [stopThreshold](_audio.md#stopthreshold) | 音频渲染停止阈值。 |
| [silenceThreshold](_audio.md#silencethreshold) | 音频捕获缓冲区阈值。 |
| [streamId](_audio.md#streamid-12) | 渲染或捕获的音频标识符。 |
## **详细描述**
音频采样属性。
zh-cn/device-dev/reference/hdi-apis/_audio_scene.md
浏览文件 @ 015279a7
......@@ -3,35 +3,32 @@
## **概述**
**所属模块:**
[Audio](_audio.md)
AudioScene音频场景接口。
## **汇总**
提供音频播放（Render）或录音（Capture）需要的公共场景驱动能力，包括选择音频场景等。
**Since：**
### Public 属性
1.0
| Public 属性 | 描述 |
| -------- | -------- |
| ( [CheckSceneCapability](#checkscenecapability) )([AudioHandle](_audio.md#ga18675ddb073465fdeac33a897f675d79) handle, const struct [AudioSceneDescriptor](_audio_scene_descriptor.md) \*scene, bool \*supported) | 是否支持某个音频场景的配置 [更多...](#checkscenecapability) |
| ( [SelectScene](#selectscene) )([AudioHandle](_audio.md#ga18675ddb073465fdeac33a897f675d79) handle, const struct [AudioSceneDescriptor](_audio_scene_descriptor.md) \*scene) | 选择音频场景 [更多...](#selectscene) |
**Version：**
1.0
## **详细描述**
**相关模块:**
AudioScene音频场景接口。
[Audio](_audio.md)
提供音频播放（render）或录音（capture）需要的公共场景驱动能力，包括选择音频场景等。
**Since：**
## **汇总**
1.0
**Version：**
### Public 属性
1.0
| 名称 | 描述 |
| -------- | -------- |
| ([CheckSceneCapability](#checkscenecapability))(AudioHandle handle, const struct AudioSceneDescriptor \*scene, bool \*supported) | 是否支持某个音频场景的配置 |
| ([SelectScene](#selectscene))(AudioHandle handle, const struct AudioSceneDescriptor \*scene) | 选择音频场景 |
## **类成员变量说明**
......@@ -48,7 +45,7 @@ int32_t(* AudioScene::CheckSceneCapability) (AudioHandle handle, const struct Au
是否支持某个音频场景的配置
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
......@@ -56,11 +53,11 @@ int32_t(* AudioScene::CheckSceneCapability) (AudioHandle handle, const struct Au
| scene | 待获取的音频场景描述符 |
| supported | 是否支持的状态保存到supported中，true表示支持，false表示不支持 |
**返回：**
**返回:**
成功返回值0，失败返回负值
**参见：**
**参见:**
[SelectScene](#selectscene)
......@@ -84,17 +81,17 @@ int32_t(* AudioScene::SelectScene) (AudioHandle handle, const struct AudioSceneD
- 3. 只是选择一个音频输出设备，例如输出设备为听筒（receiver）、喇叭（speaker）、有线耳机（headset）
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 待操作的音频句柄 |
| scene | 待设置的音频场景描述符 |
**返回：**
**返回:**
成功返回值0，失败返回负值
**参见：**
**参见:**
[CheckSceneCapability](#checkscenecapability)
zh-cn/device-dev/reference/hdi-apis/_audio_scene_descriptor.md
浏览文件 @ 015279a7
......@@ -3,28 +3,26 @@
## **概述**
**所属模块:**
音频场景描述符。
**相关模块:**
[Audio](_audio.md)
## **汇总**
### 类
| 类 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [SceneDesc](union_audio_scene_descriptor_1_1_scene_desc.md) | 音频场景描述 [AudioSceneDescriptor::SceneDesc](union_audio_scene_descriptor_1_1_scene_desc.md) |
| [SceneDesc](union_audio_scene_descriptor_1_1_scene_desc.md) | 音频场景描述 |
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [scene](_audio.md#scene) | 音频场景的名称。 |
| [desc](_audio.md#desc-25) | 音频设备描述符。 |
## **详细描述**
音频场景描述符。
zh-cn/device-dev/reference/hdi-apis/_audio_session_ext_info.md
浏览文件 @ 015279a7
......@@ -3,7 +3,9 @@
## **概述**
**所属模块:**
会话拓展信息。
**相关模块:**
[Audio](_audio.md)
......@@ -13,11 +15,6 @@
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [sessionType](_audio.md#sessiontype) | 音频会话类型。 |
## **详细描述**
会话拓展信息。
zh-cn/device-dev/reference/hdi-apis/_audio_sub_port_capability.md
浏览文件 @ 015279a7
......@@ -3,7 +3,9 @@
## **概述**
**所属模块:**
音频子端口的支持能力。
**相关模块:**
[Audio](_audio.md)
......@@ -13,13 +15,8 @@
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [portId](_audio.md#portid-34) | 子端口ID。 |
| [desc](_audio.md#desc-45) | 以字符串命名的子端口。 |
| [mask](_audio.md#mask) | 数据透传模式，详情参考[AudioPortPassthroughMode](_audio.md#audioportpassthroughmode)。 |
## **详细描述**
音频子端口的支持能力。
| [mask](_audio.md#mask) | 数据透传模式。 |
zh-cn/device-dev/reference/hdi-apis/_audio_time_stamp.md
浏览文件 @ 015279a7
......@@ -3,7 +3,11 @@
## **概述**
**所属模块:**
音频时间戳。
时间定义，POSIX timespec的替代品。
**相关模块:**
[Audio](_audio.md)
......@@ -13,14 +17,7 @@
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [tvSec](_audio.md#tvsec) | tvSec时间，单位：秒。 |
| [tvNSec](_audio.md#tvnsec) | tvNSec时间，单位：纳秒。 |
## **详细描述**
音频时间戳。
时间定义，POSIX timespec的替代品。
zh-cn/device-dev/reference/hdi-apis/_audio_volume.md
浏览文件 @ 015279a7
......@@ -3,40 +3,37 @@
## **概述**
**所属模块:**
[Audio](_audio.md)
AudioVolume音频音量接口。
## **汇总**
提供音频播放（render）或录音（capture）需要的公共音量驱动能力，包括静音操作、设置音量、设置增益等。
**Since：**
### Public 属性
1.0
| Public 属性 | 描述 |
| -------- | -------- |
| ( [SetMute](#setmute) )([AudioHandle](_audio.md#ga18675ddb073465fdeac33a897f675d79) handle, bool mute) | 设置音频的静音状态 [更多...](#setmute) |
| ( [GetMute](#getmute) )([AudioHandle](_audio.md#ga18675ddb073465fdeac33a897f675d79) handle, bool \*mute) | 获取音频的静音状态 [更多...](#getmute) |
| ( [SetVolume](#setvolume) )([AudioHandle](_audio.md#ga18675ddb073465fdeac33a897f675d79) handle, float volume) | 设置一个音频流的音量 [更多...](#setvolume) |
| ( [GetVolume](#getvolume) )([AudioHandle](_audio.md#ga18675ddb073465fdeac33a897f675d79) handle, float \*volume) | 获取一个音频流的音量 [更多...](#getvolume) |
| ( [GetGainThreshold](#getgainthreshold) )([AudioHandle](_audio.md#ga18675ddb073465fdeac33a897f675d79) handle, float \*min, float \*max) | 获取音频流增益的阈值 [更多...](#getgainthreshold) |
| ( [GetGain](#getgain) )([AudioHandle](_audio.md#ga18675ddb073465fdeac33a897f675d79) handle, float \*gain) | 获取音频流的增益 [更多...](#getgain) |
| ( [SetGain](#setgain) )([AudioHandle](_audio.md#ga18675ddb073465fdeac33a897f675d79) handle, float gain) | 设置音频流的增益 [更多...](#setgain) |
**Version：**
1.0
## **详细描述**
**相关模块:**
AudioVolume音频音量接口。
[Audio](_audio.md)
提供音频播放（render）或录音（capture）需要的公共音量驱动能力，包括静音操作、设置音量、设置增益等。
**Since：**
## **汇总**
1.0
**Version：**
### Public 属性
1.0
| 名称 | 描述 |
| -------- | -------- |
| ([SetMute](#setmute))(AudioHandle handle, bool mute) | 设置音频的静音状态 |
| ([GetMute](#getmute))(AudioHandle handle, bool \*mute) | 获取音频的静音状态 |
| ([SetVolume](#setvolume))(AudioHandle handle, float volume) | 设置一个音频流的音量 |
| ([GetVolume](#getvolume))(AudioHandle handle, float \*volume) | 获取一个音频流的音量 |
| ([GetGainThreshold](#getgainthreshold))(AudioHandle handle, float \*min, float \*max) | 获取音频流增益的阈值 |
| ([GetGain](#getgain))(AudioHandle handle, float \*gain) | 获取音频流的增益 |
| ([SetGain](#setgain))(AudioHandle handle, float gain) | 设置音频流的增益 |
## **类成员变量说明**
......@@ -53,18 +50,18 @@ int32_t(* AudioVolume::GetGain) (AudioHandle handle, float *gain)
获取音频流的增益
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 待操作的音频句柄 |
| gain | 保存当前获取到的增益到gain中 |
**返回：**
**返回:**
成功返回值0，失败返回负值
**参见：**
**参见:**
[GetGainThreshold](#getgainthreshold)
......@@ -84,11 +81,11 @@ int32_t(* AudioVolume::GetGainThreshold) (AudioHandle handle, float *min, float
在具体的功能实现中，可以根据芯片平台的实际情况来进行处理：
- 1. 可以使用实际的增益值，例如增益的范围为-50db ~ 6db
- 可以使用实际的增益值，例如增益的范围为-50db ~ 6db。
- 2. 也可以将增益范围设定为0.0~1.0，如果增益的范围为-50db ~ 6db， 则增益的映射关系为0.0表示静音，1.0表示最大增益（6db）
- 也可以将增益范围设定为0.0~1.0，如果增益的范围为-50db ~ 6db， 则增益的映射关系为0.0表示静音，1.0表示最大增益（6db）。
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
......@@ -96,11 +93,11 @@ int32_t(* AudioVolume::GetGainThreshold) (AudioHandle handle, float *min, float
| min | 获取的音频增益的阈值下限保存到min中 |
| max | 获取的音频增益的阈值上限保存到max中 |
**返回：**
**返回:**
成功返回值0，失败返回负值
**参见：**
**参见:**
[GetGain](#getgain)
......@@ -118,18 +115,18 @@ int32_t(* AudioVolume::GetMute) (AudioHandle handle, bool *mute)
获取音频的静音状态
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 待操作的音频句柄 |
| mute | 获取的静音状态保存到mute中，true表示静音操作、false表示取消静音操作 |
**返回：**
**返回:**
成功返回值0，失败返回负值
**参见：**
**参见:**
[SetMute](#setmute)
......@@ -145,18 +142,18 @@ int32_t(* AudioVolume::GetVolume) (AudioHandle handle, float *volume)
获取一个音频流的音量
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 待操作的音频句柄 |
| volume | 获取的音量保存到volume中，范围0.0~1.0 |
**返回：**
**返回:**
成功返回值0，失败返回负值
**参见：**
**参见:**
[SetVolume](#setvolume)
......@@ -172,18 +169,18 @@ int32_t(* AudioVolume::SetGain) (AudioHandle handle, float gain)
设置音频流的增益
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 待操作的音频句柄 |
| gain | gain 待设置的增益 |
**返回：**
**返回:**
成功返回值0，失败返回负值
**参见：**
**参见:**
[GetGainThreshold](#getgainthreshold)
......@@ -201,18 +198,18 @@ int32_t(* AudioVolume::SetMute) (AudioHandle handle, bool mute)
设置音频的静音状态
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 待操作的音频句柄 |
| mute | 待设置的静音状态，true表示静音操作、false表示取消静音操作 |
**返回：**
**返回:**
成功返回值0，失败返回负值
**参见：**
**参见:**
[GetMute](#getmute)
......@@ -228,15 +225,15 @@ int32_t(* AudioVolume::SetVolume) (AudioHandle handle, float volume)
设置一个音频流的音量。
音量的取值范围是0.0~1.0，如果音频服务中的音量等级为15级（0 ~ 15）， 则音量的映射关系为0.0表示静音，1.0表示最大音量等级（15）
音量的取值范围是0.0~1.0，如果音频服务中的音量等级为15级（0 ~ 15）， 则音量的映射关系为0.0表示静音，1.0表示最大音量等级（15）。
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| handle | 待操作的音频句柄 |
| volume | 待设置的音量，范围0.0~1.0 |
**返回：**
**返回:**
成功返回值0，失败返回负值
zh-cn/device-dev/reference/hdi-apis/_auth_result_info.md
浏览文件 @ 015279a7
......@@ -3,6 +3,16 @@
## **概述**
用户身份认证结果信息。
**Since：**
3.2
**Version：**
1.0
**所属模块:**
[HdfUserAuth](_hdf_user_auth.md)
......@@ -13,37 +23,24 @@
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [result](#result) | 用户身份认证结果。 |
| [lockoutDuration](#lockoutduration) | 认证方式被冻结的时间。 |
| [remainAttempts](#remainattempts) | 认证方式距离被冻结的可处理认证请求次数。 |
| [freezingTime](#freezingtime) | 认证方式被冻结的时间。 |
| [remainTimes](#remaintimes) | 认证方式距离被冻结的可处理认证请求次数。 |
| [msgs](#msgs) | 执行器发送的消息。 |
| [token](#token) | 用户身份认证令牌。 |
| rootSecret | 保护文件加密密钥的密钥。 |
## **详细描述**
用户身份认证结果信息。
**Since：**
3.2
**Version：**
1.0
| [rootSecret](#rootsecret) | 保护文件加密密钥的密钥。 |
## **类成员变量说明**
### lockoutDuration
### freezingTime
```
int AuthResultInfo::lockoutDuration
int AuthResultInfo::freezingTime
```
**描述：**
......@@ -63,11 +60,11 @@ struct ExecutorSendMsg [] AuthResultInfo::msgs
执行器发送的消息。
### remainAttempts
### remainTimes
```
int AuthResultInfo::remainAttempts
int AuthResultInfo::remainTimes
```
**描述：**
......
zh-cn/device-dev/reference/hdi-apis/_auth_solution.md
浏览文件 @ 015279a7
......@@ -3,6 +3,16 @@
## **概述**
认证方案。
**Since：**
3.2
**Version：**
1.0
**所属模块:**
[HdfUserAuth](_hdf_user_auth.md)
......@@ -13,28 +23,15 @@
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [userId](#userid) | 用户ID。 |
| [authTrustLevel](#authtrustlevel) | 认证结果可信等级。 |
| [authType](#authtype) | 用户认证凭据类型AuthType}。 |
| [authType](#authtype) | 用户认证凭据类型。 |
| [executorSensorHint](#executorsensorhint) | 既定用户认证凭据类型的执行器传感器提示，用于找到对应认证方式的传感器。 |
| [challenge](#challenge) | 挑战值，用于签发认证令牌。 |
## **详细描述**
认证方案。
**Since：**
3.2
**Version：**
1.0
## **类成员变量说明**
......@@ -59,7 +56,7 @@ enum AuthType AuthSolution::authType
**描述：**
用户认证凭据类型AuthType}。
用户认证凭据类型[AuthType](_hdf_user_auth.md#authtype)。
### challenge
......
zh-cn/device-dev/reference/hdi-apis/_battery_info.md
浏览文件 @ 015279a7
......@@ -3,7 +3,13 @@
## **概述**
**所属模块:**
电池相关信息。
**Since:**
3.1
**相关模块:**
[Battery](battery.md)
......@@ -13,11 +19,11 @@
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [capacity](#capacity) | 表示电池的电量百分比。 |
| [voltage](#voltage) | 表示电池的电压。 |
| [temperature](#temperature) | 表示电池的温度 |
| [temperature](#temperature) | 表示电池的温度。 |
| [healthState](#healthstate) | 表示电池的健康状态。 |
| [pluggedType](#pluggedtype) | 表示电池的充电设备类型。 |
| [pluggedMaxCurrent](#pluggedmaxcurrent) | 表示电池的最大充电电流。 |
......@@ -32,15 +38,6 @@
| [technology](#technology) | 表示电池的技术型号。 |
## **详细描述**
电池相关信息。
**Since：**
3.1
## **类成员变量说明**
......@@ -197,7 +194,7 @@ int BatteryInfo::temperature
**描述：**
表示电池的温度
表示电池的温度。
### totalEnergy
......
zh-cn/device-dev/reference/hdi-apis/_buffer_data.md
浏览文件 @ 015279a7
......@@ -3,6 +3,8 @@
## **概述**
定义一层的缓冲区数据，包括虚拟和物理内存地址。
**所属模块:**
[Display](_display.md)
......@@ -13,10 +15,10 @@
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [phyAddr](_display.md#phyaddr-12) | 物理内存地址。 |
| [virAddr](_display.md#viraddr) | 虚拟内存地址。 |
| [phyAddr](_display.md#phyaddr-13) | 物理内存地址。 |
| [virAddr](_display.md#viraddr-12) | 虚拟内存地址。 |
## **详细描述**
......
zh-cn/device-dev/reference/hdi-apis/_capture_ended_info.md 0 → 100644
浏览文件 @ 015279a7
# CaptureEndedInfo
## **概述**
捕获结束相关信息，用于捕获结束回调[OnCaptureEnded](interface_i_stream_operator_callback.md#oncaptureended)。
**相关模块:**
[Camera](camera.md)
## **汇总**
### Public 属性
| 名称 | 描述 |
| -------- | -------- |
| [streamId_](#streamid) | 捕获的流ID。 |
| [frameCount_](#framecount) | 捕获结束时已经抓取的帧数。 |
## **类成员变量说明**
### frameCount_
```
int CaptureEndedInfo::frameCount_
```
**描述：**
捕获结束时已经抓取的帧数。
### streamId_
```
int CaptureEndedInfo::streamId_
```
**描述：**
捕获的流ID。
zh-cn/device-dev/reference/hdi-apis/_capture_error_info.md 0 → 100644
浏览文件 @ 015279a7
# CaptureErrorInfo
## **概述**
流错误信息，用于回调[OnCaptureError](interface_i_stream_operator_callback.md#oncaptureerror)。
**相关模块:**
[Camera](camera.md)
## **汇总**
### Public 属性
| 名称 | 描述 |
| -------- | -------- |
| [streamId_](#streamid) | 流ID。 |
| [error_](#error) | 错误类型。 |
## **类成员变量说明**
### error_
```
enum StreamError CaptureErrorInfo::error_
```
**描述：**
错误类型。
### streamId_
```
int CaptureErrorInfo::streamId_
```
**描述：**
流ID。
zh-cn/device-dev/reference/hdi-apis/_capture_info.md 0 → 100644
浏览文件 @ 015279a7
# CaptureInfo
## **概述**
捕获请求的相关信息。
**相关模块:**
[Camera](camera.md)
## **汇总**
### Public 属性
| 名称 | 描述 |
| -------- | -------- |
| [streamIds_](#streamids) | 捕获的流ID集合。 |
| [captureSetting_](#capturesetting) | 捕获的配置信息。 |
| [enableShutterCallback_](#enableshuttercallback) | 使能捕获回调。 |
## **类成员变量说明**
### captureSetting_
```
unsigned char [] CaptureInfo::captureSetting_
```
**描述：**
捕获的配置信息。
### enableShutterCallback_
```
boolean CaptureInfo::enableShutterCallback_
```
**描述：**
使能捕获回调，每一次捕获后都会触发[OnFrameShutter](interface_i_stream_operator_callback.md#onframeshutter)。
### streamIds_
```
int [] CaptureInfo::streamIds_
```
**描述：**
捕获的流ID集合。
zh-cn/device-dev/reference/hdi-apis/_codec.md 已删除 100644 → 0
浏览文件 @ 476a7c3a
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_codec_callback_type.md
浏览文件 @ 015279a7
......@@ -3,9 +3,21 @@
## **概述**
**所属模块:**
Codec回调接口定义。
提供了以下3种回调函数:
- 组件错误事件、命令完成事件、端口设置等事件回调，详见[EventHandler](#eventhandler)。
- 输入端口处理完buffer回调，详见[EmptyBufferDone](#emptybufferdone)。
- 输出端口填充完buffer回调，详见[FillBufferDone](#fillbufferdone)。 通过以下两种方式注册回调：
- 创建组件时，通过[CreateComponent](_codec_component_manager.md#createcomponent)方法。
- 当组件处于OMX_StateLoaded状态时，通过[SetCallbacks](_codec_component_type.md#setcallbacks)方法注册回调。
**相关模块:**
[Codec](_codec.md)
[Codec](codec.md)
## **汇总**
......@@ -13,26 +25,134 @@
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [remote](_codec.md#remote) | 指向HdfRemoteService的指针。 [更多...](_codec.md#remote) |
| ( [EventHandler](_codec.md#eventhandler) )(struct CodecCallbackType \*self, enum OMX_EVENTTYPE event, struct [EventInfo](_event_info.md) \*info) | 事件上报。 [更多...](_codec.md#eventhandler) |
| ( [EmptyBufferDone](_codec.md#emptybufferdone) )(struct CodecCallbackType \*self, int8_t \*appData, uint32_t appDataLen, const struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 上报输入buffer编码或者解码处理完毕。 [更多...](_codec.md#emptybufferdone) |
| ( [FillBufferDone](_codec.md#fillbufferdone) )(struct CodecCallbackType \*self, int8_t \*appData, uint32_t appDataLen, struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 上报输出buffer填充完毕。 [更多...](_codec.md#fillbufferdone) |
| [remote](#remote) | 指向HdfRemoteService的指针。 |
| ([EventHandler](#eventhandler) )(struct CodecCallbackType \*self, enum OMX_EVENTTYPE event, struct EventInfo \*info) | 事件上报。 |
| ([EmptyBufferDone](#emptybufferdone) )(struct CodecCallbackType \*self, int8_t \*appData, uint32_t appDataLen, const struct OmxCodecBuffer \*buffer) | 上报输入buffer编码或者解码处理完毕。 |
| ([FillBufferDone](#fillbufferdone) )(struct CodecCallbackType \*self, int8_t \*appData, uint32_t appDataLen, struct OmxCodecBuffer \*buffer) | 上报输出buffer填充完毕。 |
## **详细描述**
## **类成员变量说明**
Codec回调接口定义。
提供了以下3种回调函数:
### EmptyBufferDone
```
int32_t(* CodecCallbackType::EmptyBufferDone) (struct CodecCallbackType *self, int8_t *appData, uint32_t appDataLen, const struct OmxCodecBuffer *buffer)
```
**描述：**
上报输入buffer编码或者解码处理完毕。
组件运行过程中向上报告输入buffer已经使用完毕。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| self | 输入参数，指向要操作的callback指针。 |
| appData | 输入参数，上层数据，通常是设置回调时给入的上层实例。 |
| appDataLen | 输入参数，appData字节数。 |
| buffer | 输入参数，已经处理完毕的输入buffer信息[OmxCodecBuffer](_omx_codec_buffer.md)。 |
**返回:**
HDF_SUCCESS 表示上报成功。
HDF_ERR_INVALID_PARAM 表示参数无效，上报失败。
HDF_ERR_INVALID_OBJECT 表示对象无效，上报失败。
HDF_ERR_MALLOC_FAIL 表示申请内存失败，上报失败。
### EventHandler
```
int32_t(* CodecCallbackType::EventHandler) (struct CodecCallbackType *self, enum OMX_EVENTTYPE event, struct EventInfo *info)
```
**描述：**
事件上报。
组件运行过程中向上报告错误事件、命令完成事件、端口设置更改事件等。
- 当eEvent为OMX_EventCmdComplete，eventData为NULL，data1 数据为OMX_COMMANDTYPE, 此时，当data1为OMX_CommandStateSet，data2表示状态，其它情况下，data2表示端口。
- 当event为OMX_EventError时，data1表示错误码，data2和eventData都为0。
- 当event为OMX_EventMark时，data1和data2都为0，eventData指向mark指针。
- 当event为OMX_EventPortSettingsChanged时，data1表示端口，data2和eventData为0。
- 当event为OMX_EventBufferFlag时，data1表示端口，data2表示flag，eventData为0。
- 当event为OMX_EventResourcesAcquired或OMX_EventDynamicResourcesAvailable时，data1、data2和eventData都为0。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| self | 输入参数，指向要操作的callback指针。 |
| event | 输入参数，要通知的事件类型。 |
| info | 输入参数，指向事件上报携带的信息指针，详见[EventInfo](_event_info.md)。 |
**返回:**
HDF_SUCCESS 表示事件上报成功。
HDF_ERR_INVALID_PARAM 表示参数无效，事件上报失败。
HDF_ERR_INVALID_OBJECT 表示对象无效，事件上报失败。
HDF_ERR_MALLOC_FAIL 表示申请内存失败，事件上报失败。
### FillBufferDone
```
int32_t(* CodecCallbackType::FillBufferDone) (struct CodecCallbackType *self, int8_t *appData, uint32_t appDataLen, struct OmxCodecBuffer *buffer)
```
**描述：**
上报输出buffer填充完毕。
组件运行过程中向上报告输出buffer已经填充完毕。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| self | 输入参数，指向要操作的callback指针。 |
| appData | 输入参数，上层数据，通常是设置回调时给入的上层实例。 |
| appDataLen | 输入参数，appData字节数。 |
| buffer | 输入参数，已经填充完毕的buffer信息[OmxCodecBuffer](_omx_codec_buffer.md)。 |
**返回:**
HDF_SUCCESS 表示上报成功。
HDF_ERR_INVALID_PARAM 表示参数无效，上报失败。
HDF_ERR_INVALID_OBJECT 表示对象无效，上报失败。
HDF_ERR_MALLOC_FAIL 表示申请内存失败，上报失败。
- 组件错误事件、命令完成事件、端口设置等事件回调，详见EventHandler。
- 输入端口处理完buffer回调，详见EmptyBufferDone。
### remote
- 输出端口填充完buffer回调，详见FillBufferDone。 通过以下两种方式注册回调:
```
struct HdfRemoteService* CodecCallbackType::remote
```
- 创建组件时，通过CreateComponent方法。
**描述：**
- 当组件处于OMX_StateLoaded状态时，通过SetCallbacks方法注册回调。
指向HdfRemoteService的指针。
zh-cn/device-dev/reference/hdi-apis/_codec_comp_capability.md
浏览文件 @ 015279a7
......@@ -3,9 +3,11 @@
## **概述**
**所属模块:**
定义Codec编解码能力。
**相关模块:**
[Codec](_codec.md)
[Codec](codec.md)
## **汇总**
......@@ -13,25 +15,20 @@
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [role](#role) | 媒体类型。 |
| [type](#type) | 编解码类型。 |
| [compName](#compname) [[NAME_LENGTH](_codec.md#gaf71324c57f05ff9e24bd384925dd6b17)] | 编解码组件名称。 |
| [supportProfiles](#supportprofiles) [[PROFILE_NUM](_codec.md#gaab6353cb3662bdc672ae8ab90df529ce)] | 支持的profiles，详见[Profile](_codec.md#profile)。 |
| [compName](#compname) [NAME_LENGTH] | 编解码组件名称。 |
| [supportProfiles](#supportprofiles) [PROFILE_NUM] | 支持的profiles。 |
| [maxInst](#maxinst) | 最大实例。 |
| [isSoftwareCodec](#issoftwarecodec) | 软件编解码还是硬件编解码。 |
| [processModeMask](#processmodemask) | 编解码处理模式掩码，详见[CodecProcessMode](_codec.md#codecprocessmode)。 |
| [capsMask](#capsmask) | 编解码播放能力掩码，详见[CodecCapsMask](_codec.md#codeccapsmask)。 |
| [processModeMask](#processmodemask) | 编解码处理模式掩码。 |
| [capsMask](#capsmask) | 编解码播放能力掩码。 |
| [bitRate](#bitrate) | 支持的码率范围。 |
| [port](#port) | 支持的音视频编解码能力。 |
## **详细描述**
定义Codec编解码能力。
## **类成员变量说明**
......@@ -44,7 +41,7 @@ RangeValue CodecCompCapability::bitRate
**描述：**
支持的码率范围
支持的码率范围。
### capsMask
......@@ -56,7 +53,7 @@ uint32_t CodecCompCapability::capsMask
**描述：**
编解码播放能力掩码，详见[CodecCapsMask](_codec.md#codeccapsmask).
编解码播放能力掩码，详见[CodecCapsMask](codec.md#codeccapsmask)。
### compName
......@@ -68,7 +65,7 @@ char CodecCompCapability::compName[NAME_LENGTH]
**描述：**
编解码组件名称
编解码组件名称。
### isSoftwareCodec
......@@ -80,7 +77,7 @@ bool CodecCompCapability::isSoftwareCodec
**描述：**
软件编解码还是硬件编解码
软件编解码还是硬件编解码。
### maxInst
......@@ -92,7 +89,7 @@ int32_t CodecCompCapability::maxInst
**描述：**
最大实例
最大实例。
### port
......@@ -104,7 +101,7 @@ PortCap CodecCompCapability::port
**描述：**
支持的音视频编解码能力
支持的音视频编解码能力。
### processModeMask
......@@ -116,7 +113,7 @@ int32_t CodecCompCapability::processModeMask
**描述：**
编解码处理模式掩码，详见[CodecProcessMode](_codec.md#codecprocessmode).
编解码处理模式掩码，详见[CodecProcessMode](codec.md#codecprocessmode)。
### role
......@@ -128,7 +125,7 @@ AvCodecRole CodecCompCapability::role
**描述：**
媒体类型
媒体类型。
### supportProfiles
......@@ -140,7 +137,7 @@ int32_t CodecCompCapability::supportProfiles[PROFILE_NUM]
**描述：**
支持的profiles，详见[Profile](_codec.md#profile)
支持的profiles，详见[Profile](codec.md#profile)。
### type
......@@ -152,4 +149,4 @@ CodecType CodecCompCapability::type
**描述：**
编解码类型
编解码类型。
zh-cn/device-dev/reference/hdi-apis/_codec_component_manager.md
浏览文件 @ 015279a7
......@@ -3,33 +3,30 @@
## **概述**
**所属模块:**
[Codec](_codec.md)
Codec组件管理类接口定义。
## **汇总**
主要提供以下功能:
- 获取Codec编解码组件数量以及编解码能力集表。
### Public 属性
- 创建/销毁Codec组件。
| Public 属性 | 描述 |
| -------- | -------- |
| ([GetComponentNum](#getcomponentnum) )() | 获取Codec编解码组件数量。 [更多...](#getcomponentnum) |
| ( [GetComponentCapabilityList](#getcomponentcapabilitylist) )([CodecCompCapability](_codec_comp_capability.md) \*capList, int32_t count) | 获取编解码能力集表。 [更多...](#getcomponentcapabilitylist) |
| ( [CreateComponent](#createcomponent) )(struct [CodecComponentType](_codec_component_type.md) \*\*component, char \*compName, void \*appData, int32_t appDataSize, struct [CodecCallbackType](_codec_callback_type.md) \*callbacks) | 创建Codec组件实例。 [更多...](#createcomponent) |
| ( [DestroyComponent](#destroycomponent))(struct [CodecComponentType](_codec_component_type.md) \*component) | 销毁组件实例。 [更多...](#destroycomponent) |
**相关模块:**
[Codec](codec.md)
## **详细描述**
Codec组件管理类接口定义。
## **汇总**
主要提供以下功能:
- 获取Codec编解码组件数量以及编解码能力集表。
### Public 属性
- 创建/销毁Codec组件。
| 名称 | 描述 |
| -------- | -------- |
| ([GetComponentNum](#getcomponentnum) )() | 获取Codec编解码组件数量。 |
| ([GetComponentCapabilityList](#getcomponentcapabilitylist) )(CodecCompCapability \*capList, int32_t count) | 获取编解码能力集表。 |
| ([CreateComponent](#createcomponent) )(struct CodecComponentType \*\*component, char \*compName, void \*appData, int32_t appDataSize, struct CodecCallbackType \*callbacks) | 创建Codec组件实例。 |
| ([DestroyComponent](#destroycomponent) )(struct CodecComponentType \*component) | 销毁组件实例。 |
## **类成员变量说明**
......@@ -48,7 +45,7 @@ int32_t(* CodecComponentManager::CreateComponent) (struct CodecComponentType **c
根据组件名称创建Codec组件实例。
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
......@@ -58,7 +55,7 @@ int32_t(* CodecComponentManager::CreateComponent) (struct CodecComponentType **c
| appDataSize | 输入参数，appData字节数。 |
| callbacks | 输入参数，回调接口，指向OMX_CALLBACKTYPE结构的指针，详见[CodecCallbackType](_codec_callback_type.md)。 |
**返回：**
**返回:**
HDF_SUCCESS 表示创建组件成功。
......@@ -82,13 +79,13 @@ int32_t(* CodecComponentManager::DestroyComponent) (struct CodecComponentType *c
销毁指定的Codec组件。
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| component | 输入参数，需要销毁的Codec组件。 |
**返回：**
**返回:**
HDF_SUCCESS 表示销毁组件成功。
......@@ -112,14 +109,14 @@ int32_t(* CodecComponentManager::GetComponentCapabilityList) (CodecCompCapabilit
用户可通过此接口了解Codec模块提供了哪些编解码能力，对应的能力体现在[CodecCompCapability](_codec_comp_capability.md)结构体。
**参数：**
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| capList | 输出参数，返回全部组件的能力集表[CodecCompCapability](_codec_comp_capability.md)。 |
| count | 输入参数，编解码组件数量，由[GetComponentNum](#getcomponentnum)获得。 |
**返回：**
**返回:**
HDF_SUCCESS 表示获取能力集表成功。
......@@ -143,6 +140,6 @@ int32_t(* CodecComponentManager::GetComponentNum) ()
通过此接口获取Codec编解码组件数量，用来获取全部编解码能力集。
**返回：**
**返回:**
Codec编解码组件数量。
zh-cn/device-dev/reference/hdi-apis/_comp_ver_info.md
浏览文件 @ 015279a7
......@@ -3,9 +3,11 @@
## **概述**
**所属模块:**
定义组件版本信息。
[Codec](_codec.md)
**相关模块:**
[Codec](codec.md)
## **汇总**
......@@ -13,18 +15,12 @@
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [compName](#compname) [[NAME_LENGTH](_codec.md#gaf71324c57f05ff9e24bd384925dd6b17)] | 组件名称 |
| [compUUID](#compuuid) [[UUID_LENGTH](_codec.md#ga9226162b034cc837cd977f0fcf611c2c)] | 组件的UUID标识符 |
| [compVersion](#compversion) | OMX组件版本信息 |
| [specVersion](#specversion) | 构建组件所依据的规范的版本信息 |
## **Details**
## **详细描述**
| [compName](#compname) [[NAME_LENGTH](codec.md#gaf71324c57f05ff9e24bd384925dd6b17)] | 组件名称。 |
| [compUUID](#compuuid) [[UUID_LENGTH](codec.md#ga9226162b034cc837cd977f0fcf611c2c)] | 组件的UUID标识符。 |
| [compVersion](#compversion) | OMX组件版本信息。 |
| [specVersion](#specversion) | 构建组件所依据的规范的版本信息。 |
## **类成员变量说明**
......@@ -39,7 +35,7 @@ char CompVerInfo::compName[NAME_LENGTH]
**描述：**
组件名称
组件名称。
### compUUID
......@@ -51,7 +47,7 @@ uint8_t CompVerInfo::compUUID[UUID_LENGTH]
**描述：**
组件的UUID标识符
组件的UUID标识符。
### compVersion
......@@ -63,7 +59,7 @@ union OMX_VERSIONTYPE CompVerInfo::compVersion
**描述：**
OMX组件版本信息
OMX组件版本信息。
### specVersion
......@@ -75,4 +71,4 @@ union OMX_VERSIONTYPE CompVerInfo::specVersion
**描述：**
构建组件所依据的规范的版本信息
构建组件所依据的规范的版本信息。
zh-cn/device-dev/reference/hdi-apis/_credential_info.md
浏览文件 @ 015279a7
......@@ -3,6 +3,16 @@
## **概述**
认证凭据信息。
**自动:**
3.2
**Version：**
1.0
**所属模块:**
[HdfUserAuth](_hdf_user_auth.md)
......@@ -13,7 +23,7 @@
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [credentialId](#credentialid) | 认证凭据ID。 |
| [index](#index) | 用户认证框架的执行器索引。 |
......@@ -23,19 +33,6 @@
| [executorSensorHint](#executorsensorhint) | 既定用户认证凭据类型的执行器传感器提示，用于找到对应认证方式的传感器。 |
## **详细描述**
认证凭据信息。
**自动:**
3.2
**Version：**
1.0
## **类成员变量说明**
......
zh-cn/device-dev/reference/hdi-apis/_device_funcs.md
浏览文件 @ 015279a7
......@@ -3,7 +3,9 @@
## **概述**
**所属模块:**
显示设备控制接口结构体，定义显示设备控制接口函数指针。
**相关模块:**
[Display](_display.md)
......@@ -13,47 +15,98 @@
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| ( **RegHotPlugCallback** )(HotPlugCallback callback, void \*data) | 注册热插拔事件回调 |
| ( **RegDisplayVBlankCallback** )(uint32_t devId, VBlankCallback callback, void \*data) | 注册VBlank事件回调。 |
| ( **RegDisplayRefreshCallback** )(uint32_t devId, RefreshCallback callback, void \*data) | 刷新请求回调。 |
| ( **GetDisplayCapability** )(uint32_t devId, [DisplayCapability](_display_capability.md) \*info) | 获取显示设备能力集。 |
| ( **GetDisplaySupportedModes** )(uint32_t devId, uint32_t \*num, [DisplayModeInfo](_display_mode_info.md) \*modes) | 获取显示设备支持的显示模式信息。 |
| ( **GetDisplayMode** )(uint32_t devId, uint32_t \*modeId) | 获取显示设备当前的显示模式。 |
| ( **SetDisplayMode** )(uint32_t devId, uint32_t modeId) | 设置显示设备的显示模式。 |
| ( **GetDisplayPowerStatus** )(uint32_t devId, [DispPowerStatus](_display.md#disppowerstatus) \*status) | 获取显示设备当前的电源状态。 |
| ( **SetDisplayPowerStatus** )(uint32_t devId, [DispPowerStatus](_display.md#disppowerstatus) status) | 设置显示设备当前的电源状态。 |
| ( **GetDisplayBacklight** )(uint32_t devId, uint32_t \*level) | 获取显示设备当前的背光值。 |
| ( **SetDisplayBacklight** )(uint32_t devId, uint32_t level) | 设置显示设备当前的背光值。 |
| ( **GetDisplayProperty** )(uint32_t devId, uint32_t id, uint64_t \*value) | 获取显示设备属性值。 |
| ( **SetDisplayProperty** )(uint32_t devId, uint32_t id, uint64_t value) | 设置显示设备属性值。 |
| ( **PrepareDisplayLayers** )(uint32_t devId, bool \*needFlushFb) | 显示设备合成前准备 |
| ( **GetDisplayCompChange** )(uint32_t devId, uint32_t \*num, uint32_t \*Layers, int32_t \*type) | 获取显示设备合成类型有变化的layer |
| ( **SetDisplayClientCrop** )(uint32_t devId, [IRect](_i_rect.md) \*rect) | 设置显示设备的裁剪区域。 |
| ( **SetDisplayClientDestRect** )(uint32_t devId, [IRect](_i_rect.md) \*rect) | 设置显示设备的显示区域。 |
| ( **SetDisplayClientBuffer** )(uint32_t devId, const BufferHandle \*buffer, int32_t fence) | 设置显示设备的显示缓存。 |
| ( **SetDisplayClientDamage** )(uint32_t devId, uint32_t num, [IRect](_i_rect.md) \*rect) | 设置显示设备的显示脏区 |
| ( **SetDisplayVsyncEnabled** )(uint32_t devId, bool enabled) | 使能垂直同步信号。 |
| ( **GetDisplayReleaseFence** )(uint32_t devId, uint32_t \*num, uint32_t \*layers, int32_t \*fences) | 获取显示图层fence。 |
| ( **GetDisplaySupportedColorGamuts** )(uint32_t devId, uint32_t \*num, [ColorGamut](_display.md#colorgamut) \*gamuts) | 获取显示设备支持的色域信息。 |
| ( **GetDisplayColorGamut** )(uint32_t devId, [ColorGamut](_display.md#colorgamut) \*gamut) | 获取显示设备当前的色域模式。 |
| ( **SetDisplayColorGamut** )(uint32_t devId, [ColorGamut](_display.md#colorgamut) gamut) | 设置显示设备当前的色域模式。 |
| ( **GetDisplayGamutMap** )(uint32_t devId, [GamutMap](_display.md#gamutmap) \*gamutMap) | 获取显示设备当前的色域映射模式。 |
| ( **SetDisplayGamutMap** )(uint32_t devId, [GamutMap](_display.md#gamutmap) gamutMap) | 设置显示设备当前的色域映射模式。 |
| ( **SetDisplayColorTransform** )(uint32_t devId, const float \*matrix) | 设置显示设备当前的4x4的颜色转换矩阵。 |
| ( **GetHDRCapabilityInfos** )(uint32_t devId, [HDRCapability](_h_d_r_capability.md) \*info) | 获取显示设备支持的HDR属性信息。 |
| ( **GetSupportedMetadataKey** )(uint32_t devId, uint32_t \*num, [HDRMetadataKey](_display.md#hdrmetadatakey) \*keys) | 获取显示设备支持的 HDRMetadataKey。 |
| ( **Commit** )(uint32_t devId, int32_t \*fence) | 提交合成送显请求。 |
| ( **InvokeDisplayCmd** )(uint32_t devId,...) | 调用显示设备命令。 |
| ( **CreateVirtualDisplay** )(uint32_t width, uint32_t height, int32_t \*format, uint32_t \*devId) | 创建虚拟显示设备。 |
| ( **DestroyVirtualDisplay** )(uint32_t devId) | 销毁虚拟显示设备。 |
| ( **SetVirtualDisplayBuffer** )(uint32_t devId, BufferHandle \*buffer, int32_t fence) | 设置虚拟屏的输出缓存。 |
| ( **GetWriteBackFrame** )(uint32_t devId, BufferHandle \*buffer, int32_t \*fence) | 获取显示设备的回写帧。 |
| ( **CreateWriteBack** )(uint32_t \*devId, uint32_t width, uint32_t height, int32_t \*format) | 对指定显示设备创建回写点。 |
| ( **DestroyWriteBack** )(uint32_t devId) | 销毁指定显示设备的回写点。 |
## **详细描述**
| ([DeviceFuncs::RegHotPlugCallback](_display.md#reghotplugcallback) )(HotPlugCallback callback, void \*data) | 注册热插拔事件回调。 |
| ([DeviceFuncs::RegDisplayVBlankCallback](_display.md#regdisplayvblankcallback) )(uint32_t devId, VBlankCallback callback, void \*data) | 注册VBlank事件回调。 |
| ([DeviceFuncs::RegDisplayRefreshCallback](_display.md#regdisplayrefreshcallback) )(uint32_t devId, RefreshCallback callback, void \*data) | 刷新请求回调。 |
| ([DeviceFuncs::GetDisplayCapability](_display.md#getdisplaycapability) )(uint32_t devId, DisplayCapability \*info) | 获取显示设备能力集。 |
| ([DeviceFuncs::GetDisplaySupportedModes](_display.md#getdisplaysupportedmodes) )(uint32_t devId, uint32_t \*num, DisplayModeInfo \*modes) | 获取显示设备支持的显示模式信息。 |
| ([DeviceFuncs::GetDisplayMode](_display.md#getdisplaymode) )(uint32_t devId, uint32_t \*modeId) | 获取显示设备当前的显示模式。 |
| ([DeviceFuncs::SetDisplayMode](_display.md#setdisplaymode) )(uint32_t devId, uint32_t modeId) | 设置显示设备的显示模式。 |
| ([DeviceFuncs::GetDisplayPowerStatus](_display.md#getdisplaypowerstatus) )(uint32_t devId, DispPowerStatus \*status) | 获取显示设备当前的电源状态。 |
| ([DeviceFuncs::SetDisplayPowerStatus](_display.md#setdisplaypowerstatus) )(uint32_t devId, DispPowerStatus status) | 设置显示设备当前的电源状态。 |
| ([DeviceFuncs::GetDisplayBacklight](_display.md#getdisplaybacklight) )(uint32_t devId, uint32_t \*level) | 获取显示设备当前的背光值。 |
| ([DeviceFuncs::SetDisplayBacklight](_display.md#setdisplaybacklight) )(uint32_t devId, uint32_t level) | 设置显示设备当前的背光值。 |
| ([DeviceFuncs::GetDisplayProperty](_display.md#getdisplayproperty) )(uint32_t devId, uint32_t id, uint64_t \*value) | 获取显示设备属性值。 |
| ([DeviceFuncs::SetDisplayProperty](_display.md#setdisplayproperty) )(uint32_t devId, uint32_t id, uint64_t value) | 设置显示设备属性值。 |
| ([DeviceFuncs::PrepareDisplayLayers](_display.md#preparedisplaylayers) )(uint32_t devId, bool \*needFlushFb) | 显示设备合成前准备。 |
| ([DeviceFuncs::GetDisplayCompChange](_display.md#getdisplaycompchange) )(uint32_t devId, uint32_t \*num, uint32_t \*Layers, int32_t \*type) | 获取显示设备合成类型有变化的layer。 |
| ([DeviceFuncs::SetDisplayClientCrop](_display.md#setdisplayclientcrop) )(uint32_t devId, IRect \*rect) | 设置显示设备的裁剪区域。 |
| ([DeviceFuncs::SetDisplayClientDestRect](_display.md#setdisplayclientdestrect) )(uint32_t devId, IRect \*rect) | 设置显示设备的显示区域。 |
| ([DeviceFuncs::SetDisplayClientBuffer](_display.md#setdisplayclientbuffer) )(uint32_t devId, const BufferHandle \*buffer, int32_t fence) | 设置显示设备的显示缓存。 |
| ([DeviceFuncs::SetDisplayClientDamage](_display.md#setdisplayclientdamage) )(uint32_t devId, uint32_t num, IRect \*rect) | 设置显示设备的显示脏区。 |
| ([DeviceFuncs::SetDisplayVsyncEnabled](_display.md#setdisplayvsyncenabled) )(uint32_t devId, bool enabled) | 使能垂直同步信号。 |
| ([DeviceFuncs::GetDisplayReleaseFence](_display.md#getdisplayreleasefence) )(uint32_t devId, uint32_t \*num, uint32_t \*layers, int32_t \*fences) | 获取显示图层fence。 |
| ([DeviceFuncs::GetDisplaySupportedColorGamuts](_display.md#getdisplaysupportedcolorgamuts) )(uint32_t devId, uint32_t \*num, ColorGamut \*gamuts) | 获取显示设备支持的色域信息。 |
| ([DeviceFuncs::GetDisplayColorGamut](_display.md#getdisplaycolorgamut) )(uint32_t devId, ColorGamut \*gamut) | 获取显示设备当前的色域模式。 |
| ([DeviceFuncs::SetDisplayColorGamut](_display.md#setdisplaycolorgamut) )(uint32_t devId, ColorGamut gamut) | 设置显示设备当前的色域模式。 |
| ([DeviceFuncs::GetDisplayGamutMap](_display.md#getdisplaygamutmap) )(uint32_t devId, GamutMap \*gamutMap) | 获取显示设备当前的色域映射模式。 |
| ([DeviceFuncs::SetDisplayGamutMap](_display.md#setdisplaygamutmap) )(uint32_t devId, GamutMap gamutMap) | 设置显示设备当前的色域映射模式。 |
| ([DeviceFuncs::SetDisplayColorTransform](_display.md#setdisplaycolortransform) )(uint32_t devId, const float \*matrix) | 设置显示设备当前的4x4的颜色转换矩阵。 |
| ([DeviceFuncs::GetHDRCapabilityInfos](_display.md#gethdrcapabilityinfos) )(uint32_t devId, HDRCapability \*info) | 获取显示设备支持的HDR属性信息。 |
| ([DeviceFuncs::GetSupportedMetadataKey](_display.md#getsupportedmetadatakey) )(uint32_t devId, uint32_t \*num, DisplayInfo::widthHDRMetadataKey \*keys) | 获取显示设备支持的 HDRMetadataKey。 |
| ([DeviceFuncs::Commit](_display.md#commit) )(uint32_t devId, int32_t \*fence) | 提交合成送显请求。 |
| ([DeviceFuncs::InvokeDisplayCmd](_display.md#invokedisplaycmd) )(uint32_t devId,...) | 调用显示设备命令。 |
| ([DeviceFuncs::CreateVirtualDisplay](_display.md#createvirtualdisplay) )(uint32_t width, uint32_t height, int32_t \*format, uint32_t \*devId) | 创建虚拟显示设备。 |
| ([DeviceFuncs::DestroyVirtualDisplay](_display.md#destroyvirtualdisplay) )(uint32_t devId) | 销毁虚拟显示设备。 |
| ([DeviceFuncs::SetVirtualDisplayBuffer](_display.md#setvirtualdisplaybuffer) )(uint32_t devId, BufferHandle \*buffer, int32_t fence) | 设置虚拟屏的输出缓存。 |
| ([DeviceFuncs::GetWriteBackFrame](_display.md#getwritebackframe) )(uint32_t devId, BufferHandle \*buffer, int32_t \*fence) | 获取显示设备的回写帧。 |
| ([DeviceFuncs::CreateWriteBack](#createwriteback)DeviceFuncs::CreateWriteBack)(uint32_t \*devId, uint32_t width, uint32_t height, int32_t \*format) | PixelFormat, 接口实现层可以根据硬件需求，修改format并返回给图形服务。 |
| ([DeviceFuncs::DestroyWriteBack](#destroywriteback) )(uint32_t devId) | 销毁指定显示设备的回写点。 |
显示设备控制接口结构体，定义显示设备控制接口函数指针。
## **类成员变量说明**
### CreateWriteBack
```
int32_t(* DeviceFuncs::CreateWriteBack) (uint32_t *devId, uint32_t width, uint32_t height, int32_t *format)
```
**描述：**
PixelFormat, 接口实现层可以根据硬件需求，修改format并返回给图形服务。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| devId | 输入参数，指示需要操作的设备ID，接口实现层在创建完回写点后将回写点设备ID存放在该参数中返回给图形服务。 |
| width | 输入参数，回写像素宽度。 |
| height | 输入参数，回写像素高度。 |
| format | 输入参数，回写点数据格式，详情参考[PixelFormat](_display.md#pixelformat)，接口实现层可以根据硬件需求，修改format并返回给图形服务。 |
**返回:**
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#disperrcode)。
### DestroyWriteBack
```
int32_t(* DeviceFuncs::DestroyWriteBack) (uint32_t devId)
```
**描述：**
销毁指定显示设备的回写点。
该接口用來销毁指定的回写点。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| devId | 输入参数，指示需要操作的设备ID。 |
**返回:**
DISPLAY_SUCCESS 表示执行成功。
其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#disperrcode)。
zh-cn/device-dev/reference/hdi-apis/_display_capability.md
浏览文件 @ 015279a7
......@@ -3,7 +3,9 @@
## **概述**
**所属模块:**
定义输出性能。
**相关模块:**
[Display](_display.md)
......@@ -13,10 +15,10 @@
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [name](_display.md#name-22) [PROPERTY_NAME_LEN] | 显示设备名称 |
| [type](_display.md#type-23) | 显示屏接口类型 |
| [name [PROPERTY_NAME_LEN]](_display.md#name-22) | 显示设备名称 |
| [type](_display.md#type-27) | 显示屏接口类型 |
| [phyWidth](_display.md#phywidth) | 物理宽度 |
| [phyHeight](_display.md#phyheight) | 物理高度 |
| [supportLayers](_display.md#supportlayers) | 支持的图层数 |
......@@ -24,8 +26,3 @@
| [supportWriteBack](_display.md#supportwriteback) | 是否支持回写 |
| [propertyCount](_display.md#propertycount) | 属性数组大小 |
| [props](_display.md#props) | 属性数组 |
## **详细描述**
定义输出性能。
zh-cn/device-dev/reference/hdi-apis/_display_info.md
浏览文件 @ 015279a7
......@@ -3,7 +3,9 @@
## **概述**
**所属模块:**
定义显示信息结构体。
**相关模块:**
[Display](_display.md)
......@@ -13,13 +15,8 @@
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [width](_display.md#width-17) | 显示屏宽度 |
| [height](_display.md#height-17) | 显示屏高度 |
| [width](_display.md#width-19) | 显示屏宽度 |
| [height](_display.md#height-18) | 显示屏高度 |
| [rotAngle](_display.md#rotangle) | 显示屏旋转角度 |
## **详细描述**
定义显示信息结构体。
zh-cn/device-dev/reference/hdi-apis/_display_mode_info.md
浏览文件 @ 015279a7
......@@ -3,7 +3,9 @@
## **概述**
**所属模块:**
定义输出模式信息。
**相关模块:**
[Display](_display.md)
......@@ -13,14 +15,9 @@
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [width](_display.md#width-57) | 像素宽度 |
| [height](_display.md#height-57) | 像素高度 |
| [width](_display.md#width-59) | 像素宽度 |
| [height](_display.md#height-58) | 像素高度 |
| [freshRate](_display.md#freshrate) | 刷新速率 |
| [id](_display.md#id) | 模式ID |
## **详细描述**
定义输出模式信息。
zh-cn/device-dev/reference/hdi-apis/_enroll_param.md
浏览文件 @ 015279a7
......@@ -3,6 +3,16 @@
## **概述**
录入结果信息。
**Since：**
3.2
**Version：**
1.0
**所属模块:**
[HdfUserAuth](_hdf_user_auth.md)
......@@ -13,24 +23,11 @@
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [authType](#authtype) | 用户认证凭据类型。 |
| [executorType](#executortype) | 执行器类型。 |
| [executorId](#executorsensorhint) | 既定用户认证凭据类型的执行器传感器提示，用于找到对应认证方式的传感器。 |
## **详细描述**
录入结果信息。
**Since：**
3.2
**Version：**
1.0
| [executorSensorHint](#executorsensorhint) | 既定用户认证凭据类型的执行器传感器提示，用于找到对应认证方式的传感器。 |
## **类成员变量说明**
......
zh-cn/device-dev/reference/hdi-apis/_enroll_resultinfo.md
浏览文件 @ 015279a7
......@@ -3,6 +3,16 @@
## **概述**
注册认证凭据参数。
**Since：**
3.2
**Version：**
1.0
**所属模块:**
[HdfUserAuth](_hdf_user_auth.md)
......@@ -13,26 +23,13 @@
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [credentialId](#credentialid) | 认证凭据ID。 |
| [oldInfo](#oldinfo) | 旧凭据信息。 |
| [rootSecret](#rootsecret) | 保护文件加密密钥的密钥。 |
## **详细描述**
注册认证凭据参数。
**Since：**
3.2
**Version：**
1.0
## **类成员变量说明**
......@@ -57,7 +54,7 @@ struct CredentialInfo EnrollParam::oldInfo
**描述：**
旧凭据信息{\@link CredentialInfo}。
旧凭据信息[CredentialInfo](_credential_info.md)。
### rootSecret
......
zh-cn/device-dev/reference/hdi-apis/_enrolled_info.md
浏览文件 @ 015279a7
......@@ -3,6 +3,16 @@
## **概述**
注册信息。
**Since：**
3.2
**Version：**
1.0
**所属模块:**
[HdfUserAuth](_hdf_user_auth.md)
......@@ -13,25 +23,12 @@
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [enrolledId](#enrolledid) | 注册ID，用户注册新的认证凭据时会更新注册ID。 |
| [authType](#authtype) | 用户认证凭据类型。 |
## **详细描述**
注册信息。
**Since：**
3.2
**Version：**
1.0
## **类成员变量说明**
......@@ -44,7 +41,7 @@ enum AuthType EnrolledInfo::authType
**描述：**
用户认证凭据类型AuthType}。
用户认证凭据类型[AuthType](_hdf_user_auth.md#authtype)。
### enrolledId
......
zh-cn/device-dev/reference/hdi-apis/_event_info.md
浏览文件 @ 015279a7
......@@ -3,9 +3,11 @@
## **概述**
**所属模块:**
定义事件上报信息。
**相关模块:**
[Codec](_codec.md)
[Codec](codec.md)
## **汇总**
......@@ -13,7 +15,7 @@
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [appData](#appdata) | 设置回调时给入的上层实例。 |
| [appDataLen](#appdatalen) | appData字节数。 |
......@@ -23,11 +25,6 @@
| [eventDataLen](#eventdatalen) | eventData字节数。 |
## **详细描述**
定义事件上报信息。
## **类成员变量说明**
......@@ -40,7 +37,7 @@ int8_t* EventInfo::appData
**描述：**
设置回调时给入的上层实例
设置回调时给入的上层实例。
### appDataLen
......@@ -52,7 +49,7 @@ uint32_t EventInfo::appDataLen
**描述：**
appData字节数
appData字节数。
### data1
......@@ -64,7 +61,7 @@ uint32_t EventInfo::data1
**描述：**
事件上报携带的数据1
事件上报携带的数据1。
### data2
......@@ -76,7 +73,7 @@ uint32_t EventInfo::data2
**描述：**
事件上报携带的数据2
事件上报携带的数据2。
### eventData
......@@ -88,7 +85,7 @@ int8_t* EventInfo::eventData
**描述：**
事件上报携带的数据信息
事件上报携带的数据信息。
### eventDataLen
......@@ -100,4 +97,4 @@ uint32_t EventInfo::eventDataLen
**描述：**
eventData字节数
eventData字节数。
zh-cn/device-dev/reference/hdi-apis/_executor_info.md
浏览文件 @ 015279a7
......@@ -3,6 +3,16 @@
## **概述**
执行器信息。
**Since：**
3.2
**Version：**
1.0
**所属模块:**
[HdfFaceAuth](_hdf_face_auth.md) | [HdfPinAuth](_hdf_pin_auth.md)
......@@ -13,7 +23,7 @@
### Public 属性
| Public 属性 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [sensorId](#sensorid) | 传感器ID，不同传感器在人脸/口令认证驱动内的唯一标识。 |
| [executorType](#executortype) | 执行器类型，根据执行器支持的能力/算法类型进行分类。 |
......@@ -26,19 +36,6 @@
| [info](#info) | 执行器注册信息。 |
## **详细描述**
执行器信息。
**Since：**
3.2
**Version：**
1.0
## **类成员变量说明**
......@@ -63,7 +60,7 @@ enum ExecutorSecureLevel ExecutorInfo::esl
**描述：**
执行器安全等级[ExecutorSecureLevel](_hdf_user_auth.md#executorsecurelevel)。
执行器安全等级[ExecutorSecureLevel](_hdf_face_auth.md#executorsecurelevel)。
### executorRole
......@@ -75,7 +72,7 @@ enum ExecutorRole ExecutorInfo::executorRole
**描述：**
执行器角色[ExecutorRole](_hdf_user_auth.md#executorrole)。
执行器角色[ExecutorRole](_hdf_face_auth.md#executorrole)。
### executorType
......@@ -147,6 +144,4 @@ unsigned short ExecutorInfo::sensorId
**描述：**
传感器ID，不同传感器在人脸认证驱动内的唯一标识。
传感器ID，不同传感器在口令认证驱动内的唯一标识。
传感器ID，不同传感器在人脸认证驱动、口令认证驱动内的唯一标识。
zh-cn/device-dev/reference/hdi-apis/_hdf_light_color.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_hdf_light_info.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_hdf_wifi_info.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_hdf_wifi_scan.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_light.md 已删除 100644 → 0
浏览文件 @ 476a7c3a
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_port_info.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_r_g_b_color.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_stream_info.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_u_s_b.md 已删除 100644 → 0
浏览文件 @ 476a7c3a
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_usb_dev.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_usb_pipe.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_usb_types_8idl.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_v_g_u_buffer.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_v_g_u_conic.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_v_g_u_fill_attr.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_v_g_u_funcs.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_v_g_u_gradient.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_v_g_u_image.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_v_g_u_linear.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_v_g_u_matrix3.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_v_g_u_path.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_v_g_u_pattern.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_v_g_u_point.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_v_g_u_radial.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_v_g_u_rect.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_v_g_u_solid.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_v_g_u_surface.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_w_r_g_b_color.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_wlan_types_8idl.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_yun_desc_info_.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/annotated.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/camera.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/codec.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/display__vgu_8h.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/files.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/light.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/modulelist.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/motion.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/sensor.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/total.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/usb.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/vibrator.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/wlan.md 0 → 100644
浏览文件 @ 015279a7
此差异已折叠。
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或