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

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _AUDIO_SET_ATTRIBUTES:
   4
   5 ====================
   6 AUDIO_SET_ATTRIBUTES
   7 ====================
   8
   9 Name
  10 ----
  11
  12 AUDIO_SET_ATTRIBUTES
  13
  14
  15 Synopsis
  16 --------
  17
  18 .. cpp:function:: int ioctl(fd, int request = AUDIO_SET_ATTRIBUTES, audio_attributes_t attr )
  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 AUDIO_SET_ATTRIBUTES for this command.
  40
  41     -  .. row 3
  42
  43        -  audio_attributes_t attr
  44
  45        -  audio 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 audio stream.
  53
  54
  55 Return Value
  56 ------------
  57
  58 On success 0 is returned, on error -1 and the ``errno`` variable is set
  59 appropriately. The generic error codes are described at the
  60 :ref:`Generic Error Codes <gen-errors>` chapter.
  61
  62 .. flat-table::
  63     :header-rows:  0
  64     :stub-columns: 0
  65
  66
  67     -  .. row 1
  68
  69        -  ``EINVAL``
  70
  71        -  attr is not a valid or supported attribute setting.