Android O Developer Preview

VibrationEffect

public abstract class VibrationEffect
extends Object implements Parcelable

java.lang.Object
↳	android.os.VibrationEffect

A VibrationEffect describes a haptic effect to be performed by a Vibrator. These effects may be any number of things, from single shot vibrations to complex waveforms.

Summary

Constants
`int`	`DEFAULT_AMPLITUDE` The default vibration strength of the device.

Inherited constants

From interface


    android.os.Parcelable

Fields
`public static final Creator<VibrationEffect>`	`CREATOR`

Public methods
`static VibrationEffect`	`createOneShot(long milliseconds, int amplitude)` Create a one shot vibration.
`static VibrationEffect`	`createWaveform(long[] timings, int[] amplitudes, int repeat)` Create a waveform vibration.
`static VibrationEffect`	`createWaveform(long[] timings, int repeat)` Create a waveform vibration.
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

Inherited methods

From class


  
    java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

From interface


  
    android.os.Parcelable

Constants

DEFAULT_AMPLITUDE

Android O Developer Preview

int DEFAULT_AMPLITUDE

The default vibration strength of the device.

Constant Value: -1 (0xffffffff)

Fields

CREATOR

Android O Developer Preview

Creator<VibrationEffect> CREATOR

Public methods

createOneShot

Android O Developer Preview

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.

Parameters
`milliseconds`	`long`: The number of milliseconds to vibrate. This must be a positive number.
`amplitude`	`int`: The strength of the vibration. This must be a value between 1 and 255, or `DEFAULT_AMPLITUDE`.

Returns
`VibrationEffect`	The desired effect.

createWaveform

Android O Developer Preview

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

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.

Parameters
`timings`	`long`: The timing values of the timing / amplitude pairs. Timing values of 0 will cause the pair to be ignored.
`amplitudes`	`int`: The amplitude values of the timing / amplitude pairs. Amplitude values must be between 0 and 255, or equal to `DEFAULT_AMPLITUDE`. An amplitude value of 0 implies the motor is off.
`repeat`	`int`: The index into the timings array at which to repeat, or -1 if you you don't want to repeat.

Returns
`VibrationEffect`	The desired effect.

createWaveform

Android O Developer Preview

VibrationEffect createWaveform (long[] timings, 
                int repeat)

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.

Parameters
`timings`	`long`: The pattern of alternating on-off timings, starting with off. Timing values of 0 will cause the timing / amplitude pair to be ignored.
`repeat`	`int`: The index into the timings array at which to repeat, or -1 if you you don't want to repeat.

Returns
`VibrationEffect`	The desired effect.

describeContents

Android O Developer Preview

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(Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

Jun	JUL	Aug
	08
2016	2017	2018

Most visited

Recently visited

Results for

VibrationEffect

Summary

Constants

Inherited constants

Fields

Public methods

Inherited methods

Constants

DEFAULT_AMPLITUDE

Fields

CREATOR

Public methods

createOneShot

createWaveform

createWaveform

describeContents

Interfaces

Classes

Enums

Exceptions