Use this guide to quickly start a basic video call with the Agora SDK for Unity.
The following video demonstrates how to build an app that implements the Agora video call from scratch.
The following figure shows the workflow to integrate into your app in order to add Video Call functionality.
As shown in the figure, the workflow for adding Video Call in your project is as follows:
Retrieve a token
A token is the credential that authenticates a user when your app client joins a channel. In a test or production environment, your app client retrieves tokens from a server in your security infrastructure.
Join a channel
Call joinChannel
to create and join a channel. App clients that pass the same channel name join the same channel.
Publish and subscribe to audio and video in the channel
After joining a channel, the app client automatically publishes and subscribes to audio and video in the channel.
For an app client to join a channel, you need the following information:
Unity 2017 or later
Operating system and IDE requirements:
Target Platform | Operating system version | IDE version |
---|---|---|
Android | Android 4.1 or later | Android Studio 3.0 or later |
iOS | iOS 9.0 or later | Xcode 9.0 or later |
macOS | macOS 10.10 or later | Xcode 9.0 or later |
Windows | Windows 7 or later | Microsoft Visual Studio 2017 or later |
A valid Agora account and an App ID
In this section, we create a Unity project and integrate the SDK into the project.
Use the following steps or follow the Unity official manual to build a project from scratch. Skip to Integrate the SDK if you have already created a Unity project.
Ensure that you have downloaded and installed Unity before the following steps. If not, click here to download.
Open Unity and click New.
Fill in and select the options in the following fields, and click Create project.
Choose either of the following approaches to integrate the Agora Unity SDK into your project.
Approach 1: Automatically integrate the SDK with Unity Asset Store
Approach 2: Manually add the SDK files
Go to SDK Downloads, download the Agora SDK for Unity under Video SDK, and extract the files from the downloaded SDK package.
Copy the Plugins
subfolder from the samples/Hello-Video-Unity-Agora/Assets/AgoraEngine
directory of the downloaded SDK to the Assets
subfolder of your project.
BL_BuildPostProcess.cs
file from the samples/Hello-Video-Unity-Agora/Assets/AgoraEngine/Editor
directory.This section provides instructions on using the Agora Video SDK for Unity to implement a basic one-to-one video call, as well as an API call sequence diagram.
Create the user interface (UI) for a one-to-one call in your project. If you already have one UI in your project, skip to Get the device permission (Android only) or Initialize IRtcEngine.
We recommend adding the following elements to the UI:
If you use the Unity Editor to build your UI, ensure that you bind VideoSurface.cs to the GameObjects designated for local and remote videos. In the following example, the VideoSurface.cs is applied to the cube for the local video and to the cylinder for the remote video.
If you build for Android, you should add in APIs to check and request the device permission. For all other platforms, this is handled by the engine, and you can skip to Initialize IRtcEngine.
Unity versions later than UNITY_2018_3_OR_NEWER do not automatically request camera and microphone permissions from your Android device. If you are using one of these versions, call the CheckPermission
method to request access to the camera and microphone of your Android device.
#if(UNITY_2018_3_OR_NEWER)
using UnityEngine.Android;
#endif
void Start ()
{
#if(UNITY_2018_3_OR_NEWER)
permissionList.Add(Permission.Microphone);
permissionList.Add(Permission.Camera);
#endif
}
private void CheckPermission()
{
#if(UNITY_2018_3_OR_NEWER)
foreach(string permission in permissionList)
{
if (Permission.HasUserAuthorizedPermission(permission))
{
}
else
{
Permission.RequestUserPermission(permission);
}
}
#endif
}
void Update ()
{
#if(UNITY_2018_3_OR_NEWER)
// Ask for your Android device's permissions.
CheckPermission();
#endif
}
Initialize the IRtcEngine
object before calling any other Agora APIs.
Call the GetEngine
method and pass in the App ID to initialize the IRtcEngine object.
Listen for callback events, such as when the local user joins the channel, and when the first video frame of a remote user is decoded.
// Pass an App ID to create and initialize an IRtcEngine object.
mRtcEngine = IRtcEngine.GetEngine (appId);
// Listen for the OnJoinChannelSuccessHandler callback.
// This callback occurs when the local user successfully joins the channel.
mRtcEngine.OnJoinChannelSuccessHandler = OnJoinChannelSuccessHandler;
// Listen for the OnUserJoinedHandler callback.
// This callback occurs when the first video frame of a remote user is received and decoded after the remote user successfully joins the channel.
// You can call the SetForUser method in this callback to set the remote video.
mRtcEngine.OnUserJoinedHandler = OnUserJoinedHandler;
// Listen for the OnUserOfflineHandler callback.
// This callback occurs when the remote user leaves the channel or drops offline.
mRtcEngine.OnUserOfflineHandler = OnUserOfflineHandler;
After initializing an IRtcEngine
object, set the local video before joining a channel so that you can see yourself in the call. Follow these steps to configure the local video:
Call EnableVideo
to enable the video module.
Call EnableVideoObserver
to get the local video.
// Enable the video module.
mRtcEngine.EnableVideo();
// Get the local video and pass it on to Unity.
mRtcEngine.EnableVideoObserver();`
Choose an object to display the local video, and drag the VideoSurface.cs file to Script, so that you can bind the VideoSurface.cs file to the object and see the local video. Unity renders 3D objects by default, such as Cube, Cylinder and Plane. To render the object in other types, modify the renderer in the VideoSurface.cs file.
// The default renderer is Renderer.
Renderer rend = GetComponent();
rend.material.mainTexture = nativeTexture;
// Change the renderer to RawImage.
RawImage rend = GetComponent();
rend.texture = nativeTexture;`
After initializing an IRtcEngine
object and setting the local video, call JoinChannelByKey
to join a channel. Set the following parameters when calling this method:
channelKey
: The token for identifying the role and privileges of a user. Set it as one of the following values:
channelKey
as "".channelName
: The unique name of the channel to join. Users that input the same channel name join the same channel.
uid
: Integer. The unique ID of the local user. If you set uid
as 0, the SDK automatically assigns one user ID and returns it in the OnJoinChannelSuccessHandler
callback.
// Join a channel.
mRtcEngine.JoinChannelByKey(null, channel, null, 0);
In a video call, you should be able to see remote users too. Call SetForUser
in VideoSurface.cs after joining a channel.
When you are in a channel and a remote user joins this channel, the SDK triggers the OnUserJoinedHandler
callback, and you can get the user’s uid.
In the VideoSurface.cs file, call the SetForUser
method in the callback, and pass in the uid
to set the video of the remote user.
Drag the VideoSurface.cs script to the target object, so that you can bind the VideoSurface.cs to the object and see the remote video.
The video capture and render frame rate of Agora Unity SDK is 15 fps by default. Call SetGameFps
in the VideoSurface.cs file to adjust the video refresh rate based on your scenario.
// This callback occurs when the first video frame of a remote user is received and decoded after the remote user successfully joins the channel.
// You can call the SetForUser method in this callback to set up the remote video view.
private void OnUserJoinedHandler(uint uid, int elapsed)
{
Debug.Log ("OnUserJoinedHandler: uid = " + uid)
GameObject go = GameObject.Find (uid.ToString ());
if (!ReferenceEquals (go, null)) {
return;
}
go = GameObject.CreatePrimitive (PrimitiveType.Plane);
if (!ReferenceEquals (go, null)) {
go.name = uid.ToString ();
VideoSurface remoteVideoSurface = go.AddComponent<VideoSurface> ();
// Set the remote video.
remoteVideoSurface.SetForUser (uid);
// Adjust the video refreshing frame rate. The video capture and render frame rate of Agora Unity SDK is 15 fps by default.
// For example, in the game scenario, the refreshing frame rate of the game is 60 fps, which causes 3 times redundancy compared to the video render frame rate. Call the SetGameFps to adjust the refreshing frame rate of the game to 15 fps.
remoteVideoSurface.SetGameFps (60);
remoteVideoSurface.SetEnable (true);
}
mRemotePeer = uid;
}
To remove the VideoSurface.cs script from the object, see the following sample codes.
private void OnUserOfflineHandler(uint uid, USER_OFFLINE_REASON reason)
{
// Remove video stream.
// Call this in the main thread.
GameObject go = GameObject.Find (uid.ToString());
if (!ReferenceEquals (go, null)) {
Destroy (go);
}
}
According to your scenario, such as when the call ends and when you need to close the app, call LeaveChannel
to leave the current call, and call DisableVideoObserver
to disable the video.
public void leave()
{
Debug.Log ("calling leave");
if (mRtcEngine == null)
return;
// Leave the channel.
mRtcEngine.LeaveChannel();
// Disable the video.
mRtcEngine.DisableVideoObserver();
}
After leaving the channel, if you want to exit the app or release the memory of IRtcEngine
, call Destroy
to destroy the IRtcEngine
object.
void OnApplicationQuit()
{
if (mRtcEngine != null)
{
// Destroy the IRtcEngine object.
IRtcEngine.Destroy();
mRtcEngine = null;
}
}
You can find the complete code in the sample project provided by Agora on GitHub.
Run the project in Unity. You should be able to see both the local and remote video if you successfully start a one-to-one video call.
When using the Agora Unity SDK, you can also use the dollowing documents as a reference: