Interface AppleDevice

An external iOS device that can be used for screen recording.

interface AppleDevice {
    id: string;
    name: string;
    model_id?: string;
    availability: "available" | "notPaired" | "notConnected" | "pairedNeedsConnect" | "pairedNeedsReconnect";
}

Properties

id: string

An identifier that uniquely identifies the device.

name: string

A localized device name for display in the user interface.

model_id?: string

The model of this device.

availability: "available" | "notPaired" | "notConnected" | "pairedNeedsConnect" | "pairedNeedsReconnect"

The current availability state of this device.

  • available: Device can be recorded
  • notPaired: Device cannot be recorded because it is connected but not paired (recovery: "Tap 'Trust' on iPhone")
  • notConnected: Device cannot be recorded because it is currently not connected (recovery: "Connect via cable")
  • pairedNeedsConnect: Device cannot be recorded because it is paired but currently not connected (recovery: "(Re-)connect via cable")
  • pairedNeedsReconnect: Device cannot be recorded because it needs to be reconnected (recovery: "Unplug cable, and reconnect again")

Generated using TypeDoc