ffcreator/types/lib/FFCreator.d.ts

FFCreator is a lightweight and flexible short video production library

/// <reference path="FFCon.d.ts" />
/// <reference path="Conf.d.ts" />
/// <reference path="FFBase.d.ts" />

declare namespace FFCreatorSpace {
  interface FFCreatorConf extends ConfOptions {
    log?: boolean;
    audio?: FFAudioConf | string;
  }

  interface FFCreatorEventMap {
    progress: FFCreatorProgressEvent;
    complete: FFCreatorCompleteEvent;
    start: FFCreatorStartEvent;
    error: FFCreatorErrorEvent;
  }

  type FFCreatorStartEvent = {
    type: 'start';
  };

  type FFCreatorProgressEvent = {
    type: 'progress';
    percent: number;
  };

  type FFCreatorCompleteEvent = {
    type: 'complete';
    output: string;
    useage: string;
  };

  type FFCreatorErrorEvent = {
    type: 'error';
    pos: unknown;
    error: string;
  };
  class FFCreator extends FFCon {
    constructor(conf: FFCreatorConf);

    inCenter: boolean;  
    destroyed: boolean;  
    cleanAllCache: boolean;  

    on<K extends keyof FFCreatorEventMap>(name: K, fn: (ev: FFCreatorEventMap[K]) => any): void;

    /**
     *  Create output path, only used when using FFCreatorCenter.
     */
    generateOutput(): void;

    /**
     *  Get FFmpeg command line.
     */
    getFFmpeg(): void;

    /**
     * Set the fps of the composite video.
     * @param fps
     */
    setFps(fps: number): void;

    /**
     * Set the total duration of the composite video.
     * @param duration
     */
    setDuration(duration: number): void;

    /**
     *  Set configuration.
     * @param  key - the config key
     * @param  val - the config val
     * @param key
     * @param val
     */
    setConf(key: string, val: any): void;

    /**
     * Get configuration
     * @param key
     */
    getConf(key: string): any;

    /**
     * add audio
     * @param args FFAudio or audio config
     */
    addAudio(args: FFAudio | FFAudioConf): void;

    /**
     * set width and height
     * @param width
     * @param height
     */
    setSize(width: number, height: number): void;

    /**
     * Set the video output path
     * @param output - the video output path
     */
    setOutput(output: string): void;

    /**
     * Get the video output path
     */
    getFile(): string;

    /**
     * Set the video output path
     * @param  output - the video output path
     */
    output(output: string): void;

    /**
     * Close logger switch
     */
    closeLog(): void;

    /**
     * Open logger switch
     */
    openLog(): void;

    /**
     * Hook handler function
     * @todo 补全options类型
     * @param options
     */
    setInputOptions(options: Record<string, unknown>): void;

    /**
     * Start video processing
     * @param delay default 25
     */
    start(delay?: number): Promise<unknown>;

    /**
     * Set the installation path of the current server ffmpeg.
     * @param path
     */
    static setFFmpegPath(path: string): void;

    /**
     * Set the installation path of the current server ffprobe.
     * @param path
     */
    static setFFprobePath(path: string): void;

    static setFFPath(): void;

    /**
     * Create new effect and add to effects object
     * @param name the new effect name
     * @param effectConf the new effect value
     */
    createEffect(name: string, effectConf: FFAnimationConf): void;

    /**
     * Set as the first frame cover page image
     * @param cover the cover face image path
     */
    setCover(cover: string): void;

    destroy():void;

    /**
     * Create new effect and add to effects object
     * @param name the new effect name
     * @param params the new effect value
     */
    createEffect(
      name: string,
      params: {
        from: Record<string, any>;
        to: Record<string, any>;
        ease?: AnamiationEaseTypes;
        time?: number;
        delay?: number;
      },
    ): void;
  }
}