Language

VibrationEffect.Builder.Build Method

Definition

Builds the composed VibrationEffect.

[Android.Runtime.Register("build", "()Landroid/os/VibrationEffect;", "", ApiSince=37)]
public Android.OS.VibrationEffect Build();
[<Android.Runtime.Register("build", "()Landroid/os/VibrationEffect;", "", ApiSince=37)>]
member this.Build : unit -> Android.OS.VibrationEffect

Returns

The resulting VibrationEffect. This value cannot be null.

Attributes

Remarks

Builds the composed VibrationEffect.

This method finalizes the composition of all added elements (Envelopes, Presets, Events) and returns a single VibrationEffect that can be played by the vibrator.

The Builder object is still valid after this call, so you can continue adding more elements to it and generate more VibrationEffects by calling this method again.

More haptic elements can be added after Build() only if SetRepeatingEffect(Int64, VibrationEffect, Int64) has not been called. Building the effect does not remove this restriction.

Automatic fallback will be supported for the built VibrationEffect. If the device does not support some of the composed haptic elements, they will be automatically mapped to fallback effects at runtime (except for elements that explicitly do not support fallback, such as envelopes from WaveformEnvelopeBuilder).

Android reference for android.os.VibrationEffect.Builder.build.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to