Quickstart: Run the Speech Devices SDK sample app on Windows
In this quickstart, you'll learn how to use the Speech Devices SDK for Windows to build a speech-enabled product or use it as a Conversation Transcription device. For Conversation Transcription only the Azure Kinect DK is supported. For other speech use linear mic arrays that provide a microphone array geometry are supported.
The application is built with the Speech SDK package, and the Eclipse Java IDE (v4) on 64-bit Windows. It runs on a 64-bit Java 8 runtime environment (JRE).
This quickstart requires:
- Operating System: 64-bit Windows
- A microphone array such as Azure Kinect DK
- Eclipse Java IDE
- Java 8 or JDK 8 only.
- Microsoft Visual C++ Redistributable
- An Azure subscription key for the Speech service. Get one for free.
- Download the latest version of the Speech Devices SDK for Java, and extract the .zip to your working directory.
The JRE-Sample-Release.zip file includes the JRE sample app and this quickstart assumes that the app is extracted to C:\SDSDK\JRE-Sample-Release
Conversation Transcription is currently only available for "en-US" and "zh-CN", in the “centralus” and “eastasia” regions. You must have a speech key in one of those regions to use Conversation Transcription.
If you plan to use the intents you'll need a Language Understanding Service (LUIS) subscription. To learn more about LUIS and intent recognition, see Recognize speech intents with LUIS, C#. A sample LUIS model is available for this app.
Create and configure the project
In the Eclipse IDE Launcher, in the Workspace field, enter the name of a new workspace directory. Then select Launch.
In a moment, the main window of the Eclipse IDE appears. Close the Welcome screen if one is present.
From the Eclipse menu bar, create a new project by choosing File > New > Java Project. If not available choose Project and then Java Project.
The New Java Project wizard starts. Browse for the location of the sample project. Select Finish.
In the Package explorer, right-click your project. Choose Configure > Convert to Maven Project from the context menu. Select Finish.
Open the pom.xml file and edit it.
At the end of the file, before the closing tag
dependencieselements, as shown here, and ensure the
versionmatches your current version:
<repositories> <repository> <id>maven-cognitiveservices-speech</id> <name>Microsoft Cognitive Services Speech Maven Repository</name> <url>https://csspeechstorage.blob.core.windows.net/maven/</url> </repository> </repositories> <dependencies> <dependency> <groupId>com.microsoft.cognitiveservices.speech</groupId> <artifactId>client-sdk</artifactId> <version>1.7.0</version> </dependency> </dependencies>
Copy the contents of Windows-x64 to the Java Project location, eg C:\SDSDK\JRE-Sample-Release
Microsoft.CognitiveServices.Speech.extension.pma.dllinto the project folder target\classes
Configure the sample application
Add your speech subscription key to the source code. If you want to try intent recognition, also add your Language Understanding service subscription key and application ID.
For speech and LUIS, your information goes into
// Subscription private static String SpeechSubscriptionKey = "<enter your subscription info here>"; private static String SpeechRegion = "westus"; // You can change this if your speech region is different. private static String LuisSubscriptionKey = "<enter your subscription info here>"; private static String LuisRegion = "westus2"; // you can change this, if you want to test the intent, and your LUIS region is different. private static String LuisAppId = "<enter your LUIS AppId>";
If you are using conversation transcription, your speech key and region information are also needed in
private static final String CTSKey = "<Conversation Transcription Service Key>"; private static final String CTSRegion="<Conversation Transcription Service Region>";// Region may be "centralus" or "eastasia"
The default keyword (keyword) is "Computer". You can also try one of the other provided keywords, like "Machine" or "Assistant". The resource files for these alternate keywords are in the Speech Devices SDK, in the keyword folder. For example,
C:\SDSDK\JRE-Sample-Release\keyword\Computercontains the files used for the keyword "Computer".
You can also create a custom keyword.
To use a new keyword, update the following line in
FunctionsList.java, and copy the keyword to your app. For example, to use the keyword 'Machine' from the keyword package
kws.tablefile from the zip package into the project folder target/classes.
FunctionsList.javawith the keyword name:
private static final String Keyword = "Machine";
Run the sample application from Eclipse
From the Eclipse menu bar, Run > Run As > Java Application. Then select FunctionsList and OK.
The Speech Devices SDK example application starts and displays the following options:
Try the new Conversation Transcription demo. Start transcribing with Session > Start. By default everyone is a guest. However, if you have participant’s voice signatures they can be put into a file
participants.propertiesin the project folder target/classes. To generate the voice signature, look at Transcribe conversations (SDK).
Create and run a standalone application
In the Package explorer, right-click your project. Choose Export.
The Export window appears. Expand Java and select Runnable JAR file and then select Next.
The Runnable JAR File Export window appears. Choose an Export destination for the application, and then select Finish.
Microsoft.CognitiveServices.Speech.extension.pma.dllin the destination folder chosen above as these files are needed by the application.
To run the standalone application
java -jar SpeechDemo.jar