HapticGenerator 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.
Haptic Generator(HG).
[Android.Runtime.Register("android/media/audiofx/HapticGenerator", ApiSince=31, DoNotGenerateAcw=true)]
public class HapticGenerator : Android.Media.Audiofx.AudioEffect, IDisposable, Java.Interop.IJavaPeerable, Java.Lang.IAutoCloseable[<Android.Runtime.Register("android/media/audiofx/HapticGenerator", ApiSince=31, DoNotGenerateAcw=true)>]
type HapticGenerator = class
inherit AudioEffect
interface IAutoCloseable
interface IJavaObject
interface IDisposable
interface IJavaPeerable- Inheritance
- Attributes
- Implements
Remarks
Haptic Generator(HG).
HG is an audio post-processor which generates haptic data based on the audio channels. The generated haptic data is sent along with audio data down to the audio HAL, which will require the device to support audio-coupled-haptic playback. In that case, the effect will only be created on device supporting audio-coupled-haptic playback. Call HapticGenerator#isAvailable() to check if the device supports this effect.
An application can create a HapticGenerator object to initiate and control this audio effect in the audio framework.
To attach the HapticGenerator to a particular AudioTrack or MediaPlayer, specify the audio session ID of this AudioTrack or MediaPlayer when constructing the HapticGenerator.
See android.media.MediaPlayer#getAudioSessionId() for details on audio sessions.
See android.media.audiofx.AudioEffect class for more details on controlling audio effects.
Java documentation for android.media.audiofx.HapticGenerator.
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
| HapticGenerator(IntPtr, JniHandleOwnership) |
Fields
| ActionCloseAudioEffectControlSession |
Intent to signal to the effect control application or service that an audio session is closed and that effects should not be applied anymore. (Inherited from AudioEffect) |
| ActionDisplayAudioEffectControlPanel |
Intent to launch an audio effect control panel UI. (Inherited from AudioEffect) |
| ActionOpenAudioEffectControlSession |
Intent to signal to the effect control application or service that a new audio session is opened and requires audio effects to be applied. (Inherited from AudioEffect) |
| AlreadyExists |
Obsolete.
Internal operation status. (Inherited from AudioEffect) |
| ContentTypeGame |
Obsolete.
Value for |
| ContentTypeMovie |
Obsolete.
Value for |
| ContentTypeMusic |
Obsolete.
Value for |
| ContentTypeVoice |
Obsolete.
Value for |
| EffectAuxiliary |
Effect connection mode is auxiliary. (Inherited from AudioEffect) |
| EffectInsert |
Effect connection mode is insert. (Inherited from AudioEffect) |
| EffectPostProcessing |
Effect connection mode is post processing. (Inherited from AudioEffect) |
| EffectPreProcessing |
Effect connection mode is pre processing. (Inherited from AudioEffect) |
| Error |
Obsolete.
Unspecified error. (Inherited from AudioEffect) |
| ErrorBadValue |
Obsolete.
Operation failed due to bad parameter value. (Inherited from AudioEffect) |
| ErrorDeadObject |
Obsolete.
Operation failed due to dead remote object. (Inherited from AudioEffect) |
| ErrorInvalidOperation |
Obsolete.
Operation failed because it was requested in wrong state. (Inherited from AudioEffect) |
| ErrorNoInit |
Obsolete.
Operation failed due to bad object initialization. (Inherited from AudioEffect) |
| ErrorNoMemory |
Obsolete.
Operation failed due to lack of memory. (Inherited from AudioEffect) |
| ExtraAudioSession |
Contains the ID of the audio session the effects should be applied to. (Inherited from AudioEffect) |
| ExtraContentType |
Indicates which type of content is played by the application. (Inherited from AudioEffect) |
| ExtraPackageName |
Contains the package name of the calling application. (Inherited from AudioEffect) |
| Success |
Obsolete.
Successful operation. (Inherited from AudioEffect) |
Properties
| Class |
Returns the runtime class of this |
| Enabled |
Returns effect enabled state (Inherited from AudioEffect) |
| Handle |
The handle to the underlying Android instance. (Inherited from Object) |
| HasControl |
Checks if this AudioEffect object is controlling the effect engine. (Inherited from AudioEffect) |
| Id |
Returns effect unique identifier. (Inherited from AudioEffect) |
| IsAvailable | |
| JniIdentityHashCode | (Inherited from Object) |
| JniPeerMembers | |
| PeerReference | (Inherited from Object) |
| ThresholdClass | |
| ThresholdType | |
Methods
| Clone() |
Creates and returns a copy of this object. (Inherited from Object) |
| Close() |
Release the resources that are held by the effect. |
| Create(Int32) |
Creates a HapticGenerator and attaches it to the given audio session. |
| Dispose() | (Inherited from Object) |
| Dispose(Boolean) | (Inherited from Object) |
| Equals(Object) |
Indicates whether some other object is "equal to" this one. (Inherited from Object) |
| GetDescriptor() |
Get the effect descriptor. (Inherited from AudioEffect) |
| 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) |
| Release() |
Releases the native AudioEffect resources. (Inherited from AudioEffect) |
| SetControlStatusListener(AudioEffect+IOnControlStatusChangeListener) |
Sets the listener AudioEffect notifies when the effect engine control is taken or returned. (Inherited from AudioEffect) |
| SetEnabled(Boolean) |
Enable or disable the effect. (Inherited from AudioEffect) |
| SetEnableStatusListener(AudioEffect+IOnEnableStatusChangeListener) |
Sets the listener AudioEffect notifies when the effect engine is enabled or disabled. (Inherited from AudioEffect) |
| 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, 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) |
Events
| ControlStatus | (Inherited from AudioEffect) |
| EnableStatus | (Inherited from AudioEffect) |
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) | |