Skip to content

Commit c91f54e

Browse files
ShawnJacksonShawnJackson
authored
Merge pull request #185512 from paulth1/overview
edit pass: Overview
2 parents df2e9f9 + 911f7fb commit c91f54e

15 files changed

+148
-151
lines changed

‎articles/cognitive-services/Speech-Service/includes/get-speech-sdk-android.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.author: eur
88

99
:::row:::
1010
:::column span="3":::
11-
When developing for Android, there are two Speech SDKs available. The Java Speech SDK is available natively as an Android package, or the .NET Speech SDK could be used with **Xamarin.Android** as it implements .NET Standard 2.0.
11+
When you develop for Android, two Speech SDKs are available. The Java Speech SDK is available natively as an Android package, or the .NET Speech SDK could be used with **Xamarin.Android** as it implements .NET Standard 2.0.
1212
:::column-end:::
1313
:::column:::
1414
<br>
@@ -26,7 +26,7 @@ ms.author: eur
2626

2727
:::row:::
2828
:::column span="3":::
29-
Xamarin.Android exposes the complete Android SDK for .NET developers. Build fully native Android apps using C# or F# in Visual Studio. For more information, see <a href="/xamarin/android/" target="_blank">Xamarin.Android </a>
29+
Xamarin.Android exposes the complete Android SDK for .NET developers. Build fully native Android apps by using C# or F# in Visual Studio. For more information, see <a href="/xamarin/android/" target="_blank">Xamarin.Android.</a>
3030
:::column-end:::
3131
:::column:::
3232
<br>

‎articles/cognitive-services/Speech-Service/includes/get-speech-sdk-browser.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.custom: devx-track-js
99

1010
:::row:::
1111
:::column span="3":::
12-
The Speech SDK for JavaScript is available as an npm package, see <a href="https://www.npmjs.com/package/microsoft-cognitiveservices-speech-sdk" target="_blank">microsoft-cognitiveservices-speech-sdk </a> and its companion GitHub repository <a href="https://github.com/Microsoft/cognitive-services-speech-sdk-js" target="_blank">cognitive-services-speech-sdk-js </a>.
12+
The Speech SDK for JavaScript is available as an npm package. See <a href="https://www.npmjs.com/package/microsoft-cognitiveservices-speech-sdk" target="_blank">microsoft-cognitiveservices-speech-sdk </a> and its companion GitHub repository <a href="https://github.com/Microsoft/cognitive-services-speech-sdk-js" target="_blank">cognitive-services-speech-sdk-js</a>.
1313
:::column-end:::
1414
:::column:::
1515
<br>
@@ -20,23 +20,23 @@ ms.custom: devx-track-js
2020
:::row-end:::
2121

2222
> [!TIP]
23-
> Although the Speech SDK for JavaScript is available as an npm package, thus both client web browsers and Node.js can consume it - consider the various architectural implications of each environment. For example, the <a href="https://en.wikipedia.org/wiki/Document_Object_Model" target="_blank">document object model (DOM) </a> is not available for server-side applications just as the <a href="https://nodejs.org/api/fs.html" target="_blank">file system </a> is not available to client-side applications.
23+
> The Speech SDK for JavaScript is available as an npm package, so both client web browsers and Node.js can consume it. But make sure to consider the various architectural implications of each environment. For example, the <a href="https://en.wikipedia.org/wiki/Document_Object_Model" target="_blank">document object model (DOM) </a> isn't available for server-side applications just as the <a href="https://nodejs.org/api/fs.html" target="_blank">file system </a> isn't available to client-side applications.
2424
2525
### Node.js Package Manager (NPM)
2626

27-
To install the Speech SDK for JavaScript, run the following `npm install` command below.
27+
To install the Speech SDK for JavaScript, run the following `npm install` command:
2828

2929
```nodejs
3030
npm install microsoft-cognitiveservices-speech-sdk
3131
```
3232

3333
### HTML script tag
3434

35-
Alternatively, you could directly include a `<script>` tag in the HTMLs `<head>` element, relying on the <a href="https://www.jsdelivr.com/package/npm/microsoft-cognitiveservices-speech-sdk" target="_blank">**JSDelivr** NPM syndicate </a>.
35+
Alternatively, you could directly include a `<script>` tag in the HTMLs `<head>` element, relying on the <a href="https://www.jsdelivr.com/package/npm/microsoft-cognitiveservices-speech-sdk" target="_blank">**JSDelivr** NPM syndicate</a>.
3636

3737
```html
3838
<script src="https://cdn.jsdelivr.net/npm/microsoft-cognitiveservices-speech-sdk@latest/distrib/browser/microsoft.cognitiveservices.speech.sdk.bundle-min.js">
3939
</script>
4040
```
4141

42-
For more information, see the <a href="https://github.com/Azure-Samples/cognitive-services-speech-sdk/tree/master/quickstart/javascript/browser" target="_blank">Web Browser Speech SDK quickstart </a>.
42+
For more information, see the <a href="https://github.com/Azure-Samples/cognitive-services-speech-sdk/tree/master/quickstart/javascript/browser" target="_blank">Web browser Speech SDK quickstart</a>.

‎articles/cognitive-services/Speech-Service/includes/get-speech-sdk-cpp.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.author: eur
99
:::row:::
1010
:::column span="3":::
1111
The C++ Speech SDK is available as a NuGet package on Windows, Linux, and macOS. For more information, see <a href="https://www.nuget.org/packages/Microsoft.CognitiveServices.Speech" target="_blank">Microsoft.CognitiveServices.Speech</a>.
12-
The C++ Speech SDK is also available as tar package from https://aka.ms/csspeech/linuxbinary.
12+
The C++ Speech SDK is also available as a tar package from https://aka.ms/csspeech/linuxbinary.
1313
:::column-end:::
1414
:::column:::
1515
<br>
@@ -21,12 +21,12 @@ ms.author: eur
2121

2222
#### C++ NuGet package
2323

24-
The C++ Speech SDK can be installed from the **Package Manager** with the following `Install-Package` command.
24+
The C++ Speech SDK can be installed from the **Package Manager** with the following `Install-Package` command:
2525

2626
```powershell
2727
Install-Package Microsoft.CognitiveServices.Speech
2828
```
2929

3030
#### Additional resources
3131

32-
- <a href="https://github.com/Azure-Samples/cognitive-services-speech-sdk/tree/master/quickstart/cpp" target="_blank">Windows, Linux, and macOS quickstart C++ source code </a>
32+
<a href="https://github.com/Azure-Samples/cognitive-services-speech-sdk/tree/master/quickstart/cpp" target="_blank">Windows, Linux, and macOS quickstart C++ source code </a>

‎articles/cognitive-services/Speech-Service/includes/get-speech-sdk-dotnet.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.custom: devx-track-csharp
99

1010
:::row:::
1111
:::column span="3":::
12-
The .NET Speech SDK is available as a NuGet package and implements .NET Standard 2.0, for more information, see <a href="https://www.nuget.org/packages/Microsoft.CognitiveServices.Speech" target="_blank">Microsoft.CognitiveServices.Speech </a>.
12+
The .NET Speech SDK is available as a NuGet package and implements .NET Standard 2.0. For more information, see <a href="https://www.nuget.org/packages/Microsoft.CognitiveServices.Speech" target="_blank">Microsoft.CognitiveServices.Speech</a>.
1313
:::column-end:::
1414
:::column:::
1515
<br>
@@ -19,20 +19,20 @@ ms.custom: devx-track-csharp
1919
:::column-end:::
2020
:::row-end:::
2121

22-
#### C# NuGet Package
22+
#### C# NuGet package
2323

24-
The .NET Speech SDK can be installed from the **.NET Core CLI** with the following `dotnet add` command.
24+
The .NET Speech SDK can be installed from the **.NET Core CLI** with the following `dotnet add` command:
2525

2626
```dotnetcli
2727
dotnet add package Microsoft.CognitiveServices.Speech
2828
```
2929

30-
The .NET Speech SDK can be installed from the **Package Manager** with the following `Install-Package` command.
30+
The .NET Speech SDK can be installed from the **Package Manager** with the following `Install-Package` command:
3131

3232
```powershell
3333
Install-Package Microsoft.CognitiveServices.Speech
3434
```
3535

3636
#### Additional resources
3737

38-
- <a href="https://github.com/Azure-Samples/cognitive-services-speech-sdk/tree/master/quickstart/csharp" target="_blank">.NET Core, .NET Framework, Unity, UWP, and Xamarin quickstart C# source code </a>
38+
<a href="https://github.com/Azure-Samples/cognitive-services-speech-sdk/tree/master/quickstart/csharp" target="_blank">.NET Core, .NET Framework, Unity, UWP, and Xamarin quickstart C# source code </a>

‎articles/cognitive-services/Speech-Service/includes/get-speech-sdk-ios.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.author: eur
88

99
:::row:::
1010
:::column span="3":::
11-
When developing for iOS, the following Speech SDKs are available. The Objective-C/Swift Speech SDK is available natively as an iOS CocoaPod package. Alternatively, the .NET Speech SDK could be used with Xamarin.iOS and Unity application frameworks.
11+
When you develop for iOS, the following Speech SDKs are available. The Objective-C/Swift Speech SDK is available natively as an iOS CocoaPod package. Alternatively, the .NET Speech SDK could be used with Xamarin.iOS and Unity application frameworks.
1212
:::column-end:::
1313
:::column:::
1414
<br>
@@ -19,7 +19,7 @@ ms.author: eur
1919
:::row-end:::
2020

2121
> [!TIP]
22-
> For details using the Objective-C Speech SDK with Swift, see <a href="https://developer.apple.com/documentation/swift/imported_c_and_objective-c_apis/importing_objective-c_into_swift" target="_blank">Importing Objective-C into Swift </a>.
22+
> For details on using the Objective-C Speech SDK with Swift, see <a href="https://developer.apple.com/documentation/swift/imported_c_and_objective-c_apis/importing_objective-c_into_swift" target="_blank">Importing Objective-C into Swift</a>.
2323
2424
### System requirements
2525

@@ -30,7 +30,7 @@ ms.author: eur
3030

3131
:::row:::
3232
:::column span="3":::
33-
The iOS CocoaPod package is available for download and use with the <a href="https://apps.apple.com/us/app/xcode/id497799835" target="_blank">Xcode 9.4.1 (or later) </a> integrated development environment (IDE). First, <a href="https://aka.ms/csspeech/iosbinary" target="_blank">download the binary CocoaPod </a>. Extract the pod in the same directory for its intended use, create a *Podfile* and list the `pod` as a `target`.
33+
The iOS CocoaPod package is available for download and use with the <a href="https://apps.apple.com/us/app/xcode/id497799835" target="_blank">Xcode 9.4.1 (or later) </a> integrated development environment (IDE). First, <a href="https://aka.ms/csspeech/iosbinary" target="_blank">download the binary CocoaPod</a>. Extract the pod in the same directory for its intended use, create a *Podfile*, and list the `pod` as a `target`.
3434
:::column-end:::
3535
:::column:::
3636
<br>
@@ -53,7 +53,7 @@ end
5353

5454
:::row:::
5555
:::column span="3":::
56-
Xamarin.iOS exposes the complete iOS SDK for .NET developers. Build fully native iOS apps using C# in Visual Studio. For more information, see <a href="/xamarin/ios/" target="_blank">Xamarin.iOS </a>.
56+
Xamarin.iOS exposes the complete iOS SDK for .NET developers. Build fully native iOS apps by using C# in Visual Studio. For more information, see <a href="/xamarin/ios/" target="_blank">Xamarin.iOS</a>.
5757
:::column-end:::
5858
:::column:::
5959
<br>

‎articles/cognitive-services/Speech-Service/includes/get-speech-sdk-java.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.author: eur
88

99
:::row:::
1010
:::column span="3":::
11-
The Java SDK for Android is packaged as an <a href="https://developer.android.com/studio/projects/android-library" target="_blank">AAR (Android Library) </a>, which includes the necessary libraries and required Android permissions. It's hosted in a Maven repository at `https://csspeechstorage.blob.core.windows.net/maven/` as package `com.microsoft.cognitiveservices.speech:client-sdk:1.19.0`. (Make sure 1.19.0 is the latest version by [searching our GitHub repo](https://github.com/Azure-Samples/cognitive-services-speech-sdk/search?q=com.microsoft.cognitiveservices.speech%3Aclient-sdk).)
11+
The Java SDK for Android is packaged as an <a href="https://developer.android.com/studio/projects/android-library" target="_blank">AAR (Android Library)</a>, which includes the necessary libraries and required Android permissions. It's hosted in a Maven repository at `https://csspeechstorage.blob.core.windows.net/maven/` as package `com.microsoft.cognitiveservices.speech:client-sdk:1.19.0`. Make sure 1.19.0 is the latest version by [searching our GitHub repo](https://github.com/Azure-Samples/cognitive-services-speech-sdk/search?q=com.microsoft.cognitiveservices.speech%3Aclient-sdk).
1212
:::column-end:::
1313
:::column:::
1414
<br>
@@ -21,16 +21,16 @@ ms.author: eur
2121
To consume the package from your Android Studio project, make the following changes:
2222

2323
1. In the project-level *build.gradle* file, add the following to the `repositories` section:
24-
```gradle
25-
maven { url 'https://csspeechstorage.blob.core.windows.net/maven/' }
26-
```
24+
```gradle
25+
maven { url 'https://csspeechstorage.blob.core.windows.net/maven/' }
26+
```
2727
28-
2. In the module-level *build.gradle* file, add the following to the `dependencies` section:
29-
```gradle
30-
implementation 'com.microsoft.cognitiveservices.speech:client-sdk:1.19.0'
31-
```
28+
1. In the module-level *build.gradle* file, add the following to the `dependencies` section:
29+
```gradle
30+
implementation 'com.microsoft.cognitiveservices.speech:client-sdk:1.19.0'
31+
```
3232
3333
#### Additional resources
3434
35-
- <a href="https://github.com/Azure-Samples/cognitive-services-speech-sdk/tree/master/quickstart/java/android" target="_blank">Android specific Java quickstart source code </a>
35+
- <a href="https://github.com/Azure-Samples/cognitive-services-speech-sdk/tree/master/quickstart/java/android" target="_blank">Android-specific Java quickstart source code </a>
3636
- <a href="https://github.com/Azure-Samples/cognitive-services-speech-sdk/tree/master/quickstart/java/jre" target="_blank">Java Runtime (JRE) quickstart source code </a>

‎articles/cognitive-services/Speech-Service/includes/get-speech-sdk-linux.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,13 @@ ms.author: eur
2626
> [!IMPORTANT]
2727
> For C# on Linux ARM64, the .NET Core 3.x (dotnet-sdk-3.x package) is required.
2828
29-
> [!NOTE]
30-
> To use the Speech SDK in Alpine Linux, create a Debian chroot environment as documented in the Alpine Linux Wiki on [running glibc programs](https://wiki.alpinelinux.org/wiki/Running_glibc_programs), and then follow Debian instructions here.
29+
To use the Speech SDK in Alpine Linux, create a Debian chroot environment as documented in the Alpine Linux Wiki on [running glibc programs](https://wiki.alpinelinux.org/wiki/Running_glibc_programs). Then follow the Debian instructions here.
3130

3231
### System requirements
3332

34-
For a native application, the Speech SDK relies on `libMicrosoft.CognitiveServices.Speech.core.so`. Make sure the target architecture (x86, x64) matches the application. Depending on the Linux version, additional dependencies may be required.
33+
For a native application, the Speech SDK relies on `libMicrosoft.CognitiveServices.Speech.core.so`. Make sure the target architecture (x86, x64) matches the application. Depending on the Linux version, more dependencies might be required:
3534

36-
- The shared libraries of the GNU C library (including the POSIX Threads Programming library, `libpthreads`)
35+
- The shared libraries of the GNU C library, including the POSIX Threads Programming library, `libpthreads`
3736
- The OpenSSL library (`libssl`)
3837
- The shared library for ALSA applications (`libasound`)
3938

‎articles/cognitive-services/Speech-Service/includes/get-speech-sdk-macos.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ ms.date: 03/27/2020
66
ms.author: eur
77
---
88

9-
When developing for macOS, the following Speech SDKs are available.
9+
When you develop for macOS, the following Speech SDKs are available:
1010

11-
- The Objective-C/Swift Speech SDK is available natively as a CocoaPod package for Mac x64 and ARM based silicons. For details about using the Objective-C Speech SDK with Swift, see <a href="https://developer.apple.com/documentation/swift/imported_c_and_objective-c_apis/importing_objective-c_into_swift" target="_blank">Importing Objective-C into Swift </a>.
11+
- The Objective-C/Swift Speech SDK is available natively as a CocoaPod package for Mac x64 and ARM-based silicons. For details about using the Objective-C Speech SDK with Swift, see <a href="https://developer.apple.com/documentation/swift/imported_c_and_objective-c_apis/importing_objective-c_into_swift" target="_blank">Importing Objective-C into Swift</a>.
1212
- The .NET Speech SDK is available via NuGet package and could be used with **Xamarin.Mac** and **Unity** application frameworks.
1313
- The Python Speech SDK is available as a PyPI module for Python versions 3.7 and higher.
1414
- The Java Speech SDK is available via the Maven repository as a JAR package.
@@ -21,7 +21,7 @@ When developing for macOS, the following Speech SDKs are available.
2121

2222
:::row:::
2323
:::column span="3":::
24-
The macOS CocoaPod package is available for download and use with the <a href="https://apps.apple.com/us/app/xcode/id497799835" target="_blank">Xcode 9.4.1 (or later) </a> integrated development environment (IDE). First, <a href="https://aka.ms/csspeech/macosbinary" target="_blank">download the binary CocoaPod </a>. Extract the pod in the same directory for its intended use, create a *Podfile* and list the `pod` as a `target`.
24+
The macOS CocoaPod package is available for download and use with the <a href="https://apps.apple.com/us/app/xcode/id497799835" target="_blank">Xcode 9.4.1 (or later) </a> integrated development environment (IDE). First, <a href="https://aka.ms/csspeech/macosbinary" target="_blank">download the binary CocoaPod </a>. Extract the pod in the same directory for its intended use, create a *Podfile*, and list the `pod` as a `target`.
2525
:::column-end:::
2626
:::column:::
2727
<br>
@@ -44,7 +44,7 @@ end
4444

4545
:::row:::
4646
:::column span="3":::
47-
Xamarin.Mac exposes the complete macOS SDK for .NET developers to build native Mac applications using C#. For more information, see <a href="/xamarin/mac/" target="_blank">Xamarin.Mac </a>.
47+
Xamarin.Mac exposes the complete macOS SDK for .NET developers to build native Mac applications by using C#. For more information, see <a href="/xamarin/mac/" target="_blank">Xamarin.Mac</a>.
4848
:::column-end:::
4949
:::column:::
5050
<br>

‎articles/cognitive-services/Speech-Service/includes/get-speech-sdk-nodejs.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.custom: devx-track-js
99

1010
:::row:::
1111
:::column span="3":::
12-
The Speech SDK for JavaScript is available as an npm package, see <a href="https://www.npmjs.com/package/microsoft-cognitiveservices-speech-sdk" target="_blank">microsoft-cognitiveservices-speech-sdk </a> and its companion GitHub repository <a href="https://github.com/Microsoft/cognitive-services-speech-sdk-js" target="_blank">cognitive-services-speech-sdk-js </a>.
12+
The Speech SDK for JavaScript is available as an npm package. See <a href="https://www.npmjs.com/package/microsoft-cognitiveservices-speech-sdk" target="_blank">microsoft-cognitiveservices-speech-sdk </a> and its companion GitHub repository <a href="https://github.com/Microsoft/cognitive-services-speech-sdk-js" target="_blank">cognitive-services-speech-sdk-js</a>.
1313
:::column-end:::
1414
:::column:::
1515
<br>
@@ -20,14 +20,14 @@ ms.custom: devx-track-js
2020
:::row-end:::
2121

2222
> [!TIP]
23-
> Although the Speech SDK for JavaScript is available as an npm package, thus both Node.js and client web browsers can consume it - consider the various architectural implications of each environment. For example, the <a href="https://en.wikipedia.org/wiki/Document_Object_Model" target="_blank">document object model (DOM) </a> is not available for server-side applications just as the <a href="https://nodejs.org/api/fs.html" target="_blank">file system </a> is not available to client-side applications.
23+
> The Speech SDK for JavaScript is available as an npm package, so both Node.js and client web browsers can consume it. But make sure to consider the various architectural implications of each environment. For example, the <a href="https://en.wikipedia.org/wiki/Document_Object_Model" target="_blank">document object model (DOM) </a> isn't available for server-side applications just as the <a href="https://nodejs.org/api/fs.html" target="_blank">file system </a> isn't available to client-side applications.
2424
2525
### Node.js Package Manager (NPM)
2626

27-
To install the Speech SDK for JavaScript, run the following `npm install` command below.
27+
To install the Speech SDK for JavaScript, run the following `npm install` command:
2828

2929
```nodejs
3030
npm install microsoft-cognitiveservices-speech-sdk
3131
```
3232

33-
For more information, see the <a href="https://github.com/Azure-Samples/cognitive-services-speech-sdk/tree/master/quickstart/javascript/node" target="_blank">Node.js Speech SDK quickstart </a>.
33+
For more information, see the <a href="https://github.com/Azure-Samples/cognitive-services-speech-sdk/tree/master/quickstart/javascript/node" target="_blank">Node.js Speech SDK quickstart</a>.

0 commit comments

Comments
 (0)