VibrationAttributes

FLAG_BYPASS_INTERRUPTION_POLICY

public static final int FLAG_BYPASS_INTERRUPTION_POLICY

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.

Constant Value: 1 (0x00000001)

USAGE_ACCESSIBILITY

public static final int USAGE_ACCESSIBILITY

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

Constant Value: 66 (0x00000042)

USAGE_ALARM

public static final int USAGE_ALARM

Usage value to use for alarm vibrations.

Constant Value: 17 (0x00000011)

USAGE_CLASS_ALARM

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

Constant Value: 1 (0x00000001)

USAGE_CLASS_FEEDBACK

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

Constant Value: 2 (0x00000002)

USAGE_CLASS_MASK

public static final int USAGE_CLASS_MASK

Mask for vibration usage class value.

Constant Value: 15 (0x0000000f)

USAGE_CLASS_MEDIA

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

Constant Value: 3 (0x00000003)

USAGE_CLASS_UNKNOWN

public static final int USAGE_CLASS_UNKNOWN

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

Constant Value: 0 (0x00000000)

USAGE_COMMUNICATION_REQUEST

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

Constant Value: 65 (0x00000041)

USAGE_GESTURE_INPUT

public static final int USAGE_GESTURE_INPUT

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 ERROR(/InputDevice). Note that the gesture input may involve interacting with an ERROR(/InputDevice), but the input itself is a user gesture that is not a direct application of the ERROR(/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 ERROR(/InputDevice). Another example is a pinch gesture on a touchscreen.

Constant Value: 98 (0x00000062)

USAGE_HARDWARE_FEEDBACK

public static final int USAGE_HARDWARE_FEEDBACK

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

Constant Value: 50 (0x00000032)

USAGE_MEDIA

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

Constant Value: 19 (0x00000013)

USAGE_NOTIFICATION

public static final int USAGE_NOTIFICATION

Usage value to use for notification vibrations.

Constant Value: 49 (0x00000031)

USAGE_PHYSICAL_EMULATION

public static final int USAGE_PHYSICAL_EMULATION

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.

Constant Value: 34 (0x00000022)

USAGE_RINGTONE

public static final int USAGE_RINGTONE

Usage value to use for ringtone vibrations.

Constant Value: 33 (0x00000021)

USAGE_TOUCH

public static final int USAGE_TOUCH

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.

Constant Value: 18 (0x00000012)

USAGE_UNKNOWN

public static final int USAGE_UNKNOWN

Usage value to use when usage is unknown.

Constant Value: 0 (0x00000000)

CREATOR

public static final Creator<VibrationAttributes> CREATOR

createForUsage

public static VibrationAttributes createForUsage (int usage)

Creates a new VibrationAttributes instance with given usage.

describeContents

public int describeContents ()

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

public boolean equals (Object o)

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

public int getFlags ()

Return the flags.

getUsage

public int getUsage ()

Return the vibration usage.

getUsageClass

public int getUsageClass ()

Return the vibration usage class.

hashCode

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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

public boolean isFlagSet (int flag)

Check whether a flag is set

toString

public String toString ()

Returns a string representation of the object.

writeToParcel

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.