diff --git a/help-en/index.md b/help-en/index.md index 884fbc81..2cb807ee 100644 --- a/help-en/index.md +++ b/help-en/index.md @@ -10,9 +10,51 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro ## categories - - -### [an](category_an.html) +[an](#cat_an) +[array](#cat_array) +[base](#cat_base) +[chaos](#cat_chaos) +[conv](#cat_conv) +[data](#cat_data) +[dyn](#cat_dyn) +[env](#cat_env) +[flow](#cat_flow) +[flt](#cat_flt) +[fx](#cat_fx) +[global](#cat_global) +[hw](#cat_hw) +[lang](#cat_lang) +[lfo](#cat_lfo) +[list](#cat_list) +[live](#cat_live) +[local](#cat_local) +[math](#cat_math) +[midi](#cat_midi) +[misc](#cat_misc) +[msg](#cat_msg) +[net](#cat_net) +[noise](#cat_noise) +[osc](#cat_osc) +[patch](#cat_patch) +[path](#cat_path) +[predicates](#cat_predicates) +[preset](#cat_preset) +[property](#cat_property) +[proto](#cat_proto) +[random](#cat_random) +[samp](#cat_samp) +[seq](#cat_seq) +[snd](#cat_snd) +[spat](#cat_spat) +[string](#cat_string) +[symbol](#cat_symbol) +[synth](#cat_synth) +[system](#cat_system) +[tl](#cat_tl) +[ui](#cat_ui) + + +### an --- @@ -30,7 +72,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**an.zero\~**](an.zero~.html): zero crossing count/rate/freq calculator -### [array](category_array.html) +### array --- @@ -96,7 +138,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**plot.response\~**](plot.response~.html): output amp/phase freq response to impulse -### [base](category_base.html) +### base --- @@ -142,7 +184,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**z\~**](z~.html): sample delay -### [chaos](category_chaos.html) +### chaos --- @@ -160,7 +202,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**chaos.std0\~**](chaos.std0~.html): Standard map chaotic generator -### [conv](category_conv.html) +### conv --- @@ -256,7 +298,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**music.voice2midi**](music.voice2midi.html): convert voice music list of midi pitches -### [data](category_data.html) +### data --- @@ -318,7 +360,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**set.union**](set.union.html): output union of given sets -### [dyn](category_dyn.html) +### dyn --- @@ -338,7 +380,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**dyn.softclip\~**](dyn.softclip~.html): soft signal clip -### [env](category_env.html) +### env --- @@ -372,7 +414,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**vline2env**](vline2env.html): Converts vline messages to env -### [flow](category_flow.html) +### flow --- @@ -482,7 +524,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**route.symbol**](route.symbol.html): separate symbol messages from other types -### [flt](category_flt.html) +### flt --- @@ -564,7 +606,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**flt.resonlp\~**](flt.resonlp~.html): Simple resonant lowpass filter -### [fx](category_fx.html) +### fx --- @@ -638,7 +680,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**fx.zita_rev1\~**](fx.zita_rev1~.html): Zita stereo reverb -### [global](category_global.html) +### global --- @@ -656,7 +698,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**global.set**](global.set.html): global named set object -### [hw](category_hw.html) +### hw --- @@ -678,7 +720,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**hw.serial**](hw.serial.html): serial port device -### [lang](category_lang.html) +### lang --- @@ -690,7 +732,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**ui.faust\~**](ui.faust~.html): faust compiled ui object -### [lfo](category_lfo.html) +### lfo --- @@ -716,7 +758,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**lfo.tri\~**](lfo.tri~.html): Zero-mean unit-amplitude low frequency triangle wave -### [list](category_list.html) +### list ###### objects for list processing --- @@ -862,7 +904,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**list.zip**](list.zip.html): takes n lists from n inlets (specified by argument) and output their elements sequentially (list1-1 list2-1 list1-2 list2-2 etc.). -### [live](category_live.html) +### live --- @@ -870,7 +912,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**live.capture\~**](live.capture~.html): record up to 32s of sound and playback the recorded sound in loop -### [local](category_local.html) +### local --- @@ -888,7 +930,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**local.set**](local.set.html): local named set object -### [math](category_math.html) +### math ###### math objects. can operate with list of numbers. --- @@ -1090,7 +1132,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**math.trunc\~**](math.trunc~.html): truncate to integer value -### [midi](category_midi.html) +### midi --- @@ -1136,7 +1178,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**midi.vrand**](midi.vrand.html): midi velocity randomizer -### [misc](category_misc.html) +### misc --- @@ -1158,7 +1200,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**speech.rhvoice\~**](speech.rhvoice~.html): RHVoice text to speech synthesis -### [msg](category_msg.html) +### msg --- @@ -1174,7 +1216,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**msg.sched**](msg.sched.html): message scheduler -### [net](category_net.html) +### net --- @@ -1192,7 +1234,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**net.osc.server**](net.osc.server.html): OSC server control -### [noise](category_noise.html) +### noise --- @@ -1244,7 +1286,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**noise.white\~**](noise.white~.html): White noise generator -### [osc](category_osc.html) +### osc --- @@ -1268,7 +1310,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**osc.tri\~**](osc.tri~.html): Bandlimited triangle wave oscillator -### [patch](category_patch.html) +### patch --- @@ -1292,7 +1334,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**patch.tree**](patch.tree.html): patch tree -### [path](category_path.html) +### path --- @@ -1322,7 +1364,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**path.split**](path.split.html): file path split -### [predicates](category_predicates.html) +### predicates --- @@ -1352,7 +1394,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**is_symbol**](is_symbol.html): checks if input data has *symbol* type -### [preset](category_preset.html) +### preset --- @@ -1366,7 +1408,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**preset.symbol**](preset.symbol.html): load/store symbol preset -### [property](category_property.html) +### property --- @@ -1390,7 +1432,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**prop.split**](prop.split.html): separate properties from dataflow -### [proto](category_proto.html) +### proto --- @@ -1420,7 +1462,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**proto.xtouch_ext**](proto.xtouch_ext.html): Behringer XTouch Extender XMidi protocol -### [random](category_random.html) +### random --- @@ -1442,7 +1484,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**random.pw_lin**](random.pw_lin.html): piecewise linear random distribution -### [samp](category_samp.html) +### samp --- @@ -1450,7 +1492,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**samp.time\~**](samp.time~.html): sample counter -### [seq](category_seq.html) +### seq --- @@ -1474,7 +1516,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**sequencer**](sequencer.html): basic sequence player -### [snd](category_snd.html) +### snd --- @@ -1482,7 +1524,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**snd.file**](snd.file.html): Sound file loader on steroids -### [spat](category_spat.html) +### spat --- @@ -1536,7 +1578,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**spat.zita8\~**](spat.zita8~.html): 8 channel reverb spatializer -### [string](category_string.html) +### string --- @@ -1570,7 +1612,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**string2symbol**](string2symbol.html): converts string to symbol -### [symbol](category_symbol.html) +### symbol --- @@ -1586,7 +1628,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**symbol2intlist**](symbol2intlist.html): converts symbol to list of character codes -### [synth](category_synth.html) +### synth --- @@ -1660,7 +1702,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**synth.wurley\~**](synth.wurley~.html): Wurlitzer electric piano FM synthesis instrument -### [system](category_system.html) +### system --- @@ -1684,7 +1726,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**system.screen_size**](system.screen_size.html): returns current screen size in pixels -### [tl](category_tl.html) +### tl --- @@ -1700,7 +1742,7 @@ centre of electroacoustic music of Moscow Conservatory (CEAMMC) and ZIL-electro [**tl.transport**](tl.transport.html): Timeline transport control -### [ui](category_ui.html) +### ui --- diff --git a/help-en/ui.dsp~.md b/help-en/ui.dsp~.md index 718085a4..7390098f 100644 --- a/help-en/ui.dsp~.md +++ b/help-en/ui.dsp~.md @@ -1,45 +1,137 @@ -[< reference home](index.html) +[index](index.html) :: [ui](category_ui.html) --- # ui.dsp~ +###### GUI for turning DSP on/off -GUI for turning DSP on/off +*available since version:* 0.1 --- -
---- +[![example](../examples/img/ui.dsp~.jpg)](../examples/pd/ui.dsp~.pd) + + + + + +## methods: + +* **start** +starts audio processing
+ +* **stop** +stops audio processing
+ +* **settings** +opens audio settings dialog
+ +* **pos** +set UI element position
+ __parameters:__ + - **X** top left x-coord
+ type: float
+ required: True
+ + - **Y** top right y-coord
+ type: float
+ required: True
+ + + + +## properties: + +* **@send** +Get/set send destination
+_type:_ symbol
+_default:_ (null)
+ +* **@receive** +Get/set receive source
+_type:_ symbol
+_default:_ (null)
+ +* **@size** +Get/set element size (width, height pair)
+_type:_ list
+_default:_ 30 30
+ +* **@pinned** +Get/set pin mode. if 1 - put element to the lowest level
+_type:_ bool
+_default:_ 0
+ +* **@active_color** +Get/set element active color (list of red, green, blue values in 0-1 range)
+_type:_ list
+_default:_ 0 0.75 1 1
+ +* **@background_color** +Get/set element background color (list of red, green, blue values in 0-1 range)
+_type:_ list
+_default:_ 0.93 0.93 0.93 1
+ +* **@border_color** +Get/set border color (list of red, green, blue values in 0-1 range)
+_type:_ list
+_default:_ 0.6 0.6 0.6 1
+ +* **@fontsize** +Get/set fontsize
+_type:_ int
+_range:_ 4..100
+_default:_ 11
+ +* **@fontname** +Get/set fontname
+_type:_ symbol
+_enum:_ Courier, DejaVu, Helvetica, Monaco, Times
+_default:_ Helvetica
+ +* **@fontweight** +Get/set font weight
+_type:_ symbol
+_enum:_ normal, bold
+_default:_ normal
+ +* **@fontslant** +Get/set font slant
+_type:_ symbol
+_enum:_ roman, italic
+_default:_ roman
+ + + +## inlets: + +_type:_ control + + + + + +## keywords: + +[ui](keywords/ui.html) +[dsp](keywords/dsp.html) + + + + + + +**Authors:** Pierre Guillot, Serge Poltavsky + + + + +**License:** GPL3 or later -![example](examples/ui.dsp~-example.jpg) ---- -arguments: ---- -properties: - -@send: send destination
-@receive: receive source
-@size: element size (width, height - pair)
-@pinned: pin mode. if 1 - put element - to the lowest level
-@active_color: element active color - (list of red, green, blue values in 0-1 range)
-@background_color: element - background color (list of red, green, blue values in 0-1 range)
-@border_color: border color (list - of red, green, blue values in 0-1 range)
-@fontsize: - fontsize
-@fontname: fontname
-@fontweight: font - weight
-@fontslant: font - slant
diff --git a/help-en/ui.preset.md b/help-en/ui.preset.md index b4359b37..24ec3ae3 100644 --- a/help-en/ui.preset.md +++ b/help-en/ui.preset.md @@ -1,62 +1,198 @@ -[< reference home](index.html) +[index](index.html) :: [ui](category_ui.html) --- # ui.preset +###### Preset manager -Preset manager +*available since version:* 0.1 --- -Saves presets value of UI objects that have @presetname property. Can handle UI - objects only on the save canvas, no subpatches or abstractions are supported. -NOTE: if no UI widgets with @presetname on canvas - *Shift-click* is - disabled. -Active slot is highlighted, available slots are dark gray -
+## information +Saves presets value of UI objects that have @presetname property. Can handle UI objects only on the save canvas, no subpatches or abstractions are supported. NOTE: if no UI widgets with @presetname on canvas - *Shift-click* is disabled. Active slot is highlighted, available slots are dark gray ---- +[![example](../examples/img/ui.preset.jpg)](../examples/pd/ui.preset.pd) + + + + + +## methods: + +* **clear** +clear specified preset
+ __parameters:__ + - **IDX** preset index
+ type: int
+ required: True
+ +* **clearall** +clear all existing presets
+ +* **load** +loads specified preset
+ __parameters:__ + - **IDX** preset index
+ type: int
+ required: True
+ +* **interp** +loads linearry interpolated value between preset, for example: 1.5 means load +interpolated value between preset 1 and 2.
+ __parameters:__ + - **IDX** preset interpolation index
+ type: float
+ required: True
+ +* **store** +stores specified preset
+ __parameters:__ + - **IDX** preset index
+ type: int
+ required: True
+ +* **read** +read presets from file
+ __parameters:__ + - **PATH** path to preset file
+ type: symbol
+ required: True
+ +* **write** +read presets from file
+ __parameters:__ + - **PATH** path to preset file
+ type: symbol
+ required: True
+ +* **duplicate** +fill empty presets by coping exiting values
+ +* **pos** +set UI element position
+ __parameters:__ + - **X** top left x-coord
+ type: float
+ required: True
+ + - **Y** top right y-coord
+ type: float
+ required: True
+ + + + +## properties: + +* **@current** (readonly) +Get current preset index
+_type:_ int
+_default:_ -1
+ +* **@receive** +Get/set receive source
+_type:_ symbol
+_default:_ (null)
+ +* **@size** +Get/set element size (width, height pair)
+_type:_ list
+_default:_ 102 42
+ +* **@pinned** +Get/set pin mode. if 1 - put element to the lowest level
+_type:_ bool
+_default:_ 0
+ +* **@active_color** +Get/set active color (list of red, green, blue values in 0-1 range)
+_type:_ list
+_default:_ 0 0.75 1 1
+ +* **@text_color** +Get/set text color (list of red, green, blue values in 0-1 range)
+_type:_ list
+_default:_ 0 0 0 1
+ +* **@empty_color** +Get/set empty cell color (list of red, green, blue values in 0-1 range)
+_type:_ list
+_default:_ 0.86 0.86 0.86 1
+ +* **@stored_color** +Get/set stored cell color (list of red, green, blue values in 0-1 range)
+_type:_ list
+_default:_ 0.5 0.5 0.5 1
+ +* **@background_color** +Get/set element background color (list of red, green, blue values in 0-1 range)
+_type:_ list
+_default:_ 0.93 0.93 0.93 1
+ +* **@border_color** +Get/set border color (list of red, green, blue values in 0-1 range)
+_type:_ list
+_default:_ 0.6 0.6 0.6 1
+ +* **@fontsize** +Get/set fontsize
+_type:_ int
+_range:_ 4..100
+_default:_ 11
+ +* **@fontname** +Get/set fontname
+_type:_ symbol
+_enum:_ Courier, DejaVu, Helvetica, Monaco, Times
+_default:_ Helvetica
+ +* **@fontweight** +Get/set font weight
+_type:_ symbol
+_enum:_ normal, bold
+_default:_ normal
+ +* **@fontslant** +Get/set font slant
+_type:_ symbol
+_enum:_ roman, italic
+_default:_ roman
+ + + +## inlets: + +_type:_ control + + + + + +## keywords: + +[ui](keywords/ui.html) +[preset](keywords/preset.html) + + + +**See also:** +[\[preset.float\]](preset.float.html) +[\[preset.storage\]](preset.storage.html) + + + + +**Authors:** Pierre Guillot, Serge Poltavsky + + + + +**License:** GPL3 or later -![example](examples/ui.preset-example.jpg) ---- -arguments: ---- -properties: - -@current: current preset - index
-@send: send destination
-@receive: receive source
-@size: element size (width, height - pair)
-@pinned: pin mode. if 1 - put element - to the lowest level
-@active_color: active color (list of - red, green, blue values in 0-1 range)
-@text_color: text color (list of red, - green, blue values in 0-1 range)
-@empty_color: empty cell color - (list of red, green, blue values in 0-1 range)
-@stored_color: stored cell color - (list of red, green, blue values in 0-1 range)
-@background_color: element - background color (list of red, green, blue values in 0-1 range)
-@border_color: border color (list - of red, green, blue values in 0-1 range)
-@fontsize: - fontsize
-@fontname: fontname
-@fontweight: font - weight
-@fontslant: font - slant
---- -see also:
-[![preset.float](img/object_preset.float.png)](preset.float.html) -[![preset.storage](img/object_preset.storage.png)](preset.storage.html)