Package org.robolectric.shadows

Class ShadowVibrator

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 AudioAttributes	audioAttributesFromLastVibration
protected long[]	pattern
protected List<ShadowVibrator.PrimitiveEffect>	primitiveEffects
protected List<Integer>	supportedPrimitives
protected VibrationAttributes	vibrationAttributesFromLastVibration
protected List<android.os.vibrator.VibrationEffectSegment>	vibrationEffectSegments

Constructor Summary

Constructors

Constructor	Description
ShadowVibrator()

Method Summary

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.
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)
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 Details

pattern

protected long[] pattern

vibrationEffectSegments

protected final List<android.os.vibrator.VibrationEffectSegment> vibrationEffectSegments

primitiveEffects

protected final List<ShadowVibrator.PrimitiveEffect> primitiveEffects

supportedPrimitives

protected final List<Integer> supportedPrimitives

vibrationAttributesFromLastVibration

@Nullable protected VibrationAttributes vibrationAttributesFromLastVibration

audioAttributesFromLastVibration

@Nullable protected AudioAttributes audioAttributesFromLastVibration

Constructor Details

ShadowVibrator

public ShadowVibrator()

Method Details

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.

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.