Added in API level 10000

Summary: Nested Classes | Methods | Inherited Methods

VibrationEffect.Envelope

---

Kotlin |Java

public static final class VibrationEffect.Envelope
extends Object

java.lang.Object
↳	android.os.VibrationEffect.Envelope

---

Represents a haptic effect defined by an envelope, to be used within a VibrationEffect.Builder.

This class encapsulates Piecewise Linear Envelope (PWLE) effects, which can be created using either the WaveformEnvelopeBuilder for direct amplitude and frequency control, or the BasicEnvelopeBuilder for a more perception-based approach using intensity and sharpness.

Envelopes are fundamental building blocks in the composition API, allowing for expressive and complex haptic effects by sequencing them with other elements like Presets.

Summary

Nested classes
class	VibrationEffect.Envelope.BeatingEnvelopeBuilder A builder to help users create rich and expressive beating vibrations, taking beats per second, vibration sharpness, and an amplitude scale envelope as input.

Public methods
static VibrationEffect.Envelope	create(VibrationEffect.WaveformEnvelopeBuilder builder) Creates a new haptic Envelope from the provided WaveformEnvelopeBuilder.
static VibrationEffect.Envelope	create(VibrationEffect.BasicEnvelopeBuilder builder) Creates a new haptic Envelope from the provided BasicEnvelopeBuilder.

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

create

Added in API level 10000

public static VibrationEffect.Envelope create (VibrationEffect.WaveformEnvelopeBuilder builder)

Creates a new haptic Envelope from the provided WaveformEnvelopeBuilder.

Note: Envelopes created from WaveformEnvelopeBuilder do not support haptics fallback.

Parameters
builder	VibrationEffect.WaveformEnvelopeBuilder: The builder used to define the envelope's waveform. This value cannot be null.

Returns
VibrationEffect.Envelope	The created Envelope. This value cannot be null.

create

Added in API level 10000

public static VibrationEffect.Envelope create (VibrationEffect.BasicEnvelopeBuilder builder)

Creates a new haptic Envelope from the provided BasicEnvelopeBuilder.

Parameters
builder	VibrationEffect.BasicEnvelopeBuilder: The builder used to define the envelope's basic parameters. This value cannot be null.

Returns
VibrationEffect.Envelope	The created Envelope. This value cannot be null.