本文介绍在正式使用 Agora SDK for Android 进行通话/直播前,需要准备的开发环境,包含前提条件及 SDK 集成方法等内容。

前提条件

请确保满足以下开发环境要求:

  • Android SDK API Level Level ≥ 16

  • Android Studio 3.0 或以上版本

  • App 要求 Android 4.1 或以上设备

  • 在使用 Agora 相关功能及服务前,已打开特定端口,详见 防火墙说明

  • 如果你的应用以 Android 9 为目标平台,请关注 Android 隐私权变更

需要下载的文件:

Android 语音通话/语音直播 SDK

下载的文件包括 libs 文件和 sample 文件,其中 libs 文件包括:

文件/文件夹名称 文件类型
agora-rtc-sdk.jar Java JAR 文件
arm64-v8a 文件夹
armeabi-v7a 文件夹
include 文件夹
x86 文件夹

在正式使用 SDK 前,你可以尝试先在 sample 文件上集成 SDK。

创建 Agora 账号并获取 App ID

  1. 进入 https://dashboard.agora.io/ ,按照屏幕提示创建一个开发者账号。

  2. 登录 Dashboard 页面,点击添加新项目

  3. 填写项目名, 然后点击提交

  4. 在你创建的项目下,查看并获取该项目对应的App ID

添加 SDK

  1. 设置 libs 存放路径。使用 Android Studio 打开你想要运行的项目(本文以 sample 文件为例),选择 app/src/main/build.gradle 文件,将预设的 libs 路径添加到 fileTree 代码行中。

确保路径名称不包含中文字符。如果路径包含中文字符,则代码无法编译成功且会显示包含随机 ASCII 字符的错误信息。

  1. 添加 libs 文件包。根据步骤 1 中预设的路径添加 libs 文件包。

  2. 添加 sourceSets。在 build.gradle 文件里, 设置 sourceSets 的存放路径,该路径必须与 libs 路径一致。

    android {
     ...
     sourceSets {
            main {
                jniLibs.srcDirs = ['../../../libs']
            }
        }
    }
  3. 添加 App ID。选择 app/src/main/res/values/strings.xml 文件,在下列代码中填写 App ID。

    <resources>
        <string name="app_name">Agora-Android-Voice-Tutorial</string>
        ...
        <string name="agora_app_id">YOUR APP ID</string>
    </resources>
  4. 同步项目文件。点击 Sync Project With Gradle Files 按钮,直到同步完成。

配置 NDK

如需调用 libs 包中 include 文件夹里的插件时,需要配置 NDK 环境:

  1. 点击 Configure 按钮,并选择 Project Defaults > Project Structure,点击下载 Android NDK。

  2. 下载完成后点击 Finish,Android Studio 会自动添加 NDK 路径。

    若 NDK 路径没有自动添加,则点击 select 手动添加即可,并在 local.properties 配置文件中检查配置路径是否正确。

  3. 点击 Sync Project With Gradle Files 按钮,重新同步 Android 项目文件。

添加权限

  1. 打开 app/src/main/AndroidManifest.xml 文件,添加必要的设备权限。例如:

    <manifest xmlns:android="http://schemas.android.com/apk/res/android"
       package="io.agora.tutorials1v1acall">
    
    <uses-permission android:name="android.permission.READ_PHONE_STATE" />    
    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.RECORD_AUDIO" />
    <uses-permission android:name="android.permission.CAMERA" />
    <uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
    <!-- The Agora SDK requires Bluetooth permissions in case users are using Bluetooth devices.-->
    <uses-permission android:name="android.permission.BLUETOOTH" />
    
    ...
    </manifest>
  2. 点击 Sync Project With Gradle Files , 重新同步 Android 项目文件。

防止混淆代码

proguard-rules.pro 文件中,为 Agora SDK 添加 -keep 类的配置,这样可以防止混淆 Agora SDK 公共类名称:

-keep class io.agora.**{*;}

相关文档

完成了客户端集成后,你可以使用 Agora SDK,依次实现左侧《快速开始》菜单栏下的步骤,进行通话/直播:

  • 初始化
  • 加入频道
  • 发布和订阅流