Documentation/userspace-api/media/dvb/video-select-source.rst

   1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
   2 .. c:namespace:: DTV.video
   3
   4 .. _VIDEO_SELECT_SOURCE:
   5
   6 ===================
   7 VIDEO_SELECT_SOURCE
   8 ===================
   9
  10 Name
  11 ----
  12
  13 VIDEO_SELECT_SOURCE
  14
  15 .. attention:: This ioctl is deprecated.
  16
  17 Synopsis
  18 --------
  19
  20 .. c:macro:: VIDEO_SELECT_SOURCE
  21
  22 ``int ioctl(fd, VIDEO_SELECT_SOURCE, video_stream_source_t source)``
  23
  24 Arguments
  25 ---------
  26
  27 .. flat-table::
  28     :header-rows:  0
  29     :stub-columns: 0
  30
  31     -  .. row 1
  32
  33        -  int fd
  34
  35        -  File descriptor returned by a previous call to open().
  36
  37     -  .. row 2
  38
  39        -  int request
  40
  41        -  Equals VIDEO_SELECT_SOURCE for this command.
  42
  43     -  .. row 3
  44
  45        -  video_stream_source_t source
  46
  47        -  Indicates which source shall be used for the Video stream.
  48
  49 Description
  50 -----------
  51
  52 This ioctl is for Digital TV devices only. This ioctl was also supported by the
  53 V4L2 ivtv driver, but that has been replaced by the ivtv-specific
  54 ``IVTV_IOC_PASSTHROUGH_MODE`` ioctl.
  55
  56 This ioctl call informs the video device which source shall be used for
  57 the input data. The possible sources are demux or memory. If memory is
  58 selected, the data is fed to the video device through the write command.
  59
  60 .. c:type:: video_stream_source_t
  61
  62 .. code-block:: c
  63
  64         typedef enum {
  65                 VIDEO_SOURCE_DEMUX, /* Select the demux as the main source */
  66                 VIDEO_SOURCE_MEMORY /* If this source is selected, the stream
  67                                 comes from the user through the write
  68                                 system call */
  69         } video_stream_source_t;
  70
  71 Return Value
  72 ------------
  73
  74 On success 0 is returned, on error -1 and the ``errno`` variable is set
  75 appropriately. The generic error codes are described at the
  76 :ref:`Generic Error Codes <gen-errors>` chapter.