amsehili@343: 
amine@344: .. image:: doc/figures/auditok-logo.png
amsehili@343:     :align: center
amsehili@343: 
amsehili@343: ``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.
amsehili@343: 
amsehili@343: 
amine@336: .. image:: https://travis-ci.org/amsehili/auditok.svg?branch=master
amine@336:     :target: https://travis-ci.org/amsehili/auditok
amine@336: 
amine@336: .. image:: https://readthedocs.org/projects/auditok/badge/?version=latest
amine@336:     :target: http://auditok.readthedocs.org/en/latest/?badge=latest
amine@336:     :alt: Documentation Status
amine@336: 
amsehili@343: Basic example
amsehili@343: -------------
amsehili@343: 
amine@336: .. code:: python
amine@336: 
amine@336:     from auditok import split
amsehili@343: 
amsehili@343:     # split returns a generator of AudioRegion objects
amine@336:     audio_regions = split("audio.wav")
amine@336:     for region in audio_regions:
amine@336:         region.play(progress_bar=True)
amine@336:         filename = region.save("/tmp/region_{meta.start:.3f}.wav")
amine@336:         print("region saved as: {}".format(filename))
amine@336: 
amine@336: 
amsehili@343: Example using `AudioRegion`
amsehili@343: --------------------------
amine@336: 
amine@336: .. code:: python
amine@336: 
amine@336:     from auditok import AudioRegion
amine@336:     region = AudioRegion.load("audio.wav")
amsehili@343:     regions = region.split_and_plot() # or just region.splitp()
amine@336: 
amine@336: 
amine@336: ouptut figure:
amine@336: 
amine@336: .. image:: doc/figures/example_1.png