Mercurial > hg > auditok
changeset 343:6321013e540d
Update README.rst
| author | Amine SEHILI <amsehili@users.noreply.github.com> |
|---|---|
| date | Sun, 10 Nov 2019 03:50:37 +0100 |
| parents | 5187d584fe5b |
| children | deb4bbed0ecd |
| files | README.rst |
| diffstat | 1 files changed, 15 insertions(+), 4 deletions(-) [+] |
line wrap: on
line diff
--- a/README.rst Sun Nov 10 03:31:30 2019 +0100 +++ b/README.rst Sun Nov 10 03:50:37 2019 +0100 @@ -1,3 +1,10 @@ + +.. image:: doc/figures/auditok-logo-50.png + :align: center + +``auditok`` is an **Audio Activity Detection** tool that can process online data (read from an audio device or from standard input) as well as audio files. It can be used as a command line program and offers an easy to use API. + + .. image:: https://travis-ci.org/amsehili/auditok.svg?branch=master :target: https://travis-ci.org/amsehili/auditok @@ -5,9 +12,14 @@ :target: http://auditok.readthedocs.org/en/latest/?badge=latest :alt: Documentation Status +Basic example +------------- + .. code:: python from auditok import split + + # split returns a generator of AudioRegion objects audio_regions = split("audio.wav") for region in audio_regions: region.play(progress_bar=True) @@ -15,15 +27,14 @@ print("region saved as: {}".format(filename)) - -``auditok`` is an **Audio Activity Detection** tool that can process online data (read from an audio device or from standard input) as well as audio files. It can be used as a command line program and offers an easy to use API. - +Example using `AudioRegion` +-------------------------- .. code:: python from auditok import AudioRegion region = AudioRegion.load("audio.wav") - regions = region.split_and_plot() + regions = region.split_and_plot() # or just region.splitp() ouptut figure: