Documentation/userspace-api/media/dvb/audio-stop.rst

   1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
   2 .. c:namespace:: DTV.audio
   3
   4 .. _AUDIO_STOP:
   5
   6 ==========
   7 AUDIO_STOP
   8 ==========
   9
  10 Name
  11 ----
  12
  13 AUDIO_STOP
  14
  15 .. attention:: This ioctl is deprecated
  16
  17 Synopsis
  18 --------
  19
  20 .. c:macro:: AUDIO_STOP
  21
  22 ``int ioctl(int fd, AUDIO_STOP)``
  23
  24 Arguments
  25 ---------
  26
  27 .. flat-table::
  28     :header-rows:  0
  29     :stub-columns: 0
  30
  31     -  .. row 1
  32
  33        -  int fd
  34
  35        -  File descriptor returned by a previous call to open().
  36
  37 Description
  38 -----------
  39
  40 This ioctl call asks the Audio Device to stop playing the current
  41 stream.
  42
  43 Return Value
  44 ------------
  45
  46 On success 0 is returned, on error -1 and the ``errno`` variable is set
  47 appropriately. The generic error codes are described at the
  48 :ref:`Generic Error Codes <gen-errors>` chapter.