Configuration Reference¶
voctocore reads an INI-style configuration file. The search order is:
Path given by
-ion the command line~/.config/voctomix/voctocore.ini/etc/voctomix/voctocore.inivoctocore/default-config.ini(repository default)
[mix] — core mixing settings¶
sourcesComma-separated list of source names. Required. Example:
cam1,cam2,laptoplivesourcesSources to expose as additional live outputs. Example:
grabberbackgroundsBackground source names, enables multi-background mode. Example:
bg_fs,bg_sbsIf this list is omitted but a
[source.background]section exists, voctocore automatically uses that single background for all composites.videocapsGStreamer caps string for the video format of the mix. Default:
video/x-raw,format=I420,width=1920,height=1080,framerate=25/1,pixel-aspect-ratio=1/1audiocapsGStreamer caps string for the audio format of the mix. Default:
audio/x-raw,format=S16LE,channels=2,layout=interleaved,rate=48000nosignalTest pattern shown when a source has no signal. Default:
smpte100. Set tononeto disable the no-signal fallback.audiomixmatrixControls how input audio channels are mapped to output audio channels before the mix is sent downstream. Each value is a floating-point gain (
0.0= silent,1.0= full volume).Format: space-separated values within a row, rows separated by
/:<out0_from_in0> <out0_from_in1> ... / <out1_from_in0> <out1_from_in1> ...
The number of columns equals the number of input channels.
The number of rows equals the number of output channels.
Each cell
[row][col]sets how much of input channel col is mixed into output channel row.
Default: identity matrix derived from the
channelsvalue inaudiocaps(pass-through, no remixing).Examples (for a standard 2-channel stereo stream):
Pass-through — left stays left, right stays right:
audiomixmatrix = 1 0 / 0 1
Swap left and right channels:
audiomixmatrix = 0 1 / 1 0
Downmix stereo to mono (average both channels into a single output):
audiomixmatrix = 0.5 0.5
Duplicate a mono source to both stereo outputs:
audiomixmatrix = 1 / 1
Send only the left input channel to both outputs (useful when a source carries audio only on one channel):
audiomixmatrix = 1 0 / 1 0
[source.<name>] — per-source settings¶
Each source defined in mix/sources can have its own section. See
Sources for the full per-kind option reference.
[composites] — video composites¶
Composites define how sources A and B are positioned in the output frame. Each line defines one composite:
[composites]
fullscreen.alpha-b = 0
sidebyside.a = 0/0/960/1080
sidebyside.b = 960/0/1920/1080
pip.a = 0/0/1920/1080
pip.b = 1440/810/1920/1080
See Composites and Transitions for the full composite and transition syntax.
[transitions] — animated transitions¶
[transitions]
FADE = 750, fullscreen / fullscreen
Format: <name> = <duration_ms>, <from_composite> / [intermediate /] <to_composite>
See Composites and Transitions for details.
[previews] — preview output¶
enabledEnable encoded preview outputs for the GUI. Default:
false.liveWhich live sources to include in the preview output. Default:
false. Accepted values:true(mix only),all, or a comma-separated list of source names frommix/livesources.widthPreview frame width in pixels. Default:
320.heightPreview frame height in pixels. Default: width × 9/16.
nameoverlayOverlay the source name on preview thumbnails. Default:
true.videoencoderEncoder backend used for preview streams. Required when
enabled = true. Accepted values:cpu— software encodervaapi— Intel/AMD hardware encoderv4l2— V4L2 hardware encoder
videocodecCodec name with optional comma-separated GStreamer element properties. Default:
jpeg,quality=90. Accepted codecs:jpeg,h264,mpeg2(the available codecs depend on the chosenvideoencoder).Examples:
videocodec = jpeg,quality=90 videocodec = h264,bitrate=2000
videodecoderDecoder backend used by voctogui when displaying the preview stream. Accepted values:
cpu,vaapi.deinterlaceDeinterlace the preview stream before encoding. Default:
false.videocapsGStreamer caps string overriding the mix’s
videocapsfor this section. Default: inherit from[mix] videocaps.audiocapsGStreamer caps string overriding the mix’s
audiocapsfor this section. Default: inherit from[mix] audiocaps.
[blinder] — stream blanker¶
See Blinder sources.
[overlay] — image overlays¶
See Overlay sources.
[avrawoutput] — raw A/V output¶
enabledExpose the full-quality mix as a raw Matroska stream on port
11000. Default:true(enabled unless explicitly set tofalse).
[mirrors] — source mirror ports¶
enabledExpose a copy of each source’s raw input stream on its own TCP port. Default:
false.sourcesComma-separated list of source names to mirror. Default: every source listed in
mix/sources.
[localrecording] — local recording¶
Note
Local recording is not yet implemented in voctomix 2.0.
enabledEnable local recording output. Default:
false.
[programoutput] — direct monitor output¶
Outputs the mix recording directly to a GStreamer video/audio sink (e.g. a display or an AJA output card).
enabledEnable the program output. Default:
false.videosinkGStreamer element or pipeline fragment for video output. Default:
autovideosinkaudiosinkGStreamer element or pipeline fragment for audio output. Default:
autoaudiosink
[output-buffers] — output queue sizes¶
Fine-tune the output buffer depth per channel (in frames):
[output-buffers]
mix = 500
cam1 = 500
Default is 500 for all channels.