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
  15 Synopsis
  16 --------
  17
  18 .. cpp:function:: int ioctl(int fd, int request = AUDIO_GET_STATUS, struct audio_status *status)
  19
  20
  21 Arguments
  22 ---------
  23
  24 .. flat-table::
  25     :header-rows:  0
  26     :stub-columns: 0
  27
  28
  29     -  .. row 1
  30
  31        -  int fd
  32
  33        -  File descriptor returned by a previous call to open().
  34
  35     -  .. row 2
  36
  37        -  int request
  38
  39        -  Equals AUDIO_GET_STATUS for this command.
  40
  41     -  .. row 3
  42
  43        -  struct audio_status \*status
  44
  45        -  Returns the current state of Audio Device.
  46
  47
  48 Description
  49 -----------
  50
  51 This ioctl call asks the Audio Device to return the current state of the
  52 Audio Device.
  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.