sphinx.addnodesdocument)}( rawsourcechildren]( translations LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget3/translations/zh_CN/userspace-api/media/v4l/controlmodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget3/translations/zh_TW/userspace-api/media/v4l/controlmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget3/translations/it_IT/userspace-api/media/v4l/controlmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget3/translations/ja_JP/userspace-api/media/v4l/controlmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget3/translations/ko_KR/userspace-api/media/v4l/controlmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hPortuguese (Brazilian)}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget3/translations/pt_BR/userspace-api/media/v4l/controlmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget3/translations/sp_SP/userspace-api/media/v4l/controlmodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhcomment)}(h8SPDX-License-Identifier: GFDL-1.1-no-invariants-or-laterh]h8SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later}hhsbah}(h]h ]h"]h$]h&] xml:spacepreserveuh1hhhhhhM/var/lib/git/docbuild/linux/Documentation/userspace-api/media/v4l/control.rsthKubhtarget)}(h .. _control:h]h}(h]h ]h"]h$]h&]refidcontroluh1hhKhhhhhhubhsection)}(hhh](htitle)}(h User Controlsh]h User Controls}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh paragraph)}(hXDevices typically have a number of user-settable controls such as brightness, saturation and so on, which would be presented to the user on a graphical user interface. But, different devices will have different controls available, and furthermore, the range of possible values, and the default value will vary from device to device. The control ioctls provide the information and a mechanism to create a nice user interface for these controls that will work correctly with any device.h]hXDevices typically have a number of user-settable controls such as brightness, saturation and so on, which would be presented to the user on a graphical user interface. But, different devices will have different controls available, and furthermore, the range of possible values, and the default value will vary from device to device. The control ioctls provide the information and a mechanism to create a nice user interface for these controls that will work correctly with any device.}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK hhhhubh)}(hXAll controls are accessed using an ID value. V4L2 defines several IDs for specific purposes. Drivers can also implement their own custom controls using ``V4L2_CID_PRIVATE_BASE`` [#f1]_ and higher values. The pre-defined control IDs have the prefix ``V4L2_CID_``, and are listed in :ref:`control-id`. The ID is used when querying the attributes of a control, and when getting or setting the current value.h](hAll controls are accessed using an ID value. V4L2 defines several IDs for specific purposes. Drivers can also implement their own custom controls using }(hhhhhNhNubhliteral)}(h``V4L2_CID_PRIVATE_BASE``h]hV4L2_CID_PRIVATE_BASE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhubh }(hhhhhNhNubhfootnote_reference)}(h[#f1]_h]h1}(hjhhhNhNubah}(h]id1ah ]h"]h$]h&]autoKhԌf1docnameuserspace-api/media/v4l/controluh1jhhresolvedKubh@ and higher values. The pre-defined control IDs have the prefix }(hhhhhNhNubj)}(h ``V4L2_CID_``h]h V4L2_CID_}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhubh, and are listed in }(hhhhhNhNubh)}(h:ref:`control-id`h]hinline)}(hjEh]h control-id}(hjIhhhNhNubah}(h]h ](xrefstdstd-refeh"]h$]h&]uh1jGhjCubah}(h]h ]h"]h$]h&]refdocj+ refdomainjTreftyperef refexplicitrefwarn reftarget control-iduh1hhhhKhhubhj. The ID is used when querying the attributes of a control, and when getting or setting the current value.}(hhhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hXGenerally applications should present controls to the user without assumptions about their purpose. Each control comes with a name string the user is supposed to understand. When the purpose is non-intuitive the driver writer should provide a user manual, a user interface plug-in or a driver specific panel application. Predefined IDs were introduced to change a few controls programmatically, for example to mute a device during a channel switch.h]hXGenerally applications should present controls to the user without assumptions about their purpose. Each control comes with a name string the user is supposed to understand. When the purpose is non-intuitive the driver writer should provide a user manual, a user interface plug-in or a driver specific panel application. Predefined IDs were introduced to change a few controls programmatically, for example to mute a device during a channel switch.}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hX7Drivers may enumerate different controls after switching the current video input or output, tuner or modulator, or audio input or output. Different in the sense of other bounds, another default and current value, step size or other menu items. A control with a certain *custom* ID can also change name and type.h](hX Drivers may enumerate different controls after switching the current video input or output, tuner or modulator, or audio input or output. Different in the sense of other bounds, another default and current value, step size or other menu items. A control with a certain }(hjhhhNhNubhemphasis)}(h*custom*h]hcustom}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh" ID can also change name and type.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK"hhhhubh)}(hIf a control is not applicable to the current configuration of the device (for example, it doesn't apply to the current video input) drivers set the ``V4L2_CTRL_FLAG_INACTIVE`` flag.h](hIf a control is not applicable to the current configuration of the device (for example, it doesn’t apply to the current video input) drivers set the }(hjhhhNhNubj)}(h``V4L2_CTRL_FLAG_INACTIVE``h]hV4L2_CTRL_FLAG_INACTIVE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh flag.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK(hhhhubh)}(hX Control values are stored globally, they do not change when switching except to stay within the reported bounds. They also do not change e. g. when the device is opened or closed, when the tuner radio frequency is changed or generally never without application request.h]hX Control values are stored globally, they do not change when switching except to stay within the reported bounds. They also do not change e. g. when the device is opened or closed, when the tuner radio frequency is changed or generally never without application request.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK,hhhhubh)}(hV4L2 specifies an event mechanism to notify applications when controls change value (see :ref:`VIDIOC_SUBSCRIBE_EVENT`, event ``V4L2_EVENT_CTRL``), panel applications might want to make use of that in order to always reflect the correct control value.h](hYV4L2 specifies an event mechanism to notify applications when controls change value (see }(hjhhhNhNubh)}(h:ref:`VIDIOC_SUBSCRIBE_EVENT`h]jH)}(hjh]hVIDIOC_SUBSCRIBE_EVENT}(hjhhhNhNubah}(h]h ](jSstdstd-refeh"]h$]h&]uh1jGhjubah}(h]h ]h"]h$]h&]refdocj+ refdomainjreftyperef refexplicitrefwarnjevidioc_subscribe_eventuh1hhhhK1hjubh, event }(hjhhhNhNubj)}(h``V4L2_EVENT_CTRL``h]hV4L2_EVENT_CTRL}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhj), panel applications might want to make use of that in order to always reflect the correct control value.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK1hhhhubh)}(h$All controls use machine endianness.h]h$All controls use machine endianness.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK7hhhhubh)}(h.. _control-id:h]h}(h]h ]h"]h$]h&]hԌ control-iduh1hhK:hhhhhhubh)}(hhh](h)}(h Control IDsh]h Control IDs}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj,hhhhhK=ubhdefinition_list)}(hhh](hdefinition_list_item)}(hI``V4L2_CID_BASE`` First predefined ID, equal to ``V4L2_CID_BRIGHTNESS``. h](hterm)}(h``V4L2_CID_BASE``h]j)}(hjLh]h V4L2_CID_BASE}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjJubah}(h]h ]h"]h$]h&]uh1jHhhhK@hjDubh definition)}(hhh]h)}(h6First predefined ID, equal to ``V4L2_CID_BRIGHTNESS``.h](hFirst predefined ID, equal to }(hjfhhhNhNubj)}(h``V4L2_CID_BRIGHTNESS``h]hV4L2_CID_BRIGHTNESS}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjfubh.}(hjfhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK@hjcubah}(h]h ]h"]h$]h&]uh1jahjDubeh}(h]h ]h"]h$]h&]uh1jBhhhK@hj?ubjC)}(h5``V4L2_CID_USER_BASE`` Synonym of ``V4L2_CID_BASE``. h](jI)}(h``V4L2_CID_USER_BASE``h]j)}(hjh]hV4L2_CID_USER_BASE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jHhhhKChjubjb)}(hhh]h)}(hSynonym of ``V4L2_CID_BASE``.h](h Synonym of }(hjhhhNhNubj)}(h``V4L2_CID_BASE``h]h V4L2_CID_BASE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKChjubah}(h]h ]h"]h$]h&]uh1jahjubeh}(h]h ]h"]h$]h&]uh1jBhhhKChj?hhubjC)}(h^``V4L2_CID_BRIGHTNESS`` ``(integer)`` Picture brightness, or more precisely, the black level. h](jI)}(h%``V4L2_CID_BRIGHTNESS`` ``(integer)``h](j)}(h``V4L2_CID_BRIGHTNESS``h]hV4L2_CID_BRIGHTNESS}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh }(hjhhhNhNubj)}(h ``(integer)``h]h (integer)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jHhhhKFhjubjb)}(hhh]h)}(h7Picture brightness, or more precisely, the black level.h]h7Picture brightness, or more precisely, the black level.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKFhj ubah}(h]h ]h"]h$]h&]uh1jahjubeh}(h]h ]h"]h$]h&]uh1jBhhhKFhj?hhubjC)}(hC``V4L2_CID_CONTRAST`` ``(integer)`` Picture contrast or luma gain. h](jI)}(h#``V4L2_CID_CONTRAST`` ``(integer)``h](j)}(h``V4L2_CID_CONTRAST``h]hV4L2_CID_CONTRAST}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj+ubh }(hj+hhhNhNubj)}(h ``(integer)``h]h (integer)}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj+ubeh}(h]h ]h"]h$]h&]uh1jHhhhKIhj'ubjb)}(hhh]h)}(hPicture contrast or luma gain.h]hPicture contrast or luma gain.}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKIhjUubah}(h]h ]h"]h$]h&]uh1jahj'ubeh}(h]h ]h"]h$]h&]uh1jBhhhKIhj?hhubjC)}(hO``V4L2_CID_SATURATION`` ``(integer)`` Picture color saturation or chroma gain. h](jI)}(h%``V4L2_CID_SATURATION`` ``(integer)``h](j)}(h``V4L2_CID_SATURATION``h]hV4L2_CID_SATURATION}(hjzhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjvubh }(hjvhhhNhNubj)}(h ``(integer)``h]h (integer)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjvubeh}(h]h ]h"]h$]h&]uh1jHhhhKLhjrubjb)}(hhh]h)}(h(Picture color saturation or chroma gain.h]h(Picture color saturation or chroma gain.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKLhjubah}(h]h ]h"]h$]h&]uh1jahjrubeh}(h]h ]h"]h$]h&]uh1jBhhhKLhj?hhubjC)}(h5``V4L2_CID_HUE`` ``(integer)`` Hue or color balance. h](jI)}(h``V4L2_CID_HUE`` ``(integer)``h](j)}(h``V4L2_CID_HUE``h]h V4L2_CID_HUE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh }(hjhhhNhNubj)}(h ``(integer)``h]h (integer)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jHhhhKOhjubjb)}(hhh]h)}(hHue or color balance.h]hHue or color balance.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKOhjubah}(h]h ]h"]h$]h&]uh1jahjubeh}(h]h ]h"]h$]h&]uh1jBhhhKOhj?hhubjC)}(h}``V4L2_CID_AUDIO_VOLUME`` ``(integer)`` Overall audio volume. Note some drivers also provide an OSS or ALSA mixer interface. h](jI)}(h'``V4L2_CID_AUDIO_VOLUME`` ``(integer)``h](j)}(h``V4L2_CID_AUDIO_VOLUME``h]hV4L2_CID_AUDIO_VOLUME}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh }(hj hhhNhNubj)}(h ``(integer)``h]h (integer)}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jHhhhKShjubjb)}(hhh]h)}(hTOverall audio volume. Note some drivers also provide an OSS or ALSA mixer interface.h]hTOverall audio volume. Note some drivers also provide an OSS or ALSA mixer interface.}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKRhj6ubah}(h]h ]h"]h$]h&]uh1jahjubeh}(h]h ]h"]h$]h&]uh1jBhhhKShj?hhubjC)}(hz``V4L2_CID_AUDIO_BALANCE`` ``(integer)`` Audio stereo balance. Minimum corresponds to all the way left, maximum to right. h](jI)}(h(``V4L2_CID_AUDIO_BALANCE`` ``(integer)``h](j)}(h``V4L2_CID_AUDIO_BALANCE``h]hV4L2_CID_AUDIO_BALANCE}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjWubh }(hjWhhhNhNubj)}(h ``(integer)``h]h (integer)}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjWubeh}(h]h ]h"]h$]h&]uh1jHhhhKWhjSubjb)}(hhh]h)}(hPAudio stereo balance. Minimum corresponds to all the way left, maximum to right.h]hPAudio stereo balance. Minimum corresponds to all the way left, maximum to right.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKVhjubah}(h]h ]h"]h$]h&]uh1jahjSubeh}(h]h ]h"]h$]h&]uh1jBhhhKWhj?hhubjC)}(h=``V4L2_CID_AUDIO_BASS`` ``(integer)`` Audio bass adjustment. h](jI)}(h%``V4L2_CID_AUDIO_BASS`` ``(integer)``h](j)}(h``V4L2_CID_AUDIO_BASS``h]hV4L2_CID_AUDIO_BASS}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh }(hjhhhNhNubj)}(h ``(integer)``h]h (integer)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jHhhhKZhjubjb)}(hhh]h)}(hAudio bass adjustment.h]hAudio bass adjustment.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKZhjubah}(h]h ]h"]h$]h&]uh1jahjubeh}(h]h ]h"]h$]h&]uh1jBhhhKZhj?hhubjC)}(hA``V4L2_CID_AUDIO_TREBLE`` ``(integer)`` Audio treble adjustment. h](jI)}(h'``V4L2_CID_AUDIO_TREBLE`` ``(integer)``h](j)}(h``V4L2_CID_AUDIO_TREBLE``h]hV4L2_CID_AUDIO_TREBLE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh }(hjhhhNhNubj)}(h ``(integer)``h]h (integer)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jHhhhK]hjubjb)}(hhh]h)}(hAudio treble adjustment.h]hAudio treble adjustment.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK]hjubah}(h]h ]h"]h$]h&]uh1jahjubeh}(h]h ]h"]h$]h&]uh1jBhhhK]hj?hhubjC)}(hX#``V4L2_CID_AUDIO_MUTE`` ``(boolean)`` Mute audio, i. e. set the volume to zero, however without affecting ``V4L2_CID_AUDIO_VOLUME``. Like ALSA drivers, V4L2 drivers must mute at load time to avoid excessive noise. Actually the entire device should be reset to a low power consumption state. h](jI)}(h%``V4L2_CID_AUDIO_MUTE`` ``(boolean)``h](j)}(h``V4L2_CID_AUDIO_MUTE``h]hV4L2_CID_AUDIO_MUTE}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj8ubh }(hj8hhhNhNubj)}(h ``(boolean)``h]h (boolean)}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj8ubeh}(h]h ]h"]h$]h&]uh1jHhhhKchj4ubjb)}(hhh]h)}(hMute audio, i. e. set the volume to zero, however without affecting ``V4L2_CID_AUDIO_VOLUME``. Like ALSA drivers, V4L2 drivers must mute at load time to avoid excessive noise. Actually the entire device should be reset to a low power consumption state.h](hDMute audio, i. e. set the volume to zero, however without affecting }(hjehhhNhNubj)}(h``V4L2_CID_AUDIO_VOLUME``h]hV4L2_CID_AUDIO_VOLUME}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjeubh. Like ALSA drivers, V4L2 drivers must mute at load time to avoid excessive noise. Actually the entire device should be reset to a low power consumption state.}(hjehhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK`hjbubah}(h]h ]h"]h$]h&]uh1jahj4ubeh}(h]h ]h"]h$]h&]uh1jBhhhKchj?hhubjC)}(hF``V4L2_CID_AUDIO_LOUDNESS`` ``(boolean)`` Loudness mode (bass boost). h](jI)}(h)``V4L2_CID_AUDIO_LOUDNESS`` ``(boolean)``h](j)}(h``V4L2_CID_AUDIO_LOUDNESS``h]hV4L2_CID_AUDIO_LOUDNESS}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh }(hjhhhNhNubj)}(h ``(boolean)``h]h (boolean)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jHhhhKfhjubjb)}(hhh]h)}(hLoudness mode (bass boost).h]hLoudness mode (bass boost).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKfhjubah}(h]h ]h"]h$]h&]uh1jahjubeh}(h]h ]h"]h$]h&]uh1jBhhhKfhj?hhubjC)}(h``V4L2_CID_BLACK_LEVEL`` ``(integer)`` Another name for brightness (not a synonym of ``V4L2_CID_BRIGHTNESS``). This control is deprecated and should not be used in new drivers and applications. h](jI)}(h&``V4L2_CID_BLACK_LEVEL`` ``(integer)``h](j)}(h``V4L2_CID_BLACK_LEVEL``h]hV4L2_CID_BLACK_LEVEL}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh }(hjhhhNhNubj)}(h ``(integer)``h]h (integer)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jHhhhKkhjubjb)}(hhh]h)}(hAnother name for brightness (not a synonym of ``V4L2_CID_BRIGHTNESS``). This control is deprecated and should not be used in new drivers and applications.h](h.Another name for brightness (not a synonym of }(hj hhhNhNubj)}(h``V4L2_CID_BRIGHTNESS``h]hV4L2_CID_BRIGHTNESS}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubhU). This control is deprecated and should not be used in new drivers and applications.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKihj ubah}(h]h ]h"]h$]h&]uh1jahjubeh}(h]h ]h"]h$]h&]uh1jBhhhKkhj?hhubjC)}(hQ``V4L2_CID_AUTO_WHITE_BALANCE`` ``(boolean)`` Automatic white balance (cameras). h](jI)}(h-``V4L2_CID_AUTO_WHITE_BALANCE`` ``(boolean)``h](j)}(h``V4L2_CID_AUTO_WHITE_BALANCE``h]hV4L2_CID_AUTO_WHITE_BALANCE}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj=ubh }(hj=hhhNhNubj)}(h ``(boolean)``h]h (boolean)}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1jhj=ubeh}(h]h ]h"]h$]h&]uh1jHhhhKnhj9ubjb)}(hhh]h)}(h"Automatic white balance (cameras).h]h"Automatic white balance (cameras).}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKnhjgubah}(h]h ]h"]h$]h&]uh1jahj9ubeh}(h]h ]h"]h$]h&]uh1jBhhhKnhj?hhubjC)}(hX'``V4L2_CID_DO_WHITE_BALANCE`` ``(button)`` This is an action control. When set (the value is ignored), the device will do a white balance and then hold the current setting. Contrast this with the boolean ``V4L2_CID_AUTO_WHITE_BALANCE``, which, when activated, keeps adjusting the white balance. h](jI)}(h*``V4L2_CID_DO_WHITE_BALANCE`` ``(button)``h](j)}(h``V4L2_CID_DO_WHITE_BALANCE``h]hV4L2_CID_DO_WHITE_BALANCE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh }(hjhhhNhNubj)}(h ``(button)``h]h(button)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jHhhhKthjubjb)}(hhh]h)}(hThis is an action control. When set (the value is ignored), the device will do a white balance and then hold the current setting. Contrast this with the boolean ``V4L2_CID_AUTO_WHITE_BALANCE``, which, when activated, keeps adjusting the white balance.h](hThis is an action control. When set (the value is ignored), the device will do a white balance and then hold the current setting. Contrast this with the boolean }(hjhhhNhNubj)}(h``V4L2_CID_AUTO_WHITE_BALANCE``h]hV4L2_CID_AUTO_WHITE_BALANCE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh;, which, when activated, keeps adjusting the white balance.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKqhjubah}(h]h ]h"]h$]h&]uh1jahjubeh}(h]h ]h"]h$]h&]uh1jBhhhKthj?hhubjC)}(h;``V4L2_CID_RED_BALANCE`` ``(integer)`` Red chroma balance. h](jI)}(h&``V4L2_CID_RED_BALANCE`` ``(integer)``h](j)}(h``V4L2_CID_RED_BALANCE``h]hV4L2_CID_RED_BALANCE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh }(hjhhhNhNubj)}(h ``(integer)``h]h (integer)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jHhhhKwhjubjb)}(hhh]h)}(hRed chroma balance.h]hRed chroma balance.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKwhjubah}(h]h ]h"]h$]h&]uh1jahjubeh}(h]h ]h"]h$]h&]uh1jBhhhKwhj?hhubjC)}(h=``V4L2_CID_BLUE_BALANCE`` ``(integer)`` Blue chroma balance. h](jI)}(h'``V4L2_CID_BLUE_BALANCE`` ``(integer)``h](j)}(h``V4L2_CID_BLUE_BALANCE``h]hV4L2_CID_BLUE_BALANCE}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj0ubh }(hj0hhhNhNubj)}(h ``(integer)``h]h (integer)}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj0ubeh}(h]h ]h"]h$]h&]uh1jHhhhKzhj,ubjb)}(hhh]h)}(hBlue chroma balance.h]hBlue chroma balance.}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKzhjZubah}(h]h ]h"]h$]h&]uh1jahj,ubeh}(h]h ]h"]h$]h&]uh1jBhhhKzhj?hhubjC)}(h/``V4L2_CID_GAMMA`` ``(integer)`` Gamma adjust. h](jI)}(h ``V4L2_CID_GAMMA`` ``(integer)``h](j)}(h``V4L2_CID_GAMMA``h]hV4L2_CID_GAMMA}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj{ubh }(hj{hhhNhNubj)}(h ``(integer)``h]h (integer)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj{ubeh}(h]h ]h"]h$]h&]uh1jHhhhK}hjwubjb)}(hhh]h)}(h Gamma adjust.h]h Gamma adjust.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK}hjubah}(h]h ]h"]h$]h&]uh1jahjwubeh}(h]h ]h"]h$]h&]uh1jBhhhK}hj?hhubjC)}(h``V4L2_CID_WHITENESS`` ``(integer)`` Whiteness for grey-scale devices. This is a synonym for ``V4L2_CID_GAMMA``. This control is deprecated and should not be used in new drivers and applications. h](jI)}(h$``V4L2_CID_WHITENESS`` ``(integer)``h](j)}(h``V4L2_CID_WHITENESS``h]hV4L2_CID_WHITENESS}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh }(hjhhhNhNubj)}(h ``(integer)``h]h (integer)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jHhhhKhjubjb)}(hhh]h)}(hWhiteness for grey-scale devices. This is a synonym for ``V4L2_CID_GAMMA``. This control is deprecated and should not be used in new drivers and applications.h](h8Whiteness for grey-scale devices. This is a synonym for }(hjhhhNhNubj)}(h``V4L2_CID_GAMMA``h]hV4L2_CID_GAMMA}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhT. This control is deprecated and should not be used in new drivers and applications.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jahjubeh}(h]h ]h"]h$]h&]uh1jBhhhKhj?hhubjC)}(h@``V4L2_CID_EXPOSURE`` ``(integer)`` Exposure (cameras). [Unit?] h](jI)}(h#``V4L2_CID_EXPOSURE`` ``(integer)``h](j)}(h``V4L2_CID_EXPOSURE``h]hV4L2_CID_EXPOSURE}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj#ubh }(hj#hhhNhNubj)}(h ``(integer)``h]h (integer)}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj#ubeh}(h]h ]h"]h$]h&]uh1jHhhhKhjubjb)}(hhh]h)}(hExposure (cameras). [Unit?]h]hExposure (cameras). [Unit?]}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjMubah}(h]h ]h"]h$]h&]uh1jahjubeh}(h]h ]h"]h$]h&]uh1jBhhhKhj?hhubjC)}(hE``V4L2_CID_AUTOGAIN`` ``(boolean)`` Automatic gain/exposure control. h](jI)}(h#``V4L2_CID_AUTOGAIN`` ``(boolean)``h](j)}(h``V4L2_CID_AUTOGAIN``h]hV4L2_CID_AUTOGAIN}(hjrhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjnubh }(hjnhhhNhNubj)}(h ``(boolean)``h]h (boolean)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjnubeh}(h]h ]h"]h$]h&]uh1jHhhhKhjjubjb)}(hhh]h)}(h Automatic gain/exposure control.h]h Automatic gain/exposure control.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jahjjubeh}(h]h ]h"]h$]h&]uh1jBhhhKhj?hhubjC)}(hXs``V4L2_CID_GAIN`` ``(integer)`` Gain control. Primarily used to control gain on e.g. TV tuners but also on webcams. Most devices control only digital gain with this control but on some this could include analogue gain as well. Devices that recognise the difference between digital and analogue gain use controls ``V4L2_CID_DIGITAL_GAIN`` and ``V4L2_CID_ANALOGUE_GAIN``. h](jI)}(h``V4L2_CID_GAIN`` ``(integer)``h](j)}(h``V4L2_CID_GAIN``h]h V4L2_CID_GAIN}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh }(hjhhhNhNubj)}(h ``(integer)``h]h (integer)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jHhhhKhjubjb)}(hhh](h)}(h Gain control.h]h Gain control.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(hXCPrimarily used to control gain on e.g. TV tuners but also on webcams. Most devices control only digital gain with this control but on some this could include analogue gain as well. Devices that recognise the difference between digital and analogue gain use controls ``V4L2_CID_DIGITAL_GAIN`` and ``V4L2_CID_ANALOGUE_GAIN``.h](hX Primarily used to control gain on e.g. TV tuners but also on webcams. Most devices control only digital gain with this control but on some this could include analogue gain as well. Devices that recognise the difference between digital and analogue gain use controls }(hjhhhNhNubj)}(h``V4L2_CID_DIGITAL_GAIN``h]hV4L2_CID_DIGITAL_GAIN}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh and }(hjhhhNhNubj)}(h``V4L2_CID_ANALOGUE_GAIN``h]hV4L2_CID_ANALOGUE_GAIN}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubeh}(h]h ]h"]h$]h&]uh1jahjubeh}(h]h ]h"]h$]h&]uh1jBhhhKhj?hhubeh}(h]h ]h"]h$]h&]uh1j=hj,hhhhhNubh)}(h.. _v4l2-cid-hflip:h]h}(h]h ]h"]h$]h&]hԌv4l2-cid-hflipuh1hhKhj,hhhhubj>)}(hhh]jC)}(hB``V4L2_CID_HFLIP`` ``(boolean)`` Mirror the picture horizontally. h](jI)}(h ``V4L2_CID_HFLIP`` ``(boolean)``h](j)}(h``V4L2_CID_HFLIP``h]hV4L2_CID_HFLIP}(hjN hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjJ ubh }(hjJ hhhNhNubj)}(h ``(boolean)``h]h (boolean)}(hj` hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjJ ubeh}(h]h ]h"]h$]h&]uh1jHhhhKhjF ubjb)}(hhh]h)}(h Mirror the picture horizontally.h]h Mirror the picture horizontally.}(hjw hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjt ubah}(h]h ]h"]h$]h&]uh1jahjF ubeh}(h]h ]h"]h$]h&]uh1jBhhhKhjC ubah}(h]jB ah ]h"]v4l2-cid-hflipah$]h&]uh1j=hj,hhhhhNexpect_referenced_by_name}j j8 sexpect_referenced_by_id}jB j8 subh)}(h.. _v4l2-cid-vflip:h]h}(h]h ]h"]h$]h&]hԌv4l2-cid-vflipuh1hhKhj,hhhhubj>)}(hhh]jC)}(h@``V4L2_CID_VFLIP`` ``(boolean)`` Mirror the picture vertically. h](jI)}(h ``V4L2_CID_VFLIP`` ``(boolean)``h](j)}(h``V4L2_CID_VFLIP``h]hV4L2_CID_VFLIP}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh }(hj hhhNhNubj)}(h ``(boolean)``h]h (boolean)}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jHhhhKhj ubjb)}(hhh]h)}(hMirror the picture vertically.h]hMirror the picture vertically.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1jahj ubeh}(h]h ]h"]h$]h&]uh1jBhhhKhj ubah}(h]j ah ]h"]v4l2-cid-vflipah$]h&]uh1j=hj,hhhhhNj }j j sj }j j subh)}(h.. _v4l2-power-line-frequency:h]h}(h]h ]h"]h$]h&]hԌv4l2-power-line-frequencyuh1hhKhj,hhhhubj>)}(hhh](jC)}(hX``V4L2_CID_POWER_LINE_FREQUENCY`` ``(enum)`` Enables a power line frequency filter to avoid flicker. Possible values for ``enum v4l2_power_line_frequency`` are: ========================================== == ``V4L2_CID_POWER_LINE_FREQUENCY_DISABLED`` 0 ``V4L2_CID_POWER_LINE_FREQUENCY_50HZ`` 1 ``V4L2_CID_POWER_LINE_FREQUENCY_60HZ`` 2 ``V4L2_CID_POWER_LINE_FREQUENCY_AUTO`` 3 ========================================== == h](jI)}(h,``V4L2_CID_POWER_LINE_FREQUENCY`` ``(enum)``h](j)}(h!``V4L2_CID_POWER_LINE_FREQUENCY``h]hV4L2_CID_POWER_LINE_FREQUENCY}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh }(hj hhhNhNubj)}(h ``(enum)``h]h(enum)}(hj& hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jHhhhKhj ubjb)}(hhh](h)}(hsEnables a power line frequency filter to avoid flicker. Possible values for ``enum v4l2_power_line_frequency`` are:h](hLEnables a power line frequency filter to avoid flicker. Possible values for }(hj= hhhNhNubj)}(h"``enum v4l2_power_line_frequency``h]henum v4l2_power_line_frequency}(hjE hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj= ubh are:}(hj= hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj: ubhtable)}(hhh]htgroup)}(hhh](hcolspec)}(hhh]h}(h]h ]h"]h$]h&]colwidthK*uh1jg hjd ubjh )}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jg hjd ubhtbody)}(hhh](hrow)}(hhh](hentry)}(hhh]h)}(h*``V4L2_CID_POWER_LINE_FREQUENCY_DISABLED``h]j)}(hj h]h&V4L2_CID_POWER_LINE_FREQUENCY_DISABLED}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(h0h]h0}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1j hj ubeh}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh](j )}(hhh]h)}(h&``V4L2_CID_POWER_LINE_FREQUENCY_50HZ``h]j)}(hj h]h"V4L2_CID_POWER_LINE_FREQUENCY_50HZ}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(h1h]h1}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1j hj ubeh}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh](j )}(hhh]h)}(h&``V4L2_CID_POWER_LINE_FREQUENCY_60HZ``h]j)}(hj h]h"V4L2_CID_POWER_LINE_FREQUENCY_60HZ}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(h2h]h2}(hj, hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj) ubah}(h]h ]h"]h$]h&]uh1j hj ubeh}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh](j )}(hhh]h)}(h&``V4L2_CID_POWER_LINE_FREQUENCY_AUTO``h]j)}(hjN h]h"V4L2_CID_POWER_LINE_FREQUENCY_AUTO}(hjP hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjL ubah}(h]h ]h"]h$]h&]uh1hhhhKhjI ubah}(h]h ]h"]h$]h&]uh1j hjF ubj )}(hhh]h)}(h3h]h3}(hjl hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhji ubah}(h]h ]h"]h$]h&]uh1j hjF ubeh}(h]h ]h"]h$]h&]uh1j hj ubeh}(h]h ]h"]h$]h&]uh1j} hjd ubeh}(h]h ]h"]h$]h&]colsKuh1jb hj_ ubah}(h]h ]h"]h$]h&]uh1j] hj: ubeh}(h]h ]h"]h$]h&]uh1jahj ubeh}(h]h ]h"]h$]h&]uh1jBhhhKhj ubjC)}(h``V4L2_CID_HUE_AUTO`` ``(boolean)`` Enables automatic hue control by the device. The effect of setting ``V4L2_CID_HUE`` while automatic hue control is enabled is undefined, drivers should ignore such request. h](jI)}(h#``V4L2_CID_HUE_AUTO`` ``(boolean)``h](j)}(h``V4L2_CID_HUE_AUTO``h]hV4L2_CID_HUE_AUTO}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh }(hj hhhNhNubj)}(h ``(boolean)``h]h (boolean)}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jHhhhKhj ubjb)}(hhh]h)}(hEnables automatic hue control by the device. The effect of setting ``V4L2_CID_HUE`` while automatic hue control is enabled is undefined, drivers should ignore such request.h](hCEnables automatic hue control by the device. The effect of setting }(hj hhhNhNubj)}(h``V4L2_CID_HUE``h]h V4L2_CID_HUE}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubhY while automatic hue control is enabled is undefined, drivers should ignore such request.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1jahj ubeh}(h]h ]h"]h$]h&]uh1jBhhhKhj hhubjC)}(hXD``V4L2_CID_WHITE_BALANCE_TEMPERATURE`` ``(integer)`` This control specifies the white balance settings as a color temperature in Kelvin. A driver should have a minimum of 2800 (incandescent) to 6500 (daylight). For more information about color temperature see `Wikipedia `__. h](jI)}(h4``V4L2_CID_WHITE_BALANCE_TEMPERATURE`` ``(integer)``h](j)}(h&``V4L2_CID_WHITE_BALANCE_TEMPERATURE``h]h"V4L2_CID_WHITE_BALANCE_TEMPERATURE}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh }(hj hhhNhNubj)}(h ``(integer)``h]h (integer)}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jHhhhKhj ubjb)}(hhh]h)}(hXThis control specifies the white balance settings as a color temperature in Kelvin. A driver should have a minimum of 2800 (incandescent) to 6500 (daylight). For more information about color temperature see `Wikipedia `__.h](hThis control specifies the white balance settings as a color temperature in Kelvin. A driver should have a minimum of 2800 (incandescent) to 6500 (daylight). For more information about color temperature see }(hj3 hhhNhNubh reference)}(h>`Wikipedia `__h]h Wikipedia}(hj= hhhNhNubah}(h]h ]h"]h$]h&]name Wikipediarefuri.http://en.wikipedia.org/wiki/Color_temperatureuh1j; hj3 ubh.}(hj3 hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj0 ubah}(h]h ]h"]h$]h&]uh1jahj ubeh}(h]h ]h"]h$]h&]uh1jBhhhKhj hhubjC)}(h``V4L2_CID_SHARPNESS`` ``(integer)`` Adjusts the sharpness filters in a camera. The minimum value disables the filters, higher values give a sharper picture. h](jI)}(h$``V4L2_CID_SHARPNESS`` ``(integer)``h](j)}(h``V4L2_CID_SHARPNESS``h]hV4L2_CID_SHARPNESS}(hjm hhhNhNubah}(h]h ]h"]h$]h&]uh1jhji ubh }(hji hhhNhNubj)}(h ``(integer)``h]h (integer)}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhji ubeh}(h]h ]h"]h$]h&]uh1jHhhhKhje ubjb)}(hhh]h)}(hxAdjusts the sharpness filters in a camera. The minimum value disables the filters, higher values give a sharper picture.h]hxAdjusts the sharpness filters in a camera. The minimum value disables the filters, higher values give a sharper picture.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1jahje ubeh}(h]h ]h"]h$]h&]uh1jBhhhKhj hhubjC)}(h``V4L2_CID_BACKLIGHT_COMPENSATION`` ``(integer)`` Adjusts the backlight compensation in a camera. The minimum value disables backlight compensation. h](jI)}(h1``V4L2_CID_BACKLIGHT_COMPENSATION`` ``(integer)``h](j)}(h#``V4L2_CID_BACKLIGHT_COMPENSATION``h]hV4L2_CID_BACKLIGHT_COMPENSATION}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh }(hj hhhNhNubj)}(h ``(integer)``h]h (integer)}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jHhhhKhj ubjb)}(hhh]h)}(hbAdjusts the backlight compensation in a camera. The minimum value disables backlight compensation.h]hbAdjusts the backlight compensation in a camera. The minimum value disables backlight compensation.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1jahj ubeh}(h]h ]h"]h$]h&]uh1jBhhhKhj hhubjC)}(hE``V4L2_CID_CHROMA_AGC`` ``(boolean)`` Chroma automatic gain control. h](jI)}(h%``V4L2_CID_CHROMA_AGC`` ``(boolean)``h](j)}(h``V4L2_CID_CHROMA_AGC``h]hV4L2_CID_CHROMA_AGC}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh }(hj hhhNhNubj)}(h ``(boolean)``h]h (boolean)}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jHhhhKhj ubjb)}(hhh]h)}(hChroma automatic gain control.h]hChroma automatic gain control.}(hj, hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj) ubah}(h]h ]h"]h$]h&]uh1jahj ubeh}(h]h ]h"]h$]h&]uh1jBhhhKhj hhubjC)}(hn``V4L2_CID_CHROMA_GAIN`` ``(integer)`` Adjusts the Chroma gain control (for use when chroma AGC is disabled). h](jI)}(h&``V4L2_CID_CHROMA_GAIN`` ``(integer)``h](j)}(h``V4L2_CID_CHROMA_GAIN``h]hV4L2_CID_CHROMA_GAIN}(hjN hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjJ ubh }(hjJ hhhNhNubj)}(h ``(integer)``h]h (integer)}(hj` hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjJ ubeh}(h]h ]h"]h$]h&]uh1jHhhhKhjF ubjb)}(hhh]h)}(hFAdjusts the Chroma gain control (for use when chroma AGC is disabled).h]hFAdjusts the Chroma gain control (for use when chroma AGC is disabled).}(hjw hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjt ubah}(h]h ]h"]h$]h&]uh1jahjF ubeh}(h]h ]h"]h$]h&]uh1jBhhhKhj hhubjC)}(h``V4L2_CID_COLOR_KILLER`` ``(boolean)`` Enable the color killer (i. e. force a black & white image in case of a weak video signal). h](jI)}(h'``V4L2_CID_COLOR_KILLER`` ``(boolean)``h](j)}(h``V4L2_CID_COLOR_KILLER``h]hV4L2_CID_COLOR_KILLER}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh }(hj hhhNhNubj)}(h ``(boolean)``h]h (boolean)}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jHhhhKhj ubjb)}(hhh]h)}(h[Enable the color killer (i. e. force a black & white image in case of a weak video signal).h]h[Enable the color killer (i. e. force a black & white image in case of a weak video signal).}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1jahj ubeh}(h]h ]h"]h$]h&]uh1jBhhhKhj hhubeh}(h]j ah ]h"]v4l2-power-line-frequencyah$]h&]uh1j=hj,hhhhhNj }j j sj }j j subh)}(h.. _v4l2-colorfx:h]h}(h]h ]h"]h$]h&]hԌ v4l2-colorfxuh1hhKhj,hhhhubj>)}(hhh]jC)}(h\``V4L2_CID_COLORFX`` ``(enum)`` Selects a color effect. The following values are defined: h](jI)}(h``V4L2_CID_COLORFX`` ``(enum)``h](j)}(h``V4L2_CID_COLORFX``h]hV4L2_CID_COLORFX}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh }(hj hhhNhNubj)}(h ``(enum)``h]h(enum)}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jHhhhKhj ubjb)}(hhh]h)}(h9Selects a color effect. The following values are defined:h]h9Selects a color effect. The following values are defined:}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj!ubah}(h]h ]h"]h$]h&]uh1jahj ubeh}(h]h ]h"]h$]h&]uh1jBhhhKhj ubah}(h]j ah ]h"] v4l2-colorfxah$]h&]uh1j=hj,hhhhhNj }jBj sj }j j subhtabular_col_spec)}(hhh]h}(h]h ]h"]h$]h&]spec|p{5.7cm}|p{11.8cm}|uh1jGhhhKhj,hhubj^ )}(hhh]jc )}(hhh](jh )}(hhh]h}(h]h ]h"]h$]h&]colwidthK uh1jg hjWubjh )}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jg hjWubj~ )}(hhh](j )}(hhh](j )}(hhh]h)}(h``V4L2_COLORFX_NONE``h]j)}(hjyh]hV4L2_COLORFX_NONE}(hj{hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjwubah}(h]h ]h"]h$]h&]uh1hhhhKhjtubah}(h]h ]h"]h$]h&]uh1j hjqubj )}(hhh]h)}(hColor effect is disabled.h]hColor effect is disabled.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j hjqubeh}(h]h ]h"]h$]h&]uh1j hjnubj )}(hhh](j )}(hhh]h)}(h``V4L2_COLORFX_ANTIQUE``h]j)}(hjh]hV4L2_COLORFX_ANTIQUE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hAn aging (old photo) effect.h]hAn aging (old photo) effect.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjnubj )}(hhh](j )}(hhh]h)}(h``V4L2_COLORFX_ART_FREEZE``h]j)}(hjh]hV4L2_COLORFX_ART_FREEZE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hFrost color effect.h]hFrost color effect.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjnubj )}(hhh](j )}(hhh]h)}(h``V4L2_COLORFX_AQUA``h]j)}(hj9h]hV4L2_COLORFX_AQUA}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj7ubah}(h]h ]h"]h$]h&]uh1hhhhKhj4ubah}(h]h ]h"]h$]h&]uh1j hj1ubj )}(hhh]h)}(hWater color, cool tone.h]hWater color, cool tone.}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjTubah}(h]h ]h"]h$]h&]uh1j hj1ubeh}(h]h ]h"]h$]h&]uh1j hjnubj )}(hhh](j )}(hhh]h)}(h``V4L2_COLORFX_BW``h]j)}(hjyh]hV4L2_COLORFX_BW}(hj{hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjwubah}(h]h ]h"]h$]h&]uh1hhhhKhjtubah}(h]h ]h"]h$]h&]uh1j hjqubj )}(hhh]h)}(hBlack and white.h]hBlack and white.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j hjqubeh}(h]h ]h"]h$]h&]uh1j hjnubj )}(hhh](j )}(hhh]h)}(h``V4L2_COLORFX_EMBOSS``h]j)}(hjh]hV4L2_COLORFX_EMBOSS}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(huEmboss, the highlights and shadows replace light/dark boundaries and low contrast areas are set to a gray background.h]huEmboss, the highlights and shadows replace light/dark boundaries and low contrast areas are set to a gray background.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjnubj )}(hhh](j )}(hhh]h)}(h``V4L2_COLORFX_GRASS_GREEN``h]j)}(hjh]hV4L2_COLORFX_GRASS_GREEN}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(h Grass green.h]h Grass green.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjnubj )}(hhh](j )}(hhh]h)}(h``V4L2_COLORFX_NEGATIVE``h]j)}(hj9h]hV4L2_COLORFX_NEGATIVE}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj7ubah}(h]h ]h"]h$]h&]uh1hhhhKhj4ubah}(h]h ]h"]h$]h&]uh1j hj1ubj )}(hhh]h)}(h Negative.h]h Negative.}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjTubah}(h]h ]h"]h$]h&]uh1j hj1ubeh}(h]h ]h"]h$]h&]uh1j hjnubj )}(hhh](j )}(hhh]h)}(h``V4L2_COLORFX_SEPIA``h]j)}(hjyh]hV4L2_COLORFX_SEPIA}(hj{hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjwubah}(h]h ]h"]h$]h&]uh1hhhhKhjtubah}(h]h ]h"]h$]h&]uh1j hjqubj )}(hhh]h)}(h Sepia tone.h]h Sepia tone.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j hjqubeh}(h]h ]h"]h$]h&]uh1j hjnubj )}(hhh](j )}(hhh]h)}(h``V4L2_COLORFX_SKETCH``h]j)}(hjh]hV4L2_COLORFX_SKETCH}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hSketch.h]hSketch.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjnubj )}(hhh](j )}(hhh]h)}(h``V4L2_COLORFX_SKIN_WHITEN``h]j)}(hjh]hV4L2_COLORFX_SKIN_WHITEN}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(h Skin whiten.h]h Skin whiten.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjnubj )}(hhh](j )}(hhh]h)}(h``V4L2_COLORFX_SKY_BLUE``h]j)}(hj9h]hV4L2_COLORFX_SKY_BLUE}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj7ubah}(h]h ]h"]h$]h&]uh1hhhhKhj4ubah}(h]h ]h"]h$]h&]uh1j hj1ubj )}(hhh]h)}(h Sky blue.h]h Sky blue.}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjTubah}(h]h ]h"]h$]h&]uh1j hj1ubeh}(h]h ]h"]h$]h&]uh1j hjnubj )}(hhh](j )}(hhh]h)}(h``V4L2_COLORFX_SOLARIZATION``h]j)}(hjyh]hV4L2_COLORFX_SOLARIZATION}(hj{hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjwubah}(h]h ]h"]h$]h&]uh1hhhhKhjtubah}(h]h ]h"]h$]h&]uh1j hjqubj )}(hhh]h)}(hySolarization, the image is partially reversed in tone, only color values above or below a certain threshold are inverted.h]hySolarization, the image is partially reversed in tone, only color values above or below a certain threshold are inverted.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j hjqubeh}(h]h ]h"]h$]h&]uh1j hjnubj )}(hhh](j )}(hhh]h)}(h``V4L2_COLORFX_SILHOUETTE``h]j)}(hjh]hV4L2_COLORFX_SILHOUETTE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hSilhouette (outline).h]hSilhouette (outline).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjnubj )}(hhh](j )}(hhh]h)}(h``V4L2_COLORFX_VIVID``h]j)}(hjh]hV4L2_COLORFX_VIVID}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(h Vivid colors.h]h Vivid colors.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjnubj )}(hhh](j )}(hhh]h)}(h``V4L2_COLORFX_SET_CBCR``h]j)}(hj9h]hV4L2_COLORFX_SET_CBCR}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj7ubah}(h]h ]h"]h$]h&]uh1hhhhKhj4ubah}(h]h ]h"]h$]h&]uh1j hj1ubj )}(hhh]h)}(hsThe Cb and Cr chroma components are replaced by fixed coefficients determined by ``V4L2_CID_COLORFX_CBCR`` control.h](hQThe Cb and Cr chroma components are replaced by fixed coefficients determined by }(hjWhhhNhNubj)}(h``V4L2_CID_COLORFX_CBCR``h]hV4L2_CID_COLORFX_CBCR}(hj_hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjWubh control.}(hjWhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjTubah}(h]h ]h"]h$]h&]uh1j hj1ubeh}(h]h ]h"]h$]h&]uh1j hjnubj )}(hhh](j )}(hhh]h)}(h``V4L2_COLORFX_SET_RGB``h]j)}(hjh]hV4L2_COLORFX_SET_RGB}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hkThe RGB components are replaced by the fixed RGB components determined by ``V4L2_CID_COLORFX_RGB`` control.h](hJThe RGB components are replaced by the fixed RGB components determined by }(hjhhhNhNubj)}(h``V4L2_CID_COLORFX_RGB``h]hV4L2_CID_COLORFX_RGB}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh control.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjnubeh}(h]h ]h"]h$]h&]uh1j} hjWubeh}(h]h ]h"]h$]h&]colsKuh1jb hjTubah}(h]h ]h"]h$]h&]uh1j] hj,hhhNhNubj>)}(hhh](jC)}(hX,``V4L2_CID_COLORFX_RGB`` ``(integer)`` Determines the Red, Green, and Blue coefficients for ``V4L2_COLORFX_SET_RGB`` color effect. Bits [7:0] of the supplied 32 bit value are interpreted as Blue component, bits [15:8] as Green component, bits [23:16] as Red component, and bits [31:24] must be zero. h](jI)}(h&``V4L2_CID_COLORFX_RGB`` ``(integer)``h](j)}(h``V4L2_CID_COLORFX_RGB``h]hV4L2_CID_COLORFX_RGB}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh }(hjhhhNhNubj)}(h ``(integer)``h]h (integer)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jHhhhMhjubjb)}(hhh]h)}(hXDetermines the Red, Green, and Blue coefficients for ``V4L2_COLORFX_SET_RGB`` color effect. Bits [7:0] of the supplied 32 bit value are interpreted as Blue component, bits [15:8] as Green component, bits [23:16] as Red component, and bits [31:24] must be zero.h](h5Determines the Red, Green, and Blue coefficients for }(hjhhhNhNubj)}(h``V4L2_COLORFX_SET_RGB``h]hV4L2_COLORFX_SET_RGB}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh color effect. Bits [7:0] of the supplied 32 bit value are interpreted as Blue component, bits [15:8] as Green component, bits [23:16] as Red component, and bits [31:24] must be zero.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jahjubeh}(h]h ]h"]h$]h&]uh1jBhhhMhjubjC)}(h``V4L2_CID_COLORFX_CBCR`` ``(integer)`` Determines the Cb and Cr coefficients for ``V4L2_COLORFX_SET_CBCR`` color effect. Bits [7:0] of the supplied 32 bit value are interpreted as Cr component, bits [15:8] as Cb component and bits [31:16] must be zero. h](jI)}(h'``V4L2_CID_COLORFX_CBCR`` ``(integer)``h](j)}(h``V4L2_CID_COLORFX_CBCR``h]hV4L2_CID_COLORFX_CBCR}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjLubh }(hjLhhhNhNubj)}(h ``(integer)``h]h (integer)}(hjbhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjLubeh}(h]h ]h"]h$]h&]uh1jHhhhM hjHubjb)}(hhh]h)}(hDetermines the Cb and Cr coefficients for ``V4L2_COLORFX_SET_CBCR`` color effect. Bits [7:0] of the supplied 32 bit value are interpreted as Cr component, bits [15:8] as Cb component and bits [31:16] must be zero.h](h*Determines the Cb and Cr coefficients for }(hjyhhhNhNubj)}(h``V4L2_COLORFX_SET_CBCR``h]hV4L2_COLORFX_SET_CBCR}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjyubh color effect. Bits [7:0] of the supplied 32 bit value are interpreted as Cr component, bits [15:8] as Cb component and bits [31:16] must be zero.}(hjyhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjvubah}(h]h ]h"]h$]h&]uh1jahjHubeh}(h]h ]h"]h$]h&]uh1jBhhhM hjhhubjC)}(hG``V4L2_CID_AUTOBRIGHTNESS`` ``(boolean)`` Enable Automatic Brightness. h](jI)}(h)``V4L2_CID_AUTOBRIGHTNESS`` ``(boolean)``h](j)}(h``V4L2_CID_AUTOBRIGHTNESS``h]hV4L2_CID_AUTOBRIGHTNESS}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh }(hjhhhNhNubj)}(h ``(boolean)``h]h (boolean)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jHhhhM hjubjb)}(hhh]h)}(hEnable Automatic Brightness.h]hEnable Automatic Brightness.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hjubah}(h]h ]h"]h$]h&]uh1jahjubeh}(h]h ]h"]h$]h&]uh1jBhhhM hjhhubjC)}(hXa``V4L2_CID_ROTATE`` ``(integer)`` Rotates the image by specified angle. Common angles are 90, 270 and 180. Rotating the image to 90 and 270 will reverse the height and width of the display window. It is necessary to set the new height and width of the picture using the :ref:`VIDIOC_S_FMT ` ioctl according to the rotation angle selected. h](jI)}(h!``V4L2_CID_ROTATE`` ``(integer)``h](j)}(h``V4L2_CID_ROTATE``h]hV4L2_CID_ROTATE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh }(hjhhhNhNubj)}(h ``(integer)``h]h (integer)}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jHhhhMhjubjb)}(hhh]h)}(hX>Rotates the image by specified angle. Common angles are 90, 270 and 180. Rotating the image to 90 and 270 will reverse the height and width of the display window. It is necessary to set the new height and width of the picture using the :ref:`VIDIOC_S_FMT ` ioctl according to the rotation angle selected.h](hRotates the image by specified angle. Common angles are 90, 270 and 180. Rotating the image to 90 and 270 will reverse the height and width of the display window. It is necessary to set the new height and width of the picture using the }(hj!hhhNhNubh)}(h":ref:`VIDIOC_S_FMT `h]jH)}(hj+h]h VIDIOC_S_FMT}(hj-hhhNhNubah}(h]h ](jSstdstd-refeh"]h$]h&]uh1jGhj)ubah}(h]h ]h"]h$]h&]refdocj+ refdomainj7reftyperef refexplicitrefwarnje vidioc_g_fmtuh1hhhhMhj!ubh0 ioctl according to the rotation angle selected.}(hj!hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jahjubeh}(h]h ]h"]h$]h&]uh1jBhhhMhjhhubjC)}(hXF``V4L2_CID_BG_COLOR`` ``(integer)`` Sets the background color on the current output device. Background color needs to be specified in the RGB24 format. The supplied 32 bit value is interpreted as bits 0-7 Red color information, bits 8-15 Green color information, bits 16-23 Blue color information and bits 24-31 must be zero. h](jI)}(h#``V4L2_CID_BG_COLOR`` ``(integer)``h](j)}(h``V4L2_CID_BG_COLOR``h]hV4L2_CID_BG_COLOR}(hjghhhNhNubah}(h]h ]h"]h$]h&]uh1jhjcubh }(hjchhhNhNubj)}(h ``(integer)``h]h (integer)}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjcubeh}(h]h ]h"]h$]h&]uh1jHhhhMhj_ubjb)}(hhh]h)}(hX!Sets the background color on the current output device. Background color needs to be specified in the RGB24 format. The supplied 32 bit value is interpreted as bits 0-7 Red color information, bits 8-15 Green color information, bits 16-23 Blue color information and bits 24-31 must be zero.h]hX!Sets the background color on the current output device. Background color needs to be specified in the RGB24 format. The supplied 32 bit value is interpreted as bits 0-7 Red color information, bits 8-15 Green color information, bits 16-23 Blue color information and bits 24-31 must be zero.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jahj_ubeh}(h]h ]h"]h$]h&]uh1jBhhhMhjhhubjC)}(h``V4L2_CID_ILLUMINATORS_1 V4L2_CID_ILLUMINATORS_2`` ``(boolean)`` Switch on or off the illuminator 1 or 2 of the device (usually a microscope). h](jI)}(hA``V4L2_CID_ILLUMINATORS_1 V4L2_CID_ILLUMINATORS_2`` ``(boolean)``h](j)}(h3``V4L2_CID_ILLUMINATORS_1 V4L2_CID_ILLUMINATORS_2``h]h/V4L2_CID_ILLUMINATORS_1 V4L2_CID_ILLUMINATORS_2}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh }(hjhhhNhNubj)}(h ``(boolean)``h]h (boolean)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jHhhhM hjubjb)}(hhh]h)}(hMSwitch on or off the illuminator 1 or 2 of the device (usually a microscope).h]hMSwitch on or off the illuminator 1 or 2 of the device (usually a microscope).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jahjubeh}(h]h ]h"]h$]h&]uh1jBhhhM hjhhubjC)}(hXP``V4L2_CID_MIN_BUFFERS_FOR_CAPTURE`` ``(integer)`` This is a read-only control that can be read by the application and used as a hint to determine the number of CAPTURE buffers to pass to REQBUFS. The value is the minimum number of CAPTURE buffers that is necessary for hardware to work. This control is required for stateful decoders. h](jI)}(h2``V4L2_CID_MIN_BUFFERS_FOR_CAPTURE`` ``(integer)``h](j)}(h$``V4L2_CID_MIN_BUFFERS_FOR_CAPTURE``h]h V4L2_CID_MIN_BUFFERS_FOR_CAPTURE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh }(hjhhhNhNubj)}(h ``(integer)``h]h (integer)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jHhhhM'hjubjb)}(hhh]h)}(hXThis is a read-only control that can be read by the application and used as a hint to determine the number of CAPTURE buffers to pass to REQBUFS. The value is the minimum number of CAPTURE buffers that is necessary for hardware to work. This control is required for stateful decoders._ph]hXThis is a read-only control that can be read by the application and used as a hint to determine the number of CAPTURE buffers to pass to REQBUFS. The value is the minimum number of CAPTURE buffers that is necessary for hardware to work. This control is required for stateful decoders.}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM#hj#ubah}(h]h ]h"]h$]h&]uh1jahjubeh}(h]h ]h"]h$]h&]uh1jBhhhM'hjhhubjC)}(hXM``V4L2_CID_MIN_BUFFERS_FOR_OUTPUT`` ``(integer)`` This is a read-only control that can be read by the application and used as a hint to determine the number of OUTPUT buffers to pass to REQBUFS. The value is the minimum number of OUTPUT buffers that is necessary for hardware to work. This control is required for stateful encoders. h](jI)}(h1``V4L2_CID_MIN_BUFFERS_FOR_OUTPUT`` ``(integer)``h](j)}(h#``V4L2_CID_MIN_BUFFERS_FOR_OUTPUT``h]hV4L2_CID_MIN_BUFFERS_FOR_OUTPUT}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjDubh }(hjDhhhNhNubj)}(h ``(integer)``h]h (integer)}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjDubeh}(h]h ]h"]h$]h&]uh1jHhhhM.hj@ubjb)}(hhh]h)}(hXThis is a read-only control that can be read by the application and used as a hint to determine the number of OUTPUT buffers to pass to REQBUFS. The value is the minimum number of OUTPUT buffers that is necessary for hardware to work. This control is required for stateful encoders.h]hXThis is a read-only control that can be read by the application and used as a hint to determine the number of OUTPUT buffers to pass to REQBUFS. The value is the minimum number of OUTPUT buffers that is necessary for hardware to work. This control is required for stateful encoders.}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM*hjnubah}(h]h ]h"]h$]h&]uh1jahj@ubeh}(h]h ]h"]h$]h&]uh1jBhhhM.hjhhubeh}(h]h ]h"]h$]h&]uh1j=hj,hhhhhNubh)}(h.. _v4l2-alpha-component:h]h}(h]h ]h"]h$]h&]hԌv4l2-alpha-componentuh1hhM0hj,hhhhubj>)}(hhh](jC)}(hX``V4L2_CID_ALPHA_COMPONENT`` ``(integer)`` Sets the alpha color component. When a capture device (or capture queue of a mem-to-mem device) produces a frame format that includes an alpha component (e.g. :ref:`packed RGB image formats `) and the alpha value is not defined by the device or the mem-to-mem input data this control lets you select the alpha component value of all pixels. When an output device (or output queue of a mem-to-mem device) consumes a frame format that doesn't include an alpha component and the device supports alpha channel processing this control lets you set the alpha component value of all pixels for further processing in the device. h](jI)}(h*``V4L2_CID_ALPHA_COMPONENT`` ``(integer)``h](j)}(h``V4L2_CID_ALPHA_COMPONENT``h]hV4L2_CID_ALPHA_COMPONENT}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh }(hjhhhNhNubj)}(h ``(integer)``h]h (integer)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jHhhhM=hjubjb)}(hhh]h)}(hXxSets the alpha color component. When a capture device (or capture queue of a mem-to-mem device) produces a frame format that includes an alpha component (e.g. :ref:`packed RGB image formats `) and the alpha value is not defined by the device or the mem-to-mem input data this control lets you select the alpha component value of all pixels. When an output device (or output queue of a mem-to-mem device) consumes a frame format that doesn't include an alpha component and the device supports alpha channel processing this control lets you set the alpha component value of all pixels for further processing in the device.h](hSets the alpha color component. When a capture device (or capture queue of a mem-to-mem device) produces a frame format that includes an alpha component (e.g. }(hjhhhNhNubh)}(h,:ref:`packed RGB image formats `h]jH)}(hjh]hpacked RGB image formats}(hjhhhNhNubah}(h]h ](jSstdstd-refeh"]h$]h&]uh1jGhjubah}(h]h ]h"]h$]h&]refdocj+ refdomainjreftyperef refexplicitrefwarnje pixfmt-rgbuh1hhhhM3hjubhX) and the alpha value is not defined by the device or the mem-to-mem input data this control lets you select the alpha component value of all pixels. When an output device (or output queue of a mem-to-mem device) consumes a frame format that doesn’t include an alpha component and the device supports alpha channel processing this control lets you set the alpha component value of all pixels for further processing in the device.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM3hjubah}(h]h ]h"]h$]h&]uh1jahjubeh}(h]h ]h"]h$]h&]uh1jBhhhM=hjubjC)}(hd``V4L2_CID_LASTP1`` End of the predefined control IDs (currently ``V4L2_CID_ALPHA_COMPONENT`` + 1). h](jI)}(h``V4L2_CID_LASTP1``h]j)}(hjh]hV4L2_CID_LASTP1}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jHhhhMAhjubjb)}(hhh]h)}(hOEnd of the predefined control IDs (currently ``V4L2_CID_ALPHA_COMPONENT`` + 1).h](h-End of the predefined control IDs (currently }(hj,hhhNhNubj)}(h``V4L2_CID_ALPHA_COMPONENT``h]hV4L2_CID_ALPHA_COMPONENT}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj,ubh + 1).}(hj,hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM@hj)ubah}(h]h ]h"]h$]h&]uh1jahjubeh}(h]h ]h"]h$]h&]uh1jBhhhMAhjhhubjC)}(h``V4L2_CID_PRIVATE_BASE`` ID of the first custom (driver specific) control. Applications depending on particular custom controls should check the driver name and version, see :ref:`querycap`. h](jI)}(h``V4L2_CID_PRIVATE_BASE``h]j)}(hj^h]hV4L2_CID_PRIVATE_BASE}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj\ubah}(h]h ]h"]h$]h&]uh1jHhhhMFhjXubjb)}(hhh]h)}(hID of the first custom (driver specific) control. Applications depending on particular custom controls should check the driver name and version, see :ref:`querycap`.h](hID of the first custom (driver specific) control. Applications depending on particular custom controls should check the driver name and version, see }(hjvhhhNhNubh)}(h:ref:`querycap`h]jH)}(hjh]hquerycap}(hjhhhNhNubah}(h]h ](jSstdstd-refeh"]h$]h&]uh1jGhj~ubah}(h]h ]h"]h$]h&]refdocj+ refdomainjreftyperef refexplicitrefwarnjequerycapuh1hhhhMDhjvubh.}(hjvhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMDhjsubah}(h]h ]h"]h$]h&]uh1jahjXubeh}(h]h ]h"]h$]h&]uh1jBhhhMFhjhhubeh}(h]jah ]h"]v4l2-alpha-componentah$]h&]uh1j=hj,hhhhhNj }jjsj }jjsubh)}(hXApplications can enumerate the available controls with the :ref:`VIDIOC_QUERYCTRL` and :ref:`VIDIOC_QUERYMENU ` ioctls, get and set a control value with the :ref:`VIDIOC_G_CTRL ` and :ref:`VIDIOC_S_CTRL ` ioctls. Drivers must implement ``VIDIOC_QUERYCTRL``, ``VIDIOC_G_CTRL`` and ``VIDIOC_S_CTRL`` when the device has one or more controls, ``VIDIOC_QUERYMENU`` when it has one or more menu type controls.h](h;Applications can enumerate the available controls with the }(hjhhhNhNubh)}(h:ref:`VIDIOC_QUERYCTRL`h]jH)}(hjh]hVIDIOC_QUERYCTRL}(hjhhhNhNubah}(h]h ](jSstdstd-refeh"]h$]h&]uh1jGhjubah}(h]h ]h"]h$]h&]refdocj+ refdomainjreftyperef refexplicitrefwarnjevidioc_queryctrluh1hhhhMHhjubh and }(hjhhhNhNubh)}(h*:ref:`VIDIOC_QUERYMENU `h]jH)}(hjh]hVIDIOC_QUERYMENU}(hjhhhNhNubah}(h]h ](jSstdstd-refeh"]h$]h&]uh1jGhjubah}(h]h ]h"]h$]h&]refdocj+ refdomainjreftyperef refexplicitrefwarnjevidioc_queryctrluh1hhhhMHhjubh. ioctls, get and set a control value with the }(hjhhhNhNubh)}(h$:ref:`VIDIOC_G_CTRL `h]jH)}(hjh]h VIDIOC_G_CTRL}(hjhhhNhNubah}(h]h ](jSstdstd-refeh"]h$]h&]uh1jGhj ubah}(h]h ]h"]h$]h&]refdocj+ refdomainjreftyperef refexplicitrefwarnje vidioc_g_ctrluh1hhhhMHhjubh and }hjsbh)}(h$:ref:`VIDIOC_S_CTRL `h]jH)}(hj3h]h VIDIOC_S_CTRL}(hj5hhhNhNubah}(h]h ](jSstdstd-refeh"]h$]h&]uh1jGhj1ubah}(h]h ]h"]h$]h&]refdocj+ refdomainj?reftyperef refexplicitrefwarnje vidioc_g_ctrluh1hhhhMHhjubh ioctls. Drivers must implement }(hjhhhNhNubj)}(h``VIDIOC_QUERYCTRL``h]hVIDIOC_QUERYCTRL}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh, }(hjhhhNhNubj)}(h``VIDIOC_G_CTRL``h]h VIDIOC_G_CTRL}(hjghhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh and }(hjhhhNhNubj)}(h``VIDIOC_S_CTRL``h]h VIDIOC_S_CTRL}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh+ when the device has one or more controls, }(hjhhhNhNubj)}(h``VIDIOC_QUERYMENU``h]hVIDIOC_QUERYMENU}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh, when it has one or more menu type controls.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMHhj,hhubh)}(h.. _enum_all_controls:h]h}(h]h ]h"]h$]h&]hԌenum-all-controlsuh1hhMRhj,hhhhubeh}(h]( control-idsj+eh ]h"]( control ids control-ideh$]h&]uh1hhhhhhhhK=j }jj!sj }j+j!subh)}(hhh](h)}(h!Example: Enumerating all controlsh]h!Example: Enumerating all controls}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMUubh literal_block)}(hXstruct v4l2_queryctrl queryctrl; struct v4l2_querymenu querymenu; static void enumerate_menu(__u32 id) { printf(" Menu items:\\n"); memset(&querymenu, 0, sizeof(querymenu)); querymenu.id = id; for (querymenu.index = queryctrl.minimum; querymenu.index <= queryctrl.maximum; querymenu.index++) { if (0 == ioctl(fd, VIDIOC_QUERYMENU, &querymenu)) { printf(" %s\\n", querymenu.name); } } } memset(&queryctrl, 0, sizeof(queryctrl)); queryctrl.id = V4L2_CTRL_FLAG_NEXT_CTRL; while (0 == ioctl(fd, VIDIOC_QUERYCTRL, &queryctrl)) { if (!(queryctrl.flags & V4L2_CTRL_FLAG_DISABLED)) { printf("Control %s\\n", queryctrl.name); if (queryctrl.type == V4L2_CTRL_TYPE_MENU) enumerate_menu(queryctrl.id); } queryctrl.id |= V4L2_CTRL_FLAG_NEXT_CTRL; } if (errno != EINVAL) { perror("VIDIOC_QUERYCTRL"); exit(EXIT_FAILURE); }h]hXstruct v4l2_queryctrl queryctrl; struct v4l2_querymenu querymenu; static void enumerate_menu(__u32 id) { printf(" Menu items:\\n"); memset(&querymenu, 0, sizeof(querymenu)); querymenu.id = id; for (querymenu.index = queryctrl.minimum; querymenu.index <= queryctrl.maximum; querymenu.index++) { if (0 == ioctl(fd, VIDIOC_QUERYMENU, &querymenu)) { printf(" %s\\n", querymenu.name); } } } memset(&queryctrl, 0, sizeof(queryctrl)); queryctrl.id = V4L2_CTRL_FLAG_NEXT_CTRL; while (0 == ioctl(fd, VIDIOC_QUERYCTRL, &queryctrl)) { if (!(queryctrl.flags & V4L2_CTRL_FLAG_DISABLED)) { printf("Control %s\\n", queryctrl.name); if (queryctrl.type == V4L2_CTRL_TYPE_MENU) enumerate_menu(queryctrl.id); } queryctrl.id |= V4L2_CTRL_FLAG_NEXT_CTRL; } if (errno != EINVAL) { perror("VIDIOC_QUERYCTRL"); exit(EXIT_FAILURE); }}hjsbah}(h]h ]h"]h$]h&]hhƌforcelanguagechighlight_args}uh1jhhhMWhjhhubeh}(h]( example-enumerating-all-controlsjeh ]h"](!example: enumerating all controlsenum_all_controlseh$]h&]uh1hhhhhhhhMUj }jjsj }jjsubh)}(hhh](h)}(h=Example: Enumerating all controls including compound controlsh]h=Example: Enumerating all controls including compound controls}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubj)}(hXzstruct v4l2_query_ext_ctrl query_ext_ctrl; memset(&query_ext_ctrl, 0, sizeof(query_ext_ctrl)); query_ext_ctrl.id = V4L2_CTRL_FLAG_NEXT_CTRL | V4L2_CTRL_FLAG_NEXT_COMPOUND; while (0 == ioctl(fd, VIDIOC_QUERY_EXT_CTRL, &query_ext_ctrl)) { if (!(query_ext_ctrl.flags & V4L2_CTRL_FLAG_DISABLED)) { printf("Control %s\\n", query_ext_ctrl.name); if (query_ext_ctrl.type == V4L2_CTRL_TYPE_MENU) enumerate_menu(query_ext_ctrl.id); } query_ext_ctrl.id |= V4L2_CTRL_FLAG_NEXT_CTRL | V4L2_CTRL_FLAG_NEXT_COMPOUND; } if (errno != EINVAL) { perror("VIDIOC_QUERY_EXT_CTRL"); exit(EXIT_FAILURE); }h]hXzstruct v4l2_query_ext_ctrl query_ext_ctrl; memset(&query_ext_ctrl, 0, sizeof(query_ext_ctrl)); query_ext_ctrl.id = V4L2_CTRL_FLAG_NEXT_CTRL | V4L2_CTRL_FLAG_NEXT_COMPOUND; while (0 == ioctl(fd, VIDIOC_QUERY_EXT_CTRL, &query_ext_ctrl)) { if (!(query_ext_ctrl.flags & V4L2_CTRL_FLAG_DISABLED)) { printf("Control %s\\n", query_ext_ctrl.name); if (query_ext_ctrl.type == V4L2_CTRL_TYPE_MENU) enumerate_menu(query_ext_ctrl.id); } query_ext_ctrl.id |= V4L2_CTRL_FLAG_NEXT_CTRL | V4L2_CTRL_FLAG_NEXT_COMPOUND; } if (errno != EINVAL) { perror("VIDIOC_QUERY_EXT_CTRL"); exit(EXIT_FAILURE); }}hjsbah}(h]h ]h"]h$]h&]hhjjjj}uh1jhhhMhjhhubeh}(h]jj+jjj jB j j j j jBj jjjjjjjj j7j4j9j6j1j)u nametypes}(jBjAjjj j j jBjjjjj7j9j1uh}(hhj>hj#jj+j,jj,jB jC j j j j j j jjjjjjj jj4jj6j:j)j\u footnote_refs}j]jas citation_refs} autofootnotes]j\aautofootnote_refs]jasymbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK id_counter collectionsCounter}jwKsRparse_messages]transform_messages](hsystem_message)}(hhh]h)}(hhh]h-Hyperlink target "control" is not referenced.}hjsbah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]levelKtypeINFOsourcehnjlineKuh1jubj)}(hhh]h)}(hhh]h0Hyperlink target "control-id" is not referenced.}hjsbah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]levelKtypejsourcehnjlineK:uh1jubj)}(hhh]h)}(hhh]h4Hyperlink target "v4l2-cid-hflip" is not referenced.}hjsbah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]levelKtypejsourcehnjlineKuh1jubj)}(hhh]h)}(hhh]h4Hyperlink target "v4l2-cid-vflip" is not referenced.}hj-sbah}(h]h ]h"]h$]h&]uh1hhj*ubah}(h]h ]h"]h$]h&]levelKtypejsourcehnjlineKuh1jubj)}(hhh]h)}(hhh]h?Hyperlink target "v4l2-power-line-frequency" is not referenced.}hjGsbah}(h]h ]h"]h$]h&]uh1hhjDubah}(h]h ]h"]h$]h&]levelKtypejsourcehnjlineKuh1jubj)}(hhh]h)}(hhh]h2Hyperlink target "v4l2-colorfx" is not referenced.}hjasbah}(h]h ]h"]h$]h&]uh1hhj^ubah}(h]h ]h"]h$]h&]levelKtypejsourcehnjlineKuh1jubj)}(hhh]h)}(hhh]h:Hyperlink target "v4l2-alpha-component" is not referenced.}hj{sbah}(h]h ]h"]h$]h&]uh1hhjxubah}(h]h ]h"]h$]h&]levelKtypejsourcehnjlineM0uh1jubj)}(hhh]h)}(hhh]h7Hyperlink target "enum-all-controls" is not referenced.}hjsbah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]levelKtypejsourcehnjlineMRuh1jube transformerN include_log] decorationNhhub.