Documentation/media/uapi/dvb/audio-get-status.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_GET_STATUS:
  11
  12 ================
  13 AUDIO_GET_STATUS
  14 ================
  15
  16 Name
  17 ----
  18
  19 AUDIO_GET_STATUS
  20
  21 .. attention:: This ioctl is deprecated
  22
  23 Synopsis
  24 --------
  25
  26 .. c:function:: int ioctl(int fd, AUDIO_GET_STATUS, struct audio_status *status)
  27     :name: AUDIO_GET_STATUS
  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        -  struct audio_status \*status
  47
  48        -  Returns the current state of Audio Device.
  49
  50
  51 Description
  52 -----------
  53
  54 This ioctl call asks the Audio Device to return the current state of the
  55 Audio Device.
  56
  57
  58 Return Value
  59 ------------
  60
  61 On success 0 is returned, on error -1 and the ``errno`` variable is set
  62 appropriately. The generic error codes are described at the
  63 :ref:`Generic Error Codes <gen-errors>` chapter.