vibrator_type.h

Overview

Declares the APIs for starting or stopping vibration.

Reference file: <sensors/vibrator_type.h>

Library: libohvibrator.z.so

System capability: SystemCapability.Sensors.MiscDevice

Since: 11

Related module: Vibrator

Name	typedef Keyword	Description
Vibrator_Attribute	Vibrator_Attribute	Defines a struct for the vibrator attribute.
Vibrator_FileDescription	Vibrator_FileDescription	Defines a struct for the vibration file description.

Name	typedef Keyword	Description
Vibrator_ErrorCode	Vibrator_ErrorCode	Enumerates the vibrator error codes.
Vibrator_Usage	Vibrator_Usage	Enumerates the vibration scenarios.

enum Vibrator_ErrorCode

Description

Enumerates the vibrator error codes.

Since: 11

Enum Item	Description
PERMISSION_DENIED = 201	Permission denied.
PARAMETER_ERROR = 401	Parameter check failed. For example, a mandatory parameter is not passed in, or the parameter type passed in is incorrect.
UNSUPPORTED = 801	The device does not support this API. Generally, this enumerated value is used for a device that supports the corresponding system capability but only parts of APIs.
DEVICE_OPERATION_FAILED = 14600101	Device operation failed.

enum Vibrator_Usage

Description

Enumerates the vibration scenarios.

Since: 11

Enum Item	Description
VIBRATOR_USAGE_UNKNOWN = 0	Unknown scenario
VIBRATOR_USAGE_ALARM = 1	Alarming
VIBRATOR_USAGE_RING = 2	Ringing
VIBRATOR_USAGE_NOTIFICATION = 3	Notification
VIBRATOR_USAGE_COMMUNICATION = 4	Telecommunications
VIBRATOR_USAGE_TOUCH = 5	Touch
VIBRATOR_USAGE_MEDIA = 6	Multimedia
VIBRATOR_USAGE_PHYSICAL_FEEDBACK = 7	Physical feedback
VIBRATOR_USAGE_SIMULATED_REALITY = 8	Simulated reality