Improve TTS Error resolution for: `APP_MISSING_VOICE`

[david-allison]

https://www.reddit.com/r/Anki/comments/1ekpa9h/comment/lgm4w2c/

• A user adds {{tts ja_JP :vocab}} in Anki Desktop
• A user syncs
• ja_JP is not available (likely due to the user using a nonstandard TTS Engine)
  • A user sees: Text to speech error (APP_MISSING_VOICE)
• We don't provide any help/guidance on fixing this error

---

Good first issue:

• Propose a method for how this should be improved
  • What information should a user see
  • Should we expose the {{tts-voices:}} dialog to the user
  • Should we list the valid voices for a user to select from
  • Should we provide an easy way to edit the card template
  • Should we provide an easy way to change the default TTS engine?
• Discuss on the issue
• Implement the proposed fix

---

References:

• https://github.com/ankidroid/Anki-Android/issues/14358
• https://github.com/ankidroid/Anki-Android/pull/14628

[Rohanraj123]

@david-allison I went through the code and found that there is already a place holder for future decisions.

Hence, We can just change the message type from the developer string to a valuable message such as : --> {lan}is not supported by the built-in TTS engine. Please install an external TTS engine or choose a supported language.

Letme know if thats okay I would start working on this issue.

[david-allison]

I don't think we want a longer message here, we want a "help" link

Users don't have much time to read snackbars

If we are updating the message, listing the language & voice may be possible, but this could be a large string

[Rohanraj123]

Okay I successfully regenerated the issue. Basically the issue is not when you make a card and enable the tts support from ankidroid app. It shows a nice snackbar with help link for that to move to the article. But problem arises when we make card in Anki Desktop and sync it to the mobile and that language of tts is not supported in Ankidroid app due to tts engine incompatibility.

Solution is simple then, we can just show short and crisp snack bar message just to let user know what has happened and then give a Help link section after the message. As we are doing for the normal in app tts support error message.

Message can be : TTS Error : Missing language support. HELP Same article section can help the user to resolve this error as well.

[david-allison]

That looks like a great first step

It feels like an 'end goal' would be a dialog with:

• Current TTS Engine + 'change' button which opens Android Settings
• A link to the {{tts-voices:}} dialog fragment, so a user can see what's available
• Link to 'Help'

---

I'd be open to either:

1. 1. A PR with your snackbar improvement
   2. a linkable page explaining the common issues and how to fix them
2. The above, plus using the aforementioned dialog, with better TTS diagnostic information

[Rohanraj123]

Perfect, I start working on the second option i.e dialog implementation. It might take some time, Please assign me this issue.

[david-allison]

Lovely! Please feel free to come to Discord and ask for advice if you need it

As a few hints:

• Open this dialog to show a user the available TTS Voices: https://github.com/ankidroid/Anki-Android/blob/8e1c71a54c06816887b3213d66c8e424d32cfc4f/AnkiDroid/src/main/java/com/ichi2/anki/dialogs/TtsVoicesDialogFragment.kt

• https://github.com/ankidroid/Anki-Android/blob/93c2f68429ab96caf402854e7a5721a6c4d3b79e/AnkiDroid/src/main/java/com/ichi2/anki/TtsVoices.kt -

  • Extend this class to list the currently selected TTS Engine