Document that only PCM WAV is supported.

rhmiller47 · Sep 8, 2015 · 7f72c17 · 7f72c17
1 parent 15c5e81
commit 7f72c17
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -225,6 +225,8 @@ Creates a new ``WavFile`` instance given a WAV audio file `filename_or_fileobjec
 
 If ``filename_or_fileobject`` is a string, then it is interpreted as a path to a WAV audio file (mono or stereo) on the filesystem. Otherwise, ``filename_or_fileobject`` should be a file-like object such as ``io.BytesIO`` or similar.
 
+Note that the WAV file must be in PCM/LPCM format; WAVE_FORMAT_EXTENSIBLE and compressed WAV are not supported and may result in undefined behaviour.
+
 Instances of this class are context managers, and are designed to be used with ``with`` statements:
 
 .. code:: python

diff --git a/speech_recognition/__init__.py b/speech_recognition/__init__.py
@@ -90,6 +90,8 @@ class WavFile(AudioSource):
     Creates a new ``WavFile`` instance given a WAV audio file `filename_or_fileobject`. Subclass of ``AudioSource``.
 
     If ``filename_or_fileobject`` is a string, then it is interpreted as a path to a WAV audio file (mono or stereo) on the filesystem. Otherwise, ``filename_or_fileobject`` should be a file-like object such as ``io.BytesIO`` or similar.
+
+    Note that the WAV file must be in PCM/LPCM format; WAVE_FORMAT_EXTENSIBLE and compressed WAV are not supported and may result in undefined behaviour.
     """
 
     def __init__(self, filename_or_fileobject):