diff doc/command_line_usage.rst @ 439:ca8090edca2f

Merge branch 'master' of https://github.com/amsehili/auditok
author www-data <www-data@c4dm-xenserv-virt2.eecs.qmul.ac.uk>
date Wed, 30 Oct 2024 22:17:58 +0000
parents 2644f997b6e0
children 6cf3ea23fadb
line wrap: on
line diff
--- a/doc/command_line_usage.rst	Wed Oct 30 21:17:58 2024 +0000
+++ b/doc/command_line_usage.rst	Wed Oct 30 22:17:58 2024 +0000
@@ -160,8 +160,8 @@
     auditok -o "{id}_{start:.3f}_{end:.3f}.wav"
 
 
-Save whole audio stream
------------------------
+Record the full audio stream
+----------------------------
 
 When reading audio data from the microphone, you may want to save it to disk.
 To do this, use the ``-O`` or ``--save-stream`` option:
@@ -173,14 +173,14 @@
 Note that this will work even if you read data from a file on disk.
 
 
-Join detected audio events with a silence of a given duration
--------------------------------------------------------------
+Join detected audio events, inserting a silence between them
+------------------------------------------------------------
 
 Sometimes, you may want to detect audio events while also
 creating a file that contains the same events with modified
 pause durations.
 
-To do this, use the ``-j`` or ``--join-detections`` option together
+To achieve this, use the ``-j`` or ``--join-detections`` option together
 with the ``-O`` / ``--save-stream`` option. In the example below, we
 read data from `input.wav` and save audio events to `output.wav`, adding
 1-second pauses between them: