Media · IOS API REFERENCE

CoreHaptics

Compose and play haptic patterns to customize your iOS app’s haptic feedback.

26 types

140 callable entries

11 skipped

93% entry coverage

Generated from iOS SDK 27.1. Availability is shown on each declaration; permissions and entitlements still apply.

Types

CHHapticAdvancedPatternPlayer

protocol · iOS 13.0+

CHHapticAdvancedPatternPlayerCompletionHandler

typealias

CHHapticAudioResourceID

typealias

CHHapticAudioResourceKey

typealias

CHHapticDeviceCapability

protocol · iOS 13.0+

CHHapticDynamicParameter

class · iOS 13.0+

CHHapticDynamicParameter.ID

struct

CHHapticEngine

class · iOS 13.0+

CHHapticEngine.CompletionHandler

typealias

CHHapticEngine.FinishedAction

enum

CHHapticEngine.FinishedHandler

typealias

CHHapticEngine.ResetHandler

typealias

CHHapticEngine.StoppedHandler

typealias

CHHapticEngine.StoppedReason

enum

CHHapticError

struct · iOS 13.0+

CHHapticError.Code

enum · iOS 13.0+

CHHapticEvent

class · iOS 13.0+

CHHapticEvent.EventType

struct

CHHapticEvent.ParameterID

struct

CHHapticEventParameter

class · iOS 13.0+

CHHapticParameterAttributes

protocol · iOS 13.0+

CHHapticParameterCurve

class

CHHapticParameterCurve.ControlPoint

class · iOS 13.0+

CHHapticPattern

class · iOS 13.0+

CHHapticPattern.Key

struct

CHHapticPatternPlayer

protocol · iOS 13.0+

Functions and constants

get · iOS 16.0+

CHHapticAudioResourceKeyLoopEnabled

TypeScript

const CHHapticAudioResourceKeyLoopEnabled: string

Swift declaration

let CHHapticAudioResourceKeyLoopEnabled: String

get · iOS 15.0+

CHHapticAudioResourceKeyUseVolumeEnvelope

TypeScript

const CHHapticAudioResourceKeyUseVolumeEnvelope: string

Swift declaration

let CHHapticAudioResourceKeyUseVolumeEnvelope: String

get

CoreHapticsErrorDomain

TypeScript

const CoreHapticsErrorDomain: string

Swift declaration

let CoreHapticsErrorDomain: String

get

CHHapticTimeImmediate

TypeScript

const CHHapticTimeImmediate: number

Swift declaration

var CHHapticTimeImmediate: TimeInterval { get }

Skipped declarations

11 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

CHHapticPattern.init()

inherited init: cannot prove legal (class declares 5 custom initializers)

CHHapticEvent.init()

inherited init: cannot prove legal (class declares 4 custom initializers)

CHHapticDynamicParameter.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

CHHapticEventParameter.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

CHHapticParameterCurve.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

CHHapticParameterCurve.ControlPoint.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

protocol implementation CHHapticAdvancedPatternPlayer

non-method protocol requirement

protocol implementation CHHapticPatternPlayer

non-method protocol requirement

protocol implementation CHHapticDeviceCapability

synchronous protocol result requires an active JS-thread call; delegate invocations can escape it

protocol implementation CHHapticParameterAttributes

non-method protocol requirement