## 前提条件 * 获取 AppID，参考 [开通服务](https://docs.volcengine.com/docs/6348/69865)。 * 获取 Token，参考 [密钥说明](https://docs.volcengine.com/docs/6348/70121)。 * Xcode 12.5 或以上版本。 > 本文操作步骤和示例图以 Xcode 13.1 为例。 * iOS 9.0 或以上版本的设备。 * 使用 Objective\-C 作为开发语言。 * 请确保您的项目已设置有效的开发者签名。 * 已获取 [Whiteboard SDK](https://docs.volcengine.com/docs/6348/148386)。 ## 步骤 1: 创建项目 1. 打开 **Xcode**，点击 **File \> New \> Project**。 2. 选择 **iOS** \> **App** ，点击 **Next**。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_d3d56cb764e4d4d769933ae5175285dd.jpg) 3. 输入项目名称、团队名称、选择开发语言，点击 **Next**。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_06c463e8f0e3022c72a5c8a281b3e540.jpg) 4. 选择项目存储位置，点击 **Create**。 5. 签名设置：进入 **TARGETS** \> **Project Name** \> **Signing & Capabilities**。勾选 **Automatically manage signing**，并在弹出菜单中选择 **Enable Automatic**。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_f0a2c12d5d3ac7d0b86c8586060c506d.png) ## 步骤 2: 创建用户界面根据场景需要，为你的项目创建互动白板的用户界面。为实现基本的白板功能，我们建议在项目中添加如下视图或元素： * 选择模式按钮 * 调节图形（直线、圆、矩形、箭头）格式的面板按钮 * 橡皮擦按钮 * 清空白板按钮 * 下课按钮 * 退出房间按钮 ## 步骤 3: 集成 SDK 1. 为 podfile 文件的 target 工程添加依赖项，例如： ```Plain platform :ios, '9.0' source 'https://github.com/volcengine/volcengine-specs.git' target '你的项目名字' do pod 'VolcEngineWhiteboard', '1.6.0'// 将版本号替换为最新或你需要的版本号。 end ``` 2. 在项目的配置文件里加入 SDK 依赖。可以根据实际需要指定 SDK 的版本。 ```Plain spec.dependency 'VolcEngineWhiteboard', '1.6.0'// 版本号和 podfile 中的依赖项保持一致。 ``` 3. 引入头文件在调用了白板 SDK API 的文件中引入头文件。 ```objectivec //引入头文件 #import "WhiteBoard/ByteWhiteBoardRoomManager.h" #import "WhiteBoard/ByteWhiteBoardRoom.h" #import "WhiteBoard/ByteWhiteBoard.h" ``` ## 步骤 4: 实现功能 ### 基础互动白板 API 时序图 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_25625b4f34288647771f64ac0900974a.png) ### 1. 创建和初始化白板房间 1. 为白板创建以下 3 个属性。 ```objectivec @property (nonatomic, strong) ByteWhiteBoardRoomManager * boardRoomManager; @property (nonatomic, strong) ByteWhiteBoardRoom * boardRoom; @property (nonatomic, strong) ByteWhiteBoard * board; ``` 2. 调用类 [ByteWhiteBoardRoomManager](https://docs.volcengine.com/docs/6348/131855#bytewhiteboardroommanager) 中的方法绑定设备信息和环境。 ```objectivec + (void)setDeviceID:(NSString *)deviceID; // 设备id用于方便追踪排查问题 + (void)setAid:(NSString*)aid; //火山内部客户使用，用于标识APP + (void)setLogLocation:(NSString*)path;//设置日志的位置，不设置则SDK自动选择 ``` 3. 调用 [sharedEngineWithAppId:bindToWindow:completionHandler:](https://docs.volcengine.com/docs/6348/131855#ByteWhiteBoardRoomManager-sharedenginewithappid-bindtowindow-completionhandler)，创建白板 [ByteWhiteBoardRoomManager](https://docs.volcengine.com/docs/6348/131855#bytewhiteboardroommanager)。 ```objectivec + (instancetype)sharedEngineWithAppId:(NSString *)appId setEnv:(ByteWhiteBoardEnv)env bindToWindow:(UIView *)view completionHandler:(void (^)(void))block; ``` 参考 [开通服务](https://docs.volcengine.com/docs/6348/69865) 获取 AppID。 ### 2. 加入白板房间加入白板房间。如果当前房间没有白板，SDK 将自动创建白板。 ```objectivec - (void)joinRoom:(NSString *)roomID userID:(NSString *)userID token:(NSString*)token defalutBoard:(ByteWhiteBoardInfo *)boardInfo completionHandler:(void (^)(ByteWhiteBoardRoom *))block delegate:(id)delegate; //回调触发后我们可以通过getRoomStatus得知当前房间是否上课。 ``` * 白板房间 `roomID` 不能与 RTC 房间 `roomID` 相同。以免影响白板房间和 RTC 房间内回调提醒相互影响。建议为白板房间名加上 `whiteboard_` 前缀。 * 白板用户 `userID` 不能与 RTC `userID` 相同。 * `id)delegate` 为白板 ViewController，继承了 ByteWhiteBoardRoomDelegate 协议。 * 参考 [使用 Token 完成鉴权](https://docs.volcengine.com/docs/6348/70121) 获取 Token。Token 有效时长应大于单次白板互动时长。例如， 24 小时。白板服务在当前用户加入白板房间后开始计费，直到该用户调用 [leaveRoom](https://docs.volcengine.com/docs/6348/131855#ByteWhiteBoardRoom-leaveroom) 退出房间后停止计费。建议在即将使用白板前创建白板实例。并结束使用后及时销毁白板实例。 ### 3. 获取房间内所有白板信息加入房间后，如果房间内白板数量为 0，将自动创建白板并触发 [byteWhiteBoardRoom:onCreateWhiteBoard:boardId:whiteboard:](https://docs.volcengine.com/docs/6348/131856#ByteWhiteBoardRoomDelegate-bytewhiteboardroom-oncreatewhiteboard-boardid-whiteboard-pptinfo)。你可以通过本回调获取到白板对象。此外，SDK 将通过 `ByteWhiteBoardRoomDelegate` 的 [byteWhiteBoardRoom:onCurrentWhiteBoardChanged:activeBoard:whiteboard:](https://docs.volcengine.com/docs/6348/131856#ByteWhiteBoardRoomDelegate-bytewhiteboardroom-oncurrentwhiteboardchanged-activeboard-whiteboard) 回调当前活跃的白板信息。 ### 4 使用白板使用不同的画笔对白板进行编辑。 ```objectivec [self.board setEditType:ByteWhiteBoardShapeTypePen];//设置成画笔模式或者其他 [self.board setWritable:YES];//设置当前白板是否可写 ``` ### 5. 结束使用白板在结束白板使用时，释放资源的步骤如下。 1. 调用 `ByteWhiteBoardRoom` 的 [leaveRoom](https://docs.volcengine.com/docs/6348/131855#ByteWhiteBoardRoom-leaveroom) 离开房间，结束通话过程，释放所有通话相关的资源。 ```objectivec - (void)leaveRoom; ``` 除了用户主动结束使用之外，在监听到以下错误时，你也需要调用上述接口，执行离房操作。 ```objectivec - (void)byteWhiteBoard:(ByteWhiteBoard *)board onError:(ByteWhiteBoardErrorCode)code message:(NSString *)message{ if (code == DUPLICATE_LOGIN || code == KICKED_OUT || code == INVALID_TOKEN) { //离开房间的代码 [self.boardRoom leaveRoom]; [ByteWhiteBoardRoomManager destroy]; } } - (void)byteWhiteBoardRoom:(ByteWhiteBoardRoom *)boardRoom onError:(ByteWhiteBoardErrorCode)code message:(NSString *)message { [self.class showToast:[NSString stringWithFormat:@"room error %ld",(long)code]]; if (code == DUPLICATE_LOGIN || code == KICKED_OUT || code == INVALID_TOKEN) { //离开房间的代码 [self.boardRoom leaveRoom]; [ByteWhiteBoardRoomManager destroy]; } } ``` 2. 调用 `ByteWhiteBoardRoomManager` 的 [destroy](https://docs.volcengine.com/docs/6348/131855#ByteWhiteBoardRoomManager-destroy) 释放资源。 ```objectivec [ByteWhiteBoardRoomManager destroy]; ``` ## 常见问题 ### 1. 日志和缓存文件的路径在哪里？ * 日志默认路径：AppData/Library/Caches/Logs。你可以调用 [setLogLocation:](https://docs.volcengine.com/docs/6348/131855#setloglocation) 自定义日志路径。 * 回放文件默认路径：AppData/Library/Caches ### 2. bitcode_strip 报错 ```Plain bitcode_strip ****/byteaudio.framework/byteaudio: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/bitcode_strip exited with 1 ``` **解决方法：** 关闭 bitcode：自定义环境设置 STRIP_BITCODE_FROM_COPIED_FILES = NO ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_e9968b2edde2276d63be7112aef05451.png) ### 3. ENABLE_BITCODE 报错 ```Plain '***/WhiteBoardDemo/Lib/WhiteBoard.framework/WhiteBoard' does not contain bitcode. You must rebuild it with bitcode enabled (Xcode setting ENABLE_BITCODE), obtain an updated library from the vendor, or disable bitcode for this target. file '***/WhiteBoardDemo/Lib/WhiteBoard.framework/WhiteBoard' for architecture arm64 ``` **解决方法：** 设置 **target** 的 **Enable BitCode** 字段为 **NO**。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_65fa86bb70ba2998f218e62f0cf38f41.png)

实时音视频