Skip to content

README.md

Latest commit

 

History

History
67 lines (49 loc) · 2.4 KB

README.md

File metadata and controls

67 lines (49 loc) · 2.4 KB
Raw

ffmpeg-runner

ffmpeg-runner is a simple tool based on Node.js that builds an .exe file capable of executing FFMpeg command-line commands.

Usage

By using this tool, you can package an executable program that can execute FFMpeg commands.

You can run it using the .exe file, or start it using start.bat or start.vbs, and stop it using stop.bat or stop.vbs.

Structure

├── ffmpeg-runner               # Source code directory
│   ├── dist                    # Packaged artifact
│       ├── assets              # FFMpeg program
│       ├── .env                # Environment variables during runtime
│       ├── ffmpeg-start.bat    # .bat file for running ffmpeg.exe
│       ├── ffmpeg-start.vbs    # .vbs file for running ffmpeg.exe
│       ├── ffmpeg-stop.bat     # .bat file for killing ffmpeg.exe
│       ├── ffmpeg-stop.vbs     # .vbs file for killing ffmpeg.exe
│       └── ffmpeg.exe          # The executable program that is running
│   ├── public                  # FFmpeg command builder module
│       └── mediamtx            # MediaMtx module(a simple RTSP server)
│   └── src                     # FFmpeg command builder module
│       ├── assets              # FFMpeg program
│       ├── build.js            # Script for building the application
│       ├── copy.js             # Script for copying crucial files
│       ├── main.js             # Main module
│       ├── scripts.js          # Generate a FFMpeg script
│       └── server.js           # Runner module
├── .env                        # Environment variables during runtime
├── .env.build                  # Environment variables during packaging
├── .gitignore                  # Git ignore file
├── LICENSE                     # License file
└── README.md                   # This file

Content-related

You can find and download them through the following.

  • FFMpeg: FFMpeg program
  • mediamtx: MediaMtx module(a simple RTSP server)

Development

# Clone
git clone https://github.com/MrZhuA00/ffmpeg-runner.git

cd ffmpeg-runner

npm install

# dev
npm run dev

# Build
npm run build

License

Made with 💛

Published under MIT License.