java.lang.Object
- org.robolectric.shadows.ShadowVibrator

Direct Known Subclasses:: ShadowSystemVibrator

@Implements(android.os.Vibrator.class)
public class ShadowVibrator
extends Object

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`ShadowVibrator.PrimitiveEffect`	A data class for exposing `VibrationEffect.Composition$PrimitiveEffect`, which is a hidden non TestApi class introduced in Android R.

Field Summary

Fields
Modifier and Type	Field	Description
`protected static AudioAttributes`	`audioAttributesFromLastVibration`
`protected static long[]`	`pattern`
`protected static List<ShadowVibrator.PrimitiveEffect>`	`primitiveEffects`
`protected static List<Integer>`	`supportedPrimitives`
`protected static VibrationAttributes`	`vibrationAttributesFromLastVibration`
`protected static List<android.os.vibrator.VibrationEffectSegment>`	`vibrationEffectSegments`

Constructor Summary

Constructors
Constructor Description

ShadowVibrator()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected boolean`	`areAllPrimitivesSupported(int... primitiveIds)`
`AudioAttributes`	`getAudioAttributesFromLastVibration()`	Returns the `AudioAttributes` from the last vibration.
`int`	`getEffectId()`	Returns the last vibration effect ID of a `VibrationEffect#Prebaked` (e.g.
`long`	`getMilliseconds()`	Returns the last vibration duration in MS.
`long[]`	`getPattern()`	Returns the last vibration pattern.
`List<ShadowVibrator.PrimitiveEffect>`	`getPrimitiveEffects()`	Returns the last list of `ShadowVibrator.PrimitiveEffect`.
`List<ShadowVibrator.PrimitiveEffect>`	`getPrimitiveSegmentsInPrimitiveEffects()`	Returns the last list of `PrimitiveSegment` vibrations in `ShadowVibrator.PrimitiveEffect`.
`int`	`getRepeat()`	Returns the last vibration repeat times.
`VibrationAttributes`	`getVibrationAttributesFromLastVibration()`	Returns the `VibrationAttributes` from the last vibration.
`List<android.os.vibrator.VibrationEffectSegment>`	`getVibrationEffectSegments()`	Returns the last list of `VibrationEffectSegment`.
`boolean`	`isCancelled()`	Returns true if the Vibrator has been cancelled.
`boolean`	`isVibrating()`	Returns true if the Vibrator is currently vibrating as controlled by `Vibrator.vibrate(long)`
`static void`	`reset()`
`void`	`setHasAmplitudeControl(boolean hasAmplitudeControl)`	Controls the return value of `Vibrator.hasAmplitudeControl()` the default is false.
`void`	`setHasVibrator(boolean hasVibrator)`	Controls the return value of `Vibrator.hasVibrator()` the default is true.
`void`	`setSupportedPrimitives(Collection<Integer> primitives)`	Adds supported vibration primitives.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - pattern
```
protected static long[] pattern
```
  - vibrationEffectSegments
```
protected static final List<android.os.vibrator.VibrationEffectSegment> vibrationEffectSegments
```
  - primitiveEffects
```
protected static final List<ShadowVibrator.PrimitiveEffect> primitiveEffects
```
  - supportedPrimitives
```
protected static final List<Integer> supportedPrimitives
```
  - vibrationAttributesFromLastVibration
```
@Nullable
protected static VibrationAttributes vibrationAttributesFromLastVibration
```
  - audioAttributesFromLastVibration
```
@Nullable
protected static AudioAttributes audioAttributesFromLastVibration
```
- Constructor Detail
  - ShadowVibrator
```
public ShadowVibrator()
```
- Method Detail
  - setHasVibrator
```
public void setHasVibrator(boolean hasVibrator)
```
    Controls the return value of Vibrator.hasVibrator() the default is true.
  - setHasAmplitudeControl
```
public void setHasAmplitudeControl(boolean hasAmplitudeControl)
```
    Controls the return value of Vibrator.hasAmplitudeControl() the default is false.
  - isVibrating
```
@Implementation(minSdk=30)
public boolean isVibrating()
```
    Returns true if the Vibrator is currently vibrating as controlled by Vibrator.vibrate(long)
  - isCancelled
```
public boolean isCancelled()
```
    Returns true if the Vibrator has been cancelled.
  - getMilliseconds
```
public long getMilliseconds()
```
    Returns the last vibration duration in MS.
  - getPattern
```
public long[] getPattern()
```
    Returns the last vibration pattern.
  - getEffectId
```
public int getEffectId()
```
    Returns the last vibration effect ID of a VibrationEffect#Prebaked (e.g. VibrationEffect.EFFECT_CLICK).
    This field is non-zero only if a VibrationEffect#Prebaked was ever requested.
  - getRepeat
```
public int getRepeat()
```
    Returns the last vibration repeat times.
  - getVibrationEffectSegments
```
public List<android.os.vibrator.VibrationEffectSegment> getVibrationEffectSegments()
```
    Returns the last list of VibrationEffectSegment.
  - getPrimitiveSegmentsInPrimitiveEffects
```
public List<ShadowVibrator.PrimitiveEffect> getPrimitiveSegmentsInPrimitiveEffects()
```
    Returns the last list of PrimitiveSegment vibrations in ShadowVibrator.PrimitiveEffect.
  - getPrimitiveEffects
```
@Nullable
public List<ShadowVibrator.PrimitiveEffect> getPrimitiveEffects()
```
    Returns the last list of ShadowVibrator.PrimitiveEffect.
  - areAllPrimitivesSupported
```
@Implementation(minSdk=30)
protected boolean areAllPrimitivesSupported(int... primitiveIds)
```
  - setSupportedPrimitives
```
public void setSupportedPrimitives(Collection<Integer> primitives)
```
    Adds supported vibration primitives.
  - getVibrationAttributesFromLastVibration
```
@Nullable
public VibrationAttributes getVibrationAttributesFromLastVibration()
```
    Returns the VibrationAttributes from the last vibration.
  - getAudioAttributesFromLastVibration
```
@Nullable
public AudioAttributes getAudioAttributesFromLastVibration()
```
    Returns the AudioAttributes from the last vibration.
  - reset
```
@Resetter
public static void reset()
```

Class ShadowVibrator

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

pattern

vibrationEffectSegments

primitiveEffects

supportedPrimitives

vibrationAttributesFromLastVibration

audioAttributesFromLastVibration

Constructor Detail

ShadowVibrator

Method Detail

setHasVibrator

setHasAmplitudeControl

isVibrating

isCancelled

getMilliseconds

getPattern

getEffectId

getRepeat

getVibrationEffectSegments

getPrimitiveSegmentsInPrimitiveEffects

getPrimitiveEffects

areAllPrimitivesSupported

setSupportedPrimitives

getVibrationAttributesFromLastVibration

getAudioAttributesFromLastVibration

reset