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

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDEO_CLEAR_BUFFER:
   4
   5 ==================
   6 VIDEO_CLEAR_BUFFER
   7 ==================
   8
   9 Name
  10 ----
  11
  12 VIDEO_CLEAR_BUFFER
  13
  14 .. attention:: This ioctl is deprecated.
  15
  16 Synopsis
  17 --------
  18
  19 .. c:function:: int ioctl(fd, VIDEO_CLEAR_BUFFER)
  20     :name: VIDEO_CLEAR_BUFFER
  21
  22
  23 Arguments
  24 ---------
  25
  26 .. flat-table::
  27     :header-rows:  0
  28     :stub-columns: 0
  29
  30
  31     -  .. row 1
  32
  33        -  int fd
  34
  35        -  File descriptor returned by a previous call to open().
  36
  37     -  .. row 2
  38
  39        -  int request
  40
  41        -  Equals VIDEO_CLEAR_BUFFER for this command.
  42
  43
  44 Description
  45 -----------
  46
  47 This ioctl call clears all video buffers in the driver and in the
  48 decoder hardware.
  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.