Documentation/media/uapi/dvb/video-set-id.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDEO_SET_ID:
   4
   5 ============
   6 VIDEO_SET_ID
   7 ============
   8
   9 Name
  10 ----
  11
  12 VIDEO_SET_ID
  13
  14 .. attention:: This ioctl is deprecated.
  15
  16 Synopsis
  17 --------
  18
  19 .. c:function:: int ioctl(int fd, VIDEO_SET_ID, int id)
  20     :name: VIDEO_SET_ID
  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_SET_ID for this command.
  42
  43     -  .. row 3
  44
  45        -  int id
  46
  47        -  video sub-stream id
  48
  49
  50 Description
  51 -----------
  52
  53 This ioctl selects which sub-stream is to be decoded if a program or
  54 system stream is sent to the video device.
  55
  56
  57 Return Value
  58 ------------
  59
  60 On success 0 is returned, on error -1 and the ``errno`` variable is set
  61 appropriately. The generic error codes are described at the
  62 :ref:`Generic Error Codes <gen-errors>` chapter.
  63
  64
  65
  66 .. flat-table::
  67     :header-rows:  0
  68     :stub-columns: 0
  69
  70
  71     -  .. row 1
  72
  73        -  ``EINVAL``
  74
  75        -  Invalid sub-stream id.