Loading...
Loading...
Control motorized camera docks and enable intelligent subject tracking using DockKit. Use when discovering DockKit-compatible accessories, implementing camera subject tracking for faces or bodies, controlling dock motors for pan and tilt, configuring framing behavior, setting regions of interest, or building video apps with automatic camera tracking.
npx skill4agent add dpearson2699/swift-ios-skills dockkitimport DockKitDockAccessoryManager.sharedimport DockKit
func observeAccessories() async throws {
for await stateChange in try DockAccessoryManager.shared.accessoryStateChanges {
switch stateChange.state {
case .docked:
guard let accessory = stateChange.accessory else { continue }
// Accessory is connected and ready
configureAccessory(accessory)
case .undocked:
// iPhone removed from dock
handleUndocked()
@unknown default:
break
}
}
}accessoryStateChangesAsyncSequenceDockAccessory.StateChangestate.docked.undockedaccessoryDockAccessorytrackingButtonEnabledDockAccessoryidentifiernamecategory.trackingStanduuidfirmwareVersionhardwareModel// Enable system tracking (default)
try await DockAccessoryManager.shared.setSystemTrackingEnabled(true)
// Disable system tracking for custom control
try await DockAccessoryManager.shared.setSystemTrackingEnabled(false)let isEnabled = DockAccessoryManager.shared.isSystemTrackingEnabled// Select the subject at a screen coordinate
try await accessory.selectSubject(at: CGPoint(x: 0.5, y: 0.5))
// Select specific subjects by identifier
try await accessory.selectSubjects([subjectUUID])
// Clear selection (return to automatic selection)
try await accessory.selectSubjects([])DockAccessory.Observationimport DockKit
import AVFoundation
func processFrame(
_ sampleBuffer: CMSampleBuffer,
accessory: DockAccessory,
device: AVCaptureDevice
) async throws {
let cameraInfo = DockAccessory.CameraInformation(
captureDevice: device.deviceType,
cameraPosition: device.position,
orientation: .corrected,
cameraIntrinsics: nil,
referenceDimensions: nil
)
// Create observation from your detection output
let observation = DockAccessory.Observation(
identifier: 0,
type: .humanFace,
rect: detectedFaceRect, // CGRect in normalized coordinates
faceYawAngle: nil
)
try await accessory.track(
[observation],
cameraInformation: cameraInfo
)
}| Type | Use |
|---|---|
| Preserves system multi-person tracking and framing optimizations |
| Full body tracking |
| Arbitrary objects (pets, hands, barcodes, etc.) |
rectDockAccessory.CameraInformation.correctedcameraIntrinsicsreferenceDimensions[AVMetadataObject]CVPixelBuffertry await accessory.setFramingMode(.center)| Mode | Behavior |
|---|---|
| System decides optimal framing |
| Keep subject centered (default) |
| Frame subject in left third |
| Frame subject in right third |
let currentMode = accessory.framingMode.left.right// Normalized coordinates, origin at upper-left
let squareRegion = CGRect(x: 0.25, y: 0.0, width: 0.5, height: 1.0)
try await accessory.setRegionOfInterest(squareRegion)let currentROI = accessory.regionOfInterestimport Spatial
// Pan right at 0.2 rad/s, tilt down at 0.1 rad/s
let velocity = Vector3D(x: 0.1, y: 0.2, z: 0.0)
try await accessory.setAngularVelocity(velocity)
// Stop all motion
try await accessory.setAngularVelocity(Vector3D())xyzlet target = Vector3D(x: 0.0, y: 0.5, z: 0.0) // Yaw 0.5 rad
let progress = try accessory.setOrientation(
target,
duration: .seconds(2),
relative: false
)Rotation3Drelative: trueProgressfor await state in accessory.motionStates {
let positions = state.angularPositions // Vector3D
let velocities = state.angularVelocities // Vector3D
let time = state.timestamp
if let error = state.error {
// Motor error occurred
}
}let yawLimit = try DockAccessory.Limits.Limit(
positionRange: -1.0 ..< 1.0, // radians
maximumSpeed: 0.5 // rad/s
)
let limits = DockAccessory.Limits(yaw: yawLimit, pitch: nil, roll: nil)
try accessory.setLimits(limits)// Disable system tracking before animating
try await DockAccessoryManager.shared.setSystemTrackingEnabled(false)
let progress = try await accessory.animate(motion: .kapow)
// Wait for completion
while !progress.isFinished && !progress.isCancelled {
try await Task.sleep(for: .milliseconds(100))
}
// Restore system tracking
try await DockAccessoryManager.shared.setSystemTrackingEnabled(true)| Animation | Effect |
|---|---|
| Nodding motion |
| Shaking motion |
| Startup-style motion |
| Dramatic pendulum swing |
trackingStatesTrackingStateTrackedSubjectType.person.objectspeakingConfidencelookingAtCameraConfidencesaliencyRankfor await state in accessory.trackingStates {
for subject in state.trackedSubjects {
switch subject {
case .person(let person):
let speaking = person.speakingConfidence // 0.0 - 1.0
let saliency = person.saliencyRank
case .object(let object):
let saliency = object.saliencyRank
}
}
}selectSubjects(_:)for await event in accessory.accessoryEvents {
switch event {
case .cameraShutter:
// Start or stop recording / take photo
break
case .cameraFlip:
// Switch front/back camera
break
case .cameraZoom(factor: let factor):
// factor > 0 means zoom in, < 0 means zoom out
break
case .button(id: let id, pressed: let pressed):
// Custom button with identifier
break
@unknown default:
break
}
}namefor await battery in accessory.batteryStates {
let level = battery.batteryLevel // 0.0 - 1.0
let charging = battery.chargeState // .charging, .notCharging, .notChargeable
let low = battery.lowBattery
}// WRONG -- system tracking fights manual commands
try await accessory.setAngularVelocity(velocity)
// CORRECT -- disable system tracking first
try await DockAccessoryManager.shared.setSystemTrackingEnabled(false)
try await accessory.setAngularVelocity(velocity)// WRONG -- state may have reset after backgrounding
func applicationDidBecomeActive() {
// Assume custom tracking is still active
}
// CORRECT -- re-set tracking state on foreground
func applicationDidBecomeActive() {
Task {
try await DockAccessoryManager.shared.setSystemTrackingEnabled(false)
}
}// WRONG -- calling once per second is too slow
try await accessory.track(observations, cameraInformation: cameraInfo)
// (called at 1 fps)
// CORRECT -- call at 10-30 fps
// Hook into AVCaptureVideoDataOutputSampleBufferDelegate for per-frame calls// WRONG -- tracking stays disabled after animation
try await DockAccessoryManager.shared.setSystemTrackingEnabled(false)
let progress = try await accessory.animate(motion: .kapow)
// CORRECT -- restore tracking when animation completes
try await DockAccessoryManager.shared.setSystemTrackingEnabled(false)
let progress = try await accessory.animate(motion: .kapow)
while !progress.isFinished && !progress.isCancelled {
try await Task.sleep(for: .milliseconds(100))
}
try await DockAccessoryManager.shared.setSystemTrackingEnabled(true)import DockKitaccessoryStateChanges.docked.undockedrect@unknown default