Package net.bramp.ffmpeg.builder

Class FFmpegBuilder

java.lang.Object

net.bramp.ffmpeg.builder.FFmpegBuilder

public class FFmpegBuilder
extends Object

Builds a ffmpeg command line

Author:

bramp

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FFmpegBuilder.Verbosity	Log level options: ffmpeg documentation

Field Summary

Fields

Modifier and Type	Field	Description
protected Strict	strict

Constructor Summary

Constructors

Constructor	Description
FFmpegBuilder()

Method Summary

Modifier and Type	Method	Description
FFmpegBuilder	addExtraArgs(String... values)	Add additional ouput arguments (for flags which aren't currently supported).
FFmpegHlsOutputBuilder	addHlsOutput(String filename)	Adds new HLS(Http Live Streaming) output file.
FFmpegFileInputBuilder	addInput(String filename)
FFmpegFileInputBuilder	addInput(FFmpegProbeResult result)
<T extends AbstractFFmpegInputBuilder<T>> FFmpegBuilder	addInput(T input)
FFmpegOutputBuilder	addOutput(String filename)	Adds new output file.
FFmpegOutputBuilder	addOutput(URI uri)	Adds new output file.
FFmpegBuilder	addOutput(FFmpegOutputBuilder output)	Adds an existing FFmpegOutputBuilder.
FFmpegBuilder	addProgress(URI uri)
FFmpegOutputBuilder	addStdoutOutput()	Create new output (to stdout)
List<String>	build()
protected void	clearInputs()
protected <T extends AbstractFFmpegInputBuilder<T>> T	doAddInput(T input)
boolean	getOverrideOutputFiles()
FFmpegBuilder	overrideOutputFiles(boolean override)
FFmpegBuilder	readAtNativeFrameRate()	Deprecated. Use AbstractFFmpegInputBuilder.readAtNativeFrameRate() instead
FFmpegBuilder	setAudioFilter(String filter)	Sets the audio filter flag.
FFmpegBuilder	setComplexFilter(String filter)	Deprecated. Use AbstractFFmpegOutputBuilder.setComplexFilter(String) instead
FFmpegBuilder	setFormat(String format)	Deprecated. Specify this option on an input stream using AbstractFFmpegStreamBuilder.setFormat(String)
FFmpegFileInputBuilder	setInput(String filename)
FFmpegFileInputBuilder	setInput(FFmpegProbeResult result)
<T extends AbstractFFmpegInputBuilder<T>> FFmpegBuilder	setInput(T input)
FFmpegBuilder	setPass(int pass)
FFmpegBuilder	setPassDirectory(String directory)
FFmpegBuilder	setPassPrefix(String prefix)
FFmpegBuilder	setStartOffset(long duration, TimeUnit units)	Deprecated. Specify this option on an input or output stream using AbstractFFmpegStreamBuilder.setStartOffset(long, TimeUnit)
FFmpegBuilder	setStrict(Strict strict)
FFmpegBuilder	setThreads(int threads)
FFmpegBuilder	setUserAgent(String userAgent)
FFmpegBuilder	setVBR(Integer quality)	Sets vbr quality when decoding mp3 output.
FFmpegBuilder	setVerbosity(FFmpegBuilder.Verbosity verbosity)
FFmpegBuilder	setVideoFilter(String filter)	Sets the video filter flag.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

strict

protected Strict strict

Constructor Details

FFmpegBuilder

public FFmpegBuilder()

Method Details

setStrict

public FFmpegBuilder setStrict(Strict strict)

overrideOutputFiles

public FFmpegBuilder overrideOutputFiles(boolean override)

getOverrideOutputFiles

public boolean getOverrideOutputFiles()

setPass

public FFmpegBuilder setPass(int pass)

setPassDirectory

public FFmpegBuilder setPassDirectory(String directory)

setPassPrefix

public FFmpegBuilder setPassPrefix(String prefix)

setVerbosity

public FFmpegBuilder setVerbosity(FFmpegBuilder.Verbosity verbosity)

setUserAgent

public FFmpegBuilder setUserAgent(String userAgent)

readAtNativeFrameRate

@Deprecated
public FFmpegBuilder readAtNativeFrameRate()

Deprecated.

Use AbstractFFmpegInputBuilder.readAtNativeFrameRate() instead

Makes ffmpeg read the first input at the native frame read

Returns:

this

addInput

public FFmpegFileInputBuilder addInput(FFmpegProbeResult result)

addInput

public FFmpegFileInputBuilder addInput(String filename)

addInput

public <T extends AbstractFFmpegInputBuilder<T>>
FFmpegBuilder addInput(T input)

doAddInput

protected <T extends AbstractFFmpegInputBuilder<T>>
T doAddInput(T input)

clearInputs

protected void clearInputs()

setInput

public FFmpegFileInputBuilder setInput(FFmpegProbeResult result)

setInput

public FFmpegFileInputBuilder setInput(String filename)

setInput

public <T extends AbstractFFmpegInputBuilder<T>>
FFmpegBuilder setInput(T input)

setThreads

public FFmpegBuilder setThreads(int threads)

setFormat

@Deprecated
public FFmpegBuilder setFormat(String format)

Deprecated.

Specify this option on an input stream using AbstractFFmpegStreamBuilder.setFormat(String)

Sets the format for the first input stream

Parameters:

format - , the format of this input stream, not null

Returns:

this

setStartOffset

@Deprecated
public FFmpegBuilder setStartOffset(long duration,
 TimeUnit units)

Deprecated.

Specify this option on an input or output stream using AbstractFFmpegStreamBuilder.setStartOffset(long, TimeUnit)

Sets the start offset for the first input stream

Parameters:

duration - the amount of the offset, measured in terms of the unit

units - the unit that the duration is measured in, not null

Returns:

this

addProgress

public FFmpegBuilder addProgress(URI uri)

setComplexFilter

@Deprecated
public FFmpegBuilder setComplexFilter(String filter)

Deprecated.

Use AbstractFFmpegOutputBuilder.setComplexFilter(String) instead

Sets the complex filter flag.

Parameters:

filter - the complex filter string

Returns:

this

setAudioFilter

public FFmpegBuilder setAudioFilter(String filter)

Sets the audio filter flag.

Parameters:

filter - the audio filter string

Returns:

this

setVideoFilter

public FFmpegBuilder setVideoFilter(String filter)

Sets the video filter flag.

Parameters:

filter - the video filter string

Returns:

this

setVBR

public FFmpegBuilder setVBR(Integer quality)

Sets vbr quality when decoding mp3 output.

Parameters:

quality - the quality between 0 and 9. Where 0 is best.

Returns:

FFmpegBuilder

addExtraArgs

public FFmpegBuilder addExtraArgs(String... values)

Add additional ouput arguments (for flags which aren't currently supported).

Parameters:

values - The extra arguments.

Returns:

this

addOutput

public FFmpegOutputBuilder addOutput(String filename)

Adds new output file.

Parameters:

filename - output file path

Returns:

A new FFmpegOutputBuilder

addOutput

public FFmpegOutputBuilder addOutput(URI uri)

Adds new output file.

Parameters:

uri - output file uri typically a stream

Returns:

A new FFmpegOutputBuilder

addHlsOutput

public FFmpegHlsOutputBuilder addHlsOutput(String filename)

Adds new HLS(Http Live Streaming) output file.

 List<String> args = new FFmpegBuilder()
   .addHlsOutput("output.m3u8")
   .done().build();
 

Parameters:

filename - output file path

Returns:

A new FFmpegHlsOutputBuilder

addOutput

public FFmpegBuilder addOutput(FFmpegOutputBuilder output)

Adds an existing FFmpegOutputBuilder. This is similar to calling the other addOuput methods but instead allows an existing FFmpegOutputBuilder to be used, and reused.

 List<String> args = new FFmpegBuilder()
   .addOutput(new FFmpegOutputBuilder()
     .setFilename("output.flv")
     .setVideoCodec("flv")
   )
   .build();
 

Parameters:

output - FFmpegOutputBuilder to add

Returns:

this

addStdoutOutput

public FFmpegOutputBuilder addStdoutOutput()

Create new output (to stdout)

Returns:

A new FFmpegOutputBuilder

build

@CheckReturnValue
public List<String> build()