Skip to content

demuxers

FFmpeg demuxers.

Functions:

Name Description
aa

Audible AA format files

aac

raw ADTS AAC (Advanced Audio Coding)

aax

CRI AAX

ac3

raw AC-3

ac4

raw AC-4

ace

tri-Ace Audio Container

acm

Interplay ACM

act

ACT Voice file format

adf

Artworx Data Format

adp

ADP

ads

Sony PS2 ADS

adx

CRI ADX

aea

MD STUDIO audio

afc

AFC

aiff

Audio IFF

aix

CRI AIX

alaw

PCM A-law

alias_pix

Alias/Wavefront PIX image

alp

LEGO Racers ALP

amr

3GPP AMR

amrnb

raw AMR-NB

amrwb

raw AMR-WB

anm

Deluxe Paint Animation

apac

raw APAC

apc

CRYO APC

ape

Monkey's Audio

apm

Ubisoft Rayman 2 APM

apng

Animated Portable Network Graphics

aptx

raw aptX

aptx_hd

raw aptX HD

apv

APV raw bitstream

aqtitle

AQTitle subtitles

argo_asf

Argonaut Games ASF

argo_brp

Argonaut Games BRP

argo_cvg

Argonaut Games CVG

asf

ASF (Advanced / Active Streaming Format)

asf_o

ASF (Advanced / Active Streaming Format)

ass

SSA (SubStation Alpha) subtitle

ast

AST (Audio Stream)

au

Sun AU

av1

AV1 Annex B

avi

AVI (Audio Video Interleaved)

avr

AVR (Audio Visual Research)

avs

Argonaut Games Creature Shock

avs2

raw AVS2-P2/IEEE1857.4

avs3

raw AVS3-P2/IEEE1857.10

bethsoftvid

Bethesda Softworks VID

bfi

Brute Force & Ignorance

bfstm

BFSTM (Binary Cafe Stream)

bin

Binary text

bink

Bink

binka

Bink Audio

bit

G.729 BIT file format

bitpacked

Bitpacked

bmp_pipe

piped bmp sequence

bmv

Discworld II BMV

boa

Black Ops Audio

bonk

raw Bonk

brender_pix

BRender PIX image

brstm

BRSTM (Binary Revolution Stream)

c93

Interplay C93

caf

Apple CAF (Core Audio Format)

cavsvideo

raw Chinese AVS (Audio Video Standard)

cdg

CD Graphics

cdxl

Commodore CDXL video

cine

Phantom Cine

codec2

codec2 .c2 demuxer

codec2raw

raw codec2 demuxer

concat

Virtual concatenation script

cri_pipe

piped cri sequence

d

x11grab X11 screen capture, using XCB

data

raw data

daud

D-Cinema audio

dcstr

Sega DC STR

dds_pipe

piped dds sequence

derf

Xilam DERF

dfa

Chronomaster DFA

dfpwm

raw DFPWM1a

dhav

Video DAV

dirac

raw Dirac

dnxhd

raw DNxHD (SMPTE VC-3)

dpx_pipe

piped dpx sequence

dsf

DSD Stream File (DSF)

dsicin

Delphine Software International CIN

dss

Digital Speech Standard (DSS)

dts

raw DTS

dtshd

raw DTS-HD

dv

DV (Digital Video)

dvbsub

raw dvbsub

dvbtxt

dvbtxt

dxa

DXA

ea

Electronic Arts Multimedia

ea_cdata

Electronic Arts cdata

eac3

raw E-AC-3

epaf

Ensoniq Paris Audio File

evc

EVC Annex B

exr_pipe

piped exr sequence

f32be

PCM 32-bit floating-point big-endian

f32le

PCM 32-bit floating-point little-endian

f64be

PCM 64-bit floating-point big-endian

f64le

PCM 64-bit floating-point little-endian

ffmetadata

FFmpeg metadata in text

film_cpk

Sega FILM / CPK

filmstrip

Adobe Filmstrip

fits

Flexible Image Transport System

flac

raw FLAC

flic

FLI/FLC/FLX animation

flv

FLV (Flash Video)

frm

Megalux Frame

fsb

FMOD Sample Bank

fwse

Capcom's MT Framework sound

g722

raw G.722

g723_1

G.723.1

g726

raw big-endian G.726 ("left aligned")

g726le

raw little-endian G.726 ("right aligned")

g728

raw G.728

g729

G.729 raw format demuxer

gdv

Gremlin Digital Video

gem_pipe

piped gem sequence

genh

GENeric Header

gif

CompuServe Graphics Interchange Format (GIF)

gif_pipe

piped gif sequence

gsm

raw GSM

gxf

GXF (General eXchange Format)

h261

raw H.261

h263

raw H.263

h264

raw H.264 video

hca

CRI HCA

hcom

Macintosh HCOM

hdr_pipe

piped hdr sequence

hevc

raw HEVC video

hls

Apple HTTP Live Streaming

hnm

Cryo HNM v4

hxvs

HXVF/HXVS IP camera format

iamf

Raw Immersive Audio Model and Formats

ico

Microsoft Windows ICO

idcin

id Cinematic

idf

iCE Draw File

iff

IFF (Interchange File Format)

ifv

IFV CCTV DVR

ilbc

iLBC storage

image2

image2 sequence

image2pipe

piped image2 sequence

ingenient

raw Ingenient MJPEG

ipmovie

Interplay MVE

ipu

raw IPU Video

ircam

Berkeley/IRCAM/CARL Sound Format

iss

Funcom ISS

iv8

IndigoVision 8000 video

ivf

On2 IVF

ivr

IVR (Internet Video Recording)

j2k_pipe

piped j2k sequence

jacosub

JACOsub subtitle format

jpeg_pipe

piped jpeg sequence

jpegls_pipe

piped jpegls sequence

jpegxl_anim

Animated JPEG XL

jpegxl_pipe

piped jpegxl sequence

jpegxs_pipe

piped jpegxs sequence

jv

Bitmap Brothers JV

kux

KUX (YouKu)

kvag

Simon & Schuster Interactive VAG

laf

LAF (Limitless Audio Format)

lc3

LC3 (Low Complexity Communication Codec)

live_flv

live RTMP FLV (Flash Video)

lmlm4

raw lmlm4

loas

LOAS AudioSyncStream

lrc

LRC lyrics

luodat

Video CCTV DAT

lvf

LVF

lxf

VR native stream (LXF)

m4v

raw MPEG-4 video

mca

MCA Audio Format

mcc

MacCaption

mgsts

Metal Gear Solid: The Twin Snakes

microdvd

MicroDVD subtitle format

mjpeg

raw MJPEG video

mjpeg_2000

raw MJPEG 2000 video

mlp

raw MLP

mlv

Magic Lantern Video (MLV)

mm

American Laser Games MM

mmf

Yamaha SMAF

mods

MobiClip MODS

moflex

MobiClip MOFLEX

mp3

MP2/3 (MPEG audio layer 2/3)

mpc

Musepack

mpc8

Musepack SV8

mpeg

MPEG-PS (MPEG-2 Program Stream)

mpegts

MPEG-TS (MPEG-2 Transport Stream)

mpegtsraw

raw MPEG-TS (MPEG-2 Transport Stream)

mpegvideo

raw MPEG video

mpjpeg

MIME multipart JPEG

mpl2

MPL2 subtitles

mpsub

MPlayer subtitles

msf

Sony PS3 MSF

msnwctcp

MSN TCP Webcam stream

msp

Microsoft Paint (MSP))

mtaf

Konami PS2 MTAF

mtv

MTV

mulaw

PCM mu-law

musx

Eurocom MUSX

mv

Silicon Graphics Movie

mvi

Motion Pixels MVI

mxf

MXF (Material eXchange Format)

mxg

MxPEG clip

nc

NC camera feed

nistsphere

NIST SPeech HEader REsources

nsp

Computerized Speech Lab NSP

nsv

Nullsoft Streaming Video

nut

NUT

nuv

NuppelVideo

obu

AV1 low overhead OBU

ogg

Ogg

oma

Sony OpenMG audio

osq

raw OSQ

paf

Amazing Studio Packed Animation File

pam_pipe

piped pam sequence

pbm_pipe

piped pbm sequence

pcx_pipe

piped pcx sequence

pdv

PlayDate Video

pfm_pipe

piped pfm sequence

pgm_pipe

piped pgm sequence

pgmyuv_pipe

piped pgmyuv sequence

pgx_pipe

piped pgx sequence

phm_pipe

piped phm sequence

photocd_pipe

piped photocd sequence

pictor_pipe

piped pictor sequence

pjs

PJS (Phoenix Japanimation Society) subtitles

pmp

Playstation Portable PMP

png_pipe

piped png sequence

pp_bnk

Pro Pinball Series Soundbank

ppm_pipe

piped ppm sequence

psd_pipe

piped psd sequence

psxstr

Sony Playstation STR

pva

TechnoTrend PVA

pvf

PVF (Portable Voice Format)

qcp

QCP

qdraw_pipe

piped qdraw sequence

qoa

QOA

qoi_pipe

piped qoi sequence

r3d

REDCODE R3D

rawvideo

raw video

rcwt

RCWT (Raw Captions With Time)

realtext

RealText subtitle format

redspark

RedSpark

rka

RKA (RK Audio)

rl2

RL2

rm

RealMedia

roq

id RoQ

rpl

RPL / ARMovie

rsd

GameCube RSD

rso

Lego Mindstorms RSO

rtp

RTP input

rtsp

RTSP input

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

s337m

SMPTE 337M

s8

PCM signed 8-bit

sami

SAMI subtitle format

sap

SAP input

sbc

raw SBC (low-complexity subband codec)

sbg

SBaGen binaural beats script

scc

Scenarist Closed Captions

scd

Square Enix SCD

sdns

Xbox SDNS

sdp

SDP

sdr2

SDR2

sds

MIDI Sample Dump Standard

sdx

Sample Dump eXchange

ser

SER (Simple uncompressed video format for astronomical capturing)

sga

Digital Pictures SGA

sgi_pipe

piped sgi sequence

shn

raw Shorten

siff

Beam Software SIFF

simbiosis_imx

Simbiosis Interactive IMX

sln

Asterisk raw pcm

smjpeg

Loki SDL MJPEG

smk

Smacker

smush

LucasArts Smush

sol

Sierra SOL

sox

SoX (Sound eXchange) native

spdif

IEC 61937 (compressed data in S/PDIF)

srt

SubRip subtitle

stl

Spruce subtitle format

subviewer

SubViewer subtitle format

subviewer1

SubViewer v1 subtitle format

sunrast_pipe

piped sunrast sequence

sup

raw HDMV Presentation Graphic Stream subtitles

svag

Konami PS2 SVAG

svg_pipe

piped svg sequence

svs

Square SVS

swf

SWF (ShockWave Flash)

tak

raw TAK

tedcaptions

TED Talks captions

thp

THP

tiertexseq

Tiertex Limited SEQ

tiff_pipe

piped tiff sequence

tmv

8088flex TMV

truehd

raw TrueHD

tta

TTA (True Audio)

tty

Tele-typewriter

txd

Renderware TeXture Dictionary

ty

TiVo TY Stream

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

usm

CRI USM

v210

Uncompressed 4:2:2 10-bit

v210x

Uncompressed 4:2:2 10-bit

vag

Sony PS2 VAG

vbn_pipe

piped vbn sequence

vc1

raw VC-1

vc1test

VC-1 test bitstream

vidc

PCM Archimedes VIDC

vividas

Vividas VIV

vivo

Vivo

vmd

Sierra VMD

vobsub

VobSub subtitle format

voc

Creative Voice

vpk

Sony PS2 VPK

vplayer

VPlayer subtitles

vqf

Nippon Telegraph and Telephone Corporation (NTT) TwinVQ

vvc

raw H.266/VVC video

w64

Sony Wave64

wady

Marble WADY

wav

WAV / WAVE (Waveform Audio)

wavarc

Waveform Archiver

wc3movie

Wing Commander III movie

webm_dash_manifest

WebM DASH Manifest

webp_anim

Animated WebP

webp_pipe

piped webp sequence

webvtt

WebVTT subtitle

wsaud

Westwood Studios audio

wsd

Wideband Single-bit Data (WSD)

wsvqa

Westwood Studios VQA

wtv

Windows Television (WTV)

wv

WavPack

wve

Psion 3 audio

xa

Maxis XA

xbin

eXtended BINary text (XBIN)

xbm_pipe

piped xbm sequence

xmd

Konami XMD

xmv

Microsoft XMV

xpm_pipe

piped xpm sequence

xvag

Sony PS3 XVAG

xwd_pipe

piped xwd sequence

xwma

Microsoft xWMA

yop

Psygnosis YOP

yuv4mpegpipe

YUV4MPEG pipe

aa

aa(aa_fixed_key: str | None = None) -> FFMpegDemuxerOption

Audible AA format files

Parameters:

Name Type Description Default
aa_fixed_key str | None

Fixed key used for handling Audible AA files

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

aac

raw ADTS AAC (Advanced Audio Coding)

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

aax

CRI AAX

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ac3

ac3(
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw AC-3

Parameters:

Name Type Description Default
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ac4

raw AC-4

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ace

tri-Ace Audio Container

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

acm

acm(
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

Interplay ACM

Parameters:

Name Type Description Default
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

act

ACT Voice file format

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

adf

adf(
    linespeed: int | None = None,
    video_size: str | None = None,
    framerate: str | None = None,
) -> FFMpegDemuxerOption

Artworx Data Format

Parameters:

Name Type Description Default
linespeed int | None

set simulated line speed (bytes per second) (from 1 to INT_MAX) (default 6000)

None
video_size str | None

set video size, such as 640x480 or hd720.

None
framerate str | None

set framerate (frames per second) (default "25")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

adp

ADP

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ads

Sony PS2 ADS

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

adx

adx(
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

CRI ADX

Parameters:

Name Type Description Default
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

aea

MD STUDIO audio

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

afc

AFC

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

aiff

Audio IFF

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

aix

CRI AIX

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

alaw

alaw(
    sample_rate: int | None = None,
    ch_layout: str | None = None,
) -> FFMpegDemuxerOption

PCM A-law

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
ch_layout str | None

(default "mono")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

alias_pix

alias_pix(
    pattern_type: (
        int | None | Literal["glob", "sequence", "none"]
    ) = None,
    start_number: int | None = None,
    start_number_range: int | None = None,
    ts_from_file: (
        int | None | Literal["none", "sec", "ns"]
    ) = None,
    export_path_metadata: bool | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

Alias/Wavefront PIX image

Parameters:

Name Type Description Default
pattern_type int | None | Literal['glob', 'sequence', 'none']

set pattern type (from 0 to INT_MAX) (default 4)

None
start_number int | None

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

None
start_number_range int | None

set range for looking at the first sequence number (from 1 to INT_MAX) (default 5)

None
ts_from_file int | None | Literal['none', 'sec', 'ns']

set frame timestamp from file's one (from 0 to 2) (default none)

None
export_path_metadata bool | None

enable metadata containing input path information (default false)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

alp

LEGO Racers ALP

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

amr

amr(
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

3GPP AMR

Parameters:

Name Type Description Default
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

amrnb

amrnb(
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw AMR-NB

Parameters:

Name Type Description Default
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

amrwb

amrwb(
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw AMR-WB

Parameters:

Name Type Description Default
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

anm

Deluxe Paint Animation

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

apac

apac(
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw APAC

Parameters:

Name Type Description Default
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

apc

CRYO APC

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ape

Monkey's Audio

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

apm

Ubisoft Rayman 2 APM

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

apng

apng(
    ignore_loop: bool | None = None,
    max_fps: int | None = None,
    default_fps: int | None = None,
) -> FFMpegDemuxerOption

Animated Portable Network Graphics

Parameters:

Name Type Description Default
ignore_loop bool | None

ignore loop setting (default true)

None
max_fps int | None

maximum framerate (0 is no limit) (from 0 to INT_MAX) (default 0)

None
default_fps int | None

default framerate (0 is as fast as possible) (from 0 to INT_MAX) (default 15)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

aptx

aptx(sample_rate: int | None = None) -> FFMpegDemuxerOption

raw aptX

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 48000)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

aptx_hd

aptx_hd(
    sample_rate: int | None = None,
) -> FFMpegDemuxerOption

raw aptX HD

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 48000)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

apv

apv(framerate: str | None = None) -> FFMpegDemuxerOption

APV raw bitstream

Parameters:

Name Type Description Default
framerate str | None

set frame rate (default "30")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

aqtitle

aqtitle(subfps: str | None = None) -> FFMpegDemuxerOption

AQTitle subtitles

Parameters:

Name Type Description Default
subfps str | None

set the movie frame rate (from 0 to INT_MAX) (default 25/1)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

argo_asf

argo_asf() -> FFMpegDemuxerOption

Argonaut Games ASF

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

argo_brp

argo_brp() -> FFMpegDemuxerOption

Argonaut Games BRP

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

argo_cvg

argo_cvg() -> FFMpegDemuxerOption

Argonaut Games CVG

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

asf

asf(
    no_resync_search: bool | None = None,
    export_xmp: bool | None = None,
) -> FFMpegDemuxerOption

ASF (Advanced / Active Streaming Format)

Parameters:

Name Type Description Default
no_resync_search bool | None

Don't try to resynchronize by looking for a certain optional start code (default false)

None
export_xmp bool | None

Export full XMP metadata (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

asf_o

ASF (Advanced / Active Streaming Format)

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ass

SSA (SubStation Alpha) subtitle

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ast

AST (Audio Stream)

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

au

Sun AU

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

av1

av1(framerate: str | None = None) -> FFMpegDemuxerOption

AV1 Annex B

Parameters:

Name Type Description Default
framerate str | None

(default "25")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

avi

avi(use_odml: bool | None = None) -> FFMpegDemuxerOption

AVI (Audio Video Interleaved)

Parameters:

Name Type Description Default
use_odml bool | None

use odml index (default true)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

avr

AVR (Audio Visual Research)

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

avs

Argonaut Games Creature Shock

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

avs2

avs2(
    framerate: str | None = None,
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw AVS2-P2/IEEE1857.4

Parameters:

Name Type Description Default
framerate str | None

(default "25")

None
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

avs3

avs3(
    framerate: str | None = None,
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw AVS3-P2/IEEE1857.10

Parameters:

Name Type Description Default
framerate str | None

(default "25")

None
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

bethsoftvid

bethsoftvid() -> FFMpegDemuxerOption

Bethesda Softworks VID

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

bfi

Brute Force & Ignorance

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

bfstm

BFSTM (Binary Cafe Stream)

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

bin

bin(
    linespeed: int | None = None,
    video_size: str | None = None,
    framerate: str | None = None,
) -> FFMpegDemuxerOption

Binary text

Parameters:

Name Type Description Default
linespeed int | None

set simulated line speed (bytes per second) (from 1 to INT_MAX) (default 6000)

None
video_size str | None

set video size, such as 640x480 or hd720.

None
framerate str | None

set framerate (frames per second) (default "25")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

bink

Bink

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

binka

Bink Audio

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

bit

G.729 BIT file format

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

bitpacked

bitpacked(
    pixel_format: str | None = None,
    video_size: str | None = None,
    framerate: str | None = None,
) -> FFMpegDemuxerOption

Bitpacked

Parameters:

Name Type Description Default
pixel_format str | None

set pixel format (default yuv420p)

None
video_size str | None

set frame size

None
framerate str | None

set frame rate (default "25")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

bmp_pipe

bmp_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped bmp sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

bmv

Discworld II BMV

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

boa

Black Ops Audio

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

bonk

bonk(
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw Bonk

Parameters:

Name Type Description Default
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

brender_pix

brender_pix(
    pattern_type: (
        int | None | Literal["glob", "sequence", "none"]
    ) = None,
    start_number: int | None = None,
    start_number_range: int | None = None,
    ts_from_file: (
        int | None | Literal["none", "sec", "ns"]
    ) = None,
    export_path_metadata: bool | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

BRender PIX image

Parameters:

Name Type Description Default
pattern_type int | None | Literal['glob', 'sequence', 'none']

set pattern type (from 0 to INT_MAX) (default 4)

None
start_number int | None

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

None
start_number_range int | None

set range for looking at the first sequence number (from 1 to INT_MAX) (default 5)

None
ts_from_file int | None | Literal['none', 'sec', 'ns']

set frame timestamp from file's one (from 0 to 2) (default none)

None
export_path_metadata bool | None

enable metadata containing input path information (default false)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

brstm

BRSTM (Binary Revolution Stream)

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

c93

Interplay C93

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

caf

Apple CAF (Core Audio Format)

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

cavsvideo

cavsvideo(
    framerate: str | None = None,
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw Chinese AVS (Audio Video Standard)

Parameters:

Name Type Description Default
framerate str | None

(default "25")

None
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

cdg

CD Graphics

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

cdxl

cdxl(
    sample_rate: int | None = None,
    frame_rate: str | None = None,
) -> FFMpegDemuxerOption

Commodore CDXL video

Parameters:

Name Type Description Default
sample_rate int | None

(from 8000 to INT_MAX) (default 11025)

None
frame_rate str | None

(default "15")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

cine

Phantom Cine

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

codec2

codec2(
    frames_per_packet: int | None = None,
) -> FFMpegDemuxerOption

codec2 .c2 demuxer

Parameters:

Name Type Description Default
frames_per_packet int | None

Number of frames to read at a time. Higher = faster decoding, lower granularity (from 1 to INT_MAX) (default 1)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

codec2raw

codec2raw(
    mode: (
        int
        | None
        | Literal[
            "3200",
            "2400",
            "1600",
            "1400",
            "1300",
            "1200",
            "700",
            "700B",
            "700C",
        ]
    ) = None,
    frames_per_packet: int | None = None,
) -> FFMpegDemuxerOption

raw codec2 demuxer

Parameters:

Name Type Description Default
mode int | None | Literal['3200', '2400', '1600', '1400', '1300', '1200', '700', '700B', '700C']

codec2 mode [mandatory] (from -1 to 8) (default -1)

None
frames_per_packet int | None

Number of frames to read at a time. Higher = faster decoding, lower granularity (from 1 to INT_MAX) (default 1)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

concat

concat(
    safe: bool | None = None,
    auto_convert: bool | None = None,
    segment_time_metadata: bool | None = None,
    recursion_depth: int | None = None,
) -> FFMpegDemuxerOption

Virtual concatenation script

Parameters:

Name Type Description Default
safe bool | None

enable safe mode (default true)

None
auto_convert bool | None

automatically convert bitstream format (default true)

None
segment_time_metadata bool | None

output file segment start time and duration as packet metadata (default false)

None
recursion_depth int | None

max recursion depth (from 0 to INT_MAX) (default 10)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

cri_pipe

cri_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped cri sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

d

x11grab X11 screen capture, using XCB

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

data

data(
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw data

Parameters:

Name Type Description Default
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

daud

D-Cinema audio

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

dcstr

Sega DC STR

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

dds_pipe

dds_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped dds sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

derf

Xilam DERF

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

dfa

Chronomaster DFA

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

dfpwm

dfpwm(
    sample_rate: int | None = None,
    ch_layout: str | None = None,
) -> FFMpegDemuxerOption

raw DFPWM1a

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 48000)

None
ch_layout str | None

(default "mono")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

dhav

Video DAV

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

dirac

dirac(
    framerate: str | None = None,
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw Dirac

Parameters:

Name Type Description Default
framerate str | None

(default "25")

None
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

dnxhd

dnxhd(
    framerate: str | None = None,
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw DNxHD (SMPTE VC-3)

Parameters:

Name Type Description Default
framerate str | None

(default "25")

None
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

dpx_pipe

dpx_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped dpx sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

dsf

DSD Stream File (DSF)

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

dsicin

dsicin() -> FFMpegDemuxerOption

Delphine Software International CIN

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

dss

Digital Speech Standard (DSS)

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

dts

dts(
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw DTS

Parameters:

Name Type Description Default
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

dtshd

raw DTS-HD

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

dv

DV (Digital Video)

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

dvbsub

dvbsub(
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw dvbsub

Parameters:

Name Type Description Default
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

dvbtxt

dvbtxt(
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

dvbtxt

Parameters:

Name Type Description Default
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

dxa

DXA

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ea

ea(merge_alpha: bool | None = None) -> FFMpegDemuxerOption

Electronic Arts Multimedia

Parameters:

Name Type Description Default
merge_alpha bool | None

return VP6 alpha in the main video stream (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ea_cdata

ea_cdata() -> FFMpegDemuxerOption

Electronic Arts cdata

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

eac3

eac3(
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw E-AC-3

Parameters:

Name Type Description Default
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

epaf

Ensoniq Paris Audio File

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

evc

evc(framerate: str | None = None) -> FFMpegDemuxerOption

EVC Annex B

Parameters:

Name Type Description Default
framerate str | None

(default "25")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

exr_pipe

exr_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped exr sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

f32be

f32be(
    sample_rate: int | None = None,
    ch_layout: str | None = None,
) -> FFMpegDemuxerOption

PCM 32-bit floating-point big-endian

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
ch_layout str | None

(default "mono")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

f32le

f32le(
    sample_rate: int | None = None,
    ch_layout: str | None = None,
) -> FFMpegDemuxerOption

PCM 32-bit floating-point little-endian

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
ch_layout str | None

(default "mono")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

f64be

f64be(
    sample_rate: int | None = None,
    ch_layout: str | None = None,
) -> FFMpegDemuxerOption

PCM 64-bit floating-point big-endian

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
ch_layout str | None

(default "mono")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

f64le

f64le(
    sample_rate: int | None = None,
    ch_layout: str | None = None,
) -> FFMpegDemuxerOption

PCM 64-bit floating-point little-endian

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
ch_layout str | None

(default "mono")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ffmetadata

ffmetadata() -> FFMpegDemuxerOption

FFmpeg metadata in text

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

film_cpk

film_cpk() -> FFMpegDemuxerOption

Sega FILM / CPK

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

filmstrip

filmstrip() -> FFMpegDemuxerOption

Adobe Filmstrip

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

fits

fits(framerate: str | None = None) -> FFMpegDemuxerOption

Flexible Image Transport System

Parameters:

Name Type Description Default
framerate str | None

set the framerate (default "1")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

flac

flac(
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw FLAC

Parameters:

Name Type Description Default
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

flic

FLI/FLC/FLX animation

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

flv

flv(
    flv_metadata: bool | None = None,
    flv_full_metadata: bool | None = None,
    flv_ignore_prevtag: bool | None = None,
) -> FFMpegDemuxerOption

FLV (Flash Video)

Parameters:

Name Type Description Default
flv_metadata bool | None

Allocate streams according to the onMetaData array (default false)

None
flv_full_metadata bool | None

Dump full metadata of the onMetadata (default false)

None
flv_ignore_prevtag bool | None

Ignore the Size of previous tag (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

frm

Megalux Frame

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

fsb

FMOD Sample Bank

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

fwse

Capcom's MT Framework sound

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

g722

g722(
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw G.722

Parameters:

Name Type Description Default
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

g723_1

g723_1() -> FFMpegDemuxerOption

G.723.1

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

g726

g726(
    code_size: int | None = None,
    sample_rate: int | None = None,
) -> FFMpegDemuxerOption

raw big-endian G.726 ("left aligned")

Parameters:

Name Type Description Default
code_size int | None

Bits per G.726 code (from 2 to 5) (default 4)

None
sample_rate int | None

(from 0 to INT_MAX) (default 8000)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

g726le

g726le(
    code_size: int | None = None,
    sample_rate: int | None = None,
) -> FFMpegDemuxerOption

raw little-endian G.726 ("right aligned")

Parameters:

Name Type Description Default
code_size int | None

Bits per G.726 code (from 2 to 5) (default 4)

None
sample_rate int | None

(from 0 to INT_MAX) (default 8000)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

g728

raw G.728

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

g729

g729(bit_rate: int | None = None) -> FFMpegDemuxerOption

G.729 raw format demuxer

Parameters:

Name Type Description Default
bit_rate int | None

(from 0 to INT_MAX) (default 8000)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

gdv

Gremlin Digital Video

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

gem_pipe

gem_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped gem sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

genh

GENeric Header

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

gif

gif(
    min_delay: int | None = None,
    max_gif_delay: int | None = None,
    default_delay: int | None = None,
    ignore_loop: bool | None = None,
) -> FFMpegDemuxerOption

CompuServe Graphics Interchange Format (GIF)

Parameters:

Name Type Description Default
min_delay int | None

minimum valid delay between frames (in hundredths of second) (from 0 to 6000) (default 2)

None
max_gif_delay int | None

maximum valid delay between frames (in hundredths of seconds) (from 0 to 65535) (default 65535)

None
default_delay int | None

default delay between frames (in hundredths of second) (from 0 to 6000) (default 10)

None
ignore_loop bool | None

ignore loop setting (netscape extension) (default true)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

gif_pipe

gif_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped gif sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

gsm

gsm(sample_rate: int | None = None) -> FFMpegDemuxerOption

raw GSM

Parameters:

Name Type Description Default
sample_rate int | None

(from 1 to 6.50753e+07) (default 8000)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

gxf

GXF (General eXchange Format)

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

h261

h261(
    framerate: str | None = None,
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw H.261

Parameters:

Name Type Description Default
framerate str | None

(default "25")

None
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

h263

h263(
    framerate: str | None = None,
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw H.263

Parameters:

Name Type Description Default
framerate str | None

(default "25")

None
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

h264

h264(
    framerate: str | None = None,
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw H.264 video

Parameters:

Name Type Description Default
framerate str | None

(default "25")

None
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

hca

hca(
    hca_lowkey: int | None = None,
    hca_highkey: int | None = None,
    hca_subkey: int | None = None,
) -> FFMpegDemuxerOption

CRI HCA

Parameters:

Name Type Description Default
hca_lowkey int | None

Low key used for handling CRI HCA files (from 0 to UINT32_MAX) (default 0)

None
hca_highkey int | None

High key used for handling CRI HCA files (from 0 to UINT32_MAX) (default 0)

None
hca_subkey int | None

Subkey used for handling CRI HCA files (from 0 to 65535) (default 0)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

hcom

Macintosh HCOM

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

hdr_pipe

hdr_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped hdr sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

hevc

hevc(
    framerate: str | None = None,
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw HEVC video

Parameters:

Name Type Description Default
framerate str | None

(default "25")

None
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

hls

hls(
    live_start_index: int | None = None,
    prefer_x_start: bool | None = None,
    allowed_extensions: str | None = None,
    allowed_segment_extensions: str | None = None,
    extension_picky: bool | None = None,
    max_reload: int | None = None,
    m3u8_hold_counters: int | None = None,
    http_persistent: bool | None = None,
    http_multiple: bool | None = None,
    http_seekable: bool | None = None,
    seg_format_options: str | None = None,
    seg_max_retry: int | None = None,
) -> FFMpegDemuxerOption

Apple HTTP Live Streaming

Parameters:

Name Type Description Default
live_start_index int | None

segment index to start live streams at (negative values are from the end) (from INT_MIN to INT_MAX) (default -3)

None
prefer_x_start bool | None

prefer to use #EXT-X-START if it's in playlist instead of live_start_index (default false)

None
allowed_extensions str | None

List of file extensions that hls is allowed to access (default "3gp,aac,avi,ac3,eac3,flac,mkv,m3u8,m4a,m4s,m4v,mpg,mov,mp2,mp3,mp4,mpeg,mpegts,ogg,ogv,oga,ts,vob,vtt,wav,webvtt,cmfv,cmfa,ec3,fmp4")

None
allowed_segment_extensions str | None

List of file extensions that hls is allowed to access (default "3gp,aac,avi,ac3,eac3,flac,mkv,m3u8,m4a,m4s,m4v,mpg,mov,mp2,mp3,mp4,mpeg,mpegts,ogg,ogv,oga,ts,vob,vtt,wav,webvtt,cmfv,cmfa,ec3,fmp4,html")

None
extension_picky bool | None

Be picky with all extensions matching (default true)

None
max_reload int | None

Maximum number of times a insufficient list is attempted to be reloaded (from 0 to INT_MAX) (default 100)

None
m3u8_hold_counters int | None

The maximum number of times to load m3u8 when it refreshes without new segments (from 0 to INT_MAX) (default 1000)

None
http_persistent bool | None

Use persistent HTTP connections (default true)

None
http_multiple bool | None

Use multiple HTTP connections for fetching segments (default auto)

None
http_seekable bool | None

Use HTTP partial requests, 0 = disable, 1 = enable, -1 = auto (default auto)

None
seg_format_options str | None

Set options for segment demuxer

None
seg_max_retry int | None

Maximum number of times to reload a segment on error. (from 0 to INT_MAX) (default 0)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

hnm

Cryo HNM v4

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

hxvs

HXVF/HXVS IP camera format

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

iamf

Raw Immersive Audio Model and Formats

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ico

Microsoft Windows ICO

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

idcin

id Cinematic

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

idf

idf(
    linespeed: int | None = None,
    video_size: str | None = None,
    framerate: str | None = None,
) -> FFMpegDemuxerOption

iCE Draw File

Parameters:

Name Type Description Default
linespeed int | None

set simulated line speed (bytes per second) (from 1 to INT_MAX) (default 6000)

None
video_size str | None

set video size, such as 640x480 or hd720.

None
framerate str | None

set framerate (frames per second) (default "25")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

iff

IFF (Interchange File Format)

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ifv

IFV CCTV DVR

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ilbc

iLBC storage

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

image2

image2(
    pattern_type: (
        int | None | Literal["glob", "sequence", "none"]
    ) = None,
    start_number: int | None = None,
    start_number_range: int | None = None,
    ts_from_file: (
        int | None | Literal["none", "sec", "ns"]
    ) = None,
    export_path_metadata: bool | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

image2 sequence

Parameters:

Name Type Description Default
pattern_type int | None | Literal['glob', 'sequence', 'none']

set pattern type (from 0 to INT_MAX) (default 4)

None
start_number int | None

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

None
start_number_range int | None

set range for looking at the first sequence number (from 1 to INT_MAX) (default 5)

None
ts_from_file int | None | Literal['none', 'sec', 'ns']

set frame timestamp from file's one (from 0 to 2) (default none)

None
export_path_metadata bool | None

enable metadata containing input path information (default false)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

image2pipe

image2pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped image2 sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ingenient

ingenient(
    framerate: str | None = None,
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw Ingenient MJPEG

Parameters:

Name Type Description Default
framerate str | None

(default "25")

None
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ipmovie

ipmovie() -> FFMpegDemuxerOption

Interplay MVE

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ipu

ipu(
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw IPU Video

Parameters:

Name Type Description Default
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ircam

Berkeley/IRCAM/CARL Sound Format

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

iss

Funcom ISS

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

iv8

IndigoVision 8000 video

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ivf

On2 IVF

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ivr

IVR (Internet Video Recording)

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

j2k_pipe

j2k_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped j2k sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

jacosub

jacosub() -> FFMpegDemuxerOption

JACOsub subtitle format

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

jpeg_pipe

jpeg_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped jpeg sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

jpegls_pipe

jpegls_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped jpegls sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

jpegxl_anim

jpegxl_anim() -> FFMpegDemuxerOption

Animated JPEG XL

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

jpegxl_pipe

jpegxl_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped jpegxl sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

jpegxs_pipe

jpegxs_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped jpegxs sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

jv

Bitmap Brothers JV

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

kux

kux(
    flv_metadata: bool | None = None,
    flv_full_metadata: bool | None = None,
    flv_ignore_prevtag: bool | None = None,
) -> FFMpegDemuxerOption

KUX (YouKu)

Parameters:

Name Type Description Default
flv_metadata bool | None

Allocate streams according to the onMetaData array (default false)

None
flv_full_metadata bool | None

Dump full metadata of the onMetadata (default false)

None
flv_ignore_prevtag bool | None

Ignore the Size of previous tag (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

kvag

Simon & Schuster Interactive VAG

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

laf

LAF (Limitless Audio Format)

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

lc3

LC3 (Low Complexity Communication Codec)

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

live_flv

live_flv(
    flv_metadata: bool | None = None,
    flv_full_metadata: bool | None = None,
    flv_ignore_prevtag: bool | None = None,
) -> FFMpegDemuxerOption

live RTMP FLV (Flash Video)

Parameters:

Name Type Description Default
flv_metadata bool | None

Allocate streams according to the onMetaData array (default false)

None
flv_full_metadata bool | None

Dump full metadata of the onMetadata (default false)

None
flv_ignore_prevtag bool | None

Ignore the Size of previous tag (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

lmlm4

raw lmlm4

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

loas

loas(
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

LOAS AudioSyncStream

Parameters:

Name Type Description Default
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

lrc

LRC lyrics

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

luodat

luodat() -> FFMpegDemuxerOption

Video CCTV DAT

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

lvf

LVF

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

lxf

VR native stream (LXF)

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

m4v

m4v(
    framerate: str | None = None,
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw MPEG-4 video

Parameters:

Name Type Description Default
framerate str | None

(default "25")

None
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mca

MCA Audio Format

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mcc

mcc(
    eia608_extract: bool | None = None,
) -> FFMpegDemuxerOption

MacCaption

Parameters:

Name Type Description Default
eia608_extract bool | None

extract EIA-608/708 captions from VANC packets (default true)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mgsts

Metal Gear Solid: The Twin Snakes

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

microdvd

microdvd(subfps: str | None = None) -> FFMpegDemuxerOption

MicroDVD subtitle format

Parameters:

Name Type Description Default
subfps str | None

set the movie frame rate fallback (from 0 to INT_MAX) (default 0/1)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mjpeg

mjpeg(
    framerate: str | None = None,
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw MJPEG video

Parameters:

Name Type Description Default
framerate str | None

(default "25")

None
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mjpeg_2000

mjpeg_2000(
    framerate: str | None = None,
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw MJPEG 2000 video

Parameters:

Name Type Description Default
framerate str | None

(default "25")

None
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mlp

mlp(
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw MLP

Parameters:

Name Type Description Default
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mlv

Magic Lantern Video (MLV)

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mm

American Laser Games MM

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mmf

Yamaha SMAF

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mods

MobiClip MODS

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

moflex

moflex() -> FFMpegDemuxerOption

MobiClip MOFLEX

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mp3

mp3(usetoc: bool | None = None) -> FFMpegDemuxerOption

MP2/3 (MPEG audio layer 2/3)

Parameters:

Name Type Description Default
usetoc bool | None

use table of contents (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mpc

Musepack

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mpc8

Musepack SV8

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mpeg

MPEG-PS (MPEG-2 Program Stream)

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mpegts

mpegts(
    resync_size: int | None = None,
    fix_teletext_pts: bool | None = None,
    scan_all_pmts: bool | None = None,
    skip_unknown_pmt: bool | None = None,
    merge_pmt_versions: bool | None = None,
    max_packet_size: int | None = None,
) -> FFMpegDemuxerOption

MPEG-TS (MPEG-2 Transport Stream)

Parameters:

Name Type Description Default
resync_size int | None

set size limit for looking up a new synchronization (from 0 to INT_MAX) (default 65536)

None
fix_teletext_pts bool | None

try to fix pts values of dvb teletext streams (default true)

None
scan_all_pmts bool | None

scan and combine all PMTs (default auto)

None
skip_unknown_pmt bool | None

skip PMTs for programs not advertised in the PAT (default false)

None
merge_pmt_versions bool | None

reuse streams when PMT's version/pids change (default false)

None
max_packet_size int | None

maximum size of emitted packet (from 184 to 1.07374e+09) (default 204800)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mpegtsraw

mpegtsraw(
    resync_size: int | None = None,
    compute_pcr: bool | None = None,
) -> FFMpegDemuxerOption

raw MPEG-TS (MPEG-2 Transport Stream)

Parameters:

Name Type Description Default
resync_size int | None

set size limit for looking up a new synchronization (from 0 to INT_MAX) (default 65536)

None
compute_pcr bool | None

compute exact PCR for each transport stream packet (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mpegvideo

mpegvideo(
    framerate: str | None = None,
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw MPEG video

Parameters:

Name Type Description Default
framerate str | None

(default "25")

None
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mpjpeg

mpjpeg(
    strict_mime_boundary: bool | None = None,
) -> FFMpegDemuxerOption

MIME multipart JPEG

Parameters:

Name Type Description Default
strict_mime_boundary bool | None

require MIME boundaries match (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mpl2

MPL2 subtitles

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mpsub

MPlayer subtitles

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

msf

Sony PS3 MSF

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

msnwctcp

msnwctcp() -> FFMpegDemuxerOption

MSN TCP Webcam stream

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

msp

Microsoft Paint (MSP))

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mtaf

Konami PS2 MTAF

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mtv

MTV

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mulaw

mulaw(
    sample_rate: int | None = None,
    ch_layout: str | None = None,
) -> FFMpegDemuxerOption

PCM mu-law

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
ch_layout str | None

(default "mono")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

musx

Eurocom MUSX

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mv

Silicon Graphics Movie

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mvi

Motion Pixels MVI

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mxf

mxf(
    eia608_extract: bool | None = None,
) -> FFMpegDemuxerOption

MXF (Material eXchange Format)

Parameters:

Name Type Description Default
eia608_extract bool | None

extract eia 608 captions from s436m track (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mxg

MxPEG clip

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

nc

NC camera feed

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

nistsphere

nistsphere() -> FFMpegDemuxerOption

NIST SPeech HEader REsources

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

nsp

Computerized Speech Lab NSP

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

nsv

Nullsoft Streaming Video

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

nut

NUT

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

nuv

NuppelVideo

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

obu

obu(framerate: str | None = None) -> FFMpegDemuxerOption

AV1 low overhead OBU

Parameters:

Name Type Description Default
framerate str | None

(default "25")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ogg

Ogg

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

oma

Sony OpenMG audio

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

osq

osq(
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw OSQ

Parameters:

Name Type Description Default
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

paf

Amazing Studio Packed Animation File

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

pam_pipe

pam_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped pam sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

pbm_pipe

pbm_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped pbm sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

pcx_pipe

pcx_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped pcx sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

pdv

PlayDate Video

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

pfm_pipe

pfm_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped pfm sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

pgm_pipe

pgm_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped pgm sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

pgmyuv_pipe

pgmyuv_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped pgmyuv sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

pgx_pipe

pgx_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped pgx sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

phm_pipe

phm_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped phm sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

photocd_pipe

photocd_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped photocd sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

pictor_pipe

pictor_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped pictor sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

pjs

PJS (Phoenix Japanimation Society) subtitles

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

pmp

Playstation Portable PMP

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

png_pipe

png_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped png sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

pp_bnk

pp_bnk() -> FFMpegDemuxerOption

Pro Pinball Series Soundbank

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ppm_pipe

ppm_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped ppm sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

psd_pipe

psd_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped psd sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

psxstr

psxstr() -> FFMpegDemuxerOption

Sony Playstation STR

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

pva

TechnoTrend PVA

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

pvf

PVF (Portable Voice Format)

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

qcp

QCP

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

qdraw_pipe

qdraw_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped qdraw sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

qoa

QOA

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

qoi_pipe

qoi_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped qoi sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

r3d

REDCODE R3D

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

rawvideo

rawvideo(
    stride: int | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    framerate: str | None = None,
) -> FFMpegDemuxerOption

raw video

Parameters:

Name Type Description Default
stride int | None

frame line size in bytes

None
pixel_format str | None

set pixel format (default yuv420p)

None
video_size str | None

set frame size

None
framerate str | None

set frame rate (default "25")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

rcwt

RCWT (Raw Captions With Time)

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

realtext

realtext() -> FFMpegDemuxerOption

RealText subtitle format

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

redspark

redspark() -> FFMpegDemuxerOption

RedSpark

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

rka

RKA (RK Audio)

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

rl2

RL2

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

rm

RealMedia

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

roq

id RoQ

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

rpl

RPL / ARMovie

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

rsd

GameCube RSD

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

rso

Lego Mindstorms RSO

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

rtp

rtp(
    rtp_flags: str | None = None,
    listen_timeout: str | None = None,
    localaddr: str | None = None,
    allowed_media_types: str | None = None,
    reorder_queue_size: int | None = None,
    buffer_size: int | None = None,
) -> FFMpegDemuxerOption

RTP input

Parameters:

Name Type Description Default
rtp_flags str | None

set RTP flags (default 0)

None
listen_timeout str | None

set maximum timeout (in seconds) to wait for incoming connections (default 10)

None
localaddr str | None

local address

None
allowed_media_types str | None

set media types to accept from the server (default video+audio+data+subtitle)

None
reorder_queue_size int | None

set number of packets to buffer for handling of reordered packets (from -1 to INT_MAX) (default -1)

None
buffer_size int | None

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

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

rtsp

rtsp(
    initial_pause: bool | None = None,
    rtsp_transport: str | None = None,
    rtsp_flags: str | None = None,
    allowed_media_types: str | None = None,
    min_port: int | None = None,
    max_port: int | None = None,
    listen_timeout: int | None = None,
    timeout: int | None = None,
    reorder_queue_size: int | None = None,
    buffer_size: int | None = None,
    user_agent: str | None = None,
    ca_file: str | None = None,
    tls_verify: bool | None = None,
    cert_file: str | None = None,
    key_file: str | None = None,
    verifyhost: str | None = None,
) -> FFMpegDemuxerOption

RTSP input

Parameters:

Name Type Description Default
initial_pause bool | None

do not start playing the stream immediately (default false)

None
rtsp_transport str | None

set RTSP transport protocols (default 0)

None
rtsp_flags str | None

set RTSP flags (default 0)

None
allowed_media_types str | None

set media types to accept from the server (default video+audio+data+subtitle)

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
listen_timeout int | None

set maximum timeout (in seconds) to wait for incoming connections (-1 is infinite, imply flag listen) (from INT_MIN to INT_MAX) (default -1)

None
timeout int | None

set timeout (in microseconds) of socket I/O operations (from INT_MIN to I64_MAX) (default 0)

None
reorder_queue_size int | None

set number of packets to buffer for handling of reordered packets (from -1 to INT_MAX) (default -1)

None
buffer_size int | None

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

None
user_agent str | None

override User-Agent header (default "Lavf63.1.101")

None
ca_file str | None

Certificate Authority database file

None
tls_verify bool | None

Verify the peer certificate (default true)

None
cert_file str | None

Certificate file

None
key_file str | None

Private key file

None
verifyhost str | None

Verify against a specific hostname

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

s16be

s16be(
    sample_rate: int | None = None,
    ch_layout: str | None = None,
) -> FFMpegDemuxerOption

PCM signed 16-bit big-endian

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
ch_layout str | None

(default "mono")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

s16le

s16le(
    sample_rate: int | None = None,
    ch_layout: str | None = None,
) -> FFMpegDemuxerOption

PCM signed 16-bit little-endian

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
ch_layout str | None

(default "mono")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

s24be

s24be(
    sample_rate: int | None = None,
    ch_layout: str | None = None,
) -> FFMpegDemuxerOption

PCM signed 24-bit big-endian

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
ch_layout str | None

(default "mono")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

s24le

s24le(
    sample_rate: int | None = None,
    ch_layout: str | None = None,
) -> FFMpegDemuxerOption

PCM signed 24-bit little-endian

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
ch_layout str | None

(default "mono")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

s32be

s32be(
    sample_rate: int | None = None,
    ch_layout: str | None = None,
) -> FFMpegDemuxerOption

PCM signed 32-bit big-endian

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
ch_layout str | None

(default "mono")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

s32le

s32le(
    sample_rate: int | None = None,
    ch_layout: str | None = None,
) -> FFMpegDemuxerOption

PCM signed 32-bit little-endian

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
ch_layout str | None

(default "mono")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

s337m

SMPTE 337M

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

s8

s8(
    sample_rate: int | None = None,
    ch_layout: str | None = None,
) -> FFMpegDemuxerOption

PCM signed 8-bit

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
ch_layout str | None

(default "mono")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

sami

SAMI subtitle format

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

sap

SAP input

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

sbc

sbc(
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw SBC (low-complexity subband codec)

Parameters:

Name Type Description Default
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

sbg

sbg(
    sample_rate: int | None = None,
    max_file_size: int | None = None,
) -> FFMpegDemuxerOption

SBaGen binaural beats script

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 0)

None
max_file_size int | None

(from 0 to INT_MAX) (default 5000000)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

scc

Scenarist Closed Captions

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

scd

Square Enix SCD

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

sdns

Xbox SDNS

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

sdp

sdp(
    sdp_flags: str | None = None,
    listen_timeout: str | None = None,
    localaddr: str | None = None,
    allowed_media_types: str | None = None,
    reorder_queue_size: int | None = None,
    buffer_size: int | None = None,
) -> FFMpegDemuxerOption

SDP

Parameters:

Name Type Description Default
sdp_flags str | None

SDP flags (default 0)

None
listen_timeout str | None

set maximum timeout (in seconds) to wait for incoming connections (default 10)

None
localaddr str | None

local address

None
allowed_media_types str | None

set media types to accept from the server (default video+audio+data+subtitle)

None
reorder_queue_size int | None

set number of packets to buffer for handling of reordered packets (from -1 to INT_MAX) (default -1)

None
buffer_size int | None

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

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

sdr2

SDR2

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

sds

MIDI Sample Dump Standard

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

sdx

Sample Dump eXchange

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ser

ser(framerate: str | None = None) -> FFMpegDemuxerOption

SER (Simple uncompressed video format for astronomical capturing)

Parameters:

Name Type Description Default
framerate str | None

set frame rate (default "25")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

sga

Digital Pictures SGA

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

sgi_pipe

sgi_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped sgi sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

shn

shn(
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw Shorten

Parameters:

Name Type Description Default
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

siff

Beam Software SIFF

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

simbiosis_imx

simbiosis_imx() -> FFMpegDemuxerOption

Simbiosis Interactive IMX

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

sln

sln(
    sample_rate: int | None = None,
    ch_layout: str | None = None,
) -> FFMpegDemuxerOption

Asterisk raw pcm

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 8000)

None
ch_layout str | None

(default "mono")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

smjpeg

smjpeg() -> FFMpegDemuxerOption

Loki SDL MJPEG

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

smk

Smacker

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

smush

LucasArts Smush

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

sol

Sierra SOL

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

sox

SoX (Sound eXchange) native

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

spdif

IEC 61937 (compressed data in S/PDIF)

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

srt

SubRip subtitle

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

stl

Spruce subtitle format

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

subviewer

subviewer() -> FFMpegDemuxerOption

SubViewer subtitle format

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

subviewer1

subviewer1() -> FFMpegDemuxerOption

SubViewer v1 subtitle format

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

sunrast_pipe

sunrast_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped sunrast sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

sup

raw HDMV Presentation Graphic Stream subtitles

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

svag

Konami PS2 SVAG

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

svg_pipe

svg_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped svg sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

svs

Square SVS

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

swf

SWF (ShockWave Flash)

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

tak

tak(
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw TAK

Parameters:

Name Type Description Default
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

tedcaptions

tedcaptions(
    start_time: int | None = None,
) -> FFMpegDemuxerOption

TED Talks captions

Parameters:

Name Type Description Default
start_time int | None

set the start time (offset) of the subtitles, in ms (from I64_MIN to I64_MAX) (default 15000)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

thp

THP

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

tiertexseq

tiertexseq() -> FFMpegDemuxerOption

Tiertex Limited SEQ

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

tiff_pipe

tiff_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped tiff sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

tmv

8088flex TMV

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

truehd

truehd(
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw TrueHD

Parameters:

Name Type Description Default
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

tta

TTA (True Audio)

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

tty

tty(
    chars_per_frame: int | None = None,
    video_size: str | None = None,
    framerate: str | None = None,
) -> FFMpegDemuxerOption

Tele-typewriter

Parameters:

Name Type Description Default
chars_per_frame int | None

(from 1 to INT_MAX) (default 6000)

None
video_size str | None

A string describing frame size, such as 640x480 or hd720.

None
framerate str | None

(default "25")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

txd

Renderware TeXture Dictionary

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ty

TiVo TY Stream

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

u16be

u16be(
    sample_rate: int | None = None,
    ch_layout: str | None = None,
) -> FFMpegDemuxerOption

PCM unsigned 16-bit big-endian

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
ch_layout str | None

(default "mono")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

u16le

u16le(
    sample_rate: int | None = None,
    ch_layout: str | None = None,
) -> FFMpegDemuxerOption

PCM unsigned 16-bit little-endian

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
ch_layout str | None

(default "mono")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

u24be

u24be(
    sample_rate: int | None = None,
    ch_layout: str | None = None,
) -> FFMpegDemuxerOption

PCM unsigned 24-bit big-endian

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
ch_layout str | None

(default "mono")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

u24le

u24le(
    sample_rate: int | None = None,
    ch_layout: str | None = None,
) -> FFMpegDemuxerOption

PCM unsigned 24-bit little-endian

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
ch_layout str | None

(default "mono")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

u32be

u32be(
    sample_rate: int | None = None,
    ch_layout: str | None = None,
) -> FFMpegDemuxerOption

PCM unsigned 32-bit big-endian

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
ch_layout str | None

(default "mono")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

u32le

u32le(
    sample_rate: int | None = None,
    ch_layout: str | None = None,
) -> FFMpegDemuxerOption

PCM unsigned 32-bit little-endian

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
ch_layout str | None

(default "mono")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

u8

u8(
    sample_rate: int | None = None,
    ch_layout: str | None = None,
) -> FFMpegDemuxerOption

PCM unsigned 8-bit

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
ch_layout str | None

(default "mono")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

usm

CRI USM

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

v210

v210(
    video_size: str | None = None,
    framerate: str | None = None,
) -> FFMpegDemuxerOption

Uncompressed 4:2:2 10-bit

Parameters:

Name Type Description Default
video_size str | None

set frame size

None
framerate str | None

set frame rate (default "25")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

v210x

v210x(
    video_size: str | None = None,
    framerate: str | None = None,
) -> FFMpegDemuxerOption

Uncompressed 4:2:2 10-bit

Parameters:

Name Type Description Default
video_size str | None

set frame size

None
framerate str | None

set frame rate (default "25")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

vag

Sony PS2 VAG

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

vbn_pipe

vbn_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped vbn sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

vc1

vc1(
    framerate: str | None = None,
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw VC-1

Parameters:

Name Type Description Default
framerate str | None

(default "25")

None
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

vc1test

vc1test() -> FFMpegDemuxerOption

VC-1 test bitstream

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

vidc

vidc(
    sample_rate: int | None = None,
    ch_layout: str | None = None,
) -> FFMpegDemuxerOption

PCM Archimedes VIDC

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
ch_layout str | None

(default "mono")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

vividas

vividas() -> FFMpegDemuxerOption

Vividas VIV

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

vivo

Vivo

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

vmd

Sierra VMD

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

vobsub

vobsub(sub_name: str | None = None) -> FFMpegDemuxerOption

VobSub subtitle format

Parameters:

Name Type Description Default
sub_name str | None

URI for .sub file

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

voc

Creative Voice

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

vpk

Sony PS2 VPK

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

vplayer

vplayer() -> FFMpegDemuxerOption

VPlayer subtitles

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

vqf

Nippon Telegraph and Telephone Corporation (NTT) TwinVQ

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

vvc

vvc(
    framerate: str | None = None,
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

raw H.266/VVC video

Parameters:

Name Type Description Default
framerate str | None

(default "25")

None
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

w64

w64(max_size: int | None = None) -> FFMpegDemuxerOption

Sony Wave64

Parameters:

Name Type Description Default
max_size int | None

max size of single packet (from 0 to 4.1943e+06) (default 0)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

wady

Marble WADY

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

wav

wav(
    ignore_length: bool | None = None,
    max_size: int | None = None,
) -> FFMpegDemuxerOption

WAV / WAVE (Waveform Audio)

Parameters:

Name Type Description Default
ignore_length bool | None

Ignore length (default false)

None
max_size int | None

max size of single packet (from 0 to 4.1943e+06) (default 0)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

wavarc

wavarc() -> FFMpegDemuxerOption

Waveform Archiver

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

wc3movie

wc3movie() -> FFMpegDemuxerOption

Wing Commander III movie

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

webm_dash_manifest

webm_dash_manifest(
    live: bool | None = None, bandwidth: int | None = None
) -> FFMpegDemuxerOption

WebM DASH Manifest

Parameters:

Name Type Description Default
live bool | None

flag indicating that the input is a live file that only has the headers. (default false)

None
bandwidth int | None

bandwidth of this stream to be specified in the DASH manifest. (from 0 to INT_MAX) (default 0)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

webp_anim

webp_anim(
    min_delay: int | None = None,
    max_webp_delay: int | None = None,
    default_delay: int | None = None,
    ignore_loop: bool | None = None,
    usebgcolor: bool | None = None,
) -> FFMpegDemuxerOption

Animated WebP

Parameters:

Name Type Description Default
min_delay int | None

minimum valid delay between frames (in milliseconds) (from 0 to 60000) (default 10)

None
max_webp_delay int | None

maximum valid delay between frames (in milliseconds) (from 0 to 1.67772e+07) (default 16777215)

None
default_delay int | None

default delay between frames (in milliseconds) (from 0 to 60000) (default 100)

None
ignore_loop bool | None

ignore loop setting (default true)

None
usebgcolor bool | None

use background color from ANIM chunk (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

webp_pipe

webp_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped webp sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

webvtt

webvtt(
    kind: (
        int
        | None
        | Literal[
            "subtitles",
            "captions",
            "descriptions",
            "metadata",
        ]
    ) = None,
) -> FFMpegDemuxerOption

WebVTT subtitle

Parameters:

Name Type Description Default
kind int | None | Literal['subtitles', 'captions', 'descriptions', 'metadata']

Set kind of WebVTT track (from 0 to INT_MAX) (default subtitles)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

wsaud

Westwood Studios audio

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

wsd

wsd(
    raw_packet_size: int | None = None,
) -> FFMpegDemuxerOption

Wideband Single-bit Data (WSD)

Parameters:

Name Type Description Default
raw_packet_size int | None

(from 1 to INT_MAX) (default 1024)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

wsvqa

Westwood Studios VQA

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

wtv

Windows Television (WTV)

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

wv

WavPack

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

wve

Psion 3 audio

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

xa

Maxis XA

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

xbin

xbin(
    linespeed: int | None = None,
    video_size: str | None = None,
    framerate: str | None = None,
) -> FFMpegDemuxerOption

eXtended BINary text (XBIN)

Parameters:

Name Type Description Default
linespeed int | None

set simulated line speed (bytes per second) (from 1 to INT_MAX) (default 6000)

None
video_size str | None

set video size, such as 640x480 or hd720.

None
framerate str | None

set framerate (frames per second) (default "25")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

xbm_pipe

xbm_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped xbm sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

xmd

Konami XMD

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

xmv

Microsoft XMV

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

xpm_pipe

xpm_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped xpm sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

xvag

Sony PS3 XVAG

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

xwd_pipe

xwd_pipe(
    frame_size: int | None = None,
    framerate: str | None = None,
    pixel_format: str | None = None,
    video_size: str | None = None,
    loop: bool | None = None,
) -> FFMpegDemuxerOption

piped xwd sequence

Parameters:

Name Type Description Default
frame_size int | None

force frame size in bytes (from 0 to INT_MAX) (default 0)

None
framerate str | None

set the video framerate (default "25")

None
pixel_format str | None

set video pixel format

None
video_size str | None

set video size

None
loop bool | None

force loop over input file sequence (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

xwma

Microsoft xWMA

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

yop

Psygnosis YOP

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

yuv4mpegpipe

yuv4mpegpipe() -> FFMpegDemuxerOption

YUV4MPEG pipe

Returns:

Type Description
FFMpegDemuxerOption

the set codec options