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
  15 Synopsis
  16 --------
  17
  18 .. cpp:function:: int ioctl(fd, int request = VIDEO_SELECT_SOURCE, video_stream_source_t source)
  19
  20
  21 Arguments
  22 ---------
  23
  24 .. flat-table::
  25     :header-rows:  0
  26     :stub-columns: 0
  27
  28
  29     -  .. row 1
  30
  31        -  int fd
  32
  33        -  File descriptor returned by a previous call to open().
  34
  35     -  .. row 2
  36
  37        -  int request
  38
  39        -  Equals VIDEO_SELECT_SOURCE for this command.
  40
  41     -  .. row 3
  42
  43        -  video_stream_source_t source
  44
  45        -  Indicates which source shall be used for the Video stream.
  46
  47
  48 Description
  49 -----------
  50
  51 This ioctl is for DVB devices only. This ioctl was also supported by the
  52 V4L2 ivtv driver, but that has been replaced by the ivtv-specific
  53 ``IVTV_IOC_PASSTHROUGH_MODE`` ioctl.
  54
  55 This ioctl call informs the video device which source shall be used for
  56 the input data. The possible sources are demux or memory. If memory is
  57 selected, the data is fed to the video device through the write command.
  58
  59
  60 Return Value
  61 ------------
  62
  63 On success 0 is returned, on error -1 and the ``errno`` variable is set
  64 appropriately. The generic error codes are described at the
  65 :ref:`Generic Error Codes <gen-errors>` chapter.