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

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDEO_SET_ATTRIBUTES:
   4
   5 ====================
   6 VIDEO_SET_ATTRIBUTES
   7 ====================
   8
   9 Name
  10 ----
  11
  12 VIDEO_SET_ATTRIBUTES
  13
  14
  15 Synopsis
  16 --------
  17
  18 .. cpp:function:: int ioctl(fd, int request = VIDEO_SET_ATTRIBUTE ,video_attributes_t vattr)
  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_ATTRIBUTE for this command.
  40
  41     -  .. row 3
  42
  43        -  video_attributes_t vattr
  44
  45        -  video attributes according to section ??.
  46
  47
  48 Description
  49 -----------
  50
  51 This ioctl is intended for DVD playback and allows you to set certain
  52 information about the stream. Some hardware may not need this
  53 information, but the call also tells the hardware to prepare for DVD
  54 playback.
  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        -  input is not a valid attribute setting.