PlasoStyleUpime / PlasoUpimeSdkModule 1.68.110。完成以下步骤后,可通过服务端签发的 query 启动实时课堂。| 要求 | 值 |
|---|---|
| 最低系统版本 | iOS 12.0(与对外 Demo 一致) |
| 推荐集成 | CocoaPods |
| Pod | PlasoStyleUpime、PlasoUpimeSdkModule、PlasoProgressHUD |
| 入口 API | PlasoStyleUpimeClient.createLive(withQuery:) |
appId、课堂服务地址,以及业务服务端提供的课堂 query 接口。线上课堂服务地址为 https://www.plaso.cn。正式环境中,appKey 只能保存在服务端,不能写入 App。Podfile 中配置:pod install 后打开生成的 .xcworkspace。如果 Xcode 报 libarclite 错误,再提高当前 Target 的最低部署版本。PlasoUpimeSdkModule 内嵌 Flutter 交付(与 Android StyleUpime 同源能力),随 CocoaPods 以动态 Framework(use_frameworks! :linkage => :dynamic)链入。| 项 | 说明 |
|---|---|
| 引擎版本 | 与 SDK 1.68.110 绑定;与 Android 侧内嵌引擎一致,对应 Flutter 3.22.3(以当前发版的 PlasoUpimeSdkModule 为准,升级 SDK 时引擎一并升级) |
| 链接方式 | CocoaPods 动态 Framework,勿改为静态链接混用另一套 Flutter |
| 与宿主 Flutter | 不能共存。宿主 App 若已使用 Flutter(自有 Flutter 工程 / 已嵌入另一套 Flutter Engine),无法接入本 SDK |
| Impeller | Demo / 正式接入须在 Info.plist 关闭 Impeller:FLTEnableImpeller = false(布尔) |
Info.plist 声明权限:| 权限 Key | 场景 |
|---|---|
NSCameraUsageDescription | 视频课堂、头像采集 |
NSMicrophoneUsageDescription | 音视频课堂 |
NSPhotoLibraryUsageDescription / NSPhotoLibraryAddUsageDescription | 上传或保存图片 |
NSBluetoothAlwaysUsageDescription / NSBluetoothPeripheralUsageDescription | 蓝牙手写板 |
NSLocalNetworkUsageDescription | 局域网连通性检测 |
FLTEnableImpeller | 设为 false,关闭 Impeller(内嵌 Flutter 要求) |
Podfile 中确认依赖版本为 1.68.110,执行 pod install。PlasoSdkDemoForiOS/AppConfig.swift 中的 appId 和 appKey,填入伯索分配的测试凭证:appKey 生成签名。该做法仅限测试;生产 App 必须删除本地签名逻辑,由业务服务端保存 appKey 并生成课堂 query、窗口模式签名和微课上传签名。signature 后,客户端应原样传给 createLive(withQuery:)。| 参数 | 类型 | 示例 / 取值 | 说明 |
|---|---|---|---|
appId | String | your-app-id | 伯索分配的应用标识。 |
appType | String | liveclassSDK | 实时课堂固定值。 |
validBegin | Long | Int(Date().timeIntervalSince1970) | 签名生效时间,Unix 秒级时间戳。 |
validTime | Int | 10800 | query 有效期,单位秒;由业务服务端按安全策略设置。 |
signature | String | 服务端生成 | 对 query 参数生成的签名值;客户端不能生成、修改或拼接该字段。 |
meetingId | String | class-001 | 课堂唯一 ID;建议仅使用 ASCII 字符,不包含 /、\ 或空格,长度不超过 40 字节。 |
meetingType | String | public | 课堂类型;通常使用 public,会议模式按业务能力传入 meeting。 |
mediaType | String | video | 课堂媒体类型:audio 或 video。 |
loginName | String | teacher-001 | 当前用户唯一 ID;同一 loginName 重复进入会顶掉前一个登录。 |
userName | String | 张老师 | 当前用户在课堂内展示的昵称。 |
userType | String | speaker | 用户角色:speaker 主讲、assistant 助教、listener 听众。 |
d_dimension | String | 1280x720 | 课堂分辨率,推荐固定为 1280x720。 |
beginTime、endTime、topic、onlineMode、d_sharpness、enableNewClassExam、d_enableObjectEraser 和 d_lowLatencyClass;其中 enableNewClassExam 取值 0/1/2/3(不支持 / 选择题 / 填空题 / 两者,见 query 专文),d_lowLatencyClass=0 关闭极速课堂、=1 开启。仅在业务需要时加入,并一并参与服务端签名。极速课堂的完整接入流程见《极速课堂/iOS》。createLive(withQuery:) 的 query 必填。除下表明确标识为必填的字段外,均可按需配置;未赋值时使用 SDK 默认值。UpimeLiveProtocol / UpimeEditorProtocol 配置项。Demo 或 SDK 源码中的其他字段属于内部实现、实验能力或由服务端控制,不作为对外集成配置使用。| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
query | String | - | 必填。通过 createLive(withQuery:) 传入的服务端完整签名 query;不要在客户端修改其中任意参数。 |
userName | String | - | 当前用户名称;通常与 query 中的 userName 保持一致。 |
members | [UpimeUser] | - | 预传课堂成员列表。 |
supportLocalFile | Bool | true | 是否允许在课堂中插入本地文件。 |
enableUserVisible | Bool | false | 为 true 时,UpimeUser.hidden 生效。 |
endRemindTime | Int | 0 | 下课提醒时间,单位秒;不传表示不提醒。 |
redPacketLimit | Int32 | 0 | 红包雨数量上限;大于 0 时生效。 |
defaultPermission | Int32 | 0 | 会议模式默认权限。 |
openFileMode | UpimeOpenFileMode | .picture | 文件打开模式:.picture 图片、.window 窗口。 |
toolBoxTypes | PureUpimeToolBoxType | .none | 百宝箱工具位掩码;.all 为全部工具。 |
enableInteractPPT | Bool | false | 是否开启交互 PPT。 |
teachToolTypes | PureUpimeTeachToolType | 0 | 教具位掩码。 |
supportUndo | Bool | false | 是否支持撤销。 |
useNewSmallboard | Bool | false | 是否使用新版小黑板。 |
supportHighlighter | Bool | false | 是否支持荧光笔。 |
shouldForbiddenScreenShot | Bool | false | 是否禁止截屏。 |
enableVote | Bool | false | 是否支持投票工具。 |
enableSaveBoard | Bool | false | 是否开启保存板书。 |
chatAlertConfig | UInt | 0 | 学生端消息弹框:0 使用本地记录,1 远端开启,2 远端关闭;教师不受影响。 |
enableCtlANS | Bool | true | 是否开启降噪。 |
enableStarShow | Bool | false | 是否显示积分排行榜。 |
recordingPreparationTip | String? | nil | 服务端录制开始前的延时提示文案。 |
hideRecordingIndicator | Bool | false | 是否隐藏课堂中的“录制中”状态。 |
showStudentClassElapsedTime | Bool | false | 学生端是否显示已开课时长。 |
supportCloudBox | Bool | - | 是否显示资料中心入口;开启后需实现 upimeShowCloudDisk。 |
enableBrowser | Bool | - | 是否显示浏览器工具。 |
UpimeDelegate / UpimeEditorDelegate 回调:supportCloudBox = true,并实现 upimeShowCloudDisk(_:checkAi:);upimeVC(_:getExtFileName:result:);upimeVC(_:getPreParseFileName:suffix:result:);"",不能让 SDK 一直等待。Info.plist 已设 FLTEnableImpeller=false。validBegin 为 Unix 秒级时间戳。upimeVCOnClosed 已恢复业务页面,并按需调用 dispose()。