Skip to content

Add SSML parser and speakSsml function#15699

Merged
seanbudd merged 12 commits into
nvaccess:masterfrom
LeonarddeR:ssml
Oct 31, 2023
Merged

Add SSML parser and speakSsml function#15699
seanbudd merged 12 commits into
nvaccess:masterfrom
LeonarddeR:ssml

Conversation

@LeonarddeR

@LeonarddeR LeonarddeR commented Oct 28, 2023

Copy link
Copy Markdown
Collaborator

Link to issue number:

Preparations for #12945

Summary of the issue:

  1. The way you can output speech using the nvda controller is pretty limited. It is not possible to control prosody parameters, for example. Also you can't easily insert pauses in speech.
  2. Construction of speech sequences can be pretty complex. It would if we'd have some standardized way of providing speech attributes in text.

Description of user facing changes

None for normal users, only developers.

Description of development approach

Documented in changelog entries. Basically:

  • Added an SSML Parser to generate speech sequences
  • Added speech.speakSsml to generate speech output using SSML.

Support in the NVDA Controller Client will be added in a follow up.

Testing strategy:

Unit tests

Known issues with pull request:

None known

Code Review Checklist:

  • Documentation:
    • Change log entry
    • User Documentation
    • Developer / Technical Documentation
    • Context sensitive help for GUI changes
  • Testing:
    • Unit tests
    • System (end to end) tests
    • Manual testing
  • UX of all users considered:
    • Speech
    • Braille
    • Low Vision
    • Different web browsers
    • Localization in other languages / culture than English
  • API is compatible with existing add-ons.
  • Security precautions taken.

@AppVeyorBot

Copy link
Copy Markdown

See test results for failed build of commit 3dddd95fc4

@LeonarddeR LeonarddeR marked this pull request as ready for review October 30, 2023 06:05
@LeonarddeR LeonarddeR requested a review from a team as a code owner October 30, 2023 06:05
Comment thread source/speech/types.py
Comment thread source/speechXml.py Outdated
Comment thread source/speechXml.py
@seanbudd seanbudd merged commit d34b937 into nvaccess:master Oct 31, 2023
@nvaccessAuto nvaccessAuto added this to the 2024.1 milestone Oct 31, 2023
@codeofdusk codeofdusk mentioned this pull request Aug 31, 2024
@LeonarddeR LeonarddeR deleted the ssml branch August 23, 2025 06:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants