| View: [all] [C/C++] [EEL2] [Lua] [Python] | | Automatically generated by Ultraschall-API 4.2 004 - 2094 functions available (Reaper, SWS and JS) |

Reaper Reascript-Api-Documentation 6.29
"Owl Stretching Time"
The Functions Reference
^ 1 Introduction to ReaScript
ReaScript API as of Reaper 6.29
REAPER provides an API (advanced programming interface) for users and third parties to create extended functionality. API functions can be called from a compiled C/C++ dynamic library that is loaded by REAPER, or at run-time by user-created ReaScripts that can be written using REAPER's own editor.
ReaScripts can be written in EEL2, a specialized language that is also used to write JSFX; Lua, a popular scripting language; or Python, another scripting language. EEL and Lua are embedded within REAPER and require no additional downloads or settings. Python must be downloaded and installed separately, and enabled in REAPER preferences.
A script named "__startup.lua|.eel" will be started automatically by Reaper at startup. You can have both; Reaper will run __startup.eel first, __startup.lua second.
This __startup-script doesn't need to be registered into the actionlist of Reaper; it's pure existence in the scripts-folder of the resources-folder of Reaper is sufficient for it to be run.
Learn more about ReaScript: http://www.cockos.com/reaper/sdk/reascript/reascript.php.
This documentation includes the functions provided by SWS: sws-extension.org as well as Julian Sader's plugin, that can be installed via ReaPack.
The IDE in Reaper has some limitations, as every line must not exceed 4095 characters, or they will be split when the script is loaded the next time.
The base-directory for files created from ReaScript can be read from the reaper.ini -> [REAPER)] -> lastcwd=
That means, if you create a new file without giving it a path, it will be created in the path set in lastcwd.
Note: a lot of the functions in this document require 3rd-party-extensions. You can find and install them from here:
SWS: https://www.sws-extension.org
JS-extension: https://forum.cockos.com/showthread.php?t=212174
ReaPack: https://reapack.com/
ReaImGui: https://forum.cockos.com/showthread.php?t=250419
Osara: https://osara.reaperaccessibility.com/
ReaBlink: https://github.com/ak5k/reablink/releases/
^ 2.1 CPP Api-Description
Usage of the Reaper Api in C++
Note: the C++ pure virtual interfaces used require the MSVC-compatible C++ ABI on Win32. Sorry, mingw users.
Reaper extensions: see
http://www.cockos.com/reaper/sdk/plugin/plugin.php and reaper_plugin.h.
The API functions in this header can be retrieved using reaper_plugin_info_t.GetFunc() or by using the Action "[developer] Write C++ API functions header" directly in Reaper.
VST plugins: see
http://www.cockos.com/reaper/sdk/vst/vst_ext.php The API functions in this header can be retrieved using audioMasterCallback.
Because the API is dynamic, callers should never assume a function exists.
Check that a non-NULL function pointer was returned before using it (unless
loaded functions are verified using REAPERAPI_LoadAPI(), see note below).
New (4.76+) usage of this file:
- 1) most source files should just #include "reaper_plugin_functions.h" as is.
- 2) one file should #define REAPERAPI_IMPLEMENT before including this file.
- 3) the plug-in should call REAPERAPI_LoadAPI(rec->GetFunc) from REAPER_PLUGIN_ENTRYPOINT
- and check the return value for errors (REAPERAPI_LoadAPI will return 0 on success).
By default, all functions listed in this file are loaded. This means that an older version
of REAPER may not succeed in loading, and also it may bloat your plug-in. If you wish to only load
needed functions, #define REAPERAPI_MINIMAL and various #define REAPERAPI_WANT_<functionname> lines
before including this file. You must put these definitions where REAPERAPI_IMPLEMENT is defined
and you can optionally put them elsewhere (to detect needed REAPERAPI_WANT_xxx lines at compile-
time rather than link-time).
^ 2.2 EEL Api-Description
ReaScript/EEL API
For information on the EEL2 language, please see the
EEL2 User Guide ReaScript/EEL scripts can call API functions using functionname().
Parameters that return information are effectively passed by reference, not value. If an API returns a string value, it will usually be as the first parameter.
Examples:
// function returning a single (scalar) value:
sec =
parse_timestr("1:12");
// function returning information in the first parameter (function returns void):
GetProjectPath(#string);
// lower volume of track 3 by half:
tr =
GetTrack(0, 2);
GetTrackUIVolPan(tr, vol, pan);
SetMediaTrackInfo_Value(tr, "D_VOL", vol*0.5);
ReaScript/EEL can import functions from other reascripts using @import filename.eel -- note that only the file's functions will be imported, normal code in that file will not be executed.
^ 2.3 Python Api-Description
ReaScript/Python API
ReaScript/Python requires a recent version of Python installed on this machine. Python is available from multiple sources
as a free download. After installing Python, REAPER may detect the Python dynamic library automatically. If not, you can enter the path in the ReaScript preferences page, at Options/Preferences/Plug-Ins/ReaScript.
ReaScript/Python scripts can call API functions using RPR_functionname().
All parameters are passed by value, not reference. API functions that cannot return information in the parameter list will return a single value. API functions that can return any information in the parameter list will return a list of values; The first value in the list will be the function return value (unless the function is declared to return void).
Examples:
# function returning a single (scalar) value:
sec =
RPR_parse_timestr("1:12") # function returning information in the first parameter (function returns void):
(str) =
RPR_GetProjectPath("", 512) # lower volume of track 3 by half (RPR_GetTrackUIVolPan returns Bool):
tr =
RPR_GetTrack(0, 2) (ok, tr, vol, pan) =
RPR_GetTrackUIVolPan(tr, 0, 0) # this also works, if you only care about one of the returned values:
vol =
RPR_GetTrackUIVolPan(tr, 0, 0)[2] RPR_SetMediaTrackInfo_Value(tr, "D_VOL", vol*0.5) You can create and save modules of useful functions that you can import into other ReaScripts. For example, if you create a file called reascript_utility.py that contains the function helpful_function(), you can import that file into any Python ReaScript with the line:
import reascript_utility
and call the function by using:
reascript_utility.helpful_function()
Note that ReaScripts must explicitly import the REAPER python module, even if the script is imported into another ReaScript:
from reaper_python import *
^ 2.4 Lua Api-Description
ReaScript/Lua API
ReaScript/Lua scripts can call API functions using reaper.functionname().
Some functions return multiple values. In many cases, some function parameters are ignored, especially when similarly named parameters are present in the returned values.
Examples:
-- function returning a single (scalar) value:
sec = reaper.
parse_timestr("1:12") -- function with an ignored (dummy) parameter:
path = reaper.
GetProjectPath("") -- lower volume of track 3 by half:
tr = reaper.
GetTrack(0, 2) ok, vol, pan = reaper.
GetTrackUIVolPan(tr, 0, 0) reaper.
SetMediaTrackInfo_Value(tr, "D_VOL", vol*0.5) ReaScript/Lua can import functions from other ReaScripts using require. If the files are not being found, it is probably a path problem (remember that lua paths are wildcard patterns, not just directory listings, see details
here).
^ 3 Datatypes used in this document
Datatypes used in this document
boolean - accepts only true or false as values
optional boolean - a boolean, that can be given, but is not required
number - can be integer, double or a floating-point-number
optional number - a number, that can be given, but is not required
integer - only integer numbers allowed
reaper.array - a special array, that Reaper provides
string - a string of characters/text
optional string - a string, that can be given, but is not required
AudioAccessor - Audio Accessor object for a track or a media-item
BR_Envelope (BR) - an envelope-object, created from a track or take-envelope
HWND - a window
IReaperControlSurface - a ControlSurface, e.g. OSC-devices
joystick_device - a joystick-device
KbdSectionInfo - Keyboard Section Info,
- 0, Main
- 100, Main (alt recording)
- 32060, MIDI Editor
- 32061, MIDI Event List Editor
- 32062, MIDI Inline Editor
- 32063, Media Explorer
PCM_source - the audiosource of a MediaItem
ReaProject - a project within Reaper; 0 for current open project(-tab); in
EnumProjects, it is an object, not a number!
RprMidiTake (FNG) - ReaperMidiTake as object
RprMidiNote (FNG) - RprMidiNote as object
MediaTrack - a Reaper-Track as object
MediaItem - a Reaper-MediaItem like audio,video, Midi, etc as object
MediaItem_Take - a take within a MediaItem as object
TrackEnvelope - an envelope of a track as object
WDL_FastString(S&M) - a different kind of a string, made into a Reaper-object
deviceHDC - get it using function
JS_GDI_GetWindowDC
^
AddMediaItemToTrackFunctioncall:
C: MediaItem* item AddMediaItemToTrack(MediaTrack* tr)
EEL2: MediaItem item AddMediaItemToTrack(MediaTrack tr)
Lua: MediaItem item = reaper.AddMediaItemToTrack(MediaTrack tr)
Python: MediaItem item RPR_AddMediaItemToTrack(MediaTrack tr)
Description:Creates a new media item. It will be empty and therefore not be shown in the arrange-view, until you associate a mediafile(audio, picture, video, etc) or a length and position to it using
SetMediaItemInfo_Value
| Parameters: |
| MediaTrack tr | - | tracknumber(zero based), with 0 for track 1, 1 for track 2, etc.
|
| Returnvalues: |
| MediaItem item | - | the newly created MediaItem-object
|
^
AddProjectMarkerFunctioncall:
C: int AddProjectMarker(ReaProject* proj, bool isrgn, double pos, double rgnend, const char* name, int wantidx)
EEL2: int AddProjectMarker(ReaProject proj, bool isrgn, pos, rgnend, "name", int wantidx)
Lua: integer = reaper.AddProjectMarker(ReaProject proj, boolean isrgn, number pos, number rgnend, string name, integer wantidx)
Python: Int RPR_AddProjectMarker(ReaProject proj, Boolean isrgn, Float pos, Float rgnend, String name, Int wantidx)
Description:Creates a new Projectmarker/Region.
Returns the index of the created marker/region, or -1 on failure. Supply wantidx>=0 if you want a particular index number, but you'll get a different index number a region and wantidx is already in use.
| Parameters: |
| ReaProject proj | - | the project, in which to add the new marker; use 0 for the current project; can also be a ReaProject-object, as returned by EnumProjects
|
| boolean isrgn | - | true, if it shall be a region; false, if a normal marker
|
| number pos | - | the position of the newly created marker/region in seconds
|
| number rgnend | - | if the marker is a region, this is the end of the region in seconds
|
| string name | - | the shown name of the marker
|
| integer wantidx | - | the shown number of the marker/region. Markers can have the same shown marker multiple times. Regions will get another number, if wantidx is already given.
|
| Returnvalues: |
| integer | - | the shown-number of the newly created marker/region
|
^
AddProjectMarker2Functioncall:
C: int AddProjectMarker2(ReaProject* proj, bool isrgn, double pos, double rgnend, const char* name, int wantidx, int color)
EEL2: int AddProjectMarker2(ReaProject proj, bool isrgn, pos, rgnend, "name", int wantidx, int color)
Lua: integer = reaper.AddProjectMarker2(ReaProject proj, boolean isrgn, number pos, number rgnend, string name, integer wantidx, integer color)
Python: Int RPR_AddProjectMarker2(ReaProject proj, Boolean isrgn, Float pos, Float rgnend, String name, Int wantidx, Int color)
Description:Returns the index of the created marker/region, or -1 on failure. Supply wantidx>=0 if you want a particular index number, but you'll get a different index number a region and wantidx is already in use. color should be 0 (default color), or
ColorToNative(r,g,b)|0x1000000
| Parameters: |
| ReaProject proj | - | the project, in which to add the new marker; use 0 for the current project; can also be a ReaProject-object, as returned by EnumProjects
|
| boolean isrgn | - | true, if it shall be a region; false, if a normal marker
|
| number pos | - | the position of the newly created marker/region in seconds
|
| number rgnend | - | if the marker is a region, this is the end of the region in seconds
|
| string name | - | the shown name of the marker
|
| integer wantidx | - | the shown number of the marker/region. Markers can have the same shown marker multiple times. Regions will get another number, if wantidx is already given.
|
| integer color | - | the color as returned by the function ColorToNative(r,g,b)|0x1000000
|
| Returnvalues: |
| integer | - | the shown-number of the newly created marker/region
|
^
AddRemoveReaScriptFunctioncall:
C: int AddRemoveReaScript(bool add, int sectionID, const char* scriptfn, bool commit)
EEL2: int AddRemoveReaScript(bool add, int sectionID, "scriptfn", bool commit)
Lua: integer = reaper.AddRemoveReaScript(boolean add, integer sectionID, string scriptfn, boolean commit)
Python: Int RPR_AddRemoveReaScript(Boolean add, Int sectionID, String scriptfn, Boolean commit)
Description:Adds a ReaScript (returns the new command ID, or 0 if failed) or removes a ReaScript
Returns >0 on success.
Use commit==true when adding/removing a single script.
When bulk adding/removing multiple scripts, you can optimize the n-1 first calls with commit==false and commit==true for the last call.
The commandID returned, might change, when addng this script into an other Reaper-installation.
To be sure to use the right command-id, use
ReverseNamedCommandLookup() to get the ActionCommandID, which will never change, until you remove the script.
If you want to add a script to several sections, you need to add them individually, by calling the function again with the changed section-number.
| Parameters: |
| boolean add | - | true, if it shall be added, false if it shall be removed
|
| integer sectionID | - | the section, in which this script shall appear(e.g. in the Show Actions-Dialog) 0, Main 100, Main (alt recording) Note: If you already added to main(section 0), this function automatically adds the script to Main(alt) as well. 32060, MIDI Editor 32061, MIDI Event List Editor 32062, MIDI Inline Editor 32063, Media Explorer
|
| string scriptfn | - | the filename of the Reascript to be added
|
| boolean commit | - | true, if it shall be committed, false, if you want to add new scripts first. Committing means, that Reaper stores the Reascript-information into the reaper-kb.ini for permanent use. It will be committed at Reaper's exit as well, but if Reaper crashes before exiting properly, your added script might get lost. When adding many Reascripts to Reaper, setting commit to false might help prevail ressources, as you don't rewrite the reaper-kb.ini file over and over again. However, if you only add a few scripts, this might not be of importance to you.
|
| Returnvalues: |
| integer | - | the command ID for this script.
|
^
AddTakeToMediaItemFunctioncall:
C: MediaItem_Take* AddTakeToMediaItem(MediaItem* item)
EEL2: MediaItem_Take AddTakeToMediaItem(MediaItem item)
Lua: MediaItem_Take = reaper.AddTakeToMediaItem(MediaItem item)
Python: MediaItem_Take RPR_AddTakeToMediaItem(MediaItem item)
Description:creates a new take in an item
| Parameters: |
| MediaItem item | - | a MediaItem-object, in which you want to add the new take |
| Returnvalues: |
| MediaItem_Take | - | the newly created MediaItem_Take-object |
^
AddTempoTimeSigMarkerFunctioncall:
C: bool AddTempoTimeSigMarker(ReaProject* proj, double timepos, double bpm, int timesig_num, int timesig_denom, bool lineartempochange)
EEL2: bool AddTempoTimeSigMarker(ReaProject proj, timepos, bpm, int timesig_num, int timesig_denom, bool lineartempochange)
Lua: boolean = reaper.AddTempoTimeSigMarker(ReaProject proj, number timepos, number bpm, integer timesig_num, integer timesig_denom, boolean lineartempochange)
Python: Boolean RPR_AddTempoTimeSigMarker(ReaProject proj, Float timepos, Float bpm, Int timesig_num, Int timesig_denom, Boolean lineartempochange)
Description:
| Parameters: |
| ReaProject proj | - | the project in which to add the TempoTimesigMarker, 0 for the current project; can also be a ReaProject-object, as returned by EnumProjects
|
| number timepos | - | the position in seconds
|
| number bpm | - | the speed in bpm
|
| integer timesig_num | - | timesignature number : timesig_num/timesig_denom, e.g. 3/4
|
| integer timesig_denom | - | timesignature denominator : timesig_num/timesig_denom, e.g. 3/4
|
| boolean lineartempochange | - | true, linear tempo change, false not
|
| Returnvalues: |
| boolean | - | true, if adding was successful; false, if not
|
^
adjustZoomFunctioncall:
C: void adjustZoom(double amt, int forceset, bool doupd, int centermode)
EEL2: adjustZoom(amt, int forceset, bool doupd, int centermode)
Lua: reaper.adjustZoom(number amt, integer forceset, boolean doupd, integer centermode)
Python: RPR_adjustZoom(Float amt, Int forceset, Boolean doupd, Int centermode)
Description:Sets horizontal zoom in track view.
| Parameters: |
| number amt | - | the zoom factor, positive values=zoom in, negative values=zoom out, 0=no zoom |
| integer forceset | - | forces one amt-zoomfactor(non zero) or allows repeatable zoom-in/zoomout(0) |
| boolean doupd | - | true, updates the track-view instantly; false, or only when mouse hovers over trackview |
| integer centermode | - | decides, what shall be in the center of the view. The following are available: -1, default selection, as set in the reaper-prefs, 0, edit-cursor or playcursor(if it's in the current zoomfactor of the view during playback/recording) in center, 1, keeps edit-cursor in center of zoom 2, keeps center of view in the center during zoom 3, keeps in center of zoom, what is beneath the mousecursor |
^
AnyTrackSoloFunctioncall:
C: bool AnyTrackSolo(ReaProject* proj)
EEL2: bool AnyTrackSolo(ReaProject proj)
Lua: boolean = reaper.AnyTrackSolo(ReaProject proj)
Python: Boolean RPR_AnyTrackSolo(ReaProject proj)
Description:returns, whether any of the tracks is solo in Project proj
| Parameters: |
| ReaProject proj | - | the project to be checked for. 0 for current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| Returnvalues: |
| boolean | - | true if any track is solo; false if not. Covers all solo-states(solo in place, ignore routing, exclusive solo, solo defeat).
|
^
APIExistsFunctioncall:
C: bool APIExists(const char* function_name)
EEL2: bool APIExists(function_name")
Lua: boolean = reaper.APIExists(string function_name)
Python: Boolean RPR_APIExists(String function_name)
Description:Returns true if function_name exists in the REAPER API
| Parameters: |
| string function_name | - | the name of the function you want to check the existence for |
| Returnvalues: |
| boolean | - | true, if function_name exists, false if not |
^
APITestFunctioncall:
C: void APITest()
EEL2: APITest()
Lua: reaper.APITest()
Python: RPR_APITest()
Description:Displays a message window with "Hello World", if the API was successfully called.
^
ApplyNudgeFunctioncall:
C: bool ApplyNudge(ReaProject* project, int nudgeflag, int nudgewhat, int nudgeunits, double value, bool reverse, int copies)
EEL2: bool ApplyNudge(ReaProject project, int nudgeflag, int nudgewhat, int nudgeunits, value, bool reverse, int copies)
Lua: boolean = reaper.ApplyNudge(ReaProject project, integer nudgeflag, integer nudgewhat, integer nudgeunits, number value, boolean reverse, integer copies)
Python: Boolean RPR_ApplyNudge(ReaProject project, Int nudgeflag, Int nudgewhat, Int nudgeunits, Float value, Boolean reverse, Int copies)
Description:Nudges elements like items, cursor, contents, etc to or by a value you want. Nudges only selected mediaitems.
| Parameters: |
| ReaProject project | - | the project, in which to nudge; 0 for the current project |
| integer nudgeflag | - | the way to nudge &1, set to value(otherwise nudge by values) &2, snap |
| integer nudgewhat | - | what to nudge 0, position 1, left trim 2, left edge 3, right edge 4, contents 5, duplicate 6, editcursor |
| integer nudgeunits | - | the unit, in which to nudge 0, ms 1, seconds 2, grid 3, 256th notes ... 15, whole notes 16, measures.beats (1.15 = 1 measure + 1.5 beats) 17, samples 18, frames 19, pixels 20, item lengths 21, item selections |
| number value | - | amount to nudge by, or value to set to(depending on the settings in nudgeflag and the unit in nudgeunits) |
| boolean reverse | - | in nudge mode: true nudges left; right doesn't nudge to left |
| integer copies | - | in nudge duplicate mode, number of copies (otherwise ignored) |
| Returnvalues: |
| boolean | - | true, if it worked; false, if it didn't |
^
Audio_InitFunctioncall:
C: void Audio_Init()
EEL2: Audio_Init()
Lua: reaper.Audio_Init()
Python: RPR_Audio_Init()
Description:open all audio and MIDI devices, if not open
So if the audio-device(s) are closed, you can use this to try to (re)-activate them.
^
Audio_IsPreBufferFunctioncall:
C: int Audio_IsPreBuffer()
EEL2: int Audio_IsPreBuffer()
Lua: integer = reaper.Audio_IsPreBuffer()
Python: Int RPR_Audio_IsPreBuffer()
Description:is in pre-buffer? threadsafe
^
Audio_IsRunningFunctioncall:
C: int Audio_IsRunning()
EEL2: int Audio_IsRunning()
Lua: integer = reaper.Audio_IsRunning()
Python: Int RPR_Audio_IsRunning()
Description:is audio running at all? threadsafe
It is an indicator, if the current audio-device is closed(0) or not(1).
| Returnvalues: |
| integer | - | 0, audio is not running; 1, audio is running |
^
Audio_QuitFunctioncall:
C: void Audio_Quit()
EEL2: Audio_Quit()
Lua: reaper.Audio_Quit()
Python: RPR_Audio_Quit()
Description:close all audio and MIDI devices, if open
This sets all audio-devices to closed.
^
AudioAccessorStateChangedFunctioncall:
C: bool AudioAccessorStateChanged(AudioAccessor* accessor)
EEL2: bool AudioAccessorStateChanged(AudioAccessor accessor)
Lua: boolean = reaper.AudioAccessorStateChanged(AudioAccessor accessor)
Python: Boolean RPR_AudioAccessorStateChanged(AudioAccessor accessor)
Description:
| Parameters: |
| AudioAccessor accessor | - |
|
^
AudioAccessorUpdateFunctioncall:
C: void AudioAccessorUpdate(AudioAccessor* accessor)
EEL2: AudioAccessorUpdate(AudioAccessor accessor)
Lua: reaper.AudioAccessorUpdate(AudioAccessor accessor)
Python: RPR_AudioAccessorUpdate(AudioAccessor accessor)
Description:
| Parameters: |
| AudioAccessor accessor | - |
|
^
AudioAccessorValidateStateFunctioncall:
C: bool AudioAccessorValidateState(AudioAccessor* accessor)
EEL2: bool AudioAccessorValidateState(AudioAccessor accessor)
Lua: boolean = reaper.AudioAccessorValidateState(AudioAccessor accessor)
Python: Boolean RPR_AudioAccessorValidateState(AudioAccessor accessor)
Description:Validates the current state of the audio accessor -- must ONLY call this from the main thread. Returns true if the state changed.
| Parameters: |
| AudioAccessor accessor | - | the AudioAccessor for a MediaTrack or a MediaItem_Take |
| Returnvalues: |
| boolean | - | true, if state has changed; false, if state hasn't changed |
^
BypassFxAllTracksFunctioncall:
C: void BypassFxAllTracks(int bypass)
EEL2: BypassFxAllTracks(int bypass)
Lua: reaper.BypassFxAllTracks(integer bypass)
Python: RPR_BypassFxAllTracks(Int bypass)
Description:Does bypassing of the fx of all tracks.
| Parameters: |
| integer bypass | - | -1, bypass all if not all bypassed,otherwise unbypass all |
^
ClearAllRecArmedFunctioncall:
C: void ClearAllRecArmed()
EEL2: ClearAllRecArmed()
Lua: reaper.ClearAllRecArmed()
Python: RPR_ClearAllRecArmed()
Description:Clears all armed states of all tracks.
^
ClearConsoleFunctioncall:
C: void ClearConsole()
EEL2: ClearConsole()
Lua: reaper.ClearConsole()
Python: RPR_ClearConsole()
Description:
^
ClearPeakCacheFunctioncall:
C: void ClearPeakCache()
EEL2: ClearPeakCache()
Lua: reaper.ClearPeakCache()
Python: RPR_ClearPeakCache()
Description:resets the global peak caches
^
ColorFromNativeFunctioncall:
C: void ColorFromNative(int col, int* rOut, int* gOut, int* bOut)
EEL2: ColorFromNative(int col, int &r, int &g, int &b)
Lua: integer r, integer g, integer b = reaper.ColorFromNative(integer col)
Python: (Int col, Int rOut, Int gOut, Int bOut) = RPR_ColorFromNative(col, rOut, gOut, bOut)
Description:
| Parameters: |
| integer col | - | the colorvalue to convert from
|
| Returnvalues: |
| integer r | - | the value for red, from 0 to 255
|
| integer g | - | the value for green, from 0 to 255
|
| integer b | - | the value for blue, from 0 to 255
|
^
ColorToNativeFunctioncall:
C: int ColorToNative(int r, int g, int b)
EEL2: int ColorToNative(int r, int g, int b)
Lua: integer = reaper.ColorToNative(integer r, integer g, integer b)
Python: Int RPR_ColorToNative(Int r, Int g, Int b)
Description:Make an OS dependent color from RGB values (e.g. RGB() macro on Windows). r,g and b are in [0..255]. See
ColorFromNative As Reaper treats colors differently on Mac and Windows, you should always use
ColorFromNative and
ColorToNative.
When using the returned colorvalue, you need to add |0x1000000 at the end of it, like ColorToNative(20,30,40)|0x1000000.
| Parameters: |
| integer r | - | the value for red, from 0 to 255
|
| integer g | - | the value for green, from 0 to 255
|
| integer b | - | the value for blue, from 0 to 255
|
| Returnvalues: |
| integer col | - | the correct colorvalue, fitting to your system.
|
^
CountAutomationItemsFunctioncall:
C: int CountAutomationItems(TrackEnvelope* env)
EEL2: int CountAutomationItems(TrackEnvelope env)
Lua: integer = reaper.CountAutomationItems(TrackEnvelope env)
Python: Int RPR_CountAutomationItems(TrackEnvelope env)
Description:
| Parameters: |
| TrackEnvelope env | - | the envelope-object for the envelope-lane
|
| Returnvalues: |
| integer | - | number of automation items
|
^
CountEnvelopePointsFunctioncall:
C: int CountEnvelopePoints(TrackEnvelope* envelope)
EEL2: int CountEnvelopePoints(TrackEnvelope envelope)
Lua: integer = reaper.CountEnvelopePoints(TrackEnvelope envelope)
Python: Int RPR_CountEnvelopePoints(TrackEnvelope envelope)
Description:
| Parameters: |
| TrackEnvelope envelope | - | the TrackEnvelope-object, in which to count for the envelope-points
|
| Returnvalues: |
| integer | - | the number of envelope-points in the envelopeobject envelope
|
^
CountEnvelopePointsExFunctioncall:
C: int CountEnvelopePointsEx(TrackEnvelope* envelope, int autoitem_idx)
EEL2: int CountEnvelopePointsEx(TrackEnvelope envelope, int autoitem_idx)
Lua: integer = reaper.CountEnvelopePointsEx(TrackEnvelope envelope, integer autoitem_idx)
Python: Int RPR_CountEnvelopePointsEx(TrackEnvelope envelope, Int autoitem_idx)
Description:Returns the number of points in the envelope.
autoitem_idx=-1 for the underlying envelope, 0 for the first automation item on the envelope, etc.
For automation items, pass autoitem_idx|0x10000000 to base ptidx on the number of points in one full loop iteration,
even if the automation item is trimmed so that not all points are visible.
Otherwise, ptidx will be based on the number of visible points in the automation item, including all loop iterations.
See
GetEnvelopePointEx,
SetEnvelopePointEx,
InsertEnvelopePointEx,
DeleteEnvelopePointEx.
| Parameters: |
| TrackEnvelope envelope | - | the TrackEnvelope-object, in which to count for the envelope-points
|
| integer autoitem_idx | - | -1, for the underlying envelope, 0, for the first automation item on the envelope, etc.
|
| Returnvalues: |
| integer | - | the number of envelope-points in the envelopeobject envelope
|
^
CountMediaItemsFunctioncall:
C: int CountMediaItems(ReaProject* proj)
EEL2: int CountMediaItems(ReaProject proj)
Lua: integer = reaper.CountMediaItems(ReaProject proj)
Python: Int RPR_CountMediaItems(ReaProject proj)
Description:count the number of items in the project (proj=0 for active project)
| Parameters: |
| ReaProject proj | - | the project, in which to count for the number of items; 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| Returnvalues: |
| integer | - | the number of MediaItems in a project
|
^
CountProjectMarkersFunctioncall:
C: int CountProjectMarkers(ReaProject* proj, int* num_markersOut, int* num_regionsOut)
EEL2: int CountProjectMarkers(ReaProject proj, int &num_markers, int &num_regions)
Lua: integer retval, number num_markers, number num_regions = reaper.CountProjectMarkers(ReaProject proj)
Python: (Int retval, ReaProject proj, Int num_markersOut, Int num_regionsOut) = RPR_CountProjectMarkers(proj, num_markersOut, num_regionsOut)
Description:returns the number of all markers and regions, as well as all markers and all regions in a project.
num_markersOut and num_regionsOut may be NULL.
| Parameters: |
| ReaProject proj | - | the project, in which to count the markers; 0 for current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| Returnvalues: |
| integer retval | - | all markers and regions in the project
|
| integer num_markers | - | the number of markers in the project
|
| integer num_regions | - | the number of regions in the project
|
^
CountSelectedMediaItemsFunctioncall:
C: int CountSelectedMediaItems(ReaProject* proj)
EEL2: int CountSelectedMediaItems(ReaProject proj)
Lua: integer = reaper.CountSelectedMediaItems(ReaProject proj)
Python: Int RPR_CountSelectedMediaItems(ReaProject proj)
Description:count the number of selected items in the project (proj=0 for active project)
| Parameters: |
| ReaProject proj | - | the project, in which to count for the selected mediaitems; 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| Returnvalues: |
| integer | - | the number of selected items in the project
|
^
CountSelectedTracksFunctioncall:
C: int CountSelectedTracks(ReaProject* proj)
EEL2: int CountSelectedTracks(ReaProject proj)
Lua: integer = reaper.CountSelectedTracks(ReaProject proj)
Python: Int RPR_CountSelectedTracks(ReaProject proj)
Description:Count the number of selected tracks in the project.
This function ignores the master track, see
CountSelectedTracks2
| Parameters: |
| ReaProject proj | - | the project in which to count the selected tracks; 0 for current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| Returnvalues: |
| integer | - | the number of selected tracks in the project
|
^
CountSelectedTracks2Functioncall:
C: int CountSelectedTracks2(ReaProject* proj, bool wantmaster)
EEL2: int CountSelectedTracks2(ReaProject proj, bool wantmaster)
Lua: integer = reaper.CountSelectedTracks2(ReaProject proj, boolean wantmaster)
Python: Int RPR_CountSelectedTracks2(ReaProject proj, Boolean wantmaster)
Description:Count the number of selected tracks in the project.
if you set wantmaster to true, it will include the master track as well.
| Parameters: |
| ReaProject proj | - | the number of the project in which to count the selected tracks; 0 for current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| boolean wantmaster | - | true, if you want to count the master-track as well; false, if you don't want to count it
|
| Returnvalues: |
| integer | - | the number of selected tracks in your project
|
^
CountTakeEnvelopesFunctioncall:
C: int CountTakeEnvelopes(MediaItem_Take* take)
EEL2: int CountTakeEnvelopes(MediaItem_Take take)
Lua: integer = reaper.CountTakeEnvelopes(MediaItem_Take take)
Python: Int RPR_CountTakeEnvelopes(MediaItem_Take take)
Description:
| Parameters: |
| MediaItem_Take take | - | the mediaitem-object for a certain take
|
| Returnvalues: |
| integer | - | number of envelopes of this take of a mediaitem
|
^
CountTakesFunctioncall:
C: int CountTakes(MediaItem* item)
EEL2: int CountTakes(MediaItem item)
Lua: integer = reaper.CountTakes(MediaItem item)
Python: Int RPR_CountTakes(MediaItem item)
Description:count the number of takes in the item
| Parameters: |
| MediaItem item | - | the mediaitem to count the takes of |
| Returnvalues: |
| integer | - | the number of takes in a mediaitem |
^
CountTCPFXParmsFunctioncall:
C: int CountTCPFXParms(ReaProject* project, MediaTrack* track)
EEL2: int CountTCPFXParms(ReaProject project, MediaTrack track)
Lua: integer = reaper.CountTCPFXParms(ReaProject project, MediaTrack track)
Python: Int RPR_CountTCPFXParms(ReaProject project, MediaTrack track)
Description:Count the number of FX parameter knobs displayed on the track control panel.
| Parameters: |
| ReaProject project | - | the project, in which to count the knobs |
| MediaTrack track | - | the track of which to count the knobs |
| Returnvalues: |
| integer | - | the number of FX-parameter-knobs |
^
CountTempoTimeSigMarkersFunctioncall:
C: int CountTempoTimeSigMarkers(ReaProject* proj)
EEL2: int CountTempoTimeSigMarkers(ReaProject proj)
Lua: integer = reaper.CountTempoTimeSigMarkers(ReaProject proj)
Python: Int RPR_CountTempoTimeSigMarkers(ReaProject proj)
Description:
| Parameters: |
| ReaProject proj | - | project number; 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| Returnvalues: |
| integer | - | the number of tempo/time-signature markers in the project.
|
^
CountTrackEnvelopesFunctioncall:
C: int CountTrackEnvelopes(MediaTrack* track)
EEL2: int CountTrackEnvelopes(MediaTrack track)
Lua: integer = reaper.CountTrackEnvelopes(MediaTrack track)
Python: Int RPR_CountTrackEnvelopes(MediaTrack track)
Description:
| Parameters: |
| MediaTrack track | - | the object of the track to count it's envelopes
|
| Returnvalues: |
| integer | - | the number of track-envelopes in a track
|
^
CountTrackMediaItemsFunctioncall:
C: int CountTrackMediaItems(MediaTrack* track)
EEL2: int CountTrackMediaItems(MediaTrack track)
Lua: integer = reaper.CountTrackMediaItems(MediaTrack track)
Python: Int RPR_CountTrackMediaItems(MediaTrack track)
Description:count the number of items in the track
| Parameters: |
| MediaTrack track | - | the MediaTrack to count the items of |
| Returnvalues: |
| integer | - | the number of mediaitems in the track |
^
CountTracksFunctioncall:
C: int CountTracks(ReaProject* projOptional)
EEL2: int CountTracks(ReaProject proj)
Lua: integer = reaper.CountTracks(ReaProject proj)
Python: Int RPR_CountTracks(ReaProject projOptional)
Description:count the number of tracks in the project (proj=0 for active project)
| Parameters: |
| ReaProject proj | - | the project in which to count the tracks; 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| Returnvalues: |
| integer | - | the number of tracks in the project, excluding the master-track.
|
^
CreateNewMIDIItemInProjFunctioncall:
C: MediaItem* CreateNewMIDIItemInProj(MediaTrack* track, double starttime, double endtime, const bool* qnInOptional)
EEL2: MediaItem CreateNewMIDIItemInProj(MediaTrack track, starttime, endtime, optional bool qnIn)
Lua: MediaItem = reaper.CreateNewMIDIItemInProj(MediaTrack track, number starttime, number endtime, optional boolean qnIn)
Python: MediaItem RPR_CreateNewMIDIItemInProj(MediaTrack track, Float starttime, Float endtime, const bool qnInOptional)
Description:Create a new MIDI media item, containing no MIDI events. Time is in seconds unless qn is set.
| Parameters: |
| MediaTrack track | - | the object of the track, in which to create this mediaitem |
| number starttime | - | starttime of the item in seconds, unless qnIn is set to true |
| number endtime | - | endtime of the item in seconds, unless qnIn is set to true |
| boolean qnIn | - | unknown; can be set to true, or false or be omitted |
| Returnvalues: |
| MediaItem | - | the newly created MIDI-mediaitem. |
^
CreateTakeAudioAccessorFunctioncall:
C: AudioAccessor* CreateTakeAudioAccessor(MediaItem_Take* take)
EEL2: AudioAccessor CreateTakeAudioAccessor(MediaItem_Take take)
Lua: AudioAccessor = reaper.CreateTakeAudioAccessor(MediaItem_Take take)
Python: AudioAccessor RPR_CreateTakeAudioAccessor(MediaItem_Take take)
Description:
| Parameters: |
| MediaItem_Take take | - | the take from a MediaItem-object, of which you want to create a new AudioAccessor
|
| Returnvalues: |
| AudioAccessor | - | the newly created AudioAccessor
|
^
CreateTrackAudioAccessorFunctioncall:
C: AudioAccessor* CreateTrackAudioAccessor(MediaTrack* track)
EEL2: AudioAccessor CreateTrackAudioAccessor(MediaTrack track)
Lua: AudioAccessor = reaper.CreateTrackAudioAccessor(MediaTrack track)
Python: AudioAccessor RPR_CreateTrackAudioAccessor(MediaTrack track)
Description:
| Parameters: |
| MediaTrack track | - | the MediaTrack, of which you want to create an AudioAccessor
|
| Returnvalues: |
| AudioAccessor | - | the newly created AudioAccessor for this MediaTrack
|
^
CreateTrackSendFunctioncall:
C: int CreateTrackSend(MediaTrack* tr, MediaTrack* desttrInOptional)
EEL2: int CreateTrackSend(MediaTrack tr, MediaTrack desttrIn)
Lua: integer = reaper.CreateTrackSend(MediaTrack tr, MediaTrack desttrIn)
Python: Int RPR_CreateTrackSend(MediaTrack tr, MediaTrack desttrInOptional)
Description:Create a send/receive (desttrInOptional!=NULL), or a hardware output (desttrInOptional==NULL) with default properties, return >=0 on success (== new send/receive index). See
RemoveTrackSend,
GetSetTrackSendInfo,
GetTrackSendInfo_Value,
SetTrackSendInfo_Value.
For ReaRoute-users: the outputs are hardware outputs, but with 512 added to the destination channel index (512 is the first rearoute channel, 513 the second, etc).
| Parameters: |
| MediaTrack tr | - | the MediaTrack in which to create the send/hwout
|
| MediaTrack desttrIn | - | destination track input; a MediaTrack-object, creates a new send to tr from MediaTrack-object; nil(or no MediaTrack-object), creates a new hardware-output
|
| Returnvalues: |
| integer | - | the id of the new HWOut or Send created. HWOut and Send have their own individual index-numbering.
|
^
CSurf_FlushUndoFunctioncall:
C: void CSurf_FlushUndo(bool force)
EEL2: CSurf_FlushUndo(bool force)
Lua: reaper.CSurf_FlushUndo(boolean force)
Python: RPR_CSurf_FlushUndo(Boolean force)
Description:call this to force flushing of the undo states after using CSurf_On*Change()
| Parameters: |
| boolean force | - | |
^
CSurf_GetTouchStateFunctioncall:
C: bool CSurf_GetTouchState(MediaTrack* trackid, int isPan)
EEL2: bool CSurf_GetTouchState(MediaTrack trackid, int isPan)
Lua: boolean = reaper.CSurf_GetTouchState(MediaTrack trackid, integer isPan)
Python: Boolean RPR_CSurf_GetTouchState(MediaTrack trackid, Int isPan)
Description:
| Parameters: |
| MediaTrack trackid | - | |
| integer isPan | - | |
^
CSurf_GoEndFunctioncall:
C: void CSurf_GoEnd()
EEL2: CSurf_GoEnd()
Lua: reaper.CSurf_GoEnd()
Python: RPR_CSurf_GoEnd()
Description:Moves the cursor to the end of the last item in the project.
^
CSurf_GoStartFunctioncall:
C: void CSurf_GoStart()
EEL2: CSurf_GoStart()
Lua: reaper.CSurf_GoStart()
Python: RPR_CSurf_GoStart()
Description:Moves the cursor to the start of the project.
^
CSurf_NumTracksFunctioncall:
C: int CSurf_NumTracks(bool mcpView)
EEL2: int CSurf_NumTracks(bool mcpView)
Lua: integer = reaper.CSurf_NumTracks(boolean mcpView)
Python: Int RPR_CSurf_NumTracks(Boolean mcpView)
Description:counts the number of tracks, or the number of visible tracks, when mcpView is set to true.
| Parameters: |
| boolean mcpView | - | true, only return the number of tracks visible in MCP; false, count all tracks, incl. invisible |
| Returnvalues: |
| integer | - | number of tracks |
^
CSurf_OnArrowFunctioncall:
C: void CSurf_OnArrow(int whichdir, bool wantzoom)
EEL2: CSurf_OnArrow(int whichdir, bool wantzoom)
Lua: reaper.CSurf_OnArrow(integer whichdir, boolean wantzoom)
Python: RPR_CSurf_OnArrow(Int whichdir, Boolean wantzoom)
Description:Zoom or scroll the Arrangeview vertically.
The stepsize with scrolling is track by track.
| Parameters: |
| integer whichdir | - | into which (zoom-)direction to change 0, move arrangeview upward(one track each step)/zoom in 1, move arrangeview downward(one track each step)/zoom out |
| boolean wantzoom | - | true, adjust vertical zoom; false, adjust vertical scrolling |
^
CSurf_OnFwdFunctioncall:
C: void CSurf_OnFwd(int seekplay)
EEL2: CSurf_OnFwd(int seekplay)
Lua: reaper.CSurf_OnFwd(integer seekplay)
Python: RPR_CSurf_OnFwd(Int seekplay)
Description:Moves editcursor forward, and optionally with seekplay.
| Parameters: |
| integer seekplay | - | how to move the editcursor forward 0, move cursor forward in small steps. Stepsize depends on horizontal zoomfactor. 1, move cursor forward, in half-second steps when stopped; when playing it jumps ahead with playing restarting at editcursor |
^
CSurf_OnFXChangeFunctioncall:
C: bool CSurf_OnFXChange(MediaTrack* trackid, int en)
EEL2: bool CSurf_OnFXChange(MediaTrack trackid, int en)
Lua: boolean = reaper.CSurf_OnFXChange(MediaTrack trackid, integer en)
Python: Boolean RPR_CSurf_OnFXChange(MediaTrack trackid, Int en)
Description:Sets/toggles activation of FX-Chain.
| Parameters: |
| MediaTrack trackid | - | the MediaTrack, whose FX-chain you want to de-/activate |
| integer en | - | activation state of FX-chain -1, toggle FX-chain on/off 0, set FX-chain off 1, set FX-chain on |
| Returnvalues: |
| boolean | - | true, if FX-chain is activated; false, if FX-chain is deactivated |
^
CSurf_OnInputMonitorChangeFunctioncall:
C: int CSurf_OnInputMonitorChange(MediaTrack* trackid, int monitor)
EEL2: int CSurf_OnInputMonitorChange(MediaTrack trackid, int monitor)
Lua: integer = reaper.CSurf_OnInputMonitorChange(MediaTrack trackid, integer monitor)
Python: Int RPR_CSurf_OnInputMonitorChange(MediaTrack trackid, Int monitor)
Description:sets rec-monitoring of a specific track.
| Parameters: |
| MediaTrack trackid | - | the MediaTrack, of which you want to toggle the monitor-button |
| integer monitor | - | monitor-input-state -1, monitor input on(tape auto style) (can be set with negative values, and 2 as well) 0, monitor off (can be set with 3 and higher as well) 1, monitor input on |
| Returnvalues: |
| integer | - | the new input-monitor-state (refer to parameter monitor for description) |
^
CSurf_OnInputMonitorChangeExFunctioncall:
C: int CSurf_OnInputMonitorChangeEx(MediaTrack* trackid, int monitor, bool allowgang)
EEL2: int CSurf_OnInputMonitorChangeEx(MediaTrack trackid, int monitor, bool allowgang)
Lua: integer = reaper.CSurf_OnInputMonitorChangeEx(MediaTrack trackid, integer monitor, boolean allowgang)
Python: Int RPR_CSurf_OnInputMonitorChangeEx(MediaTrack trackid, Int monitor, Boolean allowgang)
Description:Sets monitor-input-state. If MediaTrack is selected, among others, and allowgang is set to true, the new state will be set to them as well.
| Parameters: |
| MediaTrack trackid | - | the MediaTrack, whose monitor-input-state you want to set |
| integer monitor | - | monitor-input-state -1, monitor input on(tape auto style) (can be set with negative values, and 2 as well) 0, monitor off (can be set with 3 and higher as well) 1, monitor input on |
| boolean allowgang | - | true, if trackid is selected with other tracks, set new state to them as well; false, set new state only to trackid |
| Returnvalues: |
| integer | - | the new input-monitor-state (refer to parameter monitor for description) |
^
CSurf_OnMuteChangeFunctioncall:
C: bool CSurf_OnMuteChange(MediaTrack* trackid, int mute)
EEL2: bool CSurf_OnMuteChange(MediaTrack trackid, int mute)
Lua: boolean = reaper.CSurf_OnMuteChange(MediaTrack trackid, integer mute)
Python: Boolean RPR_CSurf_OnMuteChange(MediaTrack trackid, Int mute)
Description:Sets mute state of a MediaTrack.
| Parameters: |
| MediaTrack trackid | - | the MediaTrack to be muted |
| integer mute | - | mute state 0, mute off 1 and higher, mute on negative values toggle mute-state |
| Returnvalues: |
| boolean | - | the new mute-state; true, mute is on; false, mute is off |
^
CSurf_OnMuteChangeExFunctioncall:
C: bool CSurf_OnMuteChangeEx(MediaTrack* trackid, int mute, bool allowgang)
EEL2: bool CSurf_OnMuteChangeEx(MediaTrack trackid, int mute, bool allowgang)
Lua: boolean = reaper.CSurf_OnMuteChangeEx(MediaTrack trackid, integer mute, boolean allowgang)
Python: Boolean RPR_CSurf_OnMuteChangeEx(MediaTrack trackid, Int mute, Boolean allowgang)
Description:Sets/toggles mute-state for a MediaTrack. If MediaTrack is selected, among others, and allowgang is set to true, the new state will be set to them as well.
| Parameters: |
| MediaTrack trackid | - | the MediaTrack to be muted |
| integer mute | - | mute state 0, mute off 1, and higher, mute on negative values toggle mute-state |
| boolean allowgang | - | true, if trackid is selected with other tracks, set new state to them as well; false, set new state only to trackid |
| Returnvalues: |
| boolean | - | the new mute-state; true, mute is on; false, mute is off |
^
CSurf_OnPanChangeFunctioncall:
C: double CSurf_OnPanChange(MediaTrack* trackid, double pan, bool relative)
EEL2: double CSurf_OnPanChange(MediaTrack trackid, pan, bool relative)
Lua: number = reaper.CSurf_OnPanChange(MediaTrack trackid, number pan, boolean relative)
Python: Float RPR_CSurf_OnPanChange(MediaTrack trackid, Float pan, Boolean relative)
Description:Changes the pan-value of a track.
| Parameters: |
| MediaTrack trackid | - | the MediaTrack in which to change the pan |
| number pan | - | -1, full pan left; 1, full pan right; 0, pan centered |
| boolean relative | - | true, add/subtract pan to the currently set pan-value |
| Returnvalues: |
| number | - | the new pan-value |
^
CSurf_OnPanChangeExFunctioncall:
C: double CSurf_OnPanChangeEx(MediaTrack* trackid, double pan, bool relative, bool allowGang)
EEL2: double CSurf_OnPanChangeEx(MediaTrack trackid, pan, bool relative, bool allowGang)
Lua: number = reaper.CSurf_OnPanChangeEx(MediaTrack trackid, number pan, boolean relative, boolean allowGang)
Python: Float RPR_CSurf_OnPanChangeEx(MediaTrack trackid, Float pan, Boolean relative, Boolean allowGang)
Description:Changes the pan-value of a track. If MediaTrack is selected, among others, and allowgang is set to true, the new state will be set to them as well.
| Parameters: |
| MediaTrack trackid | - | the MediaTrack in which to change the pan |
| number pan | - | -1, full pan left; 1, full pan right; 0, pan centered |
| boolean relative | - | true, add/subtract pan to the currently set pan-value |
| boolean allowgang | - | true, if trackid is selected with other tracks, set new state to them as well; false, set new state only to trackid |
| Returnvalues: |
| number | - | the new pan-value |
^
CSurf_OnPauseFunctioncall:
C: void CSurf_OnPause()
EEL2: CSurf_OnPause()
Lua: reaper.CSurf_OnPause()
Python: RPR_CSurf_OnPause()
Description:Toggles between pause and play or when recording has started between pause and rec. Unlike
CSurf_OnPlay() it toggles pause first, then plays.
^
CSurf_OnPlayFunctioncall:
C: void CSurf_OnPlay()
EEL2: CSurf_OnPlay()
Lua: reaper.CSurf_OnPlay()
Python: RPR_CSurf_OnPlay()
Description:Toggles between play and pause or, when recording, rec and pause. Unlike
CSurf_OnPause() it toggles play first, then pauses.
^
CSurf_OnPlayRateChangeFunctioncall:
C: void CSurf_OnPlayRateChange(double playrate)
EEL2: CSurf_OnPlayRateChange(playrate)
Lua: reaper.CSurf_OnPlayRateChange(number playrate)
Python: RPR_CSurf_OnPlayRateChange(Float playrate)
Description:Sets the playbackrate of the current project. Can be between 0.25x to 4x.
| Parameters: |
| number playrate | - | the playbackrate of the current project. 0.25 to 4.00 |
^
CSurf_OnRecArmChangeFunctioncall:
C: bool CSurf_OnRecArmChange(MediaTrack* trackid, int recarm)
EEL2: bool CSurf_OnRecArmChange(MediaTrack trackid, int recarm)
Lua: boolean = reaper.CSurf_OnRecArmChange(MediaTrack trackid, integer recarm)
Python: Boolean RPR_CSurf_OnRecArmChange(MediaTrack trackid, Int recarm)
Description:Sets a MediaTrack's armed state.
| Parameters: |
| MediaTrack trackid | - | the MediaTrack in which to set the armed-state |
| integer recarm | - | the armstate; 0, set to unarmed 1 and higher, set to armed -1 and lower, toggle recarm |
| Returnvalues: |
| boolean | - | true, if set to armed; false, if not |
^
CSurf_OnRecArmChangeExFunctioncall:
C: bool CSurf_OnRecArmChangeEx(MediaTrack* trackid, int recarm, bool allowgang)
EEL2: bool CSurf_OnRecArmChangeEx(MediaTrack trackid, int recarm, bool allowgang)
Lua: boolean = reaper.CSurf_OnRecArmChangeEx(MediaTrack trackid, integer recarm, boolean allowgang)
Python: Boolean RPR_CSurf_OnRecArmChangeEx(MediaTrack trackid, Int recarm, Boolean allowgang)
Description:Sets a MediaTrack's armed state. If MediaTrack is selected, among others, and allowgang is set to true, the new state will be set to them as well.
| Parameters: |
| MediaTrack trackid | - | the MediaTrack in which to set the armed-state |
| integer recarm | - | the armstate; 0, set to unarmed 1 and higher, set to armed -1 and lower, toggle recarm |
| boolean allowgang | - | true, if trackid is selected with other tracks, set new state to them as well; false, set new state only to trackid |
| Returnvalues: |
| boolean | - | true, if set to armed; false, if not |
^
CSurf_OnRecordFunctioncall:
C: void CSurf_OnRecord()
EEL2: CSurf_OnRecord()
Lua: reaper.CSurf_OnRecord()
Python: RPR_CSurf_OnRecord()
Description:Toggles recording on and off. Starts recording from edit-cursor-position.
^
CSurf_OnRecvPanChangeFunctioncall:
C: double CSurf_OnRecvPanChange(MediaTrack* trackid, int recv_index, double pan, bool relative)
EEL2: double CSurf_OnRecvPanChange(MediaTrack trackid, int recv_index, pan, bool relative)
Lua: number = reaper.CSurf_OnRecvPanChange(MediaTrack trackid, integer recv_index, number pan, boolean relative)
Python: Float RPR_CSurf_OnRecvPanChange(MediaTrack trackid, Int recv_index, Float pan, Boolean relative)
Description:Sets/alters a pan-value for a received-track. Will also change pan in the accompanying send-track!
| Parameters: |
| MediaTrack trackid | - | the MediaTrack-object whose receive-pan you want to change |
| integer recv_index | - | the receive to be changed. 0 for the first receive, 1 for the second, etc |
| number pan | - | the new pan value; -1, full left; 1, full right; 0, center |
| boolean relative | - | false, set pan to new value; true, alter pan by new value |
| Returnvalues: |
| number | - | the new receive-pan-value |
^
CSurf_OnRecvVolumeChangeFunctioncall:
C: double CSurf_OnRecvVolumeChange(MediaTrack* trackid, int recv_index, double volume, bool relative)
EEL2: double CSurf_OnRecvVolumeChange(MediaTrack trackid, int recv_index, volume, bool relative)
Lua: number = reaper.CSurf_OnRecvVolumeChange(MediaTrack trackid, integer recv_index, number volume, boolean relative)
Python: Float RPR_CSurf_OnRecvVolumeChange(MediaTrack trackid, Int recv_index, Float volume, Boolean relative)
Description:Sets/alters the volume-value of a received track. Will also change volume in the accompanying send-track!
Note: You can't(!) use SLIDER2DB or DB2SLIDER for getting the volume-values, you want to set here! Use
mkvolstr instead.
| Parameters: |
| MediaTrack trackid | - | the MediaTrack-object whose receive-pan you want to change
|
| integer recv_index | - | the receive to be changed. 0 for the first receive, 1 for the second, etc
|
| number volume | - | the volume-level of the receive; 0, -inf; 1, 0dB; 4, ca +12 db; higher values are possible, though fader will not reflect them. but higher values will still be applied.
|
| boolean relative | - | false, set volume to new value; true, alter volume by new value
|
| Returnvalues: |
| number | - | the new receive-volume-value
|
^
CSurf_OnRewFunctioncall:
C: void CSurf_OnRew(int seekplay)
EEL2: CSurf_OnRew(int seekplay)
Lua: reaper.CSurf_OnRew(integer seekplay)
Python: RPR_CSurf_OnRew(Int seekplay)
Description:Moves editcursor backward, and optionally with seekplay.
| Parameters: |
| integer seekplay | - | how to move the editcursor backward 0, move cursor backward in small steps. Stepsize depends on horizontal zoomfactor. 1, move cursor backward, in half-second steps when stopped; when playing, playing will restart at playcursor |
^
CSurf_OnRewFwdFunctioncall:
C: void CSurf_OnRewFwd(int seekplay, int dir)
EEL2: CSurf_OnRewFwd(int seekplay, int dir)
Lua: reaper.CSurf_OnRewFwd(integer seekplay, integer dir)
Python: RPR_CSurf_OnRewFwd(Int seekplay, Int dir)
Description:Will move editcursor for or backward, depending on parameter dir.
During play and whith seekplay set, the movement of the editcursor depends on the playcursor-position at the time of calling CSurf_OnRewFwd.
| Parameters: |
| integer seekplay | - | turns seekplay on or off; has no effect during recording 0, when stopped, jump for/backwards in small steps(stepsize depending on zoom-factor) 1, when stopped, jump for/backwards in 0.5 seconds steps. When play/rec |
| integer dir | - | the direction; -1, move backwards; 0, keep the position; 1, move forwards |
^
CSurf_OnScrollFunctioncall:
C: void CSurf_OnScroll(int xdir, int ydir)
EEL2: CSurf_OnScroll(int xdir, int ydir)
Lua: reaper.CSurf_OnScroll(integer xdir, integer ydir)
Python: RPR_CSurf_OnScroll(Int xdir, Int ydir)
Description:Scroll arrangeview relative to it's current view-settings.
| Parameters: |
| integer xdir | - | scroll horizontally(timeline) through the project. Negative values toward the beginning, positive toward the end. The higher the values, the farther the movement. |
| integer ydir | - | scroll vertically(tracks) through the project. Negative values toward the top, positive toward the bottom. The higher the values, the farther the movement. |
^
CSurf_OnSelectedChangeFunctioncall:
C: bool CSurf_OnSelectedChange(MediaTrack* trackid, int selected)
EEL2: bool CSurf_OnSelectedChange(MediaTrack trackid, int selected)
Lua: boolean = reaper.CSurf_OnSelectedChange(MediaTrack trackid, integer selected)
Python: Boolean RPR_CSurf_OnSelectedChange(MediaTrack trackid, Int selected)
Description:Sets a track selected or not.
| Parameters: |
| MediaTrack trackid | - | the MediaTrack to be selected/unselected |
| integer selected | - | select-state; 0, track is selected; 1, track is unselected |
| Returnvalues: |
| boolean | - | true, track is selected; false, track is unselected |
^
CSurf_OnSendPanChangeFunctioncall:
C: double CSurf_OnSendPanChange(MediaTrack* trackid, int send_index, double pan, bool relative)
EEL2: double CSurf_OnSendPanChange(MediaTrack trackid, int send_index, pan, bool relative)
Lua: number = reaper.CSurf_OnSendPanChange(MediaTrack trackid, integer send_index, number pan, boolean relative)
Python: Float RPR_CSurf_OnSendPanChange(MediaTrack trackid, Int send_index, Float pan, Boolean relative)
Description:Sets/alters the pan-volume of a send-track. Will also change the volume of the accompanying receive-track!
| Parameters: |
| MediaTrack trackid | - | the MediaTrackObject, whose pan-value you want to change |
| integer send_index | - | the index-number of the send-track. 0 for the first, 2 for the second, etc |
| number pan | - | the pan value; -1 for hard left; 1 for hard right; 0 for center |
| boolean relative | - | false, set pan to new value; true, alter pan by new value |
| Returnvalues: |
| number | - | the new pan-value |
^
CSurf_OnSendVolumeChangeFunctioncall:
C: double CSurf_OnSendVolumeChange(MediaTrack* trackid, int send_index, double volume, bool relative)
EEL2: double CSurf_OnSendVolumeChange(MediaTrack trackid, int send_index, volume, bool relative)
Lua: number = reaper.CSurf_OnSendVolumeChange(MediaTrack trackid, integer send_index, number volume, boolean relative)
Python: Float RPR_CSurf_OnSendVolumeChange(MediaTrack trackid, Int send_index, Float volume, Boolean relative)
Description:Sets/alters the volume-value of a send-track. Will also alter the volume of the accompanying receive-track.
Note: You can't(!) use SLIDER2DB or DB2SLIDER for getting the volume-values, you want to set here!
| Parameters: |
| MediaTrack trackid | - | the MediaTrackObject, whose volume-value you want to change |
| integer send_index | - | the index-number of the send-track. 0 for the first, 2 for the second, etc |
| number volume | - | the volume-level of the receive; 0, -inf; 1, 0dB; 4, ca +12 db; higher values are possible, though fader will not reflect them. but higher values will still be applied. |
| boolean relative | - | false, set volume to new value; true, alter volume by new value |
| Returnvalues: |
| number | - | the new volume-value |
^
CSurf_OnSoloChangeFunctioncall:
C: bool CSurf_OnSoloChange(MediaTrack* trackid, int solo)
EEL2: bool CSurf_OnSoloChange(MediaTrack trackid, int solo)
Lua: boolean = reaper.CSurf_OnSoloChange(MediaTrack trackid, integer solo)
Python: Boolean RPR_CSurf_OnSoloChange(MediaTrack trackid, Int solo)
Description:Sets/toggles solo state of a track.
| Parameters: |
| MediaTrack trackid | - | the MediaTrack in which to toggle solo state |
| integer solo | - | solo state. 0, solo off 1 and higher, solo on -1 and lower, toggle solo on/off |
| Returnvalues: |
| boolean | - | true, solo has been turned on; false, solo has been turned off |
^
CSurf_OnSoloChangeExFunctioncall:
C: bool CSurf_OnSoloChangeEx(MediaTrack* trackid, int solo, bool allowgang)
EEL2: bool CSurf_OnSoloChangeEx(MediaTrack trackid, int solo, bool allowgang)
Lua: boolean retval = reaper.CSurf_OnSoloChangeEx(MediaTrack trackid, integer solo, boolean allowgang)
Python: Boolean RPR_CSurf_OnSoloChangeEx(MediaTrack trackid, Int solo, Boolean allowgang)
Description:Sets/toggles solo state of a track. If MediaTrack is selected, among others, and allowgang is set to true, the new state will be set to them as well.
| Parameters: |
| MediaTrack trackid | - | the MediaTrack in which to toggle solo state |
| integer solo | - | solo state. 0, solo off 1 and higher, solo on -1 and lower, toggle solo on/off |
| boolean allowgang | - | true, if trackid is selected with other tracks, set new state to them as well; false, set new state only to trackid |
| Returnvalues: |
| boolean retval | - | true, solo has been turned on; false, solo has been turned off |
^
CSurf_OnStopFunctioncall:
C: void CSurf_OnStop()
EEL2: CSurf_OnStop()
Lua: reaper.CSurf_OnStop()
Python: RPR_CSurf_OnStop()
Description:Stops playing/recording in current project.
^
CSurf_OnTempoChangeFunctioncall:
C: void CSurf_OnTempoChange(double bpm)
EEL2: CSurf_OnTempoChange(bpm)
Lua: reaper.CSurf_OnTempoChange(number bpm)
Python: RPR_CSurf_OnTempoChange(Float bpm)
Description:Sets the tempo of the project in beats per minute.
| Parameters: |
| number bpm | - | the beats per minute value; 1 to 1000 |
^
CSurf_OnTrackSelectionFunctioncall:
C: void CSurf_OnTrackSelection(MediaTrack* trackid)
EEL2: CSurf_OnTrackSelection(MediaTrack trackid)
Lua: reaper.CSurf_OnTrackSelection(MediaTrack trackid)
Python: RPR_CSurf_OnTrackSelection(MediaTrack trackid)
Description:
| Parameters: |
| MediaTrack trackid | - | |
^
CSurf_OnVolumeChangeFunctioncall:
C: double CSurf_OnVolumeChange(MediaTrack* trackid, double volume, bool relative)
EEL2: double CSurf_OnVolumeChange(MediaTrack trackid, volume, bool relative)
Lua: number = reaper.CSurf_OnVolumeChange(MediaTrack trackid, number volume, boolean relative)
Python: Float RPR_CSurf_OnVolumeChange(MediaTrack trackid, Float volume, Boolean relative)
Description:Sets or alters volume of a track to a new value.
Use
DB2SLIDER to convert dB-value to fitting numbers of the volume-parameter.
| Parameters: |
| MediaTrack trackid | - | the MediaTrack, whose volume you want to change.
|
| number volume | - | volume-value; 3.1622776601684e-008(minimum) to 3.981071705535(maximum). Higher values are possible to set but are out of fader-range.
|
| boolean relative | - | false, set volume to new value; true, alter volume by new value
|
| Returnvalues: |
| number | - | the new volume-value
|
^
CSurf_OnVolumeChangeExFunctioncall:
C: double CSurf_OnVolumeChangeEx(MediaTrack* trackid, double volume, bool relative, bool allowGang)
EEL2: double CSurf_OnVolumeChangeEx(MediaTrack trackid, volume, bool relative, bool allowGang)
Lua: number = reaper.CSurf_OnVolumeChangeEx(MediaTrack trackid, number volume, boolean relative, boolean allowGang)
Python: Float RPR_CSurf_OnVolumeChangeEx(MediaTrack trackid, Float volume, Boolean relative, Boolean allowGang)
Description:Sets or alters volume of a track to a new value. If MediaTrack is selected, among others, and allowgang is set to true, the new state will be set to them as well.
Use
DB2SLIDER to convert dB-value to fitting numbers of the volume-parameter.
| Parameters: |
| MediaTrack trackid | - | the MediaTrack, whose volume you want to change.
|
| number volume | - | volume-value; 3.1622776601684e-008(minimum) to 3.981071705535(maximum). Higher values are possible to set but are out of fader-range.
|
| boolean relative | - | false, set volume to new value; true, alter volume by new value
|
| boolean allowgang | - | true, if trackid is selected with other tracks, set new state to them as well; false, set new state only to trackid
|
| Returnvalues: |
| number | - | the new volume-value
|
^
CSurf_OnWidthChangeFunctioncall:
C: double CSurf_OnWidthChange(MediaTrack* trackid, double width, bool relative)
EEL2: double CSurf_OnWidthChange(MediaTrack trackid, width, bool relative)
Lua: number = reaper.CSurf_OnWidthChange(MediaTrack trackid, number width, boolean relative)
Python: Float RPR_CSurf_OnWidthChange(MediaTrack trackid, Float width, Boolean relative)
Description:Sets/alters the width-value of a track.
| Parameters: |
| MediaTrack trackid | - | the MediaItem, whose width you want to change |
| number width | - | the width-value; -1 to 1; 0 is no width/mono |
| boolean relative | - | false, set width to the new width-value; true, alter width by the new width-value |
| Returnvalues: |
| number | - | the new width-value |
^
CSurf_OnWidthChangeExFunctioncall:
C: double CSurf_OnWidthChangeEx(MediaTrack* trackid, double width, bool relative, bool allowGang)
EEL2: double CSurf_OnWidthChangeEx(MediaTrack trackid, width, bool relative, bool allowGang)
Lua: number = reaper.CSurf_OnWidthChangeEx(MediaTrack trackid, number width, boolean relative, boolean allowGang)
Python: Float RPR_CSurf_OnWidthChangeEx(MediaTrack trackid, Float width, Boolean relative, Boolean allowGang)
Description:Sets/alters the width-value of a track. If MediaTrack is selected, among others, and allowgang is set to true, the new state will be set to them as well.
| Parameters: |
| MediaTrack trackid | - | the MediaItem, whose width you want to change |
| number width | - | the width-value; -1 to 1; 0 is no width/mono |
| boolean relative | - | false, set width to the new width-value; true, alter width by the new width-value |
| boolean allowgang | - | true, if trackid is selected with other tracks, set new state to them as well; false, set new state only to trackid |
| Returnvalues: |
| number | - | the new width-value |
^
CSurf_OnZoomFunctioncall:
C: void CSurf_OnZoom(int xdir, int ydir)
EEL2: CSurf_OnZoom(int xdir, int ydir)
Lua: reaper.CSurf_OnZoom(integer xdir, integer ydir)
Python: RPR_CSurf_OnZoom(Int xdir, Int ydir)
Description:Changes horizontal/vertical zoom.
| Parameters: |
| integer xdir | - | horizontal zoom; 0, no change; negative values, zoom out; positive values, zoom in; the higher the values, the bigger the zoom-stepsize. |
| integer ydir | - | vertical zoom; 0, no change; negative values, zoom out; positive values, zoom in; the higher the values, the bigger the zoom-stepsize. |
^
CSurf_ResetAllCachedVolPanStatesFunctioncall:
C: void CSurf_ResetAllCachedVolPanStates()
EEL2: CSurf_ResetAllCachedVolPanStates()
Lua: reaper.CSurf_ResetAllCachedVolPanStates()
Python: RPR_CSurf_ResetAllCachedVolPanStates()
Description:Resets all cached vol-pan-states.
^
CSurf_ScrubAmtFunctioncall:
C: void CSurf_ScrubAmt(double amt)
EEL2: CSurf_ScrubAmt(amt)
Lua: reaper.CSurf_ScrubAmt(number amt)
Python: RPR_CSurf_ScrubAmt(Float amt)
Description:Changes position of the editcursor by amt-value in seconds. When playing, the playposition changes to the editcursor-position.
During recording, it changes only the position of the editcursor.
| Parameters: |
| number amt | - | how far to change position of the editcursor in seconds. Positive values toward the end, negative toward the beginning of the project. |
^
CSurf_SetAutoModeFunctioncall:
C: void CSurf_SetAutoMode(int mode, IReaperControlSurface* ignoresurf)
EEL2: CSurf_SetAutoMode(int mode, IReaperControlSurface ignoresurf)
Lua: reaper.CSurf_SetAutoMode(integer mode, IReaperControlSurface ignoresurf)
Python: RPR_CSurf_SetAutoMode(Int mode, IReaperControlSurface ignoresurf)
Description:
| Parameters: |
| integer mode | - | |
| IReaperControlSurface ignoresurf | - | |
^
CSurf_SetPlayStateFunctioncall:
C: void CSurf_SetPlayState(bool play, bool pause, bool rec, IReaperControlSurface* ignoresurf)
EEL2: CSurf_SetPlayState(bool play, bool pause, bool rec, IReaperControlSurface ignoresurf)
Lua: reaper.CSurf_SetPlayState(boolean play, boolean pause, boolean rec, IReaperControlSurface ignoresurf)
Python: RPR_CSurf_SetPlayState(Boolean play, Boolean pause, Boolean rec, IReaperControlSurface ignoresurf)
Description:
| Parameters: |
| boolean play | - | |
| boolean pause | - | |
| boolean rec | - | |
| IReaperControlSurface ignoresurf | - | |
^
CSurf_SetRepeatStateFunctioncall:
C: void CSurf_SetRepeatState(bool rep, IReaperControlSurface* ignoresurf)
EEL2: CSurf_SetRepeatState(bool rep, IReaperControlSurface ignoresurf)
Lua: reaper.CSurf_SetRepeatState(boolean rep, IReaperControlSurface ignoresurf)
Python: RPR_CSurf_SetRepeatState(Boolean rep, IReaperControlSurface ignoresurf)
Description:
| Parameters: |
| boolean rep | - | |
| IReaperControlSurface ignoresurf | - | |
^
CSurf_SetSurfaceMuteFunctioncall:
C: void CSurf_SetSurfaceMute(MediaTrack* trackid, bool mute, IReaperControlSurface* ignoresurf)
EEL2: CSurf_SetSurfaceMute(MediaTrack trackid, bool mute, IReaperControlSurface ignoresurf)
Lua: reaper.CSurf_SetSurfaceMute(MediaTrack trackid, boolean mute, IReaperControlSurface ignoresurf)
Python: RPR_CSurf_SetSurfaceMute(MediaTrack trackid, Boolean mute, IReaperControlSurface ignoresurf)
Description:
| Parameters: |
| MediaTrack trackid | - | |
| integer mute | - | |
| IReaperControlSurface ignoresurf | - | |
^
CSurf_SetSurfacePanFunctioncall:
C: void CSurf_SetSurfacePan(MediaTrack* trackid, double pan, IReaperControlSurface* ignoresurf)
EEL2: CSurf_SetSurfacePan(MediaTrack trackid, pan, IReaperControlSurface ignoresurf)
Lua: reaper.CSurf_SetSurfacePan(MediaTrack trackid, number pan, IReaperControlSurface ignoresurf)
Python: RPR_CSurf_SetSurfacePan(MediaTrack trackid, Float pan, IReaperControlSurface ignoresurf)
Description:
| Parameters: |
| MediaTrack trackid | - | |
| number pan | - | |
| IReaperControlSurface ignoresurf | - | |
^
CSurf_SetSurfaceRecArmFunctioncall:
C: void CSurf_SetSurfaceRecArm(MediaTrack* trackid, bool recarm, IReaperControlSurface* ignoresurf)
EEL2: CSurf_SetSurfaceRecArm(MediaTrack trackid, bool recarm, IReaperControlSurface ignoresurf)
Lua: reaper.CSurf_SetSurfaceRecArm(MediaTrack trackid, boolean recarm, IReaperControlSurface ignoresurf)
Python: RPR_CSurf_SetSurfaceRecArm(MediaTrack trackid, Boolean recarm, IReaperControlSurface ignoresurf)
Description:
| Parameters: |
| MediaTrack trackid | - | |
| boolean recarm | - | |
| IReaperControlSurface ignoresurf | - | |
^
CSurf_SetSurfaceSelectedFunctioncall:
C: void CSurf_SetSurfaceSelected(MediaTrack* trackid, bool selected, IReaperControlSurface* ignoresurf)
EEL2: CSurf_SetSurfaceSelected(MediaTrack trackid, bool selected, IReaperControlSurface ignoresurf)
Lua: reaper.CSurf_SetSurfaceSelected(MediaTrack trackid, boolean selected, IReaperControlSurface ignoresurf)
Python: RPR_CSurf_SetSurfaceSelected(MediaTrack trackid, Boolean selected, IReaperControlSurface ignoresurf)
Description:
| Parameters: |
| MediaTrack trackid | - | |
| boolean selected | - | |
| IReaperControlSurface ignoresurf | - | |
^
CSurf_SetSurfaceSoloFunctioncall:
C: void CSurf_SetSurfaceSolo(MediaTrack* trackid, bool solo, IReaperControlSurface* ignoresurf)
EEL2: CSurf_SetSurfaceSolo(MediaTrack trackid, bool solo, IReaperControlSurface ignoresurf)
Lua: reaper.CSurf_SetSurfaceSolo(MediaTrack trackid, boolean solo, IReaperControlSurface ignoresurf)
Python: RPR_CSurf_SetSurfaceSolo(MediaTrack trackid, Boolean solo, IReaperControlSurface ignoresurf)
Description:
| Parameters: |
| MediaTrack trackid | - | |
| boolean solo | - | |
| IReaperControlSurface ignoresurf | - | |
^
CSurf_SetSurfaceVolumeFunctioncall:
C: void CSurf_SetSurfaceVolume(MediaTrack* trackid, double volume, IReaperControlSurface* ignoresurf)
EEL2: CSurf_SetSurfaceVolume(MediaTrack trackid, volume, IReaperControlSurface ignoresurf)
Lua: reaper.CSurf_SetSurfaceVolume(MediaTrack trackid, number volume, IReaperControlSurface ignoresurf)
Python: RPR_CSurf_SetSurfaceVolume(MediaTrack trackid, Float volume, IReaperControlSurface ignoresurf)
Description:
| Parameters: |
| MediaTrack trackid | - | |
| number volume | - | |
| IReaperControlSurface ignoresurf | - | |
^
CSurf_SetTrackListChangeFunctioncall:
C: void CSurf_SetTrackListChange()
EEL2: CSurf_SetTrackListChange()
Lua: reaper.CSurf_SetTrackListChange()
Python: RPR_CSurf_SetTrackListChange()
Description:
^
CSurf_TrackFromIDFunctioncall:
C: MediaTrack* CSurf_TrackFromID(int idx, bool mcpView)
EEL2: MediaTrack CSurf_TrackFromID(int idx, bool mcpView)
Lua: MediaTrack = reaper.CSurf_TrackFromID(integer idx, boolean mcpView)
Python: MediaTrack RPR_CSurf_TrackFromID(Int idx, Boolean mcpView)
Description:Gets a MediaTrack-object by it's number.
| Parameters: |
| integer idx | - | the tracknumber of the track you want to have; 0 for track 1, 1 for track 2, etc. |
| boolean mcpView | - | true, count only tracks, that are visible in MixerControlPanel |
| Returnvalues: |
| MediaTrack | - | the MediaTrack-object of the track you requested |
^
CSurf_TrackToIDFunctioncall:
C: int CSurf_TrackToID(MediaTrack* track, bool mcpView)
EEL2: int CSurf_TrackToID(MediaTrack track, bool mcpView)
Lua: integer = reaper.CSurf_TrackToID(MediaTrack track, boolean mcpView)
Python: Int RPR_CSurf_TrackToID(MediaTrack track, Boolean mcpView)
Description:Get the tracknumber of a MediaTrack-object.
| Parameters: |
| MediaTrack track | - | the MediaTrack-object, whose number you want to know |
| boolean mcpView | - | true, only tracks visible in MixerControlPanel; false, all tracks visible in MixerControlPanel |
| Returnvalues: |
| integer | - | the tracknumber of the MediaTrack; when mcpView is true, invisible tracks will return -1 as number |
^
DB2SLIDERFunctioncall:
C: double DB2SLIDER(double x)
EEL2: double DB2SLIDER(x)
Lua: number = reaper.DB2SLIDER(number x)
Python: Float RPR_DB2SLIDER(Float x)
Description:Converts dB-value into a slider-value. Good for converting envelope-point-values.
| Parameters: |
| number x | - | the dB-value to be converted. Minimum -332db for position 0 |
| Returnvalues: |
| number | - | the slider-value |
^
DeleteEnvelopePointExFunctioncall:
C: bool DeleteEnvelopePointEx(TrackEnvelope* envelope, int autoitem_idx, int ptidx)
EEL2: bool DeleteEnvelopePointEx(TrackEnvelope envelope, int autoitem_idx, int ptidx)
Lua: boolean = reaper.DeleteEnvelopePointEx(TrackEnvelope envelope, integer autoitem_idx, integer ptidx)
Python: Boolean RPR_DeleteEnvelopePointEx(TrackEnvelope envelope, Int autoitem_idx, Int ptidx)
Description:Delete an envelope point. If setting multiple points at once, set noSort=true, and call Envelope_SortPoints when done.
autoitem_idx=-1 for the underlying envelope, 0 for the first automation item on the envelope, etc.
For automation items, pass autoitem_idx|0x10000000 to base ptidx on the number of points in one full loop iteration,
even if the automation item is trimmed so that not all points are visible.
Otherwise, ptidx will be based on the number of visible points in the automation item, including all loop iterations.
See
CountEnvelopePointsEx,
GetEnvelopePointEx,
SetEnvelopePointEx,
InsertEnvelopePointEx.
| Parameters: |
| TrackEnvelope envelope | - | the envelope, in which the point lies, that you want to delete
|
| integer autoitem_idx | - | -1, the underlying envelope; 0 to x, the 1st to x-1th automation-item |0x10000000 to base ptidx on the number of points in one full loop iteration, even if the automation item is trimmed so that not all points are visible. Otherwise, ptidx will be based on the number of visible points in the automation item, including all loop iterations.
|
| integer ptidx | - | the envelope-point to delete
|
| Returnvalues: |
| boolean | - | true, deleting was successful; false, deleting was unsuccessful
|
^
DeleteEnvelopePointRangeFunctioncall:
C: bool DeleteEnvelopePointRange(TrackEnvelope* envelope, double time_start, double time_end)
EEL2: bool DeleteEnvelopePointRange(TrackEnvelope envelope, time_start, time_end)
Lua: boolean = reaper.DeleteEnvelopePointRange(TrackEnvelope envelope, number time_start, number time_end)
Python: Boolean RPR_DeleteEnvelopePointRange(TrackEnvelope envelope, Float time_start, Float time_end)
Description:
| Parameters: |
| TrackEnvelope envelope | - | the envelope-point-object, in which to delete the envelope-points
|
| number time_start | - | the starttime of the deletionrange in seconds
|
| number time_end | - | the endtime of the deletionrange in seconds
|
| Returnvalues: |
| boolean | - | true, if it succeeded
|
^
DeleteEnvelopePointRangeExFunctioncall:
C: bool DeleteEnvelopePointRangeEx(TrackEnvelope* envelope, int autoitem_idx, double time_start, double time_end)
EEL2: bool DeleteEnvelopePointRangeEx(TrackEnvelope envelope, int autoitem_idx, time_start, time_end)
Lua: boolean = reaper.DeleteEnvelopePointRangeEx(TrackEnvelope envelope, integer autoitem_idx, number time_start, number time_end)
Python: Boolean RPR_DeleteEnvelopePointRangeEx(TrackEnvelope envelope, Int autoitem_idx, Float time_start, Float time_end)
Description:Delete a range of envelope points. autoitem_idx=-1 for the underlying envelope, 0 for the first automation item on the envelope, etc.
| Parameters: |
| TrackEnvelope envelope | - | the envelope-point-object, in which to delete the envelope-points |
| integer autoitem_idx | - | the automation item to be affected by deletion; -1, for the underlying envelope itself; 0, for the first automation item on the envelope; 1 for the second, etc |
| number time_start | - | the starttime of the deletionrange in seconds |
| number time_end | - | the endtime of the deletionrange in seconds |
| Returnvalues: |
| boolean | - | true, if deleting was successful; false, if not |
^
DeleteExtStateFunctioncall:
C: void DeleteExtState(const char* section, const char* key, bool persist)
EEL2: DeleteExtState("section", "key", bool persist)
Lua: reaper.DeleteExtState(string section, string key, boolean persist)
Python: RPR_DeleteExtState(String section, String key, Boolean persist)
Description:Delete the extended state value for a specific section and key. persist=true means the value should remain deleted the next time REAPER is opened. If persistent, the value will be deleted from the file reaper-extstate.ini in the ressources-folder.
See
SetExtState,
GetExtState,
HasExtState.
| Parameters: |
| string section | - | the section, in which the value is stored
|
| string key | - | the key, with which the value is stored
|
| boolean persist | - | true, the value shall be deleted permanently; false, delete it only temporarily.
|
^
DeleteProjectMarkerFunctioncall:
C: bool DeleteProjectMarker(ReaProject* proj, int markrgnindexnumber, bool isrgn)
EEL2: bool DeleteProjectMarker(ReaProject proj, int markrgnindexnumber, bool isrgn)
Lua: boolean = reaper.DeleteProjectMarker(ReaProject proj, integer markrgnindexnumber, boolean isrgn)
Python: Boolean RPR_DeleteProjectMarker(ReaProject proj, Int markrgnindexnumber, Boolean isrgn)
Description:Deletes a marker or a region. proj==NULL for the active project.
Does not delete tempo/timesignature markers!
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| integer markrgnindexnumber | - | the shown number of the marker to be deleted
|
| boolean isrgn | - | true, marker is a region; false, marker is a normal marker
|
| Returnvalues: |
| boolean | - | true, deleting was successful; false, deleting was unsuccessful.
|
^
DeleteProjectMarkerByIndexFunctioncall:
C: bool DeleteProjectMarkerByIndex(ReaProject* proj, int markrgnidx)
EEL2: bool DeleteProjectMarkerByIndex(ReaProject proj, int markrgnidx)
Lua: boolean = reaper.DeleteProjectMarkerByIndex(ReaProject proj, integer markrgnidx)
Python: Boolean RPR_DeleteProjectMarkerByIndex(ReaProject proj, Int markrgnidx)
Description:Differs from DeleteProjectMarker only in that markrgnidx is 0 for the first marker/region in the project, 1 for the next, etc, rather than representing the displayed marker/region ID number.
See
EnumProjectMarkers3) and
SetProjectMarker4.
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| integer markrgnidx | - | the id of the marker within the project, 0 for the first, 1 for the second, etc. Ignores the shown marker-index!
|
| Returnvalues: |
| boolean | - | true, deleting was successful; false, deleting was unsuccessful.
|
^
DeleteTakeMarkerFunctioncall:
C: bool retval = DeleteTakeMarker(MediaItem_Take* take, int idx)
EEL2: bool retval = DeleteTakeMarker(MediaItem_Take take, int idx)
Lua: boolean retval = reaper.DeleteTakeMarker(MediaItem_Take take, integer idx)
Python: Boolean retval = RPR_DeleteTakeMarker(MediaItem_Take take, Int idx)
Description:
| Parameters: |
| MediaItem_Take take | - | the take, whose take-marker you want to delete
|
| integer idx | - | the id of the marker within the take, 0 for the first, 1 for the second, etc.
|
| Returnvalues: |
| boolean retval | - | true, deleting was successful; false, deleting was unsuccessful.
|
^
DeleteTakeStretchMarkersFunctioncall:
C: int DeleteTakeStretchMarkers(MediaItem_Take* take, int idx, const int* countInOptional)
EEL2: int DeleteTakeStretchMarkers(MediaItem_Take take, int idx, optional int countIn)
Lua: integer = reaper.DeleteTakeStretchMarkers(MediaItem_Take take, integer idx, optional number countIn)
Python: Int RPR_DeleteTakeStretchMarkers(MediaItem_Take take, Int idx, const int countInOptional)
Description:Deletes one or more stretch markers. Returns number of stretch markers deleted.
| Parameters: |
| MediaItem_Take take | - | |
| integer idx | - | |
| optional number countIn | - | |
^
DeleteTempoTimeSigMarkerFunctioncall:
C: bool DeleteTempoTimeSigMarker(ReaProject* project, int markerindex)
EEL2: bool DeleteTempoTimeSigMarker(ReaProject project, int markerindex)
Lua: boolean = reaper.DeleteTempoTimeSigMarker(ReaProject project, integer markerindex)
Python: Boolean RPR_DeleteTempoTimeSigMarker(ReaProject project, Int markerindex)
Description:
| Parameters: |
| ReaProject project | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| integer markerindex | - |
|
^
DeleteTrackFunctioncall:
C: void DeleteTrack(MediaTrack* tr)
EEL2: DeleteTrack(MediaTrack tr)
Lua: reaper.DeleteTrack(MediaTrack tr)
Python: RPR_DeleteTrack(MediaTrack tr)
Description:deletes a track
| Parameters: |
| MediaTrack tr | - | the MediaTrack to be deleted |
^
DeleteTrackMediaItemFunctioncall:
C: bool DeleteTrackMediaItem(MediaTrack* tr, MediaItem* it)
EEL2: bool DeleteTrackMediaItem(MediaTrack tr, MediaItem it)
Lua: boolean = reaper.DeleteTrackMediaItem(MediaTrack tr, MediaItem it)
Python: Boolean RPR_DeleteTrackMediaItem(MediaTrack tr, MediaItem it)
Description:Deletes a MediaItem.
| Parameters: |
| MediaTrack tr | - | the MediaTrack, in which the MediaItem lies, that you want to delete |
| MediaItem it | - | the MediaItem-object you want to delete |
| Returnvalues: |
| boolean | - | true, deleting was successful; false, deleting was unsuccessful |
^
DestroyAudioAccessorFunctioncall:
C: void DestroyAudioAccessor(AudioAccessor* accessor)
EEL2: DestroyAudioAccessor(AudioAccessor accessor)
Lua: reaper.DestroyAudioAccessor(AudioAccessor accessor)
Python: RPR_DestroyAudioAccessor(AudioAccessor accessor)
Description:
| Parameters: |
| AudioAccessor accessor | - | the AudioAccessor to be destroyed
|
^
Dock_UpdateDockIDFunctioncall:
C: void Dock_UpdateDockID(const char* ident_str, int whichDock)
EEL2: Dock_UpdateDockID("ident_str", int whichDock)
Lua: reaper.Dock_UpdateDockID(string ident_str, integer whichDock)
Python: RPR_Dock_UpdateDockID(String ident_str, Int whichDock)
Description:updates preference for docker window ident_str to be in dock whichDock on next open
| Parameters: |
| string ident_str | - | |
| integer whichDock | - | |
^
DockGetPositionFunctioncall:
C: int DockGetPosition(int whichDock)
EEL2: int DockGetPosition(int whichDock)
Lua: integer = reaper.DockGetPosition(integer whichDock)
Python: Int RPR_DockGetPosition(Int whichDock)
Description:returns the position of docker whichDock
| Parameters: |
| integer whichDock | - | the docker, whose position you want to get -1, not found 0, bottom 1, left 2, top 3, right 4, floating |
^
DockIsChildOfDockFunctioncall:
C: int DockIsChildOfDock(HWND hwnd, bool* isFloatingDockerOut)
EEL2: int DockIsChildOfDock(HWND hwnd, bool &isFloatingDocker)
Lua: integer retval, boolean isFloatingDocker = reaper.DockIsChildOfDock(HWND hwnd)
Python: (Int retval, HWND hwnd, Boolean isFloatingDockerOut) = RPR_DockIsChildOfDock(hwnd, isFloatingDockerOut)
Description:returns dock index that contains hwnd, or -1
| Returnvalues: |
| integer retval | - | |
| boolean isFloatingDocker | - | |
^
DockWindowActivateFunctioncall:
C: void DockWindowActivate(HWND hwnd)
EEL2: DockWindowActivate(HWND hwnd)
Lua: reaper.DockWindowActivate(HWND hwnd)
Python: RPR_DockWindowActivate(HWND hwnd)
Description:
^
DockWindowAddFunctioncall:
C: void DockWindowAdd(HWND hwnd, const char* name, int pos, bool allowShow)
EEL2: DockWindowAdd(HWND hwnd, "name", int pos, bool allowShow)
Lua: reaper.DockWindowAdd(HWND hwnd, string name, integer pos, boolean allowShow)
Python: RPR_DockWindowAdd(HWND hwnd, String name, Int pos, Boolean allowShow)
Description:
| Parameters: |
| HWND hwnd | - | |
| string name | - | |
| integer pos | - | |
| boolean allowShow | - | |
^
DockWindowAddExFunctioncall:
C: void DockWindowAddEx(HWND hwnd, const char* name, const char* identstr, bool allowShow)
EEL2: DockWindowAddEx(HWND hwnd, "name", "identstr", bool allowShow)
Lua: reaper.DockWindowAddEx(HWND hwnd, string name, string identstr, boolean allowShow)
Python: RPR_DockWindowAddEx(HWND hwnd, String name, String identstr, Boolean allowShow)
Description:
| Parameters: |
| HWND hwnd | - | |
| string name | - | |
| string identstr | - | |
| boolean allowShow | - | |
^
DockWindowRefreshFunctioncall:
C: void DockWindowRefresh()
EEL2: DockWindowRefresh()
Lua: reaper.DockWindowRefresh()
Python: RPR_DockWindowRefresh()
Description:Refreshes docked windows.
^
DockWindowRefreshForHWNDFunctioncall:
C: void DockWindowRefreshForHWND(HWND hwnd)
EEL2: DockWindowRefreshForHWND(HWND hwnd)
Lua: reaper.DockWindowRefreshForHWND(HWND hwnd)
Python: RPR_DockWindowRefreshForHWND(HWND hwnd)
Description:
^
DockWindowRemoveFunctioncall:
C: void DockWindowRemove(HWND hwnd)
EEL2: DockWindowRemove(HWND hwnd)
Lua: reaper.DockWindowRemove(HWND hwnd)
Python: RPR_DockWindowRemove(HWND hwnd)
Description:
^
EditTempoTimeSigMarkerFunctioncall:
C: bool EditTempoTimeSigMarker(ReaProject* project, int markerindex)
EEL2: bool EditTempoTimeSigMarker(ReaProject project, int markerindex)
Lua: boolean = reaper.EditTempoTimeSigMarker(ReaProject project, integer markerindex)
Python: Boolean RPR_EditTempoTimeSigMarker(ReaProject project, Int markerindex)
Description:Open the tempo/time signature marker editor dialog.
| Parameters: |
| ReaProject project | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| integer markerindex | - |
|
| Returnvalues: |
| boolean | - | true, if user clicked OK button; false if user clicked cancel
|
^
EnsureNotCompletelyOffscreenFunctioncall:
C: void EnsureNotCompletelyOffscreen(RECT* rInOut)
EEL2: EnsureNotCompletelyOffscreen(int &r.left, int &r.top, int &r.right, int &r.bot)
Lua: integer r.left, integer r.top, integer r.right, integer r.bot = reaper.EnsureNotCompletelyOffscreen(integer r.left, integer r.top, integer r.right, integer r.bot)
Python: RPR_EnsureNotCompletelyOffscreen(RECT rInOut)
Description:call with a saved window rect for your window and it'll correct any positioning info.
| Parameters: |
| integer r.left | - | |
| integer r.top | - | |
| integer r.right | - | |
| integer r.bot | - | |
| Returnvalues: |
| integer r.left | - | |
| integer r.top | - | |
| integer r.right | - | |
| integer r.bot | - | |
^
EnumerateFilesFunctioncall:
C: const char* EnumerateFiles(const char* path, int fileindex)
EEL2: bool EnumerateFiles(#retval, "path", int fileindex)
Lua: string = reaper.EnumerateFiles(string path, integer fileindex)
Python: String RPR_EnumerateFiles(String path, Int fileindex)
Description:List the files in the "path" directory. Returns NULL/nil when all files have been listed. Use fileindex = -1 to force re-read of directory (invalidate cache). See
EnumerateSubdirectories
| Parameters: |
| string path | - | the path, where the filenames will be read from
|
| integer fileindex | - | the number of the file, with 0 the first file. Ordered by first letter in ascending order.
|
| Returnvalues: |
| string | - | the filename in path, with index fileindex
|
^
EnumerateSubdirectoriesFunctioncall:
C: const char* EnumerateSubdirectories(const char* path, int subdirindex)
EEL2: bool EnumerateSubdirectories(#retval, "path", int subdirindex)
Lua: string = reaper.EnumerateSubdirectories(string path, integer subdirindex)
Python: String RPR_EnumerateSubdirectories(String path, Int subdirindex)
Description:List the subdirectories in the "path" directory. Use subdirindex = -1 to force re-read of directory (invalidate cache). Returns NULL/nil when all subdirectories have been listed. See
EnumerateFiles
| Parameters: |
| string path | - | the path, where the directorynames will be read from
|
| integer subdirindex | - | the number of the directory, with 0 the first directory. Ordered by first letter in ascending order.
|
| Returnvalues: |
| string | - | the filename in path, with index fileindex
|
^
EnumPitchShiftModesFunctioncall:
C: bool EnumPitchShiftModes(int mode, const char** strOut)
EEL2: bool EnumPitchShiftModes(int mode, #str)
Lua: boolean retval, string str = reaper.EnumPitchShiftModes(integer mode)
Python: Boolean RPR_EnumPitchShiftModes(Int mode, String strOut)
Description:Start querying modes at 0, returns FALSE when no more modes possible, sets strOut to NULL if a mode is currently unsupported
| Parameters: |
| integer mode | - | |
| Returnvalues: |
| boolean retval | - | |
| string str | - | |
^
EnumPitchShiftSubModesFunctioncall:
C: const char* EnumPitchShiftSubModes(int mode, int submode)
EEL2: bool EnumPitchShiftSubModes(#retval, int mode, int submode)
Lua: string = reaper.EnumPitchShiftSubModes(integer mode, integer submode)
Python: String RPR_EnumPitchShiftSubModes(Int mode, Int submode)
Description:Returns submode name, or NULL
| Parameters: |
| integer mode | - | |
| integer submode | - | |
^
EnumProjectMarkersFunctioncall:
C: int EnumProjectMarkers(int idx, bool* isrgnOut, double* posOut, double* rgnendOut, const char** nameOut, int* markrgnindexnumberOut)
EEL2: int EnumProjectMarkers(int idx, bool &isrgn, &pos, &rgnend, #name, int &markrgnindexnumber)
Lua: integer retval, boolean isrgn, number pos, number rgnend, string name, integer markrgnindexnumber = reaper.EnumProjectMarkers(integer idx)
Python: (Int retval, Int idx, Boolean isrgnOut, Float posOut, Float rgnendOut, String nameOut, Int markrgnindexnumberOut) = RPR_EnumProjectMarkers(idx, isrgnOut, posOut, rgnendOut, nameOut, markrgnindexnumberOut)
Description:Returns the values of a given marker or region idx.
| Parameters: |
| integer idx | - | the number of the marker, beginning with 0 for the first marker |
| Returnvalues: |
| integer retval | - | number of marker beginning with 1 for the first marker
ignore the order of first,second,etc creation of markers but counts from position 00:00:00 to end of project. So if you created a marker at position 00:00:00 and move the first created marker to the end of the timeline,
it will be the last one, NOT the first one in the retval! |
| boolean isgrn | - | is the marker a region? |
| number pos | - | the time-position in seconds with 12 digits precision (1.123456789012) |
| number rgnend | - | if it's a region, the position of the end of the region in seconds with 12 digits precision(123.123456789012);
if it's just a marker it's 0.0 |
| string name | - | name of the marker |
| integer markrgnindexnumber | - | marker/region index number.
Note: the numbering of markers and regions is independent. If you have one region and one marker,
both share the number 1, even though you have 2 in your project(one marker and one region). |
^
EnumProjectMarkers2Functioncall:
C: int EnumProjectMarkers2(ReaProject* proj, int idx, bool* isrgnOut, double* posOut, double* rgnendOut, const char** nameOut, int* markrgnindexnumberOut)
EEL2: int EnumProjectMarkers2(ReaProject proj, int idx, bool &isrgn, &pos, &rgnend, #name, int &markrgnindexnumber)
Lua: integer retval, boolean isrgn, number pos, number rgnend, string name, integer markrgnindexnumber = reaper.EnumProjectMarkers2(ReaProject proj, integer idx)
Python: (Int retval, ReaProject proj, Int idx, Boolean isrgnOut, Float posOut, Float rgnendOut, String nameOut, Int markrgnindexnumberOut) = RPR_EnumProjectMarkers2(proj, idx, isrgnOut, posOut, rgnendOut, nameOut, markrgnindexnumberOut)
Description:Returns the values of a given marker or region idx from a given project proj.
| Parameters: |
| ReaProject proj | - | Projectnumber. 0, current project; 1 to x the first(1) to the last project(x) (in tabs for example); can also be a ReaProject-object, as returned by EnumProjects
|
| integer idx | - | the number of the marker, beginning with 0 for the first marker
|
| Returnvalues: |
| integer retval | - | number of marker beginning with 1 for the first marker ignore the order of first,second,etc creation of markers but counts from position 00:00:00 to end of project. So if you created a marker at position 00:00:00 and move the first created marker to the end of the timeline, it will be the last one, NOT the first one in the retval!
|
| boolean isgrn | - | is the marker a region?
|
| number pos | - | the time-position in seconds with 12 digits precision (1.123456789012)
|
| number rgnend | - | if it's a region, the end of the region in seconds with 12 digits precision(123.123456789012); if just marker it's 0.0
|
| string name | - | name of the marker
|
| integer markrgnindexnumber | - | marker/region index number. Note: the numbering of markers and regions is independent. If you have one region and one marker, both share the number 1, even though you have 2 in your project(one marker and one region).
|
^
EnumProjectMarkers3Functioncall:
C: int EnumProjectMarkers3(ReaProject* proj, int idx, bool* isrgnOut, double* posOut, double* rgnendOut, const char** nameOut, int* markrgnindexnumberOut, int* colorOut)
EEL2: int EnumProjectMarkers3(ReaProject proj, int idx, bool &isrgn, &pos, &rgnend, #name, int &markrgnindexnumber, int &color)
Lua: integer retval, boolean isrgn, number pos, number rgnend, string name, integer markrgnindexnumber, integer color = reaper.EnumProjectMarkers3(ReaProject proj, integer idx)
Python: (Int retval, ReaProject proj, Int idx, Boolean isrgnOut, Float posOut, Float rgnendOut, String nameOut, Int markrgnindexnumberOut, Int colorOut) = RPR_EnumProjectMarkers3(proj, idx, isrgnOut, posOut, rgnendOut, nameOut, markrgnindexnumberOut, colorOut)
Description:Returns the values of a given marker or region idx from a given project proj.
| Parameters: |
| ReaProject proj | - | Projectnumber. 0, current project; 1 to x the first(1) to the last project(x) (in tabs for example); can also be a ReaProject-object, as returned by EnumProjects
|
| integer idx | - | the number of the marker, beginning with 0 for the first marker
|
| Returnvalues: |
| integer retval | - | number of marker beginning with 1 for the first marker; ignore the order of first,second,etc creation of markers but counts from position 00:00:00 to end of project. So if you created a marker at position 00:00:00 and move the first created marker to the end of the timeline, it will be the last one, NOT the first one in the retval!
|
| boolean isgrn | - | is the marker a region?
|
| number pos | - | the time-position in seconds with 12 digits precision (1.123456789012)
|
| number rgnend | - | if it's a region, the end of the region in seconds with 12 digits precision(123.123456789012); if just marker it's 0.0
|
| string name | - | name of the marker
|
| integer markrgnindexnumber | - | marker/region index number. Note: the numbering of markers and regions is independent. If you have one region and one marker, both share the number 1, even though you have 2 in your project(one marker and one region).
|
| integer color | - | number of color of the marker/region
|
^
EnumProjectsFunctioncall:
C: ReaProject* EnumProjects(int idx, char* projfnOutOptional, int projfnOutOptional_sz)
EEL2: ReaProject EnumProjects(int idx, optional #projfn)
Lua: ReaProject retval, optional string projfn = reaper.EnumProjects(integer idx)
Python: (ReaProject retval, Int idx, String projfnOutOptional, Int projfnOutOptional_sz) = RPR_EnumProjects(idx, projfnOutOptional, projfnOutOptional_sz)
Description:Get ReaProject-object and filename of a project.
idx=-1 for current project,projfn can be NULL if not interested in filename. use idx 0x40000000 for currently rendering project, if any.
If you need the path to the recording-folder, use
GetProjectPath instead.
| Parameters: |
| integer idx | - | -1 for current project; 0 and higher for the projects; 0x40000000 for currently rendering project, if any.
|
| Returnvalues: |
| ReaProject retval | - | a ReaProject-object of the project you requested
|
| optional string projfn | - | the path+filename.rpp of the project. returns nil if no filename exists
|
^
EnumProjExtStateFunctioncall:
C: bool EnumProjExtState(ReaProject* proj, const char* extname, int idx, char* keyOutOptional, int keyOutOptional_sz, char* valOutOptional, int valOutOptional_sz)
EEL2: bool EnumProjExtState(ReaProject proj, "extname", int idx, optional #key, optional #val)
Lua: boolean retval, optional string key, optional string val = reaper.EnumProjExtState(ReaProject proj, string extname, integer idx)
Python: (Boolean retval, ReaProject proj, String extname, Int idx, String keyOutOptional, Int keyOutOptional_sz, String valOutOptional, Int valOutOptional_sz) = RPR_EnumProjExtState(proj, extname, idx, keyOutOptional, keyOutOptional_sz, valOutOptional, valOutOptional_sz)
Description:
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| string extname | - | the section of the extended-states
|
| integer idx | - | the id of the entry within "extname"-section to be returned; 0 for the first, 1 for the second, etc.
|
| Returnvalues: |
| boolean retval | - | true, key and value to this section exist; false, no such key and value exists
|
| string key | - | the idx'th key in the section
|
| string val | - | the accompanying value to key
|
^
EnumRegionRenderMatrixFunctioncall:
C: MediaTrack* EnumRegionRenderMatrix(ReaProject* proj, int regionindex, int rendertrack)
EEL2: MediaTrack EnumRegionRenderMatrix(ReaProject proj, int regionindex, int rendertrack)
Lua: MediaTrack = reaper.EnumRegionRenderMatrix(ReaProject proj, integer regionindex, integer rendertrack)
Python: MediaTrack RPR_EnumRegionRenderMatrix(ReaProject proj, Int regionindex, Int rendertrack)
Description:Enumerate which tracks will be rendered within this region when using the region render matrix. When called with rendertrack==0, the function returns the first track that will be rendered (which may be the master track); rendertrack==1 will return the next track rendered, and so on. The function returns NULL when there are no more tracks that will be rendered within this region.
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| integer regionindex | - |
|
| integer rendertrack | - |
|
| Returnvalues: |
| MediaTrack | - |
|
^
EnumTrackMIDIProgramNamesFunctioncall:
C: bool EnumTrackMIDIProgramNames(int track, int programNumber, char* programName, int programName_sz)
EEL2: bool EnumTrackMIDIProgramNames(int track, int programNumber, #programName)
Lua: boolean retval, string programName = reaper.EnumTrackMIDIProgramNames(integer track, integer programNumber, string programName)
Python: (Boolean retval, Int track, Int programNumber, String programName, Int programName_sz) = RPR_EnumTrackMIDIProgramNames(track, programNumber, programName, programName_sz)
Description:returns false if there are no plugins on the track that support MIDI programs,or if all programs have been enumerated
| Parameters: |
| integer track | - | |
| string programNumber | - | |
| string programName | - | |
| Returnvalues: |
| boolean retval | - | |
| string programName | - | |
^
EnumTrackMIDIProgramNamesExFunctioncall:
C: bool EnumTrackMIDIProgramNamesEx(ReaProject* proj, MediaTrack* track, int programNumber, char* programName, int programName_sz)
EEL2: bool EnumTrackMIDIProgramNamesEx(ReaProject proj, MediaTrack track, int programNumber, #programName)
Lua: boolean retval, string programName = reaper.EnumTrackMIDIProgramNamesEx(ReaProject proj, MediaTrack track, integer programNumber, string programName)
Python: (Boolean retval, ReaProject proj, MediaTrack track, Int programNumber, String programName, Int programName_sz) = RPR_EnumTrackMIDIProgramNamesEx(proj, track, programNumber, programName, programName_sz)
Description:returns false if there are no plugins on the track that support MIDI programs,or if all programs have been enumerated
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| MediaTrack track | - |
|
| integer programNumber | - |
|
| string programName | - |
|
| Returnvalues: |
| boolean retval | - |
|
| string programName | - |
|
^
Envelope_EvaluateFunctioncall:
C: int Envelope_Evaluate(TrackEnvelope* envelope, double time, double samplerate, int samplesRequested, double* valueOutOptional, double* dVdSOutOptional, double* ddVdSOutOptional, double* dddVdSOutOptional)
EEL2: int Envelope_Evaluate(TrackEnvelope envelope, time, samplerate, int samplesRequested, optional &value, optional &dVdS, optional &ddVdS, optional &dddVdS)
Lua: integer retval, optional number value, optional number dVdS, optional number ddVdS, optional number dddVdS = reaper.Envelope_Evaluate(TrackEnvelope envelope, number time, number samplerate, integer samplesRequested)
Python: (Int retval, TrackEnvelope envelope, Float time, Float samplerate, Int samplesRequested, Float valueOutOptional, Float dVdSOutOptional, Float ddVdSOutOptional, Float dddVdSOutOptional) = RPR_Envelope_Evaluate(envelope, time, samplerate, samplesRequested, valueOutOptional, dVdSOutOptional, ddVdSOutOptional, dddVdSOutOptional)
Description:Get the effective envelope value at a given time position.
samplesRequested is how long the caller expects until the next call to Envelope_Evaluate (often, the buffer block size).
The return value is how many samples beyond that time position that the returned values are valid.
dVdS is the change in value per sample (first derivative), ddVdS is the second derivative, dddVdS is the third derivative.
See
GetEnvelopeScalingMode.
| Parameters: |
| TrackEnvelope envelope | - |
|
| number time | - |
|
| number samplerate | - |
|
| integer samplesRequested | - |
|
| Returnvalues: |
| integer retval | - |
|
| optional number value | - |
|
| optional number dVdS | - | the change in value per sample (first derivative)
|
| optional number ddVdS | - | the second derivative
|
| optional number dddVdS | - | is the third derivative
|
^
Envelope_FormatValueFunctioncall:
C: void Envelope_FormatValue(TrackEnvelope* env, double value, char* bufOut, int bufOut_sz)
EEL2: Envelope_FormatValue(TrackEnvelope env, value, #buf)
Lua: string buf = reaper.Envelope_FormatValue(TrackEnvelope env, number value)
Python: (TrackEnvelope env, Float value, String bufOut, Int bufOut_sz) = RPR_Envelope_FormatValue(env, value, bufOut, bufOut_sz)
Description:Formats the value of an envelope to a user-readable form
| Parameters: |
| TrackEnvelope env | - | |
| number value | - | |
| Returnvalues: |
| string buf | - | |
^
Envelope_GetParentTakeFunctioncall:
C: MediaItem_Take* Envelope_GetParentTake(TrackEnvelope* env, int* indexOutOptional, int* index2OutOptional)
EEL2: MediaItem_Take Envelope_GetParentTake(TrackEnvelope env, optional int &index, optional int &index2)
Lua: MediaItem_Take retval, optional number index, optional number index2 = reaper.Envelope_GetParentTake(TrackEnvelope env)
Python: (MediaItem_Take retval, TrackEnvelope env, Int indexOutOptional, Int index2OutOptional) = RPR_Envelope_GetParentTake(env, indexOutOptional, index2OutOptional)
Description:If take envelope, gets the take from the envelope. If FX, indexOutOptional set to FX index, index2OutOptional set to parameter index, otherwise -1.
| Parameters: |
| TrackEnvelope env | - | |
| Returnvalues: |
| MediaItem_Take retval | - | |
| optional number index | - | |
| optional number index2 | - | |
^
Envelope_GetParentTrackFunctioncall:
C: MediaTrack* Envelope_GetParentTrack(TrackEnvelope* env, int* indexOutOptional, int* index2OutOptional)
EEL2: MediaTrack Envelope_GetParentTrack(TrackEnvelope env, optional int &index, optional int &index2)
Lua: MediaTrack retval, optional number index, optional number index2 = reaper.Envelope_GetParentTrack(TrackEnvelope env)
Python: (MediaTrack retval, TrackEnvelope env, Int indexOutOptional, Int index2OutOptional) = RPR_Envelope_GetParentTrack(env, indexOutOptional, index2OutOptional)
Description:If track envelope, gets the track from the envelope. If FX, indexOutOptional set to FX index, index2OutOptional set to parameter index, otherwise -1.
| Parameters: |
| TrackEnvelope env | - | |
| Returnvalues: |
| MediaTrack retval | - | |
| optional number index | - | |
| optional number index2 | - | |
^
Envelope_SortPointsFunctioncall:
C: bool Envelope_SortPoints(TrackEnvelope* envelope)
EEL2: bool Envelope_SortPoints(TrackEnvelope envelope)
Lua: boolean = reaper.Envelope_SortPoints(TrackEnvelope envelope)
Python: Boolean RPR_Envelope_SortPoints(TrackEnvelope envelope)
Description:
| Parameters: |
| TrackEnvelope envelope | - |
|
^
Envelope_SortPointsExFunctioncall:
C: bool Envelope_SortPointsEx(TrackEnvelope* envelope, int autoitem_idx)
EEL2: bool Envelope_SortPointsEx(TrackEnvelope envelope, int autoitem_idx)
Lua: boolean = reaper.Envelope_SortPointsEx(TrackEnvelope envelope, integer autoitem_idx)
Python: Boolean RPR_Envelope_SortPointsEx(TrackEnvelope envelope, Int autoitem_idx)
Description:
| Parameters: |
| TrackEnvelope envelope | - |
|
| integer autoitem_idx | - |
|
^
ExecProcessFunctioncall:
C: const char* ExecProcess(const char* cmdline, int timeoutmsec)
EEL2: bool ExecProcess(#retval, "cmdline", int timeoutmsec)
Lua: string = reaper.ExecProcess(string cmdline, integer timeoutmsec)
Python: String RPR_ExecProcess(String cmdline, Int timeoutmsec)
Description:Executes command line, returns NULL on total failure, otherwise the return value, a newline, and then the output of the command.
Commands executed with ExecProcess() don't benefit from PATH-system-variables. That said, you must give the full path to a command, even if you can usually just type the command into a shell. You also may need to set a codepage manually to get the correct character-encoding. So in some cases, writing a batch-script and executing it with ExecProcess() might be a good idea.
Note: when using this in Lua, you need to take care of the right file-separators: / on Mac and Linux or \ on Windows. Unlike other Lua/Lua-used-ReaScript-functions, this will not convert the file-separators to the current system's equivalent.
Keep that in mind, when doing multi-platform-scripts!
The base-directory is Reaper's appdirectory.
On Windows, you can not use command-line-internal commands, like dir or cd, directly. To use them, you need to use cmd.exe.
You can do it like:
- "$Path_to_Command_Exe\\cmd.exe /Q /C command"
where "/Q" executes cmd.exe silently(otherwise a command-line-window pops up; but output of commands will show anyway) and "/C command" executes command.
To get a full directory-listing of c:\\ in a file c:\\directorylisting.txt, you can use:
- "c:\\windows\\system32\\cmd.exe /Q /C dir c:\\ >c:\\directorylisting.txt"
| Parameters: |
| string cmdline | - | the command to execute |
| integer timeoutmsec | - | how long to wait, until termination of execution positive value, the time to wait for execution in milliseconds 0, command will be allowed to run indefinitely (recommended for large amounts of returned output). -1, for no wait/terminate -2, for no wait and minimize |
| Returnvalues: |
| string | - | return value, newline and output of the command; otherwise nil |
^
file_existsFunctioncall:
C: bool file_exists(const char* path)
EEL2: bool file_exists("path")
Lua: boolean = reaper.file_exists(string path)
Python: Boolean RPR_file_exists(String path)
Description:Checks, if a specified file exists and is readable.
returns true if path points to a valid, readable file
| Parameters: |
| string path | - | filename with path |
| Returnvalues: |
| boolean | - | true, if file exists; false, if it doesn't |
^
FindTempoTimeSigMarkerFunctioncall:
C: int FindTempoTimeSigMarker(ReaProject* project, double time)
EEL2: int FindTempoTimeSigMarker(ReaProject project, time)
Lua: integer = reaper.FindTempoTimeSigMarker(ReaProject project, number time)
Python: Int RPR_FindTempoTimeSigMarker(ReaProject project, Float time)
Description:Find the tempo/time signature marker that falls at or before this time position (the marker that is in effect as of this time position).
| Parameters: |
| ReaProject project | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| number time | - |
|
^
format_timestrFunctioncall:
C: void format_timestr(double tpos, char* buf, int buf_sz)
EEL2: format_timestr(tpos, #buf)
Lua: string buf = reaper.format_timestr(number tpos, string buf)
Python: (Float tpos, String buf, Int buf_sz) = RPR_format_timestr(tpos, buf, buf_sz)
Description:
| Parameters: |
| number tpos | - | the position in seconds, that you want to have formatted
|
| string buf | - | needed by Reaper, just set it to ""
|
| Returnvalues: |
| string buf | - | the formatted timestring
|
^
format_timestr_lenFunctioncall:
C: void format_timestr_len(double tpos, char* buf, int buf_sz, double offset, int modeoverride)
EEL2: format_timestr_len(tpos, #buf, offset, int modeoverride)
Lua: string buf = reaper.format_timestr_len(number tpos, string buf, number offset, integer modeoverride)
Python: (Float tpos, String buf, Int buf_sz, Float offset, Int modeoverride) = RPR_format_timestr_len(tpos, buf, buf_sz, offset, modeoverride)
Description:ime formatting mode overrides: -1=proj default.
0=time
1=measures.beats + time
2=measures.beats
3=seconds
4=samples
5=h:m:s:f
offset is start of where the length will be calculated from
| Parameters: |
| number tpos | - | |
| string buf | - | |
| number offset | - | |
| integer modeoverride | - | |
| Returnvalues: |
| string buf | - | |
^
format_timestr_posFunctioncall:
C: void format_timestr_pos(double tpos, char* buf, int buf_sz, int modeoverride)
EEL2: format_timestr_pos(tpos, #buf, int modeoverride)
Lua: string buf = reaper.format_timestr_pos(number tpos, string buf, integer modeoverride)
Python: (Float tpos, String buf, Int buf_sz, Int modeoverride) = RPR_format_timestr_pos(tpos, buf, buf_sz, modeoverride)
Description:ime formatting mode overrides: -1=proj default.
0=time
1=measures.beats + time
2=measures.beats
3=seconds
4=samples
5=h:m:s:f
| Parameters: |
| number tpos | - | |
| string buf | - | |
| integer modeoverride | - | |
| Returnvalues: |
| string buf | - | |
^
genGuidFunctioncall:
C: void genGuid(GUID* g)
EEL2: genGuid(#gGUID)
Lua: string gGUID = reaper.genGuid(string gGUID)
Python: RPR_genGuid(GUID g)
Description:Generates a GUID.
| Parameters: |
| string gGUID | - | unknown |
| Returnvalues: |
| string gGUID | - | the generated GUID |
^
get_config_var_stringFunctioncall:
C: bool get_config_var_string(const char* name, char* bufOut, int bufOut_sz)
EEL2: bool get_config_var_string("name", #buf)
Lua: boolean retval, string buf = reaper.get_config_var_string(string name)
Python: (Boolean retval, String name, String bufOut, Int bufOut_sz) = RPR_get_config_var_string(name, bufOut, bufOut_sz)
Description:
| Parameters: |
| string name | - | the config-var, whose value you want
|
| Returnvalues: |
| boolean retval | - | true, the configuration-variable is a valid string variable
|
| string buf | - | the current value of the configuration-variable
|
^
get_ini_fileFunctioncall:
C: const char* get_ini_file()
EEL2: bool get_ini_file(#retval)
Lua: string = reaper.get_ini_file()
Python: String RPR_get_ini_file()
Description:Get reaper.ini full filename+path.
| Returnvalues: |
| string | - | the reaper.ini with path |
^
GetActiveTakeFunctioncall:
C: MediaItem_Take* GetActiveTake(MediaItem* item)
EEL2: MediaItem_Take GetActiveTake(MediaItem item)
Lua: MediaItem_Take = reaper.GetActiveTake(MediaItem item)
Python: MediaItem_Take RPR_GetActiveTake(MediaItem item)
Description:get the active take in this item
| Parameters: |
| MediaItem item | - | the MediaItem, whose active take you want to have returned |
| Returnvalues: |
| MediaItem_Take | - | the active take of the MediaItem |
^
GetAllProjectPlayStatesFunctioncall:
C: int GetAllProjectPlayStates(ReaProject* ignoreProject)
EEL2: int GetAllProjectPlayStates(ReaProject ignoreProject)
Lua: integer = reaper.GetAllProjectPlayStates(ReaProject ignoreProject)
Python: Int RPR_GetAllProjectPlayStates(ReaProject ignoreProject)
Description:returns the bitwise OR of all project play states, eg. and project is playing/pausing/recording (1=playing, 2=pause, 4=recording)
| Parameters: |
| ReaProject ignoreProject | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| Returnvalues: |
| integer | - | the bitwise play-state of alle projects &1, at least one project is playing &2, at least one project is paused &4, at least one project is recording
|
^
GetAppVersionFunctioncall:
C: const char* GetAppVersion()
EEL2: bool GetAppVersion(#retval)
Lua: string = reaper.GetAppVersion()
Python: String RPR_GetAppVersion()
Description:Returns app version which may include an OS/arch signifier, such as: "6.17" (windows 32-bit), "6.17/x64" (windows 64-bit), "6.17/OSX64" (macOS 64-bit Intel), "6.17/OSX" (macOS 32-bit), "6.17/macOS-arm64", "6.17/linux-x86_64", "6.17/linux-i686", "6.17/linux-aarch64", "6.17/linux-armv7l", etc
| Returnvalues: |
| string | - | the returned version-number of Reaper |
^
GetAudioAccessorEndTimeFunctioncall:
C: double GetAudioAccessorEndTime(AudioAccessor* accessor)
EEL2: double GetAudioAccessorEndTime(AudioAccessor accessor)
Lua: number = reaper.GetAudioAccessorEndTime(AudioAccessor accessor)
Python: Float RPR_GetAudioAccessorEndTime(AudioAccessor accessor)
Description:
| Parameters: |
| AudioAccessor accessor | - | the AudioAccessor, whose end-time you want to have
|
| Returnvalues: |
| number | - | the length of the AudioAccessor
|
^
GetAudioAccessorHashFunctioncall:
C: void GetAudioAccessorHash(AudioAccessor* accessor, char* hashNeed128)
EEL2: GetAudioAccessorHash(AudioAccessor accessor, #hashNeed128)
Lua: string hashNeed128 = reaper.GetAudioAccessorHash(AudioAccessor accessor, string hashNeed128)
Python: (AudioAccessor accessor, String hashNeed128) = RPR_GetAudioAccessorHash(accessor, hashNeed128)
Description:
| Parameters: |
| AudioAccessor accessor | - |
|
| string hashNeed128 | - |
|
| Returnvalues: |
| string hashNeed128 | - |
|
^
GetAudioAccessorSamplesFunctioncall:
C: int GetAudioAccessorSamples(AudioAccessor* accessor, int samplerate, int numchannels, double starttime_sec, int numsamplesperchannel, double* samplebuffer)
EEL2: int GetAudioAccessorSamples(AudioAccessor accessor, int samplerate, int numchannels, starttime_sec, int numsamplesperchannel, buffer_ptr samplebuffer)
Lua: integer = reaper.GetAudioAccessorSamples(AudioAccessor accessor, integer samplerate, integer numchannels, number starttime_sec, integer numsamplesperchannel, reaper.array samplebuffer)
Python: (Int retval, AudioAccessor accessor, Int samplerate, Int numchannels, Float starttime_sec, Int numsamplesperchannel, Float samplebuffer) = RPR_GetAudioAccessorSamples(accessor, samplerate, numchannels, starttime_sec, numsamplesperchannel, samplebuffer)
Description:Get a block of samples from the audio accessor. Samples are extracted immediately pre-FX, and returned interleaved (first sample of first channel, first sample of second channel...). Returns 0 if no audio, 1 if audio, -1 on error. See
CreateTakeAudioAccessor,
CreateTrackAudioAccessor,
DestroyAudioAccessor,
AudioAccessorStateChanged,
GetAudioAccessorStartTime,
GetAudioAccessorEndTime.
This function has special handling in Python, and only returns two objects, the API function return value, and the sample buffer. Example usage:
tr = RPR_GetTrack(0, 0)
aa = RPR_CreateTrackAudioAccessor(tr)
buf = list([0]*2*1024) # 2 channels, 1024 samples each, initialized to zero
pos = 0.0
(ret, buf) = GetAudioAccessorSamples(aa, 44100, 2, pos, 1024, buf)
# buf now holds the first 2*1024 audio samples from the track.
# typically GetAudioAccessorSamples() would be called within a loop, increasing pos each time.
| Parameters: |
| AudioAccessor accessor | - |
|
| integer samplerate | - |
|
| integer numchannels | - |
|
| number starttime_sec | - |
|
| integer numsamplesperchannel | - |
|
| reaper.array samplebuffer | - |
|
^
GetAudioAccessorStartTimeFunctioncall:
C: double GetAudioAccessorStartTime(AudioAccessor* accessor)
EEL2: double GetAudioAccessorStartTime(AudioAccessor accessor)
Lua: number = reaper.GetAudioAccessorStartTime(AudioAccessor accessor)
Python: Float RPR_GetAudioAccessorStartTime(AudioAccessor accessor)
Description:
| Parameters: |
| AudioAccessor accessor | - |
|
^
GetAudioDeviceInfoFunctioncall:
C: bool GetAudioDeviceInfo(const char* attribute, char* desc, int desc_sz)
EEL2: bool GetAudioDeviceInfo("attribute", #desc)
Lua: boolean retval, string desc = reaper.GetAudioDeviceInfo(string attribute, string desc)
Python: (Boolean retval, String attribute, String desc, Int desc_sz) = RPR_GetAudioDeviceInfo(attribute, desc, desc_sz)
Description:get information about the currently open audio device.
Attribute can be MODE, IDENT_IN, IDENT_OUT, BSIZE, SRATE, BPS.
returns false if unknown attribute or device not open.
| Parameters: |
| string attribute | - | the attribute to get, as set in Preferences -> Device MODE - the Audio system selected IDENT_IN - the selected Input device IDENT_OUT - the selected Output device BSIZE - the Buffer-sample-size (not the multiplier!) SRATE - the samplerate in Hz BPS - the sample-format (e.g 16, 24, 32 bit)
|
| string desc | - | a string the API needs to return the value; in Lua set it to ""
|
| Returnvalues: |
| boolean retval | - | true, if returning a value is possible; false, if not(unknown attribute or device not open)
|
| string desc | - | the returned value; will not return a value, if Preferences are opened
|
^
GetConfigWantsDockFunctioncall:
C: int GetConfigWantsDock(const char* ident_str)
EEL2: int GetConfigWantsDock("ident_str")
Lua: integer = reaper.GetConfigWantsDock(string ident_str)
Python: Int RPR_GetConfigWantsDock(String ident_str)
Description:gets the dock ID desired by ident_str, if any
| Parameters: |
| string ident_str | - | |
^
GetCurrentProjectInLoadSaveFunctioncall:
C: ReaProject* GetCurrentProjectInLoadSave()
EEL2: ReaProject GetCurrentProjectInLoadSave()
Lua: ReaProject = reaper.GetCurrentProjectInLoadSave()
Python: ReaProject RPR_GetCurrentProjectInLoadSave()
Description:returns current project if in load/save (usually only used from project_config_extension_t)
| Returnvalues: |
| ReaProject | - | |
^
GetCursorContextFunctioncall:
C: int GetCursorContext()
EEL2: int GetCursorContext()
Lua: integer = reaper.GetCursorContext()
Python: Int RPR_GetCursorContext()
Description:return the current cursor context.
| Returnvalues: |
| integer | - | the cursor context
-1, unknown
0, track panels
1, items
2, envelopes |
^
GetCursorContext2Functioncall:
C: int GetCursorContext2(bool want_last_valid)
EEL2: int GetCursorContext2(bool want_last_valid)
Lua: integer = reaper.GetCursorContext2(boolean want_last_valid)
Python: Int RPR_GetCursorContext2(Boolean want_last_valid)
Description:0 if track panels, 1 if items, 2 if envelopes, otherwise unknown (unlikely when want_last_valid is true)
| Parameters: |
| boolean want_last_valid | - | true, get the last valid context; false, get the current context |
| Returnvalues: |
| integer | - | the cursor context
-1, unknown
0, track panels
1, items
2, envelopes |
^
GetCursorPositionFunctioncall:
C: double GetCursorPosition()
EEL2: double GetCursorPosition()
Lua: number = reaper.GetCursorPosition()
Python: Float RPR_GetCursorPosition()
Description:edit cursor position
| Returnvalues: |
| number | - | the editcursor-position in seconds |
^
GetCursorPositionExFunctioncall:
C: double GetCursorPositionEx(ReaProject* proj)
EEL2: double GetCursorPositionEx(ReaProject proj)
Lua: number = reaper.GetCursorPositionEx(ReaProject proj)
Python: Float RPR_GetCursorPositionEx(ReaProject proj)
Description:Get the edit cursor position in a given project
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| Returnvalues: |
| number | - | the position in seconds
|
^
GetDisplayedMediaItemColorFunctioncall:
C: int GetDisplayedMediaItemColor(MediaItem* item)
EEL2: int GetDisplayedMediaItemColor(MediaItem item)
Lua: integer = reaper.GetDisplayedMediaItemColor(MediaItem item)
Python: Int RPR_GetDisplayedMediaItemColor(MediaItem item)
Description:
| Parameters: |
| MediaItem item | - |
|
^
GetDisplayedMediaItemColor2Functioncall:
C: int GetDisplayedMediaItemColor2(MediaItem* item, MediaItem_Take* take)
EEL2: int GetDisplayedMediaItemColor2(MediaItem item, MediaItem_Take take)
Lua: integer = reaper.GetDisplayedMediaItemColor2(MediaItem item, MediaItem_Take take)
Python: Int RPR_GetDisplayedMediaItemColor2(MediaItem item, MediaItem_Take take)
Description:Returns the custom take, item, or track color that is used (according to the user preference) to color the media item. The returned color is OS dependent|0x01000000 (i.e. ColorToNative(r,g,b)|0x01000000), so a return of zero means "no color", not black.
| Parameters: |
| MediaItem item | - | |
| MediaItem_Take take | - | |
^
GetEnvelopeInfo_ValueFunctioncall:
C: double GetEnvelopeInfo_Value(TrackEnvelope* env, const char* parmname)
EEL2: double GetEnvelopeInfo_Value(TrackEnvelope env, "parmname")
Lua: number retval = reaper.GetEnvelopeInfo_Value(TrackEnvelope env, string parmname)
Python: Float RPR_GetEnvelopeInfo_Value(TrackEnvelope env, String parmname)
Description:Gets an envelope numerical-value attribute:
I_TCPY : int *, Y offset of envelope relative to parent track (may be separate lane or overlap with track contents)
I_TCPH : int *, visible height of envelope
I_TCPY_USED : int *, Y offset of envelope relative to parent track, exclusive of padding
I_TCPH_USED : int *, visible height of envelope, exclusive of padding
P_TRACK : MediaTrack *, parent track pointer (if any)
P_ITEM : MediaItem *, parent item pointer (if any)
P_TAKE : MediaItem_Take *, parent take pointer (if any)
| Parameters: |
| TrackEnvelope env | - | the TrackEnvelope, of which you want to retrieve the attribute-value |
| string parmname | - | the attribute, whose value you want; can be I_TCPY, I_TCPH, I_TCPY_USED, I_TCPH_USED, P_TRACK, P_ITEM, P_TAKE see description for more details |
| Returnvalues: |
| number retval | - | the returned value of the attribute |
^
GetEnvelopeNameFunctioncall:
C: bool GetEnvelopeName(TrackEnvelope* env, char* bufOut, int bufOut_sz)
EEL2: bool GetEnvelopeName(TrackEnvelope env, #buf)
Lua: boolean retval, string buf = reaper.GetEnvelopeName(TrackEnvelope env, string buf)
Python: (Boolean retval, TrackEnvelope env, String bufOut, Int bufOut_sz) = RPR_GetEnvelopeName(env, bufOut, bufOut_sz)
Description:
| Parameters: |
| TrackEnvelope env | - | |
| string buf | - | |
| Returnvalues: |
| boolean retval | - | |
| string buf | - | |
^
GetEnvelopePointFunctioncall:
C: bool GetEnvelopePoint(TrackEnvelope* envelope, int ptidx, double* timeOutOptional, double* valueOutOptional, int* shapeOutOptional, double* tensionOutOptional, bool* selectedOutOptional)
EEL2: bool GetEnvelopePoint(TrackEnvelope envelope, int ptidx, optional &time, optional &value, optional int &shape, optional &tension, optional bool &selected)
Lua: boolean retval, optional number time, optional number value, optional number shape, optional number tension, optional boolean selected = reaper.GetEnvelopePoint(TrackEnvelope envelope, integer ptidx)
Python: (Boolean retval, TrackEnvelope envelope, Int ptidx, Float timeOutOptional, Float valueOutOptional, Int shapeOutOptional, Float tensionOutOptional, Boolean selectedOutOptional) = RPR_GetEnvelopePoint(envelope, ptidx, timeOutOptional, valueOutOptional, shapeOutOptional, tensionOutOptional, selectedOutOptional)
Description:
| Parameters: |
| TrackEnvelope envelope | - |
|
| integer ptidx | - |
|
| Returnvalues: |
| boolean retval | - |
|
| optional number time | - |
|
| optional number value | - |
|
| optional number shape | - |
|
| optional number tension | - |
|
| optional boolean selected | - |
|
^
GetEnvelopePointByTimeFunctioncall:
C: int GetEnvelopePointByTime(TrackEnvelope* envelope, double time)
EEL2: int GetEnvelopePointByTime(TrackEnvelope envelope, time)
Lua: integer = reaper.GetEnvelopePointByTime(TrackEnvelope envelope, number time)
Python: Int RPR_GetEnvelopePointByTime(TrackEnvelope envelope, Float time)
Description:
| Parameters: |
| TrackEnvelope envelope | - |
|
| number time | - |
|
^
GetEnvelopePointByTimeExFunctioncall:
C: int GetEnvelopePointByTimeEx(TrackEnvelope* envelope, int autoitem_idx, double time)
EEL2: int GetEnvelopePointByTimeEx(TrackEnvelope envelope, int autoitem_idx, time)
Lua: integer = reaper.GetEnvelopePointByTimeEx(TrackEnvelope envelope, integer autoitem_idx, number time)
Python: Int RPR_GetEnvelopePointByTimeEx(TrackEnvelope envelope, Int autoitem_idx, Float time)
Description:Returns the envelope point at or immediately prior to the given time position.
autoitem_idx=-1 for the underlying envelope, 0 for the first automation item on the envelope, etc.
For automation items, pass autoitem_idx|0x10000000 to base ptidx on the number of points in one full loop iteration,
even if the automation item is trimmed so that not all points are visible.
Otherwise, ptidx will be based on the number of visible points in the automation item, including all loop iterations.
See
GetEnvelopePointEx,
SetEnvelopePointEx,
InsertEnvelopePointEx,
DeleteEnvelopePointEx.
| Parameters: |
| TrackEnvelope envelope | - |
|
| integer autoitem_idx | - |
|
| number time | - |
|
^
GetEnvelopePointExFunctioncall:
C: bool GetEnvelopePointEx(TrackEnvelope* envelope, int autoitem_idx, int ptidx, double* timeOutOptional, double* valueOutOptional, int* shapeOutOptional, double* tensionOutOptional, bool* selectedOutOptional)
EEL2: bool GetEnvelopePointEx(TrackEnvelope envelope, int autoitem_idx, int ptidx, optional &time, optional &value, optional int &shape, optional &tension, optional bool &selected)
Lua: boolean retval, optional number time, optional number value, optional number shape, optional number tension, optional boolean selected = reaper.GetEnvelopePointEx(TrackEnvelope envelope, integer autoitem_idx, integer ptidx)
Python: (Boolean retval, TrackEnvelope envelope, Int autoitem_idx, Int ptidx, Float timeOutOptional, Float valueOutOptional, Int shapeOutOptional, Float tensionOutOptional, Boolean selectedOutOptional) = RPR_GetEnvelopePointEx(envelope, autoitem_idx, ptidx, timeOutOptional, valueOutOptional, shapeOutOptional, tensionOutOptional, selectedOutOptional)
Description:Get the attributes of an envelope point.
autoitem_idx=-1 for the underlying envelope, 0 for the first automation item on the envelope, etc.
For automation items, pass autoitem_idx|0x10000000 to base ptidx on the number of points in one full loop iteration,
even if the automation item is trimmed so that not all points are visible.
Otherwise, ptidx will be based on the number of visible points in the automation item, including all loop iterations.
See
CountEnvelopePointsEx,
SetEnvelopePointEx,
InsertEnvelopePointEx,
DeleteEnvelopePointEx.
| Parameters: |
| TrackEnvelope envelope | - |
|
| integer autoitem_idx | - |
|
| integer ptidx | - |
|
| Returnvalues: |
| boolean retval | - |
|
| optional number time | - |
|
| optional number value | - |
|
| optional number shape | - |
|
| optional number tension | - |
|
| optional boolean selected | - |
|
^
GetEnvelopeScalingModeFunctioncall:
C: int GetEnvelopeScalingMode(TrackEnvelope* env)
EEL2: int GetEnvelopeScalingMode(TrackEnvelope env)
Lua: integer = reaper.GetEnvelopeScalingMode(TrackEnvelope env)
Python: Int RPR_GetEnvelopeScalingMode(TrackEnvelope env)
Description:Returns the envelope scaling mode: 0=no scaling, 1=fader scaling. All API functions deal with raw envelope point values, to convert raw from/to scaled values see
ScaleFromEnvelopeMode,
ScaleToEnvelopeMode.
| Parameters: |
| TrackEnvelope env | - |
|
^
GetEnvelopeStateChunkFunctioncall:
C: bool GetEnvelopeStateChunk(TrackEnvelope* env, char* strNeedBig, int strNeedBig_sz, bool isundoOptional)
EEL2: bool GetEnvelopeStateChunk(TrackEnvelope env, #str, bool isundo)
Lua: boolean retval, string str = reaper.GetEnvelopeStateChunk(TrackEnvelope env, string str, boolean isundo)
Python: (Boolean retval, TrackEnvelope env, String strNeedBig, Int strNeedBig_sz, Boolean isundoOptional) = RPR_GetEnvelopeStateChunk(env, strNeedBig, strNeedBig_sz, isundoOptional)
Description:Gets the RPPXML state of an envelope.
| Parameters: |
| TrackEnvelope env | - | the Track-Envelope-object, whose trackstate you want to have
|
| string str | - | just pass "" to it
|
| boolean isundo | - | Undo flag is a performance/caching hint.
|
| Returnvalues: |
| boolean retval | - | true, if it's successful; false, if unsuccessful
|
| string str | - | the state-chunk
|
^
GetExePathFunctioncall:
C: const char* GetExePath()
EEL2: bool GetExePath(#retval)
Lua: string = reaper.GetExePath()
Python: String RPR_GetExePath()
Description:returns path of REAPER.exe (not including EXE), i.e. C:\Program Files\REAPER
| Returnvalues: |
| string | - | the path to the reaper.exe or reaper.app |
^
GetExtStateFunctioncall:
C: const char* GetExtState(const char* section, const char* key)
EEL2: bool GetExtState(#retval, "section", "key")
Lua: string = reaper.GetExtState(string section, string key)
Python: String RPR_GetExtState(String section, String key)
Description:
| Parameters: |
| string section | - | the section, in which the key and value is stored
|
| string key | - | the key, that contains the value
|
| Returnvalues: |
| string | - | the value
|
^
GetFocusedFXFunctioncall:
C: int GetFocusedFX(int* tracknumberOut, int* itemnumberOut, int* fxnumberOut)
EEL2: int GetFocusedFX(int &tracknumber, int &itemnumber, int &fxnumber)
Lua: integer retval, integer tracknumber, integer itemnumber, integer fxnumber = reaper.GetFocusedFX()
Python: (Int retval, Int tracknumberOut, Int itemnumberOut, Int fxnumberOut) = RPR_GetFocusedFX(tracknumberOut, itemnumberOut, fxnumberOut)
Description:
| Returnvalues: |
| integer retval | - | 0, if no FX window has focus 1, if a track FX window has focus or was the last focused and still open 2, if an item FX window has focus or was the last focused and still open
|
| integer tracknumber | - | tracknumber; 0, master track; 1, track 1; etc.
|
| integer itemnumber | - | -1, if it's a track-fx; 0 and higher, the mediaitem-number
|
| integer fxnumber | - | If item FX, fxnumber will have the high word be the take index, the low word the FX index
|
^
GetFocusedFX2Functioncall:
C: int GetFocusedFX2(int* tracknumberOut, int* itemnumberOut, int* fxnumberOut)
EEL2: int GetFocusedFX2(int &tracknumber, int &itemnumber, int &fxnumber)
Lua: integer retval, number tracknumber, number itemnumber, number fxnumber = reaper.GetFocusedFX2()
Python: (Int retval, Int tracknumberOut, Int itemnumberOut, Int fxnumberOut) = RPR_GetFocusedFX2(tracknumberOut, itemnumberOut, fxnumberOut)
Description:Return value has 1 set if track FX, 2 if take/item FX, 4 set if FX is no longer focused but still open.
tracknumber==0 means the master track, 1 means track 1, etc. itemnumber is zero-based (or -1 if not an item).
For interpretation of fxnumber, see
GetLastTouchedFX.
| Returnvalues: |
| integer retval | - | 0, if no FX window has focus 1, if a track FX window has focus or was the last focused and still open 2, if an item FX window has focus or was the last focused and still open 4, if FX is no longer focused but still open
|
| integer tracknumber | - | tracknumber; 0, master track; 1, track 1; etc.
|
| integer itemnumber | - | -1, if it's a track-fx; 0 and higher, the mediaitem-number
|
| integer fxnumber | - | If item FX, fxnumber will have the high word be the take index, the low word the FX index
|
^
GetFreeDiskSpaceForRecordPathFunctioncall:
C: int GetFreeDiskSpaceForRecordPath(ReaProject* proj, int pathidx)
EEL2: int GetFreeDiskSpaceForRecordPath(ReaProject proj, int pathidx)
Lua: integer = reaper.GetFreeDiskSpaceForRecordPath(ReaProject proj, integer pathidx)
Python: Int RPR_GetFreeDiskSpaceForRecordPath(ReaProject proj, Int pathidx)
Description:returns free disk space in megabytes, pathIdx 0 for normal, 1 for alternate.
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| integer pathidx | - | recording path; 0, primary recording path; 1, secondary recording path
|
| Returnvalues: |
| integer | - | the freedisk-size in megabytes
|
^
GetFXEnvelopeFunctioncall:
C: TrackEnvelope* GetFXEnvelope(MediaTrack* track, int fxindex, int parameterindex, bool create)
EEL2: TrackEnvelope GetFXEnvelope(MediaTrack track, int fxindex, int parameterindex, bool create)
Lua: TrackEnvelope = reaper.GetFXEnvelope(MediaTrack track, integer fxindex, integer parameterindex, boolean create)
Python: TrackEnvelope RPR_GetFXEnvelope(MediaTrack track, Int fxindex, Int parameterindex, Boolean create)
Description:Returns the FX parameter envelope. If the envelope does not exist and create=true, the envelope will be created.
| Parameters: |
| MediaTrack track | - | |
| integer fxindex | - | |
| integer parameterindex | - | |
| boolean create | - | |
| Returnvalues: |
| TrackEnvelope | - | |
^
GetGlobalAutomationOverrideFunctioncall:
C: int GetGlobalAutomationOverride()
EEL2: int GetGlobalAutomationOverride()
Lua: integer = reaper.GetGlobalAutomationOverride()
Python: Int RPR_GetGlobalAutomationOverride()
Description:return -1=no override, 0=trim/read, 1=read, 2=touch, 3=write, 4=latch, 5=bypass
^
GetHZoomLevelFunctioncall:
C: double GetHZoomLevel()
EEL2: double GetHZoomLevel()
Lua: number = reaper.GetHZoomLevel()
Python: Float RPR_GetHZoomLevel()
Description:returns pixels/second
| Returnvalues: |
| number | - | pixels/shown arrange-view-second |
^
GetInputChannelNameFunctioncall:
C: const char* GetInputChannelName(int channelIndex)
EEL2: bool GetInputChannelName(#retval, int channelIndex)
Lua: string = reaper.GetInputChannelName(integer channelIndex)
Python: String RPR_GetInputChannelName(Int channelIndex)
Description:Returns the name of a input-channel.
| Parameters: |
| integer channelIndex | - | the index of the input-channels, with 0 for the first, 1 for the second, etc. |
| Returnvalues: |
| string | - | the name of the input-channel. |
^
GetInputOutputLatencyFunctioncall:
C: void GetInputOutputLatency(int* inputlatencyOut, int* outputLatencyOut)
EEL2: GetInputOutputLatency(int &inputlatency, int &outputLatency)
Lua: number inputlatency retval, number outputLatency = reaper.GetInputOutputLatency()
Python: (Int inputlatencyOut, Int outputLatencyOut) = RPR_GetInputOutputLatency(inputlatencyOut, outputLatencyOut)
Description:Gets the audio device input/output latency in samples
| Returnvalues: |
| integer inputlatency retval | - | the input-latency |
| integer outputLatency | - | the output-latency |
^
GetItemEditingTime2Functioncall:
C: double GetItemEditingTime2(PCM_source** which_itemOut, int* flagsOut)
EEL2: double GetItemEditingTime2(PCM_source &which_item, int &flags)
Lua: number position, PCM_source which_item, number flags = reaper.GetItemEditingTime2()
Python: (Float retval, PCM_source* which_itemOut, Int flagsOut) = RPR_GetItemEditingTime2(which_itemOut, flagsOut)
Description:returns time of relevant edit, set which_item to the pcm_source (if applicable), flags (if specified) will be set to 1 for edge resizing, 2 for fade change, 4 for item move, 8 for item slip edit (edit cursor time or start of item)
| Returnvalues: |
| number position | - | |
| PCM_source which_item | - | |
| number flags | - | |
^
GetItemFromPointFunctioncall:
C: MediaItem* GetItemFromPoint(int screen_x, int screen_y, bool allow_locked, MediaItem_Take** takeOutOptional)
EEL2: MediaItem GetItemFromPoint(int screen_x, int screen_y, bool allow_locked, MediaItem_Take &take)
Lua: MediaItem, MediaItem_Take take = reaper.GetItemFromPoint(integer screen_x, integer screen_y, boolean allow_locked)
Python: MediaItem RPR_GetItemFromPoint(Int screen_x, Int screen_y, Boolean allow_locked, MediaItem_Take* takeOutOptional)
Description:Returns the first item at the screen coordinates specified. If allow_locked is false, locked items are ignored. If takeOutOptional specified, returns the take hit(in Lua, this function simply returns the take as additional return-value).
Note: You can not get the item at screen-coordinates, where it is hidden by other windows.
| Parameters: |
| integer screen_x | - | the x-position in pixels |
| integer screen_y | - | the y-position in pixels |
| boolean allow_locked | - | true, allow getting locked items as well; false, don't get locked items |
| Returnvalues: |
| MediaItem | - | the MediaItem at the position |
| MediaItem_Take take | - | the MediaItem_Take at the position |
^
GetItemProjectContextFunctioncall:
C: ReaProject* GetItemProjectContext(MediaItem* item)
EEL2: ReaProject GetItemProjectContext(MediaItem item)
Lua: ReaProject = reaper.GetItemProjectContext(MediaItem item)
Python: ReaProject RPR_GetItemProjectContext(MediaItem item)
Description:Returns the project, in which a MediaItem is located.
| Parameters: |
| MediaItem item | - | the MediaItem, whose project-location you want to know |
| Returnvalues: |
| ReaProject | - | the project, in which the MediaItem is located; returned as a reaper-object |
^
GetItemStateChunkFunctioncall:
C: bool GetItemStateChunk(MediaItem* item, char* strNeedBig, int strNeedBig_sz, bool isundoOptional)
EEL2: bool GetItemStateChunk(MediaItem item, #str, bool isundo)
Lua: boolean retval, string str = reaper.GetItemStateChunk(MediaItem item, string str, boolean isundo)
Python: (Boolean retval, MediaItem item, String strNeedBig, Int strNeedBig_sz, Boolean isundoOptional) = RPR_GetItemStateChunk(item, strNeedBig, strNeedBig_sz, isundoOptional)
Description:Gets the RPPXML state of an item, returns true if successful. Undo flag is a performance/caching hint.
| Parameters: |
| MediaItem item | - | the MediaItem, whose statechunk you want
|
| string str | - | just pass "" to it
|
| boolean isundo | - | Undo flag is a performance/caching hint.
|
| Returnvalues: |
| boolean retval | - | true, getting statechunk was successful
|
| string str | - | the statechunk of the MediaItem
|
^
GetLastColorThemeFileFunctioncall:
C: const char* GetLastColorThemeFile()
EEL2: bool GetLastColorThemeFile(#retval)
Lua: string = reaper.GetLastColorThemeFile()
Python: String RPR_GetLastColorThemeFile()
Description:Get the last used color-theme-file.
| Returnvalues: |
| string | - | the path and filename of the last used theme |
^
GetLastMarkerAndCurRegionFunctioncall:
C: void GetLastMarkerAndCurRegion(ReaProject* proj, double time, int* markeridxOut, int* regionidxOut)
EEL2: GetLastMarkerAndCurRegion(ReaProject proj, time, int &markeridx, int ®ionidx)
Lua: integer markeridx retval, integer regionidx = reaper.GetLastMarkerAndCurRegion(ReaProject proj, number time)
Python: (ReaProject proj, Float time, Int markeridxOut, Int regionidxOut) = RPR_GetLastMarkerAndCurRegion(proj, time, markeridxOut, regionidxOut)
Description:Get the last project marker before time, and/or the project region that includes time.
markeridx and regionidx are returned not necessarily as the displayed marker/region index, but as the index that can be passed to EnumProjectMarkers. Either or both of markeridx and regionidx may be NULL. See
EnumProjectMarkers.
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| number time | - | the position to check in seconds
|
| Returnvalues: |
| integer markeridx retval | - | the last marker-number(not shown number!) before parameter time
|
| integer regionidx | - | the region, in which parameter time lies
|
^
GetLastTouchedFXFunctioncall:
C: bool GetLastTouchedFX(int* tracknumberOut, int* fxnumberOut, int* paramnumberOut)
EEL2: bool GetLastTouchedFX(int &tracknumber, int &fxnumber, int ¶mnumber)
Lua: boolean retval, integer tracknumber, integer fxnumber, integer paramnumber = reaper.GetLastTouchedFX()
Python: (Boolean retval, Int tracknumberOut, Int fxnumberOut, Int paramnumberOut) = RPR_GetLastTouchedFX(tracknumberOut, fxnumberOut, paramnumberOut)
Description:Returns the last touched track, it's last touched parameter and tracknumber.
The low word of tracknumber is the 1-based track index -- 0 means the master track, 1 means track 1, etc.
See
GetFocusedFX2.
| Returnvalues: |
| boolean retval | - | true, if last touched FX parameter is valid; false, if otherwise
|
| integer tracknumber | - | the tracknumber; 0 means the master track, 1 means track 1, etc. If the high word of tracknumber is nonzero, it refers to the 1-based item index (1 is the first item on the track, etc).
|
| integer fxnumber | - | the id of the FX in the track tracknumber, zero-based For track FX, the low 24 bits of fxnumber refer to the FX index in the chain, and if the next 8 bits are 01, then the FX is record FX. For item FX, the low word defines the FX index in the chain, and the high word defines the take number.
|
| integer paramnumber | - | the id of the last parameter touched, zero-based
|
^
GetLastTouchedTrackFunctioncall:
C: MediaTrack* GetLastTouchedTrack()
EEL2: MediaTrack GetLastTouchedTrack()
Lua: MediaTrack = reaper.GetLastTouchedTrack()
Python: MediaTrack RPR_GetLastTouchedTrack()
Description:Gets the MediaTrack, that has been last touched.
| Returnvalues: |
| MediaTrack | - | the last touched MediaTrack as an object |
^
GetMainHwndFunctioncall:
C: HWND GetMainHwnd()
EEL2: HWND GetMainHwnd()
Lua: HWND hwnd = reaper.GetMainHwnd()
Python: HWND RPR_GetMainHwnd()
Description:Get the Reaper-window as an HWND-object
| Returnvalues: |
| HWND hwnd | - | the Reaper-Window |
^
GetMasterMuteSoloFlagsFunctioncall:
C: int GetMasterMuteSoloFlags()
EEL2: int GetMasterMuteSoloFlags()
Lua: integer mastermutesolo = reaper.GetMasterMuteSoloFlags()
Python: Int RPR_GetMasterMuteSoloFlags()
Description:Deprecated: Get the mute/solo-state of the master-track. This is deprecated as you can just query the master track as well.
| Returnvalues: |
| integer mastermutesolo | - | state of mute/solo of the master-track; &1=master mute,&2=master solo. |
^
GetMasterTrackFunctioncall:
C: MediaTrack* GetMasterTrack(ReaProject* proj)
EEL2: MediaTrack GetMasterTrack(ReaProject proj)
Lua: MediaTrack track = reaper.GetMasterTrack(ReaProject proj)
Python: MediaTrack RPR_GetMasterTrack(ReaProject proj)
Description:Get a MediaTrack-object of the MasterTrack.
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| Returnvalues: |
| MediaTrack track | - | the MediaTrack-object of the MasterTrack
|
^
GetMasterTrackVisibilityFunctioncall:
C: int GetMasterTrackVisibility()
EEL2: int GetMasterTrackVisibility()
Lua: integer master_visibility = reaper.GetMasterTrackVisibility()
Python: Int RPR_GetMasterTrackVisibility()
Description:
| Returnvalues: |
| integer master_visibility | - | state of visibility of the master-track &1 - 1, master track visible in tcp; 0, master track invisible in mixer &2 - 2, master track invisible in mixer; 0, master track visible in mixer
|
^
GetMaxMidiInputsFunctioncall:
C: int GetMaxMidiInputs()
EEL2: int GetMaxMidiInputs()
Lua: integer = reaper.GetMaxMidiInputs()
Python: Int RPR_GetMaxMidiInputs()
Description:returns max dev for midi inputs
| Returnvalues: |
| integer | - | the number of max midi inputs |
^
GetMaxMidiOutputsFunctioncall:
C: int GetMaxMidiOutputs()
EEL2: int GetMaxMidiOutputs()
Lua: integer = reaper.GetMaxMidiOutputs()
Python: Int RPR_GetMaxMidiOutputs()
Description:returns max dev for midi outputs
| Returnvalues: |
| integer | - | the number of max midi outputs |
^
GetMediaFileMetadataFunctioncall:
C: int GetMediaFileMetadata(PCM_source* mediaSource, const char* identifier, char* bufOutNeedBig, int bufOutNeedBig_sz)
EEL2: int GetMediaFileMetadata(PCM_source mediaSource, "identifier", #buf)
Lua: integer retval, string buf = reaper.GetMediaFileMetadata(PCM_source mediaSource, string identifier)
Python: (Int retval, PCM_source mediaSource, String identifier, String bufOutNeedBig, Int bufOutNeedBig_sz) = RPR_GetMediaFileMetadata(mediaSource, identifier, bufOutNeedBig, bufOutNeedBig_sz)
Description:Get text-based metadata from a media file for a given identifier. Call with identifier="" to list all identifiers contained in the file, separated by newlines. May return "[Binary data]" for metadata that REAPER doesn't handle.
| Parameters: |
| PCM_source mediaSource | - | the PCM-source of a file, whose metadata you want to get |
| string identifier | - | the identifier; use "" to get all availbale identifier from the sourcefile |
| Returnvalues: |
| integer retval | - | 0, identifier not available; 1, identifier available |
| string buf | - | the returned metadata-value of the identifier |
^
GetMediaItemFunctioncall:
C: MediaItem* GetMediaItem(ReaProject* proj, int itemidx)
EEL2: MediaItem GetMediaItem(ReaProject proj, int itemidx)
Lua: MediaItem = reaper.GetMediaItem(ReaProject proj, integer itemidx)
Python: MediaItem RPR_GetMediaItem(ReaProject proj, Int itemidx)
Description:get an item from a project by item count (zero-based)
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| integer itemidx | - | the number of the item within the whole project; 0 for the first, 1 for the second, etc; numberingorder depending on, when was a MediaItem added to the project(recording, import, etc)
|
| Returnvalues: |
| MediaItem | - | the requested MediaItem as a MediaItem-object
|
^
GetMediaItem_TrackFunctioncall:
C: MediaTrack* GetMediaItem_Track(MediaItem* item)
EEL2: MediaTrack GetMediaItem_Track(MediaItem item)
Lua: MediaTrack track = reaper.GetMediaItem_Track(MediaItem item)
Python: MediaTrack RPR_GetMediaItem_Track(MediaItem item)
Description:Get parent track of media item
| Parameters: |
| MediaItem item | - | the MediaItem, whose track you want to know |
| Returnvalues: |
| MediaTrack track | - | the returned MediaTrack, in which the MediaItem lies |
^
GetArmedCommandFunctioncall:
C: int GetArmedCommand(char* secOut, int secOut_sz)
EEL2: int GetArmedCommand(#sec)
Lua: integer retval, string sec = reaper.GetArmedCommand()
Python: (Int retval, String secOut, Int secOut_sz) = RPR_GetArmedCommand(secOut, secOut_sz)
Description:gets the currently armed command and section name (returns 0 if nothing armed). section name is empty-string for main section.
| Returnvalues: |
| integer retval | - | |
| string sec | - | |
^
ArmCommandFunctioncall:
C: void ArmCommand(int cmd, const char* sectionname)
EEL2: ArmCommand(int cmd, "sectionname")
Lua: reaper.ArmCommand(integer cmd, string sectionname)
Python: RPR_ArmCommand(Int cmd, String sectionname)
Description:arms a command (or disarms if 0 passed) in section sectionname (empty string for main)
| Parameters: |
| integer cmd | - | |
| string sectionname | - | |
^
GetMediaItemInfo_ValueFunctioncall:
C: double GetMediaItemInfo_Value(MediaItem* item, const char* parmname)
EEL2: double GetMediaItemInfo_Value(MediaItem item, "parmname")
Lua: number retval = reaper.GetMediaItemInfo_Value(MediaItem item, string parmname)
Python: Float RPR_GetMediaItemInfo_Value(MediaItem item, String parmname)
Description:Get media item numerical-value attributes.
| Parameters: |
| MediaItem item | - | the MediaItem, whose value you want to have |
| string parmname | - | the parametername, whose value you want to have: B_MUTE : bool * : muted B_LOOPSRC : bool * : loop source B_ALLTAKESPLAY : bool * : all takes play B_UISEL : bool * : selected in arrange view C_BEATATTACHMODE : char * : item timebase, -1=track or project default, 1=beats (position, length, rate), 2=beats (position only). for auto-stretch timebase: C_BEATATTACHMODE=1, C_AUTOSTRETCH=1 C_AUTOSTRETCH: : char * : auto-stretch at project tempo changes, 1=enabled, requires C_BEATATTACHMODE=1 C_LOCK : char * : locked, &1=locked, &2=lock to active take D_VOL : double * : item volume, 0=-inf, 0.5=-6dB, 1=+0dB, 2=+6dB, etc D_POSITION : double * : item position in seconds D_LENGTH : double * : item length in seconds D_SNAPOFFSET : double * : item snap offset in seconds D_FADEINLEN : double * : item manual fadein length in seconds D_FADEOUTLEN : double * : item manual fadeout length in seconds D_FADEINDIR : double * : item fadein curvature, -1..1 D_FADEOUTDIR : double * : item fadeout curvature, -1..1 D_FADEINLEN_AUTO : double * : item auto-fadein length in seconds, -1=no auto-fadein D_FADEOUTLEN_AUTO : double * : item auto-fadeout length in seconds, -1=no auto-fadeout C_FADEINSHAPE : int * : fadein shape, 0..6, 0=linear C_FADEOUTSHAPE : int * : fadeout shape, 0..6, 0=linear I_GROUPID : int * : group ID, 0=no group I_LASTY : int * : Y-position of track in pixels (read-only) I_LASTH : int * : height in track in pixels (read-only) I_CUSTOMCOLOR : int * : custom color, OS dependent color|0x100000 (i.e. ColorToNative(r,g,b)|0x100000). If you do not |0x100000, then it will not be used, but will store the color. I_CURTAKE : int * : active take number IP_ITEMNUMBER : int, item number on this track (read-only, returns the item number directly) F_FREEMODE_Y : float * : free item positioning Y-position, 0=top of track, 1=bottom of track (will never be 1) F_FREEMODE_H : float * : free item positioning height, 0=no height, 1=full height of track (will never be 0) P_TRACK : MediaTrack * (read-only) |
| Returnvalues: |
| number retval | - | the value you requested |
^
GetMediaItemNumTakesFunctioncall:
C: int GetMediaItemNumTakes(MediaItem* item)
EEL2: int GetMediaItemNumTakes(MediaItem item)
Lua: integer itemnumtakes = reaper.GetMediaItemNumTakes(MediaItem item)
Python: Int RPR_GetMediaItemNumTakes(MediaItem item)
Description:Get the number of takes in a MediaItem-object.
| Parameters: |
| MediaItem item | - | the MediaItem-object, whose number of takes you want to know. |
| Returnvalues: |
| integer itemnumtakes | - | the number of takes within the MediaItem-object |
^
GetMediaItemTakeFunctioncall:
C: MediaItem_Take* GetMediaItemTake(MediaItem* item, int tk)
EEL2: MediaItem_Take GetMediaItemTake(MediaItem item, int tk)
Lua: MediaItem_Take = reaper.GetMediaItemTake(MediaItem item, integer tk)
Python: MediaItem_Take RPR_GetMediaItemTake(MediaItem item, Int tk)
Description:Get a take from a MediaItem as a MediaItem_Take-object.
| Parameters: |
| MediaItem item | - | the MediaItem, whose take you want to request |
| integer tk | - | the id of the take, that you want to request |
| Returnvalues: |
| MediaItem_Take | - | the returned take as a MediaItem_Take-object |
^
GetMediaItemTake_ItemFunctioncall:
C: MediaItem* GetMediaItemTake_Item(MediaItem_Take* take)
EEL2: MediaItem GetMediaItemTake_Item(MediaItem_Take take)
Lua: MediaItem item = reaper.GetMediaItemTake_Item(MediaItem_Take take)
Python: MediaItem RPR_GetMediaItemTake_Item(MediaItem_Take take)
Description:Get parent item of media item take.
| Parameters: |
| MediaItem_Take take | - | the MediaItem_Take-object, whose accompanying MediaItem you want to request. |
| Returnvalues: |
| MediaItem item | - | the MediaItem, in which the MediaItem_Take takes place. |
^
GetMediaItemTake_PeaksFunctioncall:
C: int GetMediaItemTake_Peaks(MediaItem_Take* take, double peakrate, double starttime, int numchannels, int numsamplesperchannel, int want_extra_type, double* buf)
EEL2: int GetMediaItemTake_Peaks(MediaItem_Take take, peakrate, starttime, int numchannels, int numsamplesperchannel, int want_extra_type, buffer_ptr buf)
Lua: integer peaks = reaper.GetMediaItemTake_Peaks(MediaItem_Take take, number peakrate, number starttime, integer numchannels, integer numsamplesperchannel, integer want_extra_type, reaper.array buf)
Python: (Int retval, MediaItem_Take take, Float peakrate, Float starttime, Int numchannels, Int numsamplesperchannel, Int want_extra_type, Float buf) = RPR_GetMediaItemTake_Peaks(take, peakrate, starttime, numchannels, numsamplesperchannel, want_extra_type, buf)
Description:Gets block of peak samples to buf. Note that the peak samples are interleaved, but in two or three blocks (maximums, then minimums, then extra). Return value has 20 bits of returned sample count, then 4 bits of output_mode (0xf00000), then a bit to signify whether extra_type was available (0x1000000). extra_type can be 115 ('s') for spectral information, which will return peak samples as integers with the low 15 bits frequency, next 14 bits tonality.
peakrate is number of pixels in seconds.
| Parameters: |
| MediaItem_Take take | - | |
| number peakrate | - | |
| number starttime | - | |
| integer numchannels | - | |
| integer numsamplesperchannel | - | |
| integer want_extra_type | - | |
| reaper.array buf | - | |
| Returnvalues: |
| integer peaks | - | |
^
GetMediaItemTake_SourceFunctioncall:
C: PCM_source* GetMediaItemTake_Source(MediaItem_Take* take)
EEL2: PCM_source GetMediaItemTake_Source(MediaItem_Take take)
Lua: PCM_source source = reaper.GetMediaItemTake_Source(MediaItem_Take take)
Python: PCM_source RPR_GetMediaItemTake_Source(MediaItem_Take take)
Description:Get media source of media item take
| Parameters: |
| MediaItem_Take take | - | |
| Returnvalues: |
| PCM_source source | - | |
^
GetMediaItemTake_TrackFunctioncall:
C: MediaTrack* GetMediaItemTake_Track(MediaItem_Take* take)
EEL2: MediaTrack GetMediaItemTake_Track(MediaItem_Take take)
Lua: MediaTrack track = reaper.GetMediaItemTake_Track(MediaItem_Take take)
Python: MediaTrack RPR_GetMediaItemTake_Track(MediaItem_Take take)
Description:Get parent track of media item take
| Parameters: |
| MediaItem_Take take | - | |
| Returnvalues: |
| MediaTrack track | - | |
^
GetMediaItemTakeByGUIDFunctioncall:
C: MediaItem_Take* GetMediaItemTakeByGUID(ReaProject* project, const GUID* guid)
EEL2: MediaItem_Take GetMediaItemTakeByGUID(ReaProject project, "guidGUID")
Lua: MediaItem_Take take = reaper.GetMediaItemTakeByGUID(ReaProject project, string guidGUID)
Python: MediaItem_Take RPR_GetMediaItemTakeByGUID(ReaProject project, const GUID guid)
Description:
| Parameters: |
| ReaProject project | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| string guidGUID | - |
|
| Returnvalues: |
| MediaItem_Take | - | take
|
^
GetMediaItemTakeInfo_ValueFunctioncall:
C: double GetMediaItemTakeInfo_Value(MediaItem_Take* take, const char* parmname)
EEL2: double GetMediaItemTakeInfo_Value(MediaItem_Take take, "parmname")
Lua: number retval = reaper.GetMediaItemTakeInfo_Value(MediaItem_Take take, string parmname)
Python: Float RPR_GetMediaItemTakeInfo_Value(MediaItem_Take take, String parmname)
Description:Get media item take numerical-value attributes.
D_STARTOFFS : double * : start offset in source media, in seconds
D_VOL : double * : take volume, 0=-inf, 0.5=-6dB, 1=+0dB, 2=+6dB, etc, negative if take polarity is flipped
D_PAN : double * : take pan, -1..1
D_PANLAW : double * : take pan law, -1=default, 0.5=-6dB, 1.0=+0dB, etc
D_PLAYRATE : double * : take playback rate, 0.5=half speed, 1=normal, 2=double speed, etc
D_PITCH : double * : take pitch adjustment in semitones, -12=one octave down, 0=normal, +12=one octave up, etc
B_PPITCH : bool * : preserve pitch when changing playback rate
I_CHANMODE : int * : channel mode, 0=normal, 1=reverse stereo, 2=downmix, 3=left, 4=right
I_PITCHMODE : int * : pitch shifter mode, -1=projext default, otherwise high 2 bytes=shifter, low 2 bytes=parameter
I_CUSTOMCOLOR : int * : custom color, OS dependent color|0x100000 (i.e. ColorToNative(r,g,b)|0x100000). If you do not |0x100000, then it will not be used, but will store the color.
IP_TAKENUMBER : int : take number (read-only, returns the take number directly)
P_TRACK : pointer to MediaTrack (read-only)
P_ITEM : pointer to MediaItem (read-only)
P_SOURCE : PCM_source *. Note that if setting this, you should first retrieve the old source, set the new, THEN delete the old.
| Parameters: |
| MediaItem_Take take | - | |
| string parmname | - | |
| Returnvalues: |
| number retval | - | |
^
GetMediaItemTrackFunctioncall:
C: MediaTrack* GetMediaItemTrack(MediaItem* item)
EEL2: MediaTrack GetMediaItemTrack(MediaItem item)
Lua: MediaTrack = reaper.GetMediaItemTrack(MediaItem item)
Python: MediaTrack RPR_GetMediaItemTrack(MediaItem item)
Description:Get the associated MediaTrack of a MediaItem.
| Parameters: |
| MediaItem | - | the MediaItem, whose associated MediaTrack you want to have |
| Returnvalues: |
| MediaTrack | - | the MediaTrack, where the MediaItem is located in |
^
GetMediaSourceFileNameFunctioncall:
C: void GetMediaSourceFileName(PCM_source* source, char* filenamebuf, int filenamebuf_sz)
EEL2: GetMediaSourceFileName(PCM_source source, #filenamebuf)
Lua: string filenamebuf = reaper.GetMediaSourceFileName(PCM_source source, string filenamebuf)
Python: (PCM_source source, String filenamebuf, Int filenamebuf_sz) = RPR_GetMediaSourceFileName(source, filenamebuf, filenamebuf_sz)
Description:Copies the media source filename to typebuf. Note that in-project MIDI media sources have no associated filename. See
GetMediaSourceParent.
| Parameters: |
| PCM_source source | - |
|
| string filenamebuf | - |
|
| Returnvalues: |
| string filenamebuf | - |
|
^
GetMediaSourceLengthFunctioncall:
C: double GetMediaSourceLength(PCM_source* source, bool* lengthIsQNOut)
EEL2: double GetMediaSourceLength(PCM_source source, bool &lengthIsQN)
Lua: number retval, boolean lengthIsQN = reaper.GetMediaSourceLength(PCM_source source)
Python: (Float retval, PCM_source source, Boolean lengthIsQNOut) = RPR_GetMediaSourceLength(source, lengthIsQNOut)
Description:Returns the length of the source media. If the media source is beat-based, the length will be in quarter notes, otherwise it will be in seconds.
| Parameters: |
| PCM_source source | - | |
| Returnvalues: |
| number retval | - | |
| boolean lengthIsQN | - | |
^
GetMediaSourceNumChannelsFunctioncall:
C: int GetMediaSourceNumChannels(PCM_source* source)
EEL2: int GetMediaSourceNumChannels(PCM_source source)
Lua: integer mediasourcenumchans = reaper.GetMediaSourceNumChannels(PCM_source source)
Python: Int RPR_GetMediaSourceNumChannels(PCM_source source)
Description:Returns the number of channels in the source media.
| Parameters: |
| PCM_source source | - | |
| Returnvalues: |
| integer mediasourcenumchans | - | |
^
GetMediaSourceParentFunctioncall:
C: PCM_source* GetMediaSourceParent(PCM_source* src)
EEL2: PCM_source GetMediaSourceParent(PCM_source src)
Lua: PCM_source = reaper.GetMediaSourceParent(PCM_source src)
Python: PCM_source RPR_GetMediaSourceParent(PCM_source src)
Description:Returns the parent source, or NULL if src is the root source. This can be used to retrieve the parent properties of sections or reversed sources for example.
| Parameters: |
| PCM_source src | - | |
| Returnvalues: |
| PCM_source | - | |
^
GetMediaSourceSampleRateFunctioncall:
C: int GetMediaSourceSampleRate(PCM_source* source)
EEL2: int GetMediaSourceSampleRate(PCM_source source)
Lua: integer mediasourcesamplerate = reaper.GetMediaSourceSampleRate(PCM_source source)
Python: Int RPR_GetMediaSourceSampleRate(PCM_source source)
Description:Returns the sample rate. MIDI source media will return zero.
| Parameters: |
| PCM_source source | - | |
| Returnvalues: |
| integer mediasourcesamplerate | - | |
^
GetMediaSourceTypeFunctioncall:
C: void GetMediaSourceType(PCM_source* source, char* typebuf, int typebuf_sz)
EEL2: GetMediaSourceType(PCM_source source, #typebuf)
Lua: string typebuf = reaper.GetMediaSourceType(PCM_source source, string typebuf)
Python: (PCM_source source, String typebuf, Int typebuf_sz) = RPR_GetMediaSourceType(source, typebuf, typebuf_sz)
Description:copies the media source type ("WAV", "MIDI", etc) to typebuf
| Parameters: |
| PCM_source source | - | |
| string typebuf | - | |
| Returnvalues: |
| string typebuf | - | a string-buffer needed by the function, use "" in Lua |
^
GetMediaTrackInfo_ValueFunctioncall:
C: double GetMediaTrackInfo_Value(MediaTrack* tr, const char* parmname)
EEL2: double GetMediaTrackInfo_Value(MediaTrack tr, "parmname")
Lua: number retval = reaper.GetMediaTrackInfo_Value(MediaTrack tr, string parmname)
Python: Float RPR_GetMediaTrackInfo_Value(MediaTrack tr, String parmname)
Description:Get track numerical-value attributes.
B_MUTE : bool * : muted
B_PHASE : bool * : track phase inverted
B_RECMON_IN_EFFECT : bool * : record monitoring in effect (current audio-thread playback state, read-only)
IP_TRACKNUMBER : int : track number 1-based, 0=not found, -1=master track (read-only, returns the int directly)
I_SOLO : int * : soloed, 0=not soloed, 1=soloed, 2=soloed in place, 5=safe soloed, 6=safe soloed in place
I_FXEN : int * : fx enabled, 0=bypassed, !0=fx active
I_RECARM : int * : record armed, 0=not record armed, 1=record armed
I_RECINPUT : int * : record input, <0=no input. if 4096 set, input is MIDI and low 5 bits represent channel (0=all, 1-16=only chan), next 6 bits represent physical input (63=all, 62=VKB). If 4096 is not set, low 10 bits (0..1023) are input start channel (ReaRoute/Loopback start at 512). If 2048 is set, input is multichannel input (using track channel count), or if 1024 is set, input is stereo input, otherwise input is mono.
I_RECMODE : int * : record mode, 0=input, 1=stereo out, 2=none, 3=stereo out w/latency compensation, 4=midi output, 5=mono out, 6=mono out w/ latency compensation, 7=midi overdub, 8=midi replace
I_RECMON : int * : record monitoring, 0=off, 1=normal, 2=not when playing (tape style)
I_RECMONITEMS : int * : monitor items while recording, 0=off, 1=on
I_AUTOMODE : int * : track automation mode, 0=trim/off, 1=read, 2=touch, 3=write, 4=latch
I_NCHAN : int * : number of track channels, 2-64, even numbers only
I_SELECTED : int * : track selected, 0=unselected, 1=selected
I_WNDH : int * : current TCP window height in pixels including envelopes (read-only)
I_TCPH : int * : current TCP window height in pixels not including envelopes (read-only)
I_TCPY : int * : current TCP window Y-position in pixels relative to top of arrange view (read-only)
I_MCPX : int * : current MCP X-position in pixels relative to mixer container
I_MCPY : int * : current MCP Y-position in pixels relative to mixer container
I_MCPW : int * : current MCP width in pixels
I_MCPH : int * : current MCP height in pixels
I_FOLDERDEPTH : int * : folder depth change, 0=normal, 1=track is a folder parent, -1=track is the last in the innermost folder, -2=track is the last in the innermost and next-innermost folders, etc
I_FOLDERCOMPACT : int * : folder compacted state (only valid on folders), 0=normal, 1=small, 2=tiny children
I_MIDIHWOUT : int * : track midi hardware output index, <0=disabled, low 5 bits are which channels (0=all, 1-16), next 5 bits are output device index (0-31)
I_PERFFLAGS : int * : track performance flags, &1=no media buffering, &2=no anticipative FX
I_CUSTOMCOLOR : int * : custom color, OS dependent color|0x100000 (i.e. ColorToNative(r,g,b)|0x100000). If you do not |0x100000, then it will not be used, but will store the color.
I_HEIGHTOVERRIDE : int * : custom height override for TCP window, 0 for none, otherwise size in pixels
B_HEIGHTLOCK : bool * : track height lock (must set I_HEIGHTOVERRIDE before locking)
D_VOL : double * : trim volume of track, 0=-inf, 0.5=-6dB, 1=+0dB, 2=+6dB, etc
D_PAN : double * : trim pan of track, -1..1
D_WIDTH : double * : width of track, -1..1
D_DUALPANL : double * : dualpan position 1, -1..1, only if I_PANMODE==6
D_DUALPANR : double * : dualpan position 2, -1..1, only if I_PANMODE==6
I_PANMODE : int * : pan mode, 0=classic 3.x, 3=new balance, 5=stereo pan, 6=dual pan
D_PANLAW : double * : pan law of track, <0=project default, 1=+0dB, etc
P_ENV:<envchunkname or P_ENV:{GUID... : TrackEnvelope*, read only. chunkname can be <VOLENV, <PANENV, etc; GUID is the stringified envelope GUID.
B_SHOWINMIXER : bool * : track control panel visible in mixer (do not use on master track)
B_SHOWINTCP : bool * : track control panel visible in arrange view (do not use on master track)
B_MAINSEND : bool * : track sends audio to parent
C_MAINSEND_OFFS : char * : channel offset of track send to parent
B_FREEMODE : bool * : track free item positioning enabled (call UpdateTimeline() after changing)
C_BEATATTACHMODE : char * : track timebase, -1=project default, 0=time, 1=beats (position, length, rate), 2=beats (position only)
F_MCP_FXSEND_SCALE : float * : scale of fx+send area in MCP (0=minimum allowed, 1=maximum allowed)
F_MCP_FXPARM_SCALE : float * : scale of fx parameter area in MCP (0=minimum allowed, 1=maximum allowed)
F_MCP_SENDRGN_SCALE : float * : scale of send area as proportion of the fx+send total area (0=minimum allowed, 1=maximum allowed)
F_TCP_FXPARM_SCALE : float * : scale of TCP parameter area when TCP FX are embedded (0=min allowed, default, 1=max allowed)
I_PLAY_OFFSET_FLAG : int * : track playback offset state, &1=bypassed, &2=offset value is measured in samples (otherwise measured in seconds)
D_PLAY_OFFSET : double * : track playback offset, units depend on I_PLAY_OFFSET_FLAG
P_PARTRACK : MediaTrack * : parent track (read-only)
P_PROJECT : ReaProject * : parent project (read-only)
| Parameters: |
| MediaTrack tr | - | the MediaTrack-object, whose attribute you want to request |
| string parmname | - | the attribute, that you want to request, like D_VOL or B_SHOWINMIXER etc |
| Returnvalues: |
| number retval | - | the value of the requested attribute |
^
GetMIDIInputNameFunctioncall:
C: bool GetMIDIInputName(int dev, char* nameout, int nameout_sz)
EEL2: bool GetMIDIInputName(int dev, #nameout)
Lua: boolean retval, string nameout = reaper.GetMIDIInputName(integer dev, string nameout)
Python: (Boolean retval, Int dev, String nameout, Int nameout_sz) = RPR_GetMIDIInputName(dev, nameout, nameout_sz)
Description:returns true if device present
| Parameters: |
| integer dev | - | |
| string nameout | - | |
| Returnvalues: |
| boolean retval | - | |
| string nameout | - | |
^
GetMIDIOutputNameFunctioncall:
C: bool GetMIDIOutputName(int dev, char* nameout, int nameout_sz)
EEL2: bool GetMIDIOutputName(int dev, #nameout)
Lua: boolean retval, string nameout = reaper.GetMIDIOutputName(integer dev, string nameout)
Python: (Boolean retval, Int dev, String nameout, Int nameout_sz) = RPR_GetMIDIOutputName(dev, nameout, nameout_sz)
Description:returns true if device present
| Parameters: |
| integer dev | - | |
| string nameout | - | |
| Returnvalues: |
| boolean retval | - | |
| string nameout | - | |
^
GetMixerScrollFunctioncall:
C: MediaTrack* GetMixerScroll()
EEL2: MediaTrack GetMixerScroll()
Lua: MediaTrack leftmosttrack = reaper.GetMixerScroll()
Python: MediaTrack RPR_GetMixerScroll()
Description:Get the leftmost track visible in the mixer
| Returnvalues: |
| MediaTrack leftmosttrack | - | the leftmost track in the MCP |
^
GetMouseModifierFunctioncall:
C: void GetMouseModifier(const char* context, int modifier_flag, char* action, int action_sz)
EEL2: GetMouseModifier("context", int modifier_flag, #action)
Lua: string action = reaper.GetMouseModifier(string context, integer modifier_flag, string action)
Python: (String context, Int modifier_flag, String action, Int action_sz) = RPR_GetMouseModifier(context, modifier_flag, action, action_sz)
Description:Get the current mouse modifier assignment for a specific modifier key assignment, in a specific context.
action will be filled in with the command ID number for a built-in mouse modifier
or built-in REAPER command ID, or the custom action ID string.
See
SetMouseModifier for more information.
| Parameters: |
| string context | - |
|
| integer modifier_flag | - |
|
| string action | - |
|
| Returnvalues: |
| string action | - |
|
^
GetMousePositionFunctioncall:
C: void GetMousePosition(int* xOut, int* yOut)
EEL2: GetMousePosition(int &x, int &y)
Lua: integer x, integer y = reaper.GetMousePosition()
Python: (Int xOut, Int yOut) = RPR_GetMousePosition(xOut, yOut)
Description:get mouse position in screen coordinates
| Returnvalues: |
| integer x | - | horizontal position of the mouse in pixels |
| integer y | - | vertical position of the mouse in pixels |
^
GetNumAudioInputsFunctioncall:
C: int GetNumAudioInputs()
EEL2: int GetNumAudioInputs()
Lua: integer numAudioIns = reaper.GetNumAudioInputs()
Python: Int RPR_GetNumAudioInputs()
Description:Return number of normal audio hardware inputs available
| Returnvalues: |
| integer numAudioIns | - | the number of audio hardware outputs available |
^
GetNumAudioOutputsFunctioncall:
C: int GetNumAudioOutputs()
EEL2: int GetNumAudioOutputs()
Lua: integer numAudioOuts = reaper.GetNumAudioOutputs()
Python: Int RPR_GetNumAudioOutputs()
Description:Return number of normal audio hardware outputs available
| Returnvalues: |
| integer numAudioOuts | - | the number of audio hardware outputs available |
^
GetNumMIDIInputsFunctioncall:
C: int GetNumMIDIInputs()
EEL2: int GetNumMIDIInputs()
Lua: integer numMidiIns = reaper.GetNumMIDIInputs()
Python: Int RPR_GetNumMIDIInputs()
Description:returns max number of real midi hardware inputs
| Returnvalues: |
| integer numMidiIns | - | |
^
GetNumMIDIOutputsFunctioncall:
C: int GetNumMIDIOutputs()
EEL2: int GetNumMIDIOutputs()
Lua: integer numMidiOuts = reaper.GetNumMIDIOutputs()
Python: Int RPR_GetNumMIDIOutputs()
Description:returns max number of real midi hardware outputs
| Returnvalues: |
| integer numMidiOuts | - | the number of real midi hardware outputs |
^
GetNumTakeMarkersFunctioncall:
C: int GetNumTakeMarkers(MediaItem_Take* take)
EEL2: int GetNumTakeMarkers(MediaItem_Take take)
Lua: integer retval = reaper.GetNumTakeMarkers(MediaItem_Take take)
Python: Int RPR_GetNumTakeMarkers(MediaItem_Take take)
Description:
| Parameters: |
| MediaItem_Take take | - | the take, whose take-markers you want to count
|
| Returnvalues: |
| integer retval | - | the number of found take-markers
|
^
GetNumTracksFunctioncall:
C: int GetNumTracks()
EEL2: int GetNumTracks()
Lua: integer numtracks = reaper.GetNumTracks()
Python: Int RPR_GetNumTracks()
Description:Get the number of tracks. Excluding the master-track.
| Returnvalues: |
| integer numtracks | - | the number of tracks in the current project. |
^
GetOSFunctioncall:
C: const char* GetOS()
EEL2: bool GetOS(#retval)
Lua: string operating_system = reaper.GetOS()
Python: String RPR_GetOS()
Description:Returns the current operating-system. Good for determining, e.g. the correct filesystem-separators.
| Returnvalues: |
| string operating_system | - | "Win32", "Win64", "OSX32", "OSX64", "macOS-arm64" or "Other" |
^
GetOutputChannelNameFunctioncall:
C: const char* GetOutputChannelName(int channelIndex)
EEL2: bool GetOutputChannelName(#retval, int channelIndex)
Lua: string outputchanname= reaper.GetOutputChannelName(integer channelIndex)
Python: String RPR_GetOutputChannelName(Int channelIndex)
Description:Get the name of a specific output-channel.
| Parameters: |
| integer channelIndex | - | the index of the output-channel |
| Returnvalues: |
| string outputchanname | - | the name of the output-channel. |
^
GetOutputLatencyFunctioncall:
C: double GetOutputLatency()
EEL2: double GetOutputLatency()
Lua: number outputlatency = reaper.GetOutputLatency()
Python: Float RPR_GetOutputLatency()
Description:returns output latency in seconds
| Returnvalues: |
| number outputlatency | - | output-latency in seconds |
^
GetParentTrackFunctioncall:
C: MediaTrack* GetParentTrack(MediaTrack* track)
EEL2: MediaTrack GetParentTrack(MediaTrack track)
Lua: MediaTrack parenttrack = reaper.GetParentTrack(MediaTrack track)
Python: MediaTrack RPR_GetParentTrack(MediaTrack track)
Description:Get the parent MediaTrack, if a MediaTrack is a track of a foldered track.
| Parameters: |
| MediaTrack track | - | the MediaTrack in a folder, whose parent MediaTrack you want |
| Returnvalues: |
| MediaTrack parenttrack | - | the returned parent MediaTrack of a foldered MediaTrack |
^
GetPeakFileNameFunctioncall:
C: void GetPeakFileName(const char* fn, char* buf, int buf_sz)
EEL2: GetPeakFileName("fn", #buf)
Lua: string buf = reaper.GetPeakFileName(string fn, string buf)
Python: (String fn, String buf, Int buf_sz) = RPR_GetPeakFileName(fn, buf, buf_sz)
Description:get the peak file name for a given file (can be either filename.reapeaks,or a hashed filename in another path)
| Parameters: |
| string fn | - | |
| string buf | - | |
| Returnvalues: |
| string buf | - | |
^
GetPeakFileNameExFunctioncall:
C: void GetPeakFileNameEx(const char* fn, char* buf, int buf_sz, bool forWrite)
EEL2: GetPeakFileNameEx("fn", #buf, bool forWrite)
Lua: string buf = reaper.GetPeakFileNameEx(string fn, string buf, boolean forWrite)
Python: (String fn, String buf, Int buf_sz, Boolean forWrite) = RPR_GetPeakFileNameEx(fn, buf, buf_sz, forWrite)
Description:get the peak file name for a given file (can be either filename.reapeaks,or a hashed filename in another path)
| Parameters: |
| string fn | - | |
| string buf | - | a string-buffer needed by the function, just give "" in Lua |
| boolean forWrite | - | |
| Returnvalues: |
| string buf | - | the peak-filename |
^
GetPeakFileNameEx2Functioncall:
C: void GetPeakFileNameEx2(const char* fn, char* buf, int buf_sz, bool forWrite, const char* peaksfileextension)
EEL2: GetPeakFileNameEx2("fn", #buf, bool forWrite, "peaksfileextension")
Lua: string buf = reaper.GetPeakFileNameEx2(string fn, string buf, boolean forWrite, string peaksfileextension)
Python: (String fn, String buf, Int buf_sz, Boolean forWrite, String peaksfileextension) = RPR_GetPeakFileNameEx2(fn, buf, buf_sz, forWrite, peaksfileextension)
Description:Like GetPeakFileNameEx, but you can specify peaksfileextension such as ".reapeaks"
| Parameters: |
| string fn | - | |
| string buf | - | a string-buffer needed by the function, just give "" in Lua |
| boolean forWrite | - | |
| string peaksfileextension | - | |
| Returnvalues: |
| string buf | - | the peak-filename |
^
GetPlayPositionFunctioncall:
C: double GetPlayPosition()
EEL2: double GetPlayPosition()
Lua: number playposition = reaper.GetPlayPosition()
Python: Float RPR_GetPlayPosition()
Description:returns latency-compensated actual-what-you-hear position
| Returnvalues: |
| number playposition | - | the playposition in seconds |
^
GetPlayPosition2Functioncall:
C: double GetPlayPosition2()
EEL2: double GetPlayPosition2()
Lua: number playposition = reaper.GetPlayPosition2()
Python: Float RPR_GetPlayPosition2()
Description:returns position of next audio block being processed
| Returnvalues: |
| number playposition | - | the playposition in seconds |
^
GetPlayPosition2ExFunctioncall:
C: double GetPlayPosition2Ex(ReaProject* proj)
EEL2: double GetPlayPosition2Ex(ReaProject proj)
Lua: number playposition = reaper.GetPlayPosition2Ex(ReaProject proj)
Python: Float RPR_GetPlayPosition2Ex(ReaProject proj)
Description:returns position of next audio block being processed from a specific project
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| Returnvalues: |
| number playposition | - | the playposition in seconds
|
^
GetPlayPositionExFunctioncall:
C: double GetPlayPositionEx(ReaProject* proj)
EEL2: double GetPlayPositionEx(ReaProject proj)
Lua: number playposition = reaper.GetPlayPositionEx(ReaProject proj)
Python: Float RPR_GetPlayPositionEx(ReaProject proj)
Description:returns latency-compensated actual-what-you-hear position from a specific project
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| Returnvalues: |
| number playposition | - | the playposition in seconds
|
^
GetPlayStateFunctioncall:
C: int GetPlayState()
EEL2: int GetPlayState()
Lua: integer playstate = reaper.GetPlayState()
Python: Int RPR_GetPlayState()
Description:returns, in which play-state the current project is
| Returnvalues: |
| integer playstate | - | Either bitwise: &1=playing,&2=pause,&=4 is recording, or
0, stop
1, play
2, paused play
5, recording
6, paused recording |
^
GetPlayStateExFunctioncall:
C: int GetPlayStateEx(ReaProject* proj)
EEL2: int GetPlayStateEx(ReaProject proj)
Lua: integer playstate = reaper.GetPlayStateEx(ReaProject proj)
Python: Int RPR_GetPlayStateEx(ReaProject proj)
Description:returns, in which play-state a certain project is
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| Returnvalues: |
| integer playstate | - | Either bitwise: &1=playing,&2=pause,&=4 is recording, or 0, stop 1, play 2, paused play 5, recording 6, paused recording
|
^
GetProjectLengthFunctioncall:
C: double GetProjectLength(ReaProject* proj)
EEL2: double GetProjectLength(ReaProject proj)
Lua: number length = reaper.GetProjectLength(ReaProject proj)
Python: Float RPR_GetProjectLength(ReaProject proj)
Description:returns length of project (maximum of end of media item, markers, end of regions, tempo map)
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| Returnvalues: |
| number length | - | the length of the project in seconds
|
^
GetProjectNameFunctioncall:
C: void GetProjectName(ReaProject* proj, char* buf, int buf_sz)
EEL2: GetProjectName(ReaProject proj, #buf)
Lua: string buf = reaper.GetProjectName(ReaProject proj, string buf)
Python: (ReaProject proj, String buf, Int buf_sz) = RPR_GetProjectName(proj, buf, buf_sz)
Description:Get the name of the projectfile.
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| string buf | - |
|
| Returnvalues: |
| string buf | - | a string-buffer needed by the function; just give "" in Lua
|
^
GetProjectPathFunctioncall:
C: void GetProjectPath(char* buf, int buf_sz)
EEL2: GetProjectPath(#buf)
Lua: string buf = reaper.GetProjectPath(string buf)
Python: (String buf, Int buf_sz) = RPR_GetProjectPath(buf, buf_sz)
Description:Get the path of the project. Will return the defaults project-path's recording-folder, when the project hasn't been saved yet; when the project has been saved, it will return the path to the recording-folder.
If you need the filename of the path+projectfile itself, use
EnumProjects instead.
| Parameters: |
| string buf | - | a string-buffer needed by the function, just give "" in Lua
|
| Returnvalues: |
| string buf | - | the returned path
|
^
GetProjectPathExFunctioncall:
C: void GetProjectPathEx(ReaProject* proj, char* buf, int buf_sz)
EEL2: GetProjectPathEx(ReaProject proj, #buf)
Lua: string buf = reaper.GetProjectPathEx(ReaProject proj, string buf)
Python: (ReaProject proj, String buf, Int buf_sz) = RPR_GetProjectPathEx(proj, buf, buf_sz)
Description:Get the path of a specific project, usually the recordings-folder.
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| string buf | - |
|
| Returnvalues: |
| string buf | - | a string-buffer needed by the function, just use "" in Lua
|
^
GetProjectStateChangeCountFunctioncall:
C: int GetProjectStateChangeCount(ReaProject* proj)
EEL2: int GetProjectStateChangeCount(ReaProject proj)
Lua: integer = reaper.GetProjectStateChangeCount(ReaProject proj)
Python: Int RPR_GetProjectStateChangeCount(ReaProject proj)
Description:returns an integer that changes when the project state changes, e.g. undoable-actions have been made.
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| Returnvalues: |
| integer | - | the number of changes, since (re-)opening of the project.
|
^
GetProjectTimeOffsetFunctioncall:
C: double GetProjectTimeOffset(ReaProject* proj, bool rndframe)
EEL2: double GetProjectTimeOffset(ReaProject proj, bool rndframe)
Lua: number = reaper.GetProjectTimeOffset(ReaProject proj, boolean rndframe)
Python: Float RPR_GetProjectTimeOffset(ReaProject proj, Boolean rndframe)
Description:Gets project time offset in seconds (project settings -> project start time).
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| boolean rndframe | - | true, the offset is rounded to a multiple of the project frame size; false, no rounding happening
|
| Returnvalues: |
| number | - | the project-time-offset
|
^
GetProjectTimeSignatureFunctioncall:
C: void GetProjectTimeSignature(double* bpmOut, double* bpiOut)
EEL2: GetProjectTimeSignature(&bpm, &bpi)
Lua: number bpm, number bpi = reaper.GetProjectTimeSignature()
Python: (Float bpmOut, Float bpiOut) = RPR_GetProjectTimeSignature(bpmOut, bpiOut)
Description:deprecated
| Returnvalues: |
| number bpm | - | the bpm of the project's time-signature |
| number bpi | - | the bpi of the project's time-signature |
^
GetProjectTimeSignature2Functioncall:
C: void GetProjectTimeSignature2(ReaProject* proj, double* bpmOut, double* bpiOut)
EEL2: GetProjectTimeSignature2(ReaProject proj, &bpm, &bpi)
Lua: number bpm, number bpi = reaper.GetProjectTimeSignature2(ReaProject proj)
Python: (ReaProject proj, Float bpmOut, Float bpiOut) = RPR_GetProjectTimeSignature2(proj, bpmOut, bpiOut)
Description:Gets basic time signature (beats per minute, numerator of time signature in bpi)
this does not reflect tempo envelopes but is purely what is set in the project settings.
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| Returnvalues: |
| number bpm | - | beats per minute
|
| number bpi | - | numerator of time signature in bpi
|
^
GetProjExtStateFunctioncall:
C: int GetProjExtState(ReaProject* proj, const char* extname, const char* key, char* valOutNeedBig, int valOutNeedBig_sz)
EEL2: int GetProjExtState(ReaProject proj, "extname", "key", #val)
Lua: integer retval, string val = reaper.GetProjExtState(ReaProject proj, string extname, string key)
Python: (Int retval, ReaProject proj, String extname, String key, String valOutNeedBig, Int valOutNeedBig_sz) = RPR_GetProjExtState(proj, extname, key, valOutNeedBig, valOutNeedBig_sz)
Description:Get the value previously associated with this extname and key, the last time the project was saved or the value was changed. See
SetProjExtState,
EnumProjExtState.
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| string extname | - | the section, in which the key requested is stored
|
| string key | - | the key, in which the requested value is stored
|
| Returnvalues: |
| integer retval | - | true, if such an extended-state exists; false, if not
|
| string val | - | the value, as stored in extname->key
|
^
GetResourcePathFunctioncall:
C: const char* GetResourcePath()
EEL2: bool GetResourcePath(#retval)
Lua: string = reaper.GetResourcePath()
Python: String RPR_GetResourcePath()
Description:returns path where ini files are stored, other things are in subdirectories.
When resourcepath is equal to app-path(see
GetExePath), it is an indicator that Reaper is installed as portable installation.
| Returnvalues: |
| string | - | the path to the resource-folder
|
^
GetSelectedEnvelopeFunctioncall:
C: TrackEnvelope* GetSelectedEnvelope(ReaProject* proj)
EEL2: TrackEnvelope GetSelectedEnvelope(ReaProject proj)
Lua: TrackEnvelope = reaper.GetSelectedEnvelope(ReaProject proj)
Python: TrackEnvelope RPR_GetSelectedEnvelope(ReaProject proj)
Description:get the currently selected envelope, returns NULL/nil if no envelope is selected
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| Returnvalues: |
| TrackEnvelope | - | the TrackEnvelope-object of the selected envelope-lane requested; 0, if no envelope is selected
|
^
GetSelectedMediaItemFunctioncall:
C: MediaItem* GetSelectedMediaItem(ReaProject* proj, int selitem)
EEL2: MediaItem GetSelectedMediaItem(ReaProject proj, int selitem)
Lua: MediaItem = reaper.GetSelectedMediaItem(ReaProject proj, integer selitem)
Python: MediaItem RPR_GetSelectedMediaItem(ReaProject proj, Int selitem)
Description:
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| integer selitem | - | the id of the selected MediaItem, as multiple items can be selected. See CountSelectedMediaItems
|
| Returnvalues: |
| MediaItem | - | the requested MediaItem as a MediaItem-object
|
^
GetSelectedTrackFunctioncall:
C: MediaTrack* GetSelectedTrack(ReaProject* proj, int seltrackidx)
EEL2: MediaTrack GetSelectedTrack(ReaProject proj, int seltrackidx)
Lua: MediaTrack = reaper.GetSelectedTrack(ReaProject proj, integer seltrackidx)
Python: MediaTrack RPR_GetSelectedTrack(ReaProject proj, Int seltrackidx)
Description:
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| integer seltrackidx | - | the idx of within the selected tracks, zero based, as multiple tracks can be selected by the user.
|
| Returnvalues: |
| MediaTrack | - | the requested, selected MediaTrack
|
^
GetSelectedTrack2Functioncall:
C: MediaTrack* GetSelectedTrack2(ReaProject* proj, int seltrackidx, bool wantmaster)
EEL2: MediaTrack GetSelectedTrack2(ReaProject proj, int seltrackidx, bool wantmaster)
Lua: MediaTrack = reaper.GetSelectedTrack2(ReaProject proj, integer seltrackidx, boolean wantmaster)
Python: MediaTrack RPR_GetSelectedTrack2(ReaProject proj, Int seltrackidx, Boolean wantmaster)
Description:Get a selected track from a project (proj=0 for active project) by selected track count (zero-based).
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| integer seltrackidx | - | the idx of within the selected tracks, zero based, as multiple tracks can be selected by the user.
|
| boolean wantmaster | - | true, seltrackidx=0 is the master track, if selected; false, seltrackidx=0 is the first selected normal track
|
| Returnvalues: |
| MediaTrack | - | the requested, selected MediaTrack
|
^
GetSelectedTrackEnvelopeFunctioncall:
C: TrackEnvelope* GetSelectedTrackEnvelope(ReaProject* proj)
EEL2: TrackEnvelope GetSelectedTrackEnvelope(ReaProject proj)
Lua: TrackEnvelope = reaper.GetSelectedTrackEnvelope(ReaProject proj)
Python: TrackEnvelope RPR_GetSelectedTrackEnvelope(ReaProject proj)
Description:get the currently selected track envelope, returns NULL/nil if no envelope is selected
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| Returnvalues: |
| TrackEnvelope | - | the selected TrackEnvelope as an object; nil if no TrackEnvelope is selected
|
^
GetSet_ArrangeView2Functioncall:
C: void GetSet_ArrangeView2(ReaProject* proj, bool isSet, int screen_x_start, int screen_x_end, double* start_timeOut, double* end_timeOut)
EEL2: GetSet_ArrangeView2(ReaProject proj, bool isSet, int screen_x_start, int screen_x_end, &start_time, &end_time)
Lua: number start_time, number end_time = reaper.GetSet_ArrangeView2(ReaProject proj, boolean isSet, integer screen_x_start, integer screen_x_end, number start_time, number end_time)
Python: (ReaProject proj, Boolean isSet, Int screen_x_start, Int screen_x_end, Float start_timeOut, Float end_timeOut) = RPR_GetSet_ArrangeView2(proj, isSet, screen_x_start, screen_x_end, start_timeOut, end_timeOut)
Description:Gets or sets the arrange view start/end time for screen coordinates. use screen_x_start=screen_x_end=0 to use the full arrange view's start/end time
If you want to get the arrangeviewposition by pixels, set isSet=false and pass the pixel-position of the start and endposition to screen_x_start and screen_x_end.
screen_x_start and screen_x_end will be ignored, when isSet=true
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| boolean isSet | - | true, set a new arrangeview-time position; false, only get the current arrangeview-time position
|
| integer screen_x_start | - | if isSet=false, this parameter returns the start-time-position at screen-pixel-x position. set this and screenxend to 0 for the whole shown arrangeview start/endtime
|
| integer screen_x_end | - | if isSet=false, this parameter returns the end-time-position at screen-pixel-x position. set this and screenxend to 0 for the whole shown arrangeview start/endtime
|
| number start_time | - | if isSet=true, this is the startposition of the arrangeview(the left side) in seconds
|
| number end_time | - | if isSet=true, this is the startposition of the arrangeview(the right side) in seconds
|
| Returnvalues: |
| number start_time | - | the startposition of the arrangeview(left side) in seconds
|
| number end_time | - | the startposition of the arrangeview(right side) in seconds
|
^
GetSet_LoopTimeRangeFunctioncall:
C: void GetSet_LoopTimeRange(bool isSet, bool isLoop, double* startOut, double* endOut, bool allowautoseek)
EEL2: GetSet_LoopTimeRange(bool isSet, bool isLoop, &start, &end, bool allowautoseek)
Lua: number start_sel, number end_sel = reaper.GetSet_LoopTimeRange(boolean isSet, boolean isLoop, number start_sel, number end_sel, boolean allowautoseek)
Python: (Boolean isSet, Boolean isLoop, Float startOut, Float endOut, Boolean allowautoseek) = RPR_GetSet_LoopTimeRange(isSet, isLoop, startOut, endOut, allowautoseek)
Description:Gets/sets a time-selection/loop.
Loops and time-selections can be unlinked in preferences -> Editing Behavior -> Link loops to time selection.
So you can control them individually, when you've unlinked them with this function.
| Parameters: |
| boolean isSet | - | false, get the current time-selection/loop-range; true, set a new time-selection/loop-range |
| boolean isLoop | - | true, selection is a loop; false, selection is a regular time-selection |
| number start_sel | - | the new startposition of the time-selection/loop-range |
| number end_sel | - | the new endposition of the time-selection/loop-range |
| boolean allowautoseek | - | true, when setting a new loop while playback, the playcursor jumps to the loop; false, playcursor stays unaffecte by the change |
| Returnvalues: |
| number start_sel | - | the starting position of the time-selection/loop in seconds |
| number end_sel | - | the end position of the time-selection/loop in seconds |
^
GetSet_LoopTimeRange2Functioncall:
C: void GetSet_LoopTimeRange2(ReaProject* proj, bool isSet, bool isLoop, double* startOut, double* endOut, bool allowautoseek)
EEL2: GetSet_LoopTimeRange2(ReaProject proj, bool isSet, bool isLoop, &start, &end, bool allowautoseek)
Lua: number start retval, number end = reaper.GetSet_LoopTimeRange2(ReaProject proj, boolean isSet, boolean isLoop, number start, number end, boolean allowautoseek)
Python: (ReaProject proj, Boolean isSet, Boolean isLoop, Float startOut, Float endOut, Boolean allowautoseek) = RPR_GetSet_LoopTimeRange2(proj, isSet, isLoop, startOut, endOut, allowautoseek)
Description:Gets/sets a time-selection/loop.
Loops and time-selections can be unlinked in preferences -> Editing Behavior -> Link loops to time selection.
So you can control them individually, when you've unlinked them with this function.
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| boolean isSet | - | false, get the current time-selection/loop-range; true, set a new time-selection/loop-range
|
| boolean isLoop | - | true, selection is a loop; false, selection is a regular time-selection
|
| number start_sel | - | the new startposition of the time-selection/loop-range
|
| number end_sel | - | the new endposition of the time-selection/loop-range
|
| boolean allowautoseek | - | true, when setting a new loop while playback, the playcursor jumps to the loop; false, playcursor stays unaffecte by the change
|
| Returnvalues: |
| number start_sel | - | the starting position of the time-selection/loop in seconds
|
| number end_sel | - | the end position of the time-selection/loop in seconds
|
^
GetSetAutomationItemInfoFunctioncall:
C: double GetSetAutomationItemInfo(TrackEnvelope* env, int autoitem_idx, const char* desc, double value, bool is_set)
EEL2: double GetSetAutomationItemInfo(TrackEnvelope env, int autoitem_idx, "desc", value, bool is_set)
Lua: number = reaper.GetSetAutomationItemInfo(TrackEnvelope env, integer autoitem_idx, string desc, number value, boolean is_set)
Python: Float RPR_GetSetAutomationItemInfo(TrackEnvelope env, Int autoitem_idx, String desc, Float value, Boolean is_set)
Description:Get or set automation item information. autoitem_idx=0 for the first automation item on an envelope, 1 for the second item, etc. desc can be any of the following:
D_POOL_ID : double * : automation item pool ID (as an integer); edits are propagated to all other automation items that share a pool ID
D_POSITION : double * : automation item timeline position in seconds
D_LENGTH : double * : automation item length in seconds
D_STARTOFFS : double * : automation item start offset in seconds
D_PLAYRATE : double * : automation item playback rate
D_BASELINE : double * : automation item baseline value in the range [0,1]
D_AMPLITUDE : double * : automation item amplitude in the range [-1,1]
D_LOOPSRC : double * : nonzero if the automation item contents are looped
D_UISEL : double * : nonzero if the automation item is selected in the arrange view
D_POOL_QNLEN : double * : automation item pooled source length in quarter notes (setting will affect all pooled instances)
| Parameters: |
| TrackEnvelope env | - | the envelope, that contains the automation-item |
| integer autoitem_idx | - | the index of the automation-item, whose information-attribute you want to get/set |
| string desc | - | the attribute to get/set |
| number value | - | the new value to be set; write any value, when is_set=false |
| boolean is_set | - | true, set a new value; false, get the current value |
^
GetSetAutomationItemInfo_StringFunctioncall:
C: bool GetSetAutomationItemInfo_String(TrackEnvelope* env, int autoitem_idx, const char* desc, char* valuestrNeedBig, bool is_set)
EEL2: bool GetSetAutomationItemInfo_String(TrackEnvelope env, int autoitem_idx, "desc", #valuestrNeedBig, bool is_set)
Lua: boolean retval, string valuestrNeedBig = reaper.GetSetAutomationItemInfo_String(TrackEnvelope env, integer autoitem_idx, string desc, string valuestrNeedBig, boolean is_set)
Python: (Boolean retval, TrackEnvelope env, Int autoitem_idx, String desc, String valuestrNeedBig, Boolean is_set) = RPR_GetSetAutomationItemInfo_String(env, autoitem_idx, desc, valuestrNeedBig, is_set)
Description:Get or set automation item information. autoitem_idx=0 for the first automation item on an envelope, 1 for the second item, etc. returns true on success. desc can be any of the following:
P_POOL_NAME : char *, name of the underlying automation item pool
P_POOL_EXT:xyz : char *, extension-specific persistent data
| Parameters: |
| TrackEnvelope env | - | the envelope, that contains the automation-item |
| integer autoitem_idx | - | the index of the automation-item, whose information-attribute you want to get/set |
| string desc | - | the attribute to get/set |
| string valuestrNeedBig | - | the new value to set; set it to "" when is_set=false |
| boolean is_set | - | true, set a new value; false, get the current value |
| Returnvalues: |
| boolean retval | - | true, getting/setting the value was successful; falsem getting/setting the value was unsuccessful |
| string valuestrNeedBig | - | the current value set |
^
GetSetEnvelopeInfo_StringFunctioncall:
C: bool GetSetEnvelopeInfo_String(TrackEnvelope* env, const char* parmname, char* stringNeedBig, bool setNewValue)
EEL2: bool GetSetEnvelopeInfo_String(TrackEnvelope env, "parmname", #stringNeedBig, bool setNewValue)
Lua: boolean retval, string stringNeedBig = reaper.GetSetEnvelopeInfo_String(TrackEnvelope env, string parmname_attribute, string valueStringNeedBig, boolean setNewValue)
Python: (Boolean retval, TrackEnvelope env, String parmname, String stringNeedBig, Boolean setNewValue) = RPR_GetSetEnvelopeInfo_String(env, parmname, stringNeedBig, setNewValue)
Description:Gets/sets an attribute string:
P_EXT:xyz : char * : extension-specific persistent data
GUID : GUID * : 16-byte GUID, can query only, not set. If using a _String() function, GUID is a string {xyz-...}.
This is basically a key-value-store for envelopes.
| Parameters: |
| TrackEnvelope env | - | the envelope, whose ext-attributes you want to get/set |
| string parmname_attribute | - | the name of the parameter and attribute. For instance, "P_EXT:FooBar" will put the value into the envelope-ext-store named "FooBar"; you can have multiple ones with different names |
| string valueStringNeedBig | - | the new value to set; set it to "", when setNewValue=false |
| boolean setNewValue | - | true, set a new value; false, just return the current value |
| Returnvalues: |
| boolean retval | - | true, getting/setting the value was successful; falsem getting/setting the value was unsuccessful |
| string valuestrNeedBig | - | the current value set |
^
GetSetEnvelopeStateFunctioncall:
C: bool GetSetEnvelopeState(TrackEnvelope* env, char* str, int str_sz)
EEL2: bool GetSetEnvelopeState(TrackEnvelope env, #str)
Lua: boolean retval, string str = reaper.GetSetEnvelopeState(TrackEnvelope env, string str)
Python: (Boolean retval, TrackEnvelope env, String str, Int str_sz) = RPR_GetSetEnvelopeState(env, str, str_sz)
Description:
| Parameters: |
| TrackEnvelope env | - | the envelope, of which you want to get/set the value
|
| string str | - | the new value to set
|
| Returnvalues: |
| boolean retval | - | true, getting/setting was successful; false, getting/setting was unsuccessful
|
| string str | - | the value currently set
|
^
GetSetEnvelopeState2Functioncall:
C: bool GetSetEnvelopeState2(TrackEnvelope* env, char* str, int str_sz, bool isundo)
EEL2: bool GetSetEnvelopeState2(TrackEnvelope env, #str, bool isundo)
Lua: boolean retval, string str = reaper.GetSetEnvelopeState2(TrackEnvelope env, string str, boolean isundo)
Python: (Boolean retval, TrackEnvelope env, String str, Int str_sz, Boolean isundo) = RPR_GetSetEnvelopeState2(env, str, str_sz, isundo)
Description:
| Parameters: |
| TrackEnvelope env | - | the envelope to get/set the state of
|
| string str | - | the new value to set
|
| boolean isundo | - | true, undo; false, don't undo
|
| Returnvalues: |
| boolean retval | - | true, getting/setting was successful; false, getting/setting was unsuccessful
|
| string str | - | the value currently set
|
^
GetSetItemStateFunctioncall:
C: bool GetSetItemState(MediaItem* item, char* str, int str_sz)
EEL2: bool GetSetItemState(MediaItem item, #str)
Lua: boolean retval, string str = reaper.GetSetItemState(MediaItem item, string str)
Python: (Boolean retval, MediaItem item, String str, Int str_sz) = RPR_GetSetItemState(item, str, str_sz)
Description:
| Parameters: |
| MediaItem item | - |
|
| string str | - |
|
| Returnvalues: |
| boolean retval | - | true, getting/setting was successful; false, getting/setting was unsuccessful
|
| string str | - | the value currently set
|
^
GetSetItemState2Functioncall:
C: bool GetSetItemState2(MediaItem* item, char* str, int str_sz, bool isundo)
EEL2: bool GetSetItemState2(MediaItem item, #str, bool isundo)
Lua: boolean retval, string str = reaper.GetSetItemState2(MediaItem item, string str, boolean isundo)
Python: (Boolean retval, MediaItem item, String str, Int str_sz, Boolean isundo) = RPR_GetSetItemState2(item, str, str_sz, isundo)
Description:
| Parameters: |
| MediaItem item | - | the new item to set
|
| string str | - | the new value to set
|
| boolean isundo | - | true, undo; false, don't undo
|
| Returnvalues: |
| boolean retval | - | true, getting/setting was successful; false, getting/setting was unsuccessful
|
| string str | - | the value currently set
|
^
GetSetMediaItemInfo_StringFunctioncall:
C: bool GetSetMediaItemInfo_String(MediaItem* item, const char* parmname, char* stringNeedBig, bool setNewValue)
EEL2: bool GetSetMediaItemInfo_String(MediaItem item, "parmname", #stringNeedBig, bool setNewValue)
Lua: boolean retval, string stringNeedBig = reaper.GetSetMediaItemInfo_String(MediaItem item, string parmname, string stringNeedBig, boolean setNewValue)
Python: (Boolean retval, MediaItem item, String parmname, String stringNeedBig, Boolean setNewValue) = RPR_GetSetMediaItemInfo_String(item, parmname, stringNeedBig, setNewValue)
Description:Gets/sets an item attribute string:
P_NOTES : char * : item note text (do not write to returned pointer, use setNewValue to update)
P_EXT:xyz : char * : extension-specific persistent data
GUID : GUID * : 16-byte GUID, can query or update. If using a _String() function, GUID is a string {xyz-...}.
| Parameters: |
| MediaItem item | - | |
| string parmname | - | |
| string stringNeedBig | - | |
| boolean setNewValue | - | |
| Returnvalues: |
| boolean retval | - | |
| string stringNeedBig | - | |
^
GetSetMediaItemTakeInfo_StringFunctioncall:
C: bool GetSetMediaItemTakeInfo_String(MediaItem_Take* tk, const char* parmname, char* stringNeedBig, bool setnewvalue)
EEL2: bool GetSetMediaItemTakeInfo_String(MediaItem_Take tk, "parmname", #stringNeedBig, bool setnewvalue)
Lua: boolean retval, string stringNeedBig = reaper.GetSetMediaItemTakeInfo_String(MediaItem_Take tk, string parmname, string stringNeedBig, boolean setnewvalue)
Python: (Boolean retval, MediaItem_Take tk, String parmname, String stringNeedBig, Boolean setnewvalue) = RPR_GetSetMediaItemTakeInfo_String(tk, parmname, stringNeedBig, setnewvalue)
Description:Gets/sets a take attribute string:
P_NAME : char * : take name
P_EXT:xyz : char * : extension-specific persistent data
GUID : GUID * : 16-byte GUID, can query or update. If using a _String() function, GUID is a string {xyz-...}.
| Parameters: |
| MediaItem_Take tk | - | |
| string parmname | - | |
| string stringNeedBig | - | |
| boolean setnewvalue | - | |
| Returnvalues: |
| boolean retval | - | |
| string stringNeedBig | - | |
^
GetSetMediaTrackInfo_StringFunctioncall:
C: bool GetSetMediaTrackInfo_String(MediaTrack* tr, const char* parmname, char* stringNeedBig, bool setnewvalue)
EEL2: bool GetSetMediaTrackInfo_String(MediaTrack tr, "parmname", #stringNeedBig, bool setnewvalue)
Lua: boolean retval, string stringNeedBig = reaper.GetSetMediaTrackInfo_String(MediaTrack tr, string parmname, string stringNeedBig, boolean setnewvalue)
Python: (Boolean retval, MediaTrack tr, String parmname, String stringNeedBig, Boolean setnewvalue) = RPR_GetSetMediaTrackInfo_String(tr, parmname, stringNeedBig, setnewvalue)
Description:Get or set track string attributes.
P_NAME : char * : track name (on master returns NULL)
P_ICON : const char * : track icon (full filename, or relative to resource_path/data/track_icons)
P_MCP_LAYOUT : const char * : layout name
P_RAZOREDITS : const char * : list of razor edit areas, as space-separated triples of start time, end time, and envelope GUID string.
Passing the guid sets selection within the envelope; not passing the guid sets the selection within the track itself.
Example: "0.00 1.00 \"\" 0.00 1.00 "{xyz-...}"
Set stringNeedBig="" and setnewvalue=false to query the currently set razor-edits on this track.
P_TCP_LAYOUT : const char * : layout name
P_EXT:xyz : char * : extension-specific persistent data
GUID : GUID * : 16-byte GUID, can query or update. If using a _String() function, GUID is a string {xyz-...}.
| Parameters: |
| MediaTrack tr | - | |
| string parmname | - | |
| string stringNeedBig | - | |
| boolean setnewvalue | - | |
| Returnvalues: |
| boolean retval | - | |
| string stringNeedBig | - | |
^
GetSetProjectAuthorFunctioncall:
C: void GetSetProjectAuthor(ReaProject* proj, bool set, char* author, int author_sz)
EEL2: GetSetProjectAuthor(ReaProject proj, bool set, #author)
Lua: string author = reaper.GetSetProjectAuthor(ReaProject proj, boolean set, string author)
Python: (ReaProject proj, Boolean set, String author, Int author_sz) = RPR_GetSetProjectAuthor(proj, set, author, author_sz)
Description:gets or sets project author, author_sz is ignored when setting
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| boolean set | - | true, set new author; false, get current project's author
|
| string author | - | the new project author, when set is true. When set is false, author will be ignored.
|
| Returnvalues: |
| string author | - | the (new) project's author
|
^
GetSetProjectGridFunctioncall:
C: int GetSetProjectGrid(ReaProject* project, bool set, double* divisionInOutOptional, int* swingmodeInOutOptional, double* swingamtInOutOptional)
EEL2: int GetSetProjectGrid(ReaProject project, bool set, optional &divisionIn, optional int &swingmodeIn, optional &swingamtIn)
Lua: integer retval, optional number divisionIn, optional number swingmodeIn, optional number swingamtIn = reaper.GetSetProjectGrid(ReaProject project, boolean set)
Python: (Int retval, ReaProject project, Boolean set, Float divisionInOutOptional, Int swingmodeInOutOptional, Float swingamtInOutOptional) = RPR_GetSetProjectGrid(project, set, divisionInOutOptional, swingmodeInOutOptional, swingamtInOutOptional)
Description:Get or set the arrange view grid division. 0.25=quarter note, 1.0/3.0=half note triplet, etc. swingmode can be 1 for swing enabled, swingamt is -1..1. swingmode can be 3 for measure-grid. Returns grid configuration flags
| Parameters: |
| ReaProject project | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| boolean set | - |
|
| Returnvalues: |
| integer retval | - |
|
| optional number divisionIn | - |
|
| optional number swingmodeIn | - |
|
| optional number swingamtIn | - |
|
^
GetSetProjectInfoFunctioncall:
C: double GetSetProjectInfo(ReaProject* project, const char* desc, double value, bool is_set)
EEL2: double GetSetProjectInfo(ReaProject project, "desc", value, bool is_set)
Lua: number value = reaper.GetSetProjectInfo(ReaProject project, string desc, number value, boolean is_set)
Python: Float RPR_GetSetProjectInfo(ReaProject project, String desc, Float value, Boolean is_set)
Description:Get or set project information.
RENDER_SETTINGS : &(1|2)=0:master mix, &1=stems+master mix, &2=stems only, &4=multichannel tracks to multichannel files, &8=use render matrix, &16=tracks with only mono media to mono files, &32=selected media items, &64=selected media items via master, & 128=Selected tracks via master, &256=Stretch markers/transient guide-checkbox(Only with WAV/AIFF and Source=Selected media items/Selected media items via master), &512=Embed Metadata, if format supports is, &1024=Take markers-checkbox(Only with WAV and Source=Selected media items/Selected media items via master); &2048=2nd pass render
OGG, OPUS and FLAC support embedding of tempoinformation via metadata, settable using
GetSetProjectInfo_String.
RENDER_BOUNDSFLAG : 0=custom time bounds, 1=entire project, 2=time selection, 3=all project regions, 4=selected media items, 5=selected project regions
RENDER_CHANNELS : number of channels in rendered file
RENDER_SRATE : sample rate of rendered file (or 0 for project sample rate)
RENDER_STARTPOS : render start time when RENDER_BOUNDSFLAG=0
RENDER_ENDPOS : render end time when RENDER_BOUNDSFLAG=0
RENDER_TAILFLAG : apply render tail setting when rendering: &1=custom time bounds, &2=entire project, &4=time selection, &8=all project regions, &16=selected media items, &32=selected project regions
RENDER_TAILMS : tail length in ms to render (only used if RENDER_BOUNDSFLAG and RENDER_TAILFLAG are set)
RENDER_ADDTOPROJ : &1=add rendered files to project, &2=Do not render files that are likely silent
RENDER_DITHER : &1=dither, &2=noise shaping, &4=dither stems, &8=noise shaping on stems
PROJECT_SRATE : samplerate (ignored unless PROJECT_SRATE_USE set)
PROJECT_SRATE_USE : set to 1 if project samplerate is used
| Parameters: |
| ReaProject project | - | the project, whos project settings you want to get/set; 0, for the current project
|
| string desc | - | the attribute you want to get/set, like RENDERCHANNELS, PROJECTSRATE, RENDER_SETTINGS, etc
|
| number value | - | if isset==true, this is the new value to set; if isset==false, set this to 0
|
| boolean is_set | - | true, set a new value; false, get the current value
|
| Returnvalues: |
| number value | - | the new/current value set with this attribute
|
^
GetSetProjectInfo_StringFunctioncall:
C: bool GetSetProjectInfo_String(ReaProject* project, const char* desc, char* valuestrNeedBig, bool is_set)
EEL2: bool GetSetProjectInfo_String(ReaProject project, "desc", #valuestrNeedBig, bool is_set)
Lua: boolean retval, string valuestrNeedBig = reaper.GetSetProjectInfo_String(ReaProject project, string desc, string valuestrNeedBig, boolean is_set)
Python: (Boolean retval, ReaProject project, String desc, String valuestrNeedBig, Boolean is_set) = RPR_GetSetProjectInfo_String(project, desc, valuestrNeedBig, is_set)
Description:Get or set project information.
TRACK_GROUP_NAME:X : track group name, X should be 1..64
MARKER_GUID:X : get the GUID (unique ID) of the marker or region with index X, where X is the index passed to EnumProjectMarkers, not necessarily the displayed number
RECORD_PATH: recording directory -- may be blank or a relative path, to get the effective path see
GetProjectPathEx RENDER_FILE: render directory
RENDER_PATTERN: render file name (may contain wildcards)
RENDER_TARGETS: semicolon separated list of files that would be written if the project is rendered using the most recent render settings
RENDER_FORMAT: base64-encoded sink configuration (see project files, etc). Callers can also pass a simple 4-byte string (non-base64-encoded), to use default settings for that sink type.
RENDER_FORMAT2: base64-encoded secondary sink configuration. Callers can also pass a simple 4-byte string (non-base64-encoded), e.g. "evaw" or "l3pm", to use default settings for that sink type, or "" to disable secondary render.
see
render-code-documentation for how the unencoded RENDER_FORMAT-string is structured.
To just use the 4-byte-string, you can use:
"evaw" for wave, "ffia" for aiff, " osi" for audio-cd, " pdd" for ddp, "calf" for flac, "l3pm" for mp3, "vggo" for ogg, "SggO" for Opus, "PMFF" for FFMpeg-video, "FVAX" for MP4Video/Audio on Mac, " FIG" for Gif, " FCL" for LCF, "kpvw" for wavepack
RENDER_METADATA: get or set the metadata saved with the project (not metadata embedded in project media). Example, ID3 album name metadata: Uses common ID3-tagcodes like TALB(album), TPE1(Artist), etc.
To get album tag, use "ID3:TALB", to set album tag, use "ID3:TALB|my album name".
Examples in Lua:
getting the album name from the metadata of the current project:
retval, albumname = reaper.GetSetProjectInfo_String(0, "RENDER_METADATA", "ID3:TALB", false)
setting the album name in the metadata of the current project:
retval, albumame_new = reaper.GetSetProjectInfo_String(0, "RENDER_METADATA", "ID3:TALB|New album name", true)
Supported tags-codes are: TIT2(Title), TPE1(Artist), TPE2(Albumartist), TALB(Album), TRCK(Track), TCON(Genre), TYER(Year), TDRC(Recording time: YYYY-MM-DD), TKEY(Key), TBPM(Tempo), TSRC(International Standard Recording Code), COMM(Comment), COMM_LANG(Comment language), APIC_TYPE(Image type), APIC_DESC(Image description), APIC_FILE(Image file)
APIC_TYPE can have be of the following:
0: Other
1: 32x32 pixel file icon (PNG only)
2: Other file icon
3: Cover (front)
4: Cover (back)
5: Leaflet page
6: Media
7: Lead artist/Lead Performer/Solo
8: Artist/Performer
9: Conductor
10: Band/Orchestra
11: Composer
12: Lyricist/Text writer
13: Recording location
14: During recording
15: During performance
16: Movie/video screen capture
17: A bright colored fish
18: Illustration
19: Band/Artist logotype
20: Publisher/Studiotype
| Parameters: |
| ReaProject project | - | the project, whose setting you want to get or set
|
| string desc | - | the setting, that you want to get/set; refer description for available ones
|
| string valuestrNeedBig | - | if is_set==true, this is the new value to set
|
| boolean is_set | - | true, set a new value; false, just get the current one
|
| Returnvalues: |
| boolean retval | - | true, value can be set/get; false, value can't be set/get
|
| string valuestrNeedBig | - | the current value for this project-setting
|
^
GetSetProjectNotesFunctioncall:
C: void GetSetProjectNotes(ReaProject* proj, bool set, char* notesNeedBig, int notesNeedBig_sz)
EEL2: GetSetProjectNotes(ReaProject proj, bool set, #notes)
Lua: string notes = reaper.GetSetProjectNotes(ReaProject proj, boolean set, string notes)
Python: (ReaProject proj, Boolean set, String notesNeedBig, Int notesNeedBig_sz) = RPR_GetSetProjectNotes(proj, set, notesNeedBig, notesNeedBig_sz)
Description:gets or sets project notes, notesNeedBig_sz is ignored when setting
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| boolean set | - | true, set the project's notes; false, get the project's notes
|
| string notes | - | the new project's notes, when set is set to true
|
| Returnvalues: |
| string notes | - | the notes stored in the project's notes.
|
^
GetSetRepeatFunctioncall:
C: int GetSetRepeat(int val)
EEL2: int GetSetRepeat(int val)
Lua: integer = reaper.GetSetRepeat(integer val)
Python: Int RPR_GetSetRepeat(Int val)
Description:Sets or gets repeat-state of the current project.
| Parameters: |
| integer val | - | -1, query repeat-state 0, clear repeat state 1, set repeat to repeat 2 and higher, toggle repeat state |
| Returnvalues: |
| integer | - | new/current repeat state; 0, repeat is off; 1, repeat is on |
^
GetSetRepeatExFunctioncall:
C: int GetSetRepeatEx(ReaProject* proj, int val)
EEL2: int GetSetRepeatEx(ReaProject proj, int val)
Lua: integer = reaper.GetSetRepeatEx(ReaProject proj, integer val)
Python: Int RPR_GetSetRepeatEx(ReaProject proj, Int val)
Description:Sets or gets repeat-state in a specific project.
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| integer val | - | -1, query repeat-state 0, clear repeat state 1, set repeat to repeat 2 and higher, toggle repeat state
|
| Returnvalues: |
| integer | - | new/current repeat state; 0, repeat is off; 1, repeat is on
|
^
GetSetTrackGroupMembershipFunctioncall:
C: unsigned int GetSetTrackGroupMembership(MediaTrack* tr, const char* groupname, unsigned int setmask, unsigned int setvalue)
EEL2: uint GetSetTrackGroupMembership(MediaTrack tr, "groupname", uint setmask, uint setvalue)
Lua: integer = reaper.GetSetTrackGroupMembership(MediaTrack tr, string groupname, integer setmask, integer setvalue)
Python: Int RPR_GetSetTrackGroupMembership(MediaTrack tr, String groupname, Int setmask, Int setvalue)
Description:Gets or modifies the group membership for a track. Returns group state prior to call (each bit represents one of the 32 group numbers). if setmask has bits set, those bits in setvalue will be applied to group. Group can be one of:
VOLUME_LEAD
VOLUME_FOLLOW
VOLUME_VCA_LEAD
VOLUME_VCA_FOLLOW
PAN_LEAD
PAN_FOLLOW
WIDTH_LEAD
WIDTH_FOLLOW
MUTE_LEAD
MUTE_FOLLOW
SOLO_LEAD
SOLO_FOLLOW
RECARM_LEAD
RECARM_FOLLOW
POLARITY_LEAD
POLARITY_FOLLOW
AUTOMODE_LEAD
AUTOMODE_FOLLOW
VOLUME_REVERSE
PAN_REVERSE
WIDTH_REVERSE
NO_LEAD_WHEN_FOLLOW
VOLUME_VCA_FOLLOW_ISPREFX
Note: REAPER v6.11 and earlier used _MASTER and _SLAVE rather than _LEAD and _FOLLOW, which is deprecated but still supported (scripts that must support v6.11 and earlier can use the deprecated strings).
| Parameters: |
| MediaTrack tr | - | |
| string groupname | - | |
| integer setmask | - | |
| integer setvalue | - | |
^
GetSetTrackStateFunctioncall:
C: bool GetSetTrackState(MediaTrack* track, char* str, int str_sz)
EEL2: bool GetSetTrackState(MediaTrack track, #str)
Lua: boolean retval, string str = reaper.GetSetTrackState(MediaTrack track, string str)
Python: (Boolean retval, MediaTrack track, String str, Int str_sz) = RPR_GetSetTrackState(track, str, str_sz)
Description:
| Parameters: |
| MediaTrack track | - |
|
| string str | - |
|
| Returnvalues: |
| boolean retval | - |
|
| string str | - |
|
^
GetSetTrackState2Functioncall:
C: bool GetSetTrackState2(MediaTrack* track, char* str, int str_sz, bool isundo)
EEL2: bool GetSetTrackState2(MediaTrack track, #str, bool isundo)
Lua: boolean retval, string str = reaper.GetSetTrackState2(MediaTrack track, string str, boolean isundo)
Python: (Boolean retval, MediaTrack track, String str, Int str_sz, Boolean isundo) = RPR_GetSetTrackState2(track, str, str_sz, isundo)
Description:
| Parameters: |
| MediaTrack track | - |
|
| string str | - |
|
| boolean isundo | - |
|
| Returnvalues: |
| boolean retval | - |
|
| string str | - |
|
^
GetSubProjectFromSourceFunctioncall:
C: ReaProject* GetSubProjectFromSource(PCM_source* src)
EEL2: ReaProject GetSubProjectFromSource(PCM_source src)
Lua: ReaProject = reaper.GetSubProjectFromSource(PCM_source src)
Python: ReaProject RPR_GetSubProjectFromSource(PCM_source src)
Description:
| Returnvalues: |
| ReaProject | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
^
GetTakeFunctioncall:
C: MediaItem_Take* GetTake(MediaItem* item, int takeidx)
EEL2: MediaItem_Take GetTake(MediaItem item, int takeidx)
Lua: MediaItem_Take = reaper.GetTake(MediaItem item, integer takeidx)
Python: MediaItem_Take RPR_GetTake(MediaItem item, Int takeidx)
Description:get a take from an item by take count (zero-based)
| Parameters: |
| MediaItem item | - | the MediaItem, whose take you want to request |
| integer takeidx | - | the index of the takes in a MediaItem |
| Returnvalues: |
| MediaItem_Take | - | the requested MediaItem_Take |
^
GetTakeEnvelopeFunctioncall:
C: TrackEnvelope* GetTakeEnvelope(MediaItem_Take* take, int envidx)
EEL2: TrackEnvelope GetTakeEnvelope(MediaItem_Take take, int envidx)
Lua: TrackEnvelope = reaper.GetTakeEnvelope(MediaItem_Take take, integer envidx)
Python: TrackEnvelope RPR_GetTakeEnvelope(MediaItem_Take take, Int envidx)
Description:
| Parameters: |
| MediaItem_Take take | - | |
| integer envidx | - | |
| Returnvalues: |
| TrackEnvelope | - | |
^
GetTakeEnvelopeByNameFunctioncall:
C: TrackEnvelope* GetTakeEnvelopeByName(MediaItem_Take* take, const char* envname)
EEL2: TrackEnvelope GetTakeEnvelopeByName(MediaItem_Take take, "envname")
Lua: TrackEnvelope = reaper.GetTakeEnvelopeByName(MediaItem_Take take, string envname)
Python: TrackEnvelope RPR_GetTakeEnvelopeByName(MediaItem_Take take, String envname)
Description:
| Parameters: |
| MediaItem_Take take | - | |
| string envname | - | |
| Returnvalues: |
| TrackEnvelope | - | |
^
GetTakeMarkerFunctioncall:
C: double position = GetTakeMarker(MediaItem_Take* take, int idx, char* nameOut, int nameOut_sz, int* colorOutOptional)
EEL2: double position = GetTakeMarker(MediaItem_Take take, int idx, #name, optional int &color)
Lua: number position, string name, optional number color = reaper.GetTakeMarker(MediaItem_Take take, integer idx)
Python: (Float position, MediaItem_Take take, Int idx, String nameOut, Int nameOut_sz, Int colorOutOptional) = RPR_GetTakeMarker(take, idx, nameOut, nameOut_sz, colorOutOptional))
Description:
| Parameters: |
| MediaItem_Take take | - | the take, whose take-marker you want to get
|
| integer idx | - | the id of the marker within the take, 0 for the first, 1 for the second, etc.
|
| Returnvalues: |
| number position | - | the position of the takemarker within the take in seconds
|
| string name | - | the name of the takemarker
|
| optional number color | - | the color of the takemarker
|
^
GetTakeNameFunctioncall:
C: const char* GetTakeName(MediaItem_Take* take)
EEL2: bool GetTakeName(#retval, MediaItem_Take take)
Lua: takename = reaper.GetTakeName(MediaItem_Take take)
Python: String RPR_GetTakeName(MediaItem_Take take)
Description:Retruns the filename of the mediafile in a take. returns NULL if the take is not valid
| Parameters: |
| MediaItem_Take take | - | the MediaItem_Take, whose mediafilename you want to have |
| Returnvalues: |
| string takename | - | the filename of the mediafile in the take |
^
GetTakeNumStretchMarkersFunctioncall:
C: int GetTakeNumStretchMarkers(MediaItem_Take* take)
EEL2: int GetTakeNumStretchMarkers(MediaItem_Take take)
Lua: integer = reaper.GetTakeNumStretchMarkers(MediaItem_Take take)
Python: Int RPR_GetTakeNumStretchMarkers(MediaItem_Take take)
Description:Returns number of stretch markers in take
| Parameters: |
| MediaItem_Take take | - | |
^
GetTakeStretchMarkerFunctioncall:
C: int GetTakeStretchMarker(MediaItem_Take* take, int idx, double* posOut, double* srcposOutOptional)
EEL2: int GetTakeStretchMarker(MediaItem_Take take, int idx, &pos, optional &srcpos)
Lua: integer retval, number pos, optional number srcpos = reaper.GetTakeStretchMarker(MediaItem_Take take, integer idx)
Python: (Int retval, MediaItem_Take take, Int idx, Float posOut, Float srcposOutOptional) = RPR_GetTakeStretchMarker(take, idx, posOut, srcposOutOptional)
Description:Gets information on a stretch marker, idx is 0..n. Returns false if stretch marker not valid.
posOut will be set to position in item, srcposOutOptional will be set to source media position.
Returns index. if input index is -1, next marker is found using position (or source position if position is -1).
If position/source position are used to find marker position, their values are not updated.
| Parameters: |
| MediaItem_Take take | - | |
| integer idx | - | |
| Returnvalues: |
| integer retval | - | |
| number pos | - | |
| optional number srcpos | - | |
^
GetTakeStretchMarkerSlopeFunctioncall:
C: double GetTakeStretchMarkerSlope(MediaItem_Take* take, int idx)
EEL2: double GetTakeStretchMarkerSlope(MediaItem_Take take, int idx)
Lua: number = reaper.GetTakeStretchMarkerSlope(MediaItem_Take take, integer idx)
Python: Float RPR_GetTakeStretchMarkerSlope(MediaItem_Take take, Int idx)
Description:
| Parameters: |
| MediaItem_Take take | - |
|
| integer idx | - |
|
^
GetTCPFXParmFunctioncall:
C: bool GetTCPFXParm(ReaProject* project, MediaTrack* track, int index, int* fxindexOut, int* parmidxOut)
EEL2: bool GetTCPFXParm(ReaProject project, MediaTrack track, int index, int &fxindex, int &parmidx)
Lua: boolean retval, number fxindex, number parmidx = reaper.GetTCPFXParm(ReaProject project, MediaTrack track, integer index)
Python: (Boolean retval, ReaProject project, MediaTrack track, Int index, Int fxindexOut, Int parmidxOut) = RPR_GetTCPFXParm(project, track, index, fxindexOut, parmidxOut)
Description:
| Parameters: |
| ReaProject project | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| MediaTrack track | - |
|
| integer index | - |
|
| Returnvalues: |
| boolean retval | - |
|
| number fxindex | - |
|
| number parmidx | - |
|
^
GetTempoMatchPlayRateFunctioncall:
C: bool GetTempoMatchPlayRate(PCM_source* source, double srcscale, double position, double mult, double* rateOut, double* targetlenOut)
EEL2: bool GetTempoMatchPlayRate(PCM_source source, srcscale, position, mult, &rate, &targetlen)
Lua: boolean retval, number rate, number targetlen = reaper.GetTempoMatchPlayRate(PCM_source source, number srcscale, number position, number mult)
Python: (Boolean retval, PCM_source source, Float srcscale, Float position, Float mult, Float rateOut, Float targetlenOut) = RPR_GetTempoMatchPlayRate(source, srcscale, position, mult, rateOut, targetlenOut)
Description:finds the playrate and target length to insert this item stretched to a round power-of-2 number of bars, between 1/8 and 256
| Parameters: |
| PCM_source source | - | |
| number srcscale | - | |
| number position | - | |
| number mult | - | |
| Returnvalues: |
| boolean retval | - | |
| number rate | - | |
| number targetlen | - | |
^
GetTempoTimeSigMarkerFunctioncall:
C: bool GetTempoTimeSigMarker(ReaProject* proj, int ptidx, double* timeposOut, int* measureposOut, double* beatposOut, double* bpmOut, int* timesig_numOut, int* timesig_denomOut, bool* lineartempoOut)
EEL2: bool GetTempoTimeSigMarker(ReaProject proj, int ptidx, &timepos, int &measurepos, &beatpos, &bpm, int ×ig_num, int ×ig_denom, bool &lineartempo)
Lua: boolean retval, number timepos, number measurepos, number beatpos, number bpm, number timesig_num, number timesig_denom, boolean lineartempo = reaper.GetTempoTimeSigMarker(ReaProject proj, integer ptidx)
Python: (Boolean retval, ReaProject proj, Int ptidx, Float timeposOut, Int measureposOut, Float beatposOut, Float bpmOut, Int timesig_numOut, Int timesig_denomOut, Boolean lineartempoOut) = RPR_GetTempoTimeSigMarker(proj, ptidx, timeposOut, measureposOut, beatposOut, bpmOut, timesig_numOut, timesig_denomOut, lineartempoOut)
Description:
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| integer ptidx | - |
|
| Returnvalues: |
| boolean retval | - |
|
| number timepos | - |
|
| number measurepos | - |
|
| number beatpos | - |
|
| number bpm | - |
|
| number timesig_num | - |
|
| number timesig_denom | - |
|
| boolean lineartempo | - |
|
^
GetThemeColorFunctioncall:
C: int GetThemeColor(const char* ini_key, int flagsOptional)
EEL2: int GetThemeColor("ini_key", int flags)
Lua: integer retval = reaper.GetThemeColor(string ini_key, integer flags)
Python: Int RPR_GetThemeColor(String ini_key, Int flagsOptional)
Description:Returns the theme color specified, or -1 on failure. If the low bit of flags is set, the color as originally specified by the theme (before any transformations) is returned, otherwise the current (possibly transformed and modified) color is returned. See
SetThemeColor for a list of valid ini_key.
| Parameters: |
| string ini_key | - |
|
| integer flags | - |
|
| Returnvalues: |
| integer retval | - |
|
^
GetToggleCommandStateFunctioncall:
C: int GetToggleCommandState(int command_id)
EEL2: int GetToggleCommandState(int command_id)
Lua: integer = reaper.GetToggleCommandState(integer command_id)
Python: Int RPR_GetToggleCommandState(Int command_id)
Description:
| Parameters: |
| integer command_id | - | the command_id, whose toggle-state you want to know.
|
| Returnvalues: |
| integer | - | toggle-state 0, off &1, on/checked in menus &2, on/grayed out in menus &16, on/bullet in front of the entry in menus -1, NA because the action does not have on/off states.
|
^
GetToggleCommandStateExFunctioncall:
C: int GetToggleCommandStateEx(int section_id, int command_id)
EEL2: int GetToggleCommandStateEx(int section_id, int command_id)
Lua: integer = reaper.GetToggleCommandStateEx(integer section_id, integer command_id)
Python: Int RPR_GetToggleCommandStateEx(Int section_id, Int command_id)
Description:Return toggle-state of an action.
For the main action context, the MIDI editor, or the media explorer, returns the toggle state of the action. For the MIDI editor, the action state for the most recently focused window will be returned.
See
NamedCommandLookup() for the correct command_id.
| Parameters: |
| integer section_id | - | the section, in which the action lies 0, Main 100, Main (alt recording) 32060, MIDI Editor 32061, MIDI Event List Editor 32062, MIDI Inline Editor 32063, Media Explorer
|
| integer command_id | - | the command_id, whose toggle-state you want to know.
|
| Returnvalues: |
| integer | - | toggle-state 0, off &1, on/checked in menus &2, on/grayed out in menus &16, on/bullet in front of the entry in menus -1, NA because the action does not have on/off states.
|
^
GetTooltipWindowFunctioncall:
C: HWND GetTooltipWindow()
EEL2: HWND GetTooltipWindow()
Lua: HWND = reaper.GetTooltipWindow()
Python: HWND RPR_GetTooltipWindow()
Description:gets a tooltip window,in case you want to ask it for font information. Can return NULL.
| Returnvalues: |
| HWND | - | the tooltip-window |
^
GetTrackFunctioncall:
C: MediaTrack* GetTrack(ReaProject* proj, int trackidx)
EEL2: MediaTrack GetTrack(ReaProject proj, int trackidx)
Lua: MediaTrack = reaper.GetTrack(ReaProject proj, integer trackidx)
Python: MediaTrack RPR_GetTrack(ReaProject proj, Int trackidx)
Description:get a track from a project by track count (zero-based) (proj=0 for active project)
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| integer trackidx | - | the tracknumber; 0 for the first track, 1 for the second track, etc.
|
| Returnvalues: |
| MediaTrack | - | the requested MediaTrack as an object
|
^
GetTrackAutomationModeFunctioncall:
C: int GetTrackAutomationMode(MediaTrack* tr)
EEL2: int GetTrackAutomationMode(MediaTrack tr)
Lua: integer = reaper.GetTrackAutomationMode(MediaTrack tr)
Python: Int RPR_GetTrackAutomationMode(MediaTrack tr)
Description:return the track mode, regardless of global override
| Parameters: |
| MediaTrack tr | - | |
^
GetTrackColorFunctioncall:
C: int GetTrackColor(MediaTrack* track)
EEL2: int GetTrackColor(MediaTrack track)
Lua: integer = reaper.GetTrackColor(MediaTrack track)
Python: Int RPR_GetTrackColor(MediaTrack track)
Description:Returns the track custom color as OS dependent color|0x100000 (i.e. ColorToNative(r,g,b)|0x100000). Black is returned as 0x01000000, no color setting is returned as 0.
| Parameters: |
| MediaTrack track | - | the MediaTrack, whose color you want to request |
| Returnvalues: |
| integer | - | the os-dependent color |
^
GetTrackDepthFunctioncall:
C: int GetTrackDepth(MediaTrack* track)
EEL2: int GetTrackDepth(MediaTrack track)
Lua: integer = reaper.GetTrackDepth(MediaTrack track)
Python: Int RPR_GetTrackDepth(MediaTrack track)
Description:Get the depth of a track within a folder structure
| Parameters: |
| MediaTrack track | - | the MediaTrack whose position in the track-folder-structure you want to request |
| Returnvalues: |
| integer | - | the position in the track-folder-structure; 0 for the highest level or unfoldered tracks |
^
GetTrackEnvelopeFunctioncall:
C: TrackEnvelope* GetTrackEnvelope(MediaTrack* track, int envidx)
EEL2: TrackEnvelope GetTrackEnvelope(MediaTrack track, int envidx)
Lua: TrackEnvelope = reaper.GetTrackEnvelope(MediaTrack track, integer envidx)
Python: TrackEnvelope RPR_GetTrackEnvelope(MediaTrack track, Int envidx)
Description:
| Parameters: |
| MediaTrack track | - | |
| integer envidx | - | |
| Returnvalues: |
| TrackEnvelope | - | |
^
GetTrackEnvelopeByChunkNameFunctioncall:
C: TrackEnvelope* GetTrackEnvelopeByChunkName(MediaTrack* tr, const char* cfgchunkname_or_guid)
EEL2: TrackEnvelope GetTrackEnvelopeByChunkName(MediaTrack tr, "cfgchunkname_or_guid")
Lua: TrackEnvelope = reaper.GetTrackEnvelopeByChunkName(MediaTrack tr, string cfgchunkname_or_guid)
Python: TrackEnvelope RPR_GetTrackEnvelopeByChunkName(MediaTrack tr, String cfgchunkname_or_guid)
Description:Gets a built-in track envelope by configuration chunk name, e.g. "<VOLENV" or GUID string, like "{B577250D-146F-B544-9B34-F24FBE488F1F}".
| Parameters: |
| MediaTrack tr | - | |
| string cfgchunkname_or_guid | - | |
| Returnvalues: |
| TrackEnvelope | - | |
^
GetTrackEnvelopeByNameFunctioncall:
C: TrackEnvelope* GetTrackEnvelopeByName(MediaTrack* track, const char* envname)
EEL2: TrackEnvelope GetTrackEnvelopeByName(MediaTrack track, "envname")
Lua: TrackEnvelope = reaper.GetTrackEnvelopeByName(MediaTrack track, string envname)
Python: TrackEnvelope RPR_GetTrackEnvelopeByName(MediaTrack track, String envname)
Description:
| Parameters: |
| MediaTrack track | - | |
| stirng envname | - | |
| Returnvalues: |
| TrackEnvelope | - | |
^
GetTrackFromPointFunctioncall:
C: MediaTrack* GetTrackFromPoint(int screen_x, int screen_y, int* infoOutOptional)
EEL2: MediaTrack GetTrackFromPoint(int screen_x, int screen_y, optional int &info)
Lua: MediaTrack retval, optional number info = reaper.GetTrackFromPoint(integer screen_x, integer screen_y)
Python: (MediaTrack retval, Int screen_x, Int screen_y, Int infoOutOptional) = RPR_GetTrackFromPoint(screen_x, screen_y, infoOutOptional)
Description:Returns the track from the screen coordinates specified. If the screen coordinates refer to a window associated to the track (such as FX), the track will be returned. infoOutOptional will be set to 1 if it is likely an envelope, 2 if it is likely a track FX.
Note: You can not get the track at screen-coordinates, where it is hidden by other windows.
| Parameters: |
| integer screen_x | - | the x-position in pixels, from which you want to get the underlying track |
| integer screen_y | - | the y-position in pixels, from which you want to get the underlying track |
| Returnvalues: |
| MediaTrack retval | - | the MediaTrack at position; if the position is above a window associated with the track, this holds the track, where retval info will hold additional information |
| optional number info | - | additional information, if the position is above a windows associated with a track
1, if it is likely an envelope
2, if it is likely a track FX |
^
GetTrackGUIDFunctioncall:
C: GUID* GetTrackGUID(MediaTrack* tr)
EEL2: bool GetTrackGUID(#retguid, MediaTrack tr)
Lua: string GUID = reaper.GetTrackGUID(MediaTrack tr)
Python: GUID RPR_GetTrackGUID(MediaTrack tr)
Description:Get the guid of a MediaTrack
| Parameters: |
| MediaTrack tr | - | |
| Returnvalues: |
| string GUID | - | |
^
GetTrackMediaItemFunctioncall:
C: MediaItem* GetTrackMediaItem(MediaTrack* tr, int itemidx)
EEL2: MediaItem GetTrackMediaItem(MediaTrack tr, int itemidx)
Lua: MediaItem = reaper.GetTrackMediaItem(MediaTrack tr, integer itemidx)
Python: MediaItem RPR_GetTrackMediaItem(MediaTrack tr, Int itemidx)
Description:
| Parameters: |
| MediaTrack tr | - | |
| integer itemidx | - | |
| Returnvalues: |
| MediaItem | - | |
^
GetTrackMIDILyricsFunctioncall:
C: bool GetTrackMIDILyrics(MediaTrack* track, int flag, char* bufWantNeedBig, int* bufWantNeedBig_sz)
EEL2: bool GetTrackMIDILyrics(MediaTrack track, int flag, #bufWant)
Lua: boolean retval, string bufWant = reaper.GetTrackMIDILyrics(MediaTrack track, integer flag, string bufWant)
Python: (Boolean retval, MediaTrack track, Int flag, String bufWantNeedBig, Int bufWantNeedBig_sz) = RPR_GetTrackMIDILyrics(track, flag, bufWantNeedBig, bufWantNeedBig_sz)
Description:Get all MIDI lyrics on the track. Lyrics will be returned as one string with tabs between each word. flag&1: double tabs at the end of each measure and triple tabs when skipping measures, flag&2: each lyric is preceded by its beat position in the project (example with flag=2: "1.1.2\tLyric for measure 1 beat 2\t.1.1\tLyric for measure 2 beat 1 "). See
SetTrackMIDILyrics
| Parameters: |
| MediaTrack track | - |
|
| integer flag | - |
|
| string bufWant | - |
|
| Returnvalues: |
| boolean retval | - |
|
| string bufWantNeedBig_sz | - |
|
^
GetTrackMIDINoteNameFunctioncall:
C: const char* GetTrackMIDINoteName(int track, int pitch, int chan)
EEL2: bool GetTrackMIDINoteName(#retval, int track, int pitch, int chan)
Lua: string notename = reaper.GetTrackMIDINoteName(integer track, integer pitch, integer chan)
Python: String RPR_GetTrackMIDINoteName(Int track, Int pitch, Int chan)
Description:
| Parameters: |
| integer track | - |
|
| integer pitch | - |
|
| integer chan | - |
|
| Returnvalues: |
| string notename | - |
|
^
GetTrackMIDINoteNameExFunctioncall:
C: const char* GetTrackMIDINoteNameEx(ReaProject* proj, MediaTrack* track, int pitch, int chan)
EEL2: bool GetTrackMIDINoteNameEx(#retval, ReaProject proj, MediaTrack track, int pitch, int chan)
Lua: string = reaper.GetTrackMIDINoteNameEx(ReaProject proj, MediaTrack track, integer pitch, integer chan)
Python: String RPR_GetTrackMIDINoteNameEx(ReaProject proj, MediaTrack track, Int pitch, Int chan)
Description:
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| MediaTrack track | - |
|
| integer pitch | - |
|
| integer chan | - |
|
^
GetTrackMIDINoteRangeFunctioncall:
C: void GetTrackMIDINoteRange(ReaProject* proj, MediaTrack* track, int* note_loOut, int* note_hiOut)
EEL2: GetTrackMIDINoteRange(ReaProject proj, MediaTrack track, int ¬e_lo, int ¬e_hi)
Lua: number note_lo retval, number note_hi = reaper.GetTrackMIDINoteRange(ReaProject proj, MediaTrack track)
Python: (ReaProject proj, MediaTrack track, Int note_loOut, Int note_hiOut) = RPR_GetTrackMIDINoteRange(proj, track, note_loOut, note_hiOut)
Description:
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| MediaTrack track | - |
|
| Returnvalues: |
| number note_lo retval | - |
|
| number note_hi | - |
|
^
GetTrackNameFunctioncall:
C: bool GetTrackName(MediaTrack* track, char* bufOut, int bufOut_sz)
EEL2: bool GetTrackName(MediaTrack track, #buf)
Lua: boolean retval, string buf = reaper.GetTrackName(MediaTrack track)
Python: (Boolean retval, MediaTrack track, String bufOut, Int bufOut_sz) = RPR_GetTrackName(track, bufOut, bufOut_sz)
Description:Returns "MASTER" for master track, "Track N" if track has no name.
| Parameters: |
| MediaTrack track | - | the MediaTrack, whose name you want to know |
| Returnvalues: |
| boolean retval | - | true, if successful |
| string buf | - | the name of the track; "MASTER" for master-track; "Track N" if the track has no given name yet(N=tracknumber) |
^
GetTrackNumMediaItemsFunctioncall:
C: int GetTrackNumMediaItems(MediaTrack* tr)
EEL2: int GetTrackNumMediaItems(MediaTrack tr)
Lua: integer = reaper.GetTrackNumMediaItems(MediaTrack tr)
Python: Int RPR_GetTrackNumMediaItems(MediaTrack tr)
Description:Get the number of MediaItems of a MediaTrack
| Parameters: |
| MediaTrack tr | - | the MediaTrack, whose number of MediaItems you want to count |
| Returnvalues: |
| integer | - | the number of MediaItems in the MediaTrack |
^
GetTrackNumSendsFunctioncall:
C: int GetTrackNumSends(MediaTrack* tr, int category)
EEL2: int GetTrackNumSends(MediaTrack tr, int category)
Lua: integer = reaper.GetTrackNumSends(MediaTrack tr, integer category)
Python: Int RPR_GetTrackNumSends(MediaTrack tr, Int category)
Description:returns number of sends/receives/hardware outputs
For ReaRoute-users: the outputs are hardware outputs, but with 512 added to the destination channel index (512 is the first rearoute channel, 513 the second, etc).
| Parameters: |
| MediaTrack tr | - | the MediaTrack, whose number of sends/receives/hardware outputs you want to know |
| integer category | - | <0 for receives; 0=sends; >0 for hardware outputs |
| Returnvalues: |
| integer | - | the number of sends/receives/hardware outputs |
^
GetTrackReceiveNameFunctioncall:
C: bool GetTrackReceiveName(MediaTrack* track, int recv_index, char* buf, int buf_sz)
EEL2: bool GetTrackReceiveName(MediaTrack track, int recv_index, #buf)
Lua: boolean retval, string buf = reaper.GetTrackReceiveName(MediaTrack track, integer recv_index, string buf)
Python: (Boolean retval, MediaTrack track, Int recv_index, String buf, Int buf_sz) = RPR_GetTrackReceiveName(track, recv_index, buf, buf_sz)
Description:
| Parameters: |
| MediaTrack track | - |
|
| integer recv_index | - |
|
| string buf | - |
|
| Returnvalues: |
| boolean retval | - |
|
| string buf | - |
|
^
GetTrackReceiveUIMuteFunctioncall:
C: bool GetTrackReceiveUIMute(MediaTrack* track, int recv_index, bool* muteOut)
EEL2: bool GetTrackReceiveUIMute(MediaTrack track, int recv_index, bool &mute)
Lua: boolean retval, boolean mute = reaper.GetTrackReceiveUIMute(MediaTrack track, integer recv_index)
Python: (Boolean retval, MediaTrack track, Int recv_index, Boolean muteOut) = RPR_GetTrackReceiveUIMute(track, recv_index, muteOut)
Description:
| Parameters: |
| track | - |
|
| recv_index | - |
|
| Returnvalues: |
| retval | - |
|
| mute | - |
|
^
GetTrackReceiveUIVolPanFunctioncall:
C: bool GetTrackReceiveUIVolPan(MediaTrack* track, int recv_index, double* volumeOut, double* panOut)
EEL2: bool GetTrackReceiveUIVolPan(MediaTrack track, int recv_index, &volume, &pan)
Lua: boolean retval, number volume, number pan = reaper.GetTrackReceiveUIVolPan(MediaTrack track, integer recv_index)
Python: (Boolean retval, MediaTrack track, Int recv_index, Float volumeOut, Float panOut) = RPR_GetTrackReceiveUIVolPan(track, recv_index, volumeOut, panOut)
Description:
| Parameters: |
| track | - |
|
| recv_index | - |
|
| Returnvalues: |
| retval | - |
|
| volume | - |
|
| pan | - |
|
^
GetTrackSendInfo_ValueFunctioncall:
C: double GetTrackSendInfo_Value(MediaTrack* tr, int category, int sendidx, const char* parmname)
EEL2: double GetTrackSendInfo_Value(MediaTrack tr, int category, int sendidx, "parmname")
Lua: number = reaper.GetTrackSendInfo_Value(MediaTrack tr, integer category, integer sendidx, string parmname)
Python: Float RPR_GetTrackSendInfo_Value(MediaTrack tr, Int category, Int sendidx, String parmname)
Description:Get send/receive/hardware output numerical-value attributes.
category is <0 for receives, 0=sends, >0 for hardware outputs
parameter names:
B_MUTE : bool *
B_PHASE : bool *, true to flip phase
B_MONO : bool *
D_VOL : double *, 1.0 = +0dB etc
D_PAN : double *, -1..+1
D_PANLAW : double *,1.0=+0.0db, 0.5=-6dB, -1.0 = projdef etc
I_SENDMODE : int *, 0=post-fader, 1=pre-fx, 2=post-fx (deprecated), 3=post-fx
I_AUTOMODE : int * : automation mode (-1=use track automode, 0=trim/off, 1=read, 2=touch, 3=write, 4=latch)
I_SRCCHAN : int *, index,&1024=mono, -1 for none
I_DSTCHAN : int *, index, &1024=mono, otherwise stereo pair, hwout:&512=rearoute
I_MIDIFLAGS : int *, low 5 bits=source channel 0=all, 1-16, next 5 bits=dest channel, 0=orig, 1-16=chanP_DESTTRACK : read only, returns MediaTrack
, destination track, only applies for sends/recvs
P_SRCTRACK : read only, returns MediaTrack , source track, only applies for sends/recvs
P_ENV:<envchunkname : read only, returns TrackEnvelope *. To get a specific TrackEnvelope, call with :<VOLENV, :<PANENV, etc appended.
For ReaRoute-users: the outputs are hardware outputs, but with 512 added to the destination channel index (512 is the first rearoute channel, 513 the second, etc).
See
CreateTrackSend,
RemoveTrackSend,
GetTrackNumSends.
| Parameters: |
| tr | - |
|
| category | - |
|
| sendidx | - |
|
| parmname | - |
|
^
GetTrackSendNameFunctioncall:
C: bool GetTrackSendName(MediaTrack* track, int send_index, char* buf, int buf_sz)
EEL2: bool GetTrackSendName(MediaTrack track, int send_index, #buf)
Lua: boolean retval, string buf = reaper.GetTrackSendName(MediaTrack track, integer send_index, string buf)
Python: (Boolean retval, MediaTrack track, Int send_index, String buf, Int buf_sz) = RPR_GetTrackSendName(track, send_index, buf, buf_sz)
Description:
| Parameters: |
| track | - |
|
| send_index | - |
|
| string buf | - |
|
| Returnvalues: |
| retval | - |
|
| buf | - |
|
^
GetTrackSendUIMuteFunctioncall:
C: bool GetTrackSendUIMute(MediaTrack* track, int send_index, bool* muteOut)
EEL2: bool GetTrackSendUIMute(MediaTrack track, int send_index, bool &mute)
Lua: boolean retval, boolean mute = reaper.GetTrackSendUIMute(MediaTrack track, integer send_index)
Python: (Boolean retval, MediaTrack track, Int send_index, Boolean muteOut) = RPR_GetTrackSendUIMute(track, send_index, muteOut)
Description:
| Parameters: |
| track | - |
|
| send_index | - |
|
| Returnvalues: |
| retval | - |
|
| mute | - |
|
^
GetTrackSendUIVolPanFunctioncall:
C: bool GetTrackSendUIVolPan(MediaTrack* track, int send_index, double* volumeOut, double* panOut)
EEL2: bool GetTrackSendUIVolPan(MediaTrack track, int send_index, &volume, &pan)
Lua: boolean retval, number volume, number pan = reaper.GetTrackSendUIVolPan(MediaTrack track, integer send_index)
Python: (Boolean retval, MediaTrack track, Int send_index, Float volumeOut, Float panOut) = RPR_GetTrackSendUIVolPan(track, send_index, volumeOut, panOut)
Description:
| Parameters: |
| track | - |
|
| send_index | - |
|
| Returnvalues: |
| retval | - |
|
| volume | - |
|
| pan | - |
|
^
GetTrackStateFunctioncall:
C: const char* GetTrackState(MediaTrack* track, int* flagsOut)
EEL2: bool GetTrackState(#retval, MediaTrack track, int &flags)
Lua: string retval, number flags = reaper.GetTrackState(MediaTrack track)
Python: (String retval, MediaTrack track, Int flagsOut) = RPR_GetTrackState(track, flagsOut)
Description:Gets track state, returns track name.
flags will be set to:
&1=folder
&2=selected
&4=has fx enabled
&8=muted
&16=soloed
&32=SIP'd (with &16)
&64=rec armed
&128=rec monitoring on
&256=rec monitoring auto
&512=hide from TCP
&1024=hide from MCP
| Returnvalues: |
| retval | - | |
| flags | - | |
^
GetTrackStateChunkFunctioncall:
C: bool GetTrackStateChunk(MediaTrack* track, char* strNeedBig, int strNeedBig_sz, bool isundoOptional)
EEL2: bool GetTrackStateChunk(MediaTrack track, #str, bool isundo)
Lua: boolean retval, string str = reaper.GetTrackStateChunk(MediaTrack track, string str, boolean isundo)
Python: (Boolean retval, MediaTrack track, String strNeedBig, Int strNeedBig_sz, Boolean isundoOptional) = RPR_GetTrackStateChunk(track, strNeedBig, strNeedBig_sz, isundoOptional)
Description:Gets the RPPXML state of a track, returns true if successful. Undo flag is a performance/caching hint.
| Parameters: |
| track | - |
|
| string str | - |
|
| isundo | - |
|
| Returnvalues: |
| retval | - |
|
| str | - |
|
^
GetTrackUIMuteFunctioncall:
C: bool GetTrackUIMute(MediaTrack* track, bool* muteOut)
EEL2: bool GetTrackUIMute(MediaTrack track, bool &mute)
Lua: boolean retval, boolean mute = reaper.GetTrackUIMute(MediaTrack track)
Python: (Boolean retval, MediaTrack track, Boolean muteOut) = RPR_GetTrackUIMute(track, muteOut)
Description:
| Returnvalues: |
| retval | - | |
| mute | - | |
^
GetTrackUIPanFunctioncall:
C: bool GetTrackUIPan(MediaTrack* track, double* pan1Out, double* pan2Out, int* panmodeOut)
EEL2: bool GetTrackUIPan(MediaTrack track, &pan1, &pan2, int &panmode)
Lua: boolean retval, number pan1, number pan2, number panmode = reaper.GetTrackUIPan(MediaTrack track)
Python: (Boolean retval, MediaTrack track, Float pan1Out, Float pan2Out, Int panmodeOut) = RPR_GetTrackUIPan(track, pan1Out, pan2Out, panmodeOut)
Description:
| Returnvalues: |
| retval | - | |
| pan1 | - | |
| pan2 | - | |
| panmode | - | |
^
GetTrackUIVolPanFunctioncall:
C: bool GetTrackUIVolPan(MediaTrack* track, double* volumeOut, double* panOut)
EEL2: bool GetTrackUIVolPan(MediaTrack track, &volume, &pan)
Lua: boolean retval, number volume, number pan = reaper.GetTrackUIVolPan(MediaTrack track)
Python: (Boolean retval, MediaTrack track, Float volumeOut, Float panOut) = RPR_GetTrackUIVolPan(track, volumeOut, panOut)
Description:
| Returnvalues: |
| retval | - | |
| volume | - | |
| pan | - | |
^
GetUnderrunTimeFunctioncall:
C: void GetUnderrunTime(unsigned int* audio_xrunOutOptional, unsigned int* media_xrunOutOptional, unsigned int* curtimeOutOptional)
EEL2: GetUnderrunTime(optional unsigned int &audio_xrun, optional unsigned int &media_xrun, optional unsigned int &curtime)
Lua: optional number audio_xrun retval, optional number media_xrun, optional number curtime = reaper.GetUnderrunTime()
Python: RPR_GetUnderrunTime(unsigned int audio_xrunOutOptional, unsigned int media_xrunOutOptional, unsigned int curtimeOutOptional)
Description:retrieves the last timestamps of audio xrun (yellow-flash, if available), media xrun (red-flash), and the current time stamp (all milliseconds)
| Returnvalues: |
| audio_xrun retval | - | |
| media_xrun | - | |
| curtime | - | |
^
GetUserFileNameForReadFunctioncall:
C: bool GetUserFileNameForRead(char* filenameNeed4096, const char* title, const char* defext)
EEL2: bool GetUserFileNameForRead(#filenameNeed4096, "title", "defext")
Lua: boolean retval, string filenameNeed4096 = reaper.GetUserFileNameForRead(string filenameNeed4096, string title, string defext)
Python: (Boolean retval, String filenameNeed4096, String title, String defext) = RPR_GetUserFileNameForRead(filenameNeed4096, title, defext)
Description:Opens a filerequester, where a user can select a file.
The requester only returns the file, but doesn't open or write to it. That said, this function can be used for both use-cases, BUT: keep in mind, that it shows an "open"-button, even if you want to use it in code for saving a file. You also can't use it for "create new file"-usecases, as you can't choose nonexisting files.
| Parameters: |
| filenameNeed4096 | - | default-filename the requester uses, until the user selects another file. |
| title | - | title of the file-requester-window |
| defext | - | the filter for the fileextensions. Only files with an extension defined in defext are shown. examples: "", all files "*", all files "ini", only .ini-files "*.ini", only .ini-files "*.txt; *.ini; *.exe", shows .txt; .ini; .exe-files |
| Returnvalues: |
| retval | - | true, if the user selected a file; false if the user canceled the dialog |
| filenameNeed4096 | - | the filename including the full absolute path of the file the user selected |
^
GetUserInputsFunctioncall:
C: bool GetUserInputs(const char* title, int num_inputs, const char* captions_csv, char* retvals_csv, int retvals_csv_sz)
EEL2: bool GetUserInputs("title", int num_inputs, "captions_csv", #retvals_csv)
Lua: boolean retval, string retvals_csv = reaper.GetUserInputs(string title, integer num_inputs, string captions_csv, string retvals_csv)
Python: (Boolean retval, String title, Int num_inputs, String captions_csv, String retvals_csv, Int retvals_csv_sz) = RPR_GetUserInputs(title, num_inputs, captions_csv, retvals_csv, retvals_csv_sz)
Description:Opens a window with input-fields to get values from the user.
If a caption begins with *, for example "*password", the edit field will not display the input text.
Maximum fields is 16. Values are returned as a comma/custom separator-separated string.
Returns false if the user canceled the dialog.
You can supply special extra information via additional caption fields: extrawidth=XXX to increase text field width, separator=X to use a different separator for returned fields(separator=\n is recommended).
Example:
retval, retvalscsv = reaper.GetUserInputs("Title", 2, "Hello,World, separator=\n", "defaultvalue1\ndefaultvalue2")
will return the values input by the user, separated by a newline.
\n is recommended, as this allows the user entering everything, a one-lined-inputbox can handle.
Important: the separator-field in the captions has no effect on how captions in parameter captions_csv are separated from each other. They still need to be separated by commas!
Note: the parameter retvals_csv follows undisclosed csv rules. This is important when you want to set the default-captions for multiple input-field.
For instance every entry for each input-field:
- must contain an even number of quotes/single quotes
- every ( or must be closed by with )
otherwise the separator will be ignored and the default-retvals will show in the wrong fields.
Example:
a retvalcsv of I'm enlightened,I am too
with one singlequote in it (the one in I'm) will NOT be shown in two fields
I'm enlightened
I am too
but rather in one field as
I'm enlightened,I am too
These can't be escaped due Reaper's API-limitation. Keep this in mind!
| Parameters: |
| string title | - | title of the window
|
| integer num_inputs | - | number of input-fields, 1-16.
|
| string captions_csv | - | a string with the captions for each input-field, each separated by a comma. Can be fewer than num_inputs. If a caption begins with , the inputfield will display instead of characters(for i.e. passwords).
|
| string retvals_csv | - | default-values for each input-field, separated by a comma or a separator you chose.
|
| Returnvalues: |
| boolean retval | - | did the user click OK in the dialog(true) or close/cancel the dialog(false)
|
| string retvals_csv | - | the data from each of the input-fields, separated by a comma , or a separator you chose.
|
^
GoToMarkerFunctioncall:
C: void GoToMarker(ReaProject* proj, int marker_index, bool use_timeline_order)
EEL2: GoToMarker(ReaProject proj, int marker_index, bool use_timeline_order)
Lua: reaper.GoToMarker(ReaProject proj, integer marker_index, boolean use_timeline_order)
Python: RPR_GoToMarker(ReaProject proj, Int marker_index, Boolean use_timeline_order)
Description:Go to marker.
Move Editcursor to a given marker. When playing, the playcursor moves to the marker as well.
For Regions, use
GoToRegion.
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| marker_index | - | the markerindex, where you want to go to.
|
| use_timeline_order | - | false, use the shown-markernumber as marker_index; true, use markers in timelineorder, ignoring the shown-markernumber
|
^
GoToRegionFunctioncall:
C: void GoToRegion(ReaProject* proj, int region_index, bool use_timeline_order)
EEL2: GoToRegion(ReaProject proj, int region_index, bool use_timeline_order)
Lua: reaper.GoToRegion(ReaProject proj, integer region_index, boolean use_timeline_order)
Python: RPR_GoToRegion(ReaProject proj, Int region_index, Boolean use_timeline_order)
Description:Go to beginning of a region.
Seek to region after current region finishes playing (smooth seek).
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| region_index | - | the regionindex, where you want to got to.
|
| use_timeline_order | - | false, use the shown-regionnumber as region_index; true, use regions in timelineorder, ignoring the shown-regionnumber
|
^
GR_SelectColorFunctioncall:
C: int GR_SelectColor(HWND hwnd, int* colorOut)
EEL2: int GR_SelectColor(HWND hwnd, int &color)
Lua: integer retval, number color = reaper.GR_SelectColor(HWND hwnd)
Python: (Int retval, HWND hwnd, Int colorOut) = RPR_GR_SelectColor(hwnd, colorOut)
Description:Runs the system color chooser dialog. Returns 0 if the user cancels the dialog.
| Parameters: |
| hwnd | - | the window, in which to open the dialog. Nil is allowed in Lua. |
| Returnvalues: |
| retval | - | 1, user chose a color; 0, user canceled dialog |
| color | - | the returned color as a native-color-value. |
^
GSC_mainwndFunctioncall:
C: int GSC_mainwnd(int t)
EEL2: int GSC_mainwnd(int t)
Lua: integer = reaper.GSC_mainwnd(integer t)
Python: Int RPR_GSC_mainwnd(Int t)
Description:his is just like win32 GetSysColor() but can have overrides.
^
guidToStringFunctioncall:
C: void guidToString(const GUID* g, char* destNeed64)
EEL2: guidToString("gGUID", #destNeed64)
Lua: string destNeed64 = reaper.guidToString(string gGUID, string destNeed64)
Python: (const GUID g, String destNeed64) = RPR_guidToString(g, destNeed64)
Description:dest should be at least 64 chars long to be safe
| Parameters: |
| gGUID | - | |
| string destNeed64 | - | |
| Returnvalues: |
| destNeed64 | - | |
^
HasExtStateFunctioncall:
C: bool HasExtState(const char* section, const char* key)
EEL2: bool HasExtState("section", "key")
Lua: boolean = reaper.HasExtState(string section, string key)
Python: Boolean RPR_HasExtState(String section, String key)
Description:
| Parameters: |
| section | - |
|
| key | - |
|
^
HasTrackMIDIProgramsFunctioncall:
C: const char* HasTrackMIDIPrograms(int track)
EEL2: bool HasTrackMIDIPrograms(#retval, int track)
Lua: string = reaper.HasTrackMIDIPrograms(integer track)
Python: String RPR_HasTrackMIDIPrograms(Int track)
Description:returns name of track plugin that is supplying MIDI programs,or NULL if there is none
^
HasTrackMIDIProgramsExFunctioncall:
C: const char* HasTrackMIDIProgramsEx(ReaProject* proj, MediaTrack* track)
EEL2: bool HasTrackMIDIProgramsEx(#retval, ReaProject proj, MediaTrack track)
Lua: string = reaper.HasTrackMIDIProgramsEx(ReaProject proj, MediaTrack track)
Python: String RPR_HasTrackMIDIProgramsEx(ReaProject proj, MediaTrack track)
Description:returns name of track plugin that is supplying MIDI programs,or NULL if there is none
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| track | - |
|
^
Help_SetFunctioncall:
C: void Help_Set(const char* helpstring, bool is_temporary_help)
EEL2: Help_Set("helpstring", bool is_temporary_help)
Lua: reaper.Help_Set(string helpstring, boolean is_temporary_help)
Python: RPR_Help_Set(String helpstring, Boolean is_temporary_help)
Description:Displays an information in the help and information-display, underneath the TCP(might be missing, in certain themes).
| Parameters: |
| helpstring | - | the string to display |
| is_temporary_help | - | true, show until another message is displayed; false, show permanently, every time no other message is displayed. |
^
image_resolve_fnFunctioncall:
C: void image_resolve_fn(const char* in, char* out, int out_sz)
EEL2: image_resolve_fn("in", #out)
Lua: string out = reaper.image_resolve_fn(string in, string out)
Python: (String in, String out, Int out_sz) = RPR_image_resolve_fn(in, out, out_sz)
Description:
| Parameters: |
| string in | - | |
| string out | - | |
| Returnvalues: |
| stirng out | - | |
^
InsertAutomationItemFunctioncall:
C: int InsertAutomationItem(TrackEnvelope* env, int pool_id, double position, double length)
EEL2: int InsertAutomationItem(TrackEnvelope env, int pool_id, position, length)
Lua: integer = reaper.InsertAutomationItem(TrackEnvelope env, integer pool_id, number position, number length)
Python: Int RPR_InsertAutomationItem(TrackEnvelope env, Int pool_id, Float position, Float length)
Description:Insert a new automation item. pool_id < 0 collects existing envelope points into the automation item; if pool_id is >= 0 the automation item will be a new instance of that pool (which will be created as an empty instance if it does not exist). Returns the index of the item, suitable for passing to other automation item API functions. See
GetSetAutomationItemInfo.
| Parameters: |
| env | - |
|
| pool_id | - |
|
| position | - |
|
| length | - |
|
^
InsertEnvelopePointFunctioncall:
C: bool InsertEnvelopePoint(TrackEnvelope* envelope, double time, double value, int shape, double tension, bool selected, bool* noSortInOptional)
EEL2: bool InsertEnvelopePoint(TrackEnvelope envelope, time, value, int shape, tension, bool selected, optional bool noSortIn)
Lua: boolean = reaper.InsertEnvelopePoint(TrackEnvelope envelope, number time, number value, integer shape, number tension, boolean selected, optional boolean noSortIn)
Python: (Boolean retval, TrackEnvelope envelope, Float time, Float value, Int shape, Float tension, Boolean selected, Boolean noSortInOptional) = RPR_InsertEnvelopePoint(envelope, time, value, shape, tension, selected, noSortInOptional)
Description:Insert an envelope point. If setting multiple points at once, set noSort=true, and call Envelope_SortPoints when done. See
InsertEnvelopePointEx.
| Parameters: |
| envelope | - |
|
| time | - |
|
| value | - |
|
| shape | - |
|
| tension | - |
|
| selected | - |
|
| noSortIn | - |
|
^
InsertEnvelopePointExFunctioncall:
C: bool InsertEnvelopePointEx(TrackEnvelope* envelope, int autoitem_idx, double time, double value, int shape, double tension, bool selected, bool* noSortInOptional)
EEL2: bool InsertEnvelopePointEx(TrackEnvelope envelope, int autoitem_idx, time, value, int shape, tension, bool selected, optional bool noSortIn)
Lua: boolean = reaper.InsertEnvelopePointEx(TrackEnvelope envelope, integer autoitem_idx, number time, number value, integer shape, number tension, boolean selected, optional boolean noSortIn)
Python: (Boolean retval, TrackEnvelope envelope, Int autoitem_idx, Float time, Float value, Int shape, Float tension, Boolean selected, Boolean noSortInOptional) = RPR_InsertEnvelopePointEx(envelope, autoitem_idx, time, value, shape, tension, selected, noSortInOptional)
Description:Insert an envelope point. If setting multiple points at once, set noSort=true, and call Envelope_SortPoints when done.
autoitem_idx=-1 for the underlying envelope, 0 for the first automation item on the envelope, etc.
For automation items, pass autoitem_idx|0x10000000 to base ptidx on the number of points in one full loop iteration,
even if the automation item is trimmed so that not all points are visible.
Otherwise, ptidx will be based on the number of visible points in the automation item, including all loop iterations.
See
CountEnvelopePointsEx,
GetEnvelopePointEx,
SetEnvelopePointEx,
DeleteEnvelopePointEx.
| Parameters: |
| envelope | - |
|
| autoitem_idx | - |
|
| time | - |
|
| value | - |
|
| shape | - |
|
| tension | - |
|
| selected | - |
|
| noSortIn | - |
|
^
InsertMediaFunctioncall:
C: int InsertMedia(const char* file, int mode)
EEL2: int InsertMedia("file", int mode)
Lua: integer = reaper.InsertMedia(string file, integer mode)
Python: Int RPR_InsertMedia(String file, Int mode)
Description:mode:
0=add to current track
1=add new track
3=add to selected items as takes
&4=stretch/loop to fit time sel
&8=try to match tempo 1x
&16=try to match tempo 0.5x
&32=try to match tempo 2x
&64=don't preserve pitch when matching tempo
&128=no loop/section if startpct/endpct set
&256=force loop regardless of global preference for looping imported items
&512=use high word as absolute track index if mode&3==0
&1024=insert into reasamplomatic on a new track
&2048=insert into open reasamplomatic instance
&4096=move to BWF source preferred position(BWF start offset)
&8192=reverse
| Parameters: |
| string file | - | the file to insert |
| integer mode | - | the mode, with which to insert the file(see description for more details) |
| Returnvalues: |
| integer | - | 0, inserting was unsuccessful; 1, inserting was successful
Note: will always return 1, when mode=0 or mode=1, even if the file does not exist! |
^
InsertMediaSectionFunctioncall:
C: int InsertMediaSection(const char* file, int mode, double startpct, double endpct, double pitchshift)
EEL2: int InsertMediaSection("file", int mode, startpct, endpct, pitchshift)
Lua: integer = reaper.InsertMediaSection(string file, integer mode, number startpct, number endpct, number pitchshift)
Python: Int RPR_InsertMediaSection(String file, Int mode, Float startpct, Float endpct, Float pitchshift)
Description:
| Parameters: |
| file | - |
|
| mode | - |
|
| startpct | - |
|
| endpct | - |
|
| pitchshift | - |
|
^
InsertTrackAtIndexFunctioncall:
C: void InsertTrackAtIndex(int idx, bool wantDefaults)
EEL2: InsertTrackAtIndex(int idx, bool wantDefaults)
Lua: reaper.InsertTrackAtIndex(integer idx, boolean wantDefaults)
Python: RPR_InsertTrackAtIndex(Int idx, Boolean wantDefaults)
Description:inserts a track at idx,of course this will be clamped to 0..
GetNumTracks().
| Parameters: |
| idx | - | the index, in which to insert the track; 0, insert before the first track.
|
| wantDefaults | - | true, default envelopes/FX; false, no enabled FX/envelopes
|
^
IsMediaExtensionFunctioncall:
C: bool IsMediaExtension(const char* ext, bool wantOthers)
EEL2: bool IsMediaExtension("ext", bool wantOthers)
Lua: boolean = reaper.IsMediaExtension(string ext, boolean wantOthers)
Python: Boolean RPR_IsMediaExtension(String ext, Boolean wantOthers)
Description:Tests a file extension (i.e. "wav" or "mid") to see if it's a media extension.
If wantOthers is set, then "RPP", "TXT" and other project-type formats will also pass.
| Parameters: |
| ext | - | |
| wantOthers | - | |
^
IsMediaItemSelectedFunctioncall:
C: bool IsMediaItemSelected(MediaItem* item)
EEL2: bool IsMediaItemSelected(MediaItem item)
Lua: boolean = reaper.IsMediaItemSelected(MediaItem item)
Python: Boolean RPR_IsMediaItemSelected(MediaItem item)
Description:Get, if a MediaItem is selected or not.
| Parameters: |
| item | - | the MediaItem, whose selected-state you want to know |
| Returnvalues: |
| boolean | - | true, MediaItem is selected; false, MediaItem is not selected |
^
IsProjectDirtyFunctioncall:
C: int IsProjectDirty(ReaProject* proj)
EEL2: int IsProjectDirty(ReaProject proj)
Lua: integer = reaper.IsProjectDirty(ReaProject proj)
Python: Int RPR_IsProjectDirty(ReaProject proj)
Description:Is the project dirty (needing save)? Always returns 0 if 'undo/prompt to save' is disabled in preferences.
A project becomes dirty, as soon as it was changed since creation/last saving.
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| Returnvalues: |
| integer | - | the state, if a project needs saving or not; 0, needs no saving; 1, needs saving
|
^
IsTrackSelectedFunctioncall:
C: bool IsTrackSelected(MediaTrack* track)
EEL2: bool IsTrackSelected(MediaTrack track)
Lua: boolean = reaper.IsTrackSelected(MediaTrack track)
Python: Boolean RPR_IsTrackSelected(MediaTrack track)
Description:Get, if a MediaTrack is selected or not.
| Parameters: |
| track | - | the MediaTrack, whose selection-state you want to know |
| Returnvalues: |
| boolean | - | true, MediaTrack is selected; false, MediaTrack is not selected |
^
IsTrackVisibleFunctioncall:
C: bool IsTrackVisible(MediaTrack* track, bool mixer)
EEL2: bool IsTrackVisible(MediaTrack track, bool mixer)
Lua: boolean = reaper.IsTrackVisible(MediaTrack track, boolean mixer)
Python: Boolean RPR_IsTrackVisible(MediaTrack track, Boolean mixer)
Description:Gets visibility-state of a MediaTrack.
| Parameters: |
| track | - | the MediaTrack, whose visibility-state you want to know |
| mixer | - | true, visibility-state of the MediaTrack in the mixer; false, visibility-state of the MediaTrack in the TrackControlPanel |
| Returnvalues: |
| boolean | - | true, MediaTrack is visible; false, MediaTrack is invisible |
^
joystick_createFunctioncall:
C: joystick_device* joystick_create(const GUID* guid)
EEL2: joystick_device joystick_create("guidGUID")
Lua: joystick_device = reaper.joystick_create(string guidGUID)
Python: joystick_device RPR_joystick_create(const GUID guid)
Description:creates a joystick device
| Returnvalues: |
| joystick_device | - | |
^
joystick_destroyFunctioncall:
C: void joystick_destroy(joystick_device* device)
EEL2: joystick_destroy(joystick_device device)
Lua: reaper.joystick_destroy(joystick_device device)
Python: RPR_joystick_destroy(joystick_device device)
Description:destroys a joystick device
^
joystick_enumFunctioncall:
C: const char* joystick_enum(int index, const char** namestrOutOptional)
EEL2: bool joystick_enum(#retval, int index, optional #namestr)
Lua: string retval, optional string namestr = reaper.joystick_enum(integer index)
Python: String RPR_joystick_enum(Int index, String namestrOutOptional)
Description:enumerates installed devices, returns GUID as a string
| Returnvalues: |
| retval | - | |
| string namestr | - | |
^
joystick_getaxisFunctioncall:
C: double joystick_getaxis(joystick_device* dev, int axis)
EEL2: double joystick_getaxis(joystick_device dev, int axis)
Lua: number = reaper.joystick_getaxis(joystick_device dev, integer axis)
Python: Float RPR_joystick_getaxis(joystick_device dev, Int axis)
Description:returns axis value (-1..1)
^
joystick_getbuttonmaskFunctioncall:
C: unsigned int joystick_getbuttonmask(joystick_device* dev)
EEL2: uint joystick_getbuttonmask(joystick_device dev)
Lua: integer = reaper.joystick_getbuttonmask(joystick_device dev)
Python: Int RPR_joystick_getbuttonmask(joystick_device dev)
Description:returns button pressed mask, 1=first button, 2=second...
^
joystick_getinfoFunctioncall:
C: int joystick_getinfo(joystick_device* dev, int* axesOutOptional, int* povsOutOptional)
EEL2: int joystick_getinfo(joystick_device dev, optional int &axes, optional int &povs)
Lua: integer retval, optional number axes, optional number povs = reaper.joystick_getinfo(joystick_device dev)
Python: (Int retval, joystick_device dev, Int axesOutOptional, Int povsOutOptional) = RPR_joystick_getinfo(dev, axesOutOptional, povsOutOptional)
Description:returns button count
| Returnvalues: |
| retval | - | |
| axes | - | |
| povs | - | |
^
joystick_getpovFunctioncall:
C: double joystick_getpov(joystick_device* dev, int pov)
EEL2: double joystick_getpov(joystick_device dev, int pov)
Lua: number = reaper.joystick_getpov(joystick_device dev, integer pov)
Python: Float RPR_joystick_getpov(joystick_device dev, Int pov)
Description:returns POV value (usually 0..655.35, or 655.35 on error)
^
joystick_updateFunctioncall:
C: bool joystick_update(joystick_device* dev)
EEL2: bool joystick_update(joystick_device dev)
Lua: boolean = reaper.joystick_update(joystick_device dev)
Python: Boolean RPR_joystick_update(joystick_device dev)
Description:Updates joystick state from hardware, returns true if successful (joystick_get* will not be valid until joystick_update() is called successfully)
^
LICE_ClipLineFunctioncall:
C: bool LICE_ClipLine(int* pX1Out, int* pY1Out, int* pX2Out, int* pY2Out, int xLo, int yLo, int xHi, int yHi)
EEL2: bool LICE_ClipLine(int &pX1, int &pY1, int &pX2, int &pY2, int xLo, int yLo, int xHi, int yHi)
Lua: boolean retval, number pX1, number pY1, number pX2, number pY2 = reaper.LICE_ClipLine(number pX1, number pY1, number pX2, number pY2, integer xLo, integer yLo, integer xHi, integer yHi)
Python: (Boolean retval, Int pX1Out, Int pY1Out, Int pX2Out, Int pY2Out, Int xLo, Int yLo, Int xHi, Int yHi) = RPR_LICE_ClipLine(pX1Out, pY1Out, pX2Out, pY2Out, xLo, yLo, xHi, yHi)
Description:Returns false if the line is entirely offscreen.
| Parameters: |
| number pX1 | - | |
| number pY1 | - | |
| number pX2 | - | |
| number pY2 | - | |
| integer xLo | - | |
| integer yLo | - | |
| integer xHi | - | |
| integer yHi | - | |
| Returnvalues: |
| boolean retval | - | |
| number pX1 | - | |
| number pY1 | - | |
| number pX2 | - | |
| number pY2 | - | |
^
LocalizeStringFunctioncall:
C: const char* LocalizeString(const char* src_string, const char* section, int flagsOptional)
EEL2: bool LocalizeString(#retval, "src_string", "section", int flags)
Lua: string retval = reaper.LocalizeString(string src_string, string section, integer flags)
Python: String RPR_LocalizeString(String src_string, String section, Int flagsOptional)
Description:Returns a localized version of src_string, in section section. flags can have 1 set to only localize if sprintf-style formatting matches the original.
| Parameters: |
| string src_string | - | the string, which you want to be translated
|
| string section | - | the section in the ReaperLangPack-file, in which the string to localize is located
|
| integer flags | - | 1, set to only localize if sprintf-style formatting matches the original
|
| Returnvalues: |
| string retval | - | the localized string or the original string, if no localized string is available
|
^
Loop_OnArrowFunctioncall:
C: bool Loop_OnArrow(ReaProject* project, int direction)
EEL2: bool Loop_OnArrow(ReaProject project, int direction)
Lua: boolean = reaper.Loop_OnArrow(ReaProject project, integer direction)
Python: Boolean RPR_Loop_OnArrow(ReaProject project, Int direction)
Description:Move the loop selection left or right in steps according to snap-settings(when snap is enabled).
| Parameters: |
| project | - | the project to be checked for. 0 for current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| direction | - | the direction to move; negative values, move towards start of project; positive values, move towards end of project; 0, keep position
|
| Returnvalues: |
| boolean | - | true, snap is enabled; false, snap is disabled
|
^
Main_OnCommandFunctioncall:
C: void Main_OnCommand(int command, int flag)
EEL2: Main_OnCommand(int command, int flag)
Lua: reaper.Main_OnCommand(integer command, integer flag)
Python: RPR_Main_OnCommand(Int command, Int flag)
Description:Performs an action belonging to the main action section. To perform non-native actions (ReaScripts, custom or extension plugins' actions) safely, see
NamedCommandLookup().
See
Main_OnCommandEx.
| Parameters: |
| command | - | the command-id of the action, you want to run
|
| flag | - | set to 0
|
^
Main_OnCommandExFunctioncall:
C: void Main_OnCommandEx(int command, int flag, ReaProject* proj)
EEL2: Main_OnCommandEx(int command, int flag, ReaProject proj)
Lua: reaper.Main_OnCommandEx(integer command, integer flag, ReaProject proj)
Python: RPR_Main_OnCommandEx(Int command, Int flag, ReaProject proj)
Description:Performs an action belonging to the main action section. To perform non-native actions (ReaScripts, custom or extension plugins' actions) safely, see
NamedCommandLookup().
| Parameters: |
| command | - | the command-id of the action, you want to run
|
| flag | - | 0
|
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
^
Main_openProjectFunctioncall:
C: void Main_openProject(const char* name)
EEL2: Main_openProject("name")
Lua: reaper.Main_openProject(string name)
Python: RPR_Main_openProject(String name)
Description:opens a project.
will prompt the user to save unless name is prefixed with 'noprompt:'.
example: "noprompt:projectfile.rpp"
If name is prefixed with 'template:', project file will be loaded as a template.
example: "template:projectfile.rpp"
You can combine both: "template:noprompt:projectfile.rpp"
If passed a .RTrackTemplate file, adds the template to the existing project.
| Parameters: |
| string name | - | the path and filename of the project/template you want to open |
^
Main_SaveProjectFunctioncall:
C: void Main_SaveProject(ReaProject* proj, bool forceSaveAsInOptional)
EEL2: Main_SaveProject(ReaProject proj, bool forceSaveAsIn)
Lua: reaper.Main_SaveProject(ReaProject proj, boolean forceSaveAsIn)
Python: RPR_Main_SaveProject(ReaProject proj, Boolean forceSaveAsInOptional)
Description:Save the project.
Optional with a save-dialog.
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| forceSaveAsIn | - | false, save the project; true, open save-file-dialog first
|
^
Main_UpdateLoopInfoFunctioncall:
C: void Main_UpdateLoopInfo(int ignoremask)
EEL2: Main_UpdateLoopInfo(int ignoremask)
Lua: reaper.Main_UpdateLoopInfo(integer ignoremask)
Python: RPR_Main_UpdateLoopInfo(Int ignoremask)
Description:
^
MarkProjectDirtyFunctioncall:
C: void MarkProjectDirty(ReaProject* proj)
EEL2: MarkProjectDirty(ReaProject proj)
Lua: reaper.MarkProjectDirty(ReaProject proj)
Python: RPR_MarkProjectDirty(ReaProject proj)
Description:Marks project as dirty (needing save) if 'undo/prompt to save' is enabled in preferences.
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
^
MarkTrackItemsDirtyFunctioncall:
C: void MarkTrackItemsDirty(MediaTrack* track, MediaItem* item)
EEL2: MarkTrackItemsDirty(MediaTrack track, MediaItem item)
Lua: reaper.MarkTrackItemsDirty(MediaTrack track, MediaItem item)
Python: RPR_MarkTrackItemsDirty(MediaTrack track, MediaItem item)
Description:If track is supplied, item is ignored
| Parameters: |
| track | - | the MediaTrack that you want to mark as dirty |
| item | - | if no MediaTrack is given, use this MediaItem to mark as dirty |
^
Master_GetPlayRateFunctioncall:
C: double Master_GetPlayRate(ReaProject* project)
EEL2: double Master_GetPlayRate(ReaProject project)
Lua: number = reaper.Master_GetPlayRate(ReaProject project)
Python: Float RPR_Master_GetPlayRate(ReaProject project)
Description:Get the playrate of the project.
| Parameters: |
| project | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| Returnvalues: |
| number | - | the playrate of the project, between 0.25 and 10.0
|
^
Master_GetPlayRateAtTimeFunctioncall:
C: double Master_GetPlayRateAtTime(double time_s, ReaProject* proj)
EEL2: double Master_GetPlayRateAtTime(time_s, ReaProject proj)
Lua: number = reaper.Master_GetPlayRateAtTime(number time_s, ReaProject proj)
Python: Float RPR_Master_GetPlayRateAtTime(Float time_s, ReaProject proj)
Description:
| Parameters: |
| time_s | - |
|
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
^
Master_GetTempoFunctioncall:
C: double Master_GetTempo()
EEL2: double Master_GetTempo()
Lua: number = reaper.Master_GetTempo()
Python: Float RPR_Master_GetTempo()
Description:
^
Master_NormalizePlayRateFunctioncall:
C: double Master_NormalizePlayRate(double playrate, bool isnormalized)
EEL2: double Master_NormalizePlayRate(playrate, bool isnormalized)
Lua: number = reaper.Master_NormalizePlayRate(number playrate, boolean isnormalized)
Python: Float RPR_Master_NormalizePlayRate(Float playrate, Boolean isnormalized)
Description:Convert play rate to/from a value between 0 and 1, representing the position on the project playrate slider.
| Parameters: |
| playrate | - | |
| isnormalized | - | |
^
Master_NormalizeTempoFunctioncall:
C: double Master_NormalizeTempo(double bpm, bool isnormalized)
EEL2: double Master_NormalizeTempo(bpm, bool isnormalized)
Lua: number = reaper.Master_NormalizeTempo(number bpm, boolean isnormalized)
Python: Float RPR_Master_NormalizeTempo(Float bpm, Boolean isnormalized)
Description:Convert the tempo to/from a value between 0 and 1, representing bpm in the range of 40-296 bpm.
| Parameters: |
| bpm | - | |
| isnormalized | - | |
^
MBFunctioncall:
C: int MB(const char* msg, const char* title, int type)
EEL2: int MB("msg", "title", int type)
Lua: integer = reaper.MB(string msg, string title, integer type)
Python: Int RPR_MB(String msg, String title, Int type)
Description:Shows Messagebox with user-clickable buttons.
| Parameters: |
| msg | - | the message, that shall be shown in messagebox |
| title | - | the title of the messagebox |
| type | - | which buttons shall be shown in the messagebox 0, OK 1, OK CANCEL 2, ABORT RETRY IGNORE 3, YES NO CANCEL 4, YES NO 5, RETRY CANCEL |
| Returnvalues: |
| integer | - | the button pressed by the user
1, OK
2, CANCEL
3, ABORT
4, RETRY
5, IGNORE
6, YES
7, NO |
^
MediaItemDescendsFromTrackFunctioncall:
C: int MediaItemDescendsFromTrack(MediaItem* item, MediaTrack* track)
EEL2: int MediaItemDescendsFromTrack(MediaItem item, MediaTrack track)
Lua: integer = reaper.MediaItemDescendsFromTrack(MediaItem item, MediaTrack track)
Python: Int RPR_MediaItemDescendsFromTrack(MediaItem item, MediaTrack track)
Description:Returns 1 if the track holds the item, 2 if the track is a folder containing the track that holds the item, etc.
| Parameters: |
| item | - | |
| track | - | |
^
MIDI_CountEvtsFunctioncall:
C: int MIDI_CountEvts(MediaItem_Take* take, int* notecntOut, int* ccevtcntOut, int* textsyxevtcntOut)
EEL2: int MIDI_CountEvts(MediaItem_Take take, int ¬ecnt, int &ccevtcnt, int &textsyxevtcnt)
Lua: integer retval, number notecnt, number ccevtcnt, number textsyxevtcnt = reaper.MIDI_CountEvts(MediaItem_Take take)
Python: (Int retval, MediaItem_Take take, Int notecntOut, Int ccevtcntOut, Int textsyxevtcntOut) = RPR_MIDI_CountEvts(take, notecntOut, ccevtcntOut, textsyxevtcntOut)
Description:Count the number of notes, CC events, and text/sysex events in a given MIDI item.
| Returnvalues: |
| retval | - | |
| notecnt | - | |
| ccevtcnt | - | |
| textsyxevtcnt | - | |
^
MIDI_DeleteCCFunctioncall:
C: bool MIDI_DeleteCC(MediaItem_Take* take, int ccidx)
EEL2: bool MIDI_DeleteCC(MediaItem_Take take, int ccidx)
Lua: boolean = reaper.MIDI_DeleteCC(MediaItem_Take take, integer ccidx)
Python: Boolean RPR_MIDI_DeleteCC(MediaItem_Take take, Int ccidx)
Description:Delete a MIDI CC event.
| Parameters: |
| take | - | |
| ccidx | - | |
^
MIDI_DeleteEvtFunctioncall:
C: bool MIDI_DeleteEvt(MediaItem_Take* take, int evtidx)
EEL2: bool MIDI_DeleteEvt(MediaItem_Take take, int evtidx)
Lua: boolean = reaper.MIDI_DeleteEvt(MediaItem_Take take, integer evtidx)
Python: Boolean RPR_MIDI_DeleteEvt(MediaItem_Take take, Int evtidx)
Description:Delete a MIDI event.
| Parameters: |
| take | - | |
| evtidx | - | |
^
MIDI_DeleteNoteFunctioncall:
C: bool MIDI_DeleteNote(MediaItem_Take* take, int noteidx)
EEL2: bool MIDI_DeleteNote(MediaItem_Take take, int noteidx)
Lua: boolean = reaper.MIDI_DeleteNote(MediaItem_Take take, integer noteidx)
Python: Boolean RPR_MIDI_DeleteNote(MediaItem_Take take, Int noteidx)
Description:Delete a MIDI note.
| Parameters: |
| take | - | |
| noteidx | - | |
^
MIDI_DeleteTextSysexEvtFunctioncall:
C: bool MIDI_DeleteTextSysexEvt(MediaItem_Take* take, int textsyxevtidx)
EEL2: bool MIDI_DeleteTextSysexEvt(MediaItem_Take take, int textsyxevtidx)
Lua: boolean = reaper.MIDI_DeleteTextSysexEvt(MediaItem_Take take, integer textsyxevtidx)
Python: Boolean RPR_MIDI_DeleteTextSysexEvt(MediaItem_Take take, Int textsyxevtidx)
Description:Delete a MIDI text or sysex event.
| Parameters: |
| take | - | |
| textsyxevtidx | - | |
^
MIDI_DisableSortFunctioncall:
C: void MIDI_DisableSort(MediaItem_Take* take)
EEL2: MIDI_DisableSort(MediaItem_Take take)
Lua: reaper.MIDI_DisableSort(MediaItem_Take take)
Python: RPR_MIDI_DisableSort(MediaItem_Take take)
Description:Disable sorting for all MIDI insert, delete, get and set functions, until MIDI_Sort is called.
| Parameters: |
| MediaItem_Take take | - | |
^
MIDI_EnumSelCCFunctioncall:
C: int MIDI_EnumSelCC(MediaItem_Take* take, int ccidx)
EEL2: int MIDI_EnumSelCC(MediaItem_Take take, int ccidx)
Lua: integer = reaper.MIDI_EnumSelCC(MediaItem_Take take, integer ccidx)
Python: Int RPR_MIDI_EnumSelCC(MediaItem_Take take, Int ccidx)
Description:Returns the index of the next selected MIDI CC event after ccidx (-1 if there are no more selected events).
| Parameters: |
| take | - | |
| ccidx | - | |
^
MIDI_EnumSelEvtsFunctioncall:
C: int MIDI_EnumSelEvts(MediaItem_Take* take, int evtidx)
EEL2: int MIDI_EnumSelEvts(MediaItem_Take take, int evtidx)
Lua: integer = reaper.MIDI_EnumSelEvts(MediaItem_Take take, integer evtidx)
Python: Int RPR_MIDI_EnumSelEvts(MediaItem_Take take, Int evtidx)
Description:Returns the index of the next selected MIDI event after evtidx (-1 if there are no more selected events).
| Parameters: |
| take | - | |
| evtidx | - | |
^
MIDI_EnumSelNotesFunctioncall:
C: int MIDI_EnumSelNotes(MediaItem_Take* take, int noteidx)
EEL2: int MIDI_EnumSelNotes(MediaItem_Take take, int noteidx)
Lua: integer = reaper.MIDI_EnumSelNotes(MediaItem_Take take, integer noteidx)
Python: Int RPR_MIDI_EnumSelNotes(MediaItem_Take take, Int noteidx)
Description:Returns the index of the next selected MIDI note after noteidx (-1 if there are no more selected events).
| Parameters: |
| take | - | |
| noteidx | - | |
^
MIDI_EnumSelTextSysexEvtsFunctioncall:
C: int MIDI_EnumSelTextSysexEvts(MediaItem_Take* take, int textsyxidx)
EEL2: int MIDI_EnumSelTextSysexEvts(MediaItem_Take take, int textsyxidx)
Lua: integer = reaper.MIDI_EnumSelTextSysexEvts(MediaItem_Take take, integer textsyxidx)
Python: Int RPR_MIDI_EnumSelTextSysexEvts(MediaItem_Take take, Int textsyxidx)
Description:Returns the index of the next selected MIDI text/sysex event after textsyxidx (-1 if there are no more selected events).
| Parameters: |
| take | - | |
| textsyxidx | - | |
^
MIDI_GetAllEvtsFunctioncall:
C: bool MIDI_GetAllEvts(MediaItem_Take* take, char* bufNeedBig, int* bufNeedBig_sz)
EEL2: bool MIDI_GetAllEvts(MediaItem_Take take, #buf)
Lua: boolean retval, string buf = reaper.MIDI_GetAllEvts(MediaItem_Take take, string buf)
Python: (Boolean retval, MediaItem_Take take, String bufNeedBig, Int bufNeedBig_sz) = RPR_MIDI_GetAllEvts(take, bufNeedBig, bufNeedBig_sz)
Description:Get all MIDI data. MIDI buffer is returned as a list of { int offset, char flag, int msglen, unsigned char msg[] }.
offset: MIDI ticks from previous event
flag: &1=selected &2=muted
flag high 4 bits for CC shape: &16=linear, &32=slow start/end, &16|32=fast start, &64=fast end, &64|16=bezier
msg: the MIDI message.
A meta-event of type 0xF followed by 'CCBZ ' and 5 more bytes represents bezier curve data for the previous MIDI event: 1 byte for the bezier type (usually 0) and 4 bytes for the bezier tension as a float.
For tick intervals longer than a 32 bit word can represent, zero-length meta events may be placed between valid events.
See
MIDI_SetAllEvts.
| Parameters: |
| take | - |
|
| string buf | - |
|
| Returnvalues: |
| retval | - |
|
| buf | - |
|
^
MIDI_GetCCFunctioncall:
C: bool MIDI_GetCC(MediaItem_Take* take, int ccidx, bool* selectedOut, bool* mutedOut, double* ppqposOut, int* chanmsgOut, int* chanOut, int* msg2Out, int* msg3Out)
EEL2: bool MIDI_GetCC(MediaItem_Take take, int ccidx, bool &selected, bool &muted, &ppqpos, int &chanmsg, int &chan, int &msg2, int &msg3)
Lua: boolean retval, boolean selected, boolean muted, number ppqpos, number chanmsg, number chan, number msg2, number msg3 = reaper.MIDI_GetCC(MediaItem_Take take, integer ccidx)
Python: (Boolean retval, MediaItem_Take take, Int ccidx, Boolean selectedOut, Boolean mutedOut, Float ppqposOut, Int chanmsgOut, Int chanOut, Int msg2Out, Int msg3Out) = RPR_MIDI_GetCC(take, ccidx, selectedOut, mutedOut, ppqposOut, chanmsgOut, chanOut, msg2Out, msg3Out)
Description:Get MIDI CC event properties.
| Parameters: |
| take | - | |
| ccidx | - | |
| Returnvalues: |
| retval | - | |
| selected | - | |
| muted | - | |
| ppqpos | - | |
| chanmsg | - | |
| chan | - | |
| msg2 | - | |
| msg3 | - | |
^
MIDI_GetCCShapeFunctioncall:
C: bool MIDI_GetCCShape(MediaItem_Take* take, int ccidx, int* shapeOut, double* beztensionOut)
EEL2: bool MIDI_GetCCShape(MediaItem_Take take, int ccidx, int &shape, &beztension)
Lua: boolean retval, number shape, number beztension = reaper.MIDI_GetCCShape(MediaItem_Take take, integer ccidx)
Python: (Boolean retval, MediaItem_Take take, Int ccidx, Int shapeOut, Float beztensionOut) = RPR_MIDI_GetCCShape(take, ccidx, shapeOut, beztensionOut)
Description:
| Parameters: |
| MediaItem_Take take | - |
|
| integer ccidx | - |
|
| Returnvalues: |
| boolean retval | - |
|
| number shape | - |
|
| number beztension | - |
|
^
MIDI_GetEvtFunctioncall:
C: bool MIDI_GetEvt(MediaItem_Take* take, int evtidx, bool* selectedOut, bool* mutedOut, double* ppqposOut, char* msg, int* msg_sz)
EEL2: bool MIDI_GetEvt(MediaItem_Take take, int evtidx, bool &selected, bool &muted, &ppqpos, #msg)
Lua: boolean retval, boolean selected, boolean muted, number ppqpos, string msg = reaper.MIDI_GetEvt(MediaItem_Take take, integer evtidx, boolean selected, boolean muted, number ppqpos, string msg)
Python: (Boolean retval, MediaItem_Take take, Int evtidx, Boolean selectedOut, Boolean mutedOut, Float ppqposOut, String msg, Int msg_sz) = RPR_MIDI_GetEvt(take, evtidx, selectedOut, mutedOut, ppqposOut, msg, msg_sz)
Description:Get MIDI event properties.
| Parameters: |
| MediaItem_Take take | - | |
| integer evtidx | - | |
| boolean selected | - | |
| boolean muted | - | |
| number ppqpos | - | |
| string msg | - | |
| Returnvalues: |
| boolean retval | - | |
| boolean selected | - | |
| boolean muted | - | |
| number ppqpos | - | |
| string msg | - | |
^
MIDI_GetGridFunctioncall:
C: double MIDI_GetGrid(MediaItem_Take* take, double* swingOutOptional, double* noteLenOutOptional)
EEL2: double MIDI_GetGrid(MediaItem_Take take, optional &swing, optional ¬eLen)
Lua: number retval, optional number swing, optional number noteLen = reaper.MIDI_GetGrid(MediaItem_Take take)
Python: (Float retval, MediaItem_Take take, Float swingOutOptional, Float noteLenOutOptional) = RPR_MIDI_GetGrid(take, swingOutOptional, noteLenOutOptional)
Description:Returns the most recent MIDI editor grid size for this MIDI take, in QN. Swing is between 0 and 1. Note length is 0 if it follows the grid size.
| Returnvalues: |
| retval | - | |
| swing | - | |
| noteLen | - | |
^
MIDI_GetHashFunctioncall:
C: bool MIDI_GetHash(MediaItem_Take* take, bool notesonly, char* hash, int hash_sz)
EEL2: bool MIDI_GetHash(MediaItem_Take take, bool notesonly, #hash)
Lua: boolean retval, string hash = reaper.MIDI_GetHash(MediaItem_Take take, boolean notesonly, string hash)
Python: (Boolean retval, MediaItem_Take take, Boolean notesonly, String hash, Int hash_sz) = RPR_MIDI_GetHash(take, notesonly, hash, hash_sz)
Description:Get a string that only changes when the MIDI data changes. If notesonly==true, then the string changes only when the MIDI notes change. See
MIDI_GetTrackHash
| Parameters: |
| MediaItem_Take take | - |
|
| boolean notesonly | - |
|
| string hash | - |
|
| Returnvalues: |
| boolean retval | - |
|
| string hash | - |
|
^
MIDI_GetNoteFunctioncall:
C: bool MIDI_GetNote(MediaItem_Take* take, int noteidx, bool* selectedOut, bool* mutedOut, double* startppqposOut, double* endppqposOut, int* chanOut, int* pitchOut, int* velOut)
EEL2: bool MIDI_GetNote(MediaItem_Take take, int noteidx, bool &selected, bool &muted, &startppqpos, &endppqpos, int &chan, int &pitch, int &vel)
Lua: boolean retval, boolean selected, boolean muted, number startppqpos, number endppqpos, number chan, number pitch, number vel = reaper.MIDI_GetNote(MediaItem_Take take, integer noteidx)
Python: (Boolean retval, MediaItem_Take take, Int noteidx, Boolean selectedOut, Boolean mutedOut, Float startppqposOut, Float endppqposOut, Int chanOut, Int pitchOut, Int velOut) = RPR_MIDI_GetNote(take, noteidx, selectedOut, mutedOut, startppqposOut, endppqposOut, chanOut, pitchOut, velOut)
Description:Get MIDI note properties.
| Parameters: |
| take | - | |
| noteidx | - | |
| Returnvalues: |
| retval | - | |
| selected | - | |
| muted | - | |
| startppqpos | - | |
| endppqpos | - | |
| chan | - | |
| pitch | - | |
| vel | - | |
^
MIDI_GetPPQPos_EndOfMeasureFunctioncall:
C: double MIDI_GetPPQPos_EndOfMeasure(MediaItem_Take* take, double ppqpos)
EEL2: double MIDI_GetPPQPos_EndOfMeasure(MediaItem_Take take, ppqpos)
Lua: number = reaper.MIDI_GetPPQPos_EndOfMeasure(MediaItem_Take take, number ppqpos)
Python: Float RPR_MIDI_GetPPQPos_EndOfMeasure(MediaItem_Take take, Float ppqpos)
Description:Returns the MIDI tick (ppq) position corresponding to the end of the measure.
| Parameters: |
| take | - | |
| ppqpos | - | |
^
MIDI_GetPPQPos_StartOfMeasureFunctioncall:
C: double MIDI_GetPPQPos_StartOfMeasure(MediaItem_Take* take, double ppqpos)
EEL2: double MIDI_GetPPQPos_StartOfMeasure(MediaItem_Take take, ppqpos)
Lua: number = reaper.MIDI_GetPPQPos_StartOfMeasure(MediaItem_Take take, number ppqpos)
Python: Float RPR_MIDI_GetPPQPos_StartOfMeasure(MediaItem_Take take, Float ppqpos)
Description:Returns the MIDI tick (ppq) position corresponding to the start of the measure.
| Parameters: |
| take | - | |
| ppqpos | - | |
^
MIDI_GetPPQPosFromProjQNFunctioncall:
C: double MIDI_GetPPQPosFromProjQN(MediaItem_Take* take, double projqn)
EEL2: double MIDI_GetPPQPosFromProjQN(MediaItem_Take take, projqn)
Lua: number = reaper.MIDI_GetPPQPosFromProjQN(MediaItem_Take take, number projqn)
Python: Float RPR_MIDI_GetPPQPosFromProjQN(MediaItem_Take take, Float projqn)
Description:Returns the MIDI tick (ppq) position corresponding to a specific project time in quarter notes.
| Parameters: |
| take | - | |
| projqn | - | |
^
MIDI_GetPPQPosFromProjTimeFunctioncall:
C: double MIDI_GetPPQPosFromProjTime(MediaItem_Take* take, double projtime)
EEL2: double MIDI_GetPPQPosFromProjTime(MediaItem_Take take, projtime)
Lua: number = reaper.MIDI_GetPPQPosFromProjTime(MediaItem_Take take, number projtime)
Python: Float RPR_MIDI_GetPPQPosFromProjTime(MediaItem_Take take, Float projtime)
Description:Returns the MIDI tick (ppq) position corresponding to a specific project time in seconds.
| Parameters: |
| take | - | |
| projtime | - | |
^
MIDI_GetProjQNFromPPQPosFunctioncall:
C: double MIDI_GetProjQNFromPPQPos(MediaItem_Take* take, double ppqpos)
EEL2: double MIDI_GetProjQNFromPPQPos(MediaItem_Take take, ppqpos)
Lua: number = reaper.MIDI_GetProjQNFromPPQPos(MediaItem_Take take, number ppqpos)
Python: Float RPR_MIDI_GetProjQNFromPPQPos(MediaItem_Take take, Float ppqpos)
Description:Returns the project time in quarter notes corresponding to a specific MIDI tick (ppq) position.
| Parameters: |
| take | - | |
| ppqpos | - | |
^
MIDI_GetProjTimeFromPPQPosFunctioncall:
C: double MIDI_GetProjTimeFromPPQPos(MediaItem_Take* take, double ppqpos)
EEL2: double MIDI_GetProjTimeFromPPQPos(MediaItem_Take take, ppqpos)
Lua: number = reaper.MIDI_GetProjTimeFromPPQPos(MediaItem_Take take, number ppqpos)
Python: Float RPR_MIDI_GetProjTimeFromPPQPos(MediaItem_Take take, Float ppqpos)
Description:Returns the project time in seconds corresponding to a specific MIDI tick (ppq) position.
| Parameters: |
| take | - | |
| ppqpos | - | |
^
MIDI_GetScaleFunctioncall:
C: bool MIDI_GetScale(MediaItem_Take* take, int* rootOut, int* scaleOut, char* name, int name_sz)
EEL2: bool MIDI_GetScale(MediaItem_Take take, int &root, int &scale, #name)
Lua: boolean retval, number root, number scale, string name = reaper.MIDI_GetScale(MediaItem_Take take, number root, number scale, string name)
Python: (Boolean retval, MediaItem_Take take, Int rootOut, Int scaleOut, String name, Int name_sz) = RPR_MIDI_GetScale(take, rootOut, scaleOut, name, name_sz)
Description:Get the active scale in the media source, if any. root 0=C, 1=C#, etc. scale &0x1=root, &0x2=minor 2nd, &0x4=major 2nd, &0x8=minor 3rd, &0xF=fourth, etc.
| Parameters: |
| MediaItem_Take take | - | |
| number root | - | |
| number scale | - | |
| string name | - | |
| Returnvalues: |
| boolean retval | - | |
| number root | - | |
| number scale | - | |
| string name | - | |
^
MIDI_GetTextSysexEvtFunctioncall:
C: bool MIDI_GetTextSysexEvt(MediaItem_Take* take, int textsyxevtidx, bool* selectedOutOptional, bool* mutedOutOptional, double* ppqposOutOptional, int* typeOutOptional, char* msgOptional, int* msgOptional_sz)
EEL2: bool MIDI_GetTextSysexEvt(MediaItem_Take take, int textsyxevtidx, optional bool &selected, optional bool &muted, optional &ppqpos, optional int &type, optional #msg)
Lua: boolean retval, optional boolean selected, optional boolean muted, optional number ppqpos, optional number type, optional string msg = reaper.MIDI_GetTextSysexEvt(MediaItem_Take take, integer textsyxevtidx, optional boolean selected, optional boolean muted, optional number ppqpos, optional number type, optional string msg)
Python: (Boolean retval, MediaItem_Take take, Int textsyxevtidx, Boolean selectedOutOptional, Boolean mutedOutOptional, Float ppqposOutOptional, Int typeOutOptional, String msgOptional, Int msgOptional_sz) = RPR_MIDI_GetTextSysexEvt(take, textsyxevtidx, selectedOutOptional, mutedOutOptional, ppqposOutOptional, typeOutOptional, msgOptional, msgOptional_sz)
Description:Get MIDI meta-event properties. Allowable types are -1:sysex (msg should not include bounding F0..F7), 1-14:MIDI text event types, 15=REAPER notation event. For all other meta-messages, type is returned as -2 and msg returned as all zeroes.
See
MIDI_GetEvt.
| Parameters: |
| MediaItem_Take take | - |
|
| integer textsyxevtidx | - |
|
| optional boolean selected | - |
|
| optional boolean muted | - |
|
| optional number ppqpos | - |
|
| optional number type | - |
|
| optional string msg | - |
|
| Returnvalues: |
| boolean retval | - |
|
| optional boolean selected | - |
|
| optional boolean muted | - |
|
| optional number ppqpos | - |
|
| optional number type | - |
|
| optional string msg | - |
|
^
MIDI_GetTrackHashFunctioncall:
C: bool MIDI_GetTrackHash(MediaTrack* track, bool notesonly, char* hash, int hash_sz)
EEL2: bool MIDI_GetTrackHash(MediaTrack track, bool notesonly, #hash)
Lua: boolean retval, string hash = reaper.MIDI_GetTrackHash(MediaTrack track, boolean notesonly, string hash)
Python: (Boolean retval, MediaTrack track, Boolean notesonly, String hash, Int hash_sz) = RPR_MIDI_GetTrackHash(track, notesonly, hash, hash_sz)
Description:Get a string that only changes when the MIDI data changes. If notesonly==true, then the string changes only when the MIDI notes change. See
MIDI_GetHash
| Parameters: |
| MediaTrack track | - |
|
| boolean notesonly | - |
|
| string hash | - |
|
| Returnvalues: |
| boolean retval | - |
|
| string hash | - |
|
^
MIDI_InsertCCFunctioncall:
C: bool MIDI_InsertCC(MediaItem_Take* take, bool selected, bool muted, double ppqpos, int chanmsg, int chan, int msg2, int msg3)
EEL2: bool MIDI_InsertCC(MediaItem_Take take, bool selected, bool muted, ppqpos, int chanmsg, int chan, int msg2, int msg3)
Lua: boolean = reaper.MIDI_InsertCC(MediaItem_Take take, boolean selected, boolean muted, number ppqpos, integer chanmsg, integer chan, integer msg2, integer msg3)
Python: Boolean RPR_MIDI_InsertCC(MediaItem_Take take, Boolean selected, Boolean muted, Float ppqpos, Int chanmsg, Int chan, Int msg2, Int msg3)
Description:Insert a new MIDI CC event.
| Parameters: |
| take | - | |
| selected | - | |
| muted | - | |
| ppqpos | - | |
| chanmsg | - | |
| chan | - | |
| msg2 | - | |
| msg3 | - | |
^
MIDI_InsertEvtFunctioncall:
C: bool MIDI_InsertEvt(MediaItem_Take* take, bool selected, bool muted, double ppqpos, const char* bytestr, int bytestr_sz)
EEL2: bool MIDI_InsertEvt(MediaItem_Take take, bool selected, bool muted, ppqpos, "bytestr")
Lua: boolean = reaper.MIDI_InsertEvt(MediaItem_Take take, boolean selected, boolean muted, number ppqpos, string bytestr)
Python: Boolean RPR_MIDI_InsertEvt(MediaItem_Take take, Boolean selected, Boolean muted, Float ppqpos, String bytestr, Int bytestr_sz)
Description:Insert a new MIDI event.
| Parameters: |
| take | - | |
| selected | - | |
| muted | - | |
| ppqpos | - | |
| bytestr | - | |
^
MIDI_InsertNoteFunctioncall:
C: bool MIDI_InsertNote(MediaItem_Take* take, bool selected, bool muted, double startppqpos, double endppqpos, int chan, int pitch, int vel, const bool* noSortInOptional)
EEL2: bool MIDI_InsertNote(MediaItem_Take take, bool selected, bool muted, startppqpos, endppqpos, int chan, int pitch, int vel, optional bool noSortIn)
Lua: boolean = reaper.MIDI_InsertNote(MediaItem_Take take, boolean selected, boolean muted, number startppqpos, number endppqpos, integer chan, integer pitch, integer vel, optional boolean noSortIn)
Python: Boolean RPR_MIDI_InsertNote(MediaItem_Take take, Boolean selected, Boolean muted, Float startppqpos, Float endppqpos, Int chan, Int pitch, Int vel, const bool noSortInOptional)
Description:Insert a new MIDI note. Set noSort if inserting multiple events, then call MIDI_Sort when done.
| Parameters: |
| take | - | |
| selected | - | |
| muted | - | |
| startppqpos | - | |
| endppqpos | - | |
| chan | - | |
| pitch | - | |
| vel | - | |
| noSortIn | - | |
^
MIDI_InsertTextSysexEvtFunctioncall:
C: bool MIDI_InsertTextSysexEvt(MediaItem_Take* take, bool selected, bool muted, double ppqpos, int type, const char* bytestr, int bytestr_sz)
EEL2: bool MIDI_InsertTextSysexEvt(MediaItem_Take take, bool selected, bool muted, ppqpos, int type, "bytestr")
Lua: boolean = reaper.MIDI_InsertTextSysexEvt(MediaItem_Take take, boolean selected, boolean muted, number ppqpos, integer type, string bytestr)
Python: Boolean RPR_MIDI_InsertTextSysexEvt(MediaItem_Take take, Boolean selected, Boolean muted, Float ppqpos, Int type, String bytestr, Int bytestr_sz)
Description:Insert a new MIDI text or sysex event. Allowable types are -1:sysex (msg should not include bounding F0..F7), 1-14:MIDI text event types, 15=REAPER notation event.
| Parameters: |
| take | - | |
| selected | - | |
| muted | - | |
| ppqpos | - | |
| type | - | |
| bytestr | - | |
^
midi_reinitFunctioncall:
C: void midi_reinit()
EEL2: midi_reinit()
Lua: reaper.midi_reinit()
Python: RPR_midi_reinit()
Description:Reset all MIDI devices
^
MIDI_SelectAllFunctioncall:
C: void MIDI_SelectAll(MediaItem_Take* take, bool select)
EEL2: MIDI_SelectAll(MediaItem_Take take, bool select)
Lua: reaper.MIDI_SelectAll(MediaItem_Take take, boolean select)
Python: RPR_MIDI_SelectAll(MediaItem_Take take, Boolean select)
Description:Select or deselect all MIDI content.
| Parameters: |
| take | - | |
| select | - | |
^
MIDI_SetAllEvtsFunctioncall:
C: bool MIDI_SetAllEvts(MediaItem_Take* take, const char* buf, int buf_sz)
EEL2: bool MIDI_SetAllEvts(MediaItem_Take take, "buf")
Lua: boolean = reaper.MIDI_SetAllEvts(MediaItem_Take take, string buf)
Python: Boolean RPR_MIDI_SetAllEvts(MediaItem_Take take, String buf, Int buf_sz)
Description:Set all MIDI data. MIDI buffer is passed in as a list of { int offset, char flag, int msglen, unsigned char msg[] }.
offset: MIDI ticks from previous event
flag: &1=selected &2=muted
flag high 4 bits for CC shape: &16=linear, &32=slow start/end, &16|32=fast start, &64=fast end, &64|16=bezier
msg: the MIDI message.
A meta-event of type 0xF followed by 'CCBZ ' and 5 more bytes represents bezier curve data for the previous MIDI event: 1 byte for the bezier type (usually 0) and 4 bytes for the bezier tension as a float.
For tick intervals longer than a 32 bit word can represent, zero-length meta events may be placed between valid events.
See
MIDI_GetAllEvts.
^
MIDI_SetCCFunctioncall:
C: bool MIDI_SetCC(MediaItem_Take* take, int ccidx, const bool* selectedInOptional, const bool* mutedInOptional, const double* ppqposInOptional, const int* chanmsgInOptional, const int* chanInOptional, const int* msg2InOptional, const int* msg3InOptional, const bool* noSortInOptional)
EEL2: bool MIDI_SetCC(MediaItem_Take take, int ccidx, optional bool selectedIn, optional bool mutedIn, optional ppqposIn, optional int chanmsgIn, optional int chanIn, optional int msg2In, optional int msg3In, optional bool noSortIn)
Lua: boolean = reaper.MIDI_SetCC(MediaItem_Take take, integer ccidx, optional boolean selectedIn, optional boolean mutedIn, optional number ppqposIn, optional number chanmsgIn, optional number chanIn, optional number msg2In, optional number msg3In, optional boolean noSortIn)
Python: Boolean RPR_MIDI_SetCC(MediaItem_Take take, Int ccidx, const bool selectedInOptional, const bool mutedInOptional, const double ppqposInOptional, const int chanmsgInOptional, const int chanInOptional, const int msg2InOptional, const int msg3InOptional, const bool noSortInOptional)
Description:Set MIDI CC event properties. Properties passed as NULL will not be set. set noSort if setting multiple events, then call MIDI_Sort when done.
| Parameters: |
| MediaItem_Take take | - | |
| integer ccidx | - | |
| optional boolean selectedIn | - | |
| optional boolean mutedIn | - | |
| optional number ppqposIn | - | |
| optional number chanmsgIn | - | |
| optional number chanIn | - | |
| optional number msg2In | - | |
| optional number msg3In | - | |
| optional boolean noSortIn | - | |
^
MIDI_SetCCShapeFunctioncall:
C: bool MIDI_SetCCShape(MediaItem_Take* take, int ccidx, int shape, double beztension, const bool* noSortInOptional)
EEL2: bool MIDI_SetCCShape(MediaItem_Take take, int ccidx, int shape, beztension, optional bool noSortIn)
Lua: boolean = reaper.MIDI_SetCCShape(MediaItem_Take take, integer ccidx, integer shape, number beztension, optional boolean noSortIn)
Python: Boolean RPR_MIDI_SetCCShape(MediaItem_Take take, Int ccidx, Int shape, Float beztension, const bool noSortInOptional)
Description:Set CC shape and bezier tension. set noSort if setting multiple events, then call MIDI_Sort when done. See
MIDI_SetCC,
MIDI_GetCCShape
| Parameters: |
| MediaItem_Take take | - |
|
| integer ccidx | - |
|
| integer shape | - |
|
| number beztension | - |
|
| optional boolean noSortIn | - |
|
| Returnvalues: |
| boolean retval | - |
|
^
MIDI_SetEvtFunctioncall:
C: bool MIDI_SetEvt(MediaItem_Take* take, int evtidx, const bool* selectedInOptional, const bool* mutedInOptional, const double* ppqposInOptional, const char* msgOptional, int msgOptional_sz, const bool* noSortInOptional)
EEL2: bool MIDI_SetEvt(MediaItem_Take take, int evtidx, optional bool selectedIn, optional bool mutedIn, optional ppqposIn, optional "msg", optional bool noSortIn)
Lua: boolean = reaper.MIDI_SetEvt(MediaItem_Take take, integer evtidx, optional boolean selectedIn, optional boolean mutedIn, optional number ppqposIn, optional string msg, optional boolean noSortIn)
Python: Boolean RPR_MIDI_SetEvt(MediaItem_Take take, Int evtidx, const bool selectedInOptional, const bool mutedInOptional, const double ppqposInOptional, String msgOptional, Int msgOptional_sz, const bool noSortInOptional)
Description:Set MIDI event properties. Properties passed as NULL will not be set. set noSort if setting multiple events, then call MIDI_Sort when done.
| Parameters: |
| take | - | |
| evtidx | - | |
| selectedIn | - | |
| mutedIn | - | |
| msg | - | |
| ppqposIn | - | |
| noSortIn | - | |
^
MIDI_SetItemExtentsFunctioncall:
C: bool MIDI_SetItemExtents(MediaItem* item, double startQN, double endQN)
EEL2: bool MIDI_SetItemExtents(MediaItem item, startQN, endQN)
Lua: boolean = reaper.MIDI_SetItemExtents(MediaItem item, number startQN, number endQN)
Python: Boolean RPR_MIDI_SetItemExtents(MediaItem item, Float startQN, Float endQN)
Description:Set the start/end positions of a media item that contains a MIDI take.
| Parameters: |
| item | - | |
| startQN | - | |
| endQN | - | |
^
MIDI_SetNoteFunctioncall:
C: bool MIDI_SetNote(MediaItem_Take* take, int noteidx, const bool* selectedInOptional, const bool* mutedInOptional, const double* startppqposInOptional, const double* endppqposInOptional, const int* chanInOptional, const int* pitchInOptional, const int* velInOptional, const bool* noSortInOptional)
EEL2: bool MIDI_SetNote(MediaItem_Take take, int noteidx, optional bool selectedIn, optional bool mutedIn, optional startppqposIn, optional endppqposIn, optional int chanIn, optional int pitchIn, optional int velIn, optional bool noSortIn)
Lua: boolean = reaper.MIDI_SetNote(MediaItem_Take take, integer noteidx, optional boolean selectedIn, optional boolean mutedIn, optional number startppqposIn, optional number endppqposIn, optional number chanIn, optional number pitchIn, optional number velIn, optional boolean noSortIn)
Python: Boolean RPR_MIDI_SetNote(MediaItem_Take take, Int noteidx, const bool selectedInOptional, const bool mutedInOptional, const double startppqposInOptional, const double endppqposInOptional, const int chanInOptional, const int pitchInOptional, const int velInOptional, const bool noSortInOptional)
Description:Set MIDI note properties. Properties passed as NULL (or negative values) will not be set. Set noSort if setting multiple events, then call MIDI_Sort when done. Setting multiple note start positions at once is done more safely by deleting and re-inserting the notes.
| Parameters: |
| MediaItem_Take take | - | |
| integer noteidx | - | |
| optional boolean selectedIn | - | |
| optional boolean mutedIn | - | |
| optional number startppqposIn | - | |
| optional number endppqposIn | - | |
| optional number chanIn | - | |
| optional number pitchIn | - | |
| optional number velIn | - | |
| optional boolean noSortIn | - | |
^
MIDI_SetTextSysexEvtFunctioncall:
C: bool MIDI_SetTextSysexEvt(MediaItem_Take* take, int textsyxevtidx, const bool* selectedInOptional, const bool* mutedInOptional, const double* ppqposInOptional, const int* typeInOptional, const char* msgOptional, int msgOptional_sz, const bool* noSortInOptional)
EEL2: bool MIDI_SetTextSysexEvt(MediaItem_Take take, int textsyxevtidx, optional bool selectedIn, optional bool mutedIn, optional ppqposIn, optional int typeIn, optional "msg", optional bool noSortIn)
Lua: boolean = reaper.MIDI_SetTextSysexEvt(MediaItem_Take take, integer textsyxevtidx, optional boolean selectedIn, optional boolean mutedIn, optional number ppqposIn, optional number typeIn, optional string msg, optional boolean noSortIn)
Python: Boolean RPR_MIDI_SetTextSysexEvt(MediaItem_Take take, Int textsyxevtidx, const bool selectedInOptional, const bool mutedInOptional, const double ppqposInOptional, const int typeInOptional, String msgOptional, Int msgOptional_sz, const bool noSortInOptional)
Description:Set MIDI text or sysex event properties. Properties passed as NULL will not be set. Allowable types are -1:sysex (msg should not include bounding F0..F7), 1-14:MIDI text event types, 15=REAPER notation event. set noSort if setting multiple events, then call MIDI_Sort when done.
| Parameters: |
| MediaItem_Take take | - | |
| integer textsyxevtidx | - | |
| optional boolean selectedIn | - | |
| optional boolean mutedIn | - | |
| optional number ppqposIn | - | |
| optional number typeIn | - | |
| optional string msg | - | |
| optional boolean noSortIn | - | |
^
MIDI_SortFunctioncall:
C: void MIDI_Sort(MediaItem_Take* take)
EEL2: MIDI_Sort(MediaItem_Take take)
Lua: reaper.MIDI_Sort(MediaItem_Take take)
Python: RPR_MIDI_Sort(MediaItem_Take take)
Description:Sort MIDI events after multiple calls to MIDI_SetNote, MIDI_SetCC, etc.
^
MIDIEditor_GetActiveFunctioncall:
C: HWND MIDIEditor_GetActive()
EEL2: HWND MIDIEditor_GetActive()
Lua: HWND = reaper.MIDIEditor_GetActive()
Python: HWND RPR_MIDIEditor_GetActive()
Description:
^
MIDIEditor_GetModeFunctioncall:
C: int MIDIEditor_GetMode(HWND midieditor)
EEL2: int MIDIEditor_GetMode(HWND midieditor)
Lua: integer = reaper.MIDIEditor_GetMode(HWND midieditor)
Python: Int RPR_MIDIEditor_GetMode(HWND midieditor)
Description:
^
MIDIEditor_GetSetting_intFunctioncall:
C: int MIDIEditor_GetSetting_int(HWND midieditor, const char* setting_desc)
EEL2: int MIDIEditor_GetSetting_int(HWND midieditor, "setting_desc")
Lua: integer = reaper.MIDIEditor_GetSetting_int(HWND midieditor, string setting_desc)
Python: Int RPR_MIDIEditor_GetSetting_int(HWND midieditor, String setting_desc)
Description:Get settings from a MIDI editor. setting_desc can be:
snap_enabled: returns 0 or 1
active_note_row: returns 0-127
last_clicked_cc_lane:
returns 0-127=CC,
0x100|(0-31)=14-bit CC,
0x200=velocity,
0x201=pitch,
0x202=program,
0x203=channel pressure,
0x204=bank/program select,
0x205=text,
0x206=sysex,
0x207=off velocity,
0x208=notation events,
0x210=media item lane
default_note_vel: returns 0-127
default_note_chan: returns 0-15
default_note_len: returns default length in MIDI ticks
scale_enabled: returns 0-1
scale_root: returns 0-12 (0=C)
if setting_desc is unsupported, the function returns -1.
See
MIDIEditor_SetSetting_int,
MIDIEditor_GetActive,
MIDIEditor_GetSetting_str
| Parameters: |
| midieditor | - |
|
| setting_desc | - |
|
^
MIDIEditor_GetSetting_strFunctioncall:
C: bool MIDIEditor_GetSetting_str(HWND midieditor, const char* setting_desc, char* buf, int buf_sz)
EEL2: bool MIDIEditor_GetSetting_str(HWND midieditor, "setting_desc", #buf)
Lua: boolean retval, string buf = reaper.MIDIEditor_GetSetting_str(HWND midieditor, string setting_desc, string buf)
Python: (Boolean retval, HWND midieditor, String setting_desc, String buf, Int buf_sz) = RPR_MIDIEditor_GetSetting_str(midieditor, setting_desc, buf, buf_sz)
Description:Get settings from a MIDI editor. setting_desc can be:
last_clicked_cc_lane: returns text description ("velocity", "pitch", etc)
scale: returns the scale record, for example "102034050607" for a major scale
if setting_desc is unsupported, the function returns false.
See
MIDIEditor_GetActive,
MIDIEditor_GetSetting_int
| Parameters: |
| midieditor | - |
|
| setting_desc | - |
|
| string buf | - |
|
| Returnvalues: |
| retval | - |
|
| buf | - |
|
^
MIDIEditor_GetTakeFunctioncall:
C: MediaItem_Take* MIDIEditor_GetTake(HWND midieditor)
EEL2: MediaItem_Take MIDIEditor_GetTake(HWND midieditor)
Lua: MediaItem_Take = reaper.MIDIEditor_GetTake(HWND midieditor)
Python: MediaItem_Take RPR_MIDIEditor_GetTake(HWND midieditor)
Description:get the take that is currently being edited in this MIDI editor
| Returnvalues: |
| MediaItem_Take | - | |
^
MIDIEditor_LastFocused_OnCommandFunctioncall:
C: bool MIDIEditor_LastFocused_OnCommand(int command_id, bool islistviewcommand)
EEL2: bool MIDIEditor_LastFocused_OnCommand(int command_id, bool islistviewcommand)
Lua: boolean = reaper.MIDIEditor_LastFocused_OnCommand(integer command_id, boolean islistviewcommand)
Python: Boolean RPR_MIDIEditor_LastFocused_OnCommand(Int command_id, Boolean islistviewcommand)
Description:Send an action command to the last focused MIDI editor. Returns false if there is no MIDI editor open, or if the view mode (piano roll or event list) does not match the input.
see
MIDIEditor_OnCommand
| Parameters: |
| command_id | - |
|
| islistviewcommand | - |
|
^
MIDIEditor_OnCommandFunctioncall:
C: bool MIDIEditor_OnCommand(HWND midieditor, int command_id)
EEL2: bool MIDIEditor_OnCommand(HWND midieditor, int command_id)
Lua: boolean = reaper.MIDIEditor_OnCommand(HWND midieditor, integer command_id)
Python: Boolean RPR_MIDIEditor_OnCommand(HWND midieditor, Int command_id)
Description:
| Parameters: |
| midieditor | - |
|
| command_id | - |
|
^
MIDIEditor_SetSetting_intFunctioncall:
C: bool MIDIEditor_SetSetting_int(HWND midieditor, const char* setting_desc, int setting)
EEL2: bool MIDIEditor_SetSetting_int(HWND midieditor, "setting_desc", int setting)
Lua: boolean retval = reaper.MIDIEditor_SetSetting_int(HWND midieditor, string setting_desc, integer setting)
Python: Boolean RPR_MIDIEditor_SetSetting_int(HWND midieditor, String setting_desc, Int setting)
Description:
| Parameters: |
| HWND midieditor | - |
|
| string setting_desc | - |
|
| integer setting | - |
|
| Returnvalues: |
| boolean retval | - |
|
^
mkpanstrFunctioncall:
C: void mkpanstr(char* strNeed64, double pan)
EEL2: mkpanstr(#strNeed64, pan)
Lua: string strNeed64 = reaper.mkpanstr(string strNeed64, number pan)
Python: (String strNeed64, Float pan) = RPR_mkpanstr(strNeed64, pan)
Description:Converts a double-number to its panstr-equivalent.
See
parsepanstr for its counterpart.
| Parameters: |
| string strNeed64 | - | just set this to ""
|
| number pan | - | the pan-number which shall be converted to the panstring; valid numbers are -1.0 to 1.0 even if you can set higher ones
|
| Returnvalues: |
| string strNeed64 | - | the converted panstring, from -100% over center to 100%
|
^
mkvolpanstrFunctioncall:
C: void mkvolpanstr(char* strNeed64, double vol, double pan)
EEL2: mkvolpanstr(#strNeed64, vol, pan)
Lua: string strNeed64 = reaper.mkvolpanstr(string strNeed64, number vol, number pan)
Python: (String strNeed64, Float vol, Float pan) = RPR_mkvolpanstr(strNeed64, vol, pan)
Description:creates a vol-pan-string, which holds a readable representation of the vol and pan-values.
The format is like "+6.02db center" or "+inf +80R", etc
see
mkpanstr and
mkvolstr for the individual pan/vol-string functions.
| Parameters: |
| stirng strNeed64 | - | just set this to ""
|
| number vol | - | the volume-value, which you want to convert into db
|
| number pan | - | the pan-value, which you want to convert into its percentage value; valid -1.0 to 1.0
|
| Returnvalues: |
| string strNeed64 | - | the converted volpan-string
|
^
mkvolstrFunctioncall:
C: void mkvolstr(char* strNeed64, double vol)
EEL2: mkvolstr(#strNeed64, vol)
Lua: string strNeed64 = reaper.mkvolstr(string strNeed64, number vol)
Python: (String strNeed64, Float vol) = RPR_mkvolstr(strNeed64, vol)
Description:Converts a volume-value into a string-representation of it as dB.
Note: Unlike panstr, there is no parsevolstr-string-function available!
| Parameters: |
| string strNeed64 | - | just set this to "" |
| number vol | - | the volume-value, which shall be converted; 0, -inf; 1, 0dB; 1.412, +3dB |
| Returnvalues: |
| stirng strNeed64 | - | the converted vol-string |
^
MoveEditCursorFunctioncall:
C: void MoveEditCursor(double adjamt, bool dosel)
EEL2: MoveEditCursor(adjamt, bool dosel)
Lua: reaper.MoveEditCursor(number adjamt, boolean dosel)
Python: RPR_MoveEditCursor(Float adjamt, Boolean dosel)
Description:Moves the Edit Cursor.
| Parameters: |
| number adjamt | - | move of edit cursor by seconds, relative from the current position. positive-values=forward, negative values=backwards |
| boolean dosel | - | true, create selection from old edit-cursor-position to the new position; false, just move the edit cursor |
^
MoveMediaItemToTrackFunctioncall:
C: bool MoveMediaItemToTrack(MediaItem* item, MediaTrack* desttr)
EEL2: bool MoveMediaItemToTrack(MediaItem item, MediaTrack desttr)
Lua: boolean = reaper.MoveMediaItemToTrack(MediaItem item, MediaTrack desttr)
Python: Boolean RPR_MoveMediaItemToTrack(MediaItem item, MediaTrack desttr)
Description:Moves a MediaItem-object to a specific MediaTrack.
Call
UpdateArrange to update the arrangeview after that.
| Parameters: |
| MediaItem item | - | the MediaItem, that shall be moved
|
| MediaTrack desttr | - | the MediaTrack, to which the MediaItem shall be moved to
|
| Returnvalues: |
| boolean | - | true, if move succeeded; false, if not
|
^
MuteAllTracksFunctioncall:
C: void MuteAllTracks(bool mute)
EEL2: MuteAllTracks(bool mute)
Lua: reaper.MuteAllTracks(boolean mute)
Python: RPR_MuteAllTracks(Boolean mute)
Description:Mutes all tracks
| Parameters: |
| boolean mute | - | true, mutes all tracks; false, unmutes all tracks |
^
my_getViewportFunctioncall:
C: void my_getViewport(RECT* r, const RECT* sr, bool wantWorkArea)
EEL2: my_getViewport(int &r.left, int &r.top, int &r.right, int &r.bot, int sr.left, int sr.top, int sr.right, int sr.bot, bool wantWorkArea)
Lua: integer left, integer top, integer right, integer bottom = reaper.my_getViewport(number r.left, number r.top, number r.right, number r.bot, number sr.left, number sr.top, number sr.right, number sr.bot, boolean wantWorkArea)
Python: RPR_my_getViewport(RECT r, const RECT sr, Boolean wantWorkArea)
Description:With r.??? and sr.??? parameters, you can define coordinates of a rectangle.
The function will return the left/top/right/bottom coordinates of the viewport that that rectangle is on/closest to.
| Parameters: |
| number r.left | - | left coordinate of the rectangle |
| number r.top | - | top coordinate of the rectangle |
| number r.right | - | right coordinate of the rectangle |
| number r.bot | - | bottom coordinate of the rectangle |
| number sr.left | - | left coordinate of the rectangle in multimonitor usecases |
| number sr.top | - | top coordinate of the rectangle in multimonitor usecases |
| number sr.right | - | right coordinate of the rectangle in multimonitor usecases |
| number sr.bot | - | bottom coordinate of the rectangle in mutlimonitor usecases |
| boolean wantWorkArea | - | true, returns workspace only; false, full monitor coordinates of the returned viewport |
| Returnvalues: |
| integer left | - | left coordinate of the returned viewport |
| integer top | - | top coordinate of the returned viewport |
| integer right | - | right coordinate of the returned viewport |
| integer bottom | - | bottom coordinate of the returned viewport |
^
NamedCommandLookupFunctioncall:
C: int NamedCommandLookup(const char* command_name)
EEL2: int NamedCommandLookup("command_name")
Lua: integer = reaper.NamedCommandLookup(string command_name)
Python: Int RPR_NamedCommandLookup(String command_name)
Description:Get the command ID number for named command that was registered by an extension such as "_SWS_ABOUT" or "_113088d11ae641c193a2b7ede3041ad5" for a ReaScript or a custom action.
see
Main_OnCommand for executing actions with command-ID-numbers.
| Parameters: |
| string command_name | - | the ActionCommandID of the script/action, whose command-id number you want. Must start with _, eg. "SWS_ABOUT" -> "_SWS_ABOUT"
|
| Returnvalues: |
| integer | - | the command-id-number of the script/action, which can be used to e.g. run the action, toggle actions, refresh toolbars, etc.
|
^
OnPauseButtonFunctioncall:
C: void OnPauseButton()
EEL2: OnPauseButton()
Lua: reaper.OnPauseButton()
Python: RPR_OnPauseButton()
Description:Toggles pause/play during play or pause/rec during recording in the current project.
When stopped, it will start paused play.
^
OnPauseButtonExFunctioncall:
C: void OnPauseButtonEx(ReaProject* proj)
EEL2: OnPauseButtonEx(ReaProject proj)
Lua: reaper.OnPauseButtonEx(ReaProject proj)
Python: RPR_OnPauseButtonEx(ReaProject proj)
Description:Toggles pause/play during play or pause/rec during recording in a specific project.
When stopped, it will start paused play.
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
^
OnPlayButtonFunctioncall:
C: void OnPlayButton()
EEL2: OnPlayButton()
Lua: reaper.OnPlayButton()
Python: RPR_OnPlayButton()
Description:Starts playing at edit-cursor. Will stop recording, when executed during recording.
^
OnPlayButtonExFunctioncall:
C: void OnPlayButtonEx(ReaProject* proj)
EEL2: OnPlayButtonEx(ReaProject proj)
Lua: reaper.OnPlayButtonEx(ReaProject proj)
Python: RPR_OnPlayButtonEx(ReaProject proj)
Description:Starts playing at edit-cursor. Will stop recording, when executed during recording.
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
^
OnStopButtonFunctioncall:
C: void OnStopButton()
EEL2: OnStopButton()
Lua: reaper.OnStopButton()
Python: RPR_OnStopButton()
Description:Stops playing/recording.
^
OnStopButtonExFunctioncall:
C: void OnStopButtonEx(ReaProject* proj)
EEL2: OnStopButtonEx(ReaProject proj)
Lua: reaper.OnStopButtonEx(ReaProject proj)
Python: RPR_OnStopButtonEx(ReaProject proj)
Description:Stops playing/recording.
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
^
OpenColorThemeFileFunctioncall:
C: bool OpenColorThemeFile(const char* fn)
EEL2: bool OpenColorThemeFile("fn")
Lua: boolean retval = reaper.OpenColorThemeFile(string fn)
Python: Boolean RPR_OpenColorThemeFile(String fn)
Description:Open a different installed theme.
| Parameters: |
| string fn | - | the path+filename of the color-theme-file, usually with the ".ReaperTheme"-extension |
| Returnvalues: |
| boolean retval | - | true, changing theme worked; false, changing theme didn't work |
^
OpenMediaExplorerFunctioncall:
C: HWND OpenMediaExplorer(const char* mediafn, bool play)
EEL2: HWND OpenMediaExplorer("mediafn", bool play)
Lua: HWND = reaper.OpenMediaExplorer(string mediafn, boolean play)
Python: HWND RPR_OpenMediaExplorer(String mediafn, Boolean play)
Description:Opens mediafn in the Media Explorer.
If you just want to change folder in MediaExplorer, give it a path instead of a file and set play to false.
| Parameters: |
| string mediafn | - | the filename/folder, to be opened with the Media Explorer |
| boolean play | - | true, start/toggle playing immediately; false, just select file without playing |
| Returnvalues: |
| HWND | - | the window of the Media Explorer |
^
OscLocalMessageToHostFunctioncall:
C: void OscLocalMessageToHost(const char* message, const double* valueInOptional)
EEL2: OscLocalMessageToHost("message", optional valueIn)
Lua: reaper.OscLocalMessageToHost(string message, optional number valueIn)
Python: RPR_OscLocalMessageToHost(String message, const double valueInOptional)
Description:Send an OSC message directly to REAPER. The value argument may be NULL. The message will be matched against the default OSC patterns. Only supported if control surface support was enabled when installing REAPER.
This is not broadcast outside of Reaper, so you can't control devices, plugins, etc with it!
Messages sent via this function can be used for parameter-learn/modulation and as shortcuts for scripts.
The parameter valueIn can be retrieved with the returnvalue val of the function reaper.get_action_context, so sending values to a script is possible that way.
| Parameters: |
| string message | - | the osc-message, which shall be sent to Reaper |
| optional number valueIn | - | a number, which can be sent to scripts who are started by the osc-message |
^
parse_timestrFunctioncall:
C: double parse_timestr(const char* buf)
EEL2: double parse_timestr("buf")
Lua: number timestr = reaper.parse_timestr(string buf)
Python: Float RPR_parse_timestr(String buf)
Description:
| Parameters: |
| string buf | - | the timestring to convert (hh:mm:ss.sss). Each position of the time can be one digit only, means: "1:2:3.4" is valid. Milliseconds can be more than 3 digits. Hours, seconds, minutes with more than two digits will be converted correctly "1:120" will be converted to 180 seconds.
|
| Returnvalues: |
| number timestr | - | the converted time in seconds
|
^
parse_timestr_lenFunctioncall:
C: double parse_timestr_len(const char* buf, double offset, int modeoverride)
EEL2: double parse_timestr_len("buf", offset, int modeoverride)
Lua: number = reaper.parse_timestr_len(string buf, number offset, integer modeoverride)
Python: Float RPR_parse_timestr_len(String buf, Float offset, Int modeoverride)
Description:Converts a time-string in its time-in-seconds-representation
time formatting mode overrides: -1=proj default.
0, time
1, measures.beats + time
2, measures.beats
3, seconds
4, samples
5, h:m:s:f
| Parameters: |
| string buf | - | the time-string, which shall be converted into its time in seconds |
| number offset | - | ??Buggy?? |
| integer modeoverride | - | the format, in which the timestring is |
| Returnvalues: |
| number | - | the time, as interpreted from the buf-parameter |
^
parse_timestr_posFunctioncall:
C: double parse_timestr_pos(const char* buf, int modeoverride)
EEL2: double parse_timestr_pos("buf", int modeoverride)
Lua: number = reaper.parse_timestr_pos(string buf, integer modeoverride)
Python: Float RPR_parse_timestr_pos(String buf, Int modeoverride)
Description:Parse time string and convert it into seconds.
| Parameters: |
| string buf | - | the timestring to be parsed and converted into seconds |
| integer modeoverride | - | the format of the timestring to parse and convert -1, proj default. 0, time 1, measures.beats + time 2, measures.beats 3, seconds 4, samples 5, h:m:s:f |
| Returnvalues: |
| number | - | the converted time in seconds |
^
parsepanstrFunctioncall:
C: double parsepanstr(const char* str)
EEL2: double parsepanstr("str")
Lua: number retval = reaper.parsepanstr(string str)
Python: Float RPR_parsepanstr(String str)
Description:
| Parameters: |
| string str | - | a panstring, whose value you want to convert back to its double-equivalent
|
| Returnvalues: |
| number retval | - | the double-value of the panstring
|
^
PCM_Sink_EnumFunctioncall:
C: unsigned int PCM_Sink_Enum(int idx, const char** descstrOut)
EEL2: uint PCM_Sink_Enum(int idx, #descstr)
Lua: integer retval, string descstr = reaper.PCM_Sink_Enum(integer idx)
Python: Int RPR_PCM_Sink_Enum(Int idx, String descstrOut)
Description:enumerates the available PCM-sink-formats, which means, the output-formats available in Reaper
| Parameters: |
| integer idx | - | the index of the sink-format, beginning with 0 |
| Returnvalues: |
| integer retval | - | a number, which represents the PCM-sink-format as an integer-representation
2002876005 - WAV (evaw)
1634297446 - AIFF (ffia)
1769172768 - Audio CD Image (CUE/BIN format) ( osi)
1684303904 - DDP ( pdd)
1718378851 - FLAC (calf)
1836069740 - MP3 (encoder by LAME project) (l3pm)
1869047670 - OGG Vorbis (vggo)
1332176723 - OGG Opus (SggO)
1179012432 - Video (ffmpeg/libav encoder) (PMFF)
1195984416 - Video (GIF) ( FIG)
1279477280 - Video (LCF) ( FCL)
2004250731 - WavPack lossless compressor (kpvw)
maybe others as well? |
| string descstr | - | the PCM-sink-format
0 - WAV
1 - AIFF
2 - Audio CD Image (CUE/BIN format)
3 - DDP
4 - FLAC
5 - MP3 (encoder by LAME project)
6 - OGG Vorbis
7 - OGG Opus
8 - Video (ffmpeg/libav encoder)
9 - Video (GIF)
10 - Video (LCF)
11 - WavPack lossless compressor
maybe others as well? |
^
PCM_Sink_GetExtensionFunctioncall:
C: const char* PCM_Sink_GetExtension(const char* data, int data_sz)
EEL2: bool PCM_Sink_GetExtension(#retval, "data")
Lua: string = reaper.PCM_Sink_GetExtension(string data)
Python: String RPR_PCM_Sink_GetExtension(String data, Int data_sz)
Description:allows you to retrieve the file-extension of a certain PCM-sink/fileformat available.
See
PCM_Sink_Enum to enumerate available PCM-sink/fileformats.
| Parameters: |
| string data | - | the format, whose extension-format you'd like to get: evaw, extension: "wav" ffia, extension: "aif" osi, extension: "cue" pdd, extension: "DAT" calf, extension: "flac" l3pm, extension: "mp3" vggo, extension: "ogg" SggO, extension: "opus" PMFF, extension: "avi" FIG, extension: "gif" FCL, extension: "lcf" kpvw, extension: "wv" maybe others?
|
| Returnvalues: |
| string | - | the extension returned by a certain
|
^
PCM_Sink_ShowConfigFunctioncall:
C: HWND PCM_Sink_ShowConfig(const char* cfg, int cfg_sz, HWND hwndParent)
EEL2: HWND PCM_Sink_ShowConfig("cfg", HWND hwndParent)
Lua: HWND = reaper.PCM_Sink_ShowConfig(string cfg, HWND hwndParent)
Python: HWND RPR_PCM_Sink_ShowConfig(String cfg, Int cfg_sz, HWND hwndParent)
Description:
| Parameters: |
| cfg | - | |
| hwndParent | - | |
^
PCM_Source_CreateFromFileFunctioncall:
C: PCM_source* PCM_Source_CreateFromFile(const char* filename)
EEL2: PCM_source PCM_Source_CreateFromFile("filename")
Lua: PCM_source = reaper.PCM_Source_CreateFromFile(string filename)
Python: PCM_source RPR_PCM_Source_CreateFromFile(String filename)
Description:
| Returnvalues: |
| PCM_source | - |
|
^
PCM_Source_CreateFromFileExFunctioncall:
C: PCM_source* PCM_Source_CreateFromFileEx(const char* filename, bool forcenoMidiImp)
EEL2: PCM_source PCM_Source_CreateFromFileEx("filename", bool forcenoMidiImp)
Lua: PCM_source = reaper.PCM_Source_CreateFromFileEx(string filename, boolean forcenoMidiImp)
Python: PCM_source RPR_PCM_Source_CreateFromFileEx(String filename, Boolean forcenoMidiImp)
Description:Create a PCM_source from filename, and override pref of MIDI files being imported as in-project MIDI events.
| Parameters: |
| filename | - | |
| forcenoMidiImp | - | |
| Returnvalues: |
| PCM_source | - | |
^
PCM_Source_CreateFromTypeFunctioncall:
C: PCM_source* PCM_Source_CreateFromType(const char* sourcetype)
EEL2: PCM_source PCM_Source_CreateFromType("sourcetype")
Lua: PCM_source = reaper.PCM_Source_CreateFromType(string sourcetype)
Python: PCM_source RPR_PCM_Source_CreateFromType(String sourcetype)
Description:Create a PCM_source from a "type" (use this if you're going to load its state via LoadState/ProjectStateContext).
Valid types include "WAVE", "MIDI", or whatever plug-ins define as well.
| Returnvalues: |
| PCM_source | - | |
^
PCM_Source_DestroyFunctioncall:
C: void PCM_Source_Destroy(PCM_source* src)
EEL2: PCM_Source_Destroy(PCM_source src)
Lua: reaper.PCM_Source_Destroy(PCM_source src)
Python: RPR_PCM_Source_Destroy(PCM_source src)
Description:Deletes a PCM_source -- be sure that you remove any project reference before deleting a source
^
PCM_Source_GetPeaksFunctioncall:
C: int PCM_Source_GetPeaks(PCM_source* src, double peakrate, double starttime, int numchannels, int numsamplesperchannel, int want_extra_type, double* buf)
EEL2: int PCM_Source_GetPeaks(PCM_source src, peakrate, starttime, int numchannels, int numsamplesperchannel, int want_extra_type, buffer_ptr buf)
Lua: integer = reaper.PCM_Source_GetPeaks(PCM_source src, number peakrate, number starttime, integer numchannels, integer numsamplesperchannel, integer want_extra_type, reaper.array buf)
Python: (Int retval, PCM_source src, Float peakrate, Float starttime, Int numchannels, Int numsamplesperchannel, Int want_extra_type, Float buf) = RPR_PCM_Source_GetPeaks(src, peakrate, starttime, numchannels, numsamplesperchannel, want_extra_type, buf)
Description:Gets block of peak samples to buf. Note that the peak samples are interleaved, but in two or three blocks (maximums, then minimums, then extra).
Return value has 20 bits of returned sample count, then 4 bits of output_mode (0xf00000), then a bit to signify whether extra_type was available (0x1000000).
extra_type can be 115 ('s') for spectral information, which will return peak samples as integers with the low 15 bits frequency, next 14 bits tonality.
| Parameters: |
| PCM_source src | - | |
| number peakrate | - | |
| number starttime | - | |
| integer numchannels | - | |
| integer numsamplesperchannel | - | |
| integer want_extra_type | - | |
| reaper.array buf | - | |
^
PCM_Source_GetSectionInfoFunctioncall:
C: bool PCM_Source_GetSectionInfo(PCM_source* src, double* offsOut, double* lenOut, bool* revOut)
EEL2: bool PCM_Source_GetSectionInfo(PCM_source src, &offs, &len, bool &rev)
Lua: boolean retval, number offs, number len, boolean rev = reaper.PCM_Source_GetSectionInfo(PCM_source src)
Python: (Boolean retval, PCM_source src, Float offsOut, Float lenOut, Boolean revOut) = RPR_PCM_Source_GetSectionInfo(src, offsOut, lenOut, revOut)
Description:If a section/reverse block, retrieves offset/len/reverse. return true if success
| Returnvalues: |
| retval | - | |
| offs | - | |
| len | - | |
| rev | - | |
^
PluginWantsAlwaysRunFxFunctioncall:
C: void PluginWantsAlwaysRunFx(int amt)
EEL2: PluginWantsAlwaysRunFx(int amt)
Lua: reaper.PluginWantsAlwaysRunFx(integer amt)
Python: RPR_PluginWantsAlwaysRunFx(Int amt)
Description:
^
PreventUIRefreshFunctioncall:
C: void PreventUIRefresh(int prevent_count)
EEL2: PreventUIRefresh(int prevent_count)
Lua: reaper.PreventUIRefresh(integer prevent_count)
Python: RPR_PreventUIRefresh(Int prevent_count)
Description:adds prevent_count to the UI refresh prevention state; always add then remove the same amount, or major disfunction will occur
| Parameters: |
| prevent_count | - | |
^
PromptForActionFunctioncall:
C: int PromptForAction(int session_mode, int init_id, int section_id)
EEL2: int PromptForAction(int session_mode, int init_id, int section_id)
Lua: integer retval = reaper.PromptForAction(integer session_mode, integer init_id, integer section_id)
Python: Int RPR_PromptForAction(Int session_mode, Int init_id, Int section_id)
Description:Opens the actionlist and allows you to get, which action the user selected.
So the user can select numerous actions, and when they hit the select or select/close-button, you can get the actions selected.
To start a new session, pass 1 as parameter session_mode.
After that, repeatedly call the function with session_mode=0, which will return the selected actions.
- -1, the actionlist is closed
- 0, no action has been selected
- any other number, this action has been selected.
In the latter case, call the function until it returns 0 again to get all selected actions.
If you're finished, call the function with session_mode=-1
When finished, call with session_mode=-1.
| Parameters: |
| integer session_mode | - | 1, start a new session; 0, retrieve selected actions; -1, end a session |
| integer init_id | - | the command-id, which shall be preselected, when the actionlist opens |
| integer section_id | - | the section in which you want to let the user select 0 - Main 100 - Main (alt recording) 32060 - MIDI Editor 32061 - MIDI Event List Editor 32062 - MIDI Inline Editor 32063 - Media Explorer |
| Returnvalues: |
| integer retval | - | the selected actions
-1, actionlist is not opened
0, no action has been selected yet/you retrieved all selected actions
any other number, the selected actions; call repeatedly to get all selected commandids until the function returns 0 again |
^
ReaScriptErrorFunctioncall:
C: void ReaScriptError(const char* errmsg)
EEL2: ReaScriptError("errmsg")
Lua: reaper.ReaScriptError(string errmsg)
Python: RPR_ReaScriptError(String errmsg)
Description:Causes REAPER to display the error message after the current ReaScript finishes. If called within a Lua context and errmsg has a ! prefix, script execution will be terminated.
| Parameters: |
| errmsg | - | the message to show |
^
RecursiveCreateDirectoryFunctioncall:
C: int RecursiveCreateDirectory(const char* path, size_t ignored)
EEL2: int RecursiveCreateDirectory("path", size_t ignored)
Lua: integer = reaper.RecursiveCreateDirectory(string path, integer ignored)
Python: Int RPR_RecursiveCreateDirectory(String path, Int ignored)
Description:Creates a new directory.
You can recursivly create directories, means: if the higher directories don't exist, the will also be automatically created.
returns positive value on success, 0 on failure.
| Parameters: |
| path | - | the directory-path to be created |
| ignored | - | unknown |
| Returnvalues: |
| integer | - | 0, failure; 1 and higher, success |
^
reduce_open_filesFunctioncall:
C: int reduce_open_files(int flags)
EEL2: int reduce_open_files(int flags)
Lua: integer = reaper.reduce_open_files(integer flags)
Python: Int RPR_reduce_open_files(Int flags)
Description:garbage-collects extra open files and closes them. if flags has 1 set, this is done incrementally (call this from a regular timer, if desired). if flags has 2 set, files are aggressively closed (they may need to be re-opened very soon).
returns number of files closed by this call.
| Parameters: |
| integer flags | - | influences, how the garbage collection shall be &1, incrementally &2, aggressively(files need to be reopened after that, if needed) |
| Returnvalues: |
| integer | - | the number of closed files |
^
RefreshToolbarFunctioncall:
C: void RefreshToolbar(int command_id)
EEL2: RefreshToolbar(int command_id)
Lua: reaper.RefreshToolbar(integer command_id)
Python: RPR_RefreshToolbar(Int command_id)
Description:Refreshes the toolbar-buttons, associated with a specific command_id/action
See
RefreshToolbar2.
| Parameters: |
| command_id | - | the command_id-number of the action, whose toolbar button you want to toggle. see NamedCommandLookup for getting command-ids from scripts and 3rd-party actions
|
^
RefreshToolbar2Functioncall:
C: void RefreshToolbar2(int section_id, int command_id)
EEL2: RefreshToolbar2(int section_id, int command_id)
Lua: reaper.RefreshToolbar2(integer section_id, integer command_id)
Python: RPR_RefreshToolbar2(Int section_id, Int command_id)
Description:Refreshes the toolbar-buttons, associated with a specific command_id/action within a certain section
| Parameters: |
| section_id | - | the section, in which the action lies |
^
relative_fnFunctioncall:
C: void relative_fn(const char* in, char* out, int out_sz)
EEL2: relative_fn("in", #out)
Lua: string out = reaper.relative_fn(string in, string out)
Python: (String in, String out, Int out_sz) = RPR_relative_fn(in, out, out_sz)
Description:Makes a filename "in" relative to the current project, if any.
| Parameters: |
| string in | - | |
| string out | - | |
| Returnvalues: |
| string out | - | |
^
RemoveTrackSendFunctioncall:
C: bool RemoveTrackSend(MediaTrack* tr, int category, int sendidx)
EEL2: bool RemoveTrackSend(MediaTrack tr, int category, int sendidx)
Lua: boolean = reaper.RemoveTrackSend(MediaTrack tr, integer category, integer sendidx)
Python: Boolean RPR_RemoveTrackSend(MediaTrack tr, Int category, Int sendidx)
Description:
| Parameters: |
| tr | - | the MediaTrack-object, in which you want to remove send/receive/hwouts
|
| category | - | less than 0, receives; 0, sends; greater than 0, hardware outputs
|
| sendidx | - | the idx of the send/receive/hwoutput to remove. 0, the first; 1 for the second, etc
|
| Returnvalues: |
| boolean | - | true, removing worked; false, removing didn't work(e.g. does not exist)
|
^
RenderFileSectionFunctioncall:
C: bool RenderFileSection(const char* source_filename, const char* target_filename, double start_percent, double end_percent, double playrate)
EEL2: bool RenderFileSection("source_filename", "target_filename", start_percent, end_percent, playrate)
Lua: boolean = reaper.RenderFileSection(string source_filename, string target_filename, number start_percent, number end_percent, number playrate)
Python: Boolean RPR_RenderFileSection(String source_filename, String target_filename, Float start_percent, Float end_percent, Float playrate)
Description:Not available while playing back.
| Parameters: |
| source_filename | - | |
| target_filename | - | |
| start_percent | - | |
| end_percent | - | |
| playrate | - | |
^
ReorderSelectedTracksFunctioncall:
C: bool ReorderSelectedTracks(int beforeTrackIdx, int makePrevFolder)
EEL2: bool ReorderSelectedTracks(int beforeTrackIdx, int makePrevFolder)
Lua: boolean retval = reaper.ReorderSelectedTracks(integer beforeTrackIdx, integer makePrevFolder)
Python: Boolean RPR_ReorderSelectedTracks(Int beforeTrackIdx, Int makePrevFolder)
Description:Moves all selected tracks to immediately above track specified by index beforeTrackIdx, returns false if no tracks were selected.
makePrevFolder=0 for normal,
1 = as child of track preceding track specified by beforeTrackIdx,
2 = if track preceding track specified by beforeTrackIdx is last track in folder, extend folder
| Parameters: |
| integer beforeTrackIdx | - | the number of track, before which you want to move the selected tracks; zero-based(0 for track 1, 1 for track 2, etc) |
| integer makePrevFolder | - | decides, whether the track before the moved tracks(beforeTrackIdx-1) shall be a folder-track. Does only apply, when beforeTrackIdx>0(a track above the moved tracks exists). 0, don't make track beforeTrackIdx-1 a folder track; 1, make track beforeTrackIdx-1 a folder track 2, if track beforeTrackIdx-1 is the last track in folder, extend the folder(make the last moved track the last track in folder. |
| Returnvalues: |
| boolean retval | - | true, if it was successful; false, if not(e.g. no tracks were selected) |
^
Resample_EnumModesFunctioncall:
C: const char* Resample_EnumModes(int mode)
EEL2: bool Resample_EnumModes(#retval, int mode)
Lua: string = reaper.Resample_EnumModes(integer mode)
Python: String RPR_Resample_EnumModes(Int mode)
Description:
^
resolve_fnFunctioncall:
C: void resolve_fn(const char* in, char* out, int out_sz)
EEL2: resolve_fn("in", #out)
Lua: string out = reaper.resolve_fn(string in, string out)
Python: (String in, String out, Int out_sz) = RPR_resolve_fn(in, out, out_sz)
Description:
| Parameters: |
| string in | - |
|
| string out | - |
|
| Returnvalues: |
| string out | - |
|
^
resolve_fn2Functioncall:
C: void resolve_fn2(const char* in, char* out, int out_sz, const char* checkSubDirOptional)
EEL2: resolve_fn2("in", #out, optional "checkSubDir")
Lua: string out = reaper.resolve_fn2(string in, string out, optional string checkSubDir)
Python: (String in, String out, Int out_sz, String checkSubDirOptional) = RPR_resolve_fn2(in, out, out_sz, checkSubDirOptional)
Description:Resolves a filename "in" by using project settings etc. If no file found, out will be a copy of in.
| Parameters: |
| string in | - | |
| string out | - | |
| string checkSubDir | - | |
| Returnvalues: |
| string out | - | |
^
ReverseNamedCommandLookupFunctioncall:
C: const char* ReverseNamedCommandLookup(int command_id)
EEL2: bool ReverseNamedCommandLookup(#retval, int command_id)
Lua: string = reaper.ReverseNamedCommandLookup(integer command_id)
Python: String RPR_ReverseNamedCommandLookup(Int command_id)
Description:Get the named command for the given command ID. The returned string will not start with '_' (e.g. it will return "SWS_ABOUT"), it will be NULL if command_id is a native action.
| Parameters: |
| command_id | - | the command/script/action, whose ActionCommandID you want to have |
| Returnvalues: |
| string | - | the ActionCommandID of the command/script/action |
^
ScaleFromEnvelopeModeFunctioncall:
C: double ScaleFromEnvelopeMode(int scaling_mode, double val)
EEL2: double ScaleFromEnvelopeMode(int scaling_mode, val)
Lua: number = reaper.ScaleFromEnvelopeMode(integer scaling_mode, number val)
Python: Float RPR_ScaleFromEnvelopeMode(Int scaling_mode, Float val)
Description:
| Parameters: |
| scaling_mode | - |
|
| val | - |
|
^
ScaleToEnvelopeModeFunctioncall:
C: double ScaleToEnvelopeMode(int scaling_mode, double val)
EEL2: double ScaleToEnvelopeMode(int scaling_mode, val)
Lua: number = reaper.ScaleToEnvelopeMode(integer scaling_mode, number val)
Python: Float RPR_ScaleToEnvelopeMode(Int scaling_mode, Float val)
Description:
| Parameters: |
| scaling_mode | - |
|
| val | - |
|
^
SelectAllMediaItemsFunctioncall:
C: void SelectAllMediaItems(ReaProject* proj, bool selected)
EEL2: SelectAllMediaItems(ReaProject proj, bool selected)
Lua: reaper.SelectAllMediaItems(ReaProject proj, boolean selected)
Python: RPR_SelectAllMediaItems(ReaProject proj, Boolean selected)
Description:Selects or deselects all MediaItems in a project.
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| selected | - | true, select; false, deselect
|
^
SelectProjectInstanceFunctioncall:
C: void SelectProjectInstance(ReaProject* proj)
EEL2: SelectProjectInstance(ReaProject proj)
Lua: reaper.SelectProjectInstance(ReaProject proj)
Python: RPR_SelectProjectInstance(ReaProject proj)
Description:Switch to another opened project/projecttab.
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
^
SetActiveTakeFunctioncall:
C: void SetActiveTake(MediaItem_Take* take)
EEL2: SetActiveTake(MediaItem_Take take)
Lua: reaper.SetActiveTake(MediaItem_Take take)
Python: RPR_SetActiveTake(MediaItem_Take take)
Description:set this take active in this media item
| Parameters: |
| take | - | the MediaItem_Take, you want to set as active-take in the MediaItem it is associated with |
^
SetAutomationModeFunctioncall:
C: void SetAutomationMode(int mode, bool onlySel)
EEL2: SetAutomationMode(int mode, bool onlySel)
Lua: reaper.SetAutomationMode(integer mode, boolean onlySel)
Python: RPR_SetAutomationMode(Int mode, Boolean onlySel)
Description:Sets all or selected tracks to mode.
Includes the master-track.
| Parameters: |
| mode | - | the automation-mode 0, Trim/read 1, Read 2, Touch 3, Write 4, Latch 5 and higher no mode selected |
| onlySel | - | true, only selected tracks; false, all tracks including master-track |
^
SetCurrentBPMFunctioncall:
C: void SetCurrentBPM(ReaProject* __proj, double bpm, bool wantUndo)
EEL2: SetCurrentBPM(ReaProject __proj, bpm, bool wantUndo)
Lua: reaper.SetCurrentBPM(ReaProject proj, number bpm, boolean wantUndo)
Python: RPR_SetCurrentBPM(ReaProject __proj, Float bpm, Boolean wantUndo)
Description:set current BPM in project, set wantUndo=true to add undo point
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| bpm | - | the new beats per minute-value
|
| wantUndo | - | true, add undo point; false, no undo point added
|
^
SetCursorContextFunctioncall:
C: void SetCursorContext(int mode, TrackEnvelope* envInOptional)
EEL2: SetCursorContext(int mode, TrackEnvelope envIn)
Lua: reaper.SetCursorContext(integer mode, TrackEnvelope envIn)
Python: RPR_SetCursorContext(Int mode, TrackEnvelope envInOptional)
Description:Change the focus for the cursor.
You must use this to change the focus for the cursor programmatically.
mode=0 to focus track panels, 1 to focus the arrange window, 2 to focus the arrange window and select env (or envIn==NULL to clear the current track/take envelope selection)
| Parameters: |
| mode | - | the focus to be changed to 0, track panels 1, arrange window 2, arrangewindow and env |
| envIn | - | TrackEnvelope-object of the envelope to select(only when mode=2, else set to nil); nil, clear current track/envelope-selection; |
^
SetEditCurPosFunctioncall:
C: void SetEditCurPos(double time, bool moveview, bool seekplay)
EEL2: SetEditCurPos(time, bool moveview, bool seekplay)
Lua: reaper.SetEditCurPos(number time, boolean moveview, boolean seekplay)
Python: RPR_SetEditCurPos(Float time, Boolean moveview, Boolean seekplay)
Description:Change the position of the edit-cursor in the current project.
| Parameters: |
| time | - | the new editcursor-position in seconds |
| moveview | - | true, change the arrange-view so editcursor is visible; false, just set the edit-cursor without moving the view(editcursor might be out of sight) |
| seekplay | - | true, when playing, restart playing at the new edit-cursor position; false, keep playing at "old" playposition |
^
SetEditCurPos2Functioncall:
C: void SetEditCurPos2(ReaProject* proj, double time, bool moveview, bool seekplay)
EEL2: SetEditCurPos2(ReaProject proj, time, bool moveview, bool seekplay)
Lua: reaper.SetEditCurPos2(ReaProject proj, number time, boolean moveview, boolean seekplay)
Python: RPR_SetEditCurPos2(ReaProject proj, Float time, Boolean moveview, Boolean seekplay)
Description:Change the position of the edit-cursor in a specific project.
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| time | - | the new editcursor-position in seconds
|
| moveview | - | true, change the arrange-view so editcursor is visible; false, just set the edit-cursor without moving the view(editcursor might be out of sight)
|
| seekplay | - | true, when playing, restart playing at the new edit-cursor position; false, keep playing at "old" playposition
|
^
SetEnvelopePointFunctioncall:
C: bool SetEnvelopePoint(TrackEnvelope* envelope, int ptidx, double* timeInOptional, double* valueInOptional, int* shapeInOptional, double* tensionInOptional, bool* selectedInOptional, bool* noSortInOptional)
EEL2: bool SetEnvelopePoint(TrackEnvelope envelope, int ptidx, optional timeIn, optional valueIn, optional int shapeIn, optional tensionIn, optional bool selectedIn, optional bool noSortIn)
Lua: boolean = reaper.SetEnvelopePoint(TrackEnvelope envelope, integer ptidx, optional number timeIn, optional number valueIn, optional number shapeIn, optional number tensionIn, optional boolean selectedIn, optional boolean noSortIn)
Python: (Boolean retval, TrackEnvelope envelope, Int ptidx, Float timeInOptional, Float valueInOptional, Int shapeInOptional, Float tensionInOptional, Boolean selectedInOptional, Boolean noSortInOptional) = RPR_SetEnvelopePoint(envelope, ptidx, timeInOptional, valueInOptional, shapeInOptional, tensionInOptional, selectedInOptional, noSortInOptional)
Description:Set attributes of an envelope point. Values that are not supplied will be ignored. If setting multiple points at once, set noSort=true, and call Envelope_SortPoints when done. See
SetEnvelopePointEx.
| Parameters: |
| TrackEnvelope envelope | - |
|
| integer ptidx | - |
|
| optional number timeIn | - |
|
| optional number valueIn | - |
|
| optional number shapeIn | - |
|
| optional number tensionIn | - |
|
| optional boolean selectedIn | - |
|
| optional boolean noSortIn | - |
|
^
SetEnvelopePointExFunctioncall:
C: bool SetEnvelopePointEx(TrackEnvelope* envelope, int autoitem_idx, int ptidx, double* timeInOptional, double* valueInOptional, int* shapeInOptional, double* tensionInOptional, bool* selectedInOptional, bool* noSortInOptional)
EEL2: bool SetEnvelopePointEx(TrackEnvelope envelope, int autoitem_idx, int ptidx, optional timeIn, optional valueIn, optional int shapeIn, optional tensionIn, optional bool selectedIn, optional bool noSortIn)
Lua: boolean = reaper.SetEnvelopePointEx(TrackEnvelope envelope, integer autoitem_idx, integer ptidx, optional number timeIn, optional number valueIn, optional number shapeIn, optional number tensionIn, optional boolean selectedIn, optional boolean noSortIn)
Python: (Boolean retval, TrackEnvelope envelope, Int autoitem_idx, Int ptidx, Float timeInOptional, Float valueInOptional, Int shapeInOptional, Float tensionInOptional, Boolean selectedInOptional, Boolean noSortInOptional) = RPR_SetEnvelopePointEx(envelope, autoitem_idx, ptidx, timeInOptional, valueInOptional, shapeInOptional, tensionInOptional, selectedInOptional, noSortInOptional)
Description:Set attributes of an envelope point. Values that are not supplied will be ignored. If setting multiple points at once, set noSort=true, and call Envelope_SortPoints when done.
autoitem_idx=-1 for the underlying envelope, 0 for the first automation item on the envelope, etc.
For automation items, pass autoitem_idx|0x10000000 to base ptidx on the number of points in one full loop iteration,
even if the automation item is trimmed so that not all points are visible.
Otherwise, ptidx will be based on the number of visible points in the automation item, including all loop iterations.
See
CountEnvelopePointsEx,
GetEnvelopePointEx,
InsertEnvelopePointEx,
DeleteEnvelopePointEx.
| Parameters: |
| TrackEnvelope envelope | - |
|
| integer autoitem_idx | - |
|
| integer ptidx | - |
|
| optional number timeIn | - |
|
| optional number valueIn | - |
|
| optional number shapeIn | - |
|
| optional number tensionIn | - |
|
| optional boolean selectedIn | - |
|
| optional boolean noSortIn | - |
|
^
SetEnvelopeStateChunkFunctioncall:
C: bool SetEnvelopeStateChunk(TrackEnvelope* env, const char* str, bool isundoOptional)
EEL2: bool SetEnvelopeStateChunk(TrackEnvelope env, "str", bool isundo)
Lua: boolean = reaper.SetEnvelopeStateChunk(TrackEnvelope env, string str, boolean isundo)
Python: Boolean RPR_SetEnvelopeStateChunk(TrackEnvelope env, String str, Boolean isundoOptional)
Description:Sets the RPPXML state of an envelope, returns true if successful.
| Parameters: |
| env | - | the TrackEnvelope, whose statechunk you want to set |
| str | - | the new statechunk, that you want to set |
| isundo | - | undo flag is a performance/caching hint. |
| Returnvalues: |
| boolean | - | true, setting worked; false, setting didn't work |
^
SetExtStateFunctioncall:
C: void SetExtState(const char* section, const char* key, const char* value, bool persist)
EEL2: SetExtState("section", "key", "value", bool persist)
Lua: reaper.SetExtState(string section, string key, string value, boolean persist)
Python: RPR_SetExtState(String section, String key, String value, Boolean persist)
Description:Set the extended state value for a specific section and key.
Persistant states are stored into the reaper-extstate.ini in the resources-folder.
See
GetExtState,
DeleteExtState,
HasExtState.
| Parameters: |
| section | - | the section, in which the key-value is stored
|
| key | - | the key, which stores the value
|
| value | - | the new value to be set
|
| persist | - | true, means the value should be stored and reloaded the next time REAPER is opened
|
^
SetGlobalAutomationOverrideFunctioncall:
C: void SetGlobalAutomationOverride(int mode)
EEL2: SetGlobalAutomationOverride(int mode)
Lua: reaper.SetGlobalAutomationOverride(integer mode)
Python: RPR_SetGlobalAutomationOverride(Int mode)
Description:
^
SetItemStateChunkFunctioncall:
C: bool SetItemStateChunk(MediaItem* item, const char* str, bool isundoOptional)
EEL2: bool SetItemStateChunk(MediaItem item, "str", bool isundo)
Lua: boolean = reaper.SetItemStateChunk(MediaItem item, string str, boolean isundo)
Python: Boolean RPR_SetItemStateChunk(MediaItem item, String str, Boolean isundoOptional)
Description:Sets the RPPXML state of an item, returns true if successful. Undo flag is a performance/caching hint.
| Parameters: |
| item | - | |
| str | - | |
| isundo | - | |
^
SetMasterTrackVisibilityFunctioncall:
C: int SetMasterTrackVisibility(int flag)
EEL2: int SetMasterTrackVisibility(int flag)
Lua: integer = reaper.SetMasterTrackVisibility(integer flag)
Python: Int RPR_SetMasterTrackVisibility(Int flag)
Description:set &1=1 to show the master track in the TCP, &2=2 to hide in the mixer. Returns the previous visibility state. See
GetMasterTrackVisibility.
^
SetMediaItemInfo_ValueFunctioncall:
C: bool SetMediaItemInfo_Value(MediaItem* item, const char* parmname, double newvalue)
EEL2: bool SetMediaItemInfo_Value(MediaItem item, "parmname", newvalue)
Lua: boolean = reaper.SetMediaItemInfo_Value(MediaItem item, string parmname, number newvalue)
Python: Boolean RPR_SetMediaItemInfo_Value(MediaItem item, String parmname, Float newvalue)
Description:Set media item numerical-value attributes.
B_MUTE : bool * : muted
B_MUTE_ACTUAL : bool * : muted (ignores solo). setting this value will not affect C_MUTE_SOLO.
C_MUTE_SOLO : char * : solo override (-1=soloed, 0=no override, 1=unsoloed). note that this API does not automatically unsolo other items when soloing (nor clear the unsolos when clearing the last soloed item), it must be done by the caller via action or via this API.
B_LOOPSRC : bool * : loop source
B_ALLTAKESPLAY : bool * : all takes play
B_UISEL : bool * : selected in arrange view
C_BEATATTACHMODE : char * : item timebase, -1=track or project default, 1=beats (position, length, rate), 2=beats (position only). for auto-stretch timebase: C_BEATATTACHMODE=1, C_AUTOSTRETCH=1
C_AUTOSTRETCH: : char * : auto-stretch at project tempo changes, 1=enabled, requires C_BEATATTACHMODE=1
C_LOCK : char * : locked, &1=locked, &2=lock to active take
D_VOL : double * : item volume, 0=-inf, 0.5=-6dB, 1=+0dB, 2=+6dB, etc
D_POSITION : double * : item position in seconds
D_LENGTH : double * : item length in seconds
D_SNAPOFFSET : double * : item snap offset in seconds
D_FADEINLEN : double * : item manual fadein length in seconds
D_FADEOUTLEN : double * : item manual fadeout length in seconds
D_FADEINDIR : double * : item fadein curvature, -1..1
D_FADEOUTDIR : double * : item fadeout curvature, -1..1
D_FADEINLEN_AUTO : double * : item auto-fadein length in seconds, -1=no auto-fadein
D_FADEOUTLEN_AUTO : double * : item auto-fadeout length in seconds, -1=no auto-fadeout
C_FADEINSHAPE : int * : fadein shape, 0..6, 0=linear
C_FADEOUTSHAPE : int * : fadeout shape, 0..6, 0=linear
I_GROUPID : int * : group ID, 0=no group
I_LASTY : int * : Y-position of track in pixels (read-only)
I_LASTH : int * : height in track in pixels (read-only)
I_CUSTOMCOLOR : int * : custom color, OS dependent color|0x100000 (i.e. ColorToNative(r,g,b)|0x100000). If you do not |0x100000, then it will not be used, but will store the color.
I_CURTAKE : int * : active take number
IP_ITEMNUMBER : int, item number on this track (read-only, returns the item number directly)
F_FREEMODE_Y : float * : free item positioning Y-position, 0=top of track, 1=bottom of track (will never be 1)
F_FREEMODE_H : float * : free item positioning height, 0=no height, 1=full height of track (will never be 0)
| Parameters: |
| item | - | |
| parmname | - | |
| newvalue | - | |
^
SetMediaItemLengthFunctioncall:
C: bool SetMediaItemLength(MediaItem* item, double length, bool refreshUI)
EEL2: bool SetMediaItemLength(MediaItem item, length, bool refreshUI)
Lua: boolean = reaper.SetMediaItemLength(MediaItem item, number length, boolean refreshUI)
Python: Boolean RPR_SetMediaItemLength(MediaItem item, Float length, Boolean refreshUI)
Description:Redraws the screen only if refreshUI == true.
See
UpdateArrange().
| Parameters: |
| item | - |
|
| length | - |
|
| refreshUI | - |
|
^
SetMediaItemPositionFunctioncall:
C: bool SetMediaItemPosition(MediaItem* item, double position, bool refreshUI)
EEL2: bool SetMediaItemPosition(MediaItem item, position, bool refreshUI)
Lua: boolean = reaper.SetMediaItemPosition(MediaItem item, number position, boolean refreshUI)
Python: Boolean RPR_SetMediaItemPosition(MediaItem item, Float position, Boolean refreshUI)
Description:Redraws the screen only if refreshUI == true.
See
UpdateArrange().
| Parameters: |
| item | - |
|
| position | - |
|
| refreshUI | - |
|
^
SetMediaItemSelectedFunctioncall:
C: void SetMediaItemSelected(MediaItem* item, bool selected)
EEL2: SetMediaItemSelected(MediaItem item, bool selected)
Lua: reaper.SetMediaItemSelected(MediaItem item, boolean selected)
Python: RPR_SetMediaItemSelected(MediaItem item, Boolean selected)
Description:
| Parameters: |
| item | - | |
| selected | - | |
^
SetMediaItemTake_SourceFunctioncall:
C: bool SetMediaItemTake_Source(MediaItem_Take* take, PCM_source* source)
EEL2: bool SetMediaItemTake_Source(MediaItem_Take take, PCM_source source)
Lua: boolean = reaper.SetMediaItemTake_Source(MediaItem_Take take, PCM_source source)
Python: Boolean RPR_SetMediaItemTake_Source(MediaItem_Take take, PCM_source source)
Description:Set media source of media item take. The old source will not be destroyed, it is the caller's responsibility to retrieve it and destroy it after. If source already exists in any project, it will be duplicated before being set. C/C++ code should not use this and instead use GetSetMediaItemTakeInfo() with P_SOURCE to manage ownership directly.
| Parameters: |
| take | - | |
| source | - | |
^
SetMediaItemTakeInfo_ValueFunctioncall:
C: bool SetMediaItemTakeInfo_Value(MediaItem_Take* take, const char* parmname, double newvalue)
EEL2: bool SetMediaItemTakeInfo_Value(MediaItem_Take take, "parmname", newvalue)
Lua: boolean = reaper.SetMediaItemTakeInfo_Value(MediaItem_Take take, string parmname, number newvalue)
Python: Boolean RPR_SetMediaItemTakeInfo_Value(MediaItem_Take take, String parmname, Float newvalue)
Description:Set media item take numerical-value attributes.
D_STARTOFFS : double * : start offset in source media, in seconds
D_VOL : double * : take volume, 0=-inf, 0.5=-6dB, 1=+0dB, 2=+6dB, etc, negative if take polarity is flipped
D_PAN : double * : take pan, -1..1
D_PANLAW : double * : take pan law, -1=default, 0.5=-6dB, 1.0=+0dB, etc
D_PLAYRATE : double * : take playback rate, 0.5=half speed, 1=normal, 2=double speed, etc
D_PITCH : double * : take pitch adjustment in semitones, -12=one octave down, 0=normal, +12=one octave up, etc
B_PPITCH : bool * : preserve pitch when changing playback rate
I_CHANMODE : int * : channel mode, 0=normal, 1=reverse stereo, 2=downmix, 3=left, 4=right
I_PITCHMODE : int * : pitch shifter mode, -1=projext default, otherwise high 2 bytes=shifter, low 2 bytes=parameter
I_CUSTOMCOLOR : int * : custom color, OS dependent color|0x100000 (i.e. ColorToNative(r,g,b)|0x100000). If you do not |0x100000, then it will not be used, but will store the color.
IP_TAKENUMBER : int : take number (read-only, returns the take number directly)
| Parameters: |
| take | - | |
| parmname | - | |
| newvalue | - | |
^
SetMediaTrackInfo_ValueFunctioncall:
C: bool SetMediaTrackInfo_Value(MediaTrack* tr, const char* parmname, double newvalue)
EEL2: bool SetMediaTrackInfo_Value(MediaTrack tr, "parmname", newvalue)
Lua: boolean = reaper.SetMediaTrackInfo_Value(MediaTrack tr, string parmname, number newvalue)
Python: Boolean RPR_SetMediaTrackInfo_Value(MediaTrack tr, String parmname, Float newvalue)
Description:Set track numerical-value attributes.
B_MUTE : bool * : muted
B_PHASE : bool * : track phase inverted
B_RECMON_IN_EFFECT : bool * : record monitoring in effect (current audio-thread playback state, read-only)
IP_TRACKNUMBER : int : track number 1-based, 0=not found, -1=master track (read-only, returns the int directly)
I_SOLO : int * : soloed, 0=not soloed, 1=soloed, 2=soloed in place, 5=safe soloed, 6=safe soloed in place
I_FXEN : int * : fx enabled, 0=bypassed, !0=fx active
I_RECARM : int * : record armed, 0=not record armed, 1=record armed
I_RECINPUT : int * : record input, <0=no input. if 4096 set, input is MIDI and low 5 bits represent channel (0=all, 1-16=only chan), next 6 bits represent physical input (63=all, 62=VKB). If 4096 is not set, low 10 bits (0..1023) are input start channel (ReaRoute/Loopback start at 512). If 2048 is set, input is multichannel input (using track channel count), or if 1024 is set, input is stereo input, otherwise input is mono.
I_RECMODE : int * : record mode, 0=input, 1=stereo out, 2=none, 3=stereo out w/latency compensation, 4=midi output, 5=mono out, 6=mono out w/ latency compensation, 7=midi overdub, 8=midi replace
I_RECMON : int * : record monitoring, 0=off, 1=normal, 2=not when playing (tape style)
I_RECMONITEMS : int * : monitor items while recording, 0=off, 1=on
I_AUTOMODE : int * : track automation mode, 0=trim/off, 1=read, 2=touch, 3=write, 4=latch
I_NCHAN : int * : number of track channels, 2-64, even numbers only
I_SELECTED : int * : track selected, 0=unselected, 1=selected
I_WNDH : int * : current TCP window height in pixels including envelopes (read-only)
I_TCPH : int * : current TCP window height in pixels not including envelopes (read-only)
I_TCPY : int * : current TCP window Y-position in pixels relative to top of arrange view (read-only)
I_MCPX : int * : current MCP X-position in pixels relative to mixer container
I_MCPY : int * : current MCP Y-position in pixels relative to mixer container
I_MCPW : int * : current MCP width in pixels
I_MCPH : int * : current MCP height in pixels
I_FOLDERDEPTH : int * : folder depth change, 0=normal, 1=track is a folder parent, -1=track is the last in the innermost folder, -2=track is the last in the innermost and next-innermost folders, etc
I_FOLDERCOMPACT : int * : folder compacted state (only valid on folders), 0=normal, 1=small, 2=tiny children
I_MIDIHWOUT : int * : track midi hardware output index, <0=disabled, low 5 bits are which channels (0=all, 1-16), next 5 bits are output device index (0-31)
I_PERFFLAGS : int * : track performance flags, &1=no media buffering, &2=no anticipative FX
I_CUSTOMCOLOR : int * : custom color, OS dependent color|0x100000 (i.e. ColorToNative(r,g,b)|0x100000). If you do not |0x100000, then it will not be used, but will store the color
I_HEIGHTOVERRIDE : int * : custom height override for TCP window, 0 for none, otherwise size in pixels
B_HEIGHTLOCK : bool * : track height lock (must set I_HEIGHTOVERRIDE before locking)
D_VOL : double * : trim volume of track, 0=-inf, 0.5=-6dB, 1=+0dB, 2=+6dB, etc
D_PAN : double * : trim pan of track, -1..1
D_WIDTH : double * : width of track, -1..1
D_DUALPANL : double * : dualpan position 1, -1..1, only if I_PANMODE==6
D_DUALPANR : double * : dualpan position 2, -1..1, only if I_PANMODE==6
I_PANMODE : int * : pan mode, 0=classic 3.x, 3=new balance, 5=stereo pan, 6=dual pan
D_PANLAW : double * : pan law of track, <0=project default, 1=+0dB, etc
P_ENV:<envchunkname or P_ENV:{GUID... : TrackEnvelope*, read only. chunkname can be <VOLENV, <PANENV, etc; GUID is the stringified envelope GUID.
B_SHOWINMIXER : bool * : track control panel visible in mixer (do not use on master track)
B_SHOWINTCP : bool * : track control panel visible in arrange view (do not use on master track)
B_MAINSEND : bool * : track sends audio to parent
C_MAINSEND_OFFS : char * : channel offset of track send to parent
B_FREEMODE : bool * : track free item positioning enabled (call UpdateTimeline() after changing)
C_BEATATTACHMODE : char * : track timebase, -1=project default, 0=time, 1=beats (position, length, rate), 2=beats (position only)
F_MCP_FXSEND_SCALE : float * : scale of fx+send area in MCP (0=minimum allowed, 1=maximum allowed)
F_MCP_FXPARM_SCALE : float * : scale of fx parameter area in MCP (0=minimum allowed, 1=maximum allowed)
F_MCP_SENDRGN_SCALE : float * : scale of send area as proportion of the fx+send total area (0=minimum allowed, 1=maximum allowed)
F_TCP_FXPARM_SCALE : float * : scale of TCP parameter area when TCP FX are embedded (0=min allowed, default, 1=max allowed)
I_PLAY_OFFSET_FLAG : int * : track playback offset state, &1=bypassed, &2=offset value is measured in samples (otherwise measured in seconds)
D_PLAY_OFFSET : double * : track playback offset, units depend on I_PLAY_OFFSET_FLAG
| Parameters: |
| tr | - | |
| parmname | - | |
| newvalue | - | |
^
SetMIDIEditorGridFunctioncall:
C: void SetMIDIEditorGrid(ReaProject* project, double division)
EEL2: SetMIDIEditorGrid(ReaProject project, division)
Lua: reaper.SetMIDIEditorGrid(ReaProject project, number division)
Python: RPR_SetMIDIEditorGrid(ReaProject project, Float division)
Description:Set the MIDI editor grid division. 0.25=quarter note, 1.0/3.0=half note tripet, etc.
| Parameters: |
| project | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| division | - |
|
^
SetMixerScrollFunctioncall:
C: MediaTrack* SetMixerScroll(MediaTrack* leftmosttrack)
EEL2: MediaTrack SetMixerScroll(MediaTrack leftmosttrack)
Lua: MediaTrack = reaper.SetMixerScroll(MediaTrack leftmosttrack)
Python: MediaTrack RPR_SetMixerScroll(MediaTrack leftmosttrack)
Description:Scroll the mixer so that leftmosttrack is the leftmost visible track. Returns the leftmost track after scrolling, which may be different from the passed-in track if there are not enough tracks to its right.
| Parameters: |
| leftmosttrack | - | the desired leftmost-MediaTrack |
| Returnvalues: |
| MediaTrack | - | the new leftmost-track as MediaTrack-object |
^
SetMouseModifierFunctioncall:
C: void SetMouseModifier(const char* context, int modifier_flag, const char* action)
EEL2: SetMouseModifier("context", int modifier_flag, "action")
Lua: reaper.SetMouseModifier(string context, integer modifier_flag, string action)
Python: RPR_SetMouseModifier(String context, Int modifier_flag, String action)
Description:Set the mouse modifier assignment for a specific modifier key assignment, in a specific context.
Context is a string like "MM
CTXITEM". Find these strings by modifying an assignment in
Preferences/Editing/Mouse Modifiers, then looking in reaper-mouse.ini.
Modifier flag is a number from 0 to 15: add 1 for shift, 2 for control, 4 for alt, 8 for win.
(macOS: add 1 for shift, 2 for command, 4 for opt, 8 for control.)
For left-click and double-click contexts, the action can be any built-in command ID number
or any custom action ID string. Find built-in command IDs in the REAPER actions window
(enable "show action IDs" in the context menu), and find custom action ID strings in reaper-kb.ini.
For built-in mouse modifier behaviors, find action IDs (which will be low numbers)
by modifying an assignment in Preferences/Editing/Mouse Modifiers, then looking in reaper-mouse.ini.
Assigning an action of -1 will reset that mouse modifier behavior to factory default.
See
GetMouseModifier.
| Parameters: |
| context | - |
|
| modifier_flag | - |
|
| action | - |
|
^
SetOnlyTrackSelectedFunctioncall:
C: void SetOnlyTrackSelected(MediaTrack* track)
EEL2: SetOnlyTrackSelected(MediaTrack track)
Lua: reaper.SetOnlyTrackSelected(MediaTrack track)
Python: RPR_SetOnlyTrackSelected(MediaTrack track)
Description:Set exactly one track selected, deselect all others.
This sets the track as Last-Touched-Track as well.
| Parameters: |
| track | - | the MediaTrack to be selected |
^
SetProjectGridFunctioncall:
C: void SetProjectGrid(ReaProject* project, double division)
EEL2: SetProjectGrid(ReaProject project, division)
Lua: reaper.SetProjectGrid(ReaProject project, number division)
Python: RPR_SetProjectGrid(ReaProject project, Float division)
Description:Set the arrange view grid division. 0.25=quarter note, 1.0/3.0=half note triplet, etc.
| Parameters: |
| project | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| division | - |
|
^
SetProjectMarkerFunctioncall:
C: bool SetProjectMarker(int markrgnindexnumber, bool isrgn, double pos, double rgnend, const char* name)
EEL2: bool SetProjectMarker(int markrgnindexnumber, bool isrgn, pos, rgnend, "name")
Lua: boolean = reaper.SetProjectMarker(integer markrgnindexnumber, boolean isrgn, number pos, number rgnend, string name)
Python: Boolean RPR_SetProjectMarker(Int markrgnindexnumber, Boolean isrgn, Float pos, Float rgnend, String name)
Description:Sets/alters an existing project-marker
| Parameters: |
| markrgnindexnumber | - | the shown number of the marker to be altered |
| isrgn | - | true, marker is a region; false, marker is a normal marker |
| pos | - | the position of the new marker in seconds |
| rgnend | - | the end of a region, if isrgn is true |
| name | - | shown name of the marker |
| Returnvalues: |
| boolean | - | true, setting the marker worked; false, setting the marker didn't work |
^
SetProjectMarker2Functioncall:
C: bool SetProjectMarker2(ReaProject* proj, int markrgnindexnumber, bool isrgn, double pos, double rgnend, const char* name)
EEL2: bool SetProjectMarker2(ReaProject proj, int markrgnindexnumber, bool isrgn, pos, rgnend, "name")
Lua: boolean = reaper.SetProjectMarker2(ReaProject proj, integer markrgnindexnumber, boolean isrgn, number pos, number rgnend, string name)
Python: Boolean RPR_SetProjectMarker2(ReaProject proj, Int markrgnindexnumber, Boolean isrgn, Float pos, Float rgnend, String name)
Description:Sets/alters an existing project-marker in a given project.
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| markrgnindexnumber | - | the shown number of the marker to be altered
|
| isrgn | - | true, marker is a region; false, marker is a normal marker
|
| pos | - | the position of the new marker in seconds
|
| rgnend | - | the end of a region, if isrgn is true
|
| name | - | shown name of the marker
|
| Returnvalues: |
| boolean | - | true, setting the marker worked; false, setting the marker didn't work
|
^
SetProjectMarker3Functioncall:
C: bool SetProjectMarker3(ReaProject* proj, int markrgnindexnumber, bool isrgn, double pos, double rgnend, const char* name, int color)
EEL2: bool SetProjectMarker3(ReaProject proj, int markrgnindexnumber, bool isrgn, pos, rgnend, "name", int color)
Lua: boolean = reaper.SetProjectMarker3(ReaProject proj, integer markrgnindexnumber, boolean isrgn, number pos, number rgnend, string name, integer color)
Python: Boolean RPR_SetProjectMarker3(ReaProject proj, Int markrgnindexnumber, Boolean isrgn, Float pos, Float rgnend, String name, Int color)
Description:Sets/alters an existing project-marker in a given project. Differs from SetProjectMarker2 and SetProjectMarker, that you can set color as well.
Color should be 0 to not change, or ColorToNative(r,g,b)|0x1000000
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| markrgnindexnumber | - | the shown number of the marker to be altered
|
| isrgn | - | true, marker is a region; false, marker is a normal marker
|
| pos | - | the position of the new marker in seconds
|
| rgnend | - | the end of a region, if isrgn is true
|
| name | - | shown name of the marker
|
| color | - | the new color-value as native color-value
|
| Returnvalues: |
| boolean | - | true, setting the marker worked; false, setting the marker didn't work
|
^
SetProjectMarker4Functioncall:
C: bool SetProjectMarker4(ReaProject* proj, int markrgnindexnumber, bool isrgn, double pos, double rgnend, const char* name, int color, int flags)
EEL2: bool SetProjectMarker4(ReaProject proj, int markrgnindexnumber, bool isrgn, pos, rgnend, "name", int color, int flags)
Lua: boolean = reaper.SetProjectMarker4(ReaProject proj, integer markrgnindexnumber, boolean isrgn, number pos, number rgnend, string name, integer color, integer flags)
Python: Boolean RPR_SetProjectMarker4(ReaProject proj, Int markrgnindexnumber, Boolean isrgn, Float pos, Float rgnend, String name, Int color, Int flags)
Description:Sets/alters an existing project-marker in a given project.
color should be 0 to not change, or ColorToNative(r,g,b)|0x1000000, flags&1 to clear name
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| markrgnindexnumber | - | the shown number of the marker to be altered
|
| isrgn | - | true, marker is a region; false, marker is a normal marker
|
| pos | - | the position of the new marker in seconds
|
| rgnend | - | the end of a region, if isrgn is true
|
| name | - | shown name of the marker
|
| color | - | the new color-value as native color-value
|
| flags | - | &1 to clear name
|
| Returnvalues: |
| boolean | - | true, setting the marker worked; false, setting the marker didn't work
|
^
SetProjectMarkerByIndexFunctioncall:
C: bool SetProjectMarkerByIndex(ReaProject* proj, int markrgnidx, bool isrgn, double pos, double rgnend, int IDnumber, const char* name, int color)
EEL2: bool SetProjectMarkerByIndex(ReaProject proj, int markrgnidx, bool isrgn, pos, rgnend, int IDnumber, "name", int color)
Lua: boolean = reaper.SetProjectMarkerByIndex(ReaProject proj, integer markrgnidx, boolean isrgn, number pos, number rgnend, integer IDnumber, string name, integer color)
Python: Boolean RPR_SetProjectMarkerByIndex(ReaProject proj, Int markrgnidx, Boolean isrgn, Float pos, Float rgnend, Int IDnumber, String name, Int color)
Description:
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| markrgnidx | - |
|
| isrgn | - |
|
| pos | - |
|
| rgnend | - |
|
| IDnumber | - |
|
| name | - |
|
| color | - |
|
^
SetProjectMarkerByIndex2Functioncall:
C: bool SetProjectMarkerByIndex2(ReaProject* proj, int markrgnidx, bool isrgn, double pos, double rgnend, int IDnumber, const char* name, int color, int flags)
EEL2: bool SetProjectMarkerByIndex2(ReaProject proj, int markrgnidx, bool isrgn, pos, rgnend, int IDnumber, "name", int color, int flags)
Lua: boolean = reaper.SetProjectMarkerByIndex2(ReaProject proj, integer markrgnidx, boolean isrgn, number pos, number rgnend, integer IDnumber, string name, integer color, integer flags)
Python: Boolean RPR_SetProjectMarkerByIndex2(ReaProject proj, Int markrgnidx, Boolean isrgn, Float pos, Float rgnend, Int IDnumber, String name, Int color, Int flags)
Description:Differs from SetProjectMarker4 in that markrgnidx is 0 for the first marker/region, 1 for the next, etc (see
EnumProjectMarkers3), rather than representing the displayed marker/region ID number (see
SetProjectMarker3). Function will fail if attempting to set a duplicate ID number for a region (duplicate ID numbers for markers are OK). , flags&1 to clear name.
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| markrgnidx | - |
|
| isrgn | - |
|
| pos | - |
|
| rgnend | - |
|
| IDnumber | - |
|
| name | - |
|
| color | - |
|
| flags | - |
|
^
SetProjExtStateFunctioncall:
C: int SetProjExtState(ReaProject* proj, const char* extname, const char* key, const char* value)
EEL2: int SetProjExtState(ReaProject proj, "extname", "key", "value")
Lua: integer = reaper.SetProjExtState(ReaProject proj, string extname, string key, string value)
Python: Int RPR_SetProjExtState(ReaProject proj, String extname, String key, String value)
Description:Save a key/value pair for a specific extension, to be restored the next time this specific project is loaded. Typically extname will be the name of a reascript or extension section. If key is NULL or "", all extended data for that extname will be deleted. If val is NULL or "", the data previously associated with that key will be deleted. Returns the size of the state for this extname. See
GetProjExtState,
EnumProjExtState.
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| extname | - | the section, in which the key/value is stored
|
| key | - | the key, that stores the value
|
| value | - | the value, that's stored in the key
|
| Returnvalues: |
| integer | - | the number of key/value-pairs in the extname
|
^
SetRegionRenderMatrixFunctioncall:
C: void SetRegionRenderMatrix(ReaProject* proj, int regionindex, MediaTrack* track, int addorremove)
EEL2: SetRegionRenderMatrix(ReaProject proj, int regionindex, MediaTrack track, int addorremove)
Lua: reaper.SetRegionRenderMatrix(ReaProject proj, integer regionindex, MediaTrack track, integer addorremove)
Python: RPR_SetRegionRenderMatrix(ReaProject proj, Int regionindex, MediaTrack track, Int addorremove)
Description:Add (addorremove > 0) or remove (addorremove > 0) a track from this region when using the region render matrix.
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| regionindex | - |
|
| track | - |
|
| addorremove | - |
|
^
SetTakeMarkerFunctioncall:
C: int index = SetTakeMarker(MediaItem_Take* take, int idx, const char* nameIn, double* srcposInOptional, int* colorInOptional)
EEL2: int index = SetTakeMarker(MediaItem_Take take, int idx, "nameIn", optional srcposIn, optional int colorIn)
Lua: integer index = reaper.SetTakeMarker(MediaItem_Take take, integer idx, string nameIn, optional number srcposIn, optional number colorIn)
Python: (Int index, MediaItem_Take take, Int idx, String nameIn, Float srcposInOptional, Int colorInOptional) = RPR_SetTakeMarker(take, idx, nameIn, srcposInOptional, colorInOptional)
Description:Inserts or updates a take marker. If idx<0, a take marker will be added, otherwise an existing take marker will be updated. Returns the index of the new or updated take marker (which may change if srcPos is updated).
When inserting a new takemarker, parameter srcposIn must be given!
See
GetNumTakeMarkers),
GetTakeMarker and
DeleteTakeMarker.
| Parameters: |
| MediaItem_Take take | - | the take, whose take-marker you want to delete
|
| integer idx | - | the id of the marker within the take, 0 for the first, 1 for the second, etc.
|
| string nameIn | - | the name of the takemarker
|
| optional number srcposIn | - | the position of the takemarker; omit if you want to keep the old position; must be given, when inserting a new takemarker
|
| optional number colorIn | - | the color of the takemarker
|
| Returnvalues: |
| integer index | - |
|
^
SetTakeStretchMarkerFunctioncall:
C: int SetTakeStretchMarker(MediaItem_Take* take, int idx, double pos, const double* srcposInOptional)
EEL2: int SetTakeStretchMarker(MediaItem_Take take, int idx, pos, optional srcposIn)
Lua: integer = reaper.SetTakeStretchMarker(MediaItem_Take take, integer idx, number pos, optional number srcposIn)
Python: Int RPR_SetTakeStretchMarker(MediaItem_Take take, Int idx, Float pos, const double srcposInOptional)
Description:Adds or updates a stretch marker. If idx>0, stretch marker will be added. If idx>=0, stretch marker will be updated. When adding, if srcposInOptional is omitted, source position will be auto-calculated. When updating a stretch marker, if srcposInOptional is omitted, srcpos will not be modified. Position/srcposition values will be constrained to nearby stretch markers. Returns index of stretch marker, or -1 if did not insert (or marker already existed at time).
| Parameters: |
| MediaItem_Take take | - | |
| integer idx | - | |
| number pos | - | |
| optional number srcposIn | - | |
^
SetTakeStretchMarkerSlopeFunctioncall:
C: bool SetTakeStretchMarkerSlope(MediaItem_Take* take, int idx, double slope)
EEL2: bool SetTakeStretchMarkerSlope(MediaItem_Take take, int idx, slope)
Lua: boolean = reaper.SetTakeStretchMarkerSlope(MediaItem_Take take, integer idx, number slope)
Python: Boolean RPR_SetTakeStretchMarkerSlope(MediaItem_Take take, Int idx, Float slope)
Description:
| Parameters: |
| take | - |
|
| idx | - |
|
| slope | - |
|
^
SetTempoTimeSigMarkerFunctioncall:
C: bool SetTempoTimeSigMarker(ReaProject* proj, int ptidx, double timepos, int measurepos, double beatpos, double bpm, int timesig_num, int timesig_denom, bool lineartempo)
EEL2: bool SetTempoTimeSigMarker(ReaProject proj, int ptidx, timepos, int measurepos, beatpos, bpm, int timesig_num, int timesig_denom, bool lineartempo)
Lua: boolean = reaper.SetTempoTimeSigMarker(ReaProject proj, integer ptidx, number timepos, integer measurepos, number beatpos, number bpm, integer timesig_num, integer timesig_denom, boolean lineartempo)
Python: Boolean RPR_SetTempoTimeSigMarker(ReaProject proj, Int ptidx, Float timepos, Int measurepos, Float beatpos, Float bpm, Int timesig_num, Int timesig_denom, Boolean lineartempo)
Description:
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| ptidx | - |
|
| timepos | - |
|
| measurepos | - |
|
| beatpos | - |
|
| bpm | - |
|
| timesig_num | - |
|
| timesig_denom | - |
|
| lineartempo | - |
|
^
SetThemeColorFunctioncall:
C: int SetThemeColor(const char* ini_key, int color, int flagsOptional)
EEL2: int SetThemeColor("ini_key", int color, int flags)
Lua: integer retval = reaper.SetThemeColor(string ini_key, integer color, integer flags)
Python: Int RPR_SetThemeColor(String ini_key, Int color, Int flagsOptional)
Description:Temporarily updates the theme color to the color specified (or the theme default color if -1 is specified). Returns -1 on failure, otherwise returns the color (or transformed-color). Note that the UI is not updated by this, the caller should call
UpdateArrange() etc as necessary. If the low bit of flags is set, any color transformations are bypassed. To read a value see
GetThemeColor.
* col_main_bg2 : Main window/transport background
* col_main_text2 : Main window/transport text
* col_main_textshadow : Main window text shadow (ignored if too close to text color)
* col_main_3dhl : Main window 3D highlight
* col_main_3dsh : Main window 3D shadow
* col_main_resize2 : Main window pane resize mouseover
* col_main_text : Window text
* col_main_bg : Window background
* col_main_editbk : Window edit background
* col_transport_editbk : Transport edit background
* col_toolbar_text : Toolbar button text
* col_toolbar_text_on : Toolbar button enabled text
* col_toolbar_frame : Toolbar frame when floating or docked
* toolbararmed_color : Toolbar button armed color
* toolbararmed_drawmode : Toolbar button armed fill mode
* io_text : I/O window text
* io_3dhl : I/O window 3D highlight
* io_3dsh : I/O window 3D shadow
* genlist_bg : Window list background
* genlist_fg : Window list text
* genlist_grid : Window list grid lines
* genlist_selbg : Window list selected row
* genlist_selfg : Window list selected text
* genlist_seliabg : Window list selected row (inactive)
* genlist_seliafg : Window list selected text (inactive)
* genlist_hilite : Window list highlighted text
* genlist_hilite_sel : Window list highlighted selected text
* col_buttonbg : Button background
* col_tcp_text : Track panel text
* col_tcp_textsel : Track panel (selected) text
* col_seltrack : Selected track control panel background
* col_seltrack2 : Unselected track control panel background (enabled with a checkbox above)
* tcplocked_color : Locked track control panel overlay color
* tcplocked_drawmode : Locked track control panel fill mode
* col_tracklistbg : Empty track list area
* col_mixerbg : Empty mixer list area
* col_arrangebg : Empty arrange view area
* arrange_vgrid : Empty arrange view area vertical grid shading
* col_fadearm : Fader background when automation recording
* col_fadearm2 : Fader background when automation playing
* col_fadearm3 : Fader background when in inactive touch/latch
* col_tl_fg : Timeline foreground
* col_tl_fg2 : Timeline foreground (secondary markings)
* col_tl_bg : Timeline background
* col_tl_bgsel : Time selection color
* timesel_drawmode : Time selection fill mode
* col_tl_bgsel2 : Timeline background (in loop points)
* col_trans_bg : Transport status background
* col_trans_fg : Transport status text
* playrate_edited : Project play rate control when not 1.0
* col_mi_label : Media item label
* col_mi_label_sel : Media item label (selected)
* col_mi_label_float : Floating media item label
* col_mi_label_float_sel : Floating media item label (selected)
* col_mi_bg : Media item background (odd tracks)
* col_mi_bg2 : Media item background (even tracks)
* col_tr1_itembgsel : Media item background selected (odd tracks)
* col_tr2_itembgsel : Media item background selected (even tracks)
* itembg_drawmode : Media item background fill mode
* col_tr1_peaks : Media item peaks (odd tracks)
* col_tr2_peaks : Media item peaks (even tracks)
* col_tr1_ps2 : Media item peaks when selected (odd tracks)
* col_tr2_ps2 : Media item peaks when selected (even tracks)
* col_peaksedge : Media item peaks edge highlight (odd tracks)
* col_peaksedge2 : Media item peaks edge highlight (even tracks)
* col_peaksedgesel : Media item peaks edge highlight when selected (odd tracks)
* col_peaksedgesel2 : Media item peaks edge highlight when selected (even tracks)
* cc_chase_drawmode : Media item MIDI CC peaks fill mode
* col_peaksfade : Media item peaks when active in crossfade editor (fade-out)
* col_peaksfade2 : Media item peaks when active in crossfade editor (fade-in)
* col_mi_fades : Media item fade/volume controls
* fadezone_color : Media item fade quiet zone fill color
* fadezone_drawmode : Media item fade quiet zone fill mode
* fadearea_color : Media item fade full area fill color
* fadearea_drawmode : Media item fade full area fill mode
* col_mi_fade2 : Media item edges of controls
* col_mi_fade2_drawmode : Media item edges of controls blend mode
* item_grouphl : Media item edge when selected via grouping
* col_offlinetext : Media item "offline" text
* col_stretchmarker : Media item stretch marker line
* col_stretchmarker_h0 : Media item stretch marker handle (1x)
* col_stretchmarker_h1 : Media item stretch marker handle (>1x)
* col_stretchmarker_h2 : Media item stretch marker handle (<1x)
* col_stretchmarker_b : Media item stretch marker handle edge
* col_stretchmarkerm : Media item stretch marker blend mode
* col_stretchmarker_text : Media item stretch marker text
* col_stretchmarker_tm : Media item transient guide handle
* take_marker : Media item take marker
* selitem_tag : Selected media item bar color
* activetake_tag : Active media item take bar color
* col_tr1_bg : Track background (odd tracks)
* col_tr2_bg : Track background (even tracks)
* selcol_tr1_bg : Selected track background (odd tracks)
* selcol_tr2_bg : Selected track background (even tracks)
* col_tr1_divline : Track divider line (odd tracks)
* col_tr2_divline : Track divider line (even tracks)
* col_envlane1_divline : Envelope lane divider line (odd tracks)
* col_envlane2_divline : Envelope lane divider line (even tracks)
* marquee_fill : Marquee fill
* marquee_drawmode : Marquee fill mode
* marquee_outline : Marquee outline
* marqueezoom_fill : Marquee zoom fill
* marqueezoom_drawmode : Marquee zoom fill mode
* marqueezoom_outline : Marquee zoom outline
* areasel_fill : Razor edit area fill
* areasel_drawmode : Razor edit area fill mode
* areasel_outline : Razor edit area outline
* areasel_outlinemode : Razor edit area outline mode
* col_cursor : Edit cursor
* col_cursor2 : Edit cursor (alternate)
* playcursor_color : Play cursor
* playcursor_drawmode : Play cursor fill mode
* col_gridlines2 : Grid lines (start of measure)
* col_gridlines2dm : Grid lines (start of measure) - draw mode
* col_gridlines3 : Grid lines (start of beats)
* col_gridlines3dm : Grid lines (start of beats) - draw mode
* col_gridlines : Grid lines (in between beats)
* col_gridlines1dm : Grid lines (in between beats) - draw mode
* guideline_color : Editing guide line color
* guideline_drawmode : Editing guide fill mode
* region : Regions
* region_lane_bg : Region lane background
* region_lane_text : Region lane text
* marker : Markers
* marker_lane_bg : Marker lane background
* marker_lane_text : Marker lane text
* col_tsigmark : Time signature change marker
* ts_lane_bg : Time signature lane background
* ts_lane_text : Time signature lane text
* timesig_sel_bg : Time signature marker selected background
* col_routinghl1 : Routing matrix row highlight
* col_routinghl2 : Routing matrix column highlight
* col_vudoint : Theme has interlaced VU meters
* col_vuclip : VU meter clip indicator
* col_vutop : VU meter top
* col_vumid : VU meter middle
* col_vubot : VU meter bottom
* col_vuintcol : VU meter interlace/edge color
* col_vumidi : VU meter midi activity
* col_vuind1 : VU (indicator) - no signal
* col_vuind2 : VU (indicator) - low signal
* col_vuind3 : VU (indicator) - med signal
* col_vuind4 : VU (indicator) - hot signal
* mcp_sends_normal : Sends text: normal
* mcp_sends_muted : Sends text: muted
* mcp_send_midihw : Sends text: MIDI hardware
* mcp_sends_levels : Sends level
* mcp_fx_normal : FX insert text: normal
* mcp_fx_bypassed : FX insert text: bypassed
* mcp_fx_offlined : FX insert text: offline
* mcp_fxparm_normal : FX parameter text: normal
* mcp_fxparm_bypassed : FX parameter text: bypassed
* mcp_fxparm_offlined : FX parameter text: offline
* tcp_list_scrollbar : List scrollbar (track panel)
* tcp_list_scrollbar_mode : List scrollbar (track panel) - draw mode
* tcp_list_scrollbar_mouseover : List scrollbar mouseover (track panel)
* tcp_list_scrollbar_mouseover_mode : List scrollbar mouseover (track panel) - draw mode
* mcp_list_scrollbar : List scrollbar (mixer panel)
* mcp_list_scrollbar_mode : List scrollbar (mixer panel) - draw mode
* mcp_list_scrollbar_mouseover : List scrollbar mouseover (mixer panel)
* mcp_list_scrollbar_mouseover_mode : List scrollbar mouseover (mixer panel) - draw mode
* midi_rulerbg : MIDI editor ruler background
* midi_rulerfg : MIDI editor ruler text
* midi_grid2 : MIDI editor grid line (start of measure)
* midi_griddm2 : MIDI editor grid line (start of measure) - draw mode
* midi_grid3 : MIDI editor grid line (start of beats)
* midi_griddm3 : MIDI editor grid line (start of beats) - draw mode
* midi_grid1 : MIDI editor grid line (between beats)
* midi_griddm1 : MIDI editor grid line (between beats) - draw mode
* midi_trackbg1 : MIDI editor background color (naturals)
* midi_trackbg2 : MIDI editor background color (sharps/flats)
* midi_trackbg_outer1 : MIDI editor background color, out of bounds (naturals)
* midi_trackbg_outer2 : MIDI editor background color, out of bounds (sharps/flats)
* midi_selpitch1 : MIDI editor background color, selected pitch (naturals)
* midi_selpitch2 : MIDI editor background color, selected pitch (sharps/flats)
* midi_selbg : MIDI editor time selection color
* midi_selbg_drawmode : MIDI editor time selection fill mode
* midi_gridhc : MIDI editor CC horizontal center line
* midi_gridhcdm : MIDI editor CC horizontal center line - draw mode
* midi_gridh : MIDI editor CC horizontal line
* midi_gridhdm : MIDI editor CC horizontal line - draw mode
* midi_ccbut : MIDI editor CC lane add/remove buttons
* midi_ccbut_text : MIDI editor CC lane button text
* midi_ccbut_arrow : MIDI editor CC lane button arrow
* midioct : MIDI editor octave line color
* midi_inline_trackbg1 : MIDI inline background color (naturals)
* midi_inline_trackbg2 : MIDI inline background color (sharps/flats)
* midioct_inline : MIDI inline octave line color
* midi_endpt : MIDI editor end marker
* midi_notebg : MIDI editor note, unselected (midi_note_colormap overrides)
* midi_notefg : MIDI editor note, selected (midi_note_colormap overrides)
* midi_notemute : MIDI editor note, muted, unselected (midi_note_colormap overrides)
* midi_notemute_sel : MIDI editor note, muted, selected (midi_note_colormap overrides)
* midi_itemctl : MIDI editor note controls
* midi_ofsn : MIDI editor note (offscreen)
* midi_ofsnsel : MIDI editor note (offscreen, selected)
* midi_editcurs : MIDI editor cursor
* midi_pkey1 : MIDI piano key color (naturals background, sharps/flats text)
* midi_pkey2 : MIDI piano key color (sharps/flats background, naturals text)
* midi_pkey3 : MIDI piano key color (selected)
* midi_noteon_flash : MIDI piano key note-on flash
* midi_leftbg : MIDI piano pane background
* midifont_col_light_unsel : MIDI editor note text and control color, unselected (light)
* midifont_col_dark_unsel : MIDI editor note text and control color, unselected (dark)
* midifont_mode_unsel : MIDI editor note text and control mode, unselected
* midifont_col_light : MIDI editor note text and control color (light)
* midifont_col_dark : MIDI editor note text and control color (dark)
* midifont_mode : MIDI editor note text and control mode
* score_bg : MIDI notation editor background
* score_fg : MIDI notation editor staff/notation/text
* score_sel : MIDI notation editor selected staff/notation/text
* score_timesel : MIDI notation editor time selection
* score_loop : MIDI notation editor loop points, selected pitch
* midieditorlist_bg : MIDI list editor background
* midieditorlist_fg : MIDI list editor text
* midieditorlist_grid : MIDI list editor grid lines
* midieditorlist_selbg : MIDI list editor selected row
* midieditorlist_selfg : MIDI list editor selected text
* midieditorlist_seliabg : MIDI list editor selected row (inactive)
* midieditorlist_seliafg : MIDI list editor selected text (inactive)
* midieditorlist_bg2 : MIDI list editor background (secondary)
* midieditorlist_fg2 : MIDI list editor text (secondary)
* midieditorlist_selbg2 : MIDI list editor selected row (secondary)
* midieditorlist_selfg2 : MIDI list editor selected text (secondary)
* col_explorer_sel : Media explorer selection
* col_explorer_seldm : Media explorer selection mode
* col_explorer_seledge : Media explorer selection edge
* docker_shadow : Tab control shadow
* docker_selface : Tab control selected tab
* docker_unselface : Tab control unselected tab
* docker_text : Tab control text
* docker_text_sel : Tab control text selected tab
* docker_bg : Tab control background
* windowtab_bg : Tab control background in windows
* auto_item_unsel : Envelope: Unselected automation item
* col_env1 : Envelope: Volume (pre-FX)
* col_env2 : Envelope: Volume
* env_trim_vol : Envelope: Trim Volume
* col_env3 : Envelope: Pan (pre-FX)
* col_env4 : Envelope: Pan
* env_track_mute : Envelope: Mute
* col_env5 : Envelope: Master playrate
* col_env6 : Envelope: Master tempo
* col_env7 : Envelope: Send volume
* col_env8 : Envelope: Send pan
* col_env9 : Envelope: Send volume 2
* col_env10 : Envelope: Send pan 2
* env_sends_mute : Envelope: Send mute
* col_env11 : Envelope: Audio hardware output volume
* col_env12 : Envelope: Audio hardware output pan
* col_env13 : Envelope: FX parameter 1
* col_env14 : Envelope: FX parameter 2
* col_env15 : Envelope: FX parameter 3
* col_env16 : Envelope: FX parameter 4
* env_item_vol : Envelope: Item take volume
* env_item_pan : Envelope: Item take pan
* env_item_mute : Envelope: Item take mute
* env_item_pitch : Envelope: Item take pitch
* wiring_grid2 : Wiring: Background
* wiring_grid : Wiring: Background grid lines
* wiring_border : Wiring: Box border
* wiring_tbg : Wiring: Box background
* wiring_ticon : Wiring: Box foreground
* wiring_recbg : Wiring: Record section background
* wiring_recitem : Wiring: Record section foreground
* wiring_media : Wiring: Media
* wiring_recv : Wiring: Receives
* wiring_send : Wiring: Sends
* wiring_fader : Wiring: Fader
* wiring_parent : Wiring: Master/Parent
* wiring_parentwire_border : Wiring: Master/Parent wire border
* wiring_parentwire_master : Wiring: Master/Parent to master wire
* wiring_parentwire_folder : Wiring: Master/Parent to parent folder wire
* wiring_pin_normal : Wiring: Pins normal
* wiring_pin_connected : Wiring: Pins connected
* wiring_pin_disconnected : Wiring: Pins disconnected
* wiring_horz_col : Wiring: Horizontal pin connections
* wiring_sendwire : Wiring: Send hanging wire
* wiring_hwoutwire : Wiring: Hardware output wire
* wiring_recinputwire : Wiring: Record input wire
* wiring_hwout : Wiring: System hardware outputs
* wiring_recinput : Wiring: System record inputs
* group_0 : Group #1
* group_1 : Group #2
* group_2 : Group #3
* group_3 : Group #4
* group_4 : Group #5
* group_5 : Group #6
* group_6 : Group #7
* group_7 : Group #8
* group_8 : Group #9
* group_9 : Group #10
* group_10 : Group #11
* group_11 : Group #12
* group_12 : Group #13
* group_13 : Group #14
* group_14 : Group #15
* group_15 : Group #16
* group_16 : Group #17
* group_17 : Group #18
* group_18 : Group #19
* group_19 : Group #20
* group_20 : Group #21
* group_21 : Group #22
* group_22 : Group #23
* group_23 : Group #24
* group_24 : Group #25
* group_25 : Group #26
* group_26 : Group #27
* group_27 : Group #28
* group_28 : Group #29
* group_29 : Group #30
* group_30 : Group #31
* group_31 : Group #32
* group_32 : Group #33
* group_33 : Group #34
* group_34 : Group #35
* group_35 : Group #36
* group_36 : Group #37
* group_37 : Group #38
* group_38 : Group #39
* group_39 : Group #40
* group_40 : Group #41
* group_41 : Group #42
* group_42 : Group #43
* group_43 : Group #44
* group_44 : Group #45
* group_45 : Group #46
* group_46 : Group #47
* group_47 : Group #48
* group_48 : Group #49
* group_49 : Group #50
* group_50 : Group #51
* group_51 : Group #52
* group_52 : Group #53
* group_53 : Group #54
* group_54 : Group #55
* group_55 : Group #56
* group_56 : Group #57
* group_57 : Group #58
* group_58 : Group #59
* group_59 : Group #60
* group_60 : Group #61
* group_61 : Group #62
* group_62 : Group #63
* group_63 : Group #64
| Parameters: |
| string ini_key | - |
|
| integer color | - |
|
| integer flags | - |
|
| Returnvalues: |
| integer retval | - |
|
^
SetToggleCommandStateFunctioncall:
C: bool SetToggleCommandState(int section_id, int command_id, int state)
EEL2: bool SetToggleCommandState(int section_id, int command_id, int state)
Lua: boolean = reaper.SetToggleCommandState(integer section_id, integer command_id, integer state)
Python: Boolean RPR_SetToggleCommandState(Int section_id, Int command_id, Int state)
Description:Updates the toggle state of an action, returns true if succeeded. Only ReaScripts can have their toggle states changed programmatically. See
RefreshToolbar2.
| Parameters: |
| section_id | - | the section of the action 0, Main 100, Main (alt recording) 32060, MIDI Editor 32061, MIDI Event List Editor 32062, MIDI Inline Editor 32063, Media Explorer
|
| integer command_id | - | the command-id of the action whose toggle command state you want to query
|
| integer state | - | toggle-state 0, off &1, on/checked in menus &2, on/grayed out in menus &16, on/bullet in front of the entry in menus -1, NA because the action does not have on/off states.
|
| Returnvalues: |
| boolean | - | true, setting was successful; false, setting was unsuccessful
|
^
SetTrackAutomationModeFunctioncall:
C: void SetTrackAutomationMode(MediaTrack* tr, int mode)
EEL2: SetTrackAutomationMode(MediaTrack tr, int mode)
Lua: reaper.SetTrackAutomationMode(MediaTrack tr, integer mode)
Python: RPR_SetTrackAutomationMode(MediaTrack tr, Int mode)
Description:Set automation-mode for a specific MediaTrack.
| Parameters: |
| tr | - | the MediaTrack, whose automation-mode you want to set |
| mode | - | the automation-mode 0, Trim/read 1, Read 2, Touch 3, Write 4, Latch 5 and higher no mode selected |
^
SetTrackColorFunctioncall:
C: void SetTrackColor(MediaTrack* track, int color)
EEL2: SetTrackColor(MediaTrack track, int color)
Lua: reaper.SetTrackColor(MediaTrack track, integer color)
Python: RPR_SetTrackColor(MediaTrack track, Int color)
Description:
| Parameters: |
| track | - | the MediaTrack, whose color you want to change
|
| color | - | the new color-value
|
^
SetTrackMIDILyricsFunctioncall:
C: bool SetTrackMIDILyrics(MediaTrack* track, int flag, const char* str)
EEL2: bool SetTrackMIDILyrics(MediaTrack track, int flag, "str")
Lua: boolean = reaper.SetTrackMIDILyrics(MediaTrack track, integer flag, string str)
Python: Boolean RPR_SetTrackMIDILyrics(MediaTrack track, Int flag, String str)
Description:Set all MIDI lyrics on the track. Lyrics will be stuffed into any MIDI items found in range. Flag is unused at present. str is passed in as beat position, tab, text, tab (example with flag=2: "1.1.2\tLyric for measure 1 beat 2\t.1.1\tLyric for measure 2 beat 1 "). See
GetTrackMIDILyrics
| Parameters: |
| track | - |
|
| flag | - |
|
| str | - |
|
^
SetTrackMIDINoteNameFunctioncall:
C: bool SetTrackMIDINoteName(int track, int pitch, int chan, const char* name)
EEL2: bool SetTrackMIDINoteName(int track, int pitch, int chan, "name")
Lua: boolean = reaper.SetTrackMIDINoteName(integer track, integer pitch, integer chan, string name)
Python: Boolean RPR_SetTrackMIDINoteName(Int track, Int pitch, Int chan, String name)
Description:channel > 0 assigns these note names to all channels.
| Parameters: |
| track | - | |
| pitch | - | |
| chan | - | |
| name | - | |
^
SetTrackMIDINoteNameExFunctioncall:
C: bool SetTrackMIDINoteNameEx(ReaProject* proj, MediaTrack* track, int pitch, int chan, const char* name)
EEL2: bool SetTrackMIDINoteNameEx(ReaProject proj, MediaTrack track, int pitch, int chan, "name")
Lua: boolean = reaper.SetTrackMIDINoteNameEx(ReaProject proj, MediaTrack track, integer pitch, integer chan, string name)
Python: Boolean RPR_SetTrackMIDINoteNameEx(ReaProject proj, MediaTrack track, Int pitch, Int chan, String name)
Description:channel > 0 assigns note name to all channels. pitch 128 assigns name for CC0, pitch 129 for CC1, etc.
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| track | - |
|
| pitch | - |
|
| chan | - |
|
| name | - |
|
^
SetTrackSelectedFunctioncall:
C: void SetTrackSelected(MediaTrack* track, bool selected)
EEL2: SetTrackSelected(MediaTrack track, bool selected)
Lua: reaper.SetTrackSelected(MediaTrack track, boolean selected)
Python: RPR_SetTrackSelected(MediaTrack track, Boolean selected)
Description:Set a MediaTrack selected/deselected. Will retain already existing selection, so you can set multiple tracks selected that way.
Will not affect Last-Touched-Track.
| Parameters: |
| track | - | the MediaTrack, whose selection state you want to set |
| selected | - | true, set MediaTrack to selected; false, set MediaTrack to deselected |
^
SetTrackSendInfo_ValueFunctioncall:
C: bool SetTrackSendInfo_Value(MediaTrack* tr, int category, int sendidx, const char* parmname, double newvalue)
EEL2: bool SetTrackSendInfo_Value(MediaTrack tr, int category, int sendidx, "parmname", newvalue)
Lua: boolean = reaper.SetTrackSendInfo_Value(MediaTrack tr, integer category, integer sendidx, string parmname, number newvalue)
Python: Boolean RPR_SetTrackSendInfo_Value(MediaTrack tr, Int category, Int sendidx, String parmname, Float newvalue)
Description:Set send/receive/hardware output numerical-value attributes, return true on success.
category is <0 for receives, 0=sends, >0 for hardware outputs
parameter names:
B_MUTE : bool *
B_PHASE : bool *, true to flip phase
B_MONO : bool *
D_VOL : double *, 1.0 = +0dB etc
D_PAN : double *, -1..+1
D_PANLAW : double *,1.0=+0.0db, 0.5=-6dB, -1.0 = projdef etc
I_SENDMODE : int *, 0=post-fader, 1=pre-fx, 2=post-fx (deprecated), 3=post-fx
I_AUTOMODE : int * : automation mode (-1=use track automode, 0=trim/off, 1=read, 2=touch, 3=write, 4=latch)
I_SRCCHAN : int *, index,&1024=mono, -1 for none
I_DSTCHAN : int *, index, &1024=mono, otherwise stereo pair, hwout:&512=rearoute
I_MIDIFLAGS : int *, low 5 bits=source channel 0=all, 1-16, next 5 bits=dest channel, 0=orig, 1-16=chanSee
CreateTrackSend,
RemoveTrackSend,
GetTrackNumSends.
For ReaRoute-users: the outputs are hardware outputs, but with 512 added to the destination channel index (512 is the first rearoute channel, 513 the second, etc).
See
CreateTrackSend,
RemoveTrackSend,
GetTrackNumSends.
| Parameters: |
| tr | - |
|
| category | - |
|
| sendidx | - |
|
| parmname | - |
|
| newvalue | - |
|
^
SetTrackSendUIPanFunctioncall:
C: bool SetTrackSendUIPan(MediaTrack* track, int send_idx, double pan, int isend)
EEL2: bool SetTrackSendUIPan(MediaTrack track, int send_idx, pan, int isend)
Lua: boolean = reaper.SetTrackSendUIPan(MediaTrack track, integer send_idx, number pan, integer isend)
Python: Boolean RPR_SetTrackSendUIPan(MediaTrack track, Int send_idx, Float pan, Int isend)
Description:send_idx<0 for receives, >=0 for hw ouputs, >=nb_of_hw_ouputs for sends. isend=1 for end of edit, -1 for an instant edit (such as reset), 0 for normal tweak.
| Parameters: |
| track | - | |
| send_idx | - | |
| pan | - | |
| isend | - | |
^
SetTrackSendUIVolFunctioncall:
C: bool SetTrackSendUIVol(MediaTrack* track, int send_idx, double vol, int isend)
EEL2: bool SetTrackSendUIVol(MediaTrack track, int send_idx, vol, int isend)
Lua: boolean = reaper.SetTrackSendUIVol(MediaTrack track, integer send_idx, number vol, integer isend)
Python: Boolean RPR_SetTrackSendUIVol(MediaTrack track, Int send_idx, Float vol, Int isend)
Description:send_idx<0 for receives, >=0 for hw ouputs, >=nb_of_hw_ouputs for sends. isend=1 for end of edit, -1 for an instant edit (such as reset), 0 for normal tweak.
| Parameters: |
| track | - | |
| send_idx | - | |
| vol | - | |
| isend | - | |
^
SetTrackStateChunkFunctioncall:
C: bool SetTrackStateChunk(MediaTrack* track, const char* str, bool isundoOptional)
EEL2: bool SetTrackStateChunk(MediaTrack track, "str", bool isundo)
Lua: boolean = reaper.SetTrackStateChunk(MediaTrack track, string str, boolean isundo)
Python: Boolean RPR_SetTrackStateChunk(MediaTrack track, String str, Boolean isundoOptional)
Description:Sets the RPPXML state of a track, returns true if successful. Undo flag is a performance/caching hint.
| Parameters: |
| track | - | the MediaTrack, whose statechunk you want to set |
| str | - | the new trackstatechunk, you want to set this MediaTrack to |
| isundo | - | undo flag is a performance/caching hint |
| Returnvalues: |
| boolean | - | true, setting worked; false, setting didn't work |
^
ShowPopupMenuFunctioncall:
C: void ShowPopupMenu(const char* name, int x, int y, HWND hwndParentOptional, void* ctxOptional, int ctx2Optional, int ctx3Optional)
EEL2: ShowPopupMenu("name", int x, int y, HWND hwndParent, void* ctx, int ctx2, int ctx3)
Lua: reaper.ShowPopupMenu(string name, integer x, integer y, optional HWND hwndParent, identifier ctx, integer ctx2, integer ctx3)
Python: RPR_ShowPopupMenu(String name, Int x, Int y, HWND hwndParentOptional, void ctxOptional, Int ctx2Optional, Int ctx3Optional)
Description:shows a Reaper-context menu.
You can decide, which menu to show and to which track/item/envelope/envelope-point/automation-item you want this context-menu to be applied to.
e.g. you can decide, whether settings in the context-menu "track_panel" shall be applied to track 1, track 2, etc
You can also apply this to the selected track/mediaitem/envelope.
The parameters name and ctx influence each other, means: name="item" and ctx=reaper.GetMediaItem(0,1) apply the mediaitem-contextmenu to the Mediaitem-object, given to parameter ctx.
The choice of the parameter name also influences, whether ctxOptional and ctx2Optional can be set or not and what they mean.
Blocks further execution of a script, until the context-menu is closed.
| Parameters: |
| string name | - | the name of the context-menu to show can be track_input, track_panel, track_area, track_routing, item, ruler, envelope, envelope_point, envelope_item |
| integer x | - | x-position of the contextmenu-display-position in pixels |
| integer y | - | y-position of the contextmenu-display-position in pixels |
| optional HWND hwndParent | - | the HWND-window in which to display the context-menu. nil, Reaper's main window will be used as HWND |
| optional identifier ctx | - | the object for which to apply the contextmenu. Options selected in the context-menu will be applied to this track/item; nil, use the selected track(s)/item(s)/envelope, depending on the chosen context-menu-name in parameter name; shows no context-menu, when no track/item/envelope is selected; possible objects and their corresponding name-parameter: - MediaTrack(track_input, track_panel, track_routing) - MediaItem(item) - TrackEnvelope(also Take-Envelopes!) (envelope, envelope_point) when using any other context-menu-name, this parameter will be ignored by Reaper. |
| optional ctxOptional | - | when ctx is a TrackEnvelope(or nil) and menu="envelope_point", this is the idx of the envelope-point to which to apply the context-menu when ctx is a TrackEnvelope(or nil) and menu="envelope_item", this reflects the automation-item in chosen envelope, to which to apply the context-menu(1 or higher for automation-item 1 or higher) |
| optional ctx2Optional | - | when ctx is a TrackEnvelope(or nil) and menu="envelope_point", this reflects, 0, whether to apply the context-menu to the point in the envelope-lane or 1 or higher, whether to apply the context-menu to the point in automation-item 1 or higher; nil, assumes 0(envelope-lane) |
^
ShowActionListFunctioncall:
C: void ShowActionList(KbdSectionInfo* caller, HWND callerWnd)
EEL2: ShowActionList(KbdSectionInfo caller, HWND callerWnd)
Lua: reaper.ShowActionList(KbdSectionInfo caller, optional HWND callerWnd)
Python: RPR_ShowActionList(KbdSectionInfo caller, HWND callerWnd)
Description:
| Parameters: |
| caller | - | |
| optional HWND callerWnd | - | the HWND that shall call the ActionList; can be nil |
^
ShowConsoleMsgFunctioncall:
C: void ShowConsoleMsg(const char* msg)
EEL2: ShowConsoleMsg("msg")
Lua: reaper.ShowConsoleMsg(string msg)
Python: RPR_ShowConsoleMsg(String msg)
Description:Show a message to the user (also useful for debugging). Send "\n" for newline, "" to clear the console. See
ClearConsole
| Parameters: |
| msg | - | a message to be shown in ReaConsole
|
^
ShowMessageBoxFunctioncall:
C: int ShowMessageBox(const char* msg, const char* title, int type)
EEL2: int ShowMessageBox("msg", "title", int type)
Lua: integer = reaper.ShowMessageBox(string msg, string title, integer type)
Python: Int RPR_ShowMessageBox(String msg, String title, Int type)
Description:Shows Messagebox with user-clickable buttons.
| Parameters: |
| msg | - | the message, that shall be shown in messagebox |
| title | - | the title of the messagebox |
| type | - | which buttons shall be shown in the messagebox 0, OK 1, OK CANCEL 2, ABORT RETRY IGNORE 3, YES NO CANCEL 4, YES NO 5, RETRY CANCEL |
| Returnvalues: |
| integer | - | the button pressed by the user
1, OK
2, CANCEL
3, ABORT
4, RETRY
5, IGNORE
6, YES
7, NO |
^
SLIDER2DBFunctioncall:
C: double SLIDER2DB(double y)
EEL2: double SLIDER2DB(y)
Lua: number = reaper.SLIDER2DB(number y)
Python: Float RPR_SLIDER2DB(Float y)
Description:Convert slider-value to it's dB-value-equivalent.
| Parameters: |
| y | - | the dB-value |
| Returnvalues: |
| number | - | the slider-value, you want to convert to dB |
^
SnapToGridFunctioncall:
C: double SnapToGrid(ReaProject* project, double time_pos)
EEL2: double SnapToGrid(ReaProject project, time_pos)
Lua: number = reaper.SnapToGrid(ReaProject project, number time_pos)
Python: Float RPR_SnapToGrid(ReaProject project, Float time_pos)
Description:
| Parameters: |
| project | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| time_pos | - |
|
^
SoloAllTracksFunctioncall:
C: void SoloAllTracks(int solo)
EEL2: SoloAllTracks(int solo)
Lua: reaper.SoloAllTracks(integer solo)
Python: RPR_SoloAllTracks(Int solo)
Description:Set solo-state for all tracks.
| Parameters: |
| solo | - | the new solo state for all tracks 0, solo off 1, solo, ignore routing 2, solo in place |
^
Splash_GetWndFunctioncall:
C: HWND Splash_GetWnd()
EEL2: HWND Splash_GetWnd()
Lua: HWND = reaper.Splash_GetWnd()
Python: HWND RPR_Splash_GetWnd()
Description:gets the splash window, in case you want to display a message over it. Returns NULL when the sphah window is not displayed.
^
SplitMediaItemFunctioncall:
C: MediaItem* SplitMediaItem(MediaItem* item, double position)
EEL2: MediaItem SplitMediaItem(MediaItem item, position)
Lua: MediaItem = reaper.SplitMediaItem(MediaItem item, number position)
Python: MediaItem RPR_SplitMediaItem(MediaItem item, Float position)
Description:The original item becomes the left-hand split, the function returns the right-hand split (or NULL if the split failed)
| Parameters: |
| item | - | the MediaItem so be split |
| position | - | the split-position in seconds |
| Returnvalues: |
| MediaItem | - | the new MediaItem on the right side of the split |
^
stringToGuidFunctioncall:
C: void stringToGuid(const char* str, GUID* g)
EEL2: stringToGuid("str", #gGUID)
Lua: string gGUID = reaper.stringToGuid(string str, string gGUID)
Python: RPR_stringToGuid(String str, GUID g)
Description:
| Parameters: |
| string str | - | |
| string gGUID | - | |
^
StuffMIDIMessageFunctioncall:
C: void StuffMIDIMessage(int mode, int msg1, int msg2, int msg3)
EEL2: StuffMIDIMessage(int mode, int msg1, int msg2, int msg3)
Lua: reaper.StuffMIDIMessage(integer mode, integer msg1, integer msg2, integer msg3)
Python: RPR_StuffMIDIMessage(Int mode, Int msg1, Int msg2, Int msg3)
Description:Stuffs a 3 byte MIDI message into either the Virtual MIDI Keyboard queue, or the MIDI-as-control input queue, or sends to a MIDI hardware output. mode=0 for VKB, 1 for control (actions map etc), 2 for VKB-on-current-channel; 16 for external MIDI device 0, 17 for external MIDI device 1, etc; see
GetNumMIDIOutputs,
GetMIDIOutputName.
if mode is set to 1, you can send messages as control-message for Parameter LEarn/Modulation and as shortcut for scripts.
The parameter msg3 can be retrieved with the returnvalue val of the function reaper.get_action_context, so sending values to a script is possible that way.
For more detailed information about the possible midi-messages you can send via StuffMIDIMessage, see:
StuffMIDIMessage-docs
| Parameters: |
| mode | - |
|
| msg1 | - | modifier
|
| msg2 | - | note/keyname
|
| msg3 | - | velocity
|
^
TakeFX_AddByNameFunctioncall:
C: int TakeFX_AddByName(MediaItem_Take* take, const char* fxname, int instantiate)
EEL2: int TakeFX_AddByName(MediaItem_Take take, "fxname", int instantiate)
Lua: integer = reaper.TakeFX_AddByName(MediaItem_Take take, string fxname, integer instantiate)
Python: Int RPR_TakeFX_AddByName(MediaItem_Take take, String fxname, Int instantiate)
Description:Adds or queries the position of a named FX in a take. See
TrackFX_AddByName() for information on fxname and instantiate.
| Parameters: |
| take | - |
|
| fxname | - |
|
| instantiate | - |
|
^
TakeFX_EndParamEditFunctioncall:
C: bool TakeFX_EndParamEdit(MediaItem_Take* take, int fx, int param)
EEL2: bool TakeFX_EndParamEdit(MediaItem_Take take, int fx, int param)
Lua: boolean = reaper.TakeFX_EndParamEdit(MediaItem_Take take, integer fx, integer param)
Python: Boolean RPR_TakeFX_EndParamEdit(MediaItem_Take take, Int fx, Int param)
Description:
| Parameters: |
| take | - | |
| fx | - | |
| param | - | |
^
TakeFX_FormatParamValueFunctioncall:
C: bool TakeFX_FormatParamValue(MediaItem_Take* take, int fx, int param, double val, char* buf, int buf_sz)
EEL2: bool TakeFX_FormatParamValue(MediaItem_Take take, int fx, int param, val, #buf)
Lua: boolean retval, string buf = reaper.TakeFX_FormatParamValue(MediaItem_Take take, integer fx, integer param, number val, string buf)
Python: (Boolean retval, MediaItem_Take take, Int fx, Int param, Float val, String buf, Int buf_sz) = RPR_TakeFX_FormatParamValue(take, fx, param, val, buf, buf_sz)
Description:Note: only works with FX that support Cockos VST extensions.
| Parameters: |
| take | - | |
| fx | - | |
| param | - | |
| val | - | |
| string buf | - | |
| Returnvalues: |
| retval | - | |
| buf | - | |
^
TakeFX_FormatParamValueNormalizedFunctioncall:
C: bool TakeFX_FormatParamValueNormalized(MediaItem_Take* take, int fx, int param, double value, char* buf, int buf_sz)
EEL2: bool TakeFX_FormatParamValueNormalized(MediaItem_Take take, int fx, int param, value, #buf)
Lua: boolean retval, string buf = reaper.TakeFX_FormatParamValueNormalized(MediaItem_Take take, integer fx, integer param, number value, string buf)
Python: (Boolean retval, MediaItem_Take take, Int fx, Int param, Float value, String buf, Int buf_sz) = RPR_TakeFX_FormatParamValueNormalized(take, fx, param, value, buf, buf_sz)
Description:Note: only works with FX that support Cockos VST extensions.
| Parameters: |
| take | - | |
| fx | - | |
| param | - | |
| value | - | |
| string buf | - | |
| Returnvalues: |
| retval | - | |
| buf | - | |
^
TakeFX_GetChainVisibleFunctioncall:
C: int TakeFX_GetChainVisible(MediaItem_Take* take)
EEL2: int TakeFX_GetChainVisible(MediaItem_Take take)
Lua: integer = reaper.TakeFX_GetChainVisible(MediaItem_Take take)
Python: Int RPR_TakeFX_GetChainVisible(MediaItem_Take take)
Description:returns index of effect visible in chain, or -1 for chain hidden, or -2 for chain visible but no effect selected
^
TakeFX_GetCountFunctioncall:
C: int TakeFX_GetCount(MediaItem_Take* take)
EEL2: int TakeFX_GetCount(MediaItem_Take take)
Lua: integer = reaper.TakeFX_GetCount(MediaItem_Take take)
Python: Int RPR_TakeFX_GetCount(MediaItem_Take take)
Description:
^
TakeFX_GetEnabledFunctioncall:
C: bool TakeFX_GetEnabled(MediaItem_Take* take, int fx)
EEL2: bool TakeFX_GetEnabled(MediaItem_Take take, int fx)
Lua: boolean = reaper.TakeFX_GetEnabled(MediaItem_Take take, integer fx)
Python: Boolean RPR_TakeFX_GetEnabled(MediaItem_Take take, Int fx)
Description:
^
TakeFX_GetEnvelopeFunctioncall:
C: TrackEnvelope* TakeFX_GetEnvelope(MediaItem_Take* take, int fxindex, int parameterindex, bool create)
EEL2: TrackEnvelope TakeFX_GetEnvelope(MediaItem_Take take, int fxindex, int parameterindex, bool create)
Lua: TrackEnvelope = reaper.TakeFX_GetEnvelope(MediaItem_Take take, integer fxindex, integer parameterindex, boolean create)
Python: TrackEnvelope RPR_TakeFX_GetEnvelope(MediaItem_Take take, Int fxindex, Int parameterindex, Boolean create)
Description:Returns the FX parameter envelope. If the envelope does not exist and create=true, the envelope will be created.
| Parameters: |
| take | - | |
| fxindex | - | |
| parameterindex | - | |
| create | - | |
| Returnvalues: |
| TrackEnvelope | - | |
^
TakeFX_GetFloatingWindowFunctioncall:
C: HWND TakeFX_GetFloatingWindow(MediaItem_Take* take, int index)
EEL2: HWND TakeFX_GetFloatingWindow(MediaItem_Take take, int index)
Lua: HWND = reaper.TakeFX_GetFloatingWindow(MediaItem_Take take, integer index)
Python: HWND RPR_TakeFX_GetFloatingWindow(MediaItem_Take take, Int index)
Description:returns HWND of floating window for effect index, if any
| Parameters: |
| take | - | |
| index | - | |
^
TakeFX_GetFormattedParamValueFunctioncall:
C: bool TakeFX_GetFormattedParamValue(MediaItem_Take* take, int fx, int param, char* buf, int buf_sz)
EEL2: bool TakeFX_GetFormattedParamValue(MediaItem_Take take, int fx, int param, #buf)
Lua: boolean retval, string buf = reaper.TakeFX_GetFormattedParamValue(MediaItem_Take take, integer fx, integer param, string buf)
Python: (Boolean retval, MediaItem_Take take, Int fx, Int param, String buf, Int buf_sz) = RPR_TakeFX_GetFormattedParamValue(take, fx, param, buf, buf_sz)
Description:
| Parameters: |
| take | - | |
| fx | - | |
| param | - | |
| string buf | - | |
| Returnvalues: |
| retval | - | |
| buf | - | |
^
TakeFX_GetFXGUIDFunctioncall:
C: GUID* TakeFX_GetFXGUID(MediaItem_Take* take, int fx)
EEL2: bool TakeFX_GetFXGUID(#retguid, MediaItem_Take take, int fx)
Lua: string GUID = reaper.TakeFX_GetFXGUID(MediaItem_Take take, integer fx)
Python: GUID RPR_TakeFX_GetFXGUID(MediaItem_Take take, Int fx)
Description:
^
TakeFX_GetFXNameFunctioncall:
C: bool TakeFX_GetFXName(MediaItem_Take* take, int fx, char* buf, int buf_sz)
EEL2: bool TakeFX_GetFXName(MediaItem_Take take, int fx, #buf)
Lua: boolean retval, string buf = reaper.TakeFX_GetFXName(MediaItem_Take take, integer fx, string buf)
Python: (Boolean retval, MediaItem_Take take, Int fx, String buf, Int buf_sz) = RPR_TakeFX_GetFXName(take, fx, buf, buf_sz)
Description:
| Parameters: |
| take | - | |
| fx | - | |
| string buf | - | |
| Returnvalues: |
| retval | - | |
| buf | - | |
^
TakeFX_GetIOSizeFunctioncall:
C: int TakeFX_GetIOSize(MediaItem_Take* take, int fx, int* inputPinsOutOptional, int* outputPinsOutOptional)
EEL2: int TakeFX_GetIOSize(MediaItem_Take take, int fx, optional int &inputPins, optional int &outputPins)
Lua: integer retval, optional number inputPins, optional number outputPins = reaper.TakeFX_GetIOSize(MediaItem_Take take, integer fx)
Python: (Int retval, MediaItem_Take take, Int fx, Int inputPinsOutOptional, Int outputPinsOutOptional) = RPR_TakeFX_GetIOSize(take, fx, inputPinsOutOptional, outputPinsOutOptional)
Description:sets the number of input/output pins for FX if available, returns plug-in type or -1 on error
| Returnvalues: |
| retval | - | |
| inputPins | - | |
| outputPins | - | |
^
TakeFX_GetNamedConfigParmFunctioncall:
C: bool TakeFX_GetNamedConfigParm(MediaItem_Take* take, int fx, const char* parmname, char* bufOut, int bufOut_sz)
EEL2: bool TakeFX_GetNamedConfigParm(MediaItem_Take take, int fx, "parmname", #buf)
Lua: boolean retval, string buf = reaper.TakeFX_GetNamedConfigParm(MediaItem_Take take, integer fx, string parmname)
Python: (Boolean retval, MediaItem_Take take, Int fx, String parmname, String bufOut, Int bufOut_sz) = RPR_TakeFX_GetNamedConfigParm(take, fx, parmname, bufOut, bufOut_sz)
Description:gets plug-in specific named configuration value (returns true on success)
| Parameters: |
| take | - | |
| fx | - | |
| parmname | - | |
| Returnvalues: |
| retval | - | |
| buf | - | |
^
TakeFX_GetNumParamsFunctioncall:
C: int TakeFX_GetNumParams(MediaItem_Take* take, int fx)
EEL2: int TakeFX_GetNumParams(MediaItem_Take take, int fx)
Lua: integer = reaper.TakeFX_GetNumParams(MediaItem_Take take, integer fx)
Python: Int RPR_TakeFX_GetNumParams(MediaItem_Take take, Int fx)
Description:
^
TakeFX_GetOpenFunctioncall:
C: bool TakeFX_GetOpen(MediaItem_Take* take, int fx)
EEL2: bool TakeFX_GetOpen(MediaItem_Take take, int fx)
Lua: boolean = reaper.TakeFX_GetOpen(MediaItem_Take take, integer fx)
Python: Boolean RPR_TakeFX_GetOpen(MediaItem_Take take, Int fx)
Description:Returns true if this FX UI is open in the FX chain window or a floating window. See
TakeFX_SetOpen
^
TakeFX_GetParamFunctioncall:
C: double TakeFX_GetParam(MediaItem_Take* take, int fx, int param, double* minvalOut, double* maxvalOut)
EEL2: double TakeFX_GetParam(MediaItem_Take take, int fx, int param, &minval, &maxval)
Lua: number retval, number minval, number maxval = reaper.TakeFX_GetParam(MediaItem_Take take, integer fx, integer param)
Python: (Float retval, MediaItem_Take take, Int fx, Int param, Float minvalOut, Float maxvalOut) = RPR_TakeFX_GetParam(take, fx, param, minvalOut, maxvalOut)
Description:
| Parameters: |
| take | - | |
| fx | - | |
| param | - | |
| Returnvalues: |
| retval | - | |
| minval | - | |
| maxval | - | |
^
TakeFX_GetParameterStepSizesFunctioncall:
C: bool TakeFX_GetParameterStepSizes(MediaItem_Take* take, int fx, int param, double* stepOut, double* smallstepOut, double* largestepOut, bool* istoggleOut)
EEL2: bool TakeFX_GetParameterStepSizes(MediaItem_Take take, int fx, int param, &step, &smallstep, &largestep, bool &istoggle)
Lua: boolean retval, number step, number smallstep, number largestep, boolean istoggle = reaper.TakeFX_GetParameterStepSizes(MediaItem_Take take, integer fx, integer param)
Python: (Boolean retval, MediaItem_Take take, Int fx, Int param, Float stepOut, Float smallstepOut, Float largestepOut, Boolean istoggleOut) = RPR_TakeFX_GetParameterStepSizes(take, fx, param, stepOut, smallstepOut, largestepOut, istoggleOut)
Description:
| Parameters: |
| take | - | |
| fx | - | |
| param | - | |
| Returnvalues: |
| retval | - | |
| step | - | |
| smallstep | - | |
| largestep | - | |
| istoggle | - | |
^
TakeFX_GetParamExFunctioncall:
C: double TakeFX_GetParamEx(MediaItem_Take* take, int fx, int param, double* minvalOut, double* maxvalOut, double* midvalOut)
EEL2: double TakeFX_GetParamEx(MediaItem_Take take, int fx, int param, &minval, &maxval, &midval)
Lua: number retval, number minval, number maxval, number midval = reaper.TakeFX_GetParamEx(MediaItem_Take take, integer fx, integer param)
Python: (Float retval, MediaItem_Take take, Int fx, Int param, Float minvalOut, Float maxvalOut, Float midvalOut) = RPR_TakeFX_GetParamEx(take, fx, param, minvalOut, maxvalOut, midvalOut)
Description:
| Parameters: |
| take | - | |
| fx | - | |
| param | - | |
| Returnvalues: |
| retval | - | |
| minval | - | |
| maxval | - | |
| midval | - | |
^
TakeFX_GetParamNameFunctioncall:
C: bool TakeFX_GetParamName(MediaItem_Take* take, int fx, int param, char* buf, int buf_sz)
EEL2: bool TakeFX_GetParamName(MediaItem_Take take, int fx, int param, #buf)
Lua: boolean retval, string buf = reaper.TakeFX_GetParamName(MediaItem_Take take, integer fx, integer param, string buf)
Python: (Boolean retval, MediaItem_Take take, Int fx, Int param, String buf, Int buf_sz) = RPR_TakeFX_GetParamName(take, fx, param, buf, buf_sz)
Description:
| Parameters: |
| take | - | |
| fx | - | |
| param | - | |
| string buf | - | |
| Returnvalues: |
| retval | - | |
| buf | - | |
^
TakeFX_GetParamNormalizedFunctioncall:
C: double TakeFX_GetParamNormalized(MediaItem_Take* take, int fx, int param)
EEL2: double TakeFX_GetParamNormalized(MediaItem_Take take, int fx, int param)
Lua: number = reaper.TakeFX_GetParamNormalized(MediaItem_Take take, integer fx, integer param)
Python: Float RPR_TakeFX_GetParamNormalized(MediaItem_Take take, Int fx, Int param)
Description:
| Parameters: |
| take | - | |
| fx | - | |
| param | - | |
^
TakeFX_GetPinMappingsFunctioncall:
C: int TakeFX_GetPinMappings(MediaItem_Take* tr, int fx, int isOutput, int pin, int* high32OutOptional)
EEL2: int TakeFX_GetPinMappings(MediaItem_Take tr, int fx, int is, int pin, optional int &high32)
Lua: integer retval, optional number high32 = reaper.TakeFX_GetPinMappings(MediaItem_Take tr, integer fx, integer is, integer pin)
Python: (Int retval, MediaItem_Take tr, Int fx, Int isOutput, Int pin, Int high32OutOptional) = RPR_TakeFX_GetPinMappings(tr, fx, isOutput, pin, high32OutOptional)
Description:gets the effective channel mapping bitmask for a particular pin. high32OutOptional will be set to the high 32 bits
| Parameters: |
| tr | - | |
| fx | - | |
| is | - | |
| pin | - | |
| Returnvalues: |
| retval | - | |
| high32 | - | |
^
TakeFX_GetPresetFunctioncall:
C: bool TakeFX_GetPreset(MediaItem_Take* take, int fx, char* presetname, int presetname_sz)
EEL2: bool TakeFX_GetPreset(MediaItem_Take take, int fx, #presetname)
Lua: boolean retval, string presetname = reaper.TakeFX_GetPreset(MediaItem_Take take, integer fx, string presetname)
Python: (Boolean retval, MediaItem_Take take, Int fx, String presetname, Int presetname_sz) = RPR_TakeFX_GetPreset(take, fx, presetname, presetname_sz)
Description:Get the name of the preset currently showing in the REAPER dropdown, or the full path to a factory preset file for VST3 plug-ins (.vstpreset). Returns false if the current FX parameters do not exactly match the preset (in other words, if the user loaded the preset but moved the knobs afterward). See
TakeFX_SetPreset.
| Parameters: |
| MediaItem_Take take | - |
|
| integer fx | - |
|
| string presetname | - |
|
| Returnvalues: |
| boolean retval | - |
|
| string presetname | - |
|
^
TakeFX_GetPresetIndexFunctioncall:
C: int TakeFX_GetPresetIndex(MediaItem_Take* take, int fx, int* numberOfPresetsOut)
EEL2: int TakeFX_GetPresetIndex(MediaItem_Take take, int fx, int &numberOfPresets)
Lua: integer retval, number numberOfPresets = reaper.TakeFX_GetPresetIndex(MediaItem_Take take, integer fx)
Python: (Int retval, MediaItem_Take take, Int fx, Int numberOfPresetsOut) = RPR_TakeFX_GetPresetIndex(take, fx, numberOfPresetsOut)
Description:Returns current preset index, or -1 if error. numberOfPresetsOut will be set to total number of presets available. See
TakeFX_SetPresetByIndex
| Returnvalues: |
| retval | - |
|
| numberOfPresets | - |
|
^
TakeFX_GetUserPresetFilenameFunctioncall:
C: void TakeFX_GetUserPresetFilename(MediaItem_Take* take, int fx, char* fn, int fn_sz)
EEL2: TakeFX_GetUserPresetFilename(MediaItem_Take take, int fx, #fn)
Lua: string fn = reaper.TakeFX_GetUserPresetFilename(MediaItem_Take take, integer fx, string fn)
Python: (MediaItem_Take take, Int fx, String fn, Int fn_sz) = RPR_TakeFX_GetUserPresetFilename(take, fx, fn, fn_sz)
Description:
| Parameters: |
| MediaItem_Take take | - | |
| integer fx | - | |
| string fn | - | |
| Returnvalues: |
| string fn | - | |
^
TakeFX_NavigatePresetsFunctioncall:
C: bool TakeFX_NavigatePresets(MediaItem_Take* take, int fx, int presetmove)
EEL2: bool TakeFX_NavigatePresets(MediaItem_Take take, int fx, int presetmove)
Lua: boolean = reaper.TakeFX_NavigatePresets(MediaItem_Take take, integer fx, integer presetmove)
Python: Boolean RPR_TakeFX_NavigatePresets(MediaItem_Take take, Int fx, Int presetmove)
Description:presetmove==1 activates the next preset, presetmove==-1 activates the previous preset, etc.
| Parameters: |
| take | - | |
| fx | - | |
| presetmove | - | |
^
TakeFX_SetEnabledFunctioncall:
C: void TakeFX_SetEnabled(MediaItem_Take* take, int fx, bool enabled)
EEL2: TakeFX_SetEnabled(MediaItem_Take take, int fx, bool enabled)
Lua: reaper.TakeFX_SetEnabled(MediaItem_Take take, integer fx, boolean enabled)
Python: RPR_TakeFX_SetEnabled(MediaItem_Take take, Int fx, Boolean enabled)
Description:
| Parameters: |
| take | - |
|
| fx | - |
|
| enabled | - |
|
^
TakeFX_SetNamedConfigParmFunctioncall:
C: bool TakeFX_SetNamedConfigParm(MediaItem_Take* take, int fx, const char* parmname, const char* value)
EEL2: bool TakeFX_SetNamedConfigParm(MediaItem_Take take, int fx, "parmname", "value")
Lua: boolean = reaper.TakeFX_SetNamedConfigParm(MediaItem_Take take, integer fx, string parmname, string value)
Python: Boolean RPR_TakeFX_SetNamedConfigParm(MediaItem_Take take, Int fx, String parmname, String value)
Description:gets plug-in specific named configuration value (returns true on success)
| Parameters: |
| take | - | |
| fx | - | |
| parmname | - | |
| value | - | |
^
TakeFX_SetOpenFunctioncall:
C: void TakeFX_SetOpen(MediaItem_Take* take, int fx, bool open)
EEL2: TakeFX_SetOpen(MediaItem_Take take, int fx, bool open)
Lua: reaper.TakeFX_SetOpen(MediaItem_Take take, integer fx, boolean open)
Python: RPR_TakeFX_SetOpen(MediaItem_Take take, Int fx, Boolean open)
Description:
| Parameters: |
| take | - |
|
| fx | - |
|
| open | - |
|
^
TakeFX_SetParamFunctioncall:
C: bool TakeFX_SetParam(MediaItem_Take* take, int fx, int param, double val)
EEL2: bool TakeFX_SetParam(MediaItem_Take take, int fx, int param, val)
Lua: boolean = reaper.TakeFX_SetParam(MediaItem_Take take, integer fx, integer param, number val)
Python: Boolean RPR_TakeFX_SetParam(MediaItem_Take take, Int fx, Int param, Float val)
Description:
| Parameters: |
| take | - | |
| fx | - | |
| param | - | |
| val | - | |
^
TakeFX_SetParamNormalizedFunctioncall:
C: bool TakeFX_SetParamNormalized(MediaItem_Take* take, int fx, int param, double value)
EEL2: bool TakeFX_SetParamNormalized(MediaItem_Take take, int fx, int param, value)
Lua: boolean = reaper.TakeFX_SetParamNormalized(MediaItem_Take take, integer fx, integer param, number value)
Python: Boolean RPR_TakeFX_SetParamNormalized(MediaItem_Take take, Int fx, Int param, Float value)
Description:
| Parameters: |
| take | - | |
| fx | - | |
| param | - | |
| value | - | |
^
TakeFX_SetPinMappingsFunctioncall:
C: bool TakeFX_SetPinMappings(MediaItem_Take* tr, int fx, int isOutput, int pin, int low32bits, int hi32bits)
EEL2: bool TakeFX_SetPinMappings(MediaItem_Take tr, int fx, int is, int pin, int low32bits, int hi32bits)
Lua: boolean = reaper.TakeFX_SetPinMappings(MediaItem_Take tr, integer fx, integer is, integer pin, integer low32bits, integer hi32bits)
Python: Boolean RPR_TakeFX_SetPinMappings(MediaItem_Take tr, Int fx, Int isOutput, Int pin, Int low32bits, Int hi32bits)
Description:sets the channel mapping bitmask for a particular pin. returns false if unsupported (not all types of plug-ins support this capability)
| Parameters: |
| tr | - | |
| fx | - | |
| is | - | |
| pin | - | |
| low32bits | - | |
| hi32bits | - | |
^
TakeFX_SetPresetFunctioncall:
C: bool TakeFX_SetPreset(MediaItem_Take* take, int fx, const char* presetname)
EEL2: bool TakeFX_SetPreset(MediaItem_Take take, int fx, "presetname")
Lua: boolean = reaper.TakeFX_SetPreset(MediaItem_Take take, integer fx, string presetname)
Python: Boolean RPR_TakeFX_SetPreset(MediaItem_Take take, Int fx, String presetname)
Description:Activate a preset with the name shown in the REAPER dropdown. Full paths to .vstpreset files are also supported for VST3 plug-ins. See
TakeFX_GetPreset.
presetname is case-sensitive.
| Parameters: |
| take | - |
|
| fx | - |
|
| presetname | - |
|
^
TakeFX_SetPresetByIndexFunctioncall:
C: bool TakeFX_SetPresetByIndex(MediaItem_Take* take, int fx, int idx)
EEL2: bool TakeFX_SetPresetByIndex(MediaItem_Take take, int fx, int idx)
Lua: boolean = reaper.TakeFX_SetPresetByIndex(MediaItem_Take take, integer fx, integer idx)
Python: Boolean RPR_TakeFX_SetPresetByIndex(MediaItem_Take take, Int fx, Int idx)
Description:Sets the preset idx, or the factory preset (idx==-2), or the default user preset (idx==-1). Returns true on success. See
TakeFX_GetPresetIndex.
| Parameters: |
| take | - |
|
| fx | - |
|
| idx | - |
|
^
TakeFX_ShowFunctioncall:
C: void TakeFX_Show(MediaItem_Take* take, int index, int showFlag)
EEL2: TakeFX_Show(MediaItem_Take take, int index, int showFlag)
Lua: reaper.TakeFX_Show(MediaItem_Take take, integer index, integer showFlag)
Python: RPR_TakeFX_Show(MediaItem_Take take, Int index, Int showFlag)
Description:showflag=0 for hidechain, =1 for show chain(index valid), =2 for hide floating window(index valid), =3 for show floating window (index valid)
| Parameters: |
| take | - | |
| index | - | |
| showFlag | - | |
^
TakeIsMIDIFunctioncall:
C: bool TakeIsMIDI(MediaItem_Take* take)
EEL2: bool TakeIsMIDI(MediaItem_Take take)
Lua: boolean = reaper.TakeIsMIDI(MediaItem_Take take)
Python: Boolean RPR_TakeIsMIDI(MediaItem_Take take)
Description:Returns true if the active take contains MIDI.
| Parameters: |
| take | - | the MediaItem_Take, that you want to check for MIDI-elements |
| Returnvalues: |
| boolean | - | true, MediaItem_Take contains MIDI; false, MediaItem_Take doesn't contain MIDI |
^
ThemeLayout_GetLayoutFunctioncall:
C: bool ThemeLayout_GetLayout(const char* section, int idx, char* nameOut, int nameOut_sz)
EEL2: bool ThemeLayout_GetLayout("section", int idx, #name)
Lua: boolean retval, string name = reaper.ThemeLayout_GetLayout(string section, integer idx)
Python: (Boolean retval, String section, Int idx, String nameOut, Int nameOut_sz) = RPR_ThemeLayout_GetLayout(section, idx, nameOut, nameOut_sz)
Description:Gets theme layout information.
section can be 'global' for global layout override, 'seclist' to enumerate a list of layout sections, otherwise a layout section such as 'mcp', 'tcp', 'trans', etc.
idx can be
-1 to query the current value,
-2 to get the description of the section (if not global),
-3 will return the current context DPI-scaling (256=normal, 512=retina, etc), or 0..x.
returns false if failed.
| Parameters: |
| string section | - | |
| integer idx | - | |
| Returnvalues: |
| boolean retval | - | |
| string name | - | |
^
ThemeLayout_GetParameterFunctioncall:
C: const char* ThemeLayout_GetParameter(int wp, const char** descOutOptional, int* valueOutOptional, int* defValueOutOptional, int* minValueOutOptional, int* maxValueOutOptional)
EEL2: bool ThemeLayout_GetParameter(#retval, int wp, optional #desc, optional int &value, optional int &defValue, optional int &minValue, optional int &maxValue)
Lua: string retval, optional string desc, optional number value, optional number defValue, optional number minValue, optional number maxValue = reaper.ThemeLayout_GetParameter(integer wp)
Python: (String retval, Int wp, String descOutOptional, Int valueOutOptional, Int defValueOutOptional, Int minValueOutOptional, Int maxValueOutOptional) = RPR_ThemeLayout_GetParameter(wp, descOutOptional, valueOutOptional, defValueOutOptional, minValueOutOptional, maxValueOutOptional)
Description:returns theme layout parameter. return value is cfg-name, or nil/empty if out of range.
| Returnvalues: |
| string retval | - |
|
| optional string desc | - |
|
| optional number value | - |
|
| optional number defValue | - |
|
| optional number minValue | - |
|
| optional number maxValue | - |
|
^
ThemeLayout_RefreshAllFunctioncall:
C: void ThemeLayout_RefreshAll()
EEL2: ThemeLayout_RefreshAll()
Lua: reaper.ThemeLayout_RefreshAll()
Python: RPR_ThemeLayout_RefreshAll()
Description:Refreshes all layouts
^
ThemeLayout_SetLayoutFunctioncall:
C: bool ThemeLayout_SetLayout(const char* section, const char* layout)
EEL2: bool ThemeLayout_SetLayout("section", " layout")
Lua: boolean retval = reaper.ThemeLayout_SetLayout(string section, string layout)
Python: Boolean RPR_ThemeLayout_SetLayout(String section, String layout)
Description:Sets theme layout override for a particular section
section can be 'global' or 'mcp' etc.
If setting global layout, prefix a ! to the layout string to clear any per-layout overrides.
Returns false if failed.
| Parameters: |
| string section | - | |
| string layout | - | |
| Returnvalues: |
| boolean retval | - | |
^
ThemeLayout_SetParameterFunctioncall:
C: bool ThemeLayout_SetParameter(int wp, int value, bool persist)
EEL2: bool ThemeLayout_SetParameter(int wp, int value, bool persist)
Lua: boolean retval = reaper.ThemeLayout_SetParameter(integer wp, integer value, boolean persist)
Python: Boolean RPR_ThemeLayout_SetParameter(Int wp, Int value, Boolean persist)
Description:sets theme layout parameter to value. persist=true in order to have change loaded on next theme load.
note that the caller should update layouts via ??? to make changes visible.
| Parameters: |
| integer wp | - |
|
| integer value | - |
|
| boolean persist | - |
|
| Returnvalues: |
| boolean retval | - |
|
^
time_preciseFunctioncall:
C: double time_precise()
Lua: number = reaper.time_precise()
Python: Float RPR_time_precise()
Description:Gets a precise system timestamp in seconds.
For EEL-programming, see
eel_time_precise.
| Returnvalues: |
| number | - | the system-timestamp in seconds with a precision of 7 digits
|
^
TimeMap2_beatsToTimeFunctioncall:
C: double TimeMap2_beatsToTime(ReaProject* proj, double tpos, const int* measuresInOptional)
EEL2: double TimeMap2_beatsToTime(ReaProject proj, tpos, optional int measuresIn)
Lua: number = reaper.TimeMap2_beatsToTime(ReaProject proj, number tpos, optional number measuresIn)
Python: Float RPR_TimeMap2_beatsToTime(ReaProject proj, Float tpos, const int measuresInOptional)
Description:convert a beat position (or optionally a beats+measures if measures is non-NULL) to time.
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| tpos | - |
|
| measuresIn | - |
|
^
TimeMap2_GetDividedBpmAtTimeFunctioncall:
C: double TimeMap2_GetDividedBpmAtTime(ReaProject* proj, double time)
EEL2: double TimeMap2_GetDividedBpmAtTime(ReaProject proj, time)
Lua: number = reaper.TimeMap2_GetDividedBpmAtTime(ReaProject proj, number time)
Python: Float RPR_TimeMap2_GetDividedBpmAtTime(ReaProject proj, Float time)
Description:get the effective BPM at the time (seconds) position (i.e. 2x in /8 signatures)
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| time | - |
|
^
TimeMap2_GetNextChangeTimeFunctioncall:
C: double TimeMap2_GetNextChangeTime(ReaProject* proj, double time)
EEL2: double TimeMap2_GetNextChangeTime(ReaProject proj, time)
Lua: number = reaper.TimeMap2_GetNextChangeTime(ReaProject proj, number time)
Python: Float RPR_TimeMap2_GetNextChangeTime(ReaProject proj, Float time)
Description:when does the next time map (tempo or time sig) change occur
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| time | - |
|
^
TimeMap2_QNToTimeFunctioncall:
C: double TimeMap2_QNToTime(ReaProject* proj, double qn)
EEL2: double TimeMap2_QNToTime(ReaProject proj, qn)
Lua: number = reaper.TimeMap2_QNToTime(ReaProject proj, number qn)
Python: Float RPR_TimeMap2_QNToTime(ReaProject proj, Float qn)
Description:converts project QN position to time.
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| qn | - |
|
^
TimeMap2_timeToBeatsFunctioncall:
C: double TimeMap2_timeToBeats(ReaProject* proj, double tpos, int* measuresOutOptional, int* cmlOutOptional, double* fullbeatsOutOptional, int* cdenomOutOptional)
EEL2: double TimeMap2_timeToBeats(ReaProject proj, tpos, optional int &measures, optional int &cml, optional &fullbeats, optional int &cdenom)
Lua: number retval, optional number measures, optional number cml, optional number fullbeats, optional number cdenom = reaper.TimeMap2_timeToBeats(ReaProject proj, number tpos)
Python: (Float retval, ReaProject proj, Float tpos, Int measuresOutOptional, Int cmlOutOptional, Float fullbeatsOutOptional, Int cdenomOutOptional) = RPR_TimeMap2_timeToBeats(proj, tpos, measuresOutOptional, cmlOutOptional, fullbeatsOutOptional, cdenomOutOptional)
Description:convert a time into beats.
if measures is non-NULL, measures will be set to the measure count, return value will be beats since measure.
if cml is non-NULL, will be set to current measure length in beats (i.e. time signature numerator)
if fullbeats is non-NULL, and measures is non-NULL, fullbeats will get the full beat count (same value returned if measures is NULL).
if cdenom is non-NULL, will be set to the current time signature denominator.
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| tpos | - |
|
| Returnvalues: |
| retval | - |
|
| measures | - |
|
| cml | - |
|
| fullbeats | - |
|
| cdenom | - |
|
^
TimeMap2_timeToQNFunctioncall:
C: double TimeMap2_timeToQN(ReaProject* proj, double tpos)
EEL2: double TimeMap2_timeToQN(ReaProject proj, tpos)
Lua: number = reaper.TimeMap2_timeToQN(ReaProject proj, number tpos)
Python: Float RPR_TimeMap2_timeToQN(ReaProject proj, Float tpos)
Description:converts project time position to QN position.
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| tpos | - |
|
^
TimeMap_curFrameRateFunctioncall:
C: double TimeMap_curFrameRate(ReaProject* proj, bool* dropFrameOutOptional)
EEL2: double TimeMap_curFrameRate(ReaProject proj, optional bool &dropFrame)
Lua: number retval, optional boolean dropFrame = reaper.TimeMap_curFrameRate(ReaProject proj)
Python: (Float retval, ReaProject proj, Boolean dropFrameOutOptional) = RPR_TimeMap_curFrameRate(proj, dropFrameOutOptional)
Description:Gets project framerate, and optionally whether it is drop-frame timecode
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| Returnvalues: |
| retval | - |
|
| dropFrame | - |
|
^
TimeMap_GetDividedBpmAtTimeFunctioncall:
C: double TimeMap_GetDividedBpmAtTime(double time)
EEL2: double TimeMap_GetDividedBpmAtTime(time)
Lua: number = reaper.TimeMap_GetDividedBpmAtTime(number time)
Python: Float RPR_TimeMap_GetDividedBpmAtTime(Float time)
Description:get the effective BPM at the time (seconds) position (i.e. 2x in /8 signatures)
^
TimeMap_GetMeasureInfoFunctioncall:
C: double TimeMap_GetMeasureInfo(ReaProject* proj, int measure, double* qn_startOut, double* qn_endOut, int* timesig_numOut, int* timesig_denomOut, double* tempoOut)
EEL2: double TimeMap_GetMeasureInfo(ReaProject proj, int measure, &qn_start, &qn_end, int ×ig_num, int ×ig_denom, &tempo)
Lua: number retval, number qn_start, number qn_end, number timesig_num, number timesig_denom, number tempo = reaper.TimeMap_GetMeasureInfo(ReaProject proj, integer measure)
Python: (Float retval, ReaProject proj, Int measure, Float qn_startOut, Float qn_endOut, Int timesig_numOut, Int timesig_denomOut, Float tempoOut) = RPR_TimeMap_GetMeasureInfo(proj, measure, qn_startOut, qn_endOut, timesig_numOut, timesig_denomOut, tempoOut)
Description:Get the QN position and time signature information for the start of a measure. Return the time in seconds of the measure start.
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| measure | - |
|
| Returnvalues: |
| retval | - |
|
| qn_start | - |
|
| qn_end | - |
|
| timesig_num | - |
|
| timesig_denom | - |
|
| tempo | - |
|
^
TimeMap_GetMetronomePatternFunctioncall:
C: int TimeMap_GetMetronomePattern(ReaProject* proj, double time, char* pattern, int pattern_sz)
EEL2: int TimeMap_GetMetronomePattern(ReaProject proj, time, #pattern)
Lua: integer retval, string pattern = reaper.TimeMap_GetMetronomePattern(ReaProject proj, number time, string pattern)
Python: (Int retval, ReaProject proj, Float time, String pattern, Int pattern_sz) = RPR_TimeMap_GetMetronomePattern(proj, time, pattern, pattern_sz)
Description:Fills in a string representing the active metronome pattern. For example, in a 7/8 measure divided 3+4, the pattern might be "1221222". The length of the string is the time signature numerator, and the function returns the time signature denominator.
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| number time | - |
|
| string pattern | - |
|
| Returnvalues: |
| boolean retval | - |
|
| string pattern | - |
|
^
TimeMap_GetTimeSigAtTimeFunctioncall:
C: void TimeMap_GetTimeSigAtTime(ReaProject* proj, double time, int* timesig_numOut, int* timesig_denomOut, double* tempoOut)
EEL2: TimeMap_GetTimeSigAtTime(ReaProject proj, time, int ×ig_num, int ×ig_denom, &tempo)
Lua: number timesig_num retval, number timesig_denom, number tempo = reaper.TimeMap_GetTimeSigAtTime(ReaProject proj, number time)
Python: (ReaProject proj, Float time, Int timesig_numOut, Int timesig_denomOut, Float tempoOut) = RPR_TimeMap_GetTimeSigAtTime(proj, time, timesig_numOut, timesig_denomOut, tempoOut)
Description:get the effective time signature and tempo
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| time | - |
|
| Returnvalues: |
| timesig_num retval | - |
|
| timesig_denom | - |
|
| tempo | - |
|
^
TimeMap_QNToMeasuresFunctioncall:
C: int TimeMap_QNToMeasures(ReaProject* proj, double qn, double* qnMeasureStartOutOptional, double* qnMeasureEndOutOptional)
EEL2: int TimeMap_QNToMeasures(ReaProject proj, qn, optional &qnMeasureStart, optional &qnMeasureEnd)
Lua: integer retval, optional number qnMeasureStart, optional number qnMeasureEnd = reaper.TimeMap_QNToMeasures(ReaProject proj, number qn)
Python: (Int retval, ReaProject proj, Float qn, Float qnMeasureStartOutOptional, Float qnMeasureEndOutOptional) = RPR_TimeMap_QNToMeasures(proj, qn, qnMeasureStartOutOptional, qnMeasureEndOutOptional)
Description:Find which measure the given QN position falls in.
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| qn | - |
|
| Returnvalues: |
| retval | - |
|
| qnMeasureStart | - |
|
| qnMeasureEnd | - |
|
^
TimeMap_QNToTimeFunctioncall:
C: double TimeMap_QNToTime(double qn)
EEL2: double TimeMap_QNToTime(qn)
Lua: number = reaper.TimeMap_QNToTime(number qn)
Python: Float RPR_TimeMap_QNToTime(Float qn)
Description:converts project QN position to time.
^
TimeMap_QNToTime_absFunctioncall:
C: double TimeMap_QNToTime_abs(ReaProject* proj, double qn)
EEL2: double TimeMap_QNToTime_abs(ReaProject proj, qn)
Lua: number = reaper.TimeMap_QNToTime_abs(ReaProject proj, number qn)
Python: Float RPR_TimeMap_QNToTime_abs(ReaProject proj, Float qn)
Description:Converts project quarter note count (QN) to time. QN is counted from the start of the project, regardless of any partial measures. See
TimeMap2_QNToTime
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| qn | - |
|
^
TimeMap_timeToQNFunctioncall:
C: double TimeMap_timeToQN(double tpos)
EEL2: double TimeMap_timeToQN(tpos)
Lua: number = reaper.TimeMap_timeToQN(number tpos)
Python: Float RPR_TimeMap_timeToQN(Float tpos)
Description:converts project QN position to time.
^
TimeMap_timeToQN_absFunctioncall:
C: double TimeMap_timeToQN_abs(ReaProject* proj, double tpos)
EEL2: double TimeMap_timeToQN_abs(ReaProject proj, tpos)
Lua: number = reaper.TimeMap_timeToQN_abs(ReaProject proj, number tpos)
Python: Float RPR_TimeMap_timeToQN_abs(ReaProject proj, Float tpos)
Description:Converts project time position to quarter note count (QN). QN is counted from the start of the project, regardless of any partial measures. See
TimeMap2_timeToQN
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| tpos | - |
|
^
ToggleTrackSendUIMuteFunctioncall:
C: bool ToggleTrackSendUIMute(MediaTrack* track, int send_idx)
EEL2: bool ToggleTrackSendUIMute(MediaTrack track, int send_idx)
Lua: boolean = reaper.ToggleTrackSendUIMute(MediaTrack track, integer send_idx)
Python: Boolean RPR_ToggleTrackSendUIMute(MediaTrack track, Int send_idx)
Description:send_idx<0 for receives, >=0 for hw ouputs, >=nb_of_hw_ouputs for sends.
| Parameters: |
| track | - | |
| send_idx | - | |
^
Track_GetPeakHoldDBFunctioncall:
C: double Track_GetPeakHoldDB(MediaTrack* track, int channel, bool clear)
EEL2: double Track_GetPeakHoldDB(MediaTrack track, int channel, bool clear)
Lua: number retval = reaper.Track_GetPeakHoldDB(MediaTrack track, integer channel, boolean clear)
Python: Float RPR_Track_GetPeakHoldDB(MediaTrack track, Int channel, Boolean clear)
Description:Returns meter hold state, in dB*0.01 (0 = +0dB, -0.01 = -1dB, 0.02 = +2dB, etc). If clear is set, clears the meter hold. If master track and channel==1024 or channel==1025, returns/clears RMS maximum state.
| Parameters: |
| MediaTrack track | - | |
| integer channel | - | |
| boolean clear | - | |
| Returnvalues: |
| number retval | - | |
^
Track_GetPeakInfoFunctioncall:
C: double Track_GetPeakInfo(MediaTrack* track, int channel)
EEL2: double Track_GetPeakInfo(MediaTrack track, int channel)
Lua: number retval = reaper.Track_GetPeakInfo(MediaTrack track, integer channel)
Python: Float RPR_Track_GetPeakInfo(MediaTrack track, Int channel)
Description:Returns peak meter value (1.0=+0dB, 0.0=-inf) for channel. If master track and channel==1024 or channel==1025, returns RMS meter value. if master track and channel==2048 or channel=2049, returns RMS meter hold value.
| Parameters: |
| MediaTrack track | - | |
| integer channel | - | |
| Returnvalues: |
| number retval | - | |
^
TrackCtl_SetToolTipFunctioncall:
C: void TrackCtl_SetToolTip(const char* fmt, int xpos, int ypos, bool topmost)
EEL2: TrackCtl_SetToolTip("fmt", int xpos, int ypos, bool topmost)
Lua: reaper.TrackCtl_SetToolTip(string fmt, integer xpos, integer ypos, boolean topmost)
Python: RPR_TrackCtl_SetToolTip(String fmt, Int xpos, Int ypos, Boolean topmost)
Description:Displays tooltip at location, or removes if empty string.
Only one tooltip can be shown, means, a new tooltip removes the previous one.
| Parameters: |
| fmt | - | the message, to be shown as tooltip; empty string removes tooltip |
| xpos | - | horizontal position in pixels |
| ypos | - | vertical position in pixels |
| topmost | - | unknown |
^
TrackFX_AddByNameFunctioncall:
C: int TrackFX_AddByName(MediaTrack* track, const char* fxname, bool recFX, int instantiate)
EEL2: int TrackFX_AddByName(MediaTrack track, "fxname", bool recFX, int instantiate)
Lua: integer retval = reaper.TrackFX_AddByName(MediaTrack track, string fxname, boolean recFX, integer instantiate)
Python: Int RPR_TrackFX_AddByName(MediaTrack track, String fxname, Boolean recFX, Int instantiate)
Description:Adds or queries the position of a named FX from the track FX chain (recFX=false) or record input FX/monitoring FX (recFX=true, monitoring FX are on master track).
Specify a negative value for instantiate to always create a new effect,
0 to only query the first instance of an effect, or a positive value to add an instance if one is not found.
Returns -1 on failure or the new position in chain on success.
| Parameters: |
| MediaTrack track | - | the track, into whose FXChain you want to add a new FX; for inputFX(monitoring FX), this must be the master track + recFX==true |
| string fxname | - | the name of the fx/instrument-plugin |
| boolean recFX | - | true, add the fx to the inputFX(only when track=master track); false, add it to track |
| integer instantiate | - | negative, always create this new fx; positive, create the fx, if it does not yet exist; 0, query position of the first fx with that name |
| Returnvalues: |
| integer retval | - | the index of the position of the new fx; -1, in case of an error |
^
TrackFX_CopyToTrackFunctioncall:
C: void TrackFX_CopyToTrack(MediaTrack* src_track, int src_fx, MediaTrack* dest_track, int dest_fx, bool is_move)
EEL2: TrackFX_CopyToTrack(MediaTrack src_track, int src_fx, MediaTrack dest_track, int dest_fx, bool is_move)
Lua: reaper.TrackFX_CopyToTrack(MediaTrack src_track, integer src_fx, MediaTrack dest_track, integer dest_fx, boolean is_move)
Python: RPR_TrackFX_CopyToTrack(MediaTrack src_track, Int src_fx, MediaTrack dest_track, Int dest_fx, Boolean is_move)
Description:Copies (or moves) FX from src_track to dest_track. Can be used with src_track=dest_track to reorder, FX indices have 0x1000000 set to reference input FX.
Note:
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
Add 0x1000000 to the fx-indices to address monitoringFX/rec-inputFX.
| Parameters: |
| MediaTrack src_track | - | the source-track, whose fx you want to copy; use master-track to address inputfx |
| Int src_fx | - | the index of the fx(0-based); add 0x1000000 to use it for inputfx |
| MediaTrack dest_track | - | the destination-track, into which you want to paste/insert the fx; use master-track to address inputfx |
| Int dest_fx | - | the index of the fx(0-based); add 0x1000000 to use it for inputfx |
| Boolean is_move | - | true, move the fx; false, just copy the fx as new fx to the new position |
^
TrackFX_CopyToTakeFunctioncall:
C: void TrackFX_CopyToTake(MediaTrack* src_track, int src_fx, MediaItem_Take* dest_take, int dest_fx, bool is_move)
EEL2: TrackFX_CopyToTake(MediaTrack src_track, int src_fx, MediaItem_Take dest_take, int dest_fx, bool is_move)
Lua: reaper.TrackFX_CopyToTake(MediaTrack src_track, integer src_fx, MediaItem_Take dest_take, integer dest_fx, boolean is_move)
Python: RPR_TrackFX_CopyToTake(MediaTrack src_track, Int src_fx, MediaItem_Take dest_take, Int dest_fx, Boolean is_move)
Description:Copies (or moves) FX from src_track to dest_take. src_fx can have 0x1000000 set to reference input FX.
Note:
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
Add 0x1000000 to the fx-indices to address monitoringFX/rec-inputFX.
| Parameters: |
| MediaTrack src_track | - | the source-track, whose fx you want to copy; use master-track to address inputfx |
| Int src_fx | - | the index of the fx(0-based); add 0x1000000 to use it for inputfx |
| MediaItem_Take dest_take | - | the destination-take, into which you want to paste/insert the fx |
| Int dest_fx | - | the index of the fx(0-based) |
| Boolean is_move | - | true, move the fx; false, just copy the fx as new fx to the new position |
^
TrackFX_EndParamEditFunctioncall:
C: bool TrackFX_EndParamEdit(MediaTrack* track, int fx, int param)
EEL2: bool TrackFX_EndParamEdit(MediaTrack track, int fx, int param)
Lua: boolean = reaper.TrackFX_EndParamEdit(MediaTrack track, integer fx, integer param)
Python: Boolean RPR_TrackFX_EndParamEdit(MediaTrack track, Int fx, Int param)
Description:By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
| Parameters: |
| MediaTrack track | - | the track, of which you want to set an fx's parameter editing ended |
| integer fx | - | the index of the fx; ass 0x1000000 to address rec-input-fx/monitoringfx |
| integer param | - | |
| Returnvalues: |
| boolean | - | true, setting value was successful; false, setting value was unsuccessful |
^
TrackFX_FormatParamValueFunctioncall:
C: bool TrackFX_FormatParamValue(MediaTrack* track, int fx, int param, double val, char* buf, int buf_sz)
EEL2: bool TrackFX_FormatParamValue(MediaTrack track, int fx, int param, val, #buf)
Lua: boolean retval, string buf = reaper.TrackFX_FormatParamValue(MediaTrack track, integer fx, integer param, number val, string buf)
Python: (Boolean retval, MediaTrack track, Int fx, Int param, Float val, String buf, Int buf_sz) = RPR_TrackFX_FormatParamValue(track, fx, param, val, buf, buf_sz)
Description:returns a formatted version of the currently set parameter-value.
Note: only works with FX that support Cockos VST extensions.
By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
returns false in case of an error
| Parameters: |
| MediaTrack track | - | the track, which contains the fx; use master-track if you want to address input-fx(see fx) |
| integer fx | - | the index of the fx(0-based); add 0x1000000 to use inputFX(only with track=mastertrack) |
| integer param | - | the parameter, whose format you want to apply to the value |
| number val | - | a value, which shall be formatted accordingly |
| string buf | - | simply set this to "" |
| Returnvalues: |
| boolean retval | - | true, parameter can be retrieved; false, an error occured(e.g. no such fx) |
| string buf | - | the formatted parameter value |
^
TrackFX_FormatParamValueNormalizedFunctioncall:
C: bool TrackFX_FormatParamValueNormalized(MediaTrack* track, int fx, int param, double value, char* buf, int buf_sz)
EEL2: bool TrackFX_FormatParamValueNormalized(MediaTrack track, int fx, int param, value, #buf)
Lua: boolean retval, string buf = reaper.TrackFX_FormatParamValueNormalized(MediaTrack track, integer fx, integer param, number value, string buf)
Python: (Boolean retval, MediaTrack track, Int fx, Int param, Float value, String buf, Int buf_sz) = RPR_TrackFX_FormatParamValueNormalized(track, fx, param, value, buf, buf_sz)
Description:returns a formatted version of the currently set parameter-value and normalizes it.
Note: only works with FX that support Cockos VST extensions.
By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
returns false in case of an error
| Parameters: |
| MediaTrack track | - | the track, which contains the fx; use master-track if you want to address input-fx(see fx) |
| integer fx | - | the index of the fx(0-based); add 0x1000000 to use inputFX(only with track=mastertrack) |
| integer param | - | the parameter, whose format you want to apply to the value |
| number val | - | a value, which shall be formatted accordingly |
| string buf | - | simply set this to "" |
| Returnvalues: |
| boolean retval | - | true, parameter can be retrieved; false, an error occured(e.g. no such fx) |
| string buf | - | the formatted parameter value |
^
TrackFX_GetByNameFunctioncall:
C: int TrackFX_GetByName(MediaTrack* track, const char* fxname, bool instantiate)
EEL2: int TrackFX_GetByName(MediaTrack track, "fxname", bool instantiate)
Lua: integer retval = reaper.TrackFX_GetByName(MediaTrack track, string fxname, boolean instantiate)
Python: Int RPR_TrackFX_GetByName(MediaTrack track, String fxname, Boolean instantiate)
Description:Get the index of the first track FX insert that matches fxname. If the FX is not in the chain and instantiate is true, it will be inserted. See
TrackFX_GetInstrument,
TrackFX_GetEQ. Deprecated in favor of TrackFX_AddByName.
returns -1 in case of an error
| Parameters: |
| MediaTrack track | - | the MediaTrack, which may hold the fx
|
| string fxname | - | the name of the fx, whose first index-position you want to query
|
| boolean instantiate | - | true, add the fx, is it's not existing; false, just query
|
| Returnvalues: |
| integer retval | - | the index of the first track FX with fxname
|
^
TrackFX_GetChainVisibleFunctioncall:
C: int TrackFX_GetChainVisible(MediaTrack* track)
EEL2: int TrackFX_GetChainVisible(MediaTrack track)
Lua: integer = reaper.TrackFX_GetChainVisible(MediaTrack track)
Python: Int RPR_TrackFX_GetChainVisible(MediaTrack track)
Description:returns index of effect visible in chain, or -1 for chain hidden, or -2 for chain visible but no effect selected
| Parameters: |
| MediaTrack track | - | the track, whose FXChain-visibility you want to query |
| Returnvalues: |
| integer | - | the current visibility/selected state of the FXChain:
positive, the index of the selected fx(0-based)
-1, hidden
-2, visible but no effect inserted |
^
TrackFX_GetCountFunctioncall:
C: int TrackFX_GetCount(MediaTrack* track)
EEL2: int TrackFX_GetCount(MediaTrack track)
Lua: integer = reaper.TrackFX_GetCount(MediaTrack track)
Python: Int RPR_TrackFX_GetCount(MediaTrack track)
Description:returns the number of trackfx in the FXChain of track
| Parameters: |
| MediaTrack track | - | the track, whose number of fx in the FXChain you want to count |
| Returnvalues: |
| integer | - | the number of fx in the FXChain of track |
^
TrackFX_GetEnabledFunctioncall:
C: bool TrackFX_GetEnabled(MediaTrack* track, int fx)
EEL2: bool TrackFX_GetEnabled(MediaTrack track, int fx)
Lua: boolean = reaper.TrackFX_GetEnabled(MediaTrack track, integer fx)
Python: Boolean RPR_TrackFX_GetEnabled(MediaTrack track, Int fx)
Description:returns, if a certain FX in track is enabled
See
TrackFX_SetEnabled By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
returns false in case of an error
| Parameters: |
| MediaTrack track | - | the track, whose fx-enabled-state you want to query; use master-track to query inputFX(see fx)
|
| integer fx | - | the index of the fx, whose enabled-state you want to query(0-based); add 0x1000000 to query inputFX
|
| Returnvalues: |
| boolean | - | true, fx is enabled; false, fx is disabled or not existing
|
^
TrackFX_GetEQFunctioncall:
C: int TrackFX_GetEQ(MediaTrack* track, bool instantiate)
EEL2: int TrackFX_GetEQ(MediaTrack track, bool instantiate)
Lua: integer = reaper.TrackFX_GetEQ(MediaTrack track, boolean instantiate)
Python: Int RPR_TrackFX_GetEQ(MediaTrack track, Boolean instantiate)
Description:Get the index of ReaEQ in the track FX chain. If ReaEQ is not in the chain and instantiate is true, it will be inserted. See
TrackFX_GetInstrument,
TrackFX_GetByName.
returns -1 if no ReaEQ is available.
| Parameters: |
| MediaTrack track | - | the track, whose first ReaEQ-instance-index you want to query
|
| boolean instantiate | - | true, add ReaEQ if not existing yet; false, just query its position
|
| Returnvalues: |
| integer | - | the index of first ReaEQ in the FXChain; -1, if no ReaEQ is available
|
^
TrackFX_GetEQBandEnabledFunctioncall:
C: bool TrackFX_GetEQBandEnabled(MediaTrack* track, int fx, int bandtype, int bandidx)
EEL2: bool TrackFX_GetEQBandEnabled(MediaTrack track, int fx, int bandtype, int bandidx)
Lua: boolean = reaper.TrackFX_GetEQBandEnabled(MediaTrack track, integer fx, integer bandtype, integer bandidx)
Python: Boolean RPR_TrackFX_GetEQBandEnabled(MediaTrack track, Int fx, Int bandtype, Int bandidx)
Description:Returns true if the EQ band is enabled.
Returns false if the band is disabled, or if track/fxidx is not ReaEQ.
Bandtype: 0=lhipass, 1=loshelf, 2=band, 3=notch, 4=hishelf, 5=lopass.
Bandidx: 0=first band matching bandtype, 1=2nd band matching bandtype, etc.
By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
See
TrackFX_GetEQ,
TrackFX_GetEQParam,
TrackFX_SetEQParam,
TrackFX_SetEQBandEnabled.
| Parameters: |
| MediaTrack track | - | the track, whose ReaEQ-instance-enabledstate you want to query
|
| integer fx | - | the index of the fx in the FXChain, that is the ReaEQ-instance in question
|
| integer bandtype | - | 0=lhipass, 1=loshelf, 2=band, 3=notch, 4=hishelf, 5=lopass.
|
| integer bandidx | - | 0=first band matching bandtype, 1=2nd band matching bandtype, etc.
|
| Returnvalues: |
| boolean | - | true, if the EQ band is enabled; false, if the EQ band is disabled
|
^
TrackFX_GetEQParamFunctioncall:
C: bool TrackFX_GetEQParam(MediaTrack* track, int fx, int paramidx, int* bandtypeOut, int* bandidxOut, int* paramtypeOut, double* normvalOut)
EEL2: bool TrackFX_GetEQParam(MediaTrack track, int fx, int paramidx, int &bandtype, int &bandidx, int ¶mtype, &normval)
Lua: boolean retval, number bandtype, number bandidx, number paramtype, number normval = reaper.TrackFX_GetEQParam(MediaTrack track, integer fx, integer paramidx)
Python: (Boolean retval, MediaTrack track, Int fx, Int paramidx, Int bandtypeOut, Int bandidxOut, Int paramtypeOut, Float normvalOut) = RPR_TrackFX_GetEQParam(track, fxidx, paramidx, bandtypeOut, bandidxOut, paramtypeOut, normvalOut)
Description:Returns false if track/fxidx is not ReaEQ.
Bandtype: -1=master gain, 0=lhipass, 1=loshelf, 2=band, 3=notch, 4=hishelf, 5=lopass.
Bandidx (ignored for master gain): 0=first band matching bandtype, 1=2nd band matching bandtype, etc.
Paramtype (ignored for master gain): 0=freq, 1=gain, 2=Q.
By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
See
TrackFX_GetEQ,
TrackFX_SetEQParam,
TrackFX_GetEQBandEnabled,
TrackFX_SetEQBandEnabled.
| Parameters: |
| MediaTrack track | - | the track, whose ReaEQ-instance-attributes you want to get
|
| integer fx | - | the index of the fx; add 0x1000000 to address rec-input-fx/monitoringfx; 0-based
|
| integer paramidx | - | the parameter whose eq-states you want to retrieve; 0-based
|
| Returnvalues: |
| boolean retval | - | true, if it's a ReaEQ-instance; false, is not a ReaEQ-instance or in case of an error
|
| number bandtype | - | the bandtype of the band to change; -1, master gain 0, lhipass 1, loshelf 2, band 3, notch 4, hishelf 5, lopass
|
| number bandidx | - | 0, first band matching bandtype; 1, 2nd band matching bandtype, etc.
|
| number paramtype | - | 0, freq; 1, gain; 2, Q
|
| number normval | - | the normalized value
|
^
TrackFX_GetFloatingWindowFunctioncall:
C: HWND TrackFX_GetFloatingWindow(MediaTrack* track, int fx)
EEL2: HWND TrackFX_GetFloatingWindow(MediaTrack track, int fx)
Lua: HWND = reaper.TrackFX_GetFloatingWindow(MediaTrack track, integer fx)
Python: HWND RPR_TrackFX_GetFloatingWindow(MediaTrack track, Int fx)
Description:returns HWND of floating window for effect index, if any
By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
| Parameters: |
| MediaTrack track | - | |
| integer fx | - | |
^
TrackFX_GetFormattedParamValueFunctioncall:
C: bool TrackFX_GetFormattedParamValue(MediaTrack* track, int fx, int param, char* buf, int buf_sz)
EEL2: bool TrackFX_GetFormattedParamValue(MediaTrack track, int fx, int param, #buf)
Lua: boolean retval, string buf = reaper.TrackFX_GetFormattedParamValue(MediaTrack track, integer fx, integer param, string buf)
Python: (Boolean retval, MediaTrack track, Int fx, Int param, String buf, Int buf_sz) = RPR_TrackFX_GetFormattedParamValue(track, fx, param, buf, buf_sz)
Description:By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
| Parameters: |
| track | - | |
| fx | - | |
| param | - | |
| string buf | - | |
| Returnvalues: |
| retval | - | |
| buf | - | |
^
TrackFX_GetFXGUIDFunctioncall:
C: GUID* TrackFX_GetFXGUID(MediaTrack* track, int fx)
EEL2: bool TrackFX_GetFXGUID(#retguid, MediaTrack track, int fx)
Lua: string GUID = reaper.TrackFX_GetFXGUID(MediaTrack track, integer fx)
Python: GUID RPR_TrackFX_GetFXGUID(MediaTrack track, Int fx)
Description:By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
^
TrackFX_GetFXNameFunctioncall:
C: bool TrackFX_GetFXName(MediaTrack* track, int fx, char* buf, int buf_sz)
EEL2: bool TrackFX_GetFXName(MediaTrack track, int fx, #buf)
Lua: boolean retval, string buf = reaper.TrackFX_GetFXName(MediaTrack track, integer fx, string buf)
Python: (Boolean retval, MediaTrack track, Int fx, String buf, Int buf_sz) = RPR_TrackFX_GetFXName(track, fx, buf, buf_sz)
Description:By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
| Parameters: |
| track | - | |
| fx | - | |
| string buf | - | |
| Returnvalues: |
| retval | - | |
| buf | - | |
^
TrackFX_GetInstrumentFunctioncall:
C: int TrackFX_GetInstrument(MediaTrack* track)
EEL2: int TrackFX_GetInstrument(MediaTrack track)
Lua: integer = reaper.TrackFX_GetInstrument(MediaTrack track)
Python: Int RPR_TrackFX_GetInstrument(MediaTrack track)
Description:
^
TrackFX_GetIOSizeFunctioncall:
C: int TrackFX_GetIOSize(MediaTrack* track, int fx, int* inputPinsOutOptional, int* outputPinsOutOptional)
EEL2: int TrackFX_GetIOSize(MediaTrack track, int fx, optional int &inputPins, optional int &outputPins)
Lua: integer retval, optional number inputPins, optional number outputPins = reaper.TrackFX_GetIOSize(MediaTrack track, integer fx)
Python: (Int retval, MediaTrack track, Int fx, Int inputPinsOutOptional, Int outputPinsOutOptional) = RPR_TrackFX_GetIOSize(track, fx, inputPinsOutOptional, outputPinsOutOptional)
Description:sets the number of input/output pins for FX if available, returns plug-in type or -1 on error
By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
| Returnvalues: |
| retval | - | |
| inputPins | - | |
| outputPins | - | |
^
TrackFX_GetNamedConfigParmFunctioncall:
C: bool TrackFX_GetNamedConfigParm(MediaTrack* track, int fx, const char* parmname, char* bufOut, int bufOut_sz)
EEL2: bool TrackFX_GetNamedConfigParm(MediaTrack track, int fx, "parmname", #buf)
Lua: boolean retval, string buf = reaper.TrackFX_GetNamedConfigParm(MediaTrack track, integer fx, string parmname)
Python: (Boolean retval, MediaTrack track, Int fx, String parmname, String bufOut, Int bufOut_sz) = RPR_TrackFX_GetNamedConfigParm(track, fx, parmname, bufOut, bufOut_sz)
Description:gets plug-in specific named configuration value (returns true on success). Special values: 'pdc' returns PDC latency. 'in_pin_0' returns name of first input pin (if available), 'out_pin_0' returns name of first output pin (if available), etc.
By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
| Parameters: |
| track | - | |
| fx | - | |
| parmname | - | |
| Returnvalues: |
| retval | - | |
| buf | - | |
^
TrackFX_GetNumParamsFunctioncall:
C: int TrackFX_GetNumParams(MediaTrack* track, int fx)
EEL2: int TrackFX_GetNumParams(MediaTrack track, int fx)
Lua: integer = reaper.TrackFX_GetNumParams(MediaTrack track, integer fx)
Python: Int RPR_TrackFX_GetNumParams(MediaTrack track, Int fx)
Description:By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
^
TrackFX_GetOpenFunctioncall:
C: bool TrackFX_GetOpen(MediaTrack* track, int fx)
EEL2: bool TrackFX_GetOpen(MediaTrack track, int fx)
Lua: boolean = reaper.TrackFX_GetOpen(MediaTrack track, integer fx)
Python: Boolean RPR_TrackFX_GetOpen(MediaTrack track, Int fx)
Description:Returns true if this FX UI is open in the FX chain window or a floating window. See
TrackFX_SetOpen By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
| Parameters: |
| track | - | the MediaTrack, in which the fx to check is located
|
| fx | - | the id of the fx in the fx-chain
|
| Returnvalues: |
| boolean | - | true, TrackFX is open; false, TrackFX is closed
|
^
TrackFX_GetParamFunctioncall:
C: double TrackFX_GetParam(MediaTrack* track, int fx, int param, double* minvalOut, double* maxvalOut)
EEL2: double TrackFX_GetParam(MediaTrack track, int fx, int param, &minval, &maxval)
Lua: number retval, number minval, number maxval = reaper.TrackFX_GetParam(MediaTrack track, integer fx, integer param)
Python: (Float retval, MediaTrack track, Int fx, Int param, Float minvalOut, Float maxvalOut) = RPR_TrackFX_GetParam(track, fx, param, minvalOut, maxvalOut)
Description:By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
| Parameters: |
| track | - | |
| fx | - | |
| param | - | |
| Returnvalues: |
| retval | - | |
| minval | - | |
| maxval | - | |
^
TrackFX_GetParameterStepSizesFunctioncall:
C: bool TrackFX_GetParameterStepSizes(MediaTrack* track, int fx, int param, double* stepOut, double* smallstepOut, double* largestepOut, bool* istoggleOut)
EEL2: bool TrackFX_GetParameterStepSizes(MediaTrack track, int fx, int param, &step, &smallstep, &largestep, bool &istoggle)
Lua: boolean retval, number step, number smallstep, number largestep, boolean istoggle = reaper.TrackFX_GetParameterStepSizes(MediaTrack track, integer fx, integer param)
Python: (Boolean retval, MediaTrack track, Int fx, Int param, Float stepOut, Float smallstepOut, Float largestepOut, Boolean istoggleOut) = RPR_TrackFX_GetParameterStepSizes(track, fx, param, stepOut, smallstepOut, largestepOut, istoggleOut)
Description:By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
| Parameters: |
| track | - | |
| fx | - | |
| param | - | |
| Returnvalues: |
| retval | - | |
| step | - | |
| smallstep | - | |
| largestep | - | |
| istoggle | - | |
^
TrackFX_GetParamExFunctioncall:
C: double TrackFX_GetParamEx(MediaTrack* track, int fx, int param, double* minvalOut, double* maxvalOut, double* midvalOut)
EEL2: double TrackFX_GetParamEx(MediaTrack track, int fx, int param, &minval, &maxval, &midval)
Lua: number retval, number minval, number maxval, number midval = reaper.TrackFX_GetParamEx(MediaTrack track, integer fx, integer param)
Python: (Float retval, MediaTrack track, Int fx, Int param, Float minvalOut, Float maxvalOut, Float midvalOut) = RPR_TrackFX_GetParamEx(track, fx, param, minvalOut, maxvalOut, midvalOut)
Description:By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
| Parameters: |
| track | - | |
| fx | - | |
| param | - | |
| Returnvalues: |
| retval | - | |
| minval | - | |
| maxval | - | |
| midval | - | |
^
TrackFX_GetParamNameFunctioncall:
C: bool TrackFX_GetParamName(MediaTrack* track, int fx, int param, char* buf, int buf_sz)
EEL2: bool TrackFX_GetParamName(MediaTrack track, int fx, int param, #buf)
Lua: boolean retval, string buf = reaper.TrackFX_GetParamName(MediaTrack track, integer fx, integer param, string buf)
Python: (Boolean retval, MediaTrack track, Int fx, Int param, String buf, Int buf_sz) = RPR_TrackFX_GetParamName(track, fx, param, buf, buf_sz)
Description:By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
| Parameters: |
| track | - | |
| fx | - | |
| param | - | |
| string buf | - | |
| Returnvalues: |
| retval | - | |
| buf | - | |
^
TrackFX_GetParamNormalizedFunctioncall:
C: double TrackFX_GetParamNormalized(MediaTrack* track, int fx, int param)
EEL2: double TrackFX_GetParamNormalized(MediaTrack track, int fx, int param)
Lua: number = reaper.TrackFX_GetParamNormalized(MediaTrack track, integer fx, integer param)
Python: Float RPR_TrackFX_GetParamNormalized(MediaTrack track, Int fx, Int param)
Description:By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
| Parameters: |
| track | - | |
| fx | - | |
| param | - | |
^
TrackFX_GetPinMappingsFunctioncall:
C: int TrackFX_GetPinMappings(MediaTrack* tr, int fx, int isOutput, int pin, int* high32OutOptional)
EEL2: int TrackFX_GetPinMappings(MediaTrack tr, int fx, int is, int pin, optional int &high32)
Lua: integer retval, optional number high32 = reaper.TrackFX_GetPinMappings(MediaTrack tr, integer fx, integer is, integer pin)
Python: (Int retval, MediaTrack tr, Int fx, Int isOutput, Int pin, Int high32OutOptional) = RPR_TrackFX_GetPinMappings(tr, fx, isOutput, pin, high32OutOptional)
Description:gets the effective channel mapping bitmask for a particular pin. high32OutOptional will be set to the high 32 bits
By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
| Parameters: |
| tr | - | |
| fx | - | |
| is | - | |
| pin | - | |
| Returnvalues: |
| retval | - | |
| high32 | - | |
^
TrackFX_GetPresetFunctioncall:
C: bool TrackFX_GetPreset(MediaTrack* track, int fx, char* presetname, int presetname_sz)
EEL2: bool TrackFX_GetPreset(MediaTrack track, int fx, #presetname)
Lua: boolean retval, string presetname = reaper.TrackFX_GetPreset(MediaTrack track, integer fx, string presetname)
Python: (Boolean retval, MediaTrack track, Int fx, String presetname, Int presetname_sz) = RPR_TrackFX_GetPreset(track, fx, presetname, presetname_sz)
Description:Get the name of the preset currently showing in the REAPER dropdown, or the full path to a factory preset file for VST3 plug-ins (.vstpreset). Returns false if the current FX parameters do not exactly match the preset (in other words, if the user loaded the preset but moved the knobs afterward). See
TrackFX_SetPreset.
By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
| Parameters: |
| MediaTrack track | - |
|
| integer fx | - |
|
| string presetname | - |
|
| Returnvalues: |
| boolean retval | - |
|
| string presetname | - |
|
^
TrackFX_GetPresetIndexFunctioncall:
C: int TrackFX_GetPresetIndex(MediaTrack* track, int fx, int* numberOfPresetsOut)
EEL2: int TrackFX_GetPresetIndex(MediaTrack track, int fx, int &numberOfPresets)
Lua: integer retval, number numberOfPresets = reaper.TrackFX_GetPresetIndex(MediaTrack track, integer fx)
Python: (Int retval, MediaTrack track, Int fx, Int numberOfPresetsOut) = RPR_TrackFX_GetPresetIndex(track, fx, numberOfPresetsOut)
Description:Returns current preset index, or -1 if error. numberOfPresetsOut will be set to total number of presets available. See
TrackFX_SetPresetByIndex By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
| Returnvalues: |
| retval | - |
|
| numberOfPresets | - |
|
^
TrackFX_GetRecChainVisibleFunctioncall:
C: int TrackFX_GetRecChainVisible(MediaTrack* track)
EEL2: int TrackFX_GetRecChainVisible(MediaTrack track)
Lua: integer = reaper.TrackFX_GetRecChainVisible(MediaTrack track)
Python: Int RPR_TrackFX_GetRecChainVisible(MediaTrack track)
Description:returns index of effect visible in record input chain, or -1 for chain hidden, or -2 for chain visible but no effect selected
To get the monitoring FX rather than record input FX, use Master-Track.
Note:
To access record input FX in other TrackFX-functions, use FX indices [0x1000000..0x1000000+n) for the individual fxs in the FXChain and pass over the track, whose rec-input-fxchain you want to access.
Also pass over the track, whose rec-input-fx you want to access. Pass over MasterTrack to get the monitoring FX-chain.
^
TrackFX_GetRecCountFunctioncall:
C: int TrackFX_GetRecCount(MediaTrack* track)
EEL2: int TrackFX_GetRecCount(MediaTrack track)
Lua: integer = reaper.TrackFX_GetRecCount(MediaTrack track)
Python: Int RPR_TrackFX_GetRecCount(MediaTrack track)
Description:returns count of record input FX of a track.
To get the monitoring FX rather than record input FX, use Master-Track.
Note:
To access record input FX in other TrackFX-functions, use FX indices [0x1000000..0x1000000+n) for the individual fxs in the FXChain and pass over the track, whose rec-input-fxchain you want to access.
Also pass over the track, whose rec-input-fx you want to access. Pass over MasterTrack to get the monitoring FX-chain.
^
TrackFX_GetUserPresetFilenameFunctioncall:
C: void TrackFX_GetUserPresetFilename(MediaTrack* track, int fx, char* fn, int fn_sz)
EEL2: TrackFX_GetUserPresetFilename(MediaTrack track, int fx, #fn)
Lua: string fn = reaper.TrackFX_GetUserPresetFilename(MediaTrack track, integer fx, string fn)
Python: (MediaTrack track, Int fx, String fn, Int fn_sz) = RPR_TrackFX_GetUserPresetFilename(track, fx, fn, fn_sz)
Description:By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
| Parameters: |
| MediaTrack track | - | |
| integer fx | - | |
| string fn | - | |
| Returnvalues: |
| string fn | - | |
^
TrackFX_NavigatePresetsFunctioncall:
C: bool TrackFX_NavigatePresets(MediaTrack* track, int fx, int presetmove)
EEL2: bool TrackFX_NavigatePresets(MediaTrack track, int fx, int presetmove)
Lua: boolean = reaper.TrackFX_NavigatePresets(MediaTrack track, integer fx, integer presetmove)
Python: Boolean RPR_TrackFX_NavigatePresets(MediaTrack track, Int fx, Int presetmove)
Description:presetmove==1 activates the next preset, presetmove==-1 activates the previous preset, etc.
By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
| Parameters: |
| track | - | |
| fx | - | |
| presetmove | - | |
^
TrackFX_SetEnabledFunctioncall:
C: void TrackFX_SetEnabled(MediaTrack* track, int fx, bool enabled)
EEL2: TrackFX_SetEnabled(MediaTrack track, int fx, bool enabled)
Lua: reaper.TrackFX_SetEnabled(MediaTrack track, integer fx, boolean enabled)
Python: RPR_TrackFX_SetEnabled(MediaTrack track, Int fx, Boolean enabled)
Description:Set a TrackFX enabled/disabled.
By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
See
TrackFX_GetEnabled
| Parameters: |
| track | - |
|
| fx | - |
|
| enabled | - |
|
^
TrackFX_SetEQBandEnabledFunctioncall:
C: bool TrackFX_SetEQBandEnabled(MediaTrack* track, int fx, int bandtype, int bandidx, bool enable)
EEL2: bool TrackFX_SetEQBandEnabled(MediaTrack track, int fx, int bandtype, int bandidx, bool enable)
Lua: boolean = reaper.TrackFX_SetEQBandEnabled(MediaTrack track, integer fx, integer bandtype, integer bandidx, boolean enable)
Python: Boolean RPR_TrackFX_SetEQBandEnabled(MediaTrack track, Int fx, Int bandtype, Int bandidx, Boolean enable)
Description:Enable or disable a ReaEQ band.
Returns false if track/fxidx is not ReaEQ.
Bandtype: 0=lhipass, 1=loshelf, 2=band, 3=notch, 4=hishelf, 5=lopass.
Bandidx: 0=first band matching bandtype, 1=2nd band matching bandtype, etc.
See
TrackFX_GetEQ,
TrackFX_GetEQParam,
TrackFX_SetEQParam,
TrackFX_GetEQBandEnabled.
By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
| Parameters: |
| track | - |
|
| fx | - |
|
| bandtype | - |
|
| bandidx | - |
|
| enable | - |
|
^
TrackFX_SetEQParamFunctioncall:
C: bool TrackFX_SetEQParam(MediaTrack* track, int fx, int bandtype, int bandidx, int paramtype, double val, bool isnorm)
EEL2: bool TrackFX_SetEQParam(MediaTrack track, int fx, int bandtype, int bandidx, int paramtype, val, bool isnorm)
Lua: boolean = reaper.TrackFX_SetEQParam(MediaTrack track, integer fx, integer bandtype, integer bandidx, integer paramtype, number val, boolean isnorm)
Python: Boolean RPR_TrackFX_SetEQParam(MediaTrack track, Int fx, Int bandtype, Int bandidx, Int paramtype, Float val, Boolean isnorm)
Description:Returns false if track/fxidx is not ReaEQ. Targets a band matching bandtype.
Bandtype: -1=master gain, 0=lhipass, 1=loshelf, 2=band, 3=notch, 4=hishelf, 5=lopass.
Bandidx (ignored for master gain): 0=target first band matching bandtype, 1=target 2nd band matching bandtype, etc.
Paramtype (ignored for master gain): 0=freq, 1=gain, 2=Q.
See
TrackFX_GetEQ,
TrackFX_GetEQParam,
TrackFX_GetEQBandEnabled,
TrackFX_SetEQBandEnabled.
By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
| Parameters: |
| track | - |
|
| fx | - |
|
| bandtype | - |
|
| bandidx | - |
|
| paramtype | - |
|
| val | - |
|
| isnorm | - |
|
^
TrackFX_SetNamedConfigParmFunctioncall:
C: bool TrackFX_SetNamedConfigParm(MediaTrack* track, int fx, const char* parmname, const char* value)
EEL2: bool TrackFX_SetNamedConfigParm(MediaTrack track, int fx, "parmname", "value")
Lua: boolean = reaper.TrackFX_SetNamedConfigParm(MediaTrack track, integer fx, string parmname, string value)
Python: Boolean RPR_TrackFX_SetNamedConfigParm(MediaTrack track, Int fx, String parmname, String value)
Description:sets plug-in specific named configuration value (returns true on success)
By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
| Parameters: |
| track | - | |
| fx | - | |
| parmname | - | |
| value | - | |
^
TrackFX_SetOfflineFunctioncall:
C: void TrackFX_SetOffline(MediaTrack* track, int fx, bool offline)
EEL2: TrackFX_SetOffline(MediaTrack track, int fx, bool offline)
Lua: reaper.TrackFX_SetOffline(MediaTrack track, integer fx, boolean offline)
Python: RPR_TrackFX_SetOffline(MediaTrack track, Int fx, Boolean offline)
Description:See
TrackFX_GetOffline By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
| Parameters: |
| MediaTrack track | - |
|
| integer fx | - |
|
| boolean offline | - |
|
^
TakeFX_SetOfflineFunctioncall:
C: void TakeFX_SetOffline(MediaItem_Take* take, int fx, bool offline)
EEL2: TakeFX_SetOffline(MediaItem_Take take, int fx, bool offline)
Lua: reaper.TakeFX_SetOffline(MediaItem_Take take, integer fx, boolean offline)
Python: RPR_TakeFX_SetOffline(MediaItem_Take take, Int fx, Boolean offline)
Description:
| Parameters: |
| MediaItem_Take take | - |
|
| integer fx | - |
|
| boolean offline | - |
|
^
TakeFX_GetOfflineFunctioncall:
C: bool TakeFX_GetOffline(MediaItem_Take* take, int fx)
EEL2: bool TakeFX_GetOffline(MediaItem_Take take, int fx)
Lua: boolean retval = reaper.TakeFX_GetOffline(MediaItem_Take take, integer fx)
Python: Boolean RPR_TakeFX_GetOffline(MediaItem_Take take, Int fx)
Description:
| Parameters: |
| MediaItem_Take take | - |
|
| integer fx | - |
|
| Returnvalues: |
| boolean retval | - |
|
^
TakeFX_DeleteFunctioncall:
C: bool TakeFX_Delete(MediaItem_Take* take, int fx)
EEL2: bool TakeFX_Delete(MediaItem_Take take, int fx)
Lua: boolean retval = reaper.TakeFX_Delete(MediaItem_Take take, integer fx)
Python: Boolean RPR_TakeFX_Delete(MediaItem_Take take, Int fx)
Description:Remove a FX from take chain (returns true on success)
| Parameters: |
| MediaItem_Take take | - | |
| integer fx | - | |
| Returnvalues: |
| boolean retval | - | |
^
TakeFX_CopyToTakeFunctioncall:
C: void TakeFX_CopyToTake(MediaItem_Take* src_take, int src_fx, MediaItem_Take* dest_take, int dest_fx, bool is_move)
EEL2: TakeFX_CopyToTake(MediaItem_Take src_take, int src_fx, MediaItem_Take dest_take, int dest_fx, bool is_move)
Lua: reaper.TakeFX_CopyToTake(MediaItem_Take src_take, integer src_fx, MediaItem_Take dest_take, integer dest_fx, boolean is_move)
Python: RPR_TakeFX_CopyToTake(MediaItem_Take src_take, Int src_fx, MediaItem_Take dest_take, Int dest_fx, Boolean is_move)
Description:Copies (or moves) FX from src_take to dest_take. Can be used with src_track=dest_track to reorder.
| Parameters: |
| MediaItem_Take src_take | - | |
| integer src_fx | - | |
| MediaItem_Take dest_take | - | |
| integer dest_fx | - | |
| boolean is_move | - | |
^
TakeFX_CopyToTrackFunctioncall:
C: void TakeFX_CopyToTrack(MediaItem_Take* src_take, int src_fx, MediaTrack* dest_track, int dest_fx, bool is_move)
EEL2: TakeFX_CopyToTrack(MediaItem_Take src_take, int src_fx, MediaTrack dest_track, int dest_fx, bool is_move)
Lua: reaper.TakeFX_CopyToTrack(MediaItem_Take src_take, integer src_fx, MediaTrack dest_track, integer dest_fx, boolean is_move)
Python: RPR_TakeFX_CopyToTrack(MediaItem_Take src_take, Int src_fx, MediaTrack dest_track, Int dest_fx, Boolean is_move)
Description:Copies (or moves) FX from src_take to dest_track.
Note:
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
Add 0x1000000 to the fx-indices to address monitoringFX/rec-inputFX.
| Parameters: |
| MediaItem_Take src_take | - | |
| integer src_fx | - | |
| MediaTrack dest_track | - | |
| integer dest_fx | - | |
| boolean is_move | - | |
^
TrackFX_GetOfflineFunctioncall:
C: bool TrackFX_GetOffline(MediaTrack* track, int fx)
EEL2: bool TrackFX_GetOffline(MediaTrack track, int fx)
Lua: boolean retval = reaper.TrackFX_GetOffline(MediaTrack track, integer fx)
Python: Boolean RPR_TrackFX_GetOffline(MediaTrack track, Int fx)
Description:See
TrackFX_SetOffline By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
| Parameters: |
| MediaTrack track | - |
|
| integer fx | - |
|
| Returnvalues: |
| boolean retval | - |
|
^
TakeFX_CopyToTakeFunctioncall:
C: void TakeFX_CopyToTake(MediaItem_Take* src_take, int src_fx, MediaItem_Take* dest_take, int dest_fx, bool is_move)
EEL2: TakeFX_CopyToTake(MediaItem_Take src_take, int src_fx, MediaItem_Take dest_take, int dest_fx, bool is_move)
Lua: reaper.TakeFX_CopyToTake(MediaItem_Take src_take, integer src_fx, MediaItem_Take dest_take, integer dest_fx, boolean is_move)
Python: RPR_TakeFX_CopyToTake(MediaItem_Take src_take, Int src_fx, MediaItem_Take dest_take, Int dest_fx, Boolean is_move)
Description:Copies (or moves) FX from src_take to dest_take. Can be used with src_track=dest_track to reorder.
| Parameters: |
| MediaItem_Take src_take | - | |
| integer src_fx | - | |
| MediaItem_Take dest_take | - | |
| integer dest_fx | - | |
| boolean is_move | - | |
^
TakeFX_CopyToTrackFunctioncall:
C: void TakeFX_CopyToTrack(MediaItem_Take* src_take, int src_fx, MediaTrack* dest_track, int dest_fx, bool is_move)
EEL2: TakeFX_CopyToTrack(MediaItem_Take src_take, int src_fx, MediaTrack dest_track, int dest_fx, bool is_move)
Lua: reaper.TakeFX_CopyToTrack(MediaItem_Take src_take, integer src_fx, MediaTrack dest_track, integer dest_fx, boolean is_move)
Python: RPR_TakeFX_CopyToTrack(MediaItem_Take src_take, Int src_fx, MediaTrack dest_track, Int dest_fx, Boolean is_move)
Description:Copies (or moves) FX from src_take to dest_track. dest_fx can have 0x1000000 set to reference input FX.
| Parameters: |
| MediaItem_Take src_take | - | |
| integer src_fx | - | |
| MediaTrack dest_track | - | |
| integer dest_fx | - | |
| boolean is_move | - | |
^
TrackFX_DeleteFunctioncall:
C: bool TrackFX_Delete(MediaTrack* track, int fx)
EEL2: bool TrackFX_Delete(MediaTrack track, int fx)
Lua: boolean retval = reaper.TrackFX_Delete(MediaTrack track, integer fx)
Python: Boolean RPR_TrackFX_Delete(MediaTrack track, Int fx)
Description:Remove a FX from track chain (returns true on success).
By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
| Parameters: |
| MediaTrack track | - | |
| integer fx | - | |
| Returnvalues: |
| boolean retval | - | |
^
TrackFX_SetOpenFunctioncall:
C: void TrackFX_SetOpen(MediaTrack* track, int fx, bool open)
EEL2: TrackFX_SetOpen(MediaTrack track, int fx, bool open)
Lua: reaper.TrackFX_SetOpen(MediaTrack track, integer fx, boolean open)
Python: RPR_TrackFX_SetOpen(MediaTrack track, Int fx, Boolean open)
Description:Open this FX UI. See
TrackFX_GetOpen By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
| Parameters: |
| track | - | the track, in which the FX to be opened is located
|
| fx | - | the fx-id within the fxchain
|
| open | - | true, open FX-UI; false, close FX-UI
|
^
TrackFX_SetParamFunctioncall:
C: bool TrackFX_SetParam(MediaTrack* track, int fx, int param, double val)
EEL2: bool TrackFX_SetParam(MediaTrack track, int fx, int param, val)
Lua: boolean = reaper.TrackFX_SetParam(MediaTrack track, integer fx, integer param, number val)
Python: Boolean RPR_TrackFX_SetParam(MediaTrack track, Int fx, Int param, Float val)
Description:By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
| Parameters: |
| track | - | |
| fx | - | |
| param | - | |
| val | - | |
^
TrackFX_SetParamNormalizedFunctioncall:
C: bool TrackFX_SetParamNormalized(MediaTrack* track, int fx, int param, double value)
EEL2: bool TrackFX_SetParamNormalized(MediaTrack track, int fx, int param, value)
Lua: boolean = reaper.TrackFX_SetParamNormalized(MediaTrack track, integer fx, integer param, number value)
Python: Boolean RPR_TrackFX_SetParamNormalized(MediaTrack track, Int fx, Int param, Float value)
Description:By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
| Parameters: |
| track | - | |
| fx | - | |
| param | - | |
| value | - | |
^
TrackFX_SetPinMappingsFunctioncall:
C: bool TrackFX_SetPinMappings(MediaTrack* tr, int fx, int isOutput, int pin, int low32bits, int hi32bits)
EEL2: bool TrackFX_SetPinMappings(MediaTrack tr, int fx, int is, int pin, int low32bits, int hi32bits)
Lua: boolean = reaper.TrackFX_SetPinMappings(MediaTrack tr, integer fx, integer is, integer pin, integer low32bits, integer hi32bits)
Python: Boolean RPR_TrackFX_SetPinMappings(MediaTrack tr, Int fx, Int isOutput, Int pin, Int low32bits, Int hi32bits)
Description:sets the channel mapping bitmask for a particular pin. returns false if unsupported (not all types of plug-ins support this capability)
By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
| Parameters: |
| tr | - | |
| fx | - | |
| is | - | |
| pin | - | |
| low32bits | - | |
| hi32bits | - | |
^
TrackFX_SetPresetFunctioncall:
C: bool TrackFX_SetPreset(MediaTrack* track, int fx, const char* presetname)
EEL2: bool TrackFX_SetPreset(MediaTrack track, int fx, "presetname")
Lua: boolean = reaper.TrackFX_SetPreset(MediaTrack track, integer fx, string presetname)
Python: Boolean RPR_TrackFX_SetPreset(MediaTrack track, Int fx, String presetname)
Description:Activate a preset with the name shown in the REAPER dropdown. Full paths to .vstpreset files are also supported for VST3 plug-ins. See
TrackFX_GetPreset.
By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
presetname is case-sensitive.
| Parameters: |
| track | - |
|
| fx | - |
|
| presetname | - |
|
^
TrackFX_SetPresetByIndexFunctioncall:
C: bool TrackFX_SetPresetByIndex(MediaTrack* track, int fx, int idx)
EEL2: bool TrackFX_SetPresetByIndex(MediaTrack track, int fx, int idx)
Lua: boolean = reaper.TrackFX_SetPresetByIndex(MediaTrack track, integer fx, integer idx)
Python: Boolean RPR_TrackFX_SetPresetByIndex(MediaTrack track, Int fx, Int idx)
Description:Sets the preset idx, or the factory preset (idx==-2), or the default user preset (idx==-1). Returns true on success. See
TrackFX_GetPresetIndex.
By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
| Parameters: |
| track | - |
|
| fx | - |
|
| idx | - |
|
^
TrackFX_ShowFunctioncall:
C: void TrackFX_Show(MediaTrack* track, int fx, int showFlag)
EEL2: TrackFX_Show(MediaTrack track, int fx, int showFlag)
Lua: reaper.TrackFX_Show(MediaTrack track, integer fx, integer showFlag)
Python: RPR_TrackFX_Show(MediaTrack track, Int fx, Int showFlag)
Description:Shows a track-FX-window.
By setting fx you can add 0x1000000 set to reference input FX.
To use global monitoring inputFX, use the master-track, any other track will access the track's rec-input-fx.
| Parameters: |
| MediaTrack track | - | the MediaTrack, whose TrackFX you want to show |
| integer fx | - | the id of the track within the fxchain |
| integer showFlag | - | how to show the FX-window 0, for hidechain 1, for show chain(index valid) 2, for hide floating window(index valid) 3, for show floating window(index valid) |
^
TrackList_AdjustWindowsFunctioncall:
C: void TrackList_AdjustWindows(bool isMinor)
EEL2: TrackList_AdjustWindows(bool isMinor)
Lua: reaper.TrackList_AdjustWindows(boolean isMinor)
Python: RPR_TrackList_AdjustWindows(Boolean isMinor)
Description:Updates the TCP and optionally the MCP. Helpful, when setting a new trackheight using I_HEIGHTOVERRIDE in
SetMediaTrackInfo_Value.
| Parameters: |
| boolean isMinor | - | false, updates only TCP; true, updates TCP and MCP
|
^
TrackList_UpdateAllExternalSurfacesFunctioncall:
C: void TrackList_UpdateAllExternalSurfaces()
EEL2: TrackList_UpdateAllExternalSurfaces()
Lua: reaper.TrackList_UpdateAllExternalSurfaces()
Python: RPR_TrackList_UpdateAllExternalSurfaces()
Description:
^
Undo_BeginBlockFunctioncall:
C: void Undo_BeginBlock()
EEL2: Undo_BeginBlock()
Lua: reaper.Undo_BeginBlock()
Python: RPR_Undo_BeginBlock()
Description:call to start a new block
^
Undo_BeginBlock2Functioncall:
C: void Undo_BeginBlock2(ReaProject* proj)
EEL2: Undo_BeginBlock2(ReaProject proj)
Lua: reaper.Undo_BeginBlock2(ReaProject proj)
Python: RPR_Undo_BeginBlock2(ReaProject proj)
Description:call to start a new undo block. Code after that and before
Undo_EndBlock can be undone.
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
^
Undo_CanRedo2Functioncall:
C: const char* Undo_CanRedo2(ReaProject* proj)
EEL2: bool Undo_CanRedo2(#retval, ReaProject proj)
Lua: string = reaper.Undo_CanRedo2(ReaProject proj)
Python: String RPR_Undo_CanRedo2(ReaProject proj)
Description:returns string of next action,if able,NULL if not
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
^
Undo_CanUndo2Functioncall:
C: const char* Undo_CanUndo2(ReaProject* proj)
EEL2: bool Undo_CanUndo2(#retval, ReaProject proj)
Lua: string = reaper.Undo_CanUndo2(ReaProject proj)
Python: String RPR_Undo_CanUndo2(ReaProject proj)
Description:returns string of last action,if able,NULL if not
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
^
Undo_DoRedo2Functioncall:
C: int Undo_DoRedo2(ReaProject* proj)
EEL2: int Undo_DoRedo2(ReaProject proj)
Lua: integer = reaper.Undo_DoRedo2(ReaProject proj)
Python: Int RPR_Undo_DoRedo2(ReaProject proj)
Description:nonzero if success
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
^
Undo_DoUndo2Functioncall:
C: int Undo_DoUndo2(ReaProject* proj)
EEL2: int Undo_DoUndo2(ReaProject proj)
Lua: integer = reaper.Undo_DoUndo2(ReaProject proj)
Python: Int RPR_Undo_DoUndo2(ReaProject proj)
Description:nonzero if success
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
^
Undo_EndBlockFunctioncall:
C: void Undo_EndBlock(const char* descchange, int extraflags)
EEL2: Undo_EndBlock("descchange", int extraflags)
Lua: reaper.Undo_EndBlock(string descchange, integer extraflags)
Python: RPR_Undo_EndBlock(String descchange, Int extraflags)
Description:call to end the block,with extra flags if any,and a description
| Parameters: |
| descchange | - | a string that describes the changes of the undo-block |
| extraflags | - | set to -1, include all undo states 1, track/master vol/pan/routing, routing/hwout envelopes too 2, track/master fx 4, track items 8, loop selection, markers, regions, extensions 16, freeze state 32, non-FX envelopes only 64, FX envelopes, implied by UNDO_STATE_FX too 128, contents of automation items -- not position, length, rate etc of automation items, which is part of envelope state 256, ARA state |
^
Undo_EndBlock2Functioncall:
C: void Undo_EndBlock2(ReaProject* proj, const char* descchange, int extraflags)
EEL2: Undo_EndBlock2(ReaProject proj, "descchange", int extraflags)
Lua: reaper.Undo_EndBlock2(ReaProject proj, string descchange, integer extraflags)
Python: RPR_Undo_EndBlock2(ReaProject proj, String descchange, Int extraflags)
Description:call to end the block,with extra flags if any,and a description
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| descchange | - | a string that describes the changes of the undo-block
|
| extraflags | - | set to -1, include all undo states 1, track/master vol/pan/routing, routing/hwout envelopes too 2, track/master fx 4, track items 8, loop selection, markers, regions, extensions 16, freeze state 32, non-FX envelopes only 64, FX envelopes, implied by UNDO_STATE_FX too 128, contents of automation items -- not position, length, rate etc of automation items, which is part of envelope state 256, ARA state
|
^
Undo_OnStateChangeFunctioncall:
C: void Undo_OnStateChange(const char* descchange)
EEL2: Undo_OnStateChange("descchange")
Lua: reaper.Undo_OnStateChange(string descchange)
Python: RPR_Undo_OnStateChange(String descchange)
Description:limited state change to items
^
Undo_OnStateChange2Functioncall:
C: void Undo_OnStateChange2(ReaProject* proj, const char* descchange)
EEL2: Undo_OnStateChange2(ReaProject proj, "descchange")
Lua: reaper.Undo_OnStateChange2(ReaProject proj, string descchange)
Python: RPR_Undo_OnStateChange2(ReaProject proj, String descchange)
Description:limited state change to items
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| descchange | - |
|
^
Undo_OnStateChange_ItemFunctioncall:
C: void Undo_OnStateChange_Item(ReaProject* proj, const char* name, MediaItem* item)
EEL2: Undo_OnStateChange_Item(ReaProject proj, "name", MediaItem item)
Lua: reaper.Undo_OnStateChange_Item(ReaProject proj, string name, MediaItem item)
Python: RPR_Undo_OnStateChange_Item(ReaProject proj, String name, MediaItem item)
Description:
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| name | - |
|
| item | - |
|
^
Undo_OnStateChangeExFunctioncall:
C: void Undo_OnStateChangeEx(const char* descchange, int whichStates, int trackparm)
EEL2: Undo_OnStateChangeEx("descchange", int whichStates, int trackparm)
Lua: reaper.Undo_OnStateChangeEx(string descchange, integer whichStates, integer trackparm)
Python: RPR_Undo_OnStateChangeEx(String descchange, Int whichStates, Int trackparm)
Description:rackparm=-1 by default,or if updating one fx chain,you can specify track index
| Parameters: |
| descchange | - | |
| whichStates | - | |
| trackparm | - | |
^
Undo_OnStateChangeEx2Functioncall:
C: void Undo_OnStateChangeEx2(ReaProject* proj, const char* descchange, int whichStates, int trackparm)
EEL2: Undo_OnStateChangeEx2(ReaProject proj, "descchange", int whichStates, int trackparm)
Lua: reaper.Undo_OnStateChangeEx2(ReaProject proj, string descchange, integer whichStates, integer trackparm)
Python: RPR_Undo_OnStateChangeEx2(ReaProject proj, String descchange, Int whichStates, Int trackparm)
Description:rackparm=-1 by default,or if updating one fx chain,you can specify track index
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| descchange | - |
|
| whichStates | - |
|
| trackparm | - |
|
^
UpdateArrangeFunctioncall:
C: void UpdateArrange()
EEL2: UpdateArrange()
Lua: reaper.UpdateArrange()
Python: RPR_UpdateArrange()
Description:Redraw the arrange view
^
UpdateItemInProjectFunctioncall:
C: void UpdateItemInProject(MediaItem* item)
EEL2: UpdateItemInProject(MediaItem item)
Lua: reaper.UpdateItemInProject(MediaItem item)
Python: RPR_UpdateItemInProject(MediaItem item)
Description:
^
UpdateTimelineFunctioncall:
C: void UpdateTimeline()
EEL2: UpdateTimeline()
Lua: reaper.UpdateTimeline()
Python: RPR_UpdateTimeline()
Description:Redraw the arrange view and ruler
^
ValidatePtrFunctioncall:
C: bool ValidatePtr(void* pointer, const char* ctypename)
EEL2: bool ValidatePtr(void* pointer, "ctypename")
Lua: boolean = reaper.ValidatePtr(identifier pointer, string ctypename)
Python: Boolean RPR_ValidatePtr(void pointer, String ctypename)
Description:Return true if the pointer is a valid object of the right type in proj (proj is ignored if pointer is itself a project). Supported types are: ReaProject*, MediaTrack*, MediaItem*, MediaItem_Take*, TrackEnvelope* and PCM_source*.
see
ValidatePtr2
| Parameters: |
| pointer | - | a pointer to the object to check for. In Lua or Python, you just give the object to check as this parameter.
|
| ctypename | - | the type of project to check for(given as a pointer)
|
| Returnvalues: |
| boolean | - | true, the object/pointer is of ctypename; false, it is not
|
^
ValidatePtr2Functioncall:
C: bool ValidatePtr2(ReaProject* proj, void* pointer, const char* ctypename)
EEL2: bool ValidatePtr2(ReaProject proj, void* pointer, "ctypename")
Lua: boolean = reaper.ValidatePtr2(ReaProject proj, identifier pointer, string ctypename)
Python: Boolean RPR_ValidatePtr2(ReaProject proj, void pointer, String ctypename)
Description:Return true if the pointer is a valid object of the right type in proj (proj is ignored if pointer is itself a project). Supported types are: ReaProject*, MediaTrack*, MediaItem*, MediaItem_Take*, TrackEnvelope* and PCM_source*.
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| pointer | - | a pointer to the object to check for. In Lua or Python, you just give the object to check as this parameter.
|
| ctypename | - | the type of project to check for(given as a pointer)
|
| Returnvalues: |
| boolean | - | true, the object/pointer is of ctypename; false, it is not
|
^
ViewPrefsFunctioncall:
C: void ViewPrefs(int page, const char* pageByName)
EEL2: ViewPrefs(int page, "pageByName")
Lua: reaper.ViewPrefs(integer page, string pageByName)
Python: RPR_ViewPrefs(Int page, String pageByName)
Description:Opens the prefs to a page, use pageByName if page is 0.
| Parameters: |
| page | - | the idx of the preferences-page. The following are valid: 139, General 474, Paths 219, Keyboard/Multitouch 212, Project 178, Track/Send Defaults 477, Media Item Defaults 156, Audio 118, Device 153, MIDI Devices 203, Buffering 584, Mute/Solo 136, Playback 517, Seeking 137, Recording 518, Loop Recording 478, Rendering 213, Appearance 236, Media(Appearance) 459, Peaks/Waveforms 524, Fades/Crossfades 458, Track Control Panels 172, Editing Behavior 447, Envelope Display 519, Automation 215, Mouse 466, Mouse Modifiers 490, MIDI Editor 138, Media 257, MIDI 449, Video/REX/Misc 154, Plug-ins 505, Compatibility 210, VST 209, ReWire/DX 515, ReaScript 227, ReaMote 257, Control/OSC/web 160, External Editors |
| pageByName | - | |
^
GetSetTrackGroupMembershipHighFunctioncall:
C: unsigned int GetSetTrackGroupMembershipHigh(MediaTrack* tr, const char* groupname, unsigned int setmask, unsigned int setvalue)
EEL2: uint GetSetTrackGroupMembershipHigh(MediaTrack tr, "groupname", uint setmask, uint setvalue)
Lua: integer groupstate = reaper.GetSetTrackGroupMembershipHigh(MediaTrack tr, string groupname, integer setmask, integer setvalue)
Python: Int RPR_GetSetTrackGroupMembershipHigh(MediaTrack tr, String groupname, Int setmask, Int setvalue)
Description:
| Parameters: |
| MediaTrack tr | - | |
| string groupname | - | |
| integer setmask | - | |
| integer setvalue | - | |
| Returnvalues: |
| integer groupstate | - | |
^
GetSetTrackSendInfo_StringFunctioncall:
C: bool GetSetTrackSendInfo_String(MediaTrack* tr, int category, int sendidx, const char* parmname, char* stringNeedBig, bool setNewValue)
EEL2: bool GetSetTrackSendInfo_String(MediaTrack tr, int category, int sendidx, "parmname", #stringNeedBig, bool setNewValue)
Lua: boolean retval, string stringNeedBig = reaper.GetSetTrackSendInfo_String(MediaTrack tr, integer category, integer sendidx, string parmname, string stringNeedBig, boolean setNewValue)
Python: (Boolean retval, MediaTrack tr, Int category, Int sendidx, String parmname, String stringNeedBig, Boolean setNewValue) = RPR_GetSetTrackSendInfo_String(tr, category, sendidx, parmname, stringNeedBig, setNewValue)
Description:
| Parameters: |
| MediaTrack tr | - | the MediaTrack, whose routings you want to give additional attributes |
| integer category | - | category is <0 for receives, 0=sends, >0 for hardware outputs |
| integer sendidx | - | the index of the send/receive/hwout |
| string parmname | - | the parametername "P_EXT:attribute_name", where attribute_name can be any name. You can have multiple ones, just give them different attribute-names. |
| string stringNeedBig | - | the value of the attribute |
| boolean setNewValue | - | true, set a new value; false, get the currently saved value |
| Returnvalues: |
| boolean retval | - | true, getting/setting was successful; false, getting/setting was unsuccessful |
| string stringNeedBig | - | the currently stored value |
^ 
BR_EnvAlloc(SWS)Functioncall:
C: BR_Envelope* BR_EnvAlloc(TrackEnvelope* envelope, bool takeEnvelopesUseProjectTime)
EEL2: BR_Envelope extension_api("BR_EnvAlloc", TrackEnvelope envelope, bool takeEnvelopesUseProjectTime)
Lua: BR_Envelope = reaper.BR_EnvAlloc(TrackEnvelope envelope, boolean takeEnvelopesUseProjectTime)
Python: BR_Envelope BR_EnvAlloc(TrackEnvelope envelope, Boolean takeEnvelopesUseProjectTime)
Description:[BR] Create a BR_Envelope-object from a track-envelope pointer or take-envelope pointer.
To apply changes to a BR_Envelope-object, always call
BR_EnvFree to release the object and commit changes if needed.
A BR_Envelope is not a TrackEnvelope-object and therefore can't be used as TrackEnvelope-object!
For manipulation see
BR_EnvCountPoints,
BR_EnvDeletePoint,
BR_EnvFind,
BR_EnvFindNext,
BR_EnvFindPrevious,
BR_EnvGetParentTake,
BR_EnvGetParentTrack,
BR_EnvGetPoint,
BR_EnvGetProperties,
BR_EnvSetPoint,
BR_EnvSetProperties,
BR_EnvValueAtPos.
| Parameters: |
| envelope | - | a TrackEnvelope-object of the envelope, that you want to have as a BR_Envelope
|
| takeEnvelopesUseProjectTime | - | false, take envelope points' positions are counted from take position, not project start time; true, work with project time instead
|
| Returnvalues: |
| BR_Envelope | - | the requested Envelope as a BR_Envelope-object
|
^ 
BR_EnvCountPoints(SWS)Functioncall:
C: int BR_EnvCountPoints(BR_Envelope* envelope)
EEL2: int extension_api("BR_EnvCountPoints", BR_Envelope envelope)
Lua: integer = reaper.BR_EnvCountPoints(BR_Envelope envelope)
Python: Int BR_EnvCountPoints(BR_Envelope envelope)
Description:[BR] Count envelope points in the envelope object allocated with
BR_EnvAlloc.
| Parameters: |
| envelope | - | the BR_Envelope-object, whose points you want to count
|
| Returnvalues: |
| integer | - | the number of envelope-points in the BR_Envelope-object
|
^ 
BR_EnvDeletePoint(SWS)Functioncall:
C: bool BR_EnvDeletePoint(BR_Envelope* envelope, int id)
EEL2: bool extension_api("BR_EnvDeletePoint", BR_Envelope envelope, int id)
Lua: boolean = reaper.BR_EnvDeletePoint(BR_Envelope envelope, integer id)
Python: Boolean BR_EnvDeletePoint(BR_Envelope envelope, Int id)
Description:[BR] Delete envelope point by index (zero-based) in the envelope object allocated with
BR_EnvAlloc.
| Parameters: |
| envelope | - | the BR_Envelope-object, where you want to delete an envelope-point
|
| id | - | the envelope-point-idx, that you want to delete. 0, first envelope-point; 1, second envelope-point, etc
|
| Returnvalues: |
| boolean | - | true, deleting was successful; false, deleting was unsuccessful
|
^ 
BR_EnvFind(SWS)Functioncall:
C: int BR_EnvFind(BR_Envelope* envelope, double position, double delta)
EEL2: int extension_api("BR_EnvFind", BR_Envelope envelope, position, delta)
Lua: integer = reaper.BR_EnvFind(BR_Envelope envelope, number position, number delta)
Python: Int BR_EnvFind(BR_Envelope envelope, Float position, Float delta)
Description:[BR] Find envelope point at time position in the envelope object allocated with
BR_EnvAlloc. Pass delta > 0 to search surrounding range - in that case the closest point to position within delta will be searched for. Returns envelope point id (zero-based) on success or -1 on failure.
| Parameters: |
| envelope | - | the BR_Envelope-object, in which you want to find an envelope-point
|
| position | - | the position in seconds, where you want to find from
|
| delta | - | delta > 0 to search surrounding range
|
| Returnvalues: |
| integer | - | envelope-point-id or -1 on failure
|
^ 
BR_EnvFindNext(SWS)Functioncall:
C: int BR_EnvFindNext(BR_Envelope* envelope, double position)
EEL2: int extension_api("BR_EnvFindNext", BR_Envelope envelope, position)
Lua: integer = reaper.BR_EnvFindNext(BR_Envelope envelope, number position)
Python: Int BR_EnvFindNext(BR_Envelope envelope, Float position)
Description:[BR] Find next envelope point after time position in the envelope object allocated with
BR_EnvAlloc. Returns envelope point id (zero-based) on success or -1 on failure.
| Parameters: |
| envelope | - | the BR_Envelope-object, in which you want to find the next envelope-point
|
| position | - | the position in seconds, where you want to find the next envelope-point from
|
| Returnvalues: |
| integer | - | envelope-point-id or -1 on failure
|
^ 
BR_EnvFindPrevious(SWS)Functioncall:
C: int BR_EnvFindPrevious(BR_Envelope* envelope, double position)
EEL2: int extension_api("BR_EnvFindPrevious", BR_Envelope envelope, position)
Lua: integer = reaper.BR_EnvFindPrevious(BR_Envelope envelope, number position)
Python: Int BR_EnvFindPrevious(BR_Envelope envelope, Float position)
Description:[BR] Find previous envelope point before time position in the envelope object allocated with
BR_EnvAlloc. Returns envelope point id (zero-based) on success or -1 on failure.
| Parameters: |
| envelope | - | the BR_Envelope-object, in which you want to find the previous envelope-point
|
| position | - | the position in seconds, where you want to find the previous envelope-point from
|
| Returnvalues: |
| integer | - | envelope-point-id or -1 on failure
|
^ 
BR_EnvFree(SWS)Functioncall:
C: bool BR_EnvFree(BR_Envelope* envelope, bool commit)
EEL2: bool extension_api("BR_EnvFree", BR_Envelope envelope, bool commit)
Lua: boolean = reaper.BR_EnvFree(BR_Envelope envelope, boolean commit)
Python: Boolean BR_EnvFree(BR_Envelope envelope, Boolean commit)
Description:[BR] Free envelope object allocated with
BR_EnvAlloc and commit changes if needed. Returns true if changes were committed successfully. Note that when envelope object wasn't modified nothing will get committed even if commit = true - in that case function returns false.
| Parameters: |
| envelope | - | the BR_Envelope-object that you want to commit and be freed
|
| commit | - | true, commit changes when freeing the BR_Envelope-object; false, don't commit changes when freeing the BR_Envelope-object
|
| Returnvalues: |
| boolean | - | true, committing was successful; false, committing was unsuccessful or no committing was necessary
|
^ 
BR_EnvGetParentTake(SWS)Functioncall:
C: MediaItem_Take* BR_EnvGetParentTake(BR_Envelope* envelope)
EEL2: MediaItem_Take extension_api("BR_EnvGetParentTake", BR_Envelope envelope)
Lua: MediaItem_Take = reaper.BR_EnvGetParentTake(BR_Envelope envelope)
Python: MediaItem_Take BR_EnvGetParentTake(BR_Envelope envelope)
Description:[BR] If envelope object allocated with
BR_EnvAlloc is take envelope, returns parent media item take, otherwise NULL.
| Returnvalues: |
| MediaItem_Take | - |
|
^ 
BR_EnvGetParentTrack(SWS)Functioncall:
C: MediaTrack* BR_EnvGetParentTrack(BR_Envelope* envelope)
EEL2: MediaTrack extension_api("BR_EnvGetParentTrack", BR_Envelope envelope)
Lua: MediaTrack = reaper.BR_EnvGetParentTrack(BR_Envelope envelope)
Python: MediaTrack BR_EnvGetParentTrack(BR_Envelope envelope)
Description:[BR] Get parent track of envelope object allocated with
BR_EnvAlloc. If take envelope, returns NULL.
| Parameters: |
| BR_Envelope envelope | - |
|
| Returnvalues: |
| MediaTrack | - |
|
^ 
BR_EnvGetPoint(SWS)Functioncall:
C: bool BR_EnvGetPoint(BR_Envelope* envelope, int id, double* positionOut, double* valueOut, int* shapeOut, bool* selectedOut, double* bezierOut)
EEL2: bool extension_api("BR_EnvGetPoint", BR_Envelope envelope, int id, &position, &value, int &shape, bool &selected, &bezier)
Lua: boolean retval, number position, number value, number shape, boolean selected, number bezier = reaper.BR_EnvGetPoint(BR_Envelope envelope, integer id)
Python: (Boolean retval, BR_Envelope envelope, Int id, Float positionOut, Float valueOut, Int shapeOut, Boolean selectedOut, Float bezierOut) = BR_EnvGetPoint(envelope, id, positionOut, valueOut, shapeOut, selectedOut, bezierOut)
Description:[BR] Get envelope point by id (zero-based) from the envelope object allocated with
BR_EnvAlloc. Returns true on success.
| Parameters: |
| envelope | - |
|
| id | - |
|
| Returnvalues: |
| retval | - |
|
| position | - |
|
| value | - |
|
| shape | - |
|
| selected | - |
|
| bezier | - |
|
^ 
BR_EnvGetProperties(SWS)Functioncall:
C: void BR_EnvGetProperties(BR_Envelope* envelope, bool* activeOut, bool* visibleOut, bool* armedOut, bool* inLaneOut, int* laneHeightOut, int* defaultShapeOut, double* minValueOut, double* maxValueOut, double* centerValueOut, int* typeOut, bool* faderScalingOut, int* automationItemsOptionsOutOptional)
EEL2: extension_api("BR_EnvGetProperties", BR_Envelope envelope, bool &active, bool &visible, bool &armed, bool &inLane, int &laneHeight, int &defaultShape, &minValue, &maxValue, ¢erValue, int &type, bool &faderScaling, optional int &automationItemsOptions)
Lua: boolean active, boolean visible, boolean armed, boolean inLane, number laneHeight, number defaultShape, number minValue, number maxValue, number centerValue, number type, boolean faderScaling, optional number automationItemsOptions = reaper.BR_EnvGetProperties(BR_Envelope envelope)
Python: (BR_Envelope envelope, Boolean activeOut, Boolean visibleOut, Boolean armedOut, Boolean inLaneOut, Int laneHeightOut, Int defaultShapeOut, Float minValueOut, Float maxValueOut, Float centerValueOut, Int typeOut, Boolean faderScalingOut, Int automationItemsOptionsOutOptional) = BR_EnvGetProperties(envelope, activeOut, visibleOut, armedOut, inLaneOut, laneHeightOut, defaultShapeOut, minValueOut, maxValueOut, centerValueOut, typeOut, faderScalingOut, automationItemsOptionsOutOptional)
Description:[BR] Get envelope properties for the envelope object allocated with
BR_EnvAlloc.
active: true if envelope is active
visible: true if envelope is visible
armed: true if envelope is armed
inLane: true if envelope has it's own envelope lane
laneHeight: envelope lane override height. 0 for none, otherwise size in pixels
defaultShape: default point shape: 0->Linear, 1->Square, 2->Slow start/end, 3->Fast start, 4->Fast end, 5->Bezier
minValue: minimum envelope value
maxValue: maximum envelope value
type: envelope type: 0->Volume, 1->Volume (Pre-FX), 2->Pan, 3->Pan (Pre-FX), 4->Width, 5->Width (Pre-FX), 6->Mute, 7->Pitch, 8->Playrate, 9->Tempo map, 10->Parameter
faderScaling: true if envelope uses fader scaling
automationItemsOptions: -1->project default, &1=0->don't attach to underl. env., &1->attach to underl. env. on right side, &2->attach to underl. env. on both sides, &4: bypass underl. env.
| Returnvalues: |
| boolean active | - |
|
| boolean visible | - |
|
| boolean armed | - |
|
| boolean inLane | - |
|
| number laneHeight | - |
|
| number defaultShape | - |
|
| number minValue | - |
|
| number maxValue | - |
|
| number centerValue | - |
|
| number type | - |
|
| boolean faderScaling | - |
|
| optional number automationItemsOptions | - |
|
^ 
BR_EnvSetPoint(SWS)Functioncall:
C: bool BR_EnvSetPoint(BR_Envelope* envelope, int id, double position, double value, int shape, bool selected, double bezier)
EEL2: bool extension_api("BR_EnvSetPoint", BR_Envelope envelope, int id, position, value, int shape, bool selected, bezier)
Lua: boolean = reaper.BR_EnvSetPoint(BR_Envelope envelope, integer id, number position, number value, integer shape, boolean selected, number bezier)
Python: Boolean BR_EnvSetPoint(BR_Envelope envelope, Int id, Float position, Float value, Int shape, Boolean selected, Float bezier)
Description:[BR] Set envelope point by id (zero-based) in the envelope object allocated with
BR_EnvAlloc. To create point instead, pass id = -1. Note that if new point is inserted or existing point's time position is changed, points won't automatically get sorted. To do that, see
BR_EnvSortPoints.
Returns true on success.
| Parameters: |
| envelope | - |
|
| id | - |
|
| position | - |
|
| value | - |
|
| shape | - |
|
| selected | - |
|
| bezier | - |
|
^ 
BR_EnvSetProperties(SWS)Functioncall:
C: void BR_EnvSetProperties(BR_Envelope* envelope, bool active, bool visible, bool armed, bool inLane, int laneHeight, int defaultShape, bool faderScaling, int* automationItemsOptionsInOptional)
EEL2: extension_api("BR_EnvSetProperties", BR_Envelope envelope, bool active, bool visible, bool armed, bool inLane, int laneHeight, int defaultShape, bool faderScaling, optional int automationItemsOptionsIn)
Lua: reaper.BR_EnvSetProperties(BR_Envelope envelope, boolean active, boolean visible, boolean armed, boolean inLane, integer laneHeight, integer defaultShape, boolean faderScaling, optional number automationItemsOptionsIn)
Python: (BR_Envelope envelope, Boolean active, Boolean visible, Boolean armed, Boolean inLane, Int laneHeight, Int defaultShape, Boolean faderScaling, Int automationItemsOptionsInOptional) = BR_EnvSetProperties(envelope, active, visible, armed, inLane, laneHeight, defaultShape, faderScaling, automationItemsOptionsInOptional)
Description:[BR] Set envelope properties for the envelope object allocated with
BR_EnvAlloc. For parameter description see
BR_EnvGetProperties.
Setting automationItemsOptions requires REAPER 5.979+.
| Parameters: |
| TrackEnvelope envelope | - |
|
| boolean active | - |
|
| boolean visible | - |
|
| boolean armed | - |
|
| boolean inLane | - |
|
| integer laneHeight | - |
|
| integer defaultShape | - |
|
| boolean faderScaling | - |
|
| optional number automationItemsOptionsIn | - |
|
^ 
BR_EnvSortPoints(SWS)Functioncall:
C: void BR_EnvSortPoints(BR_Envelope* envelope)
EEL2: extension_api("BR_EnvSortPoints", BR_Envelope envelope)
Lua: reaper.BR_EnvSortPoints(BR_Envelope envelope)
Python: BR_EnvSortPoints(BR_Envelope envelope)
Description:[BR] Sort envelope points by position. The only reason to call this is if sorted points are explicitly needed after editing them with
BR_EnvSetPoint. Note that you do not have to call this before doing
BR_EnvFree since it does handle unsorted points too.
^ 
BR_EnvValueAtPos(SWS)Functioncall:
C: double BR_EnvValueAtPos(BR_Envelope* envelope, double position)
EEL2: double extension_api("BR_EnvValueAtPos", BR_Envelope envelope, position)
Lua: number = reaper.BR_EnvValueAtPos(BR_Envelope envelope, number position)
Python: Float BR_EnvValueAtPos(BR_Envelope envelope, Float position)
Description:[BR] Get envelope value at time position for the envelope object allocated with
BR_EnvAlloc.
| Parameters: |
| envelope | - |
|
| position | - |
|
^ 
BR_GetArrangeView(SWS)Functioncall:
C: void BR_GetArrangeView(ReaProject* proj, double* startTimeOut, double* endTimeOut)
EEL2: extension_api("BR_GetArrangeView", ReaProject proj, &startTime, &endTime)
Lua: number startTime retval, number endTime = reaper.BR_GetArrangeView(ReaProject proj)
Python: (ReaProject proj, Float startTimeOut, Float endTimeOut) = BR_GetArrangeView(proj, startTimeOut, endTimeOut)
Description:
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| Returnvalues: |
| startTime retval | - | the current starttime in the arrangeview in seconds
|
| endTime | - | the current endtime in the arrangeview in seconds
|
^ 
BR_GetClosestGridDivision(SWS)Functioncall:
C: double BR_GetClosestGridDivision(double position)
EEL2: double extension_api("BR_GetClosestGridDivision", position)
Lua: number = reaper.BR_GetClosestGridDivision(number position)
Python: Float BR_GetClosestGridDivision(Float position)
Description:[BR] Get closest grid division to position. Note that this functions is different from
SnapToGrid in two regards. SnapToGrid() needs snap enabled to work and this one works always. Secondly, grid divisions are different from grid lines because some grid lines may be hidden due to zoom level - this function ignores grid line visibility and always searches for the closest grid division at given position. For more grid division functions, see
BR_GetNextGridDivision and
BR_GetPrevGridDivision.
^ 
BR_GetCurrentTheme(SWS)Functioncall:
C: void BR_GetCurrentTheme(char* themePathOut, int themePathOut_sz, char* themeNameOut, int themeNameOut_sz)
EEL2: extension_api("BR_GetCurrentTheme", #themePath, #themeName)
Lua: string themePath retval, string themeName = reaper.BR_GetCurrentTheme()
Python: (String themePathOut, Int themePathOut_sz, String themeNameOut, Int themeNameOut_sz) = BR_GetCurrentTheme(themePathOut, themePathOut_sz, themeNameOut, themeNameOut_sz)
Description:[BR] Get current theme information. themePathOut is set to full theme path and themeNameOut is set to theme name excluding any path info and extension
| Returnvalues: |
| themePath retval | - |
|
| themeName | - |
|
^ 
BR_GetMediaItemByGUID(SWS)Functioncall:
C: MediaItem* BR_GetMediaItemByGUID(ReaProject* proj, const char* guidStringIn)
EEL2: MediaItem extension_api("BR_GetMediaItemByGUID", ReaProject proj, "guidStringIn")
Lua: MediaItem = reaper.BR_GetMediaItemByGUID(ReaProject proj, string guidStringIn)
Python: MediaItem BR_GetMediaItemByGUID(ReaProject proj, String guidStringIn)
Description:[BR] Get media item from GUID string. Note that the GUID must be enclosed in braces {}. To get item's GUID as a string, see
BR_GetMediaItemGUID.
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| guidStringIn | - | the guid of the MediaItem you want to request.
|
| Returnvalues: |
| MediaItem | - | the requested MediaItem as a MediaItem-object
|
^ 
BR_GetMediaItemGUID(SWS)Functioncall:
C: void BR_GetMediaItemGUID(MediaItem* item, char* guidStringOut, int guidStringOut_sz)
EEL2: extension_api("BR_GetMediaItemGUID", MediaItem item, #guidString)
Lua: string guidString = reaper.BR_GetMediaItemGUID(MediaItem item)
Python: (MediaItem item, String guidStringOut, Int guidStringOut_sz) = BR_GetMediaItemGUID(item, guidStringOut, guidStringOut_sz)
Description:[BR] Get media item GUID as a string (guidStringOut_sz should be at least 64). To get media item back from GUID string, see
BR_GetMediaItemByGUID.
| Parameters: |
| item | - | the MediaItem, whose guid you want to request
|
| Returnvalues: |
| guidString | - | the requested guid of the MediaItem
|
^ 
BR_GetMediaItemImageResource(SWS)Functioncall:
C: bool BR_GetMediaItemImageResource(MediaItem* item, char* imageOut, int imageOut_sz, int* imageFlagsOut)
EEL2: bool extension_api("BR_GetMediaItemImageResource", MediaItem item, #image, int &imageFlags)
Lua: boolean retval, string image, number imageFlags = reaper.BR_GetMediaItemImageResource(MediaItem item)
Python: (Boolean retval, MediaItem item, String imageOut, Int imageOut_sz, Int imageFlagsOut) = BR_GetMediaItemImageResource(item, imageOut, imageOut_sz, imageFlagsOut)
Description:[BR] Get currently loaded image resource and its flags for a given item. Returns false if there is no image resource set. To set image resource, see
BR_SetMediaItemImageResource.
| Returnvalues: |
| retval | - |
|
| image | - |
|
| imageFlags | - |
|
^ 
BR_GetMediaItemTakeGUID(SWS)Functioncall:
C: void BR_GetMediaItemTakeGUID(MediaItem_Take* take, char* guidStringOut, int guidStringOut_sz)
EEL2: extension_api("BR_GetMediaItemTakeGUID", MediaItem_Take take, #guidString)
Lua: string guidString = reaper.BR_GetMediaItemTakeGUID(MediaItem_Take take)
Python: (MediaItem_Take take, String guidStringOut, Int guidStringOut_sz) = BR_GetMediaItemTakeGUID(take, guidStringOut, guidStringOut_sz)
Description:[BR] Get media item take GUID as a string (guidStringOut_sz should be at least 64). To get take from GUID string, see
SNM_GetMediaItemTakeByGUID.
| Returnvalues: |
| guidString | - |
|
^ 
BR_GetMediaSourceProperties(SWS)Functioncall:
C: bool BR_GetMediaSourceProperties(MediaItem_Take* take, bool* sectionOut, double* startOut, double* lengthOut, double* fadeOut, bool* reverseOut)
EEL2: bool extension_api("BR_GetMediaSourceProperties", MediaItem_Take take, bool §ion, &start, &length, &fade, bool &reverse)
Lua: boolean retval, boolean section, number start, number length, number fade, boolean reverse = reaper.BR_GetMediaSourceProperties(MediaItem_Take take)
Python: (Boolean retval, MediaItem_Take take, Boolean sectionOut, Float startOut, Float lengthOut, Float fadeOut, Boolean reverseOut) = BR_GetMediaSourceProperties(take, sectionOut, startOut, lengthOut, fadeOut, reverseOut)
Description:[BR] Get take media source properties as they appear in Item properties. Returns false if take can't have them (MIDI items etc.).
To set source properties, see
BR_SetMediaSourceProperties.
| Returnvalues: |
| retval | - |
|
| section | - |
|
| start | - |
|
| length | - |
|
| fade | - |
|
| reverse | - |
|
^ 
BR_GetMediaTrackByGUID(SWS)Functioncall:
C: MediaTrack* BR_GetMediaTrackByGUID(ReaProject* proj, const char* guidStringIn)
EEL2: MediaTrack extension_api("BR_GetMediaTrackByGUID", ReaProject proj, "guidStringIn")
Lua: MediaTrack = reaper.BR_GetMediaTrackByGUID(ReaProject proj, string guidStringIn)
Python: MediaTrack BR_GetMediaTrackByGUID(ReaProject proj, String guidStringIn)
Description:[BR] Get media track from GUID string. Note that the GUID must be enclosed in braces {}. To get track's GUID as a string, see
GetSetMediaTrackInfo_String.
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| string guidStringIn | - | the guid of the track you want to request
|
| Returnvalues: |
| MediaTrack | - | the MediaTrack requested, as MediaTrack-object
|
^ 
BR_GetMediaTrackFreezeCount(SWS)Functioncall:
C: int BR_GetMediaTrackFreezeCount(MediaTrack* track)
EEL2: int extension_api("BR_GetMediaTrackFreezeCount", MediaTrack track)
Lua: integer = reaper.BR_GetMediaTrackFreezeCount(MediaTrack track)
Python: Int BR_GetMediaTrackFreezeCount(MediaTrack track)
Description:[BR] Get media track freeze count (if track isn't frozen at all, returns 0).
^ 
BR_GetMediaTrackGUID(SWS)Functioncall:
C: void BR_GetMediaTrackGUID(MediaTrack* track, char* guidStringOut, int guidStringOut_sz)
EEL2: extension_api("BR_GetMediaTrackGUID", MediaTrack track, #guidString)
Lua: string guidString = reaper.BR_GetMediaTrackGUID(MediaTrack track)
Python: (MediaTrack track, String guidStringOut, Int guidStringOut_sz) = BR_GetMediaTrackGUID(track, guidStringOut, guidStringOut_sz)
Description:
| Parameters: |
| MediaTrack track | - | the track, whose guid you want to get
|
| Returnvalues: |
| string guidString | - | the guid of the track
|
^ 
BR_GetMediaTrackLayouts(SWS)Functioncall:
C: void BR_GetMediaTrackLayouts(MediaTrack* track, char* mcpLayoutNameOut, int mcpLayoutNameOut_sz, char* tcpLayoutNameOut, int tcpLayoutNameOut_sz)
EEL2: extension_api("BR_GetMediaTrackLayouts", MediaTrack track, #mcpLayoutName, #tcpLayoutName)
Lua: string mcpLayoutName retval, string tcpLayoutName = reaper.BR_GetMediaTrackLayouts(MediaTrack track)
Python: (MediaTrack track, String mcpLayoutNameOut, Int mcpLayoutNameOut_sz, String tcpLayoutNameOut, Int tcpLayoutNameOut_sz) = BR_GetMediaTrackLayouts(track, mcpLayoutNameOut, mcpLayoutNameOut_sz, tcpLayoutNameOut, tcpLayoutNameOut_sz)
Description:[BR] Deprecated, see
GetSetMediaTrackInfo (REAPER v5.02+). Get media track layouts for MCP and TCP. Empty string ("") means that layout is set to the default layout. To set media track layouts, see
BR_SetMediaTrackLayouts.
| Returnvalues: |
| mcpLayoutName retval | - |
|
| tcpLayoutName | - |
|
^ 
BR_GetMediaTrackSendInfo_Envelope(SWS)Functioncall:
C: TrackEnvelope* BR_GetMediaTrackSendInfo_Envelope(MediaTrack* track, int category, int sendidx, int envelopeType)
EEL2: TrackEnvelope extension_api("BR_GetMediaTrackSendInfo_Envelope", MediaTrack track, int category, int sendidx, int envelopeType)
Lua: TrackEnvelope = reaper.BR_GetMediaTrackSendInfo_Envelope(MediaTrack track, integer category, integer sendidx, integer envelopeType)
Python: TrackEnvelope BR_GetMediaTrackSendInfo_Envelope(MediaTrack track, Int category, Int sendidx, Int envelopeType)
Description:[BR] Get track envelope for send/receive/hardware output.
category is <0 for receives, 0=sends, >0 for hardware outputs
sendidx is zero-based (see
GetTrackNumSends to count track sends/receives/hardware outputs)
envelopeType determines which envelope is returned (0=volume, 1=pan, 2=mute)
Note: To get or set other send attributes, see
BR_GetSetTrackSendInfo and
BR_GetMediaTrackSendInfo_Track.
| Parameters: |
| track | - |
|
| category | - |
|
| sendidx | - |
|
| envelopeType | - |
|
| Returnvalues: |
| TrackEnvelope | - |
|
^ 
BR_GetMediaTrackSendInfo_Track(SWS)Functioncall:
C: MediaTrack* BR_GetMediaTrackSendInfo_Track(MediaTrack* track, int category, int sendidx, int trackType)
EEL2: MediaTrack extension_api("BR_GetMediaTrackSendInfo_Track", MediaTrack track, int category, int sendidx, int trackType)
Lua: MediaTrack = reaper.BR_GetMediaTrackSendInfo_Track(MediaTrack track, integer category, integer sendidx, integer trackType)
Python: MediaTrack BR_GetMediaTrackSendInfo_Track(MediaTrack track, Int category, Int sendidx, Int trackType)
Description:[BR] Get source or destination media track for send/receive.
category is <0 for receives, 0=sends
sendidx is zero-based (see
GetTrackNumSends to count track sends/receives)
trackType determines which track is returned (0=source track, 1=destination track)
Note: To get or set other send attributes, see
BR_GetSetTrackSendInfo and
BR_GetMediaTrackSendInfo_Envelope.
| Parameters: |
| track | - |
|
| category | - |
|
| sendidx | - |
|
| trackType | - |
|
| Returnvalues: |
| MediaTrack | - |
|
^ 
BR_GetMidiSourceLenPPQ(SWS)Functioncall:
C: double BR_GetMidiSourceLenPPQ(MediaItem_Take* take)
EEL2: double extension_api("BR_GetMidiSourceLenPPQ", MediaItem_Take take)
Lua: number = reaper.BR_GetMidiSourceLenPPQ(MediaItem_Take take)
Python: Float BR_GetMidiSourceLenPPQ(MediaItem_Take take)
Description:[BR] Get MIDI take source length in PPQ. In case the take isn't MIDI, return value will be -1.
^ 
BR_GetMidiTakePoolGUID(SWS)Functioncall:
C: bool BR_GetMidiTakePoolGUID(MediaItem_Take* take, char* guidStringOut, int guidStringOut_sz)
EEL2: bool extension_api("BR_GetMidiTakePoolGUID", MediaItem_Take take, #guidString)
Lua: boolean retval, string guidString = reaper.BR_GetMidiTakePoolGUID(MediaItem_Take take)
Python: (Boolean retval, MediaItem_Take take, String guidStringOut, Int guidStringOut_sz) = BR_GetMidiTakePoolGUID(take, guidStringOut, guidStringOut_sz)
Description:[BR] Get MIDI take pool GUID as a string (guidStringOut_sz should be at least 64). Returns true if take is pooled.
| Returnvalues: |
| retval | - | |
| guidString | - | |
^ 
BR_GetMidiTakeTempoInfo(SWS)Functioncall:
C: bool BR_GetMidiTakeTempoInfo(MediaItem_Take* take, bool* ignoreProjTempoOut, double* bpmOut, int* numOut, int* denOut)
EEL2: bool extension_api("BR_GetMidiTakeTempoInfo", MediaItem_Take take, bool &ignoreProjTempo, &bpm, int &num, int &den)
Lua: boolean retval, boolean ignoreProjTempo, number bpm, number num, number den = reaper.BR_GetMidiTakeTempoInfo(MediaItem_Take take)
Python: (Boolean retval, MediaItem_Take take, Boolean ignoreProjTempoOut, Float bpmOut, Int numOut, Int denOut) = BR_GetMidiTakeTempoInfo(take, ignoreProjTempoOut, bpmOut, numOut, denOut)
Description:[BR] Get "ignore project tempo" information for MIDI take. Returns true if take can ignore project tempo (no matter if it's actually ignored), otherwise false.
| Returnvalues: |
| retval | - | |
| ignoreProjTempo | - | |
| bpm | - | |
| num | - | |
| den | - | |
^ 
BR_GetMouseCursorContext(SWS)Functioncall:
C: void BR_GetMouseCursorContext(char* windowOut, int windowOut_sz, char* segmentOut, int segmentOut_sz, char* detailsOut, int detailsOut_sz)
EEL2: extension_api("BR_GetMouseCursorContext", #window, #segment, #details)
Lua: string window retval, string segment, string details = reaper.BR_GetMouseCursorContext()
Python: (String windowOut, Int windowOut_sz, String segmentOut, Int segmentOut_sz, String detailsOut, Int detailsOut_sz) = BR_GetMouseCursorContext(windowOut, windowOut_sz, segmentOut, segmentOut_sz, detailsOut, detailsOut_sz)
Description:[BR] Get mouse cursor context. Each parameter returns information in a form of string as specified in the table below.
To get more info on stuff that was found under mouse cursor see
BR_GetMouseCursorContext_Envelope,
BR_GetMouseCursorContext_Item,
BR_GetMouseCursorContext_MIDI,
BR_GetMouseCursorContext_Position,
BR_GetMouseCursorContext_Take,
BR_GetMouseCursorContext_Track
| Window | Segment | Details |
|---|
| unknown | "" | "" |
|---|
| ruler | region_lane | "" |
|---|
| marker_lane | "" |
| tempo_lane | "" |
| timeline | "" |
| transport | "" | "" |
|---|
| tcp | track | "" |
|---|
| envelope | "" |
| empty | "" |
| mcp | track | "" |
|---|
| empty | "" |
| arrange | track | empty,item, item_stretch_marker,env_point, env_segment |
|---|
| envelope | empty, env_point, env_segment |
| empty | "" |
| midi_editor | unknown | "" |
|---|
| ruler | "" |
| piano | "" |
| notes | "" |
| cc_lane | cc_selector, cc_lane |
| Returnvalues: |
| window retval | - | the window, in which the mouse-cursor was, at time of calling BR_GetMouseCursorContext
|
| segment | - | the segment within the window
|
| details | - | details with the segment of the window
|
^ 
BR_GetMouseCursorContext_Envelope(SWS)Functioncall:
C: TrackEnvelope* BR_GetMouseCursorContext_Envelope(bool* takeEnvelopeOut)
EEL2: TrackEnvelope extension_api("BR_GetMouseCursorContext_Envelope", bool &takeEnvelope)
Lua: TrackEnvelope retval, boolean takeEnvelope = reaper.BR_GetMouseCursorContext_Envelope()
Python: (TrackEnvelope retval, Boolean takeEnvelopeOut) = BR_GetMouseCursorContext_Envelope(takeEnvelopeOut)
Description:[BR] Returns envelope that was captured with the last call to
BR_GetMouseCursorContext. In case the envelope belongs to take, takeEnvelope will be true.
| Returnvalues: |
| retval | - |
|
| takeEnvelope | - |
|
^ 
BR_GetMouseCursorContext_Item(SWS)Functioncall:
C: MediaItem* BR_GetMouseCursorContext_Item()
EEL2: MediaItem extension_api("BR_GetMouseCursorContext_Item")
Lua: MediaItem = reaper.BR_GetMouseCursorContext_Item()
Python: MediaItem BR_GetMouseCursorContext_Item()
Description:[BR] Returns item under mouse cursor that was captured with the last call to
BR_GetMouseCursorContext. Note that the function will return item even if mouse cursor is over some other track lane element like stretch marker or envelope. This enables for easier identification of items when you want to ignore elements within the item.
| Returnvalues: |
| MediaItem | - |
|
^ 
BR_GetMouseCursorContext_MIDI(SWS)Functioncall:
C: void* BR_GetMouseCursorContext_MIDI(bool* inlineEditorOut, int* noteRowOut, int* ccLaneOut, int* ccLaneValOut, int* ccLaneIdOut)
EEL2: void* extension_api("BR_GetMouseCursorContext_MIDI", bool &inlineEditor, int ¬eRow, int &ccLane, int &ccLaneVal, int &ccLaneId)
Lua: identifier retval, boolean inlineEditor, number noteRow, number ccLane, number ccLaneVal, number ccLaneId = reaper.BR_GetMouseCursorContext_MIDI()
Python: (void retval, Boolean inlineEditorOut, Int noteRowOut, Int ccLaneOut, Int ccLaneValOut, Int ccLaneIdOut) = BR_GetMouseCursorContext_MIDI(inlineEditorOut, noteRowOut, ccLaneOut, ccLaneValOut, ccLaneIdOut)
Description:[BR] Returns midi editor under mouse cursor that was captured with the last call to
BR_GetMouseCursorContext.
inlineEditor: if mouse was captured in inline MIDI editor, this will be true (consequentially, returned MIDI editor will be NULL)
noteRow: note row or piano key under mouse cursor (0-127)
ccLane: CC lane under mouse cursor (CC0-127=CC, 0x100|(0-31)=14-bit CC, 0x200=velocity, 0x201=pitch, 0x202=program, 0x203=channel pressure, 0x204=bank/program select, 0x205=text, 0x206=sysex, 0x207=off velocity, 0x208=notation events)
ccLaneVal: value in CC lane under mouse cursor (0-127 or 0-16383)
ccLaneId: lane position, counting from the top (0 based)
Note: due to API limitations, if mouse is over inline MIDI editor with some note rows hidden, noteRow will be -1
| Returnvalues: |
| retval | - |
|
| inlineEditor | - |
|
| noteRow | - |
|
| ccLane | - |
|
| ccLaneVal | - |
|
| ccLaneId | - |
|
^ 
BR_GetMouseCursorContext_Position(SWS)Functioncall:
C: double BR_GetMouseCursorContext_Position()
EEL2: double extension_api("BR_GetMouseCursorContext_Position")
Lua: number = reaper.BR_GetMouseCursorContext_Position()
Python: Float BR_GetMouseCursorContext_Position()
Description:[BR] Returns project time position in arrange/ruler/midi editor that was captured with the last call to
BR_GetMouseCursorContext.
^ 
BR_GetMouseCursorContext_StretchMarker(SWS)Functioncall:
C: int BR_GetMouseCursorContext_StretchMarker()
EEL2: int extension_api("BR_GetMouseCursorContext_StretchMarker")
Lua: integer = reaper.BR_GetMouseCursorContext_StretchMarker()
Python: Int BR_GetMouseCursorContext_StretchMarker()
Description:[BR] Returns id of a stretch marker under mouse cursor that was captured with the last call to
BR_GetMouseCursorContext.
^ 
BR_GetMouseCursorContext_Take(SWS)Functioncall:
C: MediaItem_Take* BR_GetMouseCursorContext_Take()
EEL2: MediaItem_Take extension_api("BR_GetMouseCursorContext_Take")
Lua: MediaItem_Take = reaper.BR_GetMouseCursorContext_Take()
Python: MediaItem_Take BR_GetMouseCursorContext_Take()
Description:
| Returnvalues: |
| MediaItem_Take | - |
|
^ 
BR_GetMouseCursorContext_Track(SWS)Functioncall:
C: MediaTrack* BR_GetMouseCursorContext_Track()
EEL2: MediaTrack extension_api("BR_GetMouseCursorContext_Track")
Lua: MediaTrack = reaper.BR_GetMouseCursorContext_Track()
Python: MediaTrack BR_GetMouseCursorContext_Track()
Description:
| Returnvalues: |
| MediaTrack | - |
|
^ 
BR_GetNextGridDivision(SWS)Functioncall:
C: double BR_GetNextGridDivision(double position)
EEL2: double extension_api("BR_GetNextGridDivision", position)
Lua: number = reaper.BR_GetNextGridDivision(number position)
Python: Float BR_GetNextGridDivision(Float position)
Description:
^ 
BR_GetPrevGridDivision(SWS)Functioncall:
C: double BR_GetPrevGridDivision(double position)
EEL2: double extension_api("BR_GetPrevGridDivision", position)
Lua: number = reaper.BR_GetPrevGridDivision(number position)
Python: Float BR_GetPrevGridDivision(Float position)
Description:
^ 
BR_GetSetTrackSendInfo(SWS)Functioncall:
C: double BR_GetSetTrackSendInfo(MediaTrack* track, int category, int sendidx, const char* parmname, bool setNewValue, double newValue)
EEL2: double extension_api("BR_GetSetTrackSendInfo", MediaTrack track, int category, int sendidx, "parmname", bool setNewValue, newValue)
Lua: number = reaper.BR_GetSetTrackSendInfo(MediaTrack track, integer category, integer sendidx, string parmname, boolean setNewValue, number newValue)
Python: Float BR_GetSetTrackSendInfo(MediaTrack track, Int category, Int sendidx, String parmname, Boolean setNewValue, Float newValue)
Description:[BR] Get or set send attributes.
category is <0 for receives, 0=sends, >0 for hardware outputs
sendidx is zero-based (see
GetTrackNumSends to count track sends/receives/hardware outputs)
To set attribute, pass setNewValue as true
List of possible parameters:
B_MUTE : send mute state (1.0 if muted, otherwise 0.0)
B_PHASE : send phase state (1.0 if phase is inverted, otherwise 0.0)
B_MONO : send mono state (1.0 if send is set to mono, otherwise 0.0)
D_VOL : send volume (1.0=+0dB etc...)
D_PAN : send pan (-1.0=100%L, 0=center, 1.0=100%R)
D_PANLAW : send pan law (1.0=+0.0db, 0.5=-6dB, -1.0=project default etc...)
I_SENDMODE : send mode (0=post-fader, 1=pre-fx, 2=post-fx(deprecated), 3=post-fx)
I_SRCCHAN : audio source starting channel index or -1 if audio send is disabled (&1024=mono...note that in that case, when reading index, you should do (index XOR 1024) to get starting channel index)
I_DSTCHAN : audio destination starting channel index (&1024=mono (and in case of hardware output &512=rearoute)...note that in that case, when reading index, you should do (index XOR (1024 OR 512)) to get starting channel index)
I_MIDI_SRCCHAN : source MIDI channel, -1 if MIDI send is disabled (0=all, 1-16)
I_MIDI_DSTCHAN : destination MIDI channel, -1 if MIDI send is disabled (0=original, 1-16)
I_MIDI_SRCBUS : source MIDI bus, -1 if MIDI send is disabled (0=all, otherwise bus index)
I_MIDI_DSTBUS : receive MIDI bus, -1 if MIDI send is disabled (0=all, otherwise bus index)
I_MIDI_LINK_VOLPAN : link volume/pan controls to MIDI
Note: To get or set other send attributes, see
BR_GetMediaTrackSendInfo_Envelope and
BR_GetMediaTrackSendInfo_Track.
| Parameters: |
| track | - |
|
| category | - |
|
| sendidx | - |
|
| parmname | - |
|
| setNewValue | - |
|
| newValue | - |
|
^ 
BR_GetTakeFXCount(SWS)Functioncall:
C: int BR_GetTakeFXCount(MediaItem_Take* take)
EEL2: int extension_api("BR_GetTakeFXCount", MediaItem_Take take)
Lua: integer = reaper.BR_GetTakeFXCount(MediaItem_Take take)
Python: Int BR_GetTakeFXCount(MediaItem_Take take)
Description:[BR] Returns FX count for supplied take
^ 
BR_IsMidiOpenInInlineEditor(SWS)Functioncall:
C: bool BR_IsMidiOpenInInlineEditor(MediaItem_Take* take)
EEL2: bool extension_api("BR_IsMidiOpenInInlineEditor", MediaItem_Take take)
Lua: boolean = reaper.BR_IsMidiOpenInInlineEditor(MediaItem_Take take)
Python: Boolean BR_IsMidiOpenInInlineEditor(MediaItem_Take take)
Description:[SWS] Check if take has MIDI inline editor open and returns true or false.
^ 
BR_IsTakeMidi(SWS)Functioncall:
C: bool BR_IsTakeMidi(MediaItem_Take* take, bool* inProjectMidiOut)
EEL2: bool extension_api("BR_IsTakeMidi", MediaItem_Take take, bool &inProjectMidi)
Lua: boolean retval, boolean inProjectMidi = reaper.BR_IsTakeMidi(MediaItem_Take take)
Python: (Boolean retval, MediaItem_Take take, Boolean inProjectMidiOut) = BR_IsTakeMidi(take, inProjectMidiOut)
Description:[BR] Check if take is MIDI take, in case MIDI take is in-project MIDI source data, inProjectMidiOut will be true, otherwise false.
| Returnvalues: |
| retval | - | |
| inProjectMidi | - | |
^ 
BR_ItemAtMouseCursor(SWS)Functioncall:
C: MediaItem* BR_ItemAtMouseCursor(double* positionOut)
EEL2: MediaItem extension_api("BR_ItemAtMouseCursor", &position)
Lua: MediaItem retval, number position = reaper.BR_ItemAtMouseCursor()
Python: (MediaItem retval, Float positionOut) = BR_ItemAtMouseCursor(positionOut)
Description:[BR] Get media item under mouse cursor. Position is mouse cursor position in arrange.
| Returnvalues: |
| retval | - | |
| position | - | |
^ 
BR_MIDI_CCLaneRemove(SWS)Functioncall:
C: bool BR_MIDI_CCLaneRemove(vpid* midiEditor, int laneId)
EEL2: bool extension_api("BR_MIDI_CCLaneRemove", void* midiEditor, int laneId)
Lua: boolean = reaper.BR_MIDI_CCLaneRemove(identifier midiEditor, integer laneId)
Python: Boolean BR_MIDI_CCLaneRemove(void midiEditor, Int laneId)
Description:[BR] Remove CC lane in midi editor. Top visible CC lane is laneId 0. Returns true on success
| Parameters: |
| midiEditor | - | |
| laneId | - | |
^ 
BR_MIDI_CCLaneReplace(SWS)Functioncall:
C: bool BR_MIDI_CCLaneReplace(void* midiEditor, int laneId, int newCC)
EEL2: bool extension_api("BR_MIDI_CCLaneReplace", void* midiEditor, int laneId, int newCC)
Lua: boolean = reaper.BR_MIDI_CCLaneReplace(identifier midiEditor, integer laneId, integer newCC)
Python: Boolean BR_MIDI_CCLaneReplace(void midiEditor, Int laneId, Int newCC)
Description:[BR] Replace CC lane in midi editor. Top visible CC lane is laneId 0. Returns true on success.
Valid CC lanes: CC0-127=CC, 0x100|(0-31)=14-bit CC, 0x200=velocity, 0x201=pitch, 0x202=program, 0x203=channel pressure, 0x204=bank/program select, 0x205=text, 0x206=sysex, 0x207
| Parameters: |
| midiEditor | - | |
| laneId | - | |
| newCC | - | |
^ 
BR_PositionAtMouseCursor(SWS)Functioncall:
C: double BR_PositionAtMouseCursor(bool checkRuler)
EEL2: double extension_api("BR_PositionAtMouseCursor", bool checkRuler)
Lua: number = reaper.BR_PositionAtMouseCursor(boolean checkRuler)
Python: Float BR_PositionAtMouseCursor(Boolean checkRuler)
Description:[BR] Get position at mouse cursor. To check ruler along with arrange, pass checkRuler=true. Returns -1 if cursor is not over arrange/ruler.
^ 
BR_SetArrangeView(SWS)Functioncall:
C: void BR_SetArrangeView(ReaProject* proj, double startTime, double endTime)
EEL2: extension_api("BR_SetArrangeView", ReaProject proj, startTime, endTime)
Lua: reaper.BR_SetArrangeView(ReaProject proj, number startTime, number endTime)
Python: BR_SetArrangeView(ReaProject proj, Float startTime, Float endTime)
Description:
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| startTime | - | the new starttime of the arrangewview in seconds
|
| endTime | - | the new endtime of the arrangewview in seconds
|
^ 
BR_SetItemEdges(SWS)Functioncall:
C: bool BR_SetItemEdges(MediaItem* item, double startTime, double endTime)
EEL2: bool extension_api("BR_SetItemEdges", MediaItem item, startTime, endTime)
Lua: boolean = reaper.BR_SetItemEdges(MediaItem item, number startTime, number endTime)
Python: Boolean BR_SetItemEdges(MediaItem item, Float startTime, Float endTime)
Description:[BR] Set item start and end edges' position - returns true in case of any changes
| Parameters: |
| item | - | |
| startTime | - | |
| endTime | - | |
^ 
BR_SetMediaItemImageResource(SWS)Functioncall:
C: void BR_SetMediaItemImageResource(MediaItem* item, const char* imageIn, int imageFlags)
EEL2: extension_api("BR_SetMediaItemImageResource", MediaItem item, "imageIn", int imageFlags)
Lua: reaper.BR_SetMediaItemImageResource(MediaItem item, string imageIn, integer imageFlags)
Python: BR_SetMediaItemImageResource(MediaItem item, String imageIn, Int imageFlags)
Description:[BR] Set image resource and its flags for a given item. To clear current image resource, pass imageIn as "".
imageFlags: &1=0: don't display image, &1: center / tile, &3: stretch, &5: full height (REAPER 5.974+).
To get image resource, see
BR_GetMediaItemImageResource.
| Parameters: |
| item | - |
|
| imageIn | - |
|
| imageFlags | - |
|
^ 
BR_SetMediaSourceProperties(SWS)Functioncall:
C: bool BR_SetMediaSourceProperties(MediaItem_Take* take, bool section, double start, double length, double fade, bool reverse)
EEL2: bool extension_api("BR_SetMediaSourceProperties", MediaItem_Take take, bool section, start, length, fade, bool reverse)
Lua: boolean = reaper.BR_SetMediaSourceProperties(MediaItem_Take take, boolean section, number start, number length, number fade, boolean reverse)
Python: Boolean BR_SetMediaSourceProperties(MediaItem_Take take, Boolean section, Float start, Float length, Float fade, Boolean reverse)
Description:[BR] Set take media source properties. Returns false if take can't have them (MIDI items etc.). Section parameters have to be valid only when passing section=true.
To get source properties, see
BR_GetMediaSourceProperties.
| Parameters: |
| take | - |
|
| section | - |
|
| start | - |
|
| length | - |
|
| fade | - |
|
| reverse | - |
|
^ 
BR_SetMediaTrackLayouts(SWS)Functioncall:
C: bool BR_SetMediaTrackLayouts(MediaTrack* track, const char* mcpLayoutNameIn, const char* tcpLayoutNameIn)
EEL2: bool extension_api("BR_SetMediaTrackLayouts", MediaTrack track, "mcpLayoutNameIn", "tcpLayoutNameIn")
Lua: boolean = reaper.BR_SetMediaTrackLayouts(MediaTrack track, string mcpLayoutNameIn, string tcpLayoutNameIn)
Python: Boolean BR_SetMediaTrackLayouts(MediaTrack track, String mcpLayoutNameIn, String tcpLayoutNameIn)
Description:[BR] Deprecated, see
GetSetMediaTrackInfo (REAPER v5.02+). Set media track layouts for MCP and TCP. To set default layout, pass empty string ("") as layout name. In case layouts were successfully set, returns true (if layouts are already set to supplied layout names, it will return false since no changes were made).
To get media track layouts, see
BR_GetMediaTrackLayouts.
| Parameters: |
| track | - |
|
| mcpLayoutNameIn | - |
|
| tcpLayoutNameIn | - |
|
^ 
BR_SetMidiTakeTempoInfo(SWS)Functioncall:
C: bool BR_SetMidiTakeTempoInfo(MediaItem_Take* take, bool ignoreProjTempo, double bpm, int num, int den)
EEL2: bool extension_api("BR_SetMidiTakeTempoInfo", MediaItem_Take take, bool ignoreProjTempo, bpm, int num, int den)
Lua: boolean = reaper.BR_SetMidiTakeTempoInfo(MediaItem_Take take, boolean ignoreProjTempo, number bpm, integer num, integer den)
Python: Boolean BR_SetMidiTakeTempoInfo(MediaItem_Take take, Boolean ignoreProjTempo, Float bpm, Int num, Int den)
Description:[BR] Set "ignore project tempo" information for MIDI take. Returns true in case the take was successfully updated.
| Parameters: |
| take | - | |
| ignoreProjTempo | - | |
| bpm | - | |
| num | - | |
| den | - | |
^ 
BR_SetTakeSourceFromFile(SWS)Functioncall:
C: bool BR_SetTakeSourceFromFile(MediaItem_Take* take, const char* filenameIn, bool inProjectData)
EEL2: bool extension_api("BR_SetTakeSourceFromFile", MediaItem_Take take, "filenameIn", bool inProjectData)
Lua: boolean = reaper.BR_SetTakeSourceFromFile(MediaItem_Take take, string filenameIn, boolean inProjectData)
Python: Boolean BR_SetTakeSourceFromFile(MediaItem_Take take, String filenameIn, Boolean inProjectData)
Description:[BR] Set new take source from file. To import MIDI file as in-project source data pass inProjectData=true. Returns false if failed.
Any take source properties from the previous source will be lost - to preserve them, see
BR_SetTakeSourceFromFile2.
Note: To set source from existing take, see
SNM_GetSetSourceState2.
| Parameters: |
| take | - |
|
| filenameIn | - |
|
| inProjectData | - |
|
^ 
BR_SetTakeSourceFromFile2(SWS)Functioncall:
C: bool BR_SetTakeSourceFromFile2(MediaItem_Take* take, const char* filenameIn, bool inProjectData, bool keepSourceProperties)
EEL2: bool extension_api("BR_SetTakeSourceFromFile2", MediaItem_Take take, "filenameIn", bool inProjectData, bool keepSourceProperties)
Lua: boolean = reaper.BR_SetTakeSourceFromFile2(MediaItem_Take take, string filenameIn, boolean inProjectData, boolean keepSourceProperties)
Python: Boolean BR_SetTakeSourceFromFile2(MediaItem_Take take, String filenameIn, Boolean inProjectData, Boolean keepSourceProperties)
Description:
| Parameters: |
| take | - |
|
| filenameIn | - |
|
| inProjectData | - |
|
| keepSourceProperties | - |
|
^ 
BR_TakeAtMouseCursor(SWS)Functioncall:
C: MediaItem_Take* BR_TakeAtMouseCursor(double* positionOut)
EEL2: MediaItem_Take extension_api("BR_TakeAtMouseCursor", &position)
Lua: MediaItem_Take retval, number position = reaper.BR_TakeAtMouseCursor()
Python: (MediaItem_Take retval, Float positionOut) = BR_TakeAtMouseCursor(positionOut)
Description:[BR] Get take under mouse cursor. Position is mouse cursor position in arrange.
| Returnvalues: |
| retval | - | |
| position | - | |
^ 
BR_TrackAtMouseCursor(SWS)Functioncall:
C: MediaTrack* BR_TrackAtMouseCursor(int* contextOut, double* positionOut)
EEL2: MediaTrack extension_api("BR_TrackAtMouseCursor", int &context, &position)
Lua: MediaTrack retval, number context, number position = reaper.BR_TrackAtMouseCursor()
Python: (MediaTrack retval, Int contextOut, Float positionOut) = BR_TrackAtMouseCursor(contextOut, positionOut)
Description:[BR] Get track under mouse cursor.
Context signifies where the track was found: 0 = TCP, 1 = MCP, 2 = Arrange.
Position will hold mouse cursor position in arrange if applicable.
| Returnvalues: |
| retval | - | |
| context | - | |
| position | - | |
^ 
BR_TrackFX_GetFXModuleName(SWS)Functioncall:
C: bool BR_TrackFX_GetFXModuleName(MediaTrack* track, int fx, char* nameOut, int nameOut_sz)
EEL2: bool extension_api("BR_TrackFX_GetFXModuleName", MediaTrack track, int fx, #name)
Lua: boolean retval, string name = reaper.BR_TrackFX_GetFXModuleName(MediaTrack track, integer fx)
Python: (Boolean retval, MediaTrack track, Int fx, String nameOut, Int nameOut_sz) = BR_TrackFX_GetFXModuleName(track, fx, nameOut, nameOut_sz)
Description:[BR] Get the exact name (like effect.dll, effect.vst3, etc...) of an FX.
| Parameters: |
| MediaTrack track | - | |
| integer fx | - | |
| Returnvalues: |
| boolean retval | - | |
| string name | - | |
^ 
BR_Win32_GetPrivateProfileString(SWS)Functioncall:
C: int BR_Win32_GetPrivateProfileString(const char* sectionName, const char* keyName, const char* defaultString, const char* filePath, char* stringOut, int stringOut_sz)
EEL2: int extension_api("BR_Win32_GetPrivateProfileString", "sectionName", "keyName", "defaultString", "filePath", #string)
Lua: integer retval, string value = reaper.BR_Win32_GetPrivateProfileString(string sectionName, string keyName, string defaultString, string filePath)
Python: (Int retval, String sectionName, String keyName, String defaultString, String filePath, String stringOut, Int stringOut_sz) = BR_Win32_GetPrivateProfileString(sectionName, keyName, defaultString, filePath, stringOut, stringOut_sz)
Description:[BR] Equivalent to win32 API GetPrivateProfileString(). For example, you can use this to get values from REAPER.ini
If you have multiple sections in that file with the same name, only the first one will be used, the rest will be ignored by Reaper.
If you have multiple keys with the same name within a section, only the first one will be used, the rest will be ignored by Reaper.
You can get the paths using
GetExePath for the Reaper-application-folder,
GetResourcePath for the ressources-folder or get_ini_file for the path+filename of the Reaper.ini-file.
| Parameters: |
| string sectionName | - | the [section] in which the key is stored, you'd like to get
|
| string keyName | - | the key from the [section], whose value you'd like to get
|
| string defaultString | - | a default value that will be returned, if the [section] and/or key does not exist in the ini-file yet.
|
| string filePath | - | the path+filename, where the [section] and key are stored
|
| Returnvalues: |
| integer retval | - | number of characters of the value
|
| string value | - | the value of that key
|
^ 
BR_Win32_ShellExecute(SWS)Functioncall:
C: int BR_Win32_ShellExecute(const char* operation, const char* file, const char* parameters, const char* directory, int showFlags)
EEL2: int extension_api("BR_Win32_ShellExecute", "operation", "file", "parameters", "directory", int showFlags)
Lua: integer = reaper.BR_Win32_ShellExecute(string operation, string file, string parameters, string directory, integer showFlags)
Python: Int BR_Win32_ShellExecute(String operation, String file, String parameters, String directory, Int showFlags)
Description:[BR] Equivalent to win32 API ShellExecute() with HWND set to main window
| Parameters: |
| operation | - | |
| file | - | |
| parameters | - | |
| directory | - | |
| showFlags | - | |
^ 
BR_Win32_WritePrivateProfileString(SWS)Functioncall:
C: bool BR_Win32_WritePrivateProfileString(const char* sectionName, const char* keyName, const char* value, const char* filePath)
EEL2: bool extension_api("BR_Win32_WritePrivateProfileString", "sectionName", "keyName", "value", "filePath")
Lua: boolean = reaper.BR_Win32_WritePrivateProfileString(string sectionName, string keyName, string value, string filePath)
Python: Boolean BR_Win32_WritePrivateProfileString(String sectionName, String keyName, String value, String filePath)
Description:[BR] Equivalent to win32 API WritePrivateProfileString(). For example, you can use this to write to REAPER.ini
If you have multiple sections in that file with the same name, only the first one will be used, the rest will be ignored by Reaper.
If you have multiple keys with the same name within a section, only the first one will be used, the rest will be ignored by Reaper.
You can get the paths using
GetExePath for the Reaper-application-folder,
GetResourcePath for the ressources-folder or
get_ini_file for the path+filename of the Reaper.ini-file.
| Parameters: |
| sectionName | - | the [section] in which the key is stored, you'd like to set
|
| keyName | - | the key from the [section], whose value you'd like to set
|
| value | - | the value you want to have set to the key
|
| filePath | - | the path+filename, where the [section] and key are going to be stored
|
| Returnvalues: |
| boolean | - | true, if it worked; false, if not
|
^
Blink_GetBeatAtTimeFunctioncall:
C: double Blink_GetBeatAtTime(double time, double quantum)
EEL2: double extension_api("Blink_GetBeatAtTime", time, quantum)
Lua: number reaper.Blink_GetBeatAtTime(number time, number quantum)
Python: double Blink_GetBeatAtTime(double time, double quantum)
Description:Get session beat value corresponding to given time for given quantum.
| Parameters: |
| number time | - | |
| number quantum | - | |
^
Blink_GetClockNowFunctioncall:
C: double Blink_GetClockNow()
EEL2: double extension_api("Blink_GetClockNow")
Lua: number reaper.Blink_GetClockNow()
Python: double Blink_GetClockNow()
Description:Clock used by Blink.
^
Blink_GetEnabledFunctioncall:
C: bool Blink_GetEnabled()
EEL2: bool extension_api("Blink_GetEnabled")
Lua: boolean reaper.Blink_GetEnabled()
Python: bool Blink_GetEnabled()
Description:Is Blink currently enabled?
^
Blink_GetMasterFunctioncall:
C: bool Blink_GetMaster()
EEL2: bool extension_api("Blink_GetMaster")
Lua: boolean reaper.Blink_GetMaster()
Python: bool Blink_GetMaster()
Description:Is Blink Master?
^
Blink_GetNumPeersFunctioncall:
C: int Blink_GetNumPeers()
EEL2: int extension_api("Blink_GetNumPeers")
Lua: integer reaper.Blink_GetNumPeers()
Python: int Blink_GetNumPeers()
Description:How many peers are currently connected in Link session?
^
Blink_GetPhaseAtTimeFunctioncall:
C: double Blink_GetPhaseAtTime(double time, double quantum)
EEL2: double extension_api("Blink_GetPhaseAtTime", time, quantum)
Lua: number reaper.Blink_GetPhaseAtTime(number time, number quantum)
Python: double Blink_GetPhaseAtTime(double time, double quantum)
Description:Get session phase at given time for given quantum since beat 0.
| Parameters: |
| number time | - | |
| number quantum | - | |
^
Blink_GetPlayingFunctioncall:
C: bool Blink_GetPlaying()
EEL2: bool extension_api("Blink_GetPlaying")
Lua: boolean reaper.Blink_GetPlaying()
Python: bool Blink_GetPlaying()
Description:Is transport playing?
^
Blink_GetPuppetFunctioncall:
C: bool Blink_GetPuppet()
EEL2: bool extension_api("Blink_GetPuppet")
Lua: boolean reaper.Blink_GetPuppet()
Python: bool Blink_GetPuppet()
Description:Is Blink Puppet?
^
Blink_GetQuantumFunctioncall:
C: double Blink_GetQuantum()
EEL2: double extension_api("Blink_GetQuantum")
Lua: number reaper.Blink_GetQuantum()
Python: double Blink_GetQuantum()
Description:Get quantum.
^
Blink_GetStartStopSyncEnabledFunctioncall:
C: bool Blink_GetStartStopSyncEnabled()
EEL2: bool extension_api("Blink_GetStartStopSyncEnabled")
Lua: boolean reaper.Blink_GetStartStopSyncEnabled()
Python: bool Blink_GetStartStopSyncEnabled()
Description:Is start/stop synchronization enabled?
^
Blink_GetTempoFunctioncall:
C: double Blink_GetTempo()
EEL2: double extension_api("Blink_GetTempo")
Lua: number reaper.Blink_GetTempo()
Python: double Blink_GetTempo()
Description:Tempo of session timeline, in Beats Per Minute.
^
Blink_GetTimeAtBeatFunctioncall:
C: double Blink_GetTimeAtBeat(double beat, double quantum)
EEL2: double extension_api("Blink_GetTimeAtBeat", beat, quantum)
Lua: number reaper.Blink_GetTimeAtBeat(number beat, number quantum)
Python: double Blink_GetTimeAtBeat(double beat, double quantum)
Description:Get time at which given beat occurs for given quantum.
| Parameters: |
| number beat | - | |
| number quantum | - | |
^
Blink_GetTimeForPlayingFunctioncall:
C: double Blink_GetTimeForPlaying()
EEL2: double extension_api("Blink_GetTimeForPlaying")
Lua: number reaper.Blink_GetTimeForPlaying()
Python: double Blink_GetTimeForPlaying()
Description:Get time at which transport start/stop occurs.
^
Blink_SetBeatAtStartPlayingTimeRequestFunctioncall:
C: void Blink_SetBeatAtStartPlayingTimeRequest(double beat, double quantum)
EEL2: extension_api("Blink_SetBeatAtStartPlayingTimeRequest", beat, quantum)
Lua: reaper.Blink_SetBeatAtStartPlayingTimeRequest(number beat, number quantum)
Python: void Blink_SetBeatAtStartPlayingTimeRequest(double beat, double quantum)
Description:Convenience function to attempt to map given beat to time when transport is starting to play in context of given quantum. This function evaluates to a no-op if GetPlaying() equals false.
| Parameters: |
| number beat | - | |
| number quantum | - | |
^
Blink_SetBeatAtTimeForceFunctioncall:
C: void Blink_SetBeatAtTimeForce(double bpm, double time, double quantum)
EEL2: extension_api("Blink_SetBeatAtTimeForce", bpm, time, quantum)
Lua: reaper.Blink_SetBeatAtTimeForce(number bpm, number time, number quantum)
Python: void Blink_SetBeatAtTimeForce(double bpm, double time, double quantum)
Description:Rudely re-map the beat/time relationship for all peers in Link session.
| Parameters: |
| number bpm | - | |
| number time | - | |
| number quantum | - | |
^
Blink_SetBeatAtTimeRequestFunctioncall:
C: void Blink_SetBeatAtTimeRequest(double bpm, double time, double quantum)
EEL2: extension_api("Blink_SetBeatAtTimeRequest", bpm, time, quantum)
Lua: reaper.Blink_SetBeatAtTimeRequest(number bpm, number time, number quantum)
Python: void Blink_SetBeatAtTimeRequest(double bpm, double time, double quantum)
Description:Attempt to map given beat to given time in context of given quantum.
| Parameters: |
| number bpm | - | |
| number time | - | |
| number quantum | - | |
^
Blink_SetCaptureTransportCommandsFunctioncall:
C: void Blink_SetCaptureTransportCommands(bool enable)
EEL2: extension_api("Blink_SetCaptureTransportCommands", bool enable)
Lua: reaper.Blink_SetCaptureTransportCommands(boolean enable)
Python: void Blink_SetCaptureTransportCommands(bool enable)
Description:Captures REAPER 'Transport: Play/stop' and 'Tempo: Increase/Decrease current project tempo by 01 BPM' commands and broadcasts them into Link session. When used with Master or Puppet mode enabled, provides better integration between REAPER and Link session transport and tempos.
| Parameters: |
| boolean enable | - | |
^
Blink_SetEnabledFunctioncall:
C: void Blink_SetEnabled(bool enable)
EEL2: extension_api("Blink_SetEnabled", bool enable)
Lua: reaper.Blink_SetEnabled(boolean enable)
Python: void Blink_SetEnabled(bool enable)
Description:Enable/disable Blink.
| Parameters: |
| boolean enable | - | |
^
Blink_SetMasterFunctioncall:
C: void Blink_SetMaster(bool enable)
EEL2: extension_api("Blink_SetMaster", bool enable)
Lua: reaper.Blink_SetMaster(boolean enable)
Python: void Blink_SetMaster(bool enable)
Description:Set Blink as Master. Puppet needs to be enabled first. Same as Puppet, but possible beat offset is broadcast to Link session, effectively forcing local REAPER timeline on peers. Only one, if any, Blink should be Master in Link session.
| Parameters: |
| boolean enable | - | |
^
Blink_SetPlayingFunctioncall:
C: void Blink_SetPlaying(bool playing, double time)
EEL2: extension_api("Blink_SetPlaying", bool playing, time)
Lua: reaper.Blink_SetPlaying(boolean playing, number time)
Python: void Blink_SetPlaying(bool playing, double time)
Description:Set if transport should be playing or stopped, taking effect at given time.
| Parameters: |
| boolean playing | - | |
| number time | - | |
^
Blink_SetPlayingAndBeatAtTimeRequestFunctioncall:
C: void Blink_SetPlayingAndBeatAtTimeRequest(bool playing, double time, double beat, double quantum)
EEL2: extension_api("Blink_SetPlayingAndBeatAtTimeRequest", bool playing, time, beat, quantum)
Lua: reaper.Blink_SetPlayingAndBeatAtTimeRequest(boolean playing, number time, number beat, number quantum)
Python: void Blink_SetPlayingAndBeatAtTimeRequest(bool playing, double time, double beat, double quantum)
Description:Convenience function to start or stop transport at given time and attempt to map given beat to this time in context of given quantum.
| Parameters: |
| boolean playing | - | |
| number time | - | |
| number beat | - | |
| number quantum | - | |
^
Blink_SetPuppetFunctioncall:
C: void Blink_SetPuppet(bool enable)
EEL2: extension_api("Blink_SetPuppet", bool enable)
Lua: reaper.Blink_SetPuppet(boolean enable)
Python: void Blink_SetPuppet(bool enable)
Description:Set Blink as Puppet. When enabled, Blink attempts to synchronize local REAPER tempo to Link session tempo by adjusting current active tempo time signature marker and to correct possible offset by adjusting playrate. Based on cumulative single beat phase since Link session playback beat 0, regardless of quantum.
| Parameters: |
| boolean enable | - | |
^
Blink_SetQuantumFunctioncall:
C: void Blink_SetQuantum(double quantum)
EEL2: extension_api("Blink_SetQuantum", quantum)
Lua: reaper.Blink_SetQuantum(number quantum)
Python: void Blink_SetQuantum(double quantum)
Description:Set quantum. Usually this is set to length of one measure/bar in quarter notes.
| Parameters: |
| number quantum | - | |
^
Blink_SetStartStopSyncEnabledFunctioncall:
C: void Blink_SetStartStopSyncEnabled(bool enable)
EEL2: extension_api("Blink_SetStartStopSyncEnabled", bool enable)
Lua: reaper.Blink_SetStartStopSyncEnabled(boolean enable)
Python: void Blink_SetStartStopSyncEnabled(bool enable)
Description:Enable start/stop synchronization.
| Parameters: |
| boolean enable | - | |
^
Blink_SetTempoFunctioncall:
C: void Blink_SetTempo(double bpm)
EEL2: extension_api("Blink_SetTempo", bpm)
Lua: reaper.Blink_SetTempo(number bpm)
Python: void Blink_SetTempo(double bpm)
Description:Set tempo to given bpm value.
^
Blink_SetTempoAtTimeFunctioncall:
C: void Blink_SetTempoAtTime(double bpm, double time)
EEL2: extension_api("Blink_SetTempoAtTime", bpm, time)
Lua: reaper.Blink_SetTempoAtTime(number bpm, number time)
Python: void Blink_SetTempoAtTime(double bpm, double time)
Description:Set tempo to given bpm value, taking effect at given time.
| Parameters: |
| number bpm | - | |
| number time | - | |
^
Blink_StartStopFunctioncall:
C: void Blink_StartStop()
EEL2: extension_api("Blink_StartStop")
Lua: reaper.Blink_StartStop()
Python: void Blink_StartStop()
Description:Transport start/stop.
^ 
CF_GetClipboard(SWS)Functioncall:
C: void CF_GetClipboard(char* textOutNeedBig, int textOutNeedBig_sz)
EEL2: extension_api("CF_GetClipboard", #text)
Lua: string text = reaper.CF_GetClipboard()
Python: (String textOutNeedBig, Int textOutNeedBig_sz) = CF_GetClipboard(textOutNeedBig, textOutNeedBig_sz)
Description:Read the contents of the system clipboard.
| Returnvalues: |
| string text | - | the content of the clipboard |
^ 
CF_GetClipboardBig(SWS)Functioncall:
C: const char* CF_GetClipboardBig(WDL_FastString* output)
EEL2: bool extension_api("CF_GetClipboardBig", #retval, WDL_FastString output)
Lua: string = reaper.CF_GetClipboardBig(WDL_FastString output)
Python: String CF_GetClipboardBig(WDL_FastString output)
Description:
| Parameters: |
| WDL_FastString output | - | a faststring used by this
|
| Returnvalues: |
| string | - | the content of the clipboard
|
^ 
CF_SetClipboard(SWS)Functioncall:
C: void CF_SetClipboard(const char* str)
EEL2: extension_api("CF_SetClipboard", "str")
Lua: reaper.CF_SetClipboard(string str)
Python: CF_SetClipboard(String str)
Description:Write the given string into the system clipboard.
| Parameters: |
| str | - | the string to put into the clipboard |
^ 
FNG_AddMidiNote(SWS)Functioncall:
C: RprMidiNote* FNG_AddMidiNote(RprMidiTake* midiTake)
EEL2: RprMidiNote extension_api("FNG_AddMidiNote", RprMidiTake midiTake)
Lua: RprMidiNote = reaper.FNG_AddMidiNote(RprMidiTake midiTake)
Python: RprMidiNote FNG_AddMidiNote(RprMidiTake midiTake)
Description:[FNG]Add MIDI note to MIDI take
| Returnvalues: |
| RprMidiNote | - | |
^ 
FNG_AllocMidiTake(SWS)Functioncall:
C: RprMidiTake* FNG_AllocMidiTake(MediaItem_Take* take)
EEL2: RprMidiTake extension_api("FNG_AllocMidiTake", MediaItem_Take take)
Lua: RprMidiTake = reaper.FNG_AllocMidiTake(MediaItem_Take take)
Python: RprMidiTake FNG_AllocMidiTake(MediaItem_Take take)
Description:[FNG]Allocate a RprMidiTake from a take pointer. Returns a NULL pointer if the take is not an in-project MIDI take
| Returnvalues: |
| RprMidiTake | - | |
^ 
FNG_CountMidiNotes(SWS)Functioncall:
C: int FNG_CountMidiNotes(RprMidiTake* midiTake)
EEL2: int extension_api("FNG_CountMidiNotes", RprMidiTake midiTake)
Lua: integer = reaper.FNG_CountMidiNotes(RprMidiTake midiTake)
Python: Int FNG_CountMidiNotes(RprMidiTake midiTake)
Description:[FNG]Count of how many MIDI notes are in the MIDI take
^ 
FNG_FreeMidiTake(SWS)Functioncall:
C: void FNG_FreeMidiTake(RprMidiTake* midiTake)
EEL2: extension_api("FNG_FreeMidiTake", RprMidiTake midiTake)
Lua: reaper.FNG_FreeMidiTake(RprMidiTake midiTake)
Python: FNG_FreeMidiTake(RprMidiTake midiTake)
Description:[FNG]Commit changes to MIDI take and free allocated memory
^ 
FNG_GetMidiNote(SWS)Functioncall:
C: RprMidiNote* FNG_GetMidiNote(RprMidiTake* midiTake, int index)
EEL2: RprMidiNote extension_api("FNG_GetMidiNote", RprMidiTake midiTake, int index)
Lua: RprMidiNote = reaper.FNG_GetMidiNote(RprMidiTake midiTake, integer index)
Python: RprMidiNote FNG_GetMidiNote(RprMidiTake midiTake, Int index)
Description:[FNG]Get a MIDI note from a MIDI take at specified index
| Parameters: |
| midiTake | - | |
| index | - | |
| Returnvalues: |
| RprMidiNote | - | |
^ 
FNG_GetMidiNoteIntProperty(SWS)Functioncall:
C: int FNG_GetMidiNoteIntProperty(RprMidiNote* midiNote, const char* property)
EEL2: int extension_api("FNG_GetMidiNoteIntProperty", RprMidiNote midiNote, "property")
Lua: integer = reaper.FNG_GetMidiNoteIntProperty(RprMidiNote midiNote, string property)
Python: Int FNG_GetMidiNoteIntProperty(RprMidiNote midiNote, String property)
Description:[FNG]Get MIDI note property
| Parameters: |
| midiNote | - | |
| property | - | |
^ 
FNG_SetMidiNoteIntProperty(SWS)Functioncall:
C: void FNG_SetMidiNoteIntProperty(RprMidiNote* midiNote, const char* property, int value)
EEL2: extension_api("FNG_SetMidiNoteIntProperty", RprMidiNote midiNote, "property", int value)
Lua: reaper.FNG_SetMidiNoteIntProperty(RprMidiNote midiNote, string property, integer value)
Python: FNG_SetMidiNoteIntProperty(RprMidiNote midiNote, String property, Int value)
Description:[FNG]Set MIDI note property
| Parameters: |
| midiNote | - | |
| property | - | |
| value | - | |
^ 
NF_AnalyzeTakeLoudness(SWS)Functioncall:
C: bool NF_AnalyzeTakeLoudness(MediaItem_Take* take, bool analyzeTruePeak, double* lufsIntegratedOut, double* rangeOut, double* truePeakOut, double* truePeakPosOut, double* shortTermMaxOut, double* momentaryMaxOut)
EEL2: bool extension_api("NF_AnalyzeTakeLoudness", MediaItem_Take take, bool analyzeTruePeak, &lufsIntegrated, &range, & truePeak, &truePeakPos, &shortTermMax, &momentaryMax)
Lua: boolean retval, number lufsIntegrated, number range, number truePeak, number truePeakPos, number shortTermMax, number momentaryMax = reaper.NF_AnalyzeTakeLoudness(MediaItem_Take take, boolean analyzeTruePeak)
Python: (Boolean retval, MediaItem_Take take, Boolean analyzeTruePeak, Float lufsIntegratedOut, Float rangeOut, Float truePeakOut, Float truePeakPosOut, Float shortTermMaxOut, Float momentaryMaxOut) = NF_AnalyzeTakeLoudness(take, analyzeTruePeak, lufsIntegratedOut, rangeOut, truePeakOut, truePeakPosOut, shortTermMaxOut, momentaryMaxOut)
Description:Full loudness analysis. retval: returns true on successful analysis, false on MIDI take or when analysis failed for some reason. analyzeTruePeak=true: Also do true peak analysis. Returns true peak value and true peak position (relative to item position). Considerably slower than without true peak analysis (since it uses oversampling). Note: Short term uses a time window of 3 sec. for calculation. So for items shorter than this shortTermMaxOut can't be calculated correctly. Momentary uses a time window of 0.4 sec.
| Parameters: |
| take | - | |
| analyzeTruePeak | - | |
| Returnvalues: |
| retval | - | |
| lufsIntegrated | - | |
| range | - | |
| truePeak | - | |
| truePeakPos | - | |
| shortTermMax | - | |
| momentaryMax | - | |
^ 
NF_AnalyzeTakeLoudness2(SWS)Functioncall:
C: bool NF_AnalyzeTakeLoudness2(MediaItem_Take* take, bool analyzeTruePeak, double* lufsIntegratedOut, double* rangeOut, double* truePeakOut, double* truePeakPosOut, double* shortTermMaxOut, double* momentaryMaxOut, double* shortTermMaxPosOut, double* momentaryMaxPosOut)
EEL2: bool extension_api("NF_AnalyzeTakeLoudness2", MediaItem_Take take, bool analyzeTruePeak, &lufsIntegrated, &range, & truePeak, &truePeakPos, &shortTermMax, &momentaryMax, &shortTermMaxPos, &momentaryMaxPos)
Lua: boolean retval, number lufsIntegrated, number range, number truePeak, number truePeakPos, number shortTermMax, number momentaryMax, number shortTermMaxPos, number momentaryMaxPos = reaper.NF_AnalyzeTakeLoudness2(MediaItem_Take take, boolean analyzeTruePeak)
Python: (Boolean retval, MediaItem_Take take, Boolean analyzeTruePeak, Float lufsIntegratedOut, Float rangeOut, Float truePeakOut, Float truePeakPosOut, Float shortTermMaxOut, Float momentaryMaxOut, Float shortTermMaxPosOut, Float momentaryMaxPosOut) = NF_AnalyzeTakeLoudness2(take, analyzeTruePeak, lufsIntegratedOut, rangeOut, truePeakOut, truePeakPosOut, shortTermMaxOut, momentaryMaxOut, shortTermMaxPosOut, momentaryMaxPosOut)
Description:Same as
NF_AnalyzeTakeLoudness but additionally returns shortTermMaxPos and momentaryMaxPos (in absolute project time). Note: shortTermMaxPos and momentaryMaxPos actually indicate the beginning of time
intervalls, (3 sec. and 0.4 sec. resp.).
| Parameters: |
| take | - |
|
| analyzeTruePeak | - |
|
| Returnvalues: |
| retval | - |
|
| lufsIntegrated | - |
|
| range | - |
|
| truePeak | - |
|
| truePeakPos | - |
|
| shortTermMax | - |
|
| momentaryMax | - |
|
| shortTermMaxPos | - |
|
| momentaryMaxPos | - |
|
^ 
NF_AnalyzeTakeLoudness_IntegratedOnly(SWS)Functioncall:
C: bool NF_AnalyzeTakeLoudness_IntegratedOnly(MediaItem_Take* take, double* lufsIntegratedOut)
EEL2: bool extension_api("NF_AnalyzeTakeLoudness_IntegratedOnly", MediaItem_Take take, &lufsIntegrated)
Lua: boolean retval, number lufsIntegrated = reaper.NF_AnalyzeTakeLoudness_IntegratedOnly(MediaItem_Take take)
Python: (Boolean retval, MediaItem_Take take, Float lufsIntegratedOut) = NF_AnalyzeTakeLoudness_IntegratedOnly(take, lufsIntegratedOut)
Description:Does LUFS integrated analysis only. Faster than full loudness analysis (
NF_AnalyzeTakeLoudness) . Use this if only LUFS integrated is required.
Take vol. env. is taken into account.
See:
Signal flow.
| Returnvalues: |
| retval | - |
|
| lufsIntegrated | - |
|
^ 
NF_GetMediaItemAverageRMS(SWS)Functioncall:
C: double NF_GetMediaItemAverageRMS(MediaItem* item)
EEL2: double extension_api("NF_GetMediaItemAverageRMS", MediaItem item)
Lua: number = reaper.NF_GetMediaItemAverageRMS(MediaItem item)
Python: Float NF_GetMediaItemAverageRMS(MediaItem item)
Description:Returns the average overall (non-windowed) RMS level of active channels of an audio item active take, post item gain, post take volume envelope, post-fade, pre fader, pre item FX.
Returns -150.0 if MIDI take or empty item.
^ 
NF_GetMediaItemMaxPeak(SWS)Functioncall:
C: double NF_GetMediaItemMaxPeak(MediaItem* item)
EEL2: double extension_api("NF_GetMediaItemMaxPeak", MediaItem item)
Lua: number = reaper.NF_GetMediaItemMaxPeak(MediaItem item)
Python: Float NF_GetMediaItemMaxPeak(MediaItem item)
Description:Returns the greatest max. peak value of all active channels of an audio item active take, post item gain, post take volume envelope, post-fade, pre fader, pre item FX.
Returns -150.0 if MIDI take or empty item.
^ 
NF_GetMediaItemPeakRMS_NonWindowed(SWS)Functioncall:
C: double NF_GetMediaItemPeakRMS_NonWindowed(MediaItem* item)
EEL2: double extension_api("NF_GetMediaItemPeakRMS_NonWindowed", MediaItem item)
Lua: number = reaper.NF_GetMediaItemPeakRMS_NonWindowed(MediaItem item)
Python: Float NF_GetMediaItemPeakRMS_NonWindowed(MediaItem item)
Description:Returns the greatest overall (non-windowed) RMS peak level of all active channels of an audio item active take, post item gain, post take volume envelope, post-fade, pre fader, pre item FX.
Returns -150.0 if MIDI take or empty item.
^ 
NF_GetMediaItemPeakRMS_Windowed(SWS)Functioncall:
C: double NF_GetMediaItemPeakRMS_Windowed(MediaItem* item)
EEL2: double extension_api("NF_GetMediaItemPeakRMS_Windowed", MediaItem item)
Lua: number = reaper.NF_GetMediaItemPeakRMS_Windowed(MediaItem item)
Python: Float NF_GetMediaItemPeakRMS_Windowed(MediaItem item)
Description:Returns the average RMS peak level of all active channels of an audio item active take, post item gain, post take volume envelope, post-fade, pre fader, pre item FX.
Obeys 'Window size for peak RMS' setting in 'SWS: Set RMS analysis/normalize options' for calculation. Returns -150.0 if MIDI take or empty item.
^ 
SNM_AddReceive(SWS)Functioncall:
C: bool SNM_AddReceive(MediaTrack* src, MediaTrack* dest, int type)
EEL2: bool extension_api("SNM_AddReceive", MediaTrack src, MediaTrack dest, int type)
Lua: boolean = reaper.SNM_AddReceive(MediaTrack src, MediaTrack dest, integer type)
Python: Boolean SNM_AddReceive(MediaTrack src, MediaTrack dest, Int type)
Description:[S&M] Deprecated, see
CreateTrackSend (v5.15pre1+). Adds a receive. Returns false if nothing updated.
type -1=Default type (user preferences), 0=Post-Fader (Post-Pan), 1=Pre-FX, 2=deprecated, 3=Pre-Fader (Post-FX).
Note: obeys default sends preferences, supports frozen tracks, etc..
| Parameters: |
| src | - |
|
| dest | - |
|
| type | - |
|
^ 
SNM_AddTCPFXParm(SWS)Functioncall:
C: bool SNM_AddTCPFXParm(MediaTrack* tr, int fxId, int prmId)
EEL2: bool extension_api("SNM_AddTCPFXParm", MediaTrack tr, int fxId, int prmId)
Lua: boolean = reaper.SNM_AddTCPFXParm(MediaTrack tr, integer fxId, integer prmId)
Python: Boolean SNM_AddTCPFXParm(MediaTrack tr, Int fxId, Int prmId)
Description:[S&M] Add an FX parameter knob in the TCP. Returns false if nothing updated (invalid parameters, knob already present, etc..)
| Parameters: |
| tr | - | |
| fxId | - | |
| prmId | - | |
^ 
SNM_CreateFastString(SWS)Functioncall:
C: WDL_FastString* SNM_CreateFastString(const char* str)
EEL2: WDL_FastString extension_api("SNM_CreateFastString", "str")
Lua: WDL_FastString = reaper.SNM_CreateFastString(string str)
Python: WDL_FastString SNM_CreateFastString(String str)
Description:
| Returnvalues: |
| WDL_FastString | - |
|
^ 
SNM_DeleteFastString(SWS)Functioncall:
C: void SNM_DeleteFastString(WDL_FastString* str)
EEL2: extension_api("SNM_DeleteFastString", WDL_FastString str)
Lua: reaper.SNM_DeleteFastString(WDL_FastString str)
Python: SNM_DeleteFastString(WDL_FastString str)
Description:[S&M] Deletes a "fast string" instance.
^ 
SNM_GetDoubleConfigVar(SWS)Functioncall:
C: double SNM_GetDoubleConfigVar(const char* varname, double errvalue)
EEL2: double extension_api("SNM_GetDoubleConfigVar", "varname", errvalue)
Lua: number = reaper.SNM_GetDoubleConfigVar(string varname, number errvalue)
Python: Float SNM_GetDoubleConfigVar(String varname, Float errvalue)
Description:[S&M] Returns a floating-point preference (look in project prefs first, then in general prefs). Returns errvalue if failed (e.g. varname not found).
The settings can be from the Preferences, Project settings and Render-dialog, as well as numerous other settings, as e.g. set in the context menu of the transport-area.
Some variables are bitfields, where each bit represents e.g a checkbox in the preferences.
| Parameters: |
| string varname | - | the name of the config-variable to be read; not case sensitive see Reaper Config Variables for valid config-vars
|
| number errvalue | - | the errorvalue that will be returned, if varname isn't a valid one
|
| Returnvalues: |
| number | - | the returned number/doublefloat-value of varname
|
^ 
SNM_GetFastString(SWS)Functioncall:
C: const char* SNM_GetFastString(WDL_FastString* str)
EEL2: bool extension_api("SNM_GetFastString", #retval, WDL_FastString str)
Lua: string = reaper.SNM_GetFastString(WDL_FastString str)
Python: String SNM_GetFastString(WDL_FastString str)
Description:[S&M] Gets the "fast string" content.
^ 
SNM_GetFastStringLength(SWS)Functioncall:
C: int SNM_GetFastStringLength(WDL_FastString* str)
EEL2: int extension_api("SNM_GetFastStringLength", WDL_FastString str)
Lua: integer = reaper.SNM_GetFastStringLength(WDL_FastString str)
Python: Int SNM_GetFastStringLength(WDL_FastString str)
Description:[S&M] Gets the "fast string" length.
^ 
SNM_GetIntConfigVar(SWS)Functioncall:
C: int SNM_GetIntConfigVar(const char* varname, int errvalue)
EEL2: int extension_api("SNM_GetIntConfigVar", "varname", int errvalue)
Lua: integer retval = reaper.SNM_GetIntConfigVar(string varname, integer errvalue)
Python: Int SNM_GetIntConfigVar(String varname, Int errvalue)
Description:[S&M] Returns an integer preference (look in project prefs first, then in general prefs). Returns errvalue if failed (e.g. varname not found).
The settings can be from the Preferences, Project settings and Render-dialog, as well as numerous other settings, as e.g. set in the context menu of the transport-area.
Some variables are bitfields, where each bit represents e.g a checkbox in the preferences.
| Parameters: |
| string varname | - | the name of the config-variable to be read; not case sensitive see Reaper_Config_Variables.html for valid config-vars
|
| integer errvalue | - | the errorvalue that will be returned, if varname isn't a valid one
|
| Returnvalues: |
| integer retval | - | the returned integer-value of varname
|
^ 
SNM_GetLongConfigVar(SWS)Functioncall:
C: bool SNM_GetLongConfigVar(const char* varname, int* highOut, int* lowOut)
EEL2: bool extension_api("SNM_GetLongConfigVar", "varname", int &high, int &low)
Lua: boolean retval, number high, number low = reaper.SNM_GetLongConfigVar(string varname)
Python: (Boolean retval, String varname, Int highOut, Int lowOut) = SNM_GetLongConfigVar(varname, highOut, lowOut)
Description:[S&M] Reads a 64-bit integer preference split in two 32-bit integers (look in project prefs first, then in general prefs). Returns false if failed (e.g. varname not found).
| Parameters: |
| string varname | - | the name of the config-variable to be read; not case sensitive see Reaper_Config_Variables.html for valid config-vars
|
| Returnvalues: |
| boolean retval | - | true, varname was found; false, varname wasn't found
|
| number high | - | the high-32bits of the value
|
| number low | - | the low-32bits of the value
|
^ 
SNM_GetMediaItemTakeByGUID(SWS)Functioncall:
C: MediaItem_Take* SNM_GetMediaItemTakeByGUID(ReaProject* project, const char* guid)
EEL2: MediaItem_Take extension_api("SNM_GetMediaItemTakeByGUID", ReaProject project, "guid")
Lua: MediaItem_Take = reaper.SNM_GetMediaItemTakeByGUID(ReaProject project, string guid)
Python: MediaItem_Take SNM_GetMediaItemTakeByGUID(ReaProject project, String guid)
Description:[S&M] Gets a take by GUID as string. The GUID must be enclosed in braces {}. To get take GUID as string, see
BR_GetMediaItemTakeGUID
| Parameters: |
| project | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| guid | - |
|
| Returnvalues: |
| MediaItem_Take | - |
|
^ 
SNM_GetProjectMarkerName(SWS)Functioncall:
C: bool SNM_GetProjectMarkerName(ReaProject* proj, int num, bool isrgn, WDL_FastString* name)
EEL2: bool extension_api("SNM_GetProjectMarkerName", ReaProject proj, int num, bool isrgn, WDL_FastString name)
Lua: boolean = reaper.SNM_GetProjectMarkerName(ReaProject proj, integer num, boolean isrgn, WDL_FastString name)
Python: Boolean SNM_GetProjectMarkerName(ReaProject proj, Int num, Boolean isrgn, WDL_FastString name)
Description:[S&M] Gets a marker/region name. Returns true if marker/region found.
| Parameters: |
| ReaProject proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| integer num | - |
|
| boolean isrgn | - |
|
| WDL_FastString name | - |
|
^ 
SNM_GetSetObjectState(SWS)Functioncall:
C: bool SNM_GetSetObjectState(void* obj, WDL_FastString* state, bool setnewvalue, bool wantminimalstate)
EEL2: bool extension_api("SNM_GetSetObjectState", void* obj, WDL_FastString state, bool setnewvalue, bool wantminimalstate)
Lua: boolean = reaper.SNM_GetSetObjectState(identifier obj, WDL_FastString state, boolean setnewvalue, boolean wantminimalstate)
Python: Boolean SNM_GetSetObjectState(void obj, WDL_FastString state, Boolean setnewvalue, Boolean wantminimalstate)
Description:[S&M] Gets or sets the state of a track, an item or an envelope. The state chunk size is unlimited. Returns false if failed.
When getting a track state (and when you are not interested in FX data), you can use wantminimalstate=true to radically reduce the length of the state. Do not set such minimal states back though, this is for read-only applications!
Note: unlike the native GetSetObjectState, calling to FreeHeapPtr() is not required.
| Parameters: |
| obj | - | |
| WDL_FastString state | - | |
| setnewvalue | - | |
| wantminimalstate | - | |
^ 
SNM_GetSetSourceState(SWS)Functioncall:
C: bool SNM_GetSetSourceState(MediaItem* item, int takeidx, WDL_FastString* state, bool setnewvalue)
EEL2: bool extension_api("SNM_GetSetSourceState", MediaItem item, int takeidx, WDL_FastString state, bool setnewvalue)
Lua: boolean = reaper.SNM_GetSetSourceState(MediaItem item, integer takeidx, WDL_FastString state, boolean setnewvalue)
Python: Boolean SNM_GetSetSourceState(MediaItem item, Int takeidx, WDL_FastString state, Boolean setnewvalue)
Description:[S&M] Gets or sets a take source state. Returns false if failed. Use takeidx=-1 to get/alter the active take.
Note: this function does not use a MediaItem_Take* param in order to manage empty takes (i.e. takes with MediaItem_Take*==NULL), see
SNM_GetSetSourceState2.
| Parameters: |
| MediaItem item | - |
|
| integer takeidx | - |
|
| WDL_FastString state | - |
|
| boolean setnewvalue | - |
|
^ 
SNM_GetSetSourceState2(SWS)Functioncall:
C: bool SNM_GetSetSourceState2(MediaItem_Take* take, WDL_FastString* state, bool setnewvalue)
EEL2: bool extension_api("SNM_GetSetSourceState2", MediaItem_Take take, WDL_FastString state, bool setnewvalue)
Lua: boolean = reaper.SNM_GetSetSourceState2(MediaItem_Take take, WDL_FastString state, boolean setnewvalue)
Python: Boolean SNM_GetSetSourceState2(MediaItem_Take take, WDL_FastString state, Boolean setnewvalue)
Description:[S&M] Gets or sets a take source state. Returns false if failed.
Note: this function cannot deal with empty takes, see
SNM_GetSetSourceState.
| Parameters: |
| MediaItem_Take take | - |
|
| WDL_FastString state | - |
|
| boolean setnewvalue | - |
|
^ 
SNM_GetSourceType(SWS)Functioncall:
C: bool SNM_GetSourceType(MediaItem_Take* take, WDL_FastString* type)
EEL2: bool extension_api("SNM_GetSourceType", MediaItem_Take take, WDL_FastString type)
Lua: boolean = reaper.SNM_GetSourceType(MediaItem_Take takeWDL_FastString type)
Python: Boolean SNM_GetSourceType(MediaItem_Take take, WDL_FastString type)
Description:[S&M] Deprecated, see
GetMediaSourceType. Gets the source type of a take. Returns false if failed (e.g. take with empty source, etc..)
| Parameters: |
| takeWDL_FastString type | - |
|
^ 
SNM_MoveOrRemoveTrackFX(SWS)Functioncall:
C: bool SNM_MoveOrRemoveTrackFX(MediaTrack* tr, int fxId, int what)
EEL2: bool extension_api("SNM_MoveOrRemoveTrackFX", MediaTrack tr, int fxId, int what)
Lua: boolean = reaper.SNM_MoveOrRemoveTrackFX(MediaTrack tr, integer fxId, integer what)
Python: Boolean SNM_MoveOrRemoveTrackFX(MediaTrack tr, Int fxId, Int what)
Description:[S&M] Deprecated, see TakeFX_/TrackFX_ CopyToTrack/Take, TrackFX/TakeFX _Delete (v5.95pre2+). Move or removes a track FX. Returns true if tr has been updated.
fxId: fx index in chain or -1 for the selected fx. what: 0 to remove, -1 to move fx up in chain, 1 to move fx down in chain.
| Parameters: |
| tr | - | |
| fxId | - | |
| what | - | |
^ 
SNM_ReadMediaFileTag(SWS)Functioncall:
C: bool SNM_ReadMediaFileTag(const char* fn, const char* tag, char* tagvalOut, int tagvalOut_sz)
EEL2: bool extension_api("SNM_ReadMediaFileTag", "fn", "tag", #tagval)
Lua: boolean retval, string tagval = reaper.SNM_ReadMediaFileTag(string fn, string tag)
Python: (Boolean retval, String fn, String tag, String tagvalOut, Int tagvalOut_sz) = SNM_ReadMediaFileTag(fn, tag, tagvalOut, tagvalOut_sz)
Description:[S&M] Reads a media file tag. Supported tags: "artist", "album", "genre", "comment", "title", "track" (track number) or "year". Returns false if tag was not found. See
SNM_TagMediaFile.
| Parameters: |
| string fn | - | the filename+path of the mediafile
|
| string tag | - | the tag you want to request; "artist", "album", "genre", "comment", "title", "track", "year"
|
| Returnvalues: |
| boolean retval | - | true, value could be read; false, value could not be read
|
| string tagval | - | the value of the requested tag
|
^ 
SNM_RemoveReceive(SWS)Functioncall:
C: bool SNM_RemoveReceive(MediaTrack* tr, int rcvidx)
EEL2: bool extension_api("SNM_RemoveReceive", MediaTrack tr, int rcvidx)
Lua: boolean = reaper.SNM_RemoveReceive(MediaTrack tr, integer rcvidx)
Python: Boolean SNM_RemoveReceive(MediaTrack tr, Int rcvidx)
Description:[S&M] Deprecated, see
RemoveTrackSend (v5.15pre1+). Removes a receive. Returns false if nothing updated.
| Parameters: |
| tr | - |
|
| rcvidx | - |
|
^ 
SNM_RemoveReceivesFrom(SWS)Functioncall:
C: bool SNM_RemoveReceivesFrom(MediaTrack* tr, MediaTrack* srctr)
EEL2: bool extension_api("SNM_RemoveReceivesFrom", MediaTrack tr, MediaTrack srctr)
Lua: boolean = reaper.SNM_RemoveReceivesFrom(MediaTrack tr, MediaTrack srctr)
Python: Boolean SNM_RemoveReceivesFrom(MediaTrack tr, MediaTrack srctr)
Description:[S&M] Removes all receives from srctr. Returns false if nothing updated.
^ 
SNM_SelectResourceBookmark(SWS)Functioncall:
C: int SNM_SelectResourceBookmark(const char* name)
EEL2: int extension_api("SNM_SelectResourceBookmark", "name")
Lua: integer = reaper.SNM_SelectResourceBookmark(string name)
Python: Int SNM_SelectResourceBookmark(String name)
Description:[S&M] Select a bookmark of the Resources window. Returns the related bookmark id (or -1 if failed).
^ 
SNM_SetDoubleConfigVar(SWS)Functioncall:
C: bool SNM_SetDoubleConfigVar(const char* varname, double newvalue)
EEL2: bool extension_api("SNM_SetDoubleConfigVar", "varname", newvalue)
Lua: boolean retval = reaper.SNM_SetDoubleConfigVar(string varname, number newvalue)
Python: Boolean SNM_SetDoubleConfigVar(String varname, Float newvalue)
Description:[S&M] Sets a floating-point preference (look in project prefs first, then in general prefs). Returns false if failed (e.g. varname not found or newvalue out of range).
The settings can be from the Preferences, Project settings and Render-dialog, as well as numerous other settings, as e.g. set in the context menu of the transport-area.
Some variables are bitfields, where each bit represents e.g a checkbox in the preferences.
The changed settings are usually only changed within the running Reaper, but not stored in the config-files, so you need to do it manually or they get lost after Reaper is closed!
| Parameters: |
| string varname | - | the name of the config-variable to be read; not case sensitive see Reaper_Config_Variables.html for valid config-vars
|
| number newvalue | - | the new value to be set into varname
|
| Returnvalues: |
| boolean retval | - | true, if setting was successful; false, if not
|
^ 
SNM_SetFastString(SWS)Functioncall:
C: WDL_FastString* SNM_SetFastString(WDL_FastString* str, const char* newstr)
EEL2: WDL_FastString extension_api("SNM_SetFastString", WDL_FastString str, "newstr")
Lua: WDL_FastString = reaper.SNM_SetFastString(WDL_FastString str, string newstr)
Python: WDL_FastString SNM_SetFastString(WDL_FastString str, String newstr)
Description:[S&M] Sets the "fast string" content. Returns str for facility.
| Parameters: |
| str | - | |
| newstr | - | |
| Returnvalues: |
| WDL_FastString | - | |
^ 
SNM_SetIntConfigVar(SWS)Functioncall:
C: bool SNM_SetIntConfigVar(const char* varname, int newvalue)
EEL2: bool extension_api("SNM_SetIntConfigVar", "varname", int newvalue)
Lua: boolean retval = reaper.SNM_SetIntConfigVar(string varname, integer newvalue)
Python: Boolean SNM_SetIntConfigVar(String varname, Int newvalue)
Description:[S&M] Sets an integer preference (look in project prefs first, then in general prefs). Returns false if failed (e.g. varname not found).
Some variables are bitfields, where each bit represents e.g a checkbox in the preferences.
The changed settings are usually only changed within the running Reaper, but not stored in the config-files, so you need to do it manually or they get lost after Reaper is closed!
| Parameters: |
| string varname | - | the name of the config-variable to be read; not case sensitive see Reaper_Config_Variables.html for valid config-vars
|
| integer newvalue | - | the newly set value for varname
|
| Returnvalues: |
| boolean retval | - | true, if setting was successful, false if not
|
^ 
SNM_SetLongConfigVar(SWS)Functioncall:
C: bool SNM_SetLongConfigVar(const char* varname, int newHighValue, int newLowValue)
EEL2: bool extension_api("SNM_SetLongConfigVar", "varname", int newHighValue, int newLowValue)
Lua: boolean = reaper.SNM_SetLongConfigVar(string varname, integer newHighValue, integer newLowValue)
Python: Boolean SNM_SetLongConfigVar(String varname, Int newHighValue, Int newLowValue)
Description:[S&M] Sets a 64-bit integer preference from two 32-bit integers (look in project prefs first, then in general prefs). Returns false if failed (e.g. varname not found).
Some variables are bitfields, where each bit represents e.g a checkbox in the preferences.
The changed settings are usually only changed within the running Reaper, but not stored in the config-files, so you need to do it manually or they get lost after Reaper is closed!
| Parameters: |
| string varname | - | the name of the config-variable to be read; not case sensitive see Reaper_Config_Variables.html for valid config-vars
|
| integer newHighValue | - | the newly set value for varname of the high-32bits
|
| integer newLowValue | - | the newly set value for varname of the low-32bits
|
| Returnvalues: |
| boolean retval | - | true, if setting was successful, false if not
|
^ 
SNM_SetProjectMarker(SWS)Functioncall:
C: bool SNM_SetProjectMarker(ReaProject* proj, int num, bool isrgn, double pos, double rgnend, const char* name, int color)
EEL2: bool extension_api("SNM_SetProjectMarker", ReaProject proj, int num, bool isrgn, pos, rgnend, "name", int color)
Lua: boolean = reaper.SNM_SetProjectMarker(ReaProject proj, integer num, boolean isrgn, number pos, number rgnend, string name, integer color)
Python: Boolean SNM_SetProjectMarker(ReaProject proj, Int num, Boolean isrgn, Float pos, Float rgnend, String name, Int color)
Description:[S&M] Deprecated, see
SetProjectMarker4 -- Same function as SetProjectMarker3() except it can set empty names "".
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| num | - |
|
| isrgn | - |
|
| pos | - |
|
| rgnend | - |
|
| name | - |
|
| color | - |
|
^ 
SNM_TagMediaFile(SWS)Functioncall:
C: bool SNM_TagMediaFile(const char* fn, const char* tag, const char* tagval)
EEL2: bool extension_api("SNM_TagMediaFile", "fn", "tag", "tagval")
Lua: boolean = reaper.SNM_TagMediaFile(string fn, string tag, string tagval)
Python: Boolean SNM_TagMediaFile(String fn, String tag, String tagval)
Description:[S&M] Tags a media file thanks to
TagLib. Use an empty tagval to clear a tag. When a file is opened in REAPER, turn it offline before using this function. Returns false if nothing updated. See
SNM_ReadMediaFileTag.
| Parameters: |
| string fn | - | the mediafilename, in which to add the tag
|
| string tag | - | "artist", "album", "genre", "comment", "title", "track" or "year"
|
| string tagval | - | the new value to be added
|
| Returnvalues: |
| boolean | - | true, if adding the tag worked; false, if adding didn't work.
|
^ 
SNM_TieResourceSlotActions(SWS)Functioncall:
C: void SNM_TieResourceSlotActions(int bookmarkId)
EEL2: extension_api("SNM_TieResourceSlotActions", int bookmarkId)
Lua: reaper.SNM_TieResourceSlotActions(integer bookmarkId)
Python: SNM_TieResourceSlotActions(Int bookmarkId)
Description:[S&M] Attach Resources slot actions to a given bookmark.
^ 
SN_FocusMIDIEditor(SWS)Functioncall:
C: void SN_FocusMIDIEditor()
EEL2: extension_api("SN_FocusMIDIEditor")
Lua: reaper.SN_FocusMIDIEditor()
Python: SN_FocusMIDIEditor()
Description:Focuses the active/open MIDI editor.
^ 
ULT_GetMediaItemNote(SWS)Functioncall:
C: const char* ULT_GetMediaItemNote(MediaItem* item)
EEL2: bool extension_api("ULT_GetMediaItemNote", #retval, MediaItem item)
Lua: string = reaper.ULT_GetMediaItemNote(MediaItem item)
Python: String ULT_GetMediaItemNote(MediaItem item)
Description:
| Parameters: |
| MediaItem item | - | the MediaItem from which to get the notes from
|
| Returnvalues: |
| string | - | the notes, as stored in the MediaItem. If no notes exist, it will return ""
|
^ 
ULT_SetMediaItemNote(SWS)Functioncall:
C: void ULT_SetMediaItemNote(MediaItem* item, const char* note)
EEL2: extension_api("ULT_SetMediaItemNote", MediaItem item, "note")
Lua: reaper.ULT_SetMediaItemNote(MediaItem item, string note)
Python: ULT_SetMediaItemNote(MediaItem item, String note)
Description:
| Parameters: |
| MediaItem item | - | the MediaItem in which to add the Notes
|
| string note | - | the notes to be added. Newlines are allowed. Long strings may slow down Reaper!
|
^ 
JS_Actions_CountShortcuts(JS)Functioncall:
C: int JS_Actions_CountShortcuts(int section, int cmdID)
EEL2: int extension_api("JS_Actions_CountShortcuts", int section, int cmdID)
Lua: integer retval = reaper.JS_Actions_CountShortcuts(integer section, integer cmdID)
Python: Int JS_Actions_CountShortcuts(Int section, Int cmdID)
Description:Counts the shortcuts available for a specific action within a section.
| Parameters: |
| integer section | - | the section of the action: 0, Main 100, Main (alt recording) 32060, MIDI Editor 32061, MIDI Event List Editor 32062, MIDI Inline Editor 32063, Media Explorer
|
| integer cmdID | - | the command-id of the action, whose shortcuts you want to count
|
| Returnvalues: |
| integer retval | - | the number of shortcuts available
|
^ 
JS_Actions_DeleteShortcut(JS)Functioncall:
C: bool JS_Actions_DeleteShortcut(int section, int cmdID, int shortcutidx)
EEL2: bool extension_api("JS_Actions_DeleteShortcut", int section, int cmdID, int shortcutidx)
Lua: boolean = reaper.JS_Actions_DeleteShortcut(integer section, integer cmdID, integer shortcutidx)
Python: Boolean JS_Actions_DeleteShortcut(Int section, Int cmdID, Int shortcutidx)
Description:Deletes a shortcut of a specific action within a section.
| Parameters: |
| integer section | - | the section of the action: 0, Main 100, Main (alt recording) 32060, MIDI Editor 32061, MIDI Event List Editor 32062, MIDI Inline Editor 32063, Media Explorer
|
| integer cmdID | - | the command-id of the action, whose shortcut you want to delete
|
| integer shortcutidx | - | the shortcut that you want to delete; 0-based
|
| Returnvalues: |
| boolean retval | - | true, deleting was successful; false, deleting was unsuccessful
|
^ 
JS_Actions_DoShortcutDialog(JS)Functioncall:
C: bool JS_Actions_DoShortcutDialog(int section, int cmdID, int shortcutidx)
EEL2: bool extension_api("JS_Actions_DoShortcutDialog", int section, int cmdID, int shortcutidx)
Lua: boolean = reaper.JS_Actions_DoShortcutDialog(integer section, integer cmdID, integer shortcutidx)
Python: Boolean JS_Actions_DoShortcutDialog(Int section, Int cmdID, Int shortcutidx)
Description:Opens the do-shortcut-dialog, which allows you setting a shortcut for a specific action.
If the shortcut index is higher than the current number of shortcuts, it will add a new shortcut.
| Parameters: |
| integer section | - | the section of the action: 0, Main 100, Main (alt recording) 32060, MIDI Editor 32061, MIDI Event List Editor 32062, MIDI Inline Editor 32063, Media Explorer
|
| integer cmdID | - | the command-id of the action, whose shortcut you want to set
|
| integer shortcutidx | - | the shortcut that you want to set; 0-based
|
| Returnvalues: |
| boolean retval | - | true, setting was successful; false, setting was unsuccessful
|
^ 
JS_Actions_GetShortcutDesc(JS)Functioncall:
C: bool JS_Actions_GetShortcutDesc(int section, int cmdID, int shortcutidx, char* descOut, int descOut_sz)
EEL2: bool extension_api("JS_Actions_GetShortcutDesc", int section, int cmdID, int shortcutidx, #desc)
Lua: boolean retval, string desc = reaper.JS_Actions_GetShortcutDesc(integer section, integer cmdID, integer shortcutidx)
Python: (Boolean retval, Int section, Int cmdID, Int shortcutidx, String descOut, Int descOut_sz) = JS_Actions_GetShortcutDesc(section, cmdID, shortcutidx, descOut, descOut_sz)
Description:returns the description of a shortcut, as stored for a specific action within a section.
This will be the shown representation of the shortcut as seen in the actionlist. That means, it is localized!
| Parameters: |
| integer section | - | the section of the action: 0, Main 100, Main (alt recording) 32060, MIDI Editor 32061, MIDI Event List Editor 32062, MIDI Inline Editor 32063, Media Explorer
|
| integer cmdID | - | the command-id of the action, whose shortcut-description you want to get
|
| integer shortcutidx | - | the shortcut whose description you want to get; 0-based
|
| Returnvalues: |
| boolean retval | - | true, getting was successful; false, getting was unsuccessful
|
| string desc | - | the description of the shortcut; "", if shortcut is not available
|
^ 
JS_Byte(JS)Functioncall:
C: void JS_Byte(void* pointer, int offset, int* byteOut)
EEL2: extension_api("JS_Byte", void* pointer, int offset, int &byte)
Lua: number byte = reaper.JS_Byte(identifier pointer, integer offset)
Python: (void pointer, Int offset, Int byteOut) = JS_Byte(pointer, offset, byteOut)
Description:Returns the unsigned byte at address[offset]. Offset is added as steps of 1 byte each.
| Parameters: |
| identifier address | - |
|
| integer offset | - |
|
| Returnvalues: |
| number byte | - |
|
^ 
JS_Composite(JS)Functioncall:
C: int JS_Composite(void* windowHWND, int dstx, int dsty, int dstw, int dsth, void* sysBitmap, int srcx, int srcy, int srcw, int srch, bool* autoUpdateOptional)
EEL2: int extension_api("JS_Composite", void* windowHWND, int dstx, int dsty, int dstw, int dsth, void* sysBitmap, int srcx, int srcy, int srcw, int srch, optional boolean autoUpdateOptional)
Lua: integer = reaper.JS_Composite(identifier windowHWND, integer dstx, integer dsty, integer dstw, integer dsth, identifier sysBitmap, integer srcx, integer srcy, integer srcw, integer srch, optional boolean autoUpdate)
Python: (Int retval, void windowHWND, Int dstx, Int dsty, Int dstw, Int dsth, void sysBitmap, Int srcx, Int srcy, Int srcw, Int srch, Boolean autoUpdateOptional) = JS_Composite(windowHWND, dstx, dsty, dstw, dsth, sysBitmap, srcx, srcy, srcw, srch, autoUpdateOptional)
Description:Composites a LICE bitmap with a REAPER window. Each time that the window is re-drawn, the bitmap will be blitted over the window's client area (with per-pixel alpha blending).
* If dstw or dsth is -1, the bitmap will be stretched to fill the width or height of the window, respectively.
* autoUpdate is an optional parameter that is false by default. If true, JS_Composite will automatically invalidate and re-draw the part of the window that covers the current position of the bitmap, and if the bitmap is being moved, also the previous position. (If only one or a handful of bitmaps are being moved across the screen, autoUpdate should result in smoother animation on WindowsOS; if numerous bitmaps are spread over the entire window, it may be faster to disable autoUpdate and instead call
JS_Window_InvalidateRect explicitly once all bitmaps have been moved.)
* InvalidateRect should also be called whenever the contents of the bitmap contents have been changed, but not the position, to trigger a window update.
* On WindowsOS, the key to reducing flickering is to slow down the frequency at which the window is re-drawn. InvalidateRect should only be called when absolutely necessary, preferably not more than 20 times per second. (Also refer to the
JS_Composite_Delay function.)
* On WindowsOS, flickering can further be reduced by keeping the invalidated area as small as possible, covering only the bitmaps that have been edited or moved. However, if numerous bitmaps are spread over the entire window, it may be faster to simply invalidate the entire client area.
* This function should not be applied directly to top-level windows, but rather to child windows.
* Some classes of UI elements, particularly buttons, do not take kindly to being composited, and may crash REAPER.
* On WindowsOS, GDI blitting does not perform alpha multiplication of the source bitmap. For proper color rendering, a separate pre-multiplication step is therefore required, using either
LICE_Blit or
LICE_ProcessRect.
Returns:
1 if successful, otherwise -1 = windowHWND is not a window, -3 = Could not obtain the original window process, -4 = sysBitmap is not a LICE bitmap, -5 = sysBitmap is not a system bitmap, -6 = Could not obtain the window HDC, -7 = Error when subclassing to new window process.
| Parameters: |
| identifier windowHWND | - |
|
| integer dstx | - |
|
| integer dsty | - |
|
| integer dstw | - |
|
| integer dsth | - |
|
| identifier sysBitmap | - |
|
| integer srcx | - |
|
| integer srcy | - |
|
| integer srcw | - |
|
| integer srch | - |
|
| optional boolean autoUpdate | - |
|
| Returnvalues: |
| integer retval | - | 1 if successful -1 = windowHWND is not a window -3 = Could not obtain the original window process -4 = sysBitmap is not a LICE bitmap -5 = sysBitmap is not a system bitmap -6 = Could not obtain the window HDC -7 = Error when subclassing to new window process.
|
^ 
JS_Composite_Delay(JS)Functioncall:
C: int JS_Composite_Delay(void* windowHWND, double minTime, double maxTime, int numBitmapsWhenMax, double* prevMinTimeOut, double* prevMaxTimeOut, int* prevBitmapsOut)
EEL2: int extension_api("JS_Composite_Delay", void* windowHWND, minTime, maxTime, int numBitmapsWhenMax, &prevMinTime, &prevMaxTime, int &prevBitmaps)
Lua: integer retval, number prevMinTime, number prevMaxTime, number prevBitmaps = reaper.JS_Composite_Delay(identifier windowHWND, number minTime, number maxTime, integer numBitmapsWhenMax)
Python: (Int retval, void windowHWND, Float minTime, Float maxTime, Int numBitmapsWhenMax, Float prevMinTimeOut, Float prevMaxTimeOut, Int prevBitmapsOut) = JS_Composite_Delay(windowHWND, minTime, maxTime, numBitmapsWhenMax, prevMinTimeOut, prevMaxTimeOut, prevBitmapsOut)
Description:On WindowsOS, flickering of composited images can be improved considerably by slowing the refresh rate of the window. The optimal refresh rate may depend on the number of composited bitmaps.
minTime is the minimum refresh delay, in seconds, when only one bitmap is composited onto the window. The delay time will increase linearly with the number of bitmaps, up to a maximum of maxTime when numBitmapsWhenMax is reached.
If both minTime and maxTime are 0, all delay settings for the window are cleared.
Returns:
* retval = 1 if successful, 0 if arguments are invalid (i.e. if maxTime < minTime, or maxBitmaps < 1).
* If delay times have not previously been set for this window, prev time values are 0.
| Parameters: |
| identifier windowHWND | - |
|
| number minTime | - |
|
| number maxTime | - |
|
| integer numBitmapsWhenMax | - |
|
| Returnvalues: |
| integer retval | - |
|
| number prevMinTime | - |
|
| number prevMaxTime | - |
|
| number prevBitmaps | - |
|
^ 
JS_Composite_ListBitmaps(JS)Functioncall:
C: int JS_Composite_ListBitmaps(void* windowHWND, char* listOutNeedBig, int listOutNeedBig_sz)
EEL2: int extension_api("JS_Composite_ListBitmaps", void* windowHWND, #list)
Lua: integer retval, string list = reaper.JS_Composite_ListBitmaps(identifier windowHWND)
Python: (Int retval, void windowHWND, String listOutNeedBig, Int listOutNeedBig_sz) = JS_Composite_ListBitmaps(windowHWND, listOutNeedBig, listOutNeedBig_sz)
Description:Returns all bitmaps composited to the given window.
The list is formatted as a comma-separated string of hexadecimal values, each representing a LICE_IBitmap* pointer.
retval is the number of linked bitmaps found, or negative if an error occured.
| Parameters: |
| identifier windowHWND | - |
|
| Returnvalues: |
| integer retval | - |
|
| string list | - |
|
^ 
JS_Composite_Unlink(JS)Functioncall:
C: void JS_Composite_Unlink(void* windowHWND, void* bitmapOptional, bool* autoUpdateOptional)
EEL2: extension_api("JS_Composite_Unlink", void* windowHWND, void* bitmap, boolean autoUpdateOptional)
Lua: reaper.JS_Composite_Unlink(identifier windowHWND, identifier bitmap, boolean autoUpdate)
Python: (void windowHWND, void bitmapOptional, Boolean autoUpdateOptional) = JS_Composite_Unlink(windowHWND, bitmapOptional, autoUpdateOptional)
Description:Unlinks the window and bitmap.
* autoUpdate is an optional parameter. If unlinking a single bitmap and autoUpdate is true, the function will automatically re-draw the window to remove the blitted image.
If no bitmap is specified, all bitmaps composited to the window will be unlinked -- even those by other scripts.
| Parameters: |
| identifier windowHWND | - |
|
| identifier bitmap | - |
|
| boolean autoUpdate | - |
|
^ 
JS_Double(JS)Functioncall:
C: void JS_Double(void* pointer, int offset, double* doubleOut)
EEL2: extension_api("JS_Double", void* pointer, int offset, &double)
Lua: number double = reaper.JS_Double(identifier address, integer pointer)
Python: (void pointer, Int offset, Float doubleOut) = JS_Double(pointer, offset, doubleOut)
Description:Returns the 8-byte floating point value at address[offset]. Offset is added as steps of 8 bytes each.
| Parameters: |
| identifier address | - |
|
| integer offset | - |
|
| Returnvalues: |
| number double | - |
|
^ 
JS_File_Stat(JS)Functioncall:
C: int JS_File_Stat(const char* filePath, double* sizeOut, char* accessedTimeOut, char* modifiedTimeOut, char* cTimeOut, int* deviceIDOut, int* deviceSpecialIDOut, int* inodeOut, int* modeOut, int* numLinksOut, int* ownerUserIDOut, int* ownerGroupIDOut)
EEL2: int extension_api("JS_File_Stat", "filePath", &size, #accessedTime, #modifiedTime, #cTime, int &deviceID, int &deviceSpecialID, int &inode, int &mode, int &numLinks, int &ownerUserID, int &ownerGroupID)
Lua: integer retval, number size, string accessedTime, string modifiedTime, string cTime, number deviceID, number deviceSpecialID, number inode, number mode, number numLinks, number ownerUserID, number ownerGroupID = reaper.JS_File_Stat(string filePath)
Python: (Int retval, String filePath, Float sizeOut, String accessedTimeOut, String modifiedTimeOut, String cTimeOut, Int deviceIDOut, Int deviceSpecialIDOut, Int inodeOut, Int modeOut, Int numLinksOut, Int ownerUserIDOut, Int ownerGroupIDOut) = JS_File_Stat(filePath, sizeOut, accessedTimeOut, modifiedTimeOut, cTimeOut, deviceIDOut, deviceSpecialIDOut, inodeOut, modeOut, numLinksOut, ownerUserIDOut, ownerGroupIDOut)
Description:Returns information about a file.
cTime is not implemented on all systems. If it does return a time, the value may differ depending on the OS: on WindowsOS, it may refer to the time that the file was either created or copied, whereas on Linux and macOS, it may refer to the time of last status change.
retval is 0 if successful, negative if not.
| Parameters: |
| string filePath | - | the file, whose file-stats you want to get
|
| Returnvalues: |
| integer retval | - | negative, if not retrievable; 0, if retrieving was successful
|
| number size | - | the size of the file in bytes
|
| string accessedTime | - | the last time the file was accessed
|
| string modifiedTime | - | the last time the file was modified
|
| string cTime | - | the time the file was created(Windows) or the last time its status had changed(Mac and Linux)
|
| number deviceID | - | the ID of the device
|
| number deviceSpecialID | - | the special ID of the file
|
| number inode | - | the inode
|
| number mode | - | the attributes set
|
| number numLinks | - | the number of links
|
| number ownerUserID | - | ID of the user the file belongs to
|
| number ownerGroupID | - | ID of the group the file belongs to
|
^ 
JS_GDI_Blit(JS)Functioncall:
C: void JS_GDI_Blit(void* destHDC, int dstx, int dsty, void* sourceHDC, int srcx, int srxy, int width, int height, const char* modeOptional)
EEL2: extension_api("JS_GDI_Blit", void* destHDC, int dstx, int dsty, void* sourceHDC, int srcx, int srxy, int width, int height, optional "mode")
Lua: reaper.JS_GDI_Blit(identifier destHDC, integer dstx, integer dsty, identifier sourceHDC, integer srcx, integer srxy, integer width, integer height, optional string mode)
Python: JS_GDI_Blit(void destHDC, Int dstx, Int dsty, void sourceHDC, Int srcx, Int srxy, Int width, Int height, String modeOptional)
Description:Blits between two device contexts, which may include LICE "system bitmaps".
mode: Optional parameter. "SRCCOPY" by default, or specify "ALPHA" to enable per-pixel alpha blending.
WARNING: On WindowsOS, GDI_Blit does not perform alpha multiplication of the source bitmap. For proper color rendering, a separate pre-multiplication step is therefore required, using either LICE_Blit or LICE_ProcessRect.
| Parameters: |
| identifier destHDC | - |
|
| integer dstx | - |
|
| integer dsty | - |
|
| identifier sourceHDC | - |
|
| integer srcx | - |
|
| integer srxy | - |
|
| integer width | - |
|
| integer height | - |
|
| optional string mode | - |
|
^ 
JS_GDI_CreateFillBrush(JS)Functioncall:
C: void* JS_GDI_CreateFillBrush(int color)
EEL2: void* extension_api("JS_GDI_CreateFillBrush", int color)
Lua: identifier = reaper.JS_GDI_CreateFillBrush(integer color)
Python: void JS_GDI_CreateFillBrush(Int color)
Description:
| Parameters: |
| integer color | - |
|
| Returnvalues: |
| identifier | - |
|
^ 
JS_GDI_CreateFont(JS)Functioncall:
C: void* JS_GDI_CreateFont(int height, int weight, int angle, bool italic, bool underline, bool strikeOut, const char* fontName)
EEL2: void* extension_api("JS_GDI_CreateFont", int height, int weight, int angle, bool italic, bool underline, bool strike, "fontName")
Lua: identifier = reaper.JS_GDI_CreateFont(integer height, integer weight, integer angle, boolean italic, boolean underline, boolean strike, string fontName)
Python: void JS_GDI_CreateFont(Int height, Int weight, Int angle, Boolean italic, Boolean underline, Boolean strikeOut, String fontName)
Description:Parameters:
* weight: 0 - 1000, with 0 = auto, 400 = normal and 700 = bold.
* angle: the angle, in tenths of degrees, between the text and the x-axis of the device.
* fontName: If empty string "", uses first font that matches the other specified attributes.
Note: Text color must be set separately.
| Parameters: |
| integer height | - |
|
| integer weight | - |
|
| integer angle | - |
|
| boolean italic | - |
|
| boolean underline | - |
|
| boolean strike | - |
|
| string fontName | - |
|
| Returnvalues: |
| identifier | - |
|
^ 
JS_GDI_CreatePen(JS)Functioncall:
C: void* JS_GDI_CreatePen(int width, int color)
EEL2: void* extension_api("JS_GDI_CreatePen", int width, int color)
Lua: identifier = reaper.JS_GDI_CreatePen(integer width, integer color)
Python: void JS_GDI_CreatePen(Int width, Int color)
Description:
| Parameters: |
| integer width | - |
|
| integer color | - |
|
| Returnvalues: |
| identifier | - |
|
^ 
JS_GDI_DeleteObject(JS)Functioncall:
C: void JS_GDI_DeleteObject(void* GDIObject)
EEL2: extension_api("JS_GDI_DeleteObject", void* GDIObject)
Lua: reaper.JS_GDI_DeleteObject(identifier GDIObject)
Python: JS_GDI_DeleteObject(void GDIObject)
Description:
| Parameters: |
| identifier GDIObject | - |
|
^ 
JS_GDI_DrawText(JS)Functioncall:
C: int JS_GDI_DrawText(void* deviceHDC, const char* text, int len, int left, int top, int right, int bottom, const char* align))
EEL2: int extension_api("JS_GDI_DrawText", void* deviceHDC, "text", int len, int left, int top, int right, int bottom, "align)")
Lua: integer = reaper.JS_GDI_DrawText(identifier deviceHDC, string text, integer len, integer left, integer top, integer right, integer bottom, string align))
Python: Int JS_GDI_DrawText(void deviceHDC, String text, Int len, Int left, Int top, Int right, Int bottom, String align))
Description:Parameters:
* align: Combination of: "TOP", "VCENTER", "LEFT", "HCENTER", "RIGHT", "BOTTOM", "WORDBREAK", "SINGLELINE", "NOCLIP", "CALCRECT", "NOPREFIX" or "ELLIPSIS"
| Parameters: |
| identifier deviceHDC | - |
|
| string text | - |
|
| integer len | - |
|
| integer left | - |
|
| integer top | - |
|
| integer right | - |
|
| integer bottom | - |
|
| string align | - |
|
^ 
JS_GDI_FillEllipse(JS)Functioncall:
C: void JS_GDI_FillEllipse(void* deviceHDC, int left, int top, int right, int bottom)
EEL2: extension_api("JS_GDI_FillEllipse", void* deviceHDC, int left, int top, int right, int bottom)
Lua: reaper.JS_GDI_FillEllipse(identifier deviceHDC, integer left, integer top, integer right, integer bottom)
Python: JS_GDI_FillEllipse(void deviceHDC, Int left, Int top, Int right, Int bottom)
Description:
| Parameters: |
| identifier deviceHDC | - |
|
| integer left | - |
|
| integer top | - |
|
| integer right | - |
|
| integer bottom | - |
|
^ 
JS_GDI_FillPolygon(JS)Functioncall:
C: void JS_GDI_FillPolygon(void* deviceHDC, const char* packedX, const char* packedY, int numPoints)
EEL2: extension_api("JS_GDI_FillPolygon", void* deviceHDC, "packedX", "packedY", int numPoints)
Lua: reaper.JS_GDI_FillPolygon(identifier deviceHDC, string packedX, string packedY, integer numPoints)
Python: JS_GDI_FillPolygon(void deviceHDC, String packedX, String packedY, Int numPoints)
Description:packedX and packedY are strings of points, each packed as "<i4".
| Parameters: |
| identifier deviceHDC | - |
|
| string packedX | - |
|
| string packedY | - |
|
| integer numPoints | - |
|
^ 
JS_GDI_FillRect(JS)Functioncall:
C: void JS_GDI_FillRect(void* deviceHDC, int left, int top, int right, int bottom)
EEL2: extension_api("JS_GDI_FillRect", void* deviceHDC, int left, int top, int right, int bottom)
Lua: reaper.JS_GDI_FillRect(identifier deviceHDC, integer left, integer top, integer right, integer bottom)
Python: JS_GDI_FillRect(void deviceHDC, Int left, Int top, Int right, Int bottom)
Description:
| Parameters: |
| identifier deviceHDC | - |
|
| integer left | - |
|
| integer top | - |
|
| integer right | - |
|
| integer bottom | - |
|
^ 
JS_GDI_FillRoundRect(JS)Functioncall:
C: void JS_GDI_FillRoundRect(void* deviceHDC, int left, int top, int right, int bottom, int xrnd, int yrnd)
EEL2: extension_api("JS_GDI_FillRoundRect", void* deviceHDC, int left, int top, int right, int bottom, int xrnd, int yrnd)
Lua: reaper.JS_GDI_FillRoundRect(identifier deviceHDC, integer left, integer top, integer right, integer bottom, integer xrnd, integer yrnd)
Python: JS_GDI_FillRoundRect(void deviceHDC, Int left, Int top, Int right, Int bottom, Int xrnd, Int yrnd)
Description:
| Parameters: |
| identifier deviceHDC | - |
|
| integer left | - |
|
| integer top | - |
|
| integer right | - |
|
| integer bottom | - |
|
| integer xrnd | - |
|
| integer yrnd | - |
|
^ 
JS_GDI_GetClientDC(JS)Functioncall:
C: void* JS_GDI_GetClientDC(void* windowHWND)
EEL2: void* extension_api("JS_GDI_GetClientDC", void* windowHWND)
Lua: identifier = reaper.JS_GDI_GetClientDC(identifier windowHWND)
Python: void JS_GDI_GetClientDC(void windowHWND)
Description:Returns the device context for the client area of the specified window.
| Parameters: |
| identifier windowHWND | - |
|
| Returnvalues: |
| identifier | - |
|
^ 
JS_GDI_GetScreenDC(JS)Functioncall:
C: void* JS_GDI_GetScreenDC()
EEL2: void* extension_api("JS_GDI_GetScreenDC")
Lua: identifier = reaper.JS_GDI_GetScreenDC()
Python: void JS_GDI_GetScreenDC()
Description:Returns a device context for the entire screen.
WARNING: Only available on Windows, not Linux or MacOS.
| Returnvalues: |
| identifier | - |
|
^ 
JS_GDI_GetSysColor(JS)Functioncall:
C: int JS_GDI_GetSysColor(const char* GUIElement)
EEL2: int extension_api("JS_GDI_GetSysColor", "GUIElement")
Lua: integer = reaper.JS_GDI_GetSysColor(string GUIElement)
Python: Int JS_GDI_GetSysColor(String GUIElement)
Description:
| Parameters: |
| string GUIElement | - |
|
^ 
JS_GDI_GetTextColor(JS)Functioncall:
C: int JS_GDI_GetTextColor(void* deviceHDC)
EEL2: int extension_api("JS_GDI_GetTextColor", void* deviceHDC)
Lua: integer = reaper.JS_GDI_GetTextColor(identifier deviceHDC)
Python: Int JS_GDI_GetTextColor(void deviceHDC)
Description:
| Parameters: |
| identifier deviceHDC | - |
|
^ 
JS_GDI_GetWindowDC(JS)Functioncall:
C: void* JS_GDI_GetWindowDC(void* windowHWND)
EEL2: void* extension_api("JS_GDI_GetWindowDC", void* windowHWND)
Lua: identifier = reaper.JS_GDI_GetWindowDC(identifier windowHWND)
Python: void JS_GDI_GetWindowDC(void windowHWND)
Description:Returns the device context for the entire window, including title bar and frame.
| Parameters: |
| identifier windowHWND | - |
|
| Returnvalues: |
| identifier | - |
|
^ 
JS_GDI_Line(JS)Functioncall:
C: void JS_GDI_Line(void* deviceHDC, int x1, int y1, int x2, int y2)
EEL2: extension_api("JS_GDI_Line", void* deviceHDC, int x1, int y1, int x2, int y2)
Lua: reaper.JS_GDI_Line(identifier deviceHDC, integer x1, integer y1, integer x2, integer y2)
Python: JS_GDI_Line(void deviceHDC, Int x1, Int y1, Int x2, Int y2)
Description:
| Parameters: |
| identifier deviceHDC | - |
|
| integer x1 | - |
|
| integer y1 | - |
|
| integer x2 | - |
|
| integer y2 | - |
|
^ 
JS_GDI_Polyline(JS)Functioncall:
C: void JS_GDI_Polyline(void* deviceHDC, const char* packedX, const char* packedY, int numPoints)
EEL2: extension_api("JS_GDI_Polyline", void* deviceHDC, "packedX", "packedY", int numPoints)
Lua: reaper.JS_GDI_Polyline(identifier deviceHDC, string packedX, string packedY, integer numPoints)
Python: JS_GDI_Polyline(void deviceHDC, String packedX, String packedY, Int numPoints)
Description:packedX and packedY are strings of points, each packed as "<i4".
| Parameters: |
| identifier deviceHDC | - |
|
| string packedX | - |
|
| string packedY | - |
|
| integer numPoints | - |
|
^ 
JS_GDI_ReleaseDC(JS)Functioncall:
C: void JS_GDI_ReleaseDC(void* windowHWND, void* deviceHDC)
EEL2: extension_api("JS_GDI_ReleaseDC", void* windowHWND, void* deviceHDC)
Lua: reaper.JS_GDI_ReleaseDC(identifier windowHWND, identifier deviceHDC)
Python: JS_GDI_ReleaseDC(void windowHWND, void deviceHDC)
Description:To release a window HDC, both arguments must be supplied: the HWND as well as the HDC. To release a screen DC, only the HDC needs to be supplied.
For compatibility with previous versions, the HWND and HDC can be supplied in any order.
NOTE: Any GDI HDC should be released immediately after drawing, and deferred scripts should get and release new DCs in each cycle.
| Parameters: |
| identifier windowHWND | - |
|
| identifier deviceHDC | - |
|
^ 
JS_GDI_SelectObject(JS)Functioncall:
C: void* JS_GDI_SelectObject(void* deviceHDC, void* GDIObject)
EEL2: void* extension_api("JS_GDI_SelectObject", void* deviceHDC, void* GDIObject)
Lua: identifier = reaper.JS_GDI_SelectObject(identifier deviceHDC, identifier GDIObject)
Python: void JS_GDI_SelectObject(void deviceHDC, void GDIObject)
Description:Activates a font, pen, or fill brush for subsequent drawing in the specified device context.
| Parameters: |
| identifier deviceHDC | - |
|
| identifier GDIObject | - |
|
| Returnvalues: |
| identifier | - |
|
^ 
JS_GDI_SetPixel(JS)Functioncall:
C: void JS_GDI_SetPixel(void* deviceHDC, int x, int y, int color)
EEL2: extension_api("JS_GDI_SetPixel", void* deviceHDC, int x, int y, int color)
Lua: reaper.JS_GDI_SetPixel(identifier deviceHDC, integer x, integer y, integer color)
Python: JS_GDI_SetPixel(void deviceHDC, Int x, Int y, Int color)
Description:
| Parameters: |
| identifier deviceHDC | - |
|
| integer x | - |
|
| integer y | - |
|
| integer color | - |
|
^ 
JS_GDI_SetTextBkColor(JS)Functioncall:
C: void JS_GDI_SetTextBkColor(void* deviceHDC, int color)
EEL2: extension_api("JS_GDI_SetTextBkColor", void* deviceHDC, int color)
Lua: reaper.JS_GDI_SetTextBkColor(identifier deviceHDC, integer color)
Python: JS_GDI_SetTextBkColor(void deviceHDC, Int color)
Description:
| Parameters: |
| identifier deviceHDC | - |
|
| integer color | - |
|
^ 
JS_GDI_SetTextBkMode(JS)Functioncall:
C: void JS_GDI_SetTextBkMode(void* deviceHDC, int mode)
EEL2: extension_api("JS_GDI_SetTextBkMode", void* deviceHDC, int mode)
Lua: reaper.JS_GDI_SetTextBkMode(identifier deviceHDC, integer mode)
Python: JS_GDI_SetTextBkMode(void deviceHDC, Int mode)
Description:
| Parameters: |
| identifier deviceHDC | - |
|
| integer mode | - |
|
^ 
JS_GDI_SetTextColor(JS)Functioncall:
C: void JS_GDI_SetTextColor(void* deviceHDC, int color)
EEL2: extension_api("JS_GDI_SetTextColor", void* deviceHDC, int color)
Lua: reaper.JS_GDI_SetTextColor(identifier deviceHDC, integer color)
Python: JS_GDI_SetTextColor(void deviceHDC, Int color)
Description:
| Parameters: |
| identifier deviceHDC | - |
|
| integer color | - |
|
^ 
JS_GDI_StretchBlit(JS)Functioncall:
C: void JS_GDI_StretchBlit(void* destHDC, int dstx, int dsty, int dstw, int dsth, void* sourceHDC, int srcx, int srxy, int srcw, int srch, const char* modeOptional)
EEL2: extension_api("JS_GDI_StretchBlit", void* destHDC, int dstx, int dsty, int dstw, int dsth, void* sourceHDC, int srcx, int srxy, int srcw, int srch, optional "mode")
Lua: reaper.JS_GDI_StretchBlit(identifier destHDC, integer dstx, integer dsty, integer dstw, integer dsth, identifier sourceHDC, integer srcx, integer srxy, integer srcw, integer srch, optional string mode)
Python: JS_GDI_StretchBlit(void destHDC, Int dstx, Int dsty, Int dstw, Int dsth, void sourceHDC, Int srcx, Int srxy, Int srcw, Int srch, String modeOptional)
Description:Blits between two device contexts, which may include LICE "system bitmaps".
modeOptional: "SRCCOPY" by default, or specify "ALPHA" to enable per-pixel alpha blending.
WARNING: On WindowsOS, GDI_Blit does not perform alpha multiplication of the source bitmap. For proper color rendering, a separate pre-multiplication step is therefore required, using either LICE_Blit or LICE_ProcessRect.
| Parameters: |
| identifier destHDC | - |
|
| integer dstx | - |
|
| integer dsty | - |
|
| integer dstw | - |
|
| integer dsth | - |
|
| identifier sourceHDC | - |
|
| integer srcx | - |
|
| integer srxy | - |
|
| integer srcw | - |
|
| integer srch | - |
|
| optional string mode | - |
|
^ 
JS_Int(JS)Functioncall:
C: void JS_Int(void* pointer, int offset, int* intOut)
EEL2: extension_api("JS_Int", void* pointer, int offset, int &int)
Lua: number int = reaper.JS_Int(identifier pointer, integer offset)
Python: (void pointer, Int offset, Int intOut) = JS_Int(pointer, offset, intOut)
Description:Returns the 4-byte signed integer at address[offset]. Offset is added as steps of 4 bytes each.
| Parameters: |
| identifier address | - |
|
| integer offset | - |
|
| Returnvalues: |
| number int | - |
|
^ 
JS_LICE_AlterBitmapHSV(JS)Functioncall:
C: void JS_LICE_AlterBitmapHSV(void* bitmap, double hue, double saturation, double value)
EEL2: extension_api("JS_LICE_AlterBitmapHSV", void* bitmap, hue, saturation, value)
Lua: reaper.JS_LICE_AlterBitmapHSV(identifier bitmap, number hue, number saturation, number value)
Python: (JS_LICE_AlterBitmapHSV(void bitmap, Float hue, Float saturation, Float value)
Description:Hue is rolled over, saturation and value are clamped, all 0..1. (Alpha remains unchanged.)
| Parameters: |
| identifier bitmap | - |
|
| number hue | - |
|
| number saturation | - |
|
| number value | - |
|
^ 
JS_LICE_AlterRectHSV(JS)Functioncall:
C: void JS_LICE_AlterRectHSV(void* bitmap, int x, int y, int w, int h, double hue, double saturation, double value)
EEL2: extension_api("JS_LICE_AlterRectHSV", void* bitmap, int x, int y, int w, int h, hue, saturation, value)
Lua: reaper.JS_LICE_AlterRectHSV(identifier bitmap, integer x, integer y, integer w, integer h, number hue, number saturation, number value)
Python: JS_LICE_AlterRectHSV(void bitmap, Int x, Int y, Int w, Int h, Float hue, Float saturation, Float value)
Description:Hue is rolled over, saturation and value are clamped, all 0..1. (Alpha remains unchanged.)
| Parameters: |
| identifier bitmap | - |
|
| integer x | - |
|
| integer y | - |
|
| integer w | - |
|
| integer h | - |
|
| number hue | - |
|
| number saturation | - |
|
| number value | - |
|
^ 
JS_LICE_Arc(JS)Functioncall:
C: void JS_LICE_Arc(void* bitmap, double cx, double cy, double r, double minAngle, double maxAngle, int color, double alpha, const char* mode, bool antialias)
EEL2: extension_api("JS_LICE_Arc", void* bitmap, cx, cy, r, minAngle, maxAngle, int color, alpha, "mode", bool antialias)
Lua: reaper.JS_LICE_Arc(identifier bitmap, number cx, number cy, number r, number minAngle, number maxAngle, integer color, number alpha, string mode, boolean antialias)
Python: JS_LICE_Arc(void bitmap, Float cx, Float cy, Float r, Float minAngle, Float maxAngle, Int color, Float alpha, String mode, Boolean antialias)
Description:LICE modes: "COPY" (default if empty string), "MASK", "ADD", "DODGE", "MUL", "OVERLAY" or "HSVADJ", any of which may be combined with "ALPHA".
LICE color format: 0xAARRGGBB (AA is only used in ALPHA mode).
| Parameters: |
| identifier bitmap | - |
|
| number cx | - |
|
| number cy | - |
|
| number r | - |
|
| number minAngle | - |
|
| number maxAngle | - |
|
| integer color | - |
|
| number alpha | - |
|
| string mode | - |
|
| boolean antialias | - |
|
^ 
JS_LICE_ArrayAllBitmaps(JS)Functioncall:
C: int JS_LICE_ArrayAllBitmaps(void* reaperarray)
EEL2: int extension_api("JS_LICE_ArrayAllBitmaps", void* reaperarray)
Lua: integer retval = reaper.JS_LICE_ArrayAllBitmaps(identifier reaperarray)
Python: Int JS_LICE_ArrayAllBitmaps(void reaperarray)
Description:
| Parameters: |
| identifier reaperarray | - |
|
| Returnvalues: |
| integer retval | - |
|
^ 
JS_LICE_Bezier(JS)Functioncall:
C: void JS_LICE_Bezier(void* bitmap, double xstart, double ystart, double xctl1, double yctl1, double xctl2, double yctl2, double xend, double yend, double tol, int color, double alpha, const char* mode, bool antialias)
EEL2: extension_api("JS_LICE_Bezier", void* bitmap, xstart, ystart, xctl1, yctl1, xctl2, yctl2, xend, yend, tol, int color, alpha, "mode", bool antialias)
Lua: reaper.JS_LICE_Bezier(identifier bitmap, number xstart, number ystart, number xctl1, number yctl1, number xctl2, number yctl2, number xend, number yend, number tol, integer color, number alpha, string mode, boolean antialias)
Python: JS_LICE_Bezier(void bitmap, Float xstart, Float ystart, Float xctl1, Float yctl1, Float xctl2, Float yctl2, Float xend, Float yend, Float tol, Int color, Float alpha, String mode, Boolean antialias)
Description:LICE modes: "COPY" (default if empty string), "MASK", "ADD", "DODGE", "MUL", "OVERLAY" or "HSVADJ", any of which may be combined with "ALPHA" to enable per-pixel alpha blending.
LICE color format: 0xAARRGGBB (AA is only used in ALPHA mode).
| Parameters: |
| identifier bitmap | - |
|
| number xstart | - |
|
| number ystart | - |
|
| number xctl1 | - |
|
| number yctl1 | - |
|
| number xctl2 | - |
|
| number yctl2 | - |
|
| number xend | - |
|
| number yend | - |
|
| number tol | - |
|
| integer color | - |
|
| number alpha | - |
|
| string mode | - |
|
| boolean antialias | - |
|
^ 
JS_LICE_Blit(JS)Functioncall:
C: void JS_LICE_Blit(void* destBitmap, int dstx, int dsty, void* sourceBitmap, int srcx, int srcy, int width, int height, double alpha, const char* mode)
EEL2: extension_api("JS_LICE_Blit", void* destBitmap, int dstx, int dsty, void* sourceBitmap, int srcx, int srcy, int width, int height, alpha, "mode")
Lua: reaper.JS_LICE_Blit(identifier destBitmap, integer dstx, integer dsty, identifier sourceBitmap, integer srcx, integer srcy, integer width, integer height, number alpha, string mode)
Python: JS_LICE_Blit(void destBitmap, Int dstx, Int dsty, void sourceBitmap, Int srcx, Int srcy, Int width, Int height, Float alpha, String mode)
Description:Standard LICE modes: "COPY" (default if empty string), "MASK", "ADD", "DODGE", "MUL", "OVERLAY" or "HSVADJ", any of which may be combined with "ALPHA" to enable per-pixel alpha blending.
In addition to the standard LICE modes, LICE_Blit also offers:
* "CHANCOPY_XTOY", with X and Y any of the four channels, A, R, G or B. (CHANCOPY_ATOA is similar to MASK mode.)
* "BLUR"
* "ALPHAMUL", which overwrites the destination with a per-pixel alpha-multiplied copy of the source. (Similar to first clearing the destination with 0x00000000 and then blitting with "COPY,ALPHA".)
| Parameters: |
| identifier destBitmap | - |
|
| integer dstx | - |
|
| integer dsty | - |
|
| identifier sourceBitmap | - |
|
| integer srcx | - |
|
| integer srcy | - |
|
| integer width | - |
|
| integer height | - |
|
| number alpha | - |
|
| string mode | - |
|
^ 
JS_LICE_Circle(JS)Functioncall:
C: void JS_LICE_Circle(void* bitmap, double cx, double cy, double r, int color, double alpha, const char* mode, bool antialias)
EEL2: extension_api("JS_LICE_Circle", void* bitmap, cx, cy, r, int color, alpha, "mode", bool antialias)
Lua: reaper.JS_LICE_Circle(identifier bitmap, number cx, number cy, number r, integer color, number alpha, string mode, boolean antialias)
Python: JS_LICE_Circle(void bitmap, Float cx, Float cy, Float r, Int color, Float alpha, String mode, Boolean antialias)
Description:LICE modes: "COPY" (default if empty string), "MASK", "ADD", "DODGE", "MUL", "OVERLAY" or "HSVADJ", any of which may be combined with "ALPHA".
LICE color format: 0xAARRGGBB (AA is only used in ALPHA mode).
| Parameters: |
| identifier bitmap | - |
|
| number cx | - |
|
| number cy | - |
|
| number r | - |
|
| integer color | - |
|
| number alpha | - |
|
| string mode | - |
|
| boolean antialias | - |
|
^ 
JS_LICE_Clear(JS)Functioncall:
C: void JS_LICE_Clear(void* bitmap, int color)
EEL2: extension_api("JS_LICE_Clear", void* bitmap, int color)
Lua: reaper.JS_LICE_Clear(identifier bitmap, integer color)
Python: JS_LICE_Clear(void bitmap, Int color)
Description:
| Parameters: |
| identifier bitmap | - |
|
| integer color | - |
|
^ 
JS_LICE_CreateBitmap(JS)Functioncall:
C: void* JS_LICE_CreateBitmap(bool isSysBitmap, int width, int height)
EEL2: void* extension_api("JS_LICE_CreateBitmap", bool isSysBitmap, int width, int height)
Lua: identifier = reaper.JS_LICE_CreateBitmap(boolean isSysBitmap, integer width, integer height)
Python: void JS_LICE_CreateBitmap(Boolean isSysBitmap, Int width, Int height)
Description:
| Parameters: |
| boolean isSysBitmap | - |
|
| integer width | - |
|
| integer height | - |
|
| Returnvalues: |
| identifier | - |
|
^ 
JS_LICE_CreateFont(JS)Functioncall:
C: void* JS_LICE_CreateFont()
EEL2: void* extension_api("JS_LICE_CreateFont")
Lua: identifier = reaper.JS_LICE_CreateFont()
Python: void JS_LICE_CreateFont()
Description:
| Returnvalues: |
| identifier | - |
|
^ 
JS_LICE_DestroyBitmap(JS)Functioncall:
C: void JS_LICE_DestroyBitmap(void* bitmap)
EEL2: extension_api("JS_LICE_DestroyBitmap", void* bitmap)
Lua: reaper.JS_LICE_DestroyBitmap(identifier bitmap)
Python: JS_LICE_DestroyBitmap(void bitmap)
Description:Deletes the bitmap, and also unlinks bitmap from any composited window.
| Parameters: |
| identifier bitmap | - |
|
^ 
JS_LICE_DestroyFont(JS)Functioncall:
C: void JS_LICE_DestroyFont(void* LICEFont)
EEL2: extension_api("JS_LICE_DestroyFont", void* LICEFont)
Lua: reaper.JS_LICE_DestroyFont(identifier LICEFont)
Python: JS_LICE_DestroyFont(void LICEFont)
Description:
| Parameters: |
| identifier LICEFont | - |
|
^ 
JS_LICE_DrawChar(JS)Functioncall:
C: void JS_LICE_DrawChar(void* bitmap, int x, int y, char c, int color, double alpha, int mode))
EEL2: extension_api("JS_LICE_DrawChar", void* bitmap, int x, int y, char c, int color, alpha, int mode))
Lua: reaper.JS_LICE_DrawChar(identifier bitmap, integer x, integer y, integer c, integer color, number alpha, integer mode))
Python: JS_LICE_DrawChar(void bitmap, Int x, Int y, Int c, Int color, Float alpha, Int mode))
Description:
| Parameters: |
| identifier bitmap | - |
|
| integer x | - |
|
| integer y | - |
|
| integer c | - |
|
| integer color | - |
|
| number alpha | - |
|
| integer mode | - |
|
^ 
JS_LICE_DrawText(JS)Functioncall:
C: int JS_LICE_DrawText(void* bitmap, void* LICEFont, const char* text, int textLen, int x1, int y1, int x2, int y2)
EEL2: int extension_api("JS_LICE_DrawText", void* bitmap, void* LICEFont, "text", int textLen, int x1, int y1, int x2, int y2)
Lua: integer = reaper.JS_LICE_DrawText(identifier bitmap, identifier LICEFont, string text, integer textLen, integer x1, integer y1, integer x2, integer y2)
Python: Int JS_LICE_DrawText(void bitmap, void LICEFont, String text, Int textLen, Int x1, Int y1, Int x2, Int y2)
Description:
| Parameters: |
| identifier bitmap | - |
|
| identifier LICEFont | - |
|
| string text | - |
|
| integer textLen | - |
|
| integer x1 | - |
|
| integer y1 | - |
|
| integer x2 | - |
|
| integer y2 | - |
|
^ 
JS_LICE_FillCircle(JS)Functioncall:
C: void JS_LICE_FillCircle(void* bitmap, double cx, double cy, double r, int color, double alpha, const char* mode, bool antialias)
EEL2: extension_api("JS_LICE_FillCircle", void* bitmap, cx, cy, r, int color, alpha, "mode", bool antialias)
Lua: reaper.JS_LICE_FillCircle(identifier bitmap, number cx, number cy, number r, integer color, number alpha, string mode, boolean antialias)
Python: JS_LICE_FillCircle(void bitmap, Float cx, Float cy, Float r, Int color, Float alpha, String mode, Boolean antialias)
Description:LICE modes: "COPY" (default if empty string), "MASK", "ADD", "DODGE", "MUL", "OVERLAY" or "HSVADJ", any of which may be combined with "ALPHA".
LICE color format: 0xAARRGGBB (AA is only used in ALPHA mode).
| Parameters: |
| identifier bitmap | - |
|
| number cx | - |
|
| number cy | - |
|
| number r | - |
|
| integer color | - |
|
| number alpha | - |
|
| string mode | - |
|
| boolean antialias | - |
|
^ 
JS_LICE_FillPolygon(JS)Functioncall:
C: void JS_LICE_FillPolygon(void* bitmap, const char* packedX, const char* packedY, int numPoints, int color, double alpha, const char* mode)
EEL2: extension_api("JS_LICE_FillPolygon", void* bitmap, "packedX", "packedY", int numPoints, int color, alpha, "mode")
Lua: reaper.JS_LICE_FillPolygon(identifier bitmap, string packedX, string packedY, integer numPoints, integer color, number alpha, string mode)
Python: JS_LICE_FillPolygon(void bitmap, String packedX, String packedY, Int numPoints, Int color, Float alpha, String mode)
Description:packedX and packedY are two strings of coordinates, each packed as "<i4".
LICE modes : "COPY" (default if empty string), "MASK", "ADD", "DODGE", "MUL", "OVERLAY" or "HSVADJ", any of which may be combined with "ALPHA" to enable per-pixel alpha blending.
LICE color format: 0xAARRGGBB (AA is only used in ALPHA mode).
| Parameters: |
| identifier bitmap | - |
|
| string packedX | - |
|
| string packedY | - |
|
| integer numPoints | - |
|
| integer color | - |
|
| number alpha | - |
|
| string mode | - |
|
^ 
JS_LICE_FillRect(JS)Functioncall:
C: void JS_LICE_FillRect(void* bitmap, int x, int y, int w, int h, int color, double alpha, const char* mode)
EEL2: extension_api("JS_LICE_FillRect", void* bitmap, int x, int y, int w, int h, int color, alpha, "mode")
Lua: reaper.JS_LICE_FillRect(identifier bitmap, integer x, integer y, integer w, integer h, integer color, number alpha, string mode)
Python: JS_LICE_FillRect(void bitmap, Int x, Int y, Int w, Int h, Int color, Float alpha, String mode)
Description:LICE modes: "COPY" (default if empty string), "MASK", "ADD", "DODGE", "MUL", "OVERLAY" or "HSVADJ", any of which may be combined with "ALPHA".
LICE color format: 0xAARRGGBB (AA is only used in ALPHA mode).
| Parameters: |
| identifier bitmap | - |
|
| integer x | - |
|
| integer y | - |
|
| integer w | - |
|
| integer h | - |
|
| integer color | - |
|
| number alpha | - |
|
| string mode | - |
|
^ 
JS_LICE_FillTriangle(JS)Functioncall:
C: void JS_LICE_FillTriangle(void* bitmap, int x1, int y1, int x2, int y2, int x3, int y3, int color, double alpha, const char* mode)
EEL2: extension_api("JS_LICE_FillTriangle", void* bitmap, int x1, int y1, int x2, int y2, int x3, int y3, int color, alpha, "mode")
Lua: reaper.JS_LICE_FillTriangle(identifier bitmap, integer x1, integer y1, integer x2, integer y2, integer x3, integer y3, integer color, number alpha, string mode)
Python: JS_LICE_FillTriangle(void bitmap, Int x1, Int y1, Int x2, Int y2, Int x3, Int y3, Int color, Float alpha, String mode)
Description:LICE modes: "COPY" (default if empty string), "MASK", "ADD", "DODGE", "MUL", "OVERLAY" or "HSVADJ", any of which may be combined with "ALPHA".
LICE color format: 0xAARRGGBB (AA is only used in ALPHA mode).
| Parameters: |
| identifier bitmap | - |
|
| integer x1 | - |
|
| integer y1 | - |
|
| integer x2 | - |
|
| integer y2 | - |
|
| integer x3 | - |
|
| integer y3 | - |
|
| integer color | - |
|
| number alpha | - |
|
| string mode | - |
|
^ 
JS_LICE_GetDC(JS)Functioncall:
C: void* JS_LICE_GetDC(void* bitmap)
EEL2: void* extension_api("JS_LICE_GetDC", void* bitmap)
Lua: identifier = reaper.JS_LICE_GetDC(identifier bitmap)
Python: void JS_LICE_GetDC(void bitmap)
Description:
| Parameters: |
| identifier bitmap | - |
|
| Returnvalues: |
| identifier | - |
|
^ 
JS_LICE_GetHeight(JS)Functioncall:
C: int JS_LICE_GetHeight(void* bitmap)
EEL2: int extension_api("JS_LICE_GetHeight", void* bitmap)
Lua: integer = reaper.JS_LICE_GetHeight(identifier bitmap)
Python: Int JS_LICE_GetHeight(void bitmap)
Description:
| Parameters: |
| identifier bitmap | - |
|
^ 
JS_LICE_GetPixel(JS)Functioncall:
C: int JS_LICE_GetPixel(void* bitmap, int x, int y)
EEL2: int extension_api("JS_LICE_GetPixel", void* bitmap, int x, int y)
Lua: integer = reaper.JS_LICE_GetPixel(identifier bitmap, integer x, integer y)
Python: Int JS_LICE_GetPixel(void bitmap, Int x, Int y)
Description:Returns the color of the specified pixel.
| Parameters: |
| identifier bitmap | - |
|
| integer x | - |
|
| integer y | - |
|
^ 
JS_LICE_GetWidth(JS)Functioncall:
C: int JS_LICE_GetWidth(void* bitmap)
EEL2: int extension_api("JS_LICE_GetWidth", void* bitmap)
Lua: integer = reaper.JS_LICE_GetWidth(identifier bitmap)
Python: Int JS_LICE_GetWidth(void bitmap)
Description:
| Parameters: |
| identifier bitmap | - |
|
^ 
JS_LICE_GradRect(JS)Functioncall:
C: void JS_LICE_GradRect(void* bitmap, int dstx, int dsty, int dstw, int dsth, double ir, double ig, double ib, double ia, double drdx, double dgdx, double dbdx, double dadx, double drdy, double dgdy, double dbdy, double dady, const char* mode)
EEL2: extension_api("JS_LICE_GradRect", void* bitmap, int dstx, int dsty, int dstw, int dsth, ir, ig, ib, ia, drdx, dgdx, dbdx, dadx, drdy, dgdy, dbdy, dady, "mode")
Lua: reaper.JS_LICE_GradRect(identifier bitmap, integer dstx, integer dsty, integer dstw, integer dsth, number ir, number ig, number ib, number ia, number drdx, number dgdx, number dbdx, number dadx, number drdy, number dgdy, number dbdy, number dady, string mode)
Python: JS_LICE_GradRect(void bitmap, Int dstx, Int dsty, Int dstw, Int dsth, Float ir, Float ig, Float ib, Float ia, Float drdx, Float dgdx, Float dbdx, Float dadx, Float drdy, Float dgdy, Float dbdy, Float dady, String mode)
Description:
| Parameters: |
| identifier bitmap | - |
|
| integer dstx | - |
|
| integer dsty | - |
|
| integer dstw | - |
|
| integer dsth | - |
|
| number ir | - |
|
| number ig | - |
|
| number ib | - |
|
| number ia | - |
|
| number drdx | - |
|
| number dgdx | - |
|
| number dbdx | - |
|
| number dadx | - |
|
| number drdy | - |
|
| number dgdy | - |
|
| number dbdy | - |
|
| number dady | - |
|
| string mode | - |
|
^ 
JS_LICE_IsFlipped(JS)Functioncall:
C: bool JS_LICE_IsFlipped(void* bitmap)
EEL2: bool extension_api("JS_LICE_IsFlipped", void* bitmap)
Lua: boolean = reaper.JS_LICE_IsFlipped(identifier bitmap)
Python: Boolean JS_LICE_IsFlipped(void bitmap)
Description:
| Parameters: |
| identifier bitmap | - |
|
^ 
JS_LICE_Line(JS)Functioncall:
C: void JS_LICE_Line(void* bitmap, double x1, double y1, double x2, double y2, int color, double alpha, const char* mode, bool antialias)
EEL2: extension_api("JS_LICE_Line", void* bitmap, x1, y1, x2, y2, int color, alpha, "mode", bool antialias)
Lua: reaper.JS_LICE_Line(identifier bitmap, number x1, number y1, number x2, number y2, integer color, number alpha, string mode, boolean antialias)
Python: JS_LICE_Line(void bitmap, Float x1, Float y1, Float x2, Float y2, Int color, Float alpha, String mode, Boolean antialias)
Description:LICE modes: "COPY" (default if empty string), "MASK", "ADD", "DODGE", "MUL", "OVERLAY" or "HSVADJ", any of which may be combined with "ALPHA".
LICE color format: 0xAARRGGBB (AA is only used in ALPHA mode).
| Parameters: |
| identifier bitmap | - |
|
| number x1 | - |
|
| number y1 | - |
|
| number x2 | - |
|
| number y2 | - |
|
| integer color | - |
|
| number alpha | - |
|
| string mode | - |
|
| boolean antialias | - |
|
^ 
JS_LICE_ListAllBitmaps(JS)Functioncall:
C: int JS_LICE_ListAllBitmaps(char* listOutNeedBig, int listOutNeedBig_sz)
EEL2: int extension_api("JS_LICE_ListAllBitmaps", #list)
Lua: integer retval, string list = reaper.JS_LICE_ListAllBitmaps()
Python: (Int retval, String listOutNeedBig, Int listOutNeedBig_sz) = JS_LICE_ListAllBitmaps(listOutNeedBig, listOutNeedBig_sz)
Description:
| Returnvalues: |
| integer retval | - |
|
| string list | - |
|
^ 
JS_LICE_LoadJPG(JS)Functioncall:
C: void* JS_LICE_LoadJPG(const char* filename)
EEL2: void* extension_api("JS_LICE_LoadJPG", "filename")
Lua: identifier = reaper.JS_LICE_LoadJPG(string filename)
Python: void JS_LICE_LoadJPG(String filename)
Description:Returns a system LICE bitmap containing the JPEG.
| Parameters: |
| string filename | - | the filename+path of the jpg-file to load
|
| Returnvalues: |
| identifier | - | the bitmap, which holds the jpg
|
^ 
JS_LICE_LoadPNG(JS)Functioncall:
C: void* JS_LICE_LoadPNG(const char* filename)
EEL2: void* extension_api("JS_LICE_LoadPNG", "filename")
Lua: identifier = reaper.JS_LICE_LoadPNG(string filename)
Python: void JS_LICE_LoadPNG(String filename)
Description:Returns a system LICE bitmap containing the PNG.
| Parameters: |
| string filename | - | the filename with path of the png filename to load
|
| Returnvalues: |
| identifier | - |
|
^ 
JS_LICE_MeasureText(JS)Functioncall:
C: void JS_LICE_MeasureText(const char* text, int* widthOut, int* HeightOut)
EEL2: extension_api("JS_LICE_MeasureText", "text", int &width, int &Height)
Lua: number width, number Height = reaper.JS_LICE_MeasureText(string text)
Python: (String text, Int widthOut, Int HeightOut) = JS_LICE_MeasureText(text, widthOut, HeightOut)
Description:
| Parameters: |
| string text | - |
|
| Returnvalues: |
| number width | - |
|
| number Height | - |
|
^ 
JS_LICE_ProcessRect(JS)Functioncall:
C: bool JS_LICE_ProcessRect(void* bitmap, int x, int y, int w, int h, const char* mode, double operand)
EEL2: bool extension_api("JS_LICE_ProcessRect", void* bitmap, int x, int y, int w, int h, "mode", operand)
Lua: boolean = reaper.JS_LICE_ProcessRect(identifier bitmap, integer x, integer y, integer w, integer h, string mode, number operand)
Python: Boolean JS_LICE_ProcessRect(void bitmap, Int x, Int y, Int w, Int h, String mode, Float operand)
Description:Applies bitwise operations to each pixel in the target rectangle.
operand: a color in 0xAARRGGBB format.
modes:
* "XOR", "OR" or "AND".
* "SET_XYZ", with XYZ any combination of A, R, G, and B: copies the specified channels from operand to the bitmap. (Useful for setting the alpha values of a bitmap.)
* "ALPHAMUL": Performs alpha pre-multiplication on each pixel in the rect. operand is ignored in this mode. (On WindowsOS, GDI_Blit does not perform alpha multiplication on the fly, and a separate alpha pre-multiplication step is therefore required.)
NOTE:
LICE_Blit and LICE_ScaledBlit are also useful for processing bitmap colors. For example, to multiply all channel values by 1.5:
reaper.JS_LICE_Blit(bitmap, x, y, bitmap, x, y, w, h, 0.5, "ADD").
| Parameters: |
| identifier bitmap | - |
|
| integer x | - |
|
| integer y | - |
|
| integer w | - |
|
| integer h | - |
|
| string mode | - |
|
| number operand | - |
|
^ 
JS_LICE_PutPixel(JS)Functioncall:
C: void JS_LICE_PutPixel(void* bitmap, int x, int y, int color, double alpha, const char* mode)
EEL2: extension_api("JS_LICE_PutPixel", void* bitmap, int x, int y, int color, alpha, "mode")
Lua: reaper.JS_LICE_PutPixel(identifier bitmap, integer x, integer y, integer color, number alpha, string mode)
Python: JS_LICE_PutPixel(void bitmap, Int x, Int y, Int color, Float alpha, String mode)
Description:LICE modes: "COPY" (default if empty string), "MASK", "ADD", "DODGE", "MUL", "OVERLAY" or "HSVADJ", any of which may be combined with "ALPHA".
LICE color format: 0xAARRGGBB (AA is only used in ALPHA mode).
| Parameters: |
| identifier bitmap | - |
|
| integer x | - |
|
| integer y | - |
|
| integer color | - |
|
| number alpha | - |
|
| string mode | - |
|
^ 
JS_LICE_Resize(JS)Functioncall:
C: void JS_LICE_Resize(void* bitmap, int width, int height)
EEL2: extension_api("JS_LICE_Resize", void* bitmap, int width, int height)
Lua: reaper.JS_LICE_Resize(identifier bitmap, integer width, integer height)
Python: JS_LICE_Resize(void bitmap, Int width, Int height)
Description:
| Parameters: |
| identifier bitmap | - |
|
| integer width | - |
|
| integer height | - |
|
^ 
JS_LICE_RotatedBlit(JS)Functioncall:
C: void JS_LICE_RotatedBlit(void* destBitmap, int dstx, int dsty, int dstw, int dsth, void* sourceBitmap, double srcx, double srcy, double srcw, double srch, double angle, double rotxcent, double rotycent, bool cliptosourcerect, double alpha, const char* mode)
EEL2: extension_api("JS_LICE_RotatedBlit", void* destBitmap, int dstx, int dsty, int dstw, int dsth, void* sourceBitmap, srcx, srcy, srcw, srch, angle, rotxcent, rotycent, bool cliptosourcerect, alpha, "mode")
Lua: reaper.JS_LICE_RotatedBlit(identifier destBitmap, integer dstx, integer dsty, integer dstw, integer dsth, identifier sourceBitmap, number srcx, number srcy, number srcw, number srch, number angle, number rotxcent, number rotycent, boolean cliptosourcerect, number alpha, string mode)
Python: JS_LICE_RotatedBlit(void destBitmap, Int dstx, Int dsty, Int dstw, Int dsth, void sourceBitmap, Float srcx, Float srcy, Float srcw, Float srch, Float angle, Float rotxcent, Float rotycent, Boolean cliptosourcerect, Float alpha, String mode)
Description:LICE modes: "COPY" (default if empty string), "MASK", "ADD", "DODGE", "MUL", "OVERLAY" or "HSVADJ", any of which may be combined with "ALPHA" to enable per-pixel alpha blending.
| Parameters: |
| identifier destBitmap | - |
|
| integer dstx | - |
|
| integer dsty | - |
|
| integer dstw | - |
|
| integer dsth | - |
|
| identifier sourceBitmap | - |
|
| number srcx | - |
|
| number srcy | - |
|
| number srcw | - |
|
| number srch | - |
|
| number angle | - |
|
| number rotxcent | - |
|
| number rotycent | - |
|
| boolean cliptosourcerect | - |
|
| number alpha | - |
|
| string mode | - |
|
^ 
JS_LICE_RoundRect(JS)Functioncall:
C: void JS_LICE_RoundRect(void* bitmap, double x, double y, double w, double h, int cornerradius, int color, double alpha, const char* mode, bool antialias)
EEL2: extension_api("JS_LICE_RoundRect", void* bitmap, x, y, w, h, int cornerradius, int color, alpha, "mode", bool antialias)
Lua: reaper.JS_LICE_RoundRect(identifier bitmap, number x, number y, number w, number h, integer cornerradius, integer color, number alpha, string mode, boolean antialias)
Python: JS_LICE_RoundRect(void bitmap, Float x, Float y, Float w, Float h, Int cornerradius, Int color, Float alpha, String mode, Boolean antialias)
Description:LICE modes: "COPY" (default if empty string), "MASK", "ADD", "DODGE", "MUL", "OVERLAY" or "HSVADJ", any of which may be combined with "ALPHA".
LICE color format: 0xAARRGGBB (AA is only used in ALPHA mode).
| Parameters: |
| identifier bitmap | - |
|
| number x | - |
|
| number y | - |
|
| number w | - |
|
| number h | - |
|
| integer cornerradius | - |
|
| integer color | - |
|
| number alpha | - |
|
| string mode | - |
|
| boolean antialias | - |
|
^ 
JS_LICE_ScaledBlit(JS)Functioncall:
C: void JS_LICE_ScaledBlit(void* destBitmap, int dstx, int dsty, int dstw, int dsth, void* srcBitmap, double srcx, double srcy, double srcw, double srch, double alpha, const char* mode)
EEL2: extension_api("JS_LICE_ScaledBlit", void* destBitmap, int dstx, int dsty, int dstw, int dsth, void* srcBitmap, srcx, srcy, srcw, srch, alpha, "mode")
Lua: reaper.JS_LICE_ScaledBlit(identifier destBitmap, integer dstx, integer dsty, integer dstw, integer dsth, identifier srcBitmap, number srcx, number srcy, number srcw, number srch, number alpha, string mode)
Python: JS_LICE_ScaledBlit(void destBitmap, Int dstx, Int dsty, Int dstw, Int dsth, void srcBitmap, Float srcx, Float srcy, Float srcw, Float srch, Float alpha, String mode)
Description:LICE modes: "COPY" (default if empty string), "MASK", "ADD", "DODGE", "MUL", "OVERLAY" or "HSVADJ", any of which may be combined with "ALPHA" to enable per-pixel alpha blending.
| Parameters: |
| identifier destBitmap | - |
|
| integer dstx | - |
|
| integer dsty | - |
|
| integer dstw | - |
|
| integer dsth | - |
|
| identifier srcBitmap | - |
|
| number srcx | - |
|
| number srcy | - |
|
| number srcw | - |
|
| number srch | - |
|
| number alpha | - |
|
| string mode | - |
|
^ 
JS_LICE_SetAlphaFromColorMask(JS)Functioncall:
C: void JS_LICE_SetAlphaFromColorMask(void* bitmap, int colorRGB)
EEL2: extension_api("JS_LICE_SetAlphaFromColorMask", void* bitmap, int colorRGB)
Lua: reaper.JS_LICE_SetAlphaFromColorMask(identifier bitmap, integer colorRGB)
Python: JS_LICE_SetAlphaFromColorMask(void bitmap, Int colorRGB)
Description:Sets all pixels that match the given color's RGB values to fully transparent, and all other pixels to fully opaque. (All pixels' RGB values remain unchanged.)
| Parameters: |
| identifier bitmap | - |
|
| integer colorRGB | - |
|
^ 
JS_LICE_SetFontBkColor(JS)Functioncall:
C: void JS_LICE_SetFontBkColor(void* LICEFont, int color)
EEL2: extension_api("JS_LICE_SetFontBkColor", void* LICEFont, int color)
Lua: reaper.JS_LICE_SetFontBkColor(identifier LICEFont, integer color)
Python: JS_LICE_SetFontBkColor(void LICEFont, Int color)
Description:
| Parameters: |
| identifier LICEFont | - |
|
| integer color | - |
|
^ 
JS_LICE_SetFontColor(JS)Functioncall:
C: void JS_LICE_SetFontColor(void* LICEFont, int color)
EEL2: extension_api("JS_LICE_SetFontColor", void* LICEFont, int color)
Lua: reaper.JS_LICE_SetFontColor(identifier LICEFont, integer color)
Python: JS_LICE_SetFontColor(void LICEFont, Int color)
Description:
| Parameters: |
| identifier LICEFont | - |
|
| integer color | - |
|
^ 
JS_LICE_SetFontFromGDI(JS)Functioncall:
C: void JS_LICE_SetFontFromGDI(void* LICEFont, void* GDIFont, const char* moreFormats)
EEL2: extension_api("JS_LICE_SetFontFromGDI", void* LICEFont, void* GDIFont, "moreFormats")
Lua: reaper.JS_LICE_SetFontFromGDI(identifier LICEFont, identifier GDIFont, string moreFormats)
Python: JS_LICE_SetFontFromGDI(void LICEFont, void GDIFont, String moreFormats)
Description:Converts a GDI font into a LICE font.
The font can be modified by the following flags, in a comma-separated list:
"VERTICAL", "BOTTOMUP", "NATIVE", "BLUR", "INVERT", "MONO", "SHADOW" or "OUTLINE".
| Parameters: |
| identifier LICEFont | - |
|
| identifier GDIFont | - |
|
| string moreFormats | - |
|
^ 
JS_LICE_WriteJPG(JS)Functioncall:
C: bool JS_LICE_WriteJPG(const char* filename, LICE_IBitmap* bitmap, int quality, bool* forceBaselineOptional)
EEL2: bool extension_api("JS_LICE_WriteJPG", "filename", LICE_IBitmap bitmap, int quality, bool forceBaselineOptional)
Lua: boolean = reaper.JS_LICE_WriteJPG(string filename, LICE_IBitmap bitmap, integer quality, optional boolean forceBaseline)
Python: (Boolean retval, String filename, LICE_IBitmap bitmap, Int quality, Boolean forceBaselineOptional) = JS_LICE_WriteJPG(filename, bitmap, quality, forceBaselineOptional)
Description:Parameters:
* quality is an integer in the range 1..100.
* forceBaseline is an optional boolean parameter that ensures compatibility with all JPEG viewers by preventing too low quality, "cubist" settings.
| Parameters: |
| string filename | - | the filename+path of the jpg to write
|
| LICE_IBitmap bitmap | - | the bitmap, that you want to write as jpg-file
|
| integer quality | - | the quality-setting in percent, from 1(lowest quality) to 100(highest quality)
|
| optional boolean forceBaseline | - | true, ensure compatibility with all JPEG-viewers(prevent too low quality); nil or false, allow too low quality(possible compatibility-problems with some JPEG-viewers)
|
| Returnvalues: |
| boolean retval | - | true, writing was successful; false, writing was unsuccessful
|
^ 
JS_LICE_WritePNG(JS)Functioncall:
C: bool JS_LICE_WritePNG(const char* filename, LICE_IBitmap* bitmap, bool wantAlpha)
EEL2: bool extension_api("JS_LICE_WritePNG", "filename", LICE_IBitmap bitmap, bool wantAlpha)
Lua: boolean = reaper.JS_LICE_WritePNG(string filename, LICE_IBitmap bitmap, boolean wantAlpha)
Python: Boolean JS_LICE_WritePNG(String filename, LICE_IBitmap bitmap, Boolean wantAlpha)
Description:Writes the contents of a LICE_IBitMap as png-file.
| Parameters: |
| string filename | - | the filename+path of the png-file to write
|
| LICE_IBitmap bitmap | - | the bitmap, whose contents shall be written as png-file
|
| boolean wantAlpha | - | true, store alpha; false, don't store alpha
|
| Returnvalues: |
| boolean retval | - | true, writing was successful; false, writing was not successful
|
^ 
JS_ListView_EnsureVisible(JS)Functioncall:
C: void JS_ListView_EnsureVisible(void* listviewHWND, int index, bool partialOK)
EEL2: extension_api("JS_ListView_EnsureVisible", void* listviewHWND, int index, bool partialOK)
Lua: reaper.JS_ListView_EnsureVisible(identifier listviewHWND, integer index, boolean partialOK)
Python: JS_ListView_EnsureVisible(void listviewHWND, Int index, Boolean partialOK)
Description:
| Parameters: |
| identifier listviewHWND | - |
|
| integer index | - |
|
| boolean partialOK | - |
|
^ 
JS_Localize(JS)Functioncall:
C: void JS_Localize(const char* USEnglish, const char* LangPackSection, char* translationOut, int translationOut_sz)
EEL2: extension_api("JS_Localize", "USEnglish", "LangPackSection", #translation)
Lua: string translation = reaper.JS_Localize(string USEnglish, string LangPackSection)
Python: (String USEnglish, String LangPackSection, String translationOut, Int translationOut_sz) = JS_Localize(USEnglish, LangPackSection, translationOut, translationOut_sz)
Description:Returns the translation of the given US English text, according to the currently loaded Language Pack.
Parameters:
* LangPackSection: Language Packs are divided into sections such as "common" or "DLG_102".
* In Lua, by default, text of up to 1024 chars can be returned. To increase (or reduce) the default buffer size, a string and size can be included as optional 3rd and 4th arguments.
Example: reaper.JS_Localize("Actions", "common", "", 20)
| Parameters: |
| string USEnglish | - | the original english string
|
| string LangPackSection | - | the section in the Reaper-language-pack-file, in which the string is locate
|
| Returnvalues: |
| string translation | - | the translated string, according to the currently used LangPack
|
^ 
JS_MIDIEditor_ArrayAll(JS)Functioncall:
C: void JS_MIDIEditor_ArrayAll(void* reaperarray)
EEL2: extension_api("JS_MIDIEditor_ArrayAll", void* reaperarray)
Lua: reaper.JS_MIDIEditor_ArrayAll(identifier reaperarray)
Python: JS_MIDIEditor_ArrayAll(void reaperarray)
Description:Returns the addresses of all open MIDI windows (whether docked or not).
* The addresses are stored in the provided reaper.array.
* Each address can be converted to a REAPER object (HWND) by the function JS_Window_HandleFromAddress.
| Parameters: |
| identifier reaperarray | - |
|
^ 
JS_MIDIEditor_ListAll(JS)Functioncall:
C: void JS_MIDIEditor_ListAll(char* buf, int buf_sz)
EEL2: extension_api("JS_MIDIEditor_ListAll", #buf)
Lua: string buf = reaper.JS_MIDIEditor_ListAll(string buf)
Python: (String buf, Int buf_sz) = JS_MIDIEditor_ListAll(buf, buf_sz)
Description:Returns a list of HWNDs of all open MIDI windows (whether docked or not).
* The list is formatted as a comma-separated (and terminated) string of hexadecimal values.
* Each value is an address that can be converted to a HWND by the function JS_Window_HandleFromAddress.
| Returnvalues: |
| string buf | - |
|
^ 
JS_Mem_Alloc(JS)Functioncall:
C: void* JS_Mem_Alloc(int sizeBytes)
EEL2: void* extension_api("JS_Mem_Alloc", int sizeBytes)
Lua: identifier = reaper.JS_Mem_Alloc(integer sizeBytes)
Python: void JS_Mem_Alloc(Int sizeBytes)
Description:Allocates memory for general use by functions that require memory buffers.
| Parameters: |
| integer sizeBytes | - |
|
| Returnvalues: |
| identifier | - |
|
^ 
JS_Mem_Free(JS)Functioncall:
C: void* JS_Mem_Alloc(int sizeBytes)
EEL2: void* extension_api("JS_Mem_Alloc", int sizeBytes)
Lua: identifier = reaper.JS_Mem_Alloc(integer sizeBytes)
Python: Boolean JS_Mem_Free(void mallocPointer)
Description:Frees memory that was previously allocated by JS_Mem_Alloc.
| Parameters: |
| integer sizeBytes | - |
|
| Returnvalues: |
| identifier | - |
|
^ 
JS_Mem_FromString(JS)Functioncall:
C: bool JS_Mem_FromString(void* mallocPointer, int offset, const char* packedString, int stringLength)
EEL2: bool extension_api("JS_Mem_FromString", void* mallocPointer, int offset, "packedString", int stringLength)
Lua: boolean = reaper.JS_Mem_FromString(identifier mallocPointer, integer offset, string packedString, integer stringLength)
Python: Boolean JS_Mem_FromString(void mallocPointer, Int offset, String packedString, Int stringLength)
Description:Copies a packed string into a memory buffer.
| Parameters: |
| identifier mallocPointer | - |
|
| integer offset | - |
|
| string packedString | - |
|
| integer stringLength | - |
|
^ 
JS_Mouse_GetCursor(JS)Functioncall:
C: void* JS_Mouse_GetCursor()
EEL2: void* extension_api("JS_Mouse_GetCursor")
Lua: identifier = reaper.JS_Mouse_GetCursor()
Python: void JS_Mouse_GetCursor()
Description:On Windows, retrieves a handle to the current mouse cursor.
On Linux and macOS, retrieves a handle to the last cursor set by REAPER or its extensions via SWELL.
| Returnvalues: |
| identifier | - |
|
^ 
JS_Mouse_GetState(JS)Functioncall:
C: int JS_Mouse_GetState(int flags)
EEL2: int extension_api("JS_Mouse_GetState", int flags)
Lua: integer = reaper.JS_Mouse_GetState(integer flags)
Python: Int JS_Mouse_GetState(Int flags)
Description:Retrieves the states of mouse buttons and modifiers keys.
Parameters:
* flags, state: The parameter and the return value both use the same format as gfx.mouse_cap. I.e., to get the states of the left mouse button and the ctrl key, use flags = 0b00000101.
use -1 as flags to retrieve the states of all mouse-buttons and modifier
| Parameters: |
| integer flags | - |
|
^ 
JS_Mouse_LoadCursor(JS)Functioncall:
C: void* JS_Mouse_LoadCursor(int cursorNumber)
EEL2: void* extension_api("JS_Mouse_LoadCursor", int cursorNumber)
Lua: identifier = reaper.JS_Mouse_LoadCursor(integer cursorNumber)
Python: void JS_Mouse_LoadCursor(Int cursorNumber)
Description:Loads a cursor by number.
cursorNumber: Same as used for gfx.setcursor, and includes some of Windows' predefined cursors (with numbers > 32000; refer to documentation for the Win32 C++ function LoadCursor), and REAPER's own cursors (with numbers < 2000).
If successful, returns a handle to the cursor, which can be used in
JS_Mouse_SetCursor.
| Parameters: |
| integer cursorNumber | - |
|
| Returnvalues: |
| identifier | - |
|
^ 
JS_Mouse_LoadCursorFromFile(JS)Functioncall:
C: void* JS_Mouse_LoadCursorFromFile(const char* pathAndFileName, bool* forceNewLoad)
EEL2: void* extension_api("JS_Mouse_LoadCursorFromFile", "pathAndFileName", boolean forceNewLoad)
Lua: identifier = reaper.JS_Mouse_LoadCursorFromFile(string pathAndFileName, optional boolean forceNewLoad)
Python: void JS_Mouse_LoadCursorFromFile(String pathAndFileName, Boolean forceNewLoadOptional)
Description:Loads a cursor from a .cur file.
If omitted or false, and if the .cur file has already been loaded previously during the REAPER session, the file will not be re-loaded, and the previous handle will be returned, thereby (slightly) improving speed and (slighty) lowering memory usage.
If true, the file will be re-loaded and a new handle will be returned.
If successful, returns a handle to the cursor, which can be used in
JS_Mouse_SetCursor.
forceNewLoad is an optional boolean parameter:
| Parameters: |
| string pathAndFileName | - |
|
| optional boolean forceNewLoad | - |
|
| Returnvalues: |
| identifier | - |
|
^ 
JS_Mouse_SetCursor(JS)Functioncall:
C: void JS_Mouse_SetCursor(void* cursorHandle)
EEL2: extension_api("JS_Mouse_SetCursor", void* cursorHandle)
Lua: reaper.JS_Mouse_SetCursor(identifier cursorHandle)
Python: JS_Mouse_SetCursor(void cursorHandle)
Description:Sets the mouse cursor. (Only lasts while script is running, and for a single "defer" cycle.)
| Parameters: |
| identifier cursorHandle | - |
|
^ 
JS_Mouse_SetPosition(JS)Functioncall:
C: bool JS_Mouse_SetPosition(int x, int y)
EEL2: bool extension_api("JS_Mouse_SetPosition", int x, int y)
Lua: boolean = reaper.JS_Mouse_SetPosition(integer x, integer y)
Python: Boolean JS_Mouse_SetPosition(Int x, Int y)
Description:Moves the mouse cursor to the specified coordinates.
| Parameters: |
| integer x | - |
|
| integer y | - |
|
^ 
JS_PtrFromStr(JS)Functioncall:
C: void* JS_PtrFromStr(const char* s)
EEL2: void* extension_api("JS_PtrFromStr", "s")
Lua: identifier = reaper.JS_PtrFromStr(string s)
Python: void JS_PtrFromStr(String s)
Description:
| Returnvalues: |
| identifier | - |
|
^ 
JS_ReaScriptAPI_Version(JS)Functioncall:
C: void JS_ReaScriptAPI_Version(double* versionOut)
EEL2: extension_api("JS_ReaScriptAPI_Version", &version)
Lua: number version = reaper.JS_ReaScriptAPI_Version()
Python: (Float versionOut) JS_ReaScriptAPI_Version(versionOut)
Description:Returns the version of the js_ReaScriptAPI extension.
| Returnvalues: |
| number version | - |
|
^ 
JS_String(JS)Functioncall:
C: bool JS_String(void* pointer, int offset, int lengthChars, char* bufOutNeedBig, int bufOutNeedBig_sz)
EEL2: bool extension_api("JS_String", void* pointer, int offset, int lengthChars, #buf)
Lua: boolean retval, string buf = reaper.JS_String(identifier pointer, integer offset, integer lengthChars)
Python: (Boolean retval, void pointer, Int offset, Int lengthChars, String bufOutNeedBig, Int bufOutNeedBig_sz) = JS_String(pointer, offset, lengthChars, bufOutNeedBig, bufOutNeedBig_sz)
Description:Returns the memory contents starting at address[offset] as a packed string. Offset is added as steps of 1 byte (char) each.
| Parameters: |
| identifier pointer | - |
|
| integer offset | - |
|
| integer lengthChars | - |
|
| Returnvalues: |
| boolean retval | - |
|
| string buf | - |
|
^ 
JS_VKeys_GetDown(JS)Functioncall:
C: void JS_VKeys_GetDown(double cutoffTime, char* stateOutNeedBig, int* stateOutNeedBig_sz)
EEL2: extension_api("JS_VKeys_GetDown", cutoffTime, #state)
Lua: string state = reaper.JS_VKeys_GetDown(number cutoffTime)
Python: (Float cutoffTime, String stateOutNeedBig, Int stateOutNeedBig_sz) = JS_VKeys_GetDown(cutoffTime, stateOutNeedBig, stateOutNeedBig_sz)
Description:Returns a 255-byte array that specifies which virtual keys, from 0x01 to 0xFF, have sent KEYDOWN messages since cutoffTime.
Notes:
* Mouse buttons and modifier keys are not (currently) reliably detected, and JS_Mouse_GetState can be used instead.
* Auto-repeated KEYDOWN messages are ignored.
| Parameters: |
| number cutoffTime | - |
|
| Returnvalues: |
| string state | - |
|
^ 
JS_VKeys_ClearHistory(JS)Functioncall:
C: void JS_VKeys_ClearHistory()
EEL2: extension_api("JS_VKeys_ClearHistory")
Lua: reaper.JS_VKeys_ClearHistory()
Python: JS_VKeys_ClearHistory()
Description:deprecated
^ 
JS_VKeys_GetHistory(JS)Functioncall:
C: bool JS_VKeys_GetHistory(char* stateOutNeedBig, int* stateOutNeedBig_sz)
EEL2: bool extension_api("JS_VKeys_GetHistory", #state)
Lua: boolean retval, string state = reaper.JS_VKeys_GetHistory()
Python: (Boolean retval, String stateOutNeedBig, Int stateOutNeedBig_sz) = JS_VKeys_GetHistory(stateOutNeedBig, stateOutNeedBig_sz)
Description:deprecated
| Returnvalues: |
| boolean retval | - |
|
| string state | - |
|
^ 
JS_VKeys_GetState(JS)Functioncall:
C: bool JS_VKeys_GetState(char* stateOutNeedBig, int* stateOutNeedBig_sz)
EEL2: bool extension_api("JS_VKeys_GetState", #state)
Lua: boolean retval, string state = reaper.JS_VKeys_GetState()
Python: (Boolean retval, String stateOutNeedBig, Int stateOutNeedBig_sz) = JS_VKeys_GetState(stateOutNeedBig, stateOutNeedBig_sz)
Description:Retrieves the current states (0 or 1) of all virtual keys, from 0x01 to 0xFF, in a 255-byte array.
cutoffTime: A key is only regarded as down if it sent a KEYDOWN message after the cut-off time, not followed by KEYUP. (This is useful for excluding old KEYDOWN messages that weren't properly followed by KEYUP.)
If cutoffTime is positive, is it interpreted as absolute time in similar format as time_precise().
If cutoffTime is negative, it is relative to the current time.
Notes:
Notes:
* Mouse buttons and modifier keys are not (currently) reliably detected, and JS_Mouse_GetState can be used instead.
* Auto-repeated KEYDOWN messages are ignored.
| Returnvalues: |
| boolean retval | - |
|
| string state | - |
|
^ 
JS_VKeys_GetUp(JS)Functioncall:
C: void JS_VKeys_GetUp(double cutoffTime, char* stateOutNeedBig, int* stateOutNeedBig_sz)
EEL2: extension_api("JS_VKeys_GetUp", cutoffTime, #state)
Lua: string state = reaper.JS_VKeys_GetUp(number cutoffTime)
Python: (Float cutoffTime, String stateOutNeedBig, Int stateOutNeedBig_sz) = JS_VKeys_GetUp(cutoffTime, stateOutNeedBig, stateOutNeedBig_sz)
Description:Return a 255-byte array that specifies which virtual keys, from 0x01 to 0xFF, have sent KEYUP messages since cutoffTime.
Note: Mouse buttons and modifier keys are not (currently) reliably detected, and
JS_Mouse_GetState can be used instead.
| Parameters: |
| number cutoffTime | - |
|
| Returnvalues: |
| string state | - |
|
^ 
JS_VKeys_Intercept(JS)Functioncall:
C: int JS_VKeys_Intercept(int keyCode, int intercept)
EEL2: int extension_api("JS_VKeys_Intercept", int keyCode, int intercept)
Lua: integer retval = reaper.JS_VKeys_Intercept(integer keyCode, integer intercept)
Python: Int JS_VKeys_Intercept(Int keyCode, Int intercept)
Description:Intercepting (blocking) virtual keys work similar to the native function PreventUIRefresh: Each key has a (non-negative) intercept state, and the key is passed through as usual if the state equals 0, or blocked if the state is greater than 0.
keyCode: The virtual key code of the key, or -1 to change the state of all keys.
intercept: A script can increase the intercept state by passing +1, or lower the state by passing -1.
Multiple scripts can block the same key, and the intercept state may reach up to 255.
If zero is passed, the intercept state is not changed, but the current state is returned.
Returns: If keyCode refers to a single key, the intercept state of that key is returned. If keyCode = -1, the state of the key that is most strongly blocked (highest intercept state) is returned.
| Parameters: |
| integer keyCode | - |
|
| integer intercept | - |
|
| Returnvalues: |
| integer retval | - |
|
^ 
JS_WindowMessage_Intercept(JS)Functioncall:
C: int JS_WindowMessage_Intercept(void* windowHWND, const char* messages, bool passThrough)
EEL2: int extension_api("JS_WindowMessage_Intercept", void* windowHWND, "messages", bool passThrough)
Lua: integer = reaper.JS_WindowMessage_Intercept(identifier windowHWND, string messages, boolean passThrough)
Python: Int JS_WindowMessage_Intercept(void windowHWND, String messages, Boolean passThrough)
Description:Intercepts window messages to specified window.
Parameters:
* message: a single message type to be intercepted, either in WM_ or hexadecimal format. For example "WM_SETCURSOR" or "0x0020".
* passThrough: Whether message should be blocked (false) or passed through (true) to the window.
For more information on message codes, refer to the Win32 C++ API documentation.
For a list of message types that are valid cross-platform, refer to swell-types.h. Only these will be recognized by WM_ name.
Returns:
* 1: Success.
* 0: The message type is already being intercepted by another script.
* -2: message string could not be parsed.
* -3: Failure getting original window process / window not valid.
* -6: Could not obtain the window client HDC.
Notes:
* Intercepted messages can be polled using JS_WindowMessage_Peek.
* Intercepted messages can be edited, if necessary, and then forwarded to their original destination using JS_WindowMessage_Post or JS_WindowMessage_Send.
* To check whether a message type is being blocked or passed through, Peek the message type, or retrieve the entire List of intercepts.
* Mouse events are typically received by the child window under the mouse, not the parent window.
Keyboard events are usually *not* received by any individual window. To intercept keyboard events, use the VKey functions.
| Parameters: |
| identifier windowHWND | - | |
| string messages | - | |
| boolean passThrough | - | |
^ 
JS_WindowMessage_InterceptList(JS)Functioncall:
C: int JS_WindowMessage_InterceptList(void* windowHWND, const char* messages)
EEL2: int extension_api("JS_WindowMessage_InterceptList", void* windowHWND, "messages")
Lua: integer = reaper.JS_WindowMessage_InterceptList(identifier windowHWND, string messages)
Python: Int JS_WindowMessage_InterceptList(void windowHWND, String messages)
Description:Intercepts window messages to specified window.
Parameters:
* messages: comma-separated string of message types to be intercepted (either in WM_ or hexadecimal format), each with a "block" or "passthrough" modifier to specify whether the message should be blocked or passed through to the window. For example "WM_SETCURSOR:block, 0x0201:passthrough".
For more information on message codes, refer to the Win32 C++ API documentation.
For a list of message types that are valid cross-platform, refer to swell-types.h. Only these will be recognized by WM_ name.
Returns:
* 1: Success.
* 0: The message type is already being intercepted by another script.
* -1: windowHWND is not a valid window.
* -2: message string could not be parsed.
* -3: Failure getting original window process.
* -6: Could not obtain the window client HDC.
Notes:
* Intercepted messages can be polled using JS_WindowMessage_Peek.
* Intercepted messages can be edited, if necessary, and then forwarded to their original destination using JS_WindowMessage_Post or JS_WindowMessage_Send.
* To check whether a message type is being blocked or passed through, Peek the message type, or retrieve the entire List of intercepts.
| Parameters: |
| identifier windowHWND | - | |
| string messages | - | |
^ 
JS_WindowMessage_ListIntercepts(JS)Functioncall:
C: bool JS_WindowMessage_ListIntercepts(void* windowHWND, char* buf, int buf_sz)
EEL2: bool extension_api("JS_WindowMessage_ListIntercepts", void* windowHWND, #buf)
Lua: boolean retval, string buf = reaper.JS_WindowMessage_ListIntercepts(identifier windowHWND, string buf)
Python: (Boolean retval, void windowHWND, String buf, Int buf_sz) = JS_WindowMessage_ListIntercepts(windowHWND, buf, buf_sz)
Description:Returns a string with a list of all message types currently being intercepted for the specified window.
| Parameters: |
| identifier windowHWND | - |
|
| string buf | - |
|
| Returnvalues: |
| boolean retval | - |
|
| string buf | - |
|
^ 
JS_WindowMessage_PassThrough(JS)Functioncall:
C: int JS_WindowMessage_PassThrough(void* windowHWND, const char* message, bool passThrough)
EEL2: int extension_api("JS_WindowMessage_PassThrough", void* windowHWND, "message", bool passThrough)
Lua: integer = reaper.JS_WindowMessage_PassThrough(identifier windowHWND, string message, boolean passThrough)
Python: Int JS_WindowMessage_PassThrough(void windowHWND, String message, Boolean passThrough)
Description:Changes the passthrough setting of a message type that is already being intercepted.
Returns 1 if successful, 0 if the message type is not yet being intercepted, or -2 if the argument could not be parsed.
| Parameters: |
| identifier windowHWND | - |
|
| string message | - |
|
| boolean passThrough | - |
|
^ 
JS_WindowMessage_Peek(JS)Functioncall:
C: bool JS_WindowMessage_Peek(void* windowHWND, const char* message, bool* passedThroughOut, double* timeOut, int* wParamLowOut, int* wParamHighOut, int* lParamLowOut, int* lParamHighOut)
EEL2: bool extension_api("JS_WindowMessage_Peek", void* windowHWND, "message", bool &passedThrough, &time, int &wParamLow, int &wParamHigh, int &lParamLow, int &lParamHigh)
Lua: boolean retval, boolean passedThrough, number time, number wParamLow, number wParamHigh, number lParamLow, number lParamHigh = reaper.JS_WindowMessage_Peek(identifier windowHWND, string message)
Python: (Boolean retval, void windowHWND, String message, Boolean passedThroughOut, Float timeOut, Int wParamLowOut, Int wParamHighOut, Int lParamLowOut, Int lParamHighOut) = JS_WindowMessage_Peek(windowHWND, message, passedThroughOut, timeOut, wParamLowOut, wParamHighOut, lParamLowOut, lParamHighOut)
Description:Polls the state of an intercepted message.
Parameters:
* message: String containing a single message name, such as "WM_SETCURSOR", or in hexadecimal format, "0x0020".
(For a list of message types that are valid cross-platform, refer to swell-types.h. Only these will be recognized by WM_ name.)
Returns:
* A retval of false indicates that the message type is not being intercepted in the specified window.
* All messages are timestamped. A time of 0 indicates that no message if this type has been intercepted yet.
* For more information about wParam and lParam for different message types, refer to Win32 C++ documentation.
* For example, in the case of mousewheel, returns mousewheel delta, modifier keys, x position and y position.
* wParamHigh, lParamLow and lParamHigh are signed, whereas wParamLow is unsigned.
| Parameters: |
| identifier windowHWND | - | |
| string message | - | |
| Returnvalues: |
| boolean retval | - | |
| boolean passedThrough | - | |
| number time | - | |
| number wParamLow | - | |
| number wParamHigh | - | |
| number lParamLow | - | |
| number lParamHigh | - | |
^ 
JS_WindowMessage_Post(JS)Functioncall:
C: bool JS_WindowMessage_Post(void* windowHWND, const char* message, double wParam, int wParamHighWord, double lParam, int lParamHighWord)
EEL2: bool extension_api("JS_WindowMessage_Post", void* windowHWND, "message", wParam, int wParamHighWord, lParam, int lParamHighWord)
Lua: boolean retval = reaper.JS_WindowMessage_Post(identifier windowHWND, string message, number wParam, integer wParamHighWord, number lParam, integer lParamHighWord)
Python: Boolean JS_WindowMessage_Post(void windowHWND, String message, Float wParam, Int wParamHighWord, Float lParam, Int lParamHighWord)
Description:If the specified window and message type are not currently being intercepted by a script, this function will post the message in the message queue of the specified window, and return without waiting.
If the window and message type are currently being intercepted, the message will be sent directly to the original window process, similar to WindowMessage_Send, thereby skipping any intercepts.
Parameters:
* message: String containing a single message name, such as "WM_SETCURSOR", or in hexadecimal format, "0x0020".
(For a list of WM_ and CB_ message types that are valid cross-platform, refer to swell-types.h. Only these will be recognized by WM_ or CB_ name.)
* wParam, wParamHigh, lParam and lParamHigh: Low and high 16-bit WORDs of the WPARAM and LPARAM parameters.
(Most window messages encode separate information into the two WORDs. However, for those rare cases in which the entire WPARAM and LPARAM must be used to post a large pointer, the script can store this address in wParam or lParam, and keep wParamHigh and lParamHigh zero.)
Notes:
* For more information about parameter values, refer to documentation for the Win32 C++ function PostMessage.
* Messages should only be sent to windows that were created from the main thread.
* Useful for simulating mouse clicks and calling mouse modifier actions from scripts.
| Parameters: |
| identifier windowHWND | - | |
| string message | - | |
| number wParam | - | |
| integer wParamHighWord | - | |
| number lParam | - | |
| integer lParamHighWord | - | |
| Returnvalues: |
| boolean retval | - | |
^ 
JS_WindowMessage_Release(JS)Functioncall:
C: int JS_WindowMessage_Release(void* windowHWND, const char* messages)
EEL2: int extension_api("JS_WindowMessage_Release", void* windowHWND, "messages")
Lua: integer = reaper.JS_WindowMessage_Release(identifier windowHWND, string messages)
Python: Int JS_WindowMessage_Release(void windowHWND, String messages)
Description:Release intercepts of specified message types.
Parameters:
* messages: "WM_SETCURSOR,WM_MOUSEHWHEEL" or "0x0020,0x020E", for example.
| Parameters: |
| identifier windowHWND | - | |
| string messages | - | |
^ 
JS_WindowMessage_ReleaseAll(JS)Functioncall:
C: void JS_WindowMessage_ReleaseAll()
EEL2: extension_api("JS_WindowMessage_ReleaseAll")
Lua: reaper.JS_WindowMessage_ReleaseAll()
Python: JS_WindowMessage_ReleaseAll()
Description:Release script intercepts of window messages for all windows.
^ 
JS_WindowMessage_ReleaseWindow(JS)Functioncall:
C: void JS_WindowMessage_ReleaseWindow(void* windowHWND)
EEL2: extension_api("JS_WindowMessage_ReleaseWindow", void* windowHWND)
Lua: reaper.JS_WindowMessage_ReleaseWindow(identifier windowHWND)
Python: JS_WindowMessage_ReleaseWindow(void windowHWND)
Description:Release script intercepts of window messages for specified window.
| Parameters: |
| identifier windowHWND | - |
|
^ 
JS_WindowMessage_Send(JS)Functioncall:
C: int JS_WindowMessage_Send(void* windowHWND, const char* message, double wParam, int wParamHighWord, double lParam, int lParamHighWord)
EEL2: int extension_api("JS_WindowMessage_Send", void* windowHWND, "message", wParam, int wParamHighWord, lParam, int lParamHighWord)
Lua: integer = reaper.JS_WindowMessage_Send(identifier windowHWND, string message, number wParam, integer wParamHighWord, number lParam, integer lParamHighWord)
Python: Int JS_WindowMessage_Send(void windowHWND, String message, Float wParam, Int wParamHighWord, Float lParam, Int lParamHighWord)
Description:Sends a message to the specified window by calling the window process directly, and only returns after the message has been processed. Any intercepts of the message by scripts will be skipped, and the message can therefore not be blocked.
Parameters:
* message: String containing a single message name, such as "WM_SETCURSOR", or in hexadecimal format, "0x0020".
(For a list of WM_ and CB_ message types that are valid cross-platform, refer to swell-types.h. Only these will be recognized by WM_ or CB_ name.)
* wParam, wParamHigh, lParam and lParamHigh: Low and high 16-bit WORDs of the WPARAM and LPARAM parameters.
(Most window messages encode separate information into the two WORDs. However, for those rare cases in which the entire WPARAM and LPARAM must be used to post a large pointer, the script can store this address in wParam or lParam, and keep wParamHigh and lParamHigh zero.)
Notes:
* For more information about parameter and return values, refer to documentation for the Win32 C++ function SendMessage.
* Messages should only be sent to windows that were created from the main thread.
* Useful for simulating mouse clicks and calling mouse modifier actions from scripts.
| Parameters: |
| identifier windowHWND | - | |
| string message | - | |
| number wParam | - | |
| integer wParamHighWord | - | |
| number lParam | - | |
| integer lParamHighWord | - | |
^ 
JS_Window_AddressFromHandle(JS)Functioncall:
C: void JS_Window_AddressFromHandle(void* handle, double* addressOut)
EEL2: extension_api("JS_Window_AddressFromHandle", void* handle, &address)
Lua: number address = reaper.JS_Window_AddressFromHandle(identifier handle)
Python: (void handle, Float addressOut) = JS_Window_AddressFromHandle(handle, addressOut)
Description:
| Parameters: |
| identifier handle | - |
|
| Returnvalues: |
| number address | - |
|
^ 
JS_Window_ArrayAllChild(JS)Functioncall:
C: void JS_Window_ArrayAllChild(void* parentHWND, void* reaperarray)
EEL2: extension_api("JS_Window_ArrayAllChild", void* parentHWND, void* reaperarray)
Lua: reaper.JS_Window_ArrayAllChild(identifier parentHWND, identifier reaperarray)
Python: JS_Window_ArrayAllChild(void parentHWND, void reaperarray)
Description:Returns all child windows of the specified parent.
The addresses are stored in the provided reaper.array, and can be converted to REAPER objects (HWNDs) by the function JS_Window_HandleFromAddress.
| Parameters: |
| identifier parentHWND | - | |
| identifier reaperarray | - | |
^ 
JS_Window_ArrayAllTop(JS)Functioncall:
C: void JS_Window_ArrayAllTop(void* reaperarray)
EEL2: extension_api("JS_Window_ArrayAllTop", void* reaperarray)
Lua: reaper.JS_Window_ArrayAllTop(identifier reaperarray)
Python: JS_Window_ArrayAllTop(void reaperarray)
Description:Returns all top-level windows.
The addresses are stored in the provided reaper.array, and can be converted to REAPER objects (HWNDs) by the function JS_Window_HandleFromAddress.
| Parameters: |
| identifier reaperarray | - | |
^ 
JS_Window_ArrayFind(JS)Functioncall:
C: void JS_Window_ArrayFind(const char* title, bool exact, void* reaperarray)
EEL2: extension_api("JS_Window_ArrayFind", "title", bool exact, void* reaperarray)
Lua: reaper.JS_Window_ArrayFind(string title, boolean exact, identifier reaperarray)
Python: JS_Window_ArrayFind(String title, Boolean exact, void reaperarray)
Description:Returns all windows, whether top-level or child, whose titles match the specified string.
The addresses are stored in the provided reaper.array, and can be converted to REAPER objects (HWNDs) by the function JS_Window_HandleFromAddress.
Parameters: * exact: Match entire title exactly, or match substring of title.
| Parameters: |
| string title | - | |
| boolean exact | - | |
| identifier reaperarray | - | |
^ 
JS_Window_AttachResizeGrip(JS)Functioncall:
C: void JS_Window_AttachResizeGrip(void* windowHWND)
EEL2: extension_api("JS_Window_AttachResizeGrip", void* windowHWND)
Lua: reaper.JS_Window_AttachResizeGrip(identifier windowHWND)
Python: JS_Window_AttachResizeGrip(void windowHWND)
Description:
| Parameters: |
| identifier windowHWND | - |
|
^ 
JS_Window_AttachTopmostPin(JS)Functioncall:
C: void* JS_Window_AttachTopmostPin(void* windowHWND)
EEL2: void extension_api("JS_Window_AttachTopmostPin", void* windowHWND)
Lua: identifier HWND = reaper.JS_Window_AttachTopmostPin(identifier windowHWND)
Python: void JS_Window_AttachTopmostPin(void windowHWND)
Description:Attaches a "pin on top" button to the window frame. The button should remember its state when closing and re-opening the window.
WARNING: This function does not yet work on Linux.
| Parameters: |
| identifier windowHWND | - |
|
| Returnvalues: |
| identifier HWND | - |
|
^ 
JS_Window_ClientToScreen(JS)Functioncall:
C: void JS_Window_ClientToScreen(void* windowHWND, int x, int y, int* xOut, int* yOut)
EEL2: extension_api("JS_Window_ClientToScreen", void* windowHWND, int x, int y, int &x, int &y)
Lua: number x, number y = reaper.JS_Window_ClientToScreen(identifier windowHWND, integer x, integer y)
Python: (void windowHWND, Int x, Int y, Int xOut, Int yOut) = JS_Window_ClientToScreen(windowHWND, x, y, xOut, yOut)
Description:Converts the client-area coordinates of a specified point to screen coordinates.
| Parameters: |
| identifier windowHWND | - |
|
| integer x | - |
|
| integer y | - |
|
| Returnvalues: |
| number x | - |
|
| number y | - |
|
^ 
JS_Window_Create(JS)Functioncall:
C: void* JS_Window_Create(const char* title, const char* className, int x, int y, int w, int h, char* styleOptional, void* ownerHWNDOptional)
EEL2: void* extension_api("JS_Window_Create", "title", "className", int x, int y, int w, int h, optional #style, void* ownerHWND)
Lua: identifier retval, optional string style = reaper.JS_Window_Create(string title, string className, integer x, integer y, integer w, integer h, optional string style, identifier ownerHWND)
Python: (void retval, String title, String className, Int x, Int y, Int w, Int h, String styleOptional, void ownerHWNDOptional) = JS_Window_Create(title, className, x, y, w, h, styleOptional, ownerHWNDOptional)
Description:Creates a modeless window with WS_OVERLAPPEDWINDOW style and only rudimentary features. Scripts can paint into the window using GDI or LICE/Composite functions (and JS_Window_InvalidateRect to trigger re-painting).
style: An optional parameter that overrides the default style. The string may include any combination of standard window styles, such as "POPUP" for a frameless window, or "CAPTION,SIZEBOX,SYSMENU" for a standard framed window.
On Linux and macOS, "MAXIMIZE" has not yet been implemented, and the remaining styles may appear slightly different from their WindowsOS counterparts.
className: On Windows, only standard ANSI characters are supported.
ownerHWND: Optional parameter, only available on WindowsOS. Usually either the REAPER main window or another script window, and useful for ensuring that the created window automatically closes when the owner is closed.
NOTE: On Linux and macOS, the window contents are only updated *between* defer cycles, so the window cannot be animated by for/while loops within a single defer cycle.
| Parameters: |
| string title | - |
|
| string className | - |
|
| integer x | - |
|
| integer y | - |
|
| integer w | - |
|
| integer h | - |
|
| optional string style | - |
|
| identifier ownerHWND | - |
|
| Returnvalues: |
| identifier retval | - |
|
| optional string style | - |
|
^ 
JS_Window_Destroy(JS)Functioncall:
C: void JS_Window_Destroy(void* windowHWND)
EEL2: extension_api("JS_Window_Destroy", void* windowHWND)
Lua: reaper.JS_Window_Destroy(identifier windowHWND)
Python: JS_Window_Destroy(void windowHWND)
Description:Destroys the specified window.
| Parameters: |
| identifier windowHWND | - |
|
^ 
JS_Window_Enable(JS)Functioncall:
C: void JS_Window_Enable(void* windowHWND, bool enable)
EEL2: extension_api("JS_Window_Enable", void* windowHWND, bool enable)
Lua: reaper.JS_Window_Enable(identifier windowHWND, boolean enable)
Python: JS_Window_Enable(void windowHWND, Boolean enable)
Description:Enables or disables mouse and keyboard input to the specified window or control.
| Parameters: |
| identifier windowHWND | - |
|
| boolean enable | - |
|
^ 
JS_Window_EnableMetal(JS)Functioncall:
C: int retval = JS_Window_EnableMetal(void* windowHWND)
EEL2: int retval = extension_api("JS_Window_EnableMetal", void* windowHWND)
Lua: integer retval = reaper.JS_Window_EnableMetal(identifier windowHWND)
Python: Int retval = JS_Window_EnableMetal(void windowHWND)
Description:On macOS, returns the Metal graphics setting:
2 = Metal enabled and support GetDC()/ReleaseDC() for drawing (more overhead).
1 = Metal enabled.
0 = N/A (Windows and Linux).
-1 = non-metal async layered mode.
-2 = non-metal non-async layered mode.
WARNING: If using mode -1, any BitBlt()/StretchBlt() MUST have the source bitmap persist. If it is resized after Blit it could cause crashes.
| Parameters: |
| identifier windowHWND | - |
|
| Returnvalues: |
| integer retval | - |
|
^ 
JS_Window_Find(JS)Functioncall:
C: void* JS_Window_Find(const char* title, bool exact)
EEL2: void* extension_api("JS_Window_Find", "title", bool exact)
Lua: identifier = reaper.JS_Window_Find(string title, boolean exact)
Python: void JS_Window_Find(String title, Boolean exact)
Description:Returns a HWND to a window whose title matches the specified string.
* Unlike the Win32 function FindWindow, this function searches top-level as well as child windows, so that the target window can be found irrespective of docked state.
* In addition, the function can optionally match substrings of the title.
* Matching is not case sensitive.
Parameters:
* exact: Match entire title, or match substring of title.
| Parameters: |
| string title | - | the title of the window to find
|
| boolean exact | - | true, title must match exactly the name of the window; false, title can only partially match the windowtitle
|
| Returnvalues: |
| identifier | - | the identifier of the found window, or nil
|
^ 
JS_Window_FindChild(JS)Functioncall:
C: void* JS_Window_FindChild(void* parentHWND, const char* title, bool exact)
EEL2: void* extension_api("JS_Window_FindChild", void* parentHWND, "title", bool exact)
Lua: identifier = reaper.JS_Window_FindChild(identifier parentHWND, string title, boolean exact)
Python: void JS_Window_FindChild(void parentHWND, String title, Boolean exact)
Description:Returns a HWND to a child window whose title matches the specified string.
Parameters:
* exact: Match entire title length, or match substring of title. In both cases, matching is not case sensitive.
| Parameters: |
| identifier parentHWND | - | the identifier of the parent window to the child-window
|
| string title | - | the title of the child-window to find
|
| boolean exact | - | true, title must match exactly the name of the window; false, title can only partially match the windowtitle
|
| Returnvalues: |
| identifier | - | the identifier for the window found; nil, if no such window found
|
^ 
JS_Window_FindChildByID(JS)Functioncall:
C: void* JS_Window_FindChildByID(void* parentHWND, int ID)
EEL2: void* extension_api("JS_Window_FindChildByID", void* parentHWND, int ID)
Lua: identifier HWND = reaper.JS_Window_FindChildByID(identifier parentHWND, integer ID)
Python: void JS_Window_FindChildByID(void parentHWND, Int ID)
Description:Similar to the C++ WIN32 function GetDlgItem, this function finds child windows by ID.
(The ID of a window may be retrieved by JS_Window_GetLongPtr.)
For instance: with Reaper's
MainHWND, you can get:
0: Transport(Windows)/MainHWND(Mac)
999: project-tabs(if existing, otherwise will be nil)
1000: trackview
1005: timeline
1259: Mouse editing help in the area beneath the track control panels
| Parameters: |
| identifier parentHWND | - | the parent HWND, whose child-HWNDs you want to search through
|
| integer ID | - | the ID of the childHWND
|
| Returnvalues: |
| identifier HWND | - | the HWND of the window, that the function found
|
^ 
JS_Window_FindEx(JS)Functioncall:
C: void* JS_Window_FindEx(void* parentHWND, void* childHWND, const char* className, const char* title)
EEL2: void* extension_api("JS_Window_FindEx", void* parentHWND, void* childHWND, "className", "title")
Lua: identifier HWND = reaper.JS_Window_FindEx(identifier parentHWND, identifier childHWND, string className, string title)
Python: void JS_Window_FindEx(void parentHWND, void childHWND, String className, String title)
Description:Returns a handle to a child window whose class and title match the specified strings.
Parameters: * childWindow: The function searches child windows, beginning with the window after the specified child window. If childHWND is equal to parentHWND, the search begins with the first child window of parentHWND.
* title: An empty string, "", will match all windows. (Search is not case sensitive.)
| Parameters: |
| identifier parentHWND | - | the parent hwnd of the child-window to find
|
| identifier childHWND | - | the parent child-window of the window to find; set it to parentHWND to search beginning with the first childhwnd of the parenthwnd
|
| string className | - | the name of the class of the child-window, that you want to find
|
| string title | - | the title of the child-window to find
|
| Returnvalues: |
| identifier HWND | - | the found window; nil, if no window has been found
|
^ 
JS_Window_FindTop(JS)Functioncall:
C: void* JS_Window_FindTop(const char* title, bool exact)
EEL2: void* extension_api("JS_Window_FindTop", "title", bool exact)
Lua: identifier = reaper.JS_Window_FindTop(string title, boolean exact)
Python: void JS_Window_FindTop(String title, Boolean exact)
Description:Returns a HWND to a top-level window whose title matches the specified string.
Parameters:
* exact: Match entire title length, or match substring of title. In both cases, matching is not case sensitive.
| Parameters: |
| string title | - | the title of the top-level window to find
|
| boolean exact | - | true, title must match exactly the name of the window; false, title can only partially match the windowtitle
|
| Returnvalues: |
| identifier HWND | - | the found identifier of the window; nil, if not found
|
^ 
JS_Window_FromPoint(JS)Functioncall:
C: void* JS_Window_FromPoint(int x, int y)
EEL2: void* extension_api("JS_Window_FromPoint", int x, int y)
Lua: identifier = reaper.JS_Window_FromPoint(integer x, integer y)
Python: void JS_Window_FromPoint(Int x, Int y)
Description:Retrieves a HWND to the window that contains the specified point.
| Parameters: |
| integer x | - | the x-position in pixels, at which to find the window
|
| integer y | - | the y-position in pixels, at which to find the window
|
| Returnvalues: |
| identifier | - | the window found at the coordinates
|
^ 
JS_Window_GetClassName(JS)Functioncall:
C: void JS_Window_GetClassName(void* windowHWND, char* buf, int buf_sz)
EEL2: extension_api("JS_Window_GetClassName", void* windowHWND, #buf)
Lua: string buf = reaper.JS_Window_GetClassName(identifier windowHWND, string buf)
Python: (void windowHWND, String buf, Int buf_sz) = JS_Window_GetClassName(windowHWND, buf, buf_sz)
Description:WARNING: May not be fully implemented on MacOS and Linux.
| Parameters: |
| identifier windowHWND | - |
|
| string buf | - |
|
| Returnvalues: |
| string buf | - |
|
^ 
JS_Window_GetClientRect(JS)Functioncall:
C: bool JS_Window_GetClientRect(void* windowHWND, int* leftOut, int* topOut, int* rightOut, int* bottomOut)
EEL2: bool extension_api("JS_Window_GetClientRect", void* windowHWND, int &left, int &top, int &right, int &bottom)
Lua: boolean retval, number left, number top, number right, number bottom = reaper.JS_Window_GetClientRect(identifier windowHWND)
Python: (Boolean retval, void windowHWND, Int leftOut, Int topOut, Int rightOut, Int bottomOut) = JS_Window_GetClientRect(windowHWND, leftOut, topOut, rightOut, bottomOut)
Description:Retrieves the coordinates of the client area rectangle of the specified window. The dimensions are given in screen coordinates relative to the upper-left corner of the screen.
NOTE 1: Unlike the C++ function GetClientRect, this function returns the actual coordinates, not the width and height.
NOTE 2: The pixel at (right, bottom) lies immediately outside the rectangle.
| Parameters: |
| identifier windowHWND | - |
|
| Returnvalues: |
| boolean retval | - |
|
| number left | - |
|
| number top | - |
|
| number right | - |
|
| number bottom | - |
|
^ 
JS_Window_GetClientSize(JS)Functioncall:
C: bool JS_Window_GetClientSize(void* windowHWND, int* widthOut, int* heightOut)
EEL2: bool extension_api("JS_Window_GetClientSize", void* windowHWND, int &width, int &height)
Lua: boolean retval, number width, number height = reaper.JS_Window_GetClientSize(identifier windowHWND)
Python: (Boolean retval, void windowHWND, Int widthOut, Int heightOut) = JS_Window_GetClientSize(windowHWND, widthOut, heightOut)
Description:Retrieves a HWND to the window that has the keyboard focus, if the window is attached to the calling thread's message queue.
| Parameters: |
| identifier windowHWND | - |
|
| Returnvalues: |
| boolean retval | - |
|
| number width | - |
|
| number height | - |
|
^ 
JS_Window_GetFocus(JS)Functioncall:
C: void* JS_Window_GetFocus()
EEL2: void* extension_api("JS_Window_GetFocus")
Lua: identifier = reaper.JS_Window_GetFocus()
Python: void JS_Window_GetFocus()
Description:Retrieves a HWND to the window that has the keyboard focus, if the window is attached to the calling thread's message queue.
| Returnvalues: |
| identifier | - |
|
^ 
JS_Window_GetForeground(JS)Functioncall:
C: void* JS_Window_GetForeground()
EEL2: void* extension_api("JS_Window_GetForeground")
Lua: identifier = reaper.JS_Window_GetForeground()
Python: void JS_Window_GetForeground()
Description:Retrieves a HWND to the top-level foreground window (the window with which the user is currently working).
| Returnvalues: |
| identifier | - |
|
^ 
JS_Window_GetLong(JS)Functioncall:
C: void JS_Window_GetLong(void* windowHWND, const char* info, double* retvalOut)
EEL2: extension_api("JS_Window_GetLong", void* windowHWND, "info", &retval)
Lua: number retval = reaper.JS_Window_GetLong(identifier windowHWND, string info)
Python: (void windowHWND, String info, Float retvalOut) = JS_Window_GetLong(windowHWND, info, retvalOut)
Description:In the case of "DLGPROC" and "WNDPROC", the return values can be converted to pointers by
JS_Window_HandleFromAddress.
If the function fails, the return value is 0.
| Parameters: |
| identifier windowHWND | - |
|
| string info | - |
|
| Returnvalues: |
| number retval | - |
|
^ 
JS_Window_GetLongPtr(JS)Functioncall:
C: void* JS_Window_GetLongPtr(void* windowHWND, const char* info)
EEL2: void* extension_api("JS_Window_GetLongPtr", void* windowHWND, "info")
Lua: identifier = reaper.JS_Window_GetLongPtr(identifier windowHWND, string info)
Python: void JS_Window_GetLongPtr(void windowHWND, String info)
Description:Returns information about the specified window.
info: "USERDATA", "WNDPROC", "DLGPROC", "ID", "EXSTYLE" or "STYLE".
For documentation about the types of information returned, refer to the Win32 function GetWindowLongPtr.
The values returned by "DLGPROC" and "WNDPROC" are typically used as-is, as pointers, whereas the others should first be converted to integers.
| Parameters: |
| identifier windowHWND | - |
|
| string info | - |
|
| Returnvalues: |
| identifier | - |
|
^ 
JS_Window_GetParent(JS)Functioncall:
C: void* JS_Window_GetParent(void* windowHWND)
EEL2: void* extension_api("JS_Window_GetParent", void* windowHWND)
Lua: identifier = reaper.JS_Window_GetParent(identifier windowHWND)
Python: void JS_Window_GetParent(void windowHWND)
Description:Retrieves a HWND to the specified window's parent or owner.
Returns NULL if the window is unowned or if the function otherwise fails.
| Parameters: |
| identifier windowHWND | - |
|
| Returnvalues: |
| identifier | - |
|
^ 
JS_Window_GetRect(JS)Functioncall:
C: bool JS_Window_GetRect(void* windowHWND, int* leftOut, int* topOut, int* rightOut, int* bottomOut)
EEL2: bool extension_api("JS_Window_GetRect", void* windowHWND, int &left, int &top, int &right, int &bottom)
Lua: boolean retval, number left, number top, number right, number bottom = reaper.JS_Window_GetRect(identifier windowHWND)
Python: (Boolean retval, void windowHWND, Int leftOut, Int topOut, Int rightOut, Int bottomOut) = JS_Window_GetRect(windowHWND, leftOut, topOut, rightOut, bottomOut)
Description:Retrieves the coordinates of the bounding rectangle of the specified window. The dimensions are given in screen coordinates relative to the upper-left corner of the screen.
NOTE: The pixel at (right, bottom) lies immediately outside the rectangle.
| Parameters: |
| identifier windowHWND | - |
|
| Returnvalues: |
| boolean retval | - |
|
| number left | - |
|
| number top | - |
|
| number right | - |
|
| number bottom | - |
|
^ 
JS_Window_GetRelated(JS)Functioncall:
C: void* JS_Window_GetRelated(void* windowHWND, const char* relation)
EEL2: void* extension_api("JS_Window_GetRelated", void* windowHWND, "relation")
Lua: identifier = reaper.JS_Window_GetRelated(identifier windowHWND, string relation)
Python: void JS_Window_GetRelated(void windowHWND, String relation)
Description:Retrieves a handle to a window that has the specified relationship (Z-Order or owner) to the specified window.
relation: "LAST", "NEXT", "PREV", "OWNER" or "CHILD".
(Refer to documentation for Win32 C++ function GetWindow.)
| Parameters: |
| identifier windowHWND | - |
|
| string relation | - |
|
| Returnvalues: |
| identifier | - |
|
^ 
JS_Window_GetScrollInfo(JS)Functioncall:
C: bool JS_Window_GetScrollInfo(void* windowHWND, const char* scrollbar, int* positionOut, int* pageSizeOut, int* minOut, int* maxOut, int* trackPosOut)
EEL2: bool extension_api("JS_Window_GetScrollInfo", void* windowHWND, "scrollbar", int &position, int &pageSize, int &min, int &max, int &trackPos)
Lua: boolean retval, number position, number pageSize, number min, number max, number trackPos = reaper.JS_Window_GetScrollInfo(identifier windowHWND, string scrollbar)
Python: (Boolean retval, void windowHWND, String scrollbar, Int positionOut, Int pageSizeOut, Int minOut, Int maxOut, Int trackPosOut) = JS_Window_GetScrollInfo(windowHWND, scrollbar, positionOut, pageSizeOut, minOut, maxOut, trackPosOut)
Description:Retrieves the scroll information of a window.
Parameters:
* scrollbar: "v" (or "SB_VERT", or "VERT") for vertical scroll, "h" (or "SB_HORZ" or "HORZ") for horizontal.
Returns:
* Leftmost or topmost visible pixel position, as well as the visible page size, the range minimum and maximum, and scroll box tracking position.
| Parameters: |
| identifier windowHWND | - |
|
| string scrollbar | - |
|
| Returnvalues: |
| boolean retval | - |
|
| number position | - |
|
| number pageSize | - |
|
| number min | - |
|
| number max | - |
|
| number trackPos | - |
|
^ 
JS_Window_GetTitle(JS)Functioncall:
C: void JS_Window_GetTitle(void* windowHWND, char* titleOut, int titleOut_sz)
EEL2: extension_api("JS_Window_GetTitle", void* windowHWND, #title)
Lua: string title = reaper.JS_Window_GetTitle(identifier windowHWND)
Python: (void windowHWND, String titleOut, Int titleOut_sz) = JS_Window_GetTitle(windowHWND, titleOut, titleOut_sz)
Description:Returns the title (if any) of the specified window.
| Parameters: |
| identifier windowHWND | - | the hwnd of the window, whose title you want to retrieve
|
| Returnvalues: |
| string title | - | the title of the window
|
^ 
JS_Window_GetViewportFromRect(JS)Functioncall:
C: void JS_Window_GetViewportFromRect(int x1, int y1, int x2, int y2, bool wantWork, int* leftOut, int* topOut, int* rightOut, int* bottomOut)
EEL2: extension_api("JS_Window_GetViewportFromRect", int x1, int y1, int x2, int y2, bool wantWork, int &left, int &top, int &right, int &bottom)
Lua: number left, number top, number right, number bottom = reaper.JS_Window_GetViewportFromRect(integer x1, integer y1, integer x2, integer y2, boolean wantWork)
Python: (Int x1, Int y1, Int x2, Int y2, Boolean wantWork, Int leftOut, Int topOut, Int rightOut, Int bottomOut) = JS_Window_GetViewportFromRect(x1, y1, x2, y2, wantWork, leftOut, topOut, rightOut, bottomOut)
Description:Retrieves the dimensions of the display monitor that has the largest area of intersection with the specified rectangle.
If the monitor is not the primary display, some of the rectangle's coordinates may be negative.
wantWork: Returns the work area of the display, which excludes the system taskbar or application desktop toolbars.
| Parameters: |
| integer x1 | - |
|
| integer y1 | - |
|
| integer x2 | - |
|
| integer y2 | - |
|
| boolean wantWork | - |
|
| Returnvalues: |
| number left | - |
|
| number top | - |
|
| number right | - |
|
| number bottom | - |
|
^ 
JS_Window_HandleFromAddress(JS)Functioncall:
C: void* JS_Window_HandleFromAddress(double address)
EEL2: void* extension_api("JS_Window_HandleFromAddress", address)
Lua: identifier = reaper.JS_Window_HandleFromAddress(number address)
Python: void JS_Window_HandleFromAddress(Float address)
Description:Converts an address to a handle (such as a HWND) that can be utilized by REAPER and other API functions.
| Parameters: |
| number address | - |
|
| Returnvalues: |
| identifier | - |
|
^ 
JS_Window_InvalidateRect(JS)Functioncall:
C: bool JS_Window_InvalidateRect(void* windowHWND, int left, int top, int right, int bottom, bool eraseBackground)
EEL2: bool extension_api("JS_Window_InvalidateRect", void* windowHWND, int left, int top, int right, int bottom, bool eraseBackground)
Lua: boolean retval = reaper.JS_Window_InvalidateRect(identifier windowHWND, integer left, integer top, integer right, integer bottom, boolean eraseBackground)
Python: Boolean JS_Window_InvalidateRect(void windowHWND, Int left, Int top, Int right, Int bottom, Boolean eraseBackground)
Description:Similar to the Win32 function InvalidateRect.
| Parameters: |
| identifier windowHWND | - |
|
| integer left | - |
|
| integer top | - |
|
| integer right | - |
|
| integer bottom | - |
|
| boolean eraseBackground | - |
|
| Returnvalues: |
| boolean retval | - |
|
^ 
JS_Window_IsChild(JS)Functioncall:
C: bool JS_Window_IsChild(void* parentHWND, void* childHWND)
EEL2: bool extension_api("JS_Window_IsChild", void* parentHWND, void* childHWND)
Lua: boolean = reaper.JS_Window_IsChild(identifier parentHWND, identifier childHWND)
Python: Boolean JS_Window_IsChild(void parentHWND, void childHWND)
Description:Determines whether a window is a child window or descendant window of a specified parent window.
| Parameters: |
| identifier parentHWND | - |
|
| identifier childHWND | - |
|
^ 
JS_Window_IsVisible(JS)Functioncall:
C: bool JS_Window_IsVisible(void* windowHWND)
EEL2: bool extension_api("JS_Window_IsVisible", void* windowHWND)
Lua: boolean = reaper.JS_Window_IsVisible(identifier windowHWND)
Python: Boolean JS_Window_IsVisible(void windowHWND)
Description:Determines the visibility state of the window.
| Parameters: |
| identifier windowHWND | - |
|
^ 
JS_Window_IsWindow(JS)Functioncall:
C: bool JS_Window_IsWindow(void* windowHWND)
EEL2: bool extension_api("JS_Window_IsWindow", void* windowHWND)
Lua: boolean = reaper.JS_Window_IsWindow(identifier windowHWND)
Python: Boolean JS_Window_IsWindow(void windowHWND)
Description:Determines whether the specified window handle identifies an existing window.
On macOS and Linux, only windows that were created by WDL/swell will be identified (and only such windows should be acted on by scripts).
NOTE: Since REAPER v5.974, windows can be checked using the native function ValidatePtr(windowHWND, "HWND").
| Parameters: |
| identifier windowHWND | - |
|
^ 
JS_Window_ListAllChild(JS)Functioncall:
C: int JS_Window_ListAllChild(void* parentHWND, char* listOutNeedBig, int listOutNeedBig_sz)
EEL2: int extension_api("JS_Window_ListAllChild", void* parentHWND, #list)
Lua: integer retval, string list = reaper.JS_Window_ListAllChild(identifier parentHWND)
Python: (Int retval, void parentHWND, String listOutNeedBig, Int listOutNeedBig_sz) = JS_Window_ListAllChild(parentHWND, listOutNeedBig, listOutNeedBig_sz)
Description:Finds all child windows of the specified parent.
Returns:
* retval: The number of windows found; negative if an error occurred.
* list: A comma-separated string of hexadecimal values.
Each value is an address that can be converted to a HWND by the function JS_Window_HandleFromAddress.
| Parameters: |
| identifier parentHWND | - |
|
| Returnvalues: |
| integer retval | - |
|
| string list | - |
|
^ 
JS_Window_ListAllTop(JS)Functioncall:
C: int JS_Window_ListAllTop(char* listOutNeedBig, int listOutNeedBig_sz)
EEL2: int extension_api("JS_Window_ListAllTop", #list)
Lua: integer retval, string list = reaper.JS_Window_ListAllTop()
Python: (Int retval, String listOutNeedBig, Int listOutNeedBig_sz) = JS_Window_ListAllTop(listOutNeedBig, listOutNeedBig_sz)
Description:Finds all top-level windows.
Returns:
* retval: The number of windows found; negative if an error occurred.
* list: A comma-separated string of hexadecimal values. Each value is an address that can be converted to a HWND by the function JS_Window_HandleFromAddress.
| Returnvalues: |
| integer retval | - |
|
| string list | - |
|
^ 
JS_Window_ListFind(JS)Functioncall:
C: int JS_Window_ListFind(const char* title, bool exact, char* listOutNeedBig, int listOutNeedBig_sz)
EEL2: int extension_api("JS_Window_ListFind", "title", bool exact, #list)
Lua: integer retval, string list = reaper.JS_Window_ListFind(string title, boolean exact)
Python: (Int retval, String title, Boolean exact, String listOutNeedBig, Int listOutNeedBig_sz) = JS_Window_ListFind(title, exact, listOutNeedBig, listOutNeedBig_sz)
Description:Finds all windows (whether top-level or child) whose titles match the specified string.
Returns:
* retval: The number of windows found; negative if an error occurred.
* list: A comma-separated string of hexadecimal values. Each value is an address that can be converted to a HWND by the function JS_Window_HandleFromAddress.
Parameters:
* exact: Match entire title exactly, or match substring of title.
| Parameters: |
| string title | - |
|
| boolean exact | - |
|
| Returnvalues: |
| integer retval | - |
|
| string list | - |
|
^ 
JS_Window_MonitorFromRect(JS)Functioncall:
C: void JS_Window_MonitorFromRect(int x1, int y1, int x2, int y2, bool wantWork, int* leftOut, int* topOut, int* rightOut, int* bottomOut)
EEL2: extension_api("JS_Window_MonitorFromRect", int x1, int y1, int x2, int y2, bool wantWork, int &left, int &top, int &right, int &bottom)
Lua: number left, number top, number right, number bottom = reaper.JS_Window_MonitorFromRect(integer x1, integer y1, integer x2, integer y2, boolean wantWork)
Python: (Int x1, Int y1, Int x2, Int y2, Boolean wantWork, Int leftOut, Int topOut, Int rightOut, Int bottomOut) = JS_Window_MonitorFromRect(x1, y1, x2, y2, wantWork, leftOut, topOut, rightOut, bottomOut)
Description:
| Parameters: |
| integer x1 | - |
|
| integer y1 | - |
|
| integer x2 | - |
|
| integer y2 | - |
|
| boolean wantWork | - |
|
| Returnvalues: |
| number left | - |
|
| number top | - |
|
| number right | - |
|
| number bottom | - |
|
^ 
JS_Window_Move(JS)Functioncall:
C: void JS_Window_Move(void* windowHWND, int left, int top)
EEL2: extension_api("JS_Window_Move", void* windowHWND, int left, int top)
Lua: reaper.JS_Window_Move(identifier windowHWND, integer left, integer top)
Python: JS_Window_Move(void windowHWND, Int left, Int top)
Description:Changes the position of the specified window, keeping its size constant.
NOTES:
* For top-level windows, position is relative to the primary display.
* On Windows and Linux, position is calculated as the coordinates of the upper left corner of the window, relative to upper left corner of the primary display, and the positive Y-axis points downward.
* On macOS, position is calculated as the coordinates of the bottom left corner of the window, relative to bottom left corner of the display, and the positive Y-axis points upward.
* For a child window, on all platforms, position is relative to the upper-left corner of the parent window's client area.
* Equivalent to calling
JS_Window_SetPosition with NOSIZE, NOZORDER, NOACTIVATE and NOOWNERZORDER flags set.
| Parameters: |
| identifier windowHWND | - |
|
| integer left | - |
|
| integer top | - |
|
^ 
JS_Window_OnCommand(JS)Functioncall:
C: bool JS_Window_OnCommand(void* windowHWND, int commandID)
EEL2: bool extension_api("JS_Window_OnCommand", void* windowHWND, int commandID)
Lua: boolean retval = reaper.JS_Window_OnCommand(identifier windowHWND, integer commandID)
Python: Boolean JS_Window_OnCommand(void windowHWND, Int commandID)
Description:Sends a "WM_COMMAND" message to the specified window, which simulates a user selecting a command in the window menu.
This function is similar to Main_OnCommand and MIDIEditor_OnCommand, but can send commands to any window that has a menu.
In the case of windows that are listed among the Action list's contexts (such as the Media Explorer), the commandIDs of the actions in the Actions list may be used.
| Parameters: |
| identifier windowHWND | - |
|
| integer commandID | - |
|
| Returnvalues: |
| boolean retval | - |
|
^ 
JS_Window_RemoveXPStyle(JS)Functioncall:
C: bool JS_Window_RemoveXPStyle(void* windowHWND, bool remove)
EEL2: bool extension_api("JS_Window_RemoveXPStyle", void* windowHWND, bool remove)
Lua: boolean = reaper.JS_Window_RemoveXPStyle(identifier windowHWND, boolean remove)
Python: Boolean JS_Window_RemoveXPStyle(void windowHWND, Boolean remove)
Description:deprecated, removed from JS_0.952 and later
| Parameters: |
| identifier windowHWND | - |
|
| boolean remove | - |
|
^ 
JS_Window_Resize(JS)Functioncall:
C: void JS_Window_Resize(void* windowHWND, int width, int height)
EEL2: extension_api("JS_Window_Resize", void* windowHWND, int width, int height)
Lua: reaper.JS_Window_Resize(identifier windowHWND, integer width, integer height)
Python: JS_Window_Resize(void windowHWND, Int width, Int height)
Description:Changes the dimensions of the specified window, keeping the top left corner position constant.
* If resizing script GUIs, call gfx.update() after resizing.
* Equivalent to calling
JS_Window_SetPosition with NOMOVE, NOZORDER, NOACTIVATE and NOOWNERZORDER flags set.
| Parameters: |
| identifier windowHWND | - |
|
| integer width | - |
|
| integer height | - |
|
^ 
JS_Window_ScreenToClient(JS)Functioncall:
C: void JS_Window_ScreenToClient(void* windowHWND, int x, int y, int* xOut, int* yOut)
EEL2: extension_api("JS_Window_ScreenToClient", void* windowHWND, int x, int y, int &x, int &y)
Lua: number x, number y = reaper.JS_Window_ScreenToClient(identifier windowHWND, integer x, integer y)
Python: (void windowHWND, Int x, Int y, Int xOut, Int yOut) = JS_Window_ScreenToClient(windowHWND, x, y, xOut, yOut)
Description:Converts the screen coordinates of a specified point on the screen to client-area coordinates.
| Parameters: |
| identifier windowHWND | - |
|
| integer x | - |
|
| integer y | - |
|
| Returnvalues: |
| number x | - |
|
| number y | - |
|
^ 
JS_Window_SetFocus(JS)Functioncall:
C: void JS_Window_SetFocus(void* windowHWND)
EEL2: extension_api("JS_Window_SetFocus", void* windowHWND)
Lua: reaper.JS_Window_SetFocus(identifier windowHWND)
Python: JS_Window_SetFocus(void windowHWND)
Description:Sets the keyboard focus to the specified window.
| Parameters: |
| identifier windowHWND | - |
|
^ 
JS_Window_SetForeground(JS)Functioncall:
C: void JS_Window_SetForeground(void* windowHWND)
EEL2: extension_api("JS_Window_SetForeground", void* windowHWND)
Lua: reaper.JS_Window_SetForeground(identifier windowHWND)
Python: JS_Window_SetForeground(void windowHWND)
Description:Brings the specified window into the foreground, activates the window, and directs keyboard input to it.
| Parameters: |
| identifier windowHWND | - |
|
^ 
JS_Window_SetLong(JS)Functioncall:
C: void JS_Window_SetLong(void* windowHWND, const char* info, double value, double* retvalOut)
EEL2: extension_api("JS_Window_SetLong", void* windowHWND, "info", value, &retval)
Lua: number retval = reaper.JS_Window_SetLong(identifier windowHWND, string info, number value)
Python: (void windowHWND, String info, Float value, Float retvalOut) = JS_Window_SetLong(windowHWND, info, value, retvalOut)
Description:Similar to the Win32 function SetWindowLongPtr.
info: "USERDATA", "WNDPROC", "DLGPROC", "ID", "EXSTYLE" or "STYLE", and only on WindowOS, "INSTANCE" and "PARENT".
| Parameters: |
| identifier windowHWND | - |
|
| string info | - |
|
| number value | - |
|
| Returnvalues: |
| number retval | - |
|
^ 
JS_Window_SetOpacity(JS)Functioncall:
C: bool JS_Window_SetOpacity(void* windowHWND, const char* mode, double value)
EEL2: bool extension_api("JS_Window_SetOpacity", void* windowHWND, "mode", value)
Lua: boolean = reaper.JS_Window_SetOpacity(identifier windowHWND, string mode, number value)
Python: Boolean JS_Window_SetOpacity(void windowHWND, String mode, Float value)
Description:Sets the window opacity.
Parameters:
mode: either "ALPHA" or "COLOR".
value: If ALPHA, the specified value may range from zero to one, and will apply to the entire window, frame included.
If COLOR, value specifies a 0xRRGGBB color, and all pixels of this color will be made transparent. (All mouse clicks over transparent pixels will pass through, too).
WARNING: COLOR mode is only available in Windows, not Linux or macOS.
Transparency can only be applied to top-level windows. If windowHWND refers to a child window, the entire top-level window that contains windowHWND will be made transparent.
| Parameters: |
| identifier windowHWND | - |
|
| string mode | - |
|
| number value | - |
|
^ 
JS_Window_SetParent(JS)Functioncall:
C: void* JS_Window_SetParent(void* childHWND, void* parentHWNDOptional)
EEL2: void* extension_api("JS_Window_SetParent", void* childHWND, void* parentHWND)
Lua: identifier = reaper.JS_Window_SetParent(identifier childHWND, identifier parentHWND)
Python: void JS_Window_SetParent(void childHWND, void parentHWNDOptional)
Description:If successful, returns a handle to the previous parent window.
Only on WindowsOS: If parentHWND is not specified, the desktop window becomes the new parent window.
| Parameters: |
| identifier childHWND | - |
|
| identifier parentHWND | - |
|
| Returnvalues: |
| identifier Identifier | - |
|
^ 
JS_Window_SetPosition(JS)Functioncall:
C: bool JS_Window_SetPosition(void* windowHWND, int left, int top, int width, int height, char* ZOrderOptional, char* flagsOptional)
EEL2: bool extension_api("JS_Window_SetPosition", void* windowHWND, int left, int top, int width, int height, optional #ZOrder, optional #flags)
Lua: boolean retval, optional string ZOrder, optional string flags = reaper.JS_Window_SetPosition(identifier windowHWND, integer left, integer top, integer width, integer height, optional string ZOrder, optional string flags)
Python: (Boolean retval, void windowHWND, Int left, Int top, Int width, Int height, String ZOrderOptional, String flagsOptional) = JS_Window_SetPosition(windowHWND, left, top, width, height, ZOrderOptional, flagsOptional)
Description:Interface to the Win32/swell function SetWindowPos, with which window position, size, Z-order and visibility can be set, and new frame styles can be applied.
ZOrder and flags are optional parameters. If no arguments are supplied, the window will simply be moved and resized, as if the NOACTIVATE, NOZORDER, NOOWNERZORDER flags were set.
* ZOrder: "BOTTOM", "TOPMOST", "NOTOPMOST", "TOP" or a window HWND converted to a string, for example by the Lua function tostring.
* flags: Any combination of the standard flags, of which "NOMOVE", "NOSIZE", "NOZORDER", "NOACTIVATE", "SHOWWINDOW", "FRAMECHANGED" and "NOCOPYBITS" should be valid cross-platform.
| Parameters: |
| identifier windowHWND | - |
|
| integer left | - |
|
| integer top | - |
|
| integer width | - |
|
| integer height | - |
|
| optional string ZOrder | - |
|
| optional string flags | - |
|
| Returnvalues: |
| boolean retval | - |
|
| optional string ZOrder | - |
|
| optional string flags | - |
|
^ 
JS_Window_SetScrollPos(JS)Functioncall:
C: bool JS_Window_SetScrollPos(void* windowHWND, const char* scrollbar, int position)
EEL2: bool extension_api("JS_Window_SetScrollPos", void* windowHWND, "scrollbar", int position)
Lua: boolean = reaper.JS_Window_SetScrollPos(identifier windowHWND, string scrollbar, integer position)
Python: Boolean JS_Window_SetScrollPos(void windowHWND, String scrollbar, Int position)
Description:Parameters:
* scrollbar: "v" (or "SB_VERT", or "VERT") for vertical scroll, "h" (or "SB_HORZ" or "HORZ") for horizontal.
NOTE: API functions can scroll REAPER's windows, but cannot zoom them. Instead, use actions such as "View: Zoom to one loop iteration".
| Parameters: |
| identifier windowHWND | - | |
| string scrollbar | - | |
| integer position | - | |
^ 
JS_Window_SetStyle(JS)Functioncall:
C: bool JS_Window_SetStyle(void* windowHWND, char* style)
EEL2: bool extension_api("JS_Window_SetStyle", void* windowHWND, #style)
Lua: boolean retval, string style = reaper.JS_Window_SetStyle(identifier windowHWND, string style)
Python: (Boolean retval, void windowHWND, String style) = JS_Window_SetStyle(windowHWND, style)
Description:Sets and applies a window style.
style may include any combination of standard window styles, such as "POPUP" for a frameless window, or "CAPTION,SIZEBOX,SYSMENU" for a standard framed window.
On Linux and macOS, "MAXIMIZE" has not yet been implmented, and the remaining styles may appear slightly different from their WindowsOS counterparts.
| Parameters: |
| identifier windowHWND | - | |
| string style | - | |
| Returnvalues: |
| boolean retval | - | |
| string style | - | |
^ 
JS_Window_SetTitle(JS)Functioncall:
C: bool JS_Window_SetTitle(void* windowHWND, const char* title)
EEL2: bool extension_api("JS_Window_SetTitle", void* windowHWND, "title")
Lua: boolean = reaper.JS_Window_SetTitle(identifier windowHWND, string title)
Python: Boolean JS_Window_SetTitle(void windowHWND, String title)
Description:Changes the title of the specified window. Returns true if successful.
| Parameters: |
| identifier windowHWND | - |
|
| string title | - |
|
^ 
JS_Window_SetZOrder(JS)Functioncall:
C: bool JS_Window_SetZOrder(void* windowHWND, const char* ZOrder, void* insertAfterHWND)
EEL2: bool extension_api("JS_Window_SetZOrder", void* windowHWND, "ZOrder", void* insertAfterHWND)
Lua: boolean = reaper.JS_Window_SetZOrder(identifier windowHWND, string ZOrder, identifier insertAfterHWND)
Python: Boolean JS_Window_SetZOrder(void windowHWND, String ZOrder, void insertAfterHWND)
Description:Sets the window Z order.
* Equivalent to calling JS_Window_SetPos with flags NOMOVE | NOSIZE.
* Not all the Z orders have been implemented in Linux yet.
Parameters:
* ZOrder: "BOTTOM", "TOPMOST", "NOTOPMOST", "TOP", or a window HWND converted to a string, for example by the Lua function tostring.
* InsertAfterHWND: For compatibility with older versions, this parameter is still available, and is optional. If ZOrder is "INSERTAFTER", insertAfterHWND must be a handle to the window behind which windowHWND will be placed in the Z order, equivalent to setting ZOrder to this HWND; otherwise, insertAfterHWND is ignored and can be left out (or it can simply be set to the same value as windowHWND).
| Parameters: |
| identifier windowHWND | - | |
| string ZOrder | - | |
| identifier insertAfterHWND | - | |
^ 
JS_Window_Show(JS)Functioncall:
C: void JS_Window_Show(void* windowHWND, const char* state)
EEL2: extension_api("JS_Window_Show", void* windowHWND, "state")
Lua: reaper.JS_Window_Show(identifier windowHWND, string state)
Python: JS_Window_Show(void windowHWND, String state)
Description:Sets the specified window's show state.
Parameters:
* state: One of the following options: "SHOW", "SHOWNA" (or "SHOWNOACTIVATE"), "SHOWMINIMIZED", "HIDE", "NORMAL", "SHOWNORMAL", "SHOWMAXIMIZED", "SHOWDEFAULT" or "RESTORE".
On Linux and macOS, only the first four options are fully implemented.
| Parameters: |
| identifier windowHWND | - |
|
| string state | - |
|
^ 
JS_Window_Update(JS)Functioncall:
C: void JS_Window_Update(void* windowHWND)
EEL2: extension_api("JS_Window_Update", void* windowHWND)
Lua: reaper.JS_Window_Update(identifier windowHWND)
Python: JS_Window_Update(void windowHWND)
Description:Similar to the Win32 function UpdateWindow.
| Parameters: |
| identifier windowHWND | - |
|
^ 
JS_Dialog_BrowseForFolder(JS)Functioncall:
C: int JS_Dialog_BrowseForFolder(const char* caption, const char* initialFolder, char* folderOutNeedBig, int folderOutNeedBig_sz)
EEL2: int extension_api("JS_Dialog_BrowseForFolder", "caption", "initialFolder", #folder)
Lua: integer retval, string folder = reaper.JS_Dialog_BrowseForFolder(string caption, string initialFolder)
Python: (Int retval, String caption, String initialFolder, String folderOutNeedBig, Int folderOutNeedBig_sz) = JS_Dialog_BrowseForFolder(caption, initialFolder, folderOutNeedBig, folderOutNeedBig_sz)
Description:retval is 1 if a folder was selected, 0 if the user canceled the dialog, and -1 if an error occurred.
| Parameters: |
| string caption | - | the captiontext for the folder-selection dialog
|
| string initialFolder | - | the path to the folder, which shall be highlighted initially
|
| Returnvalues: |
| integer retval | - | 0, no folder was selected(user hit cancel-button); 1, folder was selected; -1, in case of an error
|
| string folder | - | the path to the folder that was selected
|
^ 
JS_Dialog_BrowseForOpenFiles(JS)Functioncall:
C: int JS_Dialog_BrowseForOpenFiles(const char* windowTitle, const char* initialFolder, const char* initialFile, const char* extensionList, bool allowMultiple, char* fileNamesOutNeedBig, int fileNamesOutNeedBig_sz)
EEL2: int extension_api("JS_Dialog_BrowseForOpenFiles", "windowTitle", "initialFolder", "initialFile", "extensionList", bool allowMultiple, #fileNames)
Lua: integer retval, string fileNames = reaper.JS_Dialog_BrowseForOpenFiles(string windowTitle, string initialFolder, string initialFile, string extensionList, boolean allowMultiple)
Python: (Int retval, String windowTitle, String initialFolder, String initialFile, String extensionList, Boolean allowMultiple, String fileNamesOutNeedBig, Int fileNamesOutNeedBig_sz) = JS_Dialog_BrowseForOpenFiles(windowTitle, initialFolder, initialFile, extensionList, allowMultiple, fileNamesOutNeedBig, fileNamesOutNeedBig_sz)
Description:If allowMultiple is true, multiple files may be selected. The returned string is \0-separated, with the first substring containing the folder path and subsequent substrings containing the file names.
* On macOS, the first substring may be empty, and each file name will then contain its entire path.
* This function only allows selection of existing files, and does not allow creation of new files.
extensionList is a string containing pairs of \0-terminated substrings. The last substring must be terminated by two \0 characters. Each pair defines one filter pattern:
* The first substring in each pair describes the filter in user-readable form (for example, "Lua script files (*.lua)") and will be displayed in the dialog box.
* The second substring specifies the filter that the operating system must use to search for the files (for example, "*.txt"; the wildcard should not be omitted). To specify multiple extensions for a single display string, use a semicolon to separate the patterns (for example, "*.lua;*.eel").
An example of an extensionList string:
"ReaScript files\0*.lua;*.eel\0Lua files (.lua)\0*.lua\0EEL files (.eel)\0*.eel\0\0".
On macOS, file dialogs do not accept empty extensionLists, nor wildcard extensions (such as "All files\0*.*\0\0"), so each acceptable extension must be listed explicitly. On Linux and Windows, wildcard extensions are acceptable, and if the extensionList string is empty, the dialog will display a default "All files (*.*)" filter.
retval is 1 if one or more files were selected, 0 if the user cancelled the dialog, or negative if an error occurred.
Displaying \0-separated strings:
* REAPER's IDE and ShowConsoleMsg only display strings up to the first \0 byte. If multiple files were selected, only the first substring containing the path will be displayed. This is not a problem for Lua or EEL, which can access the full string beyond the first \0 byte as usual.
| Parameters: |
| string windowTitle | - | the title of the file-selection-window |
| string initialFolder | - | the initial folder opened in the file-chooser-dialog |
| string initialFile | - | the default-filename already entered in the filename-entrybox |
| string extensionList | - | a list of extensions that can be selected in the selection-list. the list has the following structure(separate the entries with a \0): "description of type1\0type1\0description of type 2\0type2\0" the description of type can be anything that describes the type(s), to define one type, write: *.ext to define multiple types, write: *.ext;*.ext2;*.ext3 the extensionList must end with a \0 |
| boolean allowMultiple | - | true, allows selection of multiple files; false, allows only selection of one file |
| Returnvalues: |
| integer retval | - | 1, file was selected; 0, no file selected; -1, in case of an error |
| string fileNames | - | the selected filenames.
when parameter allowMultiple=false, this returnvalue holds filename with path
when parameter allowMultiple=true, this returnvalue holds the path and all selected files, separated by \0
path\0filename1\0filename2\0filename3 |
^ 
JS_Dialog_BrowseForSaveFile(JS)Functioncall:
C: int JS_Dialog_BrowseForSaveFile(const char* windowTitle, const char* initialFolder, const char* initialFile, const char* extensionList, char* fileNameOutNeedBig, int fileNameOutNeedBig_sz)
EEL2: int extension_api("JS_Dialog_BrowseForSaveFile", "windowTitle", "initialFolder", "initialFile", "extensionList", #fileName)
Lua: integer retval, string fileName = reaper.JS_Dialog_BrowseForSaveFile(string windowTitle, string initialFolder, string initialFile, string extensionList)
Python: (Int retval, String windowTitle, String initialFolder, String initialFile, String extensionList, String fileNameOutNeedBig, Int fileNameOutNeedBig_sz) = JS_Dialog_BrowseForSaveFile(windowTitle, initialFolder, initialFile, extensionList, fileNameOutNeedBig, fileNameOutNeedBig_sz)
Description:Opens a file-chooser-dialog for saving operations.
retval is 1 if a file was selected, 0 if the user cancelled the dialog, or negative if an error occurred.
extensionList is a string containing pairs of 0-terminated substrings. The last substring must be terminated by two 0 characters. Each pair defines one filter pattern:
* The first substring in each pair describes the filter in user-readable form (for example, "Lua script files (*.lua)") and will be displayed in the dialog box.
* The second substring specifies the filter that the operating system must use to search for the files (for example, "*.txt"; the wildcard should not be omitted). To specify multiple extensions for a single display string, use a semicolon to separate the patterns (for example, "*.lua;*.eel").
An example of an extensionList string:
"ReaScript files\0*.lua;*.eel\0Lua files (.lua)\0*.lua\0EEL files (.eel)\0*.eel\0\0".
If the extensionList string is empty, it will display the default "All files (*.*)" filter.
| Parameters: |
| string windowTitle | - | the title of the file-selection-window |
| string initialFolder | - | the initial folder opened in the file-chooser-dialog |
| string initialFile | - | the default-filename already entered in the filename-entrybox |
| string extensionList | - | a list of extensions that can be selected in the selection-list. the list has the following structure(separate the entries with a \0): "description of type1\0type1\0description of type 2\0type2\0" the description of type can be anything that describes the type(s), to define one type, write: *.ext to define multiple types, write: *.ext;*.ext2;*.ext3 the extensionList must end with a \0 |
| Returnvalues: |
| integer retval | - | 1, file was selected; 0, no file selected; -1, in case of an error |
| string fileNames | - | the selected filename. |
^ 
JS_ListView_EnumSelItems(JS)Functioncall:
C: int JS_ListView_EnumSelItems(void* listviewHWND, int index)
EEL2: int extension_api("JS_ListView_EnumSelItems", void* listviewHWND, int index)
Lua: integer = reaper.JS_ListView_EnumSelItems(identifier listviewHWND, integer index)
Python: Int JS_ListView_EnumSelItems(void listviewHWND, Int index)
Description:Returns the index of the next selected list item with index greater that the specified number. Returns -1 if no selected items left.
| Parameters: |
| identifier listviewHWND | - | the HWND of the window
|
| integer index | - | the index of the listitems before the next selected one
|
| Returnvalues: |
| integer retval | - | the index of the next selected list item
|
^ 
JS_ListView_GetFocusedItem(JS)Functioncall:
C: int JS_ListView_GetFocusedItem(void* listviewHWND, char* textOut, int textOut_sz)
EEL2: int extension_api("JS_ListView_GetFocusedItem", void* listviewHWND, #text)
Lua: integer retval, string text = reaper.JS_ListView_GetFocusedItem(identifier listviewHWND)
Python: (Int retval, void listviewHWND, String textOut, Int textOut_sz) = JS_ListView_GetFocusedItem(listviewHWND, textOut, textOut_sz)
Description:Returns the index and text of the focused item, if any.
| Parameters: |
| identifier listviewHWND | - |
|
| Returnvalues: |
| integer retval | - |
|
| string text | - |
|
^ 
JS_ListView_GetItem(JS)Functioncall:
C: void JS_ListView_GetItem(void* listviewHWND, int index, int subItem, char* textOut, int textOut_sz, int* stateOut)
EEL2: extension_api("JS_ListView_GetItem", void* listviewHWND, int index, int subItem, #text, int &state)
Lua: string text, number state = reaper.JS_ListView_GetItem(identifier listviewHWND, integer index, integer subItem)
Python: (void listviewHWND, Int index, Int subItem, String textOut, Int textOut_sz, Int stateOut) = JS_ListView_GetItem(listviewHWND, index, subItem, textOut, textOut_sz, stateOut)
Description:Returns the text and state of specified item.
| Parameters: |
| identifier listviewHWND | - |
|
| integer index | - |
|
| integer subItem | - |
|
| Returnvalues: |
| string text | - |
|
| number state | - |
|
^ 
JS_ListView_GetItemCount(JS)Functioncall:
C: int JS_ListView_GetItemCount(void* listviewHWND)
EEL2: int extension_api("JS_ListView_GetItemCount", void* listviewHWND)
Lua: integer retval = reaper.JS_ListView_GetItemCount(identifier listviewHWND)
Python: Int JS_ListView_GetItemCount(void listviewHWND)
Description:
| Parameters: |
| identifier listviewHWND | - |
|
| Returnvalues: |
| integer retval | - |
|
^ 
JS_ListView_GetItemRect(JS)Functioncall:
C: bool JS_ListView_GetItemRect(void* listviewHWND, int index, int* leftOut, int* topOut, int* rightOut, int* bottomOut)
EEL2: bool extension_api("JS_ListView_GetItemRect", void* listviewHWND, int index, int &left, int &top, int &right, int &bottom)
Lua: boolean retval, number left, number top, number right, number bottom = reaper.JS_ListView_GetItemRect(identifier listviewHWND, integer index)
Python: (Boolean retval, void listviewHWND, Int index, Int leftOut, Int topOut, Int rightOut, Int bottomOut) = JS_ListView_GetItemRect(listviewHWND, index, leftOut, topOut, rightOut, bottomOut)
Description:Returns client coordinates of the item.
| Parameters: |
| identifier listviewHWND | - |
|
| integer index | - |
|
| Returnvalues: |
| boolean retval | - |
|
| number left | - |
|
| number top | - |
|
| number right | - |
|
| number bottom | - |
|
^ 
JS_ListView_GetItemState(JS)Functioncall:
C: int JS_ListView_GetItemState(void* listviewHWND, int index)
EEL2: int extension_api("JS_ListView_GetItemState", void* listviewHWND, int index)
Lua: integer retval = reaper.JS_ListView_GetItemState(identifier listviewHWND, integer index)
Python: Int JS_ListView_GetItemState(void listviewHWND, Int index)
Description:State is a bitmask:
1 = selected, 2 = focused. On Windows only, cut-and-paste marked = 4, drag-and-drop highlighted = 8.
Warning: this function uses the Win32 bitmask values, which differ from the values used by WDL/swell.
| Parameters: |
| identifier listviewHWND | - |
|
| integer index | - |
|
| Returnvalues: |
| integer retval | - |
|
^ 
JS_ListView_GetItemText(JS)Functioncall:
C: void JS_ListView_GetItemText(void* listviewHWND, int index, int subItem, char* textOut, int textOut_sz)
EEL2: extension_api("JS_ListView_GetItemText", void* listviewHWND, int index, int subItem, #text)
Lua: string text = reaper.JS_ListView_GetItemText(identifier listviewHWND, integer index, integer subItem)
Python: (void listviewHWND, Int index, Int subItem, String textOut, Int textOut_sz) = JS_ListView_GetItemText(listviewHWND, index, subItem, textOut, textOut_sz)
Description:
| Parameters: |
| identifier listviewHWND | - |
|
| integer index | - |
|
| integer subItem | - |
|
| Returnvalues: |
| string text | - |
|
^ 
JS_ListView_GetSelectedCount(JS)Functioncall:
C: int JS_ListView_GetSelectedCount(void* listviewHWND)
EEL2: int extension_api("JS_ListView_GetSelectedCount", void* listviewHWND)
Lua: integer retval = reaper.JS_ListView_GetSelectedCount(identifier listviewHWND)
Python: Int JS_ListView_GetSelectedCount(void listviewHWND)
Description:
| Parameters: |
| identifier listviewHWND | - |
|
| Returnvalues: |
| integer retval | - |
|
^ 
JS_ListView_GetTopIndex(JS)Functioncall:
C: int JS_ListView_GetTopIndex(void* listviewHWND)
EEL2: int extension_api("JS_ListView_GetTopIndex", void* listviewHWND)
Lua: integer = reaper.JS_ListView_GetTopIndex(identifier listviewHWND)
Python: Int JS_ListView_GetTopIndex(void listviewHWND)
Description:
| Parameters: |
| identifier listviewHWND | - |
|
| Returnvalues: |
| integer retval | - |
|
^ 
JS_ListView_HitTest(JS)Functioncall:
C: void JS_ListView_HitTest(void* listviewHWND, int clientX, int clientY, int* indexOut, int* subItemOut, int* flagsOut)
EEL2: extension_api("JS_ListView_HitTest", void* listviewHWND, int clientX, int clientY, int &index, int &subItem, int &flags)
Lua: number index, number subItem, number flags = reaper.JS_ListView_HitTest(identifier listviewHWND, integer clientX, integer clientY)
Python: (void listviewHWND, Int clientX, Int clientY, Int indexOut, Int subItemOut, Int flagsOut) = JS_ListView_HitTest(listviewHWND, clientX, clientY, indexOut, subItemOut, flagsOut)
Description:
| Parameters: |
| identifier listviewHWND | - |
|
| integer clientX | - |
|
| integer clientY | - |
|
| Returnvalues: |
| number index | - |
|
| number subItem | - |
|
| number flags | - |
|
^ 
JS_ListView_ListAllSelItems(JS)Functioncall:
C: int JS_ListView_ListAllSelItems(void* listviewHWND, char* itemsOutNeedBig, int itemsOutNeedBig_sz)
EEL2: int extension_api("JS_ListView_ListAllSelItems", void* listviewHWND, #items)
Lua: integer retval, string items = reaper.JS_ListView_ListAllSelItems(identifier listviewHWND)
Python: (Int retval, void listviewHWND, String itemsOutNeedBig, Int itemsOutNeedBig_sz) = JS_ListView_ListAllSelItems(listviewHWND, itemsOutNeedBig, itemsOutNeedBig_sz)
Description:Returns the indices of all selected items as a comma-separated list.
* retval: Number of selected items found; negative or zero if an error occured.
| Parameters: |
| identifier listviewHWND | - | |
| Returnvalues: |
| integer retval | - | |
| string items | - | |
^ 
JS_ListView_SetItemState(JS)Functioncall:
C: void JS_ListView_SetItemState(void* listviewHWND, int index, int state, int mask)
EEL2: extension_api("JS_ListView_SetItemState", void* listviewHWND, int index, int state, int mask)
Lua: reaper.JS_ListView_SetItemState(identifier listviewHWND, integer index, integer state, integer mask)
Python: JS_ListView_SetItemState(void listviewHWND, Int index, Int state, Int mask)
Description:The mask parameter specifies the state bits that must be set, and the state parameter specifies the new values for those bits.
1 = selected, 2 = focused. On Windows only, cut-and-paste marked = 4, drag-and-drop highlighted = 8.
Warning: this function uses the Win32 bitmask values, which differ from the values used by WDL/swell.
| Parameters: |
| identifier listviewHWND | - | |
| integer index | - | |
| integer state | - | |
| integer mask | - | |
^ 
JS_ListView_SetItemText(JS)Functioncall:
C: void JS_ListView_SetItemText(void* listviewHWND, int index, int subItem, const char* text)
EEL2: extension_api("JS_ListView_SetItemText", void* listviewHWND, int index, int subItem, "text")
Lua: reaper.JS_ListView_SetItemText(identifier listviewHWND, integer index, integer subItem, string text)
Python: JS_ListView_SetItemText(void listviewHWND, Int index, Int subItem, String text)
Description:Currently, this fuction only accepts ASCII text.
| Parameters: |
| identifier listviewHWND | - | |
| integer index | - | |
| integer subItem | - | |
| string text | - | |
^ 
Xen_AudioWriter_Create(JS)Functioncall:
C: AudioWriter* Xen_AudioWriter_Create(const char* filename, int numchans, int samplerate)
EEL2: AudioWriter extension_api("Xen_AudioWriter_Create", "filename", int numchans, int samplerate)
Lua: AudioWriter = reaper.Xen_AudioWriter_Create(string filename, integer numchans, integer samplerate)
Python: AudioWriter Xen_AudioWriter_Create(String filename, Int numchans, Int samplerate)
Description:Creates writer for 32 bit floating point WAV
| Parameters: |
| string filename | - |
|
| integer numchans | - |
|
| integer samplerate | - |
|
| Returnvalues: |
| AudioWriter | - |
|
^ 
Xen_AudioWriter_Destroy(JS)Functioncall:
C: void Xen_AudioWriter_Destroy(AudioWriter* writer)
EEL2: extension_api("Xen_AudioWriter_Destroy", AudioWriter writer)
Lua: reaper.Xen_AudioWriter_Destroy(AudioWriter writer)
Python: Xen_AudioWriter_Destroy(AudioWriter writer)
Description:Destroys writer
| Parameters: |
| AudioWriter writer | - |
|
^ 
Xen_AudioWriter_Write(JS)Functioncall:
C: int Xen_AudioWriter_Write(AudioWriter* writer, int numframes, void* data, int offset)
EEL2: int extension_api("Xen_AudioWriter_Write", AudioWriter writer, int numframes, void* data, int offset)
Lua: integer = reaper.Xen_AudioWriter_Write(AudioWriter writer, integer numframes, identifier data, integer offset)
Python: Int Xen_AudioWriter_Write(AudioWriter writer, Int numframes, void data, Int offset)
Description:Write interleaved audio data to disk
| Parameters: |
| AudioWriter writer | - |
|
| integer numframes | - |
|
| identifier data | - |
|
| integer offset | - |
|
^ 
Xen_GetMediaSourceSamples(JS)Functioncall:
C: int Xen_GetMediaSourceSamples(PCM_source* src, void* destbuf, int destbufoffset, int numframes, int numchans, double samplerate, double sourceposition)
EEL2: int extension_api("Xen_GetMediaSourceSamples", PCM_source src, void* destbuf, int destbufoffset, int numframes, int numchans, samplerate, sourceposition)
Lua: integer = reaper.Xen_GetMediaSourceSamples(PCM_source src, identifier destbuf, integer destbufoffset, integer numframes, integer numchans, number samplerate, number sourceposition)
Python: Int Xen_GetMediaSourceSamples(PCM_source src, void destbuf, Int destbufoffset, Int numframes, Int numchans, Float samplerate, Float sourceposition)
Description:Get interleaved audio data from media source
| Parameters: |
| PCM_source src | - |
|
| identifier destbuf | - |
|
| integer destbufoffset | - |
|
| integer numframes | - |
|
| integer numchans | - |
|
| number samplerate | - |
|
| number sourceposition | - |
|
^ 
Xen_StartSourcePreview(JS)Functioncall:
C: int Xen_StartSourcePreview(PCM_source* source, double gain, bool loop, int* outputchanindexInOptional)
EEL2: int extension_api("Xen_StartSourcePreview", PCM_source source, gain, bool loop, optional int outputchanindexIn)
Lua: integer = reaper.Xen_StartSourcePreview(PCM_source source, number gain, boolean loop, optional number outputchanindexIn)
Python: (Int retval, PCM_source source, Float gain, Boolean loop, Int outputchanindexInOptional) = Xen_StartSourcePreview(source, gain, loop, outputchanindexInOptional)
Description:Start audio preview of a PCM_source, which can be created using functions like
PCM_Source_CreateFromFile Returns id of a preview handle that can be provided to
Xen_StopSourcePreview.
If the given PCM_source does not belong to an existing MediaItem/Take, it will be deleted by the preview system when the preview is stopped.
You can preview more than one file at the same time.
| Parameters: |
| PCM_source source | - | a PCM_source-created using a mediafile/item
|
| number gain | - | the volume of the previewed pcm_source
|
| boolean loop | - | true, loop the PCM_source; false, play only once
|
| optional number outputchanindexIn | - | the output channel; for multichannel files, this is the first hardware-output-channel for e.g. left channel of a stereo file
|
| Returnvalues: |
| integer id | - | the id of this preview, which can be used to stop it again
|
^ 
Xen_StopSourcePreview(JS)Functioncall:
C: int Xen_StopSourcePreview(int preview_id)
EEL2: int extension_api("Xen_StopSourcePreview", int preview_id)
Lua: integer retval = reaper.Xen_StopSourcePreview(integer preview_id)
Python: Int Xen_StopSourcePreview(Int preview_id)
Description:Stop audio preview.
To stop all running previews, set id=-1
| Parameters: |
| integer preview_id | - | the id of the running preview; -1, stops all running previews
|
| Returnvalues: |
| integer retval | - |
|
^ 
BR_Win32_CB_FindString(SWS)Functioncall:
C: int BR_Win32_CB_FindString(void* comboBoxHwnd, int startId, const char* string)
EEL2: int extension_api("BR_Win32_CB_FindString", void* comboBoxHwnd, int startId, "string")
Lua: integer = reaper.BR_Win32_CB_FindString(identifier comboBoxHwnd, integer startId, string string)
Python: Int BR_Win32_CB_FindString(void comboBoxHwnd, Int startId, String string)
Description:[BR] Equivalent to win32 API ComboBox_FindString().
| Parameters: |
| identifier comboBoxHwnd | - | |
| integer startId | - | |
| string string | - | |
^ 
BR_Win32_CB_FindStringExact(SWS)Functioncall:
C: int BR_Win32_CB_FindStringExact(void* comboBoxHwnd, int startId, const char* string)
EEL2: int extension_api("BR_Win32_CB_FindStringExact", void* comboBoxHwnd, int startId, "string")
Lua: integer = reaper.BR_Win32_CB_FindStringExact(identifier comboBoxHwnd, integer startId, string string)
Python: Int BR_Win32_CB_FindStringExact(void comboBoxHwnd, Int startId, String string)
Description:[BR] Equivalent to win32 API ComboBox_FindStringExact().
| Parameters: |
| identifier comboBoxHwnd | - | |
| integer startId | - | |
| string string | - | |
^ 
BR_Win32_ClientToScreen(SWS)Functioncall:
C: void BR_Win32_ClientToScreen(void* hwnd, int xIn, int yIn, int* xOut, int* yOut)
EEL2: extension_api("BR_Win32_ClientToScreen", void* hwnd, int xIn, int yIn, int &x, int &y)
Lua: number x, number y = reaper.BR_Win32_ClientToScreen(identifier hwnd, integer xIn, integer yIn)
Python: (void hwnd, Int xIn, Int yIn, Int xOut, Int yOut) = BR_Win32_ClientToScreen(hwnd, xIn, yIn, xOut, yOut)
Description:[BR] Equivalent to win32 API ClientToScreen().
| Parameters: |
| identifier hwnd | - | |
| integer xIn | - | |
| integer yIn | - | |
| Returnvalues: |
| number x | - | |
| number y | - | |
^ 
BR_Win32_FindWindowEx(SWS)Functioncall:
C: void* BR_Win32_FindWindowEx(const char* hwndParent, const char* hwndChildAfter, const char* className, const char* windowName, bool searchClass, bool searchName)
EEL2: void* extension_api("BR_Win32_FindWindowEx", "hwndParent", "hwndChildAfter", "className", "windowName", bool searchClass, bool searchName)
Lua: identifier = reaper.BR_Win32_FindWindowEx(string hwndParent, string hwndChildAfter, string className, string windowName, boolean searchClass, boolean searchName)
Python: void BR_Win32_FindWindowEx(String hwndParent, String hwndChildAfter, String className, String windowName, Boolean searchClass, Boolean searchName)
Description:[BR] Equivalent to win32 API FindWindowEx(). Since ReaScript doesn't allow passing NULL (None in Python, nil in Lua etc...) parameters, to search by supplied class or name set searchClass and searchName accordingly. HWND parameters should be passed as either "0" to signify NULL or as string obtained from
BR_Win32_HwndToString.
| Parameters: |
| string hwndParent | - |
|
| string hwndChildAfter | - |
|
| string className | - |
|
| string windowName | - |
|
| boolean searchClass | - |
|
| boolean searchName | - |
|
| Returnvalues: |
| identifier | - |
|
^ 
BR_Win32_GET_X_LPARAM(SWS)Functioncall:
C: int BR_Win32_GET_X_LPARAM(int lParam)
EEL2: int extension_api("BR_Win32_GET_X_LPARAM", int lParam)
Lua: integer = reaper.BR_Win32_GET_X_LPARAM(integer lParam)
Python: Int BR_Win32_GET_X_LPARAM(Int lParam)
Description:[BR] Equivalent to win32 API GET_X_LPARAM().
| Parameters: |
| integer lParam | - | |
^ 
BR_Win32_GET_Y_LPARAM(SWS)Functioncall:
C: int BR_Win32_GET_Y_LPARAM(int lParam)
EEL2: int extension_api("BR_Win32_GET_Y_LPARAM", int lParam)
Lua: integer = reaper.BR_Win32_GET_Y_LPARAM(integer lParam)
Python: Int BR_Win32_GET_Y_LPARAM(Int lParam)
Description:[BR] Equivalent to win32 API GET_Y_LPARAM().
| Parameters: |
| integer lParam | - | |
^ 
BR_Win32_GetConstant(SWS)Functioncall:
C: int BR_Win32_GetConstant(const char* constantName)
EEL2: int extension_api("BR_Win32_GetConstant", "constantName")
Lua: integer = reaper.BR_Win32_GetConstant(string constantName)
Python: Int BR_Win32_GetConstant(String constantName)
Description:[BR] Returns various constants needed for BR_Win32 functions.
Supported constants are:
CB_ERR, CB_GETCOUNT, CB_GETCURSEL, CB_SETCURSEL
EM_SETSEL
GW_CHILD, GW_HWNDFIRST, GW_HWNDLAST, GW_HWNDNEXT, GW_HWNDPREV, GW_OWNER
GWL_STYLE
SW_HIDE, SW_MAXIMIZE, SW_SHOW, SW_SHOWMINIMIZED, SW_SHOWNA, SW_SHOWNOACTIVATE, SW_SHOWNORMAL
SWP_FRAMECHANGED, SWP_FRAMECHANGED, SWP_NOMOVE, SWP_NOOWNERZORDER, SWP_NOSIZE, SWP_NOZORDER
VK_DOWN, VK_UP
WM_CLOSE, WM_KEYDOWN
WS_MAXIMIZE, WS_OVERLAPPEDWINDOW
| Parameters: |
| string constantName | - | |
^ 
BR_Win32_GetCursorPos(SWS)Functioncall:
C: bool BR_Win32_GetCursorPos(int* xOut, int* yOut)
EEL2: bool extension_api("BR_Win32_GetCursorPos", int &x, int &y)
Lua: boolean retval, number x, number y = reaper.BR_Win32_GetCursorPos()
Python: (Boolean retval, Int xOut, Int yOut) = BR_Win32_GetCursorPos(xOut, yOut)
Description:[BR] Equivalent to win32 API GetCursorPos().
| Returnvalues: |
| boolean retval | - | |
| number x | - | |
| number y | - | |
^ 
BR_Win32_GetFocus(SWS)Functioncall:
C: void* BR_Win32_GetFocus()
EEL2: void* extension_api("BR_Win32_GetFocus")
Lua: identifier = reaper.BR_Win32_GetFocus()
Python: void BR_Win32_GetFocus()
Description:[BR] Equivalent to win32 API GetFocus().
| Returnvalues: |
| identifier | - | |
^ 
BR_Win32_GetForegroundWindow(SWS)Functioncall:
C: void* BR_Win32_GetForegroundWindow()
EEL2: void* extension_api("BR_Win32_GetForegroundWindow")
Lua: identifier = reaper.BR_Win32_GetForegroundWindow()
Python: void BR_Win32_GetForegroundWindow()
Description:[BR] Equivalent to win32 API GetForegroundWindow().
| Returnvalues: |
| identifier | - | |
^ 
BR_Win32_GetMainHwnd(SWS)Functioncall:
C: void* BR_Win32_GetMainHwnd()
EEL2: void* extension_api("BR_Win32_GetMainHwnd")
Lua: identifier = reaper.BR_Win32_GetMainHwnd()
Python: void BR_Win32_GetMainHwnd()
Description:[BR] Alternative to
GetMainHwnd. REAPER seems to have problems with extensions using HWND type for exported functions so all BR_Win32 functions use void* instead of HWND type
| Returnvalues: |
| identifier | - |
|
^ 
BR_Win32_GetMixerHwnd(SWS)Functioncall:
C: void* BR_Win32_GetMixerHwnd(bool* isDockedOut)
EEL2: void* extension_api("BR_Win32_GetMixerHwnd", bool &isDocked)
Lua: identifier retval, boolean isDocked = reaper.BR_Win32_GetMixerHwnd()
Python: (void retval, Boolean isDockedOut) = BR_Win32_GetMixerHwnd(isDockedOut)
Description:[BR] Get mixer window HWND. isDockedOut will be set to true if mixer is docked
| Returnvalues: |
| identifier retval | - | |
| boolean isDocked | - | |
^ 
BR_Win32_GetMonitorRectFromRect(SWS)Functioncall:
C: void BR_Win32_GetMonitorRectFromRect(bool workingAreaOnly, int leftIn, int topIn, int rightIn, int bottomIn, int* leftOut, int* topOut, int* rightOut, int* bottomOut)
EEL2: extension_api("BR_Win32_GetMonitorRectFromRect", bool workingAreaOnly, int leftIn, int topIn, int rightIn, int bottomIn, int &left, int &top, int &right, int &bottom)
Lua: number left, number top, number right, number bottom = reaper.BR_Win32_GetMonitorRectFromRect(boolean workingAreaOnly, integer leftIn, integer topIn, integer rightIn, integer bottomIn)
Python: (Boolean workingAreaOnly, Int leftIn, Int topIn, Int rightIn, Int bottomIn, Int leftOut, Int topOut, Int rightOut, Int bottomOut) = BR_Win32_GetMonitorRectFromRect(workingAreaOnly, leftIn, topIn, rightIn, bottomIn, leftOut, topOut, rightOut, bottomOut)
Description:[BR] Get coordinates for screen which is nearest to supplied coordinates. Pass workingAreaOnly as true to get screen coordinates excluding taskbar (or menu bar on OSX).
| Parameters: |
| boolean workingAreaOnly | - | |
| integer leftIn | - | |
| integer topIn | - | |
| integer rightIn | - | |
| integer bottomIn | - | |
| Returnvalues: |
| number left | - | |
| number top | - | |
| number right | - | |
| number bottom | - | |
^ 
BR_Win32_GetParent(SWS)Functioncall:
C: void* BR_Win32_GetParent(void* hwnd)
EEL2: void* extension_api("BR_Win32_GetParent", void* hwnd)
Lua: identifier = reaper.BR_Win32_GetParent(identifier hwnd)
Python: void BR_Win32_GetParent(void hwnd)
Description:[BR] Equivalent to win32 API GetParent().
| Parameters: |
| identifier hwnd | - | |
| Returnvalues: |
| identifier | - | |
^ 
BR_Win32_GetWindow(SWS)Functioncall:
C: void* BR_Win32_GetWindow(void* hwnd, int cmd)
EEL2: void* extension_api("BR_Win32_GetWindow", void* hwnd, int cmd)
Lua: identifier = reaper.BR_Win32_GetWindow(identifier hwnd, integer cmd)
Python: void BR_Win32_GetWindow(void hwnd, Int cmd)
Description:[BR] Equivalent to win32 API GetWindow().
| Parameters: |
| identifier hwnd | - | |
| integer cmd | - | |
| Returnvalues: |
| identifier | - | |
^ 
BR_Win32_GetWindowLong(SWS)Functioncall:
C: int BR_Win32_GetWindowLong(void* hwnd, int index)
EEL2: int extension_api("BR_Win32_GetWindowLong", void* hwnd, int index)
Lua: integer = reaper.BR_Win32_GetWindowLong(identifier hwnd, integer index)
Python: Int BR_Win32_GetWindowLong(void hwnd, Int index)
Description:[BR] Equivalent to win32 API GetWindowLong().
| Parameters: |
| identifier hwnd | - | |
| integer index | - | |
^ 
BR_Win32_GetWindowRect(SWS)Functioncall:
C: bool BR_Win32_GetWindowRect(void* hwnd, int* leftOut, int* topOut, int* rightOut, int* bottomOut)
EEL2: bool extension_api("BR_Win32_GetWindowRect", void* hwnd, int &left, int &top, int &right, int &bottom)
Lua: boolean retval, number left, number top, number right, number bottom = reaper.BR_Win32_GetWindowRect(identifier hwnd)
Python: (Boolean retval, void hwnd, Int leftOut, Int topOut, Int rightOut, Int bottomOut) = BR_Win32_GetWindowRect(hwnd, leftOut, topOut, rightOut, bottomOut)
Description:[BR] Equivalent to win32 API GetWindowRect().
| Parameters: |
| identifier hwnd | - | |
| Returnvalues: |
| boolean retval | - | |
| number left | - | |
| number top | - | |
| number right | - | |
| number bottom | - | |
^ 
BR_Win32_GetWindowText(SWS)Functioncall:
C: int BR_Win32_GetWindowText(void* hwnd, char* textOut, int textOut_sz)
EEL2: int extension_api("BR_Win32_GetWindowText", void* hwnd, #text)
Lua: integer retval, string text = reaper.BR_Win32_GetWindowText(identifier hwnd)
Python: (Int retval, void hwnd, String textOut, Int textOut_sz) = BR_Win32_GetWindowText(hwnd, textOut, textOut_sz)
Description:[BR] Equivalent to win32 API GetWindowText().
| Parameters: |
| identifier hwnd | - | |
| Returnvalues: |
| integer retval | - | |
| string text | - | |
^ 
BR_Win32_HIBYTE(SWS)Functioncall:
C: int BR_Win32_HIBYTE(int value)
EEL2: int extension_api("BR_Win32_HIBYTE", int value)
Lua: integer = reaper.BR_Win32_HIBYTE(integer value)
Python: Int BR_Win32_HIBYTE(Int value)
Description:[BR] Equivalent to win32 API HIBYTE().
| Parameters: |
| integer value | - | |
^ 
BR_Win32_HIWORD(SWS)Functioncall:
C: int BR_Win32_HIWORD(int value)
EEL2: int extension_api("BR_Win32_HIWORD", int value)
Lua: integer = reaper.BR_Win32_HIWORD(integer value)
Python: Int BR_Win32_HIWORD(Int value)
Description:[BR] Equivalent to win32 API HIWORD().
| Parameters: |
| integer value | - | |
^ 
BR_Win32_HwndToString(SWS)Functioncall:
C: void BR_Win32_HwndToString(void* hwnd, char* stringOut, int stringOut_sz)
EEL2: extension_api("BR_Win32_HwndToString", void* hwnd, #string)
Lua: string hwndstring = reaper.BR_Win32_HwndToString(identifier hwnd)
Python: (void hwnd, String stringOut, Int stringOut_sz) = BR_Win32_HwndToString(hwnd, stringOut, stringOut_sz)
Description:
| Parameters: |
| identifier hwnd | - |
|
| Returnvalues: |
| string hwndstring | - |
|
^ 
BR_Win32_IsWindow(SWS)Functioncall:
C: bool BR_Win32_IsWindow(void* hwnd)
EEL2: bool extension_api("BR_Win32_IsWindow", void* hwnd)
Lua: boolean = reaper.BR_Win32_IsWindow(identifier hwnd)
Python: Boolean BR_Win32_IsWindow(void hwnd)
Description:[BR] Equivalent to win32 API IsWindow().
| Parameters: |
| identifier hwnd | - | |
^ 
BR_Win32_IsWindowVisible(SWS)Functioncall:
C: bool BR_Win32_IsWindowVisible(void* hwnd)
EEL2: bool extension_api("BR_Win32_IsWindowVisible", void* hwnd)
Lua: boolean = reaper.BR_Win32_IsWindowVisible(identifier hwnd)
Python: Boolean BR_Win32_IsWindowVisible(void hwnd)
Description:[BR] Equivalent to win32 API IsWindowVisible().
| Parameters: |
| identifier hwnd | - | |
^ 
BR_Win32_LOBYTE(SWS)Functioncall:
C: int BR_Win32_LOBYTE(int value)
EEL2: int extension_api("BR_Win32_LOBYTE", int value)
Lua: integer = reaper.BR_Win32_LOBYTE(integer value)
Python: Int BR_Win32_LOBYTE(Int value)
Description:[BR] Equivalent to win32 API LOBYTE().
| Parameters: |
| integer value | - | |
^ 
BR_Win32_LOWORD(SWS)Functioncall:
C: int BR_Win32_LOWORD(int value)
EEL2: int extension_api("BR_Win32_LOWORD", int value)
Lua: integer = reaper.BR_Win32_LOWORD(integer value)
Python: Int BR_Win32_LOWORD(Int value)
Description:[BR] Equivalent to win32 API LOWORD().
| Parameters: |
| integer value | - | |
^ 
BR_Win32_MAKELONG(SWS)Functioncall:
C: int BR_Win32_MAKELONG(int low, int high)
EEL2: int extension_api("BR_Win32_MAKELONG", int low, int high)
Lua: integer = reaper.BR_Win32_MAKELONG(integer low, integer high)
Python: Int BR_Win32_MAKELONG(Int low, Int high)
Description:[BR] Equivalent to win32 API MAKELONG().
| Parameters: |
| integer low | - | |
| integer high | - | |
^ 
BR_Win32_MAKELPARAM(SWS)Functioncall:
C: int BR_Win32_MAKELPARAM(int low, int high)
EEL2: int extension_api("BR_Win32_MAKELPARAM", int low, int high)
Lua: integer = reaper.BR_Win32_MAKELPARAM(integer low, integer high)
Python: Int BR_Win32_MAKELPARAM(Int low, Int high)
Description:[BR] Equivalent to win32 API MAKELPARAM().
| Parameters: |
| integer low | - | |
| integer high | - | |
^ 
BR_Win32_MAKELRESULT(SWS)Functioncall:
C: int BR_Win32_MAKELRESULT(int low, int high)
EEL2: int extension_api("BR_Win32_MAKELRESULT", int low, int high)
Lua: integer = reaper.BR_Win32_MAKELRESULT(integer low, integer high)
Python: Int BR_Win32_MAKELRESULT(Int low, Int high)
Description:[BR] Equivalent to win32 API MAKELRESULT().
| Parameters: |
| integer low | - | |
| integer high | - | |
^ 
BR_Win32_MAKEWORD(SWS)Functioncall:
C: int BR_Win32_MAKEWORD(int low, int high)
EEL2: int extension_api("BR_Win32_MAKEWORD", int low, int high)
Lua: integer = reaper.BR_Win32_MAKEWORD(integer low, integer high)
Python: Int BR_Win32_MAKEWORD(Int low, Int high)
Description:[BR] Equivalent to win32 API MAKEWORD().
| Parameters: |
| integer low | - | |
| integer high | - | |
^ 
BR_Win32_MAKEWPARAM(SWS)Functioncall:
C: int BR_Win32_MAKEWPARAM(int low, int high)
EEL2: int extension_api("BR_Win32_MAKEWPARAM", int low, int high)
Lua: integer = reaper.BR_Win32_MAKEWPARAM(integer low, integer high)
Python: Int BR_Win32_MAKEWPARAM(Int low, Int high)
Description:[BR] Equivalent to win32 API MAKEWPARAM().
| Parameters: |
| integer low | - | |
| integer high | - | |
^ 
BR_Win32_MIDIEditor_GetActive(SWS)Functioncall:
C: void* BR_Win32_MIDIEditor_GetActive()
EEL2: void* extension_api("BR_Win32_MIDIEditor_GetActive")
Lua: identifier = reaper.BR_Win32_MIDIEditor_GetActive()
Python: void BR_Win32_MIDIEditor_GetActive()
Description:[BR] Alternative to
MIDIEditor_GetActive. REAPER seems to have problems with extensions using HWND type for exported functions so all BR_Win32 functions use void* instead of HWND type.
| Returnvalues: |
| identifier | - |
|
^ 
BR_Win32_ScreenToClient(SWS)Functioncall:
C: void BR_Win32_ScreenToClient(void* hwnd, int xIn, int yIn, int* xOut, int* yOut)
EEL2: extension_api("BR_Win32_ScreenToClient", void* hwnd, int xIn, int yIn, int &x, int &y)
Lua: number x, number y = reaper.BR_Win32_ScreenToClient(identifier hwnd, integer xIn, integer yIn)
Python: (void hwnd, Int xIn, Int yIn, Int xOut, Int yOut) = BR_Win32_ScreenToClient(hwnd, xIn, yIn, xOut, yOut)
Description:[BR] Equivalent to win32 API ClientToScreen().
| Parameters: |
| identifier hwnd | - | |
| integer xIn | - | |
| integer yIn | - | |
| Returnvalues: |
| number x | - | |
| number y | - | |
^ 
BR_Win32_SendMessage(SWS)Functioncall:
C: int BR_Win32_SendMessage(void* hwnd, int msg, int lParam, int wParam)
EEL2: int extension_api("BR_Win32_SendMessage", void* hwnd, int msg, int lParam, int wParam)
Lua: integer = reaper.BR_Win32_SendMessage(identifier hwnd, integer msg, integer lParam, integer wParam)
Python: Int BR_Win32_SendMessage(void hwnd, Int msg, Int lParam, Int wParam)
Description:[BR] Equivalent to win32 API SendMessage().
| Parameters: |
| identifier hwnd | - | |
| integer msg | - | |
| integer lParam | - | |
| integer wParam | - | |
^ 
BR_Win32_SetFocus(SWS)Functioncall:
C: void* BR_Win32_SetFocus(void* hwnd)
EEL2: void* extension_api("BR_Win32_SetFocus", void* hwnd)
Lua: identifier = reaper.BR_Win32_SetFocus(identifier hwnd)
Python: void BR_Win32_SetFocus(void hwnd)
Description:[BR] Equivalent to win32 API SetFocus().
| Parameters: |
| identifier hwnd | - | |
| Returnvalues: |
| identifier | - | |
^ 
BR_Win32_SetForegroundWindow(SWS)Functioncall:
C: int BR_Win32_SetForegroundWindow(void* hwnd)
EEL2: int extension_api("BR_Win32_SetForegroundWindow", void* hwnd)
Lua: integer = reaper.BR_Win32_SetForegroundWindow(identifier hwnd)
Python: Int BR_Win32_SetForegroundWindow(void hwnd)
Description:[BR] Equivalent to win32 API SetForegroundWindow().
| Parameters: |
| identifier hwnd | - | |
^ 
BR_Win32_SetWindowLong(SWS)Functioncall:
C: int BR_Win32_SetWindowLong(void* hwnd, int index, int newLong)
EEL2: int extension_api("BR_Win32_SetWindowLong", void* hwnd, int index, int newLong)
Lua: integer = reaper.BR_Win32_SetWindowLong(identifier hwnd, integer index, integer newLong)
Python: Int BR_Win32_SetWindowLong(void hwnd, Int index, Int newLong)
Description:[BR] Equivalent to win32 API SetWindowLong().
| Parameters: |
| identifier hwnd | - | |
| integer index | - | |
| integer newLong | - | |
^ 
BR_Win32_SetWindowPos(SWS)Functioncall:
C: bool BR_Win32_SetWindowPos(void* hwnd, const char* hwndInsertAfter, int x, int y, int width, int height, int flags)
EEL2: bool extension_api("BR_Win32_SetWindowPos", void* hwnd, "hwndInsertAfter", int x, int y, int width, int height, int flags)
Lua: boolean = reaper.BR_Win32_SetWindowPos(identifier hwnd, string hwndInsertAfter, integer x, integer y, integer width, integer height, integer flags)
Python: Boolean BR_Win32_SetWindowPos(void hwnd, String hwndInsertAfter, Int x, Int y, Int width, Int height, Int flags)
Description:[BR] Equivalent to win32 API SetWindowPos().
hwndInsertAfter may be a string: "HWND_BOTTOM", "HWND_NOTOPMOST", "HWND_TOP", "HWND_TOPMOST" or a string obtained with
BR_Win32_HwndToString.
| Parameters: |
| identifier hwnd | - |
|
| string hwndInsertAfter | - |
|
| integer x | - |
|
| integer y | - |
|
| integer width | - |
|
| integer height | - |
|
| integer flags | - |
|
^ 
BR_Win32_ShowWindow(SWS)Functioncall:
C: bool BR_Win32_ShowWindow(void* hwnd, int cmdShow)
EEL2: bool extension_api("BR_Win32_ShowWindow", void* hwnd, int cmdShow)
Lua: boolean = reaper.BR_Win32_ShowWindow(identifier hwnd, integer cmdShow)
Python: Boolean BR_Win32_ShowWindow(void hwnd, Int cmdShow)
Description:[BR] Equivalent to win32 API ShowWindow().
| Parameters: |
| identifier hwnd | - | |
| integer cmdShow | - | |
^ 
BR_Win32_StringToHwnd(SWS)Functioncall:
C: void* BR_Win32_StringToHwnd(const char* string)
EEL2: void* extension_api("BR_Win32_StringToHwnd", "string")
Lua: identifier = reaper.BR_Win32_StringToHwnd(string string)
Python: void BR_Win32_StringToHwnd(String string)
Description:
| Parameters: |
| string string | - |
|
| Returnvalues: |
| identifier | - |
|
^ 
BR_Win32_WindowFromPoint(SWS)Functioncall:
C: void* BR_Win32_WindowFromPoint(int x, int y)
EEL2: void* extension_api("BR_Win32_WindowFromPoint", int x, int y)
Lua: identifier = reaper.BR_Win32_WindowFromPoint(integer x, integer y)
Python: void BR_Win32_WindowFromPoint(Int x, Int y)
Description:[BR] Equivalent to win32 API WindowFromPoint().
| Parameters: |
| integer x | - | |
| integer y | - | |
| Returnvalues: |
| identifier | - | |
^ 
CF_EnumMediaSourceCues(SWS)Functioncall:
C: int CF_EnumMediaSourceCues(PCM_source* src, int index, double* timeOut, double* endTimeOut, bool* isRegionOut, char* nameOut, int nameOut_sz)
EEL2: int extension_api("CF_EnumMediaSourceCues", PCM_source src, int index, &time, &endTime, bool &isRegion, #name)
Lua: integer retval, number time, number endTime, boolean isRegion, string name = reaper.CF_EnumMediaSourceCues(PCM_source src, integer index)
Python: (Int retval, PCM_source src, Int index, Float timeOut, Float endTimeOut, Boolean isRegionOut, String nameOut, Int nameOut_sz) = CF_EnumMediaSourceCues(src, index, timeOut, endTimeOut, isRegionOut, nameOut, nameOut_sz)
Description:Enumerate the source's media cues. Returns the next index or 0 when finished.
| Parameters: |
| PCM_source src | - | |
| integer index | - | |
| Returnvalues: |
| integer retval | - | |
| number time | - | |
| number endTime | - | |
| boolean isRegion | - | |
| string name | - | |
^ 
CF_EnumSelectedFX(SWS)Functioncall:
C: int CF_EnumSelectedFX(FxChain* hwnd, int index)
EEL2: int extension_api("CF_EnumSelectedFX", FxChain hwnd, int index)
Lua: integer = reaper.CF_EnumSelectedFX(FxChain hwnd, integer index)
Python: Int CF_EnumSelectedFX(FxChain hwnd, Int index)
Description:Return the index of the next selected effect in the given FX chain. Start index should be -1. Returns -1 if there are no more selected effects.
| Parameters: |
| FxChain hwnd | - | |
| integer index | - | |
^ 
CF_EnumerateActions(SWS)Functioncall:
C: int CF_EnumerateActions(int section, int index, char* nameOut, int nameOut_sz)
EEL2: int extension_api("CF_EnumerateActions", int section, int index, #name)
Lua: integer retval, string name = reaper.CF_EnumerateActions(integer section, integer index)
Python: (Int retval, Int section, Int index, String nameOut, Int nameOut_sz) = CF_EnumerateActions(section, index, nameOut, nameOut_sz)
Description:Wrapper for the unexposed kbd_enumerateActions API function.
Main=0, Main (alt recording)=100, MIDI Editor=32060, MIDI Event List Editor=32061, MIDI Inline Editor=32062, Media Explorer=32063
| Parameters: |
| integer section | - | |
| integer index | - | |
| Returnvalues: |
| integer retval | - | |
| string name | - | |
^ 
CF_ExportMediaSource(SWS)Functioncall:
C: bool CF_ExportMediaSource(PCM_source* src, const char* fn)
EEL2: bool extension_api("CF_ExportMediaSource", PCM_source src, "fn")
Lua: boolean = reaper.CF_ExportMediaSource(PCM_source src, string fn)
Python: Boolean CF_ExportMediaSource(PCM_source src, String fn)
Description:Export the source to the given file (MIDI only).
| Parameters: |
| PCM_source src | - | |
| string fn | - | |
^ 
CF_GetCommandText(SWS)Functioncall:
C: const char* CF_GetCommandText(int section, int command)
EEL2: bool extension_api("CF_GetCommandText", #retval, int section, int command)
Lua: string = reaper.CF_GetCommandText(integer section, integer command)
Python: String CF_GetCommandText(Int section, Int command)
Description:Wrapper for the unexposed kbd_getTextFromCmd API function. See
CF_EnumerateActions for common section IDs.
| Parameters: |
| integer section | - |
|
| integer command | - |
|
^ 
CF_GetFocusedFXChain(SWS)Functioncall:
C: FxChain* CF_GetFocusedFXChain()
EEL2: FxChain extension_api("CF_GetFocusedFXChain")
Lua: FxChain = reaper.CF_GetFocusedFXChain()
Python: FxChain CF_GetFocusedFXChain()
Description:Return a handle to the currently focused FX chain window.
^ 
CF_GetMediaSourceBitDepth(SWS)Functioncall:
C: int CF_GetMediaSourceBitDepth(PCM_source* src)
EEL2: int extension_api("CF_GetMediaSourceBitDepth", PCM_source src)
Lua: integer = reaper.CF_GetMediaSourceBitDepth(PCM_source src)
Python: Int CF_GetMediaSourceBitDepth(PCM_source src)
Description:Returns the bit depth if available (0 otherwise).
| Parameters: |
| PCM_source src | - | |
^ 
CF_GetMediaSourceMetadata(SWS)Functioncall:
C: bool CF_GetMediaSourceMetadata(PCM_source* src, const char* name, char* out, int out_sz)
EEL2: bool extension_api("CF_GetMediaSourceMetadata", PCM_source src, "name", #out)
Lua: boolean retval, string out = reaper.CF_GetMediaSourceMetadata(PCM_source src, string name, string out)
Python: (Boolean retval, PCM_source src, String name, String out, Int out_sz) = CF_GetMediaSourceMetadata(src, name, out, out_sz)
Description:Get the value of the given metadata field (eg. DESC, ORIG, ORIGREF, DATE, TIME, UMI, CODINGHISTORY for BWF).
| Parameters: |
| PCM_source src | - | |
| string name | - | |
| string out | - | |
| Returnvalues: |
| boolean retval | - | |
| string out | - | |
^ 
CF_GetMediaSourceOnline(SWS)Functioncall:
C: bool CF_GetMediaSourceOnline(PCM_source* src)
EEL2: bool extension_api("CF_GetMediaSourceOnline", PCM_source src)
Lua: boolean = reaper.CF_GetMediaSourceOnline(PCM_source src)
Python: Boolean CF_GetMediaSourceOnline(PCM_source src)
Description:Returns the online/offline status of the given source.
| Parameters: |
| PCM_source src | - | |
^ 
CF_GetMediaSourceRPP(SWS)Functioncall:
C: bool CF_GetMediaSourceRPP(PCM_source* src, char* fnOut, int fnOut_sz)
EEL2: bool extension_api("CF_GetMediaSourceRPP", PCM_source src, #fn)
Lua: boolean retval, string fn = reaper.CF_GetMediaSourceRPP(PCM_source src)
Python: (Boolean retval, PCM_source src, String fnOut, Int fnOut_sz) = CF_GetMediaSourceRPP(src, fnOut, fnOut_sz)
Description:Get the project associated with this source (BWF, subproject...).
| Parameters: |
| PCM_source src | - | |
| Returnvalues: |
| boolean retval | - | |
| string fn | - | |
^ 
CF_GetSWSVersion(SWS)Functioncall:
C: void CF_GetSWSVersion(char* versionOut, int versionOut_sz)
EEL2: extension_api("CF_GetSWSVersion", #version)
Lua: string version = reaper.CF_GetSWSVersion()
Python: (String versionOut, Int versionOut_sz) = CF_GetSWSVersion(versionOut, versionOut_sz)
Description:Return the current SWS version number.
| Returnvalues: |
| string version | - | |
^ 
CF_GetTakeFXChain(SWS)Functioncall:
C: FxChain* CF_GetTakeFXChain(MediaItem_Take* take)
EEL2: FxChain extension_api("CF_GetTakeFXChain", MediaItem_Take take)
Lua: FxChain = reaper.CF_GetTakeFXChain(MediaItem_Take take)
Python: FxChain CF_GetTakeFXChain(MediaItem_Take take)
Description:Return a handle to the given take FX chain window. HACK: This temporarily renames the take in order to disambiguate the take FX chain window from similarily named takes.
| Parameters: |
| MediaItem_Take take | - | |
^ 
CF_GetTrackFXChain(SWS)Functioncall:
C: FxChain* CF_GetTrackFXChain(MediaTrack* track)
EEL2: FxChain extension_api("CF_GetTrackFXChain", MediaTrack track)
Lua: FxChain = reaper.CF_GetTrackFXChain(MediaTrack track)
Python: FxChain CF_GetTrackFXChain(MediaTrack track)
Description:Return a handle to the given track FX chain window.
| Parameters: |
| MediaTrack track | - | |
^ 
CF_LocateInExplorer(SWS)Functioncall:
C: bool CF_LocateInExplorer(const char* file)
EEL2: bool extension_api("CF_LocateInExplorer", "file")
Lua: boolean = reaper.CF_LocateInExplorer(string file)
Python: Boolean CF_LocateInExplorer(String file)
Description:Select the given file in explorer/finder.
| Parameters: |
| string file | - | |
^ 
CF_SelectTrackFX(SWS)Functioncall:
C: bool CF_SelectTrackFX(MediaTrack* track, int index)
EEL2: bool extension_api("CF_SelectTrackFX", MediaTrack track, int index)
Lua: boolean = reaper.CF_SelectTrackFX(MediaTrack track, integer index)
Python: Boolean CF_SelectTrackFX(MediaTrack track, Int index)
Description:Set which track effect is active in the track's FX chain. The FX chain window does not have to be open.
| Parameters: |
| MediaTrack track | - | the track, of which you want to set an fx active |
| integer index | - | the index of the fx that shall be active |
^ 
CF_SelectTrackFX(SWS)Functioncall:
C: bool CF_SelectTrackFX(MediaTrack* track, int index)
EEL2: bool extension_api("CF_SelectTrackFX", MediaTrack track, int index)
Lua: boolean = reaper.CF_SelectTrackFX(MediaTrack track, integer index)
Python: Boolean CF_SelectTrackFX(MediaTrack track, Int index)
Description:Set which track effect is active in the track's FX chain. The FX chain window does not have to be open.
| Parameters: |
| MediaTrack track | - | the track, whose active trackfx you want to set |
| integer index | - | the index of the fx, which you want to activate |
| Returnvalues: |
| boolean | - | true, setting was successful; false, setting was unsuccessful |
^ 
CF_SetMediaSourceOnline(SWS)Functioncall:
C: void CF_SetMediaSourceOnline(PCM_source* src, bool set)
EEL2: extension_api("CF_SetMediaSourceOnline", PCM_source src, bool set)
Lua: reaper.CF_SetMediaSourceOnline(PCM_source src, boolean set)
Python: CF_SetMediaSourceOnline(PCM_source src, Boolean set)
Description:Set the online/offline status of the given source (closes files when set=false).
| Parameters: |
| PCM_source src | - | |
| boolean set | - | |
^ 
CF_ShellExecute(SWS)Functioncall:
C: bool CF_ShellExecute(const char* file)
EEL2: bool extension_api("CF_ShellExecute", "file")
Lua: boolean = reaper.CF_ShellExecute(string file)
Python: Boolean CF_ShellExecute(String file)
Description:
| Parameters: |
| string file | - |
|
^ 
NF_AnalyzeMediaItemPeakAndRMS(SWS)Functioncall:
C: bool NF_AnalyzeMediaItemPeakAndRMS(MediaItem* item, double windowSize, void* reaper.array_peaks, void* reaper.array_peakpositions, void* reaper.array_RMSs, void* reaper.array_RMSpositions)
EEL2: bool extension_api("NF_AnalyzeMediaItemPeakAndRMS", MediaItem item, windowSize, void* reaper.array_peaks, void* reaper.array_peakpositions, void* reaper.array_RMSs, void* reaper.array_RMSpositions)
Lua: boolean = reaper.NF_AnalyzeMediaItemPeakAndRMS(MediaItem item, number windowSize, identifier reaper.array_peaks, identifier reaper.array_peakpositions, identifier reaper.array_RMSs, identifier reaper.array_RMSpositions)
Python: Boolean NF_AnalyzeMediaItemPeakAndRMS(MediaItem item, Float windowSize, void reaper.array_peaks, void reaper.array_peakpositions, void reaper.array_RMSs, void reaper.array_RMSpositions)
Description:This function combines all other NF_Peak/RMS functions in a single one and additionally returns peak RMS positions.
Lua example code here.
Note: It's recommended to use this function with ReaScript/Lua as it provides reaper.array objects.
If using this function with other scripting languages, you must provide arrays in the
reaper.array format.
| Parameters: |
| MediaItem item | - |
|
| number windowSize | - |
|
| identifier reaper.array_peaks | - |
|
| identifier reaper.array_peakpositions | - |
|
| identifier reaper.array_RMSs | - |
|
| identifier reaper.array_RMSpositions | - |
|
^ 
NF_GetMediaItemMaxPeakAndMaxPeakPos(SWS)Functioncall:
C: double NF_GetMediaItemMaxPeakAndMaxPeakPos(MediaItem* item, double* maxPeakPosOut)
EEL2: double extension_api("NF_GetMediaItemMaxPeakAndMaxPeakPos", MediaItem item, &maxPeakPos)
Lua: number retval, number maxPeakPos = reaper.NF_GetMediaItemMaxPeakAndMaxPeakPos(MediaItem item)
Python: (Float retval, MediaItem item, Float maxPeakPosOut) = NF_GetMediaItemMaxPeakAndMaxPeakPos(item, maxPeakPosOut)
Description:
| Parameters: |
| MediaItem item | - |
|
| Returnvalues: |
| number retval | - |
|
| number maxPeakPos | - |
|
^ 
NF_GetSWSMarkerRegionSub(SWS)Functioncall:
C: const char* NF_GetSWSMarkerRegionSub(int markerRegionIdx)
EEL2: bool extension_api("NF_GetSWSMarkerRegionSub", #retval, int markerRegionIdx)
Lua: string = reaper.NF_GetSWSMarkerRegionSub(integer markerRegionIdx)
Python: String NF_GetSWSMarkerRegionSub(Int markerRegionIdx)
Description:Returns SWS/S&M marker/region subtitle. markerRegionIdx: Refers to index that can be passed to
EnumProjectMarkers (not displayed marker/region index).
Returns empty string if marker/region with specified index not found or marker/region subtitle not set.
Lua code example can be found here
| Parameters: |
| integer markerRegionIdx | - |
|
^ 
NF_GetSWSTrackNotes(SWS)Functioncall:
C: const char* NF_GetSWSTrackNotes(MediaTrack* track)
EEL2: bool extension_api("NF_GetSWSTrackNotes", #retval, MediaTrack track)
Lua: string tracknotes = reaper.NF_GetSWSTrackNotes(MediaTrack track)
Python: String NF_GetSWSTrackNotes(MediaTrack track)
Description:Get the SWS tracknotes.
| Parameters: |
| MediaTrack track | - | the track, whose SWS-tracknotes you want to get |
| Returnvalues: |
| string tracknotes | - | the stored notes |
^ 
NF_GetSWS_RMSoptions(SWS)Functioncall:
C: void NF_GetSWS_RMSoptions(double* targetOut, double* windowSizeOut)
EEL2: extension_api("NF_GetSWS_RMSoptions", &target, &windowSize)
Lua: number target, number windowSize = reaper.NF_GetSWS_RMSoptions()
Python: (Float targetOut, Float windowSizeOut) = NF_GetSWS_RMSoptions(targetOut, windowSizeOut)
Description:
| Returnvalues: |
| number target | - |
|
| number windowSize | - |
|
^ 
NF_SetSWSMarkerRegionSub(SWS)Functioncall:
C: bool NF_SetSWSMarkerRegionSub(const char* markerRegionSub, int markerRegionIdx)
EEL2: bool extension_api("NF_SetSWSMarkerRegionSub", "markerRegionSub", int markerRegionIdx)
Lua: boolean = reaper.NF_SetSWSMarkerRegionSub(string markerRegionSub, integer markerRegionIdx)
Python: Boolean NF_SetSWSMarkerRegionSub(String markerRegionSub, Int markerRegionIdx)
Description:Set SWS/S&M marker/region subtitle. markerRegionIdx: Refers to index that can be passed to
EnumProjectMarkers(not displayed marker/region index).
Returns true if subtitle is set successfully (i.e. marker/region with specified index is present in project).
Lua code example can be found here
| Parameters: |
| string markerRegionSub | - |
|
| integer markerRegionIdx | - |
|
^ 
NF_SetSWSTrackNotes(SWS)Functioncall:
C: void NF_SetSWSTrackNotes(MediaTrack* track, const char* str)
EEL2: extension_api("NF_SetSWSTrackNotes", MediaTrack track, "str")
Lua: reaper.NF_SetSWSTrackNotes(MediaTrack track, string str)
Python: NF_SetSWSTrackNotes(MediaTrack track, String str)
Description:
| Parameters: |
| MediaTrack track | - | |
| string str | - | |
^ 
NF_SetSWS_RMSoptions(SWS)Functioncall:
C: bool NF_SetSWS_RMSoptions(double targetLevel, double windowSize)
EEL2: bool extension_api("NF_SetSWS_RMSoptions", targetLevel, windowSize)
Lua: boolean retval = reaper.NF_SetSWS_RMSoptions(number targetLevel, number windowSize)
Python: Boolean NF_SetSWS_RMSoptions(Float targetLevel, Float windowSize)
Description:Set SWS analysis/normalize options (same as running action 'SWS: Set RMS analysis/normalize options'). targetLevel: target RMS normalize level (dB), windowSize: window size for peak RMS (sec.)
See
NF_GetSWS_RMSoptions.
| Parameters: |
| number targetLevel | - |
|
| number windowSize | - |
|
| Returnvalues: |
| boolean retval | - |
|
^ 
NF_TakeFX_GetModuleName(SWS)Functioncall:
C: bool NF_TakeFX_GetModuleName(MediaItem* item, int fx, char* nameOut, int nameOutSz)
EEL2: bool extension_api("NF_TakeFX_GetModuleName", MediaItem item, int fx, # name, int name)
Lua: boolean retval, string name = reaper.NF_TakeFX_GetModuleName(MediaItem item, integer fx)
Python: (Boolean retval, MediaItem item, Int fx, String nameOut, Int nameOutSz) = NF_TakeFX_GetModuleName(item, fx, nameOut, nameOutSz)
Description:Deprecated.
Retrieves the name of the module of a takefx from a MediaItem.
See
BR_TrackFX_GetFXModuleName. fx: counted consecutively across all takes (zero-based).
| Parameters: |
| MediaItem item | - | the MediaItem, whose modulename of an effect you want to receive
|
| integer fx | - | the index of the fx(with 0 for the first), whose modulename you want to receive
|
| Returnvalues: |
| boolean retval | - | true, modulename could be retrieved; false, modulename couldn't be retrieved(e.g. no such fx)
|
| string name | - | the name of the module
|
^ 
NF_UpdateSWSMarkerRegionSubWindow(SWS)Functioncall:
C: void NF_UpdateSWSMarkerRegionSubWindow()
EEL2: extension_api("NF_UpdateSWSMarkerRegionSubWindow")
Lua: reaper.NF_UpdateSWSMarkerRegionSubWindow()
Python: NF_UpdateSWSMarkerRegionSubWindow()
Description:Redraw the Notes window (call if you've changed a subtitle via
NF_SetSWSMarkerRegionSub which is currently displayed in the Notes window and you want to appear the new subtitle immediately.)
^ 
NF_Win32_GetSystemMetrics(SWS)Functioncall:
C: int NF_Win32_GetSystemMetrics(int nIndex)
EEL2: int extension_api("NF_Win32_GetSystemMetrics", int nIndex)
Lua: integer retval = reaper.NF_Win32_GetSystemMetrics(integer nIndex)
Python: Int NF_Win32_GetSystemMetrics(Int nIndex)
Description:
| Parameters: |
| integer nIndex | - | the value to query, i.e.: 5, width of window-borders 7, thickness of a frame around the perimeter of a window with caption but not resizeable 10, width of "thumb box" in a horizontal scroll bar 11, default icon width 13, width of the cursor in pixels 16, x-width of fullscreen 21, width of arrow of the horizontal-scrollbar 36, width of the rectangle, within double-clicks are detected 43, number of mousebuttons or zero, if no mouse is installed 45, width of a 3d-border 56, flags how system arranges minimized windows 67, (0, normal boot; 1, Fail-safe boot; 2, Fail-safe with network boot) 68, the width of the area, that detects a mouse-drag 80, number of display monitors 83, width of left and right edges of focus rectangle drawn by DrawFocusRect-Win32-function 0x2003, slate state of laptop; 0, slate mode; non-zero, otherwise etc.
|
| Returnvalues: |
| integer retval | - | the returned value
|
^
absFunctioncall:
Description:Returns the absolute value of the parameter.
^
acosFunctioncall:
Description:Returns the arc cosine of the value specified (return value is in radians). If the parameter is not between -1.0 and 1.0 inclusive, the return value is undefined.
^
asinFunctioncall:
Description:Returns the arc sine of the value specified (return value is in radians). If the parameter is not between -1.0 and 1.0 inclusive, the return value is undefined.
^
atanFunctioncall:
Description:Returns the arc tangent of the value specified (return value is in radians). If the parameter is not between -1.0 and 1.0 inclusive, the return value is undefined.
^
atan2Functioncall:
EEL2: atan2(numerator,denominator)
Description:Returns the arc tangent of the numerator divided by the denominator, allowing the denominator to be 0, and using their signs to produce a more meaningful result.
| Parameters: |
| numerator | - | |
| denominator | - | |
^
atexitFunctioncall:
Description:Adds code to be executed when the script finishes or is ended by the user. Typically used to clean up after the user terminates defer() or runloop() code.
^
ceilFunctioncall:
Description:Returns the value rounded to the next highest integer (ceil(3.1)==4, ceil(-3.9)==-3).
^
convolve_cFunctioncall:
EEL2: convolve_c(dest,src,size)
Description:Multiplies each of size complex pairs in dest by the complex pairs in src. Often used for convolution.
| Parameters: |
| dest | - | |
| src | - | |
| size | - | |
^
cosFunctioncall:
Description:Returns the cosine of the angle specified (specified in radians).
^
deferFunctioncall:
EEL2: defer(string "code")
Description:Adds code to be called back by REAPER. Used to create persistent ReaScripts that continue to run and respond to input, while the user does other tasks. Identical to runloop().
Note that no undo point will be automatically created when the script finishes, unless you create it explicitly.
Each function called by defer can only be deferred once per defer-cycle(unlike in Lua, where you can have one function deferred multiple times).
Unlike "normal" loops, defer allows looped code to run in the background without blocking Reaper's user interface.
That way, scripts, who need longer time to run, can be made possible.
Example:
the following example allows adding a to variable A with each defer-cycle.
function main()(
A=A+1;
defer("main()");
);
main();
| Parameters: |
| string code | - | the code to be run. You can also add a regular functioncall into this string, like "main()", if there's a main-function in the script |
^
evalFunctioncall:
Description:Executes code passed in. Code can use functions, but functions created in code can't be used elsewhere.
^
expFunctioncall:
Description:Returns the number e ($e, approximately 2.718) raised to the parameter-th power. This function is significantly faster than pow() or the ^ operator.
^
extension_apiFunctioncall:
EEL2: extension_api(function_name[,...])
Description:Used to call functions exported by extension plugins. The first parameter must be the exported function name, then its own parameters (as if the function was called directly).
| Parameters: |
| functionname | - | |
^
fcloseFunctioncall:
Description:Closes a file previously opened with fopen().
^
feofFunctioncall:
Description:Returns nonzero if the file fp is at the end of file.
^
fflushFunctioncall:
Description:If file fp is open for writing, flushes out any buffered data to disk.
^
fftFunctioncall:
Description:Performs a FFT on the data in the local memory buffer at the offset specified by the first parameter. The size of the FFT is specified by the second parameter, which must be 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, or 32768. The outputs are permuted, so if you plan to use them in-order, call fft_permute(buffer, size) before and fft_ipermute(buffer,size) after your in-order use. Your inputs or outputs will need to be scaled down by 1/size, if used.
Note that fft()/ifft() require real / imaginary input pairs, so a 256 point FFT actually works with 512 items.
Note that fft()/ifft() must NOT cross a 65,536 item boundary, so be sure to specify the offset accordingly.
| Parameters: |
| buffer | - | |
| size | - | |
^
fft_ipermuteFunctioncall:
EEL2: fft_ipermute(buffer,size)
Description:Permute the input for ifft(), taking bands from in-order to the order ifft() requires. See
fft() for more information.
| Parameters: |
| buffer | - |
|
| size | - |
|
^
fft_permuteFunctioncall:
EEL2: fft_permute(buffer,size)
Description:Permute the output of fft() to have bands in-order. See
fft() for more information.
| Parameters: |
| buffer | - |
|
| size | - |
|
^
fft_realFunctioncall:
EEL2: fft_real(buffer,size)
Description:Performs an FFT, but takes size input samples and produces size/2 complex output pairs. Usually used along with fft_permute(size/2). Inputs/outputs will need to be scaled by 0.5/size.
| Parameters: |
| buffer | - | |
| size | - | |
^
fgetcFunctioncall:
Description:Reads a character from file fp, returns -1 if EOF.
^
fgetsFunctioncall:
Description:Reads a line from file fp into #str. Returns length of #str read.
^
floorFunctioncall:
Description:Returns the value rounded to the next lowest integer (floor(3.9)==3, floor(-3.1)==-4).
^
fopenFunctioncall:
Description:Opens a file "fn" with mode "mode". For read, use "r" or "rb", write "w" or "wb". Returns a positive integer on success.
^
fprintfFunctioncall:
EEL2: fprintf(fp,format[,...])
Description:Formats a string and writes it to file fp. For more information on format specifiers, see
sprintf(). Returns bytes written to file.
* %% = %
* %s = string from parameter
* %d = parameter as integer
* %i = parameter as integer
* %u = parameter as unsigned integer
* %x = parameter as hex (lowercase) integer
* %X = parameter as hex (uppercase) integer
* %c = parameter as character
* %f = parameter as floating point
* %e = parameter as floating point (scientific notation, lowercase)
* %E = parameter as floating point (scientific notation, uppercase)
* %g = parameter as floating point (shortest representation, lowercase)
* %G = parameter as floating point (shortest representation, uppercase)
Many standard C printf() modifiers can be used, including:
* %.10s = string, but only print up to 10 characters
* %-10s = string, left justified to 10 characters
* %10s = string, right justified to 10 characters
* %+f = floating point, always show sign
* %.4f = floating point, minimum of 4 digits after decimal point
* %10d = integer, minimum of 10 digits (space padded)
* %010f = integer, minimum of 10 digits (zero padded)
Values for format specifiers can be specified as additional parameters to fprintf, or within {} in the format specifier (such as %{varname}d, in that case a global variable is always used).
| Parameters: |
| fp | - |
|
| format | - |
|
^
freadFunctioncall:
EEL2: fread(fp,#str,length)
Description:Reads from file fp into #str, up to length bytes. Returns actual length read, or negative if error.
| Parameters: |
| fp | - | |
| #str | - | |
| length | - | |
^
freembufFunctioncall:
Description:Hints the runtime that memory above the address specified may no longer be used. The runtime may, at its leisure, choose to lose the contents of memory above the address specified.
^
fseekFunctioncall:
EEL2: fseek(fp,offset,whence)
Description:Seeks file fp, offset bytes from whence reference. Whence negative specifies start of file, positive whence specifies end of file, and zero whence specifies current file position.
| Parameters: |
| fp | - | |
| offset | - | |
| whence | - | |
^
ftellFunctioncall:
Description:Returns the current file position.
^
fwriteFunctioncall:
EEL2: fwrite(fp,#str,len)
Description:Writes up to len characters of #str to file fp. If len is less than 1, the full contents of #str will be written. Returns the number of bytes written to file.
| Parameters: |
| fp | - | |
| #str | - | |
| len | - | |
^
get_action_contextFunctioncall:
EEL2: get_action_context(#filename,sectionID,cmdID,mode,resolution,val)
Description:Queries contextual information about the script, typically MIDI/OSC input values.
Returns true if a new value has been updated.
val will be set to a relative or absolute value depending on mode (=0: absolute mode, >0: relative modes). resolution=127 for 7-bit resolution, =16383 for 14-bit resolution.
Notes: sectionID, and cmdID will be set to -1 if the script is not part of the action list. mode, resolution and val will be set to -1 if the script was not triggered via MIDI/OSC.
For relative mode bindings, calling get_action_context() will return the accumulated relative value in decoded form (not 65 or 63, but +1/-1 etc), and clear the internal state. So if you call it multiple times, the first one will return the accumulated value, and the second will always return 0.
| Parameters: |
| #filename | - | |
| sectionID | - | |
| cmdID | - | |
| mode | - | |
| resolution | - | |
| val | - | |
^
gfx_variablesFunctioncall:
Description:The following global variables are special and will be used by the graphics system:
* gfx_r - current red component (0..1) used by drawing operations.
* gfx_g - current green component (0..1) used by drawing operations.
* gfx_b - current blue component (0..1) used by drawing operations.
* gfx_a2 - current alpha component (0..1) used by drawing operations when writing solid colors (normally ignored but useful when creating transparent images).
* gfx_a - alpha for drawing (1=normal).
* gfx_mode - blend mode for drawing. Set mode to 0 for default options. Add 1.0 for additive blend mode (if you wish to do subtractive, set gfx_a to negative and use gfx_mode as additive). Add 2.0 to disable source alpha for gfx_blit(). Add 4.0 to disable filtering for gfx_blit().
* gfx_w - width of the UI framebuffer.
* gfx_h - height of the UI framebuffer.
* gfx_x - current graphics position X. Some drawing functions use as start position and update.
* gfx_y - current graphics position Y. Some drawing functions use as start position and update.
* gfx_clear - if greater than -1.0, framebuffer will be cleared to that color. the color for this one is packed RGB (0..255), i.e. red+green*256+blue*65536. The default is 0 (black).
* gfx_dest - destination for drawing operations, -1 is main framebuffer, set to 0..1024-1 to have drawing operations go to an offscreen buffer (or loaded image).
* gfx_texth - the (READ-ONLY) height of a line of text in the current font. Do not modify this variable.
* gfx_ext_retina - to support hidpi/retina, callers should set to 1.0 on initialization, will be updated to 2.0 if high resolution display is supported, and if so gfx_w/gfx_h/etc will be doubled.
* mouse_x - current X coordinate of the mouse relative to the graphics window.
* mouse_y - current Y coordinate of the mouse relative to the graphics window.
* mouse_wheel - wheel position, will change typically by 120 or a multiple thereof, the caller should clear the state to 0 after reading it.
* mouse_hwheel - horizontal wheel positions, will change typically by 120 or a multiple thereof, the caller should clear the state to 0 after reading it.
* mouse_cap - a bitfield of mouse and keyboard modifier state:
1: left mouse button
2: right mouse button
4: Control key
8: Shift key
16: Alt key
32: Windows key
64: middle mouse button
Note: Mousebuttons will be returned after gfx_init(), the other keyboard-modifier only when using gfx_getchar()!
^
gfx_arcFunctioncall:
EEL2: gfx_arc(x,y,r,ang1,ang2[,antialias])
Description:Draws an arc of the circle centered at x,y, with ang1/ang2 being specified in radians.
| Parameters: |
| x | - | x position of the center of the circle |
| y | - | y position of the center of the circle |
| r | - | the radius of the circle |
| ang1 | - | the beginning of the circle in radians; meant for partial circles; 0-6.28 |
| ang2 | - | the end of the circle in radians; meant for partial circles; 0-6.28 |
| antialias | - | <=0.5, antialias off; >0.5, antialias on |
^
gfx_blitFunctioncall:
EEL2: gfx_blit(source, scale, rotation[, srcx, srcy, srcw, srch, destx, desty, destw, desth, rotxoffs, rotyoffs])
Description:srcx/srcy/srcw/srch specify the source rectangle (if omitted srcw/srch default to image size), destx/desty/destw/desth specify dest rectangle (if not specified, these will default to reasonable defaults -- destw/desth default to srcw/srch * scale).
| Parameters: |
| source | - | |
| scale | - | |
| rotation | - | |
| srcx | - | |
| srcy | - | |
| srcw | - | |
| srch | - | |
| destx | - | |
| desty | - | |
| destw | - | |
| desth | - | |
| rotxoffs | - | |
| rotyoffs | - | |
^
gfx_blitFunctioncall:
EEL2: gfx_blit(source,scale,rotation)
Description:If three parameters are specified, copies the entirity of the source bitmap to gfx_x,gfx_y using current opacity and copy mode (set with gfx_a, gfx_mode). You can specify scale (1.0 is unscaled) and rotation (0.0 is not rotated, angles are in radians).
For the "source" parameter specify -1 to use the main framebuffer as source, or an image index (see
gfx_loadimg().
| Parameters: |
| source | - |
|
| scale | - |
|
| rotation | - |
|
^
gfx_blitextFunctioncall:
EEL2: gfx_blitext(source,coordinatelist,rotation)
Description:Deprecated, use gfx_blit instead.
| Parameters: |
| source | - | |
| coordinatelist | - | |
| rotation | - | |
^
gfx_blurtoFunctioncall:
Description:Blurs the region of the screen between gfx_x,gfx_y and x,y, and updates gfx_x,gfx_y to x,y.
| Parameters: |
| x | - | x position of the other edge of the blur-region |
| y | - | y position of the other edge of the blur-region |
^
gfx_circleFunctioncall:
EEL2: gfx_circle(x,y,r[,fill,antialias])
Description:Draws a circle, optionally filling/antialiasing
| Parameters: |
| x | - | x position of center of the circle |
| y | - | y position of center of the circle |
| r | - | radius of the circle |
| fill | - | <=0.5, circle is not filled; >0.5, circle is filled |
| antialias | - | <=0.5, circle is not antialiased; >0.5, circle is antialiased |
^
gfx_clienttoscreenFunctioncall:
EEL2: gfx_clienttoscreen(x,y)
Description:Converts client coordinates x,y to screen coordinates.
| Parameters: |
| x | - | the x coordinate within(!) the gfx_init()-window, that shall be converted to screen-coordinates |
| y | - | the y coordinate within(!) the gfx_init()-window, that shall be converted to screen-coordinates |
^
gfx_deltablitFunctioncall:
EEL2: gfx_deltablit(srcimg,srcs,srct,srcw,srch,destx,desty,destw,desth,dsdx,dtdx,dsdy,dtdy,dsdxdy,dtdxdy[,usecliprect=1])
Description:Blits from srcimg(srcs,srct,srcw,srch) to destination (destx,desty,destw,desth). Source texture coordinates are s/t, dsdx represents the change in s coordinate for each x pixel, dtdy represents the change in t coordinate for each y pixel, etc. dsdxdy represents the change in dsdx for each line. If usecliprect is specified and 0, then srcw/srch are ignored.
This function allows you to manipulate the image, which you want to blit, by transforming, moving or cropping it.
To do rotation, you can manipulate dtdx and dsdy together.
| Parameters: |
| srcimg | - | image - the image to blit |
| srcs | - | positiondeltaX - the delta of the x-position of the image within the blitted area in pixels(useful default: 0) |
| srct | - | positiondeltaY - the delta of the y-position of the image within the blitted area in pixels(useful default: 0) |
| srcw | - | unknown - (useful default: 0) |
| srch | - | unknown - (useful default: 0) |
| destx | - | positiondeltaX - the delta of the x-position of the blitted area in pixels(useful default: 0) |
| desty | - | positiondeltaY - the delta of the y-position of the blitted area in pixels(useful default: 0) |
| destw | - | blitsizeX - the x-size of the blitted area in pixels; the deltaimage might be cropped, if it exceeds this size(useful default: width of the image) |
| desth | - | blitsizeY - the y-size of the blitted area in pixels; the deltaimage might be cropped, if it exceeds this size(useful default: height of the image) |
| dsdx | - | stretchfactorX, the lower, the more stretched is the image(minimum 0; 1 for full size); limited by blitsizeX(useful default: 1) |
| dtdx | - | deltaY: the delta of the right side of the image, related to the left side of the image; positive, right is moved up; negative, right is moved down; this delta is linear(useful default: 0) |
| dsdy | - | deltaX: the delta of the bottom side of the image, related to the top side of the image; positive, bottom is moved left; negative, bottom is moved right; this delta is linear(useful default: 0) |
| dtdy | - | stretchfactorY, the lower, the more stretched is the image(minimum 0; 1 for full size); limited by blitsizeY(useful default: 1) |
| dsdxdy | - | deltacurvedY: the delta of the right side of the image, related to the left side of the image; positive, right is moved up; negative, right is moved down; this delta "curves" the delta via a bezier(useful default: 0) |
| dtdxdy | - | deltacurvedX: the delta of the bottom side of the image, related to the top side of the image; positive, bottom is moved left; negative, bottom is moved right; this delta "curves" the delta via a bezier(useful default: 0) |
| usecliprect | - | can be set to 0 or 1(useful default: 0) |
^
gfx_dockFunctioncall:
EEL2: gfx_dock(v[,wx,wy,ww,wh])
Description:Call with v=-1 to query docked state, otherwise v>=0 to set docked state. State is &1 if docked, second byte is docker index (or last docker index if undocked). If wx-wh are specified, they will be filled with the undocked window position/size
| Parameters: |
| v | - | -1, query docking-state; 0 and higher, set state of the window to docked |
| wx | - | set to a number to query current-windowx-position |
| wy | - | set to a number to query current-windowy-position |
| ww | - | set to a number to query current-window-width |
| wh | - | set to a number to query current-window-height |
| Returnvalues: |
| querystate | - | 0 if not docked; &1 if docked; the byte &9 to &16 returns the docker-index |
| window_x_position | - | the x position of the window in pixels |
| window_y_position | - | the y position of the window in pixels |
| window_width | - | the width of the window in pixels |
| window_height | - | the height of the window in pixels |
^
gfx_drawcharFunctioncall:
Description:Draws the character (can be a numeric ASCII code as well), to gfx_x, gfx_y, and moves gfx_x over by the size of the character.
| Parameters: |
| char | - | the numeric ASCII-representation of the character to be drawn |
^
gfx_drawnumberFunctioncall:
EEL2: gfx_drawnumber(n,ndigits)
Description:Draws the number n with ndigits of precision to gfx_x, gfx_y, and updates gfx_x to the right side of the drawing. The text height is gfx_texth.
| Parameters: |
| n | - | |
| n digits | - | |
^
gfx_drawstrFunctioncall:
EEL2: gfx_drawstr(str[,flags,right,bottom])
Description:Draws a string at gfx_x, gfx_y, and updates gfx_x/gfx_y so that subsequent draws will occur in a similar place.
* If flags, right ,bottom passed in:
* flags&1: center horizontally
* flags&2: right justify
* flags&4: center vertically
* flags&8: bottom justify
* flags&256: ignore right/bottom, otherwise text is clipped to (gfx_x, gfx_y, right, bottom)
| Parameters: |
| str | - |
|
| flags | - |
|
| right | - |
|
| bottom | - |
|
^
gfx_getcharFunctioncall:
EEL2: gfx_getchar([char])
Description:If char is 0 or omitted, returns a character from the keyboard queue, or 0 if no character is available, or -1 if the graphics window is not open. If char is specified and nonzero, that character's status will be checked, and the function will return greater than 0 if it is pressed.
Common values are standard ASCII, such as 'a', 'A', '=' and '1', but for many keys multi-byte values are used, including 'home', 'up', 'down', 'left', 'rght', 'f1'.. 'f12', 'pgup', 'pgdn', 'ins', and 'del'.
Shortcuts with scope "Global + textfields" will still run the associated action, scope of "Normal" or "Global" will not.
Modified and special keys can also be returned, including:
* Ctrl/Cmd+A..Ctrl+Z as 1..26
* Ctrl/Cmd+Alt+A..Z as 257..282
* Alt+A..Z as 'A'+256..'Z'+256
* 27 for ESC
* 13 for Enter
* ' ' for space
^
gfx_getfontFunctioncall:
EEL2: gfx_getfont([#str])
Description:Returns current font index. If a string is passed, it will receive the actual font face used by this font, if available.
^
gfx_getimgdimFunctioncall:
EEL2: gfx_getimgdim(image,w,h)
Description:Retrieves the dimensions of image (representing a filename: index number) into w and h. Sets these values to 0 if an image failed loading (or if the filename index is invalid).
^
gfx_getpixelFunctioncall:
EEL2: gfx_getpixel(r,g,b)
Description:Gets the value of the pixel at gfx_x,gfx_y into r,g,b.
| Returnvalues: |
| r | - | the red-color-value, a value between 0 to 1 |
| g | - | the green-color-value, a value between 0 to 1 |
| b | - | the blue-color-value, a value between 0 to 1 |
^
gfx_gradrectFunctioncall:
EEL2: gfx_gradrect(x,y,w,h, r,g,b,a[, drdx, dgdx, dbdx, dadx, drdy, dgdy, dbdy, dady])
Description:Fills a gradient rectangle with the color and alpha specified. drdx-dadx reflect the adjustment (per-pixel) applied for each pixel moved to the right, drdy-dady are the adjustment applied for each pixel moved toward the bottom. Normally drdx=adjustamount/w, drdy=adjustamount/h, etc.
| Parameters: |
| x | - | |
| y | - | |
| w | - | |
| h | - | |
| r | - | |
| g | - | |
| b | - | |
| a | - | |
| drdx | - | |
| dgdx | - | |
| dbdx | - | |
| dadx | - | |
| drdy | - | |
| dgdy | - | |
| dbdy | - | |
| dady | - | |
^
gfx_initFunctioncall:
EEL2: gfx_init(name[,width,height,dockstate,xpos,ypos])
Description:Initializes the graphics window with title name. Suggested width and height can be specified.
Once the graphics window is open,
gfx_update() should be called periodically.
To resizes/reposition the window, call gfx_init again and pass an empty string as name-parameter.
To get the current window-states, dimensions, etc, you can use
gfx_dock.
^
gfx_lineFunctioncall:
EEL2: gfx_line(x,y,x2,y2[,aa])
Description:Draws a line from x,y to x2,y2, and if aa is not specified or 0.5 or greater, it will be antialiased.
| Parameters: |
| x | - | |
| y | - | |
| x2 | - | |
| y2 | - | |
| aa | - | |
^
gfx_linetoFunctioncall:
EEL2: gfx_lineto(x,y[,aa])
Description:Draws a line from gfx_x,gfx_y to x,y. If aa is 0.5 or greater, then antialiasing is used. Updates gfx_x and gfx_y to x,y.
^
gfx_loadimgFunctioncall:
EEL2: gfx_loadimg(image,filename)
Description:Load image from filename into slot 0..1024-1 specified by image. Returns the image index if success, otherwise -1 if failure. The image will be resized to the dimensions of the image file.
| Parameters: |
| image | - | |
| filename | - | |
^
gfx_measurecharFunctioncall:
EEL2: gfx_measurechar(character,&w,&h)
Description:Measures the drawing dimensions of a character with the current font (as set by
gfx.setfont). Returns width and height of character.
| Parameters: |
| character | - | a character, whose dimensions you want to know
|
| w | - | the width of this character
|
| h | - | the height if this character
|
^
gfx_measurestrFunctioncall:
EEL2: gfx_measurestr(str,&w,&h)
Description:Measures the drawing dimensions of a string with the current font (as set by gfx_setfont).
| Parameters: |
| str | - | |
| w | - | |
| h | - | |
^
gfx_muladdrectFunctioncall:
EEL2: gfx_muladdrect(x,y,w,h,mul_r,mul_g,mul_b[,mul_a,add_r,add_g,add_b,add_a])
Description:Multiplies each pixel by mul_* and adds add_*, and updates in-place. Useful for changing brightness/contrast, or other effects.
| Parameters: |
| x | - | |
| y | - | |
| w | - | |
| h | - | |
| mul_r | - | |
| mul_g | - | |
| mul_b | - | |
| mul_a | - | |
| add_r | - | |
| add_g | - | |
| add_b | - | |
| add_a | - | |
^
gfx_printfFunctioncall:
EEL2: gfx_printf(format[, ...])
Description:Formats and draws a string at gfx_x, gfx_y, and updates gfx_x/gfx_y accordingly (the latter only if the formatted string contains newline). For more information on format strings, see
sprintf() * %% = %
* %s = string from parameter
* %d = parameter as integer
* %i = parameter as integer
* %u = parameter as unsigned integer
* %x = parameter as hex (lowercase) integer
* %X = parameter as hex (uppercase) integer
* %c = parameter as character
* %f = parameter as floating point
* %e = parameter as floating point (scientific notation, lowercase)
* %E = parameter as floating point (scientific notation, uppercase)
* %g = parameter as floating point (shortest representation, lowercase)
* %G = parameter as floating point (shortest representation, uppercase)
Many standard C printf() modifiers can be used, including:
* %.10s = string, but only print up to 10 characters
* %-10s = string, left justified to 10 characters
* %10s = string, right justified to 10 characters
* %+f = floating point, always show sign
* %.4f = floating point, minimum of 4 digits after decimal point
* %10d = integer, minimum of 10 digits (space padded)
* %010f = integer, minimum of 10 digits (zero padded)
Values for format specifiers can be specified as additional parameters to gfx_printf, or within {} in the format specifier (such as %{varname}d, in that case a global variable is always used).
^
gfx_quitFunctioncall:
Description:Closes the graphics window.
^
gfx_rectFunctioncall:
EEL2: gfx_rect(x,y,w,h[,filled])
Description:Fills a rectangle at x,y,w,h pixels in dimension, filled by default.
| Parameters: |
| x | - | |
| y | - | |
| w | - | |
| h | - | |
| filled | - | |
^
gfx_recttoFunctioncall:
Description:Fills a rectangle from gfx_x,gfx_y to x,y. Updates gfx_x,gfx_y to x,y.
^
gfx_roundrectFunctioncall:
EEL2: gfx_roundrect(x,y,w,h,radius[,antialias])
Description:Draws a rectangle with rounded corners.
| Parameters: |
| x | - | |
| y | - | |
| w | - | |
| h | - | |
| radius | - | |
| antialias | - | |
^
gfx_screentoclientFunctioncall:
EEL2: gfx_screentoclient(x,y)
Description:Converts screen coordinates x,y to client coordinates.
^
gfx_setFunctioncall:
EEL2: gfx_set(r[,g,b,a2,mode,dest])
Description:Sets gfx_r/gfx_g/gfx_b/gfx_a2/gfx_mode, sets gfx_dest if final parameter specified
| Parameters: |
| r | - | |
| g | - | |
| b | - | |
| a | - | |
| mode | - | |
| dest | - | |
^
gfx_setcursorFunctioncall:
EEL2: gfx_setcursor(resource_id,custom_cursor_name)
Description:Sets the mouse cursor. resource_id is a value like 32512 (for an arrow cursor), custom_cursor_name is a string like "arrow" (for the REAPER custom arrow cursor). resource_id must be nonzero, but custom_cursor_name is optional.
| Parameters: |
| resource_id | - | |
| custom_cursor_name | - | |
^
eel_getdropfileFunctioncall:
EEL2: integer retval = gfx_getdropfile(integer idx[, string #filename])
Description:Returns filenames, drag'n'dropped into a window created by gfx_init().
Use idx to get a specific filename, that has been dropped into the gfx_init()-window.
Does NOT support mediaitems/takes or other Reaper-objects!
It MUST be called BEFORE calling gfx_update, as gfx_update flushes the filelist accessible with gfx_getdropfile.
| Parameters: |
| integer idx | - | the indexnumber for a filename, that has been dropped into a gfx_init()-window. 0, the first file; 1, the second file; 2, the third file, etc. -1, clears the filelist. |
| Returnvalues: |
| integer retval | - | 0, if droppped-filename with indexnumber idx doesn't exist; 1, if it exists; hints, if you already read all dropped filenames. |
| string filename | - | the filename of dropped-file with indexnumber idx |
^
gfx_setfontFunctioncall:
EEL2: gfx_setfont(idx[,fontface, sz, flags])
Description:Can select a font and optionally configure it.
After calling gfx_setfont(), gfx_texth may be updated to reflect the new average line height.
| Parameters: |
| idx | - | the font-id; idx=0 for default bitmapped font, no configuration is possible for this font. idx=1..16 for a configurable font |
| fontface | - | the name of the font, like "arial" |
| sz | - | the size of the font (8-100) |
| flags | - | flags, how to render the text; values are repeating every 256 numbers a multibyte character, which can include 'i' for italics, 'u' for underline, or 'b' for bold. These flags may or may not be supported depending on the font and OS. 66 and 98, Bold (B), (b) 73 and 105, italic (I), (i) 79 and 111, white outline (O), (o) 82 and 114, reduced(halfbright) (R), (r) 83 and 115, sharpen (S), (s) 85 and 117, underline (U), (u) 86 and 118, inVerse (V), (v) |
^
gfx_setimgdimFunctioncall:
EEL2: gfx_setimgdim(image,w,h)
Description:Resize image referenced by index 0..1024-1, width and height must be 0-8192. The contents of the image will be undefined after the resize.
| Parameters: |
| image | - | |
| w | - | |
| h | - | |
^
gfx_setpixelFunctioncall:
EEL2: gfx_setpixel(r,g,b)
Description:Writes a pixel of r,g,b to gfx_x,gfx_y.
^
gfx_showmenuFunctioncall:
Description:Shows a popup menu at gfx_x,gfx_y.
str is a list of fields separated by | characters. Each field represents a menu item.
Fields can start with special characters:
# : grayed out
! : checked
> : this menu item shows a submenu
< : last item in the current submenu
An empty field will appear as a separator in the menu. gfx_showmenu returns 0 if the user selected nothing from the menu, 1 if the first field is selected, etc.
Example:
gfx_showmenu("first item, followed by separator||!second item, checked|>third item which spawns a submenu|#first item in submenu, grayed out|
^
gfx_transformblitFunctioncall:
EEL2: gfx_transformblit(srcimg,destx,desty,destw,desth,div_w,div_h,table)
Description:Blits to destination at (destx,desty), size (destw,desth). div_w and div_h should be 2..64, and table should point to a table of 2*div_w*div_h values (this table must not cross a 65536 item boundary). Each pair in the table represents a S,T coordinate in the source image, and the table is treated as a left-right, top-bottom list of texture coordinates, which will then be rendered to the destination.
| Parameters: |
| srcimg | - | |
| destx | - | |
| desty | - | |
| destw | - | |
| desth | - | |
| div_w | - | |
| div_h | - | |
| table | - | |
^
gfx_triangleFunctioncall:
EEL2: gfx_triangle(x1,y1,x2,y2,x3,y3[x4,y4...])
Description:Draws a filled triangle, or any convex polygon.
| Parameters: |
| x1 | - | |
| y1 | - | |
| x2 | - | |
| y2 | - | |
| x3 | - | |
| y3 | - | |
| x4 | - | |
| y4 | - | |
^
gfx_updateFunctioncall:
Description:Updates the graphics display, if opened.
^
ifftFunctioncall:
Description:Perform an inverse FFT. For more information see
fft().
| Parameters: |
| buffer | - |
|
| size | - |
|
^
ifft_realFunctioncall:
EEL2: ifft_real(buffer,size)
Description:Performs an inverse FFT, but takes size/2 complex input pairs and produces size real output values. Usually used along with fft_ipermute(size/2).
| Parameters: |
| buffer | - | |
| size | - | |
^
invsqrtFunctioncall:
Description:Returns a fast inverse square root (1/sqrt(x)) approximation of the parameter.
^
logFunctioncall:
Description:Returns the natural logarithm (base e) of the parameter. If the value is not greater than 0, the return value is undefined.
^
log10Functioncall:
Description:Returns the base-10 logarithm of the parameter. If the value is not greater than 0, the return value is undefined.
^
loopFunctioncall:
EEL2: loop(count,expression)
Description:Evaluates count once, and then executes expression count, but not more than 1048576, times.
| Parameters: |
| count | - | |
| expression | - | |
^
matchFunctioncall:
EEL2: match(needle,haystack[, ...])
Description:Searches for the first parameter in the second parameter, using a simplified regular expression syntax.
* * = match 0 or more characters
* *? = match 0 or more characters, lazy
* + = match 1 or more characters
* +? = match 1 or more characters, lazy
* ? = match one character
You can also use format specifiers to match certain types of data, and optionally put that into a variable:
* %s means 1 or more chars
* %0s means 0 or more chars
* %5s means exactly 5 chars
* %5-s means 5 or more chars
* %-10s means 1-10 chars
* %3-5s means 3-5 chars
* %0-5s means 0-5 chars
* %x, %d, %u, and %f are available for use similarly
* %c can be used, but can't take any length modifiers
* Use uppercase (%S, %D, etc) for lazy matching
See also sprintf() for other notes, including specifying direct variable references via {}.
| Parameters: |
| needle | - |
|
| haystack | - |
|
^
matchiFunctioncall:
EEL2: matchi(needle,haystack[, ...])
Description:Case-insensitive version of
match().
| Parameters: |
| needle | - |
|
| haystack | - |
|
^
maxFunctioncall:
EEL2: max(&value,&value2)
Description:Returns (by reference) the maximum value of the two parameters. Since max() returns by reference, expressions such as max(x,y) = 5 are possible.
| Parameters: |
| value | - | |
| value2 | - | |
^
mem_get_valuesFunctioncall:
EEL2: mem_get_values(offset, ...)
Description:Reads values from memory starting at offset into variables specified. Slower than regular memory reads for less than a few variables, faster for more than a few. Undefined behavior if used with more than 32767 variables.
^
mem_set_valuesFunctioncall:
EEL2: mem_set_values(offset, ...)
Description:Writes values to memory starting at offset from variables specified. Slower than regular memory writes for less than a few variables, faster for more than a few. Undefined behavior if used with more than 32767 variables.
^
memcpyFunctioncall:
EEL2: memcpy(dest,src,length)
Description:Copies length items of memory from src to dest. Regions are permitted to overlap.
| Parameters: |
| dest | - | |
| src | - | |
| length | - | |
^
memsetFunctioncall:
EEL2: memset(offset,value,length)
Description:Sets length items of memory at offset to value.
| Parameters: |
| offset | - | |
| value | - | |
| length | - | |
^
minFunctioncall:
EEL2: min(&value,&value2)
Description:Returns (by reference) the minimum value of the two parameters. Since min() returns by reference, expressions such as min(x,y) = 5 are possible.
| Parameters: |
| value | - | |
| value2 | - | |
^
printfFunctioncall:
EEL2: printf(format[, ...])
Description:Output formatted string to system-specific destination, see
sprintf() for more information
* %% = %
* %s = string from parameter
* %d = parameter as integer
* %i = parameter as integer
* %u = parameter as unsigned integer
* %x = parameter as hex (lowercase) integer
* %X = parameter as hex (uppercase) integer
* %c = parameter as character
* %f = parameter as floating point
* %e = parameter as floating point (scientific notation, lowercase)
* %E = parameter as floating point (scientific notation, uppercase)
* %g = parameter as floating point (shortest representation, lowercase)
* %G = parameter as floating point (shortest representation, uppercase)
Many standard C printf() modifiers can be used, including:
* %.10s = string, but only print up to 10 characters
* %-10s = string, left justified to 10 characters
* %10s = string, right justified to 10 characters
* %+f = floating point, always show sign
* %.4f = floating point, minimum of 4 digits after decimal point
* %10d = integer, minimum of 10 digits (space padded)
* %010f = integer, minimum of 10 digits (zero padded)
Values for format specifiers can be specified as additional parameters to printf, or within {} in the format specifier (such as %{varname}d, in that case a global variable is always used).
^
randFunctioncall:
Description:Returns a psuedorandom real number between 0 and the parameter, inclusive. If the parameter is omitted or less than 1.0, 1.0 is used as a maximum instead.
^
runloopFunctioncall:
EEL2: runloop(string code)
Description:Adds code to be called back by REAPER. Used to create persistent ReaScripts that continue to run and respond to input, while the user does other tasks. Identical to defer().
Note that no undo point will be automatically created when the script finishes, unless you create it explicitly.
Each function called by runloop can only be deferred once per runloop-cycle(unlike in Lua, where you can have one function deferred multiple times).
Unlike "normal" loops, runloop allows looped code to run in the background without blocking Reaper's user interface.
That way, scripts, who need longer time to run, can be made possible.
Example:
the following example allows adding a to variable A with each runloop-cycle.
function main()(
A=A+1;
runloop("main()");
);
main();
| Parameters: |
| string code | - | the code to be run. You can also add a regular functioncall into this string, like "main()", if there's a main-function in the script |
^
signFunctioncall:
Description:Returns 1.0 if the parameter is greater than 0, -1.0 if the parameter is less than 0, or 0 if the parameter is 0.
^
sinFunctioncall:
Description:Returns the sine of the angle specified (specified in radians -- to convert from degrees to radians, multiply by $pi/180, or 0.017453).
^
sleepFunctioncall:
Description:Yields the CPU for the millisecond count specified, calling Sleep() on Windows or usleep() on other platforms.
^
sprintfFunctioncall:
EEL2: sprintf(#dest,format[, ...])
Description:Formats a string and stores it in #dest. Format specifiers begin with %, and may include:
* %% = %
* %s = string from parameter
* %d = parameter as integer
* %i = parameter as integer
* %u = parameter as unsigned integer
* %x = parameter as hex (lowercase) integer
* %X = parameter as hex (uppercase) integer
* %c = parameter as character
* %f = parameter as floating point
* %e = parameter as floating point (scientific notation, lowercase)
* %E = parameter as floating point (scientific notation, uppercase)
* %g = parameter as floating point (shortest representation, lowercase)
* %G = parameter as floating point (shortest representation, uppercase)
Many standard C printf() modifiers can be used, including:
* %.10s = string, but only print up to 10 characters
* %-10s = string, left justified to 10 characters
* %10s = string, right justified to 10 characters
* %+f = floating point, always show sign
* %.4f = floating point, minimum of 4 digits after decimal point
* %10d = integer, minimum of 10 digits (space padded)
* %010f = integer, minimum of 10 digits (zero padded)
Values for format specifiers can be specified as additional parameters to sprintf, or within {} in the format specifier (such as %{varname}d, in that case a global variable is always used).
| Parameters: |
| #dest | - | |
| format | - | |
^
sqrFunctioncall:
Description:Returns the square of the parameter (similar to value*value, but only evaluating value once).
^
sqrtFunctioncall:
Description:Returns the square root of the parameter. If the parameter is negative, the return value is undefined.
^
stack_exchFunctioncall:
Description:Exchanges a value with the top of the stack, and returns a reference to the parameter (with the new value).
^
stack_peekFunctioncall:
Description:Returns a reference to the item on the top of the stack (if index is 0), or to the Nth item on the stack if index is greater than 0.
^
stack_popFunctioncall:
Description:Pops a value from the user stack into value, or into a temporary buffer if value is not specified, and returns a reference to where the stack was popped. Note that no checking is done to determine if the stack is empty, and as such stack_pop() will never fail.
^
stack_pushFunctioncall:
Description:Pushes value onto the user stack, returns a reference to the parameter.
^
str_delsubFunctioncall:
EEL2: str_delsub(#str,pos,len)
Description:Deletes len characters at offset pos from #str, and returns #str.
| Parameters: |
| #str | - | |
| pos | - | |
| len | - | |
^
str_getcharFunctioncall:
EEL2: str_getchar(str,offset[,type])
Description:Returns the data at byte-offset offset of str. If offset is negative, position is relative to end of string.type defaults to signed char, but can be specified to read raw binary data in other formats (note the single quotes, these are single/multi-byte characters):
* 'c' - signed char
* 'cu' - unsigned char
* 's' - signed short
* 'S' - signed short, big endian
* 'su' - unsigned short
* 'Su' - unsigned short, big endian
* 'i' - signed int
* 'I' - signed int, big endian
* 'iu' - unsigned int
* 'Iu' - unsigned int, big endian
* 'f' - float
* 'F' - float, big endian
* 'd' - double
* 'D' - double, big endian
| Parameters: |
| str | - |
|
| offset | - |
|
| type | - |
|
^
str_insertFunctioncall:
EEL2: str_insert(#str,srcstr,pos)
Description:Inserts srcstr into #str at offset pos. Returns #str.
| Parameters: |
| #str | - | |
| srcstr | - | |
| pos | - | |
^
str_setcharFunctioncall:
EEL2: str_setchar(#str,offset,val[,type]))
Description:Sets value at offset offset, type optional. offset may be negative to refer to offset relative to end of string, or between 0 and length, inclusive, and if set to length it will lengthen string. See
str_getchar() for more information on types.
| Parameters: |
| #str | - |
|
| offset | - |
|
| val | - |
|
| type | - |
|
^
str_setlenFunctioncall:
EEL2: str_setlen(#str,len)
Description:Sets length of #str (if increasing, will be space-padded), and returns #str.
^
strcatFunctioncall:
EEL2: strcat(#str,srcstr)
Description:Appends srcstr to #str, and returns #str
| Parameters: |
| #str | - | |
| srcstr | - | |
^
strcmpFunctioncall:
Description:Compares strings, returning 0 if equal
^
strcpyFunctioncall:
EEL2: strcpy(#str,srcstr)
Description:Copies the contents of srcstr to #str, and returns #str
| Parameters: |
| #str | - | |
| srcstr | - | |
^
strcpy_fromFunctioncall:
EEL2: strcpy_from(#str,srcstr,offset)
Description:Copies srcstr to #str, but starts reading srcstr at offset offset
| Parameters: |
| #str | - | |
| srcstr | - | |
| offset | - | |
^
strcpy_substrFunctioncall:
EEL2: strcpy_substr(#str,srcstr,offs,ml))
Description:PHP-style (start at offs, offs<0 means from end, ml for maxlen, ml<0 = reduce length by this amt)
| Parameters: |
| #str | - | |
| srcstr | - | |
| offs | - | |
| ml | - | |
^
stricmpFunctioncall:
Description:Compares strings ignoring case, returning 0 if equal.
^
strlenFunctioncall:
Description:Returns the length of the string passed as a parameter.
^
strncatFunctioncall:
EEL2: strncat(#str,srcstr,maxlen)
Description:Appends srcstr to #str, stopping after maxlen characters of srcstr. Returns #str.
| Parameters: |
| #str | - | |
| srcstr | - | |
| maxlen | - | |
^
strncmpFunctioncall:
EEL2: strncmp(str,str2,maxlen)
Description:Compares strings giving up after maxlen characters, returning 0 if equal.
| Parameters: |
| str | - | |
| str2 | - | |
| maxlen | - | |
^
strncpyFunctioncall:
EEL2: strncpy(#str,srcstr,maxlen)
Description:Copies srcstr to #str, stopping after maxlen characters. Returns #str.
| Parameters: |
| #str | - | |
| srcstr | - | |
| maxlen | - | |
^
strnicmpFunctioncall:
EEL2: strnicmp(str,str2,maxlen)
Description:Compares strings giving up after maxlen characters, ignoring case, returning 0 if equal.
| Parameters: |
| str | - | |
| str2 | - | |
| maxlen | - | |
^
tanFunctioncall:
Description:Returns the tangent of the angle specified (specified in radians).
^
tcp_closeFunctioncall:
EEL2: tcp_close(connection)
Description:Closes a TCP connection created by tcp_listen() or tcp_connect().
^
tcp_connectFunctioncall:
EEL2: tcp_connect(address,port[,block])
Description:Create a new TCP connection to address:port. If block is specified and 0, connection will be made nonblocking. Returns TCP connection ID greater than 0 on success.
| Parameters: |
| address | - | |
| port | - | |
| block | - | |
^
tcp_listenFunctioncall:
EEL2: tcp_listen(port[,interface,#ip_out])
Description:Listens on port specified. Returns less than 0 if could not listen, 0 if no new connection available, or greater than 0 (as a TCP connection ID) if a new connection was made. If a connection made and #ip_out specified, it will be set to the remote IP. interface can be empty for all interfaces, otherwise an interface IP as a string.
| Parameters: |
| port | - | |
| interface | - | |
| #ip_out | - | |
^
tcp_listen_endFunctioncall:
EEL2: tcp_listen_end(port)
Description:Ends listening on port specified.
^
tcp_recvFunctioncall:
EEL2: tcp_recv(connection,#str[,maxlen])
Description:Receives data from a connection to #str. If maxlen is specified, no more than maxlen bytes will be received. If non-blocking, 0 will be returned if would block. Returns less than 0 if error.
| Parameters: |
| connection | - | |
| #str | - | |
| maxlen | - | |
^
tcp_sendFunctioncall:
EEL2: tcp_send(connection,str[,len])
Description:Sends a string to connection. Returns -1 on error, 0 if connection is non-blocking and would block, otherwise returns length sent. If len is specified and not less than 1, only the first len bytes of the string parameter will be sent.
| Parameters: |
| connection | - | |
| str | - | |
| len | - | |
^
tcp_set_blockFunctioncall:
EEL2: tcp_set_block(connection,block)
Description:Sets whether a connection blocks.
| Parameters: |
| connection | - | |
| block | - | |
^
timeFunctioncall:
Description:Sets the parameter (or a temporary buffer if omitted) to the number of seconds since January 1, 1970, and returns a reference to that value. The granularity of the value returned is 1 second.
^
time_preciseFunctioncall:
EEL2: time_precise([&val])
Description:Sets the parameter (or a temporary buffer if omitted) to a system-local timestamp in seconds, and returns a reference to that value. The granularity of the value returned is system defined (but generally significantly smaller than one second).
^
whileFunctioncall:
Description:Executes expression until expression evaluates to zero, or until 1048576 iterations occur. An alternate and more useful syntax is while (expression) ( statements ), which evaluates statements after every non-zero evaluation of expression.
^
atexitFunctioncall:
Lua: reaper.atexit(function function)
Description:Adds code to be executed when the script finishes or is ended by the user. Typically used to clean up after the user terminates defer() or runloop() code.
You can't defer this atexit-function, when it is run as exit-function, though, when it is run regularily before exiting the script.
You can define more than one atexit-function. They will be run in the order they've been registered as atexit-functions.
For example:
reaper.atexit(exit1)
reaper.atexit(exit2)
reaper.atexit(exit3)
will run exit1, exit2 and then exit3, when exiting the script.
You can have up to 1024 atexit-functions set in one script, no matter if its different or the same function.
| Parameters: |
| function function | - | the function, with which the script shall finish |
^
deferFunctioncall:
Lua: boolean retval = reaper.defer(function function)
Description:Adds code to be called back by REAPER. Used to create persistent ReaScripts that continue to run and respond to input, while the user does other tasks. Identical to runloop().Note that no undo point will be automatically created when the script finishes, unless you create it explicitly.
There can be 1024 defer-nodes running at the same time in one script, no matter if it's different functions or the same one.
| Parameters: |
| function function | - | the function to be called, when the current defer/runloop-run has ended |
| Returnvalues: |
| boolean retval | - | true, node could be created; false, you tried to add more than 1024 defer-nodes in the script |
^
get_action_contextFunctioncall:
Lua: boolean is_new_value, string filename_with_path, integer sectionID, integer cmdID, integer mode, integer resolution, integer val = reaper.get_action_context()
Description:Returns contextual information about the script, typically MIDI/OSC input values.val will be set to a relative or absolute value depending on mode (=0: absolute mode, >0: relative modes). resolution=127 for 7-bit resolution, =16383 for 14-bit resolution.Notes: sectionID, and cmdID will be set to -1 if the script is not part of the action list. mode, resolution and val will be set to -1 if the script was not triggered via MIDI/OSC.
For relative mode bindings, calling get_action_context() will return the accumulated relative value in decoded form (not 65 or 63, but +1/-1 etc), and clear the internal state. So if you call it multiple times, the first one will return the accumulated value, and the second will always return 0.
| Returnvalues: |
| boolean is_new_value | - | |
| string filename_with_path | - | the script's own filename with path |
| integer sectionID | - | the section, in which this script was called |
| integer cmdID | - | the command-id associated with this script |
| integer mode | - | -1, if script isn't run by shortcut; 55953, is script is run by shortcut; probably for for MIDI? |
| integer resolution | - | -1, if script isn't run by shortcut; probably more for MIDI? |
| integer val | - | -1, if script isn't run by shortcut; probably more for MIDI? |
^
gfx_variablesFunctioncall:
Description:The following global variables are special and will be used by the graphics system:
* gfx.r - current red component (0..1) used by drawing operations.
* gfx.g - current green component (0..1) used by drawing operations.
* gfx.b - current blue component (0..1) used by drawing operations.
* gfx.a2 - current alpha component (0..1) used by drawing operations when writing solid colors (normally ignored but useful when creating transparent images).
* gfx.a - alpha for drawing (1=normal).
* gfx.mode - blend mode for drawing. Set mode to 0 for default options. Add 1.0 for additive blend mode (if you wish to do subtractive, set gfx.a to negative and use gfx.mode as additive). Add 2.0 to disable source alpha for gfx.blit(). Add 4.0 to disable filtering for gfx.blit().
* gfx.w - width of the UI framebuffer.
* gfx.h - height of the UI framebuffer.
* gfx.x - current graphics position X. Some drawing functions use as start position and update.
* gfx.y - current graphics position Y. Some drawing functions use as start position and update.
* gfx.clear - if greater than -1.0, framebuffer will be cleared to that color. the color for this one is packed RGB (0..255), i.e. red+green*256+blue*65536. The default is 0 (black).
* gfx.dest - destination for drawing operations, -1 is main framebuffer, set to 0..1024-1 to have drawing operations go to an offscreen buffer (or loaded image).
* gfx.texth - the (READ-ONLY) height of a line of text in the current font. Do not modify this variable.
* gfx.ext_retina - to support hidpi/retina, callers should set to 1.0 on initialization, will be updated to 2.0 if high resolution display is supported, and if so gfx.w/gfx.h/etc will be doubled.
* gfx.mouse_x - current X coordinate of the mouse relative to the graphics window.
* gfx.mouse_y - current Y coordinate of the mouse relative to the graphics window.
* gfx.mouse_wheel - wheel position, will change typically by 120 or a multiple thereof, the caller should clear the state to 0 after reading it.
* gfx.mouse_hwheel - horizontal wheel positions, will change typically by 120 or a multiple thereof, the caller should clear the state to 0 after reading it.
* gfx.mouse_cap - a bitfield of mouse and keyboard modifier state:
1: left mouse button
2: right mouse button
4: Control key
8: Shift key
16: Alt key
32: Windows key
64: middle mouse button
Note: Mousebuttons will be returned after gfx.init(), the other keyboard-modifier only when using gfx.getchar()!
^
gfx.arcFunctioncall:
Lua: gfx.arc(integer x, integer y, integer r, number ang1, number ang2, optional number antialias)
Description:Draws an arc of the circle centered at x,y, with ang1/ang2 being specified in radians.
| Parameters: |
| integer x | - | x position of the center of the circle |
| integer y | - | y position of the center of the circle |
| integer r | - | the radius of the circle |
| number ang1 | - | the beginning of the circle in radians; meant for partial circles; 0-6.28 |
| number ang2 | - | the end of the circle in radians; meant for partial circles; 0-6.28 |
| optional number antialias | - | <=0.5, antialias off; >0.5, antialias on |
^
gfx.blitFunctioncall:
Lua: integer source = gfx.blit(integer source, number scale, number rotation, optional number srcx, optional number srcy, optional number srcw, optional number srch, optional integer destx, optional integer desty, optional integer destw, optional integer desth, optional integer rotxoffs, optional integer rotyoffs)
Description:Blits(draws) the content of source-image to another source-image or an opened window.
srcx/srcy/srcw/srch specify the source rectangle (if omitted srcw/srch default to image size), destx/desty/destw/desth specify dest rectangle (if not specified, these will default to reasonable defaults -- destw/desth default to srcw/srch * scale).
| Parameters: |
| integer source | - | the source-image/framebuffer to blit; -1 to 1023; -1 for the currently displayed framebuffer. |
| number scale | - | the scale-factor; 1, for normal size; smaller or bigger than 1 make image smaller or bigger has no effect, when destx, desty, destw, desth are given |
| number rotation | - | the rotation-factor; 0 to 6.28; 3.14 for 180 degrees. |
| optional number srcx | - | the x-coordinate-offset in the source-image |
| optional number srcy | - | the y-coordinate-offset in the source-image |
| optional number srcw | - | the width-offset in the source-image |
| optional number srch | - | the height-offset in the source-image |
| optional integer destx | - | the x-coordinate of the blitting destination |
| optional integer desty | - | the y-coordinate of the blitting destination |
| optional integer destw | - | the width of the blitting destination; may lead to stretched images |
| optional integer desth | - | the height of the blitting destination; may lead to stretched images |
| optional number rotxoffs | - | influences rotation |
| optional number rotyoffs | - | influences rotation |
^
gfx.blit(simplified)Functioncall:
Lua: integer source = gfx.blit(integer source, number scale, number rotation)
Description:Blits(draws) the content of source-image to another source-image or an opened window.
This is a simplified version of
gfx.blit().
If three parameters are specified, copies the entirity of the source bitmap to gfx.x,gfx.y using current opacity and copy mode (set with gfx.a, gfx.mode). You can specify scale (1.0 is unscaled) and rotation (0.0 is not rotated, angles are in radians).For the "source" parameter specify -1 to use the main framebuffer as source, or an image index (see gfx.loadimg()).
| Parameters: |
| integer source | - | the source-image/framebuffer to blit; -1 to 1023; -1 for the currently displayed framebuffer.
|
| number scale | - | the scale-factor; 1, for normal size; smaller or bigger than 1 make image smaller or bigger
|
| number rotation | - | the rotation-factor; 0 to 6.28; 3.14 for 180 degrees.
|
^
gfx.blitextFunctioncall:
Lua: gfx.blitext(source,coordinatelist,rotation)
Description:Deprecated, use gfx.blit instead.
| Parameters: |
| source | - | |
| coordinatelist | - | |
| rotation | - | |
^
gfx.blurtoFunctioncall:
Lua: gfx.blurto(integer x, integer y)
Description:Blurs the region of the screen between gfx.x,gfx.y and x,y, and updates gfx.x,gfx.y to x,y.
| Parameters: |
| integer x | - | x position of the other edge of the blur-region |
| integer y | - | y position of the other edge of the blur-region |
^
gfx.circleFunctioncall:
Lua: gfx.circle(integer x, integer y, integer r, optional number fill, optional number antialias)
Description:Draws a circle, optionally filling/antialiasing.
| Parameters: |
| integer x | - | x position of center of the circle |
| integer y | - | y position of center of the circle |
| integer r | - | radius of the circle |
| optional number fill | - | <=0.5, circle is not filled; >0.5, circle is filled |
| optional number antialias | - | <=0.5, circle is not antialiased; >0.5, circle is antialiased |
^
gfx.clienttoscreenFunctioncall:
Lua: int convx, int convy = gfx.clienttoscreen(integer x, integer y)
Description:Converts the coordinates x,y to screen coordinates, returns those values.
| Parameters: |
| integer x | - | the x coordinate within(!) the gfx.init()-window, that shall be converted to screen-coordinates |
| integer y | - | the y coordinate within(!) the gfx.init()-window, that shall be converted to screen-coordinates |
| Returnvalues: |
| integer convx | - | the converted coordinate in relation of the screen-viewport |
| integer convy | - | the converted coordinate in relation of the screen-viewport |
^
gfx.deltablitFunctioncall:
Lua: number retval = gfx.deltablit(integer srcimg, integer srcs, integer srct, integer srcw, integer srch, number destx, number desty, number destw, number desth, number dsdx, number dtdx, number dsdy, number dtdy, number dsdxdy, number dtdxdy,optional integer usecliprect)
Description:Blits from srcimg(srcs,srct,srcw,srch) to destination (destx,desty,destw,desth). Source texture coordinates are s/t, dsdx represents the change in s coordinate for each x pixel, dtdy represents the change in t coordinate for each y pixel, etc. dsdxdy represents the change in dsdx for each line. If usecliprect is specified and 0, then srcw/srch are ignored.
This function allows you to manipulate the image, which you want to blit, by transforming, moving or cropping it.
To do rotation, you can manipulate dtdx and dsdy together.
| Parameters: |
| integer srcimg | - | image - the image to blit |
| integer srcs | - | positiondeltaX - the delta of the x-position of the image within the blitted area in pixels(useful default: 0) |
| integer srct | - | positiondeltaY - the delta of the y-position of the image within the blitted area in pixels(useful default: 0) |
| integer srcw | - | unknown - (useful default: 0) |
| integer srch | - | unknown - (useful default: 0) |
| number destx | - | positiondeltaX - the delta of the x-position of the blitted area in pixels(useful default: 0) |
| number desty | - | positiondeltaY - the delta of the y-position of the blitted area in pixels(useful default: 0) |
| number destw | - | blitsizeX - the x-size of the blitted area in pixels; the deltaimage might be cropped, if it exceeds this size(useful default: width of the image) |
| number desth | - | blitsizeY - the y-size of the blitted area in pixels; the deltaimage might be cropped, if it exceeds this size(useful default: height of the image) |
| number dsdx | - | stretchfactorX, the lower, the more stretched is the image(minimum 0; 1 for full size); limited by blitsizeX(useful default: 1) |
| number dtdx | - | deltaY: the delta of the right side of the image, related to the left side of the image; positive, right is moved up; negative, right is moved down; this delta is linear(useful default: 0) |
| number dsdy | - | deltaX: the delta of the bottom side of the image, related to the top side of the image; positive, bottom is moved left; negative, bottom is moved right; this delta is linear(useful default: 0) |
| number dtdy | - | stretchfactorY, the lower, the more stretched is the image(minimum 0; 1 for full size); limited by blitsizeY(useful default: 1) |
| number dsdxdy | - | deltacurvedY: the delta of the right side of the image, related to the left side of the image; positive, right is moved up; negative, right is moved down; this delta "curves" the delta via a bezier(useful default: 0) |
| number dtdxdy | - | deltacurvedX: the delta of the bottom side of the image, related to the top side of the image; positive, bottom is moved left; negative, bottom is moved right; this delta "curves" the delta via a bezier(useful default: 0) |
| optional integer usecliprect | - | can be set to 0 or 1(useful default: 0) |
| Returnvalues: |
| number retval | - | unknown, usually 0 |
^
gfx.dockFunctioncall:
Lua: number querystate, optional integer window_x_position, optional integer window_y_position, optional integer window_width, optional integer window_height = gfx.dock(integer v, optional integer wx, optional integer wy, optional integer ww, optional integer wh)
Description:Queries or sets the docking-state of the gfx.init()-window.
Call with v=-1 to query docked state, otherwise v>=0 to set docked state.
State is &1 if docked, second byte is docker index (or last docker index if undocked).
If you pass numbers to wx-wh, you can query window size and position additionally to the dock-state
A specific docking index does not necessarily represent a specific docker, means, you can not query/set left docker top, but rather all dockers that exist in the current screenset.
So the first queried/set docker can be top-left-docker or the top docker or even one of the bottom dockers.
The order doesn't seem to make any sense. Especially with more than 16 windows docked in the current screenset.
| Parameters: |
| integer v | - | -1, query docking-state; 0 and higher, set state of the window to docked; the bits &256, &512, &1024, &2048 set the docker-index |
| optional integer wx | - | set to a number to query current-windowx-position |
| optional integer wy | - | set to a number to query current-windowy-position |
| optional integer ww | - | set to a number to query current-window-width |
| optional integer wh | - | set to a number to query current-window-height |
| Returnvalues: |
| integer querystate | - | 0 if not docked; &1 if docked; the bits &256, &512, &1024, &2048 get the docker-index |
| integer window_x_position | - | the x position of the window in pixels; only if wx~=nil |
| integer window_y_position | - | the y position of the window in pixels; only if wy~=nil |
| integer window_width | - | the width of the window in pixels; only if ww~=nil |
| integer window_height | - | the height of the window in pixels ; only if wh~=nil |
^
gfx.drawcharFunctioncall:
Lua: integer char = gfx.drawchar(integer char)
Description:Draws the character (can be a numeric ASCII code as well), to gfx.x, gfx.y, and moves gfx.x over by the size of the character.
| Parameters: |
| integer char | - | the numeric ASCII-representation of the character to be drawn |
| Returnvalues: |
| integer char | - | the character drawn; 0, if invalid(like strings or characters passed as parameter) |
^
gfx.drawnumberFunctioncall:
Lua: gfx.drawnumber(number n, integer ndigits)
Description:Draws the number n with ndigits of precision to gfx.x, gfx.y, and updates gfx.x to the right side of the drawing. The text height is gfx.texth.
| Parameters: |
| number n | - | the number to be drawn |
| integer ndigits | - | the number of digits for the precision |
^
gfx.drawstrFunctioncall:
Lua: gfx.drawstr(string str, optional integer flags, optional integer right, optional integer bottom)
Description:Draws a string at gfx.x, gfx.y, and updates gfx.x/gfx.y so that subsequent draws will occur in a similar place.
You can optionally set a clipping area for the text, if you set parameter flags&256 and the parameters right and bottom.
On Windows, fonts with a size > 255 may have trouble of being displayed correctly, due problems with the font-rendering and the alpha-channel.
Justin's post about this.To overcome this, try this to disable the alpha-channel:
By default, gfx.blit() blits with alpha channel. You can disable this behavior by setting "gfx.mode=2" before calling gfx.blit().
| Parameters: |
| string str | - | the string to be drawn into the gfx.init-window |
| optional integer flags | - | influence, how the text shall be drawn flags&1: center horizontally flags&2: right justify flags&4: center vertically flags&8: bottom justify flags&256: ignore right/bottom, otherwise text is clipped to (gfx.x, gfx.y, right, bottom) |
| optional integer right | - | if flags&256 is set, this parameter clips text on the right side in pixels |
| optional integer bottom | - | if flags&256 is set, this parameter clips text on the bottom side in pixels |
^
gfx.getcharFunctioncall:
Lua: integer charactercode = gfx.getchar(optional integer character)
Description:If char is 0 or omitted, returns a character from the keyboard queue, or 0 if no character is available, or -1 if the graphics window is not open.
If char is specified and nonzero, that character's status will be checked, and the function will return greater than 0 if it is pressed.
Common values are standard ASCII, such as 'a', 'A', '=' and '1', but for many keys multi-byte values are used,
including 'home', 'up', 'down', 'left', 'right', 'f1'.. 'f12', 'pgup', 'pgdn', 'ins', and 'del'.
Shortcuts with scope "Global + textfields" will still run the associated action, scope of "Normal" or "Global" will not.
Modified and special keys can also be returned, including:
- Ctrl/Cmd+A..Ctrl+Z as 1..26
- Ctrl/Cmd+Alt+A..Z as 257..282
- Alt+A..Z as 'A'+256..'Z'+256
- 27 for ESC
- 13 for Enter
- ' ' for space
-
- use 65536 as parameter charactercode to query special flags, returns: &1 (supported in this script), &2=window has focus, &4=window is visible
Some multibyte-characters, like home, up, down, left, right, f1 .. f12, pgup, pgdn, ins, del are returned as values above 255, but some other characters, like €,
are "real"-multibyte-characters, stored as multiple 8-bit-values after each other.
To retrieve them, you need to run gfx.getchar() twice per defer-cycle and return their retvals into two variables:
Example:
A=gfx.getchar() -- first byte
B=gfx.getchar() -- second byte
if A==261 and B==128 then reaper.MB("You typed the Euro-symbol.", "Message", 0) end -- typed character is the Euro-currency-symbol.
| Parameters: |
| optional integer character | - | the character to check for; use 65536 to check window-state(visible, focus) &1 (supported in this script), &2=window has focus, &4=window is visible |
| Returnvalues: |
| integer charactercode | - | either the charactercode or 0 if nothing is pressed
-1, if the gfx.init-window is closed
When the parameter character is given and not 0, charactercode is either
0, nothing is pressed, or
>0, the character you want to check for is pressed. |
^
gfx.getdropfileFunctioncall:
Lua: integer retval, string filename = gfx.getdropfile(integer idx)
Description:Returns filenames, drag'n'dropped into a window created by gfx.init().
Use idx to get a specific filename, that has been dropped into the gfx.init()-window.
Does NOT support mediaitems/takes or other Reaper-objects!
It MUST be called BEFORE calling gfx.update, as gfx.update flushes the filelist accessible with gfx.getdropfile.
| Parameters: |
| integer idx | - | the indexnumber for a filename, that has been dropped into a gfx.init()-window. 0, the first file; 1, the second file; 2, the third file, etc. -1, clears the filelist. |
| Returnvalues: |
| integer retval | - | 0, if droppped-filename with indexnumber idx doesn't exist; 1, if it exists; hints, if you already reached the last filename dropped. |
| string filename | - | the filename of dropped-file with indexnumber idx |
^
gfx.getfontFunctioncall:
Lua: integer fontindex = gfx.getfont()
Description:Returns current font index, and the actual font face used by this font (if available).
| Returnvalues: |
| integer fontindex | - | the index of the font used. Use gfx.setfont to set a font for a specific index.
|
^
gfx.getimgdimFunctioncall:
Lua: integer w, integer h = gfx.getimgdim(integer handle)
Description:Retrieves the dimensions of an image specified by handle, returns w, h pair.
Handle is basically a frame-buffer.
| Parameters: |
| integer handle | - | the index of the image-handle/framebuffer to retrieve the dimensions from;-1 to 1023; -1 for the currently displayed framebuffer. |
| Returnvalues: |
| integer w | - | the width of the image-handle in pixels |
| integer h | - | the height of the image-handle in pixels |
^
gfx.getpixelFunctioncall:
Lua: integer r, integer g, integer b = gfx.getpixel()
Description:Returns r,g,b values [0..1] of the pixel at (gfx.x,gfx.y)
| Returnvalues: |
| integer r | - | the red-color-value, a value between 0 to 1 |
| integer g | - | the green-color-value, a value between 0 to 1 |
| integer b | - | the blue-color-value, a value between 0 to 1 |
^
gfx.gradrectFunctioncall:
Lua: gfx.gradrect(x,y,w,h, r,g,b,a[, drdx, dgdx, dbdx, dadx, drdy, dgdy, dbdy, dady])
Description:Fills a gradient rectangle with the color and alpha specified. drdx-dadx reflect the adjustment (per-pixel) applied for each pixel moved to the right, drdy-dady are the adjustment applied for each pixel moved toward the bottom. Normally drdx=adjustamount/w, drdy=adjustamount/h, etc.
| Parameters: |
| x | - | |
| y | - | |
| w | - | |
| h | - | |
| r | - | |
| g | - | |
| b | - | |
| a | - | |
| drdx | - | |
| dgdx | - | |
| dbdx | - | |
| dadx | - | |
| drdy | - | |
| dgdy | - | |
| dbdy | - | |
| dady | - | |
^
gfx.initFunctioncall:
Lua: integer retval = gfx.init(string "name", optional integer width, optional integer height, optional integer dockstate, optional integer xpos, optional integer ypos)
Description:Initializes the graphics window with title name. Suggested width and height can be specified.Once the graphics window is open, gfx.update() should be called periodically.
Only one graphics-window can be opened per script! Calling gfx.ini after a window has been opened has no effect.
To resizes/reposition the window, call gfx.init again and pass an empty string as name-parameter.
To get the current window-states, dimensions, etc, you can use
gfx.dock.
| Parameters: |
| string name | - | the name of the window, which will be shown in the title of the window
|
| optional integer width | - | the width of the window; minmum is 50
|
| optional integer height | - | the height of the window; minimum is 16
|
| optional integer dockstate | - | &1=0, undocked; &1=1, docked
|
| optional integer xpos | - | x-position of the window in pixels; minimum is -80
|
| optional integer ypos | - | y-position of the window in pixels; minimum is -15
|
| Returnvalues: |
| number retval | - | 1.0, if window is opened
|
^
gfx.lineFunctioncall:
Lua: gfx.line(integer x, integer y, integer x2, integer y2, optional number aa)
Description:Draws a line from x,y to x2,y2, and if aa is not specified or 0.5 or greater, it will be antialiased.
| Parameters: |
| integer x | - | x-position of start of the line in pixels |
| integer y | - | y-position of start of the line in pixels |
| integer x2 | - | x-position of the end of the line in pixels |
| integer y2 | - | y-position of the end of the line in pixels |
| optional number aa | - | <0.5, no antialias; >=0.5, antialias |
^
gfx.linetoFunctioncall:
Lua: gfx.lineto(integer x, integer y, number aa)
Description:Draws a line from gfx.x,gfx.y to x,y. If aa is 0.5 or greater, then antialiasing is used. Updates gfx.x and gfx.y to x,y.
| Parameters: |
| integer x | - | x-position of the end of the line in pixels |
| integer y | - | y-position of the end of the line in pixels |
| optional number aa | - | <0.5, no antialias; >=0.5, antialias |
^
gfx.loadimgFunctioncall:
Lua: integer retval = gfx.loadimg(integer image, string filename)
Description:Load image from filename into slot 0..1024-1 specified by image. Returns the image index if success, otherwise -1 if failure. The image will be resized to the dimensions of the image file.
| Parameters: |
| integer image | - | the buffer-index(0 - 1023), in which to load the image |
| string filename | - | the path+filename of the image to be loaded |
| Returnvalues: |
| integer retval | - | the image-index in case of successful loading; -1 if loading failed |
^
gfx.measurecharFunctioncall:
Lua: integer width, integer height = gfx.measurechar(integer char)
Description:Measures the drawing dimensions of a character with the current font (as set by
gfx.setfont). Returns width and height of character.
| Parameters: |
| integer char | - | ASCII-Code of the character to measure
|
| Returnvalues: |
| integer width | - | the width of the character in pixels
|
| integer height | - | the height of the character in pixels
|
^
gfx.measurestrFunctioncall:
Lua: integer width, integer height = gfx.measurestr(string str)
Description:Measures the drawing dimensions of a string with the current font (as set by
gfx.setfont). Returns width and height of string.
| Parameters: |
| string str | - | the string, whose drawing dimensions you want to know
|
| Returnvalues: |
| integer width | - | the width of the drawing dimensions of str in pixels
|
| integer height | - | the height of the drawing dimensions of str in pixels
|
^
gfx.muladdrectFunctioncall:
Lua: integer retval = gfx.muladdrect(integer x, integer y, integer w, integer h, number mul_r, number mul_g, number mul_b, optional number mul_a, optional number add_r, optional number add_g, optional number add_b, optional number add_a)
Description:Multiplies each pixel within the given rectangle(x,y,w,h) by the mul_*-parameters and optionally adds add_*-parameters, and updates in-place. Useful for changing brightness/contrast, or other effects.
The multiplied values usually affect only pixels, that are not black(0,0,0,0), while the added values affect all pixels.
| Parameters: |
| integer x | - | the x-position of the rectangle in pixels, in which you want to multiply/add colorvalues to |
| integer y | - | the y-position of the rectangle in pixels, in which you want to multiply/add colorvalues to |
| integer w | - | the width of the rectangle in pixels, in which you want to multiply/add colorvalues to |
| integer h | - | the height of the rectangle in pixels, in which you want to multiply/add colorvalues to |
| number mul_r | - | the red-value to multiply by within the rectangle; 0 to 1 |
| number mul_g | - | the green-value to multiply by within the rectangle; 0 to 1 |
| number mul_b | - | the blue-value to multiply by within the rectangle; 0 to 1 |
| optional number mul_a | - | the alpha-value to multiply by within the rectangle; 0 to 1 |
| optional number add_r | - | the red-value to add by within the rectangle; 0 to 1 |
| optional number add_g | - | the green-value to add by within the rectangle; 0 to 1 |
| optional number add_b | - | the blue-value to add by within the rectangle; 0 to 1 |
| optional number add_a | - | the alpha-value to add by within the rectangle; 0 to 1 |
| Returnvalues: |
| integer retval | - | unknown |
^
gfx.printfFunctioncall:
Lua: gfx.printf(format[, ...])
Description:Formats and draws a string at gfx.x, gfx.y, and updates gfx.x/gfx.y accordingly (the latter only if the formatted string contains newline). For more information on format strings, see sprintf()
* %% = %
* %s = string from parameter
* %d = parameter as integer
* %i = parameter as integer
* %u = parameter as unsigned integer
* %x = parameter as hex (lowercase) integer
* %X = parameter as hex (uppercase) integer
* %c = parameter as character
* %f = parameter as floating point
* %e = parameter as floating point (scientific notation, lowercase)
* %E = parameter as floating point (scientific notation, uppercase)
* %g = parameter as floating point (shortest representation, lowercase)
* %G = parameter as floating point (shortest representation, uppercase)
Many standard C printf() modifiers can be used, including:
* %.10s = string, but only print up to 10 characters
* %-10s = string, left justified to 10 characters
* %10s = string, right justified to 10 characters
* %+f = floating point, always show sign
* %.4f = floating point, minimum of 4 digits after decimal point
* %10d = integer, minimum of 10 digits (space padded)
* %010f = integer, minimum of 10 digits (zero padded)
Values for format specifiers can be specified as additional parameters to gfx.printf, or within {} in the format specifier (such as %{varname}d, in that case a global variable is always used).
^
gfx.quitFunctioncall:
Lua: integer retval = gfx.quit()
Description:Closes the graphics window.
| Returnvalues: |
| integer retval | - | unknown, usually 0 |
^
gfx.rectFunctioncall:
Lua: integer retval = gfx.rect(integer x, integer y, integer w, integer h, optional integer filled)
Description:Fills a rectangle at x,y, w,h pixels in dimension, filled by default.
| Parameters: |
| integer x | - | the x-position of the upper left corner |
| integer y | - | the y-position of the upper left corner |
| integer w | - | the width of the rectangle; must be positive |
| integer h | - | the height of the rectangle; must be positive |
| optional integer filled | - | 0, unfilled; 1, filled; omitted/nil, filled |
| Returnvalues: |
| integer retval | - | unknown; usually 0 |
^
gfx.recttoFunctioncall:
Lua: integer x_coordinate = gfx.rectto(integer x, integer y)
Description:Fills a rectangle from gfx.x,gfx.y to x,y. Updates gfx.x,gfx.y to x,y.
| Parameters: |
| integer x | - | the x-coordinate, to which the rectangle shall be drawn to |
| integer y | - | the y-coordinate, to which the rectangle shall be drawn to |
| Returnvalues: |
| integer x_coordinate | - | the x-coordinate given as x-parameter; the purpose is unknown |
^
gfx.roundrectFunctioncall:
Lua: integer retval = gfx.roundrect(integer x, integer y, integer w, integer h, number radius, optional integer antialias)
Description:Draws a rectangle with rounded corners.
| Parameters: |
| integer x | - | the x-coordinate of the upper-left corner of the rectangle in pixels |
| integer y | - | the y-coordinate of the upper-left corner of the rectangle in pixels |
| integer w | - | the width of the rectangle in pixels |
| integer h | - | the height of the rectangle in pixels |
| number radius | - | the radius of the rounded corners of the rectangle; 0, for a normal rectangle; |
| number antialias | - | 0, no antialias; 1 and higher, apply antialias to the rectangle |
| Returnvalues: |
| integer retval | - | unknown |
^
gfx.screentoclientFunctioncall:
Lua: integer convx, integer convy = gfx.screentoclient(integer x, integer y)
Description:Converts the screen coordinates x,y to client coordinates, returns those values.
| Parameters: |
| integer x | - | the x-screen-coordinate that shall be converted, in pixels |
| integer y | - | the y-screen-coordinate that shall be converted, in pixels |
| Returnvalues: |
| integer convx | - | the x-client-coordinate, as converted from the x-screen-coordinate, in pixels |
| integer convy | - | the y-client-coordinate, as converted from the y-screen-coordinate, in pixels |
^
gfx.setFunctioncall:
Lua: integer retval = gfx.set(number r, optional number g, optional number b, optional number a2, optional integer mode, optional integer dest)
Description:Sets color, drawing mode and optionally the drawing-image-source-destination.
If sets the corresponding gfx-variables.
Sets gfx.r/gfx.g/gfx.b/gfx.a2/gfx.mode sets gfx.dest if final parameter specified
| Parameters: |
| number r | - | the red-value; 0 to 1; if only parameter r is given, it's value will be used for g, b as well |
| optional number g | - | the green-value; 0 to 1 |
| optional number b | - | the blue-value; 0 to 1 |
| optional number a2 | - | the alpha-value; 0 to 1 |
| optional integer mode | - | the drawing-mode; Set to 0 for default options. Add 1.0 for additive blend mode (if you wish to do subtractive, set gfx.a to negative and use gfx.mode as additive). Add 2.0 to disable source alpha for gfx.blit(). Add 4.0 to disable filtering for gfx.blit(). |
| optional integer dest | - | the source-image/framebuffer to draw to; -1 to 1023; -1 for the currently displayed framebuffer. |
| Returnvalues: |
| integer retval | - | unknown |
^
gfx.setcursorFunctioncall:
Lua: gfx.setcursor(resource_id,custom_cursor_name)
Description:Sets the mouse cursor. resource_id is a value like 32512 (for an arrow cursor), custom_cursor_name is a string like "arrow" (for the REAPER custom arrow cursor). resource_id must be nonzero, but custom_cursor_name is optional.
| Parameters: |
| resource_id | - | |
| custom_cursor_name | - | |
^
gfx.setfontFunctioncall:
Lua: gfx.setfont(integer idx,optional string fontface, optional integer sz, optional integer flags)
Description:Can select a font and optionally configure it.
After calling gfx_setfont(), gfx_texth may be updated to reflect the new average line height.
| Parameters: |
| integer idx | - | the font-id; idx=0 for default bitmapped font, no configuration is possible for this font. idx=1..16 for a configurable font |
| optional string fontface | - | the name of the font, like "arial" |
| optional integer sz | - | the size of the font (8-100) |
| optional integer flags | - | flags, how to render the text; up to 4 flags can be passed at the same time a multibyte character, which can include 'i' for italics, 'u' for underline, or 'b' for bold. These flags may or may not be supported depending on the font and OS. 66 and 98, Bold (B), (b) 73 and 105, italic (I), (i) 79 and 111, white outline (O), (o) 82 and 114, blurred (R), (r) 83 and 115, sharpen (S), (s) 85 and 117, underline (U), (u) 86 and 118, inVerse (V), (v) To create such a multibyte-character, assume this flag-value as a 32-bit-value. The first 8 bits are the first flag, the next 8 bits are the second flag, the next 8 bits are the third flag and the last 8 bits are the second flag. The flagvalue(each dot is a bit): .... .... .... .... .... .... .... .... If you want to set it to Bold(B) and Italic(I), you use the ASCII-Codes of both(66 and 73 respectively), take them apart into bits and set them in this 32-bitfield. The first 8 bits will be set by the bits of ASCII-value 66(B), the second 8 bits will be set by the bits of ASCII-Value 73(I). The resulting flagvalue is: 0100 0010 1001 0010 0000 0000 0000 0000 which is a binary representation of the integer value 18754, which combines 66 and 73 in it. |
^
gfx.setimgdimFunctioncall:
Lua: integer retval = gfx.setimgdim(integer image, integer w, integer h)
Description:Resize image referenced by index 0..1024-1, width and height must be 0-8192. The contents of the image will be undefined after the resize.
| Parameters: |
| integer image | - | the image-handle/framebuffer, whose dimensions you want to set |
| integer w | - | the new width of the image-handle |
| integer h | - | the new height of the image-handle |
| Returnvalues: |
| integer retval | - | 0, if image couldn't be set(e.g. no such handle exists); 1, if setting new dimensions was successful |
^
gfx.setpixelFunctioncall:
Lua: integer retval = gfx.setpixel(number r, number g, number b)
Description:Writes a pixel of r,g,b to gfx.x,gfx.y.
| Parameters: |
| number r | - | the red-color-value of the pixel; 0-1 |
| number g | - | the green-color-value of the pixel; 0-1 |
| number b | - | the blue-color-value of the pixel; 0-1 |
| Returnvalues: |
| integer retval | - | 1, if writing that pixel was successful; -1, is not |
^
gfx.showmenuFunctioncall:
Lua: integer selection = gfx.showmenu(string str)
Description:Shows a popup menu at gfx.x,gfx.y. str is a list of fields separated by | characters.
Each field represents a menu item. Fields can start with special characters:#, grayed out; !, checked; >, this menu item shows a submenu;>, last item in the current submenu.
An empty field will appear as a separator in the menu.
Example: selection = gfx.showmenu("first item, followed by separator||!second item, checked|>third item which spawns a submenu|#first item in submenu, grayed out|>second and last item in submenu|fourth item in top menu")
gfx.showmenu returns 0 if the user selected nothing from the menu, 1 if the first field is selected, etc.
| Parameters: |
| string str | - | a string with the menu-entries; separate the entrynames with a | Each menu-entry can start with special characters that influence the appearance of that entry: #, item is grayed out; !, item is checked; >, this menu item shows a submenu;<, last item in the current submenu. |
| Returnvalues: |
| integer selection | - | the menu-entry the user selected, with 1 for the first, 2 for the second, etc; 0, nothing was selected |
^
gfx.transformblitFunctioncall:
Lua: gfx.transformblit(integer srcimg, integer destx, integer desty, integer destw, integer desth, integer div_w, integer div_h, table table)
Description:Blits to destination at (destx,desty), size (destw,desth). div_w and div_h should be 2..64, and table should point to a table of 2*div_w*div_h values (table can be a regular table or (for less overhead) a reaper.array). Each pair in the table represents a S,T coordinate in the source image, and the table is treated as a left-right, top-bottom list of texture coordinates, which will then be rendered to the destination.
| Parameters: |
| integer srcimg | - | the image-index (1 to 1024) that you want to blit into the screenbuffer -1 |
| integer destx | - | x position of the blit picture |
| integer desty | - | y position of the blit picture |
| integer destw | - | width of the blit picture |
| integer desth | - | height of the blit picture |
| integer div_w | - | unknown, 2 to 64; probably related to parameter table |
| integer div_h | - | unknown, 2 to 64; probably related to parameter table |
| table table | - | a table of the texture coordinates, with each entry being set to a pair of value, eg: 1, 0. Will be read from left to right and from top to bottom. table[1]=1,2 table[2]=2,3 table[3]=3,1 How these values work needs more research... |
^
gfx.triangleFunctioncall:
Lua: gfx.triangle(integer x1, integer y1, integer x2, integer y2, integer x3, integer y3, [optional integer x4, optional integer y4, ...)
Description:Draws a filled triangle, or any convex polygon.
| Parameters: |
| integer x1 | - | the x-position of the first point of the polygon |
| integer y1 | - | the y-position of the first point of the polygon |
| integer x2 | - | the x-position of the second point of the polygon |
| integer y2 | - | the y-position of the second point of the polygon |
| integer x3 | - | the x-position of the third point of the polygon |
| integer y3 | - | the y-position of the third point of the polygon |
| optional integer x4 | - | the x-position of the fourth point of the polygon |
| optional integer y4 | - | the y-position of the fourth point of the polygon ... ... |
^
gmem_attachFunctioncall:
Lua: string former_attached_gmemname = reaper.gmem_attach(string sharedMemoryName)
Description:Causes gmem_read()/gmem_write() to read EEL2/JSFX/Video shared memory segment named by parameter. Set to empty string to detach. 6.20+: returns previous shared memory segment name.
Must be called, before you can use a specific gmem-variable-index with gmem_write!
| Parameters: |
| string sharedMemoryName | - | the name of the shared memory |
| Returnvalues: |
| string former_attached_gmemname | - | if you change the attached-gmem from one to a new one, this will hold the name of the previous attached shared memory(gmem) |
^
gmem_readFunctioncall:
Lua: number retval = reaper.gmem_read(integer index)
Description:Read (number) value from shared memory attached-to by gmem_attach(). index can be [0..1<<25).
returns nil if not available
| Parameters: |
| integer index | - | the index of the memory-variable to read from; index must be 0 and higher |
| Returnvalues: |
| number retval | - | the stored number-value stored in gmem-variable with index |
^
gmem_writeFunctioncall:
Lua: reaper.gmem_write(integer index, number value)
Description:Write (number) value to shared memory attached-to by gmem_attach(). index can be [0..1<<25).
Before you can write into a currently unused variable with index "index", you must call
gmem_attach first!
| Parameters: |
| integer index | - | the index of the memory-variable to write to; index must be 0 and higher
|
| number value | - | a number, either integer or float
|
^
gfx.updateFunctioncall:
Description:Updates the graphics display, if opened
^
new_arrayFunctioncall:
Lua: ReaperArray reaper_array = reaper.new_array([table|array], [size])
Description:Creates a new reaper.array object of maximum and initial size size, if specified, or from the size/values of a table/array. Both size and table/array can be specified, the size parameter will override the table/array size.
| Parameters: |
| table|array | - | |
| size | - | |
| Returnvalues: |
| reaper_array | - | |
^
runloopFunctioncall:
Lua: boolean retval = reaper.runloop(function function)
Description:Adds code to be called back by REAPER. Used to create persistent ReaScripts that continue to run and respond to input, while the user does other tasks. Identical to defer().Note that no undo point will be automatically created when the script finishes, unless you create it explicitly.
| Parameters: |
| function function | - | the function to be called |
| Returnvalues: |
| int retval | - | true, if succeded |
^
{reaper.array}.clearFunctioncall:
Lua: boolean retval = {reaper.array}.clear([value, offset, size])
Description:Sets the value of zero or more items in the array. If value not specified, 0.0 is used. offset is 1-based, if size omitted then the maximum amount available will be set.
| Parameters: |
| value | - | |
| offset | - | |
| size | - | |
^
{reaper.array}.convolveFunctioncall:
Lua: integer retval = {reaper.array}.convolve([src, srcoffs, size, destoffs])
Description:Convolves complex value pairs from reaper.array, starting at 1-based srcoffs, reading/writing to 1-based destoffs. size is in normal items (so it must be even)
| Parameters: |
| src | - | |
| scroffs | - | |
| size | - | |
| destoffs | - | |
^
{reaper.array}.copyFunctioncall:
Lua: integer retval = {reaper.array}.copy([src, srcoffs, size, destoffs])
Description:Copies values from reaper.array or table, starting at 1-based srcoffs, writing to 1-based destoffs.
| Parameters: |
| src | - | |
| srcoffs | - | |
| size | - | |
| destoffs | - | |
^
{reaper.array}.fftFunctioncall:
Lua: {reaper.array}.fft(size[, permute, offset])
Description:Performs a forward FFT of size. size must be a power of two between 4 and 32768 inclusive. If permute is specified and true, the values will be shuffled following the FFT to be in normal order.
| Parameters: |
| size | - | |
| premute | - | |
| offset | - | |
^
{reaper.array}.fft_realFunctioncall:
Lua: {reaper.array}.fft_real(size[, permute, offset])
Description:Performs a forward real->complex FFT of size. size must be a power of two between 4 and 32768 inclusive. If permute is specified and true, the values will be shuffled following the FFT to be in normal order.
| Parameters: |
| size | - | |
| premute | - | |
| offset | - | |
^
{reaper.array}.get_allocFunctioncall:
Lua: integer size = {reaper.array}.get_alloc()
Description:Returns the maximum (allocated) size of the array.
^
{reaper.array}.ifftFunctioncall:
Lua: {reaper.array}.ifft(size[, permute, offset])
Description:Performs a backwards FFT of size. size must be a power of two between 4 and 32768 inclusive. If permute is specified and true, the values will be shuffled before the IFFT to be in fft-order.
| Parameters: |
| size | - | |
| permute | - | |
| offset | - | |
^
{reaper.array}.ifft_realFunctioncall:
Lua: {reaper.array}.ifft_real(size[, permute, offset])
Description:Performs a backwards complex->real FFT of size. size must be a power of two between 4 and 32768 inclusive. If permute is specified and true, the values will be shuffled before the IFFT to be in fft-order.
| Parameters: |
| size | - | |
| permute | - | |
| offset | - | |
^
{reaper.array}.multiplyFunctioncall:
Lua: {reaper.array}.multiply([src, srcoffs, size, destoffs])
Description:Multiplies values from reaper.array, starting at 1-based srcoffs, reading/writing to 1-based destoffs.
| Parameters: |
| src | - | |
| srcoffs | - | |
| size | - | |
| destoff | - | |
^
{reaper.array}.resizeFunctioncall:
Lua: {reaper.array}.resize(size)
Description:Resizes an array object to size. size must be [0..max_size].
^
{reaper.array}.tableFunctioncall:
Lua: {reaper.array}.table([offset, size])
Description:Returns a new table with values from items in the array. Offset is 1-based and if size is omitted all available values are used.
| Parameters: |
| offset | - | |
| size | - | |
^
atexitFunctioncall:
Python: RPR_atexit(String code)
Description:Adds code to be executed when the script finishes or is ended by the user. Typically used to clean up after the user terminates defer() or runloop() code.
| Parameters: |
| String code | - | |
^
deferFunctioncall:
Python: RPR_defer(String code)
Description:Adds code to be called back by REAPER. Used to create persistent ReaScripts that continue to run and respond to input, while the user does other tasks. Identical to runloop().
Note that no undo point will be automatically created when the script finishes, unless you create it explicitly.
^
runloopFunctioncall:
Python: RPR_runloop(String code)
Description:Adds code to be called back by REAPER. Used to create persistent ReaScripts that continue to run and respond to input, while the user does other tasks. Identical to defer().
Note that no undo point will be automatically created when the script finishes, unless you create it explicitly.
^
__mergesortFunctioncall:
C: void (*__mergesort)(void* base, size_t nmemb, size_t size, int (*cmpfunc)(const void*,const void*), void* tmpspace)
Description:is a stable sorting function with an API similar to qsort().
HOWEVER, it requires some temporary space, equal to the size of the data being sorted, so you can pass it as the last parameter,
or NULL and it will allocate and free space internally.
| Parameters: |
| base | - | |
| nmemb | - | |
| size | - | |
| *cmpfunc | - | |
| tmpspace | - | |
^
AddCustomizableMenuFunctioncall:
C: bool (*AddCustomizableMenu)(const char* menuidstr, const char* menuname, const char* kbdsecname, bool addtomainmenu)
Description:Adds customizable menu.
| Parameters: |
| menuidstr | - | is some unique identifying string |
| menuname | - | is for main menus only (displayed in a menu bar somewhere), NULL otherwise |
| kbdsecname | - | is the name of the KbdSectionInfo registered by this plugin, or NULL for the main actions section |
| addtomainmenu | - | true, add to main menu; false, don't add to main menu |
^
AddExtensionsMainMenuFunctioncall:
C: bool (*AddExtensionsMainMenu)()
Description:
^
plugin_registerFunctioncall:
C: int (*plugin_register)(const char* name, void* infostruct)
Description:like rec->Register
if you have a function called myfunction(..) that you want to expose to other extensions or plug-ins, use register("API_myfunction",funcaddress), and "-API_myfunction" to remove. Other extensions then use GetFunc("myfunction") to get the function pointer.
REAPER will also export the function address to ReaScript, so your extension could supply a Python module that provides a wrapper called RPR_myfunction(..).
register("APIdef_myfunction",defstring) will include your function declaration and help in the auto-generated REAPER API header and ReaScript documentation.
defstring is four null-separated fields: return type, argument types, argument names, and help.
Example: double myfunction(char* str, int flag) would have defstring="double\0char*,int\0str,flag\0help text for myfunction"
another thing you can register is "hookcommand", which you pass a callback:
NON_API: bool runCommand(int command, int flag);
register("hookcommand",runCommand);
which returns TRUE to eat (process) the command.
flag is usually 0 but can sometimes have useful info depending on the message.
note: it's OK to call Main_OnCommand() within your runCommand, however you MUST check for recursion if doing so!
in fact, any use of this hook should benefit from a simple reentrancy test...
to get notified when an action of the main section is performed, you can register "hookpostcommand", which you pass a callback:
NON_API: void postCommand(int command, int flag);
register("hookpostcommand",postCommand);
you can also register "hookcommand2", which you pass a callback:
NON_API: bool onAction(KbdSectionInfo *sec, int command, int val, int valhw, int relmode, HWND hwnd);
register("hookcommand2",onAction);
which returns TRUE to eat (process) the command.
val/valhw are used for actions learned with MIDI/OSC.
val = \[0..127\] and valhw = -1 for MIDI CC,
valhw >=0 for MIDI pitch or OSC with value = (valhw|val<<7)/16383.0,
relmode absolute(0) or 1/2/3 for relative adjust modes
you can also register command IDs for actions, register with "command_id", parameter is a unique string with only A-Z, 0-9, returns command ID (or 0 if not supported/out of actions)
register("command_id_lookup", unique_string) will look up the integer ID of the named action without registering the string if it doesn't already exist.
| Parameters: |
| name | - | |
| infostruct | - | |
^
Audio_RegHardwareHookFunctioncall:
C: int (*Audio_RegHardwareHook)(bool isAdd, audio_hook_register_t* reg)
Description:Registers Audio Hardware-Hook.
| Parameters: |
| isAdd | - | |
| reg | - | |
^
CalculatePeaksFunctioncall:
C: int (*CalculatePeaks)(PCM_source_transfer_t* srcBlock, PCM_source_peaktransfer_t* pksBlock)
Description:Calculates Peaks.
| Parameters: |
| srcBlock | - | |
| pksBlock | - | |
^
CalculatePeaksFloatSrcPtrFunctioncall:
C: int (*CalculatePeaksFloatSrcPtr)(PCM_source_transfer_t* srcBlock, PCM_source_peaktransfer_t* pksBlock)
Description:Calculates Peaks.
| Parameters: |
| srcBlock | - | |
| pksBlock | - | |
^
CountActionShortcutsFunctioncall:
C: int (*CountActionShortcuts)(KbdSectionInfo* section, int cmdID)
Description:
| Parameters: |
| section | - | the section, in which the action lies 0, Main 100, Main (alt recording) 32060, MIDI Editor 32061, MIDI Event List Editor 32062, MIDI Inline Editor 32063, Media Explorer
|
| cmdID | - | the commandID of the action, whose count of shortcuts you want to know.
|
^
CreateLocalOscHandlerFunctioncall:
C: void* (*CreateLocalOscHandler)(void* obj, void* callback)
Description:callback is a function pointer: void (*callback)(void* obj, const char* msg, int msglen), which handles OSC messages sent from REAPER. The function return is a local osc handler. See
SendLocalOscMessage,
DestroyOscHandler.
| Parameters: |
| obj | - |
|
| callback | - |
|
^
CreateMIDIInputFunctioncall:
C: midi_Input* (*CreateMIDIInput)(int dev)
Description:Can only reliably create midi access for devices not already opened in prefs/MIDI, suitable for control surfaces etc.
| Returnvalues: |
| midi_Input* | - | |
^
CreateMIDIOutputFunctioncall:
C: midi_Output* (*CreateMIDIOutput)(int dev, bool streamMode, int* msoffset100)
Description:Can only reliably create midi access for devices not already opened in prefs/MIDI, suitable for control surfaces etc.
| Parameters: |
| dev | - | |
| streamMode | - | true, msoffset points to a persistent variable(see msoffset100 for more details) |
| int* msoffset100 | - | points to a persistent variable that can change and reflects added delay to output in 100ths of a millisecond. |
| Returnvalues: |
| midi_Output* | - | |
^
CSurf_OnOscControlMessageFunctioncall:
C: void (*CSurf_OnOscControlMessage)(const char* msg, const float* arg)
Description:On OSC Control Message.
^
DeleteActionShortcutFunctioncall:
C: bool (*DeleteActionShortcut)(KbdSectionInfo* section, int cmdID, int shortcutidx)
Description:
| Parameters: |
| section | - | the section, to which this action belongs to 0, Main 100, Main (alt recording) 32060, MIDI Editor 32061, MIDI Event List Editor 32062, MIDI Inline Editor 32063, Media Explorer
|
| cmdID | - | the commandID for the shortcut to be deleted
|
| shortcutidx | - | the shortcut to be deleted
|
^
DestroyLocalOscHandlerFunctioncall:
C: void (*DestroyLocalOscHandler)(void* local_osc_handler)
Description:
| Parameters: |
| local_osc_handler | - |
|
^
DoActionShortcutDialogFunctioncall:
C: bool (*DoActionShortcutDialog)(HWND hwnd, KbdSectionInfo* section, int cmdID, int shortcutidx)
Description:
| Parameters: |
| section | - |
|
| cmdID | - |
|
| shortcutidx | - |
|
^
DuplicateCustomizableMenuFunctioncall:
C: bool (*DuplicateCustomizableMenu)(void* srcmenu, void* destmenu)
Description:Populate destmenu with all the entries and submenus found in srcmenu.
| Parameters: |
| srcmenu | - | |
| destmenu | - | |
^
FreeHeapPtrFunctioncall:
C: void (*FreeHeapPtr)(void* ptr)
Description:free heap memory returned from a Reaper API function
^
get_config_varFunctioncall:
C: void* (*get_config_var)(const char* name, int* szOut)
Description:
| Parameters: |
| name | - |
|
| szOut | - |
|
^
get_midi_config_varFunctioncall:
C: void* (*get_midi_config_var)(const char* name, int* szOut);
Description:Deprecated.
| Parameters: |
| name | - | |
| szOut | - | |
^
GetActionShortcutDescFunctioncall:
C: bool (*GetActionShortcutDesc)(KbdSectionInfo* section, int cmdID, int shortcutidx, char* desc, int desclen)
Description:
| Parameters: |
| section | - | the section of the action 0, Main 100, Main (alt recording) 32060, MIDI Editor 32061, MIDI Event List Editor 32062, MIDI Inline Editor 32063, Media Explorer
|
| cmdID | - | the commandID of the action, whose shortcut-description you want.
|
| shortcutidx | - |
|
| desc | - |
|
| descclean | - |
|
^
GetColorThemeFunctioncall:
C: INT_PTR (*GetColorTheme)(int idx, int defval)
Description:
| Parameters: |
| idx | - |
|
| defval | - |
|
^
GetColorThemeStructFunctioncall:
C: void* (*GetColorThemeStruct)(int* szOut)
Description:returns the whole color theme (icontheme.h) and the size
^
GetContextMenuFunctioncall:
C: HMENU (*GetContextMenu)(int idx)
Description:gets context menus. submenu 0:trackctl, 1:mediaitems, 2:ruler, 3:empty track area
^
GetIconThemePointerFunctioncall:
C: void* (*GetIconThemePointer)(const char* name)
Description:returns a named icontheme entry
^
GetIconThemePointerForDPIFunctioncall:
C: void* (*GetIconThemePointerForDPI)(const char* name, int dpisc);
Description:returns a named icontheme entry for a given DPI-scaling (256=1:1).
Note: the return value should not be stored, it should be queried at each paint!
Querying name=NULL returns the start of the structure
| Parameters: |
| name | - | |
| dpisc | - | |
^
GetIconThemeStructFunctioncall:
C: void* (*GetIconThemeStruct)(int* szOut)
Description:returns a pointer to the icon theme (icontheme.h) and the size of that struct.
^
GetPeaksBitmapFunctioncall:
C: void* (*GetPeaksBitmap)(PCM_source_peaktransfer_t* pks, double maxamp, int w, int h, LICE_IBitmap* bmp)
Description:See note in reaper_plugin.h about PCM_source_peaktransfer_t::samplerate
| Parameters: |
| pks | - | |
| maxamp | - | |
| w | - | |
| h | - | |
| bmp | - | |
^
GetPreferredDiskReadModeFunctioncall:
C: void (*GetPreferredDiskReadMode)(int* mode, int* nb, int* bs)
Description:Gets user configured preferred disk read mode. mode/nb/bs are all parameters that should be passed to WDL_FileRead, see for more information.
| Parameters: |
| mode | - | |
| nb | - | |
| bs | - | |
^
GetPreferredDiskReadModePeakFunctioncall:
C: void (*GetPreferredDiskReadModePeak)(int* mode, int* nb, int* bs)
Description:Gets user configured preferred disk read mode for use when building peaks. mode/nb/bs are all parameters that should be passed to WDL_FileRead, see for more information.
| Parameters: |
| mode | - | |
| nb | - | |
| bs | - | |
^
GetPreferredDiskWriteModeFunctioncall:
C: void (*GetPreferredDiskWriteMode)(int* mode, int* nb, int* bs)
Description:Gets user configured preferred disk write mode. nb will receive two values, the initial and maximum write buffer counts. mode/nb/bs are all parameters that should be passed to WDL_FileWrite, see for more information.
| Parameters: |
| mode | - | |
| nb | - | |
| bs | - | |
^
GetSetMediaItemTakeInfoFunctioncall:
C: void* (*GetSetMediaItemTakeInfo)(MediaItem_Take* tk, const char* parmname, void* setNewValue)
Description:Gets/Sets Media Item Take-parameters. Works like GetMediaItemTakeInfo_Value and SetMediaItemTakeInfo_Value but has more parameters.
| Parameters: |
| tk | - | a MediaItem_Take-object, that shall be altered |
| parmname | - | the name of the parameter to be changed P_TRACK : pointer to MediaTrack (read-only) P_ITEM : pointer to MediaItem (read-only) P_SOURCE : PCM_source *. Note that if setting this, you should first retrieve the old source, set the new, THEN delete the old. GUID : GUID * : 16-byte GUID, can query or update P_NAME : char * to take name D_STARTOFFS : double *, start offset in take of item D_VOL : double *, take volume D_PAN : double *, take pan D_PANLAW : double *, take pan law (-1.0=default, 0.5=-6dB, 1.0=+0dB, etc) D_PLAYRATE : double *, take playrate (1.0=normal, 2.0=doublespeed, etc) D_PITCH : double *, take pitch adjust (in semitones, 0.0=normal, +12 = one octave up, etc) B_PPITCH, bool *, preserve pitch when changing rate I_CHANMODE, int *, channel mode (0=normal, 1=revstereo, 2=downmix, 3=l, 4=r) I_PITCHMODE, int *, pitch shifter mode, -1=proj default, otherwise high word=shifter low word = parameter I_CUSTOMCOLOR : int *, custom color, OS dependent color|0x100000 (i.e. ColorToNative(r,g,b)|0x100000). If you do not |0x100000, then it will not be used (though will store the color anyway). IP_TAKENUMBER : int, take number within the item (read-only, returns the take number directly) |
| setNewValue | - | the new value to be set to the parameter. See the description of parmname above for more details. |
^
GetSetMediaTrackInfoFunctioncall:
C: void* (*GetSetMediaTrackInfo)(MediaTrack* tr, const char* parmname, void* setNewValue)
Description:Gets/Sets MediaTrack-parameters. Works like GetMediaTrackInfo_Value and SetMediaTrackInfo_Value but has more parameters.
| Parameters: |
| tr | - | the Mediatrack-object, that shall be modified |
| parmname | - | the parameter to be gotten or set P_PARTRACK : MediaTrack * : parent track (read-only) P_PROJECT : ReaProject * : parent project (read-only) P_NAME : char * : track name (on master returns NULL) P_ICON : const char * : track icon (full filename, or relative to resource_path/data/track_icons) P_MCP_LAYOUT : const char * : layout name P_RAZOREDITS : const char * : list of razor edit areas, as space-separated triples of start time, end time, and envelope GUID string. Example: "0.00 1.00 \"\" 0.00 1.00 "{xyz-...}" P_TCP_LAYOUT : const char * : layout name P_EXT:xyz : char * : extension-specific persistent data GUID : GUID * : 16-byte GUID, can query or update. If using a _String() function, GUID is a string {xyz-...}. B_MUTE : bool * : muted B_PHASE : bool * : track phase inverted B_RECMON_IN_EFFECT : bool * : record monitoring in effect (current audio-thread playback state, read-only) IP_TRACKNUMBER : int : track number 1-based, 0=not found, -1=master track (read-only, returns the int directly) I_SOLO : int * : soloed, 0=not soloed, 1=soloed, 2=soloed in place, 5=safe soloed, 6=safe soloed in place I_FXEN : int * : fx enabled, 0=bypassed, !0=fx active I_RECARM : int * : record armed, 0=not record armed, 1=record armed I_RECINPUT : int * : record input, <0=no input. if 4096 set, input is MIDI and low 5 bits represent channel (0=all, 1-16=only chan), next 6 bits represent physical input (63=all, 62=VKB). If 4096 is not set, low 10 bits (0..1023) are input start channel (ReaRoute/Loopback start at 512). If 2048 is set, input is multichannel input (using track channel count), or if 1024 is set, input is stereo input, otherwise input is mono. I_RECMODE : int * : record mode, 0=input, 1=stereo out, 2=none, 3=stereo out w/latency compensation, 4=midi output, 5=mono out, 6=mono out w/ latency compensation, 7=midi overdub, 8=midi replace I_RECMON : int * : record monitoring, 0=off, 1=normal, 2=not when playing (tape style) I_RECMONITEMS : int * : monitor items while recording, 0=off, 1=on I_AUTOMODE : int * : track automation mode, 0=trim/off, 1=read, 2=touch, 3=write, 4=latch I_NCHAN : int * : number of track channels, 2-64, even numbers only I_SELECTED : int * : track selected, 0=unselected, 1=selected I_WNDH : int * : current TCP window height in pixels including envelopes (read-only) I_TCPH : int * : current TCP window height in pixels not including envelopes (read-only) I_TCPY : int * : current TCP window Y-position in pixels relative to top of arrange view (read-only) I_MCPX : int * : current MCP X-position in pixels relative to mixer container I_MCPY : int * : current MCP Y-position in pixels relative to mixer container I_MCPW : int * : current MCP width in pixels I_MCPH : int * : current MCP height in pixels I_FOLDERDEPTH : int * : folder depth change, 0=normal, 1=track is a folder parent, -1=track is the last in the innermost folder, -2=track is the last in the innermost and next-innermost folders, etc I_FOLDERCOMPACT : int * : folder compacted state (only valid on folders), 0=normal, 1=small, 2=tiny children I_MIDIHWOUT : int * : track midi hardware output index, <0=disabled, low 5 bits are which channels (0=all, 1-16), next 5 bits are output device index (0-31) I_PERFFLAGS : int * : track performance flags, &1=no media buffering, &2=no anticipative FX I_CUSTOMCOLOR : int * : custom color, OS dependent color|0x100000 (i.e. ColorToNative(r,g,b)|0x100000). If you do not |0x100000, then it will not be used, but will store the color I_HEIGHTOVERRIDE : int * : custom height override for TCP window, 0 for none, otherwise size in pixels B_HEIGHTLOCK : bool * : track height lock (must set I_HEIGHTOVERRIDE before locking) D_VOL : double * : trim volume of track, 0=-inf, 0.5=-6dB, 1=+0dB, 2=+6dB, etc D_PAN : double * : trim pan of track, -1..1 D_WIDTH : double * : width of track, -1..1 D_DUALPANL : double * : dualpan position 1, -1..1, only if I_PANMODE==6 D_DUALPANR : double * : dualpan position 2, -1..1, only if I_PANMODE==6 I_PANMODE : int * : pan mode, 0=classic 3.x, 3=new balance, 5=stereo pan, 6=dual pan D_PANLAW : double * : pan law of track, <0=project default, 1=+0dB, etc P_ENV:<envchunkname or P_ENV:{GUID... : TrackEnvelope*, read only. chunkname can be <VOLENV, <PANENV, etc; GUID is the stringified envelope GUID. B_SHOWINMIXER : bool * : track control panel visible in mixer (do not use on master track) B_SHOWINTCP : bool * : track control panel visible in arrange view (do not use on master track) B_MAINSEND : bool * : track sends audio to parent C_MAINSEND_OFFS : char * : channel offset of track send to parent B_FREEMODE : bool * : track free item positioning enabled (call UpdateTimeline() after changing) C_BEATATTACHMODE : char * : track timebase, -1=project default, 0=time, 1=beats (position, length, rate), 2=beats (position only) F_MCP_FXSEND_SCALE : float * : scale of fx+send area in MCP (0=minimum allowed, 1=maximum allowed) F_MCP_FXPARM_SCALE : float * : scale of fx parameter area in MCP (0=minimum allowed, 1=maximum allowed) F_MCP_SENDRGN_SCALE : float * : scale of send area as proportion of the fx+send total area (0=minimum allowed, 1=maximum allowed) F_TCP_FXPARM_SCALE : float * : scale of TCP parameter area when TCP FX are embedded (0=min allowed, default, 1=max allowed) I_PLAY_OFFSET_FLAG : int * : track playback offset state, &1=bypassed, &2=offset value is measured in samples (otherwise measured in seconds) D_PLAY_OFFSET : double * : track playback offset, units depend on I_PLAY_OFFSET_FLAG |
| setNewValue | - | the new value. See the description of parmname above for more details |
^
GetSetObjectStateFunctioncall:
C: char* (*GetSetObjectState)(void* obj, const char* str)
Description:get or set the state of a {track,item,envelope} as an RPPXML chunk
str="" to get the chunk string returned (must call FreeHeapPtr when done)
supply str to set the state (returns zero)
| Parameters: |
| obj | - | the object, to be modified. Can be MediaItem, TrackEnvelope, MediaTrack.
|
| str | - | supply str to set the state (returns zero); str="" to get the chunk string returned (must call FreeHeapPtr when done)
|
^
GetSetObjectState2Functioncall:
C: char* (*GetSetObjectState2)(void* obj, const char* str, bool isundo)
Description:get or set the state of a {track,item,envelope} as an RPPXML chunk
| Parameters: |
| obj | - | the object, to be modified. Can be MediaItem, TrackEnvelope, MediaTrack. |
| str | - | supply str to set the state (returns zero); str="" to get the chunk string returned (must call FreeHeapPtr when done) |
| isundo | - | set, if the state will be used for undo purposes (which may allow REAPER to get the state more efficiently |
^
GetSetTrackMIDISupportFileFunctioncall:
C: const char* (*GetSetTrackMIDISupportFile)(ReaProject* proj, MediaTrack* track, int which, const char* filename)
Description:Get or set the filename for storage of the MIDI bank/program select file.
"which" must be 1.
If fn != NULL, a new track MIDI storage file will be set; otherwise the existing track MIDI storage file will be returned.
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| track | - | the MediaTrack-object of the track to be treated
|
| which | - | thich MIDI-file to use 0, MIDI colormap image file, 1, MIDI bank/program select file, 2, MIDI text string file, 3, MIDI note mapping file.
|
| filename | - | If fn != NULL, a new track MIDI storage file will be set; otherwise the existing track MIDI storage file will be returned.
|
^
GetSetTrackSendInfoFunctioncall:
C: void* (*GetSetTrackSendInfo)(MediaTrack* tr, int category, int sendidx, const char* parmname, void* setNewValue)
Description:Get or set send/receive/hardware output attributes.
For ReaRoute-users: the outputs are hardware outputs, but with 512 added to the destination channel index (512 is the first rearoute channel, 513 the second, etc).
| Parameters: |
| tr | - | the MediaTrack object for the track to be gotten or set |
| category | - | <0 for receives, 0=sends, >0 for hardware outputs |
| sendidx | - | 0..n (to enumerate, iterate over sendidx until it returns NULL) |
| parmname | - | the parameter to get/set P_DESTTRACK : read only, returns MediaTrack *, destination track, only applies for sends/recvs P_SRCTRACK : read only, returns MediaTrack *, source track, only applies for sends/recvs P_ENV : read only, returns TrackEnvelope *, setNewValue=<VOLENV, <PANENV, etc B_MUTE : returns bool * B_PHASE : returns bool *, true to flip phase B_MONO : returns bool * D_VOL : returns double *, 1.0 = +0dB etc D_PAN : returns double *, -1..+1 D_PANLAW : returns double *,1.0=+0.0db, 0.5=-6dB, -1.0 = projdef etc I_SENDMODE : returns int *, 0=post-fader, 1=pre-fx, 2=post-fx (deprecated), 3=post-fx I_AUTOMODE : returns int * : automation mode (-1=use track automode, 0=trim/off, 1=read, 2=touch, 3=write, 4=latch) I_SRCCHAN : returns int *, index,&1024=mono, -1 for none I_DSTCHAN : returns int *, index, &1024=mono, otherwise stereo pair, hwout:&512=rearoute I_MIDIFLAGS : returns int *, low 5 bits=source channel 0=all, 1-16, next 5 bits=dest channel, 0=orig, 1-16=chan |
| setNewValue | - | the new value to be set |
^
GetToggleCommandStateThroughHooksFunctioncall:
C: int (*GetToggleCommandStateThroughHooks)(KbdSectionInfo* section, int command_id)
Description:Returns the state of an action via extension plugins' hooks.
| Parameters: |
| section | - | the section, in which the action appears in 0, Main 100, Main (alt recording) 32060, MIDI Editor 32061, MIDI Event List Editor 32062, MIDI Inline Editor 32063, Media Explorer |
| command_id | - | the command-id of the action, whose state you want |
^
HiresPeaksFromSourceFunctioncall:
C: void (*HiresPeaksFromSource)(PCM_source* src, PCM_source_peaktransfer_t* block)
Description:Hires peaks from source.
| Parameters: |
| src | - | |
| block | - | |
^
IsInRealTimeAudioFunctioncall:
C: int (*IsInRealTimeAudio)()
Description:Are we in a realtime audio thread (between OnAudioBuffer calls,not in some worker/anticipative FX thread)? threadsafe
^
IsItemTakeActiveForPlaybackFunctioncall:
C: bool (*IsItemTakeActiveForPlayback)(MediaItem* item, MediaItem_Take* take)
Description:get whether a take will be played (active take, unmuted, etc)
| Parameters: |
| item | - | MediaItem in which the take is to be checked |
| take | - | the MediaItem_Take to be checked |
^
IsREAPERFunctioncall:
Description:Returns true if dealing with REAPER, returns false for ReaMote, etc
^
kbd_enumerateActionsFunctioncall:
C: int (*kbd_enumerateActions)(KbdSectionInfo* section, int idx, const char** nameOut)
Description:Enumerates actions.
| Parameters: |
| section | - | the section, in which the action exists 0, Main 100, Main (alt recording) 32060, MIDI Editor 32061, MIDI Event List Editor 32062, MIDI Inline Editor 32063, Media Explorer |
| idx | - | |
| nameOut | - | |
^
kbd_formatKeyNameFunctioncall:
C: void (*kbd_formatKeyName)(ACCEL* ac, char* s)
Description:Format keyname
^
kbd_getCommandNameFunctioncall:
C: void (*kbd_getCommandName)(int cmd, char* s, KbdSectionInfo* section)
Description:Get the string of a key assigned to command "cmd" in a section.
This function is poorly named as it doesn't return the command's name, see
kbd_getTextFromCmd.
| Parameters: |
| cmd | - | commandid of the action
|
| s | - |
|
| section | - | the section, in which the action exists 0, Main 100, Main (alt recording) 32060, MIDI Editor 32061, MIDI Event List Editor 32062, MIDI Inline Editor 32063, Media Explorer
|
^
kbd_getTextFromCmdFunctioncall:
C: const char* (*kbd_getTextFromCmd)(DWORD cmd, KbdSectionInfo* section)
Description:Get text from Command
| Parameters: |
| cmd | - | |
| section | - | the section, in which the action exists 0, Main 100, Main (alt recording) 32060, MIDI Editor 32061, MIDI Event List Editor 32062, MIDI Inline Editor 32063, Media Explorer |
| Returnvalues: |
| const char* | - | |
^
kbd_OnMidiEventFunctioncall:
C: void (*kbd_OnMidiEvent)(MIDI_event_t* evt, int dev_index)
Description:On Midi Event. Can be called from anywhere (threadsafe)
| Parameters: |
| evt | - | the MIDI-event |
| dev_index | - | |
^
kbd_OnMidiListFunctioncall:
C: void (*kbd_OnMidiList)(MIDI_eventlist* list, int dev_index)
Description:On MIDI List. Can be called from anywhere (threadsafe)
| Parameters: |
| list | - | |
| dev_index | - | |
^
kbd_ProcessActionsMenuFunctioncall:
C: void (*kbd_ProcessActionsMenu)(HMENU menu, KbdSectionInfo* section)
Description:Process actions-menu.
| Parameters: |
| menu | - | |
| section | - | the section, in which the action exists 0, Main 100, Main (alt recording) 32060, MIDI Editor 32061, MIDI Event List Editor 32062, MIDI Inline Editor 32063, Media Explorer |
^
kbd_processMidiEventActionExFunctioncall:
C: bool (*kbd_processMidiEventActionEx)(MIDI_event_t* evt, KbdSectionInfo* section, HWND hwndCtx)
Description:Process Midi Event Action
| Parameters: |
| evt | - | |
| section | - | the section, in which the action exists 0, Main 100, Main (alt recording) 32060, MIDI Editor 32061, MIDI Event List Editor 32062, MIDI Inline Editor 32063, Media Explorer |
| hwndCtx | - | |
^
kbd_reprocessMenuFunctioncall:
C: void (*kbd_reprocessMenu)(HMENU menu, KbdSectionInfo* section)
Description:Reprocess a menu recursively, setting key assignments to what their command IDs are mapped to.
| Parameters: |
| menu | - | |
| section | - | the section, in which the action exists 0, Main 100, Main (alt recording) 32060, MIDI Editor 32061, MIDI Event List Editor 32062, MIDI Inline Editor 32063, Media Explorer |
^
kbd_RunCommandThroughHooksFunctioncall:
C: bool (*kbd_RunCommandThroughHooks)(KbdSectionInfo* section, int* actionCommandID, int* val, int* valhw, int* relmode, HWND hwnd)
Description:Run command through hooks. actioncommandID may get modified.
| Parameters: |
| section | - | the section, in which the action exists 0, Main 100, Main (alt recording) 32060, MIDI Editor 32061, MIDI Event List Editor 32062, MIDI Inline Editor 32063, Media Explorer |
| actionCommandID | - | the commandid-number of the action you want to run. |
| val | - | |
| valhw | - | |
| relmode | - | |
| hwnd | - | |
^
kbd_translateAcceleratorFunctioncall:
C: int (*kbd_translateAccelerator)(HWND hwnd, MSG* msg, KbdSectionInfo* section)
Description:Pass in the HWND to receive commands, a MSG of a key command, and a valid section,
and kbd_translateAccelerator() will process it looking for any keys bound to it, and send the messages off.
Returns 1 if processed, 0 if no key binding found.
| Parameters: |
| hwnd | - | |
| msg | - | |
| section | - | the section, in which the action exists 0, Main 100, Main (alt recording) 32060, MIDI Editor 32061, MIDI Event List Editor 32062, MIDI Inline Editor 32063, Media Explorer |
^
kbd_translateMouseFunctioncall:
C: bool (*kbd_translateMouse)(void* winmsg, unsigned char* midimsg)
Description:Translate mouse.
| Parameters: |
| winmsg | - | |
| midimsg | - | |
^
LICE__DestroyFunctioncall:
C: void (*LICE__Destroy)(LICE_IBitmap* bm)
Description:LICE destroy.
^
LICE__DestroyFontFunctioncall:
C: void (*LICE__DestroyFont)(LICE_IFont* font);
Description:LICE destroy-font.
^
LICE__DrawTextFunctioncall:
C: int (*LICE__DrawText)(LICE_IFont* font, LICE_IBitmap* bm, const char* str, int strcnt, RECT* rect, UINT dtFlags)
Description:LICE draw text.
| Parameters: |
| font | - | |
| bm | - | |
| str | - | |
| strcnt | - | |
| rect | - | |
| dtFlags | - | |
^
LICE__GetBitsFunctioncall:
C: void* (*LICE__GetBits)(LICE_IBitmap* bm)
Description:LICE get bits.
^
LICE__GetDCFunctioncall:
C: HDC (*LICE__GetDC)(LICE_IBitmap* bm)
Description:Translate mouse.
^
LICE__GetHeightFunctioncall:
C: int (*LICE__GetHeight)(LICE_IBitmap* bm)
Description:LICE get height
^
LICE__GetRowSpanFunctioncall:
C: int (*LICE__GetRowSpan)(LICE_IBitmap* bm)
Description:LICE get row span.
^
LICE__GetWidthFunctioncall:
C: int (*LICE__GetWidth)(LICE_IBitmap* bm)
Description:LICE get width.
^
LICE__IsFlippedFunctioncall:
C: bool (*LICE__IsFlipped)(LICE_IBitmap* bm)
Description:LICE is flipped
^
LICE__resizeFunctioncall:
C: bool (*LICE__resize)(LICE_IBitmap* bm, int w, int h)
Description:LICE resize
^
LICE__SetBkColorFunctioncall:
C: LICE_pixel (*LICE__SetBkColor)(LICE_IFont* font, LICE_pixel color)
Description:LICE set bk color
| Parameters: |
| font | - | |
| color | - | |
| Returnvalues: |
| LICE_pixel | - | |
^
LICE__SetFromHFontFunctioncall:
C: void (*LICE__SetFromHFont)(LICE_IFont* font, HFONT hfont, int flags)
Description:LICE set from h-font
| Parameters: |
| font | - | font must REMAIN valid,unless LICE_FONT_FLAG_PRECALCALL is set |
| hfont | - | |
| flags | - | |
^
LICE__SetTextColorFunctioncall:
C: LICE_pixel (*LICE__SetTextColor)(LICE_IFont* font, LICE_pixel color)
Description:LICE set text color
| Parameters: |
| font | - | |
| color | - | |
| Returnvalues: |
| LICE_pixel | - | |
^
LICE__SetTextCombineModeFunctioncall:
C: void (*LICE__SetTextCombineMode)(LICE_IFont* ifont, int mode, float alpha)
Description:LICE set text combine mode
| Parameters: |
| ifont | - | |
| mode | - | |
| alpha | - | |
^
LICE_ArcFunctioncall:
C: void (*LICE_Arc)(LICE_IBitmap* dest, float cx, float cy, float r, float minAngle, float maxAngle, LICE_pixel color, float alpha, int mode, bool aa)
Description:LICE arc
| Parameters: |
| dest | - | |
| cx | - | |
| cy | - | |
| r | - | |
| minAngle | - | |
| maxAngle | - | |
| color | - | |
| alpha | - | |
| mode | - | |
| aa | - | |
^
LICE_BlitFunctioncall:
C: void (*LICE_Blit)(LICE_IBitmap* dest, LICE_IBitmap* src, int dstx, int dsty, int srcx, int srcy, int srcw, int srch, float alpha, int mode)
Description:LICE blit
| Parameters: |
| dest | - | |
| src | - | |
| dstx | - | |
| dsty | - | |
| srcx | - | |
| srcy | - | |
| srcw | - | |
| srch | - | |
| alpha | - | |
| mode | - | |
^
LICE_BlurFunctioncall:
C: void (*LICE_Blur)(LICE_IBitmap* dest, LICE_IBitmap* src, int dstx, int dsty, int srcx, int srcy, int srcw, int srch)
Description:LICE blur
| Parameters: |
| dest | - | |
| src | - | |
| dstx | - | |
| dsty | - | |
| srcx | - | |
| srcy | - | |
| srcw | - | |
| srch | - | |
^
LICE_BorderedRectFunctioncall:
C: void (*LICE_BorderedRect)(LICE_IBitmap* dest, int x, int y, int w, int h, LICE_pixel bgcolor, LICE_pixel fgcolor, float alpha, int mode)
Description:LICE bordered rect.
| Parameters: |
| dest | - | |
| x | - | |
| y | - | |
| w | - | |
| h | - | |
| bgcolor | - | |
| fgcolor | - | |
| alpha | - | |
| mode | - | |
^
LICE_CircleFunctioncall:
C: void (*LICE_Circle)(LICE_IBitmap* dest, float cx, float cy, float r, LICE_pixel color, float alpha, int mode, bool aa)
Description:LICE circle
| Parameters: |
| dest | - | |
| cx | - | |
| cy | - | |
| r | - | |
| color | - | |
| alpha | - | |
| mode | - | |
| aa | - | |
^
LICE_ClearFunctioncall:
C: void (*LICE_Clear)(LICE_IBitmap* dest, LICE_pixel color)
Description:LICE clear
| Parameters: |
| dest | - | |
| color | - | |
^
LICE_ClearRectFunctioncall:
C: void (*LICE_ClearRect)(LICE_IBitmap* dest, int x, int y, int w, int h, LICE_pixel mask, LICE_pixel orbits)
Description:LICE clear rect
| Parameters: |
| dest | - | |
| x | - | |
| y | - | |
| w | - | |
| h | - | |
| mask | - | |
| orbits | - | |
^
LICE_CopyFunctioncall:
C: void (*LICE_Copy)(LICE_IBitmap* dest, LICE_IBitmap* src)
Description:LICE copy
^
LICE_CreateBitmapFunctioncall:
C: LICE_IBitmap* (*LICE_CreateBitmap)(int mode, int w, int h)
Description:Create a new bitmap. this is like calling new LICE_MemBitmap (mode=0) or new LICE_SysBitmap (mode=1).
| Parameters: |
| mode | - | |
| w | - | |
| h | - | |
| Returnvalues: |
| LICE_IBitmap* | - | |
^
LICE_CreateFontFunctioncall:
C: LICE_IFont* (*LICE_CreateFont)()
Description:LICE create font
| Returnvalues: |
| LICE_IFont* | - | |
^
LICE_DrawCharFunctioncall:
C: void (*LICE_DrawChar)(LICE_IBitmap* bm, int x, int y, char c, LICE_pixel color, float alpha, int mode)
Description:LICE draw char
| Parameters: |
| x | - | |
| y | - | |
| color | - | |
| alpha | - | |
| mode | - | |
^
LICE_DrawGlyphFunctioncall:
C: void (*LICE_DrawGlyph)(LICE_IBitmap* dest, int x, int y, LICE_pixel color, LICE_pixel_chan* alphas, int glyph_w, int glyph_h, float alpha, int mode)
Description:LICE draw glyph
| Parameters: |
| dest | - | |
| x | - | |
| y | - | |
| color | - | |
| alphas | - | |
| glyph_w | - | |
| glyph_h | - | |
| alpha | - | |
| mode | - | |
^
LICE_DrawCBezierFunctioncall:
C: void (*LICE_DrawCBezier)(LICE_IBitmap* dest, double xstart, double ystart, double xctl1, double yctl1, double xctl2, double yctl2, double xend, double yend, LICE_pixel color, float alpha, int mode, bool aa, double tol)
Description:LICE Draw C Bezier
| Parameters: |
| LICE_IBitmap* dest | - | |
| double xstart | - | |
| double ystart | - | |
| double xctl1 | - | |
| double yctl1 | - | |
| double xctl2 | - | |
| double yctl2 | - | |
| double xend | - | |
| double yend | - | |
| LICE_pixel color | - | |
| float alpha | - | |
| int mode | - | |
| bool aa | - | |
| double tol | - | |
^
LICE_DrawRectFunctioncall:
C: void (*LICE_DrawRect)(LICE_IBitmap* dest, int x, int y, int w, int h, LICE_pixel color, float alpha, int mode)
Description:LICE draw rect
| Parameters: |
| dest | - | |
| x | - | |
| y | - | |
| w | - | |
| h | - | |
| color | - | |
| alpha | - | |
| mode | - | |
^
LICE_DrawTextFunctioncall:
C: void (*LICE_DrawText)(LICE_IBitmap* bm, int x, int y, const char* string, LICE_pixel color, float alpha, int mode)
Description:LICE draw text
| Parameters: |
| bm | - | |
| x | - | |
| y | - | |
| string | - | |
| color | - | |
| alpha | - | |
| mode | - | |
^
LICE_FillCBezierFunctioncall:
C: void (*LICE_FillCBezier)(LICE_IBitmap* dest, double xstart, double ystart, double xctl1, double yctl1, double xctl2, double yctl2, double xend, double yend, int yfill, LICE_pixel color, float alpha, int mode, bool aa, double tol);
Description:LICE Fill CBezier
| Parameters: |
| LICE_IBitmap* dest | - | |
| double xstart | - | |
| double ystart | - | |
| double xctl1 | - | |
| double yctl1 | - | |
| double xctl2 | - | |
| double yctl2 | - | |
| double xend | - | |
| double yend | - | |
| int yfill | - | |
| LICE_pixel color | - | |
| float alpha | - | |
| int mode | - | |
| bool aa | - | |
| double tol | - | |
^
LICE_FillCircleFunctioncall:
C: void (*LICE_FillCircle)(LICE_IBitmap* dest, float cx, float cy, float r, LICE_pixel color, float alpha, int mode, bool aa)
Description:LICE fill circle
| Parameters: |
| dest | - | |
| cx | - | |
| cy | - | |
| r | - | |
| color | - | |
| alpha | - | |
| mode | - | |
| aa | - | |
^
LICE_FillConvexPolygonFunctioncall:
C: void (*LICE_FillConvexPolygon)(LICE_IBitmap* dest, int* x, int* y, int npoints, LICE_pixel color, float alpha, int mode)
Description:LICE fill convex polygon
| Parameters: |
| dest | - | |
| x | - | |
| y | - | |
| npoints | - | |
| color | - | |
| alpha | - | |
| mode | - | |
^
LICE_FillRectFunctioncall:
C: void (*LICE_FillRect)(LICE_IBitmap* dest, int x, int y, int w, int h, LICE_pixel color, float alpha, int mode)
Description:LICE fill rect
| Parameters: |
| dest | - | |
| x | - | |
| y | - | |
| w | - | |
| h | - | |
| color | - | |
| alpha | - | |
| mode | - | |
^
LICE_FillTrapezoidFunctioncall:
C: void (*LICE_FillTrapezoid)(LICE_IBitmap* dest, int x1a, int x1b, int y1, int x2a, int x2b, int y2, LICE_pixel color, float alpha, int mode)
Description:LICE fill trapezoid
| Parameters: |
| dest | - | |
| x1a | - | |
| x1b | - | |
| y1 | - | |
| x2a | - | |
| x2b | - | |
| y2 | - | |
| color | - | |
| alpha | - | |
| mode | - | |
^
LICE_FillTriangleFunctioncall:
C: void (*LICE_FillTriangle)(LICE_IBitmap* dest, int x1, int y1, int x2, int y2, int x3, int y3, LICE_pixel color, float alpha, int mode)
Description:LICE fill triangle
| Parameters: |
| dest | - | |
| x1 | - | |
| y1 | - | |
| x2 | - | |
| y2 | - | |
| x3 | - | |
| y3 | - | |
| color | - | |
| alpha | - | |
| mode | - | |
^
LICE_GetPixelFunctioncall:
C: LICE_pixel (*LICE_GetPixel)(LICE_IBitmap* bm, int x, int y)
Description:LICE get pixel
| Returnvalues: |
| LICE_pixel | - | |
^
LICE_GradRectFunctioncall:
C: void (*LICE_GradRect)(LICE_IBitmap* dest, int dstx, int dsty, int dstw, int dsth, float ir, float ig, float ib, float ia, float drdx, float dgdx, float dbdx, float dadx, float drdy, float dgdy, float dbdy, float dady, int mode)
Description:LICE grad rect
| Parameters: |
| dest | - | |
| dstx | - | |
| dsty | - | |
| dstw | - | |
| dsth | - | |
| ir | - | |
| ig | - | |
| ib | - | |
| ia | - | |
| drdx | - | |
| dgdx | - | |
| dbdx | - | |
| dadx | - | |
| drdy | - | |
| dgdy | - | |
| dbdy | - | |
| dady | - | |
| mode | - | |
^
LICE_LineFunctioncall:
C: void (*LICE_Line)(LICE_IBitmap* dest, float x1, float y1, float x2, float y2, LICE_pixel color, float alpha, int mode, bool aa)
Description:LICE line
| Parameters: |
| dest | - | |
| x1 | - | |
| y1 | - | |
| x2 | - | |
| y2 | - | |
| color | - | |
| alpha | - | |
| mode | - | |
| aa | - | |
^
LICE_LineIntFunctioncall:
C: void (*LICE_LineInt)(LICE_IBitmap* dest, int x1, int y1, int x2, int y2, LICE_pixel color, float alpha, int mode, bool aa)
Description:LICE line int
| Parameters: |
| dest | - | |
| x1 | - | |
| y1 | - | |
| x2 | - | |
| y2 | - | |
| color | - | |
| alpha | - | |
| mode | - | |
| aa | - | |
^
LICE_LoadPNGFunctioncall:
C: LICE_IBitmap* (*LICE_LoadPNG)(const char* filename, LICE_IBitmap* bmp)
Description:LICE load png
| Parameters: |
| filename | - | |
| bmp | - | |
| Returnvalues: |
| LICE_IBitmap* | - | |
^
LICE_LoadPNGFromResourceFunctioncall:
C: LICE_IBitmap* (*LICE_LoadPNGFromResource)(HINSTANCE hInst, int resid, LICE_IBitmap* bmp)
Description:LICE load png from resource
| Parameters: |
| hInst | - | |
| resid | - | |
| bmp | - | |
| Returnvalues: |
| LICE_IBitmap* | - | |
^
LICE_MeasureTextFunctioncall:
C: void (*LICE_MeasureText)(const char* string, int* w, int* h)
Description:LICE measure text
| Parameters: |
| string | - | |
| w | - | |
| h | - | |
^
LICE_MultiplyAddRectFunctioncall:
C: void (*LICE_MultiplyAddRect)(LICE_IBitmap* dest, int x, int y, int w, int h, float rsc, float gsc, float bsc, float asc, float radd, float gadd, float badd, float aadd)
Description:LICE multiplay add rect
| Parameters: |
| dest | - | |
| x | - | |
| y | - | |
| w | - | |
| h | - | |
| rsc | - | |
| gsc | - | |
| bsc | - | |
| asc | - | |
| radd | - | |
| gadd | - | |
| badd | - | |
| aadd | - | |
^
LICE_PutPixelFunctioncall:
C: void (*LICE_PutPixel)(LICE_IBitmap* bm, int x, int y, LICE_pixel color, float alpha, int mode)
Description:LICE put pixel
| Parameters: |
| bm | - | |
| x | - | |
| y | - | |
| color | - | |
| alpha | - | |
| mode | - | |
^
LICE_RotatedBlitFunctioncall:
C: void (*LICE_RotatedBlit)(LICE_IBitmap* dest, LICE_IBitmap* src, int dstx, int dsty, int dstw, int dsth, float srcx, float srcy, float srcw, float srch, float angle, bool cliptosourcerect, float alpha, int mode, float rotxcent, float rotycent)
Description:LICE rotate blit. These coordinates are offset from the center of the image,in source pixel coordinates.
| Parameters: |
| dest | - | |
| src | - | |
| dstx | - | |
| dsty | - | |
| dstw | - | |
| dsth | - | |
| srcx | - | |
| srcy | - | |
| srcw | - | |
| srch | - | |
| angle | - | |
| cliptosourcerect | - | |
| alpha | - | |
| mode | - | |
| rotxcent | - | |
| rtoycent | - | |
^
LICE_RoundRectFunctioncall:
C: void (*LICE_RoundRect)(LICE_IBitmap* drawbm, float xpos, float ypos, float w, float h, int cornerradius, LICE_pixel col, float alpha, int mode, bool aa)
Description:LICE round rect
| Parameters: |
| drawbm | - | |
| xpos | - | |
| ypos | - | |
| w | - | |
| h | - | |
| cornerradius | - | |
| col | - | |
| alpha | - | |
| mode | - | |
| aa | - | |
^
LICE_ScaledBlitFunctioncall:
C: void (*LICE_ScaledBlit)(LICE_IBitmap* dest, LICE_IBitmap* src, int dstx, int dsty, int dstw, int dsth, float srcx, float srcy, float srcw, float srch, float alpha, int mode)
Description:LICE scaled blit.
| Parameters: |
| dest | - | |
| src | - | |
| dstx | - | |
| dsty | - | |
| dstw | - | |
| dsth | - | |
| srcx | - | |
| srcy | - | |
| srcw | - | |
| srch | - | |
| alpha | - | |
| mode | - | |
^
LICE_SimpleFillFunctioncall:
C: void (*LICE_SimpleFill)(LICE_IBitmap* dest, int x, int y, LICE_pixel newcolor, LICE_pixel comparemask, LICE_pixel keepmask)
Description:LICE simple fill
| Parameters: |
| dest | - | |
| x | - | |
| y | - | |
| newcolor | - | |
| comparemask | - | |
| keepmask | - | |
^
PCM_Source_CreateFromSimpleFunctioncall:
C: PCM_source* (*PCM_Source_CreateFromSimple)(ISimpleMediaDecoder* dec, const char* fn)
Description:PCM_Source create from simple
| Returnvalues: |
| PCM_source* | - | |
^
PeakBuild_CreateFunctioncall:
C: REAPER_PeakBuild_Interface* (*PeakBuild_Create)(PCM_source* src, const char* fn, int srate, int nch)
Description:Peak build create
| Parameters: |
| src | - | |
| fn | - | |
| srate | - | |
| nch | - | |
| Returnvalues: |
| REAPER_PeakBuild_Interface* | - | |
^
PeakBuild_CreateExFunctioncall:
C: REAPER_PeakBuild_Interface* (*PeakBuild_CreateEx)(PCM_source* src, const char* fn, int srate, int nch, int flags)
Description:Peakbuild create-ex. flags&1 for FP support
| Parameters: |
| src | - | |
| fn | - | |
| srate | - | |
| nch | - | |
| flags | - | |
| Returnvalues: |
| REAPER_PeakBuild_Interface* | - | |
^
PeakGet_CreateFunctioncall:
C: REAPER_PeakGet_Interface* (*PeakGet_Create)(const char* fn, int srate, int nch)
Description:Peak get create.
| Parameters: |
| fn | - | |
| srate | - | |
| nch | - | |
| Returnvalues: |
| REAPER_PeakGet_Interface* | - | |
^
PlayPreviewFunctioncall:
C: int (*PlayPreview)(preview_register_t* preview)
Description:Play preview. Return nonzero on success.
^
PlayPreviewExFunctioncall:
C: int (*PlayPreviewEx)(preview_register_t* preview, int bufflags, double measure_align)
Description:return nonzero on success.
Bufflags:
&1 = buffer source,
&2 = treat length changes in source as varispeed and adjust internal state accordingly if buffering.
measure_align<0=play immediately, >0=align playback with measure start
| Parameters: |
| preview_register_t* preview | - | |
| int bufflags | - | |
| double measure_align | - | |
^
PlayTrackPreviewFunctioncall:
C: int (*PlayTrackPreview)(preview_register_t* preview)
Description:Play track preview. Returns nonzero on success,in these,m_out_chan is a track index (0-n).
^
PlayTrackPreview2Functioncall:
C: int (*PlayTrackPreview2)(ReaProject* proj, preview_register_t* preview)
Description:Play track preview. Return nonzero on success,in these,m_out_chan is a track index (0-n).
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| preview | - |
|
^
PlayTrackPreview2ExFunctioncall:
C: int (*PlayTrackPreview2Ex)(ReaProject* proj, preview_register_t* preview, int flags, double measure_align)
Description:return nonzero on success,in these,m
outchan is a track index (0-n). for flags see
PlayPreviewEx bufflags
| Parameters: |
| ReaProject* proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| preview_register_t* preview | - |
|
| int flags | - |
|
| double measure_align | - |
|
^
plugin_getapiFunctioncall:
C: void* (*plugin_getapi)(const char* name)
Description:Plugin get api.
^
plugin_getFilterListFunctioncall:
C: const char* (*plugin_getFilterList)()
Description:Plugin get filter list. Returns a double-NULL terminated list of importable media files, suitable for passing to
GetOpenFileName() etc. Includes
. (All files).
^
plugin_getImportableProjectFilterListFunctioncall:
C: const char* (*plugin_getImportableProjectFilterList)()
Description:Plugin get importable project filter list. Returns a double-NULL terminated list of importable project files, suitable for passing to
GetOpenFileName() etc. Includes
. (All files).
^
projectconfig_var_addrFunctioncall:
C: void* (*projectconfig_var_addr)(ReaProject* proj, int idx)
Description:
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| idx | - |
|
^
projectconfig_var_getoffsFunctioncall:
C: int (*projectconfig_var_getoffs)(const char* name, int* szOut)
Description:Returns offset to pass to projectconfig
varaddr() to get project-config var of name. szout gets size of object.
see
Reaper_Config_Variables.html for valid config-vars
| Parameters: |
| name | - |
|
| szOut | - | size of the object
|
^
ReaperGetPitchShiftAPIFunctioncall:
C: IReaperPitchShift* (*ReaperGetPitchShiftAPI)(int version)
Description:version must be REAPER_PITCHSHIFT_API_VER
| Returnvalues: |
| IReaperPitchShift* | - | |
^
Resampler_CreateFunctioncall:
C: REAPER_Resample_Interface* (*Resampler_Create)()
Description:Resampler create
| Returnvalues: |
| REAPER_Resample_Interface* | - | |
^
ResolveRenderPatternFunctioncall:
C: int (*ResolveRenderPattern)(ReaProject* project, const char* path, const char* pattern, char* targets, int targets_sz)
Description:Resolve a wildcard pattern into a set of nul-separated, double-nul terminated render target filenames. Returns the length of the string buffer needed for the returned file list. Call with path=NULL to suppress filtering out illegal pathnames, call with targets=NULL to get just the string buffer length.
| Parameters: |
| ReaProject* project | - | |
| const char* path | - | |
| const char* pattern | - | |
| char* targets | - | |
| int targets_sz | - | |
^
screenset_registerFunctioncall:
C: void (*screenset_register)(char* id, void* callbackFunc, void* param)
Description:Screenset register.
| Parameters: |
| id | - | |
| callbackFunc | - | |
| param | - | |
^
screenset_registerNewFunctioncall:
C: void (*screenset_registerNew)(char* id, screensetNewCallbackFunc callbackFunc, void* param)
Description:Screenset register new.
| Parameters: |
| id | - | |
| callbackFunc | - | |
| param | - | |
^
screenset_unregisterFunctioncall:
C: void (*screenset_unregister)(char* id)
Description:Screenset unregister.
^
screenset_unregisterByParamFunctioncall:
C: void (*screenset_unregisterByParam)(void* param)
Description:Screenset unregister by param
^
screenset_updateLastFocusFunctioncall:
C: void (*screenset_updateLastFocus)(HWND prevWin)
Description:LICE simple fill
^
SectionFromUniqueIDFunctioncall:
C: KbdSectionInfo* (*SectionFromUniqueID)(int uniqueID)
Description:Section from unique ID.
| Returnvalues: |
| KbdSectionInfo* | - | |
^
SetRenderLastErrorFunctioncall:
C: void (*SetRenderLastError)(const char* errorstr)
Description:Set render last error.
^
StopPreviewFunctioncall:
C: int (*StopPreview)(preview_register_t* preview)
Description:Stop preview.
^
StopTrackPreviewFunctioncall:
C: int (*StopTrackPreview)(preview_register_t* preview)
Description:Stop track preview. Return nonzero on success.
^
StopTrackPreview2Functioncall:
C: int (*StopTrackPreview2)(void* proj, preview_register_t* preview)
Description:Stop track preview2.
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| preview | - |
|
^
update_disk_countersFunctioncall:
C: void (*update_disk_counters)(int readamt, int writeamt)
Description:Updates disk I/O statistics with bytes transferred since last call.
Notify REAPER of a write error by calling with readamt=0, writeamt=-101010110 for unknown or -101010111 for disk full
| Parameters: |
| readamt | - | |
| writeamt | - | |
^
WDL_VirtualWnd_ScaledBlitBGFunctioncall:
C: bool (*WDL_VirtualWnd_ScaledBlitBG)(LICE_IBitmap* dest, WDL_VirtualWnd_BGCfg* src, int destx, int desty, int destw, int desth, int clipx, int clipy, int clipw, int cliph, float alpha, int mode)
Description:WDL virtualwnd scale blit bg.
| Parameters: |
| dest | - | |
| src | - | |
| destx | - | |
| desty | - | |
| destw | - | |
| desth | - | |
| clipx | - | |
| clipy | - | |
| clipw | - | |
| cliph | - | |
| alpha | - | |
| mode | - | |
^
GetSetMediaItemInfoFunctioncall:
C: void* (*GetSetMediaItemInfo)(MediaItem* item, const char* parmname, void* setNewValue)
Description:Get/Set Media Item Info
| Parameters: |
| item | - | a MediaItem-object |
| parmname | - | the parameter to be gotten/set P_TRACK : MediaTrack * (read only) B_MUTE : bool * to muted state B_MUTE_ACTUAL : bool * : muted (ignores solo). setting this value will not affect C_MUTE_SOLO. C_MUTE_SOLO : char * : solo override (-1=soloed, 0=no override, 1=unsoloed). note that this API does not automatically unsolo other items when soloing (nor clear the unsolos when clearing the last soloed item), it must be done by the caller via action or via this API. B_LOOPSRC : bool * to loop source B_ALLTAKESPLAY : bool * to all takes play B_UISEL : bool * to ui selected C_BEATATTACHMODE : char * to one char of beat attached mode, -1=def, 0=time, 1=allbeats, 2=beatsosonly C_LOCK : char * to one char of lock flags (&1 is locked, currently) D_VOL : double *, take volume (negative if take polarity is flipped) D_POSITION : double * of item position (seconds) D_LENGTH : double * of item length (seconds) D_SNAPOFFSET : double * of item snap offset (seconds) D_FADEINLEN : double * of item fade in length (manual, seconds) D_FADEOUTLEN : double * of item fade out length (manual, seconds) D_FADEINDIR : double * of item fade in curve [-1; 1] D_FADEOUTDIR : double * of item fade out curve [-1; 1] D_FADEINLEN_AUTO : double * of item autofade in length (seconds, -1 for no autofade set) D_FADEOUTLEN_AUTO : double * of item autofade out length (seconds, -1 for no autofade set) C_FADEINSHAPE : int * to fadein shape, 0=linear, ... C_FADEOUTSHAPE : int * to fadeout shape I_GROUPID : int * to group ID (0 = no group) I_LASTY : int * to last y position in track (readonly) I_LASTH : int * to last height in track (readonly) I_CUSTOMCOLOR : int * : custom color, OS dependent color|0x100000 (i.e. ColorToNative(r,g,b)|0x100000). If you do not |0x100000, then it will not be used (though will store the color anyway). I_CURTAKE : int * to active take IP_ITEMNUMBER : int, item number within the track (read-only, returns the item number directly) F_FREEMODE_Y : float * to free mode y position (0..1) F_FREEMODE_H : float * to free mode height (0..1) P_NOTES : char * : item note text (do not write to returned pointer, use setNewValue to update) |
| setNewValue | - | the new value to be set, refer description of parmname for the values |
^
GetToggleCommandState2Functioncall:
C: int (*GetToggleCommandState2)(KbdSectionInfo* section, int command_id)
Description:Get Toggle Command State 2
| Parameters: |
| section | - | the section, in which the action exists 0, Main 100, Main (alt recording) 32060, MIDI Editor 32061, MIDI Event List Editor 32062, MIDI Inline Editor 32063, Media Explorer |
| command_id | - | the command-id of the command, whose toggle-state you want |
^
GetTrackInfoFunctioncall:
C: const char* (*GetTrackInfo)(INT_PTR track, int* flags)
Description:Gets track info (returns name).
| Parameters: |
| track | - | track index, -1=master, 0..n, or cast a MediaTrack* to int |
| flags | - | if flags is non-NULL, will be set to: &1, folder &2, selected &4, has fx enabled &8, muted &16, soloed &32, SIP'd (with &16) &64, rec armed |
^
KBD_OnMainActionExFunctioncall:
C: int (*KBD_OnMainActionEx)(int cmd, int val, int valhw, int relmode, HWND hwnd, ReaProject* proj)
Description:val/valhw are used for midi stuff.
| Parameters: |
| cmd | - | |
| val | - | val=[0..127] and valhw=-1 (midi CC) |
| valhw | - | valhw >=0 (midi pitch (valhw | val<<7)) |
| relmode | - | relmode absolute (0) or 1/2/3 for relative adjust modes |
| hwnd | - | |
| proj | - | |
^
MIDI_eventlist_CreateFunctioncall:
C: MIDI_eventlist* (*MIDI_eventlist_Create)()
Description:
| Returnvalues: |
| MIDI_eventlist* | - |
|
^
MIDI_eventlist_DestroyFunctioncall:
C: void (*MIDI_eventlist_Destroy)(MIDI_eventlist* evtlist)
Description:
^
PCM_Sink_CreateFunctioncall:
C: PCM_sink* (*PCM_Sink_Create)(const char* filename, const char* cfg, int cfg_sz, int nch, int srate, bool buildpeaks)
Description:PCM sink create
| Parameters: |
| filename | - | |
| cfg | - | |
| cfg_sz | - | |
| nch | - | |
| srate | - | |
| buildpeaks | - | |
| Returnvalues: |
| PCM_sink* | - | |
^
PCM_Sink_CreateExFunctioncall:
C: PCM_sink* (*PCM_Sink_CreateEx)(ReaProject* proj, const char* filename, const char* cfg, int cfg_sz, int nch, int srate, bool buildpeaks)
Description:PCM sink create ex.
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| filename | - |
|
| cfg | - |
|
| cfg_sz | - |
|
| nch | - |
|
| srate | - |
|
| buildpeaks | - |
|
| Returnvalues: |
| PCM_sink* | - |
|
^
PCM_Sink_CreateMIDIFileFunctioncall:
C: PCM_sink* (*PCM_Sink_CreateMIDIFile)(const char* filename, const char* cfg, int cfg_sz, double bpm, int div)
Description:PCM sink create MIDI file.
| Parameters: |
| filename | - | |
| cfg | - | |
| cfg_sz | - | |
| bpm | - | |
| div | - | |
| Returnvalues: |
| PCM_sink* | - | |
^
PCM_Sink_CreateMIDIFileExFunctioncall:
C: PCM_sink* (*PCM_Sink_CreateMIDIFileEx)(ReaProject* proj, const char* filename, const char* cfg, int cfg_sz, double bpm, int div)
Description:PCM sink create MIDI file ex
| Parameters: |
| proj | - | the project-number. 0 for the current project. Can also be a ReaProject-object, as returned by EnumProjects
|
| filename | - |
|
| cfg | - |
|
| cfg_sz | - |
|
| bpm | - |
|
| div | - |
|
| Returnvalues: |
| PCM_sink* | - |
|
^
SendLocalOscMessageFunctioncall:
C: void (*SendLocalOscMessage)(void* local_osc_handler, const char* msg, int msglen)
Description:Send local Osc message.
| Parameters: |
| local_osc_handler | - | |
| msg | - | |
| msglen | - | |
^
PitchShiftSubModeMenuFunctioncall:
C: int (*PitchShiftSubModeMenu)(HWND hwnd, int x, int y, int mode, int submode_sel)
Description:menu to select/modify pitch shifter submode, returns new value (or old value if no item selected)
| Parameters: |
| hwnd | - | |
| x | - | |
| y | - | |
| mode | - | |
| submode_sel | - | |
^
REAPERAPI_LoadAPIFunctioncall:
C: int REAPERAPI_LoadAPI(void *(*getAPI)(const char *))
Description:Checks, whether a certain Reaper-API-function exists.
Because the API is dynamic, callers should never assume a function exists.
Check that a non-NULL function pointer was returned before using it (unless
loaded functions are verified using REAPERAPI_LoadAPI(), see note below).
1) most source files should just #include "reaper_plugin_functions.h" as is.
2) one file should #define REAPERAPI_IMPLEMENT before including this file.
3) the plug-in should call REAPERAPI_LoadAPI(rec->GetFunc) from REAPER_PLUGIN_ENTRYPOINT
and check the return value for errors (REAPERAPI_LoadAPI will return 0 on success).
| Returnvalues: |
| int | - | 0, if a function exists |
^
realloc_cmd_ptrFunctioncall:
C: bool (*realloc_cmd_ptr)(char** ptr, int* ptr_size, int new_size)
Description:special use for NeedBig script API functions - reallocates a NeedBig buffer and updates its size, returns false on error
| Returnvalues: |
| int | - | 0, if a function exists |
^
ReaPack_AboutInstalledPackageFunctioncall:
C: bool ReaPack_AboutInstalledPackage(PackageEntry* entry)
EEL2: bool extension_api("ReaPack_AboutInstalledPackage", PackageEntry entry)
Lua: boolean = reaper.ReaPack_AboutInstalledPackage(PackageEntry entry)
Python: Boolean ReaPack_AboutInstalledPackage(PackageEntry entry)
Description:Show the about dialog of the given package entry.
The repository index is downloaded asynchronously if the cached copy doesn't exist or is older than one week.
| Parameters: |
| PackageEntry entry | - | the installed Reapack-package, whose about dialog you want to show; see ReaPack_GetOwner to get this parameter
|
| Returnvalues: |
| boolean | - | true, if the dialog is shown
|
^
ReaPack_AboutRepositoryFunctioncall:
C: bool ReaPack_AboutRepository(const char* repoName)
EEL2: bool extension_api("ReaPack_AboutRepository", "repoName")
Lua: boolean = reaper.ReaPack_AboutRepository(string repoName)
Python: Boolean ReaPack_AboutRepository(String repoName)
Description:Show the about dialog of the given repository. Returns true if the repository exists in the user configuration.
The repository index is downloaded asynchronously if the cached copy doesn't exist or is older than one week.
| Parameters: |
| string repoName | - | the repository, whose about-dialog you would love to have
|
| Returnvalues: |
| boolean | - | true, if the dialog is shown
|
^
ReaPack_AddSetRepositoryFunctioncall:
C: bool ReaPack_AddSetRepository(const char* name, const char* url, bool enable, int autoInstall, char* errorOut, int errorOut_sz)
EEL2: bool extension_api("ReaPack_AddSetRepository", "name", "url", bool enable, int autoInstall, #error)
Lua: boolean retval, string error = reaper.ReaPack_AddSetRepository(string name, string url, boolean enable, integer autoInstall)
Python: (Boolean retval, String name, String url, Boolean enable, Int autoInstall, String errorOut, Int errorOut_sz) = ReaPack_AddSetRepository(name, url, enable, autoInstall, errorOut, errorOut_sz)
Description:Add or modify a repository. Set url to nullptr (or empty string in Lua) to keep the existing URL. Call
ReaPack_ProcessQueue(true) when done to process the new list and update the GUI.
autoInstall: usually set to 2 (obey user setting).
| Parameters: |
| string name | - | the name of the package
|
| string url | - | the url to the repository's xml-file; set nil to keep the current one
|
| boolean enable | - | set this repo as enabled in the GUI of ReaPack, so synchronizing is possible
|
| integer autoInstall | - | shall this repository automatically installed, when synchronizing and an update is available? 0, don't autoinstall new packages when synchronizing 1, autoinstall new packages when synchronizing 2, use user-settings
|
| Returnvalues: |
| boolean | - | true, if the repo has been added
|
| string error | - |
|
^
ReaPack_BrowsePackagesFunctioncall:
C: void ReaPack_BrowsePackages(const char* filter)
EEL2: extension_api("ReaPack_BrowsePackages", "filter")
Lua: reaper.ReaPack_BrowsePackages(string filter)
Python: ReaPack_BrowsePackages(String filter)
Description:Opens the package browser with the given filter string.
| Parameters: |
| string filter | - | the filter to be applied in the package browser. Only packages that feature words included in this filter will be shown.
|
^
ReaPack_CompareVersionsFunctioncall:
C: int ReaPack_CompareVersions(const char* ver1, const char* ver2, char* errorOut, int errorOut_sz)
EEL2: int extension_api("ReaPack_CompareVersions", "ver1", "ver2", #error)
Lua: integer retval, string error = reaper.ReaPack_CompareVersions(string ver1, string ver2)
Python: (Int retval, String ver1, String ver2, String errorOut, Int errorOut_sz) = ReaPack_CompareVersions(ver1, ver2, errorOut, errorOut_sz)
Description:Compares two versionnumbers. Versionnumbers must start with a number/digit, or they can't be compared.
Returns 0 if both versions are equal, a positive value if ver1 is higher than ver2 and a negative value otherwise.
| Parameters: |
| string ver1 | - | a first versionnumber to compare; must start with a number/digit
|
| string ver2 | - | a second versionnumber to compare; must start with a number/digit
|
| Returnvalues: |
| integer retval | - | -1, ver1<ver2 0, ver1 = ver2 1, ver1>ver2
|
| string error | - | the errormessage, if comparing the parameters ver1 and ver2 is impossible
|
^
ReaPack_EnumOwnedFilesFunctioncall:
C: bool ReaPack_EnumOwnedFiles(PackageEntry* entry, int index, char* pathOut, int pathOut_sz, int* sectionsOut, int* typeOut)
EEL2: bool extension_api("ReaPack_EnumOwnedFiles", PackageEntry entry, int index, #path, int §ions, int &type)
Lua: boolean retval, string path, number sections, number type = reaper.ReaPack_EnumOwnedFiles(PackageEntry entry, integer index)
Python: (Boolean retval, PackageEntry entry, Int index, String pathOut, Int pathOut_sz, Int sectionsOut, Int typeOut) = ReaPack_EnumOwnedFiles(entry, index, pathOut, pathOut_sz, sectionsOut, typeOut)
Description:Enumerate the files owned by the given package. Returns false when there is no more data.
sections: 0=not in action list, &1=main, &2=midi editor, &4=midi inline editor
type: see
ReaPack_GetEntryInfo.
| Parameters: |
| PackageEntry entry | - | the installed Reapack-package, whose file you want to enumerate; see ReaPack_GetOwner to get this parameter
|
| integer index | - | the index of the file of this ReaPack-package with 0 for the first file
|
| Returnvalues: |
| boolean retval | - | true, if more files exist; false, if this is the last/only file
|
| string path | - | the path and filename of the installed file
|
| number sections | - | the section(s), in which this file is installed; it is an integer bitfield 0=not in action list &1=main &2=midi editor &4=midi inline editor
|
| number type | - | the type of the extension, in which this file exists 1, script 2, extension 3, effect 4, data 5, theme 6, langpack 7, webinterface
|
^
ReaPack_FreeEntryFunctioncall:
C: bool ReaPack_FreeEntry(PackageEntry* entry)
EEL2: bool extension_api("ReaPack_FreeEntry", PackageEntry entry)
Lua: boolean = reaper.ReaPack_FreeEntry(PackageEntry entry)
Python: Boolean ReaPack_FreeEntry(PackageEntry entry)
Description:Free resources allocated for the given package entry. Must be used to free PackageEntry-objects created by
ReaPack_GetOwner.
| Parameters: |
| PackageEntry entry | - | the installed Reapack-package, whose ressources you want to free; see ReaPack_GetOwner to get this parameter
|
| Returnvalues: |
| boolean retval | - | true, if freeing was successful; false, if no
|
^
ReaPack_GetEntryInfoFunctioncall:
C: bool ReaPack_GetEntryInfo(PackageEntry* entry, char* repoOut, int repoOut_sz, char* catOut, int catOut_sz, char* pkgOut, int pkgOut_sz, char* descOut, int descOut_sz, int* typeOut, char* verOut, int verOut_sz, char* authorOut, int authorOut_sz, bool* pinnedOut, int* fileCountOut)
EEL2: bool extension_api("ReaPack_GetEntryInfo", PackageEntry entry, #repo, #cat, #pkg, #desc, int &type, #ver, #author, bool &pinned, int &fileCount)
Lua: boolean retval, string repo, string cat, string pkg, string desc, number type, string ver, string author, boolean pinned, number fileCount = reaper.ReaPack_GetEntryInfo(PackageEntry entry)
Python: (Boolean retval, PackageEntry entry, String repoOut, Int repoOut_sz, String catOut, Int catOut_sz, String pkgOut, Int pkgOut_sz, String descOut, Int descOut_sz, Int typeOut, String verOut, Int verOut_sz, String authorOut, Int authorOut_sz, Boolean pinnedOut, Int fileCountOut) = ReaPack_GetEntryInfo(entry, repoOut, repoOut_sz, catOut, catOut_sz, pkgOut, pkgOut_sz, descOut, descOut_sz, typeOut, verOut, verOut_sz, authorOut, authorOut_sz, pinnedOut, fileCountOut)
Description:Get the repository name, category, package name, package description, package type, the currently installed version, author name, pinned status and how many files are owned by the given package entry.
| Parameters: |
| PackageEntry entry | - | the installed Reapack-package, whose package-infos you want; see ReaPack_GetOwner to get this parameter
|
| Returnvalues: |
| boolean retval | - | true, if getting the info worked
|
| string repo | - | the name of the repository
|
| string cat | - | the category of this package
|
| string pkg | - | the package-name of this package
|
| string desc | - | the description of this package
|
| number type | - | the type of this package 1, script 2, extension 3, effect 4, data 5, theme 6, langpack 7, webinterface
|
| string ver | - | the currently installed version of this package
|
| string author | - | the author of this package
|
| boolean pinned | - | the pinned-status of this package
|
| number fileCount | - | the number of files of this package
|
^
ReaPack_GetOwnerFunctioncall:
C: PackageEntry* ReaPack_GetOwner(const char* fn, char* errorOut, int errorOut_sz)
EEL2: PackageEntry extension_api("ReaPack_GetOwner", "fn", #error)
Lua: PackageEntry retval, string error = reaper.ReaPack_GetOwner(string fn)
Python: (PackageEntry retval, String fn, String errorOut, Int errorOut_sz) = ReaPack_GetOwner(fn, errorOut, errorOut_sz)
Description:Returns the package entry owning the given file.
Delete the returned object from memory after use with
ReaPack_FreeEntry.
| Parameters: |
| string fn | - | filename with path to a file, of which you want to know, whose package owns it
|
| Returnvalues: |
| PackageEntry retval | - | the installed Reapack-package, who is owner of this file
|
| string error | - | an errormessage, if the file is not part of a ReaPack-package
|
^
ReaPack_GetRepositoryInfoFunctioncall:
C: bool ReaPack_GetRepositoryInfo(const char* name, char* urlOut, int urlOut_sz, bool* enabledOut, int* autoInstallOut)
EEL2: bool extension_api("ReaPack_GetRepositoryInfo", "name", #url, bool &enabled, int &autoInstall)
Lua: boolean retval, string url, boolean enabled, number autoInstall = reaper.ReaPack_GetRepositoryInfo(string name)
Python: (Boolean retval, String name, String urlOut, Int urlOut_sz, Boolean enabledOut, Int autoInstallOut) = ReaPack_GetRepositoryInfo(name, urlOut, urlOut_sz, enabledOut, autoInstallOut)
Description:Get the infos of the given repository.
| Parameters: |
| string name | - | the name of the ReaPack package, whose repository you want to have
|
| Returnvalues: |
| boolean retval | - | true, such a repository exists; false, it does not exist
|
| string url | - | the url of the repository
|
| boolean enabled | - | true, the repository is enabled for installing/syncing; false, if not
|
| number autoInstall | - | shall this repository be automatically installed when syncing? 0, manual 1, when synchronizing 2, obey user setting
|
^
ReaPack_ProcessQueueFunctioncall:
C: void ReaPack_ProcessQueue(bool refreshUI)
EEL2: extension_api("ReaPack_ProcessQueue", bool refreshUI)
Lua: reaper.ReaPack_ProcessQueue(boolean refreshUI)
Python: ReaPack_ProcessQueue(Boolean refreshUI)
Description:Run pending operations and save the configuration file. If refreshUI is true the browser and manager windows are guaranteed to be refreshed (otherwise it depends on which operations are in the queue).
| Parameters: |
| boolean refreshUI | - | true, refreshes the UI of the ReaPack-user-interface; false, doesn't update the UI
|
^
osara_outputMessageFunctioncall:
C: void osara_outputMessage(const char* message)
EEL2: extension_api("osara_outputMessage", "message")
Lua: reaper.osara_outputMessage(string message)
Python: osara_outputMessage(String message)
Description:Output a message to screen readers.
This should only be used in consultation with screen reader users. Note that this may not work on Windows when certain GUI controls have focus such as list boxes and trees.
Keep it short and to the point.
| Parameters: |
| string message | - | the message, that shall be output to the screen-reader. |
^
ImGui_AcceptDragDropPayloadFunctioncall:
C: bool ImGui_AcceptDragDropPayload(ImGui_Context* ctx, const char* type, char* payloadOutNeedBig, int payloadOutNeedBig_sz, int* flagsInOptional)
EEL2: bool extension_api("ImGui_AcceptDragDropPayload", ImGui_Context ctx, "type", #payload, optional int flagsIn)
Lua: boolean retval, string payload = reaper.ImGui_AcceptDragDropPayload(ImGui_Context ctx, string type, string payload, optional number flagsIn)
Python: bool ImGui_AcceptDragDropPayload(ImGui_Context* ctx, const char* type, char* payloadOutNeedBig, int payloadOutNeedBig_sz, int* flagsInOptional)
Description:Default values: flags = ImGui_DragDropFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string type | - | |
| string payload | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| string payload | - | - |
^
ImGui_AcceptDragDropPayloadFilesFunctioncall:
C: bool ImGui_AcceptDragDropPayloadFiles(ImGui_Context* ctx, int* countOut, int* flagsInOptional)
EEL2: bool extension_api("ImGui_AcceptDragDropPayloadFiles", ImGui_Context ctx, int &count, optional int flagsIn)
Lua: boolean retval, number count = reaper.ImGui_AcceptDragDropPayloadFiles(ImGui_Context ctx, number count, optional number flagsIn)
Python: bool ImGui_AcceptDragDropPayloadFiles(ImGui_Context* ctx, int* countOut, int* flagsInOptional)
Description:Default values: flags = ImGui_DragDropFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| number count | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number count | - | - |
^
ImGui_AcceptDragDropPayloadRGBFunctioncall:
C: bool ImGui_AcceptDragDropPayloadRGB(ImGui_Context* ctx, int* rgbOut, int* flagsInOptional)
EEL2: bool extension_api("ImGui_AcceptDragDropPayloadRGB", ImGui_Context ctx, int &rgb, optional int flagsIn)
Lua: boolean retval, number rgb = reaper.ImGui_AcceptDragDropPayloadRGB(ImGui_Context ctx, number rgb, optional number flagsIn)
Python: bool ImGui_AcceptDragDropPayloadRGB(ImGui_Context* ctx, int* rgbOut, int* flagsInOptional)
Description:Default values: flags = ImGui_DragDropFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| number rgb | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number rgb | - | - |
^
ImGui_AcceptDragDropPayloadRGBAFunctioncall:
C: bool ImGui_AcceptDragDropPayloadRGBA(ImGui_Context* ctx, int* rgbaOut, int* flagsInOptional)
EEL2: bool extension_api("ImGui_AcceptDragDropPayloadRGBA", ImGui_Context ctx, int &rgba, optional int flagsIn)
Lua: boolean retval, number rgba = reaper.ImGui_AcceptDragDropPayloadRGBA(ImGui_Context ctx, number rgba, optional number flagsIn)
Python: bool ImGui_AcceptDragDropPayloadRGBA(ImGui_Context* ctx, int* rgbaOut, int* flagsInOptional)
Description:Default values: flags = ImGui_DragDropFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| number rgba | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number rgba | - | - |
^
ImGui_AlignTextToFramePaddingFunctioncall:
C: void ImGui_AlignTextToFramePadding(ImGui_Context* ctx)
EEL2: extension_api("ImGui_AlignTextToFramePadding", ImGui_Context ctx)
Lua: reaper.ImGui_AlignTextToFramePadding(ImGui_Context ctx)
Python: void ImGui_AlignTextToFramePadding(ImGui_Context* ctx)
Description:Vertically align upcoming text baseline to FramePadding.y so that it will align properly to regularly framed items (call if you have text on a line before a framed item)
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_ArrowButtonFunctioncall:
C: bool ImGui_ArrowButton(ImGui_Context* ctx, const char* str_id, int dir)
EEL2: bool extension_api("ImGui_ArrowButton", ImGui_Context ctx, "str_id", int dir)
Lua: boolean reaper.ImGui_ArrowButton(ImGui_Context ctx, string str_id, integer dir)
Python: bool ImGui_ArrowButton(ImGui_Context* ctx, const char* str_id, int dir)
Description:Square button with an arrow shape
| Parameters: |
| ImGui_Context ctx | - | |
| string str_id | - | |
| integer dir | - | |
^
ImGui_AttachFontFunctioncall:
C: void ImGui_AttachFont(ImGui_Context* ctx, ImGui_Font* font)
EEL2: extension_api("ImGui_AttachFont", ImGui_Context ctx, ImGui_Font font)
Lua: reaper.ImGui_AttachFont(ImGui_Context ctxImGui_Font font)
Python: void ImGui_AttachFont(ImGui_Context* ctx, ImGui_Font* font)
Description:Enable a font for use in the given context. Fonts must be attached as soon as possible after creating the context or on a new defer cycle.
| Parameters: |
| ImGui_Context ctxImGui_Font font | - | |
^
ImGui_BeginFunctioncall:
C: bool ImGui_Begin(ImGui_Context* ctx, const char* name, bool* p_openInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_Begin", ImGui_Context ctx, "name", optional bool p_openIn, optional int flagsIn)
Lua: boolean reaper.ImGui_Begin(ImGui_Context ctx, string name, optional boolean p_openIn, optional number flagsIn)
Python: bool ImGui_Begin(ImGui_Context* ctx, const char* name, bool* p_openInOptional, int* flagsInOptional)
Description:Default values: p_open = nil, flags = ImGui_WindowFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string name | - | |
| optional boolean p_openIn | - | |
| optional number flagsIn | - | |
^
ImGui_BeginChildFunctioncall:
C: bool ImGui_BeginChild(ImGui_Context* ctx, const char* str_id, double* size_wInOptional, double* size_hInOptional, bool* borderInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_BeginChild", ImGui_Context ctx, "str_id", optional size_wIn, optional size_hIn, optional bool borderIn, optional int flagsIn)
Lua: boolean reaper.ImGui_BeginChild(ImGui_Context ctx, string str_id, optional number size_wIn, optional number size_hIn, optional boolean borderIn, optional number flagsIn)
Python: bool ImGui_BeginChild(ImGui_Context* ctx, const char* str_id, double* size_wInOptional, double* size_hInOptional, bool* borderInOptional, int* flagsInOptional)
Description:Default values: size_w = 0.0, size_h = 0.0, border = false, flags = ImGui_WindowFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string str_id | - | |
| optional number size_wIn | - | |
| optional number size_hIn | - | |
| optional boolean borderIn | - | |
| optional number flagsIn | - | |
^
ImGui_BeginChildFrameFunctioncall:
C: bool ImGui_BeginChildFrame(ImGui_Context* ctx, const char* str_id, double size_w, double size_h, int* flagsInOptional)
EEL2: bool extension_api("ImGui_BeginChildFrame", ImGui_Context ctx, "str_id", size_w, size_h, optional int flagsIn)
Lua: boolean reaper.ImGui_BeginChildFrame(ImGui_Context ctx, string str_id, number size_w, number size_h, optional number flagsIn)
Python: bool ImGui_BeginChildFrame(ImGui_Context* ctx, const char* str_id, double size_w, double size_h, int* flagsInOptional)
Description:Default values: flags = ImGui_WindowFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string str_id | - | |
| number size_w | - | |
| number size_h | - | |
| optional number flagsIn | - | |
^
ImGui_BeginComboFunctioncall:
C: bool ImGui_BeginCombo(ImGui_Context* ctx, const char* label, const char* preview_value, int* flagsInOptional)
EEL2: bool extension_api("ImGui_BeginCombo", ImGui_Context ctx, "label", "preview_value", optional int flagsIn)
Lua: boolean reaper.ImGui_BeginCombo(ImGui_Context ctx, string label, string preview_value, optional number flagsIn)
Python: bool ImGui_BeginCombo(ImGui_Context* ctx, const char* label, const char* preview_value, int* flagsInOptional)
Description:Default values: flags = ImGui_ComboFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| string preview_value | - | |
| optional number flagsIn | - | |
^
ImGui_BeginDragDropSourceFunctioncall:
C: bool ImGui_BeginDragDropSource(ImGui_Context* ctx, int* flagsInOptional)
EEL2: bool extension_api("ImGui_BeginDragDropSource", ImGui_Context ctx, optional int flagsIn)
Lua: boolean reaper.ImGui_BeginDragDropSource(ImGui_Context ctx, optional number flagsIn)
Python: bool ImGui_BeginDragDropSource(ImGui_Context* ctx, int* flagsInOptional)
Description:Default values: flags = ImGui_DragDropFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| optional number flagsIn | - | |
^
ImGui_BeginDragDropTargetFunctioncall:
C: bool ImGui_BeginDragDropTarget(ImGui_Context* ctx)
EEL2: bool extension_api("ImGui_BeginDragDropTarget", ImGui_Context ctx)
Lua: boolean reaper.ImGui_BeginDragDropTarget(ImGui_Context ctx)
Python: bool ImGui_BeginDragDropTarget(ImGui_Context* ctx)
Description:Call after submitting an item that may receive a payload. If this returns true, you can call AcceptDragDropPayload() + EndDragDropTarget()
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_BeginGroupFunctioncall:
C: void ImGui_BeginGroup(ImGui_Context* ctx)
EEL2: extension_api("ImGui_BeginGroup", ImGui_Context ctx)
Lua: reaper.ImGui_BeginGroup(ImGui_Context ctx)
Python: void ImGui_BeginGroup(ImGui_Context* ctx)
Description:
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_BeginListBoxFunctioncall:
C: bool ImGui_BeginListBox(ImGui_Context* ctx, const char* label, double* size_wInOptional, double* size_hInOptional)
EEL2: bool extension_api("ImGui_BeginListBox", ImGui_Context ctx, "label", optional size_wIn, optional size_hIn)
Lua: boolean reaper.ImGui_BeginListBox(ImGui_Context ctx, string label, optional number size_wIn, optional number size_hIn)
Python: bool ImGui_BeginListBox(ImGui_Context* ctx, const char* label, double* size_wInOptional, double* size_hInOptional)
Description:
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| optional number size_wIn | - | |
| optional number size_hIn | - | |
^
ImGui_BeginMainMenuBarFunctioncall:
C: bool ImGui_BeginMainMenuBar(ImGui_Context* ctx)
EEL2: bool extension_api("ImGui_BeginMainMenuBar", ImGui_Context ctx)
Lua: boolean reaper.ImGui_BeginMainMenuBar(ImGui_Context ctx)
Python: bool ImGui_BeginMainMenuBar(ImGui_Context* ctx)
Description:Create a menu bar at the top of the screen and append to it.
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_BeginMenuFunctioncall:
C: bool ImGui_BeginMenu(ImGui_Context* ctx, const char* label, bool* enabledInOptional)
EEL2: bool extension_api("ImGui_BeginMenu", ImGui_Context ctx, "label", optional bool enabledIn)
Lua: boolean reaper.ImGui_BeginMenu(ImGui_Context ctx, string label, optional boolean enabledIn)
Python: bool ImGui_BeginMenu(ImGui_Context* ctx, const char* label, bool* enabledInOptional)
Description:Default values: enabled = true
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| optional boolean enabledIn | - | |
^
ImGui_BeginMenuBarFunctioncall:
C: bool ImGui_BeginMenuBar(ImGui_Context* ctx)
EEL2: bool extension_api("ImGui_BeginMenuBar", ImGui_Context ctx)
Lua: boolean reaper.ImGui_BeginMenuBar(ImGui_Context ctx)
Python: bool ImGui_BeginMenuBar(ImGui_Context* ctx)
Description:Append to menu-bar of current window (requires ImGui_WindowFlags_MenuBar flag set on parent window). See
ImGui_EndMenuBar.
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_BeginPopupFunctioncall:
C: bool ImGui_BeginPopup(ImGui_Context* ctx, const char* str_id, int* flagsInOptional)
EEL2: bool extension_api("ImGui_BeginPopup", ImGui_Context ctx, "str_id", optional int flagsIn)
Lua: boolean reaper.ImGui_BeginPopup(ImGui_Context ctx, string str_id, optional number flagsIn)
Python: bool ImGui_BeginPopup(ImGui_Context* ctx, const char* str_id, int* flagsInOptional)
Description:Default values: flags = ImGui_WindowFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string str_id | - | |
| optional number flagsIn | - | |
^
ImGui_BeginPopupContextItemFunctioncall:
C: bool ImGui_BeginPopupContextItem(ImGui_Context* ctx, const char* str_idInOptional, int* popup_flagsInOptional)
EEL2: bool extension_api("ImGui_BeginPopupContextItem", ImGui_Context ctx, optional "str_idIn", optional int popup_flagsIn)
Lua: boolean reaper.ImGui_BeginPopupContextItem(ImGui_Context ctx, optional string str_idIn, optional number popup_flagsIn)
Python: bool ImGui_BeginPopupContextItem(ImGui_Context* ctx, const char* str_idInOptional, int* popup_flagsInOptional)
Description:Default values: str_id = nil, popup_flags = ImGui_PopupFlags_MouseButtonRight
| Parameters: |
| ImGui_Context ctx | - | |
| optional string str_idIn | - | |
| optional number popup_flagsIn | - | |
^
ImGui_BeginPopupContextVoidFunctioncall:
C: bool ImGui_BeginPopupContextVoid(ImGui_Context* ctx, const char* str_idInOptional, int* popup_flagsInOptional)
EEL2: bool extension_api("ImGui_BeginPopupContextVoid", ImGui_Context ctx, optional "str_idIn", optional int popup_flagsIn)
Lua: boolean reaper.ImGui_BeginPopupContextVoid(ImGui_Context ctx, optional string str_idIn, optional number popup_flagsIn)
Python: bool ImGui_BeginPopupContextVoid(ImGui_Context* ctx, const char* str_idInOptional, int* popup_flagsInOptional)
Description:Default values: str_id = nil, popup_flags = ImGui_PopupFlags_MouseButtonRight
| Parameters: |
| ImGui_Context ctx | - | |
| optional string str_idIn | - | |
| optional number popup_flagsIn | - | |
^
ImGui_BeginPopupContextWindowFunctioncall:
C: bool ImGui_BeginPopupContextWindow(ImGui_Context* ctx, const char* str_idInOptional, int* popup_flagsInOptional)
EEL2: bool extension_api("ImGui_BeginPopupContextWindow", ImGui_Context ctx, optional "str_idIn", optional int popup_flagsIn)
Lua: boolean reaper.ImGui_BeginPopupContextWindow(ImGui_Context ctx, optional string str_idIn, optional number popup_flagsIn)
Python: bool ImGui_BeginPopupContextWindow(ImGui_Context* ctx, const char* str_idInOptional, int* popup_flagsInOptional)
Description:Default values: str_id = nil, popup_flags = ImGui_PopupFlags_MouseButtonRight
| Parameters: |
| ImGui_Context ctx | - | |
| optional string str_idIn | - | |
| optional number popup_flagsIn | - | |
^
ImGui_BeginPopupModalFunctioncall:
C: bool ImGui_BeginPopupModal(ImGui_Context* ctx, const char* name, bool* p_openInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_BeginPopupModal", ImGui_Context ctx, "name", optional bool p_openIn, optional int flagsIn)
Lua: boolean reaper.ImGui_BeginPopupModal(ImGui_Context ctx, string name, optional boolean p_openIn, optional number flagsIn)
Python: bool ImGui_BeginPopupModal(ImGui_Context* ctx, const char* name, bool* p_openInOptional, int* flagsInOptional)
Description:Default values: p_open = nil, flags = ImGui_WindowFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string name | - | |
| optional boolean p_openIn | - | |
| optional number flagsIn | - | |
^
ImGui_BeginTabBarFunctioncall:
C: bool ImGui_BeginTabBar(ImGui_Context* ctx, const char* str_id, int* flagsInOptional)
EEL2: bool extension_api("ImGui_BeginTabBar", ImGui_Context ctx, "str_id", optional int flagsIn)
Lua: boolean reaper.ImGui_BeginTabBar(ImGui_Context ctx, string str_id, optional number flagsIn)
Python: bool ImGui_BeginTabBar(ImGui_Context* ctx, const char* str_id, int* flagsInOptional)
Description:Default values: flags = ImGui_TabBarFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string str_id | - | |
| optional number flagsIn | - | |
^
ImGui_BeginTabItemFunctioncall:
C: bool ImGui_BeginTabItem(ImGui_Context* ctx, const char* label, bool* p_openInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_BeginTabItem", ImGui_Context ctx, "label", optional bool p_openIn, optional int flagsIn)
Lua: boolean reaper.ImGui_BeginTabItem(ImGui_Context ctx, string label, optional boolean p_openIn, optional number flagsIn)
Python: bool ImGui_BeginTabItem(ImGui_Context* ctx, const char* label, bool* p_openInOptional, int* flagsInOptional)
Description:'open' is read/write.
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| optional boolean p_openIn | - | |
| optional number flagsIn | - | |
^
ImGui_BeginTableFunctioncall:
C: bool ImGui_BeginTable(ImGui_Context* ctx, const char* str_id, int column, int* flagsInOptional, double* outer_size_wInOptional, double* outer_size_hInOptional, double* inner_widthInOptional)
EEL2: bool extension_api("ImGui_BeginTable", ImGui_Context ctx, "str_id", int column, optional int flagsIn, optional outer_size_wIn, optional outer_size_hIn, optional inner_widthIn)
Lua: boolean reaper.ImGui_BeginTable(ImGui_Context ctx, string str_id, integer column, optional number flagsIn, optional number outer_size_wIn, optional number outer_size_hIn, optional number inner_widthIn)
Python: bool ImGui_BeginTable(ImGui_Context* ctx, const char* str_id, int column, int* flagsInOptional, double* outer_size_wInOptional, double* outer_size_hInOptional, double* inner_widthInOptional)
Description:Default values: flags = ImGui_TableFlags_None, outer_size_w = 0.0, outer_size_h = 0.0, inner_width = 0.0
| Parameters: |
| ImGui_Context ctx | - | |
| string str_id | - | |
| integer column | - | |
| optional number flagsIn | - | |
| optional number outer_size_wIn | - | |
| optional number outer_size_hIn | - | |
| optional number inner_widthIn | - | |
^
ImGui_BeginTooltipFunctioncall:
C: void ImGui_BeginTooltip(ImGui_Context* ctx)
EEL2: extension_api("ImGui_BeginTooltip", ImGui_Context ctx)
Lua: reaper.ImGui_BeginTooltip(ImGui_Context ctx)
Python: void ImGui_BeginTooltip(ImGui_Context* ctx)
Description:Begin/append a tooltip window. to create full-featured tooltip (with any kind of items).
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_BulletFunctioncall:
C: void ImGui_Bullet(ImGui_Context* ctx)
EEL2: extension_api("ImGui_Bullet", ImGui_Context ctx)
Lua: reaper.ImGui_Bullet(ImGui_Context ctx)
Python: void ImGui_Bullet(ImGui_Context* ctx)
Description:Draw a small circle + keep the cursor on the same line. advance cursor x position by GetTreeNodeToLabelSpacing(), same distance that TreeNode() uses.
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_BulletTextFunctioncall:
C: void ImGui_BulletText(ImGui_Context* ctx, const char* text)
EEL2: extension_api("ImGui_BulletText", ImGui_Context ctx, "text")
Lua: reaper.ImGui_BulletText(ImGui_Context ctx, string text)
Python: void ImGui_BulletText(ImGui_Context* ctx, const char* text)
Description:Shortcut for Bullet()+Text()
| Parameters: |
| ImGui_Context ctx | - | |
| string text | - | |
^
ImGui_ButtonFunctioncall:
C: bool ImGui_Button(ImGui_Context* ctx, const char* label, double* size_wInOptional, double* size_hInOptional)
EEL2: bool extension_api("ImGui_Button", ImGui_Context ctx, "label", optional size_wIn, optional size_hIn)
Lua: boolean reaper.ImGui_Button(ImGui_Context ctx, string label, optional number size_wIn, optional number size_hIn)
Python: bool ImGui_Button(ImGui_Context* ctx, const char* label, double* size_wInOptional, double* size_hInOptional)
Description:Default values: size_w = 0.0, size_h = 0.0
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| optional number size_wIn | - | |
| optional number size_hIn | - | |
^
ImGui_ButtonFlags_MouseButtonLeftFunctioncall:
C: int ImGui_ButtonFlags_MouseButtonLeft()
EEL2: int extension_api("ImGui_ButtonFlags_MouseButtonLeft")
Lua: integer reaper.ImGui_ButtonFlags_MouseButtonLeft()
Python: int ImGui_ButtonFlags_MouseButtonLeft()
Description:React on left mouse button (default)
^
ImGui_ButtonFlags_MouseButtonMiddleFunctioncall:
C: int ImGui_ButtonFlags_MouseButtonMiddle()
EEL2: int extension_api("ImGui_ButtonFlags_MouseButtonMiddle")
Lua: integer reaper.ImGui_ButtonFlags_MouseButtonMiddle()
Python: int ImGui_ButtonFlags_MouseButtonMiddle()
Description:React on center mouse button
^
ImGui_ButtonFlags_MouseButtonRightFunctioncall:
C: int ImGui_ButtonFlags_MouseButtonRight()
EEL2: int extension_api("ImGui_ButtonFlags_MouseButtonRight")
Lua: integer reaper.ImGui_ButtonFlags_MouseButtonRight()
Python: int ImGui_ButtonFlags_MouseButtonRight()
Description:React on right mouse button
^
ImGui_ButtonFlags_NoneFunctioncall:
C: int ImGui_ButtonFlags_None()
EEL2: int extension_api("ImGui_ButtonFlags_None")
Lua: integer reaper.ImGui_ButtonFlags_None()
Python: int ImGui_ButtonFlags_None()
Description:Flags: for InvisibleButton()
^
ImGui_CalcItemWidthFunctioncall:
C: double ImGui_CalcItemWidth(ImGui_Context* ctx)
EEL2: double extension_api("ImGui_CalcItemWidth", ImGui_Context ctx)
Lua: number reaper.ImGui_CalcItemWidth(ImGui_Context ctx)
Python: double ImGui_CalcItemWidth(ImGui_Context* ctx)
Description:Width of item given pushed settings and current cursor position. NOT necessarily the width of last item unlike most 'Item' functions.
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_CalcTextSizeFunctioncall:
C: void ImGui_CalcTextSize(ImGui_Context* ctx, const char* text, double* wOut, double* hOut, bool* hide_text_after_double_hashInOptional, double* wrap_widthInOptional)
EEL2: extension_api("ImGui_CalcTextSize", ImGui_Context ctx, "text", &w, &h, optional bool hide_text_after_double_hashIn, optional wrap_widthIn)
Lua: number w, number h = reaper.ImGui_CalcTextSize(ImGui_Context ctx, string text, number w, number h, optional boolean hide_text_after_double_hashIn, optional number wrap_widthIn)
Python: void ImGui_CalcTextSize(ImGui_Context* ctx, const char* text, double* wOut, double* hOut, bool* hide_text_after_double_hashInOptional, double* wrap_widthInOptional)
Description:Default values: hide_text_after_double_hash = false, wrap_width = -1.0
| Parameters: |
| ImGui_Context ctx | - | |
| string text | - | |
| number w | - | |
| number h | - | |
| optional boolean hide_text_after_double_hashIn | - | |
| optional number wrap_widthIn | - | |
| Returnvalues: |
| number w | - | |
| number h | - | - |
^
ImGui_CaptureKeyboardFromAppFunctioncall:
C: void ImGui_CaptureKeyboardFromApp(ImGui_Context* ctx, bool* want_capture_keyboard_valueInOptional)
EEL2: extension_api("ImGui_CaptureKeyboardFromApp", ImGui_Context ctx, optional bool want_capture_keyboard_valueIn)
Lua: reaper.ImGui_CaptureKeyboardFromApp(ImGui_Context ctx, optional boolean want_capture_keyboard_valueIn)
Python: void ImGui_CaptureKeyboardFromApp(ImGui_Context* ctx, bool* want_capture_keyboard_valueInOptional)
Description:Default values: want_capture_keyboard_value = true
| Parameters: |
| ImGui_Context ctx | - | |
| optional boolean want_capture_keyboard_valueIn | - | |
^
ImGui_CheckboxFunctioncall:
C: bool ImGui_Checkbox(ImGui_Context* ctx, const char* label, bool* vInOut)
EEL2: bool extension_api("ImGui_Checkbox", ImGui_Context ctx, "label", bool &v)
Lua: boolean retval, boolean v = reaper.ImGui_Checkbox(ImGui_Context ctx, string label, boolean v)
Python: bool ImGui_Checkbox(ImGui_Context* ctx, const char* label, bool* vInOut)
Description:Python: (Boolean retval, ImGui_Context ctx, String label, Boolean vInOut) = ImGui_Checkbox(ctx, label, vInOut)
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| boolean v | - | |
| Returnvalues: |
| boolean retval | - | |
| boolean v | - | - |
^
ImGui_CheckboxFlagsFunctioncall:
C: bool ImGui_CheckboxFlags(ImGui_Context* ctx, const char* label, int* flagsInOut, int flags_value)
EEL2: bool extension_api("ImGui_CheckboxFlags", ImGui_Context ctx, "label", int &flags, int flags_value)
Lua: boolean retval, number flags = reaper.ImGui_CheckboxFlags(ImGui_Context ctx, string label, number flags, integer flags_value)
Python: bool ImGui_CheckboxFlags(ImGui_Context* ctx, const char* label, int* flagsInOut, int flags_value)
Description:Python: (Boolean retval, ImGui_Context ctx, String label, Int flagsInOut, Int flags_value) = ImGui_CheckboxFlags(ctx, label, flagsInOut, flags_value)
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number flags | - | |
| integer flags_value | - | |
| Returnvalues: |
| boolean retval | - | |
| number flags | - | - |
^
ImGui_CloseCurrentPopupFunctioncall:
C: void ImGui_CloseCurrentPopup(ImGui_Context* ctx)
EEL2: extension_api("ImGui_CloseCurrentPopup", ImGui_Context ctx)
Lua: reaper.ImGui_CloseCurrentPopup(ImGui_Context ctx)
Python: void ImGui_CloseCurrentPopup(ImGui_Context* ctx)
Description:CloseCurrentPopup() is called by default by Selectable()/MenuItem() when activateda
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_Col_BorderFunctioncall:
C: int ImGui_Col_Border()
EEL2: int extension_api("ImGui_Col_Border")
Lua: integer reaper.ImGui_Col_Border()
Python: int ImGui_Col_Border()
Description:Python: Int ImGui_Col_Border()
^
ImGui_Col_BorderShadowFunctioncall:
C: int ImGui_Col_BorderShadow()
EEL2: int extension_api("ImGui_Col_BorderShadow")
Lua: integer reaper.ImGui_Col_BorderShadow()
Python: int ImGui_Col_BorderShadow()
Description:Python: Int ImGui_Col_BorderShadow()
^
ImGui_Col_ButtonFunctioncall:
C: int ImGui_Col_Button()
EEL2: int extension_api("ImGui_Col_Button")
Lua: integer reaper.ImGui_Col_Button()
Python: int ImGui_Col_Button()
Description:Python: Int ImGui_Col_Button()
^
ImGui_Col_ButtonActiveFunctioncall:
C: int ImGui_Col_ButtonActive()
EEL2: int extension_api("ImGui_Col_ButtonActive")
Lua: integer reaper.ImGui_Col_ButtonActive()
Python: int ImGui_Col_ButtonActive()
Description:Python: Int ImGui_Col_ButtonActive()
^
ImGui_Col_ButtonHoveredFunctioncall:
C: int ImGui_Col_ButtonHovered()
EEL2: int extension_api("ImGui_Col_ButtonHovered")
Lua: integer reaper.ImGui_Col_ButtonHovered()
Python: int ImGui_Col_ButtonHovered()
Description:Python: Int ImGui_Col_ButtonHovered()
^
ImGui_Col_CheckMarkFunctioncall:
C: int ImGui_Col_CheckMark()
EEL2: int extension_api("ImGui_Col_CheckMark")
Lua: integer reaper.ImGui_Col_CheckMark()
Python: int ImGui_Col_CheckMark()
Description:Python: Int ImGui_Col_CheckMark()
^
ImGui_Col_ChildBgFunctioncall:
C: int ImGui_Col_ChildBg()
EEL2: int extension_api("ImGui_Col_ChildBg")
Lua: integer reaper.ImGui_Col_ChildBg()
Python: int ImGui_Col_ChildBg()
Description:Background of child windows
^
ImGui_Col_DragDropTargetFunctioncall:
C: int ImGui_Col_DragDropTarget()
EEL2: int extension_api("ImGui_Col_DragDropTarget")
Lua: integer reaper.ImGui_Col_DragDropTarget()
Python: int ImGui_Col_DragDropTarget()
Description:Python: Int ImGui_Col_DragDropTarget()
^
ImGui_Col_FrameBgFunctioncall:
C: int ImGui_Col_FrameBg()
EEL2: int extension_api("ImGui_Col_FrameBg")
Lua: integer reaper.ImGui_Col_FrameBg()
Python: int ImGui_Col_FrameBg()
Description:Background of checkbox, radio button, plot, slider, text input
^
ImGui_Col_FrameBgActiveFunctioncall:
C: int ImGui_Col_FrameBgActive()
EEL2: int extension_api("ImGui_Col_FrameBgActive")
Lua: integer reaper.ImGui_Col_FrameBgActive()
Python: int ImGui_Col_FrameBgActive()
Description:Python: Int ImGui_Col_FrameBgActive()
^
ImGui_Col_FrameBgHoveredFunctioncall:
C: int ImGui_Col_FrameBgHovered()
EEL2: int extension_api("ImGui_Col_FrameBgHovered")
Lua: integer reaper.ImGui_Col_FrameBgHovered()
Python: int ImGui_Col_FrameBgHovered()
Description:Python: Int ImGui_Col_FrameBgHovered()
^
ImGui_Col_HeaderFunctioncall:
C: int ImGui_Col_Header()
EEL2: int extension_api("ImGui_Col_Header")
Lua: integer reaper.ImGui_Col_Header()
Python: int ImGui_Col_Header()
Description:Header* colors are used for CollapsingHeader, TreeNode, Selectable, MenuItem
^
ImGui_Col_HeaderActiveFunctioncall:
C: int ImGui_Col_HeaderActive()
EEL2: int extension_api("ImGui_Col_HeaderActive")
Lua: integer reaper.ImGui_Col_HeaderActive()
Python: int ImGui_Col_HeaderActive()
Description:Python: Int ImGui_Col_HeaderActive()
^
ImGui_Col_HeaderHoveredFunctioncall:
C: int ImGui_Col_HeaderHovered()
EEL2: int extension_api("ImGui_Col_HeaderHovered")
Lua: integer reaper.ImGui_Col_HeaderHovered()
Python: int ImGui_Col_HeaderHovered()
Description:Python: Int ImGui_Col_HeaderHovered()
^
ImGui_Col_MenuBarBgFunctioncall:
C: int ImGui_Col_MenuBarBg()
EEL2: int extension_api("ImGui_Col_MenuBarBg")
Lua: integer reaper.ImGui_Col_MenuBarBg()
Python: int ImGui_Col_MenuBarBg()
Description:Python: Int ImGui_Col_MenuBarBg()
^
ImGui_Col_ModalWindowDimBgFunctioncall:
C: int ImGui_Col_ModalWindowDimBg()
EEL2: int extension_api("ImGui_Col_ModalWindowDimBg")
Lua: integer reaper.ImGui_Col_ModalWindowDimBg()
Python: int ImGui_Col_ModalWindowDimBg()
Description:Darken/colorize entire screen behind a modal window, when one is active
^
ImGui_Col_NavHighlightFunctioncall:
C: int ImGui_Col_NavHighlight()
EEL2: int extension_api("ImGui_Col_NavHighlight")
Lua: integer reaper.ImGui_Col_NavHighlight()
Python: int ImGui_Col_NavHighlight()
Description:Gamepad/keyboard: current highlighted item
^
ImGui_Col_NavWindowingDimBgFunctioncall:
C: int ImGui_Col_NavWindowingDimBg()
EEL2: int extension_api("ImGui_Col_NavWindowingDimBg")
Lua: integer reaper.ImGui_Col_NavWindowingDimBg()
Python: int ImGui_Col_NavWindowingDimBg()
Description:Darken/colorize entire screen behind the CTRL+TAB window list, when active
^
ImGui_Col_NavWindowingHighlightFunctioncall:
C: int ImGui_Col_NavWindowingHighlight()
EEL2: int extension_api("ImGui_Col_NavWindowingHighlight")
Lua: integer reaper.ImGui_Col_NavWindowingHighlight()
Python: int ImGui_Col_NavWindowingHighlight()
Description:Highlight window when using CTRL+TAB
^
ImGui_Col_PlotHistogramFunctioncall:
C: int ImGui_Col_PlotHistogram()
EEL2: int extension_api("ImGui_Col_PlotHistogram")
Lua: integer reaper.ImGui_Col_PlotHistogram()
Python: int ImGui_Col_PlotHistogram()
Description:Python: Int ImGui_Col_PlotHistogram()
^
ImGui_Col_PlotHistogramHoveredFunctioncall:
C: int ImGui_Col_PlotHistogramHovered()
EEL2: int extension_api("ImGui_Col_PlotHistogramHovered")
Lua: integer reaper.ImGui_Col_PlotHistogramHovered()
Python: int ImGui_Col_PlotHistogramHovered()
Description:Python: Int ImGui_Col_PlotHistogramHovered()
^
ImGui_Col_PlotLinesFunctioncall:
C: int ImGui_Col_PlotLines()
EEL2: int extension_api("ImGui_Col_PlotLines")
Lua: integer reaper.ImGui_Col_PlotLines()
Python: int ImGui_Col_PlotLines()
Description:Python: Int ImGui_Col_PlotLines()
^
ImGui_Col_PlotLinesHoveredFunctioncall:
C: int ImGui_Col_PlotLinesHovered()
EEL2: int extension_api("ImGui_Col_PlotLinesHovered")
Lua: integer reaper.ImGui_Col_PlotLinesHovered()
Python: int ImGui_Col_PlotLinesHovered()
Description:Python: Int ImGui_Col_PlotLinesHovered()
^
ImGui_Col_PopupBgFunctioncall:
C: int ImGui_Col_PopupBg()
EEL2: int extension_api("ImGui_Col_PopupBg")
Lua: integer reaper.ImGui_Col_PopupBg()
Python: int ImGui_Col_PopupBg()
Description:Background of popups, menus, tooltips windows
^
ImGui_Col_ResizeGripFunctioncall:
C: int ImGui_Col_ResizeGrip()
EEL2: int extension_api("ImGui_Col_ResizeGrip")
Lua: integer reaper.ImGui_Col_ResizeGrip()
Python: int ImGui_Col_ResizeGrip()
Description:Python: Int ImGui_Col_ResizeGrip()
^
ImGui_Col_ResizeGripActiveFunctioncall:
C: int ImGui_Col_ResizeGripActive()
EEL2: int extension_api("ImGui_Col_ResizeGripActive")
Lua: integer reaper.ImGui_Col_ResizeGripActive()
Python: int ImGui_Col_ResizeGripActive()
Description:Python: Int ImGui_Col_ResizeGripActive()
^
ImGui_Col_ResizeGripHoveredFunctioncall:
C: int ImGui_Col_ResizeGripHovered()
EEL2: int extension_api("ImGui_Col_ResizeGripHovered")
Lua: integer reaper.ImGui_Col_ResizeGripHovered()
Python: int ImGui_Col_ResizeGripHovered()
Description:Python: Int ImGui_Col_ResizeGripHovered()
^
ImGui_Col_ScrollbarBgFunctioncall:
C: int ImGui_Col_ScrollbarBg()
EEL2: int extension_api("ImGui_Col_ScrollbarBg")
Lua: integer reaper.ImGui_Col_ScrollbarBg()
Python: int ImGui_Col_ScrollbarBg()
Description:Python: Int ImGui_Col_ScrollbarBg()
^
ImGui_Col_ScrollbarGrabFunctioncall:
C: int ImGui_Col_ScrollbarGrab()
EEL2: int extension_api("ImGui_Col_ScrollbarGrab")
Lua: integer reaper.ImGui_Col_ScrollbarGrab()
Python: int ImGui_Col_ScrollbarGrab()
Description:Python: Int ImGui_Col_ScrollbarGrab()
^
ImGui_Col_ScrollbarGrabActiveFunctioncall:
C: int ImGui_Col_ScrollbarGrabActive()
EEL2: int extension_api("ImGui_Col_ScrollbarGrabActive")
Lua: integer reaper.ImGui_Col_ScrollbarGrabActive()
Python: int ImGui_Col_ScrollbarGrabActive()
Description:Python: Int ImGui_Col_ScrollbarGrabActive()
^
ImGui_Col_ScrollbarGrabHoveredFunctioncall:
C: int ImGui_Col_ScrollbarGrabHovered()
EEL2: int extension_api("ImGui_Col_ScrollbarGrabHovered")
Lua: integer reaper.ImGui_Col_ScrollbarGrabHovered()
Python: int ImGui_Col_ScrollbarGrabHovered()
Description:Python: Int ImGui_Col_ScrollbarGrabHovered()
^
ImGui_Col_SeparatorFunctioncall:
C: int ImGui_Col_Separator()
EEL2: int extension_api("ImGui_Col_Separator")
Lua: integer reaper.ImGui_Col_Separator()
Python: int ImGui_Col_Separator()
Description:Python: Int ImGui_Col_Separator()
^
ImGui_Col_SeparatorActiveFunctioncall:
C: int ImGui_Col_SeparatorActive()
EEL2: int extension_api("ImGui_Col_SeparatorActive")
Lua: integer reaper.ImGui_Col_SeparatorActive()
Python: int ImGui_Col_SeparatorActive()
Description:Python: Int ImGui_Col_SeparatorActive()
^
ImGui_Col_SeparatorHoveredFunctioncall:
C: int ImGui_Col_SeparatorHovered()
EEL2: int extension_api("ImGui_Col_SeparatorHovered")
Lua: integer reaper.ImGui_Col_SeparatorHovered()
Python: int ImGui_Col_SeparatorHovered()
Description:Python: Int ImGui_Col_SeparatorHovered()
^
ImGui_Col_SliderGrabFunctioncall:
C: int ImGui_Col_SliderGrab()
EEL2: int extension_api("ImGui_Col_SliderGrab")
Lua: integer reaper.ImGui_Col_SliderGrab()
Python: int ImGui_Col_SliderGrab()
Description:Python: Int ImGui_Col_SliderGrab()
^
ImGui_Col_SliderGrabActiveFunctioncall:
C: int ImGui_Col_SliderGrabActive()
EEL2: int extension_api("ImGui_Col_SliderGrabActive")
Lua: integer reaper.ImGui_Col_SliderGrabActive()
Python: int ImGui_Col_SliderGrabActive()
Description:Python: Int ImGui_Col_SliderGrabActive()
^
ImGui_Col_TabFunctioncall:
C: int ImGui_Col_Tab()
EEL2: int extension_api("ImGui_Col_Tab")
Lua: integer reaper.ImGui_Col_Tab()
Python: int ImGui_Col_Tab()
Description:Python: Int ImGui_Col_Tab()
^
ImGui_Col_TabActiveFunctioncall:
C: int ImGui_Col_TabActive()
EEL2: int extension_api("ImGui_Col_TabActive")
Lua: integer reaper.ImGui_Col_TabActive()
Python: int ImGui_Col_TabActive()
Description:Python: Int ImGui_Col_TabActive()
^
ImGui_Col_TabHoveredFunctioncall:
C: int ImGui_Col_TabHovered()
EEL2: int extension_api("ImGui_Col_TabHovered")
Lua: integer reaper.ImGui_Col_TabHovered()
Python: int ImGui_Col_TabHovered()
Description:Python: Int ImGui_Col_TabHovered()
^
ImGui_Col_TabUnfocusedFunctioncall:
C: int ImGui_Col_TabUnfocused()
EEL2: int extension_api("ImGui_Col_TabUnfocused")
Lua: integer reaper.ImGui_Col_TabUnfocused()
Python: int ImGui_Col_TabUnfocused()
Description:Python: Int ImGui_Col_TabUnfocused()
^
ImGui_Col_TabUnfocusedActiveFunctioncall:
C: int ImGui_Col_TabUnfocusedActive()
EEL2: int extension_api("ImGui_Col_TabUnfocusedActive")
Lua: integer reaper.ImGui_Col_TabUnfocusedActive()
Python: int ImGui_Col_TabUnfocusedActive()
Description:Python: Int ImGui_Col_TabUnfocusedActive()
^
ImGui_Col_TableBorderLightFunctioncall:
C: int ImGui_Col_TableBorderLight()
EEL2: int extension_api("ImGui_Col_TableBorderLight")
Lua: integer reaper.ImGui_Col_TableBorderLight()
Python: int ImGui_Col_TableBorderLight()
Description:Table inner borders (prefer using Alpha=1.0 here)
^
ImGui_Col_TableBorderStrongFunctioncall:
C: int ImGui_Col_TableBorderStrong()
EEL2: int extension_api("ImGui_Col_TableBorderStrong")
Lua: integer reaper.ImGui_Col_TableBorderStrong()
Python: int ImGui_Col_TableBorderStrong()
Description:Table outer and header borders (prefer using Alpha=1.0 here)
^
ImGui_Col_TableHeaderBgFunctioncall:
C: int ImGui_Col_TableHeaderBg()
EEL2: int extension_api("ImGui_Col_TableHeaderBg")
Lua: integer reaper.ImGui_Col_TableHeaderBg()
Python: int ImGui_Col_TableHeaderBg()
Description:Table header background
^
ImGui_Col_TableRowBgFunctioncall:
C: int ImGui_Col_TableRowBg()
EEL2: int extension_api("ImGui_Col_TableRowBg")
Lua: integer reaper.ImGui_Col_TableRowBg()
Python: int ImGui_Col_TableRowBg()
Description:Table row background (even rows)
^
ImGui_Col_TableRowBgAltFunctioncall:
C: int ImGui_Col_TableRowBgAlt()
EEL2: int extension_api("ImGui_Col_TableRowBgAlt")
Lua: integer reaper.ImGui_Col_TableRowBgAlt()
Python: int ImGui_Col_TableRowBgAlt()
Description:Table row background (odd rows)
^
ImGui_Col_TextFunctioncall:
C: int ImGui_Col_Text()
EEL2: int extension_api("ImGui_Col_Text")
Lua: integer reaper.ImGui_Col_Text()
Python: int ImGui_Col_Text()
Description:Python: Int ImGui_Col_Text()
^
ImGui_Col_TextDisabledFunctioncall:
C: int ImGui_Col_TextDisabled()
EEL2: int extension_api("ImGui_Col_TextDisabled")
Lua: integer reaper.ImGui_Col_TextDisabled()
Python: int ImGui_Col_TextDisabled()
Description:Python: Int ImGui_Col_TextDisabled()
^
ImGui_Col_TextSelectedBgFunctioncall:
C: int ImGui_Col_TextSelectedBg()
EEL2: int extension_api("ImGui_Col_TextSelectedBg")
Lua: integer reaper.ImGui_Col_TextSelectedBg()
Python: int ImGui_Col_TextSelectedBg()
Description:Python: Int ImGui_Col_TextSelectedBg()
^
ImGui_Col_TitleBgFunctioncall:
C: int ImGui_Col_TitleBg()
EEL2: int extension_api("ImGui_Col_TitleBg")
Lua: integer reaper.ImGui_Col_TitleBg()
Python: int ImGui_Col_TitleBg()
Description:Python: Int ImGui_Col_TitleBg()
^
ImGui_Col_TitleBgActiveFunctioncall:
C: int ImGui_Col_TitleBgActive()
EEL2: int extension_api("ImGui_Col_TitleBgActive")
Lua: integer reaper.ImGui_Col_TitleBgActive()
Python: int ImGui_Col_TitleBgActive()
Description:Python: Int ImGui_Col_TitleBgActive()
^
ImGui_Col_TitleBgCollapsedFunctioncall:
C: int ImGui_Col_TitleBgCollapsed()
EEL2: int extension_api("ImGui_Col_TitleBgCollapsed")
Lua: integer reaper.ImGui_Col_TitleBgCollapsed()
Python: int ImGui_Col_TitleBgCollapsed()
Description:Python: Int ImGui_Col_TitleBgCollapsed()
^
ImGui_Col_WindowBgFunctioncall:
C: int ImGui_Col_WindowBg()
EEL2: int extension_api("ImGui_Col_WindowBg")
Lua: integer reaper.ImGui_Col_WindowBg()
Python: int ImGui_Col_WindowBg()
Description:Background of normal windows
^
ImGui_CollapsingHeaderFunctioncall:
C: bool ImGui_CollapsingHeader(ImGui_Context* ctx, const char* label, bool* p_visibleInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_CollapsingHeader", ImGui_Context ctx, "label", optional bool p_visibleIn, optional int flagsIn)
Lua: boolean reaper.ImGui_CollapsingHeader(ImGui_Context ctx, string label, optional boolean p_visibleIn, optional number flagsIn)
Python: bool ImGui_CollapsingHeader(ImGui_Context* ctx, const char* label, bool* p_visibleInOptional, int* flagsInOptional)
Description:Default values: flags = ImGui_TreeNodeFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| optional boolean p_visibleIn | - | |
| optional number flagsIn | - | |
^
ImGui_ColorButtonFunctioncall:
C: bool ImGui_ColorButton(ImGui_Context* ctx, const char* desc_id, int col_rgba, int* flagsInOptional, double* size_wInOptional, double* size_hInOptional)
EEL2: bool extension_api("ImGui_ColorButton", ImGui_Context ctx, "desc_id", int col_rgba, optional int flagsIn, optional size_wIn, optional size_hIn)
Lua: boolean reaper.ImGui_ColorButton(ImGui_Context ctx, string desc_id, integer col_rgba, optional number flagsIn, optional number size_wIn, optional number size_hIn)
Python: bool ImGui_ColorButton(ImGui_Context* ctx, const char* desc_id, int col_rgba, int* flagsInOptional, double* size_wInOptional, double* size_hInOptional)
Description:Default values: flags = ImGui_ColorEditFlags_None, size_w = 0.0, size_h = 0.0
| Parameters: |
| ImGui_Context ctx | - | |
| string desc_id | - | |
| integer col_rgba | - | |
| optional number flagsIn | - | |
| optional number size_wIn | - | |
| optional number size_hIn | - | |
^
ImGui_ColorConvertHSVtoRGBFunctioncall:
C: int ImGui_ColorConvertHSVtoRGB(double h, double s, double v, double* alphaInOptional, double* rOut, double* gOut, double* bOut)
EEL2: int extension_api("ImGui_ColorConvertHSVtoRGB", h, s, v, optional alphaIn, &r, &g, &b)
Lua: integer retval, number r, number g, number b = reaper.ImGui_ColorConvertHSVtoRGB(number h, number s, number v, optional number alphaIn)
Python: int ImGui_ColorConvertHSVtoRGB(double h, double s, double v, double* alphaInOptional, double* rOut, double* gOut, double* bOut)
Description:Default values: alpha = nil
| Parameters: |
| number h | - | |
| number s | - | |
| number v | - | |
| optional number alphaIn | - | |
| Returnvalues: |
| integer retval | - | |
| number r | - | |
| number g | - | |
| number b | - | - |
^
ImGui_ColorConvertNativeFunctioncall:
C: int ImGui_ColorConvertNative(int rgb)
EEL2: int extension_api("ImGui_ColorConvertNative", int rgb)
Lua: integer reaper.ImGui_ColorConvertNative(integer rgb)
Python: int ImGui_ColorConvertNative(int rgb)
Description:Convert native colors coming from REAPER. This swaps the red and blue channels of the specified 0xRRGGBB color on Windows.
| Parameters: |
| integer rgb | - | |
^
ImGui_ColorConvertRGBtoHSVFunctioncall:
C: int ImGui_ColorConvertRGBtoHSV(double r, double g, double b, double* alphaInOptional, double* hOut, double* sOut, double* vOut)
EEL2: int extension_api("ImGui_ColorConvertRGBtoHSV", r, g, b, optional alphaIn, &h, &s, &v)
Lua: integer retval, number h, number s, number v = reaper.ImGui_ColorConvertRGBtoHSV(number r, number g, number b, optional number alphaIn)
Python: int ImGui_ColorConvertRGBtoHSV(double r, double g, double b, double* alphaInOptional, double* hOut, double* sOut, double* vOut)
Description:Default values: alpha = nil
| Parameters: |
| number r | - | |
| number g | - | |
| number b | - | |
| optional number alphaIn | - | |
| Returnvalues: |
| integer retval | - | |
| number h | - | |
| number s | - | |
| number v | - | - |
^
ImGui_ColorEdit3Functioncall:
C: bool ImGui_ColorEdit3(ImGui_Context* ctx, const char* label, int* col_rgbInOut, int* flagsInOptional)
EEL2: bool extension_api("ImGui_ColorEdit3", ImGui_Context ctx, "label", int &col_rgb, optional int flagsIn)
Lua: boolean retval, number col_rgb = reaper.ImGui_ColorEdit3(ImGui_Context ctx, string label, number col_rgb, optional number flagsIn)
Python: bool ImGui_ColorEdit3(ImGui_Context* ctx, const char* label, int* col_rgbInOut, int* flagsInOptional)
Description:Default values: flags = ImGui_ColorEditFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number col_rgb | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number col_rgb | - | - |
^
ImGui_ColorEdit4Functioncall:
C: bool ImGui_ColorEdit4(ImGui_Context* ctx, const char* label, int* col_rgbaInOut, int* flagsInOptional)
EEL2: bool extension_api("ImGui_ColorEdit4", ImGui_Context ctx, "label", int &col_rgba, optional int flagsIn)
Lua: boolean retval, number col_rgba = reaper.ImGui_ColorEdit4(ImGui_Context ctx, string label, number col_rgba, optional number flagsIn)
Python: bool ImGui_ColorEdit4(ImGui_Context* ctx, const char* label, int* col_rgbaInOut, int* flagsInOptional)
Description:Default values: flags = ImGui_ColorEditFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number col_rgba | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number col_rgba | - | - |
^
ImGui_ColorEditFlags_AlphaBarFunctioncall:
C: int ImGui_ColorEditFlags_AlphaBar()
EEL2: int extension_api("ImGui_ColorEditFlags_AlphaBar")
Lua: integer reaper.ImGui_ColorEditFlags_AlphaBar()
Python: int ImGui_ColorEditFlags_AlphaBar()
Description:ColorEdit, ColorPicker: show vertical alpha bar/gradient in picker.
^
ImGui_ColorEditFlags_AlphaPreviewFunctioncall:
C: int ImGui_ColorEditFlags_AlphaPreview()
EEL2: int extension_api("ImGui_ColorEditFlags_AlphaPreview")
Lua: integer reaper.ImGui_ColorEditFlags_AlphaPreview()
Python: int ImGui_ColorEditFlags_AlphaPreview()
Description:ColorEdit, ColorPicker, ColorButton: display preview as a transparent color over a checkerboard, instead of opaque.
^
ImGui_ColorEditFlags_AlphaPreviewHalfFunctioncall:
C: int ImGui_ColorEditFlags_AlphaPreviewHalf()
EEL2: int extension_api("ImGui_ColorEditFlags_AlphaPreviewHalf")
Lua: integer reaper.ImGui_ColorEditFlags_AlphaPreviewHalf()
Python: int ImGui_ColorEditFlags_AlphaPreviewHalf()
Description:ColorEdit, ColorPicker, ColorButton: display half opaque / half checkerboard, instead of opaque.
^
ImGui_ColorEditFlags_DisplayHSVFunctioncall:
C: int ImGui_ColorEditFlags_DisplayHSV()
EEL2: int extension_api("ImGui_ColorEditFlags_DisplayHSV")
Lua: integer reaper.ImGui_ColorEditFlags_DisplayHSV()
Python: int ImGui_ColorEditFlags_DisplayHSV()
Description:ColorEdit: override _display_ type to HSV. ColorPicker: select any combination using one or more of RGB/HSV/Hex.
^
ImGui_ColorEditFlags_DisplayHexFunctioncall:
C: int ImGui_ColorEditFlags_DisplayHex()
EEL2: int extension_api("ImGui_ColorEditFlags_DisplayHex")
Lua: integer reaper.ImGui_ColorEditFlags_DisplayHex()
Python: int ImGui_ColorEditFlags_DisplayHex()
Description:ColorEdit: override _display_ type to Hex. ColorPicker: select any combination using one or more of RGB/HSV/Hex.
^
ImGui_ColorEditFlags_DisplayRGBFunctioncall:
C: int ImGui_ColorEditFlags_DisplayRGB()
EEL2: int extension_api("ImGui_ColorEditFlags_DisplayRGB")
Lua: integer reaper.ImGui_ColorEditFlags_DisplayRGB()
Python: int ImGui_ColorEditFlags_DisplayRGB()
Description:ColorEdit: override _display_ type to RGB. ColorPicker: select any combination using one or more of RGB/HSV/Hex.
^
ImGui_ColorEditFlags_FloatFunctioncall:
C: int ImGui_ColorEditFlags_Float()
EEL2: int extension_api("ImGui_ColorEditFlags_Float")
Lua: integer reaper.ImGui_ColorEditFlags_Float()
Python: int ImGui_ColorEditFlags_Float()
Description:ColorEdit, ColorPicker, ColorButton: _display_ values formatted as 0.0f..1.0f floats instead of 0..255 integers. No round-trip of value via integers.
^
ImGui_ColorEditFlags_InputHSVFunctioncall:
C: int ImGui_ColorEditFlags_InputHSV()
EEL2: int extension_api("ImGui_ColorEditFlags_InputHSV")
Lua: integer reaper.ImGui_ColorEditFlags_InputHSV()
Python: int ImGui_ColorEditFlags_InputHSV()
Description:ColorEdit, ColorPicker: input and output data in HSV format.
^
ImGui_ColorEditFlags_InputRGBFunctioncall:
C: int ImGui_ColorEditFlags_InputRGB()
EEL2: int extension_api("ImGui_ColorEditFlags_InputRGB")
Lua: integer reaper.ImGui_ColorEditFlags_InputRGB()
Python: int ImGui_ColorEditFlags_InputRGB()
Description:ColorEdit, ColorPicker: input and output data in RGB format.
^
ImGui_ColorEditFlags_NoAlphaFunctioncall:
C: int ImGui_ColorEditFlags_NoAlpha()
EEL2: int extension_api("ImGui_ColorEditFlags_NoAlpha")
Lua: integer reaper.ImGui_ColorEditFlags_NoAlpha()
Python: int ImGui_ColorEditFlags_NoAlpha()
Description:ColorEdit, ColorPicker, ColorButton: ignore Alpha component (will only read 3 components from the input pointer).
^
ImGui_ColorEditFlags_NoBorderFunctioncall:
C: int ImGui_ColorEditFlags_NoBorder()
EEL2: int extension_api("ImGui_ColorEditFlags_NoBorder")
Lua: integer reaper.ImGui_ColorEditFlags_NoBorder()
Python: int ImGui_ColorEditFlags_NoBorder()
Description:ColorButton: disable border (which is enforced by default)
^
ImGui_ColorEditFlags_NoDragDropFunctioncall:
C: int ImGui_ColorEditFlags_NoDragDrop()
EEL2: int extension_api("ImGui_ColorEditFlags_NoDragDrop")
Lua: integer reaper.ImGui_ColorEditFlags_NoDragDrop()
Python: int ImGui_ColorEditFlags_NoDragDrop()
Description:ColorEdit: disable drag and drop target. ColorButton: disable drag and drop source.
^
ImGui_ColorEditFlags_NoInputsFunctioncall:
C: int ImGui_ColorEditFlags_NoInputs()
EEL2: int extension_api("ImGui_ColorEditFlags_NoInputs")
Lua: integer reaper.ImGui_ColorEditFlags_NoInputs()
Python: int ImGui_ColorEditFlags_NoInputs()
Description:ColorEdit, ColorPicker: disable inputs sliders/text widgets (e.g. to show only the small preview color square).
^
ImGui_ColorEditFlags_NoLabelFunctioncall:
C: int ImGui_ColorEditFlags_NoLabel()
EEL2: int extension_api("ImGui_ColorEditFlags_NoLabel")
Lua: integer reaper.ImGui_ColorEditFlags_NoLabel()
Python: int ImGui_ColorEditFlags_NoLabel()
Description:ColorEdit, ColorPicker: disable display of inline text label (the label is still forwarded to the tooltip and picker).
^
ImGui_ColorEditFlags_NoOptionsFunctioncall:
C: int ImGui_ColorEditFlags_NoOptions()
EEL2: int extension_api("ImGui_ColorEditFlags_NoOptions")
Lua: integer reaper.ImGui_ColorEditFlags_NoOptions()
Python: int ImGui_ColorEditFlags_NoOptions()
Description:ColorEdit: disable toggling options menu when right-clicking on inputs/small preview.
^
ImGui_ColorEditFlags_NoPickerFunctioncall:
C: int ImGui_ColorEditFlags_NoPicker()
EEL2: int extension_api("ImGui_ColorEditFlags_NoPicker")
Lua: integer reaper.ImGui_ColorEditFlags_NoPicker()
Python: int ImGui_ColorEditFlags_NoPicker()
Description:ColorEdit: disable picker when clicking on color square.
^
ImGui_ColorEditFlags_NoSidePreviewFunctioncall:
C: int ImGui_ColorEditFlags_NoSidePreview()
EEL2: int extension_api("ImGui_ColorEditFlags_NoSidePreview")
Lua: integer reaper.ImGui_ColorEditFlags_NoSidePreview()
Python: int ImGui_ColorEditFlags_NoSidePreview()
Description:ColorPicker: disable bigger color preview on right side of the picker, use small color square preview instead.
^
ImGui_ColorEditFlags_NoSmallPreviewFunctioncall:
C: int ImGui_ColorEditFlags_NoSmallPreview()
EEL2: int extension_api("ImGui_ColorEditFlags_NoSmallPreview")
Lua: integer reaper.ImGui_ColorEditFlags_NoSmallPreview()
Python: int ImGui_ColorEditFlags_NoSmallPreview()
Description:ColorEdit, ColorPicker: disable color square preview next to the inputs. (e.g. to show only the inputs)
^
ImGui_ColorEditFlags_NoTooltipFunctioncall:
C: int ImGui_ColorEditFlags_NoTooltip()
EEL2: int extension_api("ImGui_ColorEditFlags_NoTooltip")
Lua: integer reaper.ImGui_ColorEditFlags_NoTooltip()
Python: int ImGui_ColorEditFlags_NoTooltip()
Description:ColorEdit, ColorPicker, ColorButton: disable tooltip when hovering the preview.
^
ImGui_ColorEditFlags_NoneFunctioncall:
C: int ImGui_ColorEditFlags_None()
EEL2: int extension_api("ImGui_ColorEditFlags_None")
Lua: integer reaper.ImGui_ColorEditFlags_None()
Python: int ImGui_ColorEditFlags_None()
Description:Flags for ColorEdit3() / ColorEdit4() / ColorPicker3() / ColorPicker4() / ColorButton()
^
ImGui_ColorEditFlags_PickerHueBarFunctioncall:
C: int ImGui_ColorEditFlags_PickerHueBar()
EEL2: int extension_api("ImGui_ColorEditFlags_PickerHueBar")
Lua: integer reaper.ImGui_ColorEditFlags_PickerHueBar()
Python: int ImGui_ColorEditFlags_PickerHueBar()
Description:ColorPicker: bar for Hue, rectangle for Sat/Value.
^
ImGui_ColorEditFlags_PickerHueWheelFunctioncall:
C: int ImGui_ColorEditFlags_PickerHueWheel()
EEL2: int extension_api("ImGui_ColorEditFlags_PickerHueWheel")
Lua: integer reaper.ImGui_ColorEditFlags_PickerHueWheel()
Python: int ImGui_ColorEditFlags_PickerHueWheel()
Description:ColorPicker: wheel for Hue, triangle for Sat/Value.
^
ImGui_ColorEditFlags_Uint8Functioncall:
C: int ImGui_ColorEditFlags_Uint8()
EEL2: int extension_api("ImGui_ColorEditFlags_Uint8")
Lua: integer reaper.ImGui_ColorEditFlags_Uint8()
Python: int ImGui_ColorEditFlags_Uint8()
Description:ColorEdit, ColorPicker, ColorButton: _display_ values formatted as 0..255.
^
ImGui_ColorEditFlags__OptionsDefaultFunctioncall:
C: int ImGui_ColorEditFlags__OptionsDefault()
EEL2: int extension_api("ImGui_ColorEditFlags__OptionsDefault")
Lua: integer reaper.ImGui_ColorEditFlags__OptionsDefault()
Python: int ImGui_ColorEditFlags__OptionsDefault()
Description:Defaults Options. You can set application defaults using SetColorEditOptions(). The intent is that you probably don't want to override them in most of your calls. Let the user choose via the option menu and/or call SetColorEditOptions() once during startup.
^
ImGui_ColorPicker3Functioncall:
C: bool ImGui_ColorPicker3(ImGui_Context* ctx, const char* label, int* col_rgbInOut, int* flagsInOptional)
EEL2: bool extension_api("ImGui_ColorPicker3", ImGui_Context ctx, "label", int &col_rgb, optional int flagsIn)
Lua: boolean retval, number col_rgb = reaper.ImGui_ColorPicker3(ImGui_Context ctx, string label, number col_rgb, optional number flagsIn)
Python: bool ImGui_ColorPicker3(ImGui_Context* ctx, const char* label, int* col_rgbInOut, int* flagsInOptional)
Description:Default values: flags = ImGui_ColorEditFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number col_rgb | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number col_rgb | - | - |
^
ImGui_ColorPicker4Functioncall:
C: bool ImGui_ColorPicker4(ImGui_Context* ctx, const char* label, int* col_rgbaInOut, int* flagsInOptional, int* ref_colInOptional)
EEL2: bool extension_api("ImGui_ColorPicker4", ImGui_Context ctx, "label", int &col_rgba, optional int flagsIn, optional int ref_colIn)
Lua: boolean retval, number col_rgba = reaper.ImGui_ColorPicker4(ImGui_Context ctx, string label, number col_rgba, optional number flagsIn, optional number ref_colIn)
Python: bool ImGui_ColorPicker4(ImGui_Context* ctx, const char* label, int* col_rgbaInOut, int* flagsInOptional, int* ref_colInOptional)
Description:Default values: flags = ImGui_ColorEditFlags_None, ref_col = nil
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number col_rgba | - | |
| optional number flagsIn | - | |
| optional number ref_colIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number col_rgba | - | - |
^
ImGui_ComboFunctioncall:
C: bool ImGui_Combo(ImGui_Context* ctx, const char* label, int* current_itemInOut, char* items, int* popup_max_height_in_itemsInOptional)
EEL2: bool extension_api("ImGui_Combo", ImGui_Context ctx, "label", int ¤t_item, #items, optional int popup_max_height_in_itemsIn)
Lua: boolean retval, number current_item, string items = reaper.ImGui_Combo(ImGui_Context ctx, string label, number current_item, string items, optional number popup_max_height_in_itemsIn)
Python: bool ImGui_Combo(ImGui_Context* ctx, const char* label, int* current_itemInOut, char* items, int* popup_max_height_in_itemsInOptional)
Description:Default values: popup_max_height_in_items = -1
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number current_item | - | |
| string items | - | |
| optional number popup_max_height_in_itemsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number current_item | - | |
| string items | - | - |
^
ImGui_ComboFlags_HeightLargeFunctioncall:
C: int ImGui_ComboFlags_HeightLarge()
EEL2: int extension_api("ImGui_ComboFlags_HeightLarge")
Lua: integer reaper.ImGui_ComboFlags_HeightLarge()
Python: int ImGui_ComboFlags_HeightLarge()
Description:Max ~20 items visible
^
ImGui_ComboFlags_HeightLargestFunctioncall:
C: int ImGui_ComboFlags_HeightLargest()
EEL2: int extension_api("ImGui_ComboFlags_HeightLargest")
Lua: integer reaper.ImGui_ComboFlags_HeightLargest()
Python: int ImGui_ComboFlags_HeightLargest()
Description:As many fitting items as possible
^
ImGui_ComboFlags_HeightRegularFunctioncall:
C: int ImGui_ComboFlags_HeightRegular()
EEL2: int extension_api("ImGui_ComboFlags_HeightRegular")
Lua: integer reaper.ImGui_ComboFlags_HeightRegular()
Python: int ImGui_ComboFlags_HeightRegular()
Description:Max ~8 items visible (default)
^
ImGui_ComboFlags_HeightSmallFunctioncall:
C: int ImGui_ComboFlags_HeightSmall()
EEL2: int extension_api("ImGui_ComboFlags_HeightSmall")
Lua: integer reaper.ImGui_ComboFlags_HeightSmall()
Python: int ImGui_ComboFlags_HeightSmall()
Description:Max ~4 items visible. Tip: If you want your combo popup to be a specific size you can use SetNextWindowSizeConstraints() prior to calling BeginCombo()
^
ImGui_ComboFlags_NoArrowButtonFunctioncall:
C: int ImGui_ComboFlags_NoArrowButton()
EEL2: int extension_api("ImGui_ComboFlags_NoArrowButton")
Lua: integer reaper.ImGui_ComboFlags_NoArrowButton()
Python: int ImGui_ComboFlags_NoArrowButton()
Description:Display on the preview box without the square arrow button
^
ImGui_ComboFlags_NoPreviewFunctioncall:
C: int ImGui_ComboFlags_NoPreview()
EEL2: int extension_api("ImGui_ComboFlags_NoPreview")
Lua: integer reaper.ImGui_ComboFlags_NoPreview()
Python: int ImGui_ComboFlags_NoPreview()
Description:Display only a square arrow button
^
ImGui_ComboFlags_NoneFunctioncall:
C: int ImGui_ComboFlags_None()
EEL2: int extension_api("ImGui_ComboFlags_None")
Lua: integer reaper.ImGui_ComboFlags_None()
Python: int ImGui_ComboFlags_None()
Description:Flags for ImGui::BeginCombo()
^
ImGui_ComboFlags_PopupAlignLeftFunctioncall:
C: int ImGui_ComboFlags_PopupAlignLeft()
EEL2: int extension_api("ImGui_ComboFlags_PopupAlignLeft")
Lua: integer reaper.ImGui_ComboFlags_PopupAlignLeft()
Python: int ImGui_ComboFlags_PopupAlignLeft()
Description:Align the popup toward the left by default
^
ImGui_Cond_AlwaysFunctioncall:
C: int ImGui_Cond_Always()
EEL2: int extension_api("ImGui_Cond_Always")
Lua: integer reaper.ImGui_Cond_Always()
Python: int ImGui_Cond_Always()
Description:No condition (always set the variable)
^
ImGui_Cond_AppearingFunctioncall:
C: int ImGui_Cond_Appearing()
EEL2: int extension_api("ImGui_Cond_Appearing")
Lua: integer reaper.ImGui_Cond_Appearing()
Python: int ImGui_Cond_Appearing()
Description:Set the variable if the object/window is appearing after being hidden/inactive (or the first time)
^
ImGui_Cond_FirstUseEverFunctioncall:
C: int ImGui_Cond_FirstUseEver()
EEL2: int extension_api("ImGui_Cond_FirstUseEver")
Lua: integer reaper.ImGui_Cond_FirstUseEver()
Python: int ImGui_Cond_FirstUseEver()
Description:Set the variable if the object/window has no persistently saved data (no entry in .ini file)
^
ImGui_Cond_OnceFunctioncall:
C: int ImGui_Cond_Once()
EEL2: int extension_api("ImGui_Cond_Once")
Lua: integer reaper.ImGui_Cond_Once()
Python: int ImGui_Cond_Once()
Description:Set the variable once per runtime session (only the first call will succeed)
^
ImGui_ConfigFlags_NavEnableKeyboardFunctioncall:
C: int ImGui_ConfigFlags_NavEnableKeyboard()
EEL2: int extension_api("ImGui_ConfigFlags_NavEnableKeyboard")
Lua: integer reaper.ImGui_ConfigFlags_NavEnableKeyboard()
Python: int ImGui_ConfigFlags_NavEnableKeyboard()
Description:Master keyboard navigation enable flag.
^
ImGui_ConfigFlags_NavEnableSetMousePosFunctioncall:
C: int ImGui_ConfigFlags_NavEnableSetMousePos()
EEL2: int extension_api("ImGui_ConfigFlags_NavEnableSetMousePos")
Lua: integer reaper.ImGui_ConfigFlags_NavEnableSetMousePos()
Python: int ImGui_ConfigFlags_NavEnableSetMousePos()
Description:Instruct navigation to move the mouse cursor.
^
ImGui_ConfigFlags_NoMouseFunctioncall:
C: int ImGui_ConfigFlags_NoMouse()
EEL2: int extension_api("ImGui_ConfigFlags_NoMouse")
Lua: integer reaper.ImGui_ConfigFlags_NoMouse()
Python: int ImGui_ConfigFlags_NoMouse()
Description:Instruct imgui to clear mouse position/buttons in NewFrame(). This allows ignoring the mouse information set by the backend.
^
ImGui_ConfigFlags_NoMouseCursorChangeFunctioncall:
C: int ImGui_ConfigFlags_NoMouseCursorChange()
EEL2: int extension_api("ImGui_ConfigFlags_NoMouseCursorChange")
Lua: integer reaper.ImGui_ConfigFlags_NoMouseCursorChange()
Python: int ImGui_ConfigFlags_NoMouseCursorChange()
Description:Instruct backend to not alter mouse cursor shape and visibility.
^
ImGui_ConfigFlags_NoSavedSettingsFunctioncall:
C: int ImGui_ConfigFlags_NoSavedSettings()
EEL2: int extension_api("ImGui_ConfigFlags_NoSavedSettings")
Lua: integer reaper.ImGui_ConfigFlags_NoSavedSettings()
Python: int ImGui_ConfigFlags_NoSavedSettings()
Description:Disable state restoration and persistence for the whole context
^
ImGui_ConfigFlags_NoneFunctioncall:
C: int ImGui_ConfigFlags_None()
EEL2: int extension_api("ImGui_ConfigFlags_None")
Lua: integer reaper.ImGui_ConfigFlags_None()
Python: int ImGui_ConfigFlags_None()
Description:Flags for ImGui_SetConfigFlags
^
ImGui_CreateContextFunctioncall:
C: ImGui_Context* ImGui_CreateContext(const char* name, int size_w, int size_h, int* pos_xInOptional, int* pos_yInOptional, int* dockInOptional, int* config_flagsInOptional)
EEL2: ImGui_Context extension_api("ImGui_CreateContext", "name", int size_w, int size_h, optional int pos_xIn, optional int pos_yIn, optional int dockIn, optional int config_flagsIn)
Lua: ImGui_Context reaper.ImGui_CreateContext(string name, integer size_w, integer size_h, optional number pos_xIn, optional number pos_yIn, optional number dockIn, optional number config_flagsIn)
Python: ImGui_Context* ImGui_CreateContext(const char* name, int size_w, int size_h, int* pos_xInOptional, int* pos_yInOptional, int* dockInOptional, int* config_flagsInOptional)
Description:Default values: pos_x = 0x80000000, pos_y = 0x80000000, dock = 0, config_flags = ImGui_ConfigFlags_None
| Parameters: |
| string name | - | |
| integer size_w | - | |
| integer size_h | - | |
| optional number pos_xIn | - | |
| optional number pos_yIn | - | |
| optional number dockIn | - | |
| optional number config_flagsIn | - | |
| Returnvalues: |
| ImGui_Context | - | |
^
ImGui_CreateFontFunctioncall:
C: ImGui_Font* ImGui_CreateFont(const char* family_or_file, int size, int* flagsInOptional)
EEL2: ImGui_Font extension_api("ImGui_CreateFont", "family_or_file", int size, optional int flagsIn)
Lua: ImGui_Font reaper.ImGui_CreateFont(string family_or_file, integer size, optional number flagsIn)
Python: ImGui_Font* ImGui_CreateFont(const char* family_or_file, int size, int* flagsInOptional)
Description:Default values: flags = ImGui_FontFlags_None
| Parameters: |
| string family_or_file | - | |
| integer size | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| ImGui_Font | - | |
^
ImGui_CreateListClipperFunctioncall:
C: ImGui_ListClipper* ImGui_CreateListClipper(ImGui_Context* ctx)
EEL2: ImGui_ListClipper extension_api("ImGui_CreateListClipper", ImGui_Context ctx)
Lua: ImGui_ListClipper reaper.ImGui_CreateListClipper(ImGui_Context ctx)
Python: ImGui_ListClipper* ImGui_CreateListClipper(ImGui_Context* ctx)
Description:The returned clipper object is tied to the context and is valid as long as it is used in each defer cycle. See
ImGui_ListClipper_Begin.
| Parameters: |
| ImGui_Context ctx | - | |
| Returnvalues: |
| ImGui_ListClipper | - | |
^
ImGui_DestroyContextFunctioncall:
C: void ImGui_DestroyContext(ImGui_Context* ctx)
EEL2: extension_api("ImGui_DestroyContext", ImGui_Context ctx)
Lua: reaper.ImGui_DestroyContext(ImGui_Context ctx)
Python: void ImGui_DestroyContext(ImGui_Context* ctx)
Description:Close and free the resources used by a context.
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_Dir_DownFunctioncall:
C: int ImGui_Dir_Down()
EEL2: int extension_api("ImGui_Dir_Down")
Lua: integer reaper.ImGui_Dir_Down()
Python: int ImGui_Dir_Down()
Description:A cardinal direction
^
ImGui_Dir_LeftFunctioncall:
C: int ImGui_Dir_Left()
EEL2: int extension_api("ImGui_Dir_Left")
Lua: integer reaper.ImGui_Dir_Left()
Python: int ImGui_Dir_Left()
Description:A cardinal direction
^
ImGui_Dir_NoneFunctioncall:
C: int ImGui_Dir_None()
EEL2: int extension_api("ImGui_Dir_None")
Lua: integer reaper.ImGui_Dir_None()
Python: int ImGui_Dir_None()
Description:A cardinal direction
^
ImGui_Dir_RightFunctioncall:
C: int ImGui_Dir_Right()
EEL2: int extension_api("ImGui_Dir_Right")
Lua: integer reaper.ImGui_Dir_Right()
Python: int ImGui_Dir_Right()
Description:A cardinal direction
^
ImGui_Dir_UpFunctioncall:
C: int ImGui_Dir_Up()
EEL2: int extension_api("ImGui_Dir_Up")
Lua: integer reaper.ImGui_Dir_Up()
Python: int ImGui_Dir_Up()
Description:A cardinal direction
^
ImGui_DragDoubleFunctioncall:
C: bool ImGui_DragDouble(ImGui_Context* ctx, const char* label, double* vInOut, double* v_speedInOptional, double* v_minInOptional, double* v_maxInOptional, const char* formatInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_DragDouble", ImGui_Context ctx, "label", &v, optional v_speedIn, optional v_minIn, optional v_maxIn, optional "formatIn", optional int flagsIn)
Lua: boolean retval, number v = reaper.ImGui_DragDouble(ImGui_Context ctx, string label, number v, optional number v_speedIn, optional number v_minIn, optional number v_maxIn, optional string formatIn, optional number flagsIn)
Python: bool ImGui_DragDouble(ImGui_Context* ctx, const char* label, double* vInOut, double* v_speedInOptional, double* v_minInOptional, double* v_maxInOptional, const char* formatInOptional, int* flagsInOptional)
Description:Default values: v_speed = 1.0, v_min = 0.0, v_max = 0.0, format = '%.3f', flags = ImGui_SliderFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number v | - | |
| optional number v_speedIn | - | |
| optional number v_minIn | - | |
| optional number v_maxIn | - | |
| optional string formatIn | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number v | - | - |
^
ImGui_DragDouble2Functioncall:
C: bool ImGui_DragDouble2(ImGui_Context* ctx, const char* label, double* v1InOut, double* v2InOut, double* v_speedInOptional, double* v_minInOptional, double* v_maxInOptional, const char* formatInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_DragDouble2", ImGui_Context ctx, "label", &v1, &v2, optional v_speedIn, optional v_minIn, optional v_maxIn, optional "formatIn", optional int flagsIn)
Lua: boolean retval, number v1, number v2 = reaper.ImGui_DragDouble2(ImGui_Context ctx, string label, number v1, number v2, optional number v_speedIn, optional number v_minIn, optional number v_maxIn, optional string formatIn, optional number flagsIn)
Python: bool ImGui_DragDouble2(ImGui_Context* ctx, const char* label, double* v1InOut, double* v2InOut, double* v_speedInOptional, double* v_minInOptional, double* v_maxInOptional, const char* formatInOptional, int* flagsInOptional)
Description:Default values: v_speed = 1.0, v_min = 0.0, v_max = 0.0, format = '%.3f', flags = ImGui_SliderFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number v1 | - | |
| number v2 | - | |
| optional number v_speedIn | - | |
| optional number v_minIn | - | |
| optional number v_maxIn | - | |
| optional string formatIn | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number v1 | - | |
| number v2 | - | - |
^
ImGui_DragDouble3Functioncall:
C: bool ImGui_DragDouble3(ImGui_Context* ctx, const char* label, double* v1InOut, double* v2InOut, double* v3InOut, double* v_speedInOptional, double* v_minInOptional, double* v_maxInOptional, const char* formatInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_DragDouble3", ImGui_Context ctx, "label", &v1, &v2, &v3, optional v_speedIn, optional v_minIn, optional v_maxIn, optional "formatIn", optional int flagsIn)
Lua: boolean retval, number v1, number v2, number v3 = reaper.ImGui_DragDouble3(ImGui_Context ctx, string label, number v1, number v2, number v3, optional number v_speedIn, optional number v_minIn, optional number v_maxIn, optional string formatIn, optional number flagsIn)
Python: bool ImGui_DragDouble3(ImGui_Context* ctx, const char* label, double* v1InOut, double* v2InOut, double* v3InOut, double* v_speedInOptional, double* v_minInOptional, double* v_maxInOptional, const char* formatInOptional, int* flagsInOptional)
Description:Default values: v_speed = 1.0, v_min = 0.0, v_max = 0.0, format = '%.3f', flags = ImGui_SliderFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number v1 | - | |
| number v2 | - | |
| number v3 | - | |
| optional number v_speedIn | - | |
| optional number v_minIn | - | |
| optional number v_maxIn | - | |
| optional string formatIn | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number v1 | - | |
| number v2 | - | |
| number v3 | - | - |
^
ImGui_DragDouble4Functioncall:
C: bool ImGui_DragDouble4(ImGui_Context* ctx, const char* label, double* v1InOut, double* v2InOut, double* v3InOut, double* v4InOut, double* v_speedInOptional, double* v_minInOptional, double* v_maxInOptional, const char* formatInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_DragDouble4", ImGui_Context ctx, "label", &v1, &v2, &v3, &v4, optional v_speedIn, optional v_minIn, optional v_maxIn, optional "formatIn", optional int flagsIn)
Lua: boolean retval, number v1, number v2, number v3, number v4 = reaper.ImGui_DragDouble4(ImGui_Context ctx, string label, number v1, number v2, number v3, number v4, optional number v_speedIn, optional number v_minIn, optional number v_maxIn, optional string formatIn, optional number flagsIn)
Python: bool ImGui_DragDouble4(ImGui_Context* ctx, const char* label, double* v1InOut, double* v2InOut, double* v3InOut, double* v4InOut, double* v_speedInOptional, double* v_minInOptional, double* v_maxInOptional, const char* formatInOptional, int* flagsInOptional)
Description:Default values: v_speed = 1.0, v_min = 0.0, v_max = 0.0, format = '%.3f', flags = ImGui_SliderFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number v1 | - | |
| number v2 | - | |
| number v3 | - | |
| number v4 | - | |
| optional number v_speedIn | - | |
| optional number v_minIn | - | |
| optional number v_maxIn | - | |
| optional string formatIn | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number v1 | - | |
| number v2 | - | |
| number v3 | - | |
| number v4 | - | - |
^
ImGui_DragDoubleNFunctioncall:
C: bool ImGui_DragDoubleN(ImGui_Context* ctx, const char* label, reaper_array* values, double* speedInOptional, double* minInOptional, double* maxInOptional, const char* formatInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_DragDoubleN", ImGui_Context ctx, "label", reaper_array values, optional speedIn, optional minIn, optional maxIn, optional "formatIn", optional int flagsIn)
Lua: boolean reaper.ImGui_DragDoubleN(ImGui_Context ctx, string labelreaper_array values, optional number speedIn, optional number minIn, optional number maxIn, optional string formatIn, optional number flagsIn)
Python: bool ImGui_DragDoubleN(ImGui_Context* ctx, const char* label, reaper_array* values, double* speedInOptional, double* minInOptional, double* maxInOptional, const char* formatInOptional, int* flagsInOptional)
Description:Default values: speed = 1.0, min = nil, max = nil, format = '%.3f', flags = ImGui_SliderFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string labelreaper_array values | - | |
| optional number speedIn | - | |
| optional number minIn | - | |
| optional number maxIn | - | |
| optional string formatIn | - | |
| optional number flagsIn | - | |
^
ImGui_DragDropFlags_AcceptBeforeDeliveryFunctioncall:
C: int ImGui_DragDropFlags_AcceptBeforeDelivery()
EEL2: int extension_api("ImGui_DragDropFlags_AcceptBeforeDelivery")
Lua: integer reaper.ImGui_DragDropFlags_AcceptBeforeDelivery()
Python: int ImGui_DragDropFlags_AcceptBeforeDelivery()
Description:AcceptDragDropPayload() will returns true even before the mouse button is released. You can then call IsDelivery() to test if the payload needs to be delivered.
^
ImGui_DragDropFlags_AcceptNoDrawDefaultRectFunctioncall:
C: int ImGui_DragDropFlags_AcceptNoDrawDefaultRect()
EEL2: int extension_api("ImGui_DragDropFlags_AcceptNoDrawDefaultRect")
Lua: integer reaper.ImGui_DragDropFlags_AcceptNoDrawDefaultRect()
Python: int ImGui_DragDropFlags_AcceptNoDrawDefaultRect()
Description:Do not draw the default highlight rectangle when hovering over target.
^
ImGui_DragDropFlags_AcceptNoPreviewTooltipFunctioncall:
C: int ImGui_DragDropFlags_AcceptNoPreviewTooltip()
EEL2: int extension_api("ImGui_DragDropFlags_AcceptNoPreviewTooltip")
Lua: integer reaper.ImGui_DragDropFlags_AcceptNoPreviewTooltip()
Python: int ImGui_DragDropFlags_AcceptNoPreviewTooltip()
Description:Request hiding the BeginDragDropSource tooltip from the BeginDragDropTarget site.
^
ImGui_DragDropFlags_AcceptPeekOnlyFunctioncall:
C: int ImGui_DragDropFlags_AcceptPeekOnly()
EEL2: int extension_api("ImGui_DragDropFlags_AcceptPeekOnly")
Lua: integer reaper.ImGui_DragDropFlags_AcceptPeekOnly()
Python: int ImGui_DragDropFlags_AcceptPeekOnly()
Description:For peeking ahead and inspecting the payload before delivery. Equivalent to ImGuiDragDropFlags_AcceptBeforeDelivery | ImGuiDragDropFlags_AcceptNoDrawDefaultRect.
^
ImGui_DragDropFlags_NoneFunctioncall:
C: int ImGui_DragDropFlags_None()
EEL2: int extension_api("ImGui_DragDropFlags_None")
Lua: integer reaper.ImGui_DragDropFlags_None()
Python: int ImGui_DragDropFlags_None()
Description:Flags for ImGui::BeginDragDropSource(), ImGui::AcceptDragDropPayload()
^
ImGui_DragDropFlags_SourceAllowNullIDFunctioncall:
C: int ImGui_DragDropFlags_SourceAllowNullID()
EEL2: int extension_api("ImGui_DragDropFlags_SourceAllowNullID")
Lua: integer reaper.ImGui_DragDropFlags_SourceAllowNullID()
Python: int ImGui_DragDropFlags_SourceAllowNullID()
Description:Allow items such as Text(), Image() that have no unique identifier to be used as drag source, by manufacturing a temporary identifier based on their window-relative position. This is extremely unusual within the dear imgui ecosystem and so we made it explicit.
^
ImGui_DragDropFlags_SourceAutoExpirePayloadFunctioncall:
C: int ImGui_DragDropFlags_SourceAutoExpirePayload()
EEL2: int extension_api("ImGui_DragDropFlags_SourceAutoExpirePayload")
Lua: integer reaper.ImGui_DragDropFlags_SourceAutoExpirePayload()
Python: int ImGui_DragDropFlags_SourceAutoExpirePayload()
Description:Automatically expire the payload if the source cease to be submitted (otherwise payloads are persisting while being dragged)
^
ImGui_DragDropFlags_SourceExternFunctioncall:
C: int ImGui_DragDropFlags_SourceExtern()
EEL2: int extension_api("ImGui_DragDropFlags_SourceExtern")
Lua: integer reaper.ImGui_DragDropFlags_SourceExtern()
Python: int ImGui_DragDropFlags_SourceExtern()
Description:External source (from outside of dear imgui), won't attempt to read current item/window info. Will always return true. Only one Extern source can be active simultaneously.
^
ImGui_DragDropFlags_SourceNoDisableHoverFunctioncall:
C: int ImGui_DragDropFlags_SourceNoDisableHover()
EEL2: int extension_api("ImGui_DragDropFlags_SourceNoDisableHover")
Lua: integer reaper.ImGui_DragDropFlags_SourceNoDisableHover()
Python: int ImGui_DragDropFlags_SourceNoDisableHover()
Description:By default, when dragging we clear data so that IsItemHovered() will return false, to avoid subsequent user code submitting tooltips. This flag disable this behavior so you can still call IsItemHovered() on the source item.
^
ImGui_DragDropFlags_SourceNoHoldToOpenOthersFunctioncall:
C: int ImGui_DragDropFlags_SourceNoHoldToOpenOthers()
EEL2: int extension_api("ImGui_DragDropFlags_SourceNoHoldToOpenOthers")
Lua: integer reaper.ImGui_DragDropFlags_SourceNoHoldToOpenOthers()
Python: int ImGui_DragDropFlags_SourceNoHoldToOpenOthers()
Description:Disable the behavior that allows to open tree nodes and collapsing header by holding over them while dragging a source item.
^
ImGui_DragDropFlags_SourceNoPreviewTooltipFunctioncall:
C: int ImGui_DragDropFlags_SourceNoPreviewTooltip()
EEL2: int extension_api("ImGui_DragDropFlags_SourceNoPreviewTooltip")
Lua: integer reaper.ImGui_DragDropFlags_SourceNoPreviewTooltip()
Python: int ImGui_DragDropFlags_SourceNoPreviewTooltip()
Description:By default, a successful call to BeginDragDropSource opens a tooltip so you can display a preview or description of the source contents. This flag disable this behavior.
^
ImGui_DragFloatRange2Functioncall:
C: bool ImGui_DragFloatRange2(ImGui_Context* ctx, const char* label, double* v_current_minInOut, double* v_current_maxInOut, double* v_speedInOptional, double* v_minInOptional, double* v_maxInOptional, const char* formatInOptional, const char* format_maxInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_DragFloatRange2", ImGui_Context ctx, "label", &v_current_min, &v_current_max, optional v_speedIn, optional v_minIn, optional v_maxIn, optional "formatIn", optional "format_maxIn", optional int flagsIn)
Lua: boolean retval, number v_current_min, number v_current_max = reaper.ImGui_DragFloatRange2(ImGui_Context ctx, string label, number v_current_min, number v_current_max, optional number v_speedIn, optional number v_minIn, optional number v_maxIn, optional string formatIn, optional string format_maxIn, optional number flagsIn)
Python: bool ImGui_DragFloatRange2(ImGui_Context* ctx, const char* label, double* v_current_minInOut, double* v_current_maxInOut, double* v_speedInOptional, double* v_minInOptional, double* v_maxInOptional, const char* formatInOptional, const char* format_maxInOptional, int* flagsInOptional)
Description:Default values: v_speed = 1.0, v_min = 0.0, v_max = 0.0, format = '%.3f', format_max = nil, flags = ImGui_SliderFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number v_current_min | - | |
| number v_current_max | - | |
| optional number v_speedIn | - | |
| optional number v_minIn | - | |
| optional number v_maxIn | - | |
| optional string formatIn | - | |
| optional string format_maxIn | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number v_current_min | - | |
| number v_current_max | - | - |
^
ImGui_DragIntFunctioncall:
C: bool ImGui_DragInt(ImGui_Context* ctx, const char* label, int* vInOut, double* v_speedInOptional, int* v_minInOptional, int* v_maxInOptional, const char* formatInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_DragInt", ImGui_Context ctx, "label", int &v, optional v_speedIn, optional int v_minIn, optional int v_maxIn, optional "formatIn", optional int flagsIn)
Lua: boolean retval, number v = reaper.ImGui_DragInt(ImGui_Context ctx, string label, number v, optional number v_speedIn, optional number v_minIn, optional number v_maxIn, optional string formatIn, optional number flagsIn)
Python: bool ImGui_DragInt(ImGui_Context* ctx, const char* label, int* vInOut, double* v_speedInOptional, int* v_minInOptional, int* v_maxInOptional, const char* formatInOptional, int* flagsInOptional)
Description:Default values: v_speed = 1.0, v_min = 0, v_max = 0, format = '%d', flags = ImGui_SliderFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number v | - | |
| optional number v_speedIn | - | |
| optional number v_minIn | - | |
| optional number v_maxIn | - | |
| optional string formatIn | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number v | - | - |
^
ImGui_DragInt2Functioncall:
C: bool ImGui_DragInt2(ImGui_Context* ctx, const char* label, int* v1InOut, int* v2InOut, double* v_speedInOptional, int* v_minInOptional, int* v_maxInOptional, const char* formatInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_DragInt2", ImGui_Context ctx, "label", int &v1, int &v2, optional v_speedIn, optional int v_minIn, optional int v_maxIn, optional "formatIn", optional int flagsIn)
Lua: boolean retval, number v1, number v2 = reaper.ImGui_DragInt2(ImGui_Context ctx, string label, number v1, number v2, optional number v_speedIn, optional number v_minIn, optional number v_maxIn, optional string formatIn, optional number flagsIn)
Python: bool ImGui_DragInt2(ImGui_Context* ctx, const char* label, int* v1InOut, int* v2InOut, double* v_speedInOptional, int* v_minInOptional, int* v_maxInOptional, const char* formatInOptional, int* flagsInOptional)
Description:Default values: v_speed = 1.0, v_min = 0, v_max = 0, format = '%d', flags = ImGui_SliderFlags_None)
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number v1 | - | |
| number v2 | - | |
| optional number v_speedIn | - | |
| optional number v_minIn | - | |
| optional number v_maxIn | - | |
| optional string formatIn | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number v1 | - | |
| number v2 | - | - |
^
ImGui_DragInt3Functioncall:
C: bool ImGui_DragInt3(ImGui_Context* ctx, const char* label, int* v1InOut, int* v2InOut, int* v3InOut, double* v_speedInOptional, int* v_minInOptional, int* v_maxInOptional, const char* formatInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_DragInt3", ImGui_Context ctx, "label", int &v1, int &v2, int &v3, optional v_speedIn, optional int v_minIn, optional int v_maxIn, optional "formatIn", optional int flagsIn)
Lua: boolean retval, number v1, number v2, number v3 = reaper.ImGui_DragInt3(ImGui_Context ctx, string label, number v1, number v2, number v3, optional number v_speedIn, optional number v_minIn, optional number v_maxIn, optional string formatIn, optional number flagsIn)
Python: bool ImGui_DragInt3(ImGui_Context* ctx, const char* label, int* v1InOut, int* v2InOut, int* v3InOut, double* v_speedInOptional, int* v_minInOptional, int* v_maxInOptional, const char* formatInOptional, int* flagsInOptional)
Description:Default values: v_speed = 1.0, v_min = 0, v_max = 0, format = '%d', flags = ImGui_SliderFlags_None)
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number v1 | - | |
| number v2 | - | |
| number v3 | - | |
| optional number v_speedIn | - | |
| optional number v_minIn | - | |
| optional number v_maxIn | - | |
| optional string formatIn | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number v1 | - | |
| number v2 | - | |
| number v3 | - | - |
^
ImGui_DragInt4Functioncall:
C: bool ImGui_DragInt4(ImGui_Context* ctx, const char* label, int* v1InOut, int* v2InOut, int* v3InOut, int* v4InOut, double* v_speedInOptional, int* v_minInOptional, int* v_maxInOptional, const char* formatInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_DragInt4", ImGui_Context ctx, "label", int &v1, int &v2, int &v3, int &v4, optional v_speedIn, optional int v_minIn, optional int v_maxIn, optional "formatIn", optional int flagsIn)
Lua: boolean retval, number v1, number v2, number v3, number v4 = reaper.ImGui_DragInt4(ImGui_Context ctx, string label, number v1, number v2, number v3, number v4, optional number v_speedIn, optional number v_minIn, optional number v_maxIn, optional string formatIn, optional number flagsIn)
Python: bool ImGui_DragInt4(ImGui_Context* ctx, const char* label, int* v1InOut, int* v2InOut, int* v3InOut, int* v4InOut, double* v_speedInOptional, int* v_minInOptional, int* v_maxInOptional, const char* formatInOptional, int* flagsInOptional)
Description:Default values: v_speed = 1.0, v_min = 0, v_max = 0, format = '%d', flags = ImGui_SliderFlags_None)
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number v1 | - | |
| number v2 | - | |
| number v3 | - | |
| number v4 | - | |
| optional number v_speedIn | - | |
| optional number v_minIn | - | |
| optional number v_maxIn | - | |
| optional string formatIn | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number v1 | - | |
| number v2 | - | |
| number v3 | - | |
| number v4 | - | - |
^
ImGui_DragIntRange2Functioncall:
C: bool ImGui_DragIntRange2(ImGui_Context* ctx, const char* label, int* v_current_minInOut, int* v_current_maxInOut, double* v_speedInOptional, int* v_minInOptional, int* v_maxInOptional, const char* formatInOptional, const char* format_maxInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_DragIntRange2", ImGui_Context ctx, "label", int &v_current_min, int &v_current_max, optional v_speedIn, optional int v_minIn, optional int v_maxIn, optional "formatIn", optional "format_maxIn", optional int flagsIn)
Lua: boolean retval, number v_current_min, number v_current_max = reaper.ImGui_DragIntRange2(ImGui_Context ctx, string label, number v_current_min, number v_current_max, optional number v_speedIn, optional number v_minIn, optional number v_maxIn, optional string formatIn, optional string format_maxIn, optional number flagsIn)
Python: bool ImGui_DragIntRange2(ImGui_Context* ctx, const char* label, int* v_current_minInOut, int* v_current_maxInOut, double* v_speedInOptional, int* v_minInOptional, int* v_maxInOptional, const char* formatInOptional, const char* format_maxInOptional, int* flagsInOptional)
Description:Default values: v_speed = 1.0, v_min = 0, v_max = 0, format = '%d', format_max = nil, flags = ImGui_SliderFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number v_current_min | - | |
| number v_current_max | - | |
| optional number v_speedIn | - | |
| optional number v_minIn | - | |
| optional number v_maxIn | - | |
| optional string formatIn | - | |
| optional string format_maxIn | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number v_current_min | - | |
| number v_current_max | - | - |
^
ImGui_DrawFlags_ClosedFunctioncall:
C: int ImGui_DrawFlags_Closed()
EEL2: int extension_api("ImGui_DrawFlags_Closed")
Lua: integer reaper.ImGui_DrawFlags_Closed()
Python: int ImGui_DrawFlags_Closed()
Description:PathStroke(), AddPolyline(): specify that shape should be closed (Important: this is always == 1 for legacy reason)
^
ImGui_DrawFlags_NoneFunctioncall:
C: int ImGui_DrawFlags_None()
EEL2: int extension_api("ImGui_DrawFlags_None")
Lua: integer reaper.ImGui_DrawFlags_None()
Python: int ImGui_DrawFlags_None()
Description:Python: Int ImGui_DrawFlags_None()
^
ImGui_DrawFlags_RoundCornersAllFunctioncall:
C: int ImGui_DrawFlags_RoundCornersAll()
EEL2: int extension_api("ImGui_DrawFlags_RoundCornersAll")
Lua: integer reaper.ImGui_DrawFlags_RoundCornersAll()
Python: int ImGui_DrawFlags_RoundCornersAll()
Description:Python: Int ImGui_DrawFlags_RoundCornersAll()
^
ImGui_DrawFlags_RoundCornersBottomFunctioncall:
C: int ImGui_DrawFlags_RoundCornersBottom()
EEL2: int extension_api("ImGui_DrawFlags_RoundCornersBottom")
Lua: integer reaper.ImGui_DrawFlags_RoundCornersBottom()
Python: int ImGui_DrawFlags_RoundCornersBottom()
Description:Python: Int ImGui_DrawFlags_RoundCornersBottom()
^
ImGui_DrawFlags_RoundCornersBottomLeftFunctioncall:
C: int ImGui_DrawFlags_RoundCornersBottomLeft()
EEL2: int extension_api("ImGui_DrawFlags_RoundCornersBottomLeft")
Lua: integer reaper.ImGui_DrawFlags_RoundCornersBottomLeft()
Python: int ImGui_DrawFlags_RoundCornersBottomLeft()
Description:AddRect(), AddRectFilled(), PathRect(): enable rounding bottom-left corner only (when rounding > 0.0f, we default to all corners).
^
ImGui_DrawFlags_RoundCornersBottomRightFunctioncall:
C: int ImGui_DrawFlags_RoundCornersBottomRight()
EEL2: int extension_api("ImGui_DrawFlags_RoundCornersBottomRight")
Lua: integer reaper.ImGui_DrawFlags_RoundCornersBottomRight()
Python: int ImGui_DrawFlags_RoundCornersBottomRight()
Description:AddRect(), AddRectFilled(), PathRect(): enable rounding bottom-right corner only (when rounding > 0.0f, we default to all corners).
^
ImGui_DrawFlags_RoundCornersLeftFunctioncall:
C: int ImGui_DrawFlags_RoundCornersLeft()
EEL2: int extension_api("ImGui_DrawFlags_RoundCornersLeft")
Lua: integer reaper.ImGui_DrawFlags_RoundCornersLeft()
Python: int ImGui_DrawFlags_RoundCornersLeft()
Description:Python: Int ImGui_DrawFlags_RoundCornersLeft()
^
ImGui_DrawFlags_RoundCornersNoneFunctioncall:
C: int ImGui_DrawFlags_RoundCornersNone()
EEL2: int extension_api("ImGui_DrawFlags_RoundCornersNone")
Lua: integer reaper.ImGui_DrawFlags_RoundCornersNone()
Python: int ImGui_DrawFlags_RoundCornersNone()
Description:AddRect(), AddRectFilled(), PathRect(): disable rounding on all corners (when rounding > 0.0f). This is NOT zero, NOT an implicit flag!
^
ImGui_DrawFlags_RoundCornersRightFunctioncall:
C: int ImGui_DrawFlags_RoundCornersRight()
EEL2: int extension_api("ImGui_DrawFlags_RoundCornersRight")
Lua: integer reaper.ImGui_DrawFlags_RoundCornersRight()
Python: int ImGui_DrawFlags_RoundCornersRight()
Description:Python: Int ImGui_DrawFlags_RoundCornersRight()
^
ImGui_DrawFlags_RoundCornersTopFunctioncall:
C: int ImGui_DrawFlags_RoundCornersTop()
EEL2: int extension_api("ImGui_DrawFlags_RoundCornersTop")
Lua: integer reaper.ImGui_DrawFlags_RoundCornersTop()
Python: int ImGui_DrawFlags_RoundCornersTop()
Description:Python: Int ImGui_DrawFlags_RoundCornersTop()
^
ImGui_DrawFlags_RoundCornersTopLeftFunctioncall:
C: int ImGui_DrawFlags_RoundCornersTopLeft()
EEL2: int extension_api("ImGui_DrawFlags_RoundCornersTopLeft")
Lua: integer reaper.ImGui_DrawFlags_RoundCornersTopLeft()
Python: int ImGui_DrawFlags_RoundCornersTopLeft()
Description:AddRect(), AddRectFilled(), PathRect(): enable rounding top-left corner only (when rounding > 0.0f, we default to all corners).
^
ImGui_DrawFlags_RoundCornersTopRightFunctioncall:
C: int ImGui_DrawFlags_RoundCornersTopRight()
EEL2: int extension_api("ImGui_DrawFlags_RoundCornersTopRight")
Lua: integer reaper.ImGui_DrawFlags_RoundCornersTopRight()
Python: int ImGui_DrawFlags_RoundCornersTopRight()
Description:AddRect(), AddRectFilled(), PathRect(): enable rounding top-right corner only (when rounding > 0.0f, we default to all corners).
^
ImGui_DrawList_AddBezierCubicFunctioncall:
C: void ImGui_DrawList_AddBezierCubic(ImGui_DrawList* draw_list, double p1_x, double p1_y, double p2_x, double p2_y, double p3_x, double p3_y, double p4_x, double p4_y, int col_rgba, double thickness, int* num_segmentsInOptional)
EEL2: extension_api("ImGui_DrawList_AddBezierCubic", ImGui_DrawList draw_list, p1_x, p1_y, p2_x, p2_y, p3_x, p3_y, p4_x, p4_y, int col_rgba, thickness, optional int num_segmentsIn)
Lua: reaper.ImGui_DrawList_AddBezierCubic(ImGui_DrawList draw_list, number p1_x, number p1_y, number p2_x, number p2_y, number p3_x, number p3_y, number p4_x, number p4_y, integer col_rgba, number thickness, optional number num_segmentsIn)
Python: void ImGui_DrawList_AddBezierCubic(ImGui_DrawList* draw_list, double p1_x, double p1_y, double p2_x, double p2_y, double p3_x, double p3_y, double p4_x, double p4_y, int col_rgba, double thickness, int* num_segmentsInOptional)
Description:Default values: num_segments = 0
| Parameters: |
| ImGui_DrawList draw_list | - | |
| number p1_x | - | |
| number p1_y | - | |
| number p2_x | - | |
| number p2_y | - | |
| number p3_x | - | |
| number p3_y | - | |
| number p4_x | - | |
| number p4_y | - | |
| integer col_rgba | - | |
| number thickness | - | |
| optional number num_segmentsIn | - | |
^
ImGui_DrawList_AddBezierQuadraticFunctioncall:
C: void ImGui_DrawList_AddBezierQuadratic(ImGui_DrawList* draw_list, double p1_x, double p1_y, double p2_x, double p2_y, double p3_x, double p3_y, int col_rgba, double thickness, int* num_segmentsInOptional)
EEL2: extension_api("ImGui_DrawList_AddBezierQuadratic", ImGui_DrawList draw_list, p1_x, p1_y, p2_x, p2_y, p3_x, p3_y, int col_rgba, thickness, optional int num_segmentsIn)
Lua: reaper.ImGui_DrawList_AddBezierQuadratic(ImGui_DrawList draw_list, number p1_x, number p1_y, number p2_x, number p2_y, number p3_x, number p3_y, integer col_rgba, number thickness, optional number num_segmentsIn)
Python: void ImGui_DrawList_AddBezierQuadratic(ImGui_DrawList* draw_list, double p1_x, double p1_y, double p2_x, double p2_y, double p3_x, double p3_y, int col_rgba, double thickness, int* num_segmentsInOptional)
Description:Default values: num_segments = 0
| Parameters: |
| ImGui_DrawList draw_list | - | |
| number p1_x | - | |
| number p1_y | - | |
| number p2_x | - | |
| number p2_y | - | |
| number p3_x | - | |
| number p3_y | - | |
| integer col_rgba | - | |
| number thickness | - | |
| optional number num_segmentsIn | - | |
^
ImGui_DrawList_AddCircleFunctioncall:
C: void ImGui_DrawList_AddCircle(ImGui_DrawList* draw_list, double center_x, double center_y, double radius, int col_rgba, int* num_segmentsInOptional, double* thicknessInOptional)
EEL2: extension_api("ImGui_DrawList_AddCircle", ImGui_DrawList draw_list, center_x, center_y, radius, int col_rgba, optional int num_segmentsIn, optional thicknessIn)
Lua: reaper.ImGui_DrawList_AddCircle(ImGui_DrawList draw_list, number center_x, number center_y, number radius, integer col_rgba, optional number num_segmentsIn, optional number thicknessIn)
Python: void ImGui_DrawList_AddCircle(ImGui_DrawList* draw_list, double center_x, double center_y, double radius, int col_rgba, int* num_segmentsInOptional, double* thicknessInOptional)
Description:Default values: num_segments = 0, thickness = 1.0
| Parameters: |
| ImGui_DrawList draw_list | - | |
| number center_x | - | |
| number center_y | - | |
| number radius | - | |
| integer col_rgba | - | |
| optional number num_segmentsIn | - | |
| optional number thicknessIn | - | |
^
ImGui_DrawList_AddCircleFilledFunctioncall:
C: void ImGui_DrawList_AddCircleFilled(ImGui_DrawList* draw_list, double center_x, double center_y, double radius, int col_rgba, int* num_segmentsInOptional)
EEL2: extension_api("ImGui_DrawList_AddCircleFilled", ImGui_DrawList draw_list, center_x, center_y, radius, int col_rgba, optional int num_segmentsIn)
Lua: reaper.ImGui_DrawList_AddCircleFilled(ImGui_DrawList draw_list, number center_x, number center_y, number radius, integer col_rgba, optional number num_segmentsIn)
Python: void ImGui_DrawList_AddCircleFilled(ImGui_DrawList* draw_list, double center_x, double center_y, double radius, int col_rgba, int* num_segmentsInOptional)
Description:Default values: num_segments = 0
| Parameters: |
| ImGui_DrawList draw_list | - | |
| number center_x | - | |
| number center_y | - | |
| number radius | - | |
| integer col_rgba | - | |
| optional number num_segmentsIn | - | |
^
ImGui_DrawList_AddConvexPolyFilledFunctioncall:
C: void ImGui_DrawList_AddConvexPolyFilled(ImGui_DrawList* draw_list, reaper_array* points, int num_points, int col_rgba)
EEL2: extension_api("ImGui_DrawList_AddConvexPolyFilled", ImGui_DrawList draw_list, reaper_array points, int num_points, int col_rgba)
Lua: reaper.ImGui_DrawList_AddConvexPolyFilled(ImGui_DrawList draw_listreaper_array points, integer num_points, integer col_rgba)
Python: void ImGui_DrawList_AddConvexPolyFilled(ImGui_DrawList* draw_list, reaper_array* points, int num_points, int col_rgba)
Description:Note: Anti-aliased filling requires points to be in clockwise order.
| Parameters: |
| ImGui_DrawList draw_listreaper_array points | - | |
| integer num_points | - | |
| integer col_rgba | - | |
^
ImGui_DrawList_AddLineFunctioncall:
C: void ImGui_DrawList_AddLine(ImGui_DrawList* draw_list, double p1_x, double p1_y, double p2_x, double p2_y, int col_rgba, double* thicknessInOptional)
EEL2: extension_api("ImGui_DrawList_AddLine", ImGui_DrawList draw_list, p1_x, p1_y, p2_x, p2_y, int col_rgba, optional thicknessIn)
Lua: reaper.ImGui_DrawList_AddLine(ImGui_DrawList draw_list, number p1_x, number p1_y, number p2_x, number p2_y, integer col_rgba, optional number thicknessIn)
Python: void ImGui_DrawList_AddLine(ImGui_DrawList* draw_list, double p1_x, double p1_y, double p2_x, double p2_y, int col_rgba, double* thicknessInOptional)
Description:Default values: thickness = 1.0
| Parameters: |
| ImGui_DrawList draw_list | - | |
| number p1_x | - | |
| number p1_y | - | |
| number p2_x | - | |
| number p2_y | - | |
| integer col_rgba | - | |
| optional number thicknessIn | - | |
^
ImGui_DrawList_AddNgonFunctioncall:
C: void ImGui_DrawList_AddNgon(ImGui_DrawList* draw_list, double center_x, double center_y, double radius, int col_rgba, int num_segments, double* thicknessInOptional)
EEL2: extension_api("ImGui_DrawList_AddNgon", ImGui_DrawList draw_list, center_x, center_y, radius, int col_rgba, int num_segments, optional thicknessIn)
Lua: reaper.ImGui_DrawList_AddNgon(ImGui_DrawList draw_list, number center_x, number center_y, number radius, integer col_rgba, integer num_segments, optional number thicknessIn)
Python: void ImGui_DrawList_AddNgon(ImGui_DrawList* draw_list, double center_x, double center_y, double radius, int col_rgba, int num_segments, double* thicknessInOptional)
Description:Default values: thickness = 1.0
| Parameters: |
| ImGui_DrawList draw_list | - | |
| number center_x | - | |
| number center_y | - | |
| number radius | - | |
| integer col_rgba | - | |
| integer num_segments | - | |
| optional number thicknessIn | - | |
^
ImGui_DrawList_AddNgonFilledFunctioncall:
C: void ImGui_DrawList_AddNgonFilled(ImGui_DrawList* draw_list, double center_x, double center_y, double radius, int col_rgba, int num_segments)
EEL2: extension_api("ImGui_DrawList_AddNgonFilled", ImGui_DrawList draw_list, center_x, center_y, radius, int col_rgba, int num_segments)
Lua: reaper.ImGui_DrawList_AddNgonFilled(ImGui_DrawList draw_list, number center_x, number center_y, number radius, integer col_rgba, integer num_segments)
Python: void ImGui_DrawList_AddNgonFilled(ImGui_DrawList* draw_list, double center_x, double center_y, double radius, int col_rgba, int num_segments)
Description:Python: ImGui_DrawList_AddNgonFilled(ImGui_DrawList draw_list, Float center_x, Float center_y, Float radius, Int col_rgba, Int num_segments)
| Parameters: |
| ImGui_DrawList draw_list | - | |
| number center_x | - | |
| number center_y | - | |
| number radius | - | |
| integer col_rgba | - | |
| integer num_segments | - | |
^
ImGui_DrawList_AddPolylineFunctioncall:
C: void ImGui_DrawList_AddPolyline(ImGui_DrawList* draw_list, reaper_array* points, int col_rgba, int flags, double thickness)
EEL2: extension_api("ImGui_DrawList_AddPolyline", ImGui_DrawList draw_list, reaper_array points, int col_rgba, int flags, thickness)
Lua: reaper.ImGui_DrawList_AddPolyline(ImGui_DrawList draw_listreaper_array points, integer col_rgba, integer flags, number thickness)
Python: void ImGui_DrawList_AddPolyline(ImGui_DrawList* draw_list, reaper_array* points, int col_rgba, int flags, double thickness)
Description:Points is a list of x,y coordinates.
| Parameters: |
| ImGui_DrawList draw_listreaper_array points | - | |
| integer col_rgba | - | |
| integer flags | - | |
| number thickness | - | |
^
ImGui_DrawList_AddQuadFunctioncall:
C: void ImGui_DrawList_AddQuad(ImGui_DrawList* draw_list, double p1_x, double p1_y, double p2_x, double p2_y, double p3_x, double p3_y, double p4_x, double p4_y, int col_rgba, double* thicknessInOptional)
EEL2: extension_api("ImGui_DrawList_AddQuad", ImGui_DrawList draw_list, p1_x, p1_y, p2_x, p2_y, p3_x, p3_y, p4_x, p4_y, int col_rgba, optional thicknessIn)
Lua: reaper.ImGui_DrawList_AddQuad(ImGui_DrawList draw_list, number p1_x, number p1_y, number p2_x, number p2_y, number p3_x, number p3_y, number p4_x, number p4_y, integer col_rgba, optional number thicknessIn)
Python: void ImGui_DrawList_AddQuad(ImGui_DrawList* draw_list, double p1_x, double p1_y, double p2_x, double p2_y, double p3_x, double p3_y, double p4_x, double p4_y, int col_rgba, double* thicknessInOptional)
Description:Default values: thickness = 1.0
| Parameters: |
| ImGui_DrawList draw_list | - | |
| number p1_x | - | |
| number p1_y | - | |
| number p2_x | - | |
| number p2_y | - | |
| number p3_x | - | |
| number p3_y | - | |
| number p4_x | - | |
| number p4_y | - | |
| integer col_rgba | - | |
| optional number thicknessIn | - | |
^
ImGui_DrawList_AddQuadFilledFunctioncall:
C: void ImGui_DrawList_AddQuadFilled(ImGui_DrawList* draw_list, double p1_x, double p1_y, double p2_x, double p2_y, double p3_x, double p3_y, double p4_x, double p4_y, int col_rgba)
EEL2: extension_api("ImGui_DrawList_AddQuadFilled", ImGui_DrawList draw_list, p1_x, p1_y, p2_x, p2_y, p3_x, p3_y, p4_x, p4_y, int col_rgba)
Lua: reaper.ImGui_DrawList_AddQuadFilled(ImGui_DrawList draw_list, number p1_x, number p1_y, number p2_x, number p2_y, number p3_x, number p3_y, number p4_x, number p4_y, integer col_rgba)
Python: void ImGui_DrawList_AddQuadFilled(ImGui_DrawList* draw_list, double p1_x, double p1_y, double p2_x, double p2_y, double p3_x, double p3_y, double p4_x, double p4_y, int col_rgba)
Description:Python: ImGui_DrawList_AddQuadFilled(ImGui_DrawList draw_list, Float p1_x, Float p1_y, Float p2_x, Float p2_y, Float p3_x, Float p3_y, Float p4_x, Float p4_y, Int col_rgba)
| Parameters: |
| ImGui_DrawList draw_list | - | |
| number p1_x | - | |
| number p1_y | - | |
| number p2_x | - | |
| number p2_y | - | |
| number p3_x | - | |
| number p3_y | - | |
| number p4_x | - | |
| number p4_y | - | |
| integer col_rgba | - | |
^
ImGui_DrawList_AddRectFunctioncall:
C: void ImGui_DrawList_AddRect(ImGui_DrawList* draw_list, double p_min_x, double p_min_y, double p_max_x, double p_max_y, int col_rgba, double* roundingInOptional, int* flagsInOptional, double* thicknessInOptional)
EEL2: extension_api("ImGui_DrawList_AddRect", ImGui_DrawList draw_list, p_min_x, p_min_y, p_max_x, p_max_y, int col_rgba, optional roundingIn, optional int flagsIn, optional thicknessIn)
Lua: reaper.ImGui_DrawList_AddRect(ImGui_DrawList draw_list, number p_min_x, number p_min_y, number p_max_x, number p_max_y, integer col_rgba, optional number roundingIn, optional number flagsIn, optional number thicknessIn)
Python: void ImGui_DrawList_AddRect(ImGui_DrawList* draw_list, double p_min_x, double p_min_y, double p_max_x, double p_max_y, int col_rgba, double* roundingInOptional, int* flagsInOptional, double* thicknessInOptional)
Description:Default values: rounding = 0.0, flags = ImGui_DrawFlags_None, thickness = 1.0
| Parameters: |
| ImGui_DrawList draw_list | - | |
| number p_min_x | - | |
| number p_min_y | - | |
| number p_max_x | - | |
| number p_max_y | - | |
| integer col_rgba | - | |
| optional number roundingIn | - | |
| optional number flagsIn | - | |
| optional number thicknessIn | - | |
^
ImGui_DrawList_AddRectFilledFunctioncall:
C: void ImGui_DrawList_AddRectFilled(ImGui_DrawList* draw_list, double p_min_x, double p_min_y, double p_max_x, double p_max_y, int col_rgba, double* roundingInOptional, int* flagsInOptional)
EEL2: extension_api("ImGui_DrawList_AddRectFilled", ImGui_DrawList draw_list, p_min_x, p_min_y, p_max_x, p_max_y, int col_rgba, optional roundingIn, optional int flagsIn)
Lua: reaper.ImGui_DrawList_AddRectFilled(ImGui_DrawList draw_list, number p_min_x, number p_min_y, number p_max_x, number p_max_y, integer col_rgba, optional number roundingIn, optional number flagsIn)
Python: void ImGui_DrawList_AddRectFilled(ImGui_DrawList* draw_list, double p_min_x, double p_min_y, double p_max_x, double p_max_y, int col_rgba, double* roundingInOptional, int* flagsInOptional)
Description:Default values: rounding = 0.0, flags = ImGui_DrawFlags_None
| Parameters: |
| ImGui_DrawList draw_list | - | |
| number p_min_x | - | |
| number p_min_y | - | |
| number p_max_x | - | |
| number p_max_y | - | |
| integer col_rgba | - | |
| optional number roundingIn | - | |
| optional number flagsIn | - | |
^
ImGui_DrawList_AddRectFilledMultiColorFunctioncall:
C: void ImGui_DrawList_AddRectFilledMultiColor(ImGui_DrawList* draw_list, double p_min_x, double p_min_y, double p_max_x, double p_max_y, int col_upr_left, int col_upr_right, int col_bot_right, int col_bot_left)
EEL2: extension_api("ImGui_DrawList_AddRectFilledMultiColor", ImGui_DrawList draw_list, p_min_x, p_min_y, p_max_x, p_max_y, int col_upr_left, int col_upr_right, int col_bot_right, int col_bot_left)
Lua: reaper.ImGui_DrawList_AddRectFilledMultiColor(ImGui_DrawList draw_list, number p_min_x, number p_min_y, number p_max_x, number p_max_y, integer col_upr_left, integer col_upr_right, integer col_bot_right, integer col_bot_left)
Python: void ImGui_DrawList_AddRectFilledMultiColor(ImGui_DrawList* draw_list, double p_min_x, double p_min_y, double p_max_x, double p_max_y, int col_upr_left, int col_upr_right, int col_bot_right, int col_bot_left)
Description:Python: ImGui_DrawList_AddRectFilledMultiColor(ImGui_DrawList draw_list, Float p_min_x, Float p_min_y, Float p_max_x, Float p_max_y, Int col_upr_left, Int col_upr_right, Int col_bot_right, Int col_bot_left)
| Parameters: |
| ImGui_DrawList draw_list | - | |
| number p_min_x | - | |
| number p_min_y | - | |
| number p_max_x | - | |
| number p_max_y | - | |
| integer col_upr_left | - | |
| integer col_upr_right | - | |
| integer col_bot_right | - | |
| integer col_bot_left | - | |
^
ImGui_DrawList_AddTextFunctioncall:
C: void ImGui_DrawList_AddText(ImGui_DrawList* draw_list, double x, double y, int col_rgba, const char* text)
EEL2: extension_api("ImGui_DrawList_AddText", ImGui_DrawList draw_list, x, y, int col_rgba, "text")
Lua: reaper.ImGui_DrawList_AddText(ImGui_DrawList draw_list, number x, number y, integer col_rgba, string text)
Python: void ImGui_DrawList_AddText(ImGui_DrawList* draw_list, double x, double y, int col_rgba, const char* text)
Description:Python: ImGui_DrawList_AddText(ImGui_DrawList draw_list, Float x, Float y, Int col_rgba, String text)
| Parameters: |
| ImGui_DrawList draw_list | - | |
| number x | - | |
| number y | - | |
| integer col_rgba | - | |
| string text | - | |
^
ImGui_DrawList_AddTextExFunctioncall:
C: void ImGui_DrawList_AddTextEx(ImGui_DrawList* draw_list, ImGui_Font* font, double font_size, double pos_x, double pos_y, int col_rgba, const char* text, double* wrap_widthInOptional, double* cpu_fine_clip_rect_xInOptional, double* cpu_fine_clip_rect_yInOptional, double* cpu_fine_clip_rect_wInOptional, double* cpu_fine_clip_rect_hInOptional)
EEL2: extension_api("ImGui_DrawList_AddTextEx", ImGui_DrawList draw_list, ImGui_Font font, font_size, pos_x, pos_y, int col_rgba, "text", optional wrap_widthIn, optional cpu_fine_clip_rect_xIn, optional cpu_fine_clip_rect_yIn, optional cpu_fine_clip_rect_wIn, optional cpu_fine_clip_rect_hIn)
Lua: reaper.ImGui_DrawList_AddTextEx(ImGui_DrawList draw_listImGui_Font font, number font_size, number pos_x, number pos_y, integer col_rgba, string text, optional number wrap_widthIn, optional number cpu_fine_clip_rect_xIn, optional number cpu_fine_clip_rect_yIn, optional number cpu_fine_clip_rect_wIn, optional number cpu_fine_clip_rect_hIn)
Python: void ImGui_DrawList_AddTextEx(ImGui_DrawList* draw_list, ImGui_Font* font, double font_size, double pos_x, double pos_y, int col_rgba, const char* text, double* wrap_widthInOptional, double* cpu_fine_clip_rect_xInOptional, double* cpu_fine_clip_rect_yInOptional, double* cpu_fine_clip_rect_wInOptional, double* cpu_fine_clip_rect_hInOptional)
Description:Default values: wrap_width = 0.0, cpu_fine_clip_rect_x = nil, cpu_fine_clip_rect_y = nil, cpu_fine_clip_rect_w = nil, cpu_fine_clip_rect_h = nil
| Parameters: |
| ImGui_DrawList draw_listImGui_Font font | - | |
| number font_size | - | |
| number pos_x | - | |
| number pos_y | - | |
| integer col_rgba | - | |
| string text | - | |
| optional number wrap_widthIn | - | |
| optional number cpu_fine_clip_rect_xIn | - | |
| optional number cpu_fine_clip_rect_yIn | - | |
| optional number cpu_fine_clip_rect_wIn | - | |
| optional number cpu_fine_clip_rect_hIn | - | |
^
ImGui_DrawList_AddTriangleFunctioncall:
C: void ImGui_DrawList_AddTriangle(ImGui_DrawList* draw_list, double p1_x, double p1_y, double p2_x, double p2_y, double p3_x, double p3_y, int col_rgba, double* thicknessInOptional)
EEL2: extension_api("ImGui_DrawList_AddTriangle", ImGui_DrawList draw_list, p1_x, p1_y, p2_x, p2_y, p3_x, p3_y, int col_rgba, optional thicknessIn)
Lua: reaper.ImGui_DrawList_AddTriangle(ImGui_DrawList draw_list, number p1_x, number p1_y, number p2_x, number p2_y, number p3_x, number p3_y, integer col_rgba, optional number thicknessIn)
Python: void ImGui_DrawList_AddTriangle(ImGui_DrawList* draw_list, double p1_x, double p1_y, double p2_x, double p2_y, double p3_x, double p3_y, int col_rgba, double* thicknessInOptional)
Description:Default values: thickness = 1.0
| Parameters: |
| ImGui_DrawList draw_list | - | |
| number p1_x | - | |
| number p1_y | - | |
| number p2_x | - | |
| number p2_y | - | |
| number p3_x | - | |
| number p3_y | - | |
| integer col_rgba | - | |
| optional number thicknessIn | - | |
^
ImGui_DrawList_AddTriangleFilledFunctioncall:
C: void ImGui_DrawList_AddTriangleFilled(ImGui_DrawList* draw_list, double p1_x, double p1_y, double p2_x, double p2_y, double p3_x, double p3_y, int col_rgba)
EEL2: extension_api("ImGui_DrawList_AddTriangleFilled", ImGui_DrawList draw_list, p1_x, p1_y, p2_x, p2_y, p3_x, p3_y, int col_rgba)
Lua: reaper.ImGui_DrawList_AddTriangleFilled(ImGui_DrawList draw_list, number p1_x, number p1_y, number p2_x, number p2_y, number p3_x, number p3_y, integer col_rgba)
Python: void ImGui_DrawList_AddTriangleFilled(ImGui_DrawList* draw_list, double p1_x, double p1_y, double p2_x, double p2_y, double p3_x, double p3_y, int col_rgba)
Description:Python: ImGui_DrawList_AddTriangleFilled(ImGui_DrawList draw_list, Float p1_x, Float p1_y, Float p2_x, Float p2_y, Float p3_x, Float p3_y, Int col_rgba)
| Parameters: |
| ImGui_DrawList draw_list | - | |
| number p1_x | - | |
| number p1_y | - | |
| number p2_x | - | |
| number p2_y | - | |
| number p3_x | - | |
| number p3_y | - | |
| integer col_rgba | - | |
^
ImGui_DrawList_PathArcToFunctioncall:
C: void ImGui_DrawList_PathArcTo(ImGui_DrawList* draw_list, double center_x, double center_y, double radius, double a_min, double a_max, int* num_segmentsInOptional)
EEL2: extension_api("ImGui_DrawList_PathArcTo", ImGui_DrawList draw_list, center_x, center_y, radius, a_min, a_max, optional int num_segmentsIn)
Lua: reaper.ImGui_DrawList_PathArcTo(ImGui_DrawList draw_list, number center_x, number center_y, number radius, number a_min, number a_max, optional number num_segmentsIn)
Python: void ImGui_DrawList_PathArcTo(ImGui_DrawList* draw_list, double center_x, double center_y, double radius, double a_min, double a_max, int* num_segmentsInOptional)
Description:Default values: num_segments = 0
| Parameters: |
| ImGui_DrawList draw_list | - | |
| number center_x | - | |
| number center_y | - | |
| number radius | - | |
| number a_min | - | |
| number a_max | - | |
| optional number num_segmentsIn | - | |
^
ImGui_DrawList_PathArcToFastFunctioncall:
C: void ImGui_DrawList_PathArcToFast(ImGui_DrawList* draw_list, double center_x, double center_y, double radius, int a_min_of_12, int a_max_of_12)
EEL2: extension_api("ImGui_DrawList_PathArcToFast", ImGui_DrawList draw_list, center_x, center_y, radius, int a_min_of_12, int a_max_of_12)
Lua: reaper.ImGui_DrawList_PathArcToFast(ImGui_DrawList draw_list, number center_x, number center_y, number radius, integer a_min_of_12, integer a_max_of_12)
Python: void ImGui_DrawList_PathArcToFast(ImGui_DrawList* draw_list, double center_x, double center_y, double radius, int a_min_of_12, int a_max_of_12)
Description:Use precomputed angles for a 12 steps circle.
| Parameters: |
| ImGui_DrawList draw_list | - | |
| number center_x | - | |
| number center_y | - | |
| number radius | - | |
| integer a_min_of_12 | - | |
| integer a_max_of_12 | - | |
^
ImGui_DrawList_PathBezierCubicCurveToFunctioncall:
C: void ImGui_DrawList_PathBezierCubicCurveTo(ImGui_DrawList* draw_list, double p2_x, double p2_y, double p3_x, double p3_y, double p4_x, double p4_y, int* num_segmentsInOptional)
EEL2: extension_api("ImGui_DrawList_PathBezierCubicCurveTo", ImGui_DrawList draw_list, p2_x, p2_y, p3_x, p3_y, p4_x, p4_y, optional int num_segmentsIn)
Lua: reaper.ImGui_DrawList_PathBezierCubicCurveTo(ImGui_DrawList draw_list, number p2_x, number p2_y, number p3_x, number p3_y, number p4_x, number p4_y, optional number num_segmentsIn)
Python: void ImGui_DrawList_PathBezierCubicCurveTo(ImGui_DrawList* draw_list, double p2_x, double p2_y, double p3_x, double p3_y, double p4_x, double p4_y, int* num_segmentsInOptional)
Description:Default values: num_segments = 0
| Parameters: |
| ImGui_DrawList draw_list | - | |
| number p2_x | - | |
| number p2_y | - | |
| number p3_x | - | |
| number p3_y | - | |
| number p4_x | - | |
| number p4_y | - | |
| optional number num_segmentsIn | - | |
^
ImGui_DrawList_PathBezierQuadraticCurveToFunctioncall:
C: void ImGui_DrawList_PathBezierQuadraticCurveTo(ImGui_DrawList* draw_list, double p2_x, double p2_y, double p3_x, double p3_y, int* num_segmentsInOptional)
EEL2: extension_api("ImGui_DrawList_PathBezierQuadraticCurveTo", ImGui_DrawList draw_list, p2_x, p2_y, p3_x, p3_y, optional int num_segmentsIn)
Lua: reaper.ImGui_DrawList_PathBezierQuadraticCurveTo(ImGui_DrawList draw_list, number p2_x, number p2_y, number p3_x, number p3_y, optional number num_segmentsIn)
Python: void ImGui_DrawList_PathBezierQuadraticCurveTo(ImGui_DrawList* draw_list, double p2_x, double p2_y, double p3_x, double p3_y, int* num_segmentsInOptional)
Description:Default values: num_segments = 0
| Parameters: |
| ImGui_DrawList draw_list | - | |
| number p2_x | - | |
| number p2_y | - | |
| number p3_x | - | |
| number p3_y | - | |
| optional number num_segmentsIn | - | |
^
ImGui_DrawList_PathClearFunctioncall:
C: void ImGui_DrawList_PathClear(ImGui_DrawList* draw_list)
EEL2: extension_api("ImGui_DrawList_PathClear", ImGui_DrawList draw_list)
Lua: reaper.ImGui_DrawList_PathClear(ImGui_DrawList draw_list)
Python: void ImGui_DrawList_PathClear(ImGui_DrawList* draw_list)
Description:Python: ImGui_DrawList_PathClear(ImGui_DrawList draw_list)
| Parameters: |
| ImGui_DrawList draw_list | - | |
^
ImGui_DrawList_PathLineToFunctioncall:
C: void ImGui_DrawList_PathLineTo(ImGui_DrawList* draw_list, double pos_x, double pos_y)
EEL2: extension_api("ImGui_DrawList_PathLineTo", ImGui_DrawList draw_list, pos_x, pos_y)
Lua: reaper.ImGui_DrawList_PathLineTo(ImGui_DrawList draw_list, number pos_x, number pos_y)
Python: void ImGui_DrawList_PathLineTo(ImGui_DrawList* draw_list, double pos_x, double pos_y)
Description:Stateful path API, add points then finish with PathFillConvex() or PathStroke()
| Parameters: |
| ImGui_DrawList draw_list | - | |
| number pos_x | - | |
| number pos_y | - | |
^
ImGui_DrawList_PathRectFunctioncall:
C: void ImGui_DrawList_PathRect(ImGui_DrawList* draw_list, double rect_min_x, double rect_min_y, double rect_max_x, double rect_max_y, double* roundingInOptional, int* flagsInOptional)
EEL2: extension_api("ImGui_DrawList_PathRect", ImGui_DrawList draw_list, rect_min_x, rect_min_y, rect_max_x, rect_max_y, optional roundingIn, optional int flagsIn)
Lua: reaper.ImGui_DrawList_PathRect(ImGui_DrawList draw_list, number rect_min_x, number rect_min_y, number rect_max_x, number rect_max_y, optional number roundingIn, optional number flagsIn)
Python: void ImGui_DrawList_PathRect(ImGui_DrawList* draw_list, double rect_min_x, double rect_min_y, double rect_max_x, double rect_max_y, double* roundingInOptional, int* flagsInOptional)
Description:Default values: rounding = 0.0, flags = ImGui_DrawFlags_None
| Parameters: |
| ImGui_DrawList draw_list | - | |
| number rect_min_x | - | |
| number rect_min_y | - | |
| number rect_max_x | - | |
| number rect_max_y | - | |
| optional number roundingIn | - | |
| optional number flagsIn | - | |
^
ImGui_DrawList_PathStrokeFunctioncall:
C: void ImGui_DrawList_PathStroke(ImGui_DrawList* draw_list, int col_rgba, int* flagsInOptional, double* thicknessInOptional)
EEL2: extension_api("ImGui_DrawList_PathStroke", ImGui_DrawList draw_list, int col_rgba, optional int flagsIn, optional thicknessIn)
Lua: reaper.ImGui_DrawList_PathStroke(ImGui_DrawList draw_list, integer col_rgba, optional number flagsIn, optional number thicknessIn)
Python: void ImGui_DrawList_PathStroke(ImGui_DrawList* draw_list, int col_rgba, int* flagsInOptional, double* thicknessInOptional)
Description:Default values: flags = ImGui_DrawFlags_None, thickness = 1.0
| Parameters: |
| ImGui_DrawList draw_list | - | |
| integer col_rgba | - | |
| optional number flagsIn | - | |
| optional number thicknessIn | - | |
^
ImGui_DrawList_PopClipRectFunctioncall:
C: void ImGui_DrawList_PopClipRect(ImGui_DrawList* draw_list)
EEL2: extension_api("ImGui_DrawList_PopClipRect", ImGui_DrawList draw_list)
Lua: reaper.ImGui_DrawList_PopClipRect(ImGui_DrawList draw_list)
Python: void ImGui_DrawList_PopClipRect(ImGui_DrawList* draw_list)
Description:See DrawList_PushClipRect
| Parameters: |
| ImGui_DrawList draw_list | - | |
^
ImGui_DrawList_PushClipRectFunctioncall:
C: void ImGui_DrawList_PushClipRect(ImGui_DrawList* draw_list, double clip_rect_min_x, double clip_rect_min_y, double clip_rect_max_x, double clip_rect_max_y, bool* intersect_with_current_clip_rectInOptional)
EEL2: extension_api("ImGui_DrawList_PushClipRect", ImGui_DrawList draw_list, clip_rect_min_x, clip_rect_min_y, clip_rect_max_x, clip_rect_max_y, optional bool intersect_with_current_clip_rectIn)
Lua: reaper.ImGui_DrawList_PushClipRect(ImGui_DrawList draw_list, number clip_rect_min_x, number clip_rect_min_y, number clip_rect_max_x, number clip_rect_max_y, optional boolean intersect_with_current_clip_rectIn)
Python: void ImGui_DrawList_PushClipRect(ImGui_DrawList* draw_list, double clip_rect_min_x, double clip_rect_min_y, double clip_rect_max_x, double clip_rect_max_y, bool* intersect_with_current_clip_rectInOptional)
Description:Default values: intersect_with_current_clip_rect = false
| Parameters: |
| ImGui_DrawList draw_list | - | |
| number clip_rect_min_x | - | |
| number clip_rect_min_y | - | |
| number clip_rect_max_x | - | |
| number clip_rect_max_y | - | |
| optional boolean intersect_with_current_clip_rectIn | - | |
^
ImGui_DrawList_PushClipRectFullScreenFunctioncall:
C: void ImGui_DrawList_PushClipRectFullScreen(ImGui_DrawList* draw_list)
EEL2: extension_api("ImGui_DrawList_PushClipRectFullScreen", ImGui_DrawList draw_list)
Lua: reaper.ImGui_DrawList_PushClipRectFullScreen(ImGui_DrawList draw_list)
Python: void ImGui_DrawList_PushClipRectFullScreen(ImGui_DrawList* draw_list)
Description:Python: ImGui_DrawList_PushClipRectFullScreen(ImGui_DrawList draw_list)
| Parameters: |
| ImGui_DrawList draw_list | - | |
^
ImGui_DummyFunctioncall:
C: void ImGui_Dummy(ImGui_Context* ctx, double size_w, double size_h)
EEL2: extension_api("ImGui_Dummy", ImGui_Context ctx, size_w, size_h)
Lua: reaper.ImGui_Dummy(ImGui_Context ctx, number size_w, number size_h)
Python: void ImGui_Dummy(ImGui_Context* ctx, double size_w, double size_h)
Description:Add a dummy item of given size. unlike InvisibleButton(), Dummy() won't take the mouse click or be navigable into.
| Parameters: |
| ImGui_Context ctx | - | |
| number size_w | - | |
| number size_h | - | |
^
ImGui_EndFunctioncall:
C: void ImGui_End(ImGui_Context* ctx)
EEL2: extension_api("ImGui_End", ImGui_Context ctx)
Lua: reaper.ImGui_End(ImGui_Context ctx)
Python: void ImGui_End(ImGui_Context* ctx)
Description:
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_EndChildFunctioncall:
C: void ImGui_EndChild(ImGui_Context* ctx)
EEL2: extension_api("ImGui_EndChild", ImGui_Context ctx)
Lua: reaper.ImGui_EndChild(ImGui_Context ctx)
Python: void ImGui_EndChild(ImGui_Context* ctx)
Description:
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_EndChildFrameFunctioncall:
C: void ImGui_EndChildFrame(ImGui_Context* ctx)
EEL2: extension_api("ImGui_EndChildFrame", ImGui_Context ctx)
Lua: reaper.ImGui_EndChildFrame(ImGui_Context ctx)
Python: void ImGui_EndChildFrame(ImGui_Context* ctx)
Description:
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_EndComboFunctioncall:
C: void ImGui_EndCombo(ImGui_Context* ctx)
EEL2: extension_api("ImGui_EndCombo", ImGui_Context ctx)
Lua: reaper.ImGui_EndCombo(ImGui_Context ctx)
Python: void ImGui_EndCombo(ImGui_Context* ctx)
Description:Only call EndCombo() if BeginCombo() returns true!
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_EndDragDropSourceFunctioncall:
C: void ImGui_EndDragDropSource(ImGui_Context* ctx)
EEL2: extension_api("ImGui_EndDragDropSource", ImGui_Context ctx)
Lua: reaper.ImGui_EndDragDropSource(ImGui_Context ctx)
Python: void ImGui_EndDragDropSource(ImGui_Context* ctx)
Description:Only call EndDragDropSource() if BeginDragDropSource() returns true!
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_EndDragDropTargetFunctioncall:
C: void ImGui_EndDragDropTarget(ImGui_Context* ctx)
EEL2: extension_api("ImGui_EndDragDropTarget", ImGui_Context ctx)
Lua: reaper.ImGui_EndDragDropTarget(ImGui_Context ctx)
Python: void ImGui_EndDragDropTarget(ImGui_Context* ctx)
Description:Only call EndDragDropTarget() if BeginDragDropTarget() returns true!
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_EndGroupFunctioncall:
C: void ImGui_EndGroup(ImGui_Context* ctx)
EEL2: extension_api("ImGui_EndGroup", ImGui_Context ctx)
Lua: reaper.ImGui_EndGroup(ImGui_Context ctx)
Python: void ImGui_EndGroup(ImGui_Context* ctx)
Description:
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_EndListBoxFunctioncall:
C: void ImGui_EndListBox(ImGui_Context* ctx)
EEL2: extension_api("ImGui_EndListBox", ImGui_Context ctx)
Lua: reaper.ImGui_EndListBox(ImGui_Context ctx)
Python: void ImGui_EndListBox(ImGui_Context* ctx)
Description:
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_EndMainMenuBarFunctioncall:
C: void ImGui_EndMainMenuBar(ImGui_Context* ctx)
EEL2: extension_api("ImGui_EndMainMenuBar", ImGui_Context ctx)
Lua: reaper.ImGui_EndMainMenuBar(ImGui_Context ctx)
Python: void ImGui_EndMainMenuBar(ImGui_Context* ctx)
Description:
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_EndMenuFunctioncall:
C: void ImGui_EndMenu(ImGui_Context* ctx)
EEL2: extension_api("ImGui_EndMenu", ImGui_Context ctx)
Lua: reaper.ImGui_EndMenu(ImGui_Context ctx)
Python: void ImGui_EndMenu(ImGui_Context* ctx)
Description:
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_EndMenuBarFunctioncall:
C: void ImGui_EndMenuBar(ImGui_Context* ctx)
EEL2: extension_api("ImGui_EndMenuBar", ImGui_Context ctx)
Lua: reaper.ImGui_EndMenuBar(ImGui_Context ctx)
Python: void ImGui_EndMenuBar(ImGui_Context* ctx)
Description:
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_EndPopupFunctioncall:
C: void ImGui_EndPopup(ImGui_Context* ctx)
EEL2: extension_api("ImGui_EndPopup", ImGui_Context ctx)
Lua: reaper.ImGui_EndPopup(ImGui_Context ctx)
Python: void ImGui_EndPopup(ImGui_Context* ctx)
Description:only call EndPopup() if BeginPopupXXX() returns true!
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_EndTabBarFunctioncall:
C: void ImGui_EndTabBar(ImGui_Context* ctx)
EEL2: extension_api("ImGui_EndTabBar", ImGui_Context ctx)
Lua: reaper.ImGui_EndTabBar(ImGui_Context ctx)
Python: void ImGui_EndTabBar(ImGui_Context* ctx)
Description:Only call EndTabBar() if BeginTabBar() returns true!
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_EndTabItemFunctioncall:
C: void ImGui_EndTabItem(ImGui_Context* ctx)
EEL2: extension_api("ImGui_EndTabItem", ImGui_Context ctx)
Lua: reaper.ImGui_EndTabItem(ImGui_Context ctx)
Python: void ImGui_EndTabItem(ImGui_Context* ctx)
Description:Only call EndTabItem() if BeginTabItem() returns true!
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_EndTableFunctioncall:
C: void ImGui_EndTable(ImGui_Context* ctx)
EEL2: extension_api("ImGui_EndTable", ImGui_Context ctx)
Lua: reaper.ImGui_EndTable(ImGui_Context ctx)
Python: void ImGui_EndTable(ImGui_Context* ctx)
Description:Only call EndTable() if BeginTable() returns true!
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_EndTooltipFunctioncall:
C: void ImGui_EndTooltip(ImGui_Context* ctx)
EEL2: extension_api("ImGui_EndTooltip", ImGui_Context ctx)
Lua: reaper.ImGui_EndTooltip(ImGui_Context ctx)
Python: void ImGui_EndTooltip(ImGui_Context* ctx)
Description:Python: ImGui_EndTooltip(ImGui_Context ctx)
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_FocusedFlags_AnyWindowFunctioncall:
C: int ImGui_FocusedFlags_AnyWindow()
EEL2: int extension_api("ImGui_FocusedFlags_AnyWindow")
Lua: integer reaper.ImGui_FocusedFlags_AnyWindow()
Python: int ImGui_FocusedFlags_AnyWindow()
Description:IsWindowFocused(): Return true if any window is focused. Important: If you are trying to tell how to dispatch your low-level inputs, do NOT use this. Use 'io.WantCaptureMouse' instead! Please read the FAQ!
^
ImGui_FocusedFlags_ChildWindowsFunctioncall:
C: int ImGui_FocusedFlags_ChildWindows()
EEL2: int extension_api("ImGui_FocusedFlags_ChildWindows")
Lua: integer reaper.ImGui_FocusedFlags_ChildWindows()
Python: int ImGui_FocusedFlags_ChildWindows()
Description:IsWindowFocused(): Return true if any children of the window is focused
^
ImGui_FocusedFlags_NoneFunctioncall:
C: int ImGui_FocusedFlags_None()
EEL2: int extension_api("ImGui_FocusedFlags_None")
Lua: integer reaper.ImGui_FocusedFlags_None()
Python: int ImGui_FocusedFlags_None()
Description:Flags for ImGui::IsWindowFocused()
^
ImGui_FocusedFlags_RootAndChildWindowsFunctioncall:
C: int ImGui_FocusedFlags_RootAndChildWindows()
EEL2: int extension_api("ImGui_FocusedFlags_RootAndChildWindows")
Lua: integer reaper.ImGui_FocusedFlags_RootAndChildWindows()
Python: int ImGui_FocusedFlags_RootAndChildWindows()
Description:ImGui_FocusedFlags_RootWindow | ImGui_FocusedFlags_ChildWindows
^
ImGui_FocusedFlags_RootWindowFunctioncall:
C: int ImGui_FocusedFlags_RootWindow()
EEL2: int extension_api("ImGui_FocusedFlags_RootWindow")
Lua: integer reaper.ImGui_FocusedFlags_RootWindow()
Python: int ImGui_FocusedFlags_RootWindow()
Description:IsWindowFocused(): Test from root window (top most parent of the current hierarchy)
^
ImGui_FontFlags_BoldFunctioncall:
C: int ImGui_FontFlags_Bold()
EEL2: int extension_api("ImGui_FontFlags_Bold")
Lua: integer reaper.ImGui_FontFlags_Bold()
Python: int ImGui_FontFlags_Bold()
Description:Python: Int ImGui_FontFlags_Bold()
^
ImGui_FontFlags_ItalicFunctioncall:
C: int ImGui_FontFlags_Italic()
EEL2: int extension_api("ImGui_FontFlags_Italic")
Lua: integer reaper.ImGui_FontFlags_Italic()
Python: int ImGui_FontFlags_Italic()
Description:Python: Int ImGui_FontFlags_Italic()
^
ImGui_FontFlags_NoneFunctioncall:
C: int ImGui_FontFlags_None()
EEL2: int extension_api("ImGui_FontFlags_None")
Lua: integer reaper.ImGui_FontFlags_None()
Python: int ImGui_FontFlags_None()
Description:Python: Int ImGui_FontFlags_None()
^
ImGui_GetBackgroundDrawListFunctioncall:
C: ImGui_DrawList* ImGui_GetBackgroundDrawList(ImGui_Context* ctx)
EEL2: ImGui_DrawList extension_api("ImGui_GetBackgroundDrawList", ImGui_Context ctx)
Lua: ImGui_DrawList reaper.ImGui_GetBackgroundDrawList(ImGui_Context ctx)
Python: ImGui_DrawList* ImGui_GetBackgroundDrawList(ImGui_Context* ctx)
Description:This draw list will be the first rendering one. Useful to quickly draw shapes/text behind dear imgui contents.
| Parameters: |
| ImGui_Context ctx | - | |
| Returnvalues: |
| ImGui_DrawList | - | |
^
ImGui_GetClipboardTextFunctioncall:
C: const char* ImGui_GetClipboardText(ImGui_Context* ctx)
EEL2: bool extension_api("ImGui_GetClipboardText", #retval, ImGui_Context ctx)
Lua: string reaper.ImGui_GetClipboardText(ImGui_Context ctx)
Python: const char* ImGui_GetClipboardText(ImGui_Context* ctx)
Description:
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_GetColorFunctioncall:
C: int ImGui_GetColor(ImGui_Context* ctx, int idx, double* alpha_mulInOptional)
EEL2: int extension_api("ImGui_GetColor", ImGui_Context ctx, int idx, optional alpha_mulIn)
Lua: integer reaper.ImGui_GetColor(ImGui_Context ctx, integer idx, optional number alpha_mulIn)
Python: int ImGui_GetColor(ImGui_Context* ctx, int idx, double* alpha_mulInOptional)
Description:Default values: alpha_mul = 1.0
| Parameters: |
| ImGui_Context ctx | - | |
| integer idx | - | |
| optional number alpha_mulIn | - | |
^
ImGui_GetColorExFunctioncall:
C: int ImGui_GetColorEx(ImGui_Context* ctx, int col_rgba)
EEL2: int extension_api("ImGui_GetColorEx", ImGui_Context ctx, int col_rgba)
Lua: integer reaper.ImGui_GetColorEx(ImGui_Context ctx, integer col_rgba)
Python: int ImGui_GetColorEx(ImGui_Context* ctx, int col_rgba)
Description:Retrieve given color with style alpha applied, packed as a 32-bit value (RGBA).
| Parameters: |
| ImGui_Context ctx | - | |
| integer col_rgba | - | |
^
ImGui_GetConfigFlagsFunctioncall:
C: int ImGui_GetConfigFlags(ImGui_Context* ctx)
EEL2: int extension_api("ImGui_GetConfigFlags", ImGui_Context ctx)
Lua: integer reaper.ImGui_GetConfigFlags(ImGui_Context ctx)
Python: int ImGui_GetConfigFlags(ImGui_Context* ctx)
Description:
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_GetContentRegionAvailFunctioncall:
C: void ImGui_GetContentRegionAvail(ImGui_Context* ctx, double* xOut, double* yOut)
EEL2: extension_api("ImGui_GetContentRegionAvail", ImGui_Context ctx, &x, &y)
Lua: number x, number y = reaper.ImGui_GetContentRegionAvail(ImGui_Context ctx)
Python: void ImGui_GetContentRegionAvail(ImGui_Context* ctx, double* xOut, double* yOut)
Description:== GetContentRegionMax() - GetCursorPos()
| Parameters: |
| ImGui_Context ctx | - | |
| Returnvalues: |
| number x | - | |
| number y | - | - |
^
ImGui_GetContentRegionMaxFunctioncall:
C: void ImGui_GetContentRegionMax(ImGui_Context* ctx, double* xOut, double* yOut)
EEL2: extension_api("ImGui_GetContentRegionMax", ImGui_Context ctx, &x, &y)
Lua: number x, number y = reaper.ImGui_GetContentRegionMax(ImGui_Context ctx)
Python: void ImGui_GetContentRegionMax(ImGui_Context* ctx, double* xOut, double* yOut)
Description:Current content boundaries (typically window boundaries including scrolling, or current column boundaries), in windows coordinates
| Parameters: |
| ImGui_Context ctx | - | |
| Returnvalues: |
| number x | - | |
| number y | - | - |
^
ImGui_GetCursorPosFunctioncall:
C: void ImGui_GetCursorPos(ImGui_Context* ctx, double* xOut, double* yOut)
EEL2: extension_api("ImGui_GetCursorPos", ImGui_Context ctx, &x, &y)
Lua: number x, number y = reaper.ImGui_GetCursorPos(ImGui_Context ctx)
Python: void ImGui_GetCursorPos(ImGui_Context* ctx, double* xOut, double* yOut)
Description:Cursor position in window
| Parameters: |
| ImGui_Context ctx | - | |
| Returnvalues: |
| number x | - | |
| number y | - | - |
^
ImGui_GetCursorPosXFunctioncall:
C: double ImGui_GetCursorPosX(ImGui_Context* ctx)
EEL2: double extension_api("ImGui_GetCursorPosX", ImGui_Context ctx)
Lua: number reaper.ImGui_GetCursorPosX(ImGui_Context ctx)
Python: double ImGui_GetCursorPosX(ImGui_Context* ctx)
Description:Cursor X position in window
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_GetCursorPosYFunctioncall:
C: double ImGui_GetCursorPosY(ImGui_Context* ctx)
EEL2: double extension_api("ImGui_GetCursorPosY", ImGui_Context ctx)
Lua: number reaper.ImGui_GetCursorPosY(ImGui_Context ctx)
Python: double ImGui_GetCursorPosY(ImGui_Context* ctx)
Description:Cursor Y position in window
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_GetCursorScreenPosFunctioncall:
C: void ImGui_GetCursorScreenPos(ImGui_Context* ctx, double* xOut, double* yOut)
EEL2: extension_api("ImGui_GetCursorScreenPos", ImGui_Context ctx, &x, &y)
Lua: number x, number y = reaper.ImGui_GetCursorScreenPos(ImGui_Context ctx)
Python: void ImGui_GetCursorScreenPos(ImGui_Context* ctx, double* xOut, double* yOut)
Description:Cursor position in absolute screen coordinates [0..io.DisplaySize] (useful to work with ImDrawList API)
| Parameters: |
| ImGui_Context ctx | - | |
| Returnvalues: |
| number x | - | |
| number y | - | - |
^
ImGui_GetCursorStartPosFunctioncall:
C: void ImGui_GetCursorStartPos(ImGui_Context* ctx, double* xOut, double* yOut)
EEL2: extension_api("ImGui_GetCursorStartPos", ImGui_Context ctx, &x, &y)
Lua: number x, number y = reaper.ImGui_GetCursorStartPos(ImGui_Context ctx)
Python: void ImGui_GetCursorStartPos(ImGui_Context* ctx, double* xOut, double* yOut)
Description:Initial cursor position in window coordinates
| Parameters: |
| ImGui_Context ctx | - | |
| Returnvalues: |
| number x | - | |
| number y | - | - |
^
ImGui_GetDeltaTimeFunctioncall:
C: double ImGui_GetDeltaTime(ImGui_Context* ctx)
EEL2: double extension_api("ImGui_GetDeltaTime", ImGui_Context ctx)
Lua: number reaper.ImGui_GetDeltaTime(ImGui_Context ctx)
Python: double ImGui_GetDeltaTime(ImGui_Context* ctx)
Description:Time elapsed since last frame, in seconds.
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_GetDisplaySizeFunctioncall:
C: void ImGui_GetDisplaySize(ImGui_Context* ctx, double* wOut, double* hOut)
EEL2: extension_api("ImGui_GetDisplaySize", ImGui_Context ctx, &w, &h)
Lua: number w, number h = reaper.ImGui_GetDisplaySize(ImGui_Context ctx)
Python: void ImGui_GetDisplaySize(ImGui_Context* ctx, double* wOut, double* hOut)
Description:Python: (ImGui_Context ctx, Float wOut, Float hOut) = ImGui_GetDisplaySize(ctx, wOut, hOut)
| Parameters: |
| ImGui_Context ctx | - | |
| Returnvalues: |
| number w | - | |
| number h | - | - |
^
ImGui_GetDockFunctioncall:
C: int ImGui_GetDock(ImGui_Context* ctx)
EEL2: int extension_api("ImGui_GetDock", ImGui_Context ctx)
Lua: integer reaper.ImGui_GetDock(ImGui_Context ctx)
Python: int ImGui_GetDock(ImGui_Context* ctx)
Description:
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_GetDragDropPayloadFunctioncall:
C: bool ImGui_GetDragDropPayload(ImGui_Context* ctx, char* typeOut, int typeOut_sz, char* payloadOutNeedBig, int payloadOutNeedBig_sz, bool* is_previewOut, bool* is_deliveryOut)
EEL2: bool extension_api("ImGui_GetDragDropPayload", ImGui_Context ctx, #type, #payload, bool &is_preview, bool &is_delivery)
Lua: boolean retval, string type, string payload, boolean is_preview, boolean is_delivery = reaper.ImGui_GetDragDropPayload(ImGui_Context ctx)
Python: bool ImGui_GetDragDropPayload(ImGui_Context* ctx, char* typeOut, int typeOut_sz, char* payloadOutNeedBig, int payloadOutNeedBig_sz, bool* is_previewOut, bool* is_deliveryOut)
Description:Peek directly into the current payload from anywhere.
| Parameters: |
| ImGui_Context ctx | - | |
| Returnvalues: |
| boolean retval | - | |
| string type | - | |
| string payload | - | |
| boolean is_preview | - | |
| boolean is_delivery | - | - |
^
ImGui_GetDragDropPayloadFileFunctioncall:
C: bool ImGui_GetDragDropPayloadFile(ImGui_Context* ctx, int index, char* filenameOut, int filenameOut_sz)
EEL2: bool extension_api("ImGui_GetDragDropPayloadFile", ImGui_Context ctx, int index, #filename)
Lua: boolean retval, string filename = reaper.ImGui_GetDragDropPayloadFile(ImGui_Context ctx, integer index)
Python: bool ImGui_GetDragDropPayloadFile(ImGui_Context* ctx, int index, char* filenameOut, int filenameOut_sz)
Description:Python: (Boolean retval, ImGui_Context ctx, Int index, String filenameOut, Int filenameOut_sz) = ImGui_GetDragDropPayloadFile(ctx, index, filenameOut, filenameOut_sz)
| Parameters: |
| ImGui_Context ctx | - | |
| integer index | - | |
| Returnvalues: |
| boolean retval | - | |
| string filename | - | - |
^
ImGui_GetFontFunctioncall:
C: ImGui_Font* ImGui_GetFont(ImGui_Context* ctx)
EEL2: ImGui_Font extension_api("ImGui_GetFont", ImGui_Context ctx)
Lua: ImGui_Font reaper.ImGui_GetFont(ImGui_Context ctx)
Python: ImGui_Font* ImGui_GetFont(ImGui_Context* ctx)
Description:Get the current font
| Parameters: |
| ImGui_Context ctx | - | |
| Returnvalues: |
| ImGui_Font | - | |
^
ImGui_GetFontSizeFunctioncall:
C: double ImGui_GetFontSize(ImGui_Context* ctx)
EEL2: double extension_api("ImGui_GetFontSize", ImGui_Context ctx)
Lua: number reaper.ImGui_GetFontSize(ImGui_Context ctx)
Python: double ImGui_GetFontSize(ImGui_Context* ctx)
Description:Get current font size (= height in pixels) of current font with current scale applied
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_GetForegroundDrawListFunctioncall:
C: ImGui_DrawList* ImGui_GetForegroundDrawList(ImGui_Context* ctx)
EEL2: ImGui_DrawList extension_api("ImGui_GetForegroundDrawList", ImGui_Context ctx)
Lua: ImGui_DrawList reaper.ImGui_GetForegroundDrawList(ImGui_Context ctx)
Python: ImGui_DrawList* ImGui_GetForegroundDrawList(ImGui_Context* ctx)
Description:This draw list will be the last rendered one. Useful to quickly draw shapes/text over dear imgui contents.
| Parameters: |
| ImGui_Context ctx | - | |
| Returnvalues: |
| ImGui_DrawList | - | |
^
ImGui_GetFrameCountFunctioncall:
C: int ImGui_GetFrameCount(ImGui_Context* ctx)
EEL2: int extension_api("ImGui_GetFrameCount", ImGui_Context ctx)
Lua: integer reaper.ImGui_GetFrameCount(ImGui_Context ctx)
Python: int ImGui_GetFrameCount(ImGui_Context* ctx)
Description:Get global imgui frame count. incremented by 1 every frame.
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_GetFrameHeightFunctioncall:
C: double ImGui_GetFrameHeight(ImGui_Context* ctx)
EEL2: double extension_api("ImGui_GetFrameHeight", ImGui_Context ctx)
Lua: number reaper.ImGui_GetFrameHeight(ImGui_Context ctx)
Python: double ImGui_GetFrameHeight(ImGui_Context* ctx)
Description:~ FontSize + style.FramePadding.y * 2
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_GetFrameHeightWithSpacingFunctioncall:
C: double ImGui_GetFrameHeightWithSpacing(ImGui_Context* ctx)
EEL2: double extension_api("ImGui_GetFrameHeightWithSpacing", ImGui_Context ctx)
Lua: number reaper.ImGui_GetFrameHeightWithSpacing(ImGui_Context ctx)
Python: double ImGui_GetFrameHeightWithSpacing(ImGui_Context* ctx)
Description:~ FontSize + style.FramePadding.y * 2 + style.ItemSpacing.y (distance in pixels between 2 consecutive lines of framed widgets)
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_GetInputQueueCharacterFunctioncall:
C: bool ImGui_GetInputQueueCharacter(ImGui_Context* ctx, int idx, int* unicode_charOut)
EEL2: bool extension_api("ImGui_GetInputQueueCharacter", ImGui_Context ctx, int idx, int &unicode_char)
Lua: boolean retval, number unicode_char = reaper.ImGui_GetInputQueueCharacter(ImGui_Context ctx, integer idx)
Python: bool ImGui_GetInputQueueCharacter(ImGui_Context* ctx, int idx, int* unicode_charOut)
Description:Read from ImGui's character input queue. Call with increasing idx until false is returned.
| Parameters: |
| ImGui_Context ctx | - | |
| integer idx | - | |
| Returnvalues: |
| boolean retval | - | |
| number unicode_char | - | - |
^
ImGui_GetItemRectMaxFunctioncall:
C: void ImGui_GetItemRectMax(ImGui_Context* ctx, double* xOut, double* yOut)
EEL2: extension_api("ImGui_GetItemRectMax", ImGui_Context ctx, &x, &y)
Lua: number x, number y = reaper.ImGui_GetItemRectMax(ImGui_Context ctx)
Python: void ImGui_GetItemRectMax(ImGui_Context* ctx, double* xOut, double* yOut)
Description:Get lower-right bounding rectangle of the last item (screen space)
| Parameters: |
| ImGui_Context ctx | - | |
| Returnvalues: |
| number x | - | |
| number y | - | - |
^
ImGui_GetItemRectMinFunctioncall:
C: void ImGui_GetItemRectMin(ImGui_Context* ctx, double* xOut, double* yOut)
EEL2: extension_api("ImGui_GetItemRectMin", ImGui_Context ctx, &x, &y)
Lua: number x, number y = reaper.ImGui_GetItemRectMin(ImGui_Context ctx)
Python: void ImGui_GetItemRectMin(ImGui_Context* ctx, double* xOut, double* yOut)
Description:Get upper-left bounding rectangle of the last item (screen space)
| Parameters: |
| ImGui_Context ctx | - | |
| Returnvalues: |
| number x | - | |
| number y | - | - |
^
ImGui_GetItemRectSizeFunctioncall:
C: void ImGui_GetItemRectSize(ImGui_Context* ctx, double* wOut, double* hOut)
EEL2: extension_api("ImGui_GetItemRectSize", ImGui_Context ctx, &w, &h)
Lua: number w, number h = reaper.ImGui_GetItemRectSize(ImGui_Context ctx)
Python: void ImGui_GetItemRectSize(ImGui_Context* ctx, double* wOut, double* hOut)
Description:Get size of last item
| Parameters: |
| ImGui_Context ctx | - | |
| Returnvalues: |
| number w | - | |
| number h | - | - |
^
ImGui_GetKeyDownDurationFunctioncall:
C: double ImGui_GetKeyDownDuration(ImGui_Context* ctx, int key_code)
EEL2: double extension_api("ImGui_GetKeyDownDuration", ImGui_Context ctx, int key_code)
Lua: number reaper.ImGui_GetKeyDownDuration(ImGui_Context ctx, integer key_code)
Python: double ImGui_GetKeyDownDuration(ImGui_Context* ctx, int key_code)
Description:Duration the keyboard key has been down (0.0f == just pressed)
| Parameters: |
| ImGui_Context ctx | - | |
| integer key_code | - | |
^
ImGui_GetKeyModsFunctioncall:
C: int ImGui_GetKeyMods(ImGui_Context* ctx)
EEL2: int extension_api("ImGui_GetKeyMods", ImGui_Context ctx)
Lua: integer reaper.ImGui_GetKeyMods(ImGui_Context ctx)
Python: int ImGui_GetKeyMods(ImGui_Context* ctx)
Description:Ctrl/Shift/Alt/Super. See ImGui_KeyModFlags_*.
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_GetKeyPressedAmountFunctioncall:
C: int ImGui_GetKeyPressedAmount(ImGui_Context* ctx, int key_index, double repeat_delay, double rate)
EEL2: int extension_api("ImGui_GetKeyPressedAmount", ImGui_Context ctx, int key_index, repeat_delay, rate)
Lua: integer reaper.ImGui_GetKeyPressedAmount(ImGui_Context ctx, integer key_index, number repeat_delay, number rate)
Python: int ImGui_GetKeyPressedAmount(ImGui_Context* ctx, int key_index, double repeat_delay, double rate)
Description:Uses provided repeat rate/delay. return a count, most often 0 or 1 but might be >1 if RepeatRate is small enough that DeltaTime > RepeatRate
| Parameters: |
| ImGui_Context ctx | - | |
| integer key_index | - | |
| number repeat_delay | - | |
| number rate | - | |
^
ImGui_GetMainViewportFunctioncall:
C: ImGui_Viewport* ImGui_GetMainViewport(ImGui_Context* ctx)
EEL2: ImGui_Viewport extension_api("ImGui_GetMainViewport", ImGui_Context ctx)
Lua: ImGui_Viewport reaper.ImGui_GetMainViewport(ImGui_Context ctx)
Python: ImGui_Viewport* ImGui_GetMainViewport(ImGui_Context* ctx)
Description:Windows are generally trying to stay within the Work Area of their host viewport.
| Parameters: |
| ImGui_Context ctx | - | |
| Returnvalues: |
| ImGui_Viewport | - | |
^
ImGui_GetMouseClickedPosFunctioncall:
C: void ImGui_GetMouseClickedPos(ImGui_Context* ctx, int button, double* xOut, double* yOut)
EEL2: extension_api("ImGui_GetMouseClickedPos", ImGui_Context ctx, int button, &x, &y)
Lua: number x, number y = reaper.ImGui_GetMouseClickedPos(ImGui_Context ctx, integer button)
Python: void ImGui_GetMouseClickedPos(ImGui_Context* ctx, int button, double* xOut, double* yOut)
Description:Python: (ImGui_Context ctx, Int button, Float xOut, Float yOut) = ImGui_GetMouseClickedPos(ctx, button, xOut, yOut)
| Parameters: |
| ImGui_Context ctx | - | |
| integer button | - | |
| Returnvalues: |
| number x | - | |
| number y | - | - |
^
ImGui_GetMouseCursorFunctioncall:
C: int ImGui_GetMouseCursor(ImGui_Context* ctx)
EEL2: int extension_api("ImGui_GetMouseCursor", ImGui_Context ctx)
Lua: integer reaper.ImGui_GetMouseCursor(ImGui_Context ctx)
Python: int ImGui_GetMouseCursor(ImGui_Context* ctx)
Description:Get desired cursor type, reset every frame. This is updated during the frame.
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_GetMouseDeltaFunctioncall:
C: void ImGui_GetMouseDelta(ImGui_Context* ctx, double* xOut, double* yOut)
EEL2: extension_api("ImGui_GetMouseDelta", ImGui_Context ctx, &x, &y)
Lua: number x, number y = reaper.ImGui_GetMouseDelta(ImGui_Context ctx)
Python: void ImGui_GetMouseDelta(ImGui_Context* ctx, double* xOut, double* yOut)
Description:Mouse delta. Note that this is zero if either current or previous position are invalid (-FLT_MAX,-FLT_MAX), so a disappearing/reappearing mouse won't have a huge delta.
| Parameters: |
| ImGui_Context ctx | - | |
| Returnvalues: |
| number x | - | |
| number y | - | - |
^
ImGui_GetMouseDownDurationFunctioncall:
C: double ImGui_GetMouseDownDuration(ImGui_Context* ctx, int button)
EEL2: double extension_api("ImGui_GetMouseDownDuration", ImGui_Context ctx, int button)
Lua: number reaper.ImGui_GetMouseDownDuration(ImGui_Context ctx, integer button)
Python: double ImGui_GetMouseDownDuration(ImGui_Context* ctx, int button)
Description:Duration the mouse button has been down (0.0f == just clicked)
| Parameters: |
| ImGui_Context ctx | - | |
| integer button | - | |
^
ImGui_GetMouseDragDeltaFunctioncall:
C: void ImGui_GetMouseDragDelta(ImGui_Context* ctx, double* xOut, double* yOut, int* buttonInOptional, double* lock_thresholdInOptional)
EEL2: extension_api("ImGui_GetMouseDragDelta", ImGui_Context ctx, &x, &y, optional int buttonIn, optional lock_thresholdIn)
Lua: number x, number y = reaper.ImGui_GetMouseDragDelta(ImGui_Context ctx, number x, number y, optional number buttonIn, optional number lock_thresholdIn)
Python: void ImGui_GetMouseDragDelta(ImGui_Context* ctx, double* xOut, double* yOut, int* buttonInOptional, double* lock_thresholdInOptional)
Description:Default values: button = ImGui_MouseButton_Left, lock_threshold = -1.0
| Parameters: |
| ImGui_Context ctx | - | |
| number x | - | |
| number y | - | |
| optional number buttonIn | - | |
| optional number lock_thresholdIn | - | |
| Returnvalues: |
| number x | - | |
| number y | - | - |
^
ImGui_GetMousePosFunctioncall:
C: void ImGui_GetMousePos(ImGui_Context* ctx, double* xOut, double* yOut)
EEL2: extension_api("ImGui_GetMousePos", ImGui_Context ctx, &x, &y)
Lua: number x, number y = reaper.ImGui_GetMousePos(ImGui_Context ctx)
Python: void ImGui_GetMousePos(ImGui_Context* ctx, double* xOut, double* yOut)
Description:Python: (ImGui_Context ctx, Float xOut, Float yOut) = ImGui_GetMousePos(ctx, xOut, yOut)
| Parameters: |
| ImGui_Context ctx | - | |
| Returnvalues: |
| number x | - | |
| number y | - | - |
^
ImGui_GetMousePosOnOpeningCurrentPopupFunctioncall:
C: void ImGui_GetMousePosOnOpeningCurrentPopup(ImGui_Context* ctx, double* xOut, double* yOut)
EEL2: extension_api("ImGui_GetMousePosOnOpeningCurrentPopup", ImGui_Context ctx, &x, &y)
Lua: number x, number y = reaper.ImGui_GetMousePosOnOpeningCurrentPopup(ImGui_Context ctx)
Python: void ImGui_GetMousePosOnOpeningCurrentPopup(ImGui_Context* ctx, double* xOut, double* yOut)
Description:Retrieve mouse position at the time of opening popup we have BeginPopup() into (helper to avoid user backing that value themselves)
| Parameters: |
| ImGui_Context ctx | - | |
| Returnvalues: |
| number x | - | |
| number y | - | - |
^
ImGui_GetMouseWheelFunctioncall:
C: void ImGui_GetMouseWheel(ImGui_Context* ctx, double* verticalOut, double* horizontalOut)
EEL2: extension_api("ImGui_GetMouseWheel", ImGui_Context ctx, &vertical, &horizontal)
Lua: number vertical, number horizontal = reaper.ImGui_GetMouseWheel(ImGui_Context ctx)
Python: void ImGui_GetMouseWheel(ImGui_Context* ctx, double* verticalOut, double* horizontalOut)
Description:Mouse wheel Vertical: 1 unit scrolls about 5 lines text.
| Parameters: |
| ImGui_Context ctx | - | |
| Returnvalues: |
| number vertical | - | |
| number horizontal | - | - |
^
ImGui_GetNativeHwndFunctioncall:
C: void* ImGui_GetNativeHwnd(ImGui_Context* ctx)
EEL2: void* extension_api("ImGui_GetNativeHwnd", ImGui_Context ctx)
Lua: identifier reaper.ImGui_GetNativeHwnd(ImGui_Context ctx)
Python: void* ImGui_GetNativeHwnd(ImGui_Context* ctx)
Description:Return the native handle for the context's platform window.
| Parameters: |
| ImGui_Context ctx | - | |
| Returnvalues: |
| identifier | - | |
^
ImGui_GetScrollMaxXFunctioncall:
C: double ImGui_GetScrollMaxX(ImGui_Context* ctx)
EEL2: double extension_api("ImGui_GetScrollMaxX", ImGui_Context ctx)
Lua: number reaper.ImGui_GetScrollMaxX(ImGui_Context ctx)
Python: double ImGui_GetScrollMaxX(ImGui_Context* ctx)
Description:Get maximum scrolling amount ~~ ContentSize.x - WindowSize.x - DecorationsSize.x
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_GetScrollMaxYFunctioncall:
C: double ImGui_GetScrollMaxY(ImGui_Context* ctx)
EEL2: double extension_api("ImGui_GetScrollMaxY", ImGui_Context ctx)
Lua: number reaper.ImGui_GetScrollMaxY(ImGui_Context ctx)
Python: double ImGui_GetScrollMaxY(ImGui_Context* ctx)
Description:Get maximum scrolling amount ~~ ContentSize.y - WindowSize.y - DecorationsSize.y
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_GetScrollXFunctioncall:
C: double ImGui_GetScrollX(ImGui_Context* ctx)
EEL2: double extension_api("ImGui_GetScrollX", ImGui_Context ctx)
Lua: number reaper.ImGui_GetScrollX(ImGui_Context ctx)
Python: double ImGui_GetScrollX(ImGui_Context* ctx)
Description:Get scrolling amount [0 .. GetScrollMaxX()]
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_GetScrollYFunctioncall:
C: double ImGui_GetScrollY(ImGui_Context* ctx)
EEL2: double extension_api("ImGui_GetScrollY", ImGui_Context ctx)
Lua: number reaper.ImGui_GetScrollY(ImGui_Context ctx)
Python: double ImGui_GetScrollY(ImGui_Context* ctx)
Description:Get scrolling amount [0 .. GetScrollMaxY()]
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_GetStyleColorFunctioncall:
C: int ImGui_GetStyleColor(ImGui_Context* ctx, int idx)
EEL2: int extension_api("ImGui_GetStyleColor", ImGui_Context ctx, int idx)
Lua: integer reaper.ImGui_GetStyleColor(ImGui_Context ctx, integer idx)
Python: int ImGui_GetStyleColor(ImGui_Context* ctx, int idx)
Description:Retrieve style color as stored in ImGuiStyle structure. Use to feed back into PushStyleColor(), Otherwise use ImGui_GetColor() to get style color with style alpha baked in. See ImGui_Col_* for available style colors.
| Parameters: |
| ImGui_Context ctx | - | |
| integer idx | - | |
^
ImGui_GetStyleColorNameFunctioncall:
C: const char* ImGui_GetStyleColorName(int idx)
EEL2: bool extension_api("ImGui_GetStyleColorName", #retval, int idx)
Lua: string reaper.ImGui_GetStyleColorName(integer idx)
Python: const char* ImGui_GetStyleColorName(int idx)
Description:Get a string corresponding to the enum value (for display, saving, etc.).
| Parameters: |
| integer idx | - | |
^
ImGui_GetStyleVarFunctioncall:
C: void ImGui_GetStyleVar(ImGui_Context* ctx, int var_idx, double* val1Out, double* val2Out)
EEL2: extension_api("ImGui_GetStyleVar", ImGui_Context ctx, int var_idx, &val1, &val2)
Lua: number val1, number val2 = reaper.ImGui_GetStyleVar(ImGui_Context ctx, integer var_idx)
Python: void ImGui_GetStyleVar(ImGui_Context* ctx, int var_idx, double* val1Out, double* val2Out)
Description:Python: (ImGui_Context ctx, Int var_idx, Float val1Out, Float val2Out) = ImGui_GetStyleVar(ctx, var_idx, val1Out, val2Out)
| Parameters: |
| ImGui_Context ctx | - | |
| integer var_idx | - | |
| Returnvalues: |
| number val1 | - | |
| number val2 | - | - |
^
ImGui_GetTextLineHeightFunctioncall:
C: double ImGui_GetTextLineHeight(ImGui_Context* ctx)
EEL2: double extension_api("ImGui_GetTextLineHeight", ImGui_Context ctx)
Lua: number reaper.ImGui_GetTextLineHeight(ImGui_Context ctx)
Python: double ImGui_GetTextLineHeight(ImGui_Context* ctx)
Description:Same as ImGui_GetFontSize
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_GetTextLineHeightWithSpacingFunctioncall:
C: double ImGui_GetTextLineHeightWithSpacing(ImGui_Context* ctx)
EEL2: double extension_api("ImGui_GetTextLineHeightWithSpacing", ImGui_Context ctx)
Lua: number reaper.ImGui_GetTextLineHeightWithSpacing(ImGui_Context ctx)
Python: double ImGui_GetTextLineHeightWithSpacing(ImGui_Context* ctx)
Description:~ FontSize + style.ItemSpacing.y (distance in pixels between 2 consecutive lines of text)
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_GetTimeFunctioncall:
C: double ImGui_GetTime(ImGui_Context* ctx)
EEL2: double extension_api("ImGui_GetTime", ImGui_Context ctx)
Lua: number reaper.ImGui_GetTime(ImGui_Context ctx)
Python: double ImGui_GetTime(ImGui_Context* ctx)
Description:Get global imgui time. Incremented every frame.
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_GetTreeNodeToLabelSpacingFunctioncall:
C: double ImGui_GetTreeNodeToLabelSpacing(ImGui_Context* ctx)
EEL2: double extension_api("ImGui_GetTreeNodeToLabelSpacing", ImGui_Context ctx)
Lua: number reaper.ImGui_GetTreeNodeToLabelSpacing(ImGui_Context ctx)
Python: double ImGui_GetTreeNodeToLabelSpacing(ImGui_Context* ctx)
Description:Horizontal distance preceding label when using TreeNode*() or Bullet() == (g.FontSize + style.FramePadding.x*2) for a regular unframed TreeNode
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_GetVersionFunctioncall:
C: void ImGui_GetVersion(char* imgui_versionOut, int imgui_versionOut_sz, char* reaimgui_versionOut, int reaimgui_versionOut_sz)
EEL2: extension_api("ImGui_GetVersion", #imgui_version, #reaimgui_version)
Lua: string imgui_version, string reaimgui_version = reaper.ImGui_GetVersion()
Python: void ImGui_GetVersion(char* imgui_versionOut, int imgui_versionOut_sz, char* reaimgui_versionOut, int reaimgui_versionOut_sz)
Description:Python: (String imgui_versionOut, Int imgui_versionOut_sz, String reaimgui_versionOut, Int reaimgui_versionOut_sz) = ImGui_GetVersion(imgui_versionOut, imgui_versionOut_sz, reaimgui_versionOut, reaimgui_versionOut_sz)
| Returnvalues: |
| string imgui_version | - | |
| string reaimgui_version | - | - |
^
ImGui_GetWindowContentRegionMaxFunctioncall:
C: void ImGui_GetWindowContentRegionMax(ImGui_Context* ctx, double* xOut, double* yOut)
EEL2: extension_api("ImGui_GetWindowContentRegionMax", ImGui_Context ctx, &x, &y)
Lua: number x, number y = reaper.ImGui_GetWindowContentRegionMax(ImGui_Context ctx)
Python: void ImGui_GetWindowContentRegionMax(ImGui_Context* ctx, double* xOut, double* yOut)
Description:Content boundaries max (roughly (0,0)+Size-Scroll) where Size can be override with SetNextWindowContentSize(), in window coordinates
| Parameters: |
| ImGui_Context ctx | - | |
| Returnvalues: |
| number x | - | |
| number y | - | - |
^
ImGui_GetWindowContentRegionMinFunctioncall:
C: void ImGui_GetWindowContentRegionMin(ImGui_Context* ctx, double* xOut, double* yOut)
EEL2: extension_api("ImGui_GetWindowContentRegionMin", ImGui_Context ctx, &x, &y)
Lua: number x, number y = reaper.ImGui_GetWindowContentRegionMin(ImGui_Context ctx)
Python: void ImGui_GetWindowContentRegionMin(ImGui_Context* ctx, double* xOut, double* yOut)
Description:Content boundaries min (roughly (0,0)-Scroll), in window coordinates
| Parameters: |
| ImGui_Context ctx | - | |
| Returnvalues: |
| number x | - | |
| number y | - | - |
^
ImGui_GetWindowContentRegionWidthFunctioncall:
C: double ImGui_GetWindowContentRegionWidth(ImGui_Context* ctx)
EEL2: double extension_api("ImGui_GetWindowContentRegionWidth", ImGui_Context ctx)
Lua: number reaper.ImGui_GetWindowContentRegionWidth(ImGui_Context ctx)
Python: double ImGui_GetWindowContentRegionWidth(ImGui_Context* ctx)
Description:Python: Float ImGui_GetWindowContentRegionWidth(ImGui_Context ctx)
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_GetWindowDrawListFunctioncall:
C: ImGui_DrawList* ImGui_GetWindowDrawList(ImGui_Context* ctx)
EEL2: ImGui_DrawList extension_api("ImGui_GetWindowDrawList", ImGui_Context ctx)
Lua: ImGui_DrawList reaper.ImGui_GetWindowDrawList(ImGui_Context ctx)
Python: ImGui_DrawList* ImGui_GetWindowDrawList(ImGui_Context* ctx)
Description:The draw list associated to the current window, to append your own drawing primitives
| Parameters: |
| ImGui_Context ctx | - | |
| Returnvalues: |
| ImGui_DrawList | - | |
^
ImGui_GetWindowHeightFunctioncall:
C: double ImGui_GetWindowHeight(ImGui_Context* ctx)
EEL2: double extension_api("ImGui_GetWindowHeight", ImGui_Context ctx)
Lua: number reaper.ImGui_GetWindowHeight(ImGui_Context ctx)
Python: double ImGui_GetWindowHeight(ImGui_Context* ctx)
Description:Get current window height (shortcut for ({ImGui_GetWindowSize()})[2])
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_GetWindowPosFunctioncall:
C: void ImGui_GetWindowPos(ImGui_Context* ctx, double* xOut, double* yOut)
EEL2: extension_api("ImGui_GetWindowPos", ImGui_Context ctx, &x, &y)
Lua: number x, number y = reaper.ImGui_GetWindowPos(ImGui_Context ctx)
Python: void ImGui_GetWindowPos(ImGui_Context* ctx, double* xOut, double* yOut)
Description:Get current window position in screen space (useful if you want to do your own drawing via the DrawList API)
| Parameters: |
| ImGui_Context ctx | - | |
| Returnvalues: |
| number x | - | |
| number y | - | - |
^
ImGui_GetWindowSizeFunctioncall:
C: void ImGui_GetWindowSize(ImGui_Context* ctx, double* wOut, double* hOut)
EEL2: extension_api("ImGui_GetWindowSize", ImGui_Context ctx, &w, &h)
Lua: number w, number h = reaper.ImGui_GetWindowSize(ImGui_Context ctx)
Python: void ImGui_GetWindowSize(ImGui_Context* ctx, double* wOut, double* hOut)
Description:Get current window size
| Parameters: |
| ImGui_Context ctx | - | |
| Returnvalues: |
| number w | - | |
| number h | - | - |
^
ImGui_GetWindowWidthFunctioncall:
C: double ImGui_GetWindowWidth(ImGui_Context* ctx)
EEL2: double extension_api("ImGui_GetWindowWidth", ImGui_Context ctx)
Lua: number reaper.ImGui_GetWindowWidth(ImGui_Context ctx)
Python: double ImGui_GetWindowWidth(ImGui_Context* ctx)
Description:Get current window width (shortcut for ({ImGui_GetWindowSize()})[1])
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_HoveredFlags_AllowWhenBlockedByActiveItemFunctioncall:
C: int ImGui_HoveredFlags_AllowWhenBlockedByActiveItem()
EEL2: int extension_api("ImGui_HoveredFlags_AllowWhenBlockedByActiveItem")
Lua: integer reaper.ImGui_HoveredFlags_AllowWhenBlockedByActiveItem()
Python: int ImGui_HoveredFlags_AllowWhenBlockedByActiveItem()
Description:Return true even if an active item is blocking access to this item/window. Useful for Drag and Drop patterns.
^
ImGui_HoveredFlags_AllowWhenBlockedByPopupFunctioncall:
C: int ImGui_HoveredFlags_AllowWhenBlockedByPopup()
EEL2: int extension_api("ImGui_HoveredFlags_AllowWhenBlockedByPopup")
Lua: integer reaper.ImGui_HoveredFlags_AllowWhenBlockedByPopup()
Python: int ImGui_HoveredFlags_AllowWhenBlockedByPopup()
Description:Return true even if a popup window is normally blocking access to this item/window
^
ImGui_HoveredFlags_AllowWhenDisabledFunctioncall:
C: int ImGui_HoveredFlags_AllowWhenDisabled()
EEL2: int extension_api("ImGui_HoveredFlags_AllowWhenDisabled")
Lua: integer reaper.ImGui_HoveredFlags_AllowWhenDisabled()
Python: int ImGui_HoveredFlags_AllowWhenDisabled()
Description:Return true even if the item is disabled
^
ImGui_HoveredFlags_AllowWhenOverlappedFunctioncall:
C: int ImGui_HoveredFlags_AllowWhenOverlapped()
EEL2: int extension_api("ImGui_HoveredFlags_AllowWhenOverlapped")
Lua: integer reaper.ImGui_HoveredFlags_AllowWhenOverlapped()
Python: int ImGui_HoveredFlags_AllowWhenOverlapped()
Description:Return true even if the position is obstructed or overlapped by another window
^
ImGui_HoveredFlags_AnyWindowFunctioncall:
C: int ImGui_HoveredFlags_AnyWindow()
EEL2: int extension_api("ImGui_HoveredFlags_AnyWindow")
Lua: integer reaper.ImGui_HoveredFlags_AnyWindow()
Python: int ImGui_HoveredFlags_AnyWindow()
Description:IsWindowHovered() only: Return true if any window is hovered
^
ImGui_HoveredFlags_ChildWindowsFunctioncall:
C: int ImGui_HoveredFlags_ChildWindows()
EEL2: int extension_api("ImGui_HoveredFlags_ChildWindows")
Lua: integer reaper.ImGui_HoveredFlags_ChildWindows()
Python: int ImGui_HoveredFlags_ChildWindows()
Description:IsWindowHovered() only: Return true if any children of the window is hovered
^
ImGui_HoveredFlags_NoneFunctioncall:
C: int ImGui_HoveredFlags_None()
EEL2: int extension_api("ImGui_HoveredFlags_None")
Lua: integer reaper.ImGui_HoveredFlags_None()
Python: int ImGui_HoveredFlags_None()
Description:Return true if directly over the item/window, not obstructed by another window, not obstructed by an active popup or modal blocking inputs under them.
^
ImGui_HoveredFlags_RectOnlyFunctioncall:
C: int ImGui_HoveredFlags_RectOnly()
EEL2: int extension_api("ImGui_HoveredFlags_RectOnly")
Lua: integer reaper.ImGui_HoveredFlags_RectOnly()
Python: int ImGui_HoveredFlags_RectOnly()
Description:ImGui_HoveredFlags_AllowWhenBlockedByPopup | ImGui_HoveredFlags_AllowWhenBlockedByActiveItem | ImGui_HoveredFlags_AllowWhenOverlapped
^
ImGui_HoveredFlags_RootAndChildWindowsFunctioncall:
C: int ImGui_HoveredFlags_RootAndChildWindows()
EEL2: int extension_api("ImGui_HoveredFlags_RootAndChildWindows")
Lua: integer reaper.ImGui_HoveredFlags_RootAndChildWindows()
Python: int ImGui_HoveredFlags_RootAndChildWindows()
Description:ImGui_HoveredFlags_RootWindow | ImGui_HoveredFlags_ChildWindows
^
ImGui_HoveredFlags_RootWindowFunctioncall:
C: int ImGui_HoveredFlags_RootWindow()
EEL2: int extension_api("ImGui_HoveredFlags_RootWindow")
Lua: integer reaper.ImGui_HoveredFlags_RootWindow()
Python: int ImGui_HoveredFlags_RootWindow()
Description:IsWindowHovered() only: Test from root window (top most parent of the current hierarchy)
^
ImGui_IndentFunctioncall:
C: void ImGui_Indent(ImGui_Context* ctx, double* indent_wInOptional)
EEL2: extension_api("ImGui_Indent", ImGui_Context ctx, optional indent_wIn)
Lua: reaper.ImGui_Indent(ImGui_Context ctx, optional number indent_wIn)
Python: void ImGui_Indent(ImGui_Context* ctx, double* indent_wInOptional)
Description:Default values: indent_w = 0.0
| Parameters: |
| ImGui_Context ctx | - | |
| optional number indent_wIn | - | |
^
ImGui_InputDoubleFunctioncall:
C: bool ImGui_InputDouble(ImGui_Context* ctx, const char* label, double* vInOut, double* stepInOptional, double* step_fastInOptional, const char* formatInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_InputDouble", ImGui_Context ctx, "label", &v, optional stepIn, optional step_fastIn, optional "formatIn", optional int flagsIn)
Lua: boolean retval, number v = reaper.ImGui_InputDouble(ImGui_Context ctx, string label, number v, optional number stepIn, optional number step_fastIn, optional string formatIn, optional number flagsIn)
Python: bool ImGui_InputDouble(ImGui_Context* ctx, const char* label, double* vInOut, double* stepInOptional, double* step_fastInOptional, const char* formatInOptional, int* flagsInOptional)
Description:Default values: step = 0.0, step_fast = 0.0, format = '%.3f', flags = ImGui_InputTextFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number v | - | |
| optional number stepIn | - | |
| optional number step_fastIn | - | |
| optional string formatIn | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number v | - | - |
^
ImGui_InputDouble2Functioncall:
C: bool ImGui_InputDouble2(ImGui_Context* ctx, const char* label, double* v1InOut, double* v2InOut, const char* formatInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_InputDouble2", ImGui_Context ctx, "label", &v1, &v2, optional "formatIn", optional int flagsIn)
Lua: boolean retval, number v1, number v2 = reaper.ImGui_InputDouble2(ImGui_Context ctx, string label, number v1, number v2, optional string formatIn, optional number flagsIn)
Python: bool ImGui_InputDouble2(ImGui_Context* ctx, const char* label, double* v1InOut, double* v2InOut, const char* formatInOptional, int* flagsInOptional)
Description:Default values: format = '%.3f', flags = ImGui_InputTextFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number v1 | - | |
| number v2 | - | |
| optional string formatIn | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number v1 | - | |
| number v2 | - | - |
^
ImGui_InputDouble3Functioncall:
C: bool ImGui_InputDouble3(ImGui_Context* ctx, const char* label, double* v1InOut, double* v2InOut, double* v3InOut, const char* formatInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_InputDouble3", ImGui_Context ctx, "label", &v1, &v2, &v3, optional "formatIn", optional int flagsIn)
Lua: boolean retval, number v1, number v2, number v3 = reaper.ImGui_InputDouble3(ImGui_Context ctx, string label, number v1, number v2, number v3, optional string formatIn, optional number flagsIn)
Python: bool ImGui_InputDouble3(ImGui_Context* ctx, const char* label, double* v1InOut, double* v2InOut, double* v3InOut, const char* formatInOptional, int* flagsInOptional)
Description:Default values: format = '%.3f', flags = ImGui_InputTextFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number v1 | - | |
| number v2 | - | |
| number v3 | - | |
| optional string formatIn | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number v1 | - | |
| number v2 | - | |
| number v3 | - | - |
^
ImGui_InputDouble4Functioncall:
C: bool ImGui_InputDouble4(ImGui_Context* ctx, const char* label, double* v1InOut, double* v2InOut, double* v3InOut, double* v4InOut, const char* formatInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_InputDouble4", ImGui_Context ctx, "label", &v1, &v2, &v3, &v4, optional "formatIn", optional int flagsIn)
Lua: boolean retval, number v1, number v2, number v3, number v4 = reaper.ImGui_InputDouble4(ImGui_Context ctx, string label, number v1, number v2, number v3, number v4, optional string formatIn, optional number flagsIn)
Python: bool ImGui_InputDouble4(ImGui_Context* ctx, const char* label, double* v1InOut, double* v2InOut, double* v3InOut, double* v4InOut, const char* formatInOptional, int* flagsInOptional)
Description:Default values: format = '%.3f', flags = ImGui_InputTextFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number v1 | - | |
| number v2 | - | |
| number v3 | - | |
| number v4 | - | |
| optional string formatIn | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number v1 | - | |
| number v2 | - | |
| number v3 | - | |
| number v4 | - | - |
^
ImGui_InputDoubleNFunctioncall:
C: bool ImGui_InputDoubleN(ImGui_Context* ctx, const char* label, reaper_array* values, double* stepInOptional, double* step_fastInOptional, const char* formatInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_InputDoubleN", ImGui_Context ctx, "label", reaper_array values, optional stepIn, optional step_fastIn, optional "formatIn", optional int flagsIn)
Lua: boolean reaper.ImGui_InputDoubleN(ImGui_Context ctx, string labelreaper_array values, optional number stepIn, optional number step_fastIn, optional string formatIn, optional number flagsIn)
Python: bool ImGui_InputDoubleN(ImGui_Context* ctx, const char* label, reaper_array* values, double* stepInOptional, double* step_fastInOptional, const char* formatInOptional, int* flagsInOptional)
Description:Default values: step = nil, format = nil, step_fast = nil, format = '%.3f', flags = ImGui_InputTextFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string labelreaper_array values | - | |
| optional number stepIn | - | |
| optional number step_fastIn | - | |
| optional string formatIn | - | |
| optional number flagsIn | - | |
^
ImGui_InputIntFunctioncall:
C: bool ImGui_InputInt(ImGui_Context* ctx, const char* label, int* vInOut, int* stepInOptional, int* step_fastInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_InputInt", ImGui_Context ctx, "label", int &v, optional int stepIn, optional int step_fastIn, optional int flagsIn)
Lua: boolean retval, number v = reaper.ImGui_InputInt(ImGui_Context ctx, string label, number v, optional number stepIn, optional number step_fastIn, optional number flagsIn)
Python: bool ImGui_InputInt(ImGui_Context* ctx, const char* label, int* vInOut, int* stepInOptional, int* step_fastInOptional, int* flagsInOptional)
Description:Default values: step = 1, step_fast = 100, flags = ImGui_InputTextFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number v | - | |
| optional number stepIn | - | |
| optional number step_fastIn | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number v | - | - |
^
ImGui_InputInt2Functioncall:
C: bool ImGui_InputInt2(ImGui_Context* ctx, const char* label, int* v1InOut, int* v2InOut, int* flagsInOptional)
EEL2: bool extension_api("ImGui_InputInt2", ImGui_Context ctx, "label", int &v1, int &v2, optional int flagsIn)
Lua: boolean retval, number v1, number v2 = reaper.ImGui_InputInt2(ImGui_Context ctx, string label, number v1, number v2, optional number flagsIn)
Python: bool ImGui_InputInt2(ImGui_Context* ctx, const char* label, int* v1InOut, int* v2InOut, int* flagsInOptional)
Description:Default values: flags = ImGui_InputTextFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number v1 | - | |
| number v2 | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number v1 | - | |
| number v2 | - | - |
^
ImGui_InputInt3Functioncall:
C: bool ImGui_InputInt3(ImGui_Context* ctx, const char* label, int* v1InOut, int* v2InOut, int* v3InOut, int* flagsInOptional)
EEL2: bool extension_api("ImGui_InputInt3", ImGui_Context ctx, "label", int &v1, int &v2, int &v3, optional int flagsIn)
Lua: boolean retval, number v1, number v2, number v3 = reaper.ImGui_InputInt3(ImGui_Context ctx, string label, number v1, number v2, number v3, optional number flagsIn)
Python: bool ImGui_InputInt3(ImGui_Context* ctx, const char* label, int* v1InOut, int* v2InOut, int* v3InOut, int* flagsInOptional)
Description:Default values: flags = ImGui_InputTextFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number v1 | - | |
| number v2 | - | |
| number v3 | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number v1 | - | |
| number v2 | - | |
| number v3 | - | - |
^
ImGui_InputInt4Functioncall:
C: bool ImGui_InputInt4(ImGui_Context* ctx, const char* label, int* v1InOut, int* v2InOut, int* v3InOut, int* v4InOut, int* flagsInOptional)
EEL2: bool extension_api("ImGui_InputInt4", ImGui_Context ctx, "label", int &v1, int &v2, int &v3, int &v4, optional int flagsIn)
Lua: boolean retval, number v1, number v2, number v3, number v4 = reaper.ImGui_InputInt4(ImGui_Context ctx, string label, number v1, number v2, number v3, number v4, optional number flagsIn)
Python: bool ImGui_InputInt4(ImGui_Context* ctx, const char* label, int* v1InOut, int* v2InOut, int* v3InOut, int* v4InOut, int* flagsInOptional)
Description:Default values: flags = ImGui_InputTextFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number v1 | - | |
| number v2 | - | |
| number v3 | - | |
| number v4 | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number v1 | - | |
| number v2 | - | |
| number v3 | - | |
| number v4 | - | - |
^
ImGui_InputTextFunctioncall:
C: bool ImGui_InputText(ImGui_Context* ctx, const char* label, char* bufInOutNeedBig, int bufInOutNeedBig_sz, int* flagsInOptional)
EEL2: bool extension_api("ImGui_InputText", ImGui_Context ctx, "label", #buf, optional int flagsIn)
Lua: boolean retval, string buf = reaper.ImGui_InputText(ImGui_Context ctx, string label, string buf, optional number flagsIn)
Python: bool ImGui_InputText(ImGui_Context* ctx, const char* label, char* bufInOutNeedBig, int bufInOutNeedBig_sz, int* flagsInOptional)
Description:Default values: flags = ImGui_InputTextFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| string buf | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| string buf | - | - |
^
ImGui_InputTextFlags_AllowTabInputFunctioncall:
C: int ImGui_InputTextFlags_AllowTabInput()
EEL2: int extension_api("ImGui_InputTextFlags_AllowTabInput")
Lua: integer reaper.ImGui_InputTextFlags_AllowTabInput()
Python: int ImGui_InputTextFlags_AllowTabInput()
Description:Pressing TAB input a '\t' character into the text field
^
ImGui_InputTextFlags_AlwaysOverwriteFunctioncall:
C: int ImGui_InputTextFlags_AlwaysOverwrite()
EEL2: int extension_api("ImGui_InputTextFlags_AlwaysOverwrite")
Lua: integer reaper.ImGui_InputTextFlags_AlwaysOverwrite()
Python: int ImGui_InputTextFlags_AlwaysOverwrite()
Description:Overwrite mode
^
ImGui_InputTextFlags_AutoSelectAllFunctioncall:
C: int ImGui_InputTextFlags_AutoSelectAll()
EEL2: int extension_api("ImGui_InputTextFlags_AutoSelectAll")
Lua: integer reaper.ImGui_InputTextFlags_AutoSelectAll()
Python: int ImGui_InputTextFlags_AutoSelectAll()
Description:Select entire text when first taking mouse focus
^
ImGui_InputTextFlags_CharsDecimalFunctioncall:
C: int ImGui_InputTextFlags_CharsDecimal()
EEL2: int extension_api("ImGui_InputTextFlags_CharsDecimal")
Lua: integer reaper.ImGui_InputTextFlags_CharsDecimal()
Python: int ImGui_InputTextFlags_CharsDecimal()
Description:Allow 0123456789.+-*/
^
ImGui_InputTextFlags_CharsHexadecimalFunctioncall:
C: int ImGui_InputTextFlags_CharsHexadecimal()
EEL2: int extension_api("ImGui_InputTextFlags_CharsHexadecimal")
Lua: integer reaper.ImGui_InputTextFlags_CharsHexadecimal()
Python: int ImGui_InputTextFlags_CharsHexadecimal()
Description:Allow 0123456789ABCDEFabcdef
^
ImGui_InputTextFlags_CharsNoBlankFunctioncall:
C: int ImGui_InputTextFlags_CharsNoBlank()
EEL2: int extension_api("ImGui_InputTextFlags_CharsNoBlank")
Lua: integer reaper.ImGui_InputTextFlags_CharsNoBlank()
Python: int ImGui_InputTextFlags_CharsNoBlank()
Description:Filter out spaces, tabs
^
ImGui_InputTextFlags_CharsScientificFunctioncall:
C: int ImGui_InputTextFlags_CharsScientific()
EEL2: int extension_api("ImGui_InputTextFlags_CharsScientific")
Lua: integer reaper.ImGui_InputTextFlags_CharsScientific()
Python: int ImGui_InputTextFlags_CharsScientific()
Description:Allow 0123456789.+-*/eE (Scientific notation input)
^
ImGui_InputTextFlags_CharsUppercaseFunctioncall:
C: int ImGui_InputTextFlags_CharsUppercase()
EEL2: int extension_api("ImGui_InputTextFlags_CharsUppercase")
Lua: integer reaper.ImGui_InputTextFlags_CharsUppercase()
Python: int ImGui_InputTextFlags_CharsUppercase()
Description:Turn a..z into A..Z
^
ImGui_InputTextFlags_CtrlEnterForNewLineFunctioncall:
C: int ImGui_InputTextFlags_CtrlEnterForNewLine()
EEL2: int extension_api("ImGui_InputTextFlags_CtrlEnterForNewLine")
Lua: integer reaper.ImGui_InputTextFlags_CtrlEnterForNewLine()
Python: int ImGui_InputTextFlags_CtrlEnterForNewLine()
Description:In multi-line mode, unfocus with Enter, add new line with Ctrl+Enter (default is opposite: unfocus with Ctrl+Enter, add line with Enter).
^
ImGui_InputTextFlags_EnterReturnsTrueFunctioncall:
C: int ImGui_InputTextFlags_EnterReturnsTrue()
EEL2: int extension_api("ImGui_InputTextFlags_EnterReturnsTrue")
Lua: integer reaper.ImGui_InputTextFlags_EnterReturnsTrue()
Python: int ImGui_InputTextFlags_EnterReturnsTrue()
Description:Return 'true' when Enter is pressed (as opposed to every time the value was modified). Consider looking at the IsItemDeactivatedAfterEdit() function.
^
ImGui_InputTextFlags_NoHorizontalScrollFunctioncall:
C: int ImGui_InputTextFlags_NoHorizontalScroll()
EEL2: int extension_api("ImGui_InputTextFlags_NoHorizontalScroll")
Lua: integer reaper.ImGui_InputTextFlags_NoHorizontalScroll()
Python: int ImGui_InputTextFlags_NoHorizontalScroll()
Description:Disable following the cursor horizontally
^
ImGui_InputTextFlags_NoUndoRedoFunctioncall:
C: int ImGui_InputTextFlags_NoUndoRedo()
EEL2: int extension_api("ImGui_InputTextFlags_NoUndoRedo")
Lua: integer reaper.ImGui_InputTextFlags_NoUndoRedo()
Python: int ImGui_InputTextFlags_NoUndoRedo()
Description:Disable undo/redo. Note that input text owns the text data while active, if you want to provide your own undo/redo stack you need e.g. to call ClearActiveID().
^
ImGui_InputTextFlags_NoneFunctioncall:
C: int ImGui_InputTextFlags_None()
EEL2: int extension_api("ImGui_InputTextFlags_None")
Lua: integer reaper.ImGui_InputTextFlags_None()
Python: int ImGui_InputTextFlags_None()
Description:Most of the ImGuiInputTextFlags flags are only useful for InputText() and not for InputFloatX, InputIntX, InputDouble etc.
^
ImGui_InputTextFlags_PasswordFunctioncall:
C: int ImGui_InputTextFlags_Password()
EEL2: int extension_api("ImGui_InputTextFlags_Password")
Lua: integer reaper.ImGui_InputTextFlags_Password()
Python: int ImGui_InputTextFlags_Password()
Description:Password mode, display all characters as '*'
^
ImGui_InputTextFlags_ReadOnlyFunctioncall:
C: int ImGui_InputTextFlags_ReadOnly()
EEL2: int extension_api("ImGui_InputTextFlags_ReadOnly")
Lua: integer reaper.ImGui_InputTextFlags_ReadOnly()
Python: int ImGui_InputTextFlags_ReadOnly()
Description:Read-only mode
^
ImGui_InputTextMultilineFunctioncall:
C: bool ImGui_InputTextMultiline(ImGui_Context* ctx, const char* label, char* bufInOutNeedBig, int bufInOutNeedBig_sz, double* widthInOptional, double* heightInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_InputTextMultiline", ImGui_Context ctx, "label", #buf, optional widthIn, optional heightIn, optional int flagsIn)
Lua: boolean retval, string buf = reaper.ImGui_InputTextMultiline(ImGui_Context ctx, string label, string buf, optional number widthIn, optional number heightIn, optional number flagsIn)
Python: bool ImGui_InputTextMultiline(ImGui_Context* ctx, const char* label, char* bufInOutNeedBig, int bufInOutNeedBig_sz, double* widthInOptional, double* heightInOptional, int* flagsInOptional)
Description:Default values: width = 0.0, height = 0.0, flags = ImGui_InputTextFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| string buf | - | |
| optional number widthIn | - | |
| optional number heightIn | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| string buf | - | - |
^
ImGui_InputTextWithHintFunctioncall:
C: bool ImGui_InputTextWithHint(ImGui_Context* ctx, const char* label, const char* hint, char* bufInOutNeedBig, int bufInOutNeedBig_sz, int* flagsInOptional)
EEL2: bool extension_api("ImGui_InputTextWithHint", ImGui_Context ctx, "label", "hint", #buf, optional int flagsIn)
Lua: boolean retval, string buf = reaper.ImGui_InputTextWithHint(ImGui_Context ctx, string label, string hint, string buf, optional number flagsIn)
Python: bool ImGui_InputTextWithHint(ImGui_Context* ctx, const char* label, const char* hint, char* bufInOutNeedBig, int bufInOutNeedBig_sz, int* flagsInOptional)
Description:Default values: flags = ImGui_InputTextFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| string hint | - | |
| string buf | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| string buf | - | - |
^
ImGui_InvisibleButtonFunctioncall:
C: bool ImGui_InvisibleButton(ImGui_Context* ctx, const char* str_id, double size_w, double size_h, int* flagsInOptional)
EEL2: bool extension_api("ImGui_InvisibleButton", ImGui_Context ctx, "str_id", size_w, size_h, optional int flagsIn)
Lua: boolean reaper.ImGui_InvisibleButton(ImGui_Context ctx, string str_id, number size_w, number size_h, optional number flagsIn)
Python: bool ImGui_InvisibleButton(ImGui_Context* ctx, const char* str_id, double size_w, double size_h, int* flagsInOptional)
Description:Default values: flags = ImGui_ButtonFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string str_id | - | |
| number size_w | - | |
| number size_h | - | |
| optional number flagsIn | - | |
^
ImGui_IsAnyItemActiveFunctioncall:
C: bool ImGui_IsAnyItemActive(ImGui_Context* ctx)
EEL2: bool extension_api("ImGui_IsAnyItemActive", ImGui_Context ctx)
Lua: boolean reaper.ImGui_IsAnyItemActive(ImGui_Context ctx)
Python: bool ImGui_IsAnyItemActive(ImGui_Context* ctx)
Description:is any item active?
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_IsAnyItemFocusedFunctioncall:
C: bool ImGui_IsAnyItemFocused(ImGui_Context* ctx)
EEL2: bool extension_api("ImGui_IsAnyItemFocused", ImGui_Context ctx)
Lua: boolean reaper.ImGui_IsAnyItemFocused(ImGui_Context ctx)
Python: bool ImGui_IsAnyItemFocused(ImGui_Context* ctx)
Description:is any item focused?
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_IsAnyItemHoveredFunctioncall:
C: bool ImGui_IsAnyItemHovered(ImGui_Context* ctx)
EEL2: bool extension_api("ImGui_IsAnyItemHovered", ImGui_Context ctx)
Lua: boolean reaper.ImGui_IsAnyItemHovered(ImGui_Context ctx)
Python: bool ImGui_IsAnyItemHovered(ImGui_Context* ctx)
Description:is any item hovered?
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_IsAnyMouseDownFunctioncall:
C: bool ImGui_IsAnyMouseDown(ImGui_Context* ctx)
EEL2: bool extension_api("ImGui_IsAnyMouseDown", ImGui_Context ctx)
Lua: boolean reaper.ImGui_IsAnyMouseDown(ImGui_Context ctx)
Python: bool ImGui_IsAnyMouseDown(ImGui_Context* ctx)
Description:Is any mouse button held?
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_IsCloseRequestedFunctioncall:
C: bool ImGui_IsCloseRequested(ImGui_Context* ctx)
EEL2: bool extension_api("ImGui_IsCloseRequested", ImGui_Context ctx)
Lua: boolean reaper.ImGui_IsCloseRequested(ImGui_Context ctx)
Python: bool ImGui_IsCloseRequested(ImGui_Context* ctx)
Description:Return whether the user has requested closing the context since the previous frame.
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_IsItemActivatedFunctioncall:
C: bool ImGui_IsItemActivated(ImGui_Context* ctx)
EEL2: bool extension_api("ImGui_IsItemActivated", ImGui_Context ctx)
Lua: boolean reaper.ImGui_IsItemActivated(ImGui_Context ctx)
Python: bool ImGui_IsItemActivated(ImGui_Context* ctx)
Description:Was the last item just made active (item was previously inactive).
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_IsItemActiveFunctioncall:
C: bool ImGui_IsItemActive(ImGui_Context* ctx)
EEL2: bool extension_api("ImGui_IsItemActive", ImGui_Context ctx)
Lua: boolean reaper.ImGui_IsItemActive(ImGui_Context ctx)
Python: bool ImGui_IsItemActive(ImGui_Context* ctx)
Description:Is the last item active? (e.g. button being held, text field being edited. This will continuously return true while holding mouse button on an item. Items that don't interact will always return false)
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_IsItemClickedFunctioncall:
C: bool ImGui_IsItemClicked(ImGui_Context* ctx, int* mouse_buttonInOptional)
EEL2: bool extension_api("ImGui_IsItemClicked", ImGui_Context ctx, optional int mouse_buttonIn)
Lua: boolean reaper.ImGui_IsItemClicked(ImGui_Context ctx, optional number mouse_buttonIn)
Python: bool ImGui_IsItemClicked(ImGui_Context* ctx, int* mouse_buttonInOptional)
Description:Default values: mouse_button = ImGui_MouseButton_Left
| Parameters: |
| ImGui_Context ctx | - | |
| optional number mouse_buttonIn | - | |
^
ImGui_IsItemDeactivatedFunctioncall:
C: bool ImGui_IsItemDeactivated(ImGui_Context* ctx)
EEL2: bool extension_api("ImGui_IsItemDeactivated", ImGui_Context ctx)
Lua: boolean reaper.ImGui_IsItemDeactivated(ImGui_Context ctx)
Python: bool ImGui_IsItemDeactivated(ImGui_Context* ctx)
Description:Was the last item just made inactive (item was previously active). Useful for Undo/Redo patterns with widgets that requires continuous editing.
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_IsItemDeactivatedAfterEditFunctioncall:
C: bool ImGui_IsItemDeactivatedAfterEdit(ImGui_Context* ctx)
EEL2: bool extension_api("ImGui_IsItemDeactivatedAfterEdit", ImGui_Context ctx)
Lua: boolean reaper.ImGui_IsItemDeactivatedAfterEdit(ImGui_Context ctx)
Python: bool ImGui_IsItemDeactivatedAfterEdit(ImGui_Context* ctx)
Description:Was the last item just made inactive and made a value change when it was active? (e.g. Slider/Drag moved). Useful for Undo/Redo patterns with widgets that requires continuous editing. Note that you may get false positives (some widgets such as Combo()/ListBox()/Selectable() will return true even when clicking an already selected item).
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_IsItemEditedFunctioncall:
C: bool ImGui_IsItemEdited(ImGui_Context* ctx)
EEL2: bool extension_api("ImGui_IsItemEdited", ImGui_Context ctx)
Lua: boolean reaper.ImGui_IsItemEdited(ImGui_Context ctx)
Python: bool ImGui_IsItemEdited(ImGui_Context* ctx)
Description:Did the last item modify its underlying value this frame? or was pressed? This is generally the same as the "bool" return value of many widgets.
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_IsItemFocusedFunctioncall:
C: bool ImGui_IsItemFocused(ImGui_Context* ctx)
EEL2: bool extension_api("ImGui_IsItemFocused", ImGui_Context ctx)
Lua: boolean reaper.ImGui_IsItemFocused(ImGui_Context ctx)
Python: bool ImGui_IsItemFocused(ImGui_Context* ctx)
Description:Is the last item focused for keyboard/gamepad navigation?
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_IsItemHoveredFunctioncall:
C: bool ImGui_IsItemHovered(ImGui_Context* ctx, int* flagsInOptional)
EEL2: bool extension_api("ImGui_IsItemHovered", ImGui_Context ctx, optional int flagsIn)
Lua: boolean reaper.ImGui_IsItemHovered(ImGui_Context ctx, optional number flagsIn)
Python: bool ImGui_IsItemHovered(ImGui_Context* ctx, int* flagsInOptional)
Description:Default values: flags = ImGui_HoveredFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| optional number flagsIn | - | |
^
ImGui_IsItemToggledOpenFunctioncall:
C: bool ImGui_IsItemToggledOpen(ImGui_Context* ctx)
EEL2: bool extension_api("ImGui_IsItemToggledOpen", ImGui_Context ctx)
Lua: boolean reaper.ImGui_IsItemToggledOpen(ImGui_Context ctx)
Python: bool ImGui_IsItemToggledOpen(ImGui_Context* ctx)
Description:Was the last item open state toggled? Set by TreeNode().
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_IsItemVisibleFunctioncall:
C: bool ImGui_IsItemVisible(ImGui_Context* ctx)
EEL2: bool extension_api("ImGui_IsItemVisible", ImGui_Context ctx)
Lua: boolean reaper.ImGui_IsItemVisible(ImGui_Context ctx)
Python: bool ImGui_IsItemVisible(ImGui_Context* ctx)
Description:Is the last item visible? (items may be out of sight because of clipping/scrolling)
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_IsKeyDownFunctioncall:
C: bool ImGui_IsKeyDown(ImGui_Context* ctx, int key_code)
EEL2: bool extension_api("ImGui_IsKeyDown", ImGui_Context ctx, int key_code)
Lua: boolean reaper.ImGui_IsKeyDown(ImGui_Context ctx, integer key_code)
Python: bool ImGui_IsKeyDown(ImGui_Context* ctx, int key_code)
Description:Is key being held.
| Parameters: |
| ImGui_Context ctx | - | |
| integer key_code | - | |
^
ImGui_IsKeyPressedFunctioncall:
C: bool ImGui_IsKeyPressed(ImGui_Context* ctx, int key_code, bool* repeatInOptional)
EEL2: bool extension_api("ImGui_IsKeyPressed", ImGui_Context ctx, int key_code, optional bool repeatIn)
Lua: boolean reaper.ImGui_IsKeyPressed(ImGui_Context ctx, integer key_code, optional boolean repeatIn)
Python: bool ImGui_IsKeyPressed(ImGui_Context* ctx, int key_code, bool* repeatInOptional)
Description:Default values: repeat = true
| Parameters: |
| ImGui_Context ctx | - | |
| integer key_code | - | |
| optional boolean repeatIn | - | |
^
ImGui_IsKeyReleasedFunctioncall:
C: bool ImGui_IsKeyReleased(ImGui_Context* ctx, int key_code)
EEL2: bool extension_api("ImGui_IsKeyReleased", ImGui_Context ctx, int key_code)
Lua: boolean reaper.ImGui_IsKeyReleased(ImGui_Context ctx, integer key_code)
Python: bool ImGui_IsKeyReleased(ImGui_Context* ctx, int key_code)
Description:Was key released (went from Down to !Down)?
| Parameters: |
| ImGui_Context ctx | - | |
| integer key_code | - | |
^
ImGui_IsMouseClickedFunctioncall:
C: bool ImGui_IsMouseClicked(ImGui_Context* ctx, int button, bool* repeatInOptional)
EEL2: bool extension_api("ImGui_IsMouseClicked", ImGui_Context ctx, int button, optional bool repeatIn)
Lua: boolean reaper.ImGui_IsMouseClicked(ImGui_Context ctx, integer button, optional boolean repeatIn)
Python: bool ImGui_IsMouseClicked(ImGui_Context* ctx, int button, bool* repeatInOptional)
Description:Default values: repeat = false
| Parameters: |
| ImGui_Context ctx | - | |
| integer button | - | |
| optional boolean repeatIn | - | |
^
ImGui_IsMouseDoubleClickedFunctioncall:
C: bool ImGui_IsMouseDoubleClicked(ImGui_Context* ctx, int button)
EEL2: bool extension_api("ImGui_IsMouseDoubleClicked", ImGui_Context ctx, int button)
Lua: boolean reaper.ImGui_IsMouseDoubleClicked(ImGui_Context ctx, integer button)
Python: bool ImGui_IsMouseDoubleClicked(ImGui_Context* ctx, int button)
Description:Did mouse button double-clicked? (note that a double-click will also report IsMouseClicked() == true)
| Parameters: |
| ImGui_Context ctx | - | |
| integer button | - | |
^
ImGui_IsMouseDownFunctioncall:
C: bool ImGui_IsMouseDown(ImGui_Context* ctx, int button)
EEL2: bool extension_api("ImGui_IsMouseDown", ImGui_Context ctx, int button)
Lua: boolean reaper.ImGui_IsMouseDown(ImGui_Context ctx, integer button)
Python: bool ImGui_IsMouseDown(ImGui_Context* ctx, int button)
Description:Is mouse button held?
| Parameters: |
| ImGui_Context ctx | - | |
| integer button | - | |
^
ImGui_IsMouseDraggingFunctioncall:
C: bool ImGui_IsMouseDragging(ImGui_Context* ctx, int button, double* lock_thresholdInOptional)
EEL2: bool extension_api("ImGui_IsMouseDragging", ImGui_Context ctx, int button, optional lock_thresholdIn)
Lua: boolean reaper.ImGui_IsMouseDragging(ImGui_Context ctx, integer button, optional number lock_thresholdIn)
Python: bool ImGui_IsMouseDragging(ImGui_Context* ctx, int button, double* lock_thresholdInOptional)
Description:Default values: lock_threshold = -1.0
| Parameters: |
| ImGui_Context ctx | - | |
| integer button | - | |
| optional number lock_thresholdIn | - | |
^
ImGui_IsMouseHoveringRectFunctioncall:
C: bool ImGui_IsMouseHoveringRect(ImGui_Context* ctx, double r_min_x, double r_min_y, double r_max_x, double r_max_y, bool* clipInOptional)
EEL2: bool extension_api("ImGui_IsMouseHoveringRect", ImGui_Context ctx, r_min_x, r_min_y, r_max_x, r_max_y, optional bool clipIn)
Lua: boolean reaper.ImGui_IsMouseHoveringRect(ImGui_Context ctx, number r_min_x, number r_min_y, number r_max_x, number r_max_y, optional boolean clipIn)
Python: bool ImGui_IsMouseHoveringRect(ImGui_Context* ctx, double r_min_x, double r_min_y, double r_max_x, double r_max_y, bool* clipInOptional)
Description:Default values: clip = true
| Parameters: |
| ImGui_Context ctx | - | |
| number r_min_x | - | |
| number r_min_y | - | |
| number r_max_x | - | |
| number r_max_y | - | |
| optional boolean clipIn | - | |
^
ImGui_IsMousePosValidFunctioncall:
C: bool ImGui_IsMousePosValid(ImGui_Context* ctx, double* mouse_pos_xInOptional, double* mouse_pos_yInOptional)
EEL2: bool extension_api("ImGui_IsMousePosValid", ImGui_Context ctx, optional mouse_pos_xIn, optional mouse_pos_yIn)
Lua: boolean reaper.ImGui_IsMousePosValid(ImGui_Context ctx, optional number mouse_pos_xIn, optional number mouse_pos_yIn)
Python: bool ImGui_IsMousePosValid(ImGui_Context* ctx, double* mouse_pos_xInOptional, double* mouse_pos_yInOptional)
Description:Default values: mouse_pos_x = nil, mouse_pos_y = nil
| Parameters: |
| ImGui_Context ctx | - | |
| optional number mouse_pos_xIn | - | |
| optional number mouse_pos_yIn | - | |
^
ImGui_IsMouseReleasedFunctioncall:
C: bool ImGui_IsMouseReleased(ImGui_Context* ctx, int button)
EEL2: bool extension_api("ImGui_IsMouseReleased", ImGui_Context ctx, int button)
Lua: boolean reaper.ImGui_IsMouseReleased(ImGui_Context ctx, integer button)
Python: bool ImGui_IsMouseReleased(ImGui_Context* ctx, int button)
Description:Did mouse button released? (went from Down to !Down)
| Parameters: |
| ImGui_Context ctx | - | |
| integer button | - | |
^
ImGui_IsPopupOpenFunctioncall:
C: bool ImGui_IsPopupOpen(ImGui_Context* ctx, const char* str_id, int* flagsInOptional)
EEL2: bool extension_api("ImGui_IsPopupOpen", ImGui_Context ctx, "str_id", optional int flagsIn)
Lua: boolean reaper.ImGui_IsPopupOpen(ImGui_Context ctx, string str_id, optional number flagsIn)
Python: bool ImGui_IsPopupOpen(ImGui_Context* ctx, const char* str_id, int* flagsInOptional)
Description:Default values: flags = ImGui_PopupFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string str_id | - | |
| optional number flagsIn | - | |
^
ImGui_IsRectVisibleFunctioncall:
C: bool ImGui_IsRectVisible(ImGui_Context* ctx, double size_w, double size_h)
EEL2: bool extension_api("ImGui_IsRectVisible", ImGui_Context ctx, size_w, size_h)
Lua: boolean reaper.ImGui_IsRectVisible(ImGui_Context ctx, number size_w, number size_h)
Python: bool ImGui_IsRectVisible(ImGui_Context* ctx, double size_w, double size_h)
Description:Test if rectangle (of given size, starting from cursor position) is visible / not clipped.
| Parameters: |
| ImGui_Context ctx | - | |
| number size_w | - | |
| number size_h | - | |
^
ImGui_IsRectVisibleExFunctioncall:
C: bool ImGui_IsRectVisibleEx(ImGui_Context* ctx, double rect_min_x, double rect_min_y, double rect_max_x, double rect_max_y)
EEL2: bool extension_api("ImGui_IsRectVisibleEx", ImGui_Context ctx, rect_min_x, rect_min_y, rect_max_x, rect_max_y)
Lua: boolean reaper.ImGui_IsRectVisibleEx(ImGui_Context ctx, number rect_min_x, number rect_min_y, number rect_max_x, number rect_max_y)
Python: bool ImGui_IsRectVisibleEx(ImGui_Context* ctx, double rect_min_x, double rect_min_y, double rect_max_x, double rect_max_y)
Description:Test if rectangle (in screen space) is visible / not clipped. to perform coarse clipping on user's side.
| Parameters: |
| ImGui_Context ctx | - | |
| number rect_min_x | - | |
| number rect_min_y | - | |
| number rect_max_x | - | |
| number rect_max_y | - | |
^
ImGui_IsWindowAppearingFunctioncall:
C: bool ImGui_IsWindowAppearing(ImGui_Context* ctx)
EEL2: bool extension_api("ImGui_IsWindowAppearing", ImGui_Context ctx)
Lua: boolean reaper.ImGui_IsWindowAppearing(ImGui_Context ctx)
Python: bool ImGui_IsWindowAppearing(ImGui_Context* ctx)
Description:Python: Boolean ImGui_IsWindowAppearing(ImGui_Context ctx)
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_IsWindowCollapsedFunctioncall:
C: bool ImGui_IsWindowCollapsed(ImGui_Context* ctx)
EEL2: bool extension_api("ImGui_IsWindowCollapsed", ImGui_Context ctx)
Lua: boolean reaper.ImGui_IsWindowCollapsed(ImGui_Context ctx)
Python: bool ImGui_IsWindowCollapsed(ImGui_Context* ctx)
Description:Python: Boolean ImGui_IsWindowCollapsed(ImGui_Context ctx)
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_IsWindowFocusedFunctioncall:
C: bool ImGui_IsWindowFocused(ImGui_Context* ctx, int* flagsInOptional)
EEL2: bool extension_api("ImGui_IsWindowFocused", ImGui_Context ctx, optional int flagsIn)
Lua: boolean reaper.ImGui_IsWindowFocused(ImGui_Context ctx, optional number flagsIn)
Python: bool ImGui_IsWindowFocused(ImGui_Context* ctx, int* flagsInOptional)
Description:Default values: flags = ImGui_FocusedFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| optional number flagsIn | - | |
^
ImGui_IsWindowHoveredFunctioncall:
C: bool ImGui_IsWindowHovered(ImGui_Context* ctx, int* flagsInOptional)
EEL2: bool extension_api("ImGui_IsWindowHovered", ImGui_Context ctx, optional int flagsIn)
Lua: boolean reaper.ImGui_IsWindowHovered(ImGui_Context ctx, optional number flagsIn)
Python: bool ImGui_IsWindowHovered(ImGui_Context* ctx, int* flagsInOptional)
Description:Default values: flags = ImGui_HoveredFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| optional number flagsIn | - | |
^
ImGui_KeyModFlags_AltFunctioncall:
C: int ImGui_KeyModFlags_Alt()
EEL2: int extension_api("ImGui_KeyModFlags_Alt")
Lua: integer reaper.ImGui_KeyModFlags_Alt()
Python: int ImGui_KeyModFlags_Alt()
Description:Python: Int ImGui_KeyModFlags_Alt()
^
ImGui_KeyModFlags_CtrlFunctioncall:
C: int ImGui_KeyModFlags_Ctrl()
EEL2: int extension_api("ImGui_KeyModFlags_Ctrl")
Lua: integer reaper.ImGui_KeyModFlags_Ctrl()
Python: int ImGui_KeyModFlags_Ctrl()
Description:Python: Int ImGui_KeyModFlags_Ctrl()
^
ImGui_KeyModFlags_NoneFunctioncall:
C: int ImGui_KeyModFlags_None()
EEL2: int extension_api("ImGui_KeyModFlags_None")
Lua: integer reaper.ImGui_KeyModFlags_None()
Python: int ImGui_KeyModFlags_None()
Description:Python: Int ImGui_KeyModFlags_None()
^
ImGui_KeyModFlags_ShiftFunctioncall:
C: int ImGui_KeyModFlags_Shift()
EEL2: int extension_api("ImGui_KeyModFlags_Shift")
Lua: integer reaper.ImGui_KeyModFlags_Shift()
Python: int ImGui_KeyModFlags_Shift()
Description:Python: Int ImGui_KeyModFlags_Shift()
^
ImGui_KeyModFlags_SuperFunctioncall:
C: int ImGui_KeyModFlags_Super()
EEL2: int extension_api("ImGui_KeyModFlags_Super")
Lua: integer reaper.ImGui_KeyModFlags_Super()
Python: int ImGui_KeyModFlags_Super()
Description:Python: Int ImGui_KeyModFlags_Super()
^
ImGui_LabelTextFunctioncall:
C: void ImGui_LabelText(ImGui_Context* ctx, const char* label, const char* text)
EEL2: extension_api("ImGui_LabelText", ImGui_Context ctx, "label", "text")
Lua: reaper.ImGui_LabelText(ImGui_Context ctx, string label, string text)
Python: void ImGui_LabelText(ImGui_Context* ctx, const char* label, const char* text)
Description:Display text+label aligned the same way as value+label widgets
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| string text | - | |
^
ImGui_ListBoxFunctioncall:
C: bool ImGui_ListBox(ImGui_Context* ctx, const char* label, int* current_itemInOut, char* items, int* height_in_itemsInOptional)
EEL2: bool extension_api("ImGui_ListBox", ImGui_Context ctx, "label", int ¤t_item, #items, optional int height_in_itemsIn)
Lua: boolean retval, number current_item, string items = reaper.ImGui_ListBox(ImGui_Context ctx, string label, number current_item, string items, optional number height_in_itemsIn)
Python: bool ImGui_ListBox(ImGui_Context* ctx, const char* label, int* current_itemInOut, char* items, int* height_in_itemsInOptional)
Description:Default values: height_in_items = -1
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number current_item | - | |
| string items | - | |
| optional number height_in_itemsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number current_item | - | |
| string items | - | - |
^
ImGui_ListClipper_BeginFunctioncall:
C: void ImGui_ListClipper_Begin(ImGui_ListClipper* clipper, int items_count, double* items_heightInOptional)
EEL2: extension_api("ImGui_ListClipper_Begin", ImGui_ListClipper clipper, int items_count, optional items_heightIn)
Lua: reaper.ImGui_ListClipper_Begin(ImGui_ListClipper clipper, integer items_count, optional number items_heightIn)
Python: void ImGui_ListClipper_Begin(ImGui_ListClipper* clipper, int items_count, double* items_heightInOptional)
Description:Default values: items_height = -1.0
| Parameters: |
| ImGui_ListClipper clipper | - | |
| integer items_count | - | |
| optional number items_heightIn | - | |
^
ImGui_ListClipper_EndFunctioncall:
C: void ImGui_ListClipper_End(ImGui_ListClipper* clipper)
EEL2: extension_api("ImGui_ListClipper_End", ImGui_ListClipper clipper)
Lua: reaper.ImGui_ListClipper_End(ImGui_ListClipper clipper)
Python: void ImGui_ListClipper_End(ImGui_ListClipper* clipper)
Description:
| Parameters: |
| ImGui_ListClipper clipper | - | |
^
ImGui_ListClipper_GetDisplayRangeFunctioncall:
C: void ImGui_ListClipper_GetDisplayRange(ImGui_ListClipper* clipper, int* display_startOut, int* display_endOut)
EEL2: extension_api("ImGui_ListClipper_GetDisplayRange", ImGui_ListClipper clipper, int &display_start, int &display_end)
Lua: number display_start, number display_end = reaper.ImGui_ListClipper_GetDisplayRange(ImGui_ListClipper clipper)
Python: void ImGui_ListClipper_GetDisplayRange(ImGui_ListClipper* clipper, int* display_startOut, int* display_endOut)
Description:Python: (ImGui_ListClipper clipper, Int display_startOut, Int display_endOut) = ImGui_ListClipper_GetDisplayRange(clipper, display_startOut, display_endOut)
| Parameters: |
| ImGui_ListClipper clipper | - | |
| Returnvalues: |
| number display_start | - | |
| number display_end | - | - |
^
ImGui_ListClipper_StepFunctioncall:
C: bool ImGui_ListClipper_Step(ImGui_ListClipper* clipper)
EEL2: bool extension_api("ImGui_ListClipper_Step", ImGui_ListClipper clipper)
Lua: boolean reaper.ImGui_ListClipper_Step(ImGui_ListClipper clipper)
Python: bool ImGui_ListClipper_Step(ImGui_ListClipper* clipper)
Description:Call until it returns false. The DisplayStart/DisplayEnd fields will be set and you can process/draw those items.
| Parameters: |
| ImGui_ListClipper clipper | - | |
^
ImGui_LogFinishFunctioncall:
C: void ImGui_LogFinish(ImGui_Context* ctx)
EEL2: extension_api("ImGui_LogFinish", ImGui_Context ctx)
Lua: reaper.ImGui_LogFinish(ImGui_Context ctx)
Python: void ImGui_LogFinish(ImGui_Context* ctx)
Description:Stop logging (close file, etc.)
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_LogTextFunctioncall:
C: void ImGui_LogText(ImGui_Context* ctx, const char* text)
EEL2: extension_api("ImGui_LogText", ImGui_Context ctx, "text")
Lua: reaper.ImGui_LogText(ImGui_Context ctx, string text)
Python: void ImGui_LogText(ImGui_Context* ctx, const char* text)
Description:Pass text data straight to log (without being displayed)
| Parameters: |
| ImGui_Context ctx | - | |
| string text | - | |
^
ImGui_LogToClipboardFunctioncall:
C: void ImGui_LogToClipboard(ImGui_Context* ctx, int* auto_open_depthInOptional)
EEL2: extension_api("ImGui_LogToClipboard", ImGui_Context ctx, optional int auto_open_depthIn)
Lua: reaper.ImGui_LogToClipboard(ImGui_Context ctx, optional number auto_open_depthIn)
Python: void ImGui_LogToClipboard(ImGui_Context* ctx, int* auto_open_depthInOptional)
Description:Default values: auto_open_depth = -1
| Parameters: |
| ImGui_Context ctx | - | |
| optional number auto_open_depthIn | - | |
^
ImGui_LogToFileFunctioncall:
C: void ImGui_LogToFile(ImGui_Context* ctx, int* auto_open_depthInOptional, const char* filenameInOptional)
EEL2: extension_api("ImGui_LogToFile", ImGui_Context ctx, optional int auto_open_depthIn, optional "filenameIn")
Lua: reaper.ImGui_LogToFile(ImGui_Context ctx, optional number auto_open_depthIn, optional string filenameIn)
Python: void ImGui_LogToFile(ImGui_Context* ctx, int* auto_open_depthInOptional, const char* filenameInOptional)
Description:Default values: auto_open_depth = -1, filename = nil
| Parameters: |
| ImGui_Context ctx | - | |
| optional number auto_open_depthIn | - | |
| optional string filenameIn | - | |
^
ImGui_LogToTTYFunctioncall:
C: void ImGui_LogToTTY(ImGui_Context* ctx, int* auto_open_depthInOptional)
EEL2: extension_api("ImGui_LogToTTY", ImGui_Context ctx, optional int auto_open_depthIn)
Lua: reaper.ImGui_LogToTTY(ImGui_Context ctx, optional number auto_open_depthIn)
Python: void ImGui_LogToTTY(ImGui_Context* ctx, int* auto_open_depthInOptional)
Description:Default values: auto_open_depth = -1
| Parameters: |
| ImGui_Context ctx | - | |
| optional number auto_open_depthIn | - | |
^
ImGui_MenuItemFunctioncall:
C: bool ImGui_MenuItem(ImGui_Context* ctx, const char* label, const char* shortcutInOptional, bool* p_selectedInOptional, bool* enabledInOptional)
EEL2: bool extension_api("ImGui_MenuItem", ImGui_Context ctx, "label", optional "shortcutIn", optional bool p_selectedIn, optional bool enabledIn)
Lua: boolean reaper.ImGui_MenuItem(ImGui_Context ctx, string label, optional string shortcutIn, optional boolean p_selectedIn, optional boolean enabledIn)
Python: bool ImGui_MenuItem(ImGui_Context* ctx, const char* label, const char* shortcutInOptional, bool* p_selectedInOptional, bool* enabledInOptional)
Description:Default values: enabled = true
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| optional string shortcutIn | - | |
| optional boolean p_selectedIn | - | |
| optional boolean enabledIn | - | |
^
ImGui_MouseButton_LeftFunctioncall:
C: int ImGui_MouseButton_Left()
EEL2: int extension_api("ImGui_MouseButton_Left")
Lua: integer reaper.ImGui_MouseButton_Left()
Python: int ImGui_MouseButton_Left()
Description:Python: Int ImGui_MouseButton_Left()
^
ImGui_MouseButton_MiddleFunctioncall:
C: int ImGui_MouseButton_Middle()
EEL2: int extension_api("ImGui_MouseButton_Middle")
Lua: integer reaper.ImGui_MouseButton_Middle()
Python: int ImGui_MouseButton_Middle()
Description:Python: Int ImGui_MouseButton_Middle()
^
ImGui_MouseButton_RightFunctioncall:
C: int ImGui_MouseButton_Right()
EEL2: int extension_api("ImGui_MouseButton_Right")
Lua: integer reaper.ImGui_MouseButton_Right()
Python: int ImGui_MouseButton_Right()
Description:Python: Int ImGui_MouseButton_Right()
^
ImGui_MouseCursor_ArrowFunctioncall:
C: int ImGui_MouseCursor_Arrow()
EEL2: int extension_api("ImGui_MouseCursor_Arrow")
Lua: integer reaper.ImGui_MouseCursor_Arrow()
Python: int ImGui_MouseCursor_Arrow()
Description:Python: Int ImGui_MouseCursor_Arrow()
^
ImGui_MouseCursor_HandFunctioncall:
C: int ImGui_MouseCursor_Hand()
EEL2: int extension_api("ImGui_MouseCursor_Hand")
Lua: integer reaper.ImGui_MouseCursor_Hand()
Python: int ImGui_MouseCursor_Hand()
Description:(Unused by Dear ImGui functions. Use for e.g. hyperlinks)
^
ImGui_MouseCursor_NotAllowedFunctioncall:
C: int ImGui_MouseCursor_NotAllowed()
EEL2: int extension_api("ImGui_MouseCursor_NotAllowed")
Lua: integer reaper.ImGui_MouseCursor_NotAllowed()
Python: int ImGui_MouseCursor_NotAllowed()
Description:When hovering something with disallowed interaction. Usually a crossed circle.
^
ImGui_MouseCursor_ResizeAllFunctioncall:
C: int ImGui_MouseCursor_ResizeAll()
EEL2: int extension_api("ImGui_MouseCursor_ResizeAll")
Lua: integer reaper.ImGui_MouseCursor_ResizeAll()
Python: int ImGui_MouseCursor_ResizeAll()
Description:(Unused by Dear ImGui functions)
^
ImGui_MouseCursor_ResizeEWFunctioncall:
C: int ImGui_MouseCursor_ResizeEW()
EEL2: int extension_api("ImGui_MouseCursor_ResizeEW")
Lua: integer reaper.ImGui_MouseCursor_ResizeEW()
Python: int ImGui_MouseCursor_ResizeEW()
Description:When hovering over a vertical border or a column
^
ImGui_MouseCursor_ResizeNESWFunctioncall:
C: int ImGui_MouseCursor_ResizeNESW()
EEL2: int extension_api("ImGui_MouseCursor_ResizeNESW")
Lua: integer reaper.ImGui_MouseCursor_ResizeNESW()
Python: int ImGui_MouseCursor_ResizeNESW()
Description:When hovering over the bottom-left corner of a window
^
ImGui_MouseCursor_ResizeNSFunctioncall:
C: int ImGui_MouseCursor_ResizeNS()
EEL2: int extension_api("ImGui_MouseCursor_ResizeNS")
Lua: integer reaper.ImGui_MouseCursor_ResizeNS()
Python: int ImGui_MouseCursor_ResizeNS()
Description:When hovering over an horizontal border
^
ImGui_MouseCursor_ResizeNWSEFunctioncall:
C: int ImGui_MouseCursor_ResizeNWSE()
EEL2: int extension_api("ImGui_MouseCursor_ResizeNWSE")
Lua: integer reaper.ImGui_MouseCursor_ResizeNWSE()
Python: int ImGui_MouseCursor_ResizeNWSE()
Description:When hovering over the bottom-right corner of a window
^
ImGui_MouseCursor_TextInputFunctioncall:
C: int ImGui_MouseCursor_TextInput()
EEL2: int extension_api("ImGui_MouseCursor_TextInput")
Lua: integer reaper.ImGui_MouseCursor_TextInput()
Python: int ImGui_MouseCursor_TextInput()
Description:When hovering over InputText, etc.
^
ImGui_NewLineFunctioncall:
C: void ImGui_NewLine(ImGui_Context* ctx)
EEL2: extension_api("ImGui_NewLine", ImGui_Context ctx)
Lua: reaper.ImGui_NewLine(ImGui_Context ctx)
Python: void ImGui_NewLine(ImGui_Context* ctx)
Description:Undo a SameLine() or force a new line when in an horizontal-layout context.
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_NumericLimits_FloatFunctioncall:
C: void ImGui_NumericLimits_Float(double* minOut, double* maxOut)
EEL2: extension_api("ImGui_NumericLimits_Float", &min, &max)
Lua: number min, number max = reaper.ImGui_NumericLimits_Float()
Python: void ImGui_NumericLimits_Float(double* minOut, double* maxOut)
Description:Returns FLT_MIN and FLT_MAX for this system.
| Returnvalues: |
| number min | - | |
| number max | - | - |
^
ImGui_OpenPopupFunctioncall:
C: void ImGui_OpenPopup(ImGui_Context* ctx, const char* str_id, int* popup_flagsInOptional)
EEL2: extension_api("ImGui_OpenPopup", ImGui_Context ctx, "str_id", optional int popup_flagsIn)
Lua: reaper.ImGui_OpenPopup(ImGui_Context ctx, string str_id, optional number popup_flagsIn)
Python: void ImGui_OpenPopup(ImGui_Context* ctx, const char* str_id, int* popup_flagsInOptional)
Description:Default values: popup_flags = ImGui_PopupFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string str_id | - | |
| optional number popup_flagsIn | - | |
^
ImGui_OpenPopupOnItemClickFunctioncall:
C: void ImGui_OpenPopupOnItemClick(ImGui_Context* ctx, const char* str_idInOptional, int* popup_flagsInOptional)
EEL2: extension_api("ImGui_OpenPopupOnItemClick", ImGui_Context ctx, optional "str_idIn", optional int popup_flagsIn)
Lua: reaper.ImGui_OpenPopupOnItemClick(ImGui_Context ctx, optional string str_idIn, optional number popup_flagsIn)
Python: void ImGui_OpenPopupOnItemClick(ImGui_Context* ctx, const char* str_idInOptional, int* popup_flagsInOptional)
Description:Default values: str_id = nil, popup_flags = ImGui_PopupFlags_MouseButtonRight
| Parameters: |
| ImGui_Context ctx | - | |
| optional string str_idIn | - | |
| optional number popup_flagsIn | - | |
^
ImGui_PathFillConvexFunctioncall:
C: void ImGui_PathFillConvex(ImGui_DrawList* draw_list, int col_rgba)
EEL2: extension_api("ImGui_PathFillConvex", ImGui_DrawList draw_list, int col_rgba)
Lua: reaper.ImGui_PathFillConvex(ImGui_DrawList draw_list, integer col_rgba)
Python: void ImGui_PathFillConvex(ImGui_DrawList* draw_list, int col_rgba)
Description:Note: Anti-aliased filling requires points to be in clockwise order.
| Parameters: |
| ImGui_DrawList draw_list | - | |
| integer col_rgba | - | |
^
ImGui_PlotHistogramFunctioncall:
C: void ImGui_PlotHistogram(ImGui_Context* ctx, const char* label, reaper_array* values, int* values_offsetInOptional, const char* overlay_textInOptional, double* scale_minInOptional, double* scale_maxInOptional, double* graph_size_wInOptional, double* graph_size_hInOptional)
EEL2: extension_api("ImGui_PlotHistogram", ImGui_Context ctx, "label", reaper_array values, optional int values_offsetIn, optional "overlay_textIn", optional scale_minIn, optional scale_maxIn, optional graph_size_wIn, optional graph_size_hIn)
Lua: reaper.ImGui_PlotHistogram(ImGui_Context ctx, string labelreaper_array values, optional number values_offsetIn, optional string overlay_textIn, optional number scale_minIn, optional number scale_maxIn, optional number graph_size_wIn, optional number graph_size_hIn)
Python: void ImGui_PlotHistogram(ImGui_Context* ctx, const char* label, reaper_array* values, int* values_offsetInOptional, const char* overlay_textInOptional, double* scale_minInOptional, double* scale_maxInOptional, double* graph_size_wInOptional, double* graph_size_hInOptional)
Description:Default values: values_offset = 0, overlay_text = nil, scale_min = FLT_MAX, scale_max = FLT_MAX, graph_size_w = 0.0, graph_size_h = 0.0
| Parameters: |
| ImGui_Context ctx | - | |
| string labelreaper_array values | - | |
| optional number values_offsetIn | - | |
| optional string overlay_textIn | - | |
| optional number scale_minIn | - | |
| optional number scale_maxIn | - | |
| optional number graph_size_wIn | - | |
| optional number graph_size_hIn | - | |
^
ImGui_PlotLinesFunctioncall:
C: void ImGui_PlotLines(ImGui_Context* ctx, const char* label, reaper_array* values, int* values_offsetInOptional, const char* overlay_textInOptional, double* scale_minInOptional, double* scale_maxInOptional, double* graph_size_wInOptional, double* graph_size_hInOptional)
EEL2: extension_api("ImGui_PlotLines", ImGui_Context ctx, "label", reaper_array values, optional int values_offsetIn, optional "overlay_textIn", optional scale_minIn, optional scale_maxIn, optional graph_size_wIn, optional graph_size_hIn)
Lua: reaper.ImGui_PlotLines(ImGui_Context ctx, string labelreaper_array values, optional number values_offsetIn, optional string overlay_textIn, optional number scale_minIn, optional number scale_maxIn, optional number graph_size_wIn, optional number graph_size_hIn)
Python: void ImGui_PlotLines(ImGui_Context* ctx, const char* label, reaper_array* values, int* values_offsetInOptional, const char* overlay_textInOptional, double* scale_minInOptional, double* scale_maxInOptional, double* graph_size_wInOptional, double* graph_size_hInOptional)
Description:Default values: values_offset = 0, overlay_text = nil, scale_min = 0.0, scale_max = 0.0, graph_size_w = 0.0, graph_size_h = 0.0
| Parameters: |
| ImGui_Context ctx | - | |
| string labelreaper_array values | - | |
| optional number values_offsetIn | - | |
| optional string overlay_textIn | - | |
| optional number scale_minIn | - | |
| optional number scale_maxIn | - | |
| optional number graph_size_wIn | - | |
| optional number graph_size_hIn | - | |
^
ImGui_PopAllowKeyboardFocusFunctioncall:
C: void ImGui_PopAllowKeyboardFocus(ImGui_Context* ctx)
EEL2: extension_api("ImGui_PopAllowKeyboardFocus", ImGui_Context ctx)
Lua: reaper.ImGui_PopAllowKeyboardFocus(ImGui_Context ctx)
Python: void ImGui_PopAllowKeyboardFocus(ImGui_Context* ctx)
Description:
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_PopButtonRepeatFunctioncall:
C: void ImGui_PopButtonRepeat(ImGui_Context* ctx)
EEL2: extension_api("ImGui_PopButtonRepeat", ImGui_Context ctx)
Lua: reaper.ImGui_PopButtonRepeat(ImGui_Context ctx)
Python: void ImGui_PopButtonRepeat(ImGui_Context* ctx)
Description:
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_PopClipRectFunctioncall:
C: void ImGui_PopClipRect(ImGui_Context* ctx)
EEL2: extension_api("ImGui_PopClipRect", ImGui_Context ctx)
Lua: reaper.ImGui_PopClipRect(ImGui_Context ctx)
Python: void ImGui_PopClipRect(ImGui_Context* ctx)
Description:
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_PopFontFunctioncall:
C: void ImGui_PopFont(ImGui_Context* ctx)
EEL2: extension_api("ImGui_PopFont", ImGui_Context ctx)
Lua: reaper.ImGui_PopFont(ImGui_Context ctx)
Python: void ImGui_PopFont(ImGui_Context* ctx)
Description:
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_PopIDFunctioncall:
C: void ImGui_PopID(ImGui_Context* ctx)
EEL2: extension_api("ImGui_PopID", ImGui_Context ctx)
Lua: reaper.ImGui_PopID(ImGui_Context ctx)
Python: void ImGui_PopID(ImGui_Context* ctx)
Description:Pop from the ID stack.
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_PopItemWidthFunctioncall:
C: void ImGui_PopItemWidth(ImGui_Context* ctx)
EEL2: extension_api("ImGui_PopItemWidth", ImGui_Context ctx)
Lua: reaper.ImGui_PopItemWidth(ImGui_Context ctx)
Python: void ImGui_PopItemWidth(ImGui_Context* ctx)
Description:
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_PopStyleColorFunctioncall:
C: void ImGui_PopStyleColor(ImGui_Context* ctx, int* countInOptional)
EEL2: extension_api("ImGui_PopStyleColor", ImGui_Context ctx, optional int countIn)
Lua: reaper.ImGui_PopStyleColor(ImGui_Context ctx, optional number countIn)
Python: void ImGui_PopStyleColor(ImGui_Context* ctx, int* countInOptional)
Description:Default values: count = 1
| Parameters: |
| ImGui_Context ctx | - | |
| optional number countIn | - | |
^
ImGui_PopStyleVarFunctioncall:
C: void ImGui_PopStyleVar(ImGui_Context* ctx, int* countInOptional)
EEL2: extension_api("ImGui_PopStyleVar", ImGui_Context ctx, optional int countIn)
Lua: reaper.ImGui_PopStyleVar(ImGui_Context ctx, optional number countIn)
Python: void ImGui_PopStyleVar(ImGui_Context* ctx, int* countInOptional)
Description:Default values: count = 1
| Parameters: |
| ImGui_Context ctx | - | |
| optional number countIn | - | |
^
ImGui_PopTextWrapPosFunctioncall:
C: void ImGui_PopTextWrapPos(ImGui_Context* ctx)
EEL2: extension_api("ImGui_PopTextWrapPos", ImGui_Context ctx)
Lua: reaper.ImGui_PopTextWrapPos(ImGui_Context ctx)
Python: void ImGui_PopTextWrapPos(ImGui_Context* ctx)
Description:Python: ImGui_PopTextWrapPos(ImGui_Context ctx)
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_PopupFlags_AnyPopupFunctioncall:
C: int ImGui_PopupFlags_AnyPopup()
EEL2: int extension_api("ImGui_PopupFlags_AnyPopup")
Lua: integer reaper.ImGui_PopupFlags_AnyPopup()
Python: int ImGui_PopupFlags_AnyPopup()
Description:ImGuiPopupFlags_AnyPopupId | ImGuiPopupFlags_AnyPopupLevel
^
ImGui_PopupFlags_AnyPopupIdFunctioncall:
C: int ImGui_PopupFlags_AnyPopupId()
EEL2: int extension_api("ImGui_PopupFlags_AnyPopupId")
Lua: integer reaper.ImGui_PopupFlags_AnyPopupId()
Python: int ImGui_PopupFlags_AnyPopupId()
Description:For IsPopupOpen(): ignore the ImGuiID parameter and test for any popup.
^
ImGui_PopupFlags_AnyPopupLevelFunctioncall:
C: int ImGui_PopupFlags_AnyPopupLevel()
EEL2: int extension_api("ImGui_PopupFlags_AnyPopupLevel")
Lua: integer reaper.ImGui_PopupFlags_AnyPopupLevel()
Python: int ImGui_PopupFlags_AnyPopupLevel()
Description:For IsPopupOpen(): search/test at any level of the popup stack (default test in the current level)
^
ImGui_PopupFlags_MouseButtonLeftFunctioncall:
C: int ImGui_PopupFlags_MouseButtonLeft()
EEL2: int extension_api("ImGui_PopupFlags_MouseButtonLeft")
Lua: integer reaper.ImGui_PopupFlags_MouseButtonLeft()
Python: int ImGui_PopupFlags_MouseButtonLeft()
Description:For BeginPopupContext*(): open on Left Mouse release. Guaranteed to always be == 0 (same as ImGuiMouseButton_Left)
^
ImGui_PopupFlags_MouseButtonMiddleFunctioncall:
C: int ImGui_PopupFlags_MouseButtonMiddle()
EEL2: int extension_api("ImGui_PopupFlags_MouseButtonMiddle")
Lua: integer reaper.ImGui_PopupFlags_MouseButtonMiddle()
Python: int ImGui_PopupFlags_MouseButtonMiddle()
Description:For BeginPopupContext*(): open on Middle Mouse release. Guaranteed to always be == 2 (same as ImGuiMouseButton_Middle)
^
ImGui_PopupFlags_MouseButtonRightFunctioncall:
C: int ImGui_PopupFlags_MouseButtonRight()
EEL2: int extension_api("ImGui_PopupFlags_MouseButtonRight")
Lua: integer reaper.ImGui_PopupFlags_MouseButtonRight()
Python: int ImGui_PopupFlags_MouseButtonRight()
Description:For BeginPopupContext*(): open on Right Mouse release. Guaranteed to always be == 1 (same as ImGuiMouseButton_Right)
^
ImGui_PopupFlags_NoOpenOverExistingPopupFunctioncall:
C: int ImGui_PopupFlags_NoOpenOverExistingPopup()
EEL2: int extension_api("ImGui_PopupFlags_NoOpenOverExistingPopup")
Lua: integer reaper.ImGui_PopupFlags_NoOpenOverExistingPopup()
Python: int ImGui_PopupFlags_NoOpenOverExistingPopup()
Description:For OpenPopup*(), BeginPopupContext*(): don't open if there's already a popup at the same level of the popup stack
^
ImGui_PopupFlags_NoOpenOverItemsFunctioncall:
C: int ImGui_PopupFlags_NoOpenOverItems()
EEL2: int extension_api("ImGui_PopupFlags_NoOpenOverItems")
Lua: integer reaper.ImGui_PopupFlags_NoOpenOverItems()
Python: int ImGui_PopupFlags_NoOpenOverItems()
Description:For BeginPopupContextWindow(): don't return true when hovering items, only when hovering empty space
^
ImGui_PopupFlags_NoneFunctioncall:
C: int ImGui_PopupFlags_None()
EEL2: int extension_api("ImGui_PopupFlags_None")
Lua: integer reaper.ImGui_PopupFlags_None()
Python: int ImGui_PopupFlags_None()
Description:Flags: for OpenPopup*(), BeginPopupContext*(), IsPopupOpen()
^
ImGui_ProgressBarFunctioncall:
C: void ImGui_ProgressBar(ImGui_Context* ctx, double fraction, double* size_arg_wInOptional, double* size_arg_hInOptional, const char* overlayInOptional)
EEL2: extension_api("ImGui_ProgressBar", ImGui_Context ctx, fraction, optional size_arg_wIn, optional size_arg_hIn, optional "overlayIn")
Lua: reaper.ImGui_ProgressBar(ImGui_Context ctx, number fraction, optional number size_arg_wIn, optional number size_arg_hIn, optional string overlayIn)
Python: void ImGui_ProgressBar(ImGui_Context* ctx, double fraction, double* size_arg_wInOptional, double* size_arg_hInOptional, const char* overlayInOptional)
Description:Default values: size_arg_w = -FLT_MIN, size_arg_h = 0.0, overlay = nil
| Parameters: |
| ImGui_Context ctx | - | |
| number fraction | - | |
| optional number size_arg_wIn | - | |
| optional number size_arg_hIn | - | |
| optional string overlayIn | - | |
^
ImGui_PushAllowKeyboardFocusFunctioncall:
C: void ImGui_PushAllowKeyboardFocus(ImGui_Context* ctx, bool allow_keyboard_focus)
EEL2: extension_api("ImGui_PushAllowKeyboardFocus", ImGui_Context ctx, bool allow_keyboard_focus)
Lua: reaper.ImGui_PushAllowKeyboardFocus(ImGui_Context ctx, boolean allow_keyboard_focus)
Python: void ImGui_PushAllowKeyboardFocus(ImGui_Context* ctx, bool allow_keyboard_focus)
Description:Allow focusing using TAB/Shift-TAB, enabled by default but you can disable it for certain widgets
| Parameters: |
| ImGui_Context ctx | - | |
| boolean allow_keyboard_focus | - | |
^
ImGui_PushButtonRepeatFunctioncall:
C: void ImGui_PushButtonRepeat(ImGui_Context* ctx, bool repeat)
EEL2: extension_api("ImGui_PushButtonRepeat", ImGui_Context ctx, bool repeat)
Lua: reaper.ImGui_PushButtonRepeat(ImGui_Context ctx, boolean repeat)
Python: void ImGui_PushButtonRepeat(ImGui_Context* ctx, bool repeat)
Description:In 'repeat' mode, Button*() functions return repeated true in a typematic manner (using io.KeyRepeatDelay/io.KeyRepeatRate setting). Note that you can call IsItemActive() after any Button() to tell if the button is held in the current frame.
| Parameters: |
| ImGui_Context ctx | - | |
| boolean repeat | - | |
^
ImGui_PushClipRectFunctioncall:
C: void ImGui_PushClipRect(ImGui_Context* ctx, double clip_rect_min_x, double clip_rect_min_y, double clip_rect_max_x, double clip_rect_max_y, bool intersect_with_current_clip_rect)
EEL2: extension_api("ImGui_PushClipRect", ImGui_Context ctx, clip_rect_min_x, clip_rect_min_y, clip_rect_max_x, clip_rect_max_y, bool intersect_with_current_clip_rect)
Lua: reaper.ImGui_PushClipRect(ImGui_Context ctx, number clip_rect_min_x, number clip_rect_min_y, number clip_rect_max_x, number clip_rect_max_y, boolean intersect_with_current_clip_rect)
Python: void ImGui_PushClipRect(ImGui_Context* ctx, double clip_rect_min_x, double clip_rect_min_y, double clip_rect_max_x, double clip_rect_max_y, bool intersect_with_current_clip_rect)
Description:Mouse hovering is affected by ImGui::PushClipRect() calls, unlike direct calls to ImDrawList::PushClipRect() which are render only. See
ImGui_PopClipRect.
| Parameters: |
| ImGui_Context ctx | - | |
| number clip_rect_min_x | - | |
| number clip_rect_min_y | - | |
| number clip_rect_max_x | - | |
| number clip_rect_max_y | - | |
| boolean intersect_with_current_clip_rect | - | |
^
ImGui_PushFontFunctioncall:
C: void ImGui_PushFont(ImGui_Context* ctx, ImGui_Font* font)
EEL2: extension_api("ImGui_PushFont", ImGui_Context ctx, ImGui_Font font)
Lua: reaper.ImGui_PushFont(ImGui_Context ctxImGui_Font font)
Python: void ImGui_PushFont(ImGui_Context* ctx, ImGui_Font* font)
Description:Change the current font. Use nil to push the default font. See
ImGui_PopFont.
| Parameters: |
| ImGui_Context ctxImGui_Font font | - | |
^
ImGui_PushIDFunctioncall:
C: void ImGui_PushID(ImGui_Context* ctx, const char* str_id)
EEL2: extension_api("ImGui_PushID", ImGui_Context ctx, "str_id")
Lua: reaper.ImGui_PushID(ImGui_Context ctx, string str_id)
Python: void ImGui_PushID(ImGui_Context* ctx, const char* str_id)
Description:You can also use the "Label##foobar" syntax within widget label to distinguish them from each others.
| Parameters: |
| ImGui_Context ctx | - | |
| string str_id | - | |
^
ImGui_PushItemWidthFunctioncall:
C: void ImGui_PushItemWidth(ImGui_Context* ctx, double item_width)
EEL2: extension_api("ImGui_PushItemWidth", ImGui_Context ctx, item_width)
Lua: reaper.ImGui_PushItemWidth(ImGui_Context ctx, number item_width)
Python: void ImGui_PushItemWidth(ImGui_Context* ctx, double item_width)
Description:Push width of items for common large "item+label" widgets. >0.0f: width in pixels, <0.0f align xx pixels to the right of window (so -FLT_MIN always align width to the right side). 0.0f = default to ~2/3 of windows width,
| Parameters: |
| ImGui_Context ctx | - | |
| number item_width | - | |
^
ImGui_PushStyleColorFunctioncall:
C: void ImGui_PushStyleColor(ImGui_Context* ctx, int idx, int col_rgba)
EEL2: extension_api("ImGui_PushStyleColor", ImGui_Context ctx, int idx, int col_rgba)
Lua: reaper.ImGui_PushStyleColor(ImGui_Context ctx, integer idx, integer col_rgba)
Python: void ImGui_PushStyleColor(ImGui_Context* ctx, int idx, int col_rgba)
Description:Modify a style color. Call ImGui_PopStyleColor to undo after use (before the end of the frame). See ImGui_Col_* for available style colors.
| Parameters: |
| ImGui_Context ctx | - | |
| integer idx | - | |
| integer col_rgba | - | |
^
ImGui_PushStyleVarFunctioncall:
C: void ImGui_PushStyleVar(ImGui_Context* ctx, int var_idx, double val1, double* val2InOptional)
EEL2: extension_api("ImGui_PushStyleVar", ImGui_Context ctx, int var_idx, val1, optional val2In)
Lua: reaper.ImGui_PushStyleVar(ImGui_Context ctx, integer var_idx, number val1, optional number val2In)
Python: void ImGui_PushStyleVar(ImGui_Context* ctx, int var_idx, double val1, double* val2InOptional)
Description:Default values: val2 = nil
| Parameters: |
| ImGui_Context ctx | - | |
| integer var_idx | - | |
| number val1 | - | |
| optional number val2In | - | |
^
ImGui_PushTextWrapPosFunctioncall:
C: void ImGui_PushTextWrapPos(ImGui_Context* ctx, double* wrap_local_pos_xInOptional)
EEL2: extension_api("ImGui_PushTextWrapPos", ImGui_Context ctx, optional wrap_local_pos_xIn)
Lua: reaper.ImGui_PushTextWrapPos(ImGui_Context ctx, optional number wrap_local_pos_xIn)
Python: void ImGui_PushTextWrapPos(ImGui_Context* ctx, double* wrap_local_pos_xInOptional)
Description:Default values: wrap_local_pos_x = 0.0
| Parameters: |
| ImGui_Context ctx | - | |
| optional number wrap_local_pos_xIn | - | |
^
ImGui_RadioButtonFunctioncall:
C: bool ImGui_RadioButton(ImGui_Context* ctx, const char* label, bool active)
EEL2: bool extension_api("ImGui_RadioButton", ImGui_Context ctx, "label", bool active)
Lua: boolean reaper.ImGui_RadioButton(ImGui_Context ctx, string label, boolean active)
Python: bool ImGui_RadioButton(ImGui_Context* ctx, const char* label, bool active)
Description:Use with e.g. if (RadioButton("one", my_value==1)) { my_value = 1; }
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| boolean active | - | |
^
ImGui_RadioButtonExFunctioncall:
C: bool ImGui_RadioButtonEx(ImGui_Context* ctx, const char* label, int* vInOut, int v_button)
EEL2: bool extension_api("ImGui_RadioButtonEx", ImGui_Context ctx, "label", int &v, int v_button)
Lua: boolean retval, number v = reaper.ImGui_RadioButtonEx(ImGui_Context ctx, string label, number v, integer v_button)
Python: bool ImGui_RadioButtonEx(ImGui_Context* ctx, const char* label, int* vInOut, int v_button)
Description:Shortcut to handle RadioButton's example pattern when value is an integer
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number v | - | |
| integer v_button | - | |
| Returnvalues: |
| boolean retval | - | |
| number v | - | - |
^
ImGui_ResetMouseDragDeltaFunctioncall:
C: void ImGui_ResetMouseDragDelta(ImGui_Context* ctx, int* buttonInOptional)
EEL2: extension_api("ImGui_ResetMouseDragDelta", ImGui_Context ctx, optional int buttonIn)
Lua: reaper.ImGui_ResetMouseDragDelta(ImGui_Context ctx, optional number buttonIn)
Python: void ImGui_ResetMouseDragDelta(ImGui_Context* ctx, int* buttonInOptional)
Description:Default values: button = ImGui_MouseButton_Left
| Parameters: |
| ImGui_Context ctx | - | |
| optional number buttonIn | - | |
^
ImGui_SameLineFunctioncall:
C: void ImGui_SameLine(ImGui_Context* ctx, double* offset_from_start_xInOptional, double* spacingInOptional)
EEL2: extension_api("ImGui_SameLine", ImGui_Context ctx, optional offset_from_start_xIn, optional spacingIn)
Lua: reaper.ImGui_SameLine(ImGui_Context ctx, optional number offset_from_start_xIn, optional number spacingIn)
Python: void ImGui_SameLine(ImGui_Context* ctx, double* offset_from_start_xInOptional, double* spacingInOptional)
Description:Default values: offset_from_start_x = 0.0, spacing = -1.0.
| Parameters: |
| ImGui_Context ctx | - | |
| optional number offset_from_start_xIn | - | |
| optional number spacingIn | - | |
^
ImGui_SelectableFunctioncall:
C: bool ImGui_Selectable(ImGui_Context* ctx, const char* label, bool* p_selectedInOptional, int* flagsInOptional, double* size_wInOptional, double* size_hInOptional)
EEL2: bool extension_api("ImGui_Selectable", ImGui_Context ctx, "label", optional bool p_selectedIn, optional int flagsIn, optional size_wIn, optional size_hIn)
Lua: boolean reaper.ImGui_Selectable(ImGui_Context ctx, string label, optional boolean p_selectedIn, optional number flagsIn, optional number size_wIn, optional number size_hIn)
Python: bool ImGui_Selectable(ImGui_Context* ctx, const char* label, bool* p_selectedInOptional, int* flagsInOptional, double* size_wInOptional, double* size_hInOptional)
Description:Default values: flags = ImGui_SelectableFlags_None, size_w = 0.0, size_h = 0.0
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| optional boolean p_selectedIn | - | |
| optional number flagsIn | - | |
| optional number size_wIn | - | |
| optional number size_hIn | - | |
^
ImGui_SelectableFlags_AllowDoubleClickFunctioncall:
C: int ImGui_SelectableFlags_AllowDoubleClick()
EEL2: int extension_api("ImGui_SelectableFlags_AllowDoubleClick")
Lua: integer reaper.ImGui_SelectableFlags_AllowDoubleClick()
Python: int ImGui_SelectableFlags_AllowDoubleClick()
Description:Generate press events on double clicks too
^
ImGui_SelectableFlags_AllowItemOverlapFunctioncall:
C: int ImGui_SelectableFlags_AllowItemOverlap()
EEL2: int extension_api("ImGui_SelectableFlags_AllowItemOverlap")
Lua: integer reaper.ImGui_SelectableFlags_AllowItemOverlap()
Python: int ImGui_SelectableFlags_AllowItemOverlap()
Description:Hit testing to allow subsequent widgets to overlap this one
^
ImGui_SelectableFlags_DisabledFunctioncall:
C: int ImGui_SelectableFlags_Disabled()
EEL2: int extension_api("ImGui_SelectableFlags_Disabled")
Lua: integer reaper.ImGui_SelectableFlags_Disabled()
Python: int ImGui_SelectableFlags_Disabled()
Description:Cannot be selected, display grayed out text
^
ImGui_SelectableFlags_DontClosePopupsFunctioncall:
C: int ImGui_SelectableFlags_DontClosePopups()
EEL2: int extension_api("ImGui_SelectableFlags_DontClosePopups")
Lua: integer reaper.ImGui_SelectableFlags_DontClosePopups()
Python: int ImGui_SelectableFlags_DontClosePopups()
Description:Clicking this don't close parent popup window
^
ImGui_SelectableFlags_NoneFunctioncall:
C: int ImGui_SelectableFlags_None()
EEL2: int extension_api("ImGui_SelectableFlags_None")
Lua: integer reaper.ImGui_SelectableFlags_None()
Python: int ImGui_SelectableFlags_None()
Description:Flags: for Selectable()
^
ImGui_SelectableFlags_SpanAllColumnsFunctioncall:
C: int ImGui_SelectableFlags_SpanAllColumns()
EEL2: int extension_api("ImGui_SelectableFlags_SpanAllColumns")
Lua: integer reaper.ImGui_SelectableFlags_SpanAllColumns()
Python: int ImGui_SelectableFlags_SpanAllColumns()
Description:Selectable frame can span all columns (text will still fit in current column)
^
ImGui_SeparatorFunctioncall:
C: void ImGui_Separator(ImGui_Context* ctx)
EEL2: extension_api("ImGui_Separator", ImGui_Context ctx)
Lua: reaper.ImGui_Separator(ImGui_Context ctx)
Python: void ImGui_Separator(ImGui_Context* ctx)
Description:Separator, generally horizontal. inside a menu bar or in horizontal layout mode, this becomes a vertical separator.
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_SetClipboardTextFunctioncall:
C: void ImGui_SetClipboardText(ImGui_Context* ctx, const char* text)
EEL2: extension_api("ImGui_SetClipboardText", ImGui_Context ctx, "text")
Lua: reaper.ImGui_SetClipboardText(ImGui_Context ctx, string text)
Python: void ImGui_SetClipboardText(ImGui_Context* ctx, const char* text)
Description:See also the ImGui_LogToClipboard function to capture GUI into clipboard, or easily output text data to the clipboard.
| Parameters: |
| ImGui_Context ctx | - | |
| string text | - | |
^
ImGui_SetColorEditOptionsFunctioncall:
C: void ImGui_SetColorEditOptions(ImGui_Context* ctx, int flags)
EEL2: extension_api("ImGui_SetColorEditOptions", ImGui_Context ctx, int flags)
Lua: reaper.ImGui_SetColorEditOptions(ImGui_Context ctx, integer flags)
Python: void ImGui_SetColorEditOptions(ImGui_Context* ctx, int flags)
Description:Picker type, etc. User will be able to change many settings, unless you pass the _NoOptions flag to your calls.
| Parameters: |
| ImGui_Context ctx | - | |
| integer flags | - | |
^
ImGui_SetConfigFlagsFunctioncall:
C: void ImGui_SetConfigFlags(ImGui_Context* ctx, int flags)
EEL2: extension_api("ImGui_SetConfigFlags", ImGui_Context ctx, int flags)
Lua: reaper.ImGui_SetConfigFlags(ImGui_Context ctx, integer flags)
Python: void ImGui_SetConfigFlags(ImGui_Context* ctx, int flags)
Description:
| Parameters: |
| ImGui_Context ctx | - | |
| integer flags | - | |
^
ImGui_SetCursorPosFunctioncall:
C: void ImGui_SetCursorPos(ImGui_Context* ctx, double local_pos_x, double local_pos_y)
EEL2: extension_api("ImGui_SetCursorPos", ImGui_Context ctx, local_pos_x, local_pos_y)
Lua: reaper.ImGui_SetCursorPos(ImGui_Context ctx, number local_pos_x, number local_pos_y)
Python: void ImGui_SetCursorPos(ImGui_Context* ctx, double local_pos_x, double local_pos_y)
Description:Cursor position in window
| Parameters: |
| ImGui_Context ctx | - | |
| number local_pos_x | - | |
| number local_pos_y | - | |
^
ImGui_SetCursorPosXFunctioncall:
C: void ImGui_SetCursorPosX(ImGui_Context* ctx, double local_x)
EEL2: extension_api("ImGui_SetCursorPosX", ImGui_Context ctx, local_x)
Lua: reaper.ImGui_SetCursorPosX(ImGui_Context ctx, number local_x)
Python: void ImGui_SetCursorPosX(ImGui_Context* ctx, double local_x)
Description:Cursor X position in window
| Parameters: |
| ImGui_Context ctx | - | |
| number local_x | - | |
^
ImGui_SetCursorPosYFunctioncall:
C: void ImGui_SetCursorPosY(ImGui_Context* ctx, double local_y)
EEL2: extension_api("ImGui_SetCursorPosY", ImGui_Context ctx, local_y)
Lua: reaper.ImGui_SetCursorPosY(ImGui_Context ctx, number local_y)
Python: void ImGui_SetCursorPosY(ImGui_Context* ctx, double local_y)
Description:Cursor Y position in window
| Parameters: |
| ImGui_Context ctx | - | |
| number local_y | - | |
^
ImGui_SetCursorScreenPosFunctioncall:
C: void ImGui_SetCursorScreenPos(ImGui_Context* ctx, double pos_x, double pos_y)
EEL2: extension_api("ImGui_SetCursorScreenPos", ImGui_Context ctx, pos_x, pos_y)
Lua: reaper.ImGui_SetCursorScreenPos(ImGui_Context ctx, number pos_x, number pos_y)
Python: void ImGui_SetCursorScreenPos(ImGui_Context* ctx, double pos_x, double pos_y)
Description:Cursor position in absolute screen coordinates [0..io.DisplaySize]
| Parameters: |
| ImGui_Context ctx | - | |
| number pos_x | - | |
| number pos_y | - | |
^
ImGui_SetDockFunctioncall:
C: void ImGui_SetDock(ImGui_Context* ctx, int dock)
EEL2: extension_api("ImGui_SetDock", ImGui_Context ctx, int dock)
Lua: reaper.ImGui_SetDock(ImGui_Context ctx, integer dock)
Python: void ImGui_SetDock(ImGui_Context* ctx, int dock)
Description:First bit is the docking enable flag. The remaining bits are the docker index.
| Parameters: |
| ImGui_Context ctx | - | |
| integer dock | - | |
^
ImGui_SetDragDropPayloadFunctioncall:
C: bool ImGui_SetDragDropPayload(ImGui_Context* ctx, const char* type, const char* data, int* condInOptional)
EEL2: bool extension_api("ImGui_SetDragDropPayload", ImGui_Context ctx, "type", "data", optional int condIn)
Lua: boolean reaper.ImGui_SetDragDropPayload(ImGui_Context ctx, string type, string data, optional number condIn)
Python: bool ImGui_SetDragDropPayload(ImGui_Context* ctx, const char* type, const char* data, int* condInOptional)
Description:Default values: cond = ImGui_Cond_Always
| Parameters: |
| ImGui_Context ctx | - | |
| string type | - | |
| string data | - | |
| optional number condIn | - | |
^
ImGui_SetItemAllowOverlapFunctioncall:
C: void ImGui_SetItemAllowOverlap(ImGui_Context* ctx)
EEL2: extension_api("ImGui_SetItemAllowOverlap", ImGui_Context ctx)
Lua: reaper.ImGui_SetItemAllowOverlap(ImGui_Context ctx)
Python: void ImGui_SetItemAllowOverlap(ImGui_Context* ctx)
Description:Allow last item to be overlapped by a subsequent item. sometimes useful with invisible buttons, selectables, etc. to catch unused area.
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_SetItemDefaultFocusFunctioncall:
C: void ImGui_SetItemDefaultFocus(ImGui_Context* ctx)
EEL2: extension_api("ImGui_SetItemDefaultFocus", ImGui_Context ctx)
Lua: reaper.ImGui_SetItemDefaultFocus(ImGui_Context ctx)
Python: void ImGui_SetItemDefaultFocus(ImGui_Context* ctx)
Description:Prefer using "SetItemDefaultFocus()" over "if (IsWindowAppearing()) SetScrollHereY()" when applicable to signify "this is the default item"
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_SetKeyboardFocusHereFunctioncall:
C: void ImGui_SetKeyboardFocusHere(ImGui_Context* ctx, int* offsetInOptional)
EEL2: extension_api("ImGui_SetKeyboardFocusHere", ImGui_Context ctx, optional int offsetIn)
Lua: reaper.ImGui_SetKeyboardFocusHere(ImGui_Context ctx, optional number offsetIn)
Python: void ImGui_SetKeyboardFocusHere(ImGui_Context* ctx, int* offsetInOptional)
Description:Default values: offset = 0
| Parameters: |
| ImGui_Context ctx | - | |
| optional number offsetIn | - | |
^
ImGui_SetMouseCursorFunctioncall:
C: void ImGui_SetMouseCursor(ImGui_Context* ctx, int cursor_type)
EEL2: extension_api("ImGui_SetMouseCursor", ImGui_Context ctx, int cursor_type)
Lua: reaper.ImGui_SetMouseCursor(ImGui_Context ctx, integer cursor_type)
Python: void ImGui_SetMouseCursor(ImGui_Context* ctx, int cursor_type)
Description:Set desired cursor type
| Parameters: |
| ImGui_Context ctx | - | |
| integer cursor_type | - | |
^
ImGui_SetNextItemOpenFunctioncall:
C: void ImGui_SetNextItemOpen(ImGui_Context* ctx, bool is_open, int* condInOptional)
EEL2: extension_api("ImGui_SetNextItemOpen", ImGui_Context ctx, bool is_open, optional int condIn)
Lua: reaper.ImGui_SetNextItemOpen(ImGui_Context ctx, boolean is_open, optional number condIn)
Python: void ImGui_SetNextItemOpen(ImGui_Context* ctx, bool is_open, int* condInOptional)
Description:Default values: cond = ImGui_Cond_Always.
| Parameters: |
| ImGui_Context ctx | - | |
| boolean is_open | - | |
| optional number condIn | - | |
^
ImGui_SetNextItemWidthFunctioncall:
C: void ImGui_SetNextItemWidth(ImGui_Context* ctx, double item_width)
EEL2: extension_api("ImGui_SetNextItemWidth", ImGui_Context ctx, item_width)
Lua: reaper.ImGui_SetNextItemWidth(ImGui_Context ctx, number item_width)
Python: void ImGui_SetNextItemWidth(ImGui_Context* ctx, double item_width)
Description:Set width of the _next_ common large "item+label" widget. >0.0f: width in pixels, <0.0f align xx pixels to the right of window (so -FLT_MIN always align width to the right side)
| Parameters: |
| ImGui_Context ctx | - | |
| number item_width | - | |
^
ImGui_SetNextWindowBgAlphaFunctioncall:
C: void ImGui_SetNextWindowBgAlpha(ImGui_Context* ctx, double alpha)
EEL2: extension_api("ImGui_SetNextWindowBgAlpha", ImGui_Context ctx, alpha)
Lua: reaper.ImGui_SetNextWindowBgAlpha(ImGui_Context ctx, number alpha)
Python: void ImGui_SetNextWindowBgAlpha(ImGui_Context* ctx, double alpha)
Description:Set next window background color alpha. helper to easily override the Alpha component of ImGuiCol_WindowBg/ChildBg/PopupBg. you may also use ImGui_WindowFlags_NoBackground.
| Parameters: |
| ImGui_Context ctx | - | |
| number alpha | - | |
^
ImGui_SetNextWindowCollapsedFunctioncall:
C: void ImGui_SetNextWindowCollapsed(ImGui_Context* ctx, bool collapsed, int* condInOptional)
EEL2: extension_api("ImGui_SetNextWindowCollapsed", ImGui_Context ctx, bool collapsed, optional int condIn)
Lua: reaper.ImGui_SetNextWindowCollapsed(ImGui_Context ctx, boolean collapsed, optional number condIn)
Python: void ImGui_SetNextWindowCollapsed(ImGui_Context* ctx, bool collapsed, int* condInOptional)
Description:Default values: cond = ImGui_Cond_Always
| Parameters: |
| ImGui_Context ctx | - | |
| boolean collapsed | - | |
| optional number condIn | - | |
^
ImGui_SetNextWindowContentSizeFunctioncall:
C: void ImGui_SetNextWindowContentSize(ImGui_Context* ctx, double size_w, double size_h)
EEL2: extension_api("ImGui_SetNextWindowContentSize", ImGui_Context ctx, size_w, size_h)
Lua: reaper.ImGui_SetNextWindowContentSize(ImGui_Context ctx, number size_w, number size_h)
Python: void ImGui_SetNextWindowContentSize(ImGui_Context* ctx, double size_w, double size_h)
Description:Set next window content size (~ scrollable client area, which enforce the range of scrollbars). Not including window decorations (title bar, menu bar, etc.) nor WindowPadding. set an axis to 0.0f to leave it automatic. Call before Begin().
| Parameters: |
| ImGui_Context ctx | - | |
| number size_w | - | |
| number size_h | - | |
^
ImGui_SetNextWindowFocusFunctioncall:
C: void ImGui_SetNextWindowFocus(ImGui_Context* ctx)
EEL2: extension_api("ImGui_SetNextWindowFocus", ImGui_Context ctx)
Lua: reaper.ImGui_SetNextWindowFocus(ImGui_Context ctx)
Python: void ImGui_SetNextWindowFocus(ImGui_Context* ctx)
Description:Set next window to be focused / top-most. Call before Begin().
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_SetNextWindowPosFunctioncall:
C: void ImGui_SetNextWindowPos(ImGui_Context* ctx, double pos_x, double pos_y, int* condInOptional, double* pivot_xInOptional, double* pivot_yInOptional)
EEL2: extension_api("ImGui_SetNextWindowPos", ImGui_Context ctx, pos_x, pos_y, optional int condIn, optional pivot_xIn, optional pivot_yIn)
Lua: reaper.ImGui_SetNextWindowPos(ImGui_Context ctx, number pos_x, number pos_y, optional number condIn, optional number pivot_xIn, optional number pivot_yIn)
Python: void ImGui_SetNextWindowPos(ImGui_Context* ctx, double pos_x, double pos_y, int* condInOptional, double* pivot_xInOptional, double* pivot_yInOptional)
Description:Default values: cond = ImGui_Cond_Always, pivot_x = 0.0, pivot_y = 0.0
| Parameters: |
| ImGui_Context ctx | - | |
| number pos_x | - | |
| number pos_y | - | |
| optional number condIn | - | |
| optional number pivot_xIn | - | |
| optional number pivot_yIn | - | |
^
ImGui_SetNextWindowSizeFunctioncall:
C: void ImGui_SetNextWindowSize(ImGui_Context* ctx, double size_w, double size_h, int* condInOptional)
EEL2: extension_api("ImGui_SetNextWindowSize", ImGui_Context ctx, size_w, size_h, optional int condIn)
Lua: reaper.ImGui_SetNextWindowSize(ImGui_Context ctx, number size_w, number size_h, optional number condIn)
Python: void ImGui_SetNextWindowSize(ImGui_Context* ctx, double size_w, double size_h, int* condInOptional)
Description:Default values: cond = ImGui_Cond_Always
| Parameters: |
| ImGui_Context ctx | - | |
| number size_w | - | |
| number size_h | - | |
| optional number condIn | - | |
^
ImGui_SetNextWindowSizeConstraintsFunctioncall:
C: void ImGui_SetNextWindowSizeConstraints(ImGui_Context* ctx, double size_min_w, double size_min_h, double size_max_w, double size_max_h)
EEL2: extension_api("ImGui_SetNextWindowSizeConstraints", ImGui_Context ctx, size_min_w, size_min_h, size_max_w, size_max_h)
Lua: reaper.ImGui_SetNextWindowSizeConstraints(ImGui_Context ctx, number size_min_w, number size_min_h, number size_max_w, number size_max_h)
Python: void ImGui_SetNextWindowSizeConstraints(ImGui_Context* ctx, double size_min_w, double size_min_h, double size_max_w, double size_max_h)
Description:Set next window size limits. use -1,-1 on either X/Y axis to preserve the current size. Sizes will be rounded down.
| Parameters: |
| ImGui_Context ctx | - | |
| number size_min_w | - | |
| number size_min_h | - | |
| number size_max_w | - | |
| number size_max_h | - | |
^
ImGui_SetScrollFromPosXFunctioncall:
C: void ImGui_SetScrollFromPosX(ImGui_Context* ctx, double local_x, double* center_x_ratioInOptional)
EEL2: extension_api("ImGui_SetScrollFromPosX", ImGui_Context ctx, local_x, optional center_x_ratioIn)
Lua: reaper.ImGui_SetScrollFromPosX(ImGui_Context ctx, number local_x, optional number center_x_ratioIn)
Python: void ImGui_SetScrollFromPosX(ImGui_Context* ctx, double local_x, double* center_x_ratioInOptional)
Description:Default values: center_x_ratio = 0.5
| Parameters: |
| ImGui_Context ctx | - | |
| number local_x | - | |
| optional number center_x_ratioIn | - | |
^
ImGui_SetScrollFromPosYFunctioncall:
C: void ImGui_SetScrollFromPosY(ImGui_Context* ctx, double local_y, double* center_y_ratioInOptional)
EEL2: extension_api("ImGui_SetScrollFromPosY", ImGui_Context ctx, local_y, optional center_y_ratioIn)
Lua: reaper.ImGui_SetScrollFromPosY(ImGui_Context ctx, number local_y, optional number center_y_ratioIn)
Python: void ImGui_SetScrollFromPosY(ImGui_Context* ctx, double local_y, double* center_y_ratioInOptional)
Description:Default values: center_y_ratio = 0.5
| Parameters: |
| ImGui_Context ctx | - | |
| number local_y | - | |
| optional number center_y_ratioIn | - | |
^
ImGui_SetScrollHereXFunctioncall:
C: void ImGui_SetScrollHereX(ImGui_Context* ctx, double* center_x_ratioInOptional)
EEL2: extension_api("ImGui_SetScrollHereX", ImGui_Context ctx, optional center_x_ratioIn)
Lua: reaper.ImGui_SetScrollHereX(ImGui_Context ctx, optional number center_x_ratioIn)
Python: void ImGui_SetScrollHereX(ImGui_Context* ctx, double* center_x_ratioInOptional)
Description:Default values: center_x_ratio = 0.5
| Parameters: |
| ImGui_Context ctx | - | |
| optional number center_x_ratioIn | - | |
^
ImGui_SetScrollHereYFunctioncall:
C: void ImGui_SetScrollHereY(ImGui_Context* ctx, double* center_y_ratioInOptional)
EEL2: extension_api("ImGui_SetScrollHereY", ImGui_Context ctx, optional center_y_ratioIn)
Lua: reaper.ImGui_SetScrollHereY(ImGui_Context ctx, optional number center_y_ratioIn)
Python: void ImGui_SetScrollHereY(ImGui_Context* ctx, double* center_y_ratioInOptional)
Description:Default values: center_y_ratio = 0.5
| Parameters: |
| ImGui_Context ctx | - | |
| optional number center_y_ratioIn | - | |
^
ImGui_SetScrollXFunctioncall:
C: void ImGui_SetScrollX(ImGui_Context* ctx, double scroll_x)
EEL2: extension_api("ImGui_SetScrollX", ImGui_Context ctx, scroll_x)
Lua: reaper.ImGui_SetScrollX(ImGui_Context ctx, number scroll_x)
Python: void ImGui_SetScrollX(ImGui_Context* ctx, double scroll_x)
Description:Set scrolling amount [0 .. GetScrollMaxX()]
| Parameters: |
| ImGui_Context ctx | - | |
| number scroll_x | - | |
^
ImGui_SetScrollYFunctioncall:
C: void ImGui_SetScrollY(ImGui_Context* ctx, double scroll_y)
EEL2: extension_api("ImGui_SetScrollY", ImGui_Context ctx, scroll_y)
Lua: reaper.ImGui_SetScrollY(ImGui_Context ctx, number scroll_y)
Python: void ImGui_SetScrollY(ImGui_Context* ctx, double scroll_y)
Description:Set scrolling amount [0 .. GetScrollMaxY()]
| Parameters: |
| ImGui_Context ctx | - | |
| number scroll_y | - | |
^
ImGui_SetTabItemClosedFunctioncall:
C: void ImGui_SetTabItemClosed(ImGui_Context* ctx, const char* tab_or_docked_window_label)
EEL2: extension_api("ImGui_SetTabItemClosed", ImGui_Context ctx, "tab_or_docked_window_label")
Lua: reaper.ImGui_SetTabItemClosed(ImGui_Context ctx, string tab_or_docked_window_label)
Python: void ImGui_SetTabItemClosed(ImGui_Context* ctx, const char* tab_or_docked_window_label)
Description:Notify TabBar or Docking system of a closed tab/window ahead (useful to reduce visual flicker on reorderable tab bars). For tab-bar: call after BeginTabBar() and before Tab submissions. Otherwise call with a window name.
| Parameters: |
| ImGui_Context ctx | - | |
| string tab_or_docked_window_label | - | |
^
ImGui_SetTooltipFunctioncall:
C: void ImGui_SetTooltip(ImGui_Context* ctx, const char* text)
EEL2: extension_api("ImGui_SetTooltip", ImGui_Context ctx, "text")
Lua: reaper.ImGui_SetTooltip(ImGui_Context ctx, string text)
Python: void ImGui_SetTooltip(ImGui_Context* ctx, const char* text)
Description:Set a text-only tooltip, typically use with ImGui_IsItemHovered(). override any previous call to SetTooltip().
| Parameters: |
| ImGui_Context ctx | - | |
| string text | - | |
^
ImGui_SetWindowCollapsedFunctioncall:
C: void ImGui_SetWindowCollapsed(ImGui_Context* ctx, const char* name, bool collapsed, int* condInOptional)
EEL2: extension_api("ImGui_SetWindowCollapsed", ImGui_Context ctx, "name", bool collapsed, optional int condIn)
Lua: reaper.ImGui_SetWindowCollapsed(ImGui_Context ctx, string name, boolean collapsed, optional number condIn)
Python: void ImGui_SetWindowCollapsed(ImGui_Context* ctx, const char* name, bool collapsed, int* condInOptional)
Description:Default values: cond = ImGui_Cond_Always
| Parameters: |
| ImGui_Context ctx | - | |
| string name | - | |
| boolean collapsed | - | |
| optional number condIn | - | |
^
ImGui_SetWindowFocusFunctioncall:
C: void ImGui_SetWindowFocus(ImGui_Context* ctx, const char* name)
EEL2: extension_api("ImGui_SetWindowFocus", ImGui_Context ctx, "name")
Lua: reaper.ImGui_SetWindowFocus(ImGui_Context ctx, string name)
Python: void ImGui_SetWindowFocus(ImGui_Context* ctx, const char* name)
Description:
| Parameters: |
| ImGui_Context ctx | - | |
| string name | - | |
^
ImGui_SetWindowPosFunctioncall:
C: void ImGui_SetWindowPos(ImGui_Context* ctx, const char* name, double pos_x, double pos_y, int* condInOptional)
EEL2: extension_api("ImGui_SetWindowPos", ImGui_Context ctx, "name", pos_x, pos_y, optional int condIn)
Lua: reaper.ImGui_SetWindowPos(ImGui_Context ctx, string name, number pos_x, number pos_y, optional number condIn)
Python: void ImGui_SetWindowPos(ImGui_Context* ctx, const char* name, double pos_x, double pos_y, int* condInOptional)
Description:Default values: cond = ImGui_Cond_Always
| Parameters: |
| ImGui_Context ctx | - | |
| string name | - | |
| number pos_x | - | |
| number pos_y | - | |
| optional number condIn | - | |
^
ImGui_SetWindowSizeFunctioncall:
C: void ImGui_SetWindowSize(ImGui_Context* ctx, const char* name, double size_w, double size_h, int* condInOptional)
EEL2: extension_api("ImGui_SetWindowSize", ImGui_Context ctx, "name", size_w, size_h, optional int condIn)
Lua: reaper.ImGui_SetWindowSize(ImGui_Context ctx, string name, number size_w, number size_h, optional number condIn)
Python: void ImGui_SetWindowSize(ImGui_Context* ctx, const char* name, double size_w, double size_h, int* condInOptional)
Description:Default values: cond = ImGui_Cond_Always
| Parameters: |
| ImGui_Context ctx | - | |
| string name | - | |
| number size_w | - | |
| number size_h | - | |
| optional number condIn | - | |
^
ImGui_ShowMetricsWindowFunctioncall:
C: void ImGui_ShowMetricsWindow(ImGui_Context* ctx, bool* p_openInOptional)
EEL2: extension_api("ImGui_ShowMetricsWindow", ImGui_Context ctx, optional bool p_openIn)
Lua: reaper.ImGui_ShowMetricsWindow(ImGui_Context ctx, optional boolean p_openIn)
Python: void ImGui_ShowMetricsWindow(ImGui_Context* ctx, bool* p_openInOptional)
Description:Default values: p_open = nil
| Parameters: |
| ImGui_Context ctx | - | |
| optional boolean p_openIn | - | |
^
ImGui_SliderAngleFunctioncall:
C: bool ImGui_SliderAngle(ImGui_Context* ctx, const char* label, double* v_radInOut, double* v_degrees_minInOptional, double* v_degrees_maxInOptional, const char* formatInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_SliderAngle", ImGui_Context ctx, "label", &v_rad, optional v_degrees_minIn, optional v_degrees_maxIn, optional "formatIn", optional int flagsIn)
Lua: boolean retval, number v_rad = reaper.ImGui_SliderAngle(ImGui_Context ctx, string label, number v_rad, optional number v_degrees_minIn, optional number v_degrees_maxIn, optional string formatIn, optional number flagsIn)
Python: bool ImGui_SliderAngle(ImGui_Context* ctx, const char* label, double* v_radInOut, double* v_degrees_minInOptional, double* v_degrees_maxInOptional, const char* formatInOptional, int* flagsInOptional)
Description:Default values: v_degrees_min = -360.0, v_degrees_max = +360.0, format = '%.0f deg', flags = ImGui_SliderFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number v_rad | - | |
| optional number v_degrees_minIn | - | |
| optional number v_degrees_maxIn | - | |
| optional string formatIn | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number v_rad | - | - |
^
ImGui_SliderDoubleFunctioncall:
C: bool ImGui_SliderDouble(ImGui_Context* ctx, const char* label, double* vInOut, double v_min, double v_max, const char* formatInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_SliderDouble", ImGui_Context ctx, "label", &v, v_min, v_max, optional "formatIn", optional int flagsIn)
Lua: boolean retval, number v = reaper.ImGui_SliderDouble(ImGui_Context ctx, string label, number v, number v_min, number v_max, optional string formatIn, optional number flagsIn)
Python: bool ImGui_SliderDouble(ImGui_Context* ctx, const char* label, double* vInOut, double v_min, double v_max, const char* formatInOptional, int* flagsInOptional)
Description:Default values: format = '%.3f', flags = ImGui_SliderFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number v | - | |
| number v_min | - | |
| number v_max | - | |
| optional string formatIn | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number v | - | - |
^
ImGui_SliderDouble2Functioncall:
C: bool ImGui_SliderDouble2(ImGui_Context* ctx, const char* label, double* v1InOut, double* v2InOut, double v_min, double v_max, const char* formatInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_SliderDouble2", ImGui_Context ctx, "label", &v1, &v2, v_min, v_max, optional "formatIn", optional int flagsIn)
Lua: boolean retval, number v1, number v2 = reaper.ImGui_SliderDouble2(ImGui_Context ctx, string label, number v1, number v2, number v_min, number v_max, optional string formatIn, optional number flagsIn)
Python: bool ImGui_SliderDouble2(ImGui_Context* ctx, const char* label, double* v1InOut, double* v2InOut, double v_min, double v_max, const char* formatInOptional, int* flagsInOptional)
Description:Default values: format = '%.3f', flags = ImGui_SliderFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number v1 | - | |
| number v2 | - | |
| number v_min | - | |
| number v_max | - | |
| optional string formatIn | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number v1 | - | |
| number v2 | - | - |
^
ImGui_SliderDouble3Functioncall:
C: bool ImGui_SliderDouble3(ImGui_Context* ctx, const char* label, double* v1InOut, double* v2InOut, double* v3InOut, double v_min, double v_max, const char* formatInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_SliderDouble3", ImGui_Context ctx, "label", &v1, &v2, &v3, v_min, v_max, optional "formatIn", optional int flagsIn)
Lua: boolean retval, number v1, number v2, number v3 = reaper.ImGui_SliderDouble3(ImGui_Context ctx, string label, number v1, number v2, number v3, number v_min, number v_max, optional string formatIn, optional number flagsIn)
Python: bool ImGui_SliderDouble3(ImGui_Context* ctx, const char* label, double* v1InOut, double* v2InOut, double* v3InOut, double v_min, double v_max, const char* formatInOptional, int* flagsInOptional)
Description:Default values: format = '%.3f', flags = ImGui_SliderFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number v1 | - | |
| number v2 | - | |
| number v3 | - | |
| number v_min | - | |
| number v_max | - | |
| optional string formatIn | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number v1 | - | |
| number v2 | - | |
| number v3 | - | - |
^
ImGui_SliderDouble4Functioncall:
C: bool ImGui_SliderDouble4(ImGui_Context* ctx, const char* label, double* v1InOut, double* v2InOut, double* v3InOut, double* v4InOut, double v_min, double v_max, const char* formatInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_SliderDouble4", ImGui_Context ctx, "label", &v1, &v2, &v3, &v4, v_min, v_max, optional "formatIn", optional int flagsIn)
Lua: boolean retval, number v1, number v2, number v3, number v4 = reaper.ImGui_SliderDouble4(ImGui_Context ctx, string label, number v1, number v2, number v3, number v4, number v_min, number v_max, optional string formatIn, optional number flagsIn)
Python: bool ImGui_SliderDouble4(ImGui_Context* ctx, const char* label, double* v1InOut, double* v2InOut, double* v3InOut, double* v4InOut, double v_min, double v_max, const char* formatInOptional, int* flagsInOptional)
Description:Default values: format = '%.3f', flags = ImGui_SliderFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number v1 | - | |
| number v2 | - | |
| number v3 | - | |
| number v4 | - | |
| number v_min | - | |
| number v_max | - | |
| optional string formatIn | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number v1 | - | |
| number v2 | - | |
| number v3 | - | |
| number v4 | - | - |
^
ImGui_SliderDoubleNFunctioncall:
C: bool ImGui_SliderDoubleN(ImGui_Context* ctx, const char* label, reaper_array* values, double v_min, double v_max, const char* formatInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_SliderDoubleN", ImGui_Context ctx, "label", reaper_array values, v_min, v_max, optional "formatIn", optional int flagsIn)
Lua: boolean reaper.ImGui_SliderDoubleN(ImGui_Context ctx, string labelreaper_array values, number v_min, number v_max, optional string formatIn, optional number flagsIn)
Python: bool ImGui_SliderDoubleN(ImGui_Context* ctx, const char* label, reaper_array* values, double v_min, double v_max, const char* formatInOptional, int* flagsInOptional)
Description:Default values: format = '%.3f', flags = ImGui_SliderFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string labelreaper_array values | - | |
| number v_min | - | |
| number v_max | - | |
| optional string formatIn | - | |
| optional number flagsIn | - | |
^
ImGui_SliderFlags_AlwaysClampFunctioncall:
C: int ImGui_SliderFlags_AlwaysClamp()
EEL2: int extension_api("ImGui_SliderFlags_AlwaysClamp")
Lua: integer reaper.ImGui_SliderFlags_AlwaysClamp()
Python: int ImGui_SliderFlags_AlwaysClamp()
Description:Clamp value to min/max bounds when input manually with CTRL+Click. By default CTRL+Click allows going out of bounds.
^
ImGui_SliderFlags_LogarithmicFunctioncall:
C: int ImGui_SliderFlags_Logarithmic()
EEL2: int extension_api("ImGui_SliderFlags_Logarithmic")
Lua: integer reaper.ImGui_SliderFlags_Logarithmic()
Python: int ImGui_SliderFlags_Logarithmic()
Description:Make the widget logarithmic (linear otherwise). Consider using ImGuiSliderFlags_NoRoundToFormat with this if using a format-string with small amount of digits.
^
ImGui_SliderFlags_NoInputFunctioncall:
C: int ImGui_SliderFlags_NoInput()
EEL2: int extension_api("ImGui_SliderFlags_NoInput")
Lua: integer reaper.ImGui_SliderFlags_NoInput()
Python: int ImGui_SliderFlags_NoInput()
Description:Disable CTRL+Click or Enter key allowing to input text directly into the widget
^
ImGui_SliderFlags_NoRoundToFormatFunctioncall:
C: int ImGui_SliderFlags_NoRoundToFormat()
EEL2: int extension_api("ImGui_SliderFlags_NoRoundToFormat")
Lua: integer reaper.ImGui_SliderFlags_NoRoundToFormat()
Python: int ImGui_SliderFlags_NoRoundToFormat()
Description:Disable rounding underlying value to match precision of the display format string (e.g. %.3f values are rounded to those 3 digits)
^
ImGui_SliderFlags_NoneFunctioncall:
C: int ImGui_SliderFlags_None()
EEL2: int extension_api("ImGui_SliderFlags_None")
Lua: integer reaper.ImGui_SliderFlags_None()
Python: int ImGui_SliderFlags_None()
Description:for DragFloat(), DragInt(), SliderFloat(), SliderInt() etc.
^
ImGui_SliderIntFunctioncall:
C: bool ImGui_SliderInt(ImGui_Context* ctx, const char* label, int* vInOut, int v_min, int v_max, const char* formatInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_SliderInt", ImGui_Context ctx, "label", int &v, int v_min, int v_max, optional "formatIn", optional int flagsIn)
Lua: boolean retval, number v = reaper.ImGui_SliderInt(ImGui_Context ctx, string label, number v, integer v_min, integer v_max, optional string formatIn, optional number flagsIn)
Python: bool ImGui_SliderInt(ImGui_Context* ctx, const char* label, int* vInOut, int v_min, int v_max, const char* formatInOptional, int* flagsInOptional)
Description:Default values: format = '%d', flags = ImGui_SliderFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number v | - | |
| integer v_min | - | |
| integer v_max | - | |
| optional string formatIn | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number v | - | - |
^
ImGui_SliderInt2Functioncall:
C: bool ImGui_SliderInt2(ImGui_Context* ctx, const char* label, int* v1InOut, int* v2InOut, int v_min, int v_max, const char* formatInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_SliderInt2", ImGui_Context ctx, "label", int &v1, int &v2, int v_min, int v_max, optional "formatIn", optional int flagsIn)
Lua: boolean retval, number v1, number v2 = reaper.ImGui_SliderInt2(ImGui_Context ctx, string label, number v1, number v2, integer v_min, integer v_max, optional string formatIn, optional number flagsIn)
Python: bool ImGui_SliderInt2(ImGui_Context* ctx, const char* label, int* v1InOut, int* v2InOut, int v_min, int v_max, const char* formatInOptional, int* flagsInOptional)
Description:Default values: format = '%d', flags = ImGui_SliderFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number v1 | - | |
| number v2 | - | |
| integer v_min | - | |
| integer v_max | - | |
| optional string formatIn | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number v1 | - | |
| number v2 | - | - |
^
ImGui_SliderInt3Functioncall:
C: bool ImGui_SliderInt3(ImGui_Context* ctx, const char* label, int* v1InOut, int* v2InOut, int* v3InOut, int v_min, int v_max, const char* formatInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_SliderInt3", ImGui_Context ctx, "label", int &v1, int &v2, int &v3, int v_min, int v_max, optional "formatIn", optional int flagsIn)
Lua: boolean retval, number v1, number v2, number v3 = reaper.ImGui_SliderInt3(ImGui_Context ctx, string label, number v1, number v2, number v3, integer v_min, integer v_max, optional string formatIn, optional number flagsIn)
Python: bool ImGui_SliderInt3(ImGui_Context* ctx, const char* label, int* v1InOut, int* v2InOut, int* v3InOut, int v_min, int v_max, const char* formatInOptional, int* flagsInOptional)
Description:Default values: format = '%d', flags = ImGui_SliderFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number v1 | - | |
| number v2 | - | |
| number v3 | - | |
| integer v_min | - | |
| integer v_max | - | |
| optional string formatIn | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number v1 | - | |
| number v2 | - | |
| number v3 | - | - |
^
ImGui_SliderInt4Functioncall:
C: bool ImGui_SliderInt4(ImGui_Context* ctx, const char* label, int* v1InOut, int* v2InOut, int* v3InOut, int* v4InOut, int v_min, int v_max, const char* formatInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_SliderInt4", ImGui_Context ctx, "label", int &v1, int &v2, int &v3, int &v4, int v_min, int v_max, optional "formatIn", optional int flagsIn)
Lua: boolean retval, number v1, number v2, number v3, number v4 = reaper.ImGui_SliderInt4(ImGui_Context ctx, string label, number v1, number v2, number v3, number v4, integer v_min, integer v_max, optional string formatIn, optional number flagsIn)
Python: bool ImGui_SliderInt4(ImGui_Context* ctx, const char* label, int* v1InOut, int* v2InOut, int* v3InOut, int* v4InOut, int v_min, int v_max, const char* formatInOptional, int* flagsInOptional)
Description:Default values: format = '%d', flags = ImGui_SliderFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number v1 | - | |
| number v2 | - | |
| number v3 | - | |
| number v4 | - | |
| integer v_min | - | |
| integer v_max | - | |
| optional string formatIn | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number v1 | - | |
| number v2 | - | |
| number v3 | - | |
| number v4 | - | - |
^
ImGui_SmallButtonFunctioncall:
C: bool ImGui_SmallButton(ImGui_Context* ctx, const char* label)
EEL2: bool extension_api("ImGui_SmallButton", ImGui_Context ctx, "label")
Lua: boolean reaper.ImGui_SmallButton(ImGui_Context ctx, string label)
Python: bool ImGui_SmallButton(ImGui_Context* ctx, const char* label)
Description:Button with FramePadding=(0,0) to easily embed within text
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
^
ImGui_SortDirection_AscendingFunctioncall:
C: int ImGui_SortDirection_Ascending()
EEL2: int extension_api("ImGui_SortDirection_Ascending")
Lua: integer reaper.ImGui_SortDirection_Ascending()
Python: int ImGui_SortDirection_Ascending()
Description:Ascending = 0->9, A->Z etc.
^
ImGui_SortDirection_DescendingFunctioncall:
C: int ImGui_SortDirection_Descending()
EEL2: int extension_api("ImGui_SortDirection_Descending")
Lua: integer reaper.ImGui_SortDirection_Descending()
Python: int ImGui_SortDirection_Descending()
Description:Descending = 9->0, Z->A etc.
^
ImGui_SortDirection_NoneFunctioncall:
C: int ImGui_SortDirection_None()
EEL2: int extension_api("ImGui_SortDirection_None")
Lua: integer reaper.ImGui_SortDirection_None()
Python: int ImGui_SortDirection_None()
Description:Python: Int ImGui_SortDirection_None()
^
ImGui_SpacingFunctioncall:
C: void ImGui_Spacing(ImGui_Context* ctx)
EEL2: extension_api("ImGui_Spacing", ImGui_Context ctx)
Lua: reaper.ImGui_Spacing(ImGui_Context ctx)
Python: void ImGui_Spacing(ImGui_Context* ctx)
Description:Add vertical spacing.
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_StyleVar_AlphaFunctioncall:
C: int ImGui_StyleVar_Alpha()
EEL2: int extension_api("ImGui_StyleVar_Alpha")
Lua: integer reaper.ImGui_StyleVar_Alpha()
Python: int ImGui_StyleVar_Alpha()
Description:Global alpha applies to everything in Dear ImGui.
^
ImGui_StyleVar_ButtonTextAlignFunctioncall:
C: int ImGui_StyleVar_ButtonTextAlign()
EEL2: int extension_api("ImGui_StyleVar_ButtonTextAlign")
Lua: integer reaper.ImGui_StyleVar_ButtonTextAlign()
Python: int ImGui_StyleVar_ButtonTextAlign()
Description:Alignment of button text when button is larger than text. Defaults to (0.5f, 0.5f) (centered).
^
ImGui_StyleVar_CellPaddingFunctioncall:
C: int ImGui_StyleVar_CellPadding()
EEL2: int extension_api("ImGui_StyleVar_CellPadding")
Lua: integer reaper.ImGui_StyleVar_CellPadding()
Python: int ImGui_StyleVar_CellPadding()
Description:Padding within a table cell
^
ImGui_StyleVar_ChildBorderSizeFunctioncall:
C: int ImGui_StyleVar_ChildBorderSize()
EEL2: int extension_api("ImGui_StyleVar_ChildBorderSize")
Lua: integer reaper.ImGui_StyleVar_ChildBorderSize()
Python: int ImGui_StyleVar_ChildBorderSize()
Description:Thickness of border around child windows. Generally set to 0.0f or 1.0f. (Other values are not well tested and more CPU/GPU costly).
^
ImGui_StyleVar_ChildRoundingFunctioncall:
C: int ImGui_StyleVar_ChildRounding()
EEL2: int extension_api("ImGui_StyleVar_ChildRounding")
Lua: integer reaper.ImGui_StyleVar_ChildRounding()
Python: int ImGui_StyleVar_ChildRounding()
Description:Radius of child window corners rounding. Set to 0.0f to have rectangular windows.
^
ImGui_StyleVar_FrameBorderSizeFunctioncall:
C: int ImGui_StyleVar_FrameBorderSize()
EEL2: int extension_api("ImGui_StyleVar_FrameBorderSize")
Lua: integer reaper.ImGui_StyleVar_FrameBorderSize()
Python: int ImGui_StyleVar_FrameBorderSize()
Description:Thickness of border around frames. Generally set to 0.0f or 1.0f. (Other values are not well tested and more CPU/GPU costly).
^
ImGui_StyleVar_FramePaddingFunctioncall:
C: int ImGui_StyleVar_FramePadding()
EEL2: int extension_api("ImGui_StyleVar_FramePadding")
Lua: integer reaper.ImGui_StyleVar_FramePadding()
Python: int ImGui_StyleVar_FramePadding()
Description:Padding within a framed rectangle (used by most widgets).
^
ImGui_StyleVar_FrameRoundingFunctioncall:
C: int ImGui_StyleVar_FrameRounding()
EEL2: int extension_api("ImGui_StyleVar_FrameRounding")
Lua: integer reaper.ImGui_StyleVar_FrameRounding()
Python: int ImGui_StyleVar_FrameRounding()
Description:Radius of frame corners rounding. Set to 0.0f to have rectangular frame (used by most widgets).
^
ImGui_StyleVar_GrabMinSizeFunctioncall:
C: int ImGui_StyleVar_GrabMinSize()
EEL2: int extension_api("ImGui_StyleVar_GrabMinSize")
Lua: integer reaper.ImGui_StyleVar_GrabMinSize()
Python: int ImGui_StyleVar_GrabMinSize()
Description:Minimum width/height of a grab box for slider/scrollbar.
^
ImGui_StyleVar_GrabRoundingFunctioncall:
C: int ImGui_StyleVar_GrabRounding()
EEL2: int extension_api("ImGui_StyleVar_GrabRounding")
Lua: integer reaper.ImGui_StyleVar_GrabRounding()
Python: int ImGui_StyleVar_GrabRounding()
Description:Radius of grabs corners rounding. Set to 0.0f to have rectangular slider grabs.
^
ImGui_StyleVar_IndentSpacingFunctioncall:
C: int ImGui_StyleVar_IndentSpacing()
EEL2: int extension_api("ImGui_StyleVar_IndentSpacing")
Lua: integer reaper.ImGui_StyleVar_IndentSpacing()
Python: int ImGui_StyleVar_IndentSpacing()
Description:Horizontal indentation when e.g. entering a tree node. Generally == (FontSize + FramePadding.x*2).
^
ImGui_StyleVar_ItemInnerSpacingFunctioncall:
C: int ImGui_StyleVar_ItemInnerSpacing()
EEL2: int extension_api("ImGui_StyleVar_ItemInnerSpacing")
Lua: integer reaper.ImGui_StyleVar_ItemInnerSpacing()
Python: int ImGui_StyleVar_ItemInnerSpacing()
Description:Horizontal and vertical spacing between within elements of a composed widget (e.g. a slider and its label).
^
ImGui_StyleVar_ItemSpacingFunctioncall:
C: int ImGui_StyleVar_ItemSpacing()
EEL2: int extension_api("ImGui_StyleVar_ItemSpacing")
Lua: integer reaper.ImGui_StyleVar_ItemSpacing()
Python: int ImGui_StyleVar_ItemSpacing()
Description:Horizontal and vertical spacing between widgets/lines.
^
ImGui_StyleVar_PopupBorderSizeFunctioncall:
C: int ImGui_StyleVar_PopupBorderSize()
EEL2: int extension_api("ImGui_StyleVar_PopupBorderSize")
Lua: integer reaper.ImGui_StyleVar_PopupBorderSize()
Python: int ImGui_StyleVar_PopupBorderSize()
Description:Thickness of border around popup/tooltip windows. Generally set to 0.0f or 1.0f. (Other values are not well tested and more CPU/GPU costly).
^
ImGui_StyleVar_PopupRoundingFunctioncall:
C: int ImGui_StyleVar_PopupRounding()
EEL2: int extension_api("ImGui_StyleVar_PopupRounding")
Lua: integer reaper.ImGui_StyleVar_PopupRounding()
Python: int ImGui_StyleVar_PopupRounding()
Description:Radius of popup window corners rounding. (Note that tooltip windows use WindowRounding)
^
ImGui_StyleVar_ScrollbarRoundingFunctioncall:
C: int ImGui_StyleVar_ScrollbarRounding()
EEL2: int extension_api("ImGui_StyleVar_ScrollbarRounding")
Lua: integer reaper.ImGui_StyleVar_ScrollbarRounding()
Python: int ImGui_StyleVar_ScrollbarRounding()
Description:Radius of grab corners for scrollbar.
^
ImGui_StyleVar_ScrollbarSizeFunctioncall:
C: int ImGui_StyleVar_ScrollbarSize()
EEL2: int extension_api("ImGui_StyleVar_ScrollbarSize")
Lua: integer reaper.ImGui_StyleVar_ScrollbarSize()
Python: int ImGui_StyleVar_ScrollbarSize()
Description:Width of the vertical scrollbar, Height of the horizontal scrollbar.
^
ImGui_StyleVar_SelectableTextAlignFunctioncall:
C: int ImGui_StyleVar_SelectableTextAlign()
EEL2: int extension_api("ImGui_StyleVar_SelectableTextAlign")
Lua: integer reaper.ImGui_StyleVar_SelectableTextAlign()
Python: int ImGui_StyleVar_SelectableTextAlign()
Description:Alignment of selectable text. Defaults to (0.0f, 0.0f) (top-left aligned). It's generally important to keep this left-aligned if you want to lay multiple items on a same line.
^
ImGui_StyleVar_TabRoundingFunctioncall:
C: int ImGui_StyleVar_TabRounding()
EEL2: int extension_api("ImGui_StyleVar_TabRounding")
Lua: integer reaper.ImGui_StyleVar_TabRounding()
Python: int ImGui_StyleVar_TabRounding()
Description:Radius of upper corners of a tab. Set to 0.0f to have rectangular tabs.
^
ImGui_StyleVar_WindowBorderSizeFunctioncall:
C: int ImGui_StyleVar_WindowBorderSize()
EEL2: int extension_api("ImGui_StyleVar_WindowBorderSize")
Lua: integer reaper.ImGui_StyleVar_WindowBorderSize()
Python: int ImGui_StyleVar_WindowBorderSize()
Description:Thickness of border around windows. Generally set to 0.0f or 1.0f. (Other values are not well tested and more CPU/GPU costly).
^
ImGui_StyleVar_WindowMinSizeFunctioncall:
C: int ImGui_StyleVar_WindowMinSize()
EEL2: int extension_api("ImGui_StyleVar_WindowMinSize")
Lua: integer reaper.ImGui_StyleVar_WindowMinSize()
Python: int ImGui_StyleVar_WindowMinSize()
Description:Minimum window size. This is a global setting. If you want to constraint individual windows, use SetNextWindowSizeConstraints().
^
ImGui_StyleVar_WindowPaddingFunctioncall:
C: int ImGui_StyleVar_WindowPadding()
EEL2: int extension_api("ImGui_StyleVar_WindowPadding")
Lua: integer reaper.ImGui_StyleVar_WindowPadding()
Python: int ImGui_StyleVar_WindowPadding()
Description:Padding within a window.
^
ImGui_StyleVar_WindowRoundingFunctioncall:
C: int ImGui_StyleVar_WindowRounding()
EEL2: int extension_api("ImGui_StyleVar_WindowRounding")
Lua: integer reaper.ImGui_StyleVar_WindowRounding()
Python: int ImGui_StyleVar_WindowRounding()
Description:Radius of window corners rounding. Set to 0.0f to have rectangular windows. Large values tend to lead to variety of artifacts and are not recommended.
^
ImGui_StyleVar_WindowTitleAlignFunctioncall:
C: int ImGui_StyleVar_WindowTitleAlign()
EEL2: int extension_api("ImGui_StyleVar_WindowTitleAlign")
Lua: integer reaper.ImGui_StyleVar_WindowTitleAlign()
Python: int ImGui_StyleVar_WindowTitleAlign()
Description:Alignment for title bar text. Defaults to (0.0f,0.5f) for left-aligned,vertically centered.
^
ImGui_TabBarFlags_AutoSelectNewTabsFunctioncall:
C: int ImGui_TabBarFlags_AutoSelectNewTabs()
EEL2: int extension_api("ImGui_TabBarFlags_AutoSelectNewTabs")
Lua: integer reaper.ImGui_TabBarFlags_AutoSelectNewTabs()
Python: int ImGui_TabBarFlags_AutoSelectNewTabs()
Description:Automatically select new tabs when they appear
^
ImGui_TabBarFlags_FittingPolicyResizeDownFunctioncall:
C: int ImGui_TabBarFlags_FittingPolicyResizeDown()
EEL2: int extension_api("ImGui_TabBarFlags_FittingPolicyResizeDown")
Lua: integer reaper.ImGui_TabBarFlags_FittingPolicyResizeDown()
Python: int ImGui_TabBarFlags_FittingPolicyResizeDown()
Description:Resize tabs when they don't fit
^
ImGui_TabBarFlags_FittingPolicyScrollFunctioncall:
C: int ImGui_TabBarFlags_FittingPolicyScroll()
EEL2: int extension_api("ImGui_TabBarFlags_FittingPolicyScroll")
Lua: integer reaper.ImGui_TabBarFlags_FittingPolicyScroll()
Python: int ImGui_TabBarFlags_FittingPolicyScroll()
Description:Add scroll buttons when tabs don't fit
^
ImGui_TabBarFlags_NoCloseWithMiddleMouseButtonFunctioncall:
C: int ImGui_TabBarFlags_NoCloseWithMiddleMouseButton()
EEL2: int extension_api("ImGui_TabBarFlags_NoCloseWithMiddleMouseButton")
Lua: integer reaper.ImGui_TabBarFlags_NoCloseWithMiddleMouseButton()
Python: int ImGui_TabBarFlags_NoCloseWithMiddleMouseButton()
Description:Disable behavior of closing tabs (that are submitted with p_open != NULL) with middle mouse button. You can still repro this behavior on user's side with if (IsItemHovered() && IsMouseClicked(2)) *p_open = false.
^
ImGui_TabBarFlags_NoTabListScrollingButtonsFunctioncall:
C: int ImGui_TabBarFlags_NoTabListScrollingButtons()
EEL2: int extension_api("ImGui_TabBarFlags_NoTabListScrollingButtons")
Lua: integer reaper.ImGui_TabBarFlags_NoTabListScrollingButtons()
Python: int ImGui_TabBarFlags_NoTabListScrollingButtons()
Description:Disable scrolling buttons (apply when fitting policy is ImGuiTabBarFlags_FittingPolicyScroll)
^
ImGui_TabBarFlags_NoTooltipFunctioncall:
C: int ImGui_TabBarFlags_NoTooltip()
EEL2: int extension_api("ImGui_TabBarFlags_NoTooltip")
Lua: integer reaper.ImGui_TabBarFlags_NoTooltip()
Python: int ImGui_TabBarFlags_NoTooltip()
Description:Disable tooltips when hovering a tab
^
ImGui_TabBarFlags_NoneFunctioncall:
C: int ImGui_TabBarFlags_None()
EEL2: int extension_api("ImGui_TabBarFlags_None")
Lua: integer reaper.ImGui_TabBarFlags_None()
Python: int ImGui_TabBarFlags_None()
Description:Flags: for BeginTabBar()
^
ImGui_TabBarFlags_ReorderableFunctioncall:
C: int ImGui_TabBarFlags_Reorderable()
EEL2: int extension_api("ImGui_TabBarFlags_Reorderable")
Lua: integer reaper.ImGui_TabBarFlags_Reorderable()
Python: int ImGui_TabBarFlags_Reorderable()
Description:Allow manually dragging tabs to re-order them + New tabs are appended at the end of list
^
ImGui_TabBarFlags_TabListPopupButtonFunctioncall:
C: int ImGui_TabBarFlags_TabListPopupButton()
EEL2: int extension_api("ImGui_TabBarFlags_TabListPopupButton")
Lua: integer reaper.ImGui_TabBarFlags_TabListPopupButton()
Python: int ImGui_TabBarFlags_TabListPopupButton()
Description:Disable buttons to open the tab list popup
^
ImGui_TabItemButtonFunctioncall:
C: bool ImGui_TabItemButton(ImGui_Context* ctx, const char* label, int* flagsInOptional)
EEL2: bool extension_api("ImGui_TabItemButton", ImGui_Context ctx, "label", optional int flagsIn)
Lua: boolean reaper.ImGui_TabItemButton(ImGui_Context ctx, string label, optional number flagsIn)
Python: bool ImGui_TabItemButton(ImGui_Context* ctx, const char* label, int* flagsInOptional)
Description:Default values: flags = ImGui_TabItemFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| optional number flagsIn | - | |
^
ImGui_TabItemFlags_LeadingFunctioncall:
C: int ImGui_TabItemFlags_Leading()
EEL2: int extension_api("ImGui_TabItemFlags_Leading")
Lua: integer reaper.ImGui_TabItemFlags_Leading()
Python: int ImGui_TabItemFlags_Leading()
Description:Enforce the tab position to the left of the tab bar (after the tab list popup button)
^
ImGui_TabItemFlags_NoCloseWithMiddleMouseButtonFunctioncall:
C: int ImGui_TabItemFlags_NoCloseWithMiddleMouseButton()
EEL2: int extension_api("ImGui_TabItemFlags_NoCloseWithMiddleMouseButton")
Lua: integer reaper.ImGui_TabItemFlags_NoCloseWithMiddleMouseButton()
Python: int ImGui_TabItemFlags_NoCloseWithMiddleMouseButton()
Description:Disable behavior of closing tabs (that are submitted with p_open != NULL) with middle mouse button. You can still repro this behavior on user's side with if (IsItemHovered() && IsMouseClicked(2)) *p_open = false.
^
ImGui_TabItemFlags_NoPushIdFunctioncall:
C: int ImGui_TabItemFlags_NoPushId()
EEL2: int extension_api("ImGui_TabItemFlags_NoPushId")
Lua: integer reaper.ImGui_TabItemFlags_NoPushId()
Python: int ImGui_TabItemFlags_NoPushId()
Description:Don't call PushID(tab->ID)/PopID() on BeginTabItem()/EndTabItem()
^
ImGui_TabItemFlags_NoReorderFunctioncall:
C: int ImGui_TabItemFlags_NoReorder()
EEL2: int extension_api("ImGui_TabItemFlags_NoReorder")
Lua: integer reaper.ImGui_TabItemFlags_NoReorder()
Python: int ImGui_TabItemFlags_NoReorder()
Description:Disable reordering this tab or having another tab cross over this tab
^
ImGui_TabItemFlags_NoTooltipFunctioncall:
C: int ImGui_TabItemFlags_NoTooltip()
EEL2: int extension_api("ImGui_TabItemFlags_NoTooltip")
Lua: integer reaper.ImGui_TabItemFlags_NoTooltip()
Python: int ImGui_TabItemFlags_NoTooltip()
Description:Disable tooltip for the given tab
^
ImGui_TabItemFlags_NoneFunctioncall:
C: int ImGui_TabItemFlags_None()
EEL2: int extension_api("ImGui_TabItemFlags_None")
Lua: integer reaper.ImGui_TabItemFlags_None()
Python: int ImGui_TabItemFlags_None()
Description:Flags: for BeginTabItem()
^
ImGui_TabItemFlags_SetSelectedFunctioncall:
C: int ImGui_TabItemFlags_SetSelected()
EEL2: int extension_api("ImGui_TabItemFlags_SetSelected")
Lua: integer reaper.ImGui_TabItemFlags_SetSelected()
Python: int ImGui_TabItemFlags_SetSelected()
Description:Trigger flag to programmatically make the tab selected when calling BeginTabItem()
^
ImGui_TabItemFlags_TrailingFunctioncall:
C: int ImGui_TabItemFlags_Trailing()
EEL2: int extension_api("ImGui_TabItemFlags_Trailing")
Lua: integer reaper.ImGui_TabItemFlags_Trailing()
Python: int ImGui_TabItemFlags_Trailing()
Description:Enforce the tab position to the right of the tab bar (before the scrolling buttons)
^
ImGui_TabItemFlags_UnsavedDocumentFunctioncall:
C: int ImGui_TabItemFlags_UnsavedDocument()
EEL2: int extension_api("ImGui_TabItemFlags_UnsavedDocument")
Lua: integer reaper.ImGui_TabItemFlags_UnsavedDocument()
Python: int ImGui_TabItemFlags_UnsavedDocument()
Description:Append '*' to title without affecting the ID, as a convenience to avoid using the ### operator. Also: tab is selected on closure and closure is deferred by one frame to allow code to undo it without flicker.
^
ImGui_TableBgTarget_CellBgFunctioncall:
C: int ImGui_TableBgTarget_CellBg()
EEL2: int extension_api("ImGui_TableBgTarget_CellBg")
Lua: integer reaper.ImGui_TableBgTarget_CellBg()
Python: int ImGui_TableBgTarget_CellBg()
Description:Set cell background color (top-most color)
^
ImGui_TableBgTarget_NoneFunctioncall:
C: int ImGui_TableBgTarget_None()
EEL2: int extension_api("ImGui_TableBgTarget_None")
Lua: integer reaper.ImGui_TableBgTarget_None()
Python: int ImGui_TableBgTarget_None()
Description:If you set the color of RowBg1 or ColumnBg1 target, your color will blend over the RowBg0 color.
^
ImGui_TableBgTarget_RowBg0Functioncall:
C: int ImGui_TableBgTarget_RowBg0()
EEL2: int extension_api("ImGui_TableBgTarget_RowBg0")
Lua: integer reaper.ImGui_TableBgTarget_RowBg0()
Python: int ImGui_TableBgTarget_RowBg0()
Description:Set row background color 0 (generally used for background, automatically set when ImGuiTableFlags_RowBg is used)
^
ImGui_TableBgTarget_RowBg1Functioncall:
C: int ImGui_TableBgTarget_RowBg1()
EEL2: int extension_api("ImGui_TableBgTarget_RowBg1")
Lua: integer reaper.ImGui_TableBgTarget_RowBg1()
Python: int ImGui_TableBgTarget_RowBg1()
Description:Set row background color 1 (generally used for selection marking)
^
ImGui_TableColumnFlags_DefaultHideFunctioncall:
C: int ImGui_TableColumnFlags_DefaultHide()
EEL2: int extension_api("ImGui_TableColumnFlags_DefaultHide")
Lua: integer reaper.ImGui_TableColumnFlags_DefaultHide()
Python: int ImGui_TableColumnFlags_DefaultHide()
Description:Default as a hidden/disabled column.
^
ImGui_TableColumnFlags_DefaultSortFunctioncall:
C: int ImGui_TableColumnFlags_DefaultSort()
EEL2: int extension_api("ImGui_TableColumnFlags_DefaultSort")
Lua: integer reaper.ImGui_TableColumnFlags_DefaultSort()
Python: int ImGui_TableColumnFlags_DefaultSort()
Description:Default as a sorting column.
^
ImGui_TableColumnFlags_IndentDisableFunctioncall:
C: int ImGui_TableColumnFlags_IndentDisable()
EEL2: int extension_api("ImGui_TableColumnFlags_IndentDisable")
Lua: integer reaper.ImGui_TableColumnFlags_IndentDisable()
Python: int ImGui_TableColumnFlags_IndentDisable()
Description:Ignore current Indent value when entering cell (default for columns > 0). Indentation changes _within_ the cell will still be honored.
^
ImGui_TableColumnFlags_IndentEnableFunctioncall:
C: int ImGui_TableColumnFlags_IndentEnable()
EEL2: int extension_api("ImGui_TableColumnFlags_IndentEnable")
Lua: integer reaper.ImGui_TableColumnFlags_IndentEnable()
Python: int ImGui_TableColumnFlags_IndentEnable()
Description:Use current Indent value when entering cell (default for column 0).
^
ImGui_TableColumnFlags_IsEnabledFunctioncall:
C: int ImGui_TableColumnFlags_IsEnabled()
EEL2: int extension_api("ImGui_TableColumnFlags_IsEnabled")
Lua: integer reaper.ImGui_TableColumnFlags_IsEnabled()
Python: int ImGui_TableColumnFlags_IsEnabled()
Description:Status: is enabled == not hidden by user/api (referred to as "Hide" in _DefaultHide and _NoHide) flags.
^
ImGui_TableColumnFlags_IsHoveredFunctioncall:
C: int ImGui_TableColumnFlags_IsHovered()
EEL2: int extension_api("ImGui_TableColumnFlags_IsHovered")
Lua: integer reaper.ImGui_TableColumnFlags_IsHovered()
Python: int ImGui_TableColumnFlags_IsHovered()
Description:Status: is hovered by mouse
^
ImGui_TableColumnFlags_IsSortedFunctioncall:
C: int ImGui_TableColumnFlags_IsSorted()
EEL2: int extension_api("ImGui_TableColumnFlags_IsSorted")
Lua: integer reaper.ImGui_TableColumnFlags_IsSorted()
Python: int ImGui_TableColumnFlags_IsSorted()
Description:Status: is currently part of the sort specs
^
ImGui_TableColumnFlags_IsVisibleFunctioncall:
C: int ImGui_TableColumnFlags_IsVisible()
EEL2: int extension_api("ImGui_TableColumnFlags_IsVisible")
Lua: integer reaper.ImGui_TableColumnFlags_IsVisible()
Python: int ImGui_TableColumnFlags_IsVisible()
Description:Status: is visible == is enabled AND not clipped by scrolling.
^
ImGui_TableColumnFlags_NoClipFunctioncall:
C: int ImGui_TableColumnFlags_NoClip()
EEL2: int extension_api("ImGui_TableColumnFlags_NoClip")
Lua: integer reaper.ImGui_TableColumnFlags_NoClip()
Python: int ImGui_TableColumnFlags_NoClip()
Description:Disable clipping for this column (all NoClip columns will render in a same draw command).
^
ImGui_TableColumnFlags_NoHeaderWidthFunctioncall:
C: int ImGui_TableColumnFlags_NoHeaderWidth()
EEL2: int extension_api("ImGui_TableColumnFlags_NoHeaderWidth")
Lua: integer reaper.ImGui_TableColumnFlags_NoHeaderWidth()
Python: int ImGui_TableColumnFlags_NoHeaderWidth()
Description:Disable header text width contribution to automatic column width.
^
ImGui_TableColumnFlags_NoHideFunctioncall:
C: int ImGui_TableColumnFlags_NoHide()
EEL2: int extension_api("ImGui_TableColumnFlags_NoHide")
Lua: integer reaper.ImGui_TableColumnFlags_NoHide()
Python: int ImGui_TableColumnFlags_NoHide()
Description:Disable ability to hide/disable this column.
^
ImGui_TableColumnFlags_NoReorderFunctioncall:
C: int ImGui_TableColumnFlags_NoReorder()
EEL2: int extension_api("ImGui_TableColumnFlags_NoReorder")
Lua: integer reaper.ImGui_TableColumnFlags_NoReorder()
Python: int ImGui_TableColumnFlags_NoReorder()
Description:Disable manual reordering this column, this will also prevent other columns from crossing over this column.
^
ImGui_TableColumnFlags_NoResizeFunctioncall:
C: int ImGui_TableColumnFlags_NoResize()
EEL2: int extension_api("ImGui_TableColumnFlags_NoResize")
Lua: integer reaper.ImGui_TableColumnFlags_NoResize()
Python: int ImGui_TableColumnFlags_NoResize()
Description:Disable manual resizing.
^
ImGui_TableColumnFlags_NoSortFunctioncall:
C: int ImGui_TableColumnFlags_NoSort()
EEL2: int extension_api("ImGui_TableColumnFlags_NoSort")
Lua: integer reaper.ImGui_TableColumnFlags_NoSort()
Python: int ImGui_TableColumnFlags_NoSort()
Description:Disable ability to sort on this field (even if ImGui_TableFlags_Sortable is set on the table).
^
ImGui_TableColumnFlags_NoSortAscendingFunctioncall:
C: int ImGui_TableColumnFlags_NoSortAscending()
EEL2: int extension_api("ImGui_TableColumnFlags_NoSortAscending")
Lua: integer reaper.ImGui_TableColumnFlags_NoSortAscending()
Python: int ImGui_TableColumnFlags_NoSortAscending()
Description:Disable ability to sort in the ascending direction.
^
ImGui_TableColumnFlags_NoSortDescendingFunctioncall:
C: int ImGui_TableColumnFlags_NoSortDescending()
EEL2: int extension_api("ImGui_TableColumnFlags_NoSortDescending")
Lua: integer reaper.ImGui_TableColumnFlags_NoSortDescending()
Python: int ImGui_TableColumnFlags_NoSortDescending()
Description:Disable ability to sort in the descending direction.
^
ImGui_TableColumnFlags_NoneFunctioncall:
C: int ImGui_TableColumnFlags_None()
EEL2: int extension_api("ImGui_TableColumnFlags_None")
Lua: integer reaper.ImGui_TableColumnFlags_None()
Python: int ImGui_TableColumnFlags_None()
Description:Flags: For TableSetupColumn()
^
ImGui_TableColumnFlags_PreferSortAscendingFunctioncall:
C: int ImGui_TableColumnFlags_PreferSortAscending()
EEL2: int extension_api("ImGui_TableColumnFlags_PreferSortAscending")
Lua: integer reaper.ImGui_TableColumnFlags_PreferSortAscending()
Python: int ImGui_TableColumnFlags_PreferSortAscending()
Description:Make the initial sort direction Ascending when first sorting on this column (default).
^
ImGui_TableColumnFlags_PreferSortDescendingFunctioncall:
C: int ImGui_TableColumnFlags_PreferSortDescending()
EEL2: int extension_api("ImGui_TableColumnFlags_PreferSortDescending")
Lua: integer reaper.ImGui_TableColumnFlags_PreferSortDescending()
Python: int ImGui_TableColumnFlags_PreferSortDescending()
Description:Make the initial sort direction Descending when first sorting on this column.
^
ImGui_TableColumnFlags_WidthFixedFunctioncall:
C: int ImGui_TableColumnFlags_WidthFixed()
EEL2: int extension_api("ImGui_TableColumnFlags_WidthFixed")
Lua: integer reaper.ImGui_TableColumnFlags_WidthFixed()
Python: int ImGui_TableColumnFlags_WidthFixed()
Description:Column will not stretch. Preferable with horizontal scrolling enabled (default if table sizing policy is _SizingFixedFit and table is resizable).
^
ImGui_TableColumnFlags_WidthStretchFunctioncall:
C: int ImGui_TableColumnFlags_WidthStretch()
EEL2: int extension_api("ImGui_TableColumnFlags_WidthStretch")
Lua: integer reaper.ImGui_TableColumnFlags_WidthStretch()
Python: int ImGui_TableColumnFlags_WidthStretch()
Description:Column will stretch. Preferable with horizontal scrolling disabled (default if table sizing policy is _SizingStretchSame or _SizingStretchProp).
^
ImGui_TableFlags_BordersFunctioncall:
C: int ImGui_TableFlags_Borders()
EEL2: int extension_api("ImGui_TableFlags_Borders")
Lua: integer reaper.ImGui_TableFlags_Borders()
Python: int ImGui_TableFlags_Borders()
Description:Draw all borders.
^
ImGui_TableFlags_BordersHFunctioncall:
C: int ImGui_TableFlags_BordersH()
EEL2: int extension_api("ImGui_TableFlags_BordersH")
Lua: integer reaper.ImGui_TableFlags_BordersH()
Python: int ImGui_TableFlags_BordersH()
Description:Draw horizontal borders.
^
ImGui_TableFlags_BordersInnerFunctioncall:
C: int ImGui_TableFlags_BordersInner()
EEL2: int extension_api("ImGui_TableFlags_BordersInner")
Lua: integer reaper.ImGui_TableFlags_BordersInner()
Python: int ImGui_TableFlags_BordersInner()
Description:Draw inner borders.
^
ImGui_TableFlags_BordersInnerHFunctioncall:
C: int ImGui_TableFlags_BordersInnerH()
EEL2: int extension_api("ImGui_TableFlags_BordersInnerH")
Lua: integer reaper.ImGui_TableFlags_BordersInnerH()
Python: int ImGui_TableFlags_BordersInnerH()
Description:Draw horizontal borders between rows.
^
ImGui_TableFlags_BordersInnerVFunctioncall:
C: int ImGui_TableFlags_BordersInnerV()
EEL2: int extension_api("ImGui_TableFlags_BordersInnerV")
Lua: integer reaper.ImGui_TableFlags_BordersInnerV()
Python: int ImGui_TableFlags_BordersInnerV()
Description:Draw vertical borders between columns.
^
ImGui_TableFlags_BordersOuterFunctioncall:
C: int ImGui_TableFlags_BordersOuter()
EEL2: int extension_api("ImGui_TableFlags_BordersOuter")
Lua: integer reaper.ImGui_TableFlags_BordersOuter()
Python: int ImGui_TableFlags_BordersOuter()
Description:Draw outer borders.
^
ImGui_TableFlags_BordersOuterHFunctioncall:
C: int ImGui_TableFlags_BordersOuterH()
EEL2: int extension_api("ImGui_TableFlags_BordersOuterH")
Lua: integer reaper.ImGui_TableFlags_BordersOuterH()
Python: int ImGui_TableFlags_BordersOuterH()
Description:Draw horizontal borders at the top and bottom.
^
ImGui_TableFlags_BordersOuterVFunctioncall:
C: int ImGui_TableFlags_BordersOuterV()
EEL2: int extension_api("ImGui_TableFlags_BordersOuterV")
Lua: integer reaper.ImGui_TableFlags_BordersOuterV()
Python: int ImGui_TableFlags_BordersOuterV()
Description:Draw vertical borders on the left and right sides.
^
ImGui_TableFlags_BordersVFunctioncall:
C: int ImGui_TableFlags_BordersV()
EEL2: int extension_api("ImGui_TableFlags_BordersV")
Lua: integer reaper.ImGui_TableFlags_BordersV()
Python: int ImGui_TableFlags_BordersV()
Description:Draw vertical borders.
^
ImGui_TableFlags_ContextMenuInBodyFunctioncall:
C: int ImGui_TableFlags_ContextMenuInBody()
EEL2: int extension_api("ImGui_TableFlags_ContextMenuInBody")
Lua: integer reaper.ImGui_TableFlags_ContextMenuInBody()
Python: int ImGui_TableFlags_ContextMenuInBody()
Description:Right-click on columns body/contents will display table context menu. By default it is available in TableHeadersRow().
^
ImGui_TableFlags_HideableFunctioncall:
C: int ImGui_TableFlags_Hideable()
EEL2: int extension_api("ImGui_TableFlags_Hideable")
Lua: integer reaper.ImGui_TableFlags_Hideable()
Python: int ImGui_TableFlags_Hideable()
Description:Enable hiding/disabling columns in context menu.
^
ImGui_TableFlags_NoClipFunctioncall:
C: int ImGui_TableFlags_NoClip()
EEL2: int extension_api("ImGui_TableFlags_NoClip")
Lua: integer reaper.ImGui_TableFlags_NoClip()
Python: int ImGui_TableFlags_NoClip()
Description:Disable clipping rectangle for every individual columns (reduce draw command count, items will be able to overflow into other columns). Generally incompatible with TableSetupScrollFreeze().
^
ImGui_TableFlags_NoHostExtendXFunctioncall:
C: int ImGui_TableFlags_NoHostExtendX()
EEL2: int extension_api("ImGui_TableFlags_NoHostExtendX")
Lua: integer reaper.ImGui_TableFlags_NoHostExtendX()
Python: int ImGui_TableFlags_NoHostExtendX()
Description:Make outer width auto-fit to columns, overriding outer_size.x value. Only available when ScrollX/ScrollY are disabled and Stretch columns are not used.
^
ImGui_TableFlags_NoHostExtendYFunctioncall:
C: int ImGui_TableFlags_NoHostExtendY()
EEL2: int extension_api("ImGui_TableFlags_NoHostExtendY")
Lua: integer reaper.ImGui_TableFlags_NoHostExtendY()
Python: int ImGui_TableFlags_NoHostExtendY()
Description:Make outer height stop exactly at outer_size.y (prevent auto-extending table past the limit). Only available when ScrollX/ScrollY are disabled. Data below the limit will be clipped and not visible.
^
ImGui_TableFlags_NoKeepColumnsVisibleFunctioncall:
C: int ImGui_TableFlags_NoKeepColumnsVisible()
EEL2: int extension_api("ImGui_TableFlags_NoKeepColumnsVisible")
Lua: integer reaper.ImGui_TableFlags_NoKeepColumnsVisible()
Python: int ImGui_TableFlags_NoKeepColumnsVisible()
Description:Disable keeping column always minimally visible when ScrollX is off and table gets too small. Not recommended if columns are resizable.
^
ImGui_TableFlags_NoPadInnerXFunctioncall:
C: int ImGui_TableFlags_NoPadInnerX()
EEL2: int extension_api("ImGui_TableFlags_NoPadInnerX")
Lua: integer reaper.ImGui_TableFlags_NoPadInnerX()
Python: int ImGui_TableFlags_NoPadInnerX()
Description:Disable inner padding between columns (double inner padding if BordersOuterV is on, single inner padding if BordersOuterV is off).
^
ImGui_TableFlags_NoPadOuterXFunctioncall:
C: int ImGui_TableFlags_NoPadOuterX()
EEL2: int extension_api("ImGui_TableFlags_NoPadOuterX")
Lua: integer reaper.ImGui_TableFlags_NoPadOuterX()
Python: int ImGui_TableFlags_NoPadOuterX()
Description:Default if BordersOuterV is off. Disable outer-most padding.
^
ImGui_TableFlags_NoSavedSettingsFunctioncall:
C: int ImGui_TableFlags_NoSavedSettings()
EEL2: int extension_api("ImGui_TableFlags_NoSavedSettings")
Lua: integer reaper.ImGui_TableFlags_NoSavedSettings()
Python: int ImGui_TableFlags_NoSavedSettings()
Description:Disable persisting columns order, width and sort settings in the .ini file.
^
ImGui_TableFlags_NoneFunctioncall:
C: int ImGui_TableFlags_None()
EEL2: int extension_api("ImGui_TableFlags_None")
Lua: integer reaper.ImGui_TableFlags_None()
Python: int ImGui_TableFlags_None()
Description:- Read on documentation at the top of imgui_tables.cpp for details.
^
ImGui_TableFlags_PadOuterXFunctioncall:
C: int ImGui_TableFlags_PadOuterX()
EEL2: int extension_api("ImGui_TableFlags_PadOuterX")
Lua: integer reaper.ImGui_TableFlags_PadOuterX()
Python: int ImGui_TableFlags_PadOuterX()
Description:Default if BordersOuterV is on. Enable outer-most padding. Generally desirable if you have headers.
^
ImGui_TableFlags_PreciseWidthsFunctioncall:
C: int ImGui_TableFlags_PreciseWidths()
EEL2: int extension_api("ImGui_TableFlags_PreciseWidths")
Lua: integer reaper.ImGui_TableFlags_PreciseWidths()
Python: int ImGui_TableFlags_PreciseWidths()
Description:Disable distributing remainder width to stretched columns (width allocation on a 100-wide table with 3 columns: Without this flag: 33,33,34. With this flag: 33,33,33). With larger number of columns, resizing will appear to be less smooth.
^
ImGui_TableFlags_ReorderableFunctioncall:
C: int ImGui_TableFlags_Reorderable()
EEL2: int extension_api("ImGui_TableFlags_Reorderable")
Lua: integer reaper.ImGui_TableFlags_Reorderable()
Python: int ImGui_TableFlags_Reorderable()
Description:Enable reordering columns in header row (need calling TableSetupColumn() + TableHeadersRow() to display headers)
^
ImGui_TableFlags_ResizableFunctioncall:
C: int ImGui_TableFlags_Resizable()
EEL2: int extension_api("ImGui_TableFlags_Resizable")
Lua: integer reaper.ImGui_TableFlags_Resizable()
Python: int ImGui_TableFlags_Resizable()
Description:Enable resizing columns.
^
ImGui_TableFlags_RowBgFunctioncall:
C: int ImGui_TableFlags_RowBg()
EEL2: int extension_api("ImGui_TableFlags_RowBg")
Lua: integer reaper.ImGui_TableFlags_RowBg()
Python: int ImGui_TableFlags_RowBg()
Description:Set each RowBg color with ImGuiCol_TableRowBg or ImGuiCol_TableRowBgAlt (equivalent of calling TableSetBgColor with ImGuiTableBgFlags_RowBg0 on each row manually)
^
ImGui_TableFlags_ScrollXFunctioncall:
C: int ImGui_TableFlags_ScrollX()
EEL2: int extension_api("ImGui_TableFlags_ScrollX")
Lua: integer reaper.ImGui_TableFlags_ScrollX()
Python: int ImGui_TableFlags_ScrollX()
Description:Enable horizontal scrolling. Require 'outer_size' parameter of BeginTable() to specify the container size. Changes default sizing policy. Because this create a child window, ScrollY is currently generally recommended when using ScrollX.
^
ImGui_TableFlags_ScrollYFunctioncall:
C: int ImGui_TableFlags_ScrollY()
EEL2: int extension_api("ImGui_TableFlags_ScrollY")
Lua: integer reaper.ImGui_TableFlags_ScrollY()
Python: int ImGui_TableFlags_ScrollY()
Description:Enable vertical scrolling. Require 'outer_size' parameter of BeginTable() to specify the container size.
^
ImGui_TableFlags_SizingFixedFitFunctioncall:
C: int ImGui_TableFlags_SizingFixedFit()
EEL2: int extension_api("ImGui_TableFlags_SizingFixedFit")
Lua: integer reaper.ImGui_TableFlags_SizingFixedFit()
Python: int ImGui_TableFlags_SizingFixedFit()
Description:Columns default to _WidthFixed or _WidthAuto (if resizable or not resizable), matching contents width.
^
ImGui_TableFlags_SizingFixedSameFunctioncall:
C: int ImGui_TableFlags_SizingFixedSame()
EEL2: int extension_api("ImGui_TableFlags_SizingFixedSame")
Lua: integer reaper.ImGui_TableFlags_SizingFixedSame()
Python: int ImGui_TableFlags_SizingFixedSame()
Description:Columns default to _WidthFixed or _WidthAuto (if resizable or not resizable), matching the maximum contents width of all columns. Implicitly enable ImGuiTableFlags_NoKeepColumnsVisible.
^
ImGui_TableFlags_SizingStretchPropFunctioncall:
C: int ImGui_TableFlags_SizingStretchProp()
EEL2: int extension_api("ImGui_TableFlags_SizingStretchProp")
Lua: integer reaper.ImGui_TableFlags_SizingStretchProp()
Python: int ImGui_TableFlags_SizingStretchProp()
Description:Columns default to _WidthStretch with default weights proportional to each columns contents widths.
^
ImGui_TableFlags_SizingStretchSameFunctioncall:
C: int ImGui_TableFlags_SizingStretchSame()
EEL2: int extension_api("ImGui_TableFlags_SizingStretchSame")
Lua: integer reaper.ImGui_TableFlags_SizingStretchSame()
Python: int ImGui_TableFlags_SizingStretchSame()
Description:Columns default to _WidthStretch with default weights all equal, unless overriden by TableSetupColumn().
^
ImGui_TableFlags_SortMultiFunctioncall:
C: int ImGui_TableFlags_SortMulti()
EEL2: int extension_api("ImGui_TableFlags_SortMulti")
Lua: integer reaper.ImGui_TableFlags_SortMulti()
Python: int ImGui_TableFlags_SortMulti()
Description:Hold shift when clicking headers to sort on multiple column. TableGetSortSpecs() may return specs where (SpecsCount > 1).
^
ImGui_TableFlags_SortTristateFunctioncall:
C: int ImGui_TableFlags_SortTristate()
EEL2: int extension_api("ImGui_TableFlags_SortTristate")
Lua: integer reaper.ImGui_TableFlags_SortTristate()
Python: int ImGui_TableFlags_SortTristate()
Description:Allow no sorting, disable default sorting. TableGetSortSpecs() may return specs where (SpecsCount == 0).
^
ImGui_TableFlags_SortableFunctioncall:
C: int ImGui_TableFlags_Sortable()
EEL2: int extension_api("ImGui_TableFlags_Sortable")
Lua: integer reaper.ImGui_TableFlags_Sortable()
Python: int ImGui_TableFlags_Sortable()
Description:Enable sorting. Call TableGetSortSpecs() to obtain sort specs. Also see ImGuiTableFlags_SortMulti and ImGuiTableFlags_SortTristate.
^
ImGui_TableGetColumnCountFunctioncall:
C: int ImGui_TableGetColumnCount(ImGui_Context* ctx)
EEL2: int extension_api("ImGui_TableGetColumnCount", ImGui_Context ctx)
Lua: integer reaper.ImGui_TableGetColumnCount(ImGui_Context ctx)
Python: int ImGui_TableGetColumnCount(ImGui_Context* ctx)
Description:Return number of columns (value passed to BeginTable)
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_TableGetColumnFlagsFunctioncall:
C: int ImGui_TableGetColumnFlags(ImGui_Context* ctx, int* column_nInOptional)
EEL2: int extension_api("ImGui_TableGetColumnFlags", ImGui_Context ctx, optional int column_nIn)
Lua: integer reaper.ImGui_TableGetColumnFlags(ImGui_Context ctx, optional number column_nIn)
Python: int ImGui_TableGetColumnFlags(ImGui_Context* ctx, int* column_nInOptional)
Description:Default values: column_n = -1
| Parameters: |
| ImGui_Context ctx | - | |
| optional number column_nIn | - | |
^
ImGui_TableGetColumnIndexFunctioncall:
C: int ImGui_TableGetColumnIndex(ImGui_Context* ctx)
EEL2: int extension_api("ImGui_TableGetColumnIndex", ImGui_Context ctx)
Lua: integer reaper.ImGui_TableGetColumnIndex(ImGui_Context ctx)
Python: int ImGui_TableGetColumnIndex(ImGui_Context* ctx)
Description:Return current column index.
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_TableGetColumnNameFunctioncall:
C: const char* ImGui_TableGetColumnName(ImGui_Context* ctx, int* column_nInOptional)
EEL2: bool extension_api("ImGui_TableGetColumnName", #retval, ImGui_Context ctx, optional int column_nIn)
Lua: string reaper.ImGui_TableGetColumnName(ImGui_Context ctx, optional number column_nIn)
Python: const char* ImGui_TableGetColumnName(ImGui_Context* ctx, int* column_nInOptional)
Description:Default values: column_n = -1
| Parameters: |
| ImGui_Context ctx | - | |
| optional number column_nIn | - | |
^
ImGui_TableGetColumnSortSpecsFunctioncall:
C: bool ImGui_TableGetColumnSortSpecs(ImGui_Context* ctx, int id, int* column_user_idOut, int* column_indexOut, int* sort_orderOut, int* sort_directionOut)
EEL2: bool extension_api("ImGui_TableGetColumnSortSpecs", ImGui_Context ctx, int id, int &column_user_id, int &column_index, int &sort_order, int &sort_direction)
Lua: boolean retval, number column_user_id, number column_index, number sort_order, number sort_direction = reaper.ImGui_TableGetColumnSortSpecs(ImGui_Context ctx, integer id)
Python: bool ImGui_TableGetColumnSortSpecs(ImGui_Context* ctx, int id, int* column_user_idOut, int* column_indexOut, int* sort_orderOut, int* sort_directionOut)
Description:
| Parameters: |
| ImGui_Context ctx | - | |
| integer id | - | |
| Returnvalues: |
| boolean retval | - | |
| number column_user_id | - | |
| number column_index | - | |
| number sort_order | - | |
| number sort_direction | - | - |
^
ImGui_TableGetRowIndexFunctioncall:
C: int ImGui_TableGetRowIndex(ImGui_Context* ctx)
EEL2: int extension_api("ImGui_TableGetRowIndex", ImGui_Context ctx)
Lua: integer reaper.ImGui_TableGetRowIndex(ImGui_Context ctx)
Python: int ImGui_TableGetRowIndex(ImGui_Context* ctx)
Description:Return current row index.
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_TableHeaderFunctioncall:
C: void ImGui_TableHeader(ImGui_Context* ctx, const char* label)
EEL2: extension_api("ImGui_TableHeader", ImGui_Context ctx, "label")
Lua: reaper.ImGui_TableHeader(ImGui_Context ctx, string label)
Python: void ImGui_TableHeader(ImGui_Context* ctx, const char* label)
Description:Submit one header cell manually (rarely used). See ImGui_TableSetColumn
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
^
ImGui_TableHeadersRowFunctioncall:
C: void ImGui_TableHeadersRow(ImGui_Context* ctx)
EEL2: extension_api("ImGui_TableHeadersRow", ImGui_Context ctx)
Lua: reaper.ImGui_TableHeadersRow(ImGui_Context ctx)
Python: void ImGui_TableHeadersRow(ImGui_Context* ctx)
Description:Submit all headers cells based on data provided to TableSetupColumn() + submit context menu
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_TableNeedSortFunctioncall:
C: bool ImGui_TableNeedSort(ImGui_Context* ctx, bool* has_specsOut)
EEL2: bool extension_api("ImGui_TableNeedSort", ImGui_Context ctx, bool &has_specs)
Lua: boolean retval, boolean has_specs = reaper.ImGui_TableNeedSort(ImGui_Context ctx)
Python: bool ImGui_TableNeedSort(ImGui_Context* ctx, bool* has_specsOut)
Description:Return true once when sorting specs have changed since last call, or the first time. 'has_specs' is false when not sorting. See ImGui_TableSortSpecs_GetColumnSpecs.
| Parameters: |
| ImGui_Context ctx | - | |
| Returnvalues: |
| boolean retval | - | |
| boolean has_specs | - | - |
^
ImGui_TableNextColumnFunctioncall:
C: bool ImGui_TableNextColumn(ImGui_Context* ctx)
EEL2: bool extension_api("ImGui_TableNextColumn", ImGui_Context ctx)
Lua: boolean reaper.ImGui_TableNextColumn(ImGui_Context ctx)
Python: bool ImGui_TableNextColumn(ImGui_Context* ctx)
Description:Append into the next column (or first column of next row if currently in last column). Return true when column is visible.
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_TableNextRowFunctioncall:
C: void ImGui_TableNextRow(ImGui_Context* ctx, int* row_flagsInOptional, double* min_row_heightInOptional)
EEL2: extension_api("ImGui_TableNextRow", ImGui_Context ctx, optional int row_flagsIn, optional min_row_heightIn)
Lua: reaper.ImGui_TableNextRow(ImGui_Context ctx, optional number row_flagsIn, optional number min_row_heightIn)
Python: void ImGui_TableNextRow(ImGui_Context* ctx, int* row_flagsInOptional, double* min_row_heightInOptional)
Description:Default values: row_flags = ImGui_TableRowFlags_None, min_row_height = 0.0
| Parameters: |
| ImGui_Context ctx | - | |
| optional number row_flagsIn | - | |
| optional number min_row_heightIn | - | |
^
ImGui_TableRowFlags_HeadersFunctioncall:
C: int ImGui_TableRowFlags_Headers()
EEL2: int extension_api("ImGui_TableRowFlags_Headers")
Lua: integer reaper.ImGui_TableRowFlags_Headers()
Python: int ImGui_TableRowFlags_Headers()
Description:Identify header row (set default background color + width of its contents accounted different for auto column width)
^
ImGui_TableRowFlags_NoneFunctioncall:
C: int ImGui_TableRowFlags_None()
EEL2: int extension_api("ImGui_TableRowFlags_None")
Lua: integer reaper.ImGui_TableRowFlags_None()
Python: int ImGui_TableRowFlags_None()
Description:Flags: For TableNextRow()
^
ImGui_TableSetBgColorFunctioncall:
C: void ImGui_TableSetBgColor(ImGui_Context* ctx, int target, int color_rgba, int* column_nInOptional)
EEL2: extension_api("ImGui_TableSetBgColor", ImGui_Context ctx, int target, int color_rgba, optional int column_nIn)
Lua: reaper.ImGui_TableSetBgColor(ImGui_Context ctx, integer target, integer color_rgba, optional number column_nIn)
Python: void ImGui_TableSetBgColor(ImGui_Context* ctx, int target, int color_rgba, int* column_nInOptional)
Description:Default values: column_n = -1
| Parameters: |
| ImGui_Context ctx | - | |
| integer target | - | |
| integer color_rgba | - | |
| optional number column_nIn | - | |
^
ImGui_TableSetColumnIndexFunctioncall:
C: bool ImGui_TableSetColumnIndex(ImGui_Context* ctx, int column_n)
EEL2: bool extension_api("ImGui_TableSetColumnIndex", ImGui_Context ctx, int column_n)
Lua: boolean reaper.ImGui_TableSetColumnIndex(ImGui_Context ctx, integer column_n)
Python: bool ImGui_TableSetColumnIndex(ImGui_Context* ctx, int column_n)
Description:Append into the specified column. Return true when column is visible.
| Parameters: |
| ImGui_Context ctx | - | |
| integer column_n | - | |
^
ImGui_TableSetupColumnFunctioncall:
C: void ImGui_TableSetupColumn(ImGui_Context* ctx, const char* label, int* flagsInOptional, double* init_width_or_weightInOptional, int* user_idInOptional)
EEL2: extension_api("ImGui_TableSetupColumn", ImGui_Context ctx, "label", optional int flagsIn, optional init_width_or_weightIn, optional int user_idIn)
Lua: reaper.ImGui_TableSetupColumn(ImGui_Context ctx, string label, optional number flagsIn, optional number init_width_or_weightIn, optional number user_idIn)
Python: void ImGui_TableSetupColumn(ImGui_Context* ctx, const char* label, int* flagsInOptional, double* init_width_or_weightInOptional, int* user_idInOptional)
Description:Default values: flags = ImGui_TableColumnFlags_None, init_width_or_weight = 0.0, user_id = 0
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| optional number flagsIn | - | |
| optional number init_width_or_weightIn | - | |
| optional number user_idIn | - | |
^
ImGui_TableSetupScrollFreezeFunctioncall:
C: void ImGui_TableSetupScrollFreeze(ImGui_Context* ctx, int cols, int rows)
EEL2: extension_api("ImGui_TableSetupScrollFreeze", ImGui_Context ctx, int cols, int rows)
Lua: reaper.ImGui_TableSetupScrollFreeze(ImGui_Context ctx, integer cols, integer rows)
Python: void ImGui_TableSetupScrollFreeze(ImGui_Context* ctx, int cols, int rows)
Description:Lock columns/rows so they stay visible when scrolled.
| Parameters: |
| ImGui_Context ctx | - | |
| integer cols | - | |
| integer rows | - | |
^
ImGui_TextFunctioncall:
C: void ImGui_Text(ImGui_Context* ctx, const char* text)
EEL2: extension_api("ImGui_Text", ImGui_Context ctx, "text")
Lua: reaper.ImGui_Text(ImGui_Context ctx, string text)
Python: void ImGui_Text(ImGui_Context* ctx, const char* text)
Description:Python: ImGui_Text(ImGui_Context ctx, String text)
| Parameters: |
| ImGui_Context ctx | - | |
| string text | - | |
^
ImGui_TextColoredFunctioncall:
C: void ImGui_TextColored(ImGui_Context* ctx, int col_rgba, const char* text)
EEL2: extension_api("ImGui_TextColored", ImGui_Context ctx, int col_rgba, "text")
Lua: reaper.ImGui_TextColored(ImGui_Context ctx, integer col_rgba, string text)
Python: void ImGui_TextColored(ImGui_Context* ctx, int col_rgba, const char* text)
Description:Shortcut for PushStyleColor(ImGuiCol_Text, color); Text(text); PopStyleColor();
| Parameters: |
| ImGui_Context ctx | - | |
| integer col_rgba | - | |
| string text | - | |
^
ImGui_TextDisabledFunctioncall:
C: void ImGui_TextDisabled(ImGui_Context* ctx, const char* text)
EEL2: extension_api("ImGui_TextDisabled", ImGui_Context ctx, "text")
Lua: reaper.ImGui_TextDisabled(ImGui_Context ctx, string text)
Python: void ImGui_TextDisabled(ImGui_Context* ctx, const char* text)
Description:Python: ImGui_TextDisabled(ImGui_Context ctx, String text)
| Parameters: |
| ImGui_Context ctx | - | |
| string text | - | |
^
ImGui_TextWrappedFunctioncall:
C: void ImGui_TextWrapped(ImGui_Context* ctx, const char* text)
EEL2: extension_api("ImGui_TextWrapped", ImGui_Context ctx, "text")
Lua: reaper.ImGui_TextWrapped(ImGui_Context ctx, string text)
Python: void ImGui_TextWrapped(ImGui_Context* ctx, const char* text)
Description:Shortcut for PushTextWrapPos(0.0f); Text(fmt, ...); PopTextWrapPos();. Note that this won't work on an auto-resizing window if there's no other widgets to extend the window width, yoy may need to set a size using SetNextWindowSize().
| Parameters: |
| ImGui_Context ctx | - | |
| string text | - | |
^
ImGui_TreeNodeFunctioncall:
C: bool ImGui_TreeNode(ImGui_Context* ctx, const char* label, int* flagsInOptional)
EEL2: bool extension_api("ImGui_TreeNode", ImGui_Context ctx, "label", optional int flagsIn)
Lua: boolean reaper.ImGui_TreeNode(ImGui_Context ctx, string label, optional number flagsIn)
Python: bool ImGui_TreeNode(ImGui_Context* ctx, const char* label, int* flagsInOptional)
Description:Default values: flags = ImGui_TreeNodeFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| optional number flagsIn | - | |
^
ImGui_TreeNodeExFunctioncall:
C: bool ImGui_TreeNodeEx(ImGui_Context* ctx, const char* str_id, const char* label, int* flagsInOptional)
EEL2: bool extension_api("ImGui_TreeNodeEx", ImGui_Context ctx, "str_id", "label", optional int flagsIn)
Lua: boolean reaper.ImGui_TreeNodeEx(ImGui_Context ctx, string str_id, string label, optional number flagsIn)
Python: bool ImGui_TreeNodeEx(ImGui_Context* ctx, const char* str_id, const char* label, int* flagsInOptional)
Description:Default values: flags = ImGui_TreeNodeFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string str_id | - | |
| string label | - | |
| optional number flagsIn | - | |
^
ImGui_TreeNodeFlags_AllowItemOverlapFunctioncall:
C: int ImGui_TreeNodeFlags_AllowItemOverlap()
EEL2: int extension_api("ImGui_TreeNodeFlags_AllowItemOverlap")
Lua: integer reaper.ImGui_TreeNodeFlags_AllowItemOverlap()
Python: int ImGui_TreeNodeFlags_AllowItemOverlap()
Description:Hit testing to allow subsequent widgets to overlap this one
^
ImGui_TreeNodeFlags_BulletFunctioncall:
C: int ImGui_TreeNodeFlags_Bullet()
EEL2: int extension_api("ImGui_TreeNodeFlags_Bullet")
Lua: integer reaper.ImGui_TreeNodeFlags_Bullet()
Python: int ImGui_TreeNodeFlags_Bullet()
Description:Display a bullet instead of arrow
^
ImGui_TreeNodeFlags_CollapsingHeaderFunctioncall:
C: int ImGui_TreeNodeFlags_CollapsingHeader()
EEL2: int extension_api("ImGui_TreeNodeFlags_CollapsingHeader")
Lua: integer reaper.ImGui_TreeNodeFlags_CollapsingHeader()
Python: int ImGui_TreeNodeFlags_CollapsingHeader()
Description:Python: Int ImGui_TreeNodeFlags_CollapsingHeader()
^
ImGui_TreeNodeFlags_DefaultOpenFunctioncall:
C: int ImGui_TreeNodeFlags_DefaultOpen()
EEL2: int extension_api("ImGui_TreeNodeFlags_DefaultOpen")
Lua: integer reaper.ImGui_TreeNodeFlags_DefaultOpen()
Python: int ImGui_TreeNodeFlags_DefaultOpen()
Description:Default node to be open
^
ImGui_TreeNodeFlags_FramePaddingFunctioncall:
C: int ImGui_TreeNodeFlags_FramePadding()
EEL2: int extension_api("ImGui_TreeNodeFlags_FramePadding")
Lua: integer reaper.ImGui_TreeNodeFlags_FramePadding()
Python: int ImGui_TreeNodeFlags_FramePadding()
Description:Use FramePadding (even for an unframed text node) to vertically align text baseline to regular widget height. Equivalent to calling AlignTextToFramePadding().
^
ImGui_TreeNodeFlags_FramedFunctioncall:
C: int ImGui_TreeNodeFlags_Framed()
EEL2: int extension_api("ImGui_TreeNodeFlags_Framed")
Lua: integer reaper.ImGui_TreeNodeFlags_Framed()
Python: int ImGui_TreeNodeFlags_Framed()
Description:Draw frame with background (e.g. for CollapsingHeader)
^
ImGui_TreeNodeFlags_LeafFunctioncall:
C: int ImGui_TreeNodeFlags_Leaf()
EEL2: int extension_api("ImGui_TreeNodeFlags_Leaf")
Lua: integer reaper.ImGui_TreeNodeFlags_Leaf()
Python: int ImGui_TreeNodeFlags_Leaf()
Description:No collapsing, no arrow (use as a convenience for leaf nodes).
^
ImGui_TreeNodeFlags_NoAutoOpenOnLogFunctioncall:
C: int ImGui_TreeNodeFlags_NoAutoOpenOnLog()
EEL2: int extension_api("ImGui_TreeNodeFlags_NoAutoOpenOnLog")
Lua: integer reaper.ImGui_TreeNodeFlags_NoAutoOpenOnLog()
Python: int ImGui_TreeNodeFlags_NoAutoOpenOnLog()
Description:Don't automatically and temporarily open node when Logging is active (by default logging will automatically open tree nodes)
^
ImGui_TreeNodeFlags_NoTreePushOnOpenFunctioncall:
C: int ImGui_TreeNodeFlags_NoTreePushOnOpen()
EEL2: int extension_api("ImGui_TreeNodeFlags_NoTreePushOnOpen")
Lua: integer reaper.ImGui_TreeNodeFlags_NoTreePushOnOpen()
Python: int ImGui_TreeNodeFlags_NoTreePushOnOpen()
Description:Don't do a TreePush() when open (e.g. for CollapsingHeader) = no extra indent nor pushing on ID stack
^
ImGui_TreeNodeFlags_NoneFunctioncall:
C: int ImGui_TreeNodeFlags_None()
EEL2: int extension_api("ImGui_TreeNodeFlags_None")
Lua: integer reaper.ImGui_TreeNodeFlags_None()
Python: int ImGui_TreeNodeFlags_None()
Description:Flags for TreeNode(), TreeNodeEx(), CollapsingHeader()
^
ImGui_TreeNodeFlags_OpenOnArrowFunctioncall:
C: int ImGui_TreeNodeFlags_OpenOnArrow()
EEL2: int extension_api("ImGui_TreeNodeFlags_OpenOnArrow")
Lua: integer reaper.ImGui_TreeNodeFlags_OpenOnArrow()
Python: int ImGui_TreeNodeFlags_OpenOnArrow()
Description:Only open when clicking on the arrow part. If ImGuiTreeNodeFlags_OpenOnDoubleClick is also set, single-click arrow or double-click all box to open.
^
ImGui_TreeNodeFlags_OpenOnDoubleClickFunctioncall:
C: int ImGui_TreeNodeFlags_OpenOnDoubleClick()
EEL2: int extension_api("ImGui_TreeNodeFlags_OpenOnDoubleClick")
Lua: integer reaper.ImGui_TreeNodeFlags_OpenOnDoubleClick()
Python: int ImGui_TreeNodeFlags_OpenOnDoubleClick()
Description:Need double-click to open node
^
ImGui_TreeNodeFlags_SelectedFunctioncall:
C: int ImGui_TreeNodeFlags_Selected()
EEL2: int extension_api("ImGui_TreeNodeFlags_Selected")
Lua: integer reaper.ImGui_TreeNodeFlags_Selected()
Python: int ImGui_TreeNodeFlags_Selected()
Description:Draw as selected
^
ImGui_TreeNodeFlags_SpanAvailWidthFunctioncall:
C: int ImGui_TreeNodeFlags_SpanAvailWidth()
EEL2: int extension_api("ImGui_TreeNodeFlags_SpanAvailWidth")
Lua: integer reaper.ImGui_TreeNodeFlags_SpanAvailWidth()
Python: int ImGui_TreeNodeFlags_SpanAvailWidth()
Description:Extend hit box to the right-most edge, even if not framed. This is not the default in order to allow adding other items on the same line. In the future we may refactor the hit system to be front-to-back, allowing natural overlaps and then this can become the default.
^
ImGui_TreeNodeFlags_SpanFullWidthFunctioncall:
C: int ImGui_TreeNodeFlags_SpanFullWidth()
EEL2: int extension_api("ImGui_TreeNodeFlags_SpanFullWidth")
Lua: integer reaper.ImGui_TreeNodeFlags_SpanFullWidth()
Python: int ImGui_TreeNodeFlags_SpanFullWidth()
Description:Extend hit box to the left-most and right-most edges (bypass the indented area).
^
ImGui_TreePopFunctioncall:
C: void ImGui_TreePop(ImGui_Context* ctx)
EEL2: extension_api("ImGui_TreePop", ImGui_Context ctx)
Lua: reaper.ImGui_TreePop(ImGui_Context ctx)
Python: void ImGui_TreePop(ImGui_Context* ctx)
Description:Unindent()+PopId()
| Parameters: |
| ImGui_Context ctx | - | |
^
ImGui_TreePushFunctioncall:
C: void ImGui_TreePush(ImGui_Context* ctx, const char* str_id)
EEL2: extension_api("ImGui_TreePush", ImGui_Context ctx, "str_id")
Lua: reaper.ImGui_TreePush(ImGui_Context ctx, string str_id)
Python: void ImGui_TreePush(ImGui_Context* ctx, const char* str_id)
Description:~ Indent()+PushId(). Already called by TreeNode() when returning true, but you can call TreePush/TreePop yourself if desired.
| Parameters: |
| ImGui_Context ctx | - | |
| string str_id | - | |
^
ImGui_UnindentFunctioncall:
C: void ImGui_Unindent(ImGui_Context* ctx, double* indent_wInOptional)
EEL2: extension_api("ImGui_Unindent", ImGui_Context ctx, optional indent_wIn)
Lua: reaper.ImGui_Unindent(ImGui_Context ctx, optional number indent_wIn)
Python: void ImGui_Unindent(ImGui_Context* ctx, double* indent_wInOptional)
Description:Default values: indent_w = 0.0
| Parameters: |
| ImGui_Context ctx | - | |
| optional number indent_wIn | - | |
^
ImGui_VSliderDoubleFunctioncall:
C: bool ImGui_VSliderDouble(ImGui_Context* ctx, const char* label, double size_w, double size_h, double* vInOut, double v_min, double v_max, const char* formatInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_VSliderDouble", ImGui_Context ctx, "label", size_w, size_h, &v, v_min, v_max, optional "formatIn", optional int flagsIn)
Lua: boolean retval, number v = reaper.ImGui_VSliderDouble(ImGui_Context ctx, string label, number size_w, number size_h, number v, number v_min, number v_max, optional string formatIn, optional number flagsIn)
Python: bool ImGui_VSliderDouble(ImGui_Context* ctx, const char* label, double size_w, double size_h, double* vInOut, double v_min, double v_max, const char* formatInOptional, int* flagsInOptional)
Description:Default values: format = '%.3f', flags = ImGui_SliderFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number size_w | - | |
| number size_h | - | |
| number v | - | |
| number v_min | - | |
| number v_max | - | |
| optional string formatIn | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number v | - | - |
^
ImGui_VSliderIntFunctioncall:
C: bool ImGui_VSliderInt(ImGui_Context* ctx, const char* label, double size_w, double size_h, int* vInOut, int v_min, int v_max, const char* formatInOptional, int* flagsInOptional)
EEL2: bool extension_api("ImGui_VSliderInt", ImGui_Context ctx, "label", size_w, size_h, int &v, int v_min, int v_max, optional "formatIn", optional int flagsIn)
Lua: boolean retval, number v = reaper.ImGui_VSliderInt(ImGui_Context ctx, string label, number size_w, number size_h, number v, integer v_min, integer v_max, optional string formatIn, optional number flagsIn)
Python: bool ImGui_VSliderInt(ImGui_Context* ctx, const char* label, double size_w, double size_h, int* vInOut, int v_min, int v_max, const char* formatInOptional, int* flagsInOptional)
Description:Default values: format = '%d', flags = ImGui_SliderFlags_None
| Parameters: |
| ImGui_Context ctx | - | |
| string label | - | |
| number size_w | - | |
| number size_h | - | |
| number v | - | |
| integer v_min | - | |
| integer v_max | - | |
| optional string formatIn | - | |
| optional number flagsIn | - | |
| Returnvalues: |
| boolean retval | - | |
| number v | - | - |
^
ImGui_ValidatePtrFunctioncall:
C: bool ImGui_ValidatePtr(void* pointer, const char* type)
EEL2: bool extension_api("ImGui_ValidatePtr", void* pointer, "type")
Lua: boolean reaper.ImGui_ValidatePtr(identifier pointer, string type)
Python: bool ImGui_ValidatePtr(void* pointer, const char* type)
Description:Return whether the pointer of the specified type is valid. Supported types are ImGui_Context*, ImGui_DrawList*, ImGui_ListClipper* and ImGui_Viewport*.
| Parameters: |
| identifier pointer | - | |
| string type | - | |
^
ImGui_Viewport_GetCenterFunctioncall:
C: void ImGui_Viewport_GetCenter(ImGui_Viewport* viewport, double* xOut, double* yOut)
EEL2: extension_api("ImGui_Viewport_GetCenter", ImGui_Viewport viewport, &x, &y)
Lua: number x, number y = reaper.ImGui_Viewport_GetCenter(ImGui_Viewport viewport)
Python: void ImGui_Viewport_GetCenter(ImGui_Viewport* viewport, double* xOut, double* yOut)
Description:Main Area: Center of the viewport.
| Parameters: |
| ImGui_Viewport viewport | - | |
| Returnvalues: |
| number x | - | |
| number y | - | - |
^
ImGui_Viewport_GetPosFunctioncall:
C: void ImGui_Viewport_GetPos(ImGui_Viewport* viewport, double* xOut, double* yOut)
EEL2: extension_api("ImGui_Viewport_GetPos", ImGui_Viewport viewport, &x, &y)
Lua: number x, number y = reaper.ImGui_Viewport_GetPos(ImGui_Viewport viewport)
Python: void ImGui_Viewport_GetPos(ImGui_Viewport* viewport, double* xOut, double* yOut)
Description:Main Area: Position of the viewport (Dear ImGui coordinates are the same as OS desktop/native coordinates)
| Parameters: |
| ImGui_Viewport viewport | - | |
| Returnvalues: |
| number x | - | |
| number y | - | - |
^
ImGui_Viewport_GetSizeFunctioncall:
C: void ImGui_Viewport_GetSize(ImGui_Viewport* viewport, double* wOut, double* hOut)
EEL2: extension_api("ImGui_Viewport_GetSize", ImGui_Viewport viewport, &w, &h)
Lua: number w, number h = reaper.ImGui_Viewport_GetSize(ImGui_Viewport viewport)
Python: void ImGui_Viewport_GetSize(ImGui_Viewport* viewport, double* wOut, double* hOut)
Description:Main Area: Size of the viewport.
| Parameters: |
| ImGui_Viewport viewport | - | |
| Returnvalues: |
| number w | - | |
| number h | - | - |
^
ImGui_Viewport_GetWorkCenterFunctioncall:
C: void ImGui_Viewport_GetWorkCenter(ImGui_Viewport* viewport, double* xOut, double* yOut)
EEL2: extension_api("ImGui_Viewport_GetWorkCenter", ImGui_Viewport viewport, &x, &y)
Lua: number x, number y = reaper.ImGui_Viewport_GetWorkCenter(ImGui_Viewport viewport)
Python: void ImGui_Viewport_GetWorkCenter(ImGui_Viewport* viewport, double* xOut, double* yOut)
Description:Work Area: Center of the viewport.
| Parameters: |
| ImGui_Viewport viewport | - | |
| Returnvalues: |
| number x | - | |
| number y | - | - |
^
ImGui_Viewport_GetWorkPosFunctioncall:
C: void ImGui_Viewport_GetWorkPos(ImGui_Viewport* viewport, double* xOut, double* yOut)
EEL2: extension_api("ImGui_Viewport_GetWorkPos", ImGui_Viewport viewport, &x, &y)
Lua: number x, number y = reaper.ImGui_Viewport_GetWorkPos(ImGui_Viewport viewport)
Python: void ImGui_Viewport_GetWorkPos(ImGui_Viewport* viewport, double* xOut, double* yOut)
Description:Work Area: Position of the viewport minus task bars, menus bars, status bars (>= Pos)
| Parameters: |
| ImGui_Viewport viewport | - | |
| Returnvalues: |
| number x | - | |
| number y | - | - |
^
ImGui_Viewport_GetWorkSizeFunctioncall:
C: void ImGui_Viewport_GetWorkSize(ImGui_Viewport* viewport, double* wOut, double* hOut)
EEL2: extension_api("ImGui_Viewport_GetWorkSize", ImGui_Viewport viewport, &w, &h)
Lua: number w, number h = reaper.ImGui_Viewport_GetWorkSize(ImGui_Viewport viewport)
Python: void ImGui_Viewport_GetWorkSize(ImGui_Viewport* viewport, double* wOut, double* hOut)
Description:Work Area: Size of the viewport minus task bars, menu bars, status bars (<= Size)
| Parameters: |
| ImGui_Viewport viewport | - | |
| Returnvalues: |
| number w | - | |
| number h | - | - |
^
ImGui_WindowFlags_AlwaysAutoResizeFunctioncall:
C: int ImGui_WindowFlags_AlwaysAutoResize()
EEL2: int extension_api("ImGui_WindowFlags_AlwaysAutoResize")
Lua: integer reaper.ImGui_WindowFlags_AlwaysAutoResize()
Python: int ImGui_WindowFlags_AlwaysAutoResize()
Description:Resize every window to its content every frame
^
ImGui_WindowFlags_AlwaysHorizontalScrollbarFunctioncall:
C: int ImGui_WindowFlags_AlwaysHorizontalScrollbar()
EEL2: int extension_api("ImGui_WindowFlags_AlwaysHorizontalScrollbar")
Lua: integer reaper.ImGui_WindowFlags_AlwaysHorizontalScrollbar()
Python: int ImGui_WindowFlags_AlwaysHorizontalScrollbar()
Description:Always show horizontal scrollbar (even if ContentSize.x < Size.x)
^
ImGui_WindowFlags_AlwaysUseWindowPaddingFunctioncall:
C: int ImGui_WindowFlags_AlwaysUseWindowPadding()
EEL2: int extension_api("ImGui_WindowFlags_AlwaysUseWindowPadding")
Lua: integer reaper.ImGui_WindowFlags_AlwaysUseWindowPadding()
Python: int ImGui_WindowFlags_AlwaysUseWindowPadding()
Description:Ensure child windows without border uses style.WindowPadding (ignored by default for non-bordered child windows, because more convenient)
^
ImGui_WindowFlags_AlwaysVerticalScrollbarFunctioncall:
C: int ImGui_WindowFlags_AlwaysVerticalScrollbar()
EEL2: int extension_api("ImGui_WindowFlags_AlwaysVerticalScrollbar")
Lua: integer reaper.ImGui_WindowFlags_AlwaysVerticalScrollbar()
Python: int ImGui_WindowFlags_AlwaysVerticalScrollbar()
Description:Always show vertical scrollbar (even if ContentSize.y < Size.y)
^
ImGui_WindowFlags_HorizontalScrollbarFunctioncall:
C: int ImGui_WindowFlags_HorizontalScrollbar()
EEL2: int extension_api("ImGui_WindowFlags_HorizontalScrollbar")
Lua: integer reaper.ImGui_WindowFlags_HorizontalScrollbar()
Python: int ImGui_WindowFlags_HorizontalScrollbar()
Description:Allow horizontal scrollbar to appear (off by default). You may use SetNextWindowContentSize(ImVec2(width,0.0f)); prior to calling Begin() to specify width. Read code in imgui_demo in the "Horizontal Scrolling" section.
^
ImGui_WindowFlags_MenuBarFunctioncall:
C: int ImGui_WindowFlags_MenuBar()
EEL2: int extension_api("ImGui_WindowFlags_MenuBar")
Lua: integer reaper.ImGui_WindowFlags_MenuBar()
Python: int ImGui_WindowFlags_MenuBar()
Description:Has a menu-bar
^
ImGui_WindowFlags_NoBackgroundFunctioncall:
C: int ImGui_WindowFlags_NoBackground()
EEL2: int extension_api("ImGui_WindowFlags_NoBackground")
Lua: integer reaper.ImGui_WindowFlags_NoBackground()
Python: int ImGui_WindowFlags_NoBackground()
Description:Disable drawing background color (WindowBg, etc.) and outside border. Similar as using SetNextWindowBgAlpha(0.0f).
^
ImGui_WindowFlags_NoBringToFrontOnFocusFunctioncall:
C: int ImGui_WindowFlags_NoBringToFrontOnFocus()
EEL2: int extension_api("ImGui_WindowFlags_NoBringToFrontOnFocus")
Lua: integer reaper.ImGui_WindowFlags_NoBringToFrontOnFocus()
Python: int ImGui_WindowFlags_NoBringToFrontOnFocus()
Description:Disable bringing window to front when taking focus (e.g. clicking on it or programmatically giving it focus)
^
ImGui_WindowFlags_NoCollapseFunctioncall:
C: int ImGui_WindowFlags_NoCollapse()
EEL2: int extension_api("ImGui_WindowFlags_NoCollapse")
Lua: integer reaper.ImGui_WindowFlags_NoCollapse()
Python: int ImGui_WindowFlags_NoCollapse()
Description:Disable user collapsing window by double-clicking on it
^
ImGui_WindowFlags_NoDecorationFunctioncall:
C: int ImGui_WindowFlags_NoDecoration()
EEL2: int extension_api("ImGui_WindowFlags_NoDecoration")
Lua: integer reaper.ImGui_WindowFlags_NoDecoration()
Python: int ImGui_WindowFlags_NoDecoration()
Description:WindowFlags_NoTitleBar | WindowFlags_NoResize | WindowFlags_NoScrollbar | WindowFlags_NoCollapse
^
ImGui_WindowFlags_NoFocusOnAppearingFunctioncall:
C: int ImGui_WindowFlags_NoFocusOnAppearing()
EEL2: int extension_api("ImGui_WindowFlags_NoFocusOnAppearing")
Lua: integer reaper.ImGui_WindowFlags_NoFocusOnAppearing()
Python: int ImGui_WindowFlags_NoFocusOnAppearing()
Description:Disable taking focus when transitioning from hidden to visible state
^
ImGui_WindowFlags_NoInputsFunctioncall:
C: int ImGui_WindowFlags_NoInputs()
EEL2: int extension_api("ImGui_WindowFlags_NoInputs")
Lua: integer reaper.ImGui_WindowFlags_NoInputs()
Python: int ImGui_WindowFlags_NoInputs()
Description:WindowFlags_NoMouseInputs | WindowFlags_NoNavInputs | WindowFlags_NoNavFocus
^
ImGui_WindowFlags_NoMouseInputsFunctioncall:
C: int ImGui_WindowFlags_NoMouseInputs()
EEL2: int extension_api("ImGui_WindowFlags_NoMouseInputs")
Lua: integer reaper.ImGui_WindowFlags_NoMouseInputs()
Python: int ImGui_WindowFlags_NoMouseInputs()
Description:Disable catching mouse, hovering test with pass through.
^
ImGui_WindowFlags_NoMoveFunctioncall:
C: int ImGui_WindowFlags_NoMove()
EEL2: int extension_api("ImGui_WindowFlags_NoMove")
Lua: integer reaper.ImGui_WindowFlags_NoMove()
Python: int ImGui_WindowFlags_NoMove()
Description:Disable user moving the window
^
ImGui_WindowFlags_NoNavFunctioncall:
C: int ImGui_WindowFlags_NoNav()
EEL2: int extension_api("ImGui_WindowFlags_NoNav")
Lua: integer reaper.ImGui_WindowFlags_NoNav()
Python: int ImGui_WindowFlags_NoNav()
Description:WindowFlags_NoNavInputs | WindowFlags_NoNavFocus
^
ImGui_WindowFlags_NoNavFocusFunctioncall:
C: int ImGui_WindowFlags_NoNavFocus()
EEL2: int extension_api("ImGui_WindowFlags_NoNavFocus")
Lua: integer reaper.ImGui_WindowFlags_NoNavFocus()
Python: int ImGui_WindowFlags_NoNavFocus()
Description:No focusing toward this window with gamepad/keyboard navigation (e.g. skipped by CTRL+TAB)
^
ImGui_WindowFlags_NoNavInputsFunctioncall:
C: int ImGui_WindowFlags_NoNavInputs()
EEL2: int extension_api("ImGui_WindowFlags_NoNavInputs")
Lua: integer reaper.ImGui_WindowFlags_NoNavInputs()
Python: int ImGui_WindowFlags_NoNavInputs()
Description:No gamepad/keyboard navigation within the window
^
ImGui_WindowFlags_NoResizeFunctioncall:
C: int ImGui_WindowFlags_NoResize()
EEL2: int extension_api("ImGui_WindowFlags_NoResize")
Lua: integer reaper.ImGui_WindowFlags_NoResize()
Python: int ImGui_WindowFlags_NoResize()
Description:Disable user resizing with the lower-right grip
^
ImGui_WindowFlags_NoSavedSettingsFunctioncall:
C: int ImGui_WindowFlags_NoSavedSettings()
EEL2: int extension_api("ImGui_WindowFlags_NoSavedSettings")
Lua: integer reaper.ImGui_WindowFlags_NoSavedSettings()
Python: int ImGui_WindowFlags_NoSavedSettings()
Description:Never load/save settings in .ini file
^
ImGui_WindowFlags_NoScrollWithMouseFunctioncall:
C: int ImGui_WindowFlags_NoScrollWithMouse()
EEL2: int extension_api("ImGui_WindowFlags_NoScrollWithMouse")
Lua: integer reaper.ImGui_WindowFlags_NoScrollWithMouse()
Python: int ImGui_WindowFlags_NoScrollWithMouse()
Description:Disable user vertically scrolling with mouse wheel. On child window, mouse wheel will be forwarded to the parent unless NoScrollbar is also set.
^
ImGui_WindowFlags_NoScrollbarFunctioncall:
C: int ImGui_WindowFlags_NoScrollbar()
EEL2: int extension_api("ImGui_WindowFlags_NoScrollbar")
Lua: integer reaper.ImGui_WindowFlags_NoScrollbar()
Python: int ImGui_WindowFlags_NoScrollbar()
Description:Disable scrollbars (window can still scroll with mouse or programmatically)
^
ImGui_WindowFlags_NoTitleBarFunctioncall:
C: int ImGui_WindowFlags_NoTitleBar()
EEL2: int extension_api("ImGui_WindowFlags_NoTitleBar")
Lua: integer reaper.ImGui_WindowFlags_NoTitleBar()
Python: int ImGui_WindowFlags_NoTitleBar()
Description:Disable title-bar
^
ImGui_WindowFlags_NoneFunctioncall:
C: int ImGui_WindowFlags_None()
EEL2: int extension_api("ImGui_WindowFlags_None")
Lua: integer reaper.ImGui_WindowFlags_None()
Python: int ImGui_WindowFlags_None()
Description:
^
ImGui_WindowFlags_UnsavedDocumentFunctioncall:
C: int ImGui_WindowFlags_UnsavedDocument()
EEL2: int extension_api("ImGui_WindowFlags_UnsavedDocument")
Lua: integer reaper.ImGui_WindowFlags_UnsavedDocument()
Python: int ImGui_WindowFlags_UnsavedDocument()
Description:Append '*' to title without affecting the ID, as a convenience to avoid using the ### operator. When used in a tab/docking context, tab is selected on closure and closure is deferred by one frame to allow code to cancel the closure (with a confirmation popup, etc.) without flicker.
| View: [all] [C/C++] [EEL2] [Lua] [Python] | | Automatically generated by Ultraschall-API 4.2 004 - 2094 functions available (Reaper, SWS, JS, ReaImGui, Osara) |