EUROPEAN SYNCHROTRON RADIATION FACILITY
INSTALLATION EUROPEENNE DE RAYONNEMENT SYNCHROTRON
ESRF Logo
Main Page   Namespace List   Alphabetical List   Compound List   File List   Compound Members   File Members  

TextTalker::TextTalker Class Reference

Class Description: This is a text-to-speech server. More...

#include <TextTalker.h>

List of all members.

Public Methods

void TTSSay ()
 To talk one time what is stored in text_to_talk and the silence (num_pause msec). More...

Constructors
Miscellaneous constructors

 TextTalker (Tango::DeviceClass *, string &)
 Constructs a newly allocated Command object. More...

 TextTalker (Tango::DeviceClass *, const char *)
 Constructs a newly allocated Command object. More...

 TextTalker (Tango::DeviceClass *, const char *, const char *)
 Constructs a newly allocated Command object. More...

Destructor
Only one destructor is defined for this class

 ~TextTalker ()
 The object desctructor. More...

void delete_device ()
 will be called at device destruction or at init command. More...

Miscellaneous methods
virtual void init_device ()
 Initialize the device. More...

virtual void always_executed_hook ()
 Always executed method befor execution command method. More...

TextTalker methods prototypes
virtual void read_attr_hardware (vector< long > &attr_list)
 Hardware acquisition for attributes. More...

virtual void read_attr (Tango::Attribute &attr)
 Extract real attribute values from hardware acquisition result. More...

virtual void write_attr_hardware (vector< long > &attr_list)
 Write attribute values to hardware. More...

virtual Tango::DevState dev_state ()
 method: TextTalker::dev_state. More...

virtual Tango::ConstDevString dev_status ()
 method: TextTalker::dev_status. More...

void dev_write (Tango::DevString)
 method: TextTalker::dev_write. More...

void dev_talk (Tango::DevString)
 method: TextTalker::dev_talk. More...

void dev_set_param (const Tango::DevVarLongArray *)
 method: TextTalker::dev_set_param. More...

void dev_stop ()
 method: TextTalker::dev_stop. More...

Tango::DevString dev_read ()
 method: TextTalker::dev_read. More...

void dev_clear ()
 method: TextTalker::dev_clear. More...

Tango::DevVarLongArray * dev_read_param ()
 method: TextTalker::dev_read_param. More...

void dev_run ()
 method: TextTalker::dev_run. More...

void pause ()
 method: TextTalker::pause. More...

void resume ()
 method: TextTalker::resume. More...

void write_welcome_text (Tango::DevString)
 method: TextTalker::write_welcome_text. More...

Tango::DevString read_welcome_text ()
 method: TextTalker::read_welcome_text. More...

void get_device_property ()
 Read the device properties from database. More...


Public Attributes

wchar_t tfs [1000]
wchar_t tts [10000]
wchar_t ttsstart [10000]
wchar_t ttg [15]
enum SPVPRIORITY THE_PRIORITY
attributes
Attributs member data.

Tango::DevString * attr_gender_read
Tango::DevString attr_gender_write
Tango::DevShort * attr_volume_read
Tango::DevShort attr_volume_write
Tango::DevLong * attr_rate_read
Tango::DevLong attr_rate_write
Tango::DevString * attr_priority_read
Tango::DevString attr_priority_write
Tango::DevLong * attr_num_pause_read
Tango::DevLong attr_num_pause_write
Tango::DevLong * attr_repeat_read
Tango::DevLong attr_repeat_write
Tango::DevString * attr_text_to_talk_read
Tango::DevString attr_text_to_talk_write
Device properties
Device properties member data.

string text_to_talk
 Device server's speech buffer. More...

Tango::DevLong repeat
 Number of repeated talks. More...

Tango::DevLong num_pause
 Number of msec of pause between 2 repeated talks. More...

string gender
 Voice's gender. More...

Tango::DevUShort volume
 The synthesizer output volume level of the voice. More...

Tango::DevLong rate
 Speaking rate of the voice. More...

string priority
 Priority for the voice. More...

string start_text
 This text will be spoken at the initialization of the server. More...


Protected Attributes

ISpVoice * pVoice


Detailed Description

Class Description: This is a text-to-speech server.


Constructor & Destructor Documentation

TextTalker::TextTalker::TextTalker Tango::DeviceClass *   ,
string &   
 

Constructs a newly allocated Command object.

Parameters:
cl  Class.
s  Device Name

TextTalker::TextTalker::TextTalker Tango::DeviceClass *   ,
const char *   
 

Constructs a newly allocated Command object.

Parameters:
cl  Class.
s  Device Name

TextTalker::TextTalker::TextTalker Tango::DeviceClass *   ,
const char *   ,
const char *   
 

Constructs a newly allocated Command object.

Parameters:
cl  Class.
s  Device name
d  Device description.

TextTalker::TextTalker::~TextTalker   [inline]
 

The object desctructor.


Member Function Documentation

void TextTalker::TextTalker::always_executed_hook   [virtual]
 

Always executed method befor execution command method.

void TextTalker::TextTalker::delete_device  
 

will be called at device destruction or at init command.

void TextTalker::TextTalker::dev_clear  
 

method: TextTalker::dev_clear.

Exceptions:
DevFailed 

Tango::DevString TextTalker::TextTalker::dev_read  
 

method: TextTalker::dev_read.

Returns:
The actual message buffered in the talking server
Exceptions:
DevFailed 

Tango::DevVarLongArray * TextTalker::TextTalker::dev_read_param  
 

method: TextTalker::dev_read_param.

(number of repeated loops and time of pause between 2 repeated speaks)

Returns:
Array of configuration parameters : argin[0] -> number of repeated talks,argin[1] -> number of msec of pause between 2 repeated talks.
Exceptions:
DevFailed 

void TextTalker::TextTalker::dev_run  
 

method: TextTalker::dev_run.

Exceptions:
DevFailed 

void TextTalker::TextTalker::dev_set_param const Tango::DevVarLongArray *   
 

method: TextTalker::dev_set_param.

Parameters:
argin  Array of configuration parameters : argin[0] -> number of repeated talks,argin[1] -> number of msec of pause between 2 repeated talks.
Exceptions:
DevFailed 

Tango::DevState TextTalker::TextTalker::dev_state   [virtual]
 

method: TextTalker::dev_state.

Returns:
State Code
Exceptions:
DevFailed 

Tango::ConstDevString TextTalker::TextTalker::dev_status   [virtual]
 

method: TextTalker::dev_status.

Returns:
Status descrition
Exceptions:
DevFailed 

void TextTalker::TextTalker::dev_stop  
 

method: TextTalker::dev_stop.

Exceptions:
DevFailed 

void TextTalker::TextTalker::dev_talk Tango::DevString   
 

method: TextTalker::dev_talk.

Parameters:
argin  The message
Exceptions:
DevFailed 

void TextTalker::TextTalker::dev_write Tango::DevString   
 

method: TextTalker::dev_write.

Parameters:
argin  The message
Exceptions:
DevFailed 

void TextTalker::TextTalker::get_device_property  
 

Read the device properties from database.

void TextTalker::TextTalker::init_device   [virtual]
 

Initialize the device.

void TextTalker::TextTalker::pause  
 

method: TextTalker::pause.

Calling Pause while the voice is not speaking increments the pause count and will put the voice into a paused state until Resume is called the same number of times. The voice maintains a pause count, so each call to pause must be balanced with a corresponding call to Resume.

Exceptions:
DevFailed 

void TextTalker::TextTalker::read_attr Tango::Attribute &    attr [virtual]
 

Extract real attribute values from hardware acquisition result.

void TextTalker::TextTalker::read_attr_hardware vector< long > &    attr_list [virtual]
 

Hardware acquisition for attributes.

Tango::DevString TextTalker::TextTalker::read_welcome_text  
 

method: TextTalker::read_welcome_text.

Returns:
The current welcome text
Exceptions:
DevFailed 

void TextTalker::TextTalker::resume  
 

method: TextTalker::resume.

Decrements the pause count (which is incremented by Pause) if the voice is currently paused. If the pause count hits zero, Resume attempts to reclaim the output device and resumes rendering. This method has no effect if the voice was not in a paused state.

Exceptions:
DevFailed 

void TextTalker::TextTalker::TTSSay  
 

To talk one time what is stored in text_to_talk and the silence (num_pause msec).

void TextTalker::TextTalker::write_attr_hardware vector< long > &    attr_list [virtual]
 

Write attribute values to hardware.

void TextTalker::TextTalker::write_welcome_text Tango::DevString   
 

method: TextTalker::write_welcome_text.

Parameters:
argin  The welcome text
Exceptions:
DevFailed 


Member Data Documentation

Tango::DevString* TextTalker::TextTalker::attr_gender_read
 

Tango::DevString TextTalker::TextTalker::attr_gender_write
 

Tango::DevLong* TextTalker::TextTalker::attr_num_pause_read
 

Tango::DevLong TextTalker::TextTalker::attr_num_pause_write
 

Tango::DevString* TextTalker::TextTalker::attr_priority_read
 

Tango::DevString TextTalker::TextTalker::attr_priority_write
 

Tango::DevLong* TextTalker::TextTalker::attr_rate_read
 

Tango::DevLong TextTalker::TextTalker::attr_rate_write
 

Tango::DevLong* TextTalker::TextTalker::attr_repeat_read
 

Tango::DevLong TextTalker::TextTalker::attr_repeat_write
 

Tango::DevString* TextTalker::TextTalker::attr_text_to_talk_read
 

Tango::DevString TextTalker::TextTalker::attr_text_to_talk_write
 

Tango::DevShort* TextTalker::TextTalker::attr_volume_read
 

Tango::DevShort TextTalker::TextTalker::attr_volume_write
 

string TextTalker::TextTalker::gender
 

Voice's gender.

Supported values are : "male" or "female".

Tango::DevLong TextTalker::TextTalker::num_pause
 

Number of msec of pause between 2 repeated talks.

string TextTalker::TextTalker::priority
 

Priority for the voice.

Supported values : "normal" = Normal priority, "alert" = Alert priority, "over" = Over priority (the voice should mix its audio with all other audio on the system with no synchronization). OVER voices only mix their audio on Windows 2000.

ISpVoice* TextTalker::TextTalker::pVoice [protected]
 

Tango::DevLong TextTalker::TextTalker::rate
 

Speaking rate of the voice.

Supported values range from -10 to 10.

Tango::DevLong TextTalker::TextTalker::repeat
 

Number of repeated talks.

string TextTalker::TextTalker::start_text
 

This text will be spoken at the initialization of the server.

string TextTalker::TextTalker::text_to_talk
 

Device server's speech buffer.

wchar_t TextTalker::TextTalker::tfs[1000]
 

enum SPVPRIORITY TextTalker::TextTalker::THE_PRIORITY
 

wchar_t TextTalker::TextTalker::ttg[15]
 

wchar_t TextTalker::TextTalker::tts[10000]
 

wchar_t TextTalker::TextTalker::ttsstart[10000]
 

Tango::DevUShort TextTalker::TextTalker::volume
 

The synthesizer output volume level of the voice.

Volume levels are specified in percentage values ranging from zero to 100.


The documentation for this class was generated from the following files: Tango Device Server User's Guide



(c) ESRF - Software Engineering Group