Added in API level 30

VibrationAttributes

---

Kotlin |Java

class VibrationAttributes : Parcelable

kotlin.Any
↳	android.os.VibrationAttributes

Encapsulates a collection of attributes describing information about a vibration.

Summary

Nested classes
	Builder Builder class for VibrationAttributes objects.

Constants
static Int	FLAG_BYPASS_INTERRUPTION_POLICY Flag requesting vibration effect to be played even under limited interruptions.
static Int	USAGE_ACCESSIBILITY Usage value to use for accessibility vibrations, such as with a screen reader.
static Int	USAGE_ALARM Usage value to use for alarm vibrations.
static Int	USAGE_CLASS_ALARM Vibration usage class value to use when the vibration is initiated to catch user's attention, such as alarm, ringtone, and notification vibrations.
static Int	USAGE_CLASS_FEEDBACK Vibration usage class value to use when the vibration is initiated as a response to user's actions, such as emulation of physical effects, and texting feedback vibration.
static Int	USAGE_CLASS_MASK Mask for vibration usage class value.
static Int	USAGE_CLASS_MEDIA Vibration usage class value to use when the vibration is part of media, such as music, movie, soundtrack, game or animations.
static Int	USAGE_CLASS_UNKNOWN Vibration usage class value to use when the vibration usage class is unknown.
static Int	USAGE_COMMUNICATION_REQUEST Usage value to use for vibrations which mean a request to enter/end a communication with the user, such as a voice prompt.
static Int	USAGE_GESTURE_INPUT Usage value to use for vibrations performed as feedback for a user's gesture input.
static Int	USAGE_HARDWARE_FEEDBACK Usage value to use for vibrations which provide a feedback for hardware component interaction, such as a fingerprint sensor.
static Int	USAGE_MEDIA Usage value to use for media vibrations, such as music, movie, soundtrack, animations, games, or any interactive media that isn't for touch feedback specifically.
static Int	USAGE_NOTIFICATION Usage value to use for notification vibrations.
static Int	USAGE_PHYSICAL_EMULATION Usage value to use for vibrations which emulate physical hardware reactions, such as edge squeeze.
static Int	USAGE_RINGTONE Usage value to use for ringtone vibrations.
static Int	USAGE_TOUCH Usage value to use for touch vibrations.
static Int	USAGE_UNKNOWN Usage value to use when usage is unknown.

Inherited constants

From class Parcelable Int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. Int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
static VibrationAttributes	createForUsage(usage: Int) Creates a new VibrationAttributes instance with given usage.
Int	describeContents()
Boolean	equals(other: Any?) Indicates whether some other object is "equal to" this one.
Int	getFlags() Return the flags.
Int	getUsage() Return the vibration usage.
Int	getUsageClass() Return the vibration usage class.
Int	hashCode()
Boolean	isFlagSet(flag: Int) Check whether a flag is set
String	toString()
Unit	writeToParcel(dest: Parcel, flags: Int) Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<VibrationAttributes!>	CREATOR

Constants

FLAG_BYPASS_INTERRUPTION_POLICY

Added in API level 30

static val FLAG_BYPASS_INTERRUPTION_POLICY: Int

Flag requesting vibration effect to be played even under limited interruptions.

Only privileged apps can ignore user settings that limit interruptions, and this flag will be ignored otherwise.

Value: 1

USAGE_ACCESSIBILITY

Added in API level 33

static val USAGE_ACCESSIBILITY: Int

Usage value to use for accessibility vibrations, such as with a screen reader.

Value: 66

USAGE_ALARM

Added in API level 30

static val USAGE_ALARM: Int

Usage value to use for alarm vibrations.

Value: 17

USAGE_CLASS_ALARM

Added in API level 30

static val USAGE_CLASS_ALARM: Int

Vibration usage class value to use when the vibration is initiated to catch user's attention, such as alarm, ringtone, and notification vibrations.

Value: 1

USAGE_CLASS_FEEDBACK

Added in API level 30

static val USAGE_CLASS_FEEDBACK: Int

Vibration usage class value to use when the vibration is initiated as a response to user's actions, such as emulation of physical effects, and texting feedback vibration.

Value: 2

USAGE_CLASS_MASK

Added in API level 30

static val USAGE_CLASS_MASK: Int

Mask for vibration usage class value.

Value: 15

USAGE_CLASS_MEDIA

Added in API level 33

static val USAGE_CLASS_MEDIA: Int

Vibration usage class value to use when the vibration is part of media, such as music, movie, soundtrack, game or animations.

Value: 3

USAGE_CLASS_UNKNOWN

Added in API level 30

static val USAGE_CLASS_UNKNOWN: Int

Vibration usage class value to use when the vibration usage class is unknown.

Value: 0

USAGE_COMMUNICATION_REQUEST

Added in API level 30

static val USAGE_COMMUNICATION_REQUEST: Int

Usage value to use for vibrations which mean a request to enter/end a communication with the user, such as a voice prompt.

Value: 65

USAGE_GESTURE_INPUT

Added in API level 36.1

static val USAGE_GESTURE_INPUT: Int

Usage value to use for vibrations performed as feedback for a user's gesture input.

A gesture input is broadly defined as a user input that falls outside the direct usage of a physical InputDevice. Note that the gesture input may involve interacting with an InputDevice, but the input itself is a user gesture that is not a direct application of the InputDevice.

The exact definition of a gesture input varies across form-factors and input modalities. For example, on Wearable devices, it could be a hand-based gesture provided by the user without touching any physical InputDevice. Another example is a pinch gesture on a touchscreen.

Value: 98

USAGE_HARDWARE_FEEDBACK

Added in API level 30

static val USAGE_HARDWARE_FEEDBACK: Int

Usage value to use for vibrations which provide a feedback for hardware component interaction, such as a fingerprint sensor.

Value: 50

USAGE_MEDIA

Added in API level 33

static val USAGE_MEDIA: Int

Usage value to use for media vibrations, such as music, movie, soundtrack, animations, games, or any interactive media that isn't for touch feedback specifically.

Value: 19

USAGE_NOTIFICATION

Added in API level 30

static val USAGE_NOTIFICATION: Int

Usage value to use for notification vibrations.

Value: 49

USAGE_PHYSICAL_EMULATION

Added in API level 30

static val USAGE_PHYSICAL_EMULATION: Int

Usage value to use for vibrations which emulate physical hardware reactions, such as edge squeeze.

Note that normal screen-touch feedback "click" effects would typically be classed as USAGE_TOUCH, and that on-screen "physical" animations like bouncing would be USAGE_MEDIA.

Value: 34

USAGE_RINGTONE

Added in API level 30

static val USAGE_RINGTONE: Int

Usage value to use for ringtone vibrations.

Value: 33

USAGE_TOUCH

Added in API level 30

static val USAGE_TOUCH: Int

Usage value to use for touch vibrations.

Most typical haptic feedback should be classed as touch feedback. Examples include vibrations for tap, long press, drag and scroll.

Value: 18

USAGE_UNKNOWN

Added in API level 30

static val USAGE_UNKNOWN: Int

Usage value to use when usage is unknown.

Value: 0

Public methods

createForUsage

Added in API level 33

static fun createForUsage(usage: Int): VibrationAttributes

Creates a new VibrationAttributes instance with given usage.

Parameters

usage

Int: Value is android.os.VibrationAttributes#USAGE_UNKNOWN, android.os.VibrationAttributes#USAGE_ACCESSIBILITY, android.os.VibrationAttributes#USAGE_ALARM, android.os.VibrationAttributes#USAGE_COMMUNICATION_REQUEST, android.os.VibrationAttributes#USAGE_HARDWARE_FEEDBACK, android.os.VibrationAttributes#USAGE_MEDIA, android.os.VibrationAttributes#USAGE_NOTIFICATION, android.os.VibrationAttributes#USAGE_PHYSICAL_EMULATION, android.os.VibrationAttributes#USAGE_RINGTONE, android.os.VibrationAttributes#USAGE_TOUCH, android.os.VibrationAttributes.USAGE_IME_FEEDBACK, or android.os.VibrationAttributes#USAGE_GESTURE_INPUT

Return
VibrationAttributes	This value cannot be null.

describeContents

Added in API level 30

fun describeContents(): Int

Return
Int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 30

fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj	the reference object with which to compare.
o	This value may be null.

Return
Boolean	true if this object is the same as the obj argument; false otherwise.

getFlags

Added in API level 30

fun getFlags(): Int

Return the flags.

Return
Int	a combined mask of all flags Value is either 0 or a combination of android.os.VibrationAttributes#FLAG_BYPASS_INTERRUPTION_POLICY, android.os.VibrationAttributes.FLAG_BYPASS_USER_VIBRATION_INTENSITY_OFF, android.os.VibrationAttributes.FLAG_INVALIDATE_SETTINGS_CACHE, and android.os.VibrationAttributes.FLAG_PIPELINED_EFFECT

getUsage

Added in API level 30

fun getUsage(): Int

Return the vibration usage.

Return

Int

Value is android.os.VibrationAttributes#USAGE_UNKNOWN, android.os.VibrationAttributes#USAGE_ACCESSIBILITY, android.os.VibrationAttributes#USAGE_ALARM, android.os.VibrationAttributes#USAGE_COMMUNICATION_REQUEST, android.os.VibrationAttributes#USAGE_HARDWARE_FEEDBACK, android.os.VibrationAttributes#USAGE_MEDIA, android.os.VibrationAttributes#USAGE_NOTIFICATION, android.os.VibrationAttributes#USAGE_PHYSICAL_EMULATION, android.os.VibrationAttributes#USAGE_RINGTONE, android.os.VibrationAttributes#USAGE_TOUCH, android.os.VibrationAttributes.USAGE_IME_FEEDBACK, or android.os.VibrationAttributes#USAGE_GESTURE_INPUT

getUsageClass

Added in API level 30

fun getUsageClass(): Int

Return the vibration usage class.

Return
Int	Value is android.os.VibrationAttributes#USAGE_CLASS_UNKNOWN, android.os.VibrationAttributes#USAGE_CLASS_ALARM, android.os.VibrationAttributes#USAGE_CLASS_FEEDBACK, or android.os.VibrationAttributes#USAGE_CLASS_MEDIA

hashCode

Added in API level 30

fun hashCode(): Int

Return
Int	a hash code value for this object.

isFlagSet

Added in API level 30

fun isFlagSet(flag: Int): Boolean

Check whether a flag is set

Parameters
flag	Int: Value is either 0 or a combination of android.os.VibrationAttributes#FLAG_BYPASS_INTERRUPTION_POLICY, android.os.VibrationAttributes.FLAG_BYPASS_USER_VIBRATION_INTENSITY_OFF, android.os.VibrationAttributes.FLAG_INVALIDATE_SETTINGS_CACHE, and android.os.VibrationAttributes.FLAG_PIPELINED_EFFECT

Return
Boolean	true if a flag is set and false otherwise

toString

Added in API level 30

fun toString(): String

Return
String	a string representation of the object.

writeToParcel

Added in API level 30

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
dest	Parcel: This value cannot be null.
flags	Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 30

static val CREATOR: Parcelable.Creator<VibrationAttributes!>