Speak Method
Returns a string which is a URL to a wave or mp3 stream of the passed-in text being spoken in the desired language.
| C# |
|---|
| string Microsoft.Translator.Speak(appId, text, language, format); |
| Parameter | Description |
|---|---|
|
appId |
Required. If the Authorization header is used, leave the appid field empty else specify a string containing "Bearer" + " " + access token. |
|
text |
Required. A string containing a sentence or sentences of the specified language to be spoken for the wave stream. The size of the text to speak must not exceed 2000 characters. |
|
language |
Required. A string representing the supported language code to speak the text in. The code must be present in the list of codes returned from the method GetLanguagesForSpeak. |
|
format |
Optional. A string specifying the content-type ID. Currently, “audio/wav” and “audio/mp3” are available. The default value is "audio/wav". |
|
options |
Optional. A string specifying the quality of the audio signals. Currently, “MaxQuality” and “MinSize” are available. With “MaxQuality”, you can get the voice(s) with the highest quality, and with “MinSize”, you can get the voices with the smallest size. If no value is provided, we default to “MinSize”. |
The following table describes required and optional request headers.
| Request Header | Description |
|---|---|
|
Authorization |
Required. Specify the the value of access_token in format "Bearer" + " " + Access Token Value |
Returns a string which is a URL to a wave or mp3 stream of the passed-in text being spoken in the desired language.
Note
|
|---|
|
Bing App ID is deprecated and is no longer supported. Please obtain an access token to use the Microsoft Translator API. For details, go here. |
Example
C#PHP
using System;
using System.IO;
using System.Net;
using System.Runtime.Serialization;
using System.Runtime.Serialization.Json;
using System.ServiceModel;
using System.ServiceModel.Channels;
using System.Text;
using System.Web;
namespace MicrosoftTranslatorSdk.SoapSamples
{
class Program
{
static void Main(string[] args)
{
AdmAccessToken admToken;
string headerValue;
//Get Client Id and Client Secret from https://datamarket.azure.com/developer/applications/
//Refer obtaining AccessToken (http://msdn.microsoft.com/en-us/library/hh454950.aspx)
AdmAuthentication admAuth = new AdmAuthentication("clientid", "clientSecret");
try
{
admToken = admAuth.GetAccessToken();
DateTime tokenReceived = DateTime.Now;
// Create a header with the access_token property of the returned token
headerValue = "Bearer " + admToken.access_token;
SpeakMethod(headerValue);
}
catch (Exception ex)
{
Console.WriteLine(ex.Message);
Console.WriteLine("Press any key to continue...");
Console.ReadKey(true);
}
}
private static void SpeakMethod(string authToken)
{
MicrosoftTranslatorSdk.SoapSamples.TranslatorService.LanguageServiceClient client = new MicrosoftTranslatorSdk.SoapSamples.TranslatorService.LanguageServiceClient();
//Set Authorization header before sending the request
HttpRequestMessageProperty httpRequestProperty = new HttpRequestMessageProperty();
httpRequestProperty.Method = "POST";
httpRequestProperty.Headers.Add("Authorization", authToken);
// Creates a block within which an OperationContext object is in scope.
using (OperationContextScope scope = new OperationContextScope(client.InnerChannel))
{
OperationContext.Current.OutgoingMessageProperties[HttpRequestMessageProperty.Name] = httpRequestProperty;
string sourceText = "Welcome";
string speakurl;
// Keep appId parameter blank as we are sending access token in authorization header.
speakurl = client.Speak("", sourceText, "en", "audio/wav", "MinSize");
Console.WriteLine(speakurl);
Console.WriteLine("Press any key to continue...");
Console.ReadKey(true);
}
}
}
}
Goto Top
<?php
class AccessTokenAuthentication {
/*
* Get the access token.
*
* @param string $grantType Grant type.
* @param string $scopeUrl Application Scopr URL.
* @param string $clientID Application client ID.
* @param string $clientSecret Application client ID.
* @param string $authUrl Oauth Url.
*
* @return string.
*/
function getTokens($grantType, $scopeUrl, $clientID, $clientSecret, $authUrl){
try {
//Initialize the Curl Session.
$ch = curl_init();
//Create the request Array.
$paramArr = array (
'grant_type' => $grantType,
'scope' => $scopeUrl,
'client_id' => $clientID,
'client_secret' => $clientSecret
);
//Create an Http Query.//
$paramArr = http_build_query($paramArr);
//Set the Curl URL.
curl_setopt($ch, CURLOPT_URL, $authUrl);
//Set HTTP POST Request.
curl_setopt($ch, CURLOPT_POST, TRUE);
//Set data to POST in HTTP "POST" Operation.
curl_setopt($ch, CURLOPT_POSTFIELDS, $paramArr);
//CURLOPT_RETURNTRANSFER- TRUE to return the transfer as a string of the return value of curl_exec().
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
//CURLOPT_SSL_VERIFYPEER- Set FALSE to stop cURL from verifying the peer's certificate.
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
//Execute the cURL session.
$strResponse = curl_exec($ch);
//Get the Error Code returned by Curl.
$curlErrno = curl_errno($ch);
if($curlErrno){
$curlError = curl_error($ch);
throw new Exception($curlError);
}
//Close the Curl Session.
curl_close($ch);
//Decode the returned JSON string.
$objResponse = json_decode($strResponse);
if ($objResponse->error){
throw new Exception($objResponse->error_description);
}
return $objResponse->access_token;
} catch (Exception $e) {
echo "Exception-".$e->getMessage();
}
}
}
/*
* Class:AccessTokenAuthentication
*
* Create SOAP Object.
*/
class SOAPMicrosoftTranslator {
/*
* Soap Object.
*
* @var ObjectArray.
*/
public $objSoap;
/*
* Create the SAOP object.
*
* @param string $accessToken Access Token string.
* @param string $wsdlUrl WSDL string.
*
* @return string.
*/
public function __construct($accessToken, $wsdlUrl){
try {
//Authorization header string.
$authHeader = "Authorization: Bearer ". $accessToken;
$contextArr = array(
'http' => array(
'header' => $authHeader
)
);
//Create a streams context.
$objContext = stream_context_create($contextArr);
$optionsArr = array (
'soap_version' => 'SOAP_1_2',
'encoding' => 'UTF-8',
'exceptions' => true,
'trace' => true,
'cache_wsdl' => 'WSDL_CACHE_NONE',
'stream_context' => $objContext,
'user_agent' => 'PHP-SOAP/'.PHP_VERSION."\r\n".$authHeader
);
//Call Soap Client.
$this->objSoap = new SoapClient($wsdlUrl, $optionsArr);
} catch(Exception $e){
echo "<h2>Exception Error!</h2>";
echo $e->getMessage();
}
}
}
try {
//Soap WSDL Url
$wsdlUrl = "http://api.microsofttranslator.com/V2/Soap.svc";
//Client ID of the application.
$clientID = "clientid";
//Client Secret key of the application.
$clientSecret = "clientsecret";
//OAuth Url.
$authUrl = "https://datamarket.accesscontrol.windows.net/v2/OAuth2-13/";
//Application Scope Url
$scopeUrl = "http://api.microsofttranslator.com";
//Application grant type
$grantType = "client_credentials";
//Create the Authentication object
$authObj = new AccessTokenAuthentication();
//Get the Access token
$accessToken = $authObj->getTokens($grantType, $scopeUrl, $clientID, $clientSecret, $authUrl);
//Create soap translator Object
$soapTranslator = new SOAPMicrosoftTranslator($accessToken, $wsdlUrl);
//Set the params.
$inputStr = "This is the sample string samplesamplesample sample";
$format = "audio/wav";
$language = "en";
//Request argument list.
$requestArg = array (
'text' => $inputStr,
'language' => $language,
'format' => $format,
//'options' => array('quality' =>'MaxQuality')
);
echo $response = $soapTranslator->objSoap->Speak($requestArg)->SpeakResult;
} catch (Exception $e) {
echo "Exception: " . $e->getMessage() . "<br/>";
}
Note