SurroundEffect class final

Configuration for the surround audio effect.

Apply audio surround upmix filter.

This filter allows to produce multichannel output from audio stream.

The filter accepts the following options:

Parameters:

  • allx: Set spread usage of stereo image across X axis for all channels. Allowed range is from -1 to 15. By default this value is negative -1, and thus unused. (range -1..15, default -1, runtime-tunable)
  • ally: Set spread usage of stereo image across Y axis for all channels. Allowed range is from -1 to 15. By default this value is negative -1, and thus unused. (range -1..15, default -1, runtime-tunable)
  • angle: Set angle of stereo surround transform, Allowed range is from 0 to 360. Default is 90. (range 0..360, default 90, runtime-tunable)
  • bcIn: Set back center input volume. By default, this is 1. (range 0..10, default 1, runtime-tunable)
  • bcOut: Set back center output volume. By default, this is 1. (range 0..10, default 1, runtime-tunable)
  • bcx: Set spread usage of stereo image across X axis for each channel. Allowed range is from 0.06 to 15. By default this value is 0.5. (range .06..15, default 0.5, runtime-tunable)
  • bcy: Set spread usage of stereo image across Y axis for each channel. Allowed range is from 0.06 to 15. By default this value is 0.5. (range .06..15, default 0.5, runtime-tunable)
  • blIn: Set back left input volume. By default, this is 1. (range 0..10, default 1, runtime-tunable)
  • blOut: Set back left output volume. By default, this is 1. (range 0..10, default 1, runtime-tunable)
  • blx: Set spread usage of stereo image across X axis for each channel. Allowed range is from 0.06 to 15. By default this value is 0.5. (range .06..15, default 0.5, runtime-tunable)
  • bly: Set spread usage of stereo image across Y axis for each channel. Allowed range is from 0.06 to 15. By default this value is 0.5. (range .06..15, default 0.5, runtime-tunable)
  • brIn: Set back right input volume. By default, this is 1. (range 0..10, default 1, runtime-tunable)
  • brOut: Set back right output volume. By default, this is 1. (range 0..10, default 1, runtime-tunable)
  • brx: Set spread usage of stereo image across X axis for each channel. Allowed range is from 0.06 to 15. By default this value is 0.5. (range .06..15, default 0.5, runtime-tunable)
  • bry: Set spread usage of stereo image across Y axis for each channel. Allowed range is from 0.06 to 15. By default this value is 0.5. (range .06..15, default 0.5, runtime-tunable)
  • chlIn: Set input channel layout. By default, this is stereo. See channel layout syntax for the required syntax. (range 0..0, default "stereo")
  • chlOut: Set output channel layout. By default, this is 5.1. See channel layout syntax for the required syntax. (range 0..0, default "5.1")
  • fcIn: Set front center input volume. By default, this is 1. (range 0..10, default 1, runtime-tunable)
  • fcOut: Set front center output volume. By default, this is 1. (range 0..10, default 1, runtime-tunable)
  • fcx: Set spread usage of stereo image across X axis for each channel. Allowed range is from 0.06 to 15. By default this value is 0.5. (range .06..15, default 0.5, runtime-tunable)
  • fcy: Set spread usage of stereo image across Y axis for each channel. Allowed range is from 0.06 to 15. By default this value is 0.5. (range .06..15, default 0.5, runtime-tunable)
  • flIn: Set front left input volume. By default, this is 1. (range 0..10, default 1, runtime-tunable)
  • flOut: Set front left output volume. By default, this is 1. (range 0..10, default 1, runtime-tunable)
  • flx: Set spread usage of stereo image across X axis for each channel. Allowed range is from 0.06 to 15. By default this value is 0.5. (range .06..15, default 0.5, runtime-tunable)
  • fly: Set spread usage of stereo image across Y axis for each channel. Allowed range is from 0.06 to 15. By default this value is 0.5. (range .06..15, default 0.5, runtime-tunable)
  • focus: Set focus of stereo surround transform, Allowed range is from -1 to 1. Default is 0. (range -1..1, default 0, runtime-tunable)
  • frIn: Set front right input volume. By default, this is 1. (range 0..10, default 1, runtime-tunable)
  • frOut: Set front right output volume. By default, this is 1. (range 0..10, default 1, runtime-tunable)
  • frx: Set spread usage of stereo image across X axis for each channel. Allowed range is from 0.06 to 15. By default this value is 0.5. (range .06..15, default 0.5, runtime-tunable)
  • fry: Set spread usage of stereo image across Y axis for each channel. Allowed range is from 0.06 to 15. By default this value is 0.5. (range .06..15, default 0.5, runtime-tunable)
  • levelIn: Set input volume level. By default, this is 1. (range 0..10, default 1, runtime-tunable)
  • levelOut: Set output volume level. By default, this is 1. (range 0..10, default 1, runtime-tunable)
  • lfe: Enable LFE channel output if output channel layout has it. By default, this is enabled. (range 0..1, default 1, runtime-tunable)
  • lfeHigh: Set LFE high cut off frequency. By default, this is 256 Hz. (range 0..512, default 256)
  • lfeIn: Set LFE input volume. By default, this is 1. (range 0..10, default 1, runtime-tunable)
  • lfeLow: Set LFE low cut off frequency. By default, this is 128 Hz. (range 0..256, default 128)
  • lfeMode: Set LFE mode, can be add or sub. Default is add. In add mode, LFE channel is created from input audio and added to output. In sub mode, LFE channel is created from input audio and added to output but also all non-LFE output channels are subtracted with output LFE channel. (range 0..1, default 0, runtime-tunable)
  • lfeOut: Set LFE output volume. By default, this is 1. (range 0..10, default 1, runtime-tunable)
  • overlap: set window overlap (range 0..1, default 0.5, runtime-tunable)
  • slIn: Set side left input volume. By default, this is 1. (range 0..10, default 1, runtime-tunable)
  • slOut: Set side left output volume. By default, this is 1. (range 0..10, default 1, runtime-tunable)
  • slx: Set spread usage of stereo image across X axis for each channel. Allowed range is from 0.06 to 15. By default this value is 0.5. (range .06..15, default 0.5, runtime-tunable)
  • sly: Set spread usage of stereo image across Y axis for each channel. Allowed range is from 0.06 to 15. By default this value is 0.5. (range .06..15, default 0.5, runtime-tunable)
  • smooth: Set temporal smoothness strength, used to gradually change factors when transforming stereo sound in time. Allowed range is from 0.0 to 1.0. Useful to improve output quality with focus option values greater than 0.0. Default is 0.0. Only values inside this range and without edges are effective. (range 0..1, default 0, runtime-tunable)
  • srIn: Set side right input volume. By default, this is 1. (range 0..10, default 1, runtime-tunable)
  • srOut: Set side right output volume. By default, this is 1. (range 0..10, default 1, runtime-tunable)
  • srx: Set spread usage of stereo image across X axis for each channel. Allowed range is from 0.06 to 15. By default this value is 0.5. (range .06..15, default 0.5, runtime-tunable)
  • sry: Set spread usage of stereo image across Y axis for each channel. Allowed range is from 0.06 to 15. By default this value is 0.5. (range .06..15, default 0.5, runtime-tunable)
  • winFunc: Set window function. It accepts the following values: (default WFUNC_HANNING)
  • winSize: Set window size. Allowed range is from 1024 to 65536. Default size is 4096. (range 1024..65536, default 4096)
Inheritance

Constructors

SurroundEffect({bool enabled = true, double allx = -1.0, double ally = -1.0, double angle = 90.0, double bcIn = 1.0, double bcOut = 1.0, double bcx = 0.5, double bcy = 0.5, double blIn = 1.0, double blOut = 1.0, double blx = 0.5, double bly = 0.5, double brIn = 1.0, double brOut = 1.0, double brx = 0.5, double bry = 0.5, String chlIn = 'stereo', String chlOut = '5.1', double fcIn = 1.0, double fcOut = 1.0, double fcx = 0.5, double fcy = 0.5, double flIn = 1.0, double flOut = 1.0, double flx = 0.5, double fly = 0.5, double focus = 0.0, double frIn = 1.0, double frOut = 1.0, double frx = 0.5, double fry = 0.5, double levelIn = 1.0, double levelOut = 1.0, bool lfe = true, int lfeHigh = 256, double lfeIn = 1.0, int lfeLow = 128, SurroundLfeMode lfeMode = SurroundLfeMode.add, double lfeOut = 1.0, double overlap = 0.5, double slIn = 1.0, double slOut = 1.0, double slx = 0.5, double sly = 0.5, double smooth = 0.0, double srIn = 1.0, double srOut = 1.0, double srx = 0.5, double sry = 0.5, SurroundWinFunc winFunc = SurroundWinFunc.hann, int winSize = 4096})
Creates an SurroundEffect with the given parameter values.
const

Properties

allx → double
set all channel's x spread
final
ally → double
set all channel's y spread
final
angle → double
set soundfield transform angle
final
bcIn → double
set back center channel input level
final
bcOut → double
set back center channel output level
final
bcx → double
set back center channel x spread
final
bcy → double
set back center channel y spread
final
blIn → double
set back left channel input level
final
blOut → double
set back left channel output level
final
blx → double
set back left channel x spread
final
bly → double
set back left channel y spread
final
brIn → double
set back right channel input level
final
brOut → double
set back right channel output level
final
brx → double
set back right channel x spread
final
bry → double
set back right channel y spread
final
chlIn → String
set input channel layout
final
chlOut → String
set output channel layout
final
enabled → bool
Whether this effect is applied. false keeps it in the list, with its settings, without inserting it in the chain.
final
fcIn → double
set front center channel input level
final
fcOut → double
set front center channel output level
final
fcx → double
set front center channel x spread
final
fcy → double
set front center channel y spread
final
filter → AudioFilter
The filter this stage runs, as a typed identifier (null for a RawAudioEffect).
no setteroverride
filterName → String
The lavfi filter this stage runs, e.g. equalizer.
no setteroverride
flIn → double
set front left channel input level
final
flOut → double
set front left channel output level
final
flx → double
set front left channel x spread
final
fly → double
set front left channel y spread
final
focus → double
set soundfield transform focus
final
frIn → double
set front right channel input level
final
frOut → double
set front right channel output level
final
frx → double
set front right channel x spread
final
fry → double
set front right channel y spread
final
hashCode → int
The hash code for this object.
no setteroverride
levelIn → double
set input level
final
levelOut → double
set output level
final
lfe → bool
output LFE
final
lfeHigh → int
LFE high cut off
final
lfeIn → double
set lfe channel input level
final
lfeLow → int
LFE low cut off
final
lfeMode → SurroundLfeMode
set LFE channel mode
final
lfeOut → double
set lfe channel output level
final
overlap → double
set window overlap
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
slIn → double
set side left channel input level
final
slOut → double
set side left channel output level
final
slx → double
set side left channel x spread
final
sly → double
set side left channel y spread
final
smooth → double
set temporal smoothness strength
final
srIn → double
set side right channel input level
final
srOut → double
set side right channel output level
final
srx → double
set side right channel x spread
final
sry → double
set side right channel y spread
final
winFunc → SurroundWinFunc
set window function
final
winSize → int
set window size
final

Methods

copyWith({bool? enabled, double? allx, double? ally, double? angle, double? bcIn, double? bcOut, double? bcx, double? bcy, double? blIn, double? blOut, double? blx, double? bly, double? brIn, double? brOut, double? brx, double? bry, String? chlIn, String? chlOut, double? fcIn, double? fcOut, double? fcx, double? fcy, double? flIn, double? flOut, double? flx, double? fly, double? focus, double? frIn, double? frOut, double? frx, double? fry, double? levelIn, double? levelOut, bool? lfe, int? lfeHigh, double? lfeIn, int? lfeLow, SurroundLfeMode? lfeMode, double? lfeOut, double? overlap, double? slIn, double? slOut, double? slx, double? sly, double? smooth, double? srIn, double? srOut, double? srx, double? sry, SurroundWinFunc? winFunc, int? winSize}) → SurroundEffect
Returns a copy of this SurroundEffect with the given fields replaced.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toFilterString() → String
Returns the audio chain entry for this effect. Only non-default parameters are emitted.
override
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
override

Constants

allxDefault → const double
Default value for allx.
allxMax → const double
Maximum value for allx.
allxMin → const double
Minimum value for allx.
allyDefault → const double
Default value for ally.
allyMax → const double
Maximum value for ally.
allyMin → const double
Minimum value for ally.
angleDefault → const double
Default value for angle.
angleMax → const double
Maximum value for angle.
angleMin → const double
Minimum value for angle.
bcInDefault → const double
Default value for bcIn.
bcInMax → const double
Maximum value for bcIn.
bcInMin → const double
Minimum value for bcIn.
bcOutDefault → const double
Default value for bcOut.
bcOutMax → const double
Maximum value for bcOut.
bcOutMin → const double
Minimum value for bcOut.
bcxDefault → const double
Default value for bcx.
bcxMax → const double
Maximum value for bcx.
bcxMin → const double
Minimum value for bcx.
bcyDefault → const double
Default value for bcy.
bcyMax → const double
Maximum value for bcy.
bcyMin → const double
Minimum value for bcy.
blInDefault → const double
Default value for blIn.
blInMax → const double
Maximum value for blIn.
blInMin → const double
Minimum value for blIn.
blOutDefault → const double
Default value for blOut.
blOutMax → const double
Maximum value for blOut.
blOutMin → const double
Minimum value for blOut.
blxDefault → const double
Default value for blx.
blxMax → const double
Maximum value for blx.
blxMin → const double
Minimum value for blx.
blyDefault → const double
Default value for bly.
blyMax → const double
Maximum value for bly.
blyMin → const double
Minimum value for bly.
brInDefault → const double
Default value for brIn.
brInMax → const double
Maximum value for brIn.
brInMin → const double
Minimum value for brIn.
brOutDefault → const double
Default value for brOut.
brOutMax → const double
Maximum value for brOut.
brOutMin → const double
Minimum value for brOut.
brxDefault → const double
Default value for brx.
brxMax → const double
Maximum value for brx.
brxMin → const double
Minimum value for brx.
bryDefault → const double
Default value for bry.
bryMax → const double
Maximum value for bry.
bryMin → const double
Minimum value for bry.
fcInDefault → const double
Default value for fcIn.
fcInMax → const double
Maximum value for fcIn.
fcInMin → const double
Minimum value for fcIn.
fcOutDefault → const double
Default value for fcOut.
fcOutMax → const double
Maximum value for fcOut.
fcOutMin → const double
Minimum value for fcOut.
fcxDefault → const double
Default value for fcx.
fcxMax → const double
Maximum value for fcx.
fcxMin → const double
Minimum value for fcx.
fcyDefault → const double
Default value for fcy.
fcyMax → const double
Maximum value for fcy.
fcyMin → const double
Minimum value for fcy.
flInDefault → const double
Default value for flIn.
flInMax → const double
Maximum value for flIn.
flInMin → const double
Minimum value for flIn.
flOutDefault → const double
Default value for flOut.
flOutMax → const double
Maximum value for flOut.
flOutMin → const double
Minimum value for flOut.
flxDefault → const double
Default value for flx.
flxMax → const double
Maximum value for flx.
flxMin → const double
Minimum value for flx.
flyDefault → const double
Default value for fly.
flyMax → const double
Maximum value for fly.
flyMin → const double
Minimum value for fly.
focusDefault → const double
Default value for focus.
focusMax → const double
Maximum value for focus.
focusMin → const double
Minimum value for focus.
frInDefault → const double
Default value for frIn.
frInMax → const double
Maximum value for frIn.
frInMin → const double
Minimum value for frIn.
frOutDefault → const double
Default value for frOut.
frOutMax → const double
Maximum value for frOut.
frOutMin → const double
Minimum value for frOut.
frxDefault → const double
Default value for frx.
frxMax → const double
Maximum value for frx.
frxMin → const double
Minimum value for frx.
fryDefault → const double
Default value for fry.
fryMax → const double
Maximum value for fry.
fryMin → const double
Minimum value for fry.
levelInDefault → const double
Default value for levelIn.
levelInMax → const double
Maximum value for levelIn.
levelInMin → const double
Minimum value for levelIn.
levelOutDefault → const double
Default value for levelOut.
levelOutMax → const double
Maximum value for levelOut.
levelOutMin → const double
Minimum value for levelOut.
lfeHighDefault → const int
Default value for lfeHigh.
lfeHighMax → const int
Maximum value for lfeHigh.
lfeHighMin → const int
Minimum value for lfeHigh.
lfeInDefault → const double
Default value for lfeIn.
lfeInMax → const double
Maximum value for lfeIn.
lfeInMin → const double
Minimum value for lfeIn.
lfeLowDefault → const int
Default value for lfeLow.
lfeLowMax → const int
Maximum value for lfeLow.
lfeLowMin → const int
Minimum value for lfeLow.
lfeOutDefault → const double
Default value for lfeOut.
lfeOutMax → const double
Maximum value for lfeOut.
lfeOutMin → const double
Minimum value for lfeOut.
overlapDefault → const double
Default value for overlap.
overlapMax → const double
Maximum value for overlap.
overlapMin → const double
Minimum value for overlap.
slInDefault → const double
Default value for slIn.
slInMax → const double
Maximum value for slIn.
slInMin → const double
Minimum value for slIn.
slOutDefault → const double
Default value for slOut.
slOutMax → const double
Maximum value for slOut.
slOutMin → const double
Minimum value for slOut.
slxDefault → const double
Default value for slx.
slxMax → const double
Maximum value for slx.
slxMin → const double
Minimum value for slx.
slyDefault → const double
Default value for sly.
slyMax → const double
Maximum value for sly.
slyMin → const double
Minimum value for sly.
smoothDefault → const double
Default value for smooth.
smoothMax → const double
Maximum value for smooth.
smoothMin → const double
Minimum value for smooth.
srInDefault → const double
Default value for srIn.
srInMax → const double
Maximum value for srIn.
srInMin → const double
Minimum value for srIn.
srOutDefault → const double
Default value for srOut.
srOutMax → const double
Maximum value for srOut.
srOutMin → const double
Minimum value for srOut.
srxDefault → const double
Default value for srx.
srxMax → const double
Maximum value for srx.
srxMin → const double
Minimum value for srx.
sryDefault → const double
Default value for sry.
sryMax → const double
Maximum value for sry.
sryMin → const double
Minimum value for sry.
winSizeDefault → const int
Default value for winSize.
winSizeMax → const int
Maximum value for winSize.
winSizeMin → const int
Minimum value for winSize.