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

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