Communication Integration - WebAgent

Step 1: Obtain the SDK

Download the latest Agora Native SDK for Web(WebAgent for short) from downloads or contact sales-us@agora.io.

Step 2: Prepare the Environments

  1. Be sure that you understand the compatibility with Agora Native SDK, and the difference from Agora Web SDK according to:

    Both of the Agora Native SDK for Web(WebAgent for short) and the Agora Web SDK(WebRTC for short) support communication and live broadcast functions, and their differences are listed as follows:

    Difference Agora Native SDK for Web Agora Web SDK
    Interoperability [1] Supporting the interoperability with all-platform Agora Native SDKs(v1.3 or later) in both communication and live broadcast scenario. Supporting the interoperability with all-platform Agora Native SDKs(v1.8 or later) in the live broadcast scenario. Agora Web SDK is a beta version now, thus it is recommended to use the interoperability with Agora Native SDK one to one, and the interoperability with multiple users is under continual improvement. [2]
    Plugin Agora Native SDK for Web needs to install one plugin application called AgoraWebAgent. Agora Web SDK does not need to install any plugin.
    Supported Browser Edge, Chrome and Safari
    • Communication: All mainstream browsers except for IE and Safari
    • Live Broadcast: Chrome
    Supported Platform Windows and Mac Windows and Mac

    Footnotes

    [1]

    To implement the interoperability between Agora Native SDK and Agora Web SDK, the users who use the Agora Native SDK shall call enableWebSdkInteroperability to enable the function.

    [2]

    If the users want to implement the communication function with Agora Web SDK and Agora Native SDK, they must all join the live broadcast channel as hosts.

  2. Be sure that the following browser requirements are satisfied:

    Platform Browser Requirement
    Windows Edge 25.10586.0.0
    Windows 10 Chrome 51.0.2704.103 (64 bit)
    Mac Safari 9.1.1(11601.6.17)

    Note

    • Do not use an unsupported browser, for example, Opera, Firefox, and Chrome browsers are not supported and will behave unpredictably.
    • Chrome is supported on Windows at 640x480p 30fps resolution. Other higher resolutions will be supported in future releases.
  3. Be sure that the following requirements for operating systems are satisfied:

    OS Requirements
    Windows Windows 7 or later
    Mac OS X v10.10 or later
  4. Understand the following capabilities and limitations:

    • The maximum supported video resolution:720p 15fps and 480p 30fps.
    • A PC can only have one instance running.

Step 3: Deploy Javascript application

The applications using the Agora Native SDK for Web are standard JavaScript applications. To deploy the application, you need to load the Agora JS library and also need access to the JS extension libraries provided with the SDK.

Load the Agora JS library AgoraRtcAgentSDK-1.8.0.js which can be downloaded from:

http://download.agora.io/sdk/release/AgoraRtcAgentSDK-1.8.0.js or https://download.agora.io/sdk/release/AgoraRtcAgentSDK-1.8.0.js

Note

The webagent log is stored at:

  • Windows: c://username/AppData/Local/Agora/AgoraWebAgent
  • Mac: /Users/username/Library/Logs/AgoraWebAgent.log

Replace username with your PC user name.

Step 4: Call APIs

Refer to Communication API - WebAgent to implement the required functions.

Appendix: Install or Uninstall AgoraWebAgent

Install AgoraWebAgent

After your deployment, the client will ask your users to install the AgoraWebAgent application on their Windows or Mac according to the system prompt. The system prompt includes a download link and an installation guide provided by Agora, and your users can directly use them or you can customize them to redirect the users to your website. The following shows the installation guide again for your customization convenience:

On Windows

  1. Double-click the AgoraWebAgent.exe downloaded from the system prompt.
../../_images/webagent_windows_1.png
  1. Select the language for installation: English.
  2. Click Browse… if you want to select a different folder. Otherwise, click Next>.
  3. Click Install and wait until the progress bar is completed.
../../_images/webagent_windows_4.png
  1. Select Run AgoraWebAgent.exe and then click Finish.
../../_images/webagent_windows_5.png

Once the program is installed, a shortcut is displayed on the Desktop and AgoraWebAgent starts up automatically whenever starting the computer. An icon will display at the lower right part of the toolbar if AgoraWebAgent is running. Users can disable/enable the automatic start-up in the task manager. If the plugin program is closed while using the Agora Video Call on the browser, restart it by clicking the shortcut on desktop. Once it is restarted, it starts up automatically again whenever starting the computer.

../../_images/webagent_windows_6.png

On Mac

  1. Double-click the AgoraWebAgent.pkg downloaded from the system prompt.
  2. Click Continue on the installer.
../../_images/webagent_mac_2.png
  1. Click Continue.
  2. Click Install to install the application on the default location.
  3. Enter your computer username and password. Proceed with Install Software.
  4. When the following message displays, the installation is complete. Click Close.
../../_images/webagent_mac_6.png

Once AgoraWebAgent is installed, it is in the applications directory by default, and it starts up automatically whenever starting the computer. An icon will display at the upper right part of the toolbar if AgoraWebAgent is running. You can disable/enable the automatic start-up by right-clicking the icon. If the program is closed while using the Agora Video Call on browser, restart it by clicking the icon in ‘/applications’ . Once it is restarted, it starts up automatically again whenever starting the computer.

Uninstall AgoraWebAgent on Windows or Mac

On Windows

The uninstallation procedure is the same as uninstalling any other application on Windows XP, Windows 7, Windows 8, and so on.

Take Windows 8 for example:

  1. Go to Desktop> Control Panel.
  2. Click Uninstalling the applications under applications.
  3. Find AgoraWebAgent.exe and right click it to select uninstall.
  4. Wait until the progress is finished.

On Mac

  1. Go to Finder on the Docker.
  2. Click and enter the folder applications.
  3. Find the installed AgoraWebAgent and right click it to select Move to Trash.