Run the Sample Project

Introduction

Agora provides an open-source One-to-One-Video sample project on GitHub. This document introduces how to run this project and experience a video call implemented by the Agora SDK.

Prerequisites

• A valid Agora account.
• An Agora project with an App ID and a temp token
• A Windows or macOS computer meets the following requirements:
  • Access to the Internet. If your network has a firewall, follow the instructions in Firewall Requirements to access Agora services.
  • A browser that matches the supported browser list. Agora highly recommends using the latest version of Google Chrome.
  • Physical media input devices, such as a built-in camera and a built-in microphone.
  • An Intel 2.2GHz Core i3/i5/i7 processor (2nd generation) or equivalent

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. Integrate the Agora SDK

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

1. Download the Basic-Video-Call repository, and find the Agora-Web-Tutorial-1to1 sample project in the Basic-Video-Call/One-to-One-Video directory.
2. Download the latest Web Video SDK, and extract the files.
3. Copy the .js file starting with AgoraRTCSDK to the assets folder in the Agora-Web-Tutorial-1to1 project, and rename the file to AgoraRTCSDK.js.

5. Join a video call

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

1. Open the index.html file in Chrome. You will see the Basic Communication page:
   

2. Enter the App ID and temporary token, as well as the channel name that you use to generate the temporary token.

3. Click JOIN, and allow the browser to access your camera and microphone in the pop-up window.

   You should see a video stream of yourself on the page.

4. To try a one-to-one video call, duplicate the browser tab, enter the same App ID, channel name, and temporary token, and then click JOIN.

   You should see two video streams in each browser window.

If the sample project does not work properly, open the browser console and check for errors. The following are the most likely errors:

• INVALID_VENDOR_KEY: Incorrect App ID or token. Ensure that you enter the correct App ID and token.
• DYNAMIC_USE_STATIC_KEY: Token missing. Because your Agora project enables App Certificate, you need a token to join the channel.
• Media access:NotFoundError: Camera/microphone error. Check that your camera and microphone are working properly.

Sample project structure

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

Relevant links

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

• Agora-Web-Tutorial-1to1-Webpack
• Agora-Web-Tutorial-1to1-Vue
• Agora-Web-Tutorial-1to1-React
• OpenVideoCall