AT&T API Platform SDK for Microsoft®  2.3.3
Wrapper classes that allow developers to build robust applications using .NET
 All Classes Namespaces Functions Enumerations Properties
Speech Methods

Classes

class  ATT_MSSDK.RequestFactory
 The RequestFactory manages the connections and calls to the AT&T API Platform. More...

Functions

SpeechResponse ATT_MSSDK.RequestFactory.SpeechToText (string audioFilePath)
 This method converts spoken audio to text.
SpeechResponse ATT_MSSDK.RequestFactory.SpeechToText (string audioFilePath, XSpeechContext speechContext)
 This method converts spoken audio to text.
SpeechResponse ATT_MSSDK.RequestFactory.SpeechToText (string audioFilePath, NameValueCollection xArgsCollection)
 This method converts spoken audio to text.
SpeechResponse ATT_MSSDK.RequestFactory.SpeechToText (string audioFilePath, XSpeechContext speechContext, NameValueCollection xArgsCollection)
 This method converts spoken audio to text.
SpeechResponse ATT_MSSDK.RequestFactory.SpeechToText (string audioFilePath, XSpeechContext speechContext, string xArgs, string contentLanguage=null, string speechSubContext=null, string audioContentType=null)
 This method converts spoken audio to text.
SpeechResponse ATT_MSSDK.RequestFactory.SpeechToText (string audioFilePath, XArgs xArgs)
 This method converts spoken audio to text.
SpeechResponse ATT_MSSDK.RequestFactory.SpeechToText (string audioFilePath, XSpeechContext speechContext, XArgs xArgs)
 This method converts spoken audio to text.
SpeechResponse ATT_MSSDK.RequestFactory.SpeechToText (string audioFilePath, XSpeechContext speechContext, XArgs xArgs, string xSpeechSubContext, string audioContentType=null)
 This method converts spoken audio to text.
SpeechResponse ATT_MSSDK.RequestFactory.SpeechToText (string audioFilePath, string speechContext)
 This method converts spoken audio to text.
SpeechResponse ATT_MSSDK.RequestFactory.SpeechToText (string audioFilePath, string speechContext, string xArgsParameter)
 This method converts spoken audio to text.

Function Documentation

SpeechResponse ATT_MSSDK.RequestFactory.SpeechToText ( string  audioFilePath)

This method converts spoken audio to text.

Parameters:
audioFilePathAudio file path
Returns:
ATT_MSSDK.Speechv3.SpeechResponse An Speech response object containing the results.
Exceptions:
ArgumentExceptionThrown if an argument is invalid.
InvalidScopeExceptionThrown if the Request Factory scope does not include SPEECH.
InvalidResponseExceptionThrown if the server returns an error or there is a connection failure.
SpeechResponse ATT_MSSDK.RequestFactory.SpeechToText ( string  audioFilePath,
XSpeechContext  speechContext 
)

This method converts spoken audio to text.

Parameters:
audioFilePathAudio file path
speechContextX-Speech Context
Returns:
ATT_MSSDK.Speechv3.SpeechResponse An Speech response object containing the results.
Exceptions:
ArgumentExceptionThrown if an argument is invalid.
InvalidScopeExceptionThrown if the Request Factory scope does not include SMS.
InvalidResponseExceptionThrown if the server returns an error or there is a connection failure.
SpeechResponse ATT_MSSDK.RequestFactory.SpeechToText ( string  audioFilePath,
NameValueCollection  xArgsCollection 
)

This method converts spoken audio to text.

Parameters:
audioFilePathAudio file path
xArgsCollectionX-Arg Collection, The X-Arg header field is a meta parameter that can be used to define multiple parameter name/value pairs. The preferred way to provide these parameters is as a set of name/value pair strings in the format: X-Arg: param1=value1,param2=value2,param3=value3
Returns:
ATT_MSSDK.Speechv3.SpeechResponse An Speech response object containing the results.
Exceptions:
ArgumentExceptionThrown if an argument is invalid.
InvalidScopeExceptionThrown if the Request Factory scope does not include SMS.
InvalidResponseExceptionThrown if the server returns an error or there is a connection failure.
SpeechResponse ATT_MSSDK.RequestFactory.SpeechToText ( string  audioFilePath,
XSpeechContext  speechContext,
NameValueCollection  xArgsCollection 
)

This method converts spoken audio to text.

Parameters:
audioFilePathAudio file path
speechContextX-Speech Context
xArgsCollectionX-Arg Collection, The X-Arg header field is a meta parameter that can be used to define multiple parameter name/value pairs. The preferred way to provide these parameters is as a set of name/value pair strings in the format: X-Arg: param1=value1,param2=value2,param3=value3
Returns:
ATT_MSSDK.Speechv3.SpeechResponse An Speech response object containing the results.
Exceptions:
ArgumentExceptionThrown if an argument is invalid.
InvalidScopeExceptionThrown if the Request Factory scope does not include SMS.
InvalidResponseExceptionThrown if the server returns an error or there is a connection failure.
SpeechResponse ATT_MSSDK.RequestFactory.SpeechToText ( string  audioFilePath,
XSpeechContext  speechContext,
string  xArgs,
string  contentLanguage = null,
string  speechSubContext = null,
string  audioContentType = null 
)

This method converts spoken audio to text.

Parameters:
audioFilePathAudio file path
speechContextX-Speech Context
xArgsThe X-Arg header field is a meta parameter that can be used to define multiple parameter name/value pairs. The preferred way to provide these parameters is as a set of name/value pair strings in the format: X-Arg: param1=value1,param2=value2,param3=value3
contentLanguageFor Generic Context only. Specifies the language of the submitted audio with one of the following two choices: ‘en-US’ (English - United States) and ‘es-US’ (Spanish - United States).
speechSubContextOnly used when X-SpeechContext is set to Gaming.
audioContentTypeCustom audio content type. e.g. audio/wav
Returns:
ATT_MSSDK.Speechv3.SpeechResponse An Speech response object containing the results.
Exceptions:
ArgumentExceptionThrown if an argument is invalid.
InvalidScopeExceptionThrown if the Request Factory scope does not include SMS.
InvalidResponseExceptionThrown if the server returns an error or there is a connection failure.
SpeechResponse ATT_MSSDK.RequestFactory.SpeechToText ( string  audioFilePath,
XArgs  xArgs 
)

This method converts spoken audio to text.

Parameters:
audioFilePathAudio file path
xArgsXArgs class, The X-Arg header field is a meta parameter that can be used to define multiple parameter name/value pairs. The preferred way to provide these parameters is as a set of name/value pair strings in the format: X-Arg: param1=value1,param2=value2,param3=value3
Returns:
ATT_MSSDK.Speechv3.SpeechResponse An Speech response object containing the results.
Exceptions:
ArgumentExceptionThrown if an argument is invalid.
InvalidScopeExceptionThrown if the Request Factory scope does not include SMS.
InvalidResponseExceptionThrown if the server returns an error or there is a connection failure.
SpeechResponse ATT_MSSDK.RequestFactory.SpeechToText ( string  audioFilePath,
XSpeechContext  speechContext,
XArgs  xArgs 
)

This method converts spoken audio to text.

Parameters:
audioFilePathAudio file path
speechContextX-Speech Context
xArgsXArgs class, The X-Arg header field is a meta parameter that can be used to define multiple parameter name/value pairs. The preferred way to provide these parameters is as a set of name/value pair strings in the format: X-Arg: param1=value1,param2=value2,param3=value3
Returns:
ATT_MSSDK.Speechv3.SpeechResponse An Speech response object containing the results.
Exceptions:
ArgumentExceptionThrown if an argument is invalid.
InvalidScopeExceptionThrown if the Request Factory scope does not include SMS.
InvalidResponseExceptionThrown if the server returns an error or there is a connection failure.
SpeechResponse ATT_MSSDK.RequestFactory.SpeechToText ( string  audioFilePath,
XSpeechContext  speechContext,
XArgs  xArgs,
string  xSpeechSubContext,
string  audioContentType = null 
)

This method converts spoken audio to text.

Parameters:
audioFilePathAudio file path
speechContextX-Speech Context
xArgsXArgs class, The X-Arg header field is a meta parameter that can be used to define multiple parameter name/value pairs. The preferred way to provide these parameters is as a set of name/value pair strings in the format: X-Arg: param1=value1,param2=value2,param3=value3
xSpeechSubContextOnly used when X-SpeechContext is set to Gaming.
audioContentTypeCustom audio content type. e.g. audio/wav
Returns:
ATT_MSSDK.Speechv3.SpeechResponse An Speech response object containing the results.
Exceptions:
ArgumentExceptionThrown if an argument is invalid.
InvalidScopeExceptionThrown if the Request Factory scope does not include SMS.
InvalidResponseExceptionThrown if the server returns an error or there is a connection failure.
SpeechResponse ATT_MSSDK.RequestFactory.SpeechToText ( string  audioFilePath,
string  speechContext 
)

This method converts spoken audio to text.

Parameters:
audioFilePathAudio file path
speechContextSpeech Context
Returns:
ATT_MSSDK.Speechv3.SpeechResponse An Speech response object containing the results.
Exceptions:
ArgumentExceptionThrown if an argument is invalid.
InvalidScopeExceptionThrown if the Request Factory scope does not include SMS.
InvalidResponseExceptionThrown if the server returns an error or there is a connection failure.
SpeechResponse ATT_MSSDK.RequestFactory.SpeechToText ( string  audioFilePath,
string  speechContext,
string  xArgsParameter 
)

This method converts spoken audio to text.

Parameters:
audioFilePathAudio file path
speechContextSpeech Context
xArgsParameterX-Arg Parameter, The X-Arg header field is a meta parameter that can be used to define multiple parameter name/value pairs. The preferred way to provide these parameters is as a set of name/value pair strings in the format: X-Arg: param1=value1,param2=value2,param3=value3
Returns:
ATT_MSSDK.Speechv3.SpeechResponse An Speech response object containing the results.
Exceptions:
ArgumentExceptionThrown if an argument is invalid.
InvalidScopeExceptionThrown if the Request Factory scope does not include SMS.
InvalidResponseExceptionThrown if the server returns an error or there is a connection failure.