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
  15 Synopsis
  16 --------
  17
  18 .. cpp:function:: int  ioctl(int fd, int request = AUDIO_CLEAR_BUFFER)
  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_CLEAR_BUFFER for this command.
  40
  41
  42 Description
  43 -----------
  44
  45 This ioctl call asks the Audio Device to clear all software and hardware
  46 buffers of the audio decoder device.
  47
  48
  49 Return Value
  50 ------------
  51
  52 On success 0 is returned, on error -1 and the ``errno`` variable is set
  53 appropriately. The generic error codes are described at the
  54 :ref:`Generic Error Codes <gen-errors>` chapter.