文档中心 > 移动直播 SDK > 小直播 App > 本地快速跑通“小直播”

本地快速跑通“小直播”

最近更新时间:2021-11-25 20:15:34

小直播简介

小直播 App 是一套开源的、完整的在线直播解决方案,它基于云直播服务、即时通信(IM)构建,并使用云函数(Serverless)提供标准的后台服务,可以实现登录、注册、开播、房间列表、连麦互动、文字互动和弹幕消息等功能。

前后端架构说明

快速搭建自己的“小直播”

步骤1:开通云直播相关服务

  1. 开通云直播服务:
    登录腾讯云官网,进入 云直播管理控制台,如果服务还没有开通,单击申请开通
  2. 获取 SDK 的测试 License:
    1. 进入云直播管理控制台 > License 管理,单击创建应用并绑定License,创建应用所需要的鉴权 License。
    2. 创建成功后请记录 Key 和 licenseURL,便于在 运行小直播 App 时使用。
      说明:

      Package Name 为 Android 的包名,Bundle Id 为 iOS 的 Bundle Id。

  3. 创建 TRTC 应用:
    登录实时音视频控制台选择 应用管理,单击新建应用输入应用名称(例如 XiaoZhiBo),单击确定创建应用。在该应用的操作栏中,单击应用信息,进入应用管理页。
    • 进入功能配置页,开启旁路推流,并选择全局自动旁路:
    • 进入应用信息页,查看并记录应用的 SDKAppID
    • 进入应用信息>快速上手,查看并记录应用的 SECRETKEY
  4. 配置直播域名:
    按照相关政策要求,您需要在 云直播管理控制台 中添加自有的已备案域名,这样才能使用腾讯云直播的播放功能,请参见 域名管理CNAME 配置 进行配置。
说明:

最后总结一下,当这些步骤执行完成后,您需要记录如下信息为后续工程的配置做好准备:

  • License URL、License Key
  • SDKAppID、UserSig
  • PlayDomain

步骤2:搭建后台服务

基于 腾讯云云函数 环境,小直播提供了一套部署简单、定制性更加灵活的开源服务,只需要四步即刻快速跑通“小直播”后台程序:

  1. 下载源码:
    git clone https://github.com/TencentServerlessApps/live-room.git
    说明:

    您也可以直接进入我们的 GitHub 仓库 进行下载。

  2. 部署准备:
    • 开通 API 网关,通过 API 网关访问云函数,提供 HTTP API。
    • 开通 COS 存储,保存云函数代码用的。
    • 开通 SLS 日志服务,云函数保存日志用的。
    • 云函数授权,云函数访问其他云资源用的。
    • 安装云函数工具 serverless/sls,安装依赖库:
      npm install -g serverless@2.63.0
      npm install
      说明:

      • 若安装 SLS 有问题,请看官方说明文档 SLS 安装,有详细解决办法。
      • Node 安装方法请参见 Node.js,在 Windows 下请使用 Administrator 权限启动 Node.js command prompt,不支持 PowerShell。
  3. 开始部署服务:
    1. live-room 目录下,创建环境变量文件 .env,并输入如下内容:
      TRTC_TIM_APPID=xxxxxxxxxxxxxxxx  // 此处即上一章节中的记录的SDKAppID;
      TRTC_TIM_SECRET=xxxxxxxxxxxxxxxx // 此处即上一章节中的记录的SecretKey
    2. 创建成功后,启动发布,需要扫码授权或配置 本地密钥授权
      npm install
      sls deploy
      说明:

      Windows 用户,请使用 Administrator 权限启动 Node.js command prompt,否则扫码认证会失败。

  4. 检查服务是否部署成功:
    从发布日志中获取 API 网关地址,例如:https://service-xxxyyzzz-1001234567.gz.apigw.tencentcs.com,在浏览器中直接打开您的网关地址。如下图所示,即恭喜您,后台服务部署成功!
    注意:

    需要记录下此 URL,在小直播 App 的运行中配置到 GenerateGlobalConfig 文件下。

步骤3:运行“小直播”App

  1. 下载代码:
    git clone https://github.com/tencentyun/XiaoZhiBo
    说明:

    您也可以直接进入 小直播 GitHub 仓库 进行下载。

  2. 工程配置&运行:
    1. 使用 Android Studio(3.5及以上的版本)打开源码工程 XiaoZhiBo/Android
    2. 找到并打开 XiaoZhiBo/Android/debug/src/main/java/com/tencent/liteav/debug/GenerateGlobalConfig.java 文件,按照上述步骤中记录的关键信息,设置此文件中的相关参数:
      参数说明
      SERVERLESSURL默认为 PLACEHOLDER , 请设置为后台服务部署成功后记录下的URL,例如:https://service-xxxyyzzz-1001234567.gz.apigw.tencentcs.com
      LICENSEURL默认为 PLACEHOLDER ,请设置为实际的 License URL 信息
      LICENSEURLKEY默认为 PLACEHOLDER ,请设置为实际的 License Key 信息
      PLAY_DOMAIN默认为 PLACEHOLDER ,请设置为实际的拉流域名
    3. 修改 app 模块下的 build.gradle 文件中 applicationId 字段为 License 信息所对应的包名。
    4. 连上 Android 设备,编译并运行即可。
目录