NVDA Helper
In-process and lite high-speed utilities for NVDA
NvdaController2 Interface Reference

Adds additional methods to control NVDA from a remote process. More...

import <nvdaController.idl;

Public Member Functions

error_status_t __stdcall getProcessId ([out] unsigned long *pid)
 Retrieves the process identifier (PID) of NVDA's process.
 
error_status_t __stdcall speakSsml ([in, string] const wchar_t *ssml, [in, defaultvalue(SYMBOL_LEVEL_UNCHANGED)] const SYMBOL_LEVEL symbolLevel, [in, defaultvalue(SPEECH_PRIORITY_NORMAL)] const SPEECH_PRIORITY priority, [in, defaultvalue(TRUE)] const boolean asynchronous)
 Instructs NVDA to speak the given Speech Synthesis Markup Language (SSML).
 
error_status_t __stdcall onSsmlMarkReached ([in, string] const wchar_t *mark)
 Called by NVDA when a mark in provided SSML is reached after calling speakSsml synchronously.
 

Detailed Description

Adds additional methods to control NVDA from a remote process.

Member Function Documentation

◆ getProcessId()

error_status_t __stdcall NvdaController2::getProcessId ( [out] unsigned long * pid)

Retrieves the process identifier (PID) of NVDA's process.

Parameters
pidOut parameter that receives the process id.

◆ speakSsml()

error_status_t __stdcall NvdaController2::speakSsml ( [in, string] const wchar_t * ssml,
[in, defaultvalue(SYMBOL_LEVEL_UNCHANGED)] const SYMBOL_LEVEL symbolLevel,
[in, defaultvalue(SPEECH_PRIORITY_NORMAL)] const SPEECH_PRIORITY priority,
[in, defaultvalue(TRUE)] const boolean asynchronous )

Instructs NVDA to speak the given Speech Synthesis Markup Language (SSML).

Parameters
ssmlThe ssml to speak.
symbolLevelThe symbol verbosity level.
priorityThe priority of the speech sequence.
asynchronousWhether SSML should be spoken asynchronously. If TRUE, returns instantly. Note that any onSsmlMarkReached callback isn't called in this case. If FALSE, returns either when the speech sequence is completed or canceled. The onSsmlMarkReached callback, if any, is called for every mark in the SSML.

◆ onSsmlMarkReached()

error_status_t __stdcall NvdaController2::onSsmlMarkReached ( [in, string] const wchar_t * mark)

Called by NVDA when a mark in provided SSML is reached after calling speakSsml synchronously.

This callback is implemented by the controller client library. It forwards the call to the callback registered with

Parameters
markThe name of the reached mark.

The documentation for this interface was generated from the following file: