auracaster/sw_pyalsaaudio
3
0
Fork 0
forked from auracaster/pyalsaaudio
Code Pull Requests Activity

document new avail() and polldescriptors_revents() PCM functions

Browse Source 
amends 43a94b3 and 5221311.
This commit is contained in:
Oswald Buddenhagen
2024-02-02 18:33:57 +01:00
parent f179db2d9b
commit db87f2ced5
1 changed files with 23 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
doc/libalsaaudio.rst
View File

@@ -327,6 +327,20 @@ PCM objects have the following methods:
*New in 0.10* *New in 0.10*
.. method:: PCM.avail()
For :const:`PCM_PLAYBACK` PCM objects, returns the number of writable
(that is, free) frames in the buffer.
For :const:`PCM_CAPTURE` PCM objects, returns the number of readable
(that is, filled) frames in the buffer.
An attempt to read/write more frames than indicated will block (in
:const:`PCM_NORMAL` mode) or fail and return zero (in
:const:`PCM_NONBLOCK` mode).
*New in 0.11*
.. method:: PCM.read() .. method:: PCM.read()
In :const:`PCM_NORMAL` mode, this function blocks until a full period is In :const:`PCM_NORMAL` mode, this function blocks until a full period is
@@ -411,6 +425,15 @@ PCM objects have the following methods:
The *eventmask* value is compatible with `poll.register`__ in the Python The *eventmask* value is compatible with `poll.register`__ in the Python
:const:`select` module. :const:`select` module.
.. method:: PCM.polldescriptors_revents(descriptors)
Processes the descriptor list returned by :func:`polldescriptors` after
using it with *select.poll*, and returns a single *eventmask* value that
is meaningful for deciding whether :func:`read` or :func:`write` should
be called.
*New in 0.11*
.. method:: PCM.set_tstamp_mode([mode=PCM_TSTAMP_ENABLE]) .. method:: PCM.set_tstamp_mode([mode=PCM_TSTAMP_ENABLE])
Set the ALSA timestamp mode on the device. The mode argument can be set to Set the ALSA timestamp mode on the device. The mode argument can be set to