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

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDEO_SELECT_SOURCE:
   4
   5 ===================
   6 VIDEO_SELECT_SOURCE
   7 ===================
   8
   9 Name
  10 ----
  11
  12 VIDEO_SELECT_SOURCE
  13
  14 .. attention:: This ioctl is deprecated.
  15
  16 Synopsis
  17 --------
  18
  19 .. c:function:: int ioctl(fd, VIDEO_SELECT_SOURCE, video_stream_source_t source)
  20     :name: VIDEO_SELECT_SOURCE
  21
  22
  23 Arguments
  24 ---------
  25
  26 .. flat-table::
  27     :header-rows:  0
  28     :stub-columns: 0
  29
  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
  50 Description
  51 -----------
  52
  53 This ioctl is for Digital TV devices only. This ioctl was also supported by the
  54 V4L2 ivtv driver, but that has been replaced by the ivtv-specific
  55 ``IVTV_IOC_PASSTHROUGH_MODE`` ioctl.
  56
  57 This ioctl call informs the video device which source shall be used for
  58 the input data. The possible sources are demux or memory. If memory is
  59 selected, the data is fed to the video device through the write command.
  60
  61 .. c:type:: video_stream_source_t
  62
  63 .. code-block:: c
  64
  65         typedef enum {
  66                 VIDEO_SOURCE_DEMUX, /* Select the demux as the main source */
  67                 VIDEO_SOURCE_MEMORY /* If this source is selected, the stream
  68                                 comes from the user through the write
  69                                 system call */
  70         } video_stream_source_t;
  71
  72 Return Value
  73 ------------
  74
  75 On success 0 is returned, on error -1 and the ``errno`` variable is set
  76 appropriately. The generic error codes are described at the
  77 :ref:`Generic Error Codes <gen-errors>` chapter.