视频互动直播(Android)

最后更新时间:2021-08-27 14:26:31

    效果展示

    您可以 下载 安装我们的 App 体验互动直播的能力效果,包括互动连麦、主播 PK、低延时观看、弹幕聊天等 TRTC 在互动直播场景下的相关能力。

    如需快速接入视频互动直播功能,您可以直接基于我们提供的 App 进行修改适配,也可以使用我们提供的 TRTCLiveRoom 组件并实现自定义 UI 界面。

    复用 App 的 UI 界面

    步骤1:创建新的应用

    1. 登录实时音视频控制台,选择【开发辅助】>【快速跑通Demo】。
    2. 输入应用名称,例如 TestLiveRoom,单击【创建】。
    3. 单击【已下载,下一步】,跳过此步骤。

    注意:

    本功能同时使用了腾讯云 实时音视频 TRTC即时通信 IM 两个基础 PaaS 服务,开通实时音视频后会同步开通即时通信 IM 服务。 即时通信 IM 属于增值服务,详细计费规则请参见 即时通信 IM 价格说明

    步骤2:下载 App 源码

    单击进入 TUILiveRoom,Clone 或者下载源码。

    步骤3:配置 App 工程文件

    1. 进入修改配置页,根据您下载的源码包,选择相应的开发环境。
    2. 找到并打开 Android/Debug/src/main/java/com/tencent/liteav/debug/GenerateTestUserSig.java 文件。
    3. 设置 GenerateTestUserSig.java 文件中的相关参数:
      • SDKAPPID:默认为占位符(PLACEHOLDER),请设置为实际的 SDKAppID。
      • SECRETKEY:默认为占位符(PLACEHOLDER),请设置为实际的密钥信息。

    1. 粘贴完成后,单击【已复制粘贴,下一步】即创建成功。
    2. 编译完成后,单击【回到控制台概览】即可。
    注意:

    本文提到的生成 UserSig 的方案是在客户端代码中配置 SECRETKEY,该方法中 SECRETKEY 很容易被反编译逆向破解,一旦您的密钥泄露,攻击者就可以盗用您的腾讯云流量,因此该方法仅适合本地跑通 App 和功能调试
    正确的 UserSig 签发方式是将 UserSig 的计算代码集成到您的服务端,并提供面向 App 的接口,在需要 UserSig 时由您的 App 向业务服务器发起请求获取动态 UserSig。更多详情请参见 服务端生成 UserSig

    步骤4:运行 App

    使用 Android Studio(3.5以上的版本)打开源码工程 TUILiveRoom,单击【运行】即可开始调试本 App。

    步骤5:修改 App 源代码

    源码中的 Source 文件夹包含两个子文件夹 ui 和 model,ui 文件夹中均为界面代码,如下表格列出了各个文件或文件夹及其所对应的 UI 界面,以便于您进行二次调整:

    文件或文件夹 功能描述
    anchor 主播端相关 UI 的实现代码。
    audience 观众端相关 UI 的实现代码。
    common 通用的 UI 组件实现代码。
    widget 通用控件。

    体验应用

    注意:

    体验应用至少需要两台设备。

    用户 A

    1. 输入用户名(请确保用户名唯一性,不能与其他用户重复)并登录,如图示:
    2. 进入后,单击【创建房间】,如下图示:
    3. 输入房间名称,单击【开始直播】。

    用户 B

    1. 输入用户名(请确保用户名唯一性,不能与其他用户重复),如下图示:
    2. 输入用户 A 创建的房间号,单击进入房间,如下图示:
    注意:

    房间号在用户 A 的房间顶部查看,如下图示:

    房间状态监听&PK 列表接入

    房间状态可使用 LiveRoomManager 进行监听,如下:

    LiveRoomManager.getInstance().addCallback(new LiveRoomManager.RoomCallback() {
    /**
    * 房间创建
    * @param roomId
    * @param callback 用于通知内部处理的结果
    */

    @Override
    public void onRoomCreate(int roomId, final LiveRoomManager.ActionCallback callback) {
    // doSomething
    }

    /**
    * 房间销毁
    * @param roomId
    * @param callback 用于通知内部处理的结果
    */

    @Override
    public void onRoomDestroy(int roomId, final LiveRoomManager.ActionCallback callback) {
    // doSomething
    }

    /**
    * 获取房间列表
    * @param callback
    */

    @Override
    public void onGetRoomIdList(final LiveRoomManager.GetCallback callback) {
    // 获取房间列表,需自行维护,用于用户之间的 PK
    if(callback != null) {
    if(success)
    {
    // 回调成功,传入房间列表
    callback.onSuccess(roomList);
    } else {
    // 房间列表获取失败
    callback.onError(code, message);
    }
    }
    }
    });
    采用 Callback 方式进行回调是为了方便用户接入,例如获取房间列表可能需要进行异步操作,采用 Callback 方式将更加灵活。

    实现自定义 UI 界面

    源码 中的 Source 文件夹包含两个子文件夹 ui 和 model,model 文件夹中包含可重用的开源组件 TRTCLiveRoom,您可以在TRTCLiveRoom.java 文件中看到该组件提供的接口函数,并使用对应接口实现自定义 UI 界面。

    步骤1:集成 SDK

    视频互动直播组件 TRTCLiveRoom 依赖 TRTC SDK 和 IM SDK,您可以按照如下步骤将两个 SDK 集成到项目中。

    方法一:通过 Maven 仓库依赖

    1. 在 dependencies 中添加 TRTCSDK 和 IMSDK 的依赖。
      dependencies {
      compile "com.tencent.liteav:LiteAVSDK_TRTC:latest.release"
      compile 'com.tencent.imsdk:imsdk:latest.release'
      }
      >?两个 SDK 的最新版本号,可以在 [TRTC](https://github.com/tencentyun/TRTCSDK) 和 [IM](https://github.com/tencentyun/TIMSDK) 的 Github 首页获取。
    2. 在 defaultConfig 中,指定 App 使用的 CPU 架构。
      defaultConfig {
      ndk {
      abiFilters "armeabi-v7a"
      }
      }
    3. 单击【Sync Now】,自动下载 SDK 并集成到工程里。

    方法二:通过本地 AAR 依赖
    若您的开发环境访问 maven 仓库较慢,您可以直接下载 ZIP 包,并按照集成文档手动集成到您的工程中。

    SDK 下载页面 集成指引
    TRTC SDK DOWNLOAD 集成文档
    IM SDK DOWNLOAD 集成文档

    步骤2:配置权限及混淆规则

    在 AndroidManifest.xml 中配置 App 的权限,SDK 需要以下权限(6.0以上的 Android 系统需要动态申请相机、读取存储权限):

    <uses-permission android:name="android.permission.INTERNET">
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE">
    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE">
    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE">
    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE">
    <uses-permission android:name="android.permission.RECORD_AUDIO">
    <uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS">
    <uses-permission android:name="android.permission.BLUETOOTH">
    <uses-permission android:name="android.permission.CAMERA">
    <uses-permission android:name="android.permission.READ_PHONE_STATE">
    <uses-feature android:name="android.hardware.camera">
    <uses-feature android:name="android.hardware.camera.autofocus">

    在 proguard-rules.pro 文件,将 SDK 相关类加入不混淆名单:

    -keep class com.tencent.** { *; }

    步骤3:导入 TRTCLiveRoom 组件

    拷贝以下目录中的所有文件到您的项目中:

    src/main/java/com/tencent/liteav/liveroom/model

    步骤4:创建并登录组件

    1. 调用 sharedInstance 接口可以创建一个 TRTCLiveRoom 组件的实例对象。
    2. 创建一个 TRTCLiveRoomConfig 对象,该对象可以设置 useCDNFirst 和 CDNPlayDomain 属性:
      • useCDNFirst 属性:用于设置观众观看方式。true 表示普通观众通过 CDN 观看,计费便宜但延时较高。false 表示普通观众通过低延时观看,计费价格介于 CDN 和连麦之间,但延迟可控制在1s以内。
      • CDNPlayDomain 属性:在 useCDNFirst 设置为 true 时才会生效,用于指定 CDN 观看的播放域名,您可以登录直播控制台 >【域名管理】页面中进行设置。
    3. 调用 login 函数完成组件的登录,请参考下表填写关键参数:
      参数名 作用
      sdkAppId 您可以在 实时音视频控制台 中查看 SDKAppID。
      userId 当前用户的 ID,字符串类型,只允许包含英文字母(a-z、A-Z)、数字(0-9)、连词符(-)和下划线(_)。
      userSig 腾讯云设计的一种安全保护签名,获取方式请参考 如何计算 UserSig
      config 全局配置信息,请在登录时初始化,登录之后不可变更。
      • useCDNFirst 属性:用于设置观众观看方式。true 表示普通观众通过 CDN 观看,计费便宜但延时较高。false 表示普通观众通过低延时观看,计费价格介于 CDN 和连麦之间,但延迟可控制在1s以内。
      • CDNPlayDomain 属性:在 useCDNFirst 设置为 true 时才会生效,用于指定 CDN 观看的播放域名,您可以登录直播控制台 >【域名管理】页面中进行设置。
      callback 登录回调,成功时 code 为0。
      TRTCLiveRoom mLiveRoom = TRTCLiveRoom.sharedInstance(this);
      //useCDNFirst:true 表示普通观众通过 CDN 观看,false 表示普通观众通过低延时观看
      //yourCDNPlayDomain:表示 CDN 观看时配置的播放域名
      TRTCLiveRoomDef.TRTCLiveRoomConfig config =
      new TRTCLiveRoomDef.TRTCLiveRoomConfig(useCDNFirst, yourCDNPlayDomain);
      mLiveRoom.login(SDKAPPID, userId, userSig, config,
      new TRTCLiveRoomCallback.ActionCallback() {
      @Override
      public void onCallback(int code, String msg) {
      if (code == 0)
      {
      //登录成功
      }
      }
      });

    步骤5:主播端开播

    1. 主播执行 步骤4 登录后,可以调用 setSelfProfile 设置自己的昵称和头像。
    2. 主播在开播前可先调用 startCameraPreview 开启摄像头预览,界面上可以配置美颜调节按钮调用,通过 getBeautyManager 进行美颜设置。
      说明:

      非企业版 SDK 不支持变脸和贴图挂件等高级美颜功能。

    3. 主播调整美颜效果后,可以调用 createRoom 创建新的直播间。
    4. 主播调用 startPublish 开始推流。如需支持 CDN 观看,请在 login 时传入的 TRTCLiveRoomConfig 参数中指定 useCDNFirstCDNPlayDomain 并在 startPublish 时指定直播拉流用的 streamID。

    // 1.主播设置昵称和头像
    mLiveRoom.setSelfProfile("A", "your_face_url", null);

    // 2.主播开播前预览并设置美颜参数
    TXCloudVideoView view = new TXCloudVideoView(context);
    parentView.add(view);
    mLiveRoom.startCameraPreview(true, view, null);
    mLiveRoom.getBeautyManager().setBeautyStyle(1);
    mLiveRoom.getBeautyManager().setBeautyLevel(6);

    // 3.主播创建房间
    TRTCLiveRoomDef.TRTCCreateRoomParam param = new TRTCLiveRoomDef.TRTCCreateRoomParam();
    param.roomName = "测试房间";
    mLiveRoom.createRoom(123456789, param, new TRTCLiveRoomCallback.ActionCallback() {
    @Override
    public void onCallback(int code, String msg) {
    if (code == 0)
    {
    // 4.主播开启推流并将流发布到 CDN
    mLiveRoom.startPublish(mSelfUserId + "_stream", null);
    }
    }
    });

    步骤6:观众端观看

    1. 观众端执行 步骤4 登录后,可以调用 setSelfProfile 设置自己的昵称和头像。
    2. 观众端向业务后台获取最新的直播房间列表。
      说明:

      App 中的直播间列表仅做演示使用,直播间列表的业务逻辑千差万别,腾讯云暂不提供直播间列表的管理服务,请自行管理您的直播间列表。

    3. 观众端调用 getRoomInfos 获取房间的详细信息,该信息是在主播端调用 createRoom 创建直播间时设置的简单描述信息。
      注意:

      如果您的直播间列表包含了足够全面的信息,可跳过调用getRoomInfos相关步骤。

    4. 观众选择一个直播间,调用 enterRoom并传入房间号即可进入该房间。
    5. 调用 startPlay 并传入主播的 userId 开始播放。
      • 若直播间列表已包含主播端的 userId 信息,观众端可直接调用 startPlay 并传入主播的 userId 即可开始播放。
      • 若在进房前暂未获取主播的 userId,观众端在进房后会收到主播 onAnchorEnter 的事件回调,该回调中携带主播的 userId 信息,调用 startPlay 即可播放。

    // 1.假定您从业务后台获取房间列表为 roomList
    List<integer> roomList = GetRoomList();

    // 2.通过调用 getRoomInfos 获取房间的详细信息
    mLiveRoom.getRoomInfos(roomList, new TRTCLiveRoomCallback.RoomInfoCallback() {
    @Override
    public void onCallback(int code, String msg, List<trtcliveroomdef.trtcliveroominfo> list) {
    if (code == 0)
    {
    // 获取到房间详细信息后,您可以在主播列表页面展示主播昵称、头像等相关信息
    }
    }
    })

    // 3.选择房间 roomid 进入
    mLiveRoom.enterRoom(roomid, null);

    // 4.观众收到主播进房通知,开始播放
    mLiveRoom.setDelegate(new TRTCLiveRoomDelegate() {
    @Override
    public void onAnchorEnter(final String userId) {
    // 5.观众播放主播画面
    mLiveRoom.startPlay(userId, mTXCloudVideoView, null);
    }
    });

    步骤7:观众与主播连麦

    1. 观众端调用 requestJoinAnchor 向主播端发起连麦请求。
    2. 主播端会收到 TRTCLiveRoomDelegate#onRequestJoinAnchor(即有观众请求与您连麦)的事件通知。
    3. 主播端可以通过调用 responseJoinAnchor 决定是否接受来自观众端的连麦请求。
    4. 观众端会收到 TRTCLiveRoomDelegate#responseCallback 事件通知,该通知会携带来自主播端的处理结果。
    5. 如果主播同意连麦请求,观众端可调用 startCameraPreview 开启本地摄像头,随后调用 startPublish 启动观众端的推流。
    6. 主播端会在观众端启动通知后收到 TRTCLiveRoomDelegate#onAnchorEnter (即另一路音视频流已到来)通知,该通知会携带观众端的 userId。
    7. 主播端调用 startPlay 即可看到连麦观众的画面。

    // 1.观众端发起连麦请求
    mLiveRoom.requestJoinAnchor(mSelfUserId + "请求和您连麦",
    new TRTCLiveRoomCallback.ActionCallback() {
    @Override
    public void onCallback(int code, String msg) {
    if (code == 0)
    {
    // 4.主播接受了观众的请求
    TXCloudVideoView view = new TXCloudVideoView(context);
    parentView.add(view);
    // 5.观众启动预览,开启推流
    mLiveRoom.startCameraPreview(true, view, null);
    mLiveRoom.startPublish(mSelfUserId + "_stream", null);
    }
    }
    });

    // 2.主播端收到连麦请求
    mLiveRoom.setDelegate(new TRTCLiveRoomDelegate() {
    @Override
    public void onRequestJoinAnchor(final TRTCLiveRoomDef.TRTCLiveUserInfo userInfo,
    String reason, final int timeout)
    {
    // 3.同意对方的连麦请求
    mLiveRoom.responseJoinAnchor(userInfo.userId, true, "同意连麦");
    }

    @Override
    public void onAnchorEnter(final String userId) {
    // 6.主播收到连麦观众的上麦通知
    TXCloudVideoView view = new TXCloudVideoView(context);
    parentView.add(view);
    // 7.主播播放观众画面
    mLiveRoom.startPlay(userId, view, null);
    }
    });

    步骤8:主播与主播 PK

    1. 主播 A 调用 requestRoomPK 向主播 B 发起 PK 请求。
    2. 主播 B 会收到 TRTCLiveRoomDelegate onRequestRoomPK回调通知。
    3. 主播 B 调用 responseRoomPK 决定是否接受主播 A 的 PK 请求。
    4. 主播 B 接受主播 A 的要求,等待 TRTCLiveRoomDelegate onAnchorEnter通知,调用 startPlay 显示主播 A。
    5. 主播 A 收到 responseCallback 回调通知,PK 请求是否被同意。
    6. 主播 A 请求被同意,等待 TRTCLiveRoomDelegate onAnchorEnter 通知,调用 startPlay 显示主播 B。

    // 主播 A:
    // 主播 A 创建12345的房间
    mLiveRoom.createRoom(12345, param, null);

    mLiveRoom.setDelegate(new TRTCLiveRoomDelegate() {
    @Override
    public void onAnchorEnter(final String userId) {
    // 6.收到 B 进房的通知
    mLiveRoom.startPlay(userId, mTXCloudVideoView, null);
    }
    });

    // 1.主播 A 向主播 B 发起 PK 请求
    mLiveRoom.requestRoomPK(54321, "B",
    new TRTCLiveRoomCallback.ActionCallback() {
    @Override
    public void onCallback(int code, String msg) {
    // 5.收到是否同意的回调
    if (code == 0) {
    // 用户接受
    } else {
    // 用户拒绝
    }
    }
    });

    // 主播 B:
    // 主播 B 创建54321的房间
    mLiveRoom.createRoom(54321, param, null);

    // 2.主播 B 收到主播 A 的消息
    mLiveRoom.setDelegate(new TRTCLiveRoomDelegate() {
    @Override
    public void onRequestRoomPK(
    final TRTCLiveRoomDef.TRTCLiveUserInfo userInfo, final int timeout)
    {
    // 3.主播 B 回复主播 A 接受请求
    mLiveRoom.responseRoomPK(userInfo.userId, true, "");
    }
    @Override
    public void onAnchorEnter(final String userId) {
    // 4.主播 B 收到主播 A 进房的通知,播放主播 A 的画面
    mLiveRoom.startPlay(userId, mTXCloudVideoView, null);
    }
    });

    步骤9:实现文字聊天和弹幕消息

    • 通过 sendRoomTextMsg 可以发送普通的文本消息,所有在该房间内的主播和观众均可以收到 onRecvRoomTextMsg 回调。
      即时通信 IM 后台有默认的敏感词过滤规则,被判定为敏感词的文本消息不会被云端转发。
      // 发送端:发送文本消息
      mLiveRoom.sendRoomTextMsg("Hello Word!", null);
      // 接收端:监听文本消息
      mLiveRoom.setDelegate(new TRTCLiveRoomDelegate() {
      @Override
      public void onRecvRoomTextMsg(String roomId,
      String message, TRTCLiveRoomDef.TRTCLiveUserInfo userInfo)
      {
      Log.d(TAG, "收到来自" + userInfo.userName + "的消息:" + message);
      }
      });
    • 通过 sendRoomCustomMsg 可以发送自定义(信令)的消息,所有在该房间内的主播和观众均可以收到 onRecvRoomCustomMsg 回调。
      自定义消息常用于传输自定义信令,例如用于点赞消息的发送和广播。
      // eg:"CMD_DANMU"表示弹幕消息,"CMD_LIKE"表示点赞消息
      mLiveRoom.sendRoomCustomMsg("CMD_DANMU", "Hello world", null);
      mLiveRoom.sendRoomCustomMsg("CMD_LIKE", "", null);
      // 接收端:监听自定义消息
      mLiveRoom.setDelegate(new TRTCLiveRoomDelegate() {
      @Override
      public void onRecvRoomCustomMsg(String roomId, String cmd,
      String message, TRTCLiveRoomDef.TRTCLiveUserInfo userInfo) {
      if ("CMD_DANMU".equals(cmd)) {
      // 收到弹幕消息
      Log.d(TAG, "收到来自" + userInfo.userName + "的弹幕消息:" + message);
      } else if ("CMD_LIKE".equals(cmd)) {
      // 收到点赞消息
      Log.d(TAG, userInfo.userName + "给您点了个赞!");
      }
      }
      });