Documentation/media/uapi/dvb/audio-get-status.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _AUDIO_GET_STATUS:
   4
   5 ================
   6 AUDIO_GET_STATUS
   7 ================
   8
   9 Name
  10 ----
  11
  12 AUDIO_GET_STATUS
  13
  14 .. attention:: This ioctl is deprecated
  15
  16 Synopsis
  17 --------
  18
  19 .. c:function:: int ioctl(int fd, AUDIO_GET_STATUS, struct audio_status *status)
  20     :name: AUDIO_GET_STATUS
  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        -  struct audio_status \*status
  40
  41        -  Returns the current state of Audio Device.
  42
  43
  44 Description
  45 -----------
  46
  47 This ioctl call asks the Audio Device to return the current state of the
  48 Audio Device.
  49
  50
  51 Return Value
  52 ------------
  53
  54 On success 0 is returned, on error -1 and the ``errno`` variable is set
  55 appropriately. The generic error codes are described at the
  56 :ref:`Generic Error Codes <gen-errors>` chapter.