Voiceover tutorial for voice artists by Nik-09 · Pull Request #476 · oppia/oppia-web-developer-docs

Nik-09 · 2025-10-31T09:35:29Z

The wiki adds tutorials on how to add manual voiceovers and how to regenerate automatic voiceovers for Oppia lessons.

Nik-09 · 2025-10-31T09:36:03Z

Voiceover-Tutorial.md

+### Pre-requisites
+
+- The exploration must be **curated** (i.e., linked to a published story).
+- Ensure the feature flags `"automatic_voiceover_regeneration_from_exp"` and `"show_regenerated_voiceovers_to_learners"` are enabled in the **Release Coordinator** page. Contact the release team for confirmation **(TODO: add Email)**.


Note to self: add emails to these lines.

Nik-09

Hi @seanlip PTAL once you are free.
Thank you!

seanlip

Thanks @Nik-09 -- took a pass!

seanlip · 2025-11-11T12:53:07Z

Voiceover-Tutorial.md

+2. Select the desired **language and accent**.
+   > **Note:** For non-English languages, ensure that the translation for that language exists. You cannot add a voiceover unless the translation is available.
+3. Upload your manual voiceover in the selected language-accent pair.
+4. And then save the draft changes.


"And then save" --> "Save".

Do you want to add a screenshot (perhaps with numbers that correspond to the steps)?

seanlip · 2025-11-11T12:53:46Z

Voiceover-Tutorial.md

+### Pre-requisites
+
+- The exploration must be **curated** (i.e., linked to a published story).
+- Ensure the feature flags `"automatic_voiceover_regeneration_from_exp"` and `"show_regenerated_voiceovers_to_learners"` are enabled in the **Release Coordinator** page. Contact the release team for confirmation **(Email: web-server-admins@oppia.org)**.


This is going to get out of date quite quickly, right (the flags will be removed on successful launch)?

seanlip · 2025-11-11T12:53:55Z

Voiceover-Tutorial.md

+
+- The exploration must be **curated** (i.e., linked to a published story).
+- Ensure the feature flags `"automatic_voiceover_regeneration_from_exp"` and `"show_regenerated_voiceovers_to_learners"` are enabled in the **Release Coordinator** page. Contact the release team for confirmation **(Email: web-server-admins@oppia.org)**.
+- Admins must enable voiceover regeneration functionality via the **Admin Misc** tab. Reach out to the admin to verify. **(Email: sean@seanlip.org)**


Use voiceover-tech-support@. All public contact should be to group aliases.

This will also go out of date though, right? Once we start supporting automated voiceovers then this step is not needed since it's always on?

Or maybe I don't understand who is supposed to use these instructions. Is it the individual creator or the voiceover admin or someone else? I feel like the first step is to just go to the translation tab and find the button; the 2nd-4th prereqs here seem like an appendix for the voiceover tech support team to look at and should probably only go at the very end.

seanlip · 2025-11-11T12:54:44Z

Voiceover-Tutorial.md

+
+1. Go to the **Translation** tab in the Exploration Editor.
+2. Select the **language and accent**.
+3. Click **Regenerate Voiceovers** for the selected language-accent.


Similar to above, maybe this needs a screenshot with numbers?

seanlip · 2025-11-11T12:55:10Z

Voiceover-Tutorial.md

+
+## Adding a New Language-Accent Pair to Oppia's Voiceover Support
+
+Oppia supports only selected **language-accent pairs** for voiceovers. To onboard a new pair, follow these steps:


onboard --> add

Also, suggest explaining what "add a new pair" entails -- something like "this will make the language/accent pair available in ..." (i.e., explain the consequences for both learners and creators).

seanlip · 2025-11-11T12:55:26Z

Voiceover-Tutorial.md

+
+1. Update the fields `LANGUAGE_CODE_TO_MATH_SYMBOL_PRONUNCIATIONS` & `LANGUAGE_CODE_TO_SENTENCE_ENDING_PUNCTUATION_MARKS` in the file **[constants.ts](https://github.com/oppia/oppia/blob/develop/assets/constants.ts)** via a pull request.
+
+>  **Note:** If you're adding a new **accent** to a language already supported (e.g., adding "English (India)" when "English (United States)" is already supported), you don't need to update the above mentioned fields.


a language already supported --> an already-supported language

seanlip · 2025-11-11T12:57:21Z

Voiceover-Tutorial.md

+
+**Optional: Enable Automatic Voiceover Support after the above steps**
+
+4. Set **Supports Autogeneration** to "Yes" **only if**:


Drop the "Optional: ..." above, just change "Set ..." to "(Optional) Set ..." here.

seanlip · 2025-11-11T12:57:37Z

Voiceover-Tutorial.md

+    - The language-accent is supported by Azure Text-to-Speech service.
+    - You are aware that this will incur costs.
+
+> ⚠️ Language-accents like **Hinglish** and **Nigerian Pidgin** do not support autogeneration due to Azure limitations, and you will not be able to enable the autogeneration flag for them.


Use this for warnings instead: https://github.com/orgs/community/discussions/16925

seanlip · 2025-11-11T12:58:53Z

Voiceover-Tutorial.md

+| **ServiceError** | Indicates an error returned by the Speech service.<br><br> - Check the error message and look for solutions online.<br>- Verify that the language-accent code used for speech synthesis is still supported by Azure TTS. (See reference [here](https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=stt)).<br>- If no action is needed, retry after 10–15 minutes.<br>- Take appropriate actions based on the error message.<br>- If the issue continues, contact Azure Support or raise a question with the Azure team. |
+| **ServiceUnavailable** | Indicates that the Speech service is currently unavailable.<br><br>- Retry after 10–15 minutes. |
+| **Autogeneration button disabled:**  Autogenerated voiceovers are not supported for the selected language accent. Please reach out to the voiceover admin if you would like them to be supported.| Reach out to voiceover admins (voiceovers-leads@oppia.org), they will either add the language accents to Oppia's voiceovers support or give you the rationale why this language accent can't be added.|
+| **Autogeneration button disabled:** Voiceover autogeneration via cloud services is currently disabled. Please contact the admins for more information.| Contact admin (sean@seanlip.org), for enabling Cloud based text-to-speech service from Admin tab.|


Use voiceover-tech-support@. All public contact should be to group aliases.

seanlip · 2025-11-11T13:02:13Z

Voiceover-Tutorial.md

+
+## Technical Cheat Sheet – Troubleshooting Voiceover Regeneration
+
+| **Error Type**         | **Steps to Fix** |


There are two types of errors, technical errors and errors in manual processes. These should be separate tables.

Have the manual processes one come first since all the above is user documentation.

For technical errors, explain where these errors will surface.

Nik-09 added 2 commits June 18, 2025 00:52

voiceover tutorial

1bf22fd

Updates voiceover tutorial wiki

e41a6a6

Nik-09 commented Oct 31, 2025

View reviewed changes

Nik-09 requested a review from seanlip October 31, 2025 09:36

Nik-09 assigned seanlip Oct 31, 2025

Adds email address

f9634d7

Nik-09 commented Nov 6, 2025

View reviewed changes

seanlip requested changes Nov 11, 2025

View reviewed changes

seanlip assigned Nik-09 and unassigned seanlip Nov 11, 2025

Nik-09 mentioned this pull request Mar 3, 2026

[Feature Request]: Missing Contact Information for Voiceover Contribution #446

Open


		## Adding a New Language-Accent Pair to Oppia's Voiceover Support

		Oppia supports only selected language-accent pairs for voiceovers. To onboard a new pair, follow these steps:


		1. Update the fields `LANGUAGE_CODE_TO_MATH_SYMBOL_PRONUNCIATIONS` & `LANGUAGE_CODE_TO_SENTENCE_ENDING_PUNCTUATION_MARKS` in the file [constants.ts](https://github.com/oppia/oppia/blob/develop/assets/constants.ts) via a pull request.

		> Note: If you're adding a new accent to a language already supported (e.g., adding "English (India)" when "English (United States)" is already supported), you don't need to update the above mentioned fields.


		Optional: Enable Automatic Voiceover Support after the above steps

		4. Set Supports Autogeneration to "Yes" only if:


		## Technical Cheat Sheet – Troubleshooting Voiceover Regeneration

		\| Error Type \| Steps to Fix \|

Conversation

Nik-09 commented Oct 31, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Nik-09 left a comment

Choose a reason for hiding this comment

Uh oh!

seanlip left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants