Run the Sample Project

Introduction

Agora provides an open-source Agora-macOS-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 11.0 or later (the interface description in this article is based on Xcode 11.0).
• A macOS device running macOS 10.10 or later.
• A valid Agora account.
• Valid developer signature and device permission settings.

Procedure

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 navigate to the Basic-Video-Call/One-to-One-Video/Agora-macOS-Tutorial-Swift-1to1/Agora-Mac-Tutorial-Swift folder.

2. Open the AppID.swift file, and enter the App ID and the temporary token.

   // Replace <#Your App ID#> with the App ID of your Agora project, and add quotation marks. For example, "xxxxxx".
   let AppID: String = <#Your App ID#>
   // Replace <#Temp Token#> with the temporary token generated in Agora Console, and add quotation marks. For example, "xxxxxx".
   let Token: String? = <#Temp Token#>

3. Open the VideoChatViewController.swift file, and replace demoChannel1 with the channel name that you use to generate the temporary token.

   func joinChannel() {
        AgoraKit.joinChannel(byToken: Token, channelId: "demoChannel1", info:nil, uid:0) { (sid, uid, elapsed) -> Void in
        }
    }

5. Integrate the Agora SDK

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

1. Go to SDK Downloads, download the latest version of the Video SDK, and extract the files from the downloaded SDK package.
2. Copy all files from the libs folder to the Agora-Mac-Tutorial-Swift folder.

6. Start a video call

Run the sample project to start a video call, as follows:

Open and run the Agora-Mac-Tutorial-Swift.xcodeproj sample project on a macOS device. When the sample project runs successfully, you can see the following interface.

If you want to experience a one-to-one video call, you can also use the Agora Web sample app to interact with your macOS device. Ensure that you enter the same App ID, channel name, and temporary token in the Agora Web sample app as in the OpenLive sample app.

Sample project structure

See the code of the main functions and the front-end style in the VideoChatViewController.swift file of the sample project for your reference.

Relevant links

Agora provides the following additional video call sample projects on GitHub:

• One-to-One-Video/Agora-macOS-Tutorial-Objective-C-1to1
• Group-Video/OpenVideoCall-macOS