eessppeelllloo/vimix
1
0
Fork 0
mirror of https://github.com/brunoherbelin/vimix.git synced 2025-12-09 17:29:59 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated Open Sound Control API (markdown)

BHBN
2024-02-18 14:55:54 +01:00
parent 8a20eca4d3
commit 4acaeb5615
1 changed files with 14 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
Open-Sound-Control-API.md

@@ -221,13 +221,13 @@ When the target is able to identify a source by its name, by its index, or as th
**`filter` : Set Filter : Clone source only**
> _Mandatory argument_ : a string `s` sets the filter to use, by name. If the source is not text, nothing happens.
> _Mandatory argument_ : a string `s` sets the filter to use, by name (lower case). If the source is not text, nothing happens.
> The valid filters are: `none`, `delay`, `resample`, `blur`, `sharpen`, `smooth`, `edge`, `alpha`, `custom`.
> Example; send `/vimix/current/filter s blur` to set the filter of the current source, assuming it is a clone source.
> _Optional arguments_ :
>
> 1. a second string `s` sets the method or type of algorithm of the filter, as listed in the user interface.
> 1. a second string `s` sets the method or type of algorithm of the filter (lower case), as listed in the user interface.
> 2. a value `f` sets the main value associated to the filter, as listed in the user interface.
> 3. a second value `f` defines the duration, in miliseconds, of the animation to reach the previous value.
>
@@ -239,7 +239,17 @@ When the target is able to identify a source by its name, by its index, or as th
> a type `N` can replace an argument type in the argument list, allowing to skip this argument.
> Example; sending `/vimix/current/filter NNf 0.7` will set the filter value to 0.7 without changing the filter type and method.
> Or send `/vimix/current/filter Ns gaussian` to only set the method to "gaussian", assuming it will be meaningful for the current filter (i.e. works only for a "blur" filter).
>
> Here are valid filter arguments;
> - `none` : no argument, i.e. only `/vimix/current/filter none` is meaningful. This removes any filter to the clone source.
> - `delay` : only the `f` value argument is used, i.e. `/vimix/current/filter sNf delay 0.1` sets delay of 0.1 second.
> - `resample` : only the `s` method argument is used. It can be `double`, `half` or `quarter`, e.g. `/vimix/current/filter ss resample half` sets resampling method to half resolution.
> - `blur` : method can be `gaussian`, `scattered`, `opening`, `closing` and `fast`. The value argument corresponds to the _Radius_ parameter of the blur (except `fast` which ignores it).
> - `sharpen` : method can be `unsharp`, `convolution`, `edge`, `white` and `black`. The value argument corresponds to the _Amount_ or _Radius_ parameter of the sharpen method, depending on the case.
> - `smooth` : method can be `bilateral`, `kuwahara`, `opening`, `closing`, `erosion`, `dilation`, `denoise`, `noise` and `grain`. The value argument corresponds to the _Factor_, _Radius_ or _Amount_ parameter of the smoothing or noise effect, depending on the case.
> - `edge` : method can be `sobel`, `freichen`, `edge` and `contour`. The value argument corresponds to the _Factor_ or _Threshold_ parameter of the edge detection method, depending on the case.
> - `alpha` : method can be `chromakey`, `lumakey` and `fill`. The value argument corresponds to the _Tolerance_ parameter of the keying method, ignored for alpha filling filter.
> - `custom` : second `s` argument is considered as a filename containing a GLSL shader code, e.g. `/vimix/#1/filter ss custom '/home/username/shadertoycode.glsl'`
***
@@ -276,7 +286,7 @@ The target `current` sets which source is active or changes the attribute of the
> Example; `/vimix/current/previous` is equivalent to pressing [SHIFT]+[TAB] in __vimix__
**A number `N` : Set source at index N as current.**
**A number N : Set source at index N as current.**
> Example; send `/vimix/current/0` to set source at index 0 to be current, equivalent to clicking on source at index 0 (first in list) in the left source panel of __vimix__.