Run the Sample Project

Agora provides an open-source API-Examples sample project on GitHub. This page introduces how to run this project and experience a live video streaming implemented by the Agora SDK.

Prerequisites

• Xcode 9.0 or later
• An iOS device running iOS 9.0 or later.
• A valid Agora account.
• Valid developer signature and device permission settings.

Procedures

1. Create an Agora project

To create an Agora project, do the following:

1. Enter the Project Management page.
2. Click Create.
3. Follow the on-screen instructions to enter a project name and use case, and check Secured mode: APP ID + Token (Recommended) as the authentication mechanism.
4. Click Submit. You can now see the project on the Project Management page.

2. Get an App ID

Agora automatically assigns each project an App ID as a unique identifier.

To copy this App ID, find your project on the Project Management page in Agora Console, and click the icon in the App ID column.

3. Generate a temporary token

To ensure communication security, Agora recommends using tokens to authenticate users joining a channel.

For testing purposes, Agora Console supports generating RTC temporary tokens. To generate an RTC temporary token:

1. On the Project Management page, find your project and click Config.
   
2. Click Generate temp RTC token under Primary Certificate.
   
3. Enter the name of the channel that you want to join, and click Generate. When joining the channel later, ensure that the channel name is the same with the one you enter here.
4. Click the copy icon to copy the temporary token.

4. Configure the sample project

Download the latest Video SDK, and fill in the samples/APIExample/APIExample/Common/KeyCenter.swift file with the App ID and temporary token generated in Agora Console.

  struct KeyCenter {
      // Replace #Your App Id# with your App ID, and add quotation marks around it, such as "xxxxxx"
      static let AppId: String = <#Your App Id#>
      // Replace #Temp Access Token# with your temporary Token, and add quotation marks around it, such as "xxxxxx"
      static var Token: String? = <#Temp Access Token#>
  }

5. Integrate the Agora SDK

Run pod install in the samples/API-Example directory, and wait for the installation to complete.

6. Compile and run the sample project

1. Connect your computer to an iOS device, click on the APIExample.xcworkspace file to open the API-Example project with Xcode, and check your iOS device in the iOS Device option.

   

2. In Signing & Capabilities under the project TARGETS, check Automatically manage signing, and configure your Apple developer account and Bundle Identifier.

3. Click to start compiling.

4. When the compilation is successful, the app appears on your iOS device. You can open the app after you set it as a app from a trusted developer in your iOS system settings.

5. Once you open the app, click Join a channel (Video), enter the channel name that you used to generate the temporary token, such as test, and click Join.

   

You can now start interactive live video streaming as local host. You can invite your friend to join your live channel as remote host through the Agora Web sample app using the same App ID, channel name, and temporary token.