Skip to content

demuxers

FFmpeg demuxers.

Functions:

Name Description
aa

aa

aac

aac

aax

aax

ac3

ac3

ac4

ac4

ace

ace

acm

acm

act

ACT Voice file format

adf

adf

adp

adp

ads

ads

adx

adx

aea

aea

afc

afc

aiff

aiff

aix

aix

alaw

alaw

alias_pix

alias_pix

alp

alp

alsa

alsa

amr

amr

amrnb

amrnb

amrwb

amrwb

anm

anm

apac

apac

apc

apc

ape

ape

apm

apm

apng

apng

aptx

aptx

aptx_hd

aptx_hd

aqtitle

aqtitle

argo_asf

argo_asf

argo_brp

argo_brp

argo_cvg

argo_cvg

asf

asf

asf_o

asf_o

ass

ass

ast

ast

au

au

av1

av1

avi

avi

avr

avr

avs

avs

avs2

avs2

avs3

avs3

bethsoftvid

bethsoftvid

bfi

bfi

bfstm

bfstm

bin

bin

bink

bink

binka

binka

bit

bit

bitpacked

bitpacked

bmp_pipe

bmp_pipe

bmv

bmv

boa

boa

bonk

bonk

brender_pix

brender_pix

brstm

brstm

c93

c93

caf

caf

cavsvideo

cavsvideo

cdg

cdg

cdxl

cdxl

cine

cine

codec2

codec2

codec2raw

codec2raw

concat

concat

cri_pipe

cri_pipe

data

data

daud

daud

dcstr

dcstr

dds_pipe

dds_pipe

derf

derf

dfa

dfa

dfpwm

dfpwm

dhav

dhav

dirac

dirac

dnxhd

dnxhd

dpx_pipe

dpx_pipe

dsf

dsf

dsicin

dsicin

dss

dss

dts

dts

dtshd

dtshd

dv

dv

dvbsub

dvbsub

dvbtxt

dvbtxt

dxa

dxa

ea

ea

ea_cdata

ea_cdata

eac3

eac3

epaf

epaf

evc

evc

exr_pipe

exr_pipe

f32be

f32be

f32le

f32le

f64be

f64be

f64le

f64le

fbdev

fbdev

ffmetadata

ffmetadata

film_cpk

film_cpk

filmstrip

filmstrip

fits

fits

flac

flac

flic

flic

flv

flv

frm

frm

fsb

fsb

fwse

fwse

g722

g722

g723_1

g723_1

g726

g726

g726le

g726le

g729

g729

gdv

gdv

gem_pipe

gem_pipe

genh

genh

gif

gif

gif_pipe

gif_pipe

gsm

gsm

gxf

gxf

h261

h261

h263

h263

h264

h264

hca

hca

hcom

hcom

hdr_pipe

hdr_pipe

hevc

hevc

hls

hls

hnm

hnm

ico

ico

idcin

idcin

idf

idf

iff

iff

ifv

ifv

ilbc

ilbc

image2

image2

image2pipe

image2pipe

ingenient

ingenient

ipmovie

ipmovie

ipu

ipu

ircam

ircam

iss

iss

iv8

iv8

ivf

ivf

ivr

ivr

j2k_pipe

j2k_pipe

jacosub

jacosub

jpeg_pipe

jpeg_pipe

jpegls_pipe

jpegls_pipe

jpegxl_anim

jpegxl_anim

jpegxl_pipe

jpegxl_pipe

jv

jv

kux

kux

kvag

kvag

laf

laf

lavfi

lavfi

live_flv

live_flv

lmlm4

lmlm4

loas

loas

lrc

lrc

luodat

luodat

lvf

lvf

lxf

lxf

m4v

m4v

mca

mca

mcc

mcc

mgsts

mgsts

microdvd

microdvd

mjpeg

mjpeg

mjpeg_2000

mjpeg_2000

mlp

mlp

mlv

mlv

mm

mm

mmf

mmf

mods

mods

moflex

moflex

mp3

mp3

mpc

mpc

mpc8

mpc8

mpeg

mpeg

mpegts

mpegts

mpegtsraw

mpegtsraw

mpegvideo

mpegvideo

mpjpeg

mpjpeg

mpl2

mpl2

mpsub

mpsub

msf

msf

msnwctcp

msnwctcp

msp

msp

mtaf

mtaf

mtv

mtv

mulaw

mulaw

musx

musx

mv

mv

mvi

mvi

mxf

mxf

mxg

mxg

nc

nc

nistsphere

nistsphere

nsp

nsp

nsv

nsv

nut

nut

nuv

nuv

obu

obu

ogg

ogg

oma

oma

osq

osq

oss

oss

paf

paf

pam_pipe

pam_pipe

pbm_pipe

pbm_pipe

pcx_pipe

pcx_pipe

pdv

pdv

pfm_pipe

pfm_pipe

pgm_pipe

pgm_pipe

pgmyuv_pipe

pgmyuv_pipe

pgx_pipe

pgx_pipe

phm_pipe

phm_pipe

photocd_pipe

photocd_pipe

pictor_pipe

pictor_pipe

pjs

pjs

pmp

pmp

png_pipe

png_pipe

pp_bnk

pp_bnk

ppm_pipe

ppm_pipe

psd_pipe

psd_pipe

psxstr

psxstr

pva

pva

pvf

pvf

qcp

qcp

qdraw_pipe

qdraw_pipe

qoi_pipe

qoi_pipe

r3d

r3d

rawvideo

rawvideo

realtext

realtext

redspark

redspark

rka

rka

rl2

rl2

rm

rm

roq

roq

rpl

rpl

rsd

rsd

rso

rso

rtp

rtp

rtsp

rtsp

s16be

s16be

s16le

s16le

s24be

s24be

s24le

s24le

s32be

s32be

s32le

s32le

s337m

s337m

s8

s8

sami

sami

sap

sap

sbc

sbc

sbg

sbg

scc

scc

scd

scd

sdns

sdns

sdp

sdp

sdr2

sdr2

sds

sds

sdx

sdx

ser

ser

sga

sga

sgi_pipe

sgi_pipe

shn

shn

siff

siff

simbiosis_imx

simbiosis_imx

sln

sln

smjpeg

smjpeg

smk

smk

smush

smush

sndio

sndio

sol

sol

sox

sox

spdif

spdif

srt

srt

stl

stl

subviewer

subviewer

subviewer1

subviewer1

sunrast_pipe

sunrast_pipe

sup

sup

svag

svag

svg_pipe

svg_pipe

svs

svs

swf

swf

tak

tak

tedcaptions

tedcaptions

thp

thp

tiertexseq

tiertexseq

tiff_pipe

tiff_pipe

tmv

tmv

truehd

truehd

tta

tta

tty

tty

txd

txd

ty

ty

u16be

u16be

u16le

u16le

u24be

u24be

u24le

u24le

u32be

u32be

u32le

u32le

u8

u8

usm

usm

v210

v210

v210x

v210x

vag

vag

vbn_pipe

vbn_pipe

vc1

vc1

vc1test

vc1test

vidc

vidc

vividas

vividas

vivo

vivo

vmd

vmd

vobsub

vobsub

voc

voc

vpk

vpk

vplayer

vplayer

vqf

vqf

vvc

vvc

w64

w64

wady

wady

wav

wav

wavarc

wavarc

wc3movie

wc3movie

webm_dash_manifest

webm_dash_manifest

webp_pipe

webp_pipe

webvtt

webvtt

wsaud

wsaud

wsd

wsd

wsvqa

wsvqa

wtv

wtv

wv

wv

wve

wve

x11grab

x11grab

xa

xa

xbin

xbin

xbm_pipe

xbm_pipe

xmd

xmd

xmv

xmv

xpm_pipe

xpm_pipe

xvag

xvag

xwd_pipe

xwd_pipe

xwma

xwma

yop

yop

yuv4mpegpipe

yuv4mpegpipe

aa

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

aa

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

aac

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

aax

aax

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ac3

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

ac3

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

ac4

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ace

ace

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

acm

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

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

adf

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

ads

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

adx

adx

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

aea

aea

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

afc

afc

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

aiff

aiff

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

aix

aix

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

alaw

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

alaw

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
channels int | None

(from 0 to INT_MAX) (default 1)

None
ch_layout str | None
None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

alias_pix

alias_pix(
    pattern_type: (
        int
        | None
        | Literal[
            "glob_sequence", "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_pix

Parameters:

Name Type Description Default
pattern_type int | None | Literal['glob_sequence', '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

alp

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

alsa

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

alsa

Parameters:

Name Type Description Default
sample_rate int | None

(from 1 to INT_MAX) (default 48000)

None
channels int | None

(from 1 to INT_MAX) (default 2)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

amr

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

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

amrnb

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

amrwb

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

anm

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

apac

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

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

apc

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ape

ape

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

apm

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

apng

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

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

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

aqtitle

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

aqtitle

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

argo_asf

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

argo_brp

argo_brp() -> FFMpegDemuxerOption

argo_brp

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

argo_cvg

argo_cvg() -> FFMpegDemuxerOption

argo_cvg

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

asf

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

asf

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_o

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ass

ass

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ast

ast

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

au

au

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

av1

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

av1

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

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

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

avs

avs

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

avs2

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

avs2

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

avs3

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

bethsoftvid

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

bfi

bfi

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

bfstm

bfstm

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

bin

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

bin

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

binka

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

bit

bit

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

bmp_pipe

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

bmv

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

boa

boa

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

bonk

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

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", "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

Parameters:

Name Type Description Default
pattern_type int | None | Literal['glob_sequence', '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

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

c93

c93

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

caf

caf

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

cavsvideo

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

cavsvideo

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

cdg

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

cdxl

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

cdxl

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

cine

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

codec2

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

codec2

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

codec2raw

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,
) -> FFMpegDemuxerOption

concat

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

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

cri_pipe

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

data

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

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

daud

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

dcstr

dcstr

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

dds_pipe

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

derf

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

dfa

dfa

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

dfpwm

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

dfpwm

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 48000)

None
channels int | None

(from 0 to INT_MAX) (default 1)

None
ch_layout str | None
None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

dhav

dhav

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

dirac

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

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

dnxhd

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

dpx_pipe

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

dsf

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

dsicin

dsicin() -> FFMpegDemuxerOption

dsicin

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

dss

dss

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

dts

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

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

dtshd

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

dv

dv

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

dvbsub

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

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

ea

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

ea_cdata

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

eac3

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

eac3

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

epaf

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

evc

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

evc

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

exr_pipe

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,
    channels: int | None = None,
    ch_layout: str | None = None,
) -> FFMpegDemuxerOption

f32be

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
channels int | None

(from 0 to INT_MAX) (default 1)

None
ch_layout str | None
None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

f32le

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

f32le

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
channels int | None

(from 0 to INT_MAX) (default 1)

None
ch_layout str | None
None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

f64be

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

f64be

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
channels int | None

(from 0 to INT_MAX) (default 1)

None
ch_layout str | None
None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

f64le

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

f64le

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
channels int | None

(from 0 to INT_MAX) (default 1)

None
ch_layout str | None
None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

fbdev

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

fbdev

Parameters:

Name Type Description Default
framerate str | None

(default "25")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ffmetadata

ffmetadata() -> FFMpegDemuxerOption

ffmetadata

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

film_cpk

film_cpk() -> FFMpegDemuxerOption

film_cpk

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

filmstrip

filmstrip() -> FFMpegDemuxerOption

filmstrip

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

fits

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

fits

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

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

flic

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,
    missing_streams: int | None = None,
) -> FFMpegDemuxerOption

flv

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

(from 0 to 255) (default 0)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

frm

frm

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

fsb

fsb

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

fwse

fwse

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

g722

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

g722

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

g723_1

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

g726

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

g726

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

g726le

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

g729

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

g729

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

gdv

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

gem_pipe

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

genh

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

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

gif_pipe

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

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

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

h261

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

h261

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

h263

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

h264

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

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

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

hdr_pipe

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

hevc

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,
    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

hls

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,wav")

None
max_reload int | None

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

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

hnm

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ico

ico

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

idcin

idcin

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

idf

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

idf

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

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ifv

ifv

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ilbc

ilbc

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

image2

image2(
    pattern_type: (
        int
        | None
        | Literal[
            "glob_sequence", "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

Parameters:

Name Type Description Default
pattern_type int | None | Literal['glob_sequence', '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

image2pipe

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

ingenient

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

ipmovie

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ipu

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

ipu

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

ircam

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

iss

iss

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

iv8

iv8

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ivf

ivf

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ivr

ivr

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

j2k_pipe

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

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

jpeg_pipe

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

jpegls_pipe

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

jpegxl_anim

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

jpegxl_pipe

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

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,
    missing_streams: int | None = None,
) -> FFMpegDemuxerOption

kux

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

(from 0 to 255) (default 0)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

kvag

kvag

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

laf

laf

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

lavfi

lavfi(
    graph: str | None = None,
    graph_file: str | None = None,
    dumpgraph: str | None = None,
) -> FFMpegDemuxerOption

lavfi

Parameters:

Name Type Description Default
graph str | None

set libavfilter graph

None
graph_file str | None

set libavfilter graph filename

None
dumpgraph str | None

dump graph to stderr

None

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,
    missing_streams: int | None = None,
) -> FFMpegDemuxerOption

live_flv

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

(from 0 to 255) (default 0)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

lmlm4

lmlm4

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

loas

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

loas

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

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

luodat

luodat() -> FFMpegDemuxerOption

luodat

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

lvf

lvf

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

lxf

lxf

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

m4v

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

m4v

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

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mcc

mcc

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mgsts

mgsts

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

microdvd

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

microdvd

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

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

mjpeg_2000

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

mjpeg_2000

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

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

mlv

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mm

mm

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mmf

mmf

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mods

mods

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

moflex

moflex() -> FFMpegDemuxerOption

moflex

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mp3

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

mp3

Parameters:

Name Type Description Default
usetoc bool | None

use table of contents (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mpc

mpc

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mpc8

mpc8

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mpeg

mpeg

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mpegts

mpegts(
    resync_size: int | None = None,
    fix_teletext_pts: bool | None = None,
    ts_packetsize: int | 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

mpegts

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

output option carrying the raw packet size (from 0 to 0) (default 0)

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

re-use streams when PMT's version/pids change (default false)

None
max_packet_size int | None

maximum size of emitted packet (from 1 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,
    ts_packetsize: int | None = None,
) -> FFMpegDemuxerOption

mpegtsraw

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

output option carrying the raw packet size (from 0 to 0) (default 0)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mpegvideo

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

mpegvideo

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

mpjpeg

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

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mpsub

mpsub

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

msf

msf

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

msnwctcp

msnwctcp() -> FFMpegDemuxerOption

msnwctcp

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

msp

msp

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mtaf

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,
    channels: int | None = None,
    ch_layout: str | None = None,
) -> FFMpegDemuxerOption

mulaw

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
channels int | None

(from 0 to INT_MAX) (default 1)

None
ch_layout str | None
None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

musx

musx

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mv

mv

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mvi

mvi

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

mxf

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

mxf

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

mxg

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

nc

nc

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

nistsphere

nistsphere() -> FFMpegDemuxerOption

nistsphere

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

nsp

nsp

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

nsv

nsv

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

nut

nut

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

nuv

nuv

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

obu

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

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

oma

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

osq

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

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

oss

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

oss

Parameters:

Name Type Description Default
sample_rate int | None

(from 1 to INT_MAX) (default 48000)

None
channels int | None

(from 1 to INT_MAX) (default 2)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

paf

paf

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

pam_pipe

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

pbm_pipe

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

pcx_pipe

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

pdv

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

pfm_pipe

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

pgm_pipe

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

pgmyuv_pipe

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

pgx_pipe

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

phm_pipe

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

photocd_pipe

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

pictor_pipe

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

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

pmp

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

png_pipe

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

pp_bnk

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

ppm_pipe

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

psd_pipe

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

psxstr

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

pva

pva

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

pvf

pvf

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

qdraw_pipe

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

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

qoi_pipe

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

r3d

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

rawvideo

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

rawvideo

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

realtext

realtext() -> FFMpegDemuxerOption

realtext

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

redspark

redspark() -> FFMpegDemuxerOption

redspark

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

rka

rka

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

rl2

rl2

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

rm

rm

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

roq

roq

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

rpl

rpl

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

rsd

rsd

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

rso

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

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,
) -> FFMpegDemuxerOption

rtsp

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 "Lavf60.16.100")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

s16be

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

s16be

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
channels int | None

(from 0 to INT_MAX) (default 1)

None
ch_layout str | None
None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

s16le

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

s16le

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
channels int | None

(from 0 to INT_MAX) (default 1)

None
ch_layout str | None
None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

s24be

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

s24be

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
channels int | None

(from 0 to INT_MAX) (default 1)

None
ch_layout str | None
None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

s24le

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

s24le

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
channels int | None

(from 0 to INT_MAX) (default 1)

None
ch_layout str | None
None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

s32be

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

s32be

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
channels int | None

(from 0 to INT_MAX) (default 1)

None
ch_layout str | None
None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

s32le

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

s32le

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
channels int | None

(from 0 to INT_MAX) (default 1)

None
ch_layout str | None
None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

s337m

s337m

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

s8

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

s8

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
channels int | None

(from 0 to INT_MAX) (default 1)

None
ch_layout str | None
None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

sami

sami

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

sap

sap

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

sbc

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

sbc

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

sbg

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

scc

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

scd

scd

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

sdns

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

sds

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

sdx

sdx

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ser

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

ser

Parameters:

Name Type Description Default
framerate str | None

set frame rate (default "25")

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

sga

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

sgi_pipe

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

shn

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

siff

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

simbiosis_imx

simbiosis_imx() -> FFMpegDemuxerOption

simbiosis_imx

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

sln

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

sln

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 8000)

None
channels int | None

(from 0 to INT_MAX) (default 1)

None
ch_layout str | None
None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

smjpeg

smjpeg() -> FFMpegDemuxerOption

smjpeg

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

smk

smk

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

smush

smush

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

sndio

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

sndio

Parameters:

Name Type Description Default
sample_rate int | None

(from 1 to INT_MAX) (default 48000)

None
channels int | None

(from 1 to INT_MAX) (default 2)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

sol

sol

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

sox

sox

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

spdif

spdif

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

srt

srt

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

stl

stl

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

subviewer

subviewer() -> FFMpegDemuxerOption

subviewer

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

subviewer1

subviewer1() -> FFMpegDemuxerOption

subviewer1

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

sunrast_pipe

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

sup

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

svag

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

svg_pipe

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

svs

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

swf

swf

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

tak

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

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

tedcaptions

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

tiertexseq

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

tiff_pipe

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

tmv

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

truehd

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

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

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

tty

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

txd

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

ty

ty

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

u16be

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

u16be

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
channels int | None

(from 0 to INT_MAX) (default 1)

None
ch_layout str | None
None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

u16le

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

u16le

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
channels int | None

(from 0 to INT_MAX) (default 1)

None
ch_layout str | None
None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

u24be

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

u24be

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
channels int | None

(from 0 to INT_MAX) (default 1)

None
ch_layout str | None
None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

u24le

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

u24le

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
channels int | None

(from 0 to INT_MAX) (default 1)

None
ch_layout str | None
None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

u32be

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

u32be

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
channels int | None

(from 0 to INT_MAX) (default 1)

None
ch_layout str | None
None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

u32le

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

u32le

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
channels int | None

(from 0 to INT_MAX) (default 1)

None
ch_layout str | None
None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

u8

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

u8

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
channels int | None

(from 0 to INT_MAX) (default 1)

None
ch_layout str | None
None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

usm

usm

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

v210

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

v210

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

v210x

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

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

vbn_pipe

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

vc1

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

vc1test

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

vidc

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

vidc

Parameters:

Name Type Description Default
sample_rate int | None

(from 0 to INT_MAX) (default 44100)

None
channels int | None

(from 0 to INT_MAX) (default 1)

None
ch_layout str | None
None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

vividas

vividas() -> FFMpegDemuxerOption

vividas

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

vivo

vivo

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

vmd

vmd

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

vobsub

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

vobsub

Parameters:

Name Type Description Default
sub_name str | None

URI for .sub file

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

voc

voc

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

vpk

vpk

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

vplayer

vplayer() -> FFMpegDemuxerOption

vplayer

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

vqf

vqf

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

vvc

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

vvc

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

w64

Parameters:

Name Type Description Default
max_size int | None

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

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

wady

wady

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

wav

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

wav

Parameters:

Name Type Description Default
ignore_length bool | None

Ignore length (default false)

None
max_size int | None

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

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

wavarc

wavarc() -> FFMpegDemuxerOption

wavarc

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

wc3movie

wc3movie() -> FFMpegDemuxerOption

wc3movie

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_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

webp_pipe

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

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

wsaud

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

wsd

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

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

wsvqa

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

wtv

wtv

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

wv

wv

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

wve

wve

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

x11grab

x11grab(
    window_id: int | None = None,
    x: int | None = None,
    y: int | None = None,
    grab_x: int | None = None,
    grab_y: int | None = None,
    video_size: str | None = None,
    framerate: str | None = None,
    draw_mouse: int | None = None,
    follow_mouse: int | None | Literal["centered"] = None,
    show_region: int | None = None,
    region_border: int | None = None,
    select_region: bool | None = None,
) -> FFMpegDemuxerOption

x11grab

Parameters:

Name Type Description Default
window_id int | None

Window to capture. (from 0 to UINT32_MAX) (default 0)

None
x int | None

Initial x coordinate. (from 0 to INT_MAX) (default 0)

None
y int | None

Initial y coordinate. (from 0 to INT_MAX) (default 0)

None
grab_x int | None

Initial x coordinate. (from 0 to INT_MAX) (default 0)

None
grab_y int | None

Initial y coordinate. (from 0 to INT_MAX) (default 0)

None
video_size str | None

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

None
framerate str | None

(default "ntsc")

None
draw_mouse int | None

Draw the mouse pointer. (from 0 to 1) (default 1)

None
follow_mouse int | None | Literal['centered']

Move the grabbing region when the mouse pointer reaches within specified amount of pixels to the edge of region. (from -1 to INT_MAX) (default 0)

None
show_region int | None

Show the grabbing region. (from 0 to 1) (default 0)

None
region_border int | None

Set the region border thickness. (from 1 to 128) (default 3)

None
select_region bool | None

Select the grabbing region graphically using the pointer. (default false)

None

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

xa

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

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

xbm_pipe

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

xmd

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

xmv

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

xpm_pipe

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

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

xwd_pipe

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

xwma

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

yop

yop

Returns:

Type Description
FFMpegDemuxerOption

the set codec options

yuv4mpegpipe

yuv4mpegpipe() -> FFMpegDemuxerOption

yuv4mpegpipe

Returns:

Type Description
FFMpegDemuxerOption

the set codec options