How to get started

  1. Review the terms of use.
  2. Get a unique API key by sending a request to speechkit@support.yandex.ru.
  3. Download and unzip the SpeechKit Mobile SDK 2.2 distribution.
  4. To include the SpeechKit library in your project in Xcode, add the following frameworks to the project:

    • AVFoundation.framework
    • AudioToolbox.framework
    • CoreAudio.framework
    • CoreGraphics.framework
    • CoreLocation.framework
    • Foundation.framework
    • QuartzCore.framework
    • Security.framework
    • SystemConfiguration.framework
    • UIKit.framework
    • YandexSpeechKit.framework
  5. Add YandexSpeechKit.bundle, which is located in the YandexSpeechKit.framework directory, to the project.

  6. Add the -ObjC linker flag in the project settings:

    Other Linker Flags: -ObjC
    Note. This flag is necessary in order to use categories from the static libraries in the app.
  7. Add the CFBundleDisplayName parameter to the Info.plist config file in your project.

    <?xml version="1.0" encoding="UTF-8"?><!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
    <plist version="1.0">
       <dict>
         ...
         <key>CFBundleDisplayName</key>
         <string>${PRODUCT_NAME}</string>
         ...
         
       </dict>
    </plist>
    Note. This field is necessary for the SpeechKit Mobile SDK version 2.2 to work correctly. In Xcode versions lower than 6, the CFBundleDisplayName parameter is already in Info.plist by default.
  8. Review the reference guide.