Install in Dash
RouteVoiceController Class Reference
RouteVoiceController
open class RouteVoiceController: NSObject, AVSpeechSynthesizerDelegate, AVAudioPlayerDelegateThe RouteVoiceController class provides voice guidance.
-
A boolean value indicating whether instructions should be announced by voice or not.
Declaration
Swift
@objc public var isEnabled: Bool = true -
Volume of announcements.
Declaration
Swift
@objc public var volume: Float = 1.0 -
SSML option which controls at which speed Polly instructions are read.
Declaration
Swift
@objc public var instructionVoiceSpeedRate = 1.08 -
SSML option that specifies the voice loudness.
Declaration
Swift
@objc public var instructionVoiceVolume = "default" -
If true, a noise indicating the user is going to be rerouted will play prior to rerouting.
Declaration
Swift
@objc public var playRerouteSound = true -
Sound to play prior to reroute. Inherits volume level from
volume.Declaration
Swift
@objc public var rerouteSoundPlayer: AVAudioPlayer = try! AVAudioPlayer(data: NSDataAsset(name: "reroute-sound", bundle: .mapboxNavigation)!.data, fileTypeHint: AVFileType.mp3.rawValue) -
Buffer time between announcements. After an announcement is given any announcement given within this
TimeIntervalwill be suppressed.Declaration
Swift
@objc public var bufferBetweenAnnouncements: TimeInterval = 3 -
Delegate used for getting metadata information about a particular spoken instruction.
Declaration
Swift
public weak var voiceControllerDelegate: VoiceControllerDelegate? -
Default initializer for
RouteVoiceController.Declaration
Swift
override public init() -
Reads aloud the given instruction.
Declaration
Swift
open func speak(_ instruction: SpokenInstruction)Parameters
instructionThe instruction to read aloud.
View Source on GitHub