开始互动直播

通过集成声网视频 SDK，开发者能够在社交、工作、教育和 IoT app 里快速实现实时音视频互动。

本文介绍如何通过少量代码集成声网视频 SDK ，在你的 Android app 里实现互动直播。

技术原理

下图展示在 app 中集成声网互动直播的基本工作流程：

实现互动直播的步骤如下：

1. 设置角色：互动直播频道中，用户角色可以是主播或者观众。主播在频道内发布音视频流，观众可订阅流。
2. 获取 Token：当 app 客户端加入频道时，你需要通过 Token 验证用户身份。App 客户端向 app 服务器发送请求，并获取 Token，然后在客户端加入频道时验证用户身份。
3. 加入频道：调用 joinChannel 创建并加入频道。使用同一频道名称的 app 客户端默认加入同一频道。
4. 在频道内发布和订阅音视频：加入频道后，角色为主播的 app 客户端可以发布音视频。对于角色为观众的客户端，如果想要发布音视频，可以调用 setClientRole 切换用户角色。

App 客户端加入频道需要以下信息：

• 频道名称：用于标识直播频道的字符串。
• App ID：声网随机生成的字符串，用于识别你的 app，可从声网控制台获取。
• 用户 ID：用户的唯一标识。你需要自行设置用户 ID，并确保它在频道内是唯一的。
• Token：在测试或生产环境中，你的 app 客户端会从你的服务器中获取 Token。为方便快速测试，你也可以获取临时 Token。临时 Token 的有效期为 24 小时。

前提条件

开始前，请确保你的开发环境满足以下条件：

• Android Studio 3.0 或以上版本。
• Android API 级别 16 或以上。
• 有效的声网账户。
• 有效的声网项目，获取项目的 App ID，并生成一个临时 Token。详情请参考开始使用声网平台。
• 可以访问互联网的计算机。如果你的网络环境部署了防火墙，请参考应用企业防火墙限制以正常使用声网服务。
• 运行 Android 4.1 或以上版本的移动设备。

建立项目

实现视频通话之前，参考如下步骤设置你的项目：

1. 如需创建新项目，在 Android Studio 里，依次选择 Phone and Tablet > Empty Activity，创建 Android 项目。

   创建项目后，Android Studio 会自动开始同步 gradle。请确保同步成功再进行下一步操作。

2. 使用 Maven Central 将 Agora 视频 SDK 集成到你的项目中。更多集成方式，请参考集成 SDK 的其他方法。

   a. 在 /Gradle Scripts/build.gradle(Project: <projectname>) 文件中添加如下代码，以添加 Maven Central 依赖：

    buildscript {
            repositories {
                    ...
                    mavenCentral()
            }
            ...
    }
   
    allprojects {
            repositories {
                    ...
                    mavenCentral()
            }
    }

   如果你的 Android 项目设置了 dependencyResolutionManagement，添加 Maven Central 依赖的方式可能存在差异。

   b. 在 /Gradle Scripts/build.gradle(Module: <projectname>.app) 文件中添加如下代码，将 Agora 视频 SDK 集成到你的 Android 项目中：

    ...
    dependencies {
     ...
     // x.y.z，请填写具体的 SDK 版本号，如：3.5.0 或 3.7.0.2。
     // 通过发版说明获取最新版本号。
     implementation 'io.agora.rtc:full-sdk:x.y.z'
    }

3. 在 /app/Manifests/AndroidManifest.xml 文件中的 </application> 后面添加如下网络和设备权限：

    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.CAMERA" />
    <uses-permission android:name="android.permission.RECORD_AUDIO" />
    <uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
    <uses-permission android:name="android.permission.BLUETOOTH" />
    <!-- 对于 Android 12.0 及以上设备，还需要添加如下权限： -->
    <uses-permission android:name="android.permission.BLUETOOTH_CONNECT"  />
    <uses-permission android:name="android.permission.READ_PHONE_STATE" />

4. 在 /Gradle Scripts/proguard-rules.pro 文件中添加如下行，以防止声网 SDK 的代码被混淆：

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

在客户端实现互动直播

本节介绍如何使用声网视频 SDK 在你的 app 里实现互动直播。

创建用户界面

互动直播的用户界面中，通常有两个视图框，分别用于展示本地视频和远端视频。在 /app/res/layout/activity_main.xml 文件中，用如下代码进行替换：

<?xml version="1.0" encoding="UTF-8"?>
<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:id="@+id/activity_main"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".MainActivity">

    <FrameLayout
        android:id="@+id/local_video_view_container"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:background="@android:color/white" />

    <FrameLayout
        android:id="@+id/remote_video_view_container"
        android:layout_width="160dp"
        android:layout_height="160dp"
        android:layout_alignParentEnd="true"
        android:layout_alignParentRight="true"
        android:layout_alignParentTop="true"
        android:layout_marginEnd="16dp"
        android:layout_marginRight="16dp"
        android:layout_marginTop="16dp"
        android:background="@android:color/darker_gray" />

</RelativeLayout>

处理 Android 系统逻辑

本节介绍如何导入所需的 Android 相关的类，获取 Android 权限。

1. 导入 Android 相关的类

   在 /app/java/com.example.<projectname>/MainActivity 文件中，在 package com.example.<projectname> 后添加如下代码：

   import androidx.core.app.ActivityCompat;
   import androidx.core.content.ContextCompat;
   
   import android.Manifest;
   import android.content.pm.PackageManager;
   import android.view.SurfaceView;
   import android.widget.FrameLayout;

2. 获取 Android 权限

   启动应用程序时，检查是否已在 app 中授予了实现直播所需的权限。如果未授权，使用内置的 Android 功能申请权限；如果已授权，则返回 true。

   在 /app/java/com.example.<projectname>/MainActivity 文件中，在 onCreate 函数前添加如下代码：

   private static final int PERMISSION_REQ_ID = 22;
   
   private static final String[] REQUESTED_PERMISSIONS = {
                   Manifest.permission.RECORD_AUDIO,
                   Manifest.permission.CAMERA
   };
   
   private boolean checkSelfPermission(String permission, int requestCode) {
           if (ContextCompat.checkSelfPermission(this, permission) !=
                           PackageManager.PERMISSION_GRANTED) {
                   ActivityCompat.requestPermissions(this, REQUESTED_PERMISSIONS, requestCode);
                   return false;
           }
           return true;
   }

实现互动直播逻辑

打开你的 app，创建 RtcEngine 实例，启用视频后加入频道。如果本地用户是主播，则将本地视频发布到用户界面下方的视图中。如果另一主播加入该频道，你的 app 会捕捉到这一加入事件，并将远端视频添加到用户界面右上角的视图中。

互动直播的 API 使用时序见下图：

按照以下步骤实现该逻辑：

1. 导入声网相关的类

   在 /app/java/com.example.<projectname>/MainActivity 文件中，在 import android.os.Bundle; 后加入如下代码：

   import io.agora.rtc.Constants;
   import io.agora.rtc.IRtcEngineEventHandler;
   import io.agora.rtc.RtcEngine;
   import io.agora.rtc.video.VideoCanvas;

2. 创建变量

   在 /app/java/com.example.<projectname>/MainActivity 文件中，在 AppCompatActivity { 后加入如下代码：

    // 填写你的项目在声网控制台中生成的 App ID。
    private String appId = "";
    // 填写频道名称。
    private String channelName = "";  
    // 填写声网控制台中生成的临时 Token。
    private String token = "";
   
    private RtcEngine mRtcEngine;
   
    private final IRtcEngineEventHandler mRtcEventHandler = new IRtcEngineEventHandler() {
        @Override
        // 监听频道内的远端主播，获取主播的 uid 信息。
        public void onUserJoined(int uid, int elapsed) {
            runOnUiThread(new Runnable() {
                @Override
                public void run() {
                    // 从 onUserJoined 回调获取 uid 后，调用 setupRemoteVideo，设置远端视频视图。
                    setupRemoteVideo(uid);
                }
            });
        }
    };

3. 初始化 app 并加入频道

   调用核心方法来创建并加入声网直播频道。在如下示例代码，我们使用 initializeAndJoinChannel 函数来封装核心方法。

   在 /app/java/com.example.<projectname>/MainActivity 文件中，在 onCreate 函数后添加如下代码：

       private void initializeAndJoinChannel() {
           try {
               mRtcEngine = RtcEngine.create(getBaseContext(), appId, mRtcEventHandler);
           } catch (Exception e) {
               throw new RuntimeException("Check the error.");
           }
   
           // 直播场景下，设置频道场景为 BROADCASTING。
           mRtcEngine.setChannelProfile(Constants.CHANNEL_PROFILE_LIVE_BROADCASTING);
           // 根据场景设置用户角色为 BORADCASTER 或 AUDIENCE。
           mRtcEngine.setClientRole(Constants.CLIENT_ROLE_BROADCASTER);
   
           // 视频默认禁用，你需要调用 enableVideo 开始视频流。 
           mRtcEngine.enableVideo();
   
           FrameLayout container = findViewById(R.id.local_video_view_container);
           // 调用 CreateRendererView 创建一个 SurfaceView 对象，并将其作为 FrameLayout 的子对象。
           SurfaceView surfaceView = RtcEngine.CreateRendererView(getBaseContext());
           container.addView(surfaceView);
           // 将 SurfaceView 对象传入声网，以渲染本地视频。
           mRtcEngine.setupLocalVideo(new VideoCanvas(surfaceView, VideoCanvas.RENDER_MODE_FIT, 0));
   
           // 使用 Token 加入频道。
           mRtcEngine.joinChannel(token, channelName, "", 0);
       }    

4. 当远端主播加入频道时添加远端界面

   在 /app/java/com.example.<projectname>/MainActivity 文件中，在 initializeAndJoinChannel 函数后加入如下代码：

   private void setupRemoteVideo(int uid) {
       FrameLayout container = findViewById(R.id.remote_video_view_container);
       SurfaceView surfaceView = RtcEngine.CreateRendererView(getBaseContext());
       surfaceView.setZOrderMediaOverlay(true);
       container.addView(surfaceView);
       mRtcEngine.setupRemoteVideo(new VideoCanvas(surfaceView, VideoCanvas.RENDER_MODE_FIT, uid));
   }

启动和关闭 app

添加完互动直播功能后，可以添加启动和关闭 app 的逻辑。App 启动时，用户就加入了互动直播；app 关闭时，直播结束。

1. 检查 app 是否有正确的权限。如果已授予权限，调用 initializeAndJoinChannel 加入直播频道。

   在 /app/java/com.example.<projectname>/MainActivity 文件中，用如下代码替换 onCreate。

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
   
        // 如果已经授予所有权限，初始化 RtcEngine 对象并加入一个频道。
        if (checkSelfPermission(REQUESTED_PERMISSIONS[0], PERMISSION_REQ_ID) &&
                checkSelfPermission(REQUESTED_PERMISSIONS[1], PERMISSION_REQ_ID)) {
            initializeAndJoinChannel();
        }
    }

2. App 关闭后，清理你在 initializeAndJoinChannel 函数中创建的所有资源。

   在 /app/java/com.example.<projectname>/MainActivity 文件中，在 onCreate 函数后添加 onDestroy。

    protected void onDestroy() {
        super.onDestroy();
   
        mRtcEngine.leaveChannel();
        mRtcEngine.destroy();
    }

测试你的 app

将 Android 设备连接到你的电脑，并在 Android Studio 里点击 Run 'app'。片刻后，项目便会安装到你的设备上。按照以下步骤测试直播 app：

1. 授予你的 app 麦克风和摄像头权限。
2. 启动 app，如果你将用户角色设置为 BROADCASTER ，便会在本地视图中看到自己。
3. 请一位朋友克隆 API-Examples-Web 项目到本地，在浏览器中打开 Demo/index.html 文件，并输入相同的 App ID、频道名和临时 Token，加入直播。
4. 如果你的朋友作为主播加入，你们会看到彼此，并听到彼此的声音；如果作为观众加入，你只能看到自己，你的朋友可以看到你并听到你的声音。

后续步骤

为保证通信安全，声网不推荐在生产环境中使用临时 Token。请参考使用 Token 鉴权，了解如何从你的服务器中获取 Token 并开始直播。

相关信息

本节提供了额外的信息供参考。

示例项目

声网在 GitHub 上提供了一个开源的互动直播示例项目 JoinChannelVideo 供你参考。

集成 SDK 的其他方法

除了通过 Maven Central 集成 Agora 视频 SDK 外，你也可以手动复制 SDK 文件，将 SDK 导入你的项目。

1. 在 SDK 下载页面下载最新版本的 Agora 视频 SDK，并解压。

2. 打开 SDK 包 libs 文件夹，将以下文件或子文件夹复制到你的项目路径中。

   文件或子文件夹	你的项目路径
   agora-rtc-sdk.jar 文件	/app/libs/
   arm64-v8a 文件夹	/app/src/main/jniLibs/
   armeabi-v7a 文件夹	/app/src/main/jniLibs/
   x86 文件夹	/app/src/main/jniLibs/
   x86_64 文件夹	/app/src/main/jniLibs/
   include 文件夹	/app/src/main/jniLibs/

   如果你使用 armeabi 架构, 请将 armeabi-v7a 文件夹的文件复制到你的项目 armeabi 文件中。如果出现不兼容问题，请联系我们。

监听观众事件

声网视频 SDK 不报告直播频道中观众的事件。如有需要，请参考直播场景下，如何监听远端观众角色用户加入/离开频道的事件。