API Example MacOS

English | 中文

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

环境准备

• XCode 13.0 +

运行示例程序

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

安装依赖库

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

使用cocoapods

安装cocoapods

pod install

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

创建Agora账号并获取AppId

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

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

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

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

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

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

   /**
    Agora 给应用程序开发人员分配 App ID，以识别项目和组织。如果组织中有多个完全分开的应用程序，例如由不同的团队构建，
    则应使用不同的 App ID。如果应用程序需要相互通信，则应使用同一个App ID。
    进入声网控制台(https://console.agora.io/)，创建一个项目，进入项目配置页，即可看到APP ID。
   */
   static let AppId: String = <# YOUR APPID#>
   
   /**
    Agora 提供 App certificate 用以生成 Token。您可以在您的服务器部署并生成 Token，或者使用控制台生成临时的 Token。
    进入声网控制台(https://console.agora.io/)，创建一个带证书鉴权的项目，进入项目配置页，即可看到APP证书。如果项目没有开启证书鉴权，这个字段留空。
    注意：App证书放在客户端不安全，推荐放在服务端以确保 App 证书不会泄露。
   */
   static var Certificate: String? = <#YOUR Certificate#>
   

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

联系我们

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

代码许可

The MIT License (MIT)