Skip to content

Commit

Permalink
Add missing documentation file documentation/speakers.txt
Browse files Browse the repository at this point in the history
  • Loading branch information
drmfinlay committed Mar 19, 2022
1 parent ed62ce7 commit a1788b9
Showing 1 changed file with 55 additions and 0 deletions.
55 changes: 55 additions & 0 deletions documentation/speakers.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@

.. _RefSpeakers:

Text-to-speech (speaker) back-ends
============================================================================

.. contents:: Contents
:local:


SpeakerBase text-to-speech class
----------------------------------------------------------------------------

The :class:`dragonfly.engines.engine.base.SpeakerBase` class forms the base
class for the specific text-to-speech (speaker) classes. It defines the
stubs required and performs some of the logic necessary for Dragonfly to be
able to interact with a text-to-speech engine.

.. autoclass:: dragonfly.engines.base.SpeakerBase
:members:


SAPI 5 text-to-speech class
----------------------------------------------------------------------------

.. autoclass:: dragonfly.engines.backend_sapi5.speaker.Sapi5Speaker
:members: speak, name


Natlink and DNS text-to-speech class
----------------------------------------------------------------------------

.. autoclass:: dragonfly.engines.backend_natlink.speaker.NatlinkSpeaker
:members: speak, name


eSpeak text-to-speech class
----------------------------------------------------------------------------

.. autoclass:: dragonfly.engines.base.speaker_stdin.EspeakSpeaker
:members: speak, name


CMU Flite text-to-speech class
----------------------------------------------------------------------------

.. autoclass:: dragonfly.engines.base.speaker_stdin.FliteSpeaker
:members: speak, name


Text fallback class
----------------------------------------------------------------------------

.. autoclass:: dragonfly.engines.backend_text.speaker.TextSpeaker
:members: speak, name

0 comments on commit a1788b9

Please sign in to comment.