VibrationAttributes

FLAG_BYPASS_INTERRUPTION_POLICY

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

static val USAGE_ACCESSIBILITY: Int

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

Value: 66

USAGE_ALARM

static val USAGE_ALARM: Int

Usage value to use for alarm vibrations.

Value: 17

USAGE_CLASS_ALARM

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

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

static val USAGE_CLASS_MASK: Int

Mask for vibration usage class value.

Value: 15

USAGE_CLASS_MEDIA

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

static val USAGE_CLASS_UNKNOWN: Int

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

Value: 0

USAGE_COMMUNICATION_REQUEST

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

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

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

static val USAGE_NOTIFICATION: Int

Usage value to use for notification vibrations.

Value: 49

USAGE_PHYSICAL_EMULATION

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

static val USAGE_RINGTONE: Int

Usage value to use for ringtone vibrations.

Value: 33

USAGE_TOUCH

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

static val USAGE_UNKNOWN: Int

Usage value to use when usage is unknown.

Value: 0

createForUsage

static fun createForUsage(usage: Int): VibrationAttributes

Creates a new VibrationAttributes instance with given usage.

describeContents

fun describeContents(): Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

equals

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.

getFlags

fun getFlags(): Int

Return the flags.

getUsage

fun getUsage(): Int

Return the vibration usage.

getUsageClass

fun getUsageClass(): Int

Return the vibration usage class.

hashCode

fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

isFlagSet

fun isFlagSet(flag: Int): Boolean

Check whether a flag is set

toString

fun toString(): String

Returns a string representation of the object.

writeToParcel

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

Flatten this object in to a Parcel.

CREATOR

static val CREATOR: Parcelable.Creator<VibrationAttributes!>