Package net.bramp.ffmpeg.builder

Class FFmpegHlsOutputBuilder

java.lang.Object

net.bramp.ffmpeg.builder.AbstractFFmpegStreamBuilder<FFmpegHlsOutputBuilder>

net.bramp.ffmpeg.builder.AbstractFFmpegOutputBuilder<FFmpegHlsOutputBuilder>

net.bramp.ffmpeg.builder.FFmpegHlsOutputBuilder

public class FFmpegHlsOutputBuilder
extends AbstractFFmpegOutputBuilder<FFmpegHlsOutputBuilder>

Builder for FFmpeg HLS (HTTP Live Streaming) output arguments.

Field Summary

Fields

Modifier and Type	Field	Description
String	hls_base_url
Long	hls_init_time
Integer	hls_list_size
String	hls_playlist_type
String	hls_segment_filename
Long	hls_time
String	master_pl_name
String	var_stream_map

Fields inherited from class net.bramp.ffmpeg.builder.AbstractFFmpegOutputBuilder

audio_bit_rate, audio_bit_stream_filter, audio_filter, audio_quality, audio_sample_format, bFrames, complexFilter, constantRateFactor, video_bit_rate, video_bit_stream_filter, video_filter, video_preset, video_quality

Fields inherited from class net.bramp.ffmpeg.builder.AbstractFFmpegStreamBuilder

audio_channels, audio_codec, audio_enabled, audio_preset, audio_sample_rate, DEVNULL, duration, extra_args, filename, format, maps, meta_tags, pass_padding_bitrate, preset, presetFilename, startOffset, strict, subtitle_enabled, subtitle_preset, targetSize, throwWarnings, uri, video_codec, video_copyinkf, video_enabled, video_frame_rate, video_frames, video_height, video_movflags, video_pixel_format, video_size, video_width

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FFmpegHlsOutputBuilder(FFmpegBuilder parent, String filename)	Constructs a new HLS output builder with the given filename.

Method Summary

Modifier and Type	Method	Description
protected void	addFormatArgs(com.google.common.collect.ImmutableList.Builder<String> args)	Adds format-related arguments such as stream mappings.
FFmpegHlsOutputBuilder	addVariant(HlsVariant variant)	Adds an HLS variant to this output.
protected FFmpegHlsOutputBuilder	getThis()	Returns this instance for fluent API chaining.
FFmpegHlsOutputBuilder	setFormat(String format)	Sets the output format.
FFmpegHlsOutputBuilder	setHlsBaseUrl(String baseurl)	Append baseurl to every entry in the playlist.
FFmpegHlsOutputBuilder	setHlsInitTime(long duration, TimeUnit units)	Segment will be cut on the next key frame after this time has passed on the first m3u8 list.
FFmpegHlsOutputBuilder	setHlsListSize(int size)	Set the maximum number of playlist entries.
FFmpegHlsOutputBuilder	setHlsPlaylistType(String type)	Set the playlist type.
FFmpegHlsOutputBuilder	setHlsSegmentFileName(String filename)	hls_segment_filename Examples "file%03d.ts" segment files: file000.ts, file001.ts, file002.ts, etc.
FFmpegHlsOutputBuilder	setHlsTime(long duration, TimeUnit units)	Set the target segment length.
FFmpegHlsOutputBuilder	setMasterPlName(String name)	Set the master playlist name.
FFmpegHlsOutputBuilder	setVarStreamMap(String map)	Set the variant stream map string manually.

Methods inherited from class net.bramp.ffmpeg.builder.AbstractFFmpegOutputBuilder

addAudioFlags, addGlobalFlags, addSourceTarget, addVideoFlags, build, build, buildOptions, formatDecimalInteger, getAudioBitRate, getAudioBitStreamFilter, getAudioFilter, getAudioQuality, getAudioSampleFormat, getComplexFilter, getConstantRateFactor, getVideoBitRate, getVideoBitStreamFilter, getVideoFilter, getVideoPreset, getVideoQuality, setAudioBitDepth, setAudioBitRate, setAudioBitStreamFilter, setAudioFilter, setAudioQuality, setAudioSampleFormat, setBFrames, setComplexFilter, setConstantRateFactor, setVideoBitRate, setVideoBitStreamFilter, setVideoFilter, setVideoPreset, setVideoQuality

Methods inherited from class net.bramp.ffmpeg.builder.AbstractFFmpegStreamBuilder

addExtraArgs, addMap, addMap, addMetaTag, addMetaTag, disableAudio, disableSubtitle, disableVideo, done, getFilename, getUri, isValidSize, setAudioChannels, setAudioCodec, setAudioPreset, setAudioSampleRate, setDuration, setFilename, setFilename, setFilename, setFrames, setPassPaddingBitrate, setPreset, setPresetFilename, setPresetFilename, setPresetFilename, setStartOffset, setStrict, setSubtitleCodec, setSubtitlePreset, setTargetSize, setUri, setVideoCodec, setVideoCopyInkf, setVideoFrameRate, setVideoFrameRate, setVideoFrameRate, setVideoHeight, setVideoMovFlags, setVideoPixelFormat, setVideoResolution, setVideoResolution, setVideoWidth, useOptions, useOptions, useOptions, useOptions

Methods inherited from class java.lang.Object

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

Field Details

hls_time

public Long hls_time

hls_segment_filename

public String hls_segment_filename

hls_init_time

public Long hls_init_time

hls_list_size

public Integer hls_list_size

hls_base_url

public String hls_base_url

hls_playlist_type

public String hls_playlist_type

master_pl_name

public String master_pl_name

var_stream_map

public String var_stream_map

Constructor Details

FFmpegHlsOutputBuilder

protected FFmpegHlsOutputBuilder(FFmpegBuilder parent,
 String filename)

Constructs a new HLS output builder with the given filename.

Method Details

setFormat

public FFmpegHlsOutputBuilder setFormat(String format)

Description copied from class: AbstractFFmpegStreamBuilder

Sets the output format.

Overrides:

setFormat in class AbstractFFmpegStreamBuilder<FFmpegHlsOutputBuilder>

setHlsTime

public FFmpegHlsOutputBuilder setHlsTime(long duration,
 TimeUnit units)

Set the target segment length. Default value is 2 seconds.

Parameters:

duration - hls_time to set

units - The units the offset is in

Returns:

FFmpegHlsOutputBuilder

setHlsSegmentFileName

public FFmpegHlsOutputBuilder setHlsSegmentFileName(String filename)

hls_segment_filename Examples

"file%03d.ts" segment files: file000.ts, file001.ts, file002.ts, etc.

Parameters:

filename - hls_segment_file_name to set

Returns:

FFmpegHlsOutputBuilder

setHlsInitTime

public FFmpegHlsOutputBuilder setHlsInitTime(long duration,
 TimeUnit units)

Segment will be cut on the next key frame after this time has passed on the first m3u8 list.

Parameters:

duration - hls_init_time to set

units - The units the offset is in

Returns:

FFmpegHlsOutputBuilder

setHlsListSize

public FFmpegHlsOutputBuilder setHlsListSize(int size)

Set the maximum number of playlist entries. If set to 0 the list file will contain all the segments .
Default value is 5

Parameters:

size - hls_time to set

Returns:

FFmpegHlsOutputBuilder

setHlsBaseUrl

public FFmpegHlsOutputBuilder setHlsBaseUrl(String baseurl)

Append baseurl to every entry in the playlist. Useful to generate playlists with absolute paths.
Note that the playlist sequence number must be unique for each segment and it is not to be confused with the segment filename sequence number which can be cyclic, for example if the wrap option is specified.

Parameters:

baseurl - hls_base_url to set

Returns:

FFmpegHlsOutputBuilder

setHlsPlaylistType

public FFmpegHlsOutputBuilder setHlsPlaylistType(String type)

Set the playlist type.

Parameters:

type - The playlist type (e.g. "event", "vod")

Returns:

FFmpegHlsOutputBuilder

setMasterPlName

public FFmpegHlsOutputBuilder setMasterPlName(String name)

Set the master playlist name.

Parameters:

name - The master playlist name

Returns:

FFmpegHlsOutputBuilder

setVarStreamMap

public FFmpegHlsOutputBuilder setVarStreamMap(String map)

Set the variant stream map string manually.

Prefer using addVariant(HlsVariant) for a cleaner API.

Parameters:

map - The variant stream map (e.g. "v:0,a:0 v:1,a:1")

Returns:

FFmpegHlsOutputBuilder

addVariant

public FFmpegHlsOutputBuilder addVariant(HlsVariant variant)

Adds an HLS variant to this output.

Parameters:

variant - The variant configuration.

Returns:

FFmpegHlsOutputBuilder

addFormatArgs

protected void addFormatArgs(com.google.common.collect.ImmutableList.Builder<String> args)

Description copied from class: AbstractFFmpegStreamBuilder

Adds format-related arguments such as stream mappings.

Overrides:

addFormatArgs in class AbstractFFmpegStreamBuilder<FFmpegHlsOutputBuilder>

getThis

@CheckReturnValue
protected FFmpegHlsOutputBuilder getThis()

Description copied from class: AbstractFFmpegStreamBuilder

Returns this instance for fluent API chaining.

Overrides:

getThis in class AbstractFFmpegOutputBuilder<FFmpegHlsOutputBuilder>