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

   1 .. Permission is granted to copy, distribute and/or modify this
   2 .. document under the terms of the GNU Free Documentation License,
   3 .. Version 1.1 or any later version published by the Free Software
   4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
   5 .. and no Back-Cover Texts. A copy of the license is included at
   6 .. Documentation/media/uapi/fdl-appendix.rst.
   7 ..
   8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
   9
  10 .. _AUDIO_SET_STREAMTYPE:
  11
  12 ====================
  13 AUDIO_SET_STREAMTYPE
  14 ====================
  15
  16 Name
  17 ----
  18
  19 AUDIO_SET_STREAMTYPE
  20
  21 .. attention:: This ioctl is deprecated
  22
  23 Synopsis
  24 --------
  25
  26 .. c:function:: int  ioctl(fd, AUDIO_SET_STREAMTYPE, int type)
  27     :name: AUDIO_SET_STREAMTYPE
  28
  29
  30 Arguments
  31 ---------
  32
  33 .. flat-table::
  34     :header-rows:  0
  35     :stub-columns: 0
  36
  37
  38     -
  39
  40        -  int fd
  41
  42        -  File descriptor returned by a previous call to open().
  43
  44     -
  45
  46        -  int type
  47
  48        -  stream type
  49
  50
  51 Description
  52 -----------
  53
  54 This ioctl tells the driver which kind of audio stream to expect. This
  55 is useful if the stream offers several audio sub-streams like LPCM and
  56 AC3.
  57
  58
  59 Return Value
  60 ------------
  61
  62 On success 0 is returned, on error -1 and the ``errno`` variable is set
  63 appropriately. The generic error codes are described at the
  64 :ref:`Generic Error Codes <gen-errors>` chapter.
  65
  66
  67
  68 .. flat-table::
  69     :header-rows:  0
  70     :stub-columns: 0
  71
  72
  73     -  .. row 1
  74
  75        -  ``EINVAL``
  76
  77        -  type is not a valid or supported stream type.