Skip to main content

知识库

Back to support overview

TeamViewer Assist AR - iOS 移动设备的SDK

上次修改时间: 2026年1月21日

通过TeamViewer Assist AR iOS的移动软件开发工具包（SDK），你可以利用Assist AR 会议的全部功能。通过将SDK嵌入到您自己的移动应用程序中，为优化客户服务提供最佳的基于AR的远程协助体验。

该SDK使您能够与您客户的设备进行安全和符合GDPR的连接。

本文适用于所有TeamViewer Assist AR 用户。

先决条件

  • iOS 15.4 或以上版本
  • 一个现有的TeamViewer 账户

如果你没有一个TeamViewer 帐户，请按照以下步骤创建一个。

  1. 进入https://login.teamviewer.com/，点击 注册。
  2. 完成创建账户的步骤，并验证您的电子邮件地址。

生成一个API密钥

1. 使用你的TeamViewer 账户在 TeamViewer Remote 用户端或者 https://web.teamviewer.com/ 登录。

2. 点击管理设置

3. 在 身份验证 的类别下选择 应用程序和标记

4. 点击 配置文件设置

5. 在 创建应用程序或标记 的选项下点击 创建移动 SDK 。

Create Mobile Sdk

6. 输入名称，并添加一个简短的描述（可选）。

7. 在 移动SDK 系统 选项中，选择 iOS

8. 点击 保存

Mobile Sdk System Ios

移动 SDK 令牌已生成且展示在 应用程序和标记 页面

9. 点击三点菜单，将此令牌复制到你的剪贴板上并粘贴到一个安全的地方。

重要提示：请勿与任何人分享此信物。

Copy Token

安装 TeamViewer 移动 SDK

你可以通过 Swift Package Manager（SPM）安装 TeamViewer SDK，或按照以下步骤手动安装。

设置你的XCode项目

TeamViewer SDK在远程支持会话中使用摄像头和麦克风。

在Info.Plist文件中添加以下键。

  • NSMicrophoneUsageDescription
  • NSCameraUsageDescription

如果你不添加这些键，当SDK试图访问麦克风或摄像头时，iOS将终止应用程序。

使用 TeamViewer SDK

重要

  • SDK 是一个单例类。您不能直接创建实例，而应访问共享实例。
  • 15.81 版本中针对 Swift 集成的重大变更
    • 主 SDK 客户端类 TeamViewerSDK 已重命名为 TeamViewerSDKClient。
    • 使用旧名称的 Objective-C 代码仍可继续编译并正常运行。
    • Swift 代码必须更新为引用 TeamViewerSDKClient。
    • 单例访问器 sharedSDK 及所有其他方法保持不变。
// Before
let tvSDK: TeamViewerSDK = .sharedSDK()
// After
let tvSDK: TeamViewerSDKClient = .sharedSDK()

 

连接并管理会话

 

1. 使用您在 Prerequisites 部分获得的 API Key 初始化 SDK 实例。

private func setupSDK() {
   let token = "YOUR_TOKEN_HERE"
   let tvSDK: TeamViewerSDKClient = .sharedSDK()
   self.tvSDK.setup(with: token,
                    andDelegate: self)
 }

2. 设置一个遵循 TeamViewerSDKDelegate 协议的委托。

这可确保您能够对 TeamViewer 连接生命周期内发生的事件作出响应。

3. 连接到会话代码

共享 SDK 提供了一种建立与会话代码连接的方法。此会话代码可以是以下两种类型之一：

  • Remote Support 或
  • Assist AR

4. 在您的 TeamViewer 客户端中或通过 TeamViewer REST API 创建会话代码。

self.session = tvSDK.connect(toSessionCode: code)

方法connectToSessionCode返回一个TeamViewer session。

重要提示： 你有责任保持这个变量的有效性，也有责任释放这个变量。如果不这样做，可能会导致会话用户界面在远程会话结束后仍然保持活力。

重要提示： 一旦SDK连接到一个会话代码，它就会进入一个等待状态，你会通过委托方法 handleSessionCodeOnline得到状态变化的通知。

在这一点上，你不应该允许用户连接到一个不同的会话代码。只允许允许用户离开当前的连接。

在支持方，会话代码将显示为在线，允许客户端与该会话代码建立连接。

对呼入的连接作出反应

SDK提供了代表方法来对传入的连接事件做出反应。

一旦连接在TeamViewer ，SDK就会通过委托方法 handleConnectionRequestWithAuthenticationData得到关于这个连接尝试的通知。

在认证数据参数上有支持者的名字，传入连接的类型（ScreenShare或Assist AR ）和一个允许或拒绝传入连接的回调函数。

如果接收到的连接被接受，就会建立相应的TeamViewer 连接。

  • 对于ScreenShare连接，会向用户显示一个关于麦克风和屏幕共享的提示。

你的应用程序的用户界面是使用重放套件抓取的，用户和支持者之间有双向的VoIP通信。

  • 对于Assist AR 连接，显示了摄像头和麦克风访问的系统权限。如果用户允许，AR会话就开始了。用户和支持方之间有双向的VoIP通信。
  • 应实现委托方法 handleConnectionRequestAbort，以便在远程用户取消连接请求时获得通知。你有责任清除显示给用户的任何提示，或取消任何CallKit的来电通知。

对可选的SDK事件做出反应

  • handleSupporterConnected: 这个方法在支持者开始会话时被调用，当用户在本地开始会话时也会被调用。
  • handleSupporterDisconnected: 这个方法在支持者结束会话时被调用，当用户在本地结束会话时也会被调用。

提示：你应该清理对会话的引用，因为这时会话被认为不再有效。

  • handleError:如果用于建立连接的会话代码或API令牌无效，该方法将被调用。

提示： 你应该清理当前会话使用的资源，因为会话本身被认为是无效的。

对可选的会议事件做出反应

  • handleSessionError:当会话中发生错误时，这个功能会被调用。例如，一个功能被请求，但客户端和服务器之间的兼容性没有得到满足。

提示： 这个错误只是信息性的。你可以把它写到日志文件中。

关于CallKit支持的说明

如果你的应用程序支持CallKit。

  • 向TeamViewer SDK提供有关您的呼叫的唯一标识符的信息。
  • TeamViewer 询问系统是否有一个正在进行的呼叫，如果是这样的话，就不尝试建立VoIP连接。
  • 告诉TeamViewer ，当前的呼叫是你的，这样我们就可以接管音频管道并开始VoIP传输。
    • 调用setupCallUUID方法。
    • 通过调用clearCallUUID 方法告诉SDK你的呼叫已经结束。

启用背景模式

确保你在Info.plist文件中至少启用了这些背景模式之一。

  • 音频，
  • AirPlay 或
  • IP语音背景模式。

重要的是：如果不这样做，将导致应用程序在活动的TeamViewer 会话中被放到后台后仅几秒钟就被暂停。

音频设置

移动SDK与默认的AVAudioSession配置值一起工作。

  • 如果你想覆盖这些值，以支持蓝牙、Airplay混合、使用扬声器等，确保在建立会话之前改变这些值。如果你的应用程序对其他应用程序进行静音，建议在接受连接之前配置音频会话的时间点。
  • 如果你的应用程序音频与其他应用程序混合，你可以在应用程序启动时配置音频选项。

禁用VoIP

如果您想使用其他方式建立语音通信，您可以在建立连接之前通过设置共享SDK实例的选项来完全禁用VoIP功能。

更多信息请参考 TVSDKOptions 文档

Class 文件

所有的公共头衔文件都有记录。关于每个类的详细信息，请参考XCode生成的QuickHelp内容（'⌥'+点击常量或变量名）。