Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 1.49 KB

README.md

File metadata and controls

39 lines (28 loc) · 1.49 KB

npm version GitHub license

fluent-ffmpeg-filters

Extend fluent-ffmpeg with fluent API for adding ffmpeg filters, as listed here.

lib directory contains one file per filter. Each filter module exposes a function that augment the ffmpeg instance.

Here is an example of use with the vstack filter.

let ffmpeg = require('fluent-ffmpeg');
const vstack = require('fluent-ffmpeg-filters').vstack;

ffmpeg = vstack(ffmpeg);

ffmpeg('./one.jpg')
  .input('./two.jpg')
  .vstack()
  .input(2)
  .shortest(0)
  .build()
  .applyVideoFilters()

Generic functions

These functions are available on each filter.

build(): register the filter configuration

The build() function is to be called once the filter function and its configuration function have all been called. Calling build() registers the filter configuration on the ffmpeg instance.

applyComplexFilter(): configure all filters

Apply the configurations of all filters to the ffmpeg instance. Call it only once.

applyVideoFilters(): configure video filters

Apply the configurations of video filters to the ffmpeg instance.

applyAudioFilters(): configure audio filters

Apply the configurations of audio filters to the ffmpeg instance.