Added in API level 30

VibrationAttributes


class VibrationAttributes : Parcelable
kotlin.Any
   ↳ android.os.VibrationAttributes

Encapsulates a collection of attributes describing information about a vibration.

Summary

Nested classes

Builder class for VibrationAttributes objects.

Constants
static Int

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

static Int

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

static Int

Usage value to use for alarm vibrations.

static Int

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

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

Mask for vibration usage class value.

static Int

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

static Int

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

static Int

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 value to use for vibrations which provide a feedback for hardware component interaction, such as a fingerprint sensor.

static 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.

static Int

Usage value to use for notification vibrations.

static Int

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

static Int

Usage value to use for ringtone vibrations.

static Int

Usage value to use for touch vibrations.

static Int

Usage value to use when usage is unknown.

Inherited constants
Public methods
static VibrationAttributes

Creates a new VibrationAttributes instance with given usage.

Int

Boolean
equals(other: Any?)

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

Int

Return the flags.

Int

Return the vibration usage.

Int

Return the vibration usage class.

Int

Boolean
isFlagSet(flag: Int)

Check whether a flag is set

String

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<VibrationAttributes!>

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_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

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, android.os.VibrationAttributes.FLAG_PIPELINED_EFFECT, and android.os.VibrationAttributes.FLAG_BYPASS_USER_VIBRATION_INTENSITY_SCALE

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, android.os.VibrationAttributes.FLAG_PIPELINED_EFFECT, and android.os.VibrationAttributes.FLAG_BYPASS_USER_VIBRATION_INTENSITY_SCALE
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!>