radioSure Internet Radio Player : accessibility enhancement - user's manual

URL: https://github.com/paulber19/radioSureAccessEnhancementNVDAAddon.git

Download:

• stable version 2.8
• Development Version

Compatibility:

• minimum version of NVDA supported: 2022.1
• latest version of NVDA tested: 2024.1

Sorry, but this document is an automatic translation from french language.

Sommaire

• 1. Introduction
  • 1.1. Features
  • 1.2. update
  • 1.3. Compatibility
  • 1.4. Configuration to be respected
  • 1.5. Special adaptation
  • 1.6. History
• 2. Script to start or stop playback of the current station
• 3. Scripts to launch the previous or next station
• 4. Scripts to increase or decrease the volume
• 5. Script to cut or reset the volume
• 6. Script to read the volume level
• 7. Script to start or stop recording of the current station
• 8. Script to display the list of favorite stations
• 9. Script to display the RadioSure options window
• 10. Script to press the Top + button
• 11. Script to read the name of the current station and the status line
• 12. Script to read the reading buffer
• 13. Script to show or hide the search area and the list of radio stations
• 14. script to go to the radio station search editing area
• 15. script to go to the list of radio stations
• 16. Script to exit the application
• 17. Activation of the contextual menu of the header of the columns of the station list
• 18. Press a button with the space bar
• 19. Disabling progress bars tracking
• 20. play of a station randomly

1. Introduction

This add-on improves the accessibility of RadioSure software with NVDA.

1.1. Features

This add-on provides:

• a script to start or stop the current station without moving focus,
• a script to launch the previous or next station from the list of stations already played without moving focus,
• a script to increase or decrease the volume without moving focus,
• a script to cut or reset the volume without moving focus,
• a script to read the volume level without moving focus,
• a script to start or stop the recording of the current station without moving focus,
• a script to display the list of favorite stations,
• a script to display the RadioSure options window,
• a script to read the name of the current station and the status line,
• a script to read the read buffer,
• a script to show or hide the search area and the list of radio stations,
• a script to go to the edit radio station search area,
• a script to go to the list of radio stations (search result),
• a script to press the Top button,
• a script to quit the application,
• scripts to activate the contextual menu of each column header of the station list to filter the list,
• the possible use of the space bar or the "Enter" key to press a button,
• configurable deactivation of progress bars tracking,
• a script to start playing a station chosen at random from the list of stations.

1.2. update

The update of the add-on is, by default, automatically a short time after the start of NVDA (about 10 seconds) and a maximum of once per day. It is possible to disable this update by unchecking the option "automatically check for updates" placed in "Update" category of the add-on settings.

The version of the add-on can be:

• a stable version: its version number is "1.0" for example.
• either a development version: the version number is of the type "1.0-dev1", or "1.0-rc1", or "1.0-beta2".

By default, the stable version is updated with a stable version more recent (higher version number).

But it is possible to update the stable version running with a development version of the next stable version. Just check the "Update also release versions to development versions"checkBox located in the "Update" category of add-on settings.

A development version is updated:

• with a more recent development version,
• with its stable version,
• or with the latest stable version if the previous option is not checked.
  The button "Search for update" placed in the "Update" category of add-on settings allows you to search immediately for an update.
  The "View history" button, placed in this same category, allows you to display the history of the current version in the browser.
  In the case of an automatic update and if a new version is detected, the "Update" dialog box is displayed to suggest:
• either the immediate installation of the new version,
• or to postpone the update until later. In this case, the search will be restarted at least one hour later.

The "What's new" button offers the possibility of opening, in the browser, the history of the extension and thus being able to know the new features of the proposed version.

1.3. Compatibility

This module has been tested with version 2.2 of RadioSure. Lowest versions are not supported.

1.4. Configuration to be respected

No special configuration.

1.5. Special adaptation

For some keyboard configuration, the basic input gestures using the "alt + control" modifier combination are not suitable.

For that, an option allows to use instead the combination "shift+ control" combination.

1.6. History

The version history of this add-on is in the "changes.html" file

2. Script to start or stop playback of the current station

This script is launched by the keyboard command "Control+p".

Its purpose is to press the "Play" button without moving the focus.

Pressing this button starts or stops playback of the current station.

3. Scripts to launch the previous or next station

RadioSure maintains the history of stations played and presents the "Back" and "Next" buttons to move through this history.

These scripts allow you to press these buttons without moving the focus.

These scripts are launched by the following keyboard commands:

• "alt+leftArrow": goes to the previous station already played and starts playing it
• "alt+rightArrow": goes to the next station already played and starts playing

4. Scripts to increase or decrease the volume

These scripts allow you to change the volume level without moving the focus. These scripts are launched by the following keyboard commands:

• "control+shift+upArrow": slightly increase the Volume in steps of 3%,
• "control+shift+flèche bas": slightly decrease the Volume in steps of 3%,
• "Control+shift+rightArrow": increase the volume in steps of 5%,
• "Control+shift+leftArrow": decrease the volume in steps of 5%,
• "Control+shift+pageDown": greatly increase the volume in steps of 20%,
• "Control+shift+pageUp": sharply reduce the volume in steps of 20%,- "Control+shift+m": set the volume at the medium level (50%)

5. Script to cut or reset the volume

This script is launched by the keyboard command "Control+m".

Its purpose is to press the "Mute" button without moving the focus.

Pressing this button cuts or restores the volume.

6. Script to read the volume level

This script is launched by the keyboard command "alt+v".

Without moving the focus, it announces the volume level in percentage

7. Script to start or stop recording of the current station

This script is launched by the keyboard commands "Control+r".

Its purpose is to press the "Rec" button without moving the focus, which starts or stops the recording of the current station.

8. Script to display the list of favorite stations

This script is launched by the keyboard command "Control+f".

Its purpose is to press the "Fav" button.

Pressing this button brings up the list of favorite stations in the context menu.

9. Script to display the RadioSure options window

This script is launched by the keyboard command "Control+o".

Its purpose is to press the "Options" button, which causes the RadioSure options configuration window to be displayed.

10. Script to press the Top + button

This script is launched by the keyboard command "Control+t". ????

11. Script to read the name of the current station and the status line

This script is launched by the keyboard command "alt+i".

It announces the information of the current station displayed by RadioSure as:

• the name of the station,
• the reading state started or stopped,
• the encoding used.

Double tap, it will copy this information to the clipboard.

For example:

http://www.maxfm.rs Reading (00:14) MP3, 160 kbps

12. Script to read the reading buffer

This script is launched by the keyboard command "alt+b".

it announces the reading buffer (information displayed by RadioSure). For example: 100% buffer

13. Script to show or hide the search area and the list of radio stations

This script is launched by the keyboard command "Control+e".

Its purpose is to press the "Expand" button without moving the focus.

This press displays or hides the search zone and the list of stations. If there is a display, the focus is placed in the station list.

14. script to go to the radio station search editing area

This script is launched by the keyboard command control+alt+e.

Its purpose is to focus on the radio station search editing area.

This editing area is in the form of an edit field and a drop-down list memorizing the previous search criteria. This editing area may not be displayed. In that case,the script causes a press on the Expand button to make it appear before moving the focus.

If the keyboard command is typed when the focus is already in the area, the script signals this.

15. script to go to the list of radio stations

This script is launched by the keyboard command control+alt+s.

Its purpose is to put the focus in the list of radio stations which contains the search result. The focus is placed on the radio station previously selected and it is announced, such as for example:

# Musik.12punks on RauteMusik.FM; Country: Germany; Genre: Rock-Punk; Language: German

This list may not be displayed. In this case, the script causes a press on the Expand button to make it appear before moving the focus. If the keyboard command is typed when the focus is already in the list the script signals it.

16. Script to exit the application

This script is launched by the keyboard command "Control+q".

Its purpose is to press the "Exit" button.

This press results in user confirmation, closing the window and stopping the RadioSure application.

17. Activation of the contextual menu of the header of the columns of the station list

RadioSure allows you to filter stations using the contextual menu of the header of each column of the station list.

but this requires a set of painful maneuvers that the following scripts remove:

• "alt+control+t": activate the contextual menu of the header of the "Title" column.
• "alt+control+c": activate the contextual menu of the header of the "Country" column.
• "alt+control+g": activate the contextual menu of the header of the "Genre" column.
• "alt+control+l": activate the contextual menu of the header of the "Language" column.

These input gestures can be modified using the NVDA "Input gestures" dialog.

Note: when a filter is applied, RadioSure signals this by preceding the label of the column header with a "*". Several filters can be applied at the same time.

18. Press a button with the space bar

In RadioSure, the space bar is provided by default to activate the buttons, but not the "Enter" key.

Now to press the buttons, you can use the "Enter" key or the space bar.

The module provides this possibility without preventing operation in all other situations.

19. Disabling progress bars tracking

When starting a station, RadioSure visually reports the progress and NVDA announces the changes of this progress according to the configuration of the choice "Progress bar output " of "Object Presentation" category of NVDA settings.

This is not of great interest and quite unpleasant in the long run.

Although it is possible by manually configuring this option and only for RadioSure using a configuration profile, to deactivate any announcement, the add-on offers to do so by default.

It is obviously possible to return to normal operation by unchecking the "Disable progress bars update" checkbox located in the "Options" category of add-on settings.

20. play of a station randomly

This script is triggered by the "alt+control+r" input gesture.

It randomly chooses a station from among the stations in the station list and starts playing it. If the station list is not displayed, it is displayed by pressing the "Expand" button.

To ensure that the playback starts correctly, it monitors the connection status of the station for the time configured in the "Random playing"group of the "Maximum delay for waiting connection" comboBox of the "Options" category of add-on settings.

At the end of this time and if the connection has not been successful, it starts over with another station the number of times configured in the "Maximum stations to check" comboBox placed in the "Random playing" group of the "Options" category of add-on settings.

By default, it memorizes stations with connection faults to exclude them virtually from the list of stations and thus do not choose them again. This operation can be deactivated by unchecking the "Skip stations without connection" check box in the "Random playing" group of the "Options" category of the add-on settings.

This group also offers a button to delete all the stored stations.

To shorten the search time for a good station, it is preferable to have as many stations as possible in the list that are connecting.