FFmpegCommand | Eloquent FFmpeg

Hierarchy

FFmpegCommand

Index

Methods

args

args(...args: string[]): this

- Defined in src/types.ts:98
Add arguments, they will be placed before any input or output arguments.

Parameters
- Rest ...args: string[]
  
  -
Returns this

concat

concat(sources: ConcatSource[], options?: ConcatOptions): FFmpegInput

- Defined in src/types.ts:76
Concatenate media files using the concat demuxer. This can also be used with stream copy, so it is much faster than the concat filter for most applications.
example
```
const cmd = ffmpeg();
cmd.concat(['file:chunk1.webm', 'file:chunk2.webm']);
cmd.output('complete_video.webm');
const process = await cmd.spawn();
await process.complete();
```
Parameters
- sources: ConcatSource[]
  
  The input sources to be concatenated, they can be in different formats but they must have the same streams, codecs, timebases, etc... https://ffmpeg.org/ffmpeg-formats.html#concat-1 https://trac.ffmpeg.org/wiki/Concatenate
- Optional options: ConcatOptions
Returns FFmpegInput

getArgs

getArgs(): string[]

- Defined in src/types.ts:114
Returns all the arguments with which ffmpeg will be spawned.

Returns string[]

input

input(source: InputSource): FFmpegInput

Adds an input to the conversion.

example

const cmd = ffmpeg();
cmd.input('input.avi');
cmd.input(fs.createReadStream('input2.avi'));
cmd.output();
const process = await cmd.spawn();
await process.complete();

Parameters

source: InputSource

-

Returns FFmpegInput

output

output(...destinations: OutputDestination[]): FFmpegOutput

- Defined in src/types.ts:93
Adds an output to the conversion, multiple destinations are supported using the tee protocol. You can use mixed destinations and multiple streams. Both NodeJS WritableStreams and AsyncGenerators are fully supported.
example
```
const cmd = ffmpeg();
cmd.input('input.avi');
cmd.output(fs.createWriteStream('dest1.mkv'), 'dest2.mkv');
const process = await cmd.spawn();
await process.complete();
```
Parameters
- Rest ...destinations: OutputDestination[]
  
  A sequence of OutputDestinations to which the output will be written. If no destinations are specified the conversion will run, but any output data will be ignored.
Returns FFmpegOutput

spawn

spawn(options?: SpawnOptions): Promise<FFmpegProcess>

- Defined in src/types.ts:110
Starts the conversion, this method is asynchronous so it must be await'ed.
example
```
const cmd = ffmpeg();
cmd.input('input.avi');
cmd.output('output.mp4');
const process = await cmd.spawn();
```
Parameters
- Optional options: SpawnOptions
  
  See SpawnOptions.
Returns Promise<FFmpegProcess>

Hierarchy

Index

Methods

Methods

args

Parameters

Rest ...args: string[]

Returns this

concat

Parameters

sources: ConcatSource[]

Optional options: ConcatOptions

Returns FFmpegInput

getArgs

Returns string[]

input

Parameters

source: InputSource

Returns FFmpegInput

output

Parameters

Rest ...destinations: OutputDestination[]

Returns FFmpegOutput

spawn

Parameters

Optional options: SpawnOptions

Returns Promise<FFmpegProcess>