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