comparison README_OSC.md @ 2525:2179bf9757a0

Clarification and reordering
author Chris Cannam
date Wed, 29 Apr 2020 15:27:43 +0100
parents c3779574273b
children
comparison
equal deleted inserted replaced
2524:1891812e44b2 2525:2179bf9757a0
215 ``` 215 ```
216 216
217 Switch playback loop mode on or off. 217 Switch playback loop mode on or off.
218 218
219 219
220 ### Region selection
221
222 ```
223 /select <t0> <t1>
224 /select all
225 /select none
226 ```
227
228 Select the region from times `<t0>` to `<t1>` in seconds; or select
229 the whole file; or clear the selection. If there is a layer selected
230 that can be used as a snap guide for the selection, then the selection
231 will be snapped to it (in the same manner as when making selections
232 interactively).
233
234 ```
235 /addselect <t0> <t1>
236 ```
237
238 Make an additional selection (leaving any existing selection in place)
239 from times `<t0>` to `<t1>` in seconds.
240
241
242 ### Panes, layers, and the window 220 ### Panes, layers, and the window
243 221
244 ``` 222 ```
245 /add <layertype> 223 /add <layertype>
246 /add <layertype> <channel> 224 /add <layertype> <channel>
247 ``` 225 ```
248 226
249 Add a new pane containing a layer of the given type, based on the 227 Add a new pane containing a layer of the given type, based on the
250 given channel of the main audio file (numbered from 0). If no 228 given channel of the main audio file (numbered from 0). If no
251 `<channel>` is specified, mix all channels. 229 `<channel>` is specified, mix all channels. The specified layer is
230 made the current layer, and the new pane becomes the current pane.
252 231
253 Useful values of `<layertype>` are: 232 Useful values of `<layertype>` are:
254 233
255 ``` 234 ```
256 waveform 235 waveform
359 `<min>` to `<max>` in the vertical scale; or zoom in or out 338 `<min>` to `<max>` in the vertical scale; or zoom in or out
360 vertically; or return to the default vertical zoom level. The effect 339 vertically; or return to the default vertical zoom level. The effect
361 of this method is heavily dependent on the current layer. 340 of this method is heavily dependent on the current layer.
362 341
363 ``` 342 ```
343 /resize <w> <h>
344 ```
345
346 Resize the main window to width `<w>` and height `<h>` (if the window
347 system permits).
348
349
350 ### Region selection
351
352 ```
353 /select <t0> <t1>
354 /select all
355 /select none
356 ```
357
358 Select the region from times `<t0>` to `<t1>` in seconds; or select
359 the whole file; or clear the selection. If there is a layer selected
360 that can be used as a snap guide for the selection, then the selection
361 will be snapped to it (in the same manner as when making selections
362 interactively).
363
364 ```
365 /addselect <t0> <t1>
366 ```
367
368 Make an additional selection (leaving any existing selection in place)
369 from times `<t0>` to `<t1>` in seconds.
370
371
372 ### Feature extraction
373
374 ```
364 /transform <name> 375 /transform <name>
365 ``` 376 ```
366 377
367 Transform the current main audio file using the named transform. 378 Transform the current main audio file using the named transform.
368 Transforms are named according to the scheme 379 Transforms are named according to the scheme
383 `percussiononsets` rather than "Simple Percussion Onset Detector". 394 `percussiononsets` rather than "Simple Percussion Onset Detector".
384 395
385 There is not yet any way to run a transform via OSC on any but the 396 There is not yet any way to run a transform via OSC on any but the
386 main audio file, nor with any but its default parameters, processing 397 main audio file, nor with any but its default parameters, processing
387 block/step size, or channel selection. 398 block/step size, or channel selection.
388
389 ```
390 /resize <w> <h>
391 ```
392
393 Resize the main window to width `<w>` and height `<h>` (if the window
394 system permits).
395 399
396 400
397 ### Housekeeping 401 ### Housekeeping
398 402
399 ``` 403 ```