web-video-creator/preprocessor/video/VideoConfig.js

A framework for creating videos based on Node.js + Puppeteer + FFmpeg.

import assert from "assert";
import _ from "lodash";

import util from "../../lib/util.js";

export default class VideoConfig {

    /** @type {string} - 视频URL */
    url;
    /** @type {string} - 蒙版视频URL */
    maskUrl;
    /** @type {number} - 开始播放时间点（毫秒） */
    startTime;
    /** @type {number} - 结束播放时间（毫秒） */
    endTime;
    /** @type {number} - 内部音频ID */
    audioId;
    /** @type {number} - 裁剪开始时间点（毫秒） */
    seekStart;
    /** @type {number} - 裁剪结束时间点（毫秒） */
    seekEnd;
    /** @type {number} - 音频淡入时长（毫秒） */
    fadeInDuration;
    /** @type {number} - 音频淡出时长（毫秒） */
    fadeOutDuration;
    /** @type {boolean} - 是否自动播放 */
    autoplay;
    /** @type {number} - 视频音量（0-100） */
    volume;
    /** @type {boolean} - 是否循环播放 */
    loop;
    /** @type {boolean} - 是否静音 */
    muted;
    /** @type {number} - 重试下载次数 */
    retryFetchs;
    /** @type {boolean} - 是否忽略本地缓存 */
    ignoreCache;

    /**
     * 构造函数
     * 
     * @param {Object} options - 视频配置选项
     * @param {string} options.url - 视频URL
     * @param {number} options.startTime - 开始播放时间点（毫秒）
     * @param {number} options.endTime - 结束播放时间点（毫秒）
     * @param {string} [options.maskUrl] - 蒙版视频URL
     * @param {string} [options.format] - 视频格式（mp4/webm）
     * @param {number} [options.audioId] - 内部音频ID
     * @param {number} [options.seekStart] - 裁剪开始时间点（毫秒）
     * @param {number} [options.seekEnd] - 裁剪结束时间点（毫秒）
     * @param {number} [options.fadeInDuration] - 音频淡入时长（毫秒）
     * @param {number} [options.fadeOutDuration] - 音频淡出时长（毫秒）
     * @param {boolean} [options.autoplay] - 是否自动播放
     * @param {number} [options.volume] - 视频音量
     * @param {boolean} [options.loop] - 是否循环播放
     * @param {boolean} [options.muted] - 是否静音
     * @param {boolean} [options.retryFetchs] - 重试下载次数
     * @param {boolean} [options.ignoreCache] - 是否忽略本地缓存
     */
    constructor(options) {
        assert(_.isObject(options), "VideoConfig options must be Object");
        const { url, maskUrl, format, startTime, endTime, audioId, seekStart, seekEnd, fadeInDuration, fadeOutDuration, autoplay, volume, loop, muted, retryFetchs, ignoreCache } = options;
        assert(util.isURL(url), "url is invalid");
        assert(_.isFinite(startTime), "startTime must be number");
        assert(_.isFinite(endTime), "endTime must be number");
        assert(_.isUndefined(maskUrl) || util.isURL(maskUrl), "maskUrl is invalid");
        assert(_.isUndefined(format) || _.isString(format), "format mudt be string");
        assert(_.isUndefined(audioId) || _.isFinite(audioId), "audioId must be number");
        assert(_.isUndefined(seekStart) || _.isFinite(seekStart), "seekStart must be number");
        assert(_.isUndefined(seekEnd) || _.isFinite(seekEnd), "seekEnd must be number");
        assert(_.isUndefined(fadeInDuration) || _.isFinite(fadeInDuration), "fadeInDuration must be number");
        assert(_.isUndefined(fadeOutDuration) || _.isFinite(fadeOutDuration), "fadeOutDuration must be number");
        assert(_.isUndefined(autoplay) || _.isBoolean(autoplay), "autoplay must be number");
        assert(_.isUndefined(volume) || _.isFinite(volume), "volume must be number");
        assert(_.isUndefined(loop) || _.isBoolean(loop), "loop must be boolean");
        assert(_.isUndefined(muted) || _.isBoolean(muted), "muted must be boolean");
        this.url = url;
        this.maskUrl = maskUrl;
        this.format = _.defaultTo(format, util.getURLExtname(this.url));
        this.startTime = startTime;
        this.endTime = endTime;
        this.audioId = audioId;
        this.seekStart = seekStart;
        this.seekEnd = seekEnd;
        this.fadeInDuration = fadeInDuration;
        this.fadeOutDuration = fadeOutDuration;
        this.autoplay = autoplay;
        this.volume = volume;
        this.loop = loop;
        this.muted = muted;
        this.retryFetchs = retryFetchs;
        this.ignoreCache = ignoreCache;
    }

}