eessppeelllloo/vimix
1
0
Fork 0
mirror of https://github.com/brunoherbelin/vimix.git synced 2025-12-13 11:19:58 +01:00
Code Issues Packages Projects Releases Wiki Activity

fixed spelling

BHBN
2024-11-22 12:26:37 +01:00
parent 6ac46954f6
commit 20b5bf6fef
1 changed files with 28 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
Open-Sound-Control-API.md

@@ -76,7 +76,7 @@ _NB: only latest version of *vimix* supports all attributes._
> _Mandatory argument_ : the value [-1 +1] is used to set the source opacity in the mixing circle. For values between 0.0 (transparent) and 1.0 (visible), the source is inside the mixing circle. For negative values, the source is outside the mixing circle (transparent) and can be deactivated if outside of mixing area. > _Mandatory argument_ : the value [-1 +1] is used to set the source opacity in the mixing circle. For values between 0.0 (transparent) and 1.0 (visible), the source is inside the mixing circle. For negative values, the source is outside the mixing circle (transparent) and can be deactivated if outside of mixing area.
> Example; send `/vimix/current/alpha f 0.3` to set source opacity to 30% (70% transparency). > Example; send `/vimix/current/alpha f 0.3` to set source opacity to 30% (70% transparency).
> Example; send `/vimix/current/alpha f -1.0` to place the source outside of mixing area where it will be deactivated. > Example; send `/vimix/current/alpha f -1.0` to place the source outside of mixing area where it will be deactivated.
> _Optional argument_ : a second value defines the duration, in miliseconds, of the animation to reach the given value. > _Optional argument_ : a second value defines the duration, in millisecond, of the animation to reach the given value.
> Example; `/vimix/current/alpha ff 1.0 1000` triggers a 1000 ms (1 second) animation to reach maximum alpha. > Example; `/vimix/current/alpha ff 1.0 1000` triggers a 1000 ms (1 second) animation to reach maximum alpha.
**`tranparency` : Set the transparency of the source (Mixing view)** **`tranparency` : Set the transparency of the source (Mixing view)**
@@ -84,22 +84,22 @@ _NB: only latest version of *vimix* supports all attributes._
> _Mandatory argument_ : the value [0 2] is used to set the source transparency. For values between 0.0 (visible) and 1.0 (transparent), the source is inside the mixing circle. For values above 1.0, the source is outside the mixing circle (transparent) and can be deactivated if outside of mixing area. It is the logical opposite of `alpha`, provided for convenience. > _Mandatory argument_ : the value [0 2] is used to set the source transparency. For values between 0.0 (visible) and 1.0 (transparent), the source is inside the mixing circle. For values above 1.0, the source is outside the mixing circle (transparent) and can be deactivated if outside of mixing area. It is the logical opposite of `alpha`, provided for convenience.
> Example; send `/vimix/current/transparency f 0.3` to set source transparency to 30% (70% alpha). > Example; send `/vimix/current/transparency f 0.3` to set source transparency to 30% (70% alpha).
> Example; send `/vimix/current/transparency f 2.0` to place the source outside of mixing area where it will be deactivated. > Example; send `/vimix/current/transparency f 2.0` to place the source outside of mixing area where it will be deactivated.
> _Optional argument_ : a second value defines the duration, in miliseconds, of the animation to reach the given value. > _Optional argument_ : a second value defines the duration, in millisecond, of the animation to reach the given value.
> Example; `/vimix/current/transparency ff 1.0 500.0` triggers a 500 ms (0.5 second) animation to reach maximum transparency. > Example; `/vimix/current/transparency ff 1.0 500.0` triggers a 500 ms (0.5 second) animation to reach maximum transparency.
**`loom` : Change the alpha of the source (Mixing view)** **`loom` : Change the alpha of the source (Mixing view)**
> _Mandatory argument_ : the value is used to indicate the speed (amplitude) of the change of alpha to apply. > _Mandatory argument_ : the value is used to indicate the speed (amplitude) of the change of alpha to apply.
> Example; send `/vimix/current/loom f 1.0` to increase the alpha by 1.0 per second (at 60Hz, that makes 1/60th of change per frame) > Example; send `/vimix/current/loom f 1.0` to increase the alpha by 1.0 per second (at 60Hz, that makes 1/60th of change per frame)
> _Optional argument_ : a second value defines the duration, in miliseconds, of a looming animation. > _Optional argument_ : a second value defines the duration, in millisecond, of a looming animation.
**`position` : Set the position of the source (Geometry view)** **`position` : Set the position of the source (Geometry view)**
> _Mandatory arguments_ : two floats `ff` are used to indicate the target position to place the source in the Geometry View. > _Mandatory arguments_ : two floats `ff` are used to indicate the target position to place the source in the Geometry View.
> Example; send `/vimix/current/position ff 1.0 1.0` to put the source at the upper right corner (+1 in x and +1 in y). > Example; send `/vimix/current/position ff 1.0 1.0` to put the source towards the upper right corner (+1 in x and +1 in y).
> To set only one coordinate (x OR y), set one type to Nil `N` in the OSC argument list. > To set only one coordinate (x OR y), set one type to Nil `N` in the OSC argument list.
> Example; send `/vimix/current/position Nf 1.0` to set the Y coordinate to 1.0 without affecting X. > Example; send `/vimix/current/position Nf 1.0` to set the Y coordinate to 1.0 without affecting X.
> _Optional argument_ : a third value defines the duration, in miliseconds, of the animation to reach the given position. > _Optional argument_ : a third value defines the duration, in millisecond, of the animation to reach the given position.
> Example; `/vimix/current/position fff 0 0 1000` triggers a 1000 ms (1 second) animation to return to center. > Example; `/vimix/current/position fff 0 0 1000` triggers a 1000 ms (1 second) animation to return to center.
**`grab` : Change the position of the source (Geometry view)** **`grab` : Change the position of the source (Geometry view)**
@@ -108,16 +108,16 @@ _NB: only latest version of *vimix* supports all attributes._
> Example; send `/vimix/current/grab ff 1.0 1.0` to grab the source towards the upper right (+1 in x and +1 in y). > Example; send `/vimix/current/grab ff 1.0 1.0` to grab the source towards the upper right (+1 in x and +1 in y).
> To change only one coordinate (x OR y), set one type to Nil `N` in the OSC argument list. > To change only one coordinate (x OR y), set one type to Nil `N` in the OSC argument list.
> Example; send `/vimix/current/grab Nf 1.0` to grab in the Y direction without affecting X. > Example; send `/vimix/current/grab Nf 1.0` to grab in the Y direction without affecting X.
> _Optional argument_ : a second value defines the duration, in miliseconds, of the animation during which the source is grabbed. > _Optional argument_ : a second value defines the duration, in millisecond, of the animation during which the source is grabbed.
**`size` : Set the size of the source (Geometry view)** **`size` : Set the size of the source (Geometry view)**
> _Mandatory arguments_ : two floats `ff` are used to indicate the size of the source in the Geometry View > _Mandatory arguments_ : two floats `ff` are used to indicate the size of the source in the Geometry View
> Example; send `/vimix/current/size ff 1.0 1.0` to set the source width and height to a square > Example; send `/vimix/current/size ff 1.0 1.0` to reset the source width and height scaling (i.e. original size)
> To set only one coordinate (x OR y), set one type to Nil `N` in the OSC argument list. > To set only one coordinate (x OR y), set one type to Nil `N` in the OSC argument list.
> Example; send `/vimix/current/size Nf 1.0` to set the height to 1.0 without affecting the width. > Example; send `/vimix/current/size Nf 1.0` to set the height to 1.0 without affecting the width.
> _Optional argument_ : a third value defines the duration, in miliseconds, of the animation to reach the given size. > _Optional argument_ : a third value defines the duration, in millisecond, of the animation to reach the given size.
> Example; `/vimix/current/size fff 1 1 1000` triggers a 1000 ms (1 second) animation to restore original source scale. > Example; `/vimix/current/size fff 1 1 1000` triggers a 1000 ms (1 second) animation to restore original source size.
**`resize` : Change the size of the source (Geometry view)** **`resize` : Change the size of the source (Geometry view)**
@@ -126,13 +126,13 @@ _NB: only latest version of *vimix* supports all attributes._
> `/vimix/current/resize ff -1.0 -1.0` to reduce the source width and height. > `/vimix/current/resize ff -1.0 -1.0` to reduce the source width and height.
> To change only one coordinate (x OR y), set one type to Nil `N` in the OSC argument list. > To change only one coordinate (x OR y), set one type to Nil `N` in the OSC argument list.
> Example; send `/vimix/current/resize Nf 1.0` to enlarge the height without affecting the width. > Example; send `/vimix/current/resize Nf 1.0` to enlarge the height without affecting the width.
> _Optional argument_ : a second value defines the duration, in miliseconds, of the animation during which the source is resized. > _Optional argument_ : a second value defines the duration, in millisecond, of the animation during which the source is resized.
**`angle` : Set the angle of the source (Geometry view)** **`angle` : Set the angle of the source (Geometry view)**
> _Mandatory argument_ : the value is used to indicate the angle of rotation to apply on the source in the Geometry View > _Mandatory argument_ : the value is used to indicate the angle of rotation to apply on the source in the Geometry View
> Example; send `/vimix/current/angle f 3.1416` to set the source orientation to 360 degrees (PI). > Example; send `/vimix/current/angle f 3.1416` to set the source orientation to 360 degrees (PI).
> _Optional argument_ : a second value defines the duration, in miliseconds, of the animation to reach the given angle. > _Optional argument_ : a second value defines the duration, in millisecond, of the animation to reach the given angle.
> Example; `/vimix/current/angle ff 0 1000` triggers a 1000 ms (1 second) animation to restore original source orientation. > Example; `/vimix/current/angle ff 0 1000` triggers a 1000 ms (1 second) animation to restore original source orientation.
**`turn` : Change the angle of the source (Geometry view)** **`turn` : Change the angle of the source (Geometry view)**
@@ -140,7 +140,7 @@ _NB: only latest version of *vimix* supports all attributes._
> _Mandatory argument_ : the value is used to indicate the angular speed (direction and amplitude) of rotation to apply on the source in the Geometry View > _Mandatory argument_ : the value is used to indicate the angular speed (direction and amplitude) of rotation to apply on the source in the Geometry View
> Example; send `/vimix/current/turn f 1.0` to turn the source in clockwise direction. > Example; send `/vimix/current/turn f 1.0` to turn the source in clockwise direction.
> `/vimix/current/turn f -0.2` to turn the source in counter-clockwise direction, slowly. > `/vimix/current/turn f -0.2` to turn the source in counter-clockwise direction, slowly.
> _Optional argument_ : a second value defines the duration, in miliseconds, of the animation. > _Optional argument_ : a second value defines the duration, in milliseconds, of the animation.
> Example; `/vimix/current/turn ff 0.2 5000` triggers a 5000 ms (5 second) rotation at 0.2 radians/second. > Example; `/vimix/current/turn ff 0.2 5000` triggers a 5000 ms (5 second) rotation at 0.2 radians/second.
**`reset` : Reset the position, scale and angle of the source (Geometry view)** **`reset` : Reset the position, scale and angle of the source (Geometry view)**
@@ -151,7 +151,7 @@ _NB: only latest version of *vimix* supports all attributes._
> _Mandatory argument_ : the value is used to set the source depth, its position in the Layers View between 0.0 (back) and 12.0 (front). > _Mandatory argument_ : the value is used to set the source depth, its position in the Layers View between 0.0 (back) and 12.0 (front).
> Example; send `/vimix/current/depth f 6.0` to set source depth to 6.0 (middle of the workspace). > Example; send `/vimix/current/depth f 6.0` to set source depth to 6.0 (middle of the workspace).
> _Optional argument_ : a second value defines the duration, in miliseconds, of the animation to reach the given value. > _Optional argument_ : a second value defines the duration, in millisecond, of the animation to reach the given value.
> Example; `/vimix/current/depth ff 2.0 500.0` triggers a 500 ms (0.5 second) animation to reach depth 2.0. > Example; `/vimix/current/depth ff 2.0 500.0` triggers a 500 ms (0.5 second) animation to reach depth 2.0.
> >
> Nota Bene: depth < 2.0 is in background, depth > 10.0 is in foreground, else is in workspace > Nota Bene: depth < 2.0 is in background, depth > 10.0 is in foreground, else is in workspace
@@ -163,7 +163,7 @@ _NB: only latest version of *vimix* supports all attributes._
> Example; `/vimix/current/blending s 'hard light'` > Example; `/vimix/current/blending s 'hard light'`
> >
> _Alternative argument_ : an integer 'i' (instead of the string) where the value is the index of the filter. > _Alternative argument_ : an integer 'i' (instead of the string) where the value is the index of the filter.
> The valid intergers are: 0: `Normal`, 1: `Screen`, 2: `Subtract`, 3: `Multiply`, 4: `Hard light`, 5: `Soft light`, 6: `Soft subtract`, 7: `Lighten only`. > The valid integer values are: 0: `Normal`, 1: `Screen`, 2: `Subtract`, 3: `Multiply`, 4: `Hard light`, 5: `Soft light`, 6: `Soft subtract`, 7: `Lighten only`.
> Example; `/vimix/current/blending i 4` sets blending to `Hard light`. > Example; `/vimix/current/blending i 4` sets blending to `Hard light`.
**`lock` : Lock/unlock the source** **`lock` : Lock/unlock the source**
@@ -181,7 +181,7 @@ _NB: only latest version of *vimix* supports all attributes._
> _Mandatory argument_ : 3 values are used to set the source RGB gamma color. > _Mandatory argument_ : 3 values are used to set the source RGB gamma color.
> Example; send `/vimix/current/color fff 0.0 0.0 1.0` to set gamma color to blue. > Example; send `/vimix/current/color fff 0.0 0.0 1.0` to set gamma color to blue.
> _Optional argument_ : a 4th value defines the duration, in miliseconds, of the animation to reach the given value. > _Optional argument_ : a 4th value defines the duration, in millisecond, of the animation to reach the given value.
> Example; send `/vimix/current/gamma ffff 0 0 1 1000` triggers a 1000 ms (1 second) animation to reach blue gamma color. > Example; send `/vimix/current/gamma ffff 0 0 1 1000` triggers a 1000 ms (1 second) animation to reach blue gamma color.
@@ -189,35 +189,35 @@ _NB: only latest version of *vimix* supports all attributes._
> _Mandatory argument_ : the value is used to set the source gamma between -1.0 and +1.0. > _Mandatory argument_ : the value is used to set the source gamma between -1.0 and +1.0.
> Example; send `/vimix/current/gamma f 1.0` to set gamma to maximum. > Example; send `/vimix/current/gamma f 1.0` to set gamma to maximum.
> _Optional argument_ : a second value defines the duration, in miliseconds, of the animation to reach the given value. > _Optional argument_ : a second value defines the duration, in millisecond, of the animation to reach the given value.
> Example; send `/vimix/current/gamma ff 1.0 1000.0` triggers a 1000 ms (1 second) animation to reach maximum gamma. > Example; send `/vimix/current/gamma ff 1.0 1000.0` triggers a 1000 ms (1 second) animation to reach maximum gamma.
**`brightness` : Set the brightness of the source (if color correction enabled)** **`brightness` : Set the brightness of the source (if color correction enabled)**
> _Mandatory argument_ : the value is used to set the source brightness between -1.0 and +1.0. > _Mandatory argument_ : the value is used to set the source brightness between -1.0 and +1.0.
> Example; send `/vimix/current/brightness f 1.0` to set contrast to maximum. > Example; send `/vimix/current/brightness f 1.0` to set contrast to maximum.
> _Optional argument_ : a second value defines the duration, in miliseconds, of the animation to reach the given value. > _Optional argument_ : a second value defines the duration, in millisecond, of the animation to reach the given value.
> Example; send `/vimix/current/brightness ff 1.0 1000.0` triggers a 1000 ms (1 second) animation to reach maximum contrast. > Example; send `/vimix/current/brightness ff 1.0 1000.0` triggers a 1000 ms (1 second) animation to reach maximum contrast.
**`contrast` : Set the contrast of the source (if color correction enabled)** **`contrast` : Set the contrast of the source (if color correction enabled)**
> _Mandatory argument_ : the value is used to set the source contrast between -1.0 and +1.0. > _Mandatory argument_ : the value is used to set the source contrast between -1.0 and +1.0.
> Example; send `/vimix/current/contrast f 0.0` to reset contrast to no change. > Example; send `/vimix/current/contrast f 0.0` to reset contrast to no change.
> _Optional argument_ : a second value defines the duration, in miliseconds, of the animation to reach the given value. > _Optional argument_ : a second value defines the duration, in millisecond, of the animation to reach the given value.
> Example; send `/vimix/current/contrast ff 1.0 1000.0` triggers a 1000 ms (1 second) animation to reach maximum contrast. > Example; send `/vimix/current/contrast ff 1.0 1000.0` triggers a 1000 ms (1 second) animation to reach maximum contrast.
**`saturation` : Set the saturation of the source (if color correction enabled)** **`saturation` : Set the saturation of the source (if color correction enabled)**
> _Mandatory argument_ : the value is used to set the source saturation between -1.0 (grayscale) and +1.0. > _Mandatory argument_ : the value is used to set the source saturation between -1.0 (grayscale) and +1.0.
> Example; send `/vimix/current/saturation f -1.0` to change to grayscale. > Example; send `/vimix/current/saturation f -1.0` to change to grayscale.
> _Optional argument_ : a second value defines the duration, in miliseconds, of the animation to reach the given value. > _Optional argument_ : a second value defines the duration, in millisecond, of the animation to reach the given value.
> Example; send `/vimix/current/saturation ff 1.0 1000.0` triggers a 1000 ms (1 second) animation to reach maximum saturation. > Example; send `/vimix/current/saturation ff 1.0 1000.0` triggers a 1000 ms (1 second) animation to reach maximum saturation.
**`hue` : Set the hue shift of the source (if color correction enabled)** **`hue` : Set the hue shift of the source (if color correction enabled)**
> _Mandatory argument_ : the value is used to set the source color hue shift between 0.0 (disabled) and 1.0. > _Mandatory argument_ : the value is used to set the source color hue shift between 0.0 (disabled) and 1.0.
> Example; send `/vimix/current/hue f 0.5` to change hue to the opposite (50%). > Example; send `/vimix/current/hue f 0.5` to change hue to the opposite (50%).
> _Optional argument_ : a second value defines the duration, in miliseconds, of the animation to reach the given value. > _Optional argument_ : a second value defines the duration, in millisecond, of the animation to reach the given value.
> Example; send `/vimix/current/hue ff 1.0 1000.0` triggers a 1000 ms (1 second) animation to go through all hue. > Example; send `/vimix/current/hue ff 1.0 1000.0` triggers a 1000 ms (1 second) animation to go through all hue.
**`posterize` : Set the color posterization level of the source (if color correction enabled)** **`posterize` : Set the color posterization level of the source (if color correction enabled)**
@@ -231,7 +231,7 @@ _NB: only latest version of *vimix* supports all attributes._
> _Mandatory argument_ : the value is used to set the source threshold between 0.0 (disabled) and 1.0. > _Mandatory argument_ : the value is used to set the source threshold between 0.0 (disabled) and 1.0.
> Example; send `/vimix/current/threshold f 0.5` to set threshold. > Example; send `/vimix/current/threshold f 0.5` to set threshold.
> _Optional argument_ : a second value defines the duration, in miliseconds, of the animation to reach the given value. > _Optional argument_ : a second value defines the duration, in millisecond, of the animation to reach the given value.
> Example; send `/vimix/current/threshold ff 1.0 1000.0` triggers a 1000 ms (1 second) animation to reach threshold. > Example; send `/vimix/current/threshold ff 1.0 1000.0` triggers a 1000 ms (1 second) animation to reach threshold.
**`invert` : Set the color invert mode of the source (if color correction enabled)** **`invert` : Set the color invert mode of the source (if color correction enabled)**
@@ -253,14 +253,14 @@ _NB: only latest version of *vimix* supports all attributes._
> _Mandatory argument_ : the value is used to set the source play speed between 0.1 and 10.0. > _Mandatory argument_ : the value is used to set the source play speed between 0.1 and 10.0.
> Example; send `/vimix/current/speed f 2.0` to set play speed to x2 for current source. > Example; send `/vimix/current/speed f 2.0` to set play speed to x2 for current source.
> _Optional argument_ : a second value defines the duration, in miliseconds, of the animation to reach the given value. > _Optional argument_ : a second value defines the duration, in millisecond, of the animation to reach the given value.
> Example; `/vimix/current/speed ff 5.0 1000.0` triggers a 1000 ms (1 second) animation to reach play speed. > Example; `/vimix/current/speed ff 5.0 1000.0` triggers a 1000 ms (1 second) animation to reach play speed.
**`ffwd` : Fast-forward playing the source : Media source only** **`ffwd` : Fast-forward playing the source : Media source only**
> _Mandatory argument_ : the value is used to set the duration of the fast-forward jump, in milisecond. > _Mandatory argument_ : the value is used to set the duration of the fast-forward jump, in millisecond.
> Example; send `/vimix/current/ffwd f 500` to fast-forward jump by 500 milisecond. > Example; send `/vimix/current/ffwd f 500` to fast-forward jump by 500 millisecond.
> _Optional argument_ : a second value defines the duration, in miliseconds, during which the fast forward is applied. > _Optional argument_ : a second value defines the duration, in millisecond, during which the fast forward is applied.
> Example; `/vimix/current/ffwd ff 50 1000` triggers a fast-forward play with 50ms jumps during 1000 ms (1 second). > Example; `/vimix/current/ffwd ff 50 1000` triggers a fast-forward play with 50ms jumps during 1000 ms (1 second).
**`seek` : Set target position in a video : Media source only** **`seek` : Set target position in a video : Media source only**
@@ -268,8 +268,8 @@ _NB: only latest version of *vimix* supports all attributes._
> _Mandatory argument_ : the value sets the target time to seek to in a video. If the source cannot seek, nothing happens. > _Mandatory argument_ : the value sets the target time to seek to in a video. If the source cannot seek, nothing happens.
> - Time as percentage of pay duration: float [0..1] > - Time as percentage of pay duration: float [0..1]
> Example; send `/vimix/current/seek f 0.5` to seek to frame at t=50% of the segments duration of the current media source (i.e. from 0% to 100% of the actual playing duration, discarding the cut segments). > Example; send `/vimix/current/seek f 0.5` to seek to frame at t=50% of the segments duration of the current media source (i.e. from 0% to 100% of the actual playing duration, discarding the cut segments).
> - Time as Hours minutes seconds mili-seconds: 4 integers > - Time as Hours minutes seconds milliseconds: 4 integers
> Example; send `/vimix/current/seek iiii 0 2 34 56` to seek to frame at t = 0 hours 2 min 34 second and 56 milisecond. > Example; send `/vimix/current/seek iiii 0 2 34 56` to seek to frame at t = 0 hours 2 min 34 second and 56 millisecond.
**`contents` : Set text contents : Text source only** **`contents` : Set text contents : Text source only**
@@ -287,7 +287,7 @@ _NB: only latest version of *vimix* supports all attributes._
> >
> 1. a second string `s` sets the method or type of algorithm of the filter (lower case), 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. > 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. > 3. a second value `f` defines the duration, in millisecond, of the animation to reach the previous value.
> >
> Example; send `/vimix/current/filter ss blur gaussian` sets the filter to `blur` with method `gaussian` with default value. > Example; send `/vimix/current/filter ss blur gaussian` sets the filter to `blur` with method `gaussian` with default value.
> Or send `/vimix/current/filter ssff blur gaussian 1.0 1000` to set the filter to `blur` with method `gaussian` and to trigger a 1000 ms (1 second) animation to reach value of 1.0 (the blur radius in this case). > Or send `/vimix/current/filter ssff blur gaussian 1.0 1000` to set the filter to `blur` with method `gaussian` and to trigger a 1000 ms (1 second) animation to reach value of 1.0 (the blur radius in this case).