VibrationEffect Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A VibrationEffect describes a haptic effect to be performed by a Vibrator.
[Android.Runtime.Register("android/os/VibrationEffect", ApiSince=26, DoNotGenerateAcw=true)]
public abstract class VibrationEffect : Java.Lang.Object, Android.OS.IParcelable, IDisposable, Java.Interop.IJavaPeerable[<Android.Runtime.Register("android/os/VibrationEffect", ApiSince=26, DoNotGenerateAcw=true)>]
type VibrationEffect = class
inherit Object
interface IParcelable
interface IJavaObject
interface IDisposable
interface IJavaPeerable- Inheritance
- Attributes
- Implements
Remarks
A VibrationEffect describes a haptic effect to be performed by a Vibrator.
These effects may be any number of things, from single shot vibrations to complex waveforms.
Java documentation for android.os.VibrationEffect.
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.
Constructors
| Name | Description |
|---|---|
| VibrationEffect(IntPtr, JniHandleOwnership) |
Initializes a new instance of the VibrationEffect class. |
Fields
| Name | Description |
|---|---|
| DefaultAmplitude |
The default vibration strength of the device. |
| EffectClick |
A click effect. |
| EffectDoubleClick |
A double click effect. |
| EffectHeavyClick |
A heavy click effect. |
| EffectTick |
A tick effect. |
Properties
| Name | Description |
|---|---|
| Class |
Returns the runtime class of this |
| Creator |
Gets the Creator value. |
| Handle |
The handle to the underlying Android instance. (Inherited from Object) |
| JniIdentityHashCode |
Gets the identity hash code assigned to this Java peer by the interop runtime. (Inherited from Object) |
| JniPeerMembers |
Provides JNI peer-member metadata for this type. |
| PeerReference |
Gets the JNI object reference for this Java peer. (Inherited from Object) |
| ThresholdClass |
Gets the Java class used for virtual method dispatch. |
| ThresholdType |
Gets the managed type used for virtual method dispatch. |
Methods
| Name | Description |
|---|---|
| Clone() |
Creates and returns a copy of this object. (Inherited from Object) |
| CreateOneShot(Int64, Int32) |
Create a one shot vibration. |
| CreatePredefined(Int32) |
Create a predefined vibration effect. |
| CreateRepeatingEffect(VibrationEffect, VibrationEffect) |
Creates a new VibrationEffect by merging the preamble and repeating vibration effect. |
| CreateRepeatingEffect(VibrationEffect) |
Creates a new VibrationEffect that repeats the given effect indefinitely. The input vibration must not be a repeating vibration. If it is, an IllegalArgumentException will be thrown. |
| CreateWaveform(Int64[], Int32) |
Create a waveform vibration, using only off/on transitions at the provided time intervals, and potentially repeating. |
| CreateWaveform(Int64[], Int32[], Int32) |
Create a waveform vibration. |
| 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(Parcel,int) , the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit. |
| Dispose() |
Releases the resources held by this Java peer. (Inherited from Object) |
| Dispose(Boolean) |
Releases the resources held by this Java peer. (Inherited from Object) |
| Equals(Object) |
Indicates whether some other object is "equal to" this one. (Inherited from Object) |
| GetHashCode() |
Returns a hash code value for the object. (Inherited from Object) |
| JavaFinalize() |
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object) |
| Notify() |
Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object) |
| NotifyAll() |
Wakes up all threads that are waiting on this object's monitor. (Inherited from Object) |
| SetHandle(IntPtr, JniHandleOwnership) |
Sets the Handle property. (Inherited from Object) |
| StartComposition() |
Start composing a haptic effect. |
| ToArray<T>() |
Creates a managed array from this Java array wrapper. (Inherited from Object) |
| ToString() |
Returns a string representation of the object. (Inherited from Object) |
| UnregisterFromRuntime() |
Unregisters this Java peer from the interop runtime. (Inherited from Object) |
| Wait() |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object) |
| Wait(Int64, Int32) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
| Wait(Int64) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
| WriteToParcel(Parcel, ParcelableWriteFlags) |
Flatten this object in to a Parcel. |
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJavaPeerable.Disposed() |
Notifies the interop runtime that this managed peer has been disposed. (Inherited from Object) |
| IJavaPeerable.DisposeUnlessReferenced() |
Releases this Java peer unless it is retained by another managed reference. (Inherited from Object) |
| IJavaPeerable.Finalized() |
Notifies the interop runtime that this managed peer has been finalized. (Inherited from Object) |
| IJavaPeerable.JniManagedPeerState |
Gets the state that describes the relationship between this managed peer and its JNI reference. (Inherited from Object) |
| IJavaPeerable.SetJniIdentityHashCode(Int32) |
Sets the interop identity hash code for this Java peer. (Inherited from Object) |
| IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) |
Sets the managed and JNI peer state for this Java peer. (Inherited from Object) |
| IJavaPeerable.SetPeerReference(JniObjectReference) |
Sets the JNI object reference used by this managed peer. (Inherited from Object) |
Extension Methods
| Name | Description |
|---|---|
| GetJniTypeName(IJavaPeerable) |
Gets the JNI name of the type of the instance |
| JavaAs<TResult>(IJavaPeerable) |
Try to coerce |
| JavaCast<TResult>(IJavaObject) |
Performs an Android runtime-checked type conversion. |
| JavaCast<TResult>(IJavaObject) | |
| TryJavaCast<TResult>(IJavaPeerable, TResult) |
Try to coerce |