View Single Post
Old 12-08-2018, 04:29 AM   #1
Human being with feelings
mespotine's Avatar
Join Date: May 2017
Location: Leipzig, Germany
Posts: 1,324
Default Ultraschall-API - 977 Functions for Lua(beta 2.76 - 20Jul2019) - "ParmLearn/Localize"

After over 1 and a half years of coding, I'm proud to announce the public-beta-release of the

Ultraschall-API 4.00 beta 2.76 - a 977 Lua-functions-library for Reaper

which can be found at or installed via ReaPack, using

This API is intended to make programming Reaper much more easier, trying to give you access to many hard-to-code corners of Reaper, improving programming workflows, that are inconvenient to work with using Reaper's own API, making debugging of scripts much easier and much more.
This API was to be used within Ultraschall only, but quickly evolved into a huge 900+ function-library, that many 3rd-party programmers and scripters may find use in, with many useful features, like:
  • ReaPack-installable, add it to your ReaPack-installation and you can install it easily
  • Rendering - you can render your projects without having to use the render-dialog. You can customize the rendering-workflow in every way you want. Just create a renderstring and pass it over to RenderProject_RenderCFG or RenderProjectRegions_RenderCFG
  • Navigation, Follow and Arrangeview-Manipulation - get/set cursors, zoom, autoscroll-management, scroll, etc
  • ArrangeView-Snapshots - you can save, retrieve snapshots of the arrangeview, including position, zoomstates to quickly jump through parts of your project
  • Trackstates - you can access and set all(!) track-states available
  • ProjectStates - you can access all and set many project-states available
  • Mediaitem-states - you can access and set many mediaitem-states (more will follow)
  • ItemExtStates/TrackExtStates - you can save additional metadata easily for specific tracks and items using ItemExtStates and TrackExtStates
  • File access - many helperfunctions for reading, writing, copying files. No more hassle writing it yourself! e.g ReadFullFile, WriteValueToFile, etc
  • Cough-Mute-management - you can write your own cough-buttons, that set the state of the mute-envelope of a track easily
  • Marker - extensive set of marker functions, get, set, export, import, enumerate, etc
  • Spectrogram - you can program the spectrogram-view
  • Routing - you can set Sends/Receives and HWOuts more straightforward than with Reaper's own Routing-functions. Includes mastertrack as well.
  • Get MediaItems - you can get all media-items within a time-range AND within the tracks you prefer; a 2D-approach e.g. GetAllMediaItemsBetween and GetMediaItemsAtPosition, etc
  • Gaps between items - you can get the gaps between items in a track, using GetGapsBetweenItems
  • Edit item(s) - Split, Cut, Copy, Paste, Move, RippleCut, RippleInsert, SectionCut by tracks AND time/start to endposition e.g. RippleCut, RippleInsert, SectionCut, SplitMediaItems_Position, MoveMediaItemsBefore_By, MoveMediaItemsSectionTo and many more
  • Previewing MediaItems and files - you can preview MediaItems and files without having to start playback of a project
  • KB-Ini-Management - manipulate the reaper-kb.ini-file with custom-settings
  • Checking for Datatypes - check all datatypes introduced with Ultraschall-API and all Lua/Reaper-datatypes
  • UndoManagement - functions for easily making undoing of functions as well as preventing creating an undo-point
  • RunCommand for Items/Tracks - apply actions to specific items/tracks
  • Checking for changed projecttabs - check, if projecttabs have been added/removed
  • ExtState-Management - an extensive set of functions for working with extstates as well as ini-files
  • Data Manipulation - manipulate a lot of your data, including bitwise-integers, tables, etc
  • Clipboard-Management - get items from clipboard, put them to clipboard, even multiple ones
  • Error Messaging System - all functions create useful error-messages that can be shown using, eg: ShowLastErrorMessage, for easier debugging
  • Custom-Defer-functions, who allow you to control, how often a deferred function shall be executed (every n'th cycle/second)
  • Child-Scripts, who allow starting scripts AND passing parameters/returnvalues/values between two scripts. Even multiple-instances of one script can be started, where communication with each scriptinstance is possible on an individual basis.
    Means: Start Childscript.lua twice, and you can communicate with ChildScript.lua(instance1) and ChildScript.lua(instance2) individually, which is difficult to do otherwise.
  • Custom-Markers and Regions, allow you to create different markertypes of the scheme _custommarker1: text of the marker
    You can add, set, count, enum, delete them like normal markers. All you need to set the custommarker-name (custommarker1 in the above example) and this will be used for the custom-markers/custom-regions of your choice
  • Localization of your scripts - via a translationfile. Now you can let people do translations for you without having to add them into your script by hand.
  • tons of other helper-functions
  • my Reaper-Internals Documentation AND
it's fully documented.
Ultraschall-API - a Lua-functions-library4Reaper:
Reaper Internals - Developerdocs4Reaper:

Last edited by mespotine; Today at 09:36 AM. Reason: Release
mespotine is offline   Reply With Quote