### Open Personal Voice Accessibility Setting Source: https://developer.apple.com/documentation/accessibility/accessibilitysettings/opensettings%28for%3A%29 This example demonstrates how to use `AccessibilitySettings.openSettings(for:)` within a SwiftUI alert to guide users to the 'Personal Voice > Allow Apps to Request to Use' setting. It includes error handling for the asynchronous operation. ```swift ContentView() .alert( "Use Personal Voice", isPresented: $showAlert ) { Button("Open Accessibility Settings") { Task { do { try await AccessibilitySettings.openSettings(for: .personalVoiceAllowAppsToRequestToUse) } catch { print("Error: \(error)") } } } Button("Cancel", role: .cancel) { } } message: { Text("To use this feature, turn on the Personal Voice > Allow Apps to Request to Use setting.") } ``` -------------------------------- ### Example byte buffer for 'hello' in UEB Source: https://developer.apple.com/documentation/accessibility/braille-hid-reference-for-connecting-to-apple-platforms A decimal representation of the byte buffer for the word 'hello' in Unified English Braille. ```text { 19, 17, 7, 7, 21, 0 } ``` -------------------------------- ### Start Live Audio Graph Session Source: https://developer.apple.com/documentation/accessibility/axliveaudiograph/start%28%29 Call this class method to begin a live audio graph session. Ensure your project has JavaScript enabled to view this content. ```swift class func start() ``` -------------------------------- ### Populate Router Button Input Report Source: https://developer.apple.com/documentation/accessibility/braille-hid-reference-for-connecting-to-apple-platforms Example of setting the bitmask for the third router button in an input report. ```C BrailleInputReport report; bzero(&report, sizeof(report)); report.routerButtons = 1 << 3; ``` -------------------------------- ### Populate Braille Key Input Report Source: https://developer.apple.com/documentation/accessibility/braille-hid-reference-for-connecting-to-apple-platforms Example of setting the bitmask for specific braille keys (1, 2, and 5) in an input report. ```C BrailleInputReport report; bzero(&report, sizeof(report)); report.brailleKeys = (1 << 0) | (1 << 1) | (1 << 4); ``` -------------------------------- ### AXCustomContent Initializer: init(coder:) Source: https://developer.apple.com/documentation/accessibility/axcustomcontent/init%28coder%3A%29 Initializes a new instance of AXCustomContent using a decoder. This initializer is available on iOS, iPadOS, Mac Catalyst, macOS, tvOS, visionOS, and watchOS starting from specific versions. ```APIDOC ## Initializer: init?(coder: NSCoder) ### Description Initializes a new instance of AXCustomContent using a decoder. This is a failable initializer. ### Availability - iOS 14.0+ - iPadOS 14.0+ - Mac Catalyst 14.0+ - macOS 11.0+ - tvOS 14.0+ - visionOS 1.0+ - watchOS 7.0+ ### Method Signature ```swift init?(coder: NSCoder) ``` ### See Also - Creating custom content: - `convenience init(attributedLabel: NSAttributedString, attributedValue: NSAttributedString)` - `convenience init(label: String, value: String)` ``` -------------------------------- ### Retrieve and Connect to Hearing Device Peripherals Source: https://developer.apple.com/documentation/accessibility/axmfihearingdevice/paireddeviceidentifiers%28%29 This example shows how to obtain the UUIDs of paired hearing devices, retrieve the corresponding `CBPeripheral` objects, and attempt to connect to them if they are not already connected. This requires a `bluetoothManager` instance. ```swift let uuids = AXMFiHearingDevice.pairedDeviceIdentifiers() let peripherals = bluetoothManager.retrievePeripherals(withIdentifiers: uuids) for peripheral in peripherals where peripheral.state == .connected { bluetoothManager.connect(peripheral) } ``` -------------------------------- ### AXLiveAudioGraph - Controlling Playback Source: https://developer.apple.com/documentation/accessibility/axliveaudiograph Methods for starting and stopping the live audio graph session. ```APIDOC ## AXLiveAudioGraph - Controlling Playback ### Description Methods for starting and stopping the live audio graph session. ### Methods #### `start()` Begins the live audio graph session. #### `stop()` Ends the live audio graph session. ``` -------------------------------- ### Initiate an Accessibility Override Session Source: https://developer.apple.com/documentation/accessibility/axfeatureoverridesessionmanager/beginoverridesession%28enabling%3Adisabling%3A%29 Use this method to start a session that manages accessibility feature overrides. It requires iOS 18.2 or iPadOS 18.2 or later. ```swift func beginOverrideSession( enabling enableOptions: AXFeatureOverrideSession.Options = [], disabling disableOptions: AXFeatureOverrideSession.Options = [] ) throws -> AXFeatureOverrideSession ``` -------------------------------- ### Check if Assistive Access is Enabled (Static) Source: https://developer.apple.com/documentation/accessibility/assistive-access Use this static property to determine if Assistive Access is currently running on the device. No setup is required. ```swift static var isAssistiveAccessEnabled: Bool ``` -------------------------------- ### AXChartDescriptor Initializer Source: https://developer.apple.com/documentation/accessibility/axchartdescriptor/contentdirection-swift.enum/init%28rawvalue%3A%29 Initializes a new instance of `AXChartDescriptor` with a given raw integer value. This initializer is available on multiple Apple platforms starting from specific OS versions. ```APIDOC ## init(rawValue:) ### Description Initializes a new instance of `AXChartDescriptor` with a given raw integer value. ### Method `init?(rawValue: Int)` ### Availability iOS 15.0+ iPadOS 15.0+ Mac Catalyst 15.0+ macOS 12.0+ tvOS 15.0+ visionOS 1.0+ watchOS 8.0+ ### Parameters #### Path Parameters - **rawValue** (Int) - Required - The raw integer value to initialize the descriptor with. ``` -------------------------------- ### init() Source: https://developer.apple.com/documentation/accessibility/accessibilitysettings/init%28%29 Initializes the Accessibility framework. ```APIDOC ## init() ### Description Initializes the Accessibility framework. ### Availability - iOS 14.0+ - iPadOS 14.0+ - Mac Catalyst 14.0+ - macOS 11.0+ - tvOS 14.0+ - visionOS 1.0+ - watchOS 7.0+ ### Syntax ```swift init() ``` ``` -------------------------------- ### Get Paired Hearing Device Identifiers Source: https://developer.apple.com/documentation/accessibility/axmfihearingdevice/paireddeviceidentifiers%28%29 Call this static method to get an array of UUIDs for paired hearing device peripherals. Ensure your app has the `hearing.aid.app` entitlement configured. ```swift static func pairedDeviceIdentifiers() -> [UUID] ``` -------------------------------- ### Get Head Anchor Alternative Notification Name Source: https://developer.apple.com/documentation/accessibility/accessibilitysettings/prefersheadanchoralternativedidchangenotification Use this notification to detect changes in the system setting for head-anchored content. Call `prefersHeadAnchorAlternative` to get the new setting when this notification is received. ```swift static var prefersHeadAnchorAlternativeDidChangeNotification: Notification.Name { get } ``` -------------------------------- ### init(rawValue:) Source: https://developer.apple.com/documentation/accessibility/axmfihearingdevice/ear/init%28rawvalue%3A%29 Initializes a new instance of AXMFiHearingDevice.Ear with a provided raw value. ```APIDOC ## init(rawValue:) ### Description Creates a structure that represents a hearing device ear with the raw value you specify. ### Parameters #### Request Body - **rawValue** (UInt) - Required - The raw value used to initialize the hearing device ear structure. ### Request Example ```swift let ear = AXMFiHearingDevice.Ear(rawValue: 1) ``` ``` -------------------------------- ### Define App UI for Assistive Access Scene Source: https://developer.apple.com/documentation/accessibility/optimizing-your-app-for-assistive-access Adopt the `AssistiveAccess` scene type to provide a streamlined UI when Assistive Access is enabled. This example shows how to define a custom view hierarchy with fewer onscreen elements for this specific scene. ```swift import SwiftUI @main struct ExampleApp: App { var body: some Scene { // Defines the default app UI. WindowGroup { StandardContentView() } // Defines the app UI when Assistive Access is on. AssistiveAccess { AssistiveAccessContentView() } } } ``` -------------------------------- ### init(content:) Source: https://developer.apple.com/documentation/accessibility/axmathexpressiontext/init%28content%3A%29 Initializes an AXMathExpressionText instance with the provided string content. ```APIDOC ## init(content:) ### Description Initializes a new AXMathExpressionText object using the specified string content. ### Parameters #### Request Body - **content** (String) - Required - The string content for the math expression. ### Request Example ```swift let expression = AXMathExpressionText(content: "x^2 + y^2 = z^2") ``` ``` -------------------------------- ### Get and Set the Data Series Name Source: https://developer.apple.com/documentation/accessibility/axdataseriesdescriptor/name Use this property to get or set the name of the data series. Available on iOS 15.0+, iPadOS 15.0+, macOS 12.0+, tvOS 15.0+, and visionOS 1.0+. ```swift var name: String? { get set } ``` -------------------------------- ### init(expressions:open:close:) Source: https://developer.apple.com/documentation/accessibility/axmathexpressionfenced/init%28expressions%3Aopen%3Aclose%3A%29 Initializes a new fenced math expression with the specified expressions and delimiter strings. ```APIDOC ## init(expressions:open:close:) ### Description Initializes a new AXMathExpressionFenced instance with a collection of expressions and specified opening and closing delimiters. ### Method Initializer ### Parameters #### Arguments - **expressions** ([AXMathExpression]) - Required - The list of expressions to be enclosed. - **open** (String) - Required - The string representing the opening delimiter. - **close** (String) - Required - The string representing the closing delimiter. ### Request Example init(expressions: [expression1, expression2], open: "(", close: ")") ``` -------------------------------- ### Get and Set Chart Content Direction Source: https://developer.apple.com/documentation/accessibility/axchartdescriptor/contentdirection-swift.property Use this property to get or set the direction of the content within the chart. Available on iOS 15.0+, iPadOS 15.0+, macOS 12.0+, tvOS 15.0+, visionOS 1.0+, and watchOS 8.0+. ```swift var contentDirection: AXChartDescriptor.ContentDirection { get set } ``` -------------------------------- ### Get Localized Color Name Source: https://developer.apple.com/documentation/accessibility/axnamefromcolor%28_%3A%29 Use this function to get a localized description of a color for accessibility attributes. Available on iOS 14.0+, iPadOS 14.0+, Mac Catalyst 14.0+, macOS 11.0+, tvOS 14.0+, visionOS 1.0+, and watchOS 7.0+. ```swift func AXNameFromColor(_ color: CGColor) -> String ``` -------------------------------- ### GET errorDomain Source: https://developer.apple.com/documentation/accessibility/axfeatureoverridesessionerror-swift.struct/errordomain Retrieves the error domain string for the AXFeatureOverrideSessionError. ```APIDOC ## GET errorDomain ### Description Returns the error domain string associated with AXFeatureOverrideSessionError. ### Method GET ### Endpoint errorDomain ### Response #### Success Response (200) - **errorDomain** (String) - The error domain string. ``` -------------------------------- ### init(brailleTable:) Source: https://developer.apple.com/documentation/accessibility/axbrailletranslator/init%28brailletable%3A%29 Initializes a new AXBrailleTranslator instance with the provided braille table. ```APIDOC ## init(brailleTable:) ### Description Initializes a new AXBrailleTranslator instance using the specified braille table. ### Parameters #### Parameters - **brailleTable** (AXBrailleTable) - Required - The braille table to be used by the translator. ### Request Example ```swift let translator = AXBrailleTranslator(brailleTable: myBrailleTable) ``` ``` -------------------------------- ### GET AXChartDescriptor.title Source: https://developer.apple.com/documentation/accessibility/axchartdescriptor/title Accesses or modifies the title of the chart descriptor. ```APIDOC ## Property: title ### Description The title of the chart. ### Declaration `var title: String? { get set }` ### Availability - iOS 15.0+ - iPadOS 15.0+ - Mac Catalyst 15.0+ - macOS 12.0+ - tvOS 15.0+ - visionOS 1.0+ - watchOS 8.0+ ``` -------------------------------- ### init(radicandExpressions:rootIndexExpression:) Source: https://developer.apple.com/documentation/accessibility/axmathexpressionroot/init%28radicandexpressions%3Arootindexexpression%3A%29 Initializes a new AXMathExpressionRoot instance with the specified radicand and root index expressions. ```APIDOC ## init(radicandExpressions:rootIndexExpression:) ### Description Initializes a new AXMathExpressionRoot instance with the provided radicand and root index expressions. ### Parameters - **radicandExpressions** ([AXMathExpression]) - Required - The expressions representing the radicand. - **rootIndexExpression** (AXMathExpression) - Required - The expression representing the root index. ### Availability - iOS 18.2+ - iPadOS 18.2+ - Mac Catalyst 18.2+ - macOS 15.2+ - tvOS 18.2+ - visionOS 2.2+ - watchOS 11.2+ ``` -------------------------------- ### GET overExpression Property Source: https://developer.apple.com/documentation/accessibility/axmathexpressionunderover/overexpression Retrieves the expression positioned above the base in an AXMathExpression. ```APIDOC ## GET overExpression ### Description Returns the expression positioned above the base in a mathematical expression. ### Method GET ### Endpoint overExpression ### Response - **overExpression** (AXMathExpression) - The expression located above the base. ``` -------------------------------- ### GET baseExpression Source: https://developer.apple.com/documentation/accessibility/axmathexpressionunderover/baseexpression Retrieves the base expression associated with an AXMathExpressionUnderOver object. ```APIDOC ## GET baseExpression ### Description Returns the base AXMathExpression for the given under-over mathematical expression. ### Property var baseExpression: AXMathExpression { get } ### Availability - iOS 18.2+ - iPadOS 18.2+ - Mac Catalyst 18.2+ - macOS 15.2+ - tvOS 18.2+ - visionOS 2.2+ - watchOS 11.2+ ``` -------------------------------- ### init(content:) Source: https://developer.apple.com/documentation/accessibility/axmathexpressionidentifier/init%28content%3A%29 Initializes an AXMathExpressionIdentifier instance with the specified content string. ```APIDOC ## init(content:) ### Description Initializes an AXMathExpressionIdentifier instance with the provided content string. ### Parameters #### Arguments - **content** (String) - Required - The mathematical expression content to be identified. ### Availability - iOS 18.2+ - iPadOS 18.2+ - Mac Catalyst 18.2+ - macOS 15.2+ - tvOS 18.2+ - visionOS 2.2+ - watchOS 11.2+ ``` -------------------------------- ### init(rawValue:) Source: https://developer.apple.com/documentation/accessibility/accessibilitysettings/feature/init%28rawvalue%3A%29 Initializes a new AccessibilitySettings.Feature instance from a raw integer value. ```APIDOC ## init(rawValue:) ### Description Creates an instance of AccessibilitySettings.Feature from the provided raw integer value. ### Method Initializer ### Parameters #### Parameters - **rawValue** (Int) - Required - The raw integer value representing the accessibility feature. ### Request Example let feature = AccessibilitySettings.Feature(rawValue: 1) ### Response - **Returns** (AccessibilitySettings.Feature?) - An optional instance of the feature if the raw value is valid. ``` -------------------------------- ### GET providerIdentifier Source: https://developer.apple.com/documentation/accessibility/axbrailletable/provideridentifier Retrieves the identifier of the provider for the current AXBrailleTable instance. ```APIDOC ## GET providerIdentifier ### Description The providerIdentifier property returns the unique identifier associated with the provider of the braille table. ### Property Definition `var providerIdentifier: String { get }` ### Availability - iOS 26.0+ - iPadOS 26.0+ - Mac Catalyst 26.0+ - macOS 26.0+ - tvOS 26.0+ - visionOS 26.0+ - watchOS 26.0+ ``` -------------------------------- ### Initialize AXCustomContent with label and value Source: https://developer.apple.com/documentation/accessibility/axcustomcontent/init%28label%3Avalue%3A%29 Creates a new instance of AXCustomContent using localized strings for the label and value parameters. ```swift convenience init( label: String, value: String ) ``` -------------------------------- ### GET expressions Source: https://developer.apple.com/documentation/accessibility/axmathexpressiontablecell/expressions Retrieves the collection of mathematical expressions associated with the table cell. ```APIDOC ## GET expressions ### Description Retrieves an array of AXMathExpression objects representing the mathematical content within the cell. ### Property var expressions: [AXMathExpression] { get } ### Availability - iOS 18.2+ - iPadOS 18.2+ - Mac Catalyst 18.2+ - macOS 15.2+ - tvOS 18.2+ - visionOS 2.2+ - watchOS 11.2+ ``` -------------------------------- ### GET AXMathExpressionFenced.closeString Source: https://developer.apple.com/documentation/accessibility/axmathexpressionfenced/closestring Retrieves the closing delimiter string for a fenced math expression. ```APIDOC ## Property: closeString ### Description A string representing the closing delimiter for a fenced math expression. ### Declaration `var closeString: String { get }` ### Availability - iOS 18.2+ - iPadOS 18.2+ - Mac Catalyst 18.2+ - macOS 15.2+ - tvOS 18.2+ - visionOS 2.2+ - watchOS 11.2+ ``` -------------------------------- ### AXFeatureOverrideSessionManager Methods Source: https://developer.apple.com/documentation/accessibility/axfeatureoverridesessionmanager Methods for starting and ending accessibility feature override sessions. ```APIDOC ## beginOverrideSession ### Description Begins a new accessibility feature override session. Multiple sessions are reconciled by combining requests, with a preference for feature enablement. ### Method Instance Method ### Parameters - **enabling** (AXFeatureOverrideSession.Options) - Required - Features to enable. - **disabling** (AXFeatureOverrideSession.Options) - Required - Features to disable. ### Response - **AXFeatureOverrideSession** - Returns a token object representing the override session. --- ## end ### Description Ends an existing accessibility feature override session and restores the prior state of accessibility feature enablement. ### Method Instance Method ### Parameters - **session** (AXFeatureOverrideSession) - Required - The session object to terminate. ``` -------------------------------- ### AXCustomContent Initializer Source: https://developer.apple.com/documentation/accessibility/axcustomcontent/init%28attributedlabel%3Aattributedvalue%3A%29 Creates new custom content with an attributed string for the label and an attributed string for the value. ```APIDOC ## init(attributedLabel:attributedValue:) ### Description Creates new custom content with an attributed string and attributed value. ### Method `convenience init` ### Parameters #### Parameters - **label** (NSAttributedString) - Required - A localized attributed string that identifies the label for this content. - **value** (NSAttributedString) - Required - A localized attributed string that provides a value for the label. ### See Also - `convenience init(label: String, value: String)` - `init?(coder: NSCoder)` ``` -------------------------------- ### GET AXFeatureOverrideSession.Options.invertColors Source: https://developer.apple.com/documentation/accessibility/axfeatureoverridesession/options/invertcolors Retrieves the invert colors option for an accessibility feature override session. ```APIDOC ## GET AXFeatureOverrideSession.Options.invertColors ### Description Returns the invert colors option used to configure an accessibility feature override session. ### Endpoint AXFeatureOverrideSession.Options.invertColors ### Response - **invertColors** (AXFeatureOverrideSession.Options) - The static property representing the invert colors feature override. ``` -------------------------------- ### GET attributedValue Source: https://developer.apple.com/documentation/accessibility/axcustomcontent/attributedvalue Retrieves the localized attributed string that provides a value for the accessibility label. ```APIDOC ## GET attributedValue ### Description A localized attributed string that provides a value for the label. ### Property Definition @NSCopying var attributedValue: NSAttributedString { get } ### Availability - iOS 14.0+ - iPadOS 14.0+ - Mac Catalyst 14.0+ - macOS 11.0+ - tvOS 14.0+ - visionOS 1.0+ - watchOS 7.0+ ``` -------------------------------- ### Initialize AXDataPoint with full parameters Source: https://developer.apple.com/documentation/accessibility/axdatapoint/initwithx%3Ay%3Aadditionalvalues%3Alabel%3A Use this initializer to create a data point containing x and y coordinates, a collection of additional values, and a descriptive label. ```Objective-C - (instancetype) initWithX:(AXDataPointValue *) xValue y:(AXDataPointValue *) yValue additionalValues:(NSArray *) additionalValues label:(NSString *) label; ``` -------------------------------- ### Get yAxis Descriptor Source: https://developer.apple.com/documentation/accessibility/axchartdescriptor/yaxis Access the descriptor for the chart's y-axis. This property is read-write. ```swift var yAxis: AXNumericDataAxisDescriptor? { get set } ``` -------------------------------- ### init(baseExpression:underExpression:overExpression:) Source: https://developer.apple.com/documentation/accessibility/axmathexpressionunderover/init%28baseexpression%3Aunderexpression%3Aoverexpression%3A%29 Initializes a new AXMathExpressionUnderOver instance with a base, under, and over expression. ```APIDOC ## init(baseExpression:underExpression:overExpression:) ### Description Creates an AXMathExpressionUnderOver object that represents a mathematical expression with components positioned above and below a base expression. ### Parameters - **baseExpression** (AXMathExpression) - Required - The base mathematical expression. - **underExpression** (AXMathExpression) - Required - The expression to be placed under the base. - **overExpression** (AXMathExpression) - Required - The expression to be placed over the base. ### Availability - iOS 18.2+ - iPadOS 18.2+ - Mac Catalyst 18.2+ - macOS 15.2+ - tvOS 18.2+ - visionOS 2.2+ - watchOS 11.2+ ``` -------------------------------- ### GET AccessibilitySettings.prefersHeadAnchorAlternative Source: https://developer.apple.com/documentation/accessibility/accessibilitysettings/prefersheadanchoralternative Retrieves the user's preference for content that follows their head position. ```APIDOC ## GET AccessibilitySettings.prefersHeadAnchorAlternative ### Description A Boolean value that indicates the person’s preference for content that follows their head position. If true, the user prefers to avoid head-anchored content. ### Method GET ### Endpoint AccessibilitySettings.prefersHeadAnchorAlternative ### Response #### Success Response (200) - **prefersHeadAnchorAlternative** (Bool) - Returns true if the user prefers to avoid head-anchored content, false otherwise. ### Response Example { "prefersHeadAnchorAlternative": true } ``` -------------------------------- ### init(content:) Source: https://developer.apple.com/documentation/accessibility/axmathexpressionoperator/init%28content%3A%29 Initializes an AXMathExpressionOperator instance with the specified content string. ```APIDOC ## init(content:) ### Description Initializes a new AXMathExpressionOperator instance using the provided content string. ### Parameters #### Request Body - **content** (String) - Required - The content string for the math expression operator. ### Request Example ```swift let operator = AXMathExpressionOperator(content: "+") ``` ``` -------------------------------- ### Accessing gridlinePositions in Swift Source: https://developer.apple.com/documentation/accessibility/axnumericdataaxisdescriptor/gridlinepositions-5cfmw Defines the property used to get or set the positions of gridlines along the axis. ```swift var gridlinePositions: [Double] { get set } ``` -------------------------------- ### Declare openSettings(for:) Method Source: https://developer.apple.com/documentation/accessibility/accessibilitysettings/opensettings%28for%3A%29 This is the method signature for opening specific Accessibility settings. It requires an `AccessibilitySettings.Feature` enum case. ```swift static func openSettings(for feature: AccessibilitySettings.Feature) async throws ``` -------------------------------- ### Get AXFeatureOverrideSessionManager sharedInstance Source: https://developer.apple.com/documentation/accessibility/axfeatureoverridesessionmanager/sharedinstance Access the singleton instance of AXFeatureOverrideSessionManager. Available on iOS 18.2+ and iPadOS 18.2+. ```swift class var sharedInstance: AXFeatureOverrideSessionManager { get } ``` -------------------------------- ### init(expressions:) Source: https://developer.apple.com/documentation/accessibility/axmathexpressiontablerow/init%28expressions%3A%29 Initializes a new AXMathExpressionTableRow instance with a collection of mathematical expressions. ```APIDOC ## init(expressions:) ### Description Initializes a new AXMathExpressionTableRow instance with an array of AXMathExpression objects. ### Parameters #### Request Body - **expressions** ([AXMathExpression]) - Required - An array of mathematical expressions to be included in the row. ### Request Example ```swift let row = AXMathExpressionTableRow(expressions: [expression1, expression2]) ``` ``` -------------------------------- ### beginOverrideSession(enabling:disabling:) Source: https://developer.apple.com/documentation/accessibility/axfeatureoverridesessionmanager/beginoverridesession%28enabling%3Adisabling%3A%29 Initiates a new accessibility feature override session with specified enabling and disabling options. ```APIDOC ## beginOverrideSession(enabling:disabling:) ### Description Initiates an accessibility feature override session, allowing for the configuration of enabled and disabled feature options. ### Method Instance Method ### Parameters #### Request Body - **enabling** (AXFeatureOverrideSession.Options) - Optional - The options to enable for the session. - **disabling** (AXFeatureOverrideSession.Options) - Optional - The options to disable for the session. ### Response - **Returns** (AXFeatureOverrideSession) - An instance of the override session. - **Throws** (Error) - Throws an error if the session cannot be initiated. ``` -------------------------------- ### Accessing the importance property Source: https://developer.apple.com/documentation/accessibility/axcustomcontent/importance-swift.property Use this property to get or set the importance level for custom accessibility content. ```swift var importance: AXCustomContent.Importance { get set } ``` -------------------------------- ### AXLiveAudioGraph Methods Source: https://developer.apple.com/documentation/accessibility/axliveaudiograph/start%28%29 Methods for controlling the lifecycle of a live audio graph session. ```APIDOC ## class func start() ### Description Begins the live audio graph session. ### Method Class Method ### Availability iOS 15.0+, iPadOS 15.0+, Mac Catalyst 15.0+, macOS 12.0+, tvOS 15.0+, visionOS 1.0+, watchOS 8.0+ --- ## class func stop() ### Description Ends the live audio graph session. ``` -------------------------------- ### Accessing accessibilityChartDescriptor Source: https://developer.apple.com/documentation/accessibility/axchart/accessibilitychartdescriptor Defines the property used to get or set the semantic chart descriptor for an accessible element. ```swift var accessibilityChartDescriptor: AXChartDescriptor? { get set } ``` -------------------------------- ### AXCustomContentProvider accessibilityCustomContent Property Source: https://developer.apple.com/documentation/accessibility/axcustomcontentprovider/accessibilitycustomcontent This property is an array of custom objects for creating accessible content. It is required and can be get or set. ```swift var accessibilityCustomContent: [AXCustomContent]! { get set } ``` -------------------------------- ### AXCustomContent Initializer Source: https://developer.apple.com/documentation/accessibility/axcustomcontent/init%28label%3Avalue%3A%29 Creates new custom content with a label and value. Available on iOS 14.0+, iPadOS 14.0+, Mac Catalyst 14.0+, macOS 11.0+, tvOS 14.0+, visionOS 1.0+, watchOS 7.0+. ```APIDOC ## init(label:value:) ### Description Creates new custom content with a label and value. ### Method Initializer ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) None #### Response Example None ## Parameters `label` (String) - Required - A localized string that identifies the label for this content. `value` (String) - Required - A localized string that provides a value for the label. ``` -------------------------------- ### init(x:y:additionalValues:label:) Source: https://developer.apple.com/documentation/accessibility/axdatapoint/init%28x%3Ay%3Aadditionalvalues%3Alabel%3A%29-4v3sb Initializes a new AXDataPoint instance with specific coordinate values and metadata. ```APIDOC ## init(x:y:additionalValues:label:) ### Description Creates a data point with the specified x-value, y-value, additional values, and label. ### Parameters - **x** (Double) - Required - The x-coordinate value. - **y** (Double?) - Optional - The y-coordinate value. Defaults to nil. - **additionalValues** ([AXDataPoint.Value]) - Optional - A collection of additional values associated with the data point. Defaults to an empty array. - **label** (String?) - Optional - A descriptive label for the data point. Defaults to nil. ### Request Example ```swift let dataPoint = AXDataPoint(x: 10.0, y: 5.0, additionalValues: [], label: "Point A") ``` ``` -------------------------------- ### init(rawValue:) Source: https://developer.apple.com/documentation/accessibility/axnumericdataaxisdescriptor/scaletype-swift.enum/init%28rawvalue%3A%29 Initializes a new instance of the scale type using the provided raw integer value. ```APIDOC ## init(rawValue:) ### Description Creates an instance of the scale type from the specified raw integer value. ### Parameters #### Parameters - **rawValue** (Int) - Required - The raw integer value representing the scale type. ### Request Example ```swift let scale = AXNumericDataAxisDescriptor.ScaleType(rawValue: 0) ``` ``` -------------------------------- ### AXCustomContentProvider accessibilityCustomContentBlock Property Source: https://developer.apple.com/documentation/accessibility/axcustomcontentprovider/accessibilitycustomcontentblock This property is an optional block that returns custom content for accessibility. It is available for get and set operations. ```swift optional var accessibilityCustomContentBlock: AXCustomContentReturnBlock? { get set } ``` -------------------------------- ### Initialize with Raw Value Source: https://developer.apple.com/documentation/accessibility/accessibilitytechnology/init%28rawvalue%3A%29 Use this initializer to create an instance from a string representation. Available on iOS 14.0+, iPadOS 14.0+, Mac Catalyst 14.0+, macOS 11.0+, tvOS 14.0+, visionOS 1.0+, and watchOS 7.0+. ```swift init(rawValue: String) ``` -------------------------------- ### Get Input Index from Result Index Source: https://developer.apple.com/documentation/accessibility/axbrailletranslationresult/inputindex%28forresultindex%3A%29 Maps a location in the resultString to where it came from in the input string. Available in iOS 26.0+ and later. ```swift func inputIndex(forResultIndex resultIndex: String.Index) -> String.Index? ``` -------------------------------- ### init(expressions:) Source: https://developer.apple.com/documentation/accessibility/axmathexpressiontablecell/init%28expressions%3A%29 Initializes a new AXMathExpressionTableCell with a provided array of AXMathExpression objects. ```APIDOC ## init(expressions:) ### Description Initializes a table cell for displaying mathematical expressions. ### Parameters #### Arguments - **expressions** ([AXMathExpression]) - Required - An array of AXMathExpression objects to be displayed in the cell. ### Availability - iOS 18.2+ - iPadOS 18.2+ - Mac Catalyst 18.2+ - macOS 15.2+ - tvOS 18.2+ - visionOS 2.2+ - watchOS 11.2+ ``` -------------------------------- ### See Also Source: https://developer.apple.com/documentation/accessibility/axdataseriesdescriptor Related classes and documentation. ```APIDOC ## See Also ### Data representation `class AXDataPoint` An object that represents a single data point in a chart. Current page is AXDataSeriesDescriptor ``` -------------------------------- ### Notification.Name.prefersHeadAnchorAlternativeDidChangeNotification Source: https://developer.apple.com/documentation/accessibility/accessibilitysettings/prefersheadanchoralternativedidchangenotification A notification that posts when the system setting for head-anchored content changes. When this notification is received, call `prefersHeadAnchorAlternative` to get the new setting. ```APIDOC ## Notification.Name.prefersHeadAnchorAlternativeDidChangeNotification ### Description A notification that posts when the system setting for head-anchored content changes. ### Method `static var prefersHeadAnchorAlternativeDidChangeNotification: Notification.Name { get }` ### Endpoint N/A (This is a system notification) ### Parameters N/A ### Request Example N/A ### Response N/A ### Discussion The system sends this notification when the setting for head-anchored content changes. When you receive this notification, call `prefersHeadAnchorAlternative` to get the new setting. On Apple Vision Pro, apps can create a heads-up display effect by setting up content to follow the person’s head position. This effect allows the content to remain in the same position, no matter where the person looks. However, some assistive technologies are incompatible with this type of content. For example, a technology might use the person’s head movements to control the current selection, or they might magnify content to make it easier to read. Anchoring content to the head position prevents these technologies from interacting with that content. ### See Also - `static var prefersHeadAnchorAlternative: Bool` ``` -------------------------------- ### init(x:y:additionalValues:label:) Source: https://developer.apple.com/documentation/accessibility/axdatapoint/init%28x%3Ay%3Aadditionalvalues%3Alabel%3A%29-83xvg Initializes a new AXDataPoint instance with specified coordinates, additional values, and a label. ```APIDOC ## init(x:y:additionalValues:label:) ### Description Creates a data point with the specified x-value, y-value, additional values, and label. ### Parameters - **x** (String) - Required - The x-value for the data point. - **y** (Double?) - Optional - The y-value for the data point. - **additionalValues** ([AXDataPoint.Value]) - Optional - A collection of additional values associated with the data point. - **label** (String?) - Optional - A descriptive label for the data point. ### Request Example ```swift let dataPoint = AXDataPoint(x: "January", y: 10.5, additionalValues: [], label: "Sales") ``` ``` -------------------------------- ### Define Braille Left Controls in HID Descriptor Source: https://developer.apple.com/documentation/accessibility/braille-hid-reference-for-connecting-to-apple-platforms Example of adding three braille left controls to a device report. ```HID Descriptor ... 0x0A, 0x0D, 0x02, // Usage (Braille Left Controls) 0xA1, 0x02, // Collection (Logical) 0x05, 0x09, // Usage Page (Button) 0x19, 0x01, // Usage Minimum (Button 1) 0x29, 0x03, // Usage Maximum (Button 3) 0x75, 0x01, // Report Size (1) 0x95, 0x03, // Report Count (3) 0x15, 0x00, // Logical Minimum (0) 0x25, 0x01, // Logical Maximum (1) 0x81, 0x02, // Input (Data,Var,Abs,No Wrap,Linear,Preferred State,No Null Position) 0xC0, // End Collection ... ``` -------------------------------- ### Initialize the chart descriptor Source: https://developer.apple.com/documentation/accessibility/representing-chart-data-as-an-audio-graph Combine the title, summary, axes, and series into an AXChartDescriptor instance. ```swift // Make and set the chart descriptor. accessibilityChartDescriptor = AXChartDescriptor(title: title, summary: summary, xAxis: weight, yAxis: mpg, additionalAxes: [msrp, country], series: [series]) ``` -------------------------------- ### Get grayscale option Source: https://developer.apple.com/documentation/accessibility/axfeatureoverridesession/options/grayscale Use this static property to access the grayscale option for feature overrides. Available on iOS 18.2+ and iPadOS 18.2+. ```swift static var grayscale: AXFeatureOverrideSession.Options { get } ``` -------------------------------- ### AccessibilityTechnology.fullKeyboardAccess Source: https://developer.apple.com/documentation/accessibility/accessibilitytechnology/fullkeyboardaccess Documentation for the fullKeyboardAccess static property within the AccessibilityTechnology structure. ```APIDOC ## static let fullKeyboardAccess ### Description A static property representing the Full Keyboard Access assistive technology. ### Availability - iOS 18.0+ - iPadOS 18.0+ - Mac Catalyst 18.0+ - macOS 15.0+ - tvOS 18.0+ - visionOS 2.0+ - watchOS 11.0+ ### Declaration `static let fullKeyboardAccess: AccessibilityTechnology` ``` -------------------------------- ### Accessing the attributedLabel property Source: https://developer.apple.com/documentation/accessibility/axdatapoint/attributedlabel Use this property to get or set an attributed string for the data point label. It requires iOS 15.0 or later. ```swift @NSCopying var attributedLabel: NSAttributedString? { get set } ``` -------------------------------- ### Retrieve language-agnostic braille tables Source: https://developer.apple.com/documentation/accessibility/axbrailletable/languageagnostictables%28%29 Returns a set of AXBrailleTable objects that are not language-specific. Available on all major Apple platforms starting from version 26.0. ```swift class func languageAgnosticTables() -> Set ``` -------------------------------- ### openSettings(for:) Source: https://developer.apple.com/documentation/accessibility/accessibilitysettings/opensettings%28for%3A%29 Opens the Settings app to a specific section of Accessibility settings. This method is available on iOS 18.0+, iPadOS 18.0+, Mac Catalyst 18.0+, macOS 15.0+, tvOS 18.0+, visionOS 2.0+, and watchOS 11.0+. ```APIDOC ## openSettings(for:) ### Description Opens the Settings app to a specific section of Accessibility settings. ### Method `static func openSettings(for feature: AccessibilitySettings.Feature) async throws` ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```swift ContentView() .alert( "Use Personal Voice", isPresented: $showAlert ) { Button("Open Accessibility Settings") { Task { do { try await AccessibilitySettings.openSettings(for: .personalVoiceAllowAppsToRequestToUse) } catch { print("Error: \(error)") } } } Button("Cancel", role: .cancel) { } } message: { Text("To use this feature, turn on the Personal Voice > Allow Apps to Request to Use setting.") } ``` ### Response #### Success Response (200) This method does not return a value upon success. It performs an action by opening the Settings app. #### Response Example N/A (Action-based, no direct response body) ``` -------------------------------- ### init(attributedTitle:summary:xAxis:yAxis:additionalAxes:series:) Source: https://developer.apple.com/documentation/accessibility/axchartdescriptor/init%28attributedtitle%3Asummary%3Axaxis%3Ayaxis%3Aadditionalaxes%3Aseries%3A%29 Creates a chart descriptor with the specified attributed title, summary, x-axis descriptor, y-axis descriptor, descriptors for additional axes, and array of data series. ```APIDOC ## init(attributedTitle:summary:xAxis:yAxis:additionalAxes:series:) ### Description Creates a chart descriptor with the specified attributed title, summary, x-axis descriptor, y-axis descriptor, descriptors for additional axes, and array of data series. ### Parameters - **attributedTitle** (NSAttributedString?) - Optional - The attributed title of the chart. - **summary** (String?) - Optional - A summary description of the chart. - **xAxis** (any AXDataAxisDescriptor) - Required - The descriptor for the x-axis. - **yAxis** (AXNumericDataAxisDescriptor?) - Optional - The descriptor for the y-axis. - **additionalAxes** ([any AXDataAxisDescriptor]) - Optional - An array of descriptors for additional axes. - **series** ([AXDataSeriesDescriptor]) - Required - An array of data series descriptors. ### Availability - iOS 15.0+, iPadOS 15.0+, Mac Catalyst 15.0+, macOS 12.0+, tvOS 15.0+, visionOS 1.0+, watchOS 8.0+ ``` -------------------------------- ### AXCustomContent Class Source: https://developer.apple.com/documentation/accessibility/axcustomcontent This section covers the AXCustomContent class, its initializers, and its properties. ```APIDOC ## AXCustomContent Objects that define custom content and the timing of its output. ### Overview An `AXCustomContent` object contains the accessibility strings for the labels you apply to your accessibility content. Combine them with the `AXCustomContentProvider` protocol to allow your users to experience the content in a more appropriate manner for each assistive technology. ### Creating custom content `convenience init(attributedLabel: NSAttributedString, attributedValue: NSAttributedString)` Creates new custom content with an attributed string and attributed value. `convenience init(label: String, value: String)` Creates new custom content with a label and value. `init?(coder: NSCoder)` ### Defining custom content `var label: String` A localized string that identifies the label for this content. `var attributedLabel: NSAttributedString` A localized attributed string that identifies the label for this content. `var value: String` A localized string that provides a value for the label. `var attributedValue: NSAttributedString` A localized attributed string that provides a value for the label. `var importance: AXCustomContent.Importance` An object that determines when to output custom accessibility content. `enum Importance` Objects that control the timing of content output. ### Relationships #### Inherits From * `NSObject` #### Conforms To * `CVarArg` * `CustomDebugStringConvertible` * `CustomStringConvertible` * `Equatable` * `Hashable` * `NSCoding` * `NSCopying` * `NSObjectProtocol` * `NSSecureCoding` ### See Also #### Custom accessibility content * `protocol AXCustomContentProvider` The interface for customizing the accessibility content. * `typealias AXCustomContentReturnBlock` ``` -------------------------------- ### Instance Property: openString Source: https://developer.apple.com/documentation/accessibility/axmathexpressionfenced/openstring The openString property returns a String representation of the fenced expression. It is available on multiple Apple platforms starting from specific OS versions. ```APIDOC ## Instance Property: openString ### Description Returns a String representation of the fenced expression. ### Availability - iOS 18.2+ - iPadOS 18.2+ - Mac Catalyst 18.2+ - macOS 15.2+ - tvOS 18.2+ - visionOS 2.2+ - watchOS 11.2+ ### Declaration ```swift var openString: String { get } ``` ``` -------------------------------- ### present(_:) Source: https://developer.apple.com/documentation/accessibility/axbraillemap/present%28_%3A%29 Converts the data from the specified image into the braille map. ```APIDOC ## present(_:) ### Description Converts the data from the image you specify into the braille map. Use this method to convert image data into the braille map directly, without the need to modify the heights of individual pins using setHeight(_:at:). ### Parameters - **image** (CGImage) - Required - An image to convert into the braille map. ### Request Example func present(_ image: CGImage) ``` -------------------------------- ### init(identifier:) Source: https://developer.apple.com/documentation/accessibility/axbrailletable/init%28identifier%3A%29 Initializes an AXBrailleTable instance with the specified identifier. Returns nil if no table exists for the provided identifier. ```APIDOC ## init(identifier:) ### Description Returns an AXBrailleTable instance initialized with the given identifier. If no table is found with the specified identifier, the initializer returns nil. ### Parameters #### Parameters - **identifier** (String) - Required - The unique identifier for the braille table. ### Request Example ```swift let table = AXBrailleTable(identifier: "en-US") ``` ### Response #### Success Response - **AXBrailleTable?** - An instance of AXBrailleTable or nil if the identifier is invalid. ``` -------------------------------- ### AXDataSeriesDescriptor Class Source: https://developer.apple.com/documentation/accessibility/axdataseriesdescriptor The AXDataSeriesDescriptor class represents a series of data points. It is available on iOS, iPadOS, macOS, tvOS, visionOS, and watchOS starting from specific versions. ```APIDOC ## Class AXDataSeriesDescriptor An object that represents a series of data points. Available in iOS 15.0+, iPadOS 15.0+, Mac Catalyst 15.0+, macOS 12.0+, tvOS 15.0+, visionOS 1.0+, watchOS 8.0+. ```swift class AXDataSeriesDescriptor ``` ``` -------------------------------- ### AccessibilitySettings.Feature.captionStyles Source: https://developer.apple.com/documentation/accessibility/accessibilitysettings/feature/captionstyles The `captionStyles` case is part of the AccessibilitySettings.Feature enum and is available on iOS, iPadOS, Mac Catalyst, macOS, tvOS, visionOS, and watchOS starting from version 26.4. ```APIDOC ## AccessibilitySettings.Feature.captionStyles ### Description Represents the caption styles feature within accessibility settings. ### Method N/A (This is a case within an enum) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ### Platform Availability - iOS: 26.4+ - iPadOS: 26.4+ - Mac Catalyst: 26.4+ - macOS: 26.4+ - tvOS: 26.4+ - visionOS: 26.4+ - watchOS: 26.4+ ``` -------------------------------- ### AXChartDescriptor Class Initialization Source: https://developer.apple.com/documentation/accessibility/axchartdescriptor Initializers for creating an AXChartDescriptor instance with chart metadata, axes, and data series. ```APIDOC ## init(title:summary:xAxis:yAxis:additionalAxes:series:) ### Description Creates a chart descriptor with the specified title, summary, x-axis descriptor, y-axis descriptor, descriptors for additional axes, and array of data series. ### Parameters - **title** (String?) - Optional - The title of the chart. - **summary** (String?) - Optional - A description of the key takeaways or features of the chart. - **xAxis** (any AXDataAxisDescriptor) - Required - The axis descriptor for the chart’s x-axis. - **yAxis** (AXNumericDataAxisDescriptor?) - Optional - The axis descriptor for the chart’s y-axis. - **additionalAxes** ([any AXDataAxisDescriptor]) - Required - The descriptors for additional categorical or numerical axes. - **series** ([AXDataSeriesDescriptor]) - Required - The descriptors for each data series in the chart. ## init(attributedTitle:summary:xAxis:yAxis:additionalAxes:series:) ### Description Creates a chart descriptor with the specified attributed title, summary, x-axis descriptor, y-axis descriptor, descriptors for additional axes, and array of data series. ### Parameters - **attributedTitle** (NSAttributedString?) - Optional - An attributed version of the chart title. ``` -------------------------------- ### Initialize AXChartDescriptor Source: https://developer.apple.com/documentation/accessibility/axchartdescriptor Convenience initializers for creating a chart descriptor with either a plain string or an attributed string title. ```swift convenience init(title: String?, summary: String?, xAxis: any AXDataAxisDescriptor, yAxis: AXNumericDataAxisDescriptor?, additionalAxes: [any AXDataAxisDescriptor], series: [AXDataSeriesDescriptor]) ``` ```swift convenience init(attributedTitle: NSAttributedString?, summary: String?, xAxis: any AXDataAxisDescriptor, yAxis: AXNumericDataAxisDescriptor?, additionalAxes: [any AXDataAxisDescriptor], series: [AXDataSeriesDescriptor]) ``` -------------------------------- ### Declare AXMathExpressionRoot Class Source: https://developer.apple.com/documentation/accessibility/axmathexpressionroot This is the basic declaration of the AXMathExpressionRoot class. It is available on iOS, iPadOS, Mac Catalyst, macOS, tvOS, visionOS, and watchOS starting from specific versions. ```swift class AXMathExpressionRoot ``` -------------------------------- ### AXDataPoint Class Initialization Source: https://developer.apple.com/documentation/accessibility/axdatapoint Methods for creating an AXDataPoint instance with specific x and y values, labels, and additional data values. ```APIDOC ## Initializer: init(x:y:additionalValues:label:) ### Description Creates a data point with the specified x-value, y-value, additional values, and label. ### Parameters #### Arguments - **x** (String or Double) - Required - The value of the x-axis. - **y** (Double?) - Optional - The value of the y-axis. - **additionalValues** ([AXDataPoint.Value]) - Required - A collection of additional data values. - **label** (String?) - Optional - A descriptive label for the data point. ``` -------------------------------- ### init(rawValue:) Source: https://developer.apple.com/documentation/accessibility/accessibilitytechnology/init%28rawvalue%3A%29 Initializes a new instance of the accessibility type with the specified raw value. This initializer is available across multiple Apple platforms and versions. ```APIDOC ## init(rawValue:) ### Description Initializes a new instance of the accessibility type with the specified raw value. ### Platforms iOS 14.0+ | iPadOS 14.0+ | Mac Catalyst 14.0+ | macOS 11.0+ | tvOS 14.0+ | visionOS 1.0+ | watchOS 7.0+ ### Syntax ```swift init(rawValue: String) ``` ``` -------------------------------- ### Instance Property: expressions Source: https://developer.apple.com/documentation/accessibility/axmathexpressionfenced/expressions The 'expressions' property returns an array of AXMathExpression objects. This property is available across multiple Apple platforms starting from specific OS versions. ```APIDOC ## Instance Property: expressions ### Description Returns an array of `AXMathExpression` objects. ### Availability iOS 18.2+ iPadOS 18.2+ Mac Catalyst 18.2+ macOS 15.2+ tvOS 18.2+ visionOS 2.2+ watchOS 11.2+ ### Syntax ```swift var expressions: [AXMathExpression] { get } ``` ``` -------------------------------- ### Initializer: init(attributedTitle:range:gridlinePositions:valueDescriptionProvider:) Source: https://developer.apple.com/documentation/accessibility/axnumericdataaxisdescriptor/init%28attributedtitle%3Arange%3Agridlinepositions%3Avaluedescriptionprovider%3A%29 Creates a numeric data axis with the specified attributed title, range, gridline positions, and value description provider closure. Available on iOS 15.0+, iPadOS 15.0+, Mac Catalyst 15.0+, macOS 12.0+, tvOS 15.0+, visionOS 1.0+, watchOS 8.0+. ```APIDOC ## Initializer: init(attributedTitle:range:gridlinePositions:valueDescriptionProvider:) ### Description Creates a numeric data axis with the specified attributed title, range, gridline positions, and value description provider closure. ### Method `convenience init` ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) None #### Response Example None ## See Also ### Creating a numeric data axis `convenience init(title: String, range: ClosedRange, gridlinePositions: [Double], valueDescriptionProvider: (Double) -> String)` Creates a numeric data axis with the specified title, range, gridline positions, and value description provider closure. ```