mapbox / mapbox/mapbox-navigation-ios

Allow clients of MapboxVoiceController to customize SpeechOptions

Open
#1,649 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature jira-sync-complete topic: voice
Dominant language
Swift
Stars
918
Forks
326
Avg merge
1h 16m
Merged PRs (30d)
3

Description

MapboxVoiceController sets the locale when fetching the audio for a spoken instruction, but the application may also want to set other options, namely the gender via [`SpeechOptions.speechGender`](https://github.com/mapbox/mapbox-speech-swift/blob/master/MapboxSpeech/MBSpeechOptions.swift#L137). MapboxVoiceController should expose these options somehow, whether through individual properties, a `speechOptions` property set upfront, or a new delegate protocol.

https://github.com/mapbox/mapbox-navigation-ios/blob/ef7a5258172fec80db6125966df6708aeb7a5031/MapboxNavigation/MapboxVoiceController.swift#L155-L158

/cc @bsudekum @willwhite

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review MapboxNavigation/MapboxVoiceController.swift around lines 155-158 and MBSpeechOptions.swift, especially SpeechOptions.speechGender. Determine how MapboxVoiceController can expose client-configurable speech options while still setting the locale for spoken instructions. Done means clients can customize those options through the controller.

Written by the indexing model from the issue text.

Assessment

Tech stack
ios, swift
Domain
mobile
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.