Netless

Netless

  • 通用文档
  • 常见问题
  • JavaScript
  • Android
  • iOS
  • Server
  • GitHub
  • 🇬🇧 English

›产品概述

产品概述

  • 使用须知
  • 开源项目
  • 版本历史

快速开始

  • 概述
  • 客户端集成
  • 初始化 SDK
  • 创建房间/获取房间信息
  • 加入房间
  • 生命周期以及事件回调

常用功能

  • 文档转换与播放
  • 状态管理
  • 教具使用
  • 视角操作
  • 白板操作
  • 自定义事件
  • 页面(场景)管理
  • 大课只读
  • 回放
  • RTC 混音

升级指南

  • 2.9.0迁移指南

版本历史

Whiteboard 版本记录

  • 基于 White-SDK-iOS 基础上,整理结构,进行开源。 开源版本,版本在旧版本数字基础上迭代增加。

迁移方法:

更改Podfile文件

# 删除 pod 'White-SDK-iOS'
# 添加以下内容
  pod 'Whiteboard'

将项目中import <White-SDK-iOS/WhiteSDK.h>引用,更改为import <Whiteboard/Whiteboard.h>。

[2.10.0] - 2020-10-10

  • 同步更新 web sdk 至 2.10.1 版本(无断代更新内容)
  • 支持显示web 端通过 iframe 插件(@netless/iframe-bridge)插入的 iframe 插件,类似音视频插件,native 无需进行修改,只需要更新至 2.10.0 版本即可

[2.9.19] - 2020-09-23

  • 同步 web sdk 至 2.9.17 版本
  • 增加 redo undo 可以操作步数回调,具体见WhiteRoomCallbackDelegate协议
  • 更新头像教具显示组件,修复没有传入 userPayload 时,无法显示的问题

[2.9.18] - 2020-09-15

  • 切换头像显示组件UI,web 端可以切换至@netless/cursor-tool即可保持一致,新组件支持cursorName,avatar字段。

[2.9.17] - 2020-09-10

  • 同步 web sdk 至 2.9.16 版本
  • 修复部分房间,回放时音频插件内容会自动全屏的问题
  • 优化 WhiteboardView,支持用户使用子类继承

[2.9.16] - 2020-09-03

  • 同步 web sdk 至 2.9.15 版本

[2.9.15] - 2020-08-24

  • 同步 web sdk 至 2.9.14 版本
  • 添加 RTC 混音接口,具体实现,见 SDK repo 中的 RTC 分支

[2.9.14] - 2020-08-10

  • 修复room.phase属性不正确,必须使用异步 API 获取的问题
  • 修复 PPT 视频在播放结束后,可能变空白的问题
  • 修复 sdkSetupFail回调检测错误的问题
  • PPT 视频支持同步(需要同步使用 white-web-sdk 2.9.13)

[2.9.13] - 2020-07-22

  • 同步 web SDK 至 2.9.12
  • 修复以下情况时,webView 中 SDK 初始化/启动失败,没有任何通知的问题。回调通知在 WhiteCommonCallbackDelegate代理中新增的sdkSetupFail:方法中;更多具体内容,见源码注释。
    1. 当传入非法 AppIdentifier
    2. 当获取用户配置信息失败时(例如无网络)
  • 修复 webView 中 SDK 初始化失败,导致加入房间,回放房间 API 一直没有回调的问题。

[2.9.12] - 2020-07-16

  • 同步 web SDK 至 2.9.11
  • 新增动态 ppt 中音视频播放暂停回调,具体见 WhiteCommonCallbackDelegate代理中pptMediaPlay:``pptMediaPause:方法及其注释

[2.9.11] - 2020-07-09

  • 修复白板背景色 API 设置失效问题

[2.9.10] - 2020-07-07

  • 同步 web SDK 至 2.9.10
  • 优化截图 API

[2.9.9] - 2020-07-07

  • 同步 web SDK 至 2.9.9
  • 修复 native 端动态 PPT 翻页后媒体仍然在播放的 bug

[2.9.8] - 2020-07-03

  • 优化音视频插件

[2.9.7] - 2020-07-02

  • 优化音视频插件,修复 native 进入房间时,正在播放的音视频进度不一致

[2.9.6] - 2020-07-01

  • 同步更新 white-web-sdk 至 2.9.8
  • 修复动态 PPT 字体重复下载导致的内存占用过多的问题

[2.9.5] - 2020-06-30

  • 同步更新 white-web-sdk 至 2.9.7
  • 提高 canvas 引擎兼容性

[2.9.4] - 2020-06-25

  • 同步更新 white-web-sdk 至 2.9.4 版本
  • 修复WhiteContentModeConfig中scale为 0 时,实际为 1 的问题

[2.9.3] - 2020-06-23

  • 同步更新 white-web-sdk 至 2.9.3 版本
  • 新增抓手``激光笔教(见WhiteApplianceNameKey)
  • 橡皮教具disableEraseImage属性,支持中途切换(见Room disableEraseImage:API)
  • Room 新增撤销,取消撤销(开启该功能前,请先阅读disableSerialization:介绍)
  • Room 提供复制,粘贴,副本,删除 API,可以对选中的内容,执行上述操作(见WhiteRoom 执行操作 API 部分)
  • RoomConfig 弃用disableOperations,新增disableCameraTransform API,与disableDeviceInputs搭配,可以起到同样效果。

[2.9.2] - 2020-06-13

  • 修复 userPayload 显示问题,保持与 web 端一致的显示逻辑。

[2.9.1] - 2020-06-10

  • iOS 11及其以下,画笔渲染引擎更改为 svg模式,兼容低版本设备。

[2.9.0] - 2020-06-09

  • 优化底层渲染系统,画笔教具渲染引擎,默认为Canvas,svg为兼容模式。
  • WhiteMemberState新增直线``箭头教具。
  • WhitePlayerConfig``audioUrl属性更改为mediaURL,效果不变。
  • WhiteSdkConfiguration:
    1. 删除zoomMinScale,zoomMaxScale属性。限制视野需求,请阅读WhiteRoomConfig,WhiterPlayerConfig以及WhiteCameraBound相关类和 API。
    2. 移除sdkStrategyConfig属性。
    3. debug属性更改为log属性,效果不变。
  • 移除WhiteOriginPrefetcher,SDK 采用更智能的链路选择,WhiteOriginPrefetcher类的预热结果对 SDK 不再有效果。
  • WhiteCameraBound增加初始化方法,方便从zoomMinScale``zoomMaxScale迁移的用户。
  • WhiteImageInformation类,预埋locked字段。
  • 删除部分弃用 API

[2.8.1] - 2020-05-22

  • 修复预热器数据造成的 sdk 连接失败问题。2.8.0 开始,不再需要预热功能。

[2.8.0] - 2020-05-14

  • 不兼容改动:SDK 初始化时,新增必填项:APP identitier,获取方式,请查看 APP identitier
  • 开放画笔渲染引擎选项,新增 canvas 渲染模式(需要主动选择)
  • 修复isWritable=false用户无法跟随新主播的问题

[2.7.13] - 2020-05-07

  • 修复 2.7.11 引入导致动态 ppt 中音视频无法正常播放的问题

[2.7.12] - 2020-05-06

  • 动态 ppt 视频,增加封面

[2.7.11] - 2020-04-28

  • 修复动态 ppt 中途加入,视频无法播放的问题

[2.7.10] - 2020-04-28

  • 加入房间,回放 API,兼容重复调用(房间,回放实例会以最后一次成功回调为准)

[2.7.9] - 2020-04-20

  • 添加主线程检查,并保证主线程调用

[2.7.8] - 2020-04-16

  • 修复 ppt 媒体进度条位置不对的问题

[2.7.7] - 2020-04-16

  • 修复使用 WhiteCombinePlayer 回放时,拔出耳机等行为会导致崩溃的问题

[2.7.6] - 2020-04-16

  • 修复动态 ppt 中,音频结束后无法重新播放的问题

[2.7.5] - 2020-04-13

  • 修复音频插件,播放时自动全屏的问题

[2.7.4] - 2020-04-12

  • 优化音视频插件
  • 增加获取房间所有场景 API(见 WhiteDisplayer getEntireScenes: 方法)

[2.7.3] - 2020-03-28

  • 统一动态 ppt 粗体显示

[2.7.2] - 2020-03-25

  • 增加动态 ppt 图片加载失败的通知

[2.7.1] - 2020-03-22

  • 优化了建连速度
  • 动态 PPT 修复在 iOS 下换行不正确问题
  • 修复了 canvas 模式下若干显示错误
  • 兼容非音视频系统用户,但鉴权速度较慢

[2.7.0] - 2020-03-18

  • 优化动态 ppt
  • 优化底层显示效率
  • 注意:该版本目前有一定兼容问题,接入自定义音视频插件系统的用户,可以升级(2020 年开始接入的用户,均为该版本);未接入音视频插件的用户请勿升级。如不清楚版本,可以询问服务团队。

[2.6.4] - 2020-03-04

  • 组合播放器,增加音视频单独缓冲开始,结束回调
  • 兼容 iOS 9

[2.6.3] - 2020-03-03

  • 优化只读模式
  • 优化动态 ppt 音视频
  • 新增getScenePathTypeAPI(见 WhiteDisplayer getScenePathType:result:方法)
  • 部分类,增加带参数初始化方法

[2.6.2] - 2020-02-23

  • 优化只读模式
  • 修复回放时,后半段时间回调step失效的问题
  • 修复throwError回调丢失信息的问题

[2.6.1] - 2020-02-20

  • 开放视野限制 API(查看 WhiteCameraBound 类相关内容)
  • 添加回放时间进度回调频率 API(详情见 WhitePlayerConfigstep属性)
  • 添加重连等待时长 API(详见 WhiteRoomConfigtimeout属性)
  • 添加writable只读模式(详情见 WhiteRoomConfigwritable属性,以及 WhiteRoom setWritable:completionHandler:方法)
    • 修正disableOperations:描述为禁止操作API
  • WhiteRoom 追加主动断连标记
  • 修复部分情况下,清屏 API 失效的情况

[2.6.0] - 2020-02-19

  • 优化加入房间API,修复部分情况下,加入房间不回调的问题

[2.5.11] - 2020-02-13

  • 优化低版本 iOS 动态 ppt 显示

[2.5.10] - 2020-02-10

  • 修复插件系统用户,无法查看插件的问题

[2.5.9] - 2020-02-10

  • 修复头像中,教具显示异常问题
  • 修复低版本 iOS 下 index db 问题

[2.5.8] - 2020-02-03

  • 修复图片替换 API
  • 增加预热器功能,使用最快资源
  • 增加倍速播放 API(详情见 WhitePlayer playbackSpeed 属性,以及 CombinePlayer playbackSpeed 属性)

[2.5.7] - 2020-01-13

  • 修复【支持插件系统】的用户,出现无法连接的问题

[2.5.6] - 2020-01-07

  • 更新音视频插件
  • 增加向后兼容可能性
  • 图片拦截功能暂时不可用,将在后续版本恢复

[2.5.5] - 2019-12-31

  • 优化音视频插件
  • 提供多路由选项(WhiteSdkConfiguration routeBackup 属性)

[2.5.4] - 2019-12-26

  • 优化CombinePlayer
  • 优化音视频插件

[2.5.3] - 2019-12-25

  • 提供显示视频,音频插件的功能(内测功能)

[2.5.2] - 2019-12-20

  • 支持动态 ppt 点击动画
  • 新增铺满 ppt API (Displayer scalePptToFit)

[2.5.1] - 2019-12-16

  • 修复新版本refreshViewSize失效的问题

[2.5.0] - 2019-12-14

  • 增加NativeReplayer模块,支持在回放白板内容的同时,同步使用系统AVPlayer播放视频。
  • Native 端调用代码开源
  • 提供视野范围限制API

White-SDK-iOS 版本记录

[2.4.20] - 2019-12-17

  • 修复2.4.15引入的refreshViewSize失效问题

[2.4.19] - 2019-12-10

  • 优化断线重连逻辑
  • 优化 iOS 音频播放

[2.4.18] - 2019-11-27

  • 兼容 iOS 9

[2.4.17] - 2019-11-18

  • 兼容 32 位 CPU(iPhone 5s 之前设备)
  • 修复 disableCameraTransform 时,导致的绘制问题

[2.4.16] - 2019-11-08

  • 颜色只支持整型

[2.4.15] - 2019-11-04

  • 橡皮擦教具,增加禁止擦除图片选项(初始化房间参数配置)
  • 修复 SDK 初始化时,部分传入参数不生效的问题
  • 提取 Player 与 Room 共有方法,迁移进 Displayer 作为父类实例方法(refreshViewSize, convertToPointInWorld, addMagixEventListener, addHighFrequencyEventListener, removeMagixEventListener)

[2.4.14] - 2019-10-29

  • 回放增加 refreshViewSize API
  • 修复了回放时首帧存在快进的问题
  • 修复了文字教具在不同端使用不同字体时,造成的文字截断问题

[2.4.13] - 2019-10-28

  • 修复[2.4.12]造成 iOS 9 崩溃的问题

[2.4.12] - 2019-10-25

  • 增加高频自定义事件 API
  • 优化部分同步问题

[2.4.11] - 2019-10-14

  • 兼容 Xcode10

[2.4.10] - 2019-09-20

  • 优化文字排版
  • 修复横竖屏切换时,视角切换行为
  • 文字教具功能适配 iOS 13

[2.4.9] - 2019-09-11

  • 优化弱网连接
  • 进入实时房间时,提供更多选项(禁止操作,关闭贝塞尔等)
  • 修正房间背景色 API

[2.4.8] - 2019-08-30

  • 优化截图效果

[2.4.7] - 2019-08-24

  • 修复回放时,图片替换 API 失效问题
  • 修复带音视频回放时,PlayerPhase 状态变化回调不及时问题
  • 优化带音视频回放效果,支持重复初始化
  • 优化回放同步获取状态 API
  • 修正主播状态信息类型,无主播时,对应信息为空
  • 修复主动断连时,无回调问题
  • 修正断连回调时,出现两次断连回调
  • 修复处于最大缩放比例时,双指移动异常的问题
  • 更新代码注释,添加更多 nullable 注释,优化对 swift 支持
  • demo 添加部分新 API 调用示例

[2.4.6] - 2019-08-06

  • 修复部分情况下,用户加入白板,无法立刻看到主播端画面的问题

[2.4.4] - 2019-08-02

  • 优化重连逻辑

[2.4.1] - 2019-07-31

  • 修复文字教具再次编辑时,无法弹出完整键盘的问题
  • 增加错误日志上传功能
  • 提供关闭日志上传功能接口(默认打开)
  • 优化断线重连功能

[2.4.0] - 2019-07-25

  • 增加同步获取实时房间,回放房间状态 API
  • 获取在线成员时,可以同时获取各个用户的教具状态,以及透传的用户信息
  • 支持同步自定义全局状态
  • 支持在本地修改白板背景色(不会同步到其他远端)

[2.3.4] - 2019-07-17

  • 适配服务器端动态 PPT,动态 ppt 客户请升级

[2.3.3] - 2019-07-12

  • 适配服务器端动态转换新 API

[2.3.2] - 2019-07-06

  • 支持阿里云跨域图片

[2.3.0] - 2019-07-04

  • 增加场景预览截图 API
  • 增加场景封面截图 API
  • 增加使用 index 切换场景 API

[2.2.2] - 2019-07-02

  • 修复 swift 环境下调用时,回放命令失效的问题

[2.2.0] - 2019-07-01

  • 增加文档转换 API,初始化时,支持自定义动态PPT 中字体链接
  • 增加动态PPT 控制 API
  • 增加视角控制 API

[2.1.3] - 2019-06-24

  • 恢复只读 API(后续将拆分为两个 API)

[2.1.2] - 2019-06-24

  • 兼容旧版本的静态 ppt 回放

[2.1.0] - 2019-06-22

兼容性变化

与之前版本 API 兼容,但是无法与低版本互连,进入同一房间。 可以与 Android 2.0.0 正式版,web 2.0.0 正式版互连,无法与 Android 2.0.0-beta 以及 web 2.0.0-beta 开头的版本互连。

可以回放 2.0.0 开始的房间,但是无法进入 2.1.0 之前的房间。

2019.06.24 前接入的客户,在升级至该版本时,请联系 SDK 团队,确认服务器指向版本。
更多内容,请查看 2.0.0正式版发布

  • 修复文字书写位置,被软键盘覆盖的情况下,键盘消失后,白板整体偏移问题。
  • 增加显示版本功能

[2.0.5] - 2019-06-16

  • 用户头像没有正确缩放
  • 文字教具,键盘无法弹出问题。(开发者目前需要手动管理键盘后,WhiteboardView 中的抖动问题)

[2.0.4] - 2019-06-03

  • 回放增加自定义事件支持
  • 修复 2.0.3-ppt 多人进入房间出现报错

[2.0.3-ppt] - 2019-06-01

  • 支持与 web 端,带动态 ppt 版本连接
  • 修复 2.0.0-ppt 中 pencil 的抖动问题
  • 修复 2.0.0-ppt 中 replay 支持
  • 恢复默认用户头像支持

[2.0.0-ppt] - 2019-05-19

  • 支持与 web 端,带动态 ppt 版本连接

[2.0.3] - 2019-04-12

  • 提供自定义实现用户头像回调参数
  • 提供延时 API

[2.0.2] - 2019-04-03

  • 增加用户信息传入接口
  • 增加显示用户头像功能
  • 增加白板外部坐标转为白板内部坐标

[2.0.1] - 2019-03-13

  • 提供清屏 API(封装 API,并非新 API),提供测试代码
  • 修复 Player 的 seek 问题

[2.0.0] - 2019-03-10

大版本更新,与过去版本API存在部分不兼容。无法与 1.0 版本进行互联。

  • 增加回放 API,并提供回放 API 示例
  • 增加测试用例代码,大部分 API 可以参考测试用例
  • 修改 PPT 翻页 API,并修改示例代码
Last updated on 10/10/2020 by leavesster
← 开源项目概述 →
  • Whiteboard 版本记录
  • [2.10.0] - 2020-10-10
  • [2.9.19] - 2020-09-23
  • [2.9.18] - 2020-09-15
  • [2.9.17] - 2020-09-10
  • [2.9.16] - 2020-09-03
  • [2.9.15] - 2020-08-24
  • [2.9.14] - 2020-08-10
  • [2.9.13] - 2020-07-22
  • [2.9.12] - 2020-07-16
  • [2.9.11] - 2020-07-09
  • [2.9.10] - 2020-07-07
  • [2.9.9] - 2020-07-07
  • [2.9.8] - 2020-07-03
  • [2.9.7] - 2020-07-02
  • [2.9.6] - 2020-07-01
  • [2.9.5] - 2020-06-30
  • [2.9.4] - 2020-06-25
  • [2.9.3] - 2020-06-23
  • [2.9.2] - 2020-06-13
  • [2.9.1] - 2020-06-10
  • [2.9.0] - 2020-06-09
  • [2.8.1] - 2020-05-22
  • [2.8.0] - 2020-05-14
  • [2.7.13] - 2020-05-07
  • [2.7.12] - 2020-05-06
  • [2.7.11] - 2020-04-28
  • [2.7.10] - 2020-04-28
  • [2.7.9] - 2020-04-20
  • [2.7.8] - 2020-04-16
  • [2.7.7] - 2020-04-16
  • [2.7.6] - 2020-04-16
  • [2.7.5] - 2020-04-13
  • [2.7.4] - 2020-04-12
  • [2.7.3] - 2020-03-28
  • [2.7.2] - 2020-03-25
  • [2.7.1] - 2020-03-22
  • [2.7.0] - 2020-03-18
  • [2.6.4] - 2020-03-04
  • [2.6.3] - 2020-03-03
  • [2.6.2] - 2020-02-23
    • [2.6.1] - 2020-02-20
    • [2.6.0] - 2020-02-19
    • [2.5.11] - 2020-02-13
    • [2.5.10] - 2020-02-10
    • [2.5.9] - 2020-02-10
    • [2.5.8] - 2020-02-03
    • [2.5.7] - 2020-01-13
    • [2.5.6] - 2020-01-07
    • [2.5.5] - 2019-12-31
    • [2.5.4] - 2019-12-26
    • [2.5.3] - 2019-12-25
    • [2.5.2] - 2019-12-20
    • [2.5.1] - 2019-12-16
  • White-SDK-iOS 版本记录
    • [2.4.20] - 2019-12-17
    • [2.4.19] - 2019-12-10
    • [2.4.18] - 2019-11-27
    • [2.4.17] - 2019-11-18
    • [2.4.16] - 2019-11-08
    • [2.4.15] - 2019-11-04
    • [2.4.14] - 2019-10-29
    • [2.4.13] - 2019-10-28
    • [2.4.12] - 2019-10-25
    • [2.4.11] - 2019-10-14
    • [2.4.10] - 2019-09-20
    • [2.4.9] - 2019-09-11
    • [2.4.8] - 2019-08-30
    • [2.4.7] - 2019-08-24
    • [2.4.6] - 2019-08-06
    • [2.4.4] - 2019-08-02
    • [2.4.1] - 2019-07-31
    • [2.4.0] - 2019-07-25
    • [2.3.4] - 2019-07-17
    • [2.3.3] - 2019-07-12
    • [2.3.2] - 2019-07-06
    • [2.3.0] - 2019-07-04
    • [2.2.2] - 2019-07-02
    • [2.2.0] - 2019-07-01
    • [2.1.3] - 2019-06-24
    • [2.1.2] - 2019-06-24
    • [2.1.0] - 2019-06-22
    • 兼容性变化
    • [2.0.5] - 2019-06-16
    • [2.0.4] - 2019-06-03
    • [2.0.3-ppt] - 2019-06-01
    • [2.0.0-ppt] - 2019-05-19
    • [2.0.3] - 2019-04-12
    • [2.0.2] - 2019-04-03
    • [2.0.1] - 2019-03-13
    • [2.0.0] - 2019-03-10
Netless
接入即互动
产品
管理控制台官网网站Demo 体验Github
公司
加入我们服务条款隐私协议
联系方式
support@netless.link社区
Copyright © 2020 Netless