audio, TypeScript SDK docs

acompressor

FFmpeg

Audio → Audio

AudioStream.acompressor(opts?: AcompressorOpts): AudioStream

Dynamic range compressor

Param	Type	Description
threshold	number
ratio	number

acontrast

FFmpeg

Audio → Audio

AudioStream.acontrast(opts?: AcontrastOpts): AudioStream

Simple audio dynamic contrast enhancement

Param	Type	Description
contrast	number

adeclick

FFmpeg

Audio → Audio

AudioStream.adeclick(opts?: AdeclickOpts): AudioStream

Remove clicks and pops

Param	Type	Description
window	number
overlap	number
arorder	number
threshold	number
burst	number
method	'add' \| 'a' \| 'save' \| 's'

adelay

FFmpeg

Audio → Audio

AudioStream.adelay(opts: AdelayOpts): AudioStream

Delay one or more channels

Param	Type	Description
delays required	string

aecho

FFmpeg

Audio → Audio

AudioStream.aecho(opts: AechoOpts): AudioStream

Echo effect

Param	Type	Description
in_gain	number
out_gain	number
delays required	string
decays required	string

afade

FFmpeg

Audio → Audio

AudioStream.afade(opts: AfadeOpts): AudioStream

Fade audio in or out

Param	Type	Description
type required	'in' \| 'out'
duration	number	Range: greater than 0
start_time	number	Range: at least 0

afftdn

FFmpeg

Audio → Audio

AudioStream.afftdn(opts?: AfftdnOpts): AudioStream

FFT-based broadband noise reduction

Param	Type	Description
nr	number
nt	'w' \| 'v' \| 's' \| 'p'
bn	string

agate

FFmpeg

Audio → Audio

AudioStream.agate(opts?: AgateOpts): AudioStream

Noise gate

Param	Type	Description
threshold	number
ratio	number
attack	number
release	number
range	number
detection	'peak' \| 'rms'

alimiter

FFmpeg

Audio → Audio

AudioStream.alimiter(opts?: AlimiterOpts): AudioStream

Lookahead peak limiter

Param	Type	Description
limit	number
attack	number
release	number
level_in	number
level_out	number
level	boolean
asc	boolean

aloop

FFmpeg

Audio → Audio

AudioStream.aloop(opts?: AloopOpts): AudioStream

Loop a range of audio samples

Param	Type	Description
loop	number
size	number
start	number

amerge

FFmpeg

Audio → Audio

AudioStream.amerge(opts?: AmergeOpts): AudioStream

Merge channels of two streams into one

Param	Type	Description
inputs	number

anlmdn

FFmpeg

Audio → Audio

AudioStream.anlmdn(opts?: AnlmdnOpts): AudioStream

Non-local means audio denoising

Param	Type	Description
s	number
p	number
r	number

apad

FFmpeg

Audio → Audio

AudioStream.apad(opts?: ApadOpts): AudioStream

Pad the end of audio with silence

Param	Type	Description
whole_dur	number

aphaser

FFmpeg

Audio → Audio

AudioStream.aphaser(opts?: AphaserOpts): AudioStream

Phaser effect

Param	Type	Description
in_gain	number
out_gain	number
delay	number
decay	number
speed	number
type	'triangular' \| 'sinusoidal'

aresample

FFmpeg

Audio → Audio

AudioStream.aresample(opts: AresampleOpts): AudioStream

Resample audio to target rate

Param	Type	Description
rate required	number

areverse

FFmpeg

Audio → Audio

AudioStream.areverse(): AudioStream

Reverse the audio

asetpts

FFmpeg

Audio → Audio

AudioStream.asetpts(opts: AsetptsOpts): AudioStream

Param	Type	Description
expr required	string

astats

FFmpeg

Audio → Audio

AudioStream.astats(opts?: AstatsOpts): AudioStream

Measure per-channel audio statistics

Param	Type	Description
metadata	number
reset	number
measure_perchannel	string
measure_overall	string

asubboost

FFmpeg

Audio → Audio

AudioStream.asubboost(opts?: AsubboostOpts): AudioStream

Boost sub-bass frequencies

Param	Type	Description
dry	number
wet	number
decay	number
feedback	number
cutoff	number
slope	number
delay	number

atempo

FFmpeg

Audio → Audio

AudioStream.atempo(opts: AtempoOpts): AudioStream

Change tempo without changing pitch

Param	Type	Description
tempo required	number	Tempo multiplier (1.0 = unchanged). Range: [0.5, 100]

atrim

FFmpeg

Audio → Audio

AudioStream.atrim(opts?: AtrimOpts): AudioStream

Keep only the samples between start and end

Param	Type	Description
start	number	Range: at least 0
end	number	Range: greater than 0

bandpass

FFmpeg

Audio → Audio

AudioStream.bandpass(opts: BandpassOpts): AudioStream

Band-pass filter around a center frequency

Param	Type	Description
f required	number
width_type	'h' \| 'q' \| 'o' \| 's' \| 'k'
width required	number

bass

FFmpeg

Audio → Audio

AudioStream.bass(opts: BassOpts): AudioStream

Boost or cut bass frequencies

Param	Type	Description
gain required	number
frequency	number
width_type	'h' \| 'q' \| 'o' \| 's' \| 'k'
width	number

channelmap

FFmpeg

Audio → Audio

AudioStream.channelmap(opts?: ChannelmapOpts): AudioStream

Remap audio channels

Param	Type	Description
map	string
channel_layout	string

chorus

FFmpeg

Audio → Audio

AudioStream.chorus(opts?: ChorusOpts): AudioStream

Chorus effect

Param	Type	Description
in_gain	number
out_gain	number
delays	string
speeds	string
depths	string
decays	string

compand

FFmpeg

Audio → Audio

AudioStream.compand(opts?: CompandOpts): AudioStream

Compress or expand dynamic range with a transfer curve

Param	Type	Description
attacks	string
decays	string
points	string
soft-knee	number
gain	number
volume	number
delay	number

crossfeed

FFmpeg

Audio → Audio

AudioStream.crossfeed(opts?: CrossfeedOpts): AudioStream

Blend stereo channels for headphone listening

Param	Type	Description
strength	number
range	number
slope	number
level_in	number
level_out	number

deesser

FFmpeg

Audio → Audio

AudioStream.deesser(opts?: DeesserOpts): AudioStream

Reduce sibilance ('s' harshness)

Param	Type	Description
i	number
m	number
f	number
s	'i' \| 'o' \| 'e'

dialoguenhance

FFmpeg

Audio → Audio

AudioStream.dialoguenhance(opts?: DialoguenhanceOpts): AudioStream

Enhance dialogue against background audio

Param	Type	Description
original	number
enhance	number
voice	number

dynaudnorm

FFmpeg

Audio → Audio

AudioStream.dynaudnorm(opts?: DynaudnormOpts): AudioStream

Dynamic loudness normalization over time windows

Param	Type	Description
framelen	number
gausssize	number
peak	number
maxgain	number
targetrms	number
compress	number
threshold	number

ebur128

FFmpeg

Audio → Audio

AudioStream.ebur128(): AudioStream

Measure EBU R128 loudness

equalizer

FFmpeg

Audio → Audio

AudioStream.equalizer(opts: EqualizerOpts): AudioStream

Parametric EQ band

Param	Type	Description
f required	number
width_type	'h' \| 'q' \| 'o' \| 's' \| 'k'
width required	number
gain required	number

flanger

FFmpeg

Audio → Audio

AudioStream.flanger(opts?: FlangerOpts): AudioStream

Flanger effect

Param	Type	Description
delay	number
depth	number
speed	number

highpass

FFmpeg

Audio → Audio

AudioStream.highpass(opts: HighpassOpts): AudioStream

High-pass filter

Param	Type	Description
f required	number	Cutoff frequency in Hz.

loudnorm

FFmpeg

Audio → Audio

AudioStream.loudnorm(opts?: LoudnormOpts): AudioStream

Loudness normalization

Param	Type	Description
I	number	Target integrated loudness in LUFS (broadcast standard: -23, streaming: -14). Range: [-70, -5]
TP	number	Maximum true peak in dBTP. Range: [-9, 0]
LRA	number	Target loudness range in LU. Range: [1, 50]

lowpass

FFmpeg

Audio → Audio

AudioStream.lowpass(opts: LowpassOpts): AudioStream

Low-pass filter

Param	Type	Description
f required	number

pan

FFmpeg

Audio → Audio

AudioStream.pan(opts: PanOpts): AudioStream

Mix/route channels with per-channel gains

Param	Type	Description
layout required	string

rubberband

FFmpeg

Audio → Audio

AudioStream.rubberband(opts?: RubberbandOpts): AudioStream

Time-stretch and pitch-shift (Rubber Band)

Param	Type	Description
tempo	number
pitch	number
transients	'crisp' \| 'mixed' \| 'smooth'
detector	'compound' \| 'percussive' \| 'soft'
phase	'laminar' \| 'independent'
window	'standard' \| 'short' \| 'long'
smoothing	'off' \| 'on'
formant	'shifted' \| 'preserved'
pitchq	'quality' \| 'speed' \| 'consistency'
channels	'apart' \| 'together'

showcqt

FFmpeg

Audio → Video

AudioStream.showcqt(opts?: ShowcqtOpts): VideoStream

Render a constant-Q spectrum visualization as video

Param	Type	Description
s	string
fps	number
bar_h	number
axis_h	number
sono_h	number
fullhd	number
sono_v	string
bar_v	string
count	number
fcount	number
fontcolor	string
font	string
fontsize	number

showspectrum

FFmpeg

Audio → Video

AudioStream.showspectrum(opts?: ShowspectrumOpts): VideoStream

Render a spectrogram as video

Param	Type	Description
s	string
mode	'combined' \| 'separate'
slide	'replace' \| 'scroll' \| 'fullframe' \| 'rscroll'
color	string
scale	'lin' \| 'log' \| 'sqrt' \| 'cbrt' \| '5thrt' \| '4thrt'
fscale	'lin' \| 'log'
saturation	number
win_func	string
orientation	'vertical' \| 'horizontal'
overlap	number
gain	number
data	'magnitude' \| 'phase' \| 'uphase'
rotation	number
start	number
stop	number
fps	number
legend	number

showwaves

FFmpeg

Audio → Video

AudioStream.showwaves(opts?: ShowwavesOpts): VideoStream

Render the waveform as video

Param	Type	Description
s	string
mode	'point' \| 'line' \| 'p2p' \| 'cline'
rate	number
n	number
colors	string
scale	'lin' \| 'log' \| 'sqrt' \| 'cbrt' \| '5thrt'
draw	'full' \| 'scale'
split_channels	number

silencedetect

FFmpeg

Audio → Audio

AudioStream.silencedetect(opts?: SilencedetectOpts): AudioStream

Detect silent intervals

Param	Type	Description
noise	string
d	number

silenceremove

FFmpeg

Audio → Audio

AudioStream.silenceremove(opts?: SilenceremoveOpts): AudioStream

Cut silence from the audio

Param	Type	Description
stop_periods	number	Number of silence periods to remove from the middle/end.
stop_duration	number	Minimum silence length in seconds before cutting.
stop_threshold	string	Level treated as silence (e.g. '-50dB').

speechnorm

FFmpeg

Audio → Audio

AudioStream.speechnorm(opts?: SpeechnormOpts): AudioStream

Speech-optimized loudness normalization

Param	Type	Description
peak	number
expansion	number
compression	number
threshold	number
raise	number
fall	number

stereowiden

FFmpeg

Audio → Audio

AudioStream.stereowiden(opts?: StereowidenOpts): AudioStream

Widen the stereo image

Param	Type	Description
delay	number
feedback	number
crossfeed	number

surround

FFmpeg

Audio → Audio

AudioStream.surround(opts?: SurroundOpts): AudioStream

Upmix stereo to surround

Param	Type	Description
chl_out	string
chl_in	string
level_in	number
level_out	number
lfe	boolean
lfe_low	number
lfe_high	number
fc_in	number
fc_out	number
fl_in	number
fl_out	number
fr_in	number
fr_out	number
bl_in	number
bl_out	number
br_in	number
br_out	number
lfe_in	number
lfe_out	number

treble

FFmpeg

Audio → Audio

AudioStream.treble(opts: TrebleOpts): AudioStream

Boost or cut treble frequencies

Param	Type	Description
gain required	number
frequency	number
width_type	'h' \| 'q' \| 'o' \| 's' \| 'k'
width	number

tremolo

FFmpeg

Audio → Audio

AudioStream.tremolo(opts?: TremoloOpts): AudioStream

Amplitude modulation (tremolo)

Param	Type	Description
f	number
d	number

vibrato

FFmpeg

Audio → Audio

AudioStream.vibrato(opts?: VibratoOpts): AudioStream

Frequency modulation (vibrato)

Param	Type	Description
f	number
d	number

volume

FFmpeg

Audio → Audio

AudioStream.volume(opts: VolumeOpts): AudioStream

Adjust volume

Param	Type	Description
volume required	number	Gain multiplier (1.0 = unchanged, 0.5 = -6 dB). Range: at least 0

audio: audio filters

acompressor

acontrast

adeclick

adelay

aecho

afade

afftdn

agate

alimiter

aloop

amerge

anlmdn

apad

aphaser

aresample

areverse

asetpts

astats

asubboost

atempo

atrim

bandpass

bass

channelmap

chorus

compand

crossfeed

deesser

dialoguenhance

dynaudnorm

ebur128

equalizer

flanger

highpass

loudnorm

lowpass

pan

rubberband

showcqt

showspectrum

showwaves

silencedetect

silenceremove

speechnorm

stereowiden

surround

treble

tremolo

vibrato

volume