This file is used for both applications and instruments products, and it can define audio, MIDI and/or GUI aspects of a product, -depending on the properties they use. -In case of instruments, it loads the related sfz file(s).
+depending on the properties they use. +In case of instruments, it loads the related sfz file(s). +It's digitally signed and should not be altered, +but users who want to modify instruments can edit the .sfz and .xml files +this file points to.
One or more gui file(s) are usually located in a GUI directory for
any product type, instrument or application.
diff --git a/search/search_index.json b/search/search_index.json
index 54ff410..125b524 100644
--- a/search/search_index.json
+++ b/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"ARIA XML files","text":"
The ARIA engine library uses XML files to describe the structure and functioning of both application and instrument products.
The information in this documentation was extracted from the XML data in Plogue products using the ARIA engine, like Alter/Ego, chipsounds, sforzando or Garritan ARIA Player and various free sfz based audio sample libraries.
"},{"location":"#ariasetupxml","title":"AriaSetup.xml","text":"Defines the application based on ARIA engine and loads the default bank, e.g. sforzando.bank.xml and GUI, e.g. GUI/gui.xml.
This file is used for both applications and instruments products, and it can define audio, MIDI and/or GUI aspects of a product, depending on the properties they use. In case of instruments, it loads the related sfz file(s).
"},{"location":"#guixml","title":"GUI/*.xml","text":"One or more gui file(s) are usually located in a GUI directory for any product type, instrument or application. Contains various Widgets definitions.
TODO
"},{"location":"ariasetup/","title":"AriaSetup.xml","text":"This file is quite self descriptive.
<?xml version=\"1.0\" ?>\n\n<Key>__512_alphanumeric_characters__</Key>\n<AriaSetup version=\"__4_digit_value__\">\n\n <Property name=\"vendor\" value=\"__full_brand_name__\"/>\n <Property name=\"product\" value=\"__productname__\"/>\n <Property name=\"productID\" value=\"__4_digit_value__\"/>\n <Property name=\"product_full\" value=\"__brand__ __productname__\"/>\n <Property name=\"version\" value=\"__4_digit_value__\"/>\n\n<!-- Path to .scl files directory -->\n <Property name=\"default_path_scl\" value=\"Scales\"/>\n <Property name=\"supportURL\" value=\"__http(s)_url_to_customer_support__\"/>\n <Property name=\"default_bank\" value=\"__appname__.bank.xml\"/>\n\n<!-- TODO: Ignore Key? -->\n <Property name=\"default_bank_signed\" value=\"0\"/>\n\n<!-- If to use D2D Windows renderer -->\n <Property name=\"usesD2D\" value=\"1\"/>\n<!--\n Possible additional properties:\n\n <Property name=\"guiPath\" value=\"GUI/gui.xml\"/>\n <Property name=\"registerURL\" value=\"__http(s) url to product registration__\"/>\n <Property name=\"blacklisted_banks\" value=\"__4_digit_value__\"/>\n <Property name=\"usesPalette\" value=\"1\"/>\n <Property name=\"paletteWidth_Windows\" value=\"__3_digit_value__\"/>\n <Property name=\"paletteWidth_OSXCarbon\" value=\"__3_digit_value__\"/>\n <Property name=\"paletteWidth_OSXCocoa\" value=\"__3_digit_value__\"/>\n-->\n\n <Converters>\n <Converter extension=\"dls\" program=\"\"/>\n <Converter extension=\"sf2\" program=\"\"/>\n <Converter extension=\"wav\" program=\"\"/>\n </Converters>\n\n<!-- ARIA Player have 16 slots (0 to 15) with midi_mode=\"4\", no polyphony -->\n <Multi>\n <Slot id=\"00\" midi_mode=\"1\" polyphony=\"64\" />\n </Multi>\n\n <Aliases>\n<!-- GM2 Effect send (Reverb) -->\n <Alias source=\"91\" destination=\"DID_AUXSEND0\" transform=\"linear\"/>\n<!--\n ARIA Player have also an (unused) chorus\n <Alias source=\"93\" destination=\"DID_AUXSEND1\" transform=\"linear\"/\n-->\n </Aliases>\n\n <Effects>\n<!-- ARIA Player have also `id` and `position` additional attributes -->\n <Effect name=\"Ambience\" bankId=\"__4_digit_value__\" bus=\"audio_aux0\"/>\n </Effects>\n\n</AriaSetup>\nTODO
"},{"location":"bank_application/","title":"Application Bank","text":"<?xml version=\"1.0\" ?>\n\n<Key>__512_alphanumeric_characters__</Key>\n\n<AriaBank\n id=\"__4_digit_value__\"\n name=\"__productname__\"\n vendor=\"__full_brand_name__\"\n product=\"__productname__\"\n version=\"__4_digit_value__\">\n\n <!-- Two effects in a graph fed by the same send mix -->\n <Program name=\"Conv+Amb\" type=\"effect\" mode_offset=\"2000\" export=\"0\">\n\n <GUI target=\"*ARIA_EFFECTS\" path=\"GUI/gui_ambience.xml\"/>\n\n <Param id=\"19\" value=\"0\"/> <!-- like previously, Ambiance DRY is OFF -->\n\n <Element id=\"0\" path=\"*Input\"/>\n <Element id=\"1\" path=\"*com.Garritan.Ambience\"/>\n <Element id=\"2\" path=\"*Output\"/>\n\n <!-- MIDI/Param links -->\n <Link source=\"0\" source_pin=\"m0\" destination=\"1\" destination_pin=\"m0\"/>\n <Link source=\"1\" source_pin=\"m0\" destination=\"2\" destination_pin=\"m0\"/>\n\n <!-- Audio Connections -->\n <Link source=\"0\" source_pin=\"a0\" destination=\"1\" destination_pin=\"a0\"/>\n <Link source=\"0\" source_pin=\"a1\" destination=\"1\" destination_pin=\"a1\"/>\n <Link source=\"1\" source_pin=\"a0\" destination=\"2\" destination_pin=\"a0\"/>\n <Link source=\"1\" source_pin=\"a1\" destination=\"2\" destination_pin=\"a1\"/>\n </Program>\n\n <Program type=\"effect\" name=\"Detune\" mode_offset=\"2000\" export=\"0\">\n <GUI target=\"*ARIA_EFFECTS\" path=\"GUI/FX_detune.xml\"/>\n <Param id=\"5\" value=\"1\"/> <!-- like DRY is OFF -->\n <Param id=\"2\" value=\"0.5\"/>\n\n <Element id=\"0\" path=\"*Input\"/>\n <Element id=\"1\" path=\"*com.mda.Detune\"/>\n <Element id=\"2\" path=\"*Output\"/>\n\n <!-- MIDI/Param links -->\n <Link source=\"0\" source_pin=\"m0\" destination=\"1\" destination_pin=\"m0\"/>\n <Link source=\"1\" source_pin=\"m0\" destination=\"2\" destination_pin=\"m0\"/>\n\n <!-- Audio Connections -->\n <Link source=\"0\" source_pin=\"a0\" destination=\"1\" destination_pin=\"a0\"/>\n <Link source=\"0\" source_pin=\"a1\" destination=\"1\" destination_pin=\"a1\"/>\n <Link source=\"1\" source_pin=\"a0\" destination=\"2\" destination_pin=\"a0\"/>\n <Link source=\"1\" source_pin=\"a1\" destination=\"2\" destination_pin=\"a1\"/>\n </Program>\n\n</AriaBank>\nMain file to load for all xml files definitions for the instrument. Following Unreal Instruments Kitchen-X as example.
"},{"location":"bank_instrument/#example","title":"Example","text":"Kitchen-X.bank.xml:
<?xml version=\"1.0\" ?>\n\n<Key>__512_alphanumeric_characters__</Key>\n<AriaBank id=\"2532\" name=\"Kitchen-X\" vendor=\"ARIA OEM\" product=\"Kitchen-X\" version=\"1000\">\n <Define name=\"$sample_dir\" value=\"../Samples\"/>\n\n <!-- branding for Aria Player and sforzando UIs -->\n <AriaGUI path=\"GUI/aria_info.xml\" target=\"*ARIA_INFO\"/>\n\n <AriaProgram name=\"01-Kitchen-X\" gui=\"GUI/01-Kitchen-X.xml\">\n <AriaElement path=\"Programs/01-Kitchen-X.sfz\"/>\n </AriaProgram>\n\n <AriaProgram name=\"02-Chromatic Glass\" gui=\"GUI/02-Chromatic Glass.xml\">\n <AriaElement path=\"Programs/02-Chromatic Glass.sfz\"/>\n </AriaProgram>\n\n <AriaProgram name=\"03-Glass Harp\" gui=\"GUI/03-Glass Harp.xml\">\n <AriaElement path=\"Programs/03-Glass Harp.sfz\"/>\n </AriaProgram>\n</AriaBank>\nUID for the instrument. The tag is at the same root level as ARIABank.
"},{"location":"bank_instrument/#define","title":"Define","text":"Macro from XML that can be used as alternative of the define opcode in SFZ, so it can be used in SFZ files set from AriaProgram(s), e.g.: default_path=$sample_dir/Cello/
Child node of AriaProgram
Name Type Description / Value(s) path string the relative path to the SFZ file, e.g.: \"Programs/TableWarp2.sfz\""},{"location":"gui/","title":"GUI","text":"GUI/aria_info.xml:
<!--\n It's a GUI file, describing an (opaque?) image with a rectangle area\n of 775x330 size inside a 787x335 container area.\n-->\n<GUI w=\"787\" h=\"335\" >\n <StaticImage x=\"0\" y=\"0\" w=\"775\" h=\"330\" image=\"Infotab.png\"/>\n</GUI>\n1st instrument set, GUI/01-Kitchen-X.xml:
<!--\n Like above, but having also the GUI controls for CCs and the like over\n a transparent (?) background image.\n-->\n<GUI w=\"775\" h=\"335\">\n <StaticImage x=\"0\" y=\"0\" w=\"775\" h=\"330\" image=\"Control.png\" transparent=\"1\"/>\n\n <!-- Other GUI widgets follows here (Sliders) -->\n</GUI>\nThe GUI node accepts the following parameters:
Name Type Description / Values generic_h / generic_w int TODO generic_s int TODO w / h int size DrawingBoundaries int TODO color_back RGBA background color color_border RGBA border color color_DrawingBoundaries RGBA TODO color_text RGBA text color font_size enum verysmall / small / normal / big / verybig idleThrottle int TODO image string background image filename"},{"location":"widgets/","title":"Widgets","text":""},{"location":"widgets/#commandbutton","title":"CommandButton","text":"A button to run some command like open some webpage URL
Name Type Description / Value(s) x / y / w / h int coordinates and size command string a command, see table below data0 string command parameter e.g.: \"http://www.someplace.com/\" image string the name of the image file (2 vertical frames button) inverted int 1 or not set (0?): inverted on off image frames Command name Description / Value(s) edit launch_url value in `data0`` license orlicense_NNNN"},{"location":"widgets/#guicontainer","title":"GUIContainer","text":"An abstract class / layout to contain GUI pages, used in TabView Panes
Name Type Description / Value(s) eslot int TODO param int numeric or macro defined id e.g.: 10 or ID_SOMETHING param_offset int TODO path string xml filename of the contained GUI or define macro *ID slot int TODO xoffset int TODO: might be border / margin / padding value yoffset int TODO: might be border / margin / padding value"},{"location":"widgets/#keyboard","title":"Keyboard","text":"Name Type Description / Value(s) x / y / w / h int coordinates and size offsetN int with N = 0 to 5, 6 in total TODO param int numeric or macro defined id e.g.: 10 or ID_SOMETHING start_key int first note key, e.g.: 0 end_key int last note key, e.g.: 108 image string filename for the enabled white keys when pressed and unpressed image2 string filename for the enabled black keys when pressed and unpressed image3 string TODO image4 string TODO"},{"location":"widgets/#knob","title":"Knob","text":"Name Type Description / Value(s) x / y int coordinates eslot int TODO frames int number of image frames image string the name of the image file (vertical frame images) inverse int 1 or not set (0?): inverted on off image frames param int numeric or macro defined id e.g.: 10 or ID_SOMETHING vdefault int TODO"},{"location":"widgets/#label","title":"Label","text":"A text label to display some value set from another control, associated with the same param.
Vertical, 2 image frames button.
Name Type Description / Value(s) x / y / w / h int coordinates and size image string the name of the image file inverse int 1 or not set (0?): inverted on off image frames param int numeric or macro defined id e.g.: 10 or ID_SOMETHING"},{"location":"widgets/#numerictextbox","title":"NumericTextBox","text":"Name Type Description / Value(s) x / y / w / h int coordinates and size alignment enum left / center / right, the text alignment inside the rect color_text RGBA text color factor int TODO format string printf format string / FORMAT_LINEAR2DB / FORMAT_STEREOPAN offset int TODO param int numeric or macro defined id e.g.: 10 or ID_SOMETHING transparent int 1 or 0"},{"location":"widgets/#optionmenu","title":"OptionMenu","text":"A LMB / RMB clickable label area to display a menu
Name Type Description / Value(s) x / y / w / h int coordinates and size alignment enum left / center / right, the text alignment inside the rect color_text RGBA e.g.: \"#D7DAE0FF\" font_size enum verysmall / small / normal / big / verybig param int numeric or macro defined id e.g.: 10 or ID_SOMETHING transparent int 1 or 0 vdefault int TODO"},{"location":"widgets/#optionitem","title":"OptionItem","text":"OptionMenu item
Name Type Description / Value(s) name string the menuitem label value float the value associated e.g.: 0.5678"},{"location":"widgets/#prefixnamemenu","title":"<PrefixName>Menu","text":"A combobox controlled by a spinner. The control name prefix is custom, e.g. \"FileMenu\", \"KSMenu\", \"OutputMenu\", \"Preset\"
Name Type Description / Value(s) x / y / w / h int coordinates and size alignment enum left / center / right, the text alignment inside the rect color_text RGBA text color entry_empty TODO: might be int like transparent entry_import TODO: might be int like transparent entry_reload TODO: might be int like transparent entry_saveasdefault int TODO: might be int like transparent eslot int TODO font_size enum verysmall / small / normal / big / verybig image_next string arrow image filename image_previous string arrow image filename image_vertical_align TODO: might be int like transparent param int numeric or macro defined id e.g.: 10 or ID_SOMETHING target URL TODO: some effect URL, e.g.: \"com.Vendor.Effectname\" transparent int 1 or 0 type URL TODO: same as target"},{"location":"widgets/#popupoverlay","title":"PopupOverlay","text":"Overlay widget, might be the one displayed when registering an instrument
Name Type Description / Value(s) x / y / w / h int coordinates and size color_back RGBA background color (e.g.: #00000060)"},{"location":"widgets/#progressbar","title":"ProgressBar","text":"Name Type Description / Value(s) x / y / w / h int coordinates and size image string image filename for a 2 frames progress bar TODO: empty and full? Verify this"},{"location":"widgets/#rect","title":"Rect","text":"A drawn rectangle
Name Type Description / Value(s) x / y / w / h int coordinates and size drawMode enum filled TODO fill_color RGBA fill color frameWidth int TODO"},{"location":"widgets/#slider","title":"Slider","text":"Name Type Description / Value(s) x / y / w / h int coordinates and size param int numeric or macro defined id e.g.: 10 or ID_SOMETHING image_handle string the name of the image file (slider handle) image_bg string the name of the image file (slider trail) orientation enum horizontal / vertical"},{"location":"widgets/#specialdigitknob","title":"SpecialDigitKnob","text":"A clickable label that changes its value when keeping pressed the LMB and moving the mouse left or right
Name Type Description / Value(s) x / y / w / h int coordinates and size alignment enum left / center / right, the text alignment inside the rect base int TODO digit_max int maximum value, e.g.\"100\" TODO: what's the difference with vmax? digit_min int minimum value, e.g.\"-100\" TODO: what's the difference with vmin? image string the name of the image used for the numeric values minus_image string the name of the image used to add a minus for negative values plus_image string the name of the image used to add a plus for positive values nbh int the number image height nbw int the number image width granularity int TODO numbers int value size, e.g. 2 for 0-99 or 3 for 0-100 param int numeric or macro defined id e.g.: 10 or ID_SOMETHING show_leading_zeros int TODO, might be int like transparent vmax int maximum value, e.g.\"100\" vmin int minimum value, e.g.\"-100\""},{"location":"widgets/#splash","title":"Splash","text":"TODO: might be a splashscreen window
Name Type Description / Value(s) x / y / w / h int coordinates and size image string the filename of the background image url string URL TODO: probably open in browser on image click"},{"location":"widgets/#staticimage","title":"StaticImage","text":"Name Type Description / Value(s) x / y / w / h int coordinates and size image string the name of the image file transparent int 1 or 0"},{"location":"widgets/#statictext","title":"StaticText","text":"Non variable Label like control
Name Type Description / Value(s) x / y / w / h int coordinates and size alignment enum left / center / right, the text alignment inside the rect color_back RGBA background color color_border RGBA border color color_text RGBA text color font_size enum verysmall / small / normal / big / verybig text string label displayed text transparent int 1 or 0"},{"location":"widgets/#stepeditor","title":"StepEditor","text":"Name Type Description / Value(s) x / y / w / h int coordinates and size border_color RGBA image string the name of the image file editor_border_color RGBA fill_color RGBA zero_color RGBA hoffset int TODO: might be border / margin / padding value voffset int TODO: might be border / margin / padding value nbstep int TODO param int numeric or macro defined id e.g.: 10 or ID_SOMETHING step_increment int step increment target URL TODO: some effect URL, e.g.: \"com.Vendor.Effectname\" transparent int 1 or 0 vmax int maximum value, e.g.\"15\" vmin int minimum value, e.g.\"0\""},{"location":"widgets/#tabview","title":"TabView","text":"Tabbed control, with Panes as pages.
Name Type Description / Value(s) x / y / w / h int coordinates and size id string the control id color_selected RGBA TODO color_deselected RGBA TODO image string image filename of the button background (2 frames: clicked and released) position enum top / bottom TODO: other values? alignment enum left / center / right, tab button positions"},{"location":"widgets/#pane","title":"Pane","text":"TabView' page pane.
Name Type Description / Value(s) image image filename of the pane background, optional imageb image filename of the button background (2 frames: clicked and released)"}]} \ No newline at end of file +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"ARIA XML files","text":"The ARIA engine library uses XML files to describe the structure and functioning of both application and instrument products.
The information in this documentation was extracted from the XML data in Plogue products using the ARIA engine, like Alter/Ego, chipsounds, sforzando or Garritan ARIA Player and various free sfz based audio sample libraries.
"},{"location":"#ariasetupxml","title":"AriaSetup.xml","text":"Defines the application based on ARIA engine and loads the default bank, e.g. sforzando.bank.xml and GUI, e.g. GUI/gui.xml.
This file is used for both applications and instruments products, and it can define audio, MIDI and/or GUI aspects of a product, depending on the properties they use.
In case of instruments, it loads the related sfz file(s). It's digitally signed and should not be altered, but users who want to modify instruments can edit the .sfz and .xml files this file points to.
"},{"location":"#guixml","title":"GUI/*.xml","text":"One or more gui file(s) are usually located in a GUI directory for any product type, instrument or application. Contains various Widgets definitions.
TODO
"},{"location":"ariasetup/","title":"AriaSetup.xml","text":"This file is quite self descriptive.
<?xml version=\"1.0\" ?>\n\n<Key>__512_alphanumeric_characters__</Key>\n<AriaSetup version=\"__4_digit_value__\">\n\n <Property name=\"vendor\" value=\"__full_brand_name__\"/>\n <Property name=\"product\" value=\"__productname__\"/>\n <Property name=\"productID\" value=\"__4_digit_value__\"/>\n <Property name=\"product_full\" value=\"__brand__ __productname__\"/>\n <Property name=\"version\" value=\"__4_digit_value__\"/>\n\n<!-- Path to .scl files directory -->\n <Property name=\"default_path_scl\" value=\"Scales\"/>\n <Property name=\"supportURL\" value=\"__http(s)_url_to_customer_support__\"/>\n <Property name=\"default_bank\" value=\"__appname__.bank.xml\"/>\n\n<!-- TODO: Ignore Key? -->\n <Property name=\"default_bank_signed\" value=\"0\"/>\n\n<!-- If to use D2D Windows renderer -->\n <Property name=\"usesD2D\" value=\"1\"/>\n<!--\n Possible additional properties:\n\n <Property name=\"guiPath\" value=\"GUI/gui.xml\"/>\n <Property name=\"registerURL\" value=\"__http(s) url to product registration__\"/>\n <Property name=\"blacklisted_banks\" value=\"__4_digit_value__\"/>\n <Property name=\"usesPalette\" value=\"1\"/>\n <Property name=\"paletteWidth_Windows\" value=\"__3_digit_value__\"/>\n <Property name=\"paletteWidth_OSXCarbon\" value=\"__3_digit_value__\"/>\n <Property name=\"paletteWidth_OSXCocoa\" value=\"__3_digit_value__\"/>\n-->\n\n <Converters>\n <Converter extension=\"dls\" program=\"\"/>\n <Converter extension=\"sf2\" program=\"\"/>\n <Converter extension=\"wav\" program=\"\"/>\n </Converters>\n\n<!-- ARIA Player have 16 slots (0 to 15) with midi_mode=\"4\", no polyphony -->\n <Multi>\n <Slot id=\"00\" midi_mode=\"1\" polyphony=\"64\" />\n </Multi>\n\n <Aliases>\n<!-- GM2 Effect send (Reverb) -->\n <Alias source=\"91\" destination=\"DID_AUXSEND0\" transform=\"linear\"/>\n<!--\n ARIA Player have also an (unused) chorus\n <Alias source=\"93\" destination=\"DID_AUXSEND1\" transform=\"linear\"/\n-->\n </Aliases>\n\n <Effects>\n<!-- ARIA Player have also `id` and `position` additional attributes -->\n <Effect name=\"Ambience\" bankId=\"__4_digit_value__\" bus=\"audio_aux0\"/>\n </Effects>\n\n</AriaSetup>\nTODO
"},{"location":"bank_application/","title":"Application Bank","text":"<?xml version=\"1.0\" ?>\n\n<Key>__512_alphanumeric_characters__</Key>\n\n<AriaBank\n id=\"__4_digit_value__\"\n name=\"__productname__\"\n vendor=\"__full_brand_name__\"\n product=\"__productname__\"\n version=\"__4_digit_value__\">\n\n <!-- Two effects in a graph fed by the same send mix -->\n <Program name=\"Conv+Amb\" type=\"effect\" mode_offset=\"2000\" export=\"0\">\n\n <GUI target=\"*ARIA_EFFECTS\" path=\"GUI/gui_ambience.xml\"/>\n\n <Param id=\"19\" value=\"0\"/> <!-- like previously, Ambiance DRY is OFF -->\n\n <Element id=\"0\" path=\"*Input\"/>\n <Element id=\"1\" path=\"*com.Garritan.Ambience\"/>\n <Element id=\"2\" path=\"*Output\"/>\n\n <!-- MIDI/Param links -->\n <Link source=\"0\" source_pin=\"m0\" destination=\"1\" destination_pin=\"m0\"/>\n <Link source=\"1\" source_pin=\"m0\" destination=\"2\" destination_pin=\"m0\"/>\n\n <!-- Audio Connections -->\n <Link source=\"0\" source_pin=\"a0\" destination=\"1\" destination_pin=\"a0\"/>\n <Link source=\"0\" source_pin=\"a1\" destination=\"1\" destination_pin=\"a1\"/>\n <Link source=\"1\" source_pin=\"a0\" destination=\"2\" destination_pin=\"a0\"/>\n <Link source=\"1\" source_pin=\"a1\" destination=\"2\" destination_pin=\"a1\"/>\n </Program>\n\n <Program type=\"effect\" name=\"Detune\" mode_offset=\"2000\" export=\"0\">\n <GUI target=\"*ARIA_EFFECTS\" path=\"GUI/FX_detune.xml\"/>\n <Param id=\"5\" value=\"1\"/> <!-- like DRY is OFF -->\n <Param id=\"2\" value=\"0.5\"/>\n\n <Element id=\"0\" path=\"*Input\"/>\n <Element id=\"1\" path=\"*com.mda.Detune\"/>\n <Element id=\"2\" path=\"*Output\"/>\n\n <!-- MIDI/Param links -->\n <Link source=\"0\" source_pin=\"m0\" destination=\"1\" destination_pin=\"m0\"/>\n <Link source=\"1\" source_pin=\"m0\" destination=\"2\" destination_pin=\"m0\"/>\n\n <!-- Audio Connections -->\n <Link source=\"0\" source_pin=\"a0\" destination=\"1\" destination_pin=\"a0\"/>\n <Link source=\"0\" source_pin=\"a1\" destination=\"1\" destination_pin=\"a1\"/>\n <Link source=\"1\" source_pin=\"a0\" destination=\"2\" destination_pin=\"a0\"/>\n <Link source=\"1\" source_pin=\"a1\" destination=\"2\" destination_pin=\"a1\"/>\n </Program>\n\n</AriaBank>\nMain file to load for all xml files definitions for the instrument. Following Unreal Instruments Kitchen-X as example.
"},{"location":"bank_instrument/#example","title":"Example","text":"Kitchen-X.bank.xml:
<?xml version=\"1.0\" ?>\n\n<Key>__512_alphanumeric_characters__</Key>\n<AriaBank id=\"2532\" name=\"Kitchen-X\" vendor=\"ARIA OEM\" product=\"Kitchen-X\" version=\"1000\">\n <Define name=\"$sample_dir\" value=\"../Samples\"/>\n\n <!-- branding for Aria Player and sforzando UIs -->\n <AriaGUI path=\"GUI/aria_info.xml\" target=\"*ARIA_INFO\"/>\n\n <AriaProgram name=\"01-Kitchen-X\" gui=\"GUI/01-Kitchen-X.xml\">\n <AriaElement path=\"Programs/01-Kitchen-X.sfz\"/>\n </AriaProgram>\n\n <AriaProgram name=\"02-Chromatic Glass\" gui=\"GUI/02-Chromatic Glass.xml\">\n <AriaElement path=\"Programs/02-Chromatic Glass.sfz\"/>\n </AriaProgram>\n\n <AriaProgram name=\"03-Glass Harp\" gui=\"GUI/03-Glass Harp.xml\">\n <AriaElement path=\"Programs/03-Glass Harp.sfz\"/>\n </AriaProgram>\n</AriaBank>\nUID for the instrument. The tag is at the same root level as ARIABank.
"},{"location":"bank_instrument/#define","title":"Define","text":"Macro from XML that can be used as alternative of the define opcode in SFZ, so it can be used in SFZ files set from AriaProgram(s), e.g.: default_path=$sample_dir/Cello/
Child node of AriaProgram
Name Type Description / Value(s) path string the relative path to the SFZ file, e.g.: \"Programs/TableWarp2.sfz\""},{"location":"gui/","title":"GUI","text":"GUI/aria_info.xml:
<!--\n It's a GUI file, describing an (opaque?) image with a rectangle area\n of 775x330 size inside a 787x335 container area.\n-->\n<GUI w=\"787\" h=\"335\" >\n <StaticImage x=\"0\" y=\"0\" w=\"775\" h=\"330\" image=\"Infotab.png\"/>\n</GUI>\n1st instrument set, GUI/01-Kitchen-X.xml:
<!--\n Like above, but having also the GUI controls for CCs and the like over\n a transparent (?) background image.\n-->\n<GUI w=\"775\" h=\"335\">\n <StaticImage x=\"0\" y=\"0\" w=\"775\" h=\"330\" image=\"Control.png\" transparent=\"1\"/>\n\n <!-- Other GUI widgets follows here (Sliders) -->\n</GUI>\nThe GUI node accepts the following parameters:
Name Type Description / Values generic_h / generic_w int TODO generic_s int TODO w / h int size DrawingBoundaries int TODO color_back RGBA background color color_border RGBA border color color_DrawingBoundaries RGBA TODO color_text RGBA text color font_size enum verysmall / small / normal / big / verybig idleThrottle int TODO image string background image filename"},{"location":"widgets/","title":"Widgets","text":""},{"location":"widgets/#commandbutton","title":"CommandButton","text":"A button to run some command like open some webpage URL
Name Type Description / Value(s) x / y / w / h int coordinates and size command string a command, see table below data0 string command parameter e.g.: \"http://www.someplace.com/\" image string the name of the image file (2 vertical frames button) inverted int 1 or not set (0?): inverted on off image frames Command name Description / Value(s) edit launch_url value in `data0`` license orlicense_NNNN"},{"location":"widgets/#guicontainer","title":"GUIContainer","text":"An abstract class / layout to contain GUI pages, used in TabView Panes
Name Type Description / Value(s) eslot int TODO param int numeric or macro defined id e.g.: 10 or ID_SOMETHING param_offset int TODO path string xml filename of the contained GUI or define macro *ID slot int TODO xoffset int TODO: might be border / margin / padding value yoffset int TODO: might be border / margin / padding value"},{"location":"widgets/#keyboard","title":"Keyboard","text":"Name Type Description / Value(s) x / y / w / h int coordinates and size offsetN int with N = 0 to 5, 6 in total TODO param int numeric or macro defined id e.g.: 10 or ID_SOMETHING start_key int first note key, e.g.: 0 end_key int last note key, e.g.: 108 image string filename for the enabled white keys when pressed and unpressed image2 string filename for the enabled black keys when pressed and unpressed image3 string TODO image4 string TODO"},{"location":"widgets/#knob","title":"Knob","text":"Name Type Description / Value(s) x / y int coordinates eslot int TODO frames int number of image frames image string the name of the image file (vertical frame images) inverse int 1 or not set (0?): inverted on off image frames param int numeric or macro defined id e.g.: 10 or ID_SOMETHING vdefault int TODO"},{"location":"widgets/#label","title":"Label","text":"A text label to display some value set from another control, associated with the same param.
Vertical, 2 image frames button.
Name Type Description / Value(s) x / y / w / h int coordinates and size image string the name of the image file inverse int 1 or not set (0?): inverted on off image frames param int numeric or macro defined id e.g.: 10 or ID_SOMETHING"},{"location":"widgets/#numerictextbox","title":"NumericTextBox","text":"Name Type Description / Value(s) x / y / w / h int coordinates and size alignment enum left / center / right, the text alignment inside the rect color_text RGBA text color factor int TODO format string printf format string / FORMAT_LINEAR2DB / FORMAT_STEREOPAN offset int TODO param int numeric or macro defined id e.g.: 10 or ID_SOMETHING transparent int 1 or 0"},{"location":"widgets/#optionmenu","title":"OptionMenu","text":"A LMB / RMB clickable label area to display a menu
Name Type Description / Value(s) x / y / w / h int coordinates and size alignment enum left / center / right, the text alignment inside the rect color_text RGBA e.g.: \"#D7DAE0FF\" font_size enum verysmall / small / normal / big / verybig param int numeric or macro defined id e.g.: 10 or ID_SOMETHING transparent int 1 or 0 vdefault int TODO"},{"location":"widgets/#optionitem","title":"OptionItem","text":"OptionMenu item
Name Type Description / Value(s) name string the menuitem label value float the value associated e.g.: 0.5678"},{"location":"widgets/#prefixnamemenu","title":"<PrefixName>Menu","text":"A combobox controlled by a spinner. The control name prefix is custom, e.g. \"FileMenu\", \"KSMenu\", \"OutputMenu\", \"Preset\"
Name Type Description / Value(s) x / y / w / h int coordinates and size alignment enum left / center / right, the text alignment inside the rect color_text RGBA text color entry_empty TODO: might be int like transparent entry_import TODO: might be int like transparent entry_reload TODO: might be int like transparent entry_saveasdefault int TODO: might be int like transparent eslot int TODO font_size enum verysmall / small / normal / big / verybig image_next string arrow image filename image_previous string arrow image filename image_vertical_align TODO: might be int like transparent param int numeric or macro defined id e.g.: 10 or ID_SOMETHING target URL TODO: some effect URL, e.g.: \"com.Vendor.Effectname\" transparent int 1 or 0 type URL TODO: same as target"},{"location":"widgets/#popupoverlay","title":"PopupOverlay","text":"Overlay widget, might be the one displayed when registering an instrument
Name Type Description / Value(s) x / y / w / h int coordinates and size color_back RGBA background color (e.g.: #00000060)"},{"location":"widgets/#progressbar","title":"ProgressBar","text":"Name Type Description / Value(s) x / y / w / h int coordinates and size image string image filename for a 2 frames progress bar TODO: empty and full? Verify this"},{"location":"widgets/#rect","title":"Rect","text":"A drawn rectangle
Name Type Description / Value(s) x / y / w / h int coordinates and size drawMode enum filled TODO fill_color RGBA fill color frameWidth int TODO"},{"location":"widgets/#slider","title":"Slider","text":"Name Type Description / Value(s) x / y / w / h int coordinates and size param int numeric or macro defined id e.g.: 10 or ID_SOMETHING image_handle string the name of the image file (slider handle) image_bg string the name of the image file (slider trail) orientation enum horizontal / vertical"},{"location":"widgets/#specialdigitknob","title":"SpecialDigitKnob","text":"A clickable label that changes its value when keeping pressed the LMB and moving the mouse left or right
Name Type Description / Value(s) x / y / w / h int coordinates and size alignment enum left / center / right, the text alignment inside the rect base int TODO digit_max int maximum value, e.g.\"100\" TODO: what's the difference with vmax? digit_min int minimum value, e.g.\"-100\" TODO: what's the difference with vmin? image string the name of the image used for the numeric values minus_image string the name of the image used to add a minus for negative values plus_image string the name of the image used to add a plus for positive values nbh int the number image height nbw int the number image width granularity int TODO numbers int value size, e.g. 2 for 0-99 or 3 for 0-100 param int numeric or macro defined id e.g.: 10 or ID_SOMETHING show_leading_zeros int TODO, might be int like transparent vmax int maximum value, e.g.\"100\" vmin int minimum value, e.g.\"-100\""},{"location":"widgets/#splash","title":"Splash","text":"TODO: might be a splashscreen window
Name Type Description / Value(s) x / y / w / h int coordinates and size image string the filename of the background image url string URL TODO: probably open in browser on image click"},{"location":"widgets/#staticimage","title":"StaticImage","text":"Name Type Description / Value(s) x / y / w / h int coordinates and size image string the name of the image file transparent int 1 or 0"},{"location":"widgets/#statictext","title":"StaticText","text":"Non variable Label like control
Name Type Description / Value(s) x / y / w / h int coordinates and size alignment enum left / center / right, the text alignment inside the rect color_back RGBA background color color_border RGBA border color color_text RGBA text color font_size enum verysmall / small / normal / big / verybig text string label displayed text transparent int 1 or 0"},{"location":"widgets/#stepeditor","title":"StepEditor","text":"Name Type Description / Value(s) x / y / w / h int coordinates and size border_color RGBA image string the name of the image file editor_border_color RGBA fill_color RGBA zero_color RGBA hoffset int TODO: might be border / margin / padding value voffset int TODO: might be border / margin / padding value nbstep int TODO param int numeric or macro defined id e.g.: 10 or ID_SOMETHING step_increment int step increment target URL TODO: some effect URL, e.g.: \"com.Vendor.Effectname\" transparent int 1 or 0 vmax int maximum value, e.g.\"15\" vmin int minimum value, e.g.\"0\""},{"location":"widgets/#tabview","title":"TabView","text":"Tabbed control, with Panes as pages.
Name Type Description / Value(s) x / y / w / h int coordinates and size id string the control id color_selected RGBA TODO color_deselected RGBA TODO image string image filename of the button background (2 frames: clicked and released) position enum top / bottom TODO: other values? alignment enum left / center / right, tab button positions"},{"location":"widgets/#pane","title":"Pane","text":"TabView' page pane.
Name Type Description / Value(s) image image filename of the pane background, optional imageb image filename of the button background (2 frames: clicked and released)"}]} \ No newline at end of file diff --git a/sitemap.xml b/sitemap.xml index 2b12fb7..2ac7762 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -2,37 +2,37 @@