VibrationAttributes.Builder


public static final class VibrationAttributes.Builder
extends Object

java.lang.Object
   ↳ android.os.VibrationAttributes.Builder


Builder class for VibrationAttributes objects. By default, all information is set to UNKNOWN.

Summary

Public constructors

Builder()

Constructs a new Builder with the defaults.

Builder(VibrationAttributes vib)

Constructs a new Builder from a given VibrationAttributes.

Builder(AudioAttributes audio)

Constructs a new Builder from AudioAttributes.

Public methods

VibrationAttributes build()

Combines all of the attributes that have been set and returns a new VibrationAttributes object.

VibrationAttributes.Builder setFlags(int flags, int mask)

Sets only the flags specified in the bitmask, leaving the other supported flag values unchanged in the builder.

VibrationAttributes.Builder setUsage(int usage)

Sets the attribute describing the type of the corresponding vibration.

Inherited methods

Public constructors

Builder

Added in API level 30
public Builder ()

Constructs a new Builder with the defaults.

Builder

Added in API level 30
public Builder (VibrationAttributes vib)

Constructs a new Builder from a given VibrationAttributes.

Parameters
vib VibrationAttributes: This value may be null.

Builder

Added in API level 33
public Builder (AudioAttributes audio)

Constructs a new Builder from AudioAttributes.

Parameters
audio AudioAttributes: This value cannot be null.

Public methods

build

Added in API level 30
public VibrationAttributes build ()

Combines all of the attributes that have been set and returns a new VibrationAttributes object.

Returns
VibrationAttributes a new VibrationAttributes object This value cannot be null.

setFlags

Added in API level 30
public VibrationAttributes.Builder setFlags (int flags, 
                int mask)

Sets only the flags specified in the bitmask, leaving the other supported flag values unchanged in the builder.

Parameters
flags int: Combination of flags to be set. Value is either 0 or a combination of VibrationAttributes.FLAG_BYPASS_INTERRUPTION_POLICY, android.os.VibrationAttributes.FLAG_BYPASS_USER_VIBRATION_INTENSITY_OFF, android.os.VibrationAttributes.FLAG_INVALIDATE_SETTINGS_CACHE, android.os.VibrationAttributes.FLAG_PIPELINED_EFFECT, and android.os.VibrationAttributes.FLAG_BYPASS_USER_VIBRATION_INTENSITY_SCALE

mask int: Bit range that should be changed.

Returns
VibrationAttributes.Builder the same Builder instance. This value cannot be null.