vibrator.h
Overview
Declares the APIs for starting or stopping vibration.
Header file: <sensors/vibrator.h>
Library: libohvibrator.z.so
System capability: SystemCapability.Sensors.MiscDevice
Since: 11
Related module: Vibrator
Summary
Functions
| Name | Description |
|---|---|
| int32_t OH_Vibrator_PlayVibration(int32_t duration, Vibrator_Attribute attribute) | Configures the vibrator to vibrate continuously for a given duration. |
| int32_t OH_Vibrator_PlayVibrationCustom(Vibrator_FileDescription fileDescription, Vibrator_Attribute vibrateAttribute) | Configures the vibrator to vibrate with the custom sequence. |
| int32_t OH_Vibrator_Cancel() | Stops the vibration. |
Function Description
OH_Vibrator_PlayVibration()
int32_t OH_Vibrator_PlayVibration(int32_t duration, Vibrator_Attribute attribute)
Description
Controls the vibrator to vibrate continuously for a given duration.
Required permissions: ohos.permission.VIBRATE
Since: 11
Parameters
| Name | Description |
|---|---|
| int32_t duration | Vibration duration, in milliseconds. |
| Vibrator_Attribute attribute | Vibration attribute. For details, see VibrateAttribute. |
Returns
| Type | Description |
|---|---|
| int32_t | Returns 0 if the operation is successful; returns a non-zero value otherwise. For details, see Vibrator_ErrorCode. |
OH_Vibrator_PlayVibrationCustom()
int32_t OH_Vibrator_PlayVibrationCustom(Vibrator_FileDescription fileDescription, Vibrator_Attribute vibrateAttribute)
Description
Configure the vibrator to vibrate with the custom sequence.
Required permissions: ohos.permission.VIBRATE
Since: 11
Parameters
| Name | Description |
|---|---|
| Vibrator_FileDescription fileDescription | File descriptor of the custom vibration effect. For details, see Vibrator_FileDescription. |
| Vibrator_Attribute vibrateAttribute | Vibration attribute. For details, see Vibrator_Attribute. |
Returns
| Type | Description |
|---|---|
| int32_t | Returns 0 if the operation is successful; returns a non-zero value otherwise. For details, see Vibrator_ErrorCode. |
OH_Vibrator_Cancel()
int32_t OH_Vibrator_Cancel()
Description
Stops the vibration.
Required permissions: ohos.permission.VIBRATE
Since: 11
Returns
| Type | Description |
|---|---|
| int32_t | Returns 0 if the operation is successful; returns a non-zero value otherwise. For details, see Vibrator_ErrorCode. |
你可能感兴趣的鸿蒙文章
openharmony 鸿蒙 js-apis-vibrator
openharmony 鸿蒙 capi-sensor-sensor-subscriptionid
openharmony 鸿蒙 capi-sensor-sensor-subscriptionattribute
openharmony 鸿蒙 capi-vibrator-vibrator-filedescription
openharmony 鸿蒙 js-apis-sensor-sys
openharmony 鸿蒙 capi-oh-sensor-h
openharmony 鸿蒙 errorcode-sensor