Skip to content

Latest commit

 

History

History
122 lines (88 loc) · 9.22 KB

README.zh.md

File metadata and controls

122 lines (88 loc) · 9.22 KB
Raw

API Example iOS

English | 中文

简介

该仓库包含了使用 RTC Objective-C SDK for iOS 的示例项目。

image

项目结构

此项目使用一个单独的 app 实现了多种功能。每个功能以 storyboard 的形式加载，方便你进行试用。

Function Location
音视频直播 LiveStreaming.swift
自定义音频采集 CustomAudioSource.swift
自定义视频渲染 CustomVideoRender.swift
原始音视频数据 (Objective-C 混编 C++, 使用 AgoraMediaRawData.h ) RawMediaData.swift
原始音频数据 (Native Objective-C 接口) RawAudioData.swift
自定义视频采集 (Push) CustomVideoSourcePush.swift
自定义视频采集 (mediaIO) CustomVideoSourceMediaIO.swift
切换频道 QuickSwitchChannel.swift
加入多频道 JoinMultiChannel.swift
加入频道（音频） JoinChannelAudio.swift
加入频道（音视频） JoinChannelVideo.swift
混音与音频文件播放 AudioMixing.swift
变声与音效 VoiceChanger.swift
媒体播放器组件 MediaPlayer.swift
RTMP 推流 RTMPStreaming.swift
媒体流加密（自定义加密 + SDK 加密） StreamEncryption.swift
视频元数据 VideoMetadata.swift
多人视频聊天 VideoChat.swift
呼叫前测试 PrecallTest.swift
频道媒体流转发 MediaChannelRelay.swift
超级分辨率 SuperResolution.swift
多进程同时发送屏幕共享流和摄像头采集流 ScreenShare.swift
使用自定义视频采集 (mediaIO) 实现 AR 功能 ARKit.swift
发送数据流 CreateDataStream.swift
区域访问限制 GlobalSettings.swift

如何运行示例项目

前提条件

  • XCode 10.0 +
  • iOS 真机设备
  • 不支持模拟器

运行步骤

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

  1. 使用 Xcode 打开生成的 APIExample.xcworkspace。

  2. 编辑 KeyCenter.swift 文件。

    • 将 YOUR APP ID 替换为你的 App ID。
    • 将 YOUR Certificate 替换为你的 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证书。
  注意：如果项目没有开启证书鉴权，这个字段留空。
 */
 static var Certificate: String? = <#YOUR Certificate#>

    参考 开始使用 Agora 平台 了解如何获取 App ID 和 Token。你可以获取一个临时 token，快速运行示例项目。

    生成 Token 使用的频道名必须和加入频道时使用的频道名一致。

    为提高项目的安全性，Agora 使用 Token（动态密钥）对即将加入频道的用户进行鉴权。

    临时 Token 仅作为演示和测试用途。在生产环境中，你需要自行部署服务器签发 Token，详见生成 Token。

  3. 构建并在 iOS 设备中运行项目。

一切就绪。你可以自由探索示例项目，体验 RTC Objective-C for iOS SDK 的丰富功能。

反馈

如果你有任何问题或建议，可以通过 issue 的形式反馈。

参考文档

相关资源

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

已知问题

iOS 系统版本升级至 14.0 版本后，用户首次使用集成了 v3.1.2 或之前版本声网 iOS 语音或视频 SDK 的 app 时会看到查找本地网络设备的弹窗提示。默认弹窗界面如下图所示：

解决方案

代码许可

示例项目遵守 MIT 许可证。