Documentation/media/uapi/dvb/audio-set-id.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_ID:
  11
  12 ============
  13 AUDIO_SET_ID
  14 ============
  15
  16 Name
  17 ----
  18
  19 AUDIO_SET_ID
  20
  21 .. attention:: This ioctl is deprecated
  22
  23 Synopsis
  24 --------
  25
  26 .. c:function:: int  ioctl(int fd, AUDIO_SET_ID, int id)
  27     :name: AUDIO_SET_ID
  28
  29 Arguments
  30 ---------
  31
  32 .. flat-table::
  33     :header-rows:  0
  34     :stub-columns: 0
  35
  36
  37     -
  38
  39        -  int fd
  40
  41        -  File descriptor returned by a previous call to open().
  42
  43     -
  44
  45        -  int id
  46
  47        -  audio sub-stream id
  48
  49
  50 Description
  51 -----------
  52
  53 This ioctl selects which sub-stream is to be decoded if a program or
  54 system stream is sent to the video device. If no audio stream type is
  55 set the id has to be in [0xC0,0xDF] for MPEG sound, in [0x80,0x87] for
  56 AC3 and in [0xA0,0xA7] for LPCM. More specifications may follow for
  57 other stream types. If the stream type is set the id just specifies the
  58 substream id of the audio stream and only the first 5 bits are
  59 recognized.
  60
  61
  62 Return Value
  63 ------------
  64
  65 On success 0 is returned, on error -1 and the ``errno`` variable is set
  66 appropriately. The generic error codes are described at the
  67 :ref:`Generic Error Codes <gen-errors>` chapter.