CHANGELOG.md

Change Log
==========

- 标记为 **粗体** 的改动需要特别留意；
- 被标记 `DEPRECATED` 的代码 **将在大版本升级时移除**；
- 带有 `alpha`、`beta`、`rc` 等字样的版本，代码和功能都不稳定，**请勿随意升级**；

## 2.10.2

- 支持抢红包灵敏度处理。

## 2.10.1

- 支持小班课云插播。

## 2.10.0

### 体积优化

- 合并 IJK 播放器，减少 SDK 大小。
- 支持 AVSDK 可选集成，减少 SDK 大小。

### 新增功能

- 聊天支持多条消息置顶，参考 `BJLChatVM` 的 `stickyMessageList`。
- 支持 webrtc 课程设置镜像模式。
- 支持抽奖功能，参考 `BJLRoomVM` 的 `普通抽奖 和 口令抽奖` 模块。
- 支持红包雨在抢完后立即结束，减少无用的抢红包时间。

### 功能优化

- webrtc 混流使用通话音量，优化体验。
- 优化用户音视频状态信令处理，仅台上用户的音视频状态有效，参考 `audioState` 和 `videoState`。
- 支持自定义信令的发送最大每分钟 30 条。

### 问题修复

- 修复计时器暂停时的剩余时间不正确的问题。
- 禁用课件中存在重定向链接时会跳转到 safari 的行为。
- 修复未打开麦克风时，被其他应用占用麦克风时，仍然会停止播放的情况。
- 修复聊天信息偶现崩溃问题。
- 修复文字画笔在触发了画布以外的其他手势的取消状态的情况下，无法调起文字输入框的情况。
- 修复 webrtc 混流静音无效的情况。

## 2.9.4

- 优化 webrtc 加入、离开频道的逻辑，根据实际情况自动加入、离开频道。

## 2.9.3

- 支持随机选人，参考 `BJLRoomVM` 的 `随机选人` 模块。
- 支持多种奖励(点赞)方式，参考 `BJLRoomVM` 的 `awardKey` 和 `BJLAward`。
- 支持自动上报部分崩溃信息。
- 支持腾讯 webrtc 混流(合流)大班课。
- 优化混流(合流)大班课互动体验，音视频与互动同步。

## 2.9.2

- 支持全员，分组点赞，参考 `BJLRoomVM` 的点赞模块。
- webrtc 教室支持设置推流方向。
- 支持接收老师控制教室只看老师，助教，自己，参考 `BJLPlayingVM` 的 `disableAutoPlayVideoExceptPresent` 的属性。
- 支持回调当前是否有选中画笔，参考 `BJLDrawingVM` 的 `hasSelectedShape` 属性。

## 2.9.1

- 非纯 webrtc 教室支持主讲人切换。
- 升级第三方 webrtc 版本。
- 增加小班课教室颜色配置。

## 2.9.0

- 小班课支持动态课件可交互，参考 `BJLSlideshowUI` 的 `updateWebPPTInteractable` 方法。
- 优化画笔同步方式。
- 收到下课时，自动停止云端录制。
- 优化 webrtc 合流，支持助教上课。
- 修复教室销毁时 AVSDK 偶现的崩溃。
- 修复三角形画笔超出边界时显示不正确的问题。
- 修复 H5 课件断网重连偶现画笔不显示的问题。
- 修复 AVSDK 下课后上课偶现拉流黑屏的问题。

## 2.8.2

- 优化 TCP 拉流体验，减少偶现崩溃。 
- 支持只看老师，助教和自己的视频的配置。
- 支持动态切换 webrtc 教室类型。
- 修复举手时长配置无效的问题。
- 优化 APP 在 inactive 状态下的体验。

## 2.8.1

- 修复大班课默认未支持高清的问题。

## 2.8.0

### 问题修复

- 修复线上双师教室偶现的一直处于切换教室中的问题。
- 修复 AVSDK 移除视频的偶现的崩溃。
- 修复偶现的在切换线程过程中对象销毁时，执行了对销毁的对象进行 weak 操作的崩溃。
- 修复用户退到后台时未处理下台信令导致回到前台时未下台的问题。
- 修复由于配置了禁止举手导致不能打开音视频的问题。
- 修复偶现的禁用自动息屏失效问题。

### 新增功能

- 支持设置教室全体镜像翻转，参考 `BJLRecordingVM` 的 `sendEncoderMirrorMode:` 方法。
- 新增用户的音视频状态，参考 `BJLUser` 的 `audioState` 和 `videoState` 属性。
- 声网支持推双路视频流。

### 功能优化

- 水印显示优化，支持不同显示模式下，保持水印显示在视频区域，参考 `BJLPlayingVM` 的 `updateWatermarkWithUser:size:videoContentMode:` 方法。
- 优化麦克风和摄像头授权，优化首次开启音视频体验。
- 优化 tcp 教室互动体验。

## 2.7.6

- 修复三角形画笔在超出边界后显示不正确的问题。

## 2.7.5

- 修复动态课件偶现自动翻页的问题。

## 2.7.4

### 新增功能

- 增加聊天消息置顶功能，参考 `BJLChatVM` 的消息置顶模块。
- 增加播放视频时切换播放的视频的清晰度的接口，目前默认播放高清晰度的视频，建议在不需要高清晰度的情况下，切换成低清晰度的视频，参考 `switchVideoDefinitionWithUser:useLowDefinition:`。
- 全面支持 H5 课件。
- 支持获取用户未开启摄像头时自定义背景图，参考 `BJLUser` 的 `cameraCover` 属性。
- 支持配置小班课是否允许 32 位系统的设备进入教室，参考 `BJLFeatureConfig` 的 `maxStudentsCountFor32BitDevice`。

### bug修复

- 修复 webrtc 课程优势声音会变小的问题。
- 修复 H5 课件偶现自动翻页的问题。
- 修复了部分崩溃和已知问题。

### 功能优化

- 文字画笔支持换行输入。
- 配置了自动开启云端录制的情况下，SDK自动开启云端录制，参考`BJLFeatureConfig` 的 `autoStartServerRecording`。
- 优化摄像头和麦克风授权问题，支持设置 `BJLRecordingVM` 的 `checkMicrophoneAndCameraAccessCallback` 回调统一处理。
- 优化课件翻页限制，禁止未授权的学生以及无权限的助教操作课件。

## 2.7.3

- 修复切换 720 清晰度崩溃的问题。

## 2.7.2

### bug 修复

- 修复 AVSDK 崩溃。
- 修复 webrtc 崩溃。
- 修复聊天文字表情混排时偶现解析崩溃。
- 修复解除全体禁言时导致开启了麦克风的学生被关闭麦克风的问题。

### 新增功能

- 直播增加阿里云上报。
- 新增课程到期被踢出教室的错误码，参考 `BJLErrorCode` 的 `BJLErrorCode_enterRoom_timeExpire`。
- 问答字数限制调整为 280。
- 小班课支持 h5 课件使用，参考 `BJLDocumentPageInfo` 的 `isWebDoc`。
- 大班课支持配置禁止学生课件本地翻页，参考 `BJLFeatureConfig` 的 `disableStudentChangePPTPage`。

### 功能优化

- 大班课上麦学生进入后台不从发言列表中移除。

## 2.7.1

### API 废弃

- 禁止问答用户列表字典属性修改为数组属性，参考 `BJLRoomVM` 中 `fobidQuestionUserNumberList` 废弃，使用 `forbidQuestionList`。
- 废弃以前的一对一和普通小班课教室类型，新增基础一对一教室类型，参考 `BJLConstants.h` 文件中枚举值 `BJLRoomType` 废弃 `BJLRoomType_1to1`，`BJLRoomType_smallClass`， `BJLRoomType_1toN`， 新增 `BJLRoomType_1vNClass` 替代 `BJLRoomType_1toN`，新增 `BJLRoomType_1v1Class`。
- 重命名专业小班课一对一类型，参考 `BJLConstants.h` 文件中 枚举值 `BJLIcTemplateType` 废弃 `BJLIcTemplateType_1to1`，使用 `BJLIcTemplateType_1v1` 替代。

### 新增功能

- 支持腾讯 webrtc 课程。
- 支持专业小班课使用不同颜色区分分组用户，参考 `BJLOnlineUsersVM` 分组模块。
- 支持配置动态课件加载失败时是否使用静态课件，参考 `BJLSlideshowUI` 的 `shouldSwitchNativePPTBlock`。
- 新增 webrtc 课程流畅率统计。

### 功能优化

- avsdk 音视频优化。
- 大班课学生发言状态下退到后台，保持发言状态，不从视频列表中移除。
- 文字画笔点击其画布他区域结束当前的画笔编辑，而不是更新文字画笔位置，支持双击再次编辑文字画笔。
- 停止监课截图。
- 优化图片画笔对于有旋转方向的图片的支持。
- 隐藏用户名为手机号的手机号中间4位数字。

### bug 修复

- 修复画笔在使用过程中取消了画笔权限导致的无法显示的问题。
- 修复开视频前设置使用后置摄像头无效的问题。
- 修复聊天时可能存在聊天内容为 nil 导致的崩溃。
- 修复线上双师的班型,学生从小班进入大班时,分组变为0的问题。

## 2.6.2

- 增加合流时被合流的音视频列表，参考 `BJLPlayingVM` 的 `mixedPlayingUsers` 和 `extraMixedPlayingUsers`。

## 2.6.1

- 支持配置是否允许 32 位设备进入教室，参考 `BJLRoom` 的 `maxAllowedActiveStudentsCountFor32BitDevice` 属性，默认不允许。

## 2.6.0

- 画笔支持马克笔，设置 `BJLDrawingVM` 的 `strokeAlpha` 属性。

- 支持展示文字画笔输入过程。 

- 解决tcp拉流花屏的问题。

## 2.5.0

- 优化音视频体验。

- 支持**任意**用户发送自定义广播信令，参考 `BJLRoomVM` 的 `sendCustomizedBroadcast` 方法。

## 2.4.0

- 支持文字表情混排，参考 `BJLMessage` 中的内容。

- 支持聊天撤回，参考 `BJLChatVM` 的 `revokeMessage` 方法。

- 增加真正上课开始时间，以老师最近一次开始上课的时间为准，参考 `BJLRoomVM` 的 `classStartTimeMillisecond` 属性。

- 增加大班课主视频和 PPT 位置切换回调，参考 `BJLRoomVM` 的 `didVideoExchangePositonWithPPT` 方法。

## 2.3.1

- 修复大班课分组公告偶现无数据的问题。

## 2.3.0

- 增加开关麦克风和摄像头的权限检测回调，参考 `BJLRecordingVM` 的 `checkMicrophoneAndCameraAccessCallback`。

- 支持课后评价，参考 `BJLRoomVM` 的 `evaluationRequest`。

- 增加 WebRTC 首帧到达回调，参考 `BJLPlayingVM` 的 `playingUserDidFinishLoadingVideo`。

## 2.2.1

- 老师、学生麦克风采集音量支持后台配置。

- 画笔支持旋转。
	- release 环境目前仅支持图片画笔旋转，debug 环境支持所有画笔类型旋转。

- 更新声网依赖版本为 2.8.0。

- AVSDK：学生默认上行链路配置与老师统一，保证老师和上麦学生的交互效果。

- 大班课支持计时器。

- 解决 AVSDK 内存泄漏问题。

- 解决专业版小班课举手被同意后无法打开音视频的问题。

## 2.2.0

- 普通大班课(`self.room.featureConfig.isWebRTC` 为 `NO`)支持设置视频采集方向，参考 `BJLRecordingVM` 的 `videoRecordingOrientation` 属性，可在监听到进入教室成功时设置，上课过程中如需切换，关闭采集后重新打开也可生效；

- 支持设置视频采集、播放画面的显示模式；
  - 通过设置 `BJLRecordingVM` 的 `videoContentMode` 属性修改本地采集画面的显示模式，可在监听到进入教室成功时设置，上课过程中如需切换，关闭采集后重新打开也可生效；
  - 通过设置 `BJLPlayingVM` 的 `videoContentMode` 属性修改播放画面的显示模式，可在监听到进入教室成功时设置，上课过程中如需切换，关闭采集后重新打开也可生效。

 - 支持专业小班课 1V1 模板，参考 `BJLIcTemplateType_1to1`，支持辅助摄像头和屏幕共享授权，参考 `BJLRecordingVM` 的 `音视频采集权限` 部分
 
 - 支持获取课后表情报告，后台需要配置才能生成报告，参考 `enableExpressExport`。使用流程参考 `BJLRoomVM` 的 `表情报告` 部分。

- 修复大班课使用画笔时，双击会导致静态PPT放大的问题。

- 修复小班课未上台用户能够打开音视频的问题。

- avsdk 课程支持流畅率上报

## 2.1.0

### 音视频

- 普通大班课支持全局静音。
	- `BJLMeidaVM` 的 `needMutePlayingAudio` 属性表示是否静音，通过 `updateNeedMutePlayingAudio:` 方法控制。

- 支持进入声网教室。
	- `BJLFeatureConfig` 的 `playerType` 属性为 `BJLPlayerType_AGORA` 时表示该教室音视频使用声网技术;
	- 声网教室可通过百家云后台创建，如果需要开通声网教室或了解具体细节，可以与百家云商务沟通。

### 课件

- 大班课课件支持多白板。
	- 单页白板实例为 `BJLSlidePage` 类型，`documentID` 均为 `0`，`slidePageIndex` 表示序号；
	- 通过 `BJLDocumentVM` 的 `addWhiteboardPage` 添加一页白板，`deleteWhiteboardPageWithIndex:` 方法删除对应 `slidePageIndex` 的白板页；
	- 通过监听 `BJLDocument` 的 `didAddWhiteboardPage:` 方法获取白板页添加通知，监听 `didDeleteWhiteboardPageWithIndex:` 方法获取白板页删除通知。

- 大班课课件动画效果支持即时开关。
	- 通过设置 `BJLRoom` 的 `disablePPTAnimation` 属性开关课件动效，设置之后立即生效；
	- 课件动效仍然受后台配置影响，如账号在百家云后台配置了禁用动效，则设置该属性也无法打开。

- 大班课支持设置禁止学生翻页。
	- 通过设置 `BJLOnlineUserVM` 的 `forbidStudentChangePPT` 属性控制。

- 课件备注。
	- 通过 `BJLSlideshowUI` 定义的 `updateShowPPTRemarkInfo:` 方法控制课件模块备注信息的显示、隐藏。

- 虚线画笔。
	- `BJLDrawingVM` 的 `isDottedLine` 属性表示将要画的画笔是否为虚线，根据需要设置，目前只支持 `BJLDrawingShapeType_doodle` 类型的画笔。

- 动效课件当前页信息精确到动画步数。
	- `BJLDocumentVM` 的 `currentSlidePage` 属性表示教室内的当前页，它的 `step` 属性表示当前的动画步数，仅用于动效 PPT。

### 测验

- 新版测验支持 native 方式集成。
	- 参考 `BJLRoomVM` 的 `测验 V2 native 方式` 部分。

- 专业版小班课支持答题器
	- 与大班课答题器 API 相同。

### 其它

- 分组公告。
	- `BJLNotice` 的 `groupNoticeList` 表示教室内各小组的公告，数组元素为 `BJLNoticeModel` 类型。

- 用户列表支持分组显示。
	- 教室内分组信息参考 `BJLOnlineUserVM` 的 `分组` 部分；
	- `BJLOnlineUserVM` 的 `hasMoreOnlineUsersofGroup:` 获取某一个分组是否有更多在线用户未加载，`loadMoreOnlineUsersWithCount:groupID:` 加载对应分组的更多在线用户。

- 红包雨
	- 参考 `BJLRoomVM` 的 `红包雨` 部分。

- 禁言状态下可私聊老师及助教。