Add-on for Audacity user manual

Author: paulber007
URL: paulber007@wanadoo.fr

Summary

1. Introduction

Sorry, This manual is based on a french user manual's automatic translation .

1.1. Features

This add-on provides scripts:

As well as accessibility improvements:

1.2. Compatibility

The latest stable version of the module has been tested with NVDA 2017.3, NVDA 2017.4 and audacity v2.2.0 and v2.2.1 .

Previous versions of Audacity are not supported.

1.3. Configuration to meet

For proper operation of the module, it is necessary to :

1.4. Activation scripts

Each script can be activated in two ways:

In the NVDA "Input gestures" dialog, the scripts provided by the module are placed in the category of "Audacity".

For scripts that can be launched by a command interpreter, this is indicated following the description of the script.

By default, the vast majority of scripts that can be run by the shell are not assigned to any input gesture .

The command interpreter is launched using the gesture command "NVDA + Space" . A beep sound is audible.

Today, the commands are not modifiable.

The command "h" of the interpreter lists all of the commands and the command "g" displays the user manual of the module.

The shell stops is:

2. Module's Configuration

The module installs in the NVDA's "Preferences" menu, the "Audacity addon's Settings" sub-menu. It allows you to display the configuration dialog settings of the module, namely:

This configuration is saved in the file "audacityAddon.ini" in the NVDA's user configuration folder.

3. Scripts

3.1. Report audio position

To use this script, it is necessary that the focus is in the tracks view.

This script is triggered by the command "has" of the interpreter.

No gesture of command assigned by default.

It announces the time indicated in the field "audio position" of the toolbar "Audacity selection Toolbar".

3.2. Report informations's selection

To use this script, it is necessary that the focus is in the tracks view.

The selection toolbar provides several items of information:

It is possible to advertise while remaining in the tracks view with the following scripts:

By default, No input gesture is affected.

3.3. Report pressed state of the "Pause", "play" or" record" buttons

To use this script, it is necessary that the focus is in the tracks view.

It is triggered by the command "f5" of the interpreter.

By default, no input gesture is assigned.

It announces the state "Pressed"of the "Play", "Pause" and "Record" buttons.

In the case where no button is pressed, the announcement "No button pressed" is vocalized.

3.4. Report the level of playback or recording meter peak

Audacity présente meters for playback and recording to monitor the peaks of playback or recording with dropdown button.

The following scripts make it possible to know the levels of these vu-meters, without moving the focus to the view of the tracks:

By default, no input gesture is assigned.

3.5. Report the level of the playback and record'sslider

The toolbar "Audacity mixer Toolbar" presents the playback and record's sliders allowing you to adjust the levels of playback or recording.

The following scripts make it possible to know the levels of these sliders without moving the focus to the view of the tracks:

3.6. Display Audacity's guide

This script is triggered by the command "control+g" of the interpreter.

By default, no input gesture is assigned.

It allows you to view the guide of Audacity written by David Bailes for the users of the Jaws (c) screen reader.

4. Accessibility improvements

4.1. Automatic announcement of the audio position

In audio playback or not, the following shortcuts from Audacity (set by default) allow you to set or move the cursor audio:

In audio playback stopped and after activation of the shortcut, the field "audio position" of the toolbar "Audacity Selection toolbar" is automatically announced if a change has taken place and in the form:

The return of the audio position in the beginning of the selection is reported.

These shortcuts can be modified by the user without impacting the operation.

4.2. Automatic Announcement of the selection

The following shortcuts from Audacity (set by default) allow you to set or move the start and end of the selection:

If the option "Report automaticaly the selection changes" is selected, playback is stopped and after the activation of the shortcut, the selection changes are announced Depending on the type of shortcut, one or the other or both of the selection fields of the toolbar in "Selection" are announced in the form:

As all the labels advertised are those that are displayed by Audacity, there may be inconsistencies due to the translation or at the coding .

These shortcuts can be modified by the user without impacting the operation.

The command "f4" shell module allows you to enable or disable the announcement of the selection changes when it becomes annoying. It toggles the state of the option "Report automatically the selection changes" to the state "checked" to "unchecked" or vice versa.

4.3. Use the space bar or the Enter key to press a button

In Audacity, the bar space is provided to start or stop the audio playback, but not for pressing a button .

To press the button, it is necessary to use the "Enter" key, but this moves the focus to the next item in the window and no status change of the button is vocalized.

If the option "Use space bar or Enter key to press a button" is checked, it is then possible to press a button with the space bar or the Enter key and the state changes are announced.

4.4. Vocalization of the edit boxes of the time in the Selection toolbar Audacity

The "Audacity Selection" toolbar shows zones for editing time.

This time is recorded according to a format as you configure the context menu.

To change this time, it is necessary to be placed on the digit to modify (for right or left arrow) and the increase or the decrease with the arrows high or low.

This module allows a better vocalization of a hand indicating the time in hours, minutes and seconds, and on the other hand, in indicating the nature of the digit that is changed:

But only the following format are taken into account:

4.5. Other adapttations

5. History

5.1. v3.1 (7/01/2018)

5.2. v3.0.1 (4/01/2018)

- settings addon menu bug fix,

5.3. v3.0 (11/2017)

5.4. v2.3 (08/2017)

5.5. v2.2 (06/2015)

5.6. v2.1 (10/2014)

5.7. v2.0 (05/2014)

5.8. v1.0 (01/2014)

Creation of the add-on