Skip to content

Latest commit

 

History

History

iOS

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
CallAPI
CallAPI
 
 
Example
Example
 
 
.gitignore
.gitignore
 
 
.travis.yml
.travis.yml
 
 
CallAPI.podspec
CallAPI.podspec
 
 
README.md
README.md
 
 
_Pods.xcodeproj
_Pods.xcodeproj
 
 

README.md

CallAPI Example

本文档主要介绍如何快速跑通 CallAPI示例工程

1. 开通服务

请参考官网文档 开通服务

2. 运行示例

  • 克隆或者直接下载项目源码

  • 申请账号和权限

    注意，由于Demo里包含了基于 Rtm 和 环信 的两种1v1信令呼叫场景，如果您只需要体验其中的一种呼叫场景，可以跳过另一种的申请流程

    • 进入声网控制台获取 APP ID 和 APP 证书 控制台入口

    • 点击创建项目

      图片

    • 选择项目基础配置, 鉴权机制需要选择安全模式

      图片

    • 在项目的功能配置中启用"实时消息 RTM"功能

      注: 如果没有启动"实时消息 RTM"功能, 将无法体验项目完整功能

      图片

    • 拿到项目 APP ID 与 APP 证书

      图片

    • 注册环信获取AppKey

      • 环信相关功能为Demo层的扩展功能，仅提供简单的实现消息收发，一些边缘case异常、版本升级等需要自行维护。
      • CallApi Demo里的自定义环信信令管理使用的是 username + password 方式，如果需要使用更安全的token方式鉴权，需要自行实现

  • 开通声网自定义数据上报和分析服务

    该服务当前处于免费内测期，如需试用该服务，请联系 sales@agora.io

  • 在项目的KeyCenter.swift 中填写声网 APP ID 和 APP 证书 以及环信 App Key (如果不需要体验环信自定义信令流程，IMAppKey可以设置为"")

    static var AppId: String = <#Your AppId#>
static var Certificate: String = <#Your Certificate#>
static var IMAppKey: String = <#Your EaseMob AppKey#>

  • 打开终端，进入到Podfile目录下，执行pod install命令

  • 最后打开CallAPI.xcworkspace，运行即可开始您的体验

3. 项目介绍

请参考官网文档 项目介绍

CallApi是一套开源的纯业务逻辑的呼叫邀请模块，您可以自由定制和修改，而不会限制您的业务流程。

CallApi不涉及任何UI，您可以根据自己的需求灵活地自定义UI。

4. 快速集成

请参考官网文档 集成 CallAPI

5. 进阶集成

请参考官网文档 进阶集成指引

6. API说明

请参考官网文档 场景化 API

7. 实现原理

7.1 优化呼叫性能和可靠性

7.1.1 加快出图速度

  • 1.使用万能Token
    • 为了提高通话质量和稳定性，我们采用万能 Token，可以节省因加入不同频道获取 Token 的时间，这意味着，在使用我们的服务时，您无需频繁获取 Token，而只需使用一个固定的 Token 即可。这样不仅可以提高您的使用效率，还可以让您更加专注于通话内容本身。

    • 注意：为了保障通话的私密性和安全性，推荐每次呼叫都采用不同的RTC频道号。

  • 2.加快主叫出图速度
    • 2.1 [可选] 初始化时，可以提前加入自己的 RTC 频道。请注意，这种行为可能会导致额外的费用。如果对费用比较在意，您可以选择忽略此步骤。
    • 2.2 在向被叫发起呼叫时
      • 2.2.1 加入自己的 RTC 频道。
      • 2.2.2 往自己的RTC频道发送音视频流。
      • 2.2.3 订阅远端的视频流，不订阅音频流。
      • 2.2.4 同时，为了避免错过首个 I 帧解码导致可能的首帧渲染慢，您需要创建一个临时的画布，并使用 setupRemoteVideoEx 方法将被叫用户的视频流渲染到该画布中。
    • 2.3 当收到收到被叫的接受消息后，开始订阅远端音频流。
    • 2.4 当收到被叫方的首帧并且已经接收到被叫方的同意后，即可认为连接成功。此时，您可以将之前创建的临时画布添加到视图中，完成视频的渲染。
  • 3.加快被叫出图速度
    • 3.1 [可选][推荐] 当收到主叫呼叫后
      • 3.1.1 立即加入主叫的RTC频道。
      • 3.1.2 往主叫RTC频道推送音视频流。
      • 3.1.3 然后订阅远端的视频流，不订阅音频流。
      • 3.1.4 同时，为了避免错过首个 I 帧解码导致可能的首帧渲染慢，您需要创建一个临时的画布，并使用 setupRemoteVideoEx 方法将主叫用户的视频流渲染到该画布中。 请注意，[步骤3.1]会导致额外费用。如果对费用比较敏感，您可以选择忽略此步骤。
    • 3.2 当点击接受后
      • 3.2.1 如果收到呼叫时没有执行 [步骤3.1] ，那么需要在此处执行 [步骤3.1] 。
      • 3.2.2 开始订阅远端音频流。
    • 3.3 当收到主叫方的首帧后，即可确认连接成功。此时，您可以将之前创建的临时画布添加到可视化视图中，从而完成视频渲染的过程。
  • 4.时序图



7.1.2 提升消息送达率

  • 增加消息回执(如果信令通道有则忽略)
  • 增加超时重试(如果信令通道有则忽略)
  • 选择送达率高的信令通道，例如声网RTM

6.2 影响通话速度的指标

  • 主叫
    • 呼叫-被叫收到呼叫的耗时
    • 呼叫-收到被叫接受呼叫的耗时
    • 呼叫-被叫加入频道的耗时
    • 呼叫-主叫自己加入频道的耗时
    • 呼叫-收到被叫首帧的耗时
  • 被叫
    • 收到呼叫-接受呼叫的耗时
    • 收到呼叫-被叫自己加入频道的耗时
    • 收到呼叫-主叫加入频道的耗时
    • 收到呼叫-收到主叫首帧的耗时