> ## Documentation Index > Fetch the complete documentation index at: https://docs.stmlink.com/llms.txt > Use this file to discover all available pages before exploring further. # 快速开始 > iOS SMeeting 会议 SDK 快速集成，10 分钟跑通基础功能 ### 环境准备 * iOS 10.0 及以上版本 * Xcode 10.0 及以上版本 ### step 1：导入 SDK 并设置 App 权限 #### 导入 SDK 1、在您的 `Podfile` 文件中添加以下依赖。 ```objectivec theme={null} pod 'MeetingKit' ``` 2、执行以下命令，安装组件。 ```objectivec theme={null} pod install ``` > 说明： > > 如果无法安装 MeetingKit 最新版本，执行以下命令更新本地的 CocoaPods 仓库列表： ```objectivec theme={null} pod repo update ``` > 如果，还是拉取不到最新版本可以尝试指定 MeetingKit 的源： ```objectivec theme={null} pod 'MeetingKit', :git => "https://github.com/seastart/meeting-ios-cocoapods.git" ``` 3、在所使用到 MeetingKit 组件的地方引入头文件。 ```objectivec theme={null} #import ``` #### 配置 App 权限 使用音视频功能，需要授权麦克风、摄像头以及相册的使用权限。在 App 的 Info.plist 中添加以下几项，分别对应麦克风、摄像头和相册在系统弹出授权对话框时的提示信息。 ```xml theme={null} NSCameraUsageDescription MeetingKit 需要访问您的相机权限 NSMicrophoneUsageDescription MeetingKit 需要访问您的麦克风权限 NSPhotoLibraryUsageDescription MeetingKit 需要访问您的相册 ``` ### step 2：登录和登出 #### 登录 在调用 SDK 的任何其他函数之前，需要进行 SDK 登录操作，在您的项目中添加如下代码，它的作用是通过调用 MeetingKit 中的相关接口完成会议组件的初始化。这个步骤非常关键，因为只有在登录成功后才能正常使用 MeetingKit 的各项功能： ```objectivec theme={null} SEALogConfig *logConfig = [[SEALogConfig alloc] init]; logConfig.enableLocalLog = YES; [[MeetingKit sharedInstance] loginWithToken:@"Meeting User Auth Token" appGroup:@"Application Group Identifier" logConfig:logConfig onSuccess:^(id _Nullable data) { NSLog(@"会议组件登录成功"); } onFailed:^(SEAError code, NSString * _Nonnull message) { NSLog(@"会议组件登录失败(%ld，%@)", code, message); }]; ``` `enableLocalLog`默认值为`YES`。启用后会采集全进程日志到本地文件，同时保留宿主 App 的控制台输出。继续使用不带`logConfig`参数的登录接口时，也会采用该默认值。 #### 登出 ```objectivec theme={null} [[MeetingKit sharedInstance] logout]; ``` ### step 3：创建房间 #### 构建会议参数 会议参数由很多的字段构成，但通常您只需要关注特定几个字段，详情可参看 [SEAMeetingParam](https://www.yuque.com/anyconf/eanoso/gkeau9oyh5vms80z#gQ8nA)。 ```objectivec theme={null} SEAMeetingParam *meetingParam = [[SEAMeetingParam alloc] init]; meetingParam.title = @"Meeting Title"; ``` * **下表描述了**`**SEAMeetingParam**`**对象的部分属性。** | **参数名** | **必填** | **描述** | | -------- | :----: | ------ | | title | 是 | 会议标题 | | content | 否 | 会议说明 | | password | 否 | 会议密码 | #### 创建房间 创建 `SEAMeetingParam` 对象后，调用 SDK 的 `createRoom` 函数创建云会议房间。 ```objectivec theme={null} [[MeetingKit sharedInstance] createRoom:meetingParam onSuccess:^(id _Nullable data) { NSString *roomNo = (NSString *)data; NSLog(@"创建房间成功，生成的房间号码为：%@", roomNo); } onFailed:^(SEAError code, NSString * _Nonnull message) { NSLog(@"创建房间失败，code = %ld, message = %@", code, message); }]; ``` ### step 4：加入和离开房间 加入房间之前我们需要为组件设置委托，用于订阅组件的各类事件通知。 #### 设置委托 若要订阅委托事件，必须创建 `MeetingKitDelegate` 的实例，并使您的类符合 `MeetingKitDelegate` 协议。 ```objectivec theme={null} @interface YourClass : NSObject /// 根据需要，在此处添加以下任何回调函数。 ``` #### 实现回调事件 * **错误事件回调** ```objectivec theme={null} /// 错误事件回调 /// 发生不可恢复的错误，这个事件触发一般需要获取新的令牌重新入会。 /// - Parameters: /// - errCode: 错误码 /// - errMsg: 错误信息 - (void)onError:(SEAError)errCode errMsg:(nullable NSString *)errMsg { NSLog(@"发生了错误(%ld)，%@", errCode, errMsg); } ``` * **进入房间事件回调** ```objectivec theme={null} /// 进入房间事件回调 /// 调用 enterRoom: 接口执行加入房间操作后，会收到该事件通知，如果遇到错误会通过方法的 onFailed 参数抛出。 /// - Parameters: /// - meetingId: 会议标识 /// - userId: 用户标识 - (void)onEnterRoom:(NSString *)meetingId userId:(NSString *)userId { NSLog(@"加入房间成功，%@ %@", meetingId, userId); } ``` * **远端用户加入房间回调** ```objectivec theme={null} /// 远端用户加入房间回调 /// 成员调用 enterRoom: 接口执行加入房间后，当前房间所有成员都会收到该事件通知。 /// - Parameter userId: 成员标识 - (void)onUserEnter:(NSString *)userId { NSLog(@"远端用户加入房间通知，userId = %@", userId); } ``` * **远端用户离开房间回调** ```objectivec theme={null} /// 远端用户离开房间回调 /// 成员调用 exitRoom: 接口执行离开房间后，当前房间所有成员都会收到该事件通知。 /// - Parameter userId: 成员标识 - (void)onUserExit:(NSString *)userId { NSLog(@"远端用户离开房间通知，userId = %@", userId); } ``` * **用户摄像头状态变化回调** ```objectivec theme={null} /// 用户摄像头状态变化回调 /// 成员调用 requestOpenCamera: 或 closeCamera: 接口执行打开/关闭摄像头以及主持人调用 adminCloseUserCamera: 接口执行关闭远端用户摄像头后，当前房间所有成员都会收到该事件通知，注：当房间内已经有成员开启了摄像头，这时进入房间时也会收到该事件通知。 /// - Parameters: /// - targetUserId: 目标成员标识 /// - cameraState: 视频状态 - (void)onUserCameraStateChanged:(NSString *)targetUserId cameraState:(SEADeviceState)cameraState { NSLog(@"用户摄像头状态变化，userId = %@ cameraState = %ld", targetUserId, cameraState); } ``` * **用户麦克风状态变化回调** ```objectivec theme={null} /// 用户麦克风状态变化回调 /// 成员调用 requestOpenMic: 或 closeMic: 接口执行打开/关闭麦克风以及主持人调用 adminCloseUserMic: 接口执行关闭远端用户麦克风后，当前房间所有成员都会收到该事件通知，注：当房间内已经有成员开启了麦克风，这时进入房间时也会收到该事件通知。 /// - Parameters: /// - targetUserId: 目标成员标识 /// - micState: 音频状态 - (void)onUserMicStateChanged:(NSString *)targetUserId micState:(SEADeviceState)micState { NSLog(@"用户麦克风状态变化，userId = %@ micState = %ld", targetUserId, micState); } ``` #### 创建加入会议参数 在调用 enterRoom 接口时，需要填写 SEAMeetingEnterParam 关键参数，详情可参看 [SEAMeetingEnterParam](https://www.yuque.com/anyconf/eanoso/gkeau9oyh5vms80z#OLcoA)。 ```objectivec theme={null} SEAMeetingEnterParam *meetingEnterParam = [[SEAMeetingEnterParam alloc] init]; meetingEnterParam.roomNo = @"Target Room No"; meetingEnterParam.nickname = @"Your Name"; meetingEnterParam.avatar = @"Your Portrait"; meetingEnterParam.isAudience = NO; // 默认以普通参会者身份入会，设置为 YES 时以观众身份入会 ``` #### 加入房间 创建 `SEAMeetingEnterParam` 对象后，调用 SDK 的 `enterRoom` 函数加入云会议房间。 > 值得注意的是，该方法的成功参数不能作为加入房间的真实情况，仅用于接口层面的调用成功使用，即：接口调用结束。要想确认加入房间是否真实成功，需要通过上述委托监听 `onEnterRoom` 事件来实现。 ```objectivec theme={null} [[MeetingKit sharedInstance] enterRoom:meetingEnterParam onSuccess:^(id _Nullable data) { NSString *roomId = (NSString *)data; NSLog(@"加入房间成功，房间标识为：%@", roomId); } onFailed:^(SEAError code, NSString * _Nonnull message) { NSLog(@"加入房间失败，code = %ld, message = %@", code, message); }]; ``` #### 离开房间 > 调用该接口会让用户离开自己所在的房间，并释放摄像头、麦克风、扬声器等设备资源。 等资源释放完毕之后，SDK 会通过`onSuccess`回调向您通知。 如果您要再次调用`enterRoom:()`，建议等待`onSuccess`回调到来之后再执行之后的操作，以避免摄像头或麦克风被占用等异常问题。 ```objectivec theme={null} [[MeetingKit sharedInstance] exitRoom:^(id _Nullable data) { /// TO DO... }]; ``` ### step 5：打开和关闭摄像头 请求开启或关闭摄像头后，服务会通过一系列逻辑确定用户的摄像头状态。此时，组件会收到`onUserCameraStateChanged`事件。 #### 打开摄像头 ```objectivec theme={null} [[MeetingKit sharedInstance] requestOpenCamera:YES view:preview onSuccess:^(id _Nullable data) { NSLog(@"请求开启摄像头成功"); } onFailed:^(SEAError code, NSString * _Nonnull message) { NSLog(@"请求开启摄像头失败，code = %ld, message = %@", code, message); }]; ``` #### 关闭摄像头 ```objectivec theme={null} [[MeetingKit sharedInstance] closeCamera:^(id _Nullable data) { NSLog(@"请求关闭摄像头成功"); } onFailed:^(SEAError code, NSString * _Nonnull message) { NSLog(@"请求关闭摄像头失败，code = %ld, message = %@", code, message); }]; ``` > 需要注意的是，以上方法的成功参数不能作为摄像头状态的真实情况，仅用于接口层面的调用成功使用，即：接口调用结束。为保证摄像头状态客户端与服务端的一致性，需要通过委托监听 `onUserCameraStateChanged` 事件来实现。 ### step 6：打开和关闭麦克风 请求开启或关闭麦克风后，服务会通过一系列逻辑确定用户的麦克风状态。此时，组件会收到`onUserMicStateChanged`事件。 #### 打开麦克风 ```objectivec theme={null} [[MeetingKit sharedInstance] requestOpenMic:^(id _Nullable data) { NSLog(@"请求打开麦克风成功"); } onFailed:^(SEAError code, NSString * _Nonnull message) { NSLog(@"请求打开麦克风失败，code = %ld, message = %@", code, message); }]; ``` #### 关闭麦克风 ```objectivec theme={null} [[MeetingKit sharedInstance] closeMic:^(id _Nullable data) { NSLog(@"请求关闭麦克风成功"); } onFailed:^(SEAError code, NSString * _Nonnull message) { NSLog(@"请求关闭麦克风失败，code = %ld, message = %@", code, message); }]; ``` > 需要注意的是，以上方法的成功参数不能作为麦克风状态的真实情况，仅用于接口层面的调用成功使用，即：接口调用结束。为保证麦克风状态客户端与服务端的一致性，需要通过委托监听 `onUserMicStateChanged` 事件来实现。 ### step 7：订阅和取消订阅远端用户画面 #### 订阅远端用户画面 ```objectivec theme={null} [[MeetingKit sharedInstance] startRemoteView:@"Remote User ID" streamType:SEAVideoStreamTypeBig view:playerView]; ``` * **下表描述了`SEAVideoStreamType`视频流类型的所有值。** | **枚举类型** | **枚举值** | **描述** | | ------------------------ | :-----: | ------------------------------------------ | | SEAVideoStreamTypeBig | `0` | 高清大画面，一般用来传输摄像头的视频数据 | | SEAVideoStreamTypeSmall | `1` | 低清小画面，小画面和大画面的内容相同，但是分辨率和码率都比大画面低，因此清晰度也更低 | | SEAVideoStreamTypeScreen | `2` | 屏幕共享流 | #### 取消订阅远端用户画面 ```objectivec theme={null} [[MeetingKit sharedInstance] stopRemoteView:@"Remote User ID" streamType:SEAVideoStreamTypeBig]; ``` #### **取消订阅指定远端用户的所有视频画面** ```objectivec theme={null} [[MeetingKit sharedInstance] stopAllRemoteViewWithUserId:@"Remote User ID"]; ``` #### **取消订阅所有远端用户的视频画面** ```objectivec theme={null} [[MeetingKit sharedInstance] stopAllRemoteView]; ``` > 注：取消订阅成员视频画面后，组件会自行释放渲染控件。