ParallelCombination

Kotlin |Java

class ParallelCombination

kotlin.Any
↳	android.os.CombinedVibration.ParallelCombination

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

Summary

Public methods
CombinedVibration.ParallelCombination	`addVibrator(vibratorId: Int, effect: VibrationEffect)` 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`.

Public methods

addVibrator

Added in API level 31

fun addVibrator(
    vibratorId: Int, 
    effect: VibrationEffect
): CombinedVibration.ParallelCombination

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`.

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

See Also

android.os.VibrationEffect#createOneShot(long,int)

combine

Added in API level 31

fun combine(): CombinedVibration

Combine all of the added effects into a CombinedVibration.

If Flags.compositionApi() is enabled, all effects added to this combination must be consistent regarding timeline anchoring: they must either all be timeline anchored (see android.os.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.

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

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