.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH V4L2LOOPBACK-CTL "1" "March 2024" "v4l2loopback-ctl v0.13.1" "User Commands"
.SH NAME
v4l2loopback-ctl \- control v4l2 loopback devices
.SH DESCRIPTION
usage: utils/v4l2loopback\-ctl [general commands]
.IP
general commands
================
.HP
\fB\-v\fR/\-\-version : print version and exit
.HP
\fB\-h\fR/\-?/\-\-help : print this help and exit
.IP
add {<flags>} [<outputdevice> [<capturedevice>]]
.IP
delete <device>
.IP
list {<flags>}
.IP
query {<flags>} <device>
.IP
set\-fps <device> <fps>
.IP
get\-fps <device>
.IP
set\-caps <device> <caps>
.IP
get\-caps <device>
.IP
set\-timeout\-image {<flags>} <device> <image>
.IP
adding devices ('add')
======================
.IP
utils/v4l2loopback\-ctl add {<flags>} [<outputdevice> [<capturedevice>]]
.TP
<flags>
any of the following flags may be present
.TP
\fB\-n\fR/\-\-name <name>
: pretty name for the device
.TP
\fB\-\-min\-width\fR <w>
: minimum allowed frame width
.TP
\fB\-w\fR/\-\-max\-width <w>
: maximum allowed frame width
.TP
\fB\-\-min\-height\fR <w>
: minimum allowed frame height
.TP
\fB\-h\fR/\-\-max\-height <h>
: maximum allowed frame height
.HP
\fB\-x\fR/\-\-exclusive\-caps <x> : whether to announce OUTPUT/CAPTURE capabilities exclusively
.TP
\fB\-b\fR/\-\-buffers <num>
: buffers to queue
.TP
\fB\-o\fR/\-\-max\-openers <num>
: maximum allowed concurrent openers
.TP
\fB\-v\fR/\-\-verbose
: verbose mode (print properties of device after successfully creating it)
.TP
\-?/\-\-help
: print this help and exit
.TP
<outputdevice>
if given, create a specific device (otherwise just create a free one).
.IP
either specify a device name (e.g. '/dev/video1') or a device number ('1').
.TP
<capturedevice>
if given, use separate output & capture devices (otherwise they are the same).
.IP
deleting devices ('delete')
===========================
.IP
utils/v4l2loopback\-ctl delete <device>
.TP
<device>
can be given one more more times (to delete multiple devices at once).
either specify a device name (e.g. '/dev/video1') or a device number ('1').
.IP
listing devices ('list')
========================
.IP
utils/v4l2loopback\-ctl list {<flags>}
.TP
<flags>
any of the following flags may be present
.TP
\fB\-e\fR/\-\-escape
: escape control\-characters in (device) names
.TP
\fB\-h\fR/\-\-help
: print this help and exit
.IP
list all available loopback\-devices
.IP
querying devices ('query')
==========================
.IP
utils/v4l2loopback\-ctl query {<flags>} <device>
.TP
<flags>
any of the following flags may be present
.TP
\fB\-e\fR/\-\-escape
: escape control\-characters in (device) names
.TP
\fB\-h\fR/\-\-help
: print this help and exit
.TP
<device>
can be given one more more times (to query multiple devices at once).
either specify a device name (e.g. '/dev/video1') or a device number ('1').
.IP
setting framerate ('set\-fps')
=============================
.IP
utils/v4l2loopback\-ctl set\-fps <device> <fps>
.TP
<device>
either specify a device name (e.g. '/dev/video1') or a device number ('1').
.TP
<fps>
frames per second, either as integer ('30') or fraction ('50/2').
.IP
getting framerate ('get\-fps')
=============================
.IP
utils/v4l2loopback\-ctl get\-fps <device>
.IP
setting capabilities ('set\-caps')
=================================
.IP
utils/v4l2loopback\-ctl set\-caps <device> <caps>
.TP
<device>
either specify a device name (e.g. '/dev/video1') or a device number ('1').
.TP
<caps>
format specification as '<fourcc>:<width>x<height>@<fps>' (e.g. 'UYVY:1024x768@60/1')
.IP
getting capabilities ('get\-caps')
=================================
.IP
utils/v4l2loopback\-ctl get\-caps <device>
.IP
setting timeout image ('set\-timeout\-image')
===========================================
.IP
utils/v4l2loopback\-ctl set\-timeout\-image {<flags>} <device> <image>
.TP
<flags>
any of the following flags may be present
.TP
\fB\-t\fR/\-\-timeout <timeout>
: timeout (in ms)
.TP
\fB\-v\fR/\-\-verbose
: raise verbosity (print what is being done)
.TP
\fB\-h\fR/\-\-help
: print this help and exit
.TP
<device>
either specify a device name (e.g. '/dev/video1') or a device number ('1').
.TP
<image>
image file