Wearables Device Access Toolkit iOS Swift

https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/
Admin
The Wearables Device Access Toolkit SDK enables developers to integrate Meta's Wearables into iOS...
Tokens:13,346
Snippets:131
Trust Score:9.9
Update:10 months ago
Show doc for...
Tokens:
Raw
### Start Device State Session

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_devicestatesession

Starts the device state session, initiating monitoring for state changes on the selected device. This function is essential for receiving updates about the device's status.

```swift
public func start()
```

--------------------------------

### Get Camera Mocking Suite

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatmockdevice_mockdisplaylessglasses

Provides a 'getCameraKit' function to retrieve an instance of MockCameraKit. This instance allows for the mocking and control of camera functionalities within the simulated displayless smart glasses environment. It is essential for testing camera-related features.

```swift
public func getCameraKit() -> MockCameraKit

```

--------------------------------

### Start AI Glasses Registration (Swift)

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_wearablesinterface

Initiates the registration process for AI glasses by opening the Meta AI app. Upon completion in the Meta AI app, a callback URL is received and must be passed to handleUrl(_:) to finalize registration. The registrationState property tracks the process. Throws RegistrationError on failure.

```swift
public func startRegistration()
throws RegistrationError
```

--------------------------------

### Initialize StreamSession with Configuration and Device Selector (Swift)

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcamera_streamsession

Creates a streaming session with a custom configuration, including resolution, frame rate, and codec settings. The session starts in a stopped state and requires a call to start() to begin streaming. The deviceSelector determines which device to stream from.

```swift
public init(streamSessionConfig: StreamSessionConfig, deviceSelector: DeviceSelector)
```

--------------------------------

### Request Permission Swift

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_wearablesinterface

Requests a specific permission on AI glasses. This method opens the Meta AI app for user interaction. After the user responds, a callback URL must be passed to handleUrl(_:) to complete the request. Returns the PermissionStatus after user response. Throws PermissionError if there is an error starting the process.

```swift
public func requestPermission(_ permission: Permission) -> PermissionStatus
```

--------------------------------

### Start AI Glasses Unregistration (Swift)

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_wearablesinterface

Initiates the unregistration process for AI glasses by opening the Meta AI app. Upon completion in the Meta AI app, a callback URL is received and must be passed to handleUrl(_:) to finalize unregistration. The registrationState property tracks the process. Throws RegistrationError on failure.

```swift
public func startUnregistration()
throws RegistrationError
```

--------------------------------

### Get Device For Identifier API

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_wearablesinterface

Fetches the underlying Device object for a given DeviceIdentifier.

```APIDOC
## POST /websites/wearables_developer_meta_reference_ios_swift_dat_0_2/deviceForIdentifier

### Description
Fetch the underlying Device object for a given DeviceIdentifier.

### Method
POST

### Endpoint
/websites/wearables_developer_meta_reference_ios_swift_dat_0_2/deviceForIdentifier

### Parameters
#### Path Parameters
- **identifier** (DeviceIdentifier) - Required - The device identifier to fetch.

### Response
#### Success Response (200)
- **Device?** (Device?) - The Device object for the given device identifier.

### Response Example
{
  "example": "Device?"
}
```

--------------------------------

### Mutex Constructor (Swift)

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_mutex

Initializes a Mutex with a given initial value. This constructor is used to create a new Mutex instance and set its starting state.

```swift
public init(_ initialValue: sending Value)
```

--------------------------------

### Get Active Device Stream

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_autodeviceselector

Creates a stream of active device changes. This stream updates whenever the device list changes, returning an optional DeviceIdentifier. The return type is AnyAsyncSequence.

```swift
public func activeDeviceStream() -> AnyAsyncSequence<DeviceIdentifier?>
```

--------------------------------

### Get Device Name or Identifier - Swift

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_device

Returns the human-readable name of the device if it's available; otherwise, it falls back to returning the device's unique identifier. This is useful for displaying device information.

```swift
public func nameOrId() -> String
```

--------------------------------

### Get Device Type - Swift

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_device

Retrieves the specific type of the device, such as 'Ray-Ban Meta'. This function returns a `DeviceType` enum value, useful for identifying the hardware.

```swift
public func deviceType() -> DeviceType
```

--------------------------------

### Initialize DeviceStateSession

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_devicestatesession

Initializes a new instance of DeviceStateSession. This constructor requires a DeviceSelector object to specify which device to monitor.

```swift
public init(deviceSelector: DeviceSelector)
```

--------------------------------

### MockDisplaylessGlasses Protocol Definition

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatmockdevice_mockdisplaylessglasses

Defines the MockDisplaylessGlasses protocol, which simulates displayless smart glasses behavior. It extends the MockDevice protocol and provides methods for folding, unfolding, and accessing camera mocking functionalities. This is useful for testing and development scenarios.

```swift
protocol MockDisplaylessGlasses: MockDevice

```

--------------------------------

### Initialize Device Object

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_device

Initializes a new Device object with the provided private device information. This constructor is fundamental for creating and managing device instances within the toolkit.

```swift
public init( devicePrivate: DevicePrivate)
```

--------------------------------

### Handle URL API

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_wearablesinterface

Handles callback URLs from the Meta AI app during registration and permission flows.

```APIDOC
## POST /websites/wearables_developer_meta_reference_ios_swift_dat_0_2/handleUrl

### Description
Handles callback URLs from the Meta AI app during registration and permission flows. This method must be called when your app receives a URL callback after the user completes an action in the Meta AI app. This includes callbacks from startRegistration(), startUnregistration(), and permission requests. The SDK will determine if the URL is relevant to the Wearables Device Access Toolkit. If not relevant, the method returns `false` without throwing an error.
Platform Flow:
On iOS, the Meta AI app returns to your app via a URL scheme callback. You must:
1. Configure your app's URL schemes in Info.plist
2. Implement URL handling in your app delegate or scene delegate
3. Call this method with the received URL

### Method
POST

### Endpoint
/websites/wearables_developer_meta_reference_ios_swift_dat_0_2/handleUrl

### Parameters
#### Path Parameters
- **url** (URL) - Required - The incoming URL to handle.

### Response
#### Success Response (200)
- **Bool** (Bool) - `true` if the URL was handled by the Wearables Device Access Toolkit, `false` if it's not relevant to the Wearables Device Access Toolkit.

### Response Example
{
  "example": "true"
}

#### Error Response
- **RegistrationError** - If there is an error processing a relevant URL.
```

--------------------------------

### Request Permission API

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_wearablesinterface

Requests a specific permission on AI glasses.

```APIDOC
## POST /websites/wearables_developer_meta_reference_ios_swift_dat_0_2/requestPermission

### Description
Requests a specific permission on AI glasses. This method opens the Meta AI app where the user completes the permission request flow. After the user responds in the Meta AI app, your app will receive a callback URL that must be passed to handleUrl(_:) to complete the permission request.

### Method
POST

### Endpoint
/websites/wearables_developer_meta_reference_ios_swift_dat_0_2/requestPermission

### Parameters
#### Path Parameters
- **permission** (Permission) - Required - The type of permission to request.

### Response
#### Success Response (200)
- **PermissionStatus** (PermissionStatus) - The PermissionStatus after the user responds.

### Response Example
{
  "example": "PermissionStatus"
}

#### Error Response
- **PermissionError** - Thrown if there is an error starting the permission request process.
```

--------------------------------

### MockDeviceKit Enum Definition

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatmockdevice_mockdevicekit

The entry-point to the MockDeviceKit for managing simulated Meta Wearables devices. Use this in testing and development scenarios to simulate real hardware behavior. It is defined as an enum.

```swift
enum MockDeviceKit
```

--------------------------------

### MockDevice Protocol Definition and Functions (Swift)

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatmockdevice_mockdevice

This snippet defines the MockDevice protocol in Swift, including its properties and functions for simulating device interactions. It covers simulating device on/off, power on/off, and accessing the device identifier.

```swift
protocol MockDevice {
    var deviceIdentifier: DeviceIdentifier { get } // The unique device identifier for this mock device.

    func doff() // Simulates taking off (doffing) the device.
    func don() // Simulates putting on (donning) the device.
    func powerOff() // Powers off the mock device.
    func powerOn() // Powers on the mock device.
}
```

--------------------------------

### MockRaybanMeta Protocol Definition

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatmockdevice_mockraybanmeta

Defines a protocol for simulating Ray-Ban Meta smart glasses in testing environments. It extends MockDisplaylessGlasses, inheriting its capabilities and specializing for Ray-Ban Meta simulation.

```swift
protocol MockRaybanMeta: MockDisplaylessGlasses
```

--------------------------------

### MockDevice Protocol

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatmockdevice_mockdevice

This section details the MockDevice protocol, which simulates device interactions for testing and development purposes.

```APIDOC
## MockDevice Protocol

### Description

This protocol defines a mock device for simulating interactions and testing scenarios without needing a physical device.

### Method

N/A (Protocol Definition)

### Endpoint

N/A (Protocol Definition)

### Parameters

#### Path Parameters

None

#### Query Parameters

None

#### Request Body

None

### Request Example

N/A

### Response

#### Success Response (200)

N/A

#### Response Example

N/A

## Properties

### deviceIdentifier

- **deviceIdentifier** (String) - Read-only - The unique device identifier for this mock device.

## Functions

### doff

- **doff** ()

  Simulates taking off (doffing) the device.

  #### Signature
  ```public func doff()
  ```

### don

- **don** ()

  Simulates putting on (donning) the device.

  #### Signature
  ```public func don()
  ```

### powerOff

- **powerOff** ()

  Powers off the mock device.

  #### Signature
  ```public func powerOff()
  ```

### powerOn

- **powerOn** ()

  Powers on the mock device.

  #### Signature
  ```public func powerOn()
  ```
```

--------------------------------

### MockDeviceKitInterface Protocol Definition (Swift)

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatmockdevice_mockdevicekitinterface

Defines the MockDeviceKitInterface protocol for managing mock Meta Wearables devices. It includes properties for accessing paired devices and functions for pairing and unpairing devices.

```swift
protocol MockDeviceKitInterface {
    var pairedDevices: [MockDevice] { get } // The list of all currently paired mock devices.

    func pairRaybanMeta() -> MockRaybanMeta // Pairs a simulated Ray-Ban Meta device.
    func unpairDevice(_ device: MockDevice) // Unpairs a simulated device.
}
```

--------------------------------

### Initialize SpecificDeviceSelector

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_specificdeviceselector

Creates a device selector that targets a specific device. Requires a DeviceIdentifier to specify which device to select.

```swift
public init(device: DeviceIdentifier)
```

--------------------------------

### PhotoCaptureFormat Enum

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcamera_photocaptureformat

This enumeration defines the supported formats for capturing photos from Meta Wearables devices.

```APIDOC
## PhotoCaptureFormat Enum

Extends Sendable
Supported formats for capturing photos from Meta Wearables devices.

### Signature

```swift
enum PhotoCaptureFormat: Sendable
```

### Enumeration Constants

Member| Description  
---|---
heic|  High Efficiency Image Container format (HEIC) - provides better compression than JPEG.   
jpeg|  Joint Photographic Experts Group format (JPEG) - widely supported image format.   
```

--------------------------------

### Initialize VideoFrameSize Struct in Swift

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcamera_videoframesize

Initializes a new VideoFrameSize struct with specified width and height. This struct represents the dimensions of a video frame in pixels. It is a fundamental component for handling video data within the MWDATCamera module.

```swift
public init(width: UInt, height: UInt)
```

--------------------------------

### Configure Wearables Device Access Toolkit (Swift)

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_wearables

Configures the Wearables Device Access Toolkit using settings from the app bundle. This is a mandatory step before any other toolkit functionality can be used. Subsequent calls will result in an error. It may throw a WearablesError.alreadyConfigured if called more than once.

```swift
public static func configure()
throws WearablesError.alreadyConfigured
```

--------------------------------

### PhotoData Struct Initialization (Swift)

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcamera_photodata

Initializes a PhotoData struct with the captured image data and its format. This struct represents a photo captured from a Meta Wearables device and conforms to Sendable, allowing it to be safely passed across threads.

```swift
public init(data: Data, format: PhotoCaptureFormat)
```

--------------------------------

### Registration State Listener API

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_wearablesinterface

APIs for adding and managing listeners for changes in the registration state.

```APIDOC
## POST /websites/wearables_developer_meta_reference_ios_swift_dat_0_2/addRegistrationStateListener

### Description
Adds a listener to receive callbacks when the registration state changes. The listener is immediately called with the current state.

### Method
POST

### Endpoint
/websites/wearables_developer_meta_reference_ios_swift_dat_0_2/addRegistrationStateListener

### Parameters
#### Path Parameters
- **listener** (@escaping (RegistrationState) -> Void) - Required - The callback to execute when the registration state changes.

### Response
#### Success Response (200)
- **AnyListenerToken** (AnyListenerToken) - A token that can be used to cancel the listener. When the token deinits the listener is also canceled.

### Response Example
{
  "example": "AnyListenerToken"
}
```

--------------------------------

### Simulate Unfolding Glasses

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatmockdevice_mockdisplaylessglasses

Implements the 'unfold' function to simulate the action of unfolding the displayless smart glasses into an open position. This function is part of the MockDisplaylessGlasses protocol and is crucial for testing the device's operational states.

```swift
public func unfold()

```

--------------------------------

### MockCameraKit Protocol

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatmockdevice_mockcamerakit

The MockCameraKit protocol allows for mocking camera functionality, enabling developers to simulate camera behavior for testing purposes. It includes methods to set the camera feed from a video file and to set a captured image from an image file.

```APIDOC
## MockCameraKit Protocol

A suite for mocking camera functionality.

### Description
This protocol provides methods to simulate camera input, such as setting a video feed from a file or a static image.

### Method
N/A (Protocol Definition)

### Endpoint
N/A (Protocol Definition)

### Functions

#### setCameraFeed(fileURL: URL)

##### Description
Sets the camera feed from a video file. Supported codecs: h.265.

##### Signature
```swift
public func setCameraFeed(fileURL: URL)
```

##### Parameters
- **fileURL** (URL) - Required - URL of the file containing the video stream.

#### setCapturedImage(fileURL: URL)

##### Description
Sets the captured image from an image file.

##### Signature
```swift
public func setCapturedImage(fileURL: URL)
```

##### Parameters
- **fileURL** (URL) - Required - URL of the file containing the image.

### Request Example
N/A (Protocol Definition)

### Response
N/A (Protocol Definition)
```

--------------------------------

### Handle URL Callback Swift

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_wearablesinterface

Handles callback URLs from the Meta AI app during registration and permission flows. This method should be called when your app receives a URL callback. Returns true if the URL was handled by the toolkit, false otherwise. Throws RegistrationError on relevant URL processing errors.

```swift
public func handleUrl(_ url: URL) -> Bool
```

--------------------------------

### StreamSessionConfig Initialization (Swift)

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcamera_streamsessionconfig

Initializes a StreamSessionConfig for media streaming with specified video codec, resolution, and frame rate. Alternatively, a default configuration can be created using the parameterless initializer, which defaults to raw video codec, medium resolution, deliver-all frame strategy, and 30 FPS.

```swift
public init(videoCodec: VideoCodec, resolution: StreamingResolution, frameRate: UInt)

```

```swift
public init()

```

--------------------------------

### MockDeviceKit Shared Instance Property

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatmockdevice_mockdevicekit

Provides access to the shared instance of MockDeviceKit. This instance is used to manage all simulated devices within the testing environment. It is a key property for interacting with the mock device framework.

```swift
**shared**
```

--------------------------------

### Devices Stream API

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_wearablesinterface

Creates an AsyncStream for observing device list changes.

```APIDOC
## POST /websites/wearables_developer_meta_reference_ios_swift_dat_0_2/devicesStream

### Description
Creates an `AsyncStream` for observing device list changes.

### Method
POST

### Endpoint
/websites/wearables_developer_meta_reference_ios_swift_dat_0_2/devicesStream

### Response
#### Success Response (200)
- **AsyncStream<[DeviceIdentifier]>** (AsyncStream<[DeviceIdentifier]>) - Stream for observing device list changes.

### Response Example
{
  "example": "AsyncStream<[DeviceIdentifier]>"
}
```

--------------------------------

### Create Devices Stream Swift

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_wearablesinterface

Creates an AsyncStream for observing device list changes. This stream provides a continuous flow of device identifier arrays.

```swift
public func devicesStream() -> AsyncStream<[DeviceIdentifier]>
```

--------------------------------

### Registration State Stream API

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_wearablesinterface

Creates an AsyncStream for observing registration state changes.

```APIDOC
## POST /websites/wearables_developer_meta_reference_ios_swift_dat_0_2/registrationStateStream

### Description
Creates an `AsyncStream` for observing registration state changes.

### Method
POST

### Endpoint
/websites/wearables_developer_meta_reference_ios_swift_dat_0_2/registrationStateStream

### Response
#### Success Response (200)
- **AsyncStream<RegistrationState>** (AsyncStream<RegistrationState>) - Stream for observing registration state changes.

### Response Example
{
  "example": "AsyncStream<RegistrationState>"
}
```

--------------------------------

### Simulate Folding Glasses

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatmockdevice_mockdisplaylessglasses

Implements the 'fold' function to simulate the action of folding the displayless smart glasses into a closed position. This function is part of the MockDisplaylessGlasses protocol and is used for testing purposes.

```swift
public func fold()

```

--------------------------------

### Device List Listener API

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_wearablesinterface

APIs for adding and managing listeners for changes in the device list.

```APIDOC
## POST /websites/wearables_developer_meta_reference_ios_swift_dat_0_2/addDevicesListener

### Description
Adds a listener to receive callbacks when the device list changes. The listener is immediately called with the current devices.

### Method
POST

### Endpoint
/websites/wearables_developer_meta_reference_ios_swift_dat_0_2/addDevicesListener

### Parameters
#### Path Parameters
- **listener** (@escaping ([DeviceIdentifier]) -> Void) - Required - The callback to execute when the device list changes.

### Response
#### Success Response (200)
- **AnyListenerToken** (AnyListenerToken) - A token that can be used to cancel the listener. When the token deinits the listener is also canceled.

### Response Example
{
  "example": "AnyListenerToken"
}
```

--------------------------------

### AnyListenerToken Protocol

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_anylistenertoken

The AnyListenerToken protocol is used to manage listener subscriptions. A token can be used to cancel a listener subscription, and the listener is automatically canceled when the token is no longer referenced.

```APIDOC
## AnyListenerToken Protocol

### Description
A token that can be used to cancel a listener subscription. When the token is no longer referenced, the listener is automatically canceled.

### Protocol Signature
```swift
protocol AnyListenerToken: Sendable
```

### Functions
#### cancel()

##### Description
Cancels the listener subscription asynchronously.

##### Signature
```swift
public func cancel()
```
```

--------------------------------

### Device Session State Listener API

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_wearablesinterface

APIs for adding and managing listeners for device session state changes.

```APIDOC
## POST /websites/wearables_developer_meta_reference_ios_swift_dat_0_2/addDeviceSessionStateListener

### Description
Adds a listener to receive callbacks when the session state changes for a specific device. The listener is immediately called with the current session state.

### Method
POST

### Endpoint
/websites/wearables_developer_meta_reference_ios_swift_dat_0_2/addDeviceSessionStateListener

### Parameters
#### Path Parameters
- **forDeviceId** (DeviceIdentifier) - Required - The identifier of the device to listen for session state changes.
- **listener** (@escaping (SessionState) -> Void) - Required - The callback to execute when the session state changes.

### Response
#### Success Response (200)
- **AnyListenerToken** (AnyListenerToken) - A token that can be used to cancel the listener. When the token deinits the listener is also canceled.

### Response Example
{
  "example": "AnyListenerToken"
}
```

--------------------------------

### PhotoCaptureFormat Enum Definition (Swift)

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcamera_photocaptureformat

Defines the supported formats for capturing photos from Meta Wearables devices. It includes options for HEIC and JPEG, with HEIC offering better compression.

```swift
enum PhotoCaptureFormat: Sendable {
  case heic
  case jpeg
}
```

--------------------------------

### Create Registration State Stream Swift

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_wearablesinterface

Creates an AsyncStream for observing registration state changes. This stream provides a continuous flow of registration state updates.

```swift
public func registrationStateStream() -> AsyncStream<RegistrationState>
```

--------------------------------

### Set Captured Image from File URL - Swift

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatmockdevice_mockcamerakit

Sets a captured image for mocking by providing a file URL. This function allows developers to simulate image capture events using a specified image file.

```swift
public func setCapturedImage( fileURL: URL)
```

--------------------------------

### Swift: RegistrationState Enum for Meta Wearables

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_registrationstate

Defines the possible states for user registration with the Meta Wearables platform. This enum, an extension of Int, includes states like unavailable, available, registering, and registered, providing clear indicators for the registration process.

```swift
enum RegistrationState: Int {
    case unavailable
    case available
    case registering
    case registered
}
```

--------------------------------

### DeviceType Enum

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_devicetype

Represents the different types of Meta Wearables devices supported by the SDK. Each enum case corresponds to a specific hardware variant.

```APIDOC
## Enum DeviceType

### Description
Represents the types of Meta Wearables devices supported by the Wearables Device Access Toolkit. Each device type corresponds to a specific Meta Wearables hardware variant with distinct capabilities and features.

### Type
`enum DeviceType: String, CaseIterable, Sendable`

### Enumeration Constants
*   **unknown**: Unknown or invalid device type
*   **rayBanMeta**: Ray-Ban Meta
*   **oakleyMetaHSTN**: Oakley Meta HSTN
*   **oakleyMetaVanguard**: Oakley Meta Vanguard
*   **metaRayBanDisplay**: Meta Ray-Ban Display
```

--------------------------------

### Set Camera Feed from Video URL - Swift

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatmockdevice_mockcamerakit

Sets the camera feed for mocking purposes using a video file URL. This function supports h.265 codecs and requires a URL object pointing to the video stream file.

```swift
public func setCameraFeed( fileURL: URL)
```

--------------------------------

### RegistrationError Enum

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_registrationerror

Details the possible error conditions that can occur during the registration process for wearables.

```APIDOC
## RegistrationError Enum

### Description
Error conditions that can occur during the registration process.

### Signature
```swift
enum RegistrationError: Int, Error
```

### Enumeration Constants
| Member            | Description                                                                                  |
|-------------------|----------------------------------------------------------------------------------------------|
| alreadyRegistered | User is already registered when attempting to register again.                                  |
| alreadyUnregistered | User is already unregistered when attempting to unregister again.                              |
| configurationInvalid | The Wearables Device Access Toolkit configuration is invalid or incomplete.                  |
| failedToRegister  | Registration process failed for an unspecified reason.                                       |
| failedToUnregister| Unregistration process failed for an unspecified reason.                                     |
| metaAINotInstalled| The Meta AI app is not installed on the device, which is required for registration.          |
| unknown           | An unknown error occurred during the registration process.                                   |

### Properties
#### description
- **description** (Get) - Provides a human-readable description of the registration error.
```

--------------------------------

### Permission Enum

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_permission

Represents the types of permissions that can be requested from AI glasses.

```APIDOC
## Permission Enum

### Description
Represents the types of permissions that can be requested from AI glasses.

### Method
N/A (Enum definition)

### Endpoint
N/A (Enum definition)

### Parameters
N/A (Enum definition)

### Request Example
N/A (Enum definition)

### Response
#### Enumeration Constants
- **camera** (Permission) - Permission to access camera functionality on the connected wearable device.
```

--------------------------------

### Add Compatibility Listener - Swift

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_device

Adds a listener to receive asynchronous notifications whenever the device's compatibility status changes. This function returns a token that can be used to later cancel the listener subscription.

```swift
public func addCompatibilityListener(_ listener: @escaping @Sendable (Compatibility) -> Void) -> AnyListenerToken
```

--------------------------------

### StreamingResolution Enum

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcamera_streamingresolution

Defines valid live streaming resolutions using a 9:16 aspect ratio.

```APIDOC
## StreamingResolution Enum

Valid Live Streaming resolutions. We are using 9:16 aspect ratio. 720x1280(high), 576x1024, 540x960(medium), 432x768, 360x640(low)

### Signature
```swift
enum StreamingResolution: CaseIterable
```

## Enumeration Constants
| Member | Description |
|---|---|
| high | High resolution streaming at 720x1280 pixels. |
| medium | Medium resolution streaming at 504x896 pixels. |
| low | Low resolution streaming at 360x640 pixels. |

### Properties
* **videoFrameSize** [Get] | The video frame dimensions for this resolution.
```

--------------------------------

### Fetch Device for Identifier Swift

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_wearablesinterface

Fetches the underlying Device object for a given DeviceIdentifier. Returns the Device object for the given device identifier, or nil if not found.

```swift
public func deviceForIdentifier(_ identifier: DeviceIdentifier) -> Device?
```

--------------------------------

### MockDeviceKitError Enum

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatmockdevice_mockdevicekiterror

Enumerates errors that can occur when using the MockDeviceKit framework, providing specific error types for various scenarios.

```APIDOC
## enum MockDeviceKitError: Error

### Description
Errors that can occur when using MockDeviceKit.

### Enumeration Constants
- **unknown**: A generic unknown error occurred.
```

--------------------------------

### Check Device Compatibility - Swift

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_device

Determines if the current version of the device is compatible with the Wearables Device Access Toolkit. This function returns a `Compatibility` enum value indicating the compatibility status.

```swift
public func compatibility() -> Compatibility
```

--------------------------------

### VideoFrameSize Struct

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcamera_videoframesize

Represents the width and height of a video frame in pixels.

```APIDOC
## VideoFrameSize Struct

### Description
Represents the width and height of a video frame in pixels.

### Signature
```
struct VideoFrameSize
```

### Constructors
#### init(width:height:)
Creates a new video frame size with the specified dimensions.

##### Parameters
- **width** (UInt) - The width of the video frame in pixels.
- **height** (UInt) - The height of the video frame in pixels.

### Properties
- **height** (UInt) - The height of the video frame in pixels.
- **width** (UInt) - The width of the video frame in pixels.
```

--------------------------------

### Add Link State Listener - Swift

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_device

Registers a callback function to be executed when the device's connection state changes. The returned `AnyListenerToken` can be used to unsubscribe from these notifications.

```swift
public func addLinkStateListener(_ listener: @escaping @Sendable (LinkState) -> Void) -> AnyListenerToken
```

--------------------------------

### Accessing Available Devices via WearablesInterface

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_wearablesinterface

This snippet demonstrates how to access the list of currently available wearable devices through the 'devices' property of the WearablesInterface protocol. This property is read-only.

```swift
extension WearablesInterface {
    // The current list of devices available.
    var devices: [Device] { get }
}
```

--------------------------------

### Initialize AutoDeviceSelector

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_autodeviceselector

Creates an auto device selector that monitors the given wearables interface for device changes. It requires an instance of WearablesInterface.

```swift
public init(wearables: WearablesInterface)
```

--------------------------------

### Add Registration State Listener Swift

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_wearablesinterface

Adds a listener to receive callbacks when the registration state changes. The listener is immediately called with the current state. A token is returned to cancel the listener.

```swift
public func addRegistrationStateListener(_ listener: @escaping (RegistrationState) -> Void) -> AnyListenerToken
```

--------------------------------

### PhotoData Struct

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcamera_photodata

Represents a photo captured from a Meta Wearables device, including its data and format.

```APIDOC
## PhotoData Struct

### Description
A photo captured from a Meta Wearables device.

### Signature
```
struct PhotoData: Sendable
```

### Constructors
#### init(data: Data, format: PhotoCaptureFormat)
Initializes a PhotoData object.

- **data** (Data) - The photo data in the specified format.
- **format** (PhotoCaptureFormat) - The format of the captured photo data.

### Properties
- **data** (Data) - The photo data in the specified format.
- **format** (PhotoCaptureFormat) - The format of the captured photo data.
```

--------------------------------

### Permission Enum for AI Glasses

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_permission

Defines the types of permissions that can be requested from AI glasses. This enumeration extends Sendable and represents distinct permission types.

```swift
enum Permission : Sendable {
    case camera
}
```

--------------------------------

### Announcer Protocol

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_announcer

Defines a protocol for objects that can announce events to registered listeners, allowing for event-driven communication.

```APIDOC
## Announcer Protocol

### Description
A protocol for objects that can announce events to registered listeners.

### Method
N/A (Protocol Definition)

### Endpoint
N/A

### Parameters
N/A

### Functions
#### listen
Registers a listener for events of type T.

- **listener** (@escaping (T) -> Void) - Required - The callback to execute when an event occurs.

### Returns
- **AnyListenerToken** - A token that can be used to cancel the listener.

### Request Example
```swift
// Assuming 'announcer' is an instance conforming to Announcer
let token = announcer.listen { event in
    // Handle the event
    print(event)
}
```

### Response
#### Success Response (N/A for Protocol Method)
N/A

#### Response Example
```swift
// The 'listen' function returns an AnyListenerToken
// Example of canceling the listener:
token.cancel()
```
```

--------------------------------

### Announcer Protocol Listen Function - Swift

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_announcer

Implements the listen function within the Announcer protocol. This function registers a callback to be executed when an event occurs and returns a token for managing the listener.

```swift
public func listen(_ listener: @escaping (T) -> Void) -> AnyListenerToken
```

--------------------------------

### Check Permission Status API

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_wearablesinterface

Checks if a specific permission is granted for the current application.

```APIDOC
## POST /websites/wearables_developer_meta_reference_ios_swift_dat_0_2/checkPermissionStatus

### Description
Checks if a specific permission is granted for the current application.

### Method
POST

### Endpoint
/websites/wearables_developer_meta_reference_ios_swift_dat_0_2/checkPermissionStatus

### Parameters
#### Path Parameters
- **permission** (Permission) - Required - The type of permission to check.

### Response
#### Success Response (200)
- **PermissionStatus** (PermissionStatus) - The status of the permission.

### Response Example
{
  "example": "PermissionStatus"
}

#### Error Response
- **PermissionError** - Thrown if the operation fails.
```

--------------------------------

### Checking Device Registration State via WearablesInterface

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_wearablesinterface

This snippet shows how to retrieve the current registration state of the user's wearable devices using the 'registrationState' property of the WearablesInterface protocol. Refer to the RegistrationState enumeration for possible values. This property is read-only.

```swift
extension WearablesInterface {
    // The current registration state of the user's devices. See RegistrationState for options.
    var registrationState: RegistrationState { get }
}
```

--------------------------------

### PermissionError Enum

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_permissionerror

Details the `PermissionError` enumeration, which represents various errors that can occur when requesting permissions for wearable devices. It extends `Int`, `Error`, and `Sendable`.

```APIDOC
## PermissionError Enum

### Description
Errors that can occur during permission requests.

### Method
N/A (Enum Definition)

### Endpoint
N/A (Enum Definition)

### Parameters
N/A (Enum Definition)

### Request Example
N/A (Enum Definition)

### Response
#### Success Response (N/A)

#### Response Example
N/A (Enum Definition)

### Enumeration Constants
Member| Description
---|---
noDevice| No wearable devices have been discovered or registered.
noDeviceWithConnection| All discovered devices are powered off or disconnected.
connectionError| A connection error occurred while communicating with the device.
companionAppNotInstalled| The Meta AI companion app is not installed on the device.
requestInProgress| A permission request is already in progress.
requestTimeout| The permission request exceeded the allowed time limit.
internalError| An unexpected internal error occurred.
```

--------------------------------

### DeviceStateSession Class

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_devicestatesession

Manages a session for monitoring device state changes.

```APIDOC
## DeviceStateSession Class

### Description
Manages a session for monitoring device state changes. 

### Signature
```swift
class DeviceStateSession
```

### Constructors
#### init(deviceSelector: DeviceSelector)
Initializes a new DeviceStateSession.

- **deviceSelector** (DeviceSelector) - Required - The selector for the device to monitor.

### Properties
#### state
- **state** (DeviceSessionState) - The current state of the device session.

### Functions
#### start()
Starts the device state session. Begins monitoring the selected device for state changes.

#### stop()
Stops the device state session. Releases resources and stops monitoring device state changes.
```

--------------------------------

### DeviceIdentifier Type Alias

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_deviceidentifier

Defines a unique identifier for a Meta Wearables device, represented as a String.

```APIDOC
## DeviceIdentifier Type Alias

### Description
A unique identifier for a Meta Wearables device.

### Method
N/A (Type Alias)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (N/A)
- **DeviceIdentifier** (String) - A unique string identifying a Meta Wearables device.

#### Response Example
N/A
```

--------------------------------

### StreamSessionConfig Properties (Swift)

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcamera_streamsessionconfig

Defines the properties for configuring a media streaming session. These include the target frame rate, the resolution for video content, and the video codec to be used during streaming.

```swift
var frameRate: UInt

```

```swift
var resolution: StreamingResolution

```

```swift
var videoCodec: VideoCodec

```

--------------------------------

### VideoCodec Enum

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcamera_videocodec

Specifies the video codec to use for streaming. This enum defines the available options for video compression and transmission.

```APIDOC
## VideoCodec Enum

### Description
Specifies the video codec to use for streaming.

### Method
N/A (Enum Definition)

### Endpoint
N/A (Enum Definition)

### Parameters
N/A (Enum Definition)

### Request Example
N/A (Enum Definition)

### Response
#### Success Response (N/A)
This is an enumeration definition, not an endpoint that returns data.

#### Response Example
N/A (Enum Definition)

### Enumeration Constants
- **raw** (VideoCodec) - Raw decompressed video frames.
```

--------------------------------

### RegistrationError Enum Definition in Swift

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_registrationerror

Defines the possible error conditions that can occur during the device registration process for the Wearables Device Access Toolkit. It extends Int and Error protocols, providing a human-readable description for each error.

```swift
enum RegistrationError: Int, Error {
    case alreadyRegistered
    case alreadyUnregistered
    case configurationInvalid
    case failedToRegister
    case failedToUnregister
    case metaAINotInstalled
    case unknown

    var description: String {
        switch self {
        case .alreadyRegistered:
            return "User is already registered when attempting to register again."
        case .alreadyUnregistered:
            return "User is already unregistered when attempting to unregister again."
        case .configurationInvalid:
            return "The Wearables Device Access Toolkit configuration is invalid or incomplete."
        case .failedToRegister:
            return "Registration process failed for an unspecified reason."
        case .failedToUnregister:
            return "Unregistration process failed for an unspecified reason."
        case .metaAINotInstalled:
            return "The Meta AI app is not installed on the device, which is required for registration."
        case .unknown:
            return "An unknown error occurred during the registration process."
        }
    }
}
```

--------------------------------

### StreamSessionConfig Struct

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcamera_streamsessionconfig

Configuration for a media streaming session with a Meta Wearables device. Defines video codec, resolution, frame delivery strategy, and target frame rate.

```APIDOC
## StreamSessionConfig

### Description
Configuration for a media streaming session with a Meta Wearables device. Defines video codec, resolution, frame delivery strategy, and target frame rate.

### Method
N/A (Struct Definition)

### Endpoint
N/A (Struct Definition)

### Parameters
N/A (Struct Definition)

### Request Example
N/A (Struct Definition)

### Response
N/A (Struct Definition)

## Constructors

### init(videoCodec:resolution:frameRate:)

#### Description
Creates a new stream session configuration with specified parameters.

#### Parameters
- **videoCodec** (VideoCodec) - Required - The video codec to use for streaming.
- **resolution** (StreamingResolution) - Required - The resolution for video streaming.
- **frameRate** (UInt) - Required - The target frame rate for streaming.

### init()

#### Description
Creates a new stream session configuration with default settings. Uses raw video codec, medium resolution, deliver-all frame strategy, and 30 FPS.

#### Parameters
None

## Properties

### frameRate

#### Description
The target frame rate for the streaming session.

#### Type
UInt

### resolution

#### Description
The resolution at which to stream video content.

#### Type
StreamingResolution

### videoCodec

#### Description
The video codec to use for streaming.

#### Type
VideoCodec
```

--------------------------------

### Check Permission Status Swift

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_wearablesinterface

Checks if a specific permission is granted for the current application. Returns the status of the permission. Throws PermissionError if the operation fails.

```swift
public func checkPermissionStatus(_ permission: Permission) -> PermissionStatus
```

--------------------------------

### VideoFrame Struct Definition and Conversion to UIImage (Swift)

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcamera_videoframe

This snippet shows the definition of the VideoFrame struct and its makeUIImage() function. The VideoFrame struct represents a single frame of video data and provides access to the underlying CoreMedia sample buffer. The makeUIImage() function converts this frame into a UIImage, handling potential conversion failures.

```swift
struct VideoFrame: Sendable {
    var sampleBuffer: CMSampleBuffer

    func makeUIImage() -> UIImage?
}
```

--------------------------------

### LinkState Enum

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_linkstate

Represents the connection state between a device and the Wearables Device Access Toolkit.

```APIDOC
## LinkState Enum

### Description
Represents the connection state between a device and the Wearables Device Access Toolkit.

### Signature
```swift
enum LinkState: Equatable, Sendable
```

### Enumeration Constants
- **disconnected**: The device is not connected to the Wearables Device Access Toolkit.
- **connecting**: The device is currently attempting to establish a connection with the Wearables Device Access Toolkit.
- **connected**: The device is successfully connected and ready for communication.
```

--------------------------------

### DeviceType Enum Definition (Swift)

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_devicetype

Defines the enumeration for different types of Meta Wearables devices supported by the Wearables Device Access Toolkit. Each member represents a specific hardware variant with its own set of capabilities. The enum extends String, CaseIterable, and Sendable for interoperability and iteration.

```swift
enum DeviceType: String, CaseIterable, Sendable {
    case unknown
    case rayBanMeta
    case oakleyMetaHSTN
    case oakleyMetaVanguard
    case metaRayBanDisplay
}
```

--------------------------------

### Add Devices Listener Swift

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_wearablesinterface

Adds a listener to receive callbacks when the device list changes. The listener is immediately called with the current devices. A token is returned to cancel the listener.

```swift
public func addDevicesListener(_ listener: @escaping ([DeviceIdentifier]) -> Void) -> AnyListenerToken
```

--------------------------------

### WearablesError Enum

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_wearableserror

Details about the WearablesError enumeration, which lists errors that can occur during Device Access Toolkit configuration.

```APIDOC
## WearablesError Enum

### Description
Errors that can occur during Device Access Toolkit configuration.

### Signature
```swift
enum WearablesError: Int, Error
```

### Enumeration Constants
| Member          | Description                                                          |
|-----------------|----------------------------------------------------------------------|
| internalError   | An unexpected internal error occurred during configuration.            |
| alreadyConfigured | The Device Access Toolkit has already been configured.               |
| configurationError | The configuration provided is invalid or incomplete.                 |

### Properties
| Name        | Description                                                          |
|-------------|----------------------------------------------------------------------|
| description | [Get] Returns a string description of the error.                     |
```

--------------------------------

### Cancel Listener Subscription - Swift

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_anylistenertoken

The `cancel()` function is part of the `AnyListenerToken` protocol. It allows for the asynchronous cancellation of a listener subscription. The subscription is automatically canceled when the token is no longer referenced.

```swift
public func cancel()

```

--------------------------------

### Add Device Session State Listener Swift

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_wearablesinterface

Adds a listener to receive callbacks when the session state changes for a specific device. The listener is immediately called with the current session state. A token is returned to cancel the listener.

```swift
public func addDeviceSessionStateListener( forDeviceId: DeviceIdentifier, listener: @escaping (SessionState) -> Void) -> AnyListenerToken
```

--------------------------------

### DeviceState Struct

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_devicestate

Represents the current state of a Meta Wearables device, including battery and hinge information.

```APIDOC
## DeviceState Struct

### Description
Represents the current state of a Meta Wearables device, including battery and hinge information.

### Method
N/A (Struct definition)

### Endpoint
N/A (Struct definition)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A

## Properties
**batteryLevel** (Int) - The current battery level of the device as a percentage (0-100).
**hingeState** (HingeState) - The current state of the device's hinge mechanism.
```

--------------------------------

### MockDeviceKitError Enum Definition

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatmockdevice_mockdevicekiterror

Defines the MockDeviceKitError enumeration, which extends the Error protocol. This enumeration represents various errors that can occur during the usage of MockDeviceKit functionalities. It includes a generic 'unknown' error.

```swift
enum MockDeviceKitError: Error {
  case unknown
}
```

--------------------------------

### DeviceIdentifier Type Alias Definition (Swift)

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_deviceidentifier

Defines a type alias named DeviceIdentifier as a String. This is used to uniquely identify a Meta Wearables device within the system. No external dependencies are required for this basic type definition.

```swift
public typealias DeviceIdentifier = String
```

--------------------------------

### Device Class

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_device

Represents an AI glasses device accessible through the Wearables Device Access Toolkit.

```APIDOC
## Device Class

AI glasses accessible through the Wearables Device Access Toolkit.

### Description
This class represents an individual AI glasses device and provides methods to interact with its properties and functionalities.

### Signature
```swift
class Device
```

### Constructors
#### `init(devicePrivate: DevicePrivate)`
Initializes a new `Device` instance.

- **devicePrivate** (DevicePrivate) - The private device object.

### Properties
- **identifier** (String) - The unique identifier for this device.
- **linkState** (LinkState) [Get] - The current connection state of the device.
- **name** (String) - The human-readable device name, or an empty string if unavailable.

### Functions
#### `addCompatibilityListener(_ listener: @escaping @Sendable (Compatibility) -> Void) -> AnyListenerToken`
Adds a listener to receive notifications when the device's compatibility changes.

- **listener** (@escaping @Sendable (Compatibility) -> Void) - The callback to execute when the compatibility changes.
- **Returns**: `AnyListenerToken` - A token that can be used to cancel the listener.

#### `addLinkStateListener(_ listener: @escaping @Sendable (LinkState) -> Void) -> AnyListenerToken`
Adds a listener to receive notifications when the device's link state changes.

- **listener** (@escaping @Sendable (LinkState) -> Void) - The callback to execute when the link state changes.
- **Returns**: `AnyListenerToken` - A token that can be used to cancel the listener.

#### `compatibility() -> Compatibility`
Returns `true` if the version of this device is compatible with the Wearables Device Access Toolkit.

- **Returns**: `Compatibility` - The compatibility status.

#### `deviceType() -> DeviceType`
Returns the type of this device (e.g., Ray-Ban Meta).

- **Returns**: `DeviceType` - The device type identifier.

#### `nameOrId() -> String`
Returns the device name if available, otherwise returns the device identifier. This provides a fallback for display purposes when the device name is not set.

- **Returns**: `String` - The device name or identifier as a fallback.
```

--------------------------------

### Announcer Protocol Definition - Swift

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_announcer

Defines the Announcer protocol for objects that can announce events to registered listeners. It includes a function to register listeners for specific event types.

```swift
protocol Announcer {
  func listen<T>(_ listener: @escaping (T) -> Void) -> AnyListenerToken
}
```

--------------------------------

### LinkState Enum Definition (Swift)

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_linkstate

Defines the connection state between a device and the Wearables Device Access Toolkit. This enumeration extends Equatable and Sendable protocols.

```swift
enum LinkState: Equatable, Sendable {
    case disconnected
    case connecting
    case connected
}
```

--------------------------------

### PermissionError Enum Definition (Swift)

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_permissionerror

Defines the `PermissionError` enumeration, which represents errors that can occur during permission requests in the Wearables SDK. It extends `Int`, `Error`, and `Sendable` for robust error handling. Common errors include cases like `noDevice`, `connectionError`, and `companionAppNotInstalled`.

```swift
enum PermissionError: Int, Error, Sendable {
    case noDevice
    case noDeviceWithConnection
    case connectionError
    case companionAppNotInstalled
    case requestInProgress
    case requestTimeout
    case internalError
}
```

--------------------------------

### Swift: DeviceSelector Protocol Definition

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_deviceselector

Defines the DeviceSelector protocol used for selecting devices. It includes a property for the active device and a function to stream changes to the active device.

```swift
protocol DeviceSelector {
    var activeDevice: DeviceIdentifier? { get }
    func activeDeviceStream() -> AnyAsyncSequence<DeviceIdentifier?>
}
```

--------------------------------

### SessionState Enum Definition and Constants (Swift)

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcore_sessionstate

Defines the SessionState enumeration, representing the current state of a device session. It includes constants like stopped, waitingForDevice, running, paused, and unknown, each with a brief description. This enum extends Int and Sendable for interoperability and thread safety.

```swift
enum SessionState: Int, Sendable {
    case stopped
    case waitingForDevice
    case running
    case paused
    case unknown
}
```

--------------------------------

### StreamingResolution Enum Definition - Swift

Source: https://wearables.developer.meta.com/docs/reference/ios_swift/dat/0.2/mwdatcamera_streamingresolution

Defines the available live streaming resolutions for the wearables device, adhering to a 9:16 aspect ratio. It includes high, medium, and low resolutions with corresponding pixel dimensions and provides a computed property for video frame size.

```swift
enum StreamingResolution: CaseIterable {
    case high
    case medium
    case low

    var videoFrameSize: VideoFrameSize { ... }
}
```
Tokens:
Raw