C# Class TelAPI.InboundXML.Element.GetSpeech

Inheritance: ELement
Mostra file Open project: TelAPI/telapi-dotnet Class Usage Examples

Private Properties

Property Type Description

Public Methods

Method Description
Create ( string grammar, string action ) : GetSpeech

The GetSpeech element is used to translate a callers voice into text.
Create ( string grammar, string action, HttpMethod method, long timeout, bool playBeep ) : GetSpeech

The GetSpeech element is used to translate a callers voice into text.
GetSpeech ( ) : System
Pause ( ) : GetSpeech

The Pause element will pause the call
Pause ( long length ) : GetSpeech

The Pause element will pause the call, holding for the number of seconds set by the length attribute.
Play ( string resource, long loop ) : GetSpeech

The Play element plays an mp3 file for the caller
Say ( string text, Voice voice, long loop ) : GetSpeech

The Say element reads text to the caller using a text-to-speech engine.

Method Details

Create() public static method

The GetSpeech element is used to translate a callers voice into text.
public static Create ( string grammar, string action ) : GetSpeech
grammar string An XML file defining acceptable words and phrases that a user might say during the call.
action string A URL where the converted voice text will be forwarded.
return GetSpeech

Create() public static method

The GetSpeech element is used to translate a callers voice into text.
public static Create ( string grammar, string action, HttpMethod method, long timeout, bool playBeep ) : GetSpeech
grammar string An XML file defining acceptable words and phrases that a user might say during the call.
action string A URL where the converted voice text will be forwarded.
method HttpMethod Method used to request the action URL.
timeout long Amount of seconds GetSpeech should wait in silence before requesting the action URL.
playBeep bool Specifies if a beep should playback to the caller when GetSpeech begins.
return GetSpeech

GetSpeech() public method

public GetSpeech ( ) : System
return System

Pause() public method

The Pause element will pause the call
public Pause ( ) : GetSpeech
return GetSpeech

Pause() public method

The Pause element will pause the call, holding for the number of seconds set by the length attribute.
public Pause ( long length ) : GetSpeech
length long The length in seconds the pause should be.
return GetSpeech

Play() public method

The Play element plays an mp3 file for the caller
public Play ( string resource, long loop ) : GetSpeech
resource string Url of the mp3 audio
loop long The amount of times the Play should be repeated. 0 indicates an infinite loop.
return GetSpeech

Say() public method

The Say element reads text to the caller using a text-to-speech engine.
public Say ( string text, Voice voice, long loop ) : GetSpeech
text string Text to say
voice Voice The type of voice that will read the text to caller.
loop long The amount of times the spoken text should be repeated. 0 indicates an infinite loop.
return GetSpeech