SAVE_DRAFTAPI接口文档接口信息展开代码语言:TXTAI代码解释POST/openapi/capcut-mate/v1/save_draft功能描述保存剪映草稿。
快速开始目录简介项目结构核心组件架构总览详细组件分析依赖分析性能注意事项故障排查指南结论附录简介capcut-mate是一个面向剪映(CapCut)的自动化辅助服务,提供草稿创建、媒体素材添加、字幕与特效处理 附录环境要求Python:>=3.11Node.js:用于桌面客户端(随Electron依赖)Windows/macOS:桌面客户端与剪映集成依赖新增网络浏览器:支持Accept-Language请求头的语言检测功能安装与运行步骤方式一 文件中设置草稿下载URL、下载URL前缀、提示URL等方式三:桌面客户端使用1)安装依赖在桌面客户端根目录与web子目录分别安装依赖2)启动桌面应用使用Electron启动主进程3)配置草稿路径在"配置中心"页面选择剪映草稿保存路径 test_cross_platform.py验证功能导入跨平台功能对比更新详细的跨平台功能对比表功能特性Windows平台Linux平台✅完整的视频导出自动化功能✓✗(需要手动导出)✅UI界面操作支持✓✗(占位符功能)✅剪映应用控制
获取草稿文件列表。该接口用于获取指定草稿ID对应的所有文件列表,可以查看草稿中包含的素材文件、配置文件等信息。通常用于草稿内容的预览、文件管理或状态检查。
CREATE_DRAFT API 接口文档接口信息POST /openapi/capcut-mate/v1/create_draft功能描述创建剪映草稿。 该接口用于创建一个新的剪映草稿项目,可以自定义视频的宽度和高度。创建成功后会返回草稿URL和帮助文档URL,为后续的视频编辑操作提供基础。
capcut-mate容器]-->B[FastAPI应用]B-->C[草稿下载服务]C-->D[文件系统]E[Nginx服务器]-->F[静态文件服务]F-->G[输出目录文件]endsubgraph"外部服务"H[剪映客户端 TXTAI代码解释flowchartTDA[接收草稿URL]-->B[提取草稿ID]B-->C[准备目标目录]C-->D[获取文件列表]D-->E[下载所有文件]E-->F[更新JSON路径]F-->G[触发剪映扫描 Windows平台:完整功能,包括剪映自动化导出可选安装:Windows用户可通过pipinstallcapcut-mate[windows]获取完整功能性能考虑容器资源优化内存和CPU限制内存限制:2GB docs.jcaigc.cn跨平台兼容性问题Windows依赖缺失症状:在非Windows平台运行时出现ImportError解决方案:展开代码语言:BashAI代码解释#非Windows平台正常运行(无剪映自动化功能 /localtime:/etc/localtime:ro-/etc/timezone:/etc/timezone:ro跨平台安装指南非Windows平台展开代码语言:BashAI代码解释#基础安装(无剪映自动化功能
字幕处理接口是 CapCut Mate 项目的核心功能模块,提供完整的字幕管理解决方案。该接口支持批量添加字幕、样式配置、信息生成等功能,涵盖文本格式、时间轴定位、字体样式、颜色配置和动画效果等方面。
项目介绍目录引言项目发展历程核心价值主张设计理念与创新点主要应用场景目标用户群体项目资源工作流示例项目结构核心组件架构总览详细组件分析依赖关系分析性能考量故障排查指南结论引言CapCutMateAPI是一个完全开源免费的剪映自动化助手 该项目专注于为大模型赋能基础视频编辑能力,提供开箱即用的视频编辑技能,并已完全自动化了剪映核心功能工作流。它可以直接连接大模型,实现多样化的智能视频编辑,让普通用户能够快速制作专业级的视频作品。 桌面客户端(草稿下载与配置)下载页面功能:输入草稿地址(支持多行),自动解析draft_id并获取文件列表过滤匹配的文件,调用ElectronAPI保存到本地实时显示下载日志,支持清空配置中心功能:设置剪映草稿保存路径 :检查剪映是否已启动且窗口可见,确认自动化控件匹配条件导出超时:检查草稿大小与素材质量,适当降低导出分辨率/帧率草稿下载失败:确认草稿地址有效且包含draft_id参数,检查网络连通性与目标路径权限权限问题处理 插件问题:检查插件配置和API密钥设置n8n工作流问题:验证工作流配置和节点连接容器化部署问题:检查Docker配置和环境变量设置结论CapCutMateAPI通过标准化的OpenAPI与桌面客户端,将剪映的草稿创建
特效应用接口目录简介项目结构核心组件架构概览详细组件分析依赖关系分析性能考虑故障排除指南结论简介特效应用接口是剪映草稿管理系统的重要组成部分,负责向现有草稿中添加各种视频特效。 项目结构剪映特效应用接口基于模块化架构设计,主要分为以下几个层次:展开代码语言:TXTAI代码解释graphTBsubgraph"API层"Router[路由层]Schema[数据模型层]endsubgraph :预览限制:某些特效在预览模式下可能不可见,但在最终视频生成时会正常应用效果叠加:系统支持多个特效在同一时间段叠加应用兼容性:不同特效类型之间可能存在兼容性问题,建议测试后再批量应用结论特效应用接口为剪映草稿管理系统提供了完整的特效添加功能
DRAFT_DIR、TEMP_DIR、DRAFT_URL、DOWNLOAD_URL、TIP_URL、STICKER_CONFIG_PATH、TEMPLATE_DIR云渲染必需:DRAFT_SAVE_PATH(剪映草稿保存路径 生产环境编排(挂载输出目录、时区、环境变量、资源限制、重启策略)docker-compose.example.yaml:示例环境编排(生产环境参考配置)跨平台支持Windows平台:完整功能,包括UI自动化和剪映控制 CrossPlat["跨平台支持
pyJianYingDraft"]endsubgraph"外部系统"COS["腾讯云COS"]Nginx["静态资源服务
nginx"]Jianying["剪映导出流程 port","8000"]功能差异对比功能Windows平台Linux平台API服务功能✅完整支持✅完整支持草稿管理✅支持✅支持素材处理✅支持✅支持视频自动导出✅支持❌不支持UI界面操作✅支持❌不支持剪映应用控制 C.云渲染环境搭建与监控告警建议云渲染环境搭建安装并运行剪映专业版,确保可导出草稿配置DRAFT_SAVE_PATH指向剪映草稿目录配置ENABLE_APIKEY为true,接入积分服务COS对象存储集成配置
代码结构说明目录简介项目结构核心组件架构总览详细组件分析依赖关系分析性能考量故障排查指南结论附录简介本项目为CapCutMate(剪映助手)的后端与桌面客户端一体化方案,采用“Python后端+Electron 项目结构项目采用模块化分层组织:根目录:后端入口、配置、Docker支持、测试与文档src:后端核心代码,包含路由、服务、中间件、工具与剪映草稿模型desktop-client:Electron桌面应用 ,包含主进程、预加载脚本、React前端与NodeAPItemplate:剪映草稿模板资源tests:后端接口与业务逻辑测试docs:功能使用文档展开代码语言:TXTAI代码解释graphTBsubgraph ,注册路由与中间件,启动服务路由层集中定义v1版本的所有API,每个路由对应一个服务方法中间件准备中间件:确保草稿与临时目录存在统一响应中间件:标准化成功/失败响应与异常处理服务层聚合业务逻辑,封装对剪映草稿模型与工具的调用示例 setupIpcHandlers权限错误:主进程对未捕获异常进行记录并在macOS上弹窗提示浏览器环境:electronService在浏览器环境使用模拟实现,部分功能不可用结论本项目通过清晰的分层架构与前后端分离设计,实现了剪映草稿的自动化处理与桌面应用的便捷使用
:TXTAI代码解释sequenceDiagramparticipantClientas"桌面客户端"participantAPIas"FastAPI服务"participantJianyingas"剪映控制 "participantCOSas"腾讯云存储"Client->>API:HTTP请求API->>API:验证请求API->>Jianying:控制剪映窗口Jianying-->>API:导出状态API
媒体处理功能目录简介项目结构核心组件架构概览详细组件分析依赖关系分析性能考虑故障排除指南结论简介CapCutMate是一个基于剪映(CapCut)的专业视频编辑辅助工具,提供完整的媒体处理功能。 本系统采用现代化的架构设计,通过FastAPI提供RESTfulAPI接口,结合剪映自动化控制技术,实现了从媒体文件解析、格式转换、时长计算到轨道分配的完整处理流程。 ImageSvc[图片处理服务]GenSvc[生成服务]endsubgraph"工具层"MediaUtil[媒体工具]TaskMgr[任务管理器]DraftCache[草稿缓存]endsubgraph"剪映集成层 "JYController[剪映控制器]Segment[片段管理]Track[轨道管理]endRouter-->SchemaRouter-->VideoSvcRouter-->AudioSvcRouter UI自动化技术与剪映应用进行交互:剪映状态管理展开代码语言:TXTAI代码解释stateDiagram-v2[*]-->home:主页home-->edit:进入编辑页edit-->pre_export
API接口文档目录简介项目结构核心组件架构概览详细组件分析双语文档依赖关系分析性能考虑故障排除指南小结简介CapCutMate提供RESTfulAPI,用于自动化剪映草稿管理与视频生成。 ["v1路由模块
src/router/v1.py"]C-->D["请求模型
src/schemas/*.py"]C-->E["服务层调用
service.*"]E-->F["剪映控制 /响应模型
src/schemas/*.py"]D["文档与OpenAPI"]endsubgraph"业务层"S["服务层
service.*"]endsubgraph"控制层"J["剪映控制器 依赖关系分析组件耦合路由模块依赖请求/响应模型与服务层;服务层依赖剪映控制器进行底层操作文档系统与路由模块相互独立,通过接口定义进行关联外部依赖FastAPI提供路由与请求/响应模型校验;剪映控制器负责窗口与素材交互文档系统依赖 提升整体效率时间线计算使用时间线工具提前规划素材分布,避免运行时动态计算带来的延迟资源复用合理设置透明度与缩放比例,减少不必要的渲染开销异步渲染视频生成采用异步任务,建议使用查询状态接口轮询进度故障排除指南无法连接剪映确认剪映已安装并可被系统识别
滤镜系统文档目录简介项目结构核心组件架构概览详细组件分析依赖关系分析性能考虑故障排除指南结论简介CapCutMate是一个基于Python的剪映草稿处理系统,专门用于自动化视频编辑工作流。
本文件面向 capcut-mate 桌面客户端的 IPC 通信机制,系统性阐述主进程与渲染进程之间的消息传递、预加载脚本的安全桥接、具体 IPC 处理程序的实现细节,以及通信协议设计、错误处理与性能优化的最佳实践。同时提供自定义 IPC 处理程序的开发指南,帮助开发者快速扩展功能。
处理器返回;确认目标目录权限参考路径:desktop-client/nodeapi/ipcHandlers.js、desktop-client/nodeapi/logger.js5.自动化控制异常现象:剪映窗口未激活或导出状态异常排查 :检查窗口激活逻辑与日志;确认剪映安装与路径配置参考路径:main.py6.常见问题与预防目录权限不足预防:启动前通过PrepareMiddleware创建目录;在macOS检查沙箱权限参考路径:src
剪映控制器可用性:根据平台特性检测功能可用性。
视频生成流程目录简介项目结构核心组件架构概览详细组件分析依赖关系分析性能考虑故障排除指南结论附录简介本项目提供了一个完整的云端视频生成解决方案,基于剪映专业版的自动化控制实现。 通过异步任务队列管理和剪映自动化控制,实现了稳定的云端渲染服务。新增对非Windows平台的兼容性处理,当Windows依赖不可用时提供优雅降级机制。 :草稿文件列表获取多文件并行下载路径解析和文件写入目录扫描和缓存管理剪映控制器提供剪映应用程序的自动化控制:窗口状态检测和切换导出流程自动化分辨率和帧率设置错误处理和超时管理平台检测机制:在非Windows :支持最多3次的网络请求重试剪映自动化控制实现剪映应用程序的完整自动化控制:平台检测机制导入保护:非Windows平台直接抛出ImportError异常依赖检查:检查uiautomation库的可用性错误指导 :检查剪映版本和系统资源文件未生成:验证磁盘空间和剪映安装完整性窗口状态异常:确保剪映应用程序正常运行网络和存储问题下载失败:检查网络连接和文件URL有效性上传失败:验证COS配置和网络连接磁盘空间不足
重点涵盖以下方面:云渲染环境的技术架构与控制流腾讯云COS对象存储的配置与使用流程剪映草稿保存路径的配置方法云渲染必需的环境变量设置监控、日志收集与故障排查方法不同云服务商的兼容性说明与迁移指南项目结构该项目采用模块化设计 架构概览云渲染环境的核心流程包括:客户端请求进入API层,经中间件处理后调用服务层逻辑;服务层根据需求下载剪映草稿、处理媒体资源,并将产物上传至COS;最终通过统一响应格式返回结果。 使用robocopy触发剪映目录扫描,使其识别新文件。错误处理网络请求失败、IO错误、路径解析异常均有相应处理与日志记录。 剪映草稿保存路径配置本地路径DRAFT_SAVE_PATH指定剪映草稿保存位置(Windows路径示例)。 容器挂载docker-compose.yaml将宿主机目录挂载到/app/output,供剪映识别与访问。云渲染必需环境变量DRAFT_URL:草稿下载地址。
核心功能详解目录简介项目结构核心组件架构概览详细组件分析依赖关系分析性能考虑故障排除指南结论简介CapCutMate是一个基于Python的剪映自动化控制工具,提供完整的视频编辑自动化解决方案。 >AutomationDraftLib-->UtilsMediaLib-->UtilsEffectLib-->Utils核心组件CapCutMate的核心功能围绕四个主要组件构建:1.草稿管理系统负责剪映草稿的创建 NotifyClient-->End([完成])ValidateAPIKey-->|密钥无效|Error[抛出异常]CheckPoints-->|积分不足|ErrorValidateDraft-->|URL无效|Error剪映自动化控制机制系统集成了剪映自动化控制功能 :窗口未找到权限不足版本不兼容解决方案:确认剪映已安装且可运行以管理员权限运行检查剪映版本兼容性双文件兼容模式问题症状:草稿文件保存后不一致原因:双文件同步失败文件权限问题模板格式不匹配解决方案:确保启用双文件兼容模式检查文件写入权限验证模板文件完整性结论 CapCutMate提供了一个完整、可靠的剪映自动化解决方案。