diff options
Diffstat (limited to 'Documentation/media/uapi/v4l/vidioc-g-output.rst')
| -rw-r--r-- | Documentation/media/uapi/v4l/vidioc-g-output.rst | 73 |
1 files changed, 0 insertions, 73 deletions
diff --git a/Documentation/media/uapi/v4l/vidioc-g-output.rst b/Documentation/media/uapi/v4l/vidioc-g-output.rst deleted file mode 100644 index 69542d78977b..000000000000 --- a/Documentation/media/uapi/v4l/vidioc-g-output.rst +++ /dev/null @@ -1,73 +0,0 @@ -.. Permission is granted to copy, distribute and/or modify this -.. document under the terms of the GNU Free Documentation License, -.. Version 1.1 or any later version published by the Free Software -.. Foundation, with no Invariant Sections, no Front-Cover Texts -.. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. -.. -.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections - -.. _VIDIOC_G_OUTPUT: - -************************************** -ioctl VIDIOC_G_OUTPUT, VIDIOC_S_OUTPUT -************************************** - -Name -==== - -VIDIOC_G_OUTPUT - VIDIOC_S_OUTPUT - Query or select the current video output - - -Synopsis -======== - -.. c:function:: int ioctl( int fd, VIDIOC_G_OUTPUT, int *argp ) - :name: VIDIOC_G_OUTPUT - -.. c:function:: int ioctl( int fd, VIDIOC_S_OUTPUT, int *argp ) - :name: VIDIOC_S_OUTPUT - - -Arguments -========= - -``fd`` - File descriptor returned by :ref:`open() <func-open>`. - -``argp`` - Pointer to an integer with output index. - - -Description -=========== - -To query the current video output applications call the -:ref:`VIDIOC_G_OUTPUT <VIDIOC_G_OUTPUT>` ioctl with a pointer to an integer where the driver -stores the number of the output, as in the struct -:c:type:`v4l2_output` ``index`` field. This ioctl will -fail only when there are no video outputs, returning the ``EINVAL`` error -code. - -To select a video output applications store the number of the desired -output in an integer and call the :ref:`VIDIOC_S_OUTPUT <VIDIOC_G_OUTPUT>` ioctl with a -pointer to this integer. Side effects are possible. For example outputs -may support different video standards, so the driver may implicitly -switch the current standard. standard. Because of these possible side -effects applications must select an output before querying or -negotiating any other parameters. - -Information about video outputs is available using the -:ref:`VIDIOC_ENUMOUTPUT` ioctl. - - -Return Value -============ - -On success 0 is returned, on error -1 and the ``errno`` variable is set -appropriately. The generic error codes are described at the -:ref:`Generic Error Codes <gen-errors>` chapter. - -EINVAL - The number of the video output is out of bounds, or there are no - video outputs at all. |