VibratorAgent

java.lang.Object
- ohos.vibrator.agent.VibratorAgent

```
public class VibratorAgent
extends Object
```
Manages vibrators on hardware devices.
This class allows you to query a vibrator based on its ID, check whether the vibrator supports a specific vibration effect, enable the vibrator to vibrate with a certain effect, and disable the vibrator.

从以下版本开始:

1

另请参阅:

VibrationPattern

SystemCapability

SystemCapability.Sensors#MISC_DEVICE

字段概要

字段
限定符和类型	字段	说明
`static String`	`VIBRATOR_STOP_MODE_CUSTOMIZED`	Indicates the mode of stopping a custom vibration effect.
`static String`	`VIBRATOR_STOP_MODE_PRESET`	Indicates the mode of stopping a preset vibration effect.
`static String`	`VIBRATOR_STOP_MODE_TIME`	Indicates the mode of stopping a one-shot vibration effect.

构造器概要

构造器
构造器说明

VibratorAgent()
Default constructor used to create a VibratorAgent instance.

构造器
构造器	说明
`VibratorAgent()`	Default constructor used to create a `VibratorAgent` instance.

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`List<Integer>`	`getVibratorIdList()`	Obtains the IDs of all vibrators on the device.
`boolean`	`isEffectSupport(int vibratorId, String effectId)`	Checks whether a specified vibrator supports a preset vibration effect.
`boolean`	`isSupport(int vibratorId)`	Checks whether a specified vibrator exists on the hardware device.
`boolean`	`start(int vibratorId, VibrationPattern vibrationEffect)`	Controls a specified vibrator to vibrate with a custom effect.
`boolean`	`start(String effectId, boolean isLooping)`	Controls this vibrator to perform a periodic vibration with a preset vibration effect.
`boolean`	`start(VibrationPattern vibrationEffect)`	Controls this vibrator to vibrate with a custom vibration effect.
`boolean`	`startOnce(int duration)`	Controls this vibrator to perform a one-shot vibration at a given duration.
`boolean`	`startOnce(int vibratorId, int duration)`	Controls a specified vibrator to perform a one-shot vibration at a given duration.
`boolean`	`startOnce(int vibratorId, String effectId)`	Controls a specified vibrator to perform a one-shot vibration with a preset vibration effect.
`boolean`	`startOnce(String effectId)`	Controls this vibrator to perform a one-shot vibration with a preset vibration effect.
`boolean`	`stop()`	Stops the vibration of this vibrator.
`boolean`	`stop(int vibratorId, String stopMode)`	Stops the vibration of a vibrator.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - VIBRATOR_STOP_MODE_CUSTOMIZED
```
public static final String VIBRATOR_STOP_MODE_CUSTOMIZED
```
    Indicates the mode of stopping a custom vibration effect.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - VIBRATOR_STOP_MODE_PRESET
```
public static final String VIBRATOR_STOP_MODE_PRESET
```
    Indicates the mode of stopping a preset vibration effect.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - VIBRATOR_STOP_MODE_TIME
```
public static final String VIBRATOR_STOP_MODE_TIME
```
    Indicates the mode of stopping a one-shot vibration effect.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - VibratorAgent
```
public VibratorAgent()
```
    Default constructor used to create a VibratorAgent instance.
    
    从以下版本开始:
    
    1
- 方法详细资料
  - getVibratorIdList
```
public List<Integer> getVibratorIdList()
```
    Obtains the IDs of all vibrators on the device.
    This method can be used when you want to query the IDs of all vibrators on the device.
    
    返回:
    
    Returns the IDs of all vibrators on the device.
    
    从以下版本开始:
    
    1
  - isSupport
```
public boolean isSupport(int vibratorId)
```
    Checks whether a specified vibrator exists on the hardware device.
    This method can be used when you do not know whether a vibrator exists on the device.
    
    参数:
    
    vibratorId - Indicates the ID of the vibrator. You can use the getVibratorIdList() method to obtain the vibrator ID list.
    
    返回:
    
    Returns true if the vibrator exists; returns false otherwise.
    
    从以下版本开始:
    
    1
  - isEffectSupport
```
public boolean isEffectSupport(int vibratorId,
                               String effectId)
```
    Checks whether a specified vibrator supports a preset vibration effect.
    Call this method to check whether the vibrator supports a specific vibration effect before enabling it to vibrate with this effect.
    
    参数:
    
    vibratorId - Indicates the ID of the vibrator. You can use the getVibratorIdList() method to obtain the vibrator ID list.
    
    effectId - Indicates the preset vibration effect, which is described in VibrationPattern.
    
    返回:
    
    Returns true if the vibrator supports the specified vibration effect; returns false otherwise.
    
    从以下版本开始:
    
    1
  - startOnce
```
public boolean startOnce(int vibratorId,
                         int duration)
```
    Controls a specified vibrator to perform a one-shot vibration at a given duration.
    Your application needs to request the ohos.permission.VIBRATE permission to call this method.
    
    参数:
    
    vibratorId - Indicates the ID of the vibrator. You can use the getVibratorIdList() method to obtain the vibrator ID list.
    
    duration - Indicates the duration that the one-shot vibration lasts, in milliseconds.
    
    返回:
    
    Returns true if the vibrator vibrates as expected; returns false otherwise, for example, the given duration for the one-shot vibration is invalid.
    
    从以下版本开始:
    
    4
  - startOnce
```
public boolean startOnce(int vibratorId,
                         String effectId)
```
    Controls a specified vibrator to perform a one-shot vibration with a preset vibration effect.
    Your application needs to request the ohos.permission.VIBRATE permission to call this method.
    
    参数:
    
    vibratorId - Indicates the ID of the vibrator. You can use the getVibratorIdList() method to obtain the vibrator ID list.
    
    effectId - Indicates the preset vibration effect, which is described in VibrationPattern.
    
    返回:
    
    Returns true if the vibrator vibrates as expected; returns false otherwise, for example, the preset vibration effect is not supported.
    
    从以下版本开始:
    
    4
  - start
```
public boolean start(int vibratorId,
                     VibrationPattern vibrationEffect)
```
    Controls a specified vibrator to vibrate with a custom effect.
    You can customize a vibration effect in VibrationPattern. Your application needs to request the ohos.permission.VIBRATE permission to call this method.
    
    参数:
    
    vibratorId - Indicates the ID of the vibrator. You can use the getVibratorIdList() method to obtain the vibrator ID list.
    
    vibrationEffect - Indicates a custom vibration effect. You can customize the effect of a one-shot vibration using the VibrationPattern.createSingle(int, int) method, and customize the effect of a periodic vibration using the VibrationPattern.createPeriod(int[], int) or VibrationPattern.createPeriod(int[], int[], int) method.
    
    返回:
    
    Returns true if the vibrator vibrates as expected; returns false otherwise, for example, the custom vibration effect is not supported.
    
    从以下版本开始:
    
    4
    
    另请参阅:
    
    VibrationPattern
  - startOnce
```
public boolean startOnce(int duration)
```
    Controls this vibrator to perform a one-shot vibration at a given duration.
    Your application needs to request the ohos.permission.VIBRATE permission to call this method.
    
    参数:
    
    duration - Indicates the duration that the one-shot vibration lasts, in milliseconds.
    
    返回:
    
    Returns true if the vibrator vibrates as expected; returns false otherwise, for example, the given duration for the one-shot vibration is invalid.
    
    从以下版本开始:
    
    4
  - startOnce
```
public boolean startOnce(String effectId)
```
    Controls this vibrator to perform a one-shot vibration with a preset vibration effect.
    Your application needs to request the ohos.permission.VIBRATE permission to call this method.
    
    参数:
    
    effectId - Indicates the preset vibration effect, which is described in VibrationPattern.
    
    返回:
    
    Returns true if the vibrator vibrates as expected; returns false otherwise, for example, the preset vibration effect is not supported.
    
    从以下版本开始:
    
    4
  - start
```
public boolean start(String effectId,
                     boolean isLooping)
```
    Controls this vibrator to perform a periodic vibration with a preset vibration effect.
    
    参数:
    
    effectId - Indicates the preset vibration effect, which is described in VibrationPattern.
    
    isLooping - Specifies whether to start a periodic vibration. The value true means to start a periodic vibration, and false means the opposite.
    
    返回:
    
    Returns true if the vibrator vibrates as expected; returns false otherwise, for example, the preset vibration effect does not support periodic vibration.
    
    从以下版本开始:
    
    5
  - start
```
public boolean start(VibrationPattern vibrationEffect)
```
    Controls this vibrator to vibrate with a custom vibration effect.
    You can customize a vibration effect in VibrationPattern. Your application needs to request the ohos.permission.VIBRATE permission to call this method.
    
    参数:
    
    vibrationEffect - Indicates a custom vibration effect. You can customize the effect of a one-shot vibration using the VibrationPattern.createSingle(int, int) method, and customize the effect of a periodic vibration using the VibrationPattern.createPeriod(int[], int) or VibrationPattern.createPeriod(int[], int[], int) method.
    
    返回:
    
    Returns true if the vibrator vibrates as expected; returns false otherwise, for example, the custom vibration effect is not supported.
    
    从以下版本开始:
    
    4
    
    另请参阅:
    
    VibrationPattern
  - stop
```
public boolean stop(int vibratorId,
                    String stopMode)
```
    Stops the vibration of a vibrator.
    This method can be used when you no longer need the vibrator to vibrate.
    
    参数:
    
    vibratorId - Indicates the ID of the vibrator. You can use the getVibratorIdList() method to obtain the vibrator ID list.
    
    stopMode - Indicates the mode of the vibration to stop. The values can be time, preset, and customized, respectively representing a one-shot vibration effect, a preset vibration effect, and a custom vibration effect.
    
    返回:
    
    Returns true if the vibration is normally stopped; returns false otherwise, for example, the specified stop mode is invalid.
    
    从以下版本开始:
    
    1
  - stop
```
public boolean stop()
```
    Stops the vibration of this vibrator.
    This method can be used when you no longer need the vibrator to vibrate.
    
    返回:
    
    Returns true if the vibration is normally stopped; returns false otherwise.
    
    从以下版本开始:
    
    4

类 VibratorAgent

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

VIBRATOR_STOP_MODE_CUSTOMIZED

VIBRATOR_STOP_MODE_PRESET

VIBRATOR_STOP_MODE_TIME

构造器详细资料

VibratorAgent

方法详细资料

getVibratorIdList

isSupport

isEffectSupport

startOnce

startOnce

start

startOnce

startOnce

start

start

stop

stop