Documentation/media/uapi/dvb/video-select-source.rst

   1 .. Permission is granted to copy, distribute and/or modify this
   2 .. document under the terms of the GNU Free Documentation License,
   3 .. Version 1.1 or any later version published by the Free Software
   4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
   5 .. and no Back-Cover Texts. A copy of the license is included at
   6 .. Documentation/media/uapi/fdl-appendix.rst.
   7 ..
   8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
   9
  10 .. _VIDEO_SELECT_SOURCE:
  11
  12 ===================
  13 VIDEO_SELECT_SOURCE
  14 ===================
  15
  16 Name
  17 ----
  18
  19 VIDEO_SELECT_SOURCE
  20
  21 .. attention:: This ioctl is deprecated.
  22
  23 Synopsis
  24 --------
  25
  26 .. c:function:: int ioctl(fd, VIDEO_SELECT_SOURCE, video_stream_source_t source)
  27     :name: VIDEO_SELECT_SOURCE
  28
  29
  30 Arguments
  31 ---------
  32
  33 .. flat-table::
  34     :header-rows:  0
  35     :stub-columns: 0
  36
  37
  38     -  .. row 1
  39
  40        -  int fd
  41
  42        -  File descriptor returned by a previous call to open().
  43
  44     -  .. row 2
  45
  46        -  int request
  47
  48        -  Equals VIDEO_SELECT_SOURCE for this command.
  49
  50     -  .. row 3
  51
  52        -  video_stream_source_t source
  53
  54        -  Indicates which source shall be used for the Video stream.
  55
  56
  57 Description
  58 -----------
  59
  60 This ioctl is for Digital TV devices only. This ioctl was also supported by the
  61 V4L2 ivtv driver, but that has been replaced by the ivtv-specific
  62 ``IVTV_IOC_PASSTHROUGH_MODE`` ioctl.
  63
  64 This ioctl call informs the video device which source shall be used for
  65 the input data. The possible sources are demux or memory. If memory is
  66 selected, the data is fed to the video device through the write command.
  67
  68 .. c:type:: video_stream_source_t
  69
  70 .. code-block:: c
  71
  72         typedef enum {
  73                 VIDEO_SOURCE_DEMUX, /* Select the demux as the main source */
  74                 VIDEO_SOURCE_MEMORY /* If this source is selected, the stream
  75                                 comes from the user through the write
  76                                 system call */
  77         } video_stream_source_t;
  78
  79 Return Value
  80 ------------
  81
  82 On success 0 is returned, on error -1 and the ``errno`` variable is set
  83 appropriately. The generic error codes are described at the
  84 :ref:`Generic Error Codes <gen-errors>` chapter.