CombinedVibration.ParallelCombination

Kotlin |Java

public static final class CombinedVibration.ParallelCombination
extends Object

java.lang.Object
↳	android.os.CombinedVibration.ParallelCombination

A combination of haptic effects that should be played in multiple vibrators in parallel.

See also:

CombinedVibration.startParallel()

Summary

Public methods
`CombinedVibration.ParallelCombination`	`addVibrator(int vibratorId, VibrationEffect effect)` Add or replace a one shot vibration effect to be performed by the specified vibrator.
`CombinedVibration`	`combine()` Combine all of the added effects into a `CombinedVibration`.

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.

Public methods

addVibrator

Added in API level 31

public CombinedVibration.ParallelCombination addVibrator (int vibratorId, 
                VibrationEffect effect)

Add or replace a one shot vibration effect to be performed by the specified vibrator.

Parameters
`vibratorId`	`int`: The id of the vibrator that should perform this effect.
`effect`	`VibrationEffect`: The effect this vibrator should play. This value cannot be `null`.

Returns
`CombinedVibration.ParallelCombination`	The `ParallelCombination` object to enable adding multiple effects in one chain. This value cannot be `null`.

See also:

VibrationEffect.createOneShot(long,int)

combine

Added in API level 31

public CombinedVibration combine ()

Combine all of the added effects into a CombinedVibration.

If ERROR(Flags.compositionApi()/android.os.vibrator.Flags#compositionApi() Flags.compositionApi()) is enabled, all effects added to this combination must be consistent regarding timeline anchoring: they must either all be timeline anchored (see ERROR(VibrationEffect.isTimelineAnchored()/android.os.VibrationEffect#isTimelineAnchored() VibrationEffect.isTimelineAnchored())) or none of them should be.

The ParallelCombination object is still valid after this call, so you can continue adding more effects to it and generating more CombinedVibrations by calling this method again.

Returns
`CombinedVibration`	The `CombinedVibration` resulting from combining the added effects to be played in parallel. This value cannot be `null`.

Throws
`IllegalStateException`	if the combination is empty or if it contains a mix of timeline anchored and non-timeline anchored effects.