Text To Speech Driver

RSS

The Text To Speech driver can convert normal language text to spoken words.

Manufacturer: N/A

Table of Contents [Hide/Show]

Configuration Settings
Events
   Ready State Changed
Instance Properties
   DeviceDisplayName
   DeviceStartTime
   DeviceLifecycleStage
   DeviceIsRunningAndReady
Instance Methods
   Speak ( String )
   Speak ( String, String )
   SetPropertyForDuration ( String, TimeSpan, Object, Object )
   SetPropertyForDuration ( String, Number, TimeSpan, Object, Object )

Configuration Settings

Voice Name : (optional) The name of the voice to use (in English) such as 'Microsoft Anna'. The name is case-sensitive so be sure to enter it correctly. You can find available names in the Vista control panel called 'Text To Speech', and in XP it's 'Speech'.

Events

Ready State Changed

The device's running and ready state changed.

Whenever Filter:

none

EventArgs:

Number NewValue : The new property value.
Number PreviousValue : The previous property value.

Instance Properties

DeviceDisplayName

The display name for this device.

Accessibility : Read Only

Type: String

DeviceStartTime

The date and time when this device was started.

Accessibility : Read Only

Type: DateTime

DeviceLifecycleStage

The current lifecycle stage of the device. The stages in order are: Pending Start, Starting, Running, Stopping

Accessibility : Read Only

Type: Number

DeviceIsRunningAndReady

Indicates if the device is ready for use, ie it is in the Running lifecycle stage and all properties are valid and all methods are ready to be used.

Accessibility : Read Only

Type: Boolean

Instance Methods

Speak ( String )

The computer will speak the specified text using the configuration in the Text To Speech control panel.

Syntax

void Speak( String text )

Parameters

text : The text to speak.

Speak ( String, String )

The computer will speak the specified text using the configuration in the Text To Speech control panel.

Syntax

void Speak( String text, String voiceName )

Parameters

text : The text to speak.

voiceName : The name of the voice to use such as 'Microsoft Anna'.

SetPropertyForDuration ( String, TimeSpan, Object, Object )

Sets a property for a duration of time and then sets the property to a subequent value asynchronously. This action returns after setting the first value and the timer and subsequent property set run in the background. Subsequent sets of the same property will reset the timer if the subsequent value has not yet been set. This is an advanced feature, be sure to set the property name correctly.

Syntax

void SetPropertyForDuration( String propertyName, unknown duration, Object initialValue, Object finalValue )

Parameters

propertyName : The name of the property to set.

duration : The amount of time to wait after setting the initial value to set the subsequent value.

initialValue : The value to set the property to initially.

finalValue : The value to set the property to after the duration of time has passed.

SetPropertyForDuration ( String, Number, TimeSpan, Object, Object )

void SetPropertyForDuration( String propertyName, Number arrayIndex, unknown duration, Object initialValue, Object finalValue )

Parameters

propertyName : The name of the property to set.

arrayIndex : The property's array index to set.

duration : The amount of time to wait after setting the initial value to set the subsequent value.

initialValue : The value to set the property to initially.

finalValue : The value to set the property to after the duration of time has passed.