文档中心
媒体流加速（原实时码流加速）
Agora.io 社区
中文
search-icon
快速跑通示例项目
更新时间 2021/09/24 04:31:53

声网提供了一个简单的示例项目 hello_rtsa.c 用于演示推流和拉流的基本功能。该示例项目位于 RTSA Lite SDK 包 example 目录中。

你可以先编译并运行 hello_rtsa.c 体验推拉流，初步了解 RTSA Lite SDK 的 API 调用，以便后续能够更高效地将 RTSA Lite 集成到你自己的应用程序中。

开发环境准备

  • 一台装有 Ubuntu 16.04 或 18.04 的 PC，可以是虚拟机。用于编译和运行示例代码进行推流。
  • 一台真实 Android 设备。用于实时接收和播放音视频流。
  • 下载 RTSA Lite SDK 包。

操作步骤

1. 创建 Agora 账号并获取 App ID

在编译和运行示例项目前，你首先需要通过以下步骤获取 Agora App ID:

  1. 创建一个有效的 Agora 账号。
  2. 登录 Agora 控制台，点击左侧导航栏项目管理按钮进入项目管理页面。
  3. 在项目管理页面，点击创建按钮。在弹出的对话框内输入项目名称，选择鉴权机制为 App ID。点击提交，新建的项目就会显示在项目管理页中。Agora 会给每个项目自动分配一个 App ID 作为项目唯一标识。复制并保存此项目的 App ID ，稍后激活 License 和启动应用时会用到 App ID。

2. 获取 Agora 的客户 ID 和客户密钥

由于该示例项目需要使用 Agora RESTful API，因此你需要进行 HTTP 基本认证。你需要获取 Agora 提供的客户 ID 和客户密钥。

  1. 登录 Agora 控制台，点击页面右上角的用户名，在下拉列表中打开 RESTful API 页面。
  2. 点击添加密钥按钮。在下方的页面中会生成新的客户 ID 和客户密钥，在右边的操作栏点击提交按钮。
  3. 页面显示创建成功提示信息后，在相应的客户密钥栏点击下载按钮。
  4. 保存下载下来的 key_and_secret.txt ，里面包含客户 ID 和客户密钥。

3. 编译示例项目

在 SDK 包 example 目录下运行以下命令编译示例项目。

./build.sh

如果你需要在设备端（通常是 ARM Linux 系统）运行 hello_rtsa，请先参考 SDK 包中的交叉编译指南（cross_compile.zh.md 文件）。

编译完成后，会在当前目录下生成以下可执行文件：

  • hello_rtsa: 详见运行示例项目。
  • license_query: 运行 ./license_query 命令查看 License 具体信息。其中，license_key 稍后激活 License 时需要用到。
  • license_activator: 详见激活 License。

自 v1.4.2 起，SDK 下载包中包含了许可证文件，因此你无需购买商用 License 即可直接试用 RTSA Lite SDK。试用时效为 90 天且存在 10 路并发限制。 如果你需要购买商用 License，请联系 sales@agora.io 。

4. (可选) 激活商用 License

如果你使用 SDK 包自带的许可证文件进行免费体验，可跳过此步骤。

  1. 如果你已经购买了商用 License，可以先通过 license_query 查询你的 App ID 下的所有 License key。

     $ ./license_query  --appId YOUR_APPID  --customerKey YOUR_KEY --customerSecret YOUR_SECRET

    其中：

    • 参数 YOUR_APPID 需要替换为你创建的 App ID。
    • 参数 YOUR_KEY 需要替换为你刚才保存的 key_and_secret.txt 文件里的 key 值。
    • 参数 YOUR_SECRET 需要替换为你刚才保存的 key_and_secret.txt 文件里的 secret 值。

  2. 运行以下命令激活 License，生成对应的证书。

     $ ./license_activator --appId YOUR_APPID --customerKey YOUR_KEY --customerSecret YOUR_SECRET --licenseKey YOUR_LICENSE --certOutputDir .

    其中：

    • 参数 YOUR_APPID 需要替换为你创建的 App ID。
    • 参数 YOUR_KEY 需要替换为你刚才保存的 key_and_secret.txt 文件里的 key 值。
    • 参数 YOUR_SECRET 需要替换为你刚才保存的 key_and_secret.txt 文件里的 secret 值。
    • 参数 YOUR_LICENSE 需要替换为你购买的商用 license 序列号。

激活成功后，默认在当前目录生成 certificate.bin , 它是和这个设备绑定的 License 证书。hello_rtsa 运行时会加载这个文件，并在初始化 SDK 之前通过 agora_rtc_license_verify 接口调用来验证 License 证书的有效性。只有通过验证，SDK 才可以正常运行。

设备在每次运行 RTSA Lite SDK 前，都需要调用agora_rtc_license_verify 方法来验证 License 证书的有效性。只有通过验证，SDK 初始化才能够成功。

5. 运行示例项目

你可通过以下命令行，把 YOUR_APP_ID 替换称你在第一步中获取到的 App ID，加入名为 hello_demo 的频道，并且用默认参数发送 H.264 视频和 PCM 音频。音视频源默认为 SDK 包自带的 send_audio_16k_1ch.pcm 和 send_video.h264 文件。

$ ./hello_rtsa -i YOUR_APP_ID -c hello_demo

如你想进行更多体验，可参考下列参数介绍自行调试。

参数 示例
-h, --help 打印帮助信息。
-i, --appId 你的 App ID。无默认值，必填。
-t, --token 你的 RTC Token。默认值为空字符串。生成方法详见生成 Token。
-c, --channelId 频道名。无默认值，必填。
-u, --userId 用户 ID。默认值为 0，代表 SDK 随机指定。
-a, --audioFile 待推流的音频文件路径。默认值为 ./send_audio_16k_1ch.pcm。
-v, --videoFile 待推流的视频文件路径。默认值为 ./send_video.h264。
-A, --audioCodec 推流的音频编码格式，默认值为 100。
  • 1: OPUS
  • 5: G722
  • 8: AACLC
  • 9: HEAAC
  • 100: PCM
    		•
    -V, --videoCodec 推流的视频编码格式, 默认值为 2。
  • 2: H.264
  • 6: GENERIC
    		•
    -f --fps 推流的视频帧率，默认值为 25。
    -l, --sdkLogDir 存放 SDK 日志的目录，默认值为当前目录。

    6. 观看推流效果

    你可以打开 Webdemo 链接，输入你的 App ID 和频道名 hello_demo，成功加入频道后，你就可以看到和听到实时音视频流了。

    7. (可选) 运行 OpenLive 拉流播放

    如需体验完整的推拉流效果，你可以在 Android 真机上安装一个 Agora 提供的 OpenLive 应用，作为收流端来实时观看效果。

    1. 选择以下方法之一来安装 OpenLive：
    2. 运行 OpenLive，输入频道名 hello_channel，并以 AUDIENCE 身份加入该频道。

    如果是预编译版，你还需要输入 App ID。

    成功加入频道后，你就可以在 Android 上播放来自 Linux 推流端的音频和视频流了。