diff --git a/zh-cn/device-dev/reference/hdi-apis/Readme-CN.md b/zh-cn/device-dev/reference/hdi-apis/Readme-CN.md index 98c7de011fef755a118ea6dc9e3f4ef10d1bae4c..eff04082dae1a611a07b61a2abadd589d061f604 100644 --- a/zh-cn/device-dev/reference/hdi-apis/Readme-CN.md +++ b/zh-cn/device-dev/reference/hdi-apis/Readme-CN.md @@ -1,22 +1,24 @@ -# 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) diff --git a/zh-cn/device-dev/reference/hdi-apis/____attribute____.md b/zh-cn/device-dev/reference/hdi-apis/____attribute____.md deleted file mode 100644 index c271b05bee1f5f6ab32382c00e2c125470c6da91..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/____attribute____.md +++ /dev/null @@ -1,34 +0,0 @@ -# __attribute__ - - -## **概述** - -**所属模块:** - -[Display](_display.md) - - -## **汇总** - - -### Public 属性 - - | Public 属性 | 描述 | -| -------- | -------- | -| [fd](_display.md#fd) | 句柄 fd, -1代表不支持。 | -| [reserveInts](_display.md#reserveints) | reserve数组的个数。 | -| [reserve](_display.md#reserve) [0] | reserve数组。 | -| [baseAddr](_display.md#baseaddr) | 内存的初始地址。 | -| [yOffset](_display.md#yoffset) | Y的偏移量。 | -| [uOffset](_display.md#uoffset) | U的偏移量。 | -| [vOffset](_display.md#voffset) | V的偏移量。 | -| [yStride](_display.md#ystride) | Y的stride信息。 | -| [uvStride](_display.md#uvstride) | UV的stride信息。 | -| [uvStep](_display.md#uvstep) | UV的step信息。 | - - -## **详细描述** - -扩展数据句柄结构体定义。 - -YUV描述信息结构体定义。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_act_recognition_event.md b/zh-cn/device-dev/reference/hdi-apis/_act_recognition_event.md new file mode 100644 index 0000000000000000000000000000000000000000..be0a24cf5da6609d76c3ae7dc8d6bc8ebfeb0ae5 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_act_recognition_event.md @@ -0,0 +1,82 @@ +# 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 +``` + +**描述：** + +时间戳。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_alignment.md b/zh-cn/device-dev/reference/hdi-apis/_alignment.md index fe001f65e7ca31fea14d7d5ae3bf63ba18b28d62..508dff7fee34820fe172e03b1cc4c60587153ce1 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_alignment.md +++ b/zh-cn/device-dev/reference/hdi-apis/_alignment.md @@ -3,9 +3,11 @@ ## **概述** -**所属模块:** +对齐结构定义，包含宽高的对齐值。 + +**相关模块:** -[Codec](_codec.md) +[Codec](codec.md) ## **汇总** @@ -13,17 +15,12 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | | [widthAlignment](#widthalignment) | 宽的对齐值。 | | [heightAlignment](#heightalignment) | 高的对齐值。 | -## **详细描述** - -对齐结构定义，包含宽高的对齐值。 - - ## **类成员变量说明** diff --git a/zh-cn/device-dev/reference/hdi-apis/_alloc_info.md b/zh-cn/device-dev/reference/hdi-apis/_alloc_info.md index 6873294ab8b4518a09450b67b7ff209e41102503..ccbcd8849e6a1dd3f440561b03a50953475f2248 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_alloc_info.md +++ b/zh-cn/device-dev/reference/hdi-apis/_alloc_info.md @@ -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) | 申请内存大小 | - - -## **详细描述** - -定义关于要分配的内存的信息。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_audio.md b/zh-cn/device-dev/reference/hdi-apis/_audio.md index 554eb44177de3dd16d2f72091eb23972324c3a5c..4b9d2b89865f9c4dc73a96232a636a36a4d190de 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_audio.md +++ b/zh-cn/device-dev/reference/hdi-apis/_audio.md @@ -1,12 +1,27 @@ # Audio +## **概述** + +Audio模块接口定义。 + +音频接口涉及自定义类型、驱动加载接口、驱动适配器接口、音频播放（Render）接口、音频录音（Capture）接口等。 + +**Since**: + +1.0 + +**Version**: + +1.0 + + ## **汇总** ### 文件 - | 文件 | 描述 | + | 名称 | 描述 | | -------- | -------- | | [audio_adapter.h](audio__adapter_8h.md) | Audio适配器的接口定义文件 | | [audio_attribute.h](audio__attribute_8h.md) | Audio属性的接口定义文件 | @@ -21,71 +36,71 @@ ### 类 - | 类 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [AudioAdapter](_audio_adapter.md) | AudioAdapter音频适配器接口 [更多...](_audio_adapter.md) | -| [AudioAttribute](_audio_attribute.md) | AudioAttribute音频属性接口 [更多...](_audio_attribute.md) | -| [AudioCapture](_audio_capture.md) | AudioCapture音频录音接口 [更多...](_audio_capture.md) | -| [AudioControl](_audio_control.md) | AudioControl音频控制接口 [更多...](_audio_control.md) | -| [AudioManager](_audio_manager.md) | AudioManager音频适配器管理接口 [更多...](_audio_manager.md) | -| [AudioRender](_audio_render.md) | AudioRender音频播放接口 [更多...](_audio_render.md) | -| [AudioScene](_audio_scene.md) | AudioScene音频场景接口 [更多...](_audio_scene.md) | -| [AudioPort](_audio_port.md) | 音频端口 [更多...](_audio_port.md) | -| [AudioAdapterDescriptor](_audio_adapter_descriptor.md) | 音频适配器描述符 [更多...](_audio_adapter_descriptor.md) | -| [AudioDeviceDescriptor](_audio_device_descriptor.md) | 音频设备描述符 [更多...](_audio_device_descriptor.md) | -| [AudioSceneDescriptor](_audio_scene_descriptor.md) | 音频场景描述符 [更多...](_audio_scene_descriptor.md) | -| [AudioSceneDescriptor::SceneDesc](union_audio_scene_descriptor_1_1_scene_desc.md) | 音频场景描述 [更多...](union_audio_scene_descriptor_1_1_scene_desc.md) | -| [AudioSampleAttributes](_audio_sample_attributes.md) | 音频采样属性 [更多...](_audio_sample_attributes.md) | -| [AudioTimeStamp](_audio_time_stamp.md) | 音频时间戳 [更多...](_audio_time_stamp.md) | -| [AudioSubPortCapability](_audio_sub_port_capability.md) | 音频子端口的支持能力 [更多...](_audio_sub_port_capability.md) | -| [AudioPortCapability](_audio_port_capability.md) | 音频端口的支持能力 [更多...](_audio_port_capability.md) | -| [AudioMmapBufferDescripter](_audio_mmap_buffer_descripter.md) | mmap缓冲区描述符 [更多...](_audio_mmap_buffer_descripter.md) | -| [AudioDevExtInfo](_audio_dev_ext_info.md) | 音频设备拓展信息 [更多...](_audio_dev_ext_info.md) | -| [AudioMixExtInfo](_audio_mix_ext_info.md) | 音轨拓展信息 [更多...](_audio_mix_ext_info.md) | -| [AudioSessionExtInfo](_audio_session_ext_info.md) | 会话拓展信息 [更多...](_audio_session_ext_info.md) | -| [AudioRouteNode](_audio_route_node.md) | 音频路由节点 [更多...](_audio_route_node.md) | -| [AudioRoute](_audio_route.md) | 音频路由信息 [更多...](_audio_route.md) | -| [AudioVolume](_audio_volume.md) | AudioVolume音频音量接口 [更多...](_audio_volume.md) | +| [AudioAdapter](_audio_adapter.md) | AudioAdapter音频适配器接口 | +| [AudioAttribute](_audio_attribute.md) | AudioAttribute音频属性接口 | +| [AudioCapture](_audio_capture.md) | AudioCapture音频录音接口 | +| [AudioControl](_audio_control.md) | AudioControl音频控制接口 | +| [AudioManager](_audio_manager.md) | AudioManager音频适配器管理接口 | +| [AudioRender](_audio_render.md) | AudioRender音频播放接口 | +| [AudioScene](_audio_scene.md) | AudioScene音频场景接口 | +| [AudioPort](_audio_port.md) | 音频端口 | +| [AudioAdapterDescriptor](_audio_adapter_descriptor.md) | 音频适配器描述符 | +| [AudioDeviceDescriptor](_audio_device_descriptor.md) | 音频设备描述符 | +| [AudioSceneDescriptor](_audio_scene_descriptor.md) | 音频场景描述符 | +| [AudioSceneDescriptor::SceneDesc](union_audio_scene_descriptor_1_1_scene_desc.md) | 音频场景描述 | +| [AudioSampleAttributes](_audio_sample_attributes.md) | 音频采样属性 | +| [AudioTimeStamp](_audio_time_stamp.md) | 音频时间戳 | +| [AudioSubPortCapability](_audio_sub_port_capability.md) | 音频子端口的支持能力 | +| [AudioPortCapability](_audio_port_capability.md) | 音频端口的支持能力 | +| [AudioMmapBufferDescripter](_audio_mmap_buffer_descripter.md) | mmap缓冲区描述符 | +| [AudioDevExtInfo](_audio_dev_ext_info.md) | 音频设备拓展信息 | +| [AudioMixExtInfo](_audio_mix_ext_info.md) | 音轨拓展信息 | +| [AudioSessionExtInfo](_audio_session_ext_info.md) | 会话拓展信息 | +| [AudioRouteNode](_audio_route_node.md) | 音频路由节点 | +| [AudioRoute](_audio_route.md) | 音频路由信息 | +| [AudioVolume](_audio_volume.md) | AudioVolume音频音量接口 | ### 类型定义 - | 类型定义 | 描述 | + | 名称 | 描述 | | -------- | -------- | | AudioHandle | 音频句柄 | -| ([RenderCallback](#rendercallback)) (enum [AudioCallbackType](#audiocallbacktype), void \*reserved, void \*cookie) | 回调函数指针 [更多...](#rendercallback) | +| ([RenderCallback](#rendercallback)) (enum AudioCallbackType, void \*reserved, void \*cookie) | 回调函数指针 | ### 枚举 - | 枚举 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [AudioPortDirection](#audioportdirection) { PORT_OUT = 0x1u, PORT_IN = 0x2u, PORT_OUT_IN = 0x3u } | 音频端口的类型 [更多...](#audioportdirection) | -| [AudioPortPin](#audioportpin) {   PIN_NONE = 0x0u, PIN_OUT_SPEAKER = 0x1u, PIN_OUT_HEADSET = 0x2u, PIN_OUT_LINEOUT = 0x4u,   PIN_OUT_HDMI = 0x8u, PIN_OUT_USB = 0x10u, PIN_OUT_USB_EXT = 0x20u, PIN_IN_MIC = 0x8000001u,   PIN_IN_HS_MIC = 0x8000002u, PIN_IN_LINEIN = 0x8000004u, PIN_IN_USB_EXT = 0x8000008u } | 音频适配器端口的PIN脚 [更多...](#audioportpin) | -| [AudioCategory](#audiocategory) { AUDIO_IN_MEDIA = 0, AUDIO_IN_COMMUNICATION, AUDIO_IN_RINGTONE, AUDIO_IN_CALL } | 音频类型（category） [更多...](#audiocategory) | -| [AudioFormat](#audioformat) {   AUDIO_FORMAT_PCM_8_BIT = 0x1u, AUDIO_FORMAT_PCM_16_BIT = 0x2u, AUDIO_FORMAT_PCM_24_BIT = 0x3u, AUDIO_FORMAT_PCM_32_BIT = 0x4u,   AUDIO_FORMAT_AAC_MAIN = 0x1000001u, AUDIO_FORMAT_AAC_LC = 0x1000002u, AUDIO_FORMAT_AAC_LD = 0x1000003u, AUDIO_FORMAT_AAC_ELD = 0x1000004u,   AUDIO_FORMAT_AAC_HE_V1 = 0x1000005u, AUDIO_FORMAT_AAC_HE_V2 = 0x1000006u, AUDIO_FORMAT_G711A = 0x2000001u, AUDIO_FORMAT_G711U = 0x2000002u,   AUDIO_FORMAT_G726 = 0x2000003u } | 音频格式 [更多...](#audioformat) | -| [AudioChannelMask](#audiochannelmask) { AUDIO_CHANNEL_FRONT_LEFT = 0x1, AUDIO_CHANNEL_FRONT_RIGHT = 0x2, AUDIO_CHANNEL_MONO = 0x1u, AUDIO_CHANNEL_STEREO = 0x3u } | 音频通道掩码（mask） [更多...](#audiochannelmask) | -| [AudioSampleRatesMask](#audiosampleratesmask) {   AUDIO_SAMPLE_RATE_MASK_8000 = 0x1u, AUDIO_SAMPLE_RATE_MASK_12000 = 0x2u, AUDIO_SAMPLE_RATE_MASK_11025 = 0x4u, AUDIO_SAMPLE_RATE_MASK_16000 = 0x8u,   AUDIO_SAMPLE_RATE_MASK_22050 = 0x10u, AUDIO_SAMPLE_RATE_MASK_24000 = 0x20u, AUDIO_SAMPLE_RATE_MASK_32000 = 0x40u, AUDIO_SAMPLE_RATE_MASK_44100 = 0x80u,   AUDIO_SAMPLE_RATE_MASK_48000 = 0x100u, AUDIO_SAMPLE_RATE_MASK_64000 = 0x200u, AUDIO_SAMPLE_RATE_MASK_96000 = 0x400u, AUDIO_SAMPLE_RATE_MASK_INVALID = 0xFFFFFFFFu } | 音频采样频率MASK [更多...](#audiosampleratesmask) | -| [AudioPortPassthroughMode](#audioportpassthroughmode) { PORT_PASSTHROUGH_LPCM = 0x1, PORT_PASSTHROUGH_RAW = 0x2, PORT_PASSTHROUGH_HBR2LBR = 0x4, PORT_PASSTHROUGH_AUTO = 0x8 } | 音频端口的数据透传模式 [更多...](#audioportpassthroughmode) | -| [AudioSampleFormat](#audiosampleformat) {   AUDIO_SAMPLE_FORMAT_S8, AUDIO_SAMPLE_FORMAT_S8P, AUDIO_SAMPLE_FORMAT_U8, AUDIO_SAMPLE_FORMAT_U8P,   AUDIO_SAMPLE_FORMAT_S16, AUDIO_SAMPLE_FORMAT_S16P, AUDIO_SAMPLE_FORMAT_U16, AUDIO_SAMPLE_FORMAT_U16P,   AUDIO_SAMPLE_FORMAT_S24, AUDIO_SAMPLE_FORMAT_S24P, AUDIO_SAMPLE_FORMAT_U24, AUDIO_SAMPLE_FORMAT_U24P,   AUDIO_SAMPLE_FORMAT_S32, AUDIO_SAMPLE_FORMAT_S32P, AUDIO_SAMPLE_FORMAT_U32, AUDIO_SAMPLE_FORMAT_U32P,   AUDIO_SAMPLE_FORMAT_S64, AUDIO_SAMPLE_FORMAT_S64P, AUDIO_SAMPLE_FORMAT_U64, AUDIO_SAMPLE_FORMAT_U64P,   AUDIO_SAMPLE_FORMAT_F32, AUDIO_SAMPLE_FORMAT_F32P, AUDIO_SAMPLE_FORMAT_F64, AUDIO_SAMPLE_FORMAT_F64P,   AUDIO_SAMPLE_FMT_U8, AUDIO_SAMPLE_FMT_S16, AUDIO_SAMPLE_FMT_S32, AUDIO_SAMPLE_FMT_FLOAT,   AUDIO_SAMPLE_FMT_DOUBLE, AUDIO_SAMPLE_FMT_U8P, AUDIO_SAMPLE_FMT_S16P, AUDIO_SAMPLE_FMT_S32P,   AUDIO_SAMPLE_FMT_FLOATP, AUDIO_SAMPLE_FMT_DOUBLEP, AUDIO_SAMPLE_FMT_INVALID } | 原始音频样本格式 [更多...](#audiosampleformat) | -| [AudioChannelMode](#audiochannelmode) {   AUDIO_CHANNEL_NORMAL = 0, AUDIO_CHANNEL_BOTH_LEFT, AUDIO_CHANNEL_BOTH_RIGHT, AUDIO_CHANNEL_EXCHANGE,   AUDIO_CHANNEL_MIX, AUDIO_CHANNEL_LEFT_MUTE, AUDIO_CHANNEL_RIGHT_MUTE, AUDIO_CHANNEL_BOTH_MUTE } | 音频播放的通道模式 [更多...](#audiochannelmode) | -| [AudioDrainNotifyType](#audiodrainnotifytype) { AUDIO_DRAIN_NORMAL_MODE, AUDIO_DRAIN_EARLY_MODE } | DrainBuffer函数结束类型 [更多...](#audiodrainnotifytype) | -| [AudioCallbackType](#audiocallbacktype) {   AUDIO_NONBLOCK_WRITE_COMPELETED, AUDIO_DRAIN_COMPELETED, AUDIO_FLUSH_COMPLETED, AUDIO_RENDER_FULL,   AUDIO_ERROR_OCCUR } | 回调函数通知事件类型 [更多...](#audiocallbacktype) | -| [AudioPortRole](#audioportrole) { AUDIO_PORT_UNASSIGNED_ROLE = 0, AUDIO_PORT_SOURCE_ROLE = 1, AUDIO_PORT_SINK_ROLE = 2 } | 音频端口角色 [更多...](#audioportrole) | -| [AudioPortType](#audioporttype) { AUDIO_PORT_UNASSIGNED_TYPE = 0, AUDIO_PORT_DEVICE_TYPE = 1, AUDIO_PORT_MIX_TYPE = 2, AUDIO_PORT_SESSION_TYPE = 3 } | 音频端口类型 [更多...](#audioporttype) | -| [AudioSessionType](#audiosessiontype) { AUDIO_OUTPUT_STAGE_SESSION = 0, AUDIO_OUTPUT_MIX_SESSION, AUDIO_ALLOCATE_SESSION, AUDIO_INVALID_SESSION } | 端口会话类型 [更多...](#audiosessiontype) | +| [AudioPortDirection](#audioportdirection) { PORT_OUT = 0x1u, PORT_IN = 0x2u, PORT_OUT_IN = 0x3u } | 音频端口的类型 | +| [AudioPortPin](#audioportpin) { PIN_NONE = 0x0u, PIN_OUT_SPEAKER = 0x1u, PIN_OUT_HEADSET = 0x2u, PIN_OUT_LINEOUT = 0x4u,   PIN_OUT_HDMI = 0x8u, PIN_OUT_USB = 0x10u, PIN_OUT_USB_EXT = 0x20u, PIN_IN_MIC = 0x8000001u,   PIN_IN_HS_MIC = 0x8000002u, PIN_IN_LINEIN = 0x8000004u, PIN_IN_USB_EXT = 0x8000008u } | 音频适配器端口的PIN脚 | +| [AudioCategory](#audiocategory) { AUDIO_IN_MEDIA = 0, AUDIO_IN_COMMUNICATION, AUDIO_IN_RINGTONE, AUDIO_IN_CALL } | 音频类型（category） | +| [AudioFormat](#audioformat){ AUDIO_FORMAT_PCM_8_BIT = 0x1u, AUDIO_FORMAT_PCM_16_BIT = 0x2u, AUDIO_FORMAT_PCM_24_BIT = 0x3u, AUDIO_FORMAT_PCM_32_BIT = 0x4u,   AUDIO_FORMAT_AAC_MAIN = 0x1000001u, AUDIO_FORMAT_AAC_LC = 0x1000002u, AUDIO_FORMAT_AAC_LD = 0x1000003u, AUDIO_FORMAT_AAC_ELD = 0x1000004u,   AUDIO_FORMAT_AAC_HE_V1 = 0x1000005u, AUDIO_FORMAT_AAC_HE_V2 = 0x1000006u, AUDIO_FORMAT_G711A = 0x2000001u, AUDIO_FORMAT_G711U = 0x2000002u,   AUDIO_FORMAT_G726 = 0x2000003u } | 音频格式 | +| [AudioChannelMask](#audiochannelmask){ AUDIO_CHANNEL_FRONT_LEFT = 0x1, AUDIO_CHANNEL_FRONT_RIGHT = 0x2, AUDIO_CHANNEL_MONO = 0x1u, AUDIO_CHANNEL_STEREO = 0x3u } | 音频通道掩码（mask） | +| [AudioSampleRatesMask](#audiosampleratesmask){ AUDIO_SAMPLE_RATE_MASK_8000 = 0x1u, AUDIO_SAMPLE_RATE_MASK_12000 = 0x2u, AUDIO_SAMPLE_RATE_MASK_11025 = 0x4u, AUDIO_SAMPLE_RATE_MASK_16000 = 0x8u,   AUDIO_SAMPLE_RATE_MASK_22050 = 0x10u, AUDIO_SAMPLE_RATE_MASK_24000 = 0x20u, AUDIO_SAMPLE_RATE_MASK_32000 = 0x40u, AUDIO_SAMPLE_RATE_MASK_44100 = 0x80u,   AUDIO_SAMPLE_RATE_MASK_48000 = 0x100u, AUDIO_SAMPLE_RATE_MASK_64000 = 0x200u, AUDIO_SAMPLE_RATE_MASK_96000 = 0x400u, AUDIO_SAMPLE_RATE_MASK_INVALID = 0xFFFFFFFFu } | 音频采样频率MASK | +| [AudioPortPassthroughMode](#audioportpassthroughmode){ PORT_PASSTHROUGH_LPCM = 0x1, PORT_PASSTHROUGH_RAW = 0x2, PORT_PASSTHROUGH_HBR2LBR = 0x4, PORT_PASSTHROUGH_AUTO = 0x8 } | 音频端口的数据透传模式 | +| [AudioSampleFormat](#audiosampleformat){ AUDIO_SAMPLE_FORMAT_S8, AUDIO_SAMPLE_FORMAT_S8P, AUDIO_SAMPLE_FORMAT_U8, AUDIO_SAMPLE_FORMAT_U8P,   AUDIO_SAMPLE_FORMAT_S16, AUDIO_SAMPLE_FORMAT_S16P, AUDIO_SAMPLE_FORMAT_U16, AUDIO_SAMPLE_FORMAT_U16P,   AUDIO_SAMPLE_FORMAT_S24, AUDIO_SAMPLE_FORMAT_S24P, AUDIO_SAMPLE_FORMAT_U24, AUDIO_SAMPLE_FORMAT_U24P,   AUDIO_SAMPLE_FORMAT_S32, AUDIO_SAMPLE_FORMAT_S32P, AUDIO_SAMPLE_FORMAT_U32, AUDIO_SAMPLE_FORMAT_U32P,   AUDIO_SAMPLE_FORMAT_S64, AUDIO_SAMPLE_FORMAT_S64P, AUDIO_SAMPLE_FORMAT_U64, AUDIO_SAMPLE_FORMAT_U64P,   AUDIO_SAMPLE_FORMAT_F32, AUDIO_SAMPLE_FORMAT_F32P, AUDIO_SAMPLE_FORMAT_F64, AUDIO_SAMPLE_FORMAT_F64P } | 原始音频样本格式 | +| [AudioChannelMode](#audiochannelmode){  AUDIO_CHANNEL_NORMAL = 0, AUDIO_CHANNEL_BOTH_LEFT, AUDIO_CHANNEL_BOTH_RIGHT, AUDIO_CHANNEL_EXCHANGE,   AUDIO_CHANNEL_MIX, AUDIO_CHANNEL_LEFT_MUTE, AUDIO_CHANNEL_RIGHT_MUTE, AUDIO_CHANNEL_BOTH_MUTE } | 音频播放的通道模式 | +| [AudioDrainNotifyType](#audiodrainnotifytype){ AUDIO_DRAIN_NORMAL_MODE, AUDIO_DRAIN_EARLY_MODE } | DrainBuffer函数结束类型 | +| [AudioCallbackType](#audiocallbacktype){ AUDIO_NONBLOCK_WRITE_COMPELETED, AUDIO_DRAIN_COMPELETED, AUDIO_FLUSH_COMPLETED, AUDIO_RENDER_FULL,   AUDIO_ERROR_OCCUR } | 回调函数通知事件类型 | +| [AudioPortRole](#audioportrole){ AUDIO_PORT_UNASSIGNED_ROLE = 0, AUDIO_PORT_SOURCE_ROLE = 1, AUDIO_PORT_SINK_ROLE = 2 } | 音频端口角色 | +| [AudioPortType](#audioporttype){ AUDIO_PORT_UNASSIGNED_TYPE = 0, AUDIO_PORT_DEVICE_TYPE = 1, AUDIO_PORT_MIX_TYPE = 2, AUDIO_PORT_SESSION_TYPE = 3 } | 音频端口类型. | +| [AudioSessionType](#audiosessiontype){ AUDIO_OUTPUT_STAGE_SESSION = 0, AUDIO_OUTPUT_MIX_SESSION, AUDIO_ALLOCATE_SESSION, AUDIO_INVALID_SESSION } | 端口会话类型 | ### 函数 - | 函数 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [GetAudioManagerFuncs](#getaudiomanagerfuncs) (void) | 获取音频适配器管理接口的操作函数列表，详情参考[AudioManager](_audio_manager.md)[更多...](#getaudiomanagerfuncs) | +| [GetAudioManagerFuncs](#getaudiomanagerfuncs)(void) | 获取音频适配器管理接口的操作函数列表，详情参考[AudioManager](_audio_manager.md)。 | ### 变量 - | 变量 | 描述 | + | 变量 名称 | 描述 | | -------- | -------- | | [AudioPort::dir](#dir) | 音频端口的类型。 | | [AudioPort::portId](#portid-14) | 音频端口的ID。 | @@ -153,21 +168,6 @@ | [AudioRoute::sinks](#sinks) | 接受端列表。 | -## **详细描述** - -Audio模块接口定义。 - -音频接口涉及自定义类型、驱动加载接口、驱动适配器接口、音频播放（render）接口、音频录音（capture）接口等。 - -**Since：** - -1.0 - -**Version：** - -1.0 - - ## **类型定义说明** @@ -178,11 +178,11 @@ Audio模块接口定义。 typedef int32_t(* RenderCallback) (enum AudioCallbackType, void *reserved, void *cookie) ``` -**描述：** +**描述:** 回调函数指针。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -190,13 +190,13 @@ typedef int32_t(* RenderCallback) (enum AudioCallbackType, void *reserved, void | reserved | 保留字段 | | cookie | 用于传递数据 | -**返回：** +**返回:** -成功返回值0，失败返回负值 +成功返回值0，失败返回负值。 -**参见：** +**参见:** -RegCallback +[RegCallback](_audio_render.md#regcallback) ## **枚举类型说明** @@ -209,7 +209,7 @@ RegCallback enum AudioCallbackType ``` -**描述：** +**描述:** 回调函数通知事件类型。 @@ -229,7 +229,7 @@ enum AudioCallbackType enum AudioCategory ``` -**描述：** +**描述:** 音频类型（category）。 @@ -248,7 +248,7 @@ enum AudioCategory enum AudioChannelMask ``` -**描述：** +**描述:** 音频通道掩码（mask）。 @@ -269,12 +269,13 @@ enum AudioChannelMask enum AudioChannelMode ``` -**描述：** +**描述:** 音频播放的通道模式。 -> ![icon-notice.gif](public_sys-resources/icon-notice.gif) **须知：** -> 下面的模式是针对双通道立体声的音频播放而设置，其他不支持。 +**注意:** + +下面的模式是针对双通道立体声的音频播放而设置，其他不支持。 | 枚举值 | 描述 | | -------- | -------- | @@ -295,7 +296,7 @@ enum AudioChannelMode enum AudioDrainNotifyType ``` -**描述：** +**描述:** DrainBuffer函数结束类型。 @@ -312,7 +313,7 @@ DrainBuffer函数结束类型。 enum AudioFormat ``` -**描述：** +**描述:** 音频格式。 @@ -340,15 +341,15 @@ enum AudioFormat enum AudioPortDirection ``` -**描述：** +**描述:** 音频端口的类型。 | 枚举值 | 描述 | | -------- | -------- | -| PORT_OUT | 音频输出端口。 | -| PORT_IN | 音频输入端口。 | -| PORT_OUT_IN | 音频输出/入端口，同时支持输出和输入能力（OUT \| IN）。 | +| PORT_OUT | 音频输出端口 | +| PORT_IN | 音频输入端口 | +| PORT_OUT_IN | 音频输出/入端口, 同时支持输出和输入能力（OUT \| IN） | ### AudioPortPassthroughMode @@ -358,7 +359,7 @@ enum AudioPortDirection enum AudioPortPassthroughMode ``` -**描述：** +**描述:** 音频端口的数据透传模式。 @@ -377,7 +378,7 @@ enum AudioPortPassthroughMode enum AudioPortPin ``` -**描述：** +**描述:** 音频适配器端口的PIN脚。 @@ -403,7 +404,7 @@ enum AudioPortPin enum AudioPortRole ``` -**描述：** +**描述:** 音频端口角色。 @@ -421,7 +422,7 @@ enum AudioPortRole enum AudioPortType ``` -**描述：** +**描述:** 音频端口类型。 @@ -440,7 +441,7 @@ enum AudioPortType enum AudioSampleFormat ``` -**描述：** +**描述:** 原始音频样本格式。 @@ -470,17 +471,6 @@ enum AudioSampleFormat | AUDIO_SAMPLE_FORMAT_F32P | 64bit位宽浮点型非交织样本 | | AUDIO_SAMPLE_FORMAT_F64 | 64bit位宽双精度浮点型交织样本 | | AUDIO_SAMPLE_FORMAT_F64P | 64bit位宽双精度浮点型非交织样本 | -| AUDIO_SAMPLE_FMT_U8 | 无符号8位整型，打包格式 | -| AUDIO_SAMPLE_FMT_S16 | 带符号16位整型，打包格式 | -| AUDIO_SAMPLE_FMT_S32 | 带符号32位整型，打包格式 | -| AUDIO_SAMPLE_FMT_FLOAT | 浮点型，打包格式 | -| AUDIO_SAMPLE_FMT_DOUBLE | 双精度浮点型，打包格式 | -| AUDIO_SAMPLE_FMT_U8P | 无符号8位整型，平面格式 | -| AUDIO_SAMPLE_FMT_S16P | 带符号16位整型，平面格式 | -| AUDIO_SAMPLE_FMT_S32P | 带符号32位整型，平面格式 | -| AUDIO_SAMPLE_FMT_FLOATP | 浮点型，平面格式 | -| AUDIO_SAMPLE_FMT_DOUBLEP | 双精度浮点型，平面格式 | -| AUDIO_SAMPLE_FMT_INVALID | 无效采样格式 | ### AudioSampleRatesMask @@ -490,7 +480,7 @@ enum AudioSampleFormat enum AudioSampleRatesMask ``` -**描述：** +**描述:** 音频采样频率MASK。 @@ -517,7 +507,7 @@ enum AudioSampleRatesMask enum AudioSessionType ``` -**描述：** +**描述:** 端口会话类型。 @@ -539,11 +529,11 @@ enum AudioSessionType struct AudioManager* GetAudioManagerFuncs (void ) ``` -**描述：** +**描述:** 获取音频适配器管理接口的操作函数列表，详情参考[AudioManager](_audio_manager.md)。 -**返回：** +**返回:** 成功返回一个音频适配器管理接口的对象，失败返回NULL。 @@ -558,9 +548,9 @@ struct AudioManager* GetAudioManagerFuncs (void ) const char* AudioAdapterDescriptor::adapterName ``` -**描述：** +**描述:** -音频适配器的名称。 +音频适配器的名称 ### channelCount [1/2] @@ -570,7 +560,7 @@ const char* AudioAdapterDescriptor::adapterName uint32_t AudioSampleAttributes::channelCount ``` -**描述：** +**描述:** 音频通道数目，如单通道（mono）为1、立体声（stereo）为2。 @@ -582,9 +572,9 @@ uint32_t AudioSampleAttributes::channelCount unsigned int AudioPortCapability::channelCount ``` -**描述：** +**描述:** -支持的最大声道总数。 +支持的最大声道总数 ### channelMasks @@ -594,7 +584,7 @@ unsigned int AudioPortCapability::channelCount enum AudioChannelMask AudioPortCapability::channelMasks ``` -**描述：** +**描述:** 设备的声道布局掩码（mask），详情参考[AudioChannelMask](#audiochannelmask)。 @@ -606,9 +596,9 @@ enum AudioChannelMask AudioPortCapability::channelMasks const char* AudioDeviceDescriptor::desc ``` -**描述：** +**描述:** -以字符串命名的音频设备。 +以字符串命名的音频设备 ### desc [2/5] @@ -618,9 +608,9 @@ const char* AudioDeviceDescriptor::desc struct AudioDeviceDescriptor AudioSceneDescriptor::desc ``` -**描述：** +**描述:** -音频设备描述符。 +音频设备描述符 ### desc [3/5] @@ -630,9 +620,9 @@ struct AudioDeviceDescriptor AudioSceneDescriptor::desc const char* AudioSceneDescriptor::SceneDesc::desc ``` -**描述：** +**描述:** -以字符串命名的音频场景。 +以字符串命名的音频场景 ### desc [4/5] @@ -642,9 +632,9 @@ const char* AudioSceneDescriptor::SceneDesc::desc const char* AudioSubPortCapability::desc ``` -**描述：** +**描述:** -以字符串命名的子端口。 +以字符串命名的子端口 ### desc [5/5] @@ -654,9 +644,21 @@ const char* AudioSubPortCapability::desc const char* AudioDevExtInfo::desc ``` -**描述：** +**描述:** + +地址描述 + + +### device + + +``` +struct AudioDevExtInfo AudioRouteNode::ext::device +``` + +**描述:** -地址描述。 +设备特定信息。 ### deviceId @@ -666,7 +668,7 @@ const char* AudioDevExtInfo::desc unsigned int AudioPortCapability::deviceId ``` -**描述：** +**描述:** 绑定（bind）设备ID，唯一的设备识别符。 @@ -678,7 +680,7 @@ unsigned int AudioPortCapability::deviceId unsigned int AudioPortCapability::deviceType ``` -**描述：** +**描述:** 设备输出、输入类型。 @@ -690,7 +692,7 @@ unsigned int AudioPortCapability::deviceType enum AudioPortDirection AudioPort::dir ``` -**描述：** +**描述:** 音频端口的类型，详情参考[AudioPortDirection](#audioportdirection)。 @@ -702,7 +704,7 @@ enum AudioPortDirection AudioPort::dir enum AudioFormat AudioSampleAttributes::format ``` -**描述：** +**描述:** 音频数据格式，详情参考[AudioFormat](#audioformat)。 @@ -714,9 +716,9 @@ enum AudioFormat AudioSampleAttributes::format unsigned int AudioPortCapability::formatNum ``` -**描述：** +**描述:** -支持的音频格式数目。 +支持的音频格式数目 ### formats @@ -726,7 +728,7 @@ unsigned int AudioPortCapability::formatNum enum AudioFormat* AudioPortCapability::formats ``` -**描述：** +**描述:** 支持的音频格式，详情参考[AudioFormat](#audioformat)。 @@ -738,9 +740,9 @@ enum AudioFormat* AudioPortCapability::formats uint32_t AudioSampleAttributes::frameSize ``` -**描述：** +**描述:** -音频数据的帧大小。 +音频数据的帧大小 ### hardwareMode @@ -750,9 +752,9 @@ uint32_t AudioSampleAttributes::frameSize bool AudioPortCapability::hardwareMode ``` -**描述：** +**描述:** -是否支持设备绑定处理。 +是否支持设备绑定处理 ### id @@ -762,9 +764,9 @@ bool AudioPortCapability::hardwareMode unsigned int AudioSceneDescriptor::SceneDesc::id ``` -**描述：** +**描述:** -音频场景的ID。 +音频场景的ID ### interleaved @@ -774,9 +776,9 @@ unsigned int AudioSceneDescriptor::SceneDesc::id bool AudioSampleAttributes::interleaved ``` -**描述：** +**描述:** -音频数据交织的标记。 +音频数据交织的标记 ### isBigEndian @@ -786,9 +788,9 @@ bool AudioSampleAttributes::interleaved bool AudioSampleAttributes::isBigEndian ``` -**描述：** +**描述:** -音频数据的大端标志。 +音频数据的大端标志 ### isShareable @@ -798,9 +800,9 @@ bool AudioSampleAttributes::isBigEndian int32_t AudioMmapBufferDescripter::isShareable ``` -**描述：** +**描述:** -mmap缓冲区是否可以在进程间共享。 +mmap缓冲区是否可以在进程间共享 ### isSignedData @@ -810,7 +812,7 @@ mmap缓冲区是否可以在进程间共享。 bool AudioSampleAttributes::isSignedData ``` -**描述：** +**描述:** 音频数据的有符号或无符号标志 @@ -822,7 +824,7 @@ bool AudioSampleAttributes::isSignedData enum AudioPortPassthroughMode AudioSubPortCapability::mask ``` -**描述：** +**描述:** 数据透传模式，详情参考[AudioPortPassthroughMode](#audioportpassthroughmode)。 @@ -834,9 +836,9 @@ enum AudioPortPassthroughMode AudioSubPortCapability::mask void* AudioMmapBufferDescripter::memoryAddress ``` -**描述：** +**描述:** -指向mmap缓冲区的指针。 +指向mmap缓冲区的指针 ### memoryFd @@ -846,9 +848,21 @@ void* AudioMmapBufferDescripter::memoryAddress int32_t AudioMmapBufferDescripter::memoryFd ``` -**描述：** +**描述:** + +mmap缓冲区的文件描述符 + + +### mix + + +``` +struct AudioMixExtInfo AudioRouteNode::ext::mix +``` + +**描述:** -mmap缓冲区的文件描述符。 +音轨特定信息。 ### moduleId [1/2] @@ -858,9 +872,9 @@ mmap缓冲区的文件描述符。 int32_t AudioDevExtInfo::moduleId ``` -**描述：** +**描述:** -音频流绑定的模块ID。 +音频流绑定的模块ID ### moduleId [2/2] @@ -870,9 +884,9 @@ int32_t AudioDevExtInfo::moduleId int32_t AudioMixExtInfo::moduleId ``` -**描述：** +**描述:** -流所属模块标识符。 +流所属模块标识符 ### period @@ -882,9 +896,9 @@ int32_t AudioMixExtInfo::moduleId uint32_t AudioSampleAttributes::period ``` -**描述：** +**描述:** -音频采样周期。 +音频采样周期 ### pins @@ -894,7 +908,7 @@ uint32_t AudioSampleAttributes::period enum AudioPortPin AudioDeviceDescriptor::pins ``` -**描述：** +**描述:** 音频端口上的PIN脚（输出、输入），详情参考[AudioPortPin](#audioportpin)。 @@ -906,9 +920,9 @@ enum AudioPortPin AudioDeviceDescriptor::pins unsigned int AudioPort::portId ``` -**描述：** +**描述:** -音频端口的ID。 +音频端口的ID ### portId [2/4] @@ -918,9 +932,9 @@ unsigned int AudioPort::portId unsigned int AudioDeviceDescriptor::portId ``` -**描述：** +**描述:** -音频端口ID。 +音频端口ID ### portId [3/4] @@ -930,9 +944,9 @@ unsigned int AudioDeviceDescriptor::portId unsigned int AudioSubPortCapability::portId ``` -**描述：** +**描述:** -子端口ID。 +子端口ID ### portId [4/4] @@ -942,9 +956,9 @@ unsigned int AudioSubPortCapability::portId int32_t AudioRouteNode::portId ``` -**描述：** +**描述:** -音频端口ID。 +音频端口ID ### portName @@ -954,9 +968,9 @@ int32_t AudioRouteNode::portId const char* AudioPort::portName ``` -**描述：** +**描述:** -音频端口的名称。 +音频端口的名称 ### portNum @@ -966,9 +980,9 @@ const char* AudioPort::portName unsigned int AudioAdapterDescriptor::portNum ``` -**描述：** +**描述:** -一个音频适配器支持的端口数目。 +一个音频适配器支持的端口数目 ### ports @@ -978,9 +992,9 @@ unsigned int AudioAdapterDescriptor::portNum struct AudioPort* AudioAdapterDescriptor::ports ``` -**描述：** +**描述:** -一个音频适配器支持的端口列表。 +一个音频适配器支持的端口列表 ### role @@ -990,9 +1004,9 @@ struct AudioPort* AudioAdapterDescriptor::ports enum AudioPortRole AudioRouteNode::role ``` -**描述：** +**描述:** -指定端口角色为sink或source。 +指定端口角色为sink或source ### sampleRate @@ -1002,9 +1016,9 @@ enum AudioPortRole AudioRouteNode::role unsigned int AudioSampleAttributes::sampleRate ``` -**描述：** +**描述:** -音频采样频率。 +音频采样频率 ### sampleRateMasks @@ -1014,9 +1028,9 @@ unsigned int AudioSampleAttributes::sampleRate unsigned int AudioPortCapability::sampleRateMasks ``` -**描述：** +**描述:** -支持的音频采样频率（8k、16k、32k、48k）。 +支持的音频采样频率（8k、16k、32k、48k） ### scene @@ -1026,9 +1040,21 @@ unsigned int AudioPortCapability::sampleRateMasks union AudioSceneDescriptor::SceneDesc AudioSceneDescriptor::scene ``` -**描述：** +**描述:** + +音频场景的名称 + + +### session + + +``` +struct AudioSessionExtInfo AudioRouteNode::ext::session +``` + +**描述:** -音频场景的名称。 +会话特定信息。 ### sessionType @@ -1038,9 +1064,9 @@ union AudioSceneDescriptor::SceneDesc AudioSceneDescriptor::scene enum AudioSessionType AudioSessionExtInfo::sessionType ``` -**描述：** +**描述:** -音频会话类型。 +音频会话类型 ### silenceThreshold @@ -1050,9 +1076,9 @@ enum AudioSessionType AudioSessionExtInfo::sessionType uint32_t AudioSampleAttributes::silenceThreshold ``` -**描述：** +**描述:** -音频捕获缓冲区阈值。 +音频捕获缓冲区阈值 ### sinks @@ -1062,9 +1088,9 @@ uint32_t AudioSampleAttributes::silenceThreshold const struct AudioRouteNode* AudioRoute::sinks ``` -**描述：** +**描述:** -接受端列表。 +接受端列表 ### sinksNum @@ -1074,9 +1100,9 @@ const struct AudioRouteNode* AudioRoute::sinks uint32_t AudioRoute::sinksNum ``` -**描述：** +**描述:** -接受端节点数量。 +接受端节点数量 ### sources @@ -1086,9 +1112,9 @@ uint32_t AudioRoute::sinksNum const struct AudioRouteNode* AudioRoute::sources ``` -**描述：** +**描述:** -发送端列表。 +发送端列表 ### sourcesNum @@ -1098,9 +1124,9 @@ const struct AudioRouteNode* AudioRoute::sources uint32_t AudioRoute::sourcesNum ``` -**描述：** +**描述:** -发送端节点数量。 +发送端节点数量 ### startThreshold @@ -1110,9 +1136,9 @@ uint32_t AudioRoute::sourcesNum uint32_t AudioSampleAttributes::startThreshold ``` -**描述：** +**描述:** -音频渲染开始阈值。 +音频渲染开始阈值 ### stopThreshold @@ -1122,9 +1148,9 @@ uint32_t AudioSampleAttributes::startThreshold uint32_t AudioSampleAttributes::stopThreshold ``` -**描述：** +**描述:** -音频渲染停止阈值。 +音频渲染停止阈值 ### streamId [1/2] @@ -1134,9 +1160,9 @@ uint32_t AudioSampleAttributes::stopThreshold int32_t AudioSampleAttributes::streamId ``` -**描述：** +**描述:** -渲染或捕获的音频标识符。 +渲染或捕获的音频标识符 ### streamId [2/2] @@ -1146,9 +1172,9 @@ int32_t AudioSampleAttributes::streamId int32_t AudioMixExtInfo::streamId ``` -**描述：** +**描述:** -由调用者传递的Render或Capture标识符。 +由调用者传递的Render或Capture标识符 ### subPorts @@ -1158,9 +1184,9 @@ int32_t AudioMixExtInfo::streamId struct AudioSubPortCapability* AudioPortCapability::subPorts ``` -**描述：** +**描述:** -支持的子端口列表。 +支持的子端口列表 ### subPortsNum @@ -1170,9 +1196,9 @@ struct AudioSubPortCapability* AudioPortCapability::subPorts unsigned int AudioPortCapability::subPortsNum ``` -**描述：** +**描述:** -支持的子端口数目（仅用于输出设备）。 +支持的子端口数目（仅用于输出设备） ### supportSampleFormatNum @@ -1182,9 +1208,9 @@ unsigned int AudioPortCapability::subPortsNum uint32_t AudioPortCapability::supportSampleFormatNum ``` -**描述：** +**描述:** -支持的音频样本格式数量。 +支持的音频样本格式数量 ### supportSampleFormats @@ -1194,9 +1220,9 @@ uint32_t AudioPortCapability::supportSampleFormatNum enum AudioSampleFormat* AudioPortCapability::supportSampleFormats ``` -**描述：** +**描述:** -支持的音频样本格式，详请参考[AudioSampleFormat](_codec.md#audiosampleformat)。 +支持的音频样本格式，详请参考[AudioSampleFormat](#audiosampleformat)。 ### totalBufferFrames @@ -1206,7 +1232,7 @@ enum AudioSampleFormat* AudioPortCapability::supportSampleFormats int32_t AudioMmapBufferDescripter::totalBufferFrames ``` -**描述：** +**描述:** 缓冲区总大小，单位：帧。 @@ -1218,7 +1244,7 @@ int32_t AudioMmapBufferDescripter::totalBufferFrames int32_t AudioMmapBufferDescripter::transferFrameSize ``` -**描述：** +**描述:** 传输大小，单位：帧。 @@ -1230,7 +1256,7 @@ int32_t AudioMmapBufferDescripter::transferFrameSize int64_t AudioTimeStamp::tvNSec ``` -**描述：** +**描述:** tvNSec时间，单位：纳秒。 @@ -1242,7 +1268,7 @@ tvNSec时间，单位：纳秒。 int64_t AudioTimeStamp::tvSec ``` -**描述：** +**描述:** tvSec时间，单位：秒。 @@ -1254,7 +1280,7 @@ tvSec时间，单位：秒。 enum AudioCategory AudioSampleAttributes::type ``` -**描述：** +**描述:** 音频类型，详情参考[AudioCategory](#audiocategory)。 @@ -1266,7 +1292,7 @@ enum AudioCategory AudioSampleAttributes::type enum AudioPortPin AudioDevExtInfo::type ``` -**描述：** +**描述:** 音频端口上的PIN脚（输出、输入），详情参考[AudioPortPin](#audioportpin)。 @@ -1278,42 +1304,6 @@ enum AudioPortPin AudioDevExtInfo::type enum AudioPortType AudioRouteNode::type ``` -**描述：** - -指定端口类型。 - - -### device - - -``` - struct AudioDevExtInfo AudioRouteNode::device -``` - -**描述：** - -设备特定信息。 - - -### mix - - -``` - struct AudioMixExtInfo AudioRouteNode::mix -``` - -**描述：** +**描述:** -音轨特定信息。 - - -### session - - -``` - struct AudioSessionExtInfo AudioRouteNode::session -``` - -**描述：** - -会话特定信息。 +指定端口类型为device, mix等。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_audio_adapter.md b/zh-cn/device-dev/reference/hdi-apis/_audio_adapter.md index c4ddc25428e9e04cacde47a42b131bec1d9e60cf..be115d34419463c495a8b9e4e4b3f78f44ccbcaf 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_audio_adapter.md +++ b/zh-cn/device-dev/reference/hdi-apis/_audio_adapter.md @@ -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，失败返回负值 diff --git a/zh-cn/device-dev/reference/hdi-apis/_audio_adapter_descriptor.md b/zh-cn/device-dev/reference/hdi-apis/_audio_adapter_descriptor.md index 37968692e35f2e2db9256d19583836daad3789e0..93f007349acdeaafcd080489f1cb530cc84da07c 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_audio_adapter_descriptor.md +++ b/zh-cn/device-dev/reference/hdi-apis/_audio_adapter_descriptor.md @@ -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) | 一个音频适配器支持的端口列表 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_audio_attribute.md b/zh-cn/device-dev/reference/hdi-apis/_audio_attribute.md index 668a797efccc85c7f98728f8bef7a6569a17589c..91b7118108cc00bdce8ecfc2931789e5bbb40ba3 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_audio_attribute.md +++ b/zh-cn/device-dev/reference/hdi-apis/_audio_attribute.md @@ -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) diff --git a/zh-cn/device-dev/reference/hdi-apis/_audio_capture.md b/zh-cn/device-dev/reference/hdi-apis/_audio_capture.md index 0cc96d36c54f5325f93f26beb4f2e8ec7daffd6f..9f316b158812e5d3de68fbd18ccbbf6cfd659a57 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_audio_capture.md +++ b/zh-cn/device-dev/reference/hdi-apis/_audio_capture.md @@ -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) diff --git a/zh-cn/device-dev/reference/hdi-apis/_audio_control.md b/zh-cn/device-dev/reference/hdi-apis/_audio_control.md index 1d4d71c6d86d3874b823102ae0d71b296daa5794..0a7c29043458659885ef3be77f83309b93364b76 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_audio_control.md +++ b/zh-cn/device-dev/reference/hdi-apis/_audio_control.md @@ -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，再次执行后去设置待机模式成功返回正值，失败返回负值。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_audio_dev_ext_info.md b/zh-cn/device-dev/reference/hdi-apis/_audio_dev_ext_info.md index 1a4a421f8463c9ce844d987f98c89b4cce8cffe9..d3f01acc1f1826b366fbfa92b6370b86ebc480fe 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_audio_dev_ext_info.md +++ b/zh-cn/device-dev/reference/hdi-apis/_audio_dev_ext_info.md @@ -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) | 地址描述 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_audio_device_descriptor.md b/zh-cn/device-dev/reference/hdi-apis/_audio_device_descriptor.md index 5e10acce99f5c951a1daf983a6b01e36fe84b3de..3046db7ba8f824722145bb83855dc5cc53d60a42 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_audio_device_descriptor.md +++ b/zh-cn/device-dev/reference/hdi-apis/_audio_device_descriptor.md @@ -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) | 以字符串命名的音频设备 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_audio_manager.md b/zh-cn/device-dev/reference/hdi-apis/_audio_manager.md index e0fe9486e137112c5ec00cd05a7169c36039e256..d0ad0ecea2c79788ef86f7b9bcd5d130aeb3485a 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_audio_manager.md +++ b/zh-cn/device-dev/reference/hdi-apis/_audio_manager.md @@ -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) diff --git a/zh-cn/device-dev/reference/hdi-apis/_audio_mix_ext_info.md b/zh-cn/device-dev/reference/hdi-apis/_audio_mix_ext_info.md index fcf31a50003dfd54672b80acc06b907f1f80295b..50032fae465492d88b676b63a14a54d8a5b3cb87 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_audio_mix_ext_info.md +++ b/zh-cn/device-dev/reference/hdi-apis/_audio_mix_ext_info.md @@ -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标识符 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_audio_mmap_buffer_descripter.md b/zh-cn/device-dev/reference/hdi-apis/_audio_mmap_buffer_descripter.md index cd301a7d69f96715c46423c1ed984d7b59b17173..ae1a56a61e43026fdf892b4c956a884c4d6cce2b 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_audio_mmap_buffer_descripter.md +++ b/zh-cn/device-dev/reference/hdi-apis/_audio_mmap_buffer_descripter.md @@ -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缓冲区是否可以在进程间共享 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_audio_port.md b/zh-cn/device-dev/reference/hdi-apis/_audio_port.md index 5ad207379d352367e346ca39e607789e4d38207a..4cf79c86ea3854c602904c120e54a43e7abd1779 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_audio_port.md +++ b/zh-cn/device-dev/reference/hdi-apis/_audio_port.md @@ -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) | 音频端口的名称。 | - - -## **详细描述** - -音频端口。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_audio_port_cap.md b/zh-cn/device-dev/reference/hdi-apis/_audio_port_cap.md deleted file mode 100644 index 6545ac35c4833ef5e247a78a03361ce016574928..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_audio_port_cap.md +++ /dev/null @@ -1,77 +0,0 @@ -# AudioPortCap - - -## **概述** - -**所属模块:** - -[Codec](_codec.md) - - -## **汇总** - - -### Public 属性 - - | Public 属性 | 描述 | -| -------- | -------- | -| [sampleFormats](#sampleformats) [[SAMPLE_FMT_NUM](_codec.md#ga9bda75c363e9bcff915cdd521dd7ba84)] | 支持的音频采样格式，详见[AudioSampleFormat](_codec.md#audiosampleformat)。 | -| [sampleRate](#samplerate) [[SAMPLE_RATE_NUM](_codec.md#ga0d905eaa05b4b6fcec76924eb795d7fe)] | 支持的音频采样率，详见[AudioSampleRate](_codec.md#audiosamplerate)。 | -| [channelLayouts](#channellayouts) [[CHANNEL_NUM](_codec.md#ga6511732d5b29a6781cf38783157f21e1)] | 支持的音频通道数channel layouts。 | -| [channelCount](#channelcount) [[CHANNEL_NUM](_codec.md#ga6511732d5b29a6781cf38783157f21e1)] | 支持的音频通道数。 | - - -## **详细描述** - -定义音频编解码能力。 - - -## **类成员变量说明** - - -### channelCount - - -``` -int32_t AudioPortCap::channelCount[CHANNEL_NUM] -``` - -**描述：** - -支持的音频通道数 - - -### channelLayouts - - -``` -int32_t AudioPortCap::channelLayouts[CHANNEL_NUM] -``` - -**描述：** - -支持的音频通道数channel layouts - - -### sampleFormats - - -``` -int32_t AudioPortCap::sampleFormats[SAMPLE_FMT_NUM] -``` - -**描述：** - -支持的音频采样格式，详见[AudioSampleFormat](_codec.md#audiosampleformat) - - -### sampleRate - - -``` -int32_t AudioPortCap::sampleRate[SAMPLE_RATE_NUM] -``` - -**描述：** - -支持的音频采样率，详见[AudioSampleRate](_codec.md#audiosamplerate) diff --git a/zh-cn/device-dev/reference/hdi-apis/_audio_port_capability.md b/zh-cn/device-dev/reference/hdi-apis/_audio_port_capability.md index 4fbfb7c94e6286adf5b6d23a34f2d2ecd0d239f9..bcd0d457ef2599dde89fc1a3e8d89248800328fb 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_audio_port_capability.md +++ b/zh-cn/device-dev/reference/hdi-apis/_audio_port_capability.md @@ -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) | 支持的音频样本格式。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_audio_render.md b/zh-cn/device-dev/reference/hdi-apis/_audio_render.md index 8f2fbb7f23b9011a2a2c0949356cafd80e58c7c0..c4a172ab2af2c546cb3a33363d254dcebd9b5de6 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_audio_render.md +++ b/zh-cn/device-dev/reference/hdi-apis/_audio_render.md @@ -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) diff --git a/zh-cn/device-dev/reference/hdi-apis/_audio_route.md b/zh-cn/device-dev/reference/hdi-apis/_audio_route.md index d4db5ceddec9bf88fbeb75fa15f6c1a61dc57ac5..52fe8436dc04d9761877f4a8c652ccc30cfc916d 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_audio_route.md +++ b/zh-cn/device-dev/reference/hdi-apis/_audio_route.md @@ -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) | 接受端列表。 | - - -## **详细描述** - -音频路由信息。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_audio_route_node.md b/zh-cn/device-dev/reference/hdi-apis/_audio_route_node.md index 2686ecf9b5d43ab44660185531ecc550aca6cc71..ac409be4c4343dfec9cd459820adaaa74bd5ae01 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_audio_route_node.md +++ b/zh-cn/device-dev/reference/hdi-apis/_audio_route_node.md @@ -1,9 +1,11 @@ # 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) | 会话特定信息。 | - - -## **详细描述** - -音频路由节点。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_audio_sample_attributes.md b/zh-cn/device-dev/reference/hdi-apis/_audio_sample_attributes.md index 8b2c871f1cf272d6f90fbc43ce08b37e108da7f3..4ac66a50a5523a64b15e4f61822c817461bf60c1 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_audio_sample_attributes.md +++ b/zh-cn/device-dev/reference/hdi-apis/_audio_sample_attributes.md @@ -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) | 渲染或捕获的音频标识符。 | - - -## **详细描述** - -音频采样属性。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_audio_scene.md b/zh-cn/device-dev/reference/hdi-apis/_audio_scene.md index 520381a9b410129142f620ecb394f8fa2183ce94..27bf2daee3c3eaf3da86ab30c5d6a24dca4feeb2 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_audio_scene.md +++ b/zh-cn/device-dev/reference/hdi-apis/_audio_scene.md @@ -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) diff --git a/zh-cn/device-dev/reference/hdi-apis/_audio_scene_descriptor.md b/zh-cn/device-dev/reference/hdi-apis/_audio_scene_descriptor.md index 624073d4aec715fb57f5695527a5d8cd662c5d05..3910b9897ea0b8337de6762bd93282530c1620c8 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_audio_scene_descriptor.md +++ b/zh-cn/device-dev/reference/hdi-apis/_audio_scene_descriptor.md @@ -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) | 音频设备描述符。 | - - -## **详细描述** - -音频场景描述符。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_audio_session_ext_info.md b/zh-cn/device-dev/reference/hdi-apis/_audio_session_ext_info.md index d48ad307922f7be094c3e4492497e7564a9a70e3..dbb96a35bdb71174a5dd356e90dadecc45bb7c75 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_audio_session_ext_info.md +++ b/zh-cn/device-dev/reference/hdi-apis/_audio_session_ext_info.md @@ -3,7 +3,9 @@ ## **概述** -**所属模块:** +会话拓展信息。 + +**相关模块:** [Audio](_audio.md) @@ -13,11 +15,6 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | | [sessionType](_audio.md#sessiontype) | 音频会话类型。 | - - -## **详细描述** - -会话拓展信息。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_audio_sub_port_capability.md b/zh-cn/device-dev/reference/hdi-apis/_audio_sub_port_capability.md index 1bc223b1d5f70bb6b1725cf4d184216cc1c93e3f..33da2e3ebea88ca10826c778d97f7d71d9904844 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_audio_sub_port_capability.md +++ b/zh-cn/device-dev/reference/hdi-apis/_audio_sub_port_capability.md @@ -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) | 数据透传模式。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_audio_time_stamp.md b/zh-cn/device-dev/reference/hdi-apis/_audio_time_stamp.md index ec53fdefc97c8e41d22e4b68f00796577b63b74e..72f9c7d1b2bb9ef87d876e46620328874560c25d 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_audio_time_stamp.md +++ b/zh-cn/device-dev/reference/hdi-apis/_audio_time_stamp.md @@ -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的替代品。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_audio_volume.md b/zh-cn/device-dev/reference/hdi-apis/_audio_volume.md index 2766ba7eb2bb60cb95e4281799707f2ceb81abd1..a4872b457d81268fcf4bcf13e7c6f056f965cbbb 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_audio_volume.md +++ b/zh-cn/device-dev/reference/hdi-apis/_audio_volume.md @@ -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，失败返回负值 diff --git a/zh-cn/device-dev/reference/hdi-apis/_auth_result_info.md b/zh-cn/device-dev/reference/hdi-apis/_auth_result_info.md index fe4a3ac63ff19429153d7ad7d60f8c7c62066e1b..add4d4a1fa15af78a2eea1d0258a4d3966ff6d63 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_auth_result_info.md +++ b/zh-cn/device-dev/reference/hdi-apis/_auth_result_info.md @@ -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 ``` **描述：** diff --git a/zh-cn/device-dev/reference/hdi-apis/_auth_solution.md b/zh-cn/device-dev/reference/hdi-apis/_auth_solution.md index 8a43490939301ffa64c3dc9b11ce588041ee6e69..623a2e8497137c71597eaafada3341487173630f 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_auth_solution.md +++ b/zh-cn/device-dev/reference/hdi-apis/_auth_solution.md @@ -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 diff --git a/zh-cn/device-dev/reference/hdi-apis/_battery_info.md b/zh-cn/device-dev/reference/hdi-apis/_battery_info.md index 8373d179faf623504f0e9deee42a05dd4be0ca68..adc0e59b43be9c41ad81db6d428b7a3a6f26cbb9 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_battery_info.md +++ b/zh-cn/device-dev/reference/hdi-apis/_battery_info.md @@ -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 diff --git a/zh-cn/device-dev/reference/hdi-apis/_buffer_data.md b/zh-cn/device-dev/reference/hdi-apis/_buffer_data.md index 667b9b2a71c852b359534877e1f4c7294afa1137..4d24eb0e40a3453cec07111e758312f454407ddd 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_buffer_data.md +++ b/zh-cn/device-dev/reference/hdi-apis/_buffer_data.md @@ -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) | 虚拟内存地址。 | ## **详细描述** diff --git a/zh-cn/device-dev/reference/hdi-apis/_camera.md b/zh-cn/device-dev/reference/hdi-apis/_camera.md deleted file mode 100644 index 066935359619d140db859247ec934dc16ac93ad6..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_camera.md +++ /dev/null @@ -1,1837 +0,0 @@ -# Camera - - -## **汇总** - - -### 文件 - -| 文件 | 描述 | -| -------- | -------- | -| [icamera_device.h](icamera__device_8h.md) | Camera设备操作接口。 | -| [icamera_device_callback.h](icamera__device__callback_8h.md) | Camera设备的回调接口，主要包含Camera设备发生错误时和上报metadata的回调函数。 | -| [icamera_host.h](icamera__host_8h.md) | Camera服务的管理类，对上层提供HDI接口。 | -| [icamera_host_callback.h](icamera__host__callback_8h.md) | ICameraHost的回调接口，提供Camera设备和闪关灯状态变化的回调函数，回调函数由调用者实现。 | -| [ioffline_stream_operator.h](ioffline__stream__operator_8h.md) | 离线流的操作接口。 | -| [istream_operator.h](istream__operator_8h.md) | 流的操作接口。 | -| [istream_operator_callback.h](istream__operator__callback_8h.md) | [IStreamOperator](istream__operator_8h.md)相关的回调，这些回调均由调用者实现。 | -| [types.h](types_8h.md) | Camera模块HDI接口使用的数据类型。 | - - -### 类 - -| 类 | 描述 | -| -------- | -------- | -| [OHOS::Camera::ICameraDevice](_o_h_o_s_1_1_camera_1_1_i_camera_device.md) | Camera设备操作。[更多...](_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) | Camera设备操作回调。[更多...](_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) | Camera服务的管理类。[更多...](_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) | Camera服务的管理回调。[更多...](_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) | 离线流的操作类。[更多...](_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) | 流的操作类。[更多...](_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) | 流的操作回调类。[更多...](_o_h_o_s_1_1_camera_1_1_i_stream_operator_callback.md) | -| [OHOS::Camera::StreamInfo](_o_h_o_s_1_1_camera_1_1_stream_info.md) | 流信息，用于创建流时传入相关的配置参数。 [更多...](_o_h_o_s_1_1_camera_1_1_stream_info.md) | -| [OHOS::Camera::StreamAttribute](_o_h_o_s_1_1_camera_1_1_stream_attribute.md) | 流的属性。 [更多...](_o_h_o_s_1_1_camera_1_1_stream_attribute.md) | -| [OHOS::Camera::CaptureInfo](_o_h_o_s_1_1_camera_1_1_capture_info.md) | 捕获请求的相关信息。 [更多...](_o_h_o_s_1_1_camera_1_1_capture_info.md) | -| [OHOS::Camera::CaptureEndedInfo](_o_h_o_s_1_1_camera_1_1_capture_ended_info.md) | 捕获结束相关信息，用于捕获结束回调 **OnCaptureEnded**。 [更多...](_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) | 流错误信息，用于回调 **OnCaptureError**。 [更多...](_o_h_o_s_1_1_camera_1_1_capture_error_info.md) | - - -### 类型定义 - -| 类型定义 | 描述 | -| -------- | -------- | -| **OHOS::Camera::CameraAbility** = CameraMetadata | Camera设备能力集合。 | -| **OHOS::Camera::CameraSetting** = CameraMetadata | Camera设置参数，包括sensor帧率，3A相关参数等。 | -| **OHOS::Camera::MetaType** = int32_t | 整型。 | - - -### 枚举 - -| 枚举 | 描述 | -| -------- | -------- | -| [OHOS::Camera::CamRetCode](#camretcode) : int32_t {   OHOS::Camera::NO_ERROR = 0, OHOS::Camera::CAMERA_BUSY = -1, OHOS::Camera::INSUFFICIENT_RESOURCES = -2, OHOS::Camera::INVALID_ARGUMENT = -3,   OHOS::Camera::METHOD_NOT_SUPPORTED = -4, OHOS::Camera::CAMERA_CLOSED = -5, OHOS::Camera::DEVICE_ERROR = -6 } | HDI接口的返回值。 [更多...](#camretcode) | -| [OHOS::Camera::ResultCallbackMode](#resultcallbackmode) : int32_t { OHOS::Camera::PER_FRAME, OHOS::Camera::ON_CHANGED } | metadata的上报模式。 [更多...](#resultcallbackmode) | -| [OHOS::Camera::OperationMode](#operationmode) : int32_t { OHOS::Camera::NORMAL = 0 } | 流的使用模式。 [更多...](#operationmode) | -| [OHOS::Camera::StreamIntent](#streamintent) : int32_t {   OHOS::Camera::PREVIEW = 0, OHOS::Camera::VIDEO = 1, OHOS::Camera::STILL_CAPTURE = 2, OHOS::Camera::POST_VIEW = 3,   OHOS::Camera::ANALYZE = 4, OHOS::Camera::CUSTOM = 5 } | 流的类型。 [更多...](#streamintent) | -| [OHOS::Camera::EncodeType](#encodetype) : int32_t { OHOS::Camera::ENCODE_TYPE_NULL = 0, OHOS::Camera::ENCODE_TYPE_H264 = 1, OHOS::Camera::ENCODE_TYPE_H265 = 2, OHOS::Camera::ENCODE_TYPE_JPEG = 3 } | 流数据的编码类型。 [更多...](#encodetype) | -| [OHOS::Camera::StreamSupportType](#streamsupporttype) : int32_t { OHOS::Camera::DYNAMIC_SUPPORTED, OHOS::Camera::RE_CONFIGURED_REQUIRED, OHOS::Camera::NOT_SUPPORTED } | 动态配置流的切换方式，使用场景参考 [IsStreamsSupported](#isstreamssupported) 。 [更多...](#streamsupporttype) | -| [OHOS::Camera::CameraStatus](#camerastatus) { OHOS::Camera::UN_AVAILABLE = 0, OHOS::Camera::AVAILABLE = 1 } | Camera设备状态。 [更多...](#camerastatus) | -| [OHOS::Camera::FlashlightStatus](#flashlightstatus) : uint32_t { OHOS::Camera::FLASHLIGHT_OFF = 0, OHOS::Camera::FLASHLIGHT_ON = 1, OHOS::Camera::FLASHLIGHT_UNAVAILABLE = 2 } | 闪光灯状态。 [更多...](#flashlightstatus) | -| [OHOS::Camera::CameraEvent](#cameraevent): uint32_t { OHOS::Camera::CAMERA_EVENT_DEVICE_ADD = 0, OHOS::Camera::CAMERA_EVENT_DEVICE_RMV = 1 } | Camera事件。 [更多...](#cameraevent) | -| [OHOS::Camera::ErrorType](#errortype) : uint32_t { OHOS::Camera::FATAL_ERROR = 0, OHOS::Camera::REQUEST_TIMEOUT = 1 } | 设备错误类型，用于设备错误回调 [OnError](#onerror)。 [更多...](#errortype) | -| [OHOS::Camera::StreamError](#streamerror) { OHOS::Camera::UNKNOWN_ERROR = 0, OHOS::Camera::BUFFER_LOST = 1 } | 流错误类型，用于流错误类型 [CaptureErrorInfo](_o_h_o_s_1_1_camera_1_1_capture_error_info.md)。 [更多...](#streamerror) | - - -### 函数 - -| 函数 | 描述 | -| -------- | -------- | -| **OHOS::Camera::ICameraDevice::DECLARE_INTERFACE_DESCRIPTOR** (u"HDI.Camera.V1_0.Device") | IPC通信token校验。 | -| [OHOS::Camera::ICameraDevice::GetStreamOperator](#getstreamoperator) (const OHOS::sptr< [IStreamOperatorCallback](_o_h_o_s_1_1_camera_1_1_i_stream_operator_callback.md) > &callback, OHOS::sptr< [IStreamOperator](_o_h_o_s_1_1_camera_1_1_i_stream_operator.md) > &streamOperator)=0 | 获取流操作句柄。 [更多...](#getstreamoperator) | -| [OHOS::Camera::ICameraDevice::UpdateSettings](#updatesettings) (const std::shared_ptr< CameraSetting > &settings)=0 | 更新设备控制参数。 [更多...](#updatesettings) | -| [OHOS::Camera::ICameraDevice::SetResultMode](#setresultmode) (const [ResultCallbackMode](#resultcallbackmode) &mode)=0 | 设置metadata上报模式，逐帧上报还是设备状态变化时上报。 [更多...](#setresultmode) | -| [OHOS::Camera::ICameraDevice::GetEnabledResults](#getenabledresults) (std::vector< MetaType > &results)=0 | 查询使能的metadata。 [更多...](#getenabledresults) | -| [OHOS::Camera::ICameraDevice::EnableResult](#enableresult) (const std::vector< MetaType > &results)=0 | 打开metadata上报开关。 [更多...](#enableresult) | -| [OHOS::Camera::ICameraDevice::DisableResult](#disableresult) (const std::vector< MetaType > &results)=0 | 关闭metadata上报开关。 [更多...](#disableresult) | -| [OHOS::Camera::ICameraDevice::Close](#close) ()=0 | 关闭Camera设备。 [更多...](#close) | -| **OHOS::Camera::ICameraDeviceCallback::DECLARE_INTERFACE_DESCRIPTOR** (u"HDI.Camera.V1_0.DeviceCallback") | IPC通信token校验。 | -| [OHOS::Camera::ICameraDeviceCallback::OnError](#onerror) ([ErrorType](#errortype) type, int32_t errorCode)=0 | 设备发生错误时调用，由调用者实现，用于返回错误信息给调用者。 [更多...](#onerror) | -| [OHOS::Camera::ICameraDeviceCallback::OnResult](#onresult) (uint64_t timestamp, const std::shared_ptr< CameraMetadata > &result)=0 | 上报Camera设备相关的metadata的回调，上报方式查看 [SetResultMode](#setresultmode)。 [更多...](#onresult) | -| **OHOS::Camera::ICameraHost::DECLARE_INTERFACE_DESCRIPTOR** (u"HDI.Camera.V1_0.Host") | IPC通信token校验。 | -| [OHOS::Camera::ICameraHost::Get](#get) (const char \*serviceName) | 获取ICameraHost实例。 [更多...](#get) | -| [OHOS::Camera::ICameraHost::SetCallback](#setcallback) (const OHOS::sptr< [ICameraHostCallback](_o_h_o_s_1_1_camera_1_1_i_camera_host_callback.md) > &callback)=0 | 设置ICameraHost回调接口，回调函数参考 [ICameraHostCallback](_o_h_o_s_1_1_camera_1_1_i_camera_host_callback.md)。 [更多...](#setcallback) | -| [OHOS::Camera::ICameraHost::GetCameraIds](#getcameraids) (std::vector< std::string > &cameraIds)=0 | 获取当前可用的Camera设备ID列表。 [更多...](#getcameraids) | -| [OHOS::Camera::ICameraHost::GetCameraAbility](#getcameraability) (const std::string &cameraId, std::shared_ptr< CameraAbility > &ability)=0 | 获取Camera设备能力集合。 [更多...](#getcameraability) | -| [OHOS::Camera::ICameraHost::OpenCamera](#opencamera) (const std::string &cameraId, const OHOS::sptr< [ICameraDeviceCallback](_o_h_o_s_1_1_camera_1_1_i_camera_device_callback.md) > &callback, OHOS::sptr< [ICameraDevice](_o_h_o_s_1_1_camera_1_1_i_camera_device.md) > &device)=0 | 打开Camera设备。 [更多...](#opencamera) | -| [OHOS::Camera::ICameraHost::SetFlashlight](#setflashlight) (const std::string &cameraId, bool &isEnable)=0 | 打开或关闭闪光灯。 [更多...](#setflashlight) | -| **OHOS::Camera::ICameraHostCallback::DECLARE_INTERFACE_DESCRIPTOR** (u"HDI.Camera.V1_0.HostCallback") | IPC通信token校验。 | -| [OHOS::Camera::ICameraHostCallback::OnCameraStatus](#oncamerastatus) (const std::string &cameraId, [CameraStatus](#camerastatus) status)=0 | 用于Camera设备状态变化时上报状态信息给调用者。 [更多...](#oncamerastatus) | -| [OHOS::Camera::ICameraHostCallback::OnFlashlightStatus](#onflashlightstatus) (const std::string &cameraId, [FlashlightStatus](#flashlightstatus) status)=0 | 用于在闪光灯状态变化时上报状态信息给调用者。 [更多...](#onflashlightstatus) | -| [OHOS::Camera::ICameraHostCallback::OnCameraEvent](#oncameraevent) (const std::string &cameraId, [CameraEvent](#cameraevent) event)=0 | 在相机事件发生时调用。 [更多...](#oncameraevent) | -| **OHOS::Camera::IOfflineStreamOperator::DECLARE_INTERFACE_DESCRIPTOR** (u"HDI.Camera.V1_0.OfflineStreamOperator") | IPC通信token校验。 | -| [OHOS::Camera::IOfflineStreamOperator::CancelCapture](#cancelcapture-12) (int captureId)=0 | 取消捕获请求。 [更多...](#cancelcapture-12) | -| [OHOS::Camera::IOfflineStreamOperator::ReleaseStreams](#releasestreams-12) (const std::vector< int > &streamIds)=0 | 释放离线流。 [更多...](#releasestreams-12) | -| [OHOS::Camera::IOfflineStreamOperator::Release](#release) ()=0 | 释放所有离线流。 [更多...](#release) | -| **OHOS::Camera::IStreamOperator::DECLARE_INTERFACE_DESCRIPTOR** (u"HDI.Camera.V1_0.StreamOperator") | IPC通信token校验。 | -| [OHOS::Camera::IStreamOperator::IsStreamsSupported](#isstreamssupported) ([OperationMode](#operationmode) mode, const std::shared_ptr< CameraMetadata > &modeSetting, const std::vector< std::shared_ptr< [StreamInfo](_o_h_o_s_1_1_camera_1_1_stream_info.md) >> &info, [StreamSupportType](#streamsupporttype) &type)=0 | 查询是否支持添加参数对应的流 [更多...](#isstreamssupported) | -| [OHOS::Camera::IStreamOperator::CreateStreams](#createstreams) (const std::vector< std::shared_ptr< [StreamInfo](_o_h_o_s_1_1_camera_1_1_stream_info.md) >> &streamInfos)=0 | 创建流。 [更多...](#createstreams) | -| [OHOS::Camera::IStreamOperator::ReleaseStreams](#releasestreams-22) (const std::vector< int > &streamIds)=0 | 释放流。 [更多...](#releasestreams-22) | -| [OHOS::Camera::IStreamOperator::CommitStreams](#commitstreams) ([OperationMode](#operationmode) mode, const std::shared_ptr< CameraMetadata > &modeSetting)=0 | 配置流。 [更多...](#commitstreams) | -| [OHOS::Camera::IStreamOperator::GetStreamAttributes](#getstreamattributes) (std::vector< std::shared_ptr< [StreamAttribute](_o_h_o_s_1_1_camera_1_1_stream_attribute.md) >> &attributes)=0 | 获取流的属性。 [更多...](#getstreamattributes) | -| [OHOS::Camera::IStreamOperator::AttachBufferQueue](#attachbufferqueue) (int streamId, const OHOS::sptr< OHOS::IBufferProducer > &producer)=0 | 绑定生产者句柄和指定流。 [更多...](#attachbufferqueue) | -| [OHOS::Camera::IStreamOperator::DetachBufferQueue](#detachbufferqueue) (int streamId)=0 | 解除生产者句柄和指定流的绑定关系。 [更多...](#detachbufferqueue) | -| [OHOS::Camera::IStreamOperator::Capture](#capture) (int captureId, const std::shared_ptr< [CaptureInfo](_o_h_o_s_1_1_camera_1_1_capture_info.md) > &info, bool isStreaming)=0 | 捕获图像。 [更多...](#capture) | -| [OHOS::Camera::IStreamOperator::CancelCapture](#cancelcapture-22) (int captureId)=0 | 取消捕获。 [更多...](#cancelcapture-22) | -| [OHOS::Camera::IStreamOperator::ChangeToOfflineStream](#changetoofflinestream) (const std::vector< int > &streamIds, OHOS::sptr< [IStreamOperatorCallback](_o_h_o_s_1_1_camera_1_1_i_stream_operator_callback.md) > &callback, OHOS::sptr< [IOfflineStreamOperator](_o_h_o_s_1_1_camera_1_1_i_offline_stream_operator.md) > &offlineOperator)=0 | 将指定流转换成离线流。 [更多...](#changetoofflinestream) | -| **OHOS::Camera::IStreamOperatorCallback::DECLARE_INTERFACE_DESCRIPTOR** (u"HDI.Camera.V1_0.StreamOperatorCallback") | IPC通信token校验。 | -| [OHOS::Camera::IStreamOperatorCallback::OnCaptureStarted](#oncapturestarted) (int32_t captureId, const std::vector< int32_t > &streamIds)=0 | 捕获开始回调，在捕获开始时调用。 [更多...](#oncapturestarted) | -| [OHOS::Camera::IStreamOperatorCallback::OnCaptureEnded](#oncaptureended) (int32_t captureId, const std::vector< std::shared_ptr< [CaptureEndedInfo](_o_h_o_s_1_1_camera_1_1_capture_ended_info.md) >> &infos)=0 | 捕获结束回调，在捕获结束时调用。 [更多...](#oncaptureended) | -| [OHOS::Camera::IStreamOperatorCallback::OnCaptureError](#oncaptureerror) (int32_t captureId, const std::vector< std::shared_ptr< [CaptureErrorInfo](_o_h_o_s_1_1_camera_1_1_capture_error_info.md) >> &infos)=0 | 捕获错误回调，在捕获过程中发生错误时调用。 [更多...](#oncaptureerror) | -| [OHOS::Camera::IStreamOperatorCallback::OnFrameShutter](#onframeshutter) (int32_t captureId, const std::vector< int32_t > &streamIds, uint64_t timestamp)=0 | 帧捕获回调。 [更多...](#onframeshutter) | - - -### 变量 - -| 变量 | 描述 | -| -------- | -------- | -| [OHOS::Camera::StreamInfo::streamId_](#streamid-14) | 流的ID，用于在设备内唯一标识一条流。 | -| [OHOS::Camera::StreamInfo::width_](#width-12) | 图像宽度。 | -| [OHOS::Camera::StreamInfo::height_](#height-12) | 图像高度。 | -| [OHOS::Camera::StreamInfo::format_](#format) | 图像格式。 | -| [OHOS::Camera::StreamInfo::dataspace_](#dataspace) | 图像颜色空间。 | -| [OHOS::Camera::StreamInfo::intent_](#intent) | 流类型。 | -| [OHOS::Camera::StreamInfo::tunneledMode_](#tunneledmode) | 隧道模式，值为true时开启，false关闭。 | -| [OHOS::Camera::StreamInfo::bufferQueue_](#bufferqueue) | 图形提供的生产者句柄。 | -| [OHOS::Camera::StreamInfo::minFrameDuration_](#minframeduration) | 最小帧间隔。 | -| [OHOS::Camera::StreamInfo::encodeType_](#encodetype) | 编码类型。 | -| [OHOS::Camera::StreamAttribute::streamId_](#streamid-24) | 流的ID，用于在设备内唯一标识一条流。 | -| [OHOS::Camera::StreamAttribute::width_](#width-22) | 图像宽度。 | -| [OHOS::Camera::StreamAttribute::height_](#height-22) | 图像高度。 | -| [OHOS::Camera::StreamAttribute::overrideFormat_](#overrideformat) | 重写的图像格式。 | -| [OHOS::Camera::StreamAttribute::overrideDataspace_](#overridedataspace) | 重写的图像颜色空间。 | -| [OHOS::Camera::StreamAttribute::producerUsage_](#producerusage) | 重写后的生产者的使用方式。 | -| [OHOS::Camera::StreamAttribute::producerBufferCount_](#producerbuffercount) | 重写后的生产者缓存数量。 | -| [OHOS::Camera::StreamAttribute::maxBatchCaptureCount_](#maxbatchcapturecount) | 连拍支持的最大捕获帧数量。 | -| [OHOS::Camera::StreamAttribute::maxCaptureCount_](#maxcapturecount) | 最大的并发捕获请求个数，默认为1。 | -| [OHOS::Camera::CaptureInfo::streamIds_](#streamids) | 捕获的流ID集合。 | -| [OHOS::Camera::CaptureInfo::captureSetting_](#capturesetting) | 捕获的配置信息。 | -| [OHOS::Camera::CaptureInfo::enableShutterCallback_](#enableshuttercallback) | 使能捕获回调。 | -| [OHOS::Camera::CaptureEndedInfo::streamId_](#streamid-34) | 捕获的流ID。 | -| [OHOS::Camera::CaptureEndedInfo::frameCount_](#framecount) | 捕获结束时已经抓取的帧数。 | -| [OHOS::Camera::CaptureErrorInfo::streamId_](#streamid-44) | 流ID。 | -| [OHOS::Camera::CaptureErrorInfo::error_](#error) | 错误类型。 | - - -## **详细描述** - -Camera模块接口定义。 - -Camera模块涉及相机设备的操作、流的操作、离线流的操作和各种回调等。 - -**Since：** - -1.0 - - -## **枚举类型说明** - - -### CameraEvent - - -``` -enum OHOS::Camera::CameraEvent : uint32_t -``` - -**描述：** - -Camera事件。 - -| 枚举值 | **描述** | -| -------- | -------- | -| CAMERA_EVENT_DEVICE_ADD | Camera设备增加事件。 | -| CAMERA_EVENT_DEVICE_RMV | Camera设备删除事件。 | - - -### CameraStatus - - -``` -enum OHOS::Camera::CameraStatus -``` - -**描述：** - -Camera设备状态。 - -| 枚举值 | **描述** | -| -------- | -------- | -| UN_AVAILABLE | 设备当前不在位或者不可用。 | -| AVAILABLE | 设备当前可用。 | - - -### CamRetCode - - -``` -enum OHOS::Camera::CamRetCode : int32_t -``` - -**描述：** - -HDI接口的返回值。 - -| 枚举值 | **描述** | -| -------- | -------- | -| NO_ERROR | 调用成功。 | -| CAMERA_BUSY | 设备当前忙。 | -| INSUFFICIENT_RESOURCES | 资源不足。 | -| INVALID_ARGUMENT | 参数错误。 | -| METHOD_NOT_SUPPORTED | 不支持当前调用方法。 | -| CAMERA_CLOSED | Camera设备已经关闭。 | -| DEVICE_ERROR | 驱动层发生严重错误。 | - - -### EncodeType - - -``` -enum OHOS::Camera::EncodeType : int32_t -``` - -**描述：** - -流数据的编码类型。 - -| 枚举值 | **描述** | -| -------- | -------- | -| ENCODE_TYPE_NULL | 未设置编码类型。 | -| ENCODE_TYPE_H264 | 编码类型为H264。 | -| ENCODE_TYPE_H265 | 编码类型为H265。 | -| ENCODE_TYPE_JPEG | 编码类型为JPEG。 | - - -### ErrorType - - -``` -enum OHOS::Camera::ErrorType : uint32_t -``` - -**描述：** - -设备错误类型，用于设备错误回调 **OnError**。 - -| 枚举值 | **描述** | -| -------- | -------- | -| FATAL_ERROR | 严重错误，需要关闭Camera设备。 | -| REQUEST_TIMEOUT | 请求超时，需要关闭Camera设备。 | - - -### FlashlightStatus - - -``` -enum OHOS::Camera::FlashlightStatus : uint32_t -``` - -**描述：** - -闪光灯状态。 - -| 枚举值 | **描述** | -| -------- | -------- | -| FLASHLIGHT_OFF | 闪光灯关闭。 | -| FLASHLIGHT_ON | 闪光灯开启。 | -| FLASHLIGHT_UNAVAILABLE | 闪光灯当前不可用。 | - - -### OperationMode - - -``` -enum OHOS::Camera::OperationMode : int32_t -``` - -**描述：** - -流的使用模式。 - -| 枚举值 | **描述** | -| -------- | -------- | -| NORMAL | 普通模式。 | - - -### ResultCallbackMode - - -``` -enum OHOS::Camera::ResultCallbackMode : int32_t -``` - -**描述：** - -metadata的上报模式。 - -| 枚举值 | **描述** | -| -------- | -------- | -| PER_FRAME | 每帧上报。 | -| ON_CHANGED | 设备状态变化时上报。 | - - -### StreamError - - -``` -enum OHOS::Camera::StreamError -``` - -**描述：** - -流错误类型，用于流错误类型 [CaptureErrorInfo](_o_h_o_s_1_1_camera_1_1_capture_error_info.md)。 - -| 枚举值 | **描述** | -| -------- | -------- | -| UNKNOWN_ERROR | 流未知错误。 | -| BUFFER_LOST | 丢包。 | - - -### StreamIntent - - -``` -enum OHOS::Camera::StreamIntent : int32_t -``` - -**描述：** - -流的类型。 - -| 枚举值 | **描述** | -| -------- | -------- | -| PREVIEW | 流数据用于显示，即预览流。 | -| VIDEO | 流数据用于编码生成录像，即录像流。 | -| STILL_CAPTURE | 流数据用于编码生成照片，即拍照流。 | -| POST_VIEW | 流数据用于保存缩略图。 | -| ANALYZE | 流数据用于图像分析。 | -| CUSTOM | 自定义类型。 | - - -### StreamSupportType - - -``` -enum OHOS::Camera::StreamSupportType : int32_t -``` - -**描述：** - -动态配置流的切换方式，使用场景参考 [IsStreamsSupported](#isstreamssupported) 。 - -| 枚举值 | 描述 | -| -------- | -------- | -| DYNAMIC_SUPPORTED | 支持动态配置流，对应的流参数直接生效。 | -| RE_CONFIGURED_REQUIRED | 不支持动态配置流，对应的参数需要停止流然后重新配置流才能生效。 | -| NOT_SUPPORTED | 不支持对应的流参数配置。 | - - -## **函数说明** - - -### AttachBufferQueue() - - -``` -virtual CamRetCode OHOS::Camera::IStreamOperator::AttachBufferQueue (int streamId, const OHOS::sptr < OHOS::IBufferProducer > & producer ) -``` - -**描述：** - -绑定生产者句柄和指定流。 - -如果在 [CreateStreams](#createstreams) 创建流时已经指定了生产者句柄，则不需要调用该接口。如果需要重新绑定， 需先调用 [DetachBufferQueue](#detachbufferqueue) 进行解绑，然后再绑定。 对于一些IOT设备，可能不需要或者不支持预览流的图像数据缓存流转，那么不需要绑定生产者句柄， 此时在创建流时 [CreateStreams](#createstreams) 的 [StreamInfo](_o_h_o_s_1_1_camera_1_1_stream_info.md) 参数的生产者句柄bufferQueue_为空，而 tunneledMode_需设置为false。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| streamId | [IN] 用于标识要绑定的流。 | -| producer | [IN] 生产者句柄。 | - -**返回：** - -NO_ERROR 表示执行成功。 - -其他值表示执行失败，具体错误码查看 [CamRetCode](#camretcode)。 - -**参见：** - -[DetachBufferQueue](#detachbufferqueue) - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### CancelCapture() [1/2] - - -``` -virtual CamRetCode OHOS::Camera::IOfflineStreamOperator::CancelCapture (int captureId) -``` - -**描述：** - -取消捕获请求。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| captureId | [IN] 用于标识要取消的捕获请求。 | - -**返回：** - -NO_ERROR 表示执行成功。 - -其他值表示执行失败，具体错误码查看 [CamRetCode](#camretcode)。 - - -### CancelCapture() [2/2] - - -``` -virtual CamRetCode OHOS::Camera::IStreamOperator::CancelCapture (int captureId) -``` - -**描述：** - -取消捕获。 - -取消连续捕获时会调用 **OnCaptureEnded**。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| captureId | 用于标识要取消的捕获请求 | - -**返回：** - -NO_ERROR 表示执行成功。 - -其他值表示执行失败，具体错误码查看 [CamRetCode](#camretcode)。 - -**参见：** - -[Capture](#capture) - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### Capture() - - -``` -virtual CamRetCode OHOS::Camera::IStreamOperator::Capture (int captureId, const std::shared_ptr< CaptureInfo > & info, bool isStreaming ) -``` - -**描述：** - -捕获图像。 - -本接口必须在调用 [CommitStreams](#commitstreams) 配置流之后调用。 图像捕获有两种模式，分别是连续捕获和单次捕获。 - -- 连续捕获即触发之后模块内部进行连续的捕获， 消费者可以连续收到图像数据，不需要多次调用本接口，若再次调用了本接口， 则停止当前捕获，更新捕获信息，再进行一次新的捕获，多用于预览、录像或者连拍场景。 - -- 单次捕获即触发之后只捕获一帧图像数据，用于单次拍照场景。 捕获启动时，会调用 **OnCaptureStarted** 来通知调用者捕获已经启动。 - -连续捕获需调用 [CancelCapture](#cancelcapture-22) 来停止捕获。 捕获结束时，会调用 **OnCaptureEnded** 来通知调用者捕获的帧计数等信息。 [CaptureInfo](_o_h_o_s_1_1_camera_1_1_capture_info.md) 的 enableShutterCallback_ 使能 **OnFrameShutter**，使能后每次捕获触发 **OnFrameShutter** 对于多个流同时捕获的场景，本模块内部保证同时上报多路流捕获数据。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| captureId | [IN] 捕获请求的唯一标识，由调用者指定，调用者需保证在Camera设备打开期间，捕获请求ID是唯一的。 | -| info | [IN] 捕获请求的参数信息，具体信息查看 [CaptureInfo](_o_h_o_s_1_1_camera_1_1_capture_info.md)。 | -| isStreaming | [IN] 是否连续捕获，true表示连续捕获，否则为单次捕获。 | - -**返回：** - -NO_ERROR 表示执行成功。 - -其他值表示执行失败，具体错误码查看 [CamRetCode](#camretcode)。 - -**参见：** - -OnFrameShutter - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### ChangeToOfflineStream() - - -``` -virtual CamRetCode OHOS::Camera::IStreamOperator::ChangeToOfflineStream (const std::vector< int > & streamIds, OHOS::sptr< IStreamOperatorCallback > & callback, OHOS::sptr< IOfflineStreamOperator > & offlineOperator ) -``` - -**描述：** - -将指定流转换成离线流。 - -离线流只能由拍照流转换而来，其他流不支持。 一些设备处理能力有限，可能导致拍照时算法处理时间较长，从而引起捕获请求堆积在模块内部，而转换为离线 流之后，可关闭底层设备，由离线流接替，进行后续的处理。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| streamIds | [IN] 用于指定要转换成离线流的流集合。 | -| callback | [IN] 用于设置离线流的回调。 | -| offlineOperator | [OUT] 转换后的离线流。 | - -**返回：** - -NO_ERROR 表示执行成功； - -其他值表示执行失败，具体错误码查看 [CamRetCode](#camretcode)。 - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### Close() - - -``` -virtual void OHOS::Camera::ICameraDevice::Close () -``` - -**描述：** - -关闭Camera设备。 - -**参见：** - -[OpenCamera](#opencamera) - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### CommitStreams() - - -``` -virtual CamRetCode OHOS::Camera::IStreamOperator::CommitStreams (OperationMode mode, const std::shared_ptr< CameraMetadata > & modeSetting ) -``` - -**描述：** - -配置流。 - -本接口需在调用 [CreateStreams](#createstreams) 创建流之后调用。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| mode | [IN] 流运行的模式，支持的模式定义在 **OperationMode**。 | -| modeSetting | [IN] 流的配置参数，包括帧率，ZOOM等信息。 | - -**返回：** - -NO_ERROR 表示执行成功； - -其他值表示执行失败，具体错误码查看 [CamRetCode](#camretcode)。 - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### CreateStreams() - - -``` -virtual CamRetCode OHOS::Camera::IStreamOperator::CreateStreams (const std::vector< std::shared_ptr< StreamInfo >> & streamInfos) -``` - -**描述：** - -创建流。 - -此函数接口依据输入的流信息创建流，调用该接口之前需先通过 [IsStreamsSupported](#isstreamssupported) 查询HAL是否支持要创建的流。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| streamInfos | [IN] 流信息列表，流信息定义在 [StreamInfo](_o_h_o_s_1_1_camera_1_1_stream_info.md)。输入的流信息可能会被修改，需通过 [GetStreamAttributes](#getstreamattributes) 获取最新的流属性。 | - -**返回：** - -NO_ERROR 表示执行成功； - -其他值表示执行失败，具体错误码查看 [CamRetCode](#camretcode)。 - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### DetachBufferQueue() - - -``` -virtual CamRetCode OHOS::Camera::IStreamOperator::DetachBufferQueue (int streamId) -``` - -**描述：** - -解除生产者句柄和指定流的绑定关系。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| streamId | [IN] 用于标识要解除绑定的流。 | - -**返回：** - -NO_ERROR 表示执行成功； - -其他值表示执行失败，具体错误码查看[CamRetCode](#camretcode)。 - -**参见：** - -[AttachBufferQueue](#attachbufferqueue) - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### DisableResult() - - -``` -virtual CamRetCode OHOS::Camera::ICameraDevice::DisableResult (const std::vector< MetaType > & results) -``` - -**描述：** - -关闭metadata上报开关。 - -屏蔽之后，相应的**OnResult**不再上报，需 [EnableResult](#enableresult) 使能之后才上报。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| results | [IN] 需要关闭上报开关的metadata。 | - -**返回：** - -NO_ERROR 表示执行成功。 - -其他值表示执行失败，具体错误码查看 [CamRetCode](#camretcode)。 - -**参见：** - -[EnableResult](#enableresult) - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### EnableResult() - - -``` -virtual CamRetCode OHOS::Camera::ICameraDevice::EnableResult (const std::vector< MetaType > & results) -``` - -**描述：** - -打开metadata上报开关。 - -**OnResult** 只上报此接口使能后的metadata。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| results | [IN] 需要打开上报开关的metadata。 | - -**返回：** - -NO_ERROR 表示执行成功。 - -其他值表示执行失败，具体错误码查看 [CamRetCode](#camretcode)。 - -**参见：** - -[DisableResult](#disableresult) - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### Get() - - -``` -static sptr OHOS::Camera::ICameraHost::Get (const char * serviceName) -``` - -**描述：** - -获取ICameraHost实例。 - -此接口为Camera调用入口，需要先通过该接口获取ICameraHost实例，然后通过ICameraHost实例进行其它操作。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| serviceName | [IN] 要获取的ICameraHost实例的名称，当前实现中实例名称固定为camera_service。 | - -**返回：** - -成功返回ICameraHost实例，失败返回nullptr。 - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### GetCameraAbility() - - -``` -virtual CamRetCode OHOS::Camera::ICameraHost::GetCameraAbility (const std::string & cameraId, std::shared_ptr< CameraAbility > & ability ) -``` - -**描述：** - -获取Camera设备能力集合。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| cameraId | [IN] 用于指定要操作的Camera设备，通过 [GetCameraIds](#getcameraids) 获取。 | -| ability | [OUT] 返回cameraId对应Camera设备的能力集合。 | - -**返回：** - -NO_ERROR 表示执行成功。 - -其他值表示执行失败，具体错误码查看 [CamRetCode](#camretcode)。 - -**参见：** - -[GetCameraIds](#getcameraids) - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### GetCameraIds() - - -``` -virtual CamRetCode OHOS::Camera::ICameraHost::GetCameraIds (std::vector< std::string > & cameraIds) -``` - -**描述：** - -获取当前可用的Camera设备ID列表。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| cameraIds | [OUT] 返回当前可用的设备列表 | - -**返回：** - -NO_ERROR 表示执行成功。 - -其他值表示执行失败，具体错误码查看 [CamRetCode](#camretcode)。 - -**参见：** - -[GetCameraAbility](#getcameraability) - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### GetEnabledResults() - - -``` -virtual CamRetCode OHOS::Camera::ICameraDevice::GetEnabledResults (std::vector< MetaType > & results) -``` - -**描述：** - -查询使能的metadata。 - -[EnableResult](#enableresult) 使能需要上报的metadata之后，可通过此接口查询使能的metadata。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| results | [OUT] 所有使能的metadata。 | - -**返回：** - -NO_ERROR 表示执行成功。 - -其他值表示执行失败，具体错误码查看 [CamRetCode](#camretcode)。 - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### GetStreamAttributes() - - -``` -virtual CamRetCode OHOS::Camera::IStreamOperator::GetStreamAttributes (std::vector< std::shared_ptr< StreamAttribute >> & attributes) -``` - -**描述：** - -获取流的属性。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| attributes | [OUT] 用于获取流的属性。在调用[CreateStreams](#createstreams) 时，通过参数streamInfos携带的流信息可能会被重写，因此通过该接口获取的流属性可能会和 [CreateStreams](#createstreams) 输入的流信息存在差异。 | - -**返回：** - -NO_ERROR 表示执行成功。 - -其他值表示执行失败，具体错误码查看 [CamRetCode](#camretcode)。 - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### GetStreamOperator() - - -``` -virtual CamRetCode OHOS::Camera::ICameraDevice::GetStreamOperator (const OHOS::sptr< IStreamOperatorCallback > & callback, OHOS::sptr< IStreamOperator > & streamOperator ) -``` - -**描述：** - -获取流操作句柄。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| callback | [IN] 设置流回调接口，详细可查看 [IStreamOperatorCallback](_o_h_o_s_1_1_camera_1_1_i_stream_operator_callback.md)， 用于上报捕获开始 **OnCaptureStarted**，捕获结束 **OnCaptureEnded**， **OnCaptureError** 捕获错误等信息。 | -| streamOperator | [OUT] 返回流操作句柄。 | - -**返回：** - -NO_ERROR 表示执行成功。 - -其他值表示执行失败，具体错误码查看 [CamRetCode](#camretcode)。 - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### IsStreamsSupported() - - -``` -virtual CamRetCode OHOS::Camera::IStreamOperator::IsStreamsSupported (OperationMode mode, const std::shared_ptr< CameraMetadata > & modeSetting, const std::vector< std::shared_ptr< StreamInfo >> & info, StreamSupportType & type ) -``` - -**描述：** - -查询是否支持添加参数对应的流。 - -流是指从底层设备输出，经本模块内部各环节处理，最终传递到上层服务或者应用的一组数据序列 本模块支持的流的类型有预览流，录像流，拍照流等，更多类型可查看 **StreamIntent**。 - -此函数接口根据输入的运行模式和配置信息以及当前模块中正在运行的流，查询是否支持动态添加流。 - -- 如果本模块支持在不停止其他流的情况下添加新流，或者即使停止其他流但上层服务或应用不感知，则通过type参数返回DYNAMIC_SUPPORTED，上层服务或应用可以直接添加新流。 - -- 如果本模块支持添加新流但需要上层服务或应用先停止所有流的捕获，则通过type参数返回RE_CONFIGURED_REQUIRED。 - -- 如果不支持添加输入的新流，则返回NOT_SUPPORTED。 - -此函数需要在调用 [CreateStreams](#createstreams) 创建流之前调用。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| mode | [IN] 流运行的模式，支持的模式参考 **OperationMode**。 | -| modeSetting | [IN] 流的配置，包括帧率，3A等配置信息。 | -| info | [IN] 流的配置信息，具体参考 [StreamInfo](_o_h_o_s_1_1_camera_1_1_stream_info.md)。 | -| type | [OUT] 对动态配置流的支持类型，支持类型定义在 **StreamSupportType**。 | - -**返回：** - -NO_ERROR 表示执行成功。 - -其他值表示执行失败，具体错误码查看 [CamRetCode](#camretcode)。 - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### OnCameraEvent() - - -``` -virtual void OHOS::Camera::ICameraHostCallback::OnCameraEvent (const std::string & cameraId, CameraEvent event ) -``` - -**描述：** - -在相机事件发生时调用。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| cameraId | 表示相机事件绑定的相机ID。 | -| event | 表示相机事件类型。 | - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### OnCameraStatus() - - -``` -virtual void OHOS::Camera::ICameraHostCallback::OnCameraStatus (const std::string & cameraId, CameraStatus status ) -``` - -**描述：** - -用于Camera设备状态变化时上报状态信息给调用者。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| cameraId | [IN] 状态发生变化的Camera设备ID。 | -| status | [IN] 最新的设备状态。 | - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### OnCaptureEnded() - - -``` -virtual void OHOS::Camera::IStreamOperatorCallback::OnCaptureEnded (int32_t captureId, const std::vector< std::shared_ptr< CaptureEndedInfo >> & infos ) -``` - -**描述：** - -捕获结束回调，在捕获结束时调用。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| captureId | [IN] 用于标识回调对应的捕获请求。 | -| infos | [IN] 捕获结束相关信息。 | - -**参见：** - -[OnCaptureStarted](#oncapturestarted) - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### OnCaptureError() - - -``` -virtual void OHOS::Camera::IStreamOperatorCallback::OnCaptureError (int32_t captureId, const std::vector< std::shared_ptr< CaptureErrorInfo >> & infos ) -``` - -**描述：** - -捕获错误回调，在捕获过程中发生错误时调用。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| captureId | [IN] 用于标识回调对应的捕获请求。 | -| infos | [IN] 捕获错误信息列表。 | - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### OnCaptureStarted() - - -``` -virtual void OHOS::Camera::IStreamOperatorCallback::OnCaptureStarted (int32_t captureId, const std::vector< int32_t > & streamIds ) -``` - -**描述：** - -捕获开始回调，在捕获开始时调用。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| captureId | [IN] 用于标识回调对应的捕获请求。 | -| streamIds | [IN] 回调对应的流集合。 | - -**参见：** - -[OnCaptureEnded](#oncaptureended) - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### OnError() - - -``` -virtual void OHOS::Camera::ICameraDeviceCallback::OnError (ErrorType type, int32_t errorCode ) -``` - -**描述：** - -设备发生错误时调用，由调用者实现，用于返回错误信息给调用者。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| type | [IN] 错误类型，具体错误类型可参考 **ErrorType**。 | -| errorCode | [IN] 错误码，当前暂未使用。 | - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### OnFlashlightStatus() - - -``` -virtual void OHOS::Camera::ICameraHostCallback::OnFlashlightStatus (const std::string & cameraId, FlashlightStatus status ) -``` - -**描述：** - -用于在闪光灯状态变化时上报状态信息给调用者。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| cameraId | [IN] 状态发生变化的闪关灯所绑定的Camera设备ID。 | -| status | [IN] 最新的闪光灯状态。 | - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### OnFrameShutter() - - -``` -virtual void OHOS::Camera::IStreamOperatorCallback::OnFrameShutter (int32_t captureId, const std::vector< int32_t > & streamIds, uint64_t timestamp ) -``` - -**描述：** - -帧捕获回调。 - -通过 **Capture** 的输入参数 [CaptureInfo](_o_h_o_s_1_1_camera_1_1_capture_info.md) 的enableShutterCallback_使能该回调， 使能后每次捕获均会触发此回调。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| captureId | [IN] 用于标识回调对应的捕获请求。 | -| streamIds | [IN] 回调对应的流集合。 | -| timestamp | [IN] 该接口被调用时的时间戳。 | - -**参见：** - -Capture - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### OnResult() - - -``` -virtual void OHOS::Camera::ICameraDeviceCallback::OnResult (uint64_t timestamp, const std::shared_ptr< CameraMetadata > & result ) -``` - -**描述：** - -上报Camera设备相关的metadata的回调，上报方式查看 [SetResultMode](#setresultmode)。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| timestamp | [IN] metadata上报的时间戳。 | -| result | [IN] 上报的metadata，上报的metadata由 **EnableResult** 指定， 可通过 **GetEnabledResults** 查询，**DisableResult** 关闭上报开关。 | - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### OpenCamera() - - -``` -virtual CamRetCode OHOS::Camera::ICameraHost::OpenCamera (const std::string & cameraId, const OHOS::sptr< ICameraDeviceCallback > & callback, OHOS::sptr< ICameraDevice > & device ) -``` - -**描述：** - -打开Camera设备。 - -打开指定的Camera设备，通过此接口可以获取到ICameraDevice对象，通过ICameraDevice对象可以操作具体的Camera设备。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| cameraId | [IN] 需要打开的Camera设备ID，可通过 [GetCameraIds](#getcameraids) 接口获取当前已有Camera设备列表。 | -| callback | [IN] Camera设备相关的回调函数，具体参见 [ICameraDeviceCallback](_o_h_o_s_1_1_camera_1_1_i_camera_device_callback.md)。 | -| device | [OUT] 返回当前要打开的Camera设备ID对应的ICameraDevice对象。 | - -**返回：** - -NO_ERROR 表示执行成功； - -其他值表示执行失败，具体错误码查看 [CamRetCode](#camretcode)。 - -**参见：** - -[GetCameraIds](#getcameraids) - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### Release() - - -``` -virtual CamRetCode OHOS::Camera::IOfflineStreamOperator::Release () -``` - -**描述：** - -释放所有离线流。 - -**返回：** - -NO_ERROR 表示执行成功； - -其他值表示执行失败，具体错误码查看 [CamRetCode](#camretcode)。 - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### ReleaseStreams() [1/2] - - -``` -virtual CamRetCode OHOS::Camera::IOfflineStreamOperator::ReleaseStreams (const std::vector< int > & streamIds) -``` - -**描述：** - -释放离线流。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| streamIds | 用于标识要释放的离线流集合。 | - -**返回：** - -NO_ERROR 表示执行成功。 - -其他值表示执行失败，具体错误码查看 [CamRetCode](#camretcode)。 - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### ReleaseStreams() [2/2] - - -``` -virtual CamRetCode OHOS::Camera::IStreamOperator::ReleaseStreams (const std::vector< int > & streamIds) -``` - -**描述：** - -释放流。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| streamIds | [IN] 要释放的流ID列表。 | - -**返回：** - -NO_ERROR 表示执行成功； - -其他值表示执行失败，具体错误码查看 [CamRetCode](#camretcode)。 - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### SetCallback() - - -``` -virtual CamRetCode OHOS::Camera::ICameraHost::SetCallback (const OHOS::sptr< ICameraHostCallback > & callback) -``` - -**描述：** - -设置ICameraHost回调接口，回调函数参考 [ICameraHostCallback](_o_h_o_s_1_1_camera_1_1_i_camera_host_callback.md)。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| callback | [IN] 要设置的回调函数。 | - -**返回：** - -NO_ERROR 表示执行成功。 - -其他值表示执行失败，具体错误码查看 [CamRetCode](#camretcode)。 - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### SetFlashlight() - - -``` -virtual CamRetCode OHOS::Camera::ICameraHost::SetFlashlight (const std::string & cameraId, bool & isEnable ) -``` - -**描述：** - -打开或关闭闪光灯。 - -该接口只能由打开cameraId指定Camera设备的调用者调用。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| cameraId | [IN] 闪光灯对应的Camera设备ID。 | -| isEnable | [IN] true打开闪光灯，false关闭闪光灯。 | - -**返回：** - -NO_ERROR 表示执行成功。 - -其他值表示执行失败，具体错误码查看 [CamRetCode](#camretcode)。 - -**参见：** - -[GetCameraIds](#getcameraids) - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### SetResultMode() - - -``` -virtual CamRetCode OHOS::Camera::ICameraDevice::SetResultMode (const ResultCallbackMode & mode) -``` - -**描述：** - -设置metadata上报模式，逐帧上报还是设备状态变化时上报。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| mode | [IN] metadata的上报模式，逐帧上报或者设备状态变化时上报，查看 **ResultCallbackMode**。 | - -**返回：** - -NO_ERROR 表示执行成功。 - -其他值表示执行失败，具体错误码查看 [CamRetCode](#camretcode)。 - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### UpdateSettings() - - -``` -virtual CamRetCode OHOS::Camera::ICameraDevice::UpdateSettings (const std::shared_ptr< CameraSetting > & settings) -``` - -**描述：** - -更新设备控制参数。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| settings | [IN] Camera设置参数，包括sensor帧率，3A相关参数等。 | - -**返回：** - -NO_ERROR 表示执行成功。 - -其他值表示执行失败，具体错误码查看 [CamRetCode](#camretcode)。 - -**Since：** - -1.0 - -**Version：** - -1.0 - - -## **变量说明** - - -### bufferQueue_ - - -``` -OHOS::sptr OHOS::Camera::StreamInfo::bufferQueue_ -``` - -**描述：** - -图形提供的生产者句柄。 - - -### captureSetting_ - - -``` -std::shared_ptr OHOS::Camera::CaptureInfo::captureSetting_ -``` - -**描述：** - -捕获的配置信息。 - - -### dataspace_ - - -``` -int OHOS::Camera::StreamInfo::dataspace_ -``` - -**描述：** - -图像颜色空间。 - - -### enableShutterCallback_ - - -``` -bool OHOS::Camera::CaptureInfo::enableShutterCallback_ -``` - -**描述：** - -使能捕获回调，每一次捕获后都会触发 **OnFrameShutter**。 - - -### encodeType_ - - -``` -EncodeType OHOS::Camera::StreamInfo::encodeType_ -``` - -**描述：** - -编码类型。 - - -### error_ - - -``` -StreamError OHOS::Camera::CaptureErrorInfo::error_ -``` - -**描述：** - -错误类型。 - - -### format_ - - -``` -int OHOS::Camera::StreamInfo::format_ -``` - -**描述：** - -图像格式。 - - -### frameCount_ - - -``` -int OHOS::Camera::CaptureEndedInfo::frameCount_ -``` - -**描述：** - -捕获结束时已经抓取的帧数。 - - -### height_ [1/2] - - -``` -int OHOS::Camera::StreamInfo::height_ -``` - -**描述：** - -图像高度。 - - -### height_ [2/2] - - -``` -int OHOS::Camera::StreamAttribute::height_ -``` - -**描述：** - -图像高度。 - - -### intent_ - - -``` -StreamIntent OHOS::Camera::StreamInfo::intent_ -``` - -**描述：** - -流类型。 - - -### maxBatchCaptureCount_ - - -``` -int OHOS::Camera::StreamAttribute::maxBatchCaptureCount_ -``` - -**描述：** - -连拍支持的最大捕获帧数量。 - - -### maxCaptureCount_ - - -``` -int OHOS::Camera::StreamAttribute::maxCaptureCount_ -``` - -**描述：** - -最大的并发捕获请求个数，默认为1。 - - -### minFrameDuration_ - - -``` -int OHOS::Camera::StreamInfo::minFrameDuration_ -``` - -**描述：** - -最小帧间隔。 - - -### overrideDataspace_ - - -``` -int OHOS::Camera::StreamAttribute::overrideDataspace_ -``` - -**描述：** - -重写的图像颜色空间。 - - -### overrideFormat_ - - -``` -int OHOS::Camera::StreamAttribute::overrideFormat_ -``` - -**描述：** - -重写的图像格式。 - - -### producerBufferCount_ - - -``` -int OHOS::Camera::StreamAttribute::producerBufferCount_ -``` - -**描述：** - -重写后的生产者缓存数量。 - - -### producerUsage_ - - -``` -int OHOS::Camera::StreamAttribute::producerUsage_ -``` - -**描述：** - -重写后的生产者的使用方式。 - - -### streamId_ [1/4] - - -``` -int OHOS::Camera::StreamInfo::streamId_ -``` - -**描述：** - -流的ID，用于在设备内唯一标识一条流。 - - -### streamId_ [2/4] - - -``` -int OHOS::Camera::StreamAttribute::streamId_ -``` - -**描述：** - -流的ID，用于在设备内唯一标识一条流。 - - -### streamId_ [3/4] - - -``` -int OHOS::Camera::CaptureEndedInfo::streamId_ -``` - -**描述：** - -捕获的流ID。 - - -### streamId_ [4/4] - - -``` -int OHOS::Camera::CaptureErrorInfo::streamId_ -``` - -**描述：** - -流ID。 - - -### streamIds_ - - -``` -std::vector OHOS::Camera::CaptureInfo::streamIds_ -``` - -**描述：** - -捕获的流ID集合。 - - -### tunneledMode_ - - -``` -bool OHOS::Camera::StreamInfo::tunneledMode_ -``` - -**描述：** - -隧道模式，值为true时开启，false关闭。 - -开启隧道模式后，HAL不直接和上层交互，通过图形提供的生产者句柄来传递帧数据， 对于一些IOT设备，可能不需要或者不支持预览流的图像数据缓存流转，此时需要关闭隧道模式。 - - -### width_ [1/2] - - -``` -int OHOS::Camera::StreamInfo::width_ -``` - -**描述：** - -图像宽度。 - - -### width_ [2/2] - - -``` -int OHOS::Camera::StreamAttribute::width_ -``` - -**描述：** - -图像宽度。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_capture_ended_info.md b/zh-cn/device-dev/reference/hdi-apis/_capture_ended_info.md new file mode 100644 index 0000000000000000000000000000000000000000..d7e78cd69f34dee27853269c19d48b5589951e0d --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_capture_ended_info.md @@ -0,0 +1,48 @@ +# 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。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_capture_error_info.md b/zh-cn/device-dev/reference/hdi-apis/_capture_error_info.md new file mode 100644 index 0000000000000000000000000000000000000000..76cda626af0b840ad2d2ebe5e8493c2bfa5714b2 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_capture_error_info.md @@ -0,0 +1,48 @@ +# 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。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_capture_info.md b/zh-cn/device-dev/reference/hdi-apis/_capture_info.md new file mode 100644 index 0000000000000000000000000000000000000000..b6b69fa0dc996f00361e19f6927c7a48ae7999dc --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_capture_info.md @@ -0,0 +1,61 @@ +# 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集合。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_codec.md b/zh-cn/device-dev/reference/hdi-apis/_codec.md deleted file mode 100644 index f3eea39775c59854ce737f602b09aed8711e69fd..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_codec.md +++ /dev/null @@ -1,1346 +0,0 @@ -# Codec - - -## **汇总** - - -### 文件 - - | 文件 | 描述 | -| -------- | -------- | -| [codec_callback_if.h](codec__callback__if_8h.md) | 主要包括回调函数接口定义。 | -| [codec_common_type.h](codec__common__type_8h.md) | Codec模块接口定义中使用的自定义数据类型。 | -| [codec_component_if.h](codec__component__if_8h.md) | 主要包括Codec组件接口定义。 | -| [codec_component_manager.h](codec__component__manager_8h.md) | 主要包括Codec组件管理类接口。 | -| [codec_component_type.h](codec__component__type_8h.md) | Codec模块接口定义中使用的自定义数据类型。 | - - -### 类 - - | 类 | 描述 | -| -------- | -------- | -| [CodecCallbackType](_codec_callback_type.md) | Codec回调接口定义。 [更多...](_codec_callback_type.md) | -| [Alignment](_alignment.md) | 对齐结构定义，包含宽高的对齐值。 [更多...](_alignment.md) | -| [Rect](_rect.md) | 矩形的定义。 [更多...](_rect.md) | -| [RangeValue](_range_value.md) | 取值范围的定义。 [更多...](_range_value.md) | -| [CodecComponentType](_codec_component_type.md) | Codec组件接口定义。 [更多...](_codec_component_type.md) | -| [CodecComponentManager](_codec_component_manager.md) | Codec组件管理类接口定义。 [更多...](_codec_component_manager.md) | -| [VideoPortCap](_video_port_cap.md) | 定义视频编解码能力。 [更多...](_video_port_cap.md) | -| [AudioPortCap](_audio_port_cap.md) | 定义音频编解码能力。 [更多...](_audio_port_cap.md) | -| [PortCap](union_port_cap.md) | 定义音视频编解码能力。 [更多...](union_port_cap.md) | -| [CodecCompCapability](_codec_comp_capability.md) | 定义Codec编解码能力。 [更多...](_codec_comp_capability.md) | -| [OmxCodecBuffer](_omx_codec_buffer.md) | Codec buffer信息的定义。 [更多...](_omx_codec_buffer.md) | -| [CompVerInfo](_comp_ver_info.md) | 定义组件版本信息。 [更多...](_comp_ver_info.md) | -| [EventInfo](_event_info.md) | 定义事件上报信息。 [更多...](_event_info.md) | -| [SupportBufferType](_support_buffer_type.md) | SupportBuffer类型定义。 [更多...](_support_buffer_type.md) | -| [UseBufferType](_use_buffer_type.md) | UseBuffer类型定义。 [更多...](_use_buffer_type.md) | -| [GetBufferHandleUsageParams](_get_buffer_handle_usage_params.md) | BufferHandleUsage类型定义。 [更多...](_get_buffer_handle_usage_params.md) | - - -### 宏定义 - - | 宏定义 | 描述 | -| -------- | -------- | -| SAMPLE_FMT_NUM    32 | 采样格式最大值。 | -| UUID_LENGTH    128 | 定义UUID长度。 | -| PIX_FORMAT_NUM    16 | 支持的像素格式数组大小。 | -| SAMPLE_FORMAT_NUM    12 | 支持的音频采样格式数组大小。 | -| SAMPLE_RATE_NUM    16 | 支持的音频采样率数组大小。 | -| CHANNEL_NUM    16 | 支持的音频通道数组大小。 | -| NAME_LENGTH    32 | 组件名称大小。 | -| PROFILE_NUM    256 | 支持的profile数组大小。 | - - -### 枚举 - - | 枚举 | 描述 | -| -------- | -------- | -| [CodecType](#codectype) { VIDEO_DECODER, VIDEO_ENCODER, AUDIO_DECODER, AUDIO_ENCODER,   INVALID_TYPE } | 枚举编解码的类型。 [更多...](#codectype) | -| [Profile](#profile) { INVALID_PROFILE = 0, AAC_LC_PROFILE = 0x1000, AAC_MAIN_PROFILE, AAC_HE_V1_PROFILE,   AAC_HE_V2_PROFILE, AAC_LD_PROFILE, AAC_ELD_PROFILE, AVC_BASELINE_PROFILE = 0x2000,   AVC_MAIN_PROFILE, AVC_HIGH_PROFILE, HEVC_MAIN_PROFILE = 0x3000, HEVC_MAIN_10_PROFILE } | 枚举Codec规格。 [更多...](#profile) | -| [AudioSampleRate](#audiosamplerate) {   AUD_SAMPLE_RATE_8000 = 8000, AUD_SAMPLE_RATE_12000 = 12000, AUD_SAMPLE_RATE_11025 = 11025, AUD_SAMPLE_RATE_16000 = 16000,   AUD_SAMPLE_RATE_22050 = 22050, AUD_SAMPLE_RATE_24000 = 24000, AUD_SAMPLE_RATE_32000 = 32000, AUD_SAMPLE_RATE_44100 = 44100,   AUD_SAMPLE_RATE_48000 = 48000, AUD_SAMPLE_RATE_64000 = 64000, AUD_SAMPLE_RATE_96000 = 96000, AUD_SAMPLE_RATE_INVALID } | 枚举音频采样率。 [更多...](#audiosamplerate) | -| [CodecCapsMask](#codeccapsmask) { CODEC_CAP_ADAPTIVE_PLAYBACK = 0x1, CODEC_CAP_SECURE_PLAYBACK = 0x2, CODEC_CAP_TUNNEL_PLAYBACK = 0x4, CODEC_CAP_MULTI_PLANE = 0x10000 } | 枚举播放能力。 [更多...](#codeccapsmask) | -| [CodecProcessMode](#codecprocessmode) {   PROCESS_BLOCKING_INPUT_BUFFER = 0X1, PROCESS_BLOCKING_OUTPUT_BUFFER = 0X2, PROCESS_BLOCKING_CONTROL_FLOW = 0X4, PROCESS_NONBLOCKING_INPUT_BUFFER = 0X100,   PROCESS_NONBLOCKING_OUTPUT_BUFFER = 0X200, PROCESS_NONBLOCKING_CONTROL_FLOW = 0X400 } | 枚举编解码处理模式。 [更多...](#codecprocessmode) | -| [AvCodecRole](#avcodecrole) {   MEDIA_ROLETYPE_IMAGE_JPEG = 0, MEDIA_ROLETYPE_VIDEO_AVC, MEDIA_ROLETYPE_VIDEO_HEVC, MEDIA_ROLETYPE_AUDIO_FIRST = 0x10000,   MEDIA_ROLETYPE_AUDIO_AAC = 0x10000, MEDIA_ROLETYPE_AUDIO_G711A, MEDIA_ROLETYPE_AUDIO_G711U, MEDIA_ROLETYPE_AUDIO_G726,   MEDIA_ROLETYPE_AUDIO_PCM, MEDIA_ROLETYPE_AUDIO_MP3, MEDIA_ROLETYPE_INVALID } | 枚举音视频编解码组件类型。 [更多...](#avcodecrole) | -| [AudioSampleFormat](#audiosampleformat) {   AUDIO_SAMPLE_FORMAT_S8, AUDIO_SAMPLE_FORMAT_S8P, AUDIO_SAMPLE_FORMAT_U8, AUDIO_SAMPLE_FORMAT_U8P,   AUDIO_SAMPLE_FORMAT_S16, AUDIO_SAMPLE_FORMAT_S16P, AUDIO_SAMPLE_FORMAT_U16, AUDIO_SAMPLE_FORMAT_U16P,   AUDIO_SAMPLE_FORMAT_S24, AUDIO_SAMPLE_FORMAT_S24P, AUDIO_SAMPLE_FORMAT_U24, AUDIO_SAMPLE_FORMAT_U24P,   AUDIO_SAMPLE_FORMAT_S32, AUDIO_SAMPLE_FORMAT_S32P, AUDIO_SAMPLE_FORMAT_U32, AUDIO_SAMPLE_FORMAT_U32P,   AUDIO_SAMPLE_FORMAT_S64, AUDIO_SAMPLE_FORMAT_S64P, AUDIO_SAMPLE_FORMAT_U64, AUDIO_SAMPLE_FORMAT_U64P,   AUDIO_SAMPLE_FORMAT_F32, AUDIO_SAMPLE_FORMAT_F32P, AUDIO_SAMPLE_FORMAT_F64, AUDIO_SAMPLE_FORMAT_F64P,   AUDIO_SAMPLE_FMT_U8, AUDIO_SAMPLE_FMT_S16, AUDIO_SAMPLE_FMT_S32, AUDIO_SAMPLE_FMT_FLOAT,   AUDIO_SAMPLE_FMT_DOUBLE, AUDIO_SAMPLE_FMT_U8P, AUDIO_SAMPLE_FMT_S16P, AUDIO_SAMPLE_FMT_S32P,   AUDIO_SAMPLE_FMT_FLOATP, AUDIO_SAMPLE_FMT_DOUBLEP, AUDIO_SAMPLE_FMT_INVALID } | 枚举音频采样格式。 [更多...](#audiosampleformat) | -| [CodecBufferType](#codecbuffertype) {   CODEC_BUFFER_TYPE_INVALID = 0, CODEC_BUFFER_TYPE_VIRTUAL_ADDR = 0x1, CODEC_BUFFER_TYPE_AVSHARE_MEM_FD = 0x2, CODEC_BUFFER_TYPE_HANDLE = 0x4,   CODEC_BUFFER_TYPE_DYNAMIC_HANDLE = 0x8 } | 定义buffer类型。 [更多...](#codecbuffertype) | -| [ShareMemTypes](#sharememtypes) { READ_WRITE_TYPE = 0x1, READ_ONLY_TYPE = 0x2 } | 枚举共享内存类型。 [更多...](#sharememtypes) | -| [OmxIndexCodecExType](#omxindexcodecextype) { OMX_IndexExtBufferTypeStartUnused = OMX_IndexKhronosExtensions + 0x00a00000, OMX_IndexParamSupportBufferType, OMX_IndexParamUseBufferType, OMX_IndexParamGetBufferHandleUsage } | 枚举Codec扩展index。 [更多...](#omxindexcodecextype) | -| [OmxVideoExType](#omxvideoextype) { OMX_VIDEO_CodingHEVC = 11 } | 枚举Codec扩展编码类型。 [更多...](#omxvideoextype) | - - -### 函数 - - | 函数 | 描述 | -| -------- | -------- | -| [CodecCallbackTypeGet](#codeccallbacktypeget) (struct HdfRemoteService \*remote) | 实例化CodecCallbackType对象。 [更多...](#codeccallbacktypeget) | -| [CodecCallbackTypeRelease](#codeccallbacktyperelease) (struct [CodecCallbackType](_codec_callback_type.md) \*instance) | 释放CodecCallbackType对象。 [更多...](#codeccallbacktyperelease) | -| [CodecComponentTypeGet](#codeccomponenttypeget) (struct HdfRemoteService \*remote) | 实例化CodecComponentType对象。 [更多...](#codeccomponenttypeget) | -| [CodecComponentTypeRelease](#codeccomponenttyperelease) (struct [CodecComponentType](_codec_component_type.md) \*instance) | 释放CodecComponentType对象。 [更多...](#codeccomponenttyperelease) | -| [GetCodecComponentManager](#getcodeccomponentmanager) (void) | 实例化CodecComponentManager对象。 [更多...](#getcodeccomponentmanager) | -| [CodecComponentManagerRelease](#codeccomponentmanagerrelease) (void) | 释放CodecComponentManager对象。 [更多...](#codeccomponentmanagerrelease) | - - -### 变量 - - | 变量 | 描述 | -| -------- | -------- | -| [CodecCallbackType::remote](#remote) | 指向HdfRemoteService的指针。 [更多...](#remote) | -| ( [CodecCallbackType::EventHandler](#eventhandler) )(struct [CodecCallbackType](_codec_callback_type.md) \*self, enum OMX_EVENTTYPE event, struct [EventInfo](_event_info.md) \*info) | 事件上报。 [更多...](#eventhandler) | -| ( [CodecCallbackType::EmptyBufferDone](#emptybufferdone) )(struct [CodecCallbackType](_codec_callback_type.md) \*self, int8_t \*appData, uint32_t appDataLen, const struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 上报输入buffer编码或者解码处理完毕。 [更多...](#emptybufferdone) | -| ( [CodecCallbackType::FillBufferDone](#fillbufferdone) )(struct [CodecCallbackType](_codec_callback_type.md) \*self, int8_t \*appData, uint32_t appDataLen, struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 上报输出buffer填充完毕。 [更多...](#fillbufferdone) | -| ( [CodecComponentType::GetComponentVersion](#getcomponentversion) )(struct [CodecComponentType](_codec_component_type.md) \*self, struct [CompVerInfo](_comp_ver_info.md) \*verInfo) | 获取Codec组件版本号。 [更多...](#getcomponentversion) | -| ( [CodecComponentType::SendCommand](#sendcommand) )(struct [CodecComponentType](_codec_component_type.md) \*self, enum OMX_COMMANDTYPE cmd, uint32_t param, int8_t \*cmdData, uint32_t cmdDataLen) | 发送命令给组件。 [更多...](#sendcommand) | -| ( [CodecComponentType::GetParameter](#getparameter) )(struct [CodecComponentType](_codec_component_type.md) \*self, uint32_t paramIndex, int8_t \*paramStruct, uint32_t paramStructLen) | 获取组件参数设置。 [更多...](#getparameter) | -| ( [CodecComponentType::SetParameter](#setparameter) )(struct [CodecComponentType](_codec_component_type.md) \*self, uint32_t index, int8_t \*paramStruct, uint32_t paramStructLen) | 设置组件需要的参数。 [更多...](#setparameter) | -| ( [CodecComponentType::GetConfig](#getconfig) )(struct [CodecComponentType](_codec_component_type.md) \*self, uint32_t index, int8_t \*cfgStruct, uint32_t cfgStructLen) | 获取组件的配置结构。 [更多...](#getconfig) | -| ( [CodecComponentType::SetConfig](#setconfig) )(struct [CodecComponentType](_codec_component_type.md) \*self, uint32_t index, int8_t \*cfgStruct, uint32_t cfgStructLen) | 设置组件的配置。 [更多...](#setconfig) | -| ( [CodecComponentType::GetExtensionIndex](#getextensionindex) )(struct [CodecComponentType](_codec_component_type.md) \*self, const char \*paramName, uint32_t \*indexType) | 根据字符串获取组件的扩展索引。 [更多...](#getextensionindex) | -| ( [CodecComponentType::GetState](#getstate) )(struct [CodecComponentType](_codec_component_type.md) \*self, enum OMX_STATETYPE \*state) | 获取组件的当前状态。 [更多...](#getstate) | -| ( [CodecComponentType::ComponentTunnelRequest](#componenttunnelrequest) )(struct [CodecComponentType](_codec_component_type.md) \*self, uint32_t port, int32_t tunneledComp, uint32_t tunneledPort, struct OMX_TUNNELSETUPTYPE \*tunnelSetup) | 设置组件采用Tunnel方式通信。 [更多...](#componenttunnelrequest) | -| ( [CodecComponentType::UseBuffer](#usebuffer) )(struct [CodecComponentType](_codec_component_type.md) \*self, uint32_t portIndex, struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 指定组件端口的buffer。 [更多...](#usebuffer) | -| ( [CodecComponentType::AllocateBuffer](#allocatebuffer) )(struct [CodecComponentType](_codec_component_type.md) \*self, uint32_t portIndex, struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 向组件申请端口buffer。 [更多...](#allocatebuffer) | -| ( [CodecComponentType::FreeBuffer](#freebuffer) )(struct [CodecComponentType](_codec_component_type.md) \*self, uint32_t portIndex, const struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 释放buffer。 [更多...](#freebuffer) | -| ( [CodecComponentType::EmptyThisBuffer](#emptythisbuffer) )(struct [CodecComponentType](_codec_component_type.md) \*self, const struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 编解码输入待处理buffer。 [更多...](#emptythisbuffer) | -| ( [CodecComponentType::FillThisBuffer](#fillthisbuffer) )(struct [CodecComponentType](_codec_component_type.md) \*self, const struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 编解码输出填充buffer。 [更多...](#fillthisbuffer) | -| ( [CodecComponentType::SetCallbacks](#setcallbacks) )(struct [CodecComponentType](_codec_component_type.md) \*self, struct [CodecCallbackType](_codec_callback_type.md) \*callback, int8_t \*appData, uint32_t appDataLen) | 设置Codec组件的回调函数。 [更多...](#setcallbacks) | -| ( [CodecComponentType::ComponentDeInit](#componentdeinit) )(struct [CodecComponentType](_codec_component_type.md) \*self) | 组件去初始化。 [更多...](#componentdeinit) | -| ( [CodecComponentType::UseEglImage](#useeglimage) )(struct [CodecComponentType](_codec_component_type.md) \*self, struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer, uint32_t portIndex, int8_t \*eglImage, uint32_t eglImageLen) | 使用已在EGL中申请的空间。 [更多...](#useeglimage) | -| ( [CodecComponentType::ComponentRoleEnum](#componentroleenum) )(struct [CodecComponentType](_codec_component_type.md) \*self, uint8_t \*role, uint32_t roleLen, uint32_t index) | 获取组件角色。 [更多...](#componentroleenum) | - - -## **详细描述** - -Codec模块接口定义。 - -Codec模块涉及自定义类型、音视频编解码组件初始化、参数设置、数据的轮转和控制等。 - -**Since：** - -3.1 - -**Version：** - -2.0 - - -## **枚举类型说明** - - -### AudioSampleFormat - - -``` -enum AudioSampleFormat -``` - -**描述：** - -枚举音频采样格式。 - -- 对于planar的采样格式，每个声道的数据是独立存储在data中。 - -- 对于packed的采样格式，只使用第一个data，每个声道的数据是交错存储的。 - -| 枚举值 | 描述 | -| -------- | -------- | -| AUDIO_SAMPLE_FORMAT_S8 | 8bit位宽有符号交织样本。 | -| AUDIO_SAMPLE_FORMAT_S8P | 8bit位宽有符号非交织样本。 | -| AUDIO_SAMPLE_FORMAT_U8 | 8bit位宽无符号交织样本。 | -| AUDIO_SAMPLE_FORMAT_U8P | 8bit位宽无符号非交织样本。 | -| AUDIO_SAMPLE_FORMAT_S16 | 16bit位宽有符号交织样本。 | -| AUDIO_SAMPLE_FORMAT_S16P | 16bit位宽有符号非交织样本。 | -| AUDIO_SAMPLE_FORMAT_U16 | 16bit位宽无符号交织样本。 | -| AUDIO_SAMPLE_FORMAT_U16P | 16bit位宽无符号非交织样本。 | -| AUDIO_SAMPLE_FORMAT_S24 | 24bit位宽有符号交织样本。 | -| AUDIO_SAMPLE_FORMAT_S24P | 24bit位宽有符号非交织样本。 | -| AUDIO_SAMPLE_FORMAT_U24 | 24bit位宽无符号交织样本。 | -| AUDIO_SAMPLE_FORMAT_U24P | 24bit位宽无符号非交织样本。 | -| AUDIO_SAMPLE_FORMAT_S32 | 32bit位宽有符号交织样本。 | -| AUDIO_SAMPLE_FORMAT_S32P | 32bit位宽有符号非交织样本。 | -| AUDIO_SAMPLE_FORMAT_U32 | 32bit位宽无符号交织样本。 | -| AUDIO_SAMPLE_FORMAT_U32P | 32bit位宽无符号非交织样本。 | -| AUDIO_SAMPLE_FORMAT_S64 | 64bit位宽有符号交织样本。 | -| AUDIO_SAMPLE_FORMAT_S64P | 64bit位宽有符号非交织样本。 | -| AUDIO_SAMPLE_FORMAT_U64 | 64bit位宽无符号交织样本。 | -| AUDIO_SAMPLE_FORMAT_U64P | 64bit位宽无符号非交织样本。 | -| AUDIO_SAMPLE_FORMAT_F32 | 32bit位宽浮点型交织样本。 | -| AUDIO_SAMPLE_FORMAT_F32P | 64bit位宽浮点型非交织样本。 | -| AUDIO_SAMPLE_FORMAT_F64 | 64bit位宽双精度浮点型交织样本。 | -| AUDIO_SAMPLE_FORMAT_F64P | 64bit位宽双精度浮点型非交织样本。 | -| AUDIO_SAMPLE_FMT_U8 | 无符号8位整型，打包格式。 | -| AUDIO_SAMPLE_FMT_S16 | 带符号16位整型，打包格式。 | -| AUDIO_SAMPLE_FMT_S32 | 带符号32位整型，打包格式。 | -| AUDIO_SAMPLE_FMT_FLOAT | 浮点型，打包格式。 | -| AUDIO_SAMPLE_FMT_DOUBLE | 双精度浮点型，打包格式。 | -| AUDIO_SAMPLE_FMT_U8P | 无符号8位整型，平面格式。 | -| AUDIO_SAMPLE_FMT_S16P | 带符号16位整型，平面格式。 | -| AUDIO_SAMPLE_FMT_S32P | 带符号32位整型，平面格式。 | -| AUDIO_SAMPLE_FMT_FLOATP | 浮点型，平面格式。 | -| AUDIO_SAMPLE_FMT_DOUBLEP | 双精度浮点型，平面格式。 | -| AUDIO_SAMPLE_FMT_INVALID | 无效采样格式。 | - - -### AudioSampleRate - - -``` -enum AudioSampleRate -``` - -**描述：** - -枚举音频采样率 - - | 枚举值 | 描述 | -| -------- | -------- | -| AUD_SAMPLE_RATE_8000 | 8K采样率 | -| AUD_SAMPLE_RATE_12000 | 12K采样率 | -| AUD_SAMPLE_RATE_11025 | 11.025K采样率 | -| AUD_SAMPLE_RATE_16000 | 16K采样率 | -| AUD_SAMPLE_RATE_22050 | 22.050K采样率 | -| AUD_SAMPLE_RATE_24000 | 24K采样率 | -| AUD_SAMPLE_RATE_32000 | 32K采样率 | -| AUD_SAMPLE_RATE_44100 | 44.1K采样率 | -| AUD_SAMPLE_RATE_48000 | 48K采样率 | -| AUD_SAMPLE_RATE_64000 | 64K采样率 | -| AUD_SAMPLE_RATE_96000 | 96K采样率 | -| AUD_SAMPLE_RATE_INVALID | 无效采样率 | - - -### AvCodecRole - - -``` -enum AvCodecRole -``` - -**描述：** - -枚举音视频编解码组件类型。 - - | 枚举值 | 描述 | -| -------- | -------- | -| MEDIA_ROLETYPE_IMAGE_JPEG | 图像JPEG媒体类型 | -| MEDIA_ROLETYPE_VIDEO_AVC | 视频H.264媒体类型 | -| MEDIA_ROLETYPE_VIDEO_HEVC | 视频H.265媒体类型 | -| MEDIA_ROLETYPE_AUDIO_FIRST | 音频编解码器类型 | -| MEDIA_ROLETYPE_AUDIO_AAC | 音频AAC媒体类型 | -| MEDIA_ROLETYPE_AUDIO_G711A | 音频G711A媒体类型 | -| MEDIA_ROLETYPE_AUDIO_G711U | 音频G711U媒体类型 | -| MEDIA_ROLETYPE_AUDIO_G726 | 音频G726媒体类型 | -| MEDIA_ROLETYPE_AUDIO_PCM | 音频PCM媒体类型 | -| MEDIA_ROLETYPE_AUDIO_MP3 | 音频MP3媒体类型 | -| MEDIA_ROLETYPE_INVALID | 无效媒体类型 | - - -### CodecBufferType - - -``` -enum CodecBufferType -``` - -**描述：** - -定义buffer类型。 - - | 枚举值 | 描述 | -| -------- | -------- | -| CODEC_BUFFER_TYPE_INVALID | 无效buffer类型 | -| CODEC_BUFFER_TYPE_VIRTUAL_ADDR | 虚拟地址类型 | -| CODEC_BUFFER_TYPE_AVSHARE_MEM_FD | 共享内存类型 | -| CODEC_BUFFER_TYPE_HANDLE | handle类型 | -| CODEC_BUFFER_TYPE_DYNAMIC_HANDLE | 动态handle类型 | - - -### CodecCapsMask - - -``` -enum CodecCapsMask -``` - -**描述：** - -枚举播放能力。 - - | 枚举值 | 描述 | -| -------- | -------- | -| CODEC_CAP_ADAPTIVE_PLAYBACK | 自适应播放能力 | -| CODEC_CAP_SECURE_PLAYBACK | 安全播放能力 | -| CODEC_CAP_TUNNEL_PLAYBACK | 通道播放能力 | -| CODEC_CAP_MULTI_PLANE | 视频图像平面/音频通道平面能力 | - - -### CodecProcessMode - - -``` -enum CodecProcessMode -``` - -**描述：** - -枚举编解码处理模式。 - - | 枚举值 | 描述 | -| -------- | -------- | -| PROCESS_BLOCKING_INPUT_BUFFER | 同步模式输入buffer | -| PROCESS_BLOCKING_OUTPUT_BUFFER | 同步模式输出buffer | -| PROCESS_BLOCKING_CONTROL_FLOW | 同步模式控制流 | -| PROCESS_NONBLOCKING_INPUT_BUFFER | 异步模式输入buffer | -| PROCESS_NONBLOCKING_OUTPUT_BUFFER | 异步模式输出buffer | -| PROCESS_NONBLOCKING_CONTROL_FLOW | 异步模式控制流 | - - -### CodecType - - -``` -enum CodecType -``` - -**描述：** - -枚举编解码的类型。 - - | 枚举值 | 描述 | -| -------- | -------- | -| VIDEO_DECODER | 视频解码类型 | -| VIDEO_ENCODER | 视频编码类型 | -| AUDIO_DECODER | 音频解码类型 | -| AUDIO_ENCODER | 音频编码类型 | -| INVALID_TYPE | 无效类型 | - - -### OmxIndexCodecExType - - -``` -enum OmxIndexCodecExType -``` - -**描述：** - -枚举Codec扩展index。 - - | 枚举值 | 描述 | -| -------- | -------- | -| OMX_IndexExtBufferTypeStartUnused | BufferType 扩展index | -| OMX_IndexParamSupportBufferType | SupportBuffer类型 | -| OMX_IndexParamUseBufferType | UseBuffer类型 | -| OMX_IndexParamGetBufferHandleUsage | GetBufferHandleUsage类型 | - - -### OmxVideoExType - - -``` -enum OmxVideoExType -``` - -**描述：** - -枚举Codec扩展编码类型。 - - | 枚举值 | 描述 | -| -------- | -------- | -| OMX_VIDEO_CodingHEVC | HEVC编码类型 | - - -### Profile - - -``` -enum Profile -``` - -**描述：** - -枚举Codec规格。 - - | 枚举值 | 描述 | -| -------- | -------- | -| INVALID_PROFILE | 无效的规格。 | -| AAC_LC_PROFILE | AAC低复杂度规格。 | -| AAC_MAIN_PROFILE | AAC主规格。 | -| AAC_HE_V1_PROFILE | AAC高效率和频带重现规格，又称为HEAAC，AAC+，或者AACPlusV1。 | -| AAC_HE_V2_PROFILE | AAC高效率和频带重现以及变量立体声规格，又称为AAC++或者AACPlusV2。 | -| AAC_LD_PROFILE | AAC低延迟规格。 | -| AAC_ELD_PROFILE | AAC增强型低延迟规格。 | -| AVC_BASELINE_PROFILE | H.264低规格。 | -| AVC_MAIN_PROFILE | H.264主规格。 | -| AVC_HIGH_PROFILE | H.264高规格。 | -| HEVC_MAIN_PROFILE | H.265主规格。 | -| HEVC_MAIN_10_PROFILE | H.265 10比特主规格。 | - - -### ShareMemTypes - - -``` -enum ShareMemTypes -``` - -**描述：** - -枚举共享内存类型。 - - | 枚举值 | 描述 | -| -------- | -------- | -| READ_WRITE_TYPE | 可读可写的共享内存类型 | -| READ_ONLY_TYPE | 可读的共享内存类型 | - - -## **函数说明** - - -### CodecCallbackTypeGet() - - -``` -struct CodecCallbackType* CodecCallbackTypeGet (struct HdfRemoteService * remote) -``` - -**描述：** - -实例化CodecCallbackType对象。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| remote | 输入参数，指向HdfRemoteService的指针。 | - -**返回：** - -实例化CodecCallbackType对象。 - -**Since：** - -3.1 - - -### CodecCallbackTypeRelease() - - -``` -void CodecCallbackTypeRelease (struct CodecCallbackType * instance) -``` - -**描述：** - -释放CodecCallbackType对象。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| instance | 输入参数，指向CodecCallbackType实例的指针。 | - -**Since：** - -3.1 - - -### CodecComponentManagerRelease() - - -``` -void CodecComponentManagerRelease (void ) -``` - -**描述：** - -释放CodecComponentManager对象。 - -**Since：** - -3.1 - - -### CodecComponentTypeGet() - - -``` -struct CodecComponentType* CodecComponentTypeGet (struct HdfRemoteService * remote) -``` - -**描述：** - -实例化CodecComponentType对象。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| remote | 输入参数，指向RemoteService的指针。 | - -**返回：** - -实例化的CodecComponentType对象。 - -**Since：** - -3.1 - - -### CodecComponentTypeRelease() - - -``` -void CodecComponentTypeRelease (struct CodecComponentType * instance) -``` - -**描述：** - -释放CodecComponentType对象。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| instance | 输入参数，指向CodecComponentType实例的指针。 | - -**Since：** - -3.1 - - -### GetCodecComponentManager() - - -``` -struct CodecComponentManager* GetCodecComponentManager (void ) -``` - -**描述：** - -实例化CodecComponentManager对象。 - -**返回：** - -实例化的CodecComponentManager对象。 - -**Since：** - -3.1 - - -## **变量说明** - - -### AllocateBuffer - - -``` -int32_t(* CodecComponentType::AllocateBuffer) (struct CodecComponentType *self, uint32_t portIndex, struct OmxCodecBuffer *buffer) -``` - -**描述：** - -向组件申请端口buffer。 - -向组件申请分配新的buffer，此接口在以下情况下使用： - -- 当组件处于OMX_StateLoaded状态，并且用户已经向组件发送OMX_StateIdle状态转换请求。 - -- 当组件处于OMX_StateWaitForResources状态，所需的资源可用，并且组件已准备好进入OMX_StateIdle状态。 - -- 在去使能端口上，组件处于OMX_StateExecuting、OMX_StatePause或OMX_StateIdle状态。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| self | 输入参数，指向要操作的Codec组件指针。 | -| portIndex | 输入参数，指定的组件端口。 | -| buffer | 输入输出参数，指向要申请的buffer结构体[OmxCodecBuffer](_omx_codec_buffer.md)指针。 | - -**返回：** - -HDF_SUCCESS 表示申请buffer成功。 - -HDF_ERR_INVALID_PARAM 表示参数无效，申请buffer失败。 - -HDF_ERR_INVALID_OBJECT 表示对象无效，申请buffer失败。 - -HDF_ERR_MALLOC_FAIL 表示申请内存失败，申请buffer失败。 - -**Since：** - -3.1 - - -### ComponentDeInit - - -``` -int32_t(* CodecComponentType::ComponentDeInit) (struct CodecComponentType *self) -``` - -**描述：** - -组件去初始化。 - -调用此接口使组件去初始化，当组件处于OMX_StateLoaded状态时，将直接关闭组件。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| self | 输入参数，指向要操作的Codec组件指针。 | - -**返回：** - -HDF_SUCCESS 表示去初始化成功。 - -HDF_ERR_INVALID_PARAM 表示参数无效，去初始化失败。 - -HDF_ERR_INVALID_OBJECT 表示对象无效，去初始化失败。 - -HDF_ERR_MALLOC_FAIL 表示申请内存失败，去初始化失败。 - -**Since：** - -3.1 - - -### ComponentRoleEnum - - -``` -int32_t(* CodecComponentType::ComponentRoleEnum) (struct CodecComponentType *self, uint8_t *role, uint32_t roleLen, uint32_t index) -``` - -**描述：** - -获取组件角色。 - -根据组件角色索引获取对应组件角色。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| self | 输入参数，指向要操作的Codec组件指针。 | -| role | 输出参数，角色名称。 | -| roleLen | 输入参数，role字节数。 | -| index | 输入参数，角色的索引，一个组件可能支持多种角色。 | - -**返回：** - -HDF_SUCCESS 表示获取角色成功。 - -HDF_ERR_INVALID_PARAM 表示参数无效，获取角色失败。 - -HDF_ERR_INVALID_OBJECT 表示对象无效，获取角色失败。 - -HDF_ERR_MALLOC_FAIL 表示申请内存失败，获取角色失败。 - -**Since：** - -3.1 - - -### ComponentTunnelRequest - - -``` -int32_t(* CodecComponentType::ComponentTunnelRequest) (struct CodecComponentType *self, uint32_t port, int32_t tunneledComp, uint32_t tunneledPort, struct OMX_TUNNELSETUPTYPE *tunnelSetup) -``` - -**描述：** - -设置组件采用Tunnel方式通信。 - -当组件处于OMX_StateLoaded 状态时，用户通过调用此接口确定组件是否可以进行Tunnel传输，如果可以则设置组件的Tunnel传输。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| self | 输入参数，指向要操作的Codec组件指针。 | -| port | 输入参数，组件设置的端口。 | -| tunneledComp | 输入参数，组件的tunnel handle。 | -| tunneledPort | 输入参数，组件用来Tunnel通信的端口。 | -| tunnelSetup | 输入输出参数，指向Tunnel设置的结构体**OMX_TUNNELSETUPTYPE**指针。 | - -**返回：** - -HDF_SUCCESS 表示设置成功。 - -HDF_ERR_INVALID_PARAM 表示参数无效，设置失败。 - -HDF_ERR_INVALID_OBJECT 表示对象无效，设置失败。 - -HDF_ERR_MALLOC_FAIL 表示申请内存失败，设置失败。 - -**Since：** - -3.1 - - -### 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 表示申请内存失败，上报失败。 - -**Since：** - -3.1 - - -### EmptyThisBuffer - - -``` -int32_t(* CodecComponentType::EmptyThisBuffer) (struct CodecComponentType *self, const struct OmxCodecBuffer *buffer) -``` - -**描述：** - -编解码输入待处理buffer。 - -此接口在组件处于OMX_StateExecuting或者OMX_StatePause状态时调用。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| self | 输入参数，指向要操作的Codec组件指针。 | -| buffer | 输入参数，指向[OmxCodecBuffer](_omx_codec_buffer.md)结构体的指针。 | - -**返回：** - -HDF_SUCCESS 表示输入buffer成功。 - -HDF_ERR_INVALID_PARAM 表示参数无效，输入buffer失败。 - -HDF_ERR_INVALID_OBJECT 表示对象无效，输入buffer失败。 - -HDF_ERR_MALLOC_FAIL 表示申请内存失败，输入buffer失败。 - -**Since：** - -3.1 - - -### 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 | 输入参数，要通知的事件类型，详见**OMX_EVENTTYPE**。 | -| info | 输入参数，指向事件上报携带的信息指针，详见[EventInfo](_event_info.md)。 | - -**返回：** - -HDF_SUCCESS 表示事件上报成功。 - -HDF_ERR_INVALID_PARAM 表示参数无效，事件上报失败。 - -HDF_ERR_INVALID_OBJECT 表示对象无效，事件上报失败。 - -HDF_ERR_MALLOC_FAIL 表示申请内存失败，事件上报失败。 - -**Since：** - -3.1 - - -### 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 表示申请内存失败，上报失败。 - -**Since：** - -3.1 - - -### FillThisBuffer - - -``` -int32_t(* CodecComponentType::FillThisBuffer) (struct CodecComponentType *self, const struct OmxCodecBuffer *buffer) -``` - -**描述：** - -编解码输出填充buffer。 - -此接口在组件处于OMX_StateExecuting或者OMX_StatePause状态时调用。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| self | 输入参数，指向要操作的Codec组件指针。 | -| buffer | 输入参数，指向[OmxCodecBuffer](_omx_codec_buffer.md)结构体的指针。 | - -**返回：** - -HDF_SUCCESS 表示填充buffer成功。 - -HDF_ERR_INVALID_PARAM 表示参数无效，填充buffer失败。 - -HDF_ERR_INVALID_OBJECT 表示对象无效，填充buffer失败。 - -HDF_ERR_MALLOC_FAIL 表示申请内存失败，填充buffer失败。 - -**Since：** - -3.1 - - -### FreeBuffer - - -``` -int32_t(* CodecComponentType::FreeBuffer) (struct CodecComponentType *self, uint32_t portIndex, const struct OmxCodecBuffer *buffer) -``` - -**描述：** - -释放buffer。 - -此接口在以下情况下使用： - -- 当组件处于OMX_StateIdle状态，并且已经向组件发送OMX_StateLoaded状态转换请求。 - -- 在去使能端口上，组件处于OMX_StateExecuting、OMX_StatePause或OMX_StateIdle时调用。 - -- 此接口调用可随时进行，但是如果未在上述情况下执行，可能会导致组件上报OMX_ErrorPortUnpopulated事件。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| self | 输入参数，指向要操作的Codec组件指针。 | -| portIndex | 输入参数，指定的组件端口。 | -| buffer | 输入参数，指向[OmxCodecBuffer](_omx_codec_buffer.md)结构体的指针。 | - -**返回：** - -HDF_SUCCESS 表示释放buffer成功。 - -HDF_ERR_INVALID_PARAM 表示参数无效，释放buffer失败。 - -HDF_ERR_INVALID_OBJECT 表示对象无效，释放buffer失败。 - -HDF_ERR_MALLOC_FAIL 表示申请内存失败，释放buffer失败。 - -**Since：** - -3.1 - - -### GetComponentVersion - - -``` -int32_t(* CodecComponentType::GetComponentVersion) (struct CodecComponentType *self, struct CompVerInfo *verInfo) -``` - -**描述：** - -获取Codec组件版本号。 - -通过查询组件，返回组件版本信息。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| self | 输入参数，指向要操作的Codec组件指针。 | -| verInfo | 输出参数，指向组件版本信息的指针，详见[CompVerInfo](_comp_ver_info.md)。 | - -**返回：** - -HDF_SUCCESS 表示获取版本号成功。 - -HDF_ERR_INVALID_PARAM 表示参数无效，获取版本号失败。 - -HDF_ERR_INVALID_OBJECT 表示对象无效，获取版本号失败。 - -HDF_ERR_MALLOC_FAIL 表示申请内存失败，获取版本号失败。 - -**Since：** - -3.1 - - -### GetConfig - - -``` -int32_t(* CodecComponentType::GetConfig) (struct CodecComponentType *self, uint32_t index, int8_t *cfgStruct, uint32_t cfgStructLen) -``` - -**描述：** - -获取组件的配置结构。 - -加载组件后可以随时调用此接口获取组件的配置。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| self | 输入参数，指向要操作的Codec组件指针。 | -| index | 输入参数，待填充结构的索引，详见**OMX_INDEXTYPE**。 | -| cfgStruct | 输入输出参数，指向由组件填充的应用程序分配的结构体指针。 | -| cfgStructLen | 输入参数，上层传入的cfgStruct字节数。 | - -**返回：** - -HDF_SUCCESS 表示获取配置成功。 - -HDF_ERR_INVALID_PARAM 表示参数无效，获取配置失败。 - -HDF_ERR_INVALID_OBJECT 表示对象无效，获取配置失败。 - -HDF_ERR_MALLOC_FAIL 表示申请内存失败，获取配置失败。 - -**Since：** - -3.1 - - -### GetExtensionIndex - - -``` -int32_t(* CodecComponentType::GetExtensionIndex) (struct CodecComponentType *self, const char *paramName, uint32_t *indexType) -``` - -**描述：** - -根据字符串获取组件的扩展索引。 - -将扩展字符串转换为Openmax IL结构索引。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| self | 输入参数，指向要操作的Codec组件指针。 | -| paramName | 输入参数，组件用来转换为配置索引的字符串。 | -| indexType | 输出参数，由paramName转换的配置索引，详见**OMX_INDEXTYPE**。 | - -**返回：** - -HDF_SUCCESS 表示获取扩展索引成功。 - -HDF_ERR_INVALID_PARAM 表示参数无效，获取扩展索引失败。 - -HDF_ERR_INVALID_OBJECT 表示对象无效，获取扩展索引失败。 - -HDF_ERR_MALLOC_FAIL 表示申请内存失败，获取扩展索引失败。 - -**Since：** - -3.1 - - -### GetParameter - - -``` -int32_t(* CodecComponentType::GetParameter) (struct CodecComponentType *self, uint32_t paramIndex, int8_t *paramStruct, uint32_t paramStructLen) -``` - -**描述：** - -获取组件参数设置。 - -当组件处于除了OMX_StateInvalid（组件状态异常）之外的其他状态，用户可通过此接口获取组件参数。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| self | 输入参数，指向要操作的Codec组件指针。 | -| paramIndex | 输入参数，待填充结构的索引，详见**OMX_INDEXTYPE**。 | -| paramStruct | 输入输出参数，指向由组件填充的应用程序分配的结构体指针。 | -| paramStructLen | 输入参数，paramStruct字节数。 | - -**返回：** - -HDF_SUCCESS 表示获取参数成功。 - -HDF_ERR_INVALID_PARAM 表示参数无效，获取参数失败。 - -HDF_ERR_INVALID_OBJECT 表示对象无效，获取参数失败。 - -HDF_ERR_MALLOC_FAIL 表示申请内存失败，获取参数失败。 - -**Since：** - -3.1 - - -### GetState - - -``` -int32_t(* CodecComponentType::GetState) (struct CodecComponentType *self, enum OMX_STATETYPE *state) -``` - -**描述：** - -获取组件的当前状态。 - -用户可调用此接口获取组件的当前状态，组件状态详见**OMX_STATETYPE**。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| self | 输入参数，指向要操作的Codec组件指针。 | -| state | 输出参数，指向获取到的状态指针，组件状态详见**OMX_STATETYPE**。 | - -**返回：** - -HDF_SUCCESS 表示获取状态成功。 - -HDF_ERR_INVALID_PARAM 表示参数无效，获取状态失败。 - -HDF_ERR_INVALID_OBJECT 表示对象无效，获取状态失败。 - -HDF_ERR_MALLOC_FAIL 表示申请内存失败，获取状态失败。 - -**Since：** - -3.1 - - -### remote - - -``` -struct HdfRemoteService* CodecCallbackType::remote -``` - -**描述：** - -指向HdfRemoteService的指针。 - -**Since：** - -3.1 - - -### SendCommand - - -``` -int32_t(* CodecComponentType::SendCommand) (struct CodecComponentType *self, enum OMX_COMMANDTYPE cmd, uint32_t param, int8_t *cmdData, uint32_t cmdDataLen) -``` - -**描述：** - -发送命令给组件。 - -发送命令给组件，当命令为设置状态时，会有事件回调通知结果给上层，其他命令则没有事件上报。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| self | 输入参数，指向要操作的Codec组件指针。 | -| cmd | 输入参数，组件要执行的命令，详见**OMX_COMMANDTYPE**。 | -| param | 输入参数，组件要执行的命令携带的参数。
- 当cmd为OMX_CommandStateSet时，param的值详见**OMX_STATETYPE**。
- 当cmd为OMX_CommandFlush、OMX_CommandPortDisable、OMX_CommandPortEnable、OMX_CommandMarkBuffer时，param为目标端口。 | -| cmdData | 输入参数，当cmd为OMX_CommandMarkBuffer时，指向OMX_MARKTYPE结构体指针。 | -| cmdDataLen | 输入参数，上层传递的cmdData字节数。 | - -**返回：** - -HDF_SUCCESS 表示发送命令成功。 - -HDF_ERR_INVALID_PARAM 表示参数无效，发送命令失败。 - -HDF_ERR_INVALID_OBJECT 表示对象无效，发送命令失败。 - -HDF_ERR_MALLOC_FAIL 表示申请内存失败，发送命令失败。 - -**Since：** - -3.1 - - -### SetCallbacks - - -``` -int32_t(* CodecComponentType::SetCallbacks) (struct CodecComponentType *self, struct CodecCallbackType *callback, int8_t *appData, uint32_t appDataLen) -``` - -**描述：** - -设置Codec组件的回调函数。 - -当组件处于OMX_StateLoaded状态时，使用此回调函数向上通知事件以及上报可用的输入输出信息。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| self | 输入参数，指向要操作的Codec组件指针。 | -| callback | 输入参数，指向回调函数[CodecCallbackType](_codec_callback_type.md)对象指针。 | -| appData | 输入参数，指向应用程序定义的值的指针，该值将在回调期间返回。 | -| appDataLen | 输入参数，上层传递的appData字节数。 | - -**返回：** - -HDF_SUCCESS 表示设置回调成功。 - -HDF_ERR_INVALID_PARAM 表示参数无效，设置回调失败。 - -HDF_ERR_INVALID_OBJECT 表示对象无效，设置回调失败。 - -HDF_ERR_MALLOC_FAIL 表示申请内存失败，设置回调失败。 - -**Since：** - -3.1 - - -### SetConfig - - -``` -int32_t(* CodecComponentType::SetConfig) (struct CodecComponentType *self, uint32_t index, int8_t *cfgStruct, uint32_t cfgStructLen) -``` - -**描述：** - -设置组件的配置。 - -加载组件后可以随时调用此接口设置组件的配置。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| self | 输入参数，指向要操作的Codec组件指针。 | -| index | 输入参数，要设置的结构索引，详见**OMX_INDEXTYPE**。 | -| cfgStruct | 输入参数，指向组件用于初始化的应用程序分配结构的指针。 | -| cfgStructLen | 输入参数，cfgStruct字节数。 | - -**返回：** - -HDF_SUCCESS 表示设置配置成功。 - -HDF_ERR_INVALID_PARAM 表示参数无效，设置失败。 - -HDF_ERR_INVALID_OBJECT 表示对象无效，设置失败。 - -HDF_ERR_MALLOC_FAIL 表示申请内存失败，设置失败。 - -**Since：** - -3.1 - - -### SetParameter - - -``` -int32_t(* CodecComponentType::SetParameter) (struct CodecComponentType *self, uint32_t index, int8_t *paramStruct, uint32_t paramStructLen) -``` - -**描述：** - -设置组件需要的参数。 - -当组件处于OMX_StateLoaded、OMX_StateWaitForResources状态或者端口是去使能状态，用户可通过此接口设置组件参数。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| self | 输入参数，指向要操作的Codec组件指针。 | -| index | 输入参数，要设置的结构索引，详见**OMX_INDEXTYPE**。 | -| paramStruct | 输入参数，指向组件用于初始化的应用程序分配结构的指针。 | -| paramStructLen | 输入参数，paramStruct字节数。 | - -**返回：** - -HDF_SUCCESS 表示设置参数成功。 - -HDF_ERR_INVALID_PARAM 表示参数无效，设置参数失败。 - -HDF_ERR_INVALID_OBJECT 表示对象无效，设置参数失败。 - -HDF_ERR_MALLOC_FAIL 表示申请内存失败，设置参数失败。 - -**Since：** - -3.1 - - -### UseBuffer - - -``` -int32_t(* CodecComponentType::UseBuffer) (struct CodecComponentType *self, uint32_t portIndex, struct OmxCodecBuffer *buffer) -``` - -**描述：** - -指定组件端口的buffer。 - -此接口在以下情况下使用： - -- 当组件处于OMX_StateLoaded状态，并且用户已经向组件发送OMX_StateIdle状态转换请求。 - -- 当组件处于OMX_StateWaitForResources状态，所需的资源可用，并且组件已准备好进入OMX_StateIdle状态。 - -- 在去使能端口上，组件处于OMX_StateExecuting、OMX_StatePause或OMX_StateIdle状态。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| self | 输入参数，指向要操作的Codec组件指针。 | -| portIndex | 输入参数，指定的组件端口。 | -| buffer | 输入输出参数，指向要使用的buffer结构体[OmxCodecBuffer](_omx_codec_buffer.md)指针。 | - -**返回：** - -HDF_SUCCESS 表示指定成功。 - -HDF_ERR_INVALID_PARAM 表示参数无效，指定失败。 - -HDF_ERR_INVALID_OBJECT 表示对象无效，指定失败。 - -HDF_ERR_MALLOC_FAIL 表示申请内存失败，指定失败。 - -**Since：** - -3.1 - - -### UseEglImage - - -``` -int32_t(* CodecComponentType::UseEglImage) (struct CodecComponentType *self, struct OmxCodecBuffer *buffer, uint32_t portIndex, int8_t *eglImage, uint32_t eglImageLen) -``` - -**描述：** - -使用已在EGL中申请的空间。 - -此接口在以下情况下使用： - -- 当组件处于OMX_StateLoaded状态，并且已经向组件发送OMX_StateIdle状态转换请求。 - -- 当组件处于OMX_StateWaitForResources状态，所需的资源可用，并且组件已准备好进入OMX_StateIdle状态。 - -- 在去使能端口上，组件处于OMX_StateExecuting、OMX_StatePause或OMX_StateIdle状态。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| self | 输入参数，指向要操作的Codec组件指针。 | -| buffer | 输入输出参数，指向[OmxCodecBuffer](_omx_codec_buffer.md)结构体的指针。 | -| portIndex | 输入参数，指定的组件端口。 | -| eglImage | 输入参数，EGL申请的图像指针。 | -| eglImageLen | 输入参数，eglImage字节数。 | - -**返回：** - -HDF_SUCCESS 表示使用成功。 - -HDF_ERR_INVALID_PARAM 表示参数无效，使用失败。 - -HDF_ERR_INVALID_OBJECT 表示对象无效，使用失败。 - -HDF_ERR_MALLOC_FAIL 表示申请内存失败，使用失败。 - -**Since：** - -3.1 diff --git a/zh-cn/device-dev/reference/hdi-apis/_codec_callback_type.md b/zh-cn/device-dev/reference/hdi-apis/_codec_callback_type.md index adf3edf8dd060694cd88c7d590360ca591ec7527..a8e953b4c83018037268342dcbe6d7abf7d5e3c5 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_codec_callback_type.md +++ b/zh-cn/device-dev/reference/hdi-apis/_codec_callback_type.md @@ -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的指针。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_codec_comp_capability.md b/zh-cn/device-dev/reference/hdi-apis/_codec_comp_capability.md index f8900208d56a534c34c0204d6d8124024c4fc9b6..90cf2509f95cad1c5cfbb92dc82241320c9a1aa0 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_codec_comp_capability.md +++ b/zh-cn/device-dev/reference/hdi-apis/_codec_comp_capability.md @@ -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 **描述：** -编解码类型 +编解码类型。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_codec_component_manager.md b/zh-cn/device-dev/reference/hdi-apis/_codec_component_manager.md index 22b2d95f61a7a6529fdf473dcec84ed2a8bedd22..00ea99f6b089455040d9aadc8234222404cabc28 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_codec_component_manager.md +++ b/zh-cn/device-dev/reference/hdi-apis/_codec_component_manager.md @@ -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编解码组件数量。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_codec_component_type.md b/zh-cn/device-dev/reference/hdi-apis/_codec_component_type.md index 0850d4c66221b70819644d1f2d693e094c82d1ed..3840fc5721763eb96cff3ff7d070b3f85ed5fbeb 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_codec_component_type.md +++ b/zh-cn/device-dev/reference/hdi-apis/_codec_component_type.md @@ -3,9 +3,25 @@ ## **概述** -**所属模块:** +Codec组件接口定义。 + +主要提供以下功能: + +- 获取组件的版本。 + +- 组件参数配置的获取和设置。 + +- 发送命令至组件及获取组件状态。 + +- 设置回调函数。 + +- 设置/释放组件使用的buffer。 + +- 编解码输入输出buffer处理 具体方法使用详见函数说明。 -[Codec](_codec.md) +**相关模块:** + +[Codec](codec.md) ## **汇总** @@ -13,42 +29,632 @@ ### Public 属性 - | Public 属性 | 描述 | -| -------- | -------- | -| ( [GetComponentVersion](_codec.md#getcomponentversion) )(struct CodecComponentType \*self, struct [CompVerInfo](_comp_ver_info.md) \*verInfo) | 获取Codec组件版本号。 [更多...](_codec.md#getcomponentversion) | -| ( [SendCommand](_codec.md#sendcommand) )(struct CodecComponentType \*self, enum OMX_COMMANDTYPE cmd, uint32_t param, int8_t \*cmdData, uint32_t cmdDataLen) | 发送命令给组件。 [更多...](_codec.md#sendcommand) | -| ( [GetParameter](_codec.md#getparameter) )(struct CodecComponentType \*self, uint32_t paramIndex, int8_t \*paramStruct, uint32_t paramStructLen) | 获取组件参数设置。 [更多...](_codec.md#getparameter) | -| ( [SetParameter](_codec.md#setparameter) )(struct CodecComponentType \*self, uint32_t index, int8_t \*paramStruct, uint32_t paramStructLen) | 设置组件需要的参数。 [更多...](_codec.md#setparameter) | -| ( [GetConfig](_codec.md#getconfig) )(struct CodecComponentType \*self, uint32_t index, int8_t \*cfgStruct, uint32_t cfgStructLen) | 获取组件的配置结构。 [更多...](_codec.md#getconfig) | -| ( [SetConfig](_codec.md#setconfig) )(struct CodecComponentType \*self, uint32_t index, int8_t \*cfgStruct, uint32_t cfgStructLen) | 设置组件的配置。 [更多...](_codec.md#setconfig) | -| ( [GetExtensionIndex](_codec.md#getextensionindex) )(struct CodecComponentType \*self, const char \*paramName, uint32_t \*indexType) | 根据字符串获取组件的扩展索引。 [更多...](_codec.md#getextensionindex) | -| ( [GetState](_codec.md#getstate) )(struct CodecComponentType \*self, enum OMX_STATETYPE \*state) | 获取组件的当前状态。 [更多...](_codec.md#getstate) | -| ( [ComponentTunnelRequest](_codec.md#componenttunnelrequest) )(struct CodecComponentType \*self, uint32_t port, int32_t tunneledComp, uint32_t tunneledPort, struct OMX_TUNNELSETUPTYPE \*tunnelSetup) | 设置组件采用Tunnel方式通信。 [更多...](_codec.md#componenttunnelrequest) | -| ( [UseBuffer](_codec.md#usebuffer) )(struct CodecComponentType \*self, uint32_t portIndex, struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 指定组件端口的buffer。 [更多...](_codec.md#usebuffer) | -| ( [AllocateBuffer](_codec.md#allocatebuffer) )(struct CodecComponentType \*self, uint32_t portIndex, struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 向组件申请端口buffer。 [更多...](_codec.md#allocatebuffer) | -| ( [FreeBuffer](_codec.md#freebuffer) )(struct CodecComponentType \*self, uint32_t portIndex, const struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 释放buffer。 [更多...](_codec.md#freebuffer) | -| ( [EmptyThisBuffer](_codec.md#emptythisbuffer) )(struct CodecComponentType \*self, const struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 编解码输入待处理buffer。 [更多...](_codec.md#emptythisbuffer) | -| ( [FillThisBuffer](_codec.md#fillthisbuffer) )(struct CodecComponentType \*self, const struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 编解码输出填充buffer。 [更多...](_codec.md#fillthisbuffer) | -| ( [SetCallbacks](_codec.md#setcallbacks) )(struct CodecComponentType \*self, struct [CodecCallbackType](_codec_callback_type.md) \*callback, int8_t \*appData, uint32_t appDataLen) | 设置Codec组件的回调函数。 [更多...](_codec.md#setcallbacks) | -| ( [ComponentDeInit](_codec.md#componentdeinit) )(struct CodecComponentType \*self) | 组件去初始化。 [更多...](_codec.md#componentdeinit) | -| ( [UseEglImage](_codec.md#useeglimage) )(struct CodecComponentType \*self, struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer, uint32_t portIndex, int8_t \*eglImage, uint32_t eglImageLen) | 使用已在EGL中申请的空间。 [更多...](_codec.md#useeglimage) | -| ( [ComponentRoleEnum](_codec.md#componentroleenum) )(struct [CodecComponentType \*self, uint8_t \*role, uint32_t roleLen, uint32_t index) | 获取组件角色。 [更多...](_codec.md#componentroleenum) | - - -## **详细描述** + | 名称 | 描述 | +| -------- | -------- | +| ([GetComponentVersion](#getcomponentversion) )(struct CodecComponentType \*self, struct CompVerInfo \*verInfo) | 获取Codec组件版本号。 | +| ([SendCommand](#sendcommand) )(struct CodecComponentType \*self, enum OMX_COMMANDTYPE cmd, uint32_t param, int8_t \*cmdData, uint32_t cmdDataLen) | 发送命令给组件。 | +| ([GetParameter](#getparameter) )(struct CodecComponentType \*self, uint32_t paramIndex, int8_t \*paramStruct, uint32_t paramStructLen) | 获取组件参数设置。 | +| ([SetParameter](#setparameter) )(struct CodecComponentType \*self, uint32_t index, int8_t \*paramStruct, uint32_t paramStructLen) | 设置组件需要的参数。 | +| ([GetConfig](#getconfig) )(struct CodecComponentType \*self, uint32_t index, int8_t \*cfgStruct, uint32_t cfgStructLen) | 获取组件的配置结构。 | +| ([SetConfig](#setconfig) )(struct CodecComponentType \*self, uint32_t index, int8_t \*cfgStruct, uint32_t cfgStructLen) | 设置组件的配置。 | +| ([GetExtensionIndex](#getextensionindex) )(struct CodecComponentType \*self, const char \*paramName, uint32_t \*indexType) | 根据字符串获取组件的扩展索引。 | +| ([GetState](#getstate) )(struct CodecComponentType \*self, enum OMX_STATETYPE \*state) | 获取组件的当前状态。 | +| ([ComponentTunnelRequest](#componenttunnelrequest) )(struct CodecComponentType \*self, uint32_t port, int32_t tunneledComp, uint32_t tunneledPort, struct OMX_TUNNELSETUPTYPE \*tunnelSetup) | 设置组件采用Tunnel方式通信。 | +| ([UseBuffer](#usebuffer) )(struct CodecComponentType \*self, uint32_t portIndex, struct OmxCodecBuffer \*buffer) | 指定组件端口的buffer。 | +| ([AllocateBuffer](#allocatebuffer) )(struct CodecComponentType \*self, uint32_t portIndex, struct OmxCodecBuffer \*buffer) | 向组件申请端口buffer。 | +| ([FreeBuffer](#freebuffer) )(struct CodecComponentType \*self, uint32_t portIndex, const struct OmxCodecBuffer \*buffer) | 释放buffer。 | +| ([EmptyThisBuffer](#emptythisbuffer) )(struct CodecComponentType \*self, const struct OmxCodecBuffer \*buffer) | 编解码输入待处理buffer。 | +| ([FillThisBuffer](#fillthisbuffer) )(struct CodecComponentType \*self, const struct OmxCodecBuffer \*buffer) | 编解码输出填充buffer。 | +| ([SetCallbacks](#setcallbacks) )(struct CodecComponentType \*self, struct CodecCallbackType \*callback, int8_t \*appData, uint32_t appDataLen) | 设置Codec组件的回调函数。 | +| ([ComponentDeInit](#componentdeinit) )(struct CodecComponentType \*self) | 组件去初始化。 | +| ([UseEglImage](#useeglimage) )(struct CodecComponentType \*self, struct OmxCodecBuffer \*buffer, uint32_t portIndex, int8_t \*eglImage, uint32_t eglImageLen) | 使用已在EGL中申请的空间。 | +| ([ComponentRoleEnum](#componentroleenum) )(struct CodecComponentType \*self, uint8_t \*role, uint32_t roleLen, uint32_t index) | 获取组件角色。 | -Codec组件接口定义。 -主要提供以下功能： +## **类成员变量说明** -- 获取组件的版本。 -- 组件参数配置的获取和设置。 +### AllocateBuffer -- 发送命令至组件及获取组件状态。 + +``` +int32_t(* CodecComponentType::AllocateBuffer) (struct CodecComponentType *self, uint32_t portIndex, struct OmxCodecBuffer *buffer) +``` -- 设置回调函数。 +**描述：** -- 设置/释放组件使用的buffer。 +向组件申请端口buffer。 -- 编解码输入输出buffer处理 具体方法使用详见函数说明。 +向组件申请分配新的buffer，此接口在以下情况下使用： + +- 当组件处于OMX_StateLoaded状态，并且用户已经向组件发送OMX_StateIdle状态转换请求。 + +- 当组件处于OMX_StateWaitForResources状态，所需的资源可用，并且组件已准备好进入OMX_StateIdle状态。 + +- 在去使能端口上，组件处于OMX_StateExecuting、OMX_StatePause或OMX_StateIdle状态。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| self | 输入参数，指向要操作的Codec组件指针。 | +| portIndex | 输入参数，指定的组件端口。 | +| buffer | 输入输出参数，指向要申请的buffer结构体[OmxCodecBuffer](_omx_codec_buffer.md)指针。 | + +**返回:** + +HDF_SUCCESS 表示申请buffer成功。 + +HDF_ERR_INVALID_PARAM 表示参数无效，申请buffer失败。 + +HDF_ERR_INVALID_OBJECT 表示对象无效，申请buffer失败。 + +HDF_ERR_MALLOC_FAIL 表示申请内存失败，申请buffer失败。 + + +### ComponentDeInit + + +``` +int32_t(* CodecComponentType::ComponentDeInit) (struct CodecComponentType *self) +``` + +**描述：** + +组件去初始化。 + +调用此接口使组件去初始化，当组件处于OMX_StateLoaded状态时，将直接关闭组件。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| self | 输入参数，指向要操作的Codec组件指针。 | + +**返回:** + +HDF_SUCCESS 表示去初始化成功。 + +HDF_ERR_INVALID_PARAM 表示参数无效，去初始化失败。 + +HDF_ERR_INVALID_OBJECT 表示对象无效，去初始化失败。 + +HDF_ERR_MALLOC_FAIL 表示申请内存失败，去初始化失败。 + + +### ComponentRoleEnum + + +``` +int32_t(* CodecComponentType::ComponentRoleEnum) (struct CodecComponentType *self, uint8_t *role, uint32_t roleLen, uint32_t index) +``` + +**描述：** + +获取组件角色。 + +根据组件角色索引获取对应组件角色。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| self | 输入参数，指向要操作的Codec组件指针。 | +| role | 输出参数，角色名称。 | +| roleLen | 输入参数，role字节数。 | +| index | 输入参数，角色的索引，一个组件可能支持多种角色。 | + +**返回:** + +HDF_SUCCESS 表示获取角色成功。 + +HDF_ERR_INVALID_PARAM 表示参数无效，获取角色失败。 + +HDF_ERR_INVALID_OBJECT 表示对象无效，获取角色失败。 + +HDF_ERR_MALLOC_FAIL 表示申请内存失败，获取角色失败。 + + +### ComponentTunnelRequest + + +``` +int32_t(* CodecComponentType::ComponentTunnelRequest) (struct CodecComponentType *self, uint32_t port, int32_t tunneledComp, uint32_t tunneledPort, struct OMX_TUNNELSETUPTYPE *tunnelSetup) +``` + +**描述：** + +设置组件采用Tunnel方式通信。 + +当组件处于OMX_StateLoaded 状态时，用户通过调用此接口确定组件是否可以进行Tunnel传输，如果可以则设置组件的Tunnel传输。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| self | 输入参数，指向要操作的Codec组件指针。 | +| port | 输入参数，组件设置的端口。 | +| tunneledComp | 输入参数，组件的tunnel handle。 | +| tunneledPort | 输入参数，组件用来Tunnel通信的端口。 | +| tunnelSetup | 输入输出参数，指向Tunnel设置的结构体**OMX_TUNNELSETUPTYPE**指针。 | + +**返回:** + +HDF_SUCCESS 表示设置成功。 + +HDF_ERR_INVALID_PARAM 表示参数无效，设置失败。 + +HDF_ERR_INVALID_OBJECT 表示对象无效，设置失败。 + +HDF_ERR_MALLOC_FAIL 表示申请内存失败，设置失败。 + + +### EmptyThisBuffer + + +``` +int32_t(* CodecComponentType::EmptyThisBuffer) (struct CodecComponentType *self, const struct OmxCodecBuffer *buffer) +``` + +**描述：** + +编解码输入待处理buffer。 + +此接口在组件处于OMX_StateExecuting或者OMX_StatePause状态时调用。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| self | 输入参数，指向要操作的Codec组件指针。 | +| buffer | 输入参数，指向[OmxCodecBuffer](_omx_codec_buffer.md)结构体的指针。 | + +**返回:** + +HDF_SUCCESS 表示输入buffer成功。 + +HDF_ERR_INVALID_PARAM 表示参数无效，输入buffer失败。 + +HDF_ERR_INVALID_OBJECT 表示对象无效，输入buffer失败。 + +HDF_ERR_MALLOC_FAIL 表示申请内存失败，输入buffer失败。 + + +### FillThisBuffer + + +``` +int32_t(* CodecComponentType::FillThisBuffer) (struct CodecComponentType *self, const struct OmxCodecBuffer *buffer) +``` + +**描述：** + +编解码输出填充buffer。 + +此接口在组件处于OMX_StateExecuting或者OMX_StatePause状态时调用。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| self | 输入参数，指向要操作的Codec组件指针。 | +| buffer | 输入参数，指向[OmxCodecBuffer](_omx_codec_buffer.md)结构体的指针。 | + +**返回:** + +HDF_SUCCESS 表示填充buffer成功。 + +HDF_ERR_INVALID_PARAM 表示参数无效，填充buffer失败。 + +HDF_ERR_INVALID_OBJECT 表示对象无效，填充buffer失败。 + +HDF_ERR_MALLOC_FAIL 表示申请内存失败，填充buffer失败。 + + +### FreeBuffer + + +``` +int32_t(* CodecComponentType::FreeBuffer) (struct CodecComponentType *self, uint32_t portIndex, const struct OmxCodecBuffer *buffer) +``` + +**描述：** + +释放buffer。 + +此接口在以下情况下使用： + +- 当组件处于OMX_StateIdle状态，并且已经向组件发送OMX_StateLoaded状态转换请求。 + +- 在去使能端口上，组件处于OMX_StateExecuting、OMX_StatePause或OMX_StateIdle时调用。 + +- 此接口调用可随时进行，但是如果未在上述情况下执行，可能会导致组件上报OMX_ErrorPortUnpopulated事件。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| self | 输入参数，指向要操作的Codec组件指针。 | +| portIndex | 输入参数，指定的组件端口。 | +| buffer | 输入参数，指向[OmxCodecBuffer](_omx_codec_buffer.md)结构体的指针。 | + +**返回:** + +HDF_SUCCESS 表示释放buffer成功。 + +HDF_ERR_INVALID_PARAM 表示参数无效，释放buffer失败。 + +HDF_ERR_INVALID_OBJECT 表示对象无效，释放buffer失败。 + +HDF_ERR_MALLOC_FAIL 表示申请内存失败，释放buffer失败。 + + +### GetComponentVersion + + +``` +int32_t(* CodecComponentType::GetComponentVersion) (struct CodecComponentType *self, struct CompVerInfo *verInfo) +``` + +**描述：** + +获取Codec组件版本号。 + +通过查询组件，返回组件版本信息。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| self | 输入参数，指向要操作的Codec组件指针。 | +| verInfo | 输出参数，指向组件版本信息的指针，详见[CompVerInfo](_comp_ver_info.md)。 | + +**返回:** + +HDF_SUCCESS 表示获取版本号成功。 + +HDF_ERR_INVALID_PARAM 表示参数无效，获取版本号失败。 + +HDF_ERR_INVALID_OBJECT 表示对象无效，获取版本号失败。 + +HDF_ERR_MALLOC_FAIL 表示申请内存失败，获取版本号失败。 + + +### GetConfig + + +``` +int32_t(* CodecComponentType::GetConfig) (struct CodecComponentType *self, uint32_t index, int8_t *cfgStruct, uint32_t cfgStructLen) +``` + +**描述：** + +获取组件的配置结构。 + +加载组件后可以随时调用此接口获取组件的配置。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| self | 输入参数，指向要操作的Codec组件指针。 | +| index | 输入参数，待填充结构的索引，详见**OMX_INDEXTYPE**。 | +| cfgStruct | 输入输出参数，指向由组件填充的应用程序分配的结构体指针。 | +| cfgStructLen | 输入参数，上层传入的cfgStruct字节数。 | + +**返回:** + +HDF_SUCCESS 表示获取配置成功。 + +HDF_ERR_INVALID_PARAM 表示参数无效，获取配置失败。 + +HDF_ERR_INVALID_OBJECT 表示对象无效，获取配置失败。 + +HDF_ERR_MALLOC_FAIL 表示申请内存失败，获取配置失败。 + + +### GetExtensionIndex + + +``` +int32_t(* CodecComponentType::GetExtensionIndex) (struct CodecComponentType *self, const char *paramName, uint32_t *indexType) +``` + +**描述：** + +根据字符串获取组件的扩展索引。 + +将扩展字符串转换为Openmax IL结构索引。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| self | 输入参数，指向要操作的Codec组件指针。 | +| paramName | 输入参数，组件用来转换为配置索引的字符串。 | +| indexType | 输出参数，由paramName转换的配置索引，详见**OMX_INDEXTYPE**。 | + +**返回:** + +HDF_SUCCESS 表示获取扩展索引成功。 + +HDF_ERR_INVALID_PARAM 表示参数无效，获取扩展索引失败。 + +HDF_ERR_INVALID_OBJECT 表示对象无效，获取扩展索引失败。 + +HDF_ERR_MALLOC_FAIL 表示申请内存失败，获取扩展索引失败。 + + +### GetParameter + + +``` +int32_t(* CodecComponentType::GetParameter) (struct CodecComponentType *self, uint32_t paramIndex, int8_t *paramStruct, uint32_t paramStructLen) +``` + +**描述：** + +获取组件参数设置。 + +当组件处于除了OMX_StateInvalid（组件状态异常）之外的其他状态，用户可通过此接口获取组件参数。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| self | 输入参数，指向要操作的Codec组件指针。 | +| paramIndex | 输入参数，待填充结构的索引，详见**OMX_INDEXTYPE**。 | +| paramStruct | 输入输出参数，指向由组件填充的应用程序分配的结构体指针。 | +| paramStructLen | 输入参数，paramStruct字节数。 | + +**返回:** + +HDF_SUCCESS 表示获取参数成功。 + +HDF_ERR_INVALID_PARAM 表示参数无效，获取参数失败。 + +HDF_ERR_INVALID_OBJECT 表示对象无效，获取参数失败。 + +HDF_ERR_MALLOC_FAIL 表示申请内存失败，获取参数失败。 + + +### GetState + + +``` +int32_t(* CodecComponentType::GetState) (struct CodecComponentType *self, enum OMX_STATETYPE *state) +``` + +**描述：** + +获取组件的当前状态。 + +用户可调用此接口获取组件的当前状态，组件状态详见**OMX_STATETYPE**。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| self | 输入参数，指向要操作的Codec组件指针。 | +| state | 输出参数，指向获取到的状态指针，组件状态详见**OMX_STATETYPE**。 | + +**返回:** + +HDF_SUCCESS 表示获取状态成功。 + +HDF_ERR_INVALID_PARAM 表示参数无效，获取状态失败。 + +HDF_ERR_INVALID_OBJECT 表示对象无效，获取状态失败。 + +HDF_ERR_MALLOC_FAIL 表示申请内存失败，获取状态失败。 + + +### SendCommand + + +``` +int32_t(* CodecComponentType::SendCommand) (struct CodecComponentType *self, enum OMX_COMMANDTYPE cmd, uint32_t param, int8_t *cmdData, uint32_t cmdDataLen) +``` + +**描述：** + +发送命令给组件。 + +当命令为设置状态时，会有事件回调通知结果给上层，其他命令则没有事件上报。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| self | 输入参数，指向要操作的Codec组件指针。 | +| cmd | 输入参数，组件要执行的命令，详见**OMX_COMMANDTYPE**。 | +| param | 输入参数，组件要执行的命令携带的参数。
- 当cmd为OMX_CommandStateSet时，param的值详见**OMX_STATETYPE**。
- 当cmd为OMX_CommandFlush、OMX_CommandPortDisable、OMX_CommandPortEnable、OMX_CommandMarkBuffer时，param为目标端口。 | +| cmdData | 输入参数，当cmd为OMX_CommandMarkBuffer时，指向OMX_MARKTYPE结构体指针。 | +| cmdDataLen | 输入参数，上层传递的cmdData字节数。 | + +**返回:** + +HDF_SUCCESS 表示发送命令成功。 + +HDF_ERR_INVALID_PARAM 表示参数无效，发送命令失败。 + +HDF_ERR_INVALID_OBJECT 表示对象无效，发送命令失败。 + +HDF_ERR_MALLOC_FAIL 表示申请内存失败，发送命令失败。 + + +### SetCallbacks + + +``` +int32_t(* CodecComponentType::SetCallbacks) (struct CodecComponentType *self, struct CodecCallbackType *callback, int8_t *appData, uint32_t appDataLen) +``` + +**描述：** + +设置Codec组件的回调函数。 + +当组件处于OMX_StateLoaded状态时，使用此回调函数向上通知事件以及上报可用的输入输出信息。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| self | 输入参数，指向要操作的Codec组件指针。 | +| callback | 输入参数，指向回调函数[CodecCallbackType](_codec_callback_type.md)对象指针。 | +| appData | 输入参数，指向应用程序定义的值的指针，该值将在回调期间返回。 | +| appDataLen | 输入参数，上层传递的appData字节数。 | + +**返回:** + +HDF_SUCCESS 表示设置回调成功。 + +HDF_ERR_INVALID_PARAM 表示参数无效，设置回调失败。 + +HDF_ERR_INVALID_OBJECT 表示对象无效，设置回调失败。 + +HDF_ERR_MALLOC_FAIL 表示申请内存失败，设置回调失败。 + + +### SetConfig + + +``` +int32_t(* CodecComponentType::SetConfig) (struct CodecComponentType *self, uint32_t index, int8_t *cfgStruct, uint32_t cfgStructLen) +``` + +**描述：** + +设置组件的配置。 + +加载组件后可以随时调用此接口设置组件的配置。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| self | 输入参数，指向要操作的Codec组件指针。 | +| index | 输入参数，要设置的结构索引，详见**OMX_INDEXTYPE**。 | +| cfgStruct | 输入参数，指向组件用于初始化的应用程序分配结构的指针。 | +| cfgStructLen | 输入参数，cfgStruct字节数。 | + +**返回:** + +HDF_SUCCESS 表示设置配置成功。 + +HDF_ERR_INVALID_PARAM 表示参数无效，设置失败。 + +HDF_ERR_INVALID_OBJECT 表示对象无效，设置失败。 + +HDF_ERR_MALLOC_FAIL 表示申请内存失败，设置失败。 + + +### SetParameter + + +``` +int32_t(* CodecComponentType::SetParameter) (struct CodecComponentType *self, uint32_t index, int8_t *paramStruct, uint32_t paramStructLen) +``` + +**描述：** + +设置组件需要的参数。 + +当组件处于OMX_StateLoaded、OMX_StateWaitForResources状态或者端口是去使能状态，用户可通过此接口设置组件参数。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| self | 输入参数，指向要操作的Codec组件指针。 | +| index | 输入参数，要设置的结构索引，详见**OMX_INDEXTYPE**。 | +| paramStruct | 输入参数，指向组件用于初始化的应用程序分配结构的指针。 | +| paramStructLen | 输入参数，paramStruct字节数。 | + +**返回:** + +HDF_SUCCESS 表示设置参数成功。 + +HDF_ERR_INVALID_PARAM 表示参数无效，设置参数失败。 + +HDF_ERR_INVALID_OBJECT 表示对象无效，设置参数失败。 + +HDF_ERR_MALLOC_FAIL 表示申请内存失败，设置参数失败。 + + +### UseBuffer + + +``` +int32_t(* CodecComponentType::UseBuffer) (struct CodecComponentType *self, uint32_t portIndex, struct OmxCodecBuffer *buffer) +``` + +**描述：** + +指定组件端口的buffer。 + +此接口在以下情况下使用： + +- 当组件处于OMX_StateLoaded状态，并且用户已经向组件发送OMX_StateIdle状态转换请求。 + +- 当组件处于OMX_StateWaitForResources状态，所需的资源可用，并且组件已准备好进入OMX_StateIdle状态。 + +- 在去使能端口上，组件处于OMX_StateExecuting、OMX_StatePause或OMX_StateIdle状态。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| self | 输入参数，指向要操作的Codec组件指针。 | +| portIndex | 输入参数，指定的组件端口。 | +| buffer | 输入输出参数，指向要使用的buffer结构体[OmxCodecBuffer](_omx_codec_buffer.md)指针。 | + +**返回:** + +HDF_SUCCESS 表示指定成功。 + +HDF_ERR_INVALID_PARAM 表示参数无效，指定失败。 + +HDF_ERR_INVALID_OBJECT 表示对象无效，指定失败。 + +HDF_ERR_MALLOC_FAIL 表示申请内存失败，指定失败。 + + +### UseEglImage + + +``` +int32_t(* CodecComponentType::UseEglImage) (struct CodecComponentType *self, struct OmxCodecBuffer *buffer, uint32_t portIndex, int8_t *eglImage, uint32_t eglImageLen) +``` + +**描述：** + +使用已在EGL中申请的空间。 + +此接口在以下情况下使用： + +- 当组件处于OMX_StateLoaded状态，并且已经向组件发送OMX_StateIdle状态转换请求。 + +- 当组件处于OMX_StateWaitForResources状态，所需的资源可用，并且组件已准备好进入OMX_StateIdle状态。 + +- 在去使能端口上，组件处于OMX_StateExecuting、OMX_StatePause或OMX_StateIdle状态。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| self | 输入参数，指向要操作的Codec组件指针。 | +| buffer | 输入输出参数，指向[OmxCodecBuffer](_omx_codec_buffer.md)结构体的指针。 | +| portIndex | 输入参数，指定的组件端口。 | +| eglImage | 输入参数，EGL申请的图像指针。 | +| eglImageLen | 输入参数，eglImage字节数。 | + +**返回:** + +HDF_SUCCESS 表示使用成功。 + +HDF_ERR_INVALID_PARAM 表示参数无效，使用失败。 + +HDF_ERR_INVALID_OBJECT 表示对象无效，使用失败。 + +HDF_ERR_MALLOC_FAIL 表示申请内存失败，使用失败。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_comp_ver_info.md b/zh-cn/device-dev/reference/hdi-apis/_comp_ver_info.md index ddf1830d2f8d1634cbe777656fdefd8f61615340..debad98682d7b7c71cb85127947c7af43b5cb1e4 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_comp_ver_info.md +++ b/zh-cn/device-dev/reference/hdi-apis/_comp_ver_info.md @@ -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 **描述：** -构建组件所依据的规范的版本信息 +构建组件所依据的规范的版本信息。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_credential_info.md b/zh-cn/device-dev/reference/hdi-apis/_credential_info.md index 2d38ca382a44d3e2df74c71b2a33e3dd69ccf44e..0d892d6244b3c69d8bef954895b02886b2f42271 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_credential_info.md +++ b/zh-cn/device-dev/reference/hdi-apis/_credential_info.md @@ -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 - - ## **类成员变量说明** diff --git a/zh-cn/device-dev/reference/hdi-apis/_device_funcs.md b/zh-cn/device-dev/reference/hdi-apis/_device_funcs.md index a423b267c59d718dc84d6dd28e3ccc8c884bba7b..4d03b1911cff0d4acde50b7e3379574ca1c454c7 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_device_funcs.md +++ b/zh-cn/device-dev/reference/hdi-apis/_device_funcs.md @@ -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)。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_display.md b/zh-cn/device-dev/reference/hdi-apis/_display.md index 6141341af4fda33a02465682073c09b812a63141..0d529bb77463d56dbae6c6349dcde287c0c59730 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_display.md +++ b/zh-cn/device-dev/reference/hdi-apis/_display.md @@ -4,271 +4,443 @@ ## **汇总** +## **概述** + +显示模块驱动接口定义。 + +提供给图形系统使用的驱动接口，包括图层管理、设备控制、图形硬件加速、显示内存管理和回调接口等。 + +**Since**: + +1.0 + +**Version**:。 + +2.0 + + ### 文件 - | 文件 | 描述 | + | 名称 | 描述 | | -------- | -------- | | [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) | 显示类型定义，定义显示驱动接口所使用的数据类型。 | +| [display_vgu.h](display__vgu_8h.md) | 该文件定义2D矢量硬件加速模块相关驱动函数。 | ### 类 - | 类 | 描述 | -| -------- | -------- | -| [DeviceFuncs](_device_funcs.md) | 显示设备控制接口结构体，定义显示设备控制接口函数指针。 [更多...](_device_funcs.md) | -| [GfxFuncs](_gfx_funcs.md) | 显示硬件加速驱动接口结构体，定义硬件加速驱动接口函数指针。 [更多...](_gfx_funcs.md) | -| [GrallocFuncs](_gralloc_funcs.md) | 显示内存驱动接口结构体，定义显示内存驱动接口函数指针。 [更多...](_gralloc_funcs.md) | -| [LayerFuncs](_layer_funcs.md) | 显示图层驱动接口结构体，定义显示图层驱动接口函数指针。 [更多...](_layer_funcs.md) | -| [DisplayInfo](_display_info.md) | 定义显示信息结构体 [更多...](_display_info.md) | -| [LayerInfo](_layer_info.md) | 定义图层信息结构体 [更多...](_layer_info.md) | -| [LayerAlpha](_layer_alpha.md) | 定义图层Alpha信息的结构体 [更多...](_layer_alpha.md) | -| [BufferData](_buffer_data.md) | 定义一层的缓冲区数据，包括虚拟和物理内存地址。 [更多...](_buffer_data.md) | -| [LayerBuffer](_layer_buffer.md) | 图层Buffer，用于存放图层数据。 [更多...](_layer_buffer.md) | -| [IRect](_i_rect.md) | 定义矩形信息 [更多...](_i_rect.md) | -| [ISurface](_i_surface.md) | 用于存放窗口相关信息的结构体定义，提供给硬件加速使用，例如图像合成，位图搬移等操作。 [更多...](_i_surface.md) | -| [ILine](_i_line.md) | 线条描述结构体定义，用于硬件加速绘制直线。 [更多...](_i_line.md) | -| [ICircle](_i_circle.md) | 圆形描述结构体定义，用于硬件加速绘制圆形。 [更多...](_i_circle.md) | -| [Rectangle](_rectangle.md) | 矩形描述结构体定义，用于硬件加速绘制矩形， [更多...](_rectangle.md) | -| [GfxOpt](_gfx_opt.md) | 图像硬件加速相关的操作选项结构体定义，用于图像硬件加速时的操作选项。 [更多...](_gfx_opt.md) | -| [PropertyObject](_property_object.md) | 定义包含名称、属性ID和值的属性对象。 [更多...](_property_object.md) | -| [DisplayCapability](_display_capability.md) | 定义输出性能。 [更多...](_display_capability.md) | -| [DisplayModeInfo](_display_mode_info.md) | 定义输出模式信息。 [更多...](_display_mode_info.md) | -| [AllocInfo](_alloc_info.md) | 定义关于要分配的内存的信息。 [更多...](_alloc_info.md) | -| [HDRCapability](_h_d_r_capability.md) | HDR属性结构体定义 [更多...](_h_d_r_capability.md) | -| [HDRMetaData](_h_d_r_meta_data.md) | HDR元数据结构体定义 [更多...](_h_d_r_meta_data.md) | -| [VerifyAllocInfo](_verify_alloc_info.md) | 用于验证内存分配信息的结构体定义 [更多...](_verify_alloc_info.md) | -| [PresentTimestamp](_present_timestamp.md) | 上屏时间戳结构体定义 [更多...](_present_timestamp.md) | -| [__attribute__](____attribute____.md) | 扩展数据句柄结构体定义 [更多...](____attribute____.md) | + | 名称 | 描述 | +| -------- | -------- | +| [DeviceFuncs](_device_funcs.md) | 显示设备控制接口结构体，定义显示设备控制接口函数指针。 | +| [GfxFuncs](_gfx_funcs.md) | 显示硬件加速驱动接口结构体，定义硬件加速驱动接口函数指针。 | +| [GrallocFuncs](_gralloc_funcs.md) | 显示内存驱动接口结构体，定义显示内存驱动接口函数指针。 | +| [LayerFuncs](_layer_funcs.md) | 显示图层驱动接口结构体，定义显示图层驱动接口函数指针。 | +| [DisplayInfo](_display_info.md) | 定义显示信息结构体 | +| [LayerInfo](_layer_info.md) | 定义图层信息结构体 | +| [LayerAlpha](_layer_alpha.md) | 定义图层Alpha信息的结构体 | +| [BufferData](_buffer_data.md) | 定义一层的缓冲区数据，包括虚拟和物理内存地址。 | +| [LayerBuffer](_layer_buffer.md) | 图层Buffer，用于存放图层数据。 | +| [IRect](_i_rect.md) | 定义矩形信息。 | +| [ISurface](_i_surface.md) | 用于存放窗口相关信息的结构体定义，提供给硬件加速使用，例如图像合成，位图搬移等操作。 | +| [ILine](_i_line.md) | 线条描述结构体定义，用于硬件加速绘制直线。 | +| [ICircle](_i_circle.md) | 圆形描述结构体定义，用于硬件加速绘制圆形。 | +| [Rectangle](_rectangle.md) | 矩形描述结构体定义，用于硬件加速绘制矩形。 | +| [GfxOpt](_gfx_opt.md) | 图像硬件加速相关的操作选项结构体定义，用于图像硬件加速时的操作选项。 | +| [PropertyObject](_property_object.md) | 定义包含名称、属性ID和值的属性对象。 | +| [DisplayCapability](_display_capability.md) | 定义输出性能。 | +| [DisplayModeInfo](_display_mode_info.md) | 定义输出模式信息。 | +| [AllocInfo](_alloc_info.md) | 定义关于要分配的内存的信息。 | +| [HDRCapability](_h_d_r_capability.md) | HDR属性结构体定义。 | +| [HDRMetaData](_h_d_r_meta_data.md) | HDR元数据结构体定义。 | +| [VerifyAllocInfo](_verify_alloc_info.md) | 用于验证内存分配信息的结构体定义。 | +| [PresentTimestamp](_present_timestamp.md) | 上屏时间戳结构体定义。 | +| [ExtDataHandle](_ext_data_handle.md) | 扩展数据句柄结构体定义。 | +| [YUVDescInfo](_yun_desc_info_.md) | YUV描述信息结构体定义。 | +| [VGUPoint](_v_g_u_point.md) | 坐标点对象。 | +| [VGURect](_v_g_u_rect.md) | 矩形对象。 | +| [VGUPath](_v_g_u_path.md) | 路径对象，存放路径命令和坐标数据。 | +| [VGUMatrix3](_v_g_u_matrix3.md) | 变换矩阵。 | +| [VGUBuffer](_v_g_u_buffer.md) | 硬件加速渲染位图缓存。 | +| [VGUMaskLayer](_v_g_u_mask_layer.md) | 定义蒙版图层。 | +| [VGUSurface](_v_g_u_surface.md) | 2D硬件加速绘制目标表面。 | +| [VGUColorStop](_v_g_u_color_stop.md) | 渐变颜色分布位置。 | +| [VGULinear](_v_g_u_linear.md) | 线性渐变。 | +| [VGURadial](_v_g_u_radial.md) | 辐射渐变。 | +| [VGUConic](_v_g_u_conic.md) | 圆锥渐变。 | +| [VGUImage](_v_g_u_image.md) | 图像对象。 | +| [VGUPattern](_v_g_u_pattern.md) | 图片模式对象。 | +| [VGUGradient](_v_g_u_gradient.md) | 渐变对象。 | +| [VGUSolid](_v_g_u_solid.md) | 颜色对象。 | +| [VGUPaintStyle](_v_g_u_paint_style.md) | 填充或描边路径的渲染风格。 | +| [VGUFillAttr](_v_g_u_fill_attr.md) | 填充路径的属性。 | +| [VGUStrokeAttr](_v_g_u_stroke_attr.md) | 描边路径的属性。 | +| [VGUFuncs](_v_g_u_funcs.md) | 定义2D硬件加速驱动函数。 | ### 宏定义 - | 宏定义 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| **PROPERTY_NAME_LEN**   50 | 属性名字长度。 | +| [PROPERTY_NAME_LEN](#propertynamelen)   50 | 属性名字长度。 | +| **HDI_VGU_SCALAR_IS_FLOAT**   1 | | ### 类型定义 - | 类型定义 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| ([HotPlugCallback](#hotplugcallback)) (uint32_t devId, bool connected, void \*data) | 热插拔事件回调。[更多...](#hotplugcallback) | -| ([VBlankCallback](#vblankcallback)) (unsigned int sequence, uint64_t ns, void \*data) | VBlank 事件回调。 [更多...](#vblankcallback) | -| ([RefreshCallback](#refreshcallback)) (uint32_t devId, void \*data) | 刷新请求回调。[更多...](#refreshcallback) | +| ([HotPlugCallback](#hotplugcallback)) (uint32_t devId, bool connected, void \*data) | 热插拔事件回调 。 | +| ([VBlankCallback](#vblankcallback)) (unsigned int sequence, uint64_t ns, void \*data) | VBlank 事件回调。 | +| ([RefreshCallback](#refreshcallback)) (uint32_t devId, void \*data) | 刷新请求回调 。 | +| **(VGUScalar** |   
```
#ifdef HDI_VGU_SCALAR_IS_FLOATtypedef float VGUScalar;#elsetypedef int32_t VGUScalar;#endif
``` | +| [VGUPixelFormat](#vgupixelformat) | 像素格式。 | +| [VGUBlendType](#vgublendtype) | 混合操作类型。 | ### 枚举 - | 枚举 | 描述 | -| -------- | -------- | -| [DispErrCode](#disperrcode) { DISPLAY_SUCCESS = 0, DISPLAY_FAILURE = -1, DISPLAY_FD_ERR = -2, DISPLAY_PARAM_ERR = -3,   DISPLAY_NULL_PTR = -4, DISPLAY_NOT_SUPPORT = -5, DISPLAY_NOMEM = -6, DISPLAY_SYS_BUSY = -7,   DISPLAY_NOT_PERM = -8 } | 返回值类型定义。 [更多...](#disperrcode) | -| [LayerType](#layertype) { LAYER_TYPE_GRAPHIC, LAYER_TYPE_OVERLAY, LAYER_TYPE_SIDEBAND, LAYER_TYPE_CURSOR,   LAYER_TYPE_BUTT } | 图层类型定义。 [更多...](#layertype) | -| { HBM_USE_CPU_READ = (1 << 0), HBM_USE_CPU_WRITE = (1 << 1), HBM_USE_MEM_MMZ = (1 << 2), HBM_USE_MEM_DMA = (1 << 3),   HBM_USE_MEM_SHARE = (1 << 4), HBM_USE_MEM_MMZ_CACHE = (1 << 5), HBM_USE_MEM_FB = (1 << 6), HBM_USE_ASSIGN_SIZE = (1 << 7) } | 缓冲区定义。[更多...](#anonymous-enum) | -| [PixelFormat](#pixelformat) { PIXEL_FMT_CLUT8 = 0, PIXEL_FMT_CLUT1, PIXEL_FMT_CLUT4, PIXEL_FMT_RGB_565,   PIXEL_FMT_RGBA_5658, PIXEL_FMT_RGBX_4444, PIXEL_FMT_RGBA_4444, PIXEL_FMT_RGB_444,   PIXEL_FMT_RGBX_5551, PIXEL_FMT_RGBA_5551, PIXEL_FMT_RGB_555, PIXEL_FMT_RGBX_8888,   PIXEL_FMT_RGBA_8888, PIXEL_FMT_RGB_888, PIXEL_FMT_BGR_565, PIXEL_FMT_BGRX_4444,   PIXEL_FMT_BGRA_4444, PIXEL_FMT_BGRX_5551, PIXEL_FMT_BGRA_5551, PIXEL_FMT_BGRX_8888,   PIXEL_FMT_BGRA_8888, PIXEL_FMT_YUV_422_I, PIXEL_FMT_YCBCR_422_SP, PIXEL_FMT_YCRCB_422_SP,   PIXEL_FMT_YCBCR_420_SP, PIXEL_FMT_YCRCB_420_SP, PIXEL_FMT_YCBCR_422_P, PIXEL_FMT_YCRCB_422_P,   PIXEL_FMT_YCBCR_420_P, PIXEL_FMT_YCRCB_420_P, PIXEL_FMT_YUYV_422_PKG, PIXEL_FMT_UYVY_422_PKG,   PIXEL_FMT_YVYU_422_PKG, PIXEL_FMT_VYUY_422_PKG, PIXEL_FMT_VENDOR_MASK = 0X7FFF0000, PIXEL_FMT_BUTT = 0X7FFFFFFF } | 像素格式类型定义。 [更多...](#pixelformat) | -| [TransformType](#transformtype) { ROTATE_NONE = 0, ROTATE_90, ROTATE_180, ROTATE_270,   ROTATE_BUTT } | 图层变换类型定义。 [更多...](#transformtype) | -| [BlendType](#blendtype) { BLEND_NONE = 0, BLEND_CLEAR, BLEND_SRC, BLEND_SRCOVER,   BLEND_DSTOVER, BLEND_SRCIN, BLEND_DSTIN, BLEND_SRCOUT,   BLEND_DSTOUT, BLEND_SRCATOP, BLEND_DSTATOP, BLEND_ADD,   BLEND_XOR, BLEND_DST, BLEND_AKS, BLEND_AKD,   BLEND_BUTT } | 显示内存类型定义。 [更多...](#blendtype) | -| [RopType](#roptype) { ROP_BLACK = 0, ROP_NOTMERGEPEN, ROP_MASKNOTPEN, ROP_NOTCOPYPEN,   ROP_MASKPENNOT, ROP_NOT, ROP_XORPEN, ROP_NOTMASKPEN,   ROP_MASKPEN, ROP_NOTXORPEN, ROP_NOP, ROP_MERGENOTPEN,   ROP_COPYPE, ROP_MERGEPENNOT, ROP_MERGEPEN, ROP_WHITE,   ROP_BUTT } | 硬件加速支持的ROP操作类型。 [更多...](#roptype) | -| [ColorKey](#colorkey) { CKEY_NONE = 0, CKEY_SRC, CKEY_DST, CKEY_BUTT } | Color key操作类型定义，即硬件加速支持的Color key操作类型。 [更多...](#colorkey) | -| [MirrorType](#mirrortype) { MIRROR_NONE = 0, MIRROR_LR, MIRROR_TB, MIRROR_BUTT } | 硬件加速支持的镜像操作类型定义 [更多...](#mirrortype) | -| [Connection](#connection) { CON_INVALID = 0, CONNECTED, DISCONNECTED } | 热插拔连接类型定义 [更多...](#connection) | -| [InterfaceType](#interfacetype) { DISP_INTF_HDMI = 0, DISP_INTF_LCD, DISP_INTF_BT1120, DISP_INTF_BT656,   DISP_INTF_YPBPR, DISP_INTF_RGB, DISP_INTF_CVBS, DISP_INTF_SVIDEO,   DISP_INTF_VGA, DISP_INTF_MIPI, DISP_INTF_PANEL, DISP_INTF_BUTT } | 枚举接口类型。 [更多...](#interfacetype) | -| [DispPowerStatus](#disppowerstatus) { POWER_STATUS_ON, POWER_STATUS_STANDBY, POWER_STATUS_SUSPEND, POWER_STATUS_OFF,   POWER_STATUS_BUTT } | 枚举显示状态 [更多...](#disppowerstatus) | -| [CompositionType](#compositiontype) { COMPOSITION_CLIENT, COMPOSITION_DEVICE, COMPOSITION_CURSOR, COMPOSITION_VIDEO,   COMPOSITION_DEVICE_CLEAR, COMPOSITION_CLIENT_CLEAR, COMPOSITION_TUNNEL, COMPOSITION_BUTT } | 枚举特殊层的组合类型。 [更多...](#compositiontype) | -| [ColorGamut](#colorgamut) { COLOR_GAMUT_INVALID = -1, COLOR_GAMUT_NATIVE = 0, COLOR_GAMUT_STANDARD_BT601 = 1, COLOR_GAMUT_STANDARD_BT709 = 2,   COLOR_GAMUT_DCI_P3 = 3, COLOR_GAMUT_SRGB = 4, COLOR_GAMUT_ADOBE_RGB = 5, COLOR_GAMUT_DISPLAY_P3 = 6,   COLOR_GAMUT_BT2020 = 7, COLOR_GAMUT_BT2100_PQ = 8, COLOR_GAMUT_BT2100_HLG = 9, COLOR_GAMUT_DISPLAY_BT2020 = 10 } | 色域类型枚举值 [更多...](#colorgamut) | -| [GamutMap](#gamutmap) { GAMUT_MAP_CONSTANT = 0, GAMUT_MAP_EXPANSION = 1, GAMUT_MAP_HDR_CONSTANT = 2, GAMUT_MAP_HDR_EXPANSION = 3 } | 枚举色域的映射类型 [更多...](#gamutmap) | -| [ColorDataSpace](#colordataspace) {   COLOR_DATA_SPACE_UNKNOWN = 0, GAMUT_BT601 = 0x00000001, GAMUT_BT709 = 0x00000002, GAMUT_DCI_P3 = 0x00000003,   GAMUT_SRGB = 0x00000004, GAMUT_ADOBE_RGB = 0x00000005, GAMUT_DISPLAY_P3 = 0x00000006, GAMUT_BT2020 = 0x00000007,   GAMUT_BT2100_PQ = 0x00000008, GAMUT_BT2100_HLG = 0x00000009, GAMUT_DISPLAY_BT2020 = 0x0000000a, TRANSFORM_FUNC_UNSPECIFIED = 0x00000100,   TRANSFORM_FUNC_LINEAR = 0x00000200, TRANSFORM_FUNC_SRGB = 0x00000300, TRANSFORM_FUNC_SMPTE_170M = 0x00000400, TRANSFORM_FUNC_GM2_2 = 0x00000500,   TRANSFORM_FUNC_GM2_6 = 0x00000600, TRANSFORM_FUNC_GM2_8 = 0x00000700, TRANSFORM_FUNC_ST2084 = 0x00000800, TRANSFORM_FUNC_HLG = 0x00000900,   PRECISION_UNSPECIFIED = 0x00010000, PRECISION_FULL = 0x00020000, PRESION_LIMITED = 0x00030000, PRESION_EXTENDED = 0x00040000,   BT601_SMPTE170M_FULL = GAMUT_BT601 \| TRANSFORM_FUNC_SMPTE_170M \| PRECISION_FULL, BT601_SMPTE170M_LIMITED = GAMUT_BT601 \| TRANSFORM_FUNC_SMPTE_170M \| PRESION_LIMITED, BT709_LINEAR_FULL = GAMUT_BT709 \| TRANSFORM_FUNC_LINEAR \| PRECISION_FULL, BT709_LINEAR_EXTENDED = GAMUT_BT709 \| TRANSFORM_FUNC_LINEAR \| PRESION_EXTENDED,   BT709_SRGB_FULL = GAMUT_BT709 \| TRANSFORM_FUNC_SRGB \| PRECISION_FULL, BT709_SRGB_EXTENDED = GAMUT_BT709 \| TRANSFORM_FUNC_SRGB \| PRESION_EXTENDED, BT709_SMPTE170M_LIMITED = GAMUT_BT709 \| TRANSFORM_FUNC_SMPTE_170M \| PRESION_LIMITED, DCI_P3_LINEAR_FULL = GAMUT_DCI_P3 \| TRANSFORM_FUNC_LINEAR \| PRECISION_FULL,   DCI_P3_GAMMA26_FULL = GAMUT_DCI_P3 \| TRANSFORM_FUNC_GM2_6 \| PRECISION_FULL, DISPLAY_P3_LINEAR_FULL = GAMUT_DISPLAY_P3 \| TRANSFORM_FUNC_LINEAR \| PRECISION_FULL, DCI_P3_SRGB_FULL = GAMUT_DCI_P3 \| TRANSFORM_FUNC_SRGB \| PRECISION_FULL, ADOBE_RGB_GAMMA22_FULL = GAMUT_ADOBE_RGB \| TRANSFORM_FUNC_GM2_2 \| PRECISION_FULL,   BT2020_LINEAR_FULL = GAMUT_BT2020 \| TRANSFORM_FUNC_LINEAR \| PRECISION_FULL, BT2020_SRGB_FULL = GAMUT_BT2020 \| TRANSFORM_FUNC_SRGB \| PRECISION_FULL, BT2020_SMPTE170M_FULL = GAMUT_BT2020 \| TRANSFORM_FUNC_SMPTE_170M \| PRECISION_FULL, BT2020_ST2084_FULL = GAMUT_BT2020 \| TRANSFORM_FUNC_ST2084 \| PRECISION_FULL,   BT2020_HLG_FULL = GAMUT_BT2020 \| TRANSFORM_FUNC_HLG \| PRECISION_FULL, BT2020_ST2084_LIMITED = GAMUT_BT2020 \| TRANSFORM_FUNC_ST2084 \| PRESION_LIMITED } | 枚举颜色空间的类型 [更多...](#colordataspace) | -| [HDRFormat](#hdrformat) { NOT_SUPPORT_HDR = 0, DOLBY_VISION = 1, HDR10 = 2, HLG = 3,   HDR10_PLUS = 4, HDR_VIVID = 5 } | 枚举HDR格式 [更多...](#hdrformat) | -| [HDRMetadataKey](#hdrmetadatakey) { MATAKEY_RED_PRIMARY_X = 0, MATAKEY_RED_PRIMARY_Y = 1, MATAKEY_GREEN_PRIMARY_X = 2, MATAKEY_GREEN_PRIMARY_Y = 3,   MATAKEY_BLUE_PRIMARY_X = 4, MATAKEY_BLUE_PRIMARY_Y = 5, MATAKEY_WHITE_PRIMARY_X = 6, MATAKEY_WHITE_PRIMARY_Y = 7,   MATAKEY_MAX_LUMINANCE = 8, MATAKEY_MIN_LUMINANCE = 9, MATAKEY_MAX_CONTENT_LIGHT_LEVEL = 10, MATAKEY_MAX_FRAME_AVERAGE_LIGHT_LEVEL = 11,   MATAKEY_HDR10_PLUS = 12, MATAKEY_HDR_VIVID = 13 } | 枚举HDR元数据关键字 [更多...](#hdrmetadatakey) | -| [PresentTimestampType](#presenttimestamptype) { HARDWARE_DISPLAY_PTS_UNSUPPORTED = 0, HARDWARE_DISPLAY_PTS_DELAY = 1 << 0, HARDWARE_DISPLAY_PTS_TIMESTAMP = 1 << 1 } | 上屏时间戳类型枚举值 [更多...](#presenttimestamptype) | + | 名称 | 描述 | +| -------- | -------- | +| [DispErrCode](#disperrcode){ DISPLAY_SUCCESS = 0, DISPLAY_FAILURE = -1, DISPLAY_FD_ERR = -2, DISPLAY_PARAM_ERR = -3,   DISPLAY_NULL_PTR = -4, DISPLAY_NOT_SUPPORT = -5, DISPLAY_NOMEM = -6, DISPLAY_SYS_BUSY = -7,   DISPLAY_NOT_PERM = -8 } | 返回值类型定义。 | +| [LayerType](#layertype){ LAYER_TYPE_GRAPHIC, LAYER_TYPE_OVERLAY, LAYER_TYPE_SDIEBAND, LAYER_TYPE_CURSOR,   LAYER_TYPE_BUTT } | 图层类型定义。 | +| { HBM_USE_CPU_READ = (1 << 0), HBM_USE_CPU_WRITE = (1 << 1), HBM_USE_MEM_MMZ = (1 << 2), HBM_USE_MEM_DMA = (1 << 3),   HBM_USE_MEM_SHARE = (1 << 4), HBM_USE_MEM_MMZ_CACHE = (1 << 5), HBM_USE_MEM_FB = (1 << 6), HBM_USE_ASSIGN_SIZE = (1 << 7) } | 定义缓冲区使用。 | +| [PixelFormat](#pixelformat){ PIXEL_FMT_CLUT8 = 0, PIXEL_FMT_CLUT1, PIXEL_FMT_CLUT4, PIXEL_FMT_RGB_565,   PIXEL_FMT_RGBA_5658, PIXEL_FMT_RGBX_4444, PIXEL_FMT_RGBA_4444, PIXEL_FMT_RGB_444,   PIXEL_FMT_RGBX_5551, PIXEL_FMT_RGBA_5551, PIXEL_FMT_RGB_555, PIXEL_FMT_RGBX_8888,   PIXEL_FMT_RGBA_8888, PIXEL_FMT_RGB_888, PIXEL_FMT_BGR_565, PIXEL_FMT_BGRX_4444,   PIXEL_FMT_BGRA_4444, PIXEL_FMT_BGRX_5551, PIXEL_FMT_BGRA_5551, PIXEL_FMT_BGRX_8888,   PIXEL_FMT_BGRA_8888, PIXEL_FMT_YUV_422_I, PIXEL_FMT_YCBCR_422_SP, PIXEL_FMT_YCRCB_422_SP,   PIXEL_FMT_YCBCR_420_SP, PIXEL_FMT_YCRCB_420_SP, PIXEL_FMT_YCBCR_422_P, PIXEL_FMT_YCRCB_422_P,   PIXEL_FMT_YCBCR_420_P, PIXEL_FMT_YCRCB_420_P, PIXEL_FMT_YUYV_422_PKG, PIXEL_FMT_UYVY_422_PKG,   PIXEL_FMT_YVYU_422_PKG, PIXEL_FMT_VYUY_422_PKG, PIXEL_FMT_VENDER_MASK = 0X7FFF0000, PIXEL_FMT_BUTT = 0X7FFFFFFF } | 像素格式类型定义。 | +| [TransformType](#transformtype){ ROTATE_NONE = 0, ROTATE_90, ROTATE_180, ROTATE_270,   ROTATE_BUTT } | 图层变换类型定义。 | +| [BlendType](#blendtype){ BLEND_NONE = 0, BLEND_CLEAR, BLEND_SRC, BLEND_SRCOVER,   BLEND_DSTOVER, BLEND_SRCIN, BLEND_DSTIN, BLEND_SRCOUT,   BLEND_DSTOUT, BLEND_SRCATOP, BLEND_DSTATOP, BLEND_ADD,   BLEND_XOR, BLEND_DST, BLEND_AKS, BLEND_AKD,   BLEND_BUTT } | 支持的图像混合类型。 | +| [RopType](#roptype){ ROP_BLACK = 0, ROP_NOTMERGEPEN, ROP_MASKNOTPEN, ROP_NOTCOPYPEN,   ROP_MASKPENNOT, ROP_NOT, ROP_XORPEN, ROP_NOTMASKPEN,   ROP_MASKPEN, ROP_NOTXORPEN, ROP_NOP, ROP_MERGENOTPEN,   ROP_COPYPE, ROP_MERGEPENNOT, ROP_MERGEPEN, ROP_WHITE,   ROP_BUTT } | 硬件加速支持的ROP操作类型。 | +| [ColorKey](#colorkey) { CKEY_NONE = 0, CKEY_SRC, CKEY_DST, CKEY_BUTT } | Color key操作类型定义，即硬件加速支持的Color key操作类型。 | +| [MirrorType](#mirrortype){ MIRROR_NONE = 0, MIRROR_LR, MIRROR_TB, MIRROR_BUTT } | 硬件加速支持的镜像操作类型定义。 | +| [Connection](#connection){ CON_INVALID = 0, CONNECTED, DISCONNECTED } | 热插拔连接类型定义。 | +| [InterfaceType](#interfacetype){ DISP_INTF_HDMI = 0, DISP_INTF_LCD, DISP_INTF_BT1120, DISP_INTF_BT656,   DISP_INTF_YPBPR, DISP_INTF_RGB, DISP_INTF_CVBS, DISP_INTF_SVIDEO,   DISP_INTF_VGA, DISP_INTF_MIPI, DISP_INTF_PANEL, DISP_INTF_BUTT } | 枚举接口类型。 | +| [DispPowerStatus](#disppowerstatus){ POWER_STATUS_ON, POWER_STATUS_STANDBY, POWER_STATUS_SUSPEND, POWER_STATUS_OFF,   POWER_STATUS_BUTT } | 枚举显示状态。 | +| [CompositionType](#compositiontype){ COMPOSITION_CLIENT, COMPOSITION_DEVICE, COMPOSITION_CURSOR, COMPOSITION_VIDEO,   COMPOSITION_DEVICE_CLEAR, COMPOSITION_CLIENT_CLEAR, COMPOSITION_TUNNEL, COMPOSITION_BUTT } | 枚举特殊层的组合类型。 | +| [ColorGamut](#colorgamut){ COLOR_GAMUT_INVALID = -1, COLOR_GAMUT_NATIVE = 0, COLOR_GAMUT_SATNDARD_BT601 = 1, COLOR_GAMUT_STANDARD_BT709 = 2,   COLOR_GAMUT_DCI_P3 = 3, COLOR_GAMUT_SRGB = 4, COLOR_GAMUT_ADOBE_RGB = 5, COLOR_GAMUT_DISPLAY_P3 = 6,   COLOR_GAMUT_BT2020 = 7, COLOR_GAMUT_BT2100_PQ = 8, COLOR_GAMUT_BT2100_HLG = 9, COLOR_GAMUT_DISPLAY_BT2020 = 10 } | 色域类型枚举值。 | +| [GamutMap](#gamutmap){ GAMUT_MAP_CONSTANT = 0, GAMUT_MAP_EXPANSION = 1, GAMUT_MAP_HDR_CONSTANT = 2, GAMUT_MAP_HDR_EXPANSION = 3 } | 枚举色域的映射类型。 | +| [ColorDataSpace](#colordataspace){  COLOR_DATA_SPACE_UNKNOWN = 0, GAMUT_BT601 = 0x00000001, GAMUT_BT709 = 0x00000002, GAMUT_DCI_P3 = 0x00000003,   GAMUT_SRGB = 0x00000004, GAMUT_ADOBE_RGB = 0x00000005, GAMUT_DISPLAY_P3 = 0x00000006, GAMUT_BT2020 = 0x00000007,   GAMUT_BT2100_PQ = 0x00000008, GAMUT_BT2100_HLG = 0x00000009, GAMUT_DISPLAY_BT2020 = 0x0000000a, TRANSFORM_FUNC_UNSPECIFIED = 0x00000100,   TRANSFORM_FUNC_LINEAR = 0x00000200, TRANSFORM_FUNC_SRGB = 0x00000300, TRANSFORM_FUNC_SMPTE_170M = 0x00000400, TRANSFORM_FUNC_GM2_2 = 0x00000500,   TRANSFORM_FUNC_GM2_6 = 0x00000600, TRANSFORM_FUNC_GM2_8 = 0x00000700, TRANSFORM_FUNC_ST2084 = 0x00000800, TRANSFORM_FUNC_HLG = 0x00000900,   PRECISION_UNSPECIFIED = 0x00010000, PRECISION_FULL = 0x00020000, PRESION_LIMITED = 0x00030000, PRESION_EXTENDED = 0x00040000,   BT601_SMPTE170M_FULL = GAMUT_BT601 \| TRANSFORM_FUNC_SMPTE_170M \| PRECISION_FULL, BT601_SMPTE170M_LIMITED = GAMUT_BT601 \| TRANSFORM_FUNC_SMPTE_170M \| PRESION_LIMITED, BT709_LINEAR_FULL = GAMUT_BT709 \| TRANSFORM_FUNC_LINEAR \| PRECISION_FULL, BT709_LINEAR_EXTENDED = GAMUT_BT709 \| TRANSFORM_FUNC_LINEAR \| PRESION_EXTENDED,   BT709_SRGB_FULL = GAMUT_BT709 \| TRANSFORM_FUNC_SRGB \| PRECISION_FULL, BT709_SRGB_EXTENDED = GAMUT_BT709 \| TRANSFORM_FUNC_SRGB \| PRESION_EXTENDED, BT709_SMPTE170M_LIMITED = GAMUT_BT709 \| TRANSFORM_FUNC_SMPTE_170M \| PRESION_LIMITED, DCI_P3_LINEAR_FULL = GAMUT_DCI_P3 \| TRANSFORM_FUNC_LINEAR \| PRECISION_FULL,   DCI_P3_GAMMA26_FULL = GAMUT_DCI_P3 \| TRANSFORM_FUNC_GM2_6 \| PRECISION_FULL, DISPLAY_P3_LINEAR_FULL = GAMUT_DISPLAY_P3 \| TRANSFORM_FUNC_LINEAR \| PRECISION_FULL, DCI_P3_SRGB_FULL = GAMUT_DCI_P3 \| TRANSFORM_FUNC_SRGB \| PRECISION_FULL, ADOBE_RGB_GAMMA22_FULL = GAMUT_ADOBE_RGB \| TRANSFORM_FUNC_GM2_2 \| PRECISION_FULL,   BT2020_LINEAR_FULL = GAMUT_BT2020 \| TRANSFORM_FUNC_LINEAR \| PRECISION_FULL, BT2020_SRGB_FULL = GAMUT_BT2020 \| TRANSFORM_FUNC_SRGB \| PRECISION_FULL, BT2020_SMPTE170M_FULL = GAMUT_BT2020 \| TRANSFORM_FUNC_SMPTE_170M \| PRECISION_FULL, BT2020_ST2084_FULL = GAMUT_BT2020 \| TRANSFORM_FUNC_ST2084 \| PRECISION_FULL,   BT2020_HLG_FULL = GAMUT_BT2020 \| TRANSFORM_FUNC_HLG \| PRECISION_FULL, BT2020_ST2084_LIMITED = GAMUT_BT2020 \| TRANSFORM_FUNC_ST2084 \| PRESION_LIMITED } | 枚举颜色空间的类型。 | +| [HDRFormat](#hdrformat){ NOT_SUPPORT_HDR = 0, DOLBY_VISION = 1, HDR10 = 2, HLG = 3,   HDR10_PLUS = 4, HDR_VIVID = 5 } | 枚举HDR格式。 | +| [HDRMetadataKey](#hdrmetadatakey){  MATAKEY_RED_PRIMARY_X = 0, MATAKEY_RED_PRIMARY_Y = 1, MATAKEY_GREEN_PRIMARY_X = 2, MATAKEY_GREEN_PRIMARY_Y = 3,   MATAKEY_BLUE_PRIMARY_X = 4, MATAKEY_BLUE_PRIMARY_Y = 5, MATAKEY_WHITE_PRIMARY_X = 6, MATAKEY_WHITE_PRIMARY_Y = 7,   MATAKEY_MAX_LUMINANCE = 8, MATAKEY_MIN_LUMINANCE = 9, MATAKEY_MAX_CONTENT_LIGHT_LEVEL = 10, MATAKEY_MAX_FRAME_AVERAGE_LIGHT_LEVEL = 11,   MATAKEY_HDR10_PLUS = 12, MATAKEY_HDR_VIVID = 13 } | 枚举HDR元数据关键字。 | +| [PresentTimestampType](#presenttimestamptype){ HARDWARE_DISPLAY_PTS_UNSUPPORTED = 0, HARDWARE_DISPLAY_PTS_DELAY = 1 << 0, HARDWARE_DISPLAY_PTS_TIMESTAMP = 1 << 1 } | 上屏时间戳类型枚举值。 | +| [VGUPathDataType](#vgupathdatatype){ VGU_DATA_TYPE_S16 = 0, VGU_DATA_TYPE_S32, VGU_DATA_TYPE_F32 } | 路径坐标数据类型。 | +| [VGUCapability](#vgucapability){ VGU_CAP_BLIT = (1 << 0), VGU_CAP_BLIT_NUM = (1 << 1), VGU_CAP_PATH = (1 << 2), VGU_CAP_FILTER_BLUR = (1 << 3) } | 硬件加速能力。 | +| [VGUResult](#vguresult){   VGU_SUCCESS = 0, VGU_NO_SUPPORT = -1, VGU_OPERATION_FAILED = -2, VGU_OUT_OF_MEMORY = -3,   VGU_TIMEOUT = -4, VGU_INVALID_PARAMETER = -5, VGU_BUSY = -6, VGU_NO_CONTEXT = -7 } | 错误码定义。 | +| [VGULineCap](#vgulinecap){ VGU_LINECAP_BUTT = 0, VGU_LINECAP_ROUND, VGU_LINECAP_SQUARE } | 线帽。 | +| [VGUJointType](#vgujointtype){ VGU_LINE_JOIN_MITER = 0, VGU_LINE_JOIN_ROUND, VGU_LINE_JOIN_BEVEL, VGU_LINE_JOIN_BUTT } | 联接类型。 | +| [VGUFilter](#vgufilter){ VGU_FILTER_BILINEAR = 0, VGU_FILTER_NEAREST, VGU_FILTER_LINEAR, VGU_FILTER_BUTT } | 图像滤波类型。 | +| [VGUFillRule](#vgufillrule){ VGU_RULE_WINDING = 0, VGU_RULE_EVEN_ODD, VGU_RULE_BUTT } | 填充规则定义。 | +| [VGUFillSpread](#vgufillspread){ VGU_SPREAD_PAD = 0, VGU_SPREAD_REFLECT, VGU_SPREAD_REPEAT, VGU_SPREAD_BUTT } | 渐变填充区域外的延展类型。 | +| [VGUWrapType](#vguwraptype){ VGU_WRAP_REFLECT = 0, VGU_WRAP_REPEAT, VGU_WRAP_BUTT } | 图像模式填充延展类型。 | +| [VGUPathCmd](#vgupathcmd){   VGU_PATH_CMD_CLOSE = 0, VGU_PATH_CMD_MOVE, VGU_PATH_CMD_LINE, VGU_PATH_CMD_HLINE,   VGU_PATH_CMD_VLINE, VGU_PATH_CMD_QUAD, VGU_PATH_CMD_CUBIC, VGU_PATH_CMD_SQUAD,   VGU_PATH_CMD_SCUBIC, VGU_PATH_CMD_BUTT } | 路径绘制指令类型。 | +| [VGUTransformType](#vgutransformtype){ VGU_TRANSFORM_TRANSLATE = (1 << 0), VGU_TRANSFORM_SCALE = (1 << 1), VGU_TRANSFORM_ROTATE_90 = (1 << 2), VGU_TRANSFORM_ROTATE_180 = (1 << 3),   VGU_TRANSFORM_ROTATE_270 = (1 << 4), VGU_TRANSFORM_OTHER = (1 << 16) } | 变换类型。 | +| [VGUClipType](#vgucliptype){ VGU_CLIP_RECT = 0, VGU_CLIP_PATH, VGU_CLIP_BUTT } | 绘制表面剪切类型。 | +| [VGUGradientType](#vgugradienttype){ VGU_GRADIENT_LINEAR = 0, VGU_GRADIENT_RADIAL, VGU_GRADIENT_CONIC, VGU_GRADIENT_BUTT } | 渐变类型。 | +| [VGUPaintType](#vgupainttype){ VGU_PAINT_SOLID = 0, VGU_PAINT_GRADIENT, VGU_PAINT_PATTERN, VGU_PAINT_BUTT } | 渲染对象。 | ### 函数 - | 函数 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [DeviceInitialize](#deviceinitialize) ([DeviceFuncs](_device_funcs.md) \*\*funcs) | 实现显示设备控制接口的初始化，申请操作显示设备控制接口的资源，并获取对应的操作接口。 [更多...](#deviceinitialize) | -| [DeviceUninitialize](#deviceuninitialize) ([DeviceFuncs](_device_funcs.md) \*funcs) | 取消显示设备控制接口的初始化，释放控制接口使用到的资源。 [更多...](#deviceuninitialize) | -| [GfxInitialize](#gfxinitialize) ([GfxFuncs](_gfx_funcs.md) \*\*funcs) | 获取硬件加速相关的操作接口指针。 [更多...](#gfxinitialize) | -| [GfxUninitialize](#gfxuninitialize) ([GfxFuncs](_gfx_funcs.md) \*funcs) | 释放硬件加速相关的操作接口指针。 [更多...](#gfxuninitialize) | -| [GrallocInitialize](#grallocinitialize) ([GrallocFuncs](_gralloc_funcs.md) \*\*funcs) | 初始化内存模块，并获取内存提供的操作接口。 [更多...](#grallocinitialize) | -| [GrallocUninitialize](#grallocuninitialize) ([GrallocFuncs](_gralloc_funcs.md) \*funcs) | 取消初始化内存模块，并释放内存操作接口指针。 [更多...](#grallocuninitialize) | -| [LayerInitialize](#layerinitialize) ([LayerFuncs](_layer_funcs.md) \*\*funcs) | 实现图层初始化功能，申请图层使用的资源，并获取图层提供的操作接口。 [更多...](#layerinitialize) | -| [LayerUninitialize](#layeruninitialize) ([LayerFuncs](_layer_funcs.md) \*funcs) | 取消图层初始化功能，释放图层使用到的资源，并释放图层操作接口指针。 [更多...](#layeruninitialize) | +| [DeviceInitialize](#deviceinitialize)(DeviceFuncs \*\*funcs) | 实现显示设备控制接口的初始化，申请操作显示设备控制接口的资源，并获取对应的操作接口。 | +| [DeviceUninitialize](#deviceuninitialize)(DeviceFuncs \*funcs) | 取消显示设备控制接口的初始化，释放控制接口使用到的资源。 | +| [GfxInitialize](#gfxinitialize)(GfxFuncs \*\*funcs) | 获取硬件加速相关的操作接口指针。 | +| [GfxUninitialize](#gfxuninitialize)(GfxFuncs \*funcs) | 释放硬件加速相关的操作接口指针。 | +| [GrallocInitialize](#grallocinitialize)(GrallocFuncs \*\*funcs) | 初始化内存模块，并获取内存提供的操作接口。 | +| [GrallocUninitialize](#grallocuninitialize)(GrallocFuncs \*funcs) | 取消初始化内存模块，并释放内存操作接口指针。 | +| [LayerInitialize](#layerinitialize)(LayerFuncs \*\*funcs) | 实现图层初始化功能，申请图层使用的资源，并获取图层提供的操作接口。 | +| [LayerUninitialize](#layeruninitialize)(LayerFuncs \*funcs) | 取消图层初始化功能，释放图层使用到的资源，并释放图层操作接口指针。 | +| [VGUPathInit](#vgupathinit)(VGUPath \*path, VGUPathDataType type, const uint8_t \*segments, int numSegments, const uint8_t \*data, bool enAlias, VGURect boundBox) | 初始化路径对象。 | +| [VGUPathAppend](#vgupathappend)(VGUPath \*path, const VGUPath \*subpath) | 添加子路径到当前路径中。 | +| [VGUPathClear](#vgupathclear)(VGUPath \*path) | 清除路径对象内存。 | +| [VGUMatrixIdentity](#vgumatrixidentity)(VGUMatrix3 \*matrix) | 初始化矩阵对象为单位矩阵。 | +| [VGUMatrixScale](#vgumatrixscale)(VGUMatrix3 \*matrix, float xScale, float yScale) | 矩阵变换缩放。 | +| [VGUMatrixRotate](#vgumatrixrotate)(VGUMatrix3 \*matrix, float degree) | 矩阵变换旋转。 | +| [VGUMatrixTranslate](#vgumatrixtranslate)(VGUMatrix3 \*matrix, float x, float y) | 矩阵变换平移。 | +| [VGUGradientColorStop](#vgugradientcolorstop)(VGUGradient \*gradient, const VGUColorStop \*colorStop, uint32_t count) | 对渐变添加ColorStop。 | +| [VGUGradientClearStop](#vgugradientclearstop)(VGUGradient \*gradient) | 清除ColorStop。 | +| [VGUGradientMatrix](#vgugradientmatrix)(VGUGradient \*gradient, const VGUMatrix3 \*matrix) | 设置渐变对象的变换矩阵。 | +| [VGUGradientLinear](#vgugradientlinear)(VGUGradient \*gradient, const VGUPoint \*p1, const VGUPoint \*p2) | 创建线性渐变对象。 | +| [VGUGradientRadial](#vgugradientradial)(VGUGradient \*gradient, const VGUPoint \*p1, VGUScalar r1, const VGUPoint \*p2, VGUScalar r2) | 创建辐射渐变对象 | +| [VGUGradientConic](#vgugradientconic)(VGUGradient \*gradient, VGUScalar cx, VGUScalar cy) | 创建圆锥渐变对象。 | +| [VGUInitialize](#vguinitialize)(VGUFuncs \*\*funcs) | 获取硬件加速相关的操作接口指针。 | +| [VGUUninitialize](#vguuninitialize)(VGUFuncs \*funcs) | 去初始化硬件加速模块，同时释放硬件加速模块操作函数指针。 | ### 变量 -| 变量 | 描述 | -| -------- | -------- | -| ( [DeviceFuncs::RegHotPlugCallback](#reghotplugcallback) )([HotPlugCallback](#hotplugcallback) callback, void \*data) | 注册热插拔事件回调。 [更多...](#reghotplugcallback) | -| ( [DeviceFuncs::RegDisplayVBlankCallback](#regdisplayvblankcallback) )(uint32_t devId, [VBlankCallback](#vblankcallback) callback, void \*data) | 注册VBlank事件回调。 [更多...](#regdisplayvblankcallback) | -| ( [DeviceFuncs::RegDisplayRefreshCallback](#regdisplayrefreshcallback) )(uint32_t devId, [RefreshCallback](#refreshcallback) callback, void \*data) | 刷新请求回调。 [更多...](#regdisplayrefreshcallback) | -| ( [DeviceFuncs::GetDisplayCapability](#getdisplaycapability) )(uint32_t devId, [DisplayCapability](_display_capability.md) \*info) | 获取显示设备能力集。 [更多...](#getdisplaycapability) | -| ( [DeviceFuncs::GetDisplaySupportedModes](#getdisplaysupportedmodes) )(uint32_t devId, uint32_t \*num, [DisplayModeInfo](_display_mode_info.md) \*modes) | 获取显示设备支持的显示模式信息。 [更多...](#getdisplaysupportedmodes) | -| ( [DeviceFuncs::GetDisplayMode](#getdisplaymode) )(uint32_t devId, uint32_t \*modeId) | 获取显示设备当前的显示模式。 [更多...](#getdisplaymode) | -| ( [DeviceFuncs::SetDisplayMode](#setdisplaymode) )(uint32_t devId, uint32_t modeId) | 设置显示设备的显示模式。 [更多...](#setdisplaymode) | -| ( [DeviceFuncs::GetDisplayPowerStatus](#getdisplaypowerstatus) )(uint32_t devId, [DispPowerStatus](#disppowerstatus) \*status) | 获取显示设备当前的电源状态。 [更多...](#getdisplaypowerstatus) | -| ([ DeviceFuncs::SetDisplayPowerStatus](#setdisplaypowerstatus) )(uint32_t devId, [DispPowerStatus](#disppowerstatus) status) | 设置显示设备当前的电源状态。 [更多...](#setdisplaypowerstatus) | -| ( [DeviceFuncs::GetDisplayBacklight](#getdisplaybacklight) )(uint32_t devId, uint32_t \*level) | 获取显示设备当前的背光值。 [更多...](#getdisplaybacklight) | -| ( [DeviceFuncs::SetDisplayBacklight](#setdisplaybacklight) )(uint32_t devId, uint32_t level) | 设置显示设备当前的背光值。 [更多...](#setdisplaybacklight) | -| ( [DeviceFuncs::GetDisplayProperty](#getdisplayproperty) )(uint32_t devId, uint32_t id, uint64_t \*value) | 获得显示设备属性值。 [更多...](#getdisplayproperty) | -| ( [DeviceFuncs::SetDisplayProperty](#setdisplayproperty) )(uint32_t devId, uint32_t id, uint64_t value) | 设置显示设备属性值。 [更多...](#setdisplayproperty) | -| ( [DeviceFuncs::PrepareDisplayLayers](#preparedisplaylayers) )(uint32_t devId, bool \*needFlushFb) | 显示设备合成前准备。 [更多...](#preparedisplaylayers) | -| ( [DeviceFuncs::GetDisplayCompChange](#getdisplaycompchange) )(uint32_t devId, uint32_t \*num, uint32_t \*Layers, int32_t \*type) | 获取显示设备合成类型有变化的layer。 [更多...](#getdisplaycompchange) | -| ( [DeviceFuncs::SetDisplayClientCrop](#setdisplayclientcrop) )(uint32_t devId, [IRect](_i_rect.md) \*rect) | 设置显示设备的裁剪区域。 [更多...](#setdisplayclientcrop) | -| ( [DeviceFuncs::SetDisplayClientDestRect](#setdisplayclientdestrect) )(uint32_t devId, [IRect](_i_rect.md) \*rect) | 设置显示设备的显示区域。 [更多...](#setdisplayclientdestrect) | -| ( [DeviceFuncs::SetDisplayClientBuffer](#setdisplayclientbuffer) )(uint32_t devId, const BufferHandle \*buffer, int32_t fence) | 设置显示设备的显示缓存。 [更多...](#setdisplayclientbuffer) | -| ( [DeviceFuncs::SetDisplayClientDamage](#setdisplayclientdamage) )(uint32_t devId, uint32_t num, [IRect](_i_rect.md) \*rect) | 设置显示设备的显示脏区。 [更多...](#setdisplayclientdamage) | -| ( [DeviceFuncs::SetDisplayVsyncEnabled](#setdisplayvsyncenabled) )(uint32_t devId, bool enabled) | 使能垂直同步信号。 [更多...](#setdisplayvsyncenabled) | -| ( [DeviceFuncs::GetDisplayReleaseFence](#getdisplayreleasefence) )(uint32_t devId, uint32_t \*num, uint32_t \*layers, int32_t \*fences) | 获取显示图层fence。 [更多...](#getdisplayreleasefence) | -| ( [DeviceFuncs::GetDisplaySupportedColorGamuts](#getdisplaysupportedcolorgamuts) )(uint32_t devId, uint32_t \*num, [ColorGamut](#colorgamut) \*gamuts) | 获取显示设备支持的色域信息。 [更多...](#getdisplaysupportedcolorgamuts) | -| ( [DeviceFuncs::GetDisplayColorGamut](#getdisplaycolorgamut) )(uint32_t devId, [ColorGamut](#colorgamut) \*gamut) | 获取显示设备当前的色域模式。 [更多...](#getdisplaycolorgamut) | -| ( [DeviceFuncs::SetDisplayColorGamut](#setdisplaycolorgamut) )(uint32_t devId, [ColorGamut](#colorgamut) gamut) | 设置显示设备当前的色域模式。 [更多...](#setdisplaycolorgamut) | -| ( [DeviceFuncs::GetDisplayGamutMap](#getdisplaygamutmap) )(uint32_t devId, [ColorGamut](#colorgamut) \*gamutMap) | 获取显示设备当前的色域映射模式。 [更多...](#getdisplaygamutmap) | -| ( [DeviceFuncs::SetDisplayGamutMap](#setdisplaygamutmap) )(uint32_t devId, [ColorGamut](#colorgamut) gamutMap) | 设置显示设备当前的色域映射模式。 [更多...](#setdisplaygamutmap) | -| ( [DeviceFuncs::SetDisplayColorTransform](#setdisplaycolortransform) )(uint32_t devId, const float \*matrix) | 设置显示设备当前的4x4的颜色转换矩阵。 [更多...](#setdisplaycolortransform) | -| ( [DeviceFuncs::GetHDRCapabilityInfos](#gethdrcapabilityinfos) )(uint32_t devId, [HDRCapability](_h_d_r_capability.md) \*info) | 获取显示设备支持的HDR属性信息。 [更多...](#gethdrcapabilityinfos) | -| ( [DeviceFuncs::GetSupportedMetadataKey](#getsupportedmetadatakey) )(uint32_t devId, uint32_t \*num, [HDRMetadataKey](#hdrmetadatakey) \*keys) | 获取显示设备支持的 HDRMetadataKey。 [更多...](#getsupportedmetadatakey) | -| ( [DeviceFuncs::Commit](#commit) )(uint32_t devId, int32_t \*fence) | 提交合成送显请求。 [更多...](#commit) | -| ( [DeviceFuncs::InvokeDisplayCmd](#invokedisplaycmd) )(uint32_t devId,...) | 调用显示设备命令。 [更多...](#invokedisplaycmd) | -| ([ DeviceFuncs::CreateVirtualDisplay](#createvirtualdisplay) )(uint32_t width, uint32_t height, int32_t \*format, uint32_t \*devId) | 创建虚拟显示设备。 [更多...](#createvirtualdisplay) | -| ( [DeviceFuncs::DestroyVirtualDisplay](#destroyvirtualdisplay) )(uint32_t devId) | 销毁虚拟显示设备。 [更多...](#destroyvirtualdisplay) | -| ( [DeviceFuncs::SetVirtualDisplayBuffer](#setvirtualdisplaybuffer) )(uint32_t devId, BufferHandle \*buffer, int32_t fence) | 设置虚拟屏的输出缓存。 [更多...](#setvirtualdisplaybuffer) | -| ( [DeviceFuncs::GetWriteBackFrame](#getwritebackframe) )(uint32_t devId, BufferHandle \*buffer, int32_t \*fence) | 获取显示设备的回写帧。 [更多...](#getwritebackframe) | -| ( [DeviceFuncs::CreateWriteBack](#createwriteback) )(uint32_t \*devId, uint32_t width, uint32_t height, int32_t \*format) | 对指定显示设备创建回写点。 [更多...](#createwriteback) | -| ( [DeviceFuncs::DestroyWriteBack](#destroywriteback) )(uint32_t devId) | 销毁指定显示设备的回写点。 [更多...](#destroywriteback) | -| [DisplayInfo::width](#width-17) | 显示屏宽度 | -| [DisplayInfo::height](#height-17) | 显示屏高度 | -| [DisplayInfo::rotAngle](#rotangle) | 显示屏旋转角度 | -| [LayerInfo::width](#width-27) | 图层宽度 | -| [LayerInfo::height](#height-27) | 图层高度 | -| [LayerInfo::type](#type-13) | 图层类型，包括图形层、视频层和媒体播放模式 | -| [LayerInfo::bpp](#bpp) | 每像素所占bit数 | -| [LayerInfo::pixFormat](#pixformat-12) | 图层像素格式 | -| [LayerAlpha::enGlobalAlpha](#englobalalpha-12) | 全局Alpha使能标志 | -| [LayerAlpha::enPixelAlpha](#enpixelalpha-12) | 像素Alpha使能标志 | -| [LayerAlpha::alpha0](#alpha0-12) | Alpha0值，取值范围：[0, 255] | -| [LayerAlpha::alpha1](#alpha1-12) | Alpha1值，取值范围：[0, 255] | -| [LayerAlpha::gAlpha](#galpha) | 全局Alpha值，取值范围：[0, 255] | -| [BufferData::phyAddr](#phyaddr-12) | 物理内存地址 | -| [BufferData::virAddr](#viraddr) | 虚拟内存地址 | -| [LayerBuffer::fenceId](#fenceid) | buffer 的fence号r | -| [LayerBuffer::width](#width-37) | buffer宽度 | -| [LayerBuffer::height](#height-37) | buffer高度 | -| [LayerBuffer::pitch](#pitch) | 一行数据所占字节数 | -| [LayerBuffer::pixFormat](#pixformat-22) | buffer像素格式r | -| [LayerBuffer::data](#data) | 图层buffer数据 | -| [LayerBuffer::hdl](#hdl) | 图层buffer句柄 | -| [IRect::x](#x-12) | 矩形框起始x坐标 | -| [IRect::y](#y-12) | 矩形框起始y坐标 | -| [IRect::w](#w) | 矩形框宽度 | -| [IRect::h](#h) | 矩形框高度 | -| [ISurface::phyAddr](#phyaddr-22) | 图像首地址 | -| [ISurface::height](#height-47) | 图像高度 | -| [ISurface::width](#width-47) | 图像宽度 | -| [ISurface::stride](#stride) | 图像跨度 | -| [ISurface::enColorFmt](#encolorfmt) | 图像格式 | -| [ISurface::bYCbCrClut](#bycbcrclut) | CLUT表是否位于YCbCr 空间 | -| [ISurface::bAlphaMax255](#balphamax255) | 图像Alpha最大值为255还是128 | -| [ISurface::bAlphaExt1555](#balphaext1555) | 是否使能1555的Alpha扩展 | -| [ISurface::alpha0](#alpha0-22) | Alpha0值，取值范围：[0,255] | -| [ISurface::alpha1](#alpha1-22) | Alpha1值，取值范围：[0,255] | -| [ISurface::cbcrPhyAddr](#cbcrphyaddr) | CbCr分量地址 | -| [ISurface::cbcrStride](#cbcrstride) | CbCr分量跨度 | -| [ISurface::clutPhyAddr](#clutphyaddr) | CLUT表首地址，用作颜色扩展或颜色校正 | -| [ILine::x0](#x0) | 线条起点的x坐标 | -| [ILine::y0](#y0) | 线条起点的y坐标 | -| [ILine::x1](#x1) | 线条终点的x坐标 | -| [ILine::y1](#y1) | 线条终点的y坐标 | -| [ILine::color](#color-13) | 线条颜色 | -| [ICircle::x](#x-22) | 圆心x坐标 | -| [ICircle::y](#y-22) | 圆心y坐标r | -| [ICircle::r](#r) | 圆的半径 | -| [ICircle::color](#color-23) | 圆的颜色 | -| [Rectangle::rect](#rect) | 矩形区域 | -| [Rectangle::color](#color-33) | 矩形颜色 | -| [GfxOpt::enGlobalAlpha](#englobalalpha-22) | 全局Alpha使能位 | -| [GfxOpt::globalAlpha](#globalalpha) | 全局Alpha的值 | -| [GfxOpt::enPixelAlpha](#enpixelalpha-22) | 像素Alpha使能位 | -| [GfxOpt::blendType](#blendtype) | 混合方式 | -| [GfxOpt::colorKeyFrom](#colorkeyfrom) | 色键模式 | -| [GfxOpt::enableRop](#enablerop) | Rop功能使能位 | -| [GfxOpt::colorRopType](#colorroptype) | 颜色的Rop类型 | -| [GfxOpt::alphaRopType](#alpharoptype) | Alpha的Rop类型 | -| [GfxOpt::enableScale](#enablescale) | 缩放功能使能位 | -| [GfxOpt::rotateType](#rotatetype) | 旋转类型 | -| [GfxOpt::mirrorType](#mirrortype) | 镜像类型 | -| [PropertyObject::name](#name-12) [PROPERTY_NAME_LEN] | 属性名称 | -| [PropertyObject::propId](#propid) | 属性ID | -| [PropertyObject::value](#value-12) | 属性值 | -| [DisplayCapability::name](#name-22) [PROPERTY_NAME_LEN] | 显示设备名称 | -| [DisplayCapability::type](#type-23) | 显示屏接口类型 | -| [DisplayCapability::phyWidth](#phywidth) | 物理宽度 | -| [DisplayCapability::phyHeight](#phyheight) | 物理高度 | -| [DisplayCapability::supportLayers](#supportlayers) | 支持的图层数 | -| [DisplayCapability::virtualDispCount](#virtualdispcount) | 支持的虚拟屏数 | -| [DisplayCapability::supportWriteBack](#supportwriteback) | 是否支持回写 | -| [DisplayCapability::propertyCount](#propertycount) | 属性数组大小 | -| [DisplayCapability::props](#props) | 属性数组 | -| [DisplayModeInfo::width](#width-57) | 像素宽度 | -| [DisplayModeInfo::height](#height-57) | 像素高度 | -| [DisplayModeInfo::freshRate](#freshrate) | 刷新速率 | -| [DisplayModeInfo::id](#id) | 模式ID | -| [AllocInfo::width](#width-67) | 申请内存宽度 | -| [AllocInfo::height](#height-67) | 申请内存高度 | -| [AllocInfo::usage](#usage-12) | 申请内存的使用场景 | -| [AllocInfo::format](#format-12) | 申请内存格式 | -| [AllocInfo::expectedSize](#expectedsize) | 申请内存大小 | -| [HDRCapability::formatCount](#formatcount) | 支持的HDR格式的数量 | -| [HDRCapability::formats](#formats) | 支持的HDR格式的数组首地址 | -| [HDRCapability::maxLum](#maxlum) | 最大的光亮度luminance值 | -| [HDRCapability::maxAverageLum](#maxaveragelum) | 最大的平均光亮度luminance值 | -| [HDRCapability::minLum](#minlum) | 最小的光亮度luminance值 | -| [HDRMetaData::key](#key) | HDR元数据关键字 | -| [HDRMetaData::value](#value-22) | 关键字对应的值 | -| [VerifyAllocInfo::width](#width-77) | 分配内存的宽度 | -| [VerifyAllocInfo::height](#height-77) | 分配内存的高度 | -| [VerifyAllocInfo::usage](#usage-22) | 内存的用处 | -| [VerifyAllocInfo::format](#format-22) | 分配内存的像素格式 | -| [PresentTimestamp::type](#type-33) | 上屏时间戳类型 | -| [PresentTimestamp::time](#time) | 类型对应的值 | -| [__attribute__::fd](#fd) | 句柄 fd，-1代表不支持 | -| [__attribute__::reserveInts](#reserveints) | reserve数组的个数 | -| [__attribute__::reserve](#reserve) [0] | reserve数组 | -| [__attribute__::baseAddr](#baseaddr) | 内存的初始地址 | -| [__attribute__::yOffset](#yoffset) | Y的偏移量 | -| [__attribute__::uOffset](#uoffset) | U的偏移量 | -| [__attribute__::vOffset](#voffset) | V的偏移量 | -| [__attribute__::yStride](#ystride) | Y的stride信息 | -| [__attribute__::uvStride](#uvstride) | UV的stride信息 | -| [__attribute__::uvStep](#uvstep) | UV的step信息 | - - -## **详细描述** + | 名称 | 描述 | +| -------- | -------- | +| ([DeviceFuncs::RegHotPlugCallback](#reghotplugcallback) )(HotPlugCallback callback, void \*data) | 注册热插拔事件回调。 | +| ([DeviceFuncs::RegDisplayVBlankCallback](#regdisplayvblankcallback) )(uint32_t devId, VBlankCallback callback, void \*data) | 注册VBlank事件回调。 | +| ([DeviceFuncs::RegDisplayRefreshCallback](#regdisplayrefreshcallback) )(uint32_t devId, RefreshCallback callback, void \*data) | 刷新请求回调。 | +| ([DeviceFuncs::GetDisplayCapability](#getdisplaycapability) )(uint32_t devId, DisplayCapability \*info) | 获取显示设备能力集。 | +| ([DeviceFuncs::GetDisplaySupportedModes](#getdisplaysupportedmodes) )(uint32_t devId, uint32_t \*num, DisplayModeInfo \*modes) | 获取显示设备支持的显示模式信息。 | +| ([DeviceFuncs::GetDisplayMode](#getdisplaymode) )(uint32_t devId, uint32_t \*modeId) | 获取显示设备当前的显示模式。 | +| ([DeviceFuncs::SetDisplayMode](#setdisplaymode) )(uint32_t devId, uint32_t modeId) | 设置显示设备的显示模式。 | +| ([DeviceFuncs::GetDisplayPowerStatus](#getdisplaypowerstatus) )(uint32_t devId, DispPowerStatus \*status) | 获取显示设备当前的电源状态。 | +| ([DeviceFuncs::SetDisplayPowerStatus](#setdisplaypowerstatus) )(uint32_t devId, DispPowerStatus status) | 设置显示设备当前的电源状态。 | +| ([DeviceFuncs::GetDisplayBacklight](#getdisplaybacklight) )(uint32_t devId, uint32_t \*level) | 获取显示设备当前的背光值。 | +| ([DeviceFuncs::SetDisplayBacklight](#setdisplaybacklight) )(uint32_t devId, uint32_t level) | 设置显示设备当前的背光值。 | +| ([DeviceFuncs::GetDisplayProperty](#getdisplayproperty) )(uint32_t devId, uint32_t id, uint64_t \*value) | 获取显示设备属性值。 | +| ([DeviceFuncs::SetDisplayProperty](#setdisplayproperty) )(uint32_t devId, uint32_t id, uint64_t value) | 设置显示设备属性值。 | +| ([DeviceFuncs::PrepareDisplayLayers](#preparedisplaylayers) )(uint32_t devId, bool \*needFlushFb) | 显示设备合成前准备。 | +| ([DeviceFuncs::GetDisplayCompChange](#getdisplaycompchange) )(uint32_t devId, uint32_t \*num, uint32_t \*Layers, int32_t \*type) | 获取显示设备合成类型有变化的layer。 | +| ([DeviceFuncs::SetDisplayClientCrop](#setdisplayclientcrop) )(uint32_t devId, IRect \*rect) | 设置显示设备的裁剪区域。 | +| ([DeviceFuncs::SetDisplayClientDestRect](#setdisplayclientdestrect) )(uint32_t devId, IRect \*rect) | 设置显示设备的显示区域。 | +| ([DeviceFuncs::SetDisplayClientBuffer](#setdisplayclientbuffer) )(uint32_t devId, const BufferHandle \*buffer, int32_t fence) | 设置显示设备的显示缓存。 | +| ([DeviceFuncs::SetDisplayClientDamage](#setdisplayclientdamage) )(uint32_t devId, uint32_t num, IRect \*rect) | 设置显示设备的显示脏区。 | +| ([DeviceFuncs::SetDisplayVsyncEnabled](#setdisplayvsyncenabled) )(uint32_t devId, bool enabled) | 使能垂直同步信号。 | +| ([DeviceFuncs::GetDisplayReleaseFence](#getdisplayreleasefence) )(uint32_t devId, uint32_t \*num, uint32_t \*layers, int32_t \*fences) | 获取显示图层fence。 | +| ([DeviceFuncs::GetDisplaySupportedColorGamuts](#getdisplaysupportedcolorgamuts) )(uint32_t devId, uint32_t \*num, ColorGamut \*gamuts) | 获取显示设备支持的色域信息。 | +| ([DeviceFuncs::GetDisplayColorGamut](#getdisplaycolorgamut) )(uint32_t devId, ColorGamut \*gamut) | 获取显示设备当前的色域模式。 | +| ([DeviceFuncs::SetDisplayColorGamut](#setdisplaycolorgamut) )(uint32_t devId, ColorGamut gamut) | 设置显示设备当前的色域模式。 | +| ([DeviceFuncs::GetDisplayGamutMap](#getdisplaygamutmap) )(uint32_t devId, GamutMap \*gamutMap) | 获取显示设备当前的色域映射模式。 | +| ([DeviceFuncs::SetDisplayGamutMap](#setdisplaygamutmap) )(uint32_t devId, GamutMap gamutMap) | 设置显示设备当前的色域映射模式。 | +| ([DeviceFuncs::SetDisplayColorTransform](#setdisplaycolortransform) )(uint32_t devId, const float \*matrix) | 设置显示设备当前的4x4的颜色转换矩阵。 | +| ([DeviceFuncs::GetHDRCapabilityInfos](#gethdrcapabilityinfos) )(uint32_t devId, HDRCapability \*info) | 获取显示设备支持的HDR属性信息。 | +| ([DeviceFuncs::GetSupportedMetadataKey](#getsupportedmetadatakey) )(uint32_t devId, uint32_t \*num, DisplayInfo::widthHDRMetadataKey \*keys) | 获取显示设备支持的 HDRMetadataKey。 | +| ([DeviceFuncs::Commit](#commit) )(uint32_t devId, int32_t \*fence) | 提交合成送显请求。 | +| ([DeviceFuncs::InvokeDisplayCmd](#invokedisplaycmd) )(uint32_t devId,...) | 调用显示设备命令。 | +| ([DeviceFuncs::CreateVirtualDisplay](#createvirtualdisplay) )(uint32_t width, uint32_t height, int32_t \*format, uint32_t \*devId) | 创建虚拟显示设备。 | +| ([DeviceFuncs::DestroyVirtualDisplay](#destroyvirtualdisplay) )(uint32_t devId) | 销毁虚拟显示设备。 | +| ([DeviceFuncs::SetVirtualDisplayBuffer](#setvirtualdisplaybuffer) )(uint32_t devId, BufferHandle \*buffer, int32_t fence) | 设置虚拟屏的输出缓存。 | +| ([DeviceFuncs::GetWriteBackFrame](#getwritebackframe) )(uint32_t devId, BufferHandle \*buffer, int32_t \*fence) | 获取显示设备的回写帧。 | +| [DisplayInfo::width](#width-19) | 显示屏宽度 | +| [DisplayInfo::height](#height-18) | 显示屏高度 | +| [DisplayInfo::rotAngle](#rotangle) | 显示屏旋转角度 | +| [LayerInfo::width](#width-29) | 图层宽度 | +| [LayerInfo::height](#height-28) | 图层高度 | +| [LayerInfo::type](#type-17) | 图层类型，包括图形层、视频层和媒体播放模式。 | +| [LayerInfo::bpp](#bpp) | 每像素所占bit数 | +| [LayerInfo::pixFormat](#pixformat-12) | 图层像素格式 | +| [LayerAlpha::enGlobalAlpha](#englobalalpha-12) | 全局Alpha使能标志 | +| [LayerAlpha::enPixelAlpha](#enpixelalpha-12) | 像素Alpha使能标志 | +| [LayerAlpha::alpha0](#alpha0-12) | Alpha0值，取值范围：[0, 255] | +| [LayerAlpha::alpha1](#alpha1-12) | Alpha1值，取值范围：[0, 255] | +| [LayerAlpha::gAlpha](#galpha) | 全局alpha值，取值范围：[0, 255] | +| [BufferData::phyAddr](#phyaddr-13) | 物理内存地址 | +| [BufferData::virAddr](#viraddr-12) | 虚拟内存地址 | +| [LayerBuffer::fenceId](#fenceid) | buffer 的fence号 | +| [LayerBuffer::width](#width-39) | buffer宽度 | +| [LayerBuffer::height](#height-38) | buffer高度 | +| [LayerBuffer::pitch](#pitch) | 一行数据所占字节数 | +| [LayerBuffer::pixFormat](#pixformat-22) | buffer像素格式 | +| [LayerBuffer::data](#data-12) | 图层buffer数据 | +| [LayerBuffer::hdl](#hdl) | 图层buffer句柄 | +| [IRect::x](#x-14) | 矩形框起始x坐标 | +| [IRect::y](#y-14) | 矩形框起始y坐标 | +| [IRect::w](#w-12) | 矩形框宽度 | +| [IRect::h](#h-12) | 矩形框高度 | +| [ISurface::phyAddr](#phyaddr-23) | 图像首地址 | +| [ISurface::height](#height-48) | 图像高度 | +| [ISurface::width](#width-49) | 图像宽度 | +| [ISurface::stride](#stride-12) | 图像跨度 | +| [ISurface::enColorFmt](#encolorfmt) | 图像格式 | +| [ISurface::bYCbCrClut](#bycbcrclut) | CLUT表是否位于YCbCr 空间 | +| [ISurface::bAlphaMax255](#balphamax255) | 图像Alpha最大值为255还是128 | +| [ISurface::bAlphaExt1555](#balphaext1555) | 是否使能1555的Alpha扩展 | +| [ISurface::alpha0](#alpha0-22) | Alpha0值，取值范围：[0,255] | +| [ISurface::alpha1](#alpha1-22) | Alpha1值，取值范围：[0,255] | +| [ISurface::cbcrPhyAddr](#clutphyaddr) | CbCr分量地址 | +| [ISurface::cbcrStride](#cbcrstride) | CbCr分量跨度 | +| [ISurface::clutPhyAddr](#clutphyaddr) | CLUT表首地址，用作颜色扩展或颜色校正。 | +| [ILine::x0](#x0-12) | 线条起点的x坐标 | +| [ILine::y0](#y0-12) | 线条起点的y坐标 | +| [ILine::x1](#x1-13) | 线条终点的x坐标 | +| [ILine::y1](#y1-13) | 线条终点的y坐标 | +| [ILine::color](#color-15) | 线条颜色 | +| [ICircle::x](#x-24) | 圆心x坐标 | +| [ICircle::y](#y-24) | 圆心y坐标r | +| [ICircle::r](#r) | 圆的半径 | +| [ICircle::color](#color-25) | 圆的颜色 | +| [Rectangle::rect](#rect-13) | 矩形区域 | +| [Rectangle::color](#color-35) | 矩形颜色 | +| [GfxOpt::enGlobalAlpha](#englobalalpha-22) | 全局Alpha使能位 | +| [GfxOpt::globalAlpha](#globalalpha) | 全局Alpha的值 | +| [GfxOpt::enPixelAlpha](#enpixelalpha-22) | 像素Alpha使能位 | +| [GfxOpt::blendType](#blendtype) | 混合方式 | +| [GfxOpt::colorKeyFrom](#colorkeyfrom) | 色键模式 | +| [GfxOpt::enableRop](#enablerop) | Rop功能使能位 | +| [GfxOpt::colorRopType](#colorroptype) | 颜色的Rop类型 | +| [GfxOpt::alphaRopType](#alpharoptype) | Alpha的Rop类型 | +| [GfxOpt::enableScale](#enablescale) | 缩放功能使能位 | +| [GfxOpt::rotateType](#rotatetype) | 旋转类型 | +| [GfxOpt::mirrorType](#mirrortype) | 镜像类型 | +| [PropertyObject::name](#name-12) | 属性名称 | +| [PropertyObject::propId](#propid) | 属性ID | +| [PropertyObject::value](#value-12) | 属性值 | +| [DisplayCapability::name](#name-22) | 显示设备名称 | +| [DisplayCapability::type](#type-27) | 显示屏接口类型 | +| [DisplayCapability::phyWidth](#phywidth) | 物理宽度 | +| [DisplayCapability::phyHeight](#phyheight) | 物理高度 | +| [DisplayCapability::supportLayers](#supportlayers) | 支持的图层数 | +| [DisplayCapability::virtualDispCount](#virtualdispcount) | 支持的虚拟屏数 | +| [DisplayCapability::supportWriteBack](#supportwriteback) | 是否支持回写 | +| [DisplayCapability::propertyCount](#propertycount) | 属性数组大小 | +| [DisplayCapability::props](#props) | 属性数组 | +| [DisplayModeInfo::width](#width-59) | 像素宽度 | +| [DisplayModeInfo::height](#height-58) | 像素高度 | +| [DisplayModeInfo::freshRate](#freshrate) | 刷新速率 | +| [DisplayModeInfo::id](#id) | 模式ID | +| [AllocInfo::width](#width-69) | 申请内存宽度 | +| [AllocInfo::height](#height-68) | 申请内存高度 | +| [AllocInfo::usage](#usage-12) | 申请内存的使用场景 | +| [AllocInfo::format](#format-12) | 申请内存格式 | +| [AllocInfo::expectedSize](#expectedsize) | 申请内存大小 | +| [HDRCapability::formatCount](#formatcount) | 支持的HDR格式的数量 | +| [HDRCapability::formats](#formats) | 支持的HDR格式的数组首地址 | +| [HDRCapability::maxLum](#maxlum) | 最大的光亮度luminance值 | +| [HDRCapability::maxAverageLum](#maxaveragelum) | 最大的平均光亮度luminance值 | +| [HDRCapability::minLum](#minlum) | 最小的光亮度luminance值 | +| [HDRMetaData::key](#key) | HDR元数据关键字 | +| [HDRMetaData::value](#value-22) | 关键字对应的值 | +| [VerifyAllocInfo::width](#width-79) | 分配内存的宽度 | +| [VerifyAllocInfo::height](#height-78) | 分配内存的高度 | +| [VerifyAllocInfo::usage](#usage-22) | 内存的用处 | +| [VerifyAllocInfo::format](#format-22) | 分配内存的像素格式 | +| [PresentTimestamp::type](#type-37) | 上屏时间戳类型 | +| [PresentTimestamp::time](#time) | 类型对应的值 | +| [ExtDataHandle::fd](#fd) | 句柄 fd，-1代表不支持 | +| [ExtDataHandle::reserveInts](#reserveints) | reserve数组的个数 | +| [ExtDataHandle::reserve](#reserve) [0] | reserve数组 | +| [YUVDescInfo::baseAddr](#baseaddr) | 内存的初始地址 | +| [YUVDescInfo::yOffset](#yoffset) | Y的偏移量 | +| [YUVDescInfo::uOffset](#uoffset) | U的偏移量 | +| [YUVDescInfo::vOffset](#voffset) | V的偏移量 | +| [YUVDescInfo::yStride](#ystride) | Y的stride信息 | +| [YUVDescInfo::uvStride](#uvstride) | UV的stride信息 | +| [YUVDescInfo::uvStep](#uvstep) | UV的step信息 | +| [VGUPoint::x](#x-34) | 点水平坐标 | +| [VGUPoint::y](#y-34) | 点垂直坐标 | +| [VGURect::x](#x-44) | 矩形水平起始坐标 | +| [VGURect::y](#y-44) | 矩形垂直起始坐标 | +| [VGURect::w](#w-22) | 矩形宽度 | +| [VGURect::h](#h-22) | 矩形高度 | +| [VGUPath::segment](#segment) | 存放路径命令数据 | +| [VGUPath::numSegments](#numsegments) | 路径命令总数 | +| [VGUPath::data](#data-22) | 存放路径命令对应坐标数据 | +| [VGUPath::type](#type-47) | 路径数据存储类型 | +| [VGUPath::enAlias](#enalias) | 抗锯齿开关 | +| [VGUPath::boundBox](#boundbox) | 路径最大边界 | +| [VGUMatrix3::m](#m) [3][3] | 3x3变换矩阵 | +| [VGUMatrix3::type](#type-57) | 矩阵变换类型，简单变换为缩放，平移，90度倍数旋转。 | +| [VGUBuffer::pixelFormat](#pixelformat) | 像素格式 | +| [VGUBuffer::width](#width-89) | 位图宽度 | +| [VGUBuffer::height](#height-88) | 位图高度 | +| [VGUBuffer::stride](#stride-22) | 位图stride | +| [VGUBuffer::virAddr](#viraddr-22) | 位图缓存的虚拟地址 | +| [VGUBuffer::phyAddr](#phyaddr-33) | 位图缓存的物理地址 | +| [VGUMaskLayer::buffer](#buffer-13) | 蒙版缓存 | +| [VGUMaskLayer::rect](#rect-23) | 蒙版矩形 | +| [VGUSurface::buffer](#buffer-23) | 位图缓存 | +| [VGUSurface::clipRect](#cliprect) | 矩形剪切域，如果为空，整个表面直接渲染。 | +| [VGUSurface::clipPath](#clippath) | 路径剪切域，如果为空，整个表面直接渲染。 | +| [VGUSurface::clipType](#cliptype) | 表面剪切类型 | +| [VGUSurface::mask](#mask) | 蒙版图层, 可以为空。 | +| [VGUSurface::blend](#blend) | 混合叠加模式 | +| [VGUSurface::filter](#filter) | 图像滤波类型 | +| [VGUColorStop::stop](#stop) | 颜色偏移位置, 值范围是 0.0 ~ 1.0。 | +| [VGUColorStop::color](#color-45) | 偏移位置对应颜色 | +| [VGULinear::x1](#x1-23) | 线性渐变起点水平坐标 | +| [VGULinear::y1](#y1-23) | 线性渐变起点垂直坐标 | +| [VGULinear::x2](#x2) | 线性渐变终点水平坐标 | +| [VGULinear::y2](#y2) | 线性渐变起点垂直坐标 | +| [VGURadial::x0](#x0-22) | 内圈圆心水平坐标 | +| [VGURadial::y0](#y0-22) | 内圈圆心垂直坐标 | +| [VGURadial::r0](#r0) | 内圈圆半径 | +| [VGURadial::x1](#x1-33) | 外圈圆心水平坐标 | +| [VGURadial::y1](#y1-33) | 外圈圆心垂直坐标 | +| [VGURadial::r1](#r1) | 外圈圆半径 | +| [VGUConic::cx](#cx) | 圆弧中心x坐标 | +| [VGUConic::cy](#cy) | 圆弧中心y坐标 | +| [VGUImage::buffer](#buffer-33) | 图像存储缓存 | +| [VGUImage::matrix](#matrix-12) | 图像矩阵变换，该参数为空，则内部使用单位变换矩阵。 | +| [VGUImage::rect](#rect-33) | 图像截取矩形，该参数为空，则截取整个图像。 | +| [VGUImage::opacity](#opacity-13) | 透明度，范围0~255。 | +| [VGUPattern::image](#image) | 图像对象 | +| [VGUPattern::wrapx](#wrapx) | 图像水平方向平铺类型 | +| [VGUPattern::wrapy](#wrapy) | 图像垂直方向平铺类型 | +| [VGUGradient::matrix](#matrix-22) | 针对渐变对象的变换矩阵 | +| [VGUGradient::colorStops](#colorstops) | 渐变停止颜色数组指针 | +| [VGUGradient::stopCount](#stopcount) | 渐变停止颜色个数 | +| [VGUGradient::linear](#linear) | 线性渐变对象 | +| [VGUGradient::radial](#radial) | 辐射渐变对象 | +| [VGUGradient::conic](#conic) | 圆锥渐变对象 | +| [VGUGradient::type](#type-67) | 渐变类型 | +| [VGUGradient::spread](#spread) | 渐变延伸模式 | +| [VGUGradient::opacity](#opacity-23) | 透明度，范围0~255。 | +| [VGUSolid::color](#color-55) | 颜色值 | +| [VGUSolid::opacity](#opacity-33) | 透明度. 值范围 0 ~ 255。 | +| [VGUPaintStyle::gradient](#gradient) | 渐变对象 | +| [VGUPaintStyle::pattern](#pattern) | 图片模式对象 | +| [VGUPaintStyle::solid](#solid) | 颜色对象 | +| [VGUPaintStyle::type](#type-77) | 渲染类型 | +| [VGUFillAttr::rule](#rule) | 填充规格 | +| [VGUStrokeAttr::cap](#cap) | 线帽类型 | +| [VGUStrokeAttr::join](#join) | 联结类型 | +| [VGUStrokeAttr::miterLimit](#miterlimit) | 最大斜切长度 | +| [VGUStrokeAttr::width](#width-99) | 线宽 | +| ([VGUFuncs::InitVgu](#initvgu) )(void) | 初始化硬件加速。 | +| ([VGUFuncs::DeinitVgu](#deinitvgu) )(void) | 去初始化硬件加速。 | +| ([VGUFuncs::QueryCapability](#querycapability))(uint32_t cap) | 查询硬件能力集。 | +| ([VGUFuncs::RenderFill](#renderfill))(VGUSurface \*target, const VGUPath \*path, const VGUMatrix3 \*matrix, const VGUFillAttr \*attr, const VGUPaintStyle \*style) | 使用指定的渲染对象来填充路径。 | +| ([VGUFuncs::RenderStroke](#renderstroke) )(VGUSurface \*target, const VGUPath \*path, const VGUMatrix3 \*matrix, const VGUStrokeAttr \*attr, const VGUPaintStyle \*style) | 使用指定的渲染对象来描边路径。 | +| ([VGUFuncs::RenderBlur](#renderblur) )(VGUSurface \*target, uint16_t blur) | 对目标表面进行模糊处理。 | +| ([VGUFuncs::RenderBlit](#renderblit) )(VGUSurface \*target, const VGUImage \*src, uint32_t color) | 对图像进行搬移操作。 | +| ([VGUFuncs::RenderBlitN](#renderblitn) )(VGUSurface \*target, const VGUImage \*src, uint16_t count, uint32_t color) | 对多个源图像进行叠加操作。 | +| ([VGUFuncs::RenderClearRect](#renderclearrect) )(VGUSurface \*target, const VGURect \*rect, uint32_t color, uint8_t opacity) | 对指定矩形进行颜色清除操作。 | +| ([VGUFuncs::RenderCancel](#rendercancel) )() | 取消硬件加速渲染。 | +| ([VGUFuncs::RenderSync](#rendersync) )(int32_t timeOut) | 同步硬件加速模块绘制或搬移操作。 | + + +## **宏定义说明** + + +### PROPERTY_NAME_LEN + + +``` +#define PROPERTY_NAME_LEN 50 +``` + +**描述：** + +属性名称长度 -显示模块驱动接口定义。 -提供给图形系统使用的驱动接口，包括图层管理、设备控制、图形硬件加速、显示内存管理和回调接口等。 +## **类型定义说明** -**Since：** -1.0 +### VGUPixelFormat -**Version：** + +``` +typedef PixelFormat VGUPixelFormat; +``` -2.0 +**描述：** +像素格式 -## **类型定义说明** +### VGUBlendType -### HotPlugCallback + +``` +typedef BlendType VGUBlendType; +``` + +**描述：** +混合操作类型 + +### HotPlugCallback + + ``` typedef void(* HotPlugCallback) (uint32_t devId, bool connected, void *data) ``` @@ -277,20 +449,20 @@ typedef void(* HotPlugCallback) (uint32_t devId, bool connected, void *data) 热插拔事件回调。 -当有热插拔事件发生时，会回调该接口，需要通过RegHotPlugCallback注册该回调接口。 +当有热插拔事件发生时，会回调该接口，需要通过[RegHotPlugCallback](#reghotplugcallback)注册该回调接口。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | devId | 输入参数，显示设备ID，此ID由HDI实现层生成，并通过当前回调接口传递给图形服务使用，用以标记当前连接的显示设备。 | | connected | 输入参数，指明设备的连接状态，true代表连接，false代表断开。 | -| data | 输出参数，图形服务携带的私有数据，该参数携带的是RegHotPlugCallback接口注册时传递的私有数据地址，详情参考 RegHotPlugCallback 接口注册时传递的地址。 | +| data | 输出参数，图形服务携带的私有数据，该参数携带的是[RegHotPlugCallback](#reghotplugcallback)接口注册时传递的私有数据地址。 | ### RefreshCallback - + ``` typedef void(* RefreshCallback) (uint32_t devId, void *data) ``` @@ -299,19 +471,19 @@ typedef void(* RefreshCallback) (uint32_t devId, void *data) 刷新请求回调。 -刷新请求回调，当接口实现层需要图形服务刷新数据帧时会回调该接口，需要通过RegDisplayRefreshCallback注册该回调接口。 +当接口实现层需要图形服务刷新数据帧时会回调该接口，需要通过[RegDisplayRefreshCallback](#regdisplayrefreshcallback)注册该回调接口。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | devId | 输入参数，显示设备ID。 | -| data | 输出参数，图形服务携带的私有数据，该参数携带的是RegDisplayRefreshCallback接口注册时传递的地址。 | +| data | 输出参数，图形服务携带的私有数据，该参数携带的是[RegDisplayRefreshCallback](#regdisplayrefreshcallback)接口注册时传递的地址。 | ### VBlankCallback - + ``` typedef void(* VBlankCallback) (unsigned int sequence, uint64_t ns, void *data) ``` @@ -320,15 +492,15 @@ typedef void(* VBlankCallback) (unsigned int sequence, uint64_t ns, void *data) VBlank 事件回调。 -垂直同步事件回调接口，需要通过RegDisplayVBlankCallback注册该回调接口。 +垂直同步事件回调接口，需要通过[RegDisplayVBlankCallback](#regdisplayvblankcallback)注册该回调接口。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | sequence | 输入参数，指明VBlank序列，是一个累加值。 | | ns | 输入参数，该次VBlank事件的时间戳，以纳秒为单位。 | -| data | 输出参数，图形服务携带的私有数据，该参数携带的是RegDisplayVBlankCallback接口注册时传递的地址。 | +| data | 输出参数，图形服务携带的私有数据，该参数携带的是[RegDisplayVBlankCallback](#regdisplayvblankcallback)接口注册时传递的地址。 | ## **枚举类型说明** @@ -336,14 +508,14 @@ VBlank 事件回调。 ### anonymous enum - + ``` anonymous enum ``` **描述：** -缓冲区定义。 +定义缓冲区使用。 | 枚举值 | 描述 | | -------- | -------- | @@ -359,16 +531,16 @@ anonymous enum ### BlendType - + ``` enum BlendType ``` **描述：** -显示内存类型定义。 +支持的图像混合类型。 -根据图形系统指定的类型进行分配，包括带cache或者不带cache的内存。 +系统在硬件加速期间基于指定的混合类型合成图像。 | 枚举值 | 描述 | | -------- | -------- | @@ -393,7 +565,7 @@ enum BlendType ### ColorDataSpace - + ``` enum ColorDataSpace ``` @@ -450,14 +622,14 @@ enum ColorDataSpace ### ColorGamut - + ``` enum ColorGamut ``` **描述：** -色域类型枚举值。 +色域类型枚举值 | 枚举值 | 描述 | | -------- | -------- | @@ -477,7 +649,7 @@ enum ColorGamut ### ColorKey - + ``` enum ColorKey ``` @@ -496,7 +668,7 @@ Color key操作类型定义，即硬件加速支持的Color key操作类型。 ### CompositionType - + ``` enum CompositionType ``` @@ -507,19 +679,19 @@ enum CompositionType | 枚举值 | 描述 | | -------- | -------- | -| COMPOSITION_CLIENT | Client 合成类型，使用CPU或者GPU合成。 | -| COMPOSITION_DEVICE | Device 合成类型，使用Device合成。 | -| COMPOSITION_CURSOR | Cursor合成类型，用于光标合成。 | -| COMPOSITION_VIDEO | Video合成类型，用于视频层合成。 | -| COMPOSITION_DEVICE_CLEAR | Device clear 合成类型，device会清除目标区域。 | -| COMPOSITION_CLIENT_CLEAR | Client clear 合成类型，service会清除目标区域。 | -| COMPOSITION_TUNNEL | Tunnel 合成类型，用于tunnel。 | -| COMPOSITION_BUTT | 合成类型，一个不可用类型，用于默认初始化。 | +| COMPOSITION_CLIENT | Client 合成类型，使用CPU或者GPU合成 | +| COMPOSITION_DEVICE | Device 合成类型，使用Device合成 | +| COMPOSITION_CURSOR | Cursor合成类型，用于光标合成 | +| COMPOSITION_VIDEO | Video合成类型，用于视频层合成 | +| COMPOSITION_DEVICE_CLEAR | Device clear 合成类型，device会清除目标区域 | +| COMPOSITION_CLIENT_CLEAR | Client clear 合成类型，service会清除目标区域 | +| COMPOSITION_TUNNEL | Tunnel 合成类型，用于tunnel | +| COMPOSITION_BUTT | 合成类型，一个不可用类型，用于默认初始化 | ### Connection - + ``` enum Connection ``` @@ -537,7 +709,7 @@ enum Connection ### DispErrCode - + ``` enum DispErrCode ``` @@ -561,7 +733,7 @@ enum DispErrCode ### DispPowerStatus - + ``` enum DispPowerStatus ``` @@ -581,7 +753,7 @@ enum DispPowerStatus ### GamutMap - + ``` enum GamutMap ``` @@ -600,7 +772,7 @@ enum GamutMap ### HDRFormat - + ``` enum HDRFormat ``` @@ -621,7 +793,7 @@ enum HDRFormat ### HDRMetadataKey - + ``` enum HDRMetadataKey ``` @@ -650,7 +822,7 @@ enum HDRMetadataKey ### InterfaceType - + ``` enum InterfaceType ``` @@ -672,12 +844,12 @@ enum InterfaceType | DISP_INTF_VGA | VGA 接口 | | DISP_INTF_MIPI | MIPI 接口 | | DISP_INTF_PANEL | PANEL 接口 | -| DISP_INTF_BUTT | BUTT接口，一个不可用类型，用于默认初始化。 | +| DISP_INTF_BUTT | BUTT 接口，一个不可用类型，用于默认初始化。 | ### LayerType - + ``` enum LayerType ``` @@ -697,7 +869,7 @@ enum LayerType ### MirrorType - + ``` enum MirrorType ``` @@ -716,7 +888,7 @@ enum MirrorType ### PixelFormat - + ``` enum PixelFormat ``` @@ -761,20 +933,20 @@ enum PixelFormat | PIXEL_FMT_UYVY_422_PKG | UYVY422 打包格式t | | PIXEL_FMT_YVYU_422_PKG | YVYU422 打包格式 | | PIXEL_FMT_VYUY_422_PKG | VYUY422 打包格式 | -| PIXEL_FMT_VENDOR_MASK | vendor mask 格式 | +| PIXEL_FMT_VENDER_MASK | vendor mask 格式 | | PIXEL_FMT_BUTT | Invalid 像素格式 | ### PresentTimestampType - + ``` enum PresentTimestampType ``` **描述：** -上屏时间戳类型枚举值。 +上屏时间戳类型枚举值 | 枚举值 | 描述 | | -------- | -------- | @@ -785,7 +957,7 @@ enum PresentTimestampType ### RopType - + ``` enum RopType ``` @@ -794,7 +966,7 @@ enum RopType 硬件加速支持的ROP操作类型。 -硬件加速支持的ROP操作类型，在将前景位图的RGB颜色分量和Alpha分量值与背景位图的RGB颜色 分量值和Alpha分量值进行按位的布尔运算（包括按位与，按位或等），将结果输出。 +硬件加速支持的ROP操作类型，在将前景位图的RGB颜色分量和Alpha分量值与背景位图的RGB颜色分量值和Alpha分量值进行按位的布尔运算（包括按位与，按位或等），将结果输出。 | 枚举值 | 描述 | | -------- | -------- | @@ -819,7 +991,7 @@ enum RopType ### TransformType - + ``` enum TransformType ``` @@ -837,1099 +1009,1261 @@ enum TransformType | ROTATE_BUTT | 无效操作 | -## **函数说明** +### VGUCapability + +``` +enum VGUCapability +``` -### DeviceInitialize() +**描述：** + +硬件加速能力。 + + | 枚举值 | 描述 | +| -------- | -------- | +| VGU_CAP_BLIT | 支持Blit能力 | +| VGU_CAP_BLIT_NUM | 搬移支持图片叠加最大数目 | +| VGU_CAP_PATH | 支持路径的fill和stroke能力 | +| VGU_CAP_FILTER_BLUR | 支持模糊能力 | +### VGUClipType + + ``` -int32_t DeviceInitialize (DeviceFuncs **funcs) +enum VGUClipType ``` **描述：** -实现显示设备控制接口的初始化，申请操作显示设备控制接口的资源，并获取对应的操作接口。 - -**参数：** +绘制表面剪切类型。 - | 名称 | 描述 | + | 枚举值 | 描述 | | -------- | -------- | -| funcs | 输出参数，显示设备控制接口指针，初始化时分配内存，调用者不需要分配内存，调用者获取该指针用于操作显示设备。 | - -**返回：** - -DISPLAY_SUCCESS 表示执行成功。 +| VGU_CLIP_RECT | 矩形剪切(默认) | +| VGU_CLIP_PATH | 路径剪切 | +| VGU_CLIP_BUTT | 无效定义 | -其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 -**Since：** +### VGUFillRule -1.0 + +``` +enum VGUFillRule +``` -**Version：** +**描述：** -1.0 +填充规则定义。 + | 枚举值 | 描述 | +| -------- | -------- | +| VGU_RULE_WINDING | 非0填充(默认) | +| VGU_RULE_EVEN_ODD | 奇偶填充 | +| VGU_RULE_BUTT | 无效定义 | -### DeviceUninitialize() +### VGUFillSpread + ``` -int32_t DeviceUninitialize (DeviceFuncs * funcs) +enum VGUFillSpread ``` **描述：** -取消显示设备控制接口的初始化，释放控制接口使用到的资源。 - -**参数：** +渐变填充区域外的延展类型。 - | 名称 | 描述 | + | 枚举值 | 描述 | | -------- | -------- | -| funcs | 输出参数，显示设备控制接口指针，用于释放初始化函数中分配的操作指针内存。 | +| VGU_SPREAD_PAD | Pad类型(默认) | +| VGU_SPREAD_REFLECT | Reflect类型 | +| VGU_SPREAD_REPEAT | Repeat类型 | +| VGU_SPREAD_BUTT | 无效定义 | -**返回：** -DISPLAY_SUCCESS 表示执行成功。 - -其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 - -**Since：** +### VGUFilter -1.0 + +``` +enum VGUFilter +``` -**Version：** +**描述：** -1.0 +图像滤波类型。 + | 枚举值 | 描述 | +| -------- | -------- | +| VGU_FILTER_BILINEAR | 双线性插值(默认) | +| VGU_FILTER_NEAREST | 无插值 | +| VGU_FILTER_LINEAR | 线性插值 | +| VGU_FILTER_BUTT | 无效定义 | -### GfxInitialize() +### VGUGradientType + ``` -int32_t GfxInitialize (GfxFuncs **funcs) +enum VGUGradientType ``` **描述：** -获取硬件加速相关的操作接口指针。 - -**参数：** +渐变类型。 - | 名称 | 描述 | + | 枚举值 | 描述 | | -------- | -------- | -| funcs | 输出参数，硬件加速模块操作接口指针，调用者不需要分配内存，调用者获取该指针操作硬件加速。 | - -**返回：** - -DISPLAY_SUCCESS 表示执行成功。 +| VGU_GRADIENT_LINEAR | 线性渐变 | +| VGU_GRADIENT_RADIAL | 辐射渐变 | +| VGU_GRADIENT_CONIC | 圆锥渐变 | +| VGU_GRADIENT_BUTT | 无效定义 | -其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 -**Since：** +### VGUJointType -1.0 + +``` +enum VGUJointType +``` -**Version：** +**描述：** -1.0 +联接类型。 + | 枚举值 | 描述 | +| -------- | -------- | +| VGU_LINE_JOIN_MITER | 尖角(默认) | +| VGU_LINE_JOIN_ROUND | 圆角 | +| VGU_LINE_JOIN_BEVEL | 斜角 | +| VGU_LINE_JOIN_BUTT | 无效定义 | -### GfxUninitialize() +### VGULineCap + ``` -int32_t GfxUninitialize (GfxFuncs * funcs) +enum VGULineCap ``` **描述：** -释放硬件加速相关的操作接口指针。 - -**参数：** +线帽。 - | 名称 | 描述 | + | 枚举值 | 描述 | | -------- | -------- | -| funcs | 输出参数，硬件加速操作接口指针。 | - -**返回：** +| VGU_LINECAP_BUTT | 线条末端为平直线帽(默认) | +| VGU_LINECAP_ROUND | 线条末端为圆形线帽 | +| VGU_LINECAP_SQUARE | 线条末端为正方向形线帽 | -DISPLAY_SUCCESS 表示执行成功。 - -其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 -**Since：** +### VGUPaintType -1.0 + +``` +enum VGUPaintType +``` -**Version：** +**描述：** -1.0 +渲染对象 + | 枚举值 | 描述 | +| -------- | -------- | +| VGU_PAINT_SOLID | 填充颜色 | +| VGU_PAINT_GRADIENT | 渲染渐变对象 | +| VGU_PAINT_PATTERN | 渲染图片模式 | +| VGU_PAINT_BUTT | 无效操作 | -### GrallocInitialize() +### VGUPathCmd + ``` -int32_t GrallocInitialize (GrallocFuncs **funcs) +enum VGUPathCmd ``` **描述：** -初始化内存模块，并获取内存提供的操作接口。 - -**参数：** +路径绘制指令类型。 - | 名称 | 描述 | + | 枚举值 | 描述 | | -------- | -------- | -| funcs | 输出参数，内存模块操作接口指针，初始化内存模块时分配内存，调用者不需要分配内存，调用者获取该指针操作内存。 | +| VGU_PATH_CMD_CLOSE | 线段关闭，坐标数据：none | +| VGU_PATH_CMD_MOVE | 移动到指定位置，坐标数据：x0, y0 | +| VGU_PATH_CMD_LINE | 线条，坐标数据：x0, y0 | +| VGU_PATH_CMD_HLINE | 水平线，坐标数据：x0 | +| VGU_PATH_CMD_VLINE | 垂直线，坐标数据：y0 | +| VGU_PATH_CMD_QUAD | 二次贝塞尔曲线，坐标数据：x0, y0, x1, y1 | +| VGU_PATH_CMD_CUBIC | 三次贝塞尔曲线，坐标数据：x0, y0, x1, y1, x2, y2 | +| VGU_PATH_CMD_SQUAD | 平滑二次贝塞尔曲线，坐标数据：x1, y1 | +| VGU_PATH_CMD_SCUBIC | 平滑三次贝塞尔曲线，坐标数据：x1, y1, x2, y2 | +| VGU_PATH_CMD_BUTT | 无效定义 | -**返回：** -DISPLAY_SUCCESS 表示执行成功。 +### VGUPathDataType -其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 + +``` +enum VGUPathDataType +``` -**Since：** +**描述：** -1.0 +路径坐标数据类型。 -**Version：** + | 枚举值 | 描述 | +| -------- | -------- | +| VGU_DATA_TYPE_S16 | 整型(2 bytes) | +| VGU_DATA_TYPE_S32 | 整型(4 bytes) | +| VGU_DATA_TYPE_F32 | 浮点(4 bytes) | -1.0 +### VGUResult -### GrallocUninitialize() + +``` +enum VGUResult +``` + +**描述：** + +错误码定义。 + + | 枚举值 | 描述 | +| -------- | -------- | +| VGU_SUCCESS | 成功 | +| VGU_NO_SUPPORT | 不支持 | +| VGU_OPERATION_FAILED | 操作失败 | +| VGU_OUT_OF_MEMORY | 内存溢出 | +| VGU_TIMEOUT | 超时 | +| VGU_INVALID_PARAMETER | 无效参数， | +| VGU_BUSY | 设备忙 | +| VGU_NO_CONTEXT | 无上下文 | +### VGUTransformType + + ``` -int32_t GrallocUninitialize (GrallocFuncs * funcs) +enum VGUTransformType ``` **描述：** -取消初始化内存模块，并释放内存操作接口指针。 - -**参数：** +变换类型。 - | 名称 | 描述 | + | 枚举值 | 描述 | | -------- | -------- | -| funcs | 输出参数，内存操作接口指针，用于释放内存初始化函数中分配的操作指针内存。 | +| VGU_TRANSFORM_TRANSLATE | 平移变换 | +| VGU_TRANSFORM_SCALE | 缩放变换 | +| VGU_TRANSFORM_ROTATE_90 | 旋转90度 | +| VGU_TRANSFORM_ROTATE_180 | 旋转180度 | +| VGU_TRANSFORM_ROTATE_270 | 旋转270度 | +| VGU_TRANSFORM_OTHER | 其他变换 | -**返回：** -DISPLAY_SUCCESS 表示执行成功。 +### VGUWrapType -其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 + +``` +enum VGUWrapType +``` -**Since：** +**描述：** -1.0 +图像模式填充延展类型。 -**Version：** + | 枚举值 | 描述 | +| -------- | -------- | +| VGU_WRAP_REFLECT | 反射类型 | +| VGU_WRAP_REPEAT | 重复类型 | +| VGU_WRAP_BUTT | 无效定义 | -1.0 +## **函数说明** -### LayerInitialize() +### DeviceInitialize() + ``` -int32_t LayerInitialize (LayerFuncs **funcs) +int32_t DeviceInitialize (DeviceFuncs ** funcs) ``` **描述：** -实现图层初始化功能，申请图层使用的资源，并获取图层提供的操作接口。 +实现显示设备控制接口的初始化，申请操作显示设备控制接口的资源，并获取对应的操作接口。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | -| funcs | 输出参数，图层操作接口指针，初始化图层时分配内存，调用者不需要分配内存，调用者获取该指针操作图层。 | +| funcs | 输出参数，显示设备控制接口指针，初始化时分配内存，调用者不需要分配内存，调用者获取该指针用于操作显示设备。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 -**参见：** - -[LayerUninitialize](#layeruninitialize) - - -### LayerUninitialize() +### DeviceUninitialize() + ``` -int32_t LayerUninitialize (LayerFuncs * funcs) +int32_t DeviceUninitialize (DeviceFuncs * funcs) ``` **描述：** -取消图层初始化功能，释放图层使用到的资源，并释放图层操作接口指针。 +取消显示设备控制接口的初始化，释放控制接口使用到的资源。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | -| funcs | 输出参数，图层操作接口指针，用于释放图层初始化函数中分配的操作指针内存。 | +| funcs | 输出参数，显示设备控制接口指针，用于释放初始化函数中分配的操作指针内存。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 -**参见：** -[LayerInitialize](#layerinitialize) +### GfxInitialize() + + +``` +int32_t GfxInitialize (GfxFuncs ** funcs) +``` -**Since：** +**描述：** -1.0 +获取硬件加速相关的操作接口指针。 -**Version：** +**参数:** -1.0 + | 名称 | 描述 | +| -------- | -------- | +| funcs | 输出参数，硬件加速模块操作接口指针，调用者不需要分配内存，调用者获取该指针操作硬件加速。 | +**返回:** -## **变量说明** +DISPLAY_SUCCESS 表示执行成功。 +其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 -### alpha0 [1/2] +### GfxUninitialize() + ``` -uint8_t LayerAlpha::alpha0 +int32_t GfxUninitialize (GfxFuncs * funcs) ``` **描述：** -Alpha0值，取值范围：[0, 255] - - -### alpha0 [2/2] +释放硬件加速相关的操作接口指针。 +**参数:** -``` -uint8_t ISurface::alpha0 -``` + | 名称 | 描述 | +| -------- | -------- | +| funcs | 输出参数，硬件加速操作接口指针。 | -**描述：** +**返回:** -Alpha0值，取值范围：[0,255] +DISPLAY_SUCCESS 表示执行成功。 +其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 -### alpha1 [1/2] +### GrallocInitialize() + ``` -uint8_t LayerAlpha::alpha1 +int32_t GrallocInitialize (GrallocFuncs ** funcs) ``` **描述：** -Alpha1值，取值范围：[0, 255] +初始化内存模块，并获取内存提供的操作接口。 +**参数:** -### alpha1 [2/2] + | 名称 | 描述 | +| -------- | -------- | +| funcs | 输出参数，内存模块操作接口指针，初始化内存模块时分配内存，调用者不需要分配内存，调用者获取该指针操作内存。 | +**返回:** -``` -uint8_t ISurface::alpha1 -``` - -**描述：** - -Alpha1值，取值范围：[0,255] +DISPLAY_SUCCESS 表示执行成功。 +其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 -### alphaRopType +### GrallocUninitialize() + ``` -RopType GfxOpt::alphaRopType +int32_t GrallocUninitialize (GrallocFuncs * funcs) ``` **描述：** -Alpha的Rop类型 - - -### bAlphaExt1555 +取消初始化内存模块，并释放内存操作接口指针。 +**参数:** -``` -bool ISurface::bAlphaExt1555 -``` + | 名称 | 描述 | +| -------- | -------- | +| funcs | 输出参数，内存操作接口指针，用于释放内存初始化函数中分配的操作指针内存。 | -**描述：** +**返回:** -是否使能1555的Alpha扩展 +DISPLAY_SUCCESS 表示执行成功。 +其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 -### bAlphaMax255 +### LayerInitialize() + ``` -bool ISurface::bAlphaMax255 +int32_t LayerInitialize (LayerFuncs ** funcs) ``` **描述：** -图像Alpha最大值为255还是128 +实现图层初始化功能，申请图层使用的资源，并获取图层提供的操作接口。 +**参数:** -### baseAddr + | 名称 | 描述 | +| -------- | -------- | +| funcs | 输出参数，图层操作接口指针，初始化图层时分配内存，调用者不需要分配内存，调用者获取该指针操作图层。 | +**返回:** -``` -void* __attribute__::baseAddr -``` +DISPLAY_SUCCESS 表示执行成功。 -**描述：** +其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 -内存的初始地址 +**参见:** +[LayerUninitialize](#layeruninitialize) -### blendType +### LayerUninitialize() + ``` -BlendType GfxOpt::blendType +int32_t LayerUninitialize (LayerFuncs * funcs) ``` **描述：** -混合方式 +取消图层初始化功能，释放图层使用到的资源，并释放图层操作接口指针。 +**参数:** -### bpp + | 名称 | 描述 | +| -------- | -------- | +| funcs | 输出参数，图层操作接口指针，用于释放图层初始化函数中分配的操作指针内存。 | +**返回:** -``` -int32_t LayerInfo::bpp -``` +DISPLAY_SUCCESS 表示执行成功。 -**描述：** +其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 -每像素所占bit数 +**参见:** +[LayerInitialize](#layerinitialize) -### bYCbCrClut +### VGUGradientClearStop() + ``` -bool ISurface::bYCbCrClut +VGUResult VGUGradientClearStop (VGUGradient * gradient) ``` **描述：** -CLUT表是否位于YCbCr空间 - - -### cbcrPhyAddr +清除ColorStop。 +**参数:** -``` -uint64_t ISurface::cbcrPhyAddr -``` + | 名称 | 描述 | +| -------- | -------- | +| gradient | 输入参数，渐变对象。 | -**描述：** +**返回:** -CbCr分量地址 +VGU_SUCCESS 表示执行成功。 +其他值表示执行失败，具体错误码查看[VGUResult](#vguresult)。 -### cbcrStride +### VGUGradientColorStop() + ``` -int32_t ISurface::cbcrStride +VGUResult VGUGradientColorStop (VGUGradient * gradient, const VGUColorStop * colorStop, uint32_t count ) ``` **描述：** -CbCr分量跨度 - - -### clutPhyAddr +对渐变添加ColorStop。 +**参数:** -``` -uint64_t ISurface::clutPhyAddr -``` + | 名称 | 描述 | +| -------- | -------- | +| gradient | 输入参数，渐变对象。 | +| colorStop | 输入参数，ColorStop数组指针。 | +| count | 输入参数，colorStops总数。 | -**描述：** +**返回:** -CLUT表首地址，用作颜色扩展或颜色校正 +VGU_SUCCESS 表示执行成功。 +其他值表示执行失败，具体错误码查看[VGUResult](#vguresult)。 -### color [1/3] +### VGUGradientConic() + ``` -uint32_t ILine::color +VGUResult VGUGradientConic (VGUGradient * gradient, VGUScalar cx, VGUScalar cy ) ``` **描述：** -线条颜色 +创建圆锥渐变对象。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| gradient | 输入参数，渐变对象。 | +| cx | 输入参数，渐变中心水平坐标。 | +| cy | 输入参数，渐变中心垂直坐标。 | + +**返回:** +VGU_SUCCESS 表示执行成功。 -### color [2/3] +其他值表示执行失败，具体错误码查看[VGUResult](#vguresult)。 +### VGUGradientLinear() + + ``` -uint32_t ICircle::color +VGUResult VGUGradientLinear (VGUGradient * gradient, const VGUPoint * p1, const VGUPoint * p2 ) ``` **描述：** -圆的颜色 +创建线性渐变对象。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| gradient | 输入参数，渐变对象。 | +| p1 | 输入参数，起点坐标。 | +| p2 | 输入参数，终点坐标。 | +**返回:** + +VGU_SUCCESS 表示执行成功。 -### color [3/3] +其他值表示执行失败，具体错误码查看[VGUResult](#vguresult)。 +### VGUGradientMatrix() + + ``` -uint32_t Rectangle::color +VGUResult VGUGradientMatrix (VGUGradient * gradient, const VGUMatrix3 * matrix ) ``` **描述：** -矩形颜色 +设置渐变对象的变换矩阵。 +**参数:** -### colorKeyFrom + | 名称 | 描述 | +| -------- | -------- | +| gradient | 输入参数，渐变对象。 | +| matrix | 输入参数，渐变对象变换矩阵。 | + +**返回:** + +VGU_SUCCESS 表示执行成功。 +其他值表示执行失败，具体错误码查看[VGUResult](#vguresult)。 + +### VGUGradientRadial() + + ``` -ColorKey GfxOpt::colorKeyFrom +VGUResult VGUGradientRadial (VGUGradient * gradient, const VGUPoint * p1, VGUScalar r1, const VGUPoint * p2, VGUScalar r2 ) ``` **描述：** -色键模式 +创建辐射渐变对象 +**参数:** -### colorRopType + | 名称 | 描述 | +| -------- | -------- | +| gradient | 输入参数，渐变对象。 | +| p1 | 输入参数，内圆圆心坐标。 | +| r1 | 输入参数，内圆半径。 | +| p2 | 输入参数，外圆圆心坐标。 | +| r2 | 输入参数，外圆半径。 | + +**返回:** + +VGU_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[VGUResult](#vguresult)。 +### VGUInitialize() + + ``` -RopType GfxOpt::colorRopType +VGUResult VGUInitialize (VGUFuncs ** funcs) ``` **描述：** -颜色的Rop类型 +获取硬件加速相关的操作接口指针。 +**参数:** -### Commit + | 名称 | 描述 | +| -------- | -------- | +| funcs | 输出参数，硬件加速模块操作接口指针，调用者不需要分配内存，调用者获取该指针操作硬件加速。 | + +**返回:** + +VGU_SUCCESS 表示执行成功。 +其他值表示执行失败，具体错误码查看[VGUResult](#vguresult)。 + +### VGUMatrixIdentity() + + ``` -int32_t(* DeviceFuncs::Commit) (uint32_t devId, int32_t *fence) +VGUResult VGUMatrixIdentity (VGUMatrix3 * matrix) ``` **描述：** -提交合成送显请求。 - -图形服务通过该接口向接口实现层提交合成送显请求，如果有硬件合成层，接口实现层需要在这时进行合成，并且把最终合成的数据送到硬件进行显示。 +初始化矩阵对象为单位矩阵。 **参数:** | 名称 | 描述 | | -------- | -------- | -| devId | 输入参数，指示需要操作的设备ID。 | -| fences | 输出参数，fence首地址，指向fence数组的首地址。 | +| matrix | 输入参数，变换矩阵对象。 | **返回:** -DISPLAY_SUCCESS 表示执行成功。 - -其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 +VGU_SUCCESS 表示执行成功。 +其他值表示执行失败，具体错误码查看[VGUResult](#vguresult)。 -### CreateVirtualDisplay +### VGUMatrixRotate() + ``` -int32_t(* DeviceFuncs::CreateVirtualDisplay) (uint32_t width, uint32_t height, int32_t *format, uint32_t *devId) +VGUResult VGUMatrixRotate (VGUMatrix3 * matrix, float degree ) ``` **描述：** -创建虚拟显示设备。 - -该接口用于创建一个虚拟显示设备。 +矩阵变换旋转。 **参数:** -| 名称 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| width | 输入参数，指定显示设备的像素宽度。 | -| height | 输入参数，指定显示设备的像素高度。 | -| format | 输出参数，指定显示设备的像素格式。详情参考[PixelFormat](#pixelformat)，接口实现层可以根据硬件需求，修改format并返回给图形服务。 | -| devId | 输出参数，用于接口层返回创建的设备ID。 | +| matrix | 输入参数，变换矩阵对象。 | +| degree | 输入参数，旋转度数。 | **返回:** -DISPLAY_SUCCESS 表示执行成功。 - -其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 +VGU_SUCCESS 表示执行成功。 +其他值表示执行失败，具体错误码查看[VGUResult](#vguresult)。 -### CreateWriteBack +### VGUMatrixScale() + ``` -int32_t(* DeviceFuncs::CreateWriteBack) (uint32_t *devId, uint32_t width, uint32_t height, int32_t *format) +VGUResult VGUMatrixScale (VGUMatrix3 * matrix, float xScale, float yScale ) ``` **描述：** -对指定显示设备创建回写点。 - -该接口用来对指定的设备创建一个回写点，如果回写点数量超过了限制，接口实现层将会返回失败。 +矩阵变换缩放。 **参数:** | 名称 | 描述 | | -------- | -------- | -| devId | 输入参数，指示需要操作的设备ID，接口实现层在创建完回写点后将回写点设备ID存放在该参数中返回给图形服务。 | -| width | 输入参数，回写像素宽度。 | -| height | 输入参数，回写像素高度。 | -| format | 输入参数，回写点数据格式，详情参考[PixelFormat](#pixelformat)，接口实现层可以根据硬件需求，修改format并返回给图形服务。 | +| matrix | 输入参数，变换矩阵对象。 | +| xScale | 输入参数，水平方向缩放倍数。 | +| yScale | 输入参数，垂直方向缩放倍数。 | **返回:** -DISPLAY_SUCCESS 表示执行成功。 - -其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 +VGU_SUCCESS 表示执行成功。 +其他值表示执行失败，具体错误码查看[VGUResult](#vguresult)。 -### data +### VGUMatrixTranslate() + ``` -BufferData LayerBuffer::data +VGUResult VGUMatrixTranslate (VGUMatrix3 * matrix, float x, float y ) ``` **描述：** -图层buffer数据 +矩阵变换平移。 +**参数:** -### DestroyVirtualDisplay + | 名称 | 描述 | +| -------- | -------- | +| matrix | 输入参数，变换矩阵对象。 | +| x | 输入参数，水平方向位置。 | +| y | 输入参数，垂直方向位置。 | + +**返回:** +VGU_SUCCESS 表示执行成功。 +其他值表示执行失败，具体错误码查看[VGUResult](#vguresult)。 + + +### VGUPathAppend() + + ``` -int32_t(* DeviceFuncs::DestroyVirtualDisplay) (uint32_t devId) +VGUResult VGUPathAppend (VGUPath * path, const VGUPath * subpath ) ``` **描述：** -销毁虚拟显示设备。 - -该接口用于销毁指定的虚拟显示设备。 +添加子路径到当前路径中。 **参数:** | 名称 | 描述 | | -------- | -------- | -| devId | 输入参数，指示需要操作的设备ID。 | +| path | 输入参数，路径对象。 | +| subpath | 输入参数，存放子路径对象。 | **返回:** -DISPLAY_SUCCESS 表示执行成功。 - -其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 +VGU_SUCCESS 表示执行成功。 +其他值表示执行失败，具体错误码查看[VGUResult](#vguresult)。 -### DestroyWriteBack +### VGUPathClear() + ``` -int32_t(* DeviceFuncs::DestroyWriteBack) (uint32_t devId) +VGUResult VGUPathClear (VGUPath * path) ``` **描述：** -销毁指定显示设备的回写点。 - -该接口用來销毁指定的回写点。 +清除路径对象内存。 **参数:** | 名称 | 描述 | | -------- | -------- | -| devId | 输入参数，指示需要操作的设备ID。 | +| path | 输入参数，路径对象。 | **返回:** -DISPLAY_SUCCESS 表示执行成功。 - -其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 +VGU_SUCCESS 表示执行成功。 +其他值表示执行失败，具体错误码查看[VGUResult](#vguresult)。 -### enableRop +### VGUPathInit() + ``` -bool GfxOpt::enableRop +VGUResult VGUPathInit (VGUPath * path, VGUPathDataType type, const uint8_t * segments, int numSegments, const uint8_t * data, bool enAlias, VGURect boundBox ) ``` **描述：** -Rop功能使能位 +初始化路径对象。 + +**参数:** + | 名称 | 描述 | +| -------- | -------- | +| path | 输入参数，路径对象。 | +| type | 输入参数，存储路径的数据类型。 | +| segments | 输入参数，路径的命令缓存。 | +| numSegments | 输入参数，路径命令总数。 | +| data | 输入参数，路径命令对应的坐标缓存。 | +| enAlias | 输入参数，使能抗锯齿。 | +| boundBox | 输入参数，路径的边界范围。 | + +**返回:** + +VGU_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[VGUResult](#vguresult)。 -### enableScale +### VGUUninitialize() + ``` -bool GfxOpt::enableScale +VGUResult VGUUninitialize (VGUFuncs * funcs) ``` **描述：** -缩放功能使能位 +去初始化硬件加速模块，同时释放硬件加速模块操作函数指针。 +**参数:** -### enColorFmt + | 名称 | 描述 | +| -------- | -------- | +| funcs | 输出参数，硬件加速操作接口指针。 | +**返回:** -``` -PixelFormat ISurface::enColorFmt -``` +VGU_SUCCESS 表示执行成功。 -**描述：** +其他值表示执行失败，具体错误码查看[VGUResult](#vguresult)。 -图像格式 +## **变量说明** -### enGlobalAlpha [1/2] +### alpha0 [1/2] + ``` -bool LayerAlpha::enGlobalAlpha +uint8_t LayerAlpha::alpha0 ``` **描述：** -全局Alpha使能标志 +alpha0值，取值范围：[0, 255] -### enGlobalAlpha [2/2] - +### alpha0 [2/2] + ``` -bool GfxOpt::enGlobalAlpha +uint8_t ISurface::alpha0 ``` **描述：** -全局Alpha使能位 - +Alpha0值，取值范围：[0,255] -### enPixelAlpha [1/2] +### alpha1 [1/2] + ``` -bool LayerAlpha::enPixelAlpha +uint8_t LayerAlpha::alpha1 ``` **描述：** -像素Alpha使能标志 - +alpha1值，取值范围：[0, 255] -### enPixelAlpha [2/2] +### alpha1 [2/2] + ``` -bool GfxOpt::enPixelAlpha +uint8_t ISurface::alpha1 ``` **描述：** -像素Alpha使能位 - +Alpha1值，取值范围：[0,255] -### expectedSize +### alphaRopType + ``` -uint32_t AllocInfo::expectedSize +RopType GfxOpt::alphaRopType ``` **描述：** -申请内存大小 - +Alpha的Rop类型 -### fd +### bAlphaExt1555 + ``` -int32_t __attribute__::fd +bool ISurface::bAlphaExt1555 ``` **描述：** -句柄 fd，-1代表不支持。 - +是否使能1555的Alpha扩展 -### fenceId +### bAlphaMax255 + ``` -int32_t LayerBuffer::fenceId +bool ISurface::bAlphaMax255 ``` **描述：** -buffer 的fence号 +图像alpha最大值为255还是128 -### format [1/2] - +### baseAddr + ``` -PixelFormat AllocInfo::format +void* YUVDescInfo::baseAddr ``` **描述：** -申请内存格式 - +内存的初始地址 -### format [2/2] +### blend + ``` -PixelFormat VerifyAllocInfo::format +VGUBlendType VGUSurface::blend ``` **描述：** -分配内存的像素格式 - +混合叠加模式 -### formatCount +### blendType + ``` -uint32_t HDRCapability::formatCount +BlendType GfxOpt::blendType ``` **描述：** -支持的HDR格式的数量 - +混合方式 -### formats +### boundBox + ``` -HDRFormat* HDRCapability::formats +VGURect VGUPath::boundBox ``` **描述：** -支持的HDR格式的数组首地址 - +路径最大边界 -### freshRate +### bpp + ``` -uint32_t DisplayModeInfo::freshRate +int32_t LayerInfo::bpp ``` **描述：** -刷新速率 - +每像素所占bit数 -### gAlpha +### buffer [1/3] + ``` -uint8_t LayerAlpha::gAlpha +VGUBuffer* VGUMaskLayer::buffer ``` **描述：** -全局Alpha值，取值范围：[0, 255] - +蒙版缓存 -### GetDisplayBacklight +### buffer [2/3] + ``` -int32_t(* DeviceFuncs::GetDisplayBacklight) (uint32_t devId, uint32_t *level) +VGUBuffer* VGUSurface::buffer ``` **描述：** -获取显示设备当前的背光值。 - -图形服务可以通过该接口获取设置显示设备的背光值。 +位图缓存 -**参数:** +VGUSurface::clipRect - | 名称 | 描述 | -| -------- | -------- | -| devId | 输入参数，指示需要操作的设备ID。 | -| level | 输出参数，保存对应设备的背光值，由接口实现层进行写入。 | -**返回:** +### buffer [3/3] -DISPLAY_SUCCESS 表示执行成功。 + +``` +VGUBuffer* VGUImage::buffer +``` -其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 +**描述：** +图像存储缓存 -### GetDisplayCapability +### bYCbCrClut + ``` -int32_t(* DeviceFuncs::GetDisplayCapability) (uint32_t devId, DisplayCapability *info) +bool ISurface::bYCbCrClut ``` **描述：** -获取显示设备能力集。 - -图形服务可以通过该接口获取显示设备具备哪些显示能力。 - -**参数:** +CLUT表是否位于 YCbCr 空间 - | 名称 | 描述 | -| -------- | -------- | -| devId | 输入参数，指示需要操作的设备ID。 | -| info | 输出参数，设备支持的能力级信息，详情参考 {\@DisplayCapability}。 | -**返回:** +### cap -DISPLAY_SUCCESS 表示执行成功。 + +``` +VGULineCap VGUStrokeAttr::cap +``` -其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 +**描述：** +线帽类型 -### GetDisplayColorGamut +### cbcrPhyAddr + ``` -int32_t(* DeviceFuncs::GetDisplayColorGamut) (uint32_t devId, ColorGamut *gamut) +uint64_t ISurface::cbcrPhyAddr ``` **描述：** -获取显示设备当前的色域模式。 - -**参数:** +CbCr分量地址 - | 名称 | 描述 | -| -------- | -------- | -| devId | 输入参数，指示需要操作的设备ID。 | -| gamut | 输出参数，保存对应设备的色域模式，由接口实现层进行写入。 | -**返回:** +### cbcrStride -DISPLAY_SUCCESS 表示执行成功。 + +``` +int32_t ISurface::cbcrStride +``` -其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 +**描述：** +CbCr分量跨度 -### GetDisplayCompChange +### clipPath + ``` -int32_t(* DeviceFuncs::GetDisplayCompChange) (uint32_t devId, uint32_t *num, uint32_t *Layers, int32_t *type) +VGUPath* VGUSurface::clipPath ``` **描述：** -获取显示设备合成类型有变化的layer。 - -在合成准备阶段，显示设备会根据设备的合成能力修改图层的合成类型，该接口会返回哪些图层合成类型发生了变化。 - -**参数:** +路径剪切域，如果为空，整个表面直接渲染 - | 名称 | 描述 | -| -------- | -------- | -| devId | 输入参数，指示需要操作的设备ID。 | -| num | 输出参数，表示合成类型发生了变化的图层数量。 | -| Layers | 输出参数，指向图层数组首地址。 | -| type | 输出参数，指向合成类型数组首地址。 | -**返回:** +### clipRect -DISPLAY_SUCCESS 表示执行成功。 + +``` +VGURect* VGUSurface::clipRect +``` -其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 +**描述：** +矩形剪切域，如果为空，整个表面直接渲染 -### GetDisplayGamutMap +### clipType + ``` -int32_t(* DeviceFuncs::GetDisplayGamutMap) (uint32_t devId, GamutMap *gamutMap) +VGUClipType VGUSurface::clipType ``` **描述：** -获取显示设备当前的色域映射模式。 - -**参数:** +表面剪切类型 - | 名称 | 描述 | -| -------- | -------- | -| devId | 输入参数，指示需要操作的设备ID。 | -| gamutMap | 输出参数，保存对应设备的色域映射模式，由接口实现层进行写入。 | -**返回:** +### clutPhyAddr -DISPLAY_SUCCESS 表示执行成功。 + +``` +uint64_t ISurface::clutPhyAddr +``` -其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 +**描述：** +Clut表首地址，用作颜色扩展或颜色校正 -### GetDisplayMode +### color [1/5] + ``` -int32_t(* DeviceFuncs::GetDisplayMode) (uint32_t devId, uint32_t *modeId) +uint32_t ILine::color ``` **描述：** -获取显示设备当前的显示模式。 - -图形服务可以通过该接口获取显示设备当前的显示模式。 - -**参数:** +线条颜色 - | 名称 | 描述 | -| -------- | -------- | -| devId | 输入参数，指示需要操作的设备ID。 | -| modeId | 输出参数，存放当前设备的显示模式ID， 由接口实现层进行数据的写入。 | -**返回:** +### color [2/5] -DISPLAY_SUCCESS 表示执行成功。 + +``` +uint32_t ICircle::color +``` -其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 +**描述：** +圆的颜色 -### GetDisplayPowerStatus +### color [3/5] + ``` -int32_t(* DeviceFuncs::GetDisplayPowerStatus) (uint32_t devId, DispPowerStatus *status) +uint32_t Rectangle::color ``` **描述：** -获取显示设备当前的电源状态。 - -图形服务可以通过该接口获设置显示设备的电源状态。 - -**参数:** +矩形颜色 - | 名称 | 描述 | -| -------- | -------- | -| devId | 输入参数，指示需要操作的设备ID。 | -| status | 输出参数，保存对应设备的电源状态，由接口实现层进行状态的写入。 | -**返回:** +### color [4/5] -DISPLAY_SUCCESS 表示执行成功。 + +``` +uint32_t VGUColorStop::color +``` -其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 +**描述：** +偏移位置对应颜色 -### GetDisplayProperty +### color [5/5] + ``` -int32_t(* DeviceFuncs::GetDisplayProperty) (uint32_t devId, uint32_t id, uint64_t *value) +uint32_t VGUSolid::color ``` **描述：** -获得显示设备属性值。 - -图形服务可以通过该接口获取显示设备具体的属性值。 - -**参数:** +颜色值 - | 名称 | 描述 | -| -------- | -------- | -| devId | 输入参数，指示需要操作的设备ID。 | -| id | 输入参数，由接口GetDisplayCapability返回属性ID。 | -| level | 输出参数，属性ID对应的属性值，由接口实现层写入。 | -**返回:** +### colorKeyFrom -DISPLAY_SUCCESS 表示执行成功。 + +``` +ColorKey GfxOpt::colorKeyFrom +``` -其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 +**描述：** +色键模式 -### GetDisplayReleaseFence +### colorRopType + ``` -int32_t(* DeviceFuncs::GetDisplayReleaseFence) (uint32_t devId, uint32_t *num, uint32_t *layers, int32_t *fences) +RopType GfxOpt::colorRopType ``` **描述：** -获取显示图层fence。 - -图形服务在调用接口Commit后，需要通过该接口获取图层的fence信息。 - -**参数:** +颜色的Rop类型 - | 名称 | 描述 | -| -------- | -------- | -| devId | 输入参数，指示需要操作的设备ID。 | -| num | 输出参数，图层个数。 | -| layers | 输出参数，图层首地址，指向图层数组的首地址。 | -| fences | 输出参数，fence首地址，指向fence数组的首地址。 | -**返回:** +### colorStops -DISPLAY_SUCCESS 表示执行成功。 + +``` +VGUColorStop* VGUGradient::colorStops +``` -其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 +**描述：** +渐变停止颜色数组指针 -### GetDisplaySupportedColorGamuts +### Commit + ``` -int32_t(* DeviceFuncs::GetDisplaySupportedColorGamuts) (uint32_t devId, uint32_t *num, ColorGamut *gamuts) +int32_t(* DeviceFuncs::Commit) (uint32_t devId, int32_t *fence) ``` **描述：** -获取显示设备支持的色域信息。 +提交合成送显请求。 + +图形服务通过该接口向接口实现层提交合成送显请求，如果有硬件合成层，接口实现层需要在这时进行合成，并且把最终合成的数据送到硬件进行显示。 **参数:** | 名称 | 描述 | | -------- | -------- | | devId | 输入参数，指示需要操作的设备ID。 | -| num | 输出参数，设备支持的色域数组个数。 | -| gamuts | 输出参数，色域首地址，指向色域数组首地址。 | +| fences | 输出参数，fence首地址，指向fence数组的首地址。 | **返回:** @@ -1938,26 +2272,39 @@ DISPLAY_SUCCESS 表示执行成功。 其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 -### GetDisplaySupportedModes +### conic + + +``` +VGUConic VGUGradient::conic +``` + +**描述：** + +圆锥渐变对象 + +### CreateVirtualDisplay + ``` -int32_t(* DeviceFuncs::GetDisplaySupportedModes) (uint32_t devId, uint32_t *num, DisplayModeInfo *modes) +int32_t(* DeviceFuncs::CreateVirtualDisplay) (uint32_t width, uint32_t height, int32_t *format, uint32_t *devId) ``` **描述：** -获取显示设备支持的显示模式信息。 +创建虚拟显示设备。 -图形服务可以通过该接口获取到显示设备支持哪些显示模式。 +该接口用于创建一个虚拟显示设备。 **参数:** | 名称 | 描述 | | -------- | -------- | -| devId | 输入参数，指示需要操作的设备ID。 | -| num | 输出参数，设备支持的模式数量。 | -| modes | 输出参数，设备支持的所有模式信息，包括所有能支持的分辨率和刷新率，每一个模式实现层都有一个Id与之对应，在获取当前模式 和设置当前模式时都会使用到，详情参考 {\@DisplayModeInfo}。 | +| width | 输入参数，指定显示设备的像素宽度。 | +| height | 输入参数，指定显示设备的像素高度。 | +| format | 输出参数，指定显示设备的像素格式。 详情参考[PixelFormat](#pixelformat)，接口实现层可以根据硬件需求，修改format并返回给图形服务。 | +| devId | 输出参数，用于接口层返回创建的设备ID。 | **返回:** @@ -1966,77 +2313,915 @@ DISPLAY_SUCCESS 表示执行成功。 其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 -### GetHDRCapabilityInfos - +### cx + ``` -int32_t(* DeviceFuncs::GetHDRCapabilityInfos) (uint32_t devId, HDRCapability *info) +VGUScalar VGUConic::cx ``` **描述：** -获取显示设备支持的HDR属性信息。 - -**参数:** +圆弧中心x坐标 - | 名称 | 描述 | -| -------- | -------- | -| devId | 输入参数，指示需要操作的设备ID。 | -| info | 输出参数，保存对应设备的HDR属性信息，由接口实现层进行写入。 | -**返回:** +### cy -DISPLAY_SUCCESS 表示执行成功。 + +``` +VGUScalar VGUConic::cy +``` -其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 +**描述：** +圆弧中心y坐标 -### GetSupportedMetadataKey +### data [1/2] + ``` -int32_t(* DeviceFuncs::GetSupportedMetadataKey) (uint32_t devId, uint32_t *num, HDRMetadataKey *keys) +BufferData LayerBuffer::data ``` **描述：** -获取显示设备支持的 HDRMetadataKey。 +图层buffer数据 -**参数:** - | 名称 | 描述 | +### data [2/2] + + +``` +uint8_t* VGUPath::data +``` + +**描述：** + +存放路径命令对应坐标数据 + + +### DeinitVgu + + +``` +VGUResult(* VGUFuncs::DeinitVgu) (void) +``` + +**描述：** + +去初始化硬件加速。 + +**返回:** + +VGU_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[VGUResult](#vguresult)。 + +**参见:** + +[InitVgu](#initvgu) + + +### DestroyVirtualDisplay + + +``` +int32_t(* DeviceFuncs::DestroyVirtualDisplay) (uint32_t devId) +``` + +**描述：** + +销毁虚拟显示设备。 + +该接口用于销毁指定的虚拟显示设备。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| devId | 输入参数，指示需要操作的设备ID。 | + +**返回:** + +DISPLAY_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 + + +### enableRop + + +``` +bool GfxOpt::enableRop +``` + +**描述：** + +Rop功能使能位 + + +### enableScale + + +``` +bool GfxOpt::enableScale +``` + +**描述：** + +缩放功能使能位 + + +### enAlias + + +``` +bool VGUPath::enAlias +``` + +**描述：** + +抗锯齿开关 + + +### enColorFmt + + +``` +PixelFormat ISurface::enColorFmt +``` + +**描述：** + +图像格式 + + +### enGlobalAlpha [1/2] + + +``` +bool LayerAlpha::enGlobalAlpha +``` + +**描述：** + +全局alpha使能标志 + + +### enGlobalAlpha [2/2] + + +``` +bool GfxOpt::enGlobalAlpha +``` + +**描述：** + +全局alpha使能位 + + +### enPixelAlpha [1/2] + + +``` +bool LayerAlpha::enPixelAlpha +``` + +**描述：** + +像素alpha使能标志 + + +### enPixelAlpha [2/2] + + +``` +bool GfxOpt::enPixelAlpha +``` + +**描述：** + +像素alpha使能位 + + +### expectedSize + + +``` +uint32_t AllocInfo::expectedSize +``` + +**描述：** + +申请内存大小 + + +### fd + + +``` +int32_t ExtDataHandle::fd +``` + +**描述：** + +句柄 fd, -1代表不支持 + + +### fenceId + + +``` +int32_t LayerBuffer::fenceId +``` + +**描述：** + +buffer 的fence号r + + +### filter + + +``` +VGUFilter VGUSurface::filter +``` + +**描述：** + +图像滤波类型 + + +### format [1/2] + + +``` +PixelFormat AllocInfo::format +``` + +**描述：** + +申请内存格式 + + +### format [2/2] + + +``` +PixelFormat VerifyAllocInfo::format +``` + +**描述：** + +分配内存的像素格式 + + +### formatCount + + +``` +uint32_t HDRCapability::formatCount +``` + +**描述：** + +支持的HDR格式的数量 + + +### formats + + +``` +HDRFormat* HDRCapability::formats +``` + +**描述：** + +支持的HDR格式的数组首地址 + + +### freshRate + + +``` +uint32_t DisplayModeInfo::freshRate +``` + +**描述：** + +刷新速率 + + +### gAlpha + + +``` +uint8_t LayerAlpha::gAlpha +``` + +**描述：** + +全局alpha值，取值范围：[0, 255] + + +### GetDisplayBacklight + + +``` +int32_t(* DeviceFuncs::GetDisplayBacklight) (uint32_t devId, uint32_t *level) +``` + +**描述：** + +获取显示设备当前的背光值。 + +图形服务可以通过该接口获取设置显示设备的背光值。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| devId | 输入参数，指示需要操作的设备ID。 | +| level | 输出参数，保存对应设备的背光值，由接口实现层进行写入。 | + +**返回:** + +DISPLAY_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 + + +### GetDisplayCapability + + +``` +int32_t(* DeviceFuncs::GetDisplayCapability) (uint32_t devId, DisplayCapability *info) +``` + +**描述：** + +获取显示设备能力集。 + +图形服务可以通过该接口获取显示设备具备哪些显示能力。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| devId | 输入参数，指示需要操作的设备ID。 | +| info | 输出参数，设备支持的能力级信息，详情参考[DisplayCapability](_display_capability.md)。 | + +**返回:** + +DISPLAY_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 + + +### GetDisplayColorGamut + + +``` +int32_t(* DeviceFuncs::GetDisplayColorGamut) (uint32_t devId, ColorGamut *gamut) +``` + +**描述：** + +获取显示设备当前的色域模式。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| devId | 输入参数，指示需要操作的设备ID。 | +| gamut | 输出参数，保存对应设备的色域模式，由接口实现层进行写入。 | + +**返回:** + +DISPLAY_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 + + +### GetDisplayCompChange + + +``` +int32_t(* DeviceFuncs::GetDisplayCompChange) (uint32_t devId, uint32_t *num, uint32_t *Layers, int32_t *type) +``` + +**描述：** + +获取显示设备合成类型有变化的layer。 + +在合成准备阶段，显示设备会根据设备的合成能力修改图层的合成类型，该接口会返回哪些图层合成类型发生了变化。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| devId | 输入参数，指示需要操作的设备ID。 | +| num | 输出参数，表示合成类型发生了变化的图层数量。 | +| Layers | 输出参数，指向图层数组首地址。 | +| type | 输出参数，指向合成类型数组首地址。 | + +**返回:** + +DISPLAY_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 + + +### GetDisplayGamutMap + + +``` +int32_t(* DeviceFuncs::GetDisplayGamutMap) (uint32_t devId, GamutMap *gamutMap) +``` + +**描述：** + +获取显示设备当前的色域映射模式。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| devId | 输入参数，指示需要操作的设备ID。 | +| gamutMap | 输出参数，保存对应设备的色域映射模式，由接口实现层进行写入。 | + +**返回:** + +DISPLAY_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 + + +### GetDisplayMode + + +``` +int32_t(* DeviceFuncs::GetDisplayMode) (uint32_t devId, uint32_t *modeId) +``` + +**描述：** + +获取显示设备当前的显示模式。 + +图形服务可以通过该接口获取显示设备当前的显示模式。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| devId | 输入参数，指示需要操作的设备ID。 | +| modeId | 输出参数，存放当前设备的显示模式ID， 由接口实现层进行数据的写入。 | + +**返回:** + +DISPLAY_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 + + +### GetDisplayPowerStatus + + +``` +int32_t(* DeviceFuncs::GetDisplayPowerStatus) (uint32_t devId, DispPowerStatus *status) +``` + +**描述：** + +获取显示设备当前的电源状态。 + +图形服务可以通过该接口获设置显示设备的电源状态。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| devId | 输入参数，指示需要操作的设备ID。 | +| status | 输出参数，保存对应设备的电源状态，由接口实现层进行状态的写入。 | + +**返回:** + +DISPLAY_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 + + +### GetDisplayProperty + + +``` +int32_t(* DeviceFuncs::GetDisplayProperty) (uint32_t devId, uint32_t id, uint64_t *value) +``` + +**描述：** + +获取显示设备属性值。 + +图形服务可以通过该接口获取显示设备具体的属性值。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| devId | 输入参数，指示需要操作的设备ID。 | +| id | 输入参数，由接口GetDisplayCapability返回属性ID。 | +| level | 输出参数，属性ID对应的属性值，由接口实现层写入。 | + +**返回:** + +DISPLAY_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 + + +### GetDisplayReleaseFence + + +``` +int32_t(* DeviceFuncs::GetDisplayReleaseFence) (uint32_t devId, uint32_t *num, uint32_t *layers, int32_t *fences) +``` + +**描述：** + +获取显示图层fence。 + +图形服务在调用接口Commit后，需要通过该接口获取图层的fence信息。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| devId | 输入参数，指示需要操作的设备ID。 | +| num | 输出参数，图层个数。 | +| layers | 输出参数，图层首地址，指向图层数组的首地址。 | +| fences | 输出参数，fence首地址，指向fence数组的首地址。 | + +**返回:** + +DISPLAY_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 + + +### GetDisplaySupportedColorGamuts + + +``` +int32_t(* DeviceFuncs::GetDisplaySupportedColorGamuts) (uint32_t devId, uint32_t *num, ColorGamut *gamuts) +``` + +**描述：** + +获取显示设备支持的色域信息。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| devId | 输入参数，指示需要操作的设备ID。 | +| num | 输出参数，设备支持的色域数组个数。 | +| gamuts | 输出参数，色域首地址，指向色域数组首地址。 | + +**返回:** + +DISPLAY_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 + + +### GetDisplaySupportedModes + + +``` +int32_t(* DeviceFuncs::GetDisplaySupportedModes) (uint32_t devId, uint32_t *num, DisplayModeInfo *modes) +``` + +**描述：** + +获取显示设备支持的显示模式信息。 + +图形服务可以通过该接口获取到显示设备支持哪些显示模式。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| devId | 输入参数，指示需要操作的设备ID。 | +| num | 输出参数，设备支持的模式数量。 | +| modes | 输出参数，设备支持的所有模式信息，包括所有能支持的分辨率和刷新率，每一个模式实现层都有一个Id与之对应，在获取当前模式 和设置当前模式时都会使用到，详情参考 [ERROR:Invalid link:zh-cn_topic_0000001424181693.xml#xref1503723582192156,link:zh-cn_topic_0000001369548770.xml](zh-cn_topic_0000001369548770.xml)。 | + +**返回:** + +DISPLAY_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 + + +### GetHDRCapabilityInfos + + +``` +int32_t(* DeviceFuncs::GetHDRCapabilityInfos) (uint32_t devId, HDRCapability *info) +``` + +**描述：** + +获取显示设备支持的HDR属性信息。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| devId | 输入参数，指示需要操作的设备ID。 | +| info | 输出参数，保存对应设备的HDR属性信息，由接口实现层进行写入。 | + +**返回:** + +DISPLAY_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 + + +### GetSupportedMetadataKey + + +``` +int32_t(* DeviceFuncs::GetSupportedMetadataKey) (uint32_t devId, uint32_t *num, HDRMetadataKey *keys) +``` + +**描述：** + +获取显示设备支持的 HDRMetadataKey。 + +**参数:** + + | 名称 | 描述 | | -------- | -------- | | devId | 输入参数，指示需要操作的设备ID。 | | num | 输出参数，设备支持的HDRMetadataKey数组个数。 | -| keys | 输出参数，HDRMetadataKey首地址，指向HDRMetadataKey数组首地址。 | +| keys | 输出参数，HDRMetadataKey首地址, 指向HDRMetadataKey数组首地址。 | + +**返回:** + +DISPLAY_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 + + +### GetWriteBackFrame + + +``` +int32_t(* DeviceFuncs::GetWriteBackFrame) (uint32_t devId, BufferHandle *buffer, int32_t *fence) +``` + +**描述：** + +获取显示设备的回写帧。 + +该接口用来获取devId指定的回写点数据，接口实现层将显示设备回写点的数据写入到设置的缓存中。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| devId | 输入参数，指示需要操作的设备ID。 | +| buffer | 输出参数，回写点数据缓存。 | +| fence | 输出参数，同步栅栏，图形服务在调用该接口时，需要将Buffer的release fence 传入，标记该缓存是否可以被写入，接口实现层在接口返回前需要将buffer的acquirce fence 写入回传给图形服务，用来标记回写数据是否已经写入缓存。 | + +**返回:** + +DISPLAY_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 + + +### globalAlpha + + +``` +uint32_t GfxOpt::globalAlpha +``` + +**描述：** + +全局alpha的值 + + +### gradient + + +``` +VGUGradient* VGUPaintStyle::gradient +``` + +**描述：** + +渐变对象 + + +### h [1/2] + + +``` +int32_t IRect::h +``` + +**描述：** + +矩形框高度 + + +### h [2/2] + + +``` +VGUScalar VGURect::h +``` + +**描述：** + +矩形高度 + + +### hdl + + +``` +BufferHandle* LayerBuffer::hdl +``` + +**描述：** + +图层buffer句柄 + + +### height [1/8] + + +``` +uint32_t DisplayInfo::height +``` + +**描述：** + +显示屏高度 + + +### height [2/8] + + +``` +int32_t LayerInfo::height +``` + +**描述：** + +图层高度 + + +### height [3/8] + + +``` +int32_t LayerBuffer::height +``` + +**描述：** + +buffer高度 + + +### height [4/8] + + +``` +int32_t ISurface::height +``` + +**描述：** + +图像高度 + + +### height [5/8] + + +``` +int32_t DisplayModeInfo::height +``` + +**描述：** + +像素高度 + + +### height [6/8] + + +``` +uint32_t AllocInfo::height +``` + +**描述：** + +申请内存高度 + + +### height [7/8] + + +``` +uint32_t VerifyAllocInfo::height +``` + +**描述：** + +分配内存的高度 + + +### height [8/8] + + +``` +uint32_t VGUBuffer::height +``` + +**描述：** + +位图高度 + + +### id + + +``` +int32_t DisplayModeInfo::id +``` + +**描述：** + +模式ID + + +### image + + +``` +VGUImage* VGUPattern::image +``` + +**描述：** + +图像对象 + + +### InitVgu + + +``` +VGUResult(* VGUFuncs::InitVgu) (void) +``` + +**描述：** + +初始化硬件加速。 **返回:** -DISPLAY_SUCCESS 表示执行成功。 +VGU_SUCCESS 表示执行成功。 -其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 +其他值表示执行失败，具体错误码查看[VGUResult](#vguresult)。 +**参见:** + +[DeinitVgu](#deinitvgu) -### GetWriteBackFrame +### InvokeDisplayCmd + ``` -int32_t(* DeviceFuncs::GetWriteBackFrame) (uint32_t devId, BufferHandle *buffer, int32_t *fence) +int32_t(* DeviceFuncs::InvokeDisplayCmd) (uint32_t devId,...) ``` **描述：** -获取显示设备的回写帧。 +调用显示设备命令。 -该接口用来获取devId指定的回写点数据，接口实现层将显示设备回写点的数据写入到设置的缓存中。 +该接口用于图形服务和接口实现层之间的接口扩展，如果由临时接口新增可以通过该接口进行扩展，不用增加新的接口定义。 **参数:** | 名称 | 描述 | | -------- | -------- | | devId | 输入参数，指示需要操作的设备ID。 | -| buffer | 输出参数，回写点数据缓存。 | -| fence | 输出参数，同步栅栏，图形服务在调用该接口时，需要将Buffer的release fence 传入，标记该缓存是否可以被写入，接口实现层在接口返回前需要将buffer的acquirce fence 写入回传给图形服务，用来标记回写数据是否已经写入缓存。 | **返回:** @@ -2045,156 +3230,361 @@ DISPLAY_SUCCESS 表示执行成功。 其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 -### globalAlpha +### join + + +``` +VGUJointType VGUStrokeAttr::join +``` + +**描述：** + +联结类型 +### key + + ``` -uint32_t GfxOpt::globalAlpha +HDRMetadataKey HDRMetaData::key ``` **描述：** -全局Alpha的值 +HDR元数据关键字 + + +### linear + + +``` +VGULinear VGUGradient::linear +``` + +**描述：** +线性渐变对象 -### h +### m + ``` -int32_t IRect::h +float VGUMatrix3::m[3][3] ``` **描述：** -矩形框高度 +3x3变换矩阵 -### hdl +### mask + + +``` +VGUMaskLayer* VGUSurface::mask +``` + +**描述：** +蒙版图层，可以为空 + +### matrix [1/2] + + ``` -BufferHandle* LayerBuffer::hdl +VGUMatrix3* VGUImage::matrix ``` **描述：** -图层buffer句柄 +图像矩阵变换，该参数为空，则内部使用单位变换矩阵 + + +### matrix [2/2] + + +``` +VGUMatrix3* VGUGradient::matrix +``` + +**描述：** +针对渐变对象的变换矩阵 -### height [1/7] +### maxAverageLum + ``` -uint32_t DisplayInfo::height +float HDRCapability::maxAverageLum ``` **描述：** -显示屏高度 +最大的平均光亮度luminance值 -### height [2/7] +### maxLum + + +``` +float HDRCapability::maxLum +``` + +**描述：** + +最大的光亮度luminance值 + +### minLum + ``` -int32_t LayerInfo::height +float HDRCapability::minLum ``` **描述：** -图层高度 +最小的光亮度luminance值 + +### mirrorType + + +``` +MirrorType GfxOpt::mirrorType +``` + +**描述：** + +镜像类型 -### height [3/7] +### miterLimit + ``` -int32_t LayerBuffer::height +float VGUStrokeAttr::miterLimit ``` **描述：** -buffer高度 +最大斜切长度 + + +### name [1/2] + + +``` +char PropertyObject::name[PROPERTY_NAME_LEN] +``` + +**描述：** + +属性名称 + + +### name [2/2] + + +``` +char DisplayCapability::name[PROPERTY_NAME_LEN] +``` + +**描述：** + +显示设备名称 + + +### numSegments + + +``` +int32_t VGUPath::numSegments +``` + +**描述：** + +路径命令总数 + + +### opacity [1/3] + + +``` +uint8_t VGUImage::opacity +``` + +**描述：** +透明度，范围0~255 -### height [4/7] +### opacity [2/3] + + +``` +uint8_t VGUGradient::opacity +``` + +**描述：** + +透明度，范围0~255 + + +### opacity [3/3] + + +``` +uint8_t VGUSolid::opacity +``` + +**描述：** + +透明度，取值范围 0 ~ 255。 + + +### pattern + + +``` +VGUPattern* VGUPaintStyle::pattern +``` + +**描述：** + +图片模式对象 + + +### phyAddr [1/3] + + +``` +uint64_t BufferData::phyAddr +``` + +**描述：** + +物理内存地址 + + +### phyAddr [2/3] + + +``` +uint64_t ISurface::phyAddr +``` + +**描述：** + +图像首地址 + + +### phyAddr [3/3] + + +``` +uint64_t VGUBuffer::phyAddr +``` + +**描述：** + +位图缓存的物理地址 + + +### phyHeight + + +``` +uint32_t DisplayCapability::phyHeight +``` + +**描述：** + +物理高度 + + +### phyWidth + ``` -int32_t ISurface::height +uint32_t DisplayCapability::phyWidth ``` **描述：** -图像高度 - +物理宽度 -### height [5/7] +### pitch + ``` -int32_t DisplayModeInfo::height +int32_t LayerBuffer::pitch ``` **描述：** -像素高度 - +一行数据所占字节数 -### height [6/7] +### pixelFormat + ``` -uint32_t AllocInfo::height +VGUPixelFormat VGUBuffer::pixelFormat ``` **描述：** -申请内存高度 - +像素格式 -### height [7/7] +### pixFormat [1/2] + ``` -uint32_t VerifyAllocInfo::height +PixelFormat LayerInfo::pixFormat ``` **描述：** -分配内存的高度 - +图层像素格式 -### id +### pixFormat [2/2] + ``` -int32_t DisplayModeInfo::id +PixelFormat LayerBuffer::pixFormat ``` **描述：** -模式ID - +buffer像素格式r -### InvokeDisplayCmd +### PrepareDisplayLayers + ``` -int32_t(* DeviceFuncs::InvokeDisplayCmd) (uint32_t devId,...) +int32_t(* DeviceFuncs::PrepareDisplayLayers) (uint32_t devId, bool *needFlushFb) ``` **描述：** -调用显示设备命令。 +显示设备合成前准备。 -该接口用于图形服务和接口实现层之间的接口扩展，如果由临时接口新增可以通过该接口进行扩展，不用增加新的接口定义。 +图形服务在合成前需要通过该接口通知显示设备进行合成前的准备工作。 **参数:** | 名称 | 描述 | | -------- | -------- | | devId | 输入参数，指示需要操作的设备ID。 | +| needFlushFb | 输出参数，接口实现层通过该参数指示图形服务在commit前是否需要通过[SetDisplayClientBuffer](#setdisplayclientbuffer)重新设置显示帧存。 true表示需要设置显示帧存，false表示不需要。 | **返回:** @@ -2203,193 +3593,225 @@ DISPLAY_SUCCESS 表示执行成功。 其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 -### key - +### propertyCount + ``` -HDRMetadataKey HDRMetaData::key +uint32_t DisplayCapability::propertyCount ``` **描述：** -HDR元数据关键字 - +属性数组大小 -### maxAverageLum +### propId + ``` -float HDRCapability::maxAverageLum +uint32_t PropertyObject::propId ``` **描述：** -最大的平均光亮度luminance值 - +属性ID -### maxLum +### props + ``` -float HDRCapability::maxLum +PropertyObject* DisplayCapability::props ``` **描述：** -最大的光亮度luminance值 - +属性数组 -### minLum +### QueryCapability + ``` -float HDRCapability::minLum +int32_t(* VGUFuncs::QueryCapability) (uint32_t cap) ``` **描述：** -最小的光亮度luminance值 +查询硬件能力集。 + +**参数:** + | 名称 | 描述 | +| -------- | -------- | +| cap | 输入参数，待查询能力。该参数类型定义参考 [VGUCapability](#vgucapability)。 | + +**返回:** + +VGU_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[VGUResult](#vguresult)。 -### mirrorType +### r + ``` -MirrorType GfxOpt::mirrorType +int32_t ICircle::r ``` **描述：** -镜像类型 - +圆的半径 -### name [1/2] +### r0 + ``` -char PropertyObject::name[PROPERTY_NAME_LEN] +VGUScalar VGURadial::r0 ``` **描述：** -属性名称 - +内圈圆半径 -### name [2/2] +### r1 + ``` -char DisplayCapability::name[PROPERTY_NAME_LEN] +VGUScalar VGURadial::r1 ``` **描述：** -显示设备名称 - +外圈圆半径 -### phyAddr [1/2] +### radial + ``` -uint64_t BufferData::phyAddr +VGURadial VGUGradient::radial ``` **描述：** -物理内存地址 - +辐射渐变对象 -### phyAddr [2/2] +### rect [1/3] + ``` -uint64_t ISurface::phyAddr +IRect Rectangle::rect ``` **描述：** -图像首地址 - +矩形区域 -### phyHeight +### rect [2/3] + ``` -uint32_t DisplayCapability::phyHeight +VGURect* VGUMaskLayer::rect ``` **描述：** -物理高度 - +蒙版矩形 -### phyWidth +### rect [3/3] + ``` -uint32_t DisplayCapability::phyWidth +VGURect* VGUImage::rect ``` **描述：** -物理宽度 - +图像截取矩形，该参数为空，则截取整个图像 -### pitch +### RegDisplayRefreshCallback + ``` -int32_t LayerBuffer::pitch +int32_t(* DeviceFuncs::RegDisplayRefreshCallback) (uint32_t devId, RefreshCallback callback, void *data) ``` **描述：** -一行数据所占字节数 - +刷新请求回调。 -### pixFormat [1/2] +注册刷新请求事件回调，当实现层有刷新需求时，实现层通过回调注册的接口通知图形服务。 +**参数:** -``` -PixelFormat LayerInfo::pixFormat -``` + | 名称 | 描述 | +| -------- | -------- | +| devId | 输入参数，指示需要操作的设备ID。 | +| callback | 输入参数，刷新请求事件回调实例，当有接口实现层有刷新请求时，需要通过该实例通知图形服务。 | +| data | 输出参数，图形服务携带的私有数据，在事件回调接口中需要返回给图形服务。 | -**描述：** +**返回:** -图层像素格式 +DISPLAY_SUCCESS 表示执行成功。 +其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 -### pixFormat [2/2] +### RegDisplayVBlankCallback + ``` -PixelFormat LayerBuffer::pixFormat +int32_t(* DeviceFuncs::RegDisplayVBlankCallback) (uint32_t devId, VBlankCallback callback, void *data) ``` **描述：** -buffer像素格式 +注册VBlank事件回调。 +注册VBlank事件回调，当有VBlank事件发生时接口实现层需要回调注册的接口。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| devId | 输入参数，指示需要操作的设备ID。 | +| callback | 输入参数，VBlank事件回调实例，当有VBlank事件发生时并且DisplayVsync处于Enable状态，接口实现层需要通过该实例通知图形服务。 | +| data | 输出参数，图形服务携带的私有数据，在事件回调接口中需要返回给图形服务。 | + +**返回:** + +DISPLAY_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 -### PrepareDisplayLayers +### RegHotPlugCallback + ``` -int32_t(* DeviceFuncs::PrepareDisplayLayers) (uint32_t devId, bool *needFlushFb) +int32_t(* DeviceFuncs::RegHotPlugCallback) (HotPlugCallback callback, void *data) ``` **描述：** -显示设备合成前准备。 +注册热插拔事件回调。 -图形服务在合成前需要通过该接口通知显示设备进行合成前的准备工作。 +注册热插拔事件回调，当有热插拔事件发生时接口实现层需要回调注册的接口。 **参数:** | 名称 | 描述 | | -------- | -------- | -| devId | 输入参数，指示需要操作的设备ID。 | -| needFlushFb | 输出参数，接口实现层通过该参数指示图形服务在commit前是否需要通过SetDisplayClientBuffer重新设置显示帧存。 true表示需要设置显示帧存，false表示不需要。 | +| callback | 输入参数，热插拔事件回调实例，当有热插拔事件发生时，接口实现层需要通过该实例通知图形服务。 | +| data | 输出参数，图形服务携带的私有数据，在事件回调接口中需要返回给图形服务。 | **返回:** @@ -2398,154 +3820,224 @@ DISPLAY_SUCCESS 表示执行成功。 其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 -### propertyCount - +### RenderBlit + ``` -uint32_t DisplayCapability::propertyCount +VGUResult(* VGUFuncs::RenderBlit) (VGUSurface *target, const VGUImage *src, uint32_t color) ``` **描述：** -属性数组大小 +对图像进行搬移操作。 +搬移过程中同时进行颜色空间转换，矩阵变换操作。 -### propId +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| target | 输入参数，渲染目标表面。 | +| src | 输入参数，待叠加源图像。 | +| color | 输入参数，参与混合的颜色值。如果颜色值为0，则不参与混合操作。 | + +**返回:** + +VGU_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[VGUResult](#vguresult)。 +### RenderBlitN + + ``` -uint32_t PropertyObject::propId +VGUResult(* VGUFuncs::RenderBlitN) (VGUSurface *target, const VGUImage *src, uint16_t count, uint32_t color) ``` **描述：** -属性ID +对多个源图像进行叠加操作。 +搬移过程中同时进行颜色空间转换，矩阵变换操作。该接口支持多个源图形同时叠加到目标表面， 对于硬件支持源图像数目可以通过[QueryCapability](#querycapability)接口查询**。** -### props +**参数**： + + + | 名称 | 描述 | +| -------- | -------- | +| target | 输入参数，渲染目标表面。 | +| src | 输入参数，待叠加源图像数组。 | +| count | 输入参数，待叠加源图像个数。 | +| color | 输入参数，参与混合的颜色值。如果颜色值为0，则不参与混合操作。 | + + +**返回**： + + +VGU_SUCCESS 表示执行成功。 +其他值表示执行失败，具体错误码查看[VGUResult](#vguresult)。 + + +### RenderBlur + + ``` -PropertyObject* DisplayCapability::props +VGUResult(* VGUFuncs::RenderBlur) (VGUSurface *target, uint16_t blur) ``` **描述：** -属性数组 +对目标表面进行模糊处理。 +**参数:** -### r + | 名称 | 描述 | +| -------- | -------- | +| target | 输入参数，渲染目标表面。 | +| blur | 输入参数，模糊半径。 | + +**返回:** + +VGU_SUCCESS 表示执行成功。 +其他值表示执行失败，具体错误码查看[VGUResult](#vguresult)。 + +### RenderCancel + + ``` -int32_t ICircle::r +VGUResult(* VGUFuncs::RenderCancel) () ``` **描述：** -圆的半径 +取消硬件加速渲染。 +**返回:** + +VGU_SUCCESS 表示执行成功。 -### rect +其他值表示执行失败，具体错误码查看[VGUResult](#vguresult)。 +### RenderClearRect + + ``` -IRect Rectangle::rect +VGUResult(* VGUFuncs::RenderClearRect) (VGUSurface *target, const VGURect *rect, uint32_t color, uint8_t opacity) ``` **描述：** -矩形区域 +对指定矩形进行颜色清除操作。 +**参数:** -### RegDisplayRefreshCallback + | 名称 | 描述 | +| -------- | -------- | +| target | 输入参数，渲染目标表面。 | +| rect | 输入参数，待填充矩形大小，如果该参数为空，则整个表面清除。 | +| color | 输入参数，填充颜色。 | +| opacity | 输入参数，填充透明度。 | + +**返回:** + +VGU_SUCCESS 表示执行成功。 +其他值表示执行失败，具体错误码查看[VGUResult](#vguresult)。 + +### RenderFill + + ``` -int32_t(* DeviceFuncs::RegDisplayRefreshCallback) (uint32_t devId, RefreshCallback callback, void *data) +VGUResult(* VGUFuncs::RenderFill) (VGUSurface *target, const VGUPath *path, const VGUMatrix3 *matrix, const VGUFillAttr *attr, const VGUPaintStyle *style) ``` **描述：** -刷新请求回调。 - -注册刷新请求事件回调，当实现层有刷新需求时，实现层通过回调注册的接口通知图形服务。 +使用指定的渲染对象来填充路径。 **参数:** | 名称 | 描述 | | -------- | -------- | -| devId | 输入参数，指示需要操作的设备ID。 | -| callback | 输入参数，刷新请求事件回调实例，当有接口实现层有刷新请求时，需要通过该实例通知图形服务。 | -| data | 输出参数，图形服务携带的私有数据，在事件回调接口中需要返回给图形服务。 | +| target | 输入参数，渲染目标表面。 | +| path | 输入参数，路径对象。 | +| matrix | 输入参数，变换矩阵对象。 如果该参数为空，默认为单位矩阵。 | +| attr | 输入参数，填充属性。 | +| style | 输入参数，绘制对象。 | **返回:** -DISPLAY_SUCCESS 表示执行成功。 - -其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 +VGU_SUCCESS 表示执行成功。 +其他值表示执行失败，具体错误码查看[VGUResult](#vguresult)。 -### RegDisplayVBlankCallback +### RenderStroke + ``` -int32_t(* DeviceFuncs::RegDisplayVBlankCallback) (uint32_t devId, VBlankCallback callback, void *data) +VGUResult(* VGUFuncs::RenderStroke) (VGUSurface *target, const VGUPath *path, const VGUMatrix3 *matrix, const VGUStrokeAttr *attr, const VGUPaintStyle *style) ``` **描述：** -注册VBlank事件回调。 - -注册VBlank事件回调，当有VBlank事件发生时接口实现层需要回调注册的接口。 +使用指定的渲染对象来描边路径。 **参数:** | 名称 | 描述 | | -------- | -------- | -| devId | 输入参数，指示需要操作的设备ID。 | -| callback | 输入参数，VBlank事件回调实例，当有VBlank事件发生时并且DisplayVsync处于Enable状态，接口实现层需要通过该实例通知图形服务。 | -| data | 输出参数，图形服务携带的私有数据，在事件回调接口中需要返回给图形服务。 | +| target | 输入参数，渲染目标表面。 | +| path | 输入参数，路径对象。 | +| matrix | 输入参数，变换矩阵对象。 如果该参数为空，默认为单位矩阵。 | +| attr | 输入参数，描边属性。 | +| style | 输入参数，绘制对象。 | **返回:** -DISPLAY_SUCCESS 表示执行成功。 - -其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 +VGU_SUCCESS 表示执行成功。 +其他值表示执行失败，具体错误码查看[VGUResult](#vguresult)。 -### RegHotPlugCallback +### RenderSync + ``` -int32_t(* DeviceFuncs::RegHotPlugCallback) ((HotPlugCallback callback, void *data) +VGUResult(* VGUFuncs::RenderSync) (int32_t timeOut) ``` **描述：** -注册热插拔事件回调。 +同步硬件加速模块绘制或搬移操作。 -注册热插拔事件回调，当有热插拔事件发生时接口实现层需要回调注册的接口。 +该函数将阻塞等待硬件绘制完成后继续运行。 **参数:** | 名称 | 描述 | | -------- | -------- | -| callback | 输入参数，热插拔事件回调实例，当有热插拔事件发生时，接口实现层需要通过该实例通知图形服务。 | -| data | 输出参数，图形服务携带的私有数据，在事件回调接口中需要返回给图形服务。 | +| timeOut | 输入参数，该参数表示硬件加速同步等待超时时间。 值为**0**表示没有等待时间。 | **返回:** -DISPLAY_SUCCESS 表示执行成功。 +VGU_SUCCESS 表示执行成功。 -其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 +其他值表示执行失败，具体错误码查看[VGUResult](#vguresult)。 ### reserve - + ``` -int32_t __attribute__::reserve[0] +int32_t ExtDataHandle::reserve[0] ``` **描述：** @@ -2555,9 +4047,9 @@ reserve数组 ### reserveInts - + ``` -uint32_t __attribute__::reserveInts +uint32_t ExtDataHandle::reserveInts ``` **描述：** @@ -2565,33 +4057,57 @@ uint32_t __attribute__::reserveInts reserve数组的个数 -### rotAngle +### rotAngle + + +``` +int32_t DisplayInfo::rotAngle +``` + +**描述：** + +显示屏旋转角度 + + +### rotateType + + +``` +TransformType GfxOpt::rotateType +``` + +**描述：** + +旋转类型 + +### rule + ``` -int32_t DisplayInfo::rotAngle +VGUFillRule VGUFillAttr::rule ``` **描述：** -显示屏旋转角度 - +填充规格 -### rotateType +### segment + ``` -TransformType GfxOpt::rotateType +uint8_t* VGUPath::segment ``` **描述：** -旋转类型 +存放路径命令数据 ### SetDisplayBacklight - + ``` int32_t(* DeviceFuncs::SetDisplayBacklight) (uint32_t devId, uint32_t level) ``` @@ -2618,7 +4134,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### SetDisplayClientBuffer - + ``` int32_t(* DeviceFuncs::SetDisplayClientBuffer) (uint32_t devId, const BufferHandle *buffer, int32_t fence) ``` @@ -2646,7 +4162,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### SetDisplayClientCrop - + ``` int32_t(* DeviceFuncs::SetDisplayClientCrop) (uint32_t devId, IRect *rect) ``` @@ -2673,7 +4189,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### SetDisplayClientDamage - + ``` int32_t(* DeviceFuncs::SetDisplayClientDamage) (uint32_t devId, uint32_t num, IRect *rect) ``` @@ -2701,7 +4217,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### SetDisplayClientDestRect - + ``` int32_t(* DeviceFuncs::SetDisplayClientDestRect) (uint32_t devId, IRect *rect) ``` @@ -2728,7 +4244,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### SetDisplayColorGamut - + ``` int32_t(* DeviceFuncs::SetDisplayColorGamut) (uint32_t devId, ColorGamut gamut) ``` @@ -2753,7 +4269,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### SetDisplayColorTransform - + ``` int32_t(* DeviceFuncs::SetDisplayColorTransform) (uint32_t devId, const float *matrix) ``` @@ -2778,7 +4294,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### SetDisplayGamutMap - + ``` int32_t(* DeviceFuncs::SetDisplayGamutMap) (uint32_t devId, GamutMap gamutMap) ``` @@ -2803,7 +4319,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### SetDisplayMode - + ``` int32_t(* DeviceFuncs::SetDisplayMode) (uint32_t devId, uint32_t modeId) ``` @@ -2830,7 +4346,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### SetDisplayPowerStatus - + ``` int32_t(* DeviceFuncs::SetDisplayPowerStatus) (uint32_t devId, DispPowerStatus status) ``` @@ -2857,7 +4373,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### SetDisplayProperty - + ``` int32_t(* DeviceFuncs::SetDisplayProperty) (uint32_t devId, uint32_t id, uint64_t value) ``` @@ -2885,7 +4401,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### SetDisplayVsyncEnabled - + ``` int32_t(* DeviceFuncs::SetDisplayVsyncEnabled) (uint32_t devId, bool enabled) ``` @@ -2912,7 +4428,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### SetVirtualDisplayBuffer - + ``` int32_t(* DeviceFuncs::SetVirtualDisplayBuffer) (uint32_t devId, BufferHandle *buffer, int32_t fence) ``` @@ -2938,9 +4454,57 @@ DISPLAY_SUCCESS 表示执行成功。 其他值表示执行失败，具体错误码查看[DispErrCode](#disperrcode)。 -### stride +### solid + + +``` +VGUSolid* VGUPaintStyle::solid +``` + +**描述：** + +颜色对象 + + +### spread + + +``` +VGUFillSpread VGUGradient::spread +``` + +**描述：** + +渐变延伸模式 + + +### stop + + +``` +float VGUColorStop::stop +``` + +**描述：** + +颜色偏移位置，取值范围是 0.0 ~ 1.0。 + + +### stopCount + + +``` +uint16_t VGUGradient::stopCount +``` + +**描述：** + +渐变停止颜色个数 + +### stride [1/2] + ``` int32_t ISurface::stride ``` @@ -2950,9 +4514,21 @@ int32_t ISurface::stride 图像跨度 -### supportLayers +### stride [2/2] + + +``` +uint32_t VGUBuffer::stride +``` +**描述：** + +位图stride + + +### supportLayers + ``` uint32_t DisplayCapability::supportLayers ``` @@ -2964,7 +4540,7 @@ uint32_t DisplayCapability::supportLayers ### supportWriteBack - + ``` bool DisplayCapability::supportWriteBack ``` @@ -2976,7 +4552,7 @@ bool DisplayCapability::supportWriteBack ### time - + ``` int64_t PresentTimestamp::time ``` @@ -2986,9 +4562,9 @@ int64_t PresentTimestamp::time 类型对应的值 -### type [1/3] - +### type [1/7] + ``` LayerType LayerInfo::type ``` @@ -2998,9 +4574,9 @@ LayerType LayerInfo::type 图层类型，包括图形层、视频层和媒体播放模式 -### type [2/3] - +### type [2/7] + ``` InterfaceType DisplayCapability::type ``` @@ -3010,9 +4586,9 @@ InterfaceType DisplayCapability::type 显示屏接口类型 -### type [3/3] - +### type [3/7] + ``` PresentTimestampType PresentTimestamp::type ``` @@ -3022,11 +4598,59 @@ PresentTimestampType PresentTimestamp::type 上屏时间戳类型 -### uOffset +### type [4/7] + + +``` +VGUPathDataType VGUPath::type +``` + +**描述：** + +路径数据存储类型 + + +### type [5/7] + + +``` +uint32_t VGUMatrix3::type +``` + +**描述：** + +矩阵变换类型，简单变换为缩放，平移，90度倍数旋转 + + +### type [6/7] + + +``` +VGUGradientType VGUGradient::type +``` + +**描述：** + +渐变类型 + + +### type [7/7] + + +``` +VGUPaintType VGUPaintStyle::type +``` + +**描述：** +渲染类型 + +### uOffset + + ``` -size_t __attribute__::uOffset +size_t YUVDescInfo::uOffset ``` **描述：** @@ -3036,7 +4660,7 @@ U的偏移量 ### usage [1/2] - + ``` uint64_t AllocInfo::usage ``` @@ -3048,7 +4672,7 @@ uint64_t AllocInfo::usage ### usage [2/2] - + ``` uint64_t VerifyAllocInfo::usage ``` @@ -3060,9 +4684,9 @@ uint64_t VerifyAllocInfo::usage ### uvStep - + ``` -size_t __attribute__::uvStep +size_t YUVDescInfo::uvStep ``` **描述：** @@ -3072,7 +4696,7 @@ UV的step信息 ### uvStride - + ``` size_t __attribute__::uvStride ``` @@ -3084,7 +4708,7 @@ UV的stride信息 ### value [1/2] - + ``` uint64_t PropertyObject::value ``` @@ -3096,7 +4720,7 @@ uint64_t PropertyObject::value ### value [2/2] - + ``` float HDRMetaData::value ``` @@ -3106,9 +4730,9 @@ float HDRMetaData::value 关键字对应的值 -### virAddr - +### virAddr [1/2] + ``` void* BufferData::virAddr ``` @@ -3118,9 +4742,21 @@ void* BufferData::virAddr 虚拟内存地址 -### virtualDispCount +### virAddr [2/2] + + +``` +void* VGUBuffer::virAddr +``` + +**描述：** +位图缓存的虚拟地址 + +### virtualDispCount + + ``` uint32_t DisplayCapability::virtualDispCount ``` @@ -3132,9 +4768,9 @@ uint32_t DisplayCapability::virtualDispCount ### vOffset - + ``` -size_t __attribute__::vOffset +size_t YUVDescInfo::vOffset ``` **描述：** @@ -3142,9 +4778,9 @@ size_t __attribute__::vOffset V的偏移量 -### w - +### w [1/2] + ``` int32_t IRect::w ``` @@ -3154,9 +4790,21 @@ int32_t IRect::w 矩形框宽度 -### width [1/7] +### w [2/2] + + +``` +VGUScalar VGURect::w +``` + +**描述：** + +矩形宽度 + +### width [1/9] + ``` uint32_t DisplayInfo::width ``` @@ -3166,9 +4814,9 @@ uint32_t DisplayInfo::width 显示屏宽度 -### width [2/7] - +### width [2/9] + ``` int32_t LayerInfo::width ``` @@ -3178,9 +4826,9 @@ int32_t LayerInfo::width 图层宽度 -### width [3/7] - +### width [3/9] + ``` int32_t LayerBuffer::width ``` @@ -3190,9 +4838,9 @@ int32_t LayerBuffer::width buffer宽度 -### width [4/7] - +### width [4/9] + ``` int32_t ISurface::width ``` @@ -3202,9 +4850,9 @@ int32_t ISurface::width 图像宽度 -### width [5/7] - +### width [5/9] + ``` int32_t DisplayModeInfo::width ``` @@ -3214,9 +4862,9 @@ int32_t DisplayModeInfo::width 像素宽度 -### width [6/7] - +### width [6/9] + ``` uint32_t AllocInfo::width ``` @@ -3226,9 +4874,9 @@ uint32_t AllocInfo::width 申请内存宽度 -### width [7/7] - +### width [7/9] + ``` uint32_t VerifyAllocInfo::width ``` @@ -3238,9 +4886,57 @@ uint32_t VerifyAllocInfo::width 分配内存的宽度 -### x [1/2] +### width [8/9] + + +``` +uint32_t VGUBuffer::width +``` + +**描述：** + +位图宽度 + + +### width [9/9] + + +``` +float VGUStrokeAttr::width +``` + +**描述：** + +线宽 + + +### wrapx + + +``` +VGUWrapType VGUPattern::wrapx +``` + +**描述：** + +图像水平方向平铺类型 + + +### wrapy + + +``` +VGUWrapType VGUPattern::wrapy +``` + +**描述：** + +图像垂直方向平铺类型 + +### x [1/4] + ``` int32_t IRect::x ``` @@ -3250,9 +4946,9 @@ int32_t IRect::x 矩形框起始x坐标 -### x [2/2] - +### x [2/4] + ``` int32_t ICircle::x ``` @@ -3262,9 +4958,33 @@ int32_t ICircle::x 圆心x坐标 -### x0 +### x [3/4] + + +``` +VGUScalar VGUPoint::x +``` + +**描述：** + +点水平坐标 + + +### x [4/4] + + +``` +VGUScalar VGURect::x +``` + +**描述：** + +矩形水平起始坐标 + +### x0 [1/2] + ``` int32_t ILine::x0 ``` @@ -3274,9 +4994,21 @@ int32_t ILine::x0 线条起点的x坐标 -### x1 +### x0 [2/2] + + +``` +VGUScalar VGURadial::x0 +``` + +**描述：** + +内圈圆心水平坐标 + +### x1 [1/3] + ``` int32_t ILine::x1 ``` @@ -3286,9 +5018,45 @@ int32_t ILine::x1 线条终点的x坐标 -### y [1/2] +### x1 [2/3] + + +``` +VGUScalar VGULinear::x1 +``` + +**描述：** + +线性渐变起点水平坐标 + + +### x1 [3/3] + +``` +VGUScalar VGURadial::x1 +``` + +**描述：** + +外圈圆心水平坐标 + + +### x2 + + +``` +VGUScalar VGULinear::x2 +``` + +**描述：** +线性渐变终点水平坐标 + + +### y [1/4] + + ``` int32_t IRect::y ``` @@ -3298,9 +5066,9 @@ int32_t IRect::y 矩形框起始y坐标 -### y [2/2] - +### y [2/4] + ``` int32_t ICircle::y ``` @@ -3310,9 +5078,33 @@ int32_t ICircle::y 圆心y坐标r -### y0 +### y [3/4] + +``` +VGUScalar VGUPoint::y +``` + +**描述：** + +点垂直坐标 + + +### y [4/4] + + +``` +VGUScalar VGURect::y +``` + +**描述：** +矩形垂直起始坐标 + + +### y0 [1/2] + + ``` int32_t ILine::y0 ``` @@ -3322,9 +5114,21 @@ int32_t ILine::y0 线条起点的y坐标 -### y1 +### y0 [2/2] + + +``` +VGUScalar VGURadial::y0 +``` + +**描述：** +内圈圆心垂直坐标 + +### y1 [1/3] + + ``` int32_t ILine::y1 ``` @@ -3334,11 +5138,47 @@ int32_t ILine::y1 线条终点的y坐标 -### yOffset +### y1 [2/3] + + +``` +VGUScalar VGULinear::y1 +``` + +**描述：** + +线性渐变起点垂直坐标 + + +### y1 [3/3] + + +``` +VGUScalar VGURadial::y1 +``` + +**描述：** + +外圈圆心垂直坐标 + + +### y2 + + +``` +VGUScalar VGULinear::y2 +``` + +**描述：** +线性渐变终点垂直坐标 + +### yOffset + + ``` -size_t __attribute__::yOffset +size_t YUVDescInfo::yOffset ``` **描述：** @@ -3348,9 +5188,9 @@ Y的偏移量 ### yStride - + ``` -size_t __attribute__::yStride +size_t YUVDescInfo::yStride ``` **描述：** diff --git a/zh-cn/device-dev/reference/hdi-apis/_display_capability.md b/zh-cn/device-dev/reference/hdi-apis/_display_capability.md index a4a43e5cb58d12934ab7589b6e901c97b5a4c3c7..dc9fb8e076741b999ee98f403c7c5e563d2e7ffc 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_display_capability.md +++ b/zh-cn/device-dev/reference/hdi-apis/_display_capability.md @@ -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) | 属性数组 | - - -## **详细描述** - -定义输出性能。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_display_info.md b/zh-cn/device-dev/reference/hdi-apis/_display_info.md index b67997b6de13b855cdea17de0987e37d70b233be..daaa760ad656a45a7877199274a37ddf1b369f11 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_display_info.md +++ b/zh-cn/device-dev/reference/hdi-apis/_display_info.md @@ -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) | 显示屏旋转角度 | - - -## **详细描述** - -定义显示信息结构体。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_display_mode_info.md b/zh-cn/device-dev/reference/hdi-apis/_display_mode_info.md index eafd58d19e35fad8b0a08e5389bd1ca9e34b1209..a89c6e0ff77a5b9bf8d183a17539c9ea4f651919 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_display_mode_info.md +++ b/zh-cn/device-dev/reference/hdi-apis/_display_mode_info.md @@ -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 | - - -## **详细描述** - -定义输出模式信息。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_enroll_param.md b/zh-cn/device-dev/reference/hdi-apis/_enroll_param.md index cc322e8336343a6499543a67f7ca6565cf3f29b3..df3fc98fbc8e6a2a2938fc0d6435ac6459b38677 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_enroll_param.md +++ b/zh-cn/device-dev/reference/hdi-apis/_enroll_param.md @@ -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) | 既定用户认证凭据类型的执行器传感器提示，用于找到对应认证方式的传感器。 | ## **类成员变量说明** diff --git a/zh-cn/device-dev/reference/hdi-apis/_enroll_resultinfo.md b/zh-cn/device-dev/reference/hdi-apis/_enroll_resultinfo.md index a1213411c37768ce085514a640f8d89adc301a63..c16294b124fd10052766e2eec171eefcc2c388d8 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_enroll_resultinfo.md +++ b/zh-cn/device-dev/reference/hdi-apis/_enroll_resultinfo.md @@ -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 diff --git a/zh-cn/device-dev/reference/hdi-apis/_enrolled_info.md b/zh-cn/device-dev/reference/hdi-apis/_enrolled_info.md index 36c6ffd6e1e8e66e645074fd4fb3b81388059e14..63fe13082c82824a84d862b0c6ce7acd0798553f 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_enrolled_info.md +++ b/zh-cn/device-dev/reference/hdi-apis/_enrolled_info.md @@ -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 diff --git a/zh-cn/device-dev/reference/hdi-apis/_event_info.md b/zh-cn/device-dev/reference/hdi-apis/_event_info.md index 02b70dc552b5ced6c3ed1b8f1cc995cce92fab1d..93032444d007f364a50ec8e287d948efa8702e38 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_event_info.md +++ b/zh-cn/device-dev/reference/hdi-apis/_event_info.md @@ -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字节数。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_executor_info.md b/zh-cn/device-dev/reference/hdi-apis/_executor_info.md index 29f4d116ca581180a4a07be6ffccddbc250ee365..c67700a04747ebc6a061cf7cb6cab70699090524 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_executor_info.md +++ b/zh-cn/device-dev/reference/hdi-apis/_executor_info.md @@ -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，不同传感器在人脸认证驱动、口令认证驱动内的唯一标识。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_executor_register_info.md b/zh-cn/device-dev/reference/hdi-apis/_executor_register_info.md index ff242ae7d76d8749b458eac663519c3ca30fbb12..a0ee3deb5f7e7e0ae97a1c5f3ce6db95bd42bc88 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_executor_register_info.md +++ b/zh-cn/device-dev/reference/hdi-apis/_executor_register_info.md @@ -3,6 +3,16 @@ ## **概述** +执行器注册信息。 + +**Since：** + +3.2 + +**Version：** + +1.0 + **所属模块:** [HdfUserAuth](_hdf_user_auth.md) @@ -13,7 +23,7 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | | [authType](#authtype) | 用户认证凭据类型。 | | [executorRole](#executorrole) | 执行器角色。 | @@ -23,19 +33,6 @@ | [publicKey](#publickey) | 执行器公钥，用于校验该执行器私钥签名的信息。 | -## **详细描述** - -执行器注册信息。 - -**Since：** - -3.2 - -**Version：** - -1.0 - - ## **类成员变量说明** diff --git a/zh-cn/device-dev/reference/hdi-apis/_executor_send_msg.md b/zh-cn/device-dev/reference/hdi-apis/_executor_send_msg.md index 90ed9fcc8933fe089cf35c374839e4168bf83f8c..ba9ea1bf58db81a19ebdff5a34eb0a5e0031563f 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_executor_send_msg.md +++ b/zh-cn/device-dev/reference/hdi-apis/_executor_send_msg.md @@ -3,6 +3,16 @@ ## **概述** +执行器发送的消息。 + +**Since：** + +3.2 + +**Version：** + +1.0 + **所属模块:** [HdfUserAuth](_hdf_user_auth.md) @@ -13,24 +23,13 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | | [executorIndex](#executorindex) | 用户认证框架的执行器索引。 | | [commandId](#commandid) | 消息命令ID。 | | [msg](#msg) | 执行器发送的消息。 | -## **详细描述** - -执行器发送的消息。 - -**Since：** - -3.2 - -**Version：** - - ## **类成员变量说明** diff --git a/zh-cn/device-dev/reference/hdi-apis/_ext_data_handle.md b/zh-cn/device-dev/reference/hdi-apis/_ext_data_handle.md new file mode 100644 index 0000000000000000000000000000000000000000..51239a52338c14e4d3a360136e58c80b73a64df7 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_ext_data_handle.md @@ -0,0 +1,22 @@ +# ExtDataHandle + + +## **概述** + +扩展数据句柄结构体定义。 + +**相关模块:** + +[Display](_display.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [fd](_display.md#fd) | 句柄 fd, -1代表不支持。 | +| [reserveInts](_display.md#reserveints) | reserve数组的个数。 | +| [reserve](_display.md#reserve) [0] | reserve数组。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_face_auth_types_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_face_auth_types_8idl.md index b9c9e4ad7876f5796cd736e15b1ec3ae429eb4c1..580e403779f4246547b52d2e90534a6c230ad0ae 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_face_auth_types_8idl.md +++ b/zh-cn/device-dev/reference/hdi-apis/_face_auth_types_8idl.md @@ -3,6 +3,12 @@ ## **概述** +定义人脸认证驱动的枚举类和数据结构。 + +**Since：** + +3.2 + **所属模块:** [HdfFaceAuth](_hdf_face_auth.md) @@ -13,34 +19,25 @@ ### 类 - | 类 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [ExecutorInfo](_executor_info.md) | 执行器信息。 [更多...](_executor_info.md) | -| [TemplateInfo](_template_info.md) | 凭据模版信息。 [更多...](_template_info.md) | +| [ExecutorInfo](_executor_info.md) | 执行器信息。 | +| [TemplateInfo](_template_info.md) | 凭据模版信息。 | ### 枚举 - | 枚举 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [AuthType](_hdf_face_auth.md#authtype) : int { PIN = 1, FACE = 2, FINGERPRINT = 4 } | 枚举用户认证凭据类型。 [更多...](_hdf_face_auth.md#authtype) | -| [ExecutorRole](_hdf_face_auth.md#executorrole) : int { COLLECTOR = 1, VERIFIER = 2, ALL_IN_ONE = 3 } | 枚举执行器角色。 [更多...](_hdf_face_auth.md#executorrole) | -| [ExecutorSecureLevel](_hdf_face_auth.md#executorsecurelevel) : int { ESL0 = 0, ESL1 = 1, ESL2 = 2, ESL3 = 3 } | 枚举执行器安全等级。 [更多...](_hdf_face_auth.md#executorsecurelevel) | -| [CommandId](_hdf_face_auth.md#commandid) : int { LOCK_TEMPLATE = 1, UNLOCK_TEMPLATE = 2, VENDOR_COMMAND_BEGIN = 10000 } | 枚举人脸认证功能相关操作命令。 [更多...](_hdf_face_auth.md#commandid) | -| [FaceTipsCode](_hdf_face_auth.md#facetipscode) : int { FACE_AUTH_TIP_TOO_BRIGHT = 1, FACE_AUTH_TIP_TOO_DARK = 2, FACE_AUTH_TIP_TOO_CLOSE = 3, FACE_AUTH_TIP_TOO_FAR = 4,   FACE_AUTH_TIP_TOO_HIGH = 5, FACE_AUTH_TIP_TOO_LOW = 6, FACE_AUTH_TIP_TOO_RIGHT = 7, FACE_AUTH_TIP_TOO_LEFT = 8,   FACE_AUTH_TIP_TOO_MUCH_MOTION = 9, FACE_AUTH_TIP_POOR_GAZE = 10, FACE_AUTH_TIP_NOT_DETECTED = 11, VENDOR_FACE_AUTH_TIP_BEGIN = 10000 } | 枚举提示信息编码。 [更多...](_hdf_face_auth.md#facetipscode) | +| [AuthType](_hdf_face_auth.md#authtype): int { PIN = 1, FACE = 2, FINGERPRINT = 4 } | 枚举用户认证凭据类型。 | +| [ExecutorRole](_hdf_face_auth.md#executorrole): int { COLLECTOR = 1, VERIFIER = 2, ALL_IN_ONE = 3 } | 枚举执行器角色。 | +| [ExecutorSecureLevel](_hdf_face_auth.md#executorsecurelevel): int { ESL0 = 0, ESL1 = 1, ESL2 = 2, ESL3 = 3 } | 枚举执行器安全等级。 | +| [CommandId](_hdf_face_auth.md#commandid): int { LOCK_TEMPLATE = 1, UNLOCK_TEMPLATE = 2, VENDOR_COMMAND_BEGIN = 10000 } | 枚举人脸认证功能相关操作命令。 | +| [FaceTipsCode](_hdf_face_auth.md#facetipscode): int { FACE_AUTH_TIP_TOO_BRIGHT = 1, FACE_AUTH_TIP_TOO_DARK = 2, FACE_AUTH_TIP_TOO_CLOSE = 3, FACE_AUTH_TIP_TOO_FAR = 4,   FACE_AUTH_TIP_TOO_HIGH = 5, FACE_AUTH_TIP_TOO_LOW = 6, FACE_AUTH_TIP_TOO_RIGHT = 7, FACE_AUTH_TIP_TOO_LEFT = 8,   FACE_AUTH_TIP_TOO_MUCH_MOTION = 9, FACE_AUTH_TIP_POOR_GAZE = 10, FACE_AUTH_TIP_NOT_DETECTED = 11, VENDOR_FACE_AUTH_TIP_BEGIN = 10000 } | 枚举提示信息编码。 | -### 变量 +### 关键字 - | 变量 名称 | 描述 | + | 名称 | 描述 | | -------- | -------- | | package ohos.hdi.face_auth.v1_0 | 人脸认证接口的包路径 | - - -## **详细描述** - -定义人脸认证驱动的枚举类和数据结构。 - -**Since：** - -3.2 diff --git a/zh-cn/device-dev/reference/hdi-apis/_get_buffer_handle_usage_params.md b/zh-cn/device-dev/reference/hdi-apis/_get_buffer_handle_usage_params.md index 2f5936c9d16e2800eb9fd6718d7f18f552e99685..da5ba0c838ea4dd4d13bf64034bddf6e2697a401 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_get_buffer_handle_usage_params.md +++ b/zh-cn/device-dev/reference/hdi-apis/_get_buffer_handle_usage_params.md @@ -3,9 +3,11 @@ ## **概述** -**所属模块:** +BufferHandleUsage类型定义。 + +**相关模块:** -[Codec](_codec.md) +[Codec](codec.md) ## **汇总** @@ -13,17 +15,12 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [size](#size) | 结构体大小 | -| [version](#version) | 组件版本信息 | -| [portIndex](#portindex) | 端口索引 | -| [usage](#usage) | 使用率 | - - -## **详细描述** - -BufferHandleUsage类型定义。 +| [size](#size) | 结构体大小。 | +| [version](#version) | 组件版本信息。 | +| [portIndex](#portindex) | 端口索引。 | +| [usage](#usage) | 申请内存的使用场景。 | ## **类成员变量说明** @@ -38,7 +35,7 @@ uint32_t GetBufferHandleUsageParams::portIndex **描述：** -端口索引 +端口索引。 ### size @@ -50,7 +47,7 @@ uint32_t GetBufferHandleUsageParams::size **描述：** -结构体大小 +结构体大小。 ### usage @@ -62,7 +59,7 @@ uint32_t GetBufferHandleUsageParams::usage **描述：** -usage +申请内存的使用场景。 ### version @@ -74,4 +71,4 @@ union OMX_VERSIONTYPE GetBufferHandleUsageParams::version **描述：** -组件版本信息 +组件版本信息。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_gfx_funcs.md b/zh-cn/device-dev/reference/hdi-apis/_gfx_funcs.md index 76ed3097f7da3a13a35b00d4f791bfcf2ffa2ccf..fcc1c2a22e5cb89102134fe227a7c38a29c82ac2 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_gfx_funcs.md +++ b/zh-cn/device-dev/reference/hdi-apis/_gfx_funcs.md @@ -3,7 +3,9 @@ ## **概述** -**所属模块:** +显示硬件加速驱动接口结构体，定义硬件加速驱动接口函数指针。 + +**相关模块:** [Display](_display.md) @@ -13,21 +15,16 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| ( [InitGfx](#initgfx) )(void) | 初始化硬件加速。 [更多...](#initgfx) | -| ( [DeinitGfx](#deinitgfx) )(void) | 去初始化硬件加速。 [更多...](#deinitgfx) | -| ( [FillRect](#fillrect) )([ISurface](_i_surface.md) \*surface, [IRect](_i_rect.md) \*rect, uint32_t color, [GfxOpt](_gfx_opt.md) \*opt) | 填充矩形，用一种颜色填充画布上指定矩形区域的矩形框。 [更多...](#fillrect) | -| ( [DrawRectangle](#drawrectangle) )([ISurface](_i_surface.md) \*surface, [Rectangle](_rectangle.md) \*rect, uint32_t color, [GfxOpt](_gfx_opt.md) \*opt) | 绘制矩形框，用一种颜色在画布上绘制指定区域的矩形框。 [更多...](#drawrectangle) | -| ( [DrawLine](#drawline) )([ISurface](_i_surface.md) \*surface, [ILine](_i_line.md) \*line, [GfxOpt](_gfx_opt.md) \*opt) | 绘制直线，使用一种颜色在画布上绘制一条直线。 [更多...](#drawline) | -| ( [DrawCircle](#drawcircle) )([ISurface](_i_surface.md) \*surface, [ICircle](_i_circle.md) \*circle, [GfxOpt](_gfx_opt.md) \*opt) | 绘制圆形，使用一种颜色在画布上绘制指定圆心和半径的圆。 [更多...](#drawcircle) | -| ( [Blit](#blit) )([ISurface](_i_surface.md) \*srcSurface, [IRect](_i_rect.md) \*srcRect, [ISurface](_i_surface.md) \*dstSurface, [IRect](_i_rect.md) \*dstRect, [GfxOpt](_gfx_opt.md) \*opt) | 位图搬移 [更多...](#blit) | -| ( [Sync](#sync) )(int32_t timeOut) | 硬件加速同步。 [更多...](#sync) | - - -## **详细描述** - -显示硬件加速驱动接口结构体，定义硬件加速驱动接口函数指针。 +| ([InitGfx](#initgfx))(void) | 初始化硬件加速。 | +| ([DeinitGfx](#deinitgfx))(void) | 去初始化硬件加速。 | +| ([FillRect](#fillrect))(ISurface \*surface, IRect \*rect, uint32_t color, GfxOpt \*opt) | 填充矩形，用一种颜色填充画布上指定矩形区域的矩形框。 | +| ([DrawRectangle](#drawrectangle))(ISurface \*surface, Rectangle \*rect, uint32_t color, GfxOpt \*opt) | 绘制矩形框，用一种颜色在画布上绘制指定区域的矩形框。 | +| ([DrawLine](#drawline))(ISurface \*surface, ILine \*line, GfxOpt \*opt) | 绘制直线，使用一种颜色在画布上绘制一条直线。 | +| ([DrawCircle](#drawcircle))(ISurface \*surface, ICircle \*circle, GfxOpt \*opt) | 绘制圆形，使用一种颜色在画布上绘制指定圆心和半径的圆。 | +| ([Blit](#blit))(ISurface \*srcSurface, IRect \*srcRect, ISurface \*dstSurface, IRect \*dstRect, GfxOpt \*opt) | 位图搬移 | +| ([Sync](#sync))(int32_t timeOut) | 硬件加速同步。 | ## **类成员变量说明** @@ -42,11 +39,11 @@ int32_t(* GfxFuncs::Blit) (ISurface *srcSurface, IRect *srcRect, ISurface *dstSu **描述：** -位图搬移 +位图搬移。 在位图搬移过程中，可以实现色彩空间转换、缩放、旋转等功能。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -56,7 +53,7 @@ int32_t(* GfxFuncs::Blit) (ISurface *srcSurface, IRect *srcRect, ISurface *dstSu | dstRect | 输出参数，目标位图区域。 | | opt | 输入参数，硬件加速选项。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 @@ -74,13 +71,13 @@ int32_t(* GfxFuncs::DeinitGfx) (void) 去初始化硬件加速。 -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#disperrcode)。 -**参见：** +**参见:** [InitGfx](#initgfx) @@ -96,7 +93,7 @@ int32_t(* GfxFuncs::DrawCircle) (ISurface *surface, ICircle *circle, GfxOpt *opt 绘制圆形，使用一种颜色在画布上绘制指定圆心和半径的圆。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -104,7 +101,7 @@ int32_t(* GfxFuncs::DrawCircle) (ISurface *surface, ICircle *circle, GfxOpt *opt | circle | 输入参数，圆形结构。 | | opt | 输入参数，硬件加速选项。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 @@ -122,7 +119,7 @@ int32_t(* GfxFuncs::DrawLine) (ISurface *surface, ILine *line, GfxOpt *opt) 绘制直线，使用一种颜色在画布上绘制一条直线。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -130,7 +127,7 @@ int32_t(* GfxFuncs::DrawLine) (ISurface *surface, ILine *line, GfxOpt *opt) | line | 输入参数，直线结构。 | | opt | 输入参数，硬件加速选项。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 @@ -148,7 +145,7 @@ int32_t(* GfxFuncs::DrawRectangle) (ISurface *surface, Rectangle *rect, uint32_t 绘制矩形框，用一种颜色在画布上绘制指定区域的矩形框。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -157,7 +154,7 @@ int32_t(* GfxFuncs::DrawRectangle) (ISurface *surface, Rectangle *rect, uint32_t | color | 输入参数，绘制的颜色。 | | opt | 输入参数，硬件加速选项。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 @@ -175,7 +172,7 @@ int32_t(* GfxFuncs::FillRect) (ISurface *surface, IRect *rect, uint32_t color, G 填充矩形，用一种颜色填充画布上指定矩形区域的矩形框。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -184,7 +181,7 @@ int32_t(* GfxFuncs::FillRect) (ISurface *surface, IRect *rect, uint32_t color, G | color | 输入参数，填充的颜色。 | | opt | 输入参数，硬件加速选项。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 @@ -202,13 +199,13 @@ int32_t(* GfxFuncs::InitGfx) (void) 初始化硬件加速。 -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#disperrcode)。 -**参见：** +**参见:** [DeinitGfx](#deinitgfx) @@ -226,13 +223,13 @@ int32_t(* GfxFuncs::Sync) (int32_t timeOut) 在使用硬件加速模块进行图像绘制、图像叠加、图像搬移时，通过调用该接口进行硬件同步，该接口会等待硬件加速完成。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | timeOut | 输入参数，硬件加速同步超时设置，设置为0表示无超时，等待直到硬件加速完成。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_gfx_opt.md b/zh-cn/device-dev/reference/hdi-apis/_gfx_opt.md index 00fdaa09fd517f09213a136e8ab126a907c73b02..a278028b82892474e27285b6f08fcfc9a72c3cd4 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_gfx_opt.md +++ b/zh-cn/device-dev/reference/hdi-apis/_gfx_opt.md @@ -3,7 +3,9 @@ ## **概述** -**所属模块:** +图像硬件加速相关的操作选项结构体定义，用于图像硬件加速时的操作选项。 + +**相关模块:** [Display](_display.md) @@ -13,11 +15,11 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [enGlobalAlpha](_display.md#englobalalpha-22) | 全局alpha使能标志 | -| [globalAlpha](_display.md#globalalpha) | 全局alpha的值 | -| [enPixelAlpha](_display.md#enpixelalpha-22) | 像素alpha使能标志 | +| [enGlobalAlpha](_display.md#englobalalpha-22) | 全局Alpha使能标志 | +| [globalAlpha](_display.md#globalalpha) | 全局Alpha的值 | +| [enPixelAlpha](_display.md#enpixelalpha-22) | 像素Alpha使能标志 | | [blendType](_display.md#blendtype) | 混合方式 | | [colorKeyFrom](_display.md#colorkeyfrom) | 色键模式 | | [enableRop](_display.md#enablerop) | Rop功能使能位 | @@ -26,8 +28,3 @@ | [enableScale](_display.md#enablescale) | 缩放功能使能位 | | [rotateType](_display.md#rotatetype) | 旋转类型 | | [mirrorType](_display.md#mirrortype) | 镜像类型 | - - -## **详细描述** - -图像硬件加速相关的操作选项结构体定义，用于图像硬件加速时的操作选项。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_gralloc_funcs.md b/zh-cn/device-dev/reference/hdi-apis/_gralloc_funcs.md index d67c99a3dd81c1e4afa35a157c5b43538d65f4c1..db86f4424e237c419c2860fd1e64b4f50feeb2b1 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_gralloc_funcs.md +++ b/zh-cn/device-dev/reference/hdi-apis/_gralloc_funcs.md @@ -3,7 +3,9 @@ ## **概述** -**所属模块:** +显示内存驱动接口结构体，定义显示内存驱动接口函数指针。 + +**相关模块:** [Display](_display.md) @@ -13,23 +15,18 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| ( [AllocMem](#allocmem) )(const [AllocInfo](_alloc_info.md) \*info, BufferHandle \*\*handle) | 显示内存分配。 [更多...](#allocmem) | -| ( [FreeMem](#freemem) )(BufferHandle \*handle) | 显示内存释放。 [更多...](#freemem) | -| ( [Mmap](#mmap) )(BufferHandle \*handle) | 显示内存映射，将内存映射到对应的进程地址空间中。 [更多...](#mmap) | -| ( [MmapYUV](#mmapyuv) )(BufferHandle \*handle, YUVDescInfo \*info) | YUV 内存映射。 [更多...](#mmapyuv) | -| ( [MmapCache](#mmapcache) )(BufferHandle \*handle) | 显示内存映射，将内存映射为 cache 内存到对应的进程地址空间中。 [更多...](#mmapcache) | -| ( [Unmap](#unmap) )(BufferHandle \*handle) | 内存反映射，将内存进行反映射。 [更多...](#unmap) | -| ( [FlushCache](#flushcache) )(BufferHandle \*handle) | 刷新cache，刷新cache里的内容到内存并且使cache里的内容无效。 [更多...](#flushcache) | -| ( [FlushMCache](#flushmcache) )(BufferHandle \*handle) | 刷新Mmap映射的cache，刷新Mmap映射的cache里的内容到内存并且使cache里的内容无效。 [更多...](#flushmcache) | -| ( [InvalidateCache](#invalidatecache) )(BufferHandle \*handle) | 使cache中的内容无效用以存储更新内存内容。 [更多...](#invalidatecache) | -| ( [IsSupportedAlloc](#issupportedalloc) )(uint32_t num, const [VerifyAllocInfo](_verify_alloc_info.md) \*infos, bool \*supporteds) | 检测给定的VerifyAllocInfo数组信息能否申请内存成功。 [更多...](#issupportedalloc) | - - -## **详细描述** - -显示内存驱动接口结构体，定义显示内存驱动接口函数指针。 +| ([AllocMem](#allocmem))(const AllocInfo \*info, BufferHandle \*\*handle) | 显示内存分配。 | +| ([FreeMem](#freemem))(BufferHandle \*handle) | 显示内存释放。 | +| ([Mmap](#mmap))(BufferHandle \*handle) | 显示内存映射，将内存映射到对应的进程地址空间中。 | +| ([MmapYUV](#mmapyuv))(BufferHandle \*handle, YUVDescInfo \*info) | YUV 内存映射。 | +| ([MmapCache](#mmapcache))(BufferHandle \*handle) | 显示内存映射，将内映射为cache内存到对应的进程地址空间中。 | +| ([Unmap](#unmap))(BufferHandle \*handle) | 内存反映射，将内存进行反映射。 | +| ([FlushCache](#flushcache))(BufferHandle \*handle) | 刷新cache，刷新cache里的内容到内存并且使cache里的内容无效。 | +| ([FlushMCache](#flushmcache))(BufferHandle \*handle) | 刷新Mmap映射的cache，刷新Mmap映射的cache里的内容到内存并且使cache里的内容无效。 | +| ([InvalidateCache](#invalidatecache))(BufferHandle \*handle) | 使cache中的内容无效用以存储更新内存内容。 | +| ([IsSupportedAlloc](#issupportedalloc))(uint32_t num, const VerifyAllocInfo \*infos, bool \*supporteds) | 检测给定的VerifyAllocInfo数组信息能否申请内存成功。 | ## **类成员变量说明** @@ -48,14 +45,14 @@ int32_t(* GrallocFuncs::AllocMem) (const AllocInfo *info, BufferHandle **handle) 根据GUI图形系统传递的参数分配内存，分配的内存根据类型可分为共享内存、cache内存和非cache内存等。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | info | 输入参数，指示申请内存AllocInfo信息. | | handle | 输入参数，指向申请的内存handle指针。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 @@ -73,13 +70,13 @@ int32_t(* GrallocFuncs::FlushCache) (BufferHandle *handle) 刷新cache，刷新cache里的内容到内存并且使cache里的内容无效。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | handle | 输出参数，待刷新cache的handle指针。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 @@ -97,13 +94,13 @@ int32_t(* GrallocFuncs::FlushMCache) (BufferHandle *handle) 刷新Mmap映射的cache，刷新Mmap映射的cache里的内容到内存并且使cache里的内容无效。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | handle | 输出参数，待刷新cache的handle指针。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 @@ -121,13 +118,13 @@ void(* GrallocFuncs::FreeMem) (BufferHandle *handle) 显示内存释放。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | handle | 输入参数，待释放的内存handle指针。 | -**返回：** +**返回:** 成功返回有效地址，失败返回NULL。 @@ -143,13 +140,13 @@ int32_t(* GrallocFuncs::InvalidateCache) (BufferHandle *handle) 使cache中的内容无效用以存储更新内存内容。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | handle | 输出参数，待无效cache的handle指针。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 @@ -167,15 +164,15 @@ int32_t(* GrallocFuncs::IsSupportedAlloc) (uint32_t num, const VerifyAllocInfo * 检测给定的VerifyAllocInfo数组信息能否申请内存成功。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | -| num | 输入参数，VerifyAllocInfo数组个数。 | -| infos | 输出参数，VerifyAllocInfo数组首地址。 | +| num | 输入参数，[VerifyAllocInfo](_verify_alloc_info.md)数组个数。 | +| infos | 输出参数，[VerifyAllocInfo](_verify_alloc_info.md)数组首地址。 | | supporteds | 输出参数，supporteds数组首地址, 表示能否申请成功。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 @@ -193,13 +190,13 @@ void*(* GrallocFuncs::Mmap) (BufferHandle *handle) 显示内存映射，将内存映射到对应的进程地址空间中。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | handle | 输入参数，待映射内存handle指针。 | -**返回：** +**返回:** 成功返回有效地址，失败返回NULL。 @@ -215,13 +212,13 @@ void*(* GrallocFuncs::MmapCache) (BufferHandle *handle) 显示内存映射，将内存映射为 cache 内存到对应的进程地址空间中。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | handle | 输出参数，待映射内存 handle 指针。 | -**返回：** +**返回:** 成功返回有效地址，失败返回 NULL。 @@ -237,14 +234,14 @@ void*(* GrallocFuncs::MmapYUV) (BufferHandle *handle, YUVDescInfo *info) YUV 内存映射。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | handle | 输出参数，指示内存映射的输出缓存。 | -| info | 输出参数，指示内存映射的YUVDescInfo信息。 | +| info | 输出参数，指示内存映射的[YUVDescInfo](_yun_desc_info_.md)信息。 | -**返回：** +**返回:** 成功返回有效地址，失败返回 NULL。 @@ -260,13 +257,13 @@ int32_t(* GrallocFuncs::Unmap) (BufferHandle *handle) 内存反映射，将内存进行反映射。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | handle | 输出参数，待反映射内存handle指针。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_h_d_r_capability.md b/zh-cn/device-dev/reference/hdi-apis/_h_d_r_capability.md index 08d19bbbbfe355000de3b0421183a4a8f1eb73da..a82e3058421ea0160df98b4cfcadb2c127dbf3ea 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_h_d_r_capability.md +++ b/zh-cn/device-dev/reference/hdi-apis/_h_d_r_capability.md @@ -3,7 +3,9 @@ ## **概述** -**所属模块:** +HDR属性结构体定义。 + +**相关模块:** [Display](_display.md) @@ -13,15 +15,10 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | | [formatCount](_display.md#formatcount) | 支持的HDR格式的数量 | | [formats](_display.md#formats) | 支持的HDR格式的数组首地址 | | [maxLum](_display.md#maxlum) | 最大的光亮度luminance值 | | [maxAverageLum](_display.md#maxaveragelum) | 最大的平均光亮度luminance值 | | [minLum](_display.md#minlum) | 最小的光亮度luminance值 | - - -## **详细描述** - -HDR属性结构体定义。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_h_d_r_meta_data.md b/zh-cn/device-dev/reference/hdi-apis/_h_d_r_meta_data.md index d20665318f9555957e07bac0617c2f65e6f5586f..44610a551845f6df58cf94c74cf994c9dcd40e27 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_h_d_r_meta_data.md +++ b/zh-cn/device-dev/reference/hdi-apis/_h_d_r_meta_data.md @@ -3,7 +3,9 @@ ## **概述** -**所属模块:** +HDR元数据结构体定义。 + +**相关模块:** [Display](_display.md) @@ -13,12 +15,7 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | | [key](_display.md#key) | HDR元数据关键字。 | | [value](_display.md#value-22) | 关键字对应的值。 | - - -## **详细描述** - -HDR元数据结构体定义。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_hdf_face_auth.md b/zh-cn/device-dev/reference/hdi-apis/_hdf_face_auth.md index 742e19ca1cb15f5562d8a22f65651c69e2250123..7ef609b97adf64a1cc7546e0e84012a6a6ce0f0b 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_hdf_face_auth.md +++ b/zh-cn/device-dev/reference/hdi-apis/_hdf_face_auth.md @@ -1,12 +1,23 @@ # HdfFaceAuth +## **概述** + +提供人脸认证驱动的标准API接口。 + +人脸认证驱动为人脸认证服务提供统一的访问接口。获取人脸认证驱动代理后，人脸认证服务可以调用相关接口获取执行器，获取人脸认证执行器后， 人脸认证服务可以调用相关接口获取执行器，获取凭据模版信息，注册人脸特征模版，进行用户人脸认证，删除人脸特征模版等。 + +**Since：** + +3.2 + + ## **汇总** ### 文件 - | 文件 | 描述 | + | 名称 | 描述 | | -------- | -------- | | [FaceAuthTypes.idl](_face_auth_types_8idl.md) | 定义人脸认证驱动的枚举类和数据结构。 | | [IExecutor.idl](face__auth_2_i_executor_8idl.md) | 定义执行器接口，用于获取执行器，获取凭据模版信息，注册人脸特征模版，进行用户人脸认证，删除人脸特征模版等。 | @@ -16,44 +27,33 @@ ### 类 - | 类 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [ExecutorInfo](_executor_info.md) | 执行器信息。 [更多...](_executor_info.md) | -| [TemplateInfo](_template_info.md) | 凭据模版信息。 [更多...](_template_info.md) | -| [IExecutor](interface_i_executor.md) | 定义执行器接口，用于获取执行器，获取凭据模版信息，注册人脸特征模版，进行用户人脸认证，删除人脸特征模版等。 [更多...](interface_i_executor.md) | -| [IExecutorCallback](interface_i_executor_callback.md) | 定义异步API接口回调，用于返回异步接口的请求处理结果和信息。使用细节见[IExecutor](interface_i_executor.md)。 [更多...](interface_i_executor_callback.md) | -| [IFaceAuthInterface](interface_i_face_auth_interface.md) | 定义获取人脸认证驱动的执行器列表接口。 [更多...](interface_i_face_auth_interface.md) | +| [ExecutorInfo](_executor_info.md) | 执行器信息。 | +| [TemplateInfo](_template_info.md) | 凭据模版信息。 | +| [IExecutor](interface_i_executor.md) | 定义执行器接口，用于获取执行器，获取凭据模版信息，注册人脸特征模版，进行用户人脸认证，删除人脸特征模版等。 | +| [IExecutorCallback](interface_i_executor_callback.md) | 定义异步API接口回调，用于返回异步接口的请求处理结果和信息。使用细节见[IExecutor](interface_i_executor.md)。 | +| [IFaceAuthInterface](interface_i_face_auth_interface.md) | 定义获取人脸认证驱动的执行器列表接口。 | ### 枚举 - | 枚举 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [AuthType](#authtype) : int { PIN = 1, FACE = 2, FINGERPRINT = 4 } | 枚举用户认证凭据类型。 [更多...](#authtype) | -| [ExecutorRole](#executorrole) : int { COLLECTOR = 1, VERIFIER = 2, ALL_IN_ONE = 3 } | 枚举执行器角色。 [更多...](#executorrole) | -| [ExecutorSecureLevel](#executorsecurelevel) : int { ESL0 = 0, ESL1 = 1, ESL2 = 2, ESL3 = 3 } | 枚举执行器安全等级。 [更多...](#executorsecurelevel) | -| [CommandId](#commandid) : int { LOCK_TEMPLATE = 1, UNLOCK_TEMPLATE = 2, VENDOR_COMMAND_BEGIN = 10000 } | 枚举人脸认证功能相关操作命令。 [更多...](#commandid) | -| [FaceTipsCode](#facetipscode) : int { FACE_AUTH_TIP_TOO_BRIGHT = 1, FACE_AUTH_TIP_TOO_DARK = 2, FACE_AUTH_TIP_TOO_CLOSE = 3, FACE_AUTH_TIP_TOO_FAR = 4,   FACE_AUTH_TIP_TOO_HIGH = 5, FACE_AUTH_TIP_TOO_LOW = 6, FACE_AUTH_TIP_TOO_RIGHT = 7, FACE_AUTH_TIP_TOO_LEFT = 8,   FACE_AUTH_TIP_TOO_MUCH_MOTION = 9, FACE_AUTH_TIP_POOR_GAZE = 10, FACE_AUTH_TIP_NOT_DETECTED = 11, VENDOR_FACE_AUTH_TIP_BEGIN = 10000 } | 枚举提示信息编码。 [更多...](#facetipscode) | +| [AuthType](#authtype): int { PIN = 1, FACE = 2, FINGERPRINT = 4 } | 枚举用户认证凭据类型。 | +| [ExecutorRole](#executorrole): int { COLLECTOR = 1, VERIFIER = 2, ALL_IN_ONE = 3 } | 枚举执行器角色。 | +| [ExecutorSecureLevel](#executorsecurelevel): int { ESL0 = 0, ESL1 = 1, ESL2 = 2, ESL3 = 3 } | 枚举执行器安全等级。 | +| [CommandId](#commandid): int { LOCK_TEMPLATE = 1, UNLOCK_TEMPLATE = 2, VENDOR_COMMAND_BEGIN = 10000 } | 枚举人脸认证功能相关操作命令。 | +| [FaceTipsCode](#facetipscode): int { FACE_AUTH_TIP_TOO_BRIGHT = 1, FACE_AUTH_TIP_TOO_DARK = 2, FACE_AUTH_TIP_TOO_CLOSE = 3, FACE_AUTH_TIP_TOO_FAR = 4,   FACE_AUTH_TIP_TOO_HIGH = 5, FACE_AUTH_TIP_TOO_LOW = 6, FACE_AUTH_TIP_TOO_RIGHT = 7, FACE_AUTH_TIP_TOO_LEFT = 8,   FACE_AUTH_TIP_TOO_MUCH_MOTION = 9, FACE_AUTH_TIP_POOR_GAZE = 10, FACE_AUTH_TIP_NOT_DETECTED = 11, VENDOR_FACE_AUTH_TIP_BEGIN = 10000 } | 枚举提示信息编码。 | -### 变量 +### 关键字 - | 变量 名称 | 描述 | + | 名称 | 描述 | | -------- | -------- | | package ohos.hdi.face_auth.v1_0 | 人脸认证接口的包路径 | -## **详细描述** - -提供人脸认证驱动的标准API接口。 - -人脸认证驱动为人脸认证服务提供统一的访问接口。获取人脸认证驱动代理后，人脸认证服务可以调用相关接口获取执行器，获取人脸认证执行器后， 人脸认证服务可以调用相关接口获取执行器，获取凭据模版信息，注册人脸特征模版，进行用户人脸认证，删除人脸特征模版等。 - -**Since：** - -3.2 - - ## **枚举类型说明** diff --git a/zh-cn/device-dev/reference/hdi-apis/_hdf_feature_info.md b/zh-cn/device-dev/reference/hdi-apis/_hdf_feature_info.md new file mode 100644 index 0000000000000000000000000000000000000000..a70f0222d87c4633abcb243913540b3fd9b6fb97 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_hdf_feature_info.md @@ -0,0 +1,48 @@ +# HdfFeatureInfo + + +## **概述** + +feature对象信息。 + +**相关模块:** + +[WLAN](wlan.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [ifName](#ifname) | feature对象的网卡名称。 | +| [type](#type) | feature对象的类型。 | + + +## **类成员变量说明** + + +### ifName + + +``` +String HdfFeatureInfo::ifName +``` + +**描述：** + +feature对象的网卡名称。 + + +### type + + +``` +int HdfFeatureInfo::type +``` + +**描述：** + +feature对象的类型。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_hdf_light_color.md b/zh-cn/device-dev/reference/hdi-apis/_hdf_light_color.md new file mode 100644 index 0000000000000000000000000000000000000000..6dc7205e01de6bb66bf73bb9eebbf8c8737a0efc --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_hdf_light_color.md @@ -0,0 +1,37 @@ +# HdfLightColor + + +## **概述** + +定义亮灯参数。 + +参数包括灯的模式设置。 + +**相关模块:** + +[Light](light.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [colorValue](#colorvalue) | 设置灯的模式 | + + +## **类成员变量说明** + + +### colorValue + + +``` +union ColorValue HdfLightColor::colorValue +``` + +**描述：** + +设置灯的模式, 详见[ColorValue](union_color_value.md)。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_hdf_light_effect.md b/zh-cn/device-dev/reference/hdi-apis/_hdf_light_effect.md new file mode 100644 index 0000000000000000000000000000000000000000..341b2fb7f29860c5bd48a843f233b9b22516cf16 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_hdf_light_effect.md @@ -0,0 +1,50 @@ +# HdfLightEffect + + +## **概述** + +定义灯的效果参数。 + +参数包括设置灯的亮度、闪烁模式。 + +**相关模块:** + +[Light](light.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [lightBrightness](#lightbrightness) | 亮度值。 | +| [flashEffect](#flasheffect) | 闪烁模式。 | + + +## **类成员变量说明** + + +### flashEffect + + +``` +struct HdfLightFlashEffect HdfLightEffect::flashEffect +``` + +**描述：** + +闪烁模式。详见**[HdfLightFlashEffect](_hdf_light_flash_effect.md)**。 + + +### lightBrightness + + +``` +int HdfLightEffect::lightBrightness +``` + +**描述：** + +亮度值：Bits 24–31为扩展位，Bits 16–23为红色，Bits 8–15为绿色，Bits 0–7为蓝色。 如果字节段等于0时，灯的亮度根据HCS配置的默认亮度进行设置。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_hdf_light_flash_effect.md b/zh-cn/device-dev/reference/hdi-apis/_hdf_light_flash_effect.md new file mode 100644 index 0000000000000000000000000000000000000000..2d853ebaab83a9eed7c4fe87c32e706da4c0b38a --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_hdf_light_flash_effect.md @@ -0,0 +1,63 @@ +# HdfLightFlashEffect + + +## **概述** + +定义灯的闪烁参数。 + +这些参数包括闪烁模式以及闪烁期间指示灯的打开和关闭时间。 + +**相关模块:** + +[Light](light.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [flashMode](#flashmode) | 闪烁模式。 | +| [onTime](#ontime) | 表示在一个闪烁周期内灯持续点亮的时间，单位毫秒。 | +| [offTime](#offtime) | 表示在一个闪烁周期内灯持续熄灭的时间，单位毫秒。 | + + +## **类成员变量说明** + + +### flashMode + + +``` +int HdfLightFlashEffect::flashMode +``` + +**描述：** + +闪烁模式。详见[HdfLightFlashMode](light.md#hdflightflashmode)。 + + +### offTime + + +``` +int HdfLightFlashEffect::offTime +``` + +**描述：** + +表示在一个闪烁周期内灯持续熄灭的时间，单位毫秒。 + + +### onTime + + +``` +int HdfLightFlashEffect::onTime +``` + +**描述：** + +表示在一个闪烁周期内灯持续点亮的时间，单位毫秒。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_hdf_light_info.md b/zh-cn/device-dev/reference/hdi-apis/_hdf_light_info.md new file mode 100644 index 0000000000000000000000000000000000000000..8674b13b2368719c859becac7cc845613fbfc560 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_hdf_light_info.md @@ -0,0 +1,76 @@ +# HdfLightInfo + + +## **概述** + +定义灯的基本信息。 + +参数包括灯类型ID、逻辑灯的名称、逻辑控制器中物理灯的数量和自定义扩展信息。 + +**相关模块:** + +[Light](light.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [lightName](#lightname) | 逻辑灯的名称。 | +| [lightId](#lightid) | 灯类型ID。 | +| [lightNumber](#lightnumber) | 逻辑控制器中物理灯的数量。 | +| [reserved](#reserved) | 自定义扩展信息。 | + + +## **类成员变量说明** + + +### lightId + + +``` +int HdfLightInfo::lightId +``` + +**描述：** + +灯类型ID。详见[HdfLightId](light.md#hdflightid)。 + + +### lightName + + +``` +String HdfLightInfo::lightName +``` + +**描述：** + +逻辑灯的名称。 + + +### lightNumber + + +``` +int HdfLightInfo::lightNumber +``` + +**描述：** + +逻辑控制器中物理灯的数量。 + + +### reserved + + +``` +int HdfLightInfo::reserved +``` + +**描述：** + +自定义扩展信息。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_hdf_motion_event.md b/zh-cn/device-dev/reference/hdi-apis/_hdf_motion_event.md new file mode 100644 index 0000000000000000000000000000000000000000..cdf6b6de73a224d141a63e61054f03cb318f0c1c --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_hdf_motion_event.md @@ -0,0 +1,89 @@ +# HdfMotionEvent + + +## **概述** + +上报手势识别数据结构。 + +上报手势识别数据事件信息包括手势识别类型、手势识别结果、手势识别状态、手势识别数据长度、手势识别数据。 + +**相关模块:** + +[Motion](motion.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [motion](#motion) | 手势识别类型。 | +| [result](#result) | 手势识别结果。 | +| [status](#status) | 手势识别状态。 | +| [datalen](#datalen) | 手势识别数据长度。 | +| [data](#data) | 手势识别数据。 | + + +## **类成员变量说明** + + +### data + + +``` +int [] HdfMotionEvent::data +``` + +**描述：** + +手势识别数据。 + + +### datalen + + +``` +int HdfMotionEvent::datalen +``` + +**描述：** + +手势识别数据长度。 + + +### motion + + +``` +int HdfMotionEvent::motion +``` + +**描述：** + +手势识别类型。 + + +### result + + +``` +int HdfMotionEvent::result +``` + +**描述：** + +手势识别结果。 + + +### status + + +``` +int HdfMotionEvent::status +``` + +**描述：** + +手势识别状态。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_hdf_net_device_info.md b/zh-cn/device-dev/reference/hdi-apis/_hdf_net_device_info.md new file mode 100644 index 0000000000000000000000000000000000000000..c865bc30d915523c671a2979d1f10d2b1417c9b5 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_hdf_net_device_info.md @@ -0,0 +1,87 @@ +# HdfNetDeviceInfo + + +## **概述** + +网络设备信息。 + +**相关模块:** + +[WLAN](wlan.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [index](#index) | 网络设备索引。 | +| [ifName](#ifname) | 网卡名称。 | +| [ifNameLen](#ifnamelen) | 网卡名称长度。 | +| [iftype](#iftype) | 网卡类型。 | +| [mac](#mac) | 网络设备MAC地址。 | + + +## **类成员变量说明** + + +### ifName + + +``` +String HdfNetDeviceInfo::ifName +``` + +**描述：** + +网卡名称。 + + +### ifNameLen + + +``` +unsigned int HdfNetDeviceInfo::ifNameLen +``` + +**描述：** + +网卡名称长度。 + + +### iftype + + +``` +unsigned char HdfNetDeviceInfo::iftype +``` + +**描述：** + +网卡类型。 + + +### index + + +``` +unsigned int HdfNetDeviceInfo::index +``` + +**描述：** + +网络设备索引。 + + +### mac + + +``` +unsigned char [] HdfNetDeviceInfo::mac +``` + +**描述：** + +网络设备MAC地址。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_hdf_net_device_info_result.md b/zh-cn/device-dev/reference/hdi-apis/_hdf_net_device_info_result.md new file mode 100644 index 0000000000000000000000000000000000000000..d48f209f60a14cc68c2e966173192a5018b49d5a --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_hdf_net_device_info_result.md @@ -0,0 +1,35 @@ +# HdfNetDeviceInfoResult + + +## **概述** + +网络设备信息集合。 + +**相关模块:** + +[WLAN](wlan.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [deviceInfos](#deviceinfos) | 网络设备信息集合。 | + + +## **类成员变量说明** + + +### deviceInfos + + +``` +struct HdfNetDeviceInfo [] HdfNetDeviceInfoResult::deviceInfos +``` + +**描述：** + +网络设备信息集合。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_hdf_pin_auth.md b/zh-cn/device-dev/reference/hdi-apis/_hdf_pin_auth.md index 10de6c4064d9b27e522693a9d859d5a097d1e85f..b5a0a2ce3457fe5f5a1208b51d0cf9d3933efa5f 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_hdf_pin_auth.md +++ b/zh-cn/device-dev/reference/hdi-apis/_hdf_pin_auth.md @@ -1,12 +1,23 @@ # HdfPinAuth +## **概述** + +提供口令认证驱动的标准API接口。 + +口令认证驱动为口令认证服务提供统一的访问接口。获取口令认证驱动代理后，口令认证服务可以调用相关接口获取执行器，获取口令认证执行器后， 口令认证服务可以调用相关接口获取执行器信息，获取凭据模版信息，注册口令，认证口令，删除口令等。 + +**Since：** + +3.2 + + ## **汇总** ### 文件 - | 文件 | 描述 | + | 名称 | 描述 | | -------- | -------- | | [IExecutor.idl](pin__auth_2_i_executor_8idl.md) | 定义执行器标准API接口。接口可用于获取执行器信息，获取凭据模版信息，注册口令，认证口令，删除口令等。 | | [IExecutorCallback.idl](pin__auth_2_i_executor_callback_8idl.md) | 定义异步API接口回调，用于返回异步接口的请求处理结果和获取信息。 | @@ -16,43 +27,32 @@ ### 类 - | 类 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [IExecutor](interface_pin_i_executor.md) | 定义执行器标准API接口。接口可用于获取执行器信息，获取凭据模版信息，注册口令，认证口令，删除口令等。[更多...](interface_pin_i_executor.md) | -| [IExecutorCallback](interface_pin_i_executor_callback.md) | 定义异步API接口回调，用于返回异步接口的请求处理结果和信息。使用细节见[IExecutor](interface_pin_i_executor.md)。 [更多...](interface_pin_i_executor_callback.md) | -| [IPinAuthInterface](interface_i_pin_auth_interface.md) | 定义获取口令认证驱动的执行器列表接口。 [更多...](interface_i_pin_auth_interface.md) | -| [ExecutorInfo](_executor_info.md) | 执行器信息。 [更多...](_executor_info.md) | -| [TemplateInfo](_template_info.md) | 凭据模版信息。 [更多...](_template_info.md) | +| [IExecutor](interface_pin_i_executor.md) | 定义执行器标准API接口。接口可用于获取执行器信息，获取凭据模版信息，注册口令，认证口令，删除口令等。 | +| [IExecutorCallback](interface_pin_i_executor_callback.md) | 定义异步API接口回调，用于返回异步接口的请求处理结果和信息。使用细节见[IExecutor](interface_pin_i_executor.md)。 | +| [IPinAuthInterface](interface_i_pin_auth_interface.md) | 定义获取口令认证驱动的执行器列表接口。 | +| [ExecutorInfo](_executor_info.md) | 执行器信息。 | +| [TemplateInfo](_template_info.md) | 凭据模版信息。 | ### 枚举 - | 枚举 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [AuthType](#authtype) : int {   PIN = 1, FACE = 2, FINGERPRINT = 4 } | 枚举用户认证凭据类型。 [更多...](#authtype) | -| [ExecutorRole](#executorrole) : int {   COLLECTOR = 1, VERIFIER = 2, ALL_IN_ONE = 3 } | 枚举执行器角色。 [更多...](#executorrole) | -| [ExecutorSecureLevel](#executorsecurelevel) : int {   ESL0 = 0, ESL1 = 1, ESL2 = 2, ESL3 = 3 } | 枚举执行器安全等级。 [更多...](#executorsecurelevel) | -| [CommandId](#commandid) : int { DEFAULT = 0 } | 枚举口令认证相关功能操作命令。 [更多...](#commandid) | +| [AuthType](#authtype): int {   PIN = 1, FACE = 2, FINGERPRINT = 4 } | 枚举用户认证凭据类型。 | +| [ExecutorRole](#executorrole): int {   COLLECTOR = 1, VERIFIER = 2, ALL_IN_ONE = 3 } | 枚举执行器角色。 | +| [ExecutorSecureLevel](#executorsecurelevel): int {   ESL0 = 0, ESL1 = 1, ESL2 = 2, ESL3 = 3 } | 枚举执行器安全等级。 | +| [CommandId](#commandid): int { DEFAULT = 0 } | 枚举口令认证相关功能操作命令。 | -### 变量 +### 关键字 - | 变量 名称 | 描述 | + | 名称 | 描述 | | -------- | -------- | | package ohos.hdi.pin_auth.v1_0 | 口令认证接口的包路径 | -## **详细描述** - -提供口令认证驱动的标准API接口。 - -口令认证驱动为口令认证服务提供统一的访问接口。获取口令认证驱动代理后，口令认证服务可以调用相关接口获取执行器，获取口令认证执行器后， 口令认证服务可以调用相关接口获取执行器信息，获取凭据模版信息，注册口令，认证口令，删除口令等。 - -**Since：** - -3.2 - - ## **枚举类型说明** diff --git a/zh-cn/device-dev/reference/hdi-apis/_hdf_sensor_events.md b/zh-cn/device-dev/reference/hdi-apis/_hdf_sensor_events.md new file mode 100644 index 0000000000000000000000000000000000000000..e736441a261b43df836741365219889894a43d75 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_hdf_sensor_events.md @@ -0,0 +1,115 @@ +# HdfSensorEvents + + +## **概述** + +定义传感器上报的数据。 + +上报的传感器数据包括传感器ID、传感器算法版本号、数据生成时间、传感器类型ID、 数据选项（如测量范围和精度）、数据上报模式、数据地址、数据长度。 + +**相关模块:** + +[Sensor](sensor.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [sensorId](#sensorid) | 传感器ID。 | +| [version](#version) | 传感器算法版本号。 | +| [timestamp](#timestamp) | 传感器数据生成时间。 | +| [option](#option) | 传感器数据选项，包括测量范围和精度。 | +| [mode](#mode) | 传感器数据上报模式。 | +| [data](#data) | 传感器数据地址。 | +| [dataLen](#datalen) | 传感器数据长度。 | + + +## **类成员变量说明** + + +### data + + +``` +unsigned char [] HdfSensorEvents::data +``` + +**描述：** + +传感器数据地址。 + + +### dataLen + + +``` +unsigned int HdfSensorEvents::dataLen +``` + +**描述：** + +传感器数据长度。 + + +### mode + + +``` +int HdfSensorEvents::mode +``` + +**描述：** + +传感器数据上报模式。 + + +### option + + +``` +unsigned int HdfSensorEvents::option +``` + +**描述：** + +传感器数据选项，包括测量范围和精度。 + + +### sensorId + + +``` +int HdfSensorEvents::sensorId +``` + +**描述：** + +传感器ID。 + + +### timestamp + + +``` +long HdfSensorEvents::timestamp +``` + +**描述：** + +传感器数据生成时间。 + + +### version + + +``` +int HdfSensorEvents::version +``` + +**描述：** + +传感器算法版本号。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_hdf_sensor_information.md b/zh-cn/device-dev/reference/hdi-apis/_hdf_sensor_information.md new file mode 100644 index 0000000000000000000000000000000000000000..ae9c37c451081576d74ad35cd807c07f9f82c80a --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_hdf_sensor_information.md @@ -0,0 +1,141 @@ +# HdfSensorInformation + + +## **概述** + +定义传感器的基本信息。 + +传感器的信息包括传感器名称、供应商、固件版本、硬件版本、传感器类型ID、传感器ID、最大测量范围、精度和功率。 + +**相关模块:** + +[Sensor](sensor.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [sensorName](#sensorname) | 传感器名称。 | +| [vendorName](#vendorname) | 传感器供应商。 | +| [firmwareVersion](#firmwareversion) | 传感器固件版本。 | +| [hardwareVersion](#hardwareversion) | 传感器硬件版本。 | +| [sensorTypeId](#sensortypeid) | 传感器类型ID。 | +| [sensorId](#sensorid) | 传感器ID，由传感器驱动程序开发人员定义。 | +| [maxRange](#maxrange) | 传感器的最大测量范围。 | +| [accuracy](#accuracy) | 传感器精度。 | +| [power](#power) | 传感器功率。 | + + +## **类成员变量说明** + + +### accuracy + + +``` +float HdfSensorInformation::accuracy +``` + +**描述：** + +传感器精度。 + + +### firmwareVersion + + +``` +String HdfSensorInformation::firmwareVersion +``` + +**描述：** + +传感器固件版本。 + + +### hardwareVersion + + +``` +String HdfSensorInformation::hardwareVersion +``` + +**描述：** + +传感器硬件版本。 + + +### maxRange + + +``` +float HdfSensorInformation::maxRange +``` + +**描述：** + +传感器的最大测量范围。 + + +### power + + +``` +float HdfSensorInformation::power +``` + +**描述：** + +传感器功率。 + + +### sensorId + + +``` +int HdfSensorInformation::sensorId +``` + +**描述：** + +传感器ID，由传感器驱动程序开发人员定义。 + + +### sensorName + + +``` +String HdfSensorInformation::sensorName +``` + +**描述：** + +传感器名称。 + + +### sensorTypeId + + +``` +int HdfSensorInformation::sensorTypeId +``` + +**描述：** + +传感器类型ID（在[HdfSensorTypeTag](sensor.md#hdfsensortypetag)中描述）**。** + + +### vendorName + + +``` +String HdfSensorInformation::vendorName +``` + +**描述：** + +传感器供应商。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_hdf_sta_info.md b/zh-cn/device-dev/reference/hdi-apis/_hdf_sta_info.md new file mode 100644 index 0000000000000000000000000000000000000000..05d24dd843d57a33be7655c3d921bd681b4a36e9 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_hdf_sta_info.md @@ -0,0 +1,35 @@ +# HdfStaInfo + + +## **概述** + +STA的信息。 + +**相关模块:** + +[WLAN](wlan.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [mac](#mac) | STA的MAC地址。 | + + +## **类成员变量说明** + + +### mac + + +``` +unsigned char [] HdfStaInfo::mac +``` + +**描述：** + +STA的MAC地址。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_hdf_thermal_callback_info.md b/zh-cn/device-dev/reference/hdi-apis/_hdf_thermal_callback_info.md index 5652e991ce997a3b1c53d18467dc185f278e806d..ba1f6fd2b244795392c49f9bd994bc27fb3298c2 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_hdf_thermal_callback_info.md +++ b/zh-cn/device-dev/reference/hdi-apis/_hdf_thermal_callback_info.md @@ -3,7 +3,9 @@ ## **概述** -**所属模块:** +设备发热的信息列表。 + +**相关模块:** [Thermal](thermal.md) @@ -13,16 +15,11 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | | [info](#info) | 设备发热的信息列表。 | -## **详细描述** - -设备发热的信息列表。 - - ## **类成员变量说明** diff --git a/zh-cn/device-dev/reference/hdi-apis/_hdf_user_auth.md b/zh-cn/device-dev/reference/hdi-apis/_hdf_user_auth.md index abdbc3ced7dfeafaf2c4892d213017fd87642005..2fbbca3bfa3acb1cfe8f629664d9347ab8386d2e 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_hdf_user_auth.md +++ b/zh-cn/device-dev/reference/hdi-apis/_hdf_user_auth.md @@ -1,12 +1,23 @@ # HdfUserAuth +## **概述** + +提供用户认证驱动的标准API接口。 + +用户认证驱动为用户认证服务提供统一的访问接口。获取用户认证驱动代理后，用户认证服务可以调用相关接口注册执行器，管理用户认证凭据， 完成PIN码和生物特征。 + +**Since：** + +3.2 + + ## **汇总** ### 文件 - | 文件 | 描述 | + | 名称 | 描述 | | -------- | -------- | | [IUserAuthInterface.idl](_i_user_auth_interface_8idl.md) | 声明用户认证驱动的API接口。接口可用于注册执行器，管理用户认证凭据，完成PIN码和生物特征认证。 | | [UserAuthTypes.idl](_user_auth_types_8idl.md) | 定义用户认证驱动的枚举类和数据结构。 | @@ -14,49 +25,39 @@ ### 类 - | 类 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [IUserAuthInterface](interface_i_user_auth_interface.md) | 声明用户认证驱动的API接口。 [更多...](interface_i_user_auth_interface.md) | -| [ExecutorRegisterInfo](_executor_register_info.md) | 执行器注册信息。 [更多...](_executor_register_info.md) | -| [ExecutorInfo](_user_executor_info.md) | 执行器信息。 [更多...](_user_executor_info.md) | -| [ScheduleInfo](_schedule_info.md) | 调度信息。 [更多...](_schedule_info.md) | -| [AuthSolution](_auth_solution.md) | 认证方案。 [更多...](_auth_solution.md) | -| [ExecutorSendMsg](_executor_send_msg.md) | 执行器发送的消息。 [更多...](_executor_send_msg.md) | -| [AuthResultInfo](_auth_result_info.md) | 用户身份认证结果信息。 [更多...](_auth_result_info.md) | -| [IdentifyResultInfo](_identify_result_info.md) | 用户身份识别结果信息。 [更多...](_identify_result_info.md) | -| [EnrollParam](_enroll_param.md) | 注册认证凭据参数。 [更多...](_enroll_param.md) | -| [CredentialInfo](_credential_info.md) | 认证凭据信息。 [更多...](_credential_info.md) | -| [EnrolledInfo](_enrolled_info.md) | 注册信息。 [更多...](_enrolled_info.md) | +| [IUserAuthInterface](interface_i_user_auth_interface.md) | 声明用户认证驱动的API接口。 | +| [ExecutorRegisterInfo](_executor_register_info.md) | 执行器注册信息。 | +| [ExecutorInfo](_user_executor_info.md) | 执行器信息。 | +| [ScheduleInfo](_schedule_info.md) | 调度信息。 | +| [AuthSolution](_auth_solution.md) | 认证方案。 | +| [ExecutorSendMsg](_executor_send_msg.md) | 执行器发送的消息。 | +| [AuthResultInfo](_auth_result_info.md) | 用户身份认证结果信息。 | +| [IdentifyResultInfo](_identify_result_info.md) | 用户身份识别结果信息。 | +| [EnrollParam](_enroll_param.md) | 注册认证凭据参数。 | +| [CredentialInfo](_credential_info.md) | 认证凭据信息。 | +| [EnrolledInfo](_enrolled_info.md) | 注册信息。 | +| [EnrollResultInfo](_enroll_resultinfo.md) | 录入结果信息。 | ### 枚举 - | 枚举 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [AuthType](#authtype) : int {   PIN = 1, FACE = 2, FINGERPRINT = 4, ALL = 0 } | 枚举用户认证凭据类型。 [更多...](#authtype) | -| [ExecutorRole](#executorrole) : int {   COLLECTOR = 1, VERIFIER = 2, ALL_IN_ONE = 3 } | 枚举执行器角色。 [更多...](#executorrole) | -| [ExecutorSecureLevel](#executorsecurelevel) : int {   ESL0 = 0, ESL1 = 1, ESL2 = 2, ESL3 = 3 } | 枚举执行器安全等级。 [更多...](#executorsecurelevel) | -| [PinSubType](#pinsubtype) : int {   PIN\_SIX = 10000, PIN\_NUMBER = 10001, PIN\_MIX = 10002 } | 口令认证子类型。 [更多...](#pinsubtype) | +| [AuthType](#authtype): int { PIN = 1, FACE = 2, FINGERPRINT = 4, ALL = 0 } | 枚举用户认证凭据类型。 | +| [ExecutorRole](#executorrole): int { COLLECTOR = 1, VERIFIER = 2, ALL_IN_ONE = 3 } | 枚举执行器角色。 | +| [ExecutorSecureLevel](#executorsecurelevel): int { ESL0 = 0, ESL1 = 1, ESL2 = 2, ESL3 = 3 } | 枚举执行器安全等级。 | +| [PinSubType](#pinsubtype) : int { PIN_SIX = 10000, PIN_NUMBER = 10001, PIN_MIX = 10002 } | 口令认证子类型。 | -### 变量 +### 关键字 - | 变量 | 描述 | + | 名称 | 描述 | | -------- | -------- | | package ohos.hdi.user_auth.v1_0 | 用户认证接口的包路径 | -## **详细描述** - -提供用户认证驱动的标准API接口。 - -用户认证驱动为用户认证服务提供统一的访问接口。获取用户认证驱动代理后，用户认证服务可以调用相关接口注册执行器，管理用户认证凭据， 完成PIN码和生物特征。 - -**Since：** - -3.2 - - ## **枚举类型说明** @@ -130,5 +131,5 @@ enum PinSubType : int | 枚举值 | 描述 | | -------- | -------- | | PIN_SIX | 六位口令密码。 | -| PIN_NUMBER| 数字口令密码。 | +| PIN_NUMBER | 数字口令密码。 | | PIN_MIX | 混合密码。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_hdf_vibrator_info.md b/zh-cn/device-dev/reference/hdi-apis/_hdf_vibrator_info.md new file mode 100644 index 0000000000000000000000000000000000000000..f176936bc9025a917b58ec1c130041f4ad96026a --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_hdf_vibrator_info.md @@ -0,0 +1,102 @@ +# HdfVibratorInfo + + +## **概述** + +定义马达参数。 + +参数包括设置马达振幅和频率以及振幅和频率的范围。 + +**相关模块:** + +[Vibrator](vibrator.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [isSupportIntensity](#issupportintensity) | 设置马达振幅。1表示支持，0表示不支持。 | +| [isSupportFrequency](#issupportfrequency) | 设置马达频率。1表示支持，0表示不支持。 | +| [intensityMaxValue](#intensitymaxvalue) | 最大振幅。 | +| [intensityMinValue](#intensityminvalue) | 最小振幅。 | +| [frequencyMaxValue](#frequencymaxvalue) | 最大频率。 | +| [frequencyMinValue](#frequencyminvalue) | 最小频率。 | + + +## **类成员变量说明** + + +### frequencyMaxValue + + +``` +int HdfVibratorInfo::frequencyMaxValue +``` + +**描述：** + +最大频率。 + + +### frequencyMinValue + + +``` +int HdfVibratorInfo::frequencyMinValue +``` + +**描述：** + +最小频率。 + + +### intensityMaxValue + + +``` +int HdfVibratorInfo::intensityMaxValue +``` + +**描述：** + +最大振幅。 + + +### intensityMinValue + + +``` +int HdfVibratorInfo::intensityMinValue +``` + +**描述：** + +最小振幅。 + + +### isSupportFrequency + + +``` +int HdfVibratorInfo::isSupportFrequency +``` + +**描述：** + +设置马达频率。1表示支持，0表示不支持。 + + +### isSupportIntensity + + +``` +int HdfVibratorInfo::isSupportIntensity +``` + +**描述：** + +设置马达振幅。1表示支持，0表示不支持。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_hdf_wifi_driver_scan_ssid.md b/zh-cn/device-dev/reference/hdi-apis/_hdf_wifi_driver_scan_ssid.md new file mode 100644 index 0000000000000000000000000000000000000000..7fb2e4b79eb9895f1dcba5b2ee8be56b94294721 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_hdf_wifi_driver_scan_ssid.md @@ -0,0 +1,48 @@ +# HdfWifiDriverScanSsid + + +## **概述** + +WiFi扫描参数SSID信息。 + +**相关模块:** + +[WLAN](wlan.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [ssid](#ssid) | WiFi扫描的SSID。 | +| [ssidLen](#ssidlen) | WiFi扫描的SSID长度。 | + + +## **类成员变量说明** + + +### ssid + + +``` +String HdfWifiDriverScanSsid::ssid +``` + +**描述：** + +WiFi扫描的SSID。 + + +### ssidLen + + +``` +int HdfWifiDriverScanSsid::ssidLen +``` + +**描述：** + +WiFi扫描的SSID长度。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_hdf_wifi_info.md b/zh-cn/device-dev/reference/hdi-apis/_hdf_wifi_info.md new file mode 100644 index 0000000000000000000000000000000000000000..9adcd49e7bfdfaded903d9535971b586d944b3ca --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_hdf_wifi_info.md @@ -0,0 +1,48 @@ +# HdfWifiInfo + + +## **概述** + +WiFi频段信息。 + +**相关模块:** + +[WLAN](wlan.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [band](#band) | WiFi频段。 | +| [size](#size) | WiFi频段下支持的频率个数。 | + + +## **类成员变量说明** + + +### band + + +``` +int HdfWifiInfo::band +``` + +**描述：** + +WiFi频段。 + + +### size + + +``` +unsigned int HdfWifiInfo::size +``` + +**描述：** + +WiFi频段下支持的频率个数。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_hdf_wifi_scan.md b/zh-cn/device-dev/reference/hdi-apis/_hdf_wifi_scan.md new file mode 100644 index 0000000000000000000000000000000000000000..8f86e02e5da124f5a357b345a7705d5ba83222d1 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_hdf_wifi_scan.md @@ -0,0 +1,100 @@ +# HdfWifiScan + + +## **概述** + +WiFi扫描参数。 + +**相关模块:** + +[WLAN](wlan.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [ssids](#ssids) | WiFi扫描的SSID集合。 | +| [freqs](#freqs) | WiFi扫描的频率集合。 | +| [extraIes](#extraies) | WiFi扫描请求中携带的扩展IE。 | +| [bssid](#bssid) | WiFi扫描的BSSID。 | +| [prefixSsidScanFlag](#prefixssidscanflag) | SSID扫描的前缀标志。 | +| [fastConnectFlag](#fastconnectflag) | 快速连接标志。 | + + +## **类成员变量说明** + + +### bssid + + +``` +unsigned char [] HdfWifiScan::bssid +``` + +**描述：** + +WiFi扫描的BSSID。 + + +### extraIes + + +``` +unsigned char [] HdfWifiScan::extraIes +``` + +**描述：** + +WiFi扫描请求中携带的扩展IE。 + + +### fastConnectFlag + + +``` +unsigned char HdfWifiScan::fastConnectFlag +``` + +**描述：** + +快速连接标志。 + + +### freqs + + +``` +int [] HdfWifiScan::freqs +``` + +**描述：** + +WiFi扫描的频率集合。 + + +### prefixSsidScanFlag + + +``` +unsigned char HdfWifiScan::prefixSsidScanFlag +``` + +**描述：** + +SSID扫描的前缀标志。 + + +### ssids + + +``` +struct HdfWifiDriverScanSsid [] HdfWifiScan::ssids +``` + +**描述：** + +WiFi扫描的SSID集合。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_hdf_wifi_scan_result.md b/zh-cn/device-dev/reference/hdi-apis/_hdf_wifi_scan_result.md new file mode 100644 index 0000000000000000000000000000000000000000..3c752f70abebab38485fe2885322b0644b05fad3 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_hdf_wifi_scan_result.md @@ -0,0 +1,165 @@ +# HdfWifiScanResult + + +## **概述** + +WiFi扫描结果。 + +**相关模块:** + +[WLAN](wlan.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [flags](#flags) | BSS/IBSS的标志位。 | +| [bssid](#bssid) | BSSID信息。 | +| [caps](#caps) | Capability信息字段（主机字节序排列）。 | +| [freq](#freq) | 信道频率。 | +| [beaconInt](#beaconint) | Beacon帧间隔。 | +| [qual](#qual) | 信号质量。 | +| [level](#level) | 信号强度。 | +| [age](#age) | 收到最新的Beacon或者探测响应帧数据的时间长度，单位为毫秒。 | +| [variable](#variable) | 扫描结果中的变量值。 | +| [ie](#ie) | 紧跟的Probe Response中IE字段。 | +| [beaconIe](#beaconie) | 紧跟的Beacon中IE字段。 | + + +## **类成员变量说明** + + +### age + + +``` +unsigned int HdfWifiScanResult::age +``` + +**描述：** + +收到最新的Beacon或者探测响应帧数据的时间长度，单位为毫秒。 + + +### beaconIe + + +``` +unsigned char [] HdfWifiScanResult::beaconIe +``` + +**描述：** + +紧跟的Beacon中IE字段。 + + +### beaconInt + + +``` +short HdfWifiScanResult::beaconInt +``` + +**描述：** + +Beacon帧间隔。 + + +### bssid + + +``` +unsigned char [] HdfWifiScanResult::bssid +``` + +**描述：** + +BSSID信息。 + + +### caps + + +``` +short HdfWifiScanResult::caps +``` + +**描述：** + +Capability信息字段（主机字节序排列）。 + + +### flags + + +``` +int HdfWifiScanResult::flags +``` + +**描述：** + +BSS/IBSS的标志位。 + + +### freq + + +``` +int HdfWifiScanResult::freq +``` + +**描述：** + +信道频率。 + + +### ie + + +``` +unsigned char [] HdfWifiScanResult::ie +``` + +**描述：** + +紧跟的Probe Response中IE字段。 + + +### level + + +``` +int HdfWifiScanResult::level +``` + +**描述：** + +信号强度。 + + +### qual + + +``` +int HdfWifiScanResult::qual +``` + +**描述：** + +信号质量。 + + +### variable + + +``` +unsigned char [] HdfWifiScanResult::variable +``` + +**描述：** + +扫描结果中的变量值。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_activity_changed_callback_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_i_activity_changed_callback_8idl.md new file mode 100644 index 0000000000000000000000000000000000000000..512c1de4667f228022002ae3532680b03b471cb2 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_i_activity_changed_callback_8idl.md @@ -0,0 +1,37 @@ +# IActivityChangedCallback.idl + + +## **概述** + +定义行为识别数据上报回调函数接口。 + +在行为识别用户订阅行为识别数据时需要注册这个回调函数接口的实例。 + +**Since**: + +3.2 + +**Version**: + +1.0 + +**相关模块:** + +[HdiActivityRecognition](activity_recognition.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [IActivityChangedCallback](interface_i_activity_changed_callback.md) | 定义上报行为事件的回调函数 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.activity_recognition.v1_0 | 行为识别模块接口的包路径。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_activity_interface_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_i_activity_interface_8idl.md new file mode 100644 index 0000000000000000000000000000000000000000..1115b0560274f44133152ce9dacc3ca6910f019b --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_i_activity_interface_8idl.md @@ -0,0 +1,35 @@ +# IActivityInterface.idl + + +## **概述** + +声明行为识别模块提供的API，用于获取设备支持的行为类型，订阅或取消订阅不同的行为事件，获取当前的行为事件，以及获取设备缓存的行为事件。 + +**Since**: + +3.2 + +**Version**: + +1.0 + +**相关模块:** + +[HdiActivityRecognition](activity_recognition.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [IActivityInterface](interface_i_activity_interface.md) | 定义对行为识别进行基本操作的接口。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.activity_recognition.v1_0 | 行为识别模块接口的包路径。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_battery_callback_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_i_battery_callback_8idl.md index 96897505990ce8d3b82c7a6d27b6f0f21cfb6cb5..7b87b968efd6452fef859f9392e44af4e1ff2797 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_i_battery_callback_8idl.md +++ b/zh-cn/device-dev/reference/hdi-apis/_i_battery_callback_8idl.md @@ -3,38 +3,35 @@ ## **概述** -**所属模块:** - -[Battery](battery.md) - +电池信息的回调。 -## **汇总** +电池模块为电池服务提供的订阅电池信息变化的回调。 +**Since:** -### 类 +3.1 - | 类 | 描述 | -| -------- | -------- | -| [IBatteryCallback](interface_i_battery_callback.md) | 电池信息的回调。 [更多...](interface_i_battery_callback.md) | +**Version:** +1.0 -### 变量 +**相关模块:** - | 变量 名称 | 描述 | -| -------- | -------- | -| package ohos.hdi.battery.v1_0 | 电池信息接口的包路径 | +[Battery](battery.md) -## **详细描述** +## **汇总** -电池信息的回调。 -电池模块为电池服务提供的订阅电池信息变化的回调。 +### 类 -**Since：** + | 名称 | 描述 | +| -------- | -------- | +| [IBatteryCallback](interface_i_battery_callback.md) | 电池信息的回调。 | -3.1 -**Version：** +### 关键字 -1.0 + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.battery.v1_0 | 电池模块接口的包路径 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_battery_interface_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_i_battery_interface_8idl.md index 7a4a80ad0cd4c4d46a7afd72724c1fc404b56903..662cabfcd0b933eb19f6919c278e149ffd712b34 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_i_battery_interface_8idl.md +++ b/zh-cn/device-dev/reference/hdi-apis/_i_battery_interface_8idl.md @@ -3,34 +3,35 @@ ## **概述** -**所属模块:** +获取、订阅电池信息的接口。 -[Battery](battery.md) +服务获取此模块的对象或代理后，可以调用相关的接口获取、订阅电池信息。 +**Since:** -## **汇总** +3.1 +**Version:** -### 类 +1.0 - | 类 | 描述 | -| -------- | -------- | -| [IBatteryInterface](interface_i_battery_interface.md) | 获取、订阅电池信息的接口。 [更多...](interface_i_battery_interface.md) | +**相关模块:** +[Battery](battery.md) -### 变量 - | 变量 名称 | 描述 | -| -------- | -------- | -| package ohos.hdi.battery.v1_0 | 电池信息接口的包路径 | +## **汇总** -## **详细描述** +### 类 -获取、订阅电池信息的接口。 + | 名称 | 描述 | +| -------- | -------- | +| [IBatteryInterface](interface_i_battery_interface.md) | 获取、订阅电池信息的接口。 | -服务获取此对象后，可以调用相关的接口获取、订阅电池信息。 -**Since：** +### 关键字 -3.1 + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.battery.v1_0 | 电池模块接口的包路径 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_camera_device_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_i_camera_device_8idl.md new file mode 100644 index 0000000000000000000000000000000000000000..0c641e4aeb1d2785a18aeaa78ab38c30e4c49b54 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_i_camera_device_8idl.md @@ -0,0 +1,35 @@ +# ICameraDevice.idl + + +## **概述** + +Camera设备操作接口。 + +**Since:** + +3.2 + +**Version:** + +1.0 + +**相关模块:** + +[Camera](camera.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [ICameraDevice](interface_i_camera_device.md) | 定义Camera设备基本的操作。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.camera.v1_0 | Camera设备接口的包路径。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_camera_device_callback_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_i_camera_device_callback_8idl.md new file mode 100644 index 0000000000000000000000000000000000000000..944d0a957e8a806e67b2eb1a7c3bd7dc10d40a91 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_i_camera_device_callback_8idl.md @@ -0,0 +1,35 @@ +# ICameraDeviceCallback.idl + + +## **概述** + +Camera设备的回调接口，主要包含Camera设备发生错误时和上报metadata的回调函数。 + +**Since:** + +3.2 + +**Version:** + +1.0 + +**相关模块:** + +[Camera](camera.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [ICameraDeviceCallback](interface_i_camera_device_callback.md) | 定义Camera设备回调操作。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.camera.v1_0 | Camera设备接口的包路径。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_camera_host_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_i_camera_host_8idl.md new file mode 100644 index 0000000000000000000000000000000000000000..8a2434a865bed0af4cd3ab98ca7cbc91ee15b333 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_i_camera_host_8idl.md @@ -0,0 +1,35 @@ +# ICameraHost.idl + + +## **概述** + +Camera服务的管理类，对上层提供HDI接口。 + +**Since:** + +3.2 + +**Version:** + +1.0 + +**相关模块:** + +[Camera](camera.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [ICameraHost](interface_i_camera_host.md) | 定义Camera设备功能操作。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.camera.v1_0 | Camera设备接口的包路径。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_camera_host_callback_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_i_camera_host_callback_8idl.md new file mode 100644 index 0000000000000000000000000000000000000000..c77ad0f79b94cd58cf9c658b89bbb1b8a9343616 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_i_camera_host_callback_8idl.md @@ -0,0 +1,35 @@ +# ICameraHostCallback.idl + + +## **概述** + +ICameraHost的回调接口，提供Camera设备和闪关灯状态变化的回调函数，回调函数由调用者实现。 + +**Since:** + +3.2 + +**Version:** + +1.0 + +**相关模块:** + +[Camera](camera.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [ICameraHostCallback](interface_i_camera_host_callback.md) | 定义Camera设备功能回调操作。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.camera.v1_0 | Camera设备接口的包路径。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_circle.md b/zh-cn/device-dev/reference/hdi-apis/_i_circle.md index 1bc7edaa14025dad5c55d757af5ac06dbeb04bc4..2293ef4912ae0d72e8cf9aa7ecea55cf098cde01 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_i_circle.md +++ b/zh-cn/device-dev/reference/hdi-apis/_i_circle.md @@ -3,7 +3,9 @@ ## **概述** -**所属模块:** +圆形描述结构体定义，用于硬件加速绘制圆形。 + +**相关模块:** [Display](_display.md) @@ -13,14 +15,9 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [x](_display.md#x-22) | 矩形框起始X坐标。 | -| [y](_display.md#y-22) | 矩形框起始Y坐标。 | +| [x](_display.md#x-24) | 矩形框起始X坐标。 | +| [y](_display.md#y-24) | 矩形框起始Y坐标。 | | [r](_display.md#r) | 圆的半径。 | -| [color](_display.md#color-23) | 圆的颜色。 | - - -## **详细描述** - -圆形描述结构体定义，用于硬件加速绘制圆形。 +| [color](_display.md#color-25) | 圆的颜色。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_face_auth_interface_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_i_face_auth_interface_8idl.md index 3776682000f467549f40f0f7bfb4d606a56ccb9c..9a2f845c20dafdb59bbdc5f7bba0550e9691c864 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_i_face_auth_interface_8idl.md +++ b/zh-cn/device-dev/reference/hdi-apis/_i_face_auth_interface_8idl.md @@ -3,6 +3,12 @@ ## **概述** +定义获取人脸认证驱动的执行器列表接口，用于从人脸认证驱动获取执行器对象列表。 + +**Since：** + +3.2 + **所属模块:** [HdfFaceAuth](_hdf_face_auth.md) @@ -13,22 +19,13 @@ ### 类 - | 类 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [IFaceAuthInterface](interface_i_face_auth_interface.md) | 定义获取人脸认证驱动的执行器列表接口。 [更多...](interface_i_face_auth_interface.md) | +| [IFaceAuthInterface](interface_i_face_auth_interface.md) | 定义获取人脸认证驱动的执行器列表接口。 | -### 变量 +### 关键字 - | 变量 名称 | 描述 | + | 名称 | 描述 | | -------- | -------- | | package ohos.hdi.face_auth.v1_0 | 人脸认证接口的包路径 | - - -## **详细描述** - -定义获取人脸认证驱动的执行器列表接口，用于从人脸认证驱动获取执行器对象列表。 - -**Since：** - -3.2 diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_input_interface.md b/zh-cn/device-dev/reference/hdi-apis/_i_input_interface.md index cf3f527b4fe26462524e33a0bc2e87b7a294d5e4..8c20b1df852f9663f11f9810664778f527c65541 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_i_input_interface.md +++ b/zh-cn/device-dev/reference/hdi-apis/_i_input_interface.md @@ -3,9 +3,11 @@ ## **概述** -**所属模块:** +定义用于提供Input设备驱动程序功能的接口。 + +**相关模块:** -[Input](_input.md) +[Input](input.md) ## **汇总** @@ -13,16 +15,11 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [iInputManager](#iinputmanager) | Input设备的设备管理接口。 | -| [iInputController](#iinputcontroller) | Input设备的业务控制接口。 | -| [iInputReporter](#iinputreporter) | Input设备的数据上报接口。 | - - -## **详细描述** - -定义用于提供Input设备驱动程序功能的接口。 +| [iInputManager](#iinputmanager) | Input设备的设备管理接口 | +| [iInputController](#iinputcontroller) | Input设备的业务控制接口 | +| [iInputReporter](#iinputreporter) | Input设备的数据上报接口 | ## **类成员变量说明** @@ -37,7 +34,7 @@ InputController* IInputInterface::iInputController **描述：** -Input设备的业务控制接口。 +Input设备的业务控制接口 ### iInputManager @@ -49,7 +46,7 @@ InputManager* IInputInterface::iInputManager **描述：** -Input设备的设备管理接口。 +Input设备的设备管理接口 ### iInputReporter @@ -61,4 +58,4 @@ InputReporter* IInputInterface::iInputReporter **描述：** -Input设备的数据上报接口。 +Input设备的数据上报接口 diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_light_interface_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_i_light_interface_8idl.md new file mode 100644 index 0000000000000000000000000000000000000000..aca373cfa7d9f8ce752380cdec2ec7e0466188ee --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_i_light_interface_8idl.md @@ -0,0 +1,35 @@ +# ILightInterface.idl + + +## **概述** + +定义灯模块的通用接口能力，包括获取灯类型ID、打开或关闭灯光、设置灯的亮度和闪烁模式。 + +**Since:** + +3.1 + +**Version:** + +1.0 + +**相关模块:** + +[Light](light.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [ILightInterface](interface_i_light_interface.md) | 提供灯模块基本操作接口。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.light.v1_0 | 灯模块接口的包路径。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_line.md b/zh-cn/device-dev/reference/hdi-apis/_i_line.md index ee33cb7f530956d58f511b68858c0770d7530ce6..5862171b3cf32ca39b0a60adf34cf1f13729464d 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_i_line.md +++ b/zh-cn/device-dev/reference/hdi-apis/_i_line.md @@ -3,7 +3,9 @@ ## **概述** -**所属模块:** +线条描述结构体定义，用于硬件加速绘制直线。 + +**相关模块:** [Display](_display.md) @@ -13,15 +15,10 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [x0](_display.md#x0) | 线条起点的X坐标。 | -| [y0](_display.md#y0) | 线条起点的Y坐标。 | -| [x1](_display.md#x1) | 线条终点的X坐标。 | -| [y1](_display.md#y1) | 线条终点的Y坐标。 | -| [color](_display.md#color-13) | 线条颜色。 | - - -## **详细描述** - -线条描述结构体定义，用于硬件加速绘制直线。 +| [x0](_display.md#x0-12) | 线条起点的X坐标。 | +| [y0](_display.md#y0-12) | 线条起点的Y坐标。 | +| [x1](_display.md#x1-13) | 线条终点的X坐标。 | +| [y1](_display.md#y1-13) | 线条终点的Y坐标。 | +| [color](_display.md#color-15) | 线条颜色。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_motion_callback_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_i_motion_callback_8idl.md new file mode 100644 index 0000000000000000000000000000000000000000..08483942ca8df59eb0513ecef2444a4cab4337d0 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_i_motion_callback_8idl.md @@ -0,0 +1,37 @@ +# IMotionCallback.idl + + +## **概述** + +定义上报手势识别数据回调函数接口。 + +在手势识别用户订阅手势识别数据时需要注册这个回调函数接口的实例。 + +**Since:** + +3.2 + +**Version:** + +1.0 + +**相关模块:** + +[Motion](motion.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [IMotionCallback](interface_i_motion_callback.md) | 定义上报手势识别数据回调函数。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.motion.v1_0 | 手势识别模块接口的包路径。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_motion_interface_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_i_motion_interface_8idl.md new file mode 100644 index 0000000000000000000000000000000000000000..92fd912be4c749fd3e0af1668131c13ccc2c8729 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_i_motion_interface_8idl.md @@ -0,0 +1,37 @@ +# IMotionInterface.idl + + +## **概述** + +定义使能/去使能手势识别、订阅/取消订阅手势识别数据的接口。 + +在实现拿起、翻转、摇一摇、旋转屏等手势识别功能时，需要调用此处定义的接口。 + +**Since:** + +3.2 + +**Version:** + +1.0 + +**相关模块:** + +[Motion](motion.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [IMotionInterface](interface_i_motion_interface.md) | 提供Motion设备基本控制操作接口。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.motion.v1_0 | 手势识别模块接口的包路径。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_offline_stream_operator_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_i_offline_stream_operator_8idl.md new file mode 100644 index 0000000000000000000000000000000000000000..4328c264226967bd3e8853dd2b5f9e084dea7b55 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_i_offline_stream_operator_8idl.md @@ -0,0 +1,35 @@ +# IOfflineStreamOperator.idl + + +## **概述** + +离线流的操作接口。 + +**Since:** + +3.2 + +**Version:** + +1.0 + +**相关模块:** + +[Camera](camera.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [IOfflineStreamOperator](interface_i_offline_stream_operator.md) | 定义Camera设备离线流操作。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.camera.v1_0 | Camera设备接口的包路径。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_pin_auth_interface_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_i_pin_auth_interface_8idl.md index 75007400f13eb9b00a91b8954caf233be2906ad9..4a1362ac9401a1f682c0f0ef0e61fb6cac9ecfe2 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_i_pin_auth_interface_8idl.md +++ b/zh-cn/device-dev/reference/hdi-apis/_i_pin_auth_interface_8idl.md @@ -3,6 +3,12 @@ ## **概述** +定义获取口令认证驱动的执行器列表接口，用于从口令认证驱动获取执行器对象列表。 + +**Since：** + +3.2 + **所属模块:** [HdfPinAuth](_hdf_pin_auth.md) @@ -13,22 +19,13 @@ ### 类 - | 类 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [IPinAuthInterface](interface_i_pin_auth_interface.md) | 定义获取口令认证驱动的执行器列表接口。 [更多...](interface_i_pin_auth_interface.md) | +| [IPinAuthInterface](interface_i_pin_auth_interface.md) | 定义获取口令认证驱动的执行器列表接口。 | -### 变量 +### 关键字 - | 变量 名称 | 描述 | + | 名称 | 描述 | | -------- | -------- | | package ohos.hdi.pin_auth.v1_0 | 口令认证接口的包路径 | - - -## **详细描述** - -定义获取口令认证驱动的执行器列表接口，用于从口令认证驱动获取执行器对象列表。 - -**Since：** - -3.2 diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_power_hdi_callback_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_i_power_hdi_callback_8idl.md index 58b85115424fd410feff222b777c099e50a88746..3336fcba06cf6ec28189e14c35300c7d6b3eedd2 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_i_power_hdi_callback_8idl.md +++ b/zh-cn/device-dev/reference/hdi-apis/_i_power_hdi_callback_8idl.md @@ -3,38 +3,35 @@ ## **概述** -**所属模块:** - -[Power](power.md) - +休眠/唤醒状态的回调。 -## **汇总** +电源模块为电源服务提供的订阅休眠/唤醒状态的回调。 +**Since：** -### 类 +3.1 - | 类 | 描述 | -| -------- | -------- | -| [IPowerHdiCallback](interface_i_power_hdi_callback.md) | 休眠/唤醒状态的回调。 [更多...](interface_i_power_hdi_callback.md) | +**Version:** +1.0 -### 变量 +**相关模块:** - | 变量 名称 | 描述 | -| -------- | -------- | -| package ohos.hdi.power.v1_0 | 电源接口的包路径 | +[Power](power.md) -## **详细描述** +## **汇总** -休眠/唤醒状态的回调。 -电源模块为电源服务提供的订阅休眠/唤醒状态的回调。 +### 类 -**Since：** + | 名称 | 描述 | +| -------- | -------- | +| [IPowerHdiCallback](interface_i_power_hdi_callback.md) | 休眠/唤醒状态的回调。 | -3.1 -**Version：** +### 关键字 -1.0 + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.power.v1_0 | 电源模块接口的包路径。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_power_interface_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_i_power_interface_8idl.md index b6899c701f1f7919e937b3f9e7e86e7693e13fe2..dc9da2e90b44e572eece17d102853495bb91e7a2 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_i_power_interface_8idl.md +++ b/zh-cn/device-dev/reference/hdi-apis/_i_power_interface_8idl.md @@ -3,38 +3,35 @@ ## **概述** -**所属模块:** - -[Power](power.md) - +休眠/唤醒操作、订阅休眠/唤醒状态、运行锁管理的接口。 -## **汇总** +电源模块为电源服务提供休眠/唤醒操作、订阅休眠/唤醒状态和运行锁管理的接口。 +**Since：** -### 类 +3.1 - | 类 | 描述 | -| -------- | -------- | -| [IPowerInterface](interface_i_power_interface.md) | 休眠/唤醒操作、订阅休眠/唤醒状态、运行锁管理的接口。 [更多...](interface_i_power_interface.md) | +**Version:** +1.0 -### 变量 +**相关模块:** - | 变量 名称 | 描述 | -| -------- | -------- | -| package ohos.hdi.power.v1_0 | 电源接口的包路径 | +[Power](power.md) -## **详细描述** +## **汇总** -休眠/唤醒操作、订阅休眠/唤醒状态、运行锁管理的接口。 -电源模块为电源服务提供休眠/唤醒操作、订阅休眠/唤醒状态和运行锁管理的接口。 +### 类 -**Since：** + | 名称 | 描述 | +| -------- | -------- | +| [IPowerInterface](interface_i_power_interface.md) | 休眠/唤醒操作、订阅休眠/唤醒状态、运行锁管理的接口。 | -3.1 -**Version：** +### 关键字 -1.0 + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.power.v1_0 | 电源模块接口的包路径。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_rect.md b/zh-cn/device-dev/reference/hdi-apis/_i_rect.md index f2b8f481e4ebb1800008d7ccf84bf9da98e0ef96..f9085f24e11c14e4ef55d9b4c02f27e8bd7e4b97 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_i_rect.md +++ b/zh-cn/device-dev/reference/hdi-apis/_i_rect.md @@ -3,7 +3,9 @@ ## **概述** -**所属模块:** +定义矩形信息。 + +**相关模块:** [Display](_display.md) @@ -13,14 +15,9 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [x](_display.md#x-12) | 矩形框起始X坐标。 | -| [y](_display.md#y-12) | 矩形框起始Y坐标。 | -| [w](_display.md#w) | 矩形框宽度。 | -| [h](_display.md#h) | 矩形框高度。 | - - -## **详细描述** - -定义矩形信息。 +| [x](_display.md#x-14) | 矩形框起始X坐标。 | +| [y](_display.md#y-14) | 矩形框起始Y坐标。 | +| [w](_display.md#w-12) | 矩形框宽度。 | +| [h](_display.md#h-12) | 矩形框高度。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_sensor_callback_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_i_sensor_callback_8idl.md new file mode 100644 index 0000000000000000000000000000000000000000..90176ba6c0d139069118cc31184af63e7d5c8158 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_i_sensor_callback_8idl.md @@ -0,0 +1,35 @@ +# ISensorCallback.idl + + +## **概述** + +Sensor模块为Sensor服务提供数据上报的回调函数。 + +**Since：** + +2.2 + +**Version:** + +1.0 + +**相关模块:** + +[Sensor](sensor.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [ISensorCallback](interface_i_sensor_callback.md) | 定义用于上报传感器数据的回调函数。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.sensor.v1_0 | Sensor模块接口的包路径。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_sensor_interface_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_i_sensor_interface_8idl.md new file mode 100644 index 0000000000000000000000000000000000000000..9b93aadd9a598ef7f112ba15e6d775a9b074ced5 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_i_sensor_interface_8idl.md @@ -0,0 +1,35 @@ +# ISensorInterface.idl + + +## **概述** + +Sensor模块对外通用的接口声明文件，提供获取传感器设备信息、订阅/取消订阅传感器数据、 使能/去使能传感器、设置传感器模式、设置传感器精度，量程等可选配置接口定义。 + +**Since：** + +2.2 + +**Version:** + +1.0 + +**相关模块:** + +[Sensor](sensor.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [ISensorInterface](interface_i_sensor_interface.md) | 提供Sensor设备基本控制操作接口。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.sensor.v1_0 | Sensor模块接口的包路径。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_stream_operator_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_i_stream_operator_8idl.md new file mode 100644 index 0000000000000000000000000000000000000000..6f24cb60c4fa57941630539bf4c39b2b67bc14ea --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_i_stream_operator_8idl.md @@ -0,0 +1,36 @@ +# IStreamOperator.idl + + +## **概述** + +流的操作接口。 + +**Since：** + +3.2 + +**Version:** + +1.0 + +**相关模块:** + +[Camera](camera.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [IStreamOperator](interface_i_stream_operator.md) | 定义Camera设备流操作。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.camera.v1_0 | Camera设备接口的包路径。 | +| **BufferProducerSequenceable** | | diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_stream_operator_callback_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_i_stream_operator_callback_8idl.md new file mode 100644 index 0000000000000000000000000000000000000000..f349924e485b58083362b1641a013ba2252ede13 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_i_stream_operator_callback_8idl.md @@ -0,0 +1,35 @@ +# IStreamOperatorCallback.idl + + +## **概述** + +[IStreamOperator](interface_i_stream_operator.md)相关的回调，这些回调均由调用者实现。 + +**Since：** + +3.2 + +**Version:** + +1.0 + +**相关模块:** + +[Camera](camera.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [IStreamOperatorCallback](interface_i_stream_operator_callback.md) | 定义Camera设备流回调操作。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.camera.v1_0 | Camera设备接口的包路径。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_surface.md b/zh-cn/device-dev/reference/hdi-apis/_i_surface.md index 26873d781962dcbe7d81d890889fdf29afa8a396..8006305430c09c9e3f97b5731cf0b882e3ee9f4c 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_i_surface.md +++ b/zh-cn/device-dev/reference/hdi-apis/_i_surface.md @@ -3,7 +3,9 @@ ## **概述** -**所属模块:** +用于存放窗口相关信息的结构体定义，提供给硬件加速使用，例如图像合成，位图搬移等操作。 + +**相关模块:** [Display](_display.md) @@ -13,23 +15,18 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [phyAddr](_display.md#phyaddr-22) | 图像首地址 | -| [height](_display.md#height-47) | 图像高度 | -| [width](_display.md#width-47) | 图像宽度 | -| [stride](_display.md#stride) | 图像跨度 | +| [phyAddr](_display.md#phyaddr-23) | 图像首地址 | +| [height](_display.md#height-48) | 图像高度 | +| [width](_display.md#width-49) | 图像宽度 | +| [stride](_display.md#stride-12) | 图像跨度 | | [enColorFmt](_display.md#encolorfmt) | 图像格式 | -| [bYCbCrClut](_display.md#bycbcrclut) | CLUT表是否位于YCbCr空间 | +| [bYCbCrClut](_display.md#bycbcrclut) | CLUT表是否位于 YCbCr 空间 | | [bAlphaMax255](_display.md#balphamax255) | 图像Alpha最大值为255还是128 | | [bAlphaExt1555](_display.md#balphaext1555) | 是否使能1555的Alpha扩展 | | [alpha0](_display.md#alpha0-22) | Alpha0值，取值范围：[0,255] | | [alpha1](_display.md#alpha1-22) | Alpha1值，取值范围：[0,255] | -| [cbcrPhyAddr](_display.md#cbcrphyaddr) | CbCr分量地址 | +| [clutPhyAddr](_display.md#clutphyaddr) | CbCr分量地址 | | [cbcrStride](_display.md#cbcrstride) | CbCr分量跨度 | -| [clutPhyAddr](_display.md#clutphyaddr) | CLUT表首地址，用作颜色扩展或颜色校正。| - - -## **详细描述** - -用于存放窗口相关信息的结构体定义，提供给硬件加速使用，例如图像合成，位图搬移等操作。 +| [clutPhyAddr](_display.md#clutphyaddr) | CLUT表首地址，用作颜色扩展或颜色校正 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_thermal_callback_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_i_thermal_callback_8idl.md index 5a4758d6b98696af3f30cdea9973526aa0dc68e4..67ec77493039b8de2a3a97be1063c2945c4c968a 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_i_thermal_callback_8idl.md +++ b/zh-cn/device-dev/reference/hdi-apis/_i_thermal_callback_8idl.md @@ -3,38 +3,35 @@ ## **概述** -**所属模块:** - -[Thermal](thermal.md) - +设备发热状态的回调。 -## **汇总** +热模块为热服务提供的设备发热状态的回调。 +**Since:** -### 类 +3.1 - | 类 | 描述 | -| -------- | -------- | -| [IThermalCallback](interface_i_thermal_callback.md) | 订阅设备发热状态的回调。 [更多...](interface_i_thermal_callback.md) | +**Version:** +1.0 -### 变量 +**相关模块:** - | 变量 名称 | 描述 | -| -------- | -------- | -| package ohos.hdi.thermal.v1_0 | 设备温度管理接口的包路径 | +[Thermal](thermal.md) -## **详细描述** +## **汇总** -设备发热状态的回调。 -热模块为热服务提供的设备发热状态的回调。 +### 类 -**Since：** + | 名称 | 描述 | +| -------- | -------- | +| [IThermalCallback](interface_i_thermal_callback.md) | 订阅设备发热状态的回调。 | -3.1 -**Version：** +### 关键字 -1.0 + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.thermal.v1_0 | Thermal模块接口的包路径。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_thermal_interface_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_i_thermal_interface_8idl.md index 06a92364867540b188c6d3cec54e94ff968d74ca..94f01ad5540cbeb24513fed7cab2573ee21ac077 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_i_thermal_interface_8idl.md +++ b/zh-cn/device-dev/reference/hdi-apis/_i_thermal_interface_8idl.md @@ -3,38 +3,35 @@ ## **概述** -**所属模块:** - -[Thermal](thermal.md) - +设备温度管理、控制及订阅接口。 -## **汇总** +热模块为热服务提供的设备温度管理、控制及订阅接口。 +**Since:** -### 类 +3.1 - | 类 | 描述 | -| -------- | -------- | -| [IThermalInterface](interface_i_thermal_interface.md) | 设备温度管理、控制及订阅接口。 [更多...](interface_i_thermal_interface.md) | +**Version:** +1.0 -### 变量 +**相关模块:** - | 变量 名称 | 描述 | -| -------- | -------- | -| package ohos.hdi.thermal.v1_0 | 设备温度管理接口的包路径 | +[Thermal](thermal.md) -## **详细描述** +## **汇总** -设备温度管理、控制及订阅接口。 -热模块为热服务提供的设备温度管理、控制及订阅接口。 +### 类 -**Since：** + | 名称 | 描述 | +| -------- | -------- | +| [IThermalInterface](interface_i_thermal_interface.md) | 设备温度管理、控制及订阅接口。 | -3.1 -**Version：** +### 关键字 -1.0 + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.thermal.v1_0 | Thermal模块接口的包路径。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_usb_interface_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_i_usb_interface_8idl.md new file mode 100644 index 0000000000000000000000000000000000000000..b7dad51734962b8a92cdac7544341552bb0c51c6 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_i_usb_interface_8idl.md @@ -0,0 +1,35 @@ +# IUsbInterface.idl + + +## **概述** + +声明标准的USB驱动接口函数。 + +**Since:** + +3.2 + +**Version:** + +1.0 + +**相关模块:** + +[USB](usb.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [IUsbInterface](interface_i_usb_interface.md) | 定义USB驱动基本的操作功能。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.usb.v1_0 | USB驱动接口的包路径。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_usbd_bulk_callback_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_i_usbd_bulk_callback_8idl.md new file mode 100644 index 0000000000000000000000000000000000000000..0c86dd008f370412921b5187ee2498c4c62b529a --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_i_usbd_bulk_callback_8idl.md @@ -0,0 +1,35 @@ +# IUsbdBulkCallback.idl + + +## **概述** + +USB驱动批量传输读/写数据的回调。 + +**Since:** + +3.2 + +**Version:** + +1.0 + +**相关模块:** + +[USB](usb.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [IUsbdBulkCallback](interface_i_usbd_bulk_callback.md) | USB驱动的回调函数。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.usb.v1_0 | USB驱动接口的包路径。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_usbd_subscriber_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_i_usbd_subscriber_8idl.md new file mode 100644 index 0000000000000000000000000000000000000000..6a7bdfc81009ef635e3bf85ea770726963a073fc --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_i_usbd_subscriber_8idl.md @@ -0,0 +1,35 @@ +# IUsbdSubscriber.idl + + +## **概述** + +USB驱动的订阅函数。 + +**Since:** + +3.2 + +**Version:** + +1.0 + +**相关模块:** + +[USB](usb.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [IUsbdSubscriber](interface_i_usbd_subscriber.md) | 定义USB驱动的订阅类相关函数。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.usb.v1_0 | USB驱动接口的包路径。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_user_auth_interface_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_i_user_auth_interface_8idl.md index 7f3c5bd0151a021922e2030f7c66bd5bd19aa98f..65a42d5ab47817d5f689becba8a863a3595d9667 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_i_user_auth_interface_8idl.md +++ b/zh-cn/device-dev/reference/hdi-apis/_i_user_auth_interface_8idl.md @@ -3,6 +3,12 @@ ## **概述** +声明用户认证驱动的API接口。接口可用于注册执行器，管理用户认证凭据，完成PIN码和生物特征认证。 + +**Since：** + +3.2 + **所属模块:** [HdfUserAuth](_hdf_user_auth.md) @@ -13,22 +19,13 @@ ### 类 - | 类 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [IUserAuthInterface](interface_i_user_auth_interface.md) | 声明用户认证驱动的API接口。 [更多...](interface_i_user_auth_interface.md) | +| [IUserAuthInterface](interface_i_user_auth_interface.md) | 声明用户认证驱动的API接口。 | -### 变量 +### 关键字 - | 变量 名称 | 描述 | + | 名称 | 描述 | | -------- | -------- | | package ohos.hdi.user_auth.v1_0 | 用户认证接口的包路径 | - - -## **详细描述** - -声明用户认证驱动的API接口。接口可用于注册执行器，管理用户认证凭据，完成PIN码和生物特征认证。 - -**Since：** - -3.2 diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_vibrator_interface_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_i_vibrator_interface_8idl.md new file mode 100644 index 0000000000000000000000000000000000000000..bd1f6b90c2b08b8e9b58193eafea768589d6836e --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_i_vibrator_interface_8idl.md @@ -0,0 +1,35 @@ +# IVibratorInterface.idl + + +## **概述** + +定义马达的通用API，可用于控制马达执行单次或周期性振动、设置马达振幅与频率。 + +**Since:** + +3.2 + +**Version:** + +1.1 + +**相关模块:** + +[Vibrator](vibrator.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [IVibratorInterface](interface_i_vibrator_interface.md) | Vibrator模块向上层服务提供统一的接口。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.vibrator.v1_1 | 马达模块接口的包路径。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_wi_fi.md b/zh-cn/device-dev/reference/hdi-apis/_i_wi_fi.md deleted file mode 100644 index 4010893f082cb29cf18a9f8aaeeff6c7ea0bbec6..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_i_wi_fi.md +++ /dev/null @@ -1,369 +0,0 @@ -# IWiFi - - -## **概述** - -**所属模块:** - -[WLAN](_w_l_a_n.md) - - -## **汇总** - - -### Public 属性 - - | Public 属性 | 描述 | -| -------- | -------- | -| ( [start](#start) )(struct IWiFi \*iwifi) | 创建HAL和驱动之间的通道及获取驱动网卡信息，该函数调用在创建IWiFi实体后进行。 [更多...](#start) | -| ( [stop](#stop) )(struct IWiFi \*iwifi) | 销毁HAL和驱动之间的通道，该函数调用在销毁IWiFi实体前进行。 [更多...](#stop) | -| ( [getSupportFeature](#getsupportfeature) )(uint8_t \*supType, uint32_t size) | 获取该设备支持的WLAN特性（不考虑当前的使用状态）。 [更多...](#getsupportfeature) | -| ( [getSupportCombo](#getsupportcombo) )(uint64_t \*combo, uint32_t size) | 获取多网卡共存情况。 [更多...](#getsupportcombo) | -| ( [createFeature](#createfeature) )(int32_t type, struct [IWiFiBaseFeature](_i_wi_fi_base_feature.md) \*\*ifeature) | 根据输入类型创建对应的特性[IWiFiBaseFeature](_i_wi_fi_base_feature.md)。 [更多...](#createfeature) | -| ( [getFeatureByIfName](#getfeaturebyifname) )(const char \*ifName, struct [IWiFiBaseFeature](_i_wi_fi_base_feature.md) \*\*ifeature) | 通过网络接口名字获取对应的特性。 [更多...](#getfeaturebyifname) | -| ( [registerEventCallback](#registereventcallback) )([CallbackFunc](_w_l_a_n.md#callbackfunc) cbFunc, const char \*ifName) | 注册IWiFi的回调函数，监听异步事件。 [更多...](#registereventcallback) | -| ( [unregisterEventCallback](#unregistereventcallback) )([CallbackFunc](_w_l_a_n.md#callbackfunc) cbFunc, const char \*ifName) | 去注册IWiFi的回调函数。 [更多...](#unregistereventcallback) | -| ( [destroyFeature](#destroyfeature) )(struct [IWiFiBaseFeature](_i_wi_fi_base_feature.md) \*ifeature) | 根据输入类型销毁对应的特性[IWiFiBaseFeature](_i_wi_fi_base_feature.md)。 [更多...](#destroyfeature) | -| ( [resetDriver](#resetdriver) )(const uint8_t chipId, const char \*ifName) | 重置具有指定芯片ID的WLAN驱动程序。 [更多...](#resetdriver) | -| ( [getNetDevInfo](#getnetdevinfo) )(struct NetDeviceInfoResult \*netDeviceInfoResult) | 获取网络设备信息（设备索引、网卡名字、MAC等信息）。 [更多...](#getnetdevinfo) | -| ( [getPowerMode](#getpowermode) )(const char \*ifName, uint8_t \*mode) | 获取正在使用的功率模式。 [更多...](#getpowermode) | -| ( [setPowerMode](#setpowermode) )(const char \*ifName, uint8_t mode) | 设置功率模式 [更多...](#setpowermode) | - - -## **详细描述** - -HAL对WLAN服务提供的基本能力。 - -用于创建HAL与驱动的通道，创建/获取/销毁WLAN特性等。 - -**Since：** - -1.0 - -**Version：** - -1.0 - - -## **类成员变量说明** - - -### createFeature - - -``` -int32_t(* IWiFi::createFeature) (int32_t type, struct IWiFiBaseFeature **ifeature) -``` - -**描述：** - -根据输入类型创建对应的特性[IWiFiBaseFeature](_i_wi_fi_base_feature.md)。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| type | 输入参数，创建的feature类型。 | -| ifeature | 输出参数，获取创建的feature对象。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - - -### destroyFeature - - -``` -int32_t(* IWiFi::destroyFeature) (struct IWiFiBaseFeature *ifeature) -``` - -**描述：** - -根据输入类型销毁对应的特性[IWiFiBaseFeature](_i_wi_fi_base_feature.md)。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| ifeature | 输入参数，销毁的feature对象。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - - -### getFeatureByIfName - - -``` -int32_t(* IWiFi::getFeatureByIfName) (const char *ifName, struct IWiFiBaseFeature **ifeature) -``` - -**描述：** - -通过网络接口名字获取对应的特性。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| ifName | 输入参数，网卡名称。 | -| ifeature | 输出参数，获取该网络接口名字的feature对象。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - - -### getNetDevInfo - - -``` -int32_t(* IWiFi::getNetDevInfo) (struct NetDeviceInfoResult *netDeviceInfoResult) -``` - -**描述：** - -获取网络设备信息（设备索引、网卡名字、MAC等信息）。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| netDeviceInfoResult | 输出参数，得到的网络设备信息。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - - -### getPowerMode - - -``` -int32_t(* IWiFi::getPowerMode) (const char *ifName, uint8_t *mode) -``` - -**描述：** - -获取正在使用的功率模式。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| ifName | 输入参数，网卡名称。 | -| mode | 输出参数，功率模式，包括睡眠模式（待机状态运行）、一般模式（正常额定功率运行）、穿墙模式（最大功率运行，提高信号强度和覆盖面积）。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - - -### getSupportCombo - - -``` -int32_t(* IWiFi::getSupportCombo) (uint64_t *combo, uint32_t size) -``` - -**描述：** - -获取多网卡共存情况。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| combo | 输出参数，基于芯片的能力保存当前所有支持的多网卡共存情况（比如支持AP，STA，P2P等不同组合的共存）。 | -| size | 输入参数，combo数组的长度。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - - -### getSupportFeature - - -``` -int32_t(* IWiFi::getSupportFeature) (uint8_t *supType, uint32_t size) -``` - -**描述：** - -获取该设备支持的WLAN特性（不考虑当前的使用状态）。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| supType | 输出参数，保存当前设备支持的特性。 | -| size | 输入参数，supType数组的长度。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - - -### registerEventCallback - - -``` -int32_t(* IWiFi::registerEventCallback) (CallbackFunc cbFunc, const char *ifName) -``` - -**描述：** - -注册IWiFi的回调函数，监听异步事件。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| cbFunc | 输入参数，注册的回调函数。 | -| ifName | 输入参数，网卡名称。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - - -### resetDriver - - -``` -int32_t(* IWiFi::resetDriver) (const uint8_t chipId, const char *ifName) -``` - -**描述：** - -重置具有指定芯片ID的WLAN驱动程序。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| chipId | 输入参数，需要进行重置驱动的对应芯片ID。 | -| ifName | 输入参数，网卡名称。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - - -### setPowerMode - - -``` -int32_t(* IWiFi::setPowerMode) (const char *ifName, uint8_t mode) -``` - -**描述：** - -设置功率模式 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| ifName | 输入参数，网卡名称。 | -| mode | 输入参数，功率模式,包括睡眠模式（待机状态运行）、一般模式（正常额定功率运行）、穿墙模式（最大功率运行，提高信号强度和覆盖面积）。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - - -### start - - -``` -int32_t(* IWiFi::start) (struct IWiFi *iwifi) -``` - -**描述：** - -创建HAL和驱动之间的通道及获取驱动网卡信息，该函数调用在创建IWiFi实体后进行。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| iwifi | 输入参数，IWiFi对象。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - - -### stop - - -``` -int32_t(* IWiFi::stop) (struct IWiFi *iwifi) -``` - -**描述：** - -销毁HAL和驱动之间的通道，该函数调用在销毁IWiFi实体前进行。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| iwifi | 输入参数，IWiFi对象。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - - -### unregisterEventCallback - - -``` -int32_t(* IWiFi::unregisterEventCallback) (CallbackFunc cbFunc, const char *ifName) -``` - -**描述：** - -去注册IWiFi的回调函数。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| cbFunc | 输入参数，去注册的回调函数。 | -| ifName | 输入参数，网卡名称。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_wi_fi_ap.md b/zh-cn/device-dev/reference/hdi-apis/_i_wi_fi_ap.md deleted file mode 100644 index 2b291fba5e1a5852eee597b9d401ea72884f5b70..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_i_wi_fi_ap.md +++ /dev/null @@ -1,101 +0,0 @@ -# IWiFiAp - - -## **概述** - -**所属模块:** - -[WLAN](_w_l_a_n.md) - - -## **汇总** - - -### Public 属性 - - | Public 属性 | 描述 | -| -------- | -------- | -| [baseFeature](#basefeature) | 基本特性。 | -| ( [getAsscociatedStas](#getasscociatedstas) )(const struct IWiFiAp \*apFeature, struct [StaInfo](_sta_info.md) \*staInfo, uint32_t count, uint32_t \*num) | 获取连接上的所有STA的信息（目前只包含MAC地址）。 [更多...](#getasscociatedstas) | -| ( [setCountryCode](#setcountrycode) )(const struct IWiFiAp \*apFeature, const char \*code, uint32_t len) | 设置国家码（表示AP射频所在的国家，规定了AP射频特性，包括AP的发送功率、支持的信道等。其目的是为了使AP的射频特性符合不同国家或区域的法律法规要求）。 [更多...](#setcountrycode) | - - -## **详细描述** - -继承了IWiFiBaseFeature基本特性，并包含AP模式下获取连接STA的信息和设置国家码的功能。 - -**Since：** - -1.0 - -**Version：** - -1.0 - - -## **类成员变量说明** - - -### baseFeature - - -``` -struct IWiFiBaseFeature IWiFiAp::baseFeature -``` - -**描述：** - -基本特性。 - - -### getAsscociatedStas - - -``` -int32_t(* IWiFiAp::getAsscociatedStas) (const struct IWiFiAp *apFeature, struct StaInfo *staInfo, uint32_t count, uint32_t *num) -``` - -**描述：** - -获取连接上的所有STA的信息（目前只包含MAC地址）。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| apFeature | 输入参数，AP特性。 | -| staInfo | 输出参数，保存与AP连接的STA的基本信息。 | -| count | 输入参数，staInfo结构体数组的元素个数。 | -| num | 输出参数，实际连接的STA的个数。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - - -### setCountryCode - - -``` -int32_t(* IWiFiAp::setCountryCode) (const struct IWiFiAp *apFeature, const char *code, uint32_t len) -``` - -**描述：** - -设置国家码（表示AP射频所在的国家，规定了AP射频特性，包括AP的发送功率、支持的信道等。其目的是为了使AP的射频特性符合不同国家或区域的法律法规要求）。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| apFeature | 输入参数，AP特性。 | -| code | 输入参数，设置的国家码。 | -| len | 输入参数，国家码长度。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_wi_fi_base_feature.md b/zh-cn/device-dev/reference/hdi-apis/_i_wi_fi_base_feature.md deleted file mode 100644 index 0f440188c6e2ce31ffc78229a6d82c8e53a3702a..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_i_wi_fi_base_feature.md +++ /dev/null @@ -1,259 +0,0 @@ -# IWiFiBaseFeature - - -## **概述** - -**所属模块:** - -[WLAN](_w_l_a_n.md) - - -## **汇总** - - -### Public 属性 - - | Public 属性 | 描述 | -| -------- | -------- | -| [ifName](#ifname) [[IFNAME_MAX_LEN](_w_l_a_n.md#ga63637ece87095ff8d153f650434ecf97)] | 网卡名称。 | -| **type** | 特性的类型，参考[FeatureType](_w_l_a_n.md#featuretype)。 | -| ( [getNetworkIfaceName](#getnetworkifacename) )(const struct IWiFiBaseFeature \*baseFeature) | 根据基本特性获取网卡名称。 [更多...](#getnetworkifacename) | -| ( [getFeatureType](#getfeaturetype) )(const struct IWiFiBaseFeature \*baseFeature) | 获取基本特性的类型[FeatureType](_w_l_a_n.md#featuretype)。 [更多...](#getfeaturetype) | -| ( [setMacAddress](#setmacaddress) )(const struct IWiFiBaseFeature \*baseFeature, unsigned char \*mac, uint8_t len) | 根据传入参数设置对应网卡的MAC地址。 [更多...](#setmacaddress) | -| ( [getDeviceMacAddress](#getdevicemacaddress) )(const struct IWiFiBaseFeature \*baseFeature, unsigned char \*mac, uint8_t len) | 获取设备的MAC地址。 [更多...](#getdevicemacaddress) | -| ( [getValidFreqsWithBand](#getvalidfreqswithband) )(const struct IWiFiBaseFeature \*baseFeature, int32_t band, int32_t \*freqs, uint32_t count, uint32_t \*num) | 获取指定频段（2.4G或者5G）下支持的频率。 [更多...](#getvalidfreqswithband) | -| ( [setTxPower](#settxpower) )(const struct IWiFiBaseFeature \*baseFeature, int32_t power) | 设置发射功率。 [更多...](#settxpower) | -| ( [getChipId](#getchipid) )(const struct IWiFiBaseFeature \*baseFeature, uint8_t \*chipId) | 获得当前驱动的芯片ID。 [更多...](#getchipid) | -| ( [getIfNamesByChipId](#getifnamesbychipid) )(const uint8_t chipId, char \*\*ifNames, uint32_t \*num) | 通过芯片ID获得当前芯片所有的网卡名称。 [更多...](#getifnamesbychipid) | - - -## **详细描述** - -WLAN基本特性操作接口，包括获取网卡名称，设置MAC地址，设置发射功率等公共能力接口。 - -**Since：** - -1.0 - -**Version：** - -1.0 - - -## **类成员变量说明** - - -### getChipId - - -``` -int32_t(* IWiFiBaseFeature::getChipId) (const struct IWiFiBaseFeature *baseFeature, uint8_t *chipId) -``` - -**描述：** - -获得当前驱动的芯片ID。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| baseFeature | 输入参数，基本特性。 | -| chipId | 输出参数，获得的芯片ID。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - - -### getDeviceMacAddress - - -``` -int32_t(* IWiFiBaseFeature::getDeviceMacAddress) (const struct IWiFiBaseFeature *baseFeature, unsigned char *mac, uint8_t len) -``` - -**描述：** - -获取设备的MAC地址。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| baseFeature | 输入参数，基本特性。 | -| mac | 输出参数，获得的MAC地址。 | -| len | 输入参数，获得的MAC地址长度。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - - -### getFeatureType - - -``` -int32_t(*IWiFiBaseFeature::getFeatureType) (const struct IWiFiBaseFeature *baseFeature) -``` - -**描述：** - -获取基本特性的类型[FeatureType](_w_l_a_n.md#featuretype)。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| baseFeature | 输入参数，基本特性。 | - -**返回：** - -如果操作成功，则返回特性类型。 - -如果操作失败，则返回负值。 - - -### getIfNamesByChipId - - -``` -int32_t(* IWiFiBaseFeature::getIfNamesByChipId) (const uint8_t chipId, char **ifNames, uint32_t *num) -``` - -**描述：** - -通过芯片ID获得当前芯片所有的网卡名称。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| chipId | 输入参数，需要获取网卡名称的芯片ID。 | -| ifNames | 输出参数，网卡名称。 | -| num | 输出参数，网卡的数量。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - - -### getNetworkIfaceName - - -``` -const char*(* IWiFiBaseFeature::getNetworkIfaceName) (const struct IWiFiBaseFeature *baseFeature) -``` - -**描述：** - -根据基本特性获取网卡名称。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| baseFeature | 输入参数，基本特性。 | - -**返回：** - -如果操作成功，则返回网卡名称。 - -如果操作失败，则返回NULL。 - - -### getValidFreqsWithBand - - -``` -int32_t(* IWiFiBaseFeature::getValidFreqsWithBand) (const struct IWiFiBaseFeature *baseFeature, int32_t band, int32_t *freqs, uint32_t count, uint32_t *num) -``` - -**描述：** - -获取指定频段（2.4G或者5G）下支持的频率。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| baseFeature | 输入参数，基本特性。 | -| band | 输入参数，指定的一个频段。 | -| freqs | 输出参数，保存支持的频率。 | -| count | 输入参数，频率数组的元素个数。 | -| num | 输出参数，实际支持的频率个数。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - - -### ifName - - -``` -char IWiFiBaseFeature::ifName[IFNAME_MAX_LEN] -``` - -**描述：** - -网卡名称。 - - -### setMacAddress - - -``` -int32_t(* IWiFiBaseFeature::setMacAddress) (const struct IWiFiBaseFeature *baseFeature, unsigned char *mac, uint8_t len) -``` - -**描述：** - -根据传入参数设置对应网卡的MAC地址。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| baseFeature | 输入参数，基本特性。 | -| mac | 输入参数，设置的MAC地址。 | -| len | 输入参数，设置的MAC地址长度。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - - -### setTxPower - - -``` -int32_t(* IWiFiBaseFeature::setTxPower) (const struct IWiFiBaseFeature *baseFeature, int32_t power) -``` - -**描述：** - -设置发射功率。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| baseFeature | 输入参数，基本特性。 | -| power | 输入参数，设置的发射功率。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_wi_fi_sta.md b/zh-cn/device-dev/reference/hdi-apis/_i_wi_fi_sta.md deleted file mode 100644 index aff3e568d7d0cae1422620565645673dbcb5508e..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_i_wi_fi_sta.md +++ /dev/null @@ -1,99 +0,0 @@ -# IWiFiSta - - -## **概述** - -**所属模块:** - -[WLAN](_w_l_a_n.md) - - -## **汇总** - - -### Public 属性 - - | Public 属性 | 描述 | -| -------- | -------- | -| [baseFeature](#basefeature) | 基本特性。 | -| ( [setScanningMacAddress](#setscanningmacaddress) )(const struct IWiFiSta \*staFeature, unsigned char \*scanMac, uint8_t len) | 设置扫描单个MAC地址。 [更多...](#setscanningmacaddress) | -| ( [startScan](#startscan) )(const char \*ifName, WifiScan \*scan) | 启动扫描。 [更多...](#startscan) | - - -## **详细描述** - -继承了[IWiFiBaseFeature](_i_wi_fi_base_feature.md)基本特性，额外包含设置扫描单个MAC地址功能。 - -**Since：** - -1.0 - -**Version：** - -1.0 - - -## **类成员变量说明** - - -### baseFeature - - -``` -struct IWiFiBaseFeature IWiFiSta::baseFeature -``` - -**描述：** - -基本特性。 - - -### setScanningMacAddress - - -``` -int32_t(* IWiFiSta::setScanningMacAddress) (const struct IWiFiSta *staFeature, unsigned char *scanMac, uint8_t len) -``` - -**描述：** - -设置扫描单个MAC地址。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| staFeature | 输入参数，STA特性。 | -| scanMac | 输入参数，设置STA扫描的MAC地址。 | -| len | 输入参数，MAC地址的长度。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - - -### startScan - - -``` -int32_t(* IWiFiSta::startScan) (const char *ifName, WifiScan *scan) -``` - -**描述：** - -启动扫描。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| ifName | 输入参数，网卡名称。 | -| scan | 输入参数，扫描参数。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_wlan_callback_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_i_wlan_callback_8idl.md new file mode 100644 index 0000000000000000000000000000000000000000..beb6dbd85a0accf901c36f1212d4e1a5747c95f6 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_i_wlan_callback_8idl.md @@ -0,0 +1,35 @@ +# IWlanCallback.idl + + +## **概述** + +WLAN模块为WLAN服务提供的重启驱动、扫描结果、Netlink消息处理的回调。 + +**Since:** + +3.2 + +**Version:** + +1.0 + +**相关模块:** + +[WLAN](wlan.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [IWlanCallback](interface_i_wlan_callback.md) | 定义WLAN模块的回调函数。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.wlan.v1_0 | WLAN模块接口的包路径。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_wlan_interface_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_i_wlan_interface_8idl.md new file mode 100644 index 0000000000000000000000000000000000000000..c29124f5e5f131c61798081b8f95a1d97360ffce --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_i_wlan_interface_8idl.md @@ -0,0 +1,37 @@ +# IWlanInterface.idl + + +## **概述** + +建立/关闭WLAN热点，扫描/关联/去关联WLAN热点，设置国家码，管理网络设备等操作的接口。 + +上层服务调用相关的接口实现：建立/关闭WLAN热点，扫描/关联/去关联WLAN热点，设置国家码，管理网络设备等功能。 + +**Since:** + +3.2 + +**Version:** + +1.0 + +**相关模块:** + +[WLAN](wlan.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [IWlanInterface](interface_i_wlan_interface.md) | WLAN模块向上层WLAN服务提供了统一接口。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.wlan.v1_0 | WLAN模块接口的包路径。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_identify_result_info.md b/zh-cn/device-dev/reference/hdi-apis/_identify_result_info.md index f990a2d18bffdca9b2404f92e1c56f191bc93676..7de20781d4853dcc55f0a24b127939d5abc0c241 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_identify_result_info.md +++ b/zh-cn/device-dev/reference/hdi-apis/_identify_result_info.md @@ -3,6 +3,16 @@ ## **概述** +用户身份识别结果信息。 + +**Since：** + +3.2 + +**Version:** + +1.0 + **所属模块:** [HdfUserAuth](_hdf_user_auth.md) @@ -13,26 +23,13 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | | [result](#result) | 用户身份识别结果。 | | [userId](#userid) | 用户ID。 | | [token](#token) | 用户身份识别令牌。 | -## **详细描述** - -用户身份识别结果信息。 - -**Since：** - -3.2 - -**Version:** - -1.0 - - ## **类成员变量说明** diff --git a/zh-cn/device-dev/reference/hdi-apis/_input.md b/zh-cn/device-dev/reference/hdi-apis/_input.md deleted file mode 100644 index dbd838eafb69a6c12d443de9271c1ff24ddd14cf..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_input.md +++ /dev/null @@ -1,238 +0,0 @@ -# Input - - -## **汇总** - - -### 文件 - - | 文件 | 描述 | -| -------- | -------- | -| [input_controller.h](input__controller_8h.md) | 描述Input设备业务控制相关的接口声明。 | -| [input_manager.h](input__manager_8h.md) | 描述Input设备管理相关的接口声明。 | -| [input_reporter.h](input__reporter_8h.md) | 描述Input设备数据上报相关的接口声明。 | -| [input_type.h](input__type_8h.md) | Input设备相关的类型定义，定义了Input设备驱动接口所使用的结构体及枚举类型。 | - - -### 类 - - | 类 | 描述 | -| -------- | -------- | -| [InputController](_input_controller.md) | 提供Input设备业务控制相关的接口。 [更多...](_input_controller.md) | -| [InputManager](_input_manager.md) | 提供Input设备管理相关的接口。 [更多...](_input_manager.md) | -| [IInputInterface](_i_input_interface.md) | 定义用于提供输入设备驱动能力的接口。[更多...](_i_input_interface.md) | -| [InputReporter](_input_reporter.md) | 提供Input设备数据上报相关的接口。 [更多...](_input_reporter.md) | -| [InputEventPackage](_event_package.md) | Input事件数据包结构。 [更多...](_event_package.md) | -| [InputHotPlugEvent](_input_hotplug_event.md) | 热插拔事件数据包结构。 [更多...](_input_hotplug_event.md) | -| [InputDevDesc](_input_dev_desc.md) | Input设备描述信息。 [更多...](_input_dev_desc.md) | -| [InputEventCb](_input_report_event_cb.md) | 此结构体定义了输入事件回调函数并提供给Input服务使用。 [更多...](_input_report_event_cb.md) | -| [InputHostCb](_input_host_cb.md) | 此结构体定义了热插拔事件上报回调函数并提供给Input服务使用。 [更多...](_input_host_cb.md) | -| [InputDevAbility](_input_dev_ability.md) | Input设备的能力属性，存储支持事件的位图。 [更多...](_input_dev_ability.md) | -| [InputDimensionInfo](_input_dimension_info.md) | Input设备的维度信息。 [更多...](_input_dimension_info.md) | -| [InputDevIdentify](_input_dev_identify.md) | Input设备的识别信息。 [更多...](_input_dev_identify.md) | -| [InputDevAttr](_input_dev_attr.md) | Input设备属性。 [更多...](_input_dev_attr.md) | -| [InputDeviceInfo](_device_info.md) | Input设备基础设备信息。 [更多...](_device_info.md) | -| [InputExtraCmd](_input_extra_cmd.md) | 扩展指令的数据结构。 [更多...](_input_extra_cmd.md) | - - -### 宏定义 - - | 宏定义 | 描述 | -| -------- | -------- | -| **MAX_INPUT_DEV_NUM**   32 | Input设备最大数量。 | -| **DEV_NAME_LEN**   64 | Input设备名称长度。 | -| **CHIP_INFO_LEN**   10 | 芯片信息长度。 | -| **CHIP_NAME_LEN**   10 | 芯片名称长度。 | -| **VENDOR_NAME_LEN**   10 | 厂商名称长度。 | -| **SELF_TEST_RESULT_LEN**   20 | 自测结果长度。 | -| **DEV_MANAGER_SERVICE_NAME**   "hdf_input_host" | Input设备节点服务名称。 | -| **DIV_ROUND_UP(nr, d)**  (((nr) + (d) - 1) / (d)) | 向上取整计算公式。| -| **BYTE_HAS_BITS**  8 | 一个字节所包含的比特数。 | -| **BITS_TO_UINT64(count)**  DIV_ROUND_UP(count, BYTE_HAS_BITS * sizeof(uint64_t)) | 比特与64位无符号整数的转换公式。 | -| **HDF_FF_CNT**  (0x7f + 1) | Input设备发送力反馈命令的数量最大值。| - - -### 枚举 - - | 枚举 | 描述 | -| -------- | -------- | -| [RetStatus](#retstatus) { INPUT_SUCCESS = 0, INPUT_FAILURE = -1, INPUT_INVALID_PARAM = -2, INPUT_NOMEM = -3,   INPUT_NULL_PTR = -4, INPUT_TIMEOUT = -5, INPUT_UNSUPPORTED = -6 } | 定义返回值类型。 [更多...](#retstatus) | -| [InputDevType](#inputdevtype) { INDEV_TYPE_TOUCH, INDEV_TYPE_KEY, INDEV_TYPE_KEYBOARD, INDEV_TYPE_MOUSE,   INDEV_TYPE_BUTTON, INDEV_TYPE_CROWN, INDEV_TYPE_ENCODER, INDEV_TYPE_UNKNOWN } | 定义Input设备类型。 [更多...](#inputdevtype) | -| [PowerStatus](#powerstatus) { INPUT_RESUME, INPUT_SUSPEND, INPUT_LOW_POWER, INPUT_POWER_STATUS_UNKNOWN } | 定义电源状态。 [更多...](#powerstatus) | -| [CapacitanceTest](#capacitancetest) { BASE_TEST, FULL_TEST, MMI_TEST, RUNNING_TEST,   TEST_TYPE_UNKNOWN } | 定义容值测试类型。 [更多...](#capacitancetest) | - - -### 函数 - - | 函数 | 描述 | -| -------- | -------- | -| [GetInputInterface](#getinputinterface) ([IInputInterface](_i_input_interface.md) \*\*interface) | Input服务通过调用此接口获取操作Input设备的所有接口。 [更多...](#getinputinterface) | -| [ReleaseInputInterface](#releaseinputinterface) ([IInputInterface](_i_input_interface.md) \*\*inputInterface) | Input服务通过调用此接口释放操作Input设备的所有接口。 [更多...](#releaseinputinterface) | - - -## **详细描述** - -Input模块驱动接口声明。 - -本模块为Input服务提供相关驱动接口，包括Input设备的打开和关闭、Input事件获取、设备信息查询、回调函数注册、特性状态控制等接口。 - -**Since：** - -1.0 - -**Version：** - -1.0 - - -## **枚举类型说明** - - -### CapacitanceTest - - -``` -enum CapacitanceTest -``` - -**描述：** - -定义容值测试类型。 - - | 枚举值 | 描述 | -| -------- | -------- | -| BASE_TEST | 基础容值测试 | -| FULL_TEST | 全量容值自检测试 | -| MMI_TEST | MMI容值测试 | -| RUNNING_TEST | 老化容值测试 | -| TEST_TYPE_UNKNOWN | 未知的测试类型 | - - -### InputDevType - - -``` -enum InputDevType -``` - -**描述：** - -定义Input设备类型。 - - | 枚举值 | 描述 | -| -------- | -------- | -| INDEV_TYPE_TOUCH | 触摸屏。 | -| INDEV_TYPE_KEY | 物理按键。 | -| INDEV_TYPE_KEYBOARD | 键盘。 | -| INDEV_TYPE_MOUSE | 鼠标。 | -| INDEV_TYPE_BUTTON | 虚拟按键。 | -| INDEV_TYPE_CROWN | 表冠。 | -| INDEV_TYPE_ENCODER | 自定义编码的特定功能或者事件。 | -| INDEV_TYPE_UNKNOWN | 未知输入设备类型。 | - - -### PowerStatus - - -``` -enum PowerStatus -``` - -**描述：** - -定义电源状态。 - - | 枚举值 | 描述 | -| -------- | -------- | -| INPUT_RESUME | 正常唤醒。 | -| INPUT_SUSPEND | 休眠下电模式。 | -| INPUT_LOW_POWER | 休眠低功耗模式。 | -| INPUT_POWER_STATUS_UNKNOWN | 未知电源状态。 | - - -### RetStatus - - -``` -enum RetStatus -``` - -**描述：** - -定义返回值类型。 - - | 枚举值 | 描述 | -| -------- | -------- | -| INPUT_SUCCESS | 成功。 | -| INPUT_FAILURE | 失败。 | -| INPUT_INVALID_PARAM | 无效参数。 | -| INPUT_NOMEM | 内存不足。 | -| INPUT_NULL_PTR | 空指针。 | -| INPUT_TIMEOUT | 执行超时。 | -| INPUT_UNSUPPORTED | 特性不支持。 | - - -## **函数说明** - - -### GetInputInterface() - - -``` -int32_t GetInputInterface (IInputInterface **interface) -``` - -**描述：** - -Input服务通过调用此接口获取操作Input设备的所有接口。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| interface | 对Input设备进行接口操作的指针，通常在Input服务启动后，通过调用此函数获取Input设备操作接口。 | - -**返回：** - -INPUT_SUCCESS 表示执行成功。 - -其他值表示执行失败，具体错误码查看[RetStatus](#retstatus)。 - -**Since：** - -1.0 - -**Version：** - -1.0 - -### ReleaseInputInterface() - - -``` -int32_t ReleaseInputInterface (IInputInterface *inputInterface) -``` - -**描述：** - -Input服务通过调用此接口释放操作Input设备的所有接口。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| inputInterface| 对Input设备进行接口操作的指针。 | - -**返回：** - -INPUT_SUCCESS 表示执行成功。 - -其他值表示执行失败，具体错误码查看[RetStatus](#retstatus)。 - -**Since：** - -1.0 - -**Version：** - -1.0 diff --git a/zh-cn/device-dev/reference/hdi-apis/_input_controller.md b/zh-cn/device-dev/reference/hdi-apis/_input_controller.md index 2f3d3e0c4394801375698db6f2393d5d85de169b..34ed01cf05b1a3ccbf1c59fe78ea25dd1a2d19bb 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_input_controller.md +++ b/zh-cn/device-dev/reference/hdi-apis/_input_controller.md @@ -3,9 +3,13 @@ ## **概述** -**所属模块:** +提供Input设备业务控制相关的接口。 + +此类接口包含电源状态的设置、特性的使能、器件信息的获取，以及产线相关的测试功能接口。 + +**相关模块:** -[Input](_input.md) +[Input](input.md) ## **汇总** @@ -13,24 +17,17 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| ( [SetPowerStatus](#setpowerstatus) )(uint32_t devIndex, uint32_t status) | 设置电源状态 [更多...](#setpowerstatus) | -| ( [GetPowerStatus](#getpowerstatus) )(uint32_t devIndex, uint32_t \*status) | 获取电源状态 [更多...](#getpowerstatus) | -| ( [GetDeviceType](#getdevicetype) )(uint32_t devIndex, uint32_t \*deviceType) | 获取devIndex对应的Input设备的类型 [更多...](#getdevicetype) | -| ( [GetChipInfo](#getchipinfo) )(uint32_t devIndex, char \*chipInfo, uint32_t length) | 获取器件对应的编码信息 [更多...](#getchipinfo) | -| ( [GetVendorName](#getvendorname) )(uint32_t devIndex, char \*vendorName, uint32_t length) | 获取devIndex对应的模组厂商名 [更多...](#getvendorname) | -| ( [GetChipName](#getchipname) )(uint32_t devIndex, char \*chipName, uint32_t length) | 获取devIndex对应的驱动芯片名 [更多...](#getchipname) | -| ( [SetGestureMode](#setgesturemode) )(uint32_t devIndex, uint32_t gestureMode) | 设置手势模式 [更多...](#setgesturemode) | -| ( [RunCapacitanceTest](#runcapacitancetest) )(uint32_t devIndex, uint32_t testType, char \*result, uint32_t length) | 执行容值自检测试 [更多...](#runcapacitancetest) | -| ( [RunExtraCommand](#runextracommand) )(uint32_t devIndex, [InputExtraCmd](_input_extra_cmd.md) \*cmd) | 执行拓展指令 [更多...](#runextracommand) | - - -## **详细描述** - -提供Input设备业务控制相关的接口。 - -此类接口包含电源状态的设置、特性的使能、器件信息的获取，以及产线相关的测试功能接口。 +| ([SetPowerStatus](#setpowerstatus) )(uint32_t devIndex, uint32_t status) | 设置电源状态。 | +| ([GetPowerStatus](#getpowerstatus) )(uint32_t devIndex, uint32_t \*status) | 获取电源状态。 | +| ([GetDeviceType](#getdevicetype) )(uint32_t devIndex, uint32_t \*deviceType) | 获取devIndex对应的Input设备的类型。 | +| ([GetChipInfo](#getchipinfo) )(uint32_t devIndex, char \*chipInfo, uint32_t length) | 获取器件对应的编码信息。 | +| ([GetVendorName](#getvendorname) )(uint32_t devIndex, char \*vendorName, uint32_t length) | 获取devIndex对应的模组厂商名。 | +| ([GetChipName](#getchipname) )(uint32_t devIndex, char \*chipName, uint32_t length) | 获取devIndex对应的驱动芯片名。 | +| ([SetGestureMode](#setgesturemode) )(uint32_t devIndex, uint32_t gestureMode) | 设置手势模式。 | +| ([RunCapacitanceTest](#runcapacitancetest) )(uint32_t devIndex, uint32_t testType, char \*result, uint32_t length) | 执行容值自检测试。 | +| ([RunExtraCommand](#runextracommand) )(uint32_t devIndex, [InputExtraCmd](_input_extra_cmd.md) \*cmd) | 执行拓展指令。 | ## **类成员变量说明** @@ -49,7 +46,7 @@ int32_t(* InputController::GetChipInfo) (uint32_t devIndex, char *chipInfo, uint 一款产品通常会有多家模组和Driver IC，上层应用如果关注具体器件型号，则通过此接口来获取。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -57,11 +54,11 @@ int32_t(* InputController::GetChipInfo) (uint32_t devIndex, char *chipInfo, uint | chipInfo | 输出参数，获取的对应设备索引的器件编码信息。 | | length | 输入参数，保存器件芯片信息的内存长度。 | -**返回：** +**返回:** INPUT_SUCCESS 表示执行成功。 -其他值表示执行失败，具体错误码查看[RetStatus](_input.md#retstatus)。 +其他值表示执行失败，具体错误码查看[RetStatus](input.md#retstatus)。 ### GetChipName @@ -75,7 +72,7 @@ int32_t(* InputController::GetChipName) (uint32_t devIndex, char *chipName, uint 获取devIndex对应的驱动芯片名。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -83,11 +80,11 @@ int32_t(* InputController::GetChipName) (uint32_t devIndex, char *chipName, uint | chipName | 输出参数，获取的对应设备索引的驱动芯片名。 | | length | 输入参数，保存驱动芯片名的内存长度。 | -**返回：** +**返回:** INPUT_SUCCESS 表示执行成功。 -其他值表示执行失败，具体错误码查看[RetStatus](_input.md#retstatus)。 +其他值表示执行失败，具体错误码查看[RetStatus](input.md#retstatus)。 ### GetDeviceType @@ -101,18 +98,18 @@ int32_t(* InputController::GetDeviceType) (uint32_t devIndex, uint32_t *deviceTy 获取devIndex对应的Input设备的类型。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | -| deviceType | 输出参数，获取的对应设备索引的设备类型，具体参考[InputDevType](_input.md#inputdevtype)。 | +| deviceType | 输出参数，获取的对应设备索引的设备类型，具体参考[InputDevType](input.md#inputdevtype)。 | -**返回：** +**返回:** INPUT_SUCCESS 表示执行成功。 -其他值表示执行失败，具体错误码查看[RetStatus](_input.md#retstatus)。 +其他值表示执行失败，具体错误码查看[RetStatus](input.md#retstatus)。 ### GetPowerStatus @@ -128,18 +125,18 @@ int32_t(* InputController::GetPowerStatus) (uint32_t devIndex, uint32_t *status) 在系统休眠或者唤醒时，Input服务或电源管理模块获取电源状态，以便驱动IC能正常进入对应的休眠模式。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | -| status | 输出参数，获取的对应设备索引的电源状态，具体参考[PowerStatus](_input.md#powerstatus)。 | +| status | 输出参数，获取的对应设备索引的电源状态，具体参考[PowerStatus](input.md#powerstatus)。 | -**返回：** +**返回:** INPUT_SUCCESS 表示执行成功。 -其他值表示执行失败，具体错误码查看[RetStatus](_input.md#retstatus)。 +其他值表示执行失败，具体错误码查看[RetStatus](input.md#retstatus)。 ### GetVendorName @@ -153,19 +150,19 @@ int32_t(* InputController::GetVendorName) (uint32_t devIndex, char *vendorName, 获取devIndex对应的模组厂商名。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | -| devIndex | Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | -| vendorName | 获取的对应设备索引的模组厂商名。 | -| length | 保存模组厂商名的内存长度。 | +| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | +| vendorName | 输出参数，获取的对应设备索引的模组厂商名。 | +| length | 输入参数，保存模组厂商名的内存长度。 | -**返回：** +**返回:** -Returns INPUT_SUCCESS 表示执行成功。 +INPUT_SUCCESS 表示执行成功。 -Returns 其他值表示执行失败，具体错误码查看[RetStatus](_input.md#retstatus)。 +其他值表示执行失败，具体错误码查看[RetStatus](input.md#retstatus)。 ### RunCapacitanceTest @@ -179,22 +176,22 @@ int32_t(* InputController::RunCapacitanceTest) (uint32_t devIndex, uint32_t test 执行容值自检测试。 -启动不同检测场景下的容值自检测试，并获取测试结果，容值自检项由器件厂商自定义， 一般包括RawData测试、短路检测、开路检测、干扰检测、行列差检测等测试项。 +启动不同检测场景下的容值自检测试，并获取测试结果，容值自检项由器件厂商自定义， 一般包括RawData测试、 \* 短路检测、开路检测、干扰检测、行列差检测等测试项。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | -| testType | 输入参数，容值测试的测试类型，具体参考[CapacitanceTest](_input.md#capacitancetest)。 | +| testType | 输入参数，容值测试的测试类型，具体参考[CapacitanceTest](input.md#capacitancetest)。 | | result | 输出参数，容值测试的结果，成功则输出“SUCC”，失败则返回对应的错误提示。 | | length | 输入参数，保存容值测试结果的内存长度。 | -**返回：** +**返回:** INPUT_SUCCESS 表示执行成功。 -其他值表示执行失败，具体错误码查看[RetStatus](_input.md#retstatus)。 +其他值表示执行失败，具体错误码查看[RetStatus](input.md#retstatus)。 ### RunExtraCommand @@ -208,18 +205,18 @@ int32_t(* InputController::RunExtraCommand) (uint32_t devIndex, InputExtraCmd *c 执行拓展指令。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | | cmd | 输入参数，拓展指令数据包，包括指令编码及参数，具体参考[InputExtraCmd](_input_extra_cmd.md)。 | -**返回：** +**返回:** INPUT_SUCCESS 表示执行成功。 -其他值表示执行失败，具体错误码查看[RetStatus](_input.md#retstatus)。 +其他值表示执行失败，具体错误码查看[RetStatus](input.md#retstatus)。 ### SetGestureMode @@ -235,18 +232,18 @@ int32_t(* InputController::SetGestureMode) (uint32_t devIndex, uint32_t gestureM 上层应用开关手势模式，即设置手势模式的对应使能bit。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | | gestureMode | 输入参数，手势模式的开关状态。 | -**返回：** +**返回:** INPUT_SUCCESS 表示执行成功。 -其他值表示执行失败，具体错误码查看[RetStatus](_input.md#retstatus)。 +其他值表示执行失败，具体错误码查看[RetStatus](input.md#retstatus)。 ### SetPowerStatus @@ -262,15 +259,15 @@ int32_t(* InputController::SetPowerStatus) (uint32_t devIndex, uint32_t status) 在系统休眠或者唤醒时，Input服务或电源管理模块设置电源状态，以使驱动IC能正常进入对应的休眠模式。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | -| status | 输入参数，设置的电源状态，Input服务控制Input设备进入resume或者suspend等状态[PowerStatus](_input.md#powerstatus)。 | +| status | 输入参数，设置的电源状态，Input服务控制Input设备进入resume或者suspend等状态[PowerStatus](input.md#powerstatus)。 | -**返回：** +**返回:** INPUT_SUCCESS 表示执行成功。 -其他值表示执行失败，具体错误码查看[RetStatus](_input.md#retstatus)。 +其他值表示执行失败，具体错误码查看[RetStatus](input.md#retstatus)。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_input_dev_ability.md b/zh-cn/device-dev/reference/hdi-apis/_input_dev_ability.md index d7ec4c6686ae6b2f80a83c11b74685a1bdfcb128..09a32f7c4d89e3e74b1a3a232a213e1b5be07899 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_input_dev_ability.md +++ b/zh-cn/device-dev/reference/hdi-apis/_input_dev_ability.md @@ -3,9 +3,11 @@ ## **概述** -**所属模块:** +Input设备的能力属性，存储支持事件的位图。用位的方式来表示该Input设备能够上报的事件类型。 + +**相关模块:** -[Input](_input.md) +[Input](input.md) ## **汇总** @@ -13,184 +15,190 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [devProp](#devprop) | 设备属性 | -| [eventType](#eventtype) | 记录支持的事件类型的位图 | -| [absCode](#abscode) | 记录支持的绝对坐标的位图 | -| [relCode](#relcode) | 记录支持的相对坐标的位图 | -| [keyCode](#keycode) | 记录支持的按键值的位图 | -| [ledCode](#ledcode) | 记录设备支持的指示灯的位图 | -| [miscCode](misccode#) |记录设备支持的其他功能的位图 | -| [soundCode](#soundcode) | 记录设备支持的声音或警报的位图 | -| [forceCode](#forcecode) | 记录设备支持的作用力功能的位图 | -| [switchCode](#switchcode) | 记录设备支持的开关功能的位图 | -| [keyType](#keytype) | 按键状态的位图 | -| [ledType](#ledtype) | LED状态的位图 | -| [soundType](#soundtype) | 声音状态的位图 | -| [switchType](#switchtype) | 开关状态的位图 | - -## **详细描述** - -Input设备的能力属性，存储支持事件的位图。用位的方式来表示该Input设备能够上报的事件类型。 +| [devProp](#devprop) [[BITS_TO_UINT64](input.md#bitstouint64)(INPUT_PROP_CNT)] | 设备属性 | +| [eventType](#eventtype) [[BITS_TO_UINT64](input.md#bitstouint64)(EV_CNT)] | 记录支持的事件类型的位图 | +| [absCode](#abscode) [[BITS_TO_UINT64](input.md#bitstouint64)(ABS_CNT)] | 记录支持的绝对坐标的位图 | +| [relCode](#relcode) [[BITS_TO_UINT64](input.md#bitstouint64)(REL_CNT)] | 记录支持的相对坐标的位图 | +| [keyCode](#keycode) [[BITS_TO_UINT64](input.md#bitstouint64)(KEY_CNT)] | 记录支持的按键值的位图 | +| [ledCode](#ledcode) [[BITS_TO_UINT64](input.md#bitstouint64)(LED_CNT)] | 记录设备支持的指示灯的位图 | +| [miscCode](#misccode) [[BITS_TO_UINT64](input.md#bitstouint64)(MSC_CNT)] | 记录设备支持的其他功能的位图 | +| [soundCode](#soundcode) [[BITS_TO_UINT64](input.md#bitstouint64)(SND_CNT)] | 记录设备支持的声音或警报的位图 | +| [forceCode](#forcecode) [[BITS_TO_UINT64](input.md#bitstouint64)([HDF_FF_CNT](input.md#hdfffcnt))] | 记录设备支持的作用力功能的位图 | +| [switchCode](#switchcode) [[BITS_TO_UINT64](input.md#bitstouint64)(SW_CNT)] | 记录设备支持的开关功能的位图 | +| [keyType](#keytype) [[BITS_TO_UINT64](input.md#bitstouint64)(KEY_CNT)] | 按键状态的位图 | +| [ledType](#ledtype) [[BITS_TO_UINT64](input.md#bitstouint64)(LED_CNT)] | LED状态的位图 | +| [soundType](#soundtype) [[BITS_TO_UINT64](input.md#bitstouint64)(SND_CNT)] | 声音状态的位图 | +| [switchType](#switchtype) [[BITS_TO_UINT64](input.md#bitstouint64)(SW_CNT)] | 开关状态的位图 | ## **类成员变量说明** -### devProp - +### absCode + ``` -uint64_t InputDevAbility::devProp[BITS_TO_UINT64(INPUT_PROP_CNT)] +uint64_t InputDevAbility::absCode[BITS_TO_UINT64(ABS_CNT)] ``` **描述：** -设备属性。 - +记录支持的绝对坐标的位图 -### eventType +### devProp + ``` -uint64_t InputDevAbility::eventType[BITS_TO_UINT64(EV_CNT)] +uint64_t InputDevAbility::devProp[BITS_TO_UINT64(INPUT_PROP_CNT)] ``` **描述：** -用于记录支持的事件类型的位图。 +设备属性 -### absCode +### eventType + ``` -uint64_t InputDevAbility::absCode[BITS_TO_UINT64(ABS_CNT)] +uint64_t InputDevAbility::eventType[BITS_TO_UINT64(EV_CNT)] ``` **描述：** -记录支持的绝对坐标的位图。 +用于记录支持的事件类型的位图 -### relCode +### forceCode + ``` -uint64_t InputDevAbility::relCode[BITS_TO_UINT64(REL_CNT)] +uint64_t InputDevAbility::forceCode[BITS_TO_UINT64(HDF_FF_CNT)] ``` **描述：** -记录支持的相对坐标的位图。 +记录设备支持的作用力功能的位图 -### keyCode +### keyCode + ``` uint64_t InputDevAbility::keyCode[BITS_TO_UINT64(KEY_CNT)] ``` **描述：** -记录支持的按键值的位图。 +记录支持的按键值的位图 -### ledCode - +### keyType + ``` -uint64_t InputDevAbility::ledCode[BITS_TO_UINT64(LED_CNT)] +uint64_t InputDevAbility::keyType[BITS_TO_UINT64(KEY_CNT)] ``` **描述：** -记录设备支持的指示灯的位图。 - +按键状态的位图 -### miscCode +### ledCode + ``` -uint64_t InputDevAbility::miscCode[BITS_TO_UINT64(MSC_CNT)] +uint64_t InputDevAbility::ledCode[BITS_TO_UINT64(LED_CNT)] ``` **描述：** -记录设备支持的其他功能的位图。 - +记录设备支持的指示灯的位图 -### soundCode +### ledType + ``` -uint64_t InputDevAbility::soundCode[BITS_TO_UINT64(SND_CNT)] +uint64_t InputDevAbility::ledType[BITS_TO_UINT64(LED_CNT)] ``` **描述：** -记录设备支持的声音或警报的位图。 +led状态的位图 -### forceCode +### miscCode + ``` -uint64_t InputDevAbility::forceCode[BITS_TO_UINT64(HDF_FF_CNT)] +uint64_t InputDevAbility::miscCode[BITS_TO_UINT64(MSC_CNT)] ``` **描述：** -记录设备支持的作用力功能的位图。 +记录设备支持的其他功能的位图 -### switchCode +### relCode + ``` -uint64_t InputDevAbility::switchCode[BITS_TO_UINT64(SW_CNT)] +uint64_t InputDevAbility::relCode[BITS_TO_UINT64(REL_CNT)] ``` **描述：** -记录设备支持的开关功能的位图。 +记录支持的相对坐标的位图 -### keyType +### soundCode + ``` -uint64_t InputDevAbility::keyType[BITS_TO_UINT64(KEY_CNT)] +uint64_t InputDevAbility::soundCode[BITS_TO_UINT64(SND_CNT)] ``` **描述：** -按键状态的位图。 +记录设备支持的声音或警报的位图 -### ledType +### soundType + ``` -uint64_t InputDevAbility::ledType[BITS_TO_UINT64(LED_CNT)] +uint64_t InputDevAbility::soundType[BITS_TO_UINT64(SND_CNT)] ``` **描述：** -LED状态的位图。 +声音状态的位图 -### soundType +### switchCode + + ``` -uint64_t InputDevAbility::soundType[BITS_TO_UINT64(SND_CNT)] +uint64_t InputDevAbility::switchCode[BITS_TO_UINT64(SW_CNT)] ``` **描述：** -声音状态的位图。 +记录设备支持的开关功能的位图 + ### switchType + ``` uint64_t InputDevAbility::switchType[BITS_TO_UINT64(SW_CNT)] ``` **描述：** -开关状态的位图。 - +开关状态的位图 diff --git a/zh-cn/device-dev/reference/hdi-apis/_input_dev_attr.md b/zh-cn/device-dev/reference/hdi-apis/_input_dev_attr.md index d6dcb2b37936249aeae66af38131a56c27019797..27ffb8c84c6882fdecde230d24023d0ead5bade6 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_input_dev_attr.md +++ b/zh-cn/device-dev/reference/hdi-apis/_input_dev_attr.md @@ -3,9 +3,11 @@ ## **概述** -**所属模块:** +Input设备属性。 + +**相关模块:** -[Input](_input.md) +[Input](input.md) ## **汇总** @@ -13,46 +15,47 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [devName](#devname) | 设备名 | +| [devName](#devname) [DEV_NAME_LEN] | 设备名 | | [id](#id) | 设备识别信息 | -| [axisInfo](#axisinfo) | 设备维度信息 | - -## **详细描述** - -Input设备属性。 +| [axisInfo](#axisinfo) [ABS_CNT] | 设备维度信息 | ## **类成员变量说明** -### devName +### axisInfo + ``` -char InputDevAttr::devName[DEV_NAME_LEN] +InputDimensionInfo InputDevAttr::axisInfo[ABS_CNT] ``` **描述：** -设备名。 +设备维度信息 -### id +### devName + + ``` -InputDevIdentify InputDevAttr::id +char InputDevAttr::devName[DEV_NAME_LEN] ``` **描述：** -设备识别信息。 +设备名 -### axisInfo +### id + + ``` -InputDimensionInfo InputDevAttr::axisInfo[ABS_CNT]; +InputDevIdentify InputDevAttr::id ``` **描述：** -设备维度信息。 \ No newline at end of file +设备识别信息 diff --git a/zh-cn/device-dev/reference/hdi-apis/_input_dev_desc.md b/zh-cn/device-dev/reference/hdi-apis/_input_dev_desc.md index e2fbf7cf662776f9017cf4f4d17ae6114251b435..89b51c3c3dde76f178fcee194062fde0dea4d740 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_input_dev_desc.md +++ b/zh-cn/device-dev/reference/hdi-apis/_input_dev_desc.md @@ -3,9 +3,11 @@ ## **概述** -**所属模块:** +Input设备描述信息。 + +**相关模块:** -[Input](_input.md) +[Input](input.md) ## **汇总** @@ -13,15 +15,10 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [devIndex](#devindex) | 设备索引 | -| [devType](#devtype) | 设备类型 | - - -## **详细描述** - -Input设备描述信息。 +| [devIndex](#devindex) | 设备索引。 | +| [devType](#devtype) | 设备类型。 | ## **类成员变量说明** @@ -29,23 +26,23 @@ Input设备描述信息。 ### devIndex - -```cpp + +``` uint32_t InputDevDesc::devIndex ``` **描述：** -设备索引。 +设备索引 ### devType - -```cpp + +``` uint32_t InputDevDesc::devType ``` **描述：** -设备类型。 +设备类型 diff --git a/zh-cn/device-dev/reference/hdi-apis/_input_dev_identify.md b/zh-cn/device-dev/reference/hdi-apis/_input_dev_identify.md index 76839b56e7950a86e5232ea388b0e92fe7e3b142..1470ec653c305b4fc2d1fe79aba276a557ea4c30 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_input_dev_identify.md +++ b/zh-cn/device-dev/reference/hdi-apis/_input_dev_identify.md @@ -3,9 +3,11 @@ ## **概述** -**所属模块:** +Input设备的识别信息。 + +**相关模块:** -[Input](_input.md) +[Input](input.md) ## **汇总** @@ -13,16 +15,12 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | | [busType](#bustype) | 总线类型 | | [vendor](#vendor) | 生产商编号 | -| [product](#product) | 产品编号 | -| [version](#version) | 版本号 | - -## **详细描述** - -Input设备的识别信息。 +| [product](#product) | 产品编号 | +| [version](#version) | 版本号 | ## **类成员变量说明** @@ -30,40 +28,47 @@ Input设备的识别信息。 ### busType -```cpp + +``` uint16_t InputDevIdentify::busType ``` **描述：** -总线类型。 +总线类型 -### vendor -```cpp -uint16_t InputDevIdentify::vendor +### product + + +``` +uint16_t InputDevIdentify::product ``` **描述：** -生产商编号。 +产品编号 -### product -```cpp -uint16_t InputDevIdentify::product +### vendor + + +``` +uint16_t InputDevIdentify::vendor ``` **描述：** -产品编号。 +生产商编号 + ### version -```cpp + +``` uint16_t InputDevIdentify::version ``` **描述：** -版本号。 +版本号 diff --git a/zh-cn/device-dev/reference/hdi-apis/_device_info.md b/zh-cn/device-dev/reference/hdi-apis/_input_device_info.md similarity index 68% rename from zh-cn/device-dev/reference/hdi-apis/_device_info.md rename to zh-cn/device-dev/reference/hdi-apis/_input_device_info.md index d70dedd1806bb2b2c392c58f0ed8e4bca5deaed2..46d0ccbb683ebbeff26b184da4525c295562f601 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_device_info.md +++ b/zh-cn/device-dev/reference/hdi-apis/_input_device_info.md @@ -3,9 +3,11 @@ ## **概述** -**所属模块:** +Input设备基础设备信息。 + +**相关模块:** -[Input](_input.md) +[Input](input.md) ## **汇总** @@ -13,106 +15,99 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [devIndex](#devindex) | 设备索引 | -| [devType](#devtype) | 设备类型 | +| [devIndex](#devindex) | 设备索引 | +| [devType](#devtype) | 设备类型 | | [chipInfo](#chipinfo) [CHIP_INFO_LEN] | 驱动芯片编码信息 | -| [vendorName](#vendorname) [VENDOR_NAME_LEN] | 模组厂商名 | +| [vendorName](#vendorname) [VENDOR_NAME_LEN] | 模组厂商名 | | [chipName](#chipname) [CHIP_NAME_LEN] | 驱动芯片型号 | -| [attrSet](#attrset)| 设备属性。 | -| [abilitySet](#abilityset)| 设备能力属性。| - - - -## **详细描述** - -Input设备基础设备信息。 +| [attrSet](#attrset) | 设备属性 | +| [abilitySet](#abilityset) | 设备能力属性 | ## **类成员变量说明** -### chipInfo +### abilitySet ``` -char InputDeviceInfo::chipInfo[CHIP_INFO_LEN] +InputDevAbility InputDeviceInfo::abilitySet ``` **描述：** -驱动芯片编码信息。 +设备能力属性 -### chipName +### attrSet ``` -char InputDeviceInfo::chipName[CHIP_NAME_LEN] +InputDevAttr InputDeviceInfo::attrSet ``` **描述：** -驱动芯片型号。 +设备属性 -### devIndex +### chipInfo ``` -uint32_t InputDeviceInfo::devIndex +char InputDeviceInfo::chipInfo[CHIP_INFO_LEN] ``` **描述：** -设备索引。 - +驱动芯片编码信息 -### devType +### chipName ``` -uint32_t InputDeviceInfo::devType +char InputDeviceInfo::chipName[CHIP_NAME_LEN] ``` **描述：** -设备类型。 +驱动芯片型号 -### vendorName +### devIndex ``` -char InputDeviceInfo::vendorName[VENDOR_NAME_LEN] +uint32_t InputDeviceInfo::devIndex ``` **描述：** -模组厂商名。 +设备索引 -### attrSet +### devType ``` -InputDevAttr InputDeviceInfo::attrSet +uint32_t InputDeviceInfo::devType ``` **描述：** -设备属性。 +设备类型 -### abilitySet +### vendorName ``` -InputDevAbility InputDeviceInfo::abilitySet +char InputDeviceInfo::vendorName[VENDOR_NAME_LEN] ``` **描述：** -设备能力属性。 \ No newline at end of file +模组厂商名 diff --git a/zh-cn/device-dev/reference/hdi-apis/_input_dimension_info.md b/zh-cn/device-dev/reference/hdi-apis/_input_dimension_info.md index bdbbdbd5d33b9886691cbedfa742fa432c43f34e..16919c614433d3d3781a4618a1aafb2d04a49272 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_input_dimension_info.md +++ b/zh-cn/device-dev/reference/hdi-apis/_input_dimension_info.md @@ -3,9 +3,11 @@ ## **概述** -**所属模块:** +Input设备的维度信息。 + +**相关模块:** -[Input](_input.md) +[Input](input.md) ## **汇总** @@ -13,18 +15,14 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | | [axis](#axis) | 坐标轴 | | [min](#min) | 记录各个坐标的最小值 | -| [max](#max) | 记录各个坐标的最大值 | -| [fuzz](#fuzz) | 记录各个坐标的分辨率 | -| [flat](#flat) | 记录各个坐标的基准值 | -| [range](#range) | 范围 | - -## **详细描述** - -Input设备的维度信息。 +| [max](#max) | 记录各个坐标的最大值 | +| [fuzz](#fuzz) | 记录各个坐标的分辨率 | +| [flat](#flat) | 记录各个坐标的基准值 | +| [range](#range) | 范围 | ## **类成员变量说明** @@ -32,60 +30,71 @@ Input设备的维度信息。 ### axis + ``` int32_t InputDimensionInfo::axis ``` **描述：** -坐标轴。 +坐标轴 -### min +### flat + + ``` -int32_t InputDimensionInfo::min +int32_t InputDimensionInfo::flat ``` **描述：** -记录各个坐标的最小值。 +记录各个坐标的基准值 -### max +### fuzz + + ``` -int32_t InputDimensionInfo::max +int32_t InputDimensionInfo::fuzz ``` **描述：** -记录各个坐标的最大值。 +记录各个坐标的分辨率 -### fuzz +### max + + ``` -int32_t InputDimensionInfo::fuzz +int32_t InputDimensionInfo::max ``` **描述：** -记录各个坐标的分辨率。 +记录各个坐标的最大值 -### flat +### min + + ``` -int32_t InputDimensionInfo::flat +int32_t InputDimensionInfo::min ``` **描述：** -记录各个坐标的基准值。 +记录各个坐标的最小值 + ### range + ``` int32_t InputDimensionInfo::range ``` **描述：** -范围。 \ No newline at end of file +范围 diff --git a/zh-cn/device-dev/reference/hdi-apis/_input_event_cb.md b/zh-cn/device-dev/reference/hdi-apis/_input_event_cb.md new file mode 100644 index 0000000000000000000000000000000000000000..b91f20bfafd8c53c43ce9a481a9d368572730044 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_input_event_cb.md @@ -0,0 +1,43 @@ +# InputEventCb + + +## **概述** + +此结构体定义了输入事件回调函数并提供给Input服务使用。 + +**相关模块:** + +[Input](input.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| ([EventPkgCallback](#eventpkgcallback) )(const [InputEventPackage](_input_event_package.md) \*\*pkgs, uint32_t count, uint32_t devIndex) | 输入事件数据上报的回调函数。 | + + +## **类成员变量说明** + + +### EventPkgCallback + + +``` +void(* InputEventCb::EventPkgCallback) (const InputEventPackage **pkgs, uint32_t count, uint32_t devIndex) +``` + +**描述：** + +输入事件数据上报的回调函数。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| eventData | 输入参数，驱动上报的Input事件数据。 | +| count | 输入参数，Input事件数据包的个数。 | +| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_event_package.md b/zh-cn/device-dev/reference/hdi-apis/_input_event_package.md similarity index 75% rename from zh-cn/device-dev/reference/hdi-apis/_event_package.md rename to zh-cn/device-dev/reference/hdi-apis/_input_event_package.md index d044d04799d0a1a4c8c726025cbb3624db1a7bf5..402db456d3bfe64396d9441dc458292e260e9a18 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_event_package.md +++ b/zh-cn/device-dev/reference/hdi-apis/_input_event_package.md @@ -3,9 +3,11 @@ ## **概述** -**所属模块:** +Input事件数据包结构。 + +**相关模块:** -[Input](_input.md) +[Input](input.md) ## **汇总** @@ -13,7 +15,7 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | | [type](#type) | 输入事件的属性 | | [code](#code) | 输入事件的特定编码项 | @@ -21,11 +23,6 @@ | [timestamp](#timestamp) | 输入事件对应的时间戳 | -## **详细描述** - -Input事件数据包结构。 - - ## **类成员变量说明** @@ -33,7 +30,7 @@ Input事件数据包结构。 ``` -uint32_t EventPackage::code +uint32_t InputEventPackage::code ``` **描述：** @@ -45,7 +42,7 @@ uint32_t EventPackage::code ``` -uint64_t EventPackage::timestamp +uint64_t InputEventPackage::timestamp ``` **描述：** @@ -57,7 +54,7 @@ uint64_t EventPackage::timestamp ``` -uint32_t EventPackage::type +uint32_t InputEventPackage::type ``` **描述：** @@ -69,7 +66,7 @@ uint32_t EventPackage::type ``` -int32_t EventPackage::value +int32_t InputEventPackage::value ``` **描述：** diff --git a/zh-cn/device-dev/reference/hdi-apis/_input_extra_cmd.md b/zh-cn/device-dev/reference/hdi-apis/_input_extra_cmd.md index 56083e65b9a4c823d7c5fc42cc29ddbd3b910228..15f6265f62ba0cbecfe9168947ea9d38d228de6d 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_input_extra_cmd.md +++ b/zh-cn/device-dev/reference/hdi-apis/_input_extra_cmd.md @@ -3,9 +3,11 @@ ## **概述** -**所属模块:** +扩展指令的数据结构。 + +**相关模块:** -[Input](_input.md) +[Input](input.md) ## **汇总** @@ -13,17 +15,12 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | | [cmdCode](#cmdcode) | 指令对应的编码。 | | [cmdValue](#cmdvalue) | 指令传输的数据。 | -## **详细描述** - -扩展指令的数据结构。 - - ## **类成员变量说明** diff --git a/zh-cn/device-dev/reference/hdi-apis/_input_host_cb.md b/zh-cn/device-dev/reference/hdi-apis/_input_host_cb.md index 372d6d7847b87f3d69a034e382093462d778e26e..9fa62eb2d7cb0ddf78799b6be36ac01ec01ec69d 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_input_host_cb.md +++ b/zh-cn/device-dev/reference/hdi-apis/_input_host_cb.md @@ -3,9 +3,11 @@ ## **概述** -**所属模块:** +此结构体定义了热插拔事件上报回调函数并提供给Input服务使用。 + +**相关模块:** -[Input](_input.md) +[Input](input.md) ## **汇总** @@ -13,32 +15,24 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| ( [HotPlugCallback](#hotplugcallback) ) (const [InputHotPlugEvent](_input_hotplug_event.md) \*event) | 热插拔事件上报的回调函数。 [更多...](#hotplugcallback) | - - -## **详细描述** - -此结构体定义了热插拔事件上报回调函数并提供给Input服务使用。 - - -## **类成员变量说明** +| ([HotPlugCallback](#hotplugcallback) )(const [InputHotPlugEvent](_input_hot_plug_event.md) \*event) | 热插拔事件上报的回调函数。 | ### HotPlugCallback - + ``` -void (* InputHostCb::HotPlugCallback) (const InputHotPlugEvent* event); +void(* InputHostCb::HotPlugCallback) (const InputHotPlugEvent *event) ``` **描述：** 热插拔事件上报的回调函数。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | -| event | 输入参数，上报的热插拔事件数据。 | \ No newline at end of file +| event | 输入参数，上报的热插拔事件数据。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_input_hotplug_event.md b/zh-cn/device-dev/reference/hdi-apis/_input_hot_plug_event.md similarity index 59% rename from zh-cn/device-dev/reference/hdi-apis/_input_hotplug_event.md rename to zh-cn/device-dev/reference/hdi-apis/_input_hot_plug_event.md index 1bfe63ea8dbf62d5577191ab8c18ca4fa4af7096..120da873657221d2f2301b1f9caa4d8e7ec76543 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_input_hotplug_event.md +++ b/zh-cn/device-dev/reference/hdi-apis/_input_hot_plug_event.md @@ -3,9 +3,11 @@ ## **概述** -**所属模块:** +热插拔事件数据包结构。 + +**相关模块:** -[Input](_input.md) +[Input](input.md) ## **汇总** @@ -13,16 +15,11 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [devIndex](#devindex) | 设备索引 | -| [devType](#devtype) | 设备类型 | -| [status](#status) | 设备状态| - - -## **详细描述** - -热插拔事件数据包结构。 +| [devIndex](#devindex) | 设备索引。 | +| [devType](#devtype) | 设备类型。 | +| [status](#status) | 设备状态。 | ## **类成员变量说明** @@ -30,31 +27,31 @@ ### devIndex - + ``` uint32_t InputHotPlugEvent::devIndex ``` **描述：** -设备索引。 +设备索引 ### devType - + ``` uint32_t InputHotPlugEvent::devType ``` **描述：** -设备类型。 +设备类型 ### status - + ``` uint32_t InputHotPlugEvent::status ``` @@ -62,5 +59,5 @@ uint32_t InputHotPlugEvent::status **描述：** 设备状态。 -- 1：离线 -- 0：在线。 + +1: 离线。 0: 在线。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_input_manager.md b/zh-cn/device-dev/reference/hdi-apis/_input_manager.md index 6f9a062e8fc5bec538ce8dcb044c1d0eb5fd0859..f3ba8b6b97959e9cc7cde4292f23be594c589155 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_input_manager.md +++ b/zh-cn/device-dev/reference/hdi-apis/_input_manager.md @@ -3,9 +3,13 @@ ## **概述** -**所属模块:** +提供Input设备管理相关的接口。 + +此类接口包含Input设备的扫描、打开和关闭、特定设备信息查询，以及所有设备列表信息获取等接口。 -[Input](_input.md) +**相关模块:** + +[Input](input.md) ## **汇总** @@ -13,20 +17,13 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| ( [ScanInputDevice](#scaninputdevice) )(DevDesc \*staArr, uint32_t arrLen) | Input服务用于扫描所有在线设备。 [更多...](#scaninputdevice) | -| ( [OpenInputDevice](#openinputdevice) )(uint32_t devIndex) | Input服务打开对应设备的设备文件 [更多...](#openinputdevice) | -| ( [CloseInputDevice](#closeinputdevice) )(uint32_t devIndex) | Input服务关闭对应设备的设备文件 [更多...](#closeinputdevice) | -| ( [GetInputDevice](#getinputdevice) )(uint32_t devIndex, [InputDeviceInfo](_device_info.md) \*\*devInfo) | Input服务获取对应ID的设备信息 [更多...](#getinputdevice) | -| ( [GetInputDeviceList](#getinputdevicelist) )(uint32_t \*devNum, [InputDeviceInfo](_device_info.md) \*\*devList, uint32_t size) | Input服务获取所有Input设备列表的设备信息 [更多...](#getinputdevicelist) | - - -## **详细描述** - -提供Input设备管理相关的接口。 - -此类接口包含Input设备的扫描、打开和关闭、特定设备信息查询，以及所有设备列表信息获取等。 +| ([ScanInputDevice](#scaninputdevice) )([InputDevDesc](_input_dev_desc.md) \*staArr, uint32_t arrLen) | Input服务用于扫描所有在线设备。 | +| ([OpenInputDevice](#openinputdevice) )(uint32_t devIndex) | Input服务打开对应设备的设备文件。 | +| ([CloseInputDevice](#closeinputdevice) )(uint32_t devIndex) | Input服务关闭对应设备的设备文件。 | +| ([GetInputDevice](#getinputdevice) )(uint32_t devIndex, [InputDeviceInfo](_input_device_info.md) \*\*devInfo) | Input服务获取对应ID的设备信息。 | +| ([GetInputDeviceList](#getinputdevicelist) )(uint32_t \*devNum, [InputDeviceInfo](_input_device_info.md) \*\*devList, uint32_t size) | Input服务获取所有Input设备列表的设备信息。 | ## **类成员变量说明** @@ -35,7 +32,7 @@ ### CloseInputDevice -```cpp +``` int32_t(* InputManager::CloseInputDevice) (uint32_t devIndex) ``` @@ -43,23 +40,23 @@ int32_t(* InputManager::CloseInputDevice) (uint32_t devIndex) Input服务关闭对应设备的设备文件。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | -| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。| +| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | -**返回：** +**返回:** INPUT_SUCCESS 表示执行成功。 -其他值表示执行失败，具体错误码查看[RetStatus](_input.md#retstatus)。 +其他值表示执行失败，具体错误码查看[RetStatus](input.md#retstatus)。 ### GetInputDevice -```cpp +``` int32_t(* InputManager::GetInputDevice) (uint32_t devIndex, InputDeviceInfo **devInfo) ``` @@ -67,24 +64,24 @@ int32_t(* InputManager::GetInputDevice) (uint32_t devIndex, InputDeviceInfo **de Input服务获取对应ID的设备信息。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | -| devInfo | 输出参数，即devIndex对应的设备的设备信息，具体参考[InputDeviceInfo](_device_info.md)。 | +| devInfo | 输出参数，即devIndex对应的设备的设备信息，具体参考[InputDeviceInfo](_input_device_info.md)。 | -**返回：** +**返回:** INPUT_SUCCESS 表示执行成功。 -其他值表示执行失败，具体错误码查看[RetStatus](_input.md#retstatus)。 +其他值表示执行失败，具体错误码查看[RetStatus](input.md#retstatus)。 ### GetInputDeviceList -```cpp +``` int32_t(* InputManager::GetInputDeviceList) (uint32_t *devNum, InputDeviceInfo **devList, uint32_t size) ``` @@ -92,25 +89,25 @@ int32_t(* InputManager::GetInputDeviceList) (uint32_t *devNum, InputDeviceInfo * Input服务获取所有Input设备列表的设备信息。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | devNum | 输出参数，当前已经注册过的所有Input设备的总数。 | -| devList | 输出参数，Input设备列表所对应的设备信息，具体参考[InputDeviceInfo](_device_info.md)。 | -| size | 输入参数，即指定deviceList数组对应的元素个数。| +| devList | 输出参数，Input设备列表所对应的设备信息，具体参考[InputDeviceInfo](_input_device_info.md)。 | +| size | 输入参数，即指定deviceList数组对应的元素个数。 | -返回： +**返回:** INPUT_SUCCESS 表示执行成功。 -其他值表示执行失败，具体错误码查看[RetStatus](_input.md#retstatus)。 +其他值表示执行失败，具体错误码查看[RetStatus](input.md#retstatus)。 ### OpenInputDevice -```cpp +``` int32_t(* InputManager::OpenInputDevice) (uint32_t devIndex) ``` @@ -118,23 +115,23 @@ int32_t(* InputManager::OpenInputDevice) (uint32_t devIndex) Input服务打开对应设备的设备文件。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | -**返回：** +**返回:** INPUT_SUCCESS 表示执行成功。 -其他值表示执行失败，具体错误码查看[RetStatus](_input.md#retstatus)。 +其他值表示执行失败，具体错误码查看[RetStatus](input.md#retstatus)。 ### ScanInputDevice -```cpp +``` int32_t(* InputManager::ScanInputDevice) (InputDevDesc *staArr, uint32_t arrLen) ``` @@ -142,15 +139,15 @@ int32_t(* InputManager::ScanInputDevice) (InputDevDesc *staArr, uint32_t arrLen) Input服务用于扫描所有在线设备。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | staArr | 输出参数，存放Input设备扫描信息的数组，信息包含设备索引以及设备类型。 | | arrLen | 输入参数，staArr数组的长度信息。 | -**返回：** +**返回:** INPUT_SUCCESS 表示执行成功。 -其他值表示执行失败，具体错误码查看[RetStatus](_input.md#retstatus)。 +其他值表示执行失败，具体错误码查看[RetStatus](input.md#retstatus)。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_input_report_event_cb.md b/zh-cn/device-dev/reference/hdi-apis/_input_report_event_cb.md deleted file mode 100644 index b6dd9371652a5af31acba24509d9bc040d8fe6c7..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_input_report_event_cb.md +++ /dev/null @@ -1,47 +0,0 @@ -# InputEventCb - - -## **概述** - -**所属模块:** - -[Input](_input.md) - - -## **汇总** - - -### Public 属性 - - | Public 属性 | 描述 | -| -------- | -------- | -| ( [EventPkgCallback](#eventpkgcallback) )(const [InputEventPackage](_event_package.md) \*\*pkgs, uint32_t count, uint32_t devIndex) | 输入事件数据上报的回调函数。 [更多...](#eventpkgcallback) | - - -## **详细描述** - -此结构体定义了输入事件回调函数并提供给Input服务使用。 - - -## **类成员变量说明** - - -### EventPkgCallback - - -``` -void (* InputEventCb::EventPkgCallback)(const InputEventPackage **pkgs, uint32_t count, uint32_t devIndex); -``` - -**描述：** - -输入事件数据上报的回调函数。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| pkgs| 驱动上报的Input事件数据。 | -| count | Input事件数据包的个数。 | -| devIndex | Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | - diff --git a/zh-cn/device-dev/reference/hdi-apis/_input_reporter.md b/zh-cn/device-dev/reference/hdi-apis/_input_reporter.md index c940b505e9afd0e810da168a011514479fc285d6..05a265bcd9663ff490143df88032c8cc19bf972a 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_input_reporter.md +++ b/zh-cn/device-dev/reference/hdi-apis/_input_reporter.md @@ -3,9 +3,13 @@ ## **概述** -**所属模块:** +提供Input设备数据上报相关的接口。 + +此类接口包含input设备的数据上报回调函数的注册和注销。 -[Input](_input.md) +**相关模块:** + +[Input](input.md) ## **汇总** @@ -13,19 +17,12 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| ( [RegisterReportCallback](#registerreportcallback) )(uint32_t devIndex, [InputEventCb](_input_report_event_cb.md) \*callback) | 注册对应设备的回调函数。 [更多...](#registerreportcallback) | -| ( [UnregisterReportCallback](#unregisterreportcallback) )(uint32_t devIndex) | 注销对应设备的回调函数。 [更多...](#unregisterreportcallback) | -| ( [RegisterHotPlugCallback](#registerhotplugcallback) )([InputHostCb](_input_host_cb.md) \*callback) | 注册Input设备的热插拔回调函数。 [更多...](#registerhotplugcallback) | -| ( [UnregisterHotPlugCallback](#unregisterhotplugcallback) )(void) | 注销Input设备的热插拔回调函数。 [更多...](#unregisterhotplugcallback) | - - -## **详细描述** - -提供Input设备数据上报相关的接口。 - -此类接口包含Input设备的数据上报回调函数的注册和注销。 +| ([RegisterReportCallback](#registerreportcallback) )(uint32_t devIndex, [InputEventCb](_input_event_cb.md) \*callback) | 注册对应设备的回调函数。 | +| ([UnregisterReportCallback](#unregisterreportcallback) )(uint32_t devIndex) | 注销对应设备的回调函数。 | +| ([RegisterHotPlugCallback](#registerhotplugcallback) )([InputHostCb](_input_host_cb.md) \*callback) | 注册Input设备的热插拔回调函数。 | +| ([UnregisterHotPlugCallback](#unregisterhotplugcallback) )(void) | 注销Input设备的热插拔回调函数。 | ## **类成员变量说明** @@ -34,7 +31,7 @@ ### RegisterHotPlugCallback -```cpp +``` int32_t(* InputReporter::RegisterHotPlugCallback) (InputHostCb *callback) ``` @@ -44,23 +41,23 @@ int32_t(* InputReporter::RegisterHotPlugCallback) (InputHostCb *callback) Input服务通过此接口注册回调函数到hdi中，所有Input设备由此函数进行热插拔事件上报。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | callback | 输入参数，回调函数的函数指针。 | -**返回：** +**返回:** INPUT_SUCCESS 表示执行成功。 -其他值表示执行失败，具体错误码查看[RetStatus](_input.md#retstatus)。 +其他值表示执行失败，具体错误码查看[RetStatus](input.md#retstatus)。 ### RegisterReportCallback -```cpp +``` int32_t(* InputReporter::RegisterReportCallback) (uint32_t devIndex, InputEventCb *callback) ``` @@ -70,24 +67,24 @@ int32_t(* InputReporter::RegisterReportCallback) (uint32_t devIndex, InputEventC Input服务通过此接口注册数据回调函数到hdi中，hdi通过此回调函数上报Input事件。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | | callback | 输入参数，回调函数的函数指针。 | -**返回：** +**返回:** INPUT_SUCCESS 表示执行成功。 -其他值表示执行失败，具体错误码查看[RetStatus](_input.md#retstatus)。 +其他值表示执行失败，具体错误码查看[RetStatus](input.md#retstatus)。 ### UnregisterHotPlugCallback -```cpp +``` int32_t(* InputReporter::UnregisterHotPlugCallback) (void) ``` @@ -95,17 +92,17 @@ int32_t(* InputReporter::UnregisterHotPlugCallback) (void) 注销Input设备的热插拔回调函数。 -**返回：** +**返回:** INPUT_SUCCESS 表示执行成功。 -其他值表示执行失败，具体错误码查看[RetStatus](_input.md#retstatus)。 +其他值表示执行失败，具体错误码查看[RetStatus](input.md#retstatus)。 ### UnregisterReportCallback -```cpp +``` int32_t(* InputReporter::UnregisterReportCallback) (uint32_t devIndex) ``` @@ -113,14 +110,14 @@ int32_t(* InputReporter::UnregisterReportCallback) (uint32_t devIndex) 注销对应设备的回调函数。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | -| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。| +| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | -**返回：** +**返回:** INPUT_SUCCESS 表示执行成功。 -其他值表示执行失败，具体错误码查看[RetStatus](_input.md#retstatus)。 +其他值表示执行失败，具体错误码查看[RetStatus](input.md#retstatus)。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_layer_alpha.md b/zh-cn/device-dev/reference/hdi-apis/_layer_alpha.md index 9dc52678aecefe62852b3c53f430b051c1f39bb0..2e941168a2d4917bc64becf9fea5d23769db931e 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_layer_alpha.md +++ b/zh-cn/device-dev/reference/hdi-apis/_layer_alpha.md @@ -3,7 +3,9 @@ ## **概述** -**所属模块:** +定义图层Alpha信息的结构体。 + +**相关模块:** [Display](_display.md) @@ -13,15 +15,10 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [enGlobalAlpha](_display.md#englobalalpha-12) | 全局alpha使能标志 | -| [enPixelAlpha](_display.md#enpixelalpha-12) | 像素alpha使能标志 | -| [alpha0](_display.md#alpha0-12) | alpha0值，取值范围：[0, 255] | -| [alpha1](_display.md#alpha1-12) | alpha1值，取值范围：[0, 255] | -| [gAlpha](_display.md#galpha) | 全局alpha值，取值范围：[0, 255] | - - -## **详细描述** - -定义图层Alpha信息的结构体。 +| [enGlobalAlpha](_display.md#englobalalpha-12) | 全局Alpha使能标志 | +| [enPixelAlpha](_display.md#enpixelalpha-12) | 像素Alpha使能标志 | +| [alpha0](_display.md#alpha0-12) | Alpha0值，取值范围：[0, 255] | +| [alpha1](_display.md#alpha1-12) | Alpha1值，取值范围：[0, 255] | +| [gAlpha](_display.md#galpha) | 全局Alpha值，取值范围：[0, 255] | diff --git a/zh-cn/device-dev/reference/hdi-apis/_layer_buffer.md b/zh-cn/device-dev/reference/hdi-apis/_layer_buffer.md index 179aa36a396027e7cbae879faf591dcbfc977550..6f19f9bbb6d40719f9c9725735b455b0577bb6fe 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_layer_buffer.md +++ b/zh-cn/device-dev/reference/hdi-apis/_layer_buffer.md @@ -3,7 +3,9 @@ ## **概述** -**所属模块:** +图层Buffer，用于存放图层数据。 + +**相关模块:** [Display](_display.md) @@ -13,17 +15,12 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | | [fenceId](_display.md#fenceid) | buffer的fence号 | -| [width](_display.md#width-37) | buffer宽度 | -| [height](_display.md#height-37) | buffer高度 | +| [width](_display.md#width-39) | buffer宽度 | +| [height](_display.md#height-38) | buffer高度 | | [pitch](_display.md#pitch) | 一行数据所占字节数 | | [pixFormat](_display.md#pixformat-22) | 图层像素格式 | -| [data](_display.md#data) | 图层buffer数据 | +| [data](_display.md#data-12) | 图层buffer数据 | | [hdl](_display.md#hdl) | 图层buffer句柄 | - - -## **详细描述** - -图层Buffer，用于存放图层数据。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_layer_funcs.md b/zh-cn/device-dev/reference/hdi-apis/_layer_funcs.md index 6868d6a8388fc43ef53e245a960504741a1ebf6c..95fb4bf8040f3a5fac4b3ba9eab25ce0b900d31d 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_layer_funcs.md +++ b/zh-cn/device-dev/reference/hdi-apis/_layer_funcs.md @@ -3,7 +3,9 @@ ## **概述** -**所属模块:** +显示图层驱动接口结构体，定义显示图层驱动接口函数指针。 + +**相关模块:** [Display](_display.md) @@ -13,55 +15,50 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| ( [InitDisplay](#initdisplay) )(uint32_t devId) | 初始化显示设备。 [更多...](#initdisplay) | -| ( [DeinitDisplay](#deinitdisplay) )(uint32_t devId) | 取消初始化显示设备。 [更多...](#deinitdisplay) | -| ( [GetDisplayInfo](#getdisplayinfo) )(uint32_t devId, [DisplayInfo](_display_info.md) \*dispInfo) | 获取显示设备相关信息。 [更多...](#getdisplayinfo) | -| ( [CreateLayer](#createlayer) )(uint32_t devId, const [LayerInfo](_layer_info.md) \*layerInfo, uint32_t \*layerId) | 打开图层。 [更多...](#createlayer) | -| ( [CloseLayer](#closelayer) )(uint32_t devId, uint32_t layerId) | 关闭图层。 [更多...](#closelayer) | -| ( [SetLayerVisible](#setlayervisible) )(uint32_t devId, uint32_t layerId, bool visible) | 设置图层是否可见。 [更多...](#setlayervisible) | -| ( [GetLayerVisibleState](#getlayervisiblestate) )(uint32_t devId, uint32_t layerId, bool \*visible) | 获取图层是否可见状态。 [更多...](#getlayervisiblestate) | -| ( [SetLayerSize](#setlayersize) )(uint32_t devId, uint32_t layerId, [IRect](_i_rect.md) \*rect) | 设置图层大小。 [更多...](#setlayersize) | -| ( [GetLayerSize](#getlayersize) )(uint32_t devId, uint32_t layerId, [IRect](_i_rect.md) \*rect) | 获取图层大小。 [更多...](#getlayersize) | -| ( [SetLayerCrop](#setlayercrop) )(uint32_t devId, uint32_t layerId, [IRect](_i_rect.md) \*rect) | 设置图层裁剪区域。 [更多...](#setlayercrop) | -| ( [SetLayerZorder](#setlayerzorder) )(uint32_t devId, uint32_t layerId, uint32_t zorder) | 设置图层Z轴次序。 [更多...](#setlayerzorder) | -| ( [GetLayerZorder](#getlayerzorder) )(uint32_t devId, uint32_t layerId, uint32_t \*zorder) | 获取图层Z轴次序。 [更多...](#getlayerzorder) | -| ( [SetLayerPreMulti](#setlayerpremulti) )(uint32_t devId, uint32_t layerId, bool preMul) | 设置图层预乘。 [更多...](#setlayerpremulti) | -| ( [GetLayerPreMulti](#getlayerpremulti) )(uint32_t devId, uint32_t layerId, bool \*preMul) | 获取图层预乘标识。 [更多...](#getlayerpremulti) | -| ( [SetLayerAlpha](#setlayeralpha) )(uint32_t devId, uint32_t layerId, [LayerAlpha](_layer_alpha.md) \*alpha) | 设置图层alpha值。 [更多...](#setlayeralpha) | -| ( [GetLayerAlpha](#getlayeralpha) )(uint32_t devId, uint32_t layerId, [LayerAlpha](_layer_alpha.md) \*alpha) | 获取图层alpha值。 [更多...](#getlayeralpha) | -| ( [SetLayerColorKey](#setlayercolorkey) )(uint32_t devId, uint32_t layerId, bool enable, uint32_t key) | 设置图层colorkey属性,在图层叠加时使用。 [更多...](#setlayercolorkey) | -| ( [GetLayerColorKey](#getlayercolorkey) )(uint32_t devId, uint32_t layerId, bool \*enable, uint32_t \*key) | 获取图层colorkey。 [更多...](#getlayercolorkey) | -| ( [SetLayerPalette](#setlayerpalette) )(uint32_t devId, uint32_t layerId, uint32_t \*palette, uint32_t len) | 设置图层调色板。 [更多...](#setlayerpalette) | -| ( [GetLayerPalette](#getlayerpalette) )(uint32_t devId, uint32_t layerId, uint32_t \*palette, uint32_t len) | 获取图层调色板。 [更多...](#getlayerpalette) | -| ( [SetTransformMode](#settransformmode) )(uint32_t devId, uint32_t layerId, [TransformType](_display.md#transformtype) type) | 设置图层变换模式，根据不同的场景设置图层的旋转、缩放、移位等。 [更多...](#settransformmode) | -| ( [SetLayerCompression](#setlayercompression) )(uint32_t devId, uint32_t layerId, int32_t compType) | 设置图层压缩功能 [更多...](#setlayercompression) | -| ( [GetLayerCompression](#getlayercompression) )(uint32_t devId, uint32_t layerId, int32_t \*compType) | 获取图层压缩功能是否打开。 [更多...](#getlayercompression) | -| ( [SetLayerDirtyRegion](#setlayerdirtyregion) )(uint32_t devId, uint32_t layerId, [IRect](_i_rect.md) \*region) | 设置图层刷新区域。 [更多...](#setlayerdirtyregion) | -| ( [GetLayerBuffer](#getlayerbuffer) )(uint32_t devId, uint32_t layerId, [LayerBuffer](_layer_buffer.md) \*buffer) | 获取图层的buffer。 [更多...](#getlayerbuffer) | -| ( [Flush](#flush) )(uint32_t devId, uint32_t layerId, [LayerBuffer](_layer_buffer.md) \*buffer) | 刷新图层。 [更多...](#flush) | -| ( [WaitForVBlank](#waitforvblank) )(uint32_t devId, uint32_t layerId, int32_t timeOut) | 实现等待帧消隐期到来功能。 [更多...](#waitforvblank) | -| ( [SnapShot](#snapshot) )(uint32_t devId, [LayerBuffer](_layer_buffer.md) \*buffer) | 实现抓图功能。 [更多...](#snapshot) | -| ( [SetLayerVisibleRegion](#setlayervisibleregion) )(uint32_t devId, uint32_t layerId, uint32_t num, [IRect](_i_rect.md) \*rect) | 设置一个图层的可见区域 [更多...](#setlayervisibleregion) | -| ( [SetLayerBuffer](#setlayerbuffer) )(uint32_t devId, uint32_t layerId, const BufferHandle \*buffer, int32_t fence) | 设置一个层的缓冲区。 [更多...](#setlayerbuffer) | -| ( [InvokeLayerCmd](#invokelayercmd) )(uint32_t devId, uint32_t layerId, uint32_t cmd,...) | 扩展接口 [更多...](#invokelayercmd) | -| ( [SetLayerCompositionType](#setlayercompositiontype) )(uint32_t devId, uint32_t layerId, [CompositionType](_display.md#compositiontype) type) | 设置客户端期望的组合类型 [更多...](#setlayercompositiontype) | -| ( [SetLayerBlendType](#setlayerblendtype) )(uint32_t devId, uint32_t layerId, [BlendType](_display.md#blendtype) type) | 设置混合类型 [更多...](#setlayerblendtype) | -| ( [SetLayerColorTransform](#setlayercolortransform) )(uint32_t devId, uint32_t layerId, const float \*matrix) | 设置图层当前的颜色转换矩阵。 [更多...](#setlayercolortransform) | -| ( [SetLayerColorDataSpace](#setlayercolordataspace) )(uint32_t devId, uint32_t layerId, [ColorDataSpace](_display.md#colordataspace) colorSpace) | 设置图层的颜色数据空间。 [更多...](#setlayercolordataspace) | -| ( [GetLayerColorDataSpace](#getlayercolordataspace) )(uint32_t devId, uint32_t layerId, [ColorDataSpace](_display.md#colordataspace) \*colorSpace) | 获取图层当前的颜色数据空间。 [更多...](#getlayercolordataspace) | -| ( [SetLayerMetaData](#setlayermetadata) )(uint32_t devId, uint32_t layerId, uint32_t num, const [HDRMetaData](_h_d_r_meta_data.md) \*metaData) | 设置图层的HDRmetaData。 [更多...](#setlayermetadata) | -| ( [SetLayerMetaDataSet](#setlayermetadataset) )(uint32_t devId, uint32_t layerId, [HDRMetadataKey](_display.md#hdrmetadatakey) key, uint32_t num, const uint8_t \*metaData) | 设置图层的metaData set。 [更多...](#setlayermetadataset) | -| ( [GetSupportedPresentTimestamp](#getsupportedpresenttimestamp) )(uint32_t devId, uint32_t layerId, [PresentTimestampType](_display.md#presenttimestamptype) \*type) | 获取图层支持的上屏时间戳类型。 [更多...](#getsupportedpresenttimestamp) | -| ( [GetHwPresentTimestamp](#gethwpresenttimestamp) )(uint32_t devId, uint32_t layerId, [PresentTimestamp](_present_timestamp.md) \*pts) | 获取图层的上屏时间戳信息。 [更多...](#gethwpresenttimestamp) | -| ( [SetLayerTunnelHandle](#setlayertunnelhandle) )(uint32_t devId, uint32_t layerId, ExtDataHandle \*handle) | 设置图层的tunnel句柄。 [更多...](#setlayertunnelhandle) | -| ( [GetLayerReleaseFence](#getlayerreleasefence) )(uint32_t devId, uint32_t layerId, int32_t \*fence) | 获取图层的同步栅栏。 [更多...](#getlayerreleasefence) | - - -## **详细描述** - -显示图层驱动接口结构体，定义显示图层驱动接口函数指针。 +| ([InitDisplay](#initdisplay))(uint32_t devId) | 初始化显示设备。 | +| ([DeinitDisplay](#deinitdisplay))(uint32_t devId) | 取消初始化显示设备。 | +| ([GetDisplayInfo](#getdisplayinfo))(uint32_t devId, DisplayInfo \*dispInfo) | 获取显示设备相关信息。 | +| ([CreateLayer](#createlayer))(uint32_t devId, const LayerInfo \*layerInfo, uint32_t \*layerId) | 打开图层。 | +| ([CloseLayer](#closelayer))(uint32_t devId, uint32_t layerId) | 关闭图层。 | +| ([SetLayerVisible](#setlayervisible))(uint32_t devId, uint32_t layerId, bool visible) | 设置图层是否可见。 | +| ([GetLayerVisibleState](#getlayervisiblestate))(uint32_t devId, uint32_t layerId, bool \*visible) | 获取图层是否可见状态。 | +| ([SetLayerSize](#setlayersize))(uint32_t devId, uint32_t layerId, IRect \*rect) | 设置图层大小。 | +| ([GetLayerSize](#getlayersize))(uint32_t devId, uint32_t layerId, IRect \*rect) | 获取图层大小。 | +| ([SetLayerCrop](#setlayercrop))(uint32_t devId, uint32_t layerId, IRect \*rect) | 设置图层裁剪区域。 | +| ([SetLayerZorder](#setlayerzorder))(uint32_t devId, uint32_t layerId, uint32_t zorder) | 设置图层Z轴次序。 | +| ([GetLayerZorder](#getlayerzorder))(uint32_t devId, uint32_t layerId, uint32_t \*zorder) | 获取图层Z轴次序。 | +| ([SetLayerPreMulti](#setlayerpremulti))(uint32_t devId, uint32_t layerId, bool preMul) | 设置图层预乘。 | +| ([GetLayerPreMulti](#getlayerpremulti))(uint32_t devId, uint32_t layerId, bool \*preMul) | 获取图层预乘标识。 | +| ([SetLayerAlpha](#setlayeralpha))(uint32_t devId, uint32_t layerId, LayerAlpha \*alpha) | 设置图层Alpha值。 | +| ([GetLayerAlpha](#getlayeralpha))(uint32_t devId, uint32_t layerId, LayerAlpha \*alpha) | 获取图层Alpha值。 | +| ([SetLayerColorKey](#setlayercolorkey))(uint32_t devId, uint32_t layerId, bool enable, uint32_t key) | 设置图层colorkey属性,在图层叠加时使用。 | +| ([GetLayerColorKey](#getlayercolorkey))(uint32_t devId, uint32_t layerId, bool \*enable, uint32_t \*key) | 获取图层colorkey。 | +| ([SetLayerPalette](#setlayerpalette))(uint32_t devId, uint32_t layerId, uint32_t \*palette, uint32_t len) | 设置图层调色板。 | +| ([GetLayerPalette](#getlayerpalette))(uint32_t devId, uint32_t layerId, uint32_t \*palette, uint32_t len) | 获取图层调色板。 | +| ([SetTransformMode](#settransformmode))(uint32_t devId, uint32_t layerId, TransformType type) | 设置图层变换模式，根据不同的场景设置图层的旋转、缩放、移位等。 | +| ([SetLayerCompression](#setlayercompression))(uint32_t devId, uint32_t layerId, int32_t compType) | 设置图层压缩功能。 | +| ([GetLayerCompression](#getlayercompression))(uint32_t devId, uint32_t layerId, int32_t \*compType) | 获取图层压缩功能是否打开。 | +| ([SetLayerDirtyRegion](#setlayerdirtyregion))(uint32_t devId, uint32_t layerId, IRect \*region) | 设置图层刷新区域。 | +| ([GetLayerBuffer](#getlayerbuffer))(uint32_t devId, uint32_t layerId, LayerBuffer \*buffer) | 获取图层的buffer。 | +| ([Flush](#flush))(uint32_t devId, uint32_t layerId, LayerBuffer \*buffer) | 刷新图层。 | +| ([WaitForVBlank](#waitforvblank))(uint32_t devId, uint32_t layerId, int32_t timeOut) | 实现等待帧消隐期到来功能。 | +| ([SnapShot](#snapshot))(uint32_t devId, LayerBuffer \*buffer) | 实现抓图功能。 | +| ([SetLayerVisibleRegion](#setlayervisibleregion))(uint32_t devId, uint32_t layerId, uint32_t num, IRect \*rect) | 设置一个图层的可见区域。 | +| ([SetLayerBuffer](#setlayerbuffer))(uint32_t devId, uint32_t layerId, const BufferHandle \*buffer, int32_t fence) | 设置一个层的缓冲区。 | +| ([InvokeLayerCmd](#invokelayercmd))(uint32_t devId, uint32_t layerId, uint32_t cmd,...) | 扩展接口。 | +| ([SetLayerCompositionType](#setlayercompositiontype))(uint32_t devId, uint32_t layerId, CompositionType type) | 设置客户端期望的组合类型。 | +| ([SetLayerBlendType](#setlayerblendtype))(uint32_t devId, uint32_t layerId, BlendType type) | 设置混合类型。 | +| ([SetLayerColorTransform](#setlayercolortransform))(uint32_t devId, uint32_t layerId, const float \*matrix) | 设置图层当前的颜色转换矩阵。 | +| ([SetLayerColorDataSpace](#setlayercolordataspace))(uint32_t devId, uint32_t layerId, ColorDataSpace colorSpace) | 设置图层的颜色数据空间。 | +| ([GetLayerColorDataSpace](#getlayercolordataspace))(uint32_t devId, uint32_t layerId, ColorDataSpace \*colorSpace) | 获取图层当前的颜色数据空间。 | +| ([SetLayerMetaData](#setlayermetadata))(uint32_t devId, uint32_t layerId, uint32_t num, const HDRMetaData \*metaData) | 设置图层的HDRmetaData。 | +| ([SetLayerMetaDataSet](#setlayermetadataset))(uint32_t devId, uint32_t layerId, HDRMetadataKey key, uint32_t num, const uint8_t \*metaData) | 设置图层的metaData set。 | +| ([GetSupportedPresentTimestamp](#getsupportedpresenttimestamp))(uint32_t devId, uint32_t layerId, PresentTimestampType \*type) | 获取图层支持的上屏时间戳类型。 | +| ([GetHwPresentTimestamp](#gethwpresenttimestamp))(uint32_t devId, uint32_t layerId, PresentTimestamp \*pts) | 获取图层的上屏时间戳信息。 | +| ([SetLayerTunnelHandle](#setlayertunnelhandle))(uint32_t devId, uint32_t layerId, ExtDataHandle \*handle) | 设置图层的tunnel句柄。 | +| ([GetLayerReleaseFence](#getlayerreleasefence))(uint32_t devId, uint32_t layerId, int32_t \*fence) | 获取图层的同步栅栏。 | ## **类成员变量说明** @@ -80,22 +77,22 @@ int32_t(* LayerFuncs::CloseLayer) (uint32_t devId, uint32_t layerId) 在完成显示后，如果不在需要使用图层，调用关闭图层接口关闭图层。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | devId | 输入参数，显示设备ID，用于支持多个显示设备，取值从0开始，0表示第一个设备，最大支持5个设备。 | | layerId | 输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#disperrcode)。 -**参见：** +**参见:** -**OpenLayer** +[CreateLayer](#createlayer) ### CreateLayer @@ -111,7 +108,7 @@ int32_t(* LayerFuncs::CreateLayer) (uint32_t devId, const LayerInfo *layerInfo, GUI在使用图层时，需要先根据图层信息打开图层，打开图层成功可获得图层ID，根据图层ID使用图层各接口。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -119,13 +116,13 @@ GUI在使用图层时，需要先根据图层信息打开图层，打开图层 | layerInfo | 输入参数，图层信息，上层GUI打开图层时需传递图层信息，包括图层类型，图层大小，像素格式等信息。 | | layerId | 输入参数，图层ID，打开图层成功后返回给GUI的图层ID，用于标识唯一的图层。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#disperrcode)。 -**参见：** +**参见:** [CloseLayer](#closelayer) @@ -141,19 +138,19 @@ int32_t(* LayerFuncs::DeinitDisplay) (uint32_t devId) 取消初始化显示设备。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | devId | 输入参数，显示设备ID，用于支持多个显示设备，取值从0开始，0表示第一个设备，最大支持5个设备。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#disperrcode)。 -**参见：** +**参见:** [InitDisplay](#initdisplay) @@ -171,7 +168,7 @@ int32_t(* LayerFuncs::Flush) (uint32_t devId, uint32_t layerId, LayerBuffer *buf 将buffer显示数据刷新到指定的layerId图层上，实现图像数据显示到屏幕上。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -179,7 +176,7 @@ int32_t(* LayerFuncs::Flush) (uint32_t devId, uint32_t layerId, LayerBuffer *buf | layerId | 输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。 | | buffer | 输出参数，待刷新的buffer。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 @@ -197,14 +194,14 @@ int32_t(* LayerFuncs::GetDisplayInfo) (uint32_t devId, DisplayInfo *dispInfo) 获取显示设备相关信息。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | devId | 输入参数，显示设备ID，用于支持多个显示设备，取值从0开始，0表示第一个设备，最大支持5个设备。 | | dispInfo | 输出参数，显示相关信息。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 @@ -222,7 +219,7 @@ int32_t(* LayerFuncs::GetHwPresentTimestamp) (uint32_t devId, uint32_t layerId, 获取图层的上屏时间戳信息。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -230,7 +227,7 @@ int32_t(* LayerFuncs::GetHwPresentTimestamp) (uint32_t devId, uint32_t layerId, | layerId | 输入参数，指示需要操作的图层ID。 | | pts | 输出参数，保存图层的上屏时间戳信息, 由接口实现层进行写入。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 @@ -248,7 +245,7 @@ int32_t(* LayerFuncs::GetLayerAlpha) (uint32_t devId, uint32_t layerId, LayerAlp 获取图层alpha值。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -256,13 +253,13 @@ int32_t(* LayerFuncs::GetLayerAlpha) (uint32_t devId, uint32_t layerId, LayerAlp | layerId | 输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。 | | alpha | 输出参数，保存获取的图层alpha值。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#disperrcode)。 -**参见：** +**参见:** [SetLayerAlpha](#setlayeralpha) @@ -280,7 +277,7 @@ int32_t(* LayerFuncs::GetLayerBuffer) (uint32_t devId, uint32_t layerId, LayerBu 向buffer中绘图后，调用Flush接口显示到屏幕上。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -288,13 +285,13 @@ int32_t(* LayerFuncs::GetLayerBuffer) (uint32_t devId, uint32_t layerId, LayerBu | layerId | 输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。 | | buffer | 输出参数，保存获取的图层buffer。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#disperrcode)。 -**参见：** +**参见:** [Flush](#flush) @@ -310,7 +307,7 @@ int32_t(* LayerFuncs::GetLayerColorDataSpace) (uint32_t devId, uint32_t layerId, 获取图层当前的颜色数据空间。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -318,7 +315,7 @@ int32_t(* LayerFuncs::GetLayerColorDataSpace) (uint32_t devId, uint32_t layerId, | layerId | 输入参数，指示需要操作的图层ID。 | | colorSpace | 输出参数，保存对应图层的颜色数据空间。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 @@ -336,7 +333,7 @@ int32_t(* LayerFuncs::GetLayerColorKey) (uint32_t devId, uint32_t layerId, bool 获取图层colorkey。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -345,13 +342,13 @@ int32_t(* LayerFuncs::GetLayerColorKey) (uint32_t devId, uint32_t layerId, bool | enable | 输出参数，保存获取的enable色键使能标识。 | | key | 输出参数，保存获取的色键值，即颜色值。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#disperrcode)。 -**参见：** +**参见:** [SetLayerColorKey](#setlayercolorkey) @@ -367,7 +364,7 @@ int32_t(* LayerFuncs::GetLayerCompression) (uint32_t devId, uint32_t layerId, in 获取图层压缩功能是否打开。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -375,13 +372,13 @@ int32_t(* LayerFuncs::GetLayerCompression) (uint32_t devId, uint32_t layerId, in | layerId | 输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。 | | compType | 输出参数，保存获取的图层压缩功能状态。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#disperrcode)。 -**参见：** +**参见:** [SetLayerCompression](#setlayercompression) @@ -397,7 +394,7 @@ int32_t(* LayerFuncs::GetLayerPalette) (uint32_t devId, uint32_t layerId, uint32 获取图层调色板。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -406,13 +403,13 @@ int32_t(* LayerFuncs::GetLayerPalette) (uint32_t devId, uint32_t layerId, uint32 | palette | 输出参数，保存获取的图层调色板。 | | len | 输入参数，调色板长度。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#disperrcode)。 -**参见：** +**参见:** [SetLayerPalette](#setlayerpalette) @@ -428,7 +425,7 @@ int32_t(* LayerFuncs::GetLayerPreMulti) (uint32_t devId, uint32_t layerId, bool 获取图层预乘标识。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -436,13 +433,13 @@ int32_t(* LayerFuncs::GetLayerPreMulti) (uint32_t devId, uint32_t layerId, bool | layerId | 输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。 | | preMul | 输出参数，保存获取的图层预乘使能标识。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#disperrcode)。 -**参见：** +**参见:** [SetLayerPreMulti](#setlayerpremulti) @@ -458,7 +455,7 @@ int32_t(* LayerFuncs::GetLayerReleaseFence) (uint32_t devId, uint32_t layerId, i 获取图层的同步栅栏。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -466,7 +463,7 @@ int32_t(* LayerFuncs::GetLayerReleaseFence) (uint32_t devId, uint32_t layerId, i | layerId | 输入参数，指示需要操作的图层ID。 | | fence | 输出参数，保存图层的 release fence, 由接口实现层进行写入。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 @@ -484,7 +481,7 @@ int32_t(* LayerFuncs::GetLayerSize) (uint32_t devId, uint32_t layerId, IRect *re 获取图层大小。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -492,13 +489,13 @@ int32_t(* LayerFuncs::GetLayerSize) (uint32_t devId, uint32_t layerId, IRect *re | layerId | 输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。 | | rect | 输出参数，保存获取的图层大小。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#disperrcode)。 -**参见：** +**参见:** [SetLayerSize](#setlayersize) @@ -514,7 +511,7 @@ int32_t(* LayerFuncs::GetLayerVisibleState) (uint32_t devId, uint32_t layerId, b 获取图层是否可见状态。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -522,13 +519,13 @@ int32_t(* LayerFuncs::GetLayerVisibleState) (uint32_t devId, uint32_t layerId, b | layerId | 输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。 | | visible | 输出参数，保存获取的图层可见状态，true表示图层可见，false表示图层不可见。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#disperrcode)。 -**参见：** +**参见:** [SetLayerVisible](#setlayervisible) @@ -544,7 +541,7 @@ int32_t(* LayerFuncs::GetLayerZorder) (uint32_t devId, uint32_t layerId, uint32_ 获取图层Z轴次序。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -552,13 +549,13 @@ int32_t(* LayerFuncs::GetLayerZorder) (uint32_t devId, uint32_t layerId, uint32_ | layerId | 输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。 | | zorder | 输出参数，保存获取的图层Z轴次序，为整数值，取值范围为[0, 255]，值越大图层越往上排列。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#disperrcode)。 -**参见：** +**参见:** [SetLayerZorder](#setlayerzorder) @@ -574,7 +571,7 @@ int32_t(* LayerFuncs::GetSupportedPresentTimestamp) (uint32_t devId, uint32_t la 获取图层支持的上屏时间戳类型。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -582,7 +579,7 @@ int32_t(* LayerFuncs::GetSupportedPresentTimestamp) (uint32_t devId, uint32_t la | layerId | 输入参数，指示需要操作的图层ID。 | | type | 输出参数，保存图层支持的上屏时间戳类型, 由接口实现层进行写入。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 @@ -600,19 +597,19 @@ int32_t(* LayerFuncs::InitDisplay) (uint32_t devId) 初始化显示设备。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | devId | 输入参数，显示设备ID，用于支持多个显示设备，取值从0开始，0表示第一个设备，最大支持5个设备。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#disperrcode)。 -**参见：** +**参见:** [DeinitDisplay](#deinitdisplay) @@ -628,7 +625,7 @@ int32_t(* LayerFuncs::InvokeLayerCmd) (uint32_t devId, uint32_t layerId, uint32_ 扩展接口 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -636,7 +633,7 @@ int32_t(* LayerFuncs::InvokeLayerCmd) (uint32_t devId, uint32_t layerId, uint32_ | layerId | 输入参数，层ID，唯一标识一个层。可以对该层进行操作。 | | cmd | 输入参数，表示扩展cmd，用于识别不同的意图。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 @@ -654,7 +651,7 @@ int32_t(* LayerFuncs::SetLayerAlpha) (uint32_t devId, uint32_t layerId, LayerAlp 设置图层alpha值。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -662,13 +659,13 @@ int32_t(* LayerFuncs::SetLayerAlpha) (uint32_t devId, uint32_t layerId, LayerAlp | layerId | 输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。 | | alpha | 输入参数，待设置的图层 alpha 值。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#disperrcode)。 -**参见：** +**参见:** [GetLayerAlpha](#getlayeralpha) @@ -684,7 +681,7 @@ int32_t(* LayerFuncs::SetLayerBlendType) (uint32_t devId, uint32_t layerId, Blen 设置混合类型 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -692,7 +689,7 @@ int32_t(* LayerFuncs::SetLayerBlendType) (uint32_t devId, uint32_t layerId, Blen | layerId | 输入参数，层ID，唯一标识一个层。可以对该层进行操作。 | | type | 输入参数，指示混合类型。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 @@ -710,7 +707,7 @@ int32_t(* LayerFuncs::SetLayerBuffer) (uint32_t devId, uint32_t layerId, const B 设置一个层的缓冲区。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -719,7 +716,7 @@ int32_t(* LayerFuncs::SetLayerBuffer) (uint32_t devId, uint32_t layerId, const B | buffer | 输入参数，指示缓冲区句柄的指针，该指针包含所有用于合成的缓冲区的所有信息。 | | fence | 输入参数，同步文件的fd。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 @@ -737,7 +734,7 @@ int32_t(* LayerFuncs::SetLayerColorDataSpace) (uint32_t devId, uint32_t layerId, 设置图层的颜色数据空间。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -745,7 +742,7 @@ int32_t(* LayerFuncs::SetLayerColorDataSpace) (uint32_t devId, uint32_t layerId, | layerId | 输入参数，指示需要操作的图层ID。 | | colorSpace | 输入参数，表示需要设置的颜色数据空间。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 @@ -763,7 +760,7 @@ int32_t(* LayerFuncs::SetLayerColorKey) (uint32_t devId, uint32_t layerId, bool 设置图层colorkey属性,在图层叠加时使用。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -772,13 +769,13 @@ int32_t(* LayerFuncs::SetLayerColorKey) (uint32_t devId, uint32_t layerId, bool | enable | 输入参数，待设置的色键使能标识。 | | key | 输入参数，待设置的色键值，即颜色值。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#disperrcode)。 -**参见：** +**参见:** [GetLayerColorKey](#getlayercolorkey) @@ -794,7 +791,7 @@ int32_t(* LayerFuncs::SetLayerColorTransform) (uint32_t devId, uint32_t layerId, 设置图层当前的颜色转换矩阵。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -802,7 +799,7 @@ int32_t(* LayerFuncs::SetLayerColorTransform) (uint32_t devId, uint32_t layerId, | layerId | 输入参数，指示需要操作的图层ID。 | | matrix | 输入参数，表示需要设置的颜色转换模式。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 @@ -818,9 +815,9 @@ int32_t(* LayerFuncs::SetLayerCompositionType) (uint32_t devId, uint32_t layerId **描述：** -设置客户端期望的组合类型 +设置客户端期望的组合类型。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -828,7 +825,7 @@ int32_t(* LayerFuncs::SetLayerCompositionType) (uint32_t devId, uint32_t layerId | layerId | 输入参数，层ID，唯一标识一个层。可以对该层进行操作。 | | type | 输入参数，指示客户端期望的组合类型。它可能随实现而变化。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 @@ -844,11 +841,11 @@ int32_t(* LayerFuncs::SetLayerCompression) (uint32_t devId, uint32_t layerId, in **描述：** -设置图层压缩功能 +设置图层压缩功能。 在特定场景下，需要对图像数据进行压缩，可设置启动或关闭图层压缩功能。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -856,13 +853,13 @@ int32_t(* LayerFuncs::SetLayerCompression) (uint32_t devId, uint32_t layerId, in | layerId | 输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。 | | compType | 输入参数，图层压缩使能标识。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#disperrcode)。 -**参见：** +**参见:** [GetLayerCompression](#getlayercompression) @@ -878,7 +875,7 @@ int32_t(* LayerFuncs::SetLayerCrop) (uint32_t devId, uint32_t layerId, IRect *re 设置图层裁剪区域。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -886,7 +883,7 @@ int32_t(* LayerFuncs::SetLayerCrop) (uint32_t devId, uint32_t layerId, IRect *re | layerId | 输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。 | | rect | 输入参数，待设置的裁剪区域。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 @@ -906,7 +903,7 @@ int32_t(* LayerFuncs::SetLayerDirtyRegion) (uint32_t devId, uint32_t layerId, IR GUI图形系统绘制好图像数据后，在调用Flush接口刷新屏幕之前需要设置图层刷新区域。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -914,7 +911,7 @@ GUI图形系统绘制好图像数据后，在调用Flush接口刷新屏幕之前 | layerId | 输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。 | | region | 输入参数，待设置的刷新区域。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 @@ -932,7 +929,7 @@ int32_t(* LayerFuncs::SetLayerMetaData) (uint32_t devId, uint32_t layerId, uint3 设置图层的HDRmetaData。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -941,7 +938,7 @@ int32_t(* LayerFuncs::SetLayerMetaData) (uint32_t devId, uint32_t layerId, uint3 | num | 输入参数，metadata 数组个数。 | | metaData | 输入参数，表示需要设置的 metadata 数组首地址。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 @@ -959,17 +956,17 @@ int32_t(* LayerFuncs::SetLayerMetaDataSet) (uint32_t devId, uint32_t layerId, HD 设置图层的metaData set。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | devId | 输入参数，指示需要操作的设备ID。 | | layerId | 输入参数，指示需要操作的图层ID。 | -| key | 输入参数，表示需要设置的 HDRMetadataKey。 | +| key | 输入参数，表示需要设置的[HDRMetadataKey](_display.md#hdrmetadatakey)。 | | num | 输入参数，metadata 数组个数。 | | metaData | 输入参数，表示需要设置的 metadata 数组首地址, 数据类型为uint8_t。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 @@ -987,7 +984,7 @@ int32_t(* LayerFuncs::SetLayerPalette) (uint32_t devId, uint32_t layerId, uint32 设置图层调色板。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -996,13 +993,13 @@ int32_t(* LayerFuncs::SetLayerPalette) (uint32_t devId, uint32_t layerId, uint32 | palette | 输入参数，待设置的图层调色板。 | | len | 输入参数，调色板长度。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#disperrcode)。 -**参见：** +**参见:** [GetLayerPalette](#getlayerpalette) @@ -1018,7 +1015,7 @@ int32_t(* LayerFuncs::SetLayerPreMulti) (uint32_t devId, uint32_t layerId, bool 设置图层预乘。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -1026,13 +1023,13 @@ int32_t(* LayerFuncs::SetLayerPreMulti) (uint32_t devId, uint32_t layerId, bool | layerId | 输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。 | | preMul | 输入参数，待设置的图层预乘使能标识，1表示使能图层预乘，0表示不使能图层预乘。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#disperrcode)。 -**参见：** +**参见:** [GetLayerPreMulti](#getlayerpremulti) @@ -1048,7 +1045,7 @@ int32_t(* LayerFuncs::SetLayerSize) (uint32_t devId, uint32_t layerId, IRect *re 设置图层大小。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -1056,13 +1053,13 @@ int32_t(* LayerFuncs::SetLayerSize) (uint32_t devId, uint32_t layerId, IRect *re | layerId | 输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。 | | rect | 输入参数，待设置的图层大小，单位为像素。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#disperrcode)。 -**参见：** +**参见:** [GetLayerSize](#getlayersize) @@ -1078,7 +1075,7 @@ int32_t(* LayerFuncs::SetLayerTunnelHandle) (uint32_t devId, uint32_t layerId, E 设置图层的tunnel句柄。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -1086,7 +1083,7 @@ int32_t(* LayerFuncs::SetLayerTunnelHandle) (uint32_t devId, uint32_t layerId, E | layerId | 输入参数，指示需要操作的图层ID。 | | handle | 输入参数，表示需要设置的句柄。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 @@ -1106,7 +1103,7 @@ int32_t(* LayerFuncs::SetLayerVisible) (uint32_t devId, uint32_t layerId, bool v 不可见情况下图层不显示在屏幕上，可见情况下图层显示在屏幕上。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -1114,13 +1111,13 @@ int32_t(* LayerFuncs::SetLayerVisible) (uint32_t devId, uint32_t layerId, bool v | layerId | 输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。 | | visible | 输入参数，待设置的图层可见标识，设置true表示图层可见，设置false表示图层不可见。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#disperrcode)。 -**参见：** +**参见:** [GetLayerVisibleState](#getlayervisiblestate) @@ -1136,16 +1133,16 @@ int32_t(* LayerFuncs::SetLayerVisibleRegion) (uint32_t devId, uint32_t layerId, 设置一个图层的可见区域 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | devId | 输入参数，显示设备的ID。取值范围为0 ~ 4，其中0表示第一个显示设备，4表示最后一个显示设备。 | | layerId | 输入参数，层ID，唯一标识一个层。可以对该层进行操作。 | -| num | 输入参数，指定rect的计数，该区域包含多个 [IRect](_i_rect.md),num表示该区域中有多少个rect区域。 | +| num | 输入参数，指定rect的计数，该区域包含多个[IRect](_i_rect.md)，num表示该区域中有多少个rect区域。 | | rect | 输出参数，rectes对象的指针。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 @@ -1165,7 +1162,7 @@ int32_t(* LayerFuncs::SetLayerZorder) (uint32_t devId, uint32_t layerId, uint32_ 图层的Z序值越大，图层越靠上显示。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -1173,13 +1170,13 @@ int32_t(* LayerFuncs::SetLayerZorder) (uint32_t devId, uint32_t layerId, uint32_ | layerId | 输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。 | | zorder | 输入参数，待设置的图层Z序，为整数值，取值范围为[0, 255]，值越大图层越往上排列。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#disperrcode)。 -**参见：** +**参见:** [GetLayerZorder](#getlayerzorder) @@ -1195,7 +1192,7 @@ int32_t(* LayerFuncs::SetTransformMode) (uint32_t devId, uint32_t layerId, Trans 设置图层变换模式，根据不同的场景设置图层的旋转、缩放、移位等。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -1203,7 +1200,7 @@ int32_t(* LayerFuncs::SetTransformMode) (uint32_t devId, uint32_t layerId, Trans | layerId | 输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。 | | type | 输入参数，待设置的图层变换模式。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 @@ -1225,14 +1222,14 @@ int32_t(* LayerFuncs::SnapShot) (uint32_t devId, LayerBuffer *buffer) otherwise. -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | devId | 输入参数，显示设备ID，用于支持多个显示设备，取值从0开始，0表示第一个设备，最大支持5个设备。 | | buffer | 输出参数，保存截屏的buffer信息。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 @@ -1252,7 +1249,7 @@ int32_t(* LayerFuncs::WaitForVBlank) (uint32_t devId, uint32_t layerId, int32_t 该函数会让系统等待，直到帧消隐期到来，用于软件和硬件之间的同步。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | @@ -1260,7 +1257,7 @@ int32_t(* LayerFuncs::WaitForVBlank) (uint32_t devId, uint32_t layerId, int32_t | layerId | 输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。 | | timeOut | 输入参数，超时时间，在设置的超时时间后，没有等到帧消隐期到来则超时返回。 | -**返回：** +**返回:** DISPLAY_SUCCESS 表示执行成功。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_layer_info.md b/zh-cn/device-dev/reference/hdi-apis/_layer_info.md index dec0da93d00b2149b713cc2369472137edc4cb8f..2a37f273707a9af958cdac308f26f6cabf525855 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_layer_info.md +++ b/zh-cn/device-dev/reference/hdi-apis/_layer_info.md @@ -3,7 +3,11 @@ ## **概述** -**所属模块:** +定义图层信息结构体。 + +在创建图层时，需要将LayerInfo传递给创建图层接口，创建图层接口根据图层信息创建相应图层。 + +**相关模块:** [Display](_display.md) @@ -13,17 +17,10 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [width](_display.md#width-27) | 图层宽度 | -| [height](_display.md#height-27) | 图层高度 | -| [type](_display.md#type-13) | 图层类型，包括图形层、视频层和媒体播放模式。 | +| [width](_display.md#width-29) | 图层宽度 | +| [height](_display.md#height-28) | 图层高度 | +| [type](_display.md#type-17) | 图层类型，包括图形层、视频层和媒体播放模式。 | | [bpp](_display.md#bpp) | 每像素所占bit数 | | [pixFormat](_display.md#pixformat-12) | 图层像素格式 | - - -## **详细描述** - -定义图层信息结构体。 - -在创建图层时，需要将LayerInfo传递给创建图层接口，创建图层接口根据图层信息创建相应图层。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_light.md b/zh-cn/device-dev/reference/hdi-apis/_light.md deleted file mode 100644 index 62e49861d2aaad72185e10e690f2b52c59a93309..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_light.md +++ /dev/null @@ -1,159 +0,0 @@ -# Light - - -## **汇总** - - -### 文件 - - | 文件 | 描述 | -| -------- | -------- | -| [light_if.h](light__if_8h.md) | 声明light模块的通用API，可用于获取灯ID、打开或关闭灯、并设置灯光亮度和闪烁模式。 | -| [light_type.h](light_8typeh.md) | 定义灯的数据结构，包括灯ID、灯的模式、灯的闪烁模式和持续时间、灯的状态、灯的效果。 | - - -### 类 - - | 类 | 描述 | -| -------- | -------- | -| [LightFlashEffect](_light_flash_effect.md) | 定义闪烁参数。 [更多...](_light_flash_effect.md) | -| [LightEffect](_light_effect.md) | 定义灯的效果参数。 [更多...](_light_effect.md) | -| [LightInfo](_light_info.md) | 定义灯的基本信息。 [更多...](_light_info.md) | -| [LightInterface](_light_interface.md) | 定义可以在灯上执行的基本操作。 [更多...](_light_interface.md) | - - -### 枚举 - - | 枚举 | 描述 | -| -------- | -------- | -| [LightStatus](#lightstatus) { LIGHT_SUCCESS = 0, LIGHT_NOT_SUPPORT = -1, LIGHT_NOT_FLASH = -2, LIGHT_NOT_BRIGHTNESS = -3 } | 枚举灯模块的状态值。 [更多...](#lightstatus) | -| [LightId](#lightid) { LIGHT_ID_NONE = 0, LIGHT_ID_BATTERY = 1, LIGHT_ID_NOTIFICATIONS = 2, LIGHT_ID_ATTENTION = 3,   LIGHT_ID_BUTT = 4 } | 枚举灯类型 [更多...](#lightid) | -| [LightFlashMode](#lightflashmode) { LIGHT_FLASH_NONE = 0, LIGHT_FLASH_TIMED = 1, LIGHT_FLASH_BUTT = 2 } | 枚举灯的模式 [更多...](#lightflashmode) | - - -### 函数 - - | 函数 | 描述 | -| -------- | -------- | -| [NewLightInterfaceInstance](#newlightinterfaceinstance) (void) | 创建LightInterface实例。 [更多...](#newlightinterfaceinstance) | -| [FreeLightInterfaceInstance](#freelightinterfaceinstance) (void) | 释放LightInterface实例和相关资源。 [更多...](#freelightinterfaceinstance) | - - -## **详细描述** - -灯模块对灯服务提供通用的接口能力。 - -灯模块为灯服务提供通用的接口去访问灯驱动。 服务获取灯驱动对象或代理后，可以调用相关的APIs接口获取灯信息、打开或关闭灯，并根据灯ID设置灯闪烁模式。 - -**Since：** - -3.1 - - -## **枚举类型说明** - - -### LightFlashMode - - -``` -enum LightFlashMode -``` - -**描述：** - -枚举灯的模式 - - | 枚举值 | 描述 | -| -------- | -------- | -| LIGHT_FLASH_NONE | 常亮。 | -| LIGHT_FLASH_TIMED | 闪烁。 | -| LIGHT_FLASH_BUTT | 无效模式。 | - - -### LightId - - -``` -enum LightId -``` - -**描述：** - -枚举灯类型 - - | 枚举值 | 描述 | -| -------- | -------- | -| LIGHT_ID_NONE | 未知ID。 | -| LIGHT_ID_BATTERY | 电源指示灯。 | -| LIGHT_ID_NOTIFICATIONS | 通知灯。 | -| LIGHT_ID_ATTENTION | 报警灯。 | -| LIGHT_ID_BUTT | 无效ID。 | - - -### LightStatus - - -``` -enum LightStatus -``` - -**描述：** - -枚举灯模块的状态值。 - - | 枚举值 | 描述 | -| -------- | -------- | -| LIGHT_SUCCESS | 操作成功。 | -| LIGHT_NOT_SUPPORT | 灯ID不支持。 | -| LIGHT_NOT_FLASH | 设置闪烁不支持。 | -| LIGHT_NOT_BRIGHTNESS | 设置亮度不支持。 | - - -## **函数说明** - - -### FreeLightInterfaceInstance() - - -``` -int32_t FreeLightInterfaceInstance (void ) -``` - -**描述：** - -释放LightInterface实例和相关资源。 - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - -**Since：** - -3.1 - - -### NewLightInterfaceInstance() - - -``` -const struct LightInterface* NewLightInterfaceInstance (void ) -``` - -**描述：** - -创建LightInterface实例。 - -创建的LightInterface实例可用于执行相关的灯控制操作。 - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - -**Since：** - -3.1 diff --git a/zh-cn/device-dev/reference/hdi-apis/_light_effect.md b/zh-cn/device-dev/reference/hdi-apis/_light_effect.md deleted file mode 100644 index 63a331afec767e0ed728758026263075c7cbed70..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_light_effect.md +++ /dev/null @@ -1,57 +0,0 @@ -# LightEffect - - -## **概述** - -**所属模块:** - -[Light](_light.md) - - -## **汇总** - - -### Public 属性 - -| Public 属性 | 描述 | -| -------- | -------- | -| [lightBrightness](#lightbrightness) | 亮度值。 | -| [flashEffect](#flasheffect) | 闪烁模式。 | - - -## **详细描述** - -定义灯的效果参数。 - -参数包括亮度和闪烁模式。 - -**Since：** - -3.1 - - -## **类成员变量说明** - - -### flashEffect - - -``` -struct LightFlashEffect LightEffect::flashEffect -``` - -**描述：** - -闪烁模式。详见[LightFlashEffect](_light_flash_effect.md)。 - - -### lightBrightness - - -``` -int32_t LightEffect::lightBrightness -``` - -**描述：** - -亮度值：Bits 24–31为扩展位，Bits 16–23为红色，Bits 8–15为绿色，Bits 0–7为蓝色。 如果相对应的字节段不等于0，表示打开相应颜色的灯。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_light_flash_effect.md b/zh-cn/device-dev/reference/hdi-apis/_light_flash_effect.md deleted file mode 100644 index 9a8a9123a99ee397b85ff88fc9158af0a16d446e..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_light_flash_effect.md +++ /dev/null @@ -1,70 +0,0 @@ -# LightFlashEffect - - -## **概述** - -**所属模块:** - -[Light](_light.md) - - -## **汇总** - - -### Public 属性 - - | Public 属性 | 描述 | -| -------- | -------- | -| [flashMode](#flashmode) | 闪烁模式。 | -| [onTime](#ontime) | 表示灯在闪烁期间点亮时持续的时间（毫秒）。 | -| [offTime](#offtime) | 表示灯在闪烁期间熄灭时持续的时间（毫秒）。 | - - -## **详细描述** - -定义闪烁参数。 - -这些参数包括闪烁模式以及闪烁期间指示灯的打开和关闭时间。 - -**Since：** - -3.1 - - -## **类成员变量说明** - - -### flashMode - - -``` -int32_t LightFlashEffect::flashMode -``` - -**描述：** - -闪烁模式，详见[LightFlashMode](_light.md#lightflashmode)。 - - -### offTime - - -``` -int32_t LightFlashEffect::offTime -``` - -**描述：** - -表示灯在闪烁期间熄灭时持续的时间（毫秒）。 - - -### onTime - - -``` -int32_t LightFlashEffect::onTime -``` - -**描述：** - -表示灯在闪烁期间点亮时持续的时间（毫秒）。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_light_info.md b/zh-cn/device-dev/reference/hdi-apis/_light_info.md deleted file mode 100644 index 20d8387e71e256aaefa055c21bd9b66d208379d2..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_light_info.md +++ /dev/null @@ -1,57 +0,0 @@ -# LightInfo - - -## **概述** - -**所属模块:** - -[Light](_light.md) - - -## **汇总** - - -### Public 属性 - - | Public 属性 | 描述 | -| -------- | -------- | -| [lightId](#lightid) | 灯ID | -| [reserved](#reserved) | 自定义扩展信息 | - - -## **详细描述** - -定义灯的基本信息。 - -基本的灯信息包括灯ID和自定义扩展信息。 - -**Since：** - -3.1 - - -## **类成员变量说明** - - -### lightId - - -``` -uint32_t LightInfo::lightId -``` - -**描述：** - -灯ID，详见[LightId](_light.md#lightid)。 - - -### reserved - - -``` -int32_t LightInfo::reserved -``` - -**描述：** - -自定义扩展信息。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_light_interface.md b/zh-cn/device-dev/reference/hdi-apis/_light_interface.md deleted file mode 100644 index 9621d96fb11e3d7a3df73214c9aa2d5a45f0b252..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_light_interface.md +++ /dev/null @@ -1,109 +0,0 @@ -# LightInterface - - -## **概述** - -**所属模块:** - -[Light](_light.md) - - -## **汇总** - - -### Public 属性 - -| Public 属性 | 描述 | -| -------- | -------- | -| ( [GetLightInfo](#getlightinfo) )([out] struct [LightInfo](_light_info.md) \*\*lightInfo, [out] uint32_t \*count) | 获取当前系统中所有类型的灯信息。 [更多...](#getlightinfo) | -| ( [TurnOnLight](#turnonlight) )([in] uint32_t lightId, [in] struct [LightEffect](_light_effect.md) \*effect) | 根据指定的灯ID打开列表中的可用灯。 [更多...](#turnonlight) | -| ( [TurnOffLight](#turnofflight) )([in] uint32_t lightId) | 根据指定的灯ID关闭列表中的可用灯。 [更多...](#turnofflight) | - - -## **详细描述** - -定义可以在灯上执行的基本操作。 - -操作包括获取灯的信息、打开或关闭灯、设置灯的亮度和闪烁模式。 - - -## **类成员变量说明** - - -### GetLightInfo - - -``` -int32_t(* LightInterface::GetLightInfo) ([out] struct LightInfo **lightInfo,[out] uint32_t *count) -``` - -**描述：** - -获取当前系统中所有类型的灯信息。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| lightInfo | 表示指向灯信息的二级指针，详见[LightInfo](_light_info.md)。 | -| count | 表示指向灯数量的指针。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - - -### TurnOffLight - - -``` -int32_t(* LightInterface::TurnOffLight) ([in] uint32_t lightId) -``` - -**描述：** - -根据指定的灯ID关闭列表中的可用灯。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| lightId | 表示灯ID，详见[LightId](_light.md#lightid)。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - - -### TurnOnLight - - -``` -int32_t(* LightInterface::TurnOnLight) ([in] uint32_t lightId,[in] struct LightEffect *effect) -``` - -**描述：** - -根据指定的灯ID打开列表中的可用灯。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| lightId | 表示灯ID，详见[LightId](_light.md#lightid)。 | -| effect | 表示指向灯效果的指针，如果lightbrightness字段为0时， 灯的亮度根据HCS配置的默认亮度进行设置，详见[LightEffect](_light_effect.md)。 | - -**返回：** - -如果操作成功，则返回0。 - -如果不支持灯ID，则返回-1。 - -如果不支持闪烁设置，则返回-2。 - -如果不支持亮度设置，则返回-3。 - diff --git a/zh-cn/device-dev/reference/hdi-apis/_light_types_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_light_types_8idl.md new file mode 100644 index 0000000000000000000000000000000000000000..14c020c8b3154c2d9296425d9b94edfcba667635 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_light_types_8idl.md @@ -0,0 +1,49 @@ +# LightTypes.idl + + +## **概述** + +定义灯的数据结构，包括灯类型ID、灯的基本信息、灯的模式、灯的闪烁参数、灯的颜色模式和灯的效果参数。 + +**Since:** + +3.1 + +**Version:** + +1.0 + +**相关模块:** + +[Light](light.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [HdfLightInfo](_hdf_light_info.md) | 定义灯的基本信息。 | +| [HdfLightFlashEffect](_hdf_light_flash_effect.md) | 定义灯的闪烁参数。 | +| [RGBColor](_r_g_b_color.md) | 定义灯的RGB模式。 | +| [WRGBColor](_w_r_g_b_color.md) | 定义灯的WRGB模式。 | +| [ColorValue](union_color_value.md) | 定义灯的颜色模式。 | +| [HdfLightColor](_hdf_light_color.md) | 定义亮灯参数。 | +| [HdfLightEffect](_hdf_light_effect.md) | 定义灯的效果参数。 | + + +### 枚举 + + | 名称 | 描述 | +| -------- | -------- | +| [HdfLightId](light.md#hdflightid) { HDF_LIGHT_ID_BATTERY = 1, HDF_LIGHT_ID_NOTIFICATIONS = 2, HDF_LIGHT_ID_ATTENTION = 3, HDF_LIGHT_ID_BUTT = 4 } | 枚举灯类型。 | +| [HdfLightFlashMode](light.md#hdflightflashmode) { HDF_LIGHT_FLASH_NONE = 0, HDF_LIGHT_FLASH_TIMED = 1, HDF_LIGHT_FLASH_GRADIENT = 2, HDF_LIGHT_FLASH_BUTT = 2 } | 枚举灯的模式。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.light.v1_0 | 灯模块接口的包路径。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_meas_channel_param.md b/zh-cn/device-dev/reference/hdi-apis/_meas_channel_param.md new file mode 100644 index 0000000000000000000000000000000000000000..f79fa1a599c8747f62b908285f98f36075bb59b8 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_meas_channel_param.md @@ -0,0 +1,56 @@ +# MeasChannelParam + + +## **概述** + +信道测量参数。 + +**Since:** + +3.2 + +**Version:** + +1.0 + +**相关模块:** + +[WLAN](wlan.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [channelId](#channelid) | 信道号。 | +| [measTime](#meastime) | 测量时间。 | + + +## **类成员变量说明** + + +### channelId + + +``` +int MeasChannelParam::channelId +``` + +**描述：** + +信道号。 + + +### measTime + + +``` +int MeasChannelParam::measTime +``` + +**描述：** + +测量时间。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_meas_channel_result.md b/zh-cn/device-dev/reference/hdi-apis/_meas_channel_result.md new file mode 100644 index 0000000000000000000000000000000000000000..58c05d98f1424fcd8821a7ac425df7ee2acdbb5d --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_meas_channel_result.md @@ -0,0 +1,69 @@ +# MeasChannelResult + + +## **概述** + +信道测量结果。 + +**Since:** + +3.2 + +**Version:** + +1.0 + +**相关模块:** + +[WLAN](wlan.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [channelId](#channelid) | 信道号。 | +| [chload](#chload) | 信道负载。 | +| [noise](#noise) | 信道噪声。 | + + +## **类成员变量说明** + + +### channelId + + +``` +int MeasChannelResult::channelId +``` + +**描述：** + +信道号。 + + +### chload + + +``` +int MeasChannelResult::chload +``` + +**描述：** + +信道负载。 + + +### noise + + +``` +int MeasChannelResult::noise +``` + +**描述：** + +信道噪声。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_motion_types_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_motion_types_8idl.md new file mode 100644 index 0000000000000000000000000000000000000000..2f1c31dce3a06a64e8cba139bb0ec3235c4b5b06 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_motion_types_8idl.md @@ -0,0 +1,35 @@ +# MotionTypes.idl + + +## **概述** + +定义手势识别模块用到的数据结构，包括手势识别类型、上报的手势识别数据结构。 + +**Since:** + +3.2 + +**Version:** + +1.0 + +**相关模块:** + +[Motion](motion.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [HdfMotionEvent](_hdf_motion_event.md) | 上报手势识别数据结构。 | + + +### 枚举 + + | 名称 | 描述 | +| -------- | -------- | +| [HdfMotionTypeTag](motion.md#hdfmotiontypetag) {   HDF_MOTION_TYPE_PICKUP = 0, HDF_MOTION_TYPE_FLIP, HDF_MOTION_CLOSE_TO_EAR, HDF_MOTION_TYPE_SHAKE,   HDF_MOTION_TYPE_ROTATION, HDF_MOTION_TYPE_POCKET_MODE, HDF_MOTION_TYPE_LEAVE_EAR, HDF_MOTION_TYPE_WRIST_UP,   HDF_MOTION_TYPE_WRIST_DOWN, HDF_MOTION_TYPE_MAX } | 枚举手势识别类型。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_capture_ended_info.md b/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_capture_ended_info.md deleted file mode 100644 index 73ab78e3a96dd2462352ba188d74bb550375939d..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_capture_ended_info.md +++ /dev/null @@ -1,24 +0,0 @@ -# OHOS::Camera::CaptureEndedInfo - - -## **概述** - -**所属模块:** - -[Camera](_camera.md) - - -## **汇总** - - -### Public 属性 - - | Public 属性 | 描述 | -| -------- | -------- | -| [streamId_](_camera.md#streamid-34) | 捕获的流ID。 | -| [frameCount_](_camera.md#framecount) | 捕获结束时已经抓取的帧数。 | - - -## **详细描述** - -捕获结束相关信息，用于捕获结束回调[OnCaptureEnded](_camera.md#oncaptureended)。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_capture_error_info.md b/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_capture_error_info.md deleted file mode 100644 index fed70cf0c2f5339c6d17280d30ba324167a08120..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_capture_error_info.md +++ /dev/null @@ -1,24 +0,0 @@ -# OHOS::Camera::CaptureErrorInfo - - -## **概述** - -**所属模块:** - -[Camera](_camera.md) - - -## **汇总** - - -### Public 属性 - - | Public 属性 | 描述 | -| -------- | -------- | -| [streamId_](_camera.md#streamid-44) | 流ID。 | -| [error_](_camera.md#error) | 错误类型。 | - - -## **详细描述** - -流错误信息，用于回调[OnCaptureError](_camera.md#oncaptureerror)。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_capture_info.md b/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_capture_info.md deleted file mode 100644 index ed436019406bf6e0646d37c6a78cc3996d993b0e..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_capture_info.md +++ /dev/null @@ -1,25 +0,0 @@ -# OHOS::Camera::CaptureInfo - - -## **概述** - -**所属模块:** - -[Camera](_camera.md) - - -## **汇总** - - -### Public 属性 - - | Public 属性 | 描述 | -| -------- | -------- | -| [streamIds_](_camera.md#streamids) | 捕获的流ID集合。 | -| [captureSetting_](_camera.md#capturesetting) | 捕获的配置信息。 | -| [enableShutterCallback_](_camera.md#enableshuttercallback) | 使能捕获回调，每一次捕获后都会触发 [OnFrameShutter](_camera.md#onframeshutter)。 | - - -## **详细描述** - -捕获请求的相关信息。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_i_camera_device.md b/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_i_camera_device.md deleted file mode 100644 index 7000a726a8d5d1456daafc9e9baff100c162208b..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_i_camera_device.md +++ /dev/null @@ -1,30 +0,0 @@ -# OHOS::Camera::ICameraDevice - - -## **概述** - -**所属模块:** - -[Camera](_camera.md) - - -## **汇总** - - -### Public 成员函数 - - | Public 成员函数 | 描述 | -| -------- | -------- | -| **DECLARE_INTERFACE_DESCRIPTOR** (u"HDI.Camera.V1_0.Device") | IPC通信token校验。 | -| [GetStreamOperator](_camera.md#getstreamoperator) (const OHOS::sptr< [IStreamOperatorCallback](_o_h_o_s_1_1_camera_1_1_i_stream_operator_callback.md) > &callback, OHOS::sptr< [IStreamOperator](_o_h_o_s_1_1_camera_1_1_i_stream_operator.md) > &streamOperator)=0 | 获取流操作句柄。 [更多...](_camera.md#getstreamoperator) | -| [UpdateSettings](_camera.md#updatesettings) (const std::shared_ptr< CameraSetting > &settings)=0 | 更新设备控制参数。 [更多...](_camera.md#updatesettings) | -| [SetResultMode](_camera.md#setresultmode) (const [ResultCallbackMode](_camera.md#resultcallbackmode) &mode)=0 | 设置metadata上报模式，逐帧上报还是设备状态变化时上报。 [更多...](_camera.md#setresultmode) | -| [GetEnabledResults](_camera.md#getenabledresults) (std::vector< MetaType > &results)=0 | 查询使能的metadata。 [更多...](_camera.md#getenabledresults) | -| [EnableResult](_camera.md#enableresult) (const std::vector< MetaType > &results)=0 | 打开metadata上报开关。 [更多...](_camera.md#enableresult) | -| [DisableResult](_camera.md#disableresult) (const std::vector< MetaType > &results)=0 | 关闭metadata上报开关。 [更多...](_camera.md#disableresult) | -| [Close](_camera.md#close) ()=0 | 关闭Camera设备。 [更多...](_camera.md#close) | - - -## **详细描述** - -Camera设备操作。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_i_camera_device_callback.md b/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_i_camera_device_callback.md deleted file mode 100644 index 4a7f16ecc6932bca6fc726e496004236aa3f81ad..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_i_camera_device_callback.md +++ /dev/null @@ -1,25 +0,0 @@ -# OHOS::Camera::ICameraDeviceCallback - - -## **概述** - -**所属模块:** - -[Camera](_camera.md) - - -## **汇总** - - -### Public 成员函数 - - | Public 成员函数 | 描述 | -| -------- | -------- | -| **DECLARE_INTERFACE_DESCRIPTOR** (u"HDI.Camera.V1_0.DeviceCallback") | IPC通信token校验。 | -| [OnError](_camera.md#onerror) ([ErrorType](_camera.md#errortype) type, int32_t errorCode)=0 | 设备发生错误时调用，由调用者实现，用于返回错误信息给调用者。 [更多...](_camera.md#onerror) | -| [OnResult](_camera.md#onresult) (uint64_t timestamp, const std::shared_ptr< CameraMetadata > &result)=0 | 上报camera设备相关的metadata的回调，上报方式查看 [SetResultMode](_camera.md#setresultmode)。 [更多...](_camera.md#onresult) | - - -## **详细描述** - -Camera设备操作回调。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_i_camera_host.md b/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_i_camera_host.md deleted file mode 100644 index a77249e55bb64230e8eb8c1d48e59c9623013a3e..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_i_camera_host.md +++ /dev/null @@ -1,35 +0,0 @@ -# OHOS::Camera::ICameraHost - - -## **概述** - -**所属模块:** - -[Camera](_camera.md) - - -## **汇总** - - -### Public 成员函数 - - | Public 成员函数 | 描述 | -| -------- | -------- | -| **DECLARE_INTERFACE_DESCRIPTOR** (u"HDI.Camera.V1_0.Host") | IPC通信token校验。 | -| [SetCallback](_camera.md#setcallback) (const OHOS::sptr< [ICameraHostCallback](_o_h_o_s_1_1_camera_1_1_i_camera_host_callback.md) > &callback)=0 | 设置ICameraHost回调接口，回调函数参考 [ICameraHostCallback](_o_h_o_s_1_1_camera_1_1_i_camera_host_callback.md)。 [更多...](_camera.md#setcallback) | -| [GetCameraIds](_camera.md#getcameraids) (std::vector< std::string > &cameraIds)=0 | 获取当前可用的Camera设备ID列表。 [更多...](_camera.md#getcameraids) | -| [GetCameraAbility](_camera.md#getcameraability) (const std::string &cameraId, std::shared_ptr< CameraAbility > &ability)=0 | 获取Camera设备能力集合。 [更多...](_camera.md#getcameraability) | -| [OpenCamera](_camera.md#opencamera) (const std::string &cameraId, const OHOS::sptr< [ICameraDeviceCallback](_o_h_o_s_1_1_camera_1_1_i_camera_device_callback.md) > &callback, OHOS::sptr< [ICameraDevice](_o_h_o_s_1_1_camera_1_1_i_camera_device.md) > &device)=0 | 打开Camera设备。 [更多...](_camera.md#opencamera) | -| [SetFlashlight](_camera.md#setflashlight) (const std::string &cameraId, bool &isEnable)=0 | 打开或关闭闪光灯。 [更多...](_camera.md#setflashlight) | - - -### 静态 Public 成员函数 - - | 静态 Public 成员函数 | 描述 | -| -------- | -------- | -| [Get](_camera.md#get) (const char \*serviceName) | 获取ICameraHost实例。 [更多...](_camera.md#get) | - - -## **详细描述** - -Camera服务的管理类。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_i_camera_host_callback.md b/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_i_camera_host_callback.md deleted file mode 100644 index 7a0885b50d8f9647c9fd0dc82e9684dd2acdf255..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_i_camera_host_callback.md +++ /dev/null @@ -1,26 +0,0 @@ -# OHOS::Camera::ICameraHostCallback - - -## **概述** - -**所属模块:** - -[Camera](_camera.md) - - -## **汇总** - - -### Public 成员函数 - - | Public 成员函数 | 描述 | -| -------- | -------- | -| **DECLARE_INTERFACE_DESCRIPTOR** (u"HDI.Camera.V1_0.HostCallback") | IPC通信token校验。 | -| [OnCameraStatus](_camera.md#oncamerastatus) (const std::string &cameraId, [CameraStatus](_camera.md#camerastatus) status)=0 | 用于Camera设备状态变化时上报状态信息给调用者。 [更多...](_camera.md#oncamerastatus) | -| [OnFlashlightStatus](_camera.md#onflashlightstatus) (const std::string &cameraId, [FlashlightStatus](_camera.md#flashlightstatus) status)=0 | 用于在闪光灯状态变化时上报状态信息给调用者。 [更多...](_camera.md#onflashlightstatus) | -| [OnCameraEvent](_camera.md#oncameraevent) (const std::string &cameraId, [CameraEvent](_camera.md#cameraevent) event)=0 | 在相机事件发生时调用。 [更多...](_camera.md#oncameraevent) | - - -## **详细描述** - -Camera服务的管理回调。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_i_offline_stream_operator.md b/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_i_offline_stream_operator.md deleted file mode 100644 index f8793d89a49086de20c50ba6beb49a85107eaba9..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_i_offline_stream_operator.md +++ /dev/null @@ -1,26 +0,0 @@ -# OHOS::Camera::IOfflineStreamOperator - - -## **概述** - -**所属模块:** - -[Camera](_camera.md) - - -## **汇总** - - -### Public 成员函数 - - | Public 成员函数 | 描述 | -| -------- | -------- | -| **DECLARE_INTERFACE_DESCRIPTOR** (u"HDI.Camera.V1_0.OfflineStreamOperator") | IPC通信token校验。 | -| [CancelCapture](_camera.md#cancelcapture-12) (int captureId)=0 | 取消捕获请求。 [更多...](_camera.md#cancelcapture-12) | -| [ReleaseStreams](_camera.md#releasestreams-12) (const std::vector< int > &streamIds)=0 | 释放离线流。 [更多...](_camera.md#releasestreams-12) | -| [Release](_camera.md#release) ()=0 | 释放所有离线流。 [更多...](_camera.md#release) | - - -## **详细描述** - -离线流的操作类。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_i_stream_operator.md b/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_i_stream_operator.md deleted file mode 100644 index b38ca7889204518e9f9321b212375022a92b2acd..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_i_stream_operator.md +++ /dev/null @@ -1,33 +0,0 @@ -# OHOS::Camera::IStreamOperator - - -## **概述** - -**所属模块:** - -[Camera](_camera.md) - - -## **汇总** - - -### Public 成员函数 - - | Public 成员函数 | 描述 | -| -------- | -------- | -| **DECLARE_INTERFACE_DESCRIPTOR** (u"HDI.Camera.V1_0.StreamOperator") | IPC通信token校验。 | -| [IsStreamsSupported](_camera.md#isstreamssupported) ([OperationMode](_camera.md#operationmode) mode, const std::shared_ptr< CameraMetadata > &modeSetting, const std::vector< std::shared_ptr< [StreamInfo](_o_h_o_s_1_1_camera_1_1_stream_info.md) >> &info, [StreamSupportType](_camera.md#streamsupporttype) &type)=0 | 查询是否支持添加参数对应的流 [更多...](_camera.md#isstreamssupported) | -| [CreateStreams](_camera.md#createstreams) (const std::vector< std::shared_ptr< [StreamInfo](_o_h_o_s_1_1_camera_1_1_stream_info.md) >> &streamInfos)=0 | 创建流。 [更多...](_camera.md#createstreams) | -| [ReleaseStreams](_camera.md#releasestreams-22) (const std::vector< int > &streamIds)=0 | 释放流。 [更多...](_camera.md#releasestreams-22) | -| [CommitStreams](_camera.md#commitstreams) ([OperationMode](_camera.md#operationmode) mode, const std::shared_ptr< CameraMetadata > &modeSetting)=0 | 配置流。 [更多...](_camera.md#commitstreams) | -| [GetStreamAttributes](_camera.md#getstreamattributes) (std::vector< std::shared_ptr< [StreamAttribute](_o_h_o_s_1_1_camera_1_1_stream_attribute.md) >> &attributes)=0 | 获取流的属性。 [更多...](_camera.md#getstreamattributes) | -| [AttachBufferQueue](_camera.md#attachbufferqueue) (int streamId, const OHOS::sptr< OHOS::IBufferProducer > &producer)=0 | 绑定生产者句柄和指定流。 [更多...](_camera.md#attachbufferqueue) | -| [DetachBufferQueue](_camera.md#detachbufferqueue) (int streamId)=0 | 解除生产者句柄和指定流的绑定关系。 [更多...](_camera.md#detachbufferqueue) | -| [Capture](_camera.md#capture) (int captureId, const std::shared_ptr< [CaptureInfo](_o_h_o_s_1_1_camera_1_1_capture_info.md) > &info, bool isStreaming)=0 | 捕获图像。 [更多...](_camera.md#capture) | -| [CancelCapture](_camera.md#cancelcapture-22) (int captureId)=0 | 取消捕获。 [更多...](_camera.md#cancelcapture-22) | -| [ChangeToOfflineStream](_camera.md#changetoofflinestream) (const std::vector< int > &streamIds, OHOS::sptr< [IStreamOperatorCallback](_o_h_o_s_1_1_camera_1_1_i_stream_operator_callback.md) > &callback, OHOS::sptr< [IOfflineStreamOperator](_o_h_o_s_1_1_camera_1_1_i_offline_stream_operator.md) > &offlineOperator)=0 | 将指定流转换成离线流。 [更多...](_camera.md#changetoofflinestream) | - - -## **详细描述** - -流的操作类。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_i_stream_operator_callback.md b/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_i_stream_operator_callback.md deleted file mode 100644 index 4935fd6e235e1850ee9309db17f28910e75f5996..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_i_stream_operator_callback.md +++ /dev/null @@ -1,27 +0,0 @@ -# OHOS::Camera::IStreamOperatorCallback - - -## **概述** - -**所属模块:** - -[Camera](_camera.md) - - -## **汇总** - - -### Public 成员函数 - - | Public 成员函数 | 描述 | -| -------- | -------- | -| **DECLARE_INTERFACE_DESCRIPTOR** (u"HDI.Camera.V1_0.StreamOperatorCallback") | IPC通信token校验。 | -| [OnCaptureStarted](_camera.md#oncapturestarted) (int32_t captureId, const std::vector< int32_t > &streamIds)=0 | 捕获开始回调，在捕获开始时调用。 [更多...](_camera.md#oncapturestarted) | -| [OnCaptureEnded](_camera.md#oncaptureended) (int32_t captureId, const std::vector< std::shared_ptr< [CaptureEndedInfo](_o_h_o_s_1_1_camera_1_1_capture_ended_info.md) >> &infos)=0 | 捕获结束回调，在捕获结束时调用。 [更多...](_camera.md#oncaptureended) | -| [OnCaptureError](_camera.md#oncaptureerror) (int32_t captureId, const std::vector< std::shared_ptr< [CaptureErrorInfo](_o_h_o_s_1_1_camera_1_1_capture_error_info.md) >> &infos)=0 | 捕获错误回调，在捕获过程中发生错误时调用。 [更多...](_camera.md#oncaptureerror) | -| [OnFrameShutter](_camera.md#onframeshutter) (int32_t captureId, const std::vector< int32_t > &streamIds, uint64_t timestamp)=0 | 帧捕获回调。 [更多...](_camera.md#onframeshutter) | - - -## **详细描述** - -流的操作回调类。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_stream_attribute.md b/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_stream_attribute.md deleted file mode 100644 index bff01127d61678c5dcd89a5655ecbad50c4312ad..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_stream_attribute.md +++ /dev/null @@ -1,31 +0,0 @@ -# OHOS::Camera::StreamAttribute - - -## **概述** - -**所属模块:** - -[Camera](_camera.md) - - -## **汇总** - - -### Public 属性 - - | Public 属性 | 描述 | -| -------- | -------- | -| [streamId_](_camera.md#streamid-24) | 流的ID，用于在设备内唯一标识一条流。 | -| [width_](_camera.md#width-22) | 图像宽度。 | -| [height_](_camera.md#height-22) | 图像高度。 | -| [overrideFormat_](_camera.md#overrideformat) | 重写的图像格式。 | -| [overrideDatasapce_](_camera.md#overridedataspace) | 重写的图像颜色空间。| -| [producerUsage_](_camera.md#producerusage) | 重写后的生产者的使用方式。 | -| [producerBufferCount_](_camera.md#producerbuffercount) | 重写后的生产者缓存数量。 | -| [maxBatchCaptureCount_](_camera.md#maxbatchcapturecount) | 连拍支持的最大捕获帧数量。 | -| [maxCaptureCount_](_camera.md#maxcapturecount) | 最大的并发捕获请求个数，默认为1。 | - - -## **详细描述** - -流的属性。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_stream_info.md b/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_stream_info.md deleted file mode 100644 index 613378d52a494833e1cdc354f7b0b2f4ee1ecdd7..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_camera_1_1_stream_info.md +++ /dev/null @@ -1,32 +0,0 @@ -# OHOS::Camera::StreamInfo - - -## **概述** - -**所属模块:** - -[Camera](_camera.md) - - -## **汇总** - - -### Public 属性 - - | Public 属性 | 描述 | -| -------- | -------- | -| [streamId_](_camera.md#streamid-14) | 流的ID，用于在设备内唯一标识一条流。 | -| [width_](_camera.md#width-12) | 图像宽度。 | -| [height_](_camera.md#height-12) | 图像高度。 | -| [format_](_camera.md#format) | 图像格式。 | -| [dataspace_](_camera.md#dataspace) | 图像颜色空间。 | -| [intent_](_camera.md#intent) | 流类型。 | -| [tunneledMode_](_camera.md#tunneledmode) | 隧道模式，值为true时开启，false关闭。 | -| [bufferQueue_](_camera.md#bufferqueue) | 图形提供的生产者句柄。 | -| [minFrameDuration_](_camera.md#minframeduration) | 最小帧间隔。 | -| [encodeType_](_camera.md#encodetype) | 编码类型。 | - - -## **详细描述** - -流信息，用于创建流时传入相关的配置参数。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_u_s_b_1_1_u_s_b_device_info.md b/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_u_s_b_1_1_u_s_b_device_info.md deleted file mode 100644 index 0ae62b90c880862107a3d949d7b659b322ca278e..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_u_s_b_1_1_u_s_b_device_info.md +++ /dev/null @@ -1,25 +0,0 @@ -# OHOS::USB::USBDeviceInfo - - -## **概述** - -**所属模块:** - -[USB](_u_s_b.md) - - -## **汇总** - - -### Public 属性 - - | Public 属性 | 描述 | -| -------- | -------- | -| [status](_u_s_b.md#status) | USB设备状态 | -| [busNum](_u_s_b.md#busnum-12) | USB总线编号 | -| [devNum](_u_s_b.md#devnum) | USB设备编号 | - - -## **详细描述** - -USB设备信息。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_u_s_b_1_1_usb_ctrl_transfer.md b/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_u_s_b_1_1_usb_ctrl_transfer.md deleted file mode 100644 index 545ea45988ed42a69dd6b855e100795956fb4850..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_u_s_b_1_1_usb_ctrl_transfer.md +++ /dev/null @@ -1,27 +0,0 @@ -# OHOS::USB::UsbCtrlTransfer - - -## **概述** - -**所属模块:** - -[USB](_u_s_b.md) - - -## **汇总** - - -### Public 属性 - - | Public 属性 | 描述 | -| -------- | -------- | -| [requestType](_u_s_b.md#requesttype) | 请求类型 | -| [requestCmd](_u_s_b.md#requestcmd) | 请求命令字 | -| [value](_u_s_b.md#value) | 请求值 | -| [index](_u_s_b.md#index) | 索引 | -| [timeout](_u_s_b.md#timeout) | 超时时间 | - - -## **详细描述** - -USB控制传输。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md b/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md deleted file mode 100644 index 5df0bae75c4fc4c442c14211b38e55b2b928dba5..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md +++ /dev/null @@ -1,24 +0,0 @@ -# OHOS::USB::UsbDev - - -## **概述** - -**所属模块:** - -[USB](_u_s_b.md) - - -## **汇总** - - -### Public 属性 - - | Public 属性 | 描述 | -| -------- | -------- | -| [busNum](_u_s_b.md#busnum-22) | USB总线编号 | -| [devAddr](_u_s_b.md#devaddr) | USB设备地址 | - - -## **详细描述** - -USB设备。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_u_s_b_1_1_usb_info.md b/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_u_s_b_1_1_usb_info.md deleted file mode 100644 index c576768593247cab80492de2de938a982745071c..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_u_s_b_1_1_usb_info.md +++ /dev/null @@ -1,35 +0,0 @@ -# OHOS::USB::UsbInfo - - -## **概述** - -**所属模块:** - -[USB](_u_s_b.md) - - -## **汇总** - - -### Public 成员函数 - - | Public 成员函数 | 描述 | -| -------- | -------- | -| [setDevInfoStatus](_u_s_b.md#setdevinfostatus) (int32_t status) | 设置USB设备状态。 [更多...](_u_s_b.md#setdevinfostatus) | -| [setDevInfoBusNum](_u_s_b.md#setdevinfobusnum) (int32_t busNum) | 设置USB总线编号。 [更多...](_u_s_b.md#setdevinfobusnum) | -| [setDevInfoDevNum](_u_s_b.md#setdevinfodevnum) (int32_t devNum) | 设置USB设备编号。 [更多...](_u_s_b.md#setdevinfodevnum) | -| [getDevInfoStatus](_u_s_b.md#getdevinfostatus) () const | 获取USB设备状态。 [更多...](_u_s_b.md#getdevinfostatus) | -| [getDevInfoBusNum](_u_s_b.md#getdevinfobusnum) () const | 获取USB总线编号。 [更多...](_u_s_b.md#getdevinfobusnum) | -| [getDevInfoDevNum](_u_s_b.md#getdevinfodevnum) () const | 获取USB设备编号。 [更多...](_u_s_b.md#getdevinfodevnum) | - - -### Private 成员变量 - - | Private 成员变量 | 描述 | -| -------- | -------- | -| [USBDeviceInfo](_o_h_o_s_1_1_u_s_b_1_1_u_s_b_device_info.md) devInfo | USB设备信息。 | - - -## **详细描述** - -USB设备信息类。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md b/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md deleted file mode 100644 index e58adfe5cdf7a56550c81967622d862343ac384f..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md +++ /dev/null @@ -1,24 +0,0 @@ -# OHOS::USB::UsbPipe - - -## **概述** - -**所属模块:** - -[USB](_u_s_b.md) - - -## **汇总** - - -### Public 属性 - - | Public 属性 | 描述 | -| -------- | -------- | -| [interfaceId](_u_s_b.md#interfaceid) | USB设备接口ID | -| [endpointId](_u_s_b.md#endpointid) | USB设备端点ID | - - -## **详细描述** - -管道信息。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_u_s_b_1_1_usbd_client.md b/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_u_s_b_1_1_usbd_client.md deleted file mode 100644 index 9bc4102d6e28c072dee510f953bb241cf9413766..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_u_s_b_1_1_usbd_client.md +++ /dev/null @@ -1,62 +0,0 @@ -# OHOS::USB::UsbdClient - - -## **概述** - -**所属模块:** - -[USB](_u_s_b.md) - - -## **汇总** - - -### Public 成员函数 - - | Public 成员函数 | 描述 | -| -------- | -------- | -| [OpenDevice](_u_s_b.md#opendevice) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev) | 打开设备，建立连接。 [更多...](_u_s_b.md#opendevice) | -| [CloseDevice](_u_s_b.md#closedevice) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev) | 关闭设备，释放与设备相关的所有系统资源。 [更多...](_u_s_b.md#closedevice) | -| [GetDeviceDescriptor](_u_s_b.md#getdevicedescriptor) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, std::vector< uint8_t > &descriptor) | 获取设备描述符。 [更多...](_u_s_b.md#getdevicedescriptor) | -| [GetStringDescriptor](_u_s_b.md#getstringdescriptor) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, uint8_t descId, std::vector< uint8_t > &descriptor) | 根据String ID获取设备的字符串描述符。 [更多...](_u_s_b.md#getstringdescriptor) | -| [GetConfigDescriptor](_u_s_b.md#getconfigdescriptor) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, uint8_t descId, std::vector< uint8_t > &descriptor) | 根据config ID获取设备的配置描述符config。 [更多...](_u_s_b.md#getconfigdescriptor) | -| [GetRawDescriptor](_u_s_b.md#getrawdescriptor) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, std::vector< uint8_t > &descriptor) | 获取原始描述符。 [更多...](_u_s_b.md#getrawdescriptor) | -| [GetFileDescriptor](_u_s_b.md#getfiledescriptor) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, int32_t &fd) | 获取文件描述符。 [更多...](_u_s_b.md#getfiledescriptor) | -| [SetConfig](_u_s_b.md#setconfig) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, uint8_t configIndex) | 设置当前的config信息。 [更多...](_u_s_b.md#setconfig) | -| [GetConfig](_u_s_b.md#getconfig) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, uint8_t &configIndex) | 获取当前的config信息。 [更多...](_u_s_b.md#getconfig) | -| [ClaimInterface](_u_s_b.md#claiminterface) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, uint8_t interfaceid, uint8_t force) | 打开接口，并声明独占接口，必须在数据传输前执行。 [更多...](_u_s_b.md#claiminterface) | -| [ReleaseInterface](_u_s_b.md#releaseinterface) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, uint8_t interfaceid) | 关闭接口，释放接口的占用，在停止数据传输后执行。 [更多...](_u_s_b.md#releaseinterface) | -| [SetInterface](_u_s_b.md#setinterface) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, uint8_t interfaceid, uint8_t altIndex) | 设置指定接口的备选设置，用于在具有相同ID但不同备用设置的两个接口之间进行选择。 [更多...](_u_s_b.md#setinterface) | -| [BulkTransferRead](_u_s_b.md#bulktransferread) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, const [UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md) &pipe, int32_t timeout, std::vector< uint8_t > &data) | 在给定端点上执行批量数据读取，返回读取的数据和长度，端点方向必须为数据读取，可以设置超时时间。 [更多...](_u_s_b.md#bulktransferread) | -| [BulkTransferWrite](_u_s_b.md#bulktransferwrite) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, const [UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md) &pipe, int32_t timeout, const std::vector< uint8_t > &data) | 在给定端点上执行批量数据写入， 返回读取的数据和长度，端点方向必须为数据写入。 [更多...](_u_s_b.md#bulktransferwrite) | -| [ControlTransfer](_u_s_b.md#controltransfer) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, const [UsbCtrlTransfer](_o_h_o_s_1_1_u_s_b_1_1_usb_ctrl_transfer.md) &ctrl, std::vector< uint8_t > &data) | 对此设备执行端点零的控制事务，传输方向由请求类型决定。 如果requestType＆ USB_ENDPOINT_DIR_MASK是USB_DIR_OUT ，则传输是写入，如果是USB_DIR_IN ，则传输是读取。 [更多...](_u_s_b.md#controltransfer) | -| [InterruptTransferRead](_u_s_b.md#interrupttransferread) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, const [UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md) &pipe, int32_t timeout, std::vector< uint8_t > &data) | 在给定端点上执行中断数据读取， 返回读取的数据和长度，端点方向必须为数据读取。 [更多...](_u_s_b.md#interrupttransferread) | -| [InterruptTransferWrite](_u_s_b.md#interrupttransferwrite) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, const [UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md) &pipe, int32_t timeout, std::vector< uint8_t > &data) | 在给定端点上执行中断数据写入， 返回读取的数据和长度，端点方向必须为数据写入。 [更多...](_u_s_b.md#interrupttransferwrite) | -| [IsoTransferRead](_u_s_b.md#isotransferread) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, const [UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md) &pipe, int32_t timeout, std::vector< uint8_t > &data) | 在给定端点上执行等时数据读取， 返回读取的数据和长度，端点方向必须为数据读取。 [更多...](_u_s_b.md#isotransferread) | -| [IsoTransferWrite](_u_s_b.md#isotransferwrite) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, const [UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md) &pipe, int32_t timeout, std::vector< uint8_t > &data) | 在给定端点上执行等时数据写入， 返回读取的数据和长度，端点方向必须为数据写入。 [更多...](_u_s_b.md#isotransferwrite) | -| [RequestQueue](_u_s_b.md#requestqueue) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, const [UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md) &pipe, const std::vector< uint8_t > &clientData, const std::vector< uint8_t > &buffer) | 将指定的端点进行异步数据发送或者接收请求，数据传输方向由端点方向决定。 [更多...](_u_s_b.md#requestqueue) | -| [RequestWait](_u_s_b.md#requestwait) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, std::vector< uint8_t > &clientData, std::vector< uint8_t > &buffer, int32_t timeout) | 等待RequestQueue异步请求的操作结果。 [更多...](_u_s_b.md#requestwait) | -| [RequestCancel](_u_s_b.md#requestcancel) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, const [UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md) &pipe) | 取消待处理的数据请求。 [更多...](_u_s_b.md#requestcancel) | -| [GetCurrentFunctions](_u_s_b.md#getcurrentfunctions) (int32_t &funcs) | 获取从设备支持的功能列表（按位域表示）（从设备）。 [更多...](_u_s_b.md#getcurrentfunctions) | -| [SetCurrentFunctions](_u_s_b.md#setcurrentfunctions) (int32_t funcs) | 设置从设备支持的功能列表（按位域表示）（从设备）。 [更多...](_u_s_b.md#setcurrentfunctions) | -| [SetPortRole](_u_s_b.md#setportrole) (int32_t portId, int32_t powerRole, int32_t dataRole) | 设置port端口的角色。 [更多...](_u_s_b.md#setportrole) | -| [QueryPort](_u_s_b.md#queryport) (int32_t &portId, int32_t &powerRole, int32_t &dataRole, int32_t &mode) | 查询port端口的当前设置。 [更多...](_u_s_b.md#queryport) | -| [BindUsbdSubscriber](_u_s_b.md#bindusbdsubscriber) (const sptr< [UsbdSubscriber](_o_h_o_s_1_1_u_s_b_1_1_usbd_subscriber.md) > &subscriber) | 绑定订阅者。 [更多...](_u_s_b.md#bindusbdsubscriber) | -| [UnbindUsbdSubscriber](_u_s_b.md#unbindusbdsubscriber) (const sptr< [UsbdSubscriber](_o_h_o_s_1_1_u_s_b_1_1_usbd_subscriber.md) > &subscriber) | 解绑订阅者。 [更多...](_u_s_b.md#unbindusbdsubscriber) | -| [RegBulkCallback](_u_s_b.md#regbulkcallback) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, const [UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md) &pipe, const sptr< IRemoteObject > &cb) | 注册批量传输异步回调函数。 [更多...](_u_s_b.md#regbulkcallback) | -| [UnRegBulkCallback](_u_s_b.md#unregbulkcallback) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, const [UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md) &pipe) | 注销批量传输异步回调函数。 [更多...](_u_s_b.md#unregbulkcallback) | -| [BulkRead](_u_s_b.md#bulkread) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, const [UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md) &pipe, sptr< Ashmem > &ashmem) | 批量传输异步读数据。 [更多...](_u_s_b.md#bulkread) | -| [BulkWrite](_u_s_b.md#bulkwrite) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, const [UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md) &pipe, sptr< Ashmem > &ashmem) | 批量传输异步写数据。 [更多...](_u_s_b.md#bulkwrite) | -| [BulkCancel](_u_s_b.md#bulkcancel) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, const [UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md) &pipe) | 批量传输异步取消接口，用于取消当前接口的异步批量读写操作。 [更多...](_u_s_b.md#bulkcancel) | - - -### 静态 Public 成员函数 - - | 静态 Public 成员函数 | 描述 | -| -------- | -------- | -| [GetInstance](_u_s_b.md#getinstance) () | 获取实例。 | - - -## 详细描述 - -USB驱动客户端类。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_u_s_b_1_1_usbd_subscriber.md b/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_u_s_b_1_1_usbd_subscriber.md deleted file mode 100644 index 57043338245c2dc4c9531bb08ba21e2abd987d9e..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_u_s_b_1_1_usbd_subscriber.md +++ /dev/null @@ -1,41 +0,0 @@ -# OHOS::USB::UsbdSubscriber - - -## **概述** - -**所属模块:** - -[USB](_u_s_b.md) - - -## **汇总** - - -### Public 成员函数 - - | Public 成员函数 | 描述 | -| -------- | -------- | -| [DeviceEvent](_u_s_b.md#deviceevent) (const [UsbInfo](_o_h_o_s_1_1_u_s_b_1_1_usb_info.md) &info)=0 | 设备事件。 [更多...](_u_s_b.md#deviceevent) | -| [PortChangedEvent](_u_s_b.md#portchangedevent) (int32_t portId, int32_t powerRole, int32_t dataRole, int32_t mode)=0 | 端口改变事件。 [更多...](_u_s_b.md#portchangedevent) | -| [OnRemoteRequest](_u_s_b.md#onremoterequest) (uint32_t code, MessageParcel &data, MessageParcel &reply, MessageOption &option) override | 远程请求。 [更多...](_u_s_b.md#onremoterequest) | - - -### Private 成员函数 - - | Private 成员函数 | 描述 | -| -------- | -------- | -| [OHOS::USB::UsbdSubscriber::ParserUsbInfo](_u_s_b.md#parserusbinfo) (MessageParcel &data, MessageParcel &reply, MessageOption &option, UsbInfo &info) | 解析USB设备信息。 [更多...](_u_s_b.md#parserusbinfo) | -| [OHOS::USB::UsbdSubscriber::ParserPortInfo](_u_s_b.md#parserportinfo) (MessageParcel &data, MessageParcel &reply, MessageOption &option, PortInfo &info) | 解析USB设备端口信息。 [更多...](_u_s_b.md#parserportinfo) | - - -## **详细描述** - -USB驱动订阅类。 - -**Since：** - -3.0 - -**Version：** - -1.0 \ No newline at end of file diff --git a/zh-cn/device-dev/reference/hdi-apis/_omx_codec_buffer.md b/zh-cn/device-dev/reference/hdi-apis/_omx_codec_buffer.md index 9b59c569ce179b8ea38d724027c1726aeeaf40c1..34b9713074eade2f98e39c2e9aa645cb7cd67e3f 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_omx_codec_buffer.md +++ b/zh-cn/device-dev/reference/hdi-apis/_omx_codec_buffer.md @@ -3,9 +3,11 @@ ## **概述** -**所属模块:** +Codec buffer信息的定义。 + +**相关模块:** -[Codec](_codec.md) +[Codec](codec.md) ## **汇总** @@ -13,7 +15,7 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | | [bufferId](#bufferid) | buffer的ID。 | | [size](#size) | 结构体大小。 | @@ -30,11 +32,6 @@ | [flag](#flag) | 标志。 | -## **详细描述** - -Codec buffer信息的定义。 - - ## **类成员变量说明** @@ -47,7 +44,7 @@ uint32_t OmxCodecBuffer::allocLen **描述：** -申请的buffer大小 +申请的buffer大小。 ### buffer @@ -59,7 +56,7 @@ uint8_t* OmxCodecBuffer::buffer **描述：** -编码或者解码使用的buffer +编码或者解码使用的buffer。 ### bufferId @@ -71,7 +68,7 @@ uint32_t OmxCodecBuffer::bufferId **描述：** -buffer ID +buffer ID。 ### bufferLen @@ -83,7 +80,7 @@ uint32_t OmxCodecBuffer::bufferLen **描述：** -buffer大小 +buffer大小。 ### bufferType @@ -95,7 +92,7 @@ enum CodecBufferType OmxCodecBuffer::bufferType **描述：** -buffer类型 +buffer类型。 ### fenceFd @@ -107,7 +104,7 @@ int32_t OmxCodecBuffer::fenceFd **描述：** -该描述符来自buffer消费者，Codec等待成功后才可以使用输入或者输出buffer +该描述符来自buffer消费者，Codec等待成功后才可以使用输入或者输出buffer。 ### filledLen @@ -119,7 +116,7 @@ uint32_t OmxCodecBuffer::filledLen **描述：** -填充的buffer大小 +填充的buffer大小。 ### flag @@ -131,7 +128,7 @@ uint32_t OmxCodecBuffer::flag **描述：** -标志 +标志。 ### offset @@ -143,7 +140,7 @@ uint32_t OmxCodecBuffer::offset **描述：** -有效数据从缓冲区开始的起始偏移量 +有效数据从缓冲区开始的起始偏移量。 ### pts @@ -155,7 +152,7 @@ int64_t OmxCodecBuffer::pts **描述：** -时间戳 +时间戳。 ### size @@ -167,7 +164,7 @@ uint32_t OmxCodecBuffer::size **描述：** -结构体大小 +结构体大小。 ### type @@ -179,7 +176,7 @@ enum ShareMemTypes OmxCodecBuffer::type **描述：** -共享内存类型 +共享内存类型。 ### version @@ -191,4 +188,4 @@ union OMX_VERSIONTYPE OmxCodecBuffer::version **描述：** -组件版本信息 +组件版本信息。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_pin_auth_types_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_pin_auth_types_8idl.md index 9e2a1a49e5be8d62450f959d90cca14151476c7e..8a10abb5afe0b23f994349952633fca6574d9387 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_pin_auth_types_8idl.md +++ b/zh-cn/device-dev/reference/hdi-apis/_pin_auth_types_8idl.md @@ -3,6 +3,12 @@ ## **概述** +定义口令认证驱动的枚举类和数据结构。 + +**Since:** + +3.2 + **所属模块:** [HdfPinAuth](_hdf_pin_auth.md) @@ -13,33 +19,24 @@ ### 类 - | 类 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [ExecutorInfo](_executor_info.md) | 执行器信息。 [更多...](_executor_info.md) | -| [TemplateInfo](_template_info.md) | 凭据模版信息。 [更多...](_template_info.md) | +| [ExecutorInfo](_executor_info.md) | 执行器信息。 | +| [TemplateInfo](_template_info.md) | 凭据模版信息。 | ### 枚举 - | 枚举 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [AuthType](_hdf_pin_auth.md#authtype) : int {   PIN = 1, FACE = 2, FINGERPRINT = 4 } | 枚举用户认证凭据类型。 [更多...](_hdf_face_auth.md#authtype) | -| [ExecutorRole](_hdf_pin_auth.md#executorrole) : int {   COLLECTOR = 1, VERIFIER = 2, ALL_IN_ONE = 3 } | 枚举执行器角色。 [更多...](_hdf_face_auth.md#executorrole) | -| [ExecutorSecureLevel](_hdf_pin_auth.md#executorsecurelevel) : int {   ESL0 = 0, ESL1 = 1, ESL2 = 2, ESL3 = 3 } | 枚举执行器安全等级。 [更多...](_hdf_face_auth.md#executorsecurelevel) | -| [CommandId](_hdf_pin_auth.md#commandid) : int { DEFAULT = 0 } | 枚举口令认证功能相关操作命令。 [更多...](_hdf_face_auth.md#commandid) | +| [AuthType](_hdf_pin_auth.md#authtype): int {   PIN = 1, FACE = 2, FINGERPRINT = 4 } | 枚举用户认证凭据类型。 | +| [ExecutorRole](_hdf_pin_auth.md#executorrole): int {   COLLECTOR = 1, VERIFIER = 2, ALL_IN_ONE = 3 } | 枚举执行器角色。 | +| [ExecutorSecureLevel](_hdf_pin_auth.md#executorsecurelevel): int {   ESL0 = 0, ESL1 = 1, ESL2 = 2, ESL3 = 3 } | 枚举执行器安全等级。 | +| [CommandId](_hdf_pin_auth.md#commandid): int { DEFAULT = 0 } | 枚举口令认证功能相关操作命令。 | -### 变量 +### 关键字 - | 变量 名称 | 描述 | + | 名称 | 描述 | | -------- | -------- | | package ohos.hdi.pin_auth.v1_0 | 口令认证接口的包路径 | - - -## **详细描述** - -定义口令认证驱动的枚举类和数据结构。 - -**Since：** - -3.2 diff --git a/zh-cn/device-dev/reference/hdi-apis/_port_info.md b/zh-cn/device-dev/reference/hdi-apis/_port_info.md new file mode 100644 index 0000000000000000000000000000000000000000..80422dc158b7ddc3353f149bcababf3303f10b93 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_port_info.md @@ -0,0 +1,82 @@ +# PortInfo + + +## **概述** + +USB设备端口信息。 + +**Since:** + +3.2 + +**Version:** + +1.0 + +**相关模块:** + +[USB](usb.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [portId](#portid) | USB设备端口ID。 | +| [powerRole](#powerrole) | USB设备电源角色。 | +| [dataRole](#datarole) | USB设备数据角色。 | +| [mode](#mode) | USB设备模式。 | + + +## **类成员变量说明** + + +### dataRole + + +``` +int PortInfo::dataRole +``` + +**描述：** + +USB设备数据角色。 + + +### mode + + +``` +int PortInfo::mode +``` + +**描述：** + +USB设备模式。 + + +### portId + + +``` +int PortInfo::portId +``` + +**描述：** + +USB设备端口ID。 + + +### powerRole + + +``` +int PortInfo::powerRole +``` + +**描述：** + +USB设备电源角色。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_power_types_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_power_types_8idl.md index 179b60a2a0a0261d0e9d3c8afd29316395f440ef..30be1eeab46b01def03497a8d4ae50c4517e2e92 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_power_types_8idl.md +++ b/zh-cn/device-dev/reference/hdi-apis/_power_types_8idl.md @@ -3,40 +3,37 @@ ## **概述** -**所属模块:** - -[Power](power.md) - +电源相关的数据类型。 -## **汇总** +电源管理中使用的数据类型，包括命令参数、回调参数和系统状态。 +**Since:** -### 枚举 +3.1 - | 枚举 | 描述 | -| -------- | -------- | -| [PowerHdfCmd](power.md#powerhdfcmd) {   CMD_REGISTER_CALLBCK = 0, CMD_START_SUSPEND, CMD_STOP_SUSPEND, CMD_FORCE_SUSPEND,   CMD_SUSPEND_BLOCK, CMD_SUSPEND_UNBLOCK, CMD_DUMP } | 枚举电源命令的参数。 [更多...](power.md#powerhdfcmd) | -| [PowerHdfCallbackCmd](power.md#powerhdfcallbackcmd) { CMD_ON_SUSPEND = 0, CMD_ON_WAKEUP } | 枚举电源状态回调的参数。 [更多...](power.md#powerhdfcallbackcmd) | -| [PowerHdfState](power.md#powerhdfstate) { AWAKE = 0, INACTIVE, SLEEP } | 枚举电源的状态。 [更多...](power.md#powerhdfstate) | +**Version:** +1.0 -### 变量 +**相关模块:** - | 变量 名称 | 描述 | -| -------- | -------- | -| package ohos.hdi.power.v1_0 | 电源管理接口的包路径 | +[Power](power.md) -## **详细描述** +## **汇总** -电源相关的数据类型。 -电源管理中使用的数据类型，包括命令参数、回调参数和系统状态。 +### 枚举 -**Since：** + | 名称 | 描述 | +| -------- | -------- | +| [PowerHdfCmd](power.md#powerhdfcmd) {   CMD_REGISTER_CALLBCK = 0, CMD_START_SUSPEND, CMD_STOP_SUSPEND, CMD_FORCE_SUSPEND,   CMD_SUSPEND_BLOCK, CMD_SUSPEND_UNBLOCK, CMD_DUMP } | 枚举电源命令的参数。 | +| [PowerHdfCallbackCmd](power.md#powerhdfcallbackcmd) { CMD_ON_SUSPEND = 0, CMD_ON_WAKEUP } | 枚举电源状态回调的参数。 | +| [PowerHdfState](power.md#powerhdfstate) { AWAKE = 0, INACTIVE, SLEEP } | 枚举电源的状态。 | -3.1 -**Version：** +### 关键字 -1.0 + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.power.v1_0 | 电源模块接口的包路径。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_present_timestamp.md b/zh-cn/device-dev/reference/hdi-apis/_present_timestamp.md index 75be9d799ef7eb95d18e7484fcf739a32cf44408..b10f8ce64080ce7d2becd8ca098d5f5836573efc 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_present_timestamp.md +++ b/zh-cn/device-dev/reference/hdi-apis/_present_timestamp.md @@ -3,7 +3,9 @@ ## **概述** -**所属模块:** +上屏时间戳结构体定义。 + +**相关模块:** [Display](_display.md) @@ -13,12 +15,7 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [type](_display.md#type-33) | 上屏时间戳类型 | +| [type](_display.md#type-37) | 上屏时间戳类型 | | [time](_display.md#time) | 类型对应的值 | - - -## **详细描述** - -上屏时间戳结构体定义。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_projection_screen_cmd_param.md b/zh-cn/device-dev/reference/hdi-apis/_projection_screen_cmd_param.md new file mode 100644 index 0000000000000000000000000000000000000000..baac9ef747bea6a6dd2036e24677077acffefeba --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_projection_screen_cmd_param.md @@ -0,0 +1,56 @@ +# ProjectionScreenCmdParam + + +## **概述** + +投屏参数。 + +**Since:** + +3.2 + +**Version:** + +1.0 + +**相关模块:** + +[WLAN](wlan.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [cmdId](#cmdid) | 投屏命令ID。 | +| [buf](#buf) | 投屏命令内容。 | + + +## **类成员变量说明** + + +### buf + + +``` +byte [] ProjectionScreenCmdParam::buf +``` + +**描述：** + +投屏命令内容。 + + +### cmdId + + +``` +int ProjectionScreenCmdParam::cmdId +``` + +**描述：** + +投屏命令ID。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_property_object.md b/zh-cn/device-dev/reference/hdi-apis/_property_object.md index 5520d0be40f9064035c5f374f32739ebe89798dc..2bc7c1197be43e77c135cfc654ea93bf5487f1e9 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_property_object.md +++ b/zh-cn/device-dev/reference/hdi-apis/_property_object.md @@ -3,7 +3,9 @@ ## **概述** -**所属模块:** +定义包含名称、属性ID和值的属性对象。 + +**相关模块:** [Display](_display.md) @@ -13,13 +15,8 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [name](_display.md#name-12) [PROPERTY_NAME_LEN] | 属性名称 | +| [name](_display.md#name-12) | 属性名称 | | [propId](_display.md#propid) | 属性ID | | [value](_display.md#value-12) | 属性值 | - - -## **详细描述** - -定义包含名称、属性ID和值的属性对象。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_r_g_b_color.md b/zh-cn/device-dev/reference/hdi-apis/_r_g_b_color.md new file mode 100644 index 0000000000000000000000000000000000000000..2dad0607e021b2ba53ffc416191414cc21f9b20c --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_r_g_b_color.md @@ -0,0 +1,82 @@ +# RGBColor + + +## **概述** + +定义灯的RGB模式。 + +**Since:** + +3.2 + +**Version:** + +1.0 + +**相关模块:** + +[Light](light.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [brightness](#brightness) | 亮度值，范围为0-255。 | +| [r](#r) | 红色值，范围为0-255。 | +| [g](#g) | 绿色值，范围为0-255。 | +| [b](#b) | 蓝色值，范围为0-255。 | + + +## **类成员变量说明** + + +### b + + +``` +int RGBColor::b +``` + +**描述：** + +蓝色值，范围为0-255。 + + +### brightness + + +``` +int RGBColor::brightness +``` + +**描述：** + +亮度值，范围为0-255。 + + +### g + + +``` +int RGBColor::g +``` + +**描述：** + +绿色值，范围为0-255。 + + +### r + + +``` +int RGBColor::r +``` + +**描述：** + +红色值，范围为0-255。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_range_value.md b/zh-cn/device-dev/reference/hdi-apis/_range_value.md index 723b312f4a6bb0b12078398487a4ba026204d60d..5afe5c033bd0a41a78f7e27f7cfd3bcf030781a4 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_range_value.md +++ b/zh-cn/device-dev/reference/hdi-apis/_range_value.md @@ -3,9 +3,11 @@ ## **概述** -**所属模块:** +取值范围的定义。 + +**相关模块:** -[Codec](_codec.md) +[Codec](codec.md) ## **汇总** @@ -13,15 +15,10 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [min](#min) | 最小值 | -| [max](#max) | 最大值 | - - -## **详细描述** - -取值范围的定义。 +| [min](#min) | 最小值。 | +| [max](#max) | 最大值。 | ## **类成员变量说明** @@ -36,7 +33,7 @@ int32_t RangeValue::max **描述：** -最大值 +最大值。 ### min @@ -48,4 +45,4 @@ int32_t RangeValue::min **描述：** -最小值 +最小值。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_rect.md b/zh-cn/device-dev/reference/hdi-apis/_rect.md index c241e45e26485c1110984ac3a9bd24cfecb53422..350fd817c80e9404dfa0e74ba9fe4111432ec635 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_rect.md +++ b/zh-cn/device-dev/reference/hdi-apis/_rect.md @@ -3,9 +3,11 @@ ## **概述** -**所属模块:** +矩形的定义。 + +**相关模块:** -[Codec](_codec.md) +[Codec](codec.md) ## **汇总** @@ -13,15 +15,10 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [width](#width) | 矩形的宽 | -| [height](#height) | 矩形的高 | - - -## **详细描述** - -矩形的定义。 +| [width](#width) | 矩形的宽。 | +| [height](#height) | 矩形的高。 | ## **类成员变量说明** @@ -36,7 +33,7 @@ int32_t Rect::height **描述：** -矩形的高 +矩形的高。 ### width @@ -48,4 +45,4 @@ int32_t Rect::width **描述：** -矩形的宽 +矩形的宽。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_rectangle.md b/zh-cn/device-dev/reference/hdi-apis/_rectangle.md index 374827e42143f6317681811d5d2c53c30469ced8..3f26acf96fe0616a6adcca985d4fada805616e80 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_rectangle.md +++ b/zh-cn/device-dev/reference/hdi-apis/_rectangle.md @@ -3,7 +3,9 @@ ## **概述** -**所属模块:** +矩形描述结构体定义，用于硬件加速绘制矩形。 + +**相关模块:** [Display](_display.md) @@ -13,12 +15,7 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [rect](_display.md#rect) | 矩形区域 | -| [color](_display.md#color-33) | 矩形颜色 | - - -## **详细描述** - -矩形描述结构体定义，用于硬件加速绘制矩形。 +| [rect](_display.md#rect-13) | 矩形区域 | +| [color](_display.md#color-35) | 矩形颜色 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_schedule_info.md b/zh-cn/device-dev/reference/hdi-apis/_schedule_info.md index 4fcebffea49a53a5907520898ee73d4e84f4b09e..3c44bee576d39e82ce87ee18ad846d0761c5866f 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_schedule_info.md +++ b/zh-cn/device-dev/reference/hdi-apis/_schedule_info.md @@ -3,6 +3,16 @@ ## **概述** +调度信息。 + +**Since：** + +3.2 + +**Version：** + +1.0 + **所属模块:** [HdfUserAuth](_hdf_user_auth.md) @@ -13,7 +23,7 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | | [scheduleId](#scheduleid) | 调度ID，用于标识一次操作请求的执行器调度过程。 | | [templateIds](#templateids) | 模版ID列表。 | @@ -23,19 +33,6 @@ | [executors](#executors) | 执行器信息列表。 | -## **详细描述** - -调度信息。 - -**Since：** - -3.2 - -**Version：** - -1.0 - - ## **类成员变量说明** diff --git a/zh-cn/device-dev/reference/hdi-apis/_sensor.md b/zh-cn/device-dev/reference/hdi-apis/_sensor.md deleted file mode 100644 index 14532c876f32809336fcc266e4e145f2a4eb5a2a..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_sensor.md +++ /dev/null @@ -1,326 +0,0 @@ -# Sensor - - -## **汇总** - - -### 文件 - -| 文件 | 描述 | -| -------- | -------- | -| [sensor_if.h](sensor__if_8h.md) | Sensor模块对外通用的接口声明文件，提供获取传感器设备信息、订阅/取消订阅传感器数据、 使能/去使能传感器、设置传感器模式、设置传感器精度，量程等可选配置接口定义。 | -| [sensor_type.h](sensor__type_8h.md) | 定义传感器模块所使用的传感器类型，传感器信息，传感器数据结构等数据类型。 | - - -### 类 - -| 类 | 描述 | -| -------- | -------- | -| [SensorInterface](_sensor_interface.md) | 提供sensor设备基本控制操作接口。 [更多...](_sensor_interface.md) | -| [SensorInformation](_sensor_information.md) | 定义传感器基本信息。 [更多...](_sensor_information.md) | -| [SensorEvents](_sensor_events.md) | 上报传感器数据结构。 [更多...](_sensor_events.md) | - - -### 宏定义 - -| 宏定义 | 描述 | -| -------- | -------- | -| [SENSOR_NAME_MAX_LEN](#sensor_name_max_len)   32 | Sensor名称的最大长度。 | -| [SENSOR_VERSION_MAX_LEN](#sensor_version_max_len)   16 | Sensor版本号的最大长度。 | - - -### 类型定义 - -| 类型定义 | 描述 | -| -------- | -------- | -| ([RecordDataCallback](#recorddatacallback)) (const struct [SensorEvents](_sensor_events.md) \*) | 传感器上报数据回调函数的定义，传感器服务用户在订阅传感器时， 需要注册上报数据回调函数，传感器使能后，传感器服务用户可以接受到传感器数据，详见[SensorInterface](_sensor_interface.md)。 [更多...](#recorddatacallback) | - - -### 枚举 - -| 枚举 | 描述 | -| -------- | -------- | -| [SensorStatus](#sensorstatus) { SENSOR_SUCCESS = 0, SENSOR_FAILURE = -1, SENSOR_NOT_SUPPORT = -2, SENSOR_INVALID_PARAM = -3,   SENSOR_INVALID_SERVICE = -4, SENSOR_NULL_PTR = -5 } | 定义传感器模块返回值类型。 [更多...](#sensorstatus) | -| [SensorTypeTag](#sensortypetag) { SENSOR_TYPE_NONE = 0, SENSOR_TYPE_ACCELEROMETER = 1, SENSOR_TYPE_GYROSCOPE = 2, SENSOR_TYPE_PHOTOPLETHYSMOGRAPH = 3,   SENSOR_TYPE_ELECTROCARDIOGRAPH = 4, SENSOR_TYPE_AMBIENT_LIGHT = 5, SENSOR_TYPE_MAGNETIC_FIELD = 6, SENSOR_TYPE_CAPACITIVE = 7,   SENSOR_TYPE_BAROMETER = 8, SENSOR_TYPE_TEMPERATURE = 9, SENSOR_TYPE_HALL = 10, SENSOR_TYPE_GESTURE = 11,   SENSOR_TYPE_PROXIMITY = 12, SENSOR_TYPE_HUMIDITY = 13, SENSOR_TYPE_MEDICAL_BEGIN = 128, SENSOR_TYPE_MEDICAL_END = 160,   SENSOR_TYPE_PHYSICAL_MAX = 255, SENSOR_TYPE_ORIENTATION = 256, SENSOR_TYPE_GRAVITY = 257, SENSOR_TYPE_LINEAR_ACCELERATION = 258,   SENSOR_TYPE_ROTATION_VECTOR = 259, SENSOR_TYPE_AMBIENT_TEMPERATURE = 260, SENSOR_TYPE_MAGNETIC_FIELD_UNCALIBRATED = 261, SENSOR_TYPE_GAME_ROTATION_VECTOR = 262,   SENSOR_TYPE_GYROSCOPE_UNCALIBRATED = 263, SENSOR_TYPE_SIGNIFICANT_MOTION = 264, SENSOR_TYPE_PEDOMETER_DETECTION = 265, SENSOR_TYPE_PEDOMETER = 266,   SENSOR_TYPE_GEOMAGNETIC_ROTATION_VECTOR = 277, SENSOR_TYPE_HEART_RATE = 278, SENSOR_TYPE_DEVICE_ORIENTATION = 279, SENSOR_TYPE_WEAR_DETECTION = 280,   SENSOR_TYPE_ACCELEROMETER_UNCALIBRATED = 281, SENSOR_TYPE_MAX } | 定义传感器类型标识。 [更多...](#sensortypetag) | -| [SensorAccuracyType](#sensoraccuracytype) { SENSOR_NO_ACCURACY = 0, SENSOR_LOW_ACCURACY = 1, SENSOR_MEDIUM_ACCURACY = 2, SENSOR_HIGH_ACCURACY = 3,   SENSOR_MAX_ACCURACY } | 传感器的精度类型。 [更多...](#sensoraccuracytype) | -| [SensorRangeType](#sensorrangetype) { SENSOR_RANGE_LEVEL1 = 0, SENSOR_RANGE_LEVEL2 = 1, SENSOR_RANGE_LEVEL3 = 2, SENSOR_RANGE_LEVEL_MAX } | 传感器的量程级别。 [更多...](#sensorrangetype) | -| [SensorModeType](#sensormodetype) { SENSOR_MODE_DEFAULT = 0, SENSOR_MODE_REALTIME = 1, SENSOR_MODE_ON_CHANGE = 2, SENSOR_MODE_ONE_SHOT = 3,   SENSOR_MODE_FIFO_MODE = 4, SENSOR_MODE_MAX } | 传感器的工作模式。 [更多...](#sensormodetype) | -| [SensorGroupType](#sensorgrouptype) { TRADITIONAL_SENSOR_TYPE = 0, MEDICAL_SENSOR_TYPE = 1, SENSOR_GROUP_TYPE_MAX } | 枚举传感器的硬件服务组。 [更多...](#sensorgrouptype) | - - -### 函数 - -| 函数 | 描述 | -| -------- | -------- | -| [NewSensorInterfaceInstance](#newsensorinterfaceinstance) (void) | 创建传感器接口实例。 [更多...](#newsensorinterfaceinstance) | -| [FreeSensorInterfaceInstance](#freesensorinterfaceinstance) (void) | 释放传感器接口实例。 [更多...](#freesensorinterfaceinstance) | - - -## **详细描述** - -传感器设备驱动对传感器服务提供通用的接口能力。 - -模块提供传感器服务对传感器驱动访问统一接口，服务获取驱动对象或者代理后， 通过其提供的各类方法，以传感器id区分访问不同类型传感器设备，实现获取传感器设备信息、订阅/取消订阅传感器数据、 使能/去使能传感器、设置传感器模式、设置传感器精度、量程等可选配置等。 - -**Since：** - -2.2 - -**Version：** - -1.0 - - -## **宏定义说明** - - -### SENSOR_NAME_MAX_LEN - - -``` -#define SENSOR_NAME_MAX_LEN 32 -``` - -**描述：** - -Sensor名称的最大长度。 - - -### SENSOR_VERSION_MAX_LEN - - -``` -#define SENSOR_VERSION_MAX_LEN 16 -``` - -**描述：** - -Sensor版本号的最大长度。 - - -## **类型定义说明** - - -### RecordDataCallback - - -``` -typedef int32_t(* RecordDataCallback) (const struct SensorEvents *) -``` - -**描述：** - -传感器上报数据回调函数的定义，传感器服务用户在订阅传感器时， 需要注册上报数据回调函数，传感器使能后，传感器服务用户可以接受到传感器数据，详见[SensorInterface](_sensor_interface.md)。 - - -## **枚举类型说明** - - -### SensorAccuracyType - - -``` -enum SensorAccuracyType -``` - -**描述：** - -传感器的精度类型。 - -| 枚举值 | 描述 | -| -------- | -------- | -| SENSOR_NO_ACCURACY | 无精度类型。 | -| SENSOR_LOW_ACCURACY | 低精度类型。 | -| SENSOR_MEDIUM_ACCURACY | 中等精度类型。 | -| SENSOR_HIGH_ACCURACY | 高精度类型。 | -| SENSOR_MAX_ACCURACY | 最大精度类型。 | - - -### SensorGroupType - - -``` -enum SensorGroupType -``` - -**描述：** - -枚举传感器的硬件服务组。 - -| 枚举值 | 描述 | -| -------- | -------- | -| TRADITIONAL_SENSOR_TYPE | 传统传感器类型，传感器ID枚举值范围为128-160。 | -| MEDICAL_SENSOR_TYPE | 医疗传感器类型，传感器ID枚举值范围不在128-160之间。 | -| SENSOR_GROUP_TYPE_MAX | 最大传感器类型。 | - - -### SensorModeType - - -``` -enum SensorModeType -``` - -**描述：** - -传感器的工作模式。 - -| 枚举值 | 描述 | -| -------- | -------- | -| SENSOR_MODE_DEFAULT | 传感器默认工作模式状态。 | -| SENSOR_MODE_REALTIME | 传感器实时工作模式状态，一组数据上报一次。 | -| SENSOR_MODE_ON_CHANGE | 传感器实时工作模式状态，状态变更上报一次。 | -| SENSOR_MODE_ONE_SHOT | 传感器实时工作模式状态，只上报一次。 | -| SENSOR_MODE_FIFO_MODE | 传感器缓存工作模式状态，根据配置的缓存大小上报。 | -| SENSOR_MODE_MAX | 传感器最大类型标识。 | - - -### SensorRangeType - - -``` -enum SensorRangeType -``` - -**描述：** - -传感器的量程级别。 - -| 枚举值 | 描述 | -| -------- | -------- | -| SENSOR_RANGE_LEVEL1 | 量程级别1。 | -| SENSOR_RANGE_LEVEL2 | 量程级别2。 | -| SENSOR_RANGE_LEVEL3 | 量程级别3。 | -| SENSOR_RANGE_LEVEL_MAX | 量程最大级别。 | - - -### SensorStatus - - -``` -enum SensorStatus -``` - -**描述：** - -定义传感器模块返回值类型。 - -| 枚举值 | 描述 | -| -------- | -------- | -| SENSOR_SUCCESS | 传感器执行成功。 | -| SENSOR_FAILURE | 传感器执行失败。 | -| SENSOR_NOT_SUPPORT | 传感器不支持。 | -| SENSOR_INVALID_PARAM | 传感器无效参数。 | -| SENSOR_INVALID_SERVICE | 传感器无效服务。 | -| SENSOR_NULL_PTR | 传感器空指针。 | - - -### SensorTypeTag - - -``` -enum SensorTypeTag -``` - -**描述：** - -定义传感器类型标识。 - -| 枚举值 | 描述 | -| -------- | -------- | -| SENSOR_TYPE_NONE | 空传感器类型，用于测试。 | -| SENSOR_TYPE_ACCELEROMETER | 加速度传感器。 | -| SENSOR_TYPE_GYROSCOPE | 陀螺仪传感器。 | -| SENSOR_TYPE_PHOTOPLETHYSMOGRAPH | 心率传感器。 | -| SENSOR_TYPE_ELECTROCARDIOGRAPH | 心电传感器。 | -| SENSOR_TYPE_AMBIENT_LIGHT | 环境光传感器。 | -| SENSOR_TYPE_MAGNETIC_FIELD | 地磁传感器。 | -| SENSOR_TYPE_CAPACITIVE | 电容传感器。 | -| SENSOR_TYPE_BAROMETER | 气压计传感器。 | -| SENSOR_TYPE_TEMPERATURE | 温度传感器。 | -| SENSOR_TYPE_HALL | 霍尔传感器。 | -| SENSOR_TYPE_GESTURE | 手势传感器。 | -| SENSOR_TYPE_PROXIMITY | 接近光传感器。 | -| SENSOR_TYPE_HUMIDITY | 湿度传感器。 | -| SENSOR_TYPE_MEDICAL_BEGIN | 医疗传感器ID枚举值范围的开始。 | -| SENSOR_TYPE_MEDICAL_END | 医疗传感器ID枚举值范围的结束。 | -| SENSOR_TYPE_PHYSICAL_MAX | 物理传感器最大类型。 | -| SENSOR_TYPE_ORIENTATION | 方向传感器。 | -| SENSOR_TYPE_GRAVITY | 重力传感器。 | -| SENSOR_TYPE_LINEAR_ACCELERATION | 线性加速度传感器。 | -| SENSOR_TYPE_ROTATION_VECTOR | 旋转矢量传感器。 | -| SENSOR_TYPE_AMBIENT_TEMPERATURE | 环境温度传感器 | -| SENSOR_TYPE_MAGNETIC_FIELD_UNCALIBRATED | 未校准磁场传感器。 | -| SENSOR_TYPE_GAME_ROTATION_VECTOR | 游戏旋转矢量传感器。 | -| SENSOR_TYPE_GYROSCOPE_UNCALIBRATED | 未校准陀螺仪传感器。 | -| SENSOR_TYPE_SIGNIFICANT_MOTION | 大幅度动作传感器。 | -| SENSOR_TYPE_PEDOMETER_DETECTION | 计步器检测传感器。 | -| SENSOR_TYPE_PEDOMETER | 计步器传感器。 | -| SENSOR_TYPE_GEOMAGNETIC_ROTATION_VECTOR | 地磁旋转矢量传感器。 | -| SENSOR_TYPE_HEART_RATE | 心率传感器。 | -| SENSOR_TYPE_DEVICE_ORIENTATION | 设备方向传感器。 | -| SENSOR_TYPE_WEAR_DETECTION | 佩戴检测传感器。 | -| SENSOR_TYPE_ACCELEROMETER_UNCALIBRATED | 未校准加速度传感器。 | -| SENSOR_TYPE_MAX | 传感器类型最大个数标识。 | - - -## **函数说明** - - -### FreeSensorInterfaceInstance() - - -``` -int32_t FreeSensorInterfaceInstance (void ) -``` - -**描述：** - -释放传感器接口实例。 - -**返回：** - -如果释放实例成功，则返回0。 - -如果释放实例失败，则返回负值。 - -**Since：** - -2.2 - -**Version：** - -1.0 - - -### NewSensorInterfaceInstance() - - -``` -const struct SensorInterface* NewSensorInterfaceInstance (void ) -``` - -**描述：** - -创建传感器接口实例。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| sensorId | 表示传感器ID。有关详细信息，详见[SensorTypeTag](#sensortypetag)。 | -| cb | 表示要注册的回调函数。有关详细信息，详见[RecordDataCallback](#recorddatacallback)。 | - -**返回：** - -如果创建实例成功，则返回非零值。 - -如果创建实例失败，则返回负值。 - -**Since：** - -2.2 - -**Version：** - -1.0 diff --git a/zh-cn/device-dev/reference/hdi-apis/_sensor_events.md b/zh-cn/device-dev/reference/hdi-apis/_sensor_events.md deleted file mode 100644 index 399be8a87a2254510a176a0053cb7182e00bd953..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_sensor_events.md +++ /dev/null @@ -1,122 +0,0 @@ -# SensorEvents - - -## **概述** - -**所属模块:** - -[Sensor](_sensor.md) - - -## **汇总** - - -### Public 属性 - - | Public 属性 | 描述 | -| -------- | -------- | -| [sensorId](#sensorid) | 传感器的标识号。 | -| [version](#version) | 传感器算法版本号。 | -| [timestamp](#timestamp) | 传感器数据生成时间。 | -| [option](#option) | 传感器量程精度可选配置。 | -| [mode](#mode) | 传感器工作模式。 | -| [data](#data) | 传感器数据地址。 | -| [dataLen](#datalen) | 传感器数据长度。 | - - -## **详细描述** - -上报传感器数据结构。 - -上报传感器设备数据事件信息包括传感器的标识号、传感器算法版本号、传感器数据生成时间、传感器量程精度可选配置、传感器工作模式、传感器数据地址、传感器数据长度。 - -**Since：** - -2.2 - - -## **类成员变量说明** - - -### data - - -``` -uint8_t* SensorEvents::data -``` - -**描述：** - -传感器数据地址。 - - -### mode - - -``` -int32_t SensorEvents::mode -``` - -**描述：** - -传感器工作模式。 - - -### option - - -``` -uint32_t SensorEvents::option -``` - -**描述：** - -传感器量程精度可选配置。 - - -### sensorId - - -``` -int32_t SensorEvents::sensorId -``` - -**描述：** - -传感器的标识号。 - - -### timestamp - - -``` -int64_t SensorEvents::timestamp -``` - -**描述：** - -传感器数据生成时间。 - - -### version - - -``` -int32_t SensorEvents::version -``` - -**描述：** - -传感器算法版本号。 - - -### dataLen - - -``` -int32_t SensorEvents::dataLen -``` - -**描述：** - -传感器算法版本号。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_sensor_information.md b/zh-cn/device-dev/reference/hdi-apis/_sensor_information.md deleted file mode 100644 index 083c23aab81e737015db46d92d10380f6775cbdb..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_sensor_information.md +++ /dev/null @@ -1,148 +0,0 @@ -# SensorInformation - - -## **概述** - -**所属模块:** - -[Sensor](_sensor.md) - - -## **汇总** - - -### Public 属性 - -| Public 属性 | 描述 | -| -------- | -------- | -| [sensorName](#sensorname) [[SENSOR_NAME_MAX_LEN](_sensor.md#sensornamemaxlen)] | 传感器名称。 | -| [vendorName](#vendorname) [[SENSOR_NAME_MAX_LEN](_sensor.md#sensornamemaxlen)] | 传感器设备厂商。 | -| [firmwareVersion](#firmwareversion) [[SENSOR_VERSION_MAX_LEN](_sensor.md#sensorversionmaxlen)] | 传感器固件版本号。 | -| [hardwareVersion](#hardwareversion)
[[SENSOR_VERSION_MAX_LEN](_sensor.md#sensorversionmaxlen)] | 传感器硬件版本号。 | -| [sensorTypeId](#sensortypeid) | 传感器类型编号。 | -| [sensorId](#sensorid) | 传感器的标识号，由传感器驱动开发者定义。 | -| [maxRange](#maxrange) | 传感器的最大量程。 | -| [accuracy](#accuracy) | 传感器的精度。 | -| [power](#power) | 传感器的功耗。 | - - -## **详细描述** - -定义传感器基本信息。 - -一个传感器设备信息包括传感器名字、设备厂商、固件版本号、硬件版本号、传感器类型编号、传感器标识、最大量程、精度、功耗。 - -**Since：** - -2.2 - - -## **类成员变量说明** - - -### accuracy - - -``` -float SensorInformation::accuracy -``` - -**描述：** - -传感器的精度。 - - -### firmwareVersion - - -``` -char SensorInformation::firmwareVersion[SENSOR_VERSION_MAX_LEN] -``` - -**描述：** - -传感器固件版本号。 - - -### hardwareVersion - - -``` -char SensorInformation::hardwareVersion[SENSOR_VERSION_MAX_LEN] -``` - -**描述：** - -传感器硬件版本号。 - - -### maxRange - - -``` -float SensorInformation::maxRange -``` - -**描述：** - -传感器的最大量程。 - - -### sensorId - - -``` -int32_t SensorInformation::sensorId -``` - -**描述：** - -传感器的标识号，由传感器驱动开发者定义。 - - -### sensorName - - -``` -char SensorInformation::sensorName[SENSOR_NAME_MAX_LEN] -``` - -**描述：** - -传感器名称。 - - -### sensorTypeId - - -``` -int32_t SensorInformation::sensorTypeId -``` - -**描述：** - -传感器类型编号，唯一标识一个传感器设备类型，详见[SensorTypeTag](_sensor.md#sensortypetag)。 - - -### vendorName - - -``` -char SensorInformation::vendorName[SENSOR_NAME_MAX_LEN] -``` - -**描述：** - -传感器设备厂商。 - - -### power - - -``` -char SensorInformation::power -``` - -**描述：** - -传感器的功耗。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_sensor_interface.md b/zh-cn/device-dev/reference/hdi-apis/_sensor_interface.md deleted file mode 100644 index a6c64a9af33a52941b36c03b13843f780e9d518f..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_sensor_interface.md +++ /dev/null @@ -1,234 +0,0 @@ -# SensorInterface - - -## **概述** - -**所属模块:** - -[Sensor](_sensor.md) - - -## **汇总** - - -### Public 属性 - -| Public 属性 | 描述 | -| -------- | -------- | -| ( [GetAllSensors](#getallsensors) )([out] struct [SensorInformation](_sensor_information.md) \*\*sensorInfo, [out] int32_t \*count) | 获取当前系统中所有类型的传感器信息。 [更多...](#getallsensors) | -| ( [Enable](#enable) )([in] int32_t sensorId) | 根据传感器设备类型标识使能传感器信息列表里存在的设备，只有数据订阅者使能传感器后，才能获取订阅的传感器数据。 [更多...](#enable) | -| ( [Disable](#disable) )([in] int32_t sensorId) | 根据传感器设备类型标识去使能传感器信息列表里存在的设备。 [更多...](#disable) | -| ( [SetBatch](#setbatch) )([in] int32_t sensorId, [in] int64_t samplingInterval, [in] int64_t reportInterval) | 设置指定传感器的数据采样间隔和数据上报间隔。 [更多...](#setbatch) | -| ( [SetMode](#setmode) )([in] int32_t sensorId, [in] int32_t mode) | 设置指定传感器的数据上报模式，不同的工作模式，上报数据的方式不同。 [更多...](#setmode) | -| ( [SetOption](#setoption) )([in] int32_t sensorId, [in] uint32_t option) | 设置指定传感器量程、精度等可选配置。 [更多...](#setoption) | -| ( [Register](#register) )([in] int32_t groupId, [in] [RecordDataCallback](_sensor.md#recorddatacallback) cb) | 订阅者注册传感器数据回调函数，系统会将获取到的传感器数据上报给订阅者。 [更多...](#register) | -| ( [Unregister](#unregister) )([in] int32_t groupId, [in] [RecordDataCallback](_sensor.md#recorddatacallback) cb) | 订阅者取消注册传感器数据回调函数。 [更多...](#unregister) | - - -## **详细描述** - -提供sensor设备基本控制操作接口。 - -结构体提供获取传感器设备信息、订阅/取消订阅传感器数据、使能/去使能传感器、设置传感器模式、设置传感器精度、量程等可选配置接口定义。 - - -## **类成员变量说明** - - -### Disable - - -``` -int32_t(* SensorInterface::Disable) ([in] int32_t sensorId) -``` - -**描述：** - -根据传感器设备类型标识去使能传感器信息列表里存在的设备。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| sensorId | 唯一标识一个传感器设备类型，详见[SensorTypeTag](_sensor.md#sensortypetag)。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - - -### Enable - - -``` -int32_t(* SensorInterface::Enable) ([in] int32_t sensorId) -``` - -**描述：** - -根据传感器设备类型标识使能传感器信息列表里存在的设备，只有数据订阅者使能传感器后，才能获取订阅的传感器数据。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| sensorId | 唯一标识一个传感器设备类型，详见[SensorTypeTag](_sensor.md#sensortypetag)。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - - -### GetAllSensors - - -``` -int32_t(* SensorInterface::GetAllSensors) ([out] struct SensorInformation **sensorInfo,[out] int32_t *count) -``` - -**描述：** - -获取当前系统中所有类型的传感器信息。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| sensorInfo | 输出系统中注册的所有传感器信息，一种类型传感器信息包括传感器名字、设备厂商、 固件版本号、硬件版本号、传感器类型编号、传感器标识、最大量程、精度、功耗，详见[SensorInformation](_sensor_information.md)。 | -| count | 输出系统中注册的传感器数量。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - - -### Register - - -``` -int32_t(* SensorInterface::Register) ([in] int32_t groupId,[in] RecordDataCallback cb) -``` - -**描述：** - -订阅者注册传感器数据回调函数，系统会将获取到的传感器数据上报给订阅者。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| groupId | 传感器组ID。 sensorId枚举值范围为128-160，表示已订阅医疗传感器服务，只需成功订阅一次，无需重复订阅。 sensorId枚举值范围不在128-160之间，这意味着传统传感器已订阅，只需成功订阅一次，无需重复订阅。 | -| cb | 要注册的回调函数，详见[RecordDataCallback](_sensor.md#recorddatacallback)。 | - -**返回：** - -如果注册回调函数成功，则返回0。 - -如果注册回调函数失败，则返回负数。 - - -### SetBatch - - -``` -int32_t(* SensorInterface::SetBatch) ([in] int32_t sensorId,[in] int64_t samplingInterval,[in] int64_t reportInterval) -``` - -**描述：** - -设置指定传感器的数据采样间隔和数据上报间隔。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| sensorId | 唯一标识一个传感器设备类型，详见[SensorTypeTag](_sensor.md#sensortypetag)。 | -| samplingInterval | 设置指定传感器的数据采样间隔，单位纳秒。 | -| reportInterval | 表示传感器数据上报间隔，单位纳秒。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - - -### SetMode - - -``` -int32_t(* SensorInterface::SetMode) ([in] int32_t sensorId,[in] int32_t mode) -``` - -**描述：** - -设置指定传感器的数据上报模式，不同的工作模式，上报数据的方式不同。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| sensorId | 唯一标识一个传感器设备类型，详见[SensorTypeTag](_sensor.md#sensortypetag)。 | -| mode | 传感器的数据上报模式，详见[SensorModeType](_sensor.md#sensormodetype)。 | - -**返回：** - -如果设置传感器数据报告模式成功，则返回0。 - -如果设置传感器数据报告模式失败，则返回负数。 - - -### SetOption - - -``` -int32_t(* SensorInterface::SetOption) ([in] int32_t sensorId,[in] uint32_t option) -``` - -**描述：** - -设置指定传感器量程、精度等可选配置。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| sensorId | 唯一标识一个传感器设备类型，详见[SensorTypeTag](_sensor.md#sensortypetag)。 | -| option | 传感器的量程、精度等配置。 | - -**返回：** - -如果设置参数成功，则返回0。 - -如果设置参数失败，则返回负数。 - - -### Unregister - - -``` -int32_t(* SensorInterface::Unregister) ([in] int32_t groupId,[in] RecordDataCallback cb) -``` - -**描述：** - -订阅者取消注册传感器数据回调函数。 - -**参数：** - -| 名称 | 描述 | -| -------- | -------- | -| groupId | 传感器组ID。 sensorId枚举值范围为128-160，表示已订阅医疗传感器服务。只需成功取消订阅一次，无需重复取消订阅。 sensorId枚举值范围不在128-160之间，这意味着传统传感器已订阅。并且成功取消订阅。 | -| cb | 要取消注册的回调函数，详见[RecordDataCallback](_sensor.md#recorddatacallback)。 | - -**返回：** - -如果取消注册回调函数成功，则返回0。 - -如果取消注册回调函数失败，则返回负数。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_sensor_types_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_sensor_types_8idl.md new file mode 100644 index 0000000000000000000000000000000000000000..8eadb3a7c36ddf82a854b6a9e9c264e2abf80b9b --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_sensor_types_8idl.md @@ -0,0 +1,45 @@ +# SensorTypes.idl + + +## **概述** + +定义传感器模块所使用的传感器类型，传感器信息，传感器数据结构等数据类型。 + +**Since:** + +2.2 + +**Version:** + +1.0 + +**相关模块:** + +[Sensor](sensor.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [HdfSensorInformation](_hdf_sensor_information.md) | 定义传感器的基本信息。 | +| [HdfSensorEvents](_hdf_sensor_events.md) | 定义传感器上报的数据。 | + + +### 枚举 + + | 名称 | 描述 | +| -------- | -------- | +| [HdfSensorTypeTag](sensor.md#hdfsensortypetag) {   HDF_SENSOR_TYPE_NONE = 0, HDF_SENSOR_TYPE_ACCELEROMETER = 1, HDF_SENSOR_TYPE_GYROSCOPE = 2, HDF_SENSOR_TYPE_PHOTOPLETHYSMOGRAPH = 3,   HDF_SENSOR_TYPE_ELECTROCARDIOGRAPH = 4, HDF_SENSOR_TYPE_AMBIENT_LIGHT = 5, HDF_SENSOR_TYPE_MAGNETIC_FIELD = 6, HDF_SENSOR_TYPE_CAPACITIVE = 7,   HDF_SENSOR_TYPE_BAROMETER = 8, HDF_SENSOR_TYPE_TEMPERATURE = 9, HDF_SENSOR_TYPE_HALL = 10, HDF_SENSOR_TYPE_GESTURE = 11,   HDF_SENSOR_TYPE_PROXIMITY = 12, HDF_SENSOR_TYPE_HUMIDITY = 13, HDF_SENSOR_TYPE_MEDICAL_BEGIN = 128, HDF_SENSOR_TYPE_MEDICAL_END = 160,   HDF_SENSOR_TYPE_PHYSICAL_MAX = 255, HDF_SENSOR_TYPE_ORIENTATION = 256, HDF_SENSOR_TYPE_GRAVITY = 257, HDF_SENSOR_TYPE_LINEAR_ACCELERATION = 258,   HDF_SENSOR_TYPE_ROTATION_VECTOR = 259, HDF_SENSOR_TYPE_AMBIENT_TEMPERATURE = 260, HDF_SENSOR_TYPE_MAGNETIC_FIELD_UNCALIBRATED = 261, HDF_SENSOR_TYPE_GAME_ROTATION_VECTOR = 262,   HDF_SENSOR_TYPE_GYROSCOPE_UNCALIBRATED = 263, HDF_SENSOR_TYPE_SIGNIFICANT_MOTION = 264, HDF_SENSOR_TYPE_PEDOMETER_DETECTION = 265, HDF_SENSOR_TYPE_PEDOMETER = 266,   HDF_SENSOR_TYPE_GEOMAGNETIC_ROTATION_VECTOR = 277, HDF_SENSOR_TYPE_HEART_RATE = 278, HDF_SENSOR_TYPE_DEVICE_ORIENTATION = 279, HDF_SENSOR_TYPE_WEAR_DETECTION = 280,   HDF_SENSOR_TYPE_ACCELEROMETER_UNCALIBRATED = 281, HDF_SENSOR_TYPE_MAX } | 定义传感器类型标识。 | +| [HdfSensorGroupType](sensor.md#hdfsensorgrouptype) { HDF_TRADITIONAL_SENSOR_TYPE = 0, HDF_MEDICAL_SENSOR_TYPE = 1, HDF_SENSOR_GROUP_TYPE_MAX } | 枚举传感器的硬件服务组。 | +| [HdfSensorModeType](sensor.md#hdfsensormodetype) {   SENSOR_MODE_DEFAULT = 0, SENSOR_MODE_REALTIME = 1, SENSOR_MODE_ON_CHANGE = 2, SENSOR_MODE_ONE_SHOT = 3,   SENSOR_MODE_FIFO_MODE = 4, SENSOR_MODE_MAX } | 传感器的工作模式。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.sensor.v1_0 | Sensor模块接口的包路径。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_sta_info.md b/zh-cn/device-dev/reference/hdi-apis/_sta_info.md deleted file mode 100644 index 605e17a4f2e3e629a11939553baf0b28cbf0561e..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_sta_info.md +++ /dev/null @@ -1,46 +0,0 @@ -# StaInfo - - -## **概述** - -**所属模块:** - -[WLAN](_w_l_a_n.md) - - -## **汇总** - - -### Public 属性 - - | Public 属性 | 描述 | -| -------- | -------- | -| [mac](#mac) [[WIFI_MAC_ADDR_LENGTH](_w_l_a_n.md#ga27ea7645cf89c113dae48346e19a676f)] | STA的MAC地址 | - - -## **详细描述** - -描述与AP连接的STA的基本信息。 - -**Since：** - -1.0 - -**Version：** - -1.0 - - -## **类成员变量说明** - - -### mac - - -``` -unsigned char StaInfo::mac[WIFI_MAC_ADDR_LENGTH] -``` - -**描述：** - -STA的MAC地址。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_stream_attribute.md b/zh-cn/device-dev/reference/hdi-apis/_stream_attribute.md new file mode 100644 index 0000000000000000000000000000000000000000..0f27781eb80cac98f6a7ed813503f715d4220486 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_stream_attribute.md @@ -0,0 +1,139 @@ +# StreamAttribute + + +## **概述** + +流的属性。 + +**相关模块:** + +[Camera](camera.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [streamId_](#streamid) | 流的ID，用于在设备内唯一标识一条流。 | +| [width_](#width) | 图像宽度。 | +| [height_](#height) | 图像高度。 | +| [overrideFormat_](#overrideformat) | 重写的图像格式。 | +| [overrideDataspace_](#overridedataspace) | 重写的图像颜色空间 | +| [producerUsage_](#producerusage) | 重写后的生产者的使用方式。 | +| [producerBufferCount_](#producerbuffercount) | 重写后的生产者缓存数量。 | +| [maxBatchCaptureCount_](#maxbatchcapturecount) | 连拍支持的最大捕获帧数量。 | +| [maxCaptureCount_](#maxcapturecount) | 最大的并发捕获请求个数，默认为1。 | + + +## **类成员变量说明** + + +### height_ + + +``` +int StreamAttribute::height_ +``` + +**描述：** + +图像高度。 + + +### maxBatchCaptureCount_ + + +``` +int StreamAttribute::maxBatchCaptureCount_ +``` + +**描述：** + +连拍支持的最大捕获帧数量。 + + +### maxCaptureCount_ + + +``` +int StreamAttribute::maxCaptureCount_ +``` + +**描述：** + +最大的并发捕获请求个数，默认为1。 + + +### overrideDataspace_ + + +``` +int StreamAttribute::overrideDataspace_ +``` + +**描述：** + +重写的图像颜色空间。 + + +### overrideFormat_ + + +``` +int StreamAttribute::overrideFormat_ +``` + +**描述：** + +重写的图像格式。 + + +### producerBufferCount_ + + +``` +int StreamAttribute::producerBufferCount_ +``` + +**描述：** + +重写后的生产者缓存数量。 + + +### producerUsage_ + + +``` +int StreamAttribute::producerUsage_ +``` + +**描述：** + +重写后的生产者的使用方式。 + + +### streamId_ + + +``` +int StreamAttribute::streamId_ +``` + +**描述：** + +流的ID，用于在设备内唯一标识一条流。 + + +### width_ + + +``` +int StreamAttribute::width_ +``` + +**描述：** + +图像宽度。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_stream_info.md b/zh-cn/device-dev/reference/hdi-apis/_stream_info.md new file mode 100644 index 0000000000000000000000000000000000000000..ee81d8c68b65077efd2955c34d50b3d27ce0100b --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_stream_info.md @@ -0,0 +1,152 @@ +# StreamInfo + + +## **概述** + +流信息，用于创建流时传入相关的配置参数。 + +**相关模块:** + +[Camera](camera.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [streamId_](#streamid) | 流的ID，用于在设备内唯一标识一条流。 | +| [width_](#width) | 图像宽度。 | +| [height_](#height) | 图像高度。 | +| [format_](#format) | 图像格式。 | +| [dataspace_](#dataspace) | 图像颜色空间。 | +| [intent_](#intent) | 流类型。 | +| [tunneledMode_](#tunneledmode) | 隧道模式，值为true时开启，false关闭。 | +| [bufferQueue_](#bufferqueue) | 图形提供的生产者句柄。 | +| [minFrameDuration_](#minframeduration) | 最小帧间隔。 | +| [encodeType_](#encodetype) | 编码类型。 | + + +## **类成员变量说明** + + +### bufferQueue_ + + +``` +BufferProducerSequenceable StreamInfo::bufferQueue_ +``` + +**描述：** + +图形提供的生产者句柄。 + + +### dataspace_ + + +``` +int StreamInfo::dataspace_ +``` + +**描述：** + +图像颜色空间。 + + +### encodeType_ + + +``` +enum EncodeType StreamInfo::encodeType_ +``` + +**描述：** + +编码类型。 + + +### format_ + + +``` +int StreamInfo::format_ +``` + +**描述：** + +图像格式。 + + +### height_ + + +``` +int StreamInfo::height_ +``` + +**描述：** + +图像高度。 + + +### intent_ + + +``` +enum StreamIntent StreamInfo::intent_ +``` + +**描述：** + +流类型。 + + +### minFrameDuration_ + + +``` +int StreamInfo::minFrameDuration_ +``` + +**描述：** + +最小帧间隔。 + + +### streamId_ + + +``` +int StreamInfo::streamId_ +``` + +**描述：** + +流的ID，用于在设备内唯一标识一条流。 + + +### tunneledMode_ + + +``` +boolean StreamInfo::tunneledMode_ +``` + +**描述：** + +隧道模式，值为true时开启，false关闭。 开启隧道模式后，HAL不直接和上层交互，通过图形提供的生产者句柄来传递帧数据， 对于一些IOT设备，可能不需要或者不支持预览流的图像数据缓存流转，此时需要关闭隧道模式。 + + +### width_ + + +``` +int StreamInfo::width_ +``` + +**描述：** + +图像宽度。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_support_buffer_type.md b/zh-cn/device-dev/reference/hdi-apis/_support_buffer_type.md index 22e7876400f9ef145757edc027231d5053b53499..d185ae8f897719c5e443d35bef17317916d79566 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_support_buffer_type.md +++ b/zh-cn/device-dev/reference/hdi-apis/_support_buffer_type.md @@ -3,9 +3,11 @@ ## **概述** -**所属模块:** +SupportBuffer类型定义。 + +**相关模块:** -[Codec](_codec.md) +[Codec](codec.md) ## **汇总** @@ -13,7 +15,7 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | | [size](#size) | 结构体大小 | | [version](#version) | 组件版本信息 | @@ -21,11 +23,6 @@ | [bufferTypes](#buffertypes) | 支持的所有Buffer类型 | -## **详细描述** - -SupportBuffer类型定义。 - - ## **类成员变量说明** @@ -38,7 +35,7 @@ uint32_t SupportBufferType::bufferTypes **描述：** -支持的所有Buffer类型 +支持的所有Buffer类型。 ### portIndex @@ -50,7 +47,7 @@ uint32_t SupportBufferType::portIndex **描述：** -端口索引 +端口索引。 ### size @@ -62,7 +59,7 @@ uint32_t SupportBufferType::size **描述：** -结构体大小 +结构体大小。 ### version @@ -74,4 +71,4 @@ union OMX_VERSIONTYPE SupportBufferType::version **描述：** -组件版本信息 +组件版本信息。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_template_info.md b/zh-cn/device-dev/reference/hdi-apis/_template_info.md index 9bdd2da28e29d9067964f47ecb713d2fff8f2a7e..eefb0c607c9e6f08ae07274f7711a98d0dcf7793 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_template_info.md +++ b/zh-cn/device-dev/reference/hdi-apis/_template_info.md @@ -3,6 +3,16 @@ ## **概述** +凭据模版信息。 + +**Since：** + +3.2 + +**Version：** + +1.0 + **所属模块:** [HdfFaceAuth](_hdf_face_auth.md) | [HdfPinAuth](_hdf_pin_auth.md) @@ -13,27 +23,14 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | | [executorType](#executortype) | 执行器类型，根据执行器支持的算法类型进行分类。 | -| [lockoutDuration](#lockoutduration) | 认证方式被冻结的时间。 | -| [remainAttempts](#remainattempts) | 认证方式距离被冻结的可处理认证请求次数。 | +| [freezingTime](#freezingtime) | 认证方式被冻结的时间。 | +| [remainTimes](#remaintimes) | 认证方式距离被冻结的可处理认证请求次数。 | | [extraInfo](#extrainfo) | 其他相关信息，用于支持信息扩展。 | -## **详细描述** - -凭据模版信息。 - -**Since：** - -3.2 - -**Version：** - -1.0 - - ## **类成员变量说明** @@ -61,11 +58,11 @@ unsigned char [] TemplateInfo::extraInfo 其他相关信息，用于支持信息扩展。 -### lockoutDuration +### freezingTime ``` -int TemplateInfo::lockoutDuration +int TemplateInfo::freezingTime ``` **描述：** @@ -73,11 +70,11 @@ int TemplateInfo::lockoutDuration 认证方式被冻结的时间。 -### remainAttempts +### remainTimes ``` -int TemplateInfo::remainAttempts +int TemplateInfo::remainTimes ``` **描述：** diff --git a/zh-cn/device-dev/reference/hdi-apis/_thermal_types_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_thermal_types_8idl.md index 38c78e4de0d69fd3c775a820e311780c09d6482f..8a9f62560247133588da745fba6962eaf13b0120 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_thermal_types_8idl.md +++ b/zh-cn/device-dev/reference/hdi-apis/_thermal_types_8idl.md @@ -3,39 +3,36 @@ ## **概述** -**所属模块:** - -[Thermal](thermal.md) - +设备发热状态相关的数据类型。 -## **汇总** +热管理中使用的数据类型，包括设备发热的信息和设备发热的信息列表。 +**Since:** -### 类 +3.1 - | 类 | 描述 | -| -------- | -------- | -| [ThermalZoneInfo](_thermal_zone_info.md) | 设备发热的信息。 [更多...](_thermal_zone_info.md) | -| [HdfThermalCallbackInfo](_hdf_thermal_callback_info.md) | 设备发热的信息列表。 [更多...](_hdf_thermal_callback_info.md) | +**Version:** +1.0 -### 变量 +**相关模块:** - | 变量 名称 | 描述 | -| -------- | -------- | -| package ohos.hdi.thermal.v1_0 | 设备温度管理接口的包路径 | +[Thermal](thermal.md) -## **详细描述** +## **汇总** -设备发热状态相关的数据类型。 -热管理中使用的数据类型，包括设备发热的信息和设备发热的信息列表。 +### 类 -**Since：** + | 名称 | 描述 | +| -------- | -------- | +| [ThermalZoneInfo](_thermal_zone_info.md) | 设备发热的信息。 | +| [HdfThermalCallbackInfo](_hdf_thermal_callback_info.md) | 设备发热的信息列表。 | -3.1 -**Version：** +### 关键字 -1.0 + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.thermal.v1_0 | Thermal模块接口的包路径。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_thermal_zone_info.md b/zh-cn/device-dev/reference/hdi-apis/_thermal_zone_info.md index 6c60b3463c1d06fa6efc51a5d5c0ba07fc3be39f..55c9cd68298c64581d78f868a3678c556f2b17dd 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_thermal_zone_info.md +++ b/zh-cn/device-dev/reference/hdi-apis/_thermal_zone_info.md @@ -3,7 +3,13 @@ ## **概述** -**所属模块:** +设备发热的信息。 + +**Since:** + +3.1 + +**相关模块:** [Thermal](thermal.md) @@ -13,21 +19,12 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | | [type](#type) | 发热器件的类型。 | | [temp](#temp) | 器件的温度值。 | -## **详细描述** - -设备发热的信息。 - -**Since：** - -3.1 - - ## **类成员变量说明** diff --git a/zh-cn/device-dev/reference/hdi-apis/_types_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_types_8idl.md deleted file mode 100644 index b924caff85bec0cdd0dcac7a8eefa0fca8334854..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_types_8idl.md +++ /dev/null @@ -1,49 +0,0 @@ -# Types.idl - - -## **概述** - -**所属模块:** - -[Battery](battery.md) - - -## **汇总** - - -### 类 - - | 类 | 描述 | -| -------- | -------- | -| [BatteryInfo](_battery_info.md) | 电池相关信息。 [更多...](_battery_info.md) | - - -### 枚举 - - | 枚举 | 描述 | -| -------- | -------- | -| [BatteryHealthState](battery.md#batteryhealthstate) {   BATTERY_HEALTH_UNKNOWN = 0, BATTERY_HEALTH_GOOD, BATTERY_HEALTH_OVERHEAT, BATTERY_HEALTH_OVERVOLTAGE,   BATTERY_HEALTH_COLD, BATTERY_HEALTH_DEAD, BATTERY_HEALTH_RESERVED } | 电池的健康状态。 [更多...](battery.md#batteryhealthstate) | -| [BatteryChargeState](battery.md#batterychargestate) {   CHARGE_STATE_NONE = 0, CHARGE_STATE_ENABLE, CHARGE_STATE_DISABLE, CHARGE_STATE_FULL,   CHARGE_STATE_RESERVED } | 电池的充电状态。 [更多...](battery.md#batterychargestate) | -| [BatteryPluggedType](battery.md#batterypluggedtype) {   PLUGGED_TYPE_NONE = 0, PLUGGED_TYPE_AC, PLUGGED_TYPE_USB, PLUGGED_TYPE_WIRELESS,   PLUGGED_TYPE_BUTT } | 电池的充电设备类型。 [更多...](battery.md#batterypluggedtype) | - - -### 变量 - - | 变量 名称 | 描述 | -| -------- | -------- | -| package ohos.hdi.battery.v1_0 | 电池信息接口的包路径 | - - -## **详细描述** - -电池信息相关数据类型。 - -电池信息中使用的数据类型，包括健康状态、充电状态、充电设备类型和电池信息结构。 - -**Since：** - -3.1 - -**Version：** - -1.0 diff --git a/zh-cn/device-dev/reference/hdi-apis/_u_s_b.md b/zh-cn/device-dev/reference/hdi-apis/_u_s_b.md deleted file mode 100644 index 3753bc9918d7c0294c6ac0a78719179b8c252740..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_u_s_b.md +++ /dev/null @@ -1,1863 +0,0 @@ -# USB - - -## **汇总** - - -### 文件 - - | 文件 | 描述 | -| -------- | -------- | -| [usb_info.h](usb__info_8h.md) | USB驱动订阅模块使用的数据类型。 | -| [usbd_client.h](usbd__client_8h.md) | 声明标准USB驱动接口函数。 | -| [usbd_subscriber.h](usbd__subscriber_8h.md) | USB驱动订阅模块。 | -| [usbd_type.h](usbd__type_8h.md) | USB驱动模块接口定义中使用的自定义数据类型。 | - - -### 类 - - | 类 | 描述 | -| -------- | -------- | -| [OHOS::USB::USBDeviceInfo](_o_h_o_s_1_1_u_s_b_1_1_u_s_b_device_info.md) | USB设备信息。 [更多...](_o_h_o_s_1_1_u_s_b_1_1_u_s_b_device_info.md) | -| [OHOS::USB::UsbInfo](_o_h_o_s_1_1_u_s_b_1_1_usb_info.md) | USB设备信息类。 [更多...](_o_h_o_s_1_1_u_s_b_1_1_usb_info.md) | -| [OHOS::USB::UsbdClient](_o_h_o_s_1_1_u_s_b_1_1_usbd_client.md) | Usb驱动类。[更多...](_o_h_o_s_1_1_u_s_b_1_1_usbd_client.md) | -| [OHOS::USB::UsbdSubscriber](_o_h_o_s_1_1_u_s_b_1_1_usbd_subscriber.md) | 订阅类。[更多...](_o_h_o_s_1_1_u_s_b_1_1_usbd_subscriber.md) | -| [OHOS::USB::UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) | USB设备。 [更多...](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) | -| [OHOS::USB::UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md) | 管道信息。 [更多...](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md) | -| [OHOS::USB::UsbCtrlTransfer](_o_h_o_s_1_1_u_s_b_1_1_usb_ctrl_transfer.md) | USB控制传输。 [更多...](_o_h_o_s_1_1_u_s_b_1_1_usb_ctrl_transfer.md) | - - -### 宏定义 - - | 宏定义 | 描述 | -| -------- | -------- | -| [USB_MAX_INTERFACES](#usb\_max\_interfaces)   32 | USB设备最大接口数量。 | - - -### 静态常量 - - | 静态常量 | 描述 | -| -------- | -------- | -| [USB_ENDPOINT_DIR_MASK](#usb\_endpoint\_dir\_mask)   0x80 | 从地址中提取USB Endpoint方向的位掩码。 | -| [USB_ENDPOINT_DIR_IN](#usb\_endpoint\_dir\_in)   0x80 | USB Endpoint从设备到主机的数据方向。 | -| [USB_ENDPOINT_DIR_OUT](#usb\_endpoint\_dir\_out)   0 | USB Endpoint从主机到设备的数据方向。 | - - -### 类型定义 - - | 类型定义 | 描述 | -| -------- | -------- | -| ([UsbdRequestCallback](#usbdrequestcallback)) (uint8_t \*requestArg) | 请求回调函数。[更多...](#usbdrequestcallback) | - - -### 枚举 - - | 枚举 | 描述 | -| -------- | -------- | -| [UsbdBulkCbCmd](#usbdbulkcbcmd) { CMD_USBD_BULK_CALLBACK_READ, CMD_USBD_BULK_CALLBACK_WRITE } | 批量回调命令字。 [更多...](#usbdbulkcbcmd) | -| [UsbdDeviceAction](#usbddeviceaction) { ACT_DEVUP = 0, ACT_DEVDOWN, ACT_UPDEVICE, ACT_DOWNDEVICE } | 主机端和设备端插拔事件。 [更多...](#usbddeviceaction) | - - -### 函数 - - | 函数 | 描述 | -| -------- | -------- | -| [OHOS::USB::UsbInfo::setDevInfoStatus](#setdevinfostatus) (int32_t status) | 设置USB设备状态。 [更多...](#setdevinfostatus) | -| [OHOS::USB::UsbInfo::setDevInfoBusNum](#setdevinfobusnum) (int32_t busNum) | 设置USB总线编号。 [更多...](#setdevinfobusnum) | -| [OHOS::USB::UsbInfo::setDevInfoDevNum](#setdevinfodevnum) (int32_t devNum) | 设置USB设备编号。 [更多...](#setdevinfodevnum) | -| [OHOS::USB::UsbInfo::getDevInfoStatus](#getdevinfostatus) () const | 获取USB设备状态。 [更多...](#getdevinfostatus) | -| [OHOS::USB::UsbInfo::getDevInfoBusNum](#getdevinfobusnum) () const | 获取USB总线编号。 [更多...](#getdevinfobusnum) | -| [OHOS::USB::UsbInfo::getDevInfoDevNum](#getdevinfodevnum) () const | 获取USB设备编号。 [更多...](#getdevinfodevnum) | -| [OHOS::USB::UsbdClient::GetInstance](#getinstance) ()  | 获取实例。 [更多...](#getinstance) | -| [OHOS::USB::UsbdClient::OpenDevice](#opendevice) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev) | 打开设备，建立连接。 [更多...](#opendevice) | -| [OHOS::USB::UsbdClient::CloseDevice](#closedevice) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev) | 关闭设备，释放与设备相关的所有系统资源。 [更多...](#closedevice) | -| [OHOS::USB::UsbdClient::GetDeviceDescriptor](#getdevicedescriptor) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, std::vector< uint8_t > &descriptor) | 获取设备描述符。 [更多...](#getdevicedescriptor) | -| [OHOS::USB::UsbdClient::GetStringDescriptor](#getstringdescriptor) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, uint8_t descId, std::vector< uint8_t > &descriptor) | 根据String ID获取设备的字符串描述符。 [更多...](#getstringdescriptor) | -| [OHOS::USB::UsbdClient::GetConfigDescriptor](#getconfigdescriptor) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, uint8_t descId, std::vector< uint8_t > &descriptor) | 根据config ID获取设备的配置描述符config。 [更多...](#getconfigdescriptor) | -| [OHOS::USB::UsbdClient::GetRawDescriptor](#getrawdescriptor) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, std::vector< uint8_t > &descriptor) | 获取原始描述符。 [更多...](#getrawdescriptor) | -| [OHOS::USB::UsbdClient::GetFileDescriptor](#getfiledescriptor) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, int32_t &fd) | 获取文件描述符。 [更多...](#getfiledescriptor) | -| [OHOS::USB::UsbdClient::SetConfig](#setconfig) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, uint8_t configIndex) | 设置当前的config信息。 [更多...](#setconfig) | -| [OHOS::USB::UsbdClient::GetConfig](#getconfig) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, uint8_t &configIndex) | 获取当前的config信息。 [更多...](#getconfig) | -| [OHOS::USB::UsbdClient::ClaimInterface](#claiminterface) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, uint8_t interfaceid, uint8_t force) | 打开接口，并声明独占接口，必须在数据传输前执行。 [更多...](#claiminterface) | -| [OHOS::USB::UsbdClient::ReleaseInterface](#releaseinterface) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, uint8_t interfaceid) | 关闭接口，释放接口的占用，在停止数据传输后执行。 [更多...](#releaseinterface) | -| [OHOS::USB::UsbdClient::SetInterface](#setinterface) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, uint8_t interfaceid, uint8_t altIndex) | 设置指定接口的备选设置，用于在具有相同ID但不同备用设置的两个接口之间进行选择。 [更多...](#setinterface) | -| [OHOS::USB::UsbdClient::BulkTransferRead](#bulktransferread) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, const [UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md) &pipe, int32_t timeout, std::vector< uint8_t > &data) | 在给定端点上执行批量数据读取，返回读取的数据和长度，端点方向必须为数据读取，可以设置超时时间。 [更多...](#bulktransferread) | -| [OHOS::USB::UsbdClient::BulkTransferWrite](#bulktransferwrite) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, const [UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md) &pipe, int32_t timeout, const std::vector< uint8_t > &data) | 在给定端点上执行批量数据写入， 返回读取的数据和长度，端点方向必须为数据写入。 [更多...](#bulktransferwrite) | -| [OHOS::USB::UsbdClient::ControlTransfer](#controltransfer) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, const [UsbCtrlTransfer](_o_h_o_s_1_1_u_s_b_1_1_usb_ctrl_transfer.md) &ctrl, std::vector< uint8_t > &data) | 对此设备执行端点零的控制事务，传输方向由请求类型决定。 如果requestType＆ USB_ENDPOINT_DIR_MASK是USB_DIR_OUT ，则传输是写入，如果是USB_DIR_IN ，则传输是读取。 [更多...](#controltransfer) | -| [OHOS::USB::UsbdClient::InterruptTransferRead](#interrupttransferread) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, const [UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md) &pipe, int32_t timeout, std::vector< uint8_t > &data) | 在给定端点上执行中断数据读取， 返回读取的数据和长度，端点方向必须为数据读取。 [更多...](#interrupttransferread) | -| [OHOS::USB::UsbdClient::InterruptTransferWrite](#interrupttransferwrite) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, const [UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md) &pipe, int32_t timeout, std::vector< uint8_t > &data) | 在给定端点上执行中断数据写入， 返回读取的数据和长度，端点方向必须为数据写入。 [更多...](#interrupttransferwrite) | -| [OHOS::USB::UsbdClient::IsoTransferRead](#isotransferread) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, const [UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md) &pipe, int32_t timeout, std::vector< uint8_t > &data) | 在给定端点上执行等时数据读取， 返回读取的数据和长度，端点方向必须为数据读取。 [更多...](#isotransferread) | -| [OHOS::USB::UsbdClient::IsoTransferWrite](#isotransferwrite) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, const [UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md) &pipe, int32_t timeout, std::vector< uint8_t > &data) | 在给定端点上执行等时数据写入， 返回读取的数据和长度，端点方向必须为数据写入。 [更多...](#isotransferwrite) | -| [OHOS::USB::UsbdClient::RequestQueue](#requestqueue) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, const [UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md) &pipe, const std::vector< uint8_t > &clientData, const std::vector< uint8_t > &buffer) | 将指定的端点进行异步数据发送或者接收请求，数据传输方向由端点方向决定。 [更多...](#requestqueue) | -| [OHOS::USB::UsbdClient::RequestWait](#requestwait) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, std::vector< uint8_t > &clientData, std::vector< uint8_t > &buffer, int32_t timeout) | 等待RequestQueue异步请求的操作结果。 [更多...](#requestwait) | -| [OHOS::USB::UsbdClient::RequestCancel](#requestcancel) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, const [UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md) &pipe) | 取消待处理的数据请求。 [更多...](#requestcancel) | -| [OHOS::USB::UsbdClient::GetCurrentFunctions](#getcurrentfunctions) (int32_t &funcs) | 获取从设备支持的功能列表（按位域表示）（从设备）。 [更多...](#getcurrentfunctions) | -| [OHOS::USB::UsbdClient::SetCurrentFunctions](#setcurrentfunctions) (int32_t funcs) | 设置从设备支持的功能列表（按位域表示）（从设备）。 [更多...](#setcurrentfunctions) | -| [OHOS::USB::UsbdClient::SetPortRole](#setportrole) (int32_t portId, int32_t powerRole, int32_t dataRole) | 设置port端口的角色。 [更多...](#setportrole) | -| [OHOS::USB::UsbdClient::QueryPort](#queryport) (int32_t &portId, int32_t &powerRole, int32_t &dataRole, int32_t &mode) | 查询port端口的当前设置。 [更多...](#queryport) | -| [OHOS::USB::UsbdClient::BindUsbdSubscriber](#bindusbdsubscriber) (const sptr< [UsbdSubscriber](_o_h_o_s_1_1_u_s_b_1_1_usbd_subscriber.md) > &subscriber) | 绑定订阅者。 [更多...](#bindusbdsubscriber) | -| [OHOS::USB::UsbdClient::UnbindUsbdSubscriber](#unbindusbdsubscriber) (const sptr< [UsbdSubscriber](_o_h_o_s_1_1_u_s_b_1_1_usbd_subscriber.md) > &subscriber) | 解绑订阅者。 [更多...](#unbindusbdsubscriber) | -| [OHOS::USB::UsbdClient::RegBulkCallback](#regbulkcallback) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, const [UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md) &pipe, const sptr< IRemoteObject > &cb) | 注册批量传输异步回调函数。 [更多...](#regbulkcallback) | -| [OHOS::USB::UsbdClient::UnRegBulkCallback](#unregbulkcallback) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, const [UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md) &pipe) | 注销批量传输异步回调函数。 [更多...](#unregbulkcallback) | -| [OHOS::USB::UsbdClient::BulkRead](#bulkread) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, const [UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md) &pipe, sptr< Ashmem > &ashmem) | 批量传输异步读数据。 [更多...](#bulkread) | -| [OHOS::USB::UsbdClient::BulkWrite](#bulkwrite) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, const [UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md) &pipe, sptr< Ashmem > &ashmem) | 批量传输异步写数据。 [更多...](#bulkwrite) | -| [OHOS::USB::UsbdClient::BulkCancel](#bulkcancel) (const [UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) &dev, const [UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md) &pipe) | 批量传输异步取消接口，用于取消当前接口的异步批量读写操作。 [更多...](#bulkcancel) | -| [OHOS::USB::UsbdSubscriber::DeviceEvent](#deviceevent) (const [UsbInfo](_o_h_o_s_1_1_u_s_b_1_1_usb_info.md) &info)=0 | 设备事件。 [更多...](#deviceevent) | -| [OHOS::USB::UsbdSubscriber::PortChangedEvent](#portchangedevent) (int32_t portId, int32_t powerRole, int32_t dataRole, int32_t mode)=0 | 端口改变事件。 [更多...](#portchangedevent) | -| [OHOS::USB::UsbdSubscriber::OnRemoteRequest](#onremoterequest) (uint32_t code, MessageParcel &data, MessageParcel &reply, MessageOption &option) override | 远程请求。 [更多...](#onremoterequest) | -| [OHOS::USB::UsbdSubscriber::ParserUsbInfo](#parserusbinfo) (MessageParcel &data, MessageParcel &reply, MessageOption &option, UsbInfo &info) | 解析USB设备信息。 [更多...](#parserusbinfo) | -| [OHOS::USB::UsbdSubscriber::ParserPortInfo](#parserportinfo) (MessageParcel &data, MessageParcel &reply, MessageOption &option, PortInfo &info) | 解析USB设备端口信息。 [更多...](#parserportinfo) | - - -### 变量 - - | 变量 | 描述 | -| -------- | -------- | -| [OHOS::USB::USBDeviceInfo::status](#status) | USB设备状态 | -| [OHOS::USB::USBDeviceInfo::busNum](#busnum-12) | USB总线编号 | -| [OHOS::USB::USBDeviceInfo::devNum](#devnum) | USB设备编号 | -| [OHOS::USB::UsbDev::busNum](#busnum-22) | USB总线编号 | -| [OHOS::USB::UsbDev::devAddr](#devaddr) | USB设备地址 | -| [OHOS::USB::UsbPipe::interfaceId](#interfaceid) | USB设备接口ID | -| [OHOS::USB::UsbPipe::endpointId](#endpointid) | USB设备端点ID | -| [OHOS::USB::UsbCtrlTransfer::requestType](#requesttype) | 请求类型 | -| [OHOS::USB::UsbCtrlTransfer::requestCmd](#requestcmd) | 请求命令字 | -| [OHOS::USB::UsbCtrlTransfer::value](#value) | 请求值 | -| [OHOS::USB::UsbCtrlTransfer::index](#index) | 索引 | -| [OHOS::USB::UsbCtrlTransfer::timeout](#timeout) | 超时时间 | -| [OHOS::USB::UsbInfo::devInfo](#devinfo ) | USB设备信息 | - - -## **详细描述** - -定义（USB）功能的标准API接口。 - -该模块用于获取描述符、接口对象、请求对象和提交请求的自定义数据类型和函数。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -## **宏定义说明** - - -### USB_MAX_INTERFACES - - -``` -#define USB_MAX_INTERFACES 32 -``` - -**描述：** - -USB设备最大接口数量 - - -## **静态常量说明** - -### USB_ENDPOINT_DIR_MASK - -``` -static const int32_t USB_ENDPOINT_DIR_MASK = 0x80 -``` - -**描述：** - -从地址中提取USB Endpoint方向的位掩码 - - -### USB_ENDPOINT_DIR_IN - -``` -static const int32_t USB_ENDPOINT_DIR_IN = 0x80 -``` - -**描述：** - -USB Endpoint从设备到主机的数据方向 - -### USB_ENDPOINT_DIR_OUT - -``` -static const int32_t USB_ENDPOINT_DIR_OUT = 0 -``` - -**描述：** - -USB Endpoint从主机到设备的数据方向 - - -## **类型定义说明** - - -### UsbdRequestCallback - - -``` -typedef void(* UsbdRequestCallback) (uint8_t *requestArg) -``` - -**描述：** - -请求回调函数 - - -## **枚举类型说明** - - -### UsbdBulkCbCmd - - -``` -enum UsbdBulkCbCmd -``` - -**描述：** - -批量回调命令字。 - - | 枚举值 | 描述 | -| -------- | -------- | -| CMD_USBD_BULK_CALLBACK_READ | 批量回调读取 | -| CMD_USBD_BULK_CALLBACK_WRITE | 批量回调写入 | - - -### UsbdDeviceAction - - -``` -enum UsbdDeviceAction -``` - -**描述：** - -主机端和设备端插拔事件。 - - | 枚举值 | 描述 | -| -------- | -------- | -| ACT_DEVUP | 主机端接入设备 | -| ACT_DEVDOWN | 主机端拔出设备 | -| ACT_UPDEVICE | 设备连接 | -| ACT_DOWNDEVICE | 设备断开 | - - -## **函数说明** - - -### BindUsbdSubscriber() - - -``` -int32_t OHOS::USB::UsbdClient::BindUsbdSubscriber (const sptr< UsbdSubscriber > & subscriber) -``` - -**描述：** - -绑定订阅者。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| subscriber | 输入参数，订阅者信息，详见[UsbdSubscriber](_o_h_o_s_1_1_u_s_b_1_1_usbd_subscriber.md)。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### BulkCancel() - - -``` -int32_t OHOS::USB::UsbdClient::BulkCancel (const UsbDev & dev, const UsbPipe & pipe ) -``` - -**描述：** - -批量传输异步取消接口，用于取消当前接口的异步批量读写操作。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| dev | 输入参数，USB设备地址信息，详见[UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md)。 | -| pipe | 输入参数，USB设备pipe信息，详见[UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md)。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### BulkRead() - - -``` -int32_t OHOS::USB::UsbdClient::BulkRead (const UsbDev & dev, const UsbPipe & pipe, sptr< Ashmem > & ashmem ) -``` - -**描述：** - -批量传输异步读数据。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| dev | 输入参数，USB设备地址信息，详见[UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md)。 | -| pipe | 输入参数，USB设备pipe信息，详见[UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md)。 | -| ashmem | 输出参数，为共享内存，用于存放读取的数据，详见**Ashmem**。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### BulkTransferRead() - - -``` -int32_t OHOS::USB::UsbdClient::BulkTransferRead (const UsbDev & dev, const UsbPipe & pipe, int32_t timeout, std::vector< uint8_t > & data ) -``` - -**描述：** - -在给定端点上执行批量数据读取，返回读取的数据和长度，端点方向必须为数据读取，可以设置超时时间。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| dev | 输入参数，USB设备地址信息，详见[UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md)。 | -| pipe | 输入参数，USB设备pipe信息，详见[UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md)。 | -| timeout | 输入参数，超时时间。 | -| data | 输出参数，获取写入的数据。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### BulkTransferWrite() - - -``` -int32_t OHOS::USB::UsbdClient::BulkTransferWrite (const UsbDev & dev, const UsbPipe & pipe, int32_t timeout, const std::vector< uint8_t > & data ) -``` - -**描述：** - -在给定端点上执行批量数据写入， 返回读取的数据和长度，端点方向必须为数据写入。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| dev | 输入参数，USB设备地址信息，详见[UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md)。 | -| pipe | 输入参数，USB设备pipe信息，详见[UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md)。 | -| timeout | 输入参数，超时时间。 | -| data | 输入参数，写入的数据。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### BulkWrite() - - -``` -int32_t OHOS::USB::UsbdClient::BulkWrite (const UsbDev & dev, const UsbPipe & pipe, sptr< Ashmem > & ashmem ) -``` - -**描述：** - -批量传输异步写数据。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| dev | 输入参数，USB设备地址信息，详见[UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md)。 | -| pipe | 输入参数，USB设备pipe信息，详见[UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md)。 | -| ashmem | 输入参数，为共享内存，用于存放需要写入的数据，详见**Ashmem**。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### ClaimInterface() - - -``` -int32_t OHOS::USB::UsbdClient::ClaimInterface (const UsbDev & dev, uint8_t interfaceid, uint8_t force ) -``` - -**描述：** - -打开接口，并声明独占接口，必须在数据传输前执行。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| dev | 输入参数，USB设备地址信息，详见[UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md)。 | -| interfaceid | 输入参数，USB设备interface ID。 | -| force | 输入参数，是否强制: 1强制 0不强制。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### CloseDevice() - - -``` -int32_t OHOS::USB::UsbdClient::CloseDevice (const UsbDev & dev) -``` - -**描述：** - -关闭设备，释放与设备相关的所有系统资源。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| dev | 输入参数，USB设备地址信息，详见[UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md)。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### ControlTransfer() - - -``` -int32_t OHOS::USB::UsbdClient::ControlTransfer (const UsbDev & dev, const UsbCtrlTransfer & ctrl, std::vector< uint8_t > & data ) -``` - -**描述：** - -对此设备执行端点零的控制事务，传输方向由请求类型决定。 如果requestType＆ USB_ENDPOINT_DIR_MASK是USB_DIR_OUT ，则传输是写入，如果是USB_DIR_IN ，则传输是读取。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| dev | 输入参数，USB设备地址信息，详见[UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md)。 | -| ctrl | 输入参数，USB设备控制数据包结构，详见[UsbCtrlTransfer](_o_h_o_s_1_1_u_s_b_1_1_usb_ctrl_transfer.md)。 | -| data | 输入/输出参数，读取/写入的数据。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### DeviceEvent() - - -``` -virtual int32_t OHOS::USB::UsbdSubscriber::DeviceEvent (const UsbInfo & info) -``` - -**描述：** - -设备事件。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| [UsbInfo](_o_h_o_s_1_1_u_s_b_1_1_usb_info.md) | 输入参数，USB设备信息。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### GetConfig() - - -``` -int32_t OHOS::USB::UsbdClient::GetConfig (const UsbDev & dev, uint8_t & configIndex ) -``` - -**描述：** - -获取当前的config信息。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| dev | 输入参数，USB设备地址信息，详见[UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md)。 | -| configIndex | 输出参数，USB设备config信息。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### GetConfigDescriptor() - - -``` -int32_t OHOS::USB::UsbdClient::GetConfigDescriptor (const UsbDev & dev, uint8_t descId, std::vector< uint8_t > & descriptor ) -``` - -**描述：** - -根据config ID获取设备的配置描述符config。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| dev | 输入参数，USB设备地址信息，详见[UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md)。 | -| descId | 输入参数，USB的config ID。 | -| descriptor | 输出参数，获取USB设备config信息。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### GetCurrentFunctions() - - -``` -int32_t OHOS::USB::UsbdClient::GetCurrentFunctions (int32_t & funcs) -``` - -**描述：** - -获取从设备支持的功能列表（按位域表示）（从设备）。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| funcs | 输出参数，获取当前设备的function的值。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### GetDeviceDescriptor() - - -``` -int32_t OHOS::USB::UsbdClient::GetDeviceDescriptor (const UsbDev & dev, std::vector< uint8_t > & descriptor ) -``` - -**描述：** - -获取设备描述符。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| dev | 输入参数，USB设备地址信息，详见[UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md)。 | -| descriptor | 输出参数，USB设备描述符信息。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### getDevInfoBusNum() - - -``` -int32_t OHOS::USB::UsbInfo::getDevInfoBusNum () const -``` - -**描述：** - -获取USB总线编号。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| status | 输出参数，USB总线编号。 | - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### getDevInfoDevNum() - - -``` -int32_t OHOS::USB::UsbInfo::getDevInfoDevNum () const -``` - -**描述：** - -获取USB设备编号。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| status | 输出参数，USB设备编号。 | - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### getDevInfoStatus() - - -``` -int32_t OHOS::USB::UsbInfo::getDevInfoStatus () const -``` - -**描述：** - -获取USB设备状态。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| status | 输出参数，设备状态。 | - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### GetFileDescriptor() - - -``` -int32_t OHOS::USB::UsbdClient::GetFileDescriptor (const UsbDev & dev, int32_t & fd ) -``` - -**描述：** - -获取文件描述符。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| dev | 输入参数，USB设备地址信息，详见[UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md)。 | -| fd | 输出参数，USB设备文件描述符。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### GetRawDescriptor() - - -``` -int32_t OHOS::USB::UsbdClient::GetRawDescriptor (const UsbDev & dev, std::vector< uint8_t > & descriptor ) -``` - -**描述：** - -获取原始描述符。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| dev | 输入参数，USB设备地址信息，详见[UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md)。 | -| descriptor | 输出参数，USB设备原始描述符。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### GetStringDescriptor() - - -``` -int32_t OHOS::USB::UsbdClient::GetStringDescriptor (const UsbDev & dev, uint8_t descId, std::vector< uint8_t > & descriptor ) -``` - -**描述：** - -根据String ID获取设备的字符串描述符。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| dev | 输入参数，USB设备地址信息，详见[UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md)。 | -| descId | 输入参数，USB的string ID。 | -| descriptor | 输出参数，获取USB设备config信息。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### InterruptTransferRead() - - -``` -int32_t OHOS::USB::UsbdClient::InterruptTransferRead (const UsbDev & dev, const UsbPipe & pipe, int32_t timeout, std::vector< uint8_t > & data ) -``` - -**描述：** - -在给定端点上执行中断数据读取， 返回读取的数据和长度，端点方向必须为数据读取。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| dev | 输入参数，USB设备地址信息，详见[UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md)。 | -| pipe | 输入参数，USB设备pipe信息，详见[UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md)。 | -| timeout | 输入参数，超时时间。 | -| data | 输出参数，读取的数据。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### InterruptTransferWrite() - - -``` -int32_t OHOS::USB::UsbdClient::InterruptTransferWrite (const UsbDev & dev, const UsbPipe & pipe, int32_t timeout, std::vector< uint8_t > & data ) -``` - -**描述：** - -在给定端点上执行中断数据写入， 返回读取的数据和长度，端点方向必须为数据写入。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| dev | 输入参数，USB设备地址信息，详见[UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md)。 | -| pipe | 输入参数，USB设备pipe信息，详见[UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md)。 | -| timeout | 输入参数，超时时间。 | -| data | 输入参数，写入的数据。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### IsoTransferRead() - - -``` -int32_t OHOS::USB::UsbdClient::IsoTransferRead (const UsbDev & dev, const UsbPipe & pipe, int32_t timeout, std::vector< uint8_t > & data ) -``` - -**描述：** - -在给定端点上执行等时数据读取， 返回读取的数据和长度，端点方向必须为数据读取。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| dev | 输入参数，USB设备地址信息，详见[UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md)。 | -| pipe | 输入参数，USB设备pipe信息，详见[UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md)。 | -| timeout | 输入参数，超时时间。 | -| data | 输出参数，读取的数据。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### IsoTransferWrite() - - -``` -int32_t OHOS::USB::UsbdClient::IsoTransferWrite (const UsbDev & dev, const UsbPipe & pipe, int32_t timeout, std::vector< uint8_t > & data ) -``` - -**描述：** - -在给定端点上执行等时数据写入， 返回读取的数据和长度，端点方向必须为数据写入。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| dev | 输入参数，USB设备地址信息，详见[UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md)。 | -| pipe | 输入参数，USB设备pipe信息，详见[UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md)。 | -| timeout | 输入参数，超时时间。 | -| data | 输入参数，读取的数据。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### OnRemoteRequest() - - -``` -int32_t OHOS::USB::UsbdSubscriber::OnRemoteRequest (uint32_t code, MessageParcel & data, MessageParcel & reply, MessageOption & option ) -``` - -**描述：** - -远程请求。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| code | 输入参数，命令字。 | -| data | 输入参数，待解析的数据。 | -| reply | 输出参数，返回的数据。 | -| option | 输入参数，选项数据。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### OpenDevice() - - -``` -int32_t OHOS::USB::UsbdClient::OpenDevice (const UsbDev & dev) -``` - -**描述：** - -打开设备，建立连接。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| dev | 输入参数，USB设备地址信息，详见[UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md)。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### ParserUsbInfo() - - -``` -static int32_t OHOS::USB::UsbdSubscriber::ParserUsbInfo(MessageParcel &data, MessageParcel &reply, MessageOption &option, UsbInfo &info) -``` - -**描述：** - -解析USB设备信息。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| data | 输入参数，命令字。| -| reply | 输出参数，返回的数据。 | -| option | 输入参数，选项数据。| -| info | 输出参数，USB设备信息。| - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - -### ParserPortInfo() - - -``` -static int32_t OHOS::USB::UsbdSubscriber::ParserPortInfo(MessageParcel &data, MessageParcel &reply, MessageOption &option, PortInfo &info) -``` - -**描述：** - -解析USB设备端口信息。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| data | 输入参数，命令字。| -| reply | 输出参数，返回的数据。 | -| option | 输入参数，选项数据。| -| info | 输出参数，USB设备端口信息。| - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### PortChangedEvent() - - -``` -virtual int32_t OHOS::USB::UsbdSubscriber::PortChangedEvent (int32_t portId, int32_t powerRole, int32_t dataRole, int32_t mode ) -``` - -**描述：** - -端口改变事件。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| portId | 输入参数，端口ID。 | -| powerRole | 输入参数，电源角色的值。 | -| dataRole | 输入参数，数据角色的值。 | -| mode | 输入参数，端口模式的值。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### QueryPort() - - -``` -int32_t OHOS::USB::UsbdClient::QueryPort (int32_t & portId, int32_t & powerRole, int32_t & dataRole, int32_t & mode ) -``` - -**描述：** - -查询port端口的当前设置。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| portId | 输出参数，port接口ID。 | -| powerRole | 输出参数，电源角色的值。 | -| dataRole | 输出参数，数据角色的值。 | -| mode | 输出参数，模式的值。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### RegBulkCallback() - - -``` -int32_t OHOS::USB::UsbdClient::RegBulkCallback (const UsbDev & dev, const UsbPipe & pipe, const sptr< IRemoteObject > & cb ) -``` - -**描述：** - -注册批量传输异步回调函数。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| dev | 输入参数，USB设备地址信息，详见[UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md)。 | -| pipe | 输入参数，USB设备pipe信息，详见[UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md)。 | -| cb | 输入参数，回调函数对象的引用。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### ReleaseInterface() - - -``` -int32_t OHOS::USB::UsbdClient::ReleaseInterface (const UsbDev & dev, uint8_t interfaceid ) -``` - -**描述：** - -关闭接口，释放接口的占用，在停止数据传输后执行。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| dev | 输入参数，USB设备地址信息，详见[UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md)。 | -| interfaceid | 输入参数，USB设备interface ID。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### RequestCancel() - - -``` -int32_t OHOS::USB::UsbdClient::RequestCancel (const UsbDev & dev, const UsbPipe & pipe ) -``` - -**描述：** - -取消待处理的数据请求。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| dev | 输入参数，USB设备地址信息，详见[UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md)。 | -| pipe | 输入参数，USB设备pipe信息，详见[UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md)。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### RequestQueue() - - -``` -int32_t OHOS::USB::UsbdClient::RequestQueue (const UsbDev & dev, const UsbPipe & pipe, const std::vector< uint8_t > & clientData, const std::vector< uint8_t > & buffer ) -``` - -**描述：** - -将指定的端点进行异步数据发送或者接收请求，数据传输方向由端点方向决定。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| dev | 输入参数，USB设备地址信息，详见[UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md)。 | -| pipe | 输入参数，USB设备pipe信息，详见[UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md)。 | -| clientData | 输入参数，用户数据。 | -| buffer | 输入参数，传输的数据。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### RequestWait() - - -``` -int32_t OHOS::USB::UsbdClient::RequestWait (const UsbDev & dev, std::vector< uint8_t > & clientData, std::vector< uint8_t > & buffer, int32_t timeout ) -``` - -**描述：** - -等待RequestQueue异步请求的操作结果。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| dev | 输入参数，USB设备地址信息，详见[UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md)。 | -| clientData | 输入参数，用户数据。 | -| buffer | 输入参数，传输数据。 | -| timeout | 输入参数，超时时间。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### SetConfig() - - -``` -int32_t OHOS::USB::UsbdClient::SetConfig (const UsbDev & dev, uint8_t configIndex ) -``` - -**描述：** - -设置当前的config信息。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| dev | 输入参数，USB设备地址信息，详见[UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md)。 | -| configIndex | 输入参数，USB设备config信息。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### SetCurrentFunctions() - - -``` -int32_t OHOS::USB::UsbdClient::SetCurrentFunctions (int32_t funcs) -``` - -**描述：** - -设置从设备支持的功能列表（按位域表示）（从设备）。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| funcs | 输入参数，传入设备支持的function的值。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### setDevInfoBusNum() - - -``` -void OHOS::USB::UsbInfo::setDevInfoBusNum (int32_t busNum) -``` - -**描述：** - -设置USB总线编号。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| status | 输入参数，USB总线编号。 | - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### setDevInfoDevNum() - - -``` -void OHOS::USB::UsbInfo::setDevInfoDevNum (int32_t devNum) -``` - -**描述：** - -设置USB设备编号。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| status | 输入参数，USB设备编号。 | - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### setDevInfoStatus() - - -``` -void OHOS::USB::UsbInfo::setDevInfoStatus (int32_t status) -``` - -**描述：** - -设置USB设备状态。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| status | 输入参数，设备状态。 | - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### SetInterface() - - -``` -int32_t OHOS::USB::UsbdClient::SetInterface (const UsbDev & dev, uint8_t interfaceid, uint8_t altIndex ) -``` - -**描述：** - -设置指定接口的备选设置，用于在具有相同ID但不同备用设置的两个接口之间进行选择。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| dev | 输入参数，USB设备地址信息，详见[UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md)。 | -| interfaceid | 输入参数，USB设备interface ID。 | -| altIndex | 输入参数，interface的AlternateSetting信息。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### SetPortRole() - - -``` -int32_t OHOS::USB::UsbdClient::SetPortRole (int32_t portId, int32_t powerRole, int32_t dataRole ) -``` - -**描述：** - -设置port端口的角色。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| portId | 输入参数，port接口ID。 | -| powerRole | 输入参数，电源角色的值。 | -| dataRole | 输入参数，数据角色的值。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### UnbindUsbdSubscriber() - - -``` -int32_t OHOS::USB::UsbdClient::UnbindUsbdSubscriber (const sptr< UsbdSubscriber > & subscriber) -``` - -**描述：** - -解绑订阅者。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| subscriber | 输入参数，订阅者信息，详见[UsbdSubscriber](_o_h_o_s_1_1_u_s_b_1_1_usbd_subscriber.md)。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -### UnRegBulkCallback() - - -``` -int32_t OHOS::USB::UsbdClient::UnRegBulkCallback (const UsbDev & dev, const UsbPipe & pipe ) -``` - -**描述：** - -注销批量传输异步回调函数。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| dev | 输入参数，USB设备地址信息，详见[UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md)。 | -| pipe | 输入参数，USB设备pipe信息，详见[UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md)。 | - -**返回：** - -0 表示操作成功。 - -非零值 表示操作失败。 - -**Since：** - -3.0 - -**Version：** - -1.0 - -### GetInstance() - - -``` -OHOS::USB::UsbdClient::GetInstance() -``` - -**描述：** - -获取实例。 - -**Since：** - -3.0 - -**Version：** - -1.0 - - -## **变量说明** - - -### busNum [1/2] - - -``` -int32_t OHOS::USB::USBDeviceInfo::busNum -``` - -**描述：** - -USB总线编号 - - -### busNum [2/2] - - -``` -uint8_t OHOS::USB::UsbDev::busNum -``` - -**描述：** - -USB总线编号 - - -### devAddr - - -``` -uint8_t OHOS::USB::UsbDev::devAddr -``` - -**描述：** - -USB设备地址 - -### devInfo - - -``` -OHOS::USB::UsbInfo devInfo -``` - -**描述：** - -USB设备信息 - - -### devNum - - -``` -int32_t OHOS::USB::USBDeviceInfo::devNum -``` - -**描述：** - -USB设备编号 - - -### endpointId - - -``` -uint8_t OHOS::USB::UsbPipe::endpointId -``` - -**描述：** - -USB设备端点ID - - -### index - - -``` -int32_t OHOS::USB::UsbCtrlTransfer::index -``` - -**描述：** - -索引 - - -### interfaceId - - -``` -uint8_t OHOS::USB::UsbPipe::interfaceId -``` - -**描述：** - -USB设备接口ID - - -### requestCmd - - -``` -int32_t OHOS::USB::UsbCtrlTransfer::requestCmd -``` - -**描述：** - -请求命令字 - - -### requestType - - -``` -int32_t OHOS::USB::UsbCtrlTransfer::requestType -``` - -**描述：** - -请求类型 - - -### status - - -``` -int32_t OHOS::USB::USBDeviceInfo::status -``` - -**描述：** - -USB设备状态 - - -### timeout - - -``` -int32_t OHOS::USB::UsbCtrlTransfer::timeout -``` - -**描述：** - -超时时间 - - -### value - - -``` -int32_t OHOS::USB::UsbCtrlTransfer::value -``` - -**描述：** - -请求值 diff --git a/zh-cn/device-dev/reference/hdi-apis/_u_s_b_device_info.md b/zh-cn/device-dev/reference/hdi-apis/_u_s_b_device_info.md new file mode 100644 index 0000000000000000000000000000000000000000..deb045d7748f4af7f67570f90c437bdeeeccaa9a --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_u_s_b_device_info.md @@ -0,0 +1,69 @@ +# USBDeviceInfo + + +## **概述** + +USB设备信息。 + +**Since:** + +3.2 + +**Version:** + +1.0 + +**相关模块:** + +[USB](usb.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [status](#status) | USB设备状态。 | +| [busNum](#busnum) | USB设备总线编号。 | +| [devNum](#devnum) | USB设备编号。 | + + +## **类成员变量说明** + + +### busNum + + +``` +int USBDeviceInfo::busNum +``` + +**描述：** + +USB设备总线编号。 + + +### devNum + + +``` +int USBDeviceInfo::devNum +``` + +**描述：** + +USB设备编号。 + + +### status + + +``` +int USBDeviceInfo::status +``` + +**描述：** + +USB设备状态。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_usb_ctrl_transfer.md b/zh-cn/device-dev/reference/hdi-apis/_usb_ctrl_transfer.md new file mode 100644 index 0000000000000000000000000000000000000000..99202a9155522e5e3dca0223a93e744ba3547979 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_usb_ctrl_transfer.md @@ -0,0 +1,95 @@ +# UsbCtrlTransfer + + +## **概述** + +USB设备控制传输信息。 + +**Since:** + +3.2 + +**Version:** + +1.0 + +**相关模块:** + +[USB](usb.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [requestType](#requesttype) | 请求类型。 | +| [requestCmd](#requestcmd) | 请求命令。 | +| [value](#value) | 请求值。 | +| [index](#index) | 索引值。 | +| [timeout](#timeout) | 超时时间。 | + + +## **类成员变量说明** + + +### index + + +``` +int UsbCtrlTransfer::index +``` + +**描述：** + +索引值。 + + +### requestCmd + + +``` +int UsbCtrlTransfer::requestCmd +``` + +**描述：** + +请求命令。 + + +### requestType + + +``` +int UsbCtrlTransfer::requestType +``` + +**描述：** + +请求类型。 + + +### timeout + + +``` +int UsbCtrlTransfer::timeout +``` + +**描述：** + +超时时间。 + + +### value + + +``` +int UsbCtrlTransfer::value +``` + +**描述：** + +请求值。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_usb_dev.md b/zh-cn/device-dev/reference/hdi-apis/_usb_dev.md new file mode 100644 index 0000000000000000000000000000000000000000..996d138ed2b6d2d3f5614c3de4d88a52a89abb00 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_usb_dev.md @@ -0,0 +1,56 @@ +# UsbDev + + +## **概述** + +USB设备地址信息。 + +**Since:** + +3.2 + +**Version:** + +1.0 + +**相关模块:** + +[USB](usb.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [busNum](#busnum) | USB设备总线编号。 | +| [devAddr](#devaddr) | USB设备地址。 | + + +## **类成员变量说明** + + +### busNum + + +``` +unsigned char UsbDev::busNum +``` + +**描述：** + +USB设备总线编号。 + + +### devAddr + + +``` +unsigned char UsbDev::devAddr +``` + +**描述：** + +USB设备地址。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_usb_pipe.md b/zh-cn/device-dev/reference/hdi-apis/_usb_pipe.md new file mode 100644 index 0000000000000000000000000000000000000000..983703acd118e39830f6bea2ea9ebfc699aec1a1 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_usb_pipe.md @@ -0,0 +1,56 @@ +# UsbPipe + + +## **概述** + +USB设备管道信息。 + +**Since:** + +3.2 + +**Version:** + +1.0 + +**相关模块:** + +[USB](usb.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [intfId](#intfid) | USB设备接口ID。 | +| [endpointId](#endpointid) | USB设备端点ID。 | + + +## **类成员变量说明** + + +### endpointId + + +``` +unsigned char UsbPipe::endpointId +``` + +**描述：** + +USB设备端点ID。 + + +### intfId + + +``` +unsigned char UsbPipe::intfId +``` + +**描述：** + +USB设备接口ID。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_usb_types_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_usb_types_8idl.md new file mode 100644 index 0000000000000000000000000000000000000000..b5e18db841fdd6735867dcfc5c257030401df1f2 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_usb_types_8idl.md @@ -0,0 +1,39 @@ +# UsbTypes.idl + + +## **概述** + +USB驱动相关的数据类型。 + +**Since:** + +3.2 + +**Version:** + +1.0 + +**相关模块:** + +[USB](usb.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [PortInfo](_port_info.md) | USB设备端口信息。 | +| [UsbDev](_usb_dev.md) | USB设备地址信息。 | +| [UsbPipe](_usb_pipe.md) | USB设备管道信息。 | +| [UsbCtrlTransfer](_usb_ctrl_transfer.md) | USB设备控制传输信息。 | +| [USBDeviceInfo](_u_s_b_device_info.md) | USB设备信息。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.usb.v1_0 | USB驱动接口的包路径。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_use_buffer_type.md b/zh-cn/device-dev/reference/hdi-apis/_use_buffer_type.md index 99e2e88d43d8cea5b32d737fca929bc64e8772cb..1ded6ee6683da725b0f7d5018e586857715a02c3 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_use_buffer_type.md +++ b/zh-cn/device-dev/reference/hdi-apis/_use_buffer_type.md @@ -3,9 +3,11 @@ ## **概述** -**所属模块:** +UseBuffer类型定义。 + +**相关模块:** -[Codec](_codec.md) +[Codec](codec.md) ## **汇总** @@ -13,17 +15,12 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [size](#size) | 结构体大小 | -| [version](#version) | 组件版本信息 | -| [portIndex](#portindex) | 端口索引 | -| [bufferType](#buffertype) | Buffer类型 | - - -## **详细描述** - -UseBuffer类型定义。 +| [size](#size) | 结构体大小。 | +| [version](#version) | 组件版本信息。 | +| [portIndex](#portindex) | 端口索引。 | +| [bufferType](#buffertype) | Buffer类型。 | ## **类成员变量说明** @@ -38,7 +35,7 @@ uint32_t UseBufferType::bufferType **描述：** -Buffer类型 +Buffer类型。 ### portIndex @@ -50,7 +47,7 @@ uint32_t UseBufferType::portIndex **描述：** -端口索引 +端口索引。 ### size @@ -62,7 +59,7 @@ uint32_t UseBufferType::size **描述：** -结构体大小 +结构体大小。 ### version @@ -74,4 +71,4 @@ union OMX_VERSIONTYPE UseBufferType::version **描述：** -组件版本信息 +组件版本信息。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_user_auth_types_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_user_auth_types_8idl.md index fe896715602f302e112f2b7ce8a6965bc4a6b264..9100113265ad2a7134733b9f1b0c3c5d65f925d7 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_user_auth_types_8idl.md +++ b/zh-cn/device-dev/reference/hdi-apis/_user_auth_types_8idl.md @@ -3,6 +3,12 @@ ## **概述** +定义用户认证驱动的枚举类和数据结构。 + +**Since：** + +3.2 + **所属模块:** [HdfUserAuth](_hdf_user_auth.md) @@ -13,42 +19,33 @@ ### 类 - | 类 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [ExecutorRegisterInfo](_executor_register_info.md) | 执行器注册信息。 [更多...](_executor_register_info.md) | -| [ExecutorInfo](_executor_info.md) | 执行器信息。 [更多...](_executor_info.md) | -| [ScheduleInfo](_schedule_info.md) | 调度信息。 [更多...](_schedule_info.md) | -| [AuthSolution](_auth_solution.md) | 认证方案。 [更多...](_auth_solution.md) | -| [ExecutorSendMsg](_executor_send_msg.md) | 执行器发送的消息。 [更多...](_executor_send_msg.md) | -| [AuthResultInfo](_auth_result_info.md) | 用户身份认证结果信息。 [更多...](_auth_result_info.md) | -| [IdentifyResultInfo](_identify_result_info.md) | 用户身份识别结果信息。 [更多...](_identify_result_info.md) | -| [EnrollParam](_enroll_param.md) | 注册认证凭据参数。 [更多...](_enroll_param.md) | -| [CredentialInfo](_credential_info.md) | 认证凭据信息。 [更多...](_credential_info.md) | -| [EnrolledInfo](_enrolled_info.md) | 注册信息。 [更多...](_enrolled_info.md) | -| [EnrollResultInfo](_enroll_resultinfo.md) | 录入结果信息。[更多...](_enroll_resultinfo.md) | +| [ExecutorRegisterInfo](_executor_register_info.md) | 执行器注册信息。 | +| [ExecutorInfo](_user_executor_info.md) | 执行器信息。 | +| [ScheduleInfo](_schedule_info.md) | 调度信息。 | +| [AuthSolution](_auth_solution.md) | 认证方案。 | +| [ExecutorSendMsg](_executor_send_msg.md) | 执行器发送的消息。 | +| [AuthResultInfo](_auth_result_info.md) | 用户身份认证结果信息。 | +| [IdentifyResultInfo](_identify_result_info.md) | 用户身份识别结果信息。 | +| [EnrollParam](_enroll_param.md) | 注册认证凭据参数。 | +| [CredentialInfo](_credential_info.md) | 认证凭据信息。 | +| [EnrolledInfo](_enrolled_info.md) | 注册信息。 | +| [EnrollResultInfo](_enroll_resultinfo.md) | 录入结果信息。 | ### 枚举 - | 枚举 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [AuthType](_hdf_user_auth.md#authtype) : int {   PIN = 1, FACE = 2, FINGERPRINT = 4, ALL = 0 } | 枚举用户认证凭据类型。 [更多...](_hdf_user_auth.md#authtype) | -| [ExecutorRole](_hdf_user_auth.md#executorrole) : int {   COLLECTOR = 1, VERIFIER = 2, ALL_IN_ONE = 3 } | 枚举执行器角色。 [更多...](_hdf_user_auth.md#executorrole) | -| [ExecutorSecureLevel](_hdf_user_auth.md#executorsecurelevel) : int {   ESL0 = 0, ESL1 = 1, ESL2 = 2, ESL3 = 3 } | 枚举执行器安全等级。 [更多...](_hdf_user_auth.md#executorsecurelevel) | -| [PinSubType](_hdf_user_auth.md#pinsubtype) : int {   PIN\_SIX = 10000, PIN\_NUMBER = 10001, PIN\_MIX = 10002 } | 口令认证子类型。 [更多...](_hdf_user_auth.md#pinsubtype) | +| [AuthType](_hdf_user_auth.md#authtype): int { PIN = 1, FACE = 2, FINGERPRINT = 4, ALL = 0 } | 枚举用户认证凭据类型。 | +| [ExecutorRole](_hdf_user_auth.md#executorrole): int { COLLECTOR = 1, VERIFIER = 2, ALL_IN_ONE = 3 } | 枚举执行器角色。 | +| [ExecutorSecureLevel](_hdf_user_auth.md#executorsecurelevel): int { ESL0 = 0, ESL1 = 1, ESL2 = 2, ESL3 = 3 } | 枚举执行器安全等级。 | +| [PinSubType](_hdf_user_auth.md#pinsubtype) : int { PIN_SIX = 10000, PIN_NUMBER = 10001, PIN_MIX = 10002 } | 口令认证子类型。 | -### 变量 +### 关键字 - | 变量 名称 | 描述 | + | 名称 | 描述 | | -------- | -------- | | package ohos.hdi.user_auth.v1_0 | 用户认证接口的包路径 | - - -## **详细描述** - -定义用户认证驱动的枚举类和数据结构。 - -**Since：** - -3.2 diff --git a/zh-cn/device-dev/reference/hdi-apis/_user_executor_info.md b/zh-cn/device-dev/reference/hdi-apis/_user_executor_info.md index 126685bf071258a5a15d65dc8804d274f1a55325..f19e9e25e402e9ee90326ba0be87827ca0e795ea 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_user_executor_info.md +++ b/zh-cn/device-dev/reference/hdi-apis/_user_executor_info.md @@ -3,33 +3,30 @@ ## **概述** -**所属模块:** - -[HdfUserAuth](_hdf_user_auth.md) - +执行器信息。 -## **汇总** +**Since：** +3.2 -### Public 属性 +**Version：** - | Public 属性 | 描述 | -| -------- | -------- | -| executorIndex | 用户认证框架的执行器索引。 | -| info | 执行器注册信息。 | +1.0 +**所属模块:** -## **详细描述** +[HdfUserAuth](_hdf_user_auth.md) -执行器信息。 -**Since：** +## **汇总** -3.2 -**Version：** +### Public 属性 -1.0 + | 名称 | 描述 | +| -------- | -------- | +| [executorIndex](#executorindex) | 用户认证框架的执行器索引。 | +| [info](#info) | 执行器注册信息。 | ## **类成员变量说明** diff --git a/zh-cn/device-dev/reference/hdi-apis/_v_g_u_buffer.md b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_buffer.md new file mode 100644 index 0000000000000000000000000000000000000000..a97cf039e42f39b062e85430da1ad5b162af3c7d --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_buffer.md @@ -0,0 +1,25 @@ +# VGUBuffer + + +## **概述** + +硬件加速渲染位图缓存。 + +**相关模块:** + +[Display](_display.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [pixelFormat](_display.md#pixelformat) | 像素格式 | +| [width](_display.md#width-89) | 位图宽度 | +| [height](_display.md#height-88) | 位图高度 | +| [stride](_display.md#stride-22) | 位图stride | +| [virAddr](_display.md#viraddr-22) | 位图缓存的虚拟地址 | +| [phyAddr](_display.md#phyaddr-33) | 位图缓存的物理地址 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_v_g_u_color_stop.md b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_color_stop.md new file mode 100644 index 0000000000000000000000000000000000000000..3662d99760a72075354044443a391cda7f5b7467 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_color_stop.md @@ -0,0 +1,21 @@ +# VGUColorStop + + +## **概述** + +渐变颜色分布位置。 + +**相关模块:** + +[Display](_display.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [stop](_display.md#stop) | 颜色偏移位置, 值范围是 0.0 ~ 1.0 | +| [color](_display.md#color-45) | 偏移位置对应颜色 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_v_g_u_conic.md b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_conic.md new file mode 100644 index 0000000000000000000000000000000000000000..25f37b5675cc7b63da2b8157e7c4bd1184cd45c0 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_conic.md @@ -0,0 +1,21 @@ +# VGUConic + + +## **概述** + +圆锥渐变。 + +**相关模块:** + +[Display](_display.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [cx](_display.md#cx) | 圆弧中心x坐标 | +| [cy](_display.md#cy) | 圆弧中心y坐标 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_v_g_u_fill_attr.md b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_fill_attr.md new file mode 100644 index 0000000000000000000000000000000000000000..04291c89067099b4f9efa3518f54ef7c7143ae4c --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_fill_attr.md @@ -0,0 +1,20 @@ +# VGUFillAttr + + +## **概述** + +填充路径的属性。 + +**相关模块:** + +[Display](_display.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [rule](_display.md#rule) | 填充规格 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_v_g_u_funcs.md b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_funcs.md new file mode 100644 index 0000000000000000000000000000000000000000..c8bc61bb2de2a5599fb9a90aac52d1951253235b --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_funcs.md @@ -0,0 +1,30 @@ +# VGUFuncs + + +## **概述** + +定义2D硬件加速驱动函数。 + +**相关模块:** + +[Display](_display.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| ([VGUFuncs::InitVgu](_display.md#initvgu) )(void) | 初始化硬件加速。 | +| ([VGUFuncs::DeinitVgu](_display.md#deinitvgu) )(void) | 去初始化硬件加速。 | +| ([VGUFuncs::QueryCapability](_display.md#querycapability))(uint32_t cap) | 查询硬件能力集。 | +| ([VGUFuncs::RenderFill](_display.md#renderfill))(VGUSurface \*target, const VGUPath \*path, const VGUMatrix3 \*matrix, const VGUFillAttr \*attr, const VGUPaintStyle \*style) | 使用指定的渲染对象来填充路径。 | +| ([VGUFuncs::RenderStroke](_display.md#renderstroke) )(VGUSurface \*target, const VGUPath \*path, const VGUMatrix3 \*matrix, const VGUStrokeAttr \*attr, const VGUPaintStyle \*style) | 使用指定的渲染对象来描边路径。 | +| ([VGUFuncs::RenderBlur](_display.md#renderblur) )(VGUSurface \*target, uint16_t blur) | 对目标表面进行模糊处理。 | +| ([VGUFuncs::RenderBlit](_display.md#renderblit) )(VGUSurface \*target, const VGUImage \*src, uint32_t color) | 对图像进行搬移操作。 | +| ([VGUFuncs::RenderBlitN](_display.md#renderblitn) )(VGUSurface \*target, const VGUImage \*src, uint16_t count, uint32_t color) | 对多个源图像进行叠加操作。 | +| ([VGUFuncs::RenderClearRect](_display.md#renderclearrect) )(VGUSurface \*target, const VGURect \*rect, uint32_t color, uint8_t opacity) | 对指定矩形进行颜色清除操作。 | +| ([VGUFuncs::RenderCancel](_display.md#rendercancel) )() | 取消硬件加速渲染。 | +| ([VGUFuncs::RenderSync](_display.md#rendersync) )(int32_t timeOut) | 同步硬件加速模块绘制或搬移操作。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_v_g_u_gradient.md b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_gradient.md new file mode 100644 index 0000000000000000000000000000000000000000..644e6a342e722b09cd4cd33b780c82bd36d977c0 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_gradient.md @@ -0,0 +1,28 @@ +# VGUGradient + + +## **概述** + +渐变对象。 + +**相关模块:** + +[Display](_display.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [matrix](_display.md#matrix-22) | 针对渐变对象的变换矩阵 | +| [colorStops](_display.md#colorstops) | 渐变停止颜色数组指针 | +| [stopCount](_display.md#stopcount) | 渐变停止颜色个数 | +| [linear](_display.md#linear) | 线性渐变对象 | +| [radial](_display.md#radial) | 辐射渐变对象 | +| [conic](_display.md#conic) | 圆锥渐变对象 | +| [type](_display.md#type-67) | 渐变类型 | +| [spread](_display.md#spread) | 渐变延伸模式 | +| [opacity](_display.md#opacity-23) | 透明度，范围0~255。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_v_g_u_image.md b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_image.md new file mode 100644 index 0000000000000000000000000000000000000000..d0de468a5b24d6256b121c39d8242766cb62dc93 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_image.md @@ -0,0 +1,23 @@ +# VGUImage + + +## **概述** + +图像对象。 + +**相关模块:** + +[Display](_display.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [buffer](_display.md#buffer-33) | 图像存储缓存。 | +| [matrix](_display.md#matrix-12) | 图像矩阵变换，该参数为空，则内部使用单位变换矩阵。 | +| [rect](_display.md#rect-33) | 图像截取矩形，该参数为空，则截取整个图像。 | +| [opacity](_display.md#opacity-13) | 透明度，范围0~255。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_v_g_u_linear.md b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_linear.md new file mode 100644 index 0000000000000000000000000000000000000000..e666fe236fbe80b1ce0bde1c42152afbb4efd17a --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_linear.md @@ -0,0 +1,23 @@ +# VGULinear + + +## **概述** + +线性渐变。 + +**相关模块:** + +[Display](_display.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [x1](_display.md#x1-23) | 线性渐变起点水平坐标 | +| [y1](_display.md#y1-23) | 线性渐变起点垂直坐标 | +| [x2](_display.md#x2) | 线性渐变终点水平坐标 | +| [y2](_display.md#y2) | 线性渐变终点垂直坐标 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_v_g_u_mask_layer.md b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_mask_layer.md new file mode 100644 index 0000000000000000000000000000000000000000..4dab4c31fb6de03edcc6dfdbf3ce040d2177e26a --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_mask_layer.md @@ -0,0 +1,21 @@ +# VGUMaskLayer + + +## **概述** + +定义蒙版图层。 + +**相关模块:** + +[Display](_display.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [buffer](_display.md#buffer-13) | 蒙版缓存 | +| [rect](_display.md#rect-23) | 蒙版矩形 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_v_g_u_matrix3.md b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_matrix3.md new file mode 100644 index 0000000000000000000000000000000000000000..96ae437c094298bcfb1bd9e7fc98d528f7e2fd59 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_matrix3.md @@ -0,0 +1,21 @@ +# VGUMatrix3 + + +## **概述** + +定义变换矩阵。 + +**相关模块:** + +[Display](_display.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [m](_display.md#m) [3][3] | 3x3变换矩阵 | +| [type](_display.md#type-57) | 矩阵变换类型，简单变换为缩放，平移，90度倍数旋转 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_v_g_u_paint_style.md b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_paint_style.md new file mode 100644 index 0000000000000000000000000000000000000000..96b7fcc92129c17a1d6cd7f6059affdf0280c295 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_paint_style.md @@ -0,0 +1,23 @@ +# VGUPaintStyle + + +## **概述** + +填充或描边路径的渲染风格。 + +**相关模块:** + +[Display](_display.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [gradient](_display.md#gradient) | 渐变对象 | +| [pattern](_display.md#pattern) | 图片模式对象 | +| [solid](_display.md#solid) | 颜色对象 | +| [type](_display.md#type-77) | 渲染类型 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_v_g_u_path.md b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_path.md new file mode 100644 index 0000000000000000000000000000000000000000..6aaf6ea7f61305fa825e664d2a33f0d9f3cd43c4 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_path.md @@ -0,0 +1,25 @@ +# VGUPath + + +## **概述** + +路径对象，存放路径命令和坐标数据。 + +**相关模块:** + +[Display](_display.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [segment](_display.md#segment) | 存放路径命令数据 | +| [numSegments](_display.md#numsegments) | 路径命令总数 | +| [data](_display.md#data-22) | 存放路径命令对应坐标数据 | +| [type](_display.md#type-47) | 路径数据存储类型 | +| [enAlias](_display.md#enalias) | 抗锯齿开关 | +| [boundBox](_display.md#boundbox) | 路径最大边界 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_v_g_u_pattern.md b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_pattern.md new file mode 100644 index 0000000000000000000000000000000000000000..0a703728ea6b9fd15e3c8a4b57b6355177dc6491 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_pattern.md @@ -0,0 +1,22 @@ +# VGUPattern + + +## **概述** + +图片模式对象。 + +**相关模块:** + +[Display](_display.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [image](_display.md#image) | 图像对象 | +| [wrapx](_display.md#wrapx) | 图像水平方向平铺类型 | +| [wrapy](_display.md#wrapy) | 图像垂直方向平铺类型 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_v_g_u_point.md b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_point.md new file mode 100644 index 0000000000000000000000000000000000000000..1d7c6a08a3f967bf5ed110d8e7f84762984ecde4 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_point.md @@ -0,0 +1,21 @@ +# VGUPoint + + +## **概述** + +坐标点对象。 + +**相关模块:** + +[Display](_display.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [x](_display.md#x-34) | 点水平坐标 | +| [y](_display.md#y-34) | 点垂直坐标 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_v_g_u_radial.md b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_radial.md new file mode 100644 index 0000000000000000000000000000000000000000..f31d962ebf8de392564085f8651a8b3fdd126fa3 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_radial.md @@ -0,0 +1,25 @@ +# VGURadial + + +## **概述** + +辐射渐变。 + +**相关模块:** + +[Display](_display.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [x0](_display.md#x0-22) | 内圈圆心水平坐标 | +| [y0](_display.md#y0-22) | 内圈圆心垂直坐标 | +| [r0](_display.md#r0) | 内圈圆半径 | +| [x1](_display.md#x1-33) | 外圈圆心水平坐标 | +| [y1](_display.md#y1-33) | 外圈圆心垂直坐标 | +| [r1](_display.md#r1) | 外圈圆半径 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_v_g_u_rect.md b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_rect.md new file mode 100644 index 0000000000000000000000000000000000000000..161290841e1bd96ba476ae2e5b14001543bfaa70 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_rect.md @@ -0,0 +1,23 @@ +# VGURect + + +## **概述** + +矩形对象。 + +**相关模块:** + +[Display](_display.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [x](_display.md#x-44) | 矩形水平起始坐标 | +| [y](_display.md#y-44) | 矩形垂直起始坐标 | +| [w](_display.md#w-22) | 矩形宽度 | +| [h](_display.md#h-22) | 矩形高度 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_v_g_u_solid.md b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_solid.md new file mode 100644 index 0000000000000000000000000000000000000000..676479dc7b2dce3b259fba117e30f8a5a29befae --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_solid.md @@ -0,0 +1,21 @@ +# VGUSolid + + +## **概述** + +颜色对象 + +**相关模块:** + +[Display](_display.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [color](_display.md#color-55) | 颜色值 | +| [opacity](_display.md#opacity-33) | 透明度.，取值范围 0 ~ 255。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_v_g_u_stroke_attr.md b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_stroke_attr.md new file mode 100644 index 0000000000000000000000000000000000000000..50e0672bf8078048db4c8698d1fe41162754668f --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_stroke_attr.md @@ -0,0 +1,23 @@ +# VGUStrokeAttr + + +## **概述** + +描边路径的属性。 + +**相关模块:** + +[Display](_display.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [cap](_display.md#cap) | 线帽类型 | +| [join](_display.md#join) | 联结类型 | +| [miterLimit](_display.md#miterlimit) | 最大斜切长度 | +| [width](_display.md#width-99) | 线宽 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_v_g_u_surface.md b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_surface.md new file mode 100644 index 0000000000000000000000000000000000000000..bfd04bcea0e682456704e2e100a679be38279eb6 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_v_g_u_surface.md @@ -0,0 +1,26 @@ +# VGUSurface + + +## **概述** + +2D硬件加速绘制目标表面。 + +**相关模块:** + +[Display](_display.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [buffer](_display.md#buffer-23) | 位图缓存 | +| [clipRect](_display.md#cliprect) | 矩形剪切域，如果为空，整个表面直接渲染。 | +| [clipPath](_display.md#clippath) | 路径剪切域，如果为空，整个表面直接渲染。 | +| [clipType](_display.md#cliptype) | 表面剪切类型 | +| [mask](_display.md#mask) | 蒙版图层, 可以为空。 | +| [blend](_display.md#blend) | 混合叠加模式 | +| [filter](_display.md#filter) | 图像滤波类型 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_verify_alloc_info.md b/zh-cn/device-dev/reference/hdi-apis/_verify_alloc_info.md index dc697ac80a3a92a5e11de4a8454af11cf5bc5a5b..afafaf1ca376e5543550c8f8fda49dbfa920bd87 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_verify_alloc_info.md +++ b/zh-cn/device-dev/reference/hdi-apis/_verify_alloc_info.md @@ -3,7 +3,9 @@ ## **概述** -**所属模块:** +用于验证内存分配信息的结构体定义。 + +**相关模块:** [Display](_display.md) @@ -13,14 +15,9 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [width](_display.md#width-77) | 分配内存的宽度 | -| [height](_display.md#height-77) | 分配内存的高度 | +| [width](_display.md#width-79) | 分配内存的宽度 | +| [height](_display.md#height-78) | 分配内存的高度 | | [usage](_display.md#usage-22) | 内存的用处 | | [format](_display.md#format-22) | 分配内存的像素格式 | - - -## **详细描述** - -用于验证内存分配信息的结构体定义。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_vibrator.md b/zh-cn/device-dev/reference/hdi-apis/_vibrator.md deleted file mode 100644 index b3d4c3a0a251d34fd3722591f477e63b3f86f38e..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_vibrator.md +++ /dev/null @@ -1,171 +0,0 @@ -# Vibrator - - -## **汇总** - - -### 文件 - - | 文件 | 描述 | -| -------- | -------- | -| [vibrator_if.h](vibrator__if_8h.md) | 定义马达数据结构，包括马达模式和效果振动。 | -| [vibrator_type.h](vibrator__type_8h.md) | 定义马达数据结构，包括马达模式和效果振动。 | - - -### 类 - - | 类 | 描述 | -| -------- | -------- | -| [VibratorInterface](_vibrator_interface.md) | 提供Vibrator设备基本控制操作接口。[更多...](_vibrator_interface.md) | - - -### 枚举 - - | 枚举 | 描述 | -| -------- | -------- | -| [VibratorMode](#vibratormode) { VIBRATOR_MODE_ONCE = 0, VIBRATOR_MODE_PRESET = 1, VIBRATOR_MODE_BUTT } | 枚举马达振动模式。 [更多...](#vibratormode) | -| [VibratorStatus](#vibratorstatus) { VIBRATOR_SUCCESS = 0, VIBRATOR_NOT_PERIOD = -1,  VIBRATOR_NOT_INTENSITY  = -2,  VIBRATOR_NOT_FREQUENCY= -3} | 枚举马达振动模式。[更多...](#vibratorstatus) | -| [VibratorInfo](#vibratorinfo) { isSupportIntensity, isSupportFrequency, intensityMaxValue, intensityMinValue, frequencyMaxValue, frequencyMinValue} | 定义马达参数。[更多...](#vibratorinfo) | - - -### 函数 - - | 函数 | 描述 | -| -------- | -------- | -| [NewVibratorInterfaceInstance](#newvibratorinterfaceinstance) (void) | 创建一个VibratorInterface实例。 [更多...](#newvibratorinterfaceinstance) | -| [FreeVibratorInterfaceInstance](#freevibratorinterfaceinstance) (void) | 释放VibratorInterface实例以及相关资源。 [更多...](#freevibratorinterfaceinstance) | - - -## **详细描述** - -马达驱动对马达服务提供通用的接口能力。 - -服务获取驱动对象或者代理后，马达服务启动或停止振动。 通过驱动程序对象或代理提供使用功能。 - -**Since：** - -2.2 - -**版本** - -1.0: - - -## **枚举类型说明** - - -### VibratorMode - - -``` -enum VibratorMode -``` - -**描述：** - -枚举马达振动模式。 - - | 枚举值 | 描述 | -| -------- | -------- | -| VIBRATOR_MODE_ONCE | 表示给定持续时间内的一次性振动。 | -| VIBRATOR_MODE_PRESET | 表示具有预置效果的周期性振动。 | -| VIBRATOR_MODE_BUTT | 表示效果模式无效。 | - - -### VibratorStatus - - -``` -enum VibratorStatus -``` - -**描述：** - -枚举马达振动模式。 - - | 枚举值 | 描述 | -| -------- | -------- | -| VIBRATOR_SUCCESS | 操作成功。 | -| VIBRATOR_NOT_PERIOD | 不支持振动周期设置。 | -| VIBRATOR_NOT_INTENSITY | 不支持振幅设置。 | -| VIBRATOR_NOT_FREQUENCY | 不支持频率设置。 | - - -### VibratorInfo - - -``` -enum VibratorInfo -``` - -**描述：** - -定义马达参数。 - -参数包括设置马达振幅和频率以及振幅和频率的范围。 - - | 枚举值 | 描述 | -| -------- | -------- | -| isSupportIntensity | 设置马达振幅。1表示支持，0表示不支持。 | -| isSupportFrequency | 设置马达频率。1表示支持，0表示不支持。 | -| intensityMaxValue | 最大振幅。 | -| intensityMinValue | 最小振幅。 | -| frequencyMaxValue | 最大频率。 | -| frequencyMinValue | 最小频率。 | - - -## **函数说明** - - -### FreeVibratorInterfaceInstance() - - -``` -int32_t FreeVibratorInterfaceInstance (void ) -``` - -**描述：** - -释放VibratorInterface实例以及相关资源。 - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - -**Since：** - -2.2 - -**Version：** - -1.0 - - -### NewVibratorInterfaceInstance() - - -``` -const struct VibratorInterface* NewVibratorInterfaceInstance (void ) -``` - -**描述：** - -创建一个VibratorInterface实例。 - -获的马达接口实例可用于控制马达按照配置进行振动。 - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - -**Since：** - -2.2 - -**Version：** - -1.0 diff --git a/zh-cn/device-dev/reference/hdi-apis/_vibrator_interface.md b/zh-cn/device-dev/reference/hdi-apis/_vibrator_interface.md deleted file mode 100644 index 3812f340bae039c6c2d64f9cb25ffa59bab7b3b8..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_vibrator_interface.md +++ /dev/null @@ -1,208 +0,0 @@ -# VibratorInterface - - -## **概述** - -**所属模块:** - -[Vibrator](_vibrator.md) - - -## **汇总** - - -### Public 属性 - - | Public 属性 | 描述 | -| -------- | -------- | -| ( [StartOnce](#startonce) )([in] uint32_t duration) | 控制马达以执行给定持续时间的一次性振动。 [更多...](#startonce) | -| ( [Start](#start) )([in] const char \*effectType) | 控制马达以预置效果执行周期性振动。 [更多...](#start) | -| ( [Stop](#stop) )([in] enum [VibratorMode](_vibrator.md#vibratormode) mode) | 停止马达振动。 [更多...](#stop) | -| ( [GetVibratorInfo](#getvibratorinfo))([out] struct VibratorInfo \*\*vibratorInfo) | 获取有关系统中支持设置振幅和频率的所有马达信息。[更多...](#getvibratorinfo) | -| ( [EnableVibratorModulation](#enablevibratormodulation))(uint32_t duration, int32_t intensity, int32_t frequency) | 根据传入的振动效果启动马达。 [更多...](#enablevibratormodulation) | - - -## **详细描述** - -提供Vibrator设备基本控制操作接口。 - -操作包括马达模式和效果振动、停止马达振动。 - - -## **类成员变量说明** - - -### Start - - -``` -int32_t(*VibratorInterface::Start) ([in] const char *effectType) -``` - -**描述：** - -控制马达以预置效果执行周期性振动。 - -单次振动与周期振动相互排斥。在执行一次性振动之前，需退出周期性振动。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| effectType | 指向指示预置效果类型的指针。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - -**Since:** - -2.2 - -**Version:** - -1.0 - - -### StartOnce - - -``` -int32_t(*VibratorInterface::StartOnce) ([in] uint32_t duration) -``` - -**描述：** - -控制马达以执行给定持续时间的一次性振动。 - -单次振动与周期振动相互排斥。在执行一次性振动之前，需退出周期性振动。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| duration | 指示一次性振动的持续时间，以毫秒为单位。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - -**Since:** - -2.2 - -**Version:** - -1.0 - - -### Stop - - -``` -int32_t(*VibratorInterface::Stop) ([in] enum VibratorMode mode) -``` - -**描述：** - -停止马达振动。 - -马达启动前，必须在任何模式下停止振动。此功能用在振动过程之后。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| mode | 指示振动模式，可以是一次性或周期性的，详见[VibratorMode](_vibrator.md#vibratormode)。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - -**Since:** - -2.2 - -**Version:** - -1.0 - - -### GetVibratorInfo - - -``` -int32_t (*VibratorInterface::GetVibratorInfo)([out] struct VibratorInfo **vibratorInfo) -``` - -**描述：** - -获取有关系统中支持设置振幅和频率的所有马达信息。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| vibratorInfo | 表示指向马达信息的指针，详见 [VibratorInfo](_vibrator.md#vibratorinfo)。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - -**Since:** - -3.2 - -**Version:** - -1.1 - - -### EnableVibratorModulation - - -``` -int32_t (*VibratorInterface::EnableVibratorModulation)(uint32_t duration, int32_t intensity, int32_t frequency); -``` - -**描述：** - -根据传入的振动效果启动马达。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| duration | 表示马达振动的持续时间，以毫秒为单位。 | -| intensity | 表示振动周期内的马达振幅。 | -| frequency | 表示振动周期内的马达频率。 | - -**返回：** - -如果操作成功，则返回0。 - -如果不支持振动周期设置，则返回-1。 - -如果不支持振幅设置，则返回-2。 - -如果不支持频率设置，则返回-3。 - - -**Since:** - - -3.2 - - -**Version:** - - -1.1 diff --git a/zh-cn/device-dev/reference/hdi-apis/_vibrator_types_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_vibrator_types_8idl.md new file mode 100644 index 0000000000000000000000000000000000000000..fcb8a8a80b0538a70f9221b15f7ad8ed36df28ed --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_vibrator_types_8idl.md @@ -0,0 +1,42 @@ +# VibratorTypes.idl + + +## **概述** + +定义马达数据结构，包括马达振动模式和马达参数。 + +**Since:** + +3.2 + +**Version:** + +1.1 + +**相关模块:** + +[Vibrator](vibrator.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [HdfVibratorInfo](_hdf_vibrator_info.md) | 定义马达参数。 | + + +### 枚举 + + | 名称 | 描述 | +| -------- | -------- | +| [HdfVibratorMode](vibrator.md#hdfvibratormode) { HDF_VIBRATOR_MODE_ONCE, HDF_VIBRATOR_MODE_PRESET, HDF_VIBRATOR_MODE_BUTT } | 枚举马达的振动模式。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.vibrator.v1_1 | 马达模块接口的包路径。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_video_port_cap.md b/zh-cn/device-dev/reference/hdi-apis/_video_port_cap.md index 0b3aea7ea7efe0a9d32a357d6432cc438d455b36..e97bf3ac18a1d93424dc80ab64fb7d13d9bc671b 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_video_port_cap.md +++ b/zh-cn/device-dev/reference/hdi-apis/_video_port_cap.md @@ -3,9 +3,11 @@ ## **概述** -**所属模块:** +定义视频编解码能力。 + +**相关模块:** -[Codec](_codec.md) +[Codec](codec.md) ## **汇总** @@ -13,7 +15,7 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | | [minSize](#minsize) | 支持的最小分辨率 | | [maxSize](#maxsize) | 支持的最大分辨率 | @@ -21,12 +23,7 @@ | [blockCount](#blockcount) | 支持的块数量范围 | | [blocksPerSecond](#blockspersecond) | 每秒可处理的块数量范围 | | [blockSize](#blocksize) | 支持的块大小 | -| [supportPixFmts](#supportpixfmts) [[PIX_FORMAT_NUM](_codec.md#gadb8c6478388b68c09835ebe093a8920a)] | 支持的像素格式 | - - -## **详细描述** - -定义视频编解码能力。 +| [supportPixFmts](#supportpixfmts) [[PIX_FORMAT_NUM](codec.md#gadb8c6478388b68c09835ebe093a8920a)] | 支持的像素格式 | ## **类成员变量说明** @@ -41,7 +38,7 @@ RangeValue VideoPortCap::blockCount **描述：** -支持的块数量范围 +支持的块数量范围。 ### blockSize @@ -53,7 +50,7 @@ Rect VideoPortCap::blockSize **描述：** -支持的块大小 +支持的块大小。 ### blocksPerSecond @@ -65,7 +62,7 @@ RangeValue VideoPortCap::blocksPerSecond **描述：** -每秒可处理的块数量范围 +每秒可处理的块数量范围。 ### maxSize @@ -77,7 +74,7 @@ Rect VideoPortCap::maxSize **描述：** -支持的最大分辨率 +支持的最大分辨率。 ### minSize @@ -89,7 +86,7 @@ Rect VideoPortCap::minSize **描述：** -支持的最小分辨率 +支持的最小分辨率。 ### supportPixFmts @@ -101,7 +98,7 @@ int32_t VideoPortCap::supportPixFmts[PIX_FORMAT_NUM] **描述：** -支持的像素格式 +支持的像素格式，详见**OMX_COLOR_FORMATTYPE**。 ### whAlignment @@ -113,4 +110,4 @@ Alignment VideoPortCap::whAlignment **描述：** -宽高对齐值 +宽高对齐值。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_w_l_a_n.md b/zh-cn/device-dev/reference/hdi-apis/_w_l_a_n.md deleted file mode 100644 index 1abeadfea0e954a557e821a716cab04c96aa158c..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/_w_l_a_n.md +++ /dev/null @@ -1,304 +0,0 @@ -# WLAN - - -## **汇总** - - -### 文件 - - | 文件 | 描述 | -| -------- | -------- | -| [wifi_hal.h](wifi__hal_8h.md) | 提供给WLAN服务的WLAN基本能力接口。 | -| [wifi_hal_ap_feature.h](wifi__hal__ap__feature_8h.md) | 提供WLAN的AP特性能力（获取与AP连接的STA的基本信息、设置国家码）。 | -| [wifi_hal_base_feature.h](wifi__hal__base__feature_8h.md) | 提供WLAN基本特性能力。 | -| [wifi_hal_sta_feature.h](wifi__hal__sta__feature_8h.md) | 提供WLAN的STA特性能力。 | - - -### 类 - - | 类 | 描述 | -| -------- | -------- | -| [IWiFi](_i_wi_fi.md) | HAL对WLAN服务提供的基本能力。 [更多...](_i_wi_fi.md) | -| [StaInfo](_sta_info.md) | 描述与AP连接的STA的基本信息 [更多...](_sta_info.md) | -| [IWiFiAp](_i_wi_fi_ap.md) | 继承了[IWiFiBaseFeature](_i_wi_fi_base_feature.md)基本特性，并包含AP模式下获取连接STA的信息和设置国家码的功能。 [更多...](_i_wi_fi_ap.md) | -| [IWiFiBaseFeature](_i_wi_fi_base_feature.md) | WLAN基本特性操作接口，包括获取网卡名称，设置MAC地址，设置发射功率等公共能力接口。 [更多...](_i_wi_fi_base_feature.md) | -| [IWiFiSta](_i_wi_fi_sta.md) | 继承了[IWiFiBaseFeature](_i_wi_fi_base_feature.md)基本特性，额外包含设置扫描单个MAC地址功能。 [更多...](_i_wi_fi_sta.md) | - - -### 宏定义 - - | 宏定义 | 描述 | -| -------- | -------- | -| IFNAME_MAX_LEN    16 | 网卡名称最大长度。 | -| WIFI_MAC_ADDR_LENGTH    6 | WLAN的MAC地址长度。 | -| ERR_UNAUTH_ACCESS    (-6) | 定义访问失败错误码。 | - - -### 类型定义 - - | 类型定义 | 描述 | -| -------- | -------- | -| ([CallbackFunc](#callbackfunc)) (uint32_t event, void \*data, const char \*ifName) | 定义IWiFi回调函数的原型，监听异步事件。 [更多...](#callbackfunc) | - - -### 枚举 - - | 枚举 | 描述 | -| -------- | -------- | -| [FeatureType](#featuretype) {   PROTOCOL_80211_IFTYPE_UNSPECIFIED, PROTOCOL_80211_IFTYPE_ADHOC, PROTOCOL_80211_IFTYPE_STATION, PROTOCOL_80211_IFTYPE_AP,   PROTOCOL_80211_IFTYPE_AP_VLAN, PROTOCOL_80211_IFTYPE_WDS, PROTOCOL_80211_IFTYPE_MONITOR, PROTOCOL_80211_IFTYPE_MESH_POINT,   PROTOCOL_80211_IFTYPE_P2P_CLIENT, PROTOCOL_80211_IFTYPE_P2P_GO, PROTOCOL_80211_IFTYPE_P2P_DEVICE, PROTOCOL_80211_IFTYPE_NUM } | 枚举WLAN相关特性的类型[FeatureType](#featuretype)。 [更多...](#featuretype) | - - -### 函数 - - | 函数 | 描述 | -| -------- | -------- | -| [WifiConstruct](#wificonstruct) (struct [IWiFi](_i_wi_fi.md) \*\*wifiInstance) | 创建IWiFi结构体，挂接[IWiFi](_i_wi_fi.md)中能力接口。 [更多...](#wificonstruct) | -| [WifiDestruct](#wifidestruct) (struct [IWiFi](_i_wi_fi.md) \*\*wifiInstance) | 销毁IWiFi结构体并释放相关资源。 [更多...](#wifidestruct) | -| [InitApFeature](#initapfeature) (struct [IWiFiAp](_i_wi_fi_ap.md) \*\*fe) | 初始化AP特性。WLAN服务在创建AP类型的特性[FeatureType](#featuretype)时调用。 [更多...](#initapfeature) | -| [InitBaseFeature](#initbasefeature) (struct [IWiFiBaseFeature](_i_wi_fi_base_feature.md) \*\*fe) | WLAN服务创建任何类型的特性{\@Link FeatureType}时，都需要调用此函数。 [更多...](#initbasefeature) | -| [InitStaFeature](#initstafeature) (struct [IWiFiSta](_i_wi_fi_sta.md) \*\*fe) | 初始化STA特性。WLAN服务在创建STA类型的特性[FeatureType](#featuretype)时调用。 [更多...](#initstafeature) | - - -## **详细描述** - -WLAN模块向上层WLAN服务提供了统一接口。 - -HDI层开发人员可根据WLAN模块提供的向上统一接口获取如下能力：建立/关闭WLAN热点，扫描，关联WLAN热点，WLAN平台芯片管理，网络数据缓冲的申请、释放、移动等操作，网络设备管理，电源管理等。 - -**Since：** - -1.0 - -**Version：** - -1.0 - - -## **类型定义说明** - - -### CallbackFunc - - -``` -typedef int32_t(* CallbackFunc) (uint32_t event, void *data, const char *ifName) -``` - -**描述：** - -定义IWiFi回调函数的原型，监听异步事件。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| event | 输入参数，回调传入的事件类型标识。 | -| data | 输入参数，回调传入的数据。 | -| ifName | 输入参数，网卡名称。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - -**Since：** - -1.0 - -**Version：** - -1.0 - - -## **枚举类型说明** - - -### FeatureType - - -``` -enum FeatureType -``` - -**描述：** - -枚举WLAN相关特性的类型[FeatureType](#featuretype)。 - - | 枚举值 | 描述 | -| -------- | -------- | -| PROTOCOL_80211_IFTYPE_UNSPECIFIED | 未定义的类型 | -| PROTOCOL_80211_IFTYPE_ADHOC | 特设型网络 | -| PROTOCOL_80211_IFTYPE_STATION | 工作站 | -| PROTOCOL_80211_IFTYPE_AP | 接入点 | -| PROTOCOL_80211_IFTYPE_AP_VLAN | 虚拟接入点 | -| PROTOCOL_80211_IFTYPE_WDS | 无线分布式系统 | -| PROTOCOL_80211_IFTYPE_MONITOR | 网络监听器 | -| PROTOCOL_80211_IFTYPE_MESH_POINT | 组网 | -| PROTOCOL_80211_IFTYPE_P2P_CLIENT | 对等网络客户端 | -| PROTOCOL_80211_IFTYPE_P2P_GO | 对等网络群组所有者 | -| PROTOCOL_80211_IFTYPE_P2P_DEVICE | 对等网络设备 | -| PROTOCOL_80211_IFTYPE_NUM | 网口的数目 | - - -## **函数说明** - - -### InitApFeature() - - -``` -int32_t InitApFeature (struct IWiFiAp **fe) -``` - -**描述：** - -初始化AP特性。WLAN服务在创建AP类型的特性[FeatureType](#featuretype)时调用。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| fe | 输入参数，AP特性[IWiFiAp](_i_wi_fi_ap.md)。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### InitBaseFeature() - - -``` -int32_t InitBaseFeature (struct IWiFiBaseFeature **fe) -``` - -**描述：** - -WLAN服务创建任何类型的特性{\@Link FeatureType}时，都需要调用此函数。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| fe | 输入参数，基本特性[IWiFiBaseFeature](_i_wi_fi_base_feature.md)。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### InitStaFeature() - - -``` -int32_t InitStaFeature (struct IWiFiSta **fe) -``` - -**描述：** - -初始化STA特性。WLAN服务在创建STA类型的特性[FeatureType](#featuretype)时调用。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| fe | 输出参数，STA特性[IWiFiSta](_i_wi_fi_sta.md)。 | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### WifiConstruct() - - -``` -int32_t WifiConstruct (struct IWiFi **wifiInstance) -``` - -**描述：** - -创建IWiFi结构体，挂接[IWiFi](_i_wi_fi.md)中能力接口。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| wifiInstance | HAL服务对象[IWiFi](_i_wi_fi.md) | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - -**Since：** - -1.0 - -**Version：** - -1.0 - - -### WifiDestruct() - - -``` -int32_t WifiDestruct (struct IWiFi **wifiInstance) -``` - -**描述：** - -销毁IWiFi结构体并释放相关资源。 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| wifiInstance | HAL服务对象[IWiFi](_i_wi_fi.md) | - -**返回：** - -如果操作成功，则返回0。 - -如果操作失败，则返回负值。 - -**Since：** - -1.0 - -**Version：** - -1.0 diff --git a/zh-cn/device-dev/reference/hdi-apis/_w_r_g_b_color.md b/zh-cn/device-dev/reference/hdi-apis/_w_r_g_b_color.md new file mode 100644 index 0000000000000000000000000000000000000000..a083af89d8eaca3564777e6d1274f1e21076157f --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_w_r_g_b_color.md @@ -0,0 +1,82 @@ +# WRGBColor + + +## **概述** + +定义灯的WRGB模式。 + +**Since:** + +3.2 + +**Version:** + +1.0 + +**相关模块:** + +[Light](light.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [w](#w) | 白色值，范围为0-255。 | +| [r](#r) | 红色值，范围为0-255。 | +| [g](#g) | 绿色值，范围为0-255。 | +| [b](#b) | 蓝色值，范围为0-255。 | + + +## **类成员变量说明** + + +### b + + +``` +int WRGBColor::b +``` + +**描述：** + +蓝色值，范围为0-255。 + + +### g + + +``` +int WRGBColor::g +``` + +**描述：** + +绿色值，范围为0-255。 + + +### r + + +``` +int WRGBColor::r +``` + +**描述：** + +红色值，范围为0-255。 + + +### w + + +``` +int WRGBColor::w +``` + +**描述：** + +白色值，范围为0-255。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_wifi_station_info.md b/zh-cn/device-dev/reference/hdi-apis/_wifi_station_info.md new file mode 100644 index 0000000000000000000000000000000000000000..3ae0f0f9ae61ea3f63febc2fadae143602c7b36e --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_wifi_station_info.md @@ -0,0 +1,147 @@ +# WifiStationInfo + + +## **概述** + +STA的信息。 + +**Since:** + +3.2 + +**Version:** + +1.0 + +**相关模块:** + +[WLAN](wlan.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [rxRate](#rxrate) | 接收速率。 | +| [txRate](#txrate) | 发送速率。 | +| [flags](#flags) | 速率传输类型。 | +| [rxVhtmcs](#rxvhtmcs) | 接收VHT-MCS（Very High Throughput Modulation and Coding Scheme）配置。 | +| [txVhtmcs](#txvhtmcs) | 发送VHT-MCS（Very High Throughput Modulation and Coding Scheme）配置。 | +| [rxMcs](#rxmcs) | 接收MCS（Modulation and Coding Scheme）索引。 | +| [txMcs](#txmcs) | 发送MCS（Modulation and Coding Scheme）索引。 | +| [rxVhtNss](#rxvhtnss) | 接收VHT-NSS（Very High Throughput Number of Spatial Streams）配置。 | +| [txVhtNss](#txvhtnss) | 发送VHT-NSS（Very High Throughput Number of Spatial Streams）配置。 | + + +## **类成员变量说明** + + +### flags + + +``` +unsigned int WifiStationInfo::flags +``` + +**描述：** + +速率传输类型。 + + +### rxMcs + + +``` +unsigned char WifiStationInfo::rxMcs +``` + +**描述：** + +接收MCS（Modulation and Coding Scheme）索引。 + + +### rxRate + + +``` +unsigned int WifiStationInfo::rxRate +``` + +**描述：** + +接收速率。 + + +### rxVhtmcs + + +``` +unsigned char WifiStationInfo::rxVhtmcs +``` + +**描述：** + +接收VHT-MCS（Very High Throughput Modulation and Coding Scheme）配置。 + + +### rxVhtNss + + +``` +unsigned char WifiStationInfo::rxVhtNss +``` + +**描述：** + +接收VHT-NSS（Very High Throughput Number of Spatial Streams）配置。 + + +### txMcs + + +``` +unsigned char WifiStationInfo::txMcs +``` + +**描述：** + +发送MCS（Modulation and Coding Scheme）索引。 + + +### txRate + + +``` +unsigned int WifiStationInfo::txRate +``` + +**描述：** + +发送速率。 + + +### txVhtmcs + + +``` +unsigned char WifiStationInfo::txVhtmcs +``` + +**描述：** + +发送VHT-MCS（Very High Throughput Modulation and Coding Scheme）配置。 + + +### txVhtNss + + +``` +unsigned char WifiStationInfo::txVhtNss +``` + +**描述：** + +发送VHT-NSS（Very High Throughput Number of Spatial Streams）配置。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_wlan_types_8idl.md b/zh-cn/device-dev/reference/hdi-apis/_wlan_types_8idl.md new file mode 100644 index 0000000000000000000000000000000000000000..a0919917f8cad341d90e5637c1ed462b457832f9 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_wlan_types_8idl.md @@ -0,0 +1,48 @@ +# WlanTypes.idl + + +## **概述** + +WLAN模块相关的数据类型。 + +WLAN模块中使用的数据类型，包括feature对象信息、STA信息、扫描信息、网络设备信息等。 + +**Since:** + +3.2 + +**Version:** + +1.0 + +**相关模块:** + +[WLAN](wlan.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [HdfFeatureInfo](_hdf_feature_info.md) | feature对象信息。 | +| [HdfStaInfo](_hdf_sta_info.md) | STA的信息。 | +| [HdfWifiDriverScanSsid](_hdf_wifi_driver_scan_ssid.md) | WiFi扫描参数SSID信息。 | +| [HdfWifiScan](_hdf_wifi_scan.md) | WiFi扫描参数。 | +| [HdfNetDeviceInfo](_hdf_net_device_info.md) | 网络设备信息。 | +| [HdfNetDeviceInfoResult](_hdf_net_device_info_result.md) | 网络设备信息集合。 | +| [HdfWifiScanResult](_hdf_wifi_scan_result.md) | WiFi扫描结果。 | +| [HdfWifiInfo](_hdf_wifi_info.md) | WiFi频段信息。 | +| [MeasChannelParam](_meas_channel_param.md) | 信道测量参数。 | +| [MeasChannelResult](_meas_channel_result.md) | 信道测量结果。 | +| [ProjectionScreenCmdParam](_projection_screen_cmd_param.md) | 投屏参数。 | +| [WifiStationInfo](_wifi_station_info.md) | STA的信息。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.wlan.v1_0 | WLAN模块接口的包路径。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_yun_desc_info_.md b/zh-cn/device-dev/reference/hdi-apis/_yun_desc_info_.md new file mode 100644 index 0000000000000000000000000000000000000000..248ce34a95277a447f7a2c07d77b4155ee135898 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_yun_desc_info_.md @@ -0,0 +1,26 @@ +# YUVDescInfo + + +## **概述** + +YUV描述信息结构体定义。 + +**相关模块:** + +[Display](_display.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [baseAddr](_display.md#baseaddr) | 内存的初始地址 | +| [yOffset](_display.md#yoffset) | Y的偏移量 | +| [uOffset](_display.md#uoffset) | U的偏移量 | +| [vOffset](_display.md#voffset) | V的偏移量 | +| [yStride](_display.md#ystride) | Y的stride信息 | +| [uvStride](_display.md#uvstride) | UV的stride信息 | +| [uvStep](_display.md#uvstep) | UV的step信息 | diff --git a/zh-cn/device-dev/reference/hdi-apis/activity_recognition.md b/zh-cn/device-dev/reference/hdi-apis/activity_recognition.md new file mode 100644 index 0000000000000000000000000000000000000000..d7eb2ef08f3d82c16c9b20a8859c8080d90dfbca --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/activity_recognition.md @@ -0,0 +1,91 @@ +# HdiActivityRecognition + + +## **概述** + +提供订阅和获取用户行为的API。 + +MSDP（Multimodal Sensor Data Platform）可以获取行为识别驱动程序的对象或代理，然后调用该对象或代理提供的API， 获取设备支持的行为类型，订阅或取消订阅不同的行为事件，获取当前的行为事件，以及获取设备缓存的行为事件。 + +**Since**: + +3.2 + +**Version**: + +1.0 + + +## **汇总** + + +### 文件 + + | 名称 | 描述 | +| -------- | -------- | +| [ActivityRecognitionTypes.idl](activity_recognition_types_idl.md) | 定义行为识别模块使用的数据类型。 | +| [IActivityChangedCallback.idl](_i_activity_changed_callback_8idl.md) | 定义行为识别数据上报回调函数接口。 | +| [IActivityInterface.idl](_i_activity_interface_8idl.md) | 声明行为识别模块提供的API，用于获取设备支持的行为类型，订阅或取消订阅不同的行为事件，获取当前的行为事件，以及获取设备缓存的行为事件。 | + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [ActRecognitionEvent](_act_recognition_event.md) | 定义行为事件上报的数据结构。 | +| [IActivityChangedCallback](interface_i_activity_changed_callback.md) | 定义上报行为事件的回调函数。 | +| [IActivityInterface](interface_i_activity_interface.md) | 定义对行为识别进行基本操作的接口。 | + + +### 枚举 + + | 名称 | 描述 | +| -------- | -------- | +| [ActRecognitionEventType](#actrecognitioneventtype) { ACT_RECOGNITION_EVENT_ENTER = 0x01, ACT_RECOGNITION_EVENT_EXIT = 0x02 } | 枚举行为事件的类型。 | +| [ActRecognitionPowerMode](#actrecognitionpowermode) { ACT_RECOGNITION_NORMAL_MODE = 0, ACT_RECOGNITION_LOW_POWER_MODE = 1 } | 枚举功耗模式的类型。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.activity_recognition.v1_0 | 行为识别模块接口的包路径。 | + + +## **枚举类型说明** + + +### ActRecognitionEventType + + +``` +enum ActRecognitionEventType +``` + +**描述：** + +枚举行为事件的类型。 + +支持的行为包括：车载、骑车、步行、跑步、静止、快走、高铁、未知、电梯、相对静止、手持步行、躺卧、乘机、地铁等。 + + | 枚举值 | 描述 | +| -------- | -------- | +| ACT_RECOGNITION_EVENT_ENTER | 进入某一行为 | +| ACT_RECOGNITION_EVENT_EXIT | 退出某一行为 | + + +### ActRecognitionPowerMode + + +``` +enum ActRecognitionPowerMode +``` + +**描述：** + +枚举功耗模式的类型。 + + | 枚举值 | 描述 | +| -------- | -------- | +| ACT_RECOGNITION_NORMAL_MODE | 普通模式，不论主核是否休眠都会进行行为事件的上报。 | +| ACT_RECOGNITION_LOW_POWER_MODE | 低功耗模式，主核休眠时，不会进行行为事件的上报。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/activity_recognition_types_idl.md b/zh-cn/device-dev/reference/hdi-apis/activity_recognition_types_idl.md new file mode 100644 index 0000000000000000000000000000000000000000..b57d375dc22f3750b7c3423b7e91224934b44c65 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/activity_recognition_types_idl.md @@ -0,0 +1,43 @@ +# ActivityRecognitionTypes.idl + + +## **概述** + +定义行为识别模块使用的数据类型。 + +**Since**: + +3.2 + +**Version**: + +1.0 + +**相关模块:** + +[HdiActivityRecognition](activity_recognition.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [ActRecognitionEvent](_act_recognition_event.md) | 定义行为事件上报的数据结构。 | + + +### 枚举 + + | 名称 | 描述 | +| -------- | -------- | +| [ActRecognitionEventType](activity_recognition.md#actrecognitioneventtype) { ACT_RECOGNITION_EVENT_ENTER = 0x01, ACT_RECOGNITION_EVENT_EXIT = 0x02 } | 枚举行为事件的类型。 | +| [ActRecognitionPowerMode](activity_recognition.md#actrecognitionpowermode) { ACT_RECOGNITION_NORMAL_MODE = 0, ACT_RECOGNITION_LOW_POWER_MODE = 1 } | 枚举功耗模式的类型。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.activity_recognition.v1_0 | 行为识别模块接口的包路径。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/annotated.md b/zh-cn/device-dev/reference/hdi-apis/annotated.md new file mode 100644 index 0000000000000000000000000000000000000000..1b11935d7048c296973c1cfb3958f85c7a849c9e --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/annotated.md @@ -0,0 +1,365 @@ +# 结构体 + + + +- **[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)** + +- **[AudioCapture](_audio_capture.md)** + +- **[AudioControl](_audio_control.md)** + +- **[AudioDevExtInfo](_audio_dev_ext_info.md)** + +- **[AudioDeviceDescriptor](_audio_device_descriptor.md)** + +- **[AudioManager](_audio_manager.md)** + +- **[AudioMixExtInfo](_audio_mix_ext_info.md)** + +- **[AudioMmapBufferDescripter](_audio_mmap_buffer_descripter.md)** + +- **[AudioPort](_audio_port.md)** + +- **[AudioPortCap](audio_portcap.md)** + +- **[AudioPortCapability](_audio_port_capability.md)** + +- **[AudioRender](_audio_render.md)** + +- **[AudioRoute](_audio_route.md)** + +- **[AudioRouteNode](_audio_route_node.md)** + +- **[AudioSampleAttributes](_audio_sample_attributes.md)** + +- **[AudioScene](_audio_scene.md)** + +- **[AudioSceneDescriptor](_audio_scene_descriptor.md)** + +- **[AudioSceneDescriptor::SceneDesc](union_audio_scene_descriptor_1_1_scene_desc.md)** + +- **[AudioSessionExtInfo](_audio_session_ext_info.md)** + +- **[AudioSubPortCapability](_audio_sub_port_capability.md)** + +- **[AudioTimeStamp](_audio_time_stamp.md)** + +- **[AudioVolume](_audio_volume.md)** + +- **[AuthResultInfo](_auth_result_info.md)** + +- **[AuthSolution](_auth_solution.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)** + +- **[DisplayCapability](_display_capability.md)** + +- **[DisplayInfo](_display_info.md)** + +- **[DisplayModeInfo](_display_mode_info.md)** + +- **[EnrolledInfo](_enrolled_info.md)** + +- **[EnrollParam](_enroll_param.md)** + +- **[EnrollResultInfo](_enroll_resultinfo.md)** + +- **[EventInfo](_event_info.md)** + +- **[ExecutorInfo](_executor_info.md)** + +- **[ExecutorInfo](_user_executor_info.md)** + +- **[ExecutorRegisterInfo](_executor_register_info.md)** + +- **[ExecutorSendMsg](_executor_send_msg.md)** + +- **[GetBufferHandleUsageParams](_get_buffer_handle_usage_params.md)** + +- **[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)** + +- **[IExecutor](interface_pin_i_executor.md)** + +- **[IExecutorCallback](interface_i_executor_callback.md)** + +- **[IExecutorCallback](interface_pin_i_executor_callback.md)** + +- **[IFaceAuthInterface](interface_i_face_auth_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)** + +- **[InputDevDesc](_input_dev_desc.md)** + +- **[InputDeviceInfo](_input_device_info.md)** + +- **[InputDevIdentify](_input_dev_identify.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_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)** + +- **[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)** + +- **[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)** + +- **[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)** + +- **[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)** + +- **[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)** \ No newline at end of file diff --git a/zh-cn/device-dev/reference/hdi-apis/audio__adapter_8h.md b/zh-cn/device-dev/reference/hdi-apis/audio__adapter_8h.md index 39a1c6b4c753d39fa2c89bf7aea12435a1a1397d..c0b214a7cd1bb4ac363ddbcd0086614b7f24ba42 100644 --- a/zh-cn/device-dev/reference/hdi-apis/audio__adapter_8h.md +++ b/zh-cn/device-dev/reference/hdi-apis/audio__adapter_8h.md @@ -3,29 +3,26 @@ ## **概述** -**所属模块:** - -[Audio](_audio.md) - +Audio适配器的接口定义文件。 -## **汇总** +**Since:** +1.0 -### 类 +**Version:** - | 类 | 描述 | -| -------- | -------- | -| [AudioAdapter](_audio_adapter.md) | AudioAdapter音频适配器接口 [更多...](_audio_adapter.md) | +1.0 +**相关模块:** -## **详细描述** +[Audio](_audio.md) -Audio适配器的接口定义文件。 -**Since：** +## **汇总** -1.0 -**Version：** +### 类 -1.0 + | 名称 | 描述 | +| -------- | -------- | +| [AudioAdapter](_audio_adapter.md) | AudioAdapter音频适配器接口 | diff --git a/zh-cn/device-dev/reference/hdi-apis/audio__attribute_8h.md b/zh-cn/device-dev/reference/hdi-apis/audio__attribute_8h.md index 095bcf40db692f78de203acd93a8bf9d0058821d..b17a4f40f36f38c8056a2444c545dafce407eb94 100644 --- a/zh-cn/device-dev/reference/hdi-apis/audio__attribute_8h.md +++ b/zh-cn/device-dev/reference/hdi-apis/audio__attribute_8h.md @@ -3,29 +3,26 @@ ## **概述** -**所属模块:** - -[Audio](_audio.md) - +Audio属性的接口定义文件。 -## **汇总** +**Since:** +1.0 -### 类 +**Version:** - | 类 | 描述 | -| -------- | -------- | -| [AudioAttribute](_audio_attribute.md) | AudioAttribute音频属性接口 [更多...](_audio_attribute.md) | +1.0 +**相关模块:** -## **详细描述** +[Audio](_audio.md) -Audio属性的接口定义文件。 -**Since：** +## **汇总** -1.0 -**Version：** +### 类 -1.0 + | 名称 | 描述 | +| -------- | -------- | +| [AudioAttribute](_audio_attribute.md) | AudioAttribute音频属性接口 | diff --git a/zh-cn/device-dev/reference/hdi-apis/audio__capture_8h.md b/zh-cn/device-dev/reference/hdi-apis/audio__capture_8h.md index 62573f64322601ee09e1172bb3e0036654ad439d..d4579c7564d0c68e2822d437b78c59d792348bed 100644 --- a/zh-cn/device-dev/reference/hdi-apis/audio__capture_8h.md +++ b/zh-cn/device-dev/reference/hdi-apis/audio__capture_8h.md @@ -3,29 +3,26 @@ ## **概述** -**所属模块:** - -[Audio](_audio.md) - +Audio录音的接口定义文件。 -## **汇总** +**Since:** +1.0 -### 类 +**Version:** - | 类 | 描述 | -| -------- | -------- | -| [AudioCapture](_audio_capture.md) | AudioCapture音频录音接口 [更多...](_audio_capture.md) | +1.0 +**相关模块:** -## **详细描述** +[Audio](_audio.md) -Audio录音的接口定义文件。 -**Since：** +## **汇总** -1.0 -**Version：** +### 类 -1.0 + | 名称 | 描述 | +| -------- | -------- | +| [AudioCapture](_audio_capture.md) | AudioCapture音频录音接口 | diff --git a/zh-cn/device-dev/reference/hdi-apis/audio__control_8h.md b/zh-cn/device-dev/reference/hdi-apis/audio__control_8h.md index 04254ba25ab995425f023c5dc54a8ee23a340fb1..ae8509fca29ab27aaa8d7cbaf26b4b23a90ca89e 100644 --- a/zh-cn/device-dev/reference/hdi-apis/audio__control_8h.md +++ b/zh-cn/device-dev/reference/hdi-apis/audio__control_8h.md @@ -3,29 +3,26 @@ ## **概述** -**所属模块:** - -[Audio](_audio.md) - +Audio控制的接口定义文件。 -## **汇总** +**Since:** +1.0 -### 类 +**Version:** - | 类 | 描述 | -| -------- | -------- | -| [AudioControl](_audio_control.md) | AudioControl音频控制接口 [更多...](_audio_control.md) | +1.0 +**相关模块:** -## **详细描述** +[Audio](_audio.md) -Audio控制的接口定义文件。 -**Since：** +## **汇总** -1.0 -**Version：** +### 类 -1.0 + | 名称 | 描述 | +| -------- | -------- | +| [AudioControl](_audio_control.md) | AudioControl音频控制接口 | diff --git a/zh-cn/device-dev/reference/hdi-apis/audio__manager_8h.md b/zh-cn/device-dev/reference/hdi-apis/audio__manager_8h.md index 7ac28b26d6aa3f47e03f6eee4990e6b5da257a86..921f549ce6aa3caeaf9129910c921ac999674d9c 100644 --- a/zh-cn/device-dev/reference/hdi-apis/audio__manager_8h.md +++ b/zh-cn/device-dev/reference/hdi-apis/audio__manager_8h.md @@ -3,7 +3,17 @@ ## **概述** -**所属模块:** +Audio适配器管理及加载的接口定义文件。 + +**Since:** + +1.0 + +**Version:** + +1.0 + +**相关模块:** [Audio](_audio.md) @@ -13,26 +23,13 @@ ### 类 - | 类 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [AudioManager](_audio_manager.md) | AudioManager音频适配器管理接口 [更多...](_audio_manager.md) | +| [AudioManager](_audio_manager.md) | AudioManager音频适配器管理接口 | ### 函数 - | 函数 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [GetAudioManagerFuncs](_audio.md#getaudiomanagerfuncs) (void) | 获取音频适配器管理接口的操作函数列表，详情参考[AudioManager](_audio_manager.md)[更多...](_audio.md#getaudiomanagerfuncs) | - - -## **详细描述** - -Audio适配器管理及加载的接口定义文件。 - -**Since：** - -1.0 - -**Version：** - -1.0 +| [GetAudioManagerFuncs](_audio.md#getaudiomanagerfuncs) (void) | 获取音频适配器管理接口的操作函数列表，详情参考[AudioManager](_audio_manager.md)。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/audio__render_8h.md b/zh-cn/device-dev/reference/hdi-apis/audio__render_8h.md index 7f1d7eaa28d7a5ecf2edba37ea302a9d8b96463b..873f032825cf98823f9e3518f79416f366745e77 100644 --- a/zh-cn/device-dev/reference/hdi-apis/audio__render_8h.md +++ b/zh-cn/device-dev/reference/hdi-apis/audio__render_8h.md @@ -3,29 +3,26 @@ ## **概述** -**所属模块:** - -[Audio](_audio.md) - +Audio播放的接口定义文件。 -## **汇总** +**Since:** +1.0 -### 类 +**Version:** - | 类 | 描述 | -| -------- | -------- | -| [AudioRender](_audio_render.md) | AudioRender音频播放接口 [更多...](_audio_render.md) | +1.0 +**相关模块:** -## **详细描述** +[Audio](_audio.md) -Audio播放的接口定义文件。 -**Since：** +## **汇总** -1.0 -**Version：** +### 类 -1.0 + | 名称 | 描述 | +| -------- | -------- | +| [AudioRender](_audio_render.md) | AudioRender音频播放接口 | diff --git a/zh-cn/device-dev/reference/hdi-apis/audio__scene_8h.md b/zh-cn/device-dev/reference/hdi-apis/audio__scene_8h.md index 09b3026f883670d286ec9bedca1e4a27f8a65d54..fefc2bec5aa19e1e1abbe0537f02fc995fc346e0 100644 --- a/zh-cn/device-dev/reference/hdi-apis/audio__scene_8h.md +++ b/zh-cn/device-dev/reference/hdi-apis/audio__scene_8h.md @@ -3,29 +3,26 @@ ## **概述** -**所属模块:** - -[Audio](_audio.md) - +Audio场景的接口定义文件。 -## **汇总** +**Since:** +1.0 -### 类 +**Version:** - | 类 | 描述 | -| -------- | -------- | -| [AudioScene](_audio_scene.md) | AudioScene音频场景接口 [更多...](_audio_scene.md) | +1.0 +**相关模块:** -## **详细描述** +[Audio](_audio.md) -Audio场景的接口定义文件。 -**Since：** +## **汇总** -1.0 -**Version：** +### 类 -1.0 + | 名称 | 描述 | +| -------- | -------- | +| [AudioScene](_audio_scene.md) | AudioScene音频场景接口 | diff --git a/zh-cn/device-dev/reference/hdi-apis/audio__types_8h.md b/zh-cn/device-dev/reference/hdi-apis/audio__types_8h.md index 5d038c1abc9b3780f27c3a1143fd02639cc99119..2f334779b02ffa64ba585e3713edad9b9ccf0371 100644 --- a/zh-cn/device-dev/reference/hdi-apis/audio__types_8h.md +++ b/zh-cn/device-dev/reference/hdi-apis/audio__types_8h.md @@ -3,7 +3,17 @@ ## **概述** -**所属模块:** +Audio模块接口定义中使用的自定义数据类型，包括音频端口、适配器描述符、设备描述符、场景描述符、采样属性、时间戳等。 + +**Since:** + +1.0 + +**Version:** + +1.0 + +**相关模块:** [Audio](_audio.md) @@ -13,63 +23,48 @@ ### 类 - | 类 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [AudioPort](_audio_port.md) | 音频端口 [更多...](_audio_port.md) | -| [AudioAdapterDescriptor](_audio_adapter_descriptor.md) | 音频适配器描述符 [更多...](_audio_adapter_descriptor.md) | -| [AudioDeviceDescriptor](_audio_device_descriptor.md) | 音频设备描述符 [更多...](_audio_device_descriptor.md) | -| [AudioSceneDescriptor](_audio_scene_descriptor.md) | 音频场景描述符 [更多...](_audio_scene_descriptor.md) | -| [AudioSceneDescriptor::SceneDesc](union_audio_scene_descriptor_1_1_scene_desc.md) | 音频场景描述 [更多...](union_audio_scene_descriptor_1_1_scene_desc.md) | -| [AudioSampleAttributes](_audio_sample_attributes.md) | 音频采样属性 [更多...](_audio_sample_attributes.md) | -| [AudioTimeStamp](_audio_time_stamp.md) | 音频时间戳 [更多...](_audio_time_stamp.md) | -| [AudioSubPortCapability](_audio_sub_port_capability.md) | 音频子端口的支持能力 [更多...](_audio_sub_port_capability.md) | -| [AudioPortCapability](_audio_port_capability.md) | 音频端口的支持能力 [更多...](_audio_port_capability.md) | -| [AudioMmapBufferDescripter](_audio_mmap_buffer_descripter.md) | mmap缓冲区描述符 [更多...](_audio_mmap_buffer_descripter.md) | -| [AudioDevExtInfo](_audio_dev_ext_info.md) | 音频设备拓展信息 [更多...](_audio_dev_ext_info.md) | -| [AudioMixExtInfo](_audio_mix_ext_info.md) | 音轨拓展信息 [更多...](_audio_mix_ext_info.md) | -| [AudioSessionExtInfo](_audio_session_ext_info.md) | 会话拓展信息 [更多...](_audio_session_ext_info.md) | -| [AudioRouteNode](_audio_route_node.md) | 音频路由节点 [更多...](_audio_route_node.md) | -| [AudioRoute](_audio_route.md) | 音频路由信息 [更多...](_audio_route.md) | +| [AudioPort](_audio_port.md) | 音频端口 | +| [AudioAdapterDescriptor](_audio_adapter_descriptor.md) | 音频适配器描述符 | +| [AudioDeviceDescriptor](_audio_device_descriptor.md) | 音频设备描述符 | +| [AudioSceneDescriptor](_audio_scene_descriptor.md) | 音频场景描述符 | +| [AudioSceneDescriptor::SceneDesc](union_audio_scene_descriptor_1_1_scene_desc.md) | 音频场景描述 | +| [AudioSampleAttributes](_audio_sample_attributes.md) | 音频采样属性 | +| [AudioTimeStamp](_audio_time_stamp.md) | 音频时间戳 | +| [AudioSubPortCapability](_audio_sub_port_capability.md) | 音频子端口的支持能力 | +| [AudioPortCapability](_audio_port_capability.md) | 音频端口的支持能力 | +| [AudioMmapBufferDescripter](_audio_mmap_buffer_descripter.md) | mmap缓冲区描述符 | +| [AudioDevExtInfo](_audio_dev_ext_info.md) | 音频设备拓展信息. | +| [AudioMixExtInfo](_audio_mix_ext_info.md) | 音轨拓展信息 | +| [AudioSessionExtInfo](_audio_session_ext_info.md) | 会话拓展信息 | +| [AudioRouteNode](_audio_route_node.md) | 音频路由节点. | +| [AudioRoute](_audio_route.md) | 音频路由信息. | ### 类型定义 - | 类型定义 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [AudioHandle](_audio.md#ga18675ddb073465fdeac33a897f675d79) | 音频句柄 | -| ([RenderCallback](_audio.md#rendercallback)) (enum [AudioCallbackType](_audio.md#audiocallbacktype), void \*reserved, void \*cookie) | 回调函数指针 [更多...](_audio.md#rendercallback) | +| AudioHandle | 音频句柄 | +| ([RenderCallback](_audio.md#rendercallback)) (enum AudioCallbackType, void \*reserved, void \*cookie) | 回调函数指针 | ### 枚举 - | 枚举 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [AudioPortDirection](_audio.md#audioportdirection) { PORT_OUT = 0x1u, PORT_IN = 0x2u, PORT_OUT_IN = 0x3u } | 音频端口的类型 [更多...](_audio.md#audioportdirection) | -| [AudioPortPin](_audio.md#audioportpin) {   PIN_NONE = 0x0u, PIN_OUT_SPEAKER = 0x1u, PIN_OUT_HEADSET = 0x2u, PIN_OUT_LINEOUT = 0x4u,   PIN_OUT_HDMI = 0x8u, PIN_OUT_USB = 0x10u, PIN_OUT_USB_EXT = 0x20u, PIN_IN_MIC = 0x8000001u,   PIN_IN_HS_MIC = 0x8000002u, PIN_IN_LINEIN = 0x8000004u, PIN_IN_USB_EXT = 0x8000008u } | 音频适配器端口的PIN脚 [更多...](_audio.md#audioportpin) | -| [AudioCategory](_audio.md#audiocategory) { AUDIO_IN_MEDIA = 0, AUDIO_IN_COMMUNICATION, AUDIO_IN_RINGTONE, AUDIO_IN_CALL } | 音频类型（category） [更多...](_audio.md#audiocategory) | -| [AudioFormat](_audio.md#audioformat) {   AUDIO_FORMAT_PCM_8_BIT = 0x1u, AUDIO_FORMAT_PCM_16_BIT = 0x2u, AUDIO_FORMAT_PCM_24_BIT = 0x3u, AUDIO_FORMAT_PCM_32_BIT = 0x4u,   AUDIO_FORMAT_AAC_MAIN = 0x1000001u, AUDIO_FORMAT_AAC_LC = 0x1000002u, AUDIO_FORMAT_AAC_LD = 0x1000003u, AUDIO_FORMAT_AAC_ELD = 0x1000004u,   AUDIO_FORMAT_AAC_HE_V1 = 0x1000005u, AUDIO_FORMAT_AAC_HE_V2 = 0x1000006u, AUDIO_FORMAT_G711A = 0x2000001u, AUDIO_FORMAT_G711U = 0x2000002u,   AUDIO_FORMAT_G726 = 0x2000003u } | 音频格式 [更多...](_audio.md#audioformat) | -| [AudioChannelMask](_audio.md#audiochannelmask) { AUDIO_CHANNEL_FRONT_LEFT = 0x1, AUDIO_CHANNEL_FRONT_RIGHT = 0x2, AUDIO_CHANNEL_MONO = 0x1u, AUDIO_CHANNEL_STEREO = 0x3u } | 音频通道掩码（mask） [更多...](_audio.md#audiochannelmask) | -| [AudioSampleRatesMask](_audio.md#audiosampleratesmask) {   AUDIO_SAMPLE_RATE_MASK_8000 = 0x1u, AUDIO_SAMPLE_RATE_MASK_12000 = 0x2u, AUDIO_SAMPLE_RATE_MASK_11025 = 0x4u, AUDIO_SAMPLE_RATE_MASK_16000 = 0x8u,   AUDIO_SAMPLE_RATE_MASK_22050 = 0x10u, AUDIO_SAMPLE_RATE_MASK_24000 = 0x20u, AUDIO_SAMPLE_RATE_MASK_32000 = 0x40u, AUDIO_SAMPLE_RATE_MASK_44100 = 0x80u,   AUDIO_SAMPLE_RATE_MASK_48000 = 0x100u, AUDIO_SAMPLE_RATE_MASK_64000 = 0x200u, AUDIO_SAMPLE_RATE_MASK_96000 = 0x400u, AUDIO_SAMPLE_RATE_MASK_INVALID = 0xFFFFFFFFu } | 音频采样频率MASK [更多...](_audio.md#audiosampleratesmask) | -| [AudioPortPassthroughMode](_audio.md#audioportpassthroughmode) { PORT_PASSTHROUGH_LPCM = 0x1, PORT_PASSTHROUGH_RAW = 0x2, PORT_PASSTHROUGH_HBR2LBR = 0x4, PORT_PASSTHROUGH_AUTO = 0x8 } | 音频端口的数据透传模式 [更多...](_audio.md#audioportpassthroughmode) | -| [AudioSampleFormat](_audio.md#audiosampleformat) {   AUDIO_SAMPLE_FORMAT_S8, AUDIO_SAMPLE_FORMAT_S8P, AUDIO_SAMPLE_FORMAT_U8, AUDIO_SAMPLE_FORMAT_U8P,   AUDIO_SAMPLE_FORMAT_S16, AUDIO_SAMPLE_FORMAT_S16P, AUDIO_SAMPLE_FORMAT_U16, AUDIO_SAMPLE_FORMAT_U16P,   AUDIO_SAMPLE_FORMAT_S24, AUDIO_SAMPLE_FORMAT_S24P, AUDIO_SAMPLE_FORMAT_U24, AUDIO_SAMPLE_FORMAT_U24P,   AUDIO_SAMPLE_FORMAT_S32, AUDIO_SAMPLE_FORMAT_S32P, AUDIO_SAMPLE_FORMAT_U32, AUDIO_SAMPLE_FORMAT_U32P,   AUDIO_SAMPLE_FORMAT_S64, AUDIO_SAMPLE_FORMAT_S64P, AUDIO_SAMPLE_FORMAT_U64, AUDIO_SAMPLE_FORMAT_U64P,   AUDIO_SAMPLE_FORMAT_F32, AUDIO_SAMPLE_FORMAT_F32P, AUDIO_SAMPLE_FORMAT_F64, AUDIO_SAMPLE_FORMAT_F64P,   AUDIO_SAMPLE_FMT_U8, AUDIO_SAMPLE_FMT_S16, AUDIO_SAMPLE_FMT_S32, AUDIO_SAMPLE_FMT_FLOAT,   AUDIO_SAMPLE_FMT_DOUBLE, AUDIO_SAMPLE_FMT_U8P, AUDIO_SAMPLE_FMT_S16P, AUDIO_SAMPLE_FMT_S32P,   AUDIO_SAMPLE_FMT_FLOATP, AUDIO_SAMPLE_FMT_DOUBLEP, AUDIO_SAMPLE_FMT_INVALID } | 原始音频样本格式 [更多...](_audio.md#audiosampleformat) | -| [AudioChannelMode](_audio.md#audiochannelmode) {   AUDIO_CHANNEL_NORMAL = 0, AUDIO_CHANNEL_BOTH_LEFT, AUDIO_CHANNEL_BOTH_RIGHT, AUDIO_CHANNEL_EXCHANGE,   AUDIO_CHANNEL_MIX, AUDIO_CHANNEL_LEFT_MUTE, AUDIO_CHANNEL_RIGHT_MUTE, AUDIO_CHANNEL_BOTH_MUTE } | 音频播放的通道模式 [更多...](_audio.md#audiochannelmode) | -| [AudioDrainNotifyType](_audio.md#audiodrainnotifytype) { AUDIO_DRAIN_NORMAL_MODE, AUDIO_DRAIN_EARLY_MODE } | DrainBuffer函数结束类型 [更多...](_audio.md#audiodrainnotifytype) | -| [AudioCallbackType](_audio.md#audiocallbacktype) {   AUDIO_NONBLOCK_WRITE_COMPELETED, AUDIO_DRAIN_COMPELETED, AUDIO_FLUSH_COMPLETED, AUDIO_RENDER_FULL,   AUDIO_ERROR_OCCUR } | 回调函数通知事件类型 [更多...](_audio.md#audiocallbacktype) | -| [AudioPortRole](_audio.md#audioportrole) { AUDIO_PORT_UNASSIGNED_ROLE = 0, AUDIO_PORT_SOURCE_ROLE = 1, AUDIO_PORT_SINK_ROLE = 2 } | 音频端口角色 [更多...](_audio.md#audioportrole) | -| [AudioPortType](_audio.md#audioporttype) { AUDIO_PORT_UNASSIGNED_TYPE = 0, AUDIO_PORT_DEVICE_TYPE = 1, AUDIO_PORT_MIX_TYPE = 2, AUDIO_PORT_SESSION_TYPE = 3 } | 音频端口类型. [更多...](_audio.md#audioporttype) | -| [AudioSessionType](_audio.md#audiosessiontype) { AUDIO_OUTPUT_STAGE_SESSION = 0, AUDIO_OUTPUT_MIX_SESSION, AUDIO_ALLOCATE_SESSION, AUDIO_INVALID_SESSION } | 端口会话类型 [更多...](_audio.md#audiosessiontype) | - - -## **详细描述** - -Audio模块接口定义中使用的自定义数据类型 - -Audio模块接口定义中使用的自定义数据类型，包括音频端口、适配器描述符、设备描述符、场景描述符、采样属性、时间戳等。 - -**Since：** - -1.0 - -**Version：** - -1.0 +| [AudioPortDirection](_audio.md#audioportdirection) { PORT_OUT = 0x1u, PORT_IN = 0x2u, PORT_OUT_IN = 0x3u } | 音频端口的类型 | +| [AudioPortPin](_audio.md#audioportpin) { PIN_NONE = 0x0u, PIN_OUT_SPEAKER = 0x1u, PIN_OUT_HEADSET = 0x2u, PIN_OUT_LINEOUT = 0x4u,   PIN_OUT_HDMI = 0x8u, PIN_OUT_USB = 0x10u, PIN_OUT_USB_EXT = 0x20u, PIN_IN_MIC = 0x8000001u,   PIN_IN_HS_MIC = 0x8000002u, PIN_IN_LINEIN = 0x8000004u, PIN_IN_USB_EXT = 0x8000008u } | 音频适配器端口的PIN脚 | +| [AudioCategory](_audio.md#audiocategory) { AUDIO_IN_MEDIA = 0, AUDIO_IN_COMMUNICATION, AUDIO_IN_RINGTONE, AUDIO_IN_CALL } | 音频类型（category） | +| [AudioFormat](_audio.md#audioformat){ AUDIO_FORMAT_PCM_8_BIT = 0x1u, AUDIO_FORMAT_PCM_16_BIT = 0x2u, AUDIO_FORMAT_PCM_24_BIT = 0x3u, AUDIO_FORMAT_PCM_32_BIT = 0x4u,   AUDIO_FORMAT_AAC_MAIN = 0x1000001u, AUDIO_FORMAT_AAC_LC = 0x1000002u, AUDIO_FORMAT_AAC_LD = 0x1000003u, AUDIO_FORMAT_AAC_ELD = 0x1000004u,   AUDIO_FORMAT_AAC_HE_V1 = 0x1000005u, AUDIO_FORMAT_AAC_HE_V2 = 0x1000006u, AUDIO_FORMAT_G711A = 0x2000001u, AUDIO_FORMAT_G711U = 0x2000002u,   AUDIO_FORMAT_G726 = 0x2000003u } | 音频格式 | +| [AudioChannelMask](_audio.md#audiochannelmask){ AUDIO_CHANNEL_FRONT_LEFT = 0x1, AUDIO_CHANNEL_FRONT_RIGHT = 0x2, AUDIO_CHANNEL_MONO = 0x1u, AUDIO_CHANNEL_STEREO = 0x3u } | 音频通道掩码（mask） | +| [AudioSampleRatesMask](_audio.md#audiosampleratesmask){ AUDIO_SAMPLE_RATE_MASK_8000 = 0x1u, AUDIO_SAMPLE_RATE_MASK_12000 = 0x2u, AUDIO_SAMPLE_RATE_MASK_11025 = 0x4u, AUDIO_SAMPLE_RATE_MASK_16000 = 0x8u,   AUDIO_SAMPLE_RATE_MASK_22050 = 0x10u, AUDIO_SAMPLE_RATE_MASK_24000 = 0x20u, AUDIO_SAMPLE_RATE_MASK_32000 = 0x40u, AUDIO_SAMPLE_RATE_MASK_44100 = 0x80u,   AUDIO_SAMPLE_RATE_MASK_48000 = 0x100u, AUDIO_SAMPLE_RATE_MASK_64000 = 0x200u, AUDIO_SAMPLE_RATE_MASK_96000 = 0x400u, AUDIO_SAMPLE_RATE_MASK_INVALID = 0xFFFFFFFFu } | 音频采样频率MASK | +| [AudioPortPassthroughMode](_audio.md#audioportpassthroughmode){ PORT_PASSTHROUGH_LPCM = 0x1, PORT_PASSTHROUGH_RAW = 0x2, PORT_PASSTHROUGH_HBR2LBR = 0x4, PORT_PASSTHROUGH_AUTO = 0x8 } | 音频端口的数据透传模式 | +| [AudioSampleFormat](_audio.md#audiosampleformat){ AUDIO_SAMPLE_FORMAT_S8, AUDIO_SAMPLE_FORMAT_S8P, AUDIO_SAMPLE_FORMAT_U8, AUDIO_SAMPLE_FORMAT_U8P,   AUDIO_SAMPLE_FORMAT_S16, AUDIO_SAMPLE_FORMAT_S16P, AUDIO_SAMPLE_FORMAT_U16, AUDIO_SAMPLE_FORMAT_U16P,   AUDIO_SAMPLE_FORMAT_S24, AUDIO_SAMPLE_FORMAT_S24P, AUDIO_SAMPLE_FORMAT_U24, AUDIO_SAMPLE_FORMAT_U24P,   AUDIO_SAMPLE_FORMAT_S32, AUDIO_SAMPLE_FORMAT_S32P, AUDIO_SAMPLE_FORMAT_U32, AUDIO_SAMPLE_FORMAT_U32P,   AUDIO_SAMPLE_FORMAT_S64, AUDIO_SAMPLE_FORMAT_S64P, AUDIO_SAMPLE_FORMAT_U64, AUDIO_SAMPLE_FORMAT_U64P,   AUDIO_SAMPLE_FORMAT_F32, AUDIO_SAMPLE_FORMAT_F32P, AUDIO_SAMPLE_FORMAT_F64, AUDIO_SAMPLE_FORMAT_F64P } | 原始音频样本格式 | +| [AudioChannelMode](_audio.md#audiochannelmode){  AUDIO_CHANNEL_NORMAL = 0, AUDIO_CHANNEL_BOTH_LEFT, AUDIO_CHANNEL_BOTH_RIGHT, AUDIO_CHANNEL_EXCHANGE,   AUDIO_CHANNEL_MIX, AUDIO_CHANNEL_LEFT_MUTE, AUDIO_CHANNEL_RIGHT_MUTE, AUDIO_CHANNEL_BOTH_MUTE } | 音频播放的通道模式 | +| [AudioDrainNotifyType](_audio.md#audiodrainnotifytype){ AUDIO_DRAIN_NORMAL_MODE, AUDIO_DRAIN_EARLY_MODE } | DrainBuffer函数结束类型 | +| [AudioCallbackType](_audio.md#audiocallbacktype){ AUDIO_NONBLOCK_WRITE_COMPELETED, AUDIO_DRAIN_COMPELETED, AUDIO_FLUSH_COMPLETED, AUDIO_RENDER_FULL,   AUDIO_ERROR_OCCUR } | 回调函数通知事件类型 | +| [AudioPortRole](_audio.md#audioportrole){ AUDIO_PORT_UNASSIGNED_ROLE = 0, AUDIO_PORT_SOURCE_ROLE = 1, AUDIO_PORT_SINK_ROLE = 2 } | 音频端口角色 | +| [AudioPortType](_audio.md#audioporttype){ AUDIO_PORT_UNASSIGNED_TYPE = 0, AUDIO_PORT_DEVICE_TYPE = 1, AUDIO_PORT_MIX_TYPE = 2, AUDIO_PORT_SESSION_TYPE = 3 } | 音频端口类型. | +| [AudioSessionType](_audio.md#audiosessiontype){ AUDIO_OUTPUT_STAGE_SESSION = 0, AUDIO_OUTPUT_MIX_SESSION, AUDIO_ALLOCATE_SESSION, AUDIO_INVALID_SESSION } | 端口会话类型 | diff --git a/zh-cn/device-dev/reference/hdi-apis/audio__volume_8h.md b/zh-cn/device-dev/reference/hdi-apis/audio__volume_8h.md index 743fa7b97a30dd5cf2fa49bc650e50de06928579..429de22809856c4523e327aa2861ce4590e3950d 100644 --- a/zh-cn/device-dev/reference/hdi-apis/audio__volume_8h.md +++ b/zh-cn/device-dev/reference/hdi-apis/audio__volume_8h.md @@ -3,29 +3,26 @@ ## **概述** -**所属模块:** - -[Audio](_audio.md) - +Audio音量的接口定义文件。 -## **汇总** +**Since:** +1.0 -### 类 +**Version:** - | 类 | 描述 | -| -------- | -------- | -| [AudioVolume](_audio_volume.md) | AudioVolume音频音量接口 [更多...](_audio_volume.md) | +1.0 +**相关模块:** -## **详细描述** +[Audio](_audio.md) -Audio音量的接口定义文件。 -**Since：** +## **汇总** -1.0 -**Version：** +### 类 -1.0 + | 名称 | 描述 | +| -------- | -------- | +| [AudioVolume](_audio_volume.md) | AudioVolume音频音量接口 | diff --git a/zh-cn/device-dev/reference/hdi-apis/audio_portcap.md b/zh-cn/device-dev/reference/hdi-apis/audio_portcap.md new file mode 100644 index 0000000000000000000000000000000000000000..2b1d6cf7178cf68030c31ef537da5b9c6e2caa13 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/audio_portcap.md @@ -0,0 +1,79 @@ +# AudioPortCap + + +## **概述** + +定义音频编解码能力。 + +**所属模块:** + +[Codec](codec.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [sampleFormats](#sampleformats) [SAMPLE_FMT_NUM] | 支持的音频采样格式，详见[AudioSampleFormat](codec.md#audiosampleformat)。 | +| [sampleRate](#samplerate) [SAMPLE_RATE_NUM] | 支持的音频采样率，详见[AudioSampleRate](codec.md#audiosamplerate)。 | +| [channelLayouts](#channellayouts) [CHANNEL_NUM] | 支持的音频通道数channel layouts。 | +| [channelCount](#channelcount) [CHANNEL_NUM] | 支持的音频通道数。 | + + +## **详细描述** + +定义音频编解码能力。 + + +## **类成员变量说明** + + +### channelCount + + +``` +int32_t AudioPortCap::channelCount[CHANNEL_NUM] +``` + +**描述：** + +支持的音频通道数 + + +### channelLayouts + + +``` +int32_t AudioPortCap::channelLayouts[CHANNEL_NUM] +``` + +**描述：** + +支持的音频通道数channel layouts + + +### sampleFormats + + +``` +int32_t AudioPortCap::sampleFormats[SAMPLE_FMT_NUM] +``` + +**描述：** + +支持的音频采样格式，详见[AudioSampleFormat](codec.md#audiosampleformat) + + +### sampleRate + + +``` +int32_t AudioPortCap::sampleRate[SAMPLE_RATE_NUM] +``` + +**描述：** + +支持的音频采样率，详见[AudioSampleRate](codec.md#audiosamplerate) diff --git a/zh-cn/device-dev/reference/hdi-apis/battery.md b/zh-cn/device-dev/reference/hdi-apis/battery.md index 1a16568662ace94731352b6bf85f4da96607314b..bb3e111a477ae5f1171dee8f2cead9e2072528d7 100644 --- a/zh-cn/device-dev/reference/hdi-apis/battery.md +++ b/zh-cn/device-dev/reference/hdi-apis/battery.md @@ -1,56 +1,54 @@ # Battery +## **概述** + +电池模块为电池服务提供的获取、订阅电池信息的接口。 服务获取此模块的对象或代理后，可以调用相关的接口获取电池信息、订阅电池信息的变化。 + +**Since**: + +3.2 + +**Version**: + +1.0 + + ## **汇总** ### 文件 - | 文件 | 描述 | + | 名称 | 描述 | | -------- | -------- | | [IBatteryCallback.idl](_i_battery_callback_8idl.md) | 电池信息的回调。 | | [IBatteryInterface.idl](_i_battery_interface_8idl.md) | 获取、订阅电池信息的接口。 | -| [Types.idl](_types_8idl.md) | 电池信息相关数据类型。 | +| [BatteryTypes.idl](battery_types_idl.md) | 电池信息相关数据类型。 | ### 类 - | 类 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [IBatteryCallback](interface_i_battery_callback.md) | 电池信息的回调。 [更多...](interface_i_battery_callback.md) | -| [IBatteryInterface](interface_i_battery_interface.md) | 获取、订阅电池信息的接口。 [更多...](interface_i_battery_interface.md) | -| [BatteryInfo](_battery_info.md) | 电池相关信息。 [更多...](_battery_info.md) | +| [IBatteryCallback](interface_i_battery_callback.md) | 电池信息的回调。 | +| [IBatteryInterface](interface_i_battery_interface.md) | 获取、订阅电池信息的接口。 | +| [BatteryInfo](_battery_info.md) | 电池相关信息。 | ### 枚举 - | 枚举 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [BatteryHealthState](#batteryhealthstate) {   BATTERY_HEALTH_UNKNOWN = 0, BATTERY_HEALTH_GOOD, BATTERY_HEALTH_OVERHEAT, BATTERY_HEALTH_OVERVOLTAGE,   BATTERY_HEALTH_COLD, BATTERY_HEALTH_DEAD, BATTERY_HEALTH_RESERVED } | 电池的健康状态。 [更多...](#batteryhealthstate) | -| [BatteryChargeState](#batterychargestate) {   CHARGE_STATE_NONE = 0, CHARGE_STATE_ENABLE, CHARGE_STATE_DISABLE, CHARGE_STATE_FULL,   CHARGE_STATE_RESERVED } | 电池的充电状态。 [更多...](#batterychargestate) | -| [BatteryPluggedType](#batterypluggedtype) {   PLUGGED_TYPE_NONE = 0, PLUGGED_TYPE_AC, PLUGGED_TYPE_USB, PLUGGED_TYPE_WIRELESS,   PLUGGED_TYPE_BUTT } | 电池的充电设备类型。 [更多...](#batterypluggedtype) | +| [BatteryHealthState](#batteryhealthstate) {   BATTERY_HEALTH_UNKNOWN = 0, BATTERY_HEALTH_GOOD, BATTERY_HEALTH_OVERHEAT, BATTERY_HEALTH_OVERVOLTAGE,   BATTERY_HEALTH_COLD, BATTERY_HEALTH_DEAD, BATTERY_HEALTH_RESERVED } | 电池的健康状态。 | +| [BatteryChargeState](#batterychargestate) {   CHARGE_STATE_NONE = 0, CHARGE_STATE_ENABLE, CHARGE_STATE_DISABLE, CHARGE_STATE_FULL,   CHARGE_STATE_RESERVED } | 电池的充电状态。 | +| [BatteryPluggedType](#batterypluggedtype) {   PLUGGED_TYPE_NONE = 0, PLUGGED_TYPE_AC, PLUGGED_TYPE_USB, PLUGGED_TYPE_WIRELESS,   PLUGGED_TYPE_BUTT } | 电池的充电设备类型。 | -### 变量 +### 关键字 - | 变量 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| package ohos.hdi.battery.v1_0 | 电池信息接口的包路径 | - - -## **详细描述** - -提供获取、订阅电池信息的接口。 - -电池模块为电池服务提供的获取、订阅电池信息的接口。 服务获取此模块的对象或代理后，可以调用相关的接口获取电池信息、订阅电池信息的变化。 - -**Since：** - -3.1 - -**Version：** - -1.0 +| package ohos.hdi.battery.v1_0 | 电池模块接口的包路径。 | ## **枚举类型说明** diff --git a/zh-cn/device-dev/reference/hdi-apis/battery_types_idl.md b/zh-cn/device-dev/reference/hdi-apis/battery_types_idl.md new file mode 100644 index 0000000000000000000000000000000000000000..c44dc0dd1388dcb423b6b57ecb229727d40a01bf --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/battery_types_idl.md @@ -0,0 +1,46 @@ +# Types.idl + + +## **概述** + +电池信息相关数据类型。 + +电池信息中使用的数据类型，包括健康状态、充电状态、充电设备类型和电池信息结构。 + +**Since**: + +3.1 + +**Version**: + +1.0 + +**相关模块:** + +[Battery](battery.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [BatteryInfo](_battery_info.md) | 电池相关信息。 | + + +### 枚举 + + | 名称 | 描述 | +| -------- | -------- | +| [BatteryHealthState](battery.md#batteryhealthstate) { BATTERY_HEALTH_UNKNOWN = 0, BATTERY_HEALTH_GOOD, BATTERY_HEALTH_OVERHEAT, BATTERY_HEALTH_OVERVOLTAGE,   BATTERY_HEALTH_COLD, BATTERY_HEALTH_DEAD, BATTERY_HEALTH_RESERVED } | 电池的健康状态。 | +| [BatteryChargeState](battery.md#batterychargestate) { CHARGE_STATE_NONE = 0, CHARGE_STATE_ENABLE, CHARGE_STATE_DISABLE, CHARGE_STATE_FULL,   CHARGE_STATE_RESERVED } | 电池的充电状态。 | +| [BatteryPluggedType](battery.md#batterypluggedtype) { PLUGGED_TYPE_NONE = 0, PLUGGED_TYPE_AC, PLUGGED_TYPE_USB, PLUGGED_TYPE_WIRELESS,   PLUGGED_TYPE_BUTT } | 电池的充电设备类型。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.battery.v1_0 | 电池模块接口的包路径 | diff --git a/zh-cn/device-dev/reference/hdi-apis/camera.md b/zh-cn/device-dev/reference/hdi-apis/camera.md new file mode 100644 index 0000000000000000000000000000000000000000..1c2e0a41c7d0c9482a2d2d801713eff457d46653 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/camera.md @@ -0,0 +1,285 @@ +# Camera + + +## **概述** + +Camera模块接口定义。 + +Camera模块涉及相机设备的操作、流的操作、离线流的操作和各种回调等。 + +**Since**: + +3.2 + +**Version**: + +1.0 + + +## **汇总** + + +### 文件 + + | 名称 | 描述 | +| -------- | -------- | +| [ICameraDevice.idl](_i_camera_device_8idl.md) | Camera设备操作接口。 | +| [ICameraDeviceCallback.idl](_i_camera_device_callback_8idl.md) | Camera设备的回调接口，主要包含Camera设备发生错误时和上报metadata的回调函数。 | +| [ICameraHost.idl](_i_camera_host_8idl.md) | Camera服务的管理类，对上层提供HDI接口。 | +| [ICameraHostCallback.idl](_i_camera_host_callback_8idl.md) | ICameraHost的回调接口，提供Camera设备和闪关灯状态变化的回调函数，回调函数由调用者实现。 | +| [IOfflineStreamOperator.idl](_i_offline_stream_operator_8idl.md) | 离线流的操作接口。 | +| [IStreamOperator.idl](_i_stream_operator_8idl.md) | 流的操作接口。 | +| [IStreamOperatorCallback.idl](_i_stream_operator_callback_8idl.md) | [IStreamOperator](interface_i_stream_operator.md)相关的回调，这些回调均由调用者实现。 | +| [Types.idl](camera_2v1__0_2_types_8idl.md) | Camera模块HDI接口使用的数据类型。 | + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [ICameraDevice](interface_i_camera_device.md) | 定义Camera设备基本的操作。 | +| [ICameraDeviceCallback](interface_i_camera_device_callback.md) | 定义Camera设备回调操作。 | +| [ICameraHost](interface_i_camera_host.md) | 定义Camera设备功能操作。 | +| [ICameraHostCallback](interface_i_camera_host_callback.md) | 定义Camera设备功能回调操作。 | +| [IOfflineStreamOperator](interface_i_offline_stream_operator.md) | 定义Camera设备离线流操作。 | +| [IStreamOperator](interface_i_stream_operator.md) | 定义Camera设备流操作。 | +| [IStreamOperatorCallback](interface_i_stream_operator_callback.md) | 定义Camera设备流回调操作。 | +| [StreamInfo](_stream_info.md) | 流信息，用于创建流时传入相关的配置参数。 | +| [StreamAttribute](_stream_attribute.md) | 流的属性。 | +| [CaptureInfo](_capture_info.md) | 捕获请求的相关信息。 | +| [CaptureEndedInfo](_capture_ended_info.md) | 捕获结束相关信息，用于捕获结束回调[OnCaptureEnded](interface_i_stream_operator_callback.md#oncaptureended)。 | +| [CaptureErrorInfo](_capture_error_info.md) | 流错误信息，用于回调[OnCaptureError](interface_i_stream_operator_callback.md#oncaptureerror)。 | + + +### 枚举 + + | 名称 | 描述 | +| -------- | -------- | +| [CamRetCode](#camretcode) {   NO_ERROR = 0, CAMERA_BUSY = -1, INSUFFICIENT_RESOURCES = -2, INVALID_ARGUMENT = -3,   METHOD_NOT_SUPPORTED = -4, CAMERA_CLOSED = -5, DEVICE_ERROR = -6, NO_PERMISSION = -7 } | HDI接口的返回值。 | +| [ResultCallbackMode](#resultcallbackmode) { PER_FRAME = 0, ON_CHANGED = 1 } | metadata的上报模式。 | +| [OperationMode](#operationmode) { NORMAL = 0 } | 流的使用模式。 | +| [StreamIntent](#streamintent) { PREVIEW = 0, VIDEO = 1, STILL_CAPTURE = 2, POST_VIEW = 3,   ANALYZE = 4, CUSTOM = 5 } | 流的类型。 | +| [EncodeType](#encodetype) { ENCODE_TYPE_NULL = 0, ENCODE_TYPE_H264 = 1, ENCODE_TYPE_H265 = 2, ENCODE_TYPE_JPEG = 3 } | 流数据的编码类型。 | +| [StreamSupportType](#streamsupporttype) { DYNAMIC_SUPPORTED = 0, RE_CONFIGURED_REQUIRED = 1, NOT_SUPPORTED = 2 } | 对动态配置流的支持类型，使用场景参考[IsStreamsSupported](interface_i_stream_operator.md#isstreamssupported)。 | +| [CameraStatus](#camerastatus) { UN_AVAILABLE = 0, AVAILABLE = 1 } | Camera设备状态。 | +| [FlashlightStatus](#flashlightstatus) { FLASHLIGHT_OFF = 0, FLASHLIGHT_ON = 1, FLASHLIGHT_UNAVAILABLE = 2 } | 闪光灯状态。 | +| [CameraEvent](#cameraevent) { CAMERA_EVENT_DEVICE_ADD = 0, CAMERA_EVENT_DEVICE_RMV = 1 } | Camera事件。 | +| [ErrorType](#errortype) {   FATAL_ERROR = 0, REQUEST_TIMEOUT = 1, DRIVER_ERROR = 2, DEVICE_PREEMPT = 3,   DEVICE_DISCONNECT = 4, DCAMERA_ERROR_BEGIN = 1024, DCAMERA_ERROR_DEVICE_IN_USE, DCAMERA_ERROR_NO_PERMISSION } | 设备错误类型，用于设备错误回调[OnError](interface_i_camera_device_callback.md#onerror)。 | +| [StreamError](#streamerror) { UNKNOWN_ERROR = 0, BUFFER_LOST = 1 } | 流错误类型，用于流错误类型[CaptureErrorInfo](_capture_error_info.md)。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.camera.v1_0 | Camera设备接口的包路径。 | +| sequenceable ohos.hdi.camera.v1_0.BufferProducerSequenceable | | + + +## **枚举类型说明** + + +### CameraEvent + + +``` +enum CameraEvent +``` + +**描述：** + +Camera事件。 + + | 枚举值 | 描述 | +| -------- | -------- | +| CAMERA_EVENT_DEVICE_ADD | Camera设备增加事件。 | +| CAMERA_EVENT_DEVICE_RMV | Camera设备删除事件。 | + + +### CameraStatus + + +``` +enum CameraStatus +``` + +**描述：** + +Camera设备状态。 + + | 枚举值 | 描述 | +| -------- | -------- | +| UN_AVAILABLE | 设备当前不在位或者不可用。 | +| AVAILABLE | 设备当前可用。 | + + +### CamRetCode + + +``` +enum CamRetCode +``` + +**描述：** + +HDI接口的返回值。 + + | 枚举值 | 描述 | +| -------- | -------- | +| NO_ERROR | 调用成功。 | +| CAMERA_BUSY | 设备当前忙。 | +| INSUFFICIENT_RESOURCES | 资源不足。 | +| INVALID_ARGUMENT | 参数错误。 | +| METHOD_NOT_SUPPORTED | 不支持当前调用方法。 | +| CAMERA_CLOSED | Camera设备已经关闭。 | +| DEVICE_ERROR | 驱动层发生严重错误。 | +| NO_PERMISSION | 无权限访问设备。 | + + +### EncodeType + + +``` +enum EncodeType +``` + +**描述：** + +流数据的编码类型。 + + | 枚举值 | 描述 | +| -------- | -------- | +| ENCODE_TYPE_NULL | 未设置编码类型 | +| ENCODE_TYPE_H264 | 编码类型为H264。 | +| ENCODE_TYPE_H265 | 编码类型为H265。 | +| ENCODE_TYPE_JPEG | 编码类型为JPEG。 | + + +### ErrorType + + +``` +enum ErrorType +``` + +**描述：** + +设备错误类型，用于设备错误回调[OnError](interface_i_camera_device_callback.md#onerror)。 + + | 枚举值 | 描述 | +| -------- | -------- | +| FATAL_ERROR | 严重错误，需要关闭Camera设备。 | +| REQUEST_TIMEOUT | 请求超时，需要关闭Camera设备。 | +| DRIVER_ERROR | 驱动程序中发生错误。 | +| DEVICE_PREEMPT | 设备被抢占。 | +| DEVICE_DISCONNECT | 设备已断开连接。 | +| DCAMERA_ERROR_BEGIN | 分布式像机错误开始的标识。 | +| DCAMERA_ERROR_DEVICE_IN_USE | 分布式像机设备忙。 | +| DCAMERA_ERROR_NO_PERMISSION | 没有访问分布式摄像机设备的权限。 | + + +### FlashlightStatus + + +``` +enum FlashlightStatus +``` + +**描述：** + +闪光灯状态。 + + | 枚举值 | 描述 | +| -------- | -------- | +| FLASHLIGHT_OFF | 闪光灯关闭。 | +| FLASHLIGHT_ON | 闪光灯开启。 | +| FLASHLIGHT_UNAVAILABLE | 闪光灯当前不可用。 | + + +### OperationMode + + +``` +enum OperationMode +``` + +**描述：** + +流的使用模式。 + + | 枚举值 | 描述 | +| -------- | -------- | +| NORMAL | 普通模式。 | + + +### ResultCallbackMode + + +``` +enum ResultCallbackMode +``` + +**描述：** + +metadata的上报模式。 + + | 枚举值 | 描述 | +| -------- | -------- | +| PER_FRAME | 逐帧上报。 | +| ON_CHANGED | 设备状态变化时上报。 | + + +### StreamError + + +``` +enum StreamError +``` + +**描述：** + +流错误类型，用于流错误类型[CaptureErrorInfo](_capture_error_info.md)。 + + | 枚举值 | 描述 | +| -------- | -------- | +| UNKNOWN_ERROR | 流未知错误。 | +| BUFFER_LOST | 丢包。 | + + +### StreamIntent + + +``` +enum StreamIntent +``` + +**描述：** + +流的类型。 + + | 枚举值 | 描述 | +| -------- | -------- | +| PREVIEW | 流数据用于显示，即预览流。 | +| VIDEO | 流数据用于编码生成录像，即录像流。 | +| STILL_CAPTURE | 流数据用于编码生成照片，即拍照流。 | +| POST_VIEW | 流数据用于保存缩略图。 | +| ANALYZE | 流数据用于图像分析。 | +| CUSTOM | 自定义类型。 | + + +### StreamSupportType + + +``` +enum StreamSupportType +``` + +**描述：** + +对动态配置流的支持类型，使用场景参考[IsStreamsSupported](interface_i_stream_operator.md#isstreamssupported)。 + + | 枚举值 | 描述 | +| -------- | -------- | +| DYNAMIC_SUPPORTED | 支持动态配置流，对应的流参数直接生效。 | +| RE_CONFIGURED_REQUIRED | 不支持动态配置流，对应的参数需要停止流然后重新配置流才能生效。 | +| NOT_SUPPORTED | 不支持对应的流参数配置。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/camera_2v1__0_2_types_8idl.md b/zh-cn/device-dev/reference/hdi-apis/camera_2v1__0_2_types_8idl.md new file mode 100644 index 0000000000000000000000000000000000000000..2b9d40990a3ccaf5316d3ff244d26ecf8d70482a --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/camera_2v1__0_2_types_8idl.md @@ -0,0 +1,57 @@ +# Types.idl + + +## **概述** + +Camera模块HDI接口使用的数据类型。 + +**Since:** + +3.2 + +**Version:** + +1.0 + +**相关模块:** + +[Camera](camera.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [StreamInfo](_stream_info.md) | 流信息，用于创建流时传入相关的配置参数。 | +| [StreamAttribute](_stream_attribute.md) | 流的属性。 | +| [CaptureInfo](_capture_info.md) | 捕获请求的相关信息。 | +| [CaptureEndedInfo](_capture_ended_info.md) | 捕获结束相关信息，用于捕获结束回调[OnCaptureEnded](interface_i_stream_operator_callback.md#oncaptureended)。 | +| [CaptureErrorInfo](_capture_error_info.md) | 流错误信息，用于回调[OnCaptureError](interface_i_stream_operator_callback.md#oncaptureerror)。 | + + +### 枚举 + + | 名称 | 描述 | +| -------- | -------- | +| [CamRetCode](camera.md#camretcode) {   NO_ERROR = 0, CAMERA_BUSY = -1, INSUFFICIENT_RESOURCES = -2, INVALID_ARGUMENT = -3,   METHOD_NOT_SUPPORTED = -4, CAMERA_CLOSED = -5, DEVICE_ERROR = -6, NO_PERMISSION = -7 } | HDI接口的返回值。 | +| [ResultCallbackMode](camera.md#resultcallbackmode) { PER_FRAME = 0, ON_CHANGED = 1 } | metadata的上报模式。 | +| [OperationMode](camera.md#operationmode) { NORMAL = 0 } | 流的使用模式。 | +| [StreamIntent](camera.md#streamintent) { PREVIEW = 0, VIDEO = 1, STILL_CAPTURE = 2, POST_VIEW = 3,   ANALYZE = 4, CUSTOM = 5 } | 流的类型。 | +| [EncodeType](camera.md#encodetype) { ENCODE_TYPE_NULL = 0, ENCODE_TYPE_H264 = 1, ENCODE_TYPE_H265 = 2, ENCODE_TYPE_JPEG = 3 } | 流数据的编码类型。 | +| [StreamSupportType](camera.md#streamsupporttype) { DYNAMIC_SUPPORTED = 0, RE_CONFIGURED_REQUIRED = 1, NOT_SUPPORTED = 2 } | 对动态配置流的支持类型，使用场景参考[IsStreamsSupported](interface_i_stream_operator.md#isstreamssupported)。 | +| [CameraStatus](camera.md#camerastatus) { UN_AVAILABLE = 0, AVAILABLE = 1 } | Camera设备状态。 | +| [FlashlightStatus](camera.md#flashlightstatus) { FLASHLIGHT_OFF = 0, FLASHLIGHT_ON = 1, FLASHLIGHT_UNAVAILABLE = 2 } | 闪光灯状态。 | +| [CameraEvent](camera.md#cameraevent) { CAMERA_EVENT_DEVICE_ADD = 0, CAMERA_EVENT_DEVICE_RMV = 1 } | Camera事件。 | +| [ErrorType](camera.md#errortype) {   FATAL_ERROR = 0, REQUEST_TIMEOUT = 1, DRIVER_ERROR = 2, DEVICE_PREEMPT = 3,   DEVICE_DISCONNECT = 4, DCAMERA_ERROR_BEGIN = 1024, DCAMERA_ERROR_DEVICE_IN_USE, DCAMERA_ERROR_NO_PERMISSION } | 设备错误类型，用于设备错误回调[OnError](interface_i_camera_device_callback.md#onerror)。 | +| [StreamError](camera.md#streamerror) { UNKNOWN_ERROR = 0, BUFFER_LOST = 1 } | 流错误类型，用于流错误类型[CaptureErrorInfo](_capture_error_info.md)。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.camera.v1_0 | Camera设备接口的包路径。 | +| **BufferProducerSequenceable** | | diff --git a/zh-cn/device-dev/reference/hdi-apis/codec.md b/zh-cn/device-dev/reference/hdi-apis/codec.md new file mode 100644 index 0000000000000000000000000000000000000000..94f2cc468c9d22a470f36129b1b182ff16b7d5ba --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/codec.md @@ -0,0 +1,473 @@ +# Codec + + +## **概述** + +Codec模块接口定义。 + +Codec模块涉及自定义类型、音视频编解码组件初始化、参数设置、数据的轮转和控制等。 + +**Since**: + +3.1 + +**Version**: + +2.0 + + +## **汇总** + + +### 文件 + + | 名称 | 描述 | +| -------- | -------- | +| [codec_callback_if.h](codec_callback_if_h.md) | 主要包括回调函数接口定义。 | +| [codec_common_type.h](codec_common_type_h.md) | Codec模块接口定义中使用的自定义数据类型。 | +| [codec_component_if.h](codec_component_if_h.md) | 主要包括Codec组件接口定义。 | +| [codec_component_manager.h](codec__component__manager_h.md) | 主要包括Codec组件管理类接口。 | +| [codec_component_type.h](codec__component__type_h.md) | Codec模块接口定义中使用的自定义数据类型。 | + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [CodecCallbackType](_codec_callback_type.md) | Codec回调接口定义。 | +| [Alignment](_alignment.md) | 对齐结构定义，包含宽高的对齐值。 | +| [Rect](_rect.md) | 矩形的定义。 | +| [RangeValue](_range_value.md) | 取值范围的定义。 | +| [CodecComponentType](_codec_component_type.md) | Codec组件接口定义。 | +| [CodecComponentManager](_codec_component_manager.md) | Codec组件管理类接口定义。 | +| [VideoPortCap](_video_port_cap.md) | 定义视频编解码能力。 | +| [AudioPortCap](audio_portcap.md) | 定义音频编解码能力。 | +| [PortCap](union_port_cap.md) | 定义音视频编解码能力。 | +| [CodecCompCapability](_codec_comp_capability.md) | 定义Codec编解码能力。 | +| [OmxCodecBuffer](_omx_codec_buffer.md) | Codec buffer信息的定义。 | +| [CompVerInfo](_comp_ver_info.md) | 定义组件版本信息。 | +| [EventInfo](_event_info.md) | 定义事件上报信息。 | +| [SupportBufferType](_support_buffer_type.md) | SupportBuffer类型定义。 | +| [UseBufferType](_use_buffer_type.md) | UseBuffer类型定义。 | +| [GetBufferHandleUsageParams](_get_buffer_handle_usage_params.md) | BufferHandleUsage类型定义。 | + + +### 宏定义 + + | 名称 | 描述 | +| -------- | -------- | +| SAMPLE_FMT_NUM    32 | 采样格式最大值。 | +| UUID_LENGTH    128 | 定义UUID长度。 | +| PIX_FORMAT_NUM    16 | 支持的像素格式数组大小。 | +| SAMPLE_FORMAT_NUM    12 | 支持的音频采样格式数组大小。 | +| SAMPLE_RATE_NUM    16 | 支持的音频采样率数组大小。 | +| CHANNEL_NUM    16 | 支持的音频通道数组大小。 | +| NAME_LENGTH    32 | 组件名称大小。 | +| PROFILE_NUM    256 | 支持的profile数组大小。 | + + +### 枚举 + + | 名称 | 描述 | +| -------- | -------- | +| [CodecType](#codectype) { VIDEO_DECODER, VIDEO_ENCODER, AUDIO_DECODER, AUDIO_ENCODER,   INVALID_TYPE } | 枚举编解码的类型。 | +| [Profile](#profile) { INVALID_PROFILE = 0, AAC_LC_PROFILE = 0x1000, AAC_MAIN_PROFILE, AAC_HE_V1_PROFILE,   AAC_HE_V2_PROFILE, AAC_LD_PROFILE, AAC_ELD_PROFILE, AVC_BASELINE_PROFILE = 0x2000,   AVC_MAIN_PROFILE, AVC_HIGH_PROFILE, HEVC_MAIN_PROFILE = 0x3000, HEVC_MAIN_10_PROFILE } | 枚举Codec规格。 | +| [AudioSampleRate](#audiosamplerate) { AUD_SAMPLE_RATE_8000 = 8000, AUD_SAMPLE_RATE_12000 = 12000, AUD_SAMPLE_RATE_11025 = 11025, AUD_SAMPLE_RATE_16000 = 16000,   AUD_SAMPLE_RATE_22050 = 22050, AUD_SAMPLE_RATE_24000 = 24000, AUD_SAMPLE_RATE_32000 = 32000, AUD_SAMPLE_RATE_44100 = 44100,   AUD_SAMPLE_RATE_48000 = 48000, AUD_SAMPLE_RATE_64000 = 64000, AUD_SAMPLE_RATE_96000 = 96000, AUD_SAMPLE_RATE_INVALID } | 枚举音频采样率。 | +| [CodecCapsMask](#codeccapsmask) { CODEC_CAP_ADAPTIVE_PLAYBACK = 0x1, CODEC_CAP_SECURE_PLAYBACK = 0x2, CODEC_CAP_TUNNEL_PLAYBACK = 0x4, CODEC_CAP_MULTI_PLANE = 0x10000 } | 枚举播放能力。 | +| [CodecProcessMode](#codecprocessmode) { PROCESS_BLOCKING_INPUT_BUFFER = 0X1, PROCESS_BLOCKING_OUTPUT_BUFFER = 0X2, PROCESS_BLOCKING_CONTROL_FLOW = 0X4, PROCESS_NONBLOCKING_INPUT_BUFFER = 0X100,   PROCESS_NONBLOCKING_OUTPUT_BUFFER = 0X200, PROCESS_NONBLOCKING_CONTROL_FLOW = 0X400 } | 枚举编解码处理模式。 | +| [AvCodecRole](#avcodecrole) {   MEDIA_ROLETYPE_IMAGE_JPEG = 0, MEDIA_ROLETYPE_VIDEO_AVC, MEDIA_ROLETYPE_VIDEO_HEVC, MEDIA_ROLETYPE_AUDIO_FIRST = 0x10000,   MEDIA_ROLETYPE_AUDIO_AAC = 0x10000, MEDIA_ROLETYPE_AUDIO_G711A, MEDIA_ROLETYPE_AUDIO_G711U, MEDIA_ROLETYPE_AUDIO_G726,   MEDIA_ROLETYPE_AUDIO_PCM, MEDIA_ROLETYPE_AUDIO_MP3, MEDIA_ROLETYPE_INVALID } | 枚举音视频编解码组件类型。 | +| [AudioSampleFormat](#audiosampleformat) {  AUDIO_SAMPLE_FORMAT_S8 = 0, AUDIO_SAMPLE_FORMAT_S8P = 1, AUDIO_SAMPLE_FORMAT_U8 = 2, AUDIO_SAMPLE_FORMAT_U8P = 3,   AUDIO_SAMPLE_FORMAT_S16 = 4, AUDIO_SAMPLE_FORMAT_S16P = 5, AUDIO_SAMPLE_FORMAT_U16 = 6, AUDIO_SAMPLE_FORMAT_U16P = 7,   AUDIO_SAMPLE_FORMAT_S24 = 8, AUDIO_SAMPLE_FORMAT_S24P = 9, AUDIO_SAMPLE_FORMAT_U24 = 10, AUDIO_SAMPLE_FORMAT_U24P = 11,   AUDIO_SAMPLE_FORMAT_S32 = 12, AUDIO_SAMPLE_FORMAT_S32P = 13, AUDIO_SAMPLE_FORMAT_U32 = 14, AUDIO_SAMPLE_FORMAT_U32P = 15,   AUDIO_SAMPLE_FORMAT_S64 = 16, AUDIO_SAMPLE_FORMAT_S64P = 17, AUDIO_SAMPLE_FORMAT_U64 = 18, AUDIO_SAMPLE_FORMAT_U64P = 19,   AUDIO_SAMPLE_FORMAT_F32 = 20, AUDIO_SAMPLE_FORMAT_F32P = 21, AUDIO_SAMPLE_FORMAT_F64 = 22, AUDIO_SAMPLE_FORMAT_F64P = 23,   AUDIO_SAMPLE_FMT_U8, AUDIO_SAMPLE_FMT_S16, AUDIO_SAMPLE_FMT_S32, AUDIO_SAMPLE_FMT_FLOAT,   AUDIO_SAMPLE_FMT_DOUBLE, AUDIO_SAMPLE_FMT_U8P, AUDIO_SAMPLE_FMT_S16P, AUDIO_SAMPLE_FMT_S32P,   AUDIO_SAMPLE_FMT_FLOATP, AUDIO_SAMPLE_FMT_DOUBLEP, AUDIO_SAMPLE_FMT_INVALID } | 枚举音频采样格式。 | +| [CodecBufferType](#codecbuffertype) {   CODEC_BUFFER_TYPE_INVALID = 0, CODEC_BUFFER_TYPE_VIRTUAL_ADDR = 0x1, CODEC_BUFFER_TYPE_AVSHARE_MEM_FD = 0x2, CODEC_BUFFER_TYPE_HANDLE = 0x4,   CODEC_BUFFER_TYPE_DYNAMIC_HANDLE = 0x8 } | 定义buffer类型。 | +| [ShareMemTypes](#sharememtypes) { READ_WRITE_TYPE = 0x1, READ_ONLY_TYPE = 0x2 } | 枚举共享内存类型。 | +| [OmxIndexCodecExType](#omxindexcodecextype) { OMX_IndexExtBufferTypeStartUnused = OMX_IndexKhronosExtensions + 0x00a00000, OMX_IndexParamSupportBufferType, OMX_IndexParamUseBufferType, OMX_IndexParamGetBufferHandleUsage } | 枚举Codec扩展index。 | +| [OmxVideoExType](#omxvideoextype) { OMX_VIDEO_CodingHEVC = 11 } | 枚举Codec扩展编码类型。 | + + +### 函数 + + | 名称 | 描述 | +| -------- | -------- | +| [CodecCallbackTypeGet](#codeccallbacktypeget) (struct HdfRemoteService \*remote) | 实例化CodecCallbackType对象。 | +| [CodecCallbackTypeRelease](#codeccallbacktyperelease) (struct [CodecCallbackType](_codec_callback_type.md) \*instance) | 释放CodecCallbackType对象。 | +| [CodecComponentTypeGet](#codeccomponenttypeget) (struct HdfRemoteService \*remote) | 实例化CodecComponentType对象。 | +| [CodecComponentTypeRelease](#codeccomponenttyperelease) (struct [CodecComponentType](_codec_component_type.md) \*instance) | 释放CodecComponentType对象。 | +| [GetCodecComponentManager](#getcodeccomponentmanager) (void) | 实例化CodecComponentManager对象。 | +| [CodecComponentManagerRelease](#codeccomponentmanagerrelease) (void) | 释放CodecComponentManager对象。 | + + +## **枚举类型说明** + + +### AudioSampleFormat + + +``` +enum AudioSampleFormat +``` + +**描述：** + +枚举音频采样格式。 + +对于planar的采样格式，每个声道的数据是独立存储在data中；对于packed的采样格式，只使用第一个data，每个声道的数据是交错存储的。 + + | 枚举值 | 描述 | +| -------- | -------- | +| AUDIO_SAMPLE_FORMAT_S8 | 8bit位宽有符号交织样本。 | +| AUDIO_SAMPLE_FORMAT_S8P | 8bit位宽有符号非交织样本。 | +| AUDIO_SAMPLE_FORMAT_U8 | 8bit位宽无符号交织样本。 | +| AUDIO_SAMPLE_FORMAT_U8P | 8bit位宽无符号非交织样本。 | +| AUDIO_SAMPLE_FORMAT_S16 | 16bit位宽有符号交织样本。 | +| AUDIO_SAMPLE_FORMAT_S16P | 16bit位宽有符号非交织样本。 | +| AUDIO_SAMPLE_FORMAT_U16 | 16bit位宽无符号交织样本。 | +| AUDIO_SAMPLE_FORMAT_U16P | 16bit位宽无符号非交织样本。 | +| AUDIO_SAMPLE_FORMAT_S24 | 24bit位宽有符号交织样本。 | +| AUDIO_SAMPLE_FORMAT_S24P | 24bit位宽有符号非交织样本。 | +| AUDIO_SAMPLE_FORMAT_U24 | 24bit位宽无符号交织样本。 | +| AUDIO_SAMPLE_FORMAT_U24P | 24bit位宽无符号非交织样本。 | +| AUDIO_SAMPLE_FORMAT_S32 | 32bit位宽有符号交织样本。 | +| AUDIO_SAMPLE_FORMAT_S32P | 32bit位宽有符号非交织样本。 | +| AUDIO_SAMPLE_FORMAT_U32 | 32bit位宽无符号交织样本。 | +| AUDIO_SAMPLE_FORMAT_U32P | 32bit位宽无符号非交织样本。 | +| AUDIO_SAMPLE_FORMAT_S64 | 64bit位宽有符号交织样本。 | +| AUDIO_SAMPLE_FORMAT_S64P | 64bit位宽有符号非交织样本。 | +| AUDIO_SAMPLE_FORMAT_U64 | 64bit位宽无符号交织样本。 | +| AUDIO_SAMPLE_FORMAT_U64P | 64bit位宽无符号非交织样本。 | +| AUDIO_SAMPLE_FORMAT_F32 | 32bit位宽浮点型交织样本。 | +| AUDIO_SAMPLE_FORMAT_F32P | 64bit位宽浮点型非交织样本。 | +| AUDIO_SAMPLE_FORMAT_F64 | 64bit位宽双精度浮点型交织样本。 | +| AUDIO_SAMPLE_FORMAT_F64P | 64bit位宽双精度浮点型非交织样本。 | +| AUDIO_SAMPLE_FMT_U8 | 无符号8位整型，打包格式。 | +| AUDIO_SAMPLE_FMT_S16 | 带符号16位整型，打包格式。 | +| AUDIO_SAMPLE_FMT_S32 | 带符号32位整型，打包格式。 | +| AUDIO_SAMPLE_FMT_FLOAT | 浮点型，打包格式。 | +| AUDIO_SAMPLE_FMT_DOUBLE | 双精度浮点型，打包格式。 | +| AUDIO_SAMPLE_FMT_U8P | 无符号8位整型，平面格式。 | +| AUDIO_SAMPLE_FMT_S16P | 带符号16位整型，平面格式。 | +| AUDIO_SAMPLE_FMT_S32P | 带符号32位整型，平面格式。 | +| AUDIO_SAMPLE_FMT_FLOATP | 浮点型，平面格式。 | +| AUDIO_SAMPLE_FMT_DOUBLEP | 双精度浮点型，平面格式。 | +| AUDIO_SAMPLE_FMT_INVALID | 无效采样格式。 | + + +### AudioSampleRate + + +``` +enum AudioSampleRate +``` + +**描述：** + +枚举音频采样率。 + + | 枚举值 | 描述 | +| -------- | -------- | +| AUD_SAMPLE_RATE_8000 | 8K采样率。 | +| AUD_SAMPLE_RATE_12000 | 12K采样率。 | +| AUD_SAMPLE_RATE_11025 | 11.025K采样率。 | +| AUD_SAMPLE_RATE_16000 | 16K采样率。 | +| AUD_SAMPLE_RATE_22050 | 22.050K采样率。 | +| AUD_SAMPLE_RATE_24000 | 24K采样率。 | +| AUD_SAMPLE_RATE_32000 | 32K采样率。 | +| AUD_SAMPLE_RATE_44100 | 44.1K采样率。 | +| AUD_SAMPLE_RATE_48000 | 48K采样率。 | +| AUD_SAMPLE_RATE_64000 | 64K采样率。 | +| AUD_SAMPLE_RATE_96000 | 96K采样率。 | +| AUD_SAMPLE_RATE_INVALID | 无效采样率。 | + + +### AvCodecRole + + +``` +enum AvCodecRole +``` + +**描述：** + +枚举音视频编解码组件类型。 + + | 枚举值 | 描述 | +| -------- | -------- | +| MEDIA_ROLETYPE_IMAGE_JPEG | 图像JPEG媒体类型。 | +| MEDIA_ROLETYPE_VIDEO_AVC | 视频H.264媒体类型。 | +| MEDIA_ROLETYPE_VIDEO_HEVC | 视频H.265媒体类型。 | +| MEDIA_ROLETYPE_AUDIO_FIRST | 音频编解码器类型。 | +| MEDIA_ROLETYPE_AUDIO_AAC | 音频AAC媒体类型。 | +| MEDIA_ROLETYPE_AUDIO_G711A | 音频G711A媒体类型。 | +| MEDIA_ROLETYPE_AUDIO_G711U | 音频G711U媒体类型。 | +| MEDIA_ROLETYPE_AUDIO_G726 | 音频G726媒体类型。 | +| MEDIA_ROLETYPE_AUDIO_PCM | 音频PCM媒体类型。 | +| MEDIA_ROLETYPE_AUDIO_MP3 | 音频MP3媒体类型。 | +| MEDIA_ROLETYPE_INVALID | 无效媒体类型。 | + + +### CodecBufferType + + +``` +enum CodecBufferType +``` + +**描述：** + +定义buffer类型。 + + | 枚举值 | 描述 | +| -------- | -------- | +| CODEC_BUFFER_TYPE_INVALID | 无效buffer类型。 | +| CODEC_BUFFER_TYPE_VIRTUAL_ADDR | 虚拟地址类型。 | +| CODEC_BUFFER_TYPE_AVSHARE_MEM_FD | 共享内存类型。 | +| CODEC_BUFFER_TYPE_HANDLE | handle类型。 | +| CODEC_BUFFER_TYPE_DYNAMIC_HANDLE | 动态handle类型。 | + + +### CodecCapsMask + + +``` +enum CodecCapsMask +``` + +**描述：** + +枚举播放能力。 + + | 枚举值 | 描述 | +| -------- | -------- | +| CODEC_CAP_ADAPTIVE_PLAYBACK | 自适应播放能力。 | +| CODEC_CAP_SECURE_PLAYBACK | 安全播放能力。 | +| CODEC_CAP_TUNNEL_PLAYBACK | 通道播放能力。 | +| CODEC_CAP_MULTI_PLANE | 视频图像平面/音频通道平面能力。 | + + +### CodecProcessMode + + +``` +enum CodecProcessMode +``` + +**描述：** + +枚举编解码处理模式。 + + | 枚举值 | 描述 | +| -------- | -------- | +| PROCESS_BLOCKING_INPUT_BUFFER | 同步模式输入buffer。 | +| PROCESS_BLOCKING_OUTPUT_BUFFER | 同步模式输出buffer。 | +| PROCESS_BLOCKING_CONTROL_FLOW | 同步模式控制流。 | +| PROCESS_NONBLOCKING_INPUT_BUFFER | 异步模式输入buffer。 | +| PROCESS_NONBLOCKING_OUTPUT_BUFFER | 异步模式输出buffer。 | +| PROCESS_NONBLOCKING_CONTROL_FLOW | 异步模式控制流。 | + + +### CodecType + + +``` +enum CodecType +``` + +**描述：** + +枚举编解码的类型。 + + | 枚举值 | 描述 | +| -------- | -------- | +| VIDEO_DECODER | 视频解码类型。 | +| VIDEO_ENCODER | 视频编码类型。 | +| AUDIO_DECODER | 音频解码类型。 | +| AUDIO_ENCODER | 音频编码类型。 | +| INVALID_TYPE | 无效类型。 | + + +### OmxIndexCodecExType + + +``` +enum OmxIndexCodecExType +``` + +**描述：** + +枚举Codec扩展index。 + + | 枚举值 | 描述 | +| -------- | -------- | +| OMX_IndexExtBufferTypeStartUnused | BufferType 扩展index。 | +| OMX_IndexParamSupportBufferType | SupportBuffer类型。 | +| OMX_IndexParamUseBufferType | UseBuffer类型。 | +| OMX_IndexParamGetBufferHandleUsage | GetBufferHandleUsage类型。 | + + +### OmxVideoExType + + +``` +enum OmxVideoExType +``` + +**描述：** + +枚举Codec扩展编码类型。 + + | 枚举值 | 描述 | +| -------- | -------- | +| OMX_VIDEO_CodingHEVC | HEVC编码类型。 | + + +### Profile + + +``` +enum Profile +``` + +**描述：** + +枚举Codec规格。 + + | 枚举值 | 描述 | +| -------- | -------- | +| INVALID_PROFILE | 无效的规格。 | +| AAC_LC_PROFILE | AAC低复杂度规格。 | +| AAC_MAIN_PROFILE | AAC主规格。 | +| AAC_HE_V1_PROFILE | AAC高效率和频带重现规格，又称为HEAAC，AAC+，或者AACPlusV1。 | +| AAC_HE_V2_PROFILE | AAC高效率和频带重现以及变量立体声规格，又称为AAC++或者AACPlusV2。 | +| AAC_LD_PROFILE | AAC低延迟规格。 | +| AAC_ELD_PROFILE | AAC增强型低延迟规格。 | +| AVC_BASELINE_PROFILE | H.264低规格。 | +| AVC_MAIN_PROFILE | H.264主规格。 | +| AVC_HIGH_PROFILE | H.264高规格。 | +| HEVC_MAIN_PROFILE | H.265主规格。 | +| HEVC_MAIN_10_PROFILE | H.265 10比特主规格。 | + + +### ShareMemTypes + + +``` +enum ShareMemTypes +``` + +**描述：** + +枚举共享内存类型。 + + | 枚举值 | 描述 | +| -------- | -------- | +| READ_WRITE_TYPE | 可读可写的共享内存类型。 | +| READ_ONLY_TYPE | 可读的共享内存类型。 | + + +## **函数说明** + + +### CodecCallbackTypeGet() + + +``` +struct CodecCallbackType* CodecCallbackTypeGet (struct HdfRemoteService * remote) +``` + +**描述：** + +实例化CodecCallbackType对象。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| remote | 输入参数，指向HdfRemoteService的指针。 | + +**返回:** + +实例化CodecCallbackType对象。 + + +### CodecCallbackTypeRelease() + + +``` +void CodecCallbackTypeRelease (struct CodecCallbackType * instance) +``` + +**描述：** + +释放CodecCallbackType对象。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| instance | 输入参数，指向CodecCallbackType实例的指针。 | + + +### CodecComponentManagerRelease() + + +``` +void CodecComponentManagerRelease (void ) +``` + +**描述：** + +释放CodecComponentManager对象。 + + +### CodecComponentTypeGet() + + +``` +struct CodecComponentType* CodecComponentTypeGet (struct HdfRemoteService * remote) +``` + +**描述：** + +实例化CodecComponentType对象。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| remote | 输入参数，指向RemoteService的指针。 | + +**返回:** + +实例化的CodecComponentType对象。 + + +### CodecComponentTypeRelease() + + +``` +void CodecComponentTypeRelease (struct CodecComponentType * instance) +``` + +**描述：** + +释放CodecComponentType对象。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| instance | 输入参数，指向CodecComponentType实例的指针。 | + + +### GetCodecComponentManager() + + +``` +struct CodecComponentManager* GetCodecComponentManager (void ) +``` + +**描述：** + +实例化CodecComponentManager对象。 + +**返回:** + +实例化的CodecComponentManager对象。 diff --git a/zh-cn/device-dev/reference/hdi-apis/codec__callback__if_8h.md b/zh-cn/device-dev/reference/hdi-apis/codec__callback__if_8h.md deleted file mode 100644 index 901abda364d0489a74a9b6c5808360a2886eb36b..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/codec__callback__if_8h.md +++ /dev/null @@ -1,41 +0,0 @@ -# codec_callback_if.h - - -## **概述** - -**所属模块:** - -[Codec](_codec.md) - - -## **汇总** - - -### 类 - - | 类 | 描述 | -| -------- | -------- | -| [CodecCallbackType](_codec_callback_type.md) | Codec回调接口定义。 [更多...](_codec_callback_type.md) | - - -### 函数 - - | 函数 | 描述 | -| -------- | -------- | -| [CodecCallbackTypeGet](_codec.md#codeccallbacktypeget) (struct HdfRemoteService \*remote) | 实例化CodecCallbackType对象。 [更多...](_codec.md#codeccallbacktypeget) | -| [CodecCallbackTypeRelease](_codec.md#codeccallbacktyperelease) (struct [CodecCallbackType](_codec_callback_type.md) \*instance) | 释放CodecCallbackType对象。 [更多...](_codec.md#codeccallbacktyperelease) | - - -## **详细描述** - -主要包括回调函数接口定义。 - -Codec模块事件上报、上报输入buffer和输出buffer处理完毕等接口定义。 - -**Since：** - -3.1 - -**Version：** - -2.0 diff --git a/zh-cn/device-dev/reference/hdi-apis/codec__common__type_8h.md b/zh-cn/device-dev/reference/hdi-apis/codec__common__type_8h.md deleted file mode 100644 index 7f573637c2dbff1f5945f81c5dc0bb57550d2999..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/codec__common__type_8h.md +++ /dev/null @@ -1,46 +0,0 @@ -# codec_common_type.h - - -## **概述** - -**所属模块:** - -[Codec](_codec.md) - - -## **汇总** - - -### 类 - - | 类 | 描述 | -| -------- | -------- | -| [Alignment](_alignment.md) | 对齐结构定义，包含宽高的对齐值 [更多...](_alignment.md) | -| [Rect](_rect.md) | 矩形的定义 [更多...](_rect.md) | -| [RangeValue](_range_value.md) | 取值范围的定义 [更多...](_range_value.md) | - - -### 枚举 - - | 枚举 | 描述 | -| -------- | -------- | -| [CodecType](_codec.md#codectype) { VIDEO_DECODER, VIDEO_ENCODER, AUDIO_DECODER, AUDIO_ENCODER,   INVALID_TYPE } | 枚举编解码的类型 [更多...](_codec.md#codectype) | -| [Profile](_codec.md#profile) { INVALID_PROFILE = 0, AAC_LC_PROFILE = 0x1000, AAC_MAIN_PROFILE, AAC_HE_V1_PROFILE,   AAC_HE_V2_PROFILE, AAC_LD_PROFILE, AAC_ELD_PROFILE, AVC_BASELINE_PROFILE = 0x2000,   AVC_MAIN_PROFILE, AVC_HIGH_PROFILE, HEVC_MAIN_PROFILE = 0x3000, HEVC_MAIN_10_PROFILE } | 枚举Codec规格 [更多...](_codec.md#profile) | -| [AudioSampleRate](_codec.md#audiosamplerate) {   AUD_SAMPLE_RATE_8000 = 8000, AUD_SAMPLE_RATE_12000 = 12000, AUD_SAMPLE_RATE_11025 = 11025, AUD_SAMPLE_RATE_16000 = 16000,   AUD_SAMPLE_RATE_22050 = 22050, AUD_SAMPLE_RATE_24000 = 24000, AUD_SAMPLE_RATE_32000 = 32000, AUD_SAMPLE_RATE_44100 = 44100,   AUD_SAMPLE_RATE_48000 = 48000, AUD_SAMPLE_RATE_64000 = 64000, AUD_SAMPLE_RATE_96000 = 96000, AUD_SAMPLE_RATE_INVALID } | 枚举音频采样率 [更多...](_codec.md#audiosamplerate) | -| [CodecCapsMask](_codec.md#codeccapsmask) { CODEC_CAP_ADAPTIVE_PLAYBACK = 0x1, CODEC_CAP_SECURE_PLAYBACK = 0x2, CODEC_CAP_TUNNEL_PLAYBACK = 0x4, CODEC_CAP_MULTI_PLANE = 0x10000 } | 枚举播放能力 [更多...](_codec.md#codeccapsmask) | -| [CodecProcessMode](_codec.md#codecprocessmode) {   PROCESS_BLOCKING_INPUT_BUFFER = 0X1, PROCESS_BLOCKING_OUTPUT_BUFFER = 0X2, PROCESS_BLOCKING_CONTROL_FLOW = 0X4, PROCESS_NONBLOCKING_INPUT_BUFFER = 0X100,   PROCESS_NONBLOCKING_OUTPUT_BUFFER = 0X200, PROCESS_NONBLOCKING_CONTROL_FLOW = 0X400 } | 枚举编解码处理模式 [更多...](_codec.md#codecprocessmode) | - - -## **详细描述** - -Codec模块接口定义中使用的自定义数据类型。 - -Codec模块接口定义中使用的自定义数据类型，包括编解码类型、音视频参数、buffer定义等。 - -**Since：** - -3.1 - -**Version：** - -2.0 diff --git a/zh-cn/device-dev/reference/hdi-apis/codec__component__if_8h.md b/zh-cn/device-dev/reference/hdi-apis/codec__component__if_8h.md deleted file mode 100644 index 4e4587ac518b6a11993f76ff6f599d9d05f76bd8..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/codec__component__if_8h.md +++ /dev/null @@ -1,41 +0,0 @@ -# codec_component_if.h - - -## **概述** - -**所属模块:** - -[Codec](_codec.md) - - -## **汇总** - - -### 类 - - | 类 | 描述 | -| -------- | -------- | -| [CodecComponentType](_codec_component_type.md) | Codec组件接口定义。 [更多...](_codec_component_type.md) | - - -### 函数 - - | 函数 | 描述 | -| -------- | -------- | -| [CodecComponentTypeGet](_codec.md#codeccomponenttypeget) (struct HdfRemoteService \*remote) | 实例化CodecComponentType对象。 [更多...](_codec.md#codeccomponenttypeget) | -| [CodecComponentTypeRelease](_codec.md#codeccomponenttyperelease) (struct [CodecComponentType](_codec_component_type.md) \*instance) | 释放CodecComponentType对象。 [更多...](_codec.md#codeccomponenttyperelease) | - - -## **详细描述** - -主要包括Codec组件接口定义。 - -Codec模块提供了获取组件信息、给组件发送命令、组件参数设置、buffer轮转和控制等接口定义。创建组件后，可使用下列接口进行编解码处理。 - -**Since：** - -3.1 - -**Version：** - -2.0 diff --git a/zh-cn/device-dev/reference/hdi-apis/codec__component__manager_8h.md b/zh-cn/device-dev/reference/hdi-apis/codec__component__manager_8h.md deleted file mode 100644 index 77ea946aef35c4d7d6254e37baee11b398c7b68f..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/codec__component__manager_8h.md +++ /dev/null @@ -1,41 +0,0 @@ -# codec_component_manager.h - - -## **概述** - -**所属模块:** - -[Codec](_codec.md) - - -## **汇总** - - -### 类 - - | 类 | 描述 | -| -------- | -------- | -| [CodecComponentManager](_codec_component_manager.md) | Codec组件管理类接口定义。 [更多...](_codec_component_manager.md) | - - -### 函数 - - | 函数 | 描述 | -| -------- | -------- | -| [GetCodecComponentManager](_codec.md#getcodeccomponentmanager) (void) | 实例化CodecComponentManager对象。 [更多...](_codec.md#getcodeccomponentmanager) | -| [CodecComponentManagerRelease](_codec.md#codeccomponentmanagerrelease) (void) | 释放CodecComponentManager对象。 [更多...](_codec.md#codeccomponentmanagerrelease) | - - -## **详细描述** - -主要包括Codec组件管理类接口。 - -Codec模块获取组件编解码能力集、创建组件和销毁组件等接口定义。 - -**Since：** - -3.1 - -**Version：** - -2.0 diff --git a/zh-cn/device-dev/reference/hdi-apis/codec__component__manager_h.md b/zh-cn/device-dev/reference/hdi-apis/codec__component__manager_h.md new file mode 100644 index 0000000000000000000000000000000000000000..27d7f244b3cdb5e768f53319582e80b79834a3ca --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/codec__component__manager_h.md @@ -0,0 +1,38 @@ +# codec_component_manager.h + + +## **概述** + +主要包括Codec组件管理类接口。 + +Codec模块获取组件编解码能力集、创建组件和销毁组件等接口定义。 + +**Since**: + +3.1 + +**Version**: + +2.0 + +**相关模块:** + +[Codec](codec.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [CodecComponentManager](_codec_component_manager.md) | Codec组件管理类接口定义。 | + + +### 函数 + + | 名称 | 描述 | +| -------- | -------- | +| [GetCodecComponentManager](codec.md#getcodeccomponentmanager) (void) | 实例化CodecComponentManager对象。 | +| [CodecComponentManagerRelease](codec.md#codeccomponentmanagerrelease) (void) | 释放CodecComponentManager对象。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/codec__component__type_8h.md b/zh-cn/device-dev/reference/hdi-apis/codec__component__type_8h.md deleted file mode 100644 index c83e715ec17f67d91ff5dd89e44ffa81c5dbe3a7..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/codec__component__type_8h.md +++ /dev/null @@ -1,68 +0,0 @@ -# codec_component_type.h - - -## **概述** - -**所属模块:** - -[Codec](_codec.md) - - -## **汇总** - - -### 类 - - | 类 | 描述 | -| -------- | -------- | -| [VideoPortCap](_video_port_cap.md) | 定义视频编解码能力 [更多...](_video_port_cap.md) | -| [AudioPortCap](_audio_port_cap.md) | 定义音频编解码能力 [更多...](_audio_port_cap.md) | -| [PortCap](union_port_cap.md) | 定义音视频编解码能力 [更多...](union_port_cap.md) | -| [CodecCompCapability](_codec_comp_capability.md) | 定义Codec编解码能力 [更多...](_codec_comp_capability.md) | -| [OmxCodecBuffer](_omx_codec_buffer.md) | Codec buffer信息的定义 [更多...](_omx_codec_buffer.md) | -| [CompVerInfo](_comp_ver_info.md) | 定义组件版本信息 [更多...](_comp_ver_info.md) | -| [EventInfo](_event_info.md) | 定义事件上报信息 [更多...](_event_info.md) | -| [SupportBufferType](_support_buffer_type.md) | SupportBuffer类型定义. [更多...](_support_buffer_type.md) | -| [UseBufferType](_use_buffer_type.md) | UseBuffer类型定义 [更多...](_use_buffer_type.md) | -| [GetBufferHandleUsageParams](_get_buffer_handle_usage_params.md) | BufferHandleUsage类型定义 [更多...](_get_buffer_handle_usage_params.md) | - - -### 宏定义 - - | 宏定义 | 描述 | -| -------- | -------- | -| [SAMPLE_FMT_NUM](_codec.md#ga9bda75c363e9bcff915cdd521dd7ba84)   32 | 采样格式最大值 | -| [UUID_LENGTH](_codec.md#ga9226162b034cc837cd977f0fcf611c2c)   128 | 定义UUID长度 | -| [PIX_FORMAT_NUM](_codec.md#gadb8c6478388b68c09835ebe093a8920a)   16 | 支持的像素格式数组大小 | -| [SAMPLE_FORMAT_NUM](_codec.md#gaf958b9cc535f6260e2e8b7ce42c89946)   12 | 支持的音频采样格式数组大小 | -| [SAMPLE_RATE_NUM](_codec.md#ga0d905eaa05b4b6fcec76924eb795d7fe)   16 | 支持的音频采样率数组大小 | -| [CHANNEL_NUM](_codec.md#ga6511732d5b29a6781cf38783157f21e1)   16 | 支持的音频通道数组大小 | -| [NAME_LENGTH](_codec.md#gaf71324c57f05ff9e24bd384925dd6b17)   32 | 组件名称大小 | -| [PROFILE_NUM](_codec.md#gaab6353cb3662bdc672ae8ab90df529ce)   256 | 支持的profile数组大小 | - - -### 枚举 - - | 枚举 | 描述 | -| -------- | -------- | -| [AvCodecRole](_codec.md#avcodecrole) { MEDIA_ROLETYPE_IMAGE_JPEG = 0, MEDIA_ROLETYPE_VIDEO_AVC, MEDIA_ROLETYPE_VIDEO_HEVC, MEDIA_ROLETYPE_AUDIO_FIRST = 0x10000,   MEDIA_ROLETYPE_AUDIO_AAC = 0x10000, MEDIA_ROLETYPE_AUDIO_G711A, MEDIA_ROLETYPE_AUDIO_G711U, MEDIA_ROLETYPE_AUDIO_G726,   MEDIA_ROLETYPE_AUDIO_PCM, MEDIA_ROLETYPE_AUDIO_MP3, MEDIA_ROLETYPE_INVALID } | 枚举音视频编解码组件类型 [更多...](_codec.md#avcodecrole) | -| [AudioSampleFormat](_codec.md#audiosampleformat) { AUDIO_SAMPLE_FORMAT_S8, AUDIO_SAMPLE_FORMAT_S8P, AUDIO_SAMPLE_FORMAT_U8, AUDIO_SAMPLE_FORMAT_U8P,   AUDIO_SAMPLE_FORMAT_S16, AUDIO_SAMPLE_FORMAT_S16P, AUDIO_SAMPLE_FORMAT_U16, AUDIO_SAMPLE_FORMAT_U16P,   AUDIO_SAMPLE_FORMAT_S24, AUDIO_SAMPLE_FORMAT_S24P, AUDIO_SAMPLE_FORMAT_U24, AUDIO_SAMPLE_FORMAT_U24P,   AUDIO_SAMPLE_FORMAT_S32, AUDIO_SAMPLE_FORMAT_S32P, AUDIO_SAMPLE_FORMAT_U32, AUDIO_SAMPLE_FORMAT_U32P,   AUDIO_SAMPLE_FORMAT_S64, AUDIO_SAMPLE_FORMAT_S64P, AUDIO_SAMPLE_FORMAT_U64, AUDIO_SAMPLE_FORMAT_U64P,   AUDIO_SAMPLE_FORMAT_F32, AUDIO_SAMPLE_FORMAT_F32P, AUDIO_SAMPLE_FORMAT_F64, AUDIO_SAMPLE_FORMAT_F64P,   AUDIO_SAMPLE_FMT_U8, AUDIO_SAMPLE_FMT_S16, AUDIO_SAMPLE_FMT_S32, AUDIO_SAMPLE_FMT_FLOAT,   AUDIO_SAMPLE_FMT_DOUBLE, AUDIO_SAMPLE_FMT_U8P, AUDIO_SAMPLE_FMT_S16P, AUDIO_SAMPLE_FMT_S32P,   AUDIO_SAMPLE_FMT_FLOATP, AUDIO_SAMPLE_FMT_DOUBLEP, AUDIO_SAMPLE_FMT_INVALID } | 枚举音频采样格式 [更多...](_codec.md#audiosampleformat) | -| [CodecBufferType](_codec.md#codecbuffertype) { CODEC_BUFFER_TYPE_INVALID = 0, CODEC_BUFFER_TYPE_VIRTUAL_ADDR = 0x1, CODEC_BUFFER_TYPE_AVSHARE_MEM_FD = 0x2, CODEC_BUFFER_TYPE_HANDLE = 0x4,   CODEC_BUFFER_TYPE_DYNAMIC_HANDLE = 0x8 } | 定义buffer类型 [更多...](_codec.md#codecbuffertype) | -| [ShareMemTypes](_codec.md#sharememtypes) { READ_WRITE_TYPE = 0x1, READ_ONLY_TYPE = 0x2 } | 枚举共享内存类型 [更多...](_codec.md#sharememtypes) | -| [OmxIndexCodecExType](_codec.md#omxindexcodecextype) { OMX_IndexExtBufferTypeStartUnused = OMX_IndexKhronosExtensions + 0x00a00000, OMX_IndexParamSupportBufferType, OMX_IndexParamUseBufferType, OMX_IndexParamGetBufferHandleUsage } | 枚举Codec扩展index [更多...](_codec.md#omxindexcodecextype) | -| [OmxVideoExType](_codec.md#omxvideoextype) { OMX_VIDEO_CodingHEVC = 11 } | 枚举Codec扩展编码类型 [更多...](_codec.md#omxvideoextype) | - - -## **详细描述** - -Codec模块接口定义中使用的自定义数据类型。 - -Codec模块接口定义中使用的自定义数据类型，包括编解码类型、音视频参数、buffer定义等。 - -**Since：** - -3.1 - -**Version：** - -2.0 diff --git a/zh-cn/device-dev/reference/hdi-apis/codec__component__type_h.md b/zh-cn/device-dev/reference/hdi-apis/codec__component__type_h.md new file mode 100644 index 0000000000000000000000000000000000000000..24ff738d1d110f1f43d604a75cf4b9e6840ededb --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/codec__component__type_h.md @@ -0,0 +1,65 @@ +# codec_component_type.h + + +## **概述** + +Codec模块接口定义中使用的自定义数据类型。 + +Codec模块接口定义中使用的自定义数据类型，包括编解码类型、音视频参数、buffer定义等。 + +**Since**: + +3.1 + +**Version**: + +2.0 + +**相关模块:** + +[Codec](codec.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [VideoPortCap](_video_port_cap.md) | 定义视频编解码能力。 | +| [AudioPortCap](audio_portcap.md) | 定义音频编解码能力。 | +| [PortCap](union_port_cap.md) | 定义音视频编解码能力。 | +| [CodecCompCapability](_codec_comp_capability.md) | 定义Codec编解码能力。 | +| [OmxCodecBuffer](_omx_codec_buffer.md) | Codec buffer信息的定义。 | +| [CompVerInfo](_comp_ver_info.md) | 定义组件版本信息。 | +| [EventInfo](_event_info.md) | 定义事件上报信息。 | +| [SupportBufferType](_support_buffer_type.md) | SupportBuffer类型定义。 | +| [UseBufferType](_use_buffer_type.md) | UseBuffer类型定义。 | +| [GetBufferHandleUsageParams](_get_buffer_handle_usage_params.md) | BufferHandleUsage类型定义。 | + + +### 宏定义 + + | 名称 | 描述 | +| -------- | -------- | +| [SAMPLE_FMT_NUM](codec.md#ga9bda75c363e9bcff915cdd521dd7ba84)   32 | 采样格式最大值。 | +| [UUID_LENGTH](codec.md#ga9226162b034cc837cd977f0fcf611c2c)   128 | 定义UUID长度。 | +| [PIX_FORMAT_NUM](codec.md#gadb8c6478388b68c09835ebe093a8920a)   16 | 支持的像素格式数组大小。 | +| [SAMPLE_FORMAT_NUM](codec.md#gaf958b9cc535f6260e2e8b7ce42c89946)   12 | 支持的音频采样格式数组大小。 | +| [SAMPLE_RATE_NUM](codec.md#ga0d905eaa05b4b6fcec76924eb795d7fe)   16 | 支持的音频采样率数组大小。 | +| [CHANNEL_NUM](codec.md#ga6511732d5b29a6781cf38783157f21e1)   16 | 支持的音频通道数组大小。 | +| [NAME_LENGTH](codec.md#gaf71324c57f05ff9e24bd384925dd6b17)   32 | 组件名称大小。 | +| [PROFILE_NUM](codec.md#gaab6353cb3662bdc672ae8ab90df529ce)   256 | 支持的profile数组大小。 | + + +### 枚举 + + | 名称 | 描述 | +| -------- | -------- | +| [AvCodecRole](codec.md#avcodecrole) { MEDIA_ROLETYPE_IMAGE_JPEG = 0, MEDIA_ROLETYPE_VIDEO_AVC, MEDIA_ROLETYPE_VIDEO_HEVC, MEDIA_ROLETYPE_AUDIO_FIRST = 0x10000,   MEDIA_ROLETYPE_AUDIO_AAC = 0x10000, MEDIA_ROLETYPE_AUDIO_G711A, MEDIA_ROLETYPE_AUDIO_G711U, MEDIA_ROLETYPE_AUDIO_G726,   MEDIA_ROLETYPE_AUDIO_PCM, MEDIA_ROLETYPE_AUDIO_MP3, MEDIA_ROLETYPE_INVALID } | 枚举音视频编解码组件类型。 | +| [AudioSampleFormat](codec.md#audiosampleformat) { AUDIO_SAMPLE_FORMAT_S8 = 0, AUDIO_SAMPLE_FORMAT_S8P = 1, AUDIO_SAMPLE_FORMAT_U8 = 2, AUDIO_SAMPLE_FORMAT_U8P = 3,   AUDIO_SAMPLE_FORMAT_S16 = 4, AUDIO_SAMPLE_FORMAT_S16P = 5, AUDIO_SAMPLE_FORMAT_U16 = 6, AUDIO_SAMPLE_FORMAT_U16P = 7,   AUDIO_SAMPLE_FORMAT_S24 = 8, AUDIO_SAMPLE_FORMAT_S24P = 9, AUDIO_SAMPLE_FORMAT_U24 = 10, AUDIO_SAMPLE_FORMAT_U24P = 11,   AUDIO_SAMPLE_FORMAT_S32 = 12, AUDIO_SAMPLE_FORMAT_S32P = 13, AUDIO_SAMPLE_FORMAT_U32 = 14, AUDIO_SAMPLE_FORMAT_U32P = 15,   AUDIO_SAMPLE_FORMAT_S64 = 16, AUDIO_SAMPLE_FORMAT_S64P = 17, AUDIO_SAMPLE_FORMAT_U64 = 18, AUDIO_SAMPLE_FORMAT_U64P = 19,   AUDIO_SAMPLE_FORMAT_F32 = 20, AUDIO_SAMPLE_FORMAT_F32P = 21, AUDIO_SAMPLE_FORMAT_F64 = 22, AUDIO_SAMPLE_FORMAT_F64P = 23,   AUDIO_SAMPLE_FMT_U8, AUDIO_SAMPLE_FMT_S16, AUDIO_SAMPLE_FMT_S32, AUDIO_SAMPLE_FMT_FLOAT,   AUDIO_SAMPLE_FMT_DOUBLE, AUDIO_SAMPLE_FMT_U8P, AUDIO_SAMPLE_FMT_S16P, AUDIO_SAMPLE_FMT_S32P,   AUDIO_SAMPLE_FMT_FLOATP, AUDIO_SAMPLE_FMT_DOUBLEP, AUDIO_SAMPLE_FMT_INVALID } | 枚举音频采样格式。 | +| [CodecBufferType](codec.md#codecbuffertype) { CODEC_BUFFER_TYPE_INVALID = 0, CODEC_BUFFER_TYPE_VIRTUAL_ADDR = 0x1, CODEC_BUFFER_TYPE_AVSHARE_MEM_FD = 0x2, CODEC_BUFFER_TYPE_HANDLE = 0x4,   CODEC_BUFFER_TYPE_DYNAMIC_HANDLE = 0x8 } | 定义buffer类型。 | +| [ShareMemTypes](codec.md#sharememtypes) { READ_WRITE_TYPE = 0x1, READ_ONLY_TYPE = 0x2 } | 枚举共享内存类型。 | +| [OmxIndexCodecExType](codec.md#omxindexcodecextype) { OMX_IndexExtBufferTypeStartUnused = OMX_IndexKhronosExtensions + 0x00a00000, OMX_IndexParamSupportBufferType, OMX_IndexParamUseBufferType, OMX_IndexParamGetBufferHandleUsage } | 枚举Codec扩展index。 | +| [OmxVideoExType](codec.md#omxvideoextype) { OMX_VIDEO_CodingHEVC = 11 } | 枚举Codec扩展编码类型。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/codec_callback_if_h.md b/zh-cn/device-dev/reference/hdi-apis/codec_callback_if_h.md new file mode 100644 index 0000000000000000000000000000000000000000..a7939a857bd0ce8d162e7d3a326ac0b60d73d2f7 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/codec_callback_if_h.md @@ -0,0 +1,38 @@ +# codec_callback_if.h + + +## **概述** + +主要包括回调函数接口定义。 + +Codec模块事件上报、上报输入buffer和输出buffer处理完毕等接口定义。 + +**Since**: + +3.1 + +**Version**: + +2.0 + +**相关模块:** + +[Codec](codec.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [CodecCallbackType](_codec_callback_type.md) | Codec回调接口定义。 | + + +### 函数 + + | 名称 | 描述 | +| -------- | -------- | +| [CodecCallbackTypeGet](codec.md#codeccallbacktypeget) (struct HdfRemoteService \*remote) | 实例化CodecCallbackType对象。 | +| [CodecCallbackTypeRelease](codec.md#codeccallbacktyperelease) (struct [CodecCallbackType](_codec_callback_type.md) \*instance) | 释放CodecCallbackType对象。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/codec_common_type_h.md b/zh-cn/device-dev/reference/hdi-apis/codec_common_type_h.md new file mode 100644 index 0000000000000000000000000000000000000000..e603fbceb5d28d40eaee42bc5607b1f7cd6bd0fc --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/codec_common_type_h.md @@ -0,0 +1,41 @@ +# codec_common_type.h + + +## **概述** + +Codec模块接口定义中使用的自定义数据类型，包括编解码类型、音视频参数、buffer定义等。 + +**Since**: + +3.1 + +**Version**: + +2.0 + +**相关模块:** + +[Codec](codec.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [Alignment](_alignment.md) | 对齐结构定义，包含宽高的对齐值。 | +| [Rect](_rect.md) | 矩形的定义。 | +| [RangeValue](_range_value.md) | 取值范围的定义。 | + + +### 枚举 + + | 名称 | 描述 | +| -------- | -------- | +| [CodecType](codec.md#codectype) { VIDEO_DECODER, VIDEO_ENCODER, AUDIO_DECODER, AUDIO_ENCODER,   INVALID_TYPE  } | 枚举编解码的类型。 | +| [Profile](codec.md#profile) { INVALID_PROFILE = 0, AAC_LC_PROFILE = 0x1000, AAC_MAIN_PROFILE, AAC_HE_V1_PROFILE,   AAC_HE_V2_PROFILE, AAC_LD_PROFILE, AAC_ELD_PROFILE, AVC_BASELINE_PROFILE = 0x2000,   AVC_MAIN_PROFILE, AVC_HIGH_PROFILE, HEVC_MAIN_PROFILE = 0x3000, HEVC_MAIN_10_PROFILE } | 枚举Codec规格。 | +| [AudioSampleRate](codec.md#audiosamplerate) { AUD_SAMPLE_RATE_8000 = 8000, AUD_SAMPLE_RATE_12000 = 12000, AUD_SAMPLE_RATE_11025 = 11025, AUD_SAMPLE_RATE_16000 = 16000,   AUD_SAMPLE_RATE_22050 = 22050, AUD_SAMPLE_RATE_24000 = 24000, AUD_SAMPLE_RATE_32000 = 32000, AUD_SAMPLE_RATE_44100 = 44100,   AUD_SAMPLE_RATE_48000 = 48000, AUD_SAMPLE_RATE_64000 = 64000, AUD_SAMPLE_RATE_96000 = 96000, AUD_SAMPLE_RATE_INVALID } | 枚举音频采样率。 | +| [CodecCapsMask](codec.md#codeccapsmask) { CODEC_CAP_ADAPTIVE_PLAYBACK = 0x1, CODEC_CAP_SECURE_PLAYBACK = 0x2, CODEC_CAP_TUNNEL_PLAYBACK = 0x4, CODEC_CAP_MULTI_PLANE = 0x10000 } | 枚举播放能力。 | +| [CodecProcessMode](codec.md#codecprocessmode) { PROCESS_BLOCKING_INPUT_BUFFER = 0X1, PROCESS_BLOCKING_OUTPUT_BUFFER = 0X2, PROCESS_BLOCKING_CONTROL_FLOW = 0X4, PROCESS_NONBLOCKING_INPUT_BUFFER = 0X100,   PROCESS_NONBLOCKING_OUTPUT_BUFFER = 0X200, PROCESS_NONBLOCKING_CONTROL_FLOW = 0X400 } | 枚举编解码处理模式。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/codec_component_if_h.md b/zh-cn/device-dev/reference/hdi-apis/codec_component_if_h.md new file mode 100644 index 0000000000000000000000000000000000000000..9be7901fd0dd367ba09dc8983ec89b0aab9408d4 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/codec_component_if_h.md @@ -0,0 +1,38 @@ +# codec_component_if.h + + +## **概述** + +主要包括Codec组件接口定义。 + +Codec模块提供了获取组件信息、给组件发送命令、组件参数设置、buffer轮转和控制等接口定义。创建组件后，可使用下列接口进行编解码处理。 + +**Since**: + +3.1 + +**Version**: + +2.0 + +**相关模块:** + +[Codec](codec.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [CodecComponentType](_codec_component_type.md) | Codec组件接口定义。 | + + +### 函数 + + | 名称 | 描述 | +| -------- | -------- | +| [CodecComponentTypeGet](codec.md#codeccomponenttypeget) (struct HdfRemoteService \*remote) | 实例化CodecComponentType对象。 | +| [CodecComponentTypeRelease](codec.md#codeccomponenttyperelease) (struct [CodecComponentType](_codec_component_type.md) \*instance) | 释放CodecComponentType对象。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/display__device_8h.md b/zh-cn/device-dev/reference/hdi-apis/display__device_8h.md index 7d8bb2f45071341bc1b4ab3536019f659b723353..d4dbfccb78d814df1741d41ff282bd9f83109253 100644 --- a/zh-cn/device-dev/reference/hdi-apis/display__device_8h.md +++ b/zh-cn/device-dev/reference/hdi-apis/display__device_8h.md @@ -3,7 +3,17 @@ ## **概述** -**所属模块:** +显示设备控制接口声明。 + +**Since:** + +1.0 + +**Version:** + +2.0 + +**相关模块:** [Display](_display.md) @@ -13,36 +23,23 @@ ### 类 - | 类 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [DeviceFuncs](_device_funcs.md) | 显示设备控制接口结构体，定义显示设备控制接口函数指针。 [更多...](_device_funcs.md) | +| [DeviceFuncs](_device_funcs.md) | 显示设备控制接口结构体，定义显示设备控制接口函数指针。 | ### 类型定义 - | 类型定义 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| ([HotPlugCallback](_display.md#hotplugcallback)) (uint32_t devId, bool connected, void \*data) | 热插拔事件回调。[更多...](_display.md#hotplugcallback) | -| ([VBlankCallback](_display.md#vblankcallback)) (unsigned int sequence, uint64_t ns, void \*data) | VBlank 事件回调。 [更多...](_display.md#vblankcallback) | -| ([RefreshCallback](_display.md#refreshcallback)) (uint32_t devId, void \*data) | 刷新请求回调。[更多...](_display.md#refreshcallback) | +| ([HotPlugCallback](_display.md#hotplugcallback)) (uint32_t devId, bool connected, void \*data) | 热插拔事件回调 | +| ([VBlankCallback](_display.md#vblankcallback)) (unsigned int sequence, uint64_t ns, void \*data) | VBlank 事件回调。 | +| ([RefreshCallback](_display.md#refreshcallback)) (uint32_t devId, void \*data) | 刷新请求回调 | ### 函数 - | 函数 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [DeviceInitialize](_display.md#deviceinitialize) ([DeviceFuncs](_device_funcs.md) \*\*funcs) | 实现显示设备控制接口的初始化，申请操作显示设备控制接口的资源，并获取对应的操作接口。 [更多...](_display.md#deviceinitialize) | -| [DeviceUninitialize](_display.md#deviceuninitialize) ([DeviceFuncs](_device_funcs.md) \*funcs) | 取消显示设备控制接口的初始化，释放控制接口使用到的资源。 [更多...](_display.md#deviceuninitialize) | - - -## **详细描述** - -显示设备控制接口声明。 - -**Since：** - -1.0 - -**Version：** - -2.0 +| [DeviceInitialize](_display.md#deviceinitialize)(DeviceFuncs \*\*funcs) | 实现显示设备控制接口的初始化，申请操作显示设备控制接口的资源，并获取对应的操作接口。 | +| [DeviceUninitialize](_display.md#deviceuninitialize)(DeviceFuncs \*funcs) | 取消显示设备控制接口的初始化，释放控制接口使用到的资源。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/display__gfx_8h.md b/zh-cn/device-dev/reference/hdi-apis/display__gfx_8h.md index 10cc061b8db3075f786370c338472ba45f72102c..e26796cb53997141fd676af7ccd1051d8ba66784 100644 --- a/zh-cn/device-dev/reference/hdi-apis/display__gfx_8h.md +++ b/zh-cn/device-dev/reference/hdi-apis/display__gfx_8h.md @@ -3,7 +3,17 @@ ## **概述** -**所属模块:** +显示硬件加速驱动接口声明。 + +**Since:** + +1.0 + +**Version:** + +1.0 + +**相关模块:** [Display](_display.md) @@ -13,27 +23,14 @@ ### 类 - | 类 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [GfxFuncs](_gfx_funcs.md) | 显示硬件加速驱动接口结构体，定义硬件加速驱动接口函数指针。 [更多...](_gfx_funcs.md) | +| [GfxFuncs](_gfx_funcs.md) | 显示硬件加速驱动接口结构体，定义硬件加速驱动接口函数指针。 | ### 函数 - | 函数 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [GfxInitialize](_display.md#gfxinitialize) ([GfxFuncs](_gfx_funcs.md) \*\*funcs) | 获取硬件加速相关的操作接口指针。 [更多...](_display.md#gfxinitialize) | -| [GfxUninitialize](_display.md#gfxuninitialize) ([GfxFuncs](_gfx_funcs.md) \*funcs) | 释放硬件加速相关的操作接口指针。 [更多...](_display.md#gfxuninitialize) | - - -## **详细描述** - -显示硬件加速驱动接口声明。 - -**Since：** - -1.0 - -**Version：** - -1.0 +| [GfxInitialize](_display.md#gfxinitialize)(GfxFuncs \*\*funcs) | 获取硬件加速相关的操作接口指针。 | +| [GfxUninitialize](_display.md#gfxuninitialize)(GfxFuncs \*funcs) | 释放硬件加速相关的操作接口指针。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/display__gralloc_8h.md b/zh-cn/device-dev/reference/hdi-apis/display__gralloc_8h.md index e75c7d78987dd301d0011d5afe4990a67e05db5d..5b6ae08c24a3de8b4602cb6c78666012066a656d 100644 --- a/zh-cn/device-dev/reference/hdi-apis/display__gralloc_8h.md +++ b/zh-cn/device-dev/reference/hdi-apis/display__gralloc_8h.md @@ -3,7 +3,17 @@ ## **概述** -**所属模块:** +显示内存驱动接口声明。 + +**Since:** + +1.0 + +**Version:** + +2.0 + +**相关模块:** [Display](_display.md) @@ -13,27 +23,14 @@ ### 类 - | 类 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [GrallocFuncs](_gralloc_funcs.md) | 显示内存驱动接口结构体，定义显示内存驱动接口函数指针。 [更多...](_gralloc_funcs.md) | +| [GrallocFuncs](_gralloc_funcs.md) | 显示内存驱动接口结构体，定义显示内存驱动接口函数指针。 | ### 函数 - | 函数 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [GrallocInitialize](_display.md#grallocinitialize) ([GrallocFuncs](_gralloc_funcs.md) \*\*funcs) | 初始化内存模块，并获取内存提供的操作接口。 [更多...](_display.md#grallocinitialize) | -| [GrallocUninitialize](_display.md#grallocuninitialize) ([GrallocFuncs](_gralloc_funcs.md) \*funcs) | 取消初始化内存模块，并释放内存操作接口指针。 [更多...](_display.md#grallocuninitialize) | - - -## **详细描述** - -显示内存驱动接口声明。 - -**Since：** - -1.0 - -**Version：** - -2.0 +| [GrallocInitialize](_display.md#grallocinitialize)(GrallocFuncs \*\*funcs) | 初始化内存模块，并获取内存提供的操作接口。 | +| [GrallocUninitialize](_display.md#grallocuninitialize)(GrallocFuncs \*funcs) | 取消初始化内存模块，并释放内存操作接口指针。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/display__layer_8h.md b/zh-cn/device-dev/reference/hdi-apis/display__layer_8h.md index 6075edc6e52f07cd9762c2b0211ed9730a9df171..4924bc32fa02d6b8140a8bd09a1f12f498d489ce 100644 --- a/zh-cn/device-dev/reference/hdi-apis/display__layer_8h.md +++ b/zh-cn/device-dev/reference/hdi-apis/display__layer_8h.md @@ -3,7 +3,17 @@ ## **概述** -**所属模块:** +显示图层驱动接口声明。 + +**Since:** + +1.0 + +**Version:** + +2.0 + +**相关模块:** [Display](_display.md) @@ -13,27 +23,14 @@ ### 类 - | 类 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [LayerFuncs](_layer_funcs.md) | 显示图层驱动接口结构体，定义显示图层驱动接口函数指针。 [更多...](_layer_funcs.md) | +| [LayerFuncs](_layer_funcs.md) | 显示图层驱动接口结构体，定义显示图层驱动接口函数指针。 | ### 函数 - | 函数 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [LayerInitialize](_display.md#layerinitialize) ([LayerFuncs](_layer_funcs.md) \*\*funcs) | 实现图层初始化功能，申请图层使用的资源，并获取图层提供的操作接口。 [更多...](_display.md#layerinitialize) | -| [LayerUninitialize](_display.md#layeruninitialize) ([LayerFuncs](_layer_funcs.md) \*funcs) | 取消图层初始化功能，释放图层使用到的资源，并释放图层操作接口指针。 [更多...](_display.md#layeruninitialize) | - - -## **详细描述** - -显示图层驱动接口声明。 - -**Since：** - -1.0 - -**Version：** - -2.0 +| [LayerInitialize](_display.md#layerinitialize)(LayerFuncs \*\*funcs) | 实现图层初始化功能，申请图层使用的资源，并获取图层提供的操作接口。 | +| [LayerUninitialize](_display.md#layeruninitialize)(LayerFuncs \*funcs) | 取消图层初始化功能，释放图层使用到的资源，并释放图层操作接口指针。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/display__type_8h.md b/zh-cn/device-dev/reference/hdi-apis/display__type_8h.md index 8bccecc8f04c9d708a3212174c9213192c8c6a6f..bfb64ef5202af14af0ea969ce208b19a2d6e0348 100644 --- a/zh-cn/device-dev/reference/hdi-apis/display__type_8h.md +++ b/zh-cn/device-dev/reference/hdi-apis/display__type_8h.md @@ -3,7 +3,17 @@ ## **概述** -**所属模块:** +显示类型定义，定义显示驱动接口所使用的数据类型。 + +**Since:** + +1.0 + +**Version:** + +2.0 + +**相关模块:** [Display](_display.md) @@ -13,70 +23,58 @@ ### 类 - | 类 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [DisplayInfo](_display_info.md) | 定义显示信息结构体 [更多...](_display_info.md) | -| [LayerInfo](_layer_info.md) | 定义图层信息结构体 [更多...](_layer_info.md) | -| [LayerAlpha](_layer_alpha.md) | 定义图层Alpha信息的结构体 [更多...](_layer_alpha.md) | -| [BufferData](_buffer_data.md) | 定义一层的缓冲区数据，包括虚拟和物理内存地址。 [更多...](_buffer_data.md) | -| [LayerBuffer](_layer_buffer.md) | 图层Buffer，用于存放图层数据。 [更多...](_layer_buffer.md) | -| [IRect](_i_rect.md) | 定义矩形信息 [更多...](_i_rect.md) | -| [ISurface](_i_surface.md) | 用于存放窗口相关信息的结构体定义，提供给硬件加速使用，例如图像合成，位图搬移等操作。 [更多...](_i_surface.md) | -| [ILine](_i_line.md) | 线条描述结构体定义，用于硬件加速绘制直线。 [更多...](_i_line.md) | -| [ICircle](_i_circle.md) | 圆形描述结构体定义，用于硬件加速绘制圆形。 [更多...](_i_circle.md) | -| [Rectangle](_rectangle.md) | 矩形描述结构体定义，用于硬件加速绘制矩形， [更多...](_rectangle.md) | -| [GfxOpt](_gfx_opt.md) | 图像硬件加速相关的操作选项结构体定义，用于图像硬件加速时的操作选项。 [更多...](_gfx_opt.md) | -| [PropertyObject](_property_object.md) | 定义包含名称、属性ID和值的属性对象。 [更多...](_property_object.md) | -| [DisplayCapability](_display_capability.md) | 定义输出性能。 [更多...](_display_capability.md) | -| [DisplayModeInfo](_display_mode_info.md) | 定义输出模式信息。 [更多...](_display_mode_info.md) | -| [AllocInfo](_alloc_info.md) | 定义关于要分配的内存的信息。 [更多...](_alloc_info.md) | -| [HDRCapability](_h_d_r_capability.md) | HDR属性结构体定义 [更多...](_h_d_r_capability.md) | -| [HDRMetaData](_h_d_r_meta_data.md) | HDR元数据结构体定义 [更多...](_h_d_r_meta_data.md) | -| [VerifyAllocInfo](_verify_alloc_info.md) | 用于验证内存分配信息的结构体定义 [更多...](_verify_alloc_info.md) | -| [PresentTimestamp](_present_timestamp.md) | 上屏时间戳结构体定义 [更多...](_present_timestamp.md) | -| [__attribute__](____attribute____.md) | 扩展数据句柄结构体定义 [更多...](____attribute____.md) | +| [DisplayInfo](_display_info.md) | 定义显示信息结构体。 | +| [LayerInfo](_layer_info.md) | 定义图层信息结构体。 | +| [LayerAlpha](_layer_alpha.md) | 定义图层Alpha信息的结构体。 | +| [BufferData](_buffer_data.md) | 定义一层的缓冲区数据，包括虚拟和物理内存地址。 | +| [LayerBuffer](_layer_buffer.md) | 图层Buffer，用于存放图层数据。 | +| [IRect](_i_rect.md) | 定义矩形信息。 | +| [ISurface](_i_surface.md) | 用于存放窗口相关信息的结构体定义，提供给硬件加速使用，例如图像合成，位图搬移等操作。 | +| [ILine](_i_line.md) | 线条描述结构体定义，用于硬件加速绘制直线。 | +| [ICircle](_i_circle.md) | 圆形描述结构体定义，用于硬件加速绘制圆形。 | +| [Rectangle](_rectangle.md) | 矩形描述结构体定义，用于硬件加速绘制矩形。 | +| [GfxOpt](_gfx_opt.md) | 图像硬件加速相关的操作选项结构体定义，用于图像硬件加速时的操作选项。 | +| [PropertyObject](_property_object.md) | 定义包含名称、属性ID和值的属性对象。 | +| [DisplayCapability](_display_capability.md) | 定义输出性能。 | +| [DisplayModeInfo](_display_mode_info.md) | 定义输出模式信息。 | +| [AllocInfo](_alloc_info.md) | 定义关于要分配的内存的信息。 | +| [HDRCapability](_h_d_r_capability.md) | HDR属性结构体定义。 | +| [HDRMetaData](_h_d_r_meta_data.md) | HDR元数据结构体定义。 | +| [VerifyAllocInfo](_verify_alloc_info.md) | 用于验证内存分配信息的结构体定义。 | +| [PresentTimestamp](_present_timestamp.md) | 上屏时间戳结构体定义。 | +| [ExtDataHandle](_ext_data_handle.md) | 扩展数据句柄结构体定义。 | +| [YUVDescInfo](_yun_desc_info_.md) | YUV描述信息结构体定义。 | ### 宏定义 - | 宏定义 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| **PROPERTY_NAME_LEN**   50 | 属性名称长度 | +| [PROPERTY_NAME_LEN](_display.md#propertynamelen)   50 | 属性名字长度。 | ### 枚举 - | 枚举 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [DispErrCode](_display.md#disperrcode) { DISPLAY_SUCCESS = 0, DISPLAY_FAILURE = -1, DISPLAY_FD_ERR = -2, DISPLAY_PARAM_ERR = -3,   DISPLAY_NULL_PTR = -4, DISPLAY_NOT_SUPPORT = -5, DISPLAY_NOMEM = -6, DISPLAY_SYS_BUSY = -7,   DISPLAY_NOT_PERM = -8 } | 返回值类型定义。 [更多...](_display.md#disperrcode) | -| [LayerType](_display.md#layertype) { LAYER_TYPE_GRAPHIC, LAYER_TYPE_OVERLAY, LAYER_TYPE_SIDEBAND, LAYER_TYPE_CURSOR,   LAYER_TYPE_BUTT } | 图层类型定义。 [更多...](_display.md#layertype) | -| { HBM_USE_CPU_READ = (1 << 0), HBM_USE_CPU_WRITE = (1 << 1), HBM_USE_MEM_MMZ = (1 << 2), HBM_USE_MEM_DMA = (1 << 3),   HBM_USE_MEM_SHARE = (1 << 4), HBM_USE_MEM_MMZ_CACHE = (1 << 5), HBM_USE_MEM_FB = (1 << 6), HBM_USE_ASSIGN_SIZE = (1 << 7) } |缓冲区定义。[更多...](_display.md#anonymous-enum) | -| [PixelFormat](_display.md#pixelformat) { PIXEL_FMT_CLUT8 = 0, PIXEL_FMT_CLUT1, PIXEL_FMT_CLUT4, PIXEL_FMT_RGB_565,   PIXEL_FMT_RGBA_5658, PIXEL_FMT_RGBX_4444, PIXEL_FMT_RGBA_4444, PIXEL_FMT_RGB_444,   PIXEL_FMT_RGBX_5551, PIXEL_FMT_RGBA_5551, PIXEL_FMT_RGB_555, PIXEL_FMT_RGBX_8888,   PIXEL_FMT_RGBA_8888, PIXEL_FMT_RGB_888, PIXEL_FMT_BGR_565, PIXEL_FMT_BGRX_4444,   PIXEL_FMT_BGRA_4444, PIXEL_FMT_BGRX_5551, PIXEL_FMT_BGRA_5551, PIXEL_FMT_BGRX_8888,   PIXEL_FMT_BGRA_8888, PIXEL_FMT_YUV_422_I, PIXEL_FMT_YCBCR_422_SP, PIXEL_FMT_YCRCB_422_SP,   PIXEL_FMT_YCBCR_420_SP, PIXEL_FMT_YCRCB_420_SP, PIXEL_FMT_YCBCR_422_P, PIXEL_FMT_YCRCB_422_P,   PIXEL_FMT_YCBCR_420_P, PIXEL_FMT_YCRCB_420_P, PIXEL_FMT_YUYV_422_PKG, PIXEL_FMT_UYVY_422_PKG,   PIXEL_FMT_YVYU_422_PKG, PIXEL_FMT_VYUY_422_PKG, PIXEL_FMT_VENDER_MASK = 0X7FFF0000, PIXEL_FMT_BUTT = 0X7FFFFFFF } | 像素格式类型定义。 [更多...](_display.md#pixelformat) | -| [TransformType](_display.md#transformtype) { ROTATE_NONE = 0, ROTATE_90, ROTATE_180, ROTATE_270,   ROTATE_BUTT } | 图层变换类型定义。 [更多...](_display.md#transformtype) | -| [BlendType](_display.md#blendtype) { BLEND_NONE = 0, BLEND_CLEAR, BLEND_SRC, BLEND_SRCOVER,   BLEND_DSTOVER, BLEND_SRCIN, BLEND_DSTIN, BLEND_SRCOUT,   BLEND_DSTOUT, BLEND_SRCATOP, BLEND_DSTATOP, BLEND_ADD,   BLEND_XOR, BLEND_DST, BLEND_AKS, BLEND_AKD,   BLEND_BUTT } | 显示内存类型定义。 [更多...](_display.md#blendtype) | -| [RopType](_display.md#roptype) { ROP_BLACK = 0, ROP_NOTMERGEPEN, ROP_MASKNOTPEN, ROP_NOTCOPYPEN,   ROP_MASKPENNOT, ROP_NOT, ROP_XORPEN, ROP_NOTMASKPEN,   ROP_MASKPEN, ROP_NOTXORPEN, ROP_NOP, ROP_MERGENOTPEN,   ROP_COPYPE, ROP_MERGEPENNOT, ROP_MERGEPEN, ROP_WHITE,   ROP_BUTT } |硬件加速支持的ROP操作类型。 [更多...](_display.md#roptype) | -| [ColorKey](_display.md#colorkey) { CKEY_NONE = 0, CKEY_SRC, CKEY_DST, CKEY_BUTT } | Color key操作类型定义，即硬件加速支持的Color key操作类型。 [更多...](_display.md#colorkey) | -| [MirrorType](_display.md#mirrortype) { MIRROR_NONE = 0, MIRROR_LR, MIRROR_TB, MIRROR_BUTT } | 硬件加速支持的镜像操作类型定义 [更多...](_display.md#mirrortype) | -| [Connection](_display.md#connection) { CON_INVALID = 0, CONNECTED, DISCONNECTED } | 热插拔连接类型定义 [更多...](_display.md#connection) | -| [InterfaceType](_display.md#interfacetype) { DISP_INTF_HDMI = 0, DISP_INTF_LCD, DISP_INTF_BT1120, DISP_INTF_BT656,   DISP_INTF_YPBPR, DISP_INTF_RGB, DISP_INTF_CVBS, DISP_INTF_SVIDEO,   DISP_INTF_VGA, DISP_INTF_MIPI, DISP_INTF_PANEL, DISP_INTF_BUTT } | 枚举接口类型。 [更多...](_display.md#interfacetype) | -| [DispPowerStatus](_display.md#disppowerstatus) { POWER_STATUS_ON, POWER_STATUS_STANDBY, POWER_STATUS_SUSPEND, POWER_STATUS_OFF,   POWER_STATUS_BUTT } | 枚举显示状态 [更多...](_display.md#disppowerstatus) | -| [CompositionType](_display.md#compositiontype) { COMPOSITION_CLIENT, COMPOSITION_DEVICE, COMPOSITION_CURSOR, COMPOSITION_VIDEO,   COMPOSITION_DEVICE_CLEAR, COMPOSITION_CLIENT_CLEAR, COMPOSITION_TUNNEL, COMPOSITION_BUTT } | 枚举特殊层的组合类型。 [更多...](_display.md#compositiontype) | -| [ColorGamut](_display.md#colorgamut) { COLOR_GAMUT_INVALID = -1, COLOR_GAMUT_NATIVE = 0, COLOR_GAMUT_STANDARD_BT601 = 1, COLOR_GAMUT_STANDARD_BT709 = 2,   COLOR_GAMUT_DCI_P3 = 3, COLOR_GAMUT_SRGB = 4, COLOR_GAMUT_ADOBE_RGB = 5, COLOR_GAMUT_DISPLAY_P3 = 6,   COLOR_GAMUT_BT2020 = 7, COLOR_GAMUT_BT2100_PQ = 8, COLOR_GAMUT_BT2100_HLG = 9, COLOR_GAMUT_DISPLAY_BT2020 = 10 } | 色域类型枚举值 [更多...](_display.md#colorgamut) | -| [GamutMap](_display.md#gamutmap) { GAMUT_MAP_CONSTANT = 0, GAMUT_MAP_EXPANSION = 1, GAMUT_MAP_HDR_CONSTANT = 2, GAMUT_MAP_HDR_EXPANSION = 3 } | 枚举色域的映射类型 [更多...](_display.md#gamutmap) | -| [ColorDataSpace](_display.md#colordataspace) {   COLOR_DATA_SPACE_UNKNOWN = 0, GAMUT_BT601 = 0x00000001, GAMUT_BT709 = 0x00000002, GAMUT_DCI_P3 = 0x00000003,   GAMUT_SRGB = 0x00000004, GAMUT_ADOBE_RGB = 0x00000005, GAMUT_DISPLAY_P3 = 0x00000006, GAMUT_BT2020 = 0x00000007,   GAMUT_BT2100_PQ = 0x00000008, GAMUT_BT2100_HLG = 0x00000009, GAMUT_DISPLAY_BT2020 = 0x0000000a, TRANSFORM_FUNC_UNSPECIFIED = 0x00000100,   TRANSFORM_FUNC_LINEAR = 0x00000200, TRANSFORM_FUNC_SRGB = 0x00000300, TRANSFORM_FUNC_SMPTE_170M = 0x00000400, TRANSFORM_FUNC_GM2_2 = 0x00000500,   TRANSFORM_FUNC_GM2_6 = 0x00000600, TRANSFORM_FUNC_GM2_8 = 0x00000700, TRANSFORM_FUNC_ST2084 = 0x00000800, TRANSFORM_FUNC_HLG = 0x00000900,   PRECISION_UNSPECIFIED = 0x00010000, PRECISION_FULL = 0x00020000, PRESION_LIMITED = 0x00030000, PRESION_EXTENDED = 0x00040000,   BT601_SMPTE170M_FULL = GAMUT_BT601 \| TRANSFORM_FUNC_SMPTE_170M \| PRECISION_FULL, BT601_SMPTE170M_LIMITED = GAMUT_BT601 \| TRANSFORM_FUNC_SMPTE_170M \| PRESION_LIMITED, BT709_LINEAR_FULL = GAMUT_BT709 \| TRANSFORM_FUNC_LINEAR \| PRECISION_FULL, BT709_LINEAR_EXTENDED = GAMUT_BT709 \| TRANSFORM_FUNC_LINEAR \| PRESION_EXTENDED,   BT709_SRGB_FULL = GAMUT_BT709 \| TRANSFORM_FUNC_SRGB \| PRECISION_FULL, BT709_SRGB_EXTENDED = GAMUT_BT709 \| TRANSFORM_FUNC_SRGB \| PRESION_EXTENDED, BT709_SMPTE170M_LIMITED = GAMUT_BT709 \| TRANSFORM_FUNC_SMPTE_170M \| PRESION_LIMITED, DCI_P3_LINEAR_FULL = GAMUT_DCI_P3 \| TRANSFORM_FUNC_LINEAR \| PRECISION_FULL,   DCI_P3_GAMMA26_FULL = GAMUT_DCI_P3 \| TRANSFORM_FUNC_GM2_6 \| PRECISION_FULL, DISPLAY_P3_LINEAR_FULL = GAMUT_DISPLAY_P3 \| TRANSFORM_FUNC_LINEAR \| PRECISION_FULL, DCI_P3_SRGB_FULL = GAMUT_DCI_P3 \| TRANSFORM_FUNC_SRGB \| PRECISION_FULL, ADOBE_RGB_GAMMA22_FULL = GAMUT_ADOBE_RGB \| TRANSFORM_FUNC_GM2_2 \| PRECISION_FULL,   BT2020_LINEAR_FULL = GAMUT_BT2020 \| TRANSFORM_FUNC_LINEAR \| PRECISION_FULL, BT2020_SRGB_FULL = GAMUT_BT2020 \| TRANSFORM_FUNC_SRGB \| PRECISION_FULL, BT2020_SMPTE170M_FULL = GAMUT_BT2020 \| TRANSFORM_FUNC_SMPTE_170M \| PRECISION_FULL, BT2020_ST2084_FULL = GAMUT_BT2020 \| TRANSFORM_FUNC_ST2084 \| PRECISION_FULL,   BT2020_HLG_FULL = GAMUT_BT2020 \| TRANSFORM_FUNC_HLG \| PRECISION_FULL, BT2020_ST2084_LIMITED = GAMUT_BT2020 \| TRANSFORM_FUNC_ST2084 \| PRESION_LIMITED } | 枚举颜色空间的类型 [更多...](_display.md#colordataspace) | -| [HDRFormat](_display.md#hdrformat) { NOT_SUPPORT_HDR = 0, DOLBY_VISION = 1, HDR10 = 2, HLG = 3,   HDR10_PLUS = 4, HDR_VIVID = 5 } | 枚举HDR格式 [更多...](_display.md#hdrformat) | -| [HDRMetadataKey](_display.md#hdrmetadatakey) { MATAKEY_RED_PRIMARY_X = 0, MATAKEY_RED_PRIMARY_Y = 1, MATAKEY_GREEN_PRIMARY_X = 2, MATAKEY_GREEN_PRIMARY_Y = 3,   MATAKEY_BLUE_PRIMARY_X = 4, MATAKEY_BLUE_PRIMARY_Y = 5, MATAKEY_WHITE_PRIMARY_X = 6, MATAKEY_WHITE_PRIMARY_Y = 7,   MATAKEY_MAX_LUMINANCE = 8, MATAKEY_MIN_LUMINANCE = 9, MATAKEY_MAX_CONTENT_LIGHT_LEVEL = 10, MATAKEY_MAX_FRAME_AVERAGE_LIGHT_LEVEL = 11,   MATAKEY_HDR10_PLUS = 12, MATAKEY_HDR_VIVID = 13 } | 枚举HDR元数据关键字 [更多...](_display.md#hdrmetadatakey) | -| [PresentTimestampType](_display.md#presenttimestamptype) { HARDWARE_DISPLAY_PTS_UNSUPPORTED = 0, HARDWARE_DISPLAY_PTS_DELAY = 1 << 0, HARDWARE_DISPLAY_PTS_TIMESTAMP = 1 << 1 } | 上屏时间戳类型枚举值 [更多...](_display.md#presenttimestamptype) | - - -## **详细描述** - -显示类型定义，定义显示驱动接口所使用的数据类型。 - -**Since：** - -1.0 - -**Version：** - -2.0 +| [DispErrCode](_display.md#disperrcode){ DISPLAY_SUCCESS = 0, DISPLAY_FAILURE = -1, DISPLAY_FD_ERR = -2, DISPLAY_PARAM_ERR = -3,   DISPLAY_NULL_PTR = -4, DISPLAY_NOT_SUPPORT = -5, DISPLAY_NOMEM = -6, DISPLAY_SYS_BUSY = -7,   DISPLAY_NOT_PERM = -8 } | 返回值类型定义。 | +| [LayerType](_display.md#layertype){ LAYER_TYPE_GRAPHIC, LAYER_TYPE_OVERLAY, LAYER_TYPE_SDIEBAND, LAYER_TYPE_CURSOR,   LAYER_TYPE_BUTT } | 图层类型定义。 | +| { HBM_USE_CPU_READ = (1 << 0), HBM_USE_CPU_WRITE = (1 << 1), HBM_USE_MEM_MMZ = (1 << 2), HBM_USE_MEM_DMA = (1 << 3),   HBM_USE_MEM_SHARE = (1 << 4), HBM_USE_MEM_MMZ_CACHE = (1 << 5), HBM_USE_MEM_FB = (1 << 6), HBM_USE_ASSIGN_SIZE = (1 << 7) } | 定义缓冲区使用。 | +| [PixelFormat](_display.md#pixelformat){ PIXEL_FMT_CLUT8 = 0, PIXEL_FMT_CLUT1, PIXEL_FMT_CLUT4, PIXEL_FMT_RGB_565,   PIXEL_FMT_RGBA_5658, PIXEL_FMT_RGBX_4444, PIXEL_FMT_RGBA_4444, PIXEL_FMT_RGB_444,   PIXEL_FMT_RGBX_5551, PIXEL_FMT_RGBA_5551, PIXEL_FMT_RGB_555, PIXEL_FMT_RGBX_8888,   PIXEL_FMT_RGBA_8888, PIXEL_FMT_RGB_888, PIXEL_FMT_BGR_565, PIXEL_FMT_BGRX_4444,   PIXEL_FMT_BGRA_4444, PIXEL_FMT_BGRX_5551, PIXEL_FMT_BGRA_5551, PIXEL_FMT_BGRX_8888,   PIXEL_FMT_BGRA_8888, PIXEL_FMT_YUV_422_I, PIXEL_FMT_YCBCR_422_SP, PIXEL_FMT_YCRCB_422_SP,   PIXEL_FMT_YCBCR_420_SP, PIXEL_FMT_YCRCB_420_SP, PIXEL_FMT_YCBCR_422_P, PIXEL_FMT_YCRCB_422_P,   PIXEL_FMT_YCBCR_420_P, PIXEL_FMT_YCRCB_420_P, PIXEL_FMT_YUYV_422_PKG, PIXEL_FMT_UYVY_422_PKG,   PIXEL_FMT_YVYU_422_PKG, PIXEL_FMT_VYUY_422_PKG, PIXEL_FMT_VENDER_MASK = 0X7FFF0000, PIXEL_FMT_BUTT = 0X7FFFFFFF } | 像素格式类型定义。 | +| [TransformType](_display.md#transformtype){ ROTATE_NONE = 0, ROTATE_90, ROTATE_180, ROTATE_270,   ROTATE_BUTT } | 图层变换类型定义。 | +| [BlendType](_display.md#blendtype){ BLEND_NONE = 0, BLEND_CLEAR, BLEND_SRC, BLEND_SRCOVER,   BLEND_DSTOVER, BLEND_SRCIN, BLEND_DSTIN, BLEND_SRCOUT,   BLEND_DSTOUT, BLEND_SRCATOP, BLEND_DSTATOP, BLEND_ADD,   BLEND_XOR, BLEND_DST, BLEND_AKS, BLEND_AKD,   BLEND_BUTT } | 支持的图像混合类型。 | +| [RopType](_display.md#roptype){ ROP_BLACK = 0, ROP_NOTMERGEPEN, ROP_MASKNOTPEN, ROP_NOTCOPYPEN,   ROP_MASKPENNOT, ROP_NOT, ROP_XORPEN, ROP_NOTMASKPEN,   ROP_MASKPEN, ROP_NOTXORPEN, ROP_NOP, ROP_MERGENOTPEN,   ROP_COPYPE, ROP_MERGEPENNOT, ROP_MERGEPEN, ROP_WHITE,   ROP_BUTT } | 硬件加速支持的ROP操作类型。 | +| [ColorKey](_display.md#colorkey) { CKEY_NONE = 0, CKEY_SRC, CKEY_DST, CKEY_BUTT } | Color key操作类型定义，即硬件加速支持的Color key操作类型。 | +| [MirrorType](_display.md#mirrortype){ MIRROR_NONE = 0, MIRROR_LR, MIRROR_TB, MIRROR_BUTT } | 硬件加速支持的镜像操作类型定义。 | +| [Connection](_display.md#connection){ CON_INVALID = 0, CONNECTED, DISCONNECTED } | 热插拔连接类型定义。 | +| [InterfaceType](_display.md#interfacetype){ DISP_INTF_HDMI = 0, DISP_INTF_LCD, DISP_INTF_BT1120, DISP_INTF_BT656,   DISP_INTF_YPBPR, DISP_INTF_RGB, DISP_INTF_CVBS, DISP_INTF_SVIDEO,   DISP_INTF_VGA, DISP_INTF_MIPI, DISP_INTF_PANEL, DISP_INTF_BUTT } | 枚举接口类型。 | +| [DispPowerStatus](_display.md#disppowerstatus){ POWER_STATUS_ON, POWER_STATUS_STANDBY, POWER_STATUS_SUSPEND, POWER_STATUS_OFF,   POWER_STATUS_BUTT } | 枚举显示状态。 | +| [CompositionType](_display.md#compositiontype){ COMPOSITION_CLIENT, COMPOSITION_DEVICE, COMPOSITION_CURSOR, COMPOSITION_VIDEO,   COMPOSITION_DEVICE_CLEAR, COMPOSITION_CLIENT_CLEAR, COMPOSITION_TUNNEL, COMPOSITION_BUTT } | 枚举特殊层的组合类型。 | +| [ColorGamut](_display.md#colorgamut){ COLOR_GAMUT_INVALID = -1, COLOR_GAMUT_NATIVE = 0, COLOR_GAMUT_SATNDARD_BT601 = 1, COLOR_GAMUT_STANDARD_BT709 = 2,   COLOR_GAMUT_DCI_P3 = 3, COLOR_GAMUT_SRGB = 4, COLOR_GAMUT_ADOBE_RGB = 5, COLOR_GAMUT_DISPLAY_P3 = 6,   COLOR_GAMUT_BT2020 = 7, COLOR_GAMUT_BT2100_PQ = 8, COLOR_GAMUT_BT2100_HLG = 9, COLOR_GAMUT_DISPLAY_BT2020 = 10 } | 色域类型枚举值。 | +| [GamutMap](_display.md#gamutmap){ GAMUT_MAP_CONSTANT = 0, GAMUT_MAP_EXPANSION = 1, GAMUT_MAP_HDR_CONSTANT = 2, GAMUT_MAP_HDR_EXPANSION = 3 } | 枚举色域的映射类型。 | +| [ColorDataSpace](_display.md#colordataspace){  COLOR_DATA_SPACE_UNKNOWN = 0, GAMUT_BT601 = 0x00000001, GAMUT_BT709 = 0x00000002, GAMUT_DCI_P3 = 0x00000003,   GAMUT_SRGB = 0x00000004, GAMUT_ADOBE_RGB = 0x00000005, GAMUT_DISPLAY_P3 = 0x00000006, GAMUT_BT2020 = 0x00000007,   GAMUT_BT2100_PQ = 0x00000008, GAMUT_BT2100_HLG = 0x00000009, GAMUT_DISPLAY_BT2020 = 0x0000000a, TRANSFORM_FUNC_UNSPECIFIED = 0x00000100,   TRANSFORM_FUNC_LINEAR = 0x00000200, TRANSFORM_FUNC_SRGB = 0x00000300, TRANSFORM_FUNC_SMPTE_170M = 0x00000400, TRANSFORM_FUNC_GM2_2 = 0x00000500,   TRANSFORM_FUNC_GM2_6 = 0x00000600, TRANSFORM_FUNC_GM2_8 = 0x00000700, TRANSFORM_FUNC_ST2084 = 0x00000800, TRANSFORM_FUNC_HLG = 0x00000900,   PRECISION_UNSPECIFIED = 0x00010000, PRECISION_FULL = 0x00020000, PRESION_LIMITED = 0x00030000, PRESION_EXTENDED = 0x00040000,   BT601_SMPTE170M_FULL = GAMUT_BT601 \| TRANSFORM_FUNC_SMPTE_170M \| PRECISION_FULL, BT601_SMPTE170M_LIMITED = GAMUT_BT601 \| TRANSFORM_FUNC_SMPTE_170M \| PRESION_LIMITED, BT709_LINEAR_FULL = GAMUT_BT709 \| TRANSFORM_FUNC_LINEAR \| PRECISION_FULL, BT709_LINEAR_EXTENDED = GAMUT_BT709 \| TRANSFORM_FUNC_LINEAR \| PRESION_EXTENDED,   BT709_SRGB_FULL = GAMUT_BT709 \| TRANSFORM_FUNC_SRGB \| PRECISION_FULL, BT709_SRGB_EXTENDED = GAMUT_BT709 \| TRANSFORM_FUNC_SRGB \| PRESION_EXTENDED, BT709_SMPTE170M_LIMITED = GAMUT_BT709 \| TRANSFORM_FUNC_SMPTE_170M \| PRESION_LIMITED, DCI_P3_LINEAR_FULL = GAMUT_DCI_P3 \| TRANSFORM_FUNC_LINEAR \| PRECISION_FULL,   DCI_P3_GAMMA26_FULL = GAMUT_DCI_P3 \| TRANSFORM_FUNC_GM2_6 \| PRECISION_FULL, DISPLAY_P3_LINEAR_FULL = GAMUT_DISPLAY_P3 \| TRANSFORM_FUNC_LINEAR \| PRECISION_FULL, DCI_P3_SRGB_FULL = GAMUT_DCI_P3 \| TRANSFORM_FUNC_SRGB \| PRECISION_FULL, ADOBE_RGB_GAMMA22_FULL = GAMUT_ADOBE_RGB \| TRANSFORM_FUNC_GM2_2 \| PRECISION_FULL,   BT2020_LINEAR_FULL = GAMUT_BT2020 \| TRANSFORM_FUNC_LINEAR \| PRECISION_FULL, BT2020_SRGB_FULL = GAMUT_BT2020 \| TRANSFORM_FUNC_SRGB \| PRECISION_FULL, BT2020_SMPTE170M_FULL = GAMUT_BT2020 \| TRANSFORM_FUNC_SMPTE_170M \| PRECISION_FULL, BT2020_ST2084_FULL = GAMUT_BT2020 \| TRANSFORM_FUNC_ST2084 \| PRECISION_FULL,   BT2020_HLG_FULL = GAMUT_BT2020 \| TRANSFORM_FUNC_HLG \| PRECISION_FULL, BT2020_ST2084_LIMITED = GAMUT_BT2020 \| TRANSFORM_FUNC_ST2084 \| PRESION_LIMITED } | 枚举颜色空间的类型。 | +| [HDRFormat](_display.md#hdrformat){ NOT_SUPPORT_HDR = 0, DOLBY_VISION = 1, HDR10 = 2, HLG = 3,   HDR10_PLUS = 4, HDR_VIVID = 5 } | 枚举HDR格式。 | +| [HDRMetadataKey](_display.md#hdrmetadatakey){  MATAKEY_RED_PRIMARY_X = 0, MATAKEY_RED_PRIMARY_Y = 1, MATAKEY_GREEN_PRIMARY_X = 2, MATAKEY_GREEN_PRIMARY_Y = 3,   MATAKEY_BLUE_PRIMARY_X = 4, MATAKEY_BLUE_PRIMARY_Y = 5, MATAKEY_WHITE_PRIMARY_X = 6, MATAKEY_WHITE_PRIMARY_Y = 7,   MATAKEY_MAX_LUMINANCE = 8, MATAKEY_MIN_LUMINANCE = 9, MATAKEY_MAX_CONTENT_LIGHT_LEVEL = 10, MATAKEY_MAX_FRAME_AVERAGE_LIGHT_LEVEL = 11,   MATAKEY_HDR10_PLUS = 12, MATAKEY_HDR_VIVID = 13 } | 枚举HDR元数据关键字。 | +| [PresentTimestampType](_display.md#presenttimestamptype){ HARDWARE_DISPLAY_PTS_UNSUPPORTED = 0, HARDWARE_DISPLAY_PTS_DELAY = 1 << 0, HARDWARE_DISPLAY_PTS_TIMESTAMP = 1 << 1 } | 上屏时间戳类型枚举值。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/display__vgu_8h.md b/zh-cn/device-dev/reference/hdi-apis/display__vgu_8h.md new file mode 100644 index 0000000000000000000000000000000000000000..e2625c82399cd7fd24c528905e9b6ae761a006f7 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/display__vgu_8h.md @@ -0,0 +1,99 @@ +# display_vgu.h + + +## **概述** + +定义2D矢量硬件加速模块相关驱动函数。 + +**Since:** + +3.0 + +**相关模块:** + +[Display](_display.md) + + +## **汇总** + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [VGUPoint](_v_g_u_point.md) | 坐标点对象。 | +| [VGURect](_v_g_u_rect.md) | 矩形对象。 | +| [VGUPath](_v_g_u_path.md) | 路径对象，存放路径命令和坐标数据。 | +| [VGUMatrix3](_v_g_u_matrix3.md) | 变换矩阵。 | +| [VGUBuffer](_v_g_u_buffer.md) | 硬件加速渲染位图缓存。 | +| [VGUMaskLayer](_v_g_u_mask_layer.md) | 定义蒙版图层。 | +| [VGUSurface](_v_g_u_surface.md) | 2D硬件加速绘制目标表面。 | +| [VGUColorStop](_v_g_u_color_stop.md) | 渐变颜色分布位置。 | +| [VGULinear](_v_g_u_linear.md) | 线性渐变。 | +| [VGURadial](_v_g_u_radial.md) | 辐射渐变。 | +| [VGUConic](_v_g_u_conic.md) | 圆锥渐变。 | +| [VGUImage](_v_g_u_image.md) | 图像对象。 | +| [VGUPattern](_v_g_u_pattern.md) | 图片模式对象。 | +| [VGUGradient](_v_g_u_gradient.md) | 渐变对象。 | +| [VGUSolid](_v_g_u_solid.md) | 颜色对象。 | +| [VGUPaintStyle](_v_g_u_paint_style.md) | 填充或描边路径的渲染风格。 | +| [VGUFillAttr](_v_g_u_fill_attr.md) | 填充路径的属性。 | +| [VGUStrokeAttr](_v_g_u_stroke_attr.md) | 描边路径的属性。 | +| [VGUFuncs](_v_g_u_funcs.md) | 定义2D硬件加速驱动函数。 | + + +### 宏定义 + + | 名称 | 描述 | +| -------- | -------- | +| **HDI_VGU_SCALAR_IS_FLOAT**   1 | | + + +### 类型定义 + + | 名称 | 描述 | +| -------- | -------- | +| **VGUScalar** | | +| [ERROR:Invalid link:zh-cn_topic_0000001424061937.xml#xref1262016237273,link:zh-cn_topic_0000001369548746.xml#section469245920231](zh-cn_topic_0000001369548746.xml#section469245920231) | 像素格式。 | +| [ERROR:Invalid link:zh-cn_topic_0000001424061937.xml#xref1242115582710,link:zh-cn_topic_0000001369548746.xml#section9701742192518](zh-cn_topic_0000001369548746.xml#section9701742192518) | 混合操作类型。 | + + +### 枚举 + + | 名称 | 描述 | +| -------- | -------- | +| [VGUPathDataType](_display.md#vgupathdatatype){ VGU_DATA_TYPE_S16 = 0, VGU_DATA_TYPE_S32, VGU_DATA_TYPE_F32 } | 路径坐标数据类型。 | +| [VGUCapability](_display.md#vgucapability){ VGU_CAP_BLIT = (1 << 0), VGU_CAP_BLIT_NUM = (1 << 1), VGU_CAP_PATH = (1 << 2), VGU_CAP_FILTER_BLUR = (1 << 3) } | 硬件加速能力。 | +| [VGUResult](_display.md#vguresult){   VGU_SUCCESS = 0, VGU_NO_SUPPORT = -1, VGU_OPERATION_FAILED = -2, VGU_OUT_OF_MEMORY = -3,   VGU_TIMEOUT = -4, VGU_INVALID_PARAMETER = -5, VGU_BUSY = -6, VGU_NO_CONTEXT = -7 } | 错误码定义。 | +| [VGULineCap](_display.md#vgulinecap){ VGU_LINECAP_BUTT = 0, VGU_LINECAP_ROUND, VGU_LINECAP_SQUARE } | 线帽。 | +| [VGUJointType](_display.md#vgujointtype){ VGU_LINE_JOIN_MITER = 0, VGU_LINE_JOIN_ROUND, VGU_LINE_JOIN_BEVEL, VGU_LINE_JOIN_BUTT } | 联接类型。 | +| [VGUFilter](_display.md#vgufilter){ VGU_FILTER_BILINEAR = 0, VGU_FILTER_NEAREST, VGU_FILTER_LINEAR, VGU_FILTER_BUTT } | 图像滤波类型。 | +| [VGUFillRule](_display.md#vgufillrule){ VGU_RULE_WINDING = 0, VGU_RULE_EVEN_ODD, VGU_RULE_BUTT } | 填充规则定义。 | +| [VGUFillSpread](_display.md#vgufillspread){ VGU_SPREAD_PAD = 0, VGU_SPREAD_REFLECT, VGU_SPREAD_REPEAT, VGU_SPREAD_BUTT } | 渐变填充区域外的延展类型。 | +| [VGUWrapType](_display.md#vguwraptype){ VGU_WRAP_REFLECT = 0, VGU_WRAP_REPEAT, VGU_WRAP_BUTT } | 图像模式填充延展类型。 | +| [VGUPathCmd](_display.md#vgupathcmd){   VGU_PATH_CMD_CLOSE = 0, VGU_PATH_CMD_MOVE, VGU_PATH_CMD_LINE, VGU_PATH_CMD_HLINE,   VGU_PATH_CMD_VLINE, VGU_PATH_CMD_QUAD, VGU_PATH_CMD_CUBIC, VGU_PATH_CMD_SQUAD,   VGU_PATH_CMD_SCUBIC, VGU_PATH_CMD_BUTT } | 路径绘制指令类型。 | +| [VGUTransformType](_display.md#vgutransformtype){ VGU_TRANSFORM_TRANSLATE = (1 << 0), VGU_TRANSFORM_SCALE = (1 << 1), VGU_TRANSFORM_ROTATE_90 = (1 << 2), VGU_TRANSFORM_ROTATE_180 = (1 << 3),   VGU_TRANSFORM_ROTATE_270 = (1 << 4), VGU_TRANSFORM_OTHER = (1 << 16) } | 变换类型。 | +| [VGUClipType](_display.md#vgucliptype){ VGU_CLIP_RECT = 0, VGU_CLIP_PATH, VGU_CLIP_BUTT } | 绘制表面剪切类型。 | +| [VGUGradientType](_display.md#vgugradienttype){ VGU_GRADIENT_LINEAR = 0, VGU_GRADIENT_RADIAL, VGU_GRADIENT_CONIC, VGU_GRADIENT_BUTT } | 渐变类型。 | +| [VGUPaintType](_display.md#vgupainttype){ VGU_PAINT_SOLID = 0, VGU_PAINT_GRADIENT, VGU_PAINT_PATTERN, VGU_PAINT_BUTT } | 渲染对象。 | + + +### 函数 + + | 名称 | 描述 | +| -------- | -------- | +| [VGUPathInit](_display.md#vgupathinit)(VGUPath \*path, VGUPathDataType type, const uint8_t \*segments, int numSegments, const uint8_t \*data, bool enAlias, VGURect boundBox) | 初始化路径对象。 | +| [VGUPathAppend](_display.md#vgupathappend)(VGUPath \*path, const VGUPath \*subpath) | 添加子路径到当前路径中。 | +| [VGUPathClear](_display.md#vgupathclear)(VGUPath \*path) | 清除路径对象内存。 | +| [VGUMatrixIdentity](_display.md#vgumatrixidentity)(VGUMatrix3 \*matrix) | 初始化矩阵对象为单位矩阵。 | +| [VGUMatrixScale](_display.md#vgumatrixscale)(VGUMatrix3 \*matrix, float xScale, float yScale) | 矩阵变换缩放。 | +| [VGUMatrixRotate](_display.md#vgumatrixrotate)(VGUMatrix3 \*matrix, float degree) | 矩阵变换旋转。 | +| [VGUMatrixTranslate](_display.md#vgumatrixtranslate)(VGUMatrix3 \*matrix, float x, float y) | 矩阵变换平移。 | +| [VGUGradientColorStop](_display.md#vgugradientcolorstop)(VGUGradient \*gradient, const VGUColorStop \*colorStop, uint32_t count) | 对渐变添加ColorStop。 | +| [VGUGradientClearStop](_display.md#vgugradientclearstop)(VGUGradient \*gradient) | 清除ColorStop。 | +| [VGUGradientMatrix](_display.md#vgugradientmatrix)(VGUGradient \*gradient, const VGUMatrix3 \*matrix) | 设置渐变对象的变换矩阵。 | +| [VGUGradientLinear](_display.md#vgugradientlinear)(VGUGradient \*gradient, const VGUPoint \*p1, const VGUPoint \*p2) | 创建线性渐变对象。 | +| [VGUGradientRadial](_display.md#vgugradientradial)(VGUGradient \*gradient, const VGUPoint \*p1, VGUScalar r1, const VGUPoint \*p2, VGUScalar r2) | 创建辐射渐变对象 | +| [VGUGradientConic](_display.md#vgugradientconic)(VGUGradient \*gradient, VGUScalar cx, VGUScalar cy) | 创建圆锥渐变对象。 | +| [VGUInitialize](_display.md#vguinitialize)(VGUFuncs \*\*funcs) | 获取硬件加速相关的操作接口指针。 | +| [VGUUninitialize](_display.md#vguuninitialize)(VGUFuncs \*funcs) | 去初始化硬件加速模块，同时释放硬件加速模块操作函数指针。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/face__auth_2_i_executor_8idl.md b/zh-cn/device-dev/reference/hdi-apis/face__auth_2_i_executor_8idl.md index 746f21f26106445e5134a3ac3b3878cc4d96098a..f10ada48070e6ba28b3e710c710f13cf97c6608f 100644 --- a/zh-cn/device-dev/reference/hdi-apis/face__auth_2_i_executor_8idl.md +++ b/zh-cn/device-dev/reference/hdi-apis/face__auth_2_i_executor_8idl.md @@ -3,6 +3,12 @@ ## **概述** +定义执行器接口，用于获取执行器，获取凭据模版信息，注册人脸特征模版，进行用户人脸认证，删除人脸特征模版等。 + +**Since：** + +3.2 + **所属模块:** [HdfFaceAuth](_hdf_face_auth.md) @@ -13,22 +19,13 @@ ### 类 - | 类 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [IExecutor](interface_i_executor.md) | 定义执行器接口，用于获取执行器，获取凭据模版信息，注册人脸特征模版，进行用户人脸认证，删除人脸特征模版等。 [更多...](interface_i_executor.md) | +| [IExecutor](interface_i_executor.md) | 定义执行器接口，用于获取执行器，获取凭据模版信息，注册人脸特征模版，进行用户人脸认证，删除人脸特征模版等。 | -### 变量 +### 关键字 - | 变量 名称 | 描述 | + | 名称 | 描述 | | -------- | -------- | | package ohos.hdi.face_auth.v1_0 | 人脸认证接口的包路径。 | - - -## **详细描述** - -定义执行器接口，用于获取执行器，获取凭据模版信息，注册人脸特征模版，进行用户人脸认证，删除人脸特征模版等。 - -**Since：** - -3.2 diff --git a/zh-cn/device-dev/reference/hdi-apis/face__auth_2_i_executor_callback_8idl.md b/zh-cn/device-dev/reference/hdi-apis/face__auth_2_i_executor_callback_8idl.md index ae11adf2057ae5a01e3d4c363b60754ac0754783..89c668dc7fcf495eb6d5710d3fcb68b36b87686e 100644 --- a/zh-cn/device-dev/reference/hdi-apis/face__auth_2_i_executor_callback_8idl.md +++ b/zh-cn/device-dev/reference/hdi-apis/face__auth_2_i_executor_callback_8idl.md @@ -3,6 +3,12 @@ ## **概述** +定义异步API接口回调，用于返回异步接口的请求处理结果和信息。 + +**Since：** + +3.2 + **所属模块:** [HdfFaceAuth](_hdf_face_auth.md) @@ -13,22 +19,13 @@ ### 类 - | 类 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [IExecutorCallback](interface_i_executor_callback.md) | 定义异步API接口回调，用于返回异步接口的请求处理结果和信息。使用细节见[IExecutor](interface_i_executor.md)。 [更多...](interface_i_executor_callback.md) | +| [IExecutorCallback](interface_i_executor_callback.md) | 定义异步API接口回调，用于返回异步接口的请求处理结果和信息。使用细节见[IExecutor](interface_i_executor.md)。 | -### 变量 +### 关键字 - | 变量 名称 | 描述 | + | 名称 | 描述 | | -------- | -------- | | package ohos.hdi.face_auth.v1_0 | 人脸认证接口的包路径 | - - -## **详细描述** - -定义异步API接口回调，用于返回异步接口的请求处理结果和信息。 - -**Since：** - -3.2 diff --git a/zh-cn/device-dev/reference/hdi-apis/files.md b/zh-cn/device-dev/reference/hdi-apis/files.md new file mode 100644 index 0000000000000000000000000000000000000000..c4c4f5171e25975eb0c0e29c0c73ed189c29a62d --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/files.md @@ -0,0 +1,145 @@ +# 头文件 + + + +- **[audio_adapter.h](audio__adapter_8h.md)** + +- **[audio_attribute.h](audio__attribute_8h.md)** + +- **[audio_capture.h](audio__capture_8h.md)** + +- **[audio_control.h](audio__control_8h.md)** + +- **[audio_manager.h](audio__manager_8h.md)** + +- **[audio_render.h](audio__render_8h.md)** + +- **[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_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)** + +- **[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)** + +- **[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)** + +- **[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)** + +- **[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)** + +- **[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](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)** \ No newline at end of file diff --git a/zh-cn/device-dev/reference/hdi-apis/icamera__device_8h.md b/zh-cn/device-dev/reference/hdi-apis/icamera__device_8h.md deleted file mode 100644 index 91b9f1c93460824bf925388ebdfba6f93a5d0c2e..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/icamera__device_8h.md +++ /dev/null @@ -1,31 +0,0 @@ -# icamera_device.h - - -## **概述** - -**所属模块:** - -[Camera](_camera.md) - - -## **汇总** - - -### 类 - - | 类 | 描述 | -| -------- | -------- | -| [OHOS::Camera::ICameraDevice](_o_h_o_s_1_1_camera_1_1_i_camera_device.md) | Camera设备操作。 | - - -## **详细描述** - -Camera设备操作接口。 - -**Since：** - -1.0 - -**Version：** - -1.0 diff --git a/zh-cn/device-dev/reference/hdi-apis/icamera__device__callback_8h.md b/zh-cn/device-dev/reference/hdi-apis/icamera__device__callback_8h.md deleted file mode 100644 index d70ccf005f7eae0f6882672fd0761781959b8276..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/icamera__device__callback_8h.md +++ /dev/null @@ -1,31 +0,0 @@ -# icamera_device_callback.h - - -## **概述** - -**所属模块:** - -[Camera](_camera.md) - - -## **汇总** - - -### 类 - - | 类 | 描述 | -| -------- | -------- | -| [OHOS::Camera::ICameraDeviceCallback](_o_h_o_s_1_1_camera_1_1_i_camera_device_callback.md) | Camera设备操作回调。 | - - -## **详细描述** - -Camera设备的回调接口，主要包含camera设备发生错误时和上报metadata的回调函数。 - -**Since：** - -1.0 - -**Version：** - -1.0 diff --git a/zh-cn/device-dev/reference/hdi-apis/icamera__host_8h.md b/zh-cn/device-dev/reference/hdi-apis/icamera__host_8h.md deleted file mode 100644 index e7991b95aeef1a42960f000d2132442d4542f37c..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/icamera__host_8h.md +++ /dev/null @@ -1,31 +0,0 @@ -# icamera_host.h - - -## **概述** - -**所属模块:** - -[Camera](_camera.md) - - -## **汇总** - - -### 类 - - | 类 | 描述 | -| -------- | -------- | -| [OHOS::Camera::ICameraHost](_o_h_o_s_1_1_camera_1_1_i_camera_host.md) | Camera服务的管理类。 | - - -## **详细描述** - -Camera服务的管理类，对上层提供HDI接口。 - -**Since：** - -1.0 - -**Version：** - -1.0 diff --git a/zh-cn/device-dev/reference/hdi-apis/icamera__host__callback_8h.md b/zh-cn/device-dev/reference/hdi-apis/icamera__host__callback_8h.md deleted file mode 100644 index f63aab515a0770f65885e0107c20df7e016c9149..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/icamera__host__callback_8h.md +++ /dev/null @@ -1,31 +0,0 @@ -# icamera_host_callback.h - - -## **概述** - -**所属模块:** - -[Camera](_camera.md) - - -## **汇总** - - -### 类 - - | 类 | 描述 | -| -------- | -------- | -| [OHOS::Camera::ICameraHostCallback](_o_h_o_s_1_1_camera_1_1_i_camera_host_callback.md) | Camera服务的管理回调。 | - - -## **详细描述** - -ICameraHost的回调接口，提供Camera设备和闪关灯状态变化的回调函数，回调函数由调用者实现。 - -**Since：** - -1.0 - -**Version：** - -1.0 diff --git a/zh-cn/device-dev/reference/hdi-apis/input.md b/zh-cn/device-dev/reference/hdi-apis/input.md new file mode 100644 index 0000000000000000000000000000000000000000..d94e44f1b721e5e7dbf83e2eda4060a97ae25046 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/input.md @@ -0,0 +1,333 @@ +# Input + + +## **概述** + +Input模块驱动接口声明。 + +本模块为Input服务提供相关驱动接口，包括Input设备的打开和关闭、Input事件获取、设备信息查询、回调函数注册、特性状态控制等接口。 + +**Since**: + +1.0 + +**Version**: + +1.0 + + +## **汇总** + + +### 文件 + + | 名称 | 描述 | +| -------- | -------- | +| [input_controller.h](input__controller_8h.md) | 描述Input设备业务控制相关的接口声明。 | +| [input_manager.h](input__manager_8h.md) | 描述Input设备管理相关的接口声明。 | +| [input_reporter.h](input__reporter_8h.md) | 描述Input设备数据上报相关的接口声明。 | +| [input_type.h](input__type_8h.md) | Input设备相关的类型定义，定义了Input设备驱动接口所使用的结构体及枚举类型。 | + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [InputController](_input_controller.md) | 提供Input设备业务控制相关的接口。 | +| [InputManager](_input_manager.md) | 提供Input设备管理相关的接口。 | +| [IInputInterface](_i_input_interface.md) | 定义用于提供Input设备驱动程序功能的接口。 | +| [InputReporter](_input_reporter.md) | 提供Input设备数据上报相关的接口。 | +| [InputEventPackage](_input_event_package.md) | Input事件数据包结构。 | +| [InputHotPlugEvent](_input_hot_plug_event.md) | 热插拔事件数据包结构。 | +| [InputDevDesc](_input_dev_desc.md) | Input设备描述信息。 | +| [InputEventCb](_input_event_cb.md) | 此结构体定义了输入事件回调函数并提供给Input服务使用。 | +| [InputHostCb](_input_host_cb.md) | 此结构体定义了热插拔事件上报回调函数并提供给Input服务使用。 | +| [InputDevAbility](_input_dev_ability.md) | Input设备的能力属性，存储支持事件的位图。 | +| [InputDimensionInfo](_input_dimension_info.md) | Input设备的维度信息。 | +| [InputDevIdentify](_input_dev_identify.md) | Input设备的识别信息。 | +| [InputDevAttr](_input_dev_attr.md) | Input设备属性。 | +| [InputDeviceInfo](_input_device_info.md) | Input设备基础设备信息。 | +| [InputExtraCmd](_input_extra_cmd.md) | 扩展指令的数据结构。 | + + +### 宏定义 + + | 名称 | 描述 | +| -------- | -------- | +| [MAX_INPUT_DEV_NUM](#maxinputdevnum)   32 | Input设备数量的最大值。 | +| [CHIP_INFO_LEN](#chipinfolen)   10 | 芯片信息长度。 | +| [CHIP_NAME_LEN](#chipnamelen)   10 | 芯片名称长度。 | +| [VENDOR_NAME_LEN](#vendornamelen)   10 | 厂商名称长度。 | +| [DEV_NAME_LEN](#devnamelen)   64 | Input设备名称长度。 | +| [SELF_TEST_RESULT_LEN](#selftestresultlen)   20 | 自测结果长度。 | +| [DEV_MANAGER_SERVICE_NAME](#devmanagerservicename)   "hdf_input_host" | Input设备节点服务名称。 | +| [DIV_ROUND_UP](#divroundup)(nr, d)   (((nr) + (d) - 1) / (d)) | 向上取整计算公式。 | +| [BYTE_HAS_BITS](#bytehasbits)   8 | 一个字节所包含的比特数。 | +| [BITS_TO_UINT64](#bitstouint64)(count)   [DIV_ROUND_UP](#divroundup)(count, [BYTE_HAS_BITS](#bytehasbits) \* sizeof(uint64_t)) | 比特与64位无符号整数的转换公式。 | +| [HDF_FF_CNT](#hdfffcnt)   (0x7f + 1) | Input设备发送力反馈命令的数量最大值。 | + + +### 枚举 + + | 名称 | 描述 | +| -------- | -------- | +| [RetStatus](#retstatus) {   INPUT_SUCCESS = 0, INPUT_FAILURE = -1, INPUT_INVALID_PARAM = -2, INPUT_NOMEM = -3,   INPUT_NULL_PTR = -4, INPUT_TIMEOUT = -5, INPUT_UNSUPPORTED = -6 } | 定义返回值类型。 | +| [InputDevType](#inputdevtype) {   INDEV_TYPE_TOUCH, INDEV_TYPE_KEY, INDEV_TYPE_KEYBOARD, INDEV_TYPE_MOUSE,   INDEV_TYPE_BUTTON, INDEV_TYPE_CROWN, INDEV_TYPE_ENCODER, INDEV_TYPE_UNKNOWN } | 定义Input设备类型。 | +| [PowerStatus](#powerstatus) { INPUT_RESUME, INPUT_SUSPEND, INPUT_LOW_POWER, INPUT_POWER_STATUS_UNKNOWN } | 定义电源状态。 | +| [CapacitanceTest](#capacitancetest) {   BASE_TEST, FULL_TEST, MMI_TEST, RUNNING_TEST,   TEST_TYPE_UNKNOWN } | 定义容值测试类型。 | + + +### 函数 + + | 名称 | 描述 | +| -------- | -------- | +| [GetInputInterface](#getinputinterface) ([IInputInterface](_i_input_interface.md) \*\*interface) | Input服务通过调用此接口获取操作Input设备的所有接口。 | + + +## **宏定义说明** + + +### BITS_TO_UINT64 + + +``` +#define BITS_TO_UINT64( count) DIV_ROUND_UP(count, BYTE_HAS_BITS * sizeof(uint64_t)) +``` + +**描述：** + +比特与64位无符号整数的转换公式 + + +### BYTE_HAS_BITS + + +``` +#define BYTE_HAS_BITS 8 +``` + +**描述：** + +一个字节所包含的比特数 + + +### CHIP_INFO_LEN + + +``` +#define CHIP_INFO_LEN 10 +``` + +**描述：** + +芯片信息长度 + + +### CHIP_NAME_LEN + + +``` +#define CHIP_NAME_LEN 10 +``` + +**描述：** + +芯片名称长度 + + +### DEV_MANAGER_SERVICE_NAME + + +``` +#define DEV_MANAGER_SERVICE_NAME "hdf_input_host" +``` + +**描述：** + +Input设备节点服务名称 + + +### DEV_NAME_LEN + + +``` +#define DEV_NAME_LEN 64 +``` + +**描述：** + +Input设备名称长度 + + +### DIV_ROUND_UP + + +``` +#define DIV_ROUND_UP( nr, d ) (((nr) + (d) - 1) / (d)) +``` + +**描述：** + +向上取整计算公式 + + +### HDF_FF_CNT + + +``` +#define HDF_FF_CNT (0x7f + 1) +``` + +**描述：** + +Input设备发送力反馈命令的数量最大值 + + +### MAX_INPUT_DEV_NUM + + +``` +#define MAX_INPUT_DEV_NUM 32 +``` + +**描述：** + +Input设备数量的最大值 + + +### SELF_TEST_RESULT_LEN + + +``` +#define SELF_TEST_RESULT_LEN 20 +``` + +**描述：** + +自测试结果长度 + + +### VENDOR_NAME_LEN + + +``` +#define VENDOR_NAME_LEN 10 +``` + +**描述：** + +厂商名称长度 + + +## **枚举类型说明** + + +### CapacitanceTest + + +``` +enum CapacitanceTest +``` + +**描述：** + +定义容值测试类型。 + + | 枚举值 | 描述 | +| -------- | -------- | +| BASE_TEST | 基础容值测试 | +| FULL_TEST | 全量容值自检测试 | +| MMI_TEST | MMI容值测试 | +| RUNNING_TEST | 老化容值测试 | +| TEST_TYPE_UNKNOWN | 未知的测试类型 | + + +### InputDevType + + +``` +enum InputDevType +``` + +**描述：** + +定义Input设备类型。 + + | 枚举值 | 描述 | +| -------- | -------- | +| INDEV_TYPE_TOUCH | 触摸屏 | +| INDEV_TYPE_KEY | 物理按键 | +| INDEV_TYPE_KEYBOARD | 键盘 | +| INDEV_TYPE_MOUSE | 鼠标 | +| INDEV_TYPE_BUTTON | 虚拟按键 | +| INDEV_TYPE_CROWN | 表冠 | +| INDEV_TYPE_ENCODER | 自定义编码的特定功能或者事件 | +| INDEV_TYPE_UNKNOWN | 未知输入设备类型 | + + +### PowerStatus + + +``` +enum PowerStatus +``` + +**描述：** + +定义电源状态。 + + | 枚举值 | 描述 | +| -------- | -------- | +| INPUT_RESUME | 正常唤醒 | +| INPUT_SUSPEND | 休眠下电模式 | +| INPUT_LOW_POWER | 休眠低功耗模式 | +| INPUT_POWER_STATUS_UNKNOWN | 未知电源状态 | + + +### RetStatus + + +``` +enum RetStatus +``` + +**描述：** + +定义返回值类型。 + + | 枚举值 | 描述 | +| -------- | -------- | +| INPUT_SUCCESS | 成功 | +| INPUT_FAILURE | 失败 | +| INPUT_INVALID_PARAM | 无效参数 | +| INPUT_NOMEM | 内存不足 | +| INPUT_NULL_PTR | 空指针 | +| INPUT_TIMEOUT | 执行超时 | +| INPUT_UNSUPPORTED | 特性不支持 | + + +## **函数说明** + + +### GetInputInterface() + + +``` +int32_t GetInputInterface (IInputInterface ** interface) +``` + +**描述：** + +Input服务通过调用此接口获取操作Input设备的所有接口。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| interface | 对Input设备进行接口操作的指针，通常在Input服务启动后，通过调用此函数获取Input设备操作接口。 | + +**返回:** + +INPUT_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[RetStatus](#retstatus)。 diff --git a/zh-cn/device-dev/reference/hdi-apis/input__controller_8h.md b/zh-cn/device-dev/reference/hdi-apis/input__controller_8h.md index f89f9a17d20e7b32832471a655cb880bdab0abbd..0036ad9e3661c7213b8f1c7906b0f330453b098a 100644 --- a/zh-cn/device-dev/reference/hdi-apis/input__controller_8h.md +++ b/zh-cn/device-dev/reference/hdi-apis/input__controller_8h.md @@ -3,29 +3,26 @@ ## **概述** -**所属模块:** - -[Input](_input.md) - +描述Input设备业务控制相关的接口声明。 -## **汇总** +**Since**: +1.0 -### 类 +**Version**: - | 类 | 描述 | -| -------- | -------- | -| [InputController](_input_controller.md) | 提供Input设备业务控制相关的接口。 [更多...](_input_controller.md) | +1.0 +**相关模块:** -## **详细描述** +[Input](input.md) -描述Input设备业务控制相关的接口声明。 -**Since：** +## **汇总** -1.0 -**Version：** +### 类 -1.0 + | 名称 | 描述 | +| -------- | -------- | +| [InputController](_input_controller.md) | 提供Input设备业务控制相关的接口。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/input__manager_8h.md b/zh-cn/device-dev/reference/hdi-apis/input__manager_8h.md index 245d9225041d3f59c2e7e344294361e0a36e066b..a93402294a89293abbfed1fc7bc5b74a7844b96a 100644 --- a/zh-cn/device-dev/reference/hdi-apis/input__manager_8h.md +++ b/zh-cn/device-dev/reference/hdi-apis/input__manager_8h.md @@ -3,38 +3,34 @@ ## **概述** -**所属模块:** - -[Input](_input.md) +描述Input设备管理相关的接口声明。 +**Since**: -## **汇总** +1.0 +**Version**: -### 类 - - | 类 | 描述 | -| -------- | -------- | -| [InputManager](_input_manager.md) | 提供Input设备管理相关的接口。 [更多...](_input_manager.md) | -| [IInputInterface](_i_input_interface.md) | 定义用于提供输入设备驱动能力的接口。[更多...](_i_input_interface.md) | +1.0 +**相关模块:** -### 函数 +[Input](input.md) - | 函数 | 描述 | -| -------- | -------- | -| [GetInputInterface](_input.md#getinputinterface) ([IInputInterface](_i_input_interface.md) \*\*interface) | Input服务通过调用此接口获取操作Input设备的所有接口。 [更多...](_input.md#getinputinterface) | -| [ReleaseInputInterface](_input.md#releaseinputinterface) ([IInputInterface](_i_input_interface.md) \*\*inputInterface) | Input服务通过调用此接口释放操作Input设备的所有接口。 [更多...](_input.md#releaseinputinterface) | +## **汇总** -## **详细描述** -描述Input设备管理相关的接口声明。 +### 类 -**Since：** + | 名称 | 描述 | +| -------- | -------- | +| [InputManager](_input_manager.md) | 提供Input设备管理相关的接口。 | +| [IInputInterface](_i_input_interface.md) | 定义用于提供Input设备驱动程序功能的接口。 | -1.0 -**Version：** +### 函数 -1.0 + | 名称 | 描述 | +| -------- | -------- | +| [GetInputInterface](input.md#getinputinterface) ([IInputInterface](_i_input_interface.md) \*\*interface) | Input服务通过调用此接口获取操作Input设备的所有接口。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/input__reporter_8h.md b/zh-cn/device-dev/reference/hdi-apis/input__reporter_8h.md index f537d55f387293772c63fc1446483d6629dc4166..acd441d4b5cea53936c99582849805da425ccfb8 100644 --- a/zh-cn/device-dev/reference/hdi-apis/input__reporter_8h.md +++ b/zh-cn/device-dev/reference/hdi-apis/input__reporter_8h.md @@ -3,29 +3,26 @@ ## **概述** -**所属模块:** - -[Input](_input.md) - +描述Input设备数据上报相关的接口声明。 -## **汇总** +**Since**: +1.0 -### 类 +**Version**: - | 类 | 描述 | -| -------- | -------- | -| [InputReporter](_input_reporter.md) | 提供Input设备数据上报相关的接口。 [更多...](_input_reporter.md) | +1.0 +**相关模块:** -## **详细描述** +[Input](input.md) -描述Input设备数据上报相关的接口声明。 -**Since：** +## **汇总** -1.0 -**Version：** +### 类 -1.0 + | 名称 | 描述 | +| -------- | -------- | +| [InputReporter](_input_reporter.md) | 提供Input设备数据上报相关的接口。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/input__type_8h.md b/zh-cn/device-dev/reference/hdi-apis/input__type_8h.md index 73d10e58c09a8c28292362c505269a7ec79f1371..22fd725d29f3777faa610810224f9626ce38fae7 100644 --- a/zh-cn/device-dev/reference/hdi-apis/input__type_8h.md +++ b/zh-cn/device-dev/reference/hdi-apis/input__type_8h.md @@ -3,66 +3,65 @@ ## **概述** -**所属模块:** +Input设备相关的类型定义。 -[Input](_input.md) +定义了Input设备驱动接口所使用的结构体及枚举类型。 +**Since**: -## **汇总** +1.0 +**Version**: -### 类 +1.0 - | 类 | 描述 | -| -------- | -------- | -| [InputEventPackage](_event_package.md) | Input事件数据包结构。 [更多...](_event_package.md) | -| [InputHotPlugEvent](_input_hotplug_event.md) | 热插拔事件数据包结构。 [更多...](_input_hotplug_event.md) | -| [InputDevDesc](_input_dev_desc.md) | Input设备描述信息。 [更多...](_input_dev_desc.md) | -| [InputEventCb](_input_report_event_cb.md) | 此结构体定义了输入事件回调函数并提供给Input服务使用。 [更多...](_input_report_event_cb.md) | -| [InputHostCb](_input_host_cb.md) | 此结构体定义了热插拔事件上报回调函数并提供给Input服务使用。 [更多...](_input_host_cb.md) | -| [InputDevAbility](_input_dev_ability.md) | Input设备的能力属性，存储支持事件的位图。 [更多...](_input_dev_ability.md) | -| [InputDimensionInfo](_input_dimension_info.md) | Input设备的维度信息。 [更多...](_input_dimension_info.md) | -| [InputDevIdentify](_input_dev_identify.md) | Input设备的识别信息。 [更多...](_input_dev_identify.md) | -| [InputDevAttr](_input_dev_attr.md) | Input设备属性。 [更多...](_input_dev_attr.md) | -| [InputDeviceInfo](_device_info.md) | Input设备基础设备信息。 [更多...](_device_info.md) | -| [InputExtraCmd](_input_extra_cmd.md) | 扩展指令的数据结构。 [更多...](_input_extra_cmd.md) | +**相关模块:** +[Input](input.md) -### 宏定义 - | 宏定义 | 描述 | -| -------- | -------- | -| **MAX_INPUT_DEV_NUM**   32 | Input设备最大数量。 | -| **DEV_NAME_LEN**   64 | Input设备名称长度。 | -| **CHIP_INFO_LEN**   10 | 芯片信息长度。 | -| **CHIP_NAME_LEN**   10 | 芯片名称长度。 | -| **VENDOR_NAME_LEN**   10 | 厂商名称长度。 | -| **SELF_TEST_RESULT_LEN**   20 | 自测结果长度。 | -| **DEV_MANAGER_SERVICE_NAME**   "hdf_input_host" | Input设备节点服务名称。 | -| **DIV_ROUND_UP(nr, d)**  (((nr) + (d) - 1) / (d)) | 向上取整计算公式。| -| **BYTE_HAS_BITS**  8 | 一个字节所包含的比特数。 | -| **BITS_TO_UINT64(count)**  DIV_ROUND_UP(count, BYTE_HAS_BITS * sizeof(uint64_t)) | 比特与64位无符号整数的转换公式。 | -| **HDF_FF_CNT**  (0x7f + 1) | Input设备发送力反馈命令的数量最大值。| +## **汇总** -### 枚举 +### 类 - | 枚举 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [RetStatus](_input.md#retstatus) { INPUT_SUCCESS = 0, INPUT_FAILURE = -1, INPUT_INVALID_PARAM = -2, INPUT_NOMEM = -3,   INPUT_NULL_PTR = -4, INPUT_TIMEOUT = -5, INPUT_UNSUPPORTED = -6 } | 定义返回值类型。 [更多...](_input.md#retstatus) | -| [InputDevType](_input.md#inputdevtype) { INDEV_TYPE_TOUCH, INDEV_TYPE_KEY, INDEV_TYPE_KEYBOARD, INDEV_TYPE_MOUSE,   INDEV_TYPE_BUTTON, INDEV_TYPE_CROWN, INDEV_TYPE_ENCODER, INDEV_TYPE_UNKNOWN } | 定义Input设备类型。 [更多...](_input.md#inputdevtype) | -| [PowerStatus](_input.md#powerstatus) { INPUT_RESUME, INPUT_SUSPEND, INPUT_LOW_POWER, INPUT_POWER_STATUS_UNKNOWN } | 定义电源状态。 [更多...](_input.md#powerstatus) | -| [CapacitanceTest](_input.md#capacitancetest) { BASE_TEST, FULL_TEST, MMI_TEST, RUNNING_TEST,   TEST_TYPE_UNKNOWN } | 定义容值测试类型。 [更多...](_input.md#capacitancetest) | - +| [InputEventPackage](_input_event_package.md) | Input事件数据包结构。 | +| [InputHotPlugEvent](_input_hot_plug_event.md) | 热插拔事件数据包结构。 | +| [InputDevDesc](_input_dev_desc.md) | Input设备描述信息。 | +| [InputEventCb](_input_event_cb.md) | 此结构体定义了输入事件回调函数并提供给Input服务使用。 | +| [InputHostCb](_input_host_cb.md) | 此结构体定义了热插拔事件上报回调函数并提供给Input服务使用。 | +| [InputDevAbility](_input_dev_ability.md) | Input设备的能力属性，存储支持事件的位图。 | +| [InputDimensionInfo](_input_dimension_info.md) | Input设备的维度信息。 | +| [InputDevIdentify](_input_dev_identify.md) | Input设备的识别信息。 | +| [InputDevAttr](_input_dev_attr.md) | Input设备属性。 | +| [InputDeviceInfo](_input_device_info.md) | Input设备基础设备信息。 | +| [InputExtraCmd](_input_extra_cmd.md) | 扩展指令的数据结构。 | -## **详细描述** -Input设备相关的类型定义，定义了Input设备驱动接口所使用的结构体及枚举类型。 +### 宏定义 -**Since：** + | 名称 | 描述 | +| -------- | -------- | +| [MAX_INPUT_DEV_NUM](input.md#maxinputdevnum)   32 | Input设备数量的最大值。 | +| [CHIP_INFO_LEN](input.md#chipinfolen)   10 | 芯片信息长度。 | +| [CHIP_NAME_LEN](input.md#chipnamelen)   10 | 芯片名称长度。 | +| [VENDOR_NAME_LEN](input.md#vendornamelen)   10 | 厂商名称长度。 | +| [DEV_NAME_LEN](input.md#devnamelen)   64 | Input设备名称长度。 | +| [SELF_TEST_RESULT_LEN](input.md#selftestresultlen)   20 | 自测结果长度。 | +| [DEV_MANAGER_SERVICE_NAME](input.md#devmanagerservicename)   "hdf_input_host" | Input设备节点服务名称。 | +| [DIV_ROUND_UP](input.md#divroundup)(nr, d)   (((nr) + (d) - 1) / (d)) | 向上取整计算公式。 | +| [BYTE_HAS_BITS](input.md#bytehasbits)   8 | 一个字节所包含的比特数。 | +| [BITS_TO_UINT64](input.md#bitstouint64)(count)   [DIV_ROUND_UP](input.md#divroundup)(count, [BYTE_HAS_BITS](input.md#bytehasbits) \* sizeof(uint64_t)) | 比特与64位无符号整数的转换公式。 | +| [HDF_FF_CNT](input.md#hdfffcnt)   (0x7f + 1) | Input设备发送力反馈命令的数量最大值。 | -1.0 -**Version：** +### 枚举 -1.0 + | 名称 | 描述 | +| -------- | -------- | +| [RetStatus](input.md#retstatus) { INPUT_SUCCESS = 0, INPUT_FAILURE = -1, INPUT_INVALID_PARAM = -2, INPUT_NOMEM = -3,   INPUT_NULL_PTR = -4, INPUT_TIMEOUT = -5, INPUT_UNSUPPORTED = -6 } | 定义返回值类型。 | +| [InputDevType](input.md#inputdevtype) { INDEV_TYPE_TOUCH, INDEV_TYPE_KEY, INDEV_TYPE_KEYBOARD, INDEV_TYPE_MOUSE,   INDEV_TYPE_BUTTON, INDEV_TYPE_CROWN, INDEV_TYPE_ENCODER, INDEV_TYPE_UNKNOWN } | 定义Input设备类型。 | +| [PowerStatus](input.md#powerstatus) { INPUT_RESUME, INPUT_SUSPEND, INPUT_LOW_POWER, INPUT_POWER_STATUS_UNKNOWN  } | 定义电源状态。 | +| [CapacitanceTest](input.md#capacitancetest) { BASE_TEST, FULL_TEST, MMI_TEST, RUNNING_TEST,   TEST_TYPE_UNKNOWN } | 定义容值测试类型。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/interface_i_activity_changed_callback.md b/zh-cn/device-dev/reference/hdi-apis/interface_i_activity_changed_callback.md new file mode 100644 index 0000000000000000000000000000000000000000..46600f68482f434d220249120b97408550662fae --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/interface_i_activity_changed_callback.md @@ -0,0 +1,51 @@ +# IActivityChangedCallback + + +## **概述** + +定义上报行为事件的回调函数 + +用户在获得订阅的行为事件或获取设备缓存的行为事件前，需要先注册该回调函数。只有当订阅的行为发生时，行为数据才会通过回调函数进行上报。 详情可参考[IActivityInterface](interface_i_activity_interface.md)。 + +**相关模块:** + +[HdiActivityRecognition](activity_recognition.md) + + +## **汇总** + + +### Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [OnActivityChanged](#onactivitychanged) ([in] struct [ActRecognitionEvent](_act_recognition_event.md)[] event) | 定义上报行为事件的回调函数。 | + + +## **成员函数说明** + + +### OnActivityChanged() + + +``` +IActivityChangedCallback::OnActivityChanged ([in] struct ActRecognitionEvent[] event) +``` + +**描述：** + +定义上报行为事件的回调函数。 + +数据会通过该回调函数进行上报。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| event | 上报的数据。详见[ActRecognitionEvent](_act_recognition_event.md)定义。 | + +**返回:** + +如果回调函数上报数据成功，则返回0。 + +如果回调函数上报数据成功，则返回负值。 diff --git a/zh-cn/device-dev/reference/hdi-apis/interface_i_activity_interface.md b/zh-cn/device-dev/reference/hdi-apis/interface_i_activity_interface.md new file mode 100644 index 0000000000000000000000000000000000000000..8893cf8972fa3e4911632190735b53bf0874cd2d --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/interface_i_activity_interface.md @@ -0,0 +1,209 @@ +# IActivityInterface + + +## **概述** + +定义对行为识别进行基本操作的接口。 + +接口包含注册回调函数，取消注册回调函数，获取设备支持的行为类型，获取当前设备的行为类型，订阅和取消订阅行为事件，获取设备缓存的行为事件。 + +**相关模块:** + +[HdiActivityRecognition](activity_recognition.md) + + +## **汇总** + + +### Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [RegisterActRecognitionCallback](#registeractrecognitioncallback) ([in] [IActivityChangedCallback](interface_i_activity_changed_callback.md) callbackObj) | 注册回调函数。 | +| [UnregisterActRecognitionCallback](#unregisteractrecognitioncallback) ([in] [IActivityChangedCallback](interface_i_activity_changed_callback.md) callbackObj) | 取消注册回调函数。 | +| [GetSupportActivity](#getsupportactivity) ([out] String[] activity) | 获取设备支持的行为类型。 | +| [GetCurrentActivity](#getcurrentactivity) ([out] struct [ActRecognitionEvent](_act_recognition_event.md)[] event) | 获取当前的行为事件。 | +| [EnableActRecognitionEvent](#enableactrecognitionevent) ([in] int activity, [in] int eventType, [in] long maxReportLatencyNs, [in] int powerMode) | 订阅某个行为事件。 | +| [DisableActRecognitionEvent](#disableactrecognitionevent) ([in] int activity, [in] int eventType) | 取消订阅某个行为事件。 | +| [FlushActivity](#flushactivity) () | 数据刷新。 | + + +## **成员函数说明** + + +### DisableActRecognitionEvent() + + +``` +IActivityInterface::DisableActRecognitionEvent ([in] int activity, [in] int eventType ) +``` + +**描述：** + +取消订阅某个行为事件。 + +取消订阅某个之前订阅过的行为事件。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| activity | 取消订阅的行为，参考[EnableActRecognitionEvent](#enableactrecognitionevent)接口的activity参数。 | +| eventType | 事件类型，参考[ActRecognitionEventType](activity_recognition.md#actrecognitioneventtype)定义。可以填充1（进入）或2（退出），也可以填充3（同时订阅进入和退出）。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### EnableActRecognitionEvent() + + +``` +IActivityInterface::EnableActRecognitionEvent ([in] int activity, [in] int eventType, [in] long maxReportLatencyNs, [in] int powerMode ) +``` + +**描述：** + +订阅某个行为事件。 + +订阅某个行为事件后，若该行为事件有发生，则会在一定时间内上报。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| activity | 订阅的行为，通过[GetSupportActivity](#getsupportactivity)得到设备支持的所有行为，然后将行为列表中需要订阅的行为下标作为参数填充。 | +| eventType | 事件类型，参考[ActRecognitionEventType](activity_recognition.md#actrecognitioneventtype)定义。可以填充1（进入）或2（退出），也可以填充3（同时订阅进入和退出）。 | +| maxReportLatencyNs | 最大上报时间间隔，单位是纳秒。若该时间间隔内有订阅的行为事件发生，则会上报。若存在多个订阅的行为，取最小的时间间隔。 | +| powerMode | 功耗模式。参考[ActRecognitionPowerMode](activity_recognition.md#actrecognitionpowermode)定义。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### FlushActivity() + + +``` +IActivityInterface::FlushActivity () +``` + +**描述：** + +数据刷新。 + +刷新设备缓存的所有行为事件并上报。 + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### GetCurrentActivity() + + +``` +IActivityInterface::GetCurrentActivity ([out] struct ActRecognitionEvent[] event) +``` + +**描述：** + +获取当前的行为事件。 + +在调用该接口前，必须先要调用[EnableActRecognitionEvent](#enableactrecognitionevent)接口对行为进行使能。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| event | 返回当前设备的行为事件，可能有多个行为共存，详见[ActRecognitionEvent](_act_recognition_event.md)。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### GetSupportActivity() + + +``` +IActivityInterface::GetSupportActivity ([out] String[] activity) +``` + +**描述：** + +获取设备支持的行为类型。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| activity | 参数类型为字符串，输出设备支持的行为类型。 包括："inVehicle" 、"onBicycle"、"walking"、"running"、"still"、"fast_walking"、"high_speed_rail" "unknown"、"elevator"、"relative_still"、"walking_handhold"、"lying_posture"、"plane"、"metro"等。对应[ActRecognitionEventType](activity_recognition.md#actrecognitioneventtype)中的类型。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### RegisterActRecognitionCallback() + + +``` +IActivityInterface::RegisterActRecognitionCallback ([in] IActivityChangedCallback callbackObj) +``` + +**描述：** + +注册回调函数。 + +用户在获得订阅的行为事件或获取设备缓存的行为事件前，需要先注册该回调函数。数据会通过回调函数进行上报。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| callbackObj | 要注册的回调函数，只需成功订阅一次，无需重复订阅。详见[IActivityChangedCallback](interface_i_activity_changed_callback.md)。 | + +**返回:** + +如果注册回调函数成功，则返回0。 + +如果注册回调函数失败，则返回负值。 + + +### UnregisterActRecognitionCallback() + + +``` +IActivityInterface::UnregisterActRecognitionCallback ([in] IActivityChangedCallback callbackObj) +``` + +**描述：** + +取消注册回调函数。 + +取消之前注册的回调函数。当不需要使用行为识别功能，或需要更换回调函数时，需要取消注册回调函数。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| callbackObj | 要取消注册的回调函数，只需成功取消订阅一次，无需重复取消订阅。详见[IActivityChangedCallback](interface_i_activity_changed_callback.md)。 | + +**返回:** + +如果取消注册回调函数成功，则返回0。 + +如果取消注册回调函数失败，则返回负值。 diff --git a/zh-cn/device-dev/reference/hdi-apis/interface_i_battery_callback.md b/zh-cn/device-dev/reference/hdi-apis/interface_i_battery_callback.md index cafdf21cd8e3a4d1eccbe3d8fa82ddb1256470a1..5a744f65c56a8a585963b582dcb42141ea9408c3 100644 --- a/zh-cn/device-dev/reference/hdi-apis/interface_i_battery_callback.md +++ b/zh-cn/device-dev/reference/hdi-apis/interface_i_battery_callback.md @@ -3,30 +3,27 @@ ## **概述** -**所属模块:** - -[Battery](battery.md) - +电池信息的回调。 -## **汇总** +服务创建此回调对象后，可以调用[IBatteryInterface](interface_i_battery_interface.md)的接口注册回调，从而订阅电池信息的变化。 +**Since:** -### Public 成员函数 +3.1 - | Public 成员函数 | 描述 | -| -------- | -------- | -| [Update](#update) ([in] struct [BatteryInfo](_battery_info.md) event) | 电池信息的回调方法。 [更多...](#update) | +**相关模块:** +[Battery](battery.md) -## **详细描述** -电池信息的回调。 +## **汇总** -服务创建此回调对象后，可以调用IBatteryInterface的接口注册回调，从而订阅电池信息的变化。 -**Since：** +### Public 成员函数 -3.1 + | 名称 | 描述 | +| -------- | -------- | +| [Update](#update) ([in] struct [BatteryInfo](_battery_info.md) event) | 电池信息的回调方法。 | ## **成员函数说明** @@ -45,12 +42,12 @@ IBatteryCallback::Update ([in] struct BatteryInfo event) 当电池信息发生变化时，将通过此方法的参数返回给服务。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | event | 电池信息，如电量，电压，健康状态等。 | -**参见：** +**参见:** [BatteryInfo](_battery_info.md) diff --git a/zh-cn/device-dev/reference/hdi-apis/interface_i_battery_interface.md b/zh-cn/device-dev/reference/hdi-apis/interface_i_battery_interface.md index d82964f347df262b4764b633f78815fb8257cf52..89ef2cb9d5b9aadcae91f5f9729f95c98a026430 100644 --- a/zh-cn/device-dev/reference/hdi-apis/interface_i_battery_interface.md +++ b/zh-cn/device-dev/reference/hdi-apis/interface_i_battery_interface.md @@ -3,45 +3,42 @@ ## **概述** -**所属模块:** +获取、订阅电池信息的接口。 -[Battery](battery.md) +服务获取此对象后，可以调用相关的接口获取、订阅电池信息。 +**Since:** -## **汇总** +3.1 +**相关模块:** -### Public 成员函数 +[Battery](battery.md) - | Public 成员函数 | 描述 | -| -------- | -------- | -| [Register](#register) ([in] [IBatteryCallback](interface_i_battery_callback.md) event) | 注册电池信息的回调。 [更多...](#register) | -| [UnRegister](#unregister) () | 取消注册电池信息的回调。 [更多...](#unregister) | -| [ChangePath](#changepath) ([in] String path) | 设置电池信息节点的路径。 [更多...](#changepath) | -| [GetCapacity](#getcapacity) ([out] int capacity) | 获取电池的电量百分比。 [更多...](#getcapacity) | -| [GetVoltage](#getvoltage) ([out] int voltage) | 获取电池的电压，单位微伏。 [更多...](#getvoltage) | -| [GetTemperature](#gettemperature) ([out] int temperature) | 获取电池的充电温度，单位0.1摄氏度。 [更多...](#gettemperature) | -| [GetHealthState](#gethealthstate) ([out] enum [BatteryHealthState](battery.md#batteryhealthstate) healthState) | 获取电池的健康状态。 [更多...](#gethealthstate) | -| [GetPluggedType](#getpluggedtype) ([out] enum [BatteryPluggedType](battery.md#batterypluggedtype) pluggedType) | 获取充电设备类型。 [更多...](#getpluggedtype) | -| [GetChargeState](#getchargestate) ([out] enum [BatteryChargeState](battery.md#batterychargestate) chargeState) | 获取充电状态。 [更多...](#getchargestate) | -| [GetPresent](#getpresent) ([out] boolean present) | 获取是否支持电池或者电池是否在位。 [更多...](#getpresent) | -| [GetTechnology](#gettechnology) ([out] String technology) | 获取电池的技术型号。 [更多...](#gettechnology) | -| [GetTotalEnergy](#gettotalenergy) ([out] int totalEnergy) | 获取电池的总容量。 [更多...](#gettotalenergy) | -| [GetCurrentAverage](#getcurrentaverage) ([out] int curAverage) | 获取电池的平均电流。 [更多...](#getcurrentaverage) | -| [GetCurrentNow](#getcurrentnow) ([out] int curNow) | 获取电池的电流。 [更多...](#getcurrentnow) | -| [GetRemainEnergy](#getremainenergy) ([out] int remainEnergy) | 获取电池的剩余容量。 [更多...](#getremainenergy) | -| [GetBatteryInfo](#getbatteryinfo) ([out] struct [BatteryInfo](_battery_info.md) info) | 获取电池的全部信息。 [更多...](#getbatteryinfo) | - - -## **详细描述** -获取、订阅电池信息的接口。 +## **汇总** -服务获取此对象后，可以调用相关的接口获取、订阅电池信息。 -**Since：** +### Public 成员函数 -3.1 + | 名称 | 描述 | +| -------- | -------- | +| [Register](#register) ([in] [IBatteryCallback](interface_i_battery_callback.md) event) | 注册电池信息的回调。 | +| [UnRegister](#unregister) () | 取消注册电池信息的回调。 | +| [ChangePath](#changepath) ([in] String path) | 设置电池信息节点的路径。 | +| [GetCapacity](#getcapacity) ([out] int capacity) | 获取电池的电量百分比。 | +| [GetVoltage](#getvoltage) ([out] int voltage) | 获取电池的电压，单位微伏。 | +| [GetTemperature](#gettemperature) ([out] int temperature) | 获取电池的充电温度，单位0.1摄氏度。 | +| [GetHealthState](#gethealthstate) ([out] enum [BatteryHealthState](battery.md#batteryhealthstate) healthState) | 获取电池的健康状态。 | +| [GetPluggedType](#getpluggedtype) ([out] enum [BatteryPluggedType](battery.md#batterypluggedtype) pluggedType) | 获取充电设备类型。 | +| [GetChargeState](#getchargestate) ([out] enum [BatteryChargeState](battery.md#batterychargestate) chargeState) | 获取充电状态。 | +| [GetPresent](#getpresent) ([out] boolean present) | 获取是否支持电池或者电池是否在位。 | +| [GetTechnology](#gettechnology) ([out] String technology) | 获取电池的技术型号。 | +| [GetTotalEnergy](#gettotalenergy) ([out] int totalEnergy) | 获取电池的总容量。 | +| [GetCurrentAverage](#getcurrentaverage) ([out] int curAverage) | 获取电池的平均电流。 | +| [GetCurrentNow](#getcurrentnow) ([out] int curNow) | 获取电池的电流。 | +| [GetRemainEnergy](#getremainenergy) ([out] int remainEnergy) | 获取电池的剩余容量。 | +| [GetBatteryInfo](#getbatteryinfo) ([out] struct [BatteryInfo](_battery_info.md) info) | 获取电池的全部信息。 | ## **成员函数说明** @@ -58,13 +55,13 @@ IBatteryInterface::ChangePath ([in] String path) 设置电池信息节点的路径。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | path | 输入参数，电池信息节点的路径。 | -**返回：** +**返回:** HDF_SUCCESS 表示路径设置成功。 @@ -80,17 +77,17 @@ IBatteryInterface::GetBatteryInfo ([out] struct BatteryInfo info) 获取电池的全部信息。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | -| info | 输出参数，电池的全部信息。 | +| info | 电池的全部信息。 | -**返回：** +**返回:** HDF_SUCCESS 表示获取成功。 -**参见：** +**参见:** [BatteryInfo](_battery_info.md) @@ -106,13 +103,13 @@ IBatteryInterface::GetCapacity ([out] int capacity) 获取电池的电量百分比。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | -| capacity | 输出参数，表示电量的百分比值。 | +| capacity | 表示电量的百分比值。 | -**返回：** +**返回:** HDF_SUCCESS 表示获取成功。 @@ -128,17 +125,17 @@ IBatteryInterface::GetChargeState ([out] enum BatteryChargeState chargeState) 获取充电状态。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | -| chargeState | 输出参数，表示充电状态。 | +| chargeState | 表示充电状态。 | -**返回：** +**返回:** HDF_SUCCESS 表示获取成功。 -**参见：** +**参见:** [BatteryChargeState](battery.md#batterychargestate) @@ -154,13 +151,13 @@ IBatteryInterface::GetCurrentAverage ([out] int curAverage) 获取电池的平均电流。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | -| totalEnergy | 输出参数，表示电池的平均电流，单位毫安。 | +| totalEnergy | 表示电池的平均电流，单位毫安。 | -**返回：** +**返回:** HDF_SUCCESS 表示获取成功。 @@ -176,13 +173,13 @@ IBatteryInterface::GetCurrentNow ([out] int curNow) 获取电池的电流。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | -| curNow | 输出参数，表示电池的实时电流，单位毫安。 | +| curNow | 表示电池的实时电流，单位毫安。 | -**返回：** +**返回:** HDF_SUCCESS 表示获取成功。 @@ -198,17 +195,17 @@ IBatteryInterface::GetHealthState ([out] enum BatteryHealthState healthState) 获取电池的健康状态。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | -| healthState | 输出参数，表示电池健康状态。 | +| healthState | 表示电池健康状态。 | -**返回：** +**返回:** HDF_SUCCESS 表示获取成功。 -**参见：** +**参见:** [BatteryHealthState](battery.md#batteryhealthstate) @@ -224,17 +221,17 @@ IBatteryInterface::GetPluggedType ([out] enum BatteryPluggedType pluggedType) 获取充电设备类型。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | -| pluggedType | 输出参数，表示充电设备类型。 | +| pluggedType | 表示充电设备类型。 | -**返回：** +**返回:** HDF_SUCCESS 表示获取成功。 -**参见：** +**参见:** [BatteryPluggedType](battery.md#batterypluggedtype) @@ -250,13 +247,13 @@ IBatteryInterface::GetPresent ([out] boolean present) 获取是否支持电池或者电池是否在位。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | -| present | 输出参数，表示是否支持电池或者电池是否在位。true表示支持或在位，false表示不支持或不在位。 | +| present | 表示是否支持电池或者电池是否在位。true表示支持或在位，false表示不支持或不在位。 | -**返回：** +**返回:** HDF_SUCCESS 表示获取成功。 @@ -272,13 +269,13 @@ IBatteryInterface::GetRemainEnergy ([out] int remainEnergy) 获取电池的剩余容量。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | -| remainEnergy | 输出参数，表示电池的剩余容量，单位毫安时。 | +| remainEnergy | 表示电池的剩余容量，单位毫安时。 | -**返回：** +**返回:** HDF_SUCCESS 表示获取成功。 @@ -294,13 +291,13 @@ IBatteryInterface::GetTechnology ([out] String technology) 获取电池的技术型号。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | -| technology | 输出参数，当前电池技术型号。 | +| technology | 当前电池技术型号。 | -**返回：** +**返回:** HDF_SUCCESS 表示获取成功。 @@ -316,13 +313,13 @@ IBatteryInterface::GetTemperature ([out] int temperature) 获取电池的充电温度，单位0.1摄氏度。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | -| temperature | 输出参数，表示电池温度。 | +| temperature | 表示电池温度。 | -**返回：** +**返回:** HDF_SUCCESS 表示获取成功。 @@ -338,13 +335,13 @@ IBatteryInterface::GetTotalEnergy ([out] int totalEnergy) 获取电池的总容量。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | -| totalEnergy | 输出参数，表示电池的总容量，单位毫安时。 | +| totalEnergy | 表示电池的总容量，单位毫安时。 | -**返回：** +**返回:** HDF_SUCCESS 表示获取成功。 @@ -360,13 +357,13 @@ IBatteryInterface::GetVoltage ([out] int voltage) 获取电池的电压，单位微伏。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | -| voltage | 输出参数，表示电池的电压。 | +| voltage | 表示电池的电压。 | -**返回：** +**返回:** HDF_SUCCESS 表示获取成功。 @@ -382,13 +379,13 @@ IBatteryInterface::Register ([in] IBatteryCallback event) 注册电池信息的回调。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | -| event | 输入参数，服务注册的回调。 | +| event | 服务注册的回调。 | -**返回：** +**返回:** HDF_SUCCESS 表示注册成功。 @@ -404,6 +401,6 @@ IBatteryInterface::UnRegister () 取消注册电池信息的回调。 -**返回：** +**返回:** HDF_SUCCESS 表示取消注册成功。 diff --git a/zh-cn/device-dev/reference/hdi-apis/interface_i_camera_device.md b/zh-cn/device-dev/reference/hdi-apis/interface_i_camera_device.md new file mode 100644 index 0000000000000000000000000000000000000000..dfdbd5798cfab2244627da14132333bc0f9385de --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/interface_i_camera_device.md @@ -0,0 +1,206 @@ +# ICameraDevice + + +## **概述** + +定义Camera设备基本的操作。 + +设置流回调接口、更新控制参数、执行metadata相关操作。 + +**相关模块:** + +[Camera](camera.md) + + +## **汇总** + + +### Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [GetStreamOperator](#getstreamoperator) ([in] [IStreamOperatorCallback](interface_i_stream_operator_callback.md) callbackObj, [out] [IStreamOperator](interface_i_stream_operator.md) streamOperator) | 获取流操作句柄。 | +| [UpdateSettings](#updatesettings) ([in] unsigned char[] settings) | 更新设备控制参数。 | +| [SetResultMode](#setresultmode) ([in] enum [ResultCallbackMode](camera.md#resultcallbackmode) mode) | 设置metadata上报模式，逐帧上报还是设备状态变化时上报。 | +| [GetEnabledResults](#getenabledresults) ([out] int[] results) | 查询使能的metadata。 | +| [EnableResult](#enableresult) ([in] int[] results) | 打开metadata上报开关。 | +| [DisableResult](#disableresult) ([in] int[] results) | 关闭metadata上报开关。 | +| [Close](#close) () | 关闭当前Camera设备。 | + + +## **成员函数说明** + + +### Close() + + +``` +ICameraDevice::Close () +``` + +**描述：** + +关闭当前Camera设备。 + +**参见:** + +OpenCamera + + +### DisableResult() + + +``` +ICameraDevice::DisableResult ([in] int[] results) +``` + +**描述：** + +关闭metadata上报开关。 + +屏蔽之后，相应的**OnResult**不再上报，需[EnableResult](#enableresult)使能之后才上报。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| results | 需要关闭上报开关的metadata。 | + +**返回:** + +NO_ERROR 表示执行成功。 + +其他值表示执行失败，具体错误码查看[CamRetCode](camera.md#camretcode)。 + +**参见:** + +[EnableResult](#enableresult) + + +### EnableResult() + + +``` +ICameraDevice::EnableResult ([in] int[] results) +``` + +**描述：** + +打开metadata上报开关。 + +**OnResult**只上报此接口使能后的metadata。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| results | 需要打开上报开关的多个metadata。 | + +**返回:** + +NO_ERROR 表示执行成功。 + +其他值表示执行失败，具体错误码查看[CamRetCode](camera.md#camretcode)。 + +**参见:** + +[DisableResult](#disableresult) + + +### GetEnabledResults() + + +``` +ICameraDevice::GetEnabledResults ([out] int[] results) +``` + +**描述：** + +查询使能的metadata。 + +[EnableResult](#enableresult)使能需要上报的metadata之后，可通过此接口查询使能的metadata。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| results | 所有使能的metadata的ID数组。 | + +**返回:** + +NO_ERROR 表示执行成功。 + +其他值表示执行失败，具体错误码查看[CamRetCode](camera.md#camretcode)。 + + +### GetStreamOperator() + + +``` +ICameraDevice::GetStreamOperator ([in] IStreamOperatorCallback callbackObj, [out] IStreamOperator streamOperator ) +``` + +**描述：** + +获取流操作句柄。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| callbackObj | 设置流回调接口，详细可查看[IStreamOperatorCallback](interface_i_stream_operator_callback.md)， 用于上报捕获开始[OnCaptureStarted](interface_i_stream_operator_callback.md#oncapturestarted)，捕获结束[OnCaptureEnded](interface_i_stream_operator_callback.md#oncaptureended)， 捕获错误等信息[OnCaptureError](interface_i_stream_operator_callback.md#oncaptureerror)。 | +| streamOperator | 返回流操作句柄。 | + +**返回:** + +NO_ERROR 表示执行成功。 + +其他值表示执行失败，具体错误码查看[CamRetCode](camera.md#camretcode)。 + + +### SetResultMode() + + +``` +ICameraDevice::SetResultMode ([in] enum ResultCallbackMode mode) +``` + +**描述：** + +设置metadata上报模式，逐帧上报还是设备状态变化时上报。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| mode | metadata的上报模式，逐帧上报或者设备状态变化时上报，查看[ResultCallbackMode](camera.md#resultcallbackmode)。 | + +**返回:** + +NO_ERROR 表示执行成功。 + +其他值表示执行失败，具体错误码查看[CamRetCode](camera.md#camretcode)。 + + +### UpdateSettings() + + +``` +ICameraDevice::UpdateSettings ([in] unsigned char[] settings) +``` + +**描述：** + +更新设备控制参数。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| settings | Camera设置参数，包括sensor帧率，3A相关参数等。 | + +**返回:** + +NO_ERROR 表示执行成功。 + +其他值表示执行失败，具体错误码查看[CamRetCode](camera.md#camretcode)。 diff --git a/zh-cn/device-dev/reference/hdi-apis/interface_i_camera_device_callback.md b/zh-cn/device-dev/reference/hdi-apis/interface_i_camera_device_callback.md new file mode 100644 index 0000000000000000000000000000000000000000..c8b090ed64b09494756add9d2d8d374d9d61a407 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/interface_i_camera_device_callback.md @@ -0,0 +1,64 @@ +# ICameraDeviceCallback + + +## **概述** + +定义Camera设备回调操作。 + +设置回调接口、返回错误信息和相关的metadata的回调。 + +**相关模块:** + +[Camera](camera.md) + + +## **汇总** + + +### Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [OnError](#onerror) ([in] enum [ErrorType](camera.md#errortype) type, [in] int errorCode) | 设备发生错误时调用，由调用者实现，用于返回错误信息给调用者。 | +| [OnResult](#onresult) ([in] unsigned long timestamp, [in] unsigned char[] result) | 上报Camera设备相关的metadata的回调，上报方式查看[SetResultMode](interface_i_camera_device.md#setresultmode)。 | + + +## **成员函数说明** + + +### OnError() + + +``` +ICameraDeviceCallback::OnError ([in] enum ErrorType type, [in] int errorCode ) +``` + +**描述：** + +设备发生错误时调用，由调用者实现，用于返回错误信息给调用者。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| type | 错误类型，具体可参考[ErrorType](camera.md#errortype)。 | +| errorCode | 错误码，当前暂未使用。 | + + +### OnResult() + + +``` +ICameraDeviceCallback::OnResult ([in] unsigned long timestamp, [in] unsigned char[] result ) +``` + +**描述：** + +上报Camera设备相关的metadata的回调，上报方式查看[SetResultMode](interface_i_camera_device.md#setresultmode)。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| timestamp | metadata上报的时间戳。 | +| result | 上报的metadata，由[EnableResult](interface_i_camera_device.md#enableresult)指定， 可通过[GetEnabledResults](interface_i_camera_device.md#getenabledresults)查询，[DisableResult](interface_i_camera_device.md#disableresult)关闭上报开关。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/interface_i_camera_host.md b/zh-cn/device-dev/reference/hdi-apis/interface_i_camera_host.md new file mode 100644 index 0000000000000000000000000000000000000000..b0b98e04d60e673f47de01a23ca248f26181de4e --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/interface_i_camera_host.md @@ -0,0 +1,173 @@ +# ICameraHost + + +## **概述** + +定义Camera设备功能操作。 + +设置回调接口、返回设备ID列表、打开并执行Camera设备的相关操作。 + +**相关模块:** + +[Camera](camera.md) + + +## **汇总** + + +### Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [SetCallback](#setcallback) ([in] [ICameraHostCallback](interface_i_camera_host_callback.md) callbackObj) | 设置ICameraHost回调接口，回调函数参考[ICameraHostCallback](interface_i_camera_host_callback.md)。 | +| [GetCameraIds](#getcameraids) ([out] String[] cameraIds) | 获取当前可用的Camera设备ID列表。 | +| [GetCameraAbility](#getcameraability) ([in] String cameraId, [out] unsigned char[] cameraAbility) | 获取Camera设备能力集合。 | +| [OpenCamera](#opencamera) ([in] String cameraId, [in] [ICameraDeviceCallback](interface_i_camera_device_callback.md) callbackObj, [out] [ICameraDevice](interface_i_camera_device.md) device) | 打开Camera设备。 | +| [SetFlashlight](#setflashlight) ([in] String cameraId, [in] boolean isEnable) | 打开或关闭闪光灯。 | + + +## **成员函数说明** + + +### GetCameraAbility() + + +``` +ICameraHost::GetCameraAbility ([in] String cameraId, [out] unsigned char[] cameraAbility ) +``` + +**描述：** + +获取Camera设备能力集合。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| cameraId | 用于指定要操作的Camera设备，通过[GetCameraIds](#getcameraids)获取。 | +| cameraAbility | 返回cameraId对应Camera设备的能力集合。 | + +**返回:** + +NO_ERROR 表示执行成功。 + +其他值表示执行失败，具体错误码查看[CamRetCode](camera.md#camretcode)。 + +**参见:** + +[GetCameraIds](#getcameraids) + + +### GetCameraIds() + + +``` +ICameraHost::GetCameraIds ([out] String[] cameraIds) +``` + +**描述：** + +获取当前可用的Camera设备ID列表。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| cameraIds | 返回当前可用的设备列表。 | + +**返回:** + +NO_ERROR 表示执行成功； + +其他值表示执行失败，具体错误码查看[CamRetCode](camera.md#camretcode)。 + +**参见:** + +[GetCameraAbility](#getcameraability) + + +### OpenCamera() + + +``` +ICameraHost::OpenCamera ([in] String cameraId, [in] ICameraDeviceCallback callbackObj, [out] ICameraDevice device ) +``` + +**描述：** + +打开Camera设备。 + +打开指定的Camera设备，通过此接口可以获取到ICameraDevice对象，通过ICameraDevice对象可以操作具体的Camera设备。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| cameraId | 需要打开的Camera设备ID，可通过[GetCameraIds](#getcameraids)接口获取当前已有Camera设备列表。 | +| callbackObj | Camera设备相关的回调函数，具体参见[ICameraDeviceCallback](interface_i_camera_device_callback.md)。 | +| device | 返回当前要打开的Camera设备ID对应的ICameraDevice对象。 | + +**返回:** + +NO_ERROR 表示执行成功。 + +其他值表示执行失败，具体错误码查看[CamRetCode](camera.md#camretcode)。 + +**参见:** + +[GetCameraIds](#getcameraids) + + +### SetCallback() + + +``` +ICameraHost::SetCallback ([in] ICameraHostCallback callbackObj) +``` + +**描述：** + +设置ICameraHost回调接口，回调函数参考[ICameraHostCallback](interface_i_camera_host_callback.md)。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| callbackObj | 要设置的回调函数。 | + +**返回:** + +NO_ERROR 表示执行成功。 + +其他值表示执行失败，具体错误码查看[CamRetCode](camera.md#camretcode)。 + + +### SetFlashlight() + + +``` +ICameraHost::SetFlashlight ([in] String cameraId, [in] boolean isEnable ) +``` + +**描述：** + +打开或关闭闪光灯。 + +该接口只能由打开cameraId指定Camera设备的调用者调用。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| cameraId | 闪光灯对应的Camera设备ID。 | +| isEnable | 表示是否打开闪光灯，true表示打开，false表示关闭。 | + +**返回:** + +NO_ERROR 表示执行成功。 + +其他值表示执行失败，具体错误码查看[CamRetCode](camera.md#camretcode)。 + +**参见:** + +[GetCameraIds](#getcameraids) diff --git a/zh-cn/device-dev/reference/hdi-apis/interface_i_camera_host_callback.md b/zh-cn/device-dev/reference/hdi-apis/interface_i_camera_host_callback.md new file mode 100644 index 0000000000000000000000000000000000000000..27aa0722f85d4d52c59782e28959586260553bd2 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/interface_i_camera_host_callback.md @@ -0,0 +1,84 @@ +# ICameraHostCallback + + +## **概述** + +定义Camera设备功能回调操作。 + +设置回调接口、返回设备状态编号、闪光灯状态以及相应的事件ID。 + +**相关模块:** + +[Camera](camera.md) + + +## **汇总** + + +### Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [OnCameraStatus](#oncamerastatus) ([in] String cameraId, [in] enum [CameraStatus](camera.md#camerastatus) status) | 用于Camera设备状态变化时上报状态信息给调用者。 | +| [OnFlashlightStatus](#onflashlightstatus) ([in] String cameraId, [in] enum [FlashlightStatus](camera.md#flashlightstatus) status) | 用于在闪光灯状态变化时上报状态信息给调用者。 | +| [OnCameraEvent](#oncameraevent) ([in] String cameraId, [in] enum [CameraEvent](camera.md#cameraevent) event) | 在相机事件发生时调用。 | + + +## **成员函数说明** + + +### OnCameraEvent() + + +``` +ICameraHostCallback::OnCameraEvent ([in] String cameraId, [in] enum CameraEvent event ) +``` + +**描述：** + +在相机事件发生时调用。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| cameraId | 表示相机事件绑定的相机ID。 | +| event | 表示相机事件类型。事件类型查看[CameraEvent](camera.md#cameraevent)。 | + + +### OnCameraStatus() + + +``` +ICameraHostCallback::OnCameraStatus ([in] String cameraId, [in] enum CameraStatus status ) +``` + +**描述：** + +用于Camera设备状态变化时上报状态信息给调用者。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| cameraId | 状态发生变化的Camera设备ID。 | +| status | 最新的设备状态。 | + + +### OnFlashlightStatus() + + +``` +ICameraHostCallback::OnFlashlightStatus ([in] String cameraId, [in] enum FlashlightStatus status ) +``` + +**描述：** + +用于在闪光灯状态变化时上报状态信息给调用者。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| cameraId | 状态发生变化的闪关灯所绑定的Camera设备ID。 | +| status | 最新的闪光灯状态。状态值查看[CameraStatus](camera.md#camerastatus)。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/interface_i_executor.md b/zh-cn/device-dev/reference/hdi-apis/interface_i_executor.md index 32a215289c1ff2bba8aaf381d61f8a6fa930a816..b5b3b5b1702c0cb94e109fd84c07108ea230689a 100644 --- a/zh-cn/device-dev/reference/hdi-apis/interface_i_executor.md +++ b/zh-cn/device-dev/reference/hdi-apis/interface_i_executor.md @@ -3,40 +3,37 @@ ## **概述** -**所属模块:** - -[HdfFaceAuth](_hdf_face_auth.md) - +定义执行器接口，用于获取执行器，获取凭据模版信息，注册人脸特征模版，进行用户人脸认证，删除人脸特征模版等。 -## **汇总** +**Since：** +3.2 -### Public 成员函数 +**Version:** - | Public 成员函数 | 描述 | -| -------- | -------- | -| [GetExecutorInfo](#getexecutorinfo) ([out] struct [ExecutorInfo](_executor_info.md) executorInfo) | 获取执行器信息，人脸认证服务将执行器注册到用户认证框架时需要通过该接口获取对应信息。 [更多...](#getexecutorinfo) | -| [GetTemplateInfo](#gettemplateinfo) ([in] unsigned long templateId, [out] struct [TemplateInfo](_template_info.md) templateInfo) | 获取凭据模版信息。 [更多...](#gettemplateinfo) | -| [OnRegisterFinish](#onregisterfinish-12) ([in] unsigned long[] templateIdList, [in] unsigned char[] frameworkPublicKey, [in] unsigned char[] extraInfo) | 完成执行器注册，对人脸特征模版进行对账，用于删除无效的人脸特征模板及相关信息。 [更多...](#onregisterfinish-12) | -| [Enroll](#enroll) ([in] unsigned long scheduleId, [in] unsigned char[] extraInfo, [in] [IExecutorCallback](interface_i_executor_callback.md) callbackObj) | 注册人脸特征模版。 [更多...](#enroll) | -| [Authenticate](#authenticate) ([in] unsigned long scheduleId, [in] unsigned long[] templateIdList, [in] unsigned char[] extraInfo, [in] [IExecutorCallback](interface_i_executor_callback.md) callbackObj) | 人脸认证。 [更多...](#authenticate) | -| [Identify](#identify) ([in] unsigned long scheduleId, [in] unsigned char[] extraInfo, [in] [IExecutorCallback](interface_i_executor_callback.md) callbackObj) | 人脸识别。 [更多...](#identify) | -| [Delete](#delete) ([in] unsigned long[] templateIdList) | 删除人脸特征模版。 [更多...](#delete) | -| [Cancel](#cancel) ([in] unsigned long scheduleId) | 取消操作请求。 [更多...](#cancel) | -| [SendCommand](#sendcommand) ([in] int commandId, [in] unsigned char[] extraInfo, [in] [IExecutorCallback](interface_i_executor_callback.md) callbackObj) | 发送人脸认证功能相关操作命令。 [更多...](#sendcommand) | +1.0 +**所属模块:** -## **详细描述** +[HdfFaceAuth](_hdf_face_auth.md) -定义执行器接口，用于获取执行器，获取凭据模版信息，注册人脸特征模版，进行用户人脸认证，删除人脸特征模版等。 -**Since：** +## **汇总** -3.2 -**Version:** +### Public 成员函数 -1.0 + | 名称 | 描述 | +| -------- | -------- | +| [GetExecutorInfo](#getexecutorinfo)([out] struct ExecutorInfo executorInfo) | 获取执行器信息，人脸认证服务将执行器注册到用户认证框架时需要通过该接口获取对应信息。 | +| [GetTemplateInfo](#gettemplateinfo)([in] unsigned long templateId, [out] struct TemplateInfo templateInfo) | 获取凭据模版信息。 | +| [OnRegisterFinish](#onregisterfinish)([in] unsigned long[] templateIdList, [in] unsigned char[] frameworkPublicKey, [in] unsigned char[] extraInfo) | 完成执行器注册，对人脸特征模版进行对账，用于删除无效的人脸特征模板及相关信息。 | +| [Enroll](#enroll)([in] unsigned long scheduleId, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj) | 注册人脸特征模版。 | +| [Authenticate](#authenticate)([in] unsigned long scheduleId, [in] unsigned long[] templateIdList, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj) | 人脸认证。 | +| [Identify](#identify)([in] unsigned long scheduleId, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj) | 人脸识别。 | +| [Delete](#delete)([in] unsigned long[] templateIdList) | 删除人脸特征模版。 | +| [Cancel](#cancel)([in] unsigned long scheduleId) | 取消操作请求。 | +| [SendCommand](#sendcommand)([in] int commandId, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj) | 发送人脸认证功能相关操作命令。 | ## **成员函数说明** @@ -218,7 +215,7 @@ IExecutor::Identify ([in] unsigned long scheduleId, [in] unsigned char[] extraIn 非0 表示操作失败。 -### OnRegisterFinish() [1/2] +### OnRegisterFinish() ``` @@ -285,7 +282,7 @@ IExecutor::SendCommand ([in] int commandId, [in] unsigned char[] extraInfo, [in] | 名称 | 描述 | | -------- | -------- | -| commandId | 操作命令ID[CommandId](_hdf_pin_auth.md#commandid)。 | +| commandId | 操作命令ID。 | | extraInfo | 其他相关信息，用于支持信息扩展。 | | callbackObj | 回调对象[IExecutorCallback](interface_i_executor_callback.md)。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/interface_i_executor_callback.md b/zh-cn/device-dev/reference/hdi-apis/interface_i_executor_callback.md index 356027165c4b9f5acaef72e9ca8b398f881cf954..639f188b4cbedf4cbf7d4d1efd0884f6578e70d1 100644 --- a/zh-cn/device-dev/reference/hdi-apis/interface_i_executor_callback.md +++ b/zh-cn/device-dev/reference/hdi-apis/interface_i_executor_callback.md @@ -3,43 +3,40 @@ ## **概述** -**所属模块:** - -[HdfFaceAuth](_hdf_face_auth.md) - +定义异步API接口回调，用于返回异步接口的请求处理结果和获取信息。使用细节见[IExecutor](interface_i_executor.md)。 -## **汇总** +**Since：** +3.2 -### Public 成员函数 +**Version:** - | Public 成员函数 | 描述 | -| -------- | -------- | -| [OnResult](#onresult) ([in] int result, [in] unsigned char[] extraInfo) | 定义操作结果回调函数。 [更多...](#onresult) | -| [OnTip](#ontip) ([in] int acquire, [in] unsigned char[] extraInfo) | 定义操作过程信息反馈回调函数。 [更多...](#ontip) | +1.0 +**所属模块:** -## **详细描述** +[HdfFaceAuth](_hdf_face_auth.md) -定义异步API接口回调，用于返回异步接口的请求处理结果和获取信息。使用细节见[IExecutor](interface_i_executor.md)。 -**Since：** +## **汇总** -3.2 -**Version:** +### Public 成员函数 -1.0 + | 名称 | 描述 | +| -------- | -------- | +| [OnResult](#onresult) ([in] int result, [in] unsigned char[] extraInfo) | 定义操作结果回调函数。 | +| [OnAcquireInfo](#onacquireinfo) ([in] int acquire, [in] unsigned char[] extraInfo) | 定义操作过程信息反馈回调函数。 | ## **成员函数说明** -### OnTip() +### OnAcquireInfo() ``` -IExecutorCallback::OnTip ([in] int tip, [in] unsigned char[] extraInfo ) +IExecutorCallback::OnAcquireInfo ([in] int acquire, [in] unsigned char[] extraInfo ) ``` **描述：** @@ -50,7 +47,7 @@ IExecutorCallback::OnTip ([in] int tip, [in] unsigned char[] extraInfo ) | 名称 | 描述 | | -------- | -------- | -| tip | 提示信息编码[FaceTipsCode](_hdf_face_auth.md#facetipscode)。 | +| acquire | 提示信息编码[FaceTipsCode](_hdf_face_auth.md#facetipscode)。 | | extraInfo | 其他相关信息，用于支持信息扩展。 | **返回：** diff --git a/zh-cn/device-dev/reference/hdi-apis/interface_i_face_auth_interface.md b/zh-cn/device-dev/reference/hdi-apis/interface_i_face_auth_interface.md index 32041928f7fe5e3bbd82e4861cb8d86733d4bc7d..d92d37b17762985a90a29d72c49aaa8c742e2c52 100644 --- a/zh-cn/device-dev/reference/hdi-apis/interface_i_face_auth_interface.md +++ b/zh-cn/device-dev/reference/hdi-apis/interface_i_face_auth_interface.md @@ -3,32 +3,29 @@ ## **概述** -**所属模块:** - -[HdfFaceAuth](_hdf_face_auth.md) - +定义获取人脸认证驱动的执行器列表接口。 -## **汇总** +**Since：** +3.2 -### Public 成员函数 +**Version:** - | Public 成员函数 | 描述 | -| -------- | -------- | -| [GetExecutorList](#getexecutorlist) ([out] [IExecutor](interface_i_executor.md)[] executorList) | 获取执行器列表，人脸认证服务进程启动进行初始化操作时通过该接口获取人脸认证驱动支持的执行器列表。 [更多...](#getexecutorlist) | +1.0 +**所属模块:** -## **详细描述** +[HdfFaceAuth](_hdf_face_auth.md) -定义获取人脸认证驱动的执行器列表接口。 -**Since：** +## **汇总** -3.2 -**Version:** +### Public 成员函数 -1.0 + | 名称 | 描述 | +| -------- | -------- | +| [GetExecutorList](#getexecutorlist) ([out] IExecutor[] executorList) | 获取执行器列表，人脸认证服务进程启动进行初始化操作时通过该接口获取人脸认证驱动支持的执行器列表。 | ## **成员函数说明** diff --git a/zh-cn/device-dev/reference/hdi-apis/interface_i_light_interface.md b/zh-cn/device-dev/reference/hdi-apis/interface_i_light_interface.md new file mode 100644 index 0000000000000000000000000000000000000000..5a894832572b1c291dfe7c50bd28f2986c48683d --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/interface_i_light_interface.md @@ -0,0 +1,138 @@ +# ILightInterface + + +## **概述** + +提供灯模块基本操作接口。 + +操作包括获取灯的信息、打开或关闭灯、设置灯的亮度或闪烁模式。 + +**Since:** + +3.1 + +**Version:** + +1.0 + +**相关模块:** + +[Light](light.md) + + +## **汇总** + + +### Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [GetLightInfo](#getlightinfo) ([out] struct [HdfLightInfo](_hdf_light_info.md)[] info) | 获取当前系统中所有类型的灯信息。 | +| [TurnOnLight](#turnonlight) ([in] int lightId, [in] struct [HdfLightEffect](_hdf_light_effect.md) effect) | 根据指定的灯类型ID打开列表中的可用灯。 | +| [TurnOnMultiLights](#turnonmultilights) ([in] int lightId, [in] struct [HdfLightColor](_hdf_light_color.md)[] colors) | 根据指定的灯类型ID打开相应灯中包含的多个子灯。 | +| [TurnOffLight](#turnofflight) ([in] int lightId) | 根据指定的灯类型ID关闭列表中的可用灯。 | + + +## **成员函数说明** + + +### GetLightInfo() + + +``` +ILightInterface::GetLightInfo ([out] struct HdfLightInfo[] info) +``` + +**描述：** + +获取当前系统中所有类型的灯信息。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| info | 表示指向灯信息的二级指针。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### TurnOffLight() + + +``` +ILightInterface::TurnOffLight ([in] int lightId) +``` + +**描述：** + +根据指定的灯类型ID关闭列表中的可用灯。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| lightId | 表示灯类型ID，详见[HdfLightId](light.md#hdflightid)。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### TurnOnLight() + + +``` +ILightInterface::TurnOnLight ([in] int lightId, [in] struct HdfLightEffect effect ) +``` + +**描述：** + +根据指定的灯类型ID打开列表中的可用灯。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| lightId | 表示灯类型ID。详见[HdfLightId](light.md#hdflightid)。 | +| effect | 表示指向灯效果的指针，如果lightbrightness字段为0时， 灯的亮度根据HCS配置的默认亮度进行设置。详见[HdfLightEffect](_hdf_light_effect.md)。 | + +**返回:** + +如果操作成功，则返回0。 + +如果不支持灯类型ID，则返回-1。 + +如果不支持闪烁设置，则返回-2。 + +如果不支持亮度设置，则返回-3。 + + +### TurnOnMultiLights() + + +``` +ILightInterface::TurnOnMultiLights ([in] int lightId, [in] struct HdfLightColor[] colors ) +``` + +**描述：** + +根据指定的灯类型ID打开相应灯中包含的多个子灯。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| lightId | 表示灯类型ID，详见[HdfLightId](light.md#hdflightid)。 | +| colors | 多个子灯对应的颜色和亮度, 详见[HdfLightColor](_hdf_light_color.md)。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 diff --git a/zh-cn/device-dev/reference/hdi-apis/interface_i_motion_callback.md b/zh-cn/device-dev/reference/hdi-apis/interface_i_motion_callback.md new file mode 100644 index 0000000000000000000000000000000000000000..39c11481f893e1741b5681eaf8d8be330cb2748a --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/interface_i_motion_callback.md @@ -0,0 +1,53 @@ +# IMotionCallback + + +## **概述** + +定义上报手势识别数据回调函数。 + +手势识别用户在订阅手势识别数据时需要注册这个回调函数，只有当使能手势识别后，手势识别数据用户才会收到手势识别数据。 详情可参考[IMotionInterface](interface_i_motion_interface.md)。 + +**Since:** + +3.2 + +**相关模块:** + +[Motion](motion.md) + + +## **汇总** + + +### Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [OnDataEvent](#ondataevent) ([in] struct [HdfMotionEvent](_hdf_motion_event.md) event) | 定义上报手势识别数据回调函数。 | + + +## **成员函数说明** + + +### OnDataEvent() + + +``` +IMotionCallback::OnDataEvent ([in] struct HdfMotionEvent event) +``` + +**描述：** + +定义上报手势识别数据回调函数。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| event | 回调函数上报的数据。详见[HdfMotionEvent](_hdf_motion_event.md)。 | + +**返回:** + +如果回调函数上报数据成功，则返回0。 + +如果回调函数上报数据失败，则返回负值。 diff --git a/zh-cn/device-dev/reference/hdi-apis/interface_i_motion_interface.md b/zh-cn/device-dev/reference/hdi-apis/interface_i_motion_interface.md new file mode 100644 index 0000000000000000000000000000000000000000..80d8001ff267ae63338d19099a0887fc3868479c --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/interface_i_motion_interface.md @@ -0,0 +1,118 @@ +# IMotionInterface + + +## **概述** + +提供Motion设备基本控制操作接口。 + +接口提供使能/去使能手势识别、订阅/取消订阅手势识别数据功能。 + +**相关模块:** + +[Motion](motion.md) + + +## **汇总** + + +### Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [EnableMotion](#enablemotion) ([in] int motionType) | 使能手势识别。 | +| [DisableMotion](#disablemotion) ([in] int motionType) | 去使能手势识别。 | +| [Register](#register) ([in] [IMotionCallback](interface_i_motion_callback.md) callbackObj) | 订阅者注册手势识别数据回调函数，如果注册成功，系统会将获取到的手势识别数据上报给订阅者。 | +| [Unregister](#unregister) ([in] [IMotionCallback](interface_i_motion_callback.md) callbackObj) | 订阅者取消注册手势识别数据回调函数。 | + + +## **成员函数说明** + + +### DisableMotion() + + +``` +IMotionInterface::DisableMotion ([in] int motionType) +``` + +**描述：** + +去使能手势识别。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| motionType | 手势识别类型，详见[HdfMotionTypeTag](motion.md#hdfmotiontypetag)。 | + + +### EnableMotion() + + +``` +IMotionInterface::EnableMotion ([in] int motionType) +``` + +**描述：** + +使能手势识别。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| motionType | 手势识别类型，详见[HdfMotionTypeTag](motion.md#hdfmotiontypetag)。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### Register() + + +``` +IMotionInterface::Register ([in] IMotionCallback callbackObj) +``` + +**描述：** + +订阅者注册手势识别数据回调函数，如果注册成功，系统会将获取到的手势识别数据上报给订阅者。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| callbackObj | 要注册的回调函数，只需成功订阅一次，无需重复订阅。详见[IMotionCallback](interface_i_motion_callback.md)。 | + +**返回:** + +如果注册回调函数成功，则返回0。 + +如果注册回调函数失败，则返回负值。 + + +### Unregister() + + +``` +IMotionInterface::Unregister ([in] IMotionCallback callbackObj) +``` + +**描述：** + +订阅者取消注册手势识别数据回调函数。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| callbackObj | 要取消注册的回调函数，只需成功取消订阅一次，无需重复取消订阅。详见[IMotionCallback](interface_i_motion_callback.md)。 | + +**返回:** + +如果取消注册回调函数成功，则返回0。 + +如果取消注册回调函数失败，则返回负值。 diff --git a/zh-cn/device-dev/reference/hdi-apis/interface_i_offline_stream_operator.md b/zh-cn/device-dev/reference/hdi-apis/interface_i_offline_stream_operator.md new file mode 100644 index 0000000000000000000000000000000000000000..c70eae568751d3d73bf45d1c734b8e3b092db0e9 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/interface_i_offline_stream_operator.md @@ -0,0 +1,97 @@ +# IOfflineStreamOperator + + +## **概述** + +定义Camera设备离线流操作。 + +对Camera设备离线流执行取消捕获和释放操作。 + +**相关模块:** + +[Camera](camera.md) + + +## **汇总** + + +### Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [CancelCapture](#cancelcapture) ([in] int captureId) | 取消捕获请求。 | +| [ReleaseStreams](#releasestreams) ([in] int[] streamIds) | 释放离线流。 | +| [Release](#release) () | 释放所有离线流。 释放流的前置条件：
1. 所有单次捕获的Capture处理完成。
2. 所有连续捕获请求都已经被CancelCapture。 | + + +## **成员函数说明** + + +### CancelCapture() + + +``` +IOfflineStreamOperator::CancelCapture ([in] int captureId) +``` + +**描述：** + +取消捕获请求。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| captureId | 用于标识要取消的捕获请求。 | + +**返回:** + +NO_ERROR 表示执行成功。 + +其他值表示执行失败，具体错误码查看[CamRetCode](camera.md#camretcode)。 + + +### Release() + + +``` +IOfflineStreamOperator::Release () +``` + +**描述：** + +释放所有离线流。 释放流的前置条件： + +1. 所有单次捕获的Capture处理完成。 + +2. 所有连续捕获请求都已经被CancelCapture。 + +**返回:** + +NO_ERROR 表示执行成功。 + +其他值表示执行失败，具体错误码查看[CamRetCode](camera.md#camretcode)。 + + +### ReleaseStreams() + + +``` +IOfflineStreamOperator::ReleaseStreams ([in] int[] streamIds) +``` + +**描述：** + +释放离线流。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| streamIds | 用于标识要释放的多条离线流。 | + +**返回:** + +NO_ERROR 表示执行成功。 + +其他值表示执行失败，具体错误码查看[CamRetCode](camera.md#camretcode)。 diff --git a/zh-cn/device-dev/reference/hdi-apis/interface_i_pin_auth_interface.md b/zh-cn/device-dev/reference/hdi-apis/interface_i_pin_auth_interface.md index c6d110537f39b948361d104ee1ab4978f141eca3..ae16e55ecdb3b44ad1329ab9a15d214e39c39a31 100644 --- a/zh-cn/device-dev/reference/hdi-apis/interface_i_pin_auth_interface.md +++ b/zh-cn/device-dev/reference/hdi-apis/interface_i_pin_auth_interface.md @@ -3,32 +3,29 @@ ## **概述** -**所属模块:** - -[HdfPinAuth](_hdf_pin_auth.md) - +定义获取口令认证驱动的执行器列表接口。 -## **汇总** +**Since：** +3.2 -### Public 成员函数 +**Version:** - | Public 成员函数 | 描述 | -| -------- | -------- | -| [GetExecutorList](#getexecutorlist) ([out] [IExecutor](interface_pin_i_executor.md)[] executorList) | 获取执行器列表，口令认证服务进程启动进行初始化操作时通过该接口获取口令认证驱动支持的执行器列表。 [更多...](#getexecutorlist) | +1.0 +**所属模块:** -## **详细描述** +[HdfPinAuth](_hdf_pin_auth.md) -定义获取口令认证驱动的执行器列表接口。 -**Since：** +## **汇总** -3.2 -**Version:** +### Public 成员函数 -1.0 + | 名称 | 描述 | +| -------- | -------- | +| [GetExecutorList](#getexecutorlist) ([out] IExecutor[] executorList) | 获取执行器列表，口令认证服务进程启动进行初始化操作时通过该接口获取口令认证驱动支持的执行器列表。 | ## **成员函数说明** diff --git a/zh-cn/device-dev/reference/hdi-apis/interface_i_power_hdi_callback.md b/zh-cn/device-dev/reference/hdi-apis/interface_i_power_hdi_callback.md index 993bd9ed6101f16f848009998b1088adb9a1f655..0aaecf4cb4a925d88ce4d78fbf2b37193886e0ad 100644 --- a/zh-cn/device-dev/reference/hdi-apis/interface_i_power_hdi_callback.md +++ b/zh-cn/device-dev/reference/hdi-apis/interface_i_power_hdi_callback.md @@ -3,31 +3,28 @@ ## **概述** -**所属模块:** - -[Power](power.md) - +休眠/唤醒状态的回调。 -## **汇总** +服务创建此回调对象后，可以调用IPowerInterface的接口注册回调，从而订阅休眠/唤醒状态的变化。 +**Since：** -### Public 成员函数 +3.1 - | Public 成员函数 | 描述 | -| -------- | -------- | -| [OnSuspend](#onsuspend) () | 休眠状态的回调方法。 [更多...](#onsuspend) | -| [OnWakeup](#onwakeup) () | 唤醒状态的回调方法。 [更多...](#onwakeup) | +**相关模块:** +[Power](power.md) -## **详细描述** -休眠/唤醒状态的回调。 +## **汇总** -服务创建此回调对象后，可以调用IPowerInterface的接口注册回调，从而订阅休眠/唤醒状态的变化。 -**Since：** +### Public 成员函数 -3.1 + | 名称 | 描述 | +| -------- | -------- | +| [OnSuspend](#onsuspend) () | 休眠状态的回调方法。 | +| [OnWakeup](#onwakeup) () | 唤醒状态的回调方法。 | ## **成员函数说明** diff --git a/zh-cn/device-dev/reference/hdi-apis/interface_i_power_interface.md b/zh-cn/device-dev/reference/hdi-apis/interface_i_power_interface.md index 73d549879069aba5d3d0b90d89cc12631fda7d41..5118655d14fb8dad970f9ac638a5d680662349cc 100644 --- a/zh-cn/device-dev/reference/hdi-apis/interface_i_power_interface.md +++ b/zh-cn/device-dev/reference/hdi-apis/interface_i_power_interface.md @@ -3,36 +3,33 @@ ## **概述** -**所属模块:** - -[Power](power.md) - +休眠/唤醒操作、订阅休眠/唤醒状态、运行锁管理的接口。 -## **汇总** +服务获取此对象后，可以调用相关的接口对设备进行休眠/唤醒、订阅休眠/唤醒状态和管理运行锁。 +**Since：** -### Public 成员函数 +3.1 - | Public 成员函数 | 描述 | -| -------- | -------- | -| [RegisterCallback](#registercallback) ([in] [IPowerHdiCallback](interface_i_power_hdi_callback.md) ipowerHdiCallback) | 注册休眠/唤醒状态的回调。 [更多...](#registercallback) | -| [StartSuspend](#startsuspend) () | 执行设备休眠操作。 [更多...](#startsuspend) | -| [StopSuspend](#stopsuspend) () | 执行设备唤醒操作。 [更多...](#stopsuspend) | -| [ForceSuspend](#forcesuspend) () | 执行设备强制休眠操作。 [更多...](#forcesuspend) | -| [SuspendBlock](#suspendblock) ([in] String name) | 打开运行锁，阻止休眠。 [更多...](#suspendblock) | -| [SuspendUnblock](#suspendunblock) ([in] String name) | 关闭运行锁，取消阻止休眠。 [更多...](#suspendunblock) | -| [PowerDump](#powerdump) ([out] String info) | 获取电源的Dump信息。 [更多...](#powerdump) | +**相关模块:** +[Power](power.md) -## **详细描述** -休眠/唤醒操作、订阅休眠/唤醒状态、运行锁管理的接口。 +## **汇总** -服务获取此对象后，可以调用相关的接口对设备进行休眠/唤醒、订阅休眠/唤醒状态和管理运行锁。 -**Since：** +### Public 成员函数 -3.1 + | 名称 | 描述 | +| -------- | -------- | +| [RegisterCallback](#registercallback) ([in] [IPowerHdiCallback](interface_i_power_hdi_callback.md) ipowerHdiCallback) | 注册休眠/唤醒状态的回调。 | +| [StartSuspend](#startsuspend) () | 执行设备休眠操作。 | +| [StopSuspend](#stopsuspend) () | 执行设备唤醒操作。 | +| [ForceSuspend](#forcesuspend) () | 执行设备强制休眠操作。 | +| [SuspendBlock](#suspendblock) ([in] String name) | 打开运行锁，阻止休眠。 | +| [SuspendUnblock](#suspendunblock) ([in] String name) | 关闭运行锁，取消阻止休眠。 | +| [PowerDump](#powerdump) ([out] String info) | 获取电源的Dump信息。 | ## **成员函数说明** @@ -49,7 +46,7 @@ IPowerInterface::ForceSuspend () 执行设备强制休眠操作。 -**返回：** +**返回:** HDF_SUCCESS 表示操作成功。 @@ -65,13 +62,13 @@ IPowerInterface::PowerDump ([out] String info) 获取电源的Dump信息。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | info | 输出参数，电源的Dump信息。 | -**返回：** +**返回:** HDF_SUCCESS 表示操作成功。 @@ -87,17 +84,17 @@ IPowerInterface::RegisterCallback ([in] IPowerHdiCallback ipowerHdiCallback) 注册休眠/唤醒状态的回调。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | ipowerHdiCallback | 输入参数，服务注册的回调。 | -**返回：** +**返回:** HDF_SUCCESS 表示注册成功。 -**参见：** +**参见:** [IPowerHdiCallback](interface_i_power_hdi_callback.md) @@ -113,7 +110,7 @@ IPowerInterface::StartSuspend () 执行设备休眠操作。 -**返回：** +**返回:** HDF_SUCCESS 表示操作成功。 @@ -129,7 +126,7 @@ IPowerInterface::StopSuspend () 执行设备唤醒操作。 -**返回：** +**返回:** HDF_SUCCESS 表示操作成功。 @@ -145,13 +142,13 @@ IPowerInterface::SuspendBlock ([in] String name) 打开运行锁，阻止休眠。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | name | 输入参数，运行锁的名称。 | -**返回：** +**返回:** HDF_SUCCESS 表示操作成功。 @@ -167,12 +164,12 @@ IPowerInterface::SuspendUnblock ([in] String name) 关闭运行锁，取消阻止休眠。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | name | 输入参数，运行锁的名称。 | -**返回：** +**返回:** HDF_SUCCESS 表示操作成功。 diff --git a/zh-cn/device-dev/reference/hdi-apis/interface_i_sensor_callback.md b/zh-cn/device-dev/reference/hdi-apis/interface_i_sensor_callback.md new file mode 100644 index 0000000000000000000000000000000000000000..56699b4b547f0a277e721dc1a186a6f1da74bae3 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/interface_i_sensor_callback.md @@ -0,0 +1,49 @@ +# ISensorCallback + + +## **概述** + +定义用于上报传感器数据的回调函数。 + +传感器用户订阅传感器数据，只在使能传感器后，传感器数据订阅者才能接收传感器数据。 + +**相关模块:** + +[Sensor](sensor.md) + + +## **汇总** + + +### Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [OnDataEvent](#ondataevent) ([in] struct [HdfSensorEvents](_hdf_sensor_events.md) event) | 定义上报传感器数据的功能。 | + + +## **成员函数说明** + + +### OnDataEvent() + + +``` +ISensorCallback::OnDataEvent ([in] struct HdfSensorEvents event) +``` + +**描述：** + +定义上报传感器数据的功能。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| event | 上报的传感器数据，详见[HdfSensorEvents](_hdf_sensor_events.md)。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 diff --git a/zh-cn/device-dev/reference/hdi-apis/interface_i_sensor_interface.md b/zh-cn/device-dev/reference/hdi-apis/interface_i_sensor_interface.md new file mode 100644 index 0000000000000000000000000000000000000000..be4ea74d8120858005132020f305985b2f322c06 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/interface_i_sensor_interface.md @@ -0,0 +1,238 @@ +# ISensorInterface + + +## **概述** + +提供Sensor设备基本控制操作接口。 + +操作包括获取传感器设备信息、订阅/取消订阅传感器数据、使能/去使能传感器、设置传感器模式、设置传感器精度、量程等可选配置接口定义。 + +**Since：** + +2.2 + +**Version:** + +1.0 + +**相关模块:** + +[Sensor](sensor.md) + + +## **汇总** + + +### Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [GetAllSensorInfo](#getallsensorinfo) ([out] struct [HdfSensorInformation](_hdf_sensor_information.md)[] info) | 获取当前系统中所有类型的传感器信息。 | +| [Enable](#enable) ([in] int sensorId) | 根据传感器设备类型标识使能传感器信息列表里存在的设备，只有数据订阅者使能传感器后，才能获取订阅的传感器数据。 | +| [Disable](#disable) ([in] int sensorId) | 根据传感器设备类型标识去使能传感器信息列表里存在的设备。 | +| [SetBatch](#setbatch) ([in] int sensorId,[in] long samplingInterval, [in] long reportInterval) | 设置指定传感器的数据上报模式，不同的工作模式，上报数据的方式不同。 | +| [SetMode](#setmode) ([in] int sensorId, [in] int mode) | 设置指定传感器数据上报模式。 | +| [SetOption](#setoption) ([in] int sensorId, [in] unsigned int option) | 设置指定传感器量程、精度等可选配置。 | +| [Register](#register) ([in] int groupId, [in] [ISensorCallback](interface_i_sensor_callback.md) callbackObj) | 订阅者注册传感器数据回调函数，系统会将获取到的传感器数据上报给订阅者。 | +| [Unregister](#unregister) ([in] int groupId, [in] [ISensorCallback](interface_i_sensor_callback.md) callbackObj) | 订阅者取消注册传感器数据回调函数。 | + + +## **成员函数说明** + + +### Disable() + + +``` +ISensorInterface::Disable ([in] int sensorId) +``` + +**描述：** + +根据传感器设备类型标识去使能传感器信息列表里存在的设备。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| sensorId | 唯一标识一个传感器设备类型，详见[HdfSensorTypeTag](sensor.md#hdfsensortypetag)。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### Enable() + + +``` +ISensorInterface::Enable ([in] int sensorId) +``` + +**描述：** + +根据传感器设备类型标识使能传感器信息列表里存在的设备，只有数据订阅者使能传感器后，才能获取订阅的传感器数据。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| sensorId | 唯一标识一个传感器设备类型，详见[HdfSensorTypeTag](sensor.md#hdfsensortypetag)。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### GetAllSensorInfo() + + +``` +ISensorInterface::GetAllSensorInfo ([out] struct HdfSensorInformation[] info) +``` + +**描述：** + +获取当前系统中所有类型的传感器信息。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| 输出系统中注册的所有传感器信息，一种类型传感器信息包括传感器名字、设备厂商、 | 固件版本号、硬件版本号、传感器类型编号、传感器标识、最大量程、精度、功耗，详见[HdfSensorInformation](_hdf_sensor_information.md)。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### Register() + + +``` +ISensorInterface::Register ([in] int groupId, [in] ISensorCallback callbackObj ) +``` + +**描述：** + +订阅者注册传感器数据回调函数，系统会将获取到的传感器数据上报给订阅者。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| groupId | 传感器组ID。 groupId枚举值范围为128-160，表示已订阅医疗传感器服务，只需成功订阅一次，无需重复订阅。 groupId枚举值范围不在128-160之间，这意味着传统传感器已订阅，只需成功订阅一次，无需重复订阅。 | +| callbackObj | 要注册的回调函数，详见[ISensorCallback](interface_i_sensor_callback.md)。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负数。 + + +### SetBatch() + + +``` +ISensorInterface::SetBatch ([in] int sensorId, [in] long samplingInterval, [in] long reportInterval ) +``` + +**描述：** + +设置指定传感器的数据上报模式，不同的工作模式，上报数据的方式不同。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| sensorId | 唯一标识一个传感器设备类型，详见[HdfSensorTypeTag](sensor.md#hdfsensortypetag)。 | +| samplingInterval | 设置指定传感器的数据采样间隔，单位纳秒。 | +| reportInterval | 表示传感器数据上报间隔，单位纳秒。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### SetMode() + + +``` +ISensorInterface::SetMode ([in] int sensorId, [in] int mode ) +``` + +**描述：** + +设置指定传感器数据上报模式。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| sensorId | 唯一标识一个传感器设备类型，详见[HdfSensorTypeTag](sensor.md#hdfsensortypetag)。 | +| mode | 传感器的数据上报模式，详见[HdfSensorModeType](sensor.md#hdfsensormodetype)。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负数。 + + +### SetOption() + + +``` +ISensorInterface::SetOption ([in] int sensorId, [in] unsigned int option ) +``` + +**描述：** + +设置指定传感器量程、精度等可选配置。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| sensorId | 唯一标识一个传感器设备类型，详见[HdfSensorTypeTag](sensor.md#hdfsensortypetag)。 | +| option | 表示要设置的选项，如测量范围和精度。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负数。 + + +### Unregister() + + +``` +ISensorInterface::Unregister ([in] int groupId, [in] ISensorCallback callbackObj ) +``` + +**描述：** + +订阅者取消注册传感器数据回调函数。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| groupId | 传感器组ID。 groupId枚举值范围为128-160，表示已订阅医疗传感器服务。只需成功取消订阅一次，无需重复取消订阅。 groupId枚举值范围不在128-160之间，这意味着传统传感器已订阅。并且成功取消订阅。 | +| callbackObj | 要取消注册的回调函数，详见[ISensorCallback](interface_i_sensor_callback.md)。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负数。 diff --git a/zh-cn/device-dev/reference/hdi-apis/interface_i_stream_operator.md b/zh-cn/device-dev/reference/hdi-apis/interface_i_stream_operator.md new file mode 100644 index 0000000000000000000000000000000000000000..98a762eceb7b11e0c574191f4586aa767a95ede1 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/interface_i_stream_operator.md @@ -0,0 +1,325 @@ +# IStreamOperator + + +## **概述** + +定义Camera设备流操作。 + +对Camera设备执行流的创建、配置与添加参数、属性获取、句柄绑定与解除、图像捕获与取消、流的转换以及流释放操作。 + +流是指从底层设备输出，经本模块内部各环节处理，最终传递到上层服务或者应用的一组数据序列。 本模块支持的流的类型有预览流，录像流，拍照流等，更多类型可查看[StreamIntent](camera.md#streamintent)。 + +**相关模块:** + +[Camera](camera.md) + + +## **汇总** + + +### Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [IsStreamsSupported](#isstreamssupported) ([in] enum [OperationMode](camera.md#operationmode) mode, [in] unsigned char[] modeSetting, [in] struct [StreamInfo](_stream_info.md)[] infos, [out] enum [StreamSupportType](camera.md#streamsupporttype) type) | 查询是否支持添加参数对应的流。 | +| [CreateStreams](#createstreams) ([in] struct [StreamInfo](_stream_info.md)[] streamInfos) | 创建流。 | +| [ReleaseStreams](#releasestreams) ([in] int[] streamIds) | 释放流。 | +| [CommitStreams](#commitstreams) ([in] enum [OperationMode](camera.md#operationmode) mode, [in] unsigned char[] modeSetting) | 配置流。 | +| [GetStreamAttributes](#getstreamattributes) ([out] struct [StreamAttribute](_stream_attribute.md)[] attributes) | 获取流的属性。通过该接口获取的流属性可能会和[CreateStreams](#createstreams)输入的流信息存在差异。 | +| [AttachBufferQueue](#attachbufferqueue) ([in] int streamId, [in] BufferProducerSequenceable bufferProducer) | 绑定生产者句柄和指定流。 | +| [DetachBufferQueue](#detachbufferqueue) ([in] int streamId) | 解除生产者句柄和指定流的绑定关系。 | +| [Capture](#capture) ([in] int captureId, [in] struct [CaptureInfo](_capture_info.md) info, [in] boolean isStreaming) | 捕获图像。 | +| [CancelCapture](#cancelcapture) ([in] int captureId) | 取消连续捕获。捕获结束时，会调用[OnCaptureEnded](interface_i_stream_operator_callback.md#oncaptureended)来通知调用者捕获的帧计数等信息。 | +| [ChangeToOfflineStream](#changetoofflinestream) ([in] int[] streamIds, [in] [IStreamOperatorCallback](interface_i_stream_operator_callback.md) callbackObj, [out] [IOfflineStreamOperator](interface_i_offline_stream_operator.md) offlineOperator) | 将指定流转换成离线流。 | + + +## **成员函数说明** + + +### AttachBufferQueue() + + +``` +IStreamOperator::AttachBufferQueue ([in] int streamId, [in] BufferProducerSequenceable bufferProducer ) +``` + +**描述：** + +绑定生产者句柄和指定流。 + +如果在[CreateStreams](#createstreams)创建流时已经指定了生产者句柄，则不需要调用该接口。如果需要重新绑定， 需先调用[DetachBufferQueue](#detachbufferqueue)进行解绑，然后再绑定。 对于一些IOT设备，可能不需要或者不支持预览流的图像数据缓存流转，那么不需要绑定生产者句柄， 此时在创建流时[CreateStreams](#createstreams)的[StreamInfo](_stream_info.md)参数的生产者句柄bufferQueue_为空，而 tunneledMode_需设置为false。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| streamId | 用于标识要绑定的流。 | +| bufferProducer | 生产者句柄。 | + +**返回:** + +NO_ERROR 表示执行成功。 + +其他值表示执行失败，具体错误码查看[CamRetCode](camera.md#camretcode)。 + +**参见:** + +[DetachBufferQueue](#detachbufferqueue) + + +### CancelCapture() + + +``` +IStreamOperator::CancelCapture ([in] int captureId) +``` + +**描述：** + +取消连续捕获。捕获结束时，会调用[OnCaptureEnded](interface_i_stream_operator_callback.md#oncaptureended)来通知调用者捕获的帧计数等信息。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| captureId | 用于标识要取消的捕获请求。 | + +**返回:** + +NO_ERROR 表示执行成功。 + +其他值表示执行失败，具体错误码查看[CamRetCode](camera.md#camretcode)。 + +**参见:** + +[Capture](#capture) + + +### Capture() + + +``` +IStreamOperator::Capture ([in] int captureId, [in] struct CaptureInfo info, [in] boolean isStreaming ) +``` + +**描述：** + +捕获图像。 + +本接口必须在调用[CommitStreams](#commitstreams)配置流之后调用。 图像捕获有两种模式，分别是连续捕获和单次捕获。 + +- 连续捕获即触发之后模块内部进行连续的捕获，消费者可以连续收到图像数据，不需要多次调用本接口，若再次调用了本接口， 则停止当前捕获，更新捕获信息，再进行一次新的捕获，多用于预览、录像或者连拍场景。 + +- 单次捕获即触发之后只捕获一帧图像数据，用于单次拍照场景。捕获启动时，会调用[OnCaptureStarted](interface_i_stream_operator_callback.md#oncapturestarted)来通知调用者捕获已经启动。 + +- 连续捕获需调用[CancelCapture](#cancelcapture)来停止捕获。捕获结束时，会调用[OnCaptureEnded](interface_i_stream_operator_callback.md#oncaptureended)来通知调用者捕获的帧计数等信息。 [CaptureInfo](_capture_info.md)的[enableShutterCallback_](_capture_info.md#enableshuttercallback)使能OnFrameShutter，使能后每次捕获触发OnFrameShutter。 对于多个流同时捕获的场景，本模块内部保证同时上报多路流捕获数据。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| captureId | 捕获请求的唯一标识，由调用者指定，调用者需保证在Camera设备打开期间，捕获请求ID是唯一的。 | +| info | 捕获请求的参数信息，具体信息查看[CaptureInfo](_capture_info.md)。 | +| isStreaming | 是否连续捕获，true表示连续捕获，否则为单次捕获。 | + +**返回:** + +NO_ERROR 表示执行成功。 + +其他值表示执行失败，具体错误码查看[CamRetCode](camera.md#camretcode)。 + +**参见:** + +[OnFrameShutter](interface_i_stream_operator_callback.md#onframeshutter) + + +### ChangeToOfflineStream() + + +``` +IStreamOperator::ChangeToOfflineStream ([in] int[] streamIds, [in] IStreamOperatorCallback callbackObj, [out] IOfflineStreamOperator offlineOperator ) +``` + +**描述：** + +将指定流转换成离线流。 + +离线流只能由拍照流转换而来，其他流不支持。 一些设备处理能力有限，可能导致拍照时算法处理时间较长，从而引起捕获请求堆积在模块内部，而转换为离线 流之后，可关闭底层设备，由离线流接替，进行后续的处理。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| streamIds | 用于指定要转换成离线流的流集合。 | +| callbackObj | 用于设置离线流的回调。 | +| offlineOperator | 转换后的离线流。 | + +**返回:** + +NO_ERROR 表示执行成功。 + +其他值表示执行失败，具体错误码查看[CamRetCode](camera.md#camretcode)。 + + +### CommitStreams() + + +``` +IStreamOperator::CommitStreams ([in] enum OperationMode mode, [in] unsigned char[] modeSetting ) +``` + +**描述：** + +配置流。 + +本接口需在调用[CreateStreams](#createstreams)创建流之后调用。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| mode | 流运行的模式，支持的模式定义在[OperationMode](camera.md#operationmode)。 | +| modeSetting | 流的配置参数，包括帧率，ZOOM等信息。ZOOM：变焦 | + +**返回:** + +NO_ERROR 表示执行成功。 + +其他值表示执行失败，具体错误码查看[CamRetCode](camera.md#camretcode)。 + + +### CreateStreams() + + +``` +IStreamOperator::CreateStreams ([in] struct StreamInfo[] streamInfos) +``` + +**描述：** + +创建流。 + +此函数接口依据输入的流信息创建流，调用该接口之前需先通过[IsStreamsSupported](#isstreamssupported)查询HAL是否支持要创建的流。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| streamInfos | 流信息列表，流信息定义在[StreamInfo](_stream_info.md)。输入的流信息可能会被修改，需通过[GetStreamAttributes](#getstreamattributes)获取最新的流属性。 | + +**返回:** + +NO_ERROR 表示执行成功。 + +其他值表示执行失败，具体错误码查看[CamRetCode](camera.md#camretcode)。 + + +### DetachBufferQueue() + + +``` +IStreamOperator::DetachBufferQueue ([in] int streamId) +``` + +**描述：** + +解除生产者句柄和指定流的绑定关系。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| streamId | 用于标识要解除绑定的流。 | + +**返回:** + +NO_ERROR 表示执行成功。 + +其他值表示执行失败，具体错误码查看[CamRetCode](camera.md#camretcode)。 + +**参见:** + +[AttachBufferQueue](#attachbufferqueue) + + +### GetStreamAttributes() + + +``` +IStreamOperator::GetStreamAttributes ([out] struct StreamAttribute[] attributes) +``` + +**描述：** + +获取流的属性。通过该接口获取的流属性可能会和[CreateStreams](#createstreams)输入的流信息存在差异。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| attributes | 用于获取流的属性。在调用[CreateStreams](#createstreams)时，通过参数streamInfos携带的流信息可能会被重写。 | + +**返回:** + +NO_ERROR 表示执行成功。 + +其他值表示执行失败，具体错误码查看[CamRetCode](camera.md#camretcode)。 + + +### IsStreamsSupported() + + +``` +IStreamOperator::IsStreamsSupported ([in] enum OperationMode mode, [in] unsigned char[] modeSetting, [in] struct StreamInfo[] infos, [out] enum StreamSupportType type ) +``` + +**描述：** + +查询是否支持添加参数对应的流。 + +此函数接口根据输入的运行模式和配置信息以及当前模块中正在运行的流，查询是否支持动态添加流。 + +- 如果本模块支持在不停止其他流的情况下添加新流，或者即使停止其他流但上层服务或应用不感知， 则通过type参数返回DYNAMIC_SUPPORTED，上层服务或应用可以直接添加新流； + +- 如果本模块支持添加新流但需要上层服务或应用先停止所有流的捕获，则通过type参数返回RE_CONFIGURED_REQUIRED; + +- 如果不支持添加输入的新流，则返回NOT_SUPPORTED。 此函数需要在调用[CreateStreams](#createstreams)创建流之前调用。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| mode | 流的使用模式，支持的模式参考[OperationMode](camera.md#operationmode)。 | +| modeSetting | 流的配置，包括帧率，3A等配置信息。3A：自动曝光 (AE)、自动聚焦 (AF)、自动白平衡 (AWB) | +| infos | 流的配置信息，具体参考[StreamInfo](_stream_info.md)。 | +| type | 对动态配置流的支持类型，支持类型定义在[StreamSupportType](camera.md#streamsupporttype)。 | + +**返回:** + +NO_ERROR 表示执行成功。 + +其他值表示执行失败，具体错误码查看[CamRetCode](camera.md#camretcode)。 + + +### ReleaseStreams() + + +``` +IStreamOperator::ReleaseStreams ([in] int[] streamIds) +``` + +**描述：** + +释放流。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| streamIds | 要释放的流ID列表。 | + +**返回:** + +NO_ERROR 表示执行成功。 + +其他值表示执行失败，具体错误码查看[CamRetCode](camera.md#camretcode)。 diff --git a/zh-cn/device-dev/reference/hdi-apis/interface_i_stream_operator_callback.md b/zh-cn/device-dev/reference/hdi-apis/interface_i_stream_operator_callback.md new file mode 100644 index 0000000000000000000000000000000000000000..0c1293b76174281509b427abc30d78bd51b17b55 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/interface_i_stream_operator_callback.md @@ -0,0 +1,119 @@ +# IStreamOperatorCallback + + +## **概述** + +定义Camera设备流回调操作。 + +对Camera设备执行流回调的抓捕，结束，错误捕获和帧捕获等操作。 + +**相关模块:** + +[Camera](camera.md) + + +## **汇总** + + +### Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [OnCaptureStarted](#oncapturestarted) ([in] int captureId, [in] int[] streamIds) | 捕获开始回调，在捕获开始时调用。 | +| [OnCaptureEnded](#oncaptureended) ([in] int captureId, [in] struct [CaptureEndedInfo](_capture_ended_info.md)[] infos) | 捕获结束回调，在捕获结束时调用。 | +| [OnCaptureError](#oncaptureerror) ([in] int captureId, [in] struct [CaptureErrorInfo](_capture_error_info.md)[] infos) | 捕获错误回调，在捕获过程中发生错误时调用。 | +| [OnFrameShutter](#onframeshutter) ([in] int captureId, [in] int[] streamIds, [in] unsigned long timestamp) | 帧捕获回调。 | + + +## **成员函数说明** + + +### OnCaptureEnded() + + +``` +IStreamOperatorCallback::OnCaptureEnded ([in] int captureId, [in] struct CaptureEndedInfo[] infos ) +``` + +**描述：** + +捕获结束回调，在捕获结束时调用。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| captureId | 用于标识回调对应的捕获请求。 | +| infos | 捕获结束相关信息，具体结束相关信息查看[CaptureEndedInfo](_capture_ended_info.md)。 | + +**参见:** + +[OnCaptureStarted](#oncapturestarted) + + +### OnCaptureError() + + +``` +IStreamOperatorCallback::OnCaptureError ([in] int captureId, [in] struct CaptureErrorInfo[] infos ) +``` + +**描述：** + +捕获错误回调，在捕获过程中发生错误时调用。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| captureId | 用于标识回调对应的捕获请求。 | +| infos | 捕获错误信息列表，具体错误信息查看[CaptureErrorInfo](_capture_error_info.md)。 | + + +### OnCaptureStarted() + + +``` +IStreamOperatorCallback::OnCaptureStarted ([in] int captureId, [in] int[] streamIds ) +``` + +**描述：** + +捕获开始回调，在捕获开始时调用。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| captureId | 用于标识回调对应的捕获请求。 | +| streamIds | 回调对应的流集合。 | + +**参见:** + +[OnCaptureEnded](#oncaptureended) + + +### OnFrameShutter() + + +``` +IStreamOperatorCallback::OnFrameShutter ([in] int captureId, [in] int[] streamIds, [in] unsigned long timestamp ) +``` + +**描述：** + +帧捕获回调。 + +通过**Capture**的输入参数[CaptureInfo](_capture_info.md)的enableShutterCallback_使能该回调， 使能后每次捕获均会触发此回调。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| captureId | 用于标识回调对应的捕获请求。 | +| streamIds | 回调对应的流集合。 | +| timestamp | 该接口被调用时的时间戳。 | + +**参见:** + +Capture diff --git a/zh-cn/device-dev/reference/hdi-apis/interface_i_thermal_callback.md b/zh-cn/device-dev/reference/hdi-apis/interface_i_thermal_callback.md index b713dbcc70868b061dd239f2b0527d8c3e1652e6..96d23ab5bea3795d727408cd8be19ef490f957b7 100644 --- a/zh-cn/device-dev/reference/hdi-apis/interface_i_thermal_callback.md +++ b/zh-cn/device-dev/reference/hdi-apis/interface_i_thermal_callback.md @@ -3,30 +3,27 @@ ## **概述** -**所属模块:** - -[Thermal](thermal.md) - +订阅设备发热状态的回调。 -## **汇总** +服务创建此回调对象后，可以调用[IThermalInterface](interface_i_thermal_interface.md)的接口注册回调，从而订阅设备发热状态的变化。 +**Since:** -### Public 成员函数 +3.1 - | Public 成员函数 | 描述 | -| -------- | -------- | -| [OnThermalDataEvent](#onthermaldataevent) ([in] struct [HdfThermalCallbackInfo](_hdf_thermal_callback_info.md) event) | 设备发热状态变化的回调方法。 [更多...](#onthermaldataevent) | +**相关模块:** +[Thermal](thermal.md) -## **详细描述** -订阅设备发热状态的回调。 +## **汇总** -服务创建此回调对象后，可以调用IThermalInterface的接口注册回调，从而订阅设备发热状态的变化。 -**Since：** +### Public 成员函数 -3.1 + | 名称 | 描述 | +| -------- | -------- | +| [OnThermalDataEvent](#onthermaldataevent) ([in] struct [HdfThermalCallbackInfo](_hdf_thermal_callback_info.md) event) | 设备发热状态变化的回调方法。 | ## **成员函数说明** @@ -45,12 +42,12 @@ IThermalCallback::OnThermalDataEvent ([in] struct HdfThermalCallbackInfo event) 当设备发热状态发生变化时，将通过此方法的参数返回给服务。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | -| event | 输入参数，设备发热信息，包括器件类型、器件温度。 | +| event | 设备发热信息，包括器件类型、器件温度。 | -**参见：** +**参见:** [HdfThermalCallbackInfo](_hdf_thermal_callback_info.md) diff --git a/zh-cn/device-dev/reference/hdi-apis/interface_i_thermal_interface.md b/zh-cn/device-dev/reference/hdi-apis/interface_i_thermal_interface.md index cffe822befa71b155d2095b34d79894ae12bbb08..d911533f458425c6c0e5afe889500d55de599b07 100644 --- a/zh-cn/device-dev/reference/hdi-apis/interface_i_thermal_interface.md +++ b/zh-cn/device-dev/reference/hdi-apis/interface_i_thermal_interface.md @@ -3,35 +3,32 @@ ## **概述** -**所属模块:** - -[Thermal](thermal.md) - +设备温度管理、控制及订阅接口。 -## **汇总** +服务获取此对象后，可以调用相关的接口管理、控制和订阅设备温度。 +**Since：** -### Public 成员函数 +3.1 - | Public 成员函数 | 描述 | -| -------- | -------- | -| [SetCpuFreq](#setcpufreq) ([in] int freq) | 设置CPU频率。 [更多...](#setcpufreq) | -| [SetGpuFreq](#setgpufreq) ([in] int freq) | 设置GPU频率。 [更多...](#setgpufreq) | -| [SetBatteryCurrent](#setbatterycurrent) ([in] int current) | 设置充电电流。 [更多...](#setbatterycurrent) | -| [GetThermalZoneInfo](#getthermalzoneinfo) ([out] struct [HdfThermalCallbackInfo](_hdf_thermal_callback_info.md) event) | 获取设备发热的信息。 [更多...](#getthermalzoneinfo) | -| [Register](#register) ([in] [IThermalCallback](interface_i_thermal_callback.md) callbackObj) | 注册设备发热状态的回调。 [更多...](#register) | -| [Unregister](#unregister) () | 取消注册设备发热状态的回调。 [更多...](#unregister) | +**相关模块:** +[Thermal](thermal.md) -## **详细描述** -设备温度管理、控制及订阅接口。 +## **汇总** -服务获取此对象后，可以调用相关的接口管理、控制和订阅设备温度。 -**Since：** +### Public 成员函数 -3.1 + | 名称 | 描述 | +| -------- | -------- | +| [SetCpuFreq](#setcpufreq) ([in] int freq) | 设置CPU频率。 | +| [SetGpuFreq](#setgpufreq) ([in] int freq) | 设置GPU频率。 | +| [SetBatteryCurrent](#setbatterycurrent) ([in] int current) | 设置充电电流。 | +| [GetThermalZoneInfo](#getthermalzoneinfo) ([out] struct [HdfThermalCallbackInfo](_hdf_thermal_callback_info.md) event) | 获取设备发热的信息。 | +| [Register](#register) ([in] [IThermalCallback](interface_i_thermal_callback.md) callbackObj) | 注册设备发热状态的回调。 | +| [Unregister](#unregister) () | 取消注册设备发热状态的回调。 | ## **成员函数说明** @@ -48,17 +45,17 @@ IThermalInterface::GetThermalZoneInfo ([out] struct HdfThermalCallbackInfo event 获取设备发热的信息。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | event | 输出参数，设备发热信息，包括器件类型、器件温度。 | -**返回：** +**返回:** HDF_SUCCESS 表示获取成功。 -**参见：** +**参见:** [HdfThermalCallbackInfo](_hdf_thermal_callback_info.md) @@ -74,17 +71,17 @@ IThermalInterface::Register ([in] IThermalCallback callbackObj) 注册设备发热状态的回调。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | callbackObj | 输入参数，服务注册的回调。 | -**返回：** +**返回:** HDF_SUCCESS 表示注册成功。 -**参见：** +**参见:** [IThermalCallback](interface_i_thermal_callback.md) @@ -100,13 +97,13 @@ IThermalInterface::SetBatteryCurrent ([in] int current) 设置充电电流。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | current | 输入参数，充电电流，单位毫安。 | -**返回：** +**返回:** HDF_SUCCESS 表示设置成功 @@ -122,13 +119,13 @@ IThermalInterface::SetCpuFreq ([in] int freq) 设置CPU频率。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | freq | 输入参数，设置CPU频率的值。 | -**返回：** +**返回:** HDF_SUCCESS 表示设置成功。 @@ -144,13 +141,13 @@ IThermalInterface::SetGpuFreq ([in] int freq) 设置GPU频率。 -**参数：** +**参数:** | 名称 | 描述 | | -------- | -------- | | freq | 输入参数，设置GPU频率的值。 | -**返回：** +**返回:** HDF_SUCCESS 表示设置成功。 @@ -166,6 +163,6 @@ IThermalInterface::Unregister () 取消注册设备发热状态的回调。 -**返回：** +**返回:** HDF_SUCCESS 表示取消注册成功。 diff --git a/zh-cn/device-dev/reference/hdi-apis/interface_i_usb_interface.md b/zh-cn/device-dev/reference/hdi-apis/interface_i_usb_interface.md new file mode 100644 index 0000000000000000000000000000000000000000..214049b2314770756eb8da433404716a06de8503 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/interface_i_usb_interface.md @@ -0,0 +1,930 @@ +# IUsbInterface + + +## **概述** + +定义USB驱动基本的操作功能。 + +上层USB服务调用相关功能接口，可以打开/关闭设备，获取设备描述符，批量读取/写入数据等。 + +**相关模块:** + +[USB](usb.md) + + +## **汇总** + + +### Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [OpenDevice](#opendevice) ([in] struct [UsbDev](_usb_dev.md) dev) | 打开设备，建立连接。 | +| [CloseDevice](#closedevice) ([in] struct [UsbDev](_usb_dev.md) dev) | 关闭设备，释放与设备相关的所有系统资源。 | +| [GetDeviceDescriptor](#getdevicedescriptor) ([in] struct [UsbDev](_usb_dev.md) dev, [out] unsigned char[] descriptor) | 获取设备描述符，设备描述符提供了关于设备、设备的配置以及任何设备所归属的类的信息。 | +| [GetStringDescriptor](#getstringdescriptor) ([in] struct [UsbDev](_usb_dev.md) dev, [in] unsigned char descId, [out] unsigned char[] descriptor) | 根据设备的字符串ID获取字符串描述符，字符串描述符是提供一些设备接口相关的描述性信息，比如厂商的名字、产品序列号等。 | +| [GetConfigDescriptor](#getconfigdescriptor) ([in] struct [UsbDev](_usb_dev.md) dev, [in] unsigned char descId, [out] unsigned char[] descriptor) | 根据设备的配置ID获取配置描述符，配置描述符包含有关配置及其接口、备用设置及其终结点的信息。 | +| [GetRawDescriptor](#getrawdescriptor) ([in] struct [UsbDev](_usb_dev.md) dev, [out] unsigned char[] descriptor) | 获取USB设备的原始描述符。 | +| [GetFileDescriptor](#getfiledescriptor) ([in] struct [UsbDev](_usb_dev.md) dev, [out] int fd) | 获取USB设备的文件描述符。 | +| [SetConfig](#setconfig) ([in] struct [UsbDev](_usb_dev.md) dev, [in] unsigned char configIndex) | 设置USB设备当前的配置信息，USB设备被主机配置过后，主机可以使用设备提供的所有功能。 | +| [GetConfig](#getconfig) ([in] struct [UsbDev](_usb_dev.md) dev, [out] unsigned char configIndex) | 获取USB设备当前的配置信息。 | +| [ClaimInterface](#claiminterface) ([in] struct [UsbDev](_usb_dev.md) dev, [in] unsigned char interfaceid, [in] unsigned char force) | 打开USB设备的接口并声明独占，必须在数据传输前执行。 | +| [ReleaseInterface](#releaseinterface) ([in] struct [UsbDev](_usb_dev.md) dev, [in] unsigned char interfaceid) | 在停止数据传输后关闭占用的USB设备接口，并释放相关资源。 | +| [SetInterface](#setinterface) ([in] struct [UsbDev](_usb_dev.md) dev, [in] unsigned char interfaceid, [in] unsigned char altIndex) | 设置USB设备指定接口的备选设置，用于在具有相同ID但不同备用设置的两个接口之间进行选择。 | +| [BulkTransferRead](#bulktransferread) ([in] struct [UsbDev](_usb_dev.md) dev, [in] struct [UsbPipe](_usb_pipe.md) pipe, [in] int timeout, [out] unsigned char[] data) | 在USB设备指定端点方向为读取时，执行批量数据读取。 | +| [BulkTransferWrite](#bulktransferwrite) ([in] struct [UsbDev](_usb_dev.md) dev, [in] struct [UsbPipe](_usb_pipe.md) pipe, [in] int timeout, [in] unsigned char[] data) | 在USB设备指定端点方向为写入时，执行批量数据写入。 | +| [ControlTransferRead](#controltransferread) ([in] struct [UsbDev](_usb_dev.md) dev, [in] struct [UsbCtrlTransfer](_usb_ctrl_transfer.md) ctrl, [out] unsigned char[] data) | 在传输状态为读取并且控制端点是端点零时，对USB设备执行控制传输。 | +| [ControlTransferWrite](#controltransferwrite) ([in] struct [UsbDev](_usb_dev.md) dev, [in] struct [UsbCtrlTransfer](_usb_ctrl_transfer.md) ctrl, [in] unsigned char[] data) | 在传输状态为写入并且控制端点是端点零时，对USB设备执行控制传输。 | +| [InterruptTransferRead](#interrupttransferread) ([in] struct [UsbDev](_usb_dev.md) dev, [in] struct [UsbPipe](_usb_pipe.md) pipe, [in] int timeout, [out] unsigned char[] data) | 在USB设备指定端点方向为数据读取时执行中断数据读取。 | +| [InterruptTransferWrite](#interrupttransferwrite) ([in] struct [UsbDev](_usb_dev.md) dev, [in] struct [UsbPipe](_usb_pipe.md) pipe, [in] int timeout, [in] unsigned char[] data) | 在USB设备指定端点方向为写入时执行中断数据写入。 | +| [IsoTransferRead](#isotransferread) ([in] struct [UsbDev](_usb_dev.md) dev, [in] struct [UsbPipe](_usb_pipe.md) pipe, [in] int timeout, [out] unsigned char[] data) | 在USB设备指定端点方向为读取时执行等时数据读取。 | +| [IsoTransferWrite](#isotransferwrite) ([in] struct [UsbDev](_usb_dev.md) dev, [in] struct [UsbPipe](_usb_pipe.md) pipe, [in] int timeout, [in] unsigned char[] data) | 在USB设备指定端点方向为写入时执行等时数据写入。 | +| [RequestQueue](#requestqueue) ([in] struct [UsbDev](_usb_dev.md) dev, [in] struct [UsbPipe](_usb_pipe.md) pipe, [in] unsigned char[] clientData, [in] unsigned char[] buffer) | 在USB设备指定端点上进行异步数据发送或者接收请求，数据传输方向由端点方向决定。 | +| [RequestWait](#requestwait) ([in] struct [UsbDev](_usb_dev.md) dev, [out] unsigned char[] clientData, [out] unsigned char[] buffer, [in] int timeout) | 等待RequestQueue异步请求的操作结果。 | +| [RequestCancel](#requestcancel) ([in] struct [UsbDev](_usb_dev.md) dev, [in] struct [UsbPipe](_usb_pipe.md) pipe) | 取消待处理的数据请求。 | +| [GetCurrentFunctions](#getcurrentfunctions) ([out] int funcs) | 获取USB设备当前的功能（按位域表示）。 | +| [SetCurrentFunctions](#setcurrentfunctions) ([in] int funcs) | 设置USB设备当前的功能（按位域表示）。 | +| [SetPortRole](#setportrole) ([in] int portId, [in] int powerRole, [in] int dataRole) | 设置USB设备端口的角色。 | +| [QueryPort](#queryport) ([out] int portId, [out] int powerRole, [out] int dataRole, [out] int mode) | 查询USB设备端口的当前设置信息。 | +| [BindUsbdSubscriber](#bindusbdsubscriber) ([in] [IUsbdSubscriber](interface_i_usbd_subscriber.md) subscriber) | 绑定订阅者。 | +| [UnbindUsbdSubscriber](#unbindusbdsubscriber) ([in] [IUsbdSubscriber](interface_i_usbd_subscriber.md) subscriber) | 解绑订阅者。 | +| [RegBulkCallback](#regbulkcallback) ([in] struct [UsbDev](_usb_dev.md) dev, [in] struct [UsbPipe](_usb_pipe.md) pipe, [in] [IUsbdBulkCallback](interface_i_usbd_bulk_callback.md) cb) | 注册批量传输异步回调函数。 | +| [UnRegBulkCallback](#unregbulkcallback) ([in] struct [UsbDev](_usb_dev.md) dev, [in] struct [UsbPipe](_usb_pipe.md) pipe) | 注销批量传输异步回调函数。 | +| [BulkRead](#bulkread) ([in] struct [UsbDev](_usb_dev.md) dev, [in] struct [UsbPipe](_usb_pipe.md) pipe, [in] Ashmem ashmem) | 批量传输异步读数据。 | +| [BulkWrite](#bulkwrite) ([in] struct [UsbDev](_usb_dev.md) dev, [in] struct [UsbPipe](_usb_pipe.md) pipe, [in] Ashmem ashmem) | 批量传输异步写数据。 | +| [BulkCancel](#bulkcancel) ([in] struct [UsbDev](_usb_dev.md) dev, [in] struct [UsbPipe](_usb_pipe.md) pipe) | 批量传输异步取消接口，用于取消当前接口的异步批量读写操作。 | + + +## **成员函数说明** + + +### BindUsbdSubscriber() + + +``` +IUsbInterface::BindUsbdSubscriber ([in] IUsbdSubscriber subscriber) +``` + +**描述：** + +绑定订阅者。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| subscriber | 订阅者信息，详见[IUsbdSubscriber](interface_i_usbd_subscriber.md)。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 + + +### BulkCancel() + + +``` +IUsbInterface::BulkCancel ([in] struct UsbDev dev, [in] struct UsbPipe pipe ) +``` + +**描述：** + +批量传输异步取消接口，用于取消当前接口的异步批量读写操作。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| dev | USB设备地址信息，详见[UsbDev](_usb_dev.md)。 | +| pipe | USB设备管道信息，详见[UsbPipe](_usb_pipe.md)。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 + + +### BulkRead() + + +``` +IUsbInterface::BulkRead ([in] struct UsbDev dev, [in] struct UsbPipe pipe, [in] Ashmem ashmem ) +``` + +**描述：** + +批量传输异步读数据。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| dev | USB设备地址信息，详见[UsbDev](_usb_dev.md)。 | +| pipe | USB设备管道信息，详见[UsbPipe](_usb_pipe.md)。 | +| ashmem | 共享内存，用于存放读取的数据。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 + + +### BulkTransferRead() + + +``` +IUsbInterface::BulkTransferRead ([in] struct UsbDev dev, [in] struct UsbPipe pipe, [in] int timeout, [out] unsigned char[] data ) +``` + +**描述：** + +在USB设备指定端点方向为读取时，执行批量数据读取。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| dev | USB设备地址信息，详见[UsbDev](_usb_dev.md)。 | +| pipe | USB设备管道信息，详见[UsbPipe](_usb_pipe.md)。 | +| timeout | 超时时间。 | +| data | 读取的数据。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 + + +### BulkTransferWrite() + + +``` +IUsbInterface::BulkTransferWrite ([in] struct UsbDev dev, [in] struct UsbPipe pipe, [in] int timeout, [in] unsigned char[] data ) +``` + +**描述：** + +在USB设备指定端点方向为写入时，执行批量数据写入。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| dev | USB设备地址信息，详见[UsbDev](_usb_dev.md)。 | +| pipe | USB设备管道信息，详见[UsbPipe](_usb_pipe.md)。 | +| timeout | 超时时间。 | +| data | 写入的数据。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 + + +### BulkWrite() + + +``` +IUsbInterface::BulkWrite ([in] struct UsbDev dev, [in] struct UsbPipe pipe, [in] Ashmem ashmem ) +``` + +**描述：** + +批量传输异步写数据。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| dev | USB设备地址信息，详见[UsbDev](_usb_dev.md)。 | +| pipe | USB设备管道信息，详见[UsbPipe](_usb_pipe.md)。 | +| ashmem | 为共享内存，用于存放需要写入的数据。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 + + +### ClaimInterface() + + +``` +IUsbInterface::ClaimInterface ([in] struct UsbDev dev, [in] unsigned char interfaceid, [in] unsigned char force ) +``` + +**描述：** + +打开USB设备的接口并声明独占，必须在数据传输前执行。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| dev | USB设备地址信息，详见[UsbDev](_usb_dev.md)。 | +| interfaceid | USB设备接口ID。 | +| force | 是否强制，1表示强制，0表示不强制。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 + + +### CloseDevice() + + +``` +IUsbInterface::CloseDevice ([in] struct UsbDev dev) +``` + +**描述：** + +关闭设备，释放与设备相关的所有系统资源。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| dev | USB设备地址信息，详见[UsbDev](_usb_dev.md)。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 + + +### ControlTransferRead() + + +``` +IUsbInterface::ControlTransferRead ([in] struct UsbDev dev, [in] struct UsbCtrlTransfer ctrl, [out] unsigned char[] data ) +``` + +**描述：** + +在传输状态为读取并且控制端点是端点零时，对USB设备执行控制传输。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| dev | USB设备地址信息，详见[UsbDev](_usb_dev.md)。 | +| ctrl | USB设备控制数据，详见[UsbCtrlTransfer](_usb_ctrl_transfer.md)。 | +| data | 读取的数据。 | + +**返回:** + +0 表示成功。 + +非零值 表示失败。 + + +### ControlTransferWrite() + + +``` +IUsbInterface::ControlTransferWrite ([in] struct UsbDev dev, [in] struct UsbCtrlTransfer ctrl, [in] unsigned char[] data ) +``` + +**描述：** + +在传输状态为写入并且控制端点是端点零时，对USB设备执行控制传输。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| dev | USB设备地址信息，详见[UsbDev](_usb_dev.md)。 | +| ctrl | USB设备控制数据，详见[UsbCtrlTransfer](_usb_ctrl_transfer.md)。 | +| data | 写入的数据。 | + +**返回:** + +0 表示成功。 + +非零值 表示失败。 + + +### GetConfig() + + +``` +IUsbInterface::GetConfig ([in] struct UsbDev dev, [out] unsigned char configIndex ) +``` + +**描述：** + +获取USB设备当前的配置信息。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| dev | USB设备地址信息，详见[UsbDev](_usb_dev.md)。 | +| configIndex | USB设备配置信息的字符串描述符索引值（数字字符串）。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 + + +### GetConfigDescriptor() + + +``` +IUsbInterface::GetConfigDescriptor ([in] struct UsbDev dev, [in] unsigned char descId, [out] unsigned char[] descriptor ) +``` + +**描述：** + +根据设备的配置ID获取配置描述符，配置描述符包含有关配置及其接口、备用设置及其终结点的信息。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| dev | USB设备地址信息，详见[UsbDev](_usb_dev.md)。 | +| descId | USB设备的配置ID。 | +| descriptor | 获取USB设备配置信息。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 + + +### GetCurrentFunctions() + + +``` +IUsbInterface::GetCurrentFunctions ([out] int funcs) +``` + +**描述：** + +获取USB设备当前的功能（按位域表示）。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| funcs | 设备当前的功能值。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 + + +### GetDeviceDescriptor() + + +``` +IUsbInterface::GetDeviceDescriptor ([in] struct UsbDev dev, [out] unsigned char[] descriptor ) +``` + +**描述：** + +获取设备描述符，设备描述符提供了关于设备、设备的配置以及任何设备所归属的类的信息。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| dev | USB设备地址信息，详见[UsbDev](_usb_dev.md)。 | +| descriptor | USB设备的描述符信息。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 + + +### GetFileDescriptor() + + +``` +IUsbInterface::GetFileDescriptor ([in] struct UsbDev dev, [out] int fd ) +``` + +**描述：** + +获取USB设备的文件描述符。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| dev | USB设备地址信息，详见[UsbDev](_usb_dev.md)。 | +| fd | USB设备的文件描述符。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 + + +### GetRawDescriptor() + + +``` +IUsbInterface::GetRawDescriptor ([in] struct UsbDev dev, [out] unsigned char[] descriptor ) +``` + +**描述：** + +获取USB设备的原始描述符。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| dev | USB设备地址信息，详见[UsbDev](_usb_dev.md)。 | +| descriptor | USB设备的原始描述符。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 + + +### GetStringDescriptor() + + +``` +IUsbInterface::GetStringDescriptor ([in] struct UsbDev dev, [in] unsigned char descId, [out] unsigned char[] descriptor ) +``` + +**描述：** + +根据设备的字符串ID获取字符串描述符，字符串描述符是提供一些设备接口相关的描述性信息，比如厂商的名字、产品序列号等。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| dev | USB设备地址信息，详见[UsbDev](_usb_dev.md)。 | +| descId | USB设备的描述符ID。 | +| descriptor | 获取USB设备的字符串描述符。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 + + +### InterruptTransferRead() + + +``` +IUsbInterface::InterruptTransferRead ([in] struct UsbDev dev, [in] struct UsbPipe pipe, [in] int timeout, [out] unsigned char[] data ) +``` + +**描述：** + +在USB设备指定端点方向为数据读取时执行中断数据读取。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| dev | USB设备地址信息，详见[UsbDev](_usb_dev.md)。 | +| pipe | USB设备管道信息，详见[UsbPipe](_usb_pipe.md)。 | +| timeout | 超时时间。 | +| data | 读取的数据。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 + + +### InterruptTransferWrite() + + +``` +IUsbInterface::InterruptTransferWrite ([in] struct UsbDev dev, [in] struct UsbPipe pipe, [in] int timeout, [in] unsigned char[] data ) +``` + +**描述：** + +在USB设备指定端点方向为写入时执行中断数据写入。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| dev | USB设备地址信息，详见[UsbDev](_usb_dev.md)。 | +| pipe | USB设备管道信息，详见[UsbPipe](_usb_pipe.md)。 | +| timeout | 超时时间。 | +| data | 写入的数据。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 + + +### IsoTransferRead() + + +``` +IUsbInterface::IsoTransferRead ([in] struct UsbDev dev, [in] struct UsbPipe pipe, [in] int timeout, [out] unsigned char[] data ) +``` + +**描述：** + +在USB设备指定端点方向为读取时执行等时数据读取。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| dev | USB设备地址信息，详见[UsbDev](_usb_dev.md)。 | +| pipe | USB设备管道信息，详见[UsbPipe](_usb_pipe.md)。 | +| timeout | 超时时间。 | +| data | 读取的数据。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 + + +### IsoTransferWrite() + + +``` +IUsbInterface::IsoTransferWrite ([in] struct UsbDev dev, [in] struct UsbPipe pipe, [in] int timeout, [in] unsigned char[] data ) +``` + +**描述：** + +在USB设备指定端点方向为写入时执行等时数据写入。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| dev | USB设备地址信息，详见[UsbDev](_usb_dev.md)。 | +| pipe | USB设备管道信息，详见[UsbPipe](_usb_pipe.md)。 | +| timeout | 超时时间。 | +| data | 写入的数据。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 + + +### OpenDevice() + + +``` +IUsbInterface::OpenDevice ([in] struct UsbDev dev) +``` + +**描述：** + +打开设备，建立连接。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| dev | USB设备地址信息，详见[UsbDev](_usb_dev.md)。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 + + +### QueryPort() + + +``` +IUsbInterface::QueryPort ([out] int portId, [out] int powerRole, [out] int dataRole, [out] int mode ) +``` + +**描述：** + +查询USB设备端口的当前设置信息。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| portId | USB设备端口ID。 | +| powerRole | USB设备电源角色。 | +| dataRole | USB设备数据角色。 | +| mode | USB设备模式。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 + + +### RegBulkCallback() + + +``` +IUsbInterface::RegBulkCallback ([in] struct UsbDev dev, [in] struct UsbPipe pipe, [in] IUsbdBulkCallback cb ) +``` + +**描述：** + +注册批量传输异步回调函数。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| dev | USB设备地址信息，详见[UsbDev](_usb_dev.md)。 | +| pipe | USB设备管道信息，详见[UsbPipe](_usb_pipe.md)。 | +| cb | 回调函数对象，详见[IUsbdBulkCallback](interface_i_usbd_bulk_callback.md)。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 + + +### ReleaseInterface() + + +``` +IUsbInterface::ReleaseInterface ([in] struct UsbDev dev, [in] unsigned char interfaceid ) +``` + +**描述：** + +在停止数据传输后关闭占用的USB设备接口，并释放相关资源。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| dev | USB设备地址信息，详见[UsbDev](_usb_dev.md)。 | +| interfaceid | USB设备接口ID。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 + + +### RequestCancel() + + +``` +IUsbInterface::RequestCancel ([in] struct UsbDev dev, [in] struct UsbPipe pipe ) +``` + +**描述：** + +取消待处理的数据请求。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| dev | USB设备地址信息，详见[UsbDev](_usb_dev.md)。 | +| pipe | USB设备管道信息，详见[UsbPipe](_usb_pipe.md)。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 + + +### RequestQueue() + + +``` +IUsbInterface::RequestQueue ([in] struct UsbDev dev, [in] struct UsbPipe pipe, [in] unsigned char[] clientData, [in] unsigned char[] buffer ) +``` + +**描述：** + +在USB设备指定端点上进行异步数据发送或者接收请求，数据传输方向由端点方向决定。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| dev | USB设备地址信息，详见[UsbDev](_usb_dev.md)。 | +| pipe | USB设备管道信息，详见[UsbPipe](_usb_pipe.md)。 | +| clientData | 用户数据。 | +| buffer | 传输的数据。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 + + +### RequestWait() + + +``` +IUsbInterface::RequestWait ([in] struct UsbDev dev, [out] unsigned char[] clientData, [out] unsigned char[] buffer, [in] int timeout ) +``` + +**描述：** + +等待RequestQueue异步请求的操作结果。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| dev | USB设备地址信息，详见[UsbDev](_usb_dev.md)。 | +| clientData | 用户数据。 | +| buffer | 传输的数据。 | +| timeout | 超时时间。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 + + +### SetConfig() + + +``` +IUsbInterface::SetConfig ([in] struct UsbDev dev, [in] unsigned char configIndex ) +``` + +**描述：** + +设置USB设备当前的配置信息，USB设备被主机配置过后，主机可以使用设备提供的所有功能。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| dev | USB设备地址信息，详见[UsbDev](_usb_dev.md)。 | +| configIndex | USB设备配置信息的字符串描述符索引值（数字字符串）。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 + + +### SetCurrentFunctions() + + +``` +IUsbInterface::SetCurrentFunctions ([in] int funcs) +``` + +**描述：** + +设置USB设备当前的功能（按位域表示）。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| funcs | 待设置的设备功能值。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 + + +### SetInterface() + + +``` +IUsbInterface::SetInterface ([in] struct UsbDev dev, [in] unsigned char interfaceid, [in] unsigned char altIndex ) +``` + +**描述：** + +设置USB设备指定接口的备选设置，用于在具有相同ID但不同备用设置的两个接口之间进行选择。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| dev | USB设备地址信息，详见[UsbDev](_usb_dev.md)。 | +| interfaceid | USB设备接口ID。 | +| altIndex | USB设备接口的备用设置信息。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 + + +### SetPortRole() + + +``` +IUsbInterface::SetPortRole ([in] int portId, [in] int powerRole, [in] int dataRole ) +``` + +**描述：** + +设置USB设备端口的角色。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| portId | USB设备端口ID。 | +| powerRole | 电源角色的值。 | +| dataRole | 数据角色的值。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 + + +### UnbindUsbdSubscriber() + + +``` +IUsbInterface::UnbindUsbdSubscriber ([in] IUsbdSubscriber subscriber) +``` + +**描述：** + +解绑订阅者。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| subscriber | 订阅者信息，详见[IUsbdSubscriber](interface_i_usbd_subscriber.md)。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 + + +### UnRegBulkCallback() + + +``` +IUsbInterface::UnRegBulkCallback ([in] struct UsbDev dev, [in] struct UsbPipe pipe ) +``` + +**描述：** + +注销批量传输异步回调函数。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| dev | USB设备地址信息，详见[UsbDev](_usb_dev.md)。 | +| pipe | USB设备管道信息，详见[UsbPipe](_usb_pipe.md)。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 diff --git a/zh-cn/device-dev/reference/hdi-apis/interface_i_usbd_bulk_callback.md b/zh-cn/device-dev/reference/hdi-apis/interface_i_usbd_bulk_callback.md new file mode 100644 index 0000000000000000000000000000000000000000..e533f6c6902b02b964b700fc67d532c4434145c4 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/interface_i_usbd_bulk_callback.md @@ -0,0 +1,84 @@ +# IUsbdBulkCallback + + +## **概述** + +USB驱动的回调函数。 + +当USB驱动进行批量传输异步读/写数据时调用回调函数，处理对应的结果。 + +**Since:** + +3.2 + +**Version:** + +1.0 + +**相关模块:** + +[USB](usb.md) + + +## **汇总** + + +### Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [OnBulkWriteCallback](#onbulkwritecallback) ([in] int status, [in] int actLength) | 批量写数据的回调函数。 | +| [OnBulkReadCallback](#onbulkreadcallback) ([in] int status, [in] int actLength) | 批量读数据的回调函数。 | + + +## **成员函数说明** + + +### OnBulkReadCallback() + + +``` +IUsbdBulkCallback::OnBulkReadCallback ([in] int status, [in] int actLength ) +``` + +**描述：** + +批量读数据的回调函数。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| status | 完成状态。 | +| actLength | 读数据时实际接收的数据长度。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 + + +### OnBulkWriteCallback() + + +``` +IUsbdBulkCallback::OnBulkWriteCallback ([in] int status, [in] int actLength ) +``` + +**描述：** + +批量写数据的回调函数。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| status | 完成状态。 | +| actLength | 写数据时实际发送的数据长度。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 diff --git a/zh-cn/device-dev/reference/hdi-apis/interface_i_usbd_subscriber.md b/zh-cn/device-dev/reference/hdi-apis/interface_i_usbd_subscriber.md new file mode 100644 index 0000000000000000000000000000000000000000..bcd7aef290c7cda9b8f80c06b3e51d98bf43140a --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/interface_i_usbd_subscriber.md @@ -0,0 +1,74 @@ +# IUsbdSubscriber + + +## **概述** + +定义USB驱动的订阅类相关函数。 + +当设备接入/断开会调用DeviceEvent进行信息上报。 当端口状态发生变化时会调用PortChangedEvent进行信息上报。 + +**相关模块:** + +[USB](usb.md) + + +## **汇总** + + +### Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [DeviceEvent](#deviceevent) ([in] struct [USBDeviceInfo](_u_s_b_device_info.md) info) | 设备状态改变事件。 | +| [PortChangedEvent](#portchangedevent) ([in] struct [PortInfo](_port_info.md) info) | 端口改变事件。 | + + +## **成员函数说明** + + +### DeviceEvent() + + +``` +IUsbdSubscriber::DeviceEvent ([in] struct USBDeviceInfo info) +``` + +**描述：** + +设备状态改变事件。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| UsbInfo | USB设备信息。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 + + +### PortChangedEvent() + + +``` +IUsbdSubscriber::PortChangedEvent ([in] struct PortInfo info) +``` + +**描述：** + +端口改变事件。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| info | 端口信息。 | + +**返回:** + +0 表示操作成功。 + +非零值 表示操作失败。 diff --git a/zh-cn/device-dev/reference/hdi-apis/interface_i_user_auth_interface.md b/zh-cn/device-dev/reference/hdi-apis/interface_i_user_auth_interface.md index 9471fe3dcd50cd9a9eb64b937221e654fb0d024a..d6309d369b6fc7b664bc41c488f4a06ece3d08af 100644 --- a/zh-cn/device-dev/reference/hdi-apis/interface_i_user_auth_interface.md +++ b/zh-cn/device-dev/reference/hdi-apis/interface_i_user_auth_interface.md @@ -3,52 +3,49 @@ ## **概述** -**所属模块:** +声明用户认证驱动的API接口。 -[HdfUserAuth](_hdf_user_auth.md) +**Since：** +3.2 -## **汇总** +**Version：** +1.0 -### Public 成员函数 +**所属模块:** - | Public 成员函数 | 描述 | -| -------- | -------- | -| [Init](#init) () | 初始化用户认证驱动缓存信息，用于用户认证框架进程启动时初始化信息。 [更多...](#init) | -| [AddExecutor](#addexecutor) ([in] struct [ExecutorRegisterInfo](_executor_register_info.md) info, [out] unsigned long index, [out] unsigned char[] publicKey, [out] unsigned long[] templateIds) | 添加认证执行器来获取认证能力，用于各认证基础服务如口令认证服务等将认证能力对接到用户认证框架。 [更多...](#addexecutor) | -| [DeleteExecutor](#deleteexecutor) ([in] unsigned long index) | 删除执行器，用于清理失效的执行器信息。 [更多...](#deleteexecutor) | -| [OpenSession](#opensession) ([in] int userId, [out] unsigned char[] challenge) | 开启一个认证凭据管理会话，用于在请求管理用户认证凭据前获取有效挑战值。 [更多...](#opensession) | -| [CloseSession](#closesession) ([in] int userId) | 关闭认证凭据管理会话，完成用户认证凭据管理请求处理后，调用该接口使原挑战值失效。 [更多...](#closesession) | -| [BeginEnrollment](#beginenrollment) ([in] int userId, [in] unsigned char[] authToken, [in] struct [EnrollParam](_enroll_param.md) param, [out] struct [ScheduleInfo](_schedule_info.md) info) | 开始注册用户认证凭据。当注册凭据类型为口令且该用户已经注册了口令凭据时，将会更新口令凭据。 [更多...](#beginenrollment) | -| [UpdateEnrollmentResult](#updateenrollmentresult) ([in] int userId, [in] unsigned char[] scheduleResult, [out] unsigned long credentialId, [out] struct [CredentialInfo](_credential_info.md) oldInfo) | 更新用户凭据注册结果，完成凭据注册。 [更多...](#updateenrollmentresult) | -| [CancelEnrollment](#cancelenrollment) ([in] int userId) | 取消注册请求。 [更多...](#cancelenrollment) | -| [DeleteCredential](#deletecredential) ([in] int userId, [in] unsigned long credentialId, [in] unsigned char[] authToken, [out] struct [CredentialInfo](_credential_info.md) info) | 删除用户凭据信息。 [更多...](#deletecredential) | -| [GetCredential](#getcredential) ([in] int userId, [in] enum [AuthType](_hdf_face_auth.md#authtype) authType, [out] struct [CredentialInfo](_credential_info.md)[] infos) | 查询用户凭据信息。 [更多...](#getcredential) | -| [GetUserInfo](#getuserinfo) ([in] int userId, [out] unsigned long secureUid, [out] enum PinSubType pinSubType, [out] struct [EnrolledInfo](_enrolled_info.md)[] infos) | 查询用户认证相关信息。 [更多...](#getuserinfo) | -| [DeleteUser](#deleteuser) ([in] int userId, [in] unsigned char[] authToken, [out] struct [CredentialInfo](_credential_info.md)[] deletedInfos) | 删除用户口令认证凭据，在用户IAM系统内删除该用户，该请求由用户触发。 [更多...](#deleteuser) | -| [EnforceDeleteUser](#enforcedeleteuser) ([in] int userId, [out] struct [CredentialInfo](_credential_info.md)[] deletedInfos) | 强制删除用户，该请求由系统内管理用户的模块触发。 [更多...](#enforcedeleteuser) | -| [BeginAuthentication](#beginauthentication) ([in] unsigned long contextId, [in] struct [AuthSolution](_auth_solution.md) param, [out] struct [ScheduleInfo](_schedule_info.md)[] scheduleInfos) | 开始认证用户，并生成认证方案。 [更多...](#beginauthentication) | -| [UpdateAuthenticationResult](#updateauthenticationresult) ([in] unsigned long contextId, [in] unsigned char[] scheduleResult, [out] struct [AuthResultInfo](_auth_result_info.md) info) | 更新认证结果，评估认证方案的认证结果。 [更多...](#updateauthenticationresult) | -| [CancelAuthentication](#cancelauthentication) ([in] unsigned long contextId) | 取消用户认证请求。 [更多...](#cancelauthentication) | -| [BeginIdentification](#beginidentification) ([in] unsigned long contextId, [in] enum [AuthType](_hdf_face_auth.md#authtype) authType, [in] unsigned char[] challenge, [in] unsigned int executorSensorHint, [out] struct [ScheduleInfo](_schedule_info.md) scheduleInfo) | 开始用户身份识别，并生成识别方案。 [更多...](#beginidentification) | -| [UpdateIdentificationResult](#updateidentificationresult) ([in] unsigned long contextId, [in] unsigned char[] scheduleResult, [out] struct [IdentifyResultInfo](_identify_result_info.md) info) | 更新用户身份识别结果，生成身份识别方案的结果。 [更多...](#updateidentificationresult) | -| [CancelIdentification](#cancelidentification) ([in] unsigned long contextId) | 取消用户身份识别请求。 [更多...](#cancelidentification) | -| [GetAuthTrustLevel](#getauthtrustlevel) ([in] GetUserInfoint userId, [in] enum [AuthType](_hdf_face_auth.md#authtype) authType, [out] unsigned int authTrustLevel) | 获取当前认证类型的认证结果可信等级。 [更多...](#getauthtrustlevel) | -| [GetValidSolution](#getvalidsolution) ([in] int userId, [in] enum [AuthType](_hdf_face_auth.md#authtype)[] authTypes, [in] unsigned int authTrustLevel, [out] enum [AuthType](_hdf_face_auth.md#authtype)[] validTypes) | 获取指定认证结果可信等级下有效的认证方式。 [更多...](#getvalidsolution) | - - -## **详细描述** +[HdfUserAuth](_hdf_user_auth.md) -声明用户认证驱动的API接口。 -**Since：** +## **汇总** -3.2 -**Version：** +### Public 成员函数 -1.0 + | 名称 | 描述 | +| -------- | -------- | +| [Init](#init)() | 初始化用户认证驱动缓存信息，用于用户认证框架进程启动时初始化信息。 | +| [AddExecutor](#addexecutor)([in] struct ExecutorRegisterInfo info, [out] unsigned long index, [out] unsigned char[] publicKey, [out] unsigned long[] templateIds) | 添加认证执行器来获取认证能力，用于各认证基础服务如口令认证服务等将认证能力对接到用户认证框架。 | +| [DeleteExecutor](#deleteexecutor)([in] unsigned long index) | 删除执行器，用于清理失效的执行器信息。 | +| [OpenSession](#opensession)([in] int userId, [out] unsigned char[] challenge) | 开启一个认证凭据管理会话，用于在请求管理用户认证凭据前获取有效挑战值。 | +| [CloseSession](#closesession)([in] int userId) | 关闭认证凭据管理会话，完成用户认证凭据管理请求处理后，调用该接口使原挑战值失效。 | +| [BeginEnrollment](#beginenrollment)([in] int userId, [in] unsigned char[] authToken, [in] struct EnrollParam param, [out] struct ScheduleInfo info) | 开始注册用户认证凭据。当注册凭据类型为口令且该用户已经注册了口令凭据时，将会更新口令凭据。 | +| [UpdateEnrollmentResult](#updateenrollmentresult)([in] int userId, [in] unsigned char[] scheduleResult, [out] unsigned long credentialId, [out] struct CredentialInfo oldInfo) | 更新用户凭据注册结果，完成凭据注册。 | +| [CancelEnrollment](#cancelenrollment)([in] int userId) | 取消注册请求。 | +| [DeleteCredential](#deletecredential)([in] int userId, [in] unsigned long credentialId, [in] unsigned char[] authToken, [out] struct CredentialInfo info) | 删除用户凭据信息。 | +| [GetCredential](#getcredential)([in] int userId, [in] enum AuthType authType, [out] struct CredentialInfo[] infos) | 查询用户凭据信息。 | +| [GetUserInfo](#getuserinfo) ([in] int userId, [out] unsigned long secureUid, [out] enum PinSubType pinSubType, [out] struct EnrolledInfo[] infos) | 查询用户认证相关信息。 | +| [DeleteUser](#deleteuser)([in] int userId, [in] unsigned char[] authToken, [out] struct CredentialInfo[] deletedInfos) | 删除用户口令认证凭据，在用户IAM系统内删除该用户，该请求由用户触发。 | +| [EnforceDeleteUser](#enforcedeleteuser)([in] int userId, [out] struct CredentialInfo[] deletedInfos) | 强制删除用户，该请求由系统内管理用户的模块触发。 | +| [BeginAuthentication](#beginauthentication)([in] unsigned long contextId, [in] struct AuthSolution param, [out] struct ScheduleInfo[] scheduleInfos) | 开始认证用户，并生成认证方案。 | +| [UpdateAuthenticationResult](#updateauthenticationresult)([in] unsigned long contextId, [in] unsigned char[] scheduleResult, [out] struct AuthResultInfo info) | 更新认证结果，评估认证方案的认证结果。 | +| [CancelAuthentication](#cancelauthentication)([in] unsigned long contextId) | 取消用户认证请求。 | +| [BeginIdentification](#beginidentification)([in] unsigned long contextId, [in] enum AuthType authType, [in] unsigned char[] challenge, [in] unsigned int executorSensorHint, [out] struct ScheduleInfo scheduleInfo) | 开始用户身份识别，并生成识别方案。 | +| [UpdateIdentificationResult](#updateidentificationresult)([in] unsigned long contextId, [in] unsigned char[] scheduleResult, [out] struct IdentifyResultInfo info) | 更新用户身份识别结果，生成身份识别方案的结果。 | +| [CancelIdentification](#cancelidentification)([in] unsigned long contextId) | 取消用户身份识别请求。 | +| [GetAuthTrustLevel](#getauthtrustlevel)([in] GetUserInfoint userId, [in] enum AuthType authType, [out] unsigned int authTrustLevel) | 获取当前认证类型的认证结果可信等级。 | +| [GetValidSolution](#getvalidsolution)([in] int userId, [in] enum AuthType[] authTypes, [in] unsigned int authTrustLevel, [out] enum AuthType[] validTypes) | 获取指定认证结果可信等级下有效的认证方式。 | ## **成员函数说明** @@ -429,7 +426,7 @@ IUserAuthInterface::GetUserInfo([in] int userId, [out] unsigned long secureUid, | -------- | -------- | | userId | 用户ID。 | | secureUid | 安全用户ID。 | -| pinSubType | 口令认证子类型，请参考[PinSubType](_hdf_user_auth.md#pinsubtype)。 | +| pinSubType | 口令认证子类型[PinSubType](_hdf_user_auth.md#pinsubtype)。 | | infos | 注册信息[EnrolledInfo](_enrolled_info.md)。 | **返回：** diff --git a/zh-cn/device-dev/reference/hdi-apis/interface_i_vibrator_interface.md b/zh-cn/device-dev/reference/hdi-apis/interface_i_vibrator_interface.md new file mode 100644 index 0000000000000000000000000000000000000000..f0e739cef3f20c790d87d3462e5e245689530ba8 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/interface_i_vibrator_interface.md @@ -0,0 +1,169 @@ +# IVibratorInterface + + +## **概述** + +Vibrator模块向上层服务提供统一的接口。 + +上层服务开发人员可根据Vibrator模块提供的统一接口，用于控制马达执行单次或周期性振动。 + +**Since:** + +3.2 + +**Version:** + +1.1 + +**相关模块:** + +[Vibrator](vibrator.md) + + +## **汇总** + + +### Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [StartOnce](#startonce) ([in] unsigned int duration) | 控制马达以执行给定持续时间的单次振动。 | +| [Start](#start) ([in] String effectType) | 控制马达以预置效果执行周期性振动。 | +| [Stop](#stop) ([in] enum [HdfVibratorMode](vibrator.md#hdfvibratormode) mode) | 停止马达振动。 | +| [GetVibratorInfo](#getvibratorinfo) ([out] struct [HdfVibratorInfo](_hdf_vibrator_info.md)[] vibratorInfo) | 获取有关系统中支持设置振幅和频率的所有马达信息。 | +| [EnableVibratorModulation](#enablevibratormodulation) ([in] unsigned int duration, [in] int intensity, [in] int frequency) | 根据传入的振动效果启动马达。 | + + +## **成员函数说明** + + +### EnableVibratorModulation() + + +``` +IVibratorInterface::EnableVibratorModulation ([in] unsigned int duration, [in] int intensity, [in] int frequency ) +``` + +**描述：** + +根据传入的振动效果启动马达。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| duration | 表示马达振动的持续时间，以毫秒为单位。 | +| intensity | 表示振动周期内的马达振幅。 | +| frequency | 表示振动周期内的马达频率。 | + +**返回:** + +如果操作成功，则返回0。 + +如果不支持振动周期设置，则返回-1。 + +如果不支持振幅设置，则返回-2。 + +如果不支持频率设置，则返回-3。 + + +### GetVibratorInfo() + + +``` +IVibratorInterface::GetVibratorInfo ([out] struct HdfVibratorInfo[] vibratorInfo) +``` + +**描述：** + +获取有关系统中支持设置振幅和频率的所有马达信息。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| vibratorInfo | 表示指向马达信息的指针，详见[HdfVibratorInfo](_hdf_vibrator_info.md)。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### Start() + + +``` +IVibratorInterface::Start ([in] String effectType) +``` + +**描述：** + +控制马达以预置效果执行周期性振动。 + +单次振动与周期振动相互排斥。在执行周期性振动之前，需退出单次振动。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| effectType | 表示马达振动的预设效果类型。建议最大长度为64字节。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### StartOnce() + + +``` +IVibratorInterface::StartOnce ([in] unsigned int duration) +``` + +**描述：** + +控制马达以执行给定持续时间的单次振动。 + +单次振动与周期振动相互排斥。在执行单次振动之前，需退出周期性振动。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| duration | 表示单次振动的持续时间，以毫秒为单位。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### Stop() + + +``` +IVibratorInterface::Stop ([in] enum HdfVibratorMode mode) +``` + +**描述：** + +停止马达振动。 + +马达启动前，必须在任何模式下停止振动。此功能用在振动过程之后。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| mode | 表示振动模式，可以是单次或周期性的，详见[HdfVibratorMode](vibrator.md#hdfvibratormode)。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 diff --git a/zh-cn/device-dev/reference/hdi-apis/interface_i_wlan_callback.md b/zh-cn/device-dev/reference/hdi-apis/interface_i_wlan_callback.md new file mode 100644 index 0000000000000000000000000000000000000000..3fe5e85f25ae6014d60ece20c979fe605223f74c --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/interface_i_wlan_callback.md @@ -0,0 +1,99 @@ +# IWlanCallback + + +## **概述** + +定义WLAN模块的回调函数。 + +当WLAN模块发生重启，扫描热点结束，收到Netlink消息后，调用回调函数，处理对应的结果信息。 + +**Since:** + +3.2 + +**Version:** + +1.0 + +**相关模块:** + +[WLAN](wlan.md) + + +## **汇总** + + +### Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [ResetDriverResult](#resetdriverresult) ([in] unsigned int event, [in] int code, [in] String ifName) | 重启WLAN驱动的结果处理回调方法。 | +| [ScanResult](#scanresult) ([in] unsigned int event, [in] struct [HdfWifiScanResult](_hdf_wifi_scan_result.md) scanResult, [in] String ifName) | 扫描结果的回调方法。 | +| [WifiNetlinkMessage](#wifinetlinkmessage) ([in] unsigned char[] recvMsg) | Netlink消息的回调方法。 | + + +## **成员函数说明** + + +### ResetDriverResult() + + +``` +IWlanCallback::ResetDriverResult ([in] unsigned int event, [in] int code, [in] String ifName ) +``` + +**描述：** + +重启WLAN驱动的结果处理回调方法。 + +当重启WLAN驱动后，调用此接口处理驱动重启后的返回结果。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| event | 重启驱动的事件ID。 | +| code | 重启驱动后返回的结果数据。 | +| ifName | 网卡名称。 | + + +### ScanResult() + + +``` +IWlanCallback::ScanResult ([in] unsigned int event, [in] struct HdfWifiScanResult scanResult, [in] String ifName ) +``` + +**描述：** + +扫描结果的回调方法。 + +当扫描结束后，将通过此方法处理返回的扫描结果数据。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| event | 扫描结果的事件ID。 | +| scanResult | 扫描结果数据。 | +| ifName | 网卡名称。 | + + +### WifiNetlinkMessage() + + +``` +IWlanCallback::WifiNetlinkMessage ([in] unsigned char[] recvMsg) +``` + +**描述：** + +Netlink消息的回调方法。 + +当收到Netlink消息后，将通过此方法处理收到的消息。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| recvMsg | 收到的Netlink消息。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/interface_i_wlan_interface.md b/zh-cn/device-dev/reference/hdi-apis/interface_i_wlan_interface.md new file mode 100644 index 0000000000000000000000000000000000000000..33df7f747fb979dce5515f83a1de25e930e4a3fd --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/interface_i_wlan_interface.md @@ -0,0 +1,801 @@ +# IWlanInterface + + +## **概述** + +WLAN模块向上层WLAN服务提供了统一接口。 + +上层服务调用相关的接口，可以建立/关闭WLAN热点，扫描/关联/去关联WLAN热点，设置国家码，管理网络设备等。 + +**Since:** + +3.2 + +**Version:** + +1.0 + +**相关模块:** + +[WLAN](wlan.md) + + +## **汇总** + + +### Public 成员函数 + + | 名称 | 描述 | +| -------- | -------- | +| [Start](#start) () | 创建HAL和驱动之间的通道及获取驱动网卡信息，该函数调用在创建IWiFi实体后进行。 | +| [Stop](#stop) () | 销毁HAL和驱动之间的通道，该函数调用在销毁IWiFi实体前进行。 | +| [CreateFeature](#createfeature) ([in] int type, [out] struct [HdfFeatureInfo](_hdf_feature_info.md) ifeature) | 根据输入类型创建对应的feature对象。 | +| [DestroyFeature](#destroyfeature) ([in] struct [HdfFeatureInfo](_hdf_feature_info.md) ifeature) | 销毁feature对象。 | +| [GetAsscociatedStas](#getasscociatedstas) ([in] struct [HdfFeatureInfo](_hdf_feature_info.md) ifeature, [out] struct [HdfStaInfo](_hdf_sta_info.md)[] staInfo, [out] unsigned int num) | 获取与AP连接的所有STA的信息（目前只包含MAC地址）。 | +| [GetChipId](#getchipid) ([in] struct [HdfFeatureInfo](_hdf_feature_info.md) ifeature, [out] unsigned char chipId) | 获得当前驱动的芯片ID。 | +| [GetDeviceMacAddress](#getdevicemacaddress) ([in] struct [HdfFeatureInfo](_hdf_feature_info.md) ifeature, [out] unsigned char[] mac, [in] unsigned char len) | 获取设备的MAC地址。 | +| [GetFeatureByIfName](#getfeaturebyifname) ([in] String ifName, [out] struct [HdfFeatureInfo](_hdf_feature_info.md) ifeature) | 通过网卡名称获取对应的feature对象。 | +| [GetFeatureType](#getfeaturetype) ([in] struct [HdfFeatureInfo](_hdf_feature_info.md) ifeature, [out] int featureType) | 获取feature对象的类型。 | +| [GetFreqsWithBand](#getfreqswithband) ([in] struct [HdfFeatureInfo](_hdf_feature_info.md) ifeature, [in] struct [HdfWifiInfo](_hdf_wifi_info.md) wifiInfo, [out] int[] freq) | 获取指定频段（2.4G或者5G）下支持的频率。 | +| [GetIfNamesByChipId](#getifnamesbychipid) ([in] unsigned char chipId, [out] String ifName, [out] unsigned int num) | 通过芯片ID获得当前芯片所有的网卡名称。 | +| [GetNetworkIfaceName](#getnetworkifacename) ([in] struct [HdfFeatureInfo](_hdf_feature_info.md) ifeature, [out] String ifName) | 根据feature对象获取网卡名称。 | +| [GetSupportCombo](#getsupportcombo) ([out] unsigned long combo) | 获取多网卡共存情况。 | +| [GetSupportFeature](#getsupportfeature) ([out] unsigned char[] supType) | 获取该设备支持的WLAN特性（不考虑当前的使用状态）。 | +| [RegisterEventCallback](#registereventcallback) ([in] [IWlanCallback](interface_i_wlan_callback.md) cbFunc, [in] String ifName) | 注册IWiFi的回调函数，监听异步事件。 | +| [UnregisterEventCallback](#unregistereventcallback) ([in] [IWlanCallback](interface_i_wlan_callback.md) cbFunc, [in] String ifName) | 去注册IWiFi的回调函数。 | +| [ResetDriver](#resetdriver) ([in] unsigned char chipId, [in] String ifName) | 重启指定芯片ID的WLAN驱动程序。 | +| [SetCountryCode](#setcountrycode) ([in] struct [HdfFeatureInfo](_hdf_feature_info.md) ifeature, [in] String code, [in] unsigned int len) | 设置国家码（表示AP射频所在的国家，规定了AP射频特性，包括AP的发送功率、支持的信道等。其目的是为了使AP的射频特性符合不同国家或区域的法律法规要求）。 | +| [SetMacAddress](#setmacaddress) ([in] struct [HdfFeatureInfo](_hdf_feature_info.md) ifeature, [in] unsigned char[] mac) | 根据传入参数设置对应网卡的MAC地址。 | +| [SetScanningMacAddress](#setscanningmacaddress) ([in] struct [HdfFeatureInfo](_hdf_feature_info.md) ifeature, [in] unsigned char[] scanMac) | 设置扫描单个MAC地址。 | +| [SetTxPower](#settxpower) ([in] struct [HdfFeatureInfo](_hdf_feature_info.md) ifeature, [in] int power) | 设置发射功率。 | +| [GetNetDevInfo](#getnetdevinfo) ([out] struct [HdfNetDeviceInfoResult](_hdf_net_device_info_result.md) netDeviceInfoResult) | 获取网络设备信息（设备索引、网卡名字、MAC等信息）。 | +| [StartScan](#startscan) ([in] struct [HdfFeatureInfo](_hdf_feature_info.md) ifeature, [in] struct [HdfWifiScan](_hdf_wifi_scan.md) scan) | 启动扫描。 | +| [GetPowerMode](#getpowermode) ([in] struct [HdfFeatureInfo](_hdf_feature_info.md) ifeature, [out] unsigned char mode) | 获取正在使用的功率模式。 | +| [SetPowerMode](#setpowermode) ([in] struct [HdfFeatureInfo](_hdf_feature_info.md) ifeature, [in] unsigned char mode) | 设置功率模式。 | +| [StartChannelMeas](#startchannelmeas) ([in] String ifName, [in] struct [MeasChannelParam](_meas_channel_param.md) measChannelParam) | 启动信道测量。 | +| [GetChannelMeasResult](#getchannelmeasresult) ([in] String ifName, [out] struct [MeasChannelResult](_meas_channel_result.md) measChannelResult) | 获取信道测量结果。 | +| [SetProjectionScreenParam](#setprojectionscreenparam) ([in] String ifName, [in] struct [ProjectionScreenCmdParam](_projection_screen_cmd_param.md) param) | 设置投屏参数。 | +| [WifiSendCmdIoctl](#wifisendcmdioctl) ([in] String ifName, [in] int cmdId, [in] byte[] paramBuf) | 向驱动发送IO控制命令。 | +| [GetStaInfo](#getstainfo) ([in] String ifName, [out] struct [WifiStationInfo](_wifi_station_info.md) info, [in] unsigned char[] mac) | 获取指定网卡的STA的信息。 | + + +## **成员函数说明** + + +### CreateFeature() + + +``` +IWlanInterface::CreateFeature ([in] int type, [out] struct HdfFeatureInfo ifeature ) +``` + +**描述：** + +根据输入类型创建对应的feature对象。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| type | 创建的feature类型。 | +| ifeature | 获取创建的feature对象。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### DestroyFeature() + + +``` +IWlanInterface::DestroyFeature ([in] struct HdfFeatureInfo ifeature) +``` + +**描述：** + +销毁feature对象。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| ifeature | 销毁的feature对象。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### GetAsscociatedStas() + + +``` +IWlanInterface::GetAsscociatedStas ([in] struct HdfFeatureInfo ifeature, [out] struct HdfStaInfo[] staInfo, [out] unsigned int num ) +``` + +**描述：** + +获取与AP连接的所有STA的信息（目前只包含MAC地址）。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| ifeature | feature对象。 | +| staInfo | 保存与AP连接的STA的基本信息。 | +| num | 实际连接的STA的个数。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### GetChannelMeasResult() + + +``` +IWlanInterface::GetChannelMeasResult ([in] String ifName, [out] struct MeasChannelResult measChannelResult ) +``` + +**描述：** + +获取信道测量结果。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| ifName | 网卡名称。 | +| measChannelResult | 信道测量结果（信道号、信道负载、信道噪声）。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### GetChipId() + + +``` +IWlanInterface::GetChipId ([in] struct HdfFeatureInfo ifeature, [out] unsigned char chipId ) +``` + +**描述：** + +获得当前驱动的芯片ID。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| ifeature | feature对象。 | +| chipId | 获得的芯片ID。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### GetDeviceMacAddress() + + +``` +IWlanInterface::GetDeviceMacAddress ([in] struct HdfFeatureInfo ifeature, [out] unsigned char[] mac, [in] unsigned char len ) +``` + +**描述：** + +获取设备的MAC地址。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| ifeature | feature对象。 | +| mac | 获得的MAC地址。 | +| len | mac数组的长度。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### GetFeatureByIfName() + + +``` +IWlanInterface::GetFeatureByIfName ([in] String ifName, [out] struct HdfFeatureInfo ifeature ) +``` + +**描述：** + +通过网卡名称获取对应的feature对象。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| ifName | 网卡名称。 | +| ifeature | 获取该网卡的feature对象。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### GetFeatureType() + + +``` +IWlanInterface::GetFeatureType ([in] struct HdfFeatureInfo ifeature, [out] int featureType ) +``` + +**描述：** + +获取feature对象的类型。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| ifeature | feature对象。 | +| featureType | feature对象的类型。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### GetFreqsWithBand() + + +``` +IWlanInterface::GetFreqsWithBand ([in] struct HdfFeatureInfo ifeature, [in] struct HdfWifiInfo wifiInfo, [out] int[] freq ) +``` + +**描述：** + +获取指定频段（2.4G或者5G）下支持的频率。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| ifeature | feature对象。 | +| wifiInfo | 频段信息。 | +| freq | 保存支持的频率。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### GetIfNamesByChipId() + + +``` +IWlanInterface::GetIfNamesByChipId ([in] unsigned char chipId, [out] String ifName, [out] unsigned int num ) +``` + +**描述：** + +通过芯片ID获得当前芯片所有的网卡名称。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| chipId | 需要获取网卡名称的芯片ID。 | +| ifNames | 网卡名称。 | +| num | 网卡的数量。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### GetNetDevInfo() + + +``` +IWlanInterface::GetNetDevInfo ([out] struct HdfNetDeviceInfoResult netDeviceInfoResult) +``` + +**描述：** + +获取网络设备信息（设备索引、网卡名字、MAC等信息）。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| netDeviceInfoResult | 输出参数，得到的网络设备信息。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### GetNetworkIfaceName() + + +``` +IWlanInterface::GetNetworkIfaceName ([in] struct HdfFeatureInfo ifeature, [out] String ifName ) +``` + +**描述：** + +根据feature对象获取网卡名称。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| ifeature | feature对象。 | +| ifName | 网卡名称。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### GetPowerMode() + + +``` +IWlanInterface::GetPowerMode ([in] struct HdfFeatureInfo ifeature, [out] unsigned char mode ) +``` + +**描述：** + +获取正在使用的功率模式。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| ifeature | feature对象。 | +| mode | 功率模式，包括睡眠模式（待机状态运行）、一般模式（正常额定功率运行）、穿墙模式（最大功率运行，提高信号强度和覆盖面积）。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### GetStaInfo() + + +``` +IWlanInterface::GetStaInfo ([in] String ifName, [out] struct WifiStationInfo info, [in] unsigned char[] mac ) +``` + +**描述：** + +获取指定网卡的STA的信息。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| ifName | 网卡名称。 | +| info | 获取的STA的信息，详情请参考[WifiStationInfo](_wifi_station_info.md)。 | +| mac | STA的MAC地址。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### GetSupportCombo() + + +``` +IWlanInterface::GetSupportCombo ([out] unsigned long combo) +``` + +**描述：** + +获取多网卡共存情况。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| combo | 基于芯片的能力保存当前所有支持的多网卡共存情况（比如支持AP、STA、P2P等不同组合的共存）。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### GetSupportFeature() + + +``` +IWlanInterface::GetSupportFeature ([out] unsigned char[] supType) +``` + +**描述：** + +获取该设备支持的WLAN特性（不考虑当前的使用状态）。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| supType | 保存当前设备支持的特性。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### RegisterEventCallback() + + +``` +IWlanInterface::RegisterEventCallback ([in] IWlanCallback cbFunc, [in] String ifName ) +``` + +**描述：** + +注册IWiFi的回调函数，监听异步事件。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| cbFunc | 注册的回调函数。 | +| ifName | 网卡名称。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### ResetDriver() + + +``` +IWlanInterface::ResetDriver ([in] unsigned char chipId, [in] String ifName ) +``` + +**描述：** + +重启指定芯片ID的WLAN驱动程序。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| chipId | 需要进行重启驱动的芯片ID。 | +| ifName | 网卡名称。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### SetCountryCode() + + +``` +IWlanInterface::SetCountryCode ([in] struct HdfFeatureInfo ifeature, [in] String code, [in] unsigned int len ) +``` + +**描述：** + +设置国家码（表示AP射频所在的国家，规定了AP射频特性，包括AP的发送功率、支持的信道等。其目的是为了使AP的射频特性符合不同国家或区域的法律法规要求）。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| ifeature | feature对象。 | +| code | 设置的国家码。 | +| len | 国家码长度。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### SetMacAddress() + + +``` +IWlanInterface::SetMacAddress ([in] struct HdfFeatureInfo ifeature, [in] unsigned char[] mac ) +``` + +**描述：** + +根据传入参数设置对应网卡的MAC地址。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| ifeature | feature对象。 | +| mac | 设置的MAC地址。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### SetPowerMode() + + +``` +IWlanInterface::SetPowerMode ([in] struct HdfFeatureInfo ifeature, [in] unsigned char mode ) +``` + +**描述：** + +设置功率模式。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| ifeature | feature对象。 | +| mode | 功率模式，包括睡眠模式（待机状态运行）、一般模式（正常额定功率运行）、穿墙模式（最大功率运行，提高信号强度和覆盖面积）。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### SetProjectionScreenParam() + + +``` +IWlanInterface::SetProjectionScreenParam ([in] String ifName, [in] struct ProjectionScreenCmdParam param ) +``` + +**描述：** + +设置投屏参数。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| ifName | 网卡名称。 | +| param | 投屏参数。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### SetScanningMacAddress() + + +``` +IWlanInterface::SetScanningMacAddress ([in] struct HdfFeatureInfo ifeature, [in] unsigned char[] scanMac ) +``` + +**描述：** + +设置扫描单个MAC地址。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| ifeature | feature对象。 | +| scanMac | 设置STA扫描的MAC地址。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### SetTxPower() + + +``` +IWlanInterface::SetTxPower ([in] struct HdfFeatureInfo ifeature, [in] int power ) +``` + +**描述：** + +设置发射功率。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| ifeature | feature对象。 | +| power | 设置的发射功率。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### Start() + + +``` +IWlanInterface::Start () +``` + +**描述：** + +创建HAL和驱动之间的通道及获取驱动网卡信息，该函数调用在创建IWiFi实体后进行。 + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### StartChannelMeas() + + +``` +IWlanInterface::StartChannelMeas ([in] String ifName, [in] struct MeasChannelParam measChannelParam ) +``` + +**描述：** + +启动信道测量。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| ifName | 网卡名称。 | +| measChannelParam | 信道测量参数（信道号、测量时间）。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### StartScan() + + +``` +IWlanInterface::StartScan ([in] struct HdfFeatureInfo ifeature, [in] struct HdfWifiScan scan ) +``` + +**描述：** + +启动扫描。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| ifeature | feature对象。 | +| scan | 扫描参数。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### Stop() + + +``` +IWlanInterface::Stop () +``` + +**描述：** + +销毁HAL和驱动之间的通道，该函数调用在销毁IWiFi实体前进行。 + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### UnregisterEventCallback() + + +``` +IWlanInterface::UnregisterEventCallback ([in] IWlanCallback cbFunc, [in] String ifName ) +``` + +**描述：** + +去注册IWiFi的回调函数。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| cbFunc | 去注册的回调函数。 | +| ifName | 网卡名称。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + + +### WifiSendCmdIoctl() + + +``` +IWlanInterface::WifiSendCmdIoctl ([in] String ifName, [in] int cmdId, [in] byte[] paramBuf ) +``` + +**描述：** + +向驱动发送IO控制命令。 + +**参数:** + + | 名称 | 描述 | +| -------- | -------- | +| ifName | 网卡名称。 | +| cmdId | 命令ID。 | +| paramBuf | 命令内容。 | + +**返回:** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 diff --git a/zh-cn/device-dev/reference/hdi-apis/interface_pin_i_executor.md b/zh-cn/device-dev/reference/hdi-apis/interface_pin_i_executor.md index f2ec31e36bd23413a8d772d66f0b89eb8cb6f72b..dd911a53c9d501fcae7e23004f394a8e35ce17bf 100644 --- a/zh-cn/device-dev/reference/hdi-apis/interface_pin_i_executor.md +++ b/zh-cn/device-dev/reference/hdi-apis/interface_pin_i_executor.md @@ -3,40 +3,37 @@ ## **概述** -**所属模块:** - -[HdfPinAuth](_hdf_pin_auth.md) - +定义执行器标准API接口。接口可用于获取执行器信息，获取凭据模版信息，注册口令，认证口令，删除口令等。 -## **汇总** +**Since：** +3.2 -### Public 成员函数 +**Version:** - | Public 成员函数 | 描述 | -| -------- | -------- | -| [GetTemplateInfo](interface_i_executor.md#gettemplateinfo) ([in] unsigned long templateId, [out] struct [TemplateInfo](_template_info.md) templateInfo) | 获取凭据模版信息。 [更多...](interface_i_executor.md#gettemplateinfo) | -| [Cancel](interface_i_executor.md#cancel) ([in] unsigned long scheduleId) | 取消操作请求。 [更多...](interface_i_executor.md#cancel) | -| [GetExecutorInfo](#getexecutorinfo) ([out] struct [ExecutorInfo](_executor_info.md) executorInfo) | 获取执行器信息，口令认证服务将执行器注册到用户认证框架时需要通过该接口获取对应信息。 [更多...](#getexecutorinfo) | -| [OnRegisterFinish](#onregisterfinish) ([in] unsigned long[] templateIdList, [in] unsigned char[] frameworkPublicKey, [in] unsigned char[] extraInfo) | 完成执行器注册，对口令模版信息进行对账，用于删除无效的口令模板及相关信息。 [更多...](#onregisterfinish) | -| [OnSetData](interface_i_executor.md#onsetdata) ([in] unsigned long scheduleId, [in] unsigned long authSubType, [in] unsigned char[] data) | 设置口令数据，口令认证驱动处理注册或认证口令请求时，如果口令数据由口令认证服务获取，需要通过该接口将口令数据传给口令认证驱动。 [更多...](interface_i_executor.md#onsetdata) | -| [Enroll](#enroll) ([in] unsigned long scheduleId, [in] unsigned char[] extraInfo, [in] [IExecutorCallback](interface_pin_i_executor_callback.md) callbackObj) | 注册口令。 [更多...](#enroll) | -| [Authenticate](#authenticate) ([in] unsigned long scheduleId, [in] unsigned long templateId, [in] unsigned char[] extraInfo, [in] [IExecutorCallback](interface_pin_i_executor_callback.md) callbackObj) | 认证口令。 [ERROR:Invalid link:zh-cn_topic_0000001304382272.xml#xref15713627408,link:zh-cn_topic_0000001304382272.xml](zh-cn_topic_0000001304382272.xml) | -| [Delete](#delete) ([in] unsigned long templateId) | 删除口令。 [更多...](#delete) | -| [SendCommand](#sendcommand) ([in] int commandId, [in] unsigned char[] extraInfo, [in] [IExecutorCallback](interface_pin_i_executor_callback.md) callbackObj) | 发送口令认证功能相关操作命令。 [更多...](#sendcommand) | +1.0 +**所属模块:** -## **详细描述** +[HdfPinAuth](_hdf_pin_auth.md) -定义执行器标准API接口。接口可用于获取执行器信息，获取凭据模版信息，注册口令，认证口令，删除口令等。 -**Since：** +## **汇总** -3.2 -**Version:** +### Public 成员函数 -1.0 + | 名称 | 描述 | +| -------- | -------- | +| [GetTemplateInfo](#gettemplateinfo)([in] unsigned long templateId, [out] struct TemplateInfo templateInfo) | 获取凭据模版信息。 | +| [Cancel](#cancel)([in] unsigned long scheduleId) | 取消操作请求。 | +| [GetExecutorInfo](#getexecutorinfo) ([out] struct ExecutorInfo executorInfo) | 获取执行器信息，口令认证服务将执行器注册到用户认证框架时需要通过该接口获取对应信息。 | +| [OnRegisterFinish](#onregisterfinish) ([in] unsigned long[] templateIdList, [in] unsigned char[] frameworkPublicKey, [in] unsigned char[] extraInfo) | 完成执行器注册，对口令模版信息进行对账，用于删除无效的口令模板及相关信息。 | +| [OnSetData](#onsetdata)([in] unsigned long scheduleId, [in] unsigned long authSubType, [in] unsigned char[] data) | 设置口令数据，口令认证驱动处理注册或认证口令请求时，如果口令数据由口令认证服务获取，需要通过该接口将口令数据传给口令认证驱动。 | +| [Enroll](#enroll) ([in] unsigned long scheduleId, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj) | 注册口令。 | +| [Authenticate](#authenticate) ([in] unsigned long scheduleId, [in] unsigned long templateId, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj) | 认证口令。 | +| [Delete](#delete) ([in] unsigned long templateId) | 删除口令。 | +| [SendCommand](#sendcommand) ([in] int commandId, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj) | 发送口令认证功能相关操作命令。 | ## **成员函数说明** @@ -259,7 +256,7 @@ IExecutor::SendCommand ([in] int commandId, [in] unsigned char[] extraInfo, [in] | 名称 | 描述 | | -------- | -------- | -| commandId | 操作命令ID[CommandId](_hdf_pin_auth.md#commandid)。 | +| commandId | 操作命令ID。 | | extraInfo | 其他相关信息，用于支持信息扩展。 | | callbackObj | 回调对象[IExecutorCallback](interface_pin_i_executor_callback.md)。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/interface_pin_i_executor_callback.md b/zh-cn/device-dev/reference/hdi-apis/interface_pin_i_executor_callback.md index afa114d1d6713248b831ebbca7933c13e947da39..e0d8afed7239953c8881233d67d6edb244c075a1 100644 --- a/zh-cn/device-dev/reference/hdi-apis/interface_pin_i_executor_callback.md +++ b/zh-cn/device-dev/reference/hdi-apis/interface_pin_i_executor_callback.md @@ -3,33 +3,30 @@ ## **概述** -**所属模块:** - -[HdfPinAuth](_hdf_pin_auth.md) +定义异步API接口回调，用于返回异步接口的请求处理结果和获取信息。使用细节见[IExecutor](interface_pin_i_executor.md)。 +**Since：** -## **汇总** - +3.2 -### Public 成员函数 +**Version:** - | Public 成员函数 | 描述 | -| -------- | -------- | -| [OnResult](interface_i_executor_callback.md#onresult) ([in] int result, [in] unsigned char[] extraInfo) | 定义操作结果回调函数。 [更多...](interface_i_executor_callback.md#onresult) | -| [OnGetData](#ongetdata) ([in] unsigned long scheduleId, [in] unsigned char[] salt, [in] unsigned long authSubType) | 定义请求获取口令数据回调函数。 [更多...](#ongetdata) | +1.0 +**所属模块:** -## **详细描述** +[HdfPinAuth](_hdf_pin_auth.md) -定义异步API接口回调，用于返回异步接口的请求处理结果和获取信息。使用细节见[IExecutor](interface_i_executor.md)。 -**Since：** +## **汇总** -3.2 -**Version:** +### Public 成员函数 -1.0 + | 名称 | 描述 | +| -------- | -------- | +| [OnResult](#onresult) ([in] int result, [in] unsigned char[] extraInfo) | 定义操作结果回调函数。 | +| [OnGetData](#ongetdata) ([in] unsigned long scheduleId, [in] unsigned char[] salt, [in] unsigned long authSubType) | 定义请求获取口令数据回调函数。 | ## **成员函数说明** diff --git a/zh-cn/device-dev/reference/hdi-apis/ioffline__stream__operator_8h.md b/zh-cn/device-dev/reference/hdi-apis/ioffline__stream__operator_8h.md deleted file mode 100644 index 0a593960df15b13fa7993604729fe44d422f52a7..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/ioffline__stream__operator_8h.md +++ /dev/null @@ -1,31 +0,0 @@ -# ioffline_stream_operator.h - - -## **概述** - -**所属模块:** - -[Camera](_camera.md) - - -## **汇总** - - -### 类 - - | 类 | 描述 | -| -------- | -------- | -| [OHOS::Camera::IOfflineStreamOperator](_o_h_o_s_1_1_camera_1_1_i_offline_stream_operator.md) | 离线流的操作类。 | - - -## **详细描述** - -离线流的操作接口。 - -**Since：** - -1.0 - -**Version：** - -1.0 diff --git a/zh-cn/device-dev/reference/hdi-apis/istream__operator_8h.md b/zh-cn/device-dev/reference/hdi-apis/istream__operator_8h.md deleted file mode 100644 index a051ce63222611aef21f4be9f21e1c972b6468ba..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/istream__operator_8h.md +++ /dev/null @@ -1,31 +0,0 @@ -# istream_operator.h - - -## **概述** - -**所属模块:** - -[Camera](_camera.md) - - -## **汇总** - - -### 类 - - | 类 | 描述 | -| -------- | -------- | -| [OHOS::Camera::IStreamOperator](_o_h_o_s_1_1_camera_1_1_i_stream_operator.md) | 流的操作类。 | - - -## **详细描述** - -流的操作接口。 - -**Since：** - -1.0 - -**Version：** - -1.0 diff --git a/zh-cn/device-dev/reference/hdi-apis/istream__operator__callback_8h.md b/zh-cn/device-dev/reference/hdi-apis/istream__operator__callback_8h.md deleted file mode 100644 index 79f5e3d8b480e208e732160c760498ea84515517..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/istream__operator__callback_8h.md +++ /dev/null @@ -1,31 +0,0 @@ -# istream_operator_callback.h - - -## **概述** - -**所属模块:** - -[Camera](_camera.md) - - -## **汇总** - - -### 类 - - | 类 | 描述 | -| -------- | -------- | -| [OHOS::Camera::IStreamOperatorCallback](_o_h_o_s_1_1_camera_1_1_i_stream_operator_callback.md) | 流的操作回调类。 | - - -## **详细描述** - -[IStreamOperator](istream__operator_8h.md) 相关的回调，这些回调均由调用者实现。 - -**Since：** - -1.0 - -**Version：** - -1.0 diff --git a/zh-cn/device-dev/reference/hdi-apis/light.md b/zh-cn/device-dev/reference/hdi-apis/light.md new file mode 100644 index 0000000000000000000000000000000000000000..dd499b06f0a262abb527523c1179f53b245a78c7 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/light.md @@ -0,0 +1,97 @@ +# Light + + +## **概述** + +灯驱动对灯服务提供通用的接口能力。 + +灯模块为灯服务提供通用的接口去访问灯驱动，服务获取灯驱动对象或代理后，可以通过调用的APIs接口获取相关的灯信息。 例如打开或关闭灯、根据灯类型ID设置灯闪烁模式。 + +**Since**: + +3.1 + +**Version**: + +1.0 + + +## **汇总** + + +### 文件 + + | 名称 | 描述 | +| -------- | -------- | +| [ILightInterface.idl](_i_light_interface_8idl.md) | 定义灯模块的通用接口能力，包括获取灯类型ID、打开或关闭灯光、设置灯的亮度和闪烁模式。 | +| [LightTypes.idl](_light_types_8idl.md) | 定义灯的数据结构，包括灯类型ID、灯的基本信息、灯的模式、灯的闪烁参数、灯的颜色模式和灯的效果参数。 | + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [ILightInterface](interface_i_light_interface.md) | 提供灯模块基本操作接口。 | +| [HdfLightInfo](_hdf_light_info.md) | 定义灯的基本信息。 | +| [HdfLightFlashEffect](_hdf_light_flash_effect.md) | 定义灯的闪烁参数。 | +| [RGBColor](_r_g_b_color.md) | 定义灯的RGB模式。 | +| [WRGBColor](_w_r_g_b_color.md) | 定义灯的WRGB模式。 | +| [ColorValue](union_color_value.md) | 定义灯的颜色模式。 | +| [HdfLightColor](_hdf_light_color.md) | 定义亮灯参数。 | +| [HdfLightEffect](_hdf_light_effect.md) | 定义灯的效果参数。 | + + +### 枚举 + + | 名称 | 描述 | +| -------- | -------- | +| [HdfLightId](#hdflightid) { HDF_LIGHT_ID_BATTERY = 1, HDF_LIGHT_ID_NOTIFICATIONS = 2, HDF_LIGHT_ID_ATTENTION = 3, HDF_LIGHT_ID_BUTT = 4 } | 枚举灯类型。 | +| [HdfLightFlashMode](#hdflightflashmode) { HDF_LIGHT_FLASH_NONE = 0, HDF_LIGHT_FLASH_TIMED = 1, HDF_LIGHT_FLASH_GRADIENT = 2, HDF_LIGHT_FLASH_BUTT = 2 } | 枚举灯的模式。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.light.v1_0 | 灯模块接口的包路径。 | + + +## **枚举类型说明** + + +### HdfLightFlashMode + + +``` +enum HdfLightFlashMode +``` + +**描述：** + +枚举灯的模式。 + + | 枚举值 | 描述 | +| -------- | -------- | +| HDF_LIGHT_FLASH_NONE | 常亮模式。 | +| HDF_LIGHT_FLASH_TIMED | 闪烁模式。 | +| HDF_LIGHT_FLASH_GRADIENT | 渐变。 | +| HDF_LIGHT_FLASH_BUTT | 无效模式。 | + + +### HdfLightId + + +``` +enum HdfLightId +``` + +**描述：** + +枚举灯类型。 + + | 枚举值 | 描述 | +| -------- | -------- | +| HDF_LIGHT_ID_BATTERY | 电源指示灯。 | +| HDF_LIGHT_ID_NOTIFICATIONS | 通知灯。 | +| HDF_LIGHT_ID_ATTENTION | 报警灯。 | +| HDF_LIGHT_ID_BUTT | 无效ID。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/light_8typeh.md b/zh-cn/device-dev/reference/hdi-apis/light_8typeh.md deleted file mode 100644 index 55be372ba23701d13dd838bfbc217c0e0e10523b..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/light_8typeh.md +++ /dev/null @@ -1,33 +0,0 @@ -# light_type.h - - -## **概述** - -**所属模块:** - -[Light](_light.md) - - -## **汇总** - - -### 类 - -| 类 | 描述 | -| -------- | -------- | -| LightFlashEffect | 定义闪烁参数。 [更多...](_light_flash_effect.md) | -| LightEffect | 定义灯的效果参数。 [更多...](_light_effect.md) | -| LightInfo | 定义灯的基本信息。 [更多...](_light_info.md) | - - -## **详细描述** - -声明light模块的通用API，可用于获取灯ID、打开或关闭灯、并设置灯光亮度和闪烁模式。 - -**Since：** - -3.1 - -**Version：** - -1.0 \ No newline at end of file diff --git a/zh-cn/device-dev/reference/hdi-apis/light__if_8h.md b/zh-cn/device-dev/reference/hdi-apis/light__if_8h.md deleted file mode 100644 index 989dc4180adaaf06f1dd227e2976a82aaf775830..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/light__if_8h.md +++ /dev/null @@ -1,40 +0,0 @@ -# light_if.h - - -## **概述** - -**所属模块:** - -[Light](_light.md) - - -## **汇总** - - -### 类 - -| 类 | 描述 | -| -------- | -------- | -| [LightInterface](_light_interface.md) | 定义可以在灯上执行的基本操作。 [更多...](_light_interface.md) | - - -### 函数 - -| 函数 | 描述 | -| -------- | -------- | -| [NewLightInterfaceInstance](_light.md#newlightinterfaceinstance) (void) | 创建LightInterface实例。 [更多...](_light.md#newlightinterfaceinstance) | -| [FreeLightInterfaceInstance](_light.md#freelightinterfaceinstance) (void) | 释放LightInterface实例和相关资源。 [更多...](_light.md#freelightinterfaceinstance) | - - -## **详细描述** - -声明light模块的通用API，可用于获取灯ID、打开或关闭灯、并设置灯光亮度和闪烁模式。 - -**Since：** - -3.1 - -**Version：** - -1.0 - diff --git a/zh-cn/device-dev/reference/hdi-apis/modulelist.md b/zh-cn/device-dev/reference/hdi-apis/modulelist.md new file mode 100644 index 0000000000000000000000000000000000000000..a0969df08272de3d04f006ea7643d30eec42deed --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/modulelist.md @@ -0,0 +1,39 @@ +# 模块 + + + +- **[Audio](_audio.md)** + +- **[Battery](battery.md)** + +- **[Camera](camera.md)** + +- **[Codec](codec.md)** + +- **[Display](_display.md)** + +- **[HdfFaceAuth](_hdf_face_auth.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)** + +- **[Thermal](thermal.md)** + +- **[USB](usb.md)** + +- **[Vibrator](vibrator.md)** + +- **[WLAN](wlan.md)** \ No newline at end of file diff --git a/zh-cn/device-dev/reference/hdi-apis/motion.md b/zh-cn/device-dev/reference/hdi-apis/motion.md new file mode 100644 index 0000000000000000000000000000000000000000..4662cf421979b9d24c5be1ca2143d2c649104b93 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/motion.md @@ -0,0 +1,75 @@ +# Motion + + +## **概述** + +手势识别设备驱动对硬件服务提供通用的接口能力。 + +模块提供硬件服务对手势识别驱动模块访问统一接口，服务获取驱动对象或者代理后，通过其提供的各类方法，实现使能手势识别/ 去使能手势识别、订阅/取消订阅手势识别数据。 + +**Since**: + +3.2 + + +## **汇总** + + +### 文件 + + | 名称 | 描述 | +| -------- | -------- | +| [IMotionCallback.idl](_i_motion_callback_8idl.md) | 定义上报手势识别数据回调函数接口。 | +| [IMotionInterface.idl](_i_motion_interface_8idl.md) | 定义使能/去使能手势识别、订阅/取消订阅手势识别数据的接口。 | +| [MotionTypes.idl](_motion_types_8idl.md) | 定义手势识别模块用到的数据结构，包括手势识别类型、上报的手势识别数据结构。 | + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [IMotionCallback](interface_i_motion_callback.md) | 定义上报手势识别数据回调函数。 | +| [IMotionInterface](interface_i_motion_interface.md) | 提供Motion设备基本控制操作接口。 | +| [HdfMotionEvent](_hdf_motion_event.md) | 上报手势识别数据结构。 | + + +### 枚举 + + | 名称 | 描述 | +| -------- | -------- | +| [HdfMotionTypeTag](#hdfmotiontypetag) {   HDF_MOTION_TYPE_PICKUP = 0, HDF_MOTION_TYPE_FLIP, HDF_MOTION_CLOSE_TO_EAR, HDF_MOTION_TYPE_SHAKE,   HDF_MOTION_TYPE_ROTATION, HDF_MOTION_TYPE_POCKET_MODE, HDF_MOTION_TYPE_LEAVE_EAR, HDF_MOTION_TYPE_WRIST_UP,   HDF_MOTION_TYPE_WRIST_DOWN, HDF_MOTION_TYPE_MAX } | 枚举手势识别类型。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.motion.v1_0 | 手势识别模块接口的包路径。 | + + +## **枚举类型说明** + + +### HdfMotionTypeTag + + +``` +enum HdfMotionTypeTag +``` + +**描述：** + +枚举手势识别类型。 + + | 枚举值 | 描述 | +| -------- | -------- | +| HDF_MOTION_TYPE_PICKUP | 拿起类型。 | +| HDF_MOTION_TYPE_FLIP | 翻转类型。 | +| HDF_MOTION_CLOSE_TO_EAR | 靠近耳朵类型。 | +| HDF_MOTION_TYPE_SHAKE | 摇一摇类型。 | +| HDF_MOTION_TYPE_ROTATION | 旋转屏类型。 | +| HDF_MOTION_TYPE_POCKET_MODE | 口袋模式类型。 | +| HDF_MOTION_TYPE_LEAVE_EAR | 拿离耳朵类型。 | +| HDF_MOTION_TYPE_WRIST_UP | 腕朝上类型。 | +| HDF_MOTION_TYPE_WRIST_DOWN | 腕朝下类型。 | +| HDF_MOTION_TYPE_MAX | 最大手势识别类型。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/pin__auth_2_i_executor_8idl.md b/zh-cn/device-dev/reference/hdi-apis/pin__auth_2_i_executor_8idl.md index b642de475903f6710b7d62886606ef708b62023e..c521e57491dce8ea817583370c6219278cfe6051 100644 --- a/zh-cn/device-dev/reference/hdi-apis/pin__auth_2_i_executor_8idl.md +++ b/zh-cn/device-dev/reference/hdi-apis/pin__auth_2_i_executor_8idl.md @@ -3,6 +3,12 @@ ## **概述** +定义执行器标准API接口。接口可用于获取执行器信息，获取凭据模版信息，注册口令，认证口令，删除口令等。 + +**Since：** + +3.2 + **所属模块:** [HdfPinAuth](_hdf_pin_auth.md) @@ -13,22 +19,13 @@ ### 类 - | 类 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [IExecutor](interface_pin_i_executor.md) | 定义执行器标准API接口。接口可用于获取执行器信息，获取凭据模版信息，注册口令，认证口令，删除口令等。 [更多...](interface_pin_i_executor.md) | +| [IExecutor](interface_pin_i_executor.md) | 定义执行器标准API接口。接口可用于获取执行器信息，获取凭据模版信息，注册口令，认证口令，删除口令等。 | -### 变量 +### 关键字 - | 变量 名称 | 描述 | + | 名称 | 描述 | | -------- | -------- | | package ohos.hdi.pin_auth.v1_0 | 口令认证接口的包路径 | - - -## **详细描述** - -定义执行器标准API接口。接口可用于获取执行器信息，获取凭据模版信息，注册口令，认证口令，删除口令等。 - -**Since：** - -3.2 diff --git a/zh-cn/device-dev/reference/hdi-apis/pin__auth_2_i_executor_callback_8idl.md b/zh-cn/device-dev/reference/hdi-apis/pin__auth_2_i_executor_callback_8idl.md index 39df7ba9021fa902cc6948b9cb567fe9de3ab613..a8a0b816d93ea68433e534748afc275f544773b6 100644 --- a/zh-cn/device-dev/reference/hdi-apis/pin__auth_2_i_executor_callback_8idl.md +++ b/zh-cn/device-dev/reference/hdi-apis/pin__auth_2_i_executor_callback_8idl.md @@ -3,6 +3,16 @@ ## **概述** +定义异步API接口回调，用于返回异步接口的请求处理结果和获取信息。使用细节见[IExecutor](interface_pin_i_executor.md)。 + +**Since：** + +3.2 + +**Version：** + +1.0 + **所属模块:** [HdfPinAuth](_hdf_pin_auth.md) @@ -13,26 +23,13 @@ ### 类 - | 类 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [IExecutorCallback](interface_pin_i_executor_callback.md) | 定义异步API接口回调，用于返回异步接口的请求处理结果和信息。使用细节见[IExecutor](interface_pin_i_executor.md)。 [更多...](interface_pin_i_executor_callback.md) | +| [IExecutorCallback](interface_pin_i_executor_callback.md) | 定义异步API接口回调，用于返回异步接口的请求处理结果和信息。使用细节见[IExecutor](interface_pin_i_executor.md)。 | -### 变量 +### 关键字 - | 变量 名称 | 描述 | + | 名称 | 描述 | | -------- | -------- | | package ohos.hdi.pin_auth.v1_0 | 口令认证接口的包路径 | - - -## **详细描述** - -定义异步API接口回调，用于返回异步接口的请求处理结果和获取信息。使用细节见[IExecutor](interface_pin_i_executor.md)。 - -**Since：** - -3.2 - -**Version：** - -1.0 diff --git a/zh-cn/device-dev/reference/hdi-apis/power.md b/zh-cn/device-dev/reference/hdi-apis/power.md index 2ce105c12d28d9579ab2b3ad6eefbf186588e312..4383da36d209e4552fbf70c1e62d023c3c4adcd3 100644 --- a/zh-cn/device-dev/reference/hdi-apis/power.md +++ b/zh-cn/device-dev/reference/hdi-apis/power.md @@ -1,12 +1,27 @@ # Power +## **概述** + +提供休眠/唤醒操作、订阅休眠/唤醒状态、运行锁管理的接口。 + +电源模块为电源服务提供的休眠/唤醒操作、订阅休眠/唤醒状态和运行锁管理的接口。 服务获取此模块的对象或代理后，可以调用相关的接口对设备进行休眠/唤醒、订阅休眠/唤醒状态和管理运行锁。 + +**Since**: + +3.1 + +**Version**: + +1.0 + + ## **汇总** ### 文件 - | 文件 | 描述 | + | 名称 | 描述 | | -------- | -------- | | [IPowerHdiCallback.idl](_i_power_hdi_callback_8idl.md) | 休眠/唤醒状态的回调。 | | [IPowerInterface.idl](_i_power_interface_8idl.md) | 休眠/唤醒操作、订阅休眠/唤醒状态、运行锁管理的接口。 | @@ -15,41 +30,26 @@ ### 类 - | 类 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [IPowerHdiCallback](interface_i_power_hdi_callback.md) | 休眠/唤醒状态的回调。 [更多...](interface_i_power_hdi_callback.md) | -| [IPowerInterface](interface_i_power_interface.md) | 休眠/唤醒操作、订阅休眠/唤醒状态、运行锁管理的接口。 [更多...](interface_i_power_interface.md) | +| [IPowerHdiCallback](interface_i_power_hdi_callback.md) | 休眠/唤醒状态的回调。 | +| [IPowerInterface](interface_i_power_interface.md) | 休眠/唤醒操作、订阅休眠/唤醒状态、运行锁管理的接口。 | ### 枚举 - | 枚举 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [PowerHdfCmd](#powerhdfcmd) {   CMD_REGISTER_CALLBCK = 0, CMD_START_SUSPEND, CMD_STOP_SUSPEND, CMD_FORCE_SUSPEND,   CMD_SUSPEND_BLOCK, CMD_SUSPEND_UNBLOCK, CMD_DUMP } | 枚举电源命令的参数。 [更多...](#powerhdfcmd) | -| [PowerHdfCallbackCmd](#powerhdfcallbackcmd) { CMD_ON_SUSPEND = 0, CMD_ON_WAKEUP } | 枚举电源状态回调的参数。 [更多...](#powerhdfcallbackcmd) | -| [PowerHdfState](#powerhdfstate) { AWAKE = 0, INACTIVE, SLEEP } | 枚举电源的状态。 [更多...](#powerhdfstate) | +| [PowerHdfCmd](#powerhdfcmd) {   CMD_REGISTER_CALLBCK = 0, CMD_START_SUSPEND, CMD_STOP_SUSPEND, CMD_FORCE_SUSPEND,   CMD_SUSPEND_BLOCK, CMD_SUSPEND_UNBLOCK, CMD_DUMP } | 枚举电源命令的参数。 | +| [PowerHdfCallbackCmd](#powerhdfcallbackcmd) { CMD_ON_SUSPEND = 0, CMD_ON_WAKEUP } | 枚举电源状态回调的参数。 | +| [PowerHdfState](#powerhdfstate) { AWAKE = 0, INACTIVE, SLEEP } | 枚举电源的状态。 | -### 变量 +### 关键字 - | 变量 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| package ohos.hdi.power.v1_0 | 电源管理接口的包路径。 | - - -## **详细描述** - -提供休眠/唤醒操作、订阅休眠/唤醒状态、运行锁管理的接口。 - -电源模块为电源服务提供的休眠/唤醒操作、订阅休眠/唤醒状态和运行锁管理的接口。 服务获取此模块的对象或代理后，可以调用相关的接口对设备进行休眠/唤醒、订阅休眠/唤醒状态和管理运行锁。 - -**Since：** - -3.1 - -**Version：** - -1.0 +| package ohos.hdi.power.v1_0 | 电源模块接口的包路径。 | ## **枚举类型说明** diff --git a/zh-cn/device-dev/reference/hdi-apis/sensor.md b/zh-cn/device-dev/reference/hdi-apis/sensor.md new file mode 100644 index 0000000000000000000000000000000000000000..819b16becb94b74508e91dfdd5f560235b1ffe21 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/sensor.md @@ -0,0 +1,145 @@ +# Sensor + + +## **概述** + +提供休眠/唤醒操作、订阅休眠/唤醒状态、运行锁管理的接口。 + +电源模块为电源服务提供的休眠/唤醒操作、订阅休眠/唤醒状态和运行锁管理的接口。 服务获取此模块的对象或代理后，可以调用相关的接口对设备进行休眠/唤醒、订阅休眠/唤醒状态和管理运行锁。 + +**Since**: + +2.2 + +**Version**: + +1.0 + + +## **汇总** + + +### 文件 + + | 名称 | 描述 | +| -------- | -------- | +| [ISensorCallback.idl](_i_sensor_callback_8idl.md) | Sensor模块为Sensor服务提供数据上报的回调函数。 | +| [ISensorInterface.idl](_i_sensor_interface_8idl.md) | Sensor模块对外通用的接口声明文件，提供获取传感器设备信息、订阅/取消订阅传感器数据、 使能/去使能传感器、设置传感器模式、设置传感器精度，量程等可选配置接口定义。 | +| [SensorTypes.idl](_sensor_types_8idl.md) | 定义传感器模块所使用的传感器类型，传感器信息，传感器数据结构等数据类型。 | + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [ISensorCallback](interface_i_sensor_callback.md) | 定义用于上报传感器数据的回调函数。 | +| [ISensorInterface](interface_i_sensor_interface.md) | 提供Sensor设备基本控制操作接口。 | +| [HdfSensorInformation](_hdf_sensor_information.md) | 定义传感器的基本信息。 | +| [HdfSensorEvents](_hdf_sensor_events.md) | 定义传感器上报的数据。 | + + +### 枚举 + + | 名称 | 描述 | +| -------- | -------- | +| [HdfSensorTypeTag](#hdfsensortypetag) {   HDF_SENSOR_TYPE_NONE = 0, HDF_SENSOR_TYPE_ACCELEROMETER = 1, HDF_SENSOR_TYPE_GYROSCOPE = 2, HDF_SENSOR_TYPE_PHOTOPLETHYSMOGRAPH = 3,   HDF_SENSOR_TYPE_ELECTROCARDIOGRAPH = 4, HDF_SENSOR_TYPE_AMBIENT_LIGHT = 5, HDF_SENSOR_TYPE_MAGNETIC_FIELD = 6, HDF_SENSOR_TYPE_CAPACITIVE = 7,   HDF_SENSOR_TYPE_BAROMETER = 8, HDF_SENSOR_TYPE_TEMPERATURE = 9, HDF_SENSOR_TYPE_HALL = 10, HDF_SENSOR_TYPE_GESTURE = 11,   HDF_SENSOR_TYPE_PROXIMITY = 12, HDF_SENSOR_TYPE_HUMIDITY = 13, HDF_SENSOR_TYPE_MEDICAL_BEGIN = 128, HDF_SENSOR_TYPE_MEDICAL_END = 160,   HDF_SENSOR_TYPE_PHYSICAL_MAX = 255, HDF_SENSOR_TYPE_ORIENTATION = 256, HDF_SENSOR_TYPE_GRAVITY = 257, HDF_SENSOR_TYPE_LINEAR_ACCELERATION = 258,   HDF_SENSOR_TYPE_ROTATION_VECTOR = 259, HDF_SENSOR_TYPE_AMBIENT_TEMPERATURE = 260, HDF_SENSOR_TYPE_MAGNETIC_FIELD_UNCALIBRATED = 261, HDF_SENSOR_TYPE_GAME_ROTATION_VECTOR = 262,   HDF_SENSOR_TYPE_GYROSCOPE_UNCALIBRATED = 263, HDF_SENSOR_TYPE_SIGNIFICANT_MOTION = 264, HDF_SENSOR_TYPE_PEDOMETER_DETECTION = 265, HDF_SENSOR_TYPE_PEDOMETER = 266,   HDF_SENSOR_TYPE_GEOMAGNETIC_ROTATION_VECTOR = 277, HDF_SENSOR_TYPE_HEART_RATE = 278, HDF_SENSOR_TYPE_DEVICE_ORIENTATION = 279, HDF_SENSOR_TYPE_WEAR_DETECTION = 280,   HDF_SENSOR_TYPE_ACCELEROMETER_UNCALIBRATED = 281, HDF_SENSOR_TYPE_MAX } | 定义传感器类型标识。 | +| [HdfSensorGroupType](#hdfsensorgrouptype) { HDF_TRADITIONAL_SENSOR_TYPE = 0, HDF_MEDICAL_SENSOR_TYPE = 1, HDF_SENSOR_GROUP_TYPE_MAX } | 枚举传感器的硬件服务组。 | +| [HdfSensorModeType](#hdfsensormodetype) {   SENSOR_MODE_DEFAULT = 0, SENSOR_MODE_REALTIME = 1, SENSOR_MODE_ON_CHANGE = 2, SENSOR_MODE_ONE_SHOT = 3,   SENSOR_MODE_FIFO_MODE = 4, SENSOR_MODE_MAX } | 传感器的工作模式。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.sensor.v1_0 | Sensor模块接口的包路径。 | + + +## **枚举类型说明** + + +### HdfSensorGroupType + + +``` +enum HdfSensorGroupType +``` + +**描述：** + +枚举传感器的硬件服务组。 + + | 枚举值 | 描述 | +| -------- | -------- | +| HDF_TRADITIONAL_SENSOR_TYPE | 传统传感器类型，传感器ID枚举值范围不在128-160之间。 | +| HDF_MEDICAL_SENSOR_TYPE | 医疗传感器类型，传感器ID枚举值范围在128-160之间。 | +| HDF_SENSOR_GROUP_TYPE_MAX | 最大传感器类型。 | + + +### HdfSensorModeType + + +``` +enum HdfSensorModeType +``` + +**描述：** + +传感器的工作模式。 + + | 枚举值 | 描述 | +| -------- | -------- | +| SENSOR_MODE_DEFAULT | 传感器数据默认上报模式。 | +| SENSOR_MODE_REALTIME | 传感器数据持续上报模式。 | +| SENSOR_MODE_ON_CHANGE | 传感器数据变更时上报模式。 | +| SENSOR_MODE_ONE_SHOT | 传感器一次数据上报模式。 | +| SENSOR_MODE_FIFO_MODE | 传感器数据缓存模式。 | +| SENSOR_MODE_MAX | 传感器最大类型标识。 | + + +### HdfSensorTypeTag + + +``` +enum HdfSensorTypeTag +``` + +**描述：** + +定义传感器类型标识。 + + | 枚举值 | 描述 | +| -------- | -------- | +| HDF_SENSOR_TYPE_NONE | 空传感器类型，用于测试。 | +| HDF_SENSOR_TYPE_ACCELEROMETER | 加速度传感器。 | +| HDF_SENSOR_TYPE_GYROSCOPE | 陀螺仪传感器。 | +| HDF_SENSOR_TYPE_PHOTOPLETHYSMOGRAPH | 心率传感器。 | +| HDF_SENSOR_TYPE_ELECTROCARDIOGRAPH | 心电传感器。 | +| HDF_SENSOR_TYPE_AMBIENT_LIGHT | 环境光传感器。 | +| HDF_SENSOR_TYPE_MAGNETIC_FIELD | 地磁传感器。 | +| HDF_SENSOR_TYPE_CAPACITIVE | 电容传感器。 | +| HDF_SENSOR_TYPE_BAROMETER | 气压计传感器。 | +| HDF_SENSOR_TYPE_TEMPERATURE | 温度传感器。 | +| HDF_SENSOR_TYPE_HALL | 霍尔传感器。 | +| HDF_SENSOR_TYPE_GESTURE | 手势传感器。 | +| HDF_SENSOR_TYPE_PROXIMITY | 接近光传感器。 | +| HDF_SENSOR_TYPE_HUMIDITY | 湿度传感器。 | +| HDF_SENSOR_TYPE_MEDICAL_BEGIN | 医疗传感器ID枚举值范围的开始。 | +| HDF_SENSOR_TYPE_MEDICAL_END | 医疗传感器ID枚举值范围的结束。 | +| HDF_SENSOR_TYPE_PHYSICAL_MAX | 物理传感器最大类型。 | +| HDF_SENSOR_TYPE_ORIENTATION | 方向传感器。 | +| HDF_SENSOR_TYPE_GRAVITY | 重力传感器。 | +| HDF_SENSOR_TYPE_LINEAR_ACCELERATION | 线性加速度传感器。 | +| HDF_SENSOR_TYPE_ROTATION_VECTOR | 旋转矢量传感器。 | +| HDF_SENSOR_TYPE_AMBIENT_TEMPERATURE | 环境温度传感器。 | +| HDF_SENSOR_TYPE_MAGNETIC_FIELD_UNCALIBRATED | 未校准磁场传感器。 | +| HDF_SENSOR_TYPE_GAME_ROTATION_VECTOR | 游戏旋转矢量传感器。 | +| HDF_SENSOR_TYPE_GYROSCOPE_UNCALIBRATED | 未校准陀螺仪传感器。 | +| HDF_SENSOR_TYPE_SIGNIFICANT_MOTION | 大幅度动作传感器。 | +| HDF_SENSOR_TYPE_PEDOMETER_DETECTION | 计步器检测传感器。 | +| HDF_SENSOR_TYPE_PEDOMETER | 计步器传感器。 | +| HDF_SENSOR_TYPE_GEOMAGNETIC_ROTATION_VECTOR | 地磁旋转矢量传感器。 | +| HDF_SENSOR_TYPE_HEART_RATE | 心率传感器。 | +| HDF_SENSOR_TYPE_DEVICE_ORIENTATION | 设备方向传感器。 | +| HDF_SENSOR_TYPE_WEAR_DETECTION | 佩戴检测传感器。 | +| HDF_SENSOR_TYPE_ACCELEROMETER_UNCALIBRATED | 未校准加速度传感器。 | +| HDF_SENSOR_TYPE_MAX | 传感器类型最大个数标识。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/sensor__if_8h.md b/zh-cn/device-dev/reference/hdi-apis/sensor__if_8h.md deleted file mode 100644 index 886db580b0e774b24cce3e329d712189beaaaa9d..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/sensor__if_8h.md +++ /dev/null @@ -1,39 +0,0 @@ -# sensor_if.h - - -## **概述** - -**所属模块:** - -[Sensor](_sensor.md) - - -## **汇总** - - -### 类 - -| 类 | 描述 | -| -------- | -------- | -| [SensorInterface](_sensor_interface.md) | 提供sensor设备基本控制操作接口。 [更多...](_sensor_interface.md) | - - -### 函数 - -| 函数 | 描述 | -| -------- | -------- | -| [NewSensorInterfaceInstance](_sensor.md#newsensorinterfaceinstance) (void) | 创建传感器接口实例。 [更多...](_sensor.md#newsensorinterfaceinstance) | -| [FreeSensorInterfaceInstance](_sensor.md#freesensorinterfaceinstance) (void) | 释放传感器接口实例。 [更多...](_sensor.md#freesensorinterfaceinstance) | - - -## **详细描述** - -Sensor模块对外通用的接口声明文件，提供获取传感器设备信息、订阅/取消订阅传感器数据、 使能/去使能传感器、设置传感器模式、设置传感器精度，量程等可选配置接口定义。 - -**Since：** - -2.2 - -**Version：** - -1.0 diff --git a/zh-cn/device-dev/reference/hdi-apis/sensor__type_8h.md b/zh-cn/device-dev/reference/hdi-apis/sensor__type_8h.md deleted file mode 100644 index 35adb8935df3946a74ce804b53a713680154aedc..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/sensor__type_8h.md +++ /dev/null @@ -1,59 +0,0 @@ -# sensor_type.h - - -## **概述** - -**所属模块:** - -[Sensor](_sensor.md) - - -## **汇总** - - -### 类 - - | 类 | 描述 | -| -------- | -------- | -| [SensorInformation](_sensor_information.md) | 定义传感器基本信息。 [更多...](_sensor_information.md) | -| [SensorEvents](_sensor_events.md) | 上报传感器数据结构。 [更多...](_sensor_events.md) | - - -### 宏定义 - - | 宏定义 | 描述 | -| -------- | -------- | -| [SENSOR_NAME_MAX_LEN](_sensor.md#sensornamemaxlen)   32 | Sensor名称的最大长度 | -| [SENSOR_VERSION_MAX_LEN](_sensor.md#sensorversionmaxlen)   16 | Sensor版本号的最大长度 | - - -### 类型定义 - - | 类型定义 | 描述 | -| -------- | -------- | -| ([RecordDataCallback](_sensor.md#recorddatacallback)) (const struct [SensorEvents](_sensor_events.md) \*) | 传感器上报数据回调函数的定义，传感器服务用户在订阅传感器时， 需要注册上报数据回调函数，传感器使能后，传感器服务用户可以接受到传感器数据，详见[SensorInterface](_sensor_interface.md)。 [更多...](_sensor.md#recorddatacallback) | - - -### 枚举 - - | 枚举 | 描述 | -| -------- | -------- | -| [SensorStatus](_sensor.md#sensorstatus) { SENSOR_SUCCESS = 0, SENSOR_FAILURE = -1, SENSOR_NOT_SUPPORT = -2, SENSOR_INVALID_PARAM = -3,   SENSOR_INVALID_SERVICE = -4, SENSOR_NULL_PTR = -5 } | 定义传感器模块返回值类型。 [更多...](_sensor.md#sensorstatus) | -| [SensorTypeTag](_sensor.md#sensortypetag) { SENSOR_TYPE_NONE = 0, SENSOR_TYPE_ACCELEROMETER = 1, SENSOR_TYPE_GYROSCOPE = 2, SENSOR_TYPE_PHOTOPLETHYSMOGRAPH = 3,   SENSOR_TYPE_ELECTROCARDIOGRAPH = 4, SENSOR_TYPE_AMBIENT_LIGHT = 5, SENSOR_TYPE_MAGNETIC_FIELD = 6, SENSOR_TYPE_CAPACITIVE = 7,   SENSOR_TYPE_BAROMETER = 8, SENSOR_TYPE_TEMPERATURE = 9, SENSOR_TYPE_HALL = 10, SENSOR_TYPE_GESTURE = 11,   SENSOR_TYPE_PROXIMITY = 12, SENSOR_TYPE_HUMIDITY = 13, SENSOR_TYPE_MEDICAL_BEGIN = 128, SENSOR_TYPE_MEDICAL_END = 160,   SENSOR_TYPE_PHYSICAL_MAX = 255, SENSOR_TYPE_ORIENTATION = 256, SENSOR_TYPE_GRAVITY = 257, SENSOR_TYPE_LINEAR_ACCELERATION = 258,   SENSOR_TYPE_ROTATION_VECTOR = 259, SENSOR_TYPE_AMBIENT_TEMPERATURE = 260, SENSOR_TYPE_MAGNETIC_FIELD_UNCALIBRATED = 261, SENSOR_TYPE_GAME_ROTATION_VECTOR = 262,   SENSOR_TYPE_GYROSCOPE_UNCALIBRATED = 263, SENSOR_TYPE_SIGNIFICANT_MOTION = 264, SENSOR_TYPE_PEDOMETER_DETECTION = 265, SENSOR_TYPE_PEDOMETER = 266,   SENSOR_TYPE_GEOMAGNETIC_ROTATION_VECTOR = 277, SENSOR_TYPE_HEART_RATE = 278, SENSOR_TYPE_DEVICE_ORIENTATION = 279, SENSOR_TYPE_WEAR_DETECTION = 280,   SENSOR_TYPE_ACCELEROMETER_UNCALIBRATED = 281, SENSOR_TYPE_MAX } | 定义传感器类型标识。 [更多...](_sensor.md#sensortypetag) | -| [SensorAccuracyType](_sensor.md#sensoraccuracytype) { SENSOR_NO_ACCURACY = 0, SENSOR_LOW_ACCURACY = 1, SENSOR_MEDIUM_ACCURACY = 2, SENSOR_HIGH_ACCURACY = 3,   SENSOR_MAX_ACCURACY } | 传感器的精度类型。 [更多...](_sensor.md#sensoraccuracytype) | -| [SensorRangeType](_sensor.md#sensorrangetype) { SENSOR_RANGE_LEVEL1 = 0, SENSOR_RANGE_LEVEL2 = 1, SENSOR_RANGE_LEVEL3 = 2, SENSOR_RANGE_LEVEL_MAX } | 传感器的量程级别。 [更多...](_sensor.md#sensorrangetype) | -| [SensorModeType](_sensor.md#sensormodetype) { SENSOR_MODE_DEFAULT = 0, SENSOR_MODE_REALTIME = 1, SENSOR_MODE_ON_CHANGE = 2, SENSOR_MODE_ONE_SHOT = 3,   SENSOR_MODE_FIFO_MODE = 4, SENSOR_MODE_MAX } | 传感器的工作模式。 [更多...](_sensor.md#sensormodetype) | -| [SensorGroupType](_sensor.md#sensorgrouptype) { TRADITIONAL_SENSOR_TYPE = 0, MEDICAL_SENSOR_TYPE = 1, SENSOR_GROUP_TYPE_MAX } | 枚举传感器的硬件服务组。 [更多...](_sensor.md#sensorgrouptype) | - - -## **详细描述** - -定义传感器模块所使用的传感器类型，传感器信息，传感器数据结构等数据类型。 - -**Since：** - -2.2 - -**Version：** - -1.0 diff --git a/zh-cn/device-dev/reference/hdi-apis/thermal.md b/zh-cn/device-dev/reference/hdi-apis/thermal.md index d639a37e380cc8615bd0440eee3909523152865b..72a5d3edf656d93a1cb5587840d022fc181f7e3d 100644 --- a/zh-cn/device-dev/reference/hdi-apis/thermal.md +++ b/zh-cn/device-dev/reference/hdi-apis/thermal.md @@ -1,12 +1,27 @@ # Thermal +## **概述** + +提供设备温度管理、控制及订阅接口。 + +热模块为热服务提供的设备温度管理、控制及订阅接口。服务获取此模块的对象或代理后，可以调用相关的接口管理、控制和订阅设备温度。 + +**Since**: + +3.1 + +**Version**: + +1.0 + + ## **汇总** ### 文件 - | 文件 | 描述 | + | 名称 | 描述 | | -------- | -------- | | [IThermalCallback.idl](_i_thermal_callback_8idl.md) | 设备发热状态的回调。 | | [IThermalInterface.idl](_i_thermal_interface_8idl.md) | 设备温度管理、控制及订阅接口。 | @@ -15,31 +30,16 @@ ### 类 - | 类 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| [IThermalCallback](interface_i_thermal_callback.md) | 订阅设备发热状态的回调。 [更多...](interface_i_thermal_callback.md) | -| [IThermalInterface](interface_i_thermal_interface.md) | 设备温度管理、控制及订阅接口。 [更多...](interface_i_thermal_interface.md) | -| [ThermalZoneInfo](_thermal_zone_info.md) | 设备发热的信息。 [更多...](_thermal_zone_info.md) | -| [HdfThermalCallbackInfo](_hdf_thermal_callback_info.md) | 设备发热的信息列表。 [更多...](_hdf_thermal_callback_info.md) | +| [IThermalCallback](interface_i_thermal_callback.md) | 订阅设备发热状态的回调。 | +| [IThermalInterface](interface_i_thermal_interface.md) | 设备温度管理、控制及订阅接口。 | +| [ThermalZoneInfo](_thermal_zone_info.md) | 设备发热的信息。 | +| [HdfThermalCallbackInfo](_hdf_thermal_callback_info.md) | 设备发热的信息列表。 | -### 变量 +### 关键字 - | 变量 名称 | 描述 | + | 名称 | 描述 | | -------- | -------- | -| package ohos.hdi.thermal.v1_0 | 设备温度管理接口的包路径 | - - -## **详细描述** - -提供设备温度管理、控制及订阅接口。 - -热模块为热服务提供的设备温度管理、控制及订阅接口。 服务获取此模块的对象或代理后，可以调用相关的接口管理、控制和订阅设备温度。 - -**Since：** - -3.1 - -**Version：** - -1.0 +| package ohos.hdi.thermal.v1_0 | Thermal模块接口的包路径。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/total.md b/zh-cn/device-dev/reference/hdi-apis/total.md new file mode 100644 index 0000000000000000000000000000000000000000..bac50766065bf942c00fe3d98e89e1772b2b5087 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/total.md @@ -0,0 +1,7 @@ +# 头文件和结构体 + + + +- **[头文件](files.md)** + +- **[结构体](annotated.md)** \ No newline at end of file diff --git a/zh-cn/device-dev/reference/hdi-apis/types_8h.md b/zh-cn/device-dev/reference/hdi-apis/types_8h.md deleted file mode 100644 index d464901d79c2444c7a1e1910b598dbe89cd1b8a0..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/types_8h.md +++ /dev/null @@ -1,61 +0,0 @@ -# types.h - - -## **概述** - -**所属模块:** - -[Camera](_camera.md) - - -## **汇总** - - -### 类 - - | 类 | 描述 | -| -------- | -------- | -| [OHOS::Camera::StreamInfo](_o_h_o_s_1_1_camera_1_1_stream_info.md) | 流信息，用于创建流时传入相关的配置参数。 [更多...](_o_h_o_s_1_1_camera_1_1_stream_info.md) | -| [OHOS::Camera::StreamAttribute](_o_h_o_s_1_1_camera_1_1_stream_attribute.md) | 流的属性。 [更多...](_o_h_o_s_1_1_camera_1_1_stream_attribute.md) | -| [OHOS::Camera::CaptureInfo](_o_h_o_s_1_1_camera_1_1_capture_info.md) | 捕获请求的相关信息。 [更多...](_o_h_o_s_1_1_camera_1_1_capture_info.md) | -| [OHOS::Camera::CaptureEndedInfo](_o_h_o_s_1_1_camera_1_1_capture_ended_info.md) | 捕获结束相关信息，用于捕获结束回调 **OnCaptureEnded**。 [更多...](_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) | 流错误信息，用于回调 **OnCaptureError**。 [更多...](_o_h_o_s_1_1_camera_1_1_capture_error_info.md) | - - -### 类型定义 - - | 类型定义 | 描述 | -| -------- | -------- | -| **OHOS::Camera::CameraAbility** = CameraMetadata | Camera设备能力集合。 | -| **OHOS::Camera::CameraSetting** = CameraMetadata | Camera设置参数，包括sensor帧率，3A相关参数等。 | -| **OHOS::Camera::MetaType** = int32_t | 整型。 | - - -### 枚举 - - | 枚举 | 描述 | -| -------- | -------- | -| [OHOS::Camera::CamRetCode](_camera.md#camretcode) : int32_t {   OHOS::Camera::NO_ERROR = 0, OHOS::Camera::CAMERA_BUSY = -1, OHOS::Camera::INSUFFICIENT_RESOURCES = -2, OHOS::Camera::INVALID_ARGUMENT = -3,   OHOS::Camera::METHOD_NOT_SUPPORTED = -4, OHOS::Camera::CAMERA_CLOSED = -5, OHOS::Camera::DEVICE_ERROR = -6 } | HDI接口的返回值。 [更多...](_camera.md#camretcode) | -| [OHOS::Camera::ResultCallbackMode](_camera.md#resultcallbackmode) : int32_t { OHOS::Camera::PER_FRAME, OHOS::Camera::ON_CHANGED } | metadata的上报模式。 [更多...](_camera.md#resultcallbackmode) | -| [OHOS::Camera::OperationMode](_camera.md#operationmode) : int32_t { OHOS::Camera::NORMAL = 0 } | 流的使用模式。 [更多...](_camera.md#operationmode) | -| [OHOS::Camera::StreamIntent](_camera.md#streamintent) : int32_t {   OHOS::Camera::PREVIEW = 0, OHOS::Camera::VIDEO = 1, OHOS::Camera::STILL_CAPTURE = 2, OHOS::Camera::POST_VIEW = 3,   OHOS::Camera::ANALYZE = 4, OHOS::Camera::CUSTOM = 5 } | 流的类型。 [更多...](_camera.md#streamintent) | -| [OHOS::Camera::EncodeType](_camera.md#encodetype) : int32_t { OHOS::Camera::ENCODE_TYPE_NULL = 0, OHOS::Camera::ENCODE_TYPE_H264 = 1, OHOS::Camera::ENCODE_TYPE_H265 = 2, OHOS::Camera::ENCODE_TYPE_JPEG = 3 } | 流数据的编码类型。 [更多...](_camera.md#encodetype) | -| [OHOS::Camera::StreamSupportType](_camera.md#streamsupporttype) : int32_t { OHOS::Camera::DYNAMIC_SUPPORTED, OHOS::Camera::RE_CONFIGURED_REQUIRED, OHOS::Camera::NOT_SUPPORTED } | 动态配置流的切换方式，使用场景参考 [IsStreamsSupported](_camera.md#isstreamssupported) 。 [更多...](_camera.md#streamsupporttype) | -| [OHOS::Camera::CameraStatus](_camera.md#camerastatus) { OHOS::Camera::UN_AVAILABLE = 0, OHOS::Camera::AVAILABLE = 1 } | Camera设备状态。 [更多...](_camera.md#camerastatus) | -| [OHOS::Camera::FlashlightStatus](_camera.md#flashlightstatus) : uint32_t { OHOS::Camera::FLASHLIGHT_OFF = 0, OHOS::Camera::FLASHLIGHT_ON = 1, OHOS::Camera::FLASHLIGHT_UNAVAILABLE = 2 } | 闪光灯状态。 [更多...](_camera.md#flashlightstatus) | -| [OHOS::Camera::CameraEvent](_camera.md#cameraevent): uint32_t { OHOS::Camera::CAMERA_EVENT_DEVICE_ADD = 0, OHOS::Camera::CAMERA_EVENT_DEVICE_RMV = 1 } | Camera事件。 [更多...](_camera.md#cameraevent) | -| [OHOS::Camera::ErrorType](_camera.md#errortype) : uint32_t { OHOS::Camera::FATAL_ERROR = 0, OHOS::Camera::REQUEST_TIMEOUT = 1 } | 设备错误类型，用于设备错误回调 **OnError**。 [更多...](_camera.md#errortype) | -| [OHOS::Camera::StreamError](_camera.md#streamerror) { OHOS::Camera::UNKNOWN_ERROR = 0, OHOS::Camera::BUFFER_LOST = 1 } | 流错误类型，用于流错误类型 **CaptureErrorInfo**。 [更多...](_camera.md#streamerror) | - - -## **详细描述** - -Camera模块HDI接口使用的数据类型。 - -**Since：** - -1.0 - -**Version：** - -1.0 diff --git a/zh-cn/device-dev/reference/hdi-apis/union_audio_scene_descriptor_1_1_scene_desc.md b/zh-cn/device-dev/reference/hdi-apis/union_audio_scene_descriptor_1_1_scene_desc.md index 8de76492ce9026d0aea6c5a71bd5ca2ad479d361..f9291a99bb1b489827b8e47ed1a33301215de8df 100644 --- a/zh-cn/device-dev/reference/hdi-apis/union_audio_scene_descriptor_1_1_scene_desc.md +++ b/zh-cn/device-dev/reference/hdi-apis/union_audio_scene_descriptor_1_1_scene_desc.md @@ -3,7 +3,9 @@ ## **概述** -**所属模块:** +音频场景描述。 + +**相关模块:** [Audio](_audio.md) @@ -13,12 +15,7 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | | [id](_audio.md#id) | 音频场景的ID。 | | [desc](_audio.md#desc-35) | 以字符串命名的音频场景。 | - - -## **详细描述** - -音频场景描述。 diff --git a/zh-cn/device-dev/reference/hdi-apis/union_color_value.md b/zh-cn/device-dev/reference/hdi-apis/union_color_value.md new file mode 100644 index 0000000000000000000000000000000000000000..49a63ccebf1a51b82141b05378791a5aa7030268 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/union_color_value.md @@ -0,0 +1,50 @@ +# ColorValue + + +## **概述** + +定义灯的颜色模式。 + +参数包括RGB模式和WRGB模式。 + +**相关模块:** + +[Light](light.md) + + +## **汇总** + + +### Public 属性 + + | 名称 | 描述 | +| -------- | -------- | +| [wrgbColor](#wrgbcolor) | WRGB模式 | +| [rgbColor](#rgbcolor) | RGB模式 | + + +## **类成员变量说明** + + +### rgbColor + + +``` +struct RGBColor ColorValue::rgbColor +``` + +**描述：** + +RGB模式, 详见[RGBColor](_r_g_b_color.md)。 + + +### wrgbColor + + +``` +struct WRGBColor ColorValue::wrgbColor +``` + +**描述：** + +WRGB模式, 详见[WRGBColor](_w_r_g_b_color.md)。 diff --git a/zh-cn/device-dev/reference/hdi-apis/union_port_cap.md b/zh-cn/device-dev/reference/hdi-apis/union_port_cap.md index 3e1b3f060202249675ae58d842207e63f25152dd..015901e57a6474e086908bec3f88c427c14db67e 100644 --- a/zh-cn/device-dev/reference/hdi-apis/union_port_cap.md +++ b/zh-cn/device-dev/reference/hdi-apis/union_port_cap.md @@ -3,9 +3,11 @@ ## **概述** -**所属模块:** +定义音视频编解码能力。 + +**相关模块:** -[Codec](_codec.md) +[Codec](codec.md) ## **汇总** @@ -13,17 +15,12 @@ ### Public 属性 - | Public 属性 | 描述 | + | 名称 | 描述 | | -------- | -------- | | [video](#video) | 视频编解码能力 | | [audio](#audio) | 音频编解码能力 | -## **详细描述** - -定义音视频编解码能力。 - - ## **类成员变量说明** @@ -36,7 +33,7 @@ AudioPortCap PortCap::audio **描述：** -音频编解码能力 +音频编解码能力。 ### video @@ -48,4 +45,4 @@ VideoPortCap PortCap::video **描述：** -视频编解码能力 +视频编解码能力。 diff --git a/zh-cn/device-dev/reference/hdi-apis/usb.md b/zh-cn/device-dev/reference/hdi-apis/usb.md new file mode 100644 index 0000000000000000000000000000000000000000..494b00f32ef88eed39019685303d6435bbf0ffc9 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/usb.md @@ -0,0 +1,50 @@ +# USB + + +## **概述** + +提供统一的USB驱动标准接口，实现USB驱动接入。 + +上层USB服务开发人员可以根据USB驱动模块提供的标准接口获取如下功能：打开/关闭设备，获取设备描述符，获取文件描述符，打开/关闭接口，批量读取/写入数据， 设置/获取设备功能，绑定/解绑订阅者等。 + +**Since**: + +3.2 + +**Version**: + +1.0 + + +## **汇总** + + +### 文件 + + | 名称 | 描述 | +| -------- | -------- | +| [IUsbdBulkCallback.idl](_i_usbd_bulk_callback_8idl.md) | USB驱动批量传输读/写数据的回调。 | +| [IUsbdSubscriber.idl](_i_usbd_subscriber_8idl.md) | USB驱动的订阅函数。 | +| [IUsbInterface.idl](_i_usb_interface_8idl.md) | 声明标准的USB驱动接口函数。 | +| [UsbTypes.idl](_usb_types_8idl.md) | USB驱动相关的数据类型。 | + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [IUsbdBulkCallback](interface_i_usbd_bulk_callback.md) | USB驱动的回调函数。 | +| [IUsbdSubscriber](interface_i_usbd_subscriber.md) | 定义USB驱动的订阅类相关函数。 | +| [IUsbInterface](interface_i_usb_interface.md) | 定义USB驱动基本的操作功能。 | +| [PortInfo](_port_info.md) | USB设备端口信息。 | +| [UsbDev](_usb_dev.md) | USB设备地址信息。 | +| [UsbPipe](_usb_pipe.md) | USB设备管道信息。 | +| [UsbCtrlTransfer](_usb_ctrl_transfer.md) | USB设备控制传输信息。 | +| [USBDeviceInfo](_u_s_b_device_info.md) | USB设备信息。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.usb.v1_0 | USB驱动接口的包路径。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/usb__info_8h.md b/zh-cn/device-dev/reference/hdi-apis/usb__info_8h.md deleted file mode 100644 index 4d075be4d50a0065bee81aa13f8f93b56c68876c..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/usb__info_8h.md +++ /dev/null @@ -1,32 +0,0 @@ -# usb_info.h - - -## **概述** - -**所属模块:** - -[USB](_u_s_b.md) - - -## **汇总** - - -### 类 - - | 类 | 描述 | -| -------- | -------- | -| [OHOS::USB::USBDeviceInfo](_o_h_o_s_1_1_u_s_b_1_1_u_s_b_device_info.md) | USB设备信息。 [更多...](_o_h_o_s_1_1_u_s_b_1_1_u_s_b_device_info.md) | -| [OHOS::USB::UsbInfo](_o_h_o_s_1_1_u_s_b_1_1_usb_info.md) | USB设备信息类。 [更多...](_o_h_o_s_1_1_u_s_b_1_1_usb_info.md) | - - -## **详细描述** - -USB驱动订阅模块使用的数据类型。 - -**Since：** - -3.0 - -**Version：** - -1.0 diff --git a/zh-cn/device-dev/reference/hdi-apis/usbd__client_8h.md b/zh-cn/device-dev/reference/hdi-apis/usbd__client_8h.md deleted file mode 100644 index e8ca6691a0b58d02be9447301431287af1273c80..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/usbd__client_8h.md +++ /dev/null @@ -1,31 +0,0 @@ -# usbd_client.h - - -## **概述** - -**所属模块:** - -[USB](_u_s_b.md) - - -## **汇总** - - -### 类 - - | 类 | 描述 | -| -------- | -------- | -| [OHOS::USB::UsbdClient](_o_h_o_s_1_1_u_s_b_1_1_usbd_client.md) | USB驱动类。[更多...](_o_h_o_s_1_1_u_s_b_1_1_usbd_client.md) | - - -## **详细描述** - -声明标准USB驱动接口函数。 - -**Since：** - -3.0 - -**Version：** - -1.0 diff --git a/zh-cn/device-dev/reference/hdi-apis/usbd__subscriber_8h.md b/zh-cn/device-dev/reference/hdi-apis/usbd__subscriber_8h.md deleted file mode 100644 index 5bddc2d6b20509f2b5d0cfd6b7be46ee5503f7b7..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/usbd__subscriber_8h.md +++ /dev/null @@ -1,31 +0,0 @@ -# usbd_subscriber.h - - -## **概述** - -**所属模块:** - -[USB](_u_s_b.md) - - -## **汇总** - - -### 类 - - | 类 | 描述 | -| -------- | -------- | -| [OHOS::USB::UsbdSubscriber](_o_h_o_s_1_1_u_s_b_1_1_usbd_subscriber.md) | USB订阅类。[更多...](_o_h_o_s_1_1_u_s_b_1_1_usbd_subscriber.md) | - - -## **详细描述** - -USB驱动订阅模块。 - -**Since：** - -3.0 - -**Version：** - -1.0 diff --git a/zh-cn/device-dev/reference/hdi-apis/usbd__type_8h.md b/zh-cn/device-dev/reference/hdi-apis/usbd__type_8h.md deleted file mode 100644 index a8a3c6bdb08dc9fa640877e6569b59c5af4b287f..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/usbd__type_8h.md +++ /dev/null @@ -1,67 +0,0 @@ -# usbd_type.h - - -## **概述** - -**所属模块:** - -[USB](_u_s_b.md) - - -## **汇总** - - -### 类 - - | 类 | 描述 | -| -------- | -------- | -| [OHOS::USB::UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) | USB设备。 [更多...](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) | -| [OHOS::USB::UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md) | 管道信息。 [更多...](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md) | -| [OHOS::USB::UsbCtrlTransfer](_o_h_o_s_1_1_u_s_b_1_1_usb_ctrl_transfer.md) | USB控制传输。 [更多...](_o_h_o_s_1_1_u_s_b_1_1_usb_ctrl_transfer.md) | -| [OHOS::USB::USBDeviceInfo](_o_h_o_s_1_1_u_s_b_1_1_u_s_b_device_info.md) | USB设备信息。 [更多...](_o_h_o_s_1_1_u_s_b_1_1_u_s_b_device_info.md) | - - -### 宏定义 - - | 宏定义 | 描述 | -| -------- | -------- | -| [USB_MAX_INTERFACES](_u_s_b.md#usbmaxinterfaces)   32 | USB设备最大接口数量。 | - -### 静态常量 - - | 静态常量 | 描述 | -| -------- | -------- | -| [USB_ENDPOINT_DIR_MASK](_u_s_b.md#usb\_endpoint\_dir\_mask)   0x80 | 从地址中提取USB Endpoint方向的位掩码。 | -| [USB_ENDPOINT_DIR_IN](_u_s_b.md#usb\_endpoint\_dir\_in)   0x80 | USB Endpoint从设备到主机的数据方向。 | -| [USB_ENDPOINT_DIR_OUT](_u_s_b.md#usb\_endpoint\_dir\_out)   0 | USB Endpoint从主机到设备的数据方向。 | - - - -### 类型定义 - - | 类型定义 | 描述 | -| -------- | -------- | -| ([UsbdRequestCallback](_u_s_b.md#usbdrequestcallback)) (uint8_t \*requestArg) | 请求回调函数。 | - - -### 枚举 - - | 枚举 | 描述 | -| -------- | -------- | -| [UsbdBulkCbCmd](_u_s_b.md#usbdbulkcbcmd) { CMD_USBD_BULK_CALLBACK_READ, CMD_USBD_BULK_CALLBACK_WRITE } | 批量回调命令字。 [更多...](_u_s_b.md#usbdbulkcbcmd) | -| [UsbdDeviceAction](_u_s_b.md#usbddeviceaction) { ACT_DEVUP = 0, ACT_DEVDOWN, ACT_UPDEVICE, ACT_DOWNDEVICE } | 主机端和设备端插拔事件。 [更多...](_u_s_b.md#usbddeviceaction) | - - -## **详细描述** - -USB驱动模块接口定义中使用的自定义数据类型。 - -USB驱动模块接口定义中使用的自定义数据类型, 包括分发的命令字、数据方向等。 - -**Since：** - -3.0 - -**Version：** - -1.0 diff --git a/zh-cn/device-dev/reference/hdi-apis/vibrator.md b/zh-cn/device-dev/reference/hdi-apis/vibrator.md new file mode 100644 index 0000000000000000000000000000000000000000..2d6e1c4eb804fe204f991cb2644e6ef13612028c --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/vibrator.md @@ -0,0 +1,70 @@ +# Vibrator + + +## **概述** + +马达驱动对马达服务提供通用的接口能力。 + +模块提供马达服务对马达驱动访问的统一接口，服务获取驱动对象或者代理后，控制马达的单次振动、周期性振动、停止振动、设置马达振幅与频率。 + +**Since**: + +3.2 + +**Version**: + +1.1 + + +## **汇总** + + +### 文件 + + | 名称 | 描述 | +| -------- | -------- | +| [IVibratorInterface.idl](_i_vibrator_interface_8idl.md) | 定义马达的通用API，可用于控制马达执行单次或周期性振动、设置马达振幅与频率。 | +| [VibratorTypes.idl](_vibrator_types_8idl.md) | 定义马达数据结构，包括马达振动模式和马达参数。 | + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [IVibratorInterface](interface_i_vibrator_interface.md) | Vibrator模块向上层服务提供统一的接口。 | +| [HdfVibratorInfo](_hdf_vibrator_info.md) | 定义马达参数。 | + + +### 枚举 + + | 名称 | 描述 | +| -------- | -------- | +| [HdfVibratorMode](#hdfvibratormode) { HDF_VIBRATOR_MODE_ONCE, HDF_VIBRATOR_MODE_PRESET, HDF_VIBRATOR_MODE_BUTT } | 枚举马达的振动模式。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.vibrator.v1_1 | 马达模块接口的包路径。 | + + +## **枚举类型说明** + + +### HdfVibratorMode + + +``` +enum HdfVibratorMode +``` + +**描述:** + +枚举马达的振动模式。 + + | 枚举值 | 描述 | +| -------- | -------- | +| HDF_VIBRATOR_MODE_ONCE | 表示给定持续时间内的单次振动。 | +| HDF_VIBRATOR_MODE_PRESET | 表示具有预置效果的周期性振动。 | +| HDF_VIBRATOR_MODE_BUTT | 表示效果模式无效。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/vibrator__if_8h.md b/zh-cn/device-dev/reference/hdi-apis/vibrator__if_8h.md deleted file mode 100644 index 29b0c3a7c21a41ed4c0ae62ab3d56da43c59c3ea..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/vibrator__if_8h.md +++ /dev/null @@ -1,39 +0,0 @@ -# vibrator_if.h - - -## **概述** - -**所属模块:** - -[Vibrator](_vibrator.md) - - -## **汇总** - - -### 类 - - | 类 | 描述 | -| -------- | -------- | -| [VibratorInterface](_vibrator_interface.md) | 提供Vibrator设备基本控制操作接口。 | - - -### 函数 - - | 函数 | 描述 | -| -------- | -------- | -| [NewVibratorInterfaceInstance](_vibrator.md#newvibratorinterfaceinstance) (void) | 创建一个VibratorInterface实例。 [更多...](_vibrator.md#newvibratorinterfaceinstance) | -| [FreeVibratorInterfaceInstance](_vibrator.md#freevibratorinterfaceinstance) (void) | 释放VibratorInterface实例以及相关资源。 [更多...](_vibrator.md#freevibratorinterfaceinstance) | - - -## **详细描述** - -定义马达数据结构，包括马达模式和效果振动。 - -**Since：** - -2.2 - -**Version：** - -1.0 diff --git a/zh-cn/device-dev/reference/hdi-apis/vibrator__type_8h.md b/zh-cn/device-dev/reference/hdi-apis/vibrator__type_8h.md deleted file mode 100644 index 1abb949a8c7e380abacb367d82feffd85471982d..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/vibrator__type_8h.md +++ /dev/null @@ -1,33 +0,0 @@ -# vibrator_type.h - - -## **概述** - -**所属模块:** - -[Vibrator](_vibrator.md) - - -## **汇总** - - -### 枚举 - - | 枚举 | 描述 | -| -------- | -------- | -| [VibratorMode](_vibrator.md#vibratormode) { VIBRATOR_MODE_ONCE = 0, VIBRATOR_MODE_PRESET = 1, VIBRATOR_MODE_BUTT } | 枚举马达振动模式。 [更多...](_vibrator.md#vibratormode) | -| [VibratorStatus](_vibrator.md#vibratorstatus) { VIBRATOR_SUCCESS = 0, VIBRATOR_NOT_PERIOD = -1,  VIBRATOR_NOT_INTENSITY  = -2,  VIBRATOR_NOT_FREQUENCY= -3} | 枚举马达振动模式。[更多...](_vibrator.md#vibratorstatus) | -| [VibratorInfo](_vibrator.md#vibratorinfo) { isSupportIntensity, isSupportFrequency, intensityMaxValue, intensityMinValue, frequencyMaxValue, frequencyMinValue} | 定义马达参数。[更多...](_vibrator.md#vibratorinfo) | - - -## **详细描述** - -定义马达数据结构，包括马达模式和效果振动。 - -**Since：** - -2.2 - -**Version：** - -1.0 diff --git a/zh-cn/device-dev/reference/hdi-apis/wifi__hal_8h.md b/zh-cn/device-dev/reference/hdi-apis/wifi__hal_8h.md deleted file mode 100644 index ce0a6c3e0386722de46f68519df51ef20ba04ce5..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/wifi__hal_8h.md +++ /dev/null @@ -1,46 +0,0 @@ -# wifi_hal.h - - -## **概述** - -**所属模块:** - -[WLAN](_w_l_a_n.md) - - -## **汇总** - - -### 类 - - | 类 | 描述 | -| -------- | -------- | -| [IWiFi](_i_wi_fi.md) | HAL对WLAN服务提供的基本能力。 [更多...](_i_wi_fi.md) | - - -### 类型定义 - - | 类型定义 | 描述 | -| -------- | -------- | -| ([CallbackFunc](_w_l_a_n.md#callbackfunc)) (uint32_t event, void \*data, const char \*ifName) | 定义IWiFi回调函数的原型，监听异步事件。 [更多...](_w_l_a_n.md#callbackfunc) | - - -### 函数 - - | 函数 | 描述 | -| -------- | -------- | -| [WifiConstruct](_w_l_a_n.md#wificonstruct) (struct [IWiFi](_i_wi_fi.md) \*\*wifiInstance) | 创建IWiFi结构体，挂接[IWiFi](_i_wi_fi.md)中能力接口。 [更多...](_w_l_a_n.md#wificonstruct) | -| [WifiDestruct](_w_l_a_n.md#wifidestruct) (struct [IWiFi](_i_wi_fi.md) \*\*wifiInstance) | 销毁IWiFi结构体并释放相关资源。 [更多...](_w_l_a_n.md#wifidestruct) | - - -## **详细描述** - -提供给WLAN服务的WLAN基本能力接口。 - -**Since：** - -1.0 - -**Version：** - -1.0 diff --git a/zh-cn/device-dev/reference/hdi-apis/wifi__hal__ap__feature_8h.md b/zh-cn/device-dev/reference/hdi-apis/wifi__hal__ap__feature_8h.md deleted file mode 100644 index 5070b56b1ba8a62600a9a0486c7125d2ed457e9d..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/wifi__hal__ap__feature_8h.md +++ /dev/null @@ -1,39 +0,0 @@ -# wifi_hal_ap_feature.h - - -## **概述** - -**所属模块:** - -[WLAN](_w_l_a_n.md) - - -## **汇总** - - -### 类 - - | 类 | 描述 | -| -------- | -------- | -| [StaInfo](_sta_info.md) | 描述与AP连接的STA的基本信息 [更多...](_sta_info.md) | -| [IWiFiAp](_i_wi_fi_ap.md) | 继承了[IWiFiBaseFeature](_i_wi_fi_base_feature.md)基本特性，并包含AP模式下获取连接STA的信息和设置国家码的功能。 [更多...](_i_wi_fi_ap.md) | - - -### 函数 - - | 函数 | 描述 | -| -------- | -------- | -| [InitApFeature](_w_l_a_n.md#initapfeature) (struct [IWiFiAp](_i_wi_fi_ap.md) \*\*fe) | 初始化AP特性。WLAN服务在创建AP类型的特性[FeatureType](_w_l_a_n.md#featuretype)时调用。 [更多...](_w_l_a_n.md#initapfeature) | - - -## **详细描述** - -提供WLAN的AP特性能力（获取与AP连接的STA的基本信息、设置国家码）。 - -**Since：** - -1.0 - -**Version：** - -1.0 diff --git a/zh-cn/device-dev/reference/hdi-apis/wifi__hal__base__feature_8h.md b/zh-cn/device-dev/reference/hdi-apis/wifi__hal__base__feature_8h.md deleted file mode 100644 index 2507aeda6f531039f93e9db3bcb511b06f6622f3..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/wifi__hal__base__feature_8h.md +++ /dev/null @@ -1,54 +0,0 @@ -# wifi_hal_base_feature.h - - -## **概述** - -**所属模块:** - -[WLAN](_w_l_a_n.md) - - -## **汇总** - - -### 类 - - | 类 | 描述 | -| -------- | -------- | -| [IWiFiBaseFeature](_i_wi_fi_base_feature.md) | WLAN基本特性操作接口，包括获取网卡名称，设置MAC地址，设置发射功率等公共能力接口。 [更多...](_i_wi_fi_base_feature.md) | - - -### 宏定义 - - | 宏定义 | 描述 | -| -------- | -------- | -| [IFNAME_MAX_LEN](_w_l_a_n.md#ga63637ece87095ff8d153f650434ecf97)   16 | 网卡名称最大长度。 | -| [WIFI_MAC_ADDR_LENGTH](_w_l_a_n.md#ga27ea7645cf89c113dae48346e19a676f)   6 | WLAN的MAC地址长度。 | -| [ERR_UNAUTH_ACCESS](_w_l_a_n.md#gadfe9ac5a374d348cd8f77a84cd5ab94e)   (-6) | 定义访问失败错误码。 | - - -### 枚举 - - | 枚举 | 描述 | -| -------- | -------- | -| [FeatureType](_w_l_a_n.md#featuretype) {   PROTOCOL_80211_IFTYPE_UNSPECIFIED, PROTOCOL_80211_IFTYPE_ADHOC, PROTOCOL_80211_IFTYPE_STATION, PROTOCOL_80211_IFTYPE_AP,   PROTOCOL_80211_IFTYPE_AP_VLAN, PROTOCOL_80211_IFTYPE_WDS, PROTOCOL_80211_IFTYPE_MONITOR, PROTOCOL_80211_IFTYPE_MESH_POINT,   PROTOCOL_80211_IFTYPE_P2P_CLIENT, PROTOCOL_80211_IFTYPE_P2P_GO, PROTOCOL_80211_IFTYPE_P2P_DEVICE, PROTOCOL_80211_IFTYPE_NUM } | 枚举WLAN相关特性的类型[FeatureType](_w_l_a_n.md#featuretype)。 [更多...](_w_l_a_n.md#featuretype) | - - -### 函数 - - | 函数 | 描述 | -| -------- | -------- | -| [InitBaseFeature](_w_l_a_n.md#initbasefeature) (struct [IWiFiBaseFeature](_i_wi_fi_base_feature.md) \*\*fe) | WLAN服务创建任何类型的特性{\@Link FeatureType}时，都需要调用此函数。 [更多...](_w_l_a_n.md#initbasefeature) | - - -## **详细描述** - -提供WLAN基本特性能力。 - -**Since：** - -1.0 - -**Version：** - -1.0 diff --git a/zh-cn/device-dev/reference/hdi-apis/wifi__hal__sta__feature_8h.md b/zh-cn/device-dev/reference/hdi-apis/wifi__hal__sta__feature_8h.md deleted file mode 100644 index 66cf5f1a520a17a27b8806a589916e124d362d23..0000000000000000000000000000000000000000 --- a/zh-cn/device-dev/reference/hdi-apis/wifi__hal__sta__feature_8h.md +++ /dev/null @@ -1,38 +0,0 @@ -# wifi_hal_sta_feature.h - - -## **概述** - -**所属模块:** - -[WLAN](_w_l_a_n.md) - - -## **汇总** - - -### 类 - - | 类 | 描述 | -| -------- | -------- | -| [IWiFiSta](_i_wi_fi_sta.md) | 继承了[IWiFiBaseFeature](_i_wi_fi_base_feature.md)基本特性，额外包含设置扫描单个MAC地址功能。 [更多...](_i_wi_fi_sta.md) | - - -### 函数 - - | 函数 | 描述 | -| -------- | -------- | -| [InitStaFeature](_w_l_a_n.md#initstafeature) (struct [IWiFiSta](_i_wi_fi_sta.md) \*\*fe) | 初始化STA特性。WLAN服务在创建STA类型的特性[FeatureType](_w_l_a_n.md#featuretype)时调用。 [更多...](_w_l_a_n.md#initstafeature) | - - -## **详细描述** - -提供WLAN的STA特性能力。 - -**Since：** - -1.0 - -**Version：** - -1.0 diff --git a/zh-cn/device-dev/reference/hdi-apis/wlan.md b/zh-cn/device-dev/reference/hdi-apis/wlan.md new file mode 100644 index 0000000000000000000000000000000000000000..b2bba7253d37b14588ca2b44988dd6a0612e6800 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/wlan.md @@ -0,0 +1,55 @@ +# WLAN + + +## **概述** + +WLAN模块向上层WLAN服务提供了统一接口。 + +上层WLAN服务开发人员可根据WLAN模块提供的向上统一接口获取如下能力：建立/关闭WLAN热点，扫描/关联WLAN热点，WLAN平台芯片管理，网络数据缓冲的申请、释放、移动等操作，网络设备管理，电源管理等。 + +**Since**: + +3.2 + +**Version**: + +1.0 + + +## **汇总** + + +### 文件 + + | 名称 | 描述 | +| -------- | -------- | +| [IWlanCallback.idl](_i_wlan_callback_8idl.md) | WLAN模块为WLAN服务提供的重启驱动、扫描结果、Netlink消息处理的回调。 | +| [IWlanInterface.idl](_i_wlan_interface_8idl.md) | 建立/关闭WLAN热点，扫描/关联/去关联WLAN热点，设置国家码，管理网络设备等操作的接口。 | +| [WlanTypes.idl](_wlan_types_8idl.md) | WLAN模块相关的数据类型。 | + + +### 类 + + | 名称 | 描述 | +| -------- | -------- | +| [IWlanCallback](interface_i_wlan_callback.md) | 定义WLAN模块的回调函数。 | +| [IWlanInterface](interface_i_wlan_interface.md) | WLAN模块向上层WLAN服务提供了统一接口。 | +| [HdfFeatureInfo](_hdf_feature_info.md) | feature对象信息。 | +| [HdfStaInfo](_hdf_sta_info.md) | STA的信息。 | +| [HdfWifiDriverScanSsid](_hdf_wifi_driver_scan_ssid.md) | WiFi扫描参数SSID信息。 | +| [HdfWifiScan](_hdf_wifi_scan.md) | WiFi扫描参数。 | +| [HdfNetDeviceInfo](_hdf_net_device_info.md) | 网络设备信息。 | +| [HdfNetDeviceInfoResult](_hdf_net_device_info_result.md) | 网络设备信息集合。 | +| [HdfWifiScanResult](_hdf_wifi_scan_result.md) | WiFi扫描结果。 | +| [HdfWifiInfo](_hdf_wifi_info.md) | WiFi频段信息。 | +| [MeasChannelParam](_meas_channel_param.md) | 信道测量参数。 | +| [MeasChannelResult](_meas_channel_result.md) | 信道测量结果。 | +| [ProjectionScreenCmdParam](_projection_screen_cmd_param.md) | 投屏参数。 | +| [WifiStationInfo](_wifi_station_info.md) | STA的信息。 | + + +### 关键字 + + | 名称 | 描述 | +| -------- | -------- | +| package ohos.hdi.wlan.v1_0 | WLAN模块接口的包路径。 |