TaiSDK语音开发文档:Android与iOS集成指南

需积分: 10 2 下载量 119 浏览量 更新于2024-09-05 收藏 33KB DOCX 举报
"语音SDK设计文档,详述了在Android和iOS平台上的集成步骤,包含权限设置、断线重连策略、接口使用时序及API介绍。" 在语音SDK的设计中,开发者需要关注的关键点包括Android和iOS工程的导出、特定平台的权限配置以及SDK的连接管理和错误处理。以下是对这些要点的详细说明: 1. **导出Android工程**: 在Android项目集成SDK时,首先需要将SDK导入到Android Studio项目中,通常是作为aar库或者JAR包。确保所有依赖库和资源文件都被正确引入,并在项目的build.gradle文件中添加相应的依赖。 2. **导出iOS工程**: 对于iOS平台,需要在Xcode中进行操作。在File->Build Settings…中选择iOS平台,然后配置构建设置,指定输出iOS工程的路径和工程名。注意,对于iOS 10及以上版本,需要在Info.plist文件中添加`Privacy-MicrophoneUsageDescription`键,提供一个合理的使用录音权限的理由,以满足苹果的隐私政策。 3. **录音权限**: iOS 10及以上版本的设备,在使用录音功能时,系统会要求用户授权。确保在Info.plist中添加相应键值对,否则应用无法正常录音。 4. **断线重连策略**: SDK采用了简单而直接的断线重连策略。当检测到网络断开后,SDK会立即尝试重连,并通过监听器接口(如OnStartReconnect和OnRecvReconnectResult)通知应用重连的状态。如果重连失败,会收到OnLogout通知,此时应用需要判断游戏状态并决定是否重新调用Init、Login和进入频道的接口。 5. **接口调用流程**: 每次登录前必须先调用Init接口获取新的token,然后才能调用Login接口。如果接口返回非ErrorCode.Success,表示调用失败,后续不会有回调通知。 6. **消息恢复与监听**: 用户重新登录后,为了接收之前未读的消息,需要重新加入之前所在的频道。加入成功后,SDK会提供离线期间该频道的最近20条消息。游戏方需自行维护频道数据,以便在重新登录时知道需要加入哪些频道。 7. **接口使用时序图**: 这通常会展示API的调用顺序和交互过程,帮助开发者理解何时调用哪个接口,以及如何处理回调事件。 8. **API接口**: Unity3D版本的TaiSDK提供了C#接口,所有接口都在主线程中异步执行,不会阻塞UI。监听类(如InitListen和LoginListen)用于接收操作结果的回调,以便开发者根据结果进行下一步操作。 9. **SDK对象**: - TaiIMAPI:这是SDK的核心管理器,负责初始化、登录、登出等操作。 - TaiDefine:包含了SDK的各种结构体定义和错误码,是理解和处理SDK返回的错误信息的关键。 语音SDK的集成涉及到多方面的考虑,包括权限设置、网络管理、消息同步以及API的正确使用。开发者需要充分理解这些要点,以确保语音功能在应用中的稳定运行。