Builder
class Builder
kotlin.Any | |
↳ | 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(vib: VibrationAttributes?) Constructs a new Builder from a given VibrationAttributes. |
|
Builder(audio: AudioAttributes) Constructs a new Builder from AudioAttributes. |
Public methods | |
---|---|
VibrationAttributes |
build() Combines all of the attributes that have been set and returns a new |
VibrationAttributes.Builder |
Sets only the flags specified in the bitmask, leaving the other supported flag values unchanged in the builder. |
VibrationAttributes.Builder |
Sets the attribute describing the type of the corresponding vibration. |
Public constructors
Builder
Builder(vib: VibrationAttributes?)
Constructs a new Builder from a given VibrationAttributes.
Parameters | |
---|---|
vib |
VibrationAttributes?: This value may be null . |
Builder
Builder(audio: AudioAttributes)
Constructs a new Builder from AudioAttributes.
Parameters | |
---|---|
audio |
AudioAttributes: This value cannot be null . |
Public methods
build
fun build(): VibrationAttributes
Combines all of the attributes that have been set and returns a new VibrationAttributes
object.
Return | |
---|---|
VibrationAttributes |
a new VibrationAttributes object This value cannot be null . |
setFlags
fun setFlags(
flags: Int,
mask: Int
): VibrationAttributes.Builder
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 android.os.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. |
Return | |
---|---|
VibrationAttributes.Builder |
the same Builder instance. This value cannot be null . |
setUsage
fun setUsage(usage: Int): VibrationAttributes.Builder
Sets the attribute describing the type of the corresponding vibration.
Return | |
---|---|
VibrationAttributes.Builder |
the same Builder instance. This value cannot be null . |