Skip to content

Latest commit

 

History

History
 
 

APIExample

README.md

API Example iOS

English | 中文

This project presents you a set of API examples to help you understand how to use Agora APIs.

Problem

After users upgrade their iOS devices to iOS 14.0, and use an app that integrates the Agora RTC SDK for iOS for the first time, users see a prompt for finding local network devices. The following picture shows the pop-up prompt:

Solution

Prerequisites

  • Xcode 13.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.

Prepare Dependencies

Change directory into iOS folder, run following command to install project dependencies,

use cocoapods

install cocoapods

pod install

Verify APIExample.xcworkspace has been properly generated.

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 APIExample.xcworkspace and edit the KeyCenter.swift file. In the KeyCenter struct, update <#Your App Id#> with your App Id, and change <#Temp Access Token#> with the temp Access Token generated from dashboard. Note you can leave the token variable nil if your project has not turned on security token.

    /**
  Agora assigns App IDs to app developers to identify projects and organizations.
 If you have multiple completely separate apps in your organization, for example built by different teams,
 you should use different App IDs.
 If applications need to communicate with each other, they should use the same App ID.
 In order to get the APP ID, you can open the agora console (https://console.agora.io/) to create a project,
 then the APP ID can be found in the project detail page.
 */
 static let AppId: String = <# YOUR APPID#>
 
 /**
  Agora provides App certificate to generate Token. You can deploy and generate a token on your server,
 or use the console to generate a temporary token.
 In order to get the APP ID, you can open the agora console (https://console.agora.io/) to create a project with the App Certificate enabled,
 then the APP Certificate can be found in the project detail page.
 PS: If the project does not have certificates enabled, leave this field blank.
 */
 static var Certificate: String? = <#YOUR Certificate#>

You are all set. Now connect your iPhone or iPad device and run the project.

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)