Swift version: 5.6
As clever as VoiceOver is, sometimes it will get the pronunciation wrong for certain words – particularly when it’s missing some context that would have made clear what the correct pronunciation was.
For example, if you have a
UILabel containing the string “Live” should that be pronounced as “liv” or as “lyve”? Or how about “Read” – is that pronounced as “reed” or “red”? There’s no way for VoiceOver to know unless you tell it.
The official way to do this is by using the
UIAccessibilitySpeechAttributeIPANotation key in an attributed string, but in practice using that just makes your sounds come out poorly.
An easier way that also produces better results is just to use your own phonetic lettering. For example:
label.text = "read" label.accessibilityLabel = "red"
Using this approach, the screen will show “read” but VoiceOver users will hear “red” – it works for everyone.
There are two places where this approach either won’t be enough or will prove extremely complicated.
First, if you use foreign languages inside your app they will be read out as if they were the user’s primary language. So, French words might be pronounced as if they were English, for example.
Second, if your app uses punctuation that the user needs to hear audibly, the result won’t be what you hoped for. For example, if you write some Swift code like
user.name that will be interpreted by VoiceOver as “user (pause) name” rather than “user period name”.
Both of these problems can be fixed by using special attributes of
NSAttributedString. For example, we can specify the language for an attributed string like this:
let attributedString1 = NSAttributedString( string: "Bonjour", attributes: [.accessibilitySpeechLanguage: "fr-FR"] ) label.text = "Bonjour" label.accessibilityAttributedLabel = attributedString1
And we can tell VoiceOver to read all punctuation like this:
let attributedString2 = NSAttributedString( string: "user.name", attributes: [.accessibilitySpeechPunctuation: true] ) label.text = "user.name" label.accessibilityAttributedLabel = attributedString2
SAVE 50% To celebrate WWDC23, all our books and bundles are half price, so you can take your Swift knowledge further without spending big! Get the Swift Power Pack to build your iOS career faster, get the Swift Platform Pack to builds apps for macOS, watchOS, and beyond, or get the Swift Plus Pack to learn advanced design patterns, testing skills, and more.
Available from iOS 11.0
This is part of the Swift Knowledge Base, a free, searchable collection of solutions for common iOS questions.
Link copied to your pasteboard.