diaGlobWrapper Help
Plays a text through the TextToSpeech engine.

Namespace:  Inkostar
Assembly:  DiaGlobWrapper (in DiaGlobWrapper.dll) Version: 0.0.0.0

Syntax

C#
public void PlayTextToSpeech(
	Channel CurrentChannel,
	string TextToSpeak,
	DiaGlobWrapperCommon..::.SyncMode PlayMode,
	bool InterruptPromptOnDigit
)
Visual Basic (Declaration)
Public Sub PlayTextToSpeech ( _
	CurrentChannel As Channel, _
	TextToSpeak As String, _
	PlayMode As DiaGlobWrapperCommon..::.SyncMode, _
	InterruptPromptOnDigit As Boolean _
)
Visual C++
public:
void PlayTextToSpeech(
	Channel^ CurrentChannel, 
	String^ TextToSpeak, 
	DiaGlobWrapperCommon..::.SyncMode PlayMode, 
	bool InterruptPromptOnDigit
)

Parameters

CurrentChannel
Type: Inkostar..::.Channel
The Channel on the Dialogic board on which the function is to be executed.
TextToSpeak
Type: System..::.String
The text to be spoken.
PlayMode
Type: Inkostar..::.DiaGlobWrapperCommon..::.SyncMode
An enumerated constant to indicate weather the playback operation should be performed asynchronously (Asynchronous) or synchronously (Synchronous). If mode is Asynchronous, the function will return immediately after being invoked while the playpack is being performed. In such case the event EventReceived.PlaybackStopped will be raised once the playback is finished or interrupted.
InterruptPromptOnDigit
Type: System..::.Boolean
A boolean value if set to True will cause the playback to be interrupted when any digit is pressed.

Remarks

This function can only be invoked when the call is in a connected state.
Compatibility: All
On failure this function will generate an exception of type DiaGlobWrapperLibException

Examples

To Play 'please input your card expiry date' synchronously on the inbound channel without being able to interrupt the playback.
C#: objDevice.PlayTextToSpeech(ChannelInbound, "please input your card expiry date", Inkostar.DiaGlobWrapperCommon.SyncMode.Asynchronous, false);
VB.NET: objDevice.PlayTextToSpeech(ChannelInbound, "please input your card expiry date", Inkostar.DiaGlobWrapperCommon.SyncMode.Synchronous, False)

See Also