By: Yaron Goali (WISERBIT DOT COM) for Microncode.com

User Control: cWaveTTS

Properties

IsTTSPause [Get] - Public (Return Datatype: Boolean)


Description: Check if the speaking is paused.
No Parameters

IsTTSSpeaking [Get] - Public (Return Datatype: Boolean)


Description: Check if the control is speaking.
No Parameters

Voice_Flags [Let] - Public


Description: Set the flags of the voice.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	Val	TTSFlags

Voice_Format [Let] - Public


Description: Set the voice format.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	Val	VoiceFormats

Voice_Index [Let] - Public


Description: Set the voice index.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	Val	Long

Voice_Output [Let] - Public


Description: Set the voice output index.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	Val	Long

Voice_Rate [Get] - Public (Return Datatype: Long)


Description: Get the rate of the voice (-10 to 10).
No Parameters

Voice_Rate [Let] - Public


Description: Set the rate of the voice (-10 to 10).

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	Val	Long

Voice_Volume [Get] - Public (Return Datatype: Long)


Description: Get the volume of the voice (0 to 100).
No Parameters

Voice_Volume [Let] - Public


Description: Set the volume of the voice (0 to 100).

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	Val	Long

Functions

DeInit - Public (Return Datatype: Long)


Description: DeInit the control, must be call before closing the program.
Return: 0 if success, otherwise a number describe the error.
No Parameters

Formats - Public


Optional	ByVal/ByRef	Variable	Datatype
		sFormatName	String
		sFormatValue	Long

GetFormats - Public (Return Datatype: Long)

No Parameters

GetOutputs - Public (Return Datatype: Collection)


Description: Get all the outputs devices.
Return: Collection of outputs devices..
No Parameters

GetOutputsX - Public (Return Datatype: Long)


Description: Set the component to get all the outputs devices.
Return: A counter. The number of the outputs, 0 if fail.
Version: From V.2
No Parameters

GetOutputXVal - Public (Return Datatype: String)


Description: Get the Outputname by index.
Return: String with the Output name.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lIndex	Long

GetVoices - Public (Return Datatype: Collection)


Description: Get all the voices.
Return: Collection of voices that installed the local machine.
No Parameters

GetVoicesX - Public (Return Datatype: Long)


Description: Set the component to get all the voices that installed the local machine.
Return: A counter. The number of the voices, 0 if fail.
Version: From V.2
No Parameters

GetVoiceXVal - Public (Return Datatype: String)


Description: Get the Voice name by index.
Return: String with the Voice name.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lIndex	Long

Init - Public (Return Datatype: Long)


Description: Init the control, must be call before using any functionality of the control.
Return: 0 if success, otherwise a number describe the error.

Optional	ByVal/ByRef	Variable	Datatype
Optional	ByVal	sKey	String

Speak - Public (Return Datatype: Long)


Description: Start to speak the sText string.
Return: Zero if success, or an number describe the error.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	sText	String

SpeakPause - Public (Return Datatype: Long)


Description: Pause the speak, bVal can be True to pause, False to un-pause.
Return: Zero if success, or an number describe the error.

Optional	ByVal/ByRef	Variable	Datatype
Optional		bVal	Boolean(True)

SpeakStop - Public (Return Datatype: Long)


Description: Stop to speak.
Return: Zero if success, or an number describe the error.
No Parameters

SpeakToWaveFile - Public (Return Datatype: Long)


Description: Save the sText string to wave file.
Return: Zero if success, or an number describe the error.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	sText	String
	ByVal	sFileName	String
Optional		bDoEvents	Boolean

Event Declares

Done - Public


Raise when done to speak the selected text.
No Parameters

Error - Public


Error handling: ErrNum - error number, ErrDescription - error description.

Optional	ByVal/ByRef	Variable	Datatype
		lErrNum	Long
		sErrDescription	String

Start - Public


Raise when start to speak the selected text.
No Parameters

Word - Public


Raise when speak the current word.

Optional	ByVal/ByRef	Variable	Datatype
		Position	Long
		Length	Long