Microsoft Speech API: iOS Speech-to-Text Client Library and Samples
This repo contains the iOS client library and samples for Speech-to-Text in Microsoft Speech API, an offering within Microsoft Cognitive Services on Azure, formerly known as Project Oxford.
The Client Library
To add the Speech Client Library dependency to an existing XCode Project:
- Select your target application, and open the menu
Add Files to ...
- Navigate to
SpeechSDK.framework, and click
- Go to your project settings, by single clicking your project, and navigate to the
Generaltab. You will notice that SpeechSDK.framework exists under the
Linked Frameworks and Librariessection.
- In the
Generaltab, under the
Embedded Binariessection, click the (+) button. In the dialog, select
SpeechSDK.frameworkand click the
- If you wish to run on the iOS Simulator or MacOSX, repeat steps 2-4 but choose either
The Client Library Reference for iOS can be found here.
This sample demonstrates the following features using a wav file or external microphone input:
- Short-form recognition
- Long-form dictation
- Recognition with intent
Build the sample
- First, you must obtain a Speech API subscription key by following the instructions on Subscriptions.
- Start XCode and choose the menu
Open...the workspace file
Cognitive-Speech-STT-iOS > SpeechSDK.xcworkspace.
- Use one of your subscription keys as the primaryKey in
- If you want to use Recognition with intent, you also need to sign up for Language Understanding Intelligent Service (LUIS) and set the key values in
- In XCode, select menu
Product > Buildto build the sample and
Runto launch the sample app.
Running the sample
In XCode, select the menu
Run to launch this sample app.
- In the application, press the button
Change Modeto select which recognition mode you would like to use.
- To Start recognition, press the Start button.
We welcome contributions. Feel free to file issues and pull requests on the repo and we'll address them as we can. Learn more about how you can help on our Contribution Rules & Guidelines.
You can reach out to us anytime with questions and suggestions using our communities below:
All Microsoft Cognitive Services SDKs and samples are licensed with the MIT License. For more information, see LICENSE.
Sample images are licensed separately, please refer to LICENSE-IMAGE.
Developer Code of Conduct
Developers using Cognitive Services, including this client library and sample, are expected to follow the "Developer Code of Conduct for Microsoft Cognitive Services", found at http://go.microsoft.com/fwlink/?LinkId=698895.