Integrate the SDK

This article shows how to integrate the Server Gateway C++ SDK and run the sample project.

Set up the development environment

Make sure your server meets the following requirements.

Hardware environment

Operating system

• Ubuntu 14.04 or higher
• CentOS: 7.0 or higher

CPU architecture

• arm64
• x86-64

If you need to run the SDK on other architectures, submit a ticket to contact technical support.

Performance

• CPU：8-core, 1.8 GHz or higher.
• 2 GB of RAM or higher. 4 GB or higher is recommended.

Network

• The server is connected to the internet and has an internet IP.
• The server can access *.agora.io and *.agoralab.co.

Software environment

• glibc 2.18 or later
• gcc 4.8 or later

If you are using Ubuntu, taking Ubuntu 20.04.3 LTS as an example, install the following dependencies in your server:

# Install aptitude
sudo apt install aptitude
# Install build-essential libx11-dev libxcomposite-dev libxext-dev libxfixes-dev libxdamage-dev cmake
sudo aptitude install libx11-dev libxcomposite-dev libxext-dev libxfixes-dev libxdamage-dev cmake

If you are using CentOS, taking CentOS 7.9.2009 as an example, install the following dependencies in your server:

sudo yum groupinstall "Development Tools"
sudo yum install wget
sudo yum groupinstall X11

Get an Agora App ID and a Video SDK Temporary Token

See Get Started with Agora to learn how to get an Agora App ID and a Video SDK temporary token.

Get the SDK

Download the latest x86-64 SDK package and decompress the file. If you need the SDK build for other architectures, submit a ticket to technical support.

This article shows how to create a simple Maven project, integrate the Server Gateway Java SDK, and run the app.

Set up the development environment

Make sure your server meets the following requirements.

Hardware environment

Operating system

• Ubuntu 18.04 or higher
• CentOS: 7.0 or higher

CPU architecture

• arm64
• x86-64

If you need to run the SDK on other architectures, submit a ticket to contact technical support.

Performance

• CPU：8-core, 1.8 GHz or higher.
• 2 GB of RAM or higher. 4 GB or higher is recommended.

Network

• The server is connected to the internet and has an internet IP.
• The server can access *.agora.io and *.agoralab.co.

Software environment

• Apache Maven or other build tools. This page uses Apache Maven as an example.
• JDK 8

Get an Agora App ID and a Video SDK Temporary Token

See Get Started with Agora to learn how to get an Agora App ID and a Video SDK temporary token.

Create a Maven project

See Maven in Five Minutes to create a Maven project.

mvn archetype:generate -DgroupId=com.mycompany.app -DartifactId=my-app -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.4 -DinteractiveMode=false

Integrate the SDK

1. Navigate to the my-app folder.

   cd my-app

2. Open pom.xml and replace the content with the following:

   <?xml version="1.0" encoding="UTF-8"?>
   <project xmlns="http://maven.apache.org/POM/4.0.0"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
   
   <groupId>org.example</groupId>
   <artifactId>agora-rtc-linux-java</artifactId>
   <version>1.0-SNAPSHOT</version>
   
   <dependencies>
       <dependency>
       <groupId>io.agora.rtc</groupId>
       <artifactId>linux-sdk</artifactId>
       <version>3.7.200.21</version>
       </dependency>
   </dependencies>
   
   <properties>
       <maven.compiler.source>1.8</maven.compiler.source>
       <maven.compiler.target>1.8</maven.compiler.target>
   </properties>
   
   <build>
       <plugins>
       <plugin>
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-shade-plugin</artifactId>
           <version>2.3</version>
           <configuration>
           <createDependencyReducedPom>true</createDependencyReducedPom>
           </configuration>
           <executions>
           <execution>
               <phase>package</phase>
               <goals>
               <goal>shade</goal>
               </goals>
               <configuration>
               <transformers>
                   <transformer
                       implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                   <mainClass>App</mainClass>
                   </transformer>
               </transformers>
               </configuration>
           </execution>
           </executions>
       </plugin>
       </plugins>
   </build>
   </project>

This article shows how to integrate the Server Gateway Python SDK and run the sample project.

Set up the development environment

Make sure your server meets the following requirements.

Hardware environment

Operating system

• Ubuntu 18.04 or higher
• CentOS: 7.0 or higher

CPU architecture

• x86-64

If you need to run the SDK on other architectures, submit a ticket to contact technical support.

Performance

• CPU：8 cores, 1.8 GHz or higher.
• 2 GB of RAM or higher. 4 GB or higher is recommended.

Network

• The server is connected to the internet and has an internet IP.
• The server can access *.agora.io and *.agoralab.co.

Software environment

• An IDE that supports Python, such as PyCharm or Visual Studio Code.
• Python 3.10 or above

Get an Agora app ID and a Video SDK temporary token

See Get Started with Agora to learn how to get an Agora app ID and a Video SDK temporary token.

Download and install the SDK

Run the following command to get the latest SDK.

pip install agora_python_server_sdk

This article shows how to integrate the Server Gateway Go SDK and run the sample project.

Set up the development environment

Make sure your server meets the following requirements.

Hardware environment

Operating system

• Ubuntu 18.04 or higher
• CentOS: 7.0 or higher

CPU architecture

• x86-64

If you need to run the SDK on other architectures, submit a ticket to contact technical support.

Performance

• CPU：8-core, 1.8 GHz or higher.
• 2 GB of RAM or higher. 4 GB or higher is recommended.

Network

• The server is connected to the internet and has an internet IP.
• The server can access *.agora.io and *.agoralab.co.

Software environment

• Go 1.21 or above

Get an Agora app ID and a Video SDK temporary token

See Get Started with Agora to learn how to get an Agora app ID and a Video SDK temporary token.

Get the SDK

Run the following command to get the latest SDK.

git clone https://github.com/AgoraIO-Extensions/Agora-Golang-Server-SDK.git go_rtc_sdk

Compile the sample project

Run the following commands to compile the sample project:

# Enter the SDK directory
cd go_rtc_sdk
# Execute the build
make build

Add the required dependencies

In the project’s go.mod or builds file, add the following lines to include the required SDK dependencies.

# Replace /path/to/go_rtc_sdk with the actual path of the SDK you downloaded in Step 1
replace github.com/AgoraIO-Extensions/Agora-Golang-Server-SDK/v2 => /path/to/go_rtc_sdk
# Replace version_number with the actual SDK version number, which you can find in the release notes, e.g., v2.1.0
require github.com/AgoraIO-Extensions/Agora-Golang-Server-SDK/v2 version_number