@trtc/calls-uikit-vue2 4.1.0

package/types/TUICallService/locales/ja_JP.d.ts

@@ -0,0 +1,127 @@
+export declare const ja_JP: {
+    hangup: string;
+    reject: string;
+    accept: string;
+    camera: string;
+    microphone: string;
+    speaker: string;
+    'virtual-background': string;
+    'other side reject call': string;
+    'reject call': string;
+    cancel: string;
+    'other side line busy': string;
+    'in busy': string;
+    'call timeout': string;
+    'end call': string;
+    'caller calling message': string;
+    'callee calling video message': string;
+    'callee calling audio message': string;
+    'no microphone access': string;
+    'no camera access': string;
+    'invite member': string;
+    'browser-authorization': string;
+    'mac-privacy': string;
+    'win-privacy': string;
+    'mac-preferences': string;
+    'win-preferences': string;
+    'Please enter userID': string;
+    'View more': string;
+    'people selected': string;
+    'Select all': string;
+    Cancel: string;
+    Done: string;
+    'exist group call': string;
+    "Video call": string;
+    "Voice call": string;
+    "Call End": string;
+    "Switch audio call": string;
+    "Switch video call": string;
+    "Call duration": string;
+    "Call Cancel": string;
+    "Other Side Cancel": string;
+    Decline: string;
+    "Other Side Decline": string;
+    "No answer": string;
+    "Other Side No Answer": string;
+    Answered: string;
+    "Other Side Line Busy": string;
+    "Line Busy": string;
+    'open camera': string;
+    'close camera': string;
+    'open microphone': string;
+    'close microphone': string;
+    'camera enabled': string;
+    'camera disabled': string;
+    'microphone enabled': string;
+    'microphone disabled': string;
+    'speaker enabled': string;
+    'speaker disabled': string;
+    'open speaker': string;
+    'close speaker': string;
+    'wait to be called': string;
+    answered: string;
+    'people in the call': string;
+    'failed to obtain speakers': string;
+    'you have a new call': string;
+    'switch camera': string;
+    join: string;
+    'people on the call': string;
+    "Supports a maximum of 9 people for simultaneous calls": string;
+    you: string;
+    "The network is poor during your current call": string;
+    "The other user network is poor during the current call": string;
+    "TUICallKit init is not complete": string;
+    timeout: string;
+    'kick out': string;
+    'Invited group call': string;
+    'Those involved': string;
+    call: string;
+    'video-call': string;
+    'audio-call': string;
+    search: string;
+    'search-result': string;
+    'Wechat scan right QR code': string;
+    'Use-phone-and-computer': string;
+    'Scan the QR code above': string;
+    'no-user': string;
+    'member-not-added': string;
+    'not-login': string;
+    'login-status-expire': string;
+    'experience-multi-call': string;
+    'not-support-multi-call': string;
+    'input-phone-userID': string;
+    userID: string;
+    'already-enter': string;
+    waiting: string;
+    'camera-opened': string;
+    'camera-closed': string;
+    'microphone-opened': string;
+    'microphone-closed': string;
+    'image-resolution': string;
+    'default-image-resolution': string;
+    'invited-person': string;
+    'video-to-audio': string;
+    me: string;
+    'be-rejected': string;
+    'be-no-response': string;
+    'be-line-busy': string;
+    'be-canceled': string;
+    'voice-call-end': string;
+    'video-call-end': string;
+    'method-call-failed': string;
+    'failed-to-obtain-permission': string;
+    'environment-detection-failed': string;
+    'switchToAudioCall-call-failed': string;
+    'switchToVideoCall-call-failed': string;
+    'microphone-unavailable': string;
+    'camera-unavailable': string;
+    'ban-device': string;
+    'not-supported-webrtc': string;
+    'blacklist-user-tips': string;
+    'is-already-calling': string;
+    'need-init': string;
+    "can't call yourself": string;
+    'accept-error': string;
+    'accept-device-error': string;
+    'call-error': string;
+};

package/types/TUICallService/locales/zh-cn.d.ts

@@ -0,0 +1,123 @@
+export declare const zh: {
+    hangup: string;
+    reject: string;
+    accept: string;
+    camera: string;
+    microphone: string;
+    speaker: string;
+    'open camera': string;
+    'close camera': string;
+    'open microphone': string;
+    'close microphone': string;
+    'video-to-audio': string;
+    'virtual-background': string;
+    'other side reject call': string;
+    'reject call': string;
+    cancel: string;
+    'other side line busy': string;
+    'in busy': string;
+    'call timeout': string;
+    'end call': string;
+    'caller calling message': string;
+    'callee calling video message': string;
+    'callee calling audio message': string;
+    'no microphone access': string;
+    'no camera access': string;
+    'invite member': string;
+    'Invited group call': string;
+    'Those involved': string;
+    waiting: string;
+    me: string;
+    'browser-authorization': string;
+    'mac-privacy': string;
+    'win-privacy': string;
+    'mac-preferences': string;
+    'win-preferences': string;
+    'Please enter userID': string;
+    'View more': string;
+    'people selected': string;
+    'Select all': string;
+    Cancel: string;
+    Done: string;
+    'exist group call': string;
+    'camera enabled': string;
+    'camera disabled': string;
+    'microphone enabled': string;
+    'microphone disabled': string;
+    'speaker enabled': string;
+    'speaker disabled': string;
+    'open speaker': string;
+    'close speaker': string;
+    'wait to be called': string;
+    answered: string;
+    'people in the call': string;
+    'failed to obtain speakers': string;
+    'you have a new call': string;
+    'switch camera': string;
+    join: string;
+    'people on the call': string;
+    "Supports a maximum of 9 people for simultaneous calls": string;
+    you: string;
+    "The network is poor during your current call": string;
+    "The other user network is poor during the current call": string;
+    "TUICallKit init is not complete": string;
+    "Video call": string;
+    "Voice call": string;
+    "Call End": string;
+    "Switch voice call": string;
+    "Switch video call": string;
+    "Call duration": string;
+    "Call Cancel": string;
+    "Other Side Cancel": string;
+    Decline: string;
+    "Other Side Decline": string;
+    "No answer": string;
+    "Other Side No Answer": string;
+    Answered: string;
+    "Other Side Line Busy": string;
+    "Line Busy": string;
+    timeout: string;
+    'kick out': string;
+    call: string;
+    'video-call': string;
+    'audio-call': string;
+    search: string;
+    'search-result': string;
+    'Wechat scan right QR code': string;
+    'Use-phone-and-computer': string;
+    'Scan the QR code above': string;
+    'no-user': string;
+    'member-not-added': string;
+    'not-login': string;
+    'login-status-expire': string;
+    'experience-multi-call': string;
+    'not-support-multi-call': string;
+    'input-phone-userID': string;
+    userID: string;
+    'already-enter': string;
+    'image-resolution': string;
+    'default-image-resolution': string;
+    'invited-person': string;
+    'be-rejected': string;
+    'be-no-response': string;
+    'be-line-busy': string;
+    'be-canceled': string;
+    'voice-call-end': string;
+    'video-call-end': string;
+    'method-call-failed': string;
+    'failed-to-obtain-permission': string;
+    'environment-detection-failed': string;
+    'switchToAudioCall-call-failed': string;
+    'switchToVideoCall-call-failed': string;
+    'microphone-unavailable': string;
+    'camera-unavailable': string;
+    'ban-device': string;
+    'not-supported-webrtc': string;
+    'blacklist-user-tips': string;
+    'is-already-calling': string;
+    'need-init': string;
+    "can't call yourself": string;
+    'accept-error': string;
+    'accept-device-error': string;
+    'call-error': string;
+};

package/types/TUICallService/serve/callManager.d.ts

@@ -0,0 +1,11 @@
+export declare class CallManager {
+    private _globalCallPagePath;
+    init(params: any): Promise<void>;
+    private _watchTUIStore;
+    private _unwatchTUIStore;
+    private _handleCallStatusChange;
+    private _handleCallStatusToCalling;
+    private _handleCallStatusToIdle;
+    getRoute(): any;
+    destroyed(): Promise<void>;
+}

package/types/TUICallService/utils/common-utils.d.ts

@@ -0,0 +1,62 @@
+export declare const isUndefined: (input: any) => boolean;
+export declare const isPlainObject: (input: any) => boolean;
+export declare const isArray: (input: any) => boolean;
+export declare const isPrivateKey: (key: string) => boolean;
+export declare const isUrl: (url: string) => boolean;
+/**
+ * 检测input类型是否为string
+ * @param {*} input 任意类型的输入
+ * @returns {Boolean} true->string / false->not a string
+ */
+export declare const isString: (input: any) => boolean;
+export declare const isBoolean: (input: any) => boolean;
+export declare const isNumber: (input: any) => boolean;
+export declare function formatTime(secondTime: number): string;
+export declare function formatTimeInverse(stringTime: string): number;
+export declare function isJSON(str: string): boolean;
+export declare const JSONToObject: (str: string) => any;
+/**
+ * 重试函数, catch 时，重试
+ * @param {Promise} promise 需重试的函数
+ * @param {number} num 需要重试的次数
+ * @param {number} time 间隔时间（s）
+ * @returns {Promise<any>} im 接口的 response 原样返回
+ */
+export declare const retryPromise: (promise: Promise<any>, num?: number, time?: number) => Promise<any>;
+/**
+ * web call engine 重复调用时的错误, 这种错误在 TUICallKit 应该忽略
+ * @param {any} error 错误信息
+ * @returns {Boolean}
+ */
+export declare function handleRepeatedCallError(error: any): boolean;
+/**
+ * 设备无权限时的错误处理
+ * @param {any} error 错误信息
+ * @returns {Boolean}
+ */
+export declare function handleNoDevicePermissionError(error: any): boolean;
+export declare function performanceNow(): number;
+/**
+ * 检测input类型是否为function
+ * @param {*} input 任意类型的输入
+ * @returns {Boolean} true->input is a function
+ */
+export declare const isFunction: (input: any) => boolean;
+export declare const getLanguage: () => string;
+export declare function noop(e: any): void;
+/**
+ * Get the object type string
+ * @param {*} input 任意类型的输入
+ * @returns {String} the object type string
+ */
+export declare const getType: (input: any) => any;
+export declare function modifyObjectKey(obj: any, oldKey: any, newKey: any): any;
+/**
+ * interpolate function
+ * @param {string} str - 'hello {{name}}'
+ * @param {object} data - { name: 'sam' }
+ * @returns {string} 'hello sam'
+ *
+*/
+export declare function interpolate(str: any, data: any): any;
+export declare function initBrowserCloseDetection(callback: Function): void;

package/types/TUICallService/utils/decorators/promise-retry.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 异步函数重试 Interface
+ * @param {number} [retries = 5] 重试次数
+ * @param {number} [timeout = 2000] 重试间隔时间
+ * @param {Function=} onError 重试错误回调
+ * @param {Function=} onRetrying 重试回调
+ * @param {Function=} onRetryFailed 重试失败回调
+ */
+interface IPromiseRetryDecoratorSettings {
+    retries?: number;
+    timeout?: number;
+    onError?: Function;
+    onRetrying?: Function;
+    onRetryFailed?: Function;
+}
+/**
+ * 装饰器函数：给异步函数增加重试
+ * @param {Object} settings 入参
+ * @returns {Function}
+ * @example
+ * class LocalStream {
+ *   @promiseRetryDecorator({
+ *     retries: 10,
+ *     timeout: 3000,
+ *     onRetryFailed: function(error) {
+ *     }
+ *   })
+ *   async recoverCapture(options) {}
+ * }
+ */
+export default function promiseRetryDecorator(settings: IPromiseRetryDecoratorSettings): (target: any, name: any, descriptor: any) => any;
+export {};

package/types/TUICallService/utils/env.d.ts

@@ -0,0 +1,10 @@
+export declare const IN_WX_MINI_APP: boolean;
+export declare const IN_UNI_NATIVE_APP: boolean;
+export declare const IN_MINI_APP: boolean;
+export declare const IN_UNI_APP: boolean;
+export declare const IN_BROWSER: boolean;
+export declare const APP_NAMESPACE: any;
+export declare const IS_H5: boolean;
+export declare const IS_PC: boolean;
+export declare const IS_WIN: any;
+export declare const IS_MAC: any;

package/types/TUICallService/utils/index.d.ts

@@ -0,0 +1,2 @@
+export declare function checkLocalMP3FileExists(src: string): Promise<boolean>;
+export declare function deepClone(obj: any): any;

package/types/TUICallService/utils/is-empty.d.ts

@@ -0,0 +1,2 @@
+declare const isEmpty: (input: any) => boolean;
+export default isEmpty;

package/types/TUICallService/utils/retry.d.ts

@@ -0,0 +1,36 @@
+/**
+ * 给异步函数封装重试逻辑
+ * @param {Object} options 重试逻辑入参
+ * @param {Object} options.retryFunction 需要封装的异步函数
+ * @param {Object} options.settings 重试属性
+ * @param {Number} [options.settings.retries = 5] 重试次数
+ * @param {Number} [options.settings.timeout = 1000] 重试间隔
+ * @param {onErrorCallback} options.onError 重试错误回调
+ * @param {onRetryingCallback} [options.onRetrying] 重试后的回调
+ * @param {Object} options.context 上下文，可选
+ * @returns {Function} 封装后的函数
+ * @example
+ * const getUserMedia = promiseRetry({
+ *   retryFunction: getUserMedia_,
+ *   settings: { retries: 5, timeout: 2000 },
+ *   onError: (error, retry, reject) => {
+ *     if (error.name === 'NotReadableError') {
+ *       retry();
+ *     } else {
+ *       reject(error);
+ *     }
+ *   },
+ *   onRetrying: retryCount => {
+ *     console.warn(`getUserMedia NotReadableError observed, retrying [${retryCount}/5]`);
+ *   }
+ * });
+ */
+declare function promiseRetry({ retryFunction, settings, onError, onRetrying, onRetryFailed, context }: {
+    retryFunction: any;
+    settings: any;
+    onError: any;
+    onRetrying: any;
+    onRetryFailed: any;
+    context: any;
+}): (...args: any[]) => Promise<unknown>;
+export default promiseRetry;

package/types/TUICallService/utils/timer.d.ts

@@ -0,0 +1,64 @@
+/// <reference types="node" />
+/**
+ * 定时器，功能：
+ * 1. 支持定时执行回调 [1,n] 次，用于常规延迟、定时操作
+ * @example
+ * // 默认嵌套执行，count=0 无限次
+ * timer.run(callback, {delay: 2000});
+ * // count=1 等同于 原始setTimeout
+ * timer.run(callback, {delay: 2000, count:0});
+ * 2. 支持 RAF 执行回调，用于小流渲染，audio音量获取等任务，需要渲染频率稳定，支持页面退后台后，用 setTimeout 接管，最短 1s 执行一次
+ * @example
+ * // 默认60fps，可以根据单位时长换算，默认开启后台执行
+ * timer.run('raf', callback, {fps: 60});
+ * // 设置执行次数
+ * timer.run('raf', callback, {fps: 60, count: 300, backgroundTask: false});
+ * 3. 支持空闲任务执行回调, requestIdleCallback 在帧渲染的空闲时间执行任务，可以用于 storage 写入等低优先级的任务
+ * @example
+ * // 支持原生setInterval 但不推荐使用，定时任务推荐用 timeout
+ * timer.run('interval', callback, {delay:2000, count:10})
+ */
+declare class Timer {
+    static taskMap: Map<any, any>;
+    static currentTaskID: number;
+    static generateTaskID(): number;
+    /**
+     *
+     * @param {string} taskName 'interval' 'timeout'
+     * @param {function} callback
+     * @param {object} options include:
+     * @param {number} options.delay millisecond
+     * @param {number} options.count 定时器回调执行次数，0 无限次 or n次
+     * @param {boolean} options.backgroundTask 在页面静默后是否继续执行定时器
+     */
+    static run(taskName: any, callback: any, options: any): any;
+    /**
+     * 定时循环执行回调函数
+     * 可以指定循环的时间间隔
+     * 可以指定循环次数
+     * @param {object} taskItem
+     * @param {function} callback
+     * @param {*} delay
+     * @param {*} count
+     * @returns ID
+     */
+    static interval(taskItem: any): NodeJS.Timer;
+    /**
+     * 延迟执行回调
+     * count = 0,循环
+     * count = n, 执行n次
+     * @param {object} taskItem
+     *
+     */
+    static timeout(taskItem: any): NodeJS.Timeout;
+    static hasTask(taskID: any): boolean;
+    static clearTask(taskID: any): boolean;
+    /**
+     * 1. 如果已移除出定时队列，退出当前任务
+     * 2. 如果当前任务已满足次数限制，则退出当前任务
+     * @param {object} taskItem
+     * @returns
+     */
+    static isBreakLoop(taskItem: any): boolean;
+}
+export default Timer;

package/types/TUICallService/utils/validate/avoidRepeatedCall.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 装饰器：阻止函数重复调用
+ * @export
+ * @param {Object} options 入参
+ * @param {Function} options.fn 函数
+ * @param {Object} options.context 上下文对象
+ * @param {String} options.name 函数名
+ * @returns {Function} 封装后的函数
+ */
+export declare function avoidRepeatedCall(): (target: any, name: string, descriptor: any) => any;

package/types/TUICallService/utils/validate/index.d.ts

@@ -0,0 +1,2 @@
+import { avoidRepeatedCall } from './avoidRepeatedCall';
+export { avoidRepeatedCall, };

package/types/TUICallService/utils/validate/validateConfig.d.ts

@@ -0,0 +1,188 @@
+import { VideoResolution, VideoDisplayMode } from "../../const/index";
+export declare const VALIDATE_PARAMS: {
+    init: {
+        SDKAppID: {
+            required: boolean;
+            rules: any[];
+            allowEmpty: boolean;
+        };
+        userID: {
+            required: boolean;
+            rules: any[];
+            allowEmpty: boolean;
+        };
+        userSig: {
+            required: boolean;
+            rules: any[];
+            allowEmpty: boolean;
+        };
+        tim: {
+            required: boolean;
+            rules: any[];
+        };
+    };
+    call: {
+        userID: {
+            required: boolean;
+            rules: any[];
+            allowEmpty: boolean;
+        };
+        type: {
+            required: boolean;
+            rules: any[];
+            range: number[];
+            allowEmpty: boolean;
+        };
+        roomID: {
+            required: boolean;
+            rules: any[];
+            range: string;
+            allowEmpty: boolean;
+        };
+        strRoomID: {
+            required: boolean;
+            rules: any[];
+            allowEmpty: boolean;
+        };
+        userData: {
+            required: boolean;
+            rules: any[];
+            allowEmpty: boolean;
+        };
+        timeout: {
+            required: boolean;
+            rules: any[];
+            allowEmpty: boolean;
+        };
+    };
+    groupCall: {
+        userIDList: {
+            required: boolean;
+            rules: any[];
+            allowEmpty: boolean;
+        };
+        type: {
+            required: boolean;
+            rules: any[];
+            range: number[];
+            allowEmpty: boolean;
+        };
+        groupID: {
+            required: boolean;
+            rules: any[];
+            allowEmpty: boolean;
+        };
+        roomID: {
+            required: boolean;
+            rules: any[];
+            range: string;
+            allowEmpty: boolean;
+        };
+        strRoomID: {
+            required: boolean;
+            rules: any[];
+            allowEmpty: boolean;
+        };
+        timeout: {
+            required: boolean;
+            rules: any[];
+            allowEmpty: boolean;
+        };
+        userData: {
+            required: boolean;
+            rules: any[];
+            allowEmpty: boolean;
+        };
+        offlinePushInfo: {
+            required: boolean;
+            rules: any[];
+            allowEmpty: boolean;
+        };
+    };
+    joinInGroupCall: {
+        type: {
+            required: boolean;
+            rules: any[];
+            range: number[];
+            allowEmpty: boolean;
+        };
+        groupID: {
+            required: boolean;
+            rules: any[];
+            allowEmpty: boolean;
+        };
+        roomID: {
+            required: boolean;
+            rules: any[];
+            allowEmpty: boolean;
+        };
+        strRoomID: {
+            required: boolean;
+            rules: any[];
+            allowEmpty: boolean;
+        };
+    };
+    inviteUser: {
+        userIDList: {
+            required: boolean;
+            rules: any[];
+            allowEmpty: boolean;
+        };
+    };
+    setSelfInfo: {
+        nickName: {
+            required: boolean;
+            rules: any[];
+            allowEmpty: boolean;
+        };
+        avatar: {
+            required: boolean;
+            rules: any[];
+            allowEmpty: boolean;
+        };
+    };
+    enableFloatWindow: {
+        key: string;
+        required: boolean;
+        rules: any[];
+        allowEmpty: boolean;
+    }[];
+    enableAIVoice: {
+        key: string;
+        required: boolean;
+        rules: any[];
+        allowEmpty: boolean;
+    }[];
+    enableMuteMode: {
+        key: string;
+        required: boolean;
+        rules: any[];
+        allowEmpty: boolean;
+    }[];
+    setCallingBell: {
+        key: string;
+        required: boolean;
+        rules: any[];
+        allowEmpty: boolean;
+    }[];
+    setLanguage: {
+        key: string;
+        required: boolean;
+        rules: any[];
+        allowEmpty: boolean;
+    }[];
+    setVideoDisplayMode: {
+        key: string;
+        required: boolean;
+        rules: any[];
+        range: VideoDisplayMode[];
+        allowEmpty: boolean;
+    }[];
+    setVideoResolution: {
+        key: string;
+        required: boolean;
+        rules: any[];
+        range: VideoResolution[];
+        allowEmpty: boolean;
+    }[];
+};

package/types/TUICallService/utils/validate/validateParams.d.ts

@@ -0,0 +1 @@
+export declare function paramValidate(config: any): (target: any, propertyName: string, descriptor: PropertyDescriptor) => PropertyDescriptor;

package/types/TUICallService/utils/validate/validateStatus.d.ts

@@ -0,0 +1,5 @@
+interface IStatusValidateParams {
+    engineInstance?: boolean;
+}
+export declare function statusValidate(config: IStatusValidateParams): (target: any, propertyName: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+export {};