VibrationEffect.Composition 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 composition of haptic elements that are combined to be playable as a single
VibrationEffect.
[Android.Runtime.Register("android/os/VibrationEffect$Composition", ApiSince=30, DoNotGenerateAcw=true)]
public sealed class VibrationEffect.Composition : Java.Lang.Object[<Android.Runtime.Register("android/os/VibrationEffect$Composition", ApiSince=30, DoNotGenerateAcw=true)>]
type VibrationEffect.Composition = class
inherit Object- Inheritance
- Attributes
Remarks
A composition of haptic elements that are combined to be playable as a single VibrationEffect.
The haptic primitives are available as Composition.PRIMITIVE_* constants and can be added to a composition to create a custom vibration effect. Here is an example of an effect that grows in intensity and then dies off, with a longer rising portion for emphasis and an extra tick 100ms after:
{@code VibrationEffect effect = VibrationEffect.startComposition()
.addPrimitive(VibrationEffect.Composition.PRIMITIVE_SLOW_RISE, 0.5f)
.addPrimitive(VibrationEffect.Composition.PRIMITIVE_QUICK_FALL, 0.5f)
.addPrimitive(VibrationEffect.Composition.PRIMITIVE_TICK, 1.0f, 100)
.compose();}
When choosing to play a composed effect, you should check that individual components are supported by the device by using Vibrator#arePrimitivesSupported.
Java documentation for android.os.VibrationEffect.Composition.
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.
Fields
| PrimitiveClick |
Obsolete.
This effect should produce a sharp, crisp click sensation. |
| PrimitiveLowTick |
Obsolete.
This very short low frequency effect should produce a light crisp sensation intended to be used repetitively for dynamic feedback. |
| PrimitiveQuickFall |
Obsolete.
A haptic effect that simulates quick downwards movement with gravity. |
| PrimitiveQuickRise |
Obsolete.
A haptic effect that simulates quick upward movement against gravity. |
| PrimitiveSlowRise |
Obsolete.
A haptic effect that simulates slow upward movement against gravity. |
| PrimitiveSpin |
Obsolete.
A haptic effect that simulates spinning momentum. |
| PrimitiveThud |
Obsolete.
A haptic effect that simulates downwards movement with gravity. |
| PrimitiveTick |
Obsolete.
This very short effect should produce a light crisp sensation intended to be used repetitively for dynamic feedback. |
Properties
| Class |
Returns the runtime class of this |
| Handle |
The handle to the underlying Android instance. (Inherited from Object) |
| JniIdentityHashCode | (Inherited from Object) |
| JniPeerMembers | |
| PeerReference | (Inherited from Object) |
| ThresholdClass |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object) |
| ThresholdType |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object) |
Methods
| AddPrimitive(Int32) | |
| AddPrimitive(Int32, Single) | |
| AddPrimitive(Int32, Single, Int32) | |
| Clone() |
Creates and returns a copy of this object. (Inherited from Object) |
| Compose() |
Compose all of the added primitives together into a single |
| Dispose() | (Inherited from Object) |
| Dispose(Boolean) | (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) |
| ToArray<T>() | (Inherited from Object) |
| ToString() |
Returns a string representation of the object. (Inherited from Object) |
| UnregisterFromRuntime() | (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) |
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, 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) |
Explicit Interface Implementations
| IJavaPeerable.Disposed() | (Inherited from Object) |
| IJavaPeerable.DisposeUnlessReferenced() | (Inherited from Object) |
| IJavaPeerable.Finalized() | (Inherited from Object) |
| IJavaPeerable.JniManagedPeerState | (Inherited from Object) |
| IJavaPeerable.SetJniIdentityHashCode(Int32) | (Inherited from Object) |
| IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) | (Inherited from Object) |
| IJavaPeerable.SetPeerReference(JniObjectReference) | (Inherited from Object) |
Extension Methods
| JavaCast<TResult>(IJavaObject) |
Performs an Android runtime-checked type conversion. |
| JavaCast<TResult>(IJavaObject) | |
| GetJniTypeName(IJavaPeerable) | |