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

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _AUDIO_SET_STREAMTYPE:
   4
   5 ====================
   6 AUDIO_SET_STREAMTYPE
   7 ====================
   8
   9 Name
  10 ----
  11
  12 AUDIO_SET_STREAMTYPE
  13
  14 .. attention:: This ioctl is deprecated
  15
  16 Synopsis
  17 --------
  18
  19 .. c:function:: int  ioctl(fd, AUDIO_SET_STREAMTYPE, int type)
  20     :name: AUDIO_SET_STREAMTYPE
  21
  22
  23 Arguments
  24 ---------
  25
  26 .. flat-table::
  27     :header-rows:  0
  28     :stub-columns: 0
  29
  30
  31     -
  32
  33        -  int fd
  34
  35        -  File descriptor returned by a previous call to open().
  36
  37     -
  38
  39        -  int type
  40
  41        -  stream type
  42
  43
  44 Description
  45 -----------
  46
  47 This ioctl tells the driver which kind of audio stream to expect. This
  48 is useful if the stream offers several audio sub-streams like LPCM and
  49 AC3.
  50
  51
  52 Return Value
  53 ------------
  54
  55 On success 0 is returned, on error -1 and the ``errno`` variable is set
  56 appropriately. The generic error codes are described at the
  57 :ref:`Generic Error Codes <gen-errors>` chapter.
  58
  59
  60
  61 .. flat-table::
  62     :header-rows:  0
  63     :stub-columns: 0
  64
  65
  66     -  .. row 1
  67
  68        -  ``EINVAL``
  69
  70        -  type is not a valid or supported stream type.