Added in API level 31

Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

CombinedVibration

---

Kotlin |Java

public abstract class CombinedVibration
extends Object implements Parcelable

java.lang.Object
↳	android.os.CombinedVibration

---

A CombinedVibration describes a combination of haptic effects to be performed by one or more Vibrators. These effects may be any number of things, from single shot vibrations to complex waveforms.

See also:

• VibrationEffect

Summary

Nested classes
class	CombinedVibration.ParallelCombination A combination of haptic effects that should be played in multiple vibrators in parallel.

Inherited constants

From interface android.os.Parcelable int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)".

Fields
public static final Creator<CombinedVibration>	CREATOR

Public methods
static CombinedVibration	createParallel(VibrationEffect effect) Create a vibration that plays a single effect in parallel on all available vibrators.
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
static CombinedVibration.ParallelCombination	startParallel() Start creating a vibration that plays explicit effects in parallel on specific target vibrators.

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 timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 31

public static final Creator<CombinedVibration> CREATOR

Public methods

createParallel

Added in API level 31

public static CombinedVibration createParallel (VibrationEffect effect)

Create a vibration that plays a single effect in parallel on all available vibrators.

This creates a parallel vibration that plays the given VibrationEffect across all available vibrators on the device at the same time.

Parameters
effect	VibrationEffect: The VibrationEffect to perform. This value cannot be null.

Returns
CombinedVibration	The combined vibration representing the effect to be played in parallel on all vibrators. This value cannot be null.

describeContents

Added in API level 31

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(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. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

startParallel

Added in API level 31

public static CombinedVibration.ParallelCombination startParallel ()

Start creating a vibration that plays explicit effects in parallel on specific target vibrators.

A parallel combination takes one or more VibrationEffects mapped to explicit vibrator IDs to be performed simultaneously.

Returns
CombinedVibration.ParallelCombination	This value cannot be null.

See also:

• CombinedVibration.ParallelCombination