blob: c5b62cde18c8ee1bef75f3906decc07a14c54e10 [file] [log] [blame]
David Brazdil0f672f62019-12-10 10:32:29 +00001.. 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/media/uapi/fdl-appendix.rst.
7..
8.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00009
10.. _AUDIO_CLEAR_BUFFER:
11
12==================
13AUDIO_CLEAR_BUFFER
14==================
15
16Name
17----
18
19AUDIO_CLEAR_BUFFER
20
21.. attention:: This ioctl is deprecated
22
23Synopsis
24--------
25
26.. c:function:: int ioctl(int fd, AUDIO_CLEAR_BUFFER)
27 :name: AUDIO_CLEAR_BUFFER
28
29Arguments
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
43Description
44-----------
45
46This ioctl call asks the Audio Device to clear all software and hardware
47buffers of the audio decoder device.
48
49
50Return Value
51------------
52
53On success 0 is returned, on error -1 and the ``errno`` variable is set
54appropriately. The generic error codes are described at the
55:ref:`Generic Error Codes <gen-errors>` chapter.