apple.corehaptics.protocol

Interface CHHapticPatternPlayer

All Known Subinterfaces:

CHHapticAdvancedPatternPlayer

public interface CHHapticPatternPlayer

[@protocol] CHHapticPatternPlayer

A protocol which defines operations for starting, stopping, and sending parameters to a pattern player.

Instances of these objects are created via the factory methods such as `CHHapticEngine(createPlayerWithPattern:error)`.

Method Summary

Modifier and Type	Method and Description
boolean	cancelAndReturnError(org.moe.natj.general.ptr.Ptr<NSError> outError) cancelAndReturnError:
boolean	isMuted() [@property] isMuted
boolean	scheduleParameterCurveAtTimeError(CHHapticParameterCurve parameterCurve, double time, org.moe.natj.general.ptr.Ptr<NSError> outError) scheduleParameterCurve:atTime:error
boolean	sendParametersAtTimeError(NSArray<? extends CHHapticDynamicParameter> parameters, double time, org.moe.natj.general.ptr.Ptr<NSError> outError) sendParameters:atTime:error
void	setIsMuted(boolean value) [@property] isMuted
boolean	startAtTimeError(double time, org.moe.natj.general.ptr.Ptr<NSError> outError) startAtTime:error
boolean	stopAtTimeError(double time, org.moe.natj.general.ptr.Ptr<NSError> outError) stopAtTime:error

Method Detail

cancelAndReturnError

boolean cancelAndReturnError(org.moe.natj.general.ptr.Ptr<NSError> outError)

cancelAndReturnError:

Removes all pending commands and stops the player as soon as possible.

isMuted

boolean isMuted()

[@property] isMuted

When set to YES, the player's audio and haptic output will be silenced.

scheduleParameterCurveAtTimeError

boolean scheduleParameterCurveAtTimeError(CHHapticParameterCurve parameterCurve,
                                          double time,
                                          org.moe.natj.general.ptr.Ptr<NSError> outError)

scheduleParameterCurve:atTime:error

Schedule a CHHapticParameterCurve, starting at the specified time (see `CHHapticEngine(currentTime)`). If 'time' is set to `CHHapticTimeImmediate`, the parameter curve is scheduled as soon as possible.

This method overrides the relativeTime property of the passed-in CHHapticParameterCurve, setting it to this method's 'time' argument. All the curve's control point times will then be calculated relative to that time.

sendParametersAtTimeError

boolean sendParametersAtTimeError(NSArray<? extends CHHapticDynamicParameter> parameters,
                                  double time,
                                  org.moe.natj.general.ptr.Ptr<NSError> outError)

sendParameters:atTime:error

Send an array of CHHapticDynamicParameters, starting at the specified time (see `CHHapticEngine(currentTime)`). If 'time' is set to `CHHapticTimeImmediate`, the parameters are sent as soon as possible.

setIsMuted

void setIsMuted(boolean value)

[@property] isMuted

When set to YES, the player's audio and haptic output will be silenced.

startAtTimeError

boolean startAtTimeError(double time,
                         org.moe.natj.general.ptr.Ptr<NSError> outError)

startAtTime:error

Start playing the pattern at the specified time (see `CHHapticEngine(currentTime)`). If 'time' is set to `CHHapticTimeImmediate`, the pattern is started as soon as possible.

stopAtTimeError

boolean stopAtTimeError(double time,
                        org.moe.natj.general.ptr.Ptr<NSError> outError)

stopAtTime:error

Stop playing the pattern at the specified time (see `CHHapticEngine(currentTime)`). If 'time' is set to `CHHapticTimeImmediate`, the pattern is stopped as soon as possible.