Documentation/userspace-api/media/dvb/audio-stop.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/userspace-api/media/fdl-appendix.rst.
   7 ..
   8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
   9
  10 .. _AUDIO_STOP:
  11
  12 ==========
  13 AUDIO_STOP
  14 ==========
  15
  16 Name
  17 ----
  18
  19 AUDIO_STOP
  20
  21 .. attention:: This ioctl is deprecated
  22
  23 Synopsis
  24 --------
  25
  26 .. c:function:: int ioctl(int fd, AUDIO_STOP)
  27     :name: AUDIO_STOP
  28
  29 Arguments
  30 ---------
  31
  32 .. flat-table::
  33     :header-rows:  0
  34     :stub-columns: 0
  35
  36
  37     -  .. row 1
  38
  39        -  int fd
  40
  41        -  File descriptor returned by a previous call to open().
  42
  43
  44 Description
  45 -----------
  46
  47 This ioctl call asks the Audio Device to stop playing the current
  48 stream.
  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.