Skip to content

Latest commit

 

History

History
 
 

README.md

Pronunciation Assess iOS

其他语言版本: 简体中文

This demo gives an example of the combined use of Agora RTC voice sdk and Chivox language assessment sdk.

With this sample app, you can:

  • Join / leave channel
  • Start a word test, read the word aloud and see the overall assessment result of your pronunciation.

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 Agora 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 Pronunciation-Assess.xcodeproj and edit the KeyCenter.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 Audio SDK. Unzip the downloaded SDK package and copy the following files from the SDK libs folder into ../libs/iOS folder.
    • AograAudioKit.framework

Integrate the Chivox SDK

  1. You need to contact Chivox or Agora for the chivox keys, and the link of Chivox SDK and provision licence file.

  2. Open Pronunciation-Assess.xcodeproj and edit the CXKeys.swift file. Update following keys.

    let CXAppKey = <#CX App Key#>
    let CXSecretKey = <#CX Secret Key#>
    
  3. Copy aiengine.h, aiengine.provision, libaiengine.a to Pronunciation-Assess/CHIVOX

Run

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

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)