polyv-live-api-sdk 1.0.0

package/dist/types/v4-ai.d.ts

@@ -0,0 +1,379 @@
+/**
+ * V4 AI Types
+ *
+ * Type definitions for V4 AI and Digital Human APIs.
+ *
+ * @module types/v4-ai
+ */
+/**
+ * Digital Human entity
+ */
+export interface DigitalHuman {
+    /** Digital human ID */
+    id: number;
+    /** Digital human name */
+    name: string;
+    /** Third-party role code */
+    thirdRoleCode: string;
+    /** Cover photo URL */
+    coverPhoto: string;
+    /** Full body photo URL */
+    fullBodyPhoto: string;
+    /** Clothes description */
+    clothesDesc: string;
+    /** Default TTS voice ID */
+    defaultTtsVoiceId: number;
+    /** Creation timestamp (milliseconds) */
+    createTime: number;
+}
+/**
+ * Parameters for listing digital humans
+ */
+export interface ListDigitalHumansParams {
+    /** Page number (>= 1) */
+    pageNumber: number;
+    /** Page size (1-1000) */
+    pageSize: number;
+}
+/**
+ * Response for listing digital humans
+ */
+export interface ListDigitalHumansResponse {
+    /** Current page number */
+    pageNumber: number;
+    /** Page size */
+    pageSize: number;
+    /** Total pages */
+    totalPages: number;
+    /** Total items */
+    totalItems: number;
+    /** Digital human list */
+    contents: DigitalHuman[];
+}
+/**
+ * Digital human organization mapping
+ */
+export interface DigitalHumanOrganization {
+    /** Digital human ID */
+    aiDigitalHumanId: number;
+    /** Organization IDs */
+    organizationIds: number[];
+    /** Whether to include child organizations */
+    includeChildren: boolean;
+}
+/**
+ * Parameters for listing digital human organizations
+ */
+export interface ListOrganizationsParams {
+    /** Comma-separated digital human IDs */
+    aiDigitalHumanIds: string;
+}
+/**
+ * Item for setting digital human organizations
+ */
+export interface SetOrganizationsItem {
+    /** Digital human ID */
+    aiDigitalHumanId: number;
+    /** Organization IDs */
+    organizationIds: number[];
+    /** Whether to include child organizations */
+    includeChildren?: boolean;
+}
+/**
+ * Parameters for setting digital human organizations
+ */
+export interface SetOrganizationsParams {
+    /** Organization mapping items */
+    items: SetOrganizationsItem[];
+}
+/**
+ * Video produce status enum
+ */
+export declare enum VideoProduceStatus {
+    /** Draft */
+    DRAFT = 5,
+    /** Waiting for processing */
+    WAITING = 10,
+    /** Processing */
+    PROCESSING = 15,
+    /** Success */
+    SUCCESS = 20,
+    /** Failed */
+    FAILED = 30,
+    /** Expired */
+    EXPIRED = 50
+}
+/**
+ * Video produce task entity
+ */
+export interface VideoProduceTask {
+    /** Task ID */
+    id: number;
+    /** Video name */
+    videoName: string;
+    /** Type (1: no digital human, 3: with digital human) */
+    type: number;
+    /** Task status */
+    status: VideoProduceStatus;
+    /** Video path URL (null if not completed) */
+    videoPath: string | null;
+    /** Video thumbnail URL (null if not completed) */
+    videoImage: string | null;
+    /** Video file size in bytes (null if not completed) */
+    videoFileSize: number | null;
+    /** Duration in seconds (null if not completed) */
+    duration: number | null;
+    /** Digital human ID (null if no digital human) */
+    digitalHumanId: number | null;
+    /** Processing time in seconds (null if not completed) */
+    dealTime: number | null;
+    /** Creation timestamp (milliseconds) */
+    createTime: number;
+    /** Last modification timestamp (milliseconds) */
+    modifyTime: number;
+    /** Subtitle file path (null if no subtitle) */
+    subtitlePath: string | null;
+    /** Tags */
+    tags: string[];
+}
+/**
+ * Parameters for listing video produce tasks
+ */
+export interface ListVideoProducesParams {
+    /** Page number (>= 1) */
+    pageNumber: number;
+    /** Page size (1-1000) */
+    pageSize: number;
+    /** Filter by video name (fuzzy match) */
+    videoName?: string;
+    /** Filter by status */
+    status?: VideoProduceStatus;
+    /** Filter by creation time start (milliseconds) */
+    createTimeStart?: number;
+    /** Filter by creation time end (milliseconds) */
+    createTimeEnd?: number;
+    /** Filter by tags */
+    tags?: string[];
+}
+/**
+ * Response for listing video produce tasks
+ */
+export interface ListVideoProducesResponse {
+    /** Current page number */
+    pageNumber: number;
+    /** Page size */
+    pageSize: number;
+    /** Total pages */
+    totalPages: number;
+    /** Total items */
+    totalItems: number;
+    /** Video produce task list */
+    contents: VideoProduceTask[];
+}
+/**
+ * Parameters for getting a video produce task
+ */
+export interface GetVideoProduceParams {
+    /** Task ID */
+    id: number;
+}
+/**
+ * TTS voice info for video creation
+ */
+export interface TtsVoiceInfo {
+    /** TTS voice ID */
+    ttsVoiceId: number;
+    /** Speech rate (0.5 - 2.0) */
+    rate: number;
+}
+/**
+ * Subtitle info for video creation
+ */
+export interface SubtitleInfo {
+    /** Whether to enable subtitle */
+    enableSubtitle: boolean;
+}
+/**
+ * Material info for video creation
+ */
+export interface MaterialInfo {
+    /** Background image URL */
+    backgroundImage: string;
+    /** Remark/content text */
+    remark?: string;
+    /** Audio file URL */
+    audioFileUrl?: string;
+}
+/**
+ * Digital human position info for video creation
+ */
+export interface DigitalHumanInfo {
+    /** Digital human ID (null for random) */
+    digitalHumanId: number | null;
+    /** X position */
+    x: number | null;
+    /** Y position */
+    y: number | null;
+    /** Width */
+    w: number | null;
+    /** Height */
+    h: number | null;
+}
+/**
+ * Item for batch creating video produce tasks
+ */
+export interface BatchCreateVideoProducesItem {
+    /** Video name */
+    videoName: string;
+    /** Whether to include digital human */
+    hasDigitalHuman: boolean;
+    /** TTS voice info */
+    ttsVoiceInfo: TtsVoiceInfo;
+    /** Subtitle info */
+    subtitleInfo: SubtitleInfo;
+    /** PPT file ID */
+    fileId?: string;
+    /** Material info list */
+    materialInfos?: MaterialInfo[];
+    /** Digital human info list (required if hasDigitalHuman is true) */
+    digitalHumanInfos?: DigitalHumanInfo[];
+    /** Tags */
+    tags?: string[];
+}
+/**
+ * Parameters for batch creating video produce tasks
+ */
+export interface BatchCreateVideoProducesParams {
+    /** Task list (max 20) */
+    tasks: BatchCreateVideoProducesItem[];
+}
+/**
+ * Response for batch creating video produce tasks
+ */
+export interface BatchCreateVideoProducesResponse {
+    /** Whether successful */
+    success: boolean;
+    /** Number of created tasks */
+    createdCount: number;
+}
+/**
+ * Parameters for deleting a video produce task
+ */
+export interface DeleteVideoProduceParams {
+    /** Task ID */
+    id: number;
+}
+/**
+ * PPT status enum
+ */
+export declare enum PptStatus {
+    /** Normal */
+    NORMAL = "normal",
+    /** Upload failed */
+    FAIL_UPLOAD = "failUpload",
+    /** Waiting for conversion */
+    WAIT_CONVERT = "waitConvert",
+    /** Conversion failed */
+    FAIL_CONVERT = "failConvert"
+}
+/**
+ * Video produce PPT entity
+ */
+export interface VideoProducePpt {
+    /** File ID */
+    fileId: string;
+    /** File name */
+    fileName: string;
+    /** File URL */
+    fileUrl: string;
+    /** Total pages (null if not converted) */
+    totalPage: number | null;
+    /** PPT status */
+    status: PptStatus;
+    /** Conversion type */
+    convertType: 'common' | 'animate';
+    /** Preview image URL */
+    previewImage: string;
+    /** Large preview image URL */
+    previewBigImage: string;
+    /** Creation timestamp (milliseconds) */
+    createTime: number;
+}
+/**
+ * Parameters for listing video produce PPTs
+ */
+export interface ListVideoProducePptsParams {
+    /** Page number (>= 1) */
+    pageNumber: number;
+    /** Page size (1-1000) */
+    pageSize: number;
+}
+/**
+ * Response for listing video produce PPTs
+ */
+export interface ListVideoProducePptsResponse {
+    /** Current page number */
+    pageNumber: number;
+    /** Page size */
+    pageSize: number;
+    /** Total pages */
+    totalPages: number;
+    /** Total items */
+    totalItems: number;
+    /** PPT list */
+    contents: VideoProducePpt[];
+}
+/**
+ * Parameters for getting a video produce PPT
+ */
+export interface GetVideoProducePptParams {
+    /** File ID */
+    fileId: string;
+}
+/**
+ * Parameters for uploading a video produce PPT
+ */
+export interface UploadVideoProducePptParams {
+    /** PPT file URL */
+    url: string;
+    /** Document name (optional) */
+    docName?: string;
+}
+/**
+ * Response for uploading a video produce PPT
+ */
+export interface UploadVideoProducePptResponse {
+    /** File ID */
+    fileId: string;
+    /** File name */
+    fileName: string;
+}
+/**
+ * TTS voice tag enum
+ */
+export declare enum TtsVoiceTag {
+    /** Male voice */
+    MALE_VOICE = "MALE_VOICE",
+    /** Female voice */
+    FEMALE_VOICE = "FEMALE_VOICE",
+    /** Children voice */
+    CHILDREN_VOICE = "CHILDREN_VOICE",
+    /** Custom voice */
+    CUSTOM_VOICE = "CUSTOM_VOICE",
+    /** Others */
+    OTHERS = "OTHERS"
+}
+/**
+ * TTS voice entity
+ */
+export interface TtsVoice {
+    /** Voice ID */
+    id: number;
+    /** Voice name */
+    voiceName: string;
+    /** Demo audio URL */
+    voiceDemoUrl: string;
+    /** Voice tag */
+    tag: TtsVoiceTag;
+}
+//# sourceMappingURL=v4-ai.d.ts.map

package/dist/types/v4-ai.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"v4-ai.d.ts","sourceRoot":"","sources":["../../src/types/v4-ai.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAMH;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,uBAAuB;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,yBAAyB;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,4BAA4B;IAC5B,aAAa,EAAE,MAAM,CAAC;IACtB,sBAAsB;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,0BAA0B;IAC1B,aAAa,EAAE,MAAM,CAAC;IACtB,0BAA0B;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,2BAA2B;IAC3B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,wCAAwC;IACxC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,yBAAyB;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,yBAAyB;IACzB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,0BAA0B;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,kBAAkB;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,yBAAyB;IACzB,QAAQ,EAAE,YAAY,EAAE,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,uBAAuB;IACvB,gBAAgB,EAAE,MAAM,CAAC;IACzB,uBAAuB;IACvB,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,6CAA6C;IAC7C,eAAe,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,wCAAwC;IACxC,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,uBAAuB;IACvB,gBAAgB,EAAE,MAAM,CAAC;IACzB,uBAAuB;IACvB,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,6CAA6C;IAC7C,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,iCAAiC;IACjC,KAAK,EAAE,oBAAoB,EAAE,CAAC;CAC/B;AAMD;;GAEG;AACH,oBAAY,kBAAkB;IAC5B,YAAY;IACZ,KAAK,IAAI;IACT,6BAA6B;IAC7B,OAAO,KAAK;IACZ,iBAAiB;IACjB,UAAU,KAAK;IACf,cAAc;IACd,OAAO,KAAK;IACZ,aAAa;IACb,MAAM,KAAK;IACX,cAAc;IACd,OAAO,KAAK;CACb;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,cAAc;IACd,EAAE,EAAE,MAAM,CAAC;IACX,iBAAiB;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,wDAAwD;IACxD,IAAI,EAAE,MAAM,CAAC;IACb,kBAAkB;IAClB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,6CAA6C;IAC7C,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,kDAAkD;IAClD,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,uDAAuD;IACvD,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,kDAAkD;IAClD,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,kDAAkD;IAClD,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,yDAAyD;IACzD,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,wCAAwC;IACxC,UAAU,EAAE,MAAM,CAAC;IACnB,iDAAiD;IACjD,UAAU,EAAE,MAAM,CAAC;IACnB,+CAA+C;IAC/C,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,WAAW;IACX,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,yBAAyB;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,yBAAyB;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,yCAAyC;IACzC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,uBAAuB;IACvB,MAAM,CAAC,EAAE,kBAAkB,CAAC;IAC5B,mDAAmD;IACnD,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,iDAAiD;IACjD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,qBAAqB;IACrB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,0BAA0B;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,kBAAkB;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,8BAA8B;IAC9B,QAAQ,EAAE,gBAAgB,EAAE,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,cAAc;IACd,EAAE,EAAE,MAAM,CAAC;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,mBAAmB;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,iCAAiC;IACjC,cAAc,EAAE,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,2BAA2B;IAC3B,eAAe,EAAE,MAAM,CAAC;IACxB,0BAA0B;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,qBAAqB;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,yCAAyC;IACzC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,iBAAiB;IACjB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjB,iBAAiB;IACjB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjB,YAAY;IACZ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjB,aAAa;IACb,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,iBAAiB;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,uCAAuC;IACvC,eAAe,EAAE,OAAO,CAAC;IACzB,qBAAqB;IACrB,YAAY,EAAE,YAAY,CAAC;IAC3B,oBAAoB;IACpB,YAAY,EAAE,YAAY,CAAC;IAC3B,kBAAkB;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,yBAAyB;IACzB,aAAa,CAAC,EAAE,YAAY,EAAE,CAAC;IAC/B,oEAAoE;IACpE,iBAAiB,CAAC,EAAE,gBAAgB,EAAE,CAAC;IACvC,WAAW;IACX,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,yBAAyB;IACzB,KAAK,EAAE,4BAA4B,EAAE,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C,yBAAyB;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,8BAA8B;IAC9B,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,cAAc;IACd,EAAE,EAAE,MAAM,CAAC;CACZ;AAED;;GAEG;AACH,oBAAY,SAAS;IACnB,aAAa;IACb,MAAM,WAAW;IACjB,oBAAoB;IACpB,WAAW,eAAe;IAC1B,6BAA6B;IAC7B,YAAY,gBAAgB;IAC5B,wBAAwB;IACxB,YAAY,gBAAgB;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,cAAc;IACd,MAAM,EAAE,MAAM,CAAC;IACf,gBAAgB;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,0CAA0C;IAC1C,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,iBAAiB;IACjB,MAAM,EAAE,SAAS,CAAC;IAClB,sBAAsB;IACtB,WAAW,EAAE,QAAQ,GAAG,SAAS,CAAC;IAClC,wBAAwB;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,8BAA8B;IAC9B,eAAe,EAAE,MAAM,CAAC;IACxB,wCAAwC;IACxC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,yBAAyB;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,yBAAyB;IACzB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,0BAA0B;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,kBAAkB;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe;IACf,QAAQ,EAAE,eAAe,EAAE,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,cAAc;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,mBAAmB;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,+BAA+B;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,cAAc;IACd,MAAM,EAAE,MAAM,CAAC;IACf,gBAAgB;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,oBAAY,WAAW;IACrB,iBAAiB;IACjB,UAAU,eAAe;IACzB,mBAAmB;IACnB,YAAY,iBAAiB;IAC7B,qBAAqB;IACrB,cAAc,mBAAmB;IACjC,mBAAmB;IACnB,YAAY,iBAAiB;IAC7B,aAAa;IACb,MAAM,WAAW;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,eAAe;IACf,EAAE,EAAE,MAAM,CAAC;IACX,iBAAiB;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,qBAAqB;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB;IAChB,GAAG,EAAE,WAAW,CAAC;CAClB"}