Skip to content
This repository was archived by the owner on Nov 18, 2020. It is now read-only.

Latest commit

 

History

History

SpeechRecognizer-iOS

README.md

Speech Recognizer

English | 中文

The SpeechRecognizer-iOS Sample App shows how to perform speech recognition on audio coming from the remote user in an Agora channel.

With this sample app, you can:

  • Voice chat
  • Speech to text

Prerequisites

  • Xcode 10.0+
  • Physical iOS device (iPhone or iPad)
  • iOS simulator is NOT supported

Quick Start

This section shows you how to prepare, build, and run the sample application.

Obtain an App Id

To build and run the sample application, get an App Id:

  1. Create a developer account at agora.io. Once you finish the signup process, you will be redirected to the Dashboard.

  2. Navigate in the Dashboard tree on the left to Projects > Project List.

  3. Save the App Id from the Dashboard for later use.

  4. Generate a temp Access Token (valid for 24 hours) from dashboard page with given channel name, save for later use.

  5. Open SpeechRecognizer-iOS.xcodeproj and edit the AppID.swift file. Update <#Your App Id#> with your App Id, and assign the token variable with the temp Access Token generated from dashboard.

    let AppID: String = <#Your App Id#>
// assign Token to nil if you have not enabled app certificate
let Token: String? = <#Temp Token#>

Integrate the Agora Audio SDK

  1. Download the Agora Voice SDK. Unzip the downloaded SDK package and copy the following files from the SDK libs folder into iOS&macOS/libs/iOS folder.

    • AograRtcKit.framework

  2. Connect your iPhone or iPad device and run the project. Ensure a valid provisioning profile is applied or your project will not run.

How to Use

  1. Choose the language to recognize.
  2. Enter a channel name in the TextFiled, and join.
  3. The app begins routes the audio data received from remote user to the Speech framework, and displays the recognized text from Speech framework in the text view.
  4. Press Leave channel to stop speech recognition and leave the channel.
  • Important: Only the first remote user in channel will be performed speech recognition.

Developer Environment Requirements

  • Xcode 10.0 +
  • Real devices (iPhone or iPad)
  • iOS simulator is NOT supported

Contact Us

  • For potential issues, take a look at our FAQ first
  • Dive into Agora SDK Samples to see more tutorials
  • Take a look at Agora Use Case for more complicated real use case
  • Repositories managed by developer communities can be found at Agora Community
  • You can find full API documentation at Document Center
  • If you encounter problems during integration, you can ask question in Stack Overflow
  • You can file bugs about this sample at issue

License

The MIT License (MIT).