Run the Sample Project

Agora provides an open-source Agora-iOS-Tutorial-Swift-1to1 sample project on GitHub. This document introduces how to run this project and experience a video call 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

1. Download the Basic-Video-Call repository, and find the Agora-iOS-Voice-Tutorial-Swift-1to1 sample project.

2. Fill in the Agora-iOS-Tutorial/AppID.swift file with the App ID and temporary token generated in Agora Console.

   // Replace #Your App Id# with your App ID, and add quotation marks around it, such as "xxxxxx"
   let AppID: String = <#Your App ID#>
   
   // Replace #Temp Access Token# with your temporary Token, and add quotation marks, such as "xxxxxx"
   let Token: String? = <#Temp Token#>

3. Open the VideoChatViewController.swift file, and set channelId of the joinChannelByToken method with the channel name that you use to generate the temporary token.

   func joinChannel() {
        agoraKit.setDefaultAudioRouteToSpeakerphone(true)
        // Replace demoChannel1 with the channel name that you use to generate the temporary token
        agoraKit.joinChannel(byToken: Token, channelId: "demoChannel1", info: nil, uid: 0) { [unowned self] (channel, uid, elapsed) -> Void in
            self.isLocalVideoRender = true
            self.logVC?.log(type: .info, content: "did join channel")
        }

5. Integrate the Agora SDK

Integrate the Agora iOS SDK into the sample project, as follows:

1. Download the latest Video SDK and extract the files.
2. Copy all files from the libs folder to the Agora-iOS-Tutorial folder.

6. Compile and run the sample project

Connect your computer to an iOS device, open the sample project on Xcode, and then compile and run the project. If the project runs successfully, you can see the following screen on the iOS device:

Now you can experience a video call. You can also use the Agora Web sample app to interact with your iOS device. Ensure that you enter the same App ID, channel name, and temporary token in the Agora Web sample app.

Sample project structure

The following table lists the structure of the sample project for your reference:

Relevant links

Apart from Swift, Agora provides an additional Agora-iOS-Tutorial-Objective-C-1to1 sample project in Objective-C.