Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create audio panel for new sound settings #15472

Merged
merged 4 commits into from Sep 20, 2023
Merged

Create audio panel for new sound settings #15472

merged 4 commits into from Sep 20, 2023

Conversation

seanbudd
Copy link
Member

@seanbudd seanbudd commented Sep 20, 2023

Link to issue number:

Fix #8711

Summary of the issue:

WASAPI is now enabled by default, so the new features for setting the volume of NVDA sounds should be moved out of the advanced setting panel.

Description of user facing changes

A new audio settings panel is created for:

  • Volume of NVDA sounds
  • Volume of NVDA sounds follows voice volume
  • Audio ducking was moved to this panel
  • Audio output device was moved to this panel

Description of development approach

Move settings, update user guide

Testing strategy:

Test change the various settings.
Ensure the settings are toggled as expected when WASAPI is toggled.

Known issues with pull request:

None

Change log entries:

Refer to diff

Code Review Checklist:

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

@seanbudd seanbudd added this to the 2023.3 milestone Sep 20, 2023
@seanbudd seanbudd requested review from a team as code owners September 20, 2023 01:49
@seanbudd seanbudd requested review from Qchristensen and michaelDCurran and removed request for a team September 20, 2023 01:49
@wmhn1872265132
Copy link
Contributor

Now that there is an independent audio settings page, should the "Output Device" option also be moved to this page?

@seanbudd
Copy link
Member Author

seanbudd commented Sep 20, 2023

Now that there is an independent audio settings page, should the "Output Device" option also be moved to this page?

done

@cary-rowen
Copy link
Contributor

So, is it still necessary to retain the original speech synthesizer dialog?

Can the combo box for selecting a speech synthesizer be an item in the speech settings panel? No need to open a separate dialog.

@seanbudd
Copy link
Member Author

@cary-rowen - I think so yes, changing the synthesizer requires some special handling that we want to keep separate from the rest of the panel

Copy link
Member

@Qchristensen Qchristensen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Documentation changes read well, great work!

@seanbudd seanbudd merged commit c2e2cdb into beta Sep 20, 2023
1 check passed
@seanbudd seanbudd deleted the audioPanel branch September 20, 2023 03:56
@codeofdusk
Copy link
Contributor

codeofdusk commented Sep 20, 2023

@seanbudd Removing "output device" from the NVDA+Control+s dialog will both break muscle memory for long-time NVDA users and make it very hard to blindly (without audible speech or connected Braille) change sound devices in the event of unexpected device switching. Please duplicate the combo box in both dialogs (my preference) or make this gesture open the new panel.

seanbudd pushed a commit that referenced this pull request Sep 20, 2023
Follow-up of #15472.

Summary of the issue:
If NVDA is started with WASAPI disabled in config and if you enable WASAPI, the new audio options to control NVDA sounds along with voice and volume of NVDA sound are available. That's confusing because modifying them will not have any effect until NVDA is restarted.

Description of user facing changes
Enabling or disabling audio options linked to WASAPI will be done looking at current state of WASAPI usage rather than looking at the state configured for next restart.

Also added an indication in the User Guide that these options can be unavailable so that the user does not look for them when they are greyed out.

Description of development approach
Rather than checking the config, check the player currently used to determine if the WASAPI related options need to be disabled or not.
seanbudd added a commit that referenced this pull request Sep 20, 2023
@XLTechie
Copy link
Collaborator

XLTechie commented Sep 21, 2023 via email

@codeofdusk
Copy link
Contributor

@XLTechie It could be, but we'll probably get pushback for that at this point in the 2023.3 release cycle. I've opened #15486 (targetting beta) and will look into something else for 2024.1.

@beqabeqa473
Copy link
Contributor

beqabeqa473 commented Sep 21, 2023 via email

@beqabeqa473
Copy link
Contributor

beqabeqa473 commented Sep 21, 2023 via email

@Adriani90
Copy link
Collaborator

@seanbudd could you add the shortcut ctrl+NVDA+u for this settings category and document it properly in the user guide and key commands reference?

@seanbudd seanbudd mentioned this pull request Sep 22, 2023
5 tasks
seanbudd added a commit that referenced this pull request Sep 25, 2023
Fixup of #15472

Summary of the issue:
A default gesture to open the new audio panel is desirable

Description of user facing changes
Adds nvda+ctrl+u as a command to open the audio panel

Commands for opening settings panels are now included in the key commands doc

Description of development approach
Adds nvda+ctrl+u as a command to open the audio panel

Adds keyCommands to the appveyor build for easier review of changes.

Updates to user guide
seanbudd pushed a commit that referenced this pull request Sep 25, 2023
Link to issue number:
Partially reverts #15472.

Summary of the issue:
The "output device" option has been removed from the NVDA+Control+s dialog. This breaks muscle memory for long-time NVDA users and makes it very hard to blindly (without audible speech or connected Braille) change sound devices in the event of unexpected device switching.

Description of how this pull request fixes the issue:
Selectively reverts the change in #15472 that removes the option from the synth selection dialog.

Testing strategy:
Verified that the "output device" option in both dialogs works as expected
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.

None yet

10 participants