Mercurial > hg > vampy-host
diff README.rst @ 132:f798cda1007f
Another minor doc update
author | Chris Cannam |
---|---|
date | Wed, 24 Jun 2015 16:30:22 +0100 |
parents | b8fe675f9c3f |
children |
line wrap: on
line diff
--- a/README.rst Wed Jun 24 16:16:22 2015 +0100 +++ b/README.rst Wed Jun 24 16:30:22 2015 +0100 @@ -30,7 +30,6 @@ (https://code.soundsoftware.ac.uk/projects/nnls-chroma/) for analysis:: - $ python >>> import vamp >>> import librosa >>> data, rate = librosa.load("example.wav") @@ -63,7 +62,8 @@ This module contains three sorts of function: - 1. Basic info and lookup functions: +1. Basic info and lookup functions +"""""""""""""""""""""""""""""""""" * ``vamp.list_plugins`` * ``vamp.get_outputs_of`` @@ -73,7 +73,8 @@ about each plugin. (For more detailed information, load a plugin and inspect it using the low-level interface described below.) - 2. Process functions: +2. Process functions +"""""""""""""""""""" * ``vamp.process_audio`` * ``vamp.process_frames`` @@ -91,8 +92,9 @@ plugin's preferred step and block sizes. The ``_frames`` versions instead accept an enumerable sequence of audio frame arrays. - 3. The process-and-collect function: - +3. The process-and-collect function +""""""""""""""""""""""""""""""""""" + * ``vamp.collect`` This accepts a single array of audio samples as input, and returns