comparison 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
comparison
equal deleted inserted replaced
436:87048a881402 439:ca8090edca2f
158 .. code:: bash 158 .. code:: bash
159 159
160 auditok -o "{id}_{start:.3f}_{end:.3f}.wav" 160 auditok -o "{id}_{start:.3f}_{end:.3f}.wav"
161 161
162 162
163 Save whole audio stream 163 Record the full audio stream
164 ----------------------- 164 ----------------------------
165 165
166 When reading audio data from the microphone, you may want to save it to disk. 166 When reading audio data from the microphone, you may want to save it to disk.
167 To do this, use the ``-O`` or ``--save-stream`` option: 167 To do this, use the ``-O`` or ``--save-stream`` option:
168 168
169 .. code:: bash 169 .. code:: bash
171 auditok --save-stream output.wav 171 auditok --save-stream output.wav
172 172
173 Note that this will work even if you read data from a file on disk. 173 Note that this will work even if you read data from a file on disk.
174 174
175 175
176 Join detected audio events with a silence of a given duration 176 Join detected audio events, inserting a silence between them
177 ------------------------------------------------------------- 177 ------------------------------------------------------------
178 178
179 Sometimes, you may want to detect audio events while also 179 Sometimes, you may want to detect audio events while also
180 creating a file that contains the same events with modified 180 creating a file that contains the same events with modified
181 pause durations. 181 pause durations.
182 182
183 To do this, use the ``-j`` or ``--join-detections`` option together 183 To achieve this, use the ``-j`` or ``--join-detections`` option together
184 with the ``-O`` / ``--save-stream`` option. In the example below, we 184 with the ``-O`` / ``--save-stream`` option. In the example below, we
185 read data from `input.wav` and save audio events to `output.wav`, adding 185 read data from `input.wav` and save audio events to `output.wav`, adding
186 1-second pauses between them: 186 1-second pauses between them:
187 187
188 188