Skip to content

Add event listeners typings for fluent-ffmpeg #70019

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
weswigham merged 3 commits into from
Jul 29, 2024
Merged

Add event listeners typings for fluent-ffmpeg #70019

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b77b68a
Add event listeners typings
ChinHongTan Jul 10, 2024
55abb46
Add tests
ChinHongTan Jul 10, 2024
4093edd
formatting
ChinHongTan Jul 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions types/fluent-ffmpeg/fluent-ffmpeg-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,3 +105,26 @@ ffmpeg("/path/to/part1.avi")
.input("/path/to/part2.avi")
.input("/path/to/part2.avi")
.mergeToFile("/path/to/merged.avi", "/path/to/tempDir");

ffmpeg("/path/to/file.avi")
.on("start", (commandLine) => {
console.log("Spawned Ffmpeg with command: " + commandLine);
})
.on("codecData", (data) => {
console.log(
"Input is " + data.audio + " audio "
+ "with " + data.video + " video",
);
})
.on("progress", (progress) => {
console.log("Processing: " + progress.percent + "% done");
})
.on("stderr", (stderrLine) => {
console.log("Stderr output: " + stderrLine);
})
.on("error", (err, stdout, stderr) => {
console.log("Cannot process video: " + err.message);
})
.on("end", () => {
console.log("Transcoding succeeded !");
});
82 changes: 82 additions & 0 deletions types/fluent-ffmpeg/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -382,6 +382,88 @@ declare namespace Ffmpeg {
ffprobe(options: string[], callback: (err: any, data: FfprobeData) => void): void; // tslint:disable-line unified-signatures
ffprobe(index: number, options: string[], callback: (err: any, data: FfprobeData) => void): void;

// event listeners
/**
* Emitted just after ffmpeg has been spawned.
*
* @event FfmpegCommand#start
* @param {String} command ffmpeg command line
*/
on(event: "start", listener: (command: string) => void): this;

/**
* Emitted when ffmpeg reports progress information
*
* @event FfmpegCommand#progress
* @param {Object} progress progress object
* @param {Number} progress.frames number of frames transcoded
* @param {Number} progress.currentFps current processing speed in frames per second
* @param {Number} progress.currentKbps current output generation speed in kilobytes per second
* @param {Number} progress.targetSize current output file size
* @param {String} progress.timemark current video timemark
* @param {Number} [progress.percent] processing progress (may not be available depending on input)
*/
on(
event: "progress",
listener: (progress: {
frames: number;
currentFps: number;
currentKbps: number;
targetSize: number;
timemark: string;
percent?: number | undefined;
}) => void,
): this;

/**
* Emitted when ffmpeg outputs to stderr
*
* @event FfmpegCommand#stderr
* @param {String} line stderr output line
*/
on(event: "stderr", listener: (line: string) => void): this;

/**
* Emitted when ffmpeg reports input codec data
*
* @event FfmpegCommand#codecData
* @param {Object} codecData codec data object
* @param {String} codecData.format input format name
* @param {String} codecData.audio input audio codec name
* @param {String} codecData.audio_details input audio codec parameters
* @param {String} codecData.video input video codec name
* @param {String} codecData.video_details input video codec parameters
*/
on(
event: "codecData",
listener: (codecData: {
format: string;
audio: string;
audio_details: string;
video: string;
video_details: string;
}) => void,
): this;

/**
* Emitted when an error happens when preparing or running a command
*
* @event FfmpegCommand#error
* @param {Error} error error object, with optional properties 'inputStreamError' / 'outputStreamError' for errors on their respective streams
* @param {String|null} stdout ffmpeg stdout, unless outputting to a stream
* @param {String|null} stderr ffmpeg stderr
*/
on(event: "error", listener: (error: Error, stdout: string | null, stderr: string | null) => void): this;

/**
* Emitted when a command finishes processing
*
* @event FfmpegCommand#end
* @param {Array|String|null} [filenames|stdout] generated filenames when taking screenshots, ffmpeg stdout when not outputting to a stream, null otherwise
* @param {String|null} stderr ffmpeg stderr
*/
on(event: "end", listener: (filenames: string[] | string | null, stderr: string | null) => void): this;

// recipes
saveToFile(output: string): FfmpegCommand;
save(output: string): FfmpegCommand;
Expand Down