forked from auracaster/pyalsaaudio
unify line spacing in .rst files
one empty line, except for high-level sections, which get two. while at it, trim whitespace on otherwise empty lines.
This commit is contained in:
Oswald Buddenhagen
@@ -14,14 +14,12 @@ Download
|
||||
|
||||
* `Download from pypi <https://pypi.python.org/pypi/pyalsaaudio>`_
|
||||
|
||||
|
||||
Github
|
||||
======
|
||||
|
||||
* `Repository <https://github.com/larsimmisch/pyalsaaudio/>`_
|
||||
* `Bug tracker <https://github.com/larsimmisch/pyalsaaudio/issues>`_
|
||||
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
|
||||
@@ -78,6 +78,7 @@ The :mod:`alsaaudio` module defines functions and classes for using ALSA.
|
||||
|
||||
Return a Python string containing the ALSA version found.
|
||||
|
||||
|
||||
.. _pcm-objects:
|
||||
|
||||
PCM Objects
|
||||
@@ -158,7 +159,6 @@ following arguments:
|
||||
The `card` keyword is deprecated because it guesses the real ALSA
|
||||
name of the card. This was always fragile and broke some legitimate usecases.
|
||||
|
||||
|
||||
PCM objects have the following methods:
|
||||
|
||||
.. method:: PCM.info()
|
||||
@@ -212,13 +212,11 @@ PCM objects have the following methods:
|
||||
Returns the type of PCM object. Either :const:`PCM_CAPTURE` or
|
||||
:const:`PCM_PLAYBACK`.
|
||||
|
||||
|
||||
.. method:: PCM.pcmmode()
|
||||
|
||||
Return the mode of the PCM object. One of :const:`PCM_NONBLOCK`,
|
||||
:const:`PCM_ASYNC`, or :const:`PCM_NORMAL`
|
||||
|
||||
|
||||
.. method:: PCM.cardname()
|
||||
|
||||
Return the name of the sound card used by this PCM object.
|
||||
@@ -271,13 +269,11 @@ PCM objects have the following methods:
|
||||
return value of zero, if the buffer is full. In this case, the data
|
||||
should be written at a later time.
|
||||
|
||||
|
||||
.. method:: PCM.pause([enable=True])
|
||||
|
||||
If *enable* is :const:`True`, playback or capture is paused.
|
||||
Otherwise, playback/capture is resumed.
|
||||
|
||||
|
||||
.. method:: PCM.polldescriptors()
|
||||
|
||||
Returns a tuple of *(file descriptor, eventmask)* that can be used to
|
||||
@@ -335,7 +331,6 @@ PCM objects have the following methods:
|
||||
update.
|
||||
================================= ===========================================
|
||||
|
||||
|
||||
**A few hints on using PCM devices for playback**
|
||||
|
||||
The most common reason for problems with playback of PCM audio is that writes
|
||||
@@ -371,7 +366,6 @@ Mixer Objects
|
||||
|
||||
Mixer objects provides access to the ALSA mixer API.
|
||||
|
||||
|
||||
.. class:: Mixer(control='Master', id=0, cardindex=-1, device='default')
|
||||
|
||||
Arguments are:
|
||||
@@ -403,18 +397,15 @@ Mixer objects have the following methods:
|
||||
|
||||
Return the name of the sound card used by this Mixer object
|
||||
|
||||
|
||||
.. method:: Mixer.mixer()
|
||||
|
||||
Return the name of the specific mixer controlled by this object, For example
|
||||
``'Master'`` or ``'PCM'``
|
||||
|
||||
|
||||
.. method:: Mixer.mixerid()
|
||||
|
||||
Return the ID of the ALSA mixer controlled by this object.
|
||||
|
||||
|
||||
.. method:: Mixer.switchcap()
|
||||
|
||||
Returns a list of the switches which are defined by this specific mixer.
|
||||
@@ -435,7 +426,6 @@ Mixer objects have the following methods:
|
||||
To manipulate these switches use the :meth:`setrec` or
|
||||
:meth:`setmute` methods
|
||||
|
||||
|
||||
.. method:: Mixer.volumecap()
|
||||
|
||||
Returns a list of the volume control capabilities of this
|
||||
@@ -478,7 +468,6 @@ Mixer objects have the following methods:
|
||||
This method will return an empty tuple if the mixer is not an enumerated
|
||||
control.
|
||||
|
||||
|
||||
.. method:: Mixer.getmute()
|
||||
|
||||
Return a list indicating the current mute setting for each
|
||||
@@ -486,7 +475,6 @@ Mixer objects have the following methods:
|
||||
|
||||
This method will fail if the mixer has no playback switch capabilities.
|
||||
|
||||
|
||||
.. method:: Mixer.getrange(pcmtype=PCM_PLAYBACK)
|
||||
|
||||
Return the volume range of the ALSA mixer controlled by this object.
|
||||
@@ -496,7 +484,6 @@ Mixer objects have the following methods:
|
||||
playback and capture volume. The default value is :const:`PCM_PLAYBACK`
|
||||
if the mixer has playback channels, otherwise it is :const:`PCM_CAPTURE`.
|
||||
|
||||
|
||||
.. method:: Mixer.getrec()
|
||||
|
||||
Return a list indicating the current record mute setting for each channel. 0
|
||||
@@ -504,7 +491,6 @@ Mixer objects have the following methods:
|
||||
|
||||
This method will fail if the mixer has no capture switch capabilities.
|
||||
|
||||
|
||||
.. method:: Mixer.getvolume(pcmtype=PCM_PLAYBACK)
|
||||
|
||||
Returns a list with the current volume settings for each channel. The list
|
||||
@@ -515,7 +501,6 @@ Mixer objects have the following methods:
|
||||
playback and capture volume. The default value is :const:`PCM_PLAYBACK`
|
||||
if the mixer has playback channels, otherwise it is :const:`PCM_CAPTURE`.
|
||||
|
||||
|
||||
.. method:: Mixer.setvolume(volume, channel=None, pcmtype=PCM_PLAYBACK)
|
||||
|
||||
Change the current volume settings for this mixer. The *volume* argument
|
||||
@@ -540,7 +525,6 @@ Mixer objects have the following methods:
|
||||
|
||||
This method will fail if the mixer has no playback mute capabilities
|
||||
|
||||
|
||||
.. method:: Mixer.setrec(capture, [channel])
|
||||
|
||||
Sets the capture mute flag to a new value. The *capture* argument
|
||||
@@ -628,6 +612,7 @@ To test PCM playback (on your default soundcard), run::
|
||||
|
||||
recordtest.py and playbacktest.py
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
**recordtest.py** and **playbacktest.py** will record and play a raw
|
||||
sound file in CD quality.
|
||||
|
||||
|
||||
@@ -92,6 +92,7 @@ And then as root: --- ::
|
||||
|
||||
# python setup.py install
|
||||
|
||||
|
||||
*******
|
||||
Testing
|
||||
*******
|
||||
|
||||
Reference in New Issue
Block a user