Voice-only quickstart

This JavaScript quickstart shows you how to create a basic Voice Calling app using the Agora RTC SDK.

Understand the tech

To start a Voice Calling session, implement the following steps in your app:

• Initialize the Agora Engine: Before calling other APIs, create and initialize an Agora Engine instance.

• Join a channel: Call methods to create and join a channel.

• Send and receive audio: All users can publish streams to the channel and subscribe to audio streams published by other users in the channel.

Prerequisites

• A supported browser.

• A JavaScript package manager such as npm.

• A microphone

• A valid Agora account and project. Please refer to Agora account management for details.

Set up your project

This section shows you how to set up your ReactJS project and install the Agora RTC SDK.

Create a project

To create a new ReactJS project with the necessary dependencies:

1. Ensure that you have installed Node.js LTS and npm.

2. Open a terminal and execute:

   npm create vite@latest agora-sdk-quickstart -- --template react-ts

   This creates a new project folder named agora-sdk-quickstart. Open the folder in your preferred IDE.

Install the SDK

Use one of the following methods to install the project dependencies:

npm i agora-rtc-react

<!-- Include the React development libraries (must be introduced in this order) -->
<script crossorigin src="https://unpkg.com/react@18/umd/react.development.js"></script>
<script crossorigin src="https://unpkg.com/react-dom@18/umd/react-dom.development.js"></script>

<!-- If the above React libraries have already been integrated through npm, skip them and include only the Agora RTC React SDK -->
<script src="https://download.agora.io/sdk/release/agora-rtc-react.2.3.0.js"></script>

Implement Voice Calling

This section guides you through the implementation of basic real-time audio interaction in your app.

This guide includes complete sample code that demonstrates implementing basic real-time interaction. To understand the core API calls in the sample code, review the following implementation steps.

Import Agora hooks and components

To use RTC SDK in your component, include the following imports:

import {
 LocalUser, // Plays the microphone audio track
 RemoteUser, // Plays the remote user audio
 useIsConnected, // Returns whether the SDK is connected to Agora's server
 useJoin, // Automatically join and leave a channel on mount and unmount
 useLocalMicrophoneTrack, // Create a local microphone audio track
 usePublish, // Publish the local track
 useRemoteUsers, // Retrieve the list of remote users
} from "agora-rtc-react";
import { useState } from "react";
import AgoraRTC, { AgoraRTCProvider } from "agora-rtc-react";

Initialize the client

Use the createClient method provided by the SDK to create a client object for the <AgoraRTCProvider /> component. Wrap the <Basics /> component with <AgoraRTCProvider /> to enable state management and access operation-related hooks.

For Voice Calling, set the mode property of ClientConfig to "rtc".

 const client = AgoraRTC.createClient({ mode: "rtc", codec: "vp8" });
 return(
   <AgoraRTCProvider client={client}>
    <Basics />
   </AgoraRTCProvider>
 );
}

Join a channel

To join a channel, use the useJoin hook. You can specify the following joinOptions:

• App ID: appid identifies the project you created in Agora Console.

• Channel name: The name of the channel to join. Clients that pass the same channel name join the same channel. If a channel with the specified name does not exist, it is created when the first user joins.

• Authentication token: A token is a dynamic key that authenticates a user when the client joins a channel. In a production environment, you obtain a token from a token server in your security infrastructure. For the purpose of this guide Generate a temporary token.

• User ID: uid is a 32-bit signed integer that identifies a user in the channel. You can specify a unique user ID for each user yourself. If you do not set a user ID or set it to 0 when joining a channel, the SDK generates a random number for the user ID and returns the value.

Add the following to Basics:

const [appId, setAppId] = useState("<-- Insert App ID -->");
const [channel, setChannel] = useState("<-- Insert Channel Name -->");
const [token, setToken] = useState("<-- Insert Token -->");
const [calling, setCalling] = useState(false);

useJoin({appid: appId, channel: channel, token: token ? token : null}, calling);

Play remote audio

To subscribe to remote users in a channel and play their audio tracks, use the useRemoteUsers hook along with the RemoteUser component. Follow these steps to implement the logic:

1. Retrieve the list of remote users

   Use the useRemoteUsers hook to fetch a list of remote users in the channel:

   const remoteUsers = useRemoteUsers();

2. Play remote audio tracks

   Loop through the remoteUsers list and render the RemoteUser component for each user to subscribe and play audio streams:

   {remoteUsers.map((user) => (
    <div key={user.uid}>
     <RemoteUser user={user}>
     </RemoteUser>
    </div>
   ))}

Leave the channel

To leave a channel, destroy the component, close the browser window, or refresh the browser tab. The useJoin hook automatically handles the destruction of the React component.

Complete sample code

A complete code sample demonstrating the basic process of real-time interaction is provided for your reference. To use the complete sample, add the following to your src/App.tsx file.

Test the sample code

To run the demo code:

1. Navigate to the project directory and install the dependencies:

   cd agora-sdk-quickstart
   npm install

2. Start the development server by executing the following command:

   npm run dev

3. Open the project in your browser

   Launch your browser and navigate to the localhost address shown in your terminal.

4. Fill in the app ID and the temporary token you obtained from Agora Console. Use the same channel name you used to generate the token.

5. Click the Join Channel button.

6. Ask a friend to run the same demo in their browser and join the channel using the same app ID, channel name, and temporary token as yours. After successfully joining the channel, you can talk to each other.

7. Click the microphone button at the bottom to switch the microphone on or off.

8. Click the hang-up button to end the call.

Reference

This section contains content that completes the information on this page, or points you to documentation that explains other aspects to this product.

• If a firewall is deployed in your network environment, refer to Connect with Cloud Proxy to use Agora services normally.

Next steps

After implementing the quickstart sample, read the following documents to learn more:

• To ensure communication security in a test or production environment, best practice is to obtain and use a token from an authentication server. For details, see Secure authentication with tokens.

Sample project

Agora provides an open source sample project on GitHub for your reference. The project demonstrates the use of each component and hook provided by the React SDK, as well as some advanced functions.

API reference

• LocalUser
• RemoteUser
• useIsConnected()
• useJoin()
• useLocalMicrophoneTrack()
• usePublish()
• useRemoteUsers()

See also

• Error codes