@lzwme/m3u8-dl/cjs/types/m3u8.d.ts

Batch download of m3u8 files and convert to mp4

import type { IncomingHttpHeaders } from 'node:http';
export interface TsItemInfo {
    /** ts 文件次序 */
    index: number;
    duration: number;
    timeline: number;
    /** ts 文件下载 url 地址 */
    uri: string;
    /** ts 文件下载保存路径 */
    tsOut: string;
    /** 下载成功的 ts 文件大小(byte) */
    tsSize?: number;
    /** 是否下载成功。成功为1，失败一次则减 1 */
    success?: number;
}
export interface M3u8Crypto {
    /** AES 加密 IV */
    iv: NodeJS.ArrayBufferView | string;
    /** 获取到的密钥值(hex) */
    key: string | NodeJS.ArrayBufferView;
    /** 加密方法 */
    method: string;
    /** 密钥获取接口 */
    uri: string;
}
export interface M3u8DLOptions {
    debug?: boolean;
    /** 是否显示内置的进度信息。默认为 true */
    showProgress?: boolean;
    /** 每当 ts 文件下载完成时回调，可用于自定义进度控制 */
    onProgress?: (finished: number, total: number, currentInfo: TsItemInfo) => void;
    /** 并发下载线程数。取决于服务器限制，过多可能会容易下载失败。一般建议不超过 8 个。默认为 cpu数 * 2，但不超过 8 */
    threadNum?: number;
    /** 要保存的文件名(路径) */
    filename?: string;
    /** 下载文件保存的路径。默认为当前目录 */
    saveDir?: string;
    /** 临时文件保存目录。默认为 cache/<md5(url)> */
    cacheDir?: string;
    /** 下载成功后是否删除临时文件。默认为 true。保存临时文件可以在重复下载时识别缓存 */
    delCache?: boolean;
    /** 文件已存在时是否仍强制下载和生成。默认为 false，文件已存在则跳过 */
    force?: boolean;
    /** 下载 m3u8、ts 等文件时自定义请求 headers */
    headers?: IncomingHttpHeaders;
    /** 下载时是否启动本地资源播放（边下边看） */
    play?: boolean;
}
export interface WorkerTaskInfo {
    info: TsItemInfo;
    crypto: M3u8Crypto;
    options: M3u8DLOptions;
}
export interface CliOptions extends M3u8DLOptions {
    silent?: boolean;
    progress?: boolean;
}