@tencentcloud/tuiroom-engine-js 3.2.1 → 3.2.2

package/dist/src/utils/validate-config.d.ts

@@ -0,0 +1,722 @@
+import { TUIVideoQuality, TUIAudioQuality, TUIRole, TUIVideoStreamType, TUIRoomType, TUIMediaDevice, TUIResolutionMode, TUISeatMode } from '../types';
+export declare const TUIRoomEngineValidateConfig: {
+    login: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            sdkAppId: {
+                required: boolean;
+                type: string;
+                allowEmpty: boolean;
+            };
+            userId: {
+                required: boolean;
+                type: string;
+                allowEmpty: boolean;
+            };
+            userSig: {
+                required: boolean;
+                type: string;
+                allowEmpty: boolean;
+            };
+        };
+    };
+    setSelfInfo: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            userName: {
+                required: boolean;
+                type: string;
+            };
+            avatarUrl: {
+                required: boolean;
+                type: string;
+            };
+            customInfo: {
+                required: boolean;
+                type: string;
+                allowEmpty: boolean;
+            };
+        };
+    };
+    createRoom: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            roomId: {
+                required: boolean;
+                type: string;
+                allowEmpty: boolean;
+            };
+            roomName: {
+                type: string;
+                allowEmpty: boolean;
+            };
+            roomType: {
+                instanceof: typeof TUIRoomType;
+            };
+            isMicrophoneDisableForAllUser: {
+                type: string;
+            };
+            isScreenShareDisableForAllUser: {
+                type: string;
+            };
+            isCameraDisableForAllUser: {
+                type: string;
+            };
+            isMessageDisableForAllUser: {
+                type: string;
+            };
+            maxSeatCount: {
+                type: string;
+            };
+            password: {
+                type: string;
+            };
+        };
+    };
+    enterRoom: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            roomId: {
+                required: boolean;
+                type: string;
+                allowEmpty: boolean;
+            };
+            roomType: {
+                instanceof: typeof TUIRoomType;
+            };
+            options: {
+                type: string;
+                properties: {
+                    password: {
+                        type: string;
+                    };
+                };
+            };
+        };
+    };
+    updateRoomNameByAdmin: {
+        name: string;
+        require: boolean;
+        type: string;
+        properties: {
+            roomName: {
+                require: boolean;
+                type: string;
+                allowEmpty: boolean;
+            };
+        };
+    };
+    setRoomMaxSeatCount: {
+        name: string;
+        require: boolean;
+        type: string;
+        properties: {
+            maxSeatCount: {
+                require: boolean;
+                type: string;
+            };
+        };
+    };
+    getUserList: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            nextSequence: {
+                type: string;
+            };
+        };
+    };
+    getUserInfo: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            userId: {
+                required: boolean;
+                type: string;
+                allowEmpty: boolean;
+            };
+        };
+    };
+    setCustomInfoForUser: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            userId: {
+                required: boolean;
+                type: string;
+                allowEmpty: boolean;
+            };
+            customInfo: {
+                required: boolean;
+                type: string;
+                allowEmpty: boolean;
+            };
+        };
+    };
+    setRoomMetadataByAdmin: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            metadata: {
+                required: boolean;
+                type: string;
+                allowEmpty: boolean;
+            };
+        };
+    };
+    getRoomMetadata: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            keys: {
+                required: boolean;
+                type: string;
+                allowEmpty: boolean;
+            };
+        };
+    };
+    takeSeat: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            seatIndex: {
+                required: boolean;
+                type: string;
+            };
+            timeout: {
+                required: boolean;
+                type: string;
+            };
+            requestCallback: {
+                instanceof: FunctionConstructor;
+            };
+        };
+    };
+    getSeatList: {};
+    openRemoteDeviceByAdmin: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            userId: {
+                required: boolean;
+                type: string;
+                allowEmpty: boolean;
+            };
+            timeout: {
+                required: boolean;
+                type: string;
+            };
+            device: {
+                require: boolean;
+                instanceof: typeof TUIMediaDevice;
+            };
+        };
+    };
+    closeRemoteDeviceByAdmin: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            userId: {
+                required: boolean;
+                type: string;
+                allowEmpty: boolean;
+            };
+            device: {
+                required: boolean;
+                instanceof: typeof TUIMediaDevice;
+            };
+        };
+    };
+    takeUserOnSeatByAdmin: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            seatIndex: {
+                required: boolean;
+                type: string;
+            };
+            userId: {
+                required: boolean;
+                type: string;
+                allowEmpty: boolean;
+            };
+            timeout: {
+                required: boolean;
+                type: string;
+            };
+            requestCallback: {
+                instanceof: FunctionConstructor;
+            };
+        };
+    };
+    kickUserOffSeatByAdmin: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            seatIndex: {
+                required: boolean;
+                type: string;
+            };
+            userId: {
+                required: boolean;
+                type: string;
+                allowEmpty: boolean;
+            };
+        };
+    };
+    cancelRequest: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            requestId: {
+                required: boolean;
+                type: string;
+                allowEmpty: boolean;
+            };
+        };
+    };
+    responseRemoteRequest: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            requestId: {
+                required: boolean;
+                type: string;
+                allowEmpty: boolean;
+            };
+            agree: {
+                required: boolean;
+                type: string;
+            };
+        };
+    };
+    setLocalVideoView: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            view: {
+                required: boolean;
+                type: string[];
+                allowEmpty: boolean;
+                validate: (value: any) => void;
+            };
+        };
+    };
+    openLocalCamera: {
+        name: string;
+        type: string;
+        properties: {
+            isFrontCamera: {
+                type: string;
+                allowEmpty: boolean;
+            };
+        };
+    };
+    closeLocalCamera: {};
+    openLocalMicrophone: {};
+    closeLocalMicrophone: {};
+    setVideoResolutionMode: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            streamType: {
+                required: boolean;
+                instanceof: typeof TUIVideoStreamType;
+            };
+            resolutionMode: {
+                required: boolean;
+                instanceof: typeof TUIResolutionMode;
+            };
+        };
+    };
+    updateVideoQuality: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            quality: {
+                required: boolean;
+                instanceof: typeof TUIVideoQuality;
+            };
+        };
+    };
+    updateVideoQualityEx: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            streamType: {
+                required: boolean;
+                instanceof: typeof TUIVideoStreamType;
+            };
+            encoderParams: {
+                required: boolean;
+                properties: {
+                    quality: {
+                        instanceof: typeof TUIVideoQuality;
+                    };
+                    fps: {
+                        type: string;
+                    };
+                    bitrate: {
+                        type: string;
+                    };
+                    resolutionMode: {
+                        instanceof: typeof TUIResolutionMode;
+                    };
+                };
+            };
+        };
+    };
+    updateAudioQuality: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            quality: {
+                required: boolean;
+                instanceof: typeof TUIAudioQuality;
+            };
+        };
+    };
+    muteRemoteAudioStream: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            userId: {
+                required: boolean;
+                type: string;
+                allowEmpty: boolean;
+            };
+            isMute: {
+                required: boolean;
+                type: string;
+            };
+        };
+    };
+    startPushLocalVideo: {};
+    stopPushLocalVideo: {};
+    setRemoteVideoView: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            userId: {
+                required: boolean;
+                type: string;
+                allowEmpty: boolean;
+            };
+            streamType: {
+                required: boolean;
+                instanceof: typeof TUIVideoStreamType;
+            };
+            view: {
+                required: boolean;
+                type: string[];
+                allowEmpty: boolean;
+            };
+        };
+    };
+    startPlayRemoteVideo: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            userId: {
+                required: boolean;
+                type: string;
+                allowEmpty: boolean;
+            };
+            streamType: {
+                required: boolean;
+                instanceof: typeof TUIVideoStreamType;
+            };
+        };
+    };
+    stopPlayRemoteVideo: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            userId: {
+                required: boolean;
+                type: string;
+                allowEmpty: boolean;
+            };
+            streamType: {
+                required: boolean;
+                instanceof: typeof TUIVideoStreamType;
+            };
+        };
+    };
+    changeUserRole: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            userId: {
+                required: boolean;
+                type: string;
+                allowEmpty: boolean;
+            };
+            userRole: {
+                required: boolean;
+                instanceof: typeof TUIRole;
+            };
+        };
+    };
+    changeUserNameCard: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            userId: {
+                required: boolean;
+                type: string;
+                allowEmpty: boolean;
+            };
+            nameCard: {
+                required: boolean;
+                type: string;
+            };
+        };
+    };
+    kickRemoteUserOutOfRoom: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            userId: {
+                required: boolean;
+                type: string;
+                allowEmpty: boolean;
+            };
+        };
+    };
+    sendTextMessage: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            messageText: {
+                require: boolean;
+                type: string;
+                allowEmpty: boolean;
+            };
+        };
+    };
+    sendCustomMessage: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            messageText: {
+                require: boolean;
+                type: string;
+                allowEmpty: boolean;
+            };
+        };
+    };
+    startScreenSharing: {
+        name: string;
+        type: string;
+        properties: {
+            screenAudio: {
+                type: string;
+            };
+            view: {
+                type: string;
+            };
+        };
+    };
+    stopScreenSharing: {};
+    startScreenSharingElectron: {
+        name: string;
+        required: boolean;
+        type: string[];
+        properties: {
+            targetId: {
+                require: boolean;
+                type: string;
+            };
+            view: {
+                type: string;
+            };
+        };
+    };
+    selectScreenSharingTarget: {
+        name: string;
+        required: boolean;
+        type: string[];
+        properties: {
+            targetId: {
+                require: boolean;
+                type: string;
+            };
+        };
+    };
+    setCurrentCameraDevice: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            deviceId: {
+                require: boolean;
+                type: string;
+            };
+        };
+    };
+    setCurrentMicDevice: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            deviceId: {
+                require: boolean;
+                type: string;
+            };
+        };
+    };
+    setCurrentSpeakerDevice: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            deviceId: {
+                require: boolean;
+                type: string;
+            };
+        };
+    };
+    disableDeviceForAllUserByAdmin: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            isDisable: {
+                require: boolean;
+                type: string;
+            };
+            device: {
+                require: boolean;
+                instanceof: typeof TUIMediaDevice;
+            };
+        };
+    };
+    disableSendingMessageForAllUser: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            isDisable: {
+                require: boolean;
+                type: string;
+            };
+        };
+    };
+    disableSendingMessageByAdmin: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            userId: {
+                require: boolean;
+                instanceof: string;
+            };
+            isDisable: {
+                require: boolean;
+                type: string;
+            };
+        };
+    };
+    updateRoomSeatModeByAdmin: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            seatMode: {
+                require: boolean;
+                instanceof: typeof TUISeatMode;
+            };
+        };
+    };
+    updateRoomPasswordByAdmin: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            password: {
+                required: boolean;
+                type: string;
+                allowEmpty: boolean;
+            };
+        };
+    };
+    applyToAdminToOpenLocalDevice: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            timeout: {
+                required: boolean;
+                type: string;
+            };
+            device: {
+                require: boolean;
+                instanceof: typeof TUIMediaDevice;
+            };
+        };
+    };
+    lockSeatByAdmin: {
+        name: string;
+        required: boolean;
+        type: string;
+        properties: {
+            seatIndex: {
+                required: boolean;
+                type: string;
+            };
+            lockParams: {
+                require: boolean;
+                type: string;
+                properties: {
+                    lockSeat: {
+                        require: boolean;
+                        type: string;
+                    };
+                    lockVideo: {
+                        require: boolean;
+                        type: string;
+                    };
+                    lockAudio: {
+                        require: boolean;
+                        type: string;
+                    };
+                };
+            };
+        };
+    };
+};