update notes for online processing

CPJKU · Feb 24, 2017 · 735d438 · 735d438
1 parent 10b4b83
commit 735d438
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -6,6 +6,7 @@ Version 0.15.dev0
 
 New features:
 
+* Streaming mode allows framewise processing of live audio input (#185)
 * Exponential linear unit (ELU) activation function (#232)
 
 Bug fixes:

diff --git a/madmom/processors.py b/madmom/processors.py
@@ -716,6 +716,12 @@ def process_online(processor, infile, outfile, **kwargs):
         Keyword arguments passed to :class:`.audio.signal.Stream` if
         `in_stream` is 'None'.
 
+    Notes
+    -----
+    Right now there is no way to determine if a processor is online-capable or
+    not. Thus, calling any processor with this function may not produce the
+    results expected.
+
     """
     from madmom.audio.signal import Stream, FramedSignal
     # set default values