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

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDEO_SET_SPU:
   4
   5 =============
   6 VIDEO_SET_SPU
   7 =============
   8
   9 Name
  10 ----
  11
  12 VIDEO_SET_SPU
  13
  14 .. attention:: This ioctl is deprecated.
  15
  16 Synopsis
  17 --------
  18
  19 .. c:function:: int ioctl(fd, VIDEO_SET_SPU , struct video_spu *spu)
  20     :name: VIDEO_SET_SPU
  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_SPU for this command.
  42
  43     -  .. row 3
  44
  45        -  video_spu_t \*spu
  46
  47        -  SPU decoding (de)activation and subid setting according to section
  48           ??.
  49
  50
  51 Description
  52 -----------
  53
  54 This ioctl activates or deactivates SPU decoding in a DVD input stream.
  55 It can only be used, if the driver is able to handle a DVD stream.
  56
  57 .. c:type:: struct video_spu
  58
  59 .. code-block:: c
  60
  61         typedef struct video_spu {
  62                 int active;
  63                 int stream_id;
  64         } video_spu_t;
  65
  66
  67 Return Value
  68 ------------
  69
  70 On success 0 is returned, on error -1 and the ``errno`` variable is set
  71 appropriately. The generic error codes are described at the
  72 :ref:`Generic Error Codes <gen-errors>` chapter.
  73
  74
  75
  76 .. flat-table::
  77     :header-rows:  0
  78     :stub-columns: 0
  79
  80
  81     -  .. row 1
  82
  83        -  ``EINVAL``
  84
  85        -  input is not a valid spu setting or driver cannot handle SPU.