Updated docs

open-cogsci · May 28, 2016 · 26de274 · 26de274
1 parent 0898941
commit 26de274
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 10 deletions.
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -33,7 +33,8 @@ Sound renderers
 ~~~~~~~~~~~~~~~
 
 This module contains objects that handle the audio frames supplied by Decoder.
-At the moment, the only one that is stable is the PyAudioSoundRenderer.
+At the moment, the only ones that are stable are the PyAudioSoundRenderer and
+SounddeviceSoundrenderer (which both are bindings to PortAudio.
 
 Pygame
 ^^^^^^
@@ -48,3 +49,10 @@ Pyaudio
 .. automodule:: mediadecoder.soundrenderers.pyaudiorenderer
 	:members:
 	:special-members: __init__
+
+Sounddevice
+^^^^^^^^^^^
+
+.. automodule:: mediadecoder.soundrenderers.sounddevicerenderer
+	:members:
+	:special-members: __init__
diff --git a/mediadecoder/soundrenderers/sounddevicerenderer.py b/mediadecoder/soundrenderers/sounddevicerenderer.py
@@ -13,7 +13,7 @@
 queue_timeout=0.01
 
 class SoundrendererSounddevice(SoundRenderer):
-	""" Uses pyaudio to play sound """
+	""" Uses python-sounddevice to play sound """
 	def __init__(self, audioformat, queue=None):
 		"""Constructor.
 		Creates a pyaudio sound renderer.

diff --git a/mediadecoder/soundrenderers/sounddevicerenderer2.py b/mediadecoder/soundrenderers/sounddevicerenderer2.py
@@ -1,10 +1,3 @@
-
-""" This is an alternative implementation of sounddevicerenderer, that doesn't use
-the callback functionality of sounddevice's OutputStream. The threading is done by
-python, instead of C (under the hood) by sounddevice. I haven't determined yet
-which method is better, so I am leaving them both in for now. """
-
-
 import threading
 import sounddevice as sd
 import logging
@@ -22,7 +15,13 @@
 queue_timeout=0.01
 
 class SoundrendererSounddevice(threading.Thread, SoundRenderer):
-	""" Uses pyaudio to play sound """
+	""" Uses python-sounddevice to play sound. 
+
+	This is an alternative implementation of sounddevicerenderer, that doesn't use
+	the callback functionality of sounddevice's OutputStream. The threading is done by
+	python, instead of C (under the hood) by sounddevice. I haven't determined yet
+	which method is better, so I am leaving them both in for now. """
+
 	def __init__(self, audioformat, queue=None):
 		"""Constructor.
 		Creates a pyaudio sound renderer.