Documentation/media/uapi/v4l/vidioc-g-output.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDIOC_G_OUTPUT:
   4
   5 **************************************
   6 ioctl VIDIOC_G_OUTPUT, VIDIOC_S_OUTPUT
   7 **************************************
   8
   9 Name
  10 ====
  11
  12 VIDIOC_G_OUTPUT - VIDIOC_S_OUTPUT - Query or select the current video output
  13
  14
  15 Synopsis
  16 ========
  17
  18 .. c:function:: int ioctl( int fd, VIDIOC_G_OUTPUT, int *argp )
  19     :name: VIDIOC_G_OUTPUT
  20
  21 .. c:function:: int ioctl( int fd, VIDIOC_S_OUTPUT, int *argp )
  22     :name: VIDIOC_S_OUTPUT
  23
  24
  25 Arguments
  26 =========
  27
  28 ``fd``
  29     File descriptor returned by :ref:`open() <func-open>`.
  30
  31 ``argp``
  32
  33
  34 Description
  35 ===========
  36
  37 To query the current video output applications call the
  38 :ref:`VIDIOC_G_OUTPUT <VIDIOC_G_OUTPUT>` ioctl with a pointer to an integer where the driver
  39 stores the number of the output, as in the struct
  40 :c:type:`v4l2_output` ``index`` field. This ioctl will
  41 fail only when there are no video outputs, returning the ``EINVAL`` error
  42 code.
  43
  44 To select a video output applications store the number of the desired
  45 output in an integer and call the :ref:`VIDIOC_S_OUTPUT <VIDIOC_G_OUTPUT>` ioctl with a
  46 pointer to this integer. Side effects are possible. For example outputs
  47 may support different video standards, so the driver may implicitly
  48 switch the current standard. standard. Because of these possible side
  49 effects applications must select an output before querying or
  50 negotiating any other parameters.
  51
  52 Information about video outputs is available using the
  53 :ref:`VIDIOC_ENUMOUTPUT` ioctl.
  54
  55
  56 Return Value
  57 ============
  58
  59 On success 0 is returned, on error -1 and the ``errno`` variable is set
  60 appropriately. The generic error codes are described at the
  61 :ref:`Generic Error Codes <gen-errors>` chapter.
  62
  63 EINVAL
  64     The number of the video output is out of bounds, or there are no
  65     video outputs at all.