Skip to content

Commit 26de274

Browse files
committed
Updated docs
1 parent 0898941 commit 26de274

File tree

3 files changed

+17
-10
lines changed

3 files changed

+17
-10
lines changed

docs/source/api.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ Sound renderers
3333
~~~~~~~~~~~~~~~
3434

3535
This module contains objects that handle the audio frames supplied by Decoder.
36-
At the moment, the only one that is stable is the PyAudioSoundRenderer.
36+
At the moment, the only ones that are stable are the PyAudioSoundRenderer and
37+
SounddeviceSoundrenderer (which both are bindings to PortAudio.
3738

3839
Pygame
3940
^^^^^^
@@ -48,3 +49,10 @@ Pyaudio
4849
.. automodule:: mediadecoder.soundrenderers.pyaudiorenderer
4950
:members:
5051
:special-members: __init__
52+
53+
Sounddevice
54+
^^^^^^^^^^^
55+
56+
.. automodule:: mediadecoder.soundrenderers.sounddevicerenderer
57+
:members:
58+
:special-members: __init__

mediadecoder/soundrenderers/sounddevicerenderer.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
queue_timeout=0.01
1414

1515
class SoundrendererSounddevice(SoundRenderer):
16-
""" Uses pyaudio to play sound """
16+
""" Uses python-sounddevice to play sound """
1717
def __init__(self, audioformat, queue=None):
1818
"""Constructor.
1919
Creates a pyaudio sound renderer.

mediadecoder/soundrenderers/sounddevicerenderer2.py

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
2-
""" This is an alternative implementation of sounddevicerenderer, that doesn't use
3-
the callback functionality of sounddevice's OutputStream. The threading is done by
4-
python, instead of C (under the hood) by sounddevice. I haven't determined yet
5-
which method is better, so I am leaving them both in for now. """
6-
7-
81
import threading
92
import sounddevice as sd
103
import logging
@@ -22,7 +15,13 @@
2215
queue_timeout=0.01
2316

2417
class SoundrendererSounddevice(threading.Thread, SoundRenderer):
25-
""" Uses pyaudio to play sound """
18+
""" Uses python-sounddevice to play sound.
19+
20+
This is an alternative implementation of sounddevicerenderer, that doesn't use
21+
the callback functionality of sounddevice's OutputStream. The threading is done by
22+
python, instead of C (under the hood) by sounddevice. I haven't determined yet
23+
which method is better, so I am leaving them both in for now. """
24+
2625
def __init__(self, audioformat, queue=None):
2726
"""Constructor.
2827
Creates a pyaudio sound renderer.

0 commit comments

Comments
 (0)