NEW: Nominations are now open for the 2019 Swift Community Awards! >>

How to highlight text to speech words being read using AVSpeechSynthesizer

Swift version: 5.1

Paul Hudson    @twostraws   

iOS has text-to-speech synthesis built right into the system, but even better is that it allows you to track when individual words are being spoken so that you can highlight the words on the screen. This is extremely easy to do thanks to the AVSpeechSynthesizerDelegate protocol: you get two callbacks in the form of willSpeakRangeOfSpeechString and didFinish, where you can do your work.

First, make sure you import AVFoundation into your project. Now make your class conform to the AVSpeechSynthesizerDelegate protocol.

Place a label into your view controller, then hook it up to an outlet called label. Now add these two methods:

func speechSynthesizer(_ synthesizer: AVSpeechSynthesizer, willSpeakRangeOfSpeechString characterRange: NSRange, utterance: AVSpeechUtterance) {
    let mutableAttributedString = NSMutableAttributedString(string: utterance.speechString)
    mutableAttributedString.addAttribute(.foregroundColor, value: UIColor.red, range: characterRange)
    label.attributedText = mutableAttributedString
}

func speechSynthesizer(_ synthesizer: AVSpeechSynthesizer, didFinish utterance: AVSpeechUtterance) {
    label.attributedText = NSAttributedString(string: utterance.speechString)
}

Finally, you need to trigger the text-to-speech engine – this might be by a button press perhaps, but it's down to you. Here's the method I attached to a button press:

@IBAction func speak(_ sender: AnyObject) {
    let string = label.text!
    let utterance = AVSpeechUtterance(string: string)
    utterance.voice = AVSpeechSynthesisVoice(language: "en-GB")

    let synthesizer = AVSpeechSynthesizer()
    synthesizer.delegate = self
    synthesizer.speak(utterance)
}

SAVE 20% ON iOS CONF SG The largest iOS conference in Southeast Asia is back in Singapore for the 5th time in January 2020, now with two days of workshops plus two days of talks on SwiftUI, Combine, GraphQL, and more! Save a massive 20% on your tickets by clicking on this link.

Available from iOS 7.0

Similar solutions…

About the Swift Knowledge Base

This is part of the Swift Knowledge Base, a free, searchable collection of solutions for common iOS questions.

MASTER SWIFT NOW
Buy Testing Swift Buy Practical iOS 12 Buy Pro Swift Buy Swift Design Patterns Buy Swift Coding Challenges Buy Server-Side Swift (Vapor Edition) Buy Server-Side Swift (Kitura Edition) Buy Hacking with macOS Buy Advanced iOS Volume One Buy Advanced iOS Volume Two Buy Hacking with watchOS Buy Hacking with tvOS Buy Hacking with Swift Buy Dive Into SpriteKit Buy Swift in Sixty Seconds Buy Objective-C for Swift Developers Buy Beyond Code

Was this page useful? Let us know!

Average rating: 2.8/5