@tcic/core-sdk-v1 1.0.5

package/dist/mods/trtc_mobile.d.ts

@@ -0,0 +1,325 @@
+import { TCIC } from '../tcic';
+import { TDeviceStatus } from './deviceStatus';
+import { Av, ITRTC, RemoteVideoConfig, StopRemoteConfig } from './trtc';
+/**
+ * 设备类型
+ * @enum {number}
+ * @readonly
+ * @property {number}  Unknown  值为（-1），Device_Change 事件回调专用
+ * @property {0} Mic 麦克风，Device_Change 事件回调专用
+ * @property {1} Speaker 扬声器，Device_Change 事件回调专用
+ * @property {2} Camera 摄像头，Device_Change 事件回调专用
+ */
+export declare enum TTrtcDeviceType {
+    Unknown = -1,
+    Mic = 0,
+    Speaker = 1,
+    Camera = 2
+}
+/**
+ * 设备信息
+ */
+export interface TTrtcDeviceInfo {
+    /**
+     * 设备类型
+     */
+    type: TTrtcDeviceType;
+    /**
+     * 设备 ID
+     */
+    deviceId: string;
+    /**
+     * 设备名字
+     */
+    deviceName: string;
+}
+export interface TStreamStatus {
+    join?: boolean;
+    audio?: boolean;
+    video?: boolean;
+    screen?: boolean;
+    screenAudio?: boolean;
+    screenPaused?: boolean;
+    mirror?: boolean;
+}
+/**
+ * TRTC模式
+ */
+export declare enum TTrtcMode {
+    /**
+     * 实时音视频模式
+     */
+    RTC = "rtc",
+    /**
+     * 直播模式
+     */
+    Live = "live"
+}
+export declare class TCIC_TRTCMobile implements ITRTC {
+    tcic: TCIC;
+    ready: Promise<boolean>;
+    private _info;
+    private _warn;
+    private _error;
+    private _innerStartLocalPreview;
+    protected _devices: TTrtcDeviceInfo[];
+    protected _micVolume: number;
+    protected _cameraTestStarted: boolean;
+    protected _micTestStarted: boolean;
+    protected _cameraStarted: boolean;
+    protected _micStarted: boolean;
+    private mSdkAppId;
+    private mRoomId;
+    private mUserId;
+    private mUserSig;
+    private mAppMode;
+    private mIsFrontCamera;
+    private mNeedSwitchCameraAfterJoin;
+    private mTrtcTimer;
+    private mEncodeParams;
+    private mRtcInfo;
+    private _volumeInfo;
+    private mRenderMap;
+    private mOpenCamera;
+    private mHasEnableMic;
+    private mIsSwitchRole;
+    private mHeartbeatTimer;
+    private mRenderTask;
+    private mCurRenderTask;
+    private mLastWarnCode;
+    private mLastWarnTimeStamp;
+    protected _publishStatus: TStreamStatus;
+    constructor(tcic: TCIC);
+    init(): Promise<boolean>;
+    /**
+     * 获取摄像头设备列表
+     */
+    getCameras(): Promise<TTrtcDeviceInfo[]>;
+    /**
+     * 切换使用的摄像头设备
+     * @param option.cameraId      要切换的设备ID
+     */
+    switchCamera(option: {
+        cameraId: string;
+        useFrontCamera?: boolean;
+        mirror?: string | boolean | undefined;
+    }): Promise<void>;
+    /**
+     * 获取正在使用的摄像头设备ID
+     */
+    getCameraDeviceId(): Promise<string>;
+    /**
+     * 获取麦克风设备列表
+     */
+    getMics(): Promise<TTrtcDeviceInfo[]>;
+    /**
+     * 切换使用的麦克风设备
+     * @param deviceId      要切换的设备ID
+     */
+    switchMic(_opts: {
+        micId: string;
+    }): Promise<void>;
+    /**
+     * 获取正在使用的麦克风设备ID
+     */
+    getMicDeviceId(): Promise<string>;
+    /**
+     * 设置正在使用的麦克风设备音量
+     * @param volume        要设置的音量大小
+     */
+    setMicVolume(volume: number): Promise<void>;
+    /**
+     * 获取正在使用的麦克风设备音量
+     */
+    getMicVolume(): Promise<number>;
+    /**
+     * 获取正在使用的麦克风设备音量
+     */
+    getRealMicVolume(): Promise<number>;
+    /**
+     * 获取扬声器设备列表
+     */
+    getSpeakers(): Promise<TTrtcDeviceInfo[]>;
+    /**
+     * 切换使用的扬声器设备
+     * @param _deviceId      要切换的设备ID
+     */
+    switchSpeaker(_deviceId: string): Promise<void>;
+    /**
+     * 获取正在使用的扬声器设备ID
+     */
+    getSpeakerDeviceId(): Promise<string>;
+    /**
+     * 设置正在使用的扬声器设备音量
+     * @param volume        要设置的音量大小
+     */
+    setSpeakerVolume(volume: number): Promise<unknown>;
+    /**
+     * 获取正在使用的扬声器设备音量
+     */
+    getSpeakerVolume(): Promise<number>;
+    private createNativeStyle;
+    private onAddRender;
+    private onRemoveRender;
+    enterRoom(isAnchor?: boolean): Promise<void>;
+    private innerGetViewType;
+    stopRemote(opts: StopRemoteConfig): Promise<void>;
+    /**
+     * 查看远端画面，声音
+     * @param opts - 传入希望查看的用户ID
+     */
+    startRemote(opts: RemoteVideoConfig & {
+        isFitMode?: boolean;
+    }): Promise<boolean>;
+    /**
+     * 开始播放本地音视频,默认不自动发布
+     */
+    localPreview(opts: {
+        view: string | HTMLDivElement;
+        publish?: boolean;
+        frameRate?: number;
+    }): Promise<void>;
+    /**
+     * 停止本地预览
+     */
+    stopLocalPreview(opts?: {
+        audio?: boolean;
+        video?: boolean;
+    }): Promise<void>;
+    startLocalVideo(dom: HTMLElement): void;
+    /**
+     * 关闭本地视频采集及渲染
+     */
+    stopLocalVideo(): Promise<void>;
+    startLocalAudio(highAudioQuality: boolean): Promise<void>;
+    /**
+     * 停止本地音频采集
+     */
+    stopLocalAudio(): Promise<unknown>;
+    /**
+     * 发布本地流
+     */
+    /**
+     * 取消发布本地流
+     */
+    unPublish(): Promise<void>;
+    /**
+     * 控制是否屏蔽自己的视频画面，屏蔽后不推流
+     * @param mute        是否屏蔽
+     */
+    muteLocalVideo(mute: boolean): Promise<unknown>;
+    /**
+     * 控制是否屏蔽自己的声音
+     * @param mute        是否屏蔽
+     */
+    muteLocalAudio(mute: boolean): Promise<unknown>;
+    /**
+     * 控制是否屏蔽远端的声音
+     * @param userId      要处理的用户ID
+     * @param mute        是否屏蔽
+     */
+    muteRemoteAudio(userId: string, mute: boolean): Promise<unknown>;
+    /**
+     * 开启音量大小回调，回调直接通过事件抛出
+     * @param interval    回调间隔(最小100ms，0为关闭)
+     */
+    enableVolumeEvaluation(interval: number): Promise<unknown>;
+    /**
+     * 恢复发布内容
+     */
+    resumePublish(opts: {
+        target: Av[];
+    }): Promise<void>;
+    /**
+     *  关闭音视频
+     */
+    mute(opts: {
+        target: Av[];
+    }): Promise<void>;
+    /**
+     *  开启音视频
+     */
+    unmute(opts: {
+        target: Av[];
+    }): Promise<void>;
+    leaveRoom(): Promise<void>;
+    destroy(): Promise<void>;
+    private onEnterRoom;
+    private onExitRoom;
+    private onUserAudioAvailable;
+    private onUserVideoAvailable;
+    private onUserSubStreamAvailable;
+    private onScreenCaptureStarted;
+    private onScreenCaptureStopped;
+    private onScreenCapturePaused;
+    private onScreenCaptureResumed;
+    private onScreenKitEvent;
+    /**
+     *
+     * @param _ret {
+        "head": {
+            "action": "onUserVoiceVolume",
+            "module": "trtccb",
+            "seqid": 55885307087936
+        },
+        "retval": {
+            "totalVolume": 6,
+            "userVolumes": [
+                {
+                    "userId": "2ZhL49DDsM1DuZxNNaBQ3GPTyGt",
+                    "volume": 1
+                },
+                {
+                    "userId": "2XZAx7Rsencu9G7ggV8RVgkr5my",
+                    "volume": 5
+                },
+                {
+                    "userId": "tic_push_user_323777580_163004",
+                    "volume": 0
+                },
+                {
+                    "userId": "2a4Ym5YHbBaqbDLQJSVa0l4ZRZD",
+                    "volume": 0
+                }
+            ]
+        }
+    }
+     */
+    private onUserVoiceVolume;
+    private onMicDidReady;
+    private onCameraDidReady;
+    private onNetworkQuality;
+    private onStatistics;
+    private onError;
+    private onWarning;
+    private onBackPressed;
+    private onConnectionLost;
+    private onConnectionRecovery;
+    private innerStartTrtcTimer;
+    private innerNativeCall;
+    private innerCreateAndroidDom;
+    private innerCreateIOSDom;
+    private innerRemoveNativeDom;
+    private innerStartLocalPreview;
+    private innerRenderUserView;
+    private innerGetStreamId;
+    private innerUpdateCameraStatus;
+    private innerUpdateMicStatus;
+    private innerStopLocalRender;
+    private innerStartLocalRender;
+    private innerStopRemoteRender;
+    private innerStartRemoteRender;
+    private innerAddRenderTask;
+    private innerRemoveRenderTask;
+    private innerProcessRenderTask;
+    private innerMoveOnTask;
+}
+/**
+ * 参考 https://cloud.tencent.com/document/product/647/38552
+ * @param errCode 错误码
+ * @returns 错误信息
+ */
+export declare function getNativeErrorInfo(errCode: number): {
+    deviceStatus: TDeviceStatus.Fail | TDeviceStatus.Not_Found | TDeviceStatus.No_Permission | TDeviceStatus.Busy | TDeviceStatus.Error_1204;
+    errMsg: string;
+};

package/dist/mods/twebview_inner.d.ts

@@ -0,0 +1,84 @@
+export declare class TWebView {
+    private static _instance;
+    private _seqId;
+    private _clientInfo;
+    private whenReady;
+    private reportInstance;
+    constructor();
+    static get instance(): TWebView;
+    /**
+     * init
+     */
+    init(): Promise<boolean>;
+    generateStaticCb(prefix: string, callback: (params: any) => void, report?: boolean): string;
+    /**
+     * 调用Native接口
+     * @param module 模块名称
+     * @param action  接口名称
+     * @param params  参数
+     * @param callback  回调
+     * @param noreport 来上报日志
+     */
+    call(module: string, action: string, params?: any, callback?: (params: any, resolve: any, reject: any) => void, timeout?: number): Promise<unknown>;
+    /**
+     * 退出(移动端专用)
+     */
+    closeWebView(): void;
+    /**
+     * 显示弹窗
+     * @param url 网页地址
+     * @param rect  位置信息
+     * @param callback 回调
+     */
+    showSubWindow(url: string, rect: DOMRect, callback: (code: number, data: any) => void): void;
+    /**
+     * 关闭弹窗自己(由弹窗调用)
+     */
+    closeWebViewSelf(): void;
+    /**
+     * 发消息到webview
+     * @param event 事件名称
+     * @param message 消息内容
+     * @param webid webview标识
+     * @param fromWebId 源webviewId
+     */
+    sendMsgToWebView(event: string, message: any, webid: string, fromWebId: string): void;
+    /**
+     * 注册webview消息回调
+     * @param callback 回调方法
+     * 此方法robinwwang说已废弃, 用 registerNativeRecv 代替.
+     */
+    /**
+     * 发消息到native
+     * @param event 事件名称
+     * @param message 消息内容
+     */
+    sendCustomMessage(message: any): void;
+    /**
+     * 注册native消息回调
+     * @param callback 回调方法
+     */
+    registerNativeRecv(callback: (event: any) => void): void;
+    /**
+     * 注册软键盘监听事件
+     * @param callback 回调方法
+     */
+    registerKeyBoardEvent(callback: (event: any) => void): void;
+    setClientInfo(info: any): void;
+    getClientInfo(): any;
+    inTVList(): boolean;
+    private _generateSeqId;
+    private _generateFuncCallback;
+    /**
+     * isIOS
+     */
+    isIOS(): boolean;
+    isIOS8910(): boolean;
+    /**
+     * isAndroid
+     */
+    isAndroid(): boolean;
+    private _sendIOSChan;
+    private _sendAndroidChan;
+    private _sendChannel;
+}

package/dist/tcic.d.ts

@@ -0,0 +1,319 @@
+import { TCIC_Bussiness } from './business.d';
+export interface CustomContent {
+    scene: string;
+    logo_url: string;
+    home_url: string;
+    js_url: string;
+    css_url: string;
+}
+export interface Member {
+    user_id: string;
+    user_name: string;
+    nickname: string;
+    camera: number;
+    mic: number;
+    silence: number;
+    hand_up: number;
+    board: number;
+    current_state: number;
+    platform: number;
+    mic_state: number;
+    camera_state: number;
+    classroom_code: string;
+    screen: number;
+    screen_state: number;
+    stage: number;
+    hand_up_times: number;
+    mute: number;
+    visible_state: number;
+    last_enter_time: number;
+    device: number;
+    join_classroom_time: number;
+    hand_up_timestamp: number;
+    hand_down_timestamp: number;
+    join_type: number;
+    avatar: string;
+    first_join_timestamp: number;
+    last_quit_timestamp: number;
+    trophy: number;
+    present_time: number;
+    answer_questions: number;
+    location: string;
+    ip_address: string;
+    coordinates: string;
+    mic_times: number;
+    im_count: number;
+    role: number;
+}
+export interface Stream {
+    user_id: string;
+    type: string;
+    url: string;
+}
+export interface RoomInfo {
+    name: string;
+    start_time: number;
+    end_time: number;
+    teacher_id: string;
+    school_id: number;
+    real_start_time: number;
+    real_end_time: number;
+    replay_url: string;
+    chat_group: string;
+    cmd_group: string;
+    status: number;
+    classroom_code: string;
+    resolution: number;
+    audience_type: number;
+    silence_all: number;
+    max_rtc_member: number;
+    forbid_visitor: number;
+    auto_open_mic: number;
+    live_url: string;
+    offstage_mic_control: number;
+    mute_all: number;
+    last_task_seq: number;
+    tasks: unknown[];
+    forbid_fill_in_mic: number;
+    updated_at: number;
+    disable_record: number;
+    audio_quality: number;
+    message_record_url: string;
+    mute_video_all: number;
+    layout: string;
+    rtc_audience_number: number;
+    max_member: number;
+    assistants: string[];
+    enable_direct_control: number;
+    interaction_mode: number;
+    video_orientation: number;
+    is_grading_required_post_class: number;
+    room_type: number;
+    video_duration: number;
+    end_delay_time: number;
+}
+export interface ClassInfo {
+    class_id: number;
+    class_type: number;
+    school_id: number;
+    custom_data: string;
+    class_sub_type: string;
+    rtc_class_info: unknown;
+    live_class_info: unknown;
+    room_info: RoomInfo;
+}
+export interface CommonResponse {
+    error_code: number;
+    error_msg: string;
+    request_id: string;
+}
+export interface MemberJoinedRes extends CommonResponse {
+    interval: number;
+    user_sig: string;
+    members: Member[];
+    timestamp: number;
+    streams: Stream[];
+    permission_list_seq: number;
+    stream_list_seq: number;
+    join_type: number;
+    sub_user_sig: string;
+    like: number;
+    online_number: number;
+}
+export interface SchoolInfoRes extends CommonResponse {
+    school_id: number;
+    name: string;
+    origin_id: string;
+    sdkappid: number;
+    custom_data: string;
+    callback_url: string;
+    feature_black_list: unknown[];
+    custom_content: CustomContent;
+    type: number;
+    callback_key: string;
+    available_terminals: number[];
+}
+export interface ClassInfoRes extends CommonResponse {
+    class_info: ClassInfo;
+}
+/**
+ * 成员类型
+ */
+export declare enum TMemberType {
+    /**
+     * 全部成员
+     */
+    All = 0,
+    /**
+     * 受邀者
+     */
+    Inviter = 1,
+    /**
+     * 访客
+     */
+    Visitor = 2,
+    /**
+     * 离线成员
+     */
+    Offline = 3
+}
+/**
+ * 角色
+ */
+export declare const enum RoleType {
+    student = 0,
+    teacher = 1,
+    assistant = 2,
+    parent = 3,
+    admin = 4
+}
+/**
+ * 房间类型
+ */
+export declare const enum RoomType {
+    rtc = 0,
+    live = 1
+}
+/**
+ * 成员相关操作
+ */
+/**
+ * 成员操作参数
+ */
+export interface TMemberActionParam {
+    /**
+     * 课堂 ID
+     */
+    classId: string;
+    /**
+     * 要操作的用户 ID
+     */
+    userId: string;
+    /**
+     * 操作类型
+     */
+    actionType: TCIC_Bussiness.TMemberActionType;
+}
+export type MemberInfo = TCIC_Bussiness.Item<unknown>;
+/**
+ * TCIC 实例类型，包含基础业务调用
+ * @alpha
+ */
+export declare class TCIC {
+    token: string;
+    userId: string;
+    classId: number;
+    /**
+     * 当前台上用户信息
+     */
+    memberInfo: MemberJoinedRes;
+    /**
+     * 当前课堂信息
+     */
+    classInfo?: ClassInfoRes;
+    /**
+     * 应用信息，例如用户配置的自定义js/css等等
+     */
+    schoolInfo?: SchoolInfoRes;
+    _myInfo?: MemberInfo;
+    _hostInfo?: MemberInfo;
+    playerConf: any;
+    constructor(opts: {
+        token: string;
+        userId: string;
+        classId: number;
+        playerConf?: any;
+    });
+    trtc: any;
+    setTRTC(trtc: any): void;
+    /**
+     * 初始化业务必要信息，
+     * 例如当前房间状态，
+     * 当前应用信息，
+     * 台上用户等等
+     * @param ready - 初始化完成回调
+     */
+    init(opts?: {
+        ready?: () => void;
+        role?: RoleType;
+    }): Promise<void>;
+    private _heartBeatTimer;
+    /**
+     * 心跳启动
+     */
+    private heartBeat;
+    private _memberInfos;
+    /**
+     * 通过ID列表获取用户简要信息
+     * 只有nick和头像
+     * @param ids - 用户ID列表
+     */
+    getUserInfoByIds(ids: string[]): Promise<Member[]>;
+    /**
+     * 停止心跳
+     */
+    private stopHeartBeat;
+    /**
+     * 销毁实例,会结尝试结束房间
+     */
+    destroy(): void;
+    /**
+     * 获取当前登陆用户信息
+     */
+    myInfo(): MemberInfo;
+    /**
+     * 获取当前房主信息
+     */
+    hostInfo(): MemberInfo;
+    /**
+     * 业务流程开启，房间活动开始后
+     * 才可以进行录制，视频等等一系列活动
+     */
+    start(): Promise<unknown>;
+    /**
+     * 业务流程结束，将会通知所有房间内成员下线
+     */
+    end(): Promise<unknown>;
+    leaveRoom(): Promise<unknown>;
+    /**
+     * 获取成员列表详情
+     * @param classId - 课堂ID
+     * @param pager - 分页信息
+     */
+    getMembersDetail(classId: string, pager: Partial<{
+        page: number;
+        limit: number;
+        type: TMemberType;
+        keyword: string;
+    }>): Promise<TCIC_Bussiness.CGI['/v1/member/memberList']['Res']>;
+    /***
+     * 对用户操作，详情参见枚举类型
+     * TCIC_Bussiness.TMemberActionType
+     * @param args - 操作参数，例如踢出等等
+     */
+    memberAction(args: TMemberActionParam): Promise<unknown>;
+    /***
+     * 成员状态上报
+     * TCIC_Bussiness.TMemberActionType
+     * @param state - 操作参数，例如踢出等等
+     */
+    memberStateReport(state: TCIC_Bussiness.TMemberStateReportParam): Promise<unknown>;
+    /**
+     * @param path - 请求地址
+     * @param param - 请求参数
+     */
+    fetchData(path: string, param?: any): Promise<unknown>;
+    getStreamConfig(userId: string, streamType: string): Stream | undefined;
+    private streamConfigs;
+    setStreamConfigs(streamConfigs: Stream[], seq: number): void;
+    /**
+     * 答题接口
+     * @param questionId - 问题ID
+     * @param answer - 答案
+     */
+    answerQuestion(questionId: string, answer: string): Promise<unknown>;
+    /**
+     * 设置上报是否控制台打印
+     */
+    setReportShowConsole(showConsole: boolean): void;
+}