文档反馈
文档反馈

实现互动直播(Android)

网易云信互动直播产品的基本功能包括音视频通话和连麦直播,当您成功初始化 SDK 之后,您可以简单体验本产品的基本业务流程,例如主播加入房间、观众 CDN 拉流、连麦者上下麦、结束直播等。本文档为您展示互动直播提供的基本业务流程。

前提条件

请确认您已完成以下操作:

主播加入房间

1. 导入类

在您的工程中对应的 Activity 文件里添加如下代码先导入以下重要类:

  import com.netease.lava.nertc.sdk.NERtcCallbackEx;
  import com.netease.lava.nertc.sdk.NERtcConstants;
  import com.netease.lava.nertc.sdk.NERtcEx;
  import com.netease.lava.nertc.sdk.NERtcParameters;
  import com.netease.lava.nertc.sdk.video.NERtcRemoteVideoStreamType;
  import com.netease.lava.nertc.sdk.video.NERtcVideoView;

2. 初始化

默认情况下,请先执行 init 方法完成初始化。

  // 示例
  private void initializeSDK() {
        try {
            NERtcEx.getInstance().init(getApplicationContext(),Config.APP_KEY,callback,null);
        } catch (Exception e) {
            showToast("SDK初始化失败");
            finish();
            ...
            return;
        }
        ...
  }

3. 设置本地视图(可选)

初始化成功后,可以设置设置本地视图,来预览本地图像。您可以在加入房间之前预览,或在加入房间后预览。

4. 设置直播模式

在互动直播的场景中,建议在加入房间前,通过 setChannelProfile 接口设置房间模式为直播模式。当前默认为通信模式。

  // 示例
  // 0 - COMMUNICATION(通信模式),  1 - LIVE_BROADCASTING(直播模式)
  NERtcEx.getInstance().setChannelProfile(1);

5. 设置推流开关

为了将多媒体流推往 CDN,还需要在初始化前设置推流开关,这样拉流的观众可以拉取到该用户对应的音视频流。

通过 NERtcParametersKEY_PUBLISH_SELF_STREAM 设置推流开关。

  // 示例
  NERtcParameters mRtcParameters = new NERtcParameters();
  mRtcParameters.set(NERtcParameters.KEY_PUBLISH_SELF_STREAM, true);
  NERtcEx.getInstance().setParameters(mRtcParameters); 

6. 加入房间

加入房间前,请确保已完成初始化相关事项。若您的业务中涉及呼叫邀请等机制,建议通过信令实现。

通过 joinChannel 方法加入房间。

  // 示例
  NERtcEx.getInstance().joinChannel(token,channelName,uid);

参数说明

参数 说明
token 安全认证签名(NERTC Token)。可设置为:
  • null。非安全模式下可设置为 null。安全性不高,建议在产品正式上线前联系对应商务经理转为安全模式。
  • 已获取的NERTC Token。安全模式下必须设置为获取到的 Token 。若未传入正确的 Token 将无法进入房间。

    推荐使用安全模式。

channelName 房间名称,设置相同房间名称的用户会进入同一个通话房间。
注意:您也可以在加入通道前,通过创建房间接口创建房间。加入房间时,若传入的 {channelName} 未事先创建,则云信服务器内部将为其自动创建一个名为 {channelName} 的通话房间。
uid 用户的唯一标识 id,房间内每个用户的 uid 必须是唯一的。

SDK发起加入房间请求后,服务器会进行响应,开发者可以通过 NERtcCallbackonJoinChannel 回调监听加入房间的结果,同时该回调会抛出当前通话房间的 channelId 与加入房间总耗时(毫秒)。

注意:请在初始化方法中传入原型为 NERtcCallback / NERtcCallbackExcallback

7. 推流任务管理

在成功加入房间后,需要设置推流任务来将通话房间内的多媒体数据推至 CDN。典型的业务场景里是由主播进行设置推流任务。推流任务也可以通过 服务端API 进行管理,请根据您的业务需求选择合适的方式。

注意

增加推流任务

音视频房间中默认没有推流任务,您需要在启动直播前通过 addLiveStreamTask 方法增加推流任务。

      // 示例
      // 初始化推流任务
      NERtcLiveStreamTaskInfo liveTask1 = new NERtcLiveStreamTaskInfo();
      //taskID 可选字母、数字,下划线,不超过64位
      liveTask1.taskId = String.valueOf(Math.abs(pushUlr.hashCode()));
      // 设置推互动直播推流地址,一个推流任务对应一个推流房间
      liveTask1.url = pushUlr;
      // 设置是否进行互动直播录制,请注意与音视频通话录制区分。
      liveTask1.serverRecordEnabled = false;
      // 设置推音视频流还是纯音频流
      liveTask1.liveMode = enableVideo? NERtcLiveStreamTaskInfo.NERtcLiveStreamMode.kNERtcLsModeVideo : NERtcLiveStreamTaskInfo.NERtcLiveStreamMode.kNERtcLsModeAudio;

      //设置整体布局
      NERtcLiveStreamLayout layout = new NERtcLiveStreamLayout();
      layout.userTranscodingList = new ArrayList<>();
      layout.width = 720;//整体布局宽度
      layout.height = 1280;//整体布局高度
      layout.backgroundColor = Color.parseColor("#3399ff"); // 整体背景色
      liveTask1.layout = layout;

      // 设置直播成员布局
      NERtcLiveStreamUserTranscoding user1 = new NERtcLiveStreamUserTranscoding();
      user1.uid = uid1; // 用户id
      user1.audioPush = true; // 推流是否发布user1 的音频
      user1.videoPush = enableVideo; // 推流是否发布user1的视频
      if (user1.videoPush) {// 如果发布视频,需要设置一下视频布局参数
          // user1 视频的缩放模式, 详情参考NERtcLiveStreamUserTranscoding 的API 文档
          user1.adaption = NERtcLiveStreamUserTranscoding.NERtcLiveStreamVideoScaleMode.kNERtcLsModeVideoScaleCropFill;
          user1.x = 10; // user1 的视频布局x偏移,相对整体布局的左上角
          user1.y = 10; // user1 的视频布局y偏移,相对整体布局的左上角
          user1.width = 180; // user1 的视频布局宽度
          user1.height = 320; //user1 的视频布局高度
      }

      layout.userTranscodingList.add(user1);

      ...
      // 设置第n位直播成员布局
      NERtcLiveStreamUserTranscoding usern = new NERtcLiveStreamUserTranscoding();
      usern.uid = uidn;
      usern.audioPush = true;
      usern.videoPush = enableVideo;
      if (usern.videoPush) {
              usern.adaption = NERtcLiveStreamUserTranscoding.NERtcLiveStreamVideoScaleMode.kNERtcLsModeVideoScaleCropFill;
              usern.x = user1.x + user1.width + 10;
              usern.y = user1.y + user1.height + 10;
              usern.width = 320;
              usern.height = 640;
          }
      layout.userTranscodingList.add(usern);

      // 调用 addLiveStreamTask 接口添加推流任务
      int ret = NERtcEx.getInstance().addLiveStreamTask(liveTask1, addLiveTaskCallback);
      if (ret != 0) {
              showToast("调用添加推流任务接口执行失败 , ret : " + ret);
          }

      // 添加推流任务的异步callback
      private AddLiveTaskCallback addLiveTaskCallback = new AddLiveTaskCallback(){
        void onAddLiveStreamTask(String taskId, int errCode){
          if (code == RtcCode.LiveCode.OK) {
                  showToast("添加推流任务成功 : taskId " + taskId);
              } else {
                  showToast("添加推流任务失败 : taskId " + taskId + " , code : " + code);
              }
          }
      };

更新推流任务

当音视频通话房间内有人员进出或其他情况时,可以使用 updateLiveStreamTask 方法更新推流任务。更新推流任务时,会覆盖之前对于这条推流任务的所有配置。

      // 示例
      // 初始化新推流任务。注意:其中的taskid为原推流任务id。
      NERtcLiveStreamTaskInfo updateLiveTask1 = preLiveTask;
      ...
      // 更新推流任务
      int ret = NERtcEx.getInstance().updateLiveStreamTask(updateLiveTask1 , updateLiveTaskCallback);
      if (ret != 0) {
          showToast("调用更新推流任务接口执行失败 , ret : " + ret);
      }
      // 更新推流任务的异步callback
      private UpdateLiveTaskCallback updateLiveTaskCallback = new UpdateLiveTaskCallback() {
          @Override
          public void onUpdateLiveStreamTask(String taskId, int errCode) {
              if (code == RtcCode.LiveCode.OK) {
                  showToast("更新推流任务成功 : taskId " + taskId);
              } else {
                  showToast("更新推流任务失败 : taskId " + taskId + " , code : " + code);
              }
          }
      };

删除推流任务

当本场互动直播准备结束时,可以通过 removeLiveStreamTask 方法主动删除推流任务。

      // 示例
      int ret = NERtcEx.getInstance().removeLiveStreamTask(preLiveTask.taskId,deleteLiveTaskCallback );
      if (ret != 0) {
          showToast("调用删除推流任务接口执行失败 : ret : " + ret);
      }
      // 删除推流任务的异步callback
      private DeleteLiveTaskCallback deleteLiveTaskCallback = new DeleteLiveTaskCallback() {
          @Override
          public void onDeleteLiveStreamTask(String taskId, int errCode) {
              if (code == RtcCode.LiveCode.OK) {
                  showToast("删除推流任务成功 : taskId " + taskId);
              } else {
                  showToast("删除推流任务失败 : taskId " + taskId + " , code : " + code);
              }
          }
      };

推流任务相关错误码

增加、更新与删除推流任务时,如果发生错误,callback 回调通过错误码形式反馈错误原因。错误码 RtcCode.LiveCode 如下:

错误码 含义
OK = 0 成功
TASK_REQUEST_INVALID = 1301 task请求无效,被后续操作覆盖
TASK_IS_INVALID = 1400 task参数格式错误
TASK_ROOM_EXITED = 1401 已经退出房间
TASK_NUM_LIMIT = 1402 推流任务超出上限
TASK_DUPLICATE_ID = 1403 推流ID重复
TASK_NOT_FOUND = 1404 taskId任务不存在,或房间不存在
TASK_REQUEST_ERR = 1417 请求失败
TASK_INTERNAL_SERVER_ERR = 1500 服务器内部错误
TASK_INVALID_LAYOUT = 1501 布局参数错误
TASK_USER_PIC_ERR = 1502 用户图片错误

互动直播推流状态

主播或连麦者参与互动直播的过程中,可以通过 NERtcCallbackonLiveStreamState 来监听推流状态。

常见的推流状态如下:

状态码 含义
NERtcConstants.LiveStreamState.STATE_PUSHING = 505 推流中
NERtcConstants.LiveStreamState.STATE_PUSH_FAIL = 506 互动直播推流失败
NERtcConstants.LiveStreamState.STATE_PUSH_STOPPED = 511 推流结束
NERtcConstants.LiveStreamState.STATE_IMAGE_ERROR = 512 背景图片设置出错

8. 设置远端视图

互动直播过程中,除了要显示本地的视频画面,通常也要显示参与互动的其他连麦者/主播的远端视频画面。

  1. NERtcCallback 通过以下回调获取相关信息:

    • onUserJoined :监听远端用户加入通话房间的事件,并抛出对方的 uid。当本端加入房间后,也会通过此回调抛出通话房间内已有的其他用户。

    • onUserVideoStart :监听远端用户发布视频流的事件,回调中携带对方的 uid 与发布的视频分辨率。

  2. 在监听到远端用户加入房间或发布视频流后,本方可以通过 setupRemoteVideoCanvas 方法设置远端用户视频画布,用于显示其视频画面。

       // 示例
       NERtcVideoView remoteView = (NERtcVideoView)findViewById(R.id.remote_view);
       NERtcEx.getInstance().setupRemoteVideoCanvas(remoteView,uid);
  3. 在监听到远端用户发布视频流后,本方可以通过 subscribeRemoteVideoStream 方法对其发起视频流的订阅,来将对方的视频流渲染到视频画布上。

       NERtcEx.getInstance().subscribeRemoteVideoStream(uid, profile, subscribe);

9. 音频流

本地音频的采集发布和远端音频订阅播放是默认启动的,正常情况下无需开发者主动干预。

观众进行 CDN 拉流

当通话房间内有主播/连麦者发布多媒体流,且正确设置了推流任务时,通话房间外的观众可以通过 CDN 直播拉流地址进行拉流播放。云信同时提供播放器 SDK 供您使用,详细内容请参考 直播 - 播放器SDK

连麦者上下麦

1. 上麦

若正在进行 CDN 拉流播放的普通观众要上麦参与互动时,必须先停止 CDN 拉流,并释放播放器相关资源。然后按照主播加入房间流程,进行初始化、设置本地视图、设置直播模式、设置推流开关、加入通话房间、设置远端视图。

注意

2. 下麦

若连麦者互动结束,需要下麦时,可以更新推流任务,在推流布局中剔除该连麦者。同时,连麦者退出通话房间,清理相关资源,重新进行播放器拉流或直接离开直播间。

通话房间内的其他用户可以通过 NERtcCallbackonUserLeave 来监听其他连麦者下麦。

结束互动直播

需要结束该场互动直播时,可以先删除推流任务,然后主播与连麦者退出通话房间,观众结束CDN拉流。

1. 退出通话房间

通过 leaveChannel() 接口退出通话房间。

  // 示例
  // 退出通话房间
  NERtcEx.getInstance().leaveChannel();

NERtcCallback 提供 onLeaveChannel 来监听当前用户退出房间的结果。

2. 销毁实例

当确定 App 短期内不再使用音视频通话实例时,可以通过 release() 接口释放对应的对象资源。

  // 示例
  // 销毁实例
  NERtcEx.getInstance().release();
×

反馈成功

非常感谢您的反馈,我们会继续努力做得更好。