The payload that configures AirPlay settings.
| Setting | Type | Required | Default | Manual Install | Supported OS |
|---|---|---|---|---|---|
AllowList AllowList If present, only AirPlay destinations in this list are available to the device. This allow list applies to supervised devices. 1 subkey | array | optional | — | ✓Yes | iOS (14.5+)macOS (11.3+) |
└─ AllowList Content Item AllowListItem 2 subkeys | dictionary | required | — | ✓Yes | iOS (7.0+)macOS (10.10+) |
└─ └─ Device ID DeviceID Deprecated (iOS 18.0, macOS 15.0) The device ID of the AirPlay destination in the format `xx:xx:xx:xx:xx:xx`. This field isn't case-sensitive.
The system limits the list of visible AirPlay destinations to devices that are present in the `AllowList` field of all installed AirPlay payloads.
Specifying the same MACAddress more than once, whether in the same payload across different payloads, results in undefined behavior.
As of tvOS 18, `DeviceID` isn't supported. | string | optional | — | ✓Yes | iOS (legacy - 18.0)macOS (legacy - 15.0) |
└─ └─ Device Name DeviceName The name of the AirPlay device.
The system limits the list of visible AirPlay destinations to devices that are present in the `AllowList` field of all installed AirPlay payloads. | string | optional | — | ✓Yes | iOS (18.0+)macOS (15.0+) |
Passwords Passwords If present, sets passwords for known AirPlay destinations. Using multiple entries for the same destination, whether within the same payload or across multiple installed payloads, is an error and results in undefined behavior. 1 subkey | array | optional | — | ✓Yes | iOS (7.0+)macOS (10.10+) |
└─ Password Content Item PasswordsItem 3 subkeys | dictionary | required | — | ✓Yes | iOS (7.0+)macOS (10.10+) |
└─ └─ Device Name DeviceName The name of the AirPlay destination; used in iOS, and available in macOS 15 and later. | string | optional | — | ✓Yes | macOS (15.0+) |
└─ └─ Password Password The password for the AirPlay destination. | string | required | — | ✓Yes | iOS (7.0+)macOS (10.10+) |
└─ └─ DeviceID DeviceID Deprecated (macOS 15.0) The device ID of the AirPlay destination; used in macOS.
Deprecated in macOS 15 and later as tvOS 18 AirPlay destinations don't support it; use `DeviceName` instead. | string | optional | — | ✓Yes | macOS (legacy - 15.0) |
Whitelist Whitelist Deprecated (iOS 14.5, macOS 11.3) Use `AllowList` instead. This key is deprecated in iOS 14.5 and macOS 11.3. 1 subkey | array | optional | — | ✓Yes | iOS (legacy - 14.5)macOS (legacy - 11.3) |
└─ AllowList Content Item AllowListItem 2 subkeys | dictionary | required | — | ✓Yes | iOS (7.0+)macOS (10.10+) |
└─ └─ Device ID DeviceID Deprecated (iOS 18.0, macOS 15.0) The device ID of the AirPlay destination in the format `xx:xx:xx:xx:xx:xx`. This field isn't case-sensitive.
The system limits the list of visible AirPlay destinations to devices that are present in the `AllowList` field of all installed AirPlay payloads.
Specifying the same MACAddress more than once, whether in the same payload across different payloads, results in undefined behavior.
As of tvOS 18, `DeviceID` isn't supported. | string | optional | — | ✓Yes | iOS (legacy - 18.0)macOS (legacy - 15.0) |
└─ └─ Device Name DeviceName The name of the AirPlay device.
The system limits the list of visible AirPlay destinations to devices that are present in the `AllowList` field of all installed AirPlay payloads. | string | optional | — | ✓Yes | iOS (18.0+)macOS (15.0+) |
