From 488baf8d792289aed8301751765ca35e0ac3e38a Mon Sep 17 00:00:00 2001 From: duangavin123 Date: Thu, 7 Jul 2022 10:03:06 +0800 Subject: [PATCH] HDI api Signed-off-by: duangavin123 --- .../api/public_sys-resources/icon-caution.gif | Bin 0 -> 580 bytes .../api/public_sys-resources/icon-danger.gif | Bin 0 -> 580 bytes .../api/public_sys-resources/icon-note.gif | Bin 0 -> 394 bytes .../api/public_sys-resources/icon-notice.gif | Bin 0 -> 406 bytes .../api/public_sys-resources/icon-tip.gif | Bin 0 -> 253 bytes .../api/public_sys-resources/icon-warning.gif | Bin 0 -> 580 bytes .../api/toctopics/____attribute____.md | 78 + zh-cn/device-dev/api/toctopics/_alignment.md | 58 + zh-cn/device-dev/api/toctopics/_alloc_info.md | 51 + zh-cn/device-dev/api/toctopics/_audio.md | 2319 +++++++ .../api/toctopics/_audio_adapter.md | 527 ++ .../toctopics/_audio_adapter_descriptor.md | 41 + .../api/toctopics/_audio_attribute.md | 427 ++ .../api/toctopics/_audio_capture.md | 149 + .../api/toctopics/_audio_control.md | 316 + .../api/toctopics/_audio_dev_ext_info.md | 41 + .../api/toctopics/_audio_device_descriptor.md | 41 + .../api/toctopics/_audio_manager.md | 223 + .../api/toctopics/_audio_mix_ext_info.md | 36 + .../_audio_mmap_buffer_descripter.md | 51 + zh-cn/device-dev/api/toctopics/_audio_port.md | 41 + .../api/toctopics/_audio_port_cap.md | 88 + .../api/toctopics/_audio_port_capability.md | 86 + .../device-dev/api/toctopics/_audio_render.md | 485 ++ .../device-dev/api/toctopics/_audio_route.md | 46 + .../api/toctopics/_audio_route_node.md | 56 + .../api/toctopics/_audio_sample_attributes.md | 91 + .../device-dev/api/toctopics/_audio_scene.md | 140 + .../api/toctopics/_audio_scene_descriptor.md | 53 + .../api/toctopics/_audio_session_ext_info.md | 31 + .../toctopics/_audio_sub_port_capability.md | 41 + .../api/toctopics/_audio_time_stamp.md | 38 + .../device-dev/api/toctopics/_audio_volume.md | 367 ++ .../api/toctopics/_auth_result_info.md | 111 + .../api/toctopics/_auth_solution.md | 111 + .../device-dev/api/toctopics/_battery_info.md | 257 + .../device-dev/api/toctopics/_buffer_data.md | 36 + zh-cn/device-dev/api/toctopics/_camera.md | 2825 ++++++++ zh-cn/device-dev/api/toctopics/_codec.md | 2595 ++++++++ .../api/toctopics/_codec_callback_type.md | 54 + .../api/toctopics/_codec_comp_capability.md | 178 + .../api/toctopics/_codec_component_manager.md | 211 + .../api/toctopics/_codec_component_type.md | 125 + .../api/toctopics/_comp_ver_info.md | 88 + .../api/toctopics/_credential_info.md | 141 + zh-cn/device-dev/api/toctopics/_d_a_c.md | 240 + zh-cn/device-dev/api/toctopics/_dac_io_msg.md | 36 + .../device-dev/api/toctopics/_device_funcs.md | 211 + .../device-dev/api/toctopics/_device_info.md | 223 + zh-cn/device-dev/api/toctopics/_display.md | 5817 +++++++++++++++++ .../api/toctopics/_display_capability.md | 71 + .../device-dev/api/toctopics/_display_info.md | 41 + .../api/toctopics/_display_mode_info.md | 46 + .../device-dev/api/toctopics/_enroll_param.md | 81 + .../api/toctopics/_enrolled_info.md | 66 + zh-cn/device-dev/api/toctopics/_event_info.md | 118 + .../api/toctopics/_event_package.md | 88 + .../api/toctopics/_executor_info.md | 173 + .../api/toctopics/_executor_register_info.md | 126 + .../api/toctopics/_executor_send_msg.md | 64 + .../api/toctopics/_face_auth_types_8idl.md | 94 + .../_get_buffer_handle_usage_params.md | 88 + zh-cn/device-dev/api/toctopics/_gfx_funcs.md | 380 ++ zh-cn/device-dev/api/toctopics/_gfx_opt.md | 81 + .../api/toctopics/_gralloc_funcs.md | 422 ++ .../api/toctopics/_h_d_r_capability.md | 51 + .../api/toctopics/_h_d_r_meta_data.md | 36 + .../api/toctopics/_hdf_face_auth.md | 401 ++ .../device-dev/api/toctopics/_hdf_pin_auth.md | 299 + .../toctopics/_hdf_thermal_callback_info.md | 43 + .../api/toctopics/_hdf_user_auth.md | 275 + .../api/toctopics/_i_battery_callback_8idl.md | 58 + .../toctopics/_i_battery_interface_8idl.md | 54 + zh-cn/device-dev/api/toctopics/_i_circle.md | 46 + .../toctopics/_i_face_auth_interface_8idl.md | 52 + .../api/toctopics/_i_input_interface.md | 73 + zh-cn/device-dev/api/toctopics/_i_line.md | 51 + .../toctopics/_i_pin_auth_interface_8idl.md | 52 + .../toctopics/_i_power_hdi_callback_8idl.md | 58 + .../api/toctopics/_i_power_interface_8idl.md | 58 + zh-cn/device-dev/api/toctopics/_i_rect.md | 46 + zh-cn/device-dev/api/toctopics/_i_surface.md | 91 + .../api/toctopics/_i_thermal_callback_8idl.md | 58 + .../toctopics/_i_thermal_interface_8idl.md | 58 + .../toctopics/_i_user_auth_interface_8idl.md | 52 + zh-cn/device-dev/api/toctopics/_i_wi_fi.md | 577 ++ zh-cn/device-dev/api/toctopics/_i_wi_fi_ap.md | 152 + .../api/toctopics/_i_wi_fi_base_feature.md | 420 ++ .../device-dev/api/toctopics/_i_wi_fi_sta.md | 142 + .../api/toctopics/_identify_result_info.md | 81 + zh-cn/device-dev/api/toctopics/_input.md | 462 ++ .../api/toctopics/_input_controller.md | 452 ++ .../api/toctopics/_input_extra_cmd.md | 58 + .../api/toctopics/_input_manager.md | 240 + .../api/toctopics/_input_report_event_cb.md | 102 + .../api/toctopics/_input_reporter.md | 191 + .../device-dev/api/toctopics/_layer_alpha.md | 51 + .../device-dev/api/toctopics/_layer_buffer.md | 61 + .../device-dev/api/toctopics/_layer_funcs.md | 2160 ++++++ zh-cn/device-dev/api/toctopics/_layer_info.md | 53 + zh-cn/device-dev/api/toctopics/_light.md | 295 + .../device-dev/api/toctopics/_light_effect.md | 64 + .../api/toctopics/_light_flash_effect.md | 79 + zh-cn/device-dev/api/toctopics/_light_info.md | 64 + .../api/toctopics/_light_interface.md | 158 + ...h_o_s_1_1_camera_1_1_capture_ended_info.md | 36 + ...h_o_s_1_1_camera_1_1_capture_error_info.md | 36 + .../_o_h_o_s_1_1_camera_1_1_capture_info.md | 41 + ..._o_h_o_s_1_1_camera_1_1_i_camera_device.md | 66 + ...1_1_camera_1_1_i_camera_device_callback.md | 41 + .../_o_h_o_s_1_1_camera_1_1_i_camera_host.md | 73 + ...s_1_1_camera_1_1_i_camera_host_callback.md | 46 + ..._1_camera_1_1_i_offline_stream_operator.md | 46 + ..._h_o_s_1_1_camera_1_1_i_stream_operator.md | 81 + ...1_camera_1_1_i_stream_operator_callback.md | 51 + ...o_h_o_s_1_1_camera_1_1_stream_attribute.md | 71 + .../_o_h_o_s_1_1_camera_1_1_stream_info.md | 76 + ...o_h_o_s_1_1_u_s_b_1_1_u_s_b_device_info.md | 41 + ...o_h_o_s_1_1_u_s_b_1_1_usb_ctrl_transfer.md | 51 + .../_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md | 36 + .../_o_h_o_s_1_1_u_s_b_1_1_usb_info.md | 56 + .../_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md | 36 + .../_o_h_o_s_1_1_u_s_b_1_1_usbd_client.md | 204 + .../_o_h_o_s_1_1_u_s_b_1_1_usbd_subscriber.md | 37 + .../api/toctopics/_omx_codec_buffer.md | 223 + .../api/toctopics/_power_types_8idl.md | 68 + .../api/toctopics/_present_timestamp.md | 36 + .../api/toctopics/_property_object.md | 41 + .../device-dev/api/toctopics/_range_value.md | 58 + zh-cn/device-dev/api/toctopics/_rect.md | 58 + zh-cn/device-dev/api/toctopics/_rectangle.md | 36 + .../api/toctopics/_schedule_info.md | 126 + zh-cn/device-dev/api/toctopics/_sensor.md | 742 +++ .../api/toctopics/_sensor_events.md | 139 + .../api/toctopics/_sensor_information.md | 170 + .../api/toctopics/_sensor_interface.md | 369 ++ zh-cn/device-dev/api/toctopics/_sta_info.md | 51 + .../api/toctopics/_support_buffer_type.md | 88 + .../api/toctopics/_template_info.md | 96 + .../api/toctopics/_thermal_types_8idl.md | 63 + .../api/toctopics/_thermal_zone_info.md | 62 + zh-cn/device-dev/api/toctopics/_types_8idl.md | 85 + zh-cn/device-dev/api/toctopics/_u_s_b.md | 2664 ++++++++ .../api/toctopics/_use_buffer_type.md | 88 + .../api/toctopics/_user_auth_types_8idl.md | 124 + .../api/toctopics/_verify_alloc_info.md | 46 + zh-cn/device-dev/api/toctopics/_vibrator.md | 188 + .../api/toctopics/_vibrator_interface.md | 148 + .../api/toctopics/_video_port_cap.md | 133 + zh-cn/device-dev/api/toctopics/_w_l_a_n.md | 537 ++ zh-cn/device-dev/api/toctopics/annotated.md | 261 + .../api/toctopics/audio__adapter_8h.md | 39 + .../api/toctopics/audio__attribute_8h.md | 39 + .../api/toctopics/audio__capture_8h.md | 39 + .../api/toctopics/audio__control_8h.md | 39 + .../api/toctopics/audio__manager_8h.md | 56 + .../api/toctopics/audio__render_8h.md | 39 + .../api/toctopics/audio__scene_8h.md | 39 + .../api/toctopics/audio__types_8h.md | 215 + .../api/toctopics/audio__volume_8h.md | 39 + zh-cn/device-dev/api/toctopics/battery.md | 280 + .../api/toctopics/codec__callback__if_8h.md | 63 + .../api/toctopics/codec__common__type_8h.md | 88 + .../api/toctopics/codec__component__if_8h.md | 63 + .../toctopics/codec__component__manager_8h.md | 63 + .../toctopics/codec__component__type_8h.md | 180 + zh-cn/device-dev/api/toctopics/dac__if_8h.md | 62 + .../api/toctopics/display__device_8h.md | 88 + .../api/toctopics/display__gfx_8h.md | 61 + .../api/toctopics/display__gralloc_8h.md | 61 + .../api/toctopics/display__layer_8h.md | 61 + .../api/toctopics/display__type_8h.md | 258 + .../toctopics/face__auth_2_i_executor_8idl.md | 52 + .../face__auth_2_i_executor_callback_8idl.md | 52 + zh-cn/device-dev/api/toctopics/files.md | 131 + .../api/toctopics/icamera__device_8h.md | 39 + .../toctopics/icamera__device__callback_8h.md | 39 + .../api/toctopics/icamera__host_8h.md | 39 + .../toctopics/icamera__host__callback_8h.md | 39 + zh-cn/device-dev/api/toctopics/index.md | 37 + .../api/toctopics/input__controller_8h.md | 39 + .../api/toctopics/input__manager_8h.md | 61 + .../api/toctopics/input__reporter_8h.md | 39 + .../api/toctopics/input__type_8h.md | 128 + .../toctopics/interface_i_battery_callback.md | 72 + .../interface_i_battery_interface.md | 609 ++ .../api/toctopics/interface_i_executor.md | 764 +++ .../interface_i_executor_callback.md | 165 + .../interface_i_face_auth_interface.md | 74 + .../interface_i_pin_auth_interface.md | 74 + .../interface_i_power_hdi_callback.md | 68 + .../toctopics/interface_i_power_interface.md | 239 + .../toctopics/interface_i_thermal_callback.md | 72 + .../interface_i_thermal_interface.md | 241 + .../interface_i_user_auth_interface.md | 982 +++ .../ioffline__stream__operator_8h.md | 39 + .../api/toctopics/istream__operator_8h.md | 39 + .../istream__operator__callback_8h.md | 39 + .../device-dev/api/toctopics/light_8typeh.md | 45 + .../device-dev/api/toctopics/light__if_8h.md | 57 + .../toctopics/pin__auth_2_i_executor_8idl.md | 52 + .../pin__auth_2_i_executor_callback_8idl.md | 56 + zh-cn/device-dev/api/toctopics/power.md | 245 + .../device-dev/api/toctopics/sensor__if_8h.md | 61 + .../api/toctopics/sensor__type_8h.md | 125 + zh-cn/device-dev/api/toctopics/thermal.md | 94 + zh-cn/device-dev/api/toctopics/total.md | 7 + zh-cn/device-dev/api/toctopics/types_8h.md | 153 + ...n_audio_scene_descriptor_1_1_scene_desc.md | 36 + .../api/toctopics/union_port_cap.md | 58 + .../device-dev/api/toctopics/usb__info_8h.md | 44 + .../api/toctopics/usbd__client_8h.md | 39 + .../api/toctopics/usbd__subscriber_8h.md | 39 + .../device-dev/api/toctopics/usbd__type_8h.md | 112 + .../api/toctopics/vibrator__if_8h.md | 61 + .../api/toctopics/vibrator__type_8h.md | 39 + .../device-dev/api/toctopics/wifi__hal_8h.md | 78 + .../toctopics/wifi__hal__ap__feature_8h.md | 61 + .../toctopics/wifi__hal__base__feature_8h.md | 100 + .../toctopics/wifi__hal__sta__feature_8h.md | 56 + .../api/zh-cn_bookmap_0000001343320953.md | 219 + 221 files changed, 44599 insertions(+) create mode 100644 zh-cn/device-dev/api/public_sys-resources/icon-caution.gif create mode 100644 zh-cn/device-dev/api/public_sys-resources/icon-danger.gif create mode 100644 zh-cn/device-dev/api/public_sys-resources/icon-note.gif create mode 100644 zh-cn/device-dev/api/public_sys-resources/icon-notice.gif create mode 100644 zh-cn/device-dev/api/public_sys-resources/icon-tip.gif create mode 100644 zh-cn/device-dev/api/public_sys-resources/icon-warning.gif create mode 100644 zh-cn/device-dev/api/toctopics/____attribute____.md create mode 100644 zh-cn/device-dev/api/toctopics/_alignment.md create mode 100644 zh-cn/device-dev/api/toctopics/_alloc_info.md create mode 100644 zh-cn/device-dev/api/toctopics/_audio.md create mode 100644 zh-cn/device-dev/api/toctopics/_audio_adapter.md create mode 100644 zh-cn/device-dev/api/toctopics/_audio_adapter_descriptor.md create mode 100644 zh-cn/device-dev/api/toctopics/_audio_attribute.md create mode 100644 zh-cn/device-dev/api/toctopics/_audio_capture.md create mode 100644 zh-cn/device-dev/api/toctopics/_audio_control.md create mode 100644 zh-cn/device-dev/api/toctopics/_audio_dev_ext_info.md create mode 100644 zh-cn/device-dev/api/toctopics/_audio_device_descriptor.md create mode 100644 zh-cn/device-dev/api/toctopics/_audio_manager.md create mode 100644 zh-cn/device-dev/api/toctopics/_audio_mix_ext_info.md create mode 100644 zh-cn/device-dev/api/toctopics/_audio_mmap_buffer_descripter.md create mode 100644 zh-cn/device-dev/api/toctopics/_audio_port.md create mode 100644 zh-cn/device-dev/api/toctopics/_audio_port_cap.md create mode 100644 zh-cn/device-dev/api/toctopics/_audio_port_capability.md create mode 100644 zh-cn/device-dev/api/toctopics/_audio_render.md create mode 100644 zh-cn/device-dev/api/toctopics/_audio_route.md create mode 100644 zh-cn/device-dev/api/toctopics/_audio_route_node.md create mode 100644 zh-cn/device-dev/api/toctopics/_audio_sample_attributes.md create mode 100644 zh-cn/device-dev/api/toctopics/_audio_scene.md create mode 100644 zh-cn/device-dev/api/toctopics/_audio_scene_descriptor.md create mode 100644 zh-cn/device-dev/api/toctopics/_audio_session_ext_info.md create mode 100644 zh-cn/device-dev/api/toctopics/_audio_sub_port_capability.md create mode 100644 zh-cn/device-dev/api/toctopics/_audio_time_stamp.md create mode 100644 zh-cn/device-dev/api/toctopics/_audio_volume.md create mode 100644 zh-cn/device-dev/api/toctopics/_auth_result_info.md create mode 100644 zh-cn/device-dev/api/toctopics/_auth_solution.md create mode 100644 zh-cn/device-dev/api/toctopics/_battery_info.md create mode 100644 zh-cn/device-dev/api/toctopics/_buffer_data.md create mode 100644 zh-cn/device-dev/api/toctopics/_camera.md create mode 100644 zh-cn/device-dev/api/toctopics/_codec.md create mode 100644 zh-cn/device-dev/api/toctopics/_codec_callback_type.md create mode 100644 zh-cn/device-dev/api/toctopics/_codec_comp_capability.md create mode 100644 zh-cn/device-dev/api/toctopics/_codec_component_manager.md create mode 100644 zh-cn/device-dev/api/toctopics/_codec_component_type.md create mode 100644 zh-cn/device-dev/api/toctopics/_comp_ver_info.md create mode 100644 zh-cn/device-dev/api/toctopics/_credential_info.md create mode 100644 zh-cn/device-dev/api/toctopics/_d_a_c.md create mode 100644 zh-cn/device-dev/api/toctopics/_dac_io_msg.md create mode 100644 zh-cn/device-dev/api/toctopics/_device_funcs.md create mode 100644 zh-cn/device-dev/api/toctopics/_device_info.md create mode 100644 zh-cn/device-dev/api/toctopics/_display.md create mode 100644 zh-cn/device-dev/api/toctopics/_display_capability.md create mode 100644 zh-cn/device-dev/api/toctopics/_display_info.md create mode 100644 zh-cn/device-dev/api/toctopics/_display_mode_info.md create mode 100644 zh-cn/device-dev/api/toctopics/_enroll_param.md create mode 100644 zh-cn/device-dev/api/toctopics/_enrolled_info.md create mode 100644 zh-cn/device-dev/api/toctopics/_event_info.md create mode 100644 zh-cn/device-dev/api/toctopics/_event_package.md create mode 100644 zh-cn/device-dev/api/toctopics/_executor_info.md create mode 100644 zh-cn/device-dev/api/toctopics/_executor_register_info.md create mode 100644 zh-cn/device-dev/api/toctopics/_executor_send_msg.md create mode 100644 zh-cn/device-dev/api/toctopics/_face_auth_types_8idl.md create mode 100644 zh-cn/device-dev/api/toctopics/_get_buffer_handle_usage_params.md create mode 100644 zh-cn/device-dev/api/toctopics/_gfx_funcs.md create mode 100644 zh-cn/device-dev/api/toctopics/_gfx_opt.md create mode 100644 zh-cn/device-dev/api/toctopics/_gralloc_funcs.md create mode 100644 zh-cn/device-dev/api/toctopics/_h_d_r_capability.md create mode 100644 zh-cn/device-dev/api/toctopics/_h_d_r_meta_data.md create mode 100644 zh-cn/device-dev/api/toctopics/_hdf_face_auth.md create mode 100644 zh-cn/device-dev/api/toctopics/_hdf_pin_auth.md create mode 100644 zh-cn/device-dev/api/toctopics/_hdf_thermal_callback_info.md create mode 100644 zh-cn/device-dev/api/toctopics/_hdf_user_auth.md create mode 100644 zh-cn/device-dev/api/toctopics/_i_battery_callback_8idl.md create mode 100644 zh-cn/device-dev/api/toctopics/_i_battery_interface_8idl.md create mode 100644 zh-cn/device-dev/api/toctopics/_i_circle.md create mode 100644 zh-cn/device-dev/api/toctopics/_i_face_auth_interface_8idl.md create mode 100644 zh-cn/device-dev/api/toctopics/_i_input_interface.md create mode 100644 zh-cn/device-dev/api/toctopics/_i_line.md create mode 100644 zh-cn/device-dev/api/toctopics/_i_pin_auth_interface_8idl.md create mode 100644 zh-cn/device-dev/api/toctopics/_i_power_hdi_callback_8idl.md create mode 100644 zh-cn/device-dev/api/toctopics/_i_power_interface_8idl.md create mode 100644 zh-cn/device-dev/api/toctopics/_i_rect.md create mode 100644 zh-cn/device-dev/api/toctopics/_i_surface.md create mode 100644 zh-cn/device-dev/api/toctopics/_i_thermal_callback_8idl.md create mode 100644 zh-cn/device-dev/api/toctopics/_i_thermal_interface_8idl.md create mode 100644 zh-cn/device-dev/api/toctopics/_i_user_auth_interface_8idl.md create mode 100644 zh-cn/device-dev/api/toctopics/_i_wi_fi.md create mode 100644 zh-cn/device-dev/api/toctopics/_i_wi_fi_ap.md create mode 100644 zh-cn/device-dev/api/toctopics/_i_wi_fi_base_feature.md create mode 100644 zh-cn/device-dev/api/toctopics/_i_wi_fi_sta.md create mode 100644 zh-cn/device-dev/api/toctopics/_identify_result_info.md create mode 100644 zh-cn/device-dev/api/toctopics/_input.md create mode 100644 zh-cn/device-dev/api/toctopics/_input_controller.md create mode 100644 zh-cn/device-dev/api/toctopics/_input_extra_cmd.md create mode 100644 zh-cn/device-dev/api/toctopics/_input_manager.md create mode 100644 zh-cn/device-dev/api/toctopics/_input_report_event_cb.md create mode 100644 zh-cn/device-dev/api/toctopics/_input_reporter.md create mode 100644 zh-cn/device-dev/api/toctopics/_layer_alpha.md create mode 100644 zh-cn/device-dev/api/toctopics/_layer_buffer.md create mode 100644 zh-cn/device-dev/api/toctopics/_layer_funcs.md create mode 100644 zh-cn/device-dev/api/toctopics/_layer_info.md create mode 100644 zh-cn/device-dev/api/toctopics/_light.md create mode 100644 zh-cn/device-dev/api/toctopics/_light_effect.md create mode 100644 zh-cn/device-dev/api/toctopics/_light_flash_effect.md create mode 100644 zh-cn/device-dev/api/toctopics/_light_info.md create mode 100644 zh-cn/device-dev/api/toctopics/_light_interface.md create mode 100644 zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_capture_ended_info.md create mode 100644 zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_capture_error_info.md create mode 100644 zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_capture_info.md create mode 100644 zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_i_camera_device.md create mode 100644 zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_i_camera_device_callback.md create mode 100644 zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_i_camera_host.md create mode 100644 zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_i_camera_host_callback.md create mode 100644 zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_i_offline_stream_operator.md create mode 100644 zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_i_stream_operator.md create mode 100644 zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_i_stream_operator_callback.md create mode 100644 zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_stream_attribute.md create mode 100644 zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_stream_info.md create mode 100644 zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_u_s_b_1_1_u_s_b_device_info.md create mode 100644 zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_u_s_b_1_1_usb_ctrl_transfer.md create mode 100644 zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md create mode 100644 zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_u_s_b_1_1_usb_info.md create mode 100644 zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md create mode 100644 zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_u_s_b_1_1_usbd_client.md create mode 100644 zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_u_s_b_1_1_usbd_subscriber.md create mode 100644 zh-cn/device-dev/api/toctopics/_omx_codec_buffer.md create mode 100644 zh-cn/device-dev/api/toctopics/_power_types_8idl.md create mode 100644 zh-cn/device-dev/api/toctopics/_present_timestamp.md create mode 100644 zh-cn/device-dev/api/toctopics/_property_object.md create mode 100644 zh-cn/device-dev/api/toctopics/_range_value.md create mode 100644 zh-cn/device-dev/api/toctopics/_rect.md create mode 100644 zh-cn/device-dev/api/toctopics/_rectangle.md create mode 100644 zh-cn/device-dev/api/toctopics/_schedule_info.md create mode 100644 zh-cn/device-dev/api/toctopics/_sensor.md create mode 100644 zh-cn/device-dev/api/toctopics/_sensor_events.md create mode 100644 zh-cn/device-dev/api/toctopics/_sensor_information.md create mode 100644 zh-cn/device-dev/api/toctopics/_sensor_interface.md create mode 100644 zh-cn/device-dev/api/toctopics/_sta_info.md create mode 100644 zh-cn/device-dev/api/toctopics/_support_buffer_type.md create mode 100644 zh-cn/device-dev/api/toctopics/_template_info.md create mode 100644 zh-cn/device-dev/api/toctopics/_thermal_types_8idl.md create mode 100644 zh-cn/device-dev/api/toctopics/_thermal_zone_info.md create mode 100644 zh-cn/device-dev/api/toctopics/_types_8idl.md create mode 100644 zh-cn/device-dev/api/toctopics/_u_s_b.md create mode 100644 zh-cn/device-dev/api/toctopics/_use_buffer_type.md create mode 100644 zh-cn/device-dev/api/toctopics/_user_auth_types_8idl.md create mode 100644 zh-cn/device-dev/api/toctopics/_verify_alloc_info.md create mode 100644 zh-cn/device-dev/api/toctopics/_vibrator.md create mode 100644 zh-cn/device-dev/api/toctopics/_vibrator_interface.md create mode 100644 zh-cn/device-dev/api/toctopics/_video_port_cap.md create mode 100644 zh-cn/device-dev/api/toctopics/_w_l_a_n.md create mode 100644 zh-cn/device-dev/api/toctopics/annotated.md create mode 100644 zh-cn/device-dev/api/toctopics/audio__adapter_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/audio__attribute_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/audio__capture_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/audio__control_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/audio__manager_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/audio__render_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/audio__scene_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/audio__types_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/audio__volume_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/battery.md create mode 100644 zh-cn/device-dev/api/toctopics/codec__callback__if_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/codec__common__type_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/codec__component__if_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/codec__component__manager_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/codec__component__type_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/dac__if_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/display__device_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/display__gfx_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/display__gralloc_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/display__layer_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/display__type_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/face__auth_2_i_executor_8idl.md create mode 100644 zh-cn/device-dev/api/toctopics/face__auth_2_i_executor_callback_8idl.md create mode 100644 zh-cn/device-dev/api/toctopics/files.md create mode 100644 zh-cn/device-dev/api/toctopics/icamera__device_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/icamera__device__callback_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/icamera__host_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/icamera__host__callback_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/index.md create mode 100644 zh-cn/device-dev/api/toctopics/input__controller_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/input__manager_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/input__reporter_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/input__type_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/interface_i_battery_callback.md create mode 100644 zh-cn/device-dev/api/toctopics/interface_i_battery_interface.md create mode 100644 zh-cn/device-dev/api/toctopics/interface_i_executor.md create mode 100644 zh-cn/device-dev/api/toctopics/interface_i_executor_callback.md create mode 100644 zh-cn/device-dev/api/toctopics/interface_i_face_auth_interface.md create mode 100644 zh-cn/device-dev/api/toctopics/interface_i_pin_auth_interface.md create mode 100644 zh-cn/device-dev/api/toctopics/interface_i_power_hdi_callback.md create mode 100644 zh-cn/device-dev/api/toctopics/interface_i_power_interface.md create mode 100644 zh-cn/device-dev/api/toctopics/interface_i_thermal_callback.md create mode 100644 zh-cn/device-dev/api/toctopics/interface_i_thermal_interface.md create mode 100644 zh-cn/device-dev/api/toctopics/interface_i_user_auth_interface.md create mode 100644 zh-cn/device-dev/api/toctopics/ioffline__stream__operator_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/istream__operator_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/istream__operator__callback_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/light_8typeh.md create mode 100644 zh-cn/device-dev/api/toctopics/light__if_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/pin__auth_2_i_executor_8idl.md create mode 100644 zh-cn/device-dev/api/toctopics/pin__auth_2_i_executor_callback_8idl.md create mode 100644 zh-cn/device-dev/api/toctopics/power.md create mode 100644 zh-cn/device-dev/api/toctopics/sensor__if_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/sensor__type_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/thermal.md create mode 100644 zh-cn/device-dev/api/toctopics/total.md create mode 100644 zh-cn/device-dev/api/toctopics/types_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/union_audio_scene_descriptor_1_1_scene_desc.md create mode 100644 zh-cn/device-dev/api/toctopics/union_port_cap.md create mode 100644 zh-cn/device-dev/api/toctopics/usb__info_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/usbd__client_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/usbd__subscriber_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/usbd__type_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/vibrator__if_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/vibrator__type_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/wifi__hal_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/wifi__hal__ap__feature_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/wifi__hal__base__feature_8h.md create mode 100644 zh-cn/device-dev/api/toctopics/wifi__hal__sta__feature_8h.md create mode 100644 zh-cn/device-dev/api/zh-cn_bookmap_0000001343320953.md diff --git a/zh-cn/device-dev/api/public_sys-resources/icon-caution.gif b/zh-cn/device-dev/api/public_sys-resources/icon-caution.gif new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 GIT binary patch literal 580 zcmV-K0=xZ3Nk%w1VIu$?0Hp~4{QBgqmQ+MG9K51r{QB&)np^||1PlfQ%(86!{`~yv zv{XhUWKt}AZaiE{EOcHp{O-j3`t;<+eEiycJT4p@77X;(jQsMfB$R?oG%6hQ z+MMLZbQBH@)Vg&1^3?qHb(5!%>3r0+`eq=&V&E}0Dypi0000000000 z00000A^8LW000R9EC2ui03!e$000L5z=Uu}ED8YtqjJd<+B}(9bIOb$3-31_h|V>=0A{ z1Hh0#H30>fNT})^fRU_83uewx9oRr{f{Sx1Ml`t)EQ zGkHZ67&~y{W5Jpq4H_WfuLxp*3<7O}GEl;1ESe36fLNs=B0&LQM1Buf(R)qg(BRd`t1OPjI1m_q4 literal 0 HcmV?d00001 diff --git a/zh-cn/device-dev/api/public_sys-resources/icon-danger.gif b/zh-cn/device-dev/api/public_sys-resources/icon-danger.gif new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 GIT binary patch literal 580 zcmV-K0=xZ3Nk%w1VIu$?0Hp~4{QBgqmQ+MG9K51r{QB&)np^||1PlfQ%(86!{`~yv zv{XhUWKt}AZaiE{EOcHp{O-j3`t;<+eEiycJT4p@77X;(jQsMfB$R?oG%6hQ z+MMLZbQBH@)Vg&1^3?qHb(5!%>3r0+`eq=&V&E}0Dypi0000000000 z00000A^8LW000R9EC2ui03!e$000L5z=Uu}ED8YtqjJd<+B}(9bIOb$3-31_h|V>=0A{ z1Hh0#H30>fNT})^fRU_83uewx9oRr{f{Sx1Ml`t)EQ zGkHZ67&~y{W5Jpq4H_WfuLxp*3<7O}GEl;1ESe36fLNs=B0&LQM1Buf(R)qg(BRd`t1OPjI1m_q4 literal 0 HcmV?d00001 diff --git a/zh-cn/device-dev/api/public_sys-resources/icon-note.gif b/zh-cn/device-dev/api/public_sys-resources/icon-note.gif new file mode 100644 index 0000000000000000000000000000000000000000..6314297e45c1de184204098efd4814d6dc8b1cda GIT binary patch literal 394 zcmZ?wbhEHblx7fPSjxcg=ii?@_wH=jwxy=7CMGH-B`L+l$wfv=#>UF#$gv|VY%C^b zCQFtrnKN(Bo_%|sJbO}7RAORe!otL&qo<>yq_Sq+8Xqqo5h0P3w3Lvb5E(g{p01vl zxR@)KuDH0l^z`+-dH3eaw=XqSH7aTIx{kzVBN;X&hha0dQSgWuiw0NWUvMRmkD|> literal 0 HcmV?d00001 diff --git a/zh-cn/device-dev/api/public_sys-resources/icon-notice.gif b/zh-cn/device-dev/api/public_sys-resources/icon-notice.gif new file mode 100644 index 0000000000000000000000000000000000000000..86024f61b691400bea99e5b1f506d9d9aef36e27 GIT binary patch literal 406 zcmV;H0crk6Nk%w1VIu$@0J8u9|NsB@_xJDb@8;&_*4Ea}&d#;9wWXz{jEszHYim+c zQaU<1At50E0000000000A^8Le000gEEC2ui03!e%000R7038S%NU)&51O^i-Tu6`s z0)`MFE@;3YqD6xSC^kTNu_J>91{PH8XfZ(p1pp2-SU@u3#{mEUC}_}tg3+I#{z}{Ok@D_ZUDg- zt0stin4;pC8M{WLSlRH*1pzqEw1}3oOskyNN?j;7HD{BBZ*OEcv4HK!6Bk6beR+04 z&8}k>SkTusVTDmkyOz#5fCA$JTPGJVQvr3uZ?QzzPQFvD0rGf_PdrcF`pMs}p^BcF zKtKTd`0wipR%nKN&Wj+V}pX;WC3SdJV!a_8Qi zE7z`U*|Y^H0^}fB$R?oG%6hQ z+MMLZbQBH@)Vg&1^3?qHb(5!%>3r0+`eq=&V&E}0Dypi0000000000 z00000A^8LW000R9EC2ui03!e$000L5z=Uu}ED8YtqjJd<+B}(9bIOb$3-31_h|V>=0A{ z1Hh0#H30>fNT})^fRU_83uewx9oRr{f{Sx1Ml`t)EQ zGkHZ67&~y{W5Jpq4H_WfuLxp*3<7O}GEl;1ESe36fLNs=B0&LQM1Buf(R)qg(BRd`t1OPjI1m_q4 literal 0 HcmV?d00001 diff --git a/zh-cn/device-dev/api/toctopics/____attribute____.md b/zh-cn/device-dev/api/toctopics/____attribute____.md new file mode 100644 index 0000000000..787544c744 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/____attribute____.md @@ -0,0 +1,78 @@ +# \_\_attribute\_\_ + +## **概述** + +**所属模块:** + +[Display](_display.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

fd

+

句柄 fd, -1代表不支持。

+

reserveInts

+

reserve数组的个数。

+

reserve [0]

+

reserve数组。

+

baseAddr

+

内存的初始地址。

+

yOffset

+

Y的偏移量。

+

uOffset

+

U的偏移量。

+

vOffset

+

V的偏移量。

+

yStride

+

Y的stride信息。

+

uvStride

+

UV的stride信息。

+

uvStep

+

UV的step信息。

+
+ +## **详细描述** + +扩展数据句柄结构体定义 + +YUV描述信息结构体定义 + diff --git a/zh-cn/device-dev/api/toctopics/_alignment.md b/zh-cn/device-dev/api/toctopics/_alignment.md new file mode 100644 index 0000000000..1f150f18e6 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_alignment.md @@ -0,0 +1,58 @@ +# Alignment + +## **概述** + +**所属模块:** + +[Codec](_codec.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + +

Public 属性

+

描述

+

widthAlignment

+

宽的对齐值。

+

heightAlignment

+

高的对齐值。

+
+ +## **详细描述** + +对齐结构定义，包含宽高的对齐值。 + +## **类成员变量说明** + +## heightAlignment + +``` +int32_t Alignment::heightAlignment +``` + +**描述：** + +高的对齐值。 + +## widthAlignment + +``` +int32_t Alignment::widthAlignment +``` + +**描述：** + +宽的对齐值。 + diff --git a/zh-cn/device-dev/api/toctopics/_alloc_info.md b/zh-cn/device-dev/api/toctopics/_alloc_info.md new file mode 100644 index 0000000000..b2b1e5f71e --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_alloc_info.md @@ -0,0 +1,51 @@ +# AllocInfo + +## **概述** + +**所属模块:** + +[Display](_display.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

width

+

申请内存宽度

+

height

+

申请内存高度

+

usage

+

申请内存的使用场景

+

format

+

申请内存格式

+

expectedSize

+

申请内存大小

+
+ +## **详细描述** + +定义关于要分配的内存的信息。 + diff --git a/zh-cn/device-dev/api/toctopics/_audio.md b/zh-cn/device-dev/api/toctopics/_audio.md new file mode 100644 index 0000000000..df7d991c84 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_audio.md @@ -0,0 +1,2319 @@ +# Audio + +## **汇总** + +## 文件 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

文件

+

描述

+

audio_adapter.h

+

Audio适配器的接口定义文件

+

audio_attribute.h

+

Audio属性的接口定义文件

+

audio_capture.h

+

Audio录音的接口定义文件

+

audio_control.h

+

Audio控制的接口定义文件

+

audio_manager.h

+

Audio适配器管理及加载的接口定义文件

+

audio_render.h

+

Audio播放的接口定义文件

+

audio_scene.h

+

Audio场景的接口定义文件

+

audio_types.h

+

Audio模块接口定义中使用的自定义数据类型

+

audio_volume.h

+

Audio音量的接口定义文件

+
+ +## 类 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

类

+

描述

+

AudioAdapter

+

AudioAdapter音频适配器接口 更多...

+

AudioAttribute

+

AudioAttribute音频属性接口 更多...

+

AudioCapture

+

AudioCapture音频录音接口 更多...

+

AudioControl

+

AudioControl音频控制接口 更多...

+

AudioManager

+

AudioManager音频适配器管理接口 更多...

+

AudioRender

+

AudioRender音频播放接口 更多...

+

AudioScene

+

AudioScene音频场景接口 更多...

+

AudioPort

+

音频端口 更多...

+

AudioAdapterDescriptor

+

音频适配器描述符 更多...

+

AudioDeviceDescriptor

+

音频设备描述符 更多...

+

AudioSceneDescriptor

+

音频场景描述符 更多...

+

AudioSceneDescriptor::SceneDesc

+

音频场景描述 更多...

+

AudioSampleAttributes

+

音频采样属性 更多...

+

AudioTimeStamp

+

音频时间戳 更多...

+

AudioSubPortCapability

+

音频子端口的支持能力 更多...

+

AudioPortCapability

+

音频端口的支持能力 更多...

+

AudioMmapBufferDescripter

+

mmap缓冲区描述符 更多...

+

AudioDevExtInfo

+

音频设备拓展信息 更多...

+

AudioMixExtInfo

+

音轨拓展信息 更多...

+

AudioSessionExtInfo

+

会话拓展信息 更多...

+

AudioRouteNode

+

音频路由节点 更多...

+

AudioRoute

+

音频路由信息 更多...

+

AudioVolume

+

AudioVolume音频音量接口 更多...

+
+ +## 类型定义 + + + + + + + + + + + + + +

类型定义

+

描述

+

AudioHandle

+

音频句柄

+

(RenderCallback) (enum AudioCallbackType, void *reserved, void *cookie)

+

回调函数指针 更多...

+
+ +## 枚举 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举

+

描述

+

AudioPortDirection { PORT_OUT = 0x1u, PORT_IN = 0x2u, PORT_OUT_IN = 0x3u }

+

音频端口的类型 更多...

+

AudioPortPin { PIN_NONE = 0x0u, PIN_OUT_SPEAKER = 0x1u, PIN_OUT_HEADSET = 0x2u, PIN_OUT_LINEOUT = 0x4u, PIN_OUT_HDMI = 0x8u, PIN_OUT_USB = 0x10u, PIN_OUT_USB_EXT = 0x20u, PIN_IN_MIC = 0x8000001u, PIN_IN_HS_MIC = 0x8000002u, PIN_IN_LINEIN = 0x8000004u, PIN_IN_USB_EXT = 0x8000008u }

+

音频适配器端口的PIN脚 更多...

+

AudioCategory { AUDIO_IN_MEDIA = 0, AUDIO_IN_COMMUNICATION, AUDIO_IN_RINGTONE, AUDIO_IN_CALL }

+

音频类型（category） 更多...

+

AudioFormat { AUDIO_FORMAT_PCM_8_BIT = 0x1u, AUDIO_FORMAT_PCM_16_BIT = 0x2u, AUDIO_FORMAT_PCM_24_BIT = 0x3u, AUDIO_FORMAT_PCM_32_BIT = 0x4u, AUDIO_FORMAT_AAC_MAIN = 0x1000001u, AUDIO_FORMAT_AAC_LC = 0x1000002u, AUDIO_FORMAT_AAC_LD = 0x1000003u, AUDIO_FORMAT_AAC_ELD = 0x1000004u, AUDIO_FORMAT_AAC_HE_V1 = 0x1000005u, AUDIO_FORMAT_AAC_HE_V2 = 0x1000006u, AUDIO_FORMAT_G711A = 0x2000001u, AUDIO_FORMAT_G711U = 0x2000002u, AUDIO_FORMAT_G726 = 0x2000003u }

+

音频格式 更多...

+

AudioChannelMask { AUDIO_CHANNEL_FRONT_LEFT = 0x1, AUDIO_CHANNEL_FRONT_RIGHT = 0x2, AUDIO_CHANNEL_MONO = 0x1u, AUDIO_CHANNEL_STEREO = 0x3u }

+

音频通道掩码（mask） 更多...

+

AudioSampleRatesMask { AUDIO_SAMPLE_RATE_MASK_8000 = 0x1u, AUDIO_SAMPLE_RATE_MASK_12000 = 0x2u, AUDIO_SAMPLE_RATE_MASK_11025 = 0x4u, AUDIO_SAMPLE_RATE_MASK_16000 = 0x8u, AUDIO_SAMPLE_RATE_MASK_22050 = 0x10u, AUDIO_SAMPLE_RATE_MASK_24000 = 0x20u, AUDIO_SAMPLE_RATE_MASK_32000 = 0x40u, AUDIO_SAMPLE_RATE_MASK_44100 = 0x80u, AUDIO_SAMPLE_RATE_MASK_48000 = 0x100u, AUDIO_SAMPLE_RATE_MASK_64000 = 0x200u, AUDIO_SAMPLE_RATE_MASK_96000 = 0x400u, AUDIO_SAMPLE_RATE_MASK_INVALID = 0xFFFFFFFFu }

+

音频采样频率MASK 更多...

+

AudioPortPassthroughMode { PORT_PASSTHROUGH_LPCM = 0x1, PORT_PASSTHROUGH_RAW = 0x2, PORT_PASSTHROUGH_HBR2LBR = 0x4, PORT_PASSTHROUGH_AUTO = 0x8 }

+

音频端口的数据透传模式 更多...

+

AudioSampleFormat { AUDIO_SAMPLE_FORMAT_S8, AUDIO_SAMPLE_FORMAT_S8P, AUDIO_SAMPLE_FORMAT_U8, AUDIO_SAMPLE_FORMAT_U8P, AUDIO_SAMPLE_FORMAT_S16, AUDIO_SAMPLE_FORMAT_S16P, AUDIO_SAMPLE_FORMAT_U16, AUDIO_SAMPLE_FORMAT_U16P, AUDIO_SAMPLE_FORMAT_S24, AUDIO_SAMPLE_FORMAT_S24P, AUDIO_SAMPLE_FORMAT_U24, AUDIO_SAMPLE_FORMAT_U24P, AUDIO_SAMPLE_FORMAT_S32, AUDIO_SAMPLE_FORMAT_S32P, AUDIO_SAMPLE_FORMAT_U32, AUDIO_SAMPLE_FORMAT_U32P, AUDIO_SAMPLE_FORMAT_S64, AUDIO_SAMPLE_FORMAT_S64P, AUDIO_SAMPLE_FORMAT_U64, AUDIO_SAMPLE_FORMAT_U64P, AUDIO_SAMPLE_FORMAT_F32, AUDIO_SAMPLE_FORMAT_F32P, AUDIO_SAMPLE_FORMAT_F64, AUDIO_SAMPLE_FORMAT_F64P, AUDIO_SAMPLE_FMT_U8, AUDIO_SAMPLE_FMT_S16, AUDIO_SAMPLE_FMT_S32, AUDIO_SAMPLE_FMT_FLOAT, AUDIO_SAMPLE_FMT_DOUBLE, AUDIO_SAMPLE_FMT_U8P, AUDIO_SAMPLE_FMT_S16P, AUDIO_SAMPLE_FMT_S32P, AUDIO_SAMPLE_FMT_FLOATP, AUDIO_SAMPLE_FMT_DOUBLEP, AUDIO_SAMPLE_FMT_INVALID }

+

原始音频样本格式 更多...

+

AudioChannelMode { AUDIO_CHANNEL_NORMAL = 0, AUDIO_CHANNEL_BOTH_LEFT, AUDIO_CHANNEL_BOTH_RIGHT, AUDIO_CHANNEL_EXCHANGE, AUDIO_CHANNEL_MIX, AUDIO_CHANNEL_LEFT_MUTE, AUDIO_CHANNEL_RIGHT_MUTE, AUDIO_CHANNEL_BOTH_MUTE }

+

音频播放的通道模式 更多...

+

AudioDrainNotifyType { AUDIO_DRAIN_NORMAL_MODE, AUDIO_DRAIN_EARLY_MODE }

+

DrainBuffer函数结束类型 更多...

+

AudioCallbackType { AUDIO_NONBLOCK_WRITE_COMPELETED, AUDIO_DRAIN_COMPELETED, AUDIO_FLUSH_COMPLETED, AUDIO_RENDER_FULL, AUDIO_ERROR_OCCUR }

+

回调函数通知事件类型 更多...

+

AudioPortRole { AUDIO_PORT_UNASSIGNED_ROLE = 0, AUDIO_PORT_SOURCE_ROLE = 1, AUDIO_PORT_SINK_ROLE = 2 }

+

音频端口角色 更多...

+

AudioPortType { AUDIO_PORT_UNASSIGNED_TYPE = 0, AUDIO_PORT_DEVICE_TYPE = 1, AUDIO_PORT_MIX_TYPE = 2, AUDIO_PORT_SESSION_TYPE = 3 }

+

音频端口类型. 更多...

+

AudioSessionType { AUDIO_OUTPUT_STAGE_SESSION = 0, AUDIO_OUTPUT_MIX_SESSION, AUDIO_ALLOCATE_SESSION, AUDIO_INVALID_SESSION }

+

端口会话类型 更多...

+
+ +## 函数 + + + + + + + + + + +

函数

+

描述

+

GetAudioManagerFuncs (void)

+

获取音频适配器管理接口的操作函数列表，详情参考AudioManager 更多...

+
+ +## 变量 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

变量 名称

+

描述

+

AudioPort::dir

+

音频端口的类型。

+

AudioPort::portId

+

音频端口的ID。

+

AudioPort::portName

+

音频端口的名称。

+

AudioAdapterDescriptor::adapterName

+

音频适配器的名称。

+

AudioAdapterDescriptor::portNum

+

一个音频适配器支持的端口数目。

+

AudioAdapterDescriptor::ports

+

一个音频适配器支持的端口列表。

+

AudioDeviceDescriptor::portId

+

音频端口ID。

+

AudioDeviceDescriptor::pins

+

音频端口上的PIN脚（输出、输入）。

+

AudioDeviceDescriptor::desc

+

以字符串命名的音频设备。

+

AudioSceneDescriptor::SceneDesc::id

+

音频场景的ID。

+

AudioSceneDescriptor::SceneDesc::desc

+

以字符串命名的音频场景。

+

AudioSceneDescriptor::scene

+

音频场景的名称。

+

AudioSceneDescriptor::desc

+

音频设备描述符。

+

AudioSampleAttributes::type

+

音频类型。

+

AudioSampleAttributes::interleaved

+

音频数据交织的标记。

+

AudioSampleAttributes::format

+

音频数据格式。

+

AudioSampleAttributes::sampleRate

+

音频采样频率。

+

AudioSampleAttributes::channelCount

+

音频通道数目，如单通道（mono）为1、立体声（stereo）为2。

+

AudioSampleAttributes::period

+

音频采样周期。

+

AudioSampleAttributes::frameSize

+

音频数据的帧大小。

+

AudioSampleAttributes::isBigEndian

+

音频数据的大端标志。

+

AudioSampleAttributes::isSignedData

+

音频数据的有符号或无符号标志。

+

AudioSampleAttributes::startThreshold

+

音频渲染开始阈值。

+

AudioSampleAttributes::stopThreshold

+

音频渲染停止阈值。

+

AudioSampleAttributes::silenceThreshold

+

音频捕获缓冲区阈值。

+

AudioSampleAttributes::streamId

+

渲染或捕获的音频标识符。

+

AudioTimeStamp::tvSec

+

tvSec时间，单位：秒。

+

AudioTimeStamp::tvNSec

+

tvNSec时间，单位：纳秒。

+

AudioSubPortCapability::portId

+

子端口ID。

+

AudioSubPortCapability::desc

+

以字符串命名的子端口。

+

AudioSubPortCapability::mask

+

数据透传模式。

+

AudioPortCapability::deviceType

+

设备输出、输入类型。

+

AudioPortCapability::deviceId

+

绑定（bind）设备ID，唯一的设备识别符。

+

AudioPortCapability::hardwareMode

+

是否支持设备绑定处理。

+

AudioPortCapability::formatNum

+

支持的音频格式数目。

+

AudioPortCapability::formats

+

支持的音频格式。

+

AudioPortCapability::sampleRateMasks

+

支持的音频采样频率（8k、16k、32k、48k）。

+

AudioPortCapability::channelMasks

+

设备的声道布局掩码（mask）。

+

AudioPortCapability::channelCount

+

支持的最大声道总数。

+

AudioPortCapability::subPortsNum

+

支持的子端口数目（仅用于输出设备）。

+

AudioPortCapability::subPorts

+

支持的子端口列表。

+

AudioPortCapability::supportSampleFormatNum

+

支持的音频样本格式数量。

+

AudioPortCapability::supportSampleFormats

+

支持的音频样本格式。

+

AudioMmapBufferDescripter::memoryAddress

+

指向mmap缓冲区的指针。

+

AudioMmapBufferDescripter::memoryFd

+

mmap缓冲区的文件描述符。

+

AudioMmapBufferDescripter::totalBufferFrames

+

缓冲区总大小，单位：帧。

+

AudioMmapBufferDescripter::transferFrameSize

+

传输大小，单位：帧。

+

AudioMmapBufferDescripter::isShareable

+

mmap缓冲区是否可以在进程间共享。

+

AudioDevExtInfo::moduleId

+

音频流绑定的模块ID。

+

AudioDevExtInfo::type

+

音频端口上的PIN脚（输出、输入）。

+

AudioDevExtInfo::desc

+

地址描述。

+

AudioMixExtInfo::moduleId

+

流所属模块标识符。

+

AudioMixExtInfo::streamId

+

由调用者传递的Render或Capture标识符。

+

AudioSessionExtInfo::sessionType

+

音频会话类型。

+

AudioRouteNode::portId

+

音频端口ID。

+

AudioRouteNode::role

+

指定端口角色为sink或source。

+

AudioRouteNode::type

+

指定端口类型。

+

AudioRouteNode::device

+

设备特定信息。

+

AudioRouteNode::mix

+

音轨特定信息。

+

AudioRouteNode::session

+

会话特定信息。

+

AudioRoute::sourcesNum

+

发送端节点数量。

+

AudioRoute::sources

+

发送端列表。

+

AudioRoute::sinksNum

+

接受端节点数量。

+

AudioRoute::sinks

+

接受端列表。

+
+ +## **详细描述** + +Audio模块接口定义。 + +音频接口涉及自定义类型、驱动加载接口、驱动适配器接口、音频播放（render）接口、音频录音（capture）接口等。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## **类型定义说明** + +## RenderCallback + +``` +typedef int32_t(* RenderCallback) (enum AudioCallbackType, void *reserved, void *cookie) +``` + +**描述：** + +回调函数指针 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

AudioCallbackType

+

回调函数响应类型

+

reserved

+

保留字段

+

cookie

+

用于传递数据

+
+ +**返回：** + +成功返回值0，失败返回负值 + +**参见：** + +RegCallback + +## **枚举类型说明** + +## AudioCallbackType + +``` +enum AudioCallbackType +``` + +**描述：** + +回调函数通知事件类型 + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

AUDIO_NONBLOCK_WRITE_COMPELETED

+

非阻塞式写完成

+

+

AUDIO_DRAIN_COMPELETED

+

DrainBuffer完成

+

+

AUDIO_FLUSH_COMPLETED

+

Flush完成

+

+

AUDIO_RENDER_FULL

+

Render缓冲区已满

+

+

AUDIO_ERROR_OCCUR

+

发生了错误

+

+
+ +## AudioCategory + +``` +enum AudioCategory +``` + +**描述：** + +音频类型（category） + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

AUDIO_IN_MEDIA

+

媒体

+

+

AUDIO_IN_COMMUNICATION

+

通信

+

+

AUDIO_IN_RINGTONE

+

铃声

+

+

AUDIO_IN_CALL

+

呼叫

+

+
+ +## AudioChannelMask + +``` +enum AudioChannelMask +``` + +**描述：** + +音频通道掩码（mask） + +定义音频声道的位置 + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

AUDIO_CHANNEL_FRONT_LEFT

+

声道布局前左

+

+

AUDIO_CHANNEL_FRONT_RIGHT

+

声道布局前右

+

+

AUDIO_CHANNEL_MONO

+

单声道

+

+

AUDIO_CHANNEL_STEREO

+

立体声，由左右声道组成（FRONT_LEFT | FRONT_RIGHT）

+

+
+ +## AudioChannelMode + +``` +enum AudioChannelMode +``` + +**描述：** + +音频播放的通道模式 + +>![](../public_sys-resources/icon-notice.gif) **须知：** +>下面的模式是针对双通道立体声的音频播放而设置，其他不支持。 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

AUDIO_CHANNEL_NORMAL

+

正常模式，不做处理

+

+

AUDIO_CHANNEL_BOTH_LEFT

+

两个声道全部为左声道声音

+

+

AUDIO_CHANNEL_BOTH_RIGHT

+

两个声道全部为右声道声音

+

+

AUDIO_CHANNEL_EXCHANGE

+

左右声道数据互换，左声道为右声道声音，右声道为左声道声音

+

+

AUDIO_CHANNEL_MIX

+

左右两个声道输出为左右声道相加（混音）

+

+

AUDIO_CHANNEL_LEFT_MUTE

+

左声道静音，右声道播放原右声道声音

+

+

AUDIO_CHANNEL_RIGHT_MUTE

+

右声道静音，左声道播放原左声道声音

+

+

AUDIO_CHANNEL_BOTH_MUTE

+

左右声道均静音

+

+
+ +## AudioDrainNotifyType + +``` +enum AudioDrainNotifyType +``` + +**描述：** + +DrainBuffer函数结束类型 + + + + + + + + + + + + + +

枚举值

+

描述

+

AUDIO_DRAIN_NORMAL_MODE

+

DrainBuffer在所有数据播放结束后返回

+

+

AUDIO_DRAIN_EARLY_MODE

+

DrainBuffer()在当前曲目的所有数据播放完之前返回，以便留出时间给音频服务做连续性曲目切换

+

+
+ +## AudioFormat + +``` +enum AudioFormat +``` + +**描述：** + +音频格式 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

AUDIO_FORMAT_PCM_8_BIT

+

8bit位宽pcm格式

+

+

AUDIO_FORMAT_PCM_16_BIT

+

16bit位宽pcm格式

+

+

AUDIO_FORMAT_PCM_24_BIT

+

24bit位宽pcm格式

+

+

AUDIO_FORMAT_PCM_32_BIT

+

32bit位宽pcm格式

+

+

AUDIO_FORMAT_AAC_MAIN

+

AAC MAIN格式

+

+

AUDIO_FORMAT_AAC_LC

+

AAC LC格式

+

+

AUDIO_FORMAT_AAC_LD

+

AAC LD格式

+

+

AUDIO_FORMAT_AAC_ELD

+

AAC ELD格式

+

+

AUDIO_FORMAT_AAC_HE_V1

+

AAC HE_V1格式

+

+

AUDIO_FORMAT_AAC_HE_V2

+

AAC HE_V2格式

+

+

AUDIO_FORMAT_G711A

+

G711A格式

+

+

AUDIO_FORMAT_G711U

+

G711u格式

+

+

AUDIO_FORMAT_G726

+

G726格式

+

+
+ +## AudioPortDirection + +``` +enum AudioPortDirection +``` + +**描述：** + +音频端口的类型 + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

PORT_OUT

+

音频输出端口。

+

+

PORT_IN

+

音频输入端口。

+

+

PORT_OUT_IN

+

音频输出/入端口，同时支持输出和输入能力（OUT | IN）。

+

+
+ +## AudioPortPassthroughMode + +``` +enum AudioPortPassthroughMode +``` + +**描述：** + +音频端口的数据透传模式 + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

PORT_PASSTHROUGH_LPCM

+

立体声pcm

+

+

PORT_PASSTHROUGH_RAW

+

HDMI透传

+

+

PORT_PASSTHROUGH_HBR2LBR

+

蓝光次世代音频降规格输出

+

+

PORT_PASSTHROUGH_AUTO

+

根据HDMI EDID能力自动匹配

+

+
+ +## AudioPortPin + +``` +enum AudioPortPin +``` + +**描述：** + +音频适配器端口的PIN脚 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

PIN_NONE

+

无效PIN

+

+

PIN_OUT_SPEAKER

+

喇叭输出

+

+

PIN_OUT_HEADSET

+

有线耳机输出

+

+

PIN_OUT_LINEOUT

+

Lineout输出

+

+

PIN_OUT_HDMI

+

HDMI输出

+

+

PIN_OUT_USB

+

USB设备输出

+

+

PIN_OUT_USB_EXT

+

扩展 USB 设备输出

+

+

PIN_IN_MIC

+

Mic输入

+

+

PIN_IN_HS_MIC

+

有线耳机Mic输入

+

+

PIN_IN_LINEIN

+

Linein输入

+

+

PIN_IN_USB_EXT

+

扩展 USB 设备输入

+

+
+ +## AudioPortRole + +``` +enum AudioPortRole +``` + +**描述：** + +音频端口角色 + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

AUDIO_PORT_UNASSIGNED_ROLE

+

未指定端口角色

+

+

AUDIO_PORT_SOURCE_ROLE

+

指定端口为发送端角色

+

+

AUDIO_PORT_SINK_ROLE

+

指定端口为接受端角色

+

+
+ +## AudioPortType + +``` +enum AudioPortType +``` + +**描述：** + +音频端口类型。 + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

AUDIO_PORT_UNASSIGNED_TYPE

+

未指定端口类型

+

+

AUDIO_PORT_DEVICE_TYPE

+

指定端口为设备类型

+

+

AUDIO_PORT_MIX_TYPE

+

指定端口类型为复合类型

+

+

AUDIO_PORT_SESSION_TYPE

+

指定端口为会话类型

+

+
+ +## AudioSampleFormat + +``` +enum AudioSampleFormat +``` + +**描述：** + +原始音频样本格式 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

AUDIO_SAMPLE_FORMAT_S8

+

8bit位宽有符号交织样本

+

+

AUDIO_SAMPLE_FORMAT_S8P

+

8bit位宽有符号非交织样本

+

+

AUDIO_SAMPLE_FORMAT_U8

+

8bit位宽无符号交织样本

+

+

AUDIO_SAMPLE_FORMAT_U8P

+

8bit位宽无符号非交织样本

+

+

AUDIO_SAMPLE_FORMAT_S16

+

16bit位宽有符号交织样本

+

+

AUDIO_SAMPLE_FORMAT_S16P

+

16bit位宽有符号非交织样本

+

+

AUDIO_SAMPLE_FORMAT_U16

+

16bit位宽无符号交织样本

+

+

AUDIO_SAMPLE_FORMAT_U16P

+

16bit位宽无符号非交织样本

+

+

AUDIO_SAMPLE_FORMAT_S24

+

24bit位宽有符号交织样本

+

+

AUDIO_SAMPLE_FORMAT_S24P

+

24bit位宽有符号非交织样本

+

+

AUDIO_SAMPLE_FORMAT_U24

+

24bit位宽无符号交织样本

+

+

AUDIO_SAMPLE_FORMAT_U24P

+

24bit位宽无符号非交织样本

+

+

AUDIO_SAMPLE_FORMAT_S32

+

32bit位宽有符号交织样本

+

+

AUDIO_SAMPLE_FORMAT_S32P

+

32bit位宽有符号非交织样本

+

+

AUDIO_SAMPLE_FORMAT_U32

+

32bit位宽无符号交织样本

+

+

AUDIO_SAMPLE_FORMAT_U32P

+

32bit位宽无符号非交织样本

+

+

AUDIO_SAMPLE_FORMAT_S64

+

64bit位宽有符号交织样本

+

+

AUDIO_SAMPLE_FORMAT_S64P

+

64bit位宽有符号非交织样本

+

+

AUDIO_SAMPLE_FORMAT_U64

+

64bit位宽无符号交织样本

+

+

AUDIO_SAMPLE_FORMAT_U64P

+

64bit位宽无符号非交织样本

+

+

AUDIO_SAMPLE_FORMAT_F32

+

32bit位宽浮点型交织样本

+

+

AUDIO_SAMPLE_FORMAT_F32P

+

64bit位宽浮点型非交织样本

+

+

AUDIO_SAMPLE_FORMAT_F64

+

64bit位宽双精度浮点型交织样本

+

+

AUDIO_SAMPLE_FORMAT_F64P

+

64bit位宽双精度浮点型非交织样本

+

+

AUDIO_SAMPLE_FMT_U8

+

无符号8位整型，打包格式

+

+

AUDIO_SAMPLE_FMT_S16

+

带符号16位整型，打包格式

+

+

AUDIO_SAMPLE_FMT_S32

+

带符号32位整型，打包格式

+

+

AUDIO_SAMPLE_FMT_FLOAT

+

浮点型，打包格式

+

+

AUDIO_SAMPLE_FMT_DOUBLE

+

双精度浮点型，打包格式

+

+

AUDIO_SAMPLE_FMT_U8P

+

无符号8位整型，平面格式

+

+

AUDIO_SAMPLE_FMT_S16P

+

带符号16位整型，平面格式

+

+

AUDIO_SAMPLE_FMT_S32P

+

带符号32位整型，平面格式

+

+

AUDIO_SAMPLE_FMT_FLOATP

+

浮点型，平面格式

+

+

AUDIO_SAMPLE_FMT_DOUBLEP

+

双精度浮点型，平面格式

+

+

AUDIO_SAMPLE_FMT_INVALID

+

无效采样格式

+

+
+ +## AudioSampleRatesMask + +``` +enum AudioSampleRatesMask +``` + +**描述：** + +音频采样频率MASK + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

AUDIO_SAMPLE_RATE_MASK_8000

+

8K 采样频率

+

+

AUDIO_SAMPLE_RATE_MASK_12000

+

12K 采样频率

+

+

AUDIO_SAMPLE_RATE_MASK_11025

+

11.025K 采样频率

+

+

AUDIO_SAMPLE_RATE_MASK_16000

+

16K 采样频率

+

+

AUDIO_SAMPLE_RATE_MASK_22050

+

22.050K 采样频率

+

+

AUDIO_SAMPLE_RATE_MASK_24000

+

24K 采样频率

+

+

AUDIO_SAMPLE_RATE_MASK_32000

+

32K 采样频率

+

+

AUDIO_SAMPLE_RATE_MASK_44100

+

44.1K 采样频率

+

+

AUDIO_SAMPLE_RATE_MASK_48000

+

48K 采样频率

+

+

AUDIO_SAMPLE_RATE_MASK_64000

+

64K 采样频率

+

+

AUDIO_SAMPLE_RATE_MASK_96000

+

96K 采样频率

+

+

AUDIO_SAMPLE_RATE_MASK_INVALID

+

无效的采样频率

+

+
+ +## AudioSessionType + +``` +enum AudioSessionType +``` + +**描述：** + +端口会话类型 + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

AUDIO_OUTPUT_STAGE_SESSION

+

会话绑定到指定输出流

+

+

AUDIO_OUTPUT_MIX_SESSION

+

会话绑定到特定音轨

+

+

AUDIO_ALLOCATE_SESSION

+

会话ID需重新申请

+

+

AUDIO_INVALID_SESSION

+

无效会话类型

+

+
+ +## **函数说明** + +## GetAudioManagerFuncs\(\) + +``` +struct AudioManager* GetAudioManagerFuncs (void ) +``` + +**描述：** + +获取音频适配器管理接口的操作函数列表，详情参考[AudioManager](_audio_manager.md)。 + +**返回：** + +成功返回一个音频适配器管理接口的对象，失败返回NULL。 + +## **变量说明** + +## adapterName + +``` +const char* AudioAdapterDescriptor::adapterName +``` + +**描述：** + +音频适配器的名称。 + +## channelCount \[1/2\] + +``` +uint32_t AudioSampleAttributes::channelCount +``` + +**描述：** + +音频通道数目，如单通道（mono）为1、立体声（stereo）为2。 + +## channelCount \[2/2\] + +``` +unsigned int AudioPortCapability::channelCount +``` + +**描述：** + +支持的最大声道总数。 + +## channelMasks + +``` +enum AudioChannelMask AudioPortCapability::channelMasks +``` + +**描述：** + +设备的声道布局掩码（mask），详情参考[AudioChannelMask](_audio.md#ga137eb03027d5947ea294b32f5095b83c)。 + +## desc \[1/5\] + +``` +const char* AudioDeviceDescriptor::desc +``` + +**描述：** + +以字符串命名的音频设备。 + +## desc \[2/5\] + +``` +struct AudioDeviceDescriptor AudioSceneDescriptor::desc +``` + +**描述：** + +音频设备描述符。 + +## desc \[3/5\] + +``` +const char* AudioSceneDescriptor::SceneDesc::desc +``` + +**描述：** + +以字符串命名的音频场景。 + +## desc \[4/5\] + +``` +const char* AudioSubPortCapability::desc +``` + +**描述：** + +以字符串命名的子端口。 + +## desc \[5/5\] + +``` +const char* AudioDevExtInfo::desc +``` + +**描述：** + +地址描述。 + +## deviceId + +``` +unsigned int AudioPortCapability::deviceId +``` + +**描述：** + +绑定（bind）设备ID，唯一的设备识别符。 + +## deviceType + +``` +unsigned int AudioPortCapability::deviceType +``` + +**描述：** + +设备输出、输入类型。 + +## dir + +``` +enum AudioPortDirection AudioPort::dir +``` + +**描述：** + +音频端口的类型，详情参考[AudioPortDirection](_audio.md#ga68ff7140b15790debbac4bbc62f8e9f8)。 + +## format + +``` +enum AudioFormat AudioSampleAttributes::format +``` + +**描述：** + +音频数据格式，详情参考[AudioFormat](_audio.md#ga98d5d077cca088ddf77314871474fe59)。 + +## formatNum + +``` +unsigned int AudioPortCapability::formatNum +``` + +**描述：** + +支持的音频格式数目。 + +## formats + +``` +enum AudioFormat* AudioPortCapability::formats +``` + +**描述：** + +支持的音频格式，详情参考[AudioFormat](_audio.md#ga98d5d077cca088ddf77314871474fe59)。 + +## frameSize + +``` +uint32_t AudioSampleAttributes::frameSize +``` + +**描述：** + +音频数据的帧大小。 + +## hardwareMode + +``` +bool AudioPortCapability::hardwareMode +``` + +**描述：** + +是否支持设备绑定处理。 + +## id + +``` +unsigned int AudioSceneDescriptor::SceneDesc::id +``` + +**描述：** + +音频场景的ID。 + +## interleaved + +``` +bool AudioSampleAttributes::interleaved +``` + +**描述：** + +音频数据交织的标记。 + +## isBigEndian + +``` +bool AudioSampleAttributes::isBigEndian +``` + +**描述：** + +音频数据的大端标志。 + +## isShareable + +``` +int32_t AudioMmapBufferDescripter::isShareable +``` + +**描述：** + +mmap缓冲区是否可以在进程间共享。 + +## isSignedData + +``` +bool AudioSampleAttributes::isSignedData +``` + +**描述：** + +音频数据的有符号或无符号标志 + +## mask + +``` +enum AudioPortPassthroughMode AudioSubPortCapability::mask +``` + +**描述：** + +数据透传模式，详情参考[AudioPortPassthroughMode](_audio.md#ga186d2d4f9a2ecacb80cd2cce2bd26f0e)。 + +## memoryAddress + +``` +void* AudioMmapBufferDescripter::memoryAddress +``` + +**描述：** + +指向mmap缓冲区的指针。 + +## memoryFd + +``` +int32_t AudioMmapBufferDescripter::memoryFd +``` + +**描述：** + +mmap缓冲区的文件描述符。 + +## moduleId \[1/2\] + +``` +int32_t AudioDevExtInfo::moduleId +``` + +**描述：** + +音频流绑定的模块ID。 + +## moduleId \[2/2\] + +``` +int32_t AudioMixExtInfo::moduleId +``` + +**描述：** + +流所属模块标识符。 + +## period + +``` +uint32_t AudioSampleAttributes::period +``` + +**描述：** + +音频采样周期。 + +## pins + +``` +enum AudioPortPin AudioDeviceDescriptor::pins +``` + +**描述：** + +音频端口上的PIN脚（输出、输入），详情参考[AudioPortPin](_audio.md#gaa7114aeeccf3ac4f5f7e1d880bcfa835)。 + +## portId \[1/4\] + +``` +unsigned int AudioPort::portId +``` + +**描述：** + +音频端口的ID。 + +## portId \[2/4\] + +``` +unsigned int AudioDeviceDescriptor::portId +``` + +**描述：** + +音频端口ID。 + +## portId \[3/4\] + +``` +unsigned int AudioSubPortCapability::portId +``` + +**描述：** + +子端口ID。 + +## portId \[4/4\] + +``` +int32_t AudioRouteNode::portId +``` + +**描述：** + +音频端口ID。 + +## portName + +``` +const char* AudioPort::portName +``` + +**描述：** + +音频端口的名称。 + +## portNum + +``` +unsigned int AudioAdapterDescriptor::portNum +``` + +**描述：** + +一个音频适配器支持的端口数目。 + +## ports + +``` +struct AudioPort* AudioAdapterDescriptor::ports +``` + +**描述：** + +一个音频适配器支持的端口列表。 + +## role + +``` +enum AudioPortRole AudioRouteNode::role +``` + +**描述：** + +指定端口角色为sink或source。 + +## sampleRate + +``` +unsigned int AudioSampleAttributes::sampleRate +``` + +**描述：** + +音频采样频率。 + +## sampleRateMasks + +``` +unsigned int AudioPortCapability::sampleRateMasks +``` + +**描述：** + +支持的音频采样频率（8k、16k、32k、48k）。 + +## scene + +``` +union AudioSceneDescriptor::SceneDesc AudioSceneDescriptor::scene +``` + +**描述：** + +音频场景的名称。 + +## sessionType + +``` +enum AudioSessionType AudioSessionExtInfo::sessionType +``` + +**描述：** + +音频会话类型。 + +## silenceThreshold + +``` +uint32_t AudioSampleAttributes::silenceThreshold +``` + +**描述：** + +音频捕获缓冲区阈值。 + +## sinks + +``` +const struct AudioRouteNode* AudioRoute::sinks +``` + +**描述：** + +接受端列表。 + +## sinksNum + +``` +uint32_t AudioRoute::sinksNum +``` + +**描述：** + +接受端节点数量。 + +## sources + +``` +const struct AudioRouteNode* AudioRoute::sources +``` + +**描述：** + +发送端列表。 + +## sourcesNum + +``` +uint32_t AudioRoute::sourcesNum +``` + +**描述：** + +发送端节点数量。 + +## startThreshold + +``` +uint32_t AudioSampleAttributes::startThreshold +``` + +**描述：** + +音频渲染开始阈值。 + +## stopThreshold + +``` +uint32_t AudioSampleAttributes::stopThreshold +``` + +**描述：** + +音频渲染停止阈值。 + +## streamId \[1/2\] + +``` +int32_t AudioSampleAttributes::streamId +``` + +**描述：** + +渲染或捕获的音频标识符。 + +## streamId \[2/2\] + +``` +int32_t AudioMixExtInfo::streamId +``` + +**描述：** + +由调用者传递的Render或Capture标识符。 + +## subPorts + +``` +struct AudioSubPortCapability* AudioPortCapability::subPorts +``` + +**描述：** + +支持的子端口列表。 + +## subPortsNum + +``` +unsigned int AudioPortCapability::subPortsNum +``` + +**描述：** + +支持的子端口数目（仅用于输出设备）。 + +## supportSampleFormatNum + +``` +uint32_t AudioPortCapability::supportSampleFormatNum +``` + +**描述：** + +支持的音频样本格式数量。 + +## supportSampleFormats + +``` +enum AudioSampleFormat* AudioPortCapability::supportSampleFormats +``` + +**描述：** + +支持的音频样本格式，详请参考[AudioSampleFormat](_codec.md#ga97cfd5633b2133e7ebe42dbb9b03e757)。 + +## totalBufferFrames + +``` +int32_t AudioMmapBufferDescripter::totalBufferFrames +``` + +**描述：** + +缓冲区总大小，单位：帧。 + +## transferFrameSize + +``` +int32_t AudioMmapBufferDescripter::transferFrameSize +``` + +**描述：** + +传输大小，单位：帧。 + +## tvNSec + +``` +int64_t AudioTimeStamp::tvNSec +``` + +**描述：** + +tvNSec时间，单位：纳秒。 + +## tvSec + +``` +int64_t AudioTimeStamp::tvSec +``` + +**描述：** + +tvSec时间，单位：秒。 + +## type \[1/3\] + +``` +enum AudioCategory AudioSampleAttributes::type +``` + +**描述：** + +音频类型，详情参考[AudioCategory](_audio.md#gaf210d41d152890f3aaf2aaac99bd28d5)。 + +## type \[2/3\] + +``` +enum AudioPortPin AudioDevExtInfo::type +``` + +**描述：** + +音频端口上的PIN脚（输出、输入），详情参考[AudioPortPin](_audio.md#gaa7114aeeccf3ac4f5f7e1d880bcfa835)。 + +## type \[3/3\] + +``` +enum AudioPortType AudioRouteNode::type +``` + +**描述：** + +指定端口类型。 + +## device + +``` + struct AudioDevExtInfo AudioRouteNode::device +``` + +**描述：** + +设备特定信息。 + +## mix + +``` + struct AudioMixExtInfo AudioRouteNode::mix +``` + +**描述：** + +音轨特定信息。 + +## session + +``` + struct AudioSessionExtInfo AudioRouteNode::session +``` + +**描述：** + +会话特定信息。 + diff --git a/zh-cn/device-dev/api/toctopics/_audio_adapter.md b/zh-cn/device-dev/api/toctopics/_audio_adapter.md new file mode 100644 index 0000000000..6f9ef63af6 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_audio_adapter.md @@ -0,0 +1,527 @@ +# AudioAdapter + +## **概述** + +**所属模块:** + +[Audio](_audio.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

( InitAllPorts )(struct AudioAdapter *adapter)

+

初始化一个音频适配器所有的端口驱动 更多...

+

( CreateRender )(struct AudioAdapter *adapter, const struct AudioDeviceDescriptor *desc, const struct AudioSampleAttributes *attrs, struct AudioRender **render)

+

创建一个音频播放（render）接口的对象 更多...

+

( DestroyRender )(struct AudioAdapter *adapter, struct AudioRender *render)

+

销毁一个音频播放（render）接口的对象 更多...

+

( CreateCapture )(struct AudioAdapter *adapter, const struct AudioDeviceDescriptor *desc, const struct AudioSampleAttributes *attrs, struct AudioCapture **capture)

+

创建一个音频录音（capture）接口的对象 更多...

+

( DestroyCapture )(struct AudioAdapter *adapter, struct AudioCapture *capture)

+

销毁一个音频录音（capture）接口的对象 更多...

+

( GetPortCapability )(struct AudioAdapter *adapter, struct AudioPort *port, struct AudioPortCapability *capability)

+

获取一个音频适配器的端口驱动的能力集 更多...

+

( SetPassthroughMode )(struct AudioAdapter *adapter, struct AudioPort *port, enum AudioPortPassthroughMode mode)

+

设置音频端口驱动的数据透传模式 更多...

+

( GetPassthroughMode )(struct AudioAdapter *adapter, struct AudioPort *port, enum AudioPortPassthroughMode *mode)

+

获取音频端口驱动的数据透传模式 更多...

+

( UpdateAudioRoute )(struct AudioAdapter *adapter, const struct AudioRoute *route, int32_t *routeHandle)

+

更新一个或多个发送端和接受端之间的路由 更多...

+

( ReleaseAudioRoute )(struct AudioAdapter *adapter, int32_t routeHandle)

+

释放一个音频路由. 更多...

+
+ +## **详细描述** + +AudioAdapter音频适配器接口 + +提供音频适配器（声卡）对外支持的驱动能力，包括初始化端口、创建render、创建capture、获取端口能力集等 + +**参见：** + +[AudioRender](_audio_render.md) + +[AudioCapture](_audio_capture.md) + +**Since：** + +1.0 + +**Version：** + +1.0 + +## **类成员变量说明** + +## CreateCapture + +``` +int32_t(* AudioAdapter::CreateCapture) (struct AudioAdapter *adapter, const struct AudioDeviceDescriptor *desc, const struct AudioSampleAttributes *attrs, struct AudioCapture **capture) +``` + +**描述：** + +创建一个音频录音（capture）接口的对象 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

adapter

+

待操作的音频适配器的指针

+

desc

+

指向要启动的音频适配器的描述符的指针

+

attrs

+

指向要打开的音频采样属性的指针

+

capture

+

指向AudioCapture对象的二级指针

+
+ +**返回：** + +成功返回值0，失败返回负值 + +**参见：** + +[GetPortCapability](_audio_adapter.md#a8f86fe208c18df58654f183f5b440f1f) + +[DestroyCapture](_audio_adapter.md#a1175a27c5273dab1acf8f8f3c4967637) + +## CreateRender + +``` +int32_t(* AudioAdapter::CreateRender) (struct AudioAdapter *adapter, const struct AudioDeviceDescriptor *desc, const struct AudioSampleAttributes *attrs, struct AudioRender **render) +``` + +**描述：** + +创建一个音频播放（render）接口的对象 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

adapter

+

待操作的音频适配器对象

+

desc

+

待打开的音频设备描述符

+

attrs

+

待打开的音频采样属性

+

render

+

获取的音频播放接口的对象实例保存到render中

+
+ +**返回：** + +成功返回值0，失败返回负值 + +**参见：** + +[GetPortCapability](_audio_adapter.md#a8f86fe208c18df58654f183f5b440f1f) + +[DestroyRender](_audio_adapter.md#a070a8d60f88134c58c4439d4419af913) + +## DestroyCapture + +``` +int32_t(* AudioAdapter::DestroyCapture) (struct AudioAdapter *adapter, struct AudioCapture *capture) +``` + +**描述：** + +销毁一个音频录音（capture）接口的对象 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

adapter

+

待操作的音频适配器对象

+

capture

+

待操作的音频录音接口对象

+
+ +**注意:** + +在音频录音过程中，不能销毁该接口对象 + +**返回：** + +成功返回值0，失败返回负值 + +**参见：** + +[CreateCapture](_audio_adapter.md#a8a46358cdad8e0a9d15ac079713535f2) + +## DestroyRender + +``` +int32_t(* AudioAdapter::DestroyRender) (struct AudioAdapter *adapter, struct AudioRender *render) +``` + +**描述：** + +销毁一个音频播放（render）接口的对象 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

adapter

+

待操作的音频适配器对象

+

render

+

待操作的音频播放接口对象

+
+ +**注意:** + +在音频播放过程中，不能销毁该接口对象 + +**返回：** + +成功返回值0，失败返回负值 + +**参见：** + +[CreateRender](_audio_adapter.md#a284ea2ad18ebac562ca7283652e61b50) + +## GetPassthroughMode + +``` +int(* AudioAdapter::GetPassthroughMode) (struct AudioAdapter *adapter, struct AudioPort *port, enum AudioPortPassthroughMode *mode) +``` + +**描述：** + +获取音频端口驱动的数据透传模式 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

adapter

+

待操作的音频适配器对象

+

port

+

待获取的端口

+

mode

+

获取的传输模式保存到mode中

+
+ +**返回：** + +成功返回值0，失败返回负值 + +**参见：** + +[SetPassthroughMode](_audio_adapter.md#a115fb7b21a1fe1b8412d24c380717bde) + +## GetPortCapability + +``` +int(* AudioAdapter::GetPortCapability) (struct AudioAdapter *adapter, struct AudioPort *port, struct AudioPortCapability *capability) +``` + +**描述：** + +获取一个音频适配器的端口驱动的能力集 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

adapter

+

待操作的音频适配器对象

+

port

+

待获取的端口

+

capability

+

获取的端口能力保存到capability中

+
+ +**返回：** + +成功返回值0，失败返回负值 + +## InitAllPorts + +``` +int(* AudioAdapter::InitAllPorts) (struct AudioAdapter *adapter) +``` + +**描述：** + +初始化一个音频适配器所有的端口驱动 + +在音频服务中，调用其他驱动接口前需要首先调用该接口检查端口是否已经初始化完成，如果端口驱动初始化完成，则函数返回值0， 否则返回负值，如果端口没有初始化完成，则需要等待一段时间（例如100ms）后重新进行检查，直到端口初始化完成后再继续操作 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

adapter

+

待操作的音频适配器对象

+
+ +**返回：** + +成功返回值0，失败返回负值 + +## ReleaseAudioRoute + +``` +int32_t(* AudioAdapter::ReleaseAudioRoute) (struct AudioAdapter *adapter, int32_t routeHandle) +``` + +**描述：** + +释放一个音频路由. + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

adapter

+

待操作的音频适配器对象

+

routeHandle

+

待释放的路由句柄.

+
+ +**返回：** + +成功返回值0，失败返回负值 + +## SetPassthroughMode + +``` +int(* AudioAdapter::SetPassthroughMode) (struct AudioAdapter *adapter, struct AudioPort *port, enum AudioPortPassthroughMode mode) +``` + +**描述：** + +设置音频端口驱动的数据透传模式 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

adapter

+

待操作的音频适配器对象

+

port

+

待设置的端口

+

mode

+

待设置的传输模式

+
+ +**返回：** + +成功返回值0，失败返回负值 + +**参见：** + +[GetPassthroughMode](_audio_adapter.md#abd8f7f086993cb4ce34d01190db6cc11) + +## UpdateAudioRoute + +``` +int32_t(* AudioAdapter::UpdateAudioRoute) (struct AudioAdapter *adapter, const struct AudioRoute *route, int32_t *routeHandle) +``` + +**描述：** + +更新一个或多个发送端和接受端之间的路由 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

adapter

+

待操作的音频适配器对象

+

route

+

路由信息

+

routeHandle

+

生成的路由句柄

+
+ +**返回：** + +成功返回值0，失败返回负值 + diff --git a/zh-cn/device-dev/api/toctopics/_audio_adapter_descriptor.md b/zh-cn/device-dev/api/toctopics/_audio_adapter_descriptor.md new file mode 100644 index 0000000000..e099ef9867 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_audio_adapter_descriptor.md @@ -0,0 +1,41 @@ +# AudioAdapterDescriptor + +## **概述** + +**所属模块:** + +[Audio](_audio.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

adapterName

+

音频适配器的名称。

+

portNum

+

一个音频适配器支持的端口数目。

+

ports

+

一个音频适配器支持的端口列表。

+
+ +## **详细描述** + +音频适配器描述符。 + diff --git a/zh-cn/device-dev/api/toctopics/_audio_attribute.md b/zh-cn/device-dev/api/toctopics/_audio_attribute.md new file mode 100644 index 0000000000..20f30a4395 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_audio_attribute.md @@ -0,0 +1,427 @@ +# AudioAttribute + +## **概述** + +**所属模块:** + +[Audio](_audio.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

( GetFrameSize )(AudioHandle handle, uint64_t *size)

+

获取音频帧（frame）的大小 更多...

+

( GetFrameCount )(AudioHandle handle, uint64_t *count)

+

获取音频buffer中的音频帧数 更多...

+

( SetSampleAttributes )(AudioHandle handle, const struct AudioSampleAttributes *attrs)

+

设置音频采样的属性参数 更多...

+

( GetSampleAttributes )(AudioHandle handle, struct AudioSampleAttributes *attrs)

+

获取音频采样的属性参数 更多...

+

( GetCurrentChannelId )(AudioHandle handle, uint32_t *channelId)

+

获取音频的数据通道ID 更多...

+

( SetExtraParams )(AudioHandle handle, const char *keyValueList)

+

设置音频拓展参数 更多...

+

( GetExtraParams )(AudioHandle handle, char *keyValueList)

+

获取音频拓展参数 更多...

+

( ReqMmapBuffer )(AudioHandle handle, int32_t reqSize, struct AudioMmapBufferDescripter *desc)

+

请求mmap缓冲区 更多...

+

( GetMmapPosition )(AudioHandle handle, uint64_t *frames, struct AudioTimeStamp *time)

+

获取当前mmap的读/写位置 更多...

+
+ +## **详细描述** + +AudioAttribute音频属性接口 + +提供音频播放（render）或录音（capture）需要的公共属性驱动能力，包括获取帧（frame）信息、设置采样属性等。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## **类成员变量说明** + +## GetCurrentChannelId + +``` +int32_t(* AudioAttribute::GetCurrentChannelId) (AudioHandle handle, uint32_t *channelId) +``` + +**描述：** + +获取音频的数据通道ID + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

handle

+

待操作的音频句柄

+

channelId

+

获取的通道ID保存到channelId中

+
+ +**返回：** + +成功返回值0，失败返回负值 + +## GetExtraParams + +``` +int32_t(* AudioAttribute::GetExtraParams) (AudioHandle handle, char *keyValueList) +``` + +**描述：** + +获取音频拓展参数。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

handle

+

待操作的音频句柄

+

keyValueList

+

拓展参数键值对字符串列表，格式为key=value，多个键值对通过分号分割

+
+ +**返回：** + +成功返回值0，失败返回负值。 + +## GetFrameCount + +``` +int32_t(* AudioAttribute::GetFrameCount) (AudioHandle handle, uint64_t *count) +``` + +**描述：** + +获取音频buffer中的音频帧数。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

handle

+

待操作的音频句柄

+

count

+

一个音频buffer中包含的音频帧数，获取后保存到count中

+
+ +**返回：** + +成功返回值0，失败返回负值 + +## GetFrameSize + +``` +int32_t(* AudioAttribute::GetFrameSize) (AudioHandle handle, uint64_t *size) +``` + +**描述：** + +获取音频帧（frame）的大小 + +获取一帧音频数据的长度（字节数） + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

handle

+

待操作的音频句柄

+

size

+

获取的音频帧大小（字节数）保存到size中

+
+ +**返回：** + +成功返回值0，失败返回负值 + +## GetMmapPosition + +``` +int32_t(* AudioAttribute::GetMmapPosition) (AudioHandle handle, uint64_t *frames, struct AudioTimeStamp *time) +``` + +**描述：** + +获取当前mmap的读/写位置 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

handle

+

待操作的音频句柄

+

frames

+

获取的音频帧计数保存到frames中

+

time

+

获取的关联时间戳保存到time中

+
+ +**返回：** + +成功返回值0，失败返回负值 + +## GetSampleAttributes + +``` +int32_t(* AudioAttribute::GetSampleAttributes) (AudioHandle handle, struct AudioSampleAttributes *attrs) +``` + +**描述：** + +获取音频采样的属性参数。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

handle

+

待操作的音频句柄

+

attrs

+

获取的音频采样属性（例如采样频率、采样精度、通道）保存到attrs中

+
+ +**返回：** + +成功返回值0，失败返回负值 + +**参见：** + +[SetSampleAttributes](_audio_attribute.md#a502fe4e4b97cd253244debcc67d45c4d) + +## ReqMmapBuffer + +``` +int32_t(* AudioAttribute::ReqMmapBuffer) (AudioHandle handle, int32_t reqSize, struct AudioMmapBufferDescripter *desc) +``` + +**描述：** + +请求mmap缓冲区 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

handle

+

待操作的音频句柄

+

reqSize

+

请求缓冲区的大小

+

desc

+

缓冲区描述符

+
+ +**返回：** + +成功返回值0，失败返回负值 + +## SetExtraParams + +``` +int32_t(* AudioAttribute::SetExtraParams) (AudioHandle handle, const char *keyValueList) +``` + +**描述：** + +设置音频拓展参数。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

handle

+

待操作的音频句柄

+

keyValueList

+

拓展参数键值对字符串列表，格式为key=value，多个键值对通过分号分割

+
+ +**返回：** + +成功返回值0，失败返回负值 + +## SetSampleAttributes + +``` +int32_t(* AudioAttribute::SetSampleAttributes) (AudioHandle handle, const struct AudioSampleAttributes *attrs) +``` + +**描述：** + +设置音频采样的属性参数。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

handle

+

待操作的音频句柄

+

attrs

+

待设置的音频采样属性，例如采样频率、采样精度、通道

+
+ +**返回：** + +成功返回值0，失败返回负值 + +**参见：** + +[GetSampleAttributes](_audio_attribute.md#a2f92d8704ef677a07d664c33342e4318) + diff --git a/zh-cn/device-dev/api/toctopics/_audio_capture.md b/zh-cn/device-dev/api/toctopics/_audio_capture.md new file mode 100644 index 0000000000..381b0738cb --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_audio_capture.md @@ -0,0 +1,149 @@ +# AudioCapture + +## **概述** + +**所属模块:** + +[Audio](_audio.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

control

+

音频控制能力接口，详情参考AudioControl

+

attr

+

音频属性能力接口，详情参考AudioAttribute

+

scene

+

音频场景能力接口，详情参考AudioScene

+

volume

+

音频音量能力接口，详情参考AudioVolume

+

( CaptureFrame )(struct AudioCapture *capture, void *frame, uint64_t requestBytes, uint64_t *replyBytes)

+

从音频驱动中录制（capture）一帧输入数据（录音，音频上行数据） 更多...

+

( GetCapturePosition )(struct AudioCapture *capture, uint64_t *frames, struct AudioTimeStamp *time)

+

获取音频输入帧数的上一次计数 更多...

+
+ +## **详细描述** + +AudioCapture音频录音接口。 + +## **类成员变量说明** + +## CaptureFrame + +``` +int32_t(* AudioCapture::CaptureFrame) (struct AudioCapture *capture, void *frame, uint64_t requestBytes, uint64_t *replyBytes) +``` + +**描述：** + +从音频驱动中录制（capture）一帧输入数据（录音，音频上行数据） + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

capture

+

待操作的音频录音接口对象

+

frame

+

待存放输入数据的音频frame

+

requestBytes

+

待存放输入数据的音频frame大小（字节数）

+

replyBytes

+

实际读取到的音频数据长度（字节数），获取后保存到replyBytes中

+
+ +**返回：** + +成功返回值0，失败返回负值 + +## GetCapturePosition + +``` +int32_t(* AudioCapture::GetCapturePosition) (struct AudioCapture *capture, uint64_t *frames, struct AudioTimeStamp *time) +``` + +**描述：** + +获取音频输入帧数的上一次计数 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

capture

+

待操作的音频录音接口对象

+

frames

+

获取的音频帧计数保存到frames中

+

time

+

获取的关联时间戳保存到time中

+
+ +**返回：** + +成功返回值0，失败返回负值 + +**参见：** + +[CaptureFrame](_audio_capture.md#a89f1baf4b6177f91b9135e86cc8681da) + diff --git a/zh-cn/device-dev/api/toctopics/_audio_control.md b/zh-cn/device-dev/api/toctopics/_audio_control.md new file mode 100644 index 0000000000..38693eebd7 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_audio_control.md @@ -0,0 +1,316 @@ +# AudioControl + +## **概述** + +**所属模块:** + +[Audio](_audio.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

( Start )(AudioHandle handle)

+

启动一个音频播放（render）或录音（capture）处理 更多...

+

( Stop )(AudioHandle handle)

+

停止一个音频播放（render）或录音（capture）处理 更多...

+

( Pause )(AudioHandle handle)

+

暂停一个音频播放（render）或录音（capture）处理 更多...

+

( Resume )(AudioHandle handle)

+

恢复一个音频播放（render）或录音（capture）处理 更多...

+

( Flush )(AudioHandle handle)

+

刷新音频缓冲区buffer中的数据 更多...

+

( TurnStandbyMode )(AudioHandle handle)

+

设置或去设置设备的待机模式 更多...

+

( AudioDevDump )(AudioHandle handle, int32_t range, int32_t fd)

+

Dump音频设备信息 更多...

+
+ +## **详细描述** + +AudioControl音频控制接口。 + +提供音频播放（render）或录音（capture）需要的公共控制驱动能力，包括Start、Stop、Pause、Resume、Flush等。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## **类成员变量说明** + +## AudioDevDump + +``` +int32_t(* AudioControl::AudioDevDump) (AudioHandle handle, int32_t range, int32_t fd) +``` + +**描述：** + +Dump音频设备信息 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

handle

+

待操作的音频句柄

+

range

+

Dump信息范围，分为简要信息、全量信息

+

fd

+

指定Dump目标文件

+
+ +**返回：** + +成功返回值0，失败返回负值 + +## Flush + +``` +int32_t(* AudioControl::Flush) (AudioHandle handle) +``` + +**描述：** + +刷新音频缓冲区buffer中的数据 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

handle

+

待操作的音频句柄

+
+ +**返回：** + +成功返回值0，失败返回负值 + +## Pause + +``` +int32_t(* AudioControl::Pause) (AudioHandle handle) +``` + +**描述：** + +暂停一个音频播放（render）或录音（capture）处理 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

handle

+

待操作的音频句柄

+
+ +**返回：** + +成功返回值0，失败返回负值 + +**参见：** + +[Resume](_audio_control.md#ac59c3e9a5ff9041989871f67253a1e8d) + +## Resume + +``` +int32_t(* AudioControl::Resume) (AudioHandle handle) +``` + +**描述：** + +恢复一个音频播放（render）或录音（capture）处理 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

handle

+

待操作的音频句柄

+
+ +**返回：** + +成功返回值0，失败返回负值 + +**参见：** + +[Pause](_audio_control.md#a16a26deffa17b9f143f602763a260908) + +## Start + +``` +int32_t(* AudioControl::Start) (AudioHandle handle) +``` + +**描述：** + +启动一个音频播放（render）或录音（capture）处理 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

handle

+

待操作的音频句柄

+
+ +**返回：** + +成功返回值0，失败返回负值 + +**参见：** + +[Stop](_audio_control.md#a62e385e391ba1efed35021ee67ab9449) + +## Stop + +``` +int32_t(* AudioControl::Stop) (AudioHandle handle) +``` + +**描述：** + +停止一个音频播放（render）或录音（capture）处理 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

handle

+

待操作的音频句柄

+
+ +**返回：** + +成功返回值0，失败返回负值 + +**参见：** + +[Start](_audio_control.md#a80ddae13819bb1eb348ad4b57597e930) + +## TurnStandbyMode + +``` +int32_t(* AudioControl::TurnStandbyMode) (AudioHandle handle) +``` + +**描述：** + +设置或去设置设备的待机模式 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

handle

+

待操作的音频句柄

+
+ +**返回：** + +设置设备待机模式成功返回值0，再次执行后去设置待机模式成功返回正值，失败返回负值 + diff --git a/zh-cn/device-dev/api/toctopics/_audio_dev_ext_info.md b/zh-cn/device-dev/api/toctopics/_audio_dev_ext_info.md new file mode 100644 index 0000000000..9a2baf9208 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_audio_dev_ext_info.md @@ -0,0 +1,41 @@ +# AudioDevExtInfo + +## **概述** + +**所属模块:** + +[Audio](_audio.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

moduleId

+

音频流绑定的模块ID。

+

type

+

音频端口上的PIN脚（输出、输入），详情参考AudioPortPin。

+

desc

+

地址描述。

+
+ +## **详细描述** + +音频设备拓展信息。 + diff --git a/zh-cn/device-dev/api/toctopics/_audio_device_descriptor.md b/zh-cn/device-dev/api/toctopics/_audio_device_descriptor.md new file mode 100644 index 0000000000..d14a42323a --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_audio_device_descriptor.md @@ -0,0 +1,41 @@ +# AudioDeviceDescriptor + +## **概述** + +**所属模块:** + +[Audio](_audio.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

portId

+

频端口ID。

+

pins

+

音频端口上的PIN脚（输出、输入），详情参考AudioPortPin。

+

desc

+

以字符串命名的音频设备。

+
+ +## **详细描述** + +音频场景描述符。 + diff --git a/zh-cn/device-dev/api/toctopics/_audio_manager.md b/zh-cn/device-dev/api/toctopics/_audio_manager.md new file mode 100644 index 0000000000..ebb49ff164 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_audio_manager.md @@ -0,0 +1,223 @@ +# AudioManager + +## **概述** + +**所属模块:** + +[Audio](_audio.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

( GetAllAdapters )(struct AudioAdapterManager *manager, struct AudioAdapterDescriptor **descs, int *size)

+

获取音频驱动中支持的所有适配器的列表 更多...

+

( LoadAdapter )(struct AudioAdapterManager *manager, const struct AudioAdapterDescriptor *desc, struct AudioAdapter **adapter)

+

加载一个音频适配器（声卡）的驱动 更多...

+

( UnloadAdapter )(struct AudioAdapterManager *manager, struct AudioAdapter *adapter)

+

卸载音频适配器（声卡）的驱动 更多...

+

( ReleaseAudioManagerObject )(struct AudioManager *object)

+

释放音频管理接口对象 更多...

+
+ +## **详细描述** + +AudioManager音频适配器管理接口 + +按照音频服务下发的音频适配器（声卡）描述符加载一个具体的音频适配器驱动程序 + +参见： + +[AudioAdapter](_audio_adapter.md) + +**Since：** + +1.0 + +**Version：** + +1.0 + +## **类成员变量说明** + +## GetAllAdapters + +``` +int(* AudioManager::GetAllAdapters) (struct AudioAdapterManager *manager, struct AudioAdapterDescriptor **descs, int *size) +``` + +**描述：** + +获取音频驱动中支持的所有适配器的列表 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

manager

+

待操作的音频管理接口对象

+

descs

+

获取到的音频适配器列表保存到descs中

+

size

+

获取到的音频适配器列表的长度保存到size中

+
+ +**返回：** + +成功返回值0，失败返回负值 + +**参见：** + +[LoadAdapter](_audio_manager.md#a94e701aaf2952efac2369688b0704e4d) + +## LoadAdapter + +``` +int(* AudioManager::LoadAdapter) (struct AudioAdapterManager *manager, const struct AudioAdapterDescriptor *desc, struct AudioAdapter **adapter) +``` + +**描述：** + +加载一个音频适配器（声卡）的驱动 + +加载一个具体的音频驱动，例如usb驱动，在具体实现中可能加载的是一个动态链接库（\*.so） + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

manager

+

待操作的音频管理接口对象

+

desc

+

待加载的音频适配器描述符

+

adapter

+

获取的音频适配器接口的对象实例保存到adapter中

+
+ +**返回：** + +成功返回值0，失败返回负值 + +**参见：** + +[GetAllAdapters](_audio_manager.md#a385ae18dad8e513fcfc49c3384cdf030) + +[UnloadAdapter](_audio_manager.md#a2e6760aa74554355b0379c9594937b3a) + +## ReleaseAudioManagerObject + +``` +bool(* AudioManager::ReleaseAudioManagerObject) (struct AudioManager *object) +``` + +**描述：** + +释放音频管理接口对象 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

object

+

待操作的音频管理接口对象

+
+ +**返回：** + +成功返回ture，失败返回false + +## UnloadAdapter + +``` +void(* AudioManager::UnloadAdapter) (struct AudioAdapterManager *manager, struct AudioAdapter *adapter) +``` + +**描述：** + +卸载音频适配器（声卡）的驱动 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

manager

+

待操作的音频管理接口对象

+

adapter

+

待卸载的音频适配器接口的对象

+
+ +**参见：** + +[LoadAdapter](_audio_manager.md#a94e701aaf2952efac2369688b0704e4d) + diff --git a/zh-cn/device-dev/api/toctopics/_audio_mix_ext_info.md b/zh-cn/device-dev/api/toctopics/_audio_mix_ext_info.md new file mode 100644 index 0000000000..0c99533157 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_audio_mix_ext_info.md @@ -0,0 +1,36 @@ +# AudioMixExtInfo + +## **概述** + +**所属模块:** + +[Audio](_audio.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + +

Public 属性

+

描述

+

moduleId

+

流所属模块标识符。

+

streamId

+

由调用者传递的Render或Capture标识符。

+
+ +## **详细描述** + +音轨拓展信息。 + diff --git a/zh-cn/device-dev/api/toctopics/_audio_mmap_buffer_descripter.md b/zh-cn/device-dev/api/toctopics/_audio_mmap_buffer_descripter.md new file mode 100644 index 0000000000..62c026ba4e --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_audio_mmap_buffer_descripter.md @@ -0,0 +1,51 @@ +# AudioMmapBufferDescripter + +## **概述** + +**所属模块:** + +[Audio](_audio.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

memoryAddress

+

指向mmap缓冲区的指针。

+

memoryFd

+

mmap缓冲区的文件描述符。

+

totalBufferFrames

+

缓冲区总大小，单位：帧。

+

transferFrameSize

+

传输大小，单位：帧。

+

isShareable

+

mmap缓冲区是否可以在进程间共享。

+
+ +## **详细描述** + +mmap缓冲区描述符。 + diff --git a/zh-cn/device-dev/api/toctopics/_audio_port.md b/zh-cn/device-dev/api/toctopics/_audio_port.md new file mode 100644 index 0000000000..7c2297ff07 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_audio_port.md @@ -0,0 +1,41 @@ +# AudioPort + +## **概述** + +**所属模块:** + +[Audio](_audio.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

dir

+

音频端口的类型，详情参考AudioPortDirection。

+

portId

+

音频端口的ID。

+

portName

+

音频端口的名称。

+
+ +## **详细描述** + +音频端口。 + diff --git a/zh-cn/device-dev/api/toctopics/_audio_port_cap.md b/zh-cn/device-dev/api/toctopics/_audio_port_cap.md new file mode 100644 index 0000000000..5a41e710be --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_audio_port_cap.md @@ -0,0 +1,88 @@ +# AudioPortCap + +## **概述** + +**所属模块:** + +[Codec](_codec.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

sampleFormats [SAMPLE_FMT_NUM]

+

支持的音频采样格式，详见AudioSampleFormat。

+

sampleRate [SAMPLE_RATE_NUM]

+

支持的音频采样率，详见AudioSampleRate。

+

channelLayouts [CHANNEL_NUM]

+

支持的音频通道数channel layouts。

+

channelCount [CHANNEL_NUM]

+

支持的音频通道数。

+
+ +## **详细描述** + +定义音频编解码能力。 + +## **类成员变量说明** + +## channelCount + +``` +int32_t AudioPortCap::channelCount[CHANNEL_NUM] +``` + +**描述：** + +支持的音频通道数 + +## channelLayouts + +``` +int32_t AudioPortCap::channelLayouts[CHANNEL_NUM] +``` + +**描述：** + +支持的音频通道数channel layouts + +## sampleFormats + +``` +int32_t AudioPortCap::sampleFormats[SAMPLE_FMT_NUM] +``` + +**描述：** + +支持的音频采样格式，详见[AudioSampleFormat](_codec.md#ga97cfd5633b2133e7ebe42dbb9b03e757) + +## sampleRate + +``` +int32_t AudioPortCap::sampleRate[SAMPLE_RATE_NUM] +``` + +**描述：** + +支持的音频采样率，详见[AudioSampleRate](_codec.md#gaa0280074adafe6d2581d31f71512b842) + diff --git a/zh-cn/device-dev/api/toctopics/_audio_port_capability.md b/zh-cn/device-dev/api/toctopics/_audio_port_capability.md new file mode 100644 index 0000000000..62bf864522 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_audio_port_capability.md @@ -0,0 +1,86 @@ +# AudioPortCapability + +## **概述** + +**所属模块:** + +[Audio](_audio.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

deviceType

+

设备输出、输入类型。

+

deviceId

+

绑定（bind）设备ID，唯一的设备识别符。

+

hardwareMode

+

是否支持设备绑定处理。

+

formatNum

+

支持的音频格式数目。

+

formats

+

支持的音频格式，详情参考AudioFormat。

+

sampleRateMasks

+

支持的音频采样频率（8k、16k、32k、48k）。

+

channelMasks

+

设备的声道布局掩码（mask），详情参考AudioChannelMask。

+

channelCount

+

支持的最大声道总数。

+

subPortsNum

+

支持的子端口数目（仅用于输出设备）。

+

subPorts

+

支持的子端口列表。

+

supportSampleFormatNum

+

支持的音频样本格式数量。

+

supportSampleFormats

+

支持的音频样本格式，详请参考AudioSampleFormat。

+
+ +## **详细描述** + +音频端口的支持能力。 + diff --git a/zh-cn/device-dev/api/toctopics/_audio_render.md b/zh-cn/device-dev/api/toctopics/_audio_render.md new file mode 100644 index 0000000000..5b8a9476aa --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_audio_render.md @@ -0,0 +1,485 @@ +# AudioRender + +## **概述** + +**所属模块:** + +[Audio](_audio.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

control

+

音频控制能力接口，详情参考AudioControl

+

attr

+

音频属性能力接口，详情参考AudioAttribute

+

scene

+

音频场景能力接口，详情参考AudioScene

+

volume

+

音频音量能力接口，详情参考AudioVolume

+

( GetLatency )(struct AudioRender *render, uint32_t *ms)

+

获取音频硬件驱动估计的延迟时间 更多...

+

( RenderFrame )(struct AudioRender *render, const void *frame, uint64_t requestBytes, uint64_t *replyBytes)

+

往音频驱动中播放（render）一帧输出数据（放音，音频下行数据） 更多...

+

( GetRenderPosition )(struct AudioRender *render, uint64_t *frames, struct AudioTimeStamp *time)

+

获取音频输出帧数的上一次计数 更多...

+

( SetRenderSpeed )(struct AudioRender *render, float speed)

+

设置一个音频的播放速度 更多...

+

( GetRenderSpeed )(struct AudioRender *render, float *speed)

+

获取一个音频当前的播放速度 更多...

+

( SetChannelMode )(struct AudioRender *render, enum AudioChannelMode mode)

+

设置音频播放的通道模式 更多...

+

( GetChannelMode )(struct AudioRender *render, enum AudioChannelMode *mode)

+

获取音频播放当前的通道模式 更多...

+

( RegCallback )(struct AudioRender *render, RenderCallback callback, void *cookie)

+

注册音频回调函数，用于放音过程中缓冲区数据写、DrainBuffer完成通知 更多...

+

( DrainBuffer )(struct AudioRender *render, enum AudioDrainNotifyType *type)

+

排空缓冲区中的数据 更多...

+
+ +## **详细描述** + +AudioRender音频播放接口 + +提供音频播放支持的驱动能力，包括音频控制、音频属性、音频场景、音频音量、获取硬件延迟时间、播放音频帧数据（render frame）等 + +**参见：** + +[AudioControl](_audio_control.md) + +[AudioAttribute](_audio_attribute.md) + +[AudioScene](_audio_scene.md) + +[AudioVolume](_audio_volume.md) + +**Since：** + +1.0 + +**Version：** + +1.0 + +## **类成员变量说明** + +## DrainBuffer + +``` +int32_t(* AudioRender::DrainBuffer) (struct AudioRender *render, enum AudioDrainNotifyType *type) +``` + +**描述：** + +排空缓冲区中的数据 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

render

+

待操作的音频播放接口对象

+

type

+

DrainBuffer的操作类型，详情请参考AudioDrainNotifyType

+
+ +**返回：** + +成功返回值0，失败返回负值 + +**参见：** + +[RegCallback](_audio_render.md#acb40275d0f402e8e38539e71f89f31a1) + +## GetChannelMode + +``` +int32_t(* AudioRender::GetChannelMode) (struct AudioRender *render, enum AudioChannelMode *mode) +``` + +**描述：** + +获取音频播放当前的通道模式 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

render

+

待操作的音频播放接口对象

+

mode

+

获取的通道模式保存到mode中

+
+ +**返回：** + +成功返回值0，失败返回负值 + +**参见：** + +[SetChannelMode](_audio_render.md#ae5aad5b26ccdd65ba501620851c5ecec) + +## GetLatency + +``` +int32_t(* AudioRender::GetLatency) (struct AudioRender *render, uint32_t *ms) +``` + +**描述：** + +获取音频硬件驱动估计的延迟时间 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

render

+

待操作的音频播放接口对象

+

ms

+

获取的延迟时间（单位：毫秒）保存到ms中

+
+ +**返回：** + +成功返回值0，失败返回负值 + +## GetRenderPosition + +``` +int32_t(* AudioRender::GetRenderPosition) (struct AudioRender *render, uint64_t *frames, struct AudioTimeStamp *time) +``` + +**描述：** + +获取音频输出帧数的上一次计数 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

render

+

待操作的音频播放接口对象

+

frames

+

获取的音频帧计数保存到frames中

+

time

+

获取的关联时间戳保存到time中

+
+ +**返回：** + +成功返回值0，失败返回负值 + +**参见：** + +[RenderFrame](_audio_render.md#a463cab04d0805a5c7b3ba5884c468246) + +## GetRenderSpeed + +``` +int32_t(* AudioRender::GetRenderSpeed) (struct AudioRender *render, float *speed) +``` + +**描述：** + +获取一个音频当前的播放速度 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

render

+

待操作的音频播放接口对象

+

speed

+

获取的播放速度保存到speed中

+
+ +**返回：** + +成功返回值0，失败返回负值 + +**参见：** + +[SetRenderSpeed](_audio_render.md#a5589427ae5a4ba6a8d2a19dd8eddbcd8) + +## RegCallback + +``` +int32_t(* AudioRender::RegCallback) (struct AudioRender *render, RenderCallback callback, void *cookie) +``` + +**描述：** + +注册音频回调函数，用于放音过程中缓冲区数据写、DrainBuffer完成通知 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

render

+

待操作的音频播放接口对象

+

callback

+

注册的回调函数

+

cookie

+

回调函数的入参

+
+ +**返回：** + +成功返回值0，失败返回负值 + +**参见：** + +[RegCallback](_audio_render.md#acb40275d0f402e8e38539e71f89f31a1) + +## RenderFrame + +``` +int32_t(* AudioRender::RenderFrame) (struct AudioRender *render, const void *frame, uint64_t requestBytes, uint64_t *replyBytes) +``` + +**描述：** + +往音频驱动中播放（render）一帧输出数据（放音，音频下行数据） + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

render

+

待操作的音频播放接口对象

+

frame

+

待写入的输出数据的音频frame

+

requestBytes

+

待写入的输出数据的音频frame大小（字节数）

+

replyBytes

+

实际写入的音频数据长度（字节数），获取后保存到replyBytes中

+
+ +**返回：** + +成功返回值0，失败返回负值 + +## SetChannelMode + +``` +int32_t(* AudioRender::SetChannelMode) (struct AudioRender *render, enum AudioChannelMode mode) +``` + +**描述：** + +设置音频播放的通道模式 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

render

+

待操作的音频播放接口对象

+

speed

+

待设置的通道模式

+
+ +**返回：** + +成功返回值0，失败返回负值 + +**参见：** + +[GetChannelMode](_audio_render.md#aad3d5e4104167620eacb2ba23edce50e) + +## SetRenderSpeed + +``` +int32_t(* AudioRender::SetRenderSpeed) (struct AudioRender *render, float speed) +``` + +**描述：** + +设置一个音频的播放速度 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

render

+

待操作的音频播放接口对象

+

speed

+

待设置的播放速度

+
+ +**返回：** + +成功返回值0，失败返回负值 + +**参见：** + +[GetRenderSpeed](_audio_render.md#af0a19dacb293d3fbe600902b93af1ee9) + diff --git a/zh-cn/device-dev/api/toctopics/_audio_route.md b/zh-cn/device-dev/api/toctopics/_audio_route.md new file mode 100644 index 0000000000..a98417b8fe --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_audio_route.md @@ -0,0 +1,46 @@ +# AudioRoute + +## **概述** + +**所属模块:** + +[Audio](_audio.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

sourcesNum

+

发送端节点数量。

+

sources

+

发送端列表。

+

sinksNum

+

接受端节点数量。

+

sinks

+

接受端列表。

+
+ +## **详细描述** + +音频路由信息。 + diff --git a/zh-cn/device-dev/api/toctopics/_audio_route_node.md b/zh-cn/device-dev/api/toctopics/_audio_route_node.md new file mode 100644 index 0000000000..58bbd422d5 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_audio_route_node.md @@ -0,0 +1,56 @@ +# AudioRouteNode + +## **述** + +**所属模块:** + +[Audio](_audio.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

portId

+

音频端口ID。

+

role

+

指定端口角色为sink或source。

+

type

+

指定端口类型。

+

device

+

设备特定信息。

+

mix

+

音轨特定信息。

+

session

+

会话特定信息。

+
+ +## **详细描述** + +音频路由节点。 + diff --git a/zh-cn/device-dev/api/toctopics/_audio_sample_attributes.md b/zh-cn/device-dev/api/toctopics/_audio_sample_attributes.md new file mode 100644 index 0000000000..3ef1f782a5 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_audio_sample_attributes.md @@ -0,0 +1,91 @@ +# AudioSampleAttributes + +## **概述** + +**所属模块:** + +[Audio](_audio.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

type

+

音频类型，详情参考AudioCategory。

+

interleaved

+

音频数据交织的标记。

+

format

+

音频数据格式，详情参考AudioFormat。

+

sampleRate

+

音频采样频率。

+

channelCount

+

音频通道数目，如单通道（mono）为1、立体声（stereo）为2。

+

period

+

音频采样周期。

+

frameSize

+

音频数据的帧大小。

+

isBigEndian

+

音频数据的大端标志。

+

isSignedData

+

音频数据的有符号或无符号标志。

+

startThreshold

+

音频渲染开始阈值。

+

stopThreshold

+

音频渲染停止阈值。

+

silenceThreshold

+

音频捕获缓冲区阈值。

+

streamId

+

渲染或捕获的音频标识符。

+
+ +## **详细描述** + +音频采样属性。 + diff --git a/zh-cn/device-dev/api/toctopics/_audio_scene.md b/zh-cn/device-dev/api/toctopics/_audio_scene.md new file mode 100644 index 0000000000..8590da5c80 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_audio_scene.md @@ -0,0 +1,140 @@ +# AudioScene + +## **概述** + +**所属模块:** + +[Audio](_audio.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + +

Public 属性

+

描述

+

( CheckSceneCapability )(AudioHandle handle, const struct AudioSceneDescriptor *scene, bool *supported)

+

是否支持某个音频场景的配置 更多...

+

( SelectScene )(AudioHandle handle, const struct AudioSceneDescriptor *scene)

+

选择音频场景 更多...

+
+ +## **详细描述** + +AudioScene音频场景接口。 + +提供音频播放（render）或录音（capture）需要的公共场景驱动能力，包括选择音频场景等。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## **类成员变量说明** + +## CheckSceneCapability + +``` +int32_t(* AudioScene::CheckSceneCapability) (AudioHandle handle, const struct AudioSceneDescriptor *scene, bool *supported) +``` + +**描述：** + +是否支持某个音频场景的配置 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

handle

+

待操作的音频句柄

+

scene

+

待获取的音频场景描述符

+

supported

+

是否支持的状态保存到supported中，true表示支持，false表示不支持

+
+ +**返回：** + +成功返回值0，失败返回负值 + +**参见：** + +[SelectScene](_audio_scene.md#aacdbf3a9f488a7e71f3a5a23c68c0068) + +## SelectScene + +``` +int32_t(* AudioScene::SelectScene) (AudioHandle handle, const struct AudioSceneDescriptor *scene) +``` + +**描述：** + +选择音频场景 + +1. 选择一个非常具体的音频场景（应用场景和输出设备的组合），例如同样是使用手机中的喇叭作为输出设备 + - 在媒体播放场景scene为media\_speaker + - 在语音通话免提场景scene为voice\_speaker + +2. 只是选择一个音频场景，例如使用场景为媒体播放（media）、电影播放（movie）、游戏播放（game） +3. 只是选择一个音频输出设备，例如输出设备为听筒（receiver）、喇叭（speaker）、有线耳机（headset） + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

handle

+

待操作的音频句柄

+

scene

+

待设置的音频场景描述符

+
+ +**返回：** + +成功返回值0，失败返回负值 + +**参见：** + +[CheckSceneCapability](_audio_scene.md#a9b485404b2ec3b8bc2b8d1b73401d45c) + diff --git a/zh-cn/device-dev/api/toctopics/_audio_scene_descriptor.md b/zh-cn/device-dev/api/toctopics/_audio_scene_descriptor.md new file mode 100644 index 0000000000..af412ad07b --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_audio_scene_descriptor.md @@ -0,0 +1,53 @@ +# AudioSceneDescriptor + +## **概述** + +**所属模块:** + +[Audio](_audio.md)[更多...](union_audio_scene_descriptor_1_1_scene_desc.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

SceneDesc

+

音频场景描述 AudioSceneDescriptor::SceneDesc

+
+ +## Public 属性 + + + + + + + + + + + + + +

Public 属性

+

描述

+

scene

+

音频场景的名称。

+

desc

+

音频设备描述符。

+
+ +## **详细描述** + +音频场景描述符。 + diff --git a/zh-cn/device-dev/api/toctopics/_audio_session_ext_info.md b/zh-cn/device-dev/api/toctopics/_audio_session_ext_info.md new file mode 100644 index 0000000000..c78870ea99 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_audio_session_ext_info.md @@ -0,0 +1,31 @@ +# AudioSessionExtInfo + +## **概述** + +**所属模块:** + +[Audio](_audio.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + +

Public 属性

+

描述

+

sessionType

+

音频会话类型。

+
+ +## **详细描述** + +会话拓展信息。 + diff --git a/zh-cn/device-dev/api/toctopics/_audio_sub_port_capability.md b/zh-cn/device-dev/api/toctopics/_audio_sub_port_capability.md new file mode 100644 index 0000000000..f9e6f5592a --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_audio_sub_port_capability.md @@ -0,0 +1,41 @@ +# AudioSubPortCapability + +## **概述** + +**所属模块:** + +[Audio](_audio.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

portId

+

子端口ID。

+

desc

+

以字符串命名的子端口。

+

mask

+

数据透传模式，详情参考AudioPortPassthroughMode。

+
+ +## **详细描述** + +音频子端口的支持能力。 + diff --git a/zh-cn/device-dev/api/toctopics/_audio_time_stamp.md b/zh-cn/device-dev/api/toctopics/_audio_time_stamp.md new file mode 100644 index 0000000000..9dc33ab671 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_audio_time_stamp.md @@ -0,0 +1,38 @@ +# AudioTimeStamp + +## **概述** + +**所属模块:** + +[Audio](_audio.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + +

Public 属性

+

描述

+

tvSec

+

tvSec时间，单位：秒。

+

tvNSec

+

tvNSec时间，单位：纳秒。

+
+ +## **详细描述** + +音频时间戳。 + +时间定义，POSIX timespec的替代品。 + diff --git a/zh-cn/device-dev/api/toctopics/_audio_volume.md b/zh-cn/device-dev/api/toctopics/_audio_volume.md new file mode 100644 index 0000000000..bd40cd85ab --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_audio_volume.md @@ -0,0 +1,367 @@ +# AudioVolume + +## **概述** + +**所属模块:** + +[Audio](_audio.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

( SetMute )(AudioHandle handle, bool mute)

+

设置音频的静音状态 更多...

+

( GetMute )(AudioHandle handle, bool *mute)

+

获取音频的静音状态 更多...

+

( SetVolume )(AudioHandle handle, float volume)

+

设置一个音频流的音量 更多...

+

( GetVolume )(AudioHandle handle, float *volume)

+

获取一个音频流的音量 更多...

+

( GetGainThreshold )(AudioHandle handle, float *min, float *max)

+

获取音频流增益的阈值 更多...

+

( GetGain )(AudioHandle handle, float *gain)

+

获取音频流的增益 更多...

+

( SetGain )(AudioHandle handle, float gain)

+

设置音频流的增益 更多...

+
+ +## **详细描述** + +AudioVolume音频音量接口。 + +提供音频播放（render）或录音（capture）需要的公共音量驱动能力，包括静音操作、设置音量、设置增益等。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## **类成员变量说明** + +## GetGain + +``` +int32_t(* AudioVolume::GetGain) (AudioHandle handle, float *gain) +``` + +**描述：** + +获取音频流的增益 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

handle

+

待操作的音频句柄

+

gain

+

保存当前获取到的增益到gain中

+
+ +**返回：** + +成功返回值0，失败返回负值 + +**参见：** + +[GetGainThreshold](_audio_volume.md#aa42ff18fa2b7e6780acf120ea49054ed) + +[SetGain](_audio_volume.md#ab667c5f8754d0b10121451a57abbe429) + +## GetGainThreshold + +``` +int32_t(* AudioVolume::GetGainThreshold) (AudioHandle handle, float *min, float *max) +``` + +**描述：** + +获取音频流增益的阈值 + +在具体的功能实现中，可以根据芯片平台的实际情况来进行处理： + +- 1. 可以使用实际的增益值，例如增益的范围为-50db \~ 6db +- 2. 也可以将增益范围设定为0.0\~1.0，如果增益的范围为-50db \~ 6db， 则增益的映射关系为0.0表示静音，1.0表示最大增益（6db） + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

handle

+

待操作的音频句柄

+

min

+

获取的音频增益的阈值下限保存到min中

+

max

+

获取的音频增益的阈值上限保存到max中

+
+ +**返回：** + +成功返回值0，失败返回负值 + +**参见：** + +[GetGain](_audio_volume.md#a5ff7f9e5b763d20822a1fadecc5a8db7) + +[SetGain](_audio_volume.md#ab667c5f8754d0b10121451a57abbe429) + +## GetMute + +``` +int32_t(* AudioVolume::GetMute) (AudioHandle handle, bool *mute) +``` + +**描述：** + +获取音频的静音状态 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

handle

+

待操作的音频句柄

+

mute

+

获取的静音状态保存到mute中，true表示静音操作、false表示取消静音操作

+
+ +**返回：** + +成功返回值0，失败返回负值 + +**参见：** + +[SetMute](_audio_volume.md#a79c127fa37eb2dbf8dc5fe9f0ed4421e) + +## GetVolume + +``` +int32_t(* AudioVolume::GetVolume) (AudioHandle handle, float *volume) +``` + +**描述：** + +获取一个音频流的音量 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

handle

+

待操作的音频句柄

+

volume

+

获取的音量保存到volume中，范围0.0~1.0

+
+ +**返回：** + +成功返回值0，失败返回负值 + +**参见：** + +[SetVolume](_audio_volume.md#aebf67caf924cba5f3be9d0f395390908) + +## SetGain + +``` +int32_t(* AudioVolume::SetGain) (AudioHandle handle, float gain) +``` + +**描述：** + +设置音频流的增益 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

handle

+

待操作的音频句柄

+

gain

+

gain 待设置的增益

+
+ +**返回：** + +成功返回值0，失败返回负值 + +**参见：** + +[GetGainThreshold](_audio_volume.md#aa42ff18fa2b7e6780acf120ea49054ed) + +[GetGain](_audio_volume.md#a5ff7f9e5b763d20822a1fadecc5a8db7) + +## SetMute + +``` +int32_t(* AudioVolume::SetMute) (AudioHandle handle, bool mute) +``` + +**描述：** + +设置音频的静音状态 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

handle

+

待操作的音频句柄

+

mute

+

待设置的静音状态，true表示静音操作、false表示取消静音操作

+
+ +**返回：** + +成功返回值0，失败返回负值 + +**参见：** + +[GetMute](_audio_volume.md#a75fcb5bda7e0ca9b823187f6056ad1d4) + +## SetVolume + +``` +int32_t(* AudioVolume::SetVolume) (AudioHandle handle, float volume) +``` + +**描述：** + +设置一个音频流的音量。 + +音量的取值范围是0.0\~1.0，如果音频服务中的音量等级为15级（0 \~ 15）， 则音量的映射关系为0.0表示静音，1.0表示最大音量等级（15） + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

handle

+

待操作的音频句柄

+

volume

+

待设置的音量，范围0.0~1.0

+
+ +**返回：** + +成功返回值0，失败返回负值 + diff --git a/zh-cn/device-dev/api/toctopics/_auth_result_info.md b/zh-cn/device-dev/api/toctopics/_auth_result_info.md new file mode 100644 index 0000000000..67b216a1f0 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_auth_result_info.md @@ -0,0 +1,111 @@ +# AuthResultInfo + +## **概述** + +**所属模块:** + +[HdfUserAuth](_hdf_user_auth.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

result

+

用户身份认证结果。

+

freezingTime

+

认证方式被冻结的时间。

+

remainTimes

+

认证方式距离被冻结的可处理认证请求次数。

+

msgs

+

执行器发送的消息。

+

token

+

用户身份认证令牌。

+
+ +## **详细描述** + +用户身份认证结果信息。 + +**Since：** + +3.2 + +**Version：** + +1.0 + +## **类成员变量说明** + +## freezingTime + +``` +int AuthResultInfo::freezingTime +``` + +**描述：** + +认证方式被冻结的时间。 + +## msgs + +``` +struct ExecutorSendMsg [] AuthResultInfo::msgs +``` + +**描述：** + +执行器发送的消息。 + +## remainTimes + +``` +int AuthResultInfo::remainTimes +``` + +**描述：** + +认证方式距离被冻结的可处理认证请求次数。 + +## result + +``` +unsigned int AuthResultInfo::result +``` + +**描述：** + +用户身份认证结果。 + +## token + +``` +unsigned char [] AuthResultInfo::token +``` + +**描述：** + +用户身份认证令牌。 + diff --git a/zh-cn/device-dev/api/toctopics/_auth_solution.md b/zh-cn/device-dev/api/toctopics/_auth_solution.md new file mode 100644 index 0000000000..59424bcf2b --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_auth_solution.md @@ -0,0 +1,111 @@ +# AuthSolution + +## **概述** + +**所属模块:** + +[HdfUserAuth](_hdf_user_auth.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

userId

+

用户ID。

+

authTrustLevel

+

认证结果可信等级。

+

authType

+

用户认证凭据类型AuthType}。

+

executorId

+

既定用户认证凭据类型的执行器ID。

+

challenge

+

挑战值，用于签发认证令牌。

+
+ +## **详细描述** + +认证方案。 + +**Since：** + +3.2 + +**Version：** + +1.0 + +## **类成员变量说明** + +## authTrustLevel + +``` +unsigned int AuthSolution::authTrustLevel +``` + +**描述：** + +认证结果可信等级。 + +## authType + +``` +enum AuthType AuthSolution::authType +``` + +**描述：** + +用户认证凭据类型AuthType\}。 + +## challenge + +``` +unsigned char [] AuthSolution::challenge +``` + +**描述：** + +挑战值，用于签发认证令牌。 + +## executorId + +``` +unsigned int AuthSolution::executorId +``` + +**描述：** + +既定用户认证凭据类型的执行器ID。 + +## userId + +``` +int AuthSolution::userId +``` + +**描述：** + +用户ID。 + diff --git a/zh-cn/device-dev/api/toctopics/_battery_info.md b/zh-cn/device-dev/api/toctopics/_battery_info.md new file mode 100644 index 0000000000..fe93f5f0e1 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_battery_info.md @@ -0,0 +1,257 @@ +# BatteryInfo + +## **概述** + +**所属模块:** + +[Battery](battery.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

capacity

+

表示电池的电量百分比。

+

voltage

+

表示电池的电压。

+

temperature

+

表示电池的温度

+

healthState

+

表示电池的健康状态。

+

pluggedType

+

表示电池的充电设备类型。

+

pluggedMaxCurrent

+

表示电池的最大充电电流。

+

pluggedMaxVoltage

+

表示电池的最大充电电压。

+

chargeState

+

表示电池的充电状态。

+

chargeCounter

+

表示电池的充电次数。

+

totalEnergy

+

表示电池的总容量。

+

curAverage

+

表示电池的平均电流。

+

curNow

+

表示电池的实时电流。

+

remainEnergy

+

表示电池的剩余容量。

+

present

+

表示是否支持电池或者电池是否在位。

+

technology

+

表示电池的技术型号。

+
+ +## **详细描述** + +电池相关信息。 + +**Since：** + +3.1 + +## **类成员变量说明** + +## capacity + +``` +int BatteryInfo::capacity +``` + +**描述：** + +表示电池的电量百分比。 + +## chargeCounter + +``` +int BatteryInfo::chargeCounter +``` + +**描述：** + +表示电池的充电次数。 + +## chargeState + +``` +int BatteryInfo::chargeState +``` + +**描述：** + +表示电池的充电状态。 + +## curAverage + +``` +int BatteryInfo::curAverage +``` + +**描述：** + +表示电池的平均电流。 + +## curNow + +``` +int BatteryInfo::curNow +``` + +**描述：** + +表示电池的实时电流。 + +## healthState + +``` +int BatteryInfo::healthState +``` + +**描述：** + +表示电池的健康状态。 + +## pluggedMaxCurrent + +``` +int BatteryInfo::pluggedMaxCurrent +``` + +**描述：** + +表示电池的最大充电电流。 + +## pluggedMaxVoltage + +``` +int BatteryInfo::pluggedMaxVoltage +``` + +**描述：** + +表示电池的最大充电电压。 + +## pluggedType + +``` +int BatteryInfo::pluggedType +``` + +**描述：** + +表示电池的充电设备类型。 + +## present + +``` +byte BatteryInfo::present +``` + +**描述：** + +表示是否支持电池或者电池是否在位。 + +## remainEnergy + +``` +int BatteryInfo::remainEnergy +``` + +**描述：** + +表示电池的剩余容量。 + +## technology + +``` +String BatteryInfo::technology +``` + +**描述：** + +表示电池的技术型号。 + +## temperature + +``` +int BatteryInfo::temperature +``` + +**描述：** + +表示电池的温度 + +## totalEnergy + +``` +int BatteryInfo::totalEnergy +``` + +**描述：** + +表示电池的总容量。 + +## voltage + +``` +int BatteryInfo::voltage +``` + +**描述：** + +表示电池的电压。 + diff --git a/zh-cn/device-dev/api/toctopics/_buffer_data.md b/zh-cn/device-dev/api/toctopics/_buffer_data.md new file mode 100644 index 0000000000..c3e36e6c38 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_buffer_data.md @@ -0,0 +1,36 @@ +# BufferData + +## **概述** + +**所属模块:** + +[Display](_display.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + +

Public 属性

+

描述

+

phyAddr

+

物理内存地址。

+

virAddr

+

虚拟内存地址。

+
+ +## **详细描述** + +定义一层的缓冲区数据，包括虚拟和物理内存地址。 + diff --git a/zh-cn/device-dev/api/toctopics/_camera.md b/zh-cn/device-dev/api/toctopics/_camera.md new file mode 100644 index 0000000000..725276f6f1 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_camera.md @@ -0,0 +1,2825 @@ +# Camera + +## **汇总** + +## 文件 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

文件

+

描述

+

icamera_device.h

+

Camera设备操作接口。

+

icamera_device_callback.h

+

Camera设备的回调接口，主要包含camera设备发生错误时和上报metadata的回调函数。

+

icamera_host.h

+

Camera服务的管理类，对上层提供HDI接口。

+

icamera_host_callback.h

+

ICameraHost的回调接口，提供Camera设备和闪关灯状态变化的回调函数，回调函数由调用者实现。

+

ioffline_stream_operator.h

+

离线流的操作接口。

+

istream_operator.h

+

流的操作接口。

+

istream_operator_callback.h

+

IStreamOperator相关的回调，这些回调均由调用者实现。

+

types.h

+

Camera模块HDI接口使用的数据类型。

+
+ +## 类 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

类

+

描述

+

OHOS::Camera::ICameraDevice

+

Camera设备操作。更多...

+

OHOS::Camera::ICameraDeviceCallback

+

Camera设备操作回调。更多...

+

OHOS::Camera::ICameraHost

+

Camera服务的管理类。更多...

+

OHOS::Camera::ICameraHostCallback

+

Camera服务的管理回调。更多...

+

OHOS::Camera::IOfflineStreamOperator

+

离线流的操作类。更多...

+

OHOS::Camera::IStreamOperator

+

流的操作类。更多...

+

OHOS::Camera::IStreamOperatorCallback

+

流的操作回调类。更多...

+

OHOS::Camera::StreamInfo

+

流信息，用于创建流时传入相关的配置参数。 更多...

+

OHOS::Camera::StreamAttribute

+

流的属性。 更多...

+

OHOS::Camera::CaptureInfo

+

捕获请求的相关信息。 更多...

+

OHOS::Camera::CaptureEndedInfo

+

捕获结束相关信息，用于捕获结束回调 OnCaptureEnded。 更多...

+

OHOS::Camera::CaptureErrorInfo

+

流错误信息，用于回调 OnCaptureError。 更多...

+
+ +## 类型定义 + + + + + + + + + + + + + + + + +

类型定义

+

描述

+

OHOS::Camera::CameraAbility = CameraMetadata

+

Camera设备能力集合。

+

OHOS::Camera::CameraSetting = CameraMetadata

+

Camera设置参数，包括sensor帧率，3A相关参数等。

+

OHOS::Camera::MetaType = int32_t

+

整型。

+
+ +## 枚举 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举

+

描述

+

OHOS::Camera::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接口的返回值。 更多...

+

OHOS::Camera::ResultCallbackMode : int32_t { OHOS::Camera::PER_FRAME, OHOS::Camera::ON_CHANGED }

+

metadata的上报模式。 更多...

+

OHOS::Camera::OperationMode : int32_t { OHOS::Camera::NORMAL = 0 }

+

流的使用模式。 更多...

+

OHOS::Camera::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 }

+

流的类型。 更多...

+

OHOS::Camera::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 }

+

流数据的编码类型。 更多...

+

OHOS::Camera::StreamSupportType : int32_t { OHOS::Camera::DYNAMIC_SUPPORTED, OHOS::Camera::RE_CONFIGURED_REQUIRED, OHOS::Camera::NOT_SUPPORTED }

+

动态配置流的切换方式，使用场景参考 IsStreamsSupported 。 更多...

+

OHOS::Camera::CameraStatus { OHOS::Camera::UN_AVAILABLE = 0, OHOS::Camera::AVAILABLE = 1 }

+

Camera设备状态。 更多...

+

OHOS::Camera::FlashlightStatus : uint32_t { OHOS::Camera::FLASHLIGHT_OFF = 0, OHOS::Camera::FLASHLIGHT_ON = 1, OHOS::Camera::FLASHLIGHT_UNAVAILABLE = 2 }

+

闪光灯状态。 更多...

+

OHOS::Camera::CameraEvent : uint32_t { OHOS::Camera::CAMERA_EVENT_DEVICE_ADD = 0, OHOS::Camera::CAMERA_EVENT_DEVICE_RMV = 1 }

+

Camera事件。 更多...

+

OHOS::Camera::ErrorType : uint32_t { OHOS::Camera::FATAL_ERROR = 0, OHOS::Camera::REQUEST_TIMEOUT = 1 }

+

设备错误类型，用于设备错误回调 OnError。 更多...

+

OHOS::Camera::StreamError { OHOS::Camera::UNKNOWN_ERROR = 0, OHOS::Camera::BUFFER_LOST = 1 }

+

流错误类型，用于流错误类型 CaptureErrorInfo。 更多...

+
+ +## 函数 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

函数

+

描述

+

OHOS::Camera::ICameraDevice::DECLARE_INTERFACE_DESCRIPTOR (u"HDI.Camera.V1_0.Device")

+

IPC通信token校验。

+

OHOS::Camera::ICameraDevice::GetStreamOperator (const OHOS::sptr< IStreamOperatorCallback > &callback, OHOS::sptr< IStreamOperator > &streamOperator)=0

+

获取流操作句柄。 更多...

+

OHOS::Camera::ICameraDevice::UpdateSettings (const std::shared_ptr< CameraSetting > &settings)=0

+

更新设备控制参数。 更多...

+

OHOS::Camera::ICameraDevice::SetResultMode (const ResultCallbackMode &mode)=0

+

设置metadata上报模式，逐帧上报还是设备状态变化时上报。 更多...

+

OHOS::Camera::ICameraDevice::GetEnabledResults (std::vector< MetaType > &results)=0

+

查询使能的metadata。 更多...

+

OHOS::Camera::ICameraDevice::EnableResult (const std::vector< MetaType > &results)=0

+

打开metadata上报开关。 更多...

+

OHOS::Camera::ICameraDevice::DisableResult (const std::vector< MetaType > &results)=0

+

关闭metadata上报开关。 更多...

+

OHOS::Camera::ICameraDevice::Close ()=0

+

关闭Camera设备。 更多...

+

OHOS::Camera::ICameraDeviceCallback::DECLARE_INTERFACE_DESCRIPTOR (u"HDI.Camera.V1_0.DeviceCallback")

+

IPC通信token校验。

+

OHOS::Camera::ICameraDeviceCallback::OnError (ErrorType type, int32_t errorCode)=0

+

设备发生错误时调用，由调用者实现，用于返回错误信息给调用者。 更多...

+

OHOS::Camera::ICameraDeviceCallback::OnResult (uint64_t timestamp, const std::shared_ptr< CameraMetadata > &result)=0

+

上报camera设备相关的metadata的回调，上报方式查看 SetResultMode。 更多...

+

OHOS::Camera::ICameraHost::DECLARE_INTERFACE_DESCRIPTOR (u"HDI.Camera.V1_0.Host")

+

IPC通信token校验。

+

OHOS::Camera::ICameraHost::Get (const char *serviceName)

+

获取ICameraHost实例。 更多...

+

OHOS::Camera::ICameraHost::SetCallback (const OHOS::sptr< ICameraHostCallback > &callback)=0

+

设置ICameraHost回调接口，回调函数参考 ICameraHostCallback。 更多...

+

OHOS::Camera::ICameraHost::GetCameraIds (std::vector< std::string > &cameraIds)=0

+

获取当前可用的Camera设备ID列表。 更多...

+

OHOS::Camera::ICameraHost::GetCameraAbility (const std::string &cameraId, std::shared_ptr< CameraAbility > &ability)=0

+

获取Camera设备能力集合。 更多...

+

OHOS::Camera::ICameraHost::OpenCamera (const std::string &cameraId, const OHOS::sptr< ICameraDeviceCallback > &callback, OHOS::sptr< ICameraDevice > &device)=0

+

打开Camera设备。 更多...

+

OHOS::Camera::ICameraHost::SetFlashlight (const std::string &cameraId, bool &isEnable)=0

+

打开或关闭闪光灯。 更多...

+

OHOS::Camera::ICameraHostCallback::DECLARE_INTERFACE_DESCRIPTOR (u"HDI.Camera.V1_0.HostCallback")

+

IPC通信token校验。

+

OHOS::Camera::ICameraHostCallback::OnCameraStatus (const std::string &cameraId, CameraStatus status)=0

+

用于Camera设备状态变化时上报状态信息给调用者。 更多...

+

OHOS::Camera::ICameraHostCallback::OnFlashlightStatus (const std::string &cameraId, FlashlightStatus status)=0

+

用于在闪光灯状态变化时上报状态信息给调用者。 更多...

+

OHOS::Camera::ICameraHostCallback::OnCameraEvent (const std::string &cameraId, CameraEvent event)=0

+

在相机事件发生时调用。 更多...

+

OHOS::Camera::IOfflineStreamOperator::DECLARE_INTERFACE_DESCRIPTOR (u"HDI.Camera.V1_0.OfflineStreamOperator")

+

IPC通信token校验。

+

OHOS::Camera::IOfflineStreamOperator::CancelCapture (int captureId)=0

+

取消捕获请求。 更多...

+

OHOS::Camera::IOfflineStreamOperator::ReleaseStreams (const std::vector< int > &streamIds)=0

+

释放离线流。 更多...

+

OHOS::Camera::IOfflineStreamOperator::Release ()=0

+

释放所有离线流。 更多...

+

OHOS::Camera::IStreamOperator::DECLARE_INTERFACE_DESCRIPTOR (u"HDI.Camera.V1_0.StreamOperator")

+

IPC通信token校验。

+

OHOS::Camera::IStreamOperator::IsStreamsSupported (OperationMode mode, const std::shared_ptr< CameraMetadata > &modeSetting, const std::vector< std::shared_ptr< StreamInfo >> &info, StreamSupportType &type)=0

+

查询是否支持添加参数对应的流 更多...

+

OHOS::Camera::IStreamOperator::CreateStreams (const std::vector< std::shared_ptr< StreamInfo >> &streamInfos)=0

+

创建流。 更多...

+

OHOS::Camera::IStreamOperator::ReleaseStreams (const std::vector< int > &streamIds)=0

+

释放流。 更多...

+

OHOS::Camera::IStreamOperator::CommitStreams (OperationMode mode, const std::shared_ptr< CameraMetadata > &modeSetting)=0

+

配置流。 更多...

+

OHOS::Camera::IStreamOperator::GetStreamAttributes (std::vector< std::shared_ptr< StreamAttribute >> &attributes)=0

+

获取流的属性。 更多...

+

OHOS::Camera::IStreamOperator::AttachBufferQueue (int streamId, const OHOS::sptr< OHOS::IBufferProducer > &producer)=0

+

绑定生产者句柄和指定流。 更多...

+

OHOS::Camera::IStreamOperator::DetachBufferQueue (int streamId)=0

+

解除生产者句柄和指定流的绑定关系。 更多...

+

OHOS::Camera::IStreamOperator::Capture (int captureId, const std::shared_ptr< CaptureInfo > &info, bool isStreaming)=0

+

捕获图像。 更多...

+

OHOS::Camera::IStreamOperator::CancelCapture (int captureId)=0

+

取消捕获。 更多...

+

OHOS::Camera::IStreamOperator::ChangeToOfflineStream (const std::vector< int > &streamIds, OHOS::sptr< IStreamOperatorCallback > &callback, OHOS::sptr< IOfflineStreamOperator > &offlineOperator)=0

+

将指定流转换成离线流。 更多...

+

OHOS::Camera::IStreamOperatorCallback::DECLARE_INTERFACE_DESCRIPTOR (u"HDI.Camera.V1_0.StreamOperatorCallback")

+

IPC通信token校验。

+

OHOS::Camera::IStreamOperatorCallback::OnCaptureStarted (int32_t captureId, const std::vector< int32_t > &streamIds)=0

+

捕获开始回调，在捕获开始时调用。 更多...

+

OHOS::Camera::IStreamOperatorCallback::OnCaptureEnded (int32_t captureId, const std::vector< std::shared_ptr< CaptureEndedInfo >> &infos)=0

+

捕获结束回调，在捕获结束时调用。 更多...

+

OHOS::Camera::IStreamOperatorCallback::OnCaptureError (int32_t captureId, const std::vector< std::shared_ptr< CaptureErrorInfo >> &infos)=0

+

捕获错误回调，在捕获过程中发生错误时调用。 更多...

+

OHOS::Camera::IStreamOperatorCallback::OnFrameShutter (int32_t captureId, const std::vector< int32_t > &streamIds, uint64_t timestamp)=0

+

帧捕获回调。 更多...

+
+ +## 变量 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

变量 名称

+

描述

+

OHOS::Camera::StreamInfo::streamId_

+

流的ID，用于在设备内唯一标识一条流。

+

OHOS::Camera::StreamInfo::width_

+

图像宽度。

+

OHOS::Camera::StreamInfo::height_

+

图像高度。

+

OHOS::Camera::StreamInfo::format_

+

图像格式。

+

OHOS::Camera::StreamInfo::datasapce_

+

图像颜色空间。

+

OHOS::Camera::StreamInfo::intent_

+

流类型。

+

OHOS::Camera::StreamInfo::tunneledMode_

+

隧道模式，值为true时开启，false关闭。

+

OHOS::Camera::StreamInfo::bufferQueue_

+

图形提供的生产者句柄。

+

OHOS::Camera::StreamInfo::minFrameDuration_

+

最小帧间隔。

+

OHOS::Camera::StreamInfo::encodeType_

+

编码类型。

+

OHOS::Camera::StreamAttribute::streamId_

+

流的ID，用于在设备内唯一标识一条流。

+

OHOS::Camera::StreamAttribute::width_

+

图像宽度。

+

OHOS::Camera::StreamAttribute::height_

+

图像高度。

+

OHOS::Camera::StreamAttribute::overrideFormat_

+

重写的图像格式。

+

OHOS::Camera::StreamAttribute::overrideDatasapce_

+

重写的图像颜色空间。

+

OHOS::Camera::StreamAttribute::producerUsage_

+

重写后的生产者的使用方式。

+

OHOS::Camera::StreamAttribute::producerBufferCount_

+

重写后的生产者缓存数量。

+

OHOS::Camera::StreamAttribute::maxBatchCaptureCount_

+

连拍支持的最大捕获帧数量。

+

OHOS::Camera::StreamAttribute::maxCaptureCount_

+

最大的并发捕获请求个数，默认为1。

+

OHOS::Camera::CaptureInfo::streamIds_

+

捕获的流ID集合。

+

OHOS::Camera::CaptureInfo::captureSetting_

+

捕获的配置信息。

+

OHOS::Camera::CaptureInfo::enableShutterCallback_

+

使能捕获回调。

+

OHOS::Camera::CaptureEndedInfo::streamId_

+

捕获的流ID。

+

OHOS::Camera::CaptureEndedInfo::frameCount_

+

捕获结束时已经抓取的帧数。

+

OHOS::Camera::CaptureErrorInfo::streamId_

+

流ID。

+

OHOS::Camera::CaptureErrorInfo::error_

+

错误类型。

+
+ +## **详细描述** + +Camera模块接口定义。 + +Camera模块涉及相机设备的操作、流的操作、离线流的操作和各种回调等。 + +**Since：** + +1.0 + +## **枚举类型说明** + +## CameraEvent + +``` +enum OHOS::Camera::CameraEvent : uint32_t +``` + +**描述：** + +Camera事件。 + + + + + + + + + + + + + +

枚举值

+

描述

+

CAMERA_EVENT_DEVICE_ADD

+

Camera设备增加事件。

+

+

CAMERA_EVENT_DEVICE_RMV

+

Camera设备删除事件。

+

+
+ +## CameraStatus + +``` +enum OHOS::Camera::CameraStatus +``` + +**描述：** + +Camera设备状态。 + + + + + + + + + + + + + +

枚举值

+

描述

+

UN_AVAILABLE

+

设备当前不在位或者不可用。

+

+

AVAILABLE

+

设备当前可用。

+

+
+ +## CamRetCode + +``` +enum OHOS::Camera::CamRetCode : int32_t +``` + +**描述：** + +HDI接口的返回值。 + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

NO_ERROR

+

调用成功。

+

+

CAMERA_BUSY

+

设备当前忙。

+

+

INSUFFICIENT_RESOURCES

+

资源不足。

+

+

INVALID_ARGUMENT

+

参数错误。

+

+

METHOD_NOT_SUPPORTED

+

不支持当前调用方法。

+

+

CAMERA_CLOSED

+

Camera设备已经关闭。

+

+

DEVICE_ERROR

+

驱动层发生严重错误。

+

+
+ +## EncodeType + +``` +enum OHOS::Camera::EncodeType : int32_t +``` + +**描述：** + +流数据的编码类型。 + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

ENCODE_TYPE_NULL

+

未设置编码类型

+

+

ENCODE_TYPE_H264

+

编码类型为H264。

+

+

ENCODE_TYPE_H265

+

编码类型为H265。

+

+

ENCODE_TYPE_JPEG

+

编码类型为JPEG。

+

+
+ +## ErrorType + +``` +enum OHOS::Camera::ErrorType : uint32_t +``` + +**描述：** + +设备错误类型，用于设备错误回调 **OnError**。 + + + + + + + + + + + + + +

枚举值

+

描述

+

FATAL_ERROR

+

严重错误，需要关闭camera设备。

+

+

REQUEST_TIMEOUT

+

请求超时，需要关闭camera设备。

+

+
+ +## FlashlightStatus + +``` +enum OHOS::Camera::FlashlightStatus : uint32_t +``` + +**描述：** + +闪光灯状态。 + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

FLASHLIGHT_OFF

+

闪光灯关闭。

+

+

FLASHLIGHT_ON

+

闪光灯开启。

+

+

FLASHLIGHT_UNAVAILABLE

+

闪光灯当前不可用。

+

+
+ +## OperationMode + +``` +enum OHOS::Camera::OperationMode : int32_t +``` + +**描述：** + +流的使用模式。 + + + + + + + + + + +

枚举值

+

描述

+

NORMAL

+

普通模式。

+

+
+ +## ResultCallbackMode + +``` +enum OHOS::Camera::ResultCallbackMode : int32_t +``` + +**描述：** + +metadata的上报模式。 + + + + + + + + + + + + + +

枚举值

+

描述

+

PER_FRAME

+

每帧上报。

+

+

ON_CHANGED

+

设备状态变化时上报。

+

+
+ +## StreamError + +``` +enum OHOS::Camera::StreamError +``` + +**描述：** + +流错误类型，用于流错误类型 [CaptureErrorInfo](_o_h_o_s_1_1_camera_1_1_capture_error_info.md)。 + + + + + + + + + + + + + +

枚举值

+

描述

+

UNKNOWN_ERROR

+

流未知错误。

+

+

BUFFER_LOST

+

丢包。

+

+
+ +## StreamIntent + +``` +enum OHOS::Camera::StreamIntent : int32_t +``` + +**描述：** + +流的类型。 + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

PREVIEW

+

流数据用于显示，即预览流。

+

+

VIDEO

+

流数据用于编码生成录像，即录像流。

+

+

STILL_CAPTURE

+

流数据用于编码生成照片，即拍照流。

+

+

POST_VIEW

+

流数据用于保存缩略图。

+

+

ANALYZE

+

流数据用于图像分析。

+

+

CUSTOM

+

自定义类型。

+

+
+ +## StreamSupportType + +``` +enum OHOS::Camera::StreamSupportType : int32_t +``` + +**描述：** + +动态配置流的切换方式，使用场景参考 [IsStreamsSupported](_camera.md#ga2ebad5dbf7873a2b3ab27900c4f5b0a7) 。 + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

DYNAMIC_SUPPORTED

+

支持动态配置流，对应的流参数直接生效。

+

+

RE_CONFIGURED_REQUIRED

+

不支持动态配置流，对应的参数需要停止流然后重新配置流才能生效。

+

+

NOT_SUPPORTED

+

不支持对应的流参数配置。

+

+
+ +## **函数说明** + +## AttachBufferQueue\(\) + +``` +virtual CamRetCode OHOS::Camera::IStreamOperator::AttachBufferQueue (int streamId, const OHOS::sptr < OHOS::IBufferProducer > & producer ) +``` + +**描述：** + +绑定生产者句柄和指定流。 + +如果在 [CreateStreams](_camera.md#gac16ffa2d2f81bb62eb9ce556a0293c71) 创建流时已经指定了生产者句柄，则不需要调用该接口。如果需要重新绑定， 需先调用 [DetachBufferQueue](_camera.md#gaad1232a57faf5c55ecfdab1c04f98951) 进行解绑，然后再绑定。 对于一些IOT设备，可能不需要或者不支持预览流的图像数据缓存流转，那么不需要绑定生产者句柄， 此时在创建流时 [CreateStreams](_camera.md#gac16ffa2d2f81bb62eb9ce556a0293c71) 的 [StreamInfo](_o_h_o_s_1_1_camera_1_1_stream_info.md) 参数的生产者句柄bufferQueue\_为空，而 tunneledMode\_需设置为false。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

streamId

+

[IN] 用于标识要绑定的流。

+

producer

+

[IN] 生产者句柄。

+
+ +**返回：** + +Returns NO\_ERROR 表示执行成功； + +Returns 其他值表示执行失败，具体错误码查看 [CamRetCode](#ga9ecee2f0e6599644dc440c9e1c553b80)。 + +**参见：** + +[DetachBufferQueue](_camera.md#gaad1232a57faf5c55ecfdab1c04f98951) + +**Since：** + +1.0 + +**Version：** + +1.0 + +## CancelCapture\(\) \[1/2\] + +``` +virtual CamRetCode OHOS::Camera::IOfflineStreamOperator::CancelCapture (int captureId) +``` + +**描述：** + +取消捕获请求。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

captureId

+

[IN] 用于标识要取消的捕获请求。

+
+ +**返回：** + +Returns NO\_ERROR 表示执行成功； + +Returns 其他值表示执行失败，具体错误码查看 [CamRetCode](#ga9ecee2f0e6599644dc440c9e1c553b80)。 + +## CancelCapture\(\) \[2/2\] + +``` +virtual CamRetCode OHOS::Camera::IStreamOperator::CancelCapture (int captureId) +``` + +**描述：** + +取消捕获。 + +取消连续捕获时会调用 **OnCaptureEnded**。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

captureId

+

用于标识要取消的捕获请求

+
+ +**返回：** + +Returns NO\_ERROR 表示执行成功； + +Returns 其他值表示执行失败，具体错误码查看 [CamRetCode](#ga9ecee2f0e6599644dc440c9e1c553b80)。 + +**参见：** + +[Capture](_camera.md#ga9fb8042cb01262bc08da16159975cf50) + +**Since：** + +1.0 + +**Version：** + +1.0 + +## Capture\(\) + +``` +virtual CamRetCode OHOS::Camera::IStreamOperator::Capture (int captureId, const std::shared_ptr< [CaptureInfo](_o_h_o_s_1_1_camera_1_1_capture_info.md) > & info, bool isStreaming ) +``` + +**描述：** + +捕获图像。 + +本接口必须在调用 [CommitStreams](_camera.md#gab94792910f425ade060edcda5c5706d1) 配置流之后调用。 图像捕获有两种模式，分别是连续捕获和单次捕获。连续捕获即触发之后模块内部进行连续的捕获， 消费者可以连续收到图像数据，不需要多次调用本接口，若再次调用了本接口， 则停止当前捕获，更新捕获信息，再进行一次新的捕获，多用于预览、录像或者连拍场景。 单次捕获即触发之后只捕获一帧图像数据，用于单次拍照场景。 捕获启动时，会调用 **OnCaptureStarted** 来通知调用者捕获已经启动。 连续捕获需调用 [CancelCapture](_camera.md#ga77100b740f501c309a573f9783313a61) 来停止捕获。 捕获结束时，会调用 **OnCaptureEnded** 来通知调用者捕获的帧计数等信息。 [CaptureInfo](_o_h_o_s_1_1_camera_1_1_capture_info.md) 的 enableShutterCallback\_ 使能 **OnFrameShutter**，使能后每次捕获触发 **OnFrameShutter** 对于多个流同时捕获的场景，本模块内部保证同时上报多路流捕获数据。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

captureId

+

[IN] 捕获请求的唯一标识，由调用者指定，调用者需保证在Camera设备打开期间，捕获请求ID是唯一的。

+

info

+

[IN] 捕获请求的参数信息，具体信息查看 CaptureInfo。

+

isStreaming

+

[IN] 是否连续捕获，true表示连续捕获，否则为单次捕获。

+
+ +**返回：** + +Returns NO\_ERROR 表示执行成功； + +Returns 其他值表示执行失败，具体错误码查看 [CamRetCode](#ga9ecee2f0e6599644dc440c9e1c553b80)。 + +**参见：** + +OnFrameShutter + +**Since：** + +1.0 + +**Version：** + +1.0 + +## ChangeToOfflineStream\(\) + +``` +virtual CamRetCode OHOS::Camera::IStreamOperator::ChangeToOfflineStream (const std::vector< int > & streamIds, OHOS::sptr< IStreamOperatorCallback > & callback, OHOS::sptr< IOfflineStreamOperator > & offlineOperator ) +``` + +**描述：** + +将指定流转换成离线流。 + +离线流只能由拍照流转换而来，其他流不支持。 一些设备处理能力有限，可能导致拍照时算法处理时间较长，从而引起捕获请求堆积在模块内部，而转换为离线 流之后，可关闭底层设备，由离线流接替，进行后续的处理。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

streamIds

+

[IN] 用于指定要转换成离线流的流集合。

+

callback

+

[IN] 用于设置离线流的回调。

+

offlineOperator

+

[OUT] 转换后的离线流。

+
+ +**返回：** + +Returns NO\_ERROR 表示执行成功； + +Returns 其他值表示执行失败，具体错误码查看 [CamRetCode](#ga9ecee2f0e6599644dc440c9e1c553b80)。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## Close\(\) + +``` +virtual void OHOS::Camera::ICameraDevice::Close () +``` + +**描述：** + +关闭Camera设备。 + +**参见：** + +[OpenCamera](_camera.md#gaf9e7aa942d3e31504d8ef5e710b029f1) + +**Since：** + +1.0 + +**Version：** + +1.0 + +## CommitStreams\(\) + +``` +virtual CamRetCode OHOS::Camera::IStreamOperator::CommitStreams (OperationMode mode, const std::shared_ptr< CameraMetadata > & modeSetting ) +``` + +**描述：** + +配置流。 + +本接口需在调用 [CreateStreams](_camera.md#gac16ffa2d2f81bb62eb9ce556a0293c71) 创建流之后调用。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

mode

+

[IN] 流运行的模式，支持的模式定义在 OperationMode。

+

modeSetting

+

[IN] 流的配置参数，包括帧率，ZOOM等信息。

+
+ +**返回：** + +Returns NO\_ERROR 表示执行成功； + +Returns 其他值表示执行失败，具体错误码查看 [CamRetCode](#ga9ecee2f0e6599644dc440c9e1c553b80)。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## CreateStreams\(\) + +``` +virtual CamRetCode OHOS::Camera::IStreamOperator::CreateStreams (const std::vector< std::shared_ptr< StreamInfo >> & streamInfos) +``` + +**描述：** + +创建流。 + +此函数接口依据输入的流信息创建流，调用该接口之前需先通过 [IsStreamsSupported](_camera.md#ga2ebad5dbf7873a2b3ab27900c4f5b0a7) 查询HAL是否支持要创建的流。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

streamInfos

+

[IN] 流信息列表，流信息定义在 StreamInfo。输入的流信息可能会被修改，需通过 GetStreamAttributes 获取最新的流属性。

+
+ +**返回：** + +Returns NO\_ERROR 表示执行成功； + +Returns 其他值表示执行失败，具体错误码查看 [CamRetCode](#ga9ecee2f0e6599644dc440c9e1c553b80)。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## DetachBufferQueue\(\) + +``` +virtual CamRetCode OHOS::Camera::IStreamOperator::DetachBufferQueue (int streamId) +``` + +**描述：** + +解除生产者句柄和指定流的绑定关系。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

streamId

+

[IN] 用于标识要解除绑定的流。

+
+ +**返回：** + +Returns NO\_ERROR 表示执行成功； + +Returns 其他值表示执行失败，具体错误码查看[CamRetCode](#ga9ecee2f0e6599644dc440c9e1c553b80)。 + +**参见：** + +[AttachBufferQueue](_camera.md#gad17206bf96c260a9384f224d65a230af) + +**Since：** + +1.0 + +**Version：** + +1.0 + +## DisableResult\(\) + +``` +virtual CamRetCode OHOS::Camera::ICameraDevice::DisableResult (const std::vector< MetaType > & results) +``` + +**描述：** + +关闭metadata上报开关。 + +屏蔽之后，相应的**OnResult**不再上报，需 [EnableResult](_camera.md#ga265b16a5b7969045b38de95bf782b75c) 使能之后才上报。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

results

+

[IN] 需要关闭上报开关的metadata。

+
+ +**返回：** + +Returns NO\_ERROR 表示执行成功。 + +Returns 其他值表示执行失败，具体错误码查看 [CamRetCode](#ga9ecee2f0e6599644dc440c9e1c553b80)。 + +**参见：** + +[EnableResult](_camera.md#ga265b16a5b7969045b38de95bf782b75c) + +**Since：** + +1.0 + +**Version：** + +1.0 + +## EnableResult\(\) + +``` +virtual CamRetCode OHOS::Camera::ICameraDevice::EnableResult (const std::vector< MetaType > & results) +``` + +**描述：** + +打开metadata上报开关。 + +**OnResult** 只上报此接口使能后的metadata。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

results

+

[IN] 需要打开上报开关的metadata。

+
+ +**返回：** + +Returns NO\_ERROR 表示执行成功。 + +Returns 其他值表示执行失败，具体错误码查看 [CamRetCode](#ga9ecee2f0e6599644dc440c9e1c553b80)。 + +**参见：** + +[DisableResult](_camera.md#ga68fd022b82dfba6d9431220faf9856bd) + +**Since：** + +1.0 + +**Version：** + +1.0 + +## Get\(\) + +``` +static sptr OHOS::Camera::ICameraHost::Get (const char * serviceName) +``` + +**描述：** + +获取ICameraHost实例。 + +此接口为Camera调用入口，需要先通过该接口获取ICameraHost实例，然后通过ICameraHost实例进行其它操作。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

serviceName

+

[IN] 要获取的ICameraHost实例的名称，当前实现中实例名称固定为camera_service。

+
+ +**返回：** + +Returns 成功返回ICameraHost实例，失败返回nullptr。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## GetCameraAbility\(\) + +``` +virtual CamRetCode OHOS::Camera::ICameraHost::GetCameraAbility (const std::string & cameraId, std::shared_ptr< CameraAbility > & ability ) +``` + +**描述：** + +获取Camera设备能力集合。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

cameraId

+

[IN] 用于指定要操作的camera设备，通过 GetCameraIds 获取。

+

ability

+

[OUT] 返回cameraId对应Camera设备的能力集合。

+
+ +**返回：** + +Returns NO\_ERROR 表示执行成功； + +Returns 其他值表示执行失败，具体错误码查看 [CamRetCode](#ga9ecee2f0e6599644dc440c9e1c553b80)。 + +**参见：** + +[GetCameraIds](_camera.md#gab3128eb3432a830b2cff6bcd999bca10) + +**Since：** + +1.0 + +**Version：** + +1.0 + +## GetCameraIds\(\) + +``` +virtual CamRetCode OHOS::Camera::ICameraHost::GetCameraIds (std::vector< std::string > & cameraIds) +``` + +**描述：** + +获取当前可用的Camera设备ID列表。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

cameraIds

+

[OUT] 返回当前可用的设备列表

+
+ +**返回：** + +Returns NO\_ERROR 表示执行成功。 + +Returns 其他值表示执行失败，具体错误码查看 [CamRetCode](#ga9ecee2f0e6599644dc440c9e1c553b80)。 + +**参见：** + +[GetCameraAbility](_camera.md#gad813ea200395e42a3ec2a457cc04b93d) + +**Since：** + +1.0 + +**Version：** + +1.0 + +## GetEnabledResults\(\) + +``` +virtual CamRetCode OHOS::Camera::ICameraDevice::GetEnabledResults (std::vector< MetaType > & results) +``` + +**描述：** + +查询使能的metadata。 + +[EnableResult](_camera.md#ga265b16a5b7969045b38de95bf782b75c) 使能需要上报的metadata之后，可通过此接口查询使能的metadata。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

results

+

[OUT] 所有使能的metadata。

+
+ +**返回：** + +Returns NO\_ERROR 表示执行成功。 + +Returns 其他值表示执行失败，具体错误码查看 [CamRetCode](#ga9ecee2f0e6599644dc440c9e1c553b80)。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## GetStreamAttributes\(\) + +``` +virtual CamRetCode OHOS::Camera::IStreamOperator::GetStreamAttributes (std::vector< std::shared_ptr< StreamAttribute >> & attributes) +``` + +**描述：** + +获取流的属性。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

attributes

+

[OUT] 用于获取流的属性。在调用CreateStreams 时，通过参数streamInfos携带的流信息 可能会被重写，因此通过该接口获取的流属性可能会。 和 CreateStreams 输入的流信息存在差异。

+
+ +**返回：** + +Returns NO\_ERROR 表示执行成功。 + +Returns 其他值表示执行失败，具体错误码查看 [CamRetCode](#ga9ecee2f0e6599644dc440c9e1c553b80)。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## GetStreamOperator\(\) + +``` +virtual CamRetCode OHOS::Camera::ICameraDevice::GetStreamOperator (const OHOS::sptr< IStreamOperatorCallback > & callback, OHOS::sptr< IStreamOperator > & streamOperator ) +``` + +**描述：** + +获取流操作句柄。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

callback

+

[IN] 设置流回调接口，详细可查看 IStreamOperatorCallback， 用于上报捕获开始 OnCaptureStarted，捕获结束 OnCaptureEnded， OnCaptureError 捕获错误等信息。

+

streamOperator

+

[OUT] 返回流操作句柄。

+
+ +**返回：** + +Returns NO\_ERROR 表示执行成功。 + +Returns 其他值表示执行失败，具体错误码查看 [CamRetCode](#ga9ecee2f0e6599644dc440c9e1c553b80)。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## IsStreamsSupported\(\) + +``` +virtual CamRetCode OHOS::Camera::IStreamOperator::IsStreamsSupported (OperationMode mode, const std::shared_ptr< CameraMetadata > & modeSetting, const std::vector< std::shared_ptr< StreamInfo >> & info, StreamSupportType & type ) +``` + +**描述：** + +查询是否支持添加参数对应的流。 + +流是指从底层设备输出，经本模块内部各环节处理，最终传递到上层服务或者应用的一组数据序列 本模块支持的流的类型有预览流，录像流，拍照流等，更多类型可查看 **StreamIntent**。 + +此函数接口根据输入的运行模式和配置信息以及当前模块中正在运行的流，查询是否支持动态添加流。 如果本模块支持在不停止其他流的情况下添加新流，或者即使停止其他流但上层服务或应用不感知 则通过type参数返回DYNAMIC\_SUPPORTED，上层服务或应用可以直接添加新流； 如果本模块支持添加新流但需要上层服务或应用先停止所有流的捕获，则通过type参数返回RE\_CONFIGURED\_REQUIRED; 如果不支持添加输入的新流，则返回NOT\_SUPPORTED。 此函数需要在调用 [CreateStreams](_camera.md#gac16ffa2d2f81bb62eb9ce556a0293c71) 创建流之前调用。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

mode

+

[IN] 流运行的模式，支持的模式参考 OperationMode。

+

modeSetting

+

[IN] 流的配置，包括帧率，3A等配置信息。

+

info

+

[IN] 流的配置信息，具体参考 StreamInfo。

+

type

+

[OUT] 对动态配置流的支持类型，支持类型定义在 StreamSupportType。

+
+ +**返回：** + +Returns NO\_ERROR 表示执行成功； + +Returns 其他值表示执行失败，具体错误码查看 [CamRetCode](#ga9ecee2f0e6599644dc440c9e1c553b80)。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## OnCameraEvent\(\) + +``` +virtual void OHOS::Camera::ICameraHostCallback::OnCameraEvent (const std::string & cameraId, CameraEvent event ) +``` + +**描述：** + +在相机事件发生时调用。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

cameraId

+

表示相机事件绑定的相机ID。

+

event

+

表示相机事件类型。

+
+ +**Since：** + +1.0 + +**Version：** + +1.0 + +## OnCameraStatus\(\) + +``` +virtual void OHOS::Camera::ICameraHostCallback::OnCameraStatus (const std::string & cameraId, CameraStatus status ) +``` + +**描述：** + +用于Camera设备状态变化时上报状态信息给调用者。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

cameraId

+

[IN] 状态发生变化的Camera设备ID。

+

status

+

[IN] 最新的设备状态。

+
+ +**Since：** + +1.0 + +**Version：** + +1.0 + +## OnCaptureEnded\(\) + +``` +virtual void OHOS::Camera::IStreamOperatorCallback::OnCaptureEnded (int32_t captureId, const std::vector< std::shared_ptr< CaptureEndedInfo >> & infos ) +``` + +**描述：** + +捕获结束回调，在捕获结束时调用。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

captureId

+

[IN] 用于标识回调对应的捕获请求。

+

infos

+

[IN] 捕获结束相关信息。

+
+ +**参见：** + +[OnCaptureStarted](_camera.md#ga6389672b42dcead4067bbb06aa7b8c18) + +**Since：** + +1.0 + +**Version：** + +1.0 + +## OnCaptureError\(\) + +``` +virtual void OHOS::Camera::IStreamOperatorCallback::OnCaptureError (int32_t captureId, const std::vector< std::shared_ptr< CaptureErrorInfo >> & infos ) +``` + +**描述：** + +捕获错误回调，在捕获过程中发生错误时调用。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

captureId

+

[IN] 用于标识回调对应的捕获请求。

+

infos

+

[IN] 捕获错误信息列表。

+
+ +**Since：** + +1.0 + +**Version：** + +1.0 + +## OnCaptureStarted\(\) + +``` +virtual void OHOS::Camera::IStreamOperatorCallback::OnCaptureStarted (int32_t captureId, const std::vector< int32_t > & streamIds ) +``` + +**描述：** + +捕获开始回调，在捕获开始时调用。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

captureId

+

[IN] 用于标识回调对应的捕获请求。

+

streamIds

+

[IN] 回调对应的流集合。

+
+ +**参见：** + +[OnCaptureEnded](_camera.md#ga3761990cab402ce99251b26e3802070d) + +**Since：** + +1.0 + +**Version：** + +1.0 + +## OnError\(\) + +``` +virtual void OHOS::Camera::ICameraDeviceCallback::OnError (ErrorType type, int32_t errorCode ) +``` + +**描述：** + +设备发生错误时调用，由调用者实现，用于返回错误信息给调用者。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

type

+

[IN] 错误类型，具体错误类型可参考 ErrorType。

+

errorCode

+

[IN] 错误码，当前暂未使用。

+
+ +**Since：** + +1.0 + +**Version：** + +1.0 + +## OnFlashlightStatus\(\) + +``` +virtual void OHOS::Camera::ICameraHostCallback::OnFlashlightStatus (const std::string & cameraId, FlashlightStatus status ) +``` + +**描述：** + +用于在闪光灯状态变化时上报状态信息给调用者。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

cameraId

+

[IN] 状态发生变化的闪关灯所绑定的Camera设备ID。

+

status

+

[IN] 最新的闪光灯状态。

+
+ +**Since：** + +1.0 + +**Version：** + +1.0 + +## OnFrameShutter\(\) + +``` +virtual void OHOS::Camera::IStreamOperatorCallback::OnFrameShutter (int32_t captureId, const std::vector< int32_t > & streamIds, uint64_t timestamp ) +``` + +**描述：** + +帧捕获回调。 + +通过 **Capture** 的输入参数 [CaptureInfo](_o_h_o_s_1_1_camera_1_1_capture_info.md) 的enableShutterCallback\_使能该回调， 使能后每次捕获均会触发此回调。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

captureId

+

[IN] 用于标识回调对应的捕获请求。

+

streamIds

+

[IN] 回调对应的流集合。

+

timestamp

+

[IN] 该接口被调用时的时间戳。

+
+ +**参见：** + +Capture + +**Since：** + +1.0 + +**Version：** + +1.0 + +## OnResult\(\) + +``` +virtual void OHOS::Camera::ICameraDeviceCallback::OnResult (uint64_t timestamp, const std::shared_ptr< CameraMetadata > & result ) +``` + +**描述：** + +上报camera设备相关的metadata的回调，上报方式查看 [SetResultMode](_camera.md#ga8adaa4f26fffa98626a2c7e731393174)。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

timestamp

+

[IN] metadata上报的时间戳。

+

result

+

[IN] 上报的metadata，上报的metadata由 EnableResult 指定， 可通过 GetEnabledResults 查询，DisableResult 关闭上报开关。

+
+ +**Since：** + +1.0 + +**Version：** + +1.0 + +## OpenCamera\(\) + +``` +virtual CamRetCode OHOS::Camera::ICameraHost::OpenCamera (const std::string & cameraId, const OHOS::sptr< ICameraDeviceCallback > & callback, OHOS::sptr< ICameraDevice > & device ) +``` + +**描述：** + +打开Camera设备。 + +打开指定的Camera设备，通过此接口可以获取到ICameraDevice对象，通过ICameraDevice对象可以操作具体的Camera设备。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

cameraId

+

[IN] 需要打开的Camera设备ID，可通过 GetCameraIds 接口获取当前已有Camera设备列表。

+

callback

+

[IN] camera设备相关的回调函数，具体参见 ICameraDeviceCallback。

+

device

+

[OUT] 返回当前要打开的Camera设备ID对应的ICameraDevice对象。

+
+ +**返回：** + +Returns NO\_ERROR 表示执行成功； + +Returns 其他值表示执行失败，具体错误码查看 [CamRetCode](#ga9ecee2f0e6599644dc440c9e1c553b80)。 + +**参见：** + +[GetCameraIds](_camera.md#gab3128eb3432a830b2cff6bcd999bca10) + +**Since：** + +1.0 + +**Version：** + +1.0 + +## Release\(\) + +``` +virtual CamRetCode OHOS::Camera::IOfflineStreamOperator::Release () +``` + +**描述：** + +释放所有离线流。 + +**返回：** + +Returns NO\_ERROR 表示执行成功； + +Returns 其他值表示执行失败，具体错误码查看 [CamRetCode](#ga9ecee2f0e6599644dc440c9e1c553b80)。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## ReleaseStreams\(\) \[1/2\] + +``` +virtual CamRetCode OHOS::Camera::IOfflineStreamOperator::ReleaseStreams (const std::vector< int > & streamIds) +``` + +**描述：** + +释放离线流。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

streamIds

+

用于标识要释放的离线流集合。

+
+ +**返回：** + +Returns NO\_ERROR 表示执行成功。 + +Returns 其他值表示执行失败，具体错误码查看 [CamRetCode](#ga9ecee2f0e6599644dc440c9e1c553b80)。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## ReleaseStreams\(\) \[2/2\] + +``` +virtual CamRetCode OHOS::Camera::IStreamOperator::ReleaseStreams (const std::vector< int > & streamIds) +``` + +**描述：** + +释放流。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

streamIds

+

[IN] 要释放的流ID列表。

+
+ +**返回：** + +Returns NO\_ERROR 表示执行成功； + +Returns 其他值表示执行失败，具体错误码查看 [CamRetCode](#ga9ecee2f0e6599644dc440c9e1c553b80)。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## SetCallback\(\) + +``` +virtual CamRetCode OHOS::Camera::ICameraHost::SetCallback (const OHOS::sptr< ICameraHostCallback > & callback) +``` + +**描述：** + +设置ICameraHost回调接口，回调函数参考 [ICameraHostCallback](_o_h_o_s_1_1_camera_1_1_i_camera_host_callback.md)。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

callback

+

[IN] 要设置的回调函数。

+
+ +**返回：** + +Returns NO\_ERROR 表示执行成功。 + +Returns 其他值表示执行失败，具体错误码查看 [CamRetCode](#ga9ecee2f0e6599644dc440c9e1c553b80)。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## SetFlashlight\(\) + +``` +virtual CamRetCode OHOS::Camera::ICameraHost::SetFlashlight (const std::string & cameraId, bool & isEnable ) +``` + +**描述：** + +打开或关闭闪光灯。 + +该接口只能由打开cameraId指定Camera设备的调用者调用。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

cameraId

+

[IN] 闪光灯对应的Camera设备ID。

+

isEnable

+

[IN] true打开闪光灯，false关闭闪光灯。

+
+ +**返回：** + +Returns NO\_ERROR 表示执行成功； + +Returns 其他值表示执行失败，具体错误码查看 [CamRetCode](#ga9ecee2f0e6599644dc440c9e1c553b80)。 + +**参见：** + +[GetCameraIds](_camera.md#gab3128eb3432a830b2cff6bcd999bca10) + +**Since：** + +1.0 + +**Version：** + +1.0 + +## SetResultMode\(\) + +``` +virtual CamRetCode OHOS::Camera::ICameraDevice::SetResultMode (const ResultCallbackMode & mode) +``` + +**描述：** + +设置metadata上报模式，逐帧上报还是设备状态变化时上报。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

mode

+

[IN] metadata的上报模式，逐帧上报或者设备状态变化时上报，查看 ResultCallbackMode。

+
+ +**返回：** + +Returns NO\_ERROR 表示执行成功。 + +Returns 其他值表示执行失败，具体错误码查看 [CamRetCode](#ga9ecee2f0e6599644dc440c9e1c553b80)。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## UpdateSettings\(\) + +``` +virtual CamRetCode OHOS::Camera::ICameraDevice::UpdateSettings (const std::shared_ptr< CameraSetting > & settings) +``` + +**描述：** + +更新设备控制参数。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

settings

+

[IN] Camera设置参数，包括sensor帧率，3A相关参数等。

+
+ +**返回：** + +Returns NO\_ERROR 表示执行成功。 + +Returns 其他值表示执行失败，具体错误码查看 [CamRetCode](#ga9ecee2f0e6599644dc440c9e1c553b80)。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## **变量说明** + +## bufferQueue\_ + +``` +OHOS::sptr OHOS::Camera::StreamInfo::bufferQueue_ +``` + +**描述：** + +图形提供的生产者句柄。 + +## captureSetting\_ + +``` +std::shared_ptr OHOS::Camera::CaptureInfo::captureSetting_ +``` + +**描述：** + +捕获的配置信息。 + +## datasapce\_ + +``` +int OHOS::Camera::StreamInfo::datasapce_ +``` + +**描述：** + +图像颜色空间。 + +## enableShutterCallback\_ + +``` +bool OHOS::Camera::CaptureInfo::enableShutterCallback_ +``` + +**描述：** + +使能捕获回调，每一次捕获后都会触发 **OnFrameShutter**。 + +## encodeType\_ + +``` +[EncodeType](_camera.md#ga57d3c5974b8119b90f6f43592bd4b1d1) OHOS::Camera::StreamInfo::encodeType_ +``` + +**描述：** + +编码类型。 + +## error\_ + +``` +[StreamError](_camera.md#ga376e6d566c73ec98e29b7dd93763aee6) OHOS::Camera::CaptureErrorInfo::error_ +``` + +**描述：** + +错误类型。 + +## format\_ + +``` +int OHOS::Camera::StreamInfo::format_ +``` + +**描述：** + +图像格式。 + +## frameCount\_ + +``` +int OHOS::Camera::CaptureEndedInfo::frameCount_ +``` + +**描述：** + +捕获结束时已经抓取的帧数。 + +## height\_ \[1/2\] + +``` +int OHOS::Camera::StreamInfo::height_ +``` + +**描述：** + +图像高度。 + +## height\_ \[2/2\] + +``` +int OHOS::Camera::StreamAttribute::height_ +``` + +**描述：** + +图像高度。 + +## intent\_ + +``` +[StreamIntent](_camera.md#ga2b195a400dc0113b8185900ddc231c19) OHOS::Camera::StreamInfo::intent_ +``` + +**描述：** + +流类型。 + +## maxBatchCaptureCount\_ + +``` +int OHOS::Camera::StreamAttribute::maxBatchCaptureCount_ +``` + +**描述：** + +连拍支持的最大捕获帧数量。 + +## maxCaptureCount\_ + +``` +int OHOS::Camera::StreamAttribute::maxCaptureCount_ +``` + +**描述：** + +最大的并发捕获请求个数，默认为1。 + +## minFrameDuration\_ + +``` +int OHOS::Camera::StreamInfo::minFrameDuration_ +``` + +**描述：** + +最小帧间隔。 + +## overrideDatasapce\_ + +``` +int OHOS::Camera::StreamAttribute::overrideDatasapce_ +``` + +**描述：** + +重写的图像颜色空间 + +## overrideFormat\_ + +``` +int OHOS::Camera::StreamAttribute::overrideFormat_ +``` + +**描述：** + +重写的图像格式。 + +## producerBufferCount\_ + +``` +int OHOS::Camera::StreamAttribute::producerBufferCount_ +``` + +**描述：** + +重写后的生产者缓存数量。 + +## producerUsage\_ + +``` +int OHOS::Camera::StreamAttribute::producerUsage_ +``` + +**描述：** + +重写后的生产者的使用方式。 + +## streamId\_ \[1/4\] + +``` +int OHOS::Camera::StreamInfo::streamId_ +``` + +**描述：** + +流的ID，用于在设备内唯一标识一条流。 + +## streamId\_ \[2/4\] + +``` +int OHOS::Camera::StreamAttribute::streamId_ +``` + +**描述：** + +流的ID，用于在设备内唯一标识一条流。 + +## streamId\_ \[3/4\] + +``` +int OHOS::Camera::CaptureEndedInfo::streamId_ +``` + +**描述：** + +捕获的流ID。 + +## streamId\_ \[4/4\] + +``` +int OHOS::Camera::CaptureErrorInfo::streamId_ +``` + +**描述：** + +流ID。 + +## streamIds\_ + +``` +std::vector OHOS::Camera::CaptureInfo::streamIds_ +``` + +**描述：** + +捕获的流ID集合。 + +## tunneledMode\_ + +``` +bool OHOS::Camera::StreamInfo::tunneledMode_ +``` + +**描述：** + +隧道模式，值为true时开启，false关闭。 + +开启隧道模式后，HAL不直接和上层交互，通过图形提供的生产者句柄来传递帧数据， 对于一些IOT设备，可能不需要或者不支持预览流的图像数据缓存流转，此时需要关闭隧道模式。 + +## width\_ \[1/2\] + +``` +int OHOS::Camera::StreamInfo::width_ +``` + +**描述：** + +图像宽度。 + +## width\_ \[2/2\] + +``` +int OHOS::Camera::StreamAttribute::width_ +``` + +**描述：** + +图像宽度。 + diff --git a/zh-cn/device-dev/api/toctopics/_codec.md b/zh-cn/device-dev/api/toctopics/_codec.md new file mode 100644 index 0000000000..b86a81b750 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_codec.md @@ -0,0 +1,2595 @@ +# Codec + +## **汇总** + +## 文件 + + + + + + + + + + + + + + + + + + + + + + +

文件

+

描述

+

codec_callback_if.h

+

主要包括回调函数接口定义。

+

codec_common_type.h

+

Codec模块接口定义中使用的自定义数据类型。

+

codec_component_if.h

+

主要包括Codec组件接口定义。

+

codec_component_manager.h

+

主要包括Codec组件管理类接口。

+

codec_component_type.h

+

Codec模块接口定义中使用的自定义数据类型。

+
+ +## 类 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

类

+

描述

+

CodecCallbackType

+

Codec回调接口定义。 更多...

+

Alignment

+

对齐结构定义，包含宽高的对齐值 更多...

+

Rect

+

矩形的定义 更多...

+

RangeValue

+

取值范围的定义 更多...

+

CodecComponentType

+

Codec组件接口定义。 更多...

+

CodecComponentManager

+

Codec组件管理类接口定义。 更多...

+

VideoPortCap

+

定义视频编解码能力 更多...

+

AudioPortCap

+

定义音频编解码能力 更多...

+

PortCap

+

定义音视频编解码能力 更多...

+

CodecCompCapability

+

定义Codec编解码能力 更多...

+

OmxCodecBuffer

+

Codec buffer信息的定义 更多...

+

CompVerInfo

+

定义组件版本信息 更多...

+

EventInfo

+

定义事件上报信息 更多...

+

SupportBufferType

+

SupportBuffer类型定义. 更多...

+

UseBufferType

+

UseBuffer类型定义 更多...

+

GetBufferHandleUsageParams

+

BufferHandleUsage类型定义 更多...

+
+ +## 宏定义 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

宏定义

+

描述

+

SAMPLE_FMT_NUM 32

+

采样格式最大值

+

UUID_LENGTH 128

+

定义UUID长度

+

PIX_FORMAT_NUM 16

+

支持的像素格式数组大小

+

SAMPLE_FORMAT_NUM 12

+

支持的音频采样格式数组大小

+

SAMPLE_RATE_NUM 16

+

支持的音频采样率数组大小

+

CHANNEL_NUM 16

+

支持的音频通道数组大小

+

NAME_LENGTH 32

+

组件名称大小

+

PROFILE_NUM 256

+

支持的profile数组大小

+
+ +## 枚举 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举

+

描述

+

CodecType { VIDEO_DECODER, VIDEO_ENCODER, AUDIO_DECODER, AUDIO_ENCODER, INVALID_TYPE }

+

枚举编解码的类型 更多...

+

Profile { INVALID_PROFILE = 0, AAC_LC_PROFILE = 0x1000, AAC_MAIN_PROFILE, AAC_HE_V1_PROFILE, AAC_HE_V2_PROFILE, AAC_LD_PROFILE, AAC_ELD_PROFILE, AVC_BASELINE_PROFILE = 0x2000, AVC_MAIN_PROFILE, AVC_HIGH_PROFILE, HEVC_MAIN_PROFILE = 0x3000, HEVC_MAIN_10_PROFILE }

+

枚举Codec规格 更多...

+

AudioSampleRate { AUD_SAMPLE_RATE_8000 = 8000, AUD_SAMPLE_RATE_12000 = 12000, AUD_SAMPLE_RATE_11025 = 11025, AUD_SAMPLE_RATE_16000 = 16000, AUD_SAMPLE_RATE_22050 = 22050, AUD_SAMPLE_RATE_24000 = 24000, AUD_SAMPLE_RATE_32000 = 32000, AUD_SAMPLE_RATE_44100 = 44100, AUD_SAMPLE_RATE_48000 = 48000, AUD_SAMPLE_RATE_64000 = 64000, AUD_SAMPLE_RATE_96000 = 96000, AUD_SAMPLE_RATE_INVALID }

+

枚举音频采样率 更多...

+

CodecCapsMask { CODEC_CAP_ADAPTIVE_PLAYBACK = 0x1, CODEC_CAP_SECURE_PLAYBACK = 0x2, CODEC_CAP_TUNNEL_PLAYBACK = 0x4, CODEC_CAP_MULTI_PLANE = 0x10000 }

+

枚举播放能力 更多...

+

CodecProcessMode { PROCESS_BLOCKING_INPUT_BUFFER = 0X1, PROCESS_BLOCKING_OUTPUT_BUFFER = 0X2, PROCESS_BLOCKING_CONTROL_FLOW = 0X4, PROCESS_NONBLOCKING_INPUT_BUFFER = 0X100, PROCESS_NONBLOCKING_OUTPUT_BUFFER = 0X200, PROCESS_NONBLOCKING_CONTROL_FLOW = 0X400 }

+

枚举编解码处理模式 更多...

+

AvCodecRole { MEDIA_ROLETYPE_IMAGE_JPEG = 0, MEDIA_ROLETYPE_VIDEO_AVC, MEDIA_ROLETYPE_VIDEO_HEVC, MEDIA_ROLETYPE_AUDIO_FIRST = 0x10000, MEDIA_ROLETYPE_AUDIO_AAC = 0x10000, MEDIA_ROLETYPE_AUDIO_G711A, MEDIA_ROLETYPE_AUDIO_G711U, MEDIA_ROLETYPE_AUDIO_G726, MEDIA_ROLETYPE_AUDIO_PCM, MEDIA_ROLETYPE_AUDIO_MP3, MEDIA_ROLETYPE_INVALID }

+

枚举音视频编解码组件类型 更多...

+

AudioSampleFormat { AUDIO_SAMPLE_FORMAT_S8, AUDIO_SAMPLE_FORMAT_S8P, AUDIO_SAMPLE_FORMAT_U8, AUDIO_SAMPLE_FORMAT_U8P, AUDIO_SAMPLE_FORMAT_S16, AUDIO_SAMPLE_FORMAT_S16P, AUDIO_SAMPLE_FORMAT_U16, AUDIO_SAMPLE_FORMAT_U16P, AUDIO_SAMPLE_FORMAT_S24, AUDIO_SAMPLE_FORMAT_S24P, AUDIO_SAMPLE_FORMAT_U24, AUDIO_SAMPLE_FORMAT_U24P, AUDIO_SAMPLE_FORMAT_S32, AUDIO_SAMPLE_FORMAT_S32P, AUDIO_SAMPLE_FORMAT_U32, AUDIO_SAMPLE_FORMAT_U32P, AUDIO_SAMPLE_FORMAT_S64, AUDIO_SAMPLE_FORMAT_S64P, AUDIO_SAMPLE_FORMAT_U64, AUDIO_SAMPLE_FORMAT_U64P, AUDIO_SAMPLE_FORMAT_F32, AUDIO_SAMPLE_FORMAT_F32P, AUDIO_SAMPLE_FORMAT_F64, AUDIO_SAMPLE_FORMAT_F64P, AUDIO_SAMPLE_FMT_U8, AUDIO_SAMPLE_FMT_S16, AUDIO_SAMPLE_FMT_S32, AUDIO_SAMPLE_FMT_FLOAT, AUDIO_SAMPLE_FMT_DOUBLE, AUDIO_SAMPLE_FMT_U8P, AUDIO_SAMPLE_FMT_S16P, AUDIO_SAMPLE_FMT_S32P, AUDIO_SAMPLE_FMT_FLOATP, AUDIO_SAMPLE_FMT_DOUBLEP, AUDIO_SAMPLE_FMT_INVALID }

+

枚举音频采样格式 更多...

+

CodecBufferType { CODEC_BUFFER_TYPE_INVALID = 0, CODEC_BUFFER_TYPE_VIRTUAL_ADDR = 0x1, CODEC_BUFFER_TYPE_AVSHARE_MEM_FD = 0x2, CODEC_BUFFER_TYPE_HANDLE = 0x4, CODEC_BUFFER_TYPE_DYNAMIC_HANDLE = 0x8 }

+

定义buffer类型 更多...

+

ShareMemTypes { READ_WRITE_TYPE = 0x1, READ_ONLY_TYPE = 0x2 }

+

枚举共享内存类型 更多...

+

OmxIndexCodecExType { OMX_IndexExtBufferTypeStartUnused = OMX_IndexKhronosExtensions + 0x00a00000, OMX_IndexParamSupportBufferType, OMX_IndexParamUseBufferType, OMX_IndexParamGetBufferHandleUsage }

+

枚举Codec扩展index 更多...

+

OmxVideoExType { OMX_VIDEO_CodingHEVC = 11 }

+

枚举Codec扩展编码类型 更多...

+
+ +## 函数 + + + + + + + + + + + + + + + + + + + + + + + + + +

函数

+

描述

+

CodecCallbackTypeGet (struct HdfRemoteService *remote)

+

实例化CodecCallbackType对象。 更多...

+

CodecCallbackTypeRelease (struct CodecCallbackType *instance)

+

释放CodecCallbackType对象。 更多...

+

CodecComponentTypeGet (struct HdfRemoteService *remote)

+

实例化CodecComponentType对象。 更多...

+

CodecComponentTypeRelease (struct CodecComponentType *instance)

+

释放CodecComponentType对象。 更多...

+

GetCodecComponentManager (void)

+

实例化CodecComponentManager对象。 更多...

+

CodecComponentManagerRelease (void)

+

释放CodecComponentManager对象。 更多...

+
+ +## 变量 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

变量 名称

+

描述

+

CodecCallbackType::remote

+

指向HdfRemoteService的指针。 更多...

+

( CodecCallbackType::EventHandler )(struct CodecCallbackType *self, enum OMX_EVENTTYPE event, struct EventInfo *info)

+

事件上报。 更多...

+

( CodecCallbackType::EmptyBufferDone )(struct CodecCallbackType *self, int8_t *appData, uint32_t appDataLen, const struct OmxCodecBuffer *buffer)

+

上报输入buffer编码或者解码处理完毕。 更多...

+

( CodecCallbackType::FillBufferDone )(struct CodecCallbackType *self, int8_t *appData, uint32_t appDataLen, struct OmxCodecBuffer *buffer)

+

上报输出buffer填充完毕。 更多...

+

( CodecComponentType::GetComponentVersion )(struct CodecComponentType *self, struct CompVerInfo *verInfo)

+

获取Codec组件版本号。 更多...

+

( CodecComponentType::SendCommand )(struct CodecComponentType *self, enum OMX_COMMANDTYPE cmd, uint32_t param, int8_t *cmdData, uint32_t cmdDataLen)

+

发送命令给组件。 更多...

+

( CodecComponentType::GetParameter )(struct CodecComponentType *self, uint32_t paramIndex, int8_t *paramStruct, uint32_t paramStructLen)

+

获取组件参数设置。 更多...

+

( CodecComponentType::SetParameter )(struct CodecComponentType *self, uint32_t index, int8_t *paramStruct, uint32_t paramStructLen)

+

设置组件需要的参数。 更多...

+

( CodecComponentType::GetConfig )(struct CodecComponentType *self, uint32_t index, int8_t *cfgStruct, uint32_t cfgStructLen)

+

获取组件的配置结构。 更多...

+

( CodecComponentType::SetConfig )(struct CodecComponentType *self, uint32_t index, int8_t *cfgStruct, uint32_t cfgStructLen)

+

设置组件的配置。 更多...

+

( CodecComponentType::GetExtensionIndex )(struct CodecComponentType *self, const char *paramName, uint32_t *indexType)

+

根据字符串获取组件的扩展索引。 更多...

+

( CodecComponentType::GetState )(struct CodecComponentType *self, enum OMX_STATETYPE *state)

+

获取组件的当前状态。 更多...

+

( CodecComponentType::ComponentTunnelRequest )(struct CodecComponentType *self, uint32_t port, int32_t tunneledComp, uint32_t tunneledPort, struct OMX_TUNNELSETUPTYPE *tunnelSetup)

+

设置组件采用Tunnel方式通信。 更多...

+

( CodecComponentType::UseBuffer )(struct CodecComponentType *self, uint32_t portIndex, struct OmxCodecBuffer *buffer)

+

指定组件端口的buffer。 更多...

+

( CodecComponentType::AllocateBuffer )(struct CodecComponentType *self, uint32_t portIndex, struct OmxCodecBuffer *buffer)

+

向组件申请端口buffer。 更多...

+

( CodecComponentType::FreeBuffer )(struct CodecComponentType *self, uint32_t portIndex, const struct OmxCodecBuffer *buffer)

+

释放buffer。 更多...

+

( CodecComponentType::EmptyThisBuffer )(struct CodecComponentType *self, const struct OmxCodecBuffer *buffer)

+

编解码输入待处理buffer。 更多...

+

( CodecComponentType::FillThisBuffer )(struct CodecComponentType *self, const struct OmxCodecBuffer *buffer)

+

编解码输出填充buffer。 更多...

+

( CodecComponentType::SetCallbacks )(struct CodecComponentType *self, struct CodecCallbackType *callback, int8_t *appData, uint32_t appDataLen)

+

设置Codec组件的回调函数。 更多...

+

( CodecComponentType::ComponentDeInit )(struct CodecComponentType *self)

+

组件去初始化。 更多...

+

( CodecComponentType::UseEglImage )(struct CodecComponentType *self, struct OmxCodecBuffer *buffer, uint32_t portIndex, int8_t *eglImage, uint32_t eglImageLen)

+

使用已在EGL中申请的空间。 更多...

+

( CodecComponentType::ComponentRoleEnum )(struct CodecComponentType *self, uint8_t *role, uint32_t roleLen, uint32_t index)

+

获取组件角色。 更多...

+
+ +## **详细描述** + +Codec模块接口定义。 + +Codec模块涉及自定义类型、音视频编解码组件初始化、参数设置、数据的轮转和控制等。 + +**Since：** + +3.1 + +**Version：** + +2.0 + +## **枚举类型说明** + +## AudioSampleFormat + +``` +enum AudioSampleFormat +``` + +**描述：** + +枚举音频采样格式 + +对于planar的采样格式，每个声道的数据是独立存储在data中；对于packed的采样格式，只使用第一个data，每个声道的数据是交错存储的。 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

AUDIO_SAMPLE_FORMAT_S8

+

8bit位宽有符号交织样本

+

+

AUDIO_SAMPLE_FORMAT_S8P

+

8bit位宽有符号非交织样本

+

+

AUDIO_SAMPLE_FORMAT_U8

+

8bit位宽无符号交织样本

+

+

AUDIO_SAMPLE_FORMAT_U8P

+

8bit位宽无符号非交织样本

+

+

AUDIO_SAMPLE_FORMAT_S16

+

16bit位宽有符号交织样本

+

+

AUDIO_SAMPLE_FORMAT_S16P

+

16bit位宽有符号非交织样本

+

+

AUDIO_SAMPLE_FORMAT_U16

+

16bit位宽无符号交织样本

+

+

AUDIO_SAMPLE_FORMAT_U16P

+

16bit位宽无符号非交织样本

+

+

AUDIO_SAMPLE_FORMAT_S24

+

24bit位宽有符号交织样本

+

+

AUDIO_SAMPLE_FORMAT_S24P

+

24bit位宽有符号非交织样本

+

+

AUDIO_SAMPLE_FORMAT_U24

+

24bit位宽无符号交织样本

+

+

AUDIO_SAMPLE_FORMAT_U24P

+

24bit位宽无符号非交织样本

+

+

AUDIO_SAMPLE_FORMAT_S32

+

32bit位宽有符号交织样本

+

+

AUDIO_SAMPLE_FORMAT_S32P

+

32bit位宽有符号非交织样本

+

+

AUDIO_SAMPLE_FORMAT_U32

+

32bit位宽无符号交织样本

+

+

AUDIO_SAMPLE_FORMAT_U32P

+

32bit位宽无符号非交织样本

+

+

AUDIO_SAMPLE_FORMAT_S64

+

64bit位宽有符号交织样本

+

+

AUDIO_SAMPLE_FORMAT_S64P

+

64bit位宽有符号非交织样本

+

+

AUDIO_SAMPLE_FORMAT_U64

+

64bit位宽无符号交织样本

+

+

AUDIO_SAMPLE_FORMAT_U64P

+

64bit位宽无符号非交织样本

+

+

AUDIO_SAMPLE_FORMAT_F32

+

32bit位宽浮点型交织样本

+

+

AUDIO_SAMPLE_FORMAT_F32P

+

64bit位宽浮点型非交织样本

+

+

AUDIO_SAMPLE_FORMAT_F64

+

64bit位宽双精度浮点型交织样本

+

+

AUDIO_SAMPLE_FORMAT_F64P

+

64bit位宽双精度浮点型非交织样本

+

+

AUDIO_SAMPLE_FMT_U8

+

无符号8位整型，打包格式

+

+

AUDIO_SAMPLE_FMT_S16

+

带符号16位整型，打包格式

+

+

AUDIO_SAMPLE_FMT_S32

+

带符号32位整型，打包格式

+

+

AUDIO_SAMPLE_FMT_FLOAT

+

浮点型，打包格式

+

+

AUDIO_SAMPLE_FMT_DOUBLE

+

双精度浮点型，打包格式

+

+

AUDIO_SAMPLE_FMT_U8P

+

无符号8位整型，平面格式

+

+

AUDIO_SAMPLE_FMT_S16P

+

带符号16位整型，平面格式

+

+

AUDIO_SAMPLE_FMT_S32P

+

带符号32位整型，平面格式

+

+

AUDIO_SAMPLE_FMT_FLOATP

+

浮点型，平面格式

+

+

AUDIO_SAMPLE_FMT_DOUBLEP

+

双精度浮点型，平面格式

+

+

AUDIO_SAMPLE_FMT_INVALID

+

无效采样格式

+

+
+ +## AudioSampleRate + +``` +enum AudioSampleRate +``` + +**描述：** + +枚举音频采样率 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

AUD_SAMPLE_RATE_8000

+

8K采样率

+

+

AUD_SAMPLE_RATE_12000

+

12K采样率

+

+

AUD_SAMPLE_RATE_11025

+

11.025K采样率

+

+

AUD_SAMPLE_RATE_16000

+

16K采样率

+

+

AUD_SAMPLE_RATE_22050

+

22.050K采样率

+

+

AUD_SAMPLE_RATE_24000

+

24K采样率

+

+

AUD_SAMPLE_RATE_32000

+

32K采样率

+

+

AUD_SAMPLE_RATE_44100

+

44.1K采样率

+

+

AUD_SAMPLE_RATE_48000

+

48K采样率

+

+

AUD_SAMPLE_RATE_64000

+

64K采样率

+

+

AUD_SAMPLE_RATE_96000

+

96K采样率

+

+

AUD_SAMPLE_RATE_INVALID

+

无效采样率

+

+
+ +## AvCodecRole + +``` +enum AvCodecRole +``` + +**描述：** + +枚举音视频编解码组件类型 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

MEDIA_ROLETYPE_IMAGE_JPEG

+

图像JPEG媒体类型

+

+

MEDIA_ROLETYPE_VIDEO_AVC

+

视频H.264媒体类型

+

+

MEDIA_ROLETYPE_VIDEO_HEVC

+

视频H.265媒体类型

+

+

MEDIA_ROLETYPE_AUDIO_FIRST

+

音频编解码器类型

+

+

MEDIA_ROLETYPE_AUDIO_AAC

+

音频AAC媒体类型

+

+

MEDIA_ROLETYPE_AUDIO_G711A

+

音频G711A媒体类型

+

+

MEDIA_ROLETYPE_AUDIO_G711U

+

音频G711U媒体类型

+

+

MEDIA_ROLETYPE_AUDIO_G726

+

音频G726媒体类型

+

+

MEDIA_ROLETYPE_AUDIO_PCM

+

音频PCM媒体类型

+

+

MEDIA_ROLETYPE_AUDIO_MP3

+

音频MP3媒体类型

+

+

MEDIA_ROLETYPE_INVALID

+

无效媒体类型

+

+
+ +## CodecBufferType + +``` +enum CodecBufferType +``` + +**描述：** + +定义buffer类型 + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

CODEC_BUFFER_TYPE_INVALID

+

无效buffer类型

+

+

CODEC_BUFFER_TYPE_VIRTUAL_ADDR

+

虚拟地址类型

+

+

CODEC_BUFFER_TYPE_AVSHARE_MEM_FD

+

共享内存类型

+

+

CODEC_BUFFER_TYPE_HANDLE

+

handle类型

+

+

CODEC_BUFFER_TYPE_DYNAMIC_HANDLE

+

动态handle类型

+

+
+ +## CodecCapsMask + +``` +enum CodecCapsMask +``` + +**描述：** + +枚举播放能力 + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

CODEC_CAP_ADAPTIVE_PLAYBACK

+

自适应播放能力

+

+

CODEC_CAP_SECURE_PLAYBACK

+

安全播放能力

+

+

CODEC_CAP_TUNNEL_PLAYBACK

+

通道播放能力

+

+

CODEC_CAP_MULTI_PLANE

+

视频图像平面/音频通道平面能力

+

+
+ +## CodecProcessMode + +``` +enum CodecProcessMode +``` + +**描述：** + +枚举编解码处理模式 + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

PROCESS_BLOCKING_INPUT_BUFFER

+

同步模式输入buffer

+

+

PROCESS_BLOCKING_OUTPUT_BUFFER

+

同步模式输出buffer

+

+

PROCESS_BLOCKING_CONTROL_FLOW

+

同步模式控制流

+

+

PROCESS_NONBLOCKING_INPUT_BUFFER

+

异步模式输入buffer

+

+

PROCESS_NONBLOCKING_OUTPUT_BUFFER

+

异步模式输出buffer

+

+

PROCESS_NONBLOCKING_CONTROL_FLOW

+

异步模式控制流

+

+
+ +## CodecType + +``` +enum CodecType +``` + +**描述：** + +枚举编解码的类型 + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

VIDEO_DECODER

+

视频解码类型

+

+

VIDEO_ENCODER

+

视频编码类型

+

+

AUDIO_DECODER

+

音频解码类型

+

+

AUDIO_ENCODER

+

音频编码类型

+

+

INVALID_TYPE

+

无效类型

+

+
+ +## OmxIndexCodecExType + +``` +enum OmxIndexCodecExType +``` + +**描述：** + +枚举Codec扩展index + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

OMX_IndexExtBufferTypeStartUnused

+

BufferType 扩展index

+

+

OMX_IndexParamSupportBufferType

+

SupportBuffer类型

+

+

OMX_IndexParamUseBufferType

+

UseBuffer类型

+

+

OMX_IndexParamGetBufferHandleUsage

+

GetBufferHandleUsage类型

+

+
+ +## OmxVideoExType + +``` +enum OmxVideoExType +``` + +**描述：** + +枚举Codec扩展编码类型 + + + + + + + + + + +

枚举值

+

描述

+

OMX_VIDEO_CodingHEVC

+

HEVC编码类型

+

+
+ +## Profile + +``` +enum Profile +``` + +**描述：** + +枚举Codec规格 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

INVALID_PROFILE

+

无效的规格

+

+

AAC_LC_PROFILE

+

AAC低复杂度规格

+

+

AAC_MAIN_PROFILE

+

AAC主规格

+

+

AAC_HE_V1_PROFILE

+

AAC高效率和频带重现规格，又称为HEAAC，AAC+，或者AACPlusV1

+

+

AAC_HE_V2_PROFILE

+

AAC高效率和频带重现以及变量立体声规格，又称为AAC++或者AACPlusV2

+

+

AAC_LD_PROFILE

+

AAC低延迟规格

+

+

AAC_ELD_PROFILE

+

AAC增强型低延迟规格

+

+

AVC_BASELINE_PROFILE

+

H.264低规格

+

+

AVC_MAIN_PROFILE

+

H.264主规格

+

+

AVC_HIGH_PROFILE

+

H.264高规格

+

+

HEVC_MAIN_PROFILE

+

H.265主规格

+

+

HEVC_MAIN_10_PROFILE

+

H.265 10比特主规格

+

+
+ +## ShareMemTypes + +``` +enum ShareMemTypes +``` + +**描述：** + +枚举共享内存类型 + + + + + + + + + + + + + +

枚举值

+

描述

+

READ_WRITE_TYPE

+

可读可写的共享内存类型

+

+

READ_ONLY_TYPE

+

可读的共享内存类型

+

+
+ +## **函数说明** + +## CodecCallbackTypeGet\(\) + +``` +struct CodecCallbackType* CodecCallbackTypeGet (struct HdfRemoteService * remote) +``` + +**描述：** + +实例化CodecCallbackType对象。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

remote

+

输入参数，指向HdfRemoteService的指针。

+
+ +**返回：** + +实例化CodecCallbackType对象。 + +**Since：** + +3.1 + +## CodecCallbackTypeRelease\(\) + +``` +void CodecCallbackTypeRelease (struct CodecCallbackType * instance) +``` + +**描述：** + +释放CodecCallbackType对象。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

instance

+

输入参数，指向CodecCallbackType实例的指针。

+
+ +**Since：** + +3.1 + +## CodecComponentManagerRelease\(\) + +``` +void CodecComponentManagerRelease (void ) +``` + +**描述：** + +释放CodecComponentManager对象。 + +**Since：** + +3.1 + +## CodecComponentTypeGet\(\) + +``` +struct CodecComponentType* CodecComponentTypeGet (struct HdfRemoteService * remote) +``` + +**描述：** + +实例化CodecComponentType对象。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

remote

+

输入参数，指向RemoteService的指针。

+
+ +**返回：** + +实例化的CodecComponentType对象。 + +**Since：** + +3.1 + +## CodecComponentTypeRelease\(\) + +``` +void CodecComponentTypeRelease (struct CodecComponentType * instance) +``` + +**描述：** + +释放CodecComponentType对象。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

instance

+

输入参数，指向CodecComponentType实例的指针。

+
+ +**Since：** + +3.1 + +## GetCodecComponentManager\(\) + +``` +struct CodecComponentManager* GetCodecComponentManager (void ) +``` + +**描述：** + +实例化CodecComponentManager对象。 + +**返回：** + +实例化的CodecComponentManager对象。 + +**Since：** + +3.1 + +## **变量说明** + +## AllocateBuffer + +``` +int32_t(* CodecComponentType::AllocateBuffer) (struct CodecComponentType *self, uint32_t portIndex, struct OmxCodecBuffer *buffer) +``` + +**描述：** + +向组件申请端口buffer。 + +向组件申请分配新的buffer，此接口在以下情况下使用： + +- 当组件处于OMX\_StateLoaded状态，并且用户已经向组件发送OMX\_StateIdle状态转换请求。 +- 当组件处于OMX\_StateWaitForResources状态，所需的资源可用，并且组件已准备好进入OMX\_StateIdle状态。 +- 在去使能端口上，组件处于OMX\_StateExecuting、OMX\_StatePause或OMX\_StateIdle状态。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

self

+

输入参数，指向要操作的Codec组件指针。

+

portIndex

+

输入参数，指定的组件端口。

+

buffer

+

输入输出参数，指向要申请的buffer结构体OmxCodecBuffer指针。

+
+ +**返回：** + +HDF\_SUCCESS 表示申请buffer成功。 + +HDF\_ERR\_INVALID\_PARAM 表示参数无效，申请buffer失败。 + +HDF\_ERR\_INVALID\_OBJECT 表示对象无效，申请buffer失败。 + +HDF\_ERR\_MALLOC\_FAIL 表示申请内存失败，申请buffer失败。 + +**Since：** + +3.1 + +## ComponentDeInit + +``` +int32_t(* CodecComponentType::ComponentDeInit) (struct CodecComponentType *self) +``` + +**描述：** + +组件去初始化。 + +调用此接口使组件去初始化，当组件处于OMX\_StateLoaded状态时，将直接关闭组件。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

self

+

输入参数，指向要操作的Codec组件指针。

+
+ +**返回：** + +HDF\_SUCCESS 表示去初始化成功。 + +HDF\_ERR\_INVALID\_PARAM 表示参数无效，去初始化失败。 + +HDF\_ERR\_INVALID\_OBJECT 表示对象无效，去初始化失败。 + +HDF\_ERR\_MALLOC\_FAIL 表示申请内存失败，去初始化失败。 + +**Since：** + +3.1 + +## ComponentRoleEnum + +``` +int32_t(* CodecComponentType::ComponentRoleEnum) (struct CodecComponentType *self, uint8_t *role, uint32_t roleLen, uint32_t index) +``` + +**描述：** + +获取组件角色。 + +根据组件角色索引获取对应组件角色。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

self

+

输入参数，指向要操作的Codec组件指针。

+

role

+

输出参数，角色名称。

+

roleLen

+

输入参数，role字节数。

+

index

+

输入参数，角色的索引，一个组件可能支持多种角色。

+
+ +**返回：** + +HDF\_SUCCESS 表示获取角色成功。 + +HDF\_ERR\_INVALID\_PARAM 表示参数无效，获取角色失败。 + +HDF\_ERR\_INVALID\_OBJECT 表示对象无效，获取角色失败。 + +HDF\_ERR\_MALLOC\_FAIL 表示申请内存失败，获取角色失败。 + +**Since：** + +3.1 + +## ComponentTunnelRequest + +``` +int32_t(* CodecComponentType::ComponentTunnelRequest) (struct CodecComponentType *self, uint32_t port, int32_t tunneledComp, uint32_t tunneledPort, struct OMX_TUNNELSETUPTYPE *tunnelSetup) +``` + +**描述：** + +设置组件采用Tunnel方式通信。 + +当组件处于OMX\_StateLoaded 状态时，用户通过调用此接口确定组件是否可以进行Tunnel传输，如果可以则设置组件的Tunnel传输。 + +**参数：** + + + + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

self

+

输入参数，指向要操作的Codec组件指针。

+

port

+

输入参数，组件设置的端口。

+

tunneledComp

+

输入参数，组件的tunnel handle。

+

tunneledPort

+

输入参数，组件用来Tunnel通信的端口。

+

tunnelSetup

+

输入输出参数，指向Tunnel设置的结构体OMX_TUNNELSETUPTYPE指针。

+
+ +**返回：** + +HDF\_SUCCESS 表示设置成功。 + +HDF\_ERR\_INVALID\_PARAM 表示参数无效，设置失败。 + +HDF\_ERR\_INVALID\_OBJECT 表示对象无效，设置失败。 + +HDF\_ERR\_MALLOC\_FAIL 表示申请内存失败，设置失败。 + +**Since：** + +3.1 + +## EmptyBufferDone + +``` +int32_t(* CodecCallbackType::EmptyBufferDone) (struct CodecCallbackType *self, int8_t *appData, uint32_t appDataLen, const struct OmxCodecBuffer *buffer) +``` + +**描述：** + +上报输入buffer编码或者解码处理完毕。 + +组件运行过程中向上报告输入buffer已经使用完毕。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

self

+

输入参数，指向要操作的callback指针。

+

appData

+

输入参数，上层数据，通常是设置回调时给入的上层实例。

+

appDataLen

+

输入参数，appData字节数。

+

buffer

+

输入参数，已经处理完毕的输入buffer信息OmxCodecBuffer。

+
+ +**返回：** + +HDF\_SUCCESS 表示上报成功。 + +HDF\_ERR\_INVALID\_PARAM 表示参数无效，上报失败。 + +HDF\_ERR\_INVALID\_OBJECT 表示对象无效，上报失败。 + +HDF\_ERR\_MALLOC\_FAIL 表示申请内存失败，上报失败。 + +**Since：** + +3.1 + +## EmptyThisBuffer + +``` +int32_t(* CodecComponentType::EmptyThisBuffer) (struct CodecComponentType *self, const struct OmxCodecBuffer *buffer) +``` + +**描述：** + +编解码输入待处理buffer。 + +此接口在组件处于OMX\_StateExecuting或者OMX\_StatePause状态时调用。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

self

+

输入参数，指向要操作的Codec组件指针。

+

buffer

+

输入参数，指向OmxCodecBuffer结构体的指针。

+
+ +**返回：** + +HDF\_SUCCESS 表示输入buffer成功。 + +HDF\_ERR\_INVALID\_PARAM 表示参数无效，输入buffer失败。 + +HDF\_ERR\_INVALID\_OBJECT 表示对象无效，输入buffer失败。 + +HDF\_ERR\_MALLOC\_FAIL 表示申请内存失败，输入buffer失败。 + +**Since：** + +3.1 + +## EventHandler + +``` +int32_t(* CodecCallbackType::EventHandler) (struct CodecCallbackType *self, enum OMX_EVENTTYPE event, struct EventInfo *info) +``` + +**描述：** + +事件上报。 + +组件运行过程中向上报告错误事件、命令完成事件、端口设置更改事件等。 + +- 当eEvent为OMX\_EventCmdComplete，eventData为NULL，data1数据为OMX\_COMMANDTYPE，此时，当data1为OMX\_CommandStateSet，data2表示状态，其它情况下，data2表示端口。 +- 当event为OMX\_EventError时，data1表示错误码，data2和eventData都为0。 +- 当event为OMX\_EventMark时，data1和data2都为0，eventData指向mark指针。 +- 当event为OMX\_EventPortSettingsChanged时，data1表示端口，data2和eventData为0。 +- 当event为OMX\_EventBufferFlag时，data1表示端口，data2表示flag，eventData为0。 +- 当event为OMX\_EventResourcesAcquired或OMX\_EventDynamicResourcesAvailable时，data1、data2和eventData都为0。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

self

+

输入参数，指向要操作的callback指针。

+

event

+

输入参数，要通知的事件类型，详见OMX_EVENTTYPE。

+

info

+

输入参数，指向事件上报携带的信息指针，详见EventInfo。

+
+ +**返回：** + +HDF\_SUCCESS 表示事件上报成功。 + +HDF\_ERR\_INVALID\_PARAM 表示参数无效，事件上报失败。 + +HDF\_ERR\_INVALID\_OBJECT 表示对象无效，事件上报失败。 + +HDF\_ERR\_MALLOC\_FAIL 表示申请内存失败，事件上报失败。 + +**Since：** + +3.1 + +## FillBufferDone + +``` +int32_t(* CodecCallbackType::FillBufferDone) (struct CodecCallbackType *self, int8_t *appData, uint32_t appDataLen, struct OmxCodecBuffer *buffer) +``` + +**描述：** + +上报输出buffer填充完毕。 + +组件运行过程中向上报告输出buffer已经填充完毕。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

self

+

输入参数，指向要操作的callback指针。

+

appData

+

输入参数，上层数据，通常是设置回调时给入的上层实例。

+

appDataLen

+

输入参数，appData字节数。

+

buffer

+

输入参数，已经填充完毕的buffer信息OmxCodecBuffer。

+
+ +**返回：** + +HDF\_SUCCESS 表示上报成功。 + +HDF\_ERR\_INVALID\_PARAM 表示参数无效，上报失败。 + +HDF\_ERR\_INVALID\_OBJECT 表示对象无效，上报失败。 + +HDF\_ERR\_MALLOC\_FAIL 表示申请内存失败，上报失败。 + +**Since：** + +3.1 + +## FillThisBuffer + +``` +int32_t(* CodecComponentType::FillThisBuffer) (struct CodecComponentType *self, const struct OmxCodecBuffer *buffer) +``` + +**描述：** + +编解码输出填充buffer。 + +此接口在组件处于OMX\_StateExecuting或者OMX\_StatePause状态时调用。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

self

+

输入参数，指向要操作的Codec组件指针。

+

buffer

+

输入参数，指向OmxCodecBuffer结构体的指针。

+
+ +**返回：** + +HDF\_SUCCESS 表示填充buffer成功。 + +HDF\_ERR\_INVALID\_PARAM 表示参数无效，填充buffer失败。 + +HDF\_ERR\_INVALID\_OBJECT 表示对象无效，填充buffer失败。 + +HDF\_ERR\_MALLOC\_FAIL 表示申请内存失败，填充buffer失败。 + +**Since：** + +3.1 + +## FreeBuffer + +``` +int32_t(* CodecComponentType::FreeBuffer) (struct CodecComponentType *self, uint32_t portIndex, const struct OmxCodecBuffer *buffer) +``` + +**描述：** + +释放buffer。 + +此接口在以下情况下使用： + +- 当组件处于OMX\_StateIdle状态，并且已经向组件发送OMX\_StateLoaded状态转换请求。 +- 在去使能端口上，组件处于OMX\_StateExecuting、OMX\_StatePause或OMX\_StateIdle时调用。 +- 此接口调用可随时进行，但是如果未在上述情况下执行，可能会导致组件上报OMX\_ErrorPortUnpopulated事件。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

self

+

输入参数，指向要操作的Codec组件指针。

+

portIndex

+

输入参数，指定的组件端口。

+

buffer

+

输入参数，指向OmxCodecBuffer结构体的指针。

+
+ +**返回：** + +HDF\_SUCCESS 表示释放buffer成功。 + +HDF\_ERR\_INVALID\_PARAM 表示参数无效，释放buffer失败。 + +HDF\_ERR\_INVALID\_OBJECT 表示对象无效，释放buffer失败。 + +HDF\_ERR\_MALLOC\_FAIL 表示申请内存失败，释放buffer失败。 + +**Since：** + +3.1 + +## GetComponentVersion + +``` +int32_t(* CodecComponentType::GetComponentVersion) (struct CodecComponentType *self, struct CompVerInfo *verInfo) +``` + +**描述：** + +获取Codec组件版本号。 + +通过查询组件，返回组件版本信息。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

self

+

输入参数，指向要操作的Codec组件指针。

+

verInfo

+

输出参数，指向组件版本信息的指针，详见CompVerInfo。

+
+ +**返回：** + +HDF\_SUCCESS 表示获取版本号成功。 + +HDF\_ERR\_INVALID\_PARAM 表示参数无效，获取版本号失败。 + +HDF\_ERR\_INVALID\_OBJECT 表示对象无效，获取版本号失败。 + +HDF\_ERR\_MALLOC\_FAIL 表示申请内存失败，获取版本号失败。 + +**Since：** + +3.1 + +## GetConfig + +``` +int32_t(* CodecComponentType::GetConfig) (struct CodecComponentType *self, uint32_t index, int8_t *cfgStruct, uint32_t cfgStructLen) +``` + +**描述：** + +获取组件的配置结构。 + +加载组件后可以随时调用此接口获取组件的配置。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

self

+

输入参数，指向要操作的Codec组件指针。

+

index

+

输入参数，待填充结构的索引，详见OMX_INDEXTYPE。

+

cfgStruct

+

输入输出参数，指向由组件填充的应用程序分配的结构体指针。

+

cfgStructLen

+

输入参数，上层传入的cfgStruct字节数。

+
+ +**返回：** + +HDF\_SUCCESS 表示获取配置成功。 + +HDF\_ERR\_INVALID\_PARAM 表示参数无效，获取配置失败。 + +HDF\_ERR\_INVALID\_OBJECT 表示对象无效，获取配置失败。 + +HDF\_ERR\_MALLOC\_FAIL 表示申请内存失败，获取配置失败。 + +**Since：** + +3.1 + +## GetExtensionIndex + +``` +int32_t(* CodecComponentType::GetExtensionIndex) (struct CodecComponentType *self, const char *paramName, uint32_t *indexType) +``` + +**描述：** + +根据字符串获取组件的扩展索引。 + +将扩展字符串转换为Openmax IL结构索引。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

self

+

输入参数，指向要操作的Codec组件指针。

+

paramName

+

输入参数，组件用来转换为配置索引的字符串。

+

indexType

+

输出参数，由paramName转换的配置索引，详见OMX_INDEXTYPE。

+
+ +**返回：** + +HDF\_SUCCESS 表示获取扩展索引成功。 + +HDF\_ERR\_INVALID\_PARAM 表示参数无效，获取扩展索引失败。 + +HDF\_ERR\_INVALID\_OBJECT 表示对象无效，获取扩展索引失败。 + +HDF\_ERR\_MALLOC\_FAIL 表示申请内存失败，获取扩展索引失败。 + +**Since：** + +3.1 + +## GetParameter + +``` +int32_t(* CodecComponentType::GetParameter) (struct CodecComponentType *self, uint32_t paramIndex, int8_t *paramStruct, uint32_t paramStructLen) +``` + +**描述：** + +获取组件参数设置。 + +当组件处于除了OMX\_StateInvalid（组件状态异常）之外的其他状态，用户可通过此接口获取组件参数。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

self

+

输入参数，指向要操作的Codec组件指针。

+

paramIndex

+

输入参数，待填充结构的索引，详见OMX_INDEXTYPE。

+

paramStruct

+

输入输出参数，指向由组件填充的应用程序分配的结构体指针。

+

paramStructLen

+

输入参数，paramStruct字节数。

+
+ +**返回：** + +HDF\_SUCCESS 表示获取参数成功。 + +HDF\_ERR\_INVALID\_PARAM 表示参数无效，获取参数失败。 + +HDF\_ERR\_INVALID\_OBJECT 表示对象无效，获取参数失败。 + +HDF\_ERR\_MALLOC\_FAIL 表示申请内存失败，获取参数失败。 + +**Since：** + +3.1 + +## GetState + +``` +int32_t(* CodecComponentType::GetState) (struct CodecComponentType *self, enum OMX_STATETYPE *state) +``` + +**描述：** + +获取组件的当前状态。 + +用户可调用此接口获取组件的当前状态，组件状态详见**OMX\_STATETYPE**。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

self

+

输入参数，指向要操作的Codec组件指针。

+

state

+

输出参数，指向获取到的状态指针，组件状态详见OMX_STATETYPE。

+
+ +**返回：** + +HDF\_SUCCESS 表示获取状态成功。 + +HDF\_ERR\_INVALID\_PARAM 表示参数无效，获取状态失败。 + +HDF\_ERR\_INVALID\_OBJECT 表示对象无效，获取状态失败。 + +HDF\_ERR\_MALLOC\_FAIL 表示申请内存失败，获取状态失败。 + +**Since：** + +3.1 + +## remote + +``` +struct HdfRemoteService* CodecCallbackType::remote +``` + +**描述：** + +指向HdfRemoteService的指针。 + +**Since：** + +3.1 + +## SendCommand + +``` +int32_t(* CodecComponentType::SendCommand) (struct CodecComponentType *self, enum OMX_COMMANDTYPE cmd, uint32_t param, int8_t *cmdData, uint32_t cmdDataLen) +``` + +**描述：** + +发送命令给组件。 + +发送命令给组件，当命令为设置状态时，会有事件回调通知结果给上层，其他命令则没有事件上报。 + +**参数：** + + + + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

self

+

输入参数，指向要操作的Codec组件指针。

+

cmd

+

输入参数，组件要执行的命令，详见OMX_COMMANDTYPE。

+

param

+

输入参数，组件要执行的命令携带的参数。

+
  • 当cmd为OMX_CommandStateSet时，param的值详见OMX_STATETYPE。
  • 当cmd为OMX_CommandFlush、OMX_CommandPortDisable、OMX_CommandPortEnable、OMX_CommandMarkBuffer时，param为目标端口。
+

cmdData

+

输入参数，当cmd为OMX_CommandMarkBuffer时，指向OMX_MARKTYPE结构体指针。

+

cmdDataLen

+

输入参数，上层传递的cmdData字节数。

+
+ +**返回：** + +HDF\_SUCCESS 表示发送命令成功。 + +HDF\_ERR\_INVALID\_PARAM 表示参数无效，发送命令失败。 + +HDF\_ERR\_INVALID\_OBJECT 表示对象无效，发送命令失败。 + +HDF\_ERR\_MALLOC\_FAIL 表示申请内存失败，发送命令失败。 + +**Since：** + +3.1 + +## SetCallbacks + +``` +int32_t(* CodecComponentType::SetCallbacks) (struct CodecComponentType *self, struct CodecCallbackType *callback, int8_t *appData, uint32_t appDataLen) +``` + +**描述：** + +设置Codec组件的回调函数。 + +当组件处于OMX\_StateLoaded状态时，使用此回调函数向上通知事件以及上报可用的输入输出信息。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

self

+

输入参数，指向要操作的Codec组件指针。

+

callback

+

输入参数，指向回调函数CodecCallbackType对象指针。

+

appData

+

输入参数，指向应用程序定义的值的指针，该值将在回调期间返回。

+

appDataLen

+

输入参数，上层传递的appData字节数。

+
+ +**返回：** + +HDF\_SUCCESS 表示设置回调成功。 + +HDF\_ERR\_INVALID\_PARAM 表示参数无效，设置回调失败。 + +HDF\_ERR\_INVALID\_OBJECT 表示对象无效，设置回调失败。 + +HDF\_ERR\_MALLOC\_FAIL 表示申请内存失败，设置回调失败。 + +**Since：** + +3.1 + +## SetConfig + +``` +int32_t(* CodecComponentType::SetConfig) (struct CodecComponentType *self, uint32_t index, int8_t *cfgStruct, uint32_t cfgStructLen) +``` + +**描述：** + +设置组件的配置。 + +加载组件后可以随时调用此接口设置组件的配置。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

self

+

输入参数，指向要操作的Codec组件指针。

+

index

+

输入参数，要设置的结构索引，详见OMX_INDEXTYPE。

+

cfgStruct

+

输入参数，指向组件用于初始化的应用程序分配结构的指针。

+

cfgStructLen

+

输入参数，cfgStruct字节数。

+
+ +**返回：** + +HDF\_SUCCESS 表示设置配置成功。 + +HDF\_ERR\_INVALID\_PARAM 表示参数无效，设置失败。 + +HDF\_ERR\_INVALID\_OBJECT 表示对象无效，设置失败。 + +HDF\_ERR\_MALLOC\_FAIL 表示申请内存失败，设置失败。 + +**Since：** + +3.1 + +## SetParameter + +``` +int32_t(* CodecComponentType::SetParameter) (struct CodecComponentType *self, uint32_t index, int8_t *paramStruct, uint32_t paramStructLen) +``` + +**描述：** + +设置组件需要的参数。 + +当组件处于OMX\_StateLoaded、OMX\_StateWaitForResources状态或者端口是去使能状态，用户可通过此接口设置组件参数。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

self

+

输入参数，指向要操作的Codec组件指针。

+

index

+

输入参数，要设置的结构索引，详见OMX_INDEXTYPE。

+

paramStruct

+

输入参数，指向组件用于初始化的应用程序分配结构的指针。

+

paramStructLen

+

输入参数，paramStruct字节数。

+
+ +**返回：** + +HDF\_SUCCESS 表示设置参数成功。 + +HDF\_ERR\_INVALID\_PARAM 表示参数无效，设置参数失败。 + +HDF\_ERR\_INVALID\_OBJECT 表示对象无效，设置参数失败。 + +HDF\_ERR\_MALLOC\_FAIL 表示申请内存失败，设置参数失败。 + +**Since：** + +3.1 + +## UseBuffer + +``` +int32_t(* CodecComponentType::UseBuffer) (struct CodecComponentType *self, uint32_t portIndex, struct OmxCodecBuffer *buffer) +``` + +**描述：** + +指定组件端口的buffer。 + +此接口在以下情况下使用： + +- 当组件处于OMX\_StateLoaded状态，并且用户已经向组件发送OMX\_StateIdle状态转换请求。 +- 当组件处于OMX\_StateWaitForResources状态，所需的资源可用，并且组件已准备好进入OMX\_StateIdle状态。 +- 在去使能端口上，组件处于OMX\_StateExecuting、OMX\_StatePause或OMX\_StateIdle状态。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

self

+

输入参数，指向要操作的Codec组件指针。

+

portIndex

+

输入参数，指定的组件端口。

+

buffer

+

输入输出参数，指向要使用的buffer结构体OmxCodecBuffer指针。

+
+ +**返回：** + +HDF\_SUCCESS 表示指定成功。 + +HDF\_ERR\_INVALID\_PARAM 表示参数无效，指定失败。 + +HDF\_ERR\_INVALID\_OBJECT 表示对象无效，指定失败。 + +HDF\_ERR\_MALLOC\_FAIL 表示申请内存失败，指定失败。 + +**Since：** + +3.1 + +## UseEglImage + +``` +int32_t(* CodecComponentType::UseEglImage) (struct CodecComponentType *self, struct OmxCodecBuffer *buffer, uint32_t portIndex, int8_t *eglImage, uint32_t eglImageLen) +``` + +**描述：** + +使用已在EGL中申请的空间。 + +此接口在以下情况下使用： + +- 当组件处于OMX\_StateLoaded状态，并且已经向组件发送OMX\_StateIdle状态转换请求。 +- 当组件处于OMX\_StateWaitForResources状态，所需的资源可用，并且组件已准备好进入OMX\_StateIdle状态。 +- 在去使能端口上，组件处于OMX\_StateExecuting、OMX\_StatePause或OMX\_StateIdle状态。 + +**参数：** + + + + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

self

+

输入参数，指向要操作的Codec组件指针。

+

buffer

+

输入输出参数，指向OmxCodecBuffer结构体的指针。

+

portIndex

+

输入参数，指定的组件端口。

+

eglImage

+

输入参数，EGL申请的图像指针。

+

eglImageLen

+

输入参数，eglImage字节数。

+
+ +**返回：** + +HDF\_SUCCESS 表示使用成功。 + +HDF\_ERR\_INVALID\_PARAM 表示参数无效，使用失败。 + +HDF\_ERR\_INVALID\_OBJECT 表示对象无效，使用失败。 + +HDF\_ERR\_MALLOC\_FAIL 表示申请内存失败，使用失败。 + +**Since：** + +3.1 + diff --git a/zh-cn/device-dev/api/toctopics/_codec_callback_type.md b/zh-cn/device-dev/api/toctopics/_codec_callback_type.md new file mode 100644 index 0000000000..9dbfa51de3 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_codec_callback_type.md @@ -0,0 +1,54 @@ +# CodecCallbackType + +## **概述** + +**所属模块:** + +[Codec](_codec.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

remote

+

指向HdfRemoteService的指针。 更多...

+

( EventHandler )(struct CodecCallbackType *self, enum OMX_EVENTTYPE event, struct EventInfo *info)

+

事件上报。 更多...

+

( EmptyBufferDone )(struct CodecCallbackType *self, int8_t *appData, uint32_t appDataLen, const struct OmxCodecBuffer *buffer)

+

上报输入buffer编码或者解码处理完毕。 更多...

+

( FillBufferDone )(struct CodecCallbackType *self, int8_t *appData, uint32_t appDataLen, struct OmxCodecBuffer *buffer)

+

上报输出buffer填充完毕。 更多...

+
+ +## **详细描述** + +Codec回调接口定义。 + +提供了以下3种回调函数: + +- 组件错误事件、命令完成事件、端口设置等事件回调，详见EventHandler。 +- 输入端口处理完buffer回调，详见EmptyBufferDone。 +- 输出端口填充完buffer回调，详见FillBufferDone。 通过以下两种方式注册回调: +- 创建组件时，通过CreateComponent方法。 +- 当组件处于OMX\_StateLoaded状态时，通过SetCallbacks方法注册回调。 + diff --git a/zh-cn/device-dev/api/toctopics/_codec_comp_capability.md b/zh-cn/device-dev/api/toctopics/_codec_comp_capability.md new file mode 100644 index 0000000000..d51761b301 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_codec_comp_capability.md @@ -0,0 +1,178 @@ +# CodecCompCapability + +## **概述** + +**所属模块:** + +[Codec](_codec.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

role

+

媒体类型。

+

type

+

编解码类型。

+

compName [NAME_LENGTH]

+

编解码组件名称。

+

supportProfiles [PROFILE_NUM]

+

支持的profiles，详见Profile。

+

maxInst

+

最大实例。

+

isSoftwareCodec

+

软件编解码还是硬件编解码。

+

processModeMask

+

编解码处理模式掩码，详见CodecProcessMode。

+

capsMask

+

编解码播放能力掩码，详见CodecCapsMask。

+

bitRate

+

支持的码率范围。

+

port

+

支持的音视频编解码能力。

+
+ +## **详细描述** + +定义Codec编解码能力。 + +## **类成员变量说明** + +## bitRate + +``` +RangeValue CodecCompCapability::bitRate +``` + +**描述：** + +支持的码率范围 + +## capsMask + +``` +uint32_t CodecCompCapability::capsMask +``` + +**描述：** + +编解码播放能力掩码，详见[CodecCapsMask](_codec.md#ga9e2fbfb8a5881de2f495933f90f23b3f). + +## compName + +``` +char CodecCompCapability::compName[NAME_LENGTH] +``` + +**描述：** + +编解码组件名称 + +## isSoftwareCodec + +``` +bool CodecCompCapability::isSoftwareCodec +``` + +**描述：** + +软件编解码还是硬件编解码 + +## maxInst + +``` +int32_t CodecCompCapability::maxInst +``` + +**描述：** + +最大实例 + +## port + +``` +PortCap CodecCompCapability::port +``` + +**描述：** + +支持的音视频编解码能力 + +## processModeMask + +``` +int32_t CodecCompCapability::processModeMask +``` + +**描述：** + +编解码处理模式掩码，详见[CodecProcessMode](_codec.md#ga5bec468886b760c542669b1615613dc4). + +## role + +``` +AvCodecRole CodecCompCapability::role +``` + +**描述：** + +媒体类型 + +## supportProfiles + +``` +int32_t CodecCompCapability::supportProfiles[PROFILE_NUM] +``` + +**描述：** + +支持的profiles，详见[Profile](_codec.md#ga85b10143618f300ff4f5bc6d45c72c01) + +## type + +``` +CodecType CodecCompCapability::type +``` + +**描述：** + +编解码类型 + diff --git a/zh-cn/device-dev/api/toctopics/_codec_component_manager.md b/zh-cn/device-dev/api/toctopics/_codec_component_manager.md new file mode 100644 index 0000000000..797864db65 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_codec_component_manager.md @@ -0,0 +1,211 @@ +# CodecComponentManager + +## **概述** + +**所属模块:** + +[Codec](_codec.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

(GetComponentNum )()

+

获取Codec编解码组件数量。 更多...

+

( GetComponentCapabilityList )(CodecCompCapability *capList, int32_t count)

+

获取编解码能力集表。 更多...

+

( CreateComponent )(struct CodecComponentType **component, char *compName, void *appData, int32_t appDataSize, struct CodecCallbackType *callbacks)

+

创建Codec组件实例。 更多...

+

( DestoryComponent )(struct CodecComponentType *component)

+

销毁组件实例。 更多...

+
+ +## **详细描述** + +Codec组件管理类接口定义。 + +主要提供以下功能: + +- 获取Codec编解码组件数量以及编解码能力集表。 +- 创建/销毁Codec组件。 + +## **类成员变量说明** + +## CreateComponent + +``` +int32_t(* CodecComponentManager::CreateComponent) (struct CodecComponentType **component, char *compName, void *appData, int32_t appDataSize, struct CodecCallbackType *callbacks) +``` + +**描述：** + +创建Codec组件实例。 + +根据组件名称创建Codec组件实例。 + +**参数：** + + + + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

component

+

输出参数，指向Codec组件的指针。

+

compName

+

输入参数，组件名称。

+

appData

+

输入参数，指向应用程序定义的值的指针，该值将在回调期间返回。

+

appDataSize

+

输入参数，appData字节数。

+

callbacks

+

输入参数，回调接口，指向OMX_CALLBACKTYPE结构的指针，详见CodecCallbackType。

+
+ +**返回：** + +HDF\_SUCCESS 表示创建组件成功。 + +HDF\_ERR\_INVALID\_PARAM 表示参数无效，创建组件失败。 + +HDF\_ERR\_INVALID\_OBJECT 表示对象无效，创建组件失败。 + +HDF\_ERR\_MALLOC\_FAIL 表示申请内存失败，创建组件失败。 + +## DestoryComponent + +``` +int32_t(* CodecComponentManager::DestoryComponent) (struct CodecComponentType *component) +``` + +**描述：** + +销毁组件实例。 + +销毁指定的Codec组件。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

component

+

输入参数，需要销毁的Codec组件。

+
+ +**返回：** + +HDF\_SUCCESS 表示销毁组件成功。 + +HDF\_ERR\_INVALID\_PARAM 表示参数无效，销毁组件失败。 + +HDF\_ERR\_INVALID\_OBJECT 表示对象无效，销毁组件失败。 + +HDF\_ERR\_MALLOC\_FAIL 表示申请内存失败，销毁组件失败。 + +## GetComponentCapabilityList + +``` +int32_t(* CodecComponentManager::GetComponentCapabilityList) (CodecCompCapability *capList, int32_t count) +``` + +**描述：** + +获取编解码能力集表。 + +用户可通过此接口了解Codec模块提供了哪些编解码能力，对应的能力体现在[CodecCompCapability](_codec_comp_capability.md)结构体。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

capList

+

输出参数，返回全部组件的能力集表CodecCompCapability。

+

count

+

输入参数，编解码组件数量，由GetComponentNum获得。

+
+ +**返回：** + +HDF\_SUCCESS 表示获取能力集表成功。 + +HDF\_ERR\_INVALID\_PARAM 表示参数无效，获取能力集表失败。 + +HDF\_ERR\_INVALID\_OBJECT 表示对象无效，获取能力集表失败。 + +HDF\_ERR\_MALLOC\_FAIL 表示申请内存失败，获取能力集表失败。 + +## GetComponentNum + +``` +int32_t(* CodecComponentManager::GetComponentNum) () +``` + +**描述：** + +获取Codec编解码组件数量。 + +通过此接口获取Codec编解码组件数量，用来获取全部编解码能力集。 + +**返回：** + +Codec编解码组件数量。 + diff --git a/zh-cn/device-dev/api/toctopics/_codec_component_type.md b/zh-cn/device-dev/api/toctopics/_codec_component_type.md new file mode 100644 index 0000000000..d34fcae662 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_codec_component_type.md @@ -0,0 +1,125 @@ +# CodecComponentType + +## **概述** + +**所属模块:** + +[Codec](_codec.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

( GetComponentVersion )(struct CodecComponentType *self, struct CompVerInfo *verInfo)

+

获取Codec组件版本号。 更多...

+

( SendCommand )(struct CodecComponentType *self, enum OMX_COMMANDTYPE cmd, uint32_t param, int8_t *cmdData, uint32_t cmdDataLen)

+

发送命令给组件。 更多...

+

( GetParameter )(struct CodecComponentType *self, uint32_t paramIndex, int8_t *paramStruct, uint32_t paramStructLen)

+

获取组件参数设置。 更多...

+

( SetParameter )(struct CodecComponentType *self, uint32_t index, int8_t *paramStruct, uint32_t paramStructLen)

+

设置组件需要的参数。 更多...

+

( GetConfig )(struct CodecComponentType *self, uint32_t index, int8_t *cfgStruct, uint32_t cfgStructLen)

+

获取组件的配置结构。 更多...

+

( SetConfig )(struct CodecComponentType *self, uint32_t index, int8_t *cfgStruct, uint32_t cfgStructLen)

+

设置组件的配置。 更多...

+

( GetExtensionIndex )(struct CodecComponentType *self, const char *paramName, uint32_t *indexType)

+

根据字符串获取组件的扩展索引。 更多...

+

( GetState )(struct CodecComponentType *self, enum OMX_STATETYPE *state)

+

获取组件的当前状态。 更多...

+

( ComponentTunnelRequest )(struct CodecComponentType *self, uint32_t port, int32_t tunneledComp, uint32_t tunneledPort, struct OMX_TUNNELSETUPTYPE *tunnelSetup)

+

设置组件采用Tunnel方式通信。 更多...

+

( UseBuffer )(struct CodecComponentType *self, uint32_t portIndex, struct OmxCodecBuffer *buffer)

+

指定组件端口的buffer。 更多...

+

( AllocateBuffer )(struct CodecComponentType *self, uint32_t portIndex, struct OmxCodecBuffer *buffer)

+

向组件申请端口buffer。 更多...

+

( FreeBuffer )(struct CodecComponentType *self, uint32_t portIndex, const struct OmxCodecBuffer *buffer)

+

释放buffer。 更多...

+

( EmptyThisBuffer )(struct CodecComponentType *self, const struct OmxCodecBuffer *buffer)

+

编解码输入待处理buffer。 更多...

+

( FillThisBuffer )(struct CodecComponentType *self, const struct OmxCodecBuffer *buffer)

+

编解码输出填充buffer。 更多...

+

( SetCallbacks )(struct CodecComponentType *self, struct CodecCallbackType *callback, int8_t *appData, uint32_t appDataLen)

+

设置Codec组件的回调函数。 更多...

+

( ComponentDeInit )(struct CodecComponentType *self)

+

组件去初始化。 更多...

+

( UseEglImage )(struct CodecComponentType *self, struct OmxCodecBuffer *buffer, uint32_t portIndex, int8_t *eglImage, uint32_t eglImageLen)

+

使用已在EGL中申请的空间。 更多...

+

( ComponentRoleEnum )(struct CodecComponentType *self, uint8_t *role, uint32_t roleLen, uint32_t index)

+

获取组件角色。 更多...

+
+ +## **详细描述** + +Codec组件接口定义。 + +主要提供以下功能： + +- 获取组件的版本。 +- 组件参数配置的获取和设置。 +- 发送命令至组件及获取组件状态。 +- 设置回调函数。 +- 设置/释放组件使用的buffer。 +- 编解码输入输出buffer处理 具体方法使用详见函数说明。 + diff --git a/zh-cn/device-dev/api/toctopics/_comp_ver_info.md b/zh-cn/device-dev/api/toctopics/_comp_ver_info.md new file mode 100644 index 0000000000..26b6022446 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_comp_ver_info.md @@ -0,0 +1,88 @@ +# CompVerInfo + +## **概述** + +**所属模块:** + +[Codec](_codec.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

compName [NAME_LENGTH]

+

组件名称

+

compUUID [UUID_LENGTH]

+

组件的UUID标识符

+

compVersion

+

OMX组件版本信息

+

specVersion

+

构建组件所依据的规范的版本信息

+
+ +## **Details** + +## **详细描述** + +## **类成员变量说明** + +## compName + +``` +char CompVerInfo::compName[NAME_LENGTH] +``` + +**描述：** + +组件名称 + +## compUUID + +``` +uint8_t CompVerInfo::compUUID[UUID_LENGTH] +``` + +**描述：** + +组件的UUID标识符 + +## compVersion + +``` +union OMX_VERSIONTYPE CompVerInfo::compVersion +``` + +**描述：** + +OMX组件版本信息 + +## specVersion + +``` +union OMX_VERSIONTYPE CompVerInfo::specVersion +``` + +**描述：** + +构建组件所依据的规范的版本信息 + diff --git a/zh-cn/device-dev/api/toctopics/_credential_info.md b/zh-cn/device-dev/api/toctopics/_credential_info.md new file mode 100644 index 0000000000..05ea67c788 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_credential_info.md @@ -0,0 +1,141 @@ +# CredentialInfo + +## **概述** + +**所属模块:** + +[HdfUserAuth](_hdf_user_auth.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

credentialId

+

认证凭据ID。

+

index

+

用户认证框架的执行器索引。

+

templateId

+

认证凭据模版ID。

+

authType

+

用户认证凭据类型AuthType}。

+

executorType

+

执行器类型。

+

executorId

+

既定用户认证凭据类型的执行器ID。

+

extraInfo

+

其他相关信息，用于支持信息扩展。

+
+ +## **详细描述** + +认证凭据信息。 + +**自动:** + +3.2 + +**Version：** + +1.0 + +## **类成员变量说明** + +## authType + +``` +enum AuthType CredentialInfo::authType +``` + +**描述：** + +用户认证凭据类型。 + +## credentialId + +``` +unsigned long CredentialInfo::credentialId +``` + +**描述：** + +认证凭据ID。 + +## executorId + +``` +unsigned int CredentialInfo::executorId +``` + +**描述：** + +既定用户认证凭据类型的执行器ID。 + +## executorType + +``` +unsigned int CredentialInfo::executorType +``` + +**描述：** + +执行器类型。 + +## extraInfo + +``` +unsigned char [] CredentialInfo::extraInfo +``` + +**描述：** + +其他相关信息，用于支持信息扩展。 + +## index + +``` +unsigned long CredentialInfo::index +``` + +**描述：** + +用户认证框架的执行器索引。 + +## templateId + +``` +unsigned long CredentialInfo::templateId +``` + +**描述：** + +认证凭据模版ID。 + diff --git a/zh-cn/device-dev/api/toctopics/_d_a_c.md b/zh-cn/device-dev/api/toctopics/_d_a_c.md new file mode 100644 index 0000000000..ee6e37795c --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_d_a_c.md @@ -0,0 +1,240 @@ +# DAC + +## **汇总** + +## 文件 + + + + + + + + + + +

文件

+

描述

+

dac_if.h

+

声明标准DAC接口函数。

+
+ +## 类 + + + + + + + + + + +

类

+

描述

+

DacIoMsg

+

DAC设备信息传输结构体 更多...

+
+ +## 函数 + + + + + + + + + + + + + + + + +

函数

+

描述

+

DacOpen (uint32_t number)

+

获取DAC控制器的句柄。 更多...

+

DacClose (DevHandle handle)

+

释放DAC控制器的句柄。 更多...

+

DacWrite (DevHandle handle, uint32_t channel, uint32_t val)

+

启动DAC设备进行传输，将目标值写入指定的DAC通道。 更多...

+
+ +## 变量 + + + + + + + + + + + + + +

变量 名称

+

描述

+

DacIoMsg::number

+

DAC设备号

+

DacIoMsg::channel

+

DAC设备通道号

+
+ +## **详细描述** + +提供数模转换器 \(DAC\) 接口。 + +该模块允许驱动程序在DAC控制器上执行操作以访问DAC通道上的设备，包括创建和销毁DAC控制器句柄和写入数据。 + +**Since：** + +3.1 + +## **函数说明** + +## DacClose\(\) + +``` +void DacClose (DevHandle handle) +``` + +**描述：** + +释放DAC控制器的句柄。 + +如果不再需要访问DAC控制器，则应调用该函数关闭其句柄，以释放未使用的内存资源。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

handle

+

表示指向DAC控制器的设备句柄的指针。

+
+ +**Since：** + +3.1 + +## DacOpen\(\) + +``` +DevHandle DacOpen (uint32_t number) +``` + +**描述：** + +获取DAC控制器的句柄。 + +您必须在访问DAC设备之前调用此函数。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

number

+

表示DAC控制器ID。

+
+ +**返回：** + +DAC控制器的DevHandle指针 表示操作成功。 + +NULL 表示操作失败。 + +**Since：** + +3.1 + +## DacWrite\(\) + +``` +int32_t DacWrite (DevHandle handle, uint32_t channel, uint32_t val ) +``` + +**描述：** + +启动DAC设备进行传输，将目标值写入指定的DAC通道。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

handle

+

表示通过DacOpen获取的DAC控制器设备句柄的指针。

+

channel

+

表示DAC传输消息所通过的通道。

+

val

+

表示设定的目标值。

+
+ +**返回：** + +0 表示操作成功。 + +负值 表示操作失败。 + +**Since：** + +3.1 + +## **变量说明** + +## channel + +``` +uint32_t DacIoMsg::channel +``` + +**描述：** + +DAC设备通道号 + +## number + +``` +uint32_t DacIoMsg::number +``` + +**描述：** + +DAC设备号 + diff --git a/zh-cn/device-dev/api/toctopics/_dac_io_msg.md b/zh-cn/device-dev/api/toctopics/_dac_io_msg.md new file mode 100644 index 0000000000..8285c2142a --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_dac_io_msg.md @@ -0,0 +1,36 @@ +# DacIoMsg + +## **概述** + +**所属模块:** + +[DAC](_d_a_c.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + +

Public 属性

+

描述

+

number

+

DAC设备号

+

channel

+

DAC设备通道号

+
+ +## **详细描述** + +DAC设备信息传输结构体。 + diff --git a/zh-cn/device-dev/api/toctopics/_device_funcs.md b/zh-cn/device-dev/api/toctopics/_device_funcs.md new file mode 100644 index 0000000000..5c69301fe1 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_device_funcs.md @@ -0,0 +1,211 @@ +# DeviceFuncs + +## **概述** + +**所属模块:** + +[Display](_display.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

( RegHotPlugCallback )(HotPlugCallback callback, void *data)

+

注册热插拔事件回调

+

( RegDisplayVBlankCallback )(uint32_t devId, VBlankCallback callback, void *data)

+

注册VBlank事件回调。

+

( RegDisplayRefreshCallback )(uint32_t devId, RefreshCallback callback, void *data)

+

刷新请求回调。

+

( GetDisplayCapability )(uint32_t devId, DisplayCapability *info)

+

获取显示设备能力集。

+

( GetDisplaySupportedModes )(uint32_t devId, uint32_t *num, DisplayModeInfo *modes)

+

获取显示设备支持的显示模式信息。

+

( GetDisplayMode )(uint32_t devId, uint32_t *modeId)

+

获取显示设备当前的显示模式。

+

( SetDisplayMode )(uint32_t devId, uint32_t modeId)

+

设置显示设备的显示模式。

+

( GetDisplayPowerStatus )(uint32_t devId, DispPowerStatus *status)

+

获取显示设备当前的电源状态。

+

( SetDisplayPowerStatus )(uint32_t devId, DispPowerStatus status)

+

设置显示设备当前的电源状态。

+

( GetDisplayBacklight )(uint32_t devId, uint32_t *level)

+

获取显示设备当前的背光值。

+

( SetDisplayBacklight )(uint32_t devId, uint32_t level)

+

设置显示设备当前的背光值。

+

( GetDisplayProperty )(uint32_t devId, uint32_t id, uint64_t *value)

+

获取显示设备属性值。

+

( SetDisplayProperty )(uint32_t devId, uint32_t id, uint64_t value)

+

设置显示设备属性值。

+

( PrepareDisplayLayers )(uint32_t devId, bool *needFlushFb)

+

显示设备合成前准备

+

( GetDisplayCompChange )(uint32_t devId, uint32_t *num, uint32_t *Layers, int32_t *type)

+

获取显示设备合成类型有变化的layer

+

( SetDisplayClientCrop )(uint32_t devId, IRect *rect)

+

设置显示设备的裁剪区域。

+

( SetDisplayClientDestRect )(uint32_t devId, IRect *rect)

+

设置显示设备的显示区域。

+

( SetDisplayClientBuffer )(uint32_t devId, const BufferHandle *buffer, int32_t fence)

+

设置显示设备的显示缓存。

+

( SetDisplayClientDamage )(uint32_t devId, uint32_t num, IRect *rect)

+

设置显示设备的显示脏区

+

( SetDisplayVsyncEnabled )(uint32_t devId, bool enabled)

+

使能垂直同步信号。

+

( GetDisplayReleaseFence )(uint32_t devId, uint32_t *num, uint32_t *layers, int32_t *fences)

+

获取显示图层fence。

+

( GetDisplaySupportedColorGamuts )(uint32_t devId, uint32_t *num, ColorGamut *gamuts)

+

获取显示设备支持的色域信息。

+

( GetDisplayColorGamut )(uint32_t devId, ColorGamut *gamut)

+

获取显示设备当前的色域模式。

+

( SetDisplayColorGamut )(uint32_t devId, ColorGamut gamut)

+

设置显示设备当前的色域模式。

+

( GetDisplayGamutMap )(uint32_t devId, GamutMap *gamutMap)

+

获取显示设备当前的色域映射模式。

+

( SetDisplayGamutMap )(uint32_t devId, GamutMap gamutMap)

+

设置显示设备当前的色域映射模式。

+

( SetDisplayColorTransform )(uint32_t devId, const float *matrix)

+

设置显示设备当前的4x4的颜色转换矩阵。

+

( GetHDRCapabilityInfos )(uint32_t devId, HDRCapability *info)

+

获取显示设备支持的HDR属性信息。

+

( GetSupportedMetadataKey )(uint32_t devId, uint32_t *num, HDRMetadataKey *keys)

+

获取显示设备支持的 HDRMetadataKey。

+

( Commit )(uint32_t devId, int32_t *fence)

+

提交合成送显请求。

+

( InvokeDisplayCmd )(uint32_t devId,...)

+

调用显示设备命令。

+

( CreateVirtualDisplay )(uint32_t width, uint32_t height, int32_t *format, uint32_t *devId)

+

创建虚拟显示设备。

+

( DestroyVirtualDisplay )(uint32_t devId)

+

销毁虚拟显示设备。

+

( SetVirtualDisplayBuffer )(uint32_t devId, BufferHandle *buffer, int32_t fence)

+

设置虚拟屏的输出缓存。

+

( GetWriteBackFrame )(uint32_t devId, BufferHandle *buffer, int32_t *fence)

+

获取显示设备的回写帧。

+

( CreateWriteBack )(uint32_t *devId, uint32_t width, uint32_t height, int32_t *format)

+

对指定显示设备创建回写点。

+

( DestroyWriteBack )(uint32_t devId)

+

销毁指定显示设备的回写点。

+
+ +## **详细描述** + +显示设备控制接口结构体，定义显示设备控制接口函数指针。 + diff --git a/zh-cn/device-dev/api/toctopics/_device_info.md b/zh-cn/device-dev/api/toctopics/_device_info.md new file mode 100644 index 0000000000..e2627c5269 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_device_info.md @@ -0,0 +1,223 @@ +# DeviceInfo + +## **概述** + +**所属模块:** + +[Input](_input.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

devIndex

+

设备索引

+

fd

+

设备对应的文件描述符

+

service

+

设备对应的服务

+

listener

+

设备对应的事件监听器

+

devType

+

设备类型

+

powerStatus

+

电源状态

+

chipInfo [CHIP_INFO_LEN]

+

驱动芯片编码信息

+

vendorName [VENDOR_NAME_LEN]

+

模组厂商名

+

chipName [CHIP_NAME_LEN]

+

驱动芯片型号

+

devNodePath [MAX_NODE_PATH_LEN]

+

设备文件路径

+

solutionX

+

x方向分辨率

+

solutionY

+

y方向分辨率

+

callback

+

数据上报回调函数 InputReportEventCb

+
+ +## **详细描述** + +input设备基础设备信息 + +## **类成员变量说明** + +## callback + +``` +InputReportEventCb* DeviceInfo::callback +``` + +**描述：** + +数据上报回调函数 [InputReportEventCb](_input_report_event_cb.md) + +## chipInfo + +``` +char DeviceInfo::chipInfo[CHIP_INFO_LEN] +``` + +**描述：** + +驱动芯片编码信息 + +## chipName + +``` +char DeviceInfo::chipName[CHIP_NAME_LEN] +``` + +**描述：** + +驱动芯片型号 + +## devIndex + +``` +uint32_t DeviceInfo::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 +``` + +**描述：** + +设备对应的服务 + +## solutionX + +``` +uint32_t DeviceInfo::solutionX +``` + +**描述：** + +x方向分辨率 + +## solutionY + +``` +uint32_t DeviceInfo::solutionY +``` + +**描述：** + +y方向分辨率 + +## vendorName + +``` +char DeviceInfo::vendorName[VENDOR_NAME_LEN] +``` + +**描述：** + +模组厂商名 + diff --git a/zh-cn/device-dev/api/toctopics/_display.md b/zh-cn/device-dev/api/toctopics/_display.md new file mode 100644 index 0000000000..d4f484d960 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_display.md @@ -0,0 +1,5817 @@ +# Display + +## **汇总** + +## 文件 + + + + + + + + + + + + + + + + + + + + + + +

文件

+

描述

+

display_device.h

+

显示设备控制接口声明。

+

display_gfx.h

+

显示硬件加速驱动接口声明。

+

display_gralloc.h

+

显示内存驱动接口声明。

+

display_layer.h

+

显示图层驱动接口声明。

+

display_type.h

+

显示类型定义，定义显示驱动接口所使用的数据类型。

+
+ +## 类 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

类

+

描述

+

DeviceFuncs

+

显示设备控制接口结构体，定义显示设备控制接口函数指针。 更多...

+

GfxFuncs

+

显示硬件加速驱动接口结构体，定义硬件加速驱动接口函数指针。 更多...

+

GrallocFuncs

+

显示内存驱动接口结构体，定义显示内存驱动接口函数指针。 更多...

+

LayerFuncs

+

显示图层驱动接口结构体，定义显示图层驱动接口函数指针。 更多...

+

DisplayInfo

+

定义显示信息结构体 更多...

+

LayerInfo

+

定义图层信息结构体 更多...

+

LayerAlpha

+

定义图层Alpha信息的结构体 更多...

+

BufferData

+

定义一层的缓冲区数据，包括虚拟和物理内存地址。 更多...

+

LayerBuffer

+

图层Buffer，用于存放图层数据。 更多...

+

IRect

+

定义矩形信息 更多...

+

ISurface

+

用于存放窗口相关信息的结构体定义，提供给硬件加速使用，例如图像合成，位图搬移等操作。 更多...

+

ILine

+

线条描述结构体定义，用于硬件加速绘制直线。 更多...

+

ICircle

+

圆形描述结构体定义，用于硬件加速绘制圆形。 更多...

+

Rectangle

+

矩形描述结构体定义，用于硬件加速绘制矩形， 更多...

+

GfxOpt

+

图像硬件加速相关的操作选项结构体定义，用于图像硬件加速时的操作选项。 更多...

+

PropertyObject

+

定义包含名称、属性ID和值的属性对象。 更多...

+

DisplayCapability

+

定义输出性能。 更多...

+

DisplayModeInfo

+

定义输出模式信息。 更多...

+

AllocInfo

+

定义关于要分配的内存的信息。 更多...

+

HDRCapability

+

HDR属性结构体定义 更多...

+

HDRMetaData

+

HDR元数据结构体定义 更多...

+

VerifyAllocInfo

+

用于验证内存分配信息的结构体定义 更多...

+

PresentTimestamp

+

上屏时间戳结构体定义 更多...

+

__attribute__

+

扩展数据句柄结构体定义 更多...

+
+ +## 宏定义 + + + + + + + + + + +

宏定义

+

描述

+

PROPERTY_NAME_LEN 50

+

属性名字长度。

+
+ +## 类型定义 + + + + + + + + + + + + + + + + +

类型定义

+

描述

+

(HotPlugCallback) (uint32_t devId, bool connected, void *data)

+

热插拔事件回调。更多...

+

(VBlankCallback) (unsigned int sequence, uint64_t ns, void *data)

+

VBlank 事件回调。 更多...

+

(RefreshCallback) (uint32_t devId, void *data)

+

刷新请求回调。更多...

+
+ +## 枚举 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举

+

描述

+

DispErrCode { DISPLAY_SUCCESS = 0, DISPLAY_FAILURE = -1, DISPLAY_FD_ERR = -2, DISPLAY_PARAM_ERR = -3, DISPLAY_NULL_PTR = -4, DISPLAY_NOT_SUPPORT = -5, DISPLAY_NOMEM = -6, DISPLAY_SYS_BUSY = -7, DISPLAY_NOT_PERM = -8 }

+

返回值类型定义。 更多...

+

LayerType { LAYER_TYPE_GRAPHIC, LAYER_TYPE_OVERLAY, LAYER_TYPE_SDIEBAND, LAYER_TYPE_CURSOR, LAYER_TYPE_BUTT }

+

图层类型定义。 更多...

+

{ HBM_USE_CPU_READ = (1 << 0), HBM_USE_CPU_WRITE = (1 << 1), HBM_USE_MEM_MMZ = (1 << 2), HBM_USE_MEM_DMA = (1 << 3), HBM_USE_MEM_SHARE = (1 << 4), HBM_USE_MEM_MMZ_CACHE = (1 << 5), HBM_USE_MEM_FB = (1 << 6), HBM_USE_ASSIGN_SIZE = (1 << 7) }

+

缓冲区定义。更多...

+

PixelFormat { PIXEL_FMT_CLUT8 = 0, PIXEL_FMT_CLUT1, PIXEL_FMT_CLUT4, PIXEL_FMT_RGB_565, PIXEL_FMT_RGBA_5658, PIXEL_FMT_RGBX_4444, PIXEL_FMT_RGBA_4444, PIXEL_FMT_RGB_444, PIXEL_FMT_RGBX_5551, PIXEL_FMT_RGBA_5551, PIXEL_FMT_RGB_555, PIXEL_FMT_RGBX_8888, PIXEL_FMT_RGBA_8888, PIXEL_FMT_RGB_888, PIXEL_FMT_BGR_565, PIXEL_FMT_BGRX_4444, PIXEL_FMT_BGRA_4444, PIXEL_FMT_BGRX_5551, PIXEL_FMT_BGRA_5551, PIXEL_FMT_BGRX_8888, PIXEL_FMT_BGRA_8888, PIXEL_FMT_YUV_422_I, PIXEL_FMT_YCBCR_422_SP, PIXEL_FMT_YCRCB_422_SP, PIXEL_FMT_YCBCR_420_SP, PIXEL_FMT_YCRCB_420_SP, PIXEL_FMT_YCBCR_422_P, PIXEL_FMT_YCRCB_422_P, PIXEL_FMT_YCBCR_420_P, PIXEL_FMT_YCRCB_420_P, PIXEL_FMT_YUYV_422_PKG, PIXEL_FMT_UYVY_422_PKG, PIXEL_FMT_YVYU_422_PKG, PIXEL_FMT_VYUY_422_PKG, PIXEL_FMT_VENDER_MASK = 0X7FFF0000, PIXEL_FMT_BUTT = 0X7FFFFFFF }

+

像素格式类型定义。 更多...

+

TransformType { ROTATE_NONE = 0, ROTATE_90, ROTATE_180, ROTATE_270, ROTATE_BUTT }

+

图层变换类型定义。 更多...

+

BlendType { BLEND_NONE = 0, BLEND_CLEAR, BLEND_SRC, BLEND_SRCOVER, BLEND_DSTOVER, BLEND_SRCIN, BLEND_DSTIN, BLEND_SRCOUT, BLEND_DSTOUT, BLEND_SRCATOP, BLEND_DSTATOP, BLEND_ADD, BLEND_XOR, BLEND_DST, BLEND_AKS, BLEND_AKD, BLEND_BUTT }

+

显示内存类型定义。 更多...

+

RopType { ROP_BLACK = 0, ROP_NOTMERGEPEN, ROP_MASKNOTPEN, ROP_NOTCOPYPEN, ROP_MASKPENNOT, ROP_NOT, ROP_XORPEN, ROP_NOTMASKPEN, ROP_MASKPEN, ROP_NOTXORPEN, ROP_NOP, ROP_MERGENOTPEN, ROP_COPYPE, ROP_MERGEPENNOT, ROP_MERGEPEN, ROP_WHITE, ROP_BUTT }

+

硬件加速支持的ROP操作类型。 更多...

+

ColorKey { CKEY_NONE = 0, CKEY_SRC, CKEY_DST, CKEY_BUTT }

+

Color key操作类型定义，即硬件加速支持的Color key操作类型。 更多...

+

MirrorType { MIRROR_NONE = 0, MIRROR_LR, MIRROR_TB, MIRROR_BUTT }

+

硬件加速支持的镜像操作类型定义 更多...

+

Connection { CON_INVALID = 0, CONNECTED, DISCONNECTED }

+

热插拔连接类型定义 更多...

+

InterfaceType { DISP_INTF_HDMI = 0, DISP_INTF_LCD, DISP_INTF_BT1120, DISP_INTF_BT656, DISP_INTF_YPBPR, DISP_INTF_RGB, DISP_INTF_CVBS, DISP_INTF_SVIDEO, DISP_INTF_VGA, DISP_INTF_MIPI, DISP_INTF_PANEL, DISP_INTF_BUTT }

+

枚举接口类型。 更多...

+

DispPowerStatus { POWER_STATUS_ON, POWER_STATUS_STANDBY, POWER_STATUS_SUSPEND, POWER_STATUS_OFF, POWER_STATUS_BUTT }

+

枚举显示状态 更多...

+

CompositionType { COMPOSITION_CLIENT, COMPOSITION_DEVICE, COMPOSITION_CURSOR, COMPOSITION_VIDEO, COMPOSITION_DEVICE_CLEAR, COMPOSITION_CLIENT_CLEAR, COMPOSITION_TUNNEL, COMPOSITION_BUTT }

+

枚举特殊层的组合类型。 更多...

+

ColorGamut { COLOR_GAMUT_INVALID = -1, COLOR_GAMUT_NATIVE = 0, COLOR_GAMUT_SATNDARD_BT601 = 1, COLOR_GAMUT_STANDARD_BT709 = 2, COLOR_GAMUT_DCI_P3 = 3, COLOR_GAMUT_SRGB = 4, COLOR_GAMUT_ADOBE_RGB = 5, COLOR_GAMUT_DISPLAY_P3 = 6, COLOR_GAMUT_BT2020 = 7, COLOR_GAMUT_BT2100_PQ = 8, COLOR_GAMUT_BT2100_HLG = 9, COLOR_GAMUT_DISPLAY_BT2020 = 10 }

+

色域类型枚举值 更多...

+

GamutMap { GAMUT_MAP_CONSTANT = 0, GAMUT_MAP_EXPANSION = 1, GAMUT_MAP_HDR_CONSTANT = 2, GAMUT_MAP_HDR_EXPANSION = 3 }

+

枚举色域的映射类型 更多...

+

ColorDataSpace { COLOR_DATA_SPACE_UNKNOWN = 0, GAMUT_BT601 = 0x00000001, GAMUT_BT709 = 0x00000002, GAMUT_DCI_P3 = 0x00000003, GAMUT_SRGB = 0x00000004, GAMUT_ADOBE_RGB = 0x00000005, GAMUT_DISPLAY_P3 = 0x00000006, GAMUT_BT2020 = 0x00000007, GAMUT_BT2100_PQ = 0x00000008, GAMUT_BT2100_HLG = 0x00000009, GAMUT_DISPLAY_BT2020 = 0x0000000a, TRANSFORM_FUNC_UNSPECIFIED = 0x00000100, TRANSFORM_FUNC_LINEAR = 0x00000200, TRANSFORM_FUNC_SRGB = 0x00000300, TRANSFORM_FUNC_SMPTE_170M = 0x00000400, TRANSFORM_FUNC_GM2_2 = 0x00000500, TRANSFORM_FUNC_GM2_6 = 0x00000600, TRANSFORM_FUNC_GM2_8 = 0x00000700, TRANSFORM_FUNC_ST2084 = 0x00000800, TRANSFORM_FUNC_HLG = 0x00000900, PRECISION_UNSPECIFIED = 0x00010000, PRECISION_FULL = 0x00020000, PRESION_LIMITED = 0x00030000, PRESION_EXTENDED = 0x00040000, BT601_SMPTE170M_FULL = GAMUT_BT601 | TRANSFORM_FUNC_SMPTE_170M | PRECISION_FULL, BT601_SMPTE170M_LIMITED = GAMUT_BT601 | TRANSFORM_FUNC_SMPTE_170M | PRESION_LIMITED, BT709_LINEAR_FULL = GAMUT_BT709 | TRANSFORM_FUNC_LINEAR | PRECISION_FULL, BT709_LINEAR_EXTENDED = GAMUT_BT709 | TRANSFORM_FUNC_LINEAR | PRESION_EXTENDED, BT709_SRGB_FULL = GAMUT_BT709 | TRANSFORM_FUNC_SRGB | PRECISION_FULL, BT709_SRGB_EXTENDED = GAMUT_BT709 | TRANSFORM_FUNC_SRGB | PRESION_EXTENDED, BT709_SMPTE170M_LIMITED = GAMUT_BT709 | TRANSFORM_FUNC_SMPTE_170M | PRESION_LIMITED, DCI_P3_LINEAR_FULL = GAMUT_DCI_P3 | TRANSFORM_FUNC_LINEAR | PRECISION_FULL, DCI_P3_GAMMA26_FULL = GAMUT_DCI_P3 | TRANSFORM_FUNC_GM2_6 | PRECISION_FULL, DISPLAY_P3_LINEAR_FULL = GAMUT_DISPLAY_P3 | TRANSFORM_FUNC_LINEAR | PRECISION_FULL, DCI_P3_SRGB_FULL = GAMUT_DCI_P3 | TRANSFORM_FUNC_SRGB | PRECISION_FULL, ADOBE_RGB_GAMMA22_FULL = GAMUT_ADOBE_RGB | TRANSFORM_FUNC_GM2_2 | PRECISION_FULL, BT2020_LINEAR_FULL = GAMUT_BT2020 | TRANSFORM_FUNC_LINEAR | PRECISION_FULL, BT2020_SRGB_FULL = GAMUT_BT2020 | TRANSFORM_FUNC_SRGB | PRECISION_FULL, BT2020_SMPTE170M_FULL = GAMUT_BT2020 | TRANSFORM_FUNC_SMPTE_170M | PRECISION_FULL, BT2020_ST2084_FULL = GAMUT_BT2020 | TRANSFORM_FUNC_ST2084 | PRECISION_FULL, BT2020_HLG_FULL = GAMUT_BT2020 | TRANSFORM_FUNC_HLG | PRECISION_FULL, BT2020_ST2084_LIMITED = GAMUT_BT2020 | TRANSFORM_FUNC_ST2084 | PRESION_LIMITED }

+

枚举颜色空间的类型 更多...

+

HDRFormat { NOT_SUPPORT_HDR = 0, DOLBY_VISION = 1, HDR10 = 2, HLG = 3, HDR10_PLUS = 4, HDR_VIVID = 5 }

+

枚举HDR格式 更多...

+

HDRMetadataKey { MATAKEY_RED_PRIMARY_X = 0, MATAKEY_RED_PRIMARY_Y = 1, MATAKEY_GREEN_PRIMARY_X = 2, MATAKEY_GREEN_PRIMARY_Y = 3, MATAKEY_BLUE_PRIMARY_X = 4, MATAKEY_BLUE_PRIMARY_Y = 5, MATAKEY_WHITE_PRIMARY_X = 6, MATAKEY_WHITE_PRIMARY_Y = 7, MATAKEY_MAX_LUMINANCE = 8, MATAKEY_MIN_LUMINANCE = 9, MATAKEY_MAX_CONTENT_LIGHT_LEVEL = 10, MATAKEY_MAX_FRAME_AVERAGE_LIGHT_LEVEL = 11, MATAKEY_HDR10_PLUS = 12, MATAKEY_HDR_VIVID = 13 }

+

枚举HDR元数据关键字 更多...

+

PresentTimestampType { HARDWARE_DISPLAY_PTS_UNSUPPORTED = 0, HARDWARE_DISPLAY_PTS_DELAY = 1 << 0, HARDWARE_DISPLAY_PTS_TIMESTAMP = 1 << 1 }

+

上屏时间戳类型枚举值 更多...

+
+ +## 函数 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

函数

+

描述

+

DeviceInitialize (DeviceFuncs **funcs)

+

实现显示设备控制接口的初始化，申请操作显示设备控制接口的资源，并获取对应的操作接口。 更多...

+

DeviceUninitialize (DeviceFuncs *funcs)

+

取消显示设备控制接口的初始化，释放控制接口使用到的资源。 更多...

+

GfxInitialize (GfxFuncs **funcs)

+

获取硬件加速相关的操作接口指针。 更多...

+

GfxUninitialize (GfxFuncs *funcs)

+

释放硬件加速相关的操作接口指针。 更多...

+

GrallocInitialize (GrallocFuncs **funcs)

+

初始化内存模块，并获取内存提供的操作接口。 更多...

+

GrallocUninitialize (GrallocFuncs *funcs)

+

取消初始化内存模块，并释放内存操作接口指针。 更多...

+

LayerInitialize (LayerFuncs **funcs)

+

实现图层初始化功能，申请图层使用的资源，并获取图层提供的操作接口。 更多...

+

LayerUninitialize (LayerFuncs *funcs)

+

取消图层初始化功能，释放图层使用到的资源，并释放图层操作接口指针。 更多...

+
+ +## 变量 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

变量 名称

+

描述

+

( DeviceFuncs::RegHotPlugCallback )(HotPlugCallback callback, void *data)

+

注册热插拔事件回调。 更多...

+

( DeviceFuncs::RegDisplayVBlankCallback )(uint32_t devId, VBlankCallback callback, void *data)

+

注册VBlank事件回调。 更多...

+

( DeviceFuncs::RegDisplayRefreshCallback )(uint32_t devId, RefreshCallback callback, void *data)

+

刷新请求回调。 更多...

+

( DeviceFuncs::GetDisplayCapability )(uint32_t devId, DisplayCapability *info)

+

获取显示设备能力集。 更多...

+

( DeviceFuncs::GetDisplaySupportedModes )(uint32_t devId, uint32_t *num, DisplayModeInfo *modes)

+

获取显示设备支持的显示模式信息。 更多...

+

( DeviceFuncs::GetDisplayMode )(uint32_t devId, uint32_t *modeId)

+

获取显示设备当前的显示模式。 更多...

+

( DeviceFuncs::SetDisplayMode )(uint32_t devId, uint32_t modeId)

+

设置显示设备的显示模式。 更多...

+

( DeviceFuncs::GetDisplayPowerStatus )(uint32_t devId, DispPowerStatus *status)

+

获取显示设备当前的电源状态。 更多...

+

( DeviceFuncs::SetDisplayPowerStatus )(uint32_t devId, DispPowerStatus status)

+

设置显示设备当前的电源状态。 更多...

+

( DeviceFuncs::GetDisplayBacklight )(uint32_t devId, uint32_t *level)

+

获取显示设备当前的背光值。 更多...

+

( DeviceFuncs::SetDisplayBacklight )(uint32_t devId, uint32_t level)

+

设置显示设备当前的背光值。 更多...

+

( DeviceFuncs::GetDisplayProperty )(uint32_t devId, uint32_t id, uint64_t *value)

+

设置显示设备属性值。 更多...

+

( DeviceFuncs::SetDisplayProperty )(uint32_t devId, uint32_t id, uint64_t value)

+

设置显示设备属性值。 更多...

+

( DeviceFuncs::PrepareDisplayLayers )(uint32_t devId, bool *needFlushFb)

+

显示设备合成前准备。 更多...

+

( DeviceFuncs::GetDisplayCompChange )(uint32_t devId, uint32_t *num, uint32_t *Layers, int32_t *type)

+

获取显示设备合成类型有变化的layer。 更多...

+

( DeviceFuncs::SetDisplayClientCrop )(uint32_t devId, IRect *rect)

+

设置显示设备的裁剪区域。 更多...

+

( DeviceFuncs::SetDisplayClientDestRect )(uint32_t devId, IRect *rect)

+

设置显示设备的显示区域。 更多...

+

( DeviceFuncs::SetDisplayClientBuffer )(uint32_t devId, const BufferHandle *buffer, int32_t fence)

+

设置显示设备的显示缓存。 更多...

+

( DeviceFuncs::SetDisplayClientDamage )(uint32_t devId, uint32_t num, IRect *rect)

+

设置显示设备的显示脏区。 更多...

+

( DeviceFuncs::SetDisplayVsyncEnabled )(uint32_t devId, bool enabled)

+

使能垂直同步信号。 更多...

+

( DeviceFuncs::GetDisplayReleaseFence )(uint32_t devId, uint32_t *num, uint32_t *layers, int32_t *fences)

+

获取显示图层fence。 更多...

+

( DeviceFuncs::GetDisplaySupportedColorGamuts )(uint32_t devId, uint32_t *num, ColorGamut *gamuts)

+

获取显示设备支持的色域信息。 更多...

+

( DeviceFuncs::GetDisplayColorGamut )(uint32_t devId, ColorGamut *gamut)

+

获取显示设备当前的色域模式。 更多...

+

( DeviceFuncs::SetDisplayColorGamut )(uint32_t devId, ColorGamut gamut)

+

设置显示设备当前的色域模式。 更多...

+

( DeviceFuncs::GetDisplayGamutMap )(uint32_t devId, ColorGamut *gamutMap)

+

获取显示设备当前的色域映射模式。 更多...

+

( DeviceFuncs::SetDisplayGamutMap )(uint32_t devId, ColorGamut gamutMap)

+

设置显示设备当前的色域映射模式。 更多...

+

( DeviceFuncs::SetDisplayColorTransform )(uint32_t devId, const float *matrix)

+

设置显示设备当前的4x4的颜色转换矩阵。 更多...

+

( DeviceFuncs::GetHDRCapabilityInfos )(uint32_t devId, HDRCapability *info)

+

获取显示设备支持的HDR属性信息。 更多...

+

( DeviceFuncs::GetSupportedMetadataKey )(uint32_t devId, uint32_t *num, HDRMetadataKey *keys)

+

获取显示设备支持的 HDRMetadataKey。 更多...

+

( DeviceFuncs::Commit )(uint32_t devId, int32_t *fence)

+

提交合成送显请求。 更多...

+

( DeviceFuncs::InvokeDisplayCmd )(uint32_t devId,...)

+

调用显示设备命令。 更多...

+

( DeviceFuncs::CreateVirtualDisplay )(uint32_t width, uint32_t height, int32_t *format, uint32_t *devId)

+

创建虚拟显示设备。 更多...

+

( DeviceFuncs::DestroyVirtualDisplay )(uint32_t devId)

+

销毁虚拟显示设备。 更多...

+

( DeviceFuncs::SetVirtualDisplayBuffer )(uint32_t devId, BufferHandle *buffer, int32_t fence)

+

设置虚拟屏的输出缓存。 更多...

+

( DeviceFuncs::GetWriteBackFrame )(uint32_t devId, BufferHandle *buffer, int32_t *fence)

+

获取显示设备的回写帧。 更多...

+

( DeviceFuncs::CreateWriteBack )(uint32_t *devId, uint32_t width, uint32_t height, int32_t *format)

+

对指定显示设备创建回写点。 更多...

+

( DeviceFuncs::DestroyWriteBack )(uint32_t devId)

+

销毁指定显示设备的回写点。 更多...

+

DisplayInfo::width

+

显示屏宽度

+

DisplayInfo::height

+

显示屏高度

+

DisplayInfo::rotAngle

+

显示屏旋转角度

+

LayerInfo::width

+

图层宽度

+

LayerInfo::height

+

图层高度

+

LayerInfo::type

+

图层类型，包括图形层、视频层和媒体播放模式

+

LayerInfo::bpp

+

每像素所占bit数

+

LayerInfo::pixFormat

+

图层像素格式

+

LayerAlpha::enGlobalAlpha

+

全局alpha使能标志

+

LayerAlpha::enPixelAlpha

+

像素alpha使能标志

+

LayerAlpha::alpha0

+

alpha0值，取值范围：[0, 255]

+

LayerAlpha::alpha1

+

alpha1值，取值范围：[0, 255]

+

LayerAlpha::gAlpha

+

全局alpha值，取值范围：[0, 255]

+

BufferData::phyAddr

+

物理内存地址

+

BufferData::virAddr

+

虚拟内存地址

+

LayerBuffer::fenceId

+

buffer 的fence号r

+

LayerBuffer::width

+

buffer宽度

+

LayerBuffer::height

+

buffer高度

+

LayerBuffer::pitch

+

一行数据所占字节数

+

LayerBuffer::pixFormat

+

buffer像素格式r

+

LayerBuffer::data

+

图层buffer数据

+

LayerBuffer::hdl

+

图层buffer句柄

+

IRect::x

+

矩形框起始x坐标

+

IRect::y

+

矩形框起始y坐标

+

IRect::w

+

矩形框宽度

+

IRect::h

+

矩形框高度

+

ISurface::phyAddr

+

图像首地址

+

ISurface::height

+

图像高度

+

ISurface::width

+

图像宽度

+

ISurface::stride

+

图像跨度

+

ISurface::enColorFmt

+

图像格式

+

ISurface::bYCbCrClut

+

CLUT表是否位于 YCbCr 空间

+

ISurface::bAlphaMax255

+

图像alpha最大值为255还是128

+

ISurface::bAlphaExt1555

+

是否使能1555的Alpha扩展

+

ISurface::alpha0

+

Alpha0值，取值范围：[0,255]

+

ISurface::alpha1

+

Alpha1值，取值范围：[0,255]

+

ISurface::cbcrPhyAddr

+

CbCr分量地址

+

ISurface::cbcrStride

+

CbCr分量跨度

+

ISurface::clutPhyAddr

+

Clut表首地址，用作颜色扩展或颜色校正

+

ILine::x0

+

线条起点的x坐标

+

ILine::y0

+

线条起点的y坐标

+

ILine::x1

+

线条终点的x坐标

+

ILine::y1

+

线条终点的y坐标

+

ILine::color

+

线条颜色

+

ICircle::x

+

圆心x坐标

+

ICircle::y

+

圆心y坐标r

+

ICircle::r

+

圆的半径

+

ICircle::color

+

圆的颜色

+

Rectangle::rect

+

矩形区域

+

Rectangle::color

+

矩形颜色

+

GfxOpt::enGlobalAlpha

+

全局alpha使能位

+

GfxOpt::globalAlpha

+

全局alpha的值

+

GfxOpt::enPixelAlpha

+

像素alpha使能位

+

GfxOpt::blendType

+

混合方式

+

GfxOpt::colorKeyFrom

+

色键模式

+

GfxOpt::enableRop

+

Rop功能使能位

+

GfxOpt::colorRopType

+

颜色的Rop类型

+

GfxOpt::alphaRopType

+

Alpha的Rop类型

+

GfxOpt::enableScale

+

缩放功能使能位

+

GfxOpt::rotateType

+

旋转类型

+

GfxOpt::mirrorType

+

镜像类型

+

PropertyObject::name [PROPERTY_NAME_LEN]

+

属性名称

+

PropertyObject::propId

+

属性ID

+

PropertyObject::value

+

属性值

+

DisplayCapability::name [PROPERTY_NAME_LEN]

+

显示设备名称

+

DisplayCapability::type

+

显示屏接口类型

+

DisplayCapability::phyWidth

+

物理宽度

+

DisplayCapability::phyHeight

+

物理高度

+

DisplayCapability::supportLayers

+

支持的图层数

+

DisplayCapability::virtualDispCount

+

支持的虚拟屏数

+

DisplayCapability::supportWriteBack

+

是否支持回写

+

DisplayCapability::propertyCount

+

属性数组大小

+

DisplayCapability::props

+

属性数组

+

DisplayModeInfo::width

+

像素宽度

+

DisplayModeInfo::height

+

像素高度

+

DisplayModeInfo::freshRate

+

刷新速率

+

DisplayModeInfo::id

+

模式ID

+

AllocInfo::width

+

申请内存宽度

+

AllocInfo::height

+

申请内存高度

+

AllocInfo::usage

+

申请内存的使用场景

+

AllocInfo::format

+

申请内存格式

+

AllocInfo::expectedSize

+

申请内存大小

+

HDRCapability::formatCount

+

支持的HDR格式的数量

+

HDRCapability::formats

+

支持的HDR格式的数组首地址

+

HDRCapability::maxLum

+

最大的光亮度luminance值

+

HDRCapability::maxAverageLum

+

最大的平均光亮度luminance值

+

HDRCapability::minLum

+

最小的光亮度luminance值

+

HDRMetaData::key

+

HDR元数据关键字

+

HDRMetaData::value

+

关键字对应的值

+

VerifyAllocInfo::width

+

分配内存的宽度

+

VerifyAllocInfo::height

+

分配内存的高度

+

VerifyAllocInfo::usage

+

内存的用处

+

VerifyAllocInfo::format

+

分配内存的像素格式

+

PresentTimestamp::type

+

上屏时间戳类型

+

PresentTimestamp::time

+

类型对应的值

+

__attribute__::fd

+

句柄 fd，-1代表不支持

+

__attribute__::reserveInts

+

reserve数组的个数

+

__attribute__::reserve [0]

+

reserve数组

+

__attribute__::baseAddr

+

内存的初始地址

+

__attribute__::yOffset

+

Y的偏移量

+

__attribute__::uOffset

+

U的偏移量

+

__attribute__::vOffset

+

V的偏移量

+

__attribute__::yStride

+

Y的stride信息

+

__attribute__::uvStride

+

UV的stride信息

+

__attribute__::uvStep

+

UV的step信息

+
+ +## **详细描述** + +显示模块驱动接口定义。 + +提供给图形系统使用的驱动接口，包括图层管理、设备控制、图形硬件加速、显示内存管理和回调接口等。 + +**Since：** + +1.0 + +**Version：** + +2.0 + +## **类型定义说明** + +## HotPlugCallback + +``` +typedef void(* HotPlugCallback) (uint32_t devId, bool connected, void *data) +``` + +**描述：** + +热插拔事件回调。 + +当有热插拔事件发生时，会回调该接口，需要通过RegHotPlugCallback注册该回调接口。 + +@paramdevId 输入参数，显示设备ID，此ID由HDI实现层生成，并通过当前回调接口传递给图形服务使用，用以标记当前连接的显示设备。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

connected

+

输入参数，指明设备的连接状态，ture代表连接，false代表断开。

+

data

+

输出参数，图形服务携带的私有数据，该参数携带的是RegHotPlugCallback接口注册时传递的私有数据地址，详情参考 {@RegHotPlugCallback} 接口注册时传递的地址。

+
+ +## RefreshCallback + +``` +typedef void(* RefreshCallback) (uint32_t devId, void *data) +``` + +**描述：** + +刷新请求回调。 + +刷新请求回调，当接口实现层需要图形服务刷新数据帧时会回调该接口，需要通过RegDisplayRefreshCallback注册该回调接口。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备ID。

+

data

+

输出参数，图形服务携带的私有数据，该参数携带的是RegDisplayRefreshCallback接口注册时传递的地址。

+
+ +## VBlankCallback + +``` +typedef void(* VBlankCallback) (unsigned int sequence, uint64_t ns, void *data) +``` + +**描述：** + +VBlank 事件回调。 + +垂直同步事件回调接口，需要通过RegDisplayVBlankCallback注册该回调接口。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

sequence

+

输入参数，指明VBlank序列，是一个累加值。

+

ns

+

输入参数，该次VBlank事件的时间戳，以纳秒为单位。

+

data

+

输出参数，图形服务携带的私有数据，该参数携带的是RegDisplayVBlankCallback接口注册时传递的地址。

+
+ +## **枚举类型说明** + +## anonymous enum + +``` +anonymous enum +``` + +**描述：** + +缓冲区定义。 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

HBM_USE_CPU_READ

+

CPU 读缓冲

+

+

HBM_USE_CPU_WRITE

+

CPU 写内存

+

+

HBM_USE_MEM_MMZ

+

MMZ

+

+

HBM_USE_MEM_DMA

+

DMA缓冲区

+

+

HBM_USE_MEM_SHARE

+

共享内存缓冲区

+

+

HBM_USE_MEM_MMZ_CACHE

+

MMZ缓存

+

+

HBM_USE_MEM_FB

+

帧缓存

+

+

HBM_USE_ASSIGN_SIZE

+

内存分配

+

+
+ +## BlendType + +``` +enum BlendType +``` + +**描述：** + +显示内存类型定义。 + +根据图形系统指定的类型进行分配，包括带cache或者不带cache的内存。 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

BLEND_NONE

+

No 混合操作

+

+

BLEND_CLEAR

+

CLEAR 混合操作

+

+

BLEND_SRC

+

SRC 混合操作

+

+

BLEND_SRCOVER

+

SRC_OVER 混合操作

+

+

BLEND_DSTOVER

+

DST_OVER 混合操作

+

+

BLEND_SRCIN

+

SRC_IN 混合操作

+

+

BLEND_DSTIN

+

DST_IN 混合操作

+

+

BLEND_SRCOUT

+

SRC_OUT 混合操作

+

+

BLEND_DSTOUT

+

DST_OUT 混合操作

+

+

BLEND_SRCATOP

+

SRC_ATOP 混合操作

+

+

BLEND_DSTATOP

+

DST_ATOP 混合操作

+

+

BLEND_ADD

+

ADD 混合操作

+

+

BLEND_XOR

+

XOR 混合操作

+

+

BLEND_DST

+

DST 混合操作

+

+

BLEND_AKS

+

AKS 混合操作

+

+

BLEND_AKD

+

AKD 混合操作

+

+

BLEND_BUTT

+

空操作

+

+
+ +## ColorDataSpace + +``` +enum ColorDataSpace +``` + +**描述：** + +枚举颜色空间的类型 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

COLOR_DATA_SPACE_UNKNOWN

+

未知的

+

+

GAMUT_BT601

+

BT601色域

+

+

GAMUT_BT709

+

BT709色域

+

+

GAMUT_DCI_P3

+

DCI_P3色域

+

+

GAMUT_SRGB

+

SRGB色域

+

+

GAMUT_ADOBE_RGB

+

ADOBE_RGB色域

+

+

GAMUT_DISPLAY_P3

+

DISPLAY_P3色域

+

+

GAMUT_BT2020

+

BT2020色域

+

+

GAMUT_BT2100_PQ

+

BT2100_PQ色域

+

+

GAMUT_BT2100_HLG

+

BT2100_HLG色域

+

+

GAMUT_DISPLAY_BT2020

+

DISPLAY_BT2020色域

+

+

TRANSFORM_FUNC_UNSPECIFIED

+

UNSPECIFIED转换函数

+

+

TRANSFORM_FUNC_LINEAR

+

LINEAR转换函数

+

+

TRANSFORM_FUNC_SRGB

+

SRGB转换函数

+

+

TRANSFORM_FUNC_SMPTE_170M

+

SMPTE_170M转换函数

+

+

TRANSFORM_FUNC_GM2_2

+

GM2_2转换函数

+

+

TRANSFORM_FUNC_GM2_6

+

GM2_6转换函数

+

+

TRANSFORM_FUNC_GM2_8

+

GM2_8转换函数

+

+

TRANSFORM_FUNC_ST2084

+

ST2084转换函数

+

+

TRANSFORM_FUNC_HLG

+

HLG转换函数

+

+

PRECISION_UNSPECIFIED

+

UNSPECIFIED精度

+

+

PRECISION_FULL

+

FULL精度

+

+

PRESION_LIMITED

+

LIMITED精度

+

+

PRESION_EXTENDED

+

EXTENDED精度

+

+

BT601_SMPTE170M_FULL

+

BT601色域 | SMPTE_170M转换函数 | FULL精度

+

+

BT601_SMPTE170M_LIMITED

+

BT601色域 | SMPTE_170M转换函数 | LIMITED精度

+

+

BT709_LINEAR_FULL

+

BT709色域 | LINEAR转换函数 | FULL精度

+

+

BT709_LINEAR_EXTENDED

+

BT709色域 | LINEAR转换函数 | EXTENDED精度

+

+

BT709_SRGB_FULL

+

BT709色域 | SRGB转换函数 | FULL精度

+

+

BT709_SRGB_EXTENDED

+

BT709色域 | SRGB转换函数 | EXTENDED精度

+

+

BT709_SMPTE170M_LIMITED

+

BT709色域 | SMPTE_170M转换函数 | LIMITED精度

+

+

DCI_P3_LINEAR_FULL

+

DCI_P3色域 | LINEAR转换函数 | FULL精度

+

+

DCI_P3_GAMMA26_FULL

+

DCI_P3色域 | GM2_6转换函数 | FULL精度

+

+

DISPLAY_P3_LINEAR_FULL

+

DISPLAY_P3色域 | LINEAR转换函数 | FULL精度

+

+

DCI_P3_SRGB_FULL

+

DCI_P3色域 | SRGB转换函数 | FULL精度

+

+

ADOBE_RGB_GAMMA22_FULL

+

ADOBE_RGB色域 | GM2_2转换函数 | FULL精度

+

+

BT2020_LINEAR_FULL

+

BT2020色域 | LINEAR转换函数 | FULL精度

+

+

BT2020_SRGB_FULL

+

BT2020色域 | SRGB转换函数 | FULL精度

+

+

BT2020_SMPTE170M_FULL

+

BT2020色域 | SMPTE_170M转换函数 | FULL精度

+

+

BT2020_ST2084_FULL

+

BT2020色域 | ST2084转换函数 | FULL精度

+

+

BT2020_HLG_FULL

+

BT2020色域 | HLG转换函数 | FULL精度

+

+

BT2020_ST2084_LIMITED

+

BT2020色域 | ST2084转换函数 | LIMITED精度

+

+
+ +## ColorGamut + +``` +enum ColorGamut +``` + +**描述：** + +色域类型枚举值。 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

COLOR_GAMUT_INVALID

+

无效值

+

+

COLOR_GAMUT_NATIVE

+

默认值

+

+

COLOR_GAMUT_SATNDARD_BT601

+

Standard BT601类型

+

+

COLOR_GAMUT_STANDARD_BT709

+

Standard BT709类型

+

+

COLOR_GAMUT_DCI_P3

+

DCI P3类型

+

+

COLOR_GAMUT_SRGB

+

SRGB类型

+

+

COLOR_GAMUT_ADOBE_RGB

+

Adobe RGB类型

+

+

COLOR_GAMUT_DISPLAY_P3

+

display P3类型

+

+

COLOR_GAMUT_BT2020

+

BT2020类型

+

+

COLOR_GAMUT_BT2100_PQ

+

BT2100 PQ类型

+

+

COLOR_GAMUT_BT2100_HLG

+

BT2100 HLG类型

+

+

COLOR_GAMUT_DISPLAY_BT2020

+

Display BT2020类型

+

+
+ +## ColorKey + +``` +enum ColorKey +``` + +**描述：** + +Color key操作类型定义，即硬件加速支持的Color key操作类型。 + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

CKEY_NONE

+

不使用colorkey

+

+

CKEY_SRC

+

使用源colorkey

+

+

CKEY_DST

+

使用目标colorkey

+

+

CKEY_BUTT

+

空操作

+

+
+ +## CompositionType + +``` +enum CompositionType +``` + +**描述：** + +枚举特殊层的组合类型。 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

COMPOSITION_CLIENT

+

Client 合成类型，使用CPU或者GPU合成。

+

+

COMPOSITION_DEVICE

+

Device 合成类型，使用Device合成。

+

+

COMPOSITION_CURSOR

+

Cursor合成类型，用于光标合成。

+

+

COMPOSITION_VIDEO

+

Video合成类型，用于视频层合成。

+

+

COMPOSITION_DEVICE_CLEAR

+

Device clear 合成类型，device会清除目标区域。

+

+

COMPOSITION_CLIENT_CLEAR

+

Client clear 合成类型，service会清除目标区域。

+

+

COMPOSITION_TUNNEL

+

Tunnel 合成类型，用于tunnel。

+

+

COMPOSITION_BUTT

+

空类型

+
+ +## Connection + +``` +enum Connection +``` + +**描述：** + +热插拔连接类型定义 + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

CON_INVALID

+

无效类型

+

+

CONNECTED

+

已连接

+

+

DISCONNECTED

+

断开连接

+

+
+ +## DispErrCode + +``` +enum DispErrCode +``` + +**描述：** + +返回值类型定义。 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

DISPLAY_SUCCESS

+

成功

+

+

DISPLAY_FAILURE

+

失败

+

+

DISPLAY_FD_ERR

+

fd错误

+

+

DISPLAY_PARAM_ERR

+

参数错误

+

+

DISPLAY_NULL_PTR

+

空指针

+

+

DISPLAY_NOT_SUPPORT

+

不支持的特性

+

+

DISPLAY_NOMEM

+

内存不足

+

+

DISPLAY_SYS_BUSY

+

系统繁忙

+

+

DISPLAY_NOT_PERM

+

操作不允许

+

+
+ +## DispPowerStatus + +``` +enum DispPowerStatus +``` + +**描述：** + +枚举显示状态 + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

POWER_STATUS_ON

+

上电模式

+

+

POWER_STATUS_STANDBY

+

待机模式

+

+

POWER_STATUS_SUSPEND

+

休眠模式

+

+

POWER_STATUS_OFF

+

下电模式

+

+

POWER_STATUS_BUTT

+

默认模式

+

+
+ +## GamutMap + +``` +enum GamutMap +``` + +**描述：** + +枚举色域的映射类型 + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

GAMUT_MAP_CONSTANT

+

不变

+

+

GAMUT_MAP_EXPANSION

+

映射增强

+

+

GAMUT_MAP_HDR_CONSTANT

+

不变，用于HDR

+

+

GAMUT_MAP_HDR_EXPANSION

+

映射增强，用于HDR

+

+
+ +## HDRFormat + +``` +enum HDRFormat +``` + +**描述：** + +枚举HDR格式 + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

NOT_SUPPORT_HDR

+

不支持HDR

+

+

DOLBY_VISION

+

Dolby Vision格式

+

+

HDR10

+

HDR10格式

+

+

HLG

+

HLG格式

+

+

HDR10_PLUS

+

HDR10 Plus格式

+

+

HDR_VIVID

+

Vivid格式

+

+
+ +## HDRMetadataKey + +``` +enum HDRMetadataKey +``` + +**描述：** + +枚举HDR元数据关键字 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

MATAKEY_RED_PRIMARY_X

+

红基色X坐标

+

+

MATAKEY_RED_PRIMARY_Y

+

红基色Y坐标

+

+

MATAKEY_GREEN_PRIMARY_X

+

绿基色X坐标

+

+

MATAKEY_GREEN_PRIMARY_Y

+

绿基色Y坐标

+

+

MATAKEY_BLUE_PRIMARY_X

+

蓝基色X坐标

+

+

MATAKEY_BLUE_PRIMARY_Y

+

蓝基色Y坐标

+

+

MATAKEY_WHITE_PRIMARY_X

+

白点X坐标

+

+

MATAKEY_WHITE_PRIMARY_Y

+

白点Y坐标

+

+

MATAKEY_MAX_LUMINANCE

+

最大的光亮度

+

+

MATAKEY_MIN_LUMINANCE

+

最小的光亮度

+

+

MATAKEY_MAX_CONTENT_LIGHT_LEVEL

+

最大的内容亮度水平

+

+

MATAKEY_MAX_FRAME_AVERAGE_LIGHT_LEVEL

+

最大的帧平均亮度水平

+

+

MATAKEY_HDR10_PLUS

+

HDR10 Plus

+

+

MATAKEY_HDR_VIVID

+

Vivid

+

+
+ +## InterfaceType + +``` +enum InterfaceType +``` + +**描述：** + +枚举接口类型。 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

DISP_INTF_HDMI

+

HDMI 接口

+

+

DISP_INTF_LCD

+

LCD 接口

+

+

DISP_INTF_BT1120

+

BT1120 接口

+

+

DISP_INTF_BT656

+

BT656 接口

+

+

DISP_INTF_YPBPR

+

YPBPR 接口

+

+

DISP_INTF_RGB

+

RGB 接口

+

+

DISP_INTF_CVBS

+

CVBS 接口

+

+

DISP_INTF_SVIDEO

+

SVIDEO 接口

+

+

DISP_INTF_VGA

+

VGA 接口

+

+

DISP_INTF_MIPI

+

MIPI 接口

+

+

DISP_INTF_PANEL

+

PANEL 接口

+

+

DISP_INTF_BUTT

+

空接口

+
+ +## LayerType + +``` +enum LayerType +``` + +**描述：** + +图层类型定义。 + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

LAYER_TYPE_GRAPHIC

+

图形层

+

+

LAYER_TYPE_OVERLAY

+

视频层

+

+

LAYER_TYPE_SDIEBAND

+

媒体播放

+

+

LAYER_TYPE_CURSOR

+

光标层

+

+

LAYER_TYPE_BUTT

+

空图层

+

+
+ +## MirrorType + +``` +enum MirrorType +``` + +**描述：** + +硬件加速支持的镜像操作类型定义 + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

MIRROR_NONE

+

不使用镜像

+

+

MIRROR_LR

+

左右镜像

+

+

MIRROR_TB

+

上下镜像

+

+

MIRROR_BUTT

+

空操作

+

+
+ +## PixelFormat + +``` +enum PixelFormat +``` + +**描述：** + +像素格式类型定义。 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

PIXEL_FMT_CLUT8

+

CLUT8 格式

+

+

PIXEL_FMT_CLUT1

+

CLUT1 格式

+

+

PIXEL_FMT_CLUT4

+

CLUT4 格式

+

+

PIXEL_FMT_RGB_565

+

RGB565 格式

+

+

PIXEL_FMT_RGBA_5658

+

RGBA5658 格式

+

+

PIXEL_FMT_RGBX_4444

+

RGBX4444 格式

+

+

PIXEL_FMT_RGBA_4444

+

RGBA4444 格式

+

+

PIXEL_FMT_RGB_444

+

RGB444 格式

+

+

PIXEL_FMT_RGBX_5551

+

RGBX5551 格式

+

+

PIXEL_FMT_RGBA_5551

+

RGBA5551 格式

+

+

PIXEL_FMT_RGB_555

+

RGB555 格式

+

+

PIXEL_FMT_RGBX_8888

+

RGBX8888 格式

+

+

PIXEL_FMT_RGBA_8888

+

RGBA8888 格式

+

+

PIXEL_FMT_RGB_888

+

RGB888 格式

+

+

PIXEL_FMT_BGR_565

+

BGR565 格式

+

+

PIXEL_FMT_BGRX_4444

+

BGRX4444 格式

+

+

PIXEL_FMT_BGRA_4444

+

BGRA4444 格式

+

+

PIXEL_FMT_BGRX_5551

+

BGRX5551 格式

+

+

PIXEL_FMT_BGRA_5551

+

BGRA5551 格式

+

+

PIXEL_FMT_BGRX_8888

+

BGRX8888 格式

+

+

PIXEL_FMT_BGRA_8888

+

BGRA8888 格式

+

+

PIXEL_FMT_YUV_422_I

+

YUV422 交错格式

+

+

PIXEL_FMT_YCBCR_422_SP

+

YCBCR422 半平面格式

+

+

PIXEL_FMT_YCRCB_422_SP

+

YCRCB422 半平面格式

+

+

PIXEL_FMT_YCBCR_420_SP

+

YCBCR420 半平面格式

+

+

PIXEL_FMT_YCRCB_420_SP

+

YCRCB420 半平面格式

+

+

PIXEL_FMT_YCBCR_422_P

+

YCBCR422 平面格式

+

+

PIXEL_FMT_YCRCB_422_P

+

YCRCB422 平面格式

+

+

PIXEL_FMT_YCBCR_420_P

+

YCBCR420 平面格式

+

+

PIXEL_FMT_YCRCB_420_P

+

YCRCB420 平面格式

+

+

PIXEL_FMT_YUYV_422_PKG

+

YUYV422 打包格式

+

+

PIXEL_FMT_UYVY_422_PKG

+

UYVY422 打包格式t

+

+

PIXEL_FMT_YVYU_422_PKG

+

YVYU422 打包格式

+

+

PIXEL_FMT_VYUY_422_PKG

+

VYUY422 打包格式

+

+

PIXEL_FMT_VENDER_MASK

+

vendor mask 格式

+

+

PIXEL_FMT_BUTT

+

Invalid 像素格式

+

+
+ +## PresentTimestampType + +``` +enum PresentTimestampType +``` + +**描述：** + +上屏时间戳类型枚举值。 + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

HARDWARE_DISPLAY_PTS_UNSUPPORTED

+

不支持

+

+

HARDWARE_DISPLAY_PTS_DELAY

+

Delay 时延类型

+

+

HARDWARE_DISPLAY_PTS_TIMESTAMP

+

时间戳类型

+

+
+ +## RopType + +``` +enum RopType +``` + +**描述：** + +硬件加速支持的ROP操作类型。 + +硬件加速支持的ROP操作类型，在将前景位图的RGB颜色分量和Alpha分量值与背景位图的RGB颜色 分量值和Alpha分量值进行按位的布尔运算（包括按位与，按位或等），将结果输出。 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

ROP_BLACK

+

黑色

+

+

ROP_NOTMERGEPEN

+

~(S2+S1)

+

+

ROP_MASKNOTPEN

+

~S2&S1

+

+

ROP_NOTCOPYPEN

+

~S2

+

+

ROP_MASKPENNOT

+

S2&~S1

+

+

ROP_NOT

+

~S1

+

+

ROP_XORPEN

+

S2^S1

+

+

ROP_NOTMASKPEN

+

~(S2&S1)

+

+

ROP_MASKPEN

+

S2&S1

+

+

ROP_NOTXORPEN

+

~(S2^S1)

+

+

ROP_NOP

+

S1

+

+

ROP_MERGENOTPEN

+

~S2+S1

+

+

ROP_COPYPE

+

S2

+

+

ROP_MERGEPENNOT

+

S2+~S1

+

+

ROP_MERGEPEN

+

S2+S1

+

+

ROP_WHITE

+

白色

+

+

ROP_BUTT

+

无效值

+

+
+ +## TransformType + +``` +enum TransformType +``` + +**描述：** + +图层变换类型定义。 + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

ROTATE_NONE

+

不旋转

+

+

ROTATE_90

+

旋转90度

+

+

ROTATE_180

+

旋转180度

+

+

ROTATE_270

+

旋转270度

+

+

ROTATE_BUTT

+

无效操作

+

+
+ +## **函数说明** + +## DeviceInitialize\(\) + +``` +int32_t DeviceInitialize (DeviceFuncs ** funcs) +``` + +**描述：** + +实现显示设备控制接口的初始化，申请操作显示设备控制接口的资源，并获取对应的操作接口。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

funcs

+

输出参数，显示设备控制接口指针，初始化时分配内存，调用者不需要分配内存，调用者获取该指针用于操作显示设备。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## DeviceUninitialize\(\) + +``` +int32_t DeviceUninitialize (DeviceFuncs * funcs) +``` + +**描述：** + +取消显示设备控制接口的初始化，释放控制接口使用到的资源。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

funcs

+

输出参数，显示设备控制接口指针，用于释放初始化函数中分配的操作指针内存。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## GfxInitialize\(\) + +``` +int32_t GfxInitialize (GfxFuncs ** funcs) +``` + +**描述：** + +获取硬件加速相关的操作接口指针。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

funcs

+

输出参数，硬件加速模块操作接口指针，调用者不需要分配内存，调用者获取该指针操作硬件加速。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## GfxUninitialize\(\) + +``` +int32_t GfxUninitialize (GfxFuncs * funcs) +``` + +**描述：** + +释放硬件加速相关的操作接口指针。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

funcs

+

输出参数，硬件加速操作接口指针。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## GrallocInitialize\(\) + +``` +int32_t GrallocInitialize (GrallocFuncs ** funcs) +``` + +**描述：** + +初始化内存模块，并获取内存提供的操作接口。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

funcs

+

输出参数，内存模块操作接口指针，初始化内存模块时分配内存，调用者不需要分配内存，调用者获取该指针操作内存。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## GrallocUninitialize\(\) + +``` +int32_t GrallocUninitialize (GrallocFuncs * funcs) +``` + +**描述：** + +取消初始化内存模块，并释放内存操作接口指针。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

funcs

+

输出参数，内存操作接口指针，用于释放内存初始化函数中分配的操作指针内存。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## LayerInitialize\(\) + +``` +int32_t LayerInitialize (LayerFuncs ** funcs) +``` + +**描述：** + +实现图层初始化功能，申请图层使用的资源，并获取图层提供的操作接口。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

funcs

+

输出参数，图层操作接口指针，初始化图层时分配内存，调用者不需要分配内存，调用者获取该指针操作图层。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +**参见：** + +[LayerUninitialize](_display.md#ga4e32b1a65cf243a9ac015b632a4eea0b) + +## LayerUninitialize\(\) + +``` +int32_t LayerUninitialize (LayerFuncs * funcs) +``` + +**描述：** + +取消图层初始化功能，释放图层使用到的资源，并释放图层操作接口指针。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

funcs

+

输出参数，图层操作接口指针，用于释放图层初始化函数中分配的操作指针内存。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +**参见：** + +[LayerInitialize](_display.md#ga061e587306a5d0367ff228d64434c05d) + +**Since：** + +1.0 + +**Version：** + +1.0 + +## **变量说明** + +## alpha0 \[1/2\] + +``` +uint8_t LayerAlpha::alpha0 +``` + +**描述：** + +alpha0值，取值范围：\[0, 255\] + +## alpha0 \[2/2\] + +``` +uint8_t ISurface::alpha0 +``` + +**描述：** + +Alpha0值，取值范围：\[0,255\] + +## alpha1 \[1/2\] + +``` +uint8_t LayerAlpha::alpha1 +``` + +**描述：** + +alpha1值，取值范围：\[0, 255\] + +## alpha1 \[2/2\] + +``` +uint8_t ISurface::alpha1 +``` + +**描述：** + +Alpha1值，取值范围：\[0,255\] + +## alphaRopType + +``` +[RopType](_display.md#ga24265f7618fbdba53d3da4806d3097c4) GfxOpt::alphaRopType +``` + +**描述：** + +Alpha的Rop类型 + +## bAlphaExt1555 + +``` +bool ISurface::bAlphaExt1555 +``` + +**描述：** + +是否使能1555的Alpha扩展 + +## bAlphaMax255 + +``` +bool ISurface::bAlphaMax255 +``` + +**描述：** + +图像alpha最大值为255还是128 + +## baseAddr + +``` +void* __attribute__::baseAddr +``` + +**描述：** + +内存的初始地址 + +## blendType + +``` +[BlendType](_display.md#gaab1839ed4aab1030dfda801a51e68817) GfxOpt::blendType +``` + +**描述：** + +混合方式 + +## bpp + +``` +int32_t LayerInfo::bpp +``` + +**描述：** + +每像素所占bit数 + +## bYCbCrClut + +``` +bool ISurface::bYCbCrClut +``` + +**描述：** + +CLUT表是否位于 YCbCr 空间 + +## cbcrPhyAddr + +``` +uint64_t ISurface::cbcrPhyAddr +``` + +**描述：** + +CbCr分量地址 + +## cbcrStride + +``` +int32_t ISurface::cbcrStride +``` + +**描述：** + +CbCr分量跨度 + +## clutPhyAddr + +``` +uint64_t ISurface::clutPhyAddr +``` + +**描述：** + +Clut表首地址，用作颜色扩展或颜色校正 + +## color \[1/3\] + +``` +uint32_t ILine::color +``` + +**描述：** + +线条颜色 + +## color \[2/3\] + +``` +uint32_t ICircle::color +``` + +**描述：** + +圆的颜色 + +## color \[3/3\] + +``` +uint32_t Rectangle::color +``` + +**描述：** + +矩形颜色 + +## colorKeyFrom + +``` +[ColorKey](_display.md#ga4fe6fb05c7ba0048b1739d88f4d4878e) GfxOpt::colorKeyFrom +``` + +**描述：** + +色键模式 + +## colorRopType + +``` +[RopType](_display.md#ga24265f7618fbdba53d3da4806d3097c4) GfxOpt::colorRopType +``` + +**描述：** + +颜色的Rop类型 + +## Commit + +``` +int32_t(* DeviceFuncs::Commit) (uint32_t devId, int32_t *fence) +``` + +**描述：** + +提交合成送显请求。 + +图形服务通过该接口向接口实现层提交合成送显请求，如果有硬件合成层，接口实现层需要在这时进行合成，并且把最终合成的数据送到硬件进行显示。 + +**参数:** + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

fences

+

输出参数，fence首地址，指向fence数组的首地址。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## CreateVirtualDisplay + +``` +int32_t(* DeviceFuncs::CreateVirtualDisplay) (uint32_t width, uint32_t height, int32_t *format, uint32_t *devId) +``` + +**描述：** + +创建虚拟显示设备。 + +该接口用于创建一个虚拟显示设备。 + +**参数:** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

width

+

输入参数，指定显示设备的像素宽度。

+

height

+

输入参数，指定显示设备的像素高度。

+

format

+

输出参数，指定显示设备的像素格式。 详情参考PixelFormat，接口实现层可以根据硬件需求，修改format并返回给图形服务。

+

devId

+

输出参数，用于接口层返回创建的设备ID。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## CreateWriteBack + +``` +int32_t(* DeviceFuncs::CreateWriteBack) (uint32_t *devId, uint32_t width, uint32_t height, int32_t *format) +``` + +**描述：** + +对指定显示设备创建回写点。 + +该接口用来对指定的设备创建一个回写点，如果回写点数量超过了限制，接口实现层将会返回失败。 + +**参数:** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID，接口实现层在创建完回写点后将回写点设备ID存放在该参数中返回给图形服务。

+

width

+

输入参数，回写像素宽度。

+

height

+

输入参数，回写像素高度。

+

format

+

输入参数，回写点数据格式，详情参考PixelFormat，接口实现层可以根据硬件需求，修改format并返回给图形服务。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## data + +``` +BufferData LayerBuffer::data +``` + +**描述：** + +图层buffer数据 + +## DestroyVirtualDisplay + +``` +int32_t(* DeviceFuncs::DestroyVirtualDisplay) (uint32_t devId) +``` + +**描述：** + +销毁虚拟显示设备。 + +该接口用于销毁指定的虚拟显示设备。 + +**参数:** + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## DestroyWriteBack + +``` +int32_t(* DeviceFuncs::DestroyWriteBack) (uint32_t devId) +``` + +**描述：** + +销毁指定显示设备的回写点。 + +该接口用來销毁指定的回写点。 + +**参数:** + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## enableRop + +``` +bool GfxOpt::enableRop +``` + +**描述：** + +Rop功能使能位 + +## enableScale + +``` +bool GfxOpt::enableScale +``` + +**描述：** + +缩放功能使能位 + +## enColorFmt + +``` +[PixelFormat](_display.md#ga60883d4958a60b91661e97027a85072a) ISurface::enColorFmt +``` + +**描述：** + +图像格式 + +## enGlobalAlpha \[1/2\] + +``` +bool LayerAlpha::enGlobalAlpha +``` + +**描述：** + +全局alpha使能标志 + +## enGlobalAlpha \[2/2\] + +``` +bool GfxOpt::enGlobalAlpha +``` + +**描述：** + +全局alpha使能位 + +## enPixelAlpha \[1/2\] + +``` +bool LayerAlpha::enPixelAlpha +``` + +**描述：** + +像素alpha使能标志 + +## enPixelAlpha \[2/2\] + +``` +bool GfxOpt::enPixelAlpha +``` + +**描述：** + +像素alpha使能位 + +## expectedSize + +``` +uint32_t AllocInfo::expectedSize +``` + +**描述：** + +申请内存大小 + +## fd + +``` +int32_t __attribute__::fd +``` + +**描述：** + +句柄 fd，-1代表不支持。 + +## fenceId + +``` +int32_t LayerBuffer::fenceId +``` + +**描述：** + +buffer 的fence号 + +## format \[1/2\] + +``` +[PixelFormat](_display.md#ga60883d4958a60b91661e97027a85072a) AllocInfo::format +``` + +**描述：** + +申请内存格式 + +## format \[2/2\] + +``` +[PixelFormat](_display.md#ga60883d4958a60b91661e97027a85072a) VerifyAllocInfo::format +``` + +**描述：** + +分配内存的像素格式 + +## formatCount + +``` +uint32_t HDRCapability::formatCount +``` + +**描述：** + +支持的HDR格式的数量 + +## formats + +``` +[HDRFormat](_display.md#gabdc446aa6fa47c5dd8d1b7d87bed2566)* HDRCapability::formats +``` + +**描述：** + +支持的HDR格式的数组首地址 + +## freshRate + +``` +uint32_t DisplayModeInfo::freshRate +``` + +**描述：** + +刷新速率 + +## gAlpha + +``` +uint8_t LayerAlpha::gAlpha +``` + +**描述：** + +全局alpha值，取值范围：\[0, 255\] + +## GetDisplayBacklight + +``` +int32_t(* DeviceFuncs::GetDisplayBacklight) (uint32_t devId, uint32_t *level) +``` + +**描述：** + +获取显示设备当前的背光值。 + +图形服务可以通过该接口获取设置显示设备的背光值。 + +**参数:** + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

level

+

输出参数，保存对应设备的背光值，由接口实现层进行写入。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## GetDisplayCapability + +``` +int32_t(* DeviceFuncs::GetDisplayCapability) (uint32_t devId, DisplayCapability *info) +``` + +**描述：** + +获取显示设备能力集。 + +图形服务可以通过该接口获取显示设备具备哪些显示能力。 + +**参数:** + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

info

+

输出参数，设备支持的能力级信息，详情参考 {@DisplayCapability}。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## GetDisplayColorGamut + +``` +int32_t(* DeviceFuncs::GetDisplayColorGamut) (uint32_t devId, ColorGamut *gamut) +``` + +**描述：** + +获取显示设备当前的色域模式。 + +**参数:** + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

gamut

+

输出参数，保存对应设备的色域模式，由接口实现层进行写入。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## GetDisplayCompChange + +``` +int32_t(* DeviceFuncs::GetDisplayCompChange) (uint32_t devId, uint32_t *num, uint32_t *Layers, int32_t *type) +``` + +**描述：** + +获取显示设备合成类型有变化的layer。 + +在合成准备阶段，显示设备会根据设备的合成能力修改图层的合成类型，该接口会返回哪些图层合成类型发生了变化。 + +**参数:** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

num

+

输出参数，表示合成类型发生了变化的图层数量。

+

Layers

+

输出参数，指向图层数组首地址。

+

type

+

输出参数，指向合成类型数组首地址。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## GetDisplayGamutMap + +``` +int32_t(* DeviceFuncs::GetDisplayGamutMap) (uint32_t devId, GamutMap *gamutMap) +``` + +**描述：** + +获取显示设备当前的色域映射模式。 + +**参数:** + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

gamutMap

+

输出参数，保存对应设备的色域映射模式，由接口实现层进行写入。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## GetDisplayMode + +``` +int32_t(* DeviceFuncs::GetDisplayMode) (uint32_t devId, uint32_t *modeId) +``` + +**描述：** + +获取显示设备当前的显示模式。 + +图形服务可以通过该接口获取显示设备当前的显示模式。 + +**参数:** + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

modeId

+

输出参数，存放当前设备的显示模式ID， 由接口实现层进行数据的写入。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## GetDisplayPowerStatus + +``` +int32_t(* DeviceFuncs::GetDisplayPowerStatus) (uint32_t devId, DispPowerStatus *status) +``` + +**描述：** + +获取显示设备当前的电源状态。 + +图形服务可以通过该接口获设置显示设备的电源状态。 + +**参数:** + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

status

+

输出参数，保存对应设备的电源状态，由接口实现层进行状态的写入。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## GetDisplayProperty + +``` +int32_t(* DeviceFuncs::GetDisplayProperty) (uint32_t devId, uint32_t id, uint64_t *value) +``` + +**描述：** + +设置显示设备属性值。 + +图形服务可以通过该接口获取显示设备具体的属性值。 + +**参数:** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

id

+

输入参数，由接口GetDisplayCapability返回属性ID。

+

level

+

输出参数，属性ID对应的属性值，由接口实现层写入。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## GetDisplayReleaseFence + +``` +int32_t(* DeviceFuncs::GetDisplayReleaseFence) (uint32_t devId, uint32_t *num, uint32_t *layers, int32_t *fences) +``` + +**描述：** + +获取显示图层fence。 + +图形服务在调用接口Commit后，需要通过该接口获取图层的fence信息。 + +**参数:** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

num

+

输出参数，图层个数。

+

layers

+

输出参数，图层首地址，指向图层数组的首地址。

+

fences

+

输出参数，fence首地址，指向fence数组的首地址。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## GetDisplaySupportedColorGamuts + +``` +int32_t(* DeviceFuncs::GetDisplaySupportedColorGamuts) (uint32_t devId, uint32_t *num, ColorGamut *gamuts) +``` + +**描述：** + +获取显示设备支持的色域信息。 + +**参数:** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

num

+

输出参数，设备支持的色域数组个数。

+

gamuts

+

输出参数，色域首地址，指向色域数组首地址。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## GetDisplaySupportedModes + +``` +int32_t(* DeviceFuncs::GetDisplaySupportedModes) (uint32_t devId, uint32_t *num, DisplayModeInfo *modes) +``` + +**描述：** + +获取显示设备支持的显示模式信息。 + +图形服务可以通过该接口获取到显示设备支持哪些显示模式。 + +**参数:** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

num

+

输出参数，设备支持的模式数量。

+

modes

+

输出参数，设备支持的所有模式信息，包括所有能支持的分辨率和刷新率，每一个模式实现层都有一个Id与之对应，在获取当前模式 和设置当前模式时都会使用到，详情参考 {@DisplayModeInfo}。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## GetHDRCapabilityInfos + +``` +int32_t(* DeviceFuncs::GetHDRCapabilityInfos) (uint32_t devId, HDRCapability *info) +``` + +**描述：** + +获取显示设备支持的HDR属性信息。 + +**参数:** + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

info

+

输出参数，保存对应设备的HDR属性信息，由接口实现层进行写入。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## GetSupportedMetadataKey + +``` +int32_t(* DeviceFuncs::GetSupportedMetadataKey) (uint32_t devId, uint32_t *num, HDRMetadataKey *keys) +``` + +**描述：** + +获取显示设备支持的 HDRMetadataKey。 + +**参数:** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

num

+

输出参数，设备支持的HDRMetadataKey数组个数。

+

keys

+

输出参数，HDRMetadataKey首地址，指向HDRMetadataKey数组首地址。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## GetWriteBackFrame + +``` +int32_t(* DeviceFuncs::GetWriteBackFrame) (uint32_t devId, BufferHandle *buffer, int32_t *fence) +``` + +**描述：** + +获取显示设备的回写帧。 + +该接口用来获取devId指定的回写点数据，接口实现层将显示设备回写点的数据写入到设置的缓存中。 + +**参数:** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

buffer

+

输出参数，回写点数据缓存。

+

fence

+

输出参数，同步栅栏，图形服务在调用该接口时，需要将Buffer的release fence 传入，标记该缓存是否可以被写入，接口实现层在接口返回前需要将buffer的acquirce fence 写入回传给图形服务，用来标记回写数据是否已经写入缓存。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## globalAlpha + +``` +uint32_t GfxOpt::globalAlpha +``` + +**描述：** + +全局alpha的值 + +## h + +``` +int32_t IRect::h +``` + +**描述：** + +矩形框高度 + +## hdl + +``` +BufferHandle* LayerBuffer::hdl +``` + +**描述：** + +图层buffer句柄 + +## height \[1/7\] + +``` +uint32_t DisplayInfo::height +``` + +**描述：** + +显示屏高度 + +## height \[2/7\] + +``` +int32_t LayerInfo::height +``` + +**描述：** + +图层高度 + +## height \[3/7\] + +``` +int32_t LayerBuffer::height +``` + +**描述：** + +buffer高度 + +## height \[4/7\] + +``` +int32_t ISurface::height +``` + +**描述：** + +图像高度 + +## height \[5/7\] + +``` +int32_t DisplayModeInfo::height +``` + +**描述：** + +像素高度 + +## height \[6/7\] + +``` +uint32_t AllocInfo::height +``` + +**描述：** + +申请内存高度 + +## height \[7/7\] + +``` +uint32_t VerifyAllocInfo::height +``` + +**描述：** + +分配内存的高度 + +## id + +``` +int32_t DisplayModeInfo::id +``` + +**描述：** + +模式ID + +## InvokeDisplayCmd + +``` +int32_t(* DeviceFuncs::InvokeDisplayCmd) (uint32_t devId,...) +``` + +**描述：** + +调用显示设备命令。 + +该接口用于图形服务和接口实现层之间的接口扩展，如果由临时接口新增可以通过该接口进行扩展，不用增加新的接口定义。 + +**参数:** + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## key + +``` +[HDRMetadataKey](_display.md#ga5d7d90acb5c568e62a02b18446f37789) HDRMetaData::key +``` + +**描述：** + +HDR元数据关键字 + +## maxAverageLum + +``` +float HDRCapability::maxAverageLum +``` + +**描述：** + +最大的平均光亮度luminance值 + +## maxLum + +``` +float HDRCapability::maxLum +``` + +**描述：** + +最大的光亮度luminance值 + +## minLum + +``` +float HDRCapability::minLum +``` + +**描述：** + +最小的光亮度luminance值 + +## mirrorType + +``` +[MirrorType](_display.md#ga08d32376574b541d162d8534adb78fd0) GfxOpt::mirrorType +``` + +**描述：** + +镜像类型 + +## name \[1/2\] + +``` +char PropertyObject::名称[PROPERTY_NAME_LEN] +``` + +**描述：** + +属性名称 + +## name \[2/2\] + +``` +char DisplayCapability::名称[PROPERTY_NAME_LEN] +``` + +**描述：** + +显示设备名称 + +## phyAddr \[1/2\] + +``` +uint64_t BufferData::phyAddr +``` + +**描述：** + +物理内存地址 + +## phyAddr \[2/2\] + +``` +uint64_t ISurface::phyAddr +``` + +**描述：** + +图像首地址 + +## phyHeight + +``` +uint32_t DisplayCapability::phyHeight +``` + +**描述：** + +物理高度 + +## phyWidth + +``` +uint32_t DisplayCapability::phyWidth +``` + +**描述：** + +物理宽度 + +## pitch + +``` +int32_t LayerBuffer::pitch +``` + +**描述：** + +一行数据所占字节数 + +## pixFormat \[1/2\] + +``` +[PixelFormat](_display.md#ga60883d4958a60b91661e97027a85072a) LayerInfo::pixFormat +``` + +**描述：** + +图层像素格式 + +## pixFormat \[2/2\] + +``` +[PixelFormat](_display.md#ga60883d4958a60b91661e97027a85072a) LayerBuffer::pixFormat +``` + +**描述：** + +buffer像素格式 + +## PrepareDisplayLayers + +``` +int32_t(* DeviceFuncs::PrepareDisplayLayers) (uint32_t devId, bool *needFlushFb) +``` + +**描述：** + +显示设备合成前准备。 + +图形服务在合成前需要通过该接口通知显示设备进行合成前的准备工作。 + +**参数:** + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

needFlushFb

+

输出参数，接口实现层通过该参数指示图形服务在commit前是否需要通过SetDisplayClientBuffer重新设置显示帧存。 true表示需要设置显示帧存，false表示不需要。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## propertyCount + +``` +uint32_t DisplayCapability::propertyCount +``` + +**描述：** + +属性数组大小 + +## propId + +``` +uint32_t PropertyObject::propId +``` + +**描述：** + +属性ID + +## props + +``` +[PropertyObject](_property_object.md)* DisplayCapability::props +``` + +**描述：** + +属性数组 + +## r + +``` +int32_t ICircle::r +``` + +**描述：** + +圆的半径 + +## rect + +``` +[IRect](_i_rect.md) Rectangle::rect +``` + +**描述：** + +矩形区域 + +## RegDisplayRefreshCallback + +``` +int32_t(* DeviceFuncs::RegDisplayRefreshCallback) (uint32_t devId, RefreshCallback callback, void *data) +``` + +**描述：** + +刷新请求回调。 + +注册刷新请求事件回调，当实现层有刷新需求时，实现层通过回调注册的接口通知图形服务。 + +**参数:** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

callback

+

输入参数，刷新请求事件回调实例，当有接口实现层有刷新请求时，需要通过该实例通知图形服务。

+

data

+

输出参数，图形服务携带的私有数据，在事件回调接口中需要返回给图形服务。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](#ga12a925dadef7573cd74d63d06824f9b0)。 + +## RegDisplayVBlankCallback + +``` +int32_t(* DeviceFuncs::RegDisplayVBlankCallback) (uint32_t devId, VBlankCallback callback, void *data) +``` + +**描述：** + +注册VBlank事件回调。 + +注册VBlank事件回调，当有VBlank事件发生时接口实现层需要回调注册的接口。 + +**参数:** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

callback

+

输入参数，VBlank事件回调实例，当有VBlank事件发生时并且DisplayVsync处于Enable状态，接口实现层需要通过该实例通知图形服务。

+

data

+

输出参数，图形服务携带的私有数据，在事件回调接口中需要返回给图形服务。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](#ga12a925dadef7573cd74d63d06824f9b0)。 + +## RegHotPlugCallback + +``` +int32_t(* DeviceFuncs::RegHotPlugCallback) ((HotPlugCallback callback, void *data) +``` + +**描述：** + +注册热插拔事件回调。 + +注册热插拔事件回调，当有热插拔事件发生时接口实现层需要回调注册的接口。 + +**参数:** + + + + + + + + + + + + + +

名称

+

描述

+

callback

+

输入参数，热插拔事件回调实例，当有热插拔事件发生时，接口实现层需要通过该实例通知图形服务。

+

data

+

输出参数，图形服务携带的私有数据，在事件回调接口中需要返回给图形服务。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](#ga12a925dadef7573cd74d63d06824f9b0)。 + +## reserve + +``` +int32_t __attribute__::reserve[0] +``` + +**描述：** + +reserve数组 + +## reserveInts + +``` +uint32_t __attribute__::reserveInts +``` + +**描述：** + +reserve数组的个数 + +## rotAngle + +``` +int32_t DisplayInfo::rotAngle +``` + +**描述：** + +显示屏旋转角度 + +## rotateType + +``` +[TransformType](_display.md#gaa65f3b21a9a92ff022e435a7304126d2) GfxOpt::rotateType +``` + +**描述：** + +旋转类型 + +## SetDisplayBacklight + +``` +int32_t(* DeviceFuncs::SetDisplayBacklight) (uint32_t devId, uint32_t level) +``` + +**描述：** + +设置显示设备当前的背光值。 + +图形服务可以通过该接口获设置显示设备的背光值。 + +**参数:** + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

level

+

输入参数，表示需要设置的背光值。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## SetDisplayClientBuffer + +``` +int32_t(* DeviceFuncs::SetDisplayClientBuffer) (uint32_t devId, const BufferHandle *buffer, int32_t fence) +``` + +**描述：** + +设置显示设备的显示缓存。 + +图形服务可以通过该接口将显示缓存设置给显示设备，显示设备硬件合成结果将会存放在该显示缓存中。 + +**参数:** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

buffer

+

输入参数，显示缓存。

+

fence

+

输入参数，同步栅栏，标识显示缓存是否可以访问，有图形服务创建和释放，接口实现层需要等待同步栅栏发送信号后才能使用显示缓存。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## SetDisplayClientCrop + +``` +int32_t(* DeviceFuncs::SetDisplayClientCrop) (uint32_t devId, IRect *rect) +``` + +**描述：** + +设置显示设备的裁剪区域。 + +图形服务可以通过该接口设置显示设备的ClientBuffer的裁剪区域，裁剪区域不能超过ClientBuffer的大小。 + +**参数:** + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

rect

+

输入参数，ClientBuffer的裁剪区域。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## SetDisplayClientDamage + +``` +int32_t(* DeviceFuncs::SetDisplayClientDamage) (uint32_t devId, uint32_t num, IRect *rect) +``` + +**描述：** + +设置显示设备的显示脏区。 + +图形服务可以通过该接口设置显示设备脏区，接口实现层可以根据该区域进行区域刷新，脏区是由多个矩形区域组合起来的。 + +**参数:** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

num

+

输入参数，矩形个数。

+

rect

+

输入参数，区域矩形指针，指向矩形数组的首地址。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## SetDisplayClientDestRect + +``` +int32_t(* DeviceFuncs::SetDisplayClientDestRect) (uint32_t devId, IRect *rect) +``` + +**描述：** + +设置显示设备的显示区域。 + +图形服务可以通过该接口设置显示设备的显示区域。 + +**参数:** + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

rect

+

输入参数，显示区域。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## SetDisplayColorGamut + +``` +int32_t(* DeviceFuncs::SetDisplayColorGamut) (uint32_t devId, ColorGamut gamut) +``` + +**描述：** + +设置显示设备当前的色域模式。 + +**参数:** + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

gamut

+

输入参数，表示需要设置的色域模式。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## SetDisplayColorTransform + +``` +int32_t(* DeviceFuncs::SetDisplayColorTransform) (uint32_t devId, const float *matrix) +``` + +**描述：** + +设置显示设备当前的4x4的颜色转换矩阵。 + +**参数:** + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

matrix

+

输入参数，表示需要设置的颜色转换模式。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## SetDisplayGamutMap + +``` +int32_t(* DeviceFuncs::SetDisplayGamutMap) (uint32_t devId, GamutMap gamutMap) +``` + +**描述：** + +设置显示设备当前的色域映射模式。 + +**参数:** + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

gamutMap

+

输入参数，表示需要设置的色域映射模式。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## SetDisplayMode + +``` +int32_t(* DeviceFuncs::SetDisplayMode) (uint32_t devId, uint32_t modeId) +``` + +**描述：** + +设置显示设备的显示模式。 + +图形服务可以通过该接口获设置显示设备的显示模式。 + +**参数:** + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

modeId

+

输入参数，指明需要设置的模式ID，接口实现层将设备切换到该参数对应的显示模式。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## SetDisplayPowerStatus + +``` +int32_t(* DeviceFuncs::SetDisplayPowerStatus) (uint32_t devId, [DispPowerStatus](#ga0f3c8af6e9d40730b0d2e0fbbf8e627d) status) +``` + +**描述：** + +设置显示设备当前的电源状态。 + +图形服务可以通过该接口获设置显示设备的电源状态。 + +**参数:** + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

status

+

输入参数，表示需要设置的电源状态。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## SetDisplayProperty + +``` +int32_t(* DeviceFuncs::SetDisplayProperty) (uint32_t devId, uint32_t id, uint64_t value) +``` + +**描述：** + +设置显示设备属性值。 + +图形服务可以通过该接口设置显示设备具体的属性值。 + +**参数:** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

id

+

输入参数，由接口GetDisplayCapability返回属性ID。

+

value

+

输入参数，需要设置的属性值。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## SetDisplayVsyncEnabled + +``` +int32_t(* DeviceFuncs::SetDisplayVsyncEnabled) (uint32_t devId, bool enabled) +``` + +**描述：** + +使能垂直同步信号。 + +图形服务可以通过该接口使能或取消垂直同步信号，当有垂直同步信号产生时，接口实现层需要回调图形服务通过RegDisplayVBlankCallback注册的 VBlankCallback 回调。 图形服务在需要刷新显示时需要使能垂直同步信号，在收到VBlankCallback事件回调时再进行合成送显，不需要刷新显示时需要取消垂直同步信号。 + +**参数:** + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

enabled

+

输入参数，使能状态，true表示能，false表示不能。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## SetVirtualDisplayBuffer + +``` +int32_t(* DeviceFuncs::SetVirtualDisplayBuffer) (uint32_t devId, BufferHandle *buffer, int32_t fence) +``` + +**描述：** + +设置虚拟屏的输出缓存。 + +该接口用于设置虚拟屏输出缓存，接口实现层需要将虚拟屏的输出放入到该缓存中，接口实现层需要等待同步栅栏发送信号后才能使用缓存。 + +**参数:** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

buffer

+

输出参数，输出缓存。

+

fence

+

输出参数，同步栅栏。

+
+ +**返回:** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## stride + +``` +int32_t ISurface::stride +``` + +**描述：** + +图像跨度 + +## supportLayers + +``` +uint32_t DisplayCapability::supportLayers +``` + +**描述：** + +支持的图层数 + +## supportWriteBack + +``` +bool DisplayCapability::supportWriteBack +``` + +**描述：** + +是否支持回写 + +## time + +``` +int64_t PresentTimestamp::time +``` + +**描述：** + +类型对应的值 + +## type \[1/3\] + +``` +[LayerType](_display.md#ga56943a0946e5f15e5e58054b8e7a04a4) LayerInfo::type +``` + +**描述：** + +图层类型，包括图形层、视频层和媒体播放模式 + +## type \[2/3\] + +``` +[InterfaceType](_display.md#gaf1ef2c97e255bd7f21d3b7614b283d9d) DisplayCapability::type +``` + +**描述：** + +显示屏接口类型 + +## type \[3/3\] + +``` +[PresentTimestampType](_display.md#gabdba71665ea5ba4004ac1a9fbeb505f3) PresentTimestamp::type +``` + +**描述：** + +上屏时间戳类型 + +## uOffset + +``` +size_t __attribute__::uOffset +``` + +**描述：** + +U的偏移量 + +## usage \[1/2\] + +``` +uint64_t AllocInfo::usage +``` + +**描述：** + +申请内存的使用场景 + +## usage \[2/2\] + +``` +uint64_t VerifyAllocInfo::usage +``` + +**描述：** + +内存的用处 + +## uvStep + +``` +size_t __attribute__::uvStep +``` + +**描述：** + +UV的step信息 + +## uvStride + +``` +size_t __attribute__::uvStride +``` + +**描述：** + +UV的stride信息 + +## value \[1/2\] + +``` +uint64_t PropertyObject::value +``` + +**描述：** + +属性值 + +## value \[2/2\] + +``` +float HDRMetaData::value +``` + +**描述：** + +关键字对应的值 + +## virAddr + +``` +void* BufferData::virAddr +``` + +**描述：** + +虚拟内存地址 + +## virtualDispCount + +``` +uint32_t DisplayCapability::virtualDispCount +``` + +**描述：** + +支持的虚拟屏数 + +## vOffset + +``` +size_t __attribute__::vOffset +``` + +**描述：** + +V的偏移量 + +## w + +``` +int32_t IRect::w +``` + +**描述：** + +矩形框宽度 + +## width \[1/7\] + +``` +uint32_t DisplayInfo::width +``` + +**描述：** + +显示屏宽度 + +## width \[2/7\] + +``` +int32_t LayerInfo::width +``` + +**描述：** + +图层宽度 + +## width \[3/7\] + +``` +int32_t LayerBuffer::width +``` + +**描述：** + +buffer宽度 + +## width \[4/7\] + +``` +int32_t ISurface::width +``` + +**描述：** + +图像宽度 + +## width \[5/7\] + +``` +int32_t DisplayModeInfo::width +``` + +**描述：** + +像素宽度 + +## width \[6/7\] + +``` +uint32_t AllocInfo::width +``` + +**描述：** + +申请内存宽度 + +## width \[7/7\] + +``` +uint32_t VerifyAllocInfo::width +``` + +**描述：** + +分配内存的宽度 + +## x \[1/2\] + +``` +int32_t IRect::x +``` + +**描述：** + +矩形框起始x坐标 + +## x \[2/2\] + +``` +int32_t ICircle::x +``` + +**描述：** + +圆心x坐标 + +## x0 + +``` +int32_t ILine::x0 +``` + +**描述：** + +线条起点的x坐标 + +## x1 + +``` +int32_t ILine::x1 +``` + +**描述：** + +线条终点的x坐标 + +## y \[1/2\] + +``` +int32_t IRect::y +``` + +**描述：** + +矩形框起始y坐标 + +## y \[2/2\] + +``` +int32_t ICircle::y +``` + +**描述：** + +圆心y坐标r + +## y0 + +``` +int32_t ILine::y0 +``` + +**描述：** + +线条起点的y坐标 + +## y1 + +``` +int32_t ILine::y1 +``` + +**描述：** + +线条终点的y坐标 + +## yOffset + +``` +size_t __attribute__::yOffset +``` + +**描述：** + +Y的偏移量 + +## yStride + +``` +size_t __attribute__::yStride +``` + +**描述：** + +Y的stride信息 + diff --git a/zh-cn/device-dev/api/toctopics/_display_capability.md b/zh-cn/device-dev/api/toctopics/_display_capability.md new file mode 100644 index 0000000000..e07618df07 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_display_capability.md @@ -0,0 +1,71 @@ +# DisplayCapability + +## **概述** + +**所属模块:** + +[Display](_display.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

name [PROPERTY_NAME_LEN]

+

显示设备名称

+

type

+

显示屏接口类型

+

phyWidth

+

物理宽度

+

phyHeight

+

物理高度

+

supportLayers

+

支持的图层数

+

virtualDispCount

+

支持的虚拟屏数

+

supportWriteBack

+

是否支持回写

+

propertyCount

+

属性数组大小

+

props

+

属性数组

+
+ +## **详细描述** + +定义输出性能。 + diff --git a/zh-cn/device-dev/api/toctopics/_display_info.md b/zh-cn/device-dev/api/toctopics/_display_info.md new file mode 100644 index 0000000000..69c51fae4a --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_display_info.md @@ -0,0 +1,41 @@ +# DisplayInfo + +## **概述** + +**所属模块:** + +[Display](_display.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

width

+

显示屏宽度

+

height

+

显示屏高度

+

rotAngle

+

显示屏旋转角度

+
+ +## **详细描述** + +定义显示信息结构体。 + diff --git a/zh-cn/device-dev/api/toctopics/_display_mode_info.md b/zh-cn/device-dev/api/toctopics/_display_mode_info.md new file mode 100644 index 0000000000..500a986dc0 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_display_mode_info.md @@ -0,0 +1,46 @@ +# DisplayModeInfo + +## **概述** + +**所属模块:** + +[Display](_display.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

width

+

像素宽度

+

height

+

像素高度

+

freshRate

+

刷新速率

+

id

+

模式ID

+
+ +## **详细描述** + +定义输出模式信息。 + diff --git a/zh-cn/device-dev/api/toctopics/_enroll_param.md b/zh-cn/device-dev/api/toctopics/_enroll_param.md new file mode 100644 index 0000000000..72ab14a5fa --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_enroll_param.md @@ -0,0 +1,81 @@ +# EnrollParam + +## **概述** + +**所属模块:** + +[HdfUserAuth](_hdf_user_auth.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

authType

+

用户认证凭据类型。

+

executorType

+

执行器类型。

+

executorId

+

既定用户认证凭据类型的执行器ID。

+
+ +## **详细描述** + +注册认证凭据参数。 + +**Since：** + +3.2 + +**Version：** + +1.0 + +## **类成员变量说明** + +## authType + +``` +enum AuthType EnrollParam::authType +``` + +**描述：** + +用户认证凭据类型。 + +## executorId + +``` +unsigned int EnrollParam::executorId +``` + +**描述：** + +既定用户认证凭据类型的执行器ID。 + +## executorType + +``` +unsigned int EnrollParam::executorType +``` + +**描述：** + +执行器类型。 + diff --git a/zh-cn/device-dev/api/toctopics/_enrolled_info.md b/zh-cn/device-dev/api/toctopics/_enrolled_info.md new file mode 100644 index 0000000000..3815419a39 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_enrolled_info.md @@ -0,0 +1,66 @@ +# EnrolledInfo + +## **概述** + +**所属模块:** + +[HdfUserAuth](_hdf_user_auth.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + +

Public 属性

+

描述

+

enrolledId

+

注册ID，用户注册新的认证凭据时会更新注册ID。

+

authType

+

用户认证凭据类型。

+
+ +## **详细描述** + +注册信息。 + +**Since：** + +3.2 + +**Version：** + +1.0 + +## **类成员变量说明** + +## authType + +``` +enum AuthType EnrolledInfo::authType +``` + +**描述：** + +用户认证凭据类型AuthType\}。 + +## enrolledId + +``` +unsigned long EnrolledInfo::enrolledId +``` + +**描述：** + +注册ID，用户注册新的认证凭据时会更新注册ID。 + diff --git a/zh-cn/device-dev/api/toctopics/_event_info.md b/zh-cn/device-dev/api/toctopics/_event_info.md new file mode 100644 index 0000000000..5e1e5449c7 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_event_info.md @@ -0,0 +1,118 @@ +# EventInfo + +## **概述** + +**所属模块:** + +[Codec](_codec.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

appData

+

设置回调时给入的上层实例。

+

appDataLen

+

appData字节数。

+

data1

+

事件上报携带的数据1。

+

data2

+

事件上报携带的数据2。

+

eventData

+

事件上报携带的数据信息。

+

eventDataLen

+

eventData字节数。

+
+ +## **详细描述** + +定义事件上报信息。 + +## **类成员变量说明** + +## appData + +``` +int8_t* EventInfo::appData +``` + +**描述：** + +设置回调时给入的上层实例 + +## appDataLen + +``` +uint32_t EventInfo::appDataLen +``` + +**描述：** + +appData字节数 + +## data1 + +``` +uint32_t EventInfo::data1 +``` + +**描述：** + +事件上报携带的数据1 + +## data2 + +``` +uint32_t EventInfo::data2 +``` + +**描述：** + +事件上报携带的数据2 + +## eventData + +``` +int8_t* EventInfo::eventData +``` + +**描述：** + +事件上报携带的数据信息 + +## eventDataLen + +``` +uint32_t EventInfo::eventDataLen +``` + +**描述：** + +eventData字节数 + diff --git a/zh-cn/device-dev/api/toctopics/_event_package.md b/zh-cn/device-dev/api/toctopics/_event_package.md new file mode 100644 index 0000000000..cdf3b78cc3 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_event_package.md @@ -0,0 +1,88 @@ +# EventPackage + +## **概述** + +**所属模块:** + +[Input](_input.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

type

+

输入事件的属性

+

code

+

输入事件的特定编码项

+

value

+

输入事件编码项对应的值

+

timestamp

+

输入事件对应的时间戳

+
+ +## **详细描述** + +input事件数据包结构。 + +## **类成员变量说明** + +## code + +``` +uint32_t EventPackage::code +``` + +**描述：** + +输入事件的特定编码项 + +## timestamp + +``` +uint64_t EventPackage::timestamp +``` + +**描述：** + +输入事件对应的时间戳 + +## type + +``` +uint32_t EventPackage::type +``` + +**描述：** + +输入事件的属性 + +## value + +``` +int32_t EventPackage::value +``` + +**描述：** + +输入事件编码项对应的值 + diff --git a/zh-cn/device-dev/api/toctopics/_executor_info.md b/zh-cn/device-dev/api/toctopics/_executor_info.md new file mode 100644 index 0000000000..8f9f9be002 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_executor_info.md @@ -0,0 +1,173 @@ +# ExecutorInfo + +## **概述** + +**所属模块:** + +[HdfFaceAuth](_hdf_face_auth.md) | [HdfPinAuth](_hdf_pin_auth.md) | [HdfUserAuth](_hdf_user_auth.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

sensorId

+

传感器ID，不同传感器在人脸/口令认证驱动内的唯一标识。

+

executorType

+

执行器类型，根据执行器支持的能力/算法类型进行分类。

+

index

+

用户认证框架的执行器索引。

+

executorRole

+

执行器角色ExecutorRole。

+

authType

+

用户认证凭据类型。

+

esl

+

执行器安全等级。

+

publicKey

+

执行器公钥，用于校验该执行器私钥签名的信息。

+

extraInfo

+

其他相关信息，用于支持信息扩展。

+

info

+

执行器注册信息ExecutorRegisterInfo。

+
+ +## **详细描述** + +执行器信息。 + +**Since：** + +3.2 + +**Version：** + +1.0 + +## **类成员变量说明** + +## authType + +``` +enum AuthType ExecutorInfo::authType +``` + +**描述：** + +用户认证凭据类型。 + +## esl + +``` +enum ExecutorSecureLevel ExecutorInfo::esl +``` + +**描述：** + +执行器安全等级ExecutorSecureLevel。 + +## executorRole + +``` +enum ExecutorRole ExecutorInfo::executorRole +``` + +**描述：** + +执行器角色ExecutorRole。 + +## executorType + +``` +unsigned int ExecutorInfo::executorType +``` + +**描述：** + +执行器类型，根据执行器支持的能力/算法类型进行分类。 + +## extraInfo + +``` +unsigned char [] ExecutorInfo::extraInfo +``` + +**描述：** + +其他相关信息，用于支持信息扩展。 + +## index + +``` +unsigned long ExecutorInfo::index +``` + +**描述：** + +用户认证框架的执行器索引。 + +## info + +``` +struct ExecutorRegisterInfo ExecutorInfo::info +``` + +**描述：** + +执行器注册信息ExecutorRegisterInfo。 + +## publicKey + +``` +unsigned char [] ExecutorInfo::publicKey +``` + +**描述：** + +执行器公钥，用于校验该执行器私钥签名的信息。 + +## sensorId + +``` +unsigned short ExecutorInfo::sensorId +``` + +**描述：** + +传感器ID，不同传感器在人脸认证驱动内的唯一标识。 + +传感器ID，不同传感器在口令认证驱动内的唯一标识。 + diff --git a/zh-cn/device-dev/api/toctopics/_executor_register_info.md b/zh-cn/device-dev/api/toctopics/_executor_register_info.md new file mode 100644 index 0000000000..358d3d459e --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_executor_register_info.md @@ -0,0 +1,126 @@ +# ExecutorRegisterInfo + +## **概述** + +**所属模块:** + +[HdfUserAuth](_hdf_user_auth.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

authType

+

用户认证凭据类型。

+

executorRole

+

执行器角色ExecutorRole。

+

executorId

+

既定用户认证凭据类型的执行器ID。

+

executorType

+

执行器类型，根据执行器支持的认证能力进行分类。

+

esl

+

执行器安全等级ExecutorSecureLevel。

+

publicKey

+

执行器公钥，用于校验该执行器私钥签名的信息。

+
+ +## **详细描述** + +执行器注册信息。 + +**Since：** + +3.2 + +**Version：** + +1.0 + +## **类成员变量说明** + +## authType + +``` +enum AuthType ExecutorRegisterInfo::authType +``` + +**描述：** + +用户认证凭据类型。 + +## esl + +``` +enum ExecutorSecureLevel ExecutorRegisterInfo::esl +``` + +**描述：** + +执行器安全等级ExecutorSecureLevel。 + +## executorId + +``` +unsigned int ExecutorRegisterInfo::executorId +``` + +**描述：** + +既定用户认证凭据类型的执行器ID。 + +## executorRole + +``` +enum ExecutorRole ExecutorRegisterInfo::executorRole +``` + +**描述：** + +执行器角色ExecutorRole。 + +## executorType + +``` +unsigned int ExecutorRegisterInfo::executorType +``` + +**描述：** + +执行器类型，根据执行器支持的认证能力进行分类。 + +## publicKey + +``` +unsigned char [] ExecutorRegisterInfo::publicKey +``` + +**描述：** + +执行器公钥，用于校验该执行器私钥签名的信息。 + diff --git a/zh-cn/device-dev/api/toctopics/_executor_send_msg.md b/zh-cn/device-dev/api/toctopics/_executor_send_msg.md new file mode 100644 index 0000000000..17e4bd6717 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_executor_send_msg.md @@ -0,0 +1,64 @@ +# ExecutorSendMsg + +## **概述** + +**所属模块:** + +[HdfUserAuth](_hdf_user_auth.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + +

Public 属性

+

描述

+

index

+

用户认证框架的执行器索引。

+

msg

+

执行器发送的消息。

+
+ +## **详细描述** + +执行器发送的消息。 + +**Since：** + +3.2 + +**Version：** + +## **类成员变量说明** + +## index + +``` +unsigned int ExecutorSendMsg::index +``` + +**描述：** + +用户认证框架的执行器索引。 + +## msg + +``` +unsigned char [] ExecutorSendMsg::msg +``` + +**描述：** + +执行器发送的消息。 + diff --git a/zh-cn/device-dev/api/toctopics/_face_auth_types_8idl.md b/zh-cn/device-dev/api/toctopics/_face_auth_types_8idl.md new file mode 100644 index 0000000000..0c634b046f --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_face_auth_types_8idl.md @@ -0,0 +1,94 @@ +# FaceAuthTypes.idl + +## **概述** + +**所属模块:** + +[HdfFaceAuth](_hdf_face_auth.md) + +## **汇总** + +## 类 + + + + + + + + + + + + + +

类

+

描述

+

ExecutorInfo

+

执行器信息。 更多...

+

TemplateInfo

+

凭据模版信息。 更多...

+
+ +## 枚举 + + + + + + + + + + + + + + + + + + + + + + +

枚举

+

描述

+

AuthType : int { PIN = 1, FACE = 2, FINGERPRINT = 4, PIN = 1, FACE = 2, FINGERPRINT = 4, ALL = 0, PIN = 1, FACE = 2, FINGERPRINT = 4 }

+

枚举用户认证凭据类型。 更多...

+

ExecutorRole : int { COLLECTOR = 1, VERIFIER = 2, ALL_IN_ONE = 3, COLLECTOR = 1, VERIFIER = 2, ALL_IN_ONE = 3, COLLECTOR = 1, VERIFIER = 2, ALL_IN_ONE = 3 }

+

枚举执行器角色。 更多...

+

ExecutorSecureLevel : int { ESL0 = 0, ESL1 = 1, ESL2 = 2, ESL3 = 3, ESL0 = 0, ESL1 = 1, ESL2 = 2, ESL3 = 3, ESL0 = 0, ESL1 = 1, ESL2 = 2, ESL3 = 3 }

+

枚举执行器安全等级。 更多...

+

CommandId : int { LOCK_TEMPLATE = 1, UNLOCK_TEMPLATE = 2, VENDOR_COMMAND_BEGIN = 10000, DEFAULT = 0 }

+

枚举人脸认证功能相关操作命令。 更多...

+

FaceTipsCode : int { FACE_AUTH_TIP_TOO_BRIGHT = 1, FACE_AUTH_TIP_TOO_DARK = 2, FACE_AUTH_TIP_TOO_CLOSE = 3, FACE_AUTH_TIP_TOO_FAR = 4, FACE_AUTH_TIP_TOO_HIGH = 5, FACE_AUTH_TIP_TOO_LOW = 6, FACE_AUTH_TIP_TOO_RIGHT = 7, FACE_AUTH_TIP_TOO_LEFT = 8, FACE_AUTH_TIP_TOO_MUCH_MOTION = 9, FACE_AUTH_TIP_POOR_GAZE = 10, FACE_AUTH_TIP_NOT_DETECTED = 11, VENDOR_FACE_AUTH_TIP_BEGIN = 10000 }

+

枚举提示信息编码。 更多...

+
+ +## 变量 + + + + + + + + + + +

变量 名称

+

描述

+

package ohos.hdi.face_auth.v1_0

+

人脸认证接口的包路径

+
+ +## **详细描述** + +定义人脸认证驱动的枚举类和数据结构。 + +**Since：** + +3.2 + diff --git a/zh-cn/device-dev/api/toctopics/_get_buffer_handle_usage_params.md b/zh-cn/device-dev/api/toctopics/_get_buffer_handle_usage_params.md new file mode 100644 index 0000000000..b2b32291ca --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_get_buffer_handle_usage_params.md @@ -0,0 +1,88 @@ +# GetBufferHandleUsageParams + +## **概述** + +**所属模块:** + +[Codec](_codec.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

size

+

结构体大小

+

version

+

组件版本信息

+

portIndex

+

端口索引

+

usage

+

使用率

+
+ +## **详细描述** + +BufferHandleUsage类型定义。 + +## **类成员变量说明** + +## portIndex + +``` +uint32_t GetBufferHandleUsageParams::portIndex +``` + +**描述：** + +端口索引 + +## size + +``` +uint32_t GetBufferHandleUsageParams::size +``` + +**描述：** + +结构体大小 + +## usage + +``` +uint32_t GetBufferHandleUsageParams::usage +``` + +**描述：** + +usage + +## version + +``` +union OMX_VERSIONTYPE GetBufferHandleUsageParams::version +``` + +**描述：** + +组件版本信息 + diff --git a/zh-cn/device-dev/api/toctopics/_gfx_funcs.md b/zh-cn/device-dev/api/toctopics/_gfx_funcs.md new file mode 100644 index 0000000000..d3c06af0aa --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_gfx_funcs.md @@ -0,0 +1,380 @@ +# GfxFuncs + +## **概述** + +**所属模块:** + +[Display](_display.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

( InitGfx )(void)

+

初始化硬件加速。 更多...

+

( DeinitGfx )(void)

+

去初始化硬件加速。 更多...

+

( FillRect )(ISurface *surface, IRect *rect, uint32_t color, GfxOpt *opt)

+

填充矩形，用一种颜色填充画布上指定矩形区域的矩形框。 更多...

+

( DrawRectangle )(ISurface *surface, Rectangle *rect, uint32_t color, GfxOpt *opt)

+

绘制矩形框，用一种颜色在画布上绘制指定区域的矩形框。 更多...

+

( DrawLine )(ISurface *surface, ILine *line, GfxOpt *opt)

+

绘制直线，使用一种颜色在画布上绘制一条直线。 更多...

+

( DrawCircle )(ISurface *surface, ICircle *circle, GfxOpt *opt)

+

绘制圆形，使用一种颜色在画布上绘制指定圆心和半径的圆。 更多...

+

( Blit )(ISurface *srcSurface, IRect *srcRect, ISurface *dstSurface, IRect *dstRect, GfxOpt *opt)

+

位图搬移 更多...

+

( Sync )(int32_t timeOut)

+

硬件加速同步。 更多...

+
+ +## **详细描述** + +显示硬件加速驱动接口结构体，定义硬件加速驱动接口函数指针。 + +## **类成员变量说明** + +## Blit + +``` +int32_t(* GfxFuncs::Blit) (ISurface *srcSurface, IRect *srcRect, ISurface *dstSurface, IRect *dstRect, GfxOpt *opt) +``` + +**描述：** + +位图搬移 + +在位图搬移过程中，可以实现色彩空间转换、缩放、旋转等功能。 + +**参数：** + + + + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

srcSurface

+

输入参数，源位图信息。

+

srcRect

+

输入参数，源位图搬移区域。

+

dstSurface

+

输出参数，目标位图信息。

+

dstRect

+

输出参数，目标位图区域。

+

opt

+

输入参数，硬件加速选项。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## DeinitGfx + +``` +int32_t(* GfxFuncs::DeinitGfx) (void) +``` + +**描述：** + +去初始化硬件加速。 + +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +**参见：** + +[InitGfx](_gfx_funcs.md#a3ec8ed6a467ed0c88e4dd723723c0f41) + +## DrawCircle + +``` +int32_t(* GfxFuncs::DrawCircle) (ISurface *surface, ICircle *circle, GfxOpt *opt) +``` + +**描述：** + +绘制圆形，使用一种颜色在画布上绘制指定圆心和半径的圆。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

surface

+

输入参数，画布。

+

circle

+

输入参数，圆形结构。

+

opt

+

输入参数，硬件加速选项。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## DrawLine + +``` +int32_t(* GfxFuncs::DrawLine) (ISurface *surface, ILine *line, GfxOpt *opt) +``` + +**描述：** + +绘制直线，使用一种颜色在画布上绘制一条直线。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

surface

+

输入参数，画布。

+

line

+

输入参数，直线结构。

+

opt

+

输入参数，硬件加速选项。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## DrawRectangle + +``` +int32_t(* GfxFuncs::DrawRectangle) (ISurface *surface, Rectangle *rect, uint32_t color, GfxOpt *opt) +``` + +**描述：** + +绘制矩形框，用一种颜色在画布上绘制指定区域的矩形框。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

surface

+

输入参数，画布。

+

rect

+

输入参数，矩形框结构。

+

color

+

输入参数，绘制的颜色。

+

opt

+

输入参数，硬件加速选项。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## FillRect + +``` +int32_t(* GfxFuncs::FillRect) (ISurface *surface, IRect *rect, uint32_t color, GfxOpt *opt) +``` + +**描述：** + +填充矩形，用一种颜色填充画布上指定矩形区域的矩形框。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

surface

+

输入参数，画布。

+

rect

+

输入参数，填充的矩形区域。

+

color

+

输入参数，填充的颜色。

+

opt

+

输入参数，硬件加速选项。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## InitGfx + +``` +int32_t(* GfxFuncs::InitGfx) (void) +``` + +**描述：** + +初始化硬件加速。 + +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +**参见：** + +[DeinitGfx](_gfx_funcs.md#ad86b127aad2a6e7f01e07b77054d42b3) + +## Sync + +``` +int32_t(* GfxFuncs::Sync) (int32_t timeOut) +``` + +**描述：** + +硬件加速同步。 + +在使用硬件加速模块进行图像绘制、图像叠加、图像搬移时，通过调用该接口进行硬件同步，该接口会等待硬件加速完成。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

timeOut

+

输入参数，硬件加速同步超时设置，设置为0表示无超时，等待直到硬件加速完成。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + diff --git a/zh-cn/device-dev/api/toctopics/_gfx_opt.md b/zh-cn/device-dev/api/toctopics/_gfx_opt.md new file mode 100644 index 0000000000..77263b8f30 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_gfx_opt.md @@ -0,0 +1,81 @@ +# GfxOpt + +## **概述** + +**所属模块:** + +[Display](_display.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

enGlobalAlpha

+

全局alpha使能标志

+

globalAlpha

+

全局alpha的值

+

enPixelAlpha

+

像素alpha使能标志

+

blendType

+

混合方式

+

colorKeyFrom

+

色键模式

+

enableRop

+

Rop功能使能位

+

colorRopType

+

颜色的Rop类型

+

alphaRopType

+

Alpha的Rop类型

+

enableScale

+

缩放功能使能位

+

rotateType

+

旋转类型

+

mirrorType

+

镜像类型

+
+ +## **详细描述** + +图像硬件加速相关的操作选项结构体定义，用于图像硬件加速时的操作选项。 + diff --git a/zh-cn/device-dev/api/toctopics/_gralloc_funcs.md b/zh-cn/device-dev/api/toctopics/_gralloc_funcs.md new file mode 100644 index 0000000000..997ac514e2 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_gralloc_funcs.md @@ -0,0 +1,422 @@ +# GrallocFuncs + +## **概述** + +**所属模块:** + +[Display](_display.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

( AllocMem )(const AllocInfo *info, BufferHandle **handle)

+

显示内存分配。 更多...

+

( FreeMem )(BufferHandle *handle)

+

显示内存释放。 更多...

+

( Mmap )(BufferHandle *handle)

+

显示内存映射，将内存映射到对应的进程地址空间中。 更多...

+

( MmapYUV )(BufferHandle *handle, YUVDescInfo *info)

+

YUV 内存映射。 更多...

+

( MmapCache )(BufferHandle *handle)

+

显示内存映射，将内存映射为 cache 内存到对应的进程地址空间中。 更多...

+

( Unmap )(BufferHandle *handle)

+

内存反映射，将内存进行反映射。 更多...

+

( FlushCache )(BufferHandle *handle)

+

刷新cache，刷新cache里的内容到内存并且使cache里的内容无效。 更多...

+

( FlushMCache )(BufferHandle *handle)

+

刷新Mmap映射的cache，刷新Mmap映射的cache里的内容到内存并且使cache里的内容无效。 更多...

+

( InvalidateCache )(BufferHandle *handle)

+

使cache中的内容无效用以存储更新内存内容。 更多...

+

( IsSupportedAlloc )(uint32_t num, const VerifyAllocInfo *infos, bool *supporteds)

+

检测给定的VerifyAllocInfo数组信息能否申请内存成功。 更多...

+
+ +## **详细描述** + +显示内存驱动接口结构体，定义显示内存驱动接口函数指针。 + +## **类成员变量说明** + +## AllocMem + +``` +int32_t(* GrallocFuncs::AllocMem) (const AllocInfo *info, BufferHandle **handle) +``` + +**描述：** + +显示内存分配。 + +根据GUI图形系统传递的参数分配内存，分配的内存根据类型可分为共享内存、cache内存和非cache内存等。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

info

+

输入参数，指示申请内存AllocInfo信息.

+

handle

+

输入参数，指向申请的内存handle指针。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## FlushCache + +``` +int32_t(* GrallocFuncs::FlushCache) (BufferHandle *handle) +``` + +**描述：** + +刷新cache，刷新cache里的内容到内存并且使cache里的内容无效。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

handle

+

输出参数，待刷新cache的handle指针。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## FlushMCache + +``` +int32_t(* GrallocFuncs::FlushMCache) (BufferHandle *handle) +``` + +**描述：** + +刷新Mmap映射的cache，刷新Mmap映射的cache里的内容到内存并且使cache里的内容无效。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

handle

+

输出参数，待刷新cache的handle指针。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## FreeMem + +``` +void(* GrallocFuncs::FreeMem) (BufferHandle *handle) +``` + +**描述：** + +显示内存释放。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

handle

+

输入参数，待释放的内存handle指针。

+
+ +**返回：** + +成功返回有效地址，失败返回NULL。 + +## InvalidateCache + +``` +int32_t(* GrallocFuncs::InvalidateCache) (BufferHandle *handle) +``` + +**描述：** + +使cache中的内容无效用以存储更新内存内容。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

handle

+

输出参数，待无效cache的handle指针。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## IsSupportedAlloc + +``` +int32_t(* GrallocFuncs::IsSupportedAlloc) (uint32_t num, const VerifyAllocInfo *infos, bool *supporteds) +``` + +**描述：** + +检测给定的VerifyAllocInfo数组信息能否申请内存成功。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

num

+

输入参数，VerifyAllocInfo数组个数。

+

infos

+

输出参数，VerifyAllocInfo数组首地址。

+

supporteds

+

输出参数，supporteds数组首地址, 表示能否申请成功。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## Mmap + +``` +void*(* GrallocFuncs::Mmap) (BufferHandle *handle) +``` + +**描述：** + +显示内存映射，将内存映射到对应的进程地址空间中。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

handle

+

输入参数，待映射内存handle指针。

+
+ +**返回：** + +成功返回有效地址，失败返回NULL。 + +## MmapCache + +``` +void*(* GrallocFuncs::MmapCache) (BufferHandle *handle) +``` + +**描述：** + +显示内存映射，将内存映射为 cache 内存到对应的进程地址空间中。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

handle

+

输出参数，待映射内存 handle 指针。

+
+ +**返回：** + +成功返回有效地址，失败返回 NULL。 + +## MmapYUV + +``` +void*(* GrallocFuncs::MmapYUV) (BufferHandle *handle, YUVDescInfo *info) +``` + +**描述：** + +YUV 内存映射。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

handle

+

输出参数，指示内存映射的输出缓存。

+

info

+

输出参数，指示内存映射的YUVDescInfo信息。

+
+ +**返回：** + +成功返回有效地址，失败返回 NULL。 + +## Unmap + +``` +int32_t(* GrallocFuncs::Unmap) (BufferHandle *handle) +``` + +**描述：** + +内存反映射，将内存进行反映射。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

handle

+

输出参数，待反映射内存handle指针。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + diff --git a/zh-cn/device-dev/api/toctopics/_h_d_r_capability.md b/zh-cn/device-dev/api/toctopics/_h_d_r_capability.md new file mode 100644 index 0000000000..7b0763b078 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_h_d_r_capability.md @@ -0,0 +1,51 @@ +# HDRCapability + +## **概述** + +**所属模块:** + +[Display](_display.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

formatCount

+

支持的HDR格式的数量

+

formats

+

支持的HDR格式的数组首地址

+

maxLum

+

最大的光亮度luminance值

+

maxAverageLum

+

最大的平均光亮度luminance值

+

minLum

+

最小的光亮度luminance值

+
+ +## **详细描述** + +HDR属性结构体定义。 + diff --git a/zh-cn/device-dev/api/toctopics/_h_d_r_meta_data.md b/zh-cn/device-dev/api/toctopics/_h_d_r_meta_data.md new file mode 100644 index 0000000000..fc8f4cc892 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_h_d_r_meta_data.md @@ -0,0 +1,36 @@ +# HDRMetaData + +## **概述** + +**所属模块:** + +[Display](_display.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + +

Public 属性

+

描述

+

key

+

HDR元数据关键字。

+

value

+

关键字对应的值。

+
+ +## **详细描述** + +HDR元数据结构体定义。 + diff --git a/zh-cn/device-dev/api/toctopics/_hdf_face_auth.md b/zh-cn/device-dev/api/toctopics/_hdf_face_auth.md new file mode 100644 index 0000000000..c56be6b842 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_hdf_face_auth.md @@ -0,0 +1,401 @@ +# HdfFaceAuth + +## **汇总** + +## 文件 + + + + + + + + + + + + + + + + + + + +

文件

+

描述

+

FaceAuthTypes.idl

+

定义人脸认证驱动的枚举类和数据结构。

+

FACEAUTH_IExecutor.idl

+

定义执行器接口，用于获取执行器，获取凭据模版信息，注册人脸特征模版，进行用户人脸认证，删除人脸特征模版等。

+

FACEAUTH_IExecutorCallback.idl

+

定义异步API接口回调，用于返回异步接口的请求处理结果和信息。

+

IFaceAuthInterface.idl

+

定义获取人脸认证驱动的执行器列表接口，用于从人脸认证驱动获取执行器对象列表。

+
+ +## 类 + + + + + + + + + + + + + + + + + + + + + + +

类

+

描述

+

ExecutorInfo

+

执行器信息。 更多...

+

TemplateInfo

+

凭据模版信息。 更多...

+

IExecutor

+

定义执行器接口，用于获取执行器，获取凭据模版信息，注册人脸特征模版，进行用户人脸认证，删除人脸特征模版等。 更多...

+

IExecutorCallback

+

定义异步API接口回调，用于返回异步接口的请求处理结果和信息。使用细节见IExecutor。 更多...

+

IFaceAuthInterface

+

定义获取人脸认证驱动的执行器列表接口。 更多...

+
+ +## 枚举 + + + + + + + + + + + + + + + + + + + + + + +

枚举

+

描述

+

AuthType : int { PIN = 1, FACE = 2, FINGERPRINT = 4, ALL = 0 }

+

枚举用户认证凭据类型。 更多...

+

ExecutorRole : int { COLLECTOR = 1, VERIFIER = 2, ALL_IN_ONE = 3 }

+

枚举执行器角色。 更多...

+

ExecutorSecureLevel : int { ESL0 = 0, ESL1 = 1, ESL2 = 2, ESL3 = 3 }

+

枚举执行器安全等级。 更多...

+

CommandId : int { LOCK_TEMPLATE = 1, UNLOCK_TEMPLATE = 2, VENDOR_COMMAND_BEGIN = 10000, DEFAULT = 0 }

+

枚举人脸认证功能相关操作命令。 更多...

+

FaceTipsCode : int { FACE_AUTH_TIP_TOO_BRIGHT = 1, FACE_AUTH_TIP_TOO_DARK = 2, FACE_AUTH_TIP_TOO_CLOSE = 3, FACE_AUTH_TIP_TOO_FAR = 4, FACE_AUTH_TIP_TOO_HIGH = 5, FACE_AUTH_TIP_TOO_LOW = 6, FACE_AUTH_TIP_TOO_RIGHT = 7, FACE_AUTH_TIP_TOO_LEFT = 8, FACE_AUTH_TIP_TOO_MUCH_MOTION = 9, FACE_AUTH_TIP_POOR_GAZE = 10, FACE_AUTH_TIP_NOT_DETECTED = 11, VENDOR_FACE_AUTH_TIP_BEGIN = 10000 }

+

枚举提示信息编码。 更多...

+
+ +## 变量 + + + + + + + + + + +

变量 名称

+

描述

+

package ohos.hdi.face_auth.v1_0

+

人脸认证接口的包路径

+
+ +## **详细描述** + +提供人脸认证驱动的标准API接口。 + +人脸认证驱动为人脸认证服务提供统一的访问接口。获取人脸认证驱动代理后，人脸认证服务可以调用相关接口获取执行器，获取人脸认证执行器后， 人脸认证服务可以调用相关接口获取执行器，获取凭据模版信息，注册人脸特征模版，进行用户人脸认证，删除人脸特征模版等。 + +**Since：** + +3.2 + +## **枚举类型说明** + +## AuthType + +``` +enum AuthType : int +``` + +**描述：** + +枚举用户认证凭据类型。 + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

PIN

+

认证凭据类型为口令。

+

+

FACE

+

认证凭据类型为人脸。

+

+

FINGERPRINT

+

认证凭据类型为指纹。

+

+

ALL

+

表示包含所有认证凭据类型。

+

+
+ +## CommandId + +``` +enum CommandId : int +``` + +**描述：** + +枚举人脸认证功能相关操作命令。 + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

LOCK_TEMPLATE

+

锁定人脸模版。

+

+

UNLOCK_TEMPLATE

+

解锁人脸模版。

+

+

VENDOR_COMMAND_BEGIN

+

用于厂商自定义操作指令。

+

+

DEFAULT

+

默认无效操作命令。

+

+
+ +## ExecutorRole + +``` +enum ExecutorRole : int +``` + +**描述：** + +枚举执行器角色。 + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

COLLECTOR

+

执行器角色为采集器，提供用户认证时的数据采集能力，需要和认证器配合完成用户认证。

+

+

VERIFIER

+

执行器角色为认证器，提供用户认证时数据处理能力，读取存储凭据模板信息并完成比对。

+

+

ALL_IN_ONE

+

执行器角色为全功能执行器，可提供用户认证数据采集、处理、储存及比对能力。

+

+
+ +## ExecutorSecureLevel + +``` +enum ExecutorSecureLevel : int +``` + +**描述：** + +枚举执行器安全等级。 + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

ESL0

+

执行器安全级别为0，关键操作在无访问控制执行环境中完成。

+

+

ESL1

+

执行器安全级别为1，关键操作在有访问控制的执行环境中完成。

+

+

ESL2

+

执行器安全级别为2，关键操作在可信执行环境中完成。

+

+

ESL3

+

执行器安全级别为3，关键操作在高安环境如独立安全芯片中完成。

+

+
+ +## FaceTipsCode + +``` +enum FaceTipsCode : int +``` + +**描述：** + +枚举提示信息编码。 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

FACE_AUTH_TIP_TOO_BRIGHT

+

获取的人脸图像由于光照度高而过亮。

+

+

FACE_AUTH_TIP_TOO_DARK

+

获取的人脸图像由于光照度低而过暗。

+

+

FACE_AUTH_TIP_TOO_CLOSE

+

人脸离设备过近。

+

+

FACE_AUTH_TIP_TOO_FAR

+

人脸离设备过远。

+

+

FACE_AUTH_TIP_TOO_HIGH

+

设备过高，只拍到人脸的上半部分。

+

+

FACE_AUTH_TIP_TOO_LOW

+

设备过低，只拍到人脸的下半部分。

+

+

FACE_AUTH_TIP_TOO_RIGHT

+

设备偏右，只拍到人脸的右侧部分。

+

+

FACE_AUTH_TIP_TOO_LEFT

+

设备偏左，只拍到人脸的左侧部分。

+

+

FACE_AUTH_TIP_TOO_MUCH_MOTION

+

人脸信息采集过程中，人脸移动过多。

+

+

FACE_AUTH_TIP_POOR_GAZE

+

用户未注视设备。

+

+

FACE_AUTH_TIP_NOT_DETECTED

+

未检测到人脸。

+

+

VENDOR_FACE_AUTH_TIP_BEGIN

+

用于厂商自定义提示信息。

+

+
+ diff --git a/zh-cn/device-dev/api/toctopics/_hdf_pin_auth.md b/zh-cn/device-dev/api/toctopics/_hdf_pin_auth.md new file mode 100644 index 0000000000..9555b071a1 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_hdf_pin_auth.md @@ -0,0 +1,299 @@ +# HdfPinAuth + +## **汇总** + +## 文件 + + + + + + + + + + + + + + + + +

文件

+

描述

+

IExecutor.idl

+

定义执行器标准API接口。接口可用于获取执行器信息，获取凭据模版信息，注册口令，认证口令，删除口令等。

+

IExecutorCallback.idl

+

定义异步API接口回调，用于返回异步接口的请求处理结果和获取信息。

+

IPinAuthInterface.idl

+

定义获取口令认证驱动的执行器列表接口，用于从口令认证驱动获取执行器对象列表。

+
+ +## 类 + + + + + + + + + + + + + + + + + + + + + + +

类

+

描述

+

IExecutor

+

定义执行器接口，用于获取执行器，获取凭据模版信息，注册人脸特征模版，进行用户人脸认证，删除人脸特征模版等。 更多...

+

IExecutorCallback

+

定义异步API接口回调，用于返回异步接口的请求处理结果和信息。使用细节见IExecutor。 更多...

+

IPinAuthInterface

+

定义获取口令认证驱动的执行器列表接口。 更多...

+

ExecutorInfo

+

执行器信息。 更多...

+

TemplateInfo

+

凭据模版信息。 更多...

+
+ +## 枚举 + + + + + + + + + + + + + + + + + + + +

枚举

+

描述

+

AuthType : int { PIN = 1, FACE = 2, FINGERPRINT = 4, ALL = 0 }

+

枚举用户认证凭据类型。 更多...

+

ExecutorRole : int { COLLECTOR = 1, VERIFIER = 2, ALL_IN_ONE = 3 }

+

枚举执行器角色。 更多...

+

ExecutorSecureLevel : int { ESL0 = 0, ESL1 = 1, ESL2 = 2, ESL3 = 3 }

+

枚举执行器安全等级。 更多...

+

CommandId : int { LOCK_TEMPLATE = 1, UNLOCK_TEMPLATE = 2, VENDOR_COMMAND_BEGIN = 10000, DEFAULT = 0 }

+

枚举口令认证相关功能操作命令。 更多...

+
+ +## 变量 + + + + + + + + + + +

变量 名称

+

描述

+

package ohos.hdi.pin_auth.v1_0

+

口令认证接口的包路径

+
+ +## **详细描述** + +提供口令认证驱动的标准API接口。 + +口令认证驱动为口令认证服务提供统一的访问接口。获取口令认证驱动代理后，口令认证服务可以调用相关接口获取执行器，获取口令认证执行器后， 口令认证服务可以调用相关接口获取执行器信息，获取凭据模版信息，注册口令，认证口令，删除口令等。 + +**Since：** + +3.2 + +## **枚举类型说明** + +## AuthType + +``` +enum AuthType : int +``` + +**描述：** + +枚举用户认证凭据类型。 + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

PIN

+

认证凭据类型为口令。

+

+

FACE

+

认证凭据类型为人脸。

+

+

FINGERPRINT

+

认证凭据类型为指纹。

+

+

ALL

+

表示包含所有认证凭据类型。

+

+
+ +## CommandId + +``` +enum CommandId : int +``` + +**描述：** + +枚举口令认证相关功能操作命令。 + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

LOCK_TEMPLATE

+

锁定人脸模版。

+

+

UNLOCK_TEMPLATE

+

解锁人脸模版。

+

+

VENDOR_COMMAND_BEGIN

+

用于厂商自定义操作指令。

+

+

DEFAULT

+

默认无效操作命令。

+

+
+ +## ExecutorRole + +``` +enum ExecutorRole : int +``` + +**描述：** + +枚举执行器角色。 + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

COLLECTOR

+

执行器角色为采集器，提供用户认证时的数据采集能力，需要和认证器配合完成用户认证。

+

+

VERIFIER

+

执行器角色为认证器，提供用户认证时数据处理能力，读取存储凭据模板信息并完成比对。

+

+

ALL_IN_ONE

+

执行器角色为全功能执行器，可提供用户认证数据采集、处理、储存及比对能力。

+

+
+ +## ExecutorSecureLevel + +``` +enum ExecutorSecureLevel : int +``` + +**描述：** + +枚举执行器安全等级。 + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

ESL0

+

执行器安全级别为0，关键操作在无访问控制执行环境中完成。

+

+

ESL1

+

执行器安全级别为1，关键操作在有访问控制的执行环境中完成。

+

+

ESL2

+

执行器安全级别为2，关键操作在可信执行环境中完成。

+

+

ESL3

+

执行器安全级别为3，关键操作在高安环境如独立安全芯片中完成。

+

+
+ diff --git a/zh-cn/device-dev/api/toctopics/_hdf_thermal_callback_info.md b/zh-cn/device-dev/api/toctopics/_hdf_thermal_callback_info.md new file mode 100644 index 0000000000..28ba720064 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_hdf_thermal_callback_info.md @@ -0,0 +1,43 @@ +# HdfThermalCallbackInfo + +## **概述** + +**所属模块:** + +[Thermal](thermal.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + +

Public 属性

+

描述

+

info

+

设备发热的信息列表。

+
+ +## **详细描述** + +设备发热的信息列表。 + +## **类成员变量说明** + +## info + +``` +List HdfThermalCallbackInfo::info +``` + +**描述：** + +设备发热的信息列表。 + diff --git a/zh-cn/device-dev/api/toctopics/_hdf_user_auth.md b/zh-cn/device-dev/api/toctopics/_hdf_user_auth.md new file mode 100644 index 0000000000..408750facb --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_hdf_user_auth.md @@ -0,0 +1,275 @@ +# HdfUserAuth + +## **汇总** + +## 文件 + + + + + + + + + + + + + +

文件

+

描述

+

IUserAuthInterface.idl

+

声明用户认证驱动的API接口。接口可用于注册执行器，管理用户认证凭据，完成PIN码和生物特征认证。

+

UserAuthTypes.idl

+

定义用户认证驱动的枚举类和数据结构。

+
+ +## 类 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

类

+

描述

+

IUserAuthInterface

+

声明用户认证驱动的API接口。 更多...

+

ExecutorRegisterInfo

+

执行器注册信息。 更多...

+

ExecutorInfo

+

执行器信息。 更多...

+

ScheduleInfo

+

调度信息。 更多...

+

AuthSolution

+

认证方案。 更多...

+

ExecutorSendMsg

+

执行器发送的消息。 更多...

+

AuthResultInfo

+

用户身份认证结果信息。 更多...

+

IdentifyResultInfo

+

用户身份识别结果信息。 更多...

+

EnrollParam

+

注册认证凭据参数。 更多...

+

CredentialInfo

+

认证凭据信息。 更多...

+

EnrolledInfo

+

注册信息。 更多...

+
+ +## 枚举 + + + + + + + + + + + + + + + + +

枚举

+

描述

+

AuthType : int { PIN = 1, FACE = 2, FINGERPRINT = 4, ALL = 0 }

+

枚举用户认证凭据类型。 更多...

+

ExecutorRole : int { COLLECTOR = 1, VERIFIER = 2, ALL_IN_ONE = 3 }

+

枚举执行器角色。 更多...

+

ExecutorSecureLevel : int { ESL0 = 0, ESL1 = 1, ESL2 = 2, ESL3 = 3 }

+

枚举执行器安全等级。 更多...

+
+ +## 变量 + + + + + + + + + + +

变量 名称

+

描述

+

package ohos.hdi.user_auth.v1_0

+

用户认证接口的包路径

+
+ +## **详细描述** + +提供用户认证驱动的标准API接口。 + +用户认证驱动为用户认证服务提供统一的访问接口。获取用户认证驱动代理后，用户认证服务可以调用相关接口注册执行器，管理用户认证凭据， 完成PIN码和生物特征。 + +**Since：** + +3.2 + +## **枚举类型说明** + +## AuthType + +``` +enum AuthType : int +``` + +**描述：** + +枚举用户认证凭据类型。 + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

PIN

+

认证凭据类型为口令。

+

+

FACE

+

认证凭据类型为人脸。

+

+

FINGERPRINT

+

认证凭据类型为指纹。

+

+

ALL

+

表示包含所有认证凭据类型。

+

+
+ +## ExecutorRole + +``` +enum ExecutorRole : int +``` + +**描述：** + +枚举执行器角色。 + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

COLLECTOR

+

执行器角色为采集器，提供用户认证时的数据采集能力，需要和认证器配合完成用户认证。

+

+

VERIFIER

+

执行器角色为认证器，提供用户认证时数据处理能力，读取存储凭据模板信息并完成比对。

+

+

ALL_IN_ONE

+

执行器角色为全功能执行器，可提供用户认证数据采集、处理、储存及比对能力。

+

+
+ +## ExecutorSecureLevel + +``` +enum ExecutorSecureLevel : int +``` + +**描述：** + +枚举执行器安全等级。 + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

ESL0

+

执行器安全级别为0，关键操作在无访问控制执行环境中完成。

+

+

ESL1

+

执行器安全级别为1，关键操作在有访问控制的执行环境中完成。

+

+

ESL2

+

执行器安全级别为2，关键操作在可信执行环境中完成。

+

+

ESL3

+

执行器安全级别为3，关键操作在高安环境如独立安全芯片中完成。

+

+
+ diff --git a/zh-cn/device-dev/api/toctopics/_i_battery_callback_8idl.md b/zh-cn/device-dev/api/toctopics/_i_battery_callback_8idl.md new file mode 100644 index 0000000000..f0c9ba3f68 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_i_battery_callback_8idl.md @@ -0,0 +1,58 @@ +# IBatteryCallback.idl + +## **概述** + +**所属模块:** + +[Battery](battery.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

IBatteryCallback

+

电池信息的回调。 更多...

+
+ +## 变量 + + + + + + + + + + +

变量 名称

+

描述

+

package ohos.hdi.battery.v1_0

+

电池信息接口的包路径

+
+ +## **详细描述** + +电池信息的回调。 + +电池模块为电池服务提供的订阅电池信息变化的回调。 + +**Since：** + +3.1 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/_i_battery_interface_8idl.md b/zh-cn/device-dev/api/toctopics/_i_battery_interface_8idl.md new file mode 100644 index 0000000000..9f77ca138f --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_i_battery_interface_8idl.md @@ -0,0 +1,54 @@ +# IBatteryInterface.idl + +## **概述** + +**所属模块:** + +[Battery](battery.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

IBatteryInterface

+

获取、订阅电池信息的接口。 更多...

+
+ +## 变量 + + + + + + + + + + +

变量 名称

+

描述

+

package ohos.hdi.battery.v1_0

+

电池信息接口的包路径

+
+ +## **详细描述** + +获取、订阅电池信息的接口。 + +服务获取此对象后，可以调用相关的接口获取、订阅电池信息。 + +**Since：** + +3.1 + diff --git a/zh-cn/device-dev/api/toctopics/_i_circle.md b/zh-cn/device-dev/api/toctopics/_i_circle.md new file mode 100644 index 0000000000..aedd59d146 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_i_circle.md @@ -0,0 +1,46 @@ +# ICircle + +## **概述** + +**所属模块:** + +[Display](_display.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

x

+

矩形框起始X坐标。

+

y

+

矩形框起始Y坐标。

+

r

+

圆的半径。

+

color

+

圆的颜色。

+
+ +## **详细描述** + +圆形描述结构体定义，用于硬件加速绘制圆形。 + diff --git a/zh-cn/device-dev/api/toctopics/_i_face_auth_interface_8idl.md b/zh-cn/device-dev/api/toctopics/_i_face_auth_interface_8idl.md new file mode 100644 index 0000000000..41ba7b392b --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_i_face_auth_interface_8idl.md @@ -0,0 +1,52 @@ +# IFaceAuthInterface.idl + +## **概述** + +**所属模块:** + +[HdfFaceAuth](_hdf_face_auth.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

IFaceAuthInterface

+

定义获取人脸认证驱动的执行器列表接口。 更多...

+
+ +## 变量 + + + + + + + + + + +

变量 名称

+

描述

+

package ohos.hdi.face_auth.v1_0

+

人脸认证接口的包路径

+
+ +## **详细描述** + +定义获取人脸认证驱动的执行器列表接口，用于从人脸认证驱动获取执行器对象列表。 + +**Since：** + +3.2 + diff --git a/zh-cn/device-dev/api/toctopics/_i_input_interface.md b/zh-cn/device-dev/api/toctopics/_i_input_interface.md new file mode 100644 index 0000000000..5839de6bb8 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_i_input_interface.md @@ -0,0 +1,73 @@ +# IInputInterface + +## **概述** + +**所属模块:** + +[Input](_input.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

iInputManager

+

input设备的设备管理接口。

+

iInputController

+

input设备的业务控制接口。

+

iInputReporter

+

input设备的数据上报接口。

+
+ +## **详细描述** + +定义用于提供输入设备驱动能力的接口。 + +## **类成员变量说明** + +## iInputController + +``` +[InputController](_input_controller.md)* IInputInterface::iInputController +``` + +**描述：** + +input设备的业务控制接口 + +## iInputManager + +``` +[InputManager](_input_manager.md)* IInputInterface::iInputManager +``` + +**描述：** + +input设备的设备管理接口 + +## iInputReporter + +``` +[InputReporter](_input_reporter.md)* IInputInterface::iInputReporter +``` + +**描述：** + +input设备的数据上报接口 + diff --git a/zh-cn/device-dev/api/toctopics/_i_line.md b/zh-cn/device-dev/api/toctopics/_i_line.md new file mode 100644 index 0000000000..237ca23046 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_i_line.md @@ -0,0 +1,51 @@ +# ILine + +## **概述** + +**所属模块:** + +[Display](_display.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

x0

+

线条起点的X坐标。

+

y0

+

线条起点的Y坐标。

+

x1

+

线条终点的X坐标。

+

y1

+

线条终点的Y坐标。

+

color

+

线条颜色。

+
+ +## **详细描述** + +线条描述结构体定义，用于硬件加速绘制直线。 + diff --git a/zh-cn/device-dev/api/toctopics/_i_pin_auth_interface_8idl.md b/zh-cn/device-dev/api/toctopics/_i_pin_auth_interface_8idl.md new file mode 100644 index 0000000000..accae73c9e --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_i_pin_auth_interface_8idl.md @@ -0,0 +1,52 @@ +# IPinAuthInterface.idl + +## **概述** + +**所属模块:** + +[HdfPinAuth](_hdf_pin_auth.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

IPinAuthInterface

+

定义获取口令认证驱动的执行器列表接口。 更多...

+
+ +## 变量 + + + + + + + + + + +

变量 名称

+

描述

+

package ohos.hdi.pin_auth.v1_0

+

口令认证接口的包路径

+
+ +## **详细描述** + +定义获取口令认证驱动的执行器列表接口，用于从口令认证驱动获取执行器对象列表。 + +**Since：** + +3.2 + diff --git a/zh-cn/device-dev/api/toctopics/_i_power_hdi_callback_8idl.md b/zh-cn/device-dev/api/toctopics/_i_power_hdi_callback_8idl.md new file mode 100644 index 0000000000..edbeb2b63f --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_i_power_hdi_callback_8idl.md @@ -0,0 +1,58 @@ +# IPowerHdiCallback.idl + +## **概述** + +**所属模块:** + +[Power](power.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

IPowerHdiCallback

+

休眠/唤醒状态的回调。 更多...

+
+ +## 变量 + + + + + + + + + + +

变量 名称

+

描述

+

package ohos.hdi.power.v1_0

+

电源接口的包路径

+
+ +## **详细描述** + +休眠/唤醒状态的回调。 + +电源模块为电源服务提供的订阅休眠/唤醒状态的回调。 + +**Since：** + +3.1 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/_i_power_interface_8idl.md b/zh-cn/device-dev/api/toctopics/_i_power_interface_8idl.md new file mode 100644 index 0000000000..9f4d028e83 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_i_power_interface_8idl.md @@ -0,0 +1,58 @@ +# IPowerInterface.idl + +## **概述** + +**所属模块:** + +[Power](power.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

IPowerInterface

+

休眠/唤醒操作、订阅休眠/唤醒状态、运行锁管理的接口。 更多...

+
+ +## 变量 + + + + + + + + + + +

变量 名称

+

描述

+

package ohos.hdi.power.v1_0

+

电源接口的包路径

+
+ +## **详细描述** + +休眠/唤醒操作、订阅休眠/唤醒状态、运行锁管理的接口。 + +电源模块为电源服务提供休眠/唤醒操作、订阅休眠/唤醒状态和运行锁管理的接口。 + +**Since：** + +3.1 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/_i_rect.md b/zh-cn/device-dev/api/toctopics/_i_rect.md new file mode 100644 index 0000000000..b590a69aa2 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_i_rect.md @@ -0,0 +1,46 @@ +# IRect + +## **概述** + +**所属模块:** + +[Display](_display.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

x

+

矩形框起始X坐标。

+

y

+

矩形框起始Y坐标。

+

w

+

矩形框宽度。

+

h

+

矩形框高度。

+
+ +## **详细描述** + +定义矩形信息。 + diff --git a/zh-cn/device-dev/api/toctopics/_i_surface.md b/zh-cn/device-dev/api/toctopics/_i_surface.md new file mode 100644 index 0000000000..31a1e39815 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_i_surface.md @@ -0,0 +1,91 @@ +# ISurface + +## **概述** + +**所属模块:** + +[Display](_display.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

phyAddr

+

图像首地址

+

height

+

图像高度

+

width

+

图像宽度

+

stride

+

图像跨度

+

enColorFmt

+

图像格式

+

bYCbCrClut

+

CLUT表是否位于 YCbCr 空间

+

bAlphaMax255

+

图像alpha最大值为255还是128

+

bAlphaExt1555

+

是否使能1555的Alpha扩展

+

alpha0

+

Alpha0值，取值范围：[0,255]

+

alpha1

+

Alpha1值，取值范围：[0,255]

+

cbcrPhyAddr

+

CLUT表首地址，用作颜色扩展或颜色校正

+

cbcrStride

+

CbCr分量跨度

+

clutPhyAddr

+

CbCr分量地址

+
+ +## **详细描述** + +用于存放窗口相关信息的结构体定义，提供给硬件加速使用，例如图像合成，位图搬移等操作。 + diff --git a/zh-cn/device-dev/api/toctopics/_i_thermal_callback_8idl.md b/zh-cn/device-dev/api/toctopics/_i_thermal_callback_8idl.md new file mode 100644 index 0000000000..739df4eefe --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_i_thermal_callback_8idl.md @@ -0,0 +1,58 @@ +# IThermalCallback.idl + +## **概述** + +**所属模块:** + +[Thermal](thermal.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

IThermalCallback

+

订阅设备发热状态的回调。 更多...

+
+ +## 变量 + + + + + + + + + + +

变量 名称

+

描述

+

package ohos.hdi.thermal.v1_0

+

设备温度管理接口的包路径

+
+ +## **详细描述** + +设备发热状态的回调。 + +热模块为热服务提供的设备发热状态的回调。 + +**Since：** + +3.1 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/_i_thermal_interface_8idl.md b/zh-cn/device-dev/api/toctopics/_i_thermal_interface_8idl.md new file mode 100644 index 0000000000..67f98c016f --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_i_thermal_interface_8idl.md @@ -0,0 +1,58 @@ +# IThermalInterface.idl + +## **概述** + +**所属模块:** + +[Thermal](thermal.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

IThermalInterface

+

设备温度管理、控制及订阅接口。 更多...

+
+ +## 变量 + + + + + + + + + + +

变量 名称

+

描述

+

package ohos.hdi.thermal.v1_0

+

设备温度管理接口的包路径

+
+ +## **详细描述** + +设备温度管理、控制及订阅接口。 + +热模块为热服务提供的设备温度管理、控制及订阅接口。 + +**Since：** + +3.1 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/_i_user_auth_interface_8idl.md b/zh-cn/device-dev/api/toctopics/_i_user_auth_interface_8idl.md new file mode 100644 index 0000000000..83940029b9 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_i_user_auth_interface_8idl.md @@ -0,0 +1,52 @@ +# IUserAuthInterface.idl + +## **概述** + +**所属模块:** + +[HdfUserAuth](_hdf_user_auth.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

IUserAuthInterface

+

声明用户认证驱动的API接口。 更多...

+
+ +## 变量 + + + + + + + + + + +

变量 名称

+

描述

+

package ohos.hdi.user_auth.v1_0

+

用户认证接口的包路径

+
+ +## **详细描述** + +声明用户认证驱动的API接口。接口可用于注册执行器，管理用户认证凭据，完成PIN码和生物特征认证。 + +**Since：** + +3.2 + diff --git a/zh-cn/device-dev/api/toctopics/_i_wi_fi.md b/zh-cn/device-dev/api/toctopics/_i_wi_fi.md new file mode 100644 index 0000000000..9b1f2d4278 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_i_wi_fi.md @@ -0,0 +1,577 @@ +# IWiFi + +## **概述** + +**所属模块:** + +[WLAN](_w_l_a_n.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

( start )(struct IWiFi *iwifi)

+

创建HAL和驱动之间的通道及获取驱动网卡信息，该函数调用在创建IWiFi实体后进行。 更多...

+

( stop )(struct IWiFi *iwifi)

+

销毁HAL和驱动之间的通道，该函数调用在销毁IWiFi实体前进行。 更多...

+

( getSupportFeature )(uint8_t *supType, uint32_t size)

+

获取该设备支持的WLAN特性（不考虑当前的使用状态）。 更多...

+

( getSupportCombo )(uint64_t *combo, uint32_t size)

+

获取多网卡共存情况。 更多...

+

( createFeature )(int32_t type, struct IWiFiBaseFeature **ifeature)

+

根据输入类型创建对应的特性IWiFiBaseFeature。 更多...

+

( getFeatureByIfName )(const char *ifName, struct IWiFiBaseFeature **ifeature)

+

通过网络接口名字获取对应的特性。 更多...

+

( registerEventCallback )(CallbackFunc cbFunc, const char *ifName)

+

注册IWiFi的回调函数，监听异步事件。 更多...

+

( unregisterEventCallback )(CallbackFunc cbFunc, const char *ifName)

+

去注册IWiFi的回调函数。 更多...

+

( destroyFeature )(struct IWiFiBaseFeature *ifeature)

+

根据输入类型销毁对应的特性IWiFiBaseFeature。 更多...

+

( resetDriver )(const uint8_t chipId, const char *ifName)

+

重置具有指定芯片ID的WLAN驱动程序。 更多...

+

( getNetDevInfo )(struct NetDeviceInfoResult *netDeviceInfoResult)

+

获取网络设备信息（设备索引、网卡名字、MAC等信息）。 更多...

+

( getPowerMode )(const char *ifName, uint8_t *mode)

+

获取正在使用的功率模式。 更多...

+

( setPowerMode )(const char *ifName, uint8_t mode)

+

设置功率模式 更多...

+
+ +## **详细描述** + +HAL对WLAN服务提供的基本能力。 + +用于创建HAL与驱动的通道，创建/获取/销毁WLAN特性等。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## **类成员变量说明** + +## createFeature + +``` +int32_t(* IWiFi::createFeature) (int32_t type, struct IWiFiBaseFeature **ifeature) +``` + +**描述：** + +根据输入类型创建对应的特性[IWiFiBaseFeature](_i_wi_fi_base_feature.md)。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

type

+

输入参数，创建的feature类型。

+

ifeature

+

输出参数，获取创建的feature对象。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +## destroyFeature + +``` +int32_t(* IWiFi::destroyFeature) (struct IWiFiBaseFeature *ifeature) +``` + +**描述：** + +根据输入类型销毁对应的特性[IWiFiBaseFeature](_i_wi_fi_base_feature.md)。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

ifeature

+

输入参数，销毁的feature对象。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +## getFeatureByIfName + +``` +int32_t(* IWiFi::getFeatureByIfName) (const char *ifName, struct IWiFiBaseFeature **ifeature) +``` + +**描述：** + +通过网络接口名字获取对应的特性。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

ifName

+

输入参数，网卡名称。

+

ifeature

+

输出参数，获取该网络接口名字的feature对象。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +## getNetDevInfo + +``` +int32_t(* IWiFi::getNetDevInfo) (struct NetDeviceInfoResult *netDeviceInfoResult) +``` + +**描述：** + +获取网络设备信息（设备索引、网卡名字、MAC等信息）。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

netDeviceInfoResult

+

输出参数，得到的网络设备信息。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +## getPowerMode + +``` +int32_t(* IWiFi::getPowerMode) (const char *ifName, uint8_t *mode) +``` + +**描述：** + +获取正在使用的功率模式。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

ifName

+

输入参数，网卡名称。

+

mode

+

输出参数，功率模式，包括睡眠模式（待机状态运行）、一般模式（正常额定功率运行）、穿墙模式（最大功率运行，提高信号强度和覆盖面积）。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +## getSupportCombo + +``` +int32_t(* IWiFi::getSupportCombo) (uint64_t *combo, uint32_t size) +``` + +**描述：** + +获取多网卡共存情况。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

combo

+

输出参数，基于芯片的能力保存当前所有支持的多网卡共存情况（比如支持AP，STA，P2P等不同组合的共存）。

+

size

+

输入参数，combo数组的长度。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +## getSupportFeature + +``` +int32_t(* IWiFi::getSupportFeature) (uint8_t *supType, uint32_t size) +``` + +**描述：** + +获取该设备支持的WLAN特性（不考虑当前的使用状态）。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

supType

+

输出参数，保存当前设备支持的特性。

+

size

+

输入参数，supType数组的长度。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +## registerEventCallback + +``` +int32_t(* IWiFi::registerEventCallback) (CallbackFunc cbFunc, const char *ifName) +``` + +**描述：** + +注册IWiFi的回调函数，监听异步事件。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

cbFunc

+

输入参数，注册的回调函数。

+

ifName

+

输入参数，网卡名称。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +## resetDriver + +``` +int32_t(* IWiFi::resetDriver) (const uint8_t chipId, const char *ifName) +``` + +**描述：** + +重置具有指定芯片ID的WLAN驱动程序。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

chipId

+

输入参数，需要进行重置驱动的对应芯片ID。

+

ifName

+

输入参数，网卡名称。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +## setPowerMode + +``` +int32_t(* IWiFi::setPowerMode) (const char *ifName, uint8_t mode) +``` + +**描述：** + +设置功率模式 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

ifName

+

输入参数，网卡名称。

+

mode

+

输入参数，功率模式,包括睡眠模式（待机状态运行）、一般模式（正常额定功率运行）、穿墙模式（最大功率运行，提高信号强度和覆盖面积）。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +## start + +``` +int32_t(* IWiFi::start) (struct IWiFi *iwifi) +``` + +**描述：** + +创建HAL和驱动之间的通道及获取驱动网卡信息，该函数调用在创建IWiFi实体后进行。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

iwifi

+

输入参数，IWiFi对象。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +## stop + +``` +int32_t(* IWiFi::stop) (struct IWiFi *iwifi) +``` + +**描述：** + +销毁HAL和驱动之间的通道，该函数调用在销毁IWiFi实体前进行。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

iwifi

+

输入参数，IWiFi对象。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +## unregisterEventCallback + +``` +int32_t(* IWiFi::unregisterEventCallback) (CallbackFunc cbFunc, const char *ifName) +``` + +**描述：** + +去注册IWiFi的回调函数。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

cbFunc

+

输入参数，去注册的回调函数。

+

ifName

+

输入参数，网卡名称。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + diff --git a/zh-cn/device-dev/api/toctopics/_i_wi_fi_ap.md b/zh-cn/device-dev/api/toctopics/_i_wi_fi_ap.md new file mode 100644 index 0000000000..8a188d6d7c --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_i_wi_fi_ap.md @@ -0,0 +1,152 @@ +# IWiFiAp + +## **概述** + +**所属模块:** + +[WLAN](_w_l_a_n.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

baseFeature

+

基本特性。

+

( getAsscociatedStas )(const struct IWiFiAp *apFeature, struct StaInfo *staInfo, uint32_t count, uint32_t *num)

+

获取连接上的所有STA的信息（目前只包含MAC地址）。 更多...

+

( setCountryCode )(const struct IWiFiAp *apFeature, const char *code, uint32_t len)

+

设置国家码（表示AP射频所在的国家，规定了AP射频特性，包括AP的发送功率、支持的信道等。其目的是为了使AP的射频特性符合不同国家或区域的法律法规要求）。 更多...

+
+ +## **详细描述** + +继承了IWiFiBaseFeature基本特性，并包含AP模式下获取连接STA的信息和设置国家码的功能。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## **类成员变量说明** + +## baseFeature + +``` +struct IWiFiBaseFeature IWiFiAp::baseFeature +``` + +**描述：** + +基本特性。 + +## getAsscociatedStas + +``` +int32_t(* IWiFiAp::getAsscociatedStas) (const struct IWiFiAp *apFeature, struct StaInfo *staInfo, uint32_t count, uint32_t *num) +``` + +**描述：** + +获取连接上的所有STA的信息（目前只包含MAC地址）。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

apFeature

+

输入参数，AP特性IWiFiAp。

+

staInfo

+

输出参数，保存与AP连接的STA的基本信息。

+

count

+

输入参数，staInfo结构体数组的元素个数。

+

num

+

输出参数，实际连接的STA的个数。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +## setCountryCode + +``` +int32_t(* IWiFiAp::setCountryCode) (const struct IWiFiAp *apFeature, const char *code, uint32_t len) +``` + +**描述：** + +设置国家码（表示AP射频所在的国家，规定了AP射频特性，包括AP的发送功率、支持的信道等。其目的是为了使AP的射频特性符合不同国家或区域的法律法规要求）。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

apFeature

+

输入参数，AP特性IWiFiAp。

+

code

+

输入参数，设置的国家码。

+

len

+

输入参数，国家码长度。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + diff --git a/zh-cn/device-dev/api/toctopics/_i_wi_fi_base_feature.md b/zh-cn/device-dev/api/toctopics/_i_wi_fi_base_feature.md new file mode 100644 index 0000000000..8a004f3a4a --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_i_wi_fi_base_feature.md @@ -0,0 +1,420 @@ +# IWiFiBaseFeature + +## **概述** + +**所属模块:** + +[WLAN](_w_l_a_n.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

ifName [IFNAME_MAX_LEN]

+

网卡名称。

+

type

+

特性的类型，参考FeatureType。

+

( getNetworkIfaceName )(const struct IWiFiBaseFeature *baseFeature)

+

根据基本特性获取网卡名称。 更多...

+

( getFeatureType )(const struct IWiFiBaseFeature *baseFeature)

+

获取基本特性的类型FeatureType。 更多...

+

( setMacAddress )(const struct IWiFiBaseFeature *baseFeature, unsigned char *mac, uint8_t len)

+

根据传入参数设置对应网卡的MAC地址。 更多...

+

( getDeviceMacAddress )(const struct IWiFiBaseFeature *baseFeature, unsigned char *mac, uint8_t len)

+

获取设备的MAC地址。 更多...

+

( getValidFreqsWithBand )(const struct IWiFiBaseFeature *baseFeature, int32_t band, int32_t *freqs, uint32_t count, uint32_t *num)

+

获取指定频段（2.4G或者5G）下支持的频率。 更多...

+

( setTxPower )(const struct IWiFiBaseFeature *baseFeature, int32_t power)

+

设置发射功率。 更多...

+

( getChipId )(const struct IWiFiBaseFeature *baseFeature, uint8_t *chipId)

+

获得当前驱动的芯片ID。 更多...

+

( getIfNamesByChipId )(const uint8_t chipId, char **ifNames, uint32_t *num)

+

通过芯片ID获得当前芯片所有的网卡名称。 更多...

+
+ +## **详细描述** + +WLAN基本特性操作接口，包括获取网卡名称，设置MAC地址，设置发射功率等公共能力接口。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## **类成员变量说明** + +## getChipId + +``` +int32_t(* IWiFiBaseFeature::getChipId) (const struct IWiFiBaseFeature *baseFeature, uint8_t *chipId) +``` + +**描述：** + +获得当前驱动的芯片ID。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

baseFeature

+

输入参数，基本特性IWiFiBaseFeature。

+

chipId

+

输出参数，获得的芯片ID。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +## getDeviceMacAddress + +``` +int32_t(* IWiFiBaseFeature::getDeviceMacAddress) (const struct IWiFiBaseFeature *baseFeature, unsigned char *mac, uint8_t len) +``` + +**描述：** + +获取设备的MAC地址。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

baseFeature

+

输入参数，基本特性IWiFiBaseFeature。

+

mac

+

输出参数，获得的MAC地址。

+

len

+

输入参数，获得的MAC地址长度。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +## getFeatureType + +``` +int32_t(* IWiFiBaseFeature::getFeatureType) (const struct IWiFiBaseFeature *baseFeature) +``` + +**描述：** + +获取基本特性的类型[FeatureType](_w_l_a_n.md#gad2b28a6ade408676d1371ea941824012)。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

baseFeature

+

输入参数，基本特性IWiFiBaseFeature。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +## getIfNamesByChipId + +``` +int32_t(* IWiFiBaseFeature::getIfNamesByChipId) (const uint8_t chipId, char **ifNames, uint32_t *num) +``` + +**描述：** + +通过芯片ID获得当前芯片所有的网卡名称。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

chipId

+

输入参数，需要获取网卡名称的芯片ID。

+

ifNames

+

输出参数，网卡名称。

+

num

+

输出参数，网卡的数量。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +## getNetworkIfaceName + +``` +const char*(* IWiFiBaseFeature::getNetworkIfaceName) (const struct IWiFiBaseFeature *baseFeature) +``` + +**描述：** + +根据基本特性获取网卡名称。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

baseFeature

+

输入参数，基本特性IWiFiBaseFeature。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +## getValidFreqsWithBand + +``` +int32_t(* IWiFiBaseFeature::getValidFreqsWithBand) (const struct IWiFiBaseFeature *baseFeature, int32_t band, int32_t *freqs, uint32_t count, uint32_t *num) +``` + +**描述：** + +获取指定频段（2.4G或者5G）下支持的频率。 + +**参数：** + + + + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

baseFeature

+

输入参数，基本特性IWiFiBaseFeature。

+

band

+

输入参数，指定的一个频段。

+

freqs

+

输出参数，保存支持的频率。

+

count

+

输入参数，频率数组的元素个数。

+

num

+

输出参数，实际支持的频率个数。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +## ifName + +``` +char IWiFiBaseFeature::ifName[IFNAME_MAX_LEN] +``` + +**描述：** + +网卡名称。 + +## setMacAddress + +``` +int32_t(* IWiFiBaseFeature::setMacAddress) (const struct IWiFiBaseFeature *baseFeature, unsigned char *mac, uint8_t len) +``` + +**描述：** + +根据传入参数设置对应网卡的MAC地址。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

baseFeature

+

输入参数，基本特性IWiFiBaseFeature。

+

mac

+

输入参数，设置的MAC地址。

+

len

+

输入参数，设置的MAC地址长度。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +## setTxPower + +``` +int32_t(* IWiFiBaseFeature::setTxPower) (const struct IWiFiBaseFeature *baseFeature, int32_t power) +``` + +**描述：** + +设置发射功率。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

baseFeature

+

输入参数，基本特性IWiFiBaseFeature。

+

power

+

输入参数，设置的发射功率。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + diff --git a/zh-cn/device-dev/api/toctopics/_i_wi_fi_sta.md b/zh-cn/device-dev/api/toctopics/_i_wi_fi_sta.md new file mode 100644 index 0000000000..d91c92faaf --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_i_wi_fi_sta.md @@ -0,0 +1,142 @@ +# IWiFiSta + +## **概述** + +**所属模块:** + +[WLAN](_w_l_a_n.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

baseFeature

+

基本特性。

+

( setScanningMacAddress )(const struct IWiFiSta *staFeature, unsigned char *scanMac, uint8_t len)

+

设置扫描单个MAC地址。 更多...

+

( startScan )(const char *ifName, WifiScan *scan)

+

启动扫描。 更多...

+
+ +## **详细描述** + +继承了[IWiFiBaseFeature](_i_wi_fi_base_feature.md)基本特性，额外包含设置扫描单个MAC地址功能。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## **类成员变量说明** + +## baseFeature + +``` +struct IWiFiBaseFeature IWiFiSta::baseFeature +``` + +**描述：** + +基本特性。 + +## setScanningMacAddress + +``` +int32_t(* IWiFiSta::setScanningMacAddress) (const struct IWiFiSta *staFeature, unsigned char *scanMac, uint8_t len) +``` + +**描述：** + +设置扫描单个MAC地址。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

staFeature

+

输入参数，STA特性IWiFiSta。

+

scanMac

+

输入参数，设置STA扫描的MAC地址。

+

len

+

输入参数，MAC地址的长度。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +## startScan + +``` +int32_t(* IWiFiSta::startScan) (const char *ifName, WifiScan *scan) +``` + +**描述：** + +启动扫描。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

ifName

+

输入参数，网卡名称。

+

scan

+

输入参数，扫描参数。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + diff --git a/zh-cn/device-dev/api/toctopics/_identify_result_info.md b/zh-cn/device-dev/api/toctopics/_identify_result_info.md new file mode 100644 index 0000000000..9c49a25138 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_identify_result_info.md @@ -0,0 +1,81 @@ +# IdentifyResultInfo + +## **概述** + +**所属模块:** + +[HdfUserAuth](_hdf_user_auth.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

result

+

用户身份识别结果。

+

userId

+

用户ID。

+

token

+

用户身份识别令牌。

+
+ +## **详细描述** + +用户身份识别结果信息。 + +**Since：** + +3.2 + +**Version:** + +1.0 + +## **类成员变量说明** + +## result + +``` +int IdentifyResultInfo::result +``` + +**描述：** + +用户身份识别结果。 + +## token + +``` +unsigned char [] IdentifyResultInfo::token +``` + +**描述：** + +用户身份识别令牌。 + +## userId + +``` +int IdentifyResultInfo::userId +``` + +**描述：** + +用户ID。 + diff --git a/zh-cn/device-dev/api/toctopics/_input.md b/zh-cn/device-dev/api/toctopics/_input.md new file mode 100644 index 0000000000..c2356b8942 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_input.md @@ -0,0 +1,462 @@ +# Input + +## **汇总** + +## 文件 + + + + + + + + + + + + + + + + + + + +

文件

+

描述

+

input_controller.h

+

描述input设备业务控制相关的接口声明。

+

input_manager.h

+

描述input设备管理相关的接口声明。

+

input_reporter.h

+

描述input设备数据上报相关的接口声明。

+

input_type.h

+

input设备相关的类型定义，定义了input设备驱动接口所使用的结构体及枚举类型。

+
+ +## 类 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

类

+

描述

+

InputController

+

提供input设备业务控制相关的接口。 更多...

+

InputManager

+

提供input设备管理相关的接口。 更多...

+

IInputInterface

+

定义用于提供输入设备驱动能力的接口。更多...

+

InputReporter

+

提供input设备数据上报相关的接口。 更多...

+

EventPackage

+

input事件数据包结构 更多...

+

InputReportEventCb

+

此结构体定义了输入事件回调函数并提供给input服务使用 更多...

+

DeviceInfo

+

input设备基础设备信息 更多...

+

InputExtraCmd

+

扩展指令的数据结构 更多...

+
+ +## 宏定义 + + + + + + + + + + + + + + + + + + + + + + + + + +

宏定义

+

描述

+

MAX_INPUT_DEV_NUM 32

+

Input设备最大数量。

+

MAX_NODE_PATH_LEN 64

+

节点路径最大长度。

+

CHIP_INFO_LEN 10

+

芯片信息长度。

+

CHIP_NAME_LEN 10

+

芯片名称长度。

+

VENDOR_NAME_LEN 10

+

厂商名称长度。

+

SELF_TEST_RESULT_LEN 20

+

自测结果长度。

+
+ +## 枚举 + + + + + + + + + + + + + + + + + + + +

枚举

+

描述

+

RetStatus { INPUT_SUCCESS = 0, INPUT_FAILURE = -1, INPUT_INVALID_PARAM = -2, INPUT_NOMEM = -3, INPUT_NULL_PTR = -4, INPUT_TIMEOUT = -5, INPUT_UNSUPPORTED = -6 }

+

定义返回值类型 更多...

+

InputDevType { INDEV_TYPE_TOUCH, INDEV_TYPE_KEY, INDEV_TYPE_KEYBOARD, INDEV_TYPE_MOUSE, INDEV_TYPE_BUTTON, INDEV_TYPE_CROWN, INDEV_TYPE_ENCODER, INDEV_TYPE_UNKNOWN }

+

定义input设备类型 更多...

+

PowerStatus { INPUT_RESUME, INPUT_SUSPEND, INPUT_LOW_POWER, INPUT_POWER_STATUS_UNKNOWN }

+

定义电源状态 更多...

+

CapacitanceTest { BASE_TEST, FULL_TEST, MMI_TEST, RUNNING_TEST, TEST_TYPE_UNKNOWN }

+

定义容值测试类型 更多...

+
+ +## 函数 + + + + + + + + + + +

函数

+

描述

+

GetInputInterface (IInputInterface **interface)

+

input服务通过调用此接口获取操作input设备的所有接口。 更多...

+
+ +## **详细描述** + +Input模块驱动接口声明。 + +本模块为Input服务提供相关驱动接口，包括input设备的打开和关闭、input事件获取、设备信息查询、回调函数注册、特性状态控制等接口。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## **枚举类型说明** + +## CapacitanceTest + +``` +enum CapacitanceTest +``` + +**描述：** + +定义容值测试类型 + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

BASE_TEST

+

基础容值测试

+

+

FULL_TEST

+

全量容值自检测试

+

+

MMI_TEST

+

MMI容值测试

+

+

RUNNING_TEST

+

老化容值测试

+

+

TEST_TYPE_UNKNOWN

+

未知的测试类型

+

+
+ +## InputDevType + +``` +enum InputDevType +``` + +**描述：** + +定义input设备类型 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

INDEV_TYPE_TOUCH

+

触摸屏。

+

+

INDEV_TYPE_KEY

+

物理按键。

+

+

INDEV_TYPE_KEYBOARD

+

键盘。

+

+

INDEV_TYPE_MOUSE

+

鼠标。

+

+

INDEV_TYPE_BUTTON

+

虚拟按键。

+

+

INDEV_TYPE_CROWN

+

表冠。

+

+

INDEV_TYPE_ENCODER

+

自定义编码的特定功能或者事件。

+

+

INDEV_TYPE_UNKNOWN

+

未知输入设备类型。

+

+
+ +## PowerStatus + +``` +enum PowerStatus +``` + +**描述：** + +定义电源状态 + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

INPUT_RESUME

+

正常唤醒。

+

+

INPUT_SUSPEND

+

休眠下电模式。

+

+

INPUT_LOW_POWER

+

休眠低功耗模式。

+

+

INPUT_POWER_STATUS_UNKNOWN

+

未知电源状态。

+

+
+ +## RetStatus + +``` +enum RetStatus +``` + +**描述：** + +定义返回值类型 + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

INPUT_SUCCESS

+

成功。

+

+

INPUT_FAILURE

+

失败。

+

+

INPUT_INVALID_PARAM

+

无效参数。

+

+

INPUT_NOMEM

+

内存不足。

+

+

INPUT_NULL_PTR

+

空指针。

+

+

INPUT_TIMEOUT

+

执行超时。

+

+

INPUT_UNSUPPORTED

+

特性不支持。

+

+
+ +## **函数说明** + +## GetInputInterface\(\) + +``` +int32_t GetInputInterface (IInputInterface ** interface) +``` + +**描述：** + +input服务通过调用此接口获取操作input设备的所有接口。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

interface

+

对input设备进行接口操作的指针，通常在input服务启动后，通过调用此函数获取input设备操作接口

+
+ +**返回：** + +Returns INPUT\_SUCCESS 表示执行成功。 + +Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 + +**Since：** + +1.0 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/_input_controller.md b/zh-cn/device-dev/api/toctopics/_input_controller.md new file mode 100644 index 0000000000..eafe35650f --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_input_controller.md @@ -0,0 +1,452 @@ +# InputController + +## **概述** + +**所属模块:** + +[Input](_input.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

( SetPowerStatus )(uint32_t devIndex, uint32_t status)

+

设置电源状态 更多...

+

( GetPowerStatus )(uint32_t devIndex, uint32_t *status)

+

获取电源状态 更多...

+

( GetDeviceType )(uint32_t devIndex, uint32_t *deviceType)

+

获取devIndex对应的input设备的类型 更多...

+

( GetChipInfo )(uint32_t devIndex, char *chipInfo, uint32_t length)

+

获取器件对应的编码信息 更多...

+

( GetVendorName )(uint32_t devIndex, char *vendorName, uint32_t length)

+

获取devIndex对应的模组厂商名 更多...

+

( GetChipName )(uint32_t devIndex, char *chipName, uint32_t length)

+

获取devIndex对应的驱动芯片名 更多...

+

( SetGestureMode )(uint32_t devIndex, uint32_t gestureMode)

+

设置手势模式 更多...

+

( RunCapacitanceTest )(uint32_t devIndex, uint32_t testType, char *result, uint32_t length)

+

执行容值自检测试 更多...

+

( RunExtraCommand )(uint32_t devIndex, InputExtraCmd *cmd)

+

执行拓展指令 更多...

+
+ +## **详细描述** + +提供input设备业务控制相关的接口。 + +此类接口包含电源状态的设置、特性的使能、器件信息的获取，以及产线相关的测试功能接口。 + +## **类成员变量说明** + +## GetChipInfo + +``` +int32_t(* InputController::GetChipInfo) (uint32_t devIndex, char *chipInfo, uint32_t length) +``` + +**描述：** + +获取器件对应的编码信息 + +一款产品通常会有多家模组和Driver IC，上层应用如果关注具体器件型号，则通过此接口来获取。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devIndex

+

Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。

+

chipInfo

+

获取的对应设备索引的器件编码信息。

+

length

+

保存器件芯片信息的内存长度。

+
+ +**返回：** + +Returns INPUT\_SUCCESS 表示执行成功。 + +Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 + +## GetChipName + +``` +int32_t(* InputController::GetChipName) (uint32_t devIndex, char *chipName, uint32_t length) +``` + +**描述：** + +获取devIndex对应的驱动芯片名 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devIndex

+

Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。

+

chipName

+

获取的对应设备索引的驱动芯片名。

+

length

+

保存驱动芯片名的内存长度。

+
+ +**返回：** + +Returns INPUT\_SUCCESS 表示执行成功。 + +Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 + +## GetDeviceType + +``` +int32_t(* InputController::GetDeviceType) (uint32_t devIndex, uint32_t *deviceType) +``` + +**描述：** + +获取devIndex对应的input设备的类型 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

devIndex

+

Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。

+

deviceType

+

获取的对应设备索引的设备类型，具体参考 InputDevType。

+
+ +**返回：** + +Returns INPUT\_SUCCESS 表示执行成功。 + +Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 + +## GetPowerStatus + +``` +int32_t(* InputController::GetPowerStatus) (uint32_t devIndex, uint32_t *status) +``` + +**描述：** + +获取电源状态 + +在系统休眠或者唤醒时，input服务或电源管理模块获取电源状态，以便驱动IC能正常进入对应的休眠模式。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

devIndex

+

Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。

+

status

+

获取的对应设备索引的电源状态，具体参考PowerStatus。

+
+ +**返回：** + +Returns INPUT\_SUCCESS 表示执行成功。 + +Returns 其他值表示执行失败，具体错误码查看**RetSatus。** + +## GetVendorName + +``` +int32_t(* InputController::GetVendorName) (uint32_t devIndex, char *vendorName, uint32_t length) +``` + +**描述：** + +获取devIndex对应的模组厂商名 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devIndex

+

Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。

+

vendorName

+

获取的对应设备索引的模组厂商名。

+

length

+

保存模组厂商名的内存长度。

+
+ +**返回：** + +Returns INPUT\_SUCCESS 表示执行成功。 + +Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 + +## RunCapacitanceTest + +``` +int32_t(* InputController::RunCapacitanceTest) (uint32_t devIndex, uint32_t testType, char *result, uint32_t length) +``` + +**描述：** + +执行容值自检测试 + +启动不同检测场景下的容值自检测试，并获取测试结果，容值自检项由器件厂商自定义， 一般包括RawData测试、 \* 短路检测、开路检测、干扰检测、行列差检测等测试项。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

devIndex

+

Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。

+

testType

+

容值测试的测试类型，具体参考CapacitanceTest。

+

result

+

容值测试的结果，成功则输出“SUCCESS”，失败则返回对应的错误提示 。

+

length

+

保存容值测试结果的内存长度。

+
+ +**返回：** + +Returns INPUT\_SUCCESS 表示执行成功。 + +Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 + +## RunExtraCommand + +``` +int32_t(* InputController::RunExtraCommand) (uint32_t devIndex, InputExtraCmd *cmd) +``` + +**描述：** + +执行拓展指令 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

devIndex

+

Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。

+

cmd

+

拓展指令数据包，包括指令编码及参数，具体参考InputExtraCmd。

+
+ +**返回：** + +Returns INPUT\_SUCCESS 表示执行成功。 + +Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 + +## SetGestureMode + +``` +int32_t(* InputController::SetGestureMode) (uint32_t devIndex, uint32_t gestureMode) +``` + +**描述：** + +设置手势模式 + +上层应用开关手势模式，即设置手势模式的对应使能bit + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

devIndex

+

Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。

+

gestureMode

+

手势模式的开关状态

+
+ +**返回：** + +Returns INPUT\_SUCCESS 表示执行成功。 + +Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 + +## SetPowerStatus + +``` +int32_t(* InputController::SetPowerStatus) (uint32_t devIndex, uint32_t status) +``` + +**描述：** + +设置电源状态 + +在系统休眠或者唤醒时，input服务或电源管理模块设置电源状态，以使驱动IC能正常进入对应的休眠模式。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

devIndex

+

Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。

+

status

+

设置的电源状态，input服务控制input设备进入resume或者suspend等状态PowerStatus。

+
+ +**返回：** + +Returns INPUT\_SUCCESS 表示执行成功。 + +Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 + diff --git a/zh-cn/device-dev/api/toctopics/_input_extra_cmd.md b/zh-cn/device-dev/api/toctopics/_input_extra_cmd.md new file mode 100644 index 0000000000..50f82cf171 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_input_extra_cmd.md @@ -0,0 +1,58 @@ +# InputExtraCmd + +## **概述** + +**所属模块:** + +[Input](_input.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + +

Public 属性

+

描述

+

cmdCode

+

指令对应的编码。

+

cmdValue

+

指令传输的数据。

+
+ +## **详细描述** + +扩展指令的数据结构。 + +## **类成员变量说明** + +## cmdCode + +``` +const char* InputExtraCmd::cmdCode +``` + +**描述：** + +指令对应的编码 + +## cmdValue + +``` +const char* InputExtraCmd::cmdValue +``` + +**描述：** + +指令传输的数据 + diff --git a/zh-cn/device-dev/api/toctopics/_input_manager.md b/zh-cn/device-dev/api/toctopics/_input_manager.md new file mode 100644 index 0000000000..21d9bce707 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_input_manager.md @@ -0,0 +1,240 @@ +# InputManager + +## **概述** + +**所属模块:** + +[Input](_input.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

( ScanInputDevice )(DevDesc *staArr, uint32_t arrLen)

+

input服务用于扫描所有在线设备。 更多...

+

( OpenInputDevice )(uint32_t devIndex)

+

input服务打开对应设备的设备文件 更多...

+

( CloseInputDevice )(uint32_t devIndex)

+

input服务关闭对应设备的设备文件 更多...

+

( GetInputDevice )(uint32_t devIndex, DeviceInfo **devInfo)

+

input服务获取对应ID的设备信息 更多...

+

( GetInputDeviceList )(uint32_t *devNum, DeviceInfo **devList, uint32_t size)

+

input服务获取所有input设备列表的设备信息 更多...

+
+ +## **详细描述** + +提供input设备管理相关的接口。 + +此类接口包含input设备的扫描、打开和关闭、特定设备信息查询，以及所有设备列表信息获取等接口。 + +## **类成员变量说明** + +## CloseInputDevice + +``` +int32_t(* InputManager::CloseInputDevice) (uint32_t devIndex) +``` + +**描述：** + +input服务关闭对应设备的设备文件 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

devIndex

+

Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备

+
+ +**返回：** + +Returns INPUT\_SUCCESS 表示执行成功。 + +Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 + +## GetInputDevice + +``` +int32_t(* InputManager::GetInputDevice) (uint32_t devIndex, DeviceInfo **devInfo) +``` + +**描述：** + +input服务获取对应ID的设备信息。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

devIndex

+

Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。

+

devInfo

+

即devIndex对应设备的设备信息，具体参考DeviceInfo。

+
+ +**返回：** + +Returns INPUT\_SUCCESS 表示执行成功。 + +Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 + +## GetInputDeviceList + +``` +int32_t(* InputManager::GetInputDeviceList) (uint32_t *devNum, DeviceInfo **devList, uint32_t size) +``` + +**描述：** + +input服务获取所有input设备列表的设备信息。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devNum

+

当前已经注册过的所有input设备的总数。

+

devInfo

+

input设备列表所对应的设备信息，具体参考DeviceInfo。

+

size

+

即指定deviceList数组对应的元素个数。

+
+ +返回： + +Returns INPUT\_SUCCESS 表示执行成功。 + +Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 + +## OpenInputDevice + +``` +int32_t(* InputManager::OpenInputDevice) (uint32_t devIndex) +``` + +**描述：** + +input服务打开对应设备的设备文件 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

devIndex

+

Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。

+
+ +**返回：** + +Returns INPUT\_SUCCESS 表示执行成功。 + +Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 + +## ScanInputDevice + +``` +int32_t(* InputManager::ScanInputDevice) (DevDesc *staArr, uint32_t arrLen) +``` + +**描述：** + +input服务用于扫描所有在线设备。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

staArr

+

存放Input设备扫描信息的数组，信息包含设备索引以及设备类型。

+

arrLen

+

staArr数组的长度信息。

+
+ +**返回：** + +Returns INPUT\_SUCCESS 表示执行成功。 + +Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 + diff --git a/zh-cn/device-dev/api/toctopics/_input_report_event_cb.md b/zh-cn/device-dev/api/toctopics/_input_report_event_cb.md new file mode 100644 index 0000000000..ce5da83118 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_input_report_event_cb.md @@ -0,0 +1,102 @@ +# InputReportEventCb + +## **概述** + +**所属模块:** + +[Input](_input.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + +

Public 属性

+

描述

+

( ReportEventPkgCallback )(const EventPackage **pkgs, uint32_t count, uint32_t devIndex)

+

输入事件数据上报的回调函数 更多...

+

( ReportHotPlugEventCallback )(const HotPlugEvent *event)

+

热插拔事件上报的回调函数 更多...

+
+ +## **详细描述** + +此结构体定义了输入事件回调函数并提供给input服务使用。 + +## **类成员变量说明** + +## ReportEventPkgCallback + +``` +void(* InputReportEventCb::ReportEventPkgCallback) (const EventPackage **pkgs, uint32_t count, uint32_t devIndex) +``` + +**描述：** + +输入事件数据上报的回调函数 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

eventData

+

驱动上报的input事件数据。

+

count

+

Input事件数据包的个数。

+

devIndex

+

Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。

+
+ +## ReportHotPlugEventCallback + +``` +void(* InputReportEventCb::ReportHotPlugEventCallback) (const HotPlugEvent *event) +``` + +**描述：** + +热插拔事件上报的回调函数 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

event

+

上报的热插拔事件数据

+
+ diff --git a/zh-cn/device-dev/api/toctopics/_input_reporter.md b/zh-cn/device-dev/api/toctopics/_input_reporter.md new file mode 100644 index 0000000000..afe71a5e50 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_input_reporter.md @@ -0,0 +1,191 @@ +# InputReporter + +## **概述** + +**所属模块:** + +[Input](_input.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

( RegisterReportCallback )(uint32_t devIndex, InputReportEventCb *callback)

+

注册对应设备的回调函数 更多...

+

( UnregisterReportCallback )(uint32_t devIndex)

+

注销对应设备的回调函数 更多...

+

( RegisterHotPlugCallback )(InputReportEventCb *callback)

+

注册Input设备的热插拔回调函数 更多...

+

( UnregisterHotPlugCallback )(void)

+

注销Input设备的热插拔回调函数 更多...

+
+ +## **详细描述** + +提供input设备数据上报相关的接口。 + +此类接口包含input设备的数据上报回调函数的注册和注销。 + +## **类成员变量说明** + +## RegisterHotPlugCallback + +``` +int32_t(* InputReporter::RegisterHotPlugCallback) (InputReportEventCb *callback) +``` + +**描述：** + +注册Input设备的热插拔回调函数 + +input服务通过此接口注册回调函数到hdi中，所有Input设备由此函数进行热插拔事件上报 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

callback

+

回调函数的函数指针

+
+ +**返回：** + +Returns INPUT\_SUCCESS 表示执行成功。 + +Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 + +## RegisterReportCallback + +``` +int32_t(* InputReporter::RegisterReportCallback) (uint32_t devIndex, InputReportEventCb *callback) +``` + +**描述：** + +注册对应设备的回调函数 + +input服务通过此接口注册数据回调函数到hdi中，hdi通过此回调函数上报input事件 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

devIndex

+

Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备

+

callback

+

回调函数的函数指针

+
+ +**返回：** + +Returns INPUT\_SUCCESS 表示执行成功。 + +Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 + +## UnregisterHotPlugCallback + +``` +int32_t(* InputReporter::UnregisterHotPlugCallback) (void) +``` + +**描述：** + +注销Input设备的热插拔回调函数 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

无

+

-

+
+ +**返回：** + +Returns INPUT\_SUCCESS 表示执行成功。 + +Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 + +## UnregisterReportCallback + +``` +int32_t(* InputReporter::UnregisterReportCallback) (uint32_t devIndex) +``` + +**描述：** + +注销对应设备的回调函数 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

devIndex

+

Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备

+
+ +**返回：** + +Returns INPUT\_SUCCESS 表示执行成功。 + +Returns 其他值表示执行失败，具体错误码查看**RetSatus**。 + diff --git a/zh-cn/device-dev/api/toctopics/_layer_alpha.md b/zh-cn/device-dev/api/toctopics/_layer_alpha.md new file mode 100644 index 0000000000..a6c17979ca --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_layer_alpha.md @@ -0,0 +1,51 @@ +# LayerAlpha + +## **概述** + +**所属模块:** + +[Display](_display.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

enGlobalAlpha

+

全局alpha使能标志

+

enPixelAlpha

+

像素alpha使能标志

+

alpha0

+

alpha0值，取值范围：[0, 255]

+

alpha1

+

alpha1值，取值范围：[0, 255]

+

gAlpha

+

全局alpha值，取值范围：[0, 255]

+
+ +## **详细描述** + +定义图层Alpha信息的结构体。 + diff --git a/zh-cn/device-dev/api/toctopics/_layer_buffer.md b/zh-cn/device-dev/api/toctopics/_layer_buffer.md new file mode 100644 index 0000000000..adc0ef9669 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_layer_buffer.md @@ -0,0 +1,61 @@ +# LayerBuffer + +## **概述** + +**所属模块:** + +[Display](_display.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

fenceId

+

buffer的fence号

+

width

+

buffer宽度

+

height

+

buffer高度

+

pitch

+

一行数据所占字节数

+

pixFormat

+

图层像素格式

+

data

+

图层buffer数据

+

hdl

+

图层buffer句柄

+
+ +## **详细描述** + +图层Buffer，用于存放图层数据。 + diff --git a/zh-cn/device-dev/api/toctopics/_layer_funcs.md b/zh-cn/device-dev/api/toctopics/_layer_funcs.md new file mode 100644 index 0000000000..7793c571eb --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_layer_funcs.md @@ -0,0 +1,2160 @@ +# LayerFuncs + +## **概述** + +**所属模块:** + +[Display](_display.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

( InitDisplay )(uint32_t devId)

+

初始化显示设备。 更多...

+

( DeinitDisplay )(uint32_t devId)

+

取消初始化显示设备。 更多...

+

( GetDisplayInfo )(uint32_t devId, DisplayInfo *dispInfo)

+

获取显示设备相关信息。 更多...

+

( CreateLayer )(uint32_t devId, const LayerInfo *layerInfo, uint32_t *layerId)

+

打开图层。 更多...

+

( CloseLayer )(uint32_t devId, uint32_t layerId)

+

关闭图层。 更多...

+

( SetLayerVisible )(uint32_t devId, uint32_t layerId, bool visible)

+

设置图层是否可见。 更多...

+

( GetLayerVisibleState )(uint32_t devId, uint32_t layerId, bool *visible)

+

获取图层是否可见状态。 更多...

+

( SetLayerSize )(uint32_t devId, uint32_t layerId, IRect *rect)

+

设置图层大小。 更多...

+

( GetLayerSize )(uint32_t devId, uint32_t layerId, IRect *rect)

+

获取图层大小。 更多...

+

( SetLayerCrop )(uint32_t devId, uint32_t layerId, IRect *rect)

+

设置图层裁剪区域。 更多...

+

( SetLayerZorder )(uint32_t devId, uint32_t layerId, uint32_t zorder)

+

设置图层Z轴次序。 更多...

+

( GetLayerZorder )(uint32_t devId, uint32_t layerId, uint32_t *zorder)

+

获取图层Z轴次序。 更多...

+

( SetLayerPreMulti )(uint32_t devId, uint32_t layerId, bool preMul)

+

设置图层预乘。 更多...

+

( GetLayerPreMulti )(uint32_t devId, uint32_t layerId, bool *preMul)

+

获取图层预乘标识。 更多...

+

( SetLayerAlpha )(uint32_t devId, uint32_t layerId, LayerAlpha *alpha)

+

设置图层alpha值。 更多...

+

( GetLayerAlpha )(uint32_t devId, uint32_t layerId, LayerAlpha *alpha)

+

获取图层alpha值。 更多...

+

( SetLayerColorKey )(uint32_t devId, uint32_t layerId, bool enable, uint32_t key)

+

设置图层colorkey属性,在图层叠加时使用。 更多...

+

( GetLayerColorKey )(uint32_t devId, uint32_t layerId, bool *enable, uint32_t *key)

+

获取图层colorkey。 更多...

+

( SetLayerPalette )(uint32_t devId, uint32_t layerId, uint32_t *palette, uint32_t len)

+

设置图层调色板。 更多...

+

( GetLayerPalette )(uint32_t devId, uint32_t layerId, uint32_t *palette, uint32_t len)

+

获取图层调色板。 更多...

+

( SetTransformMode )(uint32_t devId, uint32_t layerId, TransformType type)

+

设置图层变换模式，根据不同的场景设置图层的旋转、缩放、移位等。 更多...

+

( SetLayerCompression )(uint32_t devId, uint32_t layerId, int32_t compType)

+

设置图层压缩功能 更多...

+

( GetLayerCompression )(uint32_t devId, uint32_t layerId, int32_t *compType)

+

获取图层压缩功能是否打开。 更多...

+

( SetLayerDirtyRegion )(uint32_t devId, uint32_t layerId, IRect *region)

+

设置图层刷新区域。 更多...

+

( GetLayerBuffer )(uint32_t devId, uint32_t layerId, LayerBuffer *buffer)

+

获取图层的buffer。 更多...

+

( Flush )(uint32_t devId, uint32_t layerId, LayerBuffer *buffer)

+

刷新图层。 更多...

+

( WaitForVBlank )(uint32_t devId, uint32_t layerId, int32_t timeOut)

+

实现等待帧消隐期到来功能。 更多...

+

( SnapShot )(uint32_t devId, LayerBuffer *buffer)

+

实现抓图功能。 更多...

+

( SetLayerVisibleRegion )(uint32_t devId, uint32_t layerId, uint32_t num, IRect *rect)

+

设置一个图层的可见区域 更多...

+

( SetLayerBuffer )(uint32_t devId, uint32_t layerId, const BufferHandle *buffer, int32_t fence)

+

设置一个层的缓冲区。 更多...

+

( InvokeLayerCmd )(uint32_t devId, uint32_t layerId, uint32_t cmd,...)

+

扩展接口 更多...

+

( SetLayerCompositionType )(uint32_t devId, uint32_t layerId, CompositionType type)

+

设置客户端期望的组合类型 更多...

+

( SetLayerBlendType )(uint32_t devId, uint32_t layerId, BlendType type)

+

设置混合类型 更多...

+

( SetLayerColorTransform )(uint32_t devId, uint32_t layerId, const float *matrix)

+

设置图层当前的颜色转换矩阵。 更多...

+

( SetLayerColorDataSpace )(uint32_t devId, uint32_t layerId, ColorDataSpace colorSpace)

+

设置图层的颜色数据空间。 更多...

+

( GetLayerColorDataSpace )(uint32_t devId, uint32_t layerId, ColorDataSpace *colorSpace)

+

获取图层当前的颜色数据空间。 更多...

+

( SetLayerMetaData )(uint32_t devId, uint32_t layerId, uint32_t num, const HDRMetaData *metaData)

+

设置图层的HDRmetaData。 更多...

+

( SetLayerMetaDataSet )(uint32_t devId, uint32_t layerId, HDRMetadataKey key, uint32_t num, const uint8_t *metaData)

+

设置图层的metaData set。 更多...

+

( GetSupportedPresentTimestamp )(uint32_t devId, uint32_t layerId, PresentTimestampType *type)

+

获取图层支持的上屏时间戳类型。 更多...

+

( GetHwPresentTimestamp )(uint32_t devId, uint32_t layerId, PresentTimestamp *pts)

+

获取图层的上屏时间戳信息。 更多...

+

( SetLayerTunnelHandle )(uint32_t devId, uint32_t layerId, ExtDataHandle *handle)

+

设置图层的tunnel句柄。 更多...

+

( GetLayerReleaseFence )(uint32_t devId, uint32_t layerId, int32_t *fence)

+

获取图层的同步栅栏。 更多...

+
+ +## **详细描述** + +显示图层驱动接口结构体，定义显示图层驱动接口函数指针。 + +## **类成员变量说明** + +## CloseLayer + +``` +int32_t(* LayerFuncs::CloseLayer) (uint32_t devId, uint32_t layerId) +``` + +**描述：** + +关闭图层。 + +在完成显示后，如果不在需要使用图层，调用关闭图层接口关闭图层。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备ID，用于支持多个显示设备，取值从0开始，0表示第一个设备，最大支持5个设备。

+

layerId

+

输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +**参见：** + +**OpenLayer** + +## CreateLayer + +``` +int32_t(* LayerFuncs::CreateLayer) (uint32_t devId, const LayerInfo *layerInfo, uint32_t *layerId) +``` + +**描述：** + +打开图层。 + +GUI在使用图层时，需要先根据图层信息打开图层，打开图层成功可获得图层ID，根据图层ID使用图层各接口。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备ID，用于支持多个显示设备，取值从0开始，0表示第一个设备，最大支持5个设备。

+

layerInfo

+

输入参数，图层信息，上层GUI打开图层时需传递图层信息，包括图层类型，图层大小，像素格式等信息。

+

layerId

+

输入参数，图层ID，打开图层成功后返回给GUI的图层ID，用于标识唯一的图层。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +**参见：** + +[CloseLayer](_layer_funcs.md#a2e375f75209da329f131b914377e9616) + +## DeinitDisplay + +``` +int32_t(* LayerFuncs::DeinitDisplay) (uint32_t devId) +``` + +**描述：** + +取消初始化显示设备。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备ID，用于支持多个显示设备，取值从0开始，0表示第一个设备，最大支持5个设备。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +**参见：** + +[InitDisplay](_layer_funcs.md#a0641c3b48542646daa80386122bed46a) + +## Flush + +``` +int32_t(* LayerFuncs::Flush) (uint32_t devId, uint32_t layerId, LayerBuffer *buffer) +``` + +**描述：** + +刷新图层。 + +将buffer显示数据刷新到指定的layerId图层上，实现图像数据显示到屏幕上。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备ID，用于支持多个显示设备，取值从0开始，0表示第一个设备，最大支持5个设备。

+

layerId

+

输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。

+

buffer

+

输出参数，待刷新的buffer。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## GetDisplayInfo + +``` +int32_t(* LayerFuncs::GetDisplayInfo) (uint32_t devId, DisplayInfo *dispInfo) +``` + +**描述：** + +获取显示设备相关信息。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备ID，用于支持多个显示设备，取值从0开始，0表示第一个设备，最大支持5个设备。

+

dispInfo

+

输出参数，显示相关信息。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## GetHwPresentTimestamp + +``` +int32_t(* LayerFuncs::GetHwPresentTimestamp) (uint32_t devId, uint32_t layerId, PresentTimestamp *pts) +``` + +**描述：** + +获取图层的上屏时间戳信息。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

layerId

+

输入参数，指示需要操作的图层ID。

+

pts

+

输出参数，保存图层的上屏时间戳信息, 由接口实现层进行写入。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## GetLayerAlpha + +``` +int32_t(* LayerFuncs::GetLayerAlpha) (uint32_t devId, uint32_t layerId, LayerAlpha *alpha) +``` + +**描述：** + +获取图层alpha值。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备ID，用于支持多个显示设备，取值从0开始，0表示第一个设备，最大支持5个设备。

+

layerId

+

输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。

+

alpha

+

输出参数，保存获取的图层alpha值。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +**参见：** + +[SetLayerAlpha](_layer_funcs.md#abb9bea9f251316f7c2bea697de55a139) + +## GetLayerBuffer + +``` +int32_t(* LayerFuncs::GetLayerBuffer) (uint32_t devId, uint32_t layerId, LayerBuffer *buffer) +``` + +**描述：** + +获取图层的buffer。 + +向buffer中绘图后，调用Flush接口显示到屏幕上。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备ID，用于支持多个显示设备，取值从0开始，0表示第一个设备，最大支持5个设备。

+

layerId

+

输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。

+

buffer

+

输出参数，保存获取的图层buffer。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +**参见：** + +[Flush](_layer_funcs.md#abb480bf2b85e93841c49fdc9800bd1e7) + +## GetLayerColorDataSpace + +``` +int32_t(* LayerFuncs::GetLayerColorDataSpace) (uint32_t devId, uint32_t layerId, ColorDataSpace *colorSpace) +``` + +**描述：** + +获取图层当前的颜色数据空间。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

layerId

+

输入参数，指示需要操作的图层ID。

+

colorSpace

+

输出参数，保存对应图层的颜色数据空间。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## GetLayerColorKey + +``` +int32_t(* LayerFuncs::GetLayerColorKey) (uint32_t devId, uint32_t layerId, bool *enable, uint32_t *key) +``` + +**描述：** + +获取图层colorkey。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备ID，用于支持多个显示设备，取值从0开始，0表示第一个设备，最大支持5个设备。

+

layerId

+

输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。

+

enable

+

输出参数，保存获取的enable色键使能标识。

+

key

+

输出参数，保存获取的色键值，即颜色值。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +**参见：** + +[SetLayerColorKey](_layer_funcs.md#a5701fe1e0e2414de577aa5329bd873c9) + +## GetLayerCompression + +``` +int32_t(* LayerFuncs::GetLayerCompression) (uint32_t devId, uint32_t layerId, int32_t *compType) +``` + +**描述：** + +获取图层压缩功能是否打开。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备ID，用于支持多个显示设备，取值从0开始，0表示第一个设备，最大支持5个设备。

+

layerId

+

输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。

+

compType

+

输出参数，保存获取的图层压缩功能状态。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +**参见：** + +[SetLayerCompression](_layer_funcs.md#a46c9750d8615dc874b66ac4b10796b24) + +## GetLayerPalette + +``` +int32_t(* LayerFuncs::GetLayerPalette) (uint32_t devId, uint32_t layerId, uint32_t *palette, uint32_t len) +``` + +**描述：** + +获取图层调色板。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备ID，用于支持多个显示设备，取值从0开始，0表示第一个设备，最大支持5个设备。

+

layerId

+

输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。

+

palette

+

输出参数，保存获取的图层调色板。

+

len

+

输入参数，调色板长度。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +**参见：** + +[SetLayerPalette](_layer_funcs.md#a3982c76e093852ef386fc372581be4af) + +## GetLayerPreMulti + +``` +int32_t(* LayerFuncs::GetLayerPreMulti) (uint32_t devId, uint32_t layerId, bool *preMul) +``` + +**描述：** + +获取图层预乘标识。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备ID，用于支持多个显示设备，取值从0开始，0表示第一个设备，最大支持5个设备。

+

layerId

+

输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。

+

preMul

+

输出参数，保存获取的图层预乘使能标识。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +**参见：** + +[SetLayerPreMulti](_layer_funcs.md#a456aa01ca3ffa81d2e49c0a9487f816f) + +## GetLayerReleaseFence + +``` +int32_t(* LayerFuncs::GetLayerReleaseFence) (uint32_t devId, uint32_t layerId, int32_t *fence) +``` + +**描述：** + +获取图层的同步栅栏。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

layerId

+

输入参数，指示需要操作的图层ID。

+

fence

+

输出参数，保存图层的 release fence, 由接口实现层进行写入。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## GetLayerSize + +``` +int32_t(* LayerFuncs::GetLayerSize) (uint32_t devId, uint32_t layerId, IRect *rect) +``` + +**描述：** + +获取图层大小。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备ID，用于支持多个显示设备，取值从0开始，0表示第一个设备，最大支持5个设备。

+

layerId

+

输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。

+

rect

+

输出参数，保存获取的图层大小。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +**参见：** + +[SetLayerSize](_layer_funcs.md#ab58e66b0676b1baa1662c175d43bf219) + +## GetLayerVisibleState + +``` +int32_t(* LayerFuncs::GetLayerVisibleState) (uint32_t devId, uint32_t layerId, bool *visible) +``` + +**描述：** + +获取图层是否可见状态。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备ID，用于支持多个显示设备，取值从0开始，0表示第一个设备，最大支持5个设备。

+

layerId

+

输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。

+

visible

+

输出参数，保存获取的图层可见状态，true表示图层可见，false表示图层不可见。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +**参见：** + +[SetLayerVisible](_layer_funcs.md#aaa5bf7f98e8dc47510a4f26fb38094b6) + +## GetLayerZorder + +``` +int32_t(* LayerFuncs::GetLayerZorder) (uint32_t devId, uint32_t layerId, uint32_t *zorder) +``` + +**描述：** + +获取图层Z轴次序。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备ID，用于支持多个显示设备，取值从0开始，0表示第一个设备，最大支持5个设备。

+

layerId

+

输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。

+

zorder

+

输出参数，保存获取的图层Z轴次序，为整数值，取值范围为[0, 255]，值越大图层越往上排列。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +**参见：** + +[SetLayerZorder](_layer_funcs.md#aa3803c2a6395651d1538ffb62d29733d) + +## GetSupportedPresentTimestamp + +``` +int32_t(* LayerFuncs::GetSupportedPresentTimestamp) (uint32_t devId, uint32_t layerId, PresentTimestampType *type) +``` + +**描述：** + +获取图层支持的上屏时间戳类型。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

layerId

+

输入参数，指示需要操作的图层ID。

+

type

+

输出参数，保存图层支持的上屏时间戳类型, 由接口实现层进行写入。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## InitDisplay + +``` +int32_t(* LayerFuncs::InitDisplay) (uint32_t devId) +``` + +**描述：** + +初始化显示设备。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备ID，用于支持多个显示设备，取值从0开始，0表示第一个设备，最大支持5个设备。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +**参见：** + +[DeinitDisplay](_layer_funcs.md#a8d7a715d7d2b4bd5ab0db92c2a1eec93) + +## InvokeLayerCmd + +``` +int32_t(* LayerFuncs::InvokeLayerCmd) (uint32_t devId, uint32_t layerId, uint32_t cmd,...) +``` + +**描述：** + +扩展接口 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备的ID。取值范围为0 ~ 4，其中0表示第一个显示设备，4表示最后一个显示设备。

+

layerId

+

输入参数，层ID，唯一标识一个层。可以对该层进行操作。

+

cmd

+

输入参数，表示扩展cmd，用于识别不同的意图。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## SetLayerAlpha + +``` +int32_t(* LayerFuncs::SetLayerAlpha) (uint32_t devId, uint32_t layerId, LayerAlpha *alpha) +``` + +**描述：** + +设置图层alpha值。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备ID，用于支持多个显示设备，取值从0开始，0表示第一个设备，最大支持5个设备。

+

layerId

+

输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。

+

alpha

+

输入参数，待设置的图层 alpha 值。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +**参见：** + +[GetLayerAlpha](_layer_funcs.md#acf1e01338eeb0fd957f53ed0d2551394) + +## SetLayerBlendType + +``` +int32_t(* LayerFuncs::SetLayerBlendType) (uint32_t devId, uint32_t layerId, BlendType type) +``` + +**描述：** + +设置混合类型 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备的ID。取值范围为0 ~ 4，其中0表示第一个显示设备，4表示最后一个显示设备。

+

layerId

+

输入参数，层ID，唯一标识一个层。可以对该层进行操作。

+

type

+

输入参数，指示混合类型。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## SetLayerBuffer + +``` +int32_t(* LayerFuncs::SetLayerBuffer) (uint32_t devId, uint32_t layerId, const BufferHandle *buffer, int32_t fence) +``` + +**描述：** + +设置一个层的缓冲区。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备的ID。取值范围为0 ~ 4，其中0表示第一个显示设备，4表示最后一个显示设备。

+

layerId

+

输入参数，层ID，唯一标识一个层。可以对该层进行操作。

+

buffer

+

输入参数，指示缓冲区句柄的指针，该指针包含所有用于合成的缓冲区的所有信息。

+

fence

+

输入参数，同步文件的fd。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## SetLayerColorDataSpace + +``` +int32_t(* LayerFuncs::SetLayerColorDataSpace) (uint32_t devId, uint32_t layerId, ColorDataSpace colorSpace) +``` + +**描述：** + +设置图层的颜色数据空间。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

layerId

+

输入参数，指示需要操作的图层ID。

+

colorSpace

+

输入参数，表示需要设置的颜色数据空间。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## SetLayerColorKey + +``` +int32_t(* LayerFuncs::SetLayerColorKey) (uint32_t devId, uint32_t layerId, bool enable, uint32_t key) +``` + +**描述：** + +设置图层colorkey属性,在图层叠加时使用。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备ID，用于支持多个显示设备，取值从0开始，0表示第一个设备，最大支持5个设备。

+

layerId

+

输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。

+

enable

+

输入参数，待设置的色键使能标识。

+

key

+

输入参数，待设置的色键值，即颜色值。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +**参见：** + +[GetLayerColorKey](_layer_funcs.md#aea882232b6279b8be82c45e889187b24) + +## SetLayerColorTransform + +``` +int32_t(* LayerFuncs::SetLayerColorTransform) (uint32_t devId, uint32_t layerId, const float *matrix) +``` + +**描述：** + +设置图层当前的颜色转换矩阵。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

layerId

+

输入参数，指示需要操作的图层ID。

+

matrix

+

输入参数，表示需要设置的颜色转换模式。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## SetLayerCompositionType + +``` +int32_t(* LayerFuncs::SetLayerCompositionType) (uint32_t devId, uint32_t layerId, CompositionType type) +``` + +**描述：** + +设置客户端期望的组合类型 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备的ID。取值范围为0 ~ 4，其中0表示第一个显示设备，4表示最后一个显示设备。

+

layerId

+

输入参数，层ID，唯一标识一个层。可以对该层进行操作。

+

type

+

输入参数，指示客户端期望的组合类型。它可能随实现而变化。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## SetLayerCompression + +``` +int32_t(* LayerFuncs::SetLayerCompression) (uint32_t devId, uint32_t layerId, int32_t compType) +``` + +**描述：** + +设置图层压缩功能 + +在特定场景下，需要对图像数据进行压缩，可设置启动或关闭图层压缩功能。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备ID，用于支持多个显示设备，取值从0开始，0表示第一个设备，最大支持5个设备。

+

layerId

+

输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。

+

compType

+

输入参数，图层压缩使能标识。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +**参见：** + +[GetLayerCompression](_layer_funcs.md#ab0b5855ea4ee5228516303cba84907ce) + +## SetLayerCrop + +``` +int32_t(* LayerFuncs::SetLayerCrop) (uint32_t devId, uint32_t layerId, IRect *rect) +``` + +**描述：** + +设置图层裁剪区域。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备ID，用于支持多个显示设备，取值从0开始，0表示第一个设备，最大支持5个设备。

+

layerId

+

输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。

+

rect

+

输入参数，待设置的裁剪区域。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## SetLayerDirtyRegion + +``` +int32_t(* LayerFuncs::SetLayerDirtyRegion) (uint32_t devId, uint32_t layerId, IRect *region) +``` + +**描述：** + +设置图层刷新区域。 + +GUI图形系统绘制好图像数据后，在调用Flush接口刷新屏幕之前需要设置图层刷新区域。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备ID，用于支持多个显示设备，取值从0开始，0表示第一个设备，最大支持5个设备。

+

layerId

+

输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。

+

region

+

输入参数，待设置的刷新区域。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## SetLayerMetaData + +``` +int32_t(* LayerFuncs::SetLayerMetaData) (uint32_t devId, uint32_t layerId, uint32_t num, const HDRMetaData *metaData) +``` + +**描述：** + +设置图层的HDRmetaData。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

layerId

+

输入参数，指示需要操作的图层ID。

+

num

+

输入参数，metadata 数组个数。

+

metaData

+

输入参数，表示需要设置的 metadata 数组首地址。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## SetLayerMetaDataSet + +``` +int32_t(* LayerFuncs::SetLayerMetaDataSet) (uint32_t devId, uint32_t layerId, HDRMetadataKey key, uint32_t num, const uint8_t *metaData) +``` + +**描述：** + +设置图层的metaData set。 + +**参数：** + + + + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

layerId

+

输入参数，指示需要操作的图层ID。

+

key

+

输入参数，表示需要设置的 HDRMetadataKey。

+

num

+

输入参数，metadata 数组个数。

+

metaData

+

输入参数，表示需要设置的 metadata 数组首地址, 数据类型为uint8_t。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## SetLayerPalette + +``` +int32_t(* LayerFuncs::SetLayerPalette) (uint32_t devId, uint32_t layerId, uint32_t *palette, uint32_t len) +``` + +**描述：** + +设置图层调色板。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备ID，用于支持多个显示设备，取值从0开始，0表示第一个设备，最大支持5个设备。

+

layerId

+

输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。

+

palette

+

输入参数，待设置的图层调色板。

+

len

+

输入参数，调色板长度。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +**参见：** + +[GetLayerPalette](_layer_funcs.md#af713bc39e51dc8168c278e2f126bf4e3) + +## SetLayerPreMulti + +``` +int32_t(* LayerFuncs::SetLayerPreMulti) (uint32_t devId, uint32_t layerId, bool preMul) +``` + +**描述：** + +设置图层预乘。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备ID，用于支持多个显示设备，取值从0开始，0表示第一个设备，最大支持5个设备。

+

layerId

+

输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。

+

preMul

+

输入参数，待设置的图层预乘使能标识，1表示使能图层预乘，0表示不使能图层预乘。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +**参见：** + +[GetLayerPreMulti](_layer_funcs.md#a4a0e26f8401da1232f03bb37502ff4bd) + +## SetLayerSize + +``` +int32_t(* LayerFuncs::SetLayerSize) (uint32_t devId, uint32_t layerId, IRect *rect) +``` + +**描述：** + +设置图层大小。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备ID，用于支持多个显示设备，取值从0开始，0表示第一个设备，最大支持5个设备。

+

layerId

+

输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。

+

rect

+

输入参数，待设置的图层大小，单位为像素。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +**参见：** + +[GetLayerSize](_layer_funcs.md#a56be84be25eba64497b2a842c1f68b26) + +## SetLayerTunnelHandle + +``` +int32_t(* LayerFuncs::SetLayerTunnelHandle) (uint32_t devId, uint32_t layerId, ExtDataHandle *handle) +``` + +**描述：** + +设置图层的tunnel句柄。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，指示需要操作的设备ID。

+

layerId

+

输入参数，指示需要操作的图层ID。

+

handle

+

输入参数，表示需要设置的句柄。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## SetLayerVisible + +``` +int32_t(* LayerFuncs::SetLayerVisible) (uint32_t devId, uint32_t layerId, bool visible) +``` + +**描述：** + +设置图层是否可见。 + +不可见情况下图层不显示在屏幕上，可见情况下图层显示在屏幕上。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备ID，用于支持多个显示设备，取值从0开始，0表示第一个设备，最大支持5个设备。

+

layerId

+

输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。

+

visible

+

输入参数，待设置的图层可见标识，设置true表示图层可见，设置false表示图层不可见。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +**参见：** + +[GetLayerVisibleState](_layer_funcs.md#a6bbff71bb4f17eb84a4db4857a0b0985) + +## SetLayerVisibleRegion + +``` +int32_t(* LayerFuncs::SetLayerVisibleRegion) (uint32_t devId, uint32_t layerId, uint32_t num, IRect *rect) +``` + +**描述：** + +设置一个图层的可见区域 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备的ID。取值范围为0 ~ 4，其中0表示第一个显示设备，4表示最后一个显示设备。

+

layerId

+

输入参数，层ID，唯一标识一个层。可以对该层进行操作。

+

num

+

输入参数，指定rect的计数，该区域包含多个 IRect,num表示该区域中有多少个rect区域。

+

rect

+

输出参数，rectes对象的指针。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## SetLayerZorder + +``` +int32_t(* LayerFuncs::SetLayerZorder) (uint32_t devId, uint32_t layerId, uint32_t zorder) +``` + +**描述：** + +设置图层Z轴次序。 + +图层的Z序值越大，图层越靠上显示。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备ID，用于支持多个显示设备，取值从0开始，0表示第一个设备，最大支持5个设备。

+

layerId

+

输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。

+

zorder

+

输入参数，待设置的图层Z序，为整数值，取值范围为[0, 255]，值越大图层越往上排列。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +**参见：** + +[GetLayerZorder](_layer_funcs.md#a5644645442e1d6943b55ce0a6a801b8c) + +## SetTransformMode + +``` +int32_t(* LayerFuncs::SetTransformMode) (uint32_t devId, uint32_t layerId, TransformType type) +``` + +**描述：** + +设置图层变换模式，根据不同的场景设置图层的旋转、缩放、移位等。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备ID，用于支持多个显示设备，取值从0开始，0表示第一个设备，最大支持5个设备。

+

layerId

+

输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。

+

type

+

输入参数，待设置的图层变换模式。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## SnapShot + +``` +int32_t(* LayerFuncs::SnapShot) (uint32_t devId, LayerBuffer *buffer) +``` + +**描述：** + +实现抓图功能。 + +本函数将显示设备上的图像数据截图保存到buffer中，用于调试、应用截图等场景。 + +otherwise. + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备ID，用于支持多个显示设备，取值从0开始，0表示第一个设备，最大支持5个设备。

+

buffer

+

输出参数，保存截屏的buffer信息。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + +## WaitForVBlank + +``` +int32_t(* LayerFuncs::WaitForVBlank) (uint32_t devId, uint32_t layerId, int32_t timeOut) +``` + +**描述：** + +实现等待帧消隐期到来功能。 + +该函数会让系统等待，直到帧消隐期到来，用于软件和硬件之间的同步。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

devId

+

输入参数，显示设备ID，用于支持多个显示设备，取值从0开始，0表示第一个设备，最大支持5个设备。

+

layerId

+

输入参数，图层ID，图层的唯一标识，根据图层ID操作图层。

+

timeOut

+

输入参数，超时时间，在设置的超时时间后，没有等到帧消隐期到来则超时返回。

+
+ +**返回：** + +DISPLAY\_SUCCESS 表示执行成功。 + +其他值表示执行失败，具体错误码查看[DispErrCode](_display.md#ga12a925dadef7573cd74d63d06824f9b0)。 + diff --git a/zh-cn/device-dev/api/toctopics/_layer_info.md b/zh-cn/device-dev/api/toctopics/_layer_info.md new file mode 100644 index 0000000000..16aa2aa62e --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_layer_info.md @@ -0,0 +1,53 @@ +# LayerInfo + +## **概述** + +**所属模块:** + +[Display](_display.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

width

+

图层宽度

+

height

+

图层高度

+

type

+

图层类型，包括图形层、视频层和媒体播放模式。

+

bpp

+

每像素所占bit数

+

pixFormat

+

图层像素格式

+
+ +## **详细描述** + +定义图层信息结构体。 + +在创建图层时，需要将LayerInfo传递给创建图层接口，创建图层接口根据图层信息创建相应图层。 + diff --git a/zh-cn/device-dev/api/toctopics/_light.md b/zh-cn/device-dev/api/toctopics/_light.md new file mode 100644 index 0000000000..3849027cb3 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_light.md @@ -0,0 +1,295 @@ +# Light + +## **汇总** + +## 文件 + + + + + + + + + + + + + +

文件

+

描述

+

light_if.h

+

声明light模块的通用API，可用于获取灯ID、打开或关闭灯、并设置灯光亮度和闪烁模式。

+

light_type.h

+

定义灯的数据结构，包括灯ID、灯的模式、灯的闪烁模式和持续时间、灯的状态、灯的效果。

+
+ +## 类 + + + + + + + + + + + + + + + + + + + +

类

+

描述

+

LightFlashEffect

+

定义闪烁参数。 更多...

+

LightEffect

+

定义灯的效果参数。 更多...

+

LightInfo

+

定义灯的基本信息。 更多...

+

LightInterface

+

定义可以在灯上执行的基本操作。 更多...

+
+ +## 枚举 + + + + + + + + + + + + + + + + +

枚举

+

描述

+

LightStatus { LIGHT_SUCCESS = 0, LIGHT_NOT_SUPPORT = -1, LIGHT_NOT_FLASH = -2, LIGHT_NOT_BRIGHTNESS = -3 }

+

枚举灯模块的状态值。 更多...

+

LightId { LIGHT_ID_NONE = 0, LIGHT_ID_BATTERY = 1, LIGHT_ID_NOTIFICATIONS = 2, LIGHT_ID_ATTENTION = 3, LIGHT_ID_BUTT = 4 }

+

枚举灯类型 更多...

+

LightFlashMode { LIGHT_FLASH_NONE = 0, LIGHT_FLASH_TIMED = 1, LIGHT_FLASH_BUTT = 2 }

+

枚举灯的模式 更多...

+
+ +## 函数 + + + + + + + + + + + + + +

函数

+

描述

+

NewLightInterfaceInstance (void)

+

创建LightInterface实例。 更多...

+

FreeLightInterfaceInstance (void)

+

释放LightInterface实例和相关资源。 更多...

+
+ +## **详细描述** + +灯模块对灯服务提供通用的接口能力。 + +灯模块为灯服务提供通用的接口去访问灯驱动。 服务获取灯驱动对象或代理后，可以调用相关的APIs接口获取灯信息、打开或关闭灯，并根据灯ID设置灯闪烁模式。 + +**Since：** + +3.1 + +## **枚举类型说明** + +## LightFlashMode + +``` +enum LightFlashMode +``` + +**描述：** + +枚举灯的模式 + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

LIGHT_FLASH_NONE

+

常亮。

+

+

LIGHT_FLASH_TIMED

+

闪烁。

+

+

LIGHT_FLASH_BUTT

+

无效模式。

+

+
+ +## LightId + +``` +enum LightId +``` + +**描述：** + +枚举灯类型 + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

LIGHT_ID_NONE

+

未知ID。

+

+

LIGHT_ID_BATTERY

+

电源指示灯。

+

+

LIGHT_ID_NOTIFICATIONS

+

通知灯。

+

+

LIGHT_ID_ATTENTION

+

报警灯。

+

+

LIGHT_ID_BUTT

+

无效ID。

+

+
+ +## LightStatus + +``` +enum LightStatus +``` + +**描述：** + +枚举灯模块的状态值。 + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

LIGHT_SUCCESS

+

操作成功。

+

+

LIGHT_NOT_SUPPORT

+

灯ID不支持。

+

+

LIGHT_NOT_FLASH

+

设置闪烁不支持。

+

+

LIGHT_NOT_BRIGHTNESS

+

设置亮度不支持。

+

+
+ +## **函数说明** + +## FreeLightInterfaceInstance\(\) + +``` +int32_t FreeLightInterfaceInstance (void ) +``` + +**描述：** + +释放LightInterface实例和相关资源。 + +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +**Since：** + +3.1 + +## NewLightInterfaceInstance\(\) + +``` +const struct LightInterface* NewLightInterfaceInstance (void ) +``` + +**描述：** + +创建LightInterface实例。 + +创建的LightInterface实例可用于执行相关的灯控制操作。 + +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +**Since：** + +3.1 + diff --git a/zh-cn/device-dev/api/toctopics/_light_effect.md b/zh-cn/device-dev/api/toctopics/_light_effect.md new file mode 100644 index 0000000000..71ab2d12de --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_light_effect.md @@ -0,0 +1,64 @@ +# LightEffect + +## **概述** + +**所属模块:** + +[Light](_light.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + +

Public 属性

+

描述

+

lightBrightness

+

亮度值。

+

flashEffect

+

闪烁模式。

+
+ +## **详细描述** + +定义灯的效果参数。 + +参数包括亮度和闪烁模式。 + +**Since：** + +3.1 + +## **类成员变量说明** + +## flashEffect + +``` +struct LightFlashEffect LightEffect::flashEffect +``` + +**描述：** + +闪烁模式。详见[LightFlashEffect](_light_flash_effect.md)。 + +## lightBrightness + +``` +int32_t LightEffect::lightBrightness +``` + +**描述：** + +亮度值：Bits 24–31为扩展位，Bits 16–23为红色，bits 8–15为绿色，bits 0–7为蓝色。 如果字节段不等于0，指示打开相应颜色的灯。 + diff --git a/zh-cn/device-dev/api/toctopics/_light_flash_effect.md b/zh-cn/device-dev/api/toctopics/_light_flash_effect.md new file mode 100644 index 0000000000..46a896534a --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_light_flash_effect.md @@ -0,0 +1,79 @@ +# LightFlashEffect + +## **概述** + +**所属模块:** + +[Light](_light.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

flashMode

+

闪烁模式。

+

onTime

+

表示灯在闪烁期间点亮时持续的时间（毫秒）。

+

offTime

+

表示灯在闪烁期间熄灭时持续的时间（毫秒）。

+
+ +## **详细描述** + +定义闪烁参数。 + +这些参数包括闪烁模式以及闪烁期间指示灯的打开和关闭时间。 + +**Since：** + +3.1 + +## **类成员变量说明** + +## flashMode + +``` +int32_t LightFlashEffect::flashMode +``` + +**描述：** + +闪烁模式，详见[LightFlashMode](_light.md#gaacf9823c64514a279833614add26ab5d)。 + +## offTime + +``` +int32_t LightFlashEffect::offTime +``` + +**描述：** + +表示灯在闪烁期间熄灭时持续的时间（毫秒）。 + +## onTime + +``` +int32_t LightFlashEffect::onTime +``` + +**描述：** + +表示灯在闪烁期间点亮时持续的时间（毫秒）。 + diff --git a/zh-cn/device-dev/api/toctopics/_light_info.md b/zh-cn/device-dev/api/toctopics/_light_info.md new file mode 100644 index 0000000000..96485ffa36 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_light_info.md @@ -0,0 +1,64 @@ +# LightInfo + +## **概述** + +**所属模块:** + +[Light](_light.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + +

Public 属性

+

描述

+

lightId

+

灯ID

+

reserved

+

自定义扩展信息

+
+ +## **详细描述** + +定义灯的基本信息。 + +基本的灯信息包括灯ID和自定义扩展信息。 + +**Since：** + +3.1 + +## **类成员变量说明** + +## lightId + +``` +uint32_t LightInfo::lightId +``` + +**描述：** + +灯ID，详见[LightId](_light.md#ga8af1cb654f32fb5377425257b28748e5)。 + +## reserved + +``` +int32_t LightInfo::reserved +``` + +**描述：** + +自定义扩展信息。 + diff --git a/zh-cn/device-dev/api/toctopics/_light_interface.md b/zh-cn/device-dev/api/toctopics/_light_interface.md new file mode 100644 index 0000000000..b3b1a92cbe --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_light_interface.md @@ -0,0 +1,158 @@ +# LightInterface + +## **概述** + +**所属模块:** + +[Light](_light.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

( GetLightInfo )([out] struct LightInfo **lightInfo, [out] uint32_t *count)

+

获取当前系统中所有类型的灯信息。 更多...

+

( TurnOnLight )([in] uint32_t lightId, [in] struct LightEffect *effect)

+

根据指定的灯ID打开列表中的可用灯。 更多...

+

( TurnOffLight )([in] uint32_t lightId)

+

根据指定的灯ID关闭列表中的可用灯。 更多...

+
+ +## **详细描述** + +定义可以在灯上执行的基本操作。 + +操作包括获取灯的信息、打开或关闭灯、设置灯的亮度或闪烁模式。 + +## **类成员变量说明** + +## GetLightInfo + +``` +int32_t(* LightInterface::GetLightInfo) ([out] struct LightInfo **lightInfo,[out] uint32_t *count) +``` + +**描述：** + +获取当前系统中所有类型的灯信息。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

lightInfo

+

表示指向灯信息的二级指针，详见LightInfo。

+

count

+

表示指向灯数量的指针。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +## TurnOffLight + +``` +int32_t(* LightInterface::TurnOffLight) ([in] uint32_t lightId) +``` + +**描述：** + +根据指定的灯ID关闭列表中的可用灯。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

lightId

+

表示灯ID，详见LightId。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +## TurnOnLight + +``` +int32_t(* LightInterface::TurnOnLight) ([in] uint32_t lightId,[in] struct LightEffect *effect) +``` + +**描述：** + +根据指定的灯ID打开列表中的可用灯。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

lightId

+

表示灯ID，详见LightId。

+

effect

+

表示指向灯效果的指针，如果lightbrightness字段为0时， 灯的亮度根据HCS配置的默认亮度进行设置，详见LightEffect。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果不支持灯ID，则返回-1。 + +如果不支持闪烁设置，则返回-2。 + +如果不支持亮度设置，则返回3。 + diff --git a/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_capture_ended_info.md b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_capture_ended_info.md new file mode 100644 index 0000000000..093cdec385 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_capture_ended_info.md @@ -0,0 +1,36 @@ +# OHOS::Camera::CaptureEndedInfo + +## **概述** + +**所属模块:** + +[Camera](_camera.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + +

Public 属性

+

描述

+

streamId_

+

捕获的流ID。

+

frameCount_

+

捕获结束时已经抓取的帧数。

+
+ +## **详细描述** + +捕获结束相关信息，用于捕获结束回调 **OnCaptureEnded**。 + diff --git a/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_capture_error_info.md b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_capture_error_info.md new file mode 100644 index 0000000000..d4df7b0059 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_capture_error_info.md @@ -0,0 +1,36 @@ +# OHOS::Camera::CaptureErrorInfo + +## **概述** + +**所属模块:** + +[Camera](_camera.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + +

Public 属性

+

描述

+

streamId_

+

流ID。

+

error_

+

错误类型。

+
+ +## **详细描述** + +流错误信息，用于回调[OnCaptureError](_camera.md#gacea9a4cf4bdd5fab5499da06ecdf9b8f)。 + diff --git a/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_capture_info.md b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_capture_info.md new file mode 100644 index 0000000000..3bef10d50d --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_capture_info.md @@ -0,0 +1,41 @@ +# OHOS::Camera::CaptureInfo + +## **概述** + +**所属模块:** + +[Camera](_camera.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

streamIds_

+

捕获的流ID集合。

+

captureSetting_

+

捕获的配置信息。

+

enableShutterCallback_

+

使能捕获回调，每一次捕获后都会触发 OnFrameShutter。

+
+ +## **详细描述** + +捕获请求的相关信息。 + diff --git a/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_i_camera_device.md b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_i_camera_device.md new file mode 100644 index 0000000000..54acfdfc62 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_i_camera_device.md @@ -0,0 +1,66 @@ +# OHOS::Camera::ICameraDevice + +## **概述** + +**所属模块:** + +[Camera](_camera.md) + +## **汇总** + +## Public 成员函数 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 成员函数

+

描述

+

DECLARE_INTERFACE_DESCRIPTOR (u"HDI.Camera.V1_0.Device")

+

IPC通信token校验。

+

GetStreamOperator (const OHOS::sptr< IStreamOperatorCallback > &callback, OHOS::sptr< IStreamOperator > &streamOperator)=0

+

获取流操作句柄。 更多...

+

UpdateSettings (const std::shared_ptr< CameraSetting > &settings)=0

+

更新设备控制参数。 更多...

+

SetResultMode (const ResultCallbackMode &mode)=0

+

设置metadata上报模式，逐帧上报还是设备状态变化时上报。 更多...

+

GetEnabledResults (std::vector< MetaType > &results)=0

+

查询使能的metadata。 更多...

+

EnableResult (const std::vector< MetaType > &results)=0

+

打开metadata上报开关。 更多...

+

DisableResult (const std::vector< MetaType > &results)=0

+

关闭metadata上报开关。 更多...

+

Close ()=0

+

关闭Camera设备。 更多...

+
+ +## **详细描述** + +Camera设备操作。 + diff --git a/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_i_camera_device_callback.md b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_i_camera_device_callback.md new file mode 100644 index 0000000000..bdc5cf1f61 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_i_camera_device_callback.md @@ -0,0 +1,41 @@ +# OHOS::Camera::ICameraDeviceCallback + +## **概述** + +**所属模块:** + +[Camera](_camera.md) + +## **汇总** + +## Public 成员函数 + + + + + + + + + + + + + + + + +

Public 成员函数

+

描述

+

DECLARE_INTERFACE_DESCRIPTOR (u"HDI.Camera.V1_0.DeviceCallback")

+

IPC通信token校验。

+

OnError (ErrorType type, int32_t errorCode)=0

+

设备发生错误时调用，由调用者实现，用于返回错误信息给调用者。 更多...

+

OnResult (uint64_t timestamp, const std::shared_ptr< CameraMetadata > &result)=0

+

上报camera设备相关的metadata的回调，上报方式查看 SetResultMode。 更多...

+
+ +## **详细描述** + +Camera设备操作回调。 + diff --git a/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_i_camera_host.md b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_i_camera_host.md new file mode 100644 index 0000000000..44aa52c315 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_i_camera_host.md @@ -0,0 +1,73 @@ +# OHOS::Camera::ICameraHost + +## **概述** + +**所属模块:** + +[Camera](_camera.md) + +## **汇总** + +## Public 成员函数 + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 成员函数

+

描述

+

DECLARE_INTERFACE_DESCRIPTOR (u"HDI.Camera.V1_0.Host")

+

IPC通信token校验。

+

SetCallback (const OHOS::sptr< ICameraHostCallback > &callback)=0

+

设置ICameraHost回调接口，回调函数参考 ICameraHostCallback。 更多...

+

GetCameraIds (std::vector< std::string > &cameraIds)=0

+

获取当前可用的Camera设备ID列表。 更多...

+

GetCameraAbility (const std::string &cameraId, std::shared_ptr< CameraAbility > &ability)=0

+

获取Camera设备能力集合。 更多...

+

OpenCamera (const std::string &cameraId, const OHOS::sptr< ICameraDeviceCallback > &callback, OHOS::sptr< ICameraDevice > &device)=0

+

打开Camera设备。 更多...

+

SetFlashlight (const std::string &cameraId, bool &isEnable)=0

+

打开或关闭闪光灯。 更多...

+
+ +## 静态 Public 成员函数 + + + + + + + + + + +

静态 Public 成员函数

+

描述

+

Get (const char *serviceName)

+

获取ICameraHost实例。 更多...

+
+ +## **详细描述** + +Camera服务的管理类。 + diff --git a/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_i_camera_host_callback.md b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_i_camera_host_callback.md new file mode 100644 index 0000000000..883eda3f88 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_i_camera_host_callback.md @@ -0,0 +1,46 @@ +# OHOS::Camera::ICameraHostCallback + +## **概述** + +**所属模块:** + +[Camera](_camera.md) + +## **汇总** + +## Public 成员函数 + + + + + + + + + + + + + + + + + + + +

Public 成员函数

+

描述

+

DECLARE_INTERFACE_DESCRIPTOR (u"HDI.Camera.V1_0.HostCallback")

+

IPC通信token校验。

+

OnCameraStatus (const std::string &cameraId, CameraStatus status)=0

+

用于Camera设备状态变化时上报状态信息给调用者。 更多...

+

OnFlashlightStatus (const std::string &cameraId, FlashlightStatus status)=0

+

用于在闪光灯状态变化时上报状态信息给调用者。 更多...

+

OnCameraEvent (const std::string &cameraId, CameraEvent event)=0

+

在相机事件发生时调用。 更多...

+
+ +## **详细描述** + +Camera服务的管理回调。 + diff --git a/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_i_offline_stream_operator.md b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_i_offline_stream_operator.md new file mode 100644 index 0000000000..43f321256f --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_i_offline_stream_operator.md @@ -0,0 +1,46 @@ +# OHOS::Camera::IOfflineStreamOperator + +## **概述** + +**所属模块:** + +[Camera](_camera.md) + +## **汇总** + +## Public 成员函数 + + + + + + + + + + + + + + + + + + + +

Public 成员函数

+

描述

+

DECLARE_INTERFACE_DESCRIPTOR (u"HDI.Camera.V1_0.OfflineStreamOperator")

+

IPC通信token校验。

+

CancelCapture (int captureId)=0

+

取消捕获请求。 更多...

+

ReleaseStreams (const std::vector< int > &streamIds)=0

+

释放离线流。 更多...

+

Release ()=0

+

释放所有离线流。 更多...

+
+ +## **详细描述** + +离线流的操作类。 + diff --git a/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_i_stream_operator.md b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_i_stream_operator.md new file mode 100644 index 0000000000..89e139d113 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_i_stream_operator.md @@ -0,0 +1,81 @@ +# OHOS::Camera::IStreamOperator + +## **概述** + +**所属模块:** + +[Camera](_camera.md) + +## **汇总** + +## Public 成员函数 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 成员函数

+

描述

+

DECLARE_INTERFACE_DESCRIPTOR (u"HDI.Camera.V1_0.StreamOperator")

+

IPC通信token校验。

+

IsStreamsSupported (OperationMode mode, const std::shared_ptr< CameraMetadata > &modeSetting, const std::vector< std::shared_ptr< StreamInfo >> &info, StreamSupportType &type)=0

+

查询是否支持添加参数对应的流 更多...

+

CreateStreams (const std::vector< std::shared_ptr< StreamInfo >> &streamInfos)=0

+

创建流。 更多...

+

ReleaseStreams (const std::vector< int > &streamIds)=0

+

释放流。 更多...

+

CommitStreams (OperationMode mode, const std::shared_ptr< CameraMetadata > &modeSetting)=0

+

配置流。 更多...

+

GetStreamAttributes (std::vector< std::shared_ptr< StreamAttribute >> &attributes)=0

+

获取流的属性。 更多...

+

AttachBufferQueue (int streamId, const OHOS::sptr< OHOS::IBufferProducer > &producer)=0

+

绑定生产者句柄和指定流。 更多...

+

DetachBufferQueue (int streamId)=0

+

解除生产者句柄和指定流的绑定关系。 更多...

+

Capture (int captureId, const std::shared_ptr< CaptureInfo > &info, bool isStreaming)=0

+

捕获图像。 更多...

+

CancelCapture (int captureId)=0

+

取消捕获。 更多...

+

ChangeToOfflineStream (const std::vector< int > &streamIds, OHOS::sptr< IStreamOperatorCallback > &callback, OHOS::sptr< IOfflineStreamOperator > &offlineOperator)=0

+

将指定流转换成离线流。 更多...

+
+ +## **详细描述** + +流的操作类。 + diff --git a/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_i_stream_operator_callback.md b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_i_stream_operator_callback.md new file mode 100644 index 0000000000..4575119dc4 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_i_stream_operator_callback.md @@ -0,0 +1,51 @@ +# OHOS::Camera::IStreamOperatorCallback + +## **概述** + +**所属模块:** + +[Camera](_camera.md) + +## **汇总** + +## Public 成员函数 + + + + + + + + + + + + + + + + + + + + + + +

Public 成员函数

+

描述

+

DECLARE_INTERFACE_DESCRIPTOR (u"HDI.Camera.V1_0.StreamOperatorCallback")

+

IPC通信token校验。

+

OnCaptureStarted (int32_t captureId, const std::vector< int32_t > &streamIds)=0

+

捕获开始回调，在捕获开始时调用。 更多...

+

OnCaptureEnded (int32_t captureId, const std::vector< std::shared_ptr< CaptureEndedInfo >> &infos)=0

+

捕获结束回调，在捕获结束时调用。 更多...

+

OnCaptureError (int32_t captureId, const std::vector< std::shared_ptr< CaptureErrorInfo >> &infos)=0

+

捕获错误回调，在捕获过程中发生错误时调用。 更多...

+

OnFrameShutter (int32_t captureId, const std::vector< int32_t > &streamIds, uint64_t timestamp)=0

+

帧捕获回调。 更多...

+
+ +## **详细描述** + +流的操作回调类。 + diff --git a/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_stream_attribute.md b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_stream_attribute.md new file mode 100644 index 0000000000..4c97b65ee9 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_stream_attribute.md @@ -0,0 +1,71 @@ +# OHOS::Camera::StreamAttribute + +## **概述** + +**所属模块:** + +[Camera](_camera.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

streamId_

+

流的ID，用于在设备内唯一标识一条流。

+

width_

+

图像宽度。

+

height_

+

图像高度。

+

overrideFormat_

+

重写的图像格式。

+

overrideDatasapce_

+

重写的图像颜色空间

+

producerUsage_

+

重写后的生产者的使用方式。

+

producerBufferCount_

+

重写后的生产者缓存数量。

+

maxBatchCaptureCount_

+

连拍支持的最大捕获帧数量。

+

maxCaptureCount_

+

最大的并发捕获请求个数，默认为1。

+
+ +## **详细描述** + +流的属性。 + diff --git a/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_stream_info.md b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_stream_info.md new file mode 100644 index 0000000000..e1efbf768f --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_camera_1_1_stream_info.md @@ -0,0 +1,76 @@ +# OHOS::Camera::StreamInfo + +## **概述** + +**所属模块:** + +[Camera](_camera.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

streamId_

+

流的ID，用于在设备内唯一标识一条流。

+

width_

+

图像宽度。

+

height_

+

图像高度。

+

format_

+

图像格式。

+

datasapce_

+

图像颜色空间。

+

intent_

+

流类型。

+

tunneledMode_

+

隧道模式，值为true时开启，false关闭。

+

bufferQueue_

+

图形提供的生产者句柄。

+

minFrameDuration_

+

最小帧间隔。

+

encodeType_

+

编码类型。

+
+ +## **详细描述** + +流信息，用于创建流时传入相关的配置参数。 + diff --git a/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_u_s_b_1_1_u_s_b_device_info.md b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_u_s_b_1_1_u_s_b_device_info.md new file mode 100644 index 0000000000..5fbb825694 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_u_s_b_1_1_u_s_b_device_info.md @@ -0,0 +1,41 @@ +# OHOS::USB::USBDeviceInfo + +## **概述** + +**所属模块:** + +[USB](_u_s_b.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

status

+

USB设备状态

+

busNum

+

USB总线编号

+

devNum

+

USB设备编号

+
+ +## **详细描述** + +USB设备信息。 + diff --git a/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_u_s_b_1_1_usb_ctrl_transfer.md b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_u_s_b_1_1_usb_ctrl_transfer.md new file mode 100644 index 0000000000..3e6f39ec77 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_u_s_b_1_1_usb_ctrl_transfer.md @@ -0,0 +1,51 @@ +# OHOS::USB::UsbCtrlTransfer + +## **概述** + +**所属模块:** + +[USB](_u_s_b.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

requestType

+

请求类型

+

requestCmd

+

请求命令字

+

value

+

请求值

+

index

+

索引

+

timeout

+

超时时间

+
+ +## **详细描述** + +USB控制传输。 + diff --git a/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md new file mode 100644 index 0000000000..52cb4df3ca --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md @@ -0,0 +1,36 @@ +# OHOS::USB::UsbDev + +## **概述** + +**所属模块:** + +[USB](_u_s_b.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + +

Public 属性

+

描述

+

busNum

+

USB总线编号

+

devAddr

+

USB设备地址

+
+ +## **详细描述** + +USB设备。 + diff --git a/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_u_s_b_1_1_usb_info.md b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_u_s_b_1_1_usb_info.md new file mode 100644 index 0000000000..c7650dc48e --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_u_s_b_1_1_usb_info.md @@ -0,0 +1,56 @@ +# OHOS::USB::UsbInfo + +## **概述** + +**所属模块:** + +[USB](_u_s_b.md) + +## **汇总** + +## Public 成员函数 + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 成员函数

+

描述

+

setDevInfoStatus (int32_t status)

+

设置USB设备状态。 更多...

+

setDevInfoBusNum (int32_t busNum)

+

设置USB总线编号。 更多...

+

setDevInfoDevNum (int32_t devNum)

+

设置USB设备编号。 更多...

+

getDevInfoStatus () const

+

获取USB设备状态。 更多...

+

getDevInfoBusNum () const

+

获取USB总线编号。 更多...

+

getDevInfoDevNum () const

+

获取USB设备编号。 更多...

+
+ +## **详细描述** + +USB设备信息类。 + diff --git a/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md new file mode 100644 index 0000000000..71e16bbbc3 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md @@ -0,0 +1,36 @@ +# OHOS::USB::UsbPipe + +## **概述** + +**所属模块:** + +[USB](_u_s_b.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + +

Public 属性

+

描述

+

interfaceId

+

USB设备接口ID

+

endpointId

+

USB设备端点ID

+
+ +## **详细描述** + +管道信息。 + diff --git a/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_u_s_b_1_1_usbd_client.md b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_u_s_b_1_1_usbd_client.md new file mode 100644 index 0000000000..d1561216a0 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_u_s_b_1_1_usbd_client.md @@ -0,0 +1,204 @@ +# OHOS::USB::UsbdClient + +## **概述** + +**所属模块:** + +[USB](_u_s_b.md) + +## **汇总** + +## Public 成员函数 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 成员函数

+

描述

+

OpenDevice (const UsbDev &dev)

+

打开设备，建立连接。 更多...

+

CloseDevice (const UsbDev &dev)

+

关闭设备，释放与设备相关的所有系统资源。 更多...

+

GetDeviceDescriptor (const UsbDev &dev, std::vector< uint8_t > &descriptor)

+

获取设备描述符。 更多...

+

GetStringDescriptor (const UsbDev &dev, uint8_t descId, std::vector< uint8_t > &descriptor)

+

根据String ID获取设备的字符串描述符。 更多...

+

GetConfigDescriptor (const UsbDev &dev, uint8_t descId, std::vector< uint8_t > &descriptor)

+

根据config ID获取设备的配置描述符config。 更多...

+

GetRawDescriptor (const UsbDev &dev, std::vector< uint8_t > &descriptor)

+

获取原始描述符。 更多...

+

GetFileDescriptor (const UsbDev &dev, int32_t &fd)

+

获取文件描述符。 更多...

+

SetConfig (const UsbDev &dev, uint8_t configIndex)

+

设置当前的config信息。 更多...

+

GetConfig (const UsbDev &dev, uint8_t &configIndex)

+

获取当前的config信息。 更多...

+

ClaimInterface (const UsbDev &dev, uint8_t interfaceid, uint8_t force)

+

打开接口，并声明独占接口，必须在数据传输前执行。 更多...

+

ReleaseInterface (const UsbDev &dev, uint8_t interfaceid)

+

关闭接口，释放接口的占用，在停止数据传输后执行。 更多...

+

SetInterface (const UsbDev &dev, uint8_t interfaceid, uint8_t altIndex)

+

设置指定接口的备选设置，用于在具有相同ID但不同备用设置的两个接口之间进行选择。 更多...

+

BulkTransferRead (const UsbDev &dev, const UsbPipe &pipe, int32_t timeout, std::vector< uint8_t > &data)

+

在给定端点上执行批量数据读取，返回读取的数据和长度，端点方向必须为数据读取，可以设置超时时间。 更多...

+

BulkTransferWrite (const UsbDev &dev, const UsbPipe &pipe, int32_t timeout, const std::vector< uint8_t > &data)

+

在给定端点上执行批量数据写入， 返回读取的数据和长度，端点方向必须为数据写入。 更多...

+

ControlTransfer (const UsbDev &dev, const UsbCtrlTransfer &ctrl, std::vector< uint8_t > &data)

+

对此设备执行端点零的控制事务，传输方向由请求类型决定。 如果requestType＆ USB_ENDPOINT_DIR_MASK是USB_DIR_OUT ，则传输是写入，如果是USB_DIR_IN ，则传输是读取。 更多...

+

InterruptTransferRead (const UsbDev &dev, const UsbPipe &pipe, int32_t timeout, std::vector< uint8_t > &data)

+

在给定端点上执行中断数据读取， 返回读取的数据和长度，端点方向必须为数据读取。 更多...

+

InterruptTransferWrite (const UsbDev &dev, const UsbPipe &pipe, int32_t timeout, std::vector< uint8_t > &data)

+

在给定端点上执行中断数据写入， 返回读取的数据和长度，端点方向必须为数据写入。 更多...

+

IsoTransferRead (const UsbDev &dev, const UsbPipe &pipe, int32_t timeout, std::vector< uint8_t > &data)

+

在给定端点上执行等时数据读取， 返回读取的数据和长度，端点方向必须为数据读取。 更多...

+

IsoTransferWrite (const UsbDev &dev, const UsbPipe &pipe, int32_t timeout, std::vector< uint8_t > &data)

+

在给定端点上执行等时数据写入， 返回读取的数据和长度，端点方向必须为数据写入。 更多...

+

RequestQueue (const UsbDev &dev, const UsbPipe &pipe, const std::vector< uint8_t > &clientData, const std::vector< uint8_t > &buffer)

+

将指定的端点进行异步数据发送或者接收请求，数据传输方向由端点方向决定。 更多...

+

RequestWait (const UsbDev &dev, std::vector< uint8_t > &clientData, std::vector< uint8_t > &buffer, int32_t timeout)

+

等待RequestQueue异步请求的操作结果。 更多...

+

RequestCancel (const UsbDev &dev, const UsbPipe &pipe)

+

取消待处理的数据请求。 更多...

+

GetCurrentFunctions (int32_t &funcs)

+

获取从设备支持的功能列表（按位域表示）（从设备）。 更多...

+

SetCurrentFunctions (int32_t funcs)

+

设置从设备支持的功能列表（按位域表示）（从设备）。 更多...

+

SetPortRole (int32_t portId, int32_t powerRole, int32_t dataRole)

+

设置port端口的角色。 更多...

+

QueryPort (int32_t &portId, int32_t &powerRole, int32_t &dataRole, int32_t &mode)

+

查询port端口的当前设置。 更多...

+

BindUsbdSubscriber (const sptr< UsbdSubscriber > &subscriber)

+

绑定订阅者。 更多...

+

UnbindUsbdSubscriber (const sptr< UsbdSubscriber > &subscriber)

+

解绑订阅者。 更多...

+

RegBulkCallback (const UsbDev &dev, const UsbPipe &pipe, const sptr< IRemoteObject > &cb)

+

注册批量传输异步回调函数。 更多...

+

UnRegBulkCallback (const UsbDev &dev, const UsbPipe &pipe)

+

注销批量传输异步回调函数。 更多...

+

BulkRead (const UsbDev &dev, const UsbPipe &pipe, sptr< Ashmem > &ashmem)

+

批量传输异步读数据。 更多...

+

BulkWrite (const UsbDev &dev, const UsbPipe &pipe, sptr< Ashmem > &ashmem)

+

批量传输异步写数据。 更多...

+

BulkCancel (const UsbDev &dev, const UsbPipe &pipe)

+

批量传输异步取消接口，用于取消当前接口的异步批量读写操作。 更多...

+
+ +## 静态 Public 成员函数 + + + + + + + + + + +

静态 Public 成员函数

+

描述

+

GetInstance ()

+

获取实例。

+
+ diff --git a/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_u_s_b_1_1_usbd_subscriber.md b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_u_s_b_1_1_usbd_subscriber.md new file mode 100644 index 0000000000..11c9469311 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_o_h_o_s_1_1_u_s_b_1_1_usbd_subscriber.md @@ -0,0 +1,37 @@ +# OHOS::USB::UsbdSubscriber + +## **概述** + +**所属模块:** + +[USB](_u_s_b.md) + +## **汇总** + +## Public 成员函数 + + + + + + + + + + + + + + + + +

Public 成员函数

+

描述

+

DeviceEvent (const UsbInfo &info)=0

+

设备事件。 更多...

+

PortChangedEvent (int32_t portId, int32_t powerRole, int32_t dataRole, int32_t mode)=0

+

端口改变事件。 更多...

+

OnRemoteRequest (uint32_t code, MessageParcel &data, MessageParcel &reply, MessageOption &option) override

+

远程请求。 更多...

+
+ diff --git a/zh-cn/device-dev/api/toctopics/_omx_codec_buffer.md b/zh-cn/device-dev/api/toctopics/_omx_codec_buffer.md new file mode 100644 index 0000000000..74de5cba09 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_omx_codec_buffer.md @@ -0,0 +1,223 @@ +# OmxCodecBuffer + +## **概述** + +**所属模块:** + +[Codec](_codec.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

bufferId

+

buffer的ID。

+

size

+

结构体大小。

+

version

+

组件版本信息。

+

bufferType

+

buffer类型。

+

buffer

+

编码或者解码使用的buffer。

+

bufferLen

+

buffer大小。

+

allocLen

+

申请的buffer大小。

+

filledLen

+

填充的buffer大小。

+

offset

+

有效数据从缓冲区开始的起始偏移量。

+

fenceFd

+

该描述符来自buffer消费者，Codec等待成功后才可以使用输入或者输出buffer。

+

type

+

共享内存类型。

+

pts

+

时间戳。

+

flag

+

标志。

+
+ +## **详细描述** + +Codec buffer信息的定义。 + +## **类成员变量说明** + +## allocLen + +``` +uint32_t OmxCodecBuffer::allocLen +``` + +**描述：** + +申请的buffer大小 + +## buffer + +``` +uint8_t* OmxCodecBuffer::buffer +``` + +**描述：** + +编码或者解码使用的buffer + +## bufferId + +``` +uint32_t OmxCodecBuffer::bufferId +``` + +**描述：** + +buffer ID + +## bufferLen + +``` +uint32_t OmxCodecBuffer::bufferLen +``` + +**描述：** + +buffer大小 + +## bufferType + +``` +enum CodecBufferType OmxCodecBuffer::bufferType +``` + +**描述：** + +buffer类型 + +## fenceFd + +``` +int32_t OmxCodecBuffer::fenceFd +``` + +**描述：** + +该描述符来自buffer消费者，Codec等待成功后才可以使用输入或者输出buffer + +## filledLen + +``` +uint32_t OmxCodecBuffer::filledLen +``` + +**描述：** + +填充的buffer大小 + +## flag + +``` +uint32_t OmxCodecBuffer::flag +``` + +**描述：** + +标志 + +## offset + +``` +uint32_t OmxCodecBuffer::offset +``` + +**描述：** + +有效数据从缓冲区开始的起始偏移量 + +## pts + +``` +int64_t OmxCodecBuffer::pts +``` + +**描述：** + +时间戳 + +## size + +``` +uint32_t OmxCodecBuffer::size +``` + +**描述：** + +结构体大小 + +## type + +``` +enum ShareMemTypes OmxCodecBuffer::type +``` + +**描述：** + +共享内存类型 + +## version + +``` +union OMX_VERSIONTYPE OmxCodecBuffer::version +``` + +**描述：** + +组件版本信息 + diff --git a/zh-cn/device-dev/api/toctopics/_power_types_8idl.md b/zh-cn/device-dev/api/toctopics/_power_types_8idl.md new file mode 100644 index 0000000000..5f24f11d25 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_power_types_8idl.md @@ -0,0 +1,68 @@ +# PowerTypes.idl + +## **概述** + +**所属模块:** + +[Power](power.md) + +## **汇总** + +## 枚举 + + + + + + + + + + + + + + + + +

枚举

+

描述

+

PowerHdfCmd { CMD_REGISTER_CALLBCK = 0, CMD_START_SUSPEND, CMD_STOP_SUSPEND, CMD_FORCE_SUSPEND, CMD_SUSPEND_BLOCK, CMD_SUSPEND_UNBLOCK, CMD_DUMP }

+

枚举电源命令的参数。 更多...

+

PowerHdfCallbackCmd { CMD_ON_SUSPEND = 0, CMD_ON_WAKEUP }

+

枚举电源状态回调的参数。 更多...

+

PowerHdfState { AWAKE = 0, INACTIVE, SLEEP }

+

枚举电源的状态。 更多...

+
+ +## 变量 + + + + + + + + + + +

变量 名称

+

描述

+

package ohos.hdi.power.v1_0

+

电源管理接口的包路径

+
+ +## **详细描述** + +电源相关的数据类型。 + +电源管理中使用的数据类型，包括命令参数、回调参数和系统状态。 + +**Since：** + +3.1 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/_present_timestamp.md b/zh-cn/device-dev/api/toctopics/_present_timestamp.md new file mode 100644 index 0000000000..da14db4fd9 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_present_timestamp.md @@ -0,0 +1,36 @@ +# PresentTimestamp + +## **概述** + +**所属模块:** + +[Display](_display.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + +

Public 属性

+

描述

+

type

+

上屏时间戳类型

+

time

+

类型对应的值

+
+ +## **详细描述** + +上屏时间戳结构体定义。 + diff --git a/zh-cn/device-dev/api/toctopics/_property_object.md b/zh-cn/device-dev/api/toctopics/_property_object.md new file mode 100644 index 0000000000..8002991443 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_property_object.md @@ -0,0 +1,41 @@ +# PropertyObject + +## **概述** + +**所属模块:** + +[Display](_display.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

name [PROPERTY_NAME_LEN]

+

属性名称

+

propId

+

属性ID

+

value

+

属性值

+
+ +## **详细描述** + +定义包含名称、属性ID和值的属性对象。 + diff --git a/zh-cn/device-dev/api/toctopics/_range_value.md b/zh-cn/device-dev/api/toctopics/_range_value.md new file mode 100644 index 0000000000..64e6c5c96a --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_range_value.md @@ -0,0 +1,58 @@ +# RangeValue + +## **概述** + +**所属模块:** + +[Codec](_codec.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + +

Public 属性

+

描述

+

min

+

最小值

+

max

+

最大值

+
+ +## **详细描述** + +取值范围的定义。 + +## **类成员变量说明** + +## max + +``` +int32_t RangeValue::max +``` + +**描述：** + +最大值 + +## min + +``` +int32_t RangeValue::min +``` + +**描述：** + +最小值 + diff --git a/zh-cn/device-dev/api/toctopics/_rect.md b/zh-cn/device-dev/api/toctopics/_rect.md new file mode 100644 index 0000000000..66ad4baa6c --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_rect.md @@ -0,0 +1,58 @@ +# Rect + +## **概述** + +**所属模块:** + +[Codec](_codec.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + +

Public 属性

+

描述

+

width

+

矩形的宽

+

height

+

矩形的高

+
+ +## **详细描述** + +矩形的定义。 + +## **类成员变量说明** + +## height + +``` +int32_t Rect::height +``` + +**描述：** + +矩形的高 + +## width + +``` +int32_t Rect::width +``` + +**描述：** + +矩形的宽 + diff --git a/zh-cn/device-dev/api/toctopics/_rectangle.md b/zh-cn/device-dev/api/toctopics/_rectangle.md new file mode 100644 index 0000000000..5acf5fb4f5 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_rectangle.md @@ -0,0 +1,36 @@ +# Rectangle + +## **概述** + +**所属模块:** + +[Display](_display.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + +

Public 属性

+

描述

+

rect

+

矩形区域

+

color

+

矩形颜色

+
+ +## **详细描述** + +矩形描述结构体定义，用于硬件加速绘制矩形。 + diff --git a/zh-cn/device-dev/api/toctopics/_schedule_info.md b/zh-cn/device-dev/api/toctopics/_schedule_info.md new file mode 100644 index 0000000000..da045bb232 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_schedule_info.md @@ -0,0 +1,126 @@ +# ScheduleInfo + +## **概述** + +**所属模块:** + +[HdfUserAuth](_hdf_user_auth.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

scheduleId

+

调度ID，用于标识一次操作请求的执行器调度过程。

+

templateIds

+

模版ID列表。

+

authType

+

用户认证凭据类型。

+

executorType

+

执行器类型。

+

scheduleMode

+

调度模式，支持注册、认证和识别模式。

+

executors

+

执行器信息列表。

+
+ +## **详细描述** + +调度信息。 + +**Since：** + +3.2 + +**Version：** + +1.0 + +## **类成员变量说明** + +## authType + +``` +enum AuthType ScheduleInfo::authType +``` + +**描述：** + +用户认证凭据类型。 + +## executors + +``` +struct ExecutorInfo [] ScheduleInfo::executors +``` + +**描述：** + +执行器信息列表。 + +## executorType + +``` +unsigned int ScheduleInfo::executorType +``` + +**描述：** + +执行器类型。 + +## scheduleId + +``` +unsigned long ScheduleInfo::scheduleId +``` + +**描述：** + +调度ID，用于标识一次操作请求的执行器调度过程。 + +## scheduleMode + +``` +unsigned int ScheduleInfo::scheduleMode +``` + +**描述：** + +调度模式，支持注册、认证和识别模式。 + +## templateIds + +``` +unsigned long [] ScheduleInfo::templateIds +``` + +**描述：** + +模版id列表。 + diff --git a/zh-cn/device-dev/api/toctopics/_sensor.md b/zh-cn/device-dev/api/toctopics/_sensor.md new file mode 100644 index 0000000000..ed90db12ca --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_sensor.md @@ -0,0 +1,742 @@ +# Sensor + +## **汇总** + +## 文件 + + + + + + + + + + + + + +

文件

+

描述

+

sensor_if.h

+

Sensor模块对外通用的接口声明文件，提供获取传感器设备信息、订阅/去订阅传感器数据、 使能/去使能传感器、设置传感器模式、设置传感器精度，量程等可选配置接口定义。

+

sensor_type.h

+

定义传感器模块所使用的传感器类型，传感器信息，传感器数据结构等数据类型。

+
+ +## 类 + + + + + + + + + + + + + + + + +

类

+

描述

+

SensorInterface

+

提供sensor设备基本控制操作接口。 更多...

+

SensorInformation

+

定义传感器基本信息。 更多...

+

SensorEvents

+

上报传感器数据结构。 更多...

+
+ +## 宏定义 + + + + + + + + + + + + + +

宏定义

+

描述

+

SENSOR_NAME_MAX_LEN 32

+

Sensor名称的最大长度。

+

SENSOR_VERSION_MAX_LEN 16

+

Sensor版本号的最大长度。

+
+ +## 类型定义 + + + + + + + + + + +

类型定义

+

描述

+

(RecordDataCallback) (const struct SensorEvents *)

+

传感器上报数据回调函数的定义，传感器服务用户在订阅传感器时， 需要注册上报数据回调函数，传感器使能后，传感器服务用户可以接受到传感器数据，详见SensorInterface。 更多...

+
+ +## 枚举 + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举

+

描述

+

SensorStatus { SENSOR_SUCCESS = 0, SENSOR_FAILURE = -1, SENSOR_NOT_SUPPORT = -2, SENSOR_INVALID_PARAM = -3, SENSOR_INVALID_SERVICE = -4, SENSOR_NULL_PTR = -5 }

+

定义传感器模块返回值类型。 更多...

+

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 }

+

定义传感器类型标识。 更多...

+

SensorAccuracyType { SENSOR_NO_ACCURACY = 0, SENSOR_LOW_ACCURACY = 1, SENSOR_MEDIUM_ACCURACY = 2, SENSOR_HIGH_ACCURACY = 3, SENSOR_MAX_ACCURACY }

+

传感器的精度类型。 更多...

+

SensorRangeType { SENSOR_RANGE_LEVEL1 = 0, SENSOR_RANGE_LEVEL2 = 1, SENSOR_RANGE_LEVEL3 = 2, SENSOR_RANGE_LEVEL_MAX }

+

传感器的量程级别。 更多...

+

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 }

+

传感器的工作模式。 更多...

+

SensorGroupType { TRADITIONAL_SENSOR_TYPE = 0, MEDICAL_SENSOR_TYPE = 1, SENSOR_GROUP_TYPE_MAX }

+

枚举传感器的硬件服务组。 更多...

+
+ +## 函数 + + + + + + + + + + + + + +

函数

+

描述

+

NewSensorInterfaceInstance (void)

+

创建传感器接口实例。 更多...

+

FreeSensorInterfaceInstance (void)

+

释放传感器接口实例。 更多...

+
+ +## **详细描述** + +传感器设备驱动对传感器服务提供通用的接口能力。 + +模块提供传感器服务对传感器驱动访问统一接口，服务获取驱动对象或者代理后， 通过其提供的各类方法，以传感器id区分访问不同类型传感器设备，实现获取传感器设备信息、订阅/去订阅传感器数据、 使能/去使能传感器、设置传感器模式、设置传感器精度、量程等可选配置等。 + +**Since：** + +2.2 + +**Version：** + +1.0 + +## **宏定义说明** + +## SENSOR\_NAME\_MAX\_LEN + +``` +#define SENSOR_NAME_MAX_LEN 32 +``` + +**描述：** + +Sensor名称的最大长度。 + +## SENSOR\_VERSION\_MAX\_LEN + +``` +#define SENSOR_VERSION_MAX_LEN 16 +``` + +**描述：** + +Sensor版本号的最大长度。 + +## **类型定义说明** + +## RecordDataCallback + +``` +typedef int32_t(* RecordDataCallback) (const struct SensorEvents *) +``` + +**描述：** + +传感器上报数据回调函数的定义，传感器服务用户在订阅传感器时， 需要注册上报数据回调函数，传感器使能后，传感器服务用户可以接受到传感器数据，详见[SensorInterface](_sensor_interface.md)。 + +## **枚举类型说明** + +## SensorAccuracyType + +``` +enum SensorAccuracyType +``` + +**描述：** + +传感器的精度类型。 + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

SENSOR_NO_ACCURACY

+

无精度类型。

+

SENSOR_LOW_ACCURACY

+

低精度类型。

+

+

SENSOR_MEDIUM_ACCURACY

+

中等精度类型。

+

+

SENSOR_HIGH_ACCURACY

+

高精度类型。

+

+

SENSOR_MAX_ACCURACY

+

最大精度类型。

+

+
+ +## SensorGroupType + +``` +enum SensorGroupType +``` + +**描述：** + +枚举传感器的硬件服务组。 + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

TRADITIONAL_SENSOR_TYPE

+

传统传感器类型，传感器ID枚举值范围为128-160。

+

+

MEDICAL_SENSOR_TYPE

+

医疗传感器类型，传感器ID枚举值范围不在128-160之间。

+

+

SENSOR_GROUP_TYPE_MAX

+

最大传感器类型。

+

+
+ +## SensorModeType + +``` +enum SensorModeType +``` + +**描述：** + +传感器的工作模式。 + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

SENSOR_MODE_DEFAULT

+

传感器默认工作模式状态。

+

+

SENSOR_MODE_REALTIME

+

传感器实时工作模式状态，一组数据上报一次。

+

SENSOR_MODE_ON_CHANGE

+

传感器实时工作模式状态，状态变更上报一次。

+

+

SENSOR_MODE_ONE_SHOT

+

传感器实时工作模式状态，只上报一次。

+

+

SENSOR_MODE_FIFO_MODE

+

传感器缓存工作模式状态，根据配置的缓存大小上报。

+

+

SENSOR_MODE_MAX

+

传感器最大类型标识。

+

+
+ +## SensorRangeType + +``` +enum SensorRangeType +``` + +**描述：** + +传感器的量程级别。 + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

SENSOR_RANGE_LEVEL1

+

量程级别1。

+

SENSOR_RANGE_LEVEL2

+

量程级别2。

+

+

SENSOR_RANGE_LEVEL3

+

量程级别3。

+

+

SENSOR_RANGE_LEVEL_MAX

+

量程最大级别。

+

+
+ +## SensorStatus + +``` +enum SensorStatus +``` + +**描述：** + +定义传感器模块返回值类型。 + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

SENSOR_SUCCESS

+

传感器执行成功。

+

+

SENSOR_FAILURE

+

传感器执行失败。

+

+

SENSOR_NOT_SUPPORT

+

传感器不支持。

+

+

SENSOR_INVALID_PARAM

+

传感器无效参数。

+

+

SENSOR_INVALID_SERVICE

+

传感器无效服务。

+

+

SENSOR_NULL_PTR

+

传感器空指针。

+

+
+ +## SensorTypeTag + +``` +enum SensorTypeTag +``` + +**描述：** + +定义传感器类型标识。 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

SENSOR_TYPE_NONE

+

空传感器类型，用于测试。

+

+

SENSOR_TYPE_ACCELEROMETER

+

加速度传感器。

+

SENSOR_TYPE_GYROSCOPE

+

陀螺仪传感器。

+

+

SENSOR_TYPE_PHOTOPLETHYSMOGRAPH

+

心率传感器。

+

+

SENSOR_TYPE_ELECTROCARDIOGRAPH

+

心电传感器。

+

+

SENSOR_TYPE_AMBIENT_LIGHT

+

环境光传感器。

+

+

SENSOR_TYPE_MAGNETIC_FIELD

+

地磁传感器。

+

+

SENSOR_TYPE_CAPACITIVE

+

电容传感器。

+

+

SENSOR_TYPE_BAROMETER

+

气压计传感器。

+

+

SENSOR_TYPE_TEMPERATURE

+

温度传感器。

+

+

SENSOR_TYPE_HALL

+

霍尔传感器。

+

+

SENSOR_TYPE_GESTURE

+

手势传感器。

+

+

SENSOR_TYPE_PROXIMITY

+

接近光传感器。

+

+

SENSOR_TYPE_HUMIDITY

+

湿度传感器。

+

+

SENSOR_TYPE_MEDICAL_BEGIN

+

医疗传感器ID枚举值范围的开始。

+

+

SENSOR_TYPE_MEDICAL_END

+

医疗传感器ID枚举值范围的结束。

+

+

SENSOR_TYPE_PHYSICAL_MAX

+

物理传感器最大类型。

+

+

SENSOR_TYPE_ORIENTATION

+

方向传感器。

+

+

SENSOR_TYPE_GRAVITY

+

重力传感器。

+

+

SENSOR_TYPE_LINEAR_ACCELERATION

+

线性加速度传感器。

+

+

SENSOR_TYPE_ROTATION_VECTOR

+

旋转矢量传感器。

+

+

SENSOR_TYPE_AMBIENT_TEMPERATURE

+

环境温度传感器

+

+

SENSOR_TYPE_MAGNETIC_FIELD_UNCALIBRATED

+

未校准磁场传感器。

+

+

SENSOR_TYPE_GAME_ROTATION_VECTOR

+

游戏旋转矢量传感器。

+

+

SENSOR_TYPE_GYROSCOPE_UNCALIBRATED

+

未校准陀螺仪传感器。

+

+

SENSOR_TYPE_SIGNIFICANT_MOTION

+

大幅度动作传感器。

+

+

SENSOR_TYPE_PEDOMETER_DETECTION

+

计步器检测传感器。

+

+

SENSOR_TYPE_PEDOMETER

+

计步器传感器。

+

+

SENSOR_TYPE_GEOMAGNETIC_ROTATION_VECTOR

+

地磁旋转矢量传感器。

+

+

SENSOR_TYPE_HEART_RATE

+

心率传感器。

+

+

SENSOR_TYPE_DEVICE_ORIENTATION

+

设备方向传感器。

+

+

SENSOR_TYPE_WEAR_DETECTION

+

佩戴检测传感器。

+

+

SENSOR_TYPE_ACCELEROMETER_UNCALIBRATED

+

未校准加速度传感器。

+

+

SENSOR_TYPE_MAX

+

传感器类型最大个数。

+

+
+ +## **函数说明** + +## FreeSensorInterfaceInstance\(\) + +``` +int32_t FreeSensorInterfaceInstance (void ) +``` + +**描述：** + +释放传感器接口实例。 + +**返回：** + +如果释放实例成功，则返回0。 + +如果释放实例失败，则返回负值。 + +**Since：** + +2.2 + +**Version：** + +1.0 + +## NewSensorInterfaceInstance\(\) + +``` +const struct SensorInterface* NewSensorInterfaceInstance (void ) +``` + +**描述：** + +创建传感器接口实例。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

sensorId

+

表示传感器ID。有关详细信息，详见SensorTypeTag。

+

cb

+

表示要注册的回调函数。有关详细信息，详见RecordDataCallback。

+
+ +**返回：** + +如果创建实例成功，则返回非零值。 + +如果创建实例失败，则返回负值。 + +**Since：** + +2.2 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/_sensor_events.md b/zh-cn/device-dev/api/toctopics/_sensor_events.md new file mode 100644 index 0000000000..483d07125e --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_sensor_events.md @@ -0,0 +1,139 @@ +# SensorEvents + +## **概述** + +**所属模块:** + +[Sensor](_sensor.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

sensorId

+

传感器的标识号。

+

version

+

传感器算法版本号。

+

timestamp

+

传感器数据生成时间。

+

option

+

传感器量程精度可选配置。

+

mode

+

传感器工作模式。

+

data

+

传感器数据地址。

+

dataLen

+

传感器数据长度。

+
+ +## **详细描述** + +上报传感器数据结构。 + +上报传感器设备数据事件信息包括传感器的标识号、传感器算法版本号、传感器数据生成时间、传感器量程精度可选配置、传感器工作模式、传感器数据地址、传感器数据长度。 + +**Since：** + +2.2 + +## **类成员变量说明** + +## data + +``` +uint8_t* SensorEvents::data +``` + +**描述：** + +传感器数据地址。 + +## mode + +``` +int32_t SensorEvents::mode +``` + +**描述：** + +传感器工作模式。 + +## option + +``` +uint32_t SensorEvents::option +``` + +**描述：** + +传感器量程精度可选配置。 + +## sensorId + +``` +int32_t SensorEvents::sensorId +``` + +**描述：** + +传感器的标识号。 + +## timestamp + +``` +int64_t SensorEvents::timestamp +``` + +**描述：** + +传感器数据生成时间。 + +## version + +``` +int32_t SensorEvents::version +``` + +**描述：** + +传感器算法版本号。 + +## dataLen + +``` +int32_t SensorEvents::dataLen +``` + +**描述：** + +传感器算法版本号。 + diff --git a/zh-cn/device-dev/api/toctopics/_sensor_information.md b/zh-cn/device-dev/api/toctopics/_sensor_information.md new file mode 100644 index 0000000000..ca4f7f7412 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_sensor_information.md @@ -0,0 +1,170 @@ +# SensorInformation + +## **概述** + +**所属模块:** + +[Sensor](_sensor.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

sensorName [SENSOR_NAME_MAX_LEN]

+

传感器名称。

+

vendorName [SENSOR_NAME_MAX_LEN]

+

传感器设备厂商。

+

firmwareVersion [SENSOR_VERSION_MAX_LEN]

+

传感器固件版本号。

+

hardwareVersion

+

[SENSOR_VERSION_MAX_LEN]

+

传感器硬件版本号。

+

sensorTypeId

+

传感器类型编号，

+

sensorId

+

传感器的标识号，有传感器驱动开发者定义。

+

maxRange

+

传感器的最大量程。

+

accuracy

+

传感器的精度。

+

power

+

传感器的功耗。

+
+ +## **详细描述** + +定义传感器基本信息。 + +一个传感器设备信息包括传感器名字、设备厂商、固件版本号、硬件版本号、传感器类型编号、传感器标识、最大量程、精度、功耗。 + +**Since：** + +2.2 + +## **类成员变量说明** + +## accuracy + +``` +float SensorInformation::accuracy +``` + +**描述：** + +传感器的精度。 + +## firmwareVersion + +``` +char SensorInformation::firmwareVersion[SENSOR_VERSION_MAX_LEN] +``` + +**描述：** + +传感器固件版本号。 + +## hardwareVersion + +``` +char SensorInformation::hardwareVersion[SENSOR_VERSION_MAX_LEN] +``` + +**描述：** + +传感器硬件版本号。 + +## maxRange + +``` +float SensorInformation::maxRange +``` + +**描述：** + +传感器的最大量程。 + +## sensorId + +``` +int32_t SensorInformation::sensorId +``` + +**描述：** + +传感器的标识号，有传感器驱动开发者定义。 + +## sensorName + +``` +char SensorInformation::sensorName[SENSOR_NAME_MAX_LEN] +``` + +**描述：** + +传感器名称。 + +## sensorTypeId + +``` +int32_t SensorInformation::sensorTypeId +``` + +**描述：** + +传感器类型编号，唯一标识一个传感器设备类型，详见[SensorTypeTag](_sensor.md#gaea6a2a57db175118e08189b73f8f3da5)。 + +## vendorName + +``` +char SensorInformation::vendorName[SENSOR_NAME_MAX_LEN] +``` + +**描述：** + +传感器设备厂商。 + +## power + +``` +char SensorInformation::power +``` + +**描述：** + +传感器的功耗。 + diff --git a/zh-cn/device-dev/api/toctopics/_sensor_interface.md b/zh-cn/device-dev/api/toctopics/_sensor_interface.md new file mode 100644 index 0000000000..06dd45ca7f --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_sensor_interface.md @@ -0,0 +1,369 @@ +# SensorInterface + +## **概述** + +**所属模块:** + +[Sensor](_sensor.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

( GetAllSensors )([out] struct SensorInformation **sensorInfo, [out] int32_t *count)

+

获取当前系统中所有类型的传感器信息。 更多...

+

( Enable )([in] int32_t sensorId)

+

根据传感器设备类型标识使能传感器信息列表里存在的设备，只有数据订阅者使能传感器后，才能获取订阅的传感器数据。 更多...

+

( Disable )([in] int32_t sensorId)

+

根据传感器设备类型标识去使能传感器信息列表里存在的设备。 更多...

+

( SetBatch )([in] int32_t sensorId, [in] int64_t samplingInterval, [in] int64_t reportInterval)

+

设置指定传感器的数据采样间隔和数据上报间隔。 更多...

+

( SetMode )([in] int32_t sensorId, [in] int32_t mode)

+

设置指定传感器的数据上报模式，不同的工作模式，上报数据的方式不同。 更多...

+

( SetOption )([in] int32_t sensorId, [in] uint32_t option)

+

设置指定传感器量程、精度等可选配置。 更多...

+

( Register )([in] int32_t groupId, [in] RecordDataCallback cb)

+

订阅者注册传感器数据回调函数，系统会将获取到的传感器数据上报给订阅者。 更多...

+

( Unregister )([in] int32_t groupId, [in] RecordDataCallback cb)

+

订阅者去注册传感器数据回调函数。 更多...

+
+ +## **详细描述** + +提供sensor设备基本控制操作接口。 + +结构体提供获取传感器设备信息、订阅/去订阅传感器数据、使能/去使能传感器、设置传感器模式、设置传感器精度、量程等可选配置接口定义。 + +## **类成员变量说明** + +## Disable + +``` +int32_t(* SensorInterface::Disable) ([in] int32_t sensorId) +``` + +**描述：** + +根据传感器设备类型标识去使能传感器信息列表里存在的设备。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

sensorId

+

唯一标识一个传感器设备类型，详见SensorTypeTag。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +## Enable + +``` +int32_t(* SensorInterface::Enable) ([in] int32_t sensorId) +``` + +**描述：** + +根据传感器设备类型标识使能传感器信息列表里存在的设备，只有数据订阅者使能传感器后，才能获取订阅的传感器数据。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

sensorId

+

唯一标识一个传感器设备类型，详见SensorTypeTag。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +## GetAllSensors + +``` +int32_t(* SensorInterface::GetAllSensors) ([out] struct SensorInformation **sensorInfo,[out] int32_t *count) +``` + +**描述：** + +获取当前系统中所有类型的传感器信息。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

sensorInfo

+

输出系统中注册的所有传感器信息，一种类型传感器信息包括传感器名字、设备厂商、 固件版本号、硬件版本号、传感器类型编号、传感器标识、最大量程、精度、功耗，详见SensorInformation。

+

count

+

输出系统中注册的传感器数量。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +## Register + +``` +int32_t(* SensorInterface::Register) ([in] int32_t groupId,[in] RecordDataCallback cb) +``` + +**描述：** + +订阅者注册传感器数据回调函数，系统会将获取到的传感器数据上报给订阅者。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

groupId

+

传感器组ID。 sensorId枚举值范围为128-160，表示已订阅医疗传感器服务，只需成功订阅一次，无需重复订阅。 sensorId枚举值范围不在128-160之间，这意味着传统传感器已订阅，只需成功订阅一次，无需重复订阅。

+

cb

+

要注册的回调函数，详见RecordDataCallback。

+
+ +**返回：** + +如果注册回调函数成功，则返回0。 + +如果注册回调函数失败，则返回负数。 + +## SetBatch + +``` +int32_t(* SensorInterface::SetBatch) ([in] int32_t sensorId,[in] int64_t samplingInterval,[in] int64_t reportInterval) +``` + +**描述：** + +设置指定传感器的数据采样间隔和数据上报间隔。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

sensorId

+

唯一标识一个传感器设备类型，详见SensorTypeTag。

+

samplingInterval

+

设置指定传感器的数据采样间隔，单位纳秒。

+

reportInterval

+

表示传感器数据上报间隔，单位纳秒。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +## SetMode + +``` +int32_t(* SensorInterface::SetMode) ([in] int32_t sensorId,[in] int32_t mode) +``` + +**描述：** + +设置指定传感器的数据上报模式，不同的工作模式，上报数据的方式不同。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

sensorId

+

唯一标识一个传感器设备类型，详见SensorTypeTag。

+

mode

+

传感器的数据上报模式，详见SensorModeType。

+
+ +**返回：** + +如果设置传感器数据报告模式成功，则返回0。 + +如果设置传感器数据报告模式失败，则返回负数。 + +## SetOption + +``` +int32_t(* SensorInterface::SetOption) ([in] int32_t sensorId,[in] uint32_t option) +``` + +**描述：** + +设置指定传感器量程、精度等可选配置。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

sensorId

+

唯一标识一个传感器设备类型，详见SensorTypeTag。

+

option

+

传感器的量程、精度等配置。

+
+ +**返回：** + +如果设置参数成功，则返回0。 + +如果设置参数失败，则返回负数。 + +## Unregister + +``` +int32_t(* SensorInterface::Unregister) ([in] int32_t groupId,[in] RecordDataCallback cb) +``` + +**描述：** + +订阅者去注册传感器数据回调函数。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

groupId

+

传感器组ID。 sensorId枚举值范围为128-160，表示已订阅医疗传感器服务。只需成功取消订阅一次，无需重复取消订阅。 sensorId枚举值范围不在128-160之间，这意味着传统传感器已订阅。并且成功取消订阅。

+

cb

+

要注册的回调函数，详见RecordDataCallback。

+
+ +**返回：** + +如果取消注册回调函数成功，则返回0。 + +如果取消注册回调函数失败，则返回负数。 + diff --git a/zh-cn/device-dev/api/toctopics/_sta_info.md b/zh-cn/device-dev/api/toctopics/_sta_info.md new file mode 100644 index 0000000000..3f636ecf15 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_sta_info.md @@ -0,0 +1,51 @@ +# StaInfo + +## **概述** + +**所属模块:** + +[WLAN](_w_l_a_n.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + +

Public 属性

+

描述

+

mac [WIFI_MAC_ADDR_LENGTH]

+

STA的MAC地址

+
+ +## **详细描述** + +描述与AP连接的STA的基本信息。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## **类成员变量说明** + +## mac + +``` +unsigned char StaInfo::mac[WIFI_MAC_ADDR_LENGTH] +``` + +**描述：** + +STA的MAC地址。 + diff --git a/zh-cn/device-dev/api/toctopics/_support_buffer_type.md b/zh-cn/device-dev/api/toctopics/_support_buffer_type.md new file mode 100644 index 0000000000..f3ad71eab8 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_support_buffer_type.md @@ -0,0 +1,88 @@ +# SupportBufferType + +## **概述** + +**所属模块:** + +[Codec](_codec.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

size

+

结构体大小

+

version

+

组件版本信息

+

portIndex

+

端口索引

+

bufferTypes

+

支持的所有Buffer类型

+
+ +## **详细描述** + +SupportBuffer类型定义。 + +## **类成员变量说明** + +## bufferTypes + +``` +uint32_t SupportBufferType::bufferTypes +``` + +**描述：** + +支持的所有Buffer类型 + +## portIndex + +``` +uint32_t SupportBufferType::portIndex +``` + +**描述：** + +端口索引 + +## size + +``` +uint32_t SupportBufferType::size +``` + +**描述：** + +结构体大小 + +## version + +``` +union OMX_VERSIONTYPE SupportBufferType::version +``` + +**描述：** + +组件版本信息 + diff --git a/zh-cn/device-dev/api/toctopics/_template_info.md b/zh-cn/device-dev/api/toctopics/_template_info.md new file mode 100644 index 0000000000..14da99a8d4 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_template_info.md @@ -0,0 +1,96 @@ +# TemplateInfo + +## **概述** + +**所属模块:** + +[HdfFaceAuth](_hdf_face_auth.md) | [HdfPinAuth](_hdf_pin_auth.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

executorType

+

执行器类型，根据执行器支持的算法类型进行分类。

+

freezingTime

+

认证方式被冻结的时间。

+

remainTimes

+

认证方式距离被冻结的可处理认证请求次数。

+

extraInfo

+

其他相关信息，用于支持信息扩展。

+
+ +## **详细描述** + +凭据模版信息。 + +**Since：** + +3.2 + +**Version：** + +1.0 + +## **类成员变量说明** + +## executorType + +``` +unsigned int TemplateInfo::executorType +``` + +**描述：** + +执行器类型，根据执行器支持的算法类型进行分类。 + +## extraInfo + +``` +unsigned char [] TemplateInfo::extraInfo +``` + +**描述：** + +其他相关信息，用于支持信息扩展。 + +## freezingTime + +``` +int TemplateInfo::freezingTime +``` + +**描述：** + +认证方式被冻结的时间。 + +## remainTimes + +``` +int TemplateInfo::remainTimes +``` + +**描述：** + +认证方式距离被冻结的可处理认证请求次数。 + diff --git a/zh-cn/device-dev/api/toctopics/_thermal_types_8idl.md b/zh-cn/device-dev/api/toctopics/_thermal_types_8idl.md new file mode 100644 index 0000000000..cffdfede0b --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_thermal_types_8idl.md @@ -0,0 +1,63 @@ +# ThermalTypes.idl + +## **概述** + +**所属模块:** + +[Thermal](thermal.md) + +## **汇总** + +## 类 + + + + + + + + + + + + + +

类

+

描述

+

ThermalZoneInfo

+

设备发热的信息。 更多...

+

HdfThermalCallbackInfo

+

设备发热的信息列表。 更多...

+
+ +## 变量 + + + + + + + + + + +

变量 名称

+

描述

+

package ohos.hdi.thermal.v1_0

+

设备温度管理接口的包路径

+
+ +## **详细描述** + +设备发热状态相关的数据类型。 + +热管理中使用的数据类型，包括设备发热的信息和设备发热的信息列表。 + +**Since：** + +3.1 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/_thermal_zone_info.md b/zh-cn/device-dev/api/toctopics/_thermal_zone_info.md new file mode 100644 index 0000000000..42378f53b1 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_thermal_zone_info.md @@ -0,0 +1,62 @@ +# ThermalZoneInfo + +## **概述** + +**所属模块:** + +[Thermal](thermal.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + +

Public 属性

+

描述

+

type

+

发热器件的类型。

+

temp

+

器件的温度值。

+
+ +## **详细描述** + +设备发热的信息。 + +**Since：** + +3.1 + +## **类成员变量说明** + +## temp + +``` +int ThermalZoneInfo::temp +``` + +**描述：** + +器件的温度值。 + +## type + +``` +String ThermalZoneInfo::type +``` + +**描述：** + +发热器件的类型。 + diff --git a/zh-cn/device-dev/api/toctopics/_types_8idl.md b/zh-cn/device-dev/api/toctopics/_types_8idl.md new file mode 100644 index 0000000000..da1c979b92 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_types_8idl.md @@ -0,0 +1,85 @@ +# Types.idl + +## **概述** + +**所属模块:** + +[Battery](battery.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

BatteryInfo

+

电池相关信息。 更多...

+
+ +## 枚举 + + + + + + + + + + + + + + + + +

枚举

+

描述

+

BatteryHealthState { BATTERY_HEALTH_UNKNOWN = 0, BATTERY_HEALTH_GOOD, BATTERY_HEALTH_OVERHEAT, BATTERY_HEALTH_OVERVOLTAGE, BATTERY_HEALTH_COLD, BATTERY_HEALTH_DEAD, BATTERY_HEALTH_RESERVED }

+

电池的健康状态。 更多...

+

BatteryChargeState { CHARGE_STATE_NONE = 0, CHARGE_STATE_ENABLE, CHARGE_STATE_DISABLE, CHARGE_STATE_FULL, CHARGE_STATE_RESERVED }

+

电池的充电状态。 更多...

+

BatteryPluggedType { PLUGGED_TYPE_NONE = 0, PLUGGED_TYPE_AC, PLUGGED_TYPE_USB, PLUGGED_TYPE_WIRELESS, PLUGGED_TYPE_BUTT }

+

电池的充电设备类型。 更多...

+
+ +## 变量 + + + + + + + + + + +

变量 名称

+

描述

+

package ohos.hdi.battery.v1_0

+

电池信息接口的包路径

+
+ +## **详细描述** + +电池信息相关数据类型。 + +电池信息中使用的数据类型，包括健康状态、充电状态、充电设备类型和电池信息结构。 + +**Since：** + +3.1 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/_u_s_b.md b/zh-cn/device-dev/api/toctopics/_u_s_b.md new file mode 100644 index 0000000000..1ad29a5250 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_u_s_b.md @@ -0,0 +1,2664 @@ +# USB + +## **汇总** + +## 文件 + + + + + + + + + + + + + + + + + + + +

文件

+

描述

+

usb_info.h

+

USB驱动订阅模块使用的数据类型。

+

usbd_client.h

+

声明标准USB驱动接口函数。

+

usbd_subscriber.h

+

USB驱动订阅模块。

+

usbd_type.h

+

USB驱动模块接口定义中使用的自定义数据类型。

+
+ +## 类 + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

类

+

描述

+

OHOS::USB::USBDeviceInfo

+

USB设备信息。 更多...

+

OHOS::USB::UsbInfo

+

USB设备信息类。 更多...

+

OHOS::USB::UsbdClient

+

Usb驱动类。更多...

+

OHOS::USB::UsbdSubscriber

+

订阅类。更多...

+

OHOS::USB::UsbDev

+

USB设备。 更多...

+

OHOS::USB::UsbPipe

+

管道信息。 更多...

+

OHOS::USB::UsbCtrlTransfer

+

USB控制传输。 更多...

+
+ +## 宏定义 + + + + + + + + + + +

宏定义

+

描述

+

USB_MAX_INTERFACES 32

+

USB设备最大接口数量。

+
+ +## 类型定义 + + + + + + + + + + +

类型定义

+

描述

+

(UsbdRequestCallback) (uint8_t *requestArg)

+

请求回调函数。更多...

+
+ +## 枚举 + + + + + + + + + + + + + +

枚举

+

描述

+

UsbdBulkCbCmd { CMD_USBD_BULK_CALLBACK_READ, CMD_USBD_BULK_CALLBACK_WRITE }

+

批量回调命令字。 更多...

+

UsbdDeviceAction { ACT_DEVUP = 0, ACT_DEVDOWN, ACT_UPDEVICE, ACT_DOWNDEVICE }

+

主机端和设备端插拔事件。 更多...

+
+ +## 函数 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

函数

+

描述

+

OHOS::USB::UsbInfo::setDevInfoStatus (int32_t status)

+

设置USB设备状态。 更多...

+

OHOS::USB::UsbInfo::setDevInfoBusNum (int32_t busNum)

+

设置USB总线编号。 更多...

+

OHOS::USB::UsbInfo::setDevInfoDevNum (int32_t devNum)

+

设置USB设备编号。 更多...

+

OHOS::USB::UsbInfo::getDevInfoStatus () const

+

获取USB设备状态。 更多...

+

OHOS::USB::UsbInfo::getDevInfoBusNum () const

+

获取USB总线编号。 更多...

+

OHOS::USB::UsbInfo::getDevInfoDevNum () const

+

获取USB设备编号。 更多...

+

OHOS::USB::UsbdClient::GetInstance ()

+

获取实例。

+

OHOS::USB::UsbdClient::OpenDevice (const UsbDev &dev)

+

打开设备，建立连接。 更多...

+

OHOS::USB::UsbdClient::CloseDevice (const UsbDev &dev)

+

关闭设备，释放与设备相关的所有系统资源。 更多...

+

OHOS::USB::UsbdClient::GetDeviceDescriptor (const UsbDev &dev, std::vector< uint8_t > &descriptor)

+

获取设备描述符。 更多...

+

OHOS::USB::UsbdClient::GetStringDescriptor (const UsbDev &dev, uint8_t descId, std::vector< uint8_t > &descriptor)

+

根据String ID获取设备的字符串描述符。 更多...

+

OHOS::USB::UsbdClient::GetConfigDescriptor (const UsbDev &dev, uint8_t descId, std::vector< uint8_t > &descriptor)

+

根据config ID获取设备的配置描述符config。 更多...

+

OHOS::USB::UsbdClient::GetRawDescriptor (const UsbDev &dev, std::vector< uint8_t > &descriptor)

+

获取原始描述符。 更多...

+

OHOS::USB::UsbdClient::GetFileDescriptor (const UsbDev &dev, int32_t &fd)

+

获取文件描述符。 更多...

+

OHOS::USB::UsbdClient::SetConfig (const UsbDev &dev, uint8_t configIndex)

+

设置当前的config信息。 更多...

+

OHOS::USB::UsbdClient::GetConfig (const UsbDev &dev, uint8_t &configIndex)

+

获取当前的config信息。 更多...

+

OHOS::USB::UsbdClient::ClaimInterface (const UsbDev &dev, uint8_t interfaceid, uint8_t force)

+

打开接口，并声明独占接口，必须在数据传输前执行。 更多...

+

OHOS::USB::UsbdClient::ReleaseInterface (const UsbDev &dev, uint8_t interfaceid)

+

关闭接口，释放接口的占用，在停止数据传输后执行。 更多...

+

OHOS::USB::UsbdClient::SetInterface (const UsbDev &dev, uint8_t interfaceid, uint8_t altIndex)

+

设置指定接口的备选设置，用于在具有相同ID但不同备用设置的两个接口之间进行选择。 更多...

+

OHOS::USB::UsbdClient::BulkTransferRead (const UsbDev &dev, const UsbPipe &pipe, int32_t timeout, std::vector< uint8_t > &data)

+

在给定端点上执行批量数据读取，返回读取的数据和长度，端点方向必须为数据读取，可以设置超时时间。 更多...

+

OHOS::USB::UsbdClient::BulkTransferWrite (const UsbDev &dev, const UsbPipe &pipe, int32_t timeout, const std::vector< uint8_t > &data)

+

在给定端点上执行批量数据写入， 返回读取的数据和长度，端点方向必须为数据写入。 更多...

+

OHOS::USB::UsbdClient::ControlTransfer (const UsbDev &dev, const UsbCtrlTransfer &ctrl, std::vector< uint8_t > &data)

+

对此设备执行端点零的控制事务，传输方向由请求类型决定。 如果requestType＆ USB_ENDPOINT_DIR_MASK是USB_DIR_OUT ，则传输是写入，如果是USB_DIR_IN ，则传输是读取。 更多...

+

OHOS::USB::UsbdClient::InterruptTransferRead (const UsbDev &dev, const UsbPipe &pipe, int32_t timeout, std::vector< uint8_t > &data)

+

在给定端点上执行中断数据读取， 返回读取的数据和长度，端点方向必须为数据读取。 更多...

+

OHOS::USB::UsbdClient::InterruptTransferWrite (const UsbDev &dev, const UsbPipe &pipe, int32_t timeout, std::vector< uint8_t > &data)

+

在给定端点上执行中断数据写入， 返回读取的数据和长度，端点方向必须为数据写入。 更多...

+

OHOS::USB::UsbdClient::IsoTransferRead (const UsbDev &dev, const UsbPipe &pipe, int32_t timeout, std::vector< uint8_t > &data)

+

在给定端点上执行等时数据读取， 返回读取的数据和长度，端点方向必须为数据读取。 更多...

+

OHOS::USB::UsbdClient::IsoTransferWrite (const UsbDev &dev, const UsbPipe &pipe, int32_t timeout, std::vector< uint8_t > &data)

+

在给定端点上执行等时数据写入， 返回读取的数据和长度，端点方向必须为数据写入。 更多...

+

OHOS::USB::UsbdClient::RequestQueue (const UsbDev &dev, const UsbPipe &pipe, const std::vector< uint8_t > &clientData, const std::vector< uint8_t > &buffer)

+

将指定的端点进行异步数据发送或者接收请求，数据传输方向由端点方向决定。 更多...

+

OHOS::USB::UsbdClient::RequestWait (const UsbDev &dev, std::vector< uint8_t > &clientData, std::vector< uint8_t > &buffer, int32_t timeout)

+

等待RequestQueue异步请求的操作结果。 更多...

+

OHOS::USB::UsbdClient::RequestCancel (const UsbDev &dev, const UsbPipe &pipe)

+

取消待处理的数据请求。 更多...

+

OHOS::USB::UsbdClient::GetCurrentFunctions (int32_t &funcs)

+

获取从设备支持的功能列表（按位域表示）（从设备）。 更多...

+

OHOS::USB::UsbdClient::SetCurrentFunctions (int32_t funcs)

+

设置从设备支持的功能列表（按位域表示）（从设备）。 更多...

+

OHOS::USB::UsbdClient::SetPortRole (int32_t portId, int32_t powerRole, int32_t dataRole)

+

设置port端口的角色。 更多...

+

OHOS::USB::UsbdClient::QueryPort (int32_t &portId, int32_t &powerRole, int32_t &dataRole, int32_t &mode)

+

查询port端口的当前设置。 更多...

+

OHOS::USB::UsbdClient::BindUsbdSubscriber (const sptr< UsbdSubscriber > &subscriber)

+

绑定订阅者。 更多...

+

OHOS::USB::UsbdClient::UnbindUsbdSubscriber (const sptr< UsbdSubscriber > &subscriber)

+

解绑订阅者。 更多...

+

OHOS::USB::UsbdClient::RegBulkCallback (const UsbDev &dev, const UsbPipe &pipe, const sptr< IRemoteObject > &cb)

+

注册批量传输异步回调函数。 更多...

+

OHOS::USB::UsbdClient::UnRegBulkCallback (const UsbDev &dev, const UsbPipe &pipe)

+

注销批量传输异步回调函数。 更多...

+

OHOS::USB::UsbdClient::BulkRead (const UsbDev &dev, const UsbPipe &pipe, sptr< Ashmem > &ashmem)

+

批量传输异步读数据。 更多...

+

OHOS::USB::UsbdClient::BulkWrite (const UsbDev &dev, const UsbPipe &pipe, sptr< Ashmem > &ashmem)

+

批量传输异步写数据。 更多...

+

OHOS::USB::UsbdClient::BulkCancel (const UsbDev &dev, const UsbPipe &pipe)

+

批量传输异步取消接口，用于取消当前接口的异步批量读写操作。 更多...

+

OHOS::USB::UsbdSubscriber::DeviceEvent (const UsbInfo &info)=0

+

设备事件。 更多...

+

OHOS::USB::UsbdSubscriber::PortChangedEvent (int32_t portId, int32_t powerRole, int32_t dataRole, int32_t mode)=0

+

端口改变事件。 更多...

+

OHOS::USB::UsbdSubscriber::OnRemoteRequest (uint32_t code, MessageParcel &data, MessageParcel &reply, MessageOption &option) override

+

远程请求。 更多...

+
+ +## 变量 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

变量 名称

+

描述

+

OHOS::USB::USBDeviceInfo::status

+

USB设备状态

+

OHOS::USB::USBDeviceInfo::busNum

+

USB总线编号

+

OHOS::USB::USBDeviceInfo::devNum

+

USB设备编号

+

OHOS::USB::UsbDev::busNum

+

USB总线编号

+

OHOS::USB::UsbDev::devAddr

+

USB设备地址

+

OHOS::USB::UsbPipe::interfaceId

+

USB设备接口ID

+

OHOS::USB::UsbPipe::endpointId

+

USB设备端点ID

+

OHOS::USB::UsbCtrlTransfer::requestType

+

请求类型

+

OHOS::USB::UsbCtrlTransfer::requestCmd

+

请求命令字

+

OHOS::USB::UsbCtrlTransfer::value

+

请求值

+

OHOS::USB::UsbCtrlTransfer::index

+

索引

+

OHOS::USB::UsbCtrlTransfer::timeout

+

超时时间

+
+ +## **详细描述** + +定义（USB）功能的标准API接口。 + +该模块用于获取描述符、接口对象、请求对象和提交请求的自定义数据类型和函数。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## **宏定义说明** + +## USB\_MAX\_INTERFACES + +``` +#define USB_MAX_INTERFACES 32 +``` + +**描述：** + +USB设备最大接口数量 + +## **类型定义说明** + +## UsbdRequestCallback + +``` +typedef void(* UsbdRequestCallback) (uint8_t *requestArg) +``` + +**描述：** + +请求回调函数 + +## **枚举类型说明** + +## UsbdBulkCbCmd + +``` +enum UsbdBulkCbCmd +``` + +**描述：** + +批量回调命令字。 + + + + + + + + + + + + + +

枚举值

+

描述

+

CMD_USBD_BULK_CALLBACK_READ

+

批量回调读取

+

+

CMD_USBD_BULK_CALLBACK_WRITE

+

批量回调写入

+

+
+ +## UsbdDeviceAction + +``` +enum UsbdDeviceAction +``` + +**描述：** + +主机端和设备端插拔事件。 + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

ACT_DEVUP

+

主机端接入设备

+

+

ACT_DEVDOWN

+

主机端拔出设备

+

+

ACT_UPDEVICE

+

设备连接

+

+

ACT_DOWNDEVICE

+

设备断开

+

+
+ +## **函数说明** + +## BindUsbdSubscriber\(\) + +``` +int32_t OHOS::USB::UsbdClient::BindUsbdSubscriber (const sptr< UsbdSubscriber > & subscriber) +``` + +**描述：** + +绑定订阅者。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

subscriber

+

输入参数，订阅者信息，详见UsbdSubscriber。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## BulkCancel\(\) + +``` +int32_t OHOS::USB::UsbdClient::BulkCancel (const UsbDev & dev, const UsbPipe & pipe ) +``` + +**描述：** + +批量传输异步取消接口，用于取消当前接口的异步批量读写操作。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

dev

+

输入参数，USB设备地址信息，详见UsbDev。

+

pipe

+

输入参数，USB设备pipe信息，详见UsbPipe。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## BulkRead\(\) + +``` +int32_t OHOS::USB::UsbdClient::BulkRead (const UsbDev & dev, const UsbPipe & pipe, sptr< Ashmem > & ashmem ) +``` + +**描述：** + +批量传输异步读数据。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

dev

+

输入参数，USB设备地址信息，详见UsbDev。

+

pipe

+

输入参数，USB设备pipe信息，详见UsbPipe。

+

ashmem

+

输出参数，为共享内存，用于存放读取的数据，详见Ashmem。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## BulkTransferRead\(\) + +``` +int32_t OHOS::USB::UsbdClient::BulkTransferRead (const UsbDev & dev, const UsbPipe & pipe, int32_t timeout, std::vector< uint8_t > & data ) +``` + +**描述：** + +在给定端点上执行批量数据读取，返回读取的数据和长度，端点方向必须为数据读取，可以设置超时时间。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

dev

+

输入参数，USB设备地址信息，详见UsbDev。

+

pipe

+

输入参数，USB设备pipe信息，详见UsbPipe。

+

timeout

+

输入参数，超时时间。

+

data

+

输出参数，获取写入的数据。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## BulkTransferWrite\(\) + +``` +int32_t OHOS::USB::UsbdClient::BulkTransferWrite (const UsbDev & dev, const UsbPipe & pipe, int32_t timeout, const std::vector< uint8_t > & data ) +``` + +**描述：** + +在给定端点上执行批量数据写入， 返回读取的数据和长度，端点方向必须为数据写入。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

dev

+

输入参数，USB设备地址信息，详见UsbDev。

+

pipe

+

输入参数，USB设备pipe信息，详见UsbPipe。

+

timeout

+

输入参数，超时时间。

+

data

+

输入参数，写入的数据。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## BulkWrite\(\) + +``` +int32_t OHOS::USB::UsbdClient::BulkWrite (const UsbDev & dev, const UsbPipe & pipe, sptr< Ashmem > & ashmem ) +``` + +**描述：** + +批量传输异步写数据。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

dev

+

输入参数，USB设备地址信息，详见UsbDev。

+

pipe

+

输入参数，USB设备pipe信息，详见UsbPipe。

+

ashmem

+

输入参数，为共享内存，用于存放需要写入的数据，详见Ashmem。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## ClaimInterface\(\) + +``` +int32_t OHOS::USB::UsbdClient::ClaimInterface (const UsbDev & dev, uint8_t interfaceid, uint8_t force ) +``` + +**描述：** + +打开接口，并声明独占接口，必须在数据传输前执行。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

dev

+

输入参数，USB设备地址信息，详见UsbDev。

+

interfaceid

+

输入参数，USB设备interface ID。

+

force

+

输入参数，是否强制: 1强制 0不强制。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## CloseDevice\(\) + +``` +int32_t OHOS::USB::UsbdClient::CloseDevice (const UsbDev & dev) +``` + +**描述：** + +关闭设备，释放与设备相关的所有系统资源。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

dev

+

输入参数，USB设备地址信息，详见UsbDev。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## ControlTransfer\(\) + +``` +int32_t OHOS::USB::UsbdClient::ControlTransfer (const UsbDev & dev, const UsbCtrlTransfer & ctrl, std::vector< uint8_t > & data ) +``` + +**描述：** + +对此设备执行端点零的控制事务，传输方向由请求类型决定。 如果requestType＆ USB\_ENDPOINT\_DIR\_MASK是USB\_DIR\_OUT ，则传输是写入，如果是USB\_DIR\_IN ，则传输是读取。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

dev

+

输入参数，USB设备地址信息，详见UsbDev。

+

ctrl

+

输入参数，USB设备控制数据包结构，详见UsbCtrlTransfer。

+

data

+

输入/输出参数，读取/写入的数据。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## DeviceEvent\(\) + +``` +virtual int32_t OHOS::USB::UsbdSubscriber::DeviceEvent (const UsbInfo & info) +``` + +**描述：** + +设备事件。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

UsbInfo

+

输入参数，USB设备信息。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## GetConfig\(\) + +``` +int32_t OHOS::USB::UsbdClient::GetConfig (const UsbDev & dev, uint8_t & configIndex ) +``` + +**描述：** + +获取当前的config信息。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

dev

+

输入参数，USB设备地址信息，详见UsbDev。

+

configIndex

+

输出参数，USB设备config信息。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## GetConfigDescriptor\(\) + +``` +int32_t OHOS::USB::UsbdClient::GetConfigDescriptor (const UsbDev & dev, uint8_t descId, std::vector< uint8_t > & descriptor ) +``` + +**描述：** + +根据config ID获取设备的配置描述符config。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

dev

+

输入参数，USB设备地址信息，详见UsbDev。

+

descId

+

输入参数，USB的config ID。

+

descriptor

+

输出参数，获取USB设备config信息。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## GetCurrentFunctions\(\) + +``` +int32_t OHOS::USB::UsbdClient::GetCurrentFunctions (int32_t & funcs) +``` + +**描述：** + +获取从设备支持的功能列表（按位域表示）（从设备）。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

funcs

+

输出参数，获取当前设备的function的值。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## GetDeviceDescriptor\(\) + +``` +int32_t OHOS::USB::UsbdClient::GetDeviceDescriptor (const UsbDev & dev, std::vector< uint8_t > & descriptor ) +``` + +**描述：** + +获取设备描述符。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

dev

+

输入参数，USB设备地址信息，详见UsbDev。

+

descriptor

+

输出参数，USB设备描述符信息。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## getDevInfoBusNum\(\) + +``` +int32_t OHOS::USB::UsbInfo::getDevInfoBusNum () const +``` + +**描述：** + +获取USB总线编号。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

status

+

输出参数，USB总线编号。

+
+ +**Since：** + +3.0 + +**Version：** + +1.0 + +## getDevInfoDevNum\(\) + +``` +int32_t OHOS::USB::UsbInfo::getDevInfoDevNum () const +``` + +**描述：** + +获取USB设备编号。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

status

+

输出参数，USB设备编号。

+
+ +**Since：** + +3.0 + +**Version：** + +1.0 + +## getDevInfoStatus\(\) + +``` +int32_t OHOS::USB::UsbInfo::getDevInfoStatus () const +``` + +**描述：** + +获取USB设备状态。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

status

+

输出参数，设备状态。

+
+ +**Since：** + +3.0 + +**Version：** + +1.0 + +## GetFileDescriptor\(\) + +``` +int32_t OHOS::USB::UsbdClient::GetFileDescriptor (const UsbDev & dev, int32_t & fd ) +``` + +**描述：** + +获取文件描述符。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

dev

+

输入参数，USB设备地址信息，详见UsbDev。

+

fd

+

输出参数，USB设备文件描述符。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## GetRawDescriptor\(\) + +``` +int32_t OHOS::USB::UsbdClient::GetRawDescriptor (const UsbDev & dev, std::vector< uint8_t > & descriptor ) +``` + +**描述：** + +获取原始描述符。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

dev

+

输入参数，USB设备地址信息，详见UsbDev。

+

descriptor

+

输出参数，USB设备原始描述符。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## GetStringDescriptor\(\) + +``` +int32_t OHOS::USB::UsbdClient::GetStringDescriptor (const UsbDev & dev, uint8_t descId, std::vector< uint8_t > & descriptor ) +``` + +**描述：** + +根据String ID获取设备的字符串描述符。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

dev

+

输入参数，USB设备地址信息，详见UsbDev。

+

descId

+

输入参数，USB的string ID。

+

descriptor

+

输出参数，获取USB设备config信息。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## InterruptTransferRead\(\) + +``` +int32_t OHOS::USB::UsbdClient::InterruptTransferRead (const UsbDev & dev, const UsbPipe & pipe, int32_t timeout, std::vector< uint8_t > & data ) +``` + +**描述：** + +在给定端点上执行中断数据读取， 返回读取的数据和长度，端点方向必须为数据读取。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

dev

+

输入参数，USB设备地址信息，详见UsbDev。

+

pipe

+

输入参数，USB设备pipe信息，详见UsbPipe。

+

timeout

+

输入参数，超时时间。

+

data

+

输出参数，读取的数据。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## InterruptTransferWrite\(\) + +``` +int32_t OHOS::USB::UsbdClient::InterruptTransferWrite (const UsbDev & dev, const UsbPipe & pipe, int32_t timeout, std::vector< uint8_t > & data ) +``` + +**描述：** + +在给定端点上执行中断数据写入， 返回读取的数据和长度，端点方向必须为数据写入。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

dev

+

输入参数，USB设备地址信息，详见UsbDev。

+

pipe

+

输入参数，USB设备pipe信息，详见UsbPipe。

+

timeout

+

输入参数，超时时间。

+

data

+

输入参数，写入的数据。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## IsoTransferRead\(\) + +``` +int32_t OHOS::USB::UsbdClient::IsoTransferRead (const UsbDev & dev, const UsbPipe & pipe, int32_t timeout, std::vector< uint8_t > & data ) +``` + +**描述：** + +在给定端点上执行等时数据读取， 返回读取的数据和长度，端点方向必须为数据读取。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

dev

+

输入参数，USB设备地址信息，详见UsbDev。

+

pipe

+

输入参数，USB设备pipe信息，详见UsbPipe。

+

timeout

+

输入参数，超时时间。

+

data

+

输出参数，读取的数据。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## IsoTransferWrite\(\) + +``` +int32_t OHOS::USB::UsbdClient::IsoTransferWrite (const UsbDev & dev, const UsbPipe & pipe, int32_t timeout, std::vector< uint8_t > & data ) +``` + +**描述：** + +在给定端点上执行等时数据写入， 返回读取的数据和长度，端点方向必须为数据写入。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

dev

+

输入参数，USB设备地址信息，详见UsbDev。

+

pipe

+

输入参数，USB设备pipe信息，详见UsbPipe。

+

timeout

+

输入参数，超时时间。

+

data

+

输入参数，读取的数据。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## OnRemoteRequest\(\) + +``` +int32_t OHOS::USB::UsbdSubscriber::OnRemoteRequest (uint32_t code, MessageParcel & data, MessageParcel & reply, MessageOption & option ) +``` + +**描述：** + +远程请求。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

code

+

输入参数，命令字。

+

data

+

输入参数，待解析的数据。

+

reply

+

输出参数，返回的数据。

+

option

+

输入参数，选项数据。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## OpenDevice\(\) + +``` +int32_t OHOS::USB::UsbdClient::OpenDevice (const UsbDev & dev) +``` + +**描述：** + +打开设备，建立连接。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

dev

+

输入参数，USB设备地址信息，详见UsbDev。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## PortChangedEvent\(\) + +``` +virtual int32_t OHOS::USB::UsbdSubscriber::PortChangedEvent (int32_t portId, int32_t powerRole, int32_t dataRole, int32_t mode ) +``` + +**描述：** + +端口改变事件。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

portId

+

输入参数，端口ID。

+

powerRole

+

输入参数，电源角色的值。

+

dataRole

+

输入参数，数据角色的值。

+

mode

+

输入参数，端口模式的值。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## QueryPort\(\) + +``` +int32_t OHOS::USB::UsbdClient::QueryPort (int32_t & portId, int32_t & powerRole, int32_t & dataRole, int32_t & mode ) +``` + +**描述：** + +查询port端口的当前设置。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

portId

+

输出参数，port接口ID。

+

powerRole

+

输出参数，电源角色的值。

+

dataRole

+

输出参数，数据角色的值。

+

mode

+

输出参数，模式的值。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## RegBulkCallback\(\) + +``` +int32_t OHOS::USB::UsbdClient::RegBulkCallback (const UsbDev & dev, const UsbPipe & pipe, const sptr< IRemoteObject > & cb ) +``` + +**描述：** + +注册批量传输异步回调函数。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

dev

+

输入参数，USB设备地址信息，详见UsbDev。

+

pipe

+

输入参数，USB设备pipe信息，详见UsbPipe。

+

cb

+

输入参数，回调函数对象的引用。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## ReleaseInterface\(\) + +``` +int32_t OHOS::USB::UsbdClient::ReleaseInterface (const UsbDev & dev, uint8_t interfaceid ) +``` + +**描述：** + +关闭接口，释放接口的占用，在停止数据传输后执行。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

dev

+

输入参数，USB设备地址信息，详见UsbDev。

+

interfaceid

+

输入参数，USB设备interface ID。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## RequestCancel\(\) + +``` +int32_t OHOS::USB::UsbdClient::RequestCancel (const UsbDev & dev, const UsbPipe & pipe ) +``` + +**描述：** + +取消待处理的数据请求。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

dev

+

输入参数，USB设备地址信息，详见UsbDev。

+

pipe

+

输入参数，USB设备pipe信息，详见UsbPipe。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## RequestQueue\(\) + +``` +int32_t OHOS::USB::UsbdClient::RequestQueue (const UsbDev & dev, const UsbPipe & pipe, const std::vector< uint8_t > & clientData, const std::vector< uint8_t > & buffer ) +``` + +**描述：** + +将指定的端点进行异步数据发送或者接收请求，数据传输方向由端点方向决定。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

dev

+

输入参数，USB设备地址信息，详见UsbDev。

+

pipe

+

输入参数，USB设备pipe信息，详见UsbPipe。

+

clientData

+

输入参数，用户数据。

+

buffer

+

输入参数，传输的数据。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## RequestWait\(\) + +``` +int32_t OHOS::USB::UsbdClient::RequestWait (const UsbDev & dev, std::vector< uint8_t > & clientData, std::vector< uint8_t > & buffer, int32_t timeout ) +``` + +**描述：** + +等待RequestQueue异步请求的操作结果。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

dev

+

输入参数，USB设备地址信息，详见UsbDev。

+

clientData

+

输入参数，用户数据。

+

buffer

+

输入参数，传输数据。

+

timeout

+

输入参数，超时时间。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## SetConfig\(\) + +``` +int32_t OHOS::USB::UsbdClient::SetConfig (const UsbDev & dev, uint8_t configIndex ) +``` + +**描述：** + +设置当前的config信息。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

dev

+

输入参数，USB设备地址信息，详见UsbDev。

+

configIndex

+

输入参数，USB设备config信息。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## SetCurrentFunctions\(\) + +``` +int32_t OHOS::USB::UsbdClient::SetCurrentFunctions (int32_t funcs) +``` + +**描述：** + +设置从设备支持的功能列表（按位域表示）（从设备）。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

funcs

+

输入参数，传入设备支持的function的值。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## setDevInfoBusNum\(\) + +``` +void OHOS::USB::UsbInfo::setDevInfoBusNum (int32_t busNum) +``` + +**描述：** + +设置USB总线编号。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

status

+

输入参数，USB总线编号。

+
+ +**Since：** + +3.0 + +**Version：** + +1.0 + +## setDevInfoDevNum\(\) + +``` +void OHOS::USB::UsbInfo::setDevInfoDevNum (int32_t devNum) +``` + +**描述：** + +设置USB设备编号。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

status

+

输入参数，USB设备编号。

+
+ +**Since：** + +3.0 + +**Version：** + +1.0 + +## setDevInfoStatus\(\) + +``` +void OHOS::USB::UsbInfo::setDevInfoStatus (int32_t status) +``` + +**描述：** + +设置USB设备状态。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

status

+

输入参数，设备状态。

+
+ +**Since：** + +3.0 + +**Version：** + +1.0 + +## SetInterface\(\) + +``` +int32_t OHOS::USB::UsbdClient::SetInterface (const UsbDev & dev, uint8_t interfaceid, uint8_t altIndex ) +``` + +**描述：** + +设置指定接口的备选设置，用于在具有相同ID但不同备用设置的两个接口之间进行选择。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

dev

+

输入参数，USB设备地址信息，详见UsbDev。

+

interfaceid

+

输入参数，USB设备interface ID。

+

altIndex

+

输入参数，interface的AlternateSetting信息。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## SetPortRole\(\) + +``` +int32_t OHOS::USB::UsbdClient::SetPortRole (int32_t portId, int32_t powerRole, int32_t dataRole ) +``` + +**描述：** + +设置port端口的角色。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

portId

+

输入参数，port接口ID。

+

powerRole

+

输入参数，电源角色的值。

+

dataRole

+

输入参数，数据角色的值。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## UnbindUsbdSubscriber\(\) + +``` +int32_t OHOS::USB::UsbdClient::UnbindUsbdSubscriber (const sptr< UsbdSubscriber > & subscriber) +``` + +**描述：** + +解绑订阅者。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

subscriber

+

输入参数，订阅者信息，详见UsbdSubscriber。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## UnRegBulkCallback\(\) + +``` +int32_t OHOS::USB::UsbdClient::UnRegBulkCallback (const UsbDev & dev, const UsbPipe & pipe ) +``` + +**描述：** + +注销批量传输异步回调函数。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

dev

+

输入参数，USB设备地址信息，详见UsbDev。

+

pipe

+

输入参数，USB设备pipe信息，详见UsbPipe。

+
+ +**返回：** + +0 表示操作成功。 + +非零值 表示操作失败。 + +**Since：** + +3.0 + +**Version：** + +1.0 + +## **变量说明** + +## busNum \[1/2\] + +``` +int32_t OHOS::USB::USBDeviceInfo::busNum +``` + +**描述：** + +USB总线编号 + +## busNum \[2/2\] + +``` +uint8_t OHOS::USB::UsbDev::busNum +``` + +**描述：** + +USB总线编号 + +## devAddr + +``` +uint8_t OHOS::USB::UsbDev::devAddr +``` + +**描述：** + +USB设备地址 + +## devNum + +``` +int32_t OHOS::USB::USBDeviceInfo::devNum +``` + +**描述：** + +USB设备编号 + +## endpointId + +``` +uint8_t OHOS::USB::UsbPipe::endpointId +``` + +**描述：** + +USB设备端点ID + +## index + +``` +int32_t OHOS::USB::UsbCtrlTransfer::index +``` + +**描述：** + +索引 + +## interfaceId + +``` +uint8_t OHOS::USB::UsbPipe::interfaceId +``` + +**描述：** + +USB设备接口ID + +## requestCmd + +``` +int32_t OHOS::USB::UsbCtrlTransfer::requestCmd +``` + +**描述：** + +请求命令字 + +## requestType + +``` +int32_t OHOS::USB::UsbCtrlTransfer::requestType +``` + +**描述：** + +请求类型 + +## status + +``` +int32_t OHOS::USB::USBDeviceInfo::status +``` + +**描述：** + +USB设备状态 + +## timeout + +``` +int32_t OHOS::USB::UsbCtrlTransfer::timeout +``` + +**描述：** + +超时时间 + +## value + +``` +int32_t OHOS::USB::UsbCtrlTransfer::value +``` + +**描述：** + +请求值 + diff --git a/zh-cn/device-dev/api/toctopics/_use_buffer_type.md b/zh-cn/device-dev/api/toctopics/_use_buffer_type.md new file mode 100644 index 0000000000..9d5fd8cfed --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_use_buffer_type.md @@ -0,0 +1,88 @@ +# UseBufferType + +## **概述** + +**所属模块:** + +[Codec](_codec.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

size

+

结构体大小

+

version

+

组件版本信息

+

portIndex

+

端口索引

+

bufferType

+

Buffer类型

+
+ +## **详细描述** + +UseBuffer类型定义。 + +## **类成员变量说明** + +## bufferType + +``` +uint32_t UseBufferType::bufferType +``` + +**描述：** + +Buffer类型 + +## portIndex + +``` +uint32_t UseBufferType::portIndex +``` + +**描述：** + +端口索引 + +## size + +``` +uint32_t UseBufferType::size +``` + +**描述：** + +结构体大小 + +## version + +``` +union OMX_VERSIONTYPE UseBufferType::version +``` + +**描述：** + +组件版本信息 + diff --git a/zh-cn/device-dev/api/toctopics/_user_auth_types_8idl.md b/zh-cn/device-dev/api/toctopics/_user_auth_types_8idl.md new file mode 100644 index 0000000000..845ea8a389 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_user_auth_types_8idl.md @@ -0,0 +1,124 @@ +# UserAuthTypes.idl + +## **概述** + +**所属模块:** + +[HdfUserAuth](_hdf_user_auth.md) + +## **汇总** + +## 类 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

类

+

描述

+

ExecutorRegisterInfo

+

执行器注册信息。 更多...

+

ExecutorInfo

+

执行器信息。 更多...

+

ScheduleInfo

+

调度信息。 更多...

+

AuthSolution

+

认证方案。 更多...

+

ExecutorSendMsg

+

执行器发送的消息。 更多...

+

AuthResultInfo

+

用户身份认证结果信息。 更多...

+

IdentifyResultInfo

+

用户身份识别结果信息。 更多...

+

EnrollParam

+

注册认证凭据参数。 更多...

+

CredentialInfo

+

认证凭据信息。 更多...

+

EnrolledInfo

+

注册信息。 更多...

+
+ +## 枚举 + + + + + + + + + + + + + + + + +

枚举

+

描述

+

AuthType : int { PIN = 1, FACE = 2, FINGERPRINT = 4, ALL = 0 }

+

枚举用户认证凭据类型。 更多...

+

ExecutorRole : int { COLLECTOR = 1, VERIFIER = 2, ALL_IN_ONE = 3 }

+

枚举执行器角色。 更多...

+

ExecutorSecureLevel : int { ESL0 = 0, ESL1 = 1, ESL2 = 2, ESL3 = 3 }

+

枚举执行器安全等级。 更多...

+
+ +## 变量 + + + + + + + + + + +

变量 名称

+

描述

+

package ohos.hdi.user_auth.v1_0

+

用户认证接口的包路径

+
+ +## **详细描述** + +定义用户认证驱动的枚举类和数据结构。 + +**Since：** + +3.2 + diff --git a/zh-cn/device-dev/api/toctopics/_verify_alloc_info.md b/zh-cn/device-dev/api/toctopics/_verify_alloc_info.md new file mode 100644 index 0000000000..2288340ed3 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_verify_alloc_info.md @@ -0,0 +1,46 @@ +# VerifyAllocInfo + +## **概述** + +**所属模块:** + +[Display](_display.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

width

+

分配内存的宽度

+

height

+

分配内存的高度

+

usage

+

内存的用处

+

format

+

分配内存的像素格式

+
+ +## **详细描述** + +用于验证内存分配信息的结构体定义。 + diff --git a/zh-cn/device-dev/api/toctopics/_vibrator.md b/zh-cn/device-dev/api/toctopics/_vibrator.md new file mode 100644 index 0000000000..3c7155320e --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_vibrator.md @@ -0,0 +1,188 @@ +# Vibrator + +## **汇总** + +## 文件 + + + + + + + + + + + + + +

文件

+

描述

+

vibrator_if.h

+

定义马达数据结构，包括马达模式和效果振动。

+

vibrator_type.h

+

定义马达数据结构，包括马达模式和效果振动。

+
+ +## 类 + + + + + + + + + + +

类

+

描述

+

VibratorInterface

+

提供Vibrator设备基本控制操作接口。更多...

+
+ +## 枚举 + + + + + + + + + + +

枚举

+

描述

+

VibratorMode { VIBRATOR_MODE_ONCE = 0, VIBRATOR_MODE_PRESET = 1, VIBRATOR_MODE_BUTT }

+

枚举马达振动模式。 更多...

+
+ +## 函数 + + + + + + + + + + + + + +

函数

+

描述

+

NewVibratorInterfaceInstance (void)

+

创建一个VibratorInterface实例。 更多...

+

FreeVibratorInterfaceInstance (void)

+

释放VibratorInterface实例以及相关资源。 更多...

+
+ +## **详细描述** + +马达驱动对马达服务提供通用的接口能力。 + +服务获取驱动对象或者代理后，马达服务启动或停止振动。 通过驱动程序对象或代理提供使用功能。 + +**Since：** + +2.2 + +**版本** + +1.0: + +## **枚举类型说明** + +## VibratorMode + +``` +enum VibratorMode +``` + +**描述：** + +枚举马达振动模式。 + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

VIBRATOR_MODE_ONCE

+

表示给定持续时间内的一次性振动。

+

+

VIBRATOR_MODE_PRESET

+

表示具有预置效果的周期性振动。

+

+

VIBRATOR_MODE_BUTT

+

表示效果模式无效。

+

+
+ +## **函数说明** + +## FreeVibratorInterfaceInstance\(\) + +``` +int32_t FreeVibratorInterfaceInstance (void ) +``` + +**描述：** + +释放VibratorInterface实例以及相关资源。 + +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +**Since：** + +2.2 + +**Version：** + +1.0 + +## NewVibratorInterfaceInstance\(\) + +``` +const struct VibratorInterface* NewVibratorInterfaceInstance (void ) +``` + +**描述：** + +创建一个VibratorInterface实例。 + +获的马达接口实例可用于控制马达按照配置进行振动。 + +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +**Since：** + +2.2 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/_vibrator_interface.md b/zh-cn/device-dev/api/toctopics/_vibrator_interface.md new file mode 100644 index 0000000000..aff35bc43e --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_vibrator_interface.md @@ -0,0 +1,148 @@ +# VibratorInterface + +## **概述** + +**所属模块:** + +[Vibrator](_vibrator.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

( StartOnce )([in] uint32_t duration)

+

控制马达以执行给定持续时间的一次性振动。 更多...

+

( Start )([in] const char *effectType)

+

控制马达以预置效果执行周期性振动。 更多...

+

( Stop )([in] enum VibratorMode mode)

+

停止马达振动。 更多...

+
+ +## **详细描述** + +提供Vibrator设备基本控制操作接口。 + +## **类成员变量说明** + +## Start + +``` +int32_t(* VibratorInterface::Start) ([in] const char *effectType) +``` + +**描述：** + +控制马达以预置效果执行周期性振动。 + +单次振动与周期振动相互排斥。在执行一次性振动之前，需退出周期性振动。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

effectType

+

指向指示预置效果类型的指针。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +## StartOnce + +``` +int32_t(* VibratorInterface::StartOnce) ([in] uint32_t duration) +``` + +**描述：** + +控制马达以执行给定持续时间的一次性振动。 + +单次振动与周期振动相互排斥。在执行一次性振动之前，需退出周期性振动。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

duration

+

指示一次性振动的持续时间，以毫秒为单位。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +## Stop + +``` +int32_t(* VibratorInterface::Stop) ([in] enum VibratorMode mode) +``` + +**描述：** + +停止马达振动。 + +马达启动前，必须在任何模式下停止振动。此功能用在振动过程之后。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

mode

+

指示振动模式，可以是一次性或周期性的，详见VibratorMode。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + diff --git a/zh-cn/device-dev/api/toctopics/_video_port_cap.md b/zh-cn/device-dev/api/toctopics/_video_port_cap.md new file mode 100644 index 0000000000..cae1dc9396 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_video_port_cap.md @@ -0,0 +1,133 @@ +# VideoPortCap + +## **概述** + +**所属模块:** + +[Codec](_codec.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 属性

+

描述

+

minSize

+

支持的最小分辨率

+

maxSize

+

支持的最大分辨率

+

whAlignment

+

宽高对齐值

+

blockCount

+

支持的块数量范围

+

blocksPerSecond

+

每秒可处理的块数量范围

+

blockSize

+

支持的块大小

+

supportPixFmts [PIX_FORMAT_NUM]

+

支持的像素格式

+
+ +## **详细描述** + +定义视频编解码能力。 + +## **类成员变量说明** + +## blockCount + +``` +RangeValue VideoPortCap::blockCount +``` + +**描述：** + +支持的块数量范围 + +## blockSize + +``` +Rect VideoPortCap::blockSize +``` + +**描述：** + +支持的块大小 + +## blocksPerSecond + +``` +RangeValue VideoPortCap::blocksPerSecond +``` + +**描述：** + +每秒可处理的块数量范围 + +## maxSize + +``` +Rect VideoPortCap::maxSize +``` + +**描述：** + +支持的最大分辨率 + +## minSize + +``` +Rect VideoPortCap::minSize +``` + +**描述：** + +支持的最小分辨率 + +## supportPixFmts + +``` +int32_t VideoPortCap::supportPixFmts[PIX_FORMAT_NUM] +``` + +**描述：** + +支持的像素格式，详见**OMX\_COLOR\_FORMATTYPE**。 + +## whAlignment + +``` +Alignment VideoPortCap::whAlignment +``` + +**描述：** + +宽高对齐值 + diff --git a/zh-cn/device-dev/api/toctopics/_w_l_a_n.md b/zh-cn/device-dev/api/toctopics/_w_l_a_n.md new file mode 100644 index 0000000000..368d8d20a4 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/_w_l_a_n.md @@ -0,0 +1,537 @@ +# WLAN + +## **汇总** + +## 文件 + + + + + + + + + + + + + + + + + + + +

文件

+

描述

+

wifi_hal.h

+

提供给WLAN服务的WLAN基本能力接口。

+

wifi_hal_ap_feature.h

+

提供WLAN的AP特性能力（获取与AP连接的STA的基本信息、设置国家码）。

+

wifi_hal_base_feature.h

+

提供WLAN基本特性能力。

+

wifi_hal_sta_feature.h

+

提供WLAN的STA特性能力。

+
+ +## 类 + + + + + + + + + + + + + + + + + + + + + + +

类

+

描述

+

IWiFi

+

HAL对WLAN服务提供的基本能力。 更多...

+

StaInfo

+

描述与AP连接的STA的基本信息 更多...

+

IWiFiAp

+

继承了IWiFiBaseFeature基本特性，并包含AP模式下获取连接STA的信息和设置国家码的功能。 更多...

+

IWiFiBaseFeature

+

WLAN基本特性操作接口，包括获取网卡名称，设置MAC地址，设置发射功率等公共能力接口。 更多...

+

IWiFiSta

+

继承了IWiFiBaseFeature基本特性，额外包含设置扫描单个MAC地址功能。 更多...

+
+ +## 宏定义 + + + + + + + + + + + + + + + + +

宏定义

+

描述

+

IFNAME_MAX_LEN 16

+

网卡名称最大长度。

+

WIFI_MAC_ADDR_LENGTH 6

+

WLAN的MAC地址长度。

+

ERR_UNAUTH_ACCESS (-6)

+

定义访问失败错误码。

+
+ +## 类型定义 + + + + + + + + + + +

类型定义

+

描述

+

(CallbackFunc) (uint32_t event, void *data, const char *ifName)

+

定义IWiFi回调函数的原型，监听异步事件。 更多...

+
+ +## 枚举 + + + + + + + + + + +

枚举

+

描述

+

FeatureType { PROTOCOL_80211_IFTYPE_UNSPECIFIED, PROTOCOL_80211_IFTYPE_ADHOC, PROTOCOL_80211_IFTYPE_STATION, PROTOCOL_80211_IFTYPE_AP, PROTOCOL_80211_IFTYPE_AP_VLAN, PROTOCOL_80211_IFTYPE_WDS, PROTOCOL_80211_IFTYPE_MONITOR, PROTOCOL_80211_IFTYPE_MESH_POINT, PROTOCOL_80211_IFTYPE_P2P_CLIENT, PROTOCOL_80211_IFTYPE_P2P_GO, PROTOCOL_80211_IFTYPE_P2P_DEVICE, PROTOCOL_80211_IFTYPE_NUM }

+

枚举WLAN相关特性的类型FeatureType。 更多...

+
+ +## 函数 + + + + + + + + + + + + + + + + + + + + + + +

函数

+

描述

+

WifiConstruct (struct IWiFi **wifiInstance)

+

创建IWiFi结构体，挂接IWiFi中能力接口。 更多...

+

WifiDestruct (struct IWiFi **wifiInstance)

+

销毁IWiFi结构体并释放相关资源。 更多...

+

InitApFeature (struct IWiFiAp **fe)

+

初始化AP特性。WLAN服务在创建AP类型的特性FeatureType时调用。 更多...

+

InitBaseFeature (struct IWiFiBaseFeature **fe)

+

WLAN服务创建任何类型的特性{@Link FeatureType}时，都需要调用此函数。 更多...

+

InitStaFeature (struct IWiFiSta **fe)

+

初始化STA特性。WLAN服务在创建STA类型的特性FeatureType时调用。 更多...

+
+ +## **详细描述** + +WLAN模块向上层WLAN服务提供了统一接口。 + +HDI层开发人员可根据WLAN模块提供的向上统一接口获取如下能力：建立/关闭WLAN热点，扫描，关联WLAN热点，WLAN平台芯片管理，网络数据缓冲的申请、释放、移动等操作，网络设备管理，电源管理等。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## **类型定义说明** + +## CallbackFunc + +``` +typedef int32_t(* CallbackFunc) (uint32_t event, void *data, const char *ifName) +``` + +**描述：** + +定义IWiFi回调函数的原型，监听异步事件。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

event

+

输入参数，回调传入的事件类型标识。

+

data

+

输入参数，回调传入的数据。

+

ifName

+

输入参数，网卡名称。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## **枚举类型说明** + +## FeatureType + +``` +enum FeatureType +``` + +**描述：** + +枚举WLAN相关特性的类型[FeatureType](_w_l_a_n.md#gad2b28a6ade408676d1371ea941824012)。 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

PROTOCOL_80211_IFTYPE_UNSPECIFIED

+

未定义的类型

+

PROTOCOL_80211_IFTYPE_ADHOC

+

特设型网络

+

PROTOCOL_80211_IFTYPE_STATION

+

工作站

+

+

PROTOCOL_80211_IFTYPE_AP

+

接入点

+

+

PROTOCOL_80211_IFTYPE_AP_VLAN

+

虚拟接入点

+

+

PROTOCOL_80211_IFTYPE_WDS

+

无线分布式系统

+

+

PROTOCOL_80211_IFTYPE_MONITOR

+

网络监听器

+

+

PROTOCOL_80211_IFTYPE_MESH_POINT

+

组网

+

+

PROTOCOL_80211_IFTYPE_P2P_CLIENT

+

对等网络客户端

+

+

PROTOCOL_80211_IFTYPE_P2P_GO

+

对等网络群组所有者

+

+

PROTOCOL_80211_IFTYPE_P2P_DEVICE

+

对等网络设备

+

+

PROTOCOL_80211_IFTYPE_NUM

+

网口的数目

+

+
+ +## **函数说明** + +## InitApFeature\(\) + +``` +int32_t InitApFeature (struct IWiFiAp ** fe) +``` + +**描述：** + +初始化AP特性。WLAN服务在创建AP类型的特性[FeatureType](_w_l_a_n.md#gad2b28a6ade408676d1371ea941824012)时调用。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

fe

+

输入参数，AP特性IWiFiAp。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## InitBaseFeature\(\) + +``` +int32_t InitBaseFeature (struct IWiFiBaseFeature ** fe) +``` + +**描述：** + +WLAN服务创建任何类型的特性\{@Link FeatureType\}时，都需要调用此函数。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

fe

+

输入参数，基本特性IWiFiBaseFeature。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## InitStaFeature\(\) + +``` +int32_t InitStaFeature (struct IWiFiSta ** fe) +``` + +**描述：** + +初始化STA特性。WLAN服务在创建STA类型的特性[FeatureType](_w_l_a_n.md#gad2b28a6ade408676d1371ea941824012)时调用。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

fe

+

输出参数，STA特性IWiFiSta。

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## WifiConstruct\(\) + +``` +int32_t WifiConstruct (struct IWiFi ** wifiInstance) +``` + +**描述：** + +创建IWiFi结构体，挂接[IWiFi](_i_wi_fi.md)中能力接口。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

wifiInstance

+

HAL服务对象IWiFi

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +**Since：** + +1.0 + +**Version：** + +1.0 + +## WifiDestruct\(\) + +``` +int32_t WifiDestruct (struct IWiFi ** wifiInstance) +``` + +**描述：** + +销毁IWiFi结构体并释放相关资源。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

wifiInstance

+

HAL服务对象IWiFi

+
+ +**返回：** + +如果操作成功，则返回0。 + +如果操作失败，则返回负值。 + +**Since：** + +1.0 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/annotated.md b/zh-cn/device-dev/api/toctopics/annotated.md new file mode 100644 index 0000000000..96aa1f963a --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/annotated.md @@ -0,0 +1,261 @@ +# 结构体 + +- **[\_\_attribute\_\_](____attribute____.md)** + +- **[Alignment](_alignment.md)** + +- **[AllocInfo](_alloc_info.md)** + +- **[AudioAdapter](_audio_adapter.md)** + +- **[AudioAdapterDescriptor](_audio_adapter_descriptor.md)** + +- **[AudioAttribute](_audio_attribute.md)** + +- **[AudioCapture](_audio_capture.md)** + +- **[AudioControl](_audio_control.md)** + +- **[AudioDevExtInfo](_audio_dev_ext_info.md)** + +- **[AudioDeviceDescriptor](_audio_device_descriptor.md)** + +- **[AudioManager](_audio_manager.md)** + +- **[AudioMixExtInfo](_audio_mix_ext_info.md)** + +- **[AudioMmapBufferDescripter](_audio_mmap_buffer_descripter.md)** + +- **[AudioPort](_audio_port.md)** + +- **[AudioPortCap](_audio_port_cap.md)** + +- **[AudioPortCapability](_audio_port_capability.md)** + +- **[AudioRender](_audio_render.md)** + +- **[AudioRoute](_audio_route.md)** + +- **[AudioRouteNode](_audio_route_node.md)** + +- **[AudioSampleAttributes](_audio_sample_attributes.md)** + +- **[AudioScene](_audio_scene.md)** + +- **[AudioSceneDescriptor](_audio_scene_descriptor.md)** + +- **[AudioSceneDescriptor::SceneDesc](union_audio_scene_descriptor_1_1_scene_desc.md)** + +- **[AudioSessionExtInfo](_audio_session_ext_info.md)** + +- **[AudioSubPortCapability](_audio_sub_port_capability.md)** + +- **[AudioTimeStamp](_audio_time_stamp.md)** + +- **[AudioVolume](_audio_volume.md)** + +- **[AuthResultInfo](_auth_result_info.md)** + +- **[AuthSolution](_auth_solution.md)** + +- **[BatteryInfo](_battery_info.md)** + +- **[BufferData](_buffer_data.md)** + +- **[CodecCallbackType](_codec_callback_type.md)** + +- **[CodecCompCapability](_codec_comp_capability.md)** + +- **[CodecComponentManager](_codec_component_manager.md)** + +- **[CodecComponentType](_codec_component_type.md)** + +- **[CompVerInfo](_comp_ver_info.md)** + +- **[CredentialInfo](_credential_info.md)** + +- **[DacIoMsg](_dac_io_msg.md)** + +- **[DeviceFuncs](_device_funcs.md)** + +- **[DeviceInfo](_device_info.md)** + +- **[DisplayCapability](_display_capability.md)** + +- **[DisplayInfo](_display_info.md)** + +- **[DisplayModeInfo](_display_mode_info.md)** + +- **[EnrolledInfo](_enrolled_info.md)** + +- **[EnrollParam](_enroll_param.md)** + +- **[EventInfo](_event_info.md)** + +- **[EventPackage](_event_package.md)** + +- **[ExecutorInfo](_executor_info.md)** + +- **[ExecutorRegisterInfo](_executor_register_info.md)** + +- **[ExecutorSendMsg](_executor_send_msg.md)** + +- **[GetBufferHandleUsageParams](_get_buffer_handle_usage_params.md)** + +- **[GfxFuncs](_gfx_funcs.md)** + +- **[GfxOpt](_gfx_opt.md)** + +- **[GrallocFuncs](_gralloc_funcs.md)** + +- **[HdfThermalCallbackInfo](_hdf_thermal_callback_info.md)** + +- **[HDRCapability](_h_d_r_capability.md)** + +- **[HDRMetaData](_h_d_r_meta_data.md)** + +- **[IBatteryCallback](interface_i_battery_callback.md)** + +- **[IBatteryInterface](interface_i_battery_interface.md)** + +- **[ICircle](_i_circle.md)** + +- **[IdentifyResultInfo](_identify_result_info.md)** + +- **[IExecutor](interface_i_executor.md)** + +- **[IExecutorCallback](interface_i_executor_callback.md)** + +- **[IFaceAuthInterface](interface_i_face_auth_interface.md)** + +- **[IInputInterface](_i_input_interface.md)** + +- **[ILine](_i_line.md)** + +- **[InputController](_input_controller.md)** + +- **[InputExtraCmd](_input_extra_cmd.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)** + +- **[IRect](_i_rect.md)** + +- **[ISurface](_i_surface.md)** + +- **[IThermalCallback](interface_i_thermal_callback.md)** + +- **[IThermalInterface](interface_i_thermal_interface.md)** + +- **[IUserAuthInterface](interface_i_user_auth_interface.md)** + +- **[IWiFi](_i_wi_fi.md)** + +- **[IWiFiAp](_i_wi_fi_ap.md)** + +- **[IWiFiBaseFeature](_i_wi_fi_base_feature.md)** + +- **[IWiFiSta](_i_wi_fi_sta.md)** + +- **[LayerAlpha](_layer_alpha.md)** + +- **[LayerBuffer](_layer_buffer.md)** + +- **[LayerFuncs](_layer_funcs.md)** + +- **[LayerInfo](_layer_info.md)** + +- **[LightEffect](_light_effect.md)** + +- **[LightFlashEffect](_light_flash_effect.md)** + +- **[LightInfo](_light_info.md)** + +- **[LightInterface](_light_interface.md)** + +- **[OHOS::Camera::CaptureEndedInfo](_o_h_o_s_1_1_camera_1_1_capture_ended_info.md)** + +- **[OHOS::Camera::CaptureErrorInfo](_o_h_o_s_1_1_camera_1_1_capture_error_info.md)** + +- **[OHOS::Camera::CaptureInfo](_o_h_o_s_1_1_camera_1_1_capture_info.md)** + +- **[OHOS::Camera::ICameraDevice](_o_h_o_s_1_1_camera_1_1_i_camera_device.md)** + +- **[OHOS::Camera::ICameraDeviceCallback](_o_h_o_s_1_1_camera_1_1_i_camera_device_callback.md)** + +- **[OHOS::Camera::ICameraHost](_o_h_o_s_1_1_camera_1_1_i_camera_host.md)** + +- **[OHOS::Camera::ICameraHostCallback](_o_h_o_s_1_1_camera_1_1_i_camera_host_callback.md)** + +- **[OHOS::Camera::IOfflineStreamOperator](_o_h_o_s_1_1_camera_1_1_i_offline_stream_operator.md)** + +- **[OHOS::Camera::IStreamOperator](_o_h_o_s_1_1_camera_1_1_i_stream_operator.md)** + +- **[OHOS::Camera::IStreamOperatorCallback](_o_h_o_s_1_1_camera_1_1_i_stream_operator_callback.md)** + +- **[OHOS::Camera::StreamAttribute](_o_h_o_s_1_1_camera_1_1_stream_attribute.md)** + +- **[OHOS::Camera::StreamInfo](_o_h_o_s_1_1_camera_1_1_stream_info.md)** + +- **[OHOS::USB::UsbCtrlTransfer](_o_h_o_s_1_1_u_s_b_1_1_usb_ctrl_transfer.md)** + +- **[OHOS::USB::UsbdClient](_o_h_o_s_1_1_u_s_b_1_1_usbd_client.md)** + +- **[OHOS::USB::UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md)** + +- **[OHOS::USB::USBDeviceInfo](_o_h_o_s_1_1_u_s_b_1_1_u_s_b_device_info.md)** + +- **[OHOS::USB::UsbdSubscriber](_o_h_o_s_1_1_u_s_b_1_1_usbd_subscriber.md)** + +- **[OHOS::USB::UsbInfo](_o_h_o_s_1_1_u_s_b_1_1_usb_info.md)** + +- **[OHOS::USB::UsbPipe](_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md)** + +- **[OmxCodecBuffer](_omx_codec_buffer.md)** + +- **[PortCap](union_port_cap.md)** + +- **[PresentTimestamp](_present_timestamp.md)** + +- **[PropertyObject](_property_object.md)** + +- **[RangeValue](_range_value.md)** + +- **[Rect](_rect.md)** + +- **[Rectangle](_rectangle.md)** + +- **[ScheduleInfo](_schedule_info.md)** + +- **[SensorEvents](_sensor_events.md)** + +- **[SensorInformation](_sensor_information.md)** + +- **[SensorInterface](_sensor_interface.md)** + +- **[StaInfo](_sta_info.md)** + +- **[SupportBufferType](_support_buffer_type.md)** + +- **[TemplateInfo](_template_info.md)** + +- **[ThermalZoneInfo](_thermal_zone_info.md)** + +- **[UseBufferType](_use_buffer_type.md)** + +- **[VerifyAllocInfo](_verify_alloc_info.md)** + +- **[VibratorInterface](_vibrator_interface.md)** + +- **[VideoPortCap](_video_port_cap.md)** + + diff --git a/zh-cn/device-dev/api/toctopics/audio__adapter_8h.md b/zh-cn/device-dev/api/toctopics/audio__adapter_8h.md new file mode 100644 index 0000000000..4b76650358 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/audio__adapter_8h.md @@ -0,0 +1,39 @@ +# audio\_adapter.h + +## **概述** + +**所属模块:** + +[Audio](_audio.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

AudioAdapter

+

AudioAdapter音频适配器接口 更多...

+
+ +## **详细描述** + +Audio适配器的接口定义文件。 + +**Since：** + +1.0 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/audio__attribute_8h.md b/zh-cn/device-dev/api/toctopics/audio__attribute_8h.md new file mode 100644 index 0000000000..f27f5aa1f4 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/audio__attribute_8h.md @@ -0,0 +1,39 @@ +# audio\_attribute.h + +## **概述** + +**所属模块:** + +[Audio](_audio.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

AudioAttribute

+

AudioAttribute音频属性接口 更多...

+
+ +## **详细描述** + +Audio属性的接口定义文件。 + +**Since：** + +1.0 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/audio__capture_8h.md b/zh-cn/device-dev/api/toctopics/audio__capture_8h.md new file mode 100644 index 0000000000..4060fae0e7 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/audio__capture_8h.md @@ -0,0 +1,39 @@ +# audio\_capture.h + +## **概述** + +**所属模块:** + +[Audio](_audio.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

AudioCapture

+

AudioCapture音频录音接口 更多...

+
+ +## **详细描述** + +Audio录音的接口定义文件。 + +**Since：** + +1.0 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/audio__control_8h.md b/zh-cn/device-dev/api/toctopics/audio__control_8h.md new file mode 100644 index 0000000000..eae77ce333 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/audio__control_8h.md @@ -0,0 +1,39 @@ +# audio\_control.h + +## **概述** + +**所属模块:** + +[Audio](_audio.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

AudioControl

+

AudioControl音频控制接口 更多...

+
+ +## **详细描述** + +Audio控制的接口定义文件。 + +**Since：** + +1.0 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/audio__manager_8h.md b/zh-cn/device-dev/api/toctopics/audio__manager_8h.md new file mode 100644 index 0000000000..f505757488 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/audio__manager_8h.md @@ -0,0 +1,56 @@ +# audio\_manager.h + +## **概述** + +**所属模块:** + +[Audio](_audio.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

AudioManager

+

AudioManager音频适配器管理接口 更多...

+
+ +## 函数 + + + + + + + + + + +

函数

+

描述

+

GetAudioManagerFuncs (void)

+

获取音频适配器管理接口的操作函数列表，详情参考AudioManager 更多...

+
+ +## **详细描述** + +Audio适配器管理及加载的接口定义文件。 + +**Since：** + +1.0 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/audio__render_8h.md b/zh-cn/device-dev/api/toctopics/audio__render_8h.md new file mode 100644 index 0000000000..2a351bba4a --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/audio__render_8h.md @@ -0,0 +1,39 @@ +# audio\_render.h + +## **概述** + +**所属模块:** + +[Audio](_audio.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

AudioRender

+

AudioRender音频播放接口 更多...

+
+ +## **详细描述** + +Audio播放的接口定义文件。 + +**Since：** + +1.0 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/audio__scene_8h.md b/zh-cn/device-dev/api/toctopics/audio__scene_8h.md new file mode 100644 index 0000000000..d6d821ae63 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/audio__scene_8h.md @@ -0,0 +1,39 @@ +# audio\_scene.h + +## **概述** + +**所属模块:** + +[Audio](_audio.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

AudioScene

+

AudioScene音频场景接口 更多...

+
+ +## **详细描述** + +Audio场景的接口定义文件。 + +**Since：** + +1.0 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/audio__types_8h.md b/zh-cn/device-dev/api/toctopics/audio__types_8h.md new file mode 100644 index 0000000000..96b432f193 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/audio__types_8h.md @@ -0,0 +1,215 @@ +# audio\_types.h + +## **概述** + +**所属模块:** + +[Audio](_audio.md) + +## **汇总** + +## 类 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

类

+

描述

+

AudioPort

+

音频端口 更多...

+

AudioAdapterDescriptor

+

音频适配器描述符 更多...

+

AudioDeviceDescriptor

+

音频设备描述符 更多...

+

AudioSceneDescriptor

+

音频场景描述符 更多...

+

AudioSceneDescriptor::SceneDesc

+

音频场景描述 更多...

+

AudioSampleAttributes

+

音频采样属性 更多...

+

AudioTimeStamp

+

音频时间戳 更多...

+

AudioSubPortCapability

+

音频子端口的支持能力 更多...

+

AudioPortCapability

+

音频端口的支持能力 更多...

+

AudioMmapBufferDescripter

+

mmap缓冲区描述符 更多...

+

AudioDevExtInfo

+

音频设备拓展信息 更多...

+

AudioMixExtInfo

+

音轨拓展信息 更多...

+

AudioSessionExtInfo

+

会话拓展信息 更多...

+

AudioRouteNode

+

音频路由节点 更多...

+

AudioRoute

+

音频路由信息 更多...

+
+ +## 类型定义 + + + + + + + + + + + + + +

类型定义

+

描述

+

AudioHandle

+

音频句柄

+

(RenderCallback) (enum AudioCallbackType, void *reserved, void *cookie)

+

回调函数指针 更多...

+
+ +## 枚举 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举

+

描述

+

AudioPortDirection { PORT_OUT = 0x1u, PORT_IN = 0x2u, PORT_OUT_IN = 0x3u }

+

音频端口的类型 更多...

+

AudioPortPin { PIN_NONE = 0x0u, PIN_OUT_SPEAKER = 0x1u, PIN_OUT_HEADSET = 0x2u, PIN_OUT_LINEOUT = 0x4u, PIN_OUT_HDMI = 0x8u, PIN_OUT_USB = 0x10u, PIN_OUT_USB_EXT = 0x20u, PIN_IN_MIC = 0x8000001u, PIN_IN_HS_MIC = 0x8000002u, PIN_IN_LINEIN = 0x8000004u, PIN_IN_USB_EXT = 0x8000008u }

+

音频适配器端口的PIN脚 更多...

+

AudioCategory { AUDIO_IN_MEDIA = 0, AUDIO_IN_COMMUNICATION, AUDIO_IN_RINGTONE, AUDIO_IN_CALL }

+

音频类型（category） 更多...

+

AudioFormat { AUDIO_FORMAT_PCM_8_BIT = 0x1u, AUDIO_FORMAT_PCM_16_BIT = 0x2u, AUDIO_FORMAT_PCM_24_BIT = 0x3u, AUDIO_FORMAT_PCM_32_BIT = 0x4u, AUDIO_FORMAT_AAC_MAIN = 0x1000001u, AUDIO_FORMAT_AAC_LC = 0x1000002u, AUDIO_FORMAT_AAC_LD = 0x1000003u, AUDIO_FORMAT_AAC_ELD = 0x1000004u, AUDIO_FORMAT_AAC_HE_V1 = 0x1000005u, AUDIO_FORMAT_AAC_HE_V2 = 0x1000006u, AUDIO_FORMAT_G711A = 0x2000001u, AUDIO_FORMAT_G711U = 0x2000002u, AUDIO_FORMAT_G726 = 0x2000003u }

+

音频格式 更多...

+

AudioChannelMask { AUDIO_CHANNEL_FRONT_LEFT = 0x1, AUDIO_CHANNEL_FRONT_RIGHT = 0x2, AUDIO_CHANNEL_MONO = 0x1u, AUDIO_CHANNEL_STEREO = 0x3u }

+

音频通道掩码（mask） 更多...

+

AudioSampleRatesMask { AUDIO_SAMPLE_RATE_MASK_8000 = 0x1u, AUDIO_SAMPLE_RATE_MASK_12000 = 0x2u, AUDIO_SAMPLE_RATE_MASK_11025 = 0x4u, AUDIO_SAMPLE_RATE_MASK_16000 = 0x8u, AUDIO_SAMPLE_RATE_MASK_22050 = 0x10u, AUDIO_SAMPLE_RATE_MASK_24000 = 0x20u, AUDIO_SAMPLE_RATE_MASK_32000 = 0x40u, AUDIO_SAMPLE_RATE_MASK_44100 = 0x80u, AUDIO_SAMPLE_RATE_MASK_48000 = 0x100u, AUDIO_SAMPLE_RATE_MASK_64000 = 0x200u, AUDIO_SAMPLE_RATE_MASK_96000 = 0x400u, AUDIO_SAMPLE_RATE_MASK_INVALID = 0xFFFFFFFFu }

+

音频采样频率MASK 更多...

+

AudioPortPassthroughMode { PORT_PASSTHROUGH_LPCM = 0x1, PORT_PASSTHROUGH_RAW = 0x2, PORT_PASSTHROUGH_HBR2LBR = 0x4, PORT_PASSTHROUGH_AUTO = 0x8 }

+

音频端口的数据透传模式 更多...

+

AudioSampleFormat { AUDIO_SAMPLE_FORMAT_S8, AUDIO_SAMPLE_FORMAT_S8P, AUDIO_SAMPLE_FORMAT_U8, AUDIO_SAMPLE_FORMAT_U8P, AUDIO_SAMPLE_FORMAT_S16, AUDIO_SAMPLE_FORMAT_S16P, AUDIO_SAMPLE_FORMAT_U16, AUDIO_SAMPLE_FORMAT_U16P, AUDIO_SAMPLE_FORMAT_S24, AUDIO_SAMPLE_FORMAT_S24P, AUDIO_SAMPLE_FORMAT_U24, AUDIO_SAMPLE_FORMAT_U24P, AUDIO_SAMPLE_FORMAT_S32, AUDIO_SAMPLE_FORMAT_S32P, AUDIO_SAMPLE_FORMAT_U32, AUDIO_SAMPLE_FORMAT_U32P, AUDIO_SAMPLE_FORMAT_S64, AUDIO_SAMPLE_FORMAT_S64P, AUDIO_SAMPLE_FORMAT_U64, AUDIO_SAMPLE_FORMAT_U64P, AUDIO_SAMPLE_FORMAT_F32, AUDIO_SAMPLE_FORMAT_F32P, AUDIO_SAMPLE_FORMAT_F64, AUDIO_SAMPLE_FORMAT_F64P, AUDIO_SAMPLE_FMT_U8, AUDIO_SAMPLE_FMT_S16, AUDIO_SAMPLE_FMT_S32, AUDIO_SAMPLE_FMT_FLOAT, AUDIO_SAMPLE_FMT_DOUBLE, AUDIO_SAMPLE_FMT_U8P, AUDIO_SAMPLE_FMT_S16P, AUDIO_SAMPLE_FMT_S32P, AUDIO_SAMPLE_FMT_FLOATP, AUDIO_SAMPLE_FMT_DOUBLEP, AUDIO_SAMPLE_FMT_INVALID }

+

原始音频样本格式 更多...

+

AudioChannelMode { AUDIO_CHANNEL_NORMAL = 0, AUDIO_CHANNEL_BOTH_LEFT, AUDIO_CHANNEL_BOTH_RIGHT, AUDIO_CHANNEL_EXCHANGE, AUDIO_CHANNEL_MIX, AUDIO_CHANNEL_LEFT_MUTE, AUDIO_CHANNEL_RIGHT_MUTE, AUDIO_CHANNEL_BOTH_MUTE }

+

音频播放的通道模式 更多...

+

AudioDrainNotifyType { AUDIO_DRAIN_NORMAL_MODE, AUDIO_DRAIN_EARLY_MODE }

+

DrainBuffer函数结束类型 更多...

+

AudioCallbackType { AUDIO_NONBLOCK_WRITE_COMPELETED, AUDIO_DRAIN_COMPELETED, AUDIO_FLUSH_COMPLETED, AUDIO_RENDER_FULL, AUDIO_ERROR_OCCUR }

+

回调函数通知事件类型 更多...

+

AudioPortRole { AUDIO_PORT_UNASSIGNED_ROLE = 0, AUDIO_PORT_SOURCE_ROLE = 1, AUDIO_PORT_SINK_ROLE = 2 }

+

音频端口角色 更多...

+

AudioPortType { AUDIO_PORT_UNASSIGNED_TYPE = 0, AUDIO_PORT_DEVICE_TYPE = 1, AUDIO_PORT_MIX_TYPE = 2, AUDIO_PORT_SESSION_TYPE = 3 }

+

音频端口类型. 更多...

+

AudioSessionType { AUDIO_OUTPUT_STAGE_SESSION = 0, AUDIO_OUTPUT_MIX_SESSION, AUDIO_ALLOCATE_SESSION, AUDIO_INVALID_SESSION }

+

端口会话类型 更多...

+
+ +## **详细描述** + +Audio模块接口定义中使用的自定义数据类型 + +Audio模块接口定义中使用的自定义数据类型，包括音频端口、适配器描述符、设备描述符、场景描述符、采样属性、时间戳等。 + +**Since：** + +1.0 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/audio__volume_8h.md b/zh-cn/device-dev/api/toctopics/audio__volume_8h.md new file mode 100644 index 0000000000..af645db939 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/audio__volume_8h.md @@ -0,0 +1,39 @@ +# audio\_volume.h + +## **概述** + +**所属模块:** + +[Audio](_audio.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

AudioVolume

+

AudioVolume音频音量接口 更多...

+
+ +## **详细描述** + +Audio音量的接口定义文件。 + +**Since：** + +1.0 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/battery.md b/zh-cn/device-dev/api/toctopics/battery.md new file mode 100644 index 0000000000..cee4f89403 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/battery.md @@ -0,0 +1,280 @@ +# Battery + +## **汇总** + +## 文件 + + + + + + + + + + + + + + + + +

文件

+

描述

+

IBatteryCallback.idl

+

电池信息的回调。

+

IBatteryInterface.idl

+

获取、订阅电池信息的接口。

+

Types.idl

+

电池信息相关数据类型。

+
+ +## 类 + + + + + + + + + + + + + + + + +

类

+

描述

+

IBatteryCallback

+

电池信息的回调。 更多...

+

IBatteryInterface

+

获取、订阅电池信息的接口。 更多...

+

BatteryInfo

+

电池相关信息。 更多...

+
+ +## 枚举 + + + + + + + + + + + + + + + + +

枚举

+

描述

+

BatteryHealthState { BATTERY_HEALTH_UNKNOWN = 0, BATTERY_HEALTH_GOOD, BATTERY_HEALTH_OVERHEAT, BATTERY_HEALTH_OVERVOLTAGE, BATTERY_HEALTH_COLD, BATTERY_HEALTH_DEAD, BATTERY_HEALTH_RESERVED }

+

电池的健康状态。 更多...

+

BatteryChargeState { CHARGE_STATE_NONE = 0, CHARGE_STATE_ENABLE, CHARGE_STATE_DISABLE, CHARGE_STATE_FULL, CHARGE_STATE_RESERVED }

+

电池的充电状态。 更多...

+

BatteryPluggedType { PLUGGED_TYPE_NONE = 0, PLUGGED_TYPE_AC, PLUGGED_TYPE_USB, PLUGGED_TYPE_WIRELESS, PLUGGED_TYPE_BUTT }

+

电池的充电设备类型。 更多...

+
+ +## 变量 + + + + + + + + + + +

变量

+

描述

+

package ohos.hdi.battery.v1_0

+

电池信息接口的包路径

+
+ +## **详细描述** + +提供获取、订阅电池信息的接口。 + +电池模块为电池服务提供的获取、订阅电池信息的接口。 服务获取此模块的对象或代理后，可以调用相关的接口获取电池信息、订阅电池信息的变化。 + +**Since：** + +3.1 + +**Version：** + +1.0 + +## **枚举类型说明** + +## BatteryChargeState + +``` +enum BatteryChargeState +``` + +**描述：** + +电池的充电状态。 + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

CHARGE_STATE_NONE

+

表示电池充电状态未知。

+

+

CHARGE_STATE_ENABLE

+

表示电池充电状态为使能状态。

+

+

CHARGE_STATE_DISABLE

+

表示电池充电状态为停止状态。

+

+

CHARGE_STATE_FULL

+

表示电池充电状态为已充满状态。

+

+

CHARGE_STATE_RESERVED

+

预留。

+

+
+ +## BatteryHealthState + +``` +enum BatteryHealthState +``` + +**描述：** + +电池的健康状态。 + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

BATTERY_HEALTH_UNKNOWN

+

表示电池健康状态未知。

+

+

BATTERY_HEALTH_GOOD

+

表示电池健康状态为正常。

+

+

BATTERY_HEALTH_OVERHEAT

+

表示电池健康状态为过热。

+

+

BATTERY_HEALTH_OVERVOLTAGE

+

表示电池健康状态为过压。

+

+

BATTERY_HEALTH_COLD

+

表示电池健康状态为低温。

+

+

BATTERY_HEALTH_DEAD

+

表示电池健康状态为耗尽。

+

+

BATTERY_HEALTH_RESERVED

+

预留。

+

+
+ +## BatteryPluggedType + +``` +enum BatteryPluggedType +``` + +**描述：** + +电池的充电设备类型。 + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

PLUGGED_TYPE_NONE

+

表示连接充电器类型未知。

+

+

PLUGGED_TYPE_AC

+

表示连接的充电器类型为交流充电器。

+

+

PLUGGED_TYPE_USB

+

表示连接的充电器类型为USB充电器。

+

+

PLUGGED_TYPE_WIRELESS

+

表示连接的充电器类型为无线充电器。

+

+

PLUGGED_TYPE_BUTT

+

预留。

+

+
+ diff --git a/zh-cn/device-dev/api/toctopics/codec__callback__if_8h.md b/zh-cn/device-dev/api/toctopics/codec__callback__if_8h.md new file mode 100644 index 0000000000..012da60850 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/codec__callback__if_8h.md @@ -0,0 +1,63 @@ +# codec\_callback\_if.h + +## **概述** + +**所属模块:** + +[Codec](_codec.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

CodecCallbackType

+

Codec回调接口定义。 更多...

+
+ +## 函数 + + + + + + + + + + + + + +

函数

+

描述

+

CodecCallbackTypeGet (struct HdfRemoteService *remote)

+

实例化CodecCallbackType对象。 更多...

+

CodecCallbackTypeRelease (struct CodecCallbackType *instance)

+

释放CodecCallbackType对象。 更多...

+
+ +## **详细描述** + +主要包括回调函数接口定义。 + +Codec模块事件上报、上报输入buffer和输出buffer处理完毕等接口定义。 + +**Since：** + +3.1 + +**Version：** + +2.0 + diff --git a/zh-cn/device-dev/api/toctopics/codec__common__type_8h.md b/zh-cn/device-dev/api/toctopics/codec__common__type_8h.md new file mode 100644 index 0000000000..a9153a5497 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/codec__common__type_8h.md @@ -0,0 +1,88 @@ +# codec\_common\_type.h + +## **概述** + +**所属模块:** + +[Codec](_codec.md) + +## **汇总** + +## 类 + + + + + + + + + + + + + + + + +

类

+

描述

+

Alignment

+

对齐结构定义，包含宽高的对齐值 更多...

+

Rect

+

矩形的定义 更多...

+

RangeValue

+

取值范围的定义 更多...

+
+ +## 枚举 + + + + + + + + + + + + + + + + + + + + + + +

枚举

+

描述

+

CodecType { VIDEO_DECODER, VIDEO_ENCODER, AUDIO_DECODER, AUDIO_ENCODER, INVALID_TYPE }

+

枚举编解码的类型 更多...

+

Profile { INVALID_PROFILE = 0, AAC_LC_PROFILE = 0x1000, AAC_MAIN_PROFILE, AAC_HE_V1_PROFILE, AAC_HE_V2_PROFILE, AAC_LD_PROFILE, AAC_ELD_PROFILE, AVC_BASELINE_PROFILE = 0x2000, AVC_MAIN_PROFILE, AVC_HIGH_PROFILE, HEVC_MAIN_PROFILE = 0x3000, HEVC_MAIN_10_PROFILE }

+

枚举Codec规格 更多...

+

AudioSampleRate { AUD_SAMPLE_RATE_8000 = 8000, AUD_SAMPLE_RATE_12000 = 12000, AUD_SAMPLE_RATE_11025 = 11025, AUD_SAMPLE_RATE_16000 = 16000, AUD_SAMPLE_RATE_22050 = 22050, AUD_SAMPLE_RATE_24000 = 24000, AUD_SAMPLE_RATE_32000 = 32000, AUD_SAMPLE_RATE_44100 = 44100, AUD_SAMPLE_RATE_48000 = 48000, AUD_SAMPLE_RATE_64000 = 64000, AUD_SAMPLE_RATE_96000 = 96000, AUD_SAMPLE_RATE_INVALID }

+

枚举音频采样率 更多...

+

CodecCapsMask { CODEC_CAP_ADAPTIVE_PLAYBACK = 0x1, CODEC_CAP_SECURE_PLAYBACK = 0x2, CODEC_CAP_TUNNEL_PLAYBACK = 0x4, CODEC_CAP_MULTI_PLANE = 0x10000 }

+

枚举播放能力 更多...

+

CodecProcessMode { PROCESS_BLOCKING_INPUT_BUFFER = 0X1, PROCESS_BLOCKING_OUTPUT_BUFFER = 0X2, PROCESS_BLOCKING_CONTROL_FLOW = 0X4, PROCESS_NONBLOCKING_INPUT_BUFFER = 0X100, PROCESS_NONBLOCKING_OUTPUT_BUFFER = 0X200, PROCESS_NONBLOCKING_CONTROL_FLOW = 0X400 }

+

枚举编解码处理模式 更多...

+
+ +## **详细描述** + +Codec模块接口定义中使用的自定义数据类型。 + +Codec模块接口定义中使用的自定义数据类型，包括编解码类型、音视频参数、buffer定义等。 + +**Since：** + +3.1 + +**Version：** + +2.0 + diff --git a/zh-cn/device-dev/api/toctopics/codec__component__if_8h.md b/zh-cn/device-dev/api/toctopics/codec__component__if_8h.md new file mode 100644 index 0000000000..dba5966834 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/codec__component__if_8h.md @@ -0,0 +1,63 @@ +# codec\_component\_if.h + +## **概述** + +**所属模块:** + +[Codec](_codec.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

CodecComponentType

+

Codec组件接口定义。 更多...

+
+ +## 函数 + + + + + + + + + + + + + +

函数

+

描述

+

CodecComponentTypeGet (struct HdfRemoteService *remote)

+

实例化CodecComponentType对象。 更多...

+

CodecComponentTypeRelease (struct CodecComponentType *instance)

+

释放CodecComponentType对象。 更多...

+
+ +## **详细描述** + +主要包括Codec组件接口定义。 + +Codec模块提供了获取组件信息、给组件发送命令、组件参数设置、buffer轮转和控制等接口定义。创建组件后，可使用下列接口进行编解码处理。 + +**Since：** + +3.1 + +**Version：** + +2.0 + diff --git a/zh-cn/device-dev/api/toctopics/codec__component__manager_8h.md b/zh-cn/device-dev/api/toctopics/codec__component__manager_8h.md new file mode 100644 index 0000000000..67196af101 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/codec__component__manager_8h.md @@ -0,0 +1,63 @@ +# codec\_component\_manager.h + +## **概述** + +**所属模块:** + +[Codec](_codec.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

CodecComponentManager

+

Codec组件管理类接口定义。 更多...

+
+ +## 函数 + + + + + + + + + + + + + +

函数

+

描述

+

GetCodecComponentManager (void)

+

实例化CodecComponentManager对象。 更多...

+

CodecComponentManagerRelease (void)

+

释放CodecComponentManager对象。 更多...

+
+ +## **详细描述** + +主要包括Codec组件管理类接口。 + +Codec模块获取组件编解码能力集、创建组件和销毁组件等接口定义。 + +**Since：** + +3.1 + +**Version：** + +2.0 + diff --git a/zh-cn/device-dev/api/toctopics/codec__component__type_8h.md b/zh-cn/device-dev/api/toctopics/codec__component__type_8h.md new file mode 100644 index 0000000000..42a988b3ee --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/codec__component__type_8h.md @@ -0,0 +1,180 @@ +# codec\_component\_type.h + +## **概述** + +**所属模块:** + +[Codec](_codec.md) + +## **汇总** + +## 类 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

类

+

描述

+

VideoPortCap

+

定义视频编解码能力 更多...

+

AudioPortCap

+

定义音频编解码能力 更多...

+

PortCap

+

定义音视频编解码能力 更多...

+

CodecCompCapability

+

定义Codec编解码能力 更多...

+

OmxCodecBuffer

+

Codec buffer信息的定义 更多...

+

CompVerInfo

+

定义组件版本信息 更多...

+

EventInfo

+

定义事件上报信息 更多...

+

SupportBufferType

+

SupportBuffer类型定义. 更多...

+

UseBufferType

+

UseBuffer类型定义 更多...

+

GetBufferHandleUsageParams

+

BufferHandleUsage类型定义 更多...

+
+ +## 宏定义 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

宏定义

+

描述

+

SAMPLE_FMT_NUM 32

+

采样格式最大值

+

UUID_LENGTH 128

+

定义UUID长度

+

PIX_FORMAT_NUM 16

+

支持的像素格式数组大小

+

SAMPLE_FORMAT_NUM 12

+

支持的音频采样格式数组大小

+

SAMPLE_RATE_NUM 16

+

支持的音频采样率数组大小

+

CHANNEL_NUM 16

+

支持的音频通道数组大小

+

NAME_LENGTH 32

+

组件名称大小

+

PROFILE_NUM 256

+

支持的profile数组大小

+
+ +## 枚举 + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举

+

描述

+

AvCodecRole { MEDIA_ROLETYPE_IMAGE_JPEG = 0, MEDIA_ROLETYPE_VIDEO_AVC, MEDIA_ROLETYPE_VIDEO_HEVC, MEDIA_ROLETYPE_AUDIO_FIRST = 0x10000, MEDIA_ROLETYPE_AUDIO_AAC = 0x10000, MEDIA_ROLETYPE_AUDIO_G711A, MEDIA_ROLETYPE_AUDIO_G711U, MEDIA_ROLETYPE_AUDIO_G726, MEDIA_ROLETYPE_AUDIO_PCM, MEDIA_ROLETYPE_AUDIO_MP3, MEDIA_ROLETYPE_INVALID }

+

枚举音视频编解码组件类型 更多...

+

AudioSampleFormat { AUDIO_SAMPLE_FORMAT_S8, AUDIO_SAMPLE_FORMAT_S8P, AUDIO_SAMPLE_FORMAT_U8, AUDIO_SAMPLE_FORMAT_U8P, AUDIO_SAMPLE_FORMAT_S16, AUDIO_SAMPLE_FORMAT_S16P, AUDIO_SAMPLE_FORMAT_U16, AUDIO_SAMPLE_FORMAT_U16P, AUDIO_SAMPLE_FORMAT_S24, AUDIO_SAMPLE_FORMAT_S24P, AUDIO_SAMPLE_FORMAT_U24, AUDIO_SAMPLE_FORMAT_U24P, AUDIO_SAMPLE_FORMAT_S32, AUDIO_SAMPLE_FORMAT_S32P, AUDIO_SAMPLE_FORMAT_U32, AUDIO_SAMPLE_FORMAT_U32P, AUDIO_SAMPLE_FORMAT_S64, AUDIO_SAMPLE_FORMAT_S64P, AUDIO_SAMPLE_FORMAT_U64, AUDIO_SAMPLE_FORMAT_U64P, AUDIO_SAMPLE_FORMAT_F32, AUDIO_SAMPLE_FORMAT_F32P, AUDIO_SAMPLE_FORMAT_F64, AUDIO_SAMPLE_FORMAT_F64P, AUDIO_SAMPLE_FMT_U8, AUDIO_SAMPLE_FMT_S16, AUDIO_SAMPLE_FMT_S32, AUDIO_SAMPLE_FMT_FLOAT, AUDIO_SAMPLE_FMT_DOUBLE, AUDIO_SAMPLE_FMT_U8P, AUDIO_SAMPLE_FMT_S16P, AUDIO_SAMPLE_FMT_S32P, AUDIO_SAMPLE_FMT_FLOATP, AUDIO_SAMPLE_FMT_DOUBLEP, AUDIO_SAMPLE_FMT_INVALID }

+

枚举音频采样格式 更多...

+

CodecBufferType { CODEC_BUFFER_TYPE_INVALID = 0, CODEC_BUFFER_TYPE_VIRTUAL_ADDR = 0x1, CODEC_BUFFER_TYPE_AVSHARE_MEM_FD = 0x2, CODEC_BUFFER_TYPE_HANDLE = 0x4, CODEC_BUFFER_TYPE_DYNAMIC_HANDLE = 0x8 }

+

定义buffer类型 更多...

+

ShareMemTypes { READ_WRITE_TYPE = 0x1, READ_ONLY_TYPE = 0x2 }

+

枚举共享内存类型 更多...

+

OmxIndexCodecExType { OMX_IndexExtBufferTypeStartUnused = OMX_IndexKhronosExtensions + 0x00a00000, OMX_IndexParamSupportBufferType, OMX_IndexParamUseBufferType, OMX_IndexParamGetBufferHandleUsage }

+

枚举Codec扩展index 更多...

+

OmxVideoExType { OMX_VIDEO_CodingHEVC = 11 }

+

枚举Codec扩展编码类型 更多...

+
+ +## **详细描述** + +Codec模块接口定义中使用的自定义数据类型。 + +Codec模块接口定义中使用的自定义数据类型，包括编解码类型、音视频参数、buffer定义等。 + +**Since：** + +3.1 + +**Version：** + +2.0 + diff --git a/zh-cn/device-dev/api/toctopics/dac__if_8h.md b/zh-cn/device-dev/api/toctopics/dac__if_8h.md new file mode 100644 index 0000000000..098a002a8c --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/dac__if_8h.md @@ -0,0 +1,62 @@ +# dac\_if.h + +## **概述** + +**所属模块:** + +[DAC](_d_a_c.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

DacIoMsg

+

DAC设备信息传输结构体 更多...

+
+ +## 函数 + + + + + + + + + + + + + + + + +

函数

+

描述

+

DacOpen (uint32_t number)

+

获取DAC控制器的句柄。 更多...

+

DacClose (DevHandle handle)

+

释放DAC控制器的句柄。 更多...

+

DacWrite (DevHandle handle, uint32_t channel, uint32_t val)

+

启动DAC设备进行传输，将目标值写入指定的DAC通道。 更多...

+
+ +## **详细描述** + +声明标准DAC接口函数。 + +**Since：** + +3.1 + diff --git a/zh-cn/device-dev/api/toctopics/display__device_8h.md b/zh-cn/device-dev/api/toctopics/display__device_8h.md new file mode 100644 index 0000000000..b12c3425ec --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/display__device_8h.md @@ -0,0 +1,88 @@ +# display\_device.h + +## **概述** + +**所属模块:** + +[Display](_display.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

DeviceFuncs

+

显示设备控制接口结构体，定义显示设备控制接口函数指针。 更多...

+
+ +## 类型定义 + + + + + + + + + + + + + + + + +

类型定义

+

描述

+

(HotPlugCallback) (uint32_t devId, bool connected, void *data)

+

注册热插拔事件回调

+

(VBlankCallback) (unsigned int sequence, uint64_t ns, void *data)

+

注册VBlank事件回调。

+

(RefreshCallback) (uint32_t devId, void *data)

+

刷新请求回调。

+
+ +## 函数 + + + + + + + + + + + + + +

函数

+

描述

+

DeviceInitialize (DeviceFuncs **funcs)

+

实现显示设备控制接口的初始化，申请操作显示设备控制接口的资源，并获取对应的操作接口。 更多...

+

DeviceUninitialize (DeviceFuncs *funcs)

+

取消显示设备控制接口的初始化，释放控制接口使用到的资源。 更多...

+
+ +## **详细描述** + +显示设备控制接口声明。 + +**Since：** + +1.0 + +**Version：** + +2.0 + diff --git a/zh-cn/device-dev/api/toctopics/display__gfx_8h.md b/zh-cn/device-dev/api/toctopics/display__gfx_8h.md new file mode 100644 index 0000000000..47d4f526b3 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/display__gfx_8h.md @@ -0,0 +1,61 @@ +# display\_gfx.h + +## **概述** + +**所属模块:** + +[Display](_display.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

GfxFuncs

+

显示硬件加速驱动接口结构体，定义硬件加速驱动接口函数指针。 更多...

+
+ +## 函数 + + + + + + + + + + + + + +

函数

+

描述

+

GfxInitialize (GfxFuncs **funcs)

+

获取硬件加速相关的操作接口指针。 更多...

+

GfxUninitialize (GfxFuncs *funcs)

+

释放硬件加速相关的操作接口指针。 更多...

+
+ +## **详细描述** + +显示硬件加速驱动接口声明。 + +**Since：** + +1.0 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/display__gralloc_8h.md b/zh-cn/device-dev/api/toctopics/display__gralloc_8h.md new file mode 100644 index 0000000000..cd018c7762 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/display__gralloc_8h.md @@ -0,0 +1,61 @@ +# display\_gralloc.h + +## **概述** + +**所属模块:** + +[Display](_display.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

GrallocFuncs

+

显示内存驱动接口结构体，定义显示内存驱动接口函数指针。 更多...

+
+ +## 函数 + + + + + + + + + + + + + +

函数

+

描述

+

GrallocInitialize (GrallocFuncs **funcs)

+

初始化内存模块，并获取内存提供的操作接口。 更多...

+

GrallocUninitialize (GrallocFuncs *funcs)

+

取消初始化内存模块，并释放内存操作接口指针。 更多...

+
+ +## **详细描述** + +显示内存驱动接口声明。 + +**Since：** + +1.0 + +**Version：** + +2.0 + diff --git a/zh-cn/device-dev/api/toctopics/display__layer_8h.md b/zh-cn/device-dev/api/toctopics/display__layer_8h.md new file mode 100644 index 0000000000..30f06b89e6 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/display__layer_8h.md @@ -0,0 +1,61 @@ +# display\_layer.h + +## **概述** + +**所属模块:** + +[Display](_display.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

LayerFuncs

+

显示图层驱动接口结构体，定义显示图层驱动接口函数指针。 更多...

+
+ +## 函数 + + + + + + + + + + + + + +

函数

+

描述

+

LayerInitialize (LayerFuncs **funcs)

+

实现图层初始化功能，申请图层使用的资源，并获取图层提供的操作接口。 更多...

+

LayerUninitialize (LayerFuncs *funcs)

+

取消图层初始化功能，释放图层使用到的资源，并释放图层操作接口指针。 更多...

+
+ +## **详细描述** + +显示图层驱动接口声明。 + +**Since：** + +1.0 + +**Version：** + +2.0 + diff --git a/zh-cn/device-dev/api/toctopics/display__type_8h.md b/zh-cn/device-dev/api/toctopics/display__type_8h.md new file mode 100644 index 0000000000..a44f46b2db --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/display__type_8h.md @@ -0,0 +1,258 @@ +# display\_type.h + +## **概述** + +**所属模块:** + +[Display](_display.md) + +## **汇总** + +## 类 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

类

+

描述

+

DisplayInfo

+

定义显示信息结构体 更多...

+

LayerInfo

+

定义图层信息结构体 更多...

+

LayerAlpha

+

定义图层Alpha信息的结构体 更多...

+

BufferData

+

定义一层的缓冲区数据，包括虚拟和物理内存地址。 更多...

+

LayerBuffer

+

图层Buffer，用于存放图层数据。 更多...

+

IRect

+

定义矩形信息 更多...

+

ISurface

+

用于存放窗口相关信息的结构体定义，提供给硬件加速使用，例如图像合成，位图搬移等操作。 更多...

+

ILine

+

线条描述结构体定义，用于硬件加速绘制直线。 更多...

+

ICircle

+

圆形描述结构体定义，用于硬件加速绘制圆形。 更多...

+

Rectangle

+

矩形描述结构体定义，用于硬件加速绘制矩形， 更多...

+

GfxOpt

+

图像硬件加速相关的操作选项结构体定义，用于图像硬件加速时的操作选项。 更多...

+

PropertyObject

+

定义包含名称、属性ID和值的属性对象。 更多...

+

DisplayCapability

+

定义输出性能。 更多...

+

DisplayModeInfo

+

定义输出模式信息。 更多...

+

AllocInfo

+

定义关于要分配的内存的信息。 更多...

+

HDRCapability

+

HDR属性结构体定义 更多...

+

HDRMetaData

+

HDR元数据结构体定义 更多...

+

VerifyAllocInfo

+

用于验证内存分配信息的结构体定义 更多...

+

PresentTimestamp

+

上屏时间戳结构体定义 更多...

+

__attribute__

+

扩展数据句柄结构体定义 更多...

+
+ +## 宏定义 + + + + + + + + + + +

宏定义

+

描述

+

PROPERTY_NAME_LEN 50

+

属性名称长度

+
+ +## 枚举 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举

+

描述

+

DispErrCode { DISPLAY_SUCCESS = 0, DISPLAY_FAILURE = -1, DISPLAY_FD_ERR = -2, DISPLAY_PARAM_ERR = -3, DISPLAY_NULL_PTR = -4, DISPLAY_NOT_SUPPORT = -5, DISPLAY_NOMEM = -6, DISPLAY_SYS_BUSY = -7, DISPLAY_NOT_PERM = -8 }

+

返回值类型定义。 更多...

+

LayerType { LAYER_TYPE_GRAPHIC, LAYER_TYPE_OVERLAY, LAYER_TYPE_SDIEBAND, LAYER_TYPE_CURSOR, LAYER_TYPE_BUTT }

+

图层类型定义。 更多...

+

{ HBM_USE_CPU_READ = (1 << 0), HBM_USE_CPU_WRITE = (1 << 1), HBM_USE_MEM_MMZ = (1 << 2), HBM_USE_MEM_DMA = (1 << 3), HBM_USE_MEM_SHARE = (1 << 4), HBM_USE_MEM_MMZ_CACHE = (1 << 5), HBM_USE_MEM_FB = (1 << 6), HBM_USE_ASSIGN_SIZE = (1 << 7) }

+

缓冲区定义。更多...

+

PixelFormat { PIXEL_FMT_CLUT8 = 0, PIXEL_FMT_CLUT1, PIXEL_FMT_CLUT4, PIXEL_FMT_RGB_565, PIXEL_FMT_RGBA_5658, PIXEL_FMT_RGBX_4444, PIXEL_FMT_RGBA_4444, PIXEL_FMT_RGB_444, PIXEL_FMT_RGBX_5551, PIXEL_FMT_RGBA_5551, PIXEL_FMT_RGB_555, PIXEL_FMT_RGBX_8888, PIXEL_FMT_RGBA_8888, PIXEL_FMT_RGB_888, PIXEL_FMT_BGR_565, PIXEL_FMT_BGRX_4444, PIXEL_FMT_BGRA_4444, PIXEL_FMT_BGRX_5551, PIXEL_FMT_BGRA_5551, PIXEL_FMT_BGRX_8888, PIXEL_FMT_BGRA_8888, PIXEL_FMT_YUV_422_I, PIXEL_FMT_YCBCR_422_SP, PIXEL_FMT_YCRCB_422_SP, PIXEL_FMT_YCBCR_420_SP, PIXEL_FMT_YCRCB_420_SP, PIXEL_FMT_YCBCR_422_P, PIXEL_FMT_YCRCB_422_P, PIXEL_FMT_YCBCR_420_P, PIXEL_FMT_YCRCB_420_P, PIXEL_FMT_YUYV_422_PKG, PIXEL_FMT_UYVY_422_PKG, PIXEL_FMT_YVYU_422_PKG, PIXEL_FMT_VYUY_422_PKG, PIXEL_FMT_VENDER_MASK = 0X7FFF0000, PIXEL_FMT_BUTT = 0X7FFFFFFF }

+

像素格式类型定义。 更多...

+

TransformType { ROTATE_NONE = 0, ROTATE_90, ROTATE_180, ROTATE_270, ROTATE_BUTT }

+

图层变换类型定义。 更多...

+

BlendType { BLEND_NONE = 0, BLEND_CLEAR, BLEND_SRC, BLEND_SRCOVER, BLEND_DSTOVER, BLEND_SRCIN, BLEND_DSTIN, BLEND_SRCOUT, BLEND_DSTOUT, BLEND_SRCATOP, BLEND_DSTATOP, BLEND_ADD, BLEND_XOR, BLEND_DST, BLEND_AKS, BLEND_AKD, BLEND_BUTT }

+

显示内存类型定义。 更多...

+

RopType { ROP_BLACK = 0, ROP_NOTMERGEPEN, ROP_MASKNOTPEN, ROP_NOTCOPYPEN, ROP_MASKPENNOT, ROP_NOT, ROP_XORPEN, ROP_NOTMASKPEN, ROP_MASKPEN, ROP_NOTXORPEN, ROP_NOP, ROP_MERGENOTPEN, ROP_COPYPE, ROP_MERGEPENNOT, ROP_MERGEPEN, ROP_WHITE, ROP_BUTT }

+

硬件加速支持的ROP操作类型。 更多...

+

ColorKey { CKEY_NONE = 0, CKEY_SRC, CKEY_DST, CKEY_BUTT }

+

Color key操作类型定义，即硬件加速支持的Color key操作类型。 更多...

+

MirrorType { MIRROR_NONE = 0, MIRROR_LR, MIRROR_TB, MIRROR_BUTT }

+

硬件加速支持的镜像操作类型定义 更多...

+

Connection { CON_INVALID = 0, CONNECTED, DISCONNECTED }

+

热插拔连接类型定义 更多...

+

InterfaceType { DISP_INTF_HDMI = 0, DISP_INTF_LCD, DISP_INTF_BT1120, DISP_INTF_BT656, DISP_INTF_YPBPR, DISP_INTF_RGB, DISP_INTF_CVBS, DISP_INTF_SVIDEO, DISP_INTF_VGA, DISP_INTF_MIPI, DISP_INTF_PANEL, DISP_INTF_BUTT }

+

枚举接口类型。 更多...

+

DispPowerStatus { POWER_STATUS_ON, POWER_STATUS_STANDBY, POWER_STATUS_SUSPEND, POWER_STATUS_OFF, POWER_STATUS_BUTT }

+

枚举显示状态 更多...

+

CompositionType { COMPOSITION_CLIENT, COMPOSITION_DEVICE, COMPOSITION_CURSOR, COMPOSITION_VIDEO, COMPOSITION_DEVICE_CLEAR, COMPOSITION_CLIENT_CLEAR, COMPOSITION_TUNNEL, COMPOSITION_BUTT }

+

枚举特殊层的组合类型。 更多...

+

ColorGamut { COLOR_GAMUT_INVALID = -1, COLOR_GAMUT_NATIVE = 0, COLOR_GAMUT_SATNDARD_BT601 = 1, COLOR_GAMUT_STANDARD_BT709 = 2, COLOR_GAMUT_DCI_P3 = 3, COLOR_GAMUT_SRGB = 4, COLOR_GAMUT_ADOBE_RGB = 5, COLOR_GAMUT_DISPLAY_P3 = 6, COLOR_GAMUT_BT2020 = 7, COLOR_GAMUT_BT2100_PQ = 8, COLOR_GAMUT_BT2100_HLG = 9, COLOR_GAMUT_DISPLAY_BT2020 = 10 }

+

色域类型枚举值 更多...

+

GamutMap { GAMUT_MAP_CONSTANT = 0, GAMUT_MAP_EXPANSION = 1, GAMUT_MAP_HDR_CONSTANT = 2, GAMUT_MAP_HDR_EXPANSION = 3 }

+

枚举色域的映射类型 更多...

+

ColorDataSpace { COLOR_DATA_SPACE_UNKNOWN = 0, GAMUT_BT601 = 0x00000001, GAMUT_BT709 = 0x00000002, GAMUT_DCI_P3 = 0x00000003, GAMUT_SRGB = 0x00000004, GAMUT_ADOBE_RGB = 0x00000005, GAMUT_DISPLAY_P3 = 0x00000006, GAMUT_BT2020 = 0x00000007, GAMUT_BT2100_PQ = 0x00000008, GAMUT_BT2100_HLG = 0x00000009, GAMUT_DISPLAY_BT2020 = 0x0000000a, TRANSFORM_FUNC_UNSPECIFIED = 0x00000100, TRANSFORM_FUNC_LINEAR = 0x00000200, TRANSFORM_FUNC_SRGB = 0x00000300, TRANSFORM_FUNC_SMPTE_170M = 0x00000400, TRANSFORM_FUNC_GM2_2 = 0x00000500, TRANSFORM_FUNC_GM2_6 = 0x00000600, TRANSFORM_FUNC_GM2_8 = 0x00000700, TRANSFORM_FUNC_ST2084 = 0x00000800, TRANSFORM_FUNC_HLG = 0x00000900, PRECISION_UNSPECIFIED = 0x00010000, PRECISION_FULL = 0x00020000, PRESION_LIMITED = 0x00030000, PRESION_EXTENDED = 0x00040000, BT601_SMPTE170M_FULL = GAMUT_BT601 | TRANSFORM_FUNC_SMPTE_170M | PRECISION_FULL, BT601_SMPTE170M_LIMITED = GAMUT_BT601 | TRANSFORM_FUNC_SMPTE_170M | PRESION_LIMITED, BT709_LINEAR_FULL = GAMUT_BT709 | TRANSFORM_FUNC_LINEAR | PRECISION_FULL, BT709_LINEAR_EXTENDED = GAMUT_BT709 | TRANSFORM_FUNC_LINEAR | PRESION_EXTENDED, BT709_SRGB_FULL = GAMUT_BT709 | TRANSFORM_FUNC_SRGB | PRECISION_FULL, BT709_SRGB_EXTENDED = GAMUT_BT709 | TRANSFORM_FUNC_SRGB | PRESION_EXTENDED, BT709_SMPTE170M_LIMITED = GAMUT_BT709 | TRANSFORM_FUNC_SMPTE_170M | PRESION_LIMITED, DCI_P3_LINEAR_FULL = GAMUT_DCI_P3 | TRANSFORM_FUNC_LINEAR | PRECISION_FULL, DCI_P3_GAMMA26_FULL = GAMUT_DCI_P3 | TRANSFORM_FUNC_GM2_6 | PRECISION_FULL, DISPLAY_P3_LINEAR_FULL = GAMUT_DISPLAY_P3 | TRANSFORM_FUNC_LINEAR | PRECISION_FULL, DCI_P3_SRGB_FULL = GAMUT_DCI_P3 | TRANSFORM_FUNC_SRGB | PRECISION_FULL, ADOBE_RGB_GAMMA22_FULL = GAMUT_ADOBE_RGB | TRANSFORM_FUNC_GM2_2 | PRECISION_FULL, BT2020_LINEAR_FULL = GAMUT_BT2020 | TRANSFORM_FUNC_LINEAR | PRECISION_FULL, BT2020_SRGB_FULL = GAMUT_BT2020 | TRANSFORM_FUNC_SRGB | PRECISION_FULL, BT2020_SMPTE170M_FULL = GAMUT_BT2020 | TRANSFORM_FUNC_SMPTE_170M | PRECISION_FULL, BT2020_ST2084_FULL = GAMUT_BT2020 | TRANSFORM_FUNC_ST2084 | PRECISION_FULL, BT2020_HLG_FULL = GAMUT_BT2020 | TRANSFORM_FUNC_HLG | PRECISION_FULL, BT2020_ST2084_LIMITED = GAMUT_BT2020 | TRANSFORM_FUNC_ST2084 | PRESION_LIMITED }

+

枚举颜色空间的类型 更多...

+

HDRFormat { NOT_SUPPORT_HDR = 0, DOLBY_VISION = 1, HDR10 = 2, HLG = 3, HDR10_PLUS = 4, HDR_VIVID = 5 }

+

枚举HDR格式 更多...

+

HDRMetadataKey { MATAKEY_RED_PRIMARY_X = 0, MATAKEY_RED_PRIMARY_Y = 1, MATAKEY_GREEN_PRIMARY_X = 2, MATAKEY_GREEN_PRIMARY_Y = 3, MATAKEY_BLUE_PRIMARY_X = 4, MATAKEY_BLUE_PRIMARY_Y = 5, MATAKEY_WHITE_PRIMARY_X = 6, MATAKEY_WHITE_PRIMARY_Y = 7, MATAKEY_MAX_LUMINANCE = 8, MATAKEY_MIN_LUMINANCE = 9, MATAKEY_MAX_CONTENT_LIGHT_LEVEL = 10, MATAKEY_MAX_FRAME_AVERAGE_LIGHT_LEVEL = 11, MATAKEY_HDR10_PLUS = 12, MATAKEY_HDR_VIVID = 13 }

+

枚举HDR元数据关键字 更多...

+

PresentTimestampType { HARDWARE_DISPLAY_PTS_UNSUPPORTED = 0, HARDWARE_DISPLAY_PTS_DELAY = 1 << 0, HARDWARE_DISPLAY_PTS_TIMESTAMP = 1 << 1 }

+

上屏时间戳类型枚举值 更多...

+
+ +## **详细描述** + +显示类型定义，定义显示驱动接口所使用的数据类型。 + +**Since：** + +1.0 + +**Version：** + +2.0 + diff --git a/zh-cn/device-dev/api/toctopics/face__auth_2_i_executor_8idl.md b/zh-cn/device-dev/api/toctopics/face__auth_2_i_executor_8idl.md new file mode 100644 index 0000000000..07300803f4 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/face__auth_2_i_executor_8idl.md @@ -0,0 +1,52 @@ +# FACEAUTH\_IExecutor.idl + +## **概述** + +**所属模块:** + +[HdfFaceAuth](_hdf_face_auth.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

IExecutor

+

定义执行器接口，用于获取执行器，获取凭据模版信息，注册人脸特征模版，进行用户人脸认证，删除人脸特征模版等。 更多...

+
+ +## 变量 + + + + + + + + + + +

变量 名称

+

描述

+

package ohos.hdi.face_auth.v1_0

+

人脸认证接口的包路径

+
+ +## **详细描述** + +定义执行器接口，用于获取执行器，获取凭据模版信息，注册人脸特征模版，进行用户人脸认证，删除人脸特征模版等。 + +**Since：** + +3.2 + diff --git a/zh-cn/device-dev/api/toctopics/face__auth_2_i_executor_callback_8idl.md b/zh-cn/device-dev/api/toctopics/face__auth_2_i_executor_callback_8idl.md new file mode 100644 index 0000000000..697b05f517 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/face__auth_2_i_executor_callback_8idl.md @@ -0,0 +1,52 @@ +# FACEAUTH\_IExecutorCallback.idl + +## **概述** + +**所属模块:** + +[HdfFaceAuth](_hdf_face_auth.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

IExecutorCallback

+

定义异步API接口回调，用于返回异步接口的请求处理结果和信息。使用细节见IExecutor。 更多...

+
+ +## 变量 + + + + + + + + + + +

变量 名称

+

描述

+

package ohos.hdi.face_auth.v1_0

+

人脸认证接口的包路径

+
+ +## **详细描述** + +定义异步API接口回调，用于返回异步接口的请求处理结果和信息。 + +**Since：** + +3.2 + diff --git a/zh-cn/device-dev/api/toctopics/files.md b/zh-cn/device-dev/api/toctopics/files.md new file mode 100644 index 0000000000..d8579b7c58 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/files.md @@ -0,0 +1,131 @@ +# 头文件 + +- **[audio\_adapter.h](audio__adapter_8h.md)** + +- **[audio\_attribute.h](audio__attribute_8h.md)** + +- **[audio\_capture.h](audio__capture_8h.md)** + +- **[audio\_control.h](audio__control_8h.md)** + +- **[audio\_manager.h](audio__manager_8h.md)** + +- **[audio\_render.h](audio__render_8h.md)** + +- **[audio\_scene.h](audio__scene_8h.md)** + +- **[audio\_types.h](audio__types_8h.md)** + +- **[audio\_volume.h](audio__volume_8h.md)** + +- **[codec\_callback\_if.h](codec__callback__if_8h.md)** + +- **[codec\_common\_type.h](codec__common__type_8h.md)** + +- **[codec\_component\_if.h](codec__component__if_8h.md)** + +- **[codec\_component\_manager.h](codec__component__manager_8h.md)** + +- **[codec\_component\_type.h](codec__component__type_8h.md)** + +- **[dac\_if.h](dac__if_8h.md)** + +- **[display\_device.h](display__device_8h.md)** + +- **[display\_gfx.h](display__gfx_8h.md)** + +- **[display\_gralloc.h](display__gralloc_8h.md)** + +- **[display\_layer.h](display__layer_8h.md)** + +- **[display\_type.h](display__type_8h.md)** + +- **[icamera\_device\_callback.h](icamera__device__callback_8h.md)** + +- **[icamera\_device.h](icamera__device_8h.md)** + +- **[icamera\_host\_callback.h](icamera__host__callback_8h.md)** + +- **[icamera\_host.h](icamera__host_8h.md)** + +- **[input\_controller.h](input__controller_8h.md)** + +- **[input\_manager.h](input__manager_8h.md)** + +- **[input\_reporter.h](input__reporter_8h.md)** + +- **[input\_type.h](input__type_8h.md)** + +- **[ioffline\_stream\_operator.h](ioffline__stream__operator_8h.md)** + +- **[istream\_operator\_callback.h](istream__operator__callback_8h.md)** + +- **[istream\_operator.h](istream__operator_8h.md)** + +- **[light\_if.h](light__if_8h.md)** + +- **[light\_type.h](light_8typeh.md)** + +- **[sensor\_if.h](sensor__if_8h.md)** + +- **[sensor\_type.h](sensor__type_8h.md)** + +- **[types.h](types_8h.md)** + +- **[usb\_info.h](usb__info_8h.md)** + +- **[usbd\_client.h](usbd__client_8h.md)** + +- **[usbd\_subscriber.h](usbd__subscriber_8h.md)** + +- **[usbd\_type.h](usbd__type_8h.md)** + +- **[vibrator\_if.h](vibrator__if_8h.md)** + +- **[vibrator\_type.h](vibrator__type_8h.md)** + +- **[wifi\_hal\_ap\_feature.h](wifi__hal__ap__feature_8h.md)** + +- **[wifi\_hal\_base\_feature.h](wifi__hal__base__feature_8h.md)** + +- **[wifi\_hal\_sta\_feature.h](wifi__hal__sta__feature_8h.md)** + +- **[wifi\_hal.h](wifi__hal_8h.md)** + +- **[FACEAUTH\_IExecutor.idl](face__auth_2_i_executor_8idl.md)** + +- **[FACEAUTH\_IExecutorCallback.idl](face__auth_2_i_executor_callback_8idl.md)** + +- **[FaceAuthTypes.idl](_face_auth_types_8idl.md)** + +- **[IBatteryCallback.idl](_i_battery_callback_8idl.md)** + +- **[IBatteryInterface.idl](_i_battery_interface_8idl.md)** + +- **[IExecutor.idl](pin__auth_2_i_executor_8idl.md)** + +- **[IExecutorCallback.idl](pin__auth_2_i_executor_callback_8idl.md)** + +- **[IFaceAuthInterface.idl](_i_face_auth_interface_8idl.md)** + +- **[IPinAuthInterface.idl](_i_pin_auth_interface_8idl.md)** + +- **[IPowerHdiCallback.idl](_i_power_hdi_callback_8idl.md)** + +- **[IPowerInterface.idl](_i_power_interface_8idl.md)** + +- **[IThermalInterface.idl](_i_thermal_interface_8idl.md)** + +- **[IThermalCallback.idl](_i_thermal_callback_8idl.md)** + +- **[IUserAuthInterface.idl](_i_user_auth_interface_8idl.md)** + +- **[PowerTypes.idl](_power_types_8idl.md)** + +- **[ThermalTypes.idl](_thermal_types_8idl.md)** + +- **[Types.idl](_types_8idl.md)** + +- **[UserAuthTypes.idl](_user_auth_types_8idl.md)** + + diff --git a/zh-cn/device-dev/api/toctopics/icamera__device_8h.md b/zh-cn/device-dev/api/toctopics/icamera__device_8h.md new file mode 100644 index 0000000000..e0827a8120 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/icamera__device_8h.md @@ -0,0 +1,39 @@ +# icamera\_device.h + +## **概述** + +**所属模块:** + +[Camera](_camera.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

OHOS::Camera::ICameraDevice

+

Camera设备操作。

+
+ +## **详细描述** + +Camera设备操作接口。 + +**Since：** + +1.0 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/icamera__device__callback_8h.md b/zh-cn/device-dev/api/toctopics/icamera__device__callback_8h.md new file mode 100644 index 0000000000..60e87d217c --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/icamera__device__callback_8h.md @@ -0,0 +1,39 @@ +# icamera\_device\_callback.h + +## **概述** + +**所属模块:** + +[Camera](_camera.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

OHOS::Camera::ICameraDeviceCallback

+

Camera设备操作回调。

+
+ +## **详细描述** + +Camera设备的回调接口，主要包含camera设备发生错误时和上报metadata的回调函数。 + +**Since：** + +1.0 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/icamera__host_8h.md b/zh-cn/device-dev/api/toctopics/icamera__host_8h.md new file mode 100644 index 0000000000..160ccb93df --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/icamera__host_8h.md @@ -0,0 +1,39 @@ +# icamera\_host.h + +## **概述** + +**所属模块:** + +[Camera](_camera.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

OHOS::Camera::ICameraHost

+

Camera服务的管理类。

+
+ +## **详细描述** + +Camera服务的管理类，对上层提供HDI接口。 + +**Since：** + +1.0 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/icamera__host__callback_8h.md b/zh-cn/device-dev/api/toctopics/icamera__host__callback_8h.md new file mode 100644 index 0000000000..e482262c6c --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/icamera__host__callback_8h.md @@ -0,0 +1,39 @@ +# icamera\_host\_callback.h + +## **概述** + +**所属模块:** + +[Camera](_camera.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

OHOS::Camera::ICameraHostCallback

+

Camera服务的管理回调。

+
+ +## **详细描述** + +ICameraHost的回调接口，提供Camera设备和闪关灯状态变化的回调函数，回调函数由调用者实现。 + +**Since：** + +1.0 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/index.md b/zh-cn/device-dev/api/toctopics/index.md new file mode 100644 index 0000000000..4580e97fa9 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/index.md @@ -0,0 +1,37 @@ +# NativeAPI参考 + +- **[Audio](_audio.md)** + +- **[Battery](battery.md)** + +- **[Camera](_camera.md)** + +- **[Codec](_codec.md)** + +- **[Display](_display.md)** + +- **[DAC](_d_a_c.md)** + +- **[HdfFaceAuth](_hdf_face_auth.md)** + +- **[Input](_input.md)** + +- **[Light](_light.md)** + +- **[HdfPinAuth](_hdf_pin_auth.md)** + +- **[Power](power.md)** + +- **[Sensor](_sensor.md)** + +- **[Thermal](thermal.md)** + +- **[USB](_u_s_b.md)** + +- **[HdfUserAuth](_hdf_user_auth.md)** + +- **[Vibrator](_vibrator.md)** + +- **[WLAN](_w_l_a_n.md)** + + diff --git a/zh-cn/device-dev/api/toctopics/input__controller_8h.md b/zh-cn/device-dev/api/toctopics/input__controller_8h.md new file mode 100644 index 0000000000..8537fac3ee --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/input__controller_8h.md @@ -0,0 +1,39 @@ +# input\_controller.h + +## **概述** + +**所属模块:** + +[Input](_input.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

InputController

+

提供input设备业务控制相关的接口。 更多...

+
+ +## **详细描述** + +描述input设备业务控制相关的接口声明。 + +**Since：** + +1.0 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/input__manager_8h.md b/zh-cn/device-dev/api/toctopics/input__manager_8h.md new file mode 100644 index 0000000000..c22c3135b5 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/input__manager_8h.md @@ -0,0 +1,61 @@ +# input\_manager.h + +## **概述** + +**所属模块:** + +[Input](_input.md) + +## **汇总** + +## 类 + + + + + + + + + + + + + +

类

+

描述

+

InputManager

+

提供input设备管理相关的接口。 更多...

+

IInputInterface

+

定义用于提供输入设备驱动能力的接口。更多...

+
+ +## 函数 + + + + + + + + + + +

函数

+

描述

+

GetInputInterface (IInputInterface **interface)

+

input服务通过调用此接口获取操作input设备的所有接口。 更多...

+
+ +## **详细描述** + +描述input设备管理相关的接口声明。 + +**Since：** + +1.0 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/input__reporter_8h.md b/zh-cn/device-dev/api/toctopics/input__reporter_8h.md new file mode 100644 index 0000000000..6ca5cf08ad --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/input__reporter_8h.md @@ -0,0 +1,39 @@ +# input\_reporter.h + +## **概述** + +**所属模块:** + +[Input](_input.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

InputReporter

+

提供input设备数据上报相关的接口。 更多...

+
+ +## **详细描述** + +描述input设备数据上报相关的接口声明。 + +**Since：** + +1.0 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/input__type_8h.md b/zh-cn/device-dev/api/toctopics/input__type_8h.md new file mode 100644 index 0000000000..4035c8d157 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/input__type_8h.md @@ -0,0 +1,128 @@ +# input\_type.h + +## **概述** + +**所属模块:** + +[Input](_input.md) + +## **汇总** + +## 类 + + + + + + + + + + + + + + + + + + + +

类

+

描述

+

EventPackage

+

input事件数据包结构 更多...

+

InputReportEventCb

+

此结构体定义了输入事件回调函数并提供给input服务使用 更多...

+

DeviceInfo

+

input设备基础设备信息 更多...

+

InputExtraCmd

+

扩展指令的数据结构 更多...

+
+ +## 宏定义 + + + + + + + + + + + + + + + + + + + + + + + + + +

宏定义

+

描述

+

MAX_INPUT_DEV_NUM 32

+

Input设备最大数量。

+

MAX_NODE_PATH_LEN 64

+

节点路径最大长度。

+

CHIP_INFO_LEN 10

+

芯片信息长度。

+

CHIP_NAME_LEN 10

+

芯片名称长度。

+

VENDOR_NAME_LEN 10

+

厂商名称长度。

+

SELF_TEST_RESULT_LEN 20

+

自测结果长度。

+
+ +## 枚举 + + + + + + + + + + + + + + + + + + + +

枚举

+

描述

+

RetStatus { INPUT_SUCCESS = 0, INPUT_FAILURE = -1, INPUT_INVALID_PARAM = -2, INPUT_NOMEM = -3, INPUT_NULL_PTR = -4, INPUT_TIMEOUT = -5, INPUT_UNSUPPORTED = -6 }

+

定义返回值类型 更多...

+

InputDevType { INDEV_TYPE_TOUCH, INDEV_TYPE_KEY, INDEV_TYPE_KEYBOARD, INDEV_TYPE_MOUSE, INDEV_TYPE_BUTTON, INDEV_TYPE_CROWN, INDEV_TYPE_ENCODER, INDEV_TYPE_UNKNOWN }

+

定义input设备类型 更多...

+

PowerStatus { INPUT_RESUME, INPUT_SUSPEND, INPUT_LOW_POWER, INPUT_POWER_STATUS_UNKNOWN }

+

定义电源状态 更多...

+

CapacitanceTest { BASE_TEST, FULL_TEST, MMI_TEST, RUNNING_TEST, TEST_TYPE_UNKNOWN }

+

定义容值测试类型 更多...

+
+ +## **详细描述** + +input设备相关的类型定义，定义了input设备驱动接口所使用的结构体及枚举类型。 + +**Since：** + +1.0 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/interface_i_battery_callback.md b/zh-cn/device-dev/api/toctopics/interface_i_battery_callback.md new file mode 100644 index 0000000000..aa8fd9a5a4 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/interface_i_battery_callback.md @@ -0,0 +1,72 @@ +# IBatteryCallback + +## **概述** + +**所属模块:** + +[Battery](battery.md) + +## **汇总** + +## Public 成员函数 + + + + + + + + + + +

Public 成员函数

+

描述

+

Update ([in] struct BatteryInfo event)

+

电池信息的回调方法。 更多...

+
+ +## **详细描述** + +电池信息的回调。 + +服务创建此回调对象后，可以调用IBatteryInterface的接口注册回调，从而订阅电池信息的变化。 + +**Since：** + +3.1 + +## **成员函数说明** + +## Update\(\) + +``` +IBatteryCallback::Update ([in] struct BatteryInfo event) +``` + +**描述：** + +电池信息的回调方法。 + +当电池信息发生变化时，将通过此方法的参数返回给服务。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

event

+

电池信息，如电量，电压，健康状态等。

+
+ +**参见：** + +[BatteryInfo](_battery_info.md) + diff --git a/zh-cn/device-dev/api/toctopics/interface_i_battery_interface.md b/zh-cn/device-dev/api/toctopics/interface_i_battery_interface.md new file mode 100644 index 0000000000..5981147195 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/interface_i_battery_interface.md @@ -0,0 +1,609 @@ +# IBatteryInterface + +## **概述** + +**所属模块:** + +[Battery](battery.md) + +## **汇总** + +## Public 成员函数 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 成员函数

+

描述

+

Register ([in] IBatteryCallback event)

+

注册电池信息的回调。 更多...

+

UnRegister ()

+

取消注册电池信息的回调。 更多...

+

ChangePath ([in] String path)

+

设置电池信息节点的路径。 更多...

+

GetCapacity ([out] int capacity)

+

获取电池的电量百分比。 更多...

+

GetVoltage ([out] int voltage)

+

获取电池的电压，单位微伏。 更多...

+

GetTemperature ([out] int temperature)

+

获取电池的充电温度，单位0.1摄氏度。 更多...

+

GetHealthState ([out] enum BatteryHealthState healthState)

+

获取电池的健康状态。 更多...

+

GetPluggedType ([out] enum BatteryPluggedType pluggedType)

+

获取充电设备类型。 更多...

+

GetChargeState ([out] enum BatteryChargeState chargeState)

+

获取充电状态。 更多...

+

GetPresent ([out] boolean present)

+

获取是否支持电池或者电池是否在位。 更多...

+

GetTechnology ([out] String technology)

+

获取电池的技术型号。 更多...

+

GetTotalEnergy ([out] int totalEnergy)

+

获取电池的总容量。 更多...

+

GetCurrentAverage ([out] int curAverage)

+

获取电池的平均电流。 更多...

+

GetCurrentNow ([out] int curNow)

+

获取电池的电流。 更多...

+

GetRemainEnergy ([out] int remainEnergy)

+

获取电池的剩余容量。 更多...

+

GetBatteryInfo ([out] struct BatteryInfo info)

+

获取电池的全部信息。 更多...

+
+ +## **详细描述** + +获取、订阅电池信息的接口。 + +服务获取此对象后，可以调用相关的接口获取、订阅电池信息。 + +**Since：** + +3.1 + +## **成员函数说明** + +## ChangePath\(\) + +``` +IBatteryInterface::ChangePath ([in] String path) +``` + +**描述：** + +设置电池信息节点的路径。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

path

+

输入参数，电池信息节点的路径。

+
+ +**返回：** + +HDF\_SUCCESS 表示路径设置成功。 + +## GetBatteryInfo\(\) + +``` +IBatteryInterface::GetBatteryInfo ([out] struct BatteryInfo info) +``` + +**描述：** + +获取电池的全部信息。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

info

+

输出参数，电池的全部信息。

+
+ +**返回：** + +HDF\_SUCCESS 表示获取成功。 + +**参见：** + +[BatteryInfo](_battery_info.md) + +## GetCapacity\(\) + +``` +IBatteryInterface::GetCapacity ([out] int capacity) +``` + +**描述：** + +获取电池的电量百分比。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

capacity

+

输出参数，表示电量的百分比值。

+
+ +**返回：** + +HDF\_SUCCESS 表示获取成功。 + +## GetChargeState\(\) + +``` +IBatteryInterface::GetChargeState ([out] enum BatteryChargeState chargeState) +``` + +**描述：** + +获取充电状态。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

chargeState

+

输出参数，表示充电状态。

+
+ +**返回：** + +HDF\_SUCCESS 表示获取成功。 + +**参见：** + +[BatteryChargeState](battery.md#ga35791cca3603f7855c6368fbd00b21f1) + +## GetCurrentAverage\(\) + +``` +IBatteryInterface::GetCurrentAverage ([out] int curAverage) +``` + +**描述：** + +获取电池的平均电流。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

totalEnergy

+

输出参数，表示电池的平均电流，单位毫安。

+
+ +**返回：** + +HDF\_SUCCESS 表示获取成功。 + +## GetCurrentNow\(\) + +``` +IBatteryInterface::GetCurrentNow ([out] int curNow) +``` + +**描述：** + +获取电池的电流。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

curNow

+

输出参数，表示电池的实时电流，单位毫安。

+
+ +**返回：** + +HDF\_SUCCESS 表示获取成功。 + +## GetHealthState\(\) + +``` +IBatteryInterface::GetHealthState ([out] enum BatteryHealthState healthState) +``` + +**描述：** + +获取电池的健康状态。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

healthState

+

输出参数，表示电池健康状态。

+
+ +**返回：** + +HDF\_SUCCESS 表示获取成功。 + +**参见：** + +[BatteryHealthState](battery.md#gaec9b86ee31a5d8abf7c804d81b542f2f) + +## GetPluggedType\(\) + +``` +IBatteryInterface::GetPluggedType ([out] enum BatteryPluggedType pluggedType) +``` + +**描述：** + +获取充电设备类型。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

pluggedType

+

输出参数，表示充电设备类型。

+
+ +**返回：** + +HDF\_SUCCESS 表示获取成功。 + +**参见：** + +[BatteryPluggedType](battery.md#gab80029eabf9d0fdcc3ab4d4a4c3be6ba) + +## GetPresent\(\) + +``` +IBatteryInterface::GetPresent ([out] boolean present) +``` + +**描述：** + +获取是否支持电池或者电池是否在位。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

present

+

输出参数，表示是否支持电池或者电池是否在位。true表示支持或在位，false表示不支持或不在位。

+
+ +**返回：** + +HDF\_SUCCESS 表示获取成功。 + +## GetRemainEnergy\(\) + +``` +IBatteryInterface::GetRemainEnergy ([out] int remainEnergy) +``` + +**描述：** + +获取电池的剩余容量。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

remainEnergy

+

输出参数，表示电池的剩余容量，单位毫安时。

+
+ +**返回：** + +HDF\_SUCCESS 表示获取成功。 + +## GetTechnology\(\) + +``` +IBatteryInterface::GetTechnology ([out] String technology) +``` + +**描述：** + +获取电池的技术型号。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

technology

+

输出参数，当前电池技术型号。

+
+ +**返回：** + +HDF\_SUCCESS 表示获取成功。 + +## GetTemperature\(\) + +``` +IBatteryInterface::GetTemperature ([out] int temperature) +``` + +**描述：** + +获取电池的充电温度，单位0.1摄氏度。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

temperature

+

输出参数，表示电池温度。

+
+ +**返回：** + +HDF\_SUCCESS 表示获取成功。 + +## GetTotalEnergy\(\) + +``` +IBatteryInterface::GetTotalEnergy ([out] int totalEnergy) +``` + +**描述：** + +获取电池的总容量。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

totalEnergy

+

输出参数，表示电池的总容量，单位毫安时。

+
+ +**返回：** + +HDF\_SUCCESS 表示获取成功。 + +## GetVoltage\(\) + +``` +IBatteryInterface::GetVoltage ([out] int voltage) +``` + +**描述：** + +获取电池的电压，单位微伏。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

voltage

+

输出参数，表示电池的电压。

+
+ +**返回：** + +HDF\_SUCCESS 表示获取成功。 + +## Register\(\) + +``` +IBatteryInterface::Register ([in] IBatteryCallback event) +``` + +**描述：** + +注册电池信息的回调。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

event

+

输入参数，服务注册的回调。

+
+ +**返回：** + +HDF\_SUCCESS 表示注册成功。 + +## UnRegister\(\) + +``` +IBatteryInterface::UnRegister () +``` + +**描述：** + +取消注册电池信息的回调。 + +**返回：** + +HDF\_SUCCESS 表示取消注册成功。 + diff --git a/zh-cn/device-dev/api/toctopics/interface_i_executor.md b/zh-cn/device-dev/api/toctopics/interface_i_executor.md new file mode 100644 index 0000000000..79f515ea61 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/interface_i_executor.md @@ -0,0 +1,764 @@ +# IExecutor + +## **概述** + +**所属模块:** + +[HdfFaceAuth](_hdf_face_auth.md) | [HdfPinAuth](_hdf_pin_auth.md) + +## **汇总** + +## Public 成员函数 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 成员函数

+

描述

+

GetExecutorInfo ([out] struct ExecutorInfo executorInfo)

+

获取执行器信息，人脸认证服务将执行器注册到用户认证框架时需要通过该接口获取对应信息。 更多...

+

GetTemplateInfo ([in] unsigned long templateId, [out] struct TemplateInfo templateInfo)

+

获取凭据模版信息。 更多...

+

OnRegisterFinish ([in] unsigned long[] templateIdList, [in] unsigned char[] frameworkPublicKey, [in] unsigned char[] extraInfo)

+

完成执行器注册，对人脸特征模版进行对账，用于删除无效的人脸特征模板及相关信息。 更多...

+

Enroll ([in] unsigned long scheduleId, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj)

+

注册人脸特征模版。 更多...

+

Authenticate ([in] unsigned long scheduleId, [in] unsigned long[] templateIdList, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj)

+

人脸认证。 更多...

+

Identify ([in] unsigned long scheduleId, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj)

+

人脸识别。 更多...

+

Delete ([in] unsigned long[] templateIdList)

+

删除人脸特征模版。 更多...

+

Cancel ([in] unsigned long scheduleId)

+

取消操作请求。 更多...

+

SendCommand ([in] int commandId, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj)

+

发送人脸认证功能相关操作命令。 更多...

+

GetExecutorInfo ([out] struct ExecutorInfo executorInfo)

+

获取执行器信息，口令认证服务将执行器注册到用户认证框架时需要通过该接口获取对应信息。 更多...

+

OnRegisterFinish ([in] unsigned long[] templateIdList, [in] unsigned char[] frameworkPublicKey, [in] unsigned char[] extraInfo)

+

完成执行器注册，对口令模版信息进行对账，用于删除无效的口令模板及相关信息。 更多...

+

OnSetData ([in] unsigned long scheduleId, [in] unsigned long authSubType, [in] unsigned char[] data)

+

设置口令数据，口令认证驱动处理注册或认证口令请求时，如果口令数据由口令认证服务获取，需要通过该接口将口令数据传给口令认证驱动。 更多...

+

Enroll ([in] unsigned long scheduleId, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj)

+

注册口令。 更多...

+

Authenticate ([in] unsigned long scheduleId, [in] unsigned long templateId, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj)

+

认证口令。 更多...

+

Delete ([in] unsigned long templateId)

+

删除口令。 更多...

+

SendCommand ([in] int commandId, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj)

+

发送口令认证功能相关操作命令。 更多...

+
+ +## **详细描述** + +定义执行器标准API接口。接口可用于： + +- 获取执行器信息。 +- 获取凭据模版信息。 +- 注册人脸特征模版，进行用户人脸认证，删除人脸特征模版等。 +- 注册口令，认证口令，删除口令等。 + +**Since：** + +3.2 + +**Version:** + +1.0 + +## **成员函数说明** + +## Authenticate\(\) \[1/2\] + +``` +IExecutor::Authenticate ([in] unsigned long scheduleId, [in] unsigned long templateId, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj ) +``` + +**描述：** + +认证口令。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

scheduleId

+

调度ID，用于标识一次操作请求的调度过程。

+

templateId

+

指定要认证的模版ID。

+

extraInfo

+

其他相关信息，用于支持信息扩展。

+

callbackObj

+

回调对象IExecutorCallback。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## Authenticate\(\) \[2/2\] + +``` +IExecutor::Authenticate ([in] unsigned long scheduleId, [in] unsigned long[] templateIdList, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj ) +``` + +**描述：** + +人脸认证。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

scheduleId

+

调度ID，用于标识一次操作请求的调度过程。

+

templateIdList

+

指定要认证的模版ID列表。

+

extraInfo

+

其他相关信息，用于支持信息扩展。

+

callbackObj

+

回调对象IExecutorCallback。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## Cancel\(\) + +``` +IExecutor::Cancel ([in] unsigned long scheduleId) +``` + +**描述：** + +取消操作请求。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

scheduleId

+

调度ID，用于标识一次操作请求的调度过程。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## Delete\(\) \[1/2\] + +``` +IExecutor::Delete ([in] unsigned long templateId) +``` + +**描述：** + +删除口令。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

templateId

+

模版ID。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## Delete\(\) \[2/2\] + +``` +IExecutor::Delete ([in] unsigned long[] templateIdList) +``` + +**描述：** + +删除人脸特征模版。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

templateIdList

+

指定要删除的模版ID列表。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## Enroll\(\) \[1/2\] + +``` +IExecutor::Enroll ([in] unsigned long scheduleId, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj ) +``` + +**描述：** + +注册人脸特征模版。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

scheduleId

+

调度ID，用于标识一次操作请求的调度过程。

+

extraInfo

+

其他相关信息，用于支持信息扩展。

+

callbackObj

+

回调对象IExecutorCallback。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## Enroll\(\) \[2/2\] + +``` +IExecutor::Enroll ([in] unsigned long scheduleId, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj ) +``` + +**描述：** + +注册口令。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

scheduleId

+

调度ID，用于标识一次操作请求的调度过程。

+

extraInfo

+

其他相关信息，用于支持信息扩展。

+

callbackObj

+

回调对象IExecutorCallback。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## GetExecutorInfo\(\) \[1/2\] + +``` +IExecutor::GetExecutorInfo ([out] struct ExecutorInfo executorInfo) +``` + +**描述：** + +获取执行器信息，人脸认证服务将执行器注册到用户认证框架时需要通过该接口获取对应信息。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

executorInfo

+

执行器信息ExecutorInfo。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## GetExecutorInfo\(\) \[2/2\] + +``` +IExecutor::GetExecutorInfo ([out] struct ExecutorInfo executorInfo) +``` + +**描述：** + +获取执行器信息，口令认证服务将执行器注册到用户认证框架时需要通过该接口获取对应信息。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

executorInfo

+

执行器信息ExecutorInfo。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## GetTemplateInfo\(\) + +``` +IExecutor::GetTemplateInfo ([in] unsigned long templateId, [out] struct TemplateInfo templateInfo ) +``` + +**描述：** + +获取凭据模版信息。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

templateId

+

凭据模版ID。

+

templateInfo

+

凭据模版信息TemplateInfo。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## Identify\(\) + +``` +IExecutor::Identify ([in] unsigned long scheduleId, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj ) +``` + +**描述：** + +人脸识别。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

scheduleId

+

调度ID，用于标识一次操作请求的调度过程。

+

extraInfo

+

其他相关信息，用于支持信息扩展。

+

callbackObj

+

回调对象IExecutorCallback。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## OnRegisterFinish\(\) \[1/2\] + +``` +IExecutor::OnRegisterFinish ([in] unsigned long[] templateIdList, [in] unsigned char[] frameworkPublicKey, [in] unsigned char[] extraInfo ) +``` + +**描述：** + +完成执行器注册，对人脸特征模版进行对账，用于删除无效的人脸特征模板及相关信息。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

templateIdList

+

用户认证框架内由该执行器注册的人脸特征模版ID列表。

+

frameworkPublicKey

+

用户认证框架的公钥，用于校验用户认证框架私钥签名的信息。

+

extraInfo

+

其他相关信息，用于支持信息扩展。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## OnRegisterFinish\(\) \[2/2\] + +``` +IExecutor::OnRegisterFinish ([in] unsigned long[] templateIdList, [in] unsigned char[] frameworkPublicKey, [in] unsigned char[] extraInfo ) +``` + +**描述：** + +完成执行器注册，对口令模版信息进行对账，用于删除无效的口令模板及相关信息。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

templateIdList

+

用户认证框架内由该执行器注册的口令凭据模版ID列表。

+

frameworkPublicKey

+

用户认证框架的公钥，用于校验用户认证框架私钥签名的信息。

+

extraInfo

+

其他相关信息，用于支持信息扩展。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## OnSetData\(\) + +``` +IExecutor::OnSetData ([in] unsigned long scheduleId, [in] unsigned long authSubType, [in] unsigned char[] data ) +``` + +**描述：** + +设置口令数据，口令认证驱动处理注册或认证口令请求时，如果口令数据由口令认证服务获取，需要通过该接口将口令数据传给口令认证驱动。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

scheduleId

+

调度ID，用于标识一次操作请求的调度过程。

+

authSubType

+

口令子类型，如六位数字PIN码等。

+

data

+

口令数据。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## SendCommand\(\) \[1/2\] + +``` +IExecutor::SendCommand ([in] int commandId, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj ) +``` + +**描述：** + +发送人脸认证功能相关操作命令。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

commandId

+

操作命令IDCommandId。

+

extraInfo

+

其他相关信息，用于支持信息扩展。

+

callbackObj

+

回调对象IExecutorCallback。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## SendCommand\(\) \[2/2\] + +``` +IExecutor::SendCommand ([in] int commandId, [in] unsigned char[] extraInfo, [in] IExecutorCallback callbackObj ) +``` + +**描述：** + +发送口令认证功能相关操作命令。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

commandId

+

操作命令IDCommandId。

+

extraInfo

+

其他相关信息，用于支持信息扩展。

+

callbackObj

+

回调对象IExecutorCallback。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + diff --git a/zh-cn/device-dev/api/toctopics/interface_i_executor_callback.md b/zh-cn/device-dev/api/toctopics/interface_i_executor_callback.md new file mode 100644 index 0000000000..640732758e --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/interface_i_executor_callback.md @@ -0,0 +1,165 @@ +# IExecutorCallback + +## **概述** + +**所属模块:** + +[HdfFaceAuth](_hdf_face_auth.md) | [HdfPinAuth](_hdf_pin_auth.md) + +## **汇总** + +## Public 成员函数 + + + + + + + + + + + + + + + + +

Public 成员函数

+

描述

+

OnResult ([in] int result, [in] unsigned char[] extraInfo)

+

定义操作结果回调函数。 更多...

+

OnAcquireInfo ([in] int acquire, [in] unsigned char[] extraInfo)

+

定义操作过程信息反馈回调函数。 更多...

+

OnGetData ([in] unsigned long scheduleId, [in] unsigned char[] salt, [in] unsigned long authSubType)

+

定义请求获取口令数据回调函数。 更多...

+
+ +## **详细描述** + +定义异步API接口回调，用于返回异步接口的请求处理结果和获取信息。使用细节见[IExecutor](interface_i_executor.md)。 + +**Since：** + +3.2 + +**Version:** + +1.0 + +## **成员函数说明** + +## OnAcquireInfo\(\) + +``` +IExecutorCallback::OnAcquireInfo ([in] int acquire, [in] unsigned char[] extraInfo ) +``` + +**描述：** + +定义操作过程信息反馈回调函数。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

acquire

+

提示信息编码FaceTipsCode。

+

extraInfo

+

其他相关信息，用于支持信息扩展。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## OnGetData\(\) + +``` +IExecutorCallback::OnGetData ([in] unsigned long scheduleId, [in] unsigned char[] salt, [in] unsigned long authSubType ) +``` + +**描述：** + +定义请求获取口令数据回调函数。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

salt

+

盐值，用于对口令明文进行单向处理。

+

authSubType

+

口令子类型，如六位数字PIN码等。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## OnResult\(\) + +``` +IExecutorCallback::OnResult ([in] int result, [in] unsigned char[] extraInfo ) +``` + +**描述：** + +定义操作请求处理结果回调函数。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

result

+

操作请求处理结果。

+

extraInfo

+

其他相关信息，如用户认证通过时用于返回执行器签发的认证令牌等。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + diff --git a/zh-cn/device-dev/api/toctopics/interface_i_face_auth_interface.md b/zh-cn/device-dev/api/toctopics/interface_i_face_auth_interface.md new file mode 100644 index 0000000000..645f51f2b3 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/interface_i_face_auth_interface.md @@ -0,0 +1,74 @@ +# IFaceAuthInterface + +## **概述** + +**所属模块:** + +[HdfFaceAuth](_hdf_face_auth.md) + +## **汇总** + +## Public 成员函数 + + + + + + + + + + +

Public 成员函数

+

描述

+

GetExecutorList ([out] IExecutor[] executorList)

+

获取执行器列表，人脸认证服务进程启动进行初始化操作时通过该接口获取人脸认证驱动支持的执行器列表。 更多...

+
+ +## **详细描述** + +定义获取人脸认证驱动的执行器列表接口。 + +**Since：** + +3.2 + +**Version:** + +1.0 + +## **成员函数说明** + +## GetExecutorList\(\) + +``` +IFaceAuthInterface::GetExecutorList ([out] IExecutor[] executorList) +``` + +**描述：** + +获取执行器列表，人脸认证服务进程启动进行初始化操作时通过该接口获取人脸认证驱动支持的执行器列表。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

executorList

+

执行器对象列表IExecutor。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + diff --git a/zh-cn/device-dev/api/toctopics/interface_i_pin_auth_interface.md b/zh-cn/device-dev/api/toctopics/interface_i_pin_auth_interface.md new file mode 100644 index 0000000000..a07212b3f6 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/interface_i_pin_auth_interface.md @@ -0,0 +1,74 @@ +# IPinAuthInterface + +## **概述** + +**所属模块:** + +[HdfPinAuth](_hdf_pin_auth.md) + +## **汇总** + +## Public 成员函数 + + + + + + + + + + +

Public 成员函数

+

描述

+

GetExecutorList ([out] IExecutor[] executorList)

+

获取执行器列表，口令认证服务进程启动进行初始化操作时通过该接口获取口令认证驱动支持的执行器列表。 更多...

+
+ +## **详细描述** + +定义获取口令认证驱动的执行器列表接口。 + +**Since：** + +3.2 + +**Version:** + +1.0 + +## **成员函数说明** + +## GetExecutorList\(\) + +``` +IPinAuthInterface::GetExecutorList ([out] IExecutor[] executorList) +``` + +**描述：** + +获取执行器列表，口令认证服务进程启动进行初始化操作时通过该接口获取口令认证驱动支持的执行器列表。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

executorList

+

执行器对象列表IExecutor。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + diff --git a/zh-cn/device-dev/api/toctopics/interface_i_power_hdi_callback.md b/zh-cn/device-dev/api/toctopics/interface_i_power_hdi_callback.md new file mode 100644 index 0000000000..039e06e76a --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/interface_i_power_hdi_callback.md @@ -0,0 +1,68 @@ +# IPowerHdiCallback + +## **概述** + +**所属模块:** + +[Power](power.md) + +## **汇总** + +## Public 成员函数 + + + + + + + + + + + + + +

Public 成员函数

+

描述

+

OnSuspend ()

+

休眠状态的回调方法。 更多...

+

OnWakeup ()

+

唤醒状态的回调方法。 更多...

+
+ +## **详细描述** + +休眠/唤醒状态的回调。 + +服务创建此回调对象后，可以调用IPowerInterface的接口注册回调，从而订阅休眠/唤醒状态的变化。 + +**Since：** + +3.1 + +## **成员函数说明** + +## OnSuspend\(\) + +``` +IPowerHdiCallback::OnSuspend () +``` + +**描述：** + +休眠状态的回调方法。 + +当设备进入休眠状态时，将通过此方法通知给服务。 + +## OnWakeup\(\) + +``` +IPowerHdiCallback::OnWakeup () +``` + +**描述：** + +唤醒状态的回调方法。 + +当设备进入唤醒状态时，将通过此方法通知给服务。 + diff --git a/zh-cn/device-dev/api/toctopics/interface_i_power_interface.md b/zh-cn/device-dev/api/toctopics/interface_i_power_interface.md new file mode 100644 index 0000000000..42fd9b8edb --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/interface_i_power_interface.md @@ -0,0 +1,239 @@ +# IPowerInterface + +## **概述** + +**所属模块:** + +[Power](power.md) + +## **汇总** + +## Public 成员函数 + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 成员函数

+

描述

+

RegisterCallback ([in] IPowerHdiCallback ipowerHdiCallback)

+

注册休眠/唤醒状态的回调。 更多...

+

StartSuspend ()

+

执行设备休眠操作。 更多...

+

StopSuspend ()

+

执行设备唤醒操作。 更多...

+

ForceSuspend ()

+

执行设备强制休眠操作。 更多...

+

SuspendBlock ([in] String name)

+

打开运行锁，阻止休眠。 更多...

+

SuspendUnblock ([in] String name)

+

关闭运行锁，取消阻止休眠。 更多...

+

PowerDump ([out] String info)

+

获取电源的Dump信息。 更多...

+
+ +## **详细描述** + +休眠/唤醒操作、订阅休眠/唤醒状态、运行锁管理的接口。 + +服务获取此对象后，可以调用相关的接口对设备进行休眠/唤醒、订阅休眠/唤醒状态和管理运行锁。 + +**Since：** + +3.1 + +## **成员函数说明** + +## ForceSuspend\(\) + +``` +IPowerInterface::ForceSuspend () +``` + +**描述：** + +执行设备强制休眠操作。 + +**返回：** + +HDF\_SUCCESS 表示操作成功。 + +## PowerDump\(\) + +``` +IPowerInterface::PowerDump ([out] String info) +``` + +**描述：** + +获取电源的Dump信息。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

info

+

输出参数，电源的Dump信息。

+
+ +**返回：** + +HDF\_SUCCESS 表示操作成功。 + +## RegisterCallback\(\) + +``` +IPowerInterface::RegisterCallback ([in] IPowerHdiCallback ipowerHdiCallback) +``` + +**描述：** + +注册休眠/唤醒状态的回调。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

ipowerHdiCallback

+

输入参数，服务注册的回调。

+
+ +**返回：** + +HDF\_SUCCESS 表示注册成功。 + +**参见：** + +[IPowerHdiCallback](interface_i_power_hdi_callback.md) + +## StartSuspend\(\) + +``` +IPowerInterface::StartSuspend () +``` + +**描述：** + +执行设备休眠操作。 + +**返回：** + +HDF\_SUCCESS 表示操作成功。 + +## StopSuspend\(\) + +``` +IPowerInterface::StopSuspend () +``` + +**描述：** + +执行设备唤醒操作。 + +**返回：** + +HDF\_SUCCESS 表示操作成功。 + +## SuspendBlock\(\) + +``` +IPowerInterface::SuspendBlock ([in] String name) +``` + +**描述：** + +打开运行锁，阻止休眠。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

name

+

输入参数，运行锁的名称。

+
+ +**返回：** + +HDF\_SUCCESS 表示操作成功。 + +## SuspendUnblock\(\) + +``` +IPowerInterface::SuspendUnblock ([in] String name) +``` + +**描述：** + +关闭运行锁，取消阻止休眠。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

name

+

输入参数，运行锁的名称。

+
+ +**返回：** + +HDF\_SUCCESS 表示操作成功。 + diff --git a/zh-cn/device-dev/api/toctopics/interface_i_thermal_callback.md b/zh-cn/device-dev/api/toctopics/interface_i_thermal_callback.md new file mode 100644 index 0000000000..c77ae0c300 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/interface_i_thermal_callback.md @@ -0,0 +1,72 @@ +# IThermalCallback + +## **概述** + +**所属模块:** + +[Thermal](thermal.md) + +## **汇总** + +## Public 成员函数 + + + + + + + + + + +

Public 成员函数

+

描述

+

OnThermalDataEvent ([in] struct HdfThermalCallbackInfo event)

+

设备发热状态变化的回调方法。 更多...

+
+ +## **详细描述** + +订阅设备发热状态的回调。 + +服务创建此回调对象后，可以调用IThermalInterface的接口注册回调，从而订阅设备发热状态的变化。 + +**Since：** + +3.1 + +## **成员函数说明** + +## OnThermalDataEvent\(\) + +``` +IThermalCallback::OnThermalDataEvent ([in] struct HdfThermalCallbackInfo event) +``` + +**描述：** + +设备发热状态变化的回调方法。 + +当设备发热状态发生变化时，将通过此方法的参数返回给服务。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

event

+

输入参数，设备发热信息，包括器件类型、器件温度。

+
+ +**参见：** + +[HdfThermalCallbackInfo](_hdf_thermal_callback_info.md) + diff --git a/zh-cn/device-dev/api/toctopics/interface_i_thermal_interface.md b/zh-cn/device-dev/api/toctopics/interface_i_thermal_interface.md new file mode 100644 index 0000000000..6618449c02 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/interface_i_thermal_interface.md @@ -0,0 +1,241 @@ +# IThermalInterface + +## **概述** + +**所属模块:** + +[Thermal](thermal.md) + +## **汇总** + +## Public 成员函数 + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 成员函数

+

描述

+

SetCpuFreq ([in] int freq)

+

设置CPU频率。 更多...

+

SetGpuFreq ([in] int freq)

+

设置GPU频率。 更多...

+

SetBatteryCurrent ([in] int current)

+

设置充电电流。 更多...

+

GetThermalZoneInfo ([out] struct HdfThermalCallbackInfo event)

+

获取设备发热的信息。 更多...

+

Register ([in] IThermalCallback callbackObj)

+

注册设备发热状态的回调。 更多...

+

Unregister ()

+

取消注册设备发热状态的回调。 更多...

+
+ +## **详细描述** + +设备温度管理、控制及订阅接口。 + +服务获取此对象后，可以调用相关的接口管理、控制和订阅设备温度。 + +**Since：** + +3.1 + +## **成员函数说明** + +## GetThermalZoneInfo\(\) + +``` +IThermalInterface::GetThermalZoneInfo ([out] struct HdfThermalCallbackInfo event) +``` + +**描述：** + +获取设备发热的信息。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

event

+

输出参数，设备发热信息，包括器件类型、器件温度。

+
+ +**返回：** + +HDF\_SUCCESS 表示获取成功。 + +**参见：** + +[HdfThermalCallbackInfo](_hdf_thermal_callback_info.md) + +## Register\(\) + +``` +IThermalInterface::Register ([in] IThermalCallback callbackObj) +``` + +**描述：** + +注册设备发热状态的回调。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

callbackObj

+

输入参数，服务注册的回调。

+
+ +**返回：** + +HDF\_SUCCESS 表示注册成功。 + +**参见：** + +[IThermalCallback](interface_i_thermal_callback.md) + +## SetBatteryCurrent\(\) + +``` +IThermalInterface::SetBatteryCurrent ([in] int current) +``` + +**描述：** + +设置充电电流。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

current

+

输入参数，充电电流，单位毫安。

+
+ +**返回：** + +HDF\_SUCCESS 表示设置成功 + +## SetCpuFreq\(\) + +``` +IThermalInterface::SetCpuFreq ([in] int freq) +``` + +**描述：** + +设置CPU频率。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

freq

+

输入参数，设置CPU频率的值。

+
+ +**返回：** + +HDF\_SUCCESS 表示设置成功。 + +## SetGpuFreq\(\) + +``` +IThermalInterface::SetGpuFreq ([in] int freq) +``` + +**描述：** + +设置GPU频率。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

freq

+

输入参数，设置GPU频率的值。

+
+ +**返回：** + +HDF\_SUCCESS 表示设置成功。 + +## Unregister\(\) + +``` +IThermalInterface::Unregister () +``` + +**描述：** + +取消注册设备发热状态的回调。 + +**返回：** + +HDF\_SUCCESS 表示取消注册成功。 + diff --git a/zh-cn/device-dev/api/toctopics/interface_i_user_auth_interface.md b/zh-cn/device-dev/api/toctopics/interface_i_user_auth_interface.md new file mode 100644 index 0000000000..58ebca0c9a --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/interface_i_user_auth_interface.md @@ -0,0 +1,982 @@ +# IUserAuthInterface + +## **概述** + +**所属模块:** + +[HdfUserAuth](_hdf_user_auth.md) + +## **汇总** + +## Public 成员函数 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public 成员函数

+

描述

+

Init ()

+

初始化用户认证驱动缓存信息，用于用户认证框架进程启动时初始化信息。 更多...

+

AddExecutor ([in] struct ExecutorRegisterInfo info, [out] unsigned long index, [out] unsigned char[] publicKey, [out] unsigned long[] templateIds)

+

添加认证执行器来获取认证能力，用于各认证基础服务如口令认证服务等将认证能力对接到用户认证框架。 更多...

+

DeleteExecutor ([in] unsigned long index)

+

删除执行器，用于清理失效的执行器信息。 更多...

+

OpenSession ([in] int userId, [out] unsigned char[] challenge)

+

开启一个认证凭据管理会话，用于在请求管理用户认证凭据前获取有效挑战值。 更多...

+

CloseSession ([in] int userId)

+

关闭认证凭据管理会话，完成用户认证凭据管理请求处理后，调用该接口使原挑战值失效。 更多...

+

BeginEnrollment ([in] int userId, [in] unsigned char[] authToken, [in] struct EnrollParam param, [out] struct ScheduleInfo info)

+

开始注册用户认证凭据。当注册凭据类型为口令且该用户已经注册了口令凭据时，将会更新口令凭据。 更多...

+

UpdateEnrollmentResult ([in] int userId, [in] unsigned char[] scheduleResult, [out] unsigned long credentialId, [out] struct CredentialInfo oldInfo)

+

更新用户凭据注册结果，完成凭据注册。 更多...

+

CancelEnrollment ([in] int userId)

+

取消注册请求。 更多...

+

DeleteCredential ([in] int userId, [in] unsigned long credentialId, [in] unsigned char[] authToken, [out] struct CredentialInfo info)

+

删除用户凭据信息。 更多...

+

GetCredential ([in] int userId, [in] enum AuthType authType, [out] struct CredentialInfo[] infos)

+

查询用户凭据信息。 更多...

+

GetSecureInfo ([in] int userId, [out] unsigned long secureUid, [out] struct EnrolledInfo[] infos)

+

查询用户安全信息。 更多...

+

DeleteUser ([in] int userId, [in] unsigned char[] authToken, [out] struct CredentialInfo[] deletedInfos)

+

删除用户口令认证凭据，在用户IAM系统内删除该用户，该请求由用户触发。 更多...

+

EnforceDeleteUser ([in] int userId, [out] struct CredentialInfo[] deletedInfos)

+

强制删除用户，该请求由系统内管理用户的模块触发。 更多...

+

BeginAuthentication ([in] unsigned long contextId, [in] struct AuthSolution param, [out] struct ScheduleInfo[] scheduleInfos)

+

开始认证用户，并生成认证方案。 更多...

+

UpdateAuthenticationResult ([in] unsigned long contextId, [in] unsigned char[] scheduleResult, [out] struct AuthResultInfo info)

+

更新认证结果，评估认证方案的认证结果。 更多...

+

CancelAuthentication ([in] unsigned long contextId)

+

取消用户认证请求。 更多...

+

BeginIdentification ([in] unsigned long contextId, [in] enum AuthType authType, [in] byte[] challenge, [in] unsigned int executorId, [out] struct ScheduleInfo scheduleInfo)

+

开始用户身份识别，并生成识别方案。 更多...

+

UpdateIdentificationResult ([in] unsigned long contextId, [in] unsigned char[] scheduleResult, [out] struct IdentifyResultInfo info)

+

更新用户身份识别结果，生成身份识别方案的结果 更多...

+

CancelIdentification ([in] unsigned long contextId)

+

取消用户身份识别请求。 更多...

+

GetAuthTrustLevel ([in] int userId, [in] enum AuthType authType, [out] unsigned int authTrustLevel)

+

获取当前认证类型的认证结果可信等级。 更多...

+

GetValidSolution ([in] int userId, [in] enum AuthType[] authTypes, [in] unsigned int authTrustLevel, [out] enum AuthType[] validTypes)

+

获取指定认证结果可信等级下有效的认证方式。 更多...

+
+ +## **详细描述** + +声明用户认证驱动的API接口。 + +**Since：** + +3.2 + +**Version：** + +1.0 + +## **成员函数说明** + +## AddExecutor\(\) + +``` +IUserAuthInterface::AddExecutor ([in] struct ExecutorRegisterInfo info, [out] unsigned long index, [out] unsigned char[] publicKey, [out] unsigned long[] templateIds ) +``` + +**描述：** + +添加认证执行器来获取认证能力，用于各认证基础服务如口令认证服务等将认证能力对接到用户认证框架。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

info

+

执行器注册信息ExecutorRegisterInfo。

+

index

+

用户认证框架的执行器索引。

+

publicKey

+

用户认证框架公钥。

+

templateIds

+

该执行器已注册的模版ID列表。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## BeginAuthentication\(\) + +``` +IUserAuthInterface::BeginAuthentication ([in] unsigned long contextId, [in] struct AuthSolution param, [out] struct ScheduleInfo[] scheduleInfos ) +``` + +**描述：** + +开始认证用户，并生成认证方案。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

contextId

+

上下文索引。

+

param

+

认证方案AuthSolution。

+

scheduleInfos

+

调度信息ScheduleInfo。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## BeginEnrollment\(\) + +``` +IUserAuthInterface::BeginEnrollment ([in] int userId, [in] unsigned char[] authToken, [in] struct EnrollParam param, [out] struct ScheduleInfo info ) +``` + +**描述：** + +开始注册用户认证凭据。当注册凭据类型为口令且该用户已经注册了口令凭据时，将会更新口令凭据。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

userId

+

用户ID。

+

authToken

+

用户口令认证令牌。

+

param

+

注册凭据参数EnrollParam。

+

info

+

调度信息ScheduleInfo。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## BeginIdentification\(\) + +``` +IUserAuthInterface::BeginIdentification ([in] unsigned long contextId, [in] enum AuthType authType, [in] byte[] challenge, [in] unsigned int executorId, [out] struct ScheduleInfo scheduleInfo ) +``` + +**描述：** + +开始用户身份识别，并生成识别方案。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

contextId

+

上下文索引。

+

authType

+

用户身份识别类型AuthType}。

+

scheduleInfo

+

调度信息ScheduleInfo。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## CancelAuthentication\(\) + +``` +IUserAuthInterface::CancelAuthentication ([in] unsigned long contextId) +``` + +**描述：** + +取消用户认证请求。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

contextId

+

上下文索引。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## CancelEnrollment\(\) + +``` +IUserAuthInterface::CancelEnrollment ([in] int userId) +``` + +**描述：** + +取消注册请求。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

userId

+

用户ID。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## CancelIdentification\(\) + +``` +IUserAuthInterface::CancelIdentification ([in] unsigned long contextId) +``` + +**描述：** + +取消用户身份识别请求。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

contextId

+

上下文索引。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## CloseSession\(\) + +``` +IUserAuthInterface::CloseSession ([in] int userId) +``` + +**描述：** + +关闭认证凭据管理会话，完成用户认证凭据管理请求处理后，调用该接口使原挑战值失效。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

userId

+

用户ID。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## DeleteCredential\(\) + +``` +IUserAuthInterface::DeleteCredential ([in] int userId, [in] unsigned long credentialId, [in] unsigned char[] authToken, [out] struct CredentialInfo info ) +``` + +**描述：** + +删除用户凭据信息。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

userId

+

用户ID。

+

credentialId

+

凭据ID。

+

authToken

+

用户口令认证令牌。

+

info

+

删除的凭据信息CredentialInfo。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## DeleteExecutor\(\) + +``` +IUserAuthInterface::DeleteExecutor ([in] unsigned long index) +``` + +**描述：** + +删除执行器，用于清理失效的执行器信息。 + +**参数：** + + + + + + + + + + +

名称

+

描述

+

index

+

用户认证框架的执行器索引。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## DeleteUser\(\) + +``` +IUserAuthInterface::DeleteUser ([in] int userId, [in] unsigned char[] authToken, [out] struct CredentialInfo[] deletedInfos ) +``` + +**描述：** + +删除用户口令认证凭据，在用户IAM系统内删除该用户，该请求由用户触发。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

userId

+

用户ID。

+

authToken

+

用户口令认证令牌。

+

deletedInfos

+

删除的凭据信息CredentialInfo。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## EnforceDeleteUser\(\) + +``` +IUserAuthInterface::EnforceDeleteUser ([in] int userId, [out] struct CredentialInfo[] deletedInfos ) +``` + +**描述：** + +强制删除用户，该请求由系统内管理用户的模块触发。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

userId

+

用户ID。

+

deletedInfos

+

删除的凭据信息CredentialInfo。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## GetAuthTrustLevel\(\) + +``` +IUserAuthInterface::GetAuthTrustLevel ([in] int userId, [in] enum AuthType authType, [out] unsigned int authTrustLevel ) +``` + +**描述：** + +获取当前认证类型的认证结果可信等级。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

userId

+

用户ID。

+

authType

+

认证类型AuthType。

+

authTrustLevel

+

认证结果可信等级。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## GetCredential\(\) + +``` +IUserAuthInterface::GetCredential ([in] int userId, [in] enum AuthType authType, [out] struct CredentialInfo[] infos ) +``` + +**描述：** + +查询用户凭据信息。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

userId

+

用户ID。

+

authType

+

凭据类型AuthType。

+

infos

+

凭据信息CredentialInfo。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## GetSecureInfo\(\) + +``` +IUserAuthInterface::GetSecureInfo ([in] int userId, [out] unsigned long secureUid, [out] struct EnrolledInfo[] infos ) +``` + +**描述：** + +查询用户安全信息。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

userId

+

用户ID。

+

secureUid

+

安全用户ID。

+

infos

+

注册信息EnrolledInfo。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## GetValidSolution\(\) + +``` +IUserAuthInterface::GetValidSolution ([in] int userId, [in] enum AuthType[] authTypes, [in] unsigned int authTrustLevel, [out] enum AuthType[] validTypes ) +``` + +**描述：** + +获取指定认证结果可信等级下有效的认证方式。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

userId

+

用户ID。

+

authTypes

+

用于筛选的认证方式列表AuthType。

+

authTrustLevel

+

认证结果可信等级。

+

validTypes

+

有效的认证方式列表AuthType。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## Init\(\) + +``` +IUserAuthInterface::Init () +``` + +**描述：** + +初始化用户认证驱动缓存信息，用于用户认证框架进程启动时初始化信息。 + +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## OpenSession\(\) + +``` +IUserAuthInterface::OpenSession ([in] int userId, [out] unsigned char[] challenge ) +``` + +**描述：** + +开启一个认证凭据管理会话，用于在请求管理用户认证凭据前获取有效挑战值。 + +**参数：** + + + + + + + + + + + + + +

名称

+

描述

+

userId

+

用户ID。

+

challenge

+

随机挑战值，用于生成用户身份认证令牌。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## UpdateAuthenticationResult\(\) + +``` +IUserAuthInterface::UpdateAuthenticationResult ([in] unsigned long contextId, [in] unsigned char[] scheduleResult, [out] struct AuthResultInfo info ) +``` + +**描述：** + +更新认证结果，评估认证方案的认证结果。 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

contextId

+

上下文索引。

+

scheduleResult

+

执行器签发的认证结果。

+

info

+

认证结果信息AuthResultInfo。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## UpdateEnrollmentResult\(\) + +``` +IUserAuthInterface::UpdateEnrollmentResult ([in] int userId, [in] unsigned char[] scheduleResult, [out] unsigned long credentialId, [out] struct CredentialInfo oldInfo ) +``` + +**描述：** + +更新用户凭据注册结果，完成凭据注册。 + +**参数：** + + + + + + + + + + + + + + + + + + + +

名称

+

描述

+

userId

+

用户ID。

+

scheduleResult

+

执行器签发的注册结果。

+

credentialId

+

凭据ID。

+

oldInfo

+

已经删除的凭据信息CredentialInfo。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + +## UpdateIdentificationResult\(\) + +``` +IUserAuthInterface::UpdateIdentificationResult ([in] unsigned long contextId, [in] unsigned char[] scheduleResult, [out] struct IdentifyResultInfo info ) +``` + +**描述：** + +更新用户身份识别结果，生成身份识别方案的结果 + +**参数：** + + + + + + + + + + + + + + + + +

名称

+

描述

+

contextId

+

上下文索引。

+

scheduleResult

+

执行器签发的用户身份识别结果。

+

info

+

用户身份识别结果IdentifyResultInfo。

+
+ +**返回：** + +0 表示操作成功。 + +非0 表示操作失败。 + diff --git a/zh-cn/device-dev/api/toctopics/ioffline__stream__operator_8h.md b/zh-cn/device-dev/api/toctopics/ioffline__stream__operator_8h.md new file mode 100644 index 0000000000..170fdc5034 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/ioffline__stream__operator_8h.md @@ -0,0 +1,39 @@ +# ioffline\_stream\_operator.h + +## **概述** + +**所属模块:** + +[Camera](_camera.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

OHOS::Camera::IOfflineStreamOperator

+

离线流的操作类。

+
+ +## **详细描述** + +离线流的操作接口。 + +**Since：** + +1.0 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/istream__operator_8h.md b/zh-cn/device-dev/api/toctopics/istream__operator_8h.md new file mode 100644 index 0000000000..c56593f41e --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/istream__operator_8h.md @@ -0,0 +1,39 @@ +# istream\_operator.h + +## **概述** + +**所属模块:** + +[Camera](_camera.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

OHOS::Camera::IStreamOperator

+

流的操作类。

+
+ +## **详细描述** + +流的操作接口。 + +**Since：** + +1.0 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/istream__operator__callback_8h.md b/zh-cn/device-dev/api/toctopics/istream__operator__callback_8h.md new file mode 100644 index 0000000000..aa6975e6e2 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/istream__operator__callback_8h.md @@ -0,0 +1,39 @@ +# istream\_operator\_callback.h + +## **概述** + +**所属模块:** + +[Camera](_camera.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

OHOS::Camera::IStreamOperatorCallback

+

流的操作回调类。

+
+ +## **详细描述** + +[IStreamOperator](istream__operator_8h.md) 相关的回调，这些回调均由调用者实现。 + +**Since：** + +1.0 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/light_8typeh.md b/zh-cn/device-dev/api/toctopics/light_8typeh.md new file mode 100644 index 0000000000..f1fb441062 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/light_8typeh.md @@ -0,0 +1,45 @@ +# light\_type.h + +## **概述** + +**所属模块:** + +[Light](_light.md) + +## **汇总** + +## 类 + + + + + + + + + + + + + + + + +

类

+

描述

+

LightFlashEffect

+

定义闪烁参数。 更多...

+

LightEffect

+

定义灯的效果参数。 更多...

+

LightInfo

+

定义灯的基本信息。 更多...

+
+ +## **详细描述** + +声明light模块的通用API，可用于获取灯ID、打开或关闭灯、并设置灯光亮度和闪烁模式。 + +**Since：** + +3.1 + diff --git a/zh-cn/device-dev/api/toctopics/light__if_8h.md b/zh-cn/device-dev/api/toctopics/light__if_8h.md new file mode 100644 index 0000000000..535239042b --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/light__if_8h.md @@ -0,0 +1,57 @@ +# light\_if.h + +## **概述** + +**所属模块:** + +[Light](_light.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

LightInterface

+

定义可以在灯上执行的基本操作。 更多...

+
+ +## 函数 + + + + + + + + + + + + + +

函数

+

描述

+

NewLightInterfaceInstance (void)

+

创建LightInterface实例。 更多...

+

FreeLightInterfaceInstance (void)

+

释放LightInterface实例和相关资源。 更多...

+
+ +## **详细描述** + +声明light模块的通用API，可用于获取灯ID、打开或关闭灯、并设置灯光亮度和闪烁模式。 + +**Sinc[更多...](_light_flash_effect.md)e更多...[更多...](_light_info.md)：** + +3.1 + diff --git a/zh-cn/device-dev/api/toctopics/pin__auth_2_i_executor_8idl.md b/zh-cn/device-dev/api/toctopics/pin__auth_2_i_executor_8idl.md new file mode 100644 index 0000000000..8388cb8ed3 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/pin__auth_2_i_executor_8idl.md @@ -0,0 +1,52 @@ +# IExecutor.idl + +## **概述** + +**所属模块:** + +[HdfPinAuth](_hdf_pin_auth.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

IExecutor

+

定义执行器接口，用于获取执行器，获取凭据模版信息，注册人脸特征模版，进行用户人脸认证，删除人脸特征模版等。 更多...

+
+ +## 变量 + + + + + + + + + + +

变量 名称

+

描述

+

package ohos.hdi.pin_auth.v1_0

+

口令认证接口的包路径

+
+ +## **详细描述** + +定义执行器标准API接口。接口可用于获取执行器信息，获取凭据模版信息，注册口令，认证口令，删除口令等。 + +**Since：** + +3.2 + diff --git a/zh-cn/device-dev/api/toctopics/pin__auth_2_i_executor_callback_8idl.md b/zh-cn/device-dev/api/toctopics/pin__auth_2_i_executor_callback_8idl.md new file mode 100644 index 0000000000..be0e5cfc7d --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/pin__auth_2_i_executor_callback_8idl.md @@ -0,0 +1,56 @@ +# IExecutorCallback.idl + +## **概述** + +**所属模块:** + +[HdfPinAuth](_hdf_pin_auth.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

IExecutorCallback

+

定义异步API接口回调，用于返回异步接口的请求处理结果和信息。使用细节见IExecutor。 更多...

+
+ +## 变量 + + + + + + + + + + +

变量 名称

+

描述

+

package ohos.hdi.pin_auth.v1_0

+

口令认证接口的包路径

+
+ +## **详细描述** + +定义异步API接口回调，用于返回异步接口的请求处理结果和获取信息。使用细节见[IExecutor](interface_i_executor.md)。 + +**Since：** + +3.2 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/power.md b/zh-cn/device-dev/api/toctopics/power.md new file mode 100644 index 0000000000..96d3b01b15 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/power.md @@ -0,0 +1,245 @@ +# Power + +## **汇总** + +## 文件 + + + + + + + + + + + + + + + + +

文件

+

描述

+

IPowerHdiCallback.idl

+

休眠/唤醒状态的回调。

+

IPowerInterface.idl

+

休眠/唤醒操作、订阅休眠/唤醒状态、运行锁管理的接口。

+

PowerTypes.idl

+

电源相关的数据类型。

+
+ +## 类 + + + + + + + + + + + + + +

类

+

描述

+

IPowerHdiCallback

+

休眠/唤醒状态的回调。 更多...

+

IPowerInterface

+

休眠/唤醒操作、订阅休眠/唤醒状态、运行锁管理的接口。 更多...

+
+ +## 枚举 + + + + + + + + + + + + + + + + +

枚举

+

描述

+

PowerHdfCmd { CMD_REGISTER_CALLBCK = 0, CMD_START_SUSPEND, CMD_STOP_SUSPEND, CMD_FORCE_SUSPEND, CMD_SUSPEND_BLOCK, CMD_SUSPEND_UNBLOCK, CMD_DUMP }

+

枚举电源命令的参数。 更多...

+

PowerHdfCallbackCmd { CMD_ON_SUSPEND = 0, CMD_ON_WAKEUP }

+

枚举电源状态回调的参数。 更多...

+

PowerHdfState { AWAKE = 0, INACTIVE, SLEEP }

+

枚举电源的状态。 更多...

+
+ +## 变量 + + + + + + + + + + +

变量 名称

+

描述

+

package ohos.hdi.power.v1_0

+

电源管理接口的包路径

+
+ +## **详细描述** + +提供休眠/唤醒操作、订阅休眠/唤醒状态、运行锁管理的接口。 + +电源模块为电源服务提供的休眠/唤醒操作、订阅休眠/唤醒状态和运行锁管理的接口。 服务获取此模块的对象或代理后，可以调用相关的接口对设备进行休眠/唤醒、订阅休眠/唤醒状态和管理运行锁。 + +**Since：** + +3.1 + +**Version：** + +1.0 + +## **枚举类型说明** + +## PowerHdfCallbackCmd + +``` +enum PowerHdfCallbackCmd +``` + +**描述：** + +枚举电源状态回调的参数。 + + + + + + + + + + + + + +

枚举值

+

描述

+

CMD_ON_SUSPEND

+

休眠回调的命令参数。

+

+

CMD_ON_WAKEUP

+

唤醒回调的命令参数。

+

+
+ +## PowerHdfCmd + +``` +enum PowerHdfCmd +``` + +**描述：** + +枚举电源命令的参数。 + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

CMD_REGISTER_CALLBCK

+

订阅状态的命令参数

+

+

CMD_START_SUSPEND

+

休眠的命令参数

+

+

CMD_STOP_SUSPEND

+

唤醒的命令参数

+

+

CMD_FORCE_SUSPEND

+

强制休眠的命令参数

+

+

CMD_SUSPEND_BLOCK

+

打开运行锁的命令参数

+

+

CMD_SUSPEND_UNBLOCK

+

关闭运行锁的命令参数

+

+

CMD_DUMP

+

Dump的命令参数

+

+
+ +## PowerHdfState + +``` +enum PowerHdfState +``` + +**描述：** + +枚举电源的状态。 + + + + + + + + + + + + + + + + +

枚举值

+

描述

+

AWAKE

+

唤醒状态。

+

+

INACTIVE

+

非活动状态。

+

+

SLEEP

+

休眠状态。

+

+
+ diff --git a/zh-cn/device-dev/api/toctopics/sensor__if_8h.md b/zh-cn/device-dev/api/toctopics/sensor__if_8h.md new file mode 100644 index 0000000000..d9bbfd1d24 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/sensor__if_8h.md @@ -0,0 +1,61 @@ +# sensor\_if.h + +## **概述** + +**所属模块:** + +[Sensor](_sensor.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

SensorInterface

+

提供sensor设备基本控制操作接口。 更多...

+
+ +## 函数 + + + + + + + + + + + + + +

函数

+

描述

+

NewSensorInterfaceInstance (void)

+

创建传感器接口实例。 更多...

+

FreeSensorInterfaceInstance (void)

+

释放传感器接口实例。 更多...

+
+ +## **详细描述** + +Sensor模块对外通用的接口声明文件，提供获取传感器设备信息、订阅/去订阅传感器数据、 使能/去使能传感器、设置传感器模式、设置传感器精度，量程等可选配置接口定义。 + +**Since：** + +2.2 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/sensor__type_8h.md b/zh-cn/device-dev/api/toctopics/sensor__type_8h.md new file mode 100644 index 0000000000..4c674c4f62 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/sensor__type_8h.md @@ -0,0 +1,125 @@ +# sensor\_type.h + +## **概述** + +**所属模块:** + +[Sensor](_sensor.md) + +## **汇总** + +## 类 + + + + + + + + + + + + + +

类

+

描述

+

SensorInformation

+

定义传感器基本信息。 更多...

+

SensorEvents

+

上报传感器数据结构。 更多...

+
+ +## 宏定义 + + + + + + + + + + + + + +

宏定义

+

描述

+

SENSOR_NAME_MAX_LEN 32

+

Sensor名称的最大长度

+

SENSOR_VERSION_MAX_LEN 16

+

Sensor版本号的最大长度

+
+ +## 类型定义 + + + + + + + + + + +

类型定义

+

描述

+

(RecordDataCallback) (const struct SensorEvents *)

+

传感器上报数据回调函数的定义，传感器服务用户在订阅传感器时， 需要注册上报数据回调函数，传感器使能后，传感器服务用户可以接受到传感器数据，详见SensorInterface。 更多...

+
+ +## 枚举 + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举

+

描述

+

SensorStatus { SENSOR_SUCCESS = 0, SENSOR_FAILURE = -1, SENSOR_NOT_SUPPORT = -2, SENSOR_INVALID_PARAM = -3, SENSOR_INVALID_SERVICE = -4, SENSOR_NULL_PTR = -5 }

+

定义传感器模块返回值类型。 更多...

+

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 }

+

定义传感器类型标识。 更多...

+

SensorAccuracyType { SENSOR_NO_ACCURACY = 0, SENSOR_LOW_ACCURACY = 1, SENSOR_MEDIUM_ACCURACY = 2, SENSOR_HIGH_ACCURACY = 3, SENSOR_MAX_ACCURACY }

+

传感器的精度类型。 更多...

+

SensorRangeType { SENSOR_RANGE_LEVEL1 = 0, SENSOR_RANGE_LEVEL2 = 1, SENSOR_RANGE_LEVEL3 = 2, SENSOR_RANGE_LEVEL_MAX }

+

传感器的量程级别。 更多...

+

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 }

+

传感器的工作模式。 更多...

+

SensorGroupType { TRADITIONAL_SENSOR_TYPE = 0, MEDICAL_SENSOR_TYPE = 1, SENSOR_GROUP_TYPE_MAX }

+

枚举传感器的硬件服务组。 更多...

+
+ +## **详细描述** + +定义传感器模块所使用的传感器类型，传感器信息，传感器数据结构等数据类型。 + +**Since：** + +2.2 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/thermal.md b/zh-cn/device-dev/api/toctopics/thermal.md new file mode 100644 index 0000000000..8864f04d97 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/thermal.md @@ -0,0 +1,94 @@ +# Thermal + +## **汇总** + +## 文件 + + + + + + + + + + + + + + + + +

文件

+

描述

+

IThermalCallback.idl

+

设备发热状态的回调。

+

IThermalInterface.idl

+

设备温度管理、控制及订阅接口。

+

ThermalTypes.idl

+

设备发热状态相关的数据类型。

+
+ +## 类 + + + + + + + + + + + + + + + + + + + +

类

+

描述

+

IThermalCallback

+

订阅设备发热状态的回调。 更多...

+

IThermalInterface

+

设备温度管理、控制及订阅接口。 更多...

+

ThermalZoneInfo

+

设备发热的信息。 更多...

+

HdfThermalCallbackInfo

+

设备发热的信息列表。 更多...

+
+ +## 变量 + + + + + + + + + + +

变量 名称

+

描述

+

package ohos.hdi.thermal.v1_0

+

设备温度管理接口的包路径

+
+ +## **详细描述** + +提供设备温度管理、控制及订阅接口。 + +热模块为热服务提供的设备温度管理、控制及订阅接口。 服务获取此模块的对象或代理后，可以调用相关的接口管理、控制和订阅设备温度。 + +**Since：** + +3.1 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/total.md b/zh-cn/device-dev/api/toctopics/total.md new file mode 100644 index 0000000000..901e02c84a --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/total.md @@ -0,0 +1,7 @@ +# 头文件和结构体 + +- **[头文件](files.md)** + +- **[结构体](annotated.md)** + + diff --git a/zh-cn/device-dev/api/toctopics/types_8h.md b/zh-cn/device-dev/api/toctopics/types_8h.md new file mode 100644 index 0000000000..8a56500af2 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/types_8h.md @@ -0,0 +1,153 @@ +# types.h + +## **概述** + +**所属模块:** + +[Camera](_camera.md) + +## **汇总** + +## 类 + + + + + + + + + + + + + + + + + + + + + + +

类

+

描述

+

OHOS::Camera::StreamInfo

+

流信息，用于创建流时传入相关的配置参数。 更多...

+

OHOS::Camera::StreamAttribute

+

流的属性。 更多...

+

OHOS::Camera::CaptureInfo

+

捕获请求的相关信息。 更多...

+

OHOS::Camera::CaptureEndedInfo

+

捕获结束相关信息，用于捕获结束回调 OnCaptureEnded。 更多...

+

OHOS::Camera::CaptureErrorInfo

+

流错误信息，用于回调 OnCaptureError。 更多...

+
+ +## 类型定义 + + + + + + + + + + + + + + + + +

类型定义

+

描述

+

OHOS::Camera::CameraAbility = CameraMetadata

+

Camera设备能力集合。

+

OHOS::Camera::CameraSetting = CameraMetadata

+

Camera设置参数，包括sensor帧率，3A相关参数等。

+

OHOS::Camera::MetaType = int32_t

+

整型。

+
+ +## 枚举 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

枚举

+

描述

+

OHOS::Camera::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接口的返回值。 更多...

+

OHOS::Camera::ResultCallbackMode : int32_t { OHOS::Camera::PER_FRAME, OHOS::Camera::ON_CHANGED }

+

metadata的上报模式。 更多...

+

OHOS::Camera::OperationMode : int32_t { OHOS::Camera::NORMAL = 0 }

+

流的使用模式。 更多...

+

OHOS::Camera::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 }

+

流的类型。 更多...

+

OHOS::Camera::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 }

+

流数据的编码类型。 更多...

+

OHOS::Camera::StreamSupportType : int32_t { OHOS::Camera::DYNAMIC_SUPPORTED, OHOS::Camera::RE_CONFIGURED_REQUIRED, OHOS::Camera::NOT_SUPPORTED }

+

动态配置流的切换方式，使用场景参考 IsStreamsSupported 。 更多...

+

OHOS::Camera::CameraStatus { OHOS::Camera::UN_AVAILABLE = 0, OHOS::Camera::AVAILABLE = 1 }

+

Camera设备状态。 更多...

+

OHOS::Camera::FlashlightStatus : uint32_t { OHOS::Camera::FLASHLIGHT_OFF = 0, OHOS::Camera::FLASHLIGHT_ON = 1, OHOS::Camera::FLASHLIGHT_UNAVAILABLE = 2 }

+

闪光灯状态。 更多...

+

OHOS::Camera::CameraEvent : uint32_t { OHOS::Camera::CAMERA_EVENT_DEVICE_ADD = 0, OHOS::Camera::CAMERA_EVENT_DEVICE_RMV = 1 }

+

Camera事件。 更多...

+

OHOS::Camera::ErrorType : uint32_t { OHOS::Camera::FATAL_ERROR = 0, OHOS::Camera::REQUEST_TIMEOUT = 1 }

+

设备错误类型，用于设备错误回调 OnError。 更多...

+

OHOS::Camera::StreamError { OHOS::Camera::UNKNOWN_ERROR = 0, OHOS::Camera::BUFFER_LOST = 1 }

+

流错误类型，用于流错误类型 CaptureErrorInfo。 更多...

+
+ +## **详细描述** + +Camera模块HDI接口使用的数据类型。 + +**Since：** + +1.0 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/union_audio_scene_descriptor_1_1_scene_desc.md b/zh-cn/device-dev/api/toctopics/union_audio_scene_descriptor_1_1_scene_desc.md new file mode 100644 index 0000000000..a8866a25bf --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/union_audio_scene_descriptor_1_1_scene_desc.md @@ -0,0 +1,36 @@ +# AudioSceneDescriptor::SceneDesc + +## **概述** + +**所属模块:** + +[Audio](_audio.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + +

Public 属性

+

描述

+

id

+

音频场景的ID。

+

desc

+

以字符串命名的音频场景。

+
+ +## **详细描述** + +音频场景描述。 + diff --git a/zh-cn/device-dev/api/toctopics/union_port_cap.md b/zh-cn/device-dev/api/toctopics/union_port_cap.md new file mode 100644 index 0000000000..71c8d90f17 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/union_port_cap.md @@ -0,0 +1,58 @@ +# PortCap + +## **概述** + +**所属模块:** + +[Codec](_codec.md) + +## **汇总** + +## Public 属性 + + + + + + + + + + + + + +

Public 属性

+

描述

+

video

+

视频编解码能力

+

audio

+

音频编解码能力

+
+ +## **详细描述** + +定义音视频编解码能力。 + +## **类成员变量说明** + +## audio + +``` +AudioPortCap PortCap::audio +``` + +**描述：** + +音频编解码能力 + +## video + +``` +VideoPortCap PortCap::video +``` + +**描述：** + +视频编解码能力 + diff --git a/zh-cn/device-dev/api/toctopics/usb__info_8h.md b/zh-cn/device-dev/api/toctopics/usb__info_8h.md new file mode 100644 index 0000000000..e8c5682f15 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/usb__info_8h.md @@ -0,0 +1,44 @@ +# usb\_info.h + +## **概述** + +**所属模块:** + +[USB](_u_s_b.md) + +## **汇总** + +## 类 + + + + + + + + + + + + + +

类

+

描述

+

OHOS::USB::USBDeviceInfo

+

USB设备信息。 更多...

+

OHOS::USB::UsbInfo

+

USB设备信息类。 更多...

+
+ +## **详细描述** + +USB驱动订阅模块使用的数据类型。 + +**Since：** + +3.0 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/usbd__client_8h.md b/zh-cn/device-dev/api/toctopics/usbd__client_8h.md new file mode 100644 index 0000000000..9eb3ebc024 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/usbd__client_8h.md @@ -0,0 +1,39 @@ +# usbd\_client.h + +## **概述** + +**所属模块:** + +[USB](_u_s_b.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

OHOS::USB::UsbdClient

+

USB驱动类。更多...

+
+ +## **详细描述** + +声明标准USB驱动接口函数。 + +**Since：** + +3.0 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/usbd__subscriber_8h.md b/zh-cn/device-dev/api/toctopics/usbd__subscriber_8h.md new file mode 100644 index 0000000000..842ddb91ba --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/usbd__subscriber_8h.md @@ -0,0 +1,39 @@ +# usbd\_subscriber.h + +## **概述** + +**所属模块:** + +[USB](_u_s_b.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

OHOS::USB::UsbdSubscriber

+

USB订阅类。更多...

+
+ +## **详细描述** + +USB驱动订阅模块。 + +**Since：** + +3.0 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/usbd__type_8h.md b/zh-cn/device-dev/api/toctopics/usbd__type_8h.md new file mode 100644 index 0000000000..f3cda91c42 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/usbd__type_8h.md @@ -0,0 +1,112 @@ +# usbd\_type.h + +## **概述** + +**所属模块:** + +[USB](_u_s_b.md) + +## **汇总** + +## 类 + + + + + + + + + + + + + + + + + + + +

类

+

描述

+

OHOS::USB::UsbDev

+

USB设备。 更多...

+

OHOS::USB::UsbPipe

+

管道信息。 更多...

+

OHOS::USB::UsbCtrlTransfer

+

USB控制传输。 更多...

+

OHOS::USB::USBDeviceInfo

+

USB设备信息。 更多...

+
+ +## 宏定义 + + + + + + + + + + +

宏定义

+

描述

+

USB_MAX_INTERFACES 32

+

USB设备最大接口数量。

+
+ +## 类型定义 + + + + + + + + + + +

类型定义

+

描述

+

(UsbdRequestCallback) (uint8_t *requestArg)

+

请求回调函数。

+
+ +## 枚举 + + + + + + + + + + + + + +

枚举

+

描述

+

UsbdBulkCbCmd { CMD_USBD_BULK_CALLBACK_READ, CMD_USBD_BULK_CALLBACK_WRITE }

+

批量回调命令字。 更多...

+

UsbdDeviceAction { ACT_DEVUP = 0, ACT_DEVDOWN, ACT_UPDEVICE, ACT_DOWNDEVICE }

+

主机端和设备端插拔事件。 更多...

+
+ +## **详细描述** + +USB驱动模块接口定义中使用的自定义数据类型。 + +USB驱动模块接口定义中使用的自定义数据类型, 包括分发的命令字、数据方向等。 + +**Since：** + +3.0 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/vibrator__if_8h.md b/zh-cn/device-dev/api/toctopics/vibrator__if_8h.md new file mode 100644 index 0000000000..0ff8106997 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/vibrator__if_8h.md @@ -0,0 +1,61 @@ +# vibrator\_if.h + +## **概述** + +**所属模块:** + +[Vibrator](_vibrator.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

VibratorInterface

+

提供Vibrator设备基本控制操作接口。

+
+ +## 函数 + + + + + + + + + + + + + +

函数

+

描述

+

NewVibratorInterfaceInstance (void)

+

创建一个VibratorInterface实例。 更多...

+

FreeVibratorInterfaceInstance (void)

+

释放VibratorInterface实例以及相关资源。 更多...

+
+ +## **详细描述** + +定义马达数据结构，包括马达模式和效果振动。 + +**Since：** + +2.2 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/vibrator__type_8h.md b/zh-cn/device-dev/api/toctopics/vibrator__type_8h.md new file mode 100644 index 0000000000..1f89ae4bad --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/vibrator__type_8h.md @@ -0,0 +1,39 @@ +# vibrator\_type.h + +## **概述** + +**所属模块:** + +[Vibrator](_vibrator.md) + +## **汇总** + +## 枚举 + + + + + + + + + + +

枚举

+

描述

+

VibratorMode { VIBRATOR_MODE_ONCE = 0, VIBRATOR_MODE_PRESET = 1, VIBRATOR_MODE_BUTT }

+

枚举马达振动模式。 更多...

+
+ +## **详细描述** + +定义马达数据结构，包括马达模式和效果振动。 + +**Since：** + +2.2 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/wifi__hal_8h.md b/zh-cn/device-dev/api/toctopics/wifi__hal_8h.md new file mode 100644 index 0000000000..62d5587aa6 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/wifi__hal_8h.md @@ -0,0 +1,78 @@ +# wifi\_hal.h + +## **概述** + +**所属模块:** + +[WLAN](_w_l_a_n.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

IWiFi

+

HAL对WLAN服务提供的基本能力。 更多...

+
+ +## 类型定义 + + + + + + + + + + +

类型定义

+

描述

+

(CallbackFunc) (uint32_t event, void *data, const char *ifName)

+

定义IWiFi回调函数的原型，监听异步事件。 更多...

+
+ +## 函数 + + + + + + + + + + + + + +

函数

+

描述

+

WifiConstruct (struct IWiFi **wifiInstance)

+

创建IWiFi结构体，挂接IWiFi中能力接口。 更多...

+

WifiDestruct (struct IWiFi **wifiInstance)

+

销毁IWiFi结构体并释放相关资源。 更多...

+
+ +## **详细描述** + +提供给WLAN服务的WLAN基本能力接口。 + +**Since：** + +1.0 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/wifi__hal__ap__feature_8h.md b/zh-cn/device-dev/api/toctopics/wifi__hal__ap__feature_8h.md new file mode 100644 index 0000000000..fce63613c2 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/wifi__hal__ap__feature_8h.md @@ -0,0 +1,61 @@ +# wifi\_hal\_ap\_feature.h + +## **概述** + +**所属模块:** + +[WLAN](_w_l_a_n.md) + +## **汇总** + +## 类 + + + + + + + + + + + + + +

类

+

描述

+

StaInfo

+

描述与AP连接的STA的基本信息 更多...

+

IWiFiAp

+

继承了IWiFiBaseFeature基本特性，并包含AP模式下获取连接STA的信息和设置国家码的功能。 更多...

+
+ +## 函数 + + + + + + + + + + +

函数

+

描述

+

InitApFeature (struct IWiFiAp **fe)

+

初始化AP特性。WLAN服务在创建AP类型的特性FeatureType时调用。 更多...

+
+ +## **详细描述** + +提供WLAN的AP特性能力（获取与AP连接的STA的基本信息、设置国家码）。 + +**Since：** + +1.0 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/wifi__hal__base__feature_8h.md b/zh-cn/device-dev/api/toctopics/wifi__hal__base__feature_8h.md new file mode 100644 index 0000000000..a828e2dbf9 --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/wifi__hal__base__feature_8h.md @@ -0,0 +1,100 @@ +# wifi\_hal\_base\_feature.h + +## **概述** + +**所属模块:** + +[WLAN](_w_l_a_n.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

IWiFiBaseFeature

+

WLAN基本特性操作接口，包括获取网卡名称，设置MAC地址，设置发射功率等公共能力接口。 更多...

+
+ +## 宏定义 + + + + + + + + + + + + + + + + +

宏定义

+

描述

+

IFNAME_MAX_LEN 16

+

网卡名称最大长度。

+

WIFI_MAC_ADDR_LENGTH 6

+

WLAN的MAC地址长度。

+

ERR_UNAUTH_ACCESS (-6)

+

定义访问失败错误码。

+
+ +## 枚举 + + + + + + + + + + +

枚举

+

描述

+

FeatureType { PROTOCOL_80211_IFTYPE_UNSPECIFIED, PROTOCOL_80211_IFTYPE_ADHOC, PROTOCOL_80211_IFTYPE_STATION, PROTOCOL_80211_IFTYPE_AP, PROTOCOL_80211_IFTYPE_AP_VLAN, PROTOCOL_80211_IFTYPE_WDS, PROTOCOL_80211_IFTYPE_MONITOR, PROTOCOL_80211_IFTYPE_MESH_POINT, PROTOCOL_80211_IFTYPE_P2P_CLIENT, PROTOCOL_80211_IFTYPE_P2P_GO, PROTOCOL_80211_IFTYPE_P2P_DEVICE, PROTOCOL_80211_IFTYPE_NUM }

+

枚举WLAN相关特性的类型FeatureType。 更多...

+
+ +## 函数 + + + + + + + + + + +

函数

+

描述

+

InitBaseFeature (struct IWiFiBaseFeature **fe)

+

WLAN服务创建任何类型的特性{@Link FeatureType}时，都需要调用此函数。 更多...

+
+ +## **详细描述** + +提供WLAN基本特性能力。 + +**Since：** + +1.0 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/toctopics/wifi__hal__sta__feature_8h.md b/zh-cn/device-dev/api/toctopics/wifi__hal__sta__feature_8h.md new file mode 100644 index 0000000000..0876533c3a --- /dev/null +++ b/zh-cn/device-dev/api/toctopics/wifi__hal__sta__feature_8h.md @@ -0,0 +1,56 @@ +# wifi\_hal\_sta\_feature.h + +## **概述** + +**所属模块:** + +[WLAN](_w_l_a_n.md) + +## **汇总** + +## 类 + + + + + + + + + + +

类

+

描述

+

IWiFiSta

+

继承了IWiFiBaseFeature基本特性，额外包含设置扫描单个MAC地址功能。 更多...

+
+ +## 函数 + + + + + + + + + + +

函数

+

描述

+

InitStaFeature (struct IWiFiSta **fe)

+

初始化STA特性。WLAN服务在创建STA类型的特性FeatureType时调用。 更多...

+
+ +## **详细描述** + +提供WLAN的STA特性能力。 + +**Since：** + +1.0 + +**Version：** + +1.0 + diff --git a/zh-cn/device-dev/api/zh-cn_bookmap_0000001343320953.md b/zh-cn/device-dev/api/zh-cn_bookmap_0000001343320953.md new file mode 100644 index 0000000000..78960532e6 --- /dev/null +++ b/zh-cn/device-dev/api/zh-cn_bookmap_0000001343320953.md @@ -0,0 +1,219 @@ +# Native API 参考 + +- [NativeAPI参考](toctopics/index.md) + - [Audio](toctopics/_audio.md) + - [Battery](toctopics/battery.md) + - [Camera](toctopics/_camera.md) + - [Codec](toctopics/_codec.md) + - [Display](toctopics/_display.md) + - [DAC](toctopics/_d_a_c.md) + - [HdfFaceAuth](toctopics/_hdf_face_auth.md) + - [Input](toctopics/_input.md) + - [Light](toctopics/_light.md) + - [HdfPinAuth](toctopics/_hdf_pin_auth.md) + - [Power](toctopics/power.md) + - [Sensor](toctopics/_sensor.md) + - [Thermal](toctopics/thermal.md) + - [USB](toctopics/_u_s_b.md) + - [HdfUserAuth](toctopics/_hdf_user_auth.md) + - [Vibrator](toctopics/_vibrator.md) + - [WLAN](toctopics/_w_l_a_n.md) + +- [头文件和结构体](toctopics/total.md) + - [头文件](toctopics/files.md) + - [audio\_adapter.h](toctopics/audio__adapter_8h.md) + - [audio\_attribute.h](toctopics/audio__attribute_8h.md) + - [audio\_capture.h](toctopics/audio__capture_8h.md) + - [audio\_control.h](toctopics/audio__control_8h.md) + - [audio\_manager.h](toctopics/audio__manager_8h.md) + - [audio\_render.h](toctopics/audio__render_8h.md) + - [audio\_scene.h](toctopics/audio__scene_8h.md) + - [audio\_types.h](toctopics/audio__types_8h.md) + - [audio\_volume.h](toctopics/audio__volume_8h.md) + - [codec\_callback\_if.h](toctopics/codec__callback__if_8h.md) + - [codec\_common\_type.h](toctopics/codec__common__type_8h.md) + - [codec\_component\_if.h](toctopics/codec__component__if_8h.md) + - [codec\_component\_manager.h](toctopics/codec__component__manager_8h.md) + - [codec\_component\_type.h](toctopics/codec__component__type_8h.md) + - [dac\_if.h](toctopics/dac__if_8h.md) + - [display\_device.h](toctopics/display__device_8h.md) + - [display\_gfx.h](toctopics/display__gfx_8h.md) + - [display\_gralloc.h](toctopics/display__gralloc_8h.md) + - [display\_layer.h](toctopics/display__layer_8h.md) + - [display\_type.h](toctopics/display__type_8h.md) + - [icamera\_device\_callback.h](toctopics/icamera__device__callback_8h.md) + - [icamera\_device.h](toctopics/icamera__device_8h.md) + - [icamera\_host\_callback.h](toctopics/icamera__host__callback_8h.md) + - [icamera\_host.h](toctopics/icamera__host_8h.md) + - [input\_controller.h](toctopics/input__controller_8h.md) + - [input\_manager.h](toctopics/input__manager_8h.md) + - [input\_reporter.h](toctopics/input__reporter_8h.md) + - [input\_type.h](toctopics/input__type_8h.md) + - [ioffline\_stream\_operator.h](toctopics/ioffline__stream__operator_8h.md) + - [istream\_operator\_callback.h](toctopics/istream__operator__callback_8h.md) + - [istream\_operator.h](toctopics/istream__operator_8h.md) + - [light\_if.h](toctopics/light__if_8h.md) + - [light\_type.h](toctopics/light_8typeh.md) + - [sensor\_if.h](toctopics/sensor__if_8h.md) + - [sensor\_type.h](toctopics/sensor__type_8h.md) + - [types.h](toctopics/types_8h.md) + - [usb\_info.h](toctopics/usb__info_8h.md) + - [usbd\_client.h](toctopics/usbd__client_8h.md) + - [usbd\_subscriber.h](toctopics/usbd__subscriber_8h.md) + - [usbd\_type.h](toctopics/usbd__type_8h.md) + - [vibrator\_if.h](toctopics/vibrator__if_8h.md) + - [vibrator\_type.h](toctopics/vibrator__type_8h.md) + - [wifi\_hal\_ap\_feature.h](toctopics/wifi__hal__ap__feature_8h.md) + - [wifi\_hal\_base\_feature.h](toctopics/wifi__hal__base__feature_8h.md) + - [wifi\_hal\_sta\_feature.h](toctopics/wifi__hal__sta__feature_8h.md) + - [wifi\_hal.h](toctopics/wifi__hal_8h.md) + - [FACEAUTH\_IExecutor.idl](toctopics/face__auth_2_i_executor_8idl.md) + - [FACEAUTH\_IExecutorCallback.idl](toctopics/face__auth_2_i_executor_callback_8idl.md) + - [FaceAuthTypes.idl](toctopics/_face_auth_types_8idl.md) + - [IBatteryCallback.idl](toctopics/_i_battery_callback_8idl.md) + - [IBatteryInterface.idl](toctopics/_i_battery_interface_8idl.md) + - [IExecutor.idl](toctopics/pin__auth_2_i_executor_8idl.md) + - [IExecutorCallback.idl](toctopics/pin__auth_2_i_executor_callback_8idl.md) + - [IFaceAuthInterface.idl](toctopics/_i_face_auth_interface_8idl.md) + - [IPinAuthInterface.idl](toctopics/_i_pin_auth_interface_8idl.md) + - [IPowerHdiCallback.idl](toctopics/_i_power_hdi_callback_8idl.md) + - [IPowerInterface.idl](toctopics/_i_power_interface_8idl.md) + - [IThermalInterface.idl](toctopics/_i_thermal_interface_8idl.md) + - [IThermalCallback.idl](toctopics/_i_thermal_callback_8idl.md) + - [IUserAuthInterface.idl](toctopics/_i_user_auth_interface_8idl.md) + - [PowerTypes.idl](toctopics/_power_types_8idl.md) + - [ThermalTypes.idl](toctopics/_thermal_types_8idl.md) + - [Types.idl](toctopics/_types_8idl.md) + - [UserAuthTypes.idl](toctopics/_user_auth_types_8idl.md) + + - [结构体](toctopics/annotated.md) + - [\_\_attribute\_\_](toctopics/____attribute____.md) + - [Alignment](toctopics/_alignment.md) + - [AllocInfo](toctopics/_alloc_info.md) + - [AudioAdapter](toctopics/_audio_adapter.md) + - [AudioAdapterDescriptor](toctopics/_audio_adapter_descriptor.md) + - [AudioAttribute](toctopics/_audio_attribute.md) + - [AudioCapture](toctopics/_audio_capture.md) + - [AudioControl](toctopics/_audio_control.md) + - [AudioDevExtInfo](toctopics/_audio_dev_ext_info.md) + - [AudioDeviceDescriptor](toctopics/_audio_device_descriptor.md) + - [AudioManager](toctopics/_audio_manager.md) + - [AudioMixExtInfo](toctopics/_audio_mix_ext_info.md) + - [AudioMmapBufferDescripter](toctopics/_audio_mmap_buffer_descripter.md) + - [AudioPort](toctopics/_audio_port.md) + - [AudioPortCap](toctopics/_audio_port_cap.md) + - [AudioPortCapability](toctopics/_audio_port_capability.md) + - [AudioRender](toctopics/_audio_render.md) + - [AudioRoute](toctopics/_audio_route.md) + - [AudioRouteNode](toctopics/_audio_route_node.md) + - [AudioSampleAttributes](toctopics/_audio_sample_attributes.md) + - [AudioScene](toctopics/_audio_scene.md) + - [AudioSceneDescriptor](toctopics/_audio_scene_descriptor.md) + - [AudioSceneDescriptor::SceneDesc](toctopics/union_audio_scene_descriptor_1_1_scene_desc.md) + - [AudioSessionExtInfo](toctopics/_audio_session_ext_info.md) + - [AudioSubPortCapability](toctopics/_audio_sub_port_capability.md) + - [AudioTimeStamp](toctopics/_audio_time_stamp.md) + - [AudioVolume](toctopics/_audio_volume.md) + - [AuthResultInfo](toctopics/_auth_result_info.md) + - [AuthSolution](toctopics/_auth_solution.md) + - [BatteryInfo](toctopics/_battery_info.md) + - [BufferData](toctopics/_buffer_data.md) + - [CodecCallbackType](toctopics/_codec_callback_type.md) + - [CodecCompCapability](toctopics/_codec_comp_capability.md) + - [CodecComponentManager](toctopics/_codec_component_manager.md) + - [CodecComponentType](toctopics/_codec_component_type.md) + - [CompVerInfo](toctopics/_comp_ver_info.md) + - [CredentialInfo](toctopics/_credential_info.md) + - [DacIoMsg](toctopics/_dac_io_msg.md) + - [DeviceFuncs](toctopics/_device_funcs.md) + - [DeviceInfo](toctopics/_device_info.md) + - [DisplayCapability](toctopics/_display_capability.md) + - [DisplayInfo](toctopics/_display_info.md) + - [DisplayModeInfo](toctopics/_display_mode_info.md) + - [EnrolledInfo](toctopics/_enrolled_info.md) + - [EnrollParam](toctopics/_enroll_param.md) + - [EventInfo](toctopics/_event_info.md) + - [EventPackage](toctopics/_event_package.md) + - [ExecutorInfo](toctopics/_executor_info.md) + - [ExecutorRegisterInfo](toctopics/_executor_register_info.md) + - [ExecutorSendMsg](toctopics/_executor_send_msg.md) + - [GetBufferHandleUsageParams](toctopics/_get_buffer_handle_usage_params.md) + - [GfxFuncs](toctopics/_gfx_funcs.md) + - [GfxOpt](toctopics/_gfx_opt.md) + - [GrallocFuncs](toctopics/_gralloc_funcs.md) + - [HdfThermalCallbackInfo](toctopics/_hdf_thermal_callback_info.md) + - [HDRCapability](toctopics/_h_d_r_capability.md) + - [HDRMetaData](toctopics/_h_d_r_meta_data.md) + - [IBatteryCallback](toctopics/interface_i_battery_callback.md) + - [IBatteryInterface](toctopics/interface_i_battery_interface.md) + - [ICircle](toctopics/_i_circle.md) + - [IdentifyResultInfo](toctopics/_identify_result_info.md) + - [IExecutor](toctopics/interface_i_executor.md) + - [IExecutorCallback](toctopics/interface_i_executor_callback.md) + - [IFaceAuthInterface](toctopics/interface_i_face_auth_interface.md) + - [IInputInterface](toctopics/_i_input_interface.md) + - [ILine](toctopics/_i_line.md) + - [InputController](toctopics/_input_controller.md) + - [InputExtraCmd](toctopics/_input_extra_cmd.md) + - [InputManager](toctopics/_input_manager.md) + - [InputReporter](toctopics/_input_reporter.md) + - [InputReportEventCb](toctopics/_input_report_event_cb.md) + - [IPinAuthInterface](toctopics/interface_i_pin_auth_interface.md) + - [IPowerHdiCallback](toctopics/interface_i_power_hdi_callback.md) + - [IPowerInterface](toctopics/interface_i_power_interface.md) + - [IRect](toctopics/_i_rect.md) + - [ISurface](toctopics/_i_surface.md) + - [IThermalCallback](toctopics/interface_i_thermal_callback.md) + - [IThermalInterface](toctopics/interface_i_thermal_interface.md) + - [IUserAuthInterface](toctopics/interface_i_user_auth_interface.md) + - [IWiFi](toctopics/_i_wi_fi.md) + - [IWiFiAp](toctopics/_i_wi_fi_ap.md) + - [IWiFiBaseFeature](toctopics/_i_wi_fi_base_feature.md) + - [IWiFiSta](toctopics/_i_wi_fi_sta.md) + - [LayerAlpha](toctopics/_layer_alpha.md) + - [LayerBuffer](toctopics/_layer_buffer.md) + - [LayerFuncs](toctopics/_layer_funcs.md) + - [LayerInfo](toctopics/_layer_info.md) + - [LightEffect](toctopics/_light_effect.md) + - [LightFlashEffect](toctopics/_light_flash_effect.md) + - [LightInfo](toctopics/_light_info.md) + - [LightInterface](toctopics/_light_interface.md) + - [OHOS::Camera::CaptureEndedInfo](toctopics/_o_h_o_s_1_1_camera_1_1_capture_ended_info.md) + - [OHOS::Camera::CaptureErrorInfo](toctopics/_o_h_o_s_1_1_camera_1_1_capture_error_info.md) + - [OHOS::Camera::CaptureInfo](toctopics/_o_h_o_s_1_1_camera_1_1_capture_info.md) + - [OHOS::Camera::ICameraDevice](toctopics/_o_h_o_s_1_1_camera_1_1_i_camera_device.md) + - [OHOS::Camera::ICameraDeviceCallback](toctopics/_o_h_o_s_1_1_camera_1_1_i_camera_device_callback.md) + - [OHOS::Camera::ICameraHost](toctopics/_o_h_o_s_1_1_camera_1_1_i_camera_host.md) + - [OHOS::Camera::ICameraHostCallback](toctopics/_o_h_o_s_1_1_camera_1_1_i_camera_host_callback.md) + - [OHOS::Camera::IOfflineStreamOperator](toctopics/_o_h_o_s_1_1_camera_1_1_i_offline_stream_operator.md) + - [OHOS::Camera::IStreamOperator](toctopics/_o_h_o_s_1_1_camera_1_1_i_stream_operator.md) + - [OHOS::Camera::IStreamOperatorCallback](toctopics/_o_h_o_s_1_1_camera_1_1_i_stream_operator_callback.md) + - [OHOS::Camera::StreamAttribute](toctopics/_o_h_o_s_1_1_camera_1_1_stream_attribute.md) + - [OHOS::Camera::StreamInfo](toctopics/_o_h_o_s_1_1_camera_1_1_stream_info.md) + - [OHOS::USB::UsbCtrlTransfer](toctopics/_o_h_o_s_1_1_u_s_b_1_1_usb_ctrl_transfer.md) + - [OHOS::USB::UsbdClient](toctopics/_o_h_o_s_1_1_u_s_b_1_1_usbd_client.md) + - [OHOS::USB::UsbDev](toctopics/_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md) + - [OHOS::USB::USBDeviceInfo](toctopics/_o_h_o_s_1_1_u_s_b_1_1_u_s_b_device_info.md) + - [OHOS::USB::UsbdSubscriber](toctopics/_o_h_o_s_1_1_u_s_b_1_1_usbd_subscriber.md) + - [OHOS::USB::UsbInfo](toctopics/_o_h_o_s_1_1_u_s_b_1_1_usb_info.md) + - [OHOS::USB::UsbPipe](toctopics/_o_h_o_s_1_1_u_s_b_1_1_usb_pipe.md) + - [OmxCodecBuffer](toctopics/_omx_codec_buffer.md) + - [PortCap](toctopics/union_port_cap.md) + - [PresentTimestamp](toctopics/_present_timestamp.md) + - [PropertyObject](toctopics/_property_object.md) + - [RangeValue](toctopics/_range_value.md) + - [Rect](toctopics/_rect.md) + - [Rectangle](toctopics/_rectangle.md) + - [ScheduleInfo](toctopics/_schedule_info.md) + - [SensorEvents](toctopics/_sensor_events.md) + - [SensorInformation](toctopics/_sensor_information.md) + - [SensorInterface](toctopics/_sensor_interface.md) + - [StaInfo](toctopics/_sta_info.md) + - [SupportBufferType](toctopics/_support_buffer_type.md) + - [TemplateInfo](toctopics/_template_info.md) + - [ThermalZoneInfo](toctopics/_thermal_zone_info.md) + - [UseBufferType](toctopics/_use_buffer_type.md) + - [VerifyAllocInfo](toctopics/_verify_alloc_info.md) + - [VibratorInterface](toctopics/_vibrator_interface.md) + - [VideoPortCap](toctopics/_video_port_cap.md) + -- GitLab