Documentation/userspace-api/media/dvb/audio-set-id.rst

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