@tcic/core-sdk-v1 1.0.5

package/README-en.md

@@ -0,0 +1,10 @@
+# Real-time Interactive - Education Edition UISDK Overview
+The UISDK is a library that consolidates the core business logic of the Education Edition, providing convenient and easy-to-understand interfaces to meet the requirements of highly customized scenarios.
+
+# Features
+The SDK includes the following modules:
+
+- TCIC: Wraps the concepts of rooms, hosts, and audience in the Education Edition, supporting basic operations on these objects.
+- TIM: Supports real-time data communication within rooms, such as chat and group messaging, enabling various business models like group answering, announcements, and gift distribution.
+- TRTC: Wraps the functionality of real-time video calling, allowing features like live video calls and interactive communication.
+

package/README-inner.md

@@ -0,0 +1,10 @@
+
+
+
+# 流水线
+
+https://zhiyan.woa.com/qci/12221/pipeline/#/pipeline/detail/10798481/build/current
+
+# 文档
+
+https://docs.qcloudclass.com/latest/watchsdk/

package/README.md

@@ -0,0 +1,343 @@
+
+
+# Real time interaction - Education version SDK overview
+
+Real time Interactive Education Edition (formerly Low Code Interactive Classroom, LCIC) is a multifunctional product that integrates audio and video connectivity, interactive whiteboard, and live streaming
+
+（ https://www.tencentcloud.com/document/product/1168/53651 ）
+
+This project is a client-side JavaScript SDK (demo), which allows you to develop and customize your own real-time interactive applications based on the SDK
+
+
+# Core concepts
+
+Room: The room represents a globally unique spatiotemporal place where real-time interaction occurs, identified by the room ID, and can be created by Tencent Cloud API（ https://www.tencentcloud.com/document/product/1168/52794 ）, then you can call the SDK method to join the room and start publishing audio and video streams in the room
+
+
+# Function
+
+ The SDK mainly includes the following modules:
+
+  -TCIC: Packaging the original educational version of concepts such as rooms/homeowners/spectators, supporting the basic operations of these objects.
+
+  -TIM: Supports real-time data communication within the room, such as chatting, all staff messaging, etc. It can achieve various business models such as all staff answering, announcements, gift distribution, etc.
+
+  -TRTC: Real time video call function packaging, which can achieve functions such as connected voice calls.
+
+
+# Demo
+
+https://dev-class.qcloudclass.com/next/
+
+# Demo Code
+
+https://github.com/tencentyun/lcic-UIlessdemo
+
+# Quick Start
+
+1. Install SDK dependencies
+
+## npm
+npm install --save @tcic/core-sdk-v1
+## yarn
+yarn add @tcic/core-sdk-v1
+
+
+2. Import the SDK
+
+```typescript
+import * as SDK from '@tcic/core-sdk-v1';
+```
+
+3. Create the TCIC AND TRTC instance
+
+```javascript
+
+const tcic = SDK.create({
+  userId: 'xxx';  //
+  token: 'token_of_the_userid';
+  classId: 345678; // got from cloud api
+});
+
+const trtcClient = SDK.createTrtcClient(tcic);
+
+```
+
+4. Join the room and create TIM instance
+
+```js
+
+await tcic.init();
+
+const tim = SDK.createTimClient(tcic);
+
+```
+
+5. Local preview your video and audio
+
+```js
+trtcClient.localPreview({
+  view: 'dom-id',
+});
+
+```
+
+6. Start and join the TRTC room, your local preview will beutomatically published to the room.
+
+```js
+await tcic.start();
+await trtcClient.enterRoom();
+```
+
+
+7. Pause your video and audio
+
+```js
+trtcClient.pausePublish({
+  target: ['video', 'audio'],
+});
+```
+
+8. Resume your video and audio
+
+```js
+trtcClient.resumePublish({
+  target: ['video', 'audio'],
+});
+
+```
+
+9. Fetch the room members by page.
+
+```js
+
+tcic.getMembersDetail(classId, {
+  page: 1,
+  limit: 100,
+});
+
+```
+
+10. Automatically play member audio and video. If students have not joined, it will automatically play after students join.
+
+
+```js
+trtcClient.startRemote({
+  view: `dom-id`,
+  streamType: 'main',
+  userId: 'remote-user-id',
+});
+```
+
+11. End the room
+
+```js
+await tcic.end()
+```
+
+
+## Create a white board instance.
+
+```js
+const teduBoard = SDK.createTiw(tcic, 'your-white-board-container-dom-id').instance;
+
+// set up event listeners.
+teduBoard.on(TEduBoard.EVENT.TEB_ERROR, (errorCode, errorMessage) => {
+  console.log('======================:  ', 'TEB_ERROR', ' errorCode:', errorCode, ' errorMessage:', errorMessage);
+});
+
+teduBoard.on(TEduBoard.EVENT.TEB_WARNING, (warnCode, warnMessage) => {
+   console.log('======================:  ', 'TEB_WARNING', ' warnCode:', warnCode, ' warnMessage:', warnMessage);
+});
+
+teduBoard.on(TEduBoard.EVENT.TEB_HISTROYDATA_SYNCCOMPLETED, () => {
+   console.log('======================:  ', 'TEB_HISTROYDATA_SYNCCOMPLETED');
+});
+
+```
+
+
+Synchronize whiteboard operations to remote users by tim.
+```js
+
+// Monitor operations of local whiteboard and sync the operation to the remote user's whiteboard use the tim instance
+teduBoard.on(TEduBoard.EVENT.TEB_SYNCDATA, data => {
+  tim.sendRoomCustomMsg({
+    data: JSON.stringify(data),
+    extension: 'TXWhiteBoardExt'
+  }).then(() => {
+    // sync sucess.
+  }, () => {
+    // sync failed.
+  });
+});
+
+
+```
+
+
+On the remote side:
+```js
+
+tim.on('customMsg', (data, msg)=>{
+  if (msg.data?.content?.extension === 'TXWhiteBoardExt') {
+    if (msg.from != tcic.userId) { // filter out messages sent by yourself.
+      teduBoard.addSyncData(data);
+    }
+  }
+});
+
+
+```
+
+...
+
+for more reference, see: https://doc.qcloudtiw.com/web/official/tutorial-tutorial-2-1.html
+
+
+## API reference
+
+https://docs.qcloudclass.com/latest/tcic_engine/modules.html
+
+
+## RoadMap
+
+The SDK is still under rapid iterative development stage. The subsequent new version will release a signal-based data flow SDK, which will further simplify the usage and add more enhanced and rich capabilities, so stay tuned.
+
+
+
+
+# 中文版:
+
+# 实时互动-教育版无UISDK概述
+
+实时互动-教育版（原低代码互动课堂，LCIC）是一款集成音视频连麦、互动白板和直播等多功能的产品.
+(https://cloud.tencent.com/document/product/1639)
+
+本项目是客户端js SDK (demo), 您可以基于SDK开发定制您自己的实时互动应用
+
+
+# 核心概念
+
+房间: 房间代表一场是全局唯一的实时互动发生的时空场所,用房间ID标识, 您可以通过云api接口(https://cloud.tencent.com/document/product/1639/80942) 创建房间, 然后调用SDK的方法加入房间并开始在房间发布音视频流
+
+
+# 功能
+
+ SDK主要包含以下模块：
+ - TCIC：包装原教育版房间/房主/观众等概念，支持这些对象的基本操作。
+ - TIM：支持房间内实时数据通讯，例如聊天，全员消息等功能，可实现如全员抢答，公告，礼物下发等各种业务模式。
+ - TRTC：实时视频通话功能包装，可实现如连麦通话等功能。
+
+
+# 快速开始
+
+1. 安装SDK依赖
+
+## npm
+npm install --save @tcic/core-sdk-v1
+## yarn
+yarn add @tcic/core-sdk-v1
+
+
+2. 引入依赖
+
+```typescript
+import * as SDK from '@tcic/core-sdk-v1';
+```
+
+3. 初始化实例并加入房间
+
+```javascript
+
+const tcic = SDK.create({
+  userId: 'xxx';  //
+  token: 'token_of_the_userid';
+  classId: 345678; // got from cloud api
+});
+
+const trtcClient = SDK.createTrtcClient(tcic);
+
+```
+
+
+4. 加入课堂并创建tim实例
+
+```js
+
+await tcic.init();
+
+const tim = SDK.createTimClient(tcic);
+
+```
+
+5. 本地预览
+
+```js
+trtcClient.localPreview({
+  view: 'dom-id',
+});
+
+```
+
+6. 开始房间并加入trtc, 本地预览将会自动发布至房间
+
+```js
+await tcic.start();
+await trtcClient.enterRoom();
+```
+
+
+7. 暂停音视频
+
+```js
+trtcClient.pausePublish({
+  target: ['video', 'audio'],
+});
+```
+
+
+8. 恢复音视频
+
+```js
+trtcClient.resumePublish({
+  target: ['video', 'audio'],
+});
+
+```
+
+9. 分页拉取成员列表
+
+```js
+
+tcic.getMembersDetail(classId, {
+  page: 1,
+  limit: 100,
+});
+
+```
+
+10. 自动播放成员音视频, 若学生未加入, 待学生加入后会自动播放
+
+```js
+trtcClient.startRemote({
+  view: `dom-id`,
+  streamType: 'main',
+  userId: 'remote-user-id',
+});
+```
+
+11. 结束房间
+
+```js
+await tcic.end()
+```
+
+## API 参考
+
+https://docs.qcloudclass.com/latest/tcic_engine/modules.html
+
+
+## RoadMap
+
+SDK仍处在快速迭代开发中, 后续新版本将会发布基于signal的数据流SDK, 会进一步简化使用流程, 并加入更多增强丰富的能力,敬请期待.

package/dist/doc_index.d.ts

@@ -0,0 +1,6 @@
+export { TCIC_Bussiness } from './business.d';
+export { TIM_MSG } from './business.d';
+export { TCIC, MemberInfo, ClassInfoRes, MemberJoinedRes, SchoolInfoRes, Stream, TMemberActionParam, TMemberType, Member, ClassInfo, RoomInfo, CustomContent, RoleType, } from './tcic';
+export { create, createTimClient, createTrtcClient, createTiw } from '.';
+export { TCIC_IM, MsgData, MsgBody, MsgContent } from './mods/im';
+export { TCIC_TRTC, RemoteVideoConfig, TRTCSupportResult } from './mods/trtc';

package/dist/index.d.ts

@@ -0,0 +1,41 @@
+import { TCIC_IM } from './mods/im';
+import { TCIC_TRTC } from './mods/trtc';
+import { TCIC_TIW } from './mods/tiw';
+import { TCIC } from './tcic';
+import { debugFatory as Debug } from './utils';
+/**
+ * @alpha
+ * @param opts - 创建TCIC实例,该实例会将房间依赖数据处理好，并暴露业务相关方法，后续的IM和TRTC实例都会依赖该实例
+ * @returns
+ */
+export declare function create(opts: {
+    token: string;
+    userId: string;
+    classId: number;
+    playerConf?: any;
+}): TCIC;
+/**
+ * @alpha
+ * @param target - 创建IM实例对象,IM负责处理系统消息以及文字消息等逻辑。
+ * @returns
+ */
+export declare function createTimClient(target: TCIC): TCIC_IM;
+/**
+ * @alpha
+ * @param target - 创建TRTC实例对象,TRTC负责处理音视频相关逻辑。
+ */
+export declare function createTrtcClient(target: TCIC): TCIC_TRTC;
+/**
+ * @alpha
+ * @param tcic - create a whiteboard instance. whiteboard reference: https://doc.qcloudtiw.com/web/official/tutorial-tutorial-2-1.html
+ * @param domId - the dom id of the whiteboard container
+ */
+export declare function createTiw(tcic: TCIC, domId: string): TCIC_TIW;
+/**
+ * debug工厂函数
+ * @alpha
+ * @example - 使用方式如下:
+ * 'let debug = debugFatory('TC:IM')'
+ * debug('hello')
+ */
+export declare const debugFatory: typeof Debug;

package/dist/lib/error.d.ts

@@ -0,0 +1,20 @@
+export declare const enum ClientErrorCode {
+    /**
+     * 业务逻辑错误，可以通过自行编码解决的错误
+     * 1000 - 1999
+     * 环境问题，需要通过 检测或者兼容完成
+     * 2000 - 2999
+     */
+    TCIC_NOT_INIT = 1002
+}
+export declare class MyError extends Error {
+    code: number;
+    msg: string;
+    data: any;
+    err: any;
+    constructor(opts: {
+        code?: number;
+        msg?: string;
+        data?: any;
+    });
+}

package/dist/mods/actionModule.d.ts

@@ -0,0 +1,12 @@
+export declare const enum ActionModule {
+    TCIC = "TCIC",
+    TRTC = "TRTC",
+    IM = "IM",
+    WHITEBOARD = "WHITEBOARD",
+    RECORD = "RECORD",
+    PLAYER = "PLAYER",
+    REPORT = "REPORT",
+    ERROR = "ERROR",
+    Webview = "Webview",
+    TIW = "TIW"
+}

package/dist/mods/actionName.d.ts

@@ -0,0 +1,83 @@
+export declare const enum ActionName {
+    Init = "Init",
+    Join = "Join",
+    Leave = "Leave",
+    Start = "Start",
+    Stop = "Stop",
+    Pause = "Pause",
+    Resume = "Resume",
+    End = "End",
+    Error = "Error",
+    FetchData = "FetchData",
+    StopHeartBeat = "StopHeartBeat",
+    Destroy = "Destroy",
+    GetMyInfo = "GetMyInfo",
+    GetHostInfo = "GetHostInfo",
+    GetStreamConfig = "GetStreamConfig",
+    SetStreamConfigs = "SetStreamConfigs",
+    GetNativeParams = "GetNativeParams",
+    GenerateStaticCb = "GenerateStaticCb",
+    CallSuccess = "CallSuccess",
+    CallError = "CallError",
+    Call = "Call",
+    SetClientInfo = "SetClientInfo",
+    SendChannel = "SendChannel",
+    RemoteVideoAvailable = "RemoteVideoAvailable",
+    StartRemote = "StartRemote",
+    VideoPlayStateChanged = "VideoPlayStateChanged",
+    EnterRoom = "EnterRoom",
+    IsSupported = "IsSupported",
+    UpdateRemote = "UpdateRemote",
+    StopRemote = "StopRemote",
+    DestroyTcPlayer = "DestroyTcPlayer",
+    GetTcPlayerInstance = "GetTcPlayerInstance",
+    CheckRemoteReady = "CheckRemoteReady",
+    CreateTempTcplayerCont = "CreateTempTcplayerCont",
+    ReuseTcPlayer = "ReuseTcPlayer",
+    UnuseTcPlayer = "UnuseTcPlayer",
+    GetTcPlayerContId = "GetTcPlayerContId",
+    DoWeixinFirstPlay = "DoWeixinFirstPlay",
+    LocalPreview = "LocalPreview",
+    StopLocalPreview = "StopLocalPreview",
+    UnPublish = "UnPublish",
+    ResumePublish = "ResumePublish",
+    Mute = "Mute",
+    Unmute = "Unmute",
+    LeaveRoom = "LeaveRoom",
+    GetCameraList = "GetCameraList",
+    SwitchCamera = "SwitchCamera",
+    GetMicList = "GetMicList",
+    SwitchMic = "SwitchMic",
+    GetSpeakerList = "GetSpeakerList",
+    SetCurrentSpeaker = "SetCurrentSpeaker",
+    TEB_INIT = "TEB_INIT",
+    TEB_HISTROYDATA_SYNCCOMPLETED = "TEB_HISTROYDATA_SYNCCOMPLETED",
+    TEB_ERROR = "TEB_ERROR",
+    TEB_WARNING = "TEB_WARNING",
+    TEB_SYNCDATA = "TEB_SYNCDATA",
+    TEB_IMAGE_STATUS_CHANGED = "TEB_IMAGE_STATUS_CHANGED",
+    TEB_H5PPT_STATUS_CHANGED = "TEB_H5PPT_STATUS_CHANGED",
+    TEB_VIDEO_STATUS_CHANGED = "TEB_VIDEO_STATUS_CHANGED",
+    TEB_SWITCHFILE = "TEB_SWITCHFILE",
+    IM_PAYLOAD_PARSE_ERROR = "IM_PAYLOAD_PARSE_ERROR",
+    IM_SAASADMIN_DATA = "IM_SAASADMIN_DATA",
+    IM_CUSTOM_DATA = "IM_CUSTOM_DATA",
+    IM_TEXT_DATA = "IM_TEXT_DATA",
+    IM_MESSAGE_RECEIVED = "IM_MESSAGE_RECEIVED",
+    IM_SDK_READY = "IM_SDK_READY",
+    IM_LOGIN = "IM_LOGIN",
+    IM_UPDATE_MY_PROFILE = "IM_UPDATE_MY_PROFILE",
+    IM_JOIN_GROUP = "IM_JOIN_GROUP",
+    IM_ON = "IM_ON",
+    IM_OFF = "IM_OFF",
+    IM_CONSUME = "IM_CONSUME",
+    IM_WHEN_READY = "IM_WHEN_READY",
+    IM_DESTROY = "IM_DESTROY",
+    IM_SEND_MSG = "IM_SEND_MSG",
+    IM_SEND_ROOM_MSG = "IM_SEND_ROOM_MSG",
+    IM_SEND_ROOM_IMG_MSG = "IM_SEND_ROOM_IMG_MSG",
+    IM_SEND_ROOM_CUSTOM_MSG = "IM_SEND_ROOM_CUSTOM_MSG",
+    IM_SEND_MSG_TO_USER = "IM_SEND_MSG_TO_USER",
+    IM_SEND_IMG_TO_USER = "IM_SEND_IMG_TO_USER",
+    IM_GET_HISTORY_LIST = "IM_GET_HISTORY_LIST"
+}

package/dist/mods/deviceStatus.d.ts

@@ -0,0 +1,42 @@
+/**
+ * 设备状态
+ * @enum {number}
+ */
+export declare enum TDeviceStatus {
+    /**
+     * 打开失败
+     */
+    Fail = -1001,
+    /**
+     * 找不到设备
+     */
+    Not_Found = -1002,
+    /**
+     * 未授权
+     */
+    No_Permission = -1003,
+    /**
+     * 设备被占用
+     */
+    Busy = -1004,
+    /**
+     * 不支持
+     */
+    Not_Supported = -1005,
+    /**
+     * trtc 1204 错误，可能是被占用，也可能是其他原因 算作一种通用错误
+     */
+    Error_1204 = -1006,
+    /**
+     * 未知
+     */
+    Unknown = 0,
+    /**
+     * 已打开
+     */
+    Open = 1,
+    /**
+     * 已关闭
+     */
+    Closed = 2
+}