Files
Cyrus Daboo 97a11a861f Seed2
2026-06-22 15:55:19 -04:00

90 lines
3.1 KiB
YAML

title: Audio Accessory:Settings
description: The declaration to configure audio accessory settings.
payload:
declarationtype: com.apple.configuration.audio-accessory.settings
supportedOS:
iOS:
introduced: '26.0'
allowed-enrollments:
- supervised
allowed-scopes:
- system
sharedipad:
allowed-scopes:
- system
macOS:
introduced: n/a
tvOS:
introduced: n/a
visionOS:
introduced: n/a
watchOS:
introduced: n/a
apply: combined
payloadkeys:
- key: TemporaryPairing
title: Temporary pairing
type: <dictionary>
presence: optional
content: A dictionary that describes audio accessory temporary pairing behavior.
The device enables temporary pairing when this key is present and the `Disabled`
key isn't `false`. The device doesn't synchronize pairing information with iCloud
when temporary pairing is active.
subkeys:
- key: Disabled
title: Temporary pairing disabled
type: <boolean>
presence: optional
default: false
combinetype: boolean-or
content: If `true`, temporary pairing of audio accessories is disabled.
- key: Configuration
title: Temporary pairing configuration
type: <dictionary>
presence: optional
combinetype: first
content: A dictionary providing configuration for temporary pairing. Required
if `Disabled` isn't present or is `false`.
subkeys:
- key: UnpairingTime
title: Temporary pairing unpairing time
type: <dictionary>
presence: required
content: A dictionary that describes when the device automatically unpairs temporarily
paired audio accessories.
subkeys:
- key: Policy
title: Unpairing policy
type: <string>
presence: required
rangelist:
- None
- Hour
content: |-
A string that specifies the device's unpairing policy.
- `None`: The device doesn't automatically unpair. Use this only with a return to service device that you erase and reenroll when assigning it from one user to another.
- `Hour`: The device automatically unpairs temporarily paired audio accessories at the local time that the `Hour` key specifies.
- key: Hour
title: Hour of unpairing
type: <integer>
presence: optional
range:
min: 0
max: 23
content: The local time hour (24-hour clock) when the device automatically
unpairs temporarily paired audio accessories. Required when setting the
`Policy` key to `Hour`.
notes:
- title: ''
content: |-
Setting `TemporaryPairing` to `false` disables only the temporary pairing feature, without impacting any other use of audio accessories, so users can still:
- Pair and use audio accessories - the device records the pairing and synchronizes it to their iCloud account.
- Use the audio accessory AirPods Sharing feature.
examples:
- title: Configuration example
files:
- description: This configuration enables temporary pairing and sets an unpairing
time of 6 pm.
file: examples/declarative/declarations/configurations/audio-accessory.settings/example1.json