@shixin/cube-engine v0.1.6

cube引擎web端sdk

引入

模块化引入

    // @cube是组织名, 假设sdk的名字为web-engine, web-engine目录下面有各模块的文件
    import {Entity} from '@cube/web-engine/CubeMessage.js';
    import * as CubeMessage, {Entity} from '@cube/web-engine/CubeMessage.js';
    import {CubeCore, CubeFile, CubeWhiteboard} from '@cube/web-engine';

    
    const {RichContent} = Entity; 
    cube.loadMessager(CubeMessage.ServiceWorker);

标签引入

    <script src='path/to/cube-core.js'></script>
    <!-- 此处暴露window.cube -->
    
    <script src='path/to/cube-message.js'></script>
    <!-- 此处暴露window.CubeMessage, 其他模块同理 -->
    
    <script>
        window.cube.loadMessager(window.CubeMessage.ServiceWorker);
    </script>

模块内容

Core:

• Service: Service基类
• Listener: Listener基类
• ActionConst: websocket客户端动作常量枚举, 如login等
• Request: 原CubeRequest类
• CubeError: 错误类
• CELLET: 未修改
• StateCode: 自定义请求响应码常量枚举
• Delegate: Delegate基类
• Peer: 端点基类
• Session: 会话类
• AccountListener: 账号服务监听器
• GroupContext: 群组对象数据上下文, 未修改
• RegistrationState: 未修改
• Permission: 未修改
• GroupListener: 群组监听, 未修改
• DeviceListener: 设备监听, 未修改
• EngineState: 原CubeState, 引擎状态常量枚举
• CodecType: 编码类型枚举, 未修改
• DB: 原CubeDB, 暴露两个基类, DBCondition, DBEntity
• cube: Engine实例
• CellCloud: CellCloud
  • UUID: UUID生成工具
  • Base64: Base64库的默认导出
  • HashMap: HashMap类
  • Ajax: Ajax类
  • InetAddress: InetAddress类
  • Utils: 加密方法解密方法工具命名空间
  • Console: 控制台
  • Logger: 打印
  • Service: Service基类
  • TalkListener: TalkListener类
  • TalkService: TalkService类
  • nucleus: Nucleus实例
  • Nucleus: Nucleus类
  • ActionDialect: ActionDialect类

Message:

• Entity: 各种消息类
  • Image: 图片
  • Video: 视频
  • Voice: 音频
  • Card: 卡片
  • Custom: 自定义
  • File: 文件
  • Text: 文本
  • Reply: 回复
  • History: 历史
  • Whiteboard: 白板
  • RichContent: 富文本
  • Location: 位置
• Type: 消息类型枚举
• ServiceWorker: 原MessageServiceWorker
• Listener: 原MessageServiceListener

Instruction:

• ServiceWorker: 原InstructionServiceWorker
  • Listener: 原InstructionListener
  • Instruction: 未修改

Live:

• ServiceWorker: 原LiveServiceWorker
• Listener: 原LiveListener

File

• Manager: FileManager命名空间
  • ServiceWorker: 原FileManagerServiceWorker
  • Listener: 原FileManagerListener
• Info: 原FileInfo
• Type: 原FileType
• Permission: 原FilePermission
• StatusListener: 原FileStatusListener

RemoteDesktop

• ServiceWorker: 原RemoteDesktopServiceWorker
• Listener: 原RemoteDesktopListener

Recorder

• Recorder: 原CubeRecorder
• AdvancedRecorder: 原CubeAdvancedRecorder

Signaling

• CallServiceWorker: 未修改,
• Call: 未修改,
• CallSession: 未修改,
• CallDirection: 未修改,
• CallListener: 未修改,
• VideoSize: 未修改,
• SignalingState: 未修改,
• MediaProbe: 未修改,
• MediaServiceWorker: 未修改

SIPWorker

• ServiceWorker: 原SIPServiceWorker
• Conference: Conference命名空间
  • Listener: 原ConferenceListener
  • Type: 原ConferenceType
  • ServiceWorker: 原ConferenceServiceWorker
  • Config: 原ConferenceConfig

Whiteboard

• Whiteboard: 原CubeWhiteBoard
• ServiceWorker: 原CubeWhiteboardServiceWorker
• Listener: 原CubeWhiteboardListener