NVDA Helper
In-process and lite high-speed utilities for NVDA
nvdaController.idl File Reference

Go to the source code of this file.

Classes

interface  NvdaController
 Allows controling of NVDA from a remote process. More...
 
interface  NvdaController2
 Adds additional methods to control NVDA from a remote process. More...
 

Typedefs

typedef error_status_t(__stdcall * onSsmlMarkReachedFuncType) ([in, string] const wchar_t *mark)
 Type signature for a callback that may be implemented by a client.
 

Enumerations

enum  SPEECH_PRIORITY { SPEECH_PRIORITY_NORMAL = 0 , SPEECH_PRIORITY_NEXT = 1 , SPEECH_PRIORITY_NOW = 2 }
 Facilitates the ability to prioritize speech. More...
 
enum  SYMBOL_LEVEL {
  SYMBOL_LEVEL_NONE = 0 , SYMBOL_LEVEL_SOME = 100 , SYMBOL_LEVEL_MOST = 200 , SYMBOL_LEVEL_ALL = 300 ,
  SYMBOL_LEVEL_CHAR = 1000 , SYMBOL_LEVEL_UNCHANGED = -1
}
 The desired symbol level in a speech sequence. More...
 

Functions

error_status_t __stdcall setOnSsmlMarkReachedCallback (onSsmlMarkReachedFuncType callback)
 Sets the callback used when marks are reached within SSML.
 

Typedef Documentation

◆ onSsmlMarkReachedFuncType

typedef error_status_t(__stdcall * onSsmlMarkReachedFuncType) ([in, string] const wchar_t *mark)

Type signature for a callback that may be implemented by a client.

The callback is called for every mark in the SSML as received by speakSsml when called synchronously.

Parameters
markThe name of the reached mark.

Enumeration Type Documentation

◆ SPEECH_PRIORITY

Facilitates the ability to prioritize speech.

These values ​​correspond to the values ​​of speech.priorities.SpeechPriority in NVDA.

Enumerator
SPEECH_PRIORITY_NORMAL 

Indicates that a speech sequence should have normal priority.

SPEECH_PRIORITY_NEXT 

Indicates that a speech sequence should be spoken after the next utterance of lower priority is complete.

SPEECH_PRIORITY_NOW 

Indicates that a speech sequence is very important and should be spoken right now, interrupting low priority speech.

After it is spoken, interrupted speech will resume. Note that this does not interrupt previously queued speech at the same priority.

◆ SYMBOL_LEVEL

The desired symbol level in a speech sequence.

These values ​​correspond to the values ​​of characterProcessing.SymbolLevel in NVDA.

Enumerator
SYMBOL_LEVEL_NONE 
SYMBOL_LEVEL_SOME 
SYMBOL_LEVEL_MOST 
SYMBOL_LEVEL_ALL 
SYMBOL_LEVEL_CHAR 
SYMBOL_LEVEL_UNCHANGED 

Function Documentation

◆ setOnSsmlMarkReachedCallback()

error_status_t __stdcall setOnSsmlMarkReachedCallback ( onSsmlMarkReachedFuncType callback)

Sets the callback used when marks are reached within SSML.

The callback is called for every mark in the SSML as received by speakSsml when called synchronously. Param callback The callback to use, NULL to reset.