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

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _AUDIO_SET_ID:
   4
   5 ============
   6 AUDIO_SET_ID
   7 ============
   8
   9 Name
  10 ----
  11
  12 AUDIO_SET_ID
  13
  14 .. attention:: This ioctl is deprecated
  15
  16 Synopsis
  17 --------
  18
  19 .. c:function:: int  ioctl(int fd, AUDIO_SET_ID, int id)
  20     :name: AUDIO_SET_ID
  21
  22 Arguments
  23 ---------
  24
  25 .. flat-table::
  26     :header-rows:  0
  27     :stub-columns: 0
  28
  29
  30     -
  31
  32        -  int fd
  33
  34        -  File descriptor returned by a previous call to open().
  35
  36     -
  37
  38        -  int id
  39
  40        -  audio sub-stream id
  41
  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
  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.