call-live-sdk1 0.0.11 → 0.0.14

package/dist/types/stores/callStore.d.ts

@@ -0,0 +1,327 @@
+import { IRTCEngine } from '@volcengine/rtc';
+import * as fabric from 'fabric';
+import { LoginResponseData, RTCMasterConfigResponse } from '@/api';
+/**
+ * 视频类型枚举
+ * 用于区分不同类型的视频流
+ */
+export declare enum VideoType {
+    /** 摄像头视频 */
+    CAMERA = "video",
+    /** 屏幕共享 */
+    SCREEN = "screen",
+    /** 主画面 */
+    MAIN = "main",
+    /** 屏幕共享主画面 */
+    SCREEN_MAIN = "screenmain",
+    /** 自视频 */
+    SELF = "self"
+}
+/**
+ * 用户状态枚举
+ * 用于标识用户在等候模式下的状态
+ */
+export declare enum WaitingModeState {
+    /** 未开启等候模式 */
+    NOT_ENABLED = 0,
+    /** 等候中 */
+    WAITING = 1,
+    /** 已准入 */
+    ADMITTED = 2
+}
+export interface CallUser extends LoginResponseData {
+    device: string;
+    isVideoDisabled?: boolean;
+    isAudioDisabled?: boolean;
+    isVideoEnabled?: boolean;
+    isAudioEnabled?: boolean;
+    isScreenEnabled?: boolean;
+    joinTime?: number;
+    waiting_mode_state: WaitingModeState;
+    videoList: [id: string, screenId: string, mainId: string];
+    isPublishStream?: boolean;
+    isMirror?: boolean;
+    isVideoCapture?: boolean;
+    isSubscribeAudio?: boolean;
+}
+export interface MediaDevices {
+    audioInputs: Array<{
+        deviceId: string;
+        kind: 'audioinput';
+        label?: string;
+    }>;
+    videoInputs: Array<{
+        deviceId: string;
+        kind: 'videoinput';
+        label?: string;
+    }>;
+}
+export interface DeviceSettings {
+    cameraId?: string;
+    microphoneId?: string;
+    mirrorEnabled?: boolean;
+    beautySettings?: any;
+}
+export interface CreateLocalStreamOptions {
+    video?: boolean;
+    audio?: boolean;
+    renderMode?: number;
+}
+export interface DevicesStatus {
+    video: number;
+    audio: number;
+}
+export interface CreateLocalStreamCallbackResult {
+    code: number;
+    msg: string;
+    devicesStatus: DevicesStatus;
+}
+export interface SetMediaDevicesResult {
+    success: boolean;
+    message: string;
+    error?: Error;
+}
+export interface PullWTNStreamOptions {
+    onConnectionStateChange?: (state: {
+        connectionState: string;
+        iceConnectionState: string;
+        domId: string;
+    }) => void;
+}
+export interface WTNStreamStatus {
+    found: boolean;
+    message?: string;
+    ready: boolean;
+    hasConnection?: boolean;
+    hasStream?: boolean;
+    readyState?: number;
+    canPlay?: boolean;
+}
+export interface RTC {
+    engine: IRTCEngine;
+    beautyExtension: any;
+    devicesSettings: DeviceSettings;
+    wtnConnections?: Record<string, RTCPeerConnection>;
+    SDKVERSION: string;
+    registerBeautyExtension: () => Promise<void>;
+    bindEngineEvents: () => void;
+    startAudioCapture: () => Promise<void>;
+    stopAudioCapture: () => Promise<void>;
+    removeEventListener: () => void;
+    join: (token: string, roomId: string, uid: string, extraInfo: string, autoOption?: any) => Promise<any>;
+    canvasJoin: (token: string, roomId: string, uid: string, extraInfo: string) => Promise<any>;
+    leave: () => Promise<void>;
+    checkPermission: () => Promise<any>;
+    getDevices: () => Promise<MediaDevices>;
+    setMediaDevices: (settings: DeviceSettings) => Promise<SetMediaDevicesResult>;
+    publishStream: () => Promise<void>;
+    unpublishStream: () => Promise<void>;
+    unsubscribeStream: (userId: string) => Promise<void>;
+    createLocalStream: (userId: string, callback: (result: CreateLocalStreamCallbackResult) => void, options?: CreateLocalStreamOptions) => Promise<void>;
+    createLocalCanvasStream: (userId: string, videoTrack: MediaStreamTrack | null, audioTrack: MediaStreamTrack | null, callback: (result: CreateLocalStreamCallbackResult) => void) => Promise<void>;
+    changeAudioState: (isMicOn: boolean) => Promise<boolean>;
+    changeVideoState: (isVideoOn: boolean) => Promise<boolean>;
+    changeScreenState: (isScreenOn: boolean, userId: string) => Promise<void>;
+    setRemoteScreenCapture: (userId: string, renderDom: string | null) => Promise<void>;
+    stopScreenCapture: () => Promise<void>;
+    startLocalScreenCapture: (userId: string, domId: string) => Promise<void>;
+    createWTNStreamURL: (appId: string, streamId: string, domain?: string) => string;
+    pullWTNStream: (url: string, domId: string, options?: PullWTNStreamOptions) => Promise<RTCPeerConnection>;
+    stopWTNStream: (domId: string) => void;
+    getWTNConnectionState: (domId: string) => string | null;
+    setWTNStreamVolume: (domId: string, volume: number) => boolean;
+    muteWTNStream: (domId: string, mute: boolean) => boolean;
+    checkWTNStreamStatus: (domId: string) => WTNStreamStatus;
+    reconnectWTNStream: (url: string, domId: string, options?: PullWTNStreamOptions) => Promise<RTCPeerConnection>;
+    stopAllWTNStreams: () => void;
+}
+export declare enum LayoutMode {
+    MAIN_PLUS_LIST = "main_plus_list",// 主画布+连麦列表
+    GRID = "grid"
+}
+export interface StreamAreaConfig {
+    width: number;
+    height: number;
+    aspectRatio: number;
+}
+export interface LayoutCalculation {
+    mainArea: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    } | null;
+    callAreas: Array<{
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+        userId: string;
+        domId?: string;
+        nickname?: string;
+        device: string;
+        isVideoEnabled?: boolean;
+        isAudioEnabled?: boolean;
+        isScreenEnabled?: boolean;
+    }>;
+}
+export type RuleType = '' | 'main' | 'sub';
+export interface Scene {
+    fabricObject: fabric.Object[];
+    documentInfo: any;
+    audioStates: Map<any, any>;
+    documentIndex: number;
+    documentScrollLeft: number;
+}
+export interface Scenes {
+    [key: string]: Scene;
+}
+export interface CallConfig extends RTCMasterConfigResponse, LoginResponseData {
+    rule: RuleType;
+    isCall: boolean;
+    isAudioEnabled: boolean;
+    isScreenEnabled: boolean;
+    isVideoEnabled: boolean;
+    micConnectPermission: 0 | 1;
+    backgroundImg: string;
+    media_devices: {
+        cameraId?: string;
+        microphoneId?: string;
+        mirrorEnabled: boolean;
+    } | null;
+}
+export interface CallStoreState {
+    getter: () => Partial<CallStoreState>;
+    getInitialScenes: () => Scenes;
+    fabricObjects: fabric.Object[];
+    setFabricObjects: (objects: fabric.Object[] | ((prev: fabric.Object[]) => fabric.Object[])) => void;
+    documentInfo: any;
+    setDocumentInfo: (info: any) => void;
+    currentScene: string;
+    setCurrentScene: (scene: string) => void;
+    documentScrollLeft: number;
+    setDocumentScrollLeft: (value: number) => void;
+    documentIndex: number;
+    setDocumentIndex: (value: number) => void;
+    scenes: Scenes;
+    setScenes: (scenes: Scenes | ((prev: Scenes) => Scenes)) => void;
+    updateScene: (sceneKey: string, scene: Partial<Scene> | ((prev: Scene) => Partial<Scene>)) => void;
+    callConfig: CallConfig;
+    callCurrentUser: CallUser | undefined;
+    mainCanvasId: string;
+    currentMainVideoType: Exclude<VideoType, VideoType.CAMERA>;
+    isVoiceChatOpen: boolean;
+    isRightSidebarCollapsed: boolean;
+    callUsers: CallUser[];
+    layoutMode: LayoutMode;
+    rtc: RTC;
+    fabricInstance: any;
+    compositeCanvasRef: HTMLCanvasElement | null;
+    compositeContextRef: CanvasRenderingContext2D | null;
+    callAudioStreamsRef: MediaStream[];
+    videoList: (CallUser & {
+        domId: string;
+    })[];
+    callUsersCurrentPageRef: number;
+    offscreenCanvasRef: HTMLCanvasElement | null;
+    offscreenContextRef: CanvasRenderingContext2D | null;
+    backgroundImageRef: HTMLImageElement | null;
+    lastBackgroundImgUrlRef: string;
+    toggleRightSidebar: (collapsed?: boolean) => void;
+    removeCallUser: (userId: string) => void;
+    kickRoomUser: (userId: string, forbiddenInterval?: number) => Promise<void>;
+    updateCallConfig: (updates: Partial<CallConfig>) => void;
+    updateCallUser: (userId: string, updates: Partial<CallUser>) => CallUser | undefined;
+    activeUsers: CallUser[];
+    waitingUsers: CallUser[];
+    joinCallUser: (remoteUser?: CallUser) => CallUser | false;
+    addRemoteUser: (remoteUser: CallUser) => CallUser | false;
+    addLocalUser: () => CallUser | false;
+    isUserExists: (rtc_userid: string) => boolean;
+    validateCallConfig: () => {
+        isValid: boolean;
+        errors: string[];
+    };
+    leave: (liveId?: number, agentId?: number) => void;
+    leaveRemoteUser: (userId: string) => void;
+    switchLayoutMode: (mode: LayoutMode) => void;
+    calculateLayout: () => LayoutCalculation;
+    calculateMainPlusListLayout: (width: number, height: number) => LayoutCalculation;
+    calculateGridLayout: (width: number, height: number) => LayoutCalculation;
+    calculateMainOnlyLayout: (width: number, height: number) => LayoutCalculation;
+    initCompositeCanvas: () => HTMLCanvasElement | null;
+    renderCompositeFrameSmooth: () => void;
+    setMainCanvasId: (mainCanvasId: string) => void;
+    setCallUsers: (callUsers: CallUser[]) => void;
+    setCallConfig: (callConfig: CallConfig) => void;
+    setIsVoiceChatOpen: (isVoiceChatOpen: boolean) => void;
+    setCallCurrentUser: (callCurrentUser: CallUser | undefined) => void;
+    setCurrentMainVideoType: (currentMainVideoType: Exclude<VideoType, VideoType.CAMERA>) => void;
+    getCallConfig: () => CallConfig;
+    setRtc: (rtc: any) => void;
+    setFabricInstance: (fabricInstance: any) => void;
+    setCompositeCanvasRef: (compositeCanvasRef: HTMLCanvasElement | null) => void;
+    setCompositeContextRef: (compositeContextRef: CanvasRenderingContext2D | null) => void;
+    setCallAudioStreamsRef: (callAudioStreamsRef: MediaStream[]) => void;
+    setVideoList: (videoList: (CallUser & {
+        domId: string;
+    })[]) => void;
+    setCallUsersCurrentPageRef: (callUsersCurrentPageRef: number) => void;
+    setOffscreenCanvasRef: (offscreenCanvasRef: HTMLCanvasElement | null) => void;
+    setOffscreenContextRef: (offscreenContextRef: CanvasRenderingContext2D | null) => void;
+    setBackgroundImageRef: (backgroundImageRef: HTMLImageElement | null) => void;
+    setLastBackgroundImgUrlRef: (lastBackgroundImgUrlRef: string) => void;
+    filterCallUsers: (a: Partial<CallUser>) => CallUser[];
+    drawUserVideoContent: (context: CanvasRenderingContext2D, videoElement: HTMLVideoElement, user: any, x: number, y: number, width: number, height: number) => void;
+    drawUserInfo: (context: CanvasRenderingContext2D, user: any, x: number, y: number, width: number, height: number) => void;
+    drawStatusIndicators: (context: CanvasRenderingContext2D, user: any, x: number, y: number, width: number) => void;
+    drawStatusIndicator: (context: CanvasRenderingContext2D, x: number, y: number, width: number, statusY: number, offset: number, type: 'audio' | 'video') => void;
+    renderEmptyUserArea: (context: CanvasRenderingContext2D, user: any, x: number, y: number, width: number, height: number) => void;
+    canvasRequestRenderAll: () => void;
+    findCallUserById: (id: string) => CallUser | undefined;
+    changeAudioState: (id: string, isAudio: boolean) => void;
+    changeVideoState: (id: string, isVideo: boolean) => void;
+    /**
+     * 切换用户音频状态
+     * @param isAudio - 是否开启音频（默认：取反当前状态）
+     * @param isBanned - 是否被封禁（默认：false）
+     */
+    toggleAudio: (isAudio?: boolean, isBanned?: boolean) => Promise<{
+        success: boolean;
+        message: string;
+        isEnabled?: boolean;
+        error?: any;
+    }>;
+    /**
+     * 切换用户视频状态
+     * @param isVideo - 是否开启视频（默认：取反当前状态）
+     * @param isBanned - 是否被封禁（默认：false）
+     */
+    toggleVideo: (isVideo?: boolean, isBanned?: boolean) => Promise<{
+        success: boolean;
+        message: string;
+        isEnabled?: boolean;
+        error?: any;
+    }>;
+    toggleScreenShare: (isScreen?: boolean) => Promise<{
+        success: boolean;
+        message: string;
+        isEnabled?: boolean;
+        error?: any;
+    }>;
+    toggleMirror: (isMirror?: boolean) => Promise<{
+        success: boolean;
+        message: string;
+        isEnabled?: boolean;
+        error?: any;
+    }>;
+    callAudioMixing: () => void;
+    handleRemoteUserPublishScreen: (event: {
+        userId: string;
+        mediaType: any;
+    }) => void;
+    handleRemoteUserUnpublishScreen: (event: {
+        userId: string;
+        mediaType: any;
+    }) => Promise<void>;
+}

package/dist/types/stores/commentChatUrl.d.ts

@@ -0,0 +1,4 @@
+export interface CommentChatUrlState {
+    webTransportUrl: string;
+    fetChatUrl: (params: any) => Promise<void>;
+}

package/dist/types/stores/commentRtmpStats.d.ts

@@ -0,0 +1,4 @@
+export interface CommentRtmpStatsState {
+    rtmpStats: any;
+    setRtmpStats: (stats: any) => void;
+}

package/dist/types/stores/commentSocket.d.ts

@@ -0,0 +1,20 @@
+export interface MessageData {
+    type: 'comment_delete' | 'chat_forward' | 'activity_config_change' | string;
+    data: Record<string, any>;
+}
+export interface WebSocketMessage {
+    data: string;
+}
+export interface CommentSocketState {
+    chat_url: string;
+    commentItem: Record<string, any>;
+    commentDeleteItem: Record<string, any>;
+    activityConfigChange: Record<string, any>;
+    rtmUrl: string;
+    webTransportUrl: string;
+    readyState: number;
+    latestMessage: WebSocketMessage | undefined;
+    sendMessage: ((message: string) => void) | undefined;
+    disconnect: (() => void) | undefined;
+    fetChatUrl: (id: number) => Promise<void>;
+}

package/dist/types/stores/counterStore.d.ts

@@ -0,0 +1,7 @@
+export interface CounterState {
+    count: number;
+    increment: () => void;
+    decrement: () => void;
+    reset: () => void;
+    incrementBy: (amount: number) => void;
+}

package/dist/types/stores/currentUser.d.ts

@@ -0,0 +1,4 @@
+export interface CurrentUserState {
+    currentUser: any | null;
+    setCurrentUser: (user: any | null) => void;
+}

package/dist/types/stores/drawingToolsStore.d.ts

@@ -0,0 +1,34 @@
+export interface DrawingToolsState {
+    selectedTool: number;
+    setSelectedTool: (tool: number) => void;
+    penSize: number;
+    setPenSize: (size: number | ((prev: number) => number)) => void;
+    penColor: string;
+    setPenColor: (color: string | ((prev: string) => string)) => void;
+    laserPenSize: number;
+    setLaserPenSize: (size: number | ((prev: number) => number)) => void;
+    laserPenColor: string;
+    setLaserPenColor: (color: string | ((prev: string) => string)) => void;
+    shapeSize: number;
+    setShapeSize: (size: number | ((prev: number) => number)) => void;
+    shapeType: string;
+    setShapeType: (type: string | ((prev: string) => string)) => void;
+    shapeColor: string;
+    setShapeColor: (color: string | ((prev: string) => string)) => void;
+    textSize: number;
+    setTextSize: (size: number | ((prev: number) => number)) => void;
+    textColor: string;
+    setTextColor: (color: string | ((prev: string) => string)) => void;
+    isPreviewModalVisible: boolean;
+    setIsPreviewModalVisible: (visible: boolean) => void;
+    downPoint: {
+        current: any;
+    };
+    upPoint: {
+        current: any;
+    };
+    currentShape: {
+        current: any;
+    };
+    getter: () => any;
+}

package/dist/types/stores/guest.d.ts

@@ -0,0 +1,6 @@
+export interface GuestStateType {
+    status: 0 | 1;
+    deviceType: 'pc' | 'mobile';
+    setDeviceType: (deviceType: 'pc' | 'mobile') => void;
+    setStatus: (status: 0 | 1) => void;
+}

package/dist/types/stores/liveInfo.d.ts

@@ -0,0 +1,8 @@
+export interface LiveInfoState {
+    data: any;
+    loading: boolean;
+    error: Error | undefined;
+    run: (live_id: string | number) => void;
+    cancel: () => void;
+    refresh: () => void;
+}

package/dist/types/stores/livepushcode.d.ts

@@ -0,0 +1,11 @@
+export interface LivePushCode {
+    [key: string]: any;
+}
+export interface LivePushCodeStore {
+    livePushCode: LivePushCode | null;
+    isLoading: boolean;
+    error: string | null;
+    fetchLivePush: (live_id: number) => Promise<LivePushCode | undefined>;
+    setLivePushCode: (code: LivePushCode) => void;
+    clearLivePushCode: () => void;
+}

package/dist/types/stores/sdkStore.d.ts

@@ -0,0 +1,34 @@
+export declare enum ErrorSeverity {
+    SEVERE = "severe",
+    WARNING = "warning"
+}
+export declare enum GlobalErrorType {
+    API_ERROR = "api_error",
+    TOKEN_EXPIRED = "token_expired",
+    PARAM_VALIDATION_ERROR = "param_validation_error",
+    OTHER_ERROR = "other_error"
+}
+export interface GlobalError {
+    type: GlobalErrorType;
+    code: number;
+    message: string;
+    details?: any;
+    severity: ErrorSeverity;
+}
+export interface SdkStore {
+    styleConfig: {
+        minHeight: number;
+        minWidth: number;
+    };
+    callConfig: import('../sdk').CallSDKConfig | null;
+    setCallConfig: (config: import('../sdk').CallSDKConfig) => void;
+    getLiveId: () => number | undefined;
+    getApiDomain: () => string;
+    getAgentId: () => number | undefined;
+    updateCallConfig: (partialConfig: Partial<import('../sdk').CallSDKConfig>) => void;
+    guestConfig: import('../sdk').GuestSDKConfig | null;
+    setGuestConfig: (config: import('../sdk').GuestSDKConfig) => void;
+    globalError: GlobalError | null;
+    setGlobalError: (error: GlobalError | null) => void;
+    clearGlobalError: () => void;
+}

package/dist/utils/utiles.d.ts

@@ -1,3 +1,8 @@
+/**
+ * 检测设备是否为移动设备（手机或平板）
+ * 考虑了现代设备和浏览器的 UserAgent 变化，特别是 iOS 13+ 的 iPad
+ * @returns {boolean} 是否为移动设备
+ */
 export declare const isMobile: boolean;
 /**
  * 检测麦克风设备权限

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "call-live-sdk1",
-  "version": "0.0.11",
+  "version": "0.0.14",
   "type": "module",
   "main": "./dist/call-live-sdk.umd.js",
   "module": "./dist/call-live-sdk.es.js",
@@ -53,6 +53,7 @@
     "terser": "5.44.1",
     "typescript": "5.3.3",
     "unocss": "0.58.0",
+    "vconsole": "^3.15.1",
     "vite": "5.0.0",
     "vite-plugin-imp": "2.4.0"
   },