Documentation/media/uapi/dvb/audio-clear-buffer.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _AUDIO_CLEAR_BUFFER:
   4
   5 ==================
   6 AUDIO_CLEAR_BUFFER
   7 ==================
   8
   9 Name
  10 ----
  11
  12 AUDIO_CLEAR_BUFFER
  13
  14 .. attention:: This ioctl is deprecated
  15
  16 Synopsis
  17 --------
  18
  19 .. c:function:: int  ioctl(int fd, AUDIO_CLEAR_BUFFER)
  20     :name: AUDIO_CLEAR_BUFFER
  21
  22 Arguments
  23 ---------
  24
  25 .. flat-table::
  26     :header-rows:  0
  27     :stub-columns: 0
  28
  29
  30     -  .. row 1
  31
  32        -  int fd
  33
  34        -  File descriptor returned by a previous call to open().
  35
  36 Description
  37 -----------
  38
  39 This ioctl call asks the Audio Device to clear all software and hardware
  40 buffers of the audio decoder device.
  41
  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.