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

de-duplicate PCM.info() documentation

Browse Source 
... and move the dumpinfo() docu.

amends 4e098da - clearly, i'm blind.
This commit is contained in:
Oswald Buddenhagen
2024-02-02 18:32:19 +01:00
parent 420b538321
commit f179db2d9b
1 changed files with 6 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
doc/libalsaaudio.rst
View File

@@ -248,6 +248,12 @@ PCM objects have the following methods:
as can be found in the as can be found in the
`ALSA documentation <https://www.alsa-project.org/alsa-doc>`_. `ALSA documentation <https://www.alsa-project.org/alsa-doc>`_.
*New in 0.9.1*
.. method:: PCM.dumpinfo()
Dumps the PCM object's configured parameters to stdout.
.. method:: PCM.pcmtype() .. method:: PCM.pcmtype()
Returns the type of PCM object. Either :const:`PCM_CAPTURE` or Returns the type of PCM object. Either :const:`PCM_CAPTURE` or
@@ -306,20 +312,6 @@ PCM objects have the following methods:
.. deprecated:: 0.9 Use the `periodsize` named argument to :func:`PCM`. .. deprecated:: 0.9 Use the `periodsize` named argument to :func:`PCM`.
.. method:: PCM.info()
Returns a dictionary with the PCM object's configured parameters.
Values are retrieved from the ALSA library if they are available;
otherwise they represent those stored by pyalsaaudio, and their keys
are prefixed with ' (call value) '.
*New in 0.9.1*
.. method:: PCM.dumpinfo()
Dumps the PCM object's configured parameters to stdout.
.. method:: PCM.state() .. method:: PCM.state()
Returs the current state of the stream, which can be one of Returs the current state of the stream, which can be one of