Crate speechd_module_sys 

Low-level binding for libspeechd_module

To use this module you must implement at least the following functions as global symbols in your own code and not doing so will result in linking errors (see each function for details):

• module_config
• module_init
• module_list_voices
• module_speak or module_speak_sync
• module_pause
• module_stop
• module_close

In addition you must also implement the following functions, unless you compile and link against module_utils.c from the speech-dispatcher distribution (again see each function for details):

• module_loop
• module_set
• module_audio_set
• module_audio_init
• module_loglevel_set
• module_debug

Modules

audio

Native audio playback functions

Structs

MsgSettings

Notification

Voice

Enums

CapitalLetters

Capital letter recognition

DataMode

MessageType

NotificationType

Priority

Punctuation

Punctuation verbosity mode

Spelling

Spelling mode enabled

VoiceType

Symbolic voice type

Statics

module_stdout_mutex^⚠

Protects multi-line answers against asynchronous event reporting

Functions

module_audio_init^⚠

Initialize audio

module_audio_set^⚠

Set audio parameter

module_audio_set_server

Notify the library that the module will send its audio as wave events to the server using module_tts_output_server

module_close

Called before exit

module_config^⚠

Read the module configuration from the given optional/nullable path, called at startup

module_debug^⚠

Enable or disable debugging into the given file

module_init^⚠

Called after server sends the INIT command

module_list_voices

List voices

module_loglevel_set^⚠

Set logging subsystem parameter

module_loop

Called after init confirmed

module_pause

Stop and drop the current utterance, preferably after reaching and reporting the next __spd_ index mark

module_process

Process the module input, interpreting the SSIP protocol and calling appropriate module-provided functions

module_readline

Read and return one line of input read from the given file descriptor

module_report_event_begin

Callback to report the start of synthesis

module_report_event_end

Callback to report finishing synthesis

module_report_event_pause

Callback to confirm a module_pause request

module_report_event_stop

Callback to confirm a module_stop request

module_report_icon^⚠

Callback to report reaching a sound icon

module_report_index_mark^⚠

Callback to report reaching an index mark

module_set^⚠

Set parameter, see the SET command of section 5.2.2 (“Communication Protocol for Output Modules”) of the speech-dispatcher manual for a list of standard properties

module_speak^⚠

Asynchronous speak

module_speak_error

Callback for module_speak_sync to mark the data as not OK, before returning from module_speak_sync

module_speak_ok

Callback for module_speak_sync to confirm the data is OK before actually synthesizing

module_speak_sync^⚠

Synchonous speak

module_stop

Immediately stop and drop the current utterance

module_tts_output_server^⚠

Forward an audio chunk to the server