VibrationEffect

DEFAULT_AMPLITUDE

public static final int DEFAULT_AMPLITUDE

The default vibration strength of the device.

Constant Value: -1 (0xffffffff)

EFFECT_CLICK

public static final int EFFECT_CLICK

A click effect. Use this effect as a baseline, as it's the most common type of click effect.

Constant Value: 0 (0x00000000)

EFFECT_DOUBLE_CLICK

public static final int EFFECT_DOUBLE_CLICK

A double click effect.

Constant Value: 1 (0x00000001)

EFFECT_HEAVY_CLICK

public static final int EFFECT_HEAVY_CLICK

A heavy click effect. This effect is stronger than EFFECT_CLICK.

Constant Value: 5 (0x00000005)

EFFECT_TICK

public static final int EFFECT_TICK

A tick effect. This effect is less strong compared to EFFECT_CLICK.

Constant Value: 2 (0x00000002)

CREATOR

public static final Creator<VibrationEffect> CREATOR

createOneShot

public static VibrationEffect createOneShot (long milliseconds, 
                int amplitude)

Create a one shot vibration.

One shot vibrations will vibrate constantly for the specified period of time at the specified amplitude, and then stop.

createPredefined

public static VibrationEffect createPredefined (int effectId)

Create a predefined vibration effect.

Predefined effects are a set of common vibration effects that should be identical, regardless of the app they come from, in order to provide a cohesive experience for users across the entire device. They also may be custom tailored to the device hardware in order to provide a better experience than you could otherwise build using the generic building blocks.

This will fallback to a generic pattern if one exists and there does not exist a hardware-specific implementation of the effect.

createRepeatingEffect

public static VibrationEffect createRepeatingEffect (VibrationEffect preamble, 
                VibrationEffect repeatingEffect)

Creates a new VibrationEffect by merging the preamble and repeating vibration effect.

Neither input vibration may already be repeating. An IllegalArgumentException will be thrown if either input vibration is set to repeat indefinitely.

createRepeatingEffect

public static VibrationEffect createRepeatingEffect (VibrationEffect effect)

Creates a new VibrationEffect that repeats the given effect indefinitely.

The input vibration must not be a repeating vibration. If it is, an IllegalArgumentException will be thrown.

createWaveform

public static VibrationEffect createWaveform (long[] timings, 
                int[] amplitudes, 
                int repeat)

Create a waveform vibration.

Waveform vibrations are a potentially repeating series of timing and amplitude pairs, provided in separate arrays. For each pair, the value in the amplitude array determines the strength of the vibration and the value in the timing array determines how long it vibrates for, in milliseconds.

To cause the pattern to repeat, pass the index into the timings array at which to start the repetition, or -1 to disable repeating. Repeating effects will be played indefinitely and should be cancelled via Vibrator.cancel().

createWaveform

public static VibrationEffect createWaveform (long[] timings, 
                int repeat)

Create a waveform vibration, using only off/on transitions at the provided time intervals, and potentially repeating.

In effect, the timings array represents the number of milliseconds before turning the vibrator on, followed by the number of milliseconds to keep the vibrator on, then the number of milliseconds turned off, and so on. Consequently, the first timing value will often be 0, so that the effect will start vibrating immediately.

This method is equivalent to calling createWaveform(long[], int[], int) with corresponding amplitude values alternating between 0 and DEFAULT_AMPLITUDE, beginning with 0.

To cause the pattern to repeat, pass the index into the timings array at which to start the repetition, or -1 to disable repeating. Repeating effects will be played indefinitely and should be cancelled via Vibrator.cancel().

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.

startComposition

public static VibrationEffect.Composition startComposition ()

Start composing a haptic effect.