VibrationEffect

DEFAULT_AMPLITUDE

static val DEFAULT_AMPLITUDE: Int

The default vibration strength of the device.

Value: -1

EFFECT_CLICK

static val EFFECT_CLICK: Int

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

Value: 0

EFFECT_DOUBLE_CLICK

static val EFFECT_DOUBLE_CLICK: Int

A double click effect.

Value: 1

EFFECT_HEAVY_CLICK

static val EFFECT_HEAVY_CLICK: Int

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

Value: 5

EFFECT_TICK

static val EFFECT_TICK: Int

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

Value: 2

createOneShot

open static fun createOneShot(
    milliseconds: Long, 
    amplitude: Int
): VibrationEffect!

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

open static fun createPredefined(effectId: Int): VibrationEffect

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.

createWaveform

open static fun createWaveform(
    timings: LongArray!, 
    repeat: Int
): VibrationEffect!

Create a waveform vibration. Waveform vibrations are a potentially repeating series of timing and amplitude pairs. 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. An amplitude of 0 implies no vibration (i.e. off), and any pairs with a timing value of 0 will be ignored.

The amplitude array of the generated waveform will be the same size as the given timing array with alternating values of 0 (i.e. off) and DEFAULT_AMPLITUDE, starting with 0. Therefore the first timing value will be the period to wait before turning the vibrator on, the second value will be how long to vibrate at DEFAULT_AMPLITUDE strength, etc.

To cause the pattern to repeat, pass the index into the timings array at which to start the repetition, or -1 to disable repeating.

createWaveform

open static fun createWaveform(
    timings: LongArray!, 
    amplitudes: IntArray!, 
    repeat: Int
): VibrationEffect!

Create a waveform vibration. Waveform vibrations are a potentially repeating series of timing and amplitude pairs. 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. An amplitude of 0 implies no vibration (i.e. off), and any pairs with a timing value of 0 will be ignored.

To cause the pattern to repeat, pass the index into the timings array at which to start the repetition, or -1 to disable repeating.

describeContents

open fun describeContents(): Int

CREATOR

static val CREATOR: Parcelable.Creator<VibrationEffect!>