From a3ed18facf7c648b4dc37440b42e08a791de7d87 Mon Sep 17 00:00:00 2001 From: duangavin123 Date: Fri, 29 Jul 2022 09:52:22 +0800 Subject: [PATCH] HDI APIs Signed-off-by: duangavin123 --- .../reference/hdi-apis/Readme-CN.md | 13 +- .../hdi-apis/_audio_port_capability.md | 2 +- .../hdi-apis/_audio_scene_descriptor.md | 3 +- .../device-dev/reference/hdi-apis/_camera.md | 632 +++++++++--------- .../hdi-apis/_codec_callback_type.md | 6 +- .../hdi-apis/_codec_component_type.md | 36 +- .../reference/hdi-apis/_device_info.md | 126 +--- .../device-dev/reference/hdi-apis/_display.md | 358 +++++----- .../reference/hdi-apis/_event_package.md | 4 +- .../reference/hdi-apis/_hdf_pin_auth.md | 2 +- .../reference/hdi-apis/_hdf_user_auth.md | 19 + .../reference/hdi-apis/_i_input_interface.md | 14 +- zh-cn/device-dev/reference/hdi-apis/_input.md | 84 ++- .../reference/hdi-apis/_input_controller.md | 102 +-- .../reference/hdi-apis/_input_dev_ability.md | 196 ++++++ .../reference/hdi-apis/_input_dev_attr.md | 58 ++ .../reference/hdi-apis/_input_dev_desc.md | 51 ++ .../reference/hdi-apis/_input_dev_identify.md | 69 ++ .../hdi-apis/_input_dimension_info.md | 91 +++ .../reference/hdi-apis/_input_host_cb.md | 44 ++ .../hdi-apis/_input_hotplug_event.md | 66 ++ .../reference/hdi-apis/_input_manager.md | 68 +- .../hdi-apis/_input_report_event_cb.md | 34 +- .../reference/hdi-apis/_input_reporter.md | 58 +- .../reference/hdi-apis/_light_effect.md | 12 +- .../reference/hdi-apis/_light_interface.md | 35 +- .../_o_h_o_s_1_1_u_s_b_1_1_usb_info.md | 7 + .../_o_h_o_s_1_1_u_s_b_1_1_usbd_client.md | 7 +- .../_o_h_o_s_1_1_u_s_b_1_1_usbd_subscriber.md | 21 + .../device-dev/reference/hdi-apis/_sensor.md | 202 +++--- .../reference/hdi-apis/_sensor_information.md | 40 +- .../reference/hdi-apis/_sensor_interface.md | 84 +-- zh-cn/device-dev/reference/hdi-apis/_u_s_b.md | 149 ++++- .../hdi-apis/_user_auth_types_8idl.md | 1 + .../reference/hdi-apis/display__type_8h.md | 42 +- .../hdi-apis/input__controller_8h.md | 4 +- .../reference/hdi-apis/input__manager_8h.md | 7 +- .../reference/hdi-apis/input__reporter_8h.md | 4 +- .../reference/hdi-apis/input__type_8h.md | 32 +- .../interface_i_pin_auth_interface.md | 4 +- .../interface_i_user_auth_interface.md | 2 +- .../hdi-apis/interface_pin_i_executor.md | 14 +- .../reference/hdi-apis/light_8typeh.md | 12 +- .../reference/hdi-apis/light__if_8h.md | 17 +- .../hdi-apis/pin__auth_2_i_executor_8idl.md | 2 +- .../pin__auth_2_i_executor_callback_8idl.md | 4 +- .../reference/hdi-apis/sensor__if_8h.md | 12 +- .../reference/hdi-apis/usbd__type_8h.md | 9 + 48 files changed, 1807 insertions(+), 1052 deletions(-) create mode 100644 zh-cn/device-dev/reference/hdi-apis/_input_dev_ability.md create mode 100644 zh-cn/device-dev/reference/hdi-apis/_input_dev_attr.md create mode 100644 zh-cn/device-dev/reference/hdi-apis/_input_dev_desc.md create mode 100644 zh-cn/device-dev/reference/hdi-apis/_input_dev_identify.md create mode 100644 zh-cn/device-dev/reference/hdi-apis/_input_dimension_info.md create mode 100644 zh-cn/device-dev/reference/hdi-apis/_input_host_cb.md create mode 100644 zh-cn/device-dev/reference/hdi-apis/_input_hotplug_event.md 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 c3a79510ce..98c7de011f 100644 --- a/zh-cn/device-dev/reference/hdi-apis/Readme-CN.md +++ b/zh-cn/device-dev/reference/hdi-apis/Readme-CN.md @@ -122,7 +122,6 @@ - [CompVerInfo](_comp_ver_info.md) - [CredentialInfo](_credential_info.md) - [DeviceFuncs](_device_funcs.md) - - [DeviceInfo](_device_info.md) - [DisplayCapability](_display_capability.md) - [DisplayInfo](_display_info.md) - [DisplayModeInfo](_display_mode_info.md) @@ -130,7 +129,6 @@ - [EnrollParam](_enroll_param.md) - [EnrollResultInfo](_enroll_resultinfo.md) - [EventInfo](_event_info.md) - - [EventPackage](_event_package.md) - [ExecutorInfo](_executor_info.md) - [ExecutorInfo](_user_executor_info.md) - [ExecutorRegisterInfo](_executor_register_info.md) @@ -154,10 +152,19 @@ - [IInputInterface](_i_input_interface.md) - [ILine](_i_line.md) - [InputController](_input_controller.md) + - [InputDevAbility](_input_dev_ability.md) + - [InputDevAttr](_input_dev_attr.md) + - [InputDevDesc](_input_dev_desc.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) - [InputExtraCmd](_input_extra_cmd.md) + - [InputHostCb](_input_host_cb.md) + - [InputHotPlugEvent](_input_hotplug_event.md) - [InputManager](_input_manager.md) - [InputReporter](_input_reporter.md) - - [InputReportEventCb](_input_report_event_cb.md) - [IPinAuthInterface](interface_i_pin_auth_interface.md) - [IPowerHdiCallback](interface_i_power_hdi_callback.md) - [IPowerInterface](interface_i_power_interface.md) 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 40a05c9e22..4fbfb7c94e 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 @@ -26,7 +26,7 @@ | [subPortsNum](_audio.md#subportsnum) | 支持的子端口数目（仅用于输出设备）。 | | [subPorts](_audio.md#subports) | 支持的子端口列表。 | | [supportSampleFormatNum](_audio.md#supportsampleformatnum) | 支持的音频样本格式数量。 | -| [supportSampleFormats](_audio.md#supportsampleformats) | 支持的音频样本格式，详请参考[AudioSampleFormat](_codec.md#audiosampleformat)。 | +| [supportSampleFormats](_audio.md#supportsampleformats) | 支持的音频样本格式，详请参考[AudioSampleFormat](_audio.md#audiosampleformat)。 | ## **详细描述** 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 c7838b44b9..624073d4ae 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 @@ -5,8 +5,7 @@ **所属模块:** -[Audio](_audio.md)[更多...](union_audio_scene_descriptor_1_1_scene_desc.md) - +[Audio](_audio.md) ## **汇总** diff --git a/zh-cn/device-dev/reference/hdi-apis/_camera.md b/zh-cn/device-dev/reference/hdi-apis/_camera.md index 563a33e3bf..0669353596 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_camera.md +++ b/zh-cn/device-dev/reference/hdi-apis/_camera.md @@ -6,140 +6,140 @@ ### 文件 - | 文件 | 描述 | +| 文件 | 描述 | | -------- | -------- | -| [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接口使用的数据类型。 | +| [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::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::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::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::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) | 错误类型。 | +| [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) | 错误类型。 | ## **详细描述** @@ -158,7 +158,7 @@ Camera模块涉及相机设备的操作、流的操作、离线流的操作和 ### CameraEvent - + ``` enum OHOS::Camera::CameraEvent : uint32_t ``` @@ -167,15 +167,15 @@ enum OHOS::Camera::CameraEvent : uint32_t Camera事件。 - | 枚举值 | **描述** | +| 枚举值 | **描述** | | -------- | -------- | -| CAMERA_EVENT_DEVICE_ADD | Camera设备增加事件。 | -| CAMERA_EVENT_DEVICE_RMV | Camera设备删除事件。 | +| CAMERA_EVENT_DEVICE_ADD | Camera设备增加事件。 | +| CAMERA_EVENT_DEVICE_RMV | Camera设备删除事件。 | ### CameraStatus - + ``` enum OHOS::Camera::CameraStatus ``` @@ -184,15 +184,15 @@ enum OHOS::Camera::CameraStatus Camera设备状态。 - | 枚举值 | **描述** | +| 枚举值 | **描述** | | -------- | -------- | -| UN_AVAILABLE | 设备当前不在位或者不可用。 | -| AVAILABLE | 设备当前可用。 | +| UN_AVAILABLE | 设备当前不在位或者不可用。 | +| AVAILABLE | 设备当前可用。 | ### CamRetCode - + ``` enum OHOS::Camera::CamRetCode : int32_t ``` @@ -201,20 +201,20 @@ enum OHOS::Camera::CamRetCode : int32_t HDI接口的返回值。 - | 枚举值 | **描述** | +| 枚举值 | **描述** | | -------- | -------- | -| NO_ERROR | 调用成功。 | -| CAMERA_BUSY | 设备当前忙。 | -| INSUFFICIENT_RESOURCES | 资源不足。 | -| INVALID_ARGUMENT | 参数错误。 | -| METHOD_NOT_SUPPORTED | 不支持当前调用方法。 | -| CAMERA_CLOSED | Camera设备已经关闭。 | -| DEVICE_ERROR | 驱动层发生严重错误。 | +| NO_ERROR | 调用成功。 | +| CAMERA_BUSY | 设备当前忙。 | +| INSUFFICIENT_RESOURCES | 资源不足。 | +| INVALID_ARGUMENT | 参数错误。 | +| METHOD_NOT_SUPPORTED | 不支持当前调用方法。 | +| CAMERA_CLOSED | Camera设备已经关闭。 | +| DEVICE_ERROR | 驱动层发生严重错误。 | ### EncodeType - + ``` enum OHOS::Camera::EncodeType : int32_t ``` @@ -223,17 +223,17 @@ enum OHOS::Camera::EncodeType : int32_t 流数据的编码类型。 - | 枚举值 | **描述** | +| 枚举值 | **描述** | | -------- | -------- | -| ENCODE_TYPE_NULL | 未设置编码类型。 | -| ENCODE_TYPE_H264 | 编码类型为H264。 | -| ENCODE_TYPE_H265 | 编码类型为H265。 | -| ENCODE_TYPE_JPEG | 编码类型为JPEG。 | +| ENCODE_TYPE_NULL | 未设置编码类型。 | +| ENCODE_TYPE_H264 | 编码类型为H264。 | +| ENCODE_TYPE_H265 | 编码类型为H265。 | +| ENCODE_TYPE_JPEG | 编码类型为JPEG。 | ### ErrorType - + ``` enum OHOS::Camera::ErrorType : uint32_t ``` @@ -242,15 +242,15 @@ enum OHOS::Camera::ErrorType : uint32_t 设备错误类型，用于设备错误回调 **OnError**。 - | 枚举值 | **描述** | +| 枚举值 | **描述** | | -------- | -------- | -| FATAL_ERROR | 严重错误，需要关闭camera设备。 | -| REQUEST_TIMEOUT | 请求超时，需要关闭camera设备。 | +| FATAL_ERROR | 严重错误，需要关闭Camera设备。 | +| REQUEST_TIMEOUT | 请求超时，需要关闭Camera设备。 | ### FlashlightStatus - + ``` enum OHOS::Camera::FlashlightStatus : uint32_t ``` @@ -259,16 +259,16 @@ enum OHOS::Camera::FlashlightStatus : uint32_t 闪光灯状态。 - | 枚举值 | **描述** | +| 枚举值 | **描述** | | -------- | -------- | -| FLASHLIGHT_OFF | 闪光灯关闭。 | -| FLASHLIGHT_ON | 闪光灯开启。 | -| FLASHLIGHT_UNAVAILABLE | 闪光灯当前不可用。 | +| FLASHLIGHT_OFF | 闪光灯关闭。 | +| FLASHLIGHT_ON | 闪光灯开启。 | +| FLASHLIGHT_UNAVAILABLE | 闪光灯当前不可用。 | ### OperationMode - + ``` enum OHOS::Camera::OperationMode : int32_t ``` @@ -277,14 +277,14 @@ enum OHOS::Camera::OperationMode : int32_t 流的使用模式。 - | 枚举值 | **描述** | +| 枚举值 | **描述** | | -------- | -------- | -| NORMAL | 普通模式。 | +| NORMAL | 普通模式。 | ### ResultCallbackMode - + ``` enum OHOS::Camera::ResultCallbackMode : int32_t ``` @@ -293,15 +293,15 @@ enum OHOS::Camera::ResultCallbackMode : int32_t metadata的上报模式。 - | 枚举值 | **描述** | +| 枚举值 | **描述** | | -------- | -------- | -| PER_FRAME | 每帧上报。 | -| ON_CHANGED | 设备状态变化时上报。 | +| PER_FRAME | 每帧上报。 | +| ON_CHANGED | 设备状态变化时上报。 | ### StreamError - + ``` enum OHOS::Camera::StreamError ``` @@ -310,15 +310,15 @@ enum OHOS::Camera::StreamError 流错误类型，用于流错误类型 [CaptureErrorInfo](_o_h_o_s_1_1_camera_1_1_capture_error_info.md)。 - | 枚举值 | **描述** | +| 枚举值 | **描述** | | -------- | -------- | -| UNKNOWN_ERROR | 流未知错误。 | -| BUFFER_LOST | 丢包。 | +| UNKNOWN_ERROR | 流未知错误。 | +| BUFFER_LOST | 丢包。 | ### StreamIntent - + ``` enum OHOS::Camera::StreamIntent : int32_t ``` @@ -327,19 +327,19 @@ enum OHOS::Camera::StreamIntent : int32_t 流的类型。 - | 枚举值 | **描述** | +| 枚举值 | **描述** | | -------- | -------- | -| PREVIEW | 流数据用于显示，即预览流。 | -| VIDEO | 流数据用于编码生成录像，即录像流。 | -| STILL_CAPTURE | 流数据用于编码生成照片，即拍照流。 | -| POST_VIEW | 流数据用于保存缩略图。 | -| ANALYZE | 流数据用于图像分析。 | -| CUSTOM | 自定义类型。 | +| PREVIEW | 流数据用于显示，即预览流。 | +| VIDEO | 流数据用于编码生成录像，即录像流。 | +| STILL_CAPTURE | 流数据用于编码生成照片，即拍照流。 | +| POST_VIEW | 流数据用于保存缩略图。 | +| ANALYZE | 流数据用于图像分析。 | +| CUSTOM | 自定义类型。 | ### StreamSupportType - + ``` enum OHOS::Camera::StreamSupportType : int32_t ``` @@ -348,11 +348,11 @@ enum OHOS::Camera::StreamSupportType : int32_t 动态配置流的切换方式，使用场景参考 [IsStreamsSupported](#isstreamssupported) 。 - | 枚举值 | 描述 | +| 枚举值 | 描述 | | -------- | -------- | -| DYNAMIC_SUPPORTED | 支持动态配置流，对应的流参数直接生效。 | -| RE_CONFIGURED_REQUIRED | 不支持动态配置流，对应的参数需要停止流然后重新配置流才能生效。 | -| NOT_SUPPORTED | 不支持对应的流参数配置。 | +| DYNAMIC_SUPPORTED | 支持动态配置流，对应的流参数直接生效。 | +| RE_CONFIGURED_REQUIRED | 不支持动态配置流，对应的参数需要停止流然后重新配置流才能生效。 | +| NOT_SUPPORTED | 不支持对应的流参数配置。 | ## **函数说明** @@ -360,7 +360,7 @@ enum OHOS::Camera::StreamSupportType : int32_t ### AttachBufferQueue() - + ``` virtual CamRetCode OHOS::Camera::IStreamOperator::AttachBufferQueue (int streamId, const OHOS::sptr < OHOS::IBufferProducer > & producer ) ``` @@ -373,10 +373,10 @@ virtual CamRetCode OHOS::Camera::IStreamOperator::AttachBufferQueue (int streamI **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| streamId | [IN] 用于标识要绑定的流。 | -| producer | [IN] 生产者句柄。 | +| streamId | [IN] 用于标识要绑定的流。 | +| producer | [IN] 生产者句柄。 | **返回：** @@ -399,7 +399,7 @@ NO_ERROR 表示执行成功。 ### CancelCapture() [1/2] - + ``` virtual CamRetCode OHOS::Camera::IOfflineStreamOperator::CancelCapture (int captureId) ``` @@ -410,9 +410,9 @@ virtual CamRetCode OHOS::Camera::IOfflineStreamOperator::CancelCapture (int capt **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| captureId | [IN] 用于标识要取消的捕获请求。 | +| captureId | [IN] 用于标识要取消的捕获请求。 | **返回：** @@ -423,7 +423,7 @@ NO_ERROR 表示执行成功。 ### CancelCapture() [2/2] - + ``` virtual CamRetCode OHOS::Camera::IStreamOperator::CancelCapture (int captureId) ``` @@ -436,9 +436,9 @@ virtual CamRetCode OHOS::Camera::IStreamOperator::CancelCapture (int captureId) **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| captureId | 用于标识要取消的捕获请求 | +| captureId | 用于标识要取消的捕获请求 | **返回：** @@ -461,7 +461,7 @@ NO_ERROR 表示执行成功。 ### Capture() - + ``` virtual CamRetCode OHOS::Camera::IStreamOperator::Capture (int captureId, const std::shared_ptr< CaptureInfo > & info, bool isStreaming ) ``` @@ -480,11 +480,11 @@ virtual CamRetCode OHOS::Camera::IStreamOperator::Capture (int captureId, const **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| captureId | [IN] 捕获请求的唯一标识，由调用者指定，调用者需保证在Camera设备打开期间，捕获请求ID是唯一的。 | -| info | [IN] 捕获请求的参数信息，具体信息查看 [CaptureInfo](_o_h_o_s_1_1_camera_1_1_capture_info.md)。 | -| isStreaming | [IN] 是否连续捕获，true表示连续捕获，否则为单次捕获。 | +| captureId | [IN] 捕获请求的唯一标识，由调用者指定，调用者需保证在Camera设备打开期间，捕获请求ID是唯一的。 | +| info | [IN] 捕获请求的参数信息，具体信息查看 [CaptureInfo](_o_h_o_s_1_1_camera_1_1_capture_info.md)。 | +| isStreaming | [IN] 是否连续捕获，true表示连续捕获，否则为单次捕获。 | **返回：** @@ -507,7 +507,7 @@ OnFrameShutter ### ChangeToOfflineStream() - + ``` virtual CamRetCode OHOS::Camera::IStreamOperator::ChangeToOfflineStream (const std::vector< int > & streamIds, OHOS::sptr< IStreamOperatorCallback > & callback, OHOS::sptr< IOfflineStreamOperator > & offlineOperator ) ``` @@ -520,11 +520,11 @@ virtual CamRetCode OHOS::Camera::IStreamOperator::ChangeToOfflineStream (const s **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| streamIds | [IN] 用于指定要转换成离线流的流集合。 | -| callback | [IN] 用于设置离线流的回调。 | -| offlineOperator | [OUT] 转换后的离线流。 | +| streamIds | [IN] 用于指定要转换成离线流的流集合。 | +| callback | [IN] 用于设置离线流的回调。 | +| offlineOperator | [OUT] 转换后的离线流。 | **返回：** @@ -543,7 +543,7 @@ NO_ERROR 表示执行成功； ### Close() - + ``` virtual void OHOS::Camera::ICameraDevice::Close () ``` @@ -567,7 +567,7 @@ virtual void OHOS::Camera::ICameraDevice::Close () ### CommitStreams() - + ``` virtual CamRetCode OHOS::Camera::IStreamOperator::CommitStreams (OperationMode mode, const std::shared_ptr< CameraMetadata > & modeSetting ) ``` @@ -580,10 +580,10 @@ virtual CamRetCode OHOS::Camera::IStreamOperator::CommitStreams (OperationMode m **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| mode | [IN] 流运行的模式，支持的模式定义在 **OperationMode**。 | -| modeSetting | [IN] 流的配置参数，包括帧率，ZOOM等信息。 | +| mode | [IN] 流运行的模式，支持的模式定义在 **OperationMode**。 | +| modeSetting | [IN] 流的配置参数，包括帧率，ZOOM等信息。 | **返回：** @@ -602,7 +602,7 @@ NO_ERROR 表示执行成功； ### CreateStreams() - + ``` virtual CamRetCode OHOS::Camera::IStreamOperator::CreateStreams (const std::vector< std::shared_ptr< StreamInfo >> & streamInfos) ``` @@ -615,9 +615,9 @@ virtual CamRetCode OHOS::Camera::IStreamOperator::CreateStreams (const std::vect **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| streamInfos | [IN] 流信息列表，流信息定义在 [StreamInfo](_o_h_o_s_1_1_camera_1_1_stream_info.md)。输入的流信息可能会被修改，需通过 [GetStreamAttributes](#getstreamattributes) 获取最新的流属性。 | +| streamInfos | [IN] 流信息列表，流信息定义在 [StreamInfo](_o_h_o_s_1_1_camera_1_1_stream_info.md)。输入的流信息可能会被修改，需通过 [GetStreamAttributes](#getstreamattributes) 获取最新的流属性。 | **返回：** @@ -636,7 +636,7 @@ NO_ERROR 表示执行成功； ### DetachBufferQueue() - + ``` virtual CamRetCode OHOS::Camera::IStreamOperator::DetachBufferQueue (int streamId) ``` @@ -647,9 +647,9 @@ virtual CamRetCode OHOS::Camera::IStreamOperator::DetachBufferQueue (int streamI **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| streamId | [IN] 用于标识要解除绑定的流。 | +| streamId | [IN] 用于标识要解除绑定的流。 | **返回：** @@ -672,7 +672,7 @@ NO_ERROR 表示执行成功； ### DisableResult() - + ``` virtual CamRetCode OHOS::Camera::ICameraDevice::DisableResult (const std::vector< MetaType > & results) ``` @@ -685,9 +685,9 @@ virtual CamRetCode OHOS::Camera::ICameraDevice::DisableResult (const std::vector **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| results | [IN] 需要关闭上报开关的metadata。 | +| results | [IN] 需要关闭上报开关的metadata。 | **返回：** @@ -710,7 +710,7 @@ NO_ERROR 表示执行成功。 ### EnableResult() - + ``` virtual CamRetCode OHOS::Camera::ICameraDevice::EnableResult (const std::vector< MetaType > & results) ``` @@ -723,9 +723,9 @@ virtual CamRetCode OHOS::Camera::ICameraDevice::EnableResult (const std::vector< **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| results | [IN] 需要打开上报开关的metadata。 | +| results | [IN] 需要打开上报开关的metadata。 | **返回：** @@ -748,7 +748,7 @@ NO_ERROR 表示执行成功。 ### Get() - + ``` static sptr OHOS::Camera::ICameraHost::Get (const char * serviceName) ``` @@ -761,9 +761,9 @@ static sptr OHOS::Camera::ICameraHost::Get (const char * serviceNam **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| serviceName | [IN] 要获取的ICameraHost实例的名称，当前实现中实例名称固定为camera_service。 | +| serviceName | [IN] 要获取的ICameraHost实例的名称，当前实现中实例名称固定为camera_service。 | **返回：** @@ -780,7 +780,7 @@ static sptr OHOS::Camera::ICameraHost::Get (const char * serviceNam ### GetCameraAbility() - + ``` virtual CamRetCode OHOS::Camera::ICameraHost::GetCameraAbility (const std::string & cameraId, std::shared_ptr< CameraAbility > & ability ) ``` @@ -791,10 +791,10 @@ virtual CamRetCode OHOS::Camera::ICameraHost::GetCameraAbility (const std::strin **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| cameraId | [IN] 用于指定要操作的camera设备，通过 [GetCameraIds](#getcameraids) 获取。 | -| ability | [OUT] 返回cameraId对应Camera设备的能力集合。 | +| cameraId | [IN] 用于指定要操作的Camera设备，通过 [GetCameraIds](#getcameraids) 获取。 | +| ability | [OUT] 返回cameraId对应Camera设备的能力集合。 | **返回：** @@ -817,7 +817,7 @@ NO_ERROR 表示执行成功。 ### GetCameraIds() - + ``` virtual CamRetCode OHOS::Camera::ICameraHost::GetCameraIds (std::vector< std::string > & cameraIds) ``` @@ -828,9 +828,9 @@ virtual CamRetCode OHOS::Camera::ICameraHost::GetCameraIds (std::vector< std::st **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| cameraIds | [OUT] 返回当前可用的设备列表 | +| cameraIds | [OUT] 返回当前可用的设备列表 | **返回：** @@ -853,7 +853,7 @@ NO_ERROR 表示执行成功。 ### GetEnabledResults() - + ``` virtual CamRetCode OHOS::Camera::ICameraDevice::GetEnabledResults (std::vector< MetaType > & results) ``` @@ -866,9 +866,9 @@ virtual CamRetCode OHOS::Camera::ICameraDevice::GetEnabledResults (std::vector< **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| results | [OUT] 所有使能的metadata。 | +| results | [OUT] 所有使能的metadata。 | **返回：** @@ -887,7 +887,7 @@ NO_ERROR 表示执行成功。 ### GetStreamAttributes() - + ``` virtual CamRetCode OHOS::Camera::IStreamOperator::GetStreamAttributes (std::vector< std::shared_ptr< StreamAttribute >> & attributes) ``` @@ -898,9 +898,9 @@ virtual CamRetCode OHOS::Camera::IStreamOperator::GetStreamAttributes (std::vect **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| attributes | [OUT] 用于获取流的属性。在调用[CreateStreams](#createstreams) 时，通过参数streamInfos携带的流信息 可能会被重写，因此通过该接口获取的流属性可能会。 和 [CreateStreams](#createstreams) 输入的流信息存在差异。 | +| attributes | [OUT] 用于获取流的属性。在调用[CreateStreams](#createstreams) 时，通过参数streamInfos携带的流信息可能会被重写，因此通过该接口获取的流属性可能会和 [CreateStreams](#createstreams) 输入的流信息存在差异。 | **返回：** @@ -919,7 +919,7 @@ NO_ERROR 表示执行成功。 ### GetStreamOperator() - + ``` virtual CamRetCode OHOS::Camera::ICameraDevice::GetStreamOperator (const OHOS::sptr< IStreamOperatorCallback > & callback, OHOS::sptr< IStreamOperator > & streamOperator ) ``` @@ -930,10 +930,10 @@ virtual CamRetCode OHOS::Camera::ICameraDevice::GetStreamOperator (const OHOS::s **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| callback | [IN] 设置流回调接口，详细可查看 [IStreamOperatorCallback](_o_h_o_s_1_1_camera_1_1_i_stream_operator_callback.md)， 用于上报捕获开始 **OnCaptureStarted**，捕获结束 **OnCaptureEnded**， **OnCaptureError** 捕获错误等信息。 | -| streamOperator | [OUT] 返回流操作句柄。 | +| callback | [IN] 设置流回调接口，详细可查看 [IStreamOperatorCallback](_o_h_o_s_1_1_camera_1_1_i_stream_operator_callback.md)， 用于上报捕获开始 **OnCaptureStarted**，捕获结束 **OnCaptureEnded**， **OnCaptureError** 捕获错误等信息。 | +| streamOperator | [OUT] 返回流操作句柄。 | **返回：** @@ -952,7 +952,7 @@ NO_ERROR 表示执行成功。 ### 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 ) ``` @@ -975,12 +975,12 @@ virtual CamRetCode OHOS::Camera::IStreamOperator::IsStreamsSupported (OperationM **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| mode | [IN] 流运行的模式，支持的模式参考 **OperationMode**。 | -| modeSetting | [IN] 流的配置，包括帧率，3A等配置信息。 | -| info | [IN] 流的配置信息，具体参考 [StreamInfo](_o_h_o_s_1_1_camera_1_1_stream_info.md)。 | -| type | [OUT] 对动态配置流的支持类型，支持类型定义在 **StreamSupportType**。 | +| mode | [IN] 流运行的模式，支持的模式参考 **OperationMode**。 | +| modeSetting | [IN] 流的配置，包括帧率，3A等配置信息。 | +| info | [IN] 流的配置信息，具体参考 [StreamInfo](_o_h_o_s_1_1_camera_1_1_stream_info.md)。 | +| type | [OUT] 对动态配置流的支持类型，支持类型定义在 **StreamSupportType**。 | **返回：** @@ -999,7 +999,7 @@ NO_ERROR 表示执行成功。 ### OnCameraEvent() - + ``` virtual void OHOS::Camera::ICameraHostCallback::OnCameraEvent (const std::string & cameraId, CameraEvent event ) ``` @@ -1010,10 +1010,10 @@ virtual void OHOS::Camera::ICameraHostCallback::OnCameraEvent (const std::string **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| cameraId | 表示相机事件绑定的相机ID。 | -| event | 表示相机事件类型。 | +| cameraId | 表示相机事件绑定的相机ID。 | +| event | 表示相机事件类型。 | **Since：** @@ -1026,7 +1026,7 @@ virtual void OHOS::Camera::ICameraHostCallback::OnCameraEvent (const std::string ### OnCameraStatus() - + ``` virtual void OHOS::Camera::ICameraHostCallback::OnCameraStatus (const std::string & cameraId, CameraStatus status ) ``` @@ -1037,10 +1037,10 @@ virtual void OHOS::Camera::ICameraHostCallback::OnCameraStatus (const std::strin **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| cameraId | [IN] 状态发生变化的Camera设备ID。 | -| status | [IN] 最新的设备状态。 | +| cameraId | [IN] 状态发生变化的Camera设备ID。 | +| status | [IN] 最新的设备状态。 | **Since：** @@ -1053,7 +1053,7 @@ virtual void OHOS::Camera::ICameraHostCallback::OnCameraStatus (const std::strin ### OnCaptureEnded() - + ``` virtual void OHOS::Camera::IStreamOperatorCallback::OnCaptureEnded (int32_t captureId, const std::vector< std::shared_ptr< CaptureEndedInfo >> & infos ) ``` @@ -1064,10 +1064,10 @@ virtual void OHOS::Camera::IStreamOperatorCallback::OnCaptureEnded (int32_t capt **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| captureId | [IN] 用于标识回调对应的捕获请求。 | -| infos | [IN] 捕获结束相关信息。 | +| captureId | [IN] 用于标识回调对应的捕获请求。 | +| infos | [IN] 捕获结束相关信息。 | **参见：** @@ -1084,7 +1084,7 @@ virtual void OHOS::Camera::IStreamOperatorCallback::OnCaptureEnded (int32_t capt ### OnCaptureError() - + ``` virtual void OHOS::Camera::IStreamOperatorCallback::OnCaptureError (int32_t captureId, const std::vector< std::shared_ptr< CaptureErrorInfo >> & infos ) ``` @@ -1095,10 +1095,10 @@ virtual void OHOS::Camera::IStreamOperatorCallback::OnCaptureError (int32_t capt **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| captureId | [IN] 用于标识回调对应的捕获请求。 | -| infos | [IN] 捕获错误信息列表。 | +| captureId | [IN] 用于标识回调对应的捕获请求。 | +| infos | [IN] 捕获错误信息列表。 | **Since：** @@ -1111,7 +1111,7 @@ virtual void OHOS::Camera::IStreamOperatorCallback::OnCaptureError (int32_t capt ### OnCaptureStarted() - + ``` virtual void OHOS::Camera::IStreamOperatorCallback::OnCaptureStarted (int32_t captureId, const std::vector< int32_t > & streamIds ) ``` @@ -1122,10 +1122,10 @@ virtual void OHOS::Camera::IStreamOperatorCallback::OnCaptureStarted (int32_t ca **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| captureId | [IN] 用于标识回调对应的捕获请求。 | -| streamIds | [IN] 回调对应的流集合。 | +| captureId | [IN] 用于标识回调对应的捕获请求。 | +| streamIds | [IN] 回调对应的流集合。 | **参见：** @@ -1142,7 +1142,7 @@ virtual void OHOS::Camera::IStreamOperatorCallback::OnCaptureStarted (int32_t ca ### OnError() - + ``` virtual void OHOS::Camera::ICameraDeviceCallback::OnError (ErrorType type, int32_t errorCode ) ``` @@ -1153,10 +1153,10 @@ virtual void OHOS::Camera::ICameraDeviceCallback::OnError (ErrorType type, int32 **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| type | [IN] 错误类型，具体错误类型可参考 **ErrorType**。 | -| errorCode | [IN] 错误码，当前暂未使用。 | +| type | [IN] 错误类型，具体错误类型可参考 **ErrorType**。 | +| errorCode | [IN] 错误码，当前暂未使用。 | **Since：** @@ -1169,7 +1169,7 @@ virtual void OHOS::Camera::ICameraDeviceCallback::OnError (ErrorType type, int32 ### OnFlashlightStatus() - + ``` virtual void OHOS::Camera::ICameraHostCallback::OnFlashlightStatus (const std::string & cameraId, FlashlightStatus status ) ``` @@ -1180,10 +1180,10 @@ virtual void OHOS::Camera::ICameraHostCallback::OnFlashlightStatus (const std::s **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| cameraId | [IN] 状态发生变化的闪关灯所绑定的Camera设备ID。 | -| status | [IN] 最新的闪光灯状态。 | +| cameraId | [IN] 状态发生变化的闪关灯所绑定的Camera设备ID。 | +| status | [IN] 最新的闪光灯状态。 | **Since：** @@ -1196,7 +1196,7 @@ virtual void OHOS::Camera::ICameraHostCallback::OnFlashlightStatus (const std::s ### OnFrameShutter() - + ``` virtual void OHOS::Camera::IStreamOperatorCallback::OnFrameShutter (int32_t captureId, const std::vector< int32_t > & streamIds, uint64_t timestamp ) ``` @@ -1209,11 +1209,11 @@ virtual void OHOS::Camera::IStreamOperatorCallback::OnFrameShutter (int32_t capt **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| captureId | [IN] 用于标识回调对应的捕获请求。 | -| streamIds | [IN] 回调对应的流集合。 | -| timestamp | [IN] 该接口被调用时的时间戳。 | +| captureId | [IN] 用于标识回调对应的捕获请求。 | +| streamIds | [IN] 回调对应的流集合。 | +| timestamp | [IN] 该接口被调用时的时间戳。 | **参见：** @@ -1230,21 +1230,21 @@ Capture ### OnResult() - + ``` virtual void OHOS::Camera::ICameraDeviceCallback::OnResult (uint64_t timestamp, const std::shared_ptr< CameraMetadata > & result ) ``` **描述：** -上报camera设备相关的metadata的回调，上报方式查看 [SetResultMode](#setresultmode)。 +上报Camera设备相关的metadata的回调，上报方式查看 [SetResultMode](#setresultmode)。 **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| timestamp | [IN] metadata上报的时间戳。 | -| result | [IN] 上报的metadata，上报的metadata由 **EnableResult** 指定， 可通过 **GetEnabledResults** 查询，**DisableResult** 关闭上报开关。 | +| timestamp | [IN] metadata上报的时间戳。 | +| result | [IN] 上报的metadata，上报的metadata由 **EnableResult** 指定， 可通过 **GetEnabledResults** 查询，**DisableResult** 关闭上报开关。 | **Since：** @@ -1257,7 +1257,7 @@ virtual void OHOS::Camera::ICameraDeviceCallback::OnResult (uint64_t timestamp, ### OpenCamera() - + ``` virtual CamRetCode OHOS::Camera::ICameraHost::OpenCamera (const std::string & cameraId, const OHOS::sptr< ICameraDeviceCallback > & callback, OHOS::sptr< ICameraDevice > & device ) ``` @@ -1270,11 +1270,11 @@ virtual CamRetCode OHOS::Camera::ICameraHost::OpenCamera (const std::string & ca **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| 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对象。 | +| 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对象。 | **返回：** @@ -1297,7 +1297,7 @@ NO_ERROR 表示执行成功； ### Release() - + ``` virtual CamRetCode OHOS::Camera::IOfflineStreamOperator::Release () ``` @@ -1323,7 +1323,7 @@ NO_ERROR 表示执行成功； ### ReleaseStreams() [1/2] - + ``` virtual CamRetCode OHOS::Camera::IOfflineStreamOperator::ReleaseStreams (const std::vector< int > & streamIds) ``` @@ -1334,9 +1334,9 @@ virtual CamRetCode OHOS::Camera::IOfflineStreamOperator::ReleaseStreams (const s **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| streamIds | 用于标识要释放的离线流集合。 | +| streamIds | 用于标识要释放的离线流集合。 | **返回：** @@ -1355,7 +1355,7 @@ NO_ERROR 表示执行成功。 ### ReleaseStreams() [2/2] - + ``` virtual CamRetCode OHOS::Camera::IStreamOperator::ReleaseStreams (const std::vector< int > & streamIds) ``` @@ -1366,9 +1366,9 @@ virtual CamRetCode OHOS::Camera::IStreamOperator::ReleaseStreams (const std::vec **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| streamIds | [IN] 要释放的流ID列表。 | +| streamIds | [IN] 要释放的流ID列表。 | **返回：** @@ -1387,7 +1387,7 @@ NO_ERROR 表示执行成功； ### SetCallback() - + ``` virtual CamRetCode OHOS::Camera::ICameraHost::SetCallback (const OHOS::sptr< ICameraHostCallback > & callback) ``` @@ -1398,9 +1398,9 @@ virtual CamRetCode OHOS::Camera::ICameraHost::SetCallback (const OHOS::sptr< ICa **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| callback | [IN] 要设置的回调函数。 | +| callback | [IN] 要设置的回调函数。 | **返回：** @@ -1419,7 +1419,7 @@ NO_ERROR 表示执行成功。 ### SetFlashlight() - + ``` virtual CamRetCode OHOS::Camera::ICameraHost::SetFlashlight (const std::string & cameraId, bool & isEnable ) ``` @@ -1432,10 +1432,10 @@ virtual CamRetCode OHOS::Camera::ICameraHost::SetFlashlight (const std::string & **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| cameraId | [IN] 闪光灯对应的Camera设备ID。 | -| isEnable | [IN] true打开闪光灯，false关闭闪光灯。 | +| cameraId | [IN] 闪光灯对应的Camera设备ID。 | +| isEnable | [IN] true打开闪光灯，false关闭闪光灯。 | **返回：** @@ -1458,7 +1458,7 @@ NO_ERROR 表示执行成功。 ### SetResultMode() - + ``` virtual CamRetCode OHOS::Camera::ICameraDevice::SetResultMode (const ResultCallbackMode & mode) ``` @@ -1469,9 +1469,9 @@ virtual CamRetCode OHOS::Camera::ICameraDevice::SetResultMode (const ResultCallb **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| mode | [IN] metadata的上报模式，逐帧上报或者设备状态变化时上报，查看 **ResultCallbackMode**。 | +| mode | [IN] metadata的上报模式，逐帧上报或者设备状态变化时上报，查看 **ResultCallbackMode**。 | **返回：** @@ -1490,7 +1490,7 @@ NO_ERROR 表示执行成功。 ### UpdateSettings() - + ``` virtual CamRetCode OHOS::Camera::ICameraDevice::UpdateSettings (const std::shared_ptr< CameraSetting > & settings) ``` @@ -1501,9 +1501,9 @@ virtual CamRetCode OHOS::Camera::ICameraDevice::UpdateSettings (const std::share **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| settings | [IN] Camera设置参数，包括sensor帧率，3A相关参数等。 | +| settings | [IN] Camera设置参数，包括sensor帧率，3A相关参数等。 | **返回：** @@ -1525,7 +1525,7 @@ NO_ERROR 表示执行成功。 ### bufferQueue_ - + ``` OHOS::sptr OHOS::Camera::StreamInfo::bufferQueue_ ``` @@ -1537,7 +1537,7 @@ OHOS::sptr OHOS::Camera::StreamInfo::bufferQueue_ ### captureSetting_ - + ``` std::shared_ptr OHOS::Camera::CaptureInfo::captureSetting_ ``` @@ -1549,7 +1549,7 @@ std::shared_ptr OHOS::Camera::CaptureInfo::captureSetting_ ### dataspace_ - + ``` int OHOS::Camera::StreamInfo::dataspace_ ``` @@ -1561,7 +1561,7 @@ int OHOS::Camera::StreamInfo::dataspace_ ### enableShutterCallback_ - + ``` bool OHOS::Camera::CaptureInfo::enableShutterCallback_ ``` @@ -1573,7 +1573,7 @@ bool OHOS::Camera::CaptureInfo::enableShutterCallback_ ### encodeType_ - + ``` EncodeType OHOS::Camera::StreamInfo::encodeType_ ``` @@ -1585,7 +1585,7 @@ EncodeType OHOS::Camera::StreamInfo::encodeType_ ### error_ - + ``` StreamError OHOS::Camera::CaptureErrorInfo::error_ ``` @@ -1597,7 +1597,7 @@ StreamError OHOS::Camera::CaptureErrorInfo::error_ ### format_ - + ``` int OHOS::Camera::StreamInfo::format_ ``` @@ -1609,7 +1609,7 @@ int OHOS::Camera::StreamInfo::format_ ### frameCount_ - + ``` int OHOS::Camera::CaptureEndedInfo::frameCount_ ``` @@ -1621,7 +1621,7 @@ int OHOS::Camera::CaptureEndedInfo::frameCount_ ### height_ [1/2] - + ``` int OHOS::Camera::StreamInfo::height_ ``` @@ -1633,7 +1633,7 @@ int OHOS::Camera::StreamInfo::height_ ### height_ [2/2] - + ``` int OHOS::Camera::StreamAttribute::height_ ``` @@ -1645,7 +1645,7 @@ int OHOS::Camera::StreamAttribute::height_ ### intent_ - + ``` StreamIntent OHOS::Camera::StreamInfo::intent_ ``` @@ -1657,7 +1657,7 @@ StreamIntent OHOS::Camera::StreamInfo::intent_ ### maxBatchCaptureCount_ - + ``` int OHOS::Camera::StreamAttribute::maxBatchCaptureCount_ ``` @@ -1669,7 +1669,7 @@ int OHOS::Camera::StreamAttribute::maxBatchCaptureCount_ ### maxCaptureCount_ - + ``` int OHOS::Camera::StreamAttribute::maxCaptureCount_ ``` @@ -1681,7 +1681,7 @@ int OHOS::Camera::StreamAttribute::maxCaptureCount_ ### minFrameDuration_ - + ``` int OHOS::Camera::StreamInfo::minFrameDuration_ ``` @@ -1693,7 +1693,7 @@ int OHOS::Camera::StreamInfo::minFrameDuration_ ### overrideDataspace_ - + ``` int OHOS::Camera::StreamAttribute::overrideDataspace_ ``` @@ -1705,7 +1705,7 @@ int OHOS::Camera::StreamAttribute::overrideDataspace_ ### overrideFormat_ - + ``` int OHOS::Camera::StreamAttribute::overrideFormat_ ``` @@ -1717,7 +1717,7 @@ int OHOS::Camera::StreamAttribute::overrideFormat_ ### producerBufferCount_ - + ``` int OHOS::Camera::StreamAttribute::producerBufferCount_ ``` @@ -1729,7 +1729,7 @@ int OHOS::Camera::StreamAttribute::producerBufferCount_ ### producerUsage_ - + ``` int OHOS::Camera::StreamAttribute::producerUsage_ ``` @@ -1741,7 +1741,7 @@ int OHOS::Camera::StreamAttribute::producerUsage_ ### streamId_ [1/4] - + ``` int OHOS::Camera::StreamInfo::streamId_ ``` @@ -1753,7 +1753,7 @@ int OHOS::Camera::StreamInfo::streamId_ ### streamId_ [2/4] - + ``` int OHOS::Camera::StreamAttribute::streamId_ ``` @@ -1765,7 +1765,7 @@ int OHOS::Camera::StreamAttribute::streamId_ ### streamId_ [3/4] - + ``` int OHOS::Camera::CaptureEndedInfo::streamId_ ``` @@ -1777,7 +1777,7 @@ int OHOS::Camera::CaptureEndedInfo::streamId_ ### streamId_ [4/4] - + ``` int OHOS::Camera::CaptureErrorInfo::streamId_ ``` @@ -1789,7 +1789,7 @@ int OHOS::Camera::CaptureErrorInfo::streamId_ ### streamIds_ - + ``` std::vector OHOS::Camera::CaptureInfo::streamIds_ ``` @@ -1801,7 +1801,7 @@ std::vector OHOS::Camera::CaptureInfo::streamIds_ ### tunneledMode_ - + ``` bool OHOS::Camera::StreamInfo::tunneledMode_ ``` @@ -1815,7 +1815,7 @@ bool OHOS::Camera::StreamInfo::tunneledMode_ ### width_ [1/2] - + ``` int OHOS::Camera::StreamInfo::width_ ``` @@ -1827,7 +1827,7 @@ int OHOS::Camera::StreamInfo::width_ ### width_ [2/2] - + ``` int OHOS::Camera::StreamAttribute::width_ ``` 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 1734e7654a..adf3edf8dd 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 @@ -16,9 +16,9 @@ | Public 属性 | 描述 | | -------- | -------- | | [remote](_codec.md#remote) | 指向HdfRemoteService的指针。 [更多...](_codec.md#remote) | -| ( [EventHandler](_codec.md#eventhandler) )(struct [ERROR:Invalid link:zh-cn_topic_0000001304382300.xml#xref452479393083931,link:zh-cn_topic_0000001304382300.xml](zh-cn_topic_0000001304382300.xml) \*self, enum OMX_EVENTTYPE event, struct [EventInfo](_event_info.md) \*info) | 事件上报。 [更多...](_codec.md#eventhandler) | -| ( [EmptyBufferDone](_codec.md#emptybufferdone) )(struct [ERROR:Invalid link:zh-cn_topic_0000001304382300.xml#xref1077915705083931,link:zh-cn_topic_0000001304382300.xml](zh-cn_topic_0000001304382300.xml) \*self, int8_t \*appData, uint32_t appDataLen, const struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 上报输入buffer编码或者解码处理完毕。 [更多...](_codec.md#emptybufferdone) | -| ( [FillBufferDone](_codec.md#fillbufferdone) )(struct [ERROR:Invalid link:zh-cn_topic_0000001304382300.xml#xref1123615867083931,link:zh-cn_topic_0000001304382300.xml](zh-cn_topic_0000001304382300.xml) \*self, int8_t \*appData, uint32_t appDataLen, struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 上报输出buffer填充完毕。 [更多...](_codec.md#fillbufferdone) | +| ( [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) | ## **详细描述** 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 9487954829..0850d4c662 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 @@ -15,24 +15,24 @@ | Public 属性 | 描述 | | -------- | -------- | -| ( [GetComponentVersion](_codec.md#getcomponentversion) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref1521256091083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self, struct [CompVerInfo](_comp_ver_info.md) \*verInfo) | 获取Codec组件版本号。 [更多...](_codec.md#getcomponentversion) | -| ( [SendCommand](_codec.md#sendcommand) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref2020788308083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self, enum OMX_COMMANDTYPE cmd, uint32_t param, int8_t \*cmdData, uint32_t cmdDataLen) | 发送命令给组件。 [更多...](_codec.md#sendcommand) | -| ( [GetParameter](_codec.md#getparameter) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref2071182762083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self, uint32_t paramIndex, int8_t \*paramStruct, uint32_t paramStructLen) | 获取组件参数设置。 [更多...](_codec.md#getparameter) | -| ( [SetParameter](_codec.md#setparameter) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref1874982936083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self, uint32_t index, int8_t \*paramStruct, uint32_t paramStructLen) | 设置组件需要的参数。 [更多...](_codec.md#setparameter) | -| ( [GetConfig](_codec.md#getconfig) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref921941812083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self, uint32_t index, int8_t \*cfgStruct, uint32_t cfgStructLen) | 获取组件的配置结构。 [更多...](_codec.md#getconfig) | -| ( [SetConfig](_codec.md#setconfig) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref1073566491083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self, uint32_t index, int8_t \*cfgStruct, uint32_t cfgStructLen) | 设置组件的配置。 [更多...](_codec.md#setconfig) | -| ( [GetExtensionIndex](_codec.md#getextensionindex) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref68113596083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self, const char \*paramName, uint32_t \*indexType) | 根据字符串获取组件的扩展索引。 [更多...](_codec.md#getextensionindex) | -| ( [GetState](_codec.md#getstate) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref1226754841083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self, enum OMX_STATETYPE \*state) | 获取组件的当前状态。 [更多...](_codec.md#getstate) | -| ( [ComponentTunnelRequest](_codec.md#componenttunnelrequest) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref1739461855083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self, uint32_t port, int32_t tunneledComp, uint32_t tunneledPort, struct OMX_TUNNELSETUPTYPE \*tunnelSetup) | 设置组件采用Tunnel方式通信。 [更多...](_codec.md#componenttunnelrequest) | -| ( [UseBuffer](_codec.md#usebuffer) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref2135329427083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self, uint32_t portIndex, struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 指定组件端口的buffer。 [更多...](_codec.md#usebuffer) | -| ( [AllocateBuffer](_codec.md#allocatebuffer) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref857621490083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self, uint32_t portIndex, struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 向组件申请端口buffer。 [更多...](_codec.md#allocatebuffer) | -| ( [FreeBuffer](_codec.md#freebuffer) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref1026220701083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self, uint32_t portIndex, const struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 释放buffer。 [更多...](_codec.md#freebuffer) | -| ( [EmptyThisBuffer](_codec.md#emptythisbuffer) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref1735359869083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self, const struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 编解码输入待处理buffer。 [更多...](_codec.md#emptythisbuffer) | -| ( [FillThisBuffer](_codec.md#fillthisbuffer) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref1574208746083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self, const struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 编解码输出填充buffer。 [更多...](_codec.md#fillthisbuffer) | -| ( [SetCallbacks](_codec.md#setcallbacks) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref1922857471083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self, struct [CodecCallbackType](_codec_callback_type.md) \*callback, int8_t \*appData, uint32_t appDataLen) | 设置Codec组件的回调函数。 [更多...](_codec.md#setcallbacks) | -| ( [ComponentDeInit](_codec.md#componentdeinit) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref1721252790083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self) | 组件去初始化。 [更多...](_codec.md#componentdeinit) | -| ( [UseEglImage](_codec.md#useeglimage) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref872648430083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*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 [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref1661834974083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self, uint8_t \*role, uint32_t roleLen, uint32_t index) | 获取组件角色。 [更多...](_codec.md#componentroleenum) | +| ( [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) | ## **详细描述** diff --git a/zh-cn/device-dev/reference/hdi-apis/_device_info.md b/zh-cn/device-dev/reference/hdi-apis/_device_info.md index 592bd0305d..d70dedd180 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_device_info.md +++ b/zh-cn/device-dev/reference/hdi-apis/_device_info.md @@ -1,4 +1,4 @@ -# DeviceInfo +# InputDeviceInfo ## **概述** @@ -15,180 +15,104 @@ | Public 属性 | 描述 | | -------- | -------- | -| [devIndex](#devindex) | 设备索引 | -| [fd](#fd) | 设备对应的文件描述符 | -| [service](#service) | 设备对应的服务 | -| [listener](#listener) | 设备对应的事件监听器 | -| [devType](#devtype) | 设备类型 | -| [powerStatus](#powerstatus) | 电源状态 | +| [devIndex](#devindex) | 设备索引 | +| [devType](#devtype) | 设备类型 | | [chipInfo](#chipinfo) [CHIP_INFO_LEN] | 驱动芯片编码信息 | -| [vendorName](#vendorname) [VENDOR_NAME_LEN] | 模组厂商名 | +| [vendorName](#vendorname) [VENDOR_NAME_LEN] | 模组厂商名 | | [chipName](#chipname) [CHIP_NAME_LEN] | 驱动芯片型号 | -| [devNodePath](#devnodepath) [MAX_NODE_PATH_LEN] | 设备文件路径 | -| [solutionX](#solutionx) | x方向分辨率 | -| [solutionY](#solutiony) | y方向分辨率 | -| [callback](#callback) | 数据上报回调函数 [InputReportEventCb](_input_report_event_cb.md) | +| [attrSet](#attrset)| 设备属性。 | +| [abilitySet](#abilityset)| 设备能力属性。| + ## **详细描述** -input设备基础设备信息 +Input设备基础设备信息。 ## **类成员变量说明** -### callback - - -``` -InputReportEventCb* DeviceInfo::callback -``` - -**描述：** - -数据上报回调函数 [InputReportEventCb](_input_report_event_cb.md) - - ### chipInfo ``` -char DeviceInfo::chipInfo[CHIP_INFO_LEN] +char InputDeviceInfo::chipInfo[CHIP_INFO_LEN] ``` **描述：** -驱动芯片编码信息 +驱动芯片编码信息。 ### chipName ``` -char DeviceInfo::chipName[CHIP_NAME_LEN] +char InputDeviceInfo::chipName[CHIP_NAME_LEN] ``` **描述：** -驱动芯片型号 +驱动芯片型号。 ### devIndex ``` -uint32_t DeviceInfo::devIndex +uint32_t InputDeviceInfo::devIndex ``` **描述：** -设备索引 - - -### devNodePath - - -``` -char DeviceInfo::devNodePath[MAX_NODE_PATH_LEN] -``` - -**描述：** +设备索引。 -设备文件路径 ### devType ``` -uint32_t DeviceInfo::devType -``` - -**描述：** - -设备类型 - - -### fd - - -``` -int32_t DeviceInfo::fd -``` - -**描述：** - -设备对应的文件描述符 - - -### listener - - -``` -void* DeviceInfo::listener -``` - -**描述：** - -设备对应的事件监听器 - - -### powerStatus - - -``` -uint32_t DeviceInfo::powerStatus -``` - -**描述：** - -电源状态 - - -### service - - -``` -void* DeviceInfo::service +uint32_t InputDeviceInfo::devType ``` **描述：** -设备对应的服务 +设备类型。 -### solutionX +### vendorName ``` -uint32_t DeviceInfo::solutionX +char InputDeviceInfo::vendorName[VENDOR_NAME_LEN] ``` **描述：** -x方向分辨率 +模组厂商名。 -### solutionY +### attrSet ``` -uint32_t DeviceInfo::solutionY +InputDevAttr InputDeviceInfo::attrSet ``` **描述：** -y方向分辨率 +设备属性。 -### vendorName +### abilitySet ``` -char DeviceInfo::vendorName[VENDOR_NAME_LEN] +InputDevAbility InputDeviceInfo::abilitySet ``` **描述：** -模组厂商名 +设备能力属性。 \ No newline at end of file diff --git a/zh-cn/device-dev/reference/hdi-apis/_display.md b/zh-cn/device-dev/reference/hdi-apis/_display.md index a062997aa1..1e8b1851ab 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_display.md +++ b/zh-cn/device-dev/reference/hdi-apis/_display.md @@ -268,7 +268,7 @@ ### HotPlugCallback - + ``` typedef void(* HotPlugCallback) (uint32_t devId, bool connected, void *data) ``` @@ -290,7 +290,7 @@ typedef void(* HotPlugCallback) (uint32_t devId, bool connected, void *data) ### RefreshCallback - + ``` typedef void(* RefreshCallback) (uint32_t devId, void *data) ``` @@ -311,7 +311,7 @@ typedef void(* RefreshCallback) (uint32_t devId, void *data) ### VBlankCallback - + ``` typedef void(* VBlankCallback) (unsigned int sequence, uint64_t ns, void *data) ``` @@ -336,7 +336,7 @@ VBlank 事件回调。 ### anonymous enum - + ``` anonymous enum ``` @@ -359,7 +359,7 @@ anonymous enum ### BlendType - + ``` enum BlendType ``` @@ -393,7 +393,7 @@ enum BlendType ### ColorDataSpace - + ``` enum ColorDataSpace ``` @@ -450,7 +450,7 @@ enum ColorDataSpace ### ColorGamut - + ``` enum ColorGamut ``` @@ -477,7 +477,7 @@ enum ColorGamut ### ColorKey - + ``` enum ColorKey ``` @@ -496,7 +496,7 @@ Color key操作类型定义，即硬件加速支持的Color key操作类型。 ### CompositionType - + ``` enum CompositionType ``` @@ -519,7 +519,7 @@ enum CompositionType ### Connection - + ``` enum Connection ``` @@ -537,7 +537,7 @@ enum Connection ### DispErrCode - + ``` enum DispErrCode ``` @@ -561,7 +561,7 @@ enum DispErrCode ### DispPowerStatus - + ``` enum DispPowerStatus ``` @@ -581,7 +581,7 @@ enum DispPowerStatus ### GamutMap - + ``` enum GamutMap ``` @@ -600,7 +600,7 @@ enum GamutMap ### HDRFormat - + ``` enum HDRFormat ``` @@ -621,7 +621,7 @@ enum HDRFormat ### HDRMetadataKey - + ``` enum HDRMetadataKey ``` @@ -650,7 +650,7 @@ enum HDRMetadataKey ### InterfaceType - + ``` enum InterfaceType ``` @@ -677,7 +677,7 @@ enum InterfaceType ### LayerType - + ``` enum LayerType ``` @@ -697,7 +697,7 @@ enum LayerType ### MirrorType - + ``` enum MirrorType ``` @@ -716,7 +716,7 @@ enum MirrorType ### PixelFormat - + ``` enum PixelFormat ``` @@ -767,7 +767,7 @@ enum PixelFormat ### PresentTimestampType - + ``` enum PresentTimestampType ``` @@ -785,7 +785,7 @@ enum PresentTimestampType ### RopType - + ``` enum RopType ``` @@ -819,7 +819,7 @@ enum RopType ### TransformType - + ``` enum TransformType ``` @@ -842,7 +842,7 @@ enum TransformType ### DeviceInitialize() - + ``` int32_t DeviceInitialize (DeviceFuncs **funcs) ``` @@ -874,7 +874,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### DeviceUninitialize() - + ``` int32_t DeviceUninitialize (DeviceFuncs * funcs) ``` @@ -906,7 +906,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### GfxInitialize() - + ``` int32_t GfxInitialize (GfxFuncs **funcs) ``` @@ -938,7 +938,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### GfxUninitialize() - + ``` int32_t GfxUninitialize (GfxFuncs * funcs) ``` @@ -970,7 +970,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### GrallocInitialize() - + ``` int32_t GrallocInitialize (GrallocFuncs **funcs) ``` @@ -1002,7 +1002,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### GrallocUninitialize() - + ``` int32_t GrallocUninitialize (GrallocFuncs * funcs) ``` @@ -1034,7 +1034,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### LayerInitialize() - + ``` int32_t LayerInitialize (LayerFuncs **funcs) ``` @@ -1062,7 +1062,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### LayerUninitialize() - + ``` int32_t LayerUninitialize (LayerFuncs * funcs) ``` @@ -1101,7 +1101,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### alpha0 [1/2] - + ``` uint8_t LayerAlpha::alpha0 ``` @@ -1113,7 +1113,7 @@ alpha0值，取值范围：[0, 255] ### alpha0 [2/2] - + ``` uint8_t ISurface::alpha0 ``` @@ -1125,7 +1125,7 @@ Alpha0值，取值范围：[0,255] ### alpha1 [1/2] - + ``` uint8_t LayerAlpha::alpha1 ``` @@ -1137,7 +1137,7 @@ alpha1值，取值范围：[0, 255] ### alpha1 [2/2] - + ``` uint8_t ISurface::alpha1 ``` @@ -1149,7 +1149,7 @@ Alpha1值，取值范围：[0,255] ### alphaRopType - + ``` RopType GfxOpt::alphaRopType ``` @@ -1161,7 +1161,7 @@ Alpha的Rop类型 ### bAlphaExt1555 - + ``` bool ISurface::bAlphaExt1555 ``` @@ -1173,7 +1173,7 @@ bool ISurface::bAlphaExt1555 ### bAlphaMax255 - + ``` bool ISurface::bAlphaMax255 ``` @@ -1185,7 +1185,7 @@ bool ISurface::bAlphaMax255 ### baseAddr - + ``` void* __attribute__::baseAddr ``` @@ -1197,7 +1197,7 @@ void* __attribute__::baseAddr ### blendType - + ``` BlendType GfxOpt::blendType ``` @@ -1209,7 +1209,7 @@ BlendType GfxOpt::blendType ### bpp - + ``` int32_t LayerInfo::bpp ``` @@ -1221,7 +1221,7 @@ int32_t LayerInfo::bpp ### bYCbCrClut - + ``` bool ISurface::bYCbCrClut ``` @@ -1233,7 +1233,7 @@ CLUT表是否位于 YCbCr 空间 ### cbcrPhyAddr - + ``` uint64_t ISurface::cbcrPhyAddr ``` @@ -1245,7 +1245,7 @@ CbCr分量地址 ### cbcrStride - + ``` int32_t ISurface::cbcrStride ``` @@ -1257,7 +1257,7 @@ CbCr分量跨度 ### clutPhyAddr - + ``` uint64_t ISurface::clutPhyAddr ``` @@ -1269,7 +1269,7 @@ Clut表首地址，用作颜色扩展或颜色校正 ### color [1/3] - + ``` uint32_t ILine::color ``` @@ -1281,7 +1281,7 @@ uint32_t ILine::color ### color [2/3] - + ``` uint32_t ICircle::color ``` @@ -1293,7 +1293,7 @@ uint32_t ICircle::color ### color [3/3] - + ``` uint32_t Rectangle::color ``` @@ -1305,7 +1305,7 @@ uint32_t Rectangle::color ### colorKeyFrom - + ``` ColorKey GfxOpt::colorKeyFrom ``` @@ -1317,7 +1317,7 @@ ColorKey GfxOpt::colorKeyFrom ### colorRopType - + ``` RopType GfxOpt::colorRopType ``` @@ -1329,7 +1329,7 @@ RopType GfxOpt::colorRopType ### Commit - + ``` int32_t(* DeviceFuncs::Commit) (uint32_t devId, int32_t *fence) ``` @@ -1356,7 +1356,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### CreateVirtualDisplay - + ``` int32_t(* DeviceFuncs::CreateVirtualDisplay) (uint32_t width, uint32_t height, int32_t *format, uint32_t *devId) ``` @@ -1369,12 +1369,12 @@ int32_t(* DeviceFuncs::CreateVirtualDisplay) (uint32_t width, uint32_t height, i **参数:** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| width | 输入参数，指定显示设备的像素宽度。 | -| height | 输入参数，指定显示设备的像素高度。 | -| format | 输出参数，指定显示设备的像素格式。 详情参考[ERROR:Invalid link:zh-cn_topic_0000001357381993.xml#xref738382043153217,link:zh-cn_topic_0000001347985105.xml#ga60883d4958a60b91661e97027a85072a](zh-cn_topic_0000001347985105.xml#ga60883d4958a60b91661e97027a85072a)，接口实现层可以根据硬件需求，修改format并返回给图形服务。 | -| devId | 输出参数，用于接口层返回创建的设备ID。 | +| width | 输入参数，指定显示设备的像素宽度。 | +| height | 输入参数，指定显示设备的像素高度。 | +| format | 输出参数，指定显示设备的像素格式。详情参考[PixelFormat](#pixelformat)，接口实现层可以根据硬件需求，修改format并返回给图形服务。 | +| devId | 输出参数，用于接口层返回创建的设备ID。 | **返回:** @@ -1385,7 +1385,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### CreateWriteBack - + ``` int32_t(* DeviceFuncs::CreateWriteBack) (uint32_t *devId, uint32_t width, uint32_t height, int32_t *format) ``` @@ -1414,7 +1414,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### data - + ``` BufferData LayerBuffer::data ``` @@ -1426,7 +1426,7 @@ BufferData LayerBuffer::data ### DestroyVirtualDisplay - + ``` int32_t(* DeviceFuncs::DestroyVirtualDisplay) (uint32_t devId) ``` @@ -1452,7 +1452,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### DestroyWriteBack - + ``` int32_t(* DeviceFuncs::DestroyWriteBack) (uint32_t devId) ``` @@ -1478,7 +1478,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### enableRop - + ``` bool GfxOpt::enableRop ``` @@ -1490,7 +1490,7 @@ Rop功能使能位 ### enableScale - + ``` bool GfxOpt::enableScale ``` @@ -1502,7 +1502,7 @@ bool GfxOpt::enableScale ### enColorFmt - + ``` PixelFormat ISurface::enColorFmt ``` @@ -1514,7 +1514,7 @@ PixelFormat ISurface::enColorFmt ### enGlobalAlpha [1/2] - + ``` bool LayerAlpha::enGlobalAlpha ``` @@ -1526,7 +1526,7 @@ bool LayerAlpha::enGlobalAlpha ### enGlobalAlpha [2/2] - + ``` bool GfxOpt::enGlobalAlpha ``` @@ -1538,7 +1538,7 @@ bool GfxOpt::enGlobalAlpha ### enPixelAlpha [1/2] - + ``` bool LayerAlpha::enPixelAlpha ``` @@ -1550,7 +1550,7 @@ bool LayerAlpha::enPixelAlpha ### enPixelAlpha [2/2] - + ``` bool GfxOpt::enPixelAlpha ``` @@ -1562,7 +1562,7 @@ bool GfxOpt::enPixelAlpha ### expectedSize - + ``` uint32_t AllocInfo::expectedSize ``` @@ -1574,7 +1574,7 @@ uint32_t AllocInfo::expectedSize ### fd - + ``` int32_t __attribute__::fd ``` @@ -1586,7 +1586,7 @@ int32_t __attribute__::fd ### fenceId - + ``` int32_t LayerBuffer::fenceId ``` @@ -1598,7 +1598,7 @@ buffer 的fence号 ### format [1/2] - + ``` PixelFormat AllocInfo::format ``` @@ -1610,7 +1610,7 @@ PixelFormat AllocInfo::format ### format [2/2] - + ``` PixelFormat VerifyAllocInfo::format ``` @@ -1622,7 +1622,7 @@ PixelFormat VerifyAllocInfo::format ### formatCount - + ``` uint32_t HDRCapability::formatCount ``` @@ -1634,7 +1634,7 @@ uint32_t HDRCapability::formatCount ### formats - + ``` HDRFormat* HDRCapability::formats ``` @@ -1646,7 +1646,7 @@ HDRFormat* HDRCapability::formats ### freshRate - + ``` uint32_t DisplayModeInfo::freshRate ``` @@ -1658,7 +1658,7 @@ uint32_t DisplayModeInfo::freshRate ### gAlpha - + ``` uint8_t LayerAlpha::gAlpha ``` @@ -1670,7 +1670,7 @@ uint8_t LayerAlpha::gAlpha ### GetDisplayBacklight - + ``` int32_t(* DeviceFuncs::GetDisplayBacklight) (uint32_t devId, uint32_t *level) ``` @@ -1697,7 +1697,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### GetDisplayCapability - + ``` int32_t(* DeviceFuncs::GetDisplayCapability) (uint32_t devId, DisplayCapability *info) ``` @@ -1724,7 +1724,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### GetDisplayColorGamut - + ``` int32_t(* DeviceFuncs::GetDisplayColorGamut) (uint32_t devId, ColorGamut *gamut) ``` @@ -1749,7 +1749,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### GetDisplayCompChange - + ``` int32_t(* DeviceFuncs::GetDisplayCompChange) (uint32_t devId, uint32_t *num, uint32_t *Layers, int32_t *type) ``` @@ -1778,7 +1778,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### GetDisplayGamutMap - + ``` int32_t(* DeviceFuncs::GetDisplayGamutMap) (uint32_t devId, GamutMap *gamutMap) ``` @@ -1803,7 +1803,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### GetDisplayMode - + ``` int32_t(* DeviceFuncs::GetDisplayMode) (uint32_t devId, uint32_t *modeId) ``` @@ -1830,7 +1830,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### GetDisplayPowerStatus - + ``` int32_t(* DeviceFuncs::GetDisplayPowerStatus) (uint32_t devId, DispPowerStatus *status) ``` @@ -1857,7 +1857,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### GetDisplayProperty - + ``` int32_t(* DeviceFuncs::GetDisplayProperty) (uint32_t devId, uint32_t id, uint64_t *value) ``` @@ -1885,7 +1885,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### GetDisplayReleaseFence - + ``` int32_t(* DeviceFuncs::GetDisplayReleaseFence) (uint32_t devId, uint32_t *num, uint32_t *layers, int32_t *fences) ``` @@ -1914,7 +1914,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### GetDisplaySupportedColorGamuts - + ``` int32_t(* DeviceFuncs::GetDisplaySupportedColorGamuts) (uint32_t devId, uint32_t *num, ColorGamut *gamuts) ``` @@ -1940,7 +1940,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### GetDisplaySupportedModes - + ``` int32_t(* DeviceFuncs::GetDisplaySupportedModes) (uint32_t devId, uint32_t *num, DisplayModeInfo *modes) ``` @@ -1968,7 +1968,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### GetHDRCapabilityInfos - + ``` int32_t(* DeviceFuncs::GetHDRCapabilityInfos) (uint32_t devId, HDRCapability *info) ``` @@ -1993,7 +1993,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### GetSupportedMetadataKey - + ``` int32_t(* DeviceFuncs::GetSupportedMetadataKey) (uint32_t devId, uint32_t *num, HDRMetadataKey *keys) ``` @@ -2019,7 +2019,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### GetWriteBackFrame - + ``` int32_t(* DeviceFuncs::GetWriteBackFrame) (uint32_t devId, BufferHandle *buffer, int32_t *fence) ``` @@ -2047,7 +2047,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### globalAlpha - + ``` uint32_t GfxOpt::globalAlpha ``` @@ -2059,7 +2059,7 @@ uint32_t GfxOpt::globalAlpha ### h - + ``` int32_t IRect::h ``` @@ -2071,7 +2071,7 @@ int32_t IRect::h ### hdl - + ``` BufferHandle* LayerBuffer::hdl ``` @@ -2083,7 +2083,7 @@ BufferHandle* LayerBuffer::hdl ### height [1/7] - + ``` uint32_t DisplayInfo::height ``` @@ -2095,7 +2095,7 @@ uint32_t DisplayInfo::height ### height [2/7] - + ``` int32_t LayerInfo::height ``` @@ -2107,7 +2107,7 @@ int32_t LayerInfo::height ### height [3/7] - + ``` int32_t LayerBuffer::height ``` @@ -2119,7 +2119,7 @@ buffer高度 ### height [4/7] - + ``` int32_t ISurface::height ``` @@ -2131,7 +2131,7 @@ int32_t ISurface::height ### height [5/7] - + ``` int32_t DisplayModeInfo::height ``` @@ -2143,7 +2143,7 @@ int32_t DisplayModeInfo::height ### height [6/7] - + ``` uint32_t AllocInfo::height ``` @@ -2155,7 +2155,7 @@ uint32_t AllocInfo::height ### height [7/7] - + ``` uint32_t VerifyAllocInfo::height ``` @@ -2167,7 +2167,7 @@ uint32_t VerifyAllocInfo::height ### id - + ``` int32_t DisplayModeInfo::id ``` @@ -2179,7 +2179,7 @@ int32_t DisplayModeInfo::id ### InvokeDisplayCmd - + ``` int32_t(* DeviceFuncs::InvokeDisplayCmd) (uint32_t devId,...) ``` @@ -2205,7 +2205,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### key - + ``` HDRMetadataKey HDRMetaData::key ``` @@ -2217,7 +2217,7 @@ HDR元数据关键字 ### maxAverageLum - + ``` float HDRCapability::maxAverageLum ``` @@ -2229,7 +2229,7 @@ float HDRCapability::maxAverageLum ### maxLum - + ``` float HDRCapability::maxLum ``` @@ -2241,7 +2241,7 @@ float HDRCapability::maxLum ### minLum - + ``` float HDRCapability::minLum ``` @@ -2253,7 +2253,7 @@ float HDRCapability::minLum ### mirrorType - + ``` MirrorType GfxOpt::mirrorType ``` @@ -2265,9 +2265,9 @@ MirrorType GfxOpt::mirrorType ### name [1/2] - + ``` -char PropertyObject::名称[PROPERTY_NAME_LEN] +char PropertyObject::name[PROPERTY_NAME_LEN] ``` **描述：** @@ -2277,9 +2277,9 @@ char PropertyObject::名称[PROPERTY_NAME_LEN] ### name [2/2] - + ``` -char DisplayCapability::名称[PROPERTY_NAME_LEN] +char DisplayCapability::name[PROPERTY_NAME_LEN] ``` **描述：** @@ -2289,7 +2289,7 @@ char DisplayCapability::名称[PROPERTY_NAME_LEN] ### phyAddr [1/2] - + ``` uint64_t BufferData::phyAddr ``` @@ -2301,7 +2301,7 @@ uint64_t BufferData::phyAddr ### phyAddr [2/2] - + ``` uint64_t ISurface::phyAddr ``` @@ -2313,7 +2313,7 @@ uint64_t ISurface::phyAddr ### phyHeight - + ``` uint32_t DisplayCapability::phyHeight ``` @@ -2325,7 +2325,7 @@ uint32_t DisplayCapability::phyHeight ### phyWidth - + ``` uint32_t DisplayCapability::phyWidth ``` @@ -2337,7 +2337,7 @@ uint32_t DisplayCapability::phyWidth ### pitch - + ``` int32_t LayerBuffer::pitch ``` @@ -2349,7 +2349,7 @@ int32_t LayerBuffer::pitch ### pixFormat [1/2] - + ``` PixelFormat LayerInfo::pixFormat ``` @@ -2361,7 +2361,7 @@ PixelFormat LayerInfo::pixFormat ### pixFormat [2/2] - + ``` PixelFormat LayerBuffer::pixFormat ``` @@ -2373,7 +2373,7 @@ buffer像素格式 ### PrepareDisplayLayers - + ``` int32_t(* DeviceFuncs::PrepareDisplayLayers) (uint32_t devId, bool *needFlushFb) ``` @@ -2400,7 +2400,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### propertyCount - + ``` uint32_t DisplayCapability::propertyCount ``` @@ -2412,7 +2412,7 @@ uint32_t DisplayCapability::propertyCount ### propId - + ``` uint32_t PropertyObject::propId ``` @@ -2424,7 +2424,7 @@ uint32_t PropertyObject::propId ### props - + ``` PropertyObject* DisplayCapability::props ``` @@ -2436,7 +2436,7 @@ PropertyObject* DisplayCapability::props ### r - + ``` int32_t ICircle::r ``` @@ -2448,7 +2448,7 @@ int32_t ICircle::r ### rect - + ``` IRect Rectangle::rect ``` @@ -2460,7 +2460,7 @@ IRect Rectangle::rect ### RegDisplayRefreshCallback - + ``` int32_t(* DeviceFuncs::RegDisplayRefreshCallback) (uint32_t devId, RefreshCallback callback, void *data) ``` @@ -2488,7 +2488,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### RegDisplayVBlankCallback - + ``` int32_t(* DeviceFuncs::RegDisplayVBlankCallback) (uint32_t devId, VBlankCallback callback, void *data) ``` @@ -2516,7 +2516,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### RegHotPlugCallback - + ``` int32_t(* DeviceFuncs::RegHotPlugCallback) ((HotPlugCallback callback, void *data) ``` @@ -2543,7 +2543,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### reserve - + ``` int32_t __attribute__::reserve[0] ``` @@ -2555,7 +2555,7 @@ reserve数组 ### reserveInts - + ``` uint32_t __attribute__::reserveInts ``` @@ -2567,7 +2567,7 @@ reserve数组的个数 ### rotAngle - + ``` int32_t DisplayInfo::rotAngle ``` @@ -2579,7 +2579,7 @@ int32_t DisplayInfo::rotAngle ### rotateType - + ``` TransformType GfxOpt::rotateType ``` @@ -2591,7 +2591,7 @@ TransformType GfxOpt::rotateType ### SetDisplayBacklight - + ``` int32_t(* DeviceFuncs::SetDisplayBacklight) (uint32_t devId, uint32_t level) ``` @@ -2618,7 +2618,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### SetDisplayClientBuffer - + ``` int32_t(* DeviceFuncs::SetDisplayClientBuffer) (uint32_t devId, const BufferHandle *buffer, int32_t fence) ``` @@ -2646,7 +2646,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### SetDisplayClientCrop - + ``` int32_t(* DeviceFuncs::SetDisplayClientCrop) (uint32_t devId, IRect *rect) ``` @@ -2673,7 +2673,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### SetDisplayClientDamage - + ``` int32_t(* DeviceFuncs::SetDisplayClientDamage) (uint32_t devId, uint32_t num, IRect *rect) ``` @@ -2701,7 +2701,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### SetDisplayClientDestRect - + ``` int32_t(* DeviceFuncs::SetDisplayClientDestRect) (uint32_t devId, IRect *rect) ``` @@ -2728,7 +2728,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### SetDisplayColorGamut - + ``` int32_t(* DeviceFuncs::SetDisplayColorGamut) (uint32_t devId, ColorGamut gamut) ``` @@ -2753,7 +2753,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### SetDisplayColorTransform - + ``` int32_t(* DeviceFuncs::SetDisplayColorTransform) (uint32_t devId, const float *matrix) ``` @@ -2778,7 +2778,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### SetDisplayGamutMap - + ``` int32_t(* DeviceFuncs::SetDisplayGamutMap) (uint32_t devId, GamutMap gamutMap) ``` @@ -2803,7 +2803,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### SetDisplayMode - + ``` int32_t(* DeviceFuncs::SetDisplayMode) (uint32_t devId, uint32_t modeId) ``` @@ -2830,7 +2830,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### SetDisplayPowerStatus - + ``` int32_t(* DeviceFuncs::SetDisplayPowerStatus) (uint32_t devId, DispPowerStatus status) ``` @@ -2857,7 +2857,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### SetDisplayProperty - + ``` int32_t(* DeviceFuncs::SetDisplayProperty) (uint32_t devId, uint32_t id, uint64_t value) ``` @@ -2885,7 +2885,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### SetDisplayVsyncEnabled - + ``` int32_t(* DeviceFuncs::SetDisplayVsyncEnabled) (uint32_t devId, bool enabled) ``` @@ -2912,7 +2912,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### SetVirtualDisplayBuffer - + ``` int32_t(* DeviceFuncs::SetVirtualDisplayBuffer) (uint32_t devId, BufferHandle *buffer, int32_t fence) ``` @@ -2940,7 +2940,7 @@ DISPLAY_SUCCESS 表示执行成功。 ### stride - + ``` int32_t ISurface::stride ``` @@ -2952,7 +2952,7 @@ int32_t ISurface::stride ### supportLayers - + ``` uint32_t DisplayCapability::supportLayers ``` @@ -2964,7 +2964,7 @@ uint32_t DisplayCapability::supportLayers ### supportWriteBack - + ``` bool DisplayCapability::supportWriteBack ``` @@ -2976,7 +2976,7 @@ bool DisplayCapability::supportWriteBack ### time - + ``` int64_t PresentTimestamp::time ``` @@ -2988,7 +2988,7 @@ int64_t PresentTimestamp::time ### type [1/3] - + ``` LayerType LayerInfo::type ``` @@ -3000,7 +3000,7 @@ LayerType LayerInfo::type ### type [2/3] - + ``` InterfaceType DisplayCapability::type ``` @@ -3012,7 +3012,7 @@ InterfaceType DisplayCapability::type ### type [3/3] - + ``` PresentTimestampType PresentTimestamp::type ``` @@ -3024,7 +3024,7 @@ PresentTimestampType PresentTimestamp::type ### uOffset - + ``` size_t __attribute__::uOffset ``` @@ -3036,7 +3036,7 @@ U的偏移量 ### usage [1/2] - + ``` uint64_t AllocInfo::usage ``` @@ -3048,7 +3048,7 @@ uint64_t AllocInfo::usage ### usage [2/2] - + ``` uint64_t VerifyAllocInfo::usage ``` @@ -3060,7 +3060,7 @@ uint64_t VerifyAllocInfo::usage ### uvStep - + ``` size_t __attribute__::uvStep ``` @@ -3072,7 +3072,7 @@ UV的step信息 ### uvStride - + ``` size_t __attribute__::uvStride ``` @@ -3084,7 +3084,7 @@ UV的stride信息 ### value [1/2] - + ``` uint64_t PropertyObject::value ``` @@ -3096,7 +3096,7 @@ uint64_t PropertyObject::value ### value [2/2] - + ``` float HDRMetaData::value ``` @@ -3108,7 +3108,7 @@ float HDRMetaData::value ### virAddr - + ``` void* BufferData::virAddr ``` @@ -3120,7 +3120,7 @@ void* BufferData::virAddr ### virtualDispCount - + ``` uint32_t DisplayCapability::virtualDispCount ``` @@ -3132,7 +3132,7 @@ uint32_t DisplayCapability::virtualDispCount ### vOffset - + ``` size_t __attribute__::vOffset ``` @@ -3144,7 +3144,7 @@ V的偏移量 ### w - + ``` int32_t IRect::w ``` @@ -3156,7 +3156,7 @@ int32_t IRect::w ### width [1/7] - + ``` uint32_t DisplayInfo::width ``` @@ -3168,7 +3168,7 @@ uint32_t DisplayInfo::width ### width [2/7] - + ``` int32_t LayerInfo::width ``` @@ -3180,7 +3180,7 @@ int32_t LayerInfo::width ### width [3/7] - + ``` int32_t LayerBuffer::width ``` @@ -3192,7 +3192,7 @@ buffer宽度 ### width [4/7] - + ``` int32_t ISurface::width ``` @@ -3204,7 +3204,7 @@ int32_t ISurface::width ### width [5/7] - + ``` int32_t DisplayModeInfo::width ``` @@ -3216,7 +3216,7 @@ int32_t DisplayModeInfo::width ### width [6/7] - + ``` uint32_t AllocInfo::width ``` @@ -3228,7 +3228,7 @@ uint32_t AllocInfo::width ### width [7/7] - + ``` uint32_t VerifyAllocInfo::width ``` @@ -3240,7 +3240,7 @@ uint32_t VerifyAllocInfo::width ### x [1/2] - + ``` int32_t IRect::x ``` @@ -3252,7 +3252,7 @@ int32_t IRect::x ### x [2/2] - + ``` int32_t ICircle::x ``` @@ -3264,7 +3264,7 @@ int32_t ICircle::x ### x0 - + ``` int32_t ILine::x0 ``` @@ -3276,7 +3276,7 @@ int32_t ILine::x0 ### x1 - + ``` int32_t ILine::x1 ``` @@ -3288,7 +3288,7 @@ int32_t ILine::x1 ### y [1/2] - + ``` int32_t IRect::y ``` @@ -3300,7 +3300,7 @@ int32_t IRect::y ### y [2/2] - + ``` int32_t ICircle::y ``` @@ -3312,7 +3312,7 @@ int32_t ICircle::y ### y0 - + ``` int32_t ILine::y0 ``` @@ -3324,7 +3324,7 @@ int32_t ILine::y0 ### y1 - + ``` int32_t ILine::y1 ``` @@ -3336,7 +3336,7 @@ int32_t ILine::y1 ### yOffset - + ``` size_t __attribute__::yOffset ``` @@ -3348,7 +3348,7 @@ Y的偏移量 ### yStride - + ``` size_t __attribute__::yStride ``` diff --git a/zh-cn/device-dev/reference/hdi-apis/_event_package.md b/zh-cn/device-dev/reference/hdi-apis/_event_package.md index 6ea01ee6fa..d044d04799 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_event_package.md +++ b/zh-cn/device-dev/reference/hdi-apis/_event_package.md @@ -1,4 +1,4 @@ -# EventPackage +# InputEventPackage ## **概述** @@ -23,7 +23,7 @@ ## **详细描述** -input事件数据包结构。 +Input事件数据包结构。 ## **类成员变量说明** 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 a26f8a42ad..10de6c4064 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 @@ -19,7 +19,7 @@ | 类 | 描述 | | -------- | -------- | | [IExecutor](interface_pin_i_executor.md) | 定义执行器标准API接口。接口可用于获取执行器信息，获取凭据模版信息，注册口令，认证口令，删除口令等。[更多...](interface_pin_i_executor.md) | -| [IExecutorCallback](interface_i_executor_callback.md) | 定义异步API接口回调，用于返回异步接口的请求处理结果和信息。使用细节见[IExecutor](interface_i_executor.md)。 [更多...](interface_i_executor_callback.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) | 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 7b93380140..abdbc3ced7 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 @@ -36,6 +36,7 @@ | [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) | ### 变量 @@ -113,3 +114,21 @@ enum ExecutorSecureLevel : int | ESL1 | 执行器安全级别为1，关键操作在有访问控制的执行环境中完成。 | | ESL2 | 执行器安全级别为2，关键操作在可信执行环境中完成。 | | ESL3 | 执行器安全级别为3，关键操作在高安环境如独立安全芯片中完成。 | + + +### PinSubType + + +``` +enum PinSubType : int +``` + +**描述：** + +口令认证子类型。 + + | 枚举值 | 描述 | +| -------- | -------- | +| PIN_SIX | 六位口令密码。 | +| PIN_NUMBER| 数字口令密码。 | +| PIN_MIX | 混合密码。 | 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 d2308b6bd9..cf3f527b4f 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 @@ -15,14 +15,14 @@ | Public 属性 | 描述 | | -------- | -------- | -| [iInputManager](#iinputmanager) | input设备的设备管理接口。 | -| [iInputController](#iinputcontroller) | input设备的业务控制接口。 | -| [iInputReporter](#iinputreporter) | input设备的数据上报接口。 | +| [iInputManager](#iinputmanager) | Input设备的设备管理接口。 | +| [iInputController](#iinputcontroller) | Input设备的业务控制接口。 | +| [iInputReporter](#iinputreporter) | Input设备的数据上报接口。 | ## **详细描述** -定义用于提供输入设备驱动能力的接口。 +定义用于提供Input设备驱动程序功能的接口。 ## **类成员变量说明** @@ -37,7 +37,7 @@ InputController* IInputInterface::iInputController **描述：** -input设备的业务控制接口 +Input设备的业务控制接口。 ### iInputManager @@ -49,7 +49,7 @@ InputManager* IInputInterface::iInputManager **描述：** -input设备的设备管理接口 +Input设备的设备管理接口。 ### iInputReporter @@ -61,4 +61,4 @@ InputReporter* IInputInterface::iInputReporter **描述：** -input设备的数据上报接口 +Input设备的数据上报接口。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_input.md b/zh-cn/device-dev/reference/hdi-apis/_input.md index 4d1ff3164d..9914bfec5d 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_input.md +++ b/zh-cn/device-dev/reference/hdi-apis/_input.md @@ -8,24 +8,31 @@ | 文件 | 描述 | | -------- | -------- | -| [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设备驱动接口所使用的结构体及枚举类型。 | +| [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) | +| [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) | -| [EventPackage](_event_package.md) | input事件数据包结构 [更多...](_event_package.md) | -| [InputReportEventCb](_input_report_event_cb.md) | 此结构体定义了输入事件回调函数并提供给input服务使用 [更多...](_input_report_event_cb.md) | -| [DeviceInfo](_device_info.md) | input设备基础设备信息 [更多...](_device_info.md) | -| [InputExtraCmd](_input_extra_cmd.md) | 扩展指令的数据结构 [更多...](_input_extra_cmd.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) | ### 宏定义 @@ -33,35 +40,41 @@ | 宏定义 | 描述 | | -------- | -------- | | **MAX_INPUT_DEV_NUM**   32 | Input设备最大数量。 | -| **MAX_NODE_PATH_LEN**   64 | 节点路径最大长度。 | +| **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) | +| [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) | +| [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事件获取、设备信息查询、回调函数注册、特性状态控制等接口。 +本模块为Input服务提供相关驱动接口，包括Input设备的打开和关闭、Input事件获取、设备信息查询、回调函数注册、特性状态控制等接口。 **Since：** @@ -171,13 +184,44 @@ int32_t GetInputInterface (IInputInterface **interface) **描述：** -Input服务通过调用此接口获取操作input设备的所有接口。 +Input服务通过调用此接口获取操作Input设备的所有接口。 **参数：** | 名称 | 描述 | | -------- | -------- | -| interface | 对input设备进行接口操作的指针，通常在input服务启动后，通过调用此函数获取input设备操作接口 | +| interface | 对Input设备进行接口操作的指针，通常在Input服务启动后，通过调用此函数获取Input设备操作接口。 | + +**返回：** + +INPUT_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看**RetSatus**。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +### ReleaseInputInterface() + + +``` +int32_t ReleaseInputInterface (IInputInterface *inputInterface) +``` + +**描述：** + +Input服务通过调用此接口释放操作Input设备的所有接口。 + +**参数：** + +| 名称 | 描述 | +| -------- | -------- | +| inputInterface| 对Input设备进行接口操作的指针。 | **返回：** 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 5cdf213f38..d70cca07b8 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_input_controller.md +++ b/zh-cn/device-dev/reference/hdi-apis/_input_controller.md @@ -17,7 +17,7 @@ | -------- | -------- | | ( [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) | +| ( [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) | @@ -28,7 +28,7 @@ ## **详细描述** -提供input设备业务控制相关的接口。 +提供Input设备业务控制相关的接口。 此类接口包含电源状态的设置、特性的使能、器件信息的获取，以及产线相关的测试功能接口。 @@ -45,7 +45,7 @@ int32_t(* InputController::GetChipInfo) (uint32_t devIndex, char *chipInfo, uint **描述：** -获取器件对应的编码信息 +获取器件对应的编码信息。 一款产品通常会有多家模组和Driver IC，上层应用如果关注具体器件型号，则通过此接口来获取。 @@ -53,15 +53,15 @@ int32_t(* InputController::GetChipInfo) (uint32_t devIndex, char *chipInfo, uint | 名称 | 描述 | | -------- | -------- | -| devIndex | Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。 | -| chipInfo | 获取的对应设备索引的器件编码信息。 | -| length | 保存器件芯片信息的内存长度。 | +| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | +| chipInfo | 输出参数，获取的对应设备索引的器件编码信息。 | +| length | 输入参数，保存器件芯片信息的内存长度。 | **返回：** -Returns INPUT_SUCCESS 表示执行成功。 +INPUT_SUCCESS 表示执行成功。 -Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 +其他值表示执行失败，具体错误码查看**RetSatus**。 ### GetChipName @@ -73,21 +73,21 @@ int32_t(* InputController::GetChipName) (uint32_t devIndex, char *chipName, uint **描述：** -获取devIndex对应的驱动芯片名 +获取devIndex对应的驱动芯片名。 **参数：** | 名称 | 描述 | | -------- | -------- | -| devIndex | Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。 | -| chipName | 获取的对应设备索引的驱动芯片名。 | -| length | 保存驱动芯片名的内存长度。 | +| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | +| chipName | 输出参数，获取的对应设备索引的驱动芯片名。 | +| length | 输入参数，保存驱动芯片名的内存长度。 | **返回：** -Returns INPUT_SUCCESS 表示执行成功。 +INPUT_SUCCESS 表示执行成功。 -Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 +其他值表示执行失败，具体错误码查看**RetSatus**。 ### GetDeviceType @@ -99,20 +99,20 @@ int32_t(* InputController::GetDeviceType) (uint32_t devIndex, uint32_t *deviceTy **描述：** -获取devIndex对应的input设备的类型 +获取devIndex对应的Input设备的类型。 **参数：** | 名称 | 描述 | | -------- | -------- | -| devIndex | Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。 | -| deviceType | 获取的对应设备索引的设备类型，具体参考**InputDevType**。 | +| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | +| deviceType | 输出参数，获取的对应设备索引的设备类型，具体参考**InputDevType**。 | **返回：** -Returns INPUT_SUCCESS 表示执行成功。 +INPUT_SUCCESS 表示执行成功。 -Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 +其他值表示执行失败，具体错误码查看**RetSatus**。 ### GetPowerStatus @@ -124,22 +124,22 @@ int32_t(* InputController::GetPowerStatus) (uint32_t devIndex, uint32_t *status) **描述：** -获取电源状态 +获取电源状态。 -在系统休眠或者唤醒时，input服务或电源管理模块获取电源状态，以便驱动IC能正常进入对应的休眠模式。 +在系统休眠或者唤醒时，Input服务或电源管理模块获取电源状态，以便驱动IC能正常进入对应的休眠模式。 **参数：** | 名称 | 描述 | | -------- | -------- | -| devIndex | Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。 | -| status | 获取的对应设备索引的电源状态，具体参考**PowerStatus**。 | +| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | +| status | 输出参数，获取的对应设备索引的电源状态，具体参考[PowerStatus](_input.md#powerstatus)。 | **返回：** -Returns INPUT_SUCCESS 表示执行成功。 +INPUT_SUCCESS 表示执行成功。 -Returns 其他值表示执行失败，具体错误码查看**RetSatus。** +其他值表示执行失败，具体错误码查看**RetSatus。** ### GetVendorName @@ -157,7 +157,7 @@ int32_t(* InputController::GetVendorName) (uint32_t devIndex, char *vendorName, | 名称 | 描述 | | -------- | -------- | -| devIndex | Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。 | +| devIndex | Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | | vendorName | 获取的对应设备索引的模组厂商名。 | | length | 保存模组厂商名的内存长度。 | @@ -177,24 +177,24 @@ int32_t(* InputController::RunCapacitanceTest) (uint32_t devIndex, uint32_t test **描述：** -执行容值自检测试 +执行容值自检测试。 -启动不同检测场景下的容值自检测试，并获取测试结果，容值自检项由器件厂商自定义， 一般包括RawData测试、 \* 短路检测、开路检测、干扰检测、行列差检测等测试项。 +启动不同检测场景下的容值自检测试，并获取测试结果，容值自检项由器件厂商自定义， 一般包括RawData测试、短路检测、开路检测、干扰检测、行列差检测等测试项。 **参数：** | 名称 | 描述 | | -------- | -------- | -| devIndex | Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。 | -| testType | 容值测试的测试类型，具体参考**CapacitanceTest**。 | -| result | 容值测试的结果，成功则输出“SUCCESS”，失败则返回对应的错误提示 。 | -| length | 保存容值测试结果的内存长度。 | +| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | +| testType | 输入参数，容值测试的测试类型，具体参考**CapacitanceTest**。 | +| result | 输出参数，容值测试的结果，成功则输出“SUCC”，失败则返回对应的错误提示。 | +| length | 输入参数，保存容值测试结果的内存长度。 | **返回：** -Returns INPUT_SUCCESS 表示执行成功。 +INPUT_SUCCESS 表示执行成功。 -Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 +其他值表示执行失败，具体错误码查看**RetSatus**。 ### RunExtraCommand @@ -206,20 +206,20 @@ int32_t(* InputController::RunExtraCommand) (uint32_t devIndex, InputExtraCmd *c **描述：** -执行拓展指令 +执行拓展指令。 **参数：** | 名称 | 描述 | | -------- | -------- | -| devIndex | Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。 | -| cmd | 拓展指令数据包，包括指令编码及参数，具体参考**InputExtraCmd**。 | +| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | +| cmd | 输入参数，拓展指令数据包，包括指令编码及参数，具体参考**InputExtraCmd**。 | **返回：** -Returns INPUT_SUCCESS 表示执行成功。 +INPUT_SUCCESS 表示执行成功。 -Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 +其他值表示执行失败，具体错误码查看**RetSatus**。 ### SetGestureMode @@ -231,22 +231,22 @@ int32_t(* InputController::SetGestureMode) (uint32_t devIndex, uint32_t gestureM **描述：** -设置手势模式 +设置手势模式。 -上层应用开关手势模式，即设置手势模式的对应使能bit +上层应用开关手势模式，即设置手势模式的对应使能bit。 **参数：** | 名称 | 描述 | | -------- | -------- | -| devIndex | Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。 | -| gestureMode | 手势模式的开关状态 | +| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | +| gestureMode | 输入参数，手势模式的开关状态。 | **返回：** -Returns INPUT_SUCCESS 表示执行成功。 +INPUT_SUCCESS 表示执行成功。 -Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 +其他值表示执行失败，具体错误码查看**RetSatus**。 ### SetPowerStatus @@ -258,19 +258,19 @@ int32_t(* InputController::SetPowerStatus) (uint32_t devIndex, uint32_t status) **描述：** -设置电源状态 +设置电源状态。 -在系统休眠或者唤醒时，input服务或电源管理模块设置电源状态，以使驱动IC能正常进入对应的休眠模式。 +在系统休眠或者唤醒时，Input服务或电源管理模块设置电源状态，以使驱动IC能正常进入对应的休眠模式。 **参数：** | 名称 | 描述 | | -------- | -------- | -| devIndex | Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。 | -| status | 设置的电源状态，input服务控制input设备进入resume或者suspend等状态[PowerStatus](_input.md#powerstatus)。 | +| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | +| status | 输入参数，设置的电源状态，Input服务控制Input设备进入resume或者suspend等状态[PowerStatus](_input.md#powerstatus)。 | **返回：** -Returns INPUT_SUCCESS 表示执行成功。 +INPUT_SUCCESS 表示执行成功。 -Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 +其他值表示执行失败，具体错误码查看**RetSatus**。 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 new file mode 100644 index 0000000000..d7ec4c6686 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_input_dev_ability.md @@ -0,0 +1,196 @@ +# InputDevAbility + + +## **概述** + +**所属模块:** + +[Input](_input.md) + + +## **汇总** + + +### 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 + + +``` +uint64_t InputDevAbility::devProp[BITS_TO_UINT64(INPUT_PROP_CNT)] +``` + +**描述：** + +设备属性。 + + +### eventType + + +``` +uint64_t InputDevAbility::eventType[BITS_TO_UINT64(EV_CNT)] +``` + +**描述：** + +用于记录支持的事件类型的位图。 + +### absCode + + +``` +uint64_t InputDevAbility::absCode[BITS_TO_UINT64(ABS_CNT)] +``` + +**描述：** + +记录支持的绝对坐标的位图。 + +### relCode + + +``` +uint64_t InputDevAbility::relCode[BITS_TO_UINT64(REL_CNT)] +``` + +**描述：** + +记录支持的相对坐标的位图。 + +### keyCode + + +``` +uint64_t InputDevAbility::keyCode[BITS_TO_UINT64(KEY_CNT)] +``` + +**描述：** + +记录支持的按键值的位图。 + + +### ledCode + + +``` +uint64_t InputDevAbility::ledCode[BITS_TO_UINT64(LED_CNT)] +``` + +**描述：** + +记录设备支持的指示灯的位图。 + + +### miscCode + + +``` +uint64_t InputDevAbility::miscCode[BITS_TO_UINT64(MSC_CNT)] +``` + +**描述：** + +记录设备支持的其他功能的位图。 + + +### soundCode + + +``` +uint64_t InputDevAbility::soundCode[BITS_TO_UINT64(SND_CNT)] +``` + +**描述：** + +记录设备支持的声音或警报的位图。 + + +### forceCode + +``` +uint64_t InputDevAbility::forceCode[BITS_TO_UINT64(HDF_FF_CNT)] +``` + +**描述：** + +记录设备支持的作用力功能的位图。 + + +### switchCode + +``` +uint64_t InputDevAbility::switchCode[BITS_TO_UINT64(SW_CNT)] +``` + +**描述：** + +记录设备支持的开关功能的位图。 + + +### keyType + +``` +uint64_t InputDevAbility::keyType[BITS_TO_UINT64(KEY_CNT)] +``` + +**描述：** + +按键状态的位图。 + + +### ledType + +``` +uint64_t InputDevAbility::ledType[BITS_TO_UINT64(LED_CNT)] +``` + +**描述：** + +LED状态的位图。 + +### soundType + +``` +uint64_t InputDevAbility::soundType[BITS_TO_UINT64(SND_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 new file mode 100644 index 0000000000..d6dcb2b379 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_input_dev_attr.md @@ -0,0 +1,58 @@ +# InputDevAttr + + +## **概述** + +**所属模块:** + +[Input](_input.md) + + +## **汇总** + + +### Public 属性 + + | Public 属性 | 描述 | +| -------- | -------- | +| [devName](#devname) | 设备名 | +| [id](#id) | 设备识别信息 | +| [axisInfo](#axisinfo) | 设备维度信息 | + +## **详细描述** + +Input设备属性。 + + +## **类成员变量说明** + + +### devName + +``` +char InputDevAttr::devName[DEV_NAME_LEN] +``` + +**描述：** + +设备名。 + +### id + +``` +InputDevIdentify InputDevAttr::id +``` + +**描述：** + +设备识别信息。 + +### axisInfo + +``` +InputDimensionInfo InputDevAttr::axisInfo[ABS_CNT]; +``` + +**描述：** + +设备维度信息。 \ 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 new file mode 100644 index 0000000000..5950fca754 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_input_dev_desc.md @@ -0,0 +1,51 @@ +# InputDevDesc + + +## **概述** + +**所属模块:** + +[Input](_input.md) + + +## **汇总** + + +### Public 属性 + + | Public 属性 | 描述 | +| -------- | -------- | +| [devIndex](#devindex) | 设备索引 | +| [devType](#devtype) | 设备类型 | + + +## **详细描述** + +Input设备描述信息。 + + +## **类成员变量说明** + + +### devIndex + + +``` +uint32_t InputHotPlugEvent::devIndex +``` + +**描述：** + +设备索引。 + + +### devType + + +``` +uint32_t InputHotPlugEvent::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 new file mode 100644 index 0000000000..8520f5f62c --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_input_dev_identify.md @@ -0,0 +1,69 @@ +# InputDevIdentify + + +## **概述** + +**所属模块:** + +[Input](_input.md) + + +## **汇总** + + +### Public 属性 + + | Public 属性 | 描述 | +| -------- | -------- | +| [busType](#bustype) | 总线类型 | +| [vendor](#vendor) | 生产商编号 | +| [product](#product) | 产品编号 | +| [fuzz](#version) | 版本号 | + +## **详细描述** + +Input设备的识别信息。 + + +## **类成员变量说明** + + +### busType + +``` +uint16_t InputDevIdentify::busType +``` + +**描述：** + +总线类型。 + +### vendor + +``` +uint16_t InputDevIdentify::vendor +``` + +**描述：** + +生产商编号。 + +### product + +``` +uint16_t InputDevIdentify::product +``` + +**描述：** + +产品编号。 + +### version + +``` +uint16_t InputDevIdentify::version +``` + +**描述：** + +版本号。 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 new file mode 100644 index 0000000000..bdbbdbd5d3 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_input_dimension_info.md @@ -0,0 +1,91 @@ +# InputDimensionInfo + + +## **概述** + +**所属模块:** + +[Input](_input.md) + + +## **汇总** + + +### Public 属性 + + | Public 属性 | 描述 | +| -------- | -------- | +| [axis](#axis) | 坐标轴 | +| [min](#min) | 记录各个坐标的最小值 | +| [max](#max) | 记录各个坐标的最大值 | +| [fuzz](#fuzz) | 记录各个坐标的分辨率 | +| [flat](#flat) | 记录各个坐标的基准值 | +| [range](#range) | 范围 | + +## **详细描述** + +Input设备的维度信息。 + + +## **类成员变量说明** + + +### axis + +``` +int32_t InputDimensionInfo::axis +``` + +**描述：** + +坐标轴。 + +### min + +``` +int32_t InputDimensionInfo::min +``` + +**描述：** + +记录各个坐标的最小值。 + +### max + +``` +int32_t InputDimensionInfo::max +``` + +**描述：** + +记录各个坐标的最大值。 + +### fuzz + +``` +int32_t InputDimensionInfo::fuzz +``` + +**描述：** + +记录各个坐标的分辨率。 + +### flat + +``` +int32_t InputDimensionInfo::flat +``` + +**描述：** + +记录各个坐标的基准值。 + +### range + +``` +int32_t InputDimensionInfo::range +``` + +**描述：** + +范围。 \ No newline at end of file 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 new file mode 100644 index 0000000000..372d6d7847 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_input_host_cb.md @@ -0,0 +1,44 @@ +# InputHostCb + + +## **概述** + +**所属模块:** + +[Input](_input.md) + + +## **汇总** + + +### Public 属性 + + | Public 属性 | 描述 | +| -------- | -------- | +| ( [HotPlugCallback](#hotplugcallback) ) (const [InputHotPlugEvent](_input_hotplug_event.md) \*event) | 热插拔事件上报的回调函数。 [更多...](#hotplugcallback) | + + +## **详细描述** + +此结构体定义了热插拔事件上报回调函数并提供给Input服务使用。 + + +## **类成员变量说明** + + +### HotPlugCallback + + +``` +void (* InputHostCb::HotPlugCallback) (const InputHotPlugEvent* event); +``` + +**描述：** + +热插拔事件上报的回调函数。 + +**参数：** + + | 名称 | 描述 | +| -------- | -------- | +| event | 输入参数，上报的热插拔事件数据。 | \ No newline at end of file diff --git a/zh-cn/device-dev/reference/hdi-apis/_input_hotplug_event.md b/zh-cn/device-dev/reference/hdi-apis/_input_hotplug_event.md new file mode 100644 index 0000000000..1bfe63ea8d --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_input_hotplug_event.md @@ -0,0 +1,66 @@ +# InputHotPlugEvent + + +## **概述** + +**所属模块:** + +[Input](_input.md) + + +## **汇总** + + +### Public 属性 + + | Public 属性 | 描述 | +| -------- | -------- | +| [devIndex](#devindex) | 设备索引 | +| [devType](#devtype) | 设备类型 | +| [status](#status) | 设备状态| + + +## **详细描述** + +热插拔事件数据包结构。 + + +## **类成员变量说明** + + +### devIndex + + +``` +uint32_t InputHotPlugEvent::devIndex +``` + +**描述：** + +设备索引。 + + +### devType + + +``` +uint32_t InputHotPlugEvent::devType +``` + +**描述：** + +设备类型。 + + +### status + + +``` +uint32_t InputHotPlugEvent::status +``` + +**描述：** + +设备状态。 +- 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 e1299baf01..a70e520d59 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_input_manager.md +++ b/zh-cn/device-dev/reference/hdi-apis/_input_manager.md @@ -15,18 +15,18 @@ | 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, [DeviceInfo](_device_info.md) \*\*devInfo) | input服务获取对应ID的设备信息 [更多...](#getinputdevice) | -| ( [GetInputDeviceList](#getinputdevicelist) )(uint32_t \*devNum, [DeviceInfo](_device_info.md) \*\*devList, uint32_t size) | input服务获取所有input设备列表的设备信息 [更多...](#getinputdevicelist) | +| ( [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, [DeviceInfo](_device_info.md) \*\*devInfo) | Input服务获取对应ID的设备信息 [更多...](#getinputdevice) | +| ( [GetInputDeviceList](#getinputdevicelist) )(uint32_t \*devNum, [DeviceInfo](_device_info.md) \*\*devList, uint32_t size) | Input服务获取所有Input设备列表的设备信息 [更多...](#getinputdevicelist) | ## **详细描述** -提供input设备管理相关的接口。 +提供Input设备管理相关的接口。 -此类接口包含input设备的扫描、打开和关闭、特定设备信息查询，以及所有设备列表信息获取等接口。 +此类接口包Input设备的扫描、打开和关闭、特定设备信息查询，以及所有设备列表信息获取等接口。 ## **类成员变量说明** @@ -41,70 +41,70 @@ int32_t(* InputManager::CloseInputDevice) (uint32_t devIndex) **描述：** -input服务关闭对应设备的设备文件 +Input服务关闭对应设备的设备文件。 **参数：** | 名称 | 描述 | | -------- | -------- | -| devIndex | Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备 | +| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。| **返回：** -Returns INPUT_SUCCESS 表示执行成功。 +INPUT_SUCCESS 表示执行成功。 -Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 +其他值表示执行失败，具体错误码查看**RetSatus**。 ### GetInputDevice ``` -int32_t(* InputManager::GetInputDevice) (uint32_t devIndex, DeviceInfo **devInfo) +int32_t(* InputManager::GetInputDevice) (uint32_t devIndex, InputDeviceInfo **devInfo) ``` **描述：** -input服务获取对应ID的设备信息。 +Input服务获取对应ID的设备信息。 **参数：** | 名称 | 描述 | | -------- | -------- | -| devIndex | Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。 | -| devInfo | 即devIndex对应设备的设备信息，具体参考**DeviceInfo**。 | +| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | +| devInfo | 输出参数，即devIndex对应的设备的设备信息，具体参考**DeviceInfo**。 | **返回：** -Returns INPUT_SUCCESS 表示执行成功。 +INPUT_SUCCESS 表示执行成功。 -Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 +其他值表示执行失败，具体错误码查看**RetSatus**。 ### GetInputDeviceList ``` -int32_t(* InputManager::GetInputDeviceList) (uint32_t *devNum, DeviceInfo **devList, uint32_t size) +int32_t(* InputManager::GetInputDeviceList) (uint32_t *devNum, InputDeviceInfo **devList, uint32_t size) ``` **描述：** -input服务获取所有input设备列表的设备信息。 +Input服务获取所有Input设备列表的设备信息。 **参数：** | 名称 | 描述 | | -------- | -------- | -| devNum | 当前已经注册过的所有input设备的总数。 | -| devInfo | input设备列表所对应的设备信息，具体参考**DeviceInfo**。 | -| size | 即指定deviceList数组对应的元素个数。 | +| devNum | 输出参数，当前已经注册过的所有Input设备的总数。 | +| devInfo | 输出参数，Input设备列表所对应的设备信息，具体参考**DeviceInfo**。 | +| size | 输入参数，即指定deviceList数组对应的元素个数。| 返回： -Returns INPUT_SUCCESS 表示执行成功。 +INPUT_SUCCESS 表示执行成功。 -Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 +其他值表示执行失败，具体错误码查看**RetSatus**。 ### OpenInputDevice @@ -116,41 +116,41 @@ int32_t(* InputManager::OpenInputDevice) (uint32_t devIndex) **描述：** -input服务打开对应设备的设备文件 +Input服务打开对应设备的设备文件。 **参数：** | 名称 | 描述 | | -------- | -------- | -| devIndex | Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。 | +| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | **返回：** -Returns INPUT_SUCCESS 表示执行成功。 +INPUT_SUCCESS 表示执行成功。 -Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 +其他值表示执行失败，具体错误码查看**RetSatus**。 ### ScanInputDevice ``` -int32_t(* InputManager::ScanInputDevice) (DevDesc *staArr, uint32_t arrLen) +int32_t(* InputManager::ScanInputDevice) (InputDevDesc *staArr, uint32_t arrLen) ``` **描述：** -input服务用于扫描所有在线设备。 +Input服务用于扫描所有在线设备。 **参数：** | 名称 | 描述 | | -------- | -------- | -| staArr | 存放Input设备扫描信息的数组，信息包含设备索引以及设备类型。 | -| arrLen | staArr数组的长度信息。 | +| staArr | 输出参数，存放Input设备扫描信息的数组，信息包含设备索引以及设备类型。 | +| arrLen | 输入参数，staArr数组的长度信息。 | **返回：** -Returns INPUT_SUCCESS 表示执行成功。 +INPUT_SUCCESS 表示执行成功。 -Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 +其他值表示执行失败，具体错误码查看**RetSatus**。 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 index ae16339487..b6dd937165 100644 --- 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 @@ -1,4 +1,4 @@ -# InputReportEventCb +# InputEventCb ## **概述** @@ -15,51 +15,33 @@ | Public 属性 | 描述 | | -------- | -------- | -| ( [ReportEventPkgCallback](#reporteventpkgcallback) )(const [EventPackage](_event_package.md) \*\*pkgs, uint32_t count, uint32_t devIndex) | 输入事件数据上报的回调函数 [更多...](#reporteventpkgcallback) | -| ( [ReportHotPlugEventCallback](#reporthotplugeventcallback) )(const HotPlugEvent \*event) | 热插拔事件上报的回调函数 [更多...](#reporthotplugeventcallback) | +| ( [EventPkgCallback](#eventpkgcallback) )(const [InputEventPackage](_event_package.md) \*\*pkgs, uint32_t count, uint32_t devIndex) | 输入事件数据上报的回调函数。 [更多...](#eventpkgcallback) | ## **详细描述** -此结构体定义了输入事件回调函数并提供给input服务使用。 +此结构体定义了输入事件回调函数并提供给Input服务使用。 ## **类成员变量说明** -### ReportEventPkgCallback +### EventPkgCallback ``` -void(* InputReportEventCb::ReportEventPkgCallback) (const EventPackage **pkgs, uint32_t count, uint32_t devIndex) +void (* InputEventCb::EventPkgCallback)(const InputEventPackage **pkgs, uint32_t count, uint32_t devIndex); ``` **描述：** -输入事件数据上报的回调函数 +输入事件数据上报的回调函数。 **参数：** | 名称 | 描述 | | -------- | -------- | -| eventData | 驱动上报的input事件数据。 | +| pkgs| 驱动上报的Input事件数据。 | | count | Input事件数据包的个数。 | -| devIndex | Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。 | +| devIndex | Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | - -### ReportHotPlugEventCallback - - -``` -void(* InputReportEventCb::ReportHotPlugEventCallback) (const HotPlugEvent *event) -``` - -**描述：** - -热插拔事件上报的回调函数 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| event | 上报的热插拔事件数据 | 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 fa80efaff1..cb5424095a 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_input_reporter.md +++ b/zh-cn/device-dev/reference/hdi-apis/_input_reporter.md @@ -15,17 +15,17 @@ | Public 属性 | 描述 | | -------- | -------- | -| ( [RegisterReportCallback](#registerreportcallback) )(uint32_t devIndex, [InputReportEventCb](_input_report_event_cb.md) \*callback) | 注册对应设备的回调函数 [更多...](#registerreportcallback) | -| ( [UnregisterReportCallback](#unregisterreportcallback) )(uint32_t devIndex) | 注销对应设备的回调函数 [更多...](#unregisterreportcallback) | -| ( [RegisterHotPlugCallback](#registerhotplugcallback) )([InputReportEventCb](_input_report_event_cb.md) \*callback) | 注册Input设备的热插拔回调函数 [更多...](#registerhotplugcallback) | -| ( [UnregisterHotPlugCallback](#unregisterhotplugcallback) )(void) | 注销Input设备的热插拔回调函数 [更多...](#unregisterhotplugcallback) | +| ( [RegisterReportCallback](#registerreportcallback) )(uint32_t devIndex, [InputHostCb](_input_report_event_cb.md) \*callback) | 注册对应设备的回调函数。 [更多...](#registerreportcallback) | +| ( [UnregisterReportCallback](#unregisterreportcallback) )(uint32_t devIndex) | 注销对应设备的回调函数。 [更多...](#unregisterreportcallback) | +| ( [RegisterHotPlugCallback](#registerhotplugcallback) )([InputHostCb](_input_report_event_cb.md) \*callback) | 注册Input设备的热插拔回调函数。 [更多...](#registerhotplugcallback) | +| ( [UnregisterHotPlugCallback](#unregisterhotplugcallback) )(void) | 注销Input设备的热插拔回调函数。 [更多...](#unregisterhotplugcallback) | ## **详细描述** -提供input设备数据上报相关的接口。 +提供Input设备数据上报相关的接口。 -此类接口包含input设备的数据上报回调函数的注册和注销。 +此类接口包含Input设备的数据上报回调函数的注册和注销。 ## **类成员变量说明** @@ -35,53 +35,53 @@ ``` -int32_t(* InputReporter::RegisterHotPlugCallback) (InputReportEventCb *callback) +int32_t(* InputReporter::RegisterHotPlugCallback) (InputHostCb *callback) ``` **描述：** -注册Input设备的热插拔回调函数 +注册Input设备的热插拔回调函数。 -input服务通过此接口注册回调函数到hdi中，所有Input设备由此函数进行热插拔事件上报 +Input服务通过此接口注册回调函数到hdi中，所有Input设备由此函数进行热插拔事件上报。 **参数：** | 名称 | 描述 | | -------- | -------- | -| callback | 回调函数的函数指针 | +| callback | 输入参数，回调函数的函数指针。 | **返回：** -Returns INPUT_SUCCESS 表示执行成功。 +INPUT_SUCCESS 表示执行成功。 -Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 +其他值表示执行失败，具体错误码查看**RetSatus**。 ### RegisterReportCallback ``` -int32_t(* InputReporter::RegisterReportCallback) (uint32_t devIndex, InputReportEventCb *callback) +int32_t(* InputReporter::RegisterReportCallback) (uint32_t devIndex, InputEventCb *callback) ``` **描述：** -注册对应设备的回调函数 +注册对应设备的回调函数。 -input服务通过此接口注册数据回调函数到hdi中，hdi通过此回调函数上报input事件 +Input服务通过此接口注册数据回调函数到hdi中，hdi通过此回调函数上报Input事件。 **参数：** | 名称 | 描述 | | -------- | -------- | -| devIndex | Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备 | -| callback | 回调函数的函数指针 | +| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | +| callback | 输入参数，回调函数的函数指针。 | **返回：** -Returns INPUT_SUCCESS 表示执行成功。 +INPUT_SUCCESS 表示执行成功。 -Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 +其他值表示执行失败，具体错误码查看**RetSatus**。 ### UnregisterHotPlugCallback @@ -93,19 +93,13 @@ int32_t(* InputReporter::UnregisterHotPlugCallback) (void) **描述：** -注销Input设备的热插拔回调函数 - -**参数：** - - | 名称 | 描述 | -| -------- | -------- | -| 无 | - | +注销Input设备的热插拔回调函数。 **返回：** -Returns INPUT_SUCCESS 表示执行成功。 +INPUT_SUCCESS 表示执行成功。 -Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 +其他值表示执行失败，具体错误码查看**RetSatus**。 ### UnregisterReportCallback @@ -117,16 +111,16 @@ int32_t(* InputReporter::UnregisterReportCallback) (uint32_t devIndex) **描述：** -注销对应设备的回调函数 +注销对应设备的回调函数。 **参数：** | 名称 | 描述 | | -------- | -------- | -| devIndex | Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备 | +| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。| **返回：** -Returns INPUT_SUCCESS 表示执行成功。 +INPUT_SUCCESS 表示执行成功。 -Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 +其他值表示执行失败，具体错误码查看**RetSatus**。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_light_effect.md b/zh-cn/device-dev/reference/hdi-apis/_light_effect.md index 7dd78f2c3e..63a331afec 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_light_effect.md +++ b/zh-cn/device-dev/reference/hdi-apis/_light_effect.md @@ -13,10 +13,10 @@ ### Public 属性 - | Public 属性 | 描述 | +| Public 属性 | 描述 | | -------- | -------- | -| [lightBrightness](#lightbrightness) | 亮度值。 | -| [flashEffect](#flasheffect) | 闪烁模式。 | +| [lightBrightness](#lightbrightness) | 亮度值。 | +| [flashEffect](#flasheffect) | 闪烁模式。 | ## **详细描述** @@ -35,7 +35,7 @@ ### flashEffect - + ``` struct LightFlashEffect LightEffect::flashEffect ``` @@ -47,11 +47,11 @@ struct LightFlashEffect LightEffect::flashEffect ### lightBrightness - + ``` int32_t LightEffect::lightBrightness ``` **描述：** -亮度值：Bits 24–31为扩展位，Bits 16–23为红色，bits 8–15为绿色，bits 0–7为蓝色。 如果字节段不等于0，指示打开相应颜色的灯。 +亮度值：Bits 24–31为扩展位，Bits 16–23为红色，Bits 8–15为绿色，Bits 0–7为蓝色。 如果相对应的字节段不等于0，表示打开相应颜色的灯。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_light_interface.md b/zh-cn/device-dev/reference/hdi-apis/_light_interface.md index 2c966f0a5e..9621d96fb1 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_light_interface.md +++ b/zh-cn/device-dev/reference/hdi-apis/_light_interface.md @@ -13,18 +13,18 @@ ### Public 属性 - | 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](#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) | ## **详细描述** 定义可以在灯上执行的基本操作。 -操作包括获取灯的信息、打开或关闭灯、设置灯的亮度或闪烁模式。 +操作包括获取灯的信息、打开或关闭灯、设置灯的亮度和闪烁模式。 ## **类成员变量说明** @@ -32,7 +32,7 @@ ### GetLightInfo - + ``` int32_t(* LightInterface::GetLightInfo) ([out] struct LightInfo **lightInfo,[out] uint32_t *count) ``` @@ -43,10 +43,10 @@ int32_t(* LightInterface::GetLightInfo) ([out] struct LightInfo **lightInfo,[out **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| lightInfo | 表示指向灯信息的二级指针，详见[LightInfo](_light_info.md)。 | -| count | 表示指向灯数量的指针。 | +| lightInfo | 表示指向灯信息的二级指针，详见[LightInfo](_light_info.md)。 | +| count | 表示指向灯数量的指针。 | **返回：** @@ -57,7 +57,7 @@ int32_t(* LightInterface::GetLightInfo) ([out] struct LightInfo **lightInfo,[out ### TurnOffLight - + ``` int32_t(* LightInterface::TurnOffLight) ([in] uint32_t lightId) ``` @@ -68,9 +68,9 @@ int32_t(* LightInterface::TurnOffLight) ([in] uint32_t lightId) **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| lightId | 表示灯ID，详见[LightId](_light.md#lightid)。 | +| lightId | 表示灯ID，详见[LightId](_light.md#lightid)。 | **返回：** @@ -81,7 +81,7 @@ int32_t(* LightInterface::TurnOffLight) ([in] uint32_t lightId) ### TurnOnLight - + ``` int32_t(* LightInterface::TurnOnLight) ([in] uint32_t lightId,[in] struct LightEffect *effect) ``` @@ -92,10 +92,10 @@ int32_t(* LightInterface::TurnOnLight) ([in] uint32_t lightId,[in] struct LightE **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| lightId | 表示灯ID，详见[LightId](_light.md#lightid)。 | -| effect | 表示指向灯效果的指针，如果lightbrightness字段为0时， 灯的亮度根据HCS配置的默认亮度进行设置，详见[LightEffect](_light_effect.md)。 | +| lightId | 表示灯ID，详见[LightId](_light.md#lightid)。 | +| effect | 表示指向灯效果的指针，如果lightbrightness字段为0时， 灯的亮度根据HCS配置的默认亮度进行设置，详见[LightEffect](_light_effect.md)。 | **返回：** @@ -105,4 +105,5 @@ int32_t(* LightInterface::TurnOnLight) ([in] uint32_t lightId,[in] struct LightE 如果不支持闪烁设置，则返回-2。 -如果不支持亮度设置，则返回3。 +如果不支持亮度设置，则返回-3。 + 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 index f53374d6fe..c576768593 100644 --- 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 @@ -23,6 +23,13 @@ | [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_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 index d20a86b90e..ed579509cd 100644 --- 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 @@ -54,4 +54,9 @@ | 静态 Public 成员函数 | 描述 | | -------- | -------- | -| **GetInstance** () | 获取实例。 | +| [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 index eb3e0c18fd..5704333824 100644 --- 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 @@ -18,3 +18,24 @@ | [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/_sensor.md b/zh-cn/device-dev/reference/hdi-apis/_sensor.md index 2cdb5edfed..8af61d4b6a 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_sensor.md +++ b/zh-cn/device-dev/reference/hdi-apis/_sensor.md @@ -6,61 +6,61 @@ ### 文件 - | 文件 | 描述 | +| 文件 | 描述 | | -------- | -------- | -| [sensor_if.h](sensor__if_8h.md) | Sensor模块对外通用的接口声明文件，提供获取传感器设备信息、订阅/去订阅传感器数据、 使能/去使能传感器、设置传感器模式、设置传感器精度，量程等可选配置接口定义。 | -| [sensor_type.h](sensor__type_8h.md) | 定义传感器模块所使用的传感器类型，传感器信息，传感器数据结构等数据类型。 | +| [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) | +| [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](#sensornamemaxlen)   32 | Sensor名称的最大长度。 | -| [SENSOR_VERSION_MAX_LEN](#sensorversionmaxlen)   16 | Sensor版本号的最大长度。 | +| [SENSOR_NAME_MAX_LEN](#sensornamemaxlen)   32 | Sensor名称的最大长度。 | +| [SENSOR_VERSION_MAX_LEN](#sensorversionmaxlen)   16 | Sensor版本号的最大长度。 | ### 类型定义 - | 类型定义 | 描述 | +| 类型定义 | 描述 | | -------- | -------- | -| ([RecordDataCallback](#recorddatacallback)) (const struct [SensorEvents](_sensor_events.md) \*) | 传感器上报数据回调函数的定义，传感器服务用户在订阅传感器时， 需要注册上报数据回调函数，传感器使能后，传感器服务用户可以接受到传感器数据，详见[SensorInterface](_sensor_interface.md)。 [更多...](#recorddatacallback) | +| ([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) | +| [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) | +| [NewSensorInterfaceInstance](#newsensorinterfaceinstance) (void) | 创建传感器接口实例。 [更多...](#newsensorinterfaceinstance) | +| [FreeSensorInterfaceInstance](#freesensorinterfaceinstance) (void) | 释放传感器接口实例。 [更多...](#freesensorinterfaceinstance) | ## **详细描述** 传感器设备驱动对传感器服务提供通用的接口能力。 -模块提供传感器服务对传感器驱动访问统一接口，服务获取驱动对象或者代理后， 通过其提供的各类方法，以传感器id区分访问不同类型传感器设备，实现获取传感器设备信息、订阅/去订阅传感器数据、 使能/去使能传感器、设置传感器模式、设置传感器精度、量程等可选配置等。 +模块提供传感器服务对传感器驱动访问统一接口，服务获取驱动对象或者代理后， 通过其提供的各类方法，以传感器id区分访问不同类型传感器设备，实现获取传感器设备信息、订阅/取消订阅传感器数据、 使能/去使能传感器、设置传感器模式、设置传感器精度、量程等可选配置等。 **Since：** @@ -76,7 +76,7 @@ ### SENSOR_NAME_MAX_LEN - + ``` #define SENSOR_NAME_MAX_LEN 32 ``` @@ -88,7 +88,7 @@ Sensor名称的最大长度。 ### SENSOR_VERSION_MAX_LEN - + ``` #define SENSOR_VERSION_MAX_LEN 16 ``` @@ -103,7 +103,7 @@ Sensor版本号的最大长度。 ### RecordDataCallback - + ``` typedef int32_t(* RecordDataCallback) (const struct SensorEvents *) ``` @@ -118,7 +118,7 @@ typedef int32_t(* RecordDataCallback) (const struct SensorEvents *) ### SensorAccuracyType - + ``` enum SensorAccuracyType ``` @@ -127,18 +127,18 @@ enum SensorAccuracyType 传感器的精度类型。 - | 枚举值 | 描述 | +| 枚举值 | 描述 | | -------- | -------- | -| SENSOR_NO_ACCURACY | 无精度类型。 | -| SENSOR_LOW_ACCURACY | 低精度类型。 | -| SENSOR_MEDIUM_ACCURACY | 中等精度类型。 | -| SENSOR_HIGH_ACCURACY | 高精度类型。 | -| SENSOR_MAX_ACCURACY | 最大精度类型。 | +| SENSOR_NO_ACCURACY | 无精度类型。 | +| SENSOR_LOW_ACCURACY | 低精度类型。 | +| SENSOR_MEDIUM_ACCURACY | 中等精度类型。 | +| SENSOR_HIGH_ACCURACY | 高精度类型。 | +| SENSOR_MAX_ACCURACY | 最大精度类型。 | ### SensorGroupType - + ``` enum SensorGroupType ``` @@ -147,16 +147,16 @@ enum SensorGroupType 枚举传感器的硬件服务组。 - | 枚举值 | 描述 | +| 枚举值 | 描述 | | -------- | -------- | -| TRADITIONAL_SENSOR_TYPE | 传统传感器类型，传感器ID枚举值范围为128-160。 | -| MEDICAL_SENSOR_TYPE | 医疗传感器类型，传感器ID枚举值范围不在128-160之间。 | -| SENSOR_GROUP_TYPE_MAX | 最大传感器类型。 | +| TRADITIONAL_SENSOR_TYPE | 传统传感器类型，传感器ID枚举值范围为128-160。 | +| MEDICAL_SENSOR_TYPE | 医疗传感器类型，传感器ID枚举值范围不在128-160之间。 | +| SENSOR_GROUP_TYPE_MAX | 最大传感器类型。 | ### SensorModeType - + ``` enum SensorModeType ``` @@ -165,19 +165,19 @@ enum SensorModeType 传感器的工作模式。 - | 枚举值 | 描述 | +| 枚举值 | 描述 | | -------- | -------- | -| SENSOR_MODE_DEFAULT | 传感器默认工作模式状态。 | -| SENSOR_MODE_REALTIME | 传感器实时工作模式状态，一组数据上报一次。 | -| SENSOR_MODE_ON_CHANGE | 传感器实时工作模式状态，状态变更上报一次。 | -| SENSOR_MODE_ONE_SHOT | 传感器实时工作模式状态，只上报一次。 | -| SENSOR_MODE_FIFO_MODE | 传感器缓存工作模式状态，根据配置的缓存大小上报。 | -| SENSOR_MODE_MAX | 传感器最大类型标识。 | +| SENSOR_MODE_DEFAULT | 传感器默认工作模式状态。 | +| SENSOR_MODE_REALTIME | 传感器实时工作模式状态，一组数据上报一次。 | +| SENSOR_MODE_ON_CHANGE | 传感器实时工作模式状态，状态变更上报一次。 | +| SENSOR_MODE_ONE_SHOT | 传感器实时工作模式状态，只上报一次。 | +| SENSOR_MODE_FIFO_MODE | 传感器缓存工作模式状态，根据配置的缓存大小上报。 | +| SENSOR_MODE_MAX | 传感器最大类型标识。 | ### SensorRangeType - + ``` enum SensorRangeType ``` @@ -186,17 +186,17 @@ enum SensorRangeType 传感器的量程级别。 - | 枚举值 | 描述 | +| 枚举值 | 描述 | | -------- | -------- | -| SENSOR_RANGE_LEVEL1 | 量程级别1。 | -| SENSOR_RANGE_LEVEL2 | 量程级别2。 | -| SENSOR_RANGE_LEVEL3 | 量程级别3。 | -| SENSOR_RANGE_LEVEL_MAX | 量程最大级别。 | +| SENSOR_RANGE_LEVEL1 | 量程级别1。 | +| SENSOR_RANGE_LEVEL2 | 量程级别2。 | +| SENSOR_RANGE_LEVEL3 | 量程级别3。 | +| SENSOR_RANGE_LEVEL_MAX | 量程最大级别。 | ### SensorStatus - + ``` enum SensorStatus ``` @@ -205,19 +205,19 @@ enum SensorStatus 定义传感器模块返回值类型。 - | 枚举值 | 描述 | +| 枚举值 | 描述 | | -------- | -------- | -| SENSOR_SUCCESS | 传感器执行成功。 | -| SENSOR_FAILURE | 传感器执行失败。 | -| SENSOR_NOT_SUPPORT | 传感器不支持。 | -| SENSOR_INVALID_PARAM | 传感器无效参数。 | -| SENSOR_INVALID_SERVICE | 传感器无效服务。 | -| SENSOR_NULL_PTR | 传感器空指针。 | +| SENSOR_SUCCESS | 传感器执行成功。 | +| SENSOR_FAILURE | 传感器执行失败。 | +| SENSOR_NOT_SUPPORT | 传感器不支持。 | +| SENSOR_INVALID_PARAM | 传感器无效参数。 | +| SENSOR_INVALID_SERVICE | 传感器无效服务。 | +| SENSOR_NULL_PTR | 传感器空指针。 | ### SensorTypeTag - + ``` enum SensorTypeTag ``` @@ -226,42 +226,42 @@ 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 | 传感器类型最大个数标识。 | +| 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 | 传感器类型最大个数标识。 | ## **函数说明** @@ -269,7 +269,7 @@ enum SensorTypeTag ### FreeSensorInterfaceInstance() - + ``` int32_t FreeSensorInterfaceInstance (void ) ``` @@ -295,7 +295,7 @@ int32_t FreeSensorInterfaceInstance (void ) ### NewSensorInterfaceInstance() - + ``` const struct SensorInterface* NewSensorInterfaceInstance (void ) ``` @@ -306,10 +306,10 @@ const struct SensorInterface* NewSensorInterfaceInstance (void ) **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| sensorId | 表示传感器ID。有关详细信息，详见[SensorTypeTag](#sensortypetag)。 | -| cb | 表示要注册的回调函数。有关详细信息，详见[RecordDataCallback](#recorddatacallback)。 | +| sensorId | 表示传感器ID。有关详细信息，详见[SensorTypeTag](#sensortypetag)。 | +| cb | 表示要注册的回调函数。有关详细信息，详见[RecordDataCallback](#recorddatacallback)。 | **返回：** diff --git a/zh-cn/device-dev/reference/hdi-apis/_sensor_information.md b/zh-cn/device-dev/reference/hdi-apis/_sensor_information.md index f3c35206a6..083c23aab8 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_sensor_information.md +++ b/zh-cn/device-dev/reference/hdi-apis/_sensor_information.md @@ -13,17 +13,17 @@ ### Public 属性 - | 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) | 传感器的功耗。 | +| [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) | 传感器的功耗。 | ## **详细描述** @@ -42,7 +42,7 @@ ### accuracy - + ``` float SensorInformation::accuracy ``` @@ -54,7 +54,7 @@ float SensorInformation::accuracy ### firmwareVersion - + ``` char SensorInformation::firmwareVersion[SENSOR_VERSION_MAX_LEN] ``` @@ -66,7 +66,7 @@ char SensorInformation::firmwareVersion[SENSOR_VERSION_MAX_LEN] ### hardwareVersion - + ``` char SensorInformation::hardwareVersion[SENSOR_VERSION_MAX_LEN] ``` @@ -78,7 +78,7 @@ char SensorInformation::hardwareVersion[SENSOR_VERSION_MAX_LEN] ### maxRange - + ``` float SensorInformation::maxRange ``` @@ -90,19 +90,19 @@ float SensorInformation::maxRange ### sensorId - + ``` int32_t SensorInformation::sensorId ``` **描述：** -传感器的标识号，有传感器驱动开发者定义。 +传感器的标识号，由传感器驱动开发者定义。 ### sensorName - + ``` char SensorInformation::sensorName[SENSOR_NAME_MAX_LEN] ``` @@ -114,7 +114,7 @@ char SensorInformation::sensorName[SENSOR_NAME_MAX_LEN] ### sensorTypeId - + ``` int32_t SensorInformation::sensorTypeId ``` @@ -126,7 +126,7 @@ int32_t SensorInformation::sensorTypeId ### vendorName - + ``` char SensorInformation::vendorName[SENSOR_NAME_MAX_LEN] ``` @@ -138,7 +138,7 @@ 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 index cc24e3a087..a6c64a9af3 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_sensor_interface.md +++ b/zh-cn/device-dev/reference/hdi-apis/_sensor_interface.md @@ -13,23 +13,23 @@ ### Public 属性 - | 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) | +| ( [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设备基本控制操作接口。 -结构体提供获取传感器设备信息、订阅/去订阅传感器数据、使能/去使能传感器、设置传感器模式、设置传感器精度、量程等可选配置接口定义。 +结构体提供获取传感器设备信息、订阅/取消订阅传感器数据、使能/去使能传感器、设置传感器模式、设置传感器精度、量程等可选配置接口定义。 ## **类成员变量说明** @@ -37,7 +37,7 @@ ### Disable - + ``` int32_t(* SensorInterface::Disable) ([in] int32_t sensorId) ``` @@ -48,9 +48,9 @@ int32_t(* SensorInterface::Disable) ([in] int32_t sensorId) **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| sensorId | 唯一标识一个传感器设备类型，详见[SensorTypeTag](_sensor.md#sensortypetag)。 | +| sensorId | 唯一标识一个传感器设备类型，详见[SensorTypeTag](_sensor.md#sensortypetag)。 | **返回：** @@ -61,7 +61,7 @@ int32_t(* SensorInterface::Disable) ([in] int32_t sensorId) ### Enable - + ``` int32_t(* SensorInterface::Enable) ([in] int32_t sensorId) ``` @@ -72,9 +72,9 @@ int32_t(* SensorInterface::Enable) ([in] int32_t sensorId) **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| sensorId | 唯一标识一个传感器设备类型，详见[SensorTypeTag](_sensor.md#sensortypetag)。 | +| sensorId | 唯一标识一个传感器设备类型，详见[SensorTypeTag](_sensor.md#sensortypetag)。 | **返回：** @@ -85,7 +85,7 @@ int32_t(* SensorInterface::Enable) ([in] int32_t sensorId) ### GetAllSensors - + ``` int32_t(* SensorInterface::GetAllSensors) ([out] struct SensorInformation **sensorInfo,[out] int32_t *count) ``` @@ -96,10 +96,10 @@ int32_t(* SensorInterface::GetAllSensors) ([out] struct SensorInformation **sens **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| sensorInfo | 输出系统中注册的所有传感器信息，一种类型传感器信息包括传感器名字、设备厂商、 固件版本号、硬件版本号、传感器类型编号、传感器标识、最大量程、精度、功耗，详见[SensorInformation](_sensor_information.md)。 | -| count | 输出系统中注册的传感器数量。 | +| sensorInfo | 输出系统中注册的所有传感器信息，一种类型传感器信息包括传感器名字、设备厂商、 固件版本号、硬件版本号、传感器类型编号、传感器标识、最大量程、精度、功耗，详见[SensorInformation](_sensor_information.md)。 | +| count | 输出系统中注册的传感器数量。 | **返回：** @@ -110,7 +110,7 @@ int32_t(* SensorInterface::GetAllSensors) ([out] struct SensorInformation **sens ### Register - + ``` int32_t(* SensorInterface::Register) ([in] int32_t groupId,[in] RecordDataCallback cb) ``` @@ -121,10 +121,10 @@ int32_t(* SensorInterface::Register) ([in] int32_t groupId,[in] RecordDataCallba **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| groupId | 传感器组ID。 sensorId枚举值范围为128-160，表示已订阅医疗传感器服务，只需成功订阅一次，无需重复订阅。 sensorId枚举值范围不在128-160之间，这意味着传统传感器已订阅，只需成功订阅一次，无需重复订阅。 | -| cb | 要注册的回调函数，详见[RecordDataCallback](_sensor.md#recorddatacallback)。 | +| groupId | 传感器组ID。 sensorId枚举值范围为128-160，表示已订阅医疗传感器服务，只需成功订阅一次，无需重复订阅。 sensorId枚举值范围不在128-160之间，这意味着传统传感器已订阅，只需成功订阅一次，无需重复订阅。 | +| cb | 要注册的回调函数，详见[RecordDataCallback](_sensor.md#recorddatacallback)。 | **返回：** @@ -135,7 +135,7 @@ int32_t(* SensorInterface::Register) ([in] int32_t groupId,[in] RecordDataCallba ### SetBatch - + ``` int32_t(* SensorInterface::SetBatch) ([in] int32_t sensorId,[in] int64_t samplingInterval,[in] int64_t reportInterval) ``` @@ -146,11 +146,11 @@ int32_t(* SensorInterface::SetBatch) ([in] int32_t sensorId,[in] int64_t samplin **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| sensorId | 唯一标识一个传感器设备类型，详见[SensorTypeTag](_sensor.md#sensortypetag)。 | -| samplingInterval | 设置指定传感器的数据采样间隔，单位纳秒。 | -| reportInterval | 表示传感器数据上报间隔，单位纳秒。 | +| sensorId | 唯一标识一个传感器设备类型，详见[SensorTypeTag](_sensor.md#sensortypetag)。 | +| samplingInterval | 设置指定传感器的数据采样间隔，单位纳秒。 | +| reportInterval | 表示传感器数据上报间隔，单位纳秒。 | **返回：** @@ -161,7 +161,7 @@ int32_t(* SensorInterface::SetBatch) ([in] int32_t sensorId,[in] int64_t samplin ### SetMode - + ``` int32_t(* SensorInterface::SetMode) ([in] int32_t sensorId,[in] int32_t mode) ``` @@ -172,10 +172,10 @@ int32_t(* SensorInterface::SetMode) ([in] int32_t sensorId,[in] int32_t mode) **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| sensorId | 唯一标识一个传感器设备类型，详见[SensorTypeTag](_sensor.md#sensortypetag)。 | -| mode | 传感器的数据上报模式，详见[SensorModeType](_sensor.md#sensormodetype)。 | +| sensorId | 唯一标识一个传感器设备类型，详见[SensorTypeTag](_sensor.md#sensortypetag)。 | +| mode | 传感器的数据上报模式，详见[SensorModeType](_sensor.md#sensormodetype)。 | **返回：** @@ -186,7 +186,7 @@ int32_t(* SensorInterface::SetMode) ([in] int32_t sensorId,[in] int32_t mode) ### SetOption - + ``` int32_t(* SensorInterface::SetOption) ([in] int32_t sensorId,[in] uint32_t option) ``` @@ -197,10 +197,10 @@ int32_t(* SensorInterface::SetOption) ([in] int32_t sensorId,[in] uint32_t optio **参数：** - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| sensorId | 唯一标识一个传感器设备类型，详见[SensorTypeTag](_sensor.md#sensortypetag)。 | -| option | 传感器的量程、精度等配置。 | +| sensorId | 唯一标识一个传感器设备类型，详见[SensorTypeTag](_sensor.md#sensortypetag)。 | +| option | 传感器的量程、精度等配置。 | **返回：** @@ -211,21 +211,21 @@ int32_t(* SensorInterface::SetOption) ([in] int32_t sensorId,[in] uint32_t optio ### 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)。 | +| groupId | 传感器组ID。 sensorId枚举值范围为128-160，表示已订阅医疗传感器服务。只需成功取消订阅一次，无需重复取消订阅。 sensorId枚举值范围不在128-160之间，这意味着传统传感器已订阅。并且成功取消订阅。 | +| cb | 要取消注册的回调函数，详见[RecordDataCallback](_sensor.md#recorddatacallback)。 | **返回：** 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 index 451ef796db..3753bc9918 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_u_s_b.md +++ b/zh-cn/device-dev/reference/hdi-apis/_u_s_b.md @@ -31,7 +31,16 @@ | 宏定义 | 描述 | | -------- | -------- | -| [USB_MAX_INTERFACES](#usbmaxinterfaces)   32 | USB设备最大接口数量。 | +| [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从主机到设备的数据方向。 | ### 类型定义 @@ -59,7 +68,7 @@ | [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** () | 获取实例。 | +| [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) | @@ -96,6 +105,8 @@ | [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) | ### 变量 @@ -114,6 +125,7 @@ | [OHOS::USB::UsbCtrlTransfer::value](#value) | 请求值 | | [OHOS::USB::UsbCtrlTransfer::index](#index) | 索引 | | [OHOS::USB::UsbCtrlTransfer::timeout](#timeout) | 超时时间 | +| [OHOS::USB::UsbInfo::devInfo](#devinfo ) | USB设备信息 | ## **详细描述** @@ -146,6 +158,40 @@ 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从主机到设备的数据方向 + + ## **类型定义说明** @@ -1055,6 +1101,75 @@ int32_t OHOS::USB::UsbdClient::OpenDevice (const UsbDev & dev) 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() @@ -1570,6 +1685,25 @@ int32_t OHOS::USB::UsbdClient::UnRegBulkCallback (const UsbDev & dev, const UsbP 1.0 +### GetInstance() + + +``` +OHOS::USB::UsbdClient::GetInstance() +``` + +**描述：** + +获取实例。 + +**Since：** + +3.0 + +**Version：** + +1.0 + ## **变量说明** @@ -1609,6 +1743,17 @@ uint8_t OHOS::USB::UsbDev::devAddr USB设备地址 +### devInfo + + +``` +OHOS::USB::UsbInfo devInfo +``` + +**描述：** + +USB设备信息 + ### devNum 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 a017cbea7b..fe89671560 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 @@ -35,6 +35,7 @@ | [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) | ### 变量 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 8329743362..1687cb06bf 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 @@ -46,27 +46,27 @@ ### 枚举 - | 枚举 | 枚举 | 描述 | -| -------- | -------- | -------- | -| [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 } | [DispErrCode](_display.md#disperrcode) {   [DISPLAY_SUCCESS](_display.md#gga12a925dadef7573cd74d63d06824f9b0a188daac95e787159d50ff9546536035b) = 0, [DISPLAY_FAILURE](_display.md#gga12a925dadef7573cd74d63d06824f9b0afdffc20c71fb142c3e7f01323a31d742) = -1, [DISPLAY_FD_ERR](_display.md#gga12a925dadef7573cd74d63d06824f9b0a5bdb0a826a652f51e6c82685ae08ede8) = -2, [DISPLAY_PARAM_ERR](_display.md#gga12a925dadef7573cd74d63d06824f9b0a330e09be303bc7056f6115830bbd2370) = -3,   [DISPLAY_NULL_PTR](_display.md#gga12a925dadef7573cd74d63d06824f9b0a82fbcdba6c699059bc04b491c92424ac) = -4, [DISPLAY_NOT_SUPPORT](_display.md#gga12a925dadef7573cd74d63d06824f9b0a950a7bc41e893450315da9e73208f8c2) = -5, [DISPLAY_NOMEM](_display.md#gga12a925dadef7573cd74d63d06824f9b0af186ab511133fa3280c54d2c44358882) = -6, [DISPLAY_SYS_BUSY](_display.md#gga12a925dadef7573cd74d63d06824f9b0ac11b678fc04745ff4d91f4398b83c427) = -7,   [DISPLAY_NOT_PERM](_display.md#gga12a925dadef7573cd74d63d06824f9b0ad133674b9f3b857a12791479aaf58cf8) = -8 } | 返回值类型定义。 [更多...](_display.md#disperrcode) | -| [LayerType](_display.md#layertype) { LAYER_TYPE_GRAPHIC, LAYER_TYPE_OVERLAY, LAYER_TYPE_SDIEBAND, LAYER_TYPE_CURSOR,   LAYER_TYPE_BUTT } | [LayerType](_display.md#layertype) {   [LAYER_TYPE_GRAPHIC](_display.md#gga56943a0946e5f15e5e58054b8e7a04a4a6ef157ea82a5d4c1715b3cddcca38d6f), [LAYER_TYPE_OVERLAY](_display.md#gga56943a0946e5f15e5e58054b8e7a04a4ac33e449941bc0e4d039b4b5bed853a78), [LAYER_TYPE_SDIEBAND](_display.md#gga56943a0946e5f15e5e58054b8e7a04a4a0aef2c460a206fa00c742219d65be477), [LAYER_TYPE_CURSOR](_display.md#gga56943a0946e5f15e5e58054b8e7a04a4a44b3a657e6bf4f1f5709c03a94a11019),   [LAYER_TYPE_BUTT](_display.md#gga56943a0946e5f15e5e58054b8e7a04a4acd813c5ad9a2be97c85a97d4bdf1cb57) } | 图层类型定义。 [更多...](_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) } | {[HBM_USE_CPU_READ](_display.md#ggadf764cbdea00d65edcd07bb9953ad2b7a9bb139ab93fcaceac48e52bac1be53dc) = (1 << 0), [HBM_USE_CPU_WRITE](_display.md#ggadf764cbdea00d65edcd07bb9953ad2b7a29217cbafbb6666fe1e8d96f3c368a4d) = (1 << 1), [HBM_USE_MEM_MMZ](_display.md#ggadf764cbdea00d65edcd07bb9953ad2b7a9126b10e53b48304a5d9c351b1ace6d4) = (1 << 2), [HBM_USE_MEM_DMA](_display.md#ggadf764cbdea00d65edcd07bb9953ad2b7af7d33fd75c60375bef211629ff02d8c4) = (1 << 3),   [HBM_USE_MEM_SHARE](_display.md#ggadf764cbdea00d65edcd07bb9953ad2b7a16042b501b66017d663c3f5bcd24a20f) = (1 << 4), [HBM_USE_MEM_MMZ_CACHE](_display.md#ggadf764cbdea00d65edcd07bb9953ad2b7a553664654199ebde6733a830cbe0a369) = (1 << 5), [HBM_USE_MEM_FB](_display.md#ggadf764cbdea00d65edcd07bb9953ad2b7a110b955655861ef11167e907be5f18fc) = (1 << 6), [HBM_USE_ASSIGN_SIZE](_display.md#ggadf764cbdea00d65edcd07bb9953ad2b7a44d0fd6e88dbbe9e78c44cc8e5bddc22) = (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 } | [PixelFormat](_display.md#pixelformat) {   [PIXEL_FMT_CLUT8](_display.md#gga60883d4958a60b91661e97027a85072aabdea255b6e5f2920977f11d21445b34a) = 0, [PIXEL_FMT_CLUT1](_display.md#gga60883d4958a60b91661e97027a85072aa5740c66a546552c0c5a4bc06850af584), [PIXEL_FMT_CLUT4](_display.md#gga60883d4958a60b91661e97027a85072aabde13e8f357e39981973929309bb0e0e), [PIXEL_FMT_RGB_565](_display.md#gga60883d4958a60b91661e97027a85072aa5fae320872be3ffdda0d371cec048ec6),   [PIXEL_FMT_RGBA_5658](_display.md#gga60883d4958a60b91661e97027a85072aa4c16147153b63d7ba71b257111afdd62), [PIXEL_FMT_RGBX_4444](_display.md#gga60883d4958a60b91661e97027a85072aaa479ac0d983fde9b4f7f0e1a3b3e230f), [PIXEL_FMT_RGBA_4444](_display.md#gga60883d4958a60b91661e97027a85072aacbb91256e8c45a51410a9f6caae2d04c), [PIXEL_FMT_RGB_444](_display.md#gga60883d4958a60b91661e97027a85072aa7d18a83da06902c104208031ed487942),   [PIXEL_FMT_RGBX_5551](_display.md#gga60883d4958a60b91661e97027a85072aa85e5dd1a0e547c0031baffd02abb31a0), [PIXEL_FMT_RGBA_5551](_display.md#gga60883d4958a60b91661e97027a85072aadc1387526a271d8c6db7729de06474b1), [PIXEL_FMT_RGB_555](_display.md#gga60883d4958a60b91661e97027a85072aa720a429fa57133f6e27ef8c8fa1c404a), [PIXEL_FMT_RGBX_8888](_display.md#gga60883d4958a60b91661e97027a85072aa24a7181b7fb4019e7c19739bd9b65ff0),   [PIXEL_FMT_RGBA_8888](_display.md#gga60883d4958a60b91661e97027a85072aa90b462672221691ed66cacb07dd2e05f), [PIXEL_FMT_RGB_888](_display.md#gga60883d4958a60b91661e97027a85072aa7ff77397bf2cf52b4614a46264f8ce01), [PIXEL_FMT_BGR_565](_display.md#gga60883d4958a60b91661e97027a85072aaec581b908c291e2bd0155e25169f9629), [PIXEL_FMT_BGRX_4444](_display.md#gga60883d4958a60b91661e97027a85072aa6b5a7b35e00fc25146de0c9bf88b0230),   [PIXEL_FMT_BGRA_4444](_display.md#gga60883d4958a60b91661e97027a85072aa2f3d4ada099b2e8d84ec4501fbc8bed9), [PIXEL_FMT_BGRX_5551](_display.md#gga60883d4958a60b91661e97027a85072aaaf1a20dc0a597258cfe6aca806a8e0de), [PIXEL_FMT_BGRA_5551](_display.md#gga60883d4958a60b91661e97027a85072aa2319d4a75dae0b56776fa63d525e308b), [PIXEL_FMT_BGRX_8888](_display.md#gga60883d4958a60b91661e97027a85072aa1b19279f89c8cfb60e7d77ce23cd5f43),   [PIXEL_FMT_BGRA_8888](_display.md#gga60883d4958a60b91661e97027a85072aaeb31c670120a1fbc96a0e0887997fe16), [PIXEL_FMT_YUV_422_I](_display.md#gga60883d4958a60b91661e97027a85072aac73c2a84907a53ed95a329007b5c8992), [PIXEL_FMT_YCBCR_422_SP](_display.md#gga60883d4958a60b91661e97027a85072aabdf1224848278508479ce97f637dd711), [PIXEL_FMT_YCRCB_422_SP](_display.md#gga60883d4958a60b91661e97027a85072aa8bf97d66e26b3aad7c83dfa70e2bc451),   [PIXEL_FMT_YCBCR_420_SP](_display.md#gga60883d4958a60b91661e97027a85072aa0d1db50eb492f9073abdd2d662c56396), [PIXEL_FMT_YCRCB_420_SP](_display.md#gga60883d4958a60b91661e97027a85072aa1fa43c8a197d5c974a35b8bf02ab386e), [PIXEL_FMT_YCBCR_422_P](_display.md#gga60883d4958a60b91661e97027a85072aaa2fe085e63428ea76e1d975175001dc6), [PIXEL_FMT_YCRCB_422_P](_display.md#gga60883d4958a60b91661e97027a85072aab04eb6e1d940e42f3b4cc20c0a44c4ee),   [PIXEL_FMT_YCBCR_420_P](_display.md#gga60883d4958a60b91661e97027a85072aa3d80e785bed28e2b3f5c7df563500962), [PIXEL_FMT_YCRCB_420_P](_display.md#gga60883d4958a60b91661e97027a85072aa3dc5a0a5ad2f21218b446c477277210a), [PIXEL_FMT_YUYV_422_PKG](_display.md#gga60883d4958a60b91661e97027a85072aa3980def5b133584bdb2982a71f07798e), [PIXEL_FMT_UYVY_422_PKG](_display.md#gga60883d4958a60b91661e97027a85072aadfd69bd5b421aad5bdd39d5f33317197),   [PIXEL_FMT_YVYU_422_PKG](_display.md#gga60883d4958a60b91661e97027a85072aaf851031c336e8d9f57c940c5f52381f4), [PIXEL_FMT_VYUY_422_PKG](_display.md#gga60883d4958a60b91661e97027a85072aa317a761939335025379d382074a1541c), [PIXEL_FMT_VENDER_MASK](_display.md#gga60883d4958a60b91661e97027a85072aa67668ea067a31a8479aece94094bc547) = 0X7FFF0000, [PIXEL_FMT_BUTT](_display.md#gga60883d4958a60b91661e97027a85072aa07086bb3356c9c88959eee00c0982684) = 0X7FFFFFFF } | 像素格式类型定义。 [更多...](_display.md#pixelformat) | -| [TransformType](_display.md#transformtype) { ROTATE_NONE = 0, ROTATE_90, ROTATE_180, ROTATE_270,   ROTATE_BUTT } | [TransformType](_display.md#transformtype) {   [ROTATE_NONE](_display.md#ggaa65f3b21a9a92ff022e435a7304126d2a68e349e9d45a8eba440e2a7a3ba31ec9) = 0, [ROTATE_90](_display.md#ggaa65f3b21a9a92ff022e435a7304126d2a685062467b0c1a3164556335b467c886), [ROTATE_180](_display.md#ggaa65f3b21a9a92ff022e435a7304126d2a186263164422bb8f0eb5f7b7d195a3d1), [ROTATE_270](_display.md#ggaa65f3b21a9a92ff022e435a7304126d2a554e734d2a23790b248c5ce39816c18f),   [ROTATE_BUTT](_display.md#ggaa65f3b21a9a92ff022e435a7304126d2a9b6ff871536aeef2a8e3ce4a753988ed) } | 图层变换类型定义。 [更多...](_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 } | [BlendType](_display.md#blendtype) {   [BLEND_NONE](_display.md#ggaab1839ed4aab1030dfda801a51e68817ae410edb34509ca21425fe5872bbc7e2f) = 0, [BLEND_CLEAR](_display.md#ggaab1839ed4aab1030dfda801a51e68817a6330cee419fbdafc0b25f0aa068814e5), [BLEND_SRC](_display.md#ggaab1839ed4aab1030dfda801a51e68817af01da0c255cdbf67d0774a67c2d221b5), [BLEND_SRCOVER](_display.md#ggaab1839ed4aab1030dfda801a51e68817ad4c0cd02aa4b5f4849e2b29a26481dde),   [BLEND_DSTOVER](_display.md#ggaab1839ed4aab1030dfda801a51e68817a21f03e8d04a58ed0684b39eb84bdb89f), [BLEND_SRCIN](_display.md#ggaab1839ed4aab1030dfda801a51e68817a74e681f6c9027bb2cf0bda3b72d2dd9e), [BLEND_DSTIN](_display.md#ggaab1839ed4aab1030dfda801a51e68817a19f528828d75c34e18375219f113d9bb), [BLEND_SRCOUT](_display.md#ggaab1839ed4aab1030dfda801a51e68817a404e05a118462520e878c23f89808199),   [BLEND_DSTOUT](_display.md#ggaab1839ed4aab1030dfda801a51e68817ac0dc902b4928413d367376e4c842d909), [BLEND_SRCATOP](_display.md#ggaab1839ed4aab1030dfda801a51e68817ada473c7e3bf2b1102349489416aefefc), [BLEND_DSTATOP](_display.md#ggaab1839ed4aab1030dfda801a51e68817a0129b4506a06b1a6df297bcf685f5f89), [BLEND_ADD](_display.md#ggaab1839ed4aab1030dfda801a51e68817adbdb329830e5b4d9fa2b17d5d6d7894f),   [BLEND_XOR](_display.md#ggaab1839ed4aab1030dfda801a51e68817a167c3b256e051244066d8e53cdd5529d), [BLEND_DST](_display.md#ggaab1839ed4aab1030dfda801a51e68817a4686a5f30c73982d625a05db021e9b15), [BLEND_AKS](_display.md#ggaab1839ed4aab1030dfda801a51e68817ae549aa3794365df8965a2c3853c8da99), [BLEND_AKD](_display.md#ggaab1839ed4aab1030dfda801a51e68817a3cc39f12fa8bceba626a33c2d82a8bf7),   [BLEND_BUTT](_display.md#ggaab1839ed4aab1030dfda801a51e68817ad0650812ac2aa9eee228f48ac514b44a) } | 显示内存类型定义。 [更多...](_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 } | [RopType](_display.md#roptype) {   [ROP_BLACK](_display.md#gga24265f7618fbdba53d3da4806d3097c4a6358a786ec3b81000a07b343424cee0d) = 0, [ROP_NOTMERGEPEN](_display.md#gga24265f7618fbdba53d3da4806d3097c4a96c89f7b89a9048d355b4dc467224f4c), [ROP_MASKNOTPEN](_display.md#gga24265f7618fbdba53d3da4806d3097c4a54d054ea6920cb88f374f70e8d41f934), [ROP_NOTCOPYPEN](_display.md#gga24265f7618fbdba53d3da4806d3097c4af4a5d5dc0f15249001cff7ef32fadef1),   [ROP_MASKPENNOT](_display.md#gga24265f7618fbdba53d3da4806d3097c4ad777eea18ba9f4e071b00aa060db00e3), [ROP_NOT](_display.md#gga24265f7618fbdba53d3da4806d3097c4afa63c8e2a6a39d50954cb6316576b4e9), [ROP_XORPEN](_display.md#gga24265f7618fbdba53d3da4806d3097c4a79433776e85bb80ad0306ced0b82947c), [ROP_NOTMASKPEN](_display.md#gga24265f7618fbdba53d3da4806d3097c4ad6c4d2458a9caaa079a3e5907d636e8a),   [ROP_MASKPEN](_display.md#gga24265f7618fbdba53d3da4806d3097c4a2a069e2105c5b8d4dac5d174c76eb9d4), [ROP_NOTXORPEN](_display.md#gga24265f7618fbdba53d3da4806d3097c4a33c37c5ce718e876f43141dc5a028375), [ROP_NOP](_display.md#gga24265f7618fbdba53d3da4806d3097c4a2acacab882af44bba09878bd58e18695), [ROP_MERGENOTPEN](_display.md#gga24265f7618fbdba53d3da4806d3097c4afaea3c47612082914332b78ca8c331b3),   [ROP_COPYPE](_display.md#gga24265f7618fbdba53d3da4806d3097c4a91bae697f9dea25ac4d7be011958a45d), [ROP_MERGEPENNOT](_display.md#gga24265f7618fbdba53d3da4806d3097c4a3580b77320e4829da046b8739c61d6b8), [ROP_MERGEPEN](_display.md#gga24265f7618fbdba53d3da4806d3097c4a8195ac0d37e0d69b2cd71dd7362d3fd3), [ROP_WHITE](_display.md#gga24265f7618fbdba53d3da4806d3097c4a533a614b27da8a81b67ada085b018618),   [ROP_BUTT](_display.md#gga24265f7618fbdba53d3da4806d3097c4aa858b07e214a7f62625e24776806c74b) } | 硬件加速支持的ROP操作类型。 [更多...](_display.md#roptype) | -| [ColorKey](_display.md#colorkey) { CKEY_NONE = 0, CKEY_SRC, CKEY_DST, CKEY_BUTT } | [ColorKey](_display.md#colorkey) { [CKEY_NONE](_display.md#gga4fe6fb05c7ba0048b1739d88f4d4878ea629b31de258db2ce01cb757b85bd5273) = 0, [CKEY_SRC](_display.md#gga4fe6fb05c7ba0048b1739d88f4d4878ea5e3271e73dce39d0806ff8e9cba011bc), [CKEY_DST](_display.md#gga4fe6fb05c7ba0048b1739d88f4d4878ea6921c2c202aa69293467baa6c33fae05), [CKEY_BUTT](_display.md#gga4fe6fb05c7ba0048b1739d88f4d4878ea32cedc8986de2c290bf2ec193d88cabf) } | Color key操作类型定义，即硬件加速支持的Color key操作类型。 [更多...](_display.md#colorkey) | -| [MirrorType](_display.md#mirrortype) { MIRROR_NONE = 0, MIRROR_LR, MIRROR_TB, MIRROR_BUTT } | [MirrorType](_display.md#mirrortype) { [MIRROR_NONE](_display.md#gga08d32376574b541d162d8534adb78fd0a5ad82fcc8af04f92571e185b61eeb309) = 0, [MIRROR_LR](_display.md#gga08d32376574b541d162d8534adb78fd0ae35099d9fd28c2974661bcce36a9ea5c), [MIRROR_TB](_display.md#gga08d32376574b541d162d8534adb78fd0afd82e59546a645fd29bc779c50bfa733), [MIRROR_BUTT](_display.md#gga08d32376574b541d162d8534adb78fd0ad9e357a2c2f7dc0e3ca5a351ec457410) } | 硬件加速支持的镜像操作类型定义 [更多...](_display.md#mirrortype) | -| [Connection](_display.md#connection) { CON_INVALID = 0, CONNECTED, DISCONNECTED } | [Connection](_display.md#connection) { [CON_INVALID](_display.md#ggab0845c0c8d309ee865c78b095b00e671ab5c8a92e6af2e63e769dd8f711564760) = 0, [CONNECTED](_display.md#ggab0845c0c8d309ee865c78b095b00e671a7a691a2430ec26878897b5fbc9c22a4c), [DISCONNECTED](_display.md#ggab0845c0c8d309ee865c78b095b00e671acdaad1112073e3e2ea032424c38c34e1) } | 热插拔连接类型定义 [更多...](_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 } | [InterfaceType](_display.md#interfacetype) {   [DISP_INTF_HDMI](_display.md#ggaf1ef2c97e255bd7f21d3b7614b283d9da717f9ae7960ba280c6c6b8822c6d8b66) = 0, [DISP_INTF_LCD](_display.md#ggaf1ef2c97e255bd7f21d3b7614b283d9da210dbbea7e5c30b693515bba570474d4), [DISP_INTF_BT1120](_display.md#ggaf1ef2c97e255bd7f21d3b7614b283d9da89a4e456ceffa55cb93b2c6f4792c96b), [DISP_INTF_BT656](_display.md#ggaf1ef2c97e255bd7f21d3b7614b283d9daf23a0b7607d3fdc7eac791d62c5f9cd5),   [DISP_INTF_YPBPR](_display.md#ggaf1ef2c97e255bd7f21d3b7614b283d9da54a83297ab61376574854e804a6158e1), [DISP_INTF_RGB](_display.md#ggaf1ef2c97e255bd7f21d3b7614b283d9da83ef625db890ee1ddb4e874d6155405f), [DISP_INTF_CVBS](_display.md#ggaf1ef2c97e255bd7f21d3b7614b283d9dabf3991ede75cb3bb454372174d63ec29), [DISP_INTF_SVIDEO](_display.md#ggaf1ef2c97e255bd7f21d3b7614b283d9daad740e6f901f40965d2824415fcb9041),   [DISP_INTF_VGA](_display.md#ggaf1ef2c97e255bd7f21d3b7614b283d9da5db1f365e675d992f47ce797339beff5), [DISP_INTF_MIPI](_display.md#ggaf1ef2c97e255bd7f21d3b7614b283d9da5b9c7382dfdcc029e467c6339bf90915), [DISP_INTF_PANEL](_display.md#ggaf1ef2c97e255bd7f21d3b7614b283d9da4d64c32b687840c7e08e28a2892ac222), [DISP_INTF_BUTT](_display.md#p106611424171011) } | 枚举接口类型。 [更多...](_display.md#interfacetype) | -| [DispPowerStatus](_display.md#disppowerstatus) { POWER_STATUS_ON, POWER_STATUS_STANDBY, POWER_STATUS_SUSPEND, POWER_STATUS_OFF,   POWER_STATUS_BUTT } | [DispPowerStatus](_display.md#disppowerstatus) {   [POWER_STATUS_ON](_display.md#gga0f3c8af6e9d40730b0d2e0fbbf8e627da89e258c21283c662af2145bd3f9fc9a0), [POWER_STATUS_STANDBY](_display.md#gga0f3c8af6e9d40730b0d2e0fbbf8e627da604748a7de21aa992c1f72c252fc77a7), [POWER_STATUS_SUSPEND](_display.md#gga0f3c8af6e9d40730b0d2e0fbbf8e627da5605db047fd50c64fa0a13d8e558d479), [POWER_STATUS_OFF](_display.md#gga0f3c8af6e9d40730b0d2e0fbbf8e627daddd660122faa920f2adcd81e83d22c85),   [POWER_STATUS_BUTT](_display.md#gga0f3c8af6e9d40730b0d2e0fbbf8e627dad1f590a00c02d7335bfc24edbea92037) } | 枚举显示状态 [更多...](_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 } | [CompositionType](_display.md#compositiontype) {   [COMPOSITION_CLIENT](_display.md#ggae5d7b642670cf3dc6654131dfa115fe5afc7ab4757f19ed87ea6d1603478edbe8), [COMPOSITION_DEVICE](_display.md#ggae5d7b642670cf3dc6654131dfa115fe5aa51390e0da602171f2d042a94c6b75bf), [COMPOSITION_CURSOR](_display.md#ggae5d7b642670cf3dc6654131dfa115fe5a663feec453d4509980f3bb34f641303b), [COMPOSITION_VIDEO](_display.md#ggae5d7b642670cf3dc6654131dfa115fe5a89ea30239d366a6968c7dff429a99aa9),   [COMPOSITION_DEVICE_CLEAR](_display.md#ggae5d7b642670cf3dc6654131dfa115fe5a05f5ab2a5da295c0fdc7e19e9a121f3e), [COMPOSITION_CLIENT_CLEAR](_display.md#ggae5d7b642670cf3dc6654131dfa115fe5a7c1535ef8d388f878fae7c722d69855e), [COMPOSITION_TUNNEL](_display.md#ggae5d7b642670cf3dc6654131dfa115fe5a400576aea4b15e011ddd21748d16f9ca), [COMPOSITION_BUTT](_display.md#p488974221219) } | 枚举特殊层的组合类型。 [更多...](_display.md#compositiontype) | -| [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 } | [ColorGamut](_display.md#colorgamut) {   [COLOR_GAMUT_INVALID](_display.md#gga7e865f6dbae09a004be2949b473fd7c3a7d7d95bebc0ddb4d10da05b449bab1bf) = -1, [COLOR_GAMUT_NATIVE](_display.md#gga7e865f6dbae09a004be2949b473fd7c3af0e1dba48215d4d19bd9a3536a736cdb) = 0, [COLOR_GAMUT_SATNDARD_BT601](_display.md#gga7e865f6dbae09a004be2949b473fd7c3affa91ab208128bec9b981e7020bcbfa9) = 1, [COLOR_GAMUT_STANDARD_BT709](_display.md#gga7e865f6dbae09a004be2949b473fd7c3a248480b6ae7ad6c5327dd7cb5cfd0a85) = 2,   [COLOR_GAMUT_DCI_P3](_display.md#gga7e865f6dbae09a004be2949b473fd7c3a98eb540d5a93ab3ad4256907eec89c4e) = 3, [COLOR_GAMUT_SRGB](_display.md#gga7e865f6dbae09a004be2949b473fd7c3a8327e3fc0a79c9935dd9279c10c841c5) = 4, [COLOR_GAMUT_ADOBE_RGB](_display.md#gga7e865f6dbae09a004be2949b473fd7c3a3377a7df82b495c65f3f7ab2b1655100) = 5, [COLOR_GAMUT_DISPLAY_P3](_display.md#gga7e865f6dbae09a004be2949b473fd7c3ad79cdc9f86f3b581453c523a03a876d3) = 6,   [COLOR_GAMUT_BT2020](_display.md#gga7e865f6dbae09a004be2949b473fd7c3a79ff774719c5b83287b298d39ee274f3) = 7, [COLOR_GAMUT_BT2100_PQ](_display.md#gga7e865f6dbae09a004be2949b473fd7c3aa8191f5fca2ad767fa56767b41f4dec5) = 8, [COLOR_GAMUT_BT2100_HLG](_display.md#gga7e865f6dbae09a004be2949b473fd7c3ad4f624c7b578dacaa732cd9556724797) = 9, [COLOR_GAMUT_DISPLAY_BT2020](_display.md#gga7e865f6dbae09a004be2949b473fd7c3a5d07e2f0d8e570c5e16ccff05e12cb29) = 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 } | [GamutMap](_display.md#gamutmap) { [GAMUT_MAP_CONSTANT](_display.md#gga5700b58f1bc340e309a0962101ad7fa4acdf75e246ac2f53f37ef9e11b5561535) = 0, [GAMUT_MAP_EXPANSION](_display.md#gga5700b58f1bc340e309a0962101ad7fa4af3824abcccbd8d85d28e34149e9aaa33) = 1, [GAMUT_MAP_HDR_CONSTANT](_display.md#gga5700b58f1bc340e309a0962101ad7fa4afd4e1cb10b8032108ab070925b73e270) = 2, [GAMUT_MAP_HDR_EXPANSION](_display.md#gga5700b58f1bc340e309a0962101ad7fa4ad0f9722a0efd51910ac5f2f63fd86a10) = 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 } | [ColorDataSpace](_display.md#colordataspace) {   [COLOR_DATA_SPACE_UNKNOWN](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33cca5a0aa62f13715cbdf2b5ec1e26e76225) = 0, [GAMUT_BT601](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33ccad778a31f4c8e3431f5240f98c70f577d) = 0x00000001, [GAMUT_BT709](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33cca7d346fa865c56c76f62c7f6ab92511ec) = 0x00000002, [GAMUT_DCI_P3](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33ccae29ccb674444c3f81f0a46361d7ce63c) = 0x00000003,   [GAMUT_SRGB](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33cca16c4c57e66f86b20269db0d5d6382ded) = 0x00000004, [GAMUT_ADOBE_RGB](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33cca0a0a0c633a41a5f30596a5168a3267ca) = 0x00000005, [GAMUT_DISPLAY_P3](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33cca3d4a0608dd5c682fc020bfc68a425e15) = 0x00000006, [GAMUT_BT2020](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33ccaa6dc448a5d0d16a7d2610edb29fff407) = 0x00000007,   [GAMUT_BT2100_PQ](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33cca6b100b6876c7e77106df92b9c8cf7d2b) = 0x00000008, [GAMUT_BT2100_HLG](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33cca53a60a5ed93129597841bde263e9a798) = 0x00000009, [GAMUT_DISPLAY_BT2020](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33ccaa66ffaf12ec59488cccbd2170cc3d2c8) = 0x0000000a, [TRANSFORM_FUNC_UNSPECIFIED](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33cca0fe652843eafbf7a93b645a71342dce0) = 0x00000100,   [TRANSFORM_FUNC_LINEAR](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33ccaa2e1f70b023dd5ae3a31771217d958cc) = 0x00000200, [TRANSFORM_FUNC_SRGB](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33cca47dd20703e8d8135aedfb687b75ef66c) = 0x00000300, [TRANSFORM_FUNC_SMPTE_170M](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33ccab031ec808cc46bee79d2c96460615206) = 0x00000400, [TRANSFORM_FUNC_GM2_2](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33cca078b8dad4e1eb6720c81c841b3f417d9) = 0x00000500,   [TRANSFORM_FUNC_GM2_6](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33ccad6abe514be2fa6c57b2aec5a5eb6fc7d) = 0x00000600, [TRANSFORM_FUNC_GM2_8](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33cca850b419cb0075b5bd44df5708fc9c87f) = 0x00000700, [TRANSFORM_FUNC_ST2084](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33cca24a6d830fca211b067260df9583a1b2b) = 0x00000800, [TRANSFORM_FUNC_HLG](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33cca4a6d68c7a2219cada2edf0e9d7bc46f8) = 0x00000900,   [PRECISION_UNSPECIFIED](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33cca77342396f1154be94079d0d76fc5e829) = 0x00010000, [PRECISION_FULL](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33cca200541efc2ee0d21e37a7200e7a08a54) = 0x00020000, [PRESION_LIMITED](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33ccab51307e81936be84b6504a98197fb1ee) = 0x00030000, [PRESION_EXTENDED](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33ccafd6ac339ebbdbbdd7fee540a6fad5ec2) = 0x00040000,   [BT601_SMPTE170M_FULL](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33ccab640f36320dafb19066dfcaccc836999) = GAMUT_BT601 \| TRANSFORM_FUNC_SMPTE_170M \| PRECISION_FULL, [BT601_SMPTE170M_LIMITED](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33cca6cd475c6421764e5d71d71f1de75d638) = GAMUT_BT601 \| TRANSFORM_FUNC_SMPTE_170M \| PRESION_LIMITED, [BT709_LINEAR_FULL](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33ccad2bc96da52c18ef9bb26320507747176) = GAMUT_BT709 \| TRANSFORM_FUNC_LINEAR \| PRECISION_FULL, [BT709_LINEAR_EXTENDED](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33cca03631fd75bc6ec7280ce2c68a129e4fd) = GAMUT_BT709 \| TRANSFORM_FUNC_LINEAR \| PRESION_EXTENDED,   [BT709_SRGB_FULL](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33ccaaffba49d9c1c335387cd8153becad65a) = GAMUT_BT709 \| TRANSFORM_FUNC_SRGB \| PRECISION_FULL, [BT709_SRGB_EXTENDED](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33cca049878481c3ed46dbd6cfea995e2f0d5) = GAMUT_BT709 \| TRANSFORM_FUNC_SRGB \| PRESION_EXTENDED, [BT709_SMPTE170M_LIMITED](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33cca14381e6d202b6bda3c90264b05d31838) = GAMUT_BT709 \| TRANSFORM_FUNC_SMPTE_170M \| PRESION_LIMITED, [DCI_P3_LINEAR_FULL](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33ccad03af85a7ff4c1069a97bfb603f7d694) = GAMUT_DCI_P3 \| TRANSFORM_FUNC_LINEAR \| PRECISION_FULL,   [DCI_P3_GAMMA26_FULL](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33cca9de9b32e0e7c172c77922af8904ba3a2) = GAMUT_DCI_P3 \| TRANSFORM_FUNC_GM2_6 \| PRECISION_FULL, [DISPLAY_P3_LINEAR_FULL](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33cca8bcb3a4ed6039d158b9c32ba99fceaff) = GAMUT_DISPLAY_P3 \| TRANSFORM_FUNC_LINEAR \| PRECISION_FULL, [DCI_P3_SRGB_FULL](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33cca2fac97f61868100034eb40fdba9a9d3f) = GAMUT_DCI_P3 \| TRANSFORM_FUNC_SRGB \| PRECISION_FULL, [ADOBE_RGB_GAMMA22_FULL](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33cca1f855c7b4bd5f8a9cc29f3e335a9f2f4) = GAMUT_ADOBE_RGB \| TRANSFORM_FUNC_GM2_2 \| PRECISION_FULL,   [BT2020_LINEAR_FULL](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33cca27315309a3b866eda00f17825ee9532d) = GAMUT_BT2020 \| TRANSFORM_FUNC_LINEAR \| PRECISION_FULL, [BT2020_SRGB_FULL](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33ccaa63d6a3a8bb1c6c5b383cb7010f61d72) = GAMUT_BT2020 \| TRANSFORM_FUNC_SRGB \| PRECISION_FULL, [BT2020_SMPTE170M_FULL](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33cca6de02e882e01743ce5ca07a17d481930) = GAMUT_BT2020 \| TRANSFORM_FUNC_SMPTE_170M \| PRECISION_FULL, [BT2020_ST2084_FULL](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33ccac2e37c91fc9bd29641cf95d74aa7862c) = GAMUT_BT2020 \| TRANSFORM_FUNC_ST2084 \| PRECISION_FULL,   [BT2020_HLG_FULL](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33ccad5b0a069ac80df8d045265e88f9b5e71) = GAMUT_BT2020 \| TRANSFORM_FUNC_HLG \| PRECISION_FULL, [BT2020_ST2084_LIMITED](_display.md#gga00fa6ca1bcfe5949dceaa3a77f8d33ccaeab2d55af8e3568130cf69fa614b3c9d) = 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 } | [HDRFormat](_display.md#hdrformat) {   [NOT_SUPPORT_HDR](_display.md#ggabdc446aa6fa47c5dd8d1b7d87bed2566a0799ce04a1873f60ed59c3d30dcda69a) = 0, [DOLBY_VISION](_display.md#ggabdc446aa6fa47c5dd8d1b7d87bed2566ac43f1175d92c85033e0a85c7a14266a7) = 1, [HDR10](_display.md#ggabdc446aa6fa47c5dd8d1b7d87bed2566ada5b15b3c4b4cc64593452113ac1d4dc) = 2, [HLG](_display.md#ggabdc446aa6fa47c5dd8d1b7d87bed2566a2c6e7224778e782cbbd478e4c11282e2) = 3,   [HDR10_PLUS](_display.md#ggabdc446aa6fa47c5dd8d1b7d87bed2566abc6f25afdafdebb03fd137de1917389d) = 4, [HDR_VIVID](_display.md#ggabdc446aa6fa47c5dd8d1b7d87bed2566a84318c5a162e5b9b822e38e675117e42) = 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 } | [HDRMetadataKey](_display.md#hdrmetadatakey) {   [MATAKEY_RED_PRIMARY_X](_display.md#gga5d7d90acb5c568e62a02b18446f37789a92c0f5eaba344bee22c657040b606fd3) = 0, [MATAKEY_RED_PRIMARY_Y](_display.md#gga5d7d90acb5c568e62a02b18446f37789a405841a4999556bd36281870d579dc7e) = 1, [MATAKEY_GREEN_PRIMARY_X](_display.md#gga5d7d90acb5c568e62a02b18446f37789a08f31a74e8df3253c6326879818dfe1b) = 2, [MATAKEY_GREEN_PRIMARY_Y](_display.md#gga5d7d90acb5c568e62a02b18446f37789a19db3eede73e96c6a25dc4d31e5846e1) = 3,   [MATAKEY_BLUE_PRIMARY_X](_display.md#gga5d7d90acb5c568e62a02b18446f37789a23e7112a9c4aaf15bc2a529344a61939) = 4, [MATAKEY_BLUE_PRIMARY_Y](_display.md#gga5d7d90acb5c568e62a02b18446f37789a5a34485b5884d8bd86273750b9d47b0b) = 5, [MATAKEY_WHITE_PRIMARY_X](_display.md#gga5d7d90acb5c568e62a02b18446f37789ac12237b3de1eee6176c690e7f14ab339) = 6, [MATAKEY_WHITE_PRIMARY_Y](_display.md#gga5d7d90acb5c568e62a02b18446f37789a331c8b69a7d9484c9eaea70e78a34921) = 7,   [MATAKEY_MAX_LUMINANCE](_display.md#gga5d7d90acb5c568e62a02b18446f37789ac27053151e1fa76e58dc3281d843ad74) = 8, [MATAKEY_MIN_LUMINANCE](_display.md#gga5d7d90acb5c568e62a02b18446f37789a345f5cea142c7357e0b9de5ccfc86bed) = 9, [MATAKEY_MAX_CONTENT_LIGHT_LEVEL](_display.md#gga5d7d90acb5c568e62a02b18446f37789a9897f53fcb179afc9c90f8c7ca0ac254) = 10, [MATAKEY_MAX_FRAME_AVERAGE_LIGHT_LEVEL](_display.md#gga5d7d90acb5c568e62a02b18446f37789a8d285ea7b6246f62b7e7a65e5a870bfe) = 11,   [MATAKEY_HDR10_PLUS](_display.md#gga5d7d90acb5c568e62a02b18446f37789a89ef9c02321a94080f185c7fea3f6d1d) = 12, [MATAKEY_HDR_VIVID](_display.md#gga5d7d90acb5c568e62a02b18446f37789ac99c4612b3aee2bfede23070fe32ac7e) = 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 } | [PresentTimestampType](_display.md#presenttimestamptype) { [HARDWARE_DISPLAY_PTS_UNSUPPORTED](_display.md#ggabdba71665ea5ba4004ac1a9fbeb505f3ad6e47ab1a80ab94cccb5e465610ff45d) = 0, [HARDWARE_DISPLAY_PTS_DELAY](_display.md#ggabdba71665ea5ba4004ac1a9fbeb505f3a5c06391b9583b69d37c7a0518dd10f09) = 1 << 0, [HARDWARE_DISPLAY_PTS_TIMESTAMP](_display.md#ggabdba71665ea5ba4004ac1a9fbeb505f3afd872c457c9dade672aaaec5de622ff7) = 1 << 1 } | 上屏时间戳类型枚举值 [更多...](_display.md#presenttimestamptype) | + | 枚举 | 描述 | +| -------- | -------- | +| [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_SDIEBAND, 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_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 } | 色域类型枚举值 [更多...](_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) | ## **详细描述** 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 db9bca32be..f89f9a17d2 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 @@ -15,12 +15,12 @@ | 类 | 描述 | | -------- | -------- | -| [InputController](_input_controller.md) | 提供input设备业务控制相关的接口。 [更多...](_input_controller.md) | +| [InputController](_input_controller.md) | 提供Input设备业务控制相关的接口。 [更多...](_input_controller.md) | ## **详细描述** -描述input设备业务控制相关的接口声明。 +描述Input设备业务控制相关的接口声明。 **Since：** 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 03a08b6be8..245d922504 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 @@ -15,7 +15,7 @@ | 类 | 描述 | | -------- | -------- | -| [InputManager](_input_manager.md) | 提供input设备管理相关的接口。 [更多...](_input_manager.md) | +| [InputManager](_input_manager.md) | 提供Input设备管理相关的接口。 [更多...](_input_manager.md) | | [IInputInterface](_i_input_interface.md) | 定义用于提供输入设备驱动能力的接口。[更多...](_i_input_interface.md) | @@ -23,12 +23,13 @@ | 函数 | 描述 | | -------- | -------- | -| [GetInputInterface](_input.md#getinputinterface) ([IInputInterface](_i_input_interface.md) \*\*interface) | input服务通过调用此接口获取操作input设备的所有接口。 [更多...](_input.md#getinputinterface) | +| [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设备管理相关的接口声明。 +描述Input设备管理相关的接口声明。 **Since：** 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 5982a67450..f537d55f38 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 @@ -15,12 +15,12 @@ | 类 | 描述 | | -------- | -------- | -| [InputReporter](_input_reporter.md) | 提供input设备数据上报相关的接口。 [更多...](_input_reporter.md) | +| [InputReporter](_input_reporter.md) | 提供Input设备数据上报相关的接口。 [更多...](_input_reporter.md) | ## **详细描述** -描述input设备数据上报相关的接口声明。 +描述Input设备数据上报相关的接口声明。 **Since：** 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 97b78edcd5..73d10e58c0 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 @@ -15,10 +15,17 @@ | 类 | 描述 | | -------- | -------- | -| [EventPackage](_event_package.md) | input事件数据包结构 [更多...](_event_package.md) | -| [InputReportEventCb](_input_report_event_cb.md) | 此结构体定义了输入事件回调函数并提供给input服务使用 [更多...](_input_report_event_cb.md) | -| [DeviceInfo](_device_info.md) | input设备基础设备信息 [更多...](_device_info.md) | -| [InputExtraCmd](_input_extra_cmd.md) | 扩展指令的数据结构 [更多...](_input_extra_cmd.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) | ### 宏定义 @@ -26,26 +33,31 @@ | 宏定义 | 描述 | | -------- | -------- | | **MAX_INPUT_DEV_NUM**   32 | Input设备最大数量。 | -| **MAX_NODE_PATH_LEN**   64 | 节点路径最大长度。 | +| **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) | +| [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) | ## **详细描述** -input设备相关的类型定义，定义了input设备驱动接口所使用的结构体及枚举类型。 +Input设备相关的类型定义，定义了Input设备驱动接口所使用的结构体及枚举类型。 **Since：** 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 bff63979bd..c6d110537f 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 @@ -15,7 +15,7 @@ | Public 成员函数 | 描述 | | -------- | -------- | -| [GetExecutorList](#getexecutorlist) ([out] [IExecutor](interface_i_executor.md)[] executorList) | 获取执行器列表，口令认证服务进程启动进行初始化操作时通过该接口获取口令认证驱动支持的执行器列表。 [更多...](#getexecutorlist) | +| [GetExecutorList](#getexecutorlist) ([out] [IExecutor](interface_pin_i_executor.md)[] executorList) | 获取执行器列表，口令认证服务进程启动进行初始化操作时通过该接口获取口令认证驱动支持的执行器列表。 [更多...](#getexecutorlist) | ## **详细描述** @@ -49,7 +49,7 @@ IPinAuthInterface::GetExecutorList ([out] IExecutor[] executorList) | 名称 | 描述 | | -------- | -------- | -| executorList | 执行器对象列表[IExecutor](interface_i_executor.md)。 | +| executorList | 执行器对象列表[IExecutor](interface_pin_i_executor.md)。 | **返回：** 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 ab757df991..435ef85b8d 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 @@ -429,7 +429,7 @@ IUserAuthInterface::GetUserInfo([in] int userId, [out] unsigned long secureUid, | -------- | -------- | | userId | 用户ID。 | | secureUid | 安全用户ID。 | -| pinSubType | 口令认证子类型 {\@link PinSubType}。 | +| pinSubType | 口令认证子类型，请参考[PinSubType](_hdf_user_auth.md#pinsubtype)。 | | infos | 注册信息[EnrolledInfo](_enrolled_info.md)。 | **返回：** 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 84471c4498..f2ec31e36b 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 @@ -17,13 +17,13 @@ | -------- | -------- | | [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) | -| [h2GetExecutorInfo](#getexecutorinfo) ([out] struct [ExecutorInfo](_executor_info.md) executorInfo) | 获取执行器信息，口令认证服务将执行器注册到用户认证框架时需要通过该接口获取对应信息。 [更多...](#getexecutorinfo) | +| [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_i_executor_callback.md) callbackObj) | 注册口令。 [更多...](#enroll) | -| [Authenticate](#authenticate) ([in] unsigned long scheduleId, [in] unsigned long templateId, [in] unsigned char[] extraInfo, [in] [IExecutorCallback](interface_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) | +| [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_i_executor_callback.md) callbackObj) | 发送口令认证功能相关操作命令。 [更多...](#sendcommand) | +| [SendCommand](#sendcommand) ([in] int commandId, [in] unsigned char[] extraInfo, [in] [IExecutorCallback](interface_pin_i_executor_callback.md) callbackObj) | 发送口令认证功能相关操作命令。 [更多...](#sendcommand) | ## **详细描述** @@ -60,7 +60,7 @@ IExecutor::Authenticate ([in] unsigned long scheduleId, [in] unsigned long templ | scheduleId | 调度ID，用于标识一次操作请求的调度过程。 | | templateId | 指定要认证的模版ID。 | | extraInfo | 其他相关信息，用于支持信息扩展。 | -| callbackObj | 回调对象[IExecutorCallback](interface_i_executor_callback.md)。 | +| callbackObj | 回调对象[IExecutorCallback](interface_pin_i_executor_callback.md)。 | **返回：** @@ -134,7 +134,7 @@ IExecutor::Enroll ([in] unsigned long scheduleId, [in] unsigned char[] extraInfo | -------- | -------- | | scheduleId | 调度ID，用于标识一次操作请求的调度过程。 | | extraInfo | 其他相关信息，用于支持信息扩展。 | -| callbackObj | 回调对象[IExecutorCallback](interface_i_executor_callback.md)。 | +| callbackObj | 回调对象[IExecutorCallback](interface_pin_i_executor_callback.md)。 | **返回：** @@ -261,7 +261,7 @@ IExecutor::SendCommand ([in] int commandId, [in] unsigned char[] extraInfo, [in] | -------- | -------- | | commandId | 操作命令ID[CommandId](_hdf_pin_auth.md#commandid)。 | | extraInfo | 其他相关信息，用于支持信息扩展。 | -| callbackObj | 回调对象[IExecutorCallback](interface_i_executor_callback.md)。 | +| callbackObj | 回调对象[IExecutorCallback](interface_pin_i_executor_callback.md)。 | **返回：** diff --git a/zh-cn/device-dev/reference/hdi-apis/light_8typeh.md b/zh-cn/device-dev/reference/hdi-apis/light_8typeh.md index 768205451b..55be372ba2 100644 --- a/zh-cn/device-dev/reference/hdi-apis/light_8typeh.md +++ b/zh-cn/device-dev/reference/hdi-apis/light_8typeh.md @@ -13,11 +13,11 @@ ### 类 - | 类 | 描述 | +| 类 | 描述 | | -------- | -------- | -| LightFlashEffect | 定义闪烁参数。 [更多...](_light_flash_effect.md) | -| LightEffect | 定义灯的效果参数。 [更多...](_light_effect.md) | -| LightInfo | 定义灯的基本信息。 [更多...](_light_info.md) | +| LightFlashEffect | 定义闪烁参数。 [更多...](_light_flash_effect.md) | +| LightEffect | 定义灯的效果参数。 [更多...](_light_effect.md) | +| LightInfo | 定义灯的基本信息。 [更多...](_light_info.md) | ## **详细描述** @@ -27,3 +27,7 @@ **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 index a48fb26211..989dc4180a 100644 --- a/zh-cn/device-dev/reference/hdi-apis/light__if_8h.md +++ b/zh-cn/device-dev/reference/hdi-apis/light__if_8h.md @@ -13,23 +13,28 @@ ### 类 - | 类 | 描述 | +| 类 | 描述 | | -------- | -------- | -| [LightInterface](_light_interface.md) | 定义可以在灯上执行的基本操作。 [更多...](_light_interface.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) | +| [NewLightInterfaceInstance](_light.md#newlightinterfaceinstance) (void) | 创建LightInterface实例。 [更多...](_light.md#newlightinterfaceinstance) | +| [FreeLightInterfaceInstance](_light.md#freelightinterfaceinstance) (void) | 释放LightInterface实例和相关资源。 [更多...](_light.md#freelightinterfaceinstance) | ## **详细描述** 声明light模块的通用API，可用于获取灯ID、打开或关闭灯、并设置灯光亮度和闪烁模式。 -**Sinc[更多...](_light_flash_effect.md)e更多...[更多...](_light_info.md)：** +**Since：** 3.1 + +**Version：** + +1.0 + 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 66e82d37d3..b642de4759 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 @@ -15,7 +15,7 @@ | 类 | 描述 | | -------- | -------- | -| [IExecutor](interface_i_executor.md) | 定义执行器接口，用于获取执行器，获取凭据模版信息，注册人脸特征模版，进行用户人脸认证，删除人脸特征模版等。 [更多...](interface_i_executor.md) | +| [IExecutor](interface_pin_i_executor.md) | 定义执行器标准API接口。接口可用于获取执行器信息，获取凭据模版信息，注册口令，认证口令，删除口令等。 [更多...](interface_pin_i_executor.md) | ### 变量 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 39258b4678..39df7ba902 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 @@ -15,7 +15,7 @@ | 类 | 描述 | | -------- | -------- | -| [IExecutorCallback](interface_i_executor_callback.md) | 定义异步API接口回调，用于返回异步接口的请求处理结果和信息。使用细节见[IExecutor](interface_i_executor.md)。 [更多...](interface_i_executor_callback.md) | +| [IExecutorCallback](interface_pin_i_executor_callback.md) | 定义异步API接口回调，用于返回异步接口的请求处理结果和信息。使用细节见[IExecutor](interface_pin_i_executor.md)。 [更多...](interface_pin_i_executor_callback.md) | ### 变量 @@ -27,7 +27,7 @@ ## **详细描述** -定义异步API接口回调，用于返回异步接口的请求处理结果和获取信息。使用细节见[IExecutor](interface_i_executor.md)。 +定义异步API接口回调，用于返回异步接口的请求处理结果和获取信息。使用细节见[IExecutor](interface_pin_i_executor.md)。 **Since：** 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 index 4e575fefc0..886db580b0 100644 --- a/zh-cn/device-dev/reference/hdi-apis/sensor__if_8h.md +++ b/zh-cn/device-dev/reference/hdi-apis/sensor__if_8h.md @@ -13,22 +13,22 @@ ### 类 - | 类 | 描述 | +| 类 | 描述 | | -------- | -------- | -| [SensorInterface](_sensor_interface.md) | 提供sensor设备基本控制操作接口。 [更多...](_sensor_interface.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) | +| [NewSensorInterfaceInstance](_sensor.md#newsensorinterfaceinstance) (void) | 创建传感器接口实例。 [更多...](_sensor.md#newsensorinterfaceinstance) | +| [FreeSensorInterfaceInstance](_sensor.md#freesensorinterfaceinstance) (void) | 释放传感器接口实例。 [更多...](_sensor.md#freesensorinterfaceinstance) | ## **详细描述** -Sensor模块对外通用的接口声明文件，提供获取传感器设备信息、订阅/去订阅传感器数据、 使能/去使能传感器、设置传感器模式、设置传感器精度，量程等可选配置接口定义。 +Sensor模块对外通用的接口声明文件，提供获取传感器设备信息、订阅/取消订阅传感器数据、 使能/去使能传感器、设置传感器模式、设置传感器精度，量程等可选配置接口定义。 **Since：** 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 index f92f98f0c8..a8a3c6bdb0 100644 --- a/zh-cn/device-dev/reference/hdi-apis/usbd__type_8h.md +++ b/zh-cn/device-dev/reference/hdi-apis/usbd__type_8h.md @@ -27,6 +27,15 @@ | -------- | -------- | | [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从主机到设备的数据方向。 | + + ### 类型定义 -- GitLab