Hearing device support

Category: API Collection

Overview

Access information about paired hearing aid devices and streaming status.

Details

Topics

• Hearing devices
• struct AXMFiHearingDevice
• Streaming status
• struct Ear
• static func streamingEar() -> AXMFiHearingDevice.Ear
• static let streamingEarDidChangeNotification: NSNotification.Name
• Streaming type
• static func supportsBidirectionalStreaming() -> Bool
• Paired hearing devices
• static func pairedDeviceIdentifiers() -> [UUID]
• static let pairedUUIDsDidChangeNotification: NSNotification.Name

See Also

• Features
• API ReferenceCustomized accessibility content
• API ReferenceAudio graphs

• func AXNameFromColor(CGColor) -> String

• Accessibility

• Accessibility API
• Hearing device support

Overview

Companion apps for hearing device manufacturers might offer certain features, like remote fitting and hearing device health checks, that rely on streaming audio to the hearing devices. If a user disables audio streaming on their Apple device, these features might become unavailable.

This API gives your app the ability to check the state of the streaming preferences, so you can ask users to temporarily enable streaming to use your app’s features. You can also query other information about streaming capabilities and paired hearing devices.

Use this API to check:

• The state of the streaming preferences for the hearing device in each ear
• Whether the iOS device supports bidirectional streaming
• The Bluetooth UUIDs of the paired hearing devices that match your app’s hearing.aid.app entitlement

Topics (Grouped)

Hearing devices

• AXMFiHearingDevice — struct; A namespace for hearing device accessibility symbols in Swift.

Streaming status

• Ear — struct; Constants that represent a hearing device ear.
• funcstreamingEar() ->AXMFiHearingDevice.Ear — static; Returns which ears enable streaming.
• letstreamingEarDidChangeNotification:NSNotification.Name — static; A notification that the system posts when there’s a change to which ears enable streaming.

Streaming type

• funcsupportsBidirectionalStreaming() ->Bool — static; Returns a Boolean value that indicates whether the iOS device supports bidirectional streaming.

Paired hearing devices

• funcpairedDeviceIdentifiers() -> [UUID] — static; Returns the UUIDs of the hearing device peripherals.
• letpairedUUIDsDidChangeNotification:NSNotification.Name — static; A notification that the system posts when there’s a change to the UUIDs of the hearing device peripherals.

Features

• Customized accessibility content — API Reference; Customize your apps to deliver accessibility information to your users in measured portions as they need it.
• Audio graphs — API Reference; Define an accessible representation of your chart for VoiceOver to generate an audio graph.
• AXNameFromColor(CGColor) ->String — func; Returns a localized description of the color to use in accessibility attributes.

---

Source: https://developer.apple.com/documentation/accessibility/hearing-device-support