Run an NVDA command
nvda_run_scriptRun an NVDA command by script name without pressing its assigned key, then report the speech NVDA produces so you can verify the result.
Instructions
Run an NVDA command by name, as if its key were pressed, then report what NVDA said.
This works whatever keys the user has assigned. Commands that pass their key on to the application cannot do so, since no key was pressed. Needs key presses to be allowed, like nvda_press_keys.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The command's script name from nvda_list_scripts, such as 'reportCurrentFocus' or 'dateTime'. | |
| record | No | Also record what this action changed: how the accessibility tree around it changed (controls added, removed, renamed or moved, values and states) and the events NVDA handled. NVDA is silent for up to a few seconds while the tree is read. For something the user does, use nvda_trace_events with tree. | |
| settle_ms | No | Stop listening once NVDA has been quiet this long. | |
| class_name | No | Only the command defined by this class, when several define the same name, such as 'GlobalCommands'. | |
| timeout_ms | No | Stop listening, or waiting for until_speech, after this long in total. | |
| until_speech | No | Keep listening until NVDA says something containing this text (ignoring case), such as 'sent' or a dialog title, instead of stopping at the first pause. The result says whether it was heard. | |
| record_within | No | Record only inside this control, an id from nvda_find_objects, such as a chat's message list. Implies record. By default the web document or window around the action is recorded. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |