Only require background audio when using speech synthesis #64
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
michaelkirk
commented
Jun 14, 2024
| @@ -193,6 +191,9 @@ open class RouteVoiceController: NSObject, AVSpeechSynthesizerDelegate { | |||
| - parameter ignoreProgress: A `Bool` that indicates if the routeProgress is added to the instruction. | |||
| */ | |||
| open func speak(_ instruction: SpokenInstruction, with locale: Locale?, ignoreProgress: Bool = false) { | |||
| // Don't require background audio unless the implementer is actually using speech APIs | |||
| self.verifyBackgroundAudio() | |||
There was a problem hiding this comment.
Note that this ultimately calls an assertionFailure so it shouldn't have any bearing on release builds one way or the other.
michaelkirk
force-pushed
the
mkirk/dont-require-background-audio
branch
from
55529f4 to
5b14aad
Compare
|
Rebased. This has been approved for a few days and is pretty small, so I'm going to merge. LMK if there's a different process I should follow in the future. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #63
I'm not currently using voice instructions. I'd like to add it at some point, but my app is still useful without this feature.
The SDK requires the background "Audio" entitlement at runtime, but without the voice instructions, there's no reason for the background "Audio" entitlement.
The AppStore may not accept an application with the background audio entitlement that doesn't actually use background audio. (speaking from experience here 😬)
RouteVoiceController.verifyBackgroundAudio is called upon init, which happens when instantiating a NavigationViewController. Instead we should wait until we actually use the audio before verifying this permission.