RTC SDK API 示例

环境准备Copy Anchor Link

• Xcode 13.0+
• iOS 真机设备
• 不支持模拟器

运行示例程序Copy Anchor Link

安装依赖库Copy Anchor Link

切换到 iOS 目录，运行以下命令使用 CocoaPods 安装依赖，Agora 视频 SDK 会在安装后自动完成集成。

使用 CocoaPodsCopy Anchor Link

安装 CocoaPods

pod install

运行后确认 APIExample.xcworkspace 正常生成即可。

创建声网账号并获取 App IDCopy Anchor Link

在编译和启动示例程序前，你需要先获取一个可用的 App ID：

1. 在声网控制台创建开发者账号。
2. 在左侧导航栏中选择 项目 > 项目列表。
3. 复制项目的 App ID，稍后启动应用时需要使用。
4. 如果项目启用了 Token 鉴权，复制 App 证书，稍后将其赋值给 Certificate。
5. 打开 APIExample.xcworkspace 并编辑 KeyCenter.swift，将 App ID 和 App 证书分别替换到 <# YOUR APPID#> 与 <#YOUR Certificate#>。

    /**
     Agora 给应用程序开发人员分配 App ID，以识别项目和组织。如果组织中有多个完全分开的应用程序，例如由不同的团队构建，
     则应使用不同的 App ID。如果应用程序需要相互通信，则应使用同一个 App ID。
     进入声网控制台（https://console.shengwang.cn/），创建一个项目，进入项目配置页，即可看到 App ID。
   */
    static let AppId: String = <# YOUR APPID#>

    /**
     声网提供 App 证书用于生成 Token。你可以在服务器部署 Token 生成服务，或者使用控制台生成临时 Token。
     进入声网控制台（https://console.shengwang.cn/），创建一个启用证书鉴权的项目，进入项目配置页，即可看到 App 证书。
     注意：如果项目没有开启证书鉴权，这个字段留空。
    */
    static var Certificate: String? = <#YOUR Certificate#>

然后你就可以使用 APIExample.xcworkspace 编译并运行项目了。

开发者：上海声网科技有限公司

环境准备Copy Anchor Link

• Android Studio 3.0+
• Android 真机设备
• 支持模拟器

运行示例程序Copy Anchor Link

本节介绍如何编译和运行示例程序。

创建声网账号并获取 App IDCopy Anchor Link

在编译和启动示例程序前，你需要先获取一个可用的 App ID：

1. 在声网控制台创建开发者账号。
2. 在左侧导航栏中选择 项目 > 项目列表。
3. 复制项目的 App ID，稍后启动应用时需要使用。
4. 复制项目的 App 证书，稍后启动应用时需要使用。如果项目未启用证书鉴权，可跳过此步骤。
5. 打开 Android/APIExample 并编辑 app/src/main/res/values/string-configs.xml，将 App ID 和 App 证书分别替换为 YOUR APP ID 和 YOUR APP CERTIFICATE。

    // 声网 App ID。
    <string name="agora_app_id" translatable="false">YOUR APP ID</string>
    // 声网 App 证书。如果项目没有开启证书鉴权，这个字段留空。
    <string name="agora_app_certificate" translatable="false">YOUR APP CERTIFICATE</string>

然后你就可以编译并运行项目了。

美颜配置Copy Anchor Link

第三方美颜集成使用美颜场景化 API 库。

本项目包含第三方美颜集成示例。使用示例前，需要按以下说明配置美颜资源和证书。

商汤美颜Copy Anchor Link

1. 联系商汤技术支持，获取美颜 SDK 下载链接和证书。
2. 解压美颜 SDK，并将以下资源复制到对应路径。

相芯美颜Copy Anchor Link

1. 联系相芯技术支持，获取美颜资源和证书。
2. 将美颜资源和证书复制到对应路径。

字节美颜Copy Anchor Link

1. 联系字节技术支持，获取美颜 SDK 下载链接和证书。
2. 解压字节火山美颜资源，并将以下文件或目录复制到对应路径。

3. 在 app/src/main/java/io/agora/api/example/examples/advanced/beauty/ByteDanceBeauty.java 文件中，将 LICENSE_NAME 设置为申请到的证书文件名。

面向插件开发者Copy Anchor Link

自 RTC SDK 4.0.0 起，SDK 支持插件系统。本项目包含一个默认禁用的 SimpleFilter 示例。如需编译并运行该示例，请完成以下步骤：

1. 下载 OpenCV，解压后复制到 Android/APIExample/agora-simple-filter/src/main/jniLibs。
2. 手动下载声网视频 SDK，解压后将 C++ 动态库及架构文件夹复制到 Android/APIExample/agora-simple-filter/src/main/agoraLibs。

Android/APIExample/agora-simple-filter/src/main/agoraLibs
├── arm64-v8a
├── armeabi-v7a
├── x86
└── x86_64

3. 在 Android/APIExample/gradle.properties 文件中，将 simpleFilter 的值设置为 true。

自定义加密Copy Anchor Link

本项目包含自定义加密示例，默认是不启用的。配置方法如下：

1. 手动下载声网视频 SDK，解压后将 C++ 动态库及架构文件夹复制到 Android/APIExample/agora-stream-encrypt/src/main/agoraLibs。

Android/APIExample/agora-stream-encrypt/src/main/agoraLibs
├── arm64-v8a
├── armeabi-v7a
├── x86
└── x86_64

2. 在 Android/APIExample/gradle.properties 文件中，将 streamEncrypt 的值设置为 true。

开发者：上海声网科技有限公司

环境准备Copy Anchor Link

• Xcode 13.0+

运行示例程序Copy Anchor Link

本节介绍如何编译和运行示例程序。

安装依赖库Copy Anchor Link

切换到 macOS 目录，运行以下命令使用 CocoaPods 安装依赖，Agora 视频 SDK 会在安装后自动完成集成。

使用 CocoaPods

安装 CocoaPods

pod install

运行后确认 APIExample.xcworkspace 正常生成即可。

创建声网账号并获取 App IDCopy Anchor Link

在编译和启动示例程序前，你需要先获取一个可用的 App ID：

1. 在 声网控制台创建一个开发者账号

2. 前往后台页面，点击左部导航栏的 项目 > 项目列表 菜单

3. 复制后台的 App ID 并备注，稍后启动应用时会用到它

4. 如果开启了 Token，需要获取 App 证书并设置给 certificate

5. 打开 APIExample.xcworkspace 并编辑 KeyCenter.swift，将你的 App ID 和 App 证书分别替换到 <#Your APPID#> 与 <#YOUR Certificate#>

    /**
     Agora 给应用程序开发人员分配 App ID，以识别项目和组织。如果组织中有多个完全分开的应用程序，例如由不同的团队构建，
     则应使用不同的 App ID。如果应用程序需要相互通信，则应使用同一个 App ID。
     进入声网控制台（https://console.shengwang.cn/），创建一个项目，进入项目配置页，即可看到 App ID。
   */
    static let AppId: String = <# YOUR APPID#>

    /**
     声网提供 App 证书用于生成 Token。你可以在服务器部署 Token 生成服务，或者使用控制台生成临时 Token。
     进入声网控制台（https://console.shengwang.cn/），创建一个启用证书鉴权的项目，进入项目配置页，即可看到 App 证书。
     注意：如果项目没有开启证书鉴权，这个字段留空。
    */
    static var Certificate: String? = <#YOUR Certificate#>

然后你就可以使用 APIExample.xcworkspace 编译并运行项目了。

开发者：上海声网科技有限公司

本开源项目使用 C++ 语言

环境准备Copy Anchor Link

• Visual Studio 2013（或更高版本），默认支持 Visual Studio 2017。
• Windows 7（或更高版本）。

注意：使用其他版本需要自行修改该配置，编译 Release 版本还需要安装兼容 Windows XP 的相关插件。

运行示例程序Copy Anchor Link

本节介绍如何编译和运行示例程序。

创建声网账号并获取 App IDCopy Anchor Link

在编译和启动示例程序前，你需要先获取一个可用的 App ID：

1. 在 声网控制台创建一个开发者账号

2. 前往后台页面，点击左部导航栏的 项目 > 项目列表 菜单

3. 复制后台的 App ID 并备注，稍后启动应用时会用到它

4. 在项目页面生成临时 Access Token（24 小时内有效）并备注，注意生成的 Token 只能适用于对应的频道名。

5. 将 App ID 内容替换至 APP_ID 宏定义中

    #define APP_ID _T("Your App ID")
    #define APP_TOKEN _T("Your Token")

6. （可选）你也可以在 Debug/Release 目录下创建一个 AppId.ini 文件以配置应用程序的 App ID，并将 AppId 的值修改为刚才申请的 App ID。

    [AppID]
    AppID=xxxxxxxxxxxxxxxxxxx

编译项目Copy Anchor Link

这个开源示例项目使用了 Agora RTC SDK、DirectShow SDK、MediaPlayer SDK。

你可以通过直接运行 APIExample/installThirdParty.bat 来自动下载依赖并配置环境。配置完成后，使用 Visual Studio 2017 打开项目，选择 x86 版本进行编译即可运行。

基础场景Copy Anchor Link

直播互动Copy Anchor Link

• 切换角色
• 支持1v1，1v3, 1v8, 1v15
• 进出频道
• 显示本地和远端视频

进阶场景Copy Anchor Link

旁路推流Copy Anchor Link

• 加入频道后添加rtmp推流地址
• 移除推流地址
• 推流回调处理状态信息显示

插入媒体流Copy Anchor Link

• 加入频道后inject 媒体流
• 显示插入状态回调信息
• 插入成功，收到一个666加入回调。本地mute 666的视频和音频（也可以不mute）
• 移除插入流

视频MetaDataCopy Anchor Link

• 加入频道，发送视频流
• 发送视频SEI信息，最大1024B
• 接收视频SEI信息
• 清除SEI信息

共享屏幕Copy Anchor Link

• 进入频道，枚举所有可见窗口
• 选择一个可见窗口
• 录制屏幕
• 停止录制

美颜Copy Anchor Link

• 设置明暗对比等级
• 设置明亮度
• 设置红润度
• 设置平滑度

美声Copy Anchor Link

• 设置音效或者美声

音频设置Copy Anchor Link

• 设置音频参数
• 设置场景
• 设置频道内的音频设置

音频混合Copy Anchor Link

• 设置音频路径
• 设置播放次数
• 设置是否仅仅本地播放
• 设置是否替换麦克风音频

自定义摄像头采集Copy Anchor Link

• 摄像头采集使用DirectShow
• 枚举所有图像采集设备和类型
• 创建图像采集过滤器
• 开始采集摄像头数据
• SDK获取摄像头数据
• 停止采集摄像头数据

处理视频原始数据Copy Anchor Link

• 注册视频观察者
• 实现了对原始图像进行灰度处理，和模糊处理
• 在onCaptureVideoFrame中对视频帧进行处理

自定义音频采集Copy Anchor Link

• 音频采集使用DirectShow
• 枚举所有音频采集设备和类型
• 创建音频采集过滤器
• 开始采集麦克风数据
• SDK获取麦克风数据
• 停止采集麦克风数据

处理音频原始数据Copy Anchor Link

• 注册音频观察者
• 在onRecordAudioFrame中对音频帧进行处理

自定义媒体加密Copy Anchor Link

• 注册数据包观察者
• 在onSendAudioPacket中对音频流发送前进行加密
• 在onSendVideoPacket中对视频流发送前进行加密
• 在onReceiveAudioPacket中对音频流接收后进行解密
• 在onReceiveVideoPacket中对视频流接收后进行解密

媒体播放器组件Copy Anchor Link

• 使用 MediaPlayer Kit 打开、播放媒体。
• 使用 MediaPlayerExtensions 向 Agora RTC Engine 的频道推流。
• 使用 IMediaPlayerObserver 处理 MediaPlayer 的回调事件，例如打开、播放。

开发者：上海声网科技有限公司

示例项目（使用 jQuery 和 Bootstrap）Copy Anchor Link

如何运行示例项目Copy Anchor Link

前提条件Copy Anchor Link

• 你必须使用 SDK 支持的浏览器运行示例项目。关于支持的浏览器列表，参考浏览器兼容性和已知问题。

运行步骤Copy Anchor Link

1. 在项目根路径运行下面的命令安装依赖项。

   Copy Text

   npm install

2. 运行下面的命令启动示例项目。

   Copy Text

   npm run dev

3. 在浏览器中打开 http://localhost:3001/index.html。

4. 在示例项目设置页面上，输入 App ID 和 App 证书，然后点击设置按钮。

   • 关于 App ID 和 App 证书的获取方法，参考开通 RTC 服务。

参考Copy Anchor Link

• Web SDK 4.x 产品概述
• Web SDK 4.x API 参考
• 基于本仓库部署的在线 demo

开发者：上海声网科技有限公司

启动方法Copy Anchor Link

创建声网账号并获取 App IDCopy Anchor Link

在编译和启动示例程序前，你需要先获取一个可用的 App ID：

1. 在 声网控制台创建一个开发者账号
2. 前往后台页面，点击左部导航栏的 项目 > 项目列表 菜单
3. 复制后台的 App ID 并备注，稍后启动应用时会用到它

接下来执行以下命令

cd example
yarn
yarn start

开发者：上海声网科技有限公司