Compile and run a sample project

Agora provides open-source sample projects on GitHub to demonstrate the implementation of basic and advanced Video SDK features.

This page shows how to compile, configure, and run the Video SDK iOS sample project.

• Xcode 13.0 or higher.
• An Apple developer account.
• If you need to use CocoaPods integrated SDK, make sure CocoaPods is installed.
• Two devices running iOS 14.0 or higher.

• A computer with Internet access. If a firewall is deployed in your network environment, refer to Connect through restricted networks with Cloud Proxy to use Agora services normally.

• A camera and a microphone

• A valid Agora account and project

• Installed Git

You can obtain the sample project using the following methods:

• Go to the SDKs page, download the latest version of the Agora Video SDK, and unzip it.

• Run the following command to clone the Github repository locally:

  git clone git@github.com:AgoraIO/API-Examples.git
  

  This repository contains sample projects for all native platforms of Agora Video SDK. The examples for iOS are located under /iOS.

  Path	Description
  /iOS/APIExample	API usage examples for Agora Video SDK.
  /iOS/APIExample-Audio	API usage examples for Agora Voice SDK.

information

This page refers to the video sample project. If you want to run the audio sample project, refer to the following steps and operate in the audio folder.

1. Open the samples/APIExample/APIExample/Common/KeyCenter.swift file and fill in the App ID and App certificate you obtained from the Agora Console.

   class KeyCenter: NSObject {
   

   // Replace <#Your App ID#> with your App ID
   

   static let AppId: String = "<#Your App ID#>"
   

   // Replace #Your certificate# with your App certificate. Leave this field blank if the project allows joining with the App ID only.
   

   static let Certificate: String? = "<#Your certificate#>"
   

   }
   

2. Open terminal and run pod install in the samples/API-Example folder to install the SDK and related dependencies. After the installation is complete, the terminal displays 'Pod installation complete!'.

1. Connect an iOS device to your development machine, open Device > Privacy & Security > Security on the device, and turn on the developer mode.

2. Check your iOS device in the iOS Device options at the top of the Xcode interface.

   

3. Check Automatically manage signing in Signing & Capabilities under TARGETS, then configure your Apple developer account and Bundle Identifier under each target.

   

4. Click Start compiling.

5. After successful compilation, you see the app icon on your device.

6. If an untrusted developer prompt pops up on the device, first tap Cancel to close the prompt, then open Settings > General > VPN and Device Management on the iOS device, and choose to trust the developer.

7. Open the API Example App, select an example you want to try, then enter the channel name. For example, test, and tap Join Channel.

8. To test various audio and video interaction scenarios, connect to the Agora web demo, or install and run the sample project on a second device. Make sure you use the same app ID on both devices. When you join the same channel from two devices, you can see and hear each other.