NodeAV

node-av / constants / MuxerPrivateOptionsMap

Interface: MuxerPrivateOptionsMap ​

Defined in: src/constants/format-options.ts:100

Properties ​

3g2 ​

3g2: object

Defined in: src/constants/format-options.ts:105

3GP2 (3GPP2 file format)

brand? ​

optional brand?: string | number

Override major brand

empty_hdlr_name? ​

optional empty_hdlr_name?: boolean | string & object

write zero-length name string in hdlr atoms within mdia and minf atoms

encryption_key? ​

optional encryption_key?: string | number

The media encryption key (hex)

encryption_kid? ​

optional encryption_kid?: string | number

The media encryption key identifier (hex)

encryption_scheme? ​

optional encryption_scheme?: string | number

Configures the encryption scheme, allowed values are none, cenc-aes-ctr

frag_duration? ​

optional frag_duration?: number | string & object

Maximum fragment duration

frag_interleave? ​

optional frag_interleave?: number | string & object

Interleave samples within fragments (max number of consecutive samples, lower is tighter interleaving, but with more overhead)

frag_size? ​

optional frag_size?: number | string & object

Maximum fragment size

fragment_index? ​

optional fragment_index?: number | string & object

Fragment number of the next fragment

iods_audio_profile? ​

optional iods_audio_profile?: number | string & object

iods audio profile atom.

iods_video_profile? ​

optional iods_video_profile?: number | string & object

iods video profile atom.

ism_lookahead? ​

optional ism_lookahead?: number | string & object

Number of lookahead entries for ISM files

min_frag_duration? ​

optional min_frag_duration?: number | string & object

Minimum fragment duration

moov_size? ​

optional moov_size?: number | string & object

maximum moov size so it can be placed at the begin

mov_gamma? ​

optional mov_gamma?: number | string & object

gamma value for gama atom

movflags? ​

optional movflags?: number | string & object | "cmaf" | "dash" | "default_base_moof" | "delay_moov" | "disable_chpl" | "empty_moov" | "faststart" | "frag_custom" | "frag_discont" | "frag_every_frame" | "frag_keyframe" | "global_sidx" | "isml" | "negative_cts_offsets" | "omit_tfhd_offset" | "prefer_icc" | "rtphint" | "separate_moof" | "skip_sidx" | "skip_trailer" | "use_metadata_tags" | "write_colr" | "write_gama" | "hybrid_fragmented"

MOV muxer flags

movie_timescale? ​

optional movie_timescale?: number | string & object

set movie timescale

rtpflags? ​

optional rtpflags?: number | string & object | "latm" | "rfc2190" | "skip_rtcp" | "h264_mode0" | "send_bye"

RTP muxer flags

skip_iods? ​

optional skip_iods?: boolean | string & object

Skip writing iods atom.

use_editlist? ​

optional use_editlist?: boolean | string & object

use edit list

use_stream_ids_as_track_ids? ​

optional use_stream_ids_as_track_ids?: boolean | string & object

use stream ids as track ids

video_track_timescale? ​

optional video_track_timescale?: number | string & object

set timescale of all video tracks

write_btrt? ​

optional write_btrt?: boolean | string & object

force or disable writing btrt

write_prft? ​

optional write_prft?: number | string & object | "pts" | "wallclock"

Write producer reference time box with specified time source

write_tmcd? ​

optional write_tmcd?: boolean | string & object

force or disable writing tmcd

See ​

https://ffmpeg.org/ffmpeg-formats.html#3g2

3gp ​

3gp: object

Defined in: src/constants/format-options.ts:187

3GP (3GPP file format)

brand? ​

optional brand?: string | number

Override major brand

empty_hdlr_name? ​

optional empty_hdlr_name?: boolean | string & object

write zero-length name string in hdlr atoms within mdia and minf atoms

encryption_key? ​

optional encryption_key?: string | number

The media encryption key (hex)

encryption_kid? ​

optional encryption_kid?: string | number

The media encryption key identifier (hex)

encryption_scheme? ​

optional encryption_scheme?: string | number

Configures the encryption scheme, allowed values are none, cenc-aes-ctr

frag_duration? ​

optional frag_duration?: number | string & object

Maximum fragment duration

frag_interleave? ​

optional frag_interleave?: number | string & object

Interleave samples within fragments (max number of consecutive samples, lower is tighter interleaving, but with more overhead)

frag_size? ​

optional frag_size?: number | string & object

Maximum fragment size

fragment_index? ​

optional fragment_index?: number | string & object

Fragment number of the next fragment

iods_audio_profile? ​

optional iods_audio_profile?: number | string & object

iods audio profile atom.

iods_video_profile? ​

optional iods_video_profile?: number | string & object

iods video profile atom.

ism_lookahead? ​

optional ism_lookahead?: number | string & object

Number of lookahead entries for ISM files

min_frag_duration? ​

optional min_frag_duration?: number | string & object

Minimum fragment duration

moov_size? ​

optional moov_size?: number | string & object

maximum moov size so it can be placed at the begin

mov_gamma? ​

optional mov_gamma?: number | string & object

gamma value for gama atom

movflags? ​

optional movflags?: number | string & object | "cmaf" | "dash" | "default_base_moof" | "delay_moov" | "disable_chpl" | "empty_moov" | "faststart" | "frag_custom" | "frag_discont" | "frag_every_frame" | "frag_keyframe" | "global_sidx" | "isml" | "negative_cts_offsets" | "omit_tfhd_offset" | "prefer_icc" | "rtphint" | "separate_moof" | "skip_sidx" | "skip_trailer" | "use_metadata_tags" | "write_colr" | "write_gama" | "hybrid_fragmented"

MOV muxer flags

movie_timescale? ​

optional movie_timescale?: number | string & object

set movie timescale

rtpflags? ​

optional rtpflags?: number | string & object | "latm" | "rfc2190" | "skip_rtcp" | "h264_mode0" | "send_bye"

RTP muxer flags

skip_iods? ​

optional skip_iods?: boolean | string & object

Skip writing iods atom.

use_editlist? ​

optional use_editlist?: boolean | string & object

use edit list

use_stream_ids_as_track_ids? ​

optional use_stream_ids_as_track_ids?: boolean | string & object

use stream ids as track ids

video_track_timescale? ​

optional video_track_timescale?: number | string & object

set timescale of all video tracks

write_btrt? ​

optional write_btrt?: boolean | string & object

force or disable writing btrt

write_prft? ​

optional write_prft?: number | string & object | "pts" | "wallclock"

Write producer reference time box with specified time source

write_tmcd? ​

optional write_tmcd?: boolean | string & object

force or disable writing tmcd

See ​

https://ffmpeg.org/ffmpeg-formats.html#3gp

ac4 ​

ac4: object

Defined in: src/constants/format-options.ts:269

raw AC-4

write_crc? ​

optional write_crc?: boolean | string & object

enable checksum

See ​

https://ffmpeg.org/ffmpeg-formats.html#ac4

adts ​

adts: object

Defined in: src/constants/format-options.ts:277

ADTS AAC (Advanced Audio Coding)

write_apetag? ​

optional write_apetag?: boolean | string & object

Enable APE tag writing

write_id3v2? ​

optional write_id3v2?: boolean | string & object

Enable ID3v2 tag writing

write_mpeg2? ​

optional write_mpeg2?: boolean | string & object

Set MPEG version to MPEG-2

See ​

https://ffmpeg.org/ffmpeg-formats.html#adts

aiff ​

aiff: object

Defined in: src/constants/format-options.ts:289

Audio IFF

id3v2_version? ​

optional id3v2_version?: number | string & object

Select ID3v2 version to write. Currently 3 and 4 are supported.

write_id3v2? ​

optional write_id3v2?: boolean | string & object

Enable ID3 tags writing.

See ​

https://ffmpeg.org/ffmpeg-formats.html#aiff

alp ​

alp: object

Defined in: src/constants/format-options.ts:299

LEGO Racers ALP

type? ​

optional type?: number | string & object | "auto" | "tun" | "pcm"

set file type

See ​

https://ffmpeg.org/ffmpeg-formats.html#alp

apng ​

apng: object

Defined in: src/constants/format-options.ts:307

Animated Portable Network Graphics

final_delay? ​

optional final_delay?: string | number

Force delay after the last frame

plays? ​

optional plays?: number | string & object

Number of times to play the output: 0 - infinite loop, 1 - no loop

See ​

https://ffmpeg.org/ffmpeg-formats.html#apng

argo_asf ​

argo_asf: object

Defined in: src/constants/format-options.ts:317

Argonaut Games ASF

name? ​

optional name?: string | number

embedded file name (max 8 characters)

version_major? ​

optional version_major?: number | string & object

override file major version

version_minor? ​

optional version_minor?: number | string & object

override file minor version

See ​

https://ffmpeg.org/ffmpeg-formats.html#argo_005fasf

argo_cvg ​

argo_cvg: object

Defined in: src/constants/format-options.ts:329

Argonaut Games CVG

loop? ​

optional loop?: boolean | string & object

set loop flag

reverb? ​

optional reverb?: boolean | string & object

set reverb flag

skip_rate_check? ​

optional skip_rate_check?: boolean | string & object

skip sample rate check

See ​

https://ffmpeg.org/ffmpeg-formats.html#argo_005fcvg

asf ​

asf: object

Defined in: src/constants/format-options.ts:341

ASF (Advanced / Active Streaming Format)

packet_size? ​

optional packet_size?: number | string & object

Packet size

See ​

https://ffmpeg.org/ffmpeg-formats.html#asf

asf_stream ​

asf_stream: object

Defined in: src/constants/format-options.ts:349

ASF (Advanced / Active Streaming Format)

packet_size? ​

optional packet_size?: number | string & object

Packet size

See ​

https://ffmpeg.org/ffmpeg-formats.html#asf_005fstream

ass ​

ass: object

Defined in: src/constants/format-options.ts:357

SSA (SubStation Alpha) subtitle

ignore_readorder? ​

optional ignore_readorder?: boolean | string & object

write events immediately, even if they're out-of-order

See ​

https://ffmpeg.org/ffmpeg-formats.html#ass

ast ​

ast: object

Defined in: src/constants/format-options.ts:365

AST (Audio Stream)

loopend? ​

optional loopend?: number | string & object

Loopend position in milliseconds.

loopstart? ​

optional loopstart?: number | string & object

Loopstart position in milliseconds.

See ​

https://ffmpeg.org/ffmpeg-formats.html#ast

audiotoolbox ​

audiotoolbox: object

Defined in: src/constants/format-options.ts:375

AudioToolbox output device

audio_device_index? ​

optional audio_device_index?: number | string & object

select audio device by index (starts at 0)

list_devices? ​

optional list_devices?: boolean | string & object

list available audio devices

See ​

https://ffmpeg.org/ffmpeg-formats.html#audiotoolbox

avi ​

avi: object

Defined in: src/constants/format-options.ts:385

AVI (Audio Video Interleaved)

flipped_raw_rgb? ​

optional flipped_raw_rgb?: boolean | string & object

Raw RGB bitmaps are stored bottom-up

reserve_index_space? ​

optional reserve_index_space?: number | string & object

reserve space (in bytes) at the beginning of the file for each stream index

write_channel_mask? ​

optional write_channel_mask?: boolean | string & object

write channel mask into wave format header

See ​

https://ffmpeg.org/ffmpeg-formats.html#avi

avif ​

avif: object

Defined in: src/constants/format-options.ts:397

AVIF

loop? ​

optional loop?: number | string & object

Number of times to loop animated AVIF: 0 - infinite loop

movie_timescale? ​

optional movie_timescale?: number | string & object

set movie timescale

See ​

https://ffmpeg.org/ffmpeg-formats.html#avif

caca ​

caca: object

Defined in: src/constants/format-options.ts:407

caca (color ASCII art) output device

algorithm? ​

optional algorithm?: string | number

set dithering algorithm

antialias? ​

optional antialias?: string | number

set antialias method

charset? ​

optional charset?: string | number

set charset used to render output

color? ​

optional color?: string | number

set color used to render output

driver? ​

optional driver?: string | number

set display driver

list_dither? ​

optional list_dither?: number | string & object | "algorithms" | "antialiases" | "charsets" | "colors"

list available dither options

list_drivers? ​

optional list_drivers?: boolean | string & object

list available drivers

window_size? ​

optional window_size?: string | number

set window forced size

window_title? ​

optional window_title?: string | number

set window title

See ​

https://ffmpeg.org/ffmpeg-formats.html#caca

chromaprint ​

chromaprint: object

Defined in: src/constants/format-options.ts:431

Chromaprint

algorithm? ​

optional algorithm?: number | string & object

version of the fingerprint algorithm

fp_format? ​

optional fp_format?: number | "base64" | string & object | "raw" | "compressed"

fingerprint format to write

silence_threshold? ​

optional silence_threshold?: number | string & object

threshold for detecting silence

See ​

https://ffmpeg.org/ffmpeg-formats.html#chromaprint

dash ​

dash: object

Defined in: src/constants/format-options.ts:443

DASH Muxer

adaptation_sets? ​

optional adaptation_sets?: string | number

Adaptation sets. Syntax: id=0,streams=0,1,2 id=1,streams=3,4 and so on

availability_start_time_ms? ​

optional availability_start_time_ms?: number | string & object

set MPD availabilityStartTime as epoch milliseconds

dash_segment_type? ​

optional dash_segment_type?: number | string & object | "auto" | "mp4" | "webm"

set dash segment files type

extra_window_size? ​

optional extra_window_size?: number | string & object

number of segments kept outside of the manifest before removing from disk

format_options? ​

optional format_options?: string | number

set list of options for the container format (mp4/webm) used for dash

frag_duration? ​

optional frag_duration?: string | number

fragment duration (in seconds, fractional value can be set)

frag_type? ​

optional frag_type?: number | "none" | string & object | "every_frame" | "duration" | "pframes"

set type of interval for fragments

global_sidx? ​

optional global_sidx?: boolean | string & object

Write global SIDX atom. Applicable only for single file, mp4 output, non-streaming mode

hls_master_name? ​

optional hls_master_name?: string | number

HLS master playlist name

hls_playlist? ​

optional hls_playlist?: boolean | string & object

Generate HLS playlist files(master.m3u8, media_%d.m3u8)

http_opts? ​

optional http_opts?: string | number

HTTP protocol options

http_persistent? ​

optional http_persistent?: boolean | string & object

Use persistent HTTP connections

http_user_agent? ​

optional http_user_agent?: string | number

override User-Agent field in HTTP header

ignore_io_errors? ​

optional ignore_io_errors?: boolean | string & object

Ignore IO errors during open and write. Useful for long-duration runs with network output

index_correction? ​

optional index_correction?: boolean | string & object

Enable/Disable segment index correction logic

init_seg_name? ​

optional init_seg_name?: string | number

DASH-templated name to used for the initialization segment

ldash? ​

optional ldash?: boolean | string & object

Enable Low-latency dash. Constrains the value of a few elements

lhls? ​

optional lhls?: boolean | string & object

Enable Low-latency HLS(Experimental). Adds #EXT-X-PREFETCH tag with current segment's URI

master_m3u8_publish_rate? ​

optional master_m3u8_publish_rate?: number | string & object

Publish master playlist every after this many segment intervals

max_playback_rate? ​

optional max_playback_rate?: string | number

Set desired maximum playback rate

media_seg_name? ​

optional media_seg_name?: string | number

DASH-templated name to used for the media segments

method? ​

optional method?: string | number

set the HTTP method

min_playback_rate? ​

optional min_playback_rate?: string | number

Set desired minimum playback rate

mpd_profile? ​

optional mpd_profile?: number | string & object | "dash" | "dvb_dash"

Set profiles. Elements and values used in the manifest may be constrained by them

remove_at_exit? ​

optional remove_at_exit?: boolean | string & object

remove all segments when finished

seg_duration? ​

optional seg_duration?: string | number

segment duration (in seconds, fractional value can be set)

single_file? ​

optional single_file?: boolean | string & object

Store all segments in one file, accessed using byte ranges

single_file_name? ​

optional single_file_name?: string | number

DASH-templated name to be used for baseURL. Implies storing all segments in one file, accessed using byte ranges

streaming? ​

optional streaming?: boolean | string & object

Enable/Disable streaming mode of output. Each frame will be moof fragment

suggested_presentation_delay? ​

optional suggested_presentation_delay?: string | number

set MPD suggestedPresentationDelay

target_latency? ​

optional target_latency?: string | number

Set desired target latency for Low-latency dash

timeout? ​

optional timeout?: string | number

set timeout for socket I/O operations

update_period? ​

optional update_period?: number | string & object

Set the mpd update interval

use_template? ​

optional use_template?: boolean | string & object

Use SegmentTemplate instead of SegmentList

use_timeline? ​

optional use_timeline?: boolean | string & object

Use SegmentTimeline in SegmentTemplate

utc_timing_url? ​

optional utc_timing_url?: string | number

URL of the page that will return the UTC timestamp in ISO format

window_size? ​

optional window_size?: number | string & object

number of segments kept in the manifest

write_prft? ​

optional write_prft?: boolean | string & object

Write producer reference time element

See ​

https://ffmpeg.org/ffmpeg-formats.html#dash

decklink: object

Defined in: src/constants/format-options.ts:525

Blackmagic DeckLink output

duplex_mode? ​

optional duplex_mode?: number | string & object | "full" | "half" | "unset" | "one_sub_device_full" | "one_sub_device_half" | "two_sub_device_full" | "four_sub_device_half"

duplex mode

level_a? ​

optional level_a?: number | string & object | "true" | "unset" | "false"

set SMPTE LevelA

optional link?: number | string & object | "single" | "unset" | "dual" | "quad"

single/dual/quad SDI link configuration

list_devices? ​

optional list_devices?: boolean | string & object

use ffmpeg -sinks decklink instead

list_formats? ​

optional list_formats?: number | string & object

list supported formats

preroll? ​

optional preroll?: number | string & object

video preroll in seconds

sqd? ​

optional sqd?: number | string & object | "true" | "unset" | "false"

set Square Division

timing_offset? ​

optional timing_offset?: number | string & object | "unset"

genlock timing pixel offset

vanc_queue_size? ​

optional vanc_queue_size?: number | string & object

VANC queue buffer size

See ​

https://ffmpeg.org/ffmpeg-formats.html#decklink

dvd ​

dvd: object

Defined in: src/constants/format-options.ts:549

MPEG-2 PS (DVD VOB)

muxrate? ​

optional muxrate?: number | string & object

mux rate as bits/s

preload? ​

optional preload?: number | string & object

initial demux-decode delay in microseconds

See ​

https://ffmpeg.org/ffmpeg-formats.html#dvd

f4v ​

f4v: object

Defined in: src/constants/format-options.ts:559

F4V Adobe Flash Video

brand? ​

optional brand?: string | number

Override major brand

empty_hdlr_name? ​

optional empty_hdlr_name?: boolean | string & object

write zero-length name string in hdlr atoms within mdia and minf atoms

encryption_key? ​

optional encryption_key?: string | number

The media encryption key (hex)

encryption_kid? ​

optional encryption_kid?: string | number

The media encryption key identifier (hex)

encryption_scheme? ​

optional encryption_scheme?: string | number

Configures the encryption scheme, allowed values are none, cenc-aes-ctr

frag_duration? ​

optional frag_duration?: number | string & object

Maximum fragment duration

frag_interleave? ​

optional frag_interleave?: number | string & object

Interleave samples within fragments (max number of consecutive samples, lower is tighter interleaving, but with more overhead)

frag_size? ​

optional frag_size?: number | string & object

Maximum fragment size

fragment_index? ​

optional fragment_index?: number | string & object

Fragment number of the next fragment

iods_audio_profile? ​

optional iods_audio_profile?: number | string & object

iods audio profile atom.

iods_video_profile? ​

optional iods_video_profile?: number | string & object

iods video profile atom.

ism_lookahead? ​

optional ism_lookahead?: number | string & object

Number of lookahead entries for ISM files

min_frag_duration? ​

optional min_frag_duration?: number | string & object

Minimum fragment duration

moov_size? ​

optional moov_size?: number | string & object

maximum moov size so it can be placed at the begin

mov_gamma? ​

optional mov_gamma?: number | string & object

gamma value for gama atom

movflags? ​

optional movflags?: number | string & object | "cmaf" | "dash" | "default_base_moof" | "delay_moov" | "disable_chpl" | "empty_moov" | "faststart" | "frag_custom" | "frag_discont" | "frag_every_frame" | "frag_keyframe" | "global_sidx" | "isml" | "negative_cts_offsets" | "omit_tfhd_offset" | "prefer_icc" | "rtphint" | "separate_moof" | "skip_sidx" | "skip_trailer" | "use_metadata_tags" | "write_colr" | "write_gama" | "hybrid_fragmented"

MOV muxer flags

movie_timescale? ​

optional movie_timescale?: number | string & object

set movie timescale

rtpflags? ​

optional rtpflags?: number | string & object | "latm" | "rfc2190" | "skip_rtcp" | "h264_mode0" | "send_bye"

RTP muxer flags

skip_iods? ​

optional skip_iods?: boolean | string & object

Skip writing iods atom.

use_editlist? ​

optional use_editlist?: boolean | string & object

use edit list

use_stream_ids_as_track_ids? ​

optional use_stream_ids_as_track_ids?: boolean | string & object

use stream ids as track ids

video_track_timescale? ​

optional video_track_timescale?: number | string & object

set timescale of all video tracks

write_btrt? ​

optional write_btrt?: boolean | string & object

force or disable writing btrt

write_prft? ​

optional write_prft?: number | string & object | "pts" | "wallclock"

Write producer reference time box with specified time source

write_tmcd? ​

optional write_tmcd?: boolean | string & object

force or disable writing tmcd

See ​

https://ffmpeg.org/ffmpeg-formats.html#f4v

fbdev ​

fbdev: object

Defined in: src/constants/format-options.ts:641

Linux framebuffer

xoffset? ​

optional xoffset?: number | string & object

set x coordinate of top left corner

yoffset? ​

optional yoffset?: number | string & object

set y coordinate of top left corner

See ​

https://ffmpeg.org/ffmpeg-formats.html#fbdev

fifo ​

fifo: object

Defined in: src/constants/format-options.ts:651

FIFO queue pseudo-muxer

attempt_recovery? ​

optional attempt_recovery?: boolean | string & object

Attempt recovery in case of failure

drop_pkts_on_overflow? ​

optional drop_pkts_on_overflow?: boolean | string & object

Drop packets on fifo queue overflow not to block encoder

fifo_format? ​

optional fifo_format?: string | number

Target muxer

format_opts? ​

optional format_opts?: string | number

Options to be passed to underlying muxer

max_recovery_attempts? ​

optional max_recovery_attempts?: number | string & object

Maximal number of recovery attempts

queue_size? ​

optional queue_size?: number | string & object

Size of fifo queue

recover_any_error? ​

optional recover_any_error?: boolean | string & object

Attempt recovery regardless of type of the error

recovery_wait_streamtime? ​

optional recovery_wait_streamtime?: boolean | string & object

Use stream time instead of real time while waiting for recovery

recovery_wait_time? ​

optional recovery_wait_time?: string | number

Waiting time between recovery attempts

restart_with_keyframe? ​

optional restart_with_keyframe?: boolean | string & object

Wait for keyframe when restarting output

timeshift? ​

optional timeshift?: string | number

Delay fifo output

See ​

https://ffmpeg.org/ffmpeg-formats.html#fifo

fifo_test ​

fifo_test: object

Defined in: src/constants/format-options.ts:679

Fifo test muxer

optional print_deinit_summary?: boolean | string & object

print summary when deinitializing muxer

write_header_ret? ​

optional write_header_ret?: number | string & object

write_header() return value

write_trailer_ret? ​

optional write_trailer_ret?: number | string & object

write_trailer() return value

See ​

https://ffmpeg.org/ffmpeg-formats.html#fifo_005ftest

flac ​

flac: object

Defined in: src/constants/format-options.ts:691

raw FLAC

write_header? ​

optional write_header?: boolean | string & object

Write the file header

See ​

https://ffmpeg.org/ffmpeg-formats.html#flac

flv ​

flv: object

Defined in: src/constants/format-options.ts:699

FLV (Flash Video)

flvflags? ​

optional flvflags?: number | string & object | "aac_seq_header_detect" | "no_sequence_end" | "no_metadata" | "no_duration_filesize" | "add_keyframe_index"

FLV muxer flags

See ​

https://ffmpeg.org/ffmpeg-formats.html#flv

framehash ​

framehash: object

Defined in: src/constants/format-options.ts:707

Per-frame hash testing

format_version? ​

optional format_version?: number | string & object

file format version

hash? ​

optional hash?: string | number

set hash to use

See ​

https://ffmpeg.org/ffmpeg-formats.html#framehash

framemd5 ​

framemd5: object

Defined in: src/constants/format-options.ts:717

Per-frame MD5 testing

format_version? ​

optional format_version?: number | string & object

file format version

hash? ​

optional hash?: string | number

set hash to use

See ​

https://ffmpeg.org/ffmpeg-formats.html#framemd5

gif ​

gif: object

Defined in: src/constants/format-options.ts:727

CompuServe Graphics Interchange Format (GIF)

final_delay? ​

optional final_delay?: number | string & object

Force delay (in centiseconds) after the last frame

loop? ​

optional loop?: number | string & object

Number of times to loop the output: -1 - no loop, 0 - infinite loop

See ​

https://ffmpeg.org/ffmpeg-formats.html#gif

hash ​

hash: object

Defined in: src/constants/format-options.ts:737

Hash testing

hash? ​

optional hash?: string | number

set hash to use

See ​

https://ffmpeg.org/ffmpeg-formats.html#hash

hds ​

hds: object

Defined in: src/constants/format-options.ts:745

HDS Muxer

extra_window_size? ​

optional extra_window_size?: number | string & object

number of fragments kept outside of the manifest before removing from disk

min_frag_duration? ​

optional min_frag_duration?: number | string & object

minimum fragment duration (in microseconds)

remove_at_exit? ​

optional remove_at_exit?: boolean | string & object

remove all fragments when finished

window_size? ​

optional window_size?: number | string & object

number of fragments kept in the manifest

See ​

https://ffmpeg.org/ffmpeg-formats.html#hds

hls ​

hls: object

Defined in: src/constants/format-options.ts:759

Apple HTTP Live Streaming

cc_stream_map? ​

optional cc_stream_map?: string | number

Closed captions stream map string

headers? ​

optional headers?: string | number

set custom HTTP headers, can override built in default headers

hls_allow_cache? ​

optional hls_allow_cache?: number | string & object

explicitly set whether the client MAY (1) or MUST NOT (0) cache media segments

hls_base_url? ​

optional hls_base_url?: string | number

url to prepend to each playlist entry

hls_delete_threshold? ​

optional hls_delete_threshold?: number | string & object

set number of unreferenced segments to keep before deleting

hls_enc? ​

optional hls_enc?: boolean | string & object

enable AES128 encryption support

hls_enc_iv? ​

optional hls_enc_iv?: string | number

hex-coded 16 byte initialization vector

hls_enc_key? ​

optional hls_enc_key?: string | number

hex-coded 16 byte key to encrypt the segments

hls_enc_key_url? ​

optional hls_enc_key_url?: string | number

url to access the key to decrypt the segments

hls_flags? ​

optional hls_flags?: number | string & object | "single_file" | "temp_file" | "delete_segments" | "round_durations" | "discont_start" | "omit_endlist" | "split_by_time" | "append_list" | "program_date_time" | "second_level_segment_index" | "second_level_segment_duration" | "second_level_segment_size" | "periodic_rekey" | "independent_segments" | "iframes_only"

set flags affecting HLS playlist and media file generation

hls_fmp4_init_filename? ​

optional hls_fmp4_init_filename?: string | number

set fragment mp4 file init filename

hls_fmp4_init_resend? ​

optional hls_fmp4_init_resend?: boolean | string & object

resend fragment mp4 init file after refresh m3u8 every time

hls_init_time? ​

optional hls_init_time?: string | number

set segment length at init list

hls_key_info_file? ​

optional hls_key_info_file?: string | number

file with key URI and key file path

hls_list_size? ​

optional hls_list_size?: number | string & object

set maximum number of playlist entries

hls_playlist_type? ​

optional hls_playlist_type?: number | string & object | "event" | "vod"

set the HLS playlist type

hls_segment_filename? ​

optional hls_segment_filename?: string | number

filename template for segment files

hls_segment_options? ​

optional hls_segment_options?: string | number

set segments files format options of hls

hls_segment_size? ​

optional hls_segment_size?: number | string & object

maximum size per segment file, (in bytes)

hls_segment_type? ​

optional hls_segment_type?: number | string & object | "mpegts" | "fmp4"

set hls segment files type

hls_start_number_source? ​

optional hls_start_number_source?: number | string & object | "generic" | "epoch" | "epoch_us" | "datetime"

set source of first number in sequence

hls_subtitle_path? ​

optional hls_subtitle_path?: string | number

set path of hls subtitles

hls_time? ​

optional hls_time?: string | number

set segment length

hls_vtt_options? ​

optional hls_vtt_options?: string | number

set hls vtt list of options for the container format used for hls

http_persistent? ​

optional http_persistent?: boolean | string & object

Use persistent HTTP connections

http_user_agent? ​

optional http_user_agent?: string | number

override User-Agent field in HTTP header

ignore_io_errors? ​

optional ignore_io_errors?: boolean | string & object

Ignore IO errors for stable long-duration runs with network output

master_pl_name? ​

optional master_pl_name?: string | number

Create HLS master playlist with this name

master_pl_publish_rate? ​

optional master_pl_publish_rate?: number | string & object

Publish master play list every after this many segment intervals

method? ​

optional method?: string | number

set the HTTP method(default: PUT)

start_number? ​

optional start_number?: number | string & object

set first number in the sequence

strftime? ​

optional strftime?: boolean | string & object

set filename expansion with strftime at segment creation

strftime_mkdir? ​

optional strftime_mkdir?: boolean | string & object

create last directory component in strftime-generated filename

timeout? ​

optional timeout?: string | number

set timeout for socket I/O operations

var_stream_map? ​

optional var_stream_map?: string | number

Variant stream map string

See ​

https://ffmpeg.org/ffmpeg-formats.html#hls

image2 ​

image2: object

Defined in: src/constants/format-options.ts:852

image2 sequence

atomic_writing? ​

optional atomic_writing?: boolean | string & object

write files atomically (using temporary files and renames)

frame_pts? ​

optional frame_pts?: boolean | string & object

use current frame pts for filename

protocol_opts? ​

optional protocol_opts?: string | number

specify protocol options for the opened files

start_number? ​

optional start_number?: number | string & object

set first number in the sequence

strftime? ​

optional strftime?: boolean | string & object

use strftime for filename

update? ​

optional update?: boolean | string & object

continuously overwrite one file

See ​

https://ffmpeg.org/ffmpeg-formats.html#image2

ipod ​

ipod: object

Defined in: src/constants/format-options.ts:870

iPod H.264 MP4 (MPEG-4 Part 14)

brand? ​

optional brand?: string | number

Override major brand

empty_hdlr_name? ​

optional empty_hdlr_name?: boolean | string & object

write zero-length name string in hdlr atoms within mdia and minf atoms

encryption_key? ​

optional encryption_key?: string | number

The media encryption key (hex)

encryption_kid? ​

optional encryption_kid?: string | number

The media encryption key identifier (hex)

encryption_scheme? ​

optional encryption_scheme?: string | number

Configures the encryption scheme, allowed values are none, cenc-aes-ctr

frag_duration? ​

optional frag_duration?: number | string & object

Maximum fragment duration

frag_interleave? ​

optional frag_interleave?: number | string & object

Interleave samples within fragments (max number of consecutive samples, lower is tighter interleaving, but with more overhead)

frag_size? ​

optional frag_size?: number | string & object

Maximum fragment size

fragment_index? ​

optional fragment_index?: number | string & object

Fragment number of the next fragment

iods_audio_profile? ​

optional iods_audio_profile?: number | string & object

iods audio profile atom.

iods_video_profile? ​

optional iods_video_profile?: number | string & object

iods video profile atom.

ism_lookahead? ​

optional ism_lookahead?: number | string & object

Number of lookahead entries for ISM files

min_frag_duration? ​

optional min_frag_duration?: number | string & object

Minimum fragment duration

moov_size? ​

optional moov_size?: number | string & object

maximum moov size so it can be placed at the begin

mov_gamma? ​

optional mov_gamma?: number | string & object

gamma value for gama atom

movflags? ​

optional movflags?: number | string & object | "cmaf" | "dash" | "default_base_moof" | "delay_moov" | "disable_chpl" | "empty_moov" | "faststart" | "frag_custom" | "frag_discont" | "frag_every_frame" | "frag_keyframe" | "global_sidx" | "isml" | "negative_cts_offsets" | "omit_tfhd_offset" | "prefer_icc" | "rtphint" | "separate_moof" | "skip_sidx" | "skip_trailer" | "use_metadata_tags" | "write_colr" | "write_gama" | "hybrid_fragmented"

MOV muxer flags

movie_timescale? ​

optional movie_timescale?: number | string & object

set movie timescale

rtpflags? ​

optional rtpflags?: number | string & object | "latm" | "rfc2190" | "skip_rtcp" | "h264_mode0" | "send_bye"

RTP muxer flags

skip_iods? ​

optional skip_iods?: boolean | string & object

Skip writing iods atom.

use_editlist? ​

optional use_editlist?: boolean | string & object

use edit list

use_stream_ids_as_track_ids? ​

optional use_stream_ids_as_track_ids?: boolean | string & object

use stream ids as track ids

video_track_timescale? ​

optional video_track_timescale?: number | string & object

set timescale of all video tracks

write_btrt? ​

optional write_btrt?: boolean | string & object

force or disable writing btrt

write_prft? ​

optional write_prft?: number | string & object | "pts" | "wallclock"

Write producer reference time box with specified time source

write_tmcd? ​

optional write_tmcd?: boolean | string & object

force or disable writing tmcd

See ​

https://ffmpeg.org/ffmpeg-formats.html#ipod

ismv ​

ismv: object

Defined in: src/constants/format-options.ts:952

ISMV/ISMA (Smooth Streaming)

brand? ​

optional brand?: string | number

Override major brand

empty_hdlr_name? ​

optional empty_hdlr_name?: boolean | string & object

write zero-length name string in hdlr atoms within mdia and minf atoms

encryption_key? ​

optional encryption_key?: string | number

The media encryption key (hex)

encryption_kid? ​

optional encryption_kid?: string | number

The media encryption key identifier (hex)

encryption_scheme? ​

optional encryption_scheme?: string | number

Configures the encryption scheme, allowed values are none, cenc-aes-ctr

frag_duration? ​

optional frag_duration?: number | string & object

Maximum fragment duration

frag_interleave? ​

optional frag_interleave?: number | string & object

Interleave samples within fragments (max number of consecutive samples, lower is tighter interleaving, but with more overhead)

frag_size? ​

optional frag_size?: number | string & object

Maximum fragment size

fragment_index? ​

optional fragment_index?: number | string & object

Fragment number of the next fragment

iods_audio_profile? ​

optional iods_audio_profile?: number | string & object

iods audio profile atom.

iods_video_profile? ​

optional iods_video_profile?: number | string & object

iods video profile atom.

ism_lookahead? ​

optional ism_lookahead?: number | string & object

Number of lookahead entries for ISM files

min_frag_duration? ​

optional min_frag_duration?: number | string & object

Minimum fragment duration

moov_size? ​

optional moov_size?: number | string & object

maximum moov size so it can be placed at the begin

mov_gamma? ​

optional mov_gamma?: number | string & object

gamma value for gama atom

movflags? ​

optional movflags?: number | string & object | "cmaf" | "dash" | "default_base_moof" | "delay_moov" | "disable_chpl" | "empty_moov" | "faststart" | "frag_custom" | "frag_discont" | "frag_every_frame" | "frag_keyframe" | "global_sidx" | "isml" | "negative_cts_offsets" | "omit_tfhd_offset" | "prefer_icc" | "rtphint" | "separate_moof" | "skip_sidx" | "skip_trailer" | "use_metadata_tags" | "write_colr" | "write_gama" | "hybrid_fragmented"

MOV muxer flags

movie_timescale? ​

optional movie_timescale?: number | string & object

set movie timescale

rtpflags? ​

optional rtpflags?: number | string & object | "latm" | "rfc2190" | "skip_rtcp" | "h264_mode0" | "send_bye"

RTP muxer flags

skip_iods? ​

optional skip_iods?: boolean | string & object

Skip writing iods atom.

use_editlist? ​

optional use_editlist?: boolean | string & object

use edit list

use_stream_ids_as_track_ids? ​

optional use_stream_ids_as_track_ids?: boolean | string & object

use stream ids as track ids

video_track_timescale? ​

optional video_track_timescale?: number | string & object

set timescale of all video tracks

write_btrt? ​

optional write_btrt?: boolean | string & object

force or disable writing btrt

write_prft? ​

optional write_prft?: number | string & object | "pts" | "wallclock"

Write producer reference time box with specified time source

write_tmcd? ​

optional write_tmcd?: boolean | string & object

force or disable writing tmcd

See ​

https://ffmpeg.org/ffmpeg-formats.html#ismv

latm ​

latm: object

Defined in: src/constants/format-options.ts:1034

LOAS/LATM

smc-interval? ​

optional smc-interval?: number | string & object

StreamMuxConfig interval.

See ​

https://ffmpeg.org/ffmpeg-formats.html#latm

lrc ​

lrc: object

Defined in: src/constants/format-options.ts:1042

LRC lyrics

precision? ​

optional precision?: number | string & object

precision of the fractional part of the timestamp, 2 for centiseconds

See ​

https://ffmpeg.org/ffmpeg-formats.html#lrc

matroska ​

matroska: object

Defined in: src/constants/format-options.ts:1050

Matroska Audio

allow_raw_vfw? ​

optional allow_raw_vfw?: boolean | string & object

allow raw VFW mode

cluster_size_limit? ​

optional cluster_size_limit?: number | string & object

store at most the provided amount of bytes in a cluster

cluster_time_limit? ​

optional cluster_time_limit?: number | string & object

store at most the provided number of milliseconds in a cluster

cues_to_front? ​

optional cues_to_front?: boolean | string & object

move Cues (the index) to the front by shifting data if necessary

dash? ​

optional dash?: boolean | string & object

create a WebM file conforming to WebM DASH specification

dash_track_number? ​

optional dash_track_number?: number | string & object

track number for the DASH stream

default_mode? ​

optional default_mode?: number | string & object | "infer" | "infer_no_subs" | "passthrough"

control how a track's FlagDefault is inferred

flipped_raw_rgb? ​

optional flipped_raw_rgb?: boolean | string & object

store raw RGB bitmaps in VFW mode in bottom-up mode

live? ​

optional live?: boolean | string & object

write files assuming it is a live stream

reserve_index_space? ​

optional reserve_index_space?: number | string & object

reserve a given amount of space (in bytes) at the beginning of the file for the index (cues)

write_crc32? ​

optional write_crc32?: boolean | string & object

write a CRC32 element inside every Level 1 element

See ​

https://ffmpeg.org/ffmpeg-formats.html#matroska

mcc ​

mcc: object

Defined in: src/constants/format-options.ts:1078

MacCaption

creation_program? ​

optional creation_program?: string | number

the creation program

creation_time? ​

optional creation_time?: string | number

the creation time

mcc_version? ​

optional mcc_version?: number | string & object

the mcc file format version

override_time_code_rate? ​

optional override_time_code_rate?: string | number

override the Time Code Rate value in the output

use_u_alias? ​

optional use_u_alias?: boolean | string & object

use the U alias for E1h 00h 00h 00h, disabled by default because some .mcc files disagree on whether it has 2 or 3 zero bytes

See ​

https://ffmpeg.org/ffmpeg-formats.html#mcc

md5 ​

md5: object

Defined in: src/constants/format-options.ts:1094

MD5 testing

hash? ​

optional hash?: string | number

set hash to use

See ​

https://ffmpeg.org/ffmpeg-formats.html#md5

mov ​

mov: object

Defined in: src/constants/format-options.ts:1102

QuickTime / MOV

brand? ​

optional brand?: string | number

Override major brand

empty_hdlr_name? ​

optional empty_hdlr_name?: boolean | string & object

write zero-length name string in hdlr atoms within mdia and minf atoms

encryption_key? ​

optional encryption_key?: string | number

The media encryption key (hex)

encryption_kid? ​

optional encryption_kid?: string | number

The media encryption key identifier (hex)

encryption_scheme? ​

optional encryption_scheme?: string | number

Configures the encryption scheme, allowed values are none, cenc-aes-ctr

frag_duration? ​

optional frag_duration?: number | string & object

Maximum fragment duration

frag_interleave? ​

optional frag_interleave?: number | string & object

Interleave samples within fragments (max number of consecutive samples, lower is tighter interleaving, but with more overhead)

frag_size? ​

optional frag_size?: number | string & object

Maximum fragment size

fragment_index? ​

optional fragment_index?: number | string & object

Fragment number of the next fragment

iods_audio_profile? ​

optional iods_audio_profile?: number | string & object

iods audio profile atom.

iods_video_profile? ​

optional iods_video_profile?: number | string & object

iods video profile atom.

ism_lookahead? ​

optional ism_lookahead?: number | string & object

Number of lookahead entries for ISM files

min_frag_duration? ​

optional min_frag_duration?: number | string & object

Minimum fragment duration

moov_size? ​

optional moov_size?: number | string & object

maximum moov size so it can be placed at the begin

mov_gamma? ​

optional mov_gamma?: number | string & object

gamma value for gama atom

movflags? ​

optional movflags?: number | string & object | "cmaf" | "dash" | "default_base_moof" | "delay_moov" | "disable_chpl" | "empty_moov" | "faststart" | "frag_custom" | "frag_discont" | "frag_every_frame" | "frag_keyframe" | "global_sidx" | "isml" | "negative_cts_offsets" | "omit_tfhd_offset" | "prefer_icc" | "rtphint" | "separate_moof" | "skip_sidx" | "skip_trailer" | "use_metadata_tags" | "write_colr" | "write_gama" | "hybrid_fragmented"

MOV muxer flags

movie_timescale? ​

optional movie_timescale?: number | string & object

set movie timescale

rtpflags? ​

optional rtpflags?: number | string & object | "latm" | "rfc2190" | "skip_rtcp" | "h264_mode0" | "send_bye"

RTP muxer flags

skip_iods? ​

optional skip_iods?: boolean | string & object

Skip writing iods atom.

use_editlist? ​

optional use_editlist?: boolean | string & object

use edit list

use_stream_ids_as_track_ids? ​

optional use_stream_ids_as_track_ids?: boolean | string & object

use stream ids as track ids

video_track_timescale? ​

optional video_track_timescale?: number | string & object

set timescale of all video tracks

write_btrt? ​

optional write_btrt?: boolean | string & object

force or disable writing btrt

write_prft? ​

optional write_prft?: number | string & object | "pts" | "wallclock"

Write producer reference time box with specified time source

write_tmcd? ​

optional write_tmcd?: boolean | string & object

force or disable writing tmcd

See ​

https://ffmpeg.org/ffmpeg-formats.html#mov

mp3 ​

mp3: object

Defined in: src/constants/format-options.ts:1184

MP3 (MPEG audio layer 3)

id3v2_version? ​

optional id3v2_version?: number | string & object

Select ID3v2 version to write. Currently 3 and 4 are supported.

write_id3v1? ​

optional write_id3v1?: boolean | string & object

Enable ID3v1 writing. ID3v1 tags are written in UTF-8 which may not be supported by most software.

write_xing? ​

optional write_xing?: boolean | string & object

Write the Xing header containing file duration.

See ​

https://ffmpeg.org/ffmpeg-formats.html#mp3

mp4 ​

mp4: object

Defined in: src/constants/format-options.ts:1196

MP4 (MPEG-4 Part 14)

brand? ​

optional brand?: string | number

Override major brand

empty_hdlr_name? ​

optional empty_hdlr_name?: boolean | string & object

write zero-length name string in hdlr atoms within mdia and minf atoms

encryption_key? ​

optional encryption_key?: string | number

The media encryption key (hex)

encryption_kid? ​

optional encryption_kid?: string | number

The media encryption key identifier (hex)

encryption_scheme? ​

optional encryption_scheme?: string | number

Configures the encryption scheme, allowed values are none, cenc-aes-ctr

frag_duration? ​

optional frag_duration?: number | string & object

Maximum fragment duration

frag_interleave? ​

optional frag_interleave?: number | string & object

Interleave samples within fragments (max number of consecutive samples, lower is tighter interleaving, but with more overhead)

frag_size? ​

optional frag_size?: number | string & object

Maximum fragment size

fragment_index? ​

optional fragment_index?: number | string & object

Fragment number of the next fragment

iods_audio_profile? ​

optional iods_audio_profile?: number | string & object

iods audio profile atom.

iods_video_profile? ​

optional iods_video_profile?: number | string & object

iods video profile atom.

ism_lookahead? ​

optional ism_lookahead?: number | string & object

Number of lookahead entries for ISM files

min_frag_duration? ​

optional min_frag_duration?: number | string & object

Minimum fragment duration

moov_size? ​

optional moov_size?: number | string & object

maximum moov size so it can be placed at the begin

mov_gamma? ​

optional mov_gamma?: number | string & object

gamma value for gama atom

movflags? ​

optional movflags?: number | string & object | "cmaf" | "dash" | "default_base_moof" | "delay_moov" | "disable_chpl" | "empty_moov" | "faststart" | "frag_custom" | "frag_discont" | "frag_every_frame" | "frag_keyframe" | "global_sidx" | "isml" | "negative_cts_offsets" | "omit_tfhd_offset" | "prefer_icc" | "rtphint" | "separate_moof" | "skip_sidx" | "skip_trailer" | "use_metadata_tags" | "write_colr" | "write_gama" | "hybrid_fragmented"

MOV muxer flags

movie_timescale? ​

optional movie_timescale?: number | string & object

set movie timescale

rtpflags? ​

optional rtpflags?: number | string & object | "latm" | "rfc2190" | "skip_rtcp" | "h264_mode0" | "send_bye"

RTP muxer flags

skip_iods? ​

optional skip_iods?: boolean | string & object

Skip writing iods atom.

use_editlist? ​

optional use_editlist?: boolean | string & object

use edit list

use_stream_ids_as_track_ids? ​

optional use_stream_ids_as_track_ids?: boolean | string & object

use stream ids as track ids

video_track_timescale? ​

optional video_track_timescale?: number | string & object

set timescale of all video tracks

write_btrt? ​

optional write_btrt?: boolean | string & object

force or disable writing btrt

write_prft? ​

optional write_prft?: number | string & object | "pts" | "wallclock"

Write producer reference time box with specified time source

write_tmcd? ​

optional write_tmcd?: boolean | string & object

force or disable writing tmcd

See ​

https://ffmpeg.org/ffmpeg-formats.html#mp4

mpeg ​

mpeg: object

Defined in: src/constants/format-options.ts:1278

MPEG-1 Systems / MPEG program stream

muxrate? ​

optional muxrate?: number | string & object

mux rate as bits/s

preload? ​

optional preload?: number | string & object

initial demux-decode delay in microseconds

See ​

https://ffmpeg.org/ffmpeg-formats.html#mpeg

mpegts ​

mpegts: object

Defined in: src/constants/format-options.ts:1288

MPEG-TS (MPEG-2 Transport Stream)

mpegts_copyts? ​

optional mpegts_copyts?: boolean | string & object

don't offset dts/pts

mpegts_flags? ​

optional mpegts_flags?: number | string & object | "latm" | "resend_headers" | "pat_pmt_at_frames" | "system_b" | "initial_discontinuity" | "nit" | "omit_rai"

MPEG-TS muxing flags

mpegts_m2ts_mode? ​

optional mpegts_m2ts_mode?: boolean | string & object

Enable m2ts mode.

mpegts_original_network_id? ​

optional mpegts_original_network_id?: number | string & object

Set original_network_id field.

mpegts_pmt_start_pid? ​

optional mpegts_pmt_start_pid?: number | string & object

Set the first pid of the PMT.

mpegts_service_id? ​

optional mpegts_service_id?: number | string & object

Set service_id field.

mpegts_service_type? ​

optional mpegts_service_type?: number | string & object | "digital_tv" | "digital_radio" | "teletext" | "advanced_codec_digital_radio" | "mpeg2_digital_hdtv" | "advanced_codec_digital_sdtv" | "advanced_codec_digital_hdtv" | "hevc_digital_hdtv"

Set service_type field.

mpegts_start_pid? ​

optional mpegts_start_pid?: number | string & object

Set the first pid.

mpegts_transport_stream_id? ​

optional mpegts_transport_stream_id?: number | string & object

Set transport_stream_id field.

muxrate? ​

optional muxrate?: number | string & object

nit_period? ​

optional nit_period?: string | number

NIT retransmission time limit in seconds

omit_video_pes_length? ​

optional omit_video_pes_length?: boolean | string & object

Omit the PES packet length for video packets

pat_period? ​

optional pat_period?: string | number

PAT/PMT retransmission time limit in seconds

pcr_period? ​

optional pcr_period?: number | string & object

PCR retransmission time in milliseconds

pes_payload_size? ​

optional pes_payload_size?: number | string & object

Minimum PES packet payload in bytes

sdt_period? ​

optional sdt_period?: string | number

SDT retransmission time limit in seconds

tables_version? ​

optional tables_version?: number | string & object

set PAT, PMT, SDT and NIT version

See ​

https://ffmpeg.org/ffmpeg-formats.html#mpegts

mpjpeg ​

mpjpeg: object

Defined in: src/constants/format-options.ts:1337

MIME multipart JPEG

boundary_tag? ​

optional boundary_tag?: string | number

Boundary tag

See ​

https://ffmpeg.org/ffmpeg-formats.html#mpjpeg

mxf ​

mxf: object

Defined in: src/constants/format-options.ts:1345

MXF (Material eXchange Format)

signal_standard? ​

optional signal_standard?: number | string & object | "smpte428" | "bt601" | "bt1358" | "smpte347m" | "smpte274m" | "smpte296m" | "smpte349m"

Force/set Signal Standard

store_user_comments? ​

optional store_user_comments?: boolean | string & object

See ​

https://ffmpeg.org/ffmpeg-formats.html#mxf

mxf_d10 ​

mxf_d10: object

Defined in: src/constants/format-options.ts:1354

MXF (Material eXchange Format) D-10 Mapping

d10_channelcount? ​

optional d10_channelcount?: number | string & object

Force/set channelcount in generic sound essence descriptor

signal_standard? ​

optional signal_standard?: number | string & object | "smpte428" | "bt601" | "bt1358" | "smpte347m" | "smpte274m" | "smpte296m" | "smpte349m"

Force/set Signal Standard

store_user_comments? ​

optional store_user_comments?: boolean | string & object

See ​

https://ffmpeg.org/ffmpeg-formats.html#mxf_005fd10

mxf_opatom ​

mxf_opatom: object

Defined in: src/constants/format-options.ts:1365

MXF (Material eXchange Format) Operational Pattern Atom

mxf_audio_edit_rate? ​

optional mxf_audio_edit_rate?: string | number

Audio edit rate for timecode

signal_standard? ​

optional signal_standard?: number | string & object | "smpte428" | "bt601" | "bt1358" | "smpte347m" | "smpte274m" | "smpte296m" | "smpte349m"

Force/set Signal Standard

store_user_comments? ​

optional store_user_comments?: boolean | string & object

See ​

https://ffmpeg.org/ffmpeg-formats.html#mxf_005fopatom

nut ​

nut: object

Defined in: src/constants/format-options.ts:1376

NUT

syncpoints? ​

optional syncpoints?: number | "none" | string & object | "default" | "timestamped"

NUT syncpoint behaviour

write_index? ​

optional write_index?: boolean | string & object

Write index

See ​

https://ffmpeg.org/ffmpeg-formats.html#nut

oga ​

oga: object

Defined in: src/constants/format-options.ts:1386

Ogg Audio

oggpagesize? ​

optional oggpagesize?: number | string & object

Set preferred Ogg page size.

page_duration? ​

optional page_duration?: number | string & object

preferred page duration, in microseconds

pagesize? ​

optional pagesize?: number | string & object

preferred page size in bytes

serial_offset? ​

optional serial_offset?: number | string & object

serial number offset

See ​

https://ffmpeg.org/ffmpeg-formats.html#oga

ogg ​

ogg: object

Defined in: src/constants/format-options.ts:1400

Ogg

oggpagesize? ​

optional oggpagesize?: number | string & object

Set preferred Ogg page size.

page_duration? ​

optional page_duration?: number | string & object

preferred page duration, in microseconds

pagesize? ​

optional pagesize?: number | string & object

preferred page size in bytes

serial_offset? ​

optional serial_offset?: number | string & object

serial number offset

See ​

https://ffmpeg.org/ffmpeg-formats.html#ogg

ogv ​

ogv: object

Defined in: src/constants/format-options.ts:1414

Ogg Video

oggpagesize? ​

optional oggpagesize?: number | string & object

Set preferred Ogg page size.

page_duration? ​

optional page_duration?: number | string & object

preferred page duration, in microseconds

pagesize? ​

optional pagesize?: number | string & object

preferred page size in bytes

serial_offset? ​

optional serial_offset?: number | string & object

serial number offset

See ​

https://ffmpeg.org/ffmpeg-formats.html#ogv

opus ​

opus: object

Defined in: src/constants/format-options.ts:1428

Ogg Opus

oggpagesize? ​

optional oggpagesize?: number | string & object

Set preferred Ogg page size.

page_duration? ​

optional page_duration?: number | string & object

preferred page duration, in microseconds

pagesize? ​

optional pagesize?: number | string & object

preferred page size in bytes

serial_offset? ​

optional serial_offset?: number | string & object

serial number offset

See ​

https://ffmpeg.org/ffmpeg-formats.html#opus

pdv ​

pdv: object

Defined in: src/constants/format-options.ts:1442

PlayDate Video

max_frames? ​

optional max_frames?: number | string & object

maximum number of frames reserved in table (mandatory)

See ​

https://ffmpeg.org/ffmpeg-formats.html#pdv

psp ​

psp: object

Defined in: src/constants/format-options.ts:1450

PSP MP4 (MPEG-4 Part 14)

brand? ​

optional brand?: string | number

Override major brand

empty_hdlr_name? ​

optional empty_hdlr_name?: boolean | string & object

write zero-length name string in hdlr atoms within mdia and minf atoms

encryption_key? ​

optional encryption_key?: string | number

The media encryption key (hex)

encryption_kid? ​

optional encryption_kid?: string | number

The media encryption key identifier (hex)

encryption_scheme? ​

optional encryption_scheme?: string | number

Configures the encryption scheme, allowed values are none, cenc-aes-ctr

frag_duration? ​

optional frag_duration?: number | string & object

Maximum fragment duration

frag_interleave? ​

optional frag_interleave?: number | string & object

Interleave samples within fragments (max number of consecutive samples, lower is tighter interleaving, but with more overhead)

frag_size? ​

optional frag_size?: number | string & object

Maximum fragment size

fragment_index? ​

optional fragment_index?: number | string & object

Fragment number of the next fragment

iods_audio_profile? ​

optional iods_audio_profile?: number | string & object

iods audio profile atom.

iods_video_profile? ​

optional iods_video_profile?: number | string & object

iods video profile atom.

ism_lookahead? ​

optional ism_lookahead?: number | string & object

Number of lookahead entries for ISM files

min_frag_duration? ​

optional min_frag_duration?: number | string & object

Minimum fragment duration

moov_size? ​

optional moov_size?: number | string & object

maximum moov size so it can be placed at the begin

mov_gamma? ​

optional mov_gamma?: number | string & object

gamma value for gama atom

movflags? ​

optional movflags?: number | string & object | "cmaf" | "dash" | "default_base_moof" | "delay_moov" | "disable_chpl" | "empty_moov" | "faststart" | "frag_custom" | "frag_discont" | "frag_every_frame" | "frag_keyframe" | "global_sidx" | "isml" | "negative_cts_offsets" | "omit_tfhd_offset" | "prefer_icc" | "rtphint" | "separate_moof" | "skip_sidx" | "skip_trailer" | "use_metadata_tags" | "write_colr" | "write_gama" | "hybrid_fragmented"

MOV muxer flags

movie_timescale? ​

optional movie_timescale?: number | string & object

set movie timescale

rtpflags? ​

optional rtpflags?: number | string & object | "latm" | "rfc2190" | "skip_rtcp" | "h264_mode0" | "send_bye"

RTP muxer flags

skip_iods? ​

optional skip_iods?: boolean | string & object

Skip writing iods atom.

use_editlist? ​

optional use_editlist?: boolean | string & object

use edit list

use_stream_ids_as_track_ids? ​

optional use_stream_ids_as_track_ids?: boolean | string & object

use stream ids as track ids

video_track_timescale? ​

optional video_track_timescale?: number | string & object

set timescale of all video tracks

write_btrt? ​

optional write_btrt?: boolean | string & object

force or disable writing btrt

write_prft? ​

optional write_prft?: number | string & object | "pts" | "wallclock"

Write producer reference time box with specified time source

write_tmcd? ​

optional write_tmcd?: boolean | string & object

force or disable writing tmcd

See ​

https://ffmpeg.org/ffmpeg-formats.html#psp

pulse ​

pulse: object

Defined in: src/constants/format-options.ts:1532

Pulse audio output

buffer_duration? ​

optional buffer_duration?: number | string & object

set buffer duration in millisecs

buffer_size? ​

optional buffer_size?: number | string & object

set buffer size in bytes

device? ​

optional device?: string | number

set device name

minreq? ​

optional minreq?: number | string & object

set minimum request size

name? ​

optional name?: string | number

set application name

prebuf? ​

optional prebuf?: number | string & object

set pre-buffering size

server? ​

optional server?: string | number

set PulseAudio server

stream_name? ​

optional stream_name?: string | number

set stream description

See ​

https://ffmpeg.org/ffmpeg-formats.html#pulse

rtp ​

rtp: object

Defined in: src/constants/format-options.ts:1554

RTP output

cname? ​

optional cname?: string | number

CNAME to include in RTCP SR packets

payload_type? ​

optional payload_type?: number | string & object

Specify RTP payload type

rtpflags? ​

optional rtpflags?: number | string & object | "latm" | "rfc2190" | "skip_rtcp" | "h264_mode0" | "send_bye"

RTP muxer flags

seq? ​

optional seq?: number | string & object

Starting sequence number

ssrc? ​

optional ssrc?: number | string & object

Stream identifier

See ​

https://ffmpeg.org/ffmpeg-formats.html#rtp

rtp_mpegts ​

rtp_mpegts: object

Defined in: src/constants/format-options.ts:1570

RTP/mpegts output format

mpegts_muxer_options? ​

optional mpegts_muxer_options?: string | number

set list of options for the MPEG-TS muxer

rtp_muxer_options? ​

optional rtp_muxer_options?: string | number

set list of options for the RTP muxer

See ​

https://ffmpeg.org/ffmpeg-formats.html#rtp_005fmpegts

segment ​

segment: object

Defined in: src/constants/format-options.ts:1580

segment

break_non_keyframes? ​

optional break_non_keyframes?: boolean | string & object

allow breaking segments on non-keyframes

increment_tc? ​

optional increment_tc?: boolean | string & object

increment timecode between each segment

individual_header_trailer? ​

optional individual_header_trailer?: boolean | string & object

write header/trailer to each segment

initial_offset? ​

optional initial_offset?: string | number

set initial timestamp offset

min_seg_duration? ​

optional min_seg_duration?: string | number

set minimum segment duration

reference_stream? ​

optional reference_stream?: string | number

set reference stream

reset_timestamps? ​

optional reset_timestamps?: boolean | string & object

reset timestamps at the beginning of each segment

segment_atclocktime? ​

optional segment_atclocktime?: boolean | string & object

set segment to be cut at clocktime

segment_clocktime_offset? ​

optional segment_clocktime_offset?: string | number

set segment clocktime offset

segment_clocktime_wrap_duration? ​

optional segment_clocktime_wrap_duration?: string | number

set segment clocktime wrapping duration

segment_format? ​

optional segment_format?: string | number

set container format used for the segments

segment_format_options? ​

optional segment_format_options?: string | number

set list of options for the container format used for the segments

segment_frames? ​

optional segment_frames?: string | number

set segment split frame numbers

segment_header_filename? ​

optional segment_header_filename?: string | number

write a single file containing the header

segment_list? ​

optional segment_list?: string | number

set the segment list filename

segment_list_entry_prefix? ​

optional segment_list_entry_prefix?: string | number

set base url prefix for segments

segment_list_flags? ​

optional segment_list_flags?: number | string & object | "cache" | "live"

set flags affecting segment list generation

segment_list_size? ​

optional segment_list_size?: number | string & object

set the maximum number of playlist entries

segment_list_type? ​

optional segment_list_type?: number | "flat" | string & object | "csv" | "ext" | "ffconcat" | "m3u8" | "hls"

set the segment list type

segment_start_number? ​

optional segment_start_number?: number | string & object

set the sequence number of the first segment

segment_time? ​

optional segment_time?: string | number

set segment duration

segment_time_delta? ​

optional segment_time_delta?: string | number

set approximation value used for the segment times

segment_times? ​

optional segment_times?: string | number

set segment split time points

segment_wrap? ​

optional segment_wrap?: number | string & object

set number after which the index wraps

segment_wrap_number? ​

optional segment_wrap_number?: number | string & object

set the number of wrap before the first segment

strftime? ​

optional strftime?: boolean | string & object

set filename expansion with strftime at segment creation

write_empty_segments? ​

optional write_empty_segments?: boolean | string & object

allow writing empty 'filler' segments

write_header_trailer? ​

optional write_header_trailer?: boolean | string & object

write a header to the first segment and a trailer to the last one

See ​

https://ffmpeg.org/ffmpeg-formats.html#segment

smoothstreaming ​

smoothstreaming: object

Defined in: src/constants/format-options.ts:1642

Smooth Streaming Muxer

extra_window_size? ​

optional extra_window_size?: number | string & object

number of fragments kept outside of the manifest before removing from disk

lookahead_count? ​

optional lookahead_count?: number | string & object

number of lookahead fragments

min_frag_duration? ​

optional min_frag_duration?: number | string & object

minimum fragment duration (in microseconds)

remove_at_exit? ​

optional remove_at_exit?: boolean | string & object

remove all fragments when finished

window_size? ​

optional window_size?: number | string & object

number of fragments kept in the manifest

See ​

https://ffmpeg.org/ffmpeg-formats.html#smoothstreaming

spdif ​

spdif: object

Defined in: src/constants/format-options.ts:1658

IEC 61937 (used on S/PDIF - IEC958)

dtshd_fallback_time? ​

optional dtshd_fallback_time?: number | string & object

min secs to strip HD for after an overflow (-1: till the end, default 60)

dtshd_rate? ​

optional dtshd_rate?: number | string & object

mux complete DTS frames in HD mode at the specified IEC958 rate (in Hz, default 0=disabled)

spdif_flags? ​

optional spdif_flags?: number | string & object | "be"

IEC 61937 encapsulation flags

See ​

https://ffmpeg.org/ffmpeg-formats.html#spdif

spx ​

spx: object

Defined in: src/constants/format-options.ts:1670

Ogg Speex

oggpagesize? ​

optional oggpagesize?: number | string & object

Set preferred Ogg page size.

page_duration? ​

optional page_duration?: number | string & object

preferred page duration, in microseconds

pagesize? ​

optional pagesize?: number | string & object

preferred page size in bytes

serial_offset? ​

optional serial_offset?: number | string & object

serial number offset

See ​

https://ffmpeg.org/ffmpeg-formats.html#spx

ssegment ​

ssegment: object

Defined in: src/constants/format-options.ts:1684

streaming segment muxer

break_non_keyframes? ​

optional break_non_keyframes?: boolean | string & object

allow breaking segments on non-keyframes

increment_tc? ​

optional increment_tc?: boolean | string & object

increment timecode between each segment

individual_header_trailer? ​

optional individual_header_trailer?: boolean | string & object

write header/trailer to each segment

initial_offset? ​

optional initial_offset?: string | number

set initial timestamp offset

min_seg_duration? ​

optional min_seg_duration?: string | number

set minimum segment duration

reference_stream? ​

optional reference_stream?: string | number

set reference stream

reset_timestamps? ​

optional reset_timestamps?: boolean | string & object

reset timestamps at the beginning of each segment

segment_atclocktime? ​

optional segment_atclocktime?: boolean | string & object

set segment to be cut at clocktime

segment_clocktime_offset? ​

optional segment_clocktime_offset?: string | number

set segment clocktime offset

segment_clocktime_wrap_duration? ​

optional segment_clocktime_wrap_duration?: string | number

set segment clocktime wrapping duration

segment_format? ​

optional segment_format?: string | number

set container format used for the segments

segment_format_options? ​

optional segment_format_options?: string | number

set list of options for the container format used for the segments

segment_frames? ​

optional segment_frames?: string | number

set segment split frame numbers

segment_header_filename? ​

optional segment_header_filename?: string | number

write a single file containing the header

segment_list? ​

optional segment_list?: string | number

set the segment list filename

segment_list_entry_prefix? ​

optional segment_list_entry_prefix?: string | number

set base url prefix for segments

segment_list_flags? ​

optional segment_list_flags?: number | string & object | "cache" | "live"

set flags affecting segment list generation

segment_list_size? ​

optional segment_list_size?: number | string & object

set the maximum number of playlist entries

segment_list_type? ​

optional segment_list_type?: number | "flat" | string & object | "csv" | "ext" | "ffconcat" | "m3u8" | "hls"

set the segment list type

segment_start_number? ​

optional segment_start_number?: number | string & object

set the sequence number of the first segment

segment_time? ​

optional segment_time?: string | number

set segment duration

segment_time_delta? ​

optional segment_time_delta?: string | number

set approximation value used for the segment times

segment_times? ​

optional segment_times?: string | number

set segment split time points

segment_wrap? ​

optional segment_wrap?: number | string & object

set number after which the index wraps

segment_wrap_number? ​

optional segment_wrap_number?: number | string & object

set the number of wrap before the first segment

strftime? ​

optional strftime?: boolean | string & object

set filename expansion with strftime at segment creation

write_empty_segments? ​

optional write_empty_segments?: boolean | string & object

allow writing empty 'filler' segments

write_header_trailer? ​

optional write_header_trailer?: boolean | string & object

write a header to the first segment and a trailer to the last one

See ​

https://ffmpeg.org/ffmpeg-formats.html#ssegment

stream_segment ​

stream_segment: object

Defined in: src/constants/format-options.ts:1746

streaming segment muxer

break_non_keyframes? ​

optional break_non_keyframes?: boolean | string & object

allow breaking segments on non-keyframes

increment_tc? ​

optional increment_tc?: boolean | string & object

increment timecode between each segment

individual_header_trailer? ​

optional individual_header_trailer?: boolean | string & object

write header/trailer to each segment

initial_offset? ​

optional initial_offset?: string | number

set initial timestamp offset

min_seg_duration? ​

optional min_seg_duration?: string | number

set minimum segment duration

reference_stream? ​

optional reference_stream?: string | number

set reference stream

reset_timestamps? ​

optional reset_timestamps?: boolean | string & object

reset timestamps at the beginning of each segment

segment_atclocktime? ​

optional segment_atclocktime?: boolean | string & object

set segment to be cut at clocktime

segment_clocktime_offset? ​

optional segment_clocktime_offset?: string | number

set segment clocktime offset

segment_clocktime_wrap_duration? ​

optional segment_clocktime_wrap_duration?: string | number

set segment clocktime wrapping duration

segment_format? ​

optional segment_format?: string | number

set container format used for the segments

segment_format_options? ​

optional segment_format_options?: string | number

set list of options for the container format used for the segments

segment_frames? ​

optional segment_frames?: string | number

set segment split frame numbers

segment_header_filename? ​

optional segment_header_filename?: string | number

write a single file containing the header

segment_list? ​

optional segment_list?: string | number

set the segment list filename

segment_list_entry_prefix? ​

optional segment_list_entry_prefix?: string | number

set base url prefix for segments

segment_list_flags? ​

optional segment_list_flags?: number | string & object | "cache" | "live"

set flags affecting segment list generation

segment_list_size? ​

optional segment_list_size?: number | string & object

set the maximum number of playlist entries

segment_list_type? ​

optional segment_list_type?: number | "flat" | string & object | "csv" | "ext" | "ffconcat" | "m3u8" | "hls"

set the segment list type

segment_start_number? ​

optional segment_start_number?: number | string & object

set the sequence number of the first segment

segment_time? ​

optional segment_time?: string | number

set segment duration

segment_time_delta? ​

optional segment_time_delta?: string | number

set approximation value used for the segment times

segment_times? ​

optional segment_times?: string | number

set segment split time points

segment_wrap? ​

optional segment_wrap?: number | string & object

set number after which the index wraps

segment_wrap_number? ​

optional segment_wrap_number?: number | string & object

set the number of wrap before the first segment

strftime? ​

optional strftime?: boolean | string & object

set filename expansion with strftime at segment creation

write_empty_segments? ​

optional write_empty_segments?: boolean | string & object

allow writing empty 'filler' segments

write_header_trailer? ​

optional write_header_trailer?: boolean | string & object

write a header to the first segment and a trailer to the last one

See ​

https://ffmpeg.org/ffmpeg-formats.html#stream_005fsegment

streamhash ​

streamhash: object

Defined in: src/constants/format-options.ts:1808

Per-stream hash testing

hash? ​

optional hash?: string | number

set hash to use

See ​

https://ffmpeg.org/ffmpeg-formats.html#streamhash

svcd ​

svcd: object

Defined in: src/constants/format-options.ts:1816

MPEG-2 PS (SVCD)

muxrate? ​

optional muxrate?: number | string & object

mux rate as bits/s

preload? ​

optional preload?: number | string & object

initial demux-decode delay in microseconds

See ​

https://ffmpeg.org/ffmpeg-formats.html#svcd

tee ​

tee: object

Defined in: src/constants/format-options.ts:1826

Multiple muxer tee

fifo_options? ​

optional fifo_options?: string | number

fifo pseudo-muxer options

use_fifo? ​

optional use_fifo?: boolean | string & object

Use fifo pseudo-muxer to separate actual muxers from encoder

See ​

https://ffmpeg.org/ffmpeg-formats.html#tee

vcd ​

vcd: object

Defined in: src/constants/format-options.ts:1836

MPEG-1 Systems / MPEG program stream (VCD)

muxrate? ​

optional muxrate?: number | string & object

mux rate as bits/s

preload? ​

optional preload?: number | string & object

initial demux-decode delay in microseconds

See ​

https://ffmpeg.org/ffmpeg-formats.html#vcd

vob ​

vob: object

Defined in: src/constants/format-options.ts:1846

MPEG-2 PS (VOB)

muxrate? ​

optional muxrate?: number | string & object

mux rate as bits/s

preload? ​

optional preload?: number | string & object

initial demux-decode delay in microseconds

See ​

https://ffmpeg.org/ffmpeg-formats.html#vob

wav ​

wav: object

Defined in: src/constants/format-options.ts:1856

WAV / WAVE (Waveform Audio)

peak_block_size? ​

optional peak_block_size?: number | string & object

Number of audio samples used to generate each peak frame.

peak_format? ​

optional peak_format?: number | string & object

The format of the peak envelope data (1: uint8, 2: uint16).

peak_ppv? ​

optional peak_ppv?: number | string & object

Number of peak points per peak value (1 or 2).

rf64? ​

optional rf64?: number | string & object | "auto" | "always" | "never"

Use RF64 header rather than RIFF for large files.

write_bext? ​

optional write_bext?: boolean | string & object

Write BEXT chunk.

write_peak? ​

optional write_peak?: number | string & object | "off" | "on" | "only"

Write Peak Envelope chunk.

See ​

https://ffmpeg.org/ffmpeg-formats.html#wav

webm ​

webm: object

Defined in: src/constants/format-options.ts:1874

WebM

allow_raw_vfw? ​

optional allow_raw_vfw?: boolean | string & object

allow raw VFW mode

cluster_size_limit? ​

optional cluster_size_limit?: number | string & object

store at most the provided amount of bytes in a cluster

cluster_time_limit? ​

optional cluster_time_limit?: number | string & object

store at most the provided number of milliseconds in a cluster

cues_to_front? ​

optional cues_to_front?: boolean | string & object

move Cues (the index) to the front by shifting data if necessary

dash? ​

optional dash?: boolean | string & object

create a WebM file conforming to WebM DASH specification

dash_track_number? ​

optional dash_track_number?: number | string & object

track number for the DASH stream

default_mode? ​

optional default_mode?: number | string & object | "infer" | "infer_no_subs" | "passthrough"

control how a track's FlagDefault is inferred

flipped_raw_rgb? ​

optional flipped_raw_rgb?: boolean | string & object

store raw RGB bitmaps in VFW mode in bottom-up mode

live? ​

optional live?: boolean | string & object

write files assuming it is a live stream

reserve_index_space? ​

optional reserve_index_space?: number | string & object

reserve a given amount of space (in bytes) at the beginning of the file for the index (cues)

write_crc32? ​

optional write_crc32?: boolean | string & object

write a CRC32 element inside every Level 1 element

See ​

https://ffmpeg.org/ffmpeg-formats.html#webm

webm_chunk ​

webm_chunk: object

Defined in: src/constants/format-options.ts:1902

WebM Chunk Muxer

audio_chunk_duration? ​

optional audio_chunk_duration?: number | string & object

duration of each chunk in milliseconds

chunk_start_index? ​

optional chunk_start_index?: number | string & object

start index of the chunk

optional header?: string | number

filename of the header where the initialization data will be written

method? ​

optional method?: string | number

set the HTTP method

See ​

https://ffmpeg.org/ffmpeg-formats.html#webm_005fchunk

webm_dash_manifest ​

webm_dash_manifest: object

Defined in: src/constants/format-options.ts:1916

WebM DASH Manifest

adaptation_sets? ​

optional adaptation_sets?: string | number

Adaptation sets. Syntax: id=0,streams=0,1,2 id=1,streams=3,4 and so on

chunk_duration_ms? ​

optional chunk_duration_ms?: number | string & object

duration of each chunk (in milliseconds)

chunk_start_index? ​

optional chunk_start_index?: number | string & object

start index of the chunk

live? ​

optional live?: boolean | string & object

create a live stream manifest

minimum_update_period? ​

optional minimum_update_period?: number | string & object

Minimum Update Period (in seconds) of the manifest.

time_shift_buffer_depth? ​

optional time_shift_buffer_depth?: number | string & object

Smallest time (in seconds) shifting buffer for which any Representation is guaranteed to be available.

utc_timing_url? ​

optional utc_timing_url?: string | number

URL of the page that will return the UTC timestamp in ISO format

See ​

https://ffmpeg.org/ffmpeg-formats.html#webm_005fdash_005fmanifest

webp ​

webp: object

Defined in: src/constants/format-options.ts:1936

WebP

loop? ​

optional loop?: number | string & object

Number of times to loop the output: 0 - infinite loop

See ​

https://ffmpeg.org/ffmpeg-formats.html#webp

whip ​

whip: object

Defined in: src/constants/format-options.ts:1944

WHIP(WebRTC-HTTP ingestion protocol) muxer

authorization? ​

optional authorization?: string | number

The optional Bearer token for WHIP Authorization

cert_file? ​

optional cert_file?: string | number

The optional certificate file path for DTLS

handshake_timeout? ​

optional handshake_timeout?: number | string & object

Timeout in milliseconds for ICE and DTLS handshake.

key_file? ​

optional key_file?: string | number

The optional private key file path for DTLS

pkt_size? ​

optional pkt_size?: number | string & object

The maximum size, in bytes, of RTP packets that send out

rtp_history? ​

optional rtp_history?: number | string & object

The number of RTP history items to store

timeout? ​

optional timeout?: string | number

Set timeout for socket I/O operations

ts_buffer_size? ​

optional ts_buffer_size?: number | string & object

The buffer size, in bytes, of underlying protocol

whip_flags? ​

optional whip_flags?: number | string & object | "dtls_active"

Set flags affecting WHIP connection behavior

See ​

https://ffmpeg.org/ffmpeg-formats.html#whip

xv ​

xv: object

Defined in: src/constants/format-options.ts:1968

XV (XVideo) output device

display_name? ​

optional display_name?: string | number

set display name

window_id? ​

optional window_id?: number | string & object

set existing window id

window_size? ​

optional window_size?: string | number

set window forced size

window_title? ​

optional window_title?: string | number

set window title

window_x? ​

optional window_x?: number | string & object

set window x offset

window_y? ​

optional window_y?: number | string & object

set window y offset

See ​

https://ffmpeg.org/ffmpeg-formats.html#xv