Skip to content

Commit

Permalink
Update samples for Speech SDK release 0.5.0 (#20)
Browse files Browse the repository at this point in the history
  • Loading branch information
mahilleb-msft authored Jul 16, 2018
1 parent 4eb2713 commit 30fbcd9
Show file tree
Hide file tree
Showing 185 changed files with 5,808 additions and 1,322 deletions.
16 changes: 15 additions & 1 deletion .gitattributes
Original file line number Diff line number Diff line change
@@ -1,23 +1,37 @@
.gitattributes text
.gitignore text

.classpath text
.project text
Makefile text
gradlew text
proguard-rules.pro text

*.appxmanifest text
*.bat text
*.config text
*.cpp text
*.cs text
*.csproj text
*.filters text
*.gradle text
*.h text
*.java text
*.md text
*.pl text
*.prefs text
*.properties text
*.sln text
*.vcxproj text
*.vcxproj.filters text
*.xaml text
*.xml text
*.yml text

# Bash only likes Unix line endings
*.sh text eol=lf

# Binary extensions:
*.jar binary
*.pfx binary
*.png binary
*.wav binary
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Sample Repository for the Cognitive Services Speech SDK
# Sample Repository for the Microsoft Cognitive Services Speech SDK

The samples in this repository are working against version 0.4.0 of the SDK.
The samples in this repository are working against version 0.5.0 of the SDK.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing to Sample Repository for the Cognitive Services Speech SDK
# Contributing to Sample Repository for the Microsoft Cognitive Services Speech SDK

This project welcomes contributions and suggestions. Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
Expand Down
57 changes: 0 additions & 57 deletions Linux/quickstart-linux/quickstart-linux.cpp

This file was deleted.

65 changes: 53 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,73 @@
# Sample Repository for the Cognitive Services Speech SDK
# Sample Repository for the Microsoft Cognitive Services Speech SDK

This project hosts the **samples** for the Cognitive Services Speech SDK. To find out more about the Cognitive Services Speech SDK itself, please visit the [SDK documentation site](https://aka.ms/csspeech).
This project hosts the **samples** for the Microsoft Cognitive Services Speech SDK (Preview). To find out more about the Microsoft Cognitive Services Speech SDK itself, please visit the [SDK documentation site](https://aka.ms/csspeech).

## Features

This repository hosts samples that help you to get started with several features of the SDK.
In addition more complex scenarios are included to give you a head-start on using speech technology in your application.

We tested the samples with the latest released version of the SDK (0.4.0) on the Windows 10 and Ubuntu 16.04 platform.
We tested the samples with the latest released version of the SDK (0.5.0) on the Windows 10, Ubuntu 16.04, and ARM-based Android devices (API 23: Android 6.0 Marshmallow or higher).

## Getting Started

The [SDK documentation](https://aka.ms/csspeech) has extensive sections about getting started, setting up the SDK, as well as the process to acquire the required subscription keys. You will need subscription keys to run the samples on your machines, you therefore should follow the instructions on these pages before continuing.

Once you have these keys, follow these steps:
## Get the samples

* The easiest way to use these samples without using Git is to download the current version as a [ZIP file](https://github.com/Azure-Samples/cognitive-services-speech-sdk/archive/master.zip).

* On Windows, before you unzip the archive, right-click it, select **Properties**, and then select **Unblock**.
* Be sure to unzip the entire archive, and not just individual samples.

* Clone this sample repository using a Git client.

## Build and run the samples

> **Note: the samples make use of the Microsoft Cognitive Services Speech SDK.
> By downloading the Microsoft Cognitive Services Speech SDK, you acknowledge its license, see [Speech SDK license agreement](https://docs.microsoft.com/azure/cognitive-services/speech-service/license).**
### Windows

The sample requires a working installation of the [Visual Studio 2017 IDE](https://www.visualstudio.com/) on your system (Visual Studio Community edition is sufficient). Then clone this sample repository onto your local machine. In the `Windows` folder, you can find various samples with solution files (`*.sln`) that you can open directly in Visual Studio 2017. Compile the samples inside Visual Studio, the required Microsoft Cognitive Services Speech SDK components will automatically be downloaded from [nuget.org](https://aka.ms/nuget).
All Windows samples require a working installation of [Microsoft Visual Studio 2017](https://www.visualstudio.com/) on your system, Community edition or higher.
When you compile the samples inside Visual Studio, the required Microsoft Cognitive Services Speech SDK components will be automatically downloaded from [nuget.org](https://aka.ms/nuget).

### Linux (Ubuntu 16.04)

Our Linux sample is based on our Linux binary download (`https://aka.ms/csspeech/linuxbinary`).
Instructions to build are included in the sample's README.

### Android

All Android samples require a working installation of [Android Studio](https://developer.android.com/studio/).
They make use of the Microsoft Cognitive Services Speech SDK for Android Maven package (`com.microsoft.cognitiveservices.speech:client-sdk`) that is hosted under `https://csspeechstorage.blob.core.windows.net/maven/`.
At this time, we support ARM-based Android devices (API 23: Android 6.0 Marshmallow or higher).

## Overview of samples

Our quickstarts for various platforms demonstrates how to do one-shot speech recognition from microphone.
If you want to build them from scratch, please follow the articles in the Quickstart section on our [documentation page](https://aka.ms/csspeech).

| Quickstart | Platform | Description |
| --- | --- | --- |
| [Quickstart C++ for Linux](./quickstart/cpp-linux/) | Linux | Demonstrates one-shot speech recognition from microphone |
| [Quickstart C++ for Windows](./quickstart/cpp-windows/) | Windows | Demonstrates one-shot speech recognition from microphone |
| [Quickstart C# .NET for Windows](./quickstart/csharp-dotnet-windows/) | Windows | Demonstrates one-shot speech recognition from microphone |
| [Quickstart C# .NET Core for Windows](./quickstart/csharp-dotnetcore-windows/) | Windows | Demonstrates one-shot speech recognition from microphone |
| [Quickstart for Android](./quickstart/java-android/) | Android | Demonstrates one-shot speech recognition from microphone |

### Linux
The following samples demonstrate additional capabilities of the Speech SDK, such additional modes of speech recognition as well as intent recognition and translation:

[Our main documentation](https://aka.ms/csspeech) describes how to download and install the Speech SDK for Linux.
Then clone this sample repository onto your local machine.
Linux samples are contained in the `Linux` folder of this sample repository.
To build edit the contained `Makefile` and run `make`.
Please see [here](https://docs.microsoft.com/en-us/azure/cognitive-services/speech-service/cpp-linux) for more information.
| Sample | Platform | Description |
| --- | --- | --- |
| [C++ Console app for Windows](./samples/cpp/windows/console) | Windows | Demonstrates speech recognition, intent recognition, and translation |
| [C# Console app for .NET Framework on Windows](./samples/csharp/dotnet-windows/console) | Windows | Demonstrates speech recognition and translation |
| [C# Console app for .NET Core on Windows](./samples/csharp/dotnetcore-windows/console) | Windows | Demonstrates speech recognition and translation |
| [Speech-to-text WPF sample for .NET Framework on Windows](./samples/csharp/dotnet-windows/speechtotext-wpf) | Windows | Demonstrates speech recognition |
| [Translation WPF sample for .NET Framework on Windows](./samples/csharp/dotnet-windows/translation-wpf) | Windows | Demonstrates translation |
| [Speech-to-text UWP sample](./samples/csharp/uwp/speechtotext-uwp) | Windows | Demonstrates speech recognition |
| [Speech recognition sample for Android](./samples/java/android/sdkdemo) | Android | Demonstrates speech and intent recognition |

## Resources

- [Cognitive Services Speech SDK Documentation](https://aka.ms/csspeech)
- [Microsoft Cognitive Services Speech Service and SDK Documentation](https://aka.ms/csspeech)
25 changes: 25 additions & 0 deletions ThirdPartyNotices.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# THIRD-PARTY SOFTWARE NOTICES AND INFORMATION

Do Not Translate or Localize

This project is based on or incorporates material from the projects listed below (Third Party IP). The original copyright notice and the license under which Microsoft received such Third Party IP, are set forth below. Such licenses and notices are provided for informational purposes only. Where permitted, Microsoft licenses the Third Party IP to you under the licensing terms for the Microsoft product. Microsoft reserves all other rights not expressly granted under this agreement, whether by implication, estoppel or otherwise.

**a. Gradle**

The Cognitive Services Client Speech Samples are using code from the 'Gradle Project', obtained from https://github.com/gradle/gradle/. It is licensed under the following license:

/*
* Copyright 2016 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the ""License"");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an ""AS IS"" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
Loading

0 comments on commit 30fbcd9

Please sign in to comment.