README.zh.md

API Example Android

English | 中文

这个开源示例项目演示了Agora视频SDK的部分API使用示例，以帮助开发者更好地理解和运用Agora视频SDK的API。

环境准备

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

运行示例程序

这个段落主要讲解了如何编译和运行实例程序。

创建Agora账号并获取AppId

在编译和启动实例程序前，你需要首先获取一个可用的App Id:

1. 在agora.io创建一个开发者账号

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

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

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

5. 打开 Android/APIExample-Audio 并编辑项目根目录下的 local.properties，填入你的 App ID。如果你的 Agora 项目开启了 App Certificate，并且你希望使用示例内置的 token 生成功能，再填入 YOUR APP CERTIFICATE

   sdk.dir=/path/to/Android/sdk
   AGORA_APP_ID=YOUR APP ID
   AGORA_APP_CERT=YOUR APP CERTIFICATE
   

AGORA_APP_ID 为必填项。如果你的项目没有开启 App Certificate，AGORA_APP_CERT 留空即可。如果你使用自己的服务端生成 token，建议不要在客户端填写 AGORA_APP_CERT，直接使用 JoinChannelAudio(Token) 示例在运行时粘贴 token。

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

联系我们

• 如果你遇到了困难，可以先参阅 常见问题
• 如果你想了解更多官方示例，可以参考 官方SDK示例
• 如果你想了解 Agora SDK 在复杂场景下的应用，可以参考 官方场景案例
• 如果你想了解 Agora 的一些社区开发者维护的项目，可以查看 社区
• 完整的 API 文档见 文档中心
• 若遇到问题需要开发者帮助，你可以到 开发者社区 提问
• 如果需要售后技术支持, 你可以在 Agora Dashboard 提交工单
• 如果发现了示例代码的 bug，欢迎提交 issue

代码许可

The MIT License (MIT)