Developer Interface

accessible_output2.outputs.auto

class accessible_output2.outputs.auto.Auto

An output which automatically selects the first available output on the system

get_first_available_output()

Finds the ffirst available output. This is automatically called in braille, output and speak.

speak(*args, **kwargs)

Speaks the given text if the output supports speech

Parameters:
  • text (str) – The text to speak.
  • **options – Additional options.
braille(*args, **kwargs)

Brailles the given text if the output supports Braille

Parameters:
  • text (str) – The text to braille.
  • **options – Additional options.
output(*args, **kwargs)

Output the given text in speech, braille or both depending on what the output supports

Parameters:
  • text (str) – The text to output.
  • **options – Additional options.
Raises:

RuntimeError – If the requested output doesn’t define either speak or braille.
is_system_output()

Returns True if this output is a system output.

accessible_output2.outputs.dolphin

class accessible_output2.outputs.dolphin.Dolphin

Supports dolphin products.

speak(text, interrupt=0)

Speaks the given text.

Parameters:
  • text (str) – The text to speak.
  • **options – Additional options.
accessible_output2.outputs.dolphin.output_class

alias of accessible_output2.outputs.dolphin.Dolphin

accessible_output2.outputs.e_speak

class accessible_output2.outputs.e_speak.ESpeak

Supports ESpeak on Linux

Note this requires python-espeak to be installed This can be done on Debian distros by using apt-get install python-espeak Or through this tarball.

speak(text, interrupt=0)

Speaks the given text.

Parameters:
  • text (str) – The text to speak.
  • **options – Additional options.
accessible_output2.outputs.e_speak.output_class

alias of accessible_output2.outputs.e_speak.ESpeak

accessible_output2.outputs.jaws

accessible_output2.outputs.nvda

class accessible_output2.outputs.nvda.NVDA

Supports The NVDA screen reader

braille(text, **options)

Brailles the given text.

Parameters:
  • text (str) – The text to braille.
  • **options – Additional options.
speak(text, interrupt=False)

Speaks the given text.

Parameters:
  • text (str) – The text to speak.
  • **options – Additional options.
accessible_output2.outputs.nvda.output_class

alias of accessible_output2.outputs.nvda.NVDA

accessible_output2.outputs.pc_talker

class accessible_output2.outputs.pc_talker.PCTalker

Supports the PC Talker screen reader.

speak(text, interrupt=False)

Speaks the given text.

Parameters:
  • text (str) – The text to speak.
  • **options – Additional options.
accessible_output2.outputs.pc_talker.output_class

alias of accessible_output2.outputs.pc_talker.PCTalker

accessible_output2.outputs.sapi4

accessible_output2.outputs.sapi5

accessible_output2.outputs.system_access

class accessible_output2.outputs.system_access.SystemAccess

Supports System Access and System Access Mobile

braille(text, **options)

Brailles the given text.

Parameters:
  • text (str) – The text to braille.
  • **options – Additional options.
speak(text, interrupt=False)

Speaks the given text.

Parameters:
  • text (str) – The text to speak.
  • **options – Additional options.
accessible_output2.outputs.system_access.output_class

alias of accessible_output2.outputs.system_access.SystemAccess

accessible_output2.outputs.voiceover

class accessible_output2.outputs.voiceover.VoiceOver(*args, **kwargs)

Speech output supporting the Apple VoiceOver screen reader.

speak(text, interrupt=False)

Speaks the given text.

Parameters:
  • text (str) – The text to speak.
  • **options – Additional options.
accessible_output2.outputs.voiceover.output_class

alias of accessible_output2.outputs.voiceover.VoiceOver

accessible_output2.outputs.window_eyes

accessible_output2.outputs.zdsr

class accessible_output2.outputs.zdsr.ZDSR

Supports The ZDSR screen reader

speak(text, interrupt=False)

Speaks the given text.

Parameters:
  • text (str) – The text to speak.
  • **options – Additional options.
accessible_output2.outputs.zdsr.output_class

alias of accessible_output2.outputs.zdsr.ZDSR

accessible_output2.outputs.base

exception accessible_output2.outputs.base.OutputError

Raised by outputs if they fail to initialize or output

class accessible_output2.outputs.base.Output

The base Output object. Most functionality is found in child classes. If wishing to implement support for a new output, it might be helpful to take a look at an existing one to see how everything works.

name = 'Unnamed Output'

Name of the output. This attribute should be defined in all child classes for usability purposes.

Type:str
lib32 = None

Path pointing to a 32 bit DLL used to interface with the output. Can be None.

Type:str
lib64 = None

Path pointing to a 64 bit DLL used to interface with the output. Can be None.

Type:str
argtypes = {}

A mapping of funtion names (str) to signatures (tuple) containing C types.

Type:dict
cdll = False

Whether the DLL uses __cdecl calling conventions and should be loaded accordingly.

Type:bool
priority = 100

The priority this output should be given when automatically choosing possible outputs. See accessible_output2.outputs.auto.Auto. Priority begins at 100. Anything higher will throw it lower on the list of available outputs. Anything lower will make it more likely to be the first option selected. Example, screen readers are sometimes given a higher priority (usuallly 100) than TTS such as SAAPI5 (101) due to a common usability preference.

Type:int
system_output = False

Is this output present and accessible on most systems with little or no additional installation or configuration? example: SAPI5 is a system output, while NVDA is not.

Type:bool
output(text, **options)

Output the given text in speech, braille or both depending on what the output supports

Parameters:
  • text (str) – The text to output.
  • **options – Additional options.
Raises:

RuntimeError – If the requested output doesn’t define either speak or braille.
speak(text, **options)

Speaks the given text.

Parameters:
  • text (str) – The text to speak.
  • **options – Additional options.
braille(text, **options)

Brailles the given text.

Parameters:
  • text (str) – The text to braille.
  • **options – Additional options.