Synesis Software STLSoft - ... Robust, Lightweight, Cross-platform, Template Software ...

pantheios/backends/bec.speech.h File Reference


Detailed Description

[C, C++] Pantheios speech Back-end Common API

#include <pantheios/pantheios.h>
#include <pantheios/backend.h>

Go to the source code of this file.

Classes

struct  pan_be_speech_init_t
 Structure used for specifying initialisation information to the be.speech library. More...

Defines

#define PANTHEIOS_BE_SPEECH_F_SYNCHRONOUS   (0x00100000)
 Causes the Pantheios speech Stock Back-end to log speech synchronously.
#define PANTHEIOS_BE_SPEECH_F_PURGE_BEFORE_SPEAK   (0x00200000)
 Causes any log statements cached in the Pantheios speech Stock Back-end prior to purge any outstanding speach requests before attempting to emit the current statement.
#define PANTHEIOS_BE_SPEECH_F_SPEAK_PUNCTUATION   (0x00400000)
 Causes the Pantheios speech Stock Back-end to speak punctuation.
#define PANTHEIOS_BE_SPEECH_F_SYNCHRONOUS_ON_CRITICAL   (0x00800000)
 Causes the Pantheios speech Stock Back-end to output speech synchronously and to purge any previous outstanding speach requests if the severity level is pantheios::SEV_CRITICAL, pantheios::SEV_ALERT, or pantheios::SEV_EMERGENCY.
#define PANTHEIOS_BE_SPEECH_F_UNINIT_DISCARD_WORKAROUND   (0x01000000)
 Causes the Pantheios speech Stock Back-end to discard the speech object reference, without waiting until done, at uninitialisation time.

Functions

void pantheios_be_speech_getDefaultAppInit (pan_be_speech_init_t *init)
 Fills out a copy of the initialisation structure with default values (representative of the default behaviour of the library), ready to be customised and passed to the API initialiser function pantheios_be_speech_init().
void pantheios_be_speech_getAppInit (int backEndId, pan_be_speech_init_t *init)
 Callback function defined by the application, invoked when the API is initialised with a NULL init parameter.
int pantheios_be_speech_init (PAN_CHAR_T const *processIdentity, int id, pan_be_speech_init_t const *init, void *reserved, void **ptoken)
 Implements the functionality for pantheios_be_init() over the speech API.
void pantheios_be_speech_uninit (void *token)
 Implements the functionality for pantheios_be_uninit() over the speech API.
int pantheios_be_speech_logEntry (void *feToken, void *beToken, int severity, PAN_CHAR_T const *entry, size_t cchEntry)
 Implements the functionality for pantheios_be_logEntry() over the speech API.
int pantheios_be_speech_parseArgs (size_t numArgs, pantheios::pan_slice_t *const args, pan_be_speech_init_t *init)
 Parses the be.speech back-end flags.


Function Documentation

void pantheios_be_speech_getDefaultAppInit ( pan_be_speech_init_t init  ) 

Fills out a copy of the initialisation structure with default values (representative of the default behaviour of the library), ready to be customised and passed to the API initialiser function pantheios_be_speech_init().


pantheios Library documentation Matthew Wilson & Synesis Software, 2006-2011 SourceForge.net Logo