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
  15 Synopsis
  16 --------
  17
  18 .. cpp:function:: int ioctl(fd, int request = VIDEO_SET_SPU , video_spu_t *spu)
  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_SET_SPU for this command.
  40
  41     -  .. row 3
  42
  43        -  video_spu_t \*spu
  44
  45        -  SPU decoding (de)activation and subid setting according to section
  46           ??.
  47
  48
  49 Description
  50 -----------
  51
  52 This ioctl activates or deactivates SPU decoding in a DVD input stream.
  53 It can only be used, if the driver is able to handle a DVD stream.
  54
  55
  56 Return Value
  57 ------------
  58
  59 On success 0 is returned, on error -1 and the ``errno`` variable is set
  60 appropriately. The generic error codes are described at the
  61 :ref:`Generic Error Codes <gen-errors>` chapter.
  62
  63
  64
  65 .. flat-table::
  66     :header-rows:  0
  67     :stub-columns: 0
  68
  69
  70     -  .. row 1
  71
  72        -  ``EINVAL``
  73
  74        -  input is not a valid spu setting or driver cannot handle SPU.