Summary: Inherited Constants | Fields | Methods | Inherited Methods

VibratorEnvelopeEffectInfo

Kotlin |Java

public final class VibratorEnvelopeEffectInfo
extends Object implements Parcelable

java.lang.Object
↳	android.os.vibrator.VibratorEnvelopeEffectInfo

Provides information about the vibrator hardware capabilities and limitations regarding waveform envelope effects. This includes:

Maximum number of control points supported.
Minimum and maximum duration for individual segments.
Maximum total duration for an envelope effect.

This information can be used to help construct waveform envelope effects with VibrationEffect.WaveformEnvelopeBuilder. When designing these effects, it is also recommended to check the VibratorFrequencyProfile for information about the supported frequency range and the vibrator's output response.

See also:

Summary

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

Fields
`public static final Creator<VibratorEnvelopeEffectInfo>`	`CREATOR`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`boolean`	`equals(Object o)` Indicates whether some other object is "equal to" this one.
`long`	`getMaxControlPointDurationMillis()` Retrieves the maximum duration supported between two control points within an envelope effect, in milliseconds.
`long`	`getMaxDurationMillis()` Retrieves the maximum duration supported for an envelope effect, in milliseconds.
`int`	`getMaxSize()` Retrieves the maximum number of control points supported for an envelope effect.
`long`	`getMinControlPointDurationMillis()` Retrieves the minimum duration supported between two control points within an envelope effect, in milliseconds.
`int`	`hashCode()` Returns a hash code value for the object.
`String`	`toString()` Returns a string representation of the object.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

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.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

CREATOR

Added in Android Baklava

public static final Creator<VibratorEnvelopeEffectInfo> CREATOR

Public methods

describeContents

Added in Android Baklava

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

equals

Added in Android Baklava

public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
`o`	`Object`: the reference object with which to compare.

Returns
`boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getMaxControlPointDurationMillis

Added in Android Baklava

public long getMaxControlPointDurationMillis ()

Retrieves the maximum duration supported between two control points within an envelope effect, in milliseconds.

If the device supports envelope effects (check ERROR(/android.os.VibratorInfo#areEnvelopeEffectsSupported)), this value will be positive. Devices with envelope effects capabilities guarantee support for durations up to at least 1 second. If the device does not support envelope effects, this method will return 0.

Returns
`long`	the maximum allowed duration between two control points in an envelope effect, or 0 if envelope effects are not supported.

getMaxDurationMillis

Added in Android Baklava

public long getMaxDurationMillis ()

Retrieves the maximum duration supported for an envelope effect, in milliseconds.

If the device supports envelope effects (check ERROR(/android.os.VibratorInfo#areEnvelopeEffectsSupported)), this value will be positive. Devices with envelope effects capabilities guarantees a maximum duration equivalent to the product of getMaxSize() and getMaxControlPointDurationMillis(). If the device does not support envelope effects, this method will return 0.

Returns
`long`	The maximum duration (in milliseconds) allowed for an envelope effect, or 0 if envelope effects are not supported.

getMaxSize

Added in Android Baklava

public int getMaxSize ()

Retrieves the maximum number of control points supported for an envelope effect.

If the device supports envelope effects (check ERROR(/android.os.VibratorInfo#areEnvelopeEffectsSupported)), this value will be positive. Devices with envelope effects capabilities guarantee support for a minimum of 16 control points. If the device does not support envelope effects, this method will return 0.

Returns
`int`	the maximum number of control points allowed for an envelope effect, or 0 if envelope effects are not supported.

getMinControlPointDurationMillis

Added in Android Baklava

public long getMinControlPointDurationMillis ()

Retrieves the minimum duration supported between two control points within an envelope effect, in milliseconds.

If the device supports envelope effects (check ERROR(/android.os.VibratorInfo#areEnvelopeEffectsSupported)), this value will be positive. Devices with envelope effects capabilities guarantee support for durations down to at least 20 milliseconds. If the device does not support envelope effects, this method will return 0.

Returns
`long`	the minimum allowed duration between two control points in an envelope effect, or 0 if envelope effects are not supported.

hashCode

Added in Android Baklava

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
`int`	a hash code value for this object.

toString

Added in Android Baklava

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.

writeToParcel

Added in Android Baklava

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
`dest`	`Parcel`: This value cannot be `null`.
`flags`	`int`: Additional flags about how the object should be written. May be 0 or `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES