FFmpegOutput | Eloquent FFmpeg

Hierarchy

FFmpegOutput

Index

Properties

isStream

Methods

Properties

isStream

isStream: boolean

Whether the output is using streams.

Methods

args

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

- Defined in src/types.ts:279
Add output arguments, they will be placed before any additional arguments.

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

audioCodec

audioCodec(codec: AudioCodec | AudioEncoder | (string & {})): this

- Defined in src/types.ts:303
Select the codec for audio streams. See https://ffmpeg.org/ffmpeg-all.html#Main-options

Parameters
- codec: AudioCodec | AudioEncoder | (string & {})
  
  -
Returns this

audioFilter

audioFilter(filter: AudioFilter | (string & {}), options?: Record<string, any> | any[]): this

- Defined in src/types.ts:325
UNSTABLE

Applies a filter to the video streams.

Parameters
- filter: AudioFilter | (string & {})
  
  The filter to apply.
- Optional options: Record<string, any> | any[]
  
  Additional configuration for the filter.
Returns this

codec

codec(codec: VideoCodec | VideoEncoder | AudioCodec | AudioEncoder | SubtitleCodec | SubtitleEncoder | (string & {})): this

- Defined in src/types.ts:291
Select the codec for all streams. See https://ffmpeg.org/ffmpeg-all.html#Main-options

Parameters
- codec: VideoCodec | VideoEncoder | AudioCodec | AudioEncoder | SubtitleCodec | SubtitleEncoder | (string & {})
  
  -
Returns this

duration

duration(duration: number): this

- Defined in src/types.ts:331
Limit the duration of the data written to the output. See https://ffmpeg.org/ffmpeg-all.html#Main-options

Parameters
- duration: number
  
  The limit for the duration in milliseconds.
Returns this

format

format(format: Format | Muxer | (string & {})): this

- Defined in src/types.ts:285
Select the output format. See https://ffmpeg.org/ffmpeg-all.html#Main-options

Parameters
- format: Format | Muxer | (string & {})
  
  -
Returns this

getArgs

getArgs(): string[]

- Defined in src/types.ts:370
Returns all the arguments for the output.

Returns string[]

map

map(...streams: string[]): this

Maps inputs' streams to output streams. This is an advanced option. https://ffmpeg.org/ffmpeg-all.html#Advanced-options https://ffmpeg.org/ffmpeg-all.html#Stream-specifiers-1 https://ffmpeg.org/ffmpeg-all.html#Automatic-stream-selection

example

const cmd = ffmpeg();
cmd.input('input0.mkv');
cmd.input('input1.avi');
cmd.output('output0.webm')
// Takes input0's video streams and input1's audio streams.
  .map('0:v', '1:a');
cmd.output('output1.webm')
// Streams will be mapped in the order they were specified
// here output1's first stream will be input0's second stream
// and its second stream will be input1's first stream.
  .map('0:1', '1:0');

Parameters

Rest ...streams: string[]

Returns this

metadata

metadata(metadata: Record<string, string | undefined | null>, stream?: undefined | string): this

- Defined in src/types.ts:368
Add metadata to a stream or an output, if a value is undefined, null or '' (empty string), the key will be deleted. Values https://ffmpeg.org/ffmpeg.html#Main-options

Parameters
- metadata: Record<string, string | undefined | null>
  
  The metadata to add to the stream or output.
- Optional stream: undefined | string
  
  The stream to add metadata to, if not given metadata will be added to the output file.
Returns this

start

start(start: number): this

- Defined in src/types.ts:337
Decodes but discards the input until start is reached. See https://ffmpeg.org/ffmpeg-all.html#Main-options

Parameters
- start: number
  
  The number of milliseconds to discard.
Returns this

subtitleCodec

subtitleCodec(codec: SubtitleCodec | SubtitleEncoder | (string & {})): this

- Defined in src/types.ts:309
Select the codec for subtitle streams. See https://ffmpeg.org/ffmpeg-all.html#Main-options

Parameters
- codec: SubtitleCodec | SubtitleEncoder | (string & {})
  
  -
Returns this

videoCodec

videoCodec(codec: VideoCodec | VideoEncoder | (string & {})): this

- Defined in src/types.ts:297
Select the codec for video streams. See https://ffmpeg.org/ffmpeg-all.html#Main-options

Parameters
- codec: VideoCodec | VideoEncoder | (string & {})
  
  -
Returns this

videoFilter

videoFilter(filter: VideoFilter | (string & {}), options?: Record<string, any> | any[]): this

- Defined in src/types.ts:317
UNSTABLE

Applies a filter to the video streams.

Parameters
- filter: VideoFilter | (string & {})
  
  The filter to apply.
- Optional options: Record<string, any> | any[]
  
  Additional configuration for the filter.
Returns this

Hierarchy

Index

Properties

Methods

Properties

isStream

Methods

args

Parameters

Rest ...args: string[]

Returns this

audioCodec

Parameters

codec: AudioCodec | AudioEncoder | (string & {})

Returns this

audioFilter

Parameters

filter: AudioFilter | (string & {})

Optional options: Record<string, any> | any[]

Returns this

codec

Parameters

codec: VideoCodec | VideoEncoder | AudioCodec | AudioEncoder | SubtitleCodec | SubtitleEncoder | (string & {})

Returns this

duration

Parameters

duration: number

Returns this

format

Parameters

format: Format | Muxer | (string & {})

Returns this

getArgs

Returns string[]

map

Parameters

Rest ...streams: string[]

Returns this

metadata

Parameters

metadata: Record<string, string | undefined | null>

Optional stream: undefined | string

Returns this

start

Parameters

start: number

Returns this

subtitleCodec

Parameters

codec: SubtitleCodec | SubtitleEncoder | (string & {})

Returns this

videoCodec

Parameters

codec: VideoCodec | VideoEncoder | (string & {})

Returns this

videoFilter

Parameters

filter: VideoFilter | (string & {})

Optional options: Record<string, any> | any[]

Returns this