CoreHaptics · IOS API REFERENCE

CHHapticEngine

class · iOS 13.0+ · SDK 27.1

class CHHapticEngine

Members (27)

static · iOS 13.0+

capabilitiesForHardware

TypeScript

static capabilitiesForHardware(): SDKHandle

Swift declaration

class func capabilitiesForHardware() -> any CHHapticDeviceCapability

method · iOS 13.0+

makeAdvancedPlayer

TypeScript

makeAdvancedPlayer(pattern: CHHapticPattern): SDKHandle

Swift declaration

func makeAdvancedPlayer(with pattern: CHHapticPattern) throws -> any CHHapticAdvancedPatternPlayer

method · iOS 13.0+

makePlayer

TypeScript

makePlayer(pattern: CHHapticPattern): SDKHandle

Swift declaration

func makePlayer(with pattern: CHHapticPattern) throws -> any CHHapticPatternPlayer

init · iOS 13.0+

init

TypeScript

static init(): CHHapticEngine

Swift declaration

init() throws

init · iOS 13.0+

init

TypeScript

static initAudioSession(audioSession?: (_AVFAudio_AVAudioSession) | null): CHHapticEngine

Swift declaration

init(audioSession: AVAudioSession?) throws

method · iOS 13.0+

playPattern

TypeScript

playPatternFrom(data: ArrayBuffer): void

Swift declaration

func playPattern(from data: Data) throws

method · iOS 13.0+

playPattern

TypeScript

playPatternFrom83173(fileURL: string): void

Swift declaration

func playPattern(from fileURL: URL) throws

method · iOS 13.0+

registerAudioResource

TypeScript

registerAudioResource(resourceURL: string, options?: NativeMap<unknown, unknown>): number

Swift declaration

func registerAudioResource(_ resourceURL: URL, options: [AnyHashable : Any] = [:]) throws -> CHHapticAudioResourceID

method · iOS 13.0+

start

TypeScript

start(): void

Swift declaration

func start() throws

method · iOS 13.0+

start

TypeScript

startCompletionHandler(completionHandler?: (((arg0: (NativeError) | null) => void)) | null): void

Swift declaration

func start() async throws

method · iOS 13.0+

stop

TypeScript

stop(completionHandler?: (((arg0: (NativeError) | null) => void)) | null): void

Swift declaration

func stop() async throws

method · iOS 13.0+

unregisterAudioResource

TypeScript

unregisterAudioResource(resourceID: number): void

Swift declaration

func unregisterAudioResource(_ resourceID: CHHapticAudioResourceID) throws

get · iOS 13.0+

isAutoShutdownEnabled

TypeScript

get isAutoShutdownEnabled(): boolean

Swift declaration

var isAutoShutdownEnabled: Bool { get set }

set · iOS 13.0+

isAutoShutdownEnabled

TypeScript

set isAutoShutdownEnabled(value: boolean)

Swift declaration

var isAutoShutdownEnabled: Bool { get set }

get · iOS 13.0+

currentTime

TypeScript

get currentTime(): number

Swift declaration

var currentTime: TimeInterval { get }

get · iOS 13.0+

isMutedForAudio

TypeScript

get isMutedForAudio(): boolean

Swift declaration

var isMutedForAudio: Bool { get set }

set · iOS 13.0+

isMutedForAudio

TypeScript

set isMutedForAudio(value: boolean)

Swift declaration

var isMutedForAudio: Bool { get set }

get · iOS 13.0+

isMutedForHaptics

TypeScript

get isMutedForHaptics(): boolean

Swift declaration

var isMutedForHaptics: Bool { get set }

set · iOS 13.0+

isMutedForHaptics

TypeScript

set isMutedForHaptics(value: boolean)

Swift declaration

var isMutedForHaptics: Bool { get set }

get · iOS 16.0+

playsAudioOnly

TypeScript

get playsAudioOnly(): boolean

Swift declaration

var playsAudioOnly: Bool { get set }

set · iOS 16.0+

playsAudioOnly

TypeScript

set playsAudioOnly(value: boolean)

Swift declaration

var playsAudioOnly: Bool { get set }

get · iOS 13.0+

playsHapticsOnly

TypeScript

get playsHapticsOnly(): boolean

Swift declaration

var playsHapticsOnly: Bool { get set }

set · iOS 13.0+

playsHapticsOnly

TypeScript

set playsHapticsOnly(value: boolean)

Swift declaration

var playsHapticsOnly: Bool { get set }

get · iOS 13.0+

resetHandler

TypeScript

get resetHandler(): (() => Promise<void>)

Swift declaration

var resetHandler: CHHapticEngine.ResetHandler { get set }

set · iOS 13.0+

resetHandler

TypeScript

set resetHandler(value: (() => void))

Swift declaration

var resetHandler: CHHapticEngine.ResetHandler { get set }

get · iOS 13.0+

stoppedHandler

TypeScript

get stoppedHandler(): ((arg0: CHHapticEngine_StoppedReason) => Promise<void>)

Swift declaration

var stoppedHandler: CHHapticEngine.StoppedHandler { get set }

set · iOS 13.0+

stoppedHandler

TypeScript

set stoppedHandler(value: ((arg0: CHHapticEngine_StoppedReason) => void))

Swift declaration

var stoppedHandler: CHHapticEngine.StoppedHandler { get set }

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

CHHapticEngine.notifyWhenPlayersFinished(finishedHandler:)

callback cannot propagate synchronous failure

All CoreHaptics types →