@trtc/calls-uikit-vue 4.1.0

package/types/TUICallService/const/call.d.ts

@@ -0,0 +1,141 @@
+/**
+ * @property {String} call 1v1 通话 + 群组通话
+ * @property {String} CUSTOM 自定义 Store
+*/
+export declare enum StoreName {
+    CALL = "call",
+    CUSTOM = "custom"
+}
+/**
+ * @property {String} idle 空闲
+ * @property {String} connecting 呼叫等待中
+ * @property {String} connected 通话中
+*/
+export declare enum CallMediaType {
+    UNKNOWN = 0,
+    AUDIO = 1,
+    VIDEO = 2
+}
+/**
+ * @property {String} caller 主叫
+ * @property {String} callee 被叫
+*/
+export declare enum CallRole {
+    UNKNOWN = "unknown",
+    CALLEE = "callee",
+    CALLER = "caller"
+}
+/**
+ * @property {String} idle 空闲
+ * @property {String} calling 呼叫等待中
+ * @property {String} connected 通话中
+*/
+export declare enum CallStatus {
+    IDLE = "idle",
+    CALLING = "calling",
+    CONNECTED = "connected"
+}
+/**
+ * 视频画面显示模式
+ * 播放视频流默认使用 cover 模式; 播放屏幕共享流默认使用 contain 模式。
+ * @property {String} contain 优先保证视频内容全部显示。视频尺寸等比缩放，直至视频窗口的一边与视窗边框对齐。如果视频尺寸与显示视窗尺寸不一致，在保持长宽比的前提下，将视频进行缩放后填满视窗，缩放后的视频四周会有一圈黑边。
+ * @property {String} cover 优先保证视窗被填满。视频尺寸等比缩放，直至整个视窗被视频填满。如果视频长宽与显示窗口不同，则视频流会按照显示视窗的比例进行周边裁剪或图像拉伸后填满视窗
+ * @property {String} fill 保证视窗被填满的同时保证视频内容全部显示，但是不保证视频尺寸比例不变。视频的宽高会被拉伸至和视窗尺寸一致。(该选项值自 v4.12.1 开始支持)
+*/
+export declare enum VideoDisplayMode {
+    CONTAIN = "contain",
+    COVER = "cover",
+    FILL = "fill"
+}
+/**
+ * 视频分辨率
+ * @property {String} 480p
+ * @property {String} 720p
+ * @property {String} 1080p
+*/
+export declare enum VideoResolution {
+    RESOLUTION_480P = "480p",
+    RESOLUTION_720P = "720p",
+    RESOLUTION_1080P = "1080p"
+}
+export declare enum LanguageType {
+    EN = "en",
+    'ZH-CN' = "zh-cn",
+    JA_JP = "ja_JP"
+}
+export type TDeviceList = {
+    cameraList: any[];
+    microphoneList: any[];
+    currentCamera: any;
+    currentMicrophone: any;
+};
+export declare const StatusChange: {
+    readonly IDLE: "idle";
+    readonly BE_INVITED: "be-invited";
+    readonly DIALING_C2C: "dialing-c2c";
+    readonly DIALING_GROUP: "dialing-group";
+    readonly CALLING_C2C_AUDIO: "calling-c2c-audio";
+    readonly CALLING_C2C_VIDEO: "calling-c2c-video";
+    readonly CALLING_GROUP_AUDIO: "calling-group-audio";
+    readonly CALLING_GROUP_VIDEO: "calling-group-video";
+};
+export declare const CallType: {
+    readonly unknown: CallMediaType.UNKNOWN;
+    readonly audio: CallMediaType.AUDIO;
+    readonly video: CallMediaType.VIDEO;
+};
+/**
+ * @property {String} ear 听筒
+ * @property {String} speaker 免提
+*/
+export declare enum AudioPlayBackDevice {
+    EAR = "ear",
+    SPEAKER = "speaker"
+}
+export declare enum DeviceType {
+    MICROPHONE = "microphone",
+    CAMERA = "camera",
+    SPEAKER = "speaker"
+}
+export declare enum CameraPosition {
+    FRONT = 0,
+    BACK = 1
+}
+export declare enum FeatureButton {
+    Camera = "camera",
+    Microphone = "microphone",
+    SwitchCamera = "switchCamera",
+    InviteUser = "inviteUser"
+}
+export declare enum ButtonState {
+    Open = "open",
+    Close = "close"
+}
+export interface IViewBackgroundImage {
+    [userId: string]: string;
+}
+export declare enum ViewName {
+    LOCAL = "local",
+    REMOTE = "remote"
+}
+export declare enum LayoutMode {
+    LocalInLargeView = "local",
+    RemoteInLargeView = "remote"
+}
+export interface ICustomUIConfig {
+    button?: {
+        [buttonName in FeatureButton]?: {
+            show: boolean;
+            state: ButtonState;
+        };
+    };
+    viewBackground?: IViewBackgroundImage;
+    layoutMode?: LayoutMode;
+}
+export declare enum ACTION_TYPE {
+    INVITE = 1,
+    CANCEL_INVITE = 2,
+    ACCEPT_INVITE = 3,
+    REJECT_INVITE = 4,
+    INVITE_TIMEOUT = 5
+}

package/types/TUICallService/const/error.d.ts

@@ -0,0 +1,2 @@
+export declare const ErrorCode: any;
+export declare const ErrorMessage: any;

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

@@ -0,0 +1,27 @@
+export * from './call';
+export * from './error';
+export * from './log';
+export declare const CALL_DATA_KEY: any;
+export declare const CHAT_DATA_KEY: any;
+export declare const PUSHER_ID: {
+    INITIAL_PUSHER: string;
+    NEW_PUSHER: string;
+};
+export declare const NAME: any;
+export declare const AudioCallIcon = "https://web.sdk.qcloud.com/component/TUIKit/assets/call.png";
+export declare const VideoCallIcon = "https://web.sdk.qcloud.com/component/TUIKit/assets/call-video-reverse.svg";
+export declare const MAX_NUMBER_ROOM_ID = 2147483647;
+export declare const DEFAULT_BLUR_LEVEL = 3;
+export declare const NETWORK_QUALITY_THRESHOLD = 4;
+export declare enum PLATFORM {
+    MAC = "mac",
+    WIN = "win"
+}
+export declare enum COMPONENT {
+    TUI_CALL_KIT = 14,
+    TIM_CALL_KIT = 15
+}
+export declare enum ROOM_ID_TYPE {
+    NUMBER_ROOM_ID = 1,
+    STRING_ROOM_ID = 2
+}

package/types/TUICallService/const/log.d.ts

@@ -0,0 +1,7 @@
+export declare enum LOG_LEVEL {
+    NORMAL = 0,
+    RELEASE = 1,
+    WARNING = 2,
+    ERROR = 3,
+    NONE = 4
+}

package/types/TUICallService/index.d.ts

@@ -0,0 +1,5 @@
+import TUICallService, { TUIGlobal, TUIStore, uiDesign } from './CallService/index';
+import { StoreName, NAME, CallRole, CallMediaType, CallStatus, StatusChange, VideoResolution, VideoDisplayMode, AudioPlayBackDevice, FeatureButton, LayoutMode } from './const/index';
+import { t } from './locales/index';
+declare const TUICallKitAPI: TUICallService;
+export { TUIGlobal, TUIStore, StoreName, TUICallKitAPI, NAME, CallStatus, CallRole, CallMediaType, StatusChange, VideoResolution, VideoDisplayMode, AudioPlayBackDevice, t, uiDesign, FeatureButton, LayoutMode, };

package/types/TUICallService/interface/ICallService.d.ts

@@ -0,0 +1,69 @@
+import { CallStatus, CallRole } from '../const/index';
+type SDKAppID = {
+    SDKAppID: number;
+} | {
+    sdkAppID: number;
+};
+export interface IInitParamsBase {
+    userID: string;
+    userSig: string;
+    tim?: any;
+    isFromChat?: boolean;
+    component?: number;
+}
+export type IInitParams = IInitParamsBase & SDKAppID;
+export interface ICallsParams {
+    userIDList: Array<string>;
+    type: number;
+    chatGroupID?: string;
+    roomID?: number;
+    strRoomID?: string;
+    userData?: string;
+    timeout?: number;
+    offlinePushInfo?: IOfflinePushInfo;
+}
+export interface IUserInfo {
+    userId: string;
+    nick?: string;
+    avatar?: string;
+    remark?: string;
+    displayUserInfo?: string;
+    isAudioAvailable?: boolean;
+    isVideoAvailable?: boolean;
+    volume?: number;
+    isEnter?: boolean;
+    domId?: string;
+}
+export interface IOfflinePushInfo {
+    title?: string;
+    description?: string;
+    androidOPPOChannelID?: string;
+    extension: String;
+}
+export interface ICallbackParam {
+    beforeCalling?: (...args: any[]) => void;
+    afterCalling?: (...args: any[]) => void;
+    onMinimized?: (...args: any[]) => void;
+    onMessageSentByMe?: (...args: any[]) => void;
+    kickedOut?: (...args: any[]) => void;
+    statusChanged?: (...args: any[]) => void;
+}
+export interface ISelfInfoParams {
+    nickName: string;
+    avatar: string;
+}
+export interface IBellParams {
+    callRole?: CallRole;
+    callStatus?: CallStatus;
+    isMuteBell?: boolean;
+    calleeBellFilePath?: string;
+}
+export interface IInviteUserParams {
+    userIDList: string[];
+    offlinePushInfo?: IOfflinePushInfo;
+}
+export interface INetWorkQuality {
+    userId: string;
+    quality: number;
+}
+export {};

package/types/TUICallService/interface/ICallStore.d.ts

@@ -0,0 +1,47 @@
+import { CallStatus, CallRole, CallMediaType, VideoDisplayMode, VideoResolution, TDeviceList, CameraPosition, ICustomUIConfig } from '../const/index';
+import { IUserInfo, INetWorkQuality } from './index';
+export interface IToastInfo {
+    text: string;
+    type?: string;
+}
+export interface ICallStore {
+    callStatus: CallStatus;
+    callRole: CallRole;
+    callMediaType: CallMediaType;
+    localUserInfo: IUserInfo;
+    localUserInfoExcludeVolume: IUserInfo;
+    remoteUserInfoList: Array<IUserInfo>;
+    remoteUserInfoExcludeVolumeList: Array<IUserInfo>;
+    callerUserInfo: IUserInfo;
+    isGroup: boolean;
+    callDuration: string;
+    callTips: string;
+    toastInfo: IToastInfo;
+    isMinimized: boolean;
+    enableFloatWindow: boolean;
+    bigScreenUserId: string;
+    language: string;
+    isClickable: boolean;
+    showPermissionTip: boolean;
+    netWorkQualityList: Array<INetWorkQuality>;
+    deviceList: TDeviceList;
+    callID: string;
+    groupID: string;
+    roomID: number | string;
+    roomIdType: number;
+    cameraPosition: CameraPosition;
+    isMuteSpeaker: boolean;
+    groupCallMembers: IUserInfo[];
+    displayMode: VideoDisplayMode;
+    videoResolution: VideoResolution;
+    pusher: any;
+    player: any[];
+    isEarPhone: boolean;
+    showSelectUser: boolean;
+    isShowEnableVirtualBackground: boolean;
+    enableVirtualBackground: boolean;
+    customUIConfig: ICustomUIConfig;
+    pusherId: string;
+    translate: Function;
+    isForceUseV2API: boolean;
+}

package/types/TUICallService/interface/ITUIGlobal.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @interface TUIGlobal
+ * @property {Object} global 根据运行环境代理 wx、uni、window
+ * @property {Boolean} isPC true 标识是 pc 网页
+ * @property {Boolean} isH5 true 标识是 手机 H5
+ * @property {Boolean} isWeChat true 标识是 微信小程序
+ * @property {Boolean} isApp true 标识是 uniapp 打包的 native app
+ * @property {Boolean} isUniPlatform true 标识当前应用是通过 uniapp 平台打包的产物
+ * @property {Boolean} isOfficial true 标识是腾讯云官网 Demo 应用
+ * @property {Boolean} isWIN true 标识是window系统pc
+ * @property {Boolean} isMAC true 标识是mac os系统pc
+*/
+export interface ITUIGlobal {
+    global: any;
+    isPC: boolean;
+    isH5: boolean;
+    isWeChat: boolean;
+    isApp: boolean;
+    isUniPlatform: boolean;
+    isOfficial: boolean;
+    isWIN: boolean;
+    isMAC: boolean;
+    /**
+     * 初始化 TUIGlobal 环境变量
+     * @function
+     * @private
+     */
+    initEnv(): void;
+    /**
+     * 初始化 isOfficial
+     * @function
+     * @param {number} SDKAppID 当前实例的应用 SDKAppID
+     * @private
+     */
+    initOfficial(SDKAppID: number): void;
+}

package/types/TUICallService/interface/ITUIStore.d.ts

@@ -0,0 +1,83 @@
+import { StoreName } from '../const/index';
+export type Task = Record<StoreName, Record<string, Map<(data?: unknown) => void, 1>>>;
+export interface IOptions {
+    [key: string]: (newData?: any) => void;
+}
+/**
+ * @class TUIStore
+ * @property {ICustomStore} customStore 自定义 store，可根据业务需要通过以下 API 进行数据操作。
+*/
+export interface ITUIStore {
+    task: Task;
+    /**
+     * UI 组件注册监听
+     * @function
+     * @param {StoreName} storeName store 名称
+     * @param {IOptions} options UI 组件注册的监听信息
+     * @param {Object} params 扩展参数
+     * @param {String} params.notifyRangeWhenWatch 注册时监听时的通知范围
+     * @example
+     * // UI 层监听会话列表更新通知
+     * let onConversationListUpdated = function(conversationList) {
+     *   console.warn(conversationList);
+     * }
+     * TUIStore.watch(StoreName.CONV, {
+     *   conversationList: onConversationListUpdated,
+     * })
+     */
+    watch(storeName: StoreName, options: IOptions, params?: any): void;
+    /**
+     * UI 组件取消监听回调
+     * @function
+     * @param {StoreName} storeName store 名称
+     * @param {IOptions} options 监听信息，包含需要取消的回调等
+     * @example
+     * // UI 层取消监听会话列表更新通知
+     * TUIStore.unwatch(StoreName.CONV, {
+     *   conversationList: onConversationListUpdated,
+     * })
+     */
+    unwatch(storeName: StoreName, options: IOptions | string): void;
+    /**
+     * 获取 store 中的上一个状态
+     * @function
+     * @param {StoreName} storeName store 名称
+     * @param {String} key 需要获取的 key
+     * @private
+     */
+    getPrevData(storeName: StoreName, key: string): any;
+    /**
+     * 获取 store 中的数据
+     * @function
+     * @param {StoreName} storeName store 名称
+     * @param {String} key 需要获取的 key
+     * @private
+     */
+    getData(storeName: StoreName, key: string): any;
+    /**
+     * 更新 store
+     * - 需要使用自定义 store 时可以用此 API 更新自定义数据
+     * @function
+     * @param {StoreName} storeName store 名称
+     * @param {String} key 需要更新的 key
+     * @example
+     * // UI 层更新自定义 Store 数据
+     * TUIStore.update(StoreName.CUSTOM, 'customKey', 'customData')
+     */
+    update(storeName: StoreName, key: string, data: unknown): void;
+    /**
+     * 重置 store 内数据
+     * @function
+     * @param {StoreName} storeName store 名称
+     * @param {Array<string>} keyList 需要 reset 的 keyList
+     * @param {boolean} isNotificationNeeded 是否需要触发更新
+     * @private
+     */
+    reset: (storeName: StoreName, keyList?: Array<string>, isNotificationNeeded?: boolean) => void;
+    /**
+     * 修改多个 key-value
+     * @param {Object} params 多个 key-value 组成的 object
+     * @param {StoreName} storeName store 名称
+     */
+    updateStore: (params: any, name?: StoreName) => void;
+}

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

@@ -0,0 +1,4 @@
+export * from './ICallService';
+export * from './ICallStore';
+export * from './ITUIGlobal';
+export * from './ITUIStore';

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

@@ -0,0 +1,128 @@
+export declare const en: {
+    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;
+    'no response from the other side': 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;
+    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;
+    'Those involved': string;
+    call: string;
+    'video-call': string;
+    'audio-call': string;
+    search: string;
+    'search-result': string;
+    'no-user': string;
+    'member-not-added': string;
+    'input-phone-userID': string;
+    'not-login': string;
+    'login-status-expire': string;
+    'experience-multi-call': string;
+    'not-support-multi-call': string;
+    userID: string;
+    'already-enter': string;
+    'camera-opened': string;
+    'camera-closed': string;
+    'microphone-opened': string;
+    'microphone-closed': string;
+    timeout: string;
+    'kick out': 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;
+    'Use-phone-and-computer': string;
+    'Wechat scan right QR code': string;
+    'Scan the QR code above': string;
+    'accept-error': string;
+    'accept-device-error': string;
+    'call-error': string;
+};

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

@@ -0,0 +1,10 @@
+export declare const CallTips: any;
+export declare const languageData: languageDataType;
+export declare function t(args: any): string;
+interface languageItemType {
+    [key: string]: string;
+}
+interface languageDataType {
+    [key: string]: languageItemType;
+}
+export {};