Main Page | Namespace List | File List | Namespace Members | File Members

voce Namespace Reference

The namespace containing everything in the Voce C++ API. More...


Namespaces

namespace  internal

Functions

void init (const std::string &vocePath, bool initSynthesis, bool initRecognition, const std::string &grammarPath, const std::string &grammarName)
void destroy ()
void synthesize (const std::string &message)
void stopSynthesizing ()
int getRecognizerQueueSize ()
std::string popRecognizedString ()
void setRecognizerEnabled (bool e)
bool isRecognizerEnabled ()

Variables

const std::string pathSeparator = ":"


Detailed Description

The namespace containing everything in the Voce C++ API.

Function Documentation

void destroy  ) 
 

In addition to the usual Java Voce destroy call, this function performs some extra stuff needed to destroy the virtual machine.

Definition at line 259 of file voce.h.

References voce::internal::log().

int getRecognizerQueueSize  ) 
 

Returns the number of recognized strings currently in the recognizer's queue.

Definition at line 331 of file voce.h.

References voce::internal::log().

void init const std::string &  vocePath,
bool  initSynthesis,
bool  initRecognition,
const std::string &  grammarPath,
const std::string &  grammarName
 

Initializes Voce. This function performs some extra stuff needed to setup the Java virtual machine and cache the Java method IDs. The 'vocePath' argument is the path to the Voce class files and config file. This path can be absolute or relative to the working directory of the executable using Voce. See documentation for the Java version for an explanation of the rest of the parameters.

Definition at line 132 of file voce.h.

References voce::internal::loadJavaMethodID(), and voce::internal::log().

bool isRecognizerEnabled  ) 
 

Returns true if the recognizer is currently enabled.

Definition at line 385 of file voce.h.

References voce::internal::log().

std::string popRecognizedString  ) 
 

Returns and removes the oldest recognized string from the recognizer's queue.

Definition at line 346 of file voce.h.

References voce::internal::log().

void setRecognizerEnabled bool  e  ) 
 

Enables and disables the speech recognizer.

Definition at line 371 of file voce.h.

References voce::internal::log().

void stopSynthesizing  ) 
 

Tells the speech synthesizer to stop synthesizing. This cancels all pending messages.

Definition at line 316 of file voce.h.

References voce::internal::log().

void synthesize const std::string &  message  ) 
 

Requests that the given string be synthesized as soon as possible.

Definition at line 298 of file voce.h.

References voce::internal::log().


Variable Documentation

const std::string voce::pathSeparator = ":"
 

Definition at line 44 of file voce.h.


Generated on Wed Aug 3 16:23:08 2005 for Voce C++ API by  doxygen 1.4.1