Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Configure first voice instruction. #31

Merged
merged 2 commits into from
Mar 16, 2024
Merged

Configure first voice instruction. #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e16c3b6
Adds configuration to speak or skip the first voice instruction at le…
StephanPartzsch Mar 14, 2024
71fd5ca
Fixes route voice controller when no route progress is given.
StephanPartzsch Mar 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion MapboxCoreNavigation/RouteController.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,11 @@ open class RouteController: NSObject, Router {
*/
public var tunnelIntersectionManager: TunnelIntersectionManager = TunnelIntersectionManager()

/**
If true, the first voice announcement is always triggered when beginning a leg.
*/
public var speakFirstInstructionOnFirstStep = true

var didFindFasterRoute = false

/**
Expand Down Expand Up @@ -779,8 +784,10 @@ extension RouteController: CLLocationManagerDelegate {
guard let userSnapToStepDistanceFromManeuver = userSnapToStepDistanceFromManeuver else { return }
guard let spokenInstructions = routeProgress.currentLegProgress.currentStepProgress.remainingSpokenInstructions else { return }

let firstInstructionOnFirstStep = speakFirstInstructionOnFirstStep
// Always give the first voice announcement when beginning a leg.
let firstInstructionOnFirstStep = routeProgress.currentLegProgress.stepIndex == 0 && routeProgress.currentLegProgress.currentStepProgress.spokenInstructionIndex == 0
? routeProgress.currentLegProgress.stepIndex == 0 && routeProgress.currentLegProgress.currentStepProgress.spokenInstructionIndex == 0
: false

for voiceInstruction in spokenInstructions {
if userSnapToStepDistanceFromManeuver <= voiceInstruction.distanceAlongStep || firstInstructionOnFirstStep {
Expand Down
11 changes: 7 additions & 4 deletions MapboxNavigation/RouteVoiceController.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ open class RouteVoiceController: NSObject, AVSpeechSynthesizerDelegate {
@objc open func didPassSpokenInstructionPoint(notification: NSNotification) {
guard !NavigationSettings.shared.voiceMuted else { return }

routeProgress = notification.userInfo![RouteControllerNotificationUserInfoKey.routeProgressKey] as? RouteProgress
routeProgress = notification.userInfo?[RouteControllerNotificationUserInfoKey.routeProgressKey] as? RouteProgress
assert(routeProgress != nil, "routeProgress should not be nil.")

guard let instruction = routeProgress?.currentLegProgress.currentStepProgress.currentSpokenInstruction else { return }
Expand All @@ -194,7 +194,10 @@ open class RouteVoiceController: NSObject, AVSpeechSynthesizerDelegate {
- parameter locale: The `Locale` used to create the voice read aloud the given instruction. If `nil` the `Locale.preferredLocalLanguageCountryCode` is used for creating the voice.
*/
open func speak(_ instruction: SpokenInstruction, with locale: Locale?) {
assert(routeProgress != nil, "routeProgress should not be nil.")
guard let routeProgress else {
assertionFailure("routeProgress should not be nil.")
return
}

if speechSynth.isSpeaking, let lastSpokenInstruction = lastSpokenInstruction {
voiceControllerDelegate?.voiceController?(self, didInterrupt: lastSpokenInstruction, with: instruction)
Expand All @@ -213,10 +216,10 @@ open class RouteVoiceController: NSObject, AVSpeechSynthesizerDelegate {
utterance!.voice = AVSpeechSynthesisVoice(identifier: AVSpeechSynthesisVoiceIdentifierAlex)
}

let modifiedInstruction = voiceControllerDelegate?.voiceController?(self, willSpeak: instruction, routeProgress: routeProgress!) ?? instruction
let modifiedInstruction = voiceControllerDelegate?.voiceController?(self, willSpeak: instruction, routeProgress: routeProgress) ?? instruction

if #available(iOS 10.0, *), utterance?.voice == nil {
utterance = AVSpeechUtterance(attributedString: modifiedInstruction.attributedText(for: routeProgress!.currentLegProgress))
utterance = AVSpeechUtterance(attributedString: modifiedInstruction.attributedText(for: routeProgress.currentLegProgress))
} else {
utterance = AVSpeechUtterance(string: modifiedInstruction.text)
}
Expand Down
Loading