Package org.robovm.apple.corehaptic

Class CHHapticEngine

java.lang.Object

org.robovm.rt.bro.NativeObject

org.robovm.objc.ObjCObject

org.robovm.apple.foundation.NSObject

org.robovm.apple.corehaptic.CHHapticEngine

All Implemented Interfaces:

NSObjectProtocol, ObjCProtocol

public class CHHapticEngine
extends NSObject

Since:

Available in iOS 13.0 and later.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CHHapticEngine.AudioResourceKeys
static class	CHHapticEngine.CHHapticEnginePtr

Nested classes/interfaces inherited from class org.robovm.apple.foundation.NSObject

NSObject.Handle, NSObject.Marshaler, NSObject.NoRetainMarshaler, NSObject.NSKeyValueObserver, NSObject.NSObjectPtr, NSObject.SkipInit

Nested classes/interfaces inherited from class org.robovm.objc.ObjCObject

ObjCObject.ObjCObjectPtr, ObjCObject.Super

Field Summary

Fields inherited from class org.robovm.apple.foundation.NSObject

FLAG_NO_RETAIN

Fields inherited from class org.robovm.objc.ObjCObject

customClass

Constructor Summary

Constructors

Modifier	Constructor	Description
	CHHapticEngine()
	CHHapticEngine(AVAudioSession audioSession)
protected	CHHapticEngine(NSObject.Handle h, long handle)
protected	CHHapticEngine(NSObject.SkipInit skipInit)

Method Summary

Modifier and Type	Method	Description
static CHHapticDeviceCapability	capabilitiesForHardware()
CHHapticAdvancedPatternPlayer	createAdvancedPlayer(CHHapticPattern pattern)
CHHapticPatternPlayer	createPlayer(CHHapticPattern pattern)
double	getCurrentTime()
Runnable	getResetHandler()
VoidBlock1<CHHapticEngineStoppedReason>	getStoppedHandler()
boolean	isAutoShutdownEnabled()
boolean	isMutedForAudio()
boolean	isMutedForHaptics()
boolean	isPlaysHapticsOnly()
void	notifyWhenPlayersFinished(Block1<NSError,CHHapticEngineFinishedAction> finishedHandler)
boolean	playPattern(NSData data)
boolean	playPattern(NSURL fileURL)
long	registerAudioResource(NSURL resourceURL, NSDictionary<?,?> options)
void	setAutoShutdownEnabled(boolean v)
void	setIsMutedForAudio(boolean v)
void	setIsMutedForHaptics(boolean v)
void	setPlaysHapticsOnly(boolean v)
void	setResetHandler(Runnable v)
void	setStoppedHandler(VoidBlock1<CHHapticEngineStoppedReason> v)
void	start(VoidBlock1<NSError> completionHandler)
boolean	startAndReturnError(NSError.NSErrorPtr outError)
void	stop(VoidBlock1<NSError> completionHandler)
boolean	unregisterAudioResource(long resourceID)

Methods inherited from class org.robovm.apple.foundation.NSObject

addKeyValueObserver, addKeyValueObserver, afterMarshaled, alloc, autorelease, autorelease, awakeFromNib, conformsToProtocol, copy, description, didChangeValue, didChangeValue, didChangeValues, doDispose, equals, forceSkipInit, getAutoContentAccessingProxy, getClassForCoder, getClassForKeyedArchiver, getKeyValueCoder, getObservationInfo, hash, hashCode, init, isEqual, isKindOfClass, isMemberOfClass, mutableCopy, performSelector, performSelector, performSelector, performSelector, performSelector, performSelector, performSelector, performSelectorInBackground, performSelectorOnMainThread, performSelectorOnMainThread, performSelectorV, performSelectorV, performSelectorV, release, release, removeKeyValueObserver, removeKeyValueObservers, respondsToSelector, retain, retain, retainCount, setObservationInfo, toString, willChangeValue, willChangeValue, willChangeValues

Methods inherited from class org.robovm.objc.ObjCObject

addStrongRef, dispose, dispose, finalize, getAssociatedObject, getObjCClass, getPeerObject, getSuper, initObject, logRetainRelease, removeStrongRef, retainCustomObjectFromCb, setAssociatedObject, toObjCObject, toObjCObject, updateStrongRef

Methods inherited from class org.robovm.rt.bro.NativeObject

as, getHandle, setHandle

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

CHHapticEngine

protected CHHapticEngine(NSObject.Handle h,
long handle)

CHHapticEngine

protected CHHapticEngine(NSObject.SkipInit skipInit)

CHHapticEngine

public CHHapticEngine()
               throws NSErrorException

Throws:

NSErrorException

CHHapticEngine

public CHHapticEngine(AVAudioSession audioSession)
               throws NSErrorException

Throws:

NSErrorException

Method Details

getCurrentTime

public double getCurrentTime()

getStoppedHandler

public VoidBlock1<CHHapticEngineStoppedReason> getStoppedHandler()

setStoppedHandler

public void setStoppedHandler(VoidBlock1<CHHapticEngineStoppedReason> v)

getResetHandler

public Runnable getResetHandler()

setResetHandler

public void setResetHandler(Runnable v)

isPlaysHapticsOnly

public boolean isPlaysHapticsOnly()

setPlaysHapticsOnly

public void setPlaysHapticsOnly(boolean v)

isMutedForAudio

public boolean isMutedForAudio()

setIsMutedForAudio

public void setIsMutedForAudio(boolean v)

isMutedForHaptics

public boolean isMutedForHaptics()

setIsMutedForHaptics

public void setIsMutedForHaptics(boolean v)

isAutoShutdownEnabled

public boolean isAutoShutdownEnabled()

setAutoShutdownEnabled

public void setAutoShutdownEnabled(boolean v)

start

public void start(VoidBlock1<NSError> completionHandler)

startAndReturnError

public boolean startAndReturnError(NSError.NSErrorPtr outError)

stop

public void stop(VoidBlock1<NSError> completionHandler)

notifyWhenPlayersFinished

public void notifyWhenPlayersFinished(Block1<NSError,CHHapticEngineFinishedAction> finishedHandler)

createPlayer

public CHHapticPatternPlayer createPlayer(CHHapticPattern pattern)
                                   throws NSErrorException

Throws:

NSErrorException

createAdvancedPlayer

public CHHapticAdvancedPatternPlayer createAdvancedPlayer(CHHapticPattern pattern)
                                                   throws NSErrorException

Throws:

NSErrorException

registerAudioResource

public long registerAudioResource(NSURL resourceURL,
NSDictionary<?,?> options)
                           throws NSErrorException

Throws:

NSErrorException

unregisterAudioResource

public boolean unregisterAudioResource(long resourceID)
                                throws NSErrorException

Throws:

NSErrorException

playPattern

public boolean playPattern(NSURL fileURL)
                    throws NSErrorException

Throws:

NSErrorException

playPattern

public boolean playPattern(NSData data)
                    throws NSErrorException

Throws:

NSErrorException

capabilitiesForHardware

public static CHHapticDeviceCapability capabilitiesForHardware()