Skip to content

muxers

FFmpeg muxers.

Functions:

Name Description
a64

a64 - video for Commodore 64.

ac3

Raw AC-3.

ac4

Raw AC-4.

adts

ADTS AAC (Advanced Audio Coding).

adx

CRI ADX.

aiff

Audio IFF.

alaw

PCM A-law.

alp

LEGO Racers ALP.

alsa

ALSA audio output.

amr

3GPP AMR.

amv

AMV.

apm

Ubisoft Rayman 2 APM.

apng

Animated Portable Network Graphics.

aptx

Raw aptX (Audio Processing Technology for Bluetooth).

aptx_hd

Raw aptX HD (Audio Processing Technology for Bluetooth).

argo_asf

Argonaut Games ASF.

argo_cvg

Argonaut Games CVG.

asf

ASF (Advanced / Active Streaming Format).

asf_stream

ASF (Advanced / Active Streaming Format).

ass

SSA (SubStation Alpha) subtitle.

ast

AST (Audio Stream).

au

Sun AU.

avi

AVI (Audio Video Interleaved).

avif

AVIF.

avm2

SWF (ShockWave Flash) (AVM2).

avs2

Raw AVS2-P2/IEEE1857.4 video.

avs3

AVS3-P2/IEEE1857.10.

bit

G.729 BIT file format.

caca

Caca (color ASCII art) output device.

caf

Apple CAF (Core Audio Format).

cavsvideo

Raw Chinese AVS (Audio Video Standard) video.

chromaprint

Chromaprint.

codec2

codec2 .c2 muxer.

codec2raw

Raw codec2 muxer.

crc

CRC testing.

dash

DASH Muxer.

data

Raw data.

daud

D-Cinema audio.

dfpwm

Raw DFPWM1a.

dirac

Raw Dirac.

dnxhd

Raw DNxHD (SMPTE VC-3).

dts

Raw DTS.

dv

DV (Digital Video).

dvd

MPEG-2 PS (DVD VOB).

eac3

Raw E-AC-3.

evc

Raw EVC video.

f32be

PCM 32-bit floating-point big-endian.

f32le

PCM 32-bit floating-point little-endian.

f4v

F4V Adobe Flash Video.

f64be

PCM 64-bit floating-point big-endian.

f64le

PCM 64-bit floating-point little-endian.

fbdev

Linux framebuffer.

ffmetadata

FFmpeg metadata in text.

fifo

FIFO queue pseudo-muxer.

fifo_test

Fifo test muxer.

film_cpk

Sega FILM / CPK.

filmstrip

Adobe Filmstrip.

fits

Flexible Image Transport System.

flac

Raw FLAC.

flv

FLV (Flash Video).

framecrc

Framecrc testing.

framehash

Per-frame hash testing.

framemd5

Per-frame MD5 testing.

g722

Raw G.722.

g723_1

Raw G.723.1.

g726

Raw big-endian G.726 ("left-justified").

g726le

Raw little-endian G.726 ("right-justified").

gif

CompuServe Graphics Interchange Format (GIF).

gsm

Raw GSM.

gxf

GXF (General eXchange Format).

h261

Raw H.261.

h263

Raw H.263.

h264

Raw H.264 video.

hash

Hash testing.

hds

HDS Muxer.

hevc

Raw HEVC video.

hls

Apple HTTP Live Streaming.

ico

Microsoft Windows ICO.

ilbc

ILBC storage.

image2

image2 sequence.

image2pipe

Piped image2 sequence.

ipod

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

ircam

Berkeley/IRCAM/CARL Sound Format.

ismv

ISMV/ISMA (Smooth Streaming).

ivf

On2 IVF.

jacosub

JACOsub subtitle format.

kvag

Simon & Schuster Interactive VAG.

latm

LOAS/LATM.

lrc

LRC lyrics.

m4v

Raw MPEG-4 video.

matroska

Matroska.

md5

MD5 testing.

microdvd

MicroDVD subtitle format.

mjpeg

Raw MJPEG video.

mkvtimestamp_v2

Extract pts as timecode v2 format, as defined by mkvtoolnix.

mlp

Raw MLP.

mmf

Yamaha SMAF.

mov

QuickTime / MOV.

mp2

MP2 (MPEG audio layer 2).

mp3

MP3 (MPEG audio layer 3).

mp4

MP4 (MPEG-4 Part 14).

mpeg

MPEG-1 Systems / MPEG program stream.

mpeg1video

Raw MPEG-1 video.

mpeg2video

Raw MPEG-2 video.

mpegts

MPEG-TS (MPEG-2 Transport Stream).

mpjpeg

MIME multipart JPEG.

mulaw

PCM mu-law.

mxf

MXF (Material eXchange Format).

mxf_d10

MXF (Material eXchange Format) D-10 Mapping.

mxf_opatom

MXF (Material eXchange Format) Operational Pattern Atom.

null

Raw null video.

nut

NUT.

obu

AV1 low overhead OBU.

oga

Ogg Audio.

ogg

Ogg.

ogv

Ogg Video.

oma

Sony OpenMG audio.

opengl

OpenGL output.

opus

Ogg Opus.

oss

OSS (Open Sound System) playback.

psp

PSP MP4 (MPEG-4 Part 14).

pulse

Pulse audio output.

rawvideo

Raw video.

rm

RealMedia.

roq

Raw id RoQ.

rso

Lego Mindstorms RSO.

rtp

RTP output.

rtp_mpegts

RTP/mpegts output format.

rtsp

RTSP output.

s16be

PCM signed 16-bit big-endian.

s16le

PCM signed 16-bit little-endian.

s24be

PCM signed 24-bit big-endian.

s24le

PCM signed 24-bit little-endian.

s32be

PCM signed 32-bit big-endian.

s32le

PCM signed 32-bit little-endian.

s8

PCM signed 8-bit.

sap

SAP output.

sbc

Raw SBC.

scc

Scenarist Closed Captions.

segment

Segment.

smjpeg

Loki SDL MJPEG.

smoothstreaming

Smooth Streaming Muxer.

sox

SoX (Sound eXchange) native.

spdif

IEC 61937 (used on S/PDIF - IEC958).

spx

Ogg Speex.

srt

SubRip subtitle.

streamhash

Per-stream hash testing.

sup

Raw HDMV Presentation Graphic Stream subtitles.

svcd

MPEG-2 PS (SVCD).

swf

SWF (ShockWave Flash).

tee

Multiple muxer tee.

truehd

Raw TrueHD.

tta

TTA (True Audio).

ttml

TTML subtitle.

u16be

PCM unsigned 16-bit big-endian.

u16le

PCM unsigned 16-bit little-endian.

u24be

PCM unsigned 24-bit big-endian.

u24le

PCM unsigned 24-bit little-endian.

u32be

PCM unsigned 32-bit big-endian.

u32le

PCM unsigned 32-bit little-endian.

u8

PCM unsigned 8-bit.

uncodedframecrc

Uncoded framecrc testing.

vc1

Raw VC-1 video.

vc1test

VC-1 test bitstream.

vcd

MPEG-1 Systems / MPEG program stream (VCD).

vidc

PCM Archimedes VIDC.

vob

MPEG-2 PS (VOB).

voc

Creative Voice.

vvc

Raw H.266/VVC video.

w64

Sony Wave64.

wav

WAV / WAVE (Waveform Audio).

webm

WebM.

webm_chunk

WebM Chunk Muxer.

webm_dash_manifest

WebM DASH Manifest.

webp

WebP.

webvtt

WebVTT subtitle.

wsaud

Westwood Studios audio.

wtv

Windows Television (WTV).

wv

Raw WavPack.

xv

XV (XVideo) output device.

yuv4mpegpipe

YUV4MPEG pipe.

a64

a64 - video for Commodore 64.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

ac3

Raw AC-3.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

ac4

ac4(write_crc: bool | None = None) -> FFMpegMuxerOption

Raw AC-4.

Parameters:

Name Type Description Default
write_crc bool | None

enable checksum (default false)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

adts

adts(
    write_id3v2: bool | None = None,
    write_apetag: bool | None = None,
    write_mpeg2: bool | None = None,
) -> FFMpegMuxerOption

ADTS AAC (Advanced Audio Coding).

Parameters:

Name Type Description Default
write_id3v2 bool | None

Enable ID3v2 tag writing (default false)

None
write_apetag bool | None

Enable APE tag writing (default false)

None
write_mpeg2 bool | None

Set MPEG version to MPEG-2 (default false)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

adx

CRI ADX.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

aiff

aiff(
    write_id3v2: bool | None = None,
    id3v2_version: int | None = None,
) -> FFMpegMuxerOption

Audio IFF.

Parameters:

Name Type Description Default
write_id3v2 bool | None

Enable ID3 tags writing. (default false)

None
id3v2_version int | None

Select ID3v2 version to write. Currently 3 and 4 are supported. (from 3 to 4) (default 4)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

alaw

PCM A-law.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

alp

alp(
    type: int | None | Literal["auto", "tun", "pcm"] = None,
) -> FFMpegMuxerOption

LEGO Racers ALP.

Parameters:

Name Type Description Default
type int | None | Literal['auto', 'tun', 'pcm']

set file type (from 0 to 2) (default auto)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

alsa

ALSA audio output.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

amr

3GPP AMR.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

amv

AMV.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

apm

Ubisoft Rayman 2 APM.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

apng

apng(
    plays: int | None = None, final_delay: str | None = None
) -> FFMpegMuxerOption

Animated Portable Network Graphics.

Parameters:

Name Type Description Default
plays int | None

Number of times to play the output: 0 - infinite loop, 1 - no loop (from 0 to 65535) (default 1)

None
final_delay str | None

Force delay after the last frame (from 0 to 65535) (default 0/1)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

aptx

Raw aptX (Audio Processing Technology for Bluetooth).

Returns:

Type Description
FFMpegMuxerOption

the set codec options

aptx_hd

aptx_hd() -> FFMpegMuxerOption

Raw aptX HD (Audio Processing Technology for Bluetooth).

Returns:

Type Description
FFMpegMuxerOption

the set codec options

argo_asf

argo_asf(
    version_major: int | None = None,
    version_minor: int | None = None,
    name: str | None = None,
) -> FFMpegMuxerOption

Argonaut Games ASF.

Parameters:

Name Type Description Default
version_major int | None

override file major version (from 0 to 65535) (default 2)

None
version_minor int | None

override file minor version (from 0 to 65535) (default 1)

None
name str | None

embedded file name (max 8 characters)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

argo_cvg

argo_cvg(
    skip_rate_check: bool | None = None,
    loop: bool | None = None,
    reverb: bool | None = None,
) -> FFMpegMuxerOption

Argonaut Games CVG.

Parameters:

Name Type Description Default
skip_rate_check bool | None

skip sample rate check (default false)

None
loop bool | None

set loop flag (default false)

None
reverb bool | None

set reverb flag (default true)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

asf

asf(packet_size: int | None = None) -> FFMpegMuxerOption

ASF (Advanced / Active Streaming Format).

Parameters:

Name Type Description Default
packet_size int | None

Packet size (from 100 to 65536) (default 3200)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

asf_stream

asf_stream(
    packet_size: int | None = None,
) -> FFMpegMuxerOption

ASF (Advanced / Active Streaming Format).

Parameters:

Name Type Description Default
packet_size int | None

Packet size (from 100 to 65536) (default 3200)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

ass

ass(
    ignore_readorder: bool | None = None,
) -> FFMpegMuxerOption

SSA (SubStation Alpha) subtitle.

Parameters:

Name Type Description Default
ignore_readorder bool | None

write events immediately, even if they're out-of-order (default false)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

ast

ast(
    loopstart: int | None = None, loopend: int | None = None
) -> FFMpegMuxerOption

AST (Audio Stream).

Parameters:

Name Type Description Default
loopstart int | None

Loopstart position in milliseconds. (from -1 to INT_MAX) (default -1)

None
loopend int | None

Loopend position in milliseconds. (from 0 to INT_MAX) (default 0)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

au

Sun AU.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

avi

avi(
    reserve_index_space: int | None = None,
    write_channel_mask: bool | None = None,
    flipped_raw_rgb: bool | None = None,
) -> FFMpegMuxerOption

AVI (Audio Video Interleaved).

Parameters:

Name Type Description Default
reserve_index_space int | None

reserve space (in bytes) at the beginning of the file for each stream index (from 0 to INT_MAX) (default 0)

None
write_channel_mask bool | None

write channel mask into wave format header (default true)

None
flipped_raw_rgb bool | None

Raw RGB bitmaps are stored bottom-up (default false)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

avif

avif(
    movie_timescale: int | None = None,
    loop: int | None = None,
) -> FFMpegMuxerOption

AVIF.

Parameters:

Name Type Description Default
movie_timescale int | None

set movie timescale (from 1 to INT_MAX) (default 1000)

None
loop int | None

Number of times to loop animated AVIF: 0 - infinite loop (from 0 to INT_MAX) (default 0)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

avm2

SWF (ShockWave Flash) (AVM2).

Returns:

Type Description
FFMpegMuxerOption

the set codec options

avs2

Raw AVS2-P2/IEEE1857.4 video.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

avs3

AVS3-P2/IEEE1857.10.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

bit

G.729 BIT file format.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

caca

caca(
    window_size: str | None = None,
    window_title: str | None = None,
    driver: str | None = None,
    algorithm: str | None = None,
    antialias: str | None = None,
    charset: str | None = None,
    color: str | None = None,
    list_drivers: bool | None = None,
    list_dither: (
        str
        | None
        | Literal[
            "algorithms",
            "antialiases",
            "charsets",
            "colors",
        ]
    ) = None,
) -> FFMpegMuxerOption

Caca (color ASCII art) output device.

Parameters:

Name Type Description Default
window_size str | None

set window forced size

None
window_title str | None

set window title

None
driver str | None

set display driver

None
algorithm str | None

set dithering algorithm (default "default")

None
antialias str | None

set antialias method (default "default")

None
charset str | None

set charset used to render output (default "default")

None
color str | None

set color used to render output (default "default")

None
list_drivers bool | None

list available drivers (default false)

None
list_dither str | None | Literal['algorithms', 'antialiases', 'charsets', 'colors']

list available dither options

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

caf

Apple CAF (Core Audio Format).

Returns:

Type Description
FFMpegMuxerOption

the set codec options

cavsvideo

cavsvideo() -> FFMpegMuxerOption

Raw Chinese AVS (Audio Video Standard) video.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

chromaprint

chromaprint(
    silence_threshold: int | None = None,
    algorithm: int | None = None,
    fp_format: (
        int | None | Literal["raw", "compressed", "base64"]
    ) = None,
) -> FFMpegMuxerOption

Chromaprint.

Parameters:

Name Type Description Default
silence_threshold int | None

threshold for detecting silence (from -1 to 32767) (default -1)

None
algorithm int | None

version of the fingerprint algorithm (from 0 to INT_MAX) (default 1)

None
fp_format int | None | Literal['raw', 'compressed', 'base64']

fingerprint format to write (from 0 to 2) (default base64)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

codec2

codec2() -> FFMpegMuxerOption

codec2 .c2 muxer.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

codec2raw

codec2raw() -> FFMpegMuxerOption

Raw codec2 muxer.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

crc

CRC testing.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

dash

dash(
    adaptation_sets: str | None = None,
    window_size: int | None = None,
    extra_window_size: int | None = None,
    seg_duration: str | None = None,
    frag_duration: str | None = None,
    frag_type: (
        int
        | None
        | Literal[
            "none", "every_frame", "duration", "pframes"
        ]
    ) = None,
    remove_at_exit: bool | None = None,
    use_template: bool | None = None,
    use_timeline: bool | None = None,
    single_file: bool | None = None,
    single_file_name: str | None = None,
    init_seg_name: str | None = None,
    media_seg_name: str | None = None,
    utc_timing_url: str | None = None,
    method: str | None = None,
    http_user_agent: str | None = None,
    http_persistent: bool | None = None,
    hls_playlist: bool | None = None,
    hls_master_name: str | None = None,
    streaming: bool | None = None,
    timeout: str | None = None,
    index_correction: bool | None = None,
    format_options: str | None = None,
    global_sidx: bool | None = None,
    dash_segment_type: (
        int | None | Literal["auto", "mp4", "webm"]
    ) = None,
    ignore_io_errors: bool | None = None,
    lhls: bool | None = None,
    ldash: bool | None = None,
    master_m3u8_publish_rate: int | None = None,
    write_prft: bool | None = None,
    mpd_profile: str | None = None,
    http_opts: str | None = None,
    target_latency: str | None = None,
    min_playback_rate: str | None = None,
    max_playback_rate: str | None = None,
    update_period: int | None = None,
) -> FFMpegMuxerOption

DASH Muxer.

Parameters:

Name Type Description Default
adaptation_sets str | None

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

None
window_size int | None

number of segments kept in the manifest (from 0 to INT_MAX) (default 0)

None
extra_window_size int | None

number of segments kept outside of the manifest before removing from disk (from 0 to INT_MAX) (default 5)

None
seg_duration str | None

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

None
frag_duration str | None

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

None
frag_type int | None | Literal['none', 'every_frame', 'duration', 'pframes']

set type of interval for fragments (from 0 to 3) (default none)

None
remove_at_exit bool | None

remove all segments when finished (default false)

None
use_template bool | None

Use SegmentTemplate instead of SegmentList (default true)

None
use_timeline bool | None

Use SegmentTimeline in SegmentTemplate (default true)

None
single_file bool | None

Store all segments in one file, accessed using byte ranges (default false)

None
single_file_name str | None

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

None
init_seg_name str | None

DASH-templated name to used for the initialization segment (default "init-stream$RepresentationID$.$ext$")

None
media_seg_name str | None

DASH-templated name to used for the media segments (default "chunk-stream$RepresentationID$-$Number%05d$.$ext$")

None
utc_timing_url str | None

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

None
method str | None

set the HTTP method

None
http_user_agent str | None

override User-Agent field in HTTP header

None
http_persistent bool | None

Use persistent HTTP connections (default false)

None
hls_playlist bool | None

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

None
hls_master_name str | None

HLS master playlist name (default "master.m3u8")

None
streaming bool | None

Enable/Disable streaming mode of output. Each frame will be moof fragment (default false)

None
timeout str | None

set timeout for socket I/O operations (default -0.000001)

None
index_correction bool | None

Enable/Disable segment index correction logic (default false)

None
format_options str | None

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

None
global_sidx bool | None

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

None
dash_segment_type int | None | Literal['auto', 'mp4', 'webm']

set dash segment files type (from 0 to 2) (default auto)

None
ignore_io_errors bool | None

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

None
lhls bool | None

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

None
ldash bool | None

Enable Low-latency dash. Constrains the value of a few elements (default false)

None
master_m3u8_publish_rate int | None

Publish master playlist every after this many segment intervals (from 0 to UINT32_MAX) (default 0)

None
write_prft bool | None

Write producer reference time element (default auto)

None
mpd_profile str | None

Set profiles. Elements and values used in the manifest may be constrained by them (default dash)

None
http_opts str | None

HTTP protocol options

None
target_latency str | None

Set desired target latency for Low-latency dash (default 0)

None
min_playback_rate str | None

Set desired minimum playback rate (from 0.5 to 1.5) (default 1/1)

None
max_playback_rate str | None

Set desired maximum playback rate (from 0.5 to 1.5) (default 1/1)

None
update_period int | None

Set the mpd update interval (from 0 to I64_MAX) (default 0)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

data

Raw data.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

daud

D-Cinema audio.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

dfpwm

dfpwm() -> FFMpegMuxerOption

Raw DFPWM1a.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

dirac

dirac() -> FFMpegMuxerOption

Raw Dirac.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

dnxhd

dnxhd() -> FFMpegMuxerOption

Raw DNxHD (SMPTE VC-3).

Returns:

Type Description
FFMpegMuxerOption

the set codec options

dts

Raw DTS.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

dv

DV (Digital Video).

Returns:

Type Description
FFMpegMuxerOption

the set codec options

dvd

dvd(
    muxrate: int | None = None, preload: int | None = None
) -> FFMpegMuxerOption

MPEG-2 PS (DVD VOB).

Parameters:

Name Type Description Default
muxrate int | None

(from 0 to 1.67772e+09) (default 0)

None
preload int | None

Initial demux-decode delay in microseconds. (from 0 to INT_MAX) (default 500000)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

eac3

Raw E-AC-3.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

evc

Raw EVC video.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

f32be

f32be() -> FFMpegMuxerOption

PCM 32-bit floating-point big-endian.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

f32le

f32le() -> FFMpegMuxerOption

PCM 32-bit floating-point little-endian.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

f4v

f4v(
    movflags: str | None = None,
    moov_size: int | None = None,
    rtpflags: str | None = None,
    skip_iods: bool | None = None,
    iods_audio_profile: int | None = None,
    iods_video_profile: int | None = None,
    frag_duration: int | None = None,
    min_frag_duration: int | None = None,
    frag_size: int | None = None,
    ism_lookahead: int | None = None,
    video_track_timescale: int | None = None,
    brand: str | None = None,
    use_editlist: bool | None = None,
    fragment_index: int | None = None,
    mov_gamma: float | None = None,
    frag_interleave: int | None = None,
    encryption_scheme: str | None = None,
    encryption_key: str | None = None,
    encryption_kid: str | None = None,
    use_stream_ids_as_track_ids: bool | None = None,
    write_btrt: bool | None = None,
    write_tmcd: bool | None = None,
    write_prft: (
        int | None | Literal["wallclock", "pts"]
    ) = None,
    empty_hdlr_name: bool | None = None,
    movie_timescale: int | None = None,
) -> FFMpegMuxerOption

F4V Adobe Flash Video.

Parameters:

Name Type Description Default
movflags str | None

MOV muxer flags (default 0)

None
moov_size int | None

maximum moov size so it can be placed at the begin (from 0 to INT_MAX) (default 0)

None
rtpflags str | None

RTP muxer flags (default 0)

None
skip_iods bool | None

Skip writing iods atom. (default true)

None
iods_audio_profile int | None

iods audio profile atom. (from -1 to 255) (default -1)

None
iods_video_profile int | None

iods video profile atom. (from -1 to 255) (default -1)

None
frag_duration int | None

Maximum fragment duration (from 0 to INT_MAX) (default 0)

None
min_frag_duration int | None

Minimum fragment duration (from 0 to INT_MAX) (default 0)

None
frag_size int | None

Maximum fragment size (from 0 to INT_MAX) (default 0)

None
ism_lookahead int | None

Number of lookahead entries for ISM files (from 0 to 255) (default 0)

None
video_track_timescale int | None

set timescale of all video tracks (from 0 to INT_MAX) (default 0)

None
brand str | None

Override major brand

None
use_editlist bool | None

use edit list (default auto)

None
fragment_index int | None

Fragment number of the next fragment (from 1 to INT_MAX) (default 1)

None
mov_gamma float | None

gamma value for gama atom (from 0 to 10) (default 0)

None
frag_interleave int | None

Interleave samples within fragments (max number of consecutive samples, lower is tighter interleaving, but with more overhead) (from 0 to INT_MAX) (default 0)

None
encryption_scheme str | None

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

None
encryption_key str | None

The media encryption key (hex)

None
encryption_kid str | None

The media encryption key identifier (hex)

None
use_stream_ids_as_track_ids bool | None

use stream ids as track ids (default false)

None
write_btrt bool | None

force or disable writing btrt (default auto)

None
write_tmcd bool | None

force or disable writing tmcd (default auto)

None
write_prft int | None | Literal['wallclock', 'pts']

Write producer reference time box with specified time source (from 0 to 2) (default 0)

None
empty_hdlr_name bool | None

write zero-length name string in hdlr atoms within mdia and minf atoms (default false)

None
movie_timescale int | None

set movie timescale (from 1 to INT_MAX) (default 1000)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

f64be

f64be() -> FFMpegMuxerOption

PCM 64-bit floating-point big-endian.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

f64le

f64le() -> FFMpegMuxerOption

PCM 64-bit floating-point little-endian.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

fbdev

fbdev(
    xoffset: int | None = None, yoffset: int | None = None
) -> FFMpegMuxerOption

Linux framebuffer.

Parameters:

Name Type Description Default
xoffset int | None

set x coordinate of top left corner (from INT_MIN to INT_MAX) (default 0)

None
yoffset int | None

set y coordinate of top left corner (from INT_MIN to INT_MAX) (default 0)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

ffmetadata

ffmetadata() -> FFMpegMuxerOption

FFmpeg metadata in text.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

fifo

fifo(
    fifo_format: str | None = None,
    queue_size: int | None = None,
    format_opts: str | None = None,
    drop_pkts_on_overflow: bool | None = None,
    restart_with_keyframe: bool | None = None,
    attempt_recovery: bool | None = None,
    max_recovery_attempts: int | None = None,
    recovery_wait_time: str | None = None,
    recovery_wait_streamtime: bool | None = None,
    recover_any_error: bool | None = None,
    timeshift: str | None = None,
) -> FFMpegMuxerOption

FIFO queue pseudo-muxer.

Parameters:

Name Type Description Default
fifo_format str | None

Target muxer

None
queue_size int | None

Size of fifo queue (from 1 to INT_MAX) (default 60)

None
format_opts str | None

Options to be passed to underlying muxer

None
drop_pkts_on_overflow bool | None

Drop packets on fifo queue overflow not to block encoder (default false)

None
restart_with_keyframe bool | None

Wait for keyframe when restarting output (default false)

None
attempt_recovery bool | None

Attempt recovery in case of failure (default false)

None
max_recovery_attempts int | None

Maximal number of recovery attempts (from 0 to INT_MAX) (default 0)

None
recovery_wait_time str | None

Waiting time between recovery attempts (default 5)

None
recovery_wait_streamtime bool | None

Use stream time instead of real time while waiting for recovery (default false)

None
recover_any_error bool | None

Attempt recovery regardless of type of the error (default false)

None
timeshift str | None

Delay fifo output (default 0)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

fifo_test

fifo_test(
    write_header_ret: int | None = None,
    write_trailer_ret: int | None = None,
    print_deinit_summary: bool | None = None,
) -> FFMpegMuxerOption

Fifo test muxer.

Parameters:

Name Type Description Default
write_header_ret int | None

write_header() return value (from INT_MIN to INT_MAX) (default 0)

None
write_trailer_ret int | None

write_trailer() return value (from INT_MIN to INT_MAX) (default 0)

None
print_deinit_summary bool | None

print summary when deinitializing muxer (default true)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

film_cpk

film_cpk() -> FFMpegMuxerOption

Sega FILM / CPK.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

filmstrip

filmstrip() -> FFMpegMuxerOption

Adobe Filmstrip.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

fits

Flexible Image Transport System.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

flac

flac(write_header: bool | None = None) -> FFMpegMuxerOption

Raw FLAC.

Parameters:

Name Type Description Default
write_header bool | None

Write the file header (default true)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

flv

flv(flvflags: str | None = None) -> FFMpegMuxerOption

FLV (Flash Video).

Parameters:

Name Type Description Default
flvflags str | None

FLV muxer flags (default 0)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

framecrc

framecrc() -> FFMpegMuxerOption

Framecrc testing.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

framehash

framehash(
    hash: str | None = None,
    format_version: int | None = None,
) -> FFMpegMuxerOption

Per-frame hash testing.

Parameters:

Name Type Description Default
hash str | None

set hash to use (default "sha256")

None
format_version int | None

file format version (from 1 to 2) (default 2)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

framemd5

framemd5(
    hash: str | None = None,
    format_version: int | None = None,
) -> FFMpegMuxerOption

Per-frame MD5 testing.

Parameters:

Name Type Description Default
hash str | None

set hash to use (default "md5")

None
format_version int | None

file format version (from 1 to 2) (default 2)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

g722

Raw G.722.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

g723_1

g723_1() -> FFMpegMuxerOption

Raw G.723.1.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

g726

Raw big-endian G.726 ("left-justified").

Returns:

Type Description
FFMpegMuxerOption

the set codec options

g726le

g726le() -> FFMpegMuxerOption

Raw little-endian G.726 ("right-justified").

Returns:

Type Description
FFMpegMuxerOption

the set codec options

gif

gif(
    loop: int | None = None, final_delay: int | None = None
) -> FFMpegMuxerOption

CompuServe Graphics Interchange Format (GIF).

Parameters:

Name Type Description Default
loop int | None

Number of times to loop the output: -1 - no loop, 0 - infinite loop (from -1 to 65535) (default 0)

None
final_delay int | None

Force delay (in centiseconds) after the last frame (from -1 to 65535) (default -1)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

gsm

Raw GSM.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

gxf

GXF (General eXchange Format).

Returns:

Type Description
FFMpegMuxerOption

the set codec options

h261

Raw H.261.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

h263

Raw H.263.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

h264

Raw H.264 video.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

hash

hash(hash: str | None = None) -> FFMpegMuxerOption

Hash testing.

Parameters:

Name Type Description Default
hash str | None

set hash to use (default "sha256")

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

hds

hds(
    window_size: int | None = None,
    extra_window_size: int | None = None,
    min_frag_duration: int | None = None,
    remove_at_exit: bool | None = None,
) -> FFMpegMuxerOption

HDS Muxer.

Parameters:

Name Type Description Default
window_size int | None

number of fragments kept in the manifest (from 0 to INT_MAX) (default 0)

None
extra_window_size int | None

number of fragments kept outside of the manifest before removing from disk (from 0 to INT_MAX) (default 5)

None
min_frag_duration int | None

minimum fragment duration (in microseconds) (from 0 to INT_MAX) (default 10000000)

None
remove_at_exit bool | None

remove all fragments when finished (default false)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

hevc

Raw HEVC video.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

hls

hls(
    start_number: int | None = None,
    hls_time: str | None = None,
    hls_init_time: str | None = None,
    hls_list_size: int | None = None,
    hls_delete_threshold: int | None = None,
    hls_vtt_options: str | None = None,
    hls_allow_cache: int | None = None,
    hls_base_url: str | None = None,
    hls_segment_filename: str | None = None,
    hls_segment_options: str | None = None,
    hls_segment_size: int | None = None,
    hls_key_info_file: str | None = None,
    hls_enc: bool | None = None,
    hls_enc_key: str | None = None,
    hls_enc_key_url: str | None = None,
    hls_enc_iv: str | None = None,
    hls_subtitle_path: str | None = None,
    hls_segment_type: (
        int | None | Literal["mpegts", "fmp4"]
    ) = None,
    hls_fmp4_init_filename: str | None = None,
    hls_fmp4_init_resend: bool | None = None,
    hls_flags: str | None = None,
    strftime: bool | None = None,
    strftime_mkdir: bool | None = None,
    hls_playlist_type: (
        int | None | Literal["event", "vod"]
    ) = None,
    method: str | None = None,
    hls_start_number_source: (
        int
        | None
        | Literal[
            "generic", "epoch", "epoch_us", "datetime"
        ]
    ) = None,
    http_user_agent: str | None = None,
    var_stream_map: str | None = None,
    cc_stream_map: str | None = None,
    master_pl_name: str | None = None,
    master_pl_publish_rate: int | None = None,
    http_persistent: bool | None = None,
    timeout: str | None = None,
    ignore_io_errors: bool | None = None,
    headers: str | None = None,
) -> FFMpegMuxerOption

Apple HTTP Live Streaming.

Parameters:

Name Type Description Default
start_number int | None

set first number in the sequence (from 0 to I64_MAX) (default 0)

None
hls_time str | None

set segment length (default 2)

None
hls_init_time str | None

set segment length at init list (default 0)

None
hls_list_size int | None

set maximum number of playlist entries (from 0 to INT_MAX) (default 5)

None
hls_delete_threshold int | None

set number of unreferenced segments to keep before deleting (from 1 to INT_MAX) (default 1)

None
hls_vtt_options str | None

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

None
hls_allow_cache int | None

explicitly set whether the client MAY (1) or MUST NOT (0) cache media segments (from INT_MIN to INT_MAX) (default -1)

None
hls_base_url str | None

url to prepend to each playlist entry

None
hls_segment_filename str | None

filename template for segment files

None
hls_segment_options str | None

set segments files format options of hls

None
hls_segment_size int | None

maximum size per segment file, (in bytes) (from 0 to INT_MAX) (default 0)

None
hls_key_info_file str | None

file with key URI and key file path

None
hls_enc bool | None

enable AES128 encryption support (default false)

None
hls_enc_key str | None

hex-coded 16 byte key to encrypt the segments

None
hls_enc_key_url str | None

url to access the key to decrypt the segments

None
hls_enc_iv str | None

hex-coded 16 byte initialization vector

None
hls_subtitle_path str | None

set path of hls subtitles

None
hls_segment_type int | None | Literal['mpegts', 'fmp4']

set hls segment files type (from 0 to 1) (default mpegts)

None
hls_fmp4_init_filename str | None

set fragment mp4 file init filename (default "init.mp4")

None
hls_fmp4_init_resend bool | None

resend fragment mp4 init file after refresh m3u8 every time (default false)

None
hls_flags str | None

set flags affecting HLS playlist and media file generation (default 0)

None
strftime bool | None

set filename expansion with strftime at segment creation (default false)

None
strftime_mkdir bool | None

create last directory component in strftime-generated filename (default false)

None
hls_playlist_type int | None | Literal['event', 'vod']

set the HLS playlist type (from 0 to 2) (default 0)

None
method str | None

set the HTTP method(default: PUT)

None
hls_start_number_source int | None | Literal['generic', 'epoch', 'epoch_us', 'datetime']

set source of first number in sequence (from 0 to 3) (default generic)

None
http_user_agent str | None

override User-Agent field in HTTP header

None
var_stream_map str | None

Variant stream map string

None
cc_stream_map str | None

Closed captions stream map string

None
master_pl_name str | None

Create HLS master playlist with this name

None
master_pl_publish_rate int | None

Publish master play list every after this many segment intervals (from 0 to UINT32_MAX) (default 0)

None
http_persistent bool | None

Use persistent HTTP connections (default false)

None
timeout str | None

set timeout for socket I/O operations (default -0.000001)

None
ignore_io_errors bool | None

Ignore IO errors for stable long-duration runs with network output (default false)

None
headers str | None

set custom HTTP headers, can override built in default headers

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

ico

Microsoft Windows ICO.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

ilbc

ILBC storage.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

image2

image2(
    update: bool | None = None,
    start_number: int | None = None,
    strftime: bool | None = None,
    frame_pts: bool | None = None,
    atomic_writing: bool | None = None,
    protocol_opts: str | None = None,
) -> FFMpegMuxerOption

image2 sequence.

Parameters:

Name Type Description Default
update bool | None

continuously overwrite one file (default false)

None
start_number int | None

set first number in the sequence (from 0 to INT_MAX) (default 1)

None
strftime bool | None

use strftime for filename (default false)

None
frame_pts bool | None

use current frame pts for filename (default false)

None
atomic_writing bool | None

write files atomically (using temporary files and renames) (default false)

None
protocol_opts str | None

specify protocol options for the opened files

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

image2pipe

image2pipe() -> FFMpegMuxerOption

Piped image2 sequence.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

ipod

ipod(
    movflags: str | None = None,
    moov_size: int | None = None,
    rtpflags: str | None = None,
    skip_iods: bool | None = None,
    iods_audio_profile: int | None = None,
    iods_video_profile: int | None = None,
    frag_duration: int | None = None,
    min_frag_duration: int | None = None,
    frag_size: int | None = None,
    ism_lookahead: int | None = None,
    video_track_timescale: int | None = None,
    brand: str | None = None,
    use_editlist: bool | None = None,
    fragment_index: int | None = None,
    mov_gamma: float | None = None,
    frag_interleave: int | None = None,
    encryption_scheme: str | None = None,
    encryption_key: str | None = None,
    encryption_kid: str | None = None,
    use_stream_ids_as_track_ids: bool | None = None,
    write_btrt: bool | None = None,
    write_tmcd: bool | None = None,
    write_prft: (
        int | None | Literal["wallclock", "pts"]
    ) = None,
    empty_hdlr_name: bool | None = None,
    movie_timescale: int | None = None,
) -> FFMpegMuxerOption

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

Parameters:

Name Type Description Default
movflags str | None

MOV muxer flags (default 0)

None
moov_size int | None

maximum moov size so it can be placed at the begin (from 0 to INT_MAX) (default 0)

None
rtpflags str | None

RTP muxer flags (default 0)

None
skip_iods bool | None

Skip writing iods atom. (default true)

None
iods_audio_profile int | None

iods audio profile atom. (from -1 to 255) (default -1)

None
iods_video_profile int | None

iods video profile atom. (from -1 to 255) (default -1)

None
frag_duration int | None

Maximum fragment duration (from 0 to INT_MAX) (default 0)

None
min_frag_duration int | None

Minimum fragment duration (from 0 to INT_MAX) (default 0)

None
frag_size int | None

Maximum fragment size (from 0 to INT_MAX) (default 0)

None
ism_lookahead int | None

Number of lookahead entries for ISM files (from 0 to 255) (default 0)

None
video_track_timescale int | None

set timescale of all video tracks (from 0 to INT_MAX) (default 0)

None
brand str | None

Override major brand

None
use_editlist bool | None

use edit list (default auto)

None
fragment_index int | None

Fragment number of the next fragment (from 1 to INT_MAX) (default 1)

None
mov_gamma float | None

gamma value for gama atom (from 0 to 10) (default 0)

None
frag_interleave int | None

Interleave samples within fragments (max number of consecutive samples, lower is tighter interleaving, but with more overhead) (from 0 to INT_MAX) (default 0)

None
encryption_scheme str | None

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

None
encryption_key str | None

The media encryption key (hex)

None
encryption_kid str | None

The media encryption key identifier (hex)

None
use_stream_ids_as_track_ids bool | None

use stream ids as track ids (default false)

None
write_btrt bool | None

force or disable writing btrt (default auto)

None
write_tmcd bool | None

force or disable writing tmcd (default auto)

None
write_prft int | None | Literal['wallclock', 'pts']

Write producer reference time box with specified time source (from 0 to 2) (default 0)

None
empty_hdlr_name bool | None

write zero-length name string in hdlr atoms within mdia and minf atoms (default false)

None
movie_timescale int | None

set movie timescale (from 1 to INT_MAX) (default 1000)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

ircam

ircam() -> FFMpegMuxerOption

Berkeley/IRCAM/CARL Sound Format.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

ismv

ismv(
    movflags: str | None = None,
    moov_size: int | None = None,
    rtpflags: str | None = None,
    skip_iods: bool | None = None,
    iods_audio_profile: int | None = None,
    iods_video_profile: int | None = None,
    frag_duration: int | None = None,
    min_frag_duration: int | None = None,
    frag_size: int | None = None,
    ism_lookahead: int | None = None,
    video_track_timescale: int | None = None,
    brand: str | None = None,
    use_editlist: bool | None = None,
    fragment_index: int | None = None,
    mov_gamma: float | None = None,
    frag_interleave: int | None = None,
    encryption_scheme: str | None = None,
    encryption_key: str | None = None,
    encryption_kid: str | None = None,
    use_stream_ids_as_track_ids: bool | None = None,
    write_btrt: bool | None = None,
    write_tmcd: bool | None = None,
    write_prft: (
        int | None | Literal["wallclock", "pts"]
    ) = None,
    empty_hdlr_name: bool | None = None,
    movie_timescale: int | None = None,
) -> FFMpegMuxerOption

ISMV/ISMA (Smooth Streaming).

Parameters:

Name Type Description Default
movflags str | None

MOV muxer flags (default 0)

None
moov_size int | None

maximum moov size so it can be placed at the begin (from 0 to INT_MAX) (default 0)

None
rtpflags str | None

RTP muxer flags (default 0)

None
skip_iods bool | None

Skip writing iods atom. (default true)

None
iods_audio_profile int | None

iods audio profile atom. (from -1 to 255) (default -1)

None
iods_video_profile int | None

iods video profile atom. (from -1 to 255) (default -1)

None
frag_duration int | None

Maximum fragment duration (from 0 to INT_MAX) (default 0)

None
min_frag_duration int | None

Minimum fragment duration (from 0 to INT_MAX) (default 0)

None
frag_size int | None

Maximum fragment size (from 0 to INT_MAX) (default 0)

None
ism_lookahead int | None

Number of lookahead entries for ISM files (from 0 to 255) (default 0)

None
video_track_timescale int | None

set timescale of all video tracks (from 0 to INT_MAX) (default 0)

None
brand str | None

Override major brand

None
use_editlist bool | None

use edit list (default auto)

None
fragment_index int | None

Fragment number of the next fragment (from 1 to INT_MAX) (default 1)

None
mov_gamma float | None

gamma value for gama atom (from 0 to 10) (default 0)

None
frag_interleave int | None

Interleave samples within fragments (max number of consecutive samples, lower is tighter interleaving, but with more overhead) (from 0 to INT_MAX) (default 0)

None
encryption_scheme str | None

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

None
encryption_key str | None

The media encryption key (hex)

None
encryption_kid str | None

The media encryption key identifier (hex)

None
use_stream_ids_as_track_ids bool | None

use stream ids as track ids (default false)

None
write_btrt bool | None

force or disable writing btrt (default auto)

None
write_tmcd bool | None

force or disable writing tmcd (default auto)

None
write_prft int | None | Literal['wallclock', 'pts']

Write producer reference time box with specified time source (from 0 to 2) (default 0)

None
empty_hdlr_name bool | None

write zero-length name string in hdlr atoms within mdia and minf atoms (default false)

None
movie_timescale int | None

set movie timescale (from 1 to INT_MAX) (default 1000)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

ivf

On2 IVF.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

jacosub

jacosub() -> FFMpegMuxerOption

JACOsub subtitle format.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

kvag

Simon & Schuster Interactive VAG.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

latm

latm(smc_interval: int | None = None) -> FFMpegMuxerOption

LOAS/LATM.

Parameters:

Name Type Description Default
smc_interval int | None

StreamMuxConfig interval. (from 1 to 65535) (default 20)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

lrc

LRC lyrics.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

m4v

Raw MPEG-4 video.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

matroska

matroska(
    reserve_index_space: int | None = None,
    cues_to_front: bool | None = None,
    cluster_size_limit: int | None = None,
    cluster_time_limit: int | None = None,
    dash: bool | None = None,
    dash_track_number: int | None = None,
    live: bool | None = None,
    allow_raw_vfw: bool | None = None,
    flipped_raw_rgb: bool | None = None,
    write_crc32: bool | None = None,
    default_mode: (
        int
        | None
        | Literal["infer", "infer_no_subs", "passthrough"]
    ) = None,
) -> FFMpegMuxerOption

Matroska.

Parameters:

Name Type Description Default
reserve_index_space int | None

Reserve a given amount of space (in bytes) at the beginning of the file for the index (cues). (from 0 to INT_MAX) (default 0)

None
cues_to_front bool | None

Move Cues (the index) to the front by shifting data if necessary (default false)

None
cluster_size_limit int | None

Store at most the provided amount of bytes in a cluster. (from -1 to INT_MAX) (default -1)

None
cluster_time_limit int | None

Store at most the provided number of milliseconds in a cluster. (from -1 to I64_MAX) (default -1)

None
dash bool | None

Create a WebM file conforming to WebM DASH specification (default false)

None
dash_track_number int | None

Track number for the DASH stream (from 1 to INT_MAX) (default 1)

None
live bool | None

Write files assuming it is a live stream. (default false)

None
allow_raw_vfw bool | None

allow RAW VFW mode (default false)

None
flipped_raw_rgb bool | None

Raw RGB bitmaps in VFW mode are stored bottom-up (default false)

None
write_crc32 bool | None

write a CRC32 element inside every Level 1 element (default true)

None
default_mode int | None | Literal['infer', 'infer_no_subs', 'passthrough']

Controls how a track's FlagDefault is inferred (from 0 to 2) (default passthrough)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

md5

md5(hash: str | None = None) -> FFMpegMuxerOption

MD5 testing.

Parameters:

Name Type Description Default
hash str | None

set hash to use (default "md5")

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

microdvd

microdvd() -> FFMpegMuxerOption

MicroDVD subtitle format.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

mjpeg

mjpeg() -> FFMpegMuxerOption

Raw MJPEG video.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

mkvtimestamp_v2

mkvtimestamp_v2() -> FFMpegMuxerOption

Extract pts as timecode v2 format, as defined by mkvtoolnix.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

mlp

Raw MLP.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

mmf

Yamaha SMAF.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

mov

mov(
    movflags: str | None = None,
    moov_size: int | None = None,
    rtpflags: str | None = None,
    skip_iods: bool | None = None,
    iods_audio_profile: int | None = None,
    iods_video_profile: int | None = None,
    frag_duration: int | None = None,
    min_frag_duration: int | None = None,
    frag_size: int | None = None,
    ism_lookahead: int | None = None,
    video_track_timescale: int | None = None,
    brand: str | None = None,
    use_editlist: bool | None = None,
    fragment_index: int | None = None,
    mov_gamma: float | None = None,
    frag_interleave: int | None = None,
    encryption_scheme: str | None = None,
    encryption_key: str | None = None,
    encryption_kid: str | None = None,
    use_stream_ids_as_track_ids: bool | None = None,
    write_btrt: bool | None = None,
    write_tmcd: bool | None = None,
    write_prft: (
        int | None | Literal["wallclock", "pts"]
    ) = None,
    empty_hdlr_name: bool | None = None,
    movie_timescale: int | None = None,
) -> FFMpegMuxerOption

QuickTime / MOV.

Parameters:

Name Type Description Default
movflags str | None

MOV muxer flags (default 0)

None
moov_size int | None

maximum moov size so it can be placed at the begin (from 0 to INT_MAX) (default 0)

None
rtpflags str | None

RTP muxer flags (default 0)

None
skip_iods bool | None

Skip writing iods atom. (default true)

None
iods_audio_profile int | None

iods audio profile atom. (from -1 to 255) (default -1)

None
iods_video_profile int | None

iods video profile atom. (from -1 to 255) (default -1)

None
frag_duration int | None

Maximum fragment duration (from 0 to INT_MAX) (default 0)

None
min_frag_duration int | None

Minimum fragment duration (from 0 to INT_MAX) (default 0)

None
frag_size int | None

Maximum fragment size (from 0 to INT_MAX) (default 0)

None
ism_lookahead int | None

Number of lookahead entries for ISM files (from 0 to 255) (default 0)

None
video_track_timescale int | None

set timescale of all video tracks (from 0 to INT_MAX) (default 0)

None
brand str | None

Override major brand

None
use_editlist bool | None

use edit list (default auto)

None
fragment_index int | None

Fragment number of the next fragment (from 1 to INT_MAX) (default 1)

None
mov_gamma float | None

gamma value for gama atom (from 0 to 10) (default 0)

None
frag_interleave int | None

Interleave samples within fragments (max number of consecutive samples, lower is tighter interleaving, but with more overhead) (from 0 to INT_MAX) (default 0)

None
encryption_scheme str | None

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

None
encryption_key str | None

The media encryption key (hex)

None
encryption_kid str | None

The media encryption key identifier (hex)

None
use_stream_ids_as_track_ids bool | None

use stream ids as track ids (default false)

None
write_btrt bool | None

force or disable writing btrt (default auto)

None
write_tmcd bool | None

force or disable writing tmcd (default auto)

None
write_prft int | None | Literal['wallclock', 'pts']

Write producer reference time box with specified time source (from 0 to 2) (default 0)

None
empty_hdlr_name bool | None

write zero-length name string in hdlr atoms within mdia and minf atoms (default false)

None
movie_timescale int | None

set movie timescale (from 1 to INT_MAX) (default 1000)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

mp2

MP2 (MPEG audio layer 2).

Returns:

Type Description
FFMpegMuxerOption

the set codec options

mp3

mp3(
    id3v2_version: int | None = None,
    write_id3v1: bool | None = None,
    write_xing: bool | None = None,
) -> FFMpegMuxerOption

MP3 (MPEG audio layer 3).

Parameters:

Name Type Description Default
id3v2_version int | None

Select ID3v2 version to write. Currently 3 and 4 are supported. (from 0 to 4) (default 4)

None
write_id3v1 bool | None

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

None
write_xing bool | None

Write the Xing header containing file duration. (default true)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

mp4

mp4(
    movflags: str | None = None,
    moov_size: int | None = None,
    rtpflags: str | None = None,
    skip_iods: bool | None = None,
    iods_audio_profile: int | None = None,
    iods_video_profile: int | None = None,
    frag_duration: int | None = None,
    min_frag_duration: int | None = None,
    frag_size: int | None = None,
    ism_lookahead: int | None = None,
    video_track_timescale: int | None = None,
    brand: str | None = None,
    use_editlist: bool | None = None,
    fragment_index: int | None = None,
    mov_gamma: float | None = None,
    frag_interleave: int | None = None,
    encryption_scheme: str | None = None,
    encryption_key: str | None = None,
    encryption_kid: str | None = None,
    use_stream_ids_as_track_ids: bool | None = None,
    write_btrt: bool | None = None,
    write_tmcd: bool | None = None,
    write_prft: (
        int | None | Literal["wallclock", "pts"]
    ) = None,
    empty_hdlr_name: bool | None = None,
    movie_timescale: int | None = None,
) -> FFMpegMuxerOption

MP4 (MPEG-4 Part 14).

Parameters:

Name Type Description Default
movflags str | None

MOV muxer flags (default 0)

None
moov_size int | None

maximum moov size so it can be placed at the begin (from 0 to INT_MAX) (default 0)

None
rtpflags str | None

RTP muxer flags (default 0)

None
skip_iods bool | None

Skip writing iods atom. (default true)

None
iods_audio_profile int | None

iods audio profile atom. (from -1 to 255) (default -1)

None
iods_video_profile int | None

iods video profile atom. (from -1 to 255) (default -1)

None
frag_duration int | None

Maximum fragment duration (from 0 to INT_MAX) (default 0)

None
min_frag_duration int | None

Minimum fragment duration (from 0 to INT_MAX) (default 0)

None
frag_size int | None

Maximum fragment size (from 0 to INT_MAX) (default 0)

None
ism_lookahead int | None

Number of lookahead entries for ISM files (from 0 to 255) (default 0)

None
video_track_timescale int | None

set timescale of all video tracks (from 0 to INT_MAX) (default 0)

None
brand str | None

Override major brand

None
use_editlist bool | None

use edit list (default auto)

None
fragment_index int | None

Fragment number of the next fragment (from 1 to INT_MAX) (default 1)

None
mov_gamma float | None

gamma value for gama atom (from 0 to 10) (default 0)

None
frag_interleave int | None

Interleave samples within fragments (max number of consecutive samples, lower is tighter interleaving, but with more overhead) (from 0 to INT_MAX) (default 0)

None
encryption_scheme str | None

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

None
encryption_key str | None

The media encryption key (hex)

None
encryption_kid str | None

The media encryption key identifier (hex)

None
use_stream_ids_as_track_ids bool | None

use stream ids as track ids (default false)

None
write_btrt bool | None

force or disable writing btrt (default auto)

None
write_tmcd bool | None

force or disable writing tmcd (default auto)

None
write_prft int | None | Literal['wallclock', 'pts']

Write producer reference time box with specified time source (from 0 to 2) (default 0)

None
empty_hdlr_name bool | None

write zero-length name string in hdlr atoms within mdia and minf atoms (default false)

None
movie_timescale int | None

set movie timescale (from 1 to INT_MAX) (default 1000)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

mpeg

mpeg(
    muxrate: int | None = None, preload: int | None = None
) -> FFMpegMuxerOption

MPEG-1 Systems / MPEG program stream.

Parameters:

Name Type Description Default
muxrate int | None

(from 0 to 1.67772e+09) (default 0)

None
preload int | None

Initial demux-decode delay in microseconds. (from 0 to INT_MAX) (default 500000)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

mpeg1video

mpeg1video() -> FFMpegMuxerOption

Raw MPEG-1 video.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

mpeg2video

mpeg2video() -> FFMpegMuxerOption

Raw MPEG-2 video.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

mpegts

mpegts(
    mpegts_transport_stream_id: int | None = None,
    mpegts_original_network_id: int | None = None,
    mpegts_service_id: int | None = None,
    mpegts_service_type: (
        int
        | None
        | Literal[
            "digital_tv",
            "digital_radio",
            "teletext",
            "advanced_codec_digital_radio",
            "mpeg2_digital_hdtv",
            "advanced_codec_digital_sdtv",
            "advanced_codec_digital_hdtv",
            "hevc_digital_hdtv",
        ]
    ) = None,
    mpegts_pmt_start_pid: int | None = None,
    mpegts_start_pid: int | None = None,
    mpegts_m2ts_mode: bool | None = None,
    muxrate: int | None = None,
    pes_payload_size: int | None = None,
    mpegts_flags: str | None = None,
    mpegts_copyts: bool | None = None,
    tables_version: int | None = None,
    omit_video_pes_length: bool | None = None,
    pcr_period: int | None = None,
    pat_period: str | None = None,
    sdt_period: str | None = None,
    nit_period: str | None = None,
) -> FFMpegMuxerOption

MPEG-TS (MPEG-2 Transport Stream).

Parameters:

Name Type Description Default
mpegts_transport_stream_id int | None

Set transport_stream_id field. (from 1 to 65535) (default 1)

None
mpegts_original_network_id int | None

Set original_network_id field. (from 1 to 65535) (default 65281)

None
mpegts_service_id int | None

Set service_id field. (from 1 to 65535) (default 1)

None
mpegts_service_type int | None | Literal['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. (from 1 to 255) (default digital_tv)

None
mpegts_pmt_start_pid int | None

Set the first pid of the PMT. (from 32 to 8186) (default 4096)

None
mpegts_start_pid int | None

Set the first pid. (from 32 to 8186) (default 256)

None
mpegts_m2ts_mode bool | None

Enable m2ts mode. (default auto)

None
muxrate int | None

(from 0 to INT_MAX) (default 1)

None
pes_payload_size int | None

Minimum PES packet payload in bytes (from 0 to INT_MAX) (default 2930)

None
mpegts_flags str | None

MPEG-TS muxing flags (default 0)

None
mpegts_copyts bool | None

don't offset dts/pts (default auto)

None
tables_version int | None

set PAT, PMT, SDT and NIT version (from 0 to 31) (default 0)

None
omit_video_pes_length bool | None

Omit the PES packet length for video packets (default true)

None
pcr_period int | None

PCR retransmission time in milliseconds (from -1 to INT_MAX) (default -1)

None
pat_period str | None

PAT/PMT retransmission time limit in seconds (default 0.1)

None
sdt_period str | None

SDT retransmission time limit in seconds (default 0.5)

None
nit_period str | None

NIT retransmission time limit in seconds (default 0.5)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

mpjpeg

mpjpeg(
    boundary_tag: str | None = None,
) -> FFMpegMuxerOption

MIME multipart JPEG.

Parameters:

Name Type Description Default
boundary_tag str | None

Boundary tag (default "ffmpeg")

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

mulaw

mulaw() -> FFMpegMuxerOption

PCM mu-law.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

mxf

mxf(
    signal_standard: (
        int
        | None
        | Literal[
            "bt601",
            "bt1358",
            "smpte347m",
            "smpte274m",
            "smpte296m",
            "smpte349m",
            "smpte428",
        ]
    ) = None,
    store_user_comments: bool | None = None,
) -> FFMpegMuxerOption

MXF (Material eXchange Format).

Parameters:

Name Type Description Default
signal_standard int | None | Literal['bt601', 'bt1358', 'smpte347m', 'smpte274m', 'smpte296m', 'smpte349m', 'smpte428']

Force/set Signal Standard (from -1 to 7) (default -1)

None
store_user_comments bool | None

(default true)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

mxf_d10

mxf_d10(
    d10_channelcount: int | None = None,
    signal_standard: (
        int
        | None
        | Literal[
            "bt601",
            "bt1358",
            "smpte347m",
            "smpte274m",
            "smpte296m",
            "smpte349m",
            "smpte428",
        ]
    ) = None,
    store_user_comments: bool | None = None,
) -> FFMpegMuxerOption

MXF (Material eXchange Format) D-10 Mapping.

Parameters:

Name Type Description Default
d10_channelcount int | None

Force/set channelcount in generic sound essence descriptor (from -1 to 8) (default -1)

None
signal_standard int | None | Literal['bt601', 'bt1358', 'smpte347m', 'smpte274m', 'smpte296m', 'smpte349m', 'smpte428']

Force/set Signal Standard (from -1 to 7) (default -1)

None
store_user_comments bool | None

(default false)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

mxf_opatom

mxf_opatom(
    mxf_audio_edit_rate: str | None = None,
    signal_standard: (
        int
        | None
        | Literal[
            "bt601",
            "bt1358",
            "smpte347m",
            "smpte274m",
            "smpte296m",
            "smpte349m",
            "smpte428",
        ]
    ) = None,
    store_user_comments: bool | None = None,
) -> FFMpegMuxerOption

MXF (Material eXchange Format) Operational Pattern Atom.

Parameters:

Name Type Description Default
mxf_audio_edit_rate str | None

Audio edit rate for timecode (from 0 to INT_MAX) (default 25/1)

None
signal_standard int | None | Literal['bt601', 'bt1358', 'smpte347m', 'smpte274m', 'smpte296m', 'smpte349m', 'smpte428']

Force/set Signal Standard (from -1 to 7) (default -1)

None
store_user_comments bool | None

(default true)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

null

Raw null video.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

nut

nut(
    syncpoints: str | None = None,
    write_index: bool | None = None,
) -> FFMpegMuxerOption

NUT.

Parameters:

Name Type Description Default
syncpoints str | None

NUT syncpoint behaviour (default 0)

None
write_index bool | None

Write index (default true)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

obu

AV1 low overhead OBU.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

oga

oga(
    serial_offset: int | None = None,
    oggpagesize: int | None = None,
    pagesize: int | None = None,
    page_duration: int | None = None,
) -> FFMpegMuxerOption

Ogg Audio.

Parameters:

Name Type Description Default
serial_offset int | None

serial number offset (from 0 to INT_MAX) (default 0)

None
oggpagesize int | None

Set preferred Ogg page size. (from 0 to 65025) (default 0)

None
pagesize int | None

preferred page size in bytes (deprecated) (from 0 to 65025) (default 0)

None
page_duration int | None

preferred page duration, in microseconds (from 0 to I64_MAX) (default 1000000)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

ogg

ogg(
    serial_offset: int | None = None,
    oggpagesize: int | None = None,
    pagesize: int | None = None,
    page_duration: int | None = None,
) -> FFMpegMuxerOption

Ogg.

Parameters:

Name Type Description Default
serial_offset int | None

serial number offset (from 0 to INT_MAX) (default 0)

None
oggpagesize int | None

Set preferred Ogg page size. (from 0 to 65025) (default 0)

None
pagesize int | None

preferred page size in bytes (deprecated) (from 0 to 65025) (default 0)

None
page_duration int | None

preferred page duration, in microseconds (from 0 to I64_MAX) (default 1000000)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

ogv

ogv(
    serial_offset: int | None = None,
    oggpagesize: int | None = None,
    pagesize: int | None = None,
    page_duration: int | None = None,
) -> FFMpegMuxerOption

Ogg Video.

Parameters:

Name Type Description Default
serial_offset int | None

serial number offset (from 0 to INT_MAX) (default 0)

None
oggpagesize int | None

Set preferred Ogg page size. (from 0 to 65025) (default 0)

None
pagesize int | None

preferred page size in bytes (deprecated) (from 0 to 65025) (default 0)

None
page_duration int | None

preferred page duration, in microseconds (from 0 to I64_MAX) (default 1000000)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

oma

Sony OpenMG audio.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

opengl

opengl(
    background: str | None = None,
    no_window: int | None = None,
    window_title: str | None = None,
    window_size: str | None = None,
) -> FFMpegMuxerOption

OpenGL output.

Parameters:

Name Type Description Default
background str | None

set background color (default "black")

None
no_window int | None

disable default window (from INT_MIN to INT_MAX) (default 0)

None
window_title str | None

set window title

None
window_size str | None

set window size

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

opus

opus(
    serial_offset: int | None = None,
    oggpagesize: int | None = None,
    pagesize: int | None = None,
    page_duration: int | None = None,
) -> FFMpegMuxerOption

Ogg Opus.

Parameters:

Name Type Description Default
serial_offset int | None

serial number offset (from 0 to INT_MAX) (default 0)

None
oggpagesize int | None

Set preferred Ogg page size. (from 0 to 65025) (default 0)

None
pagesize int | None

preferred page size in bytes (deprecated) (from 0 to 65025) (default 0)

None
page_duration int | None

preferred page duration, in microseconds (from 0 to I64_MAX) (default 1000000)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

oss

OSS (Open Sound System) playback.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

psp

psp(
    movflags: str | None = None,
    moov_size: int | None = None,
    rtpflags: str | None = None,
    skip_iods: bool | None = None,
    iods_audio_profile: int | None = None,
    iods_video_profile: int | None = None,
    frag_duration: int | None = None,
    min_frag_duration: int | None = None,
    frag_size: int | None = None,
    ism_lookahead: int | None = None,
    video_track_timescale: int | None = None,
    brand: str | None = None,
    use_editlist: bool | None = None,
    fragment_index: int | None = None,
    mov_gamma: float | None = None,
    frag_interleave: int | None = None,
    encryption_scheme: str | None = None,
    encryption_key: str | None = None,
    encryption_kid: str | None = None,
    use_stream_ids_as_track_ids: bool | None = None,
    write_btrt: bool | None = None,
    write_tmcd: bool | None = None,
    write_prft: (
        int | None | Literal["wallclock", "pts"]
    ) = None,
    empty_hdlr_name: bool | None = None,
    movie_timescale: int | None = None,
) -> FFMpegMuxerOption

PSP MP4 (MPEG-4 Part 14).

Parameters:

Name Type Description Default
movflags str | None

MOV muxer flags (default 0)

None
moov_size int | None

maximum moov size so it can be placed at the begin (from 0 to INT_MAX) (default 0)

None
rtpflags str | None

RTP muxer flags (default 0)

None
skip_iods bool | None

Skip writing iods atom. (default true)

None
iods_audio_profile int | None

iods audio profile atom. (from -1 to 255) (default -1)

None
iods_video_profile int | None

iods video profile atom. (from -1 to 255) (default -1)

None
frag_duration int | None

Maximum fragment duration (from 0 to INT_MAX) (default 0)

None
min_frag_duration int | None

Minimum fragment duration (from 0 to INT_MAX) (default 0)

None
frag_size int | None

Maximum fragment size (from 0 to INT_MAX) (default 0)

None
ism_lookahead int | None

Number of lookahead entries for ISM files (from 0 to 255) (default 0)

None
video_track_timescale int | None

set timescale of all video tracks (from 0 to INT_MAX) (default 0)

None
brand str | None

Override major brand

None
use_editlist bool | None

use edit list (default auto)

None
fragment_index int | None

Fragment number of the next fragment (from 1 to INT_MAX) (default 1)

None
mov_gamma float | None

gamma value for gama atom (from 0 to 10) (default 0)

None
frag_interleave int | None

Interleave samples within fragments (max number of consecutive samples, lower is tighter interleaving, but with more overhead) (from 0 to INT_MAX) (default 0)

None
encryption_scheme str | None

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

None
encryption_key str | None

The media encryption key (hex)

None
encryption_kid str | None

The media encryption key identifier (hex)

None
use_stream_ids_as_track_ids bool | None

use stream ids as track ids (default false)

None
write_btrt bool | None

force or disable writing btrt (default auto)

None
write_tmcd bool | None

force or disable writing tmcd (default auto)

None
write_prft int | None | Literal['wallclock', 'pts']

Write producer reference time box with specified time source (from 0 to 2) (default 0)

None
empty_hdlr_name bool | None

write zero-length name string in hdlr atoms within mdia and minf atoms (default false)

None
movie_timescale int | None

set movie timescale (from 1 to INT_MAX) (default 1000)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

pulse

pulse(
    server: str | None = None,
    name: str | None = None,
    stream_name: str | None = None,
    device: str | None = None,
    buffer_size: int | None = None,
    buffer_duration: int | None = None,
    prebuf: int | None = None,
    minreq: int | None = None,
) -> FFMpegMuxerOption

Pulse audio output.

Parameters:

Name Type Description Default
server str | None

set PulseAudio server

None
name str | None

set application name (default "Lavf60.16.100")

None
stream_name str | None

set stream description

None
device str | None

set device name

None
buffer_size int | None

set buffer size in bytes (from 0 to INT_MAX) (default 0)

None
buffer_duration int | None

set buffer duration in millisecs (from 0 to INT_MAX) (default 0)

None
prebuf int | None

set pre-buffering size (from 0 to INT_MAX) (default 0)

None
minreq int | None

set minimum request size (from 0 to INT_MAX) (default 0)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

rawvideo

rawvideo() -> FFMpegMuxerOption

Raw video.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

rm

RealMedia.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

roq

Raw id RoQ.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

rso

Lego Mindstorms RSO.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

rtp

rtp(
    rtpflags: str | None = None,
    payload_type: int | None = None,
    ssrc: int | None = None,
    cname: str | None = None,
    seq: int | None = None,
) -> FFMpegMuxerOption

RTP output.

Parameters:

Name Type Description Default
rtpflags str | None

RTP muxer flags (default 0)

None
payload_type int | None

Specify RTP payload type (from -1 to 127) (default -1)

None
ssrc int | None

Stream identifier (from INT_MIN to INT_MAX) (default 0)

None
cname str | None

CNAME to include in RTCP SR packets

None
seq int | None

Starting sequence number (from -1 to 65535) (default -1)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

rtp_mpegts

rtp_mpegts(
    mpegts_muxer_options: str | None = None,
    rtp_muxer_options: str | None = None,
) -> FFMpegMuxerOption

RTP/mpegts output format.

Parameters:

Name Type Description Default
mpegts_muxer_options str | None

set list of options for the MPEG-TS muxer

None
rtp_muxer_options str | None

set list of options for the RTP muxer

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

rtsp

rtsp(
    rtpflags: str | None = None,
    rtsp_transport: str | None = None,
    min_port: int | None = None,
    max_port: int | None = None,
    buffer_size: int | None = None,
    pkt_size: int | None = None,
) -> FFMpegMuxerOption

RTSP output.

Parameters:

Name Type Description Default
rtpflags str | None

RTP muxer flags (default 0)

None
rtsp_transport str | None

set RTSP transport protocols (default 0)

None
min_port int | None

set minimum local UDP port (from 0 to 65535) (default 5000)

None
max_port int | None

set maximum local UDP port (from 0 to 65535) (default 65000)

None
buffer_size int | None

Underlying protocol send/receive buffer size (from -1 to INT_MAX) (default -1)

None
pkt_size int | None

Underlying protocol send packet size (from -1 to INT_MAX) (default 1472)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

s16be

s16be() -> FFMpegMuxerOption

PCM signed 16-bit big-endian.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

s16le

s16le() -> FFMpegMuxerOption

PCM signed 16-bit little-endian.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

s24be

s24be() -> FFMpegMuxerOption

PCM signed 24-bit big-endian.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

s24le

s24le() -> FFMpegMuxerOption

PCM signed 24-bit little-endian.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

s32be

s32be() -> FFMpegMuxerOption

PCM signed 32-bit big-endian.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

s32le

s32le() -> FFMpegMuxerOption

PCM signed 32-bit little-endian.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

s8

PCM signed 8-bit.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

sap

SAP output.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

sbc

Raw SBC.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

scc

Scenarist Closed Captions.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

segment

segment(
    reference_stream: str | None = None,
    segment_format: str | None = None,
    segment_format_options: str | None = None,
    segment_list: str | None = None,
    segment_header_filename: str | None = None,
    segment_list_flags: str | None = None,
    segment_list_size: int | None = None,
    segment_list_type: (
        int
        | None
        | Literal[
            "flat", "csv", "ext", "ffconcat", "m3u8", "hls"
        ]
    ) = None,
    segment_atclocktime: bool | None = None,
    segment_clocktime_offset: str | None = None,
    segment_clocktime_wrap_duration: str | None = None,
    segment_time: str | None = None,
    segment_time_delta: str | None = None,
    min_seg_duration: str | None = None,
    segment_times: str | None = None,
    segment_frames: str | None = None,
    segment_wrap: int | None = None,
    segment_list_entry_prefix: str | None = None,
    segment_start_number: int | None = None,
    segment_wrap_number: int | None = None,
    strftime: bool | None = None,
    increment_tc: bool | None = None,
    break_non_keyframes: bool | None = None,
    individual_header_trailer: bool | None = None,
    write_header_trailer: bool | None = None,
    reset_timestamps: bool | None = None,
    initial_offset: str | None = None,
    write_empty_segments: bool | None = None,
) -> FFMpegMuxerOption

Segment.

Parameters:

Name Type Description Default
reference_stream str | None

set reference stream (default "auto")

None
segment_format str | None

set container format used for the segments

None
segment_format_options str | None

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

None
segment_list str | None

set the segment list filename

None
segment_header_filename str | None

write a single file containing the header

None
segment_list_flags str | None

set flags affecting segment list generation (default cache)

None
segment_list_size int | None

set the maximum number of playlist entries (from 0 to INT_MAX) (default 0)

None
segment_list_type int | None | Literal['flat', 'csv', 'ext', 'ffconcat', 'm3u8', 'hls']

set the segment list type (from -1 to 4) (default -1)

None
segment_atclocktime bool | None

set segment to be cut at clocktime (default false)

None
segment_clocktime_offset str | None

set segment clocktime offset (default 0)

None
segment_clocktime_wrap_duration str | None

set segment clocktime wrapping duration (default INT64_MAX)

None
segment_time str | None

set segment duration (default 2)

None
segment_time_delta str | None

set approximation value used for the segment times (default 0)

None
min_seg_duration str | None

set minimum segment duration (default 0)

None
segment_times str | None

set segment split time points

None
segment_frames str | None

set segment split frame numbers

None
segment_wrap int | None

set number after which the index wraps (from 0 to INT_MAX) (default 0)

None
segment_list_entry_prefix str | None

set base url prefix for segments

None
segment_start_number int | None

set the sequence number of the first segment (from 0 to INT_MAX) (default 0)

None
segment_wrap_number int | None

set the number of wrap before the first segment (from 0 to INT_MAX) (default 0)

None
strftime bool | None

set filename expansion with strftime at segment creation (default false)

None
increment_tc bool | None

increment timecode between each segment (default false)

None
break_non_keyframes bool | None

allow breaking segments on non-keyframes (default false)

None
individual_header_trailer bool | None

write header/trailer to each segment (default true)

None
write_header_trailer bool | None

write a header to the first segment and a trailer to the last one (default true)

None
reset_timestamps bool | None

reset timestamps at the beginning of each segment (default false)

None
initial_offset str | None

set initial timestamp offset (default 0)

None
write_empty_segments bool | None

allow writing empty 'filler' segments (default false)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

smjpeg

smjpeg() -> FFMpegMuxerOption

Loki SDL MJPEG.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

smoothstreaming

smoothstreaming(
    window_size: int | None = None,
    extra_window_size: int | None = None,
    lookahead_count: int | None = None,
    min_frag_duration: int | None = None,
    remove_at_exit: bool | None = None,
) -> FFMpegMuxerOption

Smooth Streaming Muxer.

Parameters:

Name Type Description Default
window_size int | None

number of fragments kept in the manifest (from 0 to INT_MAX) (default 0)

None
extra_window_size int | None

number of fragments kept outside of the manifest before removing from disk (from 0 to INT_MAX) (default 5)

None
lookahead_count int | None

number of lookahead fragments (from 0 to INT_MAX) (default 2)

None
min_frag_duration int | None

minimum fragment duration (in microseconds) (from 0 to INT_MAX) (default 5000000)

None
remove_at_exit bool | None

remove all fragments when finished (default false)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

sox

SoX (Sound eXchange) native.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

spdif

spdif(
    spdif_flags: str | None = None,
    dtshd_rate: int | None = None,
    dtshd_fallback_time: int | None = None,
) -> FFMpegMuxerOption

IEC 61937 (used on S/PDIF - IEC958).

Parameters:

Name Type Description Default
spdif_flags str | None

IEC 61937 encapsulation flags (default 0)

None
dtshd_rate int | None

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

None
dtshd_fallback_time int | None

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

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

spx

spx(
    serial_offset: int | None = None,
    oggpagesize: int | None = None,
    pagesize: int | None = None,
    page_duration: int | None = None,
) -> FFMpegMuxerOption

Ogg Speex.

Parameters:

Name Type Description Default
serial_offset int | None

serial number offset (from 0 to INT_MAX) (default 0)

None
oggpagesize int | None

Set preferred Ogg page size. (from 0 to 65025) (default 0)

None
pagesize int | None

preferred page size in bytes (deprecated) (from 0 to 65025) (default 0)

None
page_duration int | None

preferred page duration, in microseconds (from 0 to I64_MAX) (default 1000000)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

srt

SubRip subtitle.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

streamhash

streamhash(hash: str | None = None) -> FFMpegMuxerOption

Per-stream hash testing.

Parameters:

Name Type Description Default
hash str | None

set hash to use (default "sha256")

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

sup

Raw HDMV Presentation Graphic Stream subtitles.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

svcd

svcd(
    muxrate: int | None = None, preload: int | None = None
) -> FFMpegMuxerOption

MPEG-2 PS (SVCD).

Parameters:

Name Type Description Default
muxrate int | None

(from 0 to 1.67772e+09) (default 0)

None
preload int | None

Initial demux-decode delay in microseconds. (from 0 to INT_MAX) (default 500000)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

swf

SWF (ShockWave Flash).

Returns:

Type Description
FFMpegMuxerOption

the set codec options

tee

tee(
    use_fifo: bool | None = None,
    fifo_options: str | None = None,
) -> FFMpegMuxerOption

Multiple muxer tee.

Parameters:

Name Type Description Default
use_fifo bool | None

Use fifo pseudo-muxer to separate actual muxers from encoder (default false)

None
fifo_options str | None

fifo pseudo-muxer options

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

truehd

truehd() -> FFMpegMuxerOption

Raw TrueHD.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

tta

TTA (True Audio).

Returns:

Type Description
FFMpegMuxerOption

the set codec options

ttml

TTML subtitle.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

u16be

u16be() -> FFMpegMuxerOption

PCM unsigned 16-bit big-endian.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

u16le

u16le() -> FFMpegMuxerOption

PCM unsigned 16-bit little-endian.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

u24be

u24be() -> FFMpegMuxerOption

PCM unsigned 24-bit big-endian.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

u24le

u24le() -> FFMpegMuxerOption

PCM unsigned 24-bit little-endian.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

u32be

u32be() -> FFMpegMuxerOption

PCM unsigned 32-bit big-endian.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

u32le

u32le() -> FFMpegMuxerOption

PCM unsigned 32-bit little-endian.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

u8

PCM unsigned 8-bit.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

uncodedframecrc

uncodedframecrc() -> FFMpegMuxerOption

Uncoded framecrc testing.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

vc1

Raw VC-1 video.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

vc1test

vc1test() -> FFMpegMuxerOption

VC-1 test bitstream.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

vcd

vcd(
    muxrate: int | None = None, preload: int | None = None
) -> FFMpegMuxerOption

MPEG-1 Systems / MPEG program stream (VCD).

Parameters:

Name Type Description Default
muxrate int | None

(from 0 to 1.67772e+09) (default 0)

None
preload int | None

Initial demux-decode delay in microseconds. (from 0 to INT_MAX) (default 500000)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

vidc

PCM Archimedes VIDC.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

vob

vob(
    muxrate: int | None = None, preload: int | None = None
) -> FFMpegMuxerOption

MPEG-2 PS (VOB).

Parameters:

Name Type Description Default
muxrate int | None

(from 0 to 1.67772e+09) (default 0)

None
preload int | None

Initial demux-decode delay in microseconds. (from 0 to INT_MAX) (default 500000)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

voc

Creative Voice.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

vvc

Raw H.266/VVC video.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

w64

Sony Wave64.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

wav

wav(
    write_bext: bool | None = None,
    write_peak: (
        int | None | Literal["off", "on", "only"]
    ) = None,
    rf64: (
        int | None | Literal["auto", "always", "never"]
    ) = None,
    peak_block_size: int | None = None,
    peak_format: int | None = None,
    peak_ppv: int | None = None,
) -> FFMpegMuxerOption

WAV / WAVE (Waveform Audio).

Parameters:

Name Type Description Default
write_bext bool | None

Write BEXT chunk. (default false)

None
write_peak int | None | Literal['off', 'on', 'only']

Write Peak Envelope chunk. (from 0 to 2) (default off)

None
rf64 int | None | Literal['auto', 'always', 'never']

Use RF64 header rather than RIFF for large files. (from -1 to 1) (default never)

None
peak_block_size int | None

Number of audio samples used to generate each peak frame. (from 0 to 65536) (default 256)

None
peak_format int | None

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

None
peak_ppv int | None

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

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

webm

webm(
    reserve_index_space: int | None = None,
    cues_to_front: bool | None = None,
    cluster_size_limit: int | None = None,
    cluster_time_limit: int | None = None,
    dash: bool | None = None,
    dash_track_number: int | None = None,
    live: bool | None = None,
    allow_raw_vfw: bool | None = None,
    flipped_raw_rgb: bool | None = None,
    write_crc32: bool | None = None,
    default_mode: (
        int
        | None
        | Literal["infer", "infer_no_subs", "passthrough"]
    ) = None,
) -> FFMpegMuxerOption

WebM.

Parameters:

Name Type Description Default
reserve_index_space int | None

Reserve a given amount of space (in bytes) at the beginning of the file for the index (cues). (from 0 to INT_MAX) (default 0)

None
cues_to_front bool | None

Move Cues (the index) to the front by shifting data if necessary (default false)

None
cluster_size_limit int | None

Store at most the provided amount of bytes in a cluster. (from -1 to INT_MAX) (default -1)

None
cluster_time_limit int | None

Store at most the provided number of milliseconds in a cluster. (from -1 to I64_MAX) (default -1)

None
dash bool | None

Create a WebM file conforming to WebM DASH specification (default false)

None
dash_track_number int | None

Track number for the DASH stream (from 1 to INT_MAX) (default 1)

None
live bool | None

Write files assuming it is a live stream. (default false)

None
allow_raw_vfw bool | None

allow RAW VFW mode (default false)

None
flipped_raw_rgb bool | None

Raw RGB bitmaps in VFW mode are stored bottom-up (default false)

None
write_crc32 bool | None

write a CRC32 element inside every Level 1 element (default true)

None
default_mode int | None | Literal['infer', 'infer_no_subs', 'passthrough']

Controls how a track's FlagDefault is inferred (from 0 to 2) (default passthrough)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

webm_chunk

webm_chunk(
    chunk_start_index: int | None = None,
    header: str | None = None,
    audio_chunk_duration: int | None = None,
    method: str | None = None,
) -> FFMpegMuxerOption

WebM Chunk Muxer.

Parameters:

Name Type Description Default
chunk_start_index int | None

start index of the chunk (from 0 to INT_MAX) (default 0)

None
header str | None

filename of the header where the initialization data will be written

None
audio_chunk_duration int | None

duration of each chunk in milliseconds (from 0 to INT_MAX) (default 5000)

None
method str | None

set the HTTP method

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

webm_dash_manifest

webm_dash_manifest(
    adaptation_sets: str | None = None,
    live: bool | None = None,
    chunk_start_index: int | None = None,
    chunk_duration_ms: int | None = None,
    utc_timing_url: str | None = None,
    time_shift_buffer_depth: float | None = None,
    minimum_update_period: int | None = None,
) -> FFMpegMuxerOption

WebM DASH Manifest.

Parameters:

Name Type Description Default
adaptation_sets str | None

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

None
live bool | None

create a live stream manifest (default false)

None
chunk_start_index int | None

start index of the chunk (from 0 to INT_MAX) (default 0)

None
chunk_duration_ms int | None

duration of each chunk (in milliseconds) (from 0 to INT_MAX) (default 1000)

None
utc_timing_url str | None

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

None
time_shift_buffer_depth float | None

Smallest time (in seconds) shifting buffer for which any Representation is guaranteed to be available. (from 1 to DBL_MAX) (default 60)

None
minimum_update_period int | None

Minimum Update Period (in seconds) of the manifest. (from 0 to INT_MAX) (default 0)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

webp

webp(loop: int | None = None) -> FFMpegMuxerOption

WebP.

Parameters:

Name Type Description Default
loop int | None

Number of times to loop the output: 0 - infinite loop (from 0 to 65535) (default 1)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

webvtt

webvtt() -> FFMpegMuxerOption

WebVTT subtitle.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

wsaud

wsaud() -> FFMpegMuxerOption

Westwood Studios audio.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

wtv

Windows Television (WTV).

Returns:

Type Description
FFMpegMuxerOption

the set codec options

wv

Raw WavPack.

Returns:

Type Description
FFMpegMuxerOption

the set codec options

xv

xv(
    display_name: str | None = None,
    window_id: int | None = None,
    window_size: str | None = None,
    window_title: str | None = None,
    window_x: int | None = None,
    window_y: int | None = None,
) -> FFMpegMuxerOption

XV (XVideo) output device.

Parameters:

Name Type Description Default
display_name str | None

set display name

None
window_id int | None

set existing window id (from 0 to I64_MAX) (default 0)

None
window_size str | None

set window forced size

None
window_title str | None

set window title

None
window_x int | None

set window x offset (from -2.14748e+09 to INT_MAX) (default 0)

None
window_y int | None

set window y offset (from -2.14748e+09 to INT_MAX) (default 0)

None

Returns:

Type Description
FFMpegMuxerOption

the set codec options

yuv4mpegpipe

yuv4mpegpipe() -> FFMpegMuxerOption

YUV4MPEG pipe.

Returns:

Type Description
FFMpegMuxerOption

the set codec options