]> git.parisson.com Git - timeside.git/commitdiff
Doc: Update documentation (fix path)
authorThomas Fillon <thomas@parisson.com>
Mon, 12 Jan 2015 14:25:35 +0000 (15:25 +0100)
committerThomas Fillon <thomas@parisson.com>
Mon, 12 Jan 2015 14:25:35 +0000 (15:25 +0100)
doc/source/api/decoder/index.rst
doc/source/tutorial/frames_stack.rst

index 8283527958179de95ca04ab131e73ff66b52ddb8..5813713b28ca8da7411b09e922dc14bb33cea018 100644 (file)
@@ -6,13 +6,13 @@ Decoder package
 .. toctree::
    :maxdepth: 2
 
-.. automodule:: timeside.decoder
+.. automodule:: timeside.plugins.decoder
    
 
 File Decoder
 ============
 
-.. autoclass:: timeside.decoder.file.FileDecoder
+.. autoclass:: timeside.plugins.decoder.file.FileDecoder
    :members:
    :undoc-members:
    :show-inheritance:
@@ -20,7 +20,7 @@ File Decoder
 Array Decoder
 =============
 
-.. autoclass:: timeside.decoder.array.ArrayDecoder
+.. autoclass:: timeside.plugins.decoder.array.ArrayDecoder
    :members:
    :undoc-members:
    :show-inheritance:
@@ -28,7 +28,7 @@ Array Decoder
 Live Decoder
 ============
 
-.. autoclass:: timeside.decoder.live.LiveDecoder
+.. autoclass:: timeside.plugins.decoder.live.LiveDecoder
    :members:
    :undoc-members:
    :show-inheritance:
index c8272ebbcd0be1f9156e5c0976d7b41dd3116c72..39075ae011d049b04b908ddd757917f268d1049f 100644 (file)
@@ -5,26 +5,26 @@
  Running a pipe with previously decoded frames
 ===============================================
 
-Example of use of the `stack` argument in :class:`timeside.decoder.file.FileDecoder` to run a pipe with previously decoded frames stacked in memory on a second pass.
+Example of use of the `stack` argument in :class:`timeside.plugins.decoder.file.FileDecoder` to run a pipe with previously decoded frames stacked in memory on a second pass.
 
 First, let's import everything and define the audio file source :
 
->>> import timeside
+>>> import timeside.core
 >>> from timeside.core import get_processor
 >>> from timeside.tools.test_samples import samples
 >>> import numpy as np
 >>> audio_file = samples['sweep.mp3']
 
-Then let's setup a :class:`FileDecoder <timeside.decoder.file.FileDecoder>` with argument `stack=True` (default argument is `stack=False`) :
+Then let's setup a :class:`FileDecoder <timeside.plugins.decoder.file.FileDecoder>` with argument `stack=True` (default argument is `stack=False`) :
 
->>> decoder = timeside.decoder.file.FileDecoder(audio_file, stack=True)
+>>> decoder = timeside.plugins.decoder.file.FileDecoder(audio_file, stack=True)
 
 Setup an arbitrary analyzer to check that decoding process from file and from stack are equivalent:
 
->>> pitch = get_processor('aubio_pitch')()
->>> pipe = (decoder | pitch)
+>>> level = get_processor('level')()
+>>> pipe = (decoder | level)
 >>> print pipe.processors #doctest: +ELLIPSIS
-[file_decoder-{}, aubio_pitch-{"blocksize_s": 0.0, "stepsize_s": 0.0}]
+[file_decoder-{}, level-{}]
 
 
 Run the pipe: