ReaScript API — Documentation

REAPER v6.41 / SWS v2.12.1.3 / Reapack v1.2.3.1 / JS_ReaScript API v1.220 / ReaImgui v0.5.8
Last update: 2021-11-23 23:33

Searchable and easy-to-read list of REAPER ReaScript API functions with common extensions support.
Generated from reascript.html file by X-Raym.
More infos about it on Cockos forum: Documentation: Reascripthelp with Styles and Filtering Tables.

HTML template based on Bootstrap Simple Sidebar template by Start Bootstrap.
Lists filtered with List-js.

Functions Definitions

MediaItem* AddMediaItemToTrack(MediaTrack* tr)
MediaItem AddMediaItemToTrack(MediaTrack tr)
MediaItem reaper.AddMediaItemToTrack(MediaTrack tr)
MediaItem RPR_AddMediaItemToTrack(MediaTrack tr)

creates a new media item.

int AddProjectMarker(ReaProject* proj, bool isrgn, double pos, double rgnend, const char* name, int wantidx)
int AddProjectMarker(ReaProject proj, bool isrgn, pos, rgnend, "name", int wantidx)
integer reaper.AddProjectMarker(ReaProject proj, boolean isrgn, number pos, number rgnend, string name, integer wantidx)
Int RPR_AddProjectMarker(ReaProject proj, Boolean isrgn, Float pos, Float rgnend, String name, Int wantidx)

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.

int AddProjectMarker2(ReaProject* proj, bool isrgn, double pos, double rgnend, const char* name, int wantidx, int color)
int AddProjectMarker2(ReaProject proj, bool isrgn, pos, rgnend, "name", int wantidx, int color)
integer reaper.AddProjectMarker2(ReaProject proj, boolean isrgn, number pos, number rgnend, string name, integer wantidx, integer color)
Int RPR_AddProjectMarker2(ReaProject proj, Boolean isrgn, Float pos, Float rgnend, String name, Int wantidx, Int color)

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

int AddRemoveReaScript(bool add, int sectionID, const char* scriptfn, bool commit)
int AddRemoveReaScript(bool add, int sectionID, "scriptfn", bool commit)
integer reaper.AddRemoveReaScript(boolean add, integer sectionID, string scriptfn, boolean commit)
Int RPR_AddRemoveReaScript(Boolean add, Int sectionID, String scriptfn, Boolean commit)

Add a ReaScript (return the new command ID, or 0 if failed) or remove a ReaScript (return >0 on success). Use commit==true when adding/removing a single script. When bulk adding/removing n scripts, you can optimize the n-1 first calls with commit==false and commit==true for the last call.

MediaItem_Take* AddTakeToMediaItem(MediaItem* item)
MediaItem_Take AddTakeToMediaItem(MediaItem item)
MediaItem_Take reaper.AddTakeToMediaItem(MediaItem item)
MediaItem_Take RPR_AddTakeToMediaItem(MediaItem item)

creates a new take in an item

bool AddTempoTimeSigMarker(ReaProject* proj, double timepos, double bpm, int timesig_num, int timesig_denom, bool lineartempochange)
bool AddTempoTimeSigMarker(ReaProject proj, timepos, bpm, int timesig_num, int timesig_denom, bool lineartempochange)
boolean reaper.AddTempoTimeSigMarker(ReaProject proj, number timepos, number bpm, integer timesig_num, integer timesig_denom, boolean lineartempochange)
Boolean RPR_AddTempoTimeSigMarker(ReaProject proj, Float timepos, Float bpm, Int timesig_num, Int timesig_denom, Boolean lineartempochange)

Deprecated. Use SetTempoTimeSigMarker with ptidx=-1.

void adjustZoom(double amt, int forceset, bool doupd, int centermode)
adjustZoom(amt, int forceset, bool doupd, int centermode)
reaper.adjustZoom(number amt, integer forceset, boolean doupd, integer centermode)
RPR_adjustZoom(Float amt, Int forceset, Boolean doupd, Int centermode)

forceset=0,doupd=true,centermode=-1 for default

bool AnyTrackSolo(ReaProject* proj)
bool AnyTrackSolo(ReaProject proj)
boolean reaper.AnyTrackSolo(ReaProject proj)
Boolean RPR_AnyTrackSolo(ReaProject proj)
bool APIExists(const char* function_name)
bool APIExists("function_name")
boolean reaper.APIExists(string function_name)
Boolean RPR_APIExists(String function_name)

Returns true if function_name exists in the REAPER API

void APITest()
APITest()
reaper.APITest()
RPR_APITest()

Displays a message window if the API was successfully called.

bool ApplyNudge(ReaProject* project, int nudgeflag, int nudgewhat, int nudgeunits, double value, bool reverse, int copies)
bool ApplyNudge(ReaProject project, int nudgeflag, int nudgewhat, int nudgeunits, value, bool reverse, int copies)
boolean reaper.ApplyNudge(ReaProject project, integer nudgeflag, integer nudgewhat, integer nudgeunits, number value, boolean reverse, integer copies)
Boolean RPR_ApplyNudge(ReaProject project, Int nudgeflag, Int nudgewhat, Int nudgeunits, Float value, Boolean reverse, Int copies)

nudgeflag: &1=set to value (otherwise nudge by value), &2=snap
nudgewhat: 0=position, 1=left trim, 2=left edge, 3=right edge, 4=contents, 5=duplicate, 6=edit cursor
nudgeunit: 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
value: amount to nudge by, or value to set to
reverse: in nudge mode, nudges left (otherwise ignored)
copies: in nudge duplicate mode, number of copies (otherwise ignored)

void ArmCommand(int cmd, const char* sectionname)
ArmCommand(int cmd, "sectionname")
reaper.ArmCommand(integer cmd, string sectionname)
RPR_ArmCommand(Int cmd, String sectionname)

arms a command (or disarms if 0 passed) in section sectionname (empty string for main)

void Audio_Init()
Audio_Init()
reaper.Audio_Init()
RPR_Audio_Init()

open all audio and MIDI devices, if not open

int Audio_IsPreBuffer()
int Audio_IsPreBuffer()
integer reaper.Audio_IsPreBuffer()
Int RPR_Audio_IsPreBuffer()

is in pre-buffer? threadsafe

int Audio_IsRunning()
int Audio_IsRunning()
integer reaper.Audio_IsRunning()
Int RPR_Audio_IsRunning()

is audio running at all? threadsafe

void Audio_Quit()
Audio_Quit()
reaper.Audio_Quit()
RPR_Audio_Quit()

close all audio and MIDI devices, if open

bool AudioAccessorStateChanged(AudioAccessor* accessor)
bool AudioAccessorStateChanged(AudioAccessor accessor)
boolean reaper.AudioAccessorStateChanged(AudioAccessor accessor)
Boolean RPR_AudioAccessorStateChanged(AudioAccessor accessor)

Returns true if the underlying samples (track or media item take) have changed, but does not update the audio accessor, so the user can selectively call AudioAccessorValidateState only when needed. See CreateTakeAudioAccessor, CreateTrackAudioAccessor, DestroyAudioAccessor, GetAudioAccessorEndTime, GetAudioAccessorSamples.

void AudioAccessorUpdate(AudioAccessor* accessor)
AudioAccessorUpdate(AudioAccessor accessor)
reaper.AudioAccessorUpdate(AudioAccessor accessor)
RPR_AudioAccessorUpdate(AudioAccessor accessor)

Force the accessor to reload its state from the underlying track or media item take. See CreateTakeAudioAccessor, CreateTrackAudioAccessor, DestroyAudioAccessor, AudioAccessorStateChanged, GetAudioAccessorStartTime, GetAudioAccessorEndTime, GetAudioAccessorSamples.

bool AudioAccessorValidateState(AudioAccessor* accessor)
bool AudioAccessorValidateState(AudioAccessor accessor)
boolean reaper.AudioAccessorValidateState(AudioAccessor accessor)
Boolean RPR_AudioAccessorValidateState(AudioAccessor accessor)

Validates the current state of the audio accessor -- must ONLY call this from the main thread. Returns true if the state changed.

void BypassFxAllTracks(int bypass)
BypassFxAllTracks(int bypass)
reaper.BypassFxAllTracks(integer bypass)
RPR_BypassFxAllTracks(Int bypass)

-1 = bypass all if not all bypassed,otherwise unbypass all

void ClearAllRecArmed()
ClearAllRecArmed()
reaper.ClearAllRecArmed()
RPR_ClearAllRecArmed()
void ClearConsole()
ClearConsole()
reaper.ClearConsole()
RPR_ClearConsole()

Clear the ReaScript console. See ShowConsoleMsg

void ClearPeakCache()
ClearPeakCache()
reaper.ClearPeakCache()
RPR_ClearPeakCache()

resets the global peak caches

void ColorFromNative(int col, int* rOut, int* gOut, int* bOut)
ColorFromNative(int col, int &r, int &g, int &b)
integer r, integer g, integer b = reaper.ColorFromNative(integer col)
(Int col, Int rOut, Int gOut, Int bOut) = RPR_ColorFromNative(col, rOut, gOut, bOut)

Extract RGB values from an OS dependent color. See ColorToNative.

int ColorToNative(int r, int g, int b)
int ColorToNative(int r, int g, int b)
integer reaper.ColorToNative(integer r, integer g, integer b)
Int RPR_ColorToNative(Int r, Int g, Int b)

Make an OS dependent color from RGB values (e.g. RGB() macro on Windows). r,g and b are in [0..255]. See ColorFromNative.

int CountAutomationItems(TrackEnvelope* env)
int CountAutomationItems(TrackEnvelope env)
integer reaper.CountAutomationItems(TrackEnvelope env)
Int RPR_CountAutomationItems(TrackEnvelope env)

Returns the number of automation items on this envelope. See GetSetAutomationItemInfo

int CountEnvelopePoints(TrackEnvelope* envelope)
int CountEnvelopePoints(TrackEnvelope envelope)
integer reaper.CountEnvelopePoints(TrackEnvelope envelope)
Int RPR_CountEnvelopePoints(TrackEnvelope envelope)

Returns the number of points in the envelope. See CountEnvelopePointsEx.

int CountEnvelopePointsEx(TrackEnvelope* envelope, int autoitem_idx)
int CountEnvelopePointsEx(TrackEnvelope envelope, int autoitem_idx)
integer reaper.CountEnvelopePointsEx(TrackEnvelope envelope, integer autoitem_idx)
Int RPR_CountEnvelopePointsEx(TrackEnvelope envelope, Int autoitem_idx)

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.

int CountMediaItems(ReaProject* proj)
int CountMediaItems(ReaProject proj)
integer reaper.CountMediaItems(ReaProject proj)
Int RPR_CountMediaItems(ReaProject proj)

count the number of items in the project (proj=0 for active project)

int CountProjectMarkers(ReaProject* proj, int* num_markersOut, int* num_regionsOut)
int CountProjectMarkers(ReaProject proj, int &num_markers, int &num_regions)
integer retval, integer num_markers, integer num_regions = reaper.CountProjectMarkers(ReaProject proj)
(Int retval, ReaProject proj, Int num_markersOut, Int num_regionsOut) = RPR_CountProjectMarkers(proj, num_markersOut, num_regionsOut)

num_markersOut and num_regionsOut may be NULL.

int CountSelectedMediaItems(ReaProject* proj)
int CountSelectedMediaItems(ReaProject proj)
integer reaper.CountSelectedMediaItems(ReaProject proj)
Int RPR_CountSelectedMediaItems(ReaProject proj)

count the number of selected items in the project (proj=0 for active project)

int CountSelectedTracks(ReaProject* proj)
int CountSelectedTracks(ReaProject proj)
integer reaper.CountSelectedTracks(ReaProject proj)
Int RPR_CountSelectedTracks(ReaProject proj)

Count the number of selected tracks in the project (proj=0 for active project). This function ignores the master track, see CountSelectedTracks2.

int CountSelectedTracks2(ReaProject* proj, bool wantmaster)
int CountSelectedTracks2(ReaProject proj, bool wantmaster)
integer reaper.CountSelectedTracks2(ReaProject proj, boolean wantmaster)
Int RPR_CountSelectedTracks2(ReaProject proj, Boolean wantmaster)

Count the number of selected tracks in the project (proj=0 for active project).

int CountTakeEnvelopes(MediaItem_Take* take)
int CountTakeEnvelopes(MediaItem_Take take)
integer reaper.CountTakeEnvelopes(MediaItem_Take take)
Int RPR_CountTakeEnvelopes(MediaItem_Take take)

See GetTakeEnvelope

int CountTakes(MediaItem* item)
int CountTakes(MediaItem item)
integer reaper.CountTakes(MediaItem item)
Int RPR_CountTakes(MediaItem item)

count the number of takes in the item

int CountTCPFXParms(ReaProject* project, MediaTrack* track)
int CountTCPFXParms(ReaProject project, MediaTrack track)
integer reaper.CountTCPFXParms(ReaProject project, MediaTrack track)
Int RPR_CountTCPFXParms(ReaProject project, MediaTrack track)

Count the number of FX parameter knobs displayed on the track control panel.

int CountTempoTimeSigMarkers(ReaProject* proj)
int CountTempoTimeSigMarkers(ReaProject proj)
integer reaper.CountTempoTimeSigMarkers(ReaProject proj)
Int RPR_CountTempoTimeSigMarkers(ReaProject proj)

Count the number of tempo/time signature markers in the project. See GetTempoTimeSigMarker, SetTempoTimeSigMarker, AddTempoTimeSigMarker.

int CountTrackEnvelopes(MediaTrack* track)
int CountTrackEnvelopes(MediaTrack track)
integer reaper.CountTrackEnvelopes(MediaTrack track)
Int RPR_CountTrackEnvelopes(MediaTrack track)

see GetTrackEnvelope

int CountTrackMediaItems(MediaTrack* track)
int CountTrackMediaItems(MediaTrack track)
integer reaper.CountTrackMediaItems(MediaTrack track)
Int RPR_CountTrackMediaItems(MediaTrack track)

count the number of items in the track

int CountTracks(ReaProject* projOptional)
int CountTracks(ReaProject proj)
integer reaper.CountTracks(ReaProject proj)
Int RPR_CountTracks(ReaProject projOptional)

count the number of tracks in the project (proj=0 for active project)

MediaItem* CreateNewMIDIItemInProj(MediaTrack* track, double starttime, double endtime, const bool* qnInOptional)
MediaItem CreateNewMIDIItemInProj(MediaTrack track, starttime, endtime, optional bool qnIn)
MediaItem reaper.CreateNewMIDIItemInProj(MediaTrack track, number starttime, number endtime, optional boolean qnIn)
MediaItem RPR_CreateNewMIDIItemInProj(MediaTrack track, Float starttime, Float endtime, const bool qnInOptional)

Create a new MIDI media item, containing no MIDI events. Time is in seconds unless qn is set.

AudioAccessor* CreateTakeAudioAccessor(MediaItem_Take* take)
AudioAccessor CreateTakeAudioAccessor(MediaItem_Take take)
AudioAccessor reaper.CreateTakeAudioAccessor(MediaItem_Take take)
AudioAccessor RPR_CreateTakeAudioAccessor(MediaItem_Take take)

Create an audio accessor object for this take. Must only call from the main thread. See CreateTrackAudioAccessor, DestroyAudioAccessor, AudioAccessorStateChanged, GetAudioAccessorStartTime, GetAudioAccessorEndTime, GetAudioAccessorSamples.

AudioAccessor* CreateTrackAudioAccessor(MediaTrack* track)
AudioAccessor CreateTrackAudioAccessor(MediaTrack track)
AudioAccessor reaper.CreateTrackAudioAccessor(MediaTrack track)
AudioAccessor RPR_CreateTrackAudioAccessor(MediaTrack track)

Create an audio accessor object for this track. Must only call from the main thread. See CreateTakeAudioAccessor, DestroyAudioAccessor, AudioAccessorStateChanged, GetAudioAccessorStartTime, GetAudioAccessorEndTime, GetAudioAccessorSamples.

int CreateTrackSend(MediaTrack* tr, MediaTrack* desttrInOptional)
int CreateTrackSend(MediaTrack tr, MediaTrack desttrIn)
integer reaper.CreateTrackSend(MediaTrack tr, MediaTrack desttrIn)
Int RPR_CreateTrackSend(MediaTrack tr, MediaTrack desttrInOptional)

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.

void CSurf_FlushUndo(bool force)
CSurf_FlushUndo(bool force)
reaper.CSurf_FlushUndo(boolean force)
RPR_CSurf_FlushUndo(Boolean force)

call this to force flushing of the undo states after using CSurf_On*Change()

bool CSurf_GetTouchState(MediaTrack* trackid, int isPan)
bool CSurf_GetTouchState(MediaTrack trackid, int isPan)
boolean reaper.CSurf_GetTouchState(MediaTrack trackid, integer isPan)
Boolean RPR_CSurf_GetTouchState(MediaTrack trackid, Int isPan)
void CSurf_GoEnd()
CSurf_GoEnd()
reaper.CSurf_GoEnd()
RPR_CSurf_GoEnd()
void CSurf_GoStart()
CSurf_GoStart()
reaper.CSurf_GoStart()
RPR_CSurf_GoStart()
int CSurf_NumTracks(bool mcpView)
int CSurf_NumTracks(bool mcpView)
integer reaper.CSurf_NumTracks(boolean mcpView)
Int RPR_CSurf_NumTracks(Boolean mcpView)
void CSurf_OnArrow(int whichdir, bool wantzoom)
CSurf_OnArrow(int whichdir, bool wantzoom)
reaper.CSurf_OnArrow(integer whichdir, boolean wantzoom)
RPR_CSurf_OnArrow(Int whichdir, Boolean wantzoom)
void CSurf_OnFwd(int seekplay)
CSurf_OnFwd(int seekplay)
reaper.CSurf_OnFwd(integer seekplay)
RPR_CSurf_OnFwd(Int seekplay)
bool CSurf_OnFXChange(MediaTrack* trackid, int en)
bool CSurf_OnFXChange(MediaTrack trackid, int en)
boolean reaper.CSurf_OnFXChange(MediaTrack trackid, integer en)
Boolean RPR_CSurf_OnFXChange(MediaTrack trackid, Int en)
int CSurf_OnInputMonitorChange(MediaTrack* trackid, int monitor)
int CSurf_OnInputMonitorChange(MediaTrack trackid, int monitor)
integer reaper.CSurf_OnInputMonitorChange(MediaTrack trackid, integer monitor)
Int RPR_CSurf_OnInputMonitorChange(MediaTrack trackid, Int monitor)
int CSurf_OnInputMonitorChangeEx(MediaTrack* trackid, int monitor, bool allowgang)
int CSurf_OnInputMonitorChangeEx(MediaTrack trackid, int monitor, bool allowgang)
integer reaper.CSurf_OnInputMonitorChangeEx(MediaTrack trackid, integer monitor, boolean allowgang)
Int RPR_CSurf_OnInputMonitorChangeEx(MediaTrack trackid, Int monitor, Boolean allowgang)
bool CSurf_OnMuteChange(MediaTrack* trackid, int mute)
bool CSurf_OnMuteChange(MediaTrack trackid, int mute)
boolean reaper.CSurf_OnMuteChange(MediaTrack trackid, integer mute)
Boolean RPR_CSurf_OnMuteChange(MediaTrack trackid, Int mute)
bool CSurf_OnMuteChangeEx(MediaTrack* trackid, int mute, bool allowgang)
bool CSurf_OnMuteChangeEx(MediaTrack trackid, int mute, bool allowgang)
boolean reaper.CSurf_OnMuteChangeEx(MediaTrack trackid, integer mute, boolean allowgang)
Boolean RPR_CSurf_OnMuteChangeEx(MediaTrack trackid, Int mute, Boolean allowgang)
double CSurf_OnPanChange(MediaTrack* trackid, double pan, bool relative)
double CSurf_OnPanChange(MediaTrack trackid, pan, bool relative)
number reaper.CSurf_OnPanChange(MediaTrack trackid, number pan, boolean relative)
Float RPR_CSurf_OnPanChange(MediaTrack trackid, Float pan, Boolean relative)
double CSurf_OnPanChangeEx(MediaTrack* trackid, double pan, bool relative, bool allowGang)
double CSurf_OnPanChangeEx(MediaTrack trackid, pan, bool relative, bool allowGang)
number reaper.CSurf_OnPanChangeEx(MediaTrack trackid, number pan, boolean relative, boolean allowGang)
Float RPR_CSurf_OnPanChangeEx(MediaTrack trackid, Float pan, Boolean relative, Boolean allowGang)
void CSurf_OnPause()
CSurf_OnPause()
reaper.CSurf_OnPause()
RPR_CSurf_OnPause()
void CSurf_OnPlay()
CSurf_OnPlay()
reaper.CSurf_OnPlay()
RPR_CSurf_OnPlay()
void CSurf_OnPlayRateChange(double playrate)
CSurf_OnPlayRateChange(playrate)
reaper.CSurf_OnPlayRateChange(number playrate)
RPR_CSurf_OnPlayRateChange(Float playrate)
bool CSurf_OnRecArmChange(MediaTrack* trackid, int recarm)
bool CSurf_OnRecArmChange(MediaTrack trackid, int recarm)
boolean reaper.CSurf_OnRecArmChange(MediaTrack trackid, integer recarm)
Boolean RPR_CSurf_OnRecArmChange(MediaTrack trackid, Int recarm)
bool CSurf_OnRecArmChangeEx(MediaTrack* trackid, int recarm, bool allowgang)
bool CSurf_OnRecArmChangeEx(MediaTrack trackid, int recarm, bool allowgang)
boolean reaper.CSurf_OnRecArmChangeEx(MediaTrack trackid, integer recarm, boolean allowgang)
Boolean RPR_CSurf_OnRecArmChangeEx(MediaTrack trackid, Int recarm, Boolean allowgang)
void CSurf_OnRecord()
CSurf_OnRecord()
reaper.CSurf_OnRecord()
RPR_CSurf_OnRecord()
double CSurf_OnRecvPanChange(MediaTrack* trackid, int recv_index, double pan, bool relative)
double CSurf_OnRecvPanChange(MediaTrack trackid, int recv_index, pan, bool relative)
number reaper.CSurf_OnRecvPanChange(MediaTrack trackid, integer recv_index, number pan, boolean relative)
Float RPR_CSurf_OnRecvPanChange(MediaTrack trackid, Int recv_index, Float pan, Boolean relative)
double CSurf_OnRecvVolumeChange(MediaTrack* trackid, int recv_index, double volume, bool relative)
double CSurf_OnRecvVolumeChange(MediaTrack trackid, int recv_index, volume, bool relative)
number reaper.CSurf_OnRecvVolumeChange(MediaTrack trackid, integer recv_index, number volume, boolean relative)
Float RPR_CSurf_OnRecvVolumeChange(MediaTrack trackid, Int recv_index, Float volume, Boolean relative)
void CSurf_OnRew(int seekplay)
CSurf_OnRew(int seekplay)
reaper.CSurf_OnRew(integer seekplay)
RPR_CSurf_OnRew(Int seekplay)
void CSurf_OnRewFwd(int seekplay, int dir)
CSurf_OnRewFwd(int seekplay, int dir)
reaper.CSurf_OnRewFwd(integer seekplay, integer dir)
RPR_CSurf_OnRewFwd(Int seekplay, Int dir)
void CSurf_OnScroll(int xdir, int ydir)
CSurf_OnScroll(int xdir, int ydir)
reaper.CSurf_OnScroll(integer xdir, integer ydir)
RPR_CSurf_OnScroll(Int xdir, Int ydir)
bool CSurf_OnSelectedChange(MediaTrack* trackid, int selected)
bool CSurf_OnSelectedChange(MediaTrack trackid, int selected)
boolean reaper.CSurf_OnSelectedChange(MediaTrack trackid, integer selected)
Boolean RPR_CSurf_OnSelectedChange(MediaTrack trackid, Int selected)
double CSurf_OnSendPanChange(MediaTrack* trackid, int send_index, double pan, bool relative)
double CSurf_OnSendPanChange(MediaTrack trackid, int send_index, pan, bool relative)
number reaper.CSurf_OnSendPanChange(MediaTrack trackid, integer send_index, number pan, boolean relative)
Float RPR_CSurf_OnSendPanChange(MediaTrack trackid, Int send_index, Float pan, Boolean relative)
double CSurf_OnSendVolumeChange(MediaTrack* trackid, int send_index, double volume, bool relative)
double CSurf_OnSendVolumeChange(MediaTrack trackid, int send_index, volume, bool relative)
number reaper.CSurf_OnSendVolumeChange(MediaTrack trackid, integer send_index, number volume, boolean relative)
Float RPR_CSurf_OnSendVolumeChange(MediaTrack trackid, Int send_index, Float volume, Boolean relative)
bool CSurf_OnSoloChange(MediaTrack* trackid, int solo)
bool CSurf_OnSoloChange(MediaTrack trackid, int solo)
boolean reaper.CSurf_OnSoloChange(MediaTrack trackid, integer solo)
Boolean RPR_CSurf_OnSoloChange(MediaTrack trackid, Int solo)
bool CSurf_OnSoloChangeEx(MediaTrack* trackid, int solo, bool allowgang)
bool CSurf_OnSoloChangeEx(MediaTrack trackid, int solo, bool allowgang)
boolean reaper.CSurf_OnSoloChangeEx(MediaTrack trackid, integer solo, boolean allowgang)
Boolean RPR_CSurf_OnSoloChangeEx(MediaTrack trackid, Int solo, Boolean allowgang)
void CSurf_OnStop()
CSurf_OnStop()
reaper.CSurf_OnStop()
RPR_CSurf_OnStop()
void CSurf_OnTempoChange(double bpm)
CSurf_OnTempoChange(bpm)
reaper.CSurf_OnTempoChange(number bpm)
RPR_CSurf_OnTempoChange(Float bpm)
void CSurf_OnTrackSelection(MediaTrack* trackid)
CSurf_OnTrackSelection(MediaTrack trackid)
reaper.CSurf_OnTrackSelection(MediaTrack trackid)
RPR_CSurf_OnTrackSelection(MediaTrack trackid)
double CSurf_OnVolumeChange(MediaTrack* trackid, double volume, bool relative)
double CSurf_OnVolumeChange(MediaTrack trackid, volume, bool relative)
number reaper.CSurf_OnVolumeChange(MediaTrack trackid, number volume, boolean relative)
Float RPR_CSurf_OnVolumeChange(MediaTrack trackid, Float volume, Boolean relative)
double CSurf_OnVolumeChangeEx(MediaTrack* trackid, double volume, bool relative, bool allowGang)
double CSurf_OnVolumeChangeEx(MediaTrack trackid, volume, bool relative, bool allowGang)
number reaper.CSurf_OnVolumeChangeEx(MediaTrack trackid, number volume, boolean relative, boolean allowGang)
Float RPR_CSurf_OnVolumeChangeEx(MediaTrack trackid, Float volume, Boolean relative, Boolean allowGang)
double CSurf_OnWidthChange(MediaTrack* trackid, double width, bool relative)
double CSurf_OnWidthChange(MediaTrack trackid, width, bool relative)
number reaper.CSurf_OnWidthChange(MediaTrack trackid, number width, boolean relative)
Float RPR_CSurf_OnWidthChange(MediaTrack trackid, Float width, Boolean relative)
double CSurf_OnWidthChangeEx(MediaTrack* trackid, double width, bool relative, bool allowGang)
double CSurf_OnWidthChangeEx(MediaTrack trackid, width, bool relative, bool allowGang)
number reaper.CSurf_OnWidthChangeEx(MediaTrack trackid, number width, boolean relative, boolean allowGang)
Float RPR_CSurf_OnWidthChangeEx(MediaTrack trackid, Float width, Boolean relative, Boolean allowGang)
void CSurf_OnZoom(int xdir, int ydir)
CSurf_OnZoom(int xdir, int ydir)
reaper.CSurf_OnZoom(integer xdir, integer ydir)
RPR_CSurf_OnZoom(Int xdir, Int ydir)
void CSurf_ResetAllCachedVolPanStates()
CSurf_ResetAllCachedVolPanStates()
reaper.CSurf_ResetAllCachedVolPanStates()
RPR_CSurf_ResetAllCachedVolPanStates()
void CSurf_ScrubAmt(double amt)
CSurf_ScrubAmt(amt)
reaper.CSurf_ScrubAmt(number amt)
RPR_CSurf_ScrubAmt(Float amt)
void CSurf_SetAutoMode(int mode, IReaperControlSurface* ignoresurf)
CSurf_SetAutoMode(int mode, IReaperControlSurface ignoresurf)
reaper.CSurf_SetAutoMode(integer mode, IReaperControlSurface ignoresurf)
RPR_CSurf_SetAutoMode(Int mode, IReaperControlSurface ignoresurf)
void CSurf_SetPlayState(bool play, bool pause, bool rec, IReaperControlSurface* ignoresurf)
CSurf_SetPlayState(bool play, bool pause, bool rec, IReaperControlSurface ignoresurf)
reaper.CSurf_SetPlayState(boolean play, boolean pause, boolean rec, IReaperControlSurface ignoresurf)
RPR_CSurf_SetPlayState(Boolean play, Boolean pause, Boolean rec, IReaperControlSurface ignoresurf)
void CSurf_SetRepeatState(bool rep, IReaperControlSurface* ignoresurf)
CSurf_SetRepeatState(bool rep, IReaperControlSurface ignoresurf)
reaper.CSurf_SetRepeatState(boolean rep, IReaperControlSurface ignoresurf)
RPR_CSurf_SetRepeatState(Boolean rep, IReaperControlSurface ignoresurf)
void CSurf_SetSurfaceMute(MediaTrack* trackid, bool mute, IReaperControlSurface* ignoresurf)
CSurf_SetSurfaceMute(MediaTrack trackid, bool mute, IReaperControlSurface ignoresurf)
reaper.CSurf_SetSurfaceMute(MediaTrack trackid, boolean mute, IReaperControlSurface ignoresurf)
RPR_CSurf_SetSurfaceMute(MediaTrack trackid, Boolean mute, IReaperControlSurface ignoresurf)
void CSurf_SetSurfacePan(MediaTrack* trackid, double pan, IReaperControlSurface* ignoresurf)
CSurf_SetSurfacePan(MediaTrack trackid, pan, IReaperControlSurface ignoresurf)
reaper.CSurf_SetSurfacePan(MediaTrack trackid, number pan, IReaperControlSurface ignoresurf)
RPR_CSurf_SetSurfacePan(MediaTrack trackid, Float pan, IReaperControlSurface ignoresurf)
void CSurf_SetSurfaceRecArm(MediaTrack* trackid, bool recarm, IReaperControlSurface* ignoresurf)
CSurf_SetSurfaceRecArm(MediaTrack trackid, bool recarm, IReaperControlSurface ignoresurf)
reaper.CSurf_SetSurfaceRecArm(MediaTrack trackid, boolean recarm, IReaperControlSurface ignoresurf)
RPR_CSurf_SetSurfaceRecArm(MediaTrack trackid, Boolean recarm, IReaperControlSurface ignoresurf)
void CSurf_SetSurfaceSelected(MediaTrack* trackid, bool selected, IReaperControlSurface* ignoresurf)
CSurf_SetSurfaceSelected(MediaTrack trackid, bool selected, IReaperControlSurface ignoresurf)
reaper.CSurf_SetSurfaceSelected(MediaTrack trackid, boolean selected, IReaperControlSurface ignoresurf)
RPR_CSurf_SetSurfaceSelected(MediaTrack trackid, Boolean selected, IReaperControlSurface ignoresurf)
void CSurf_SetSurfaceSolo(MediaTrack* trackid, bool solo, IReaperControlSurface* ignoresurf)
CSurf_SetSurfaceSolo(MediaTrack trackid, bool solo, IReaperControlSurface ignoresurf)
reaper.CSurf_SetSurfaceSolo(MediaTrack trackid, boolean solo, IReaperControlSurface ignoresurf)
RPR_CSurf_SetSurfaceSolo(MediaTrack trackid, Boolean solo, IReaperControlSurface ignoresurf)
void CSurf_SetSurfaceVolume(MediaTrack* trackid, double volume, IReaperControlSurface* ignoresurf)
CSurf_SetSurfaceVolume(MediaTrack trackid, volume, IReaperControlSurface ignoresurf)
reaper.CSurf_SetSurfaceVolume(MediaTrack trackid, number volume, IReaperControlSurface ignoresurf)
RPR_CSurf_SetSurfaceVolume(MediaTrack trackid, Float volume, IReaperControlSurface ignoresurf)
void CSurf_SetTrackListChange()
CSurf_SetTrackListChange()
reaper.CSurf_SetTrackListChange()
RPR_CSurf_SetTrackListChange()
MediaTrack* CSurf_TrackFromID(int idx, bool mcpView)
MediaTrack CSurf_TrackFromID(int idx, bool mcpView)
MediaTrack reaper.CSurf_TrackFromID(integer idx, boolean mcpView)
MediaTrack RPR_CSurf_TrackFromID(Int idx, Boolean mcpView)
int CSurf_TrackToID(MediaTrack* track, bool mcpView)
int CSurf_TrackToID(MediaTrack track, bool mcpView)
integer reaper.CSurf_TrackToID(MediaTrack track, boolean mcpView)
Int RPR_CSurf_TrackToID(MediaTrack track, Boolean mcpView)
double DB2SLIDER(double x)
double DB2SLIDER(x)
number reaper.DB2SLIDER(number x)
Float RPR_DB2SLIDER(Float x)
bool DeleteEnvelopePointEx(TrackEnvelope* envelope, int autoitem_idx, int ptidx)
bool DeleteEnvelopePointEx(TrackEnvelope envelope, int autoitem_idx, int ptidx)
boolean reaper.DeleteEnvelopePointEx(TrackEnvelope envelope, integer autoitem_idx, integer ptidx)
Boolean RPR_DeleteEnvelopePointEx(TrackEnvelope envelope, Int autoitem_idx, Int ptidx)

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.

bool DeleteEnvelopePointRange(TrackEnvelope* envelope, double time_start, double time_end)
bool DeleteEnvelopePointRange(TrackEnvelope envelope, time_start, time_end)
boolean reaper.DeleteEnvelopePointRange(TrackEnvelope envelope, number time_start, number time_end)
Boolean RPR_DeleteEnvelopePointRange(TrackEnvelope envelope, Float time_start, Float time_end)

Delete a range of envelope points. See DeleteEnvelopePointRangeEx, DeleteEnvelopePointEx.

bool DeleteEnvelopePointRangeEx(TrackEnvelope* envelope, int autoitem_idx, double time_start, double time_end)
bool DeleteEnvelopePointRangeEx(TrackEnvelope envelope, int autoitem_idx, time_start, time_end)
boolean reaper.DeleteEnvelopePointRangeEx(TrackEnvelope envelope, integer autoitem_idx, number time_start, number time_end)
Boolean RPR_DeleteEnvelopePointRangeEx(TrackEnvelope envelope, Int autoitem_idx, Float time_start, Float time_end)

Delete a range of envelope points. autoitem_idx=-1 for the underlying envelope, 0 for the first automation item on the envelope, etc.

void DeleteExtState(const char* section, const char* key, bool persist)
DeleteExtState("section", "key", bool persist)
reaper.DeleteExtState(string section, string key, boolean persist)
RPR_DeleteExtState(String section, String key, Boolean persist)

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. See SetExtState, GetExtState, HasExtState.

bool DeleteProjectMarker(ReaProject* proj, int markrgnindexnumber, bool isrgn)
bool DeleteProjectMarker(ReaProject proj, int markrgnindexnumber, bool isrgn)
boolean reaper.DeleteProjectMarker(ReaProject proj, integer markrgnindexnumber, boolean isrgn)
Boolean RPR_DeleteProjectMarker(ReaProject proj, Int markrgnindexnumber, Boolean isrgn)

Delete a marker. proj==NULL for the active project.

bool DeleteProjectMarkerByIndex(ReaProject* proj, int markrgnidx)
bool DeleteProjectMarkerByIndex(ReaProject proj, int markrgnidx)
boolean reaper.DeleteProjectMarkerByIndex(ReaProject proj, integer markrgnidx)
Boolean RPR_DeleteProjectMarkerByIndex(ReaProject proj, Int markrgnidx)

Differs from DeleteProjectMarker only 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 SetProjectMarker4).

bool DeleteTakeMarker(MediaItem_Take* take, int idx)
bool DeleteTakeMarker(MediaItem_Take take, int idx)
boolean reaper.DeleteTakeMarker(MediaItem_Take take, integer idx)
Boolean RPR_DeleteTakeMarker(MediaItem_Take take, Int idx)

Delete a take marker. Note that idx will change for all following take markers. See GetNumTakeMarkers, GetTakeMarker, SetTakeMarker

int DeleteTakeStretchMarkers(MediaItem_Take* take, int idx, const int* countInOptional)
int DeleteTakeStretchMarkers(MediaItem_Take take, int idx, optional int countIn)
integer reaper.DeleteTakeStretchMarkers(MediaItem_Take take, integer idx, optional integer countIn)
Int RPR_DeleteTakeStretchMarkers(MediaItem_Take take, Int idx, const int countInOptional)

Deletes one or more stretch markers. Returns number of stretch markers deleted.

bool DeleteTempoTimeSigMarker(ReaProject* project, int markerindex)
bool DeleteTempoTimeSigMarker(ReaProject project, int markerindex)
boolean reaper.DeleteTempoTimeSigMarker(ReaProject project, integer markerindex)
Boolean RPR_DeleteTempoTimeSigMarker(ReaProject project, Int markerindex)

Delete a tempo/time signature marker.

void DeleteTrack(MediaTrack* tr)
DeleteTrack(MediaTrack tr)
reaper.DeleteTrack(MediaTrack tr)
RPR_DeleteTrack(MediaTrack tr)

deletes a track

bool DeleteTrackMediaItem(MediaTrack* tr, MediaItem* it)
bool DeleteTrackMediaItem(MediaTrack tr, MediaItem it)
boolean reaper.DeleteTrackMediaItem(MediaTrack tr, MediaItem it)
Boolean RPR_DeleteTrackMediaItem(MediaTrack tr, MediaItem it)
void DestroyAudioAccessor(AudioAccessor* accessor)
DestroyAudioAccessor(AudioAccessor accessor)
reaper.DestroyAudioAccessor(AudioAccessor accessor)
RPR_DestroyAudioAccessor(AudioAccessor accessor)

Destroy an audio accessor. Must only call from the main thread. See CreateTakeAudioAccessor, CreateTrackAudioAccessor, AudioAccessorStateChanged, GetAudioAccessorStartTime, GetAudioAccessorEndTime, GetAudioAccessorSamples.

void Dock_UpdateDockID(const char* ident_str, int whichDock)
Dock_UpdateDockID("ident_str", int whichDock)
reaper.Dock_UpdateDockID(string ident_str, integer whichDock)
RPR_Dock_UpdateDockID(String ident_str, Int whichDock)

updates preference for docker window ident_str to be in dock whichDock on next open

int DockGetPosition(int whichDock)
int DockGetPosition(int whichDock)
integer reaper.DockGetPosition(integer whichDock)
Int RPR_DockGetPosition(Int whichDock)

-1=not found, 0=bottom, 1=left, 2=top, 3=right, 4=floating

int DockIsChildOfDock(HWND hwnd, bool* isFloatingDockerOut)
int DockIsChildOfDock(HWND hwnd, bool &isFloatingDocker)
integer retval, boolean isFloatingDocker = reaper.DockIsChildOfDock(HWND hwnd)
(Int retval, HWND hwnd, Boolean isFloatingDockerOut) = RPR_DockIsChildOfDock(hwnd, isFloatingDockerOut)

returns dock index that contains hwnd, or -1

void DockWindowActivate(HWND hwnd)
DockWindowActivate(HWND hwnd)
reaper.DockWindowActivate(HWND hwnd)
RPR_DockWindowActivate(HWND hwnd)
void DockWindowAdd(HWND hwnd, const char* name, int pos, bool allowShow)
DockWindowAdd(HWND hwnd, "name", int pos, bool allowShow)
reaper.DockWindowAdd(HWND hwnd, string name, integer pos, boolean allowShow)
RPR_DockWindowAdd(HWND hwnd, String name, Int pos, Boolean allowShow)
void DockWindowAddEx(HWND hwnd, const char* name, const char* identstr, bool allowShow)
DockWindowAddEx(HWND hwnd, "name", "identstr", bool allowShow)
reaper.DockWindowAddEx(HWND hwnd, string name, string identstr, boolean allowShow)
RPR_DockWindowAddEx(HWND hwnd, String name, String identstr, Boolean allowShow)
void DockWindowRefresh()
DockWindowRefresh()
reaper.DockWindowRefresh()
RPR_DockWindowRefresh()
void DockWindowRefreshForHWND(HWND hwnd)
DockWindowRefreshForHWND(HWND hwnd)
reaper.DockWindowRefreshForHWND(HWND hwnd)
RPR_DockWindowRefreshForHWND(HWND hwnd)
void DockWindowRemove(HWND hwnd)
DockWindowRemove(HWND hwnd)
reaper.DockWindowRemove(HWND hwnd)
RPR_DockWindowRemove(HWND hwnd)
bool EditTempoTimeSigMarker(ReaProject* project, int markerindex)
bool EditTempoTimeSigMarker(ReaProject project, int markerindex)
boolean reaper.EditTempoTimeSigMarker(ReaProject project, integer markerindex)
Boolean RPR_EditTempoTimeSigMarker(ReaProject project, Int markerindex)

Open the tempo/time signature marker editor dialog.

void EnsureNotCompletelyOffscreen(RECT* rInOut)
EnsureNotCompletelyOffscreen(int &r.left, int &r.top, int &r.right, int &r.bot)
integerr.left, integerr.top, integerr.right, integerr.bot = reaper.EnsureNotCompletelyOffscreen(integerr.left, integerr.top, integerr.right, integerr.bot)
RPR_EnsureNotCompletelyOffscreen(RECT rInOut)

call with a saved window rect for your window and it'll correct any positioning info.

const char* EnumerateFiles(const char* path, int fileindex)
bool EnumerateFiles(#retval, "path", int fileindex)
string reaper.EnumerateFiles(string path, integer fileindex)
String RPR_EnumerateFiles(String path, Int fileindex)

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

const char* EnumerateSubdirectories(const char* path, int subdirindex)
bool EnumerateSubdirectories(#retval, "path", int subdirindex)
string reaper.EnumerateSubdirectories(string path, integer subdirindex)
String RPR_EnumerateSubdirectories(String path, Int subdirindex)

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

bool EnumPitchShiftModes(int mode, const char** strOut)
bool EnumPitchShiftModes(int mode, #str)
boolean retval, string str = reaper.EnumPitchShiftModes(integer mode)
Boolean RPR_EnumPitchShiftModes(Int mode, String strOut)

Start querying modes at 0, returns FALSE when no more modes possible, sets strOut to NULL if a mode is currently unsupported

const char* EnumPitchShiftSubModes(int mode, int submode)
bool EnumPitchShiftSubModes(#retval, int mode, int submode)
string reaper.EnumPitchShiftSubModes(integer mode, integer submode)
String RPR_EnumPitchShiftSubModes(Int mode, Int submode)

Returns submode name, or NULL

int EnumProjectMarkers(int idx, bool* isrgnOut, double* posOut, double* rgnendOut, const char** nameOut, int* markrgnindexnumberOut)
int EnumProjectMarkers(int idx, bool &isrgn, &pos, &rgnend, #name, int &markrgnindexnumber)
integer retval, boolean isrgn, number pos, number rgnend, string name, integer markrgnindexnumber = reaper.EnumProjectMarkers(integer idx)
(Int retval, Int idx, Boolean isrgnOut, Float posOut, Float rgnendOut, String nameOut, Int markrgnindexnumberOut) = RPR_EnumProjectMarkers(idx, isrgnOut, posOut, rgnendOut, nameOut, markrgnindexnumberOut)
int EnumProjectMarkers2(ReaProject* proj, int idx, bool* isrgnOut, double* posOut, double* rgnendOut, const char** nameOut, int* markrgnindexnumberOut)
int EnumProjectMarkers2(ReaProject proj, int idx, bool &isrgn, &pos, &rgnend, #name, int &markrgnindexnumber)
integer retval, boolean isrgn, number pos, number rgnend, string name, integer markrgnindexnumber = reaper.EnumProjectMarkers2(ReaProject proj, integer idx)
(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)
int EnumProjectMarkers3(ReaProject* proj, int idx, bool* isrgnOut, double* posOut, double* rgnendOut, const char** nameOut, int* markrgnindexnumberOut, int* colorOut)
int EnumProjectMarkers3(ReaProject proj, int idx, bool &isrgn, &pos, &rgnend, #name, int &markrgnindexnumber, int &color)
integer retval, boolean isrgn, number pos, number rgnend, string name, integer markrgnindexnumber, integer color = reaper.EnumProjectMarkers3(ReaProject proj, integer idx)
(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)
ReaProject* EnumProjects(int idx, char* projfnOutOptional, int projfnOutOptional_sz)
ReaProject EnumProjects(int idx, optional #projfn)
ReaProject retval, optional string projfn = reaper.EnumProjects(integer idx)
(ReaProject retval, Int idx, String projfnOutOptional, Int projfnOutOptional_sz) = RPR_EnumProjects(idx, projfnOutOptional, projfnOutOptional_sz)

idx=-1 for current project,projfn can be NULL if not interested in filename. use idx 0x40000000 for currently rendering project, if any.

bool EnumProjExtState(ReaProject* proj, const char* extname, int idx, char* keyOutOptional, int keyOutOptional_sz, char* valOutOptional, int valOutOptional_sz)
bool EnumProjExtState(ReaProject proj, "extname", int idx, optional #key, optional #val)
boolean retval, optional string key, optional string val = reaper.EnumProjExtState(ReaProject proj, string extname, integer idx)
(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)

Enumerate the data stored with the project for a specific extname. Returns false when there is no more data. See SetProjExtState, GetProjExtState.

MediaTrack* EnumRegionRenderMatrix(ReaProject* proj, int regionindex, int rendertrack)
MediaTrack EnumRegionRenderMatrix(ReaProject proj, int regionindex, int rendertrack)
MediaTrack reaper.EnumRegionRenderMatrix(ReaProject proj, integer regionindex, integer rendertrack)
MediaTrack RPR_EnumRegionRenderMatrix(ReaProject proj, Int regionindex, Int rendertrack)

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.

bool EnumTrackMIDIProgramNames(int track, int programNumber, char* programName, int programName_sz)
bool EnumTrackMIDIProgramNames(int track, int programNumber, #programName)
boolean retval, string programName = reaper.EnumTrackMIDIProgramNames(integer track, integer programNumber, string programName)
(Boolean retval, Int track, Int programNumber, String programName, Int programName_sz) = RPR_EnumTrackMIDIProgramNames(track, programNumber, programName, programName_sz)

returns false if there are no plugins on the track that support MIDI programs,or if all programs have been enumerated

bool EnumTrackMIDIProgramNamesEx(ReaProject* proj, MediaTrack* track, int programNumber, char* programName, int programName_sz)
bool EnumTrackMIDIProgramNamesEx(ReaProject proj, MediaTrack track, int programNumber, #programName)
boolean retval, string programName = reaper.EnumTrackMIDIProgramNamesEx(ReaProject proj, MediaTrack track, integer programNumber, string programName)
(Boolean retval, ReaProject proj, MediaTrack track, Int programNumber, String programName, Int programName_sz) = RPR_EnumTrackMIDIProgramNamesEx(proj, track, programNumber, programName, programName_sz)

returns false if there are no plugins on the track that support MIDI programs,or if all programs have been enumerated

int Envelope_Evaluate(TrackEnvelope* envelope, double time, double samplerate, int samplesRequested, double* valueOutOptional, double* dVdSOutOptional, double* ddVdSOutOptional, double* dddVdSOutOptional)
int Envelope_Evaluate(TrackEnvelope envelope, time, samplerate, int samplesRequested, optional &value, optional &dVdS, optional &ddVdS, optional &dddVdS)
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)
(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)

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.

void Envelope_FormatValue(TrackEnvelope* env, double value, char* bufOut, int bufOut_sz)
Envelope_FormatValue(TrackEnvelope env, value, #buf)
string buf = reaper.Envelope_FormatValue(TrackEnvelope env, number value)
(TrackEnvelope env, Float value, String bufOut, Int bufOut_sz) = RPR_Envelope_FormatValue(env, value, bufOut, bufOut_sz)

Formats the value of an envelope to a user-readable form

MediaItem_Take* Envelope_GetParentTake(TrackEnvelope* env, int* indexOutOptional, int* index2OutOptional)
MediaItem_Take Envelope_GetParentTake(TrackEnvelope env, optional int &index, optional int &index2)
MediaItem_Take retval, optional integer index, optional integer index2 = reaper.Envelope_GetParentTake(TrackEnvelope env)
(MediaItem_Take retval, TrackEnvelope env, Int indexOutOptional, Int index2OutOptional) = RPR_Envelope_GetParentTake(env, indexOutOptional, index2OutOptional)

If take envelope, gets the take from the envelope. If FX, indexOutOptional set to FX index, index2OutOptional set to parameter index, otherwise -1.

MediaTrack* Envelope_GetParentTrack(TrackEnvelope* env, int* indexOutOptional, int* index2OutOptional)
MediaTrack Envelope_GetParentTrack(TrackEnvelope env, optional int &index, optional int &index2)
MediaTrack retval, optional integer index, optional integer index2 = reaper.Envelope_GetParentTrack(TrackEnvelope env)
(MediaTrack retval, TrackEnvelope env, Int indexOutOptional, Int index2OutOptional) = RPR_Envelope_GetParentTrack(env, indexOutOptional, index2OutOptional)

If track envelope, gets the track from the envelope. If FX, indexOutOptional set to FX index, index2OutOptional set to parameter index, otherwise -1.

bool Envelope_SortPoints(TrackEnvelope* envelope)
bool Envelope_SortPoints(TrackEnvelope envelope)
boolean reaper.Envelope_SortPoints(TrackEnvelope envelope)
Boolean RPR_Envelope_SortPoints(TrackEnvelope envelope)

Sort envelope points by time. See SetEnvelopePoint, InsertEnvelopePoint.

bool Envelope_SortPointsEx(TrackEnvelope* envelope, int autoitem_idx)
bool Envelope_SortPointsEx(TrackEnvelope envelope, int autoitem_idx)
boolean reaper.Envelope_SortPointsEx(TrackEnvelope envelope, integer autoitem_idx)
Boolean RPR_Envelope_SortPointsEx(TrackEnvelope envelope, Int autoitem_idx)

Sort envelope points by time. autoitem_idx=-1 for the underlying envelope, 0 for the first automation item on the envelope, etc. See SetEnvelopePoint, InsertEnvelopePoint.

const char* ExecProcess(const char* cmdline, int timeoutmsec)
bool ExecProcess(#retval, "cmdline", int timeoutmsec)
string reaper.ExecProcess(string cmdline, integer timeoutmsec)
String RPR_ExecProcess(String cmdline, Int timeoutmsec)

Executes command line, returns NULL on total failure, otherwise the return value, a newline, and then the output of the command. If timeoutmsec is 0, command will be allowed to run indefinitely (recommended for large amounts of returned output). timeoutmsec is -1 for no wait/terminate, -2 for no wait and minimize

bool file_exists(const char* path)
bool file_exists("path")
boolean reaper.file_exists(string path)
Boolean RPR_file_exists(String path)

returns true if path points to a valid, readable file

int FindTempoTimeSigMarker(ReaProject* project, double time)
int FindTempoTimeSigMarker(ReaProject project, time)
integer reaper.FindTempoTimeSigMarker(ReaProject project, number time)
Int RPR_FindTempoTimeSigMarker(ReaProject project, Float time)

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).

void format_timestr(double tpos, char* buf, int buf_sz)
format_timestr(tpos, #buf)
string buf = reaper.format_timestr(number tpos, string buf)
(Float tpos, String buf, Int buf_sz) = RPR_format_timestr(tpos, buf, buf_sz)

Format tpos (which is time in seconds) as hh:mm:ss.sss. See format_timestr_pos, format_timestr_len.

void format_timestr_len(double tpos, char* buf, int buf_sz, double offset, int modeoverride)
format_timestr_len(tpos, #buf, offset, int modeoverride)
string buf = reaper.format_timestr_len(number tpos, string buf, number offset, integer modeoverride)
(Float tpos, String buf, Int buf_sz, Float offset, Int modeoverride) = RPR_format_timestr_len(tpos, buf, buf_sz, offset, modeoverride)

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
offset is start of where the length will be calculated from

void format_timestr_pos(double tpos, char* buf, int buf_sz, int modeoverride)
format_timestr_pos(tpos, #buf, int modeoverride)
string buf = reaper.format_timestr_pos(number tpos, string buf, integer modeoverride)
(Float tpos, String buf, Int buf_sz, Int modeoverride) = RPR_format_timestr_pos(tpos, buf, buf_sz, modeoverride)

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

void genGuid(GUID* g)
genGuid(#gGUID)
string gGUID = reaper.genGuid(string gGUID)
RPR_genGuid(GUID g)
bool get_config_var_string(const char* name, char* bufOut, int bufOut_sz)
bool get_config_var_string("name", #buf)
boolean retval, string buf = reaper.get_config_var_string(string name)
(Boolean retval, String name, String bufOut, Int bufOut_sz) = RPR_get_config_var_string(name, bufOut, bufOut_sz)

gets ini configuration variable value as string

const char* get_ini_file()
bool get_ini_file(#retval)
string reaper.get_ini_file()
String RPR_get_ini_file()

Get reaper.ini full filename.

MediaItem_Take* GetActiveTake(MediaItem* item)
MediaItem_Take GetActiveTake(MediaItem item)
MediaItem_Take reaper.GetActiveTake(MediaItem item)
MediaItem_Take RPR_GetActiveTake(MediaItem item)

get the active take in this item

int GetAllProjectPlayStates(ReaProject* ignoreProject)
int GetAllProjectPlayStates(ReaProject ignoreProject)
integer reaper.GetAllProjectPlayStates(ReaProject ignoreProject)
Int RPR_GetAllProjectPlayStates(ReaProject ignoreProject)

returns the bitwise OR of all project play states (1=playing, 2=pause, 4=recording)

const char* GetAppVersion()
bool GetAppVersion(#retval)
string reaper.GetAppVersion()
String RPR_GetAppVersion()

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

int GetArmedCommand(char* secOut, int secOut_sz)
int GetArmedCommand(#sec)
integer retval, string sec = reaper.GetArmedCommand()
(Int retval, String secOut, Int secOut_sz) = RPR_GetArmedCommand(secOut, secOut_sz)

gets the currently armed command and section name (returns 0 if nothing armed). section name is empty-string for main section.

double GetAudioAccessorEndTime(AudioAccessor* accessor)
double GetAudioAccessorEndTime(AudioAccessor accessor)
number reaper.GetAudioAccessorEndTime(AudioAccessor accessor)
Float RPR_GetAudioAccessorEndTime(AudioAccessor accessor)

Get the end time of the audio that can be returned from this accessor. See CreateTakeAudioAccessor, CreateTrackAudioAccessor, DestroyAudioAccessor, AudioAccessorStateChanged, GetAudioAccessorStartTime, GetAudioAccessorSamples.

void GetAudioAccessorHash(AudioAccessor* accessor, char* hashNeed128)
GetAudioAccessorHash(AudioAccessor accessor, #hashNeed128)
string hashNeed128 = reaper.GetAudioAccessorHash(AudioAccessor accessor, string hashNeed128)
(AudioAccessor accessor, String hashNeed128) = RPR_GetAudioAccessorHash(accessor, hashNeed128)

Deprecated. See AudioAccessorStateChanged instead.

int GetAudioAccessorSamples(AudioAccessor* accessor, int samplerate, int numchannels, double starttime_sec, int numsamplesperchannel, double* samplebuffer)
int GetAudioAccessorSamples(AudioAccessor accessor, int samplerate, int numchannels, starttime_sec, int numsamplesperchannel, buffer_ptr samplebuffer)
integer reaper.GetAudioAccessorSamples(AudioAccessor accessor, integer samplerate, integer numchannels, number starttime_sec, integer numsamplesperchannel, reaper.array samplebuffer)
(Int retval, AudioAccessor accessor, Int samplerate, Int numchannels, Float starttime_sec, Int numsamplesperchannel, Float samplebuffer) = RPR_GetAudioAccessorSamples(accessor, samplerate, numchannels, starttime_sec, numsamplesperchannel, samplebuffer)

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:

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.

double GetAudioAccessorStartTime(AudioAccessor* accessor)
double GetAudioAccessorStartTime(AudioAccessor accessor)
number reaper.GetAudioAccessorStartTime(AudioAccessor accessor)
Float RPR_GetAudioAccessorStartTime(AudioAccessor accessor)

Get the start time of the audio that can be returned from this accessor. See CreateTakeAudioAccessor, CreateTrackAudioAccessor, DestroyAudioAccessor, AudioAccessorStateChanged, GetAudioAccessorEndTime, GetAudioAccessorSamples.

bool GetAudioDeviceInfo(const char* attribute, char* descOut, int descOut_sz)
bool GetAudioDeviceInfo("attribute", #desc)
boolean retval, string desc = reaper.GetAudioDeviceInfo(string attribute)
(Boolean retval, String attribute, String descOut, Int descOut_sz) = RPR_GetAudioDeviceInfo(attribute, descOut, descOut_sz)

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.

int GetConfigWantsDock(const char* ident_str)
int GetConfigWantsDock("ident_str")
integer reaper.GetConfigWantsDock(string ident_str)
Int RPR_GetConfigWantsDock(String ident_str)

gets the dock ID desired by ident_str, if any

ReaProject* GetCurrentProjectInLoadSave()
ReaProject GetCurrentProjectInLoadSave()
ReaProject reaper.GetCurrentProjectInLoadSave()
ReaProject RPR_GetCurrentProjectInLoadSave()

returns current project if in load/save (usually only used from project_config_extension_t)

int GetCursorContext()
int GetCursorContext()
integer reaper.GetCursorContext()
Int RPR_GetCursorContext()

return the current cursor context: 0 if track panels, 1 if items, 2 if envelopes, otherwise unknown

int GetCursorContext2(bool want_last_valid)
int GetCursorContext2(bool want_last_valid)
integer reaper.GetCursorContext2(boolean want_last_valid)
Int RPR_GetCursorContext2(Boolean want_last_valid)

0 if track panels, 1 if items, 2 if envelopes, otherwise unknown (unlikely when want_last_valid is true)

double GetCursorPosition()
double GetCursorPosition()
number reaper.GetCursorPosition()
Float RPR_GetCursorPosition()

edit cursor position

double GetCursorPositionEx(ReaProject* proj)
double GetCursorPositionEx(ReaProject proj)
number reaper.GetCursorPositionEx(ReaProject proj)
Float RPR_GetCursorPositionEx(ReaProject proj)

edit cursor position

int GetDisplayedMediaItemColor(MediaItem* item)
int GetDisplayedMediaItemColor(MediaItem item)
integer reaper.GetDisplayedMediaItemColor(MediaItem item)
Int RPR_GetDisplayedMediaItemColor(MediaItem item)

see GetDisplayedMediaItemColor2.

int GetDisplayedMediaItemColor2(MediaItem* item, MediaItem_Take* take)
int GetDisplayedMediaItemColor2(MediaItem item, MediaItem_Take take)
integer reaper.GetDisplayedMediaItemColor2(MediaItem item, MediaItem_Take take)
Int RPR_GetDisplayedMediaItemColor2(MediaItem item, MediaItem_Take take)

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.

double GetEnvelopeInfo_Value(TrackEnvelope* env, const char* parmname)
double GetEnvelopeInfo_Value(TrackEnvelope env, "parmname")
number reaper.GetEnvelopeInfo_Value(TrackEnvelope env, string parmname)
Float RPR_GetEnvelopeInfo_Value(TrackEnvelope env, String parmname)

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_DESTTRACK : MediaTrack * : destination track pointer, if on a send
P_ITEM : MediaItem * : parent item pointer (if any)
P_TAKE : MediaItem_Take * : parent take pointer (if any)
I_SEND_IDX : int : 1-based index of send in P_TRACK, or 0 if not a send
I_HWOUT_IDX : int : 1-based index of hardware output in P_TRACK or 0 if not a hardware output
I_RECV_IDX : int : 1-based index of receive in P_DESTTRACK or 0 if not a send/receive

bool GetEnvelopeName(TrackEnvelope* env, char* bufOut, int bufOut_sz)
bool GetEnvelopeName(TrackEnvelope env, #buf)
boolean retval, string buf = reaper.GetEnvelopeName(TrackEnvelope env)
(Boolean retval, TrackEnvelope env, String bufOut, Int bufOut_sz) = RPR_GetEnvelopeName(env, bufOut, bufOut_sz)
bool GetEnvelopePoint(TrackEnvelope* envelope, int ptidx, double* timeOutOptional, double* valueOutOptional, int* shapeOutOptional, double* tensionOutOptional, bool* selectedOutOptional)
bool GetEnvelopePoint(TrackEnvelope envelope, int ptidx, optional &time, optional &value, optional int &shape, optional &tension, optional bool &selected)
boolean retval, optional number time, optional number value, optional integer shape, optional number tension, optional boolean selected = reaper.GetEnvelopePoint(TrackEnvelope envelope, integer ptidx)
(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)

Get the attributes of an envelope point. See GetEnvelopePointEx.

int GetEnvelopePointByTime(TrackEnvelope* envelope, double time)
int GetEnvelopePointByTime(TrackEnvelope envelope, time)
integer reaper.GetEnvelopePointByTime(TrackEnvelope envelope, number time)
Int RPR_GetEnvelopePointByTime(TrackEnvelope envelope, Float time)

Returns the envelope point at or immediately prior to the given time position. See GetEnvelopePointByTimeEx.

int GetEnvelopePointByTimeEx(TrackEnvelope* envelope, int autoitem_idx, double time)
int GetEnvelopePointByTimeEx(TrackEnvelope envelope, int autoitem_idx, time)
integer reaper.GetEnvelopePointByTimeEx(TrackEnvelope envelope, integer autoitem_idx, number time)
Int RPR_GetEnvelopePointByTimeEx(TrackEnvelope envelope, Int autoitem_idx, Float time)

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.

bool GetEnvelopePointEx(TrackEnvelope* envelope, int autoitem_idx, int ptidx, double* timeOutOptional, double* valueOutOptional, int* shapeOutOptional, double* tensionOutOptional, bool* selectedOutOptional)
bool GetEnvelopePointEx(TrackEnvelope envelope, int autoitem_idx, int ptidx, optional &time, optional &value, optional int &shape, optional &tension, optional bool &selected)
boolean retval, optional number time, optional number value, optional integer shape, optional number tension, optional boolean selected = reaper.GetEnvelopePointEx(TrackEnvelope envelope, integer autoitem_idx, integer ptidx)
(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)

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.

int GetEnvelopeScalingMode(TrackEnvelope* env)
int GetEnvelopeScalingMode(TrackEnvelope env)
integer reaper.GetEnvelopeScalingMode(TrackEnvelope env)
Int RPR_GetEnvelopeScalingMode(TrackEnvelope env)

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.

bool GetEnvelopeStateChunk(TrackEnvelope* env, char* strNeedBig, int strNeedBig_sz, bool isundoOptional)
bool GetEnvelopeStateChunk(TrackEnvelope env, #str, bool isundo)
boolean retval, string str = reaper.GetEnvelopeStateChunk(TrackEnvelope env, string str, boolean isundo)
(Boolean retval, TrackEnvelope env, String strNeedBig, Int strNeedBig_sz, Boolean isundoOptional) = RPR_GetEnvelopeStateChunk(env, strNeedBig, strNeedBig_sz, isundoOptional)

Gets the RPPXML state of an envelope, returns true if successful. Undo flag is a performance/caching hint.

const char* GetExePath()
bool GetExePath(#retval)
string reaper.GetExePath()
String RPR_GetExePath()

returns path of REAPER.exe (not including EXE), i.e. C:\Program Files\REAPER

const char* GetExtState(const char* section, const char* key)
bool GetExtState(#retval, "section", "key")
string reaper.GetExtState(string section, string key)
String RPR_GetExtState(String section, String key)

Get the extended state value for a specific section and key. See SetExtState, DeleteExtState, HasExtState.

int GetFocusedFX(int* tracknumberOut, int* itemnumberOut, int* fxnumberOut)
int GetFocusedFX(int &tracknumber, int &itemnumber, int &fxnumber)
integer retval, integer tracknumber, integer itemnumber, integer fxnumber = reaper.GetFocusedFX()
(Int retval, Int tracknumberOut, Int itemnumberOut, Int fxnumberOut) = RPR_GetFocusedFX(tracknumberOut, itemnumberOut, fxnumberOut)

This function is deprecated (returns GetFocusedFX2()&3), see GetFocusedFX2.

int GetFocusedFX2(int* tracknumberOut, int* itemnumberOut, int* fxnumberOut)
int GetFocusedFX2(int &tracknumber, int &itemnumber, int &fxnumber)
integer retval, integer tracknumber, integer itemnumber, integer fxnumber = reaper.GetFocusedFX2()
(Int retval, Int tracknumberOut, Int itemnumberOut, Int fxnumberOut) = RPR_GetFocusedFX2(tracknumberOut, itemnumberOut, fxnumberOut)

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.

int GetFreeDiskSpaceForRecordPath(ReaProject* proj, int pathidx)
int GetFreeDiskSpaceForRecordPath(ReaProject proj, int pathidx)
integer reaper.GetFreeDiskSpaceForRecordPath(ReaProject proj, integer pathidx)
Int RPR_GetFreeDiskSpaceForRecordPath(ReaProject proj, Int pathidx)

returns free disk space in megabytes, pathIdx 0 for normal, 1 for alternate.

TrackEnvelope* GetFXEnvelope(MediaTrack* track, int fxindex, int parameterindex, bool create)
TrackEnvelope GetFXEnvelope(MediaTrack track, int fxindex, int parameterindex, bool create)
TrackEnvelope reaper.GetFXEnvelope(MediaTrack track, integer fxindex, integer parameterindex, boolean create)
TrackEnvelope RPR_GetFXEnvelope(MediaTrack track, Int fxindex, Int parameterindex, Boolean create)

Returns the FX parameter envelope. If the envelope does not exist and create=true, the envelope will be created.

int GetGlobalAutomationOverride()
int GetGlobalAutomationOverride()
integer reaper.GetGlobalAutomationOverride()
Int RPR_GetGlobalAutomationOverride()

return -1=no override, 0=trim/read, 1=read, 2=touch, 3=write, 4=latch, 5=bypass

double GetHZoomLevel()
double GetHZoomLevel()
number reaper.GetHZoomLevel()
Float RPR_GetHZoomLevel()

returns pixels/second

const char* GetInputChannelName(int channelIndex)
bool GetInputChannelName(#retval, int channelIndex)
string reaper.GetInputChannelName(integer channelIndex)
String RPR_GetInputChannelName(Int channelIndex)
void GetInputOutputLatency(int* inputlatencyOut, int* outputLatencyOut)
GetInputOutputLatency(int &inputlatency, int &outputLatency)
integer inputlatency, integer outputLatency = reaper.GetInputOutputLatency()
(Int inputlatencyOut, Int outputLatencyOut) = RPR_GetInputOutputLatency(inputlatencyOut, outputLatencyOut)

Gets the audio device input/output latency in samples

double GetItemEditingTime2(PCM_source** which_itemOut, int* flagsOut)
double GetItemEditingTime2(PCM_source &which_item, int &flags)
number, PCM_source which_item, integer flags = reaper.GetItemEditingTime2()
(Float retval, PCM_source* which_itemOut, Int flagsOut) = RPR_GetItemEditingTime2(which_itemOut, flagsOut)

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)

MediaItem* GetItemFromPoint(int screen_x, int screen_y, bool allow_locked, MediaItem_Take** takeOutOptional)
MediaItem GetItemFromPoint(int screen_x, int screen_y, bool allow_locked, MediaItem_Take &take)
MediaItem, MediaItem_Take take = reaper.GetItemFromPoint(integer screen_x, integer screen_y, boolean allow_locked)
MediaItem RPR_GetItemFromPoint(Int screen_x, Int screen_y, Boolean allow_locked, MediaItem_Take* takeOutOptional)

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. See GetThingFromPoint.

ReaProject* GetItemProjectContext(MediaItem* item)
ReaProject GetItemProjectContext(MediaItem item)
ReaProject reaper.GetItemProjectContext(MediaItem item)
ReaProject RPR_GetItemProjectContext(MediaItem item)
bool GetItemStateChunk(MediaItem* item, char* strNeedBig, int strNeedBig_sz, bool isundoOptional)
bool GetItemStateChunk(MediaItem item, #str, bool isundo)
boolean retval, string str = reaper.GetItemStateChunk(MediaItem item, string str, boolean isundo)
(Boolean retval, MediaItem item, String strNeedBig, Int strNeedBig_sz, Boolean isundoOptional) = RPR_GetItemStateChunk(item, strNeedBig, strNeedBig_sz, isundoOptional)

Gets the RPPXML state of an item, returns true if successful. Undo flag is a performance/caching hint.

const char* GetLastColorThemeFile()
bool GetLastColorThemeFile(#retval)
string reaper.GetLastColorThemeFile()
String RPR_GetLastColorThemeFile()
void GetLastMarkerAndCurRegion(ReaProject* proj, double time, int* markeridxOut, int* regionidxOut)
GetLastMarkerAndCurRegion(ReaProject proj, time, int &markeridx, int &regionidx)
integer markeridx, integer regionidx = reaper.GetLastMarkerAndCurRegion(ReaProject proj, number time)
(ReaProject proj, Float time, Int markeridxOut, Int regionidxOut) = RPR_GetLastMarkerAndCurRegion(proj, time, markeridxOut, regionidxOut)

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.

bool GetLastTouchedFX(int* tracknumberOut, int* fxnumberOut, int* paramnumberOut)
bool GetLastTouchedFX(int &tracknumber, int &fxnumber, int &paramnumber)
boolean retval, integer tracknumber, integer fxnumber, integer paramnumber = reaper.GetLastTouchedFX()
(Boolean retval, Int tracknumberOut, Int fxnumberOut, Int paramnumberOut) = RPR_GetLastTouchedFX(tracknumberOut, fxnumberOut, paramnumberOut)

Returns true if the last touched FX parameter is valid, false otherwise. The low word of tracknumber is the 1-based track index -- 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). 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.

MediaTrack* GetLastTouchedTrack()
MediaTrack GetLastTouchedTrack()
MediaTrack reaper.GetLastTouchedTrack()
MediaTrack RPR_GetLastTouchedTrack()
HWND GetMainHwnd()
HWND GetMainHwnd()
HWND reaper.GetMainHwnd()
HWND RPR_GetMainHwnd()
int GetMasterMuteSoloFlags()
int GetMasterMuteSoloFlags()
integer reaper.GetMasterMuteSoloFlags()
Int RPR_GetMasterMuteSoloFlags()

&1=master mute,&2=master solo. This is deprecated as you can just query the master track as well.

MediaTrack* GetMasterTrack(ReaProject* proj)
MediaTrack GetMasterTrack(ReaProject proj)
MediaTrack reaper.GetMasterTrack(ReaProject proj)
MediaTrack RPR_GetMasterTrack(ReaProject proj)
int GetMasterTrackVisibility()
int GetMasterTrackVisibility()
integer reaper.GetMasterTrackVisibility()
Int RPR_GetMasterTrackVisibility()

returns &1 if the master track is visible in the TCP, &2 if NOT visible in the mixer. See SetMasterTrackVisibility.

int GetMaxMidiInputs()
int GetMaxMidiInputs()
integer reaper.GetMaxMidiInputs()
Int RPR_GetMaxMidiInputs()

returns max dev for midi inputs/outputs

int GetMaxMidiOutputs()
int GetMaxMidiOutputs()
integer reaper.GetMaxMidiOutputs()
Int RPR_GetMaxMidiOutputs()
int GetMediaFileMetadata(PCM_source* mediaSource, const char* identifier, char* bufOutNeedBig, int bufOutNeedBig_sz)
int GetMediaFileMetadata(PCM_source mediaSource, "identifier", #buf)
integer retval, string buf = reaper.GetMediaFileMetadata(PCM_source mediaSource, string identifier)
(Int retval, PCM_source mediaSource, String identifier, String bufOutNeedBig, Int bufOutNeedBig_sz) = RPR_GetMediaFileMetadata(mediaSource, identifier, bufOutNeedBig, bufOutNeedBig_sz)

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.

MediaItem* GetMediaItem(ReaProject* proj, int itemidx)
MediaItem GetMediaItem(ReaProject proj, int itemidx)
MediaItem reaper.GetMediaItem(ReaProject proj, integer itemidx)
MediaItem RPR_GetMediaItem(ReaProject proj, Int itemidx)

get an item from a project by item count (zero-based) (proj=0 for active project)

MediaTrack* GetMediaItem_Track(MediaItem* item)
MediaTrack GetMediaItem_Track(MediaItem item)
MediaTrack reaper.GetMediaItem_Track(MediaItem item)
MediaTrack RPR_GetMediaItem_Track(MediaItem item)

Get parent track of media item

double GetMediaItemInfo_Value(MediaItem* item, const char* parmname)
double GetMediaItemInfo_Value(MediaItem item, "parmname")
number reaper.GetMediaItemInfo_Value(MediaItem item, string parmname)
Float RPR_GetMediaItemInfo_Value(MediaItem item, String parmname)

Get media item numerical-value attributes.
B_MUTE : bool * : muted (item solo overrides). setting this value will clear C_MUTE_SOLO.
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
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 (relative to top of track) in pixels (read-only)
I_LASTH : int * : height 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)

int GetMediaItemNumTakes(MediaItem* item)
int GetMediaItemNumTakes(MediaItem item)
integer reaper.GetMediaItemNumTakes(MediaItem item)
Int RPR_GetMediaItemNumTakes(MediaItem item)
MediaItem_Take* GetMediaItemTake(MediaItem* item, int tk)
MediaItem_Take GetMediaItemTake(MediaItem item, int tk)
MediaItem_Take reaper.GetMediaItemTake(MediaItem item, integer tk)
MediaItem_Take RPR_GetMediaItemTake(MediaItem item, Int tk)
MediaItem* GetMediaItemTake_Item(MediaItem_Take* take)
MediaItem GetMediaItemTake_Item(MediaItem_Take take)
MediaItem reaper.GetMediaItemTake_Item(MediaItem_Take take)
MediaItem RPR_GetMediaItemTake_Item(MediaItem_Take take)

Get parent item of media item take

int GetMediaItemTake_Peaks(MediaItem_Take* take, double peakrate, double starttime, int numchannels, int numsamplesperchannel, int want_extra_type, double* buf)
int GetMediaItemTake_Peaks(MediaItem_Take take, peakrate, starttime, int numchannels, int numsamplesperchannel, int want_extra_type, buffer_ptr buf)
integer reaper.GetMediaItemTake_Peaks(MediaItem_Take take, number peakrate, number starttime, integer numchannels, integer numsamplesperchannel, integer want_extra_type, reaper.array buf)
(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)

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.

PCM_source* GetMediaItemTake_Source(MediaItem_Take* take)
PCM_source GetMediaItemTake_Source(MediaItem_Take take)
PCM_source reaper.GetMediaItemTake_Source(MediaItem_Take take)
PCM_source RPR_GetMediaItemTake_Source(MediaItem_Take take)

Get media source of media item take

MediaTrack* GetMediaItemTake_Track(MediaItem_Take* take)
MediaTrack GetMediaItemTake_Track(MediaItem_Take take)
MediaTrack reaper.GetMediaItemTake_Track(MediaItem_Take take)
MediaTrack RPR_GetMediaItemTake_Track(MediaItem_Take take)

Get parent track of media item take

MediaItem_Take* GetMediaItemTakeByGUID(ReaProject* project, const GUID* guid)
MediaItem_Take GetMediaItemTakeByGUID(ReaProject project, "guidGUID")
MediaItem_Take reaper.GetMediaItemTakeByGUID(ReaProject project, string guidGUID)
MediaItem_Take RPR_GetMediaItemTakeByGUID(ReaProject project, const GUID guid)
double GetMediaItemTakeInfo_Value(MediaItem_Take* take, const char* parmname)
double GetMediaItemTakeInfo_Value(MediaItem_Take take, "parmname")
number reaper.GetMediaItemTakeInfo_Value(MediaItem_Take take, string parmname)
Float RPR_GetMediaItemTakeInfo_Value(MediaItem_Take take, String parmname)

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_LASTY : int * : Y-position (relative to top of track) in pixels (read-only)
I_LASTH : int * : height in pixels (read-only)
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.

MediaTrack* GetMediaItemTrack(MediaItem* item)
MediaTrack GetMediaItemTrack(MediaItem item)
MediaTrack reaper.GetMediaItemTrack(MediaItem item)
MediaTrack RPR_GetMediaItemTrack(MediaItem item)
void GetMediaSourceFileName(PCM_source* source, char* filenamebufOut, int filenamebufOut_sz)
GetMediaSourceFileName(PCM_source source, #filenamebuf)
string filenamebuf = reaper.GetMediaSourceFileName(PCM_source source)
(PCM_source source, String filenamebufOut, Int filenamebufOut_sz) = RPR_GetMediaSourceFileName(source, filenamebufOut, filenamebufOut_sz)

Copies the media source filename to filenamebuf. Note that in-project MIDI media sources have no associated filename. See GetMediaSourceParent.

double GetMediaSourceLength(PCM_source* source, bool* lengthIsQNOut)
double GetMediaSourceLength(PCM_source source, bool &lengthIsQN)
number retval, boolean lengthIsQN = reaper.GetMediaSourceLength(PCM_source source)
(Float retval, PCM_source source, Boolean lengthIsQNOut) = RPR_GetMediaSourceLength(source, lengthIsQNOut)

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.

int GetMediaSourceNumChannels(PCM_source* source)
int GetMediaSourceNumChannels(PCM_source source)
integer reaper.GetMediaSourceNumChannels(PCM_source source)
Int RPR_GetMediaSourceNumChannels(PCM_source source)

Returns the number of channels in the source media.

PCM_source* GetMediaSourceParent(PCM_source* src)
PCM_source GetMediaSourceParent(PCM_source src)
PCM_source reaper.GetMediaSourceParent(PCM_source src)
PCM_source RPR_GetMediaSourceParent(PCM_source src)

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.

int GetMediaSourceSampleRate(PCM_source* source)
int GetMediaSourceSampleRate(PCM_source source)
integer reaper.GetMediaSourceSampleRate(PCM_source source)
Int RPR_GetMediaSourceSampleRate(PCM_source source)

Returns the sample rate. MIDI source media will return zero.

void GetMediaSourceType(PCM_source* source, char* typebufOut, int typebufOut_sz)
GetMediaSourceType(PCM_source source, #typebuf)
string typebuf = reaper.GetMediaSourceType(PCM_source source)
(PCM_source source, String typebufOut, Int typebufOut_sz) = RPR_GetMediaSourceType(source, typebufOut, typebufOut_sz)

copies the media source type ("WAV", "MIDI", etc) to typebuf

double GetMediaTrackInfo_Value(MediaTrack* tr, const char* parmname)
double GetMediaTrackInfo_Value(MediaTrack tr, "parmname")
number reaper.GetMediaTrackInfo_Value(MediaTrack tr, string parmname)
Float RPR_GetMediaTrackInfo_Value(MediaTrack tr, String parmname)

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
B_SOLO_DEFEAT : bool * : when set, if anything else is soloed and this track is not muted, this track acts soloed
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
B_AUTO_RECARM : bool * : automatically set record arm when selected (does not immediately affect recarm state, script should set directly if desired)
I_VUMODE : int * : track vu mode, &1:disabled, &30==0:stereo peaks, &30==2:multichannel peaks, &30==4:stereo RMS, &30==8:combined RMS, &30==12:LUFS-M, &30==16:LUFS-S (readout=max), &30==20:LUFS-S (readout=current), &32:LUFS calculation on channels 1+2 only
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 (read-only)
I_MCPY : int * : current MCP Y-position in pixels relative to mixer container (read-only)
I_MCPW : int * : current MCP width in pixels (read-only)
I_MCPH : int * : current MCP height in pixels (read-only)
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
C_MAINSEND_NCH : char * : channel count of track send to parent (0=use all child track channels, 1=use one channel only)
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)

bool GetMIDIInputName(int dev, char* nameout, int nameout_sz)
bool GetMIDIInputName(int dev, #nameout)
boolean retval, string nameout = reaper.GetMIDIInputName(integer dev, string nameout)
(Boolean retval, Int dev, String nameout, Int nameout_sz) = RPR_GetMIDIInputName(dev, nameout, nameout_sz)

returns true if device present

bool GetMIDIOutputName(int dev, char* nameout, int nameout_sz)
bool GetMIDIOutputName(int dev, #nameout)
boolean retval, string nameout = reaper.GetMIDIOutputName(integer dev, string nameout)
(Boolean retval, Int dev, String nameout, Int nameout_sz) = RPR_GetMIDIOutputName(dev, nameout, nameout_sz)

returns true if device present

MediaTrack* GetMixerScroll()
MediaTrack GetMixerScroll()
MediaTrack reaper.GetMixerScroll()
MediaTrack RPR_GetMixerScroll()

Get the leftmost track visible in the mixer

void GetMouseModifier(const char* context, int modifier_flag, char* actionOut, int actionOut_sz)
GetMouseModifier("context", int modifier_flag, #action)
string action = reaper.GetMouseModifier(string context, integer modifier_flag)
(String context, Int modifier_flag, String actionOut, Int actionOut_sz) = RPR_GetMouseModifier(context, modifier_flag, actionOut, actionOut_sz)

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.

void GetMousePosition(int* xOut, int* yOut)
GetMousePosition(int &x, int &y)
integer x, integer y = reaper.GetMousePosition()
(Int xOut, Int yOut) = RPR_GetMousePosition(xOut, yOut)

get mouse position in screen coordinates

int GetNumAudioInputs()
int GetNumAudioInputs()
integer reaper.GetNumAudioInputs()
Int RPR_GetNumAudioInputs()

Return number of normal audio hardware inputs available

int GetNumAudioOutputs()
int GetNumAudioOutputs()
integer reaper.GetNumAudioOutputs()
Int RPR_GetNumAudioOutputs()

Return number of normal audio hardware outputs available

int GetNumMIDIInputs()
int GetNumMIDIInputs()
integer reaper.GetNumMIDIInputs()
Int RPR_GetNumMIDIInputs()

returns max number of real midi hardware inputs

int GetNumMIDIOutputs()
int GetNumMIDIOutputs()
integer reaper.GetNumMIDIOutputs()
Int RPR_GetNumMIDIOutputs()

returns max number of real midi hardware outputs

int GetNumTakeMarkers(MediaItem_Take* take)
int GetNumTakeMarkers(MediaItem_Take take)
integer reaper.GetNumTakeMarkers(MediaItem_Take take)
Int RPR_GetNumTakeMarkers(MediaItem_Take take)

Returns number of take markers. See GetTakeMarker, SetTakeMarker, DeleteTakeMarker

int GetNumTracks()
int GetNumTracks()
integer reaper.GetNumTracks()
Int RPR_GetNumTracks()
const char* GetOS()
bool GetOS(#retval)
string reaper.GetOS()
String RPR_GetOS()

Returns "Win32", "Win64", "OSX32", "OSX64", "macOS-arm64", or "Other".

const char* GetOutputChannelName(int channelIndex)
bool GetOutputChannelName(#retval, int channelIndex)
string reaper.GetOutputChannelName(integer channelIndex)
String RPR_GetOutputChannelName(Int channelIndex)
double GetOutputLatency()
double GetOutputLatency()
number reaper.GetOutputLatency()
Float RPR_GetOutputLatency()

returns output latency in seconds

MediaTrack* GetParentTrack(MediaTrack* track)
MediaTrack GetParentTrack(MediaTrack track)
MediaTrack reaper.GetParentTrack(MediaTrack track)
MediaTrack RPR_GetParentTrack(MediaTrack track)
void GetPeakFileName(const char* fn, char* bufOut, int bufOut_sz)
GetPeakFileName("fn", #buf)
string buf = reaper.GetPeakFileName(string fn)
(String fn, String bufOut, Int bufOut_sz) = RPR_GetPeakFileName(fn, bufOut, bufOut_sz)

get the peak file name for a given file (can be either filename.reapeaks,or a hashed filename in another path)

void GetPeakFileNameEx(const char* fn, char* buf, int buf_sz, bool forWrite)
GetPeakFileNameEx("fn", #buf, bool forWrite)
string buf = reaper.GetPeakFileNameEx(string fn, string buf, boolean forWrite)
(String fn, String buf, Int buf_sz, Boolean forWrite) = RPR_GetPeakFileNameEx(fn, buf, buf_sz, forWrite)

get the peak file name for a given file (can be either filename.reapeaks,or a hashed filename in another path)

void GetPeakFileNameEx2(const char* fn, char* buf, int buf_sz, bool forWrite, const char* peaksfileextension)
GetPeakFileNameEx2("fn", #buf, bool forWrite, "peaksfileextension")
string buf = reaper.GetPeakFileNameEx2(string fn, string buf, boolean forWrite, string peaksfileextension)
(String fn, String buf, Int buf_sz, Boolean forWrite, String peaksfileextension) = RPR_GetPeakFileNameEx2(fn, buf, buf_sz, forWrite, peaksfileextension)

Like GetPeakFileNameEx, but you can specify peaksfileextension such as ".reapeaks"

double GetPlayPosition()
double GetPlayPosition()
number reaper.GetPlayPosition()
Float RPR_GetPlayPosition()

returns latency-compensated actual-what-you-hear position

double GetPlayPosition2()
double GetPlayPosition2()
number reaper.GetPlayPosition2()
Float RPR_GetPlayPosition2()

returns position of next audio block being processed

double GetPlayPosition2Ex(ReaProject* proj)
double GetPlayPosition2Ex(ReaProject proj)
number reaper.GetPlayPosition2Ex(ReaProject proj)
Float RPR_GetPlayPosition2Ex(ReaProject proj)

returns position of next audio block being processed

double GetPlayPositionEx(ReaProject* proj)
double GetPlayPositionEx(ReaProject proj)
number reaper.GetPlayPositionEx(ReaProject proj)
Float RPR_GetPlayPositionEx(ReaProject proj)

returns latency-compensated actual-what-you-hear position

int GetPlayState()
int GetPlayState()
integer reaper.GetPlayState()
Int RPR_GetPlayState()

&1=playing,&2=pause,&=4 is recording

int GetPlayStateEx(ReaProject* proj)
int GetPlayStateEx(ReaProject proj)
integer reaper.GetPlayStateEx(ReaProject proj)
Int RPR_GetPlayStateEx(ReaProject proj)

&1=playing,&2=pause,&=4 is recording

double GetProjectLength(ReaProject* proj)
double GetProjectLength(ReaProject proj)
number reaper.GetProjectLength(ReaProject proj)
Float RPR_GetProjectLength(ReaProject proj)

returns length of project (maximum of end of media item, markers, end of regions, tempo map

void GetProjectName(ReaProject* proj, char* bufOut, int bufOut_sz)
GetProjectName(ReaProject proj, #buf)
string buf = reaper.GetProjectName(ReaProject proj)
(ReaProject proj, String bufOut, Int bufOut_sz) = RPR_GetProjectName(proj, bufOut, bufOut_sz)
void GetProjectPath(char* bufOut, int bufOut_sz)
GetProjectPath(#buf)
string buf = reaper.GetProjectPath()
(String bufOut, Int bufOut_sz) = RPR_GetProjectPath(bufOut, bufOut_sz)

Get the project recording path.

void GetProjectPathEx(ReaProject* proj, char* bufOut, int bufOut_sz)
GetProjectPathEx(ReaProject proj, #buf)
string buf = reaper.GetProjectPathEx(ReaProject proj)
(ReaProject proj, String bufOut, Int bufOut_sz) = RPR_GetProjectPathEx(proj, bufOut, bufOut_sz)

Get the project recording path.

int GetProjectStateChangeCount(ReaProject* proj)
int GetProjectStateChangeCount(ReaProject proj)
integer reaper.GetProjectStateChangeCount(ReaProject proj)
Int RPR_GetProjectStateChangeCount(ReaProject proj)

returns an integer that changes when the project state changes

double GetProjectTimeOffset(ReaProject* proj, bool rndframe)
double GetProjectTimeOffset(ReaProject proj, bool rndframe)
number reaper.GetProjectTimeOffset(ReaProject proj, boolean rndframe)
Float RPR_GetProjectTimeOffset(ReaProject proj, Boolean rndframe)

Gets project time offset in seconds (project settings - project start time). If rndframe is true, the offset is rounded to a multiple of the project frame size.

void GetProjectTimeSignature(double* bpmOut, double* bpiOut)
GetProjectTimeSignature(&bpm, &bpi)
number bpm, number bpi = reaper.GetProjectTimeSignature()
(Float bpmOut, Float bpiOut) = RPR_GetProjectTimeSignature(bpmOut, bpiOut)

deprecated

void GetProjectTimeSignature2(ReaProject* proj, double* bpmOut, double* bpiOut)
GetProjectTimeSignature2(ReaProject proj, &bpm, &bpi)
number bpm, number bpi = reaper.GetProjectTimeSignature2(ReaProject proj)
(ReaProject proj, Float bpmOut, Float bpiOut) = RPR_GetProjectTimeSignature2(proj, bpmOut, bpiOut)

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.

int GetProjExtState(ReaProject* proj, const char* extname, const char* key, char* valOutNeedBig, int valOutNeedBig_sz)
int GetProjExtState(ReaProject proj, "extname", "key", #val)
integer retval, string val = reaper.GetProjExtState(ReaProject proj, string extname, string key)
(Int retval, ReaProject proj, String extname, String key, String valOutNeedBig, Int valOutNeedBig_sz) = RPR_GetProjExtState(proj, extname, key, valOutNeedBig, valOutNeedBig_sz)

Get the value previously associated with this extname and key, the last time the project was saved. See SetProjExtState, EnumProjExtState.

const char* GetResourcePath()
bool GetResourcePath(#retval)
string reaper.GetResourcePath()
String RPR_GetResourcePath()

returns path where ini files are stored, other things are in subdirectories.

TrackEnvelope* GetSelectedEnvelope(ReaProject* proj)
TrackEnvelope GetSelectedEnvelope(ReaProject proj)
TrackEnvelope reaper.GetSelectedEnvelope(ReaProject proj)
TrackEnvelope RPR_GetSelectedEnvelope(ReaProject proj)

get the currently selected envelope, returns NULL/nil if no envelope is selected

MediaItem* GetSelectedMediaItem(ReaProject* proj, int selitem)
MediaItem GetSelectedMediaItem(ReaProject proj, int selitem)
MediaItem reaper.GetSelectedMediaItem(ReaProject proj, integer selitem)
MediaItem RPR_GetSelectedMediaItem(ReaProject proj, Int selitem)

get a selected item by selected item count (zero-based) (proj=0 for active project)

MediaTrack* GetSelectedTrack(ReaProject* proj, int seltrackidx)
MediaTrack GetSelectedTrack(ReaProject proj, int seltrackidx)
MediaTrack reaper.GetSelectedTrack(ReaProject proj, integer seltrackidx)
MediaTrack RPR_GetSelectedTrack(ReaProject proj, Int seltrackidx)

Get a selected track from a project (proj=0 for active project) by selected track count (zero-based). This function ignores the master track, see GetSelectedTrack2.

MediaTrack* GetSelectedTrack2(ReaProject* proj, int seltrackidx, bool wantmaster)
MediaTrack GetSelectedTrack2(ReaProject proj, int seltrackidx, bool wantmaster)
MediaTrack reaper.GetSelectedTrack2(ReaProject proj, integer seltrackidx, boolean wantmaster)
MediaTrack RPR_GetSelectedTrack2(ReaProject proj, Int seltrackidx, Boolean wantmaster)

Get a selected track from a project (proj=0 for active project) by selected track count (zero-based).

TrackEnvelope* GetSelectedTrackEnvelope(ReaProject* proj)
TrackEnvelope GetSelectedTrackEnvelope(ReaProject proj)
TrackEnvelope reaper.GetSelectedTrackEnvelope(ReaProject proj)
TrackEnvelope RPR_GetSelectedTrackEnvelope(ReaProject proj)

get the currently selected track envelope, returns NULL/nil if no envelope is selected

void GetSet_ArrangeView2(ReaProject* proj, bool isSet, int screen_x_start, int screen_x_end, double* start_timeOut, double* end_timeOut)
GetSet_ArrangeView2(ReaProject proj, bool isSet, int screen_x_start, int screen_x_end, &start_time, &end_time)
number start_time, number end_time = reaper.GetSet_ArrangeView2(ReaProject proj, boolean isSet, integer screen_x_start, integer screen_x_end)
(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)

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

void GetSet_LoopTimeRange(bool isSet, bool isLoop, double* startOut, double* endOut, bool allowautoseek)
GetSet_LoopTimeRange(bool isSet, bool isLoop, &start, &end, bool allowautoseek)
number start, number end = reaper.GetSet_LoopTimeRange(boolean isSet, boolean isLoop, number start, number end, boolean allowautoseek)
(Boolean isSet, Boolean isLoop, Float startOut, Float endOut, Boolean allowautoseek) = RPR_GetSet_LoopTimeRange(isSet, isLoop, startOut, endOut, allowautoseek)
void GetSet_LoopTimeRange2(ReaProject* proj, bool isSet, bool isLoop, double* startOut, double* endOut, bool allowautoseek)
GetSet_LoopTimeRange2(ReaProject proj, bool isSet, bool isLoop, &start, &end, bool allowautoseek)
number start, number end = reaper.GetSet_LoopTimeRange2(ReaProject proj, boolean isSet, boolean isLoop, number start, number end, boolean allowautoseek)
(ReaProject proj, Boolean isSet, Boolean isLoop, Float startOut, Float endOut, Boolean allowautoseek) = RPR_GetSet_LoopTimeRange2(proj, isSet, isLoop, startOut, endOut, allowautoseek)
double GetSetAutomationItemInfo(TrackEnvelope* env, int autoitem_idx, const char* desc, double value, bool is_set)
double GetSetAutomationItemInfo(TrackEnvelope env, int autoitem_idx, "desc", value, bool is_set)
number reaper.GetSetAutomationItemInfo(TrackEnvelope env, integer autoitem_idx, string desc, number value, boolean is_set)
Float RPR_GetSetAutomationItemInfo(TrackEnvelope env, Int autoitem_idx, String desc, Float value, Boolean is_set)

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)

bool GetSetAutomationItemInfo_String(TrackEnvelope* env, int autoitem_idx, const char* desc, char* valuestrNeedBig, bool is_set)
bool GetSetAutomationItemInfo_String(TrackEnvelope env, int autoitem_idx, "desc", #valuestrNeedBig, bool is_set)
boolean retval, string valuestrNeedBig = reaper.GetSetAutomationItemInfo_String(TrackEnvelope env, integer autoitem_idx, string desc, string valuestrNeedBig, boolean is_set)
(Boolean retval, TrackEnvelope env, Int autoitem_idx, String desc, String valuestrNeedBig, Boolean is_set) = RPR_GetSetAutomationItemInfo_String(env, autoitem_idx, desc, valuestrNeedBig, is_set)

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

bool GetSetEnvelopeInfo_String(TrackEnvelope* env, const char* parmname, char* stringNeedBig, bool setNewValue)
bool GetSetEnvelopeInfo_String(TrackEnvelope env, "parmname", #stringNeedBig, bool setNewValue)
boolean retval, string stringNeedBig = reaper.GetSetEnvelopeInfo_String(TrackEnvelope env, string parmname, string stringNeedBig, boolean setNewValue)
(Boolean retval, TrackEnvelope env, String parmname, String stringNeedBig, Boolean setNewValue) = RPR_GetSetEnvelopeInfo_String(env, parmname, stringNeedBig, setNewValue)

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-...}.

bool GetSetEnvelopeState(TrackEnvelope* env, char* str, int str_sz)
bool GetSetEnvelopeState(TrackEnvelope env, #str)
boolean retval, string str = reaper.GetSetEnvelopeState(TrackEnvelope env, string str)
(Boolean retval, TrackEnvelope env, String str, Int str_sz) = RPR_GetSetEnvelopeState(env, str, str_sz)

deprecated -- see SetEnvelopeStateChunk, GetEnvelopeStateChunk

bool GetSetEnvelopeState2(TrackEnvelope* env, char* str, int str_sz, bool isundo)
bool GetSetEnvelopeState2(TrackEnvelope env, #str, bool isundo)
boolean retval, string str = reaper.GetSetEnvelopeState2(TrackEnvelope env, string str, boolean isundo)
(Boolean retval, TrackEnvelope env, String str, Int str_sz, Boolean isundo) = RPR_GetSetEnvelopeState2(env, str, str_sz, isundo)

deprecated -- see SetEnvelopeStateChunk, GetEnvelopeStateChunk

bool GetSetItemState(MediaItem* item, char* str, int str_sz)
bool GetSetItemState(MediaItem item, #str)
boolean retval, string str = reaper.GetSetItemState(MediaItem item, string str)
(Boolean retval, MediaItem item, String str, Int str_sz) = RPR_GetSetItemState(item, str, str_sz)

deprecated -- see SetItemStateChunk, GetItemStateChunk

bool GetSetItemState2(MediaItem* item, char* str, int str_sz, bool isundo)
bool GetSetItemState2(MediaItem item, #str, bool isundo)
boolean retval, string str = reaper.GetSetItemState2(MediaItem item, string str, boolean isundo)
(Boolean retval, MediaItem item, String str, Int str_sz, Boolean isundo) = RPR_GetSetItemState2(item, str, str_sz, isundo)

deprecated -- see SetItemStateChunk, GetItemStateChunk

bool GetSetMediaItemInfo_String(MediaItem* item, const char* parmname, char* stringNeedBig, bool setNewValue)
bool GetSetMediaItemInfo_String(MediaItem item, "parmname", #stringNeedBig, bool setNewValue)
boolean retval, string stringNeedBig = reaper.GetSetMediaItemInfo_String(MediaItem item, string parmname, string stringNeedBig, boolean setNewValue)
(Boolean retval, MediaItem item, String parmname, String stringNeedBig, Boolean setNewValue) = RPR_GetSetMediaItemInfo_String(item, parmname, stringNeedBig, setNewValue)

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-...}.

bool GetSetMediaItemTakeInfo_String(MediaItem_Take* tk, const char* parmname, char* stringNeedBig, bool setNewValue)
bool GetSetMediaItemTakeInfo_String(MediaItem_Take tk, "parmname", #stringNeedBig, bool setNewValue)
boolean retval, string stringNeedBig = reaper.GetSetMediaItemTakeInfo_String(MediaItem_Take tk, string parmname, string stringNeedBig, boolean setNewValue)
(Boolean retval, MediaItem_Take tk, String parmname, String stringNeedBig, Boolean setNewValue) = RPR_GetSetMediaItemTakeInfo_String(tk, parmname, stringNeedBig, setNewValue)

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-...}.

bool GetSetMediaTrackInfo_String(MediaTrack* tr, const char* parmname, char* stringNeedBig, bool setNewValue)
bool GetSetMediaTrackInfo_String(MediaTrack tr, "parmname", #stringNeedBig, bool setNewValue)
boolean retval, string stringNeedBig = reaper.GetSetMediaTrackInfo_String(MediaTrack tr, string parmname, string stringNeedBig, boolean setNewValue)
(Boolean retval, MediaTrack tr, String parmname, String stringNeedBig, Boolean setNewValue) = RPR_GetSetMediaTrackInfo_String(tr, parmname, stringNeedBig, setNewValue)

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.
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
P_UI_RECT:tcp.mute : char * : read-only, allows querying screen position + size of track WALTER elements (tcp.size queries screen position and size of entire TCP, etc).
GUID : GUID * : 16-byte GUID, can query or update. If using a _String() function, GUID is a string {xyz-...}.

void GetSetProjectAuthor(ReaProject* proj, bool set, char* author, int author_sz)
GetSetProjectAuthor(ReaProject proj, bool set, #author)
string author = reaper.GetSetProjectAuthor(ReaProject proj, boolean set, string author)
(ReaProject proj, Boolean set, String author, Int author_sz) = RPR_GetSetProjectAuthor(proj, set, author, author_sz)

deprecated, see GetSetProjectInfo_String with desc="PROJECT_AUTHOR"

int GetSetProjectGrid(ReaProject* project, bool set, double* divisionInOutOptional, int* swingmodeInOutOptional, double* swingamtInOutOptional)
int GetSetProjectGrid(ReaProject project, bool set, optional &division, optional int &swingmode, optional &swingamt)
integer retval, optional number division, optional integer swingmode, optional number swingamt = reaper.GetSetProjectGrid(ReaProject project, boolean set, optional number division, optional integer swingmode, optional number swingamt)
(Int retval, ReaProject project, Boolean set, Float divisionInOutOptional, Int swingmodeInOutOptional, Float swingamtInOutOptional) = RPR_GetSetProjectGrid(project, set, divisionInOutOptional, swingmodeInOutOptional, swingamtInOutOptional)

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

double GetSetProjectInfo(ReaProject* project, const char* desc, double value, bool is_set)
double GetSetProjectInfo(ReaProject project, "desc", value, bool is_set)
number reaper.GetSetProjectInfo(ReaProject project, string desc, number value, boolean is_set)
Float RPR_GetSetProjectInfo(ReaProject project, String desc, Float value, Boolean is_set)

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=embed transients if format supports, &512=embed metadata if format supports, &1024=embed take markers if format supports, &2048=2nd pass render
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
RENDER_NORMALIZE: &1=enable, (&14==0)=LUFS-I, (&14==2)=RMS, (&14==4)=peak, (&14==6)=true peak, (&14==8)=LUFS-M max, (&14==10)=LUFS-S max, &32=normalize stems to common gain based on master, &64=enable brickwall limit
RENDER_NORMALIZE_TARGET: render normalization target as amplitude, so 0.5 means -6.02dB, 0.25 means -12.04dB, etc
RENDER_BRICKWALL: render brickwall limit as amplitude, so 0.5 means -6.02dB, 0.25 means -12.04dB, etc
PROJECT_SRATE : samplerate (ignored unless PROJECT_SRATE_USE set)
PROJECT_SRATE_USE : set to 1 if project samplerate is used

bool GetSetProjectInfo_String(ReaProject* project, const char* desc, char* valuestrNeedBig, bool is_set)
bool GetSetProjectInfo_String(ReaProject project, "desc", #valuestrNeedBig, bool is_set)
boolean retval, string valuestrNeedBig = reaper.GetSetProjectInfo_String(ReaProject project, string desc, string valuestrNeedBig, boolean is_set)
(Boolean retval, ReaProject project, String desc, String valuestrNeedBig, Boolean is_set) = RPR_GetSetProjectInfo_String(project, desc, valuestrNeedBig, is_set)

Get or set project information.
PROJECT_NAME : project file name (read-only, is_set will be ignored)
PROJECT_TITLE : title field from Project Settings/Notes dialog
PROJECT_AUTHOR : author field from Project Settings/Notes dialog
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()
RECORD_PATH_SECONDARY : secondary recording directory
RENDER_FILE : render directory
RENDER_PATTERN : render file name (may contain wildcards)
RENDER_METADATA : get or set the metadata saved with the project (not metadata embedded in project media). Example, ID3 album name metadata: valuestr="ID3:TALB" to get, valuestr="ID3:TALB|my album name" to set. Call with valuestr="" and is_set=false to get a semicolon-separated list of defined project metadata identifiers.
RENDER_TARGETS : semicolon separated list of files that would be written if the project is rendered using the most recent render settings
RENDER_STATS : (read-only) semicolon separated list of statistics for the most recently rendered files. call with valuestr="XXX" to run an action (for example, "42437"=dry run render selected items) before returning statistics.
RENDER_FORMAT : base64-encoded sink configuration (see project files, etc). 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.
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.
    Formats available on this machine:
    "wave" "aiff" "iso " "ddp " "flac" "mp3l" "oggv" "OggS" "FFMP" "GIF " "LCF " "wvpk"

void GetSetProjectNotes(ReaProject* proj, bool set, char* notesNeedBig, int notesNeedBig_sz)
GetSetProjectNotes(ReaProject proj, bool set, #notes)
string notes = reaper.GetSetProjectNotes(ReaProject proj, boolean set, string notes)
(ReaProject proj, Boolean set, String notesNeedBig, Int notesNeedBig_sz) = RPR_GetSetProjectNotes(proj, set, notesNeedBig, notesNeedBig_sz)

gets or sets project notes, notesNeedBig_sz is ignored when setting

int GetSetRepeat(int val)
int GetSetRepeat(int val)
integer reaper.GetSetRepeat(integer val)
Int RPR_GetSetRepeat(Int val)

-1 == query,0=clear,1=set,>1=toggle . returns new value

int GetSetRepeatEx(ReaProject* proj, int val)
int GetSetRepeatEx(ReaProject proj, int val)
integer reaper.GetSetRepeatEx(ReaProject proj, integer val)
Int RPR_GetSetRepeatEx(ReaProject proj, Int val)

-1 == query,0=clear,1=set,>1=toggle . returns new value

unsigned int GetSetTrackGroupMembership(MediaTrack* tr, const char* groupname, unsigned int setmask, unsigned int setvalue)
uint GetSetTrackGroupMembership(MediaTrack tr, "groupname", uint setmask, uint setvalue)
integer reaper.GetSetTrackGroupMembership(MediaTrack tr, string groupname, integer setmask, integer setvalue)
Unknown RPR_GetSetTrackGroupMembership(MediaTrack tr, String groupname, Unknown setmask, Unknown setvalue)

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).

unsigned int GetSetTrackGroupMembershipHigh(MediaTrack* tr, const char* groupname, unsigned int setmask, unsigned int setvalue)
uint GetSetTrackGroupMembershipHigh(MediaTrack tr, "groupname", uint setmask, uint setvalue)
integer reaper.GetSetTrackGroupMembershipHigh(MediaTrack tr, string groupname, integer setmask, integer setvalue)
Unknown RPR_GetSetTrackGroupMembershipHigh(MediaTrack tr, String groupname, Unknown setmask, Unknown setvalue)

Gets or modifies the group membership for a track. Returns group state prior to call (each bit represents one of the high 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).

bool GetSetTrackSendInfo_String(MediaTrack* tr, int category, int sendidx, const char* parmname, char* stringNeedBig, bool setNewValue)
bool GetSetTrackSendInfo_String(MediaTrack tr, int category, int sendidx, "parmname", #stringNeedBig, bool setNewValue)
boolean retval, string stringNeedBig = reaper.GetSetTrackSendInfo_String(MediaTrack tr, integer category, integer sendidx, string parmname, string stringNeedBig, boolean setNewValue)
(Boolean retval, MediaTrack tr, Int category, Int sendidx, String parmname, String stringNeedBig, Boolean setNewValue) = RPR_GetSetTrackSendInfo_String(tr, category, sendidx, parmname, stringNeedBig, setNewValue)

Gets/sets a send attribute string:
P_EXT:xyz : char * : extension-specific persistent data

bool GetSetTrackState(MediaTrack* track, char* str, int str_sz)
bool GetSetTrackState(MediaTrack track, #str)
boolean retval, string str = reaper.GetSetTrackState(MediaTrack track, string str)
(Boolean retval, MediaTrack track, String str, Int str_sz) = RPR_GetSetTrackState(track, str, str_sz)

deprecated -- see SetTrackStateChunk, GetTrackStateChunk

bool GetSetTrackState2(MediaTrack* track, char* str, int str_sz, bool isundo)
bool GetSetTrackState2(MediaTrack track, #str, bool isundo)
boolean retval, string str = reaper.GetSetTrackState2(MediaTrack track, string str, boolean isundo)
(Boolean retval, MediaTrack track, String str, Int str_sz, Boolean isundo) = RPR_GetSetTrackState2(track, str, str_sz, isundo)

deprecated -- see SetTrackStateChunk, GetTrackStateChunk

ReaProject* GetSubProjectFromSource(PCM_source* src)
ReaProject GetSubProjectFromSource(PCM_source src)
ReaProject reaper.GetSubProjectFromSource(PCM_source src)
ReaProject RPR_GetSubProjectFromSource(PCM_source src)
MediaItem_Take* GetTake(MediaItem* item, int takeidx)
MediaItem_Take GetTake(MediaItem item, int takeidx)
MediaItem_Take reaper.GetTake(MediaItem item, integer takeidx)
MediaItem_Take RPR_GetTake(MediaItem item, Int takeidx)

get a take from an item by take count (zero-based)

TrackEnvelope* GetTakeEnvelope(MediaItem_Take* take, int envidx)
TrackEnvelope GetTakeEnvelope(MediaItem_Take take, int envidx)
TrackEnvelope reaper.GetTakeEnvelope(MediaItem_Take take, integer envidx)
TrackEnvelope RPR_GetTakeEnvelope(MediaItem_Take take, Int envidx)
TrackEnvelope* GetTakeEnvelopeByName(MediaItem_Take* take, const char* envname)
TrackEnvelope GetTakeEnvelopeByName(MediaItem_Take take, "envname")
TrackEnvelope reaper.GetTakeEnvelopeByName(MediaItem_Take take, string envname)
TrackEnvelope RPR_GetTakeEnvelopeByName(MediaItem_Take take, String envname)
double GetTakeMarker(MediaItem_Take* take, int idx, char* nameOut, int nameOut_sz, int* colorOutOptional)
double GetTakeMarker(MediaItem_Take take, int idx, #name, optional int &color)
number retval, string name, optional integer color = reaper.GetTakeMarker(MediaItem_Take take, integer idx)
(Float retval, MediaItem_Take take, Int idx, String nameOut, Int nameOut_sz, Int colorOutOptional) = RPR_GetTakeMarker(take, idx, nameOut, nameOut_sz, colorOutOptional)

Get information about a take marker. Returns the position in media item source time, or -1 if the take marker does not exist. See GetNumTakeMarkers, SetTakeMarker, DeleteTakeMarker

const char* GetTakeName(MediaItem_Take* take)
bool GetTakeName(#retval, MediaItem_Take take)
string reaper.GetTakeName(MediaItem_Take take)
String RPR_GetTakeName(MediaItem_Take take)

returns NULL if the take is not valid

int GetTakeNumStretchMarkers(MediaItem_Take* take)
int GetTakeNumStretchMarkers(MediaItem_Take take)
integer reaper.GetTakeNumStretchMarkers(MediaItem_Take take)
Int RPR_GetTakeNumStretchMarkers(MediaItem_Take take)

Returns number of stretch markers in take

int GetTakeStretchMarker(MediaItem_Take* take, int idx, double* posOut, double* srcposOutOptional)
int GetTakeStretchMarker(MediaItem_Take take, int idx, &pos, optional &srcpos)
integer retval, number pos, optional number srcpos = reaper.GetTakeStretchMarker(MediaItem_Take take, integer idx)
(Int retval, MediaItem_Take take, Int idx, Float posOut, Float srcposOutOptional) = RPR_GetTakeStretchMarker(take, idx, posOut, srcposOutOptional)

Gets information on a stretch marker, idx is 0..n. Returns -1 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, the following 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.

double GetTakeStretchMarkerSlope(MediaItem_Take* take, int idx)
double GetTakeStretchMarkerSlope(MediaItem_Take take, int idx)
number reaper.GetTakeStretchMarkerSlope(MediaItem_Take take, integer idx)
Float RPR_GetTakeStretchMarkerSlope(MediaItem_Take take, Int idx)

See SetTakeStretchMarkerSlope

bool GetTCPFXParm(ReaProject* project, MediaTrack* track, int index, int* fxindexOut, int* parmidxOut)
bool GetTCPFXParm(ReaProject project, MediaTrack track, int index, int &fxindex, int &parmidx)
boolean retval, integer fxindex, integer parmidx = reaper.GetTCPFXParm(ReaProject project, MediaTrack track, integer index)
(Boolean retval, ReaProject project, MediaTrack track, Int index, Int fxindexOut, Int parmidxOut) = RPR_GetTCPFXParm(project, track, index, fxindexOut, parmidxOut)

Get information about a specific FX parameter knob (see CountTCPFXParms).

bool GetTempoMatchPlayRate(PCM_source* source, double srcscale, double position, double mult, double* rateOut, double* targetlenOut)
bool GetTempoMatchPlayRate(PCM_source source, srcscale, position, mult, &rate, &targetlen)
boolean retval, number rate, number targetlen = reaper.GetTempoMatchPlayRate(PCM_source source, number srcscale, number position, number mult)
(Boolean retval, PCM_source source, Float srcscale, Float position, Float mult, Float rateOut, Float targetlenOut) = RPR_GetTempoMatchPlayRate(source, srcscale, position, mult, rateOut, targetlenOut)

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

bool GetTempoTimeSigMarker(ReaProject* proj, int ptidx, double* timeposOut, int* measureposOut, double* beatposOut, double* bpmOut, int* timesig_numOut, int* timesig_denomOut, bool* lineartempoOut)
bool GetTempoTimeSigMarker(ReaProject proj, int ptidx, &timepos, int &measurepos, &beatpos, &bpm, int &timesig_num, int &timesig_denom, bool &lineartempo)
boolean retval, number timepos, integer measurepos, number beatpos, number bpm, integer timesig_num, integer timesig_denom, boolean lineartempo = reaper.GetTempoTimeSigMarker(ReaProject proj, integer ptidx)
(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)

Get information about a tempo/time signature marker. See CountTempoTimeSigMarkers, SetTempoTimeSigMarker, AddTempoTimeSigMarker.

int GetThemeColor(const char* ini_key, int flagsOptional)
int GetThemeColor("ini_key", int flags)
integer reaper.GetThemeColor(string ini_key, integer flags)
Int RPR_GetThemeColor(String ini_key, Int flagsOptional)

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.

MediaTrack* GetThingFromPoint(int screen_x, int screen_y, char* infoOut, int infoOut_sz)
MediaTrack GetThingFromPoint(int screen_x, int screen_y, #info)
MediaTrack retval, string info = reaper.GetThingFromPoint(integer screen_x, integer screen_y)
(MediaTrack retval, Int screen_x, Int screen_y, String infoOut, Int infoOut_sz) = RPR_GetThingFromPoint(screen_x, screen_y, infoOut, infoOut_sz)

Hit tests a point in screen coordinates. Updates infoOut with information such as "arrange", "fx_chain", "fx_0" (first FX in chain, floating). If a track panel is hit, string will begin with "tcp" or "mcp" or "tcp.mute" etc (future versions may append additional information). May return NULL with valid info string to indicate non-track thing.

int GetToggleCommandState(int command_id)
int GetToggleCommandState(int command_id)
integer reaper.GetToggleCommandState(integer command_id)
Int RPR_GetToggleCommandState(Int command_id)

See GetToggleCommandStateEx.

int GetToggleCommandStateEx(int section_id, int command_id)
int GetToggleCommandStateEx(int section_id, int command_id)
integer reaper.GetToggleCommandStateEx(integer section_id, integer command_id)
Int RPR_GetToggleCommandStateEx(Int section_id, Int command_id)

For the main action context, the MIDI editor, or the media explorer, returns the toggle state of the action. 0=off, 1=on, -1=NA because the action does not have on/off states. For the MIDI editor, the action state for the most recently focused window will be returned.

HWND GetTooltipWindow()
HWND GetTooltipWindow()
HWND reaper.GetTooltipWindow()
HWND RPR_GetTooltipWindow()

gets a tooltip window,in case you want to ask it for font information. Can return NULL.

MediaTrack* GetTrack(ReaProject* proj, int trackidx)
MediaTrack GetTrack(ReaProject proj, int trackidx)
MediaTrack reaper.GetTrack(ReaProject proj, integer trackidx)
MediaTrack RPR_GetTrack(ReaProject proj, Int trackidx)

get a track from a project by track count (zero-based) (proj=0 for active project)

int GetTrackAutomationMode(MediaTrack* tr)
int GetTrackAutomationMode(MediaTrack tr)
integer reaper.GetTrackAutomationMode(MediaTrack tr)
Int RPR_GetTrackAutomationMode(MediaTrack tr)

return the track mode, regardless of global override

int GetTrackColor(MediaTrack* track)
int GetTrackColor(MediaTrack track)
integer reaper.GetTrackColor(MediaTrack track)
Int RPR_GetTrackColor(MediaTrack track)

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.

int GetTrackDepth(MediaTrack* track)
int GetTrackDepth(MediaTrack track)
integer reaper.GetTrackDepth(MediaTrack track)
Int RPR_GetTrackDepth(MediaTrack track)
TrackEnvelope* GetTrackEnvelope(MediaTrack* track, int envidx)
TrackEnvelope GetTrackEnvelope(MediaTrack track, int envidx)
TrackEnvelope reaper.GetTrackEnvelope(MediaTrack track, integer envidx)
TrackEnvelope RPR_GetTrackEnvelope(MediaTrack track, Int envidx)
TrackEnvelope* GetTrackEnvelopeByChunkName(MediaTrack* tr, const char* cfgchunkname_or_guid)
TrackEnvelope GetTrackEnvelopeByChunkName(MediaTrack tr, "cfgchunkname_or_guid")
TrackEnvelope reaper.GetTrackEnvelopeByChunkName(MediaTrack tr, string cfgchunkname_or_guid)
TrackEnvelope RPR_GetTrackEnvelopeByChunkName(MediaTrack tr, String cfgchunkname_or_guid)

Gets a built-in track envelope by configuration chunk name, like "<VOLENV", or GUID string, like "{B577250D-146F-B544-9B34-F24FBE488F1F}".

TrackEnvelope* GetTrackEnvelopeByName(MediaTrack* track, const char* envname)
TrackEnvelope GetTrackEnvelopeByName(MediaTrack track, "envname")
TrackEnvelope reaper.GetTrackEnvelopeByName(MediaTrack track, string envname)
TrackEnvelope RPR_GetTrackEnvelopeByName(MediaTrack track, String envname)
MediaTrack* GetTrackFromPoint(int screen_x, int screen_y, int* infoOutOptional)
MediaTrack GetTrackFromPoint(int screen_x, int screen_y, optional int &info)
MediaTrack retval, optional integer info = reaper.GetTrackFromPoint(integer screen_x, integer screen_y)
(MediaTrack retval, Int screen_x, Int screen_y, Int infoOutOptional) = RPR_GetTrackFromPoint(screen_x, screen_y, infoOutOptional)

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. See GetThingFromPoint.

GUID* GetTrackGUID(MediaTrack* tr)
bool GetTrackGUID(#retguid, MediaTrack tr)
string GUID = reaper.GetTrackGUID(MediaTrack tr)
GUID RPR_GetTrackGUID(MediaTrack tr)
MediaItem* GetTrackMediaItem(MediaTrack* tr, int itemidx)
MediaItem GetTrackMediaItem(MediaTrack tr, int itemidx)
MediaItem reaper.GetTrackMediaItem(MediaTrack tr, integer itemidx)
MediaItem RPR_GetTrackMediaItem(MediaTrack tr, Int itemidx)
bool GetTrackMIDILyrics(MediaTrack* track, int flag, char* bufOutWantNeedBig, int* bufOutWantNeedBig_sz)
bool GetTrackMIDILyrics(MediaTrack track, int flag, #buf)
boolean retval, string buf = reaper.GetTrackMIDILyrics(MediaTrack track, integer flag)
(Boolean retval, MediaTrack track, Int flag, String bufOutWantNeedBig, Int bufOutWantNeedBig_sz) = RPR_GetTrackMIDILyrics(track, flag, bufOutWantNeedBig, bufOutWantNeedBig_sz)

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

const char* GetTrackMIDINoteName(int track, int pitch, int chan)
bool GetTrackMIDINoteName(#retval, int track, int pitch, int chan)
string reaper.GetTrackMIDINoteName(integer track, integer pitch, integer chan)
String RPR_GetTrackMIDINoteName(Int track, Int pitch, Int chan)

see GetTrackMIDINoteNameEx

const char* GetTrackMIDINoteNameEx(ReaProject* proj, MediaTrack* track, int pitch, int chan)
bool GetTrackMIDINoteNameEx(#retval, ReaProject proj, MediaTrack track, int pitch, int chan)
string reaper.GetTrackMIDINoteNameEx(ReaProject proj, MediaTrack track, integer pitch, integer chan)
String RPR_GetTrackMIDINoteNameEx(ReaProject proj, MediaTrack track, Int pitch, Int chan)

Get note/CC name. pitch 128 for CC0 name, 129 for CC1 name, etc. See SetTrackMIDINoteNameEx

void GetTrackMIDINoteRange(ReaProject* proj, MediaTrack* track, int* note_loOut, int* note_hiOut)
GetTrackMIDINoteRange(ReaProject proj, MediaTrack track, int &note_lo, int &note_hi)
integer note_lo, integer note_hi = reaper.GetTrackMIDINoteRange(ReaProject proj, MediaTrack track)
(ReaProject proj, MediaTrack track, Int note_loOut, Int note_hiOut) = RPR_GetTrackMIDINoteRange(proj, track, note_loOut, note_hiOut)
bool GetTrackName(MediaTrack* track, char* bufOut, int bufOut_sz)
bool GetTrackName(MediaTrack track, #buf)
boolean retval, string buf = reaper.GetTrackName(MediaTrack track)
(Boolean retval, MediaTrack track, String bufOut, Int bufOut_sz) = RPR_GetTrackName(track, bufOut, bufOut_sz)

Returns "MASTER" for master track, "Track N" if track has no name.

int GetTrackNumMediaItems(MediaTrack* tr)
int GetTrackNumMediaItems(MediaTrack tr)
integer reaper.GetTrackNumMediaItems(MediaTrack tr)
Int RPR_GetTrackNumMediaItems(MediaTrack tr)
int GetTrackNumSends(MediaTrack* tr, int category)
int GetTrackNumSends(MediaTrack tr, int category)
integer reaper.GetTrackNumSends(MediaTrack tr, integer category)
Int RPR_GetTrackNumSends(MediaTrack tr, Int category)

returns number of sends/receives/hardware outputs - category is <0 for receives, 0=sends, >0 for hardware outputs

bool GetTrackReceiveName(MediaTrack* track, int recv_index, char* bufOut, int bufOut_sz)
bool GetTrackReceiveName(MediaTrack track, int recv_index, #buf)
boolean retval, string buf = reaper.GetTrackReceiveName(MediaTrack track, integer recv_index)
(Boolean retval, MediaTrack track, Int recv_index, String bufOut, Int bufOut_sz) = RPR_GetTrackReceiveName(track, recv_index, bufOut, bufOut_sz)

See GetTrackSendName.

bool GetTrackReceiveUIMute(MediaTrack* track, int recv_index, bool* muteOut)
bool GetTrackReceiveUIMute(MediaTrack track, int recv_index, bool &mute)
boolean retval, boolean mute = reaper.GetTrackReceiveUIMute(MediaTrack track, integer recv_index)
(Boolean retval, MediaTrack track, Int recv_index, Boolean muteOut) = RPR_GetTrackReceiveUIMute(track, recv_index, muteOut)

See GetTrackSendUIMute.

bool GetTrackReceiveUIVolPan(MediaTrack* track, int recv_index, double* volumeOut, double* panOut)
bool GetTrackReceiveUIVolPan(MediaTrack track, int recv_index, &volume, &pan)
boolean retval, number volume, number pan = reaper.GetTrackReceiveUIVolPan(MediaTrack track, integer recv_index)
(Boolean retval, MediaTrack track, Int recv_index, Float volumeOut, Float panOut) = RPR_GetTrackReceiveUIVolPan(track, recv_index, volumeOut, panOut)

See GetTrackSendUIVolPan.

double GetTrackSendInfo_Value(MediaTrack* tr, int category, int sendidx, const char* parmname)
double GetTrackSendInfo_Value(MediaTrack tr, int category, int sendidx, "parmname")
number reaper.GetTrackSendInfo_Value(MediaTrack tr, integer category, integer sendidx, string parmname)
Float RPR_GetTrackSendInfo_Value(MediaTrack tr, Int category, Int sendidx, String parmname)

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=chan
P_DESTTRACK : MediaTrack * : destination track, only applies for sends/recvs (read-only)
P_SRCTRACK : MediaTrack * : source track, only applies for sends/recvs (read-only)
P_ENV:<envchunkname : TrackEnvelope * : call with :<VOLENV, :<PANENV, etc appended (read-only)
See CreateTrackSend, RemoveTrackSend, GetTrackNumSends.

bool GetTrackSendName(MediaTrack* track, int send_index, char* bufOut, int bufOut_sz)
bool GetTrackSendName(MediaTrack track, int send_index, #buf)
boolean retval, string buf = reaper.GetTrackSendName(MediaTrack track, integer send_index)
(Boolean retval, MediaTrack track, Int send_index, String bufOut, Int bufOut_sz) = RPR_GetTrackSendName(track, send_index, bufOut, bufOut_sz)

send_idx>=0 for hw ouputs, >=nb_of_hw_ouputs for sends. See GetTrackReceiveName.

bool GetTrackSendUIMute(MediaTrack* track, int send_index, bool* muteOut)
bool GetTrackSendUIMute(MediaTrack track, int send_index, bool &mute)
boolean retval, boolean mute = reaper.GetTrackSendUIMute(MediaTrack track, integer send_index)
(Boolean retval, MediaTrack track, Int send_index, Boolean muteOut) = RPR_GetTrackSendUIMute(track, send_index, muteOut)

send_idx>=0 for hw ouputs, >=nb_of_hw_ouputs for sends. See GetTrackReceiveUIMute.

bool GetTrackSendUIVolPan(MediaTrack* track, int send_index, double* volumeOut, double* panOut)
bool GetTrackSendUIVolPan(MediaTrack track, int send_index, &volume, &pan)
boolean retval, number volume, number pan = reaper.GetTrackSendUIVolPan(MediaTrack track, integer send_index)
(Boolean retval, MediaTrack track, Int send_index, Float volumeOut, Float panOut) = RPR_GetTrackSendUIVolPan(track, send_index, volumeOut, panOut)

send_idx>=0 for hw ouputs, >=nb_of_hw_ouputs for sends. See GetTrackReceiveUIVolPan.

const char* GetTrackState(MediaTrack* track, int* flagsOut)
bool GetTrackState(#retval, MediaTrack track, int &flags)
string retval, integer flags = reaper.GetTrackState(MediaTrack track)
(String retval, MediaTrack track, Int flagsOut) = RPR_GetTrackState(track, flagsOut)

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

bool GetTrackStateChunk(MediaTrack* track, char* strNeedBig, int strNeedBig_sz, bool isundoOptional)
bool GetTrackStateChunk(MediaTrack track, #str, bool isundo)
boolean retval, string str = reaper.GetTrackStateChunk(MediaTrack track, string str, boolean isundo)
(Boolean retval, MediaTrack track, String strNeedBig, Int strNeedBig_sz, Boolean isundoOptional) = RPR_GetTrackStateChunk(track, strNeedBig, strNeedBig_sz, isundoOptional)

Gets the RPPXML state of a track, returns true if successful. Undo flag is a performance/caching hint.

bool GetTrackUIMute(MediaTrack* track, bool* muteOut)
bool GetTrackUIMute(MediaTrack track, bool &mute)
boolean retval, boolean mute = reaper.GetTrackUIMute(MediaTrack track)
(Boolean retval, MediaTrack track, Boolean muteOut) = RPR_GetTrackUIMute(track, muteOut)
bool GetTrackUIPan(MediaTrack* track, double* pan1Out, double* pan2Out, int* panmodeOut)
bool GetTrackUIPan(MediaTrack track, &pan1, &pan2, int &panmode)
boolean retval, number pan1, number pan2, integer panmode = reaper.GetTrackUIPan(MediaTrack track)
(Boolean retval, MediaTrack track, Float pan1Out, Float pan2Out, Int panmodeOut) = RPR_GetTrackUIPan(track, pan1Out, pan2Out, panmodeOut)
bool GetTrackUIVolPan(MediaTrack* track, double* volumeOut, double* panOut)
bool GetTrackUIVolPan(MediaTrack track, &volume, &pan)
boolean retval, number volume, number pan = reaper.GetTrackUIVolPan(MediaTrack track)
(Boolean retval, MediaTrack track, Float volumeOut, Float panOut) = RPR_GetTrackUIVolPan(track, volumeOut, panOut)
void GetUnderrunTime(unsigned int* audio_xrunOutOptional, unsigned int* media_xrunOutOptional, unsigned int* curtimeOutOptional)
GetUnderrunTime(optional unsigned int &audio_xrun, optional unsigned int &media_xrun, optional unsigned int &curtime)
optional integer audio_xrun, optional integer media_xrun, optional integer curtime = reaper.GetUnderrunTime()
RPR_GetUnderrunTime(unsigned int audio_xrunOutOptional, unsigned int media_xrunOutOptional, unsigned int curtimeOutOptional)

retrieves the last timestamps of audio xrun (yellow-flash, if available), media xrun (red-flash), and the current time stamp (all milliseconds)

bool GetUserFileNameForRead(char* filenameNeed4096, const char* title, const char* defext)
bool GetUserFileNameForRead(#filenameNeed4096, "title", "defext")
boolean retval, string filenameNeed4096 = reaper.GetUserFileNameForRead(string filenameNeed4096, string title, string defext)
(Boolean retval, String filenameNeed4096, String title, String defext) = RPR_GetUserFileNameForRead(filenameNeed4096, title, defext)

returns true if the user selected a valid file, false if the user canceled the dialog

bool GetUserInputs(const char* title, int num_inputs, const char* captions_csv, char* retvals_csv, int retvals_csv_sz)
bool GetUserInputs("title", int num_inputs, "captions_csv", #retvals_csv)
boolean retval, string retvals_csv = reaper.GetUserInputs(string title, integer num_inputs, string captions_csv, string retvals_csv)
(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)

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-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.

void GoToMarker(ReaProject* proj, int marker_index, bool use_timeline_order)
GoToMarker(ReaProject proj, int marker_index, bool use_timeline_order)
reaper.GoToMarker(ReaProject proj, integer marker_index, boolean use_timeline_order)
RPR_GoToMarker(ReaProject proj, Int marker_index, Boolean use_timeline_order)

Go to marker. If use_timeline_order==true, marker_index 1 refers to the first marker on the timeline. If use_timeline_order==false, marker_index 1 refers to the first marker with the user-editable index of 1.

void GoToRegion(ReaProject* proj, int region_index, bool use_timeline_order)
GoToRegion(ReaProject proj, int region_index, bool use_timeline_order)
reaper.GoToRegion(ReaProject proj, integer region_index, boolean use_timeline_order)
RPR_GoToRegion(ReaProject proj, Int region_index, Boolean use_timeline_order)

Seek to region after current region finishes playing (smooth seek). If use_timeline_order==true, region_index 1 refers to the first region on the timeline. If use_timeline_order==false, region_index 1 refers to the first region with the user-editable index of 1.

int GR_SelectColor(HWND hwnd, int* colorOut)
int GR_SelectColor(HWND hwnd, int &color)
integer retval, integer color = reaper.GR_SelectColor(HWND hwnd)
(Int retval, HWND hwnd, Int colorOut) = RPR_GR_SelectColor(hwnd, colorOut)

Runs the system color chooser dialog. Returns 0 if the user cancels the dialog.

int GSC_mainwnd(int t)
int GSC_mainwnd(int t)
integer reaper.GSC_mainwnd(integer t)
Int RPR_GSC_mainwnd(Int t)

this is just like win32 GetSysColor() but can have overrides.

void guidToString(const GUID* g, char* destNeed64)
guidToString("gGUID", #destNeed64)
string destNeed64 = reaper.guidToString(string gGUID, string destNeed64)
(const GUID g, String destNeed64) = RPR_guidToString(g, destNeed64)

dest should be at least 64 chars long to be safe

bool HasExtState(const char* section, const char* key)
bool HasExtState("section", "key")
boolean reaper.HasExtState(string section, string key)
Boolean RPR_HasExtState(String section, String key)

Returns true if there exists an extended state value for a specific section and key. See SetExtState, GetExtState, DeleteExtState.

const char* HasTrackMIDIPrograms(int track)
bool HasTrackMIDIPrograms(#retval, int track)
string reaper.HasTrackMIDIPrograms(integer track)
String RPR_HasTrackMIDIPrograms(Int track)

returns name of track plugin that is supplying MIDI programs,or NULL if there is none

const char* HasTrackMIDIProgramsEx(ReaProject* proj, MediaTrack* track)
bool HasTrackMIDIProgramsEx(#retval, ReaProject proj, MediaTrack track)
string reaper.HasTrackMIDIProgramsEx(ReaProject proj, MediaTrack track)
String RPR_HasTrackMIDIProgramsEx(ReaProject proj, MediaTrack track)

returns name of track plugin that is supplying MIDI programs,or NULL if there is none

void Help_Set(const char* helpstring, bool is_temporary_help)
Help_Set("helpstring", bool is_temporary_help)
reaper.Help_Set(string helpstring, boolean is_temporary_help)
RPR_Help_Set(String helpstring, Boolean is_temporary_help)
void image_resolve_fn(const char* in, char* out, int out_sz)
image_resolve_fn("in", #out)
string out = reaper.image_resolve_fn(string in, string out)
(String in, String out, Int out_sz) = RPR_image_resolve_fn(in, out, out_sz)
int InsertAutomationItem(TrackEnvelope* env, int pool_id, double position, double length)
int InsertAutomationItem(TrackEnvelope env, int pool_id, position, length)
integer reaper.InsertAutomationItem(TrackEnvelope env, integer pool_id, number position, number length)
Int RPR_InsertAutomationItem(TrackEnvelope env, Int pool_id, Float position, Float length)

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.

bool InsertEnvelopePoint(TrackEnvelope* envelope, double time, double value, int shape, double tension, bool selected, bool* noSortInOptional)
bool InsertEnvelopePoint(TrackEnvelope envelope, time, value, int shape, tension, bool selected, optional bool noSortIn)
boolean reaper.InsertEnvelopePoint(TrackEnvelope envelope, number time, number value, integer shape, number tension, boolean selected, optional boolean noSortIn)
(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)

Insert an envelope point. If setting multiple points at once, set noSort=true, and call Envelope_SortPoints when done. See InsertEnvelopePointEx.

bool InsertEnvelopePointEx(TrackEnvelope* envelope, int autoitem_idx, double time, double value, int shape, double tension, bool selected, bool* noSortInOptional)
bool InsertEnvelopePointEx(TrackEnvelope envelope, int autoitem_idx, time, value, int shape, tension, bool selected, optional bool noSortIn)
boolean reaper.InsertEnvelopePointEx(TrackEnvelope envelope, integer autoitem_idx, number time, number value, integer shape, number tension, boolean selected, optional boolean noSortIn)
(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)

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.

int InsertMedia(const char* file, int mode)
int InsertMedia("file", int mode)
integer reaper.InsertMedia(string file, integer mode)
Int RPR_InsertMedia(String file, Int mode)

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 source preferred position (BWF start offset), &8192=reverse

int InsertMediaSection(const char* file, int mode, double startpct, double endpct, double pitchshift)
int InsertMediaSection("file", int mode, startpct, endpct, pitchshift)
integer reaper.InsertMediaSection(string file, integer mode, number startpct, number endpct, number pitchshift)
Int RPR_InsertMediaSection(String file, Int mode, Float startpct, Float endpct, Float pitchshift)

See InsertMedia.

void InsertTrackAtIndex(int idx, bool wantDefaults)
InsertTrackAtIndex(int idx, bool wantDefaults)
reaper.InsertTrackAtIndex(integer idx, boolean wantDefaults)
RPR_InsertTrackAtIndex(Int idx, Boolean wantDefaults)

inserts a track at idx,of course this will be clamped to 0..GetNumTracks(). wantDefaults=TRUE for default envelopes/FX,otherwise no enabled fx/env

bool IsMediaExtension(const char* ext, bool wantOthers)
bool IsMediaExtension("ext", bool wantOthers)
boolean reaper.IsMediaExtension(string ext, boolean wantOthers)
Boolean RPR_IsMediaExtension(String ext, Boolean wantOthers)

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.

bool IsMediaItemSelected(MediaItem* item)
bool IsMediaItemSelected(MediaItem item)
boolean reaper.IsMediaItemSelected(MediaItem item)
Boolean RPR_IsMediaItemSelected(MediaItem item)
int IsProjectDirty(ReaProject* proj)
int IsProjectDirty(ReaProject proj)
integer reaper.IsProjectDirty(ReaProject proj)
Int RPR_IsProjectDirty(ReaProject proj)

Is the project dirty (needing save)? Always returns 0 if 'undo/prompt to save' is disabled in preferences.

bool IsTrackSelected(MediaTrack* track)
bool IsTrackSelected(MediaTrack track)
boolean reaper.IsTrackSelected(MediaTrack track)
Boolean RPR_IsTrackSelected(MediaTrack track)
bool IsTrackVisible(MediaTrack* track, bool mixer)
bool IsTrackVisible(MediaTrack track, bool mixer)
boolean reaper.IsTrackVisible(MediaTrack track, boolean mixer)
Boolean RPR_IsTrackVisible(MediaTrack track, Boolean mixer)

If mixer==true, returns true if the track is visible in the mixer. If mixer==false, returns true if the track is visible in the track control panel.

joystick_device* joystick_create(const GUID* guid)
joystick_device joystick_create("guidGUID")
joystick_device reaper.joystick_create(string guidGUID)
joystick_device RPR_joystick_create(const GUID guid)

creates a joystick device

void joystick_destroy(joystick_device* device)
joystick_destroy(joystick_device device)
reaper.joystick_destroy(joystick_device device)
RPR_joystick_destroy(joystick_device device)

destroys a joystick device

const char* joystick_enum(int index, const char** namestrOutOptional)
bool joystick_enum(#retval, int index, optional #namestr)
string retval, optional string namestr = reaper.joystick_enum(integer index)
String RPR_joystick_enum(Int index, String namestrOutOptional)

enumerates installed devices, returns GUID as a string

double joystick_getaxis(joystick_device* dev, int axis)
double joystick_getaxis(joystick_device dev, int axis)
number reaper.joystick_getaxis(joystick_device dev, integer axis)
Float RPR_joystick_getaxis(joystick_device dev, Int axis)

returns axis value (-1..1)

unsigned int joystick_getbuttonmask(joystick_device* dev)
uint joystick_getbuttonmask(joystick_device dev)
integer reaper.joystick_getbuttonmask(joystick_device dev)
Unknown RPR_joystick_getbuttonmask(joystick_device dev)

returns button pressed mask, 1=first button, 2=second...

int joystick_getinfo(joystick_device* dev, int* axesOutOptional, int* povsOutOptional)
int joystick_getinfo(joystick_device dev, optional int &axes, optional int &povs)
integer retval, optional integer axes, optional integer povs = reaper.joystick_getinfo(joystick_device dev)
(Int retval, joystick_device dev, Int axesOutOptional, Int povsOutOptional) = RPR_joystick_getinfo(dev, axesOutOptional, povsOutOptional)

returns button count

double joystick_getpov(joystick_device* dev, int pov)
double joystick_getpov(joystick_device dev, int pov)
number reaper.joystick_getpov(joystick_device dev, integer pov)
Float RPR_joystick_getpov(joystick_device dev, Int pov)

returns POV value (usually 0..655.35, or 655.35 on error)

bool joystick_update(joystick_device* dev)
bool joystick_update(joystick_device dev)
boolean reaper.joystick_update(joystick_device dev)
Boolean RPR_joystick_update(joystick_device dev)

Updates joystick state from hardware, returns true if successful (joystick_get* will not be valid until joystick_update() is called successfully)

bool LICE_ClipLine(int* pX1Out, int* pY1Out, int* pX2Out, int* pY2Out, int xLo, int yLo, int xHi, int yHi)
bool LICE_ClipLine(int &pX1, int &pY1, int &pX2, int &pY2, int xLo, int yLo, int xHi, int yHi)
boolean retval, integer pX1, integer pY1, integer pX2, integer pY2 = reaper.LICE_ClipLine(integer pX1, integer pY1, integer pX2, integer pY2, integer xLo, integer yLo, integer xHi, integer yHi)
(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)

Returns false if the line is entirely offscreen.

const char* LocalizeString(const char* src_string, const char* section, int flagsOptional)
bool LocalizeString(#retval, "src_string", "section", int flags)
string reaper.LocalizeString(string src_string, string section, integer flags)
String RPR_LocalizeString(String src_string, String section, Int flagsOptional)

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.

bool Loop_OnArrow(ReaProject* project, int direction)
bool Loop_OnArrow(ReaProject project, int direction)
boolean reaper.Loop_OnArrow(ReaProject project, integer direction)
Boolean RPR_Loop_OnArrow(ReaProject project, Int direction)

Move the loop selection left or right. Returns true if snap is enabled.

void Main_OnCommand(int command, int flag)
Main_OnCommand(int command, int flag)
reaper.Main_OnCommand(integer command, integer flag)
RPR_Main_OnCommand(Int command, Int flag)

See Main_OnCommandEx.

void Main_OnCommandEx(int command, int flag, ReaProject* proj)
Main_OnCommandEx(int command, int flag, ReaProject proj)
reaper.Main_OnCommandEx(integer command, integer flag, ReaProject proj)
RPR_Main_OnCommandEx(Int command, Int flag, ReaProject proj)

Performs an action belonging to the main action section. To perform non-native actions (ReaScripts, custom or extension plugins' actions) safely, see NamedCommandLookup().

void Main_openProject(const char* name)
Main_openProject("name")
reaper.Main_openProject(string name)
RPR_Main_openProject(String name)

opens a project. will prompt the user to save unless name is prefixed with 'noprompt:'. If name is prefixed with 'template:', project file will be loaded as a template.
If passed a .RTrackTemplate file, adds the template to the existing project.

void Main_SaveProject(ReaProject* proj, bool forceSaveAsInOptional)
Main_SaveProject(ReaProject proj, bool forceSaveAsIn)
reaper.Main_SaveProject(ReaProject proj, boolean forceSaveAsIn)
RPR_Main_SaveProject(ReaProject proj, Boolean forceSaveAsInOptional)

Save the project.

void Main_UpdateLoopInfo(int ignoremask)
Main_UpdateLoopInfo(int ignoremask)
reaper.Main_UpdateLoopInfo(integer ignoremask)
RPR_Main_UpdateLoopInfo(Int ignoremask)
void MarkProjectDirty(ReaProject* proj)
MarkProjectDirty(ReaProject proj)
reaper.MarkProjectDirty(ReaProject proj)
RPR_MarkProjectDirty(ReaProject proj)

Marks project as dirty (needing save) if 'undo/prompt to save' is enabled in preferences.

void MarkTrackItemsDirty(MediaTrack* track, MediaItem* item)
MarkTrackItemsDirty(MediaTrack track, MediaItem item)
reaper.MarkTrackItemsDirty(MediaTrack track, MediaItem item)
RPR_MarkTrackItemsDirty(MediaTrack track, MediaItem item)

If track is supplied, item is ignored

double Master_GetPlayRate(ReaProject* project)
double Master_GetPlayRate(ReaProject project)
number reaper.Master_GetPlayRate(ReaProject project)
Float RPR_Master_GetPlayRate(ReaProject project)
double Master_GetPlayRateAtTime(double time_s, ReaProject* proj)
double Master_GetPlayRateAtTime(time_s, ReaProject proj)
number reaper.Master_GetPlayRateAtTime(number time_s, ReaProject proj)
Float RPR_Master_GetPlayRateAtTime(Float time_s, ReaProject proj)
double Master_GetTempo()
double Master_GetTempo()
number reaper.Master_GetTempo()
Float RPR_Master_GetTempo()
double Master_NormalizePlayRate(double playrate, bool isnormalized)
double Master_NormalizePlayRate(playrate, bool isnormalized)
number reaper.Master_NormalizePlayRate(number playrate, boolean isnormalized)
Float RPR_Master_NormalizePlayRate(Float playrate, Boolean isnormalized)

Convert play rate to/from a value between 0 and 1, representing the position on the project playrate slider.

double Master_NormalizeTempo(double bpm, bool isnormalized)
double Master_NormalizeTempo(bpm, bool isnormalized)
number reaper.Master_NormalizeTempo(number bpm, boolean isnormalized)
Float RPR_Master_NormalizeTempo(Float bpm, Boolean isnormalized)

Convert the tempo to/from a value between 0 and 1, representing bpm in the range of 40-296 bpm.

int MB(const char* msg, const char* title, int type)
int MB("msg", "title", int type)
integer reaper.MB(string msg, string title, integer type)
Int RPR_MB(String msg, String title, Int type)

type 0=OK,1=OKCANCEL,2=ABORTRETRYIGNORE,3=YESNOCANCEL,4=YESNO,5=RETRYCANCEL : ret 1=OK,2=CANCEL,3=ABORT,4=RETRY,5=IGNORE,6=YES,7=NO

int MediaItemDescendsFromTrack(MediaItem* item, MediaTrack* track)
int MediaItemDescendsFromTrack(MediaItem item, MediaTrack track)
integer reaper.MediaItemDescendsFromTrack(MediaItem item, MediaTrack track)
Int RPR_MediaItemDescendsFromTrack(MediaItem item, MediaTrack track)

Returns 1 if the track holds the item, 2 if the track is a folder containing the track that holds the item, etc.

int MIDI_CountEvts(MediaItem_Take* take, int* notecntOut, int* ccevtcntOut, int* textsyxevtcntOut)
int MIDI_CountEvts(MediaItem_Take take, int &notecnt, int &ccevtcnt, int &textsyxevtcnt)
integer retval, integer notecnt, integer ccevtcnt, integer textsyxevtcnt = reaper.MIDI_CountEvts(MediaItem_Take take)
(Int retval, MediaItem_Take take, Int notecntOut, Int ccevtcntOut, Int textsyxevtcntOut) = RPR_MIDI_CountEvts(take, notecntOut, ccevtcntOut, textsyxevtcntOut)

Count the number of notes, CC events, and text/sysex events in a given MIDI item.

bool MIDI_DeleteCC(MediaItem_Take* take, int ccidx)
bool MIDI_DeleteCC(MediaItem_Take take, int ccidx)
boolean reaper.MIDI_DeleteCC(MediaItem_Take take, integer ccidx)
Boolean RPR_MIDI_DeleteCC(MediaItem_Take take, Int ccidx)

Delete a MIDI CC event.

bool MIDI_DeleteEvt(MediaItem_Take* take, int evtidx)
bool MIDI_DeleteEvt(MediaItem_Take take, int evtidx)
boolean reaper.MIDI_DeleteEvt(MediaItem_Take take, integer evtidx)
Boolean RPR_MIDI_DeleteEvt(MediaItem_Take take, Int evtidx)

Delete a MIDI event.

bool MIDI_DeleteNote(MediaItem_Take* take, int noteidx)
bool MIDI_DeleteNote(MediaItem_Take take, int noteidx)
boolean reaper.MIDI_DeleteNote(MediaItem_Take take, integer noteidx)
Boolean RPR_MIDI_DeleteNote(MediaItem_Take take, Int noteidx)

Delete a MIDI note.

bool MIDI_DeleteTextSysexEvt(MediaItem_Take* take, int textsyxevtidx)
bool MIDI_DeleteTextSysexEvt(MediaItem_Take take, int textsyxevtidx)
boolean reaper.MIDI_DeleteTextSysexEvt(MediaItem_Take take, integer textsyxevtidx)
Boolean RPR_MIDI_DeleteTextSysexEvt(MediaItem_Take take, Int textsyxevtidx)

Delete a MIDI text or sysex event.

void MIDI_DisableSort(MediaItem_Take* take)
MIDI_DisableSort(MediaItem_Take take)
reaper.MIDI_DisableSort(MediaItem_Take take)
RPR_MIDI_DisableSort(MediaItem_Take take)

Disable sorting for all MIDI insert, delete, get and set functions, until MIDI_Sort is called.

int MIDI_EnumSelCC(MediaItem_Take* take, int ccidx)
int MIDI_EnumSelCC(MediaItem_Take take, int ccidx)
integer reaper.MIDI_EnumSelCC(MediaItem_Take take, integer ccidx)
Int RPR_MIDI_EnumSelCC(MediaItem_Take take, Int ccidx)

Returns the index of the next selected MIDI CC event after ccidx (-1 if there are no more selected events).

int MIDI_EnumSelEvts(MediaItem_Take* take, int evtidx)
int MIDI_EnumSelEvts(MediaItem_Take take, int evtidx)
integer reaper.MIDI_EnumSelEvts(MediaItem_Take take, integer evtidx)
Int RPR_MIDI_EnumSelEvts(MediaItem_Take take, Int evtidx)

Returns the index of the next selected MIDI event after evtidx (-1 if there are no more selected events).

int MIDI_EnumSelNotes(MediaItem_Take* take, int noteidx)
int MIDI_EnumSelNotes(MediaItem_Take take, int noteidx)
integer reaper.MIDI_EnumSelNotes(MediaItem_Take take, integer noteidx)
Int RPR_MIDI_EnumSelNotes(MediaItem_Take take, Int noteidx)

Returns the index of the next selected MIDI note after noteidx (-1 if there are no more selected events).

int MIDI_EnumSelTextSysexEvts(MediaItem_Take* take, int textsyxidx)
int MIDI_EnumSelTextSysexEvts(MediaItem_Take take, int textsyxidx)
integer reaper.MIDI_EnumSelTextSysexEvts(MediaItem_Take take, integer textsyxidx)
Int RPR_MIDI_EnumSelTextSysexEvts(MediaItem_Take take, Int textsyxidx)

Returns the index of the next selected MIDI text/sysex event after textsyxidx (-1 if there are no more selected events).

bool MIDI_GetAllEvts(MediaItem_Take* take, char* bufOutNeedBig, int* bufOutNeedBig_sz)
bool MIDI_GetAllEvts(MediaItem_Take take, #buf)
boolean retval, string buf = reaper.MIDI_GetAllEvts(MediaItem_Take take)
(Boolean retval, MediaItem_Take take, String bufOutNeedBig, Int bufOutNeedBig_sz) = RPR_MIDI_GetAllEvts(take, bufOutNeedBig, bufOutNeedBig_sz)

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.

bool MIDI_GetCC(MediaItem_Take* take, int ccidx, bool* selectedOut, bool* mutedOut, double* ppqposOut, int* chanmsgOut, int* chanOut, int* msg2Out, int* msg3Out)
bool MIDI_GetCC(MediaItem_Take take, int ccidx, bool &selected, bool &muted, &ppqpos, int &chanmsg, int &chan, int &msg2, int &msg3)
boolean retval, boolean selected, boolean muted, number ppqpos, integer chanmsg, integer chan, integer msg2, integer msg3 = reaper.MIDI_GetCC(MediaItem_Take take, integer ccidx)
(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)

Get MIDI CC event properties.

bool MIDI_GetCCShape(MediaItem_Take* take, int ccidx, int* shapeOut, double* beztensionOut)
bool MIDI_GetCCShape(MediaItem_Take take, int ccidx, int &shape, &beztension)
boolean retval, integer shape, number beztension = reaper.MIDI_GetCCShape(MediaItem_Take take, integer ccidx)
(Boolean retval, MediaItem_Take take, Int ccidx, Int shapeOut, Float beztensionOut) = RPR_MIDI_GetCCShape(take, ccidx, shapeOut, beztensionOut)

Get CC shape and bezier tension. See MIDI_GetCC, MIDI_SetCCShape

bool MIDI_GetEvt(MediaItem_Take* take, int evtidx, bool* selectedOut, bool* mutedOut, double* ppqposOut, char* msgOut, int* msgOut_sz)
bool MIDI_GetEvt(MediaItem_Take take, int evtidx, bool &selected, bool &muted, &ppqpos, #msg)
boolean retval, boolean selected, boolean muted, number ppqpos, string msg = reaper.MIDI_GetEvt(MediaItem_Take take, integer evtidx)
(Boolean retval, MediaItem_Take take, Int evtidx, Boolean selectedOut, Boolean mutedOut, Float ppqposOut, String msgOut, Int msgOut_sz) = RPR_MIDI_GetEvt(take, evtidx, selectedOut, mutedOut, ppqposOut, msgOut, msgOut_sz)

Get MIDI event properties.

double MIDI_GetGrid(MediaItem_Take* take, double* swingOutOptional, double* noteLenOutOptional)
double MIDI_GetGrid(MediaItem_Take take, optional &swing, optional &noteLen)
number retval, optional number swing, optional number noteLen = reaper.MIDI_GetGrid(MediaItem_Take take)
(Float retval, MediaItem_Take take, Float swingOutOptional, Float noteLenOutOptional) = RPR_MIDI_GetGrid(take, swingOutOptional, noteLenOutOptional)

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.

bool MIDI_GetHash(MediaItem_Take* take, bool notesonly, char* hashOut, int hashOut_sz)
bool MIDI_GetHash(MediaItem_Take take, bool notesonly, #hash)
boolean retval, string hash = reaper.MIDI_GetHash(MediaItem_Take take, boolean notesonly)
(Boolean retval, MediaItem_Take take, Boolean notesonly, String hashOut, Int hashOut_sz) = RPR_MIDI_GetHash(take, notesonly, hashOut, hashOut_sz)

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

bool MIDI_GetNote(MediaItem_Take* take, int noteidx, bool* selectedOut, bool* mutedOut, double* startppqposOut, double* endppqposOut, int* chanOut, int* pitchOut, int* velOut)
bool MIDI_GetNote(MediaItem_Take take, int noteidx, bool &selected, bool &muted, &startppqpos, &endppqpos, int &chan, int &pitch, int &vel)
boolean retval, boolean selected, boolean muted, number startppqpos, number endppqpos, integer chan, integer pitch, integer vel = reaper.MIDI_GetNote(MediaItem_Take take, integer noteidx)
(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)

Get MIDI note properties.

double MIDI_GetPPQPos_EndOfMeasure(MediaItem_Take* take, double ppqpos)
double MIDI_GetPPQPos_EndOfMeasure(MediaItem_Take take, ppqpos)
number reaper.MIDI_GetPPQPos_EndOfMeasure(MediaItem_Take take, number ppqpos)
Float RPR_MIDI_GetPPQPos_EndOfMeasure(MediaItem_Take take, Float ppqpos)

Returns the MIDI tick (ppq) position corresponding to the end of the measure.

double MIDI_GetPPQPos_StartOfMeasure(MediaItem_Take* take, double ppqpos)
double MIDI_GetPPQPos_StartOfMeasure(MediaItem_Take take, ppqpos)
number reaper.MIDI_GetPPQPos_StartOfMeasure(MediaItem_Take take, number ppqpos)
Float RPR_MIDI_GetPPQPos_StartOfMeasure(MediaItem_Take take, Float ppqpos)

Returns the MIDI tick (ppq) position corresponding to the start of the measure.

double MIDI_GetPPQPosFromProjQN(MediaItem_Take* take, double projqn)
double MIDI_GetPPQPosFromProjQN(MediaItem_Take take, projqn)
number reaper.MIDI_GetPPQPosFromProjQN(MediaItem_Take take, number projqn)
Float RPR_MIDI_GetPPQPosFromProjQN(MediaItem_Take take, Float projqn)

Returns the MIDI tick (ppq) position corresponding to a specific project time in quarter notes.

double MIDI_GetPPQPosFromProjTime(MediaItem_Take* take, double projtime)
double MIDI_GetPPQPosFromProjTime(MediaItem_Take take, projtime)
number reaper.MIDI_GetPPQPosFromProjTime(MediaItem_Take take, number projtime)
Float RPR_MIDI_GetPPQPosFromProjTime(MediaItem_Take take, Float projtime)

Returns the MIDI tick (ppq) position corresponding to a specific project time in seconds.

double MIDI_GetProjQNFromPPQPos(MediaItem_Take* take, double ppqpos)
double MIDI_GetProjQNFromPPQPos(MediaItem_Take take, ppqpos)
number reaper.MIDI_GetProjQNFromPPQPos(MediaItem_Take take, number ppqpos)
Float RPR_MIDI_GetProjQNFromPPQPos(MediaItem_Take take, Float ppqpos)

Returns the project time in quarter notes corresponding to a specific MIDI tick (ppq) position.

double MIDI_GetProjTimeFromPPQPos(MediaItem_Take* take, double ppqpos)
double MIDI_GetProjTimeFromPPQPos(MediaItem_Take take, ppqpos)
number reaper.MIDI_GetProjTimeFromPPQPos(MediaItem_Take take, number ppqpos)
Float RPR_MIDI_GetProjTimeFromPPQPos(MediaItem_Take take, Float ppqpos)

Returns the project time in seconds corresponding to a specific MIDI tick (ppq) position.

int MIDI_GetRecentInputEvent(int idx, char* bufOut, int* bufOut_sz, int* tsOut, int* devIdxOut, double* projPosOut, int* projLoopCntOut)
int MIDI_GetRecentInputEvent(int idx, #buf, int &ts, int &devIdx, &projPos, int &projLoopCnt)
integer retval, string buf, integer ts, integer devIdx, number projPos, integer projLoopCnt = reaper.MIDI_GetRecentInputEvent(integer idx)
(Int retval, Int idx, String bufOut, Int bufOut_sz, Int tsOut, Int devIdxOut, Float projPosOut, Int projLoopCntOut) = RPR_MIDI_GetRecentInputEvent(idx, bufOut, bufOut_sz, tsOut, devIdxOut, projPosOut, projLoopCntOut)

Gets a recent MIDI input event from the global history. idx=0 for the most recent event, which also latches to the latest MIDI event state (to get a more recent list, calling with idx=0 is necessary). idx=1 next most recent event, returns a non-zero sequence number for the event, or zero if no more events. tsOut will be set to the timestamp in samples relative to the current position (0 is current, -48000 is one second ago, etc). devIdxOut will have the low 16 bits set to the input device index, and 0x10000 will be set if device was enabled only for control. projPosOut will be set to project position in seconds if project was playing back at time of event, otherwise -1. Large SysEx events will not be included in this event list.

bool MIDI_GetScale(MediaItem_Take* take, int* rootOut, int* scaleOut, char* nameOut, int nameOut_sz)
bool MIDI_GetScale(MediaItem_Take take, int &root, int &scale, #name)
boolean retval, integer root, integer scale, string name = reaper.MIDI_GetScale(MediaItem_Take take)
(Boolean retval, MediaItem_Take take, Int rootOut, Int scaleOut, String nameOut, Int nameOut_sz) = RPR_MIDI_GetScale(take, rootOut, scaleOut, nameOut, nameOut_sz)

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.

bool MIDI_GetTextSysexEvt(MediaItem_Take* take, int textsyxevtidx, bool* selectedOutOptional, bool* mutedOutOptional, double* ppqposOutOptional, int* typeOutOptional, char* msgOptional, int* msgOptional_sz)
bool MIDI_GetTextSysexEvt(MediaItem_Take take, int textsyxevtidx, optional bool &selected, optional bool &muted, optional &ppqpos, optional int &type, optional #msg)
boolean retval, optional boolean selected, optional boolean muted, optional number ppqpos, optional integer type, optional string msg = reaper.MIDI_GetTextSysexEvt(MediaItem_Take take, integer textsyxevtidx, optional boolean selected, optional boolean muted, optional number ppqpos, optional integer type, optional string msg)
(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)

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.

bool MIDI_GetTrackHash(MediaTrack* track, bool notesonly, char* hashOut, int hashOut_sz)
bool MIDI_GetTrackHash(MediaTrack track, bool notesonly, #hash)
boolean retval, string hash = reaper.MIDI_GetTrackHash(MediaTrack track, boolean notesonly)
(Boolean retval, MediaTrack track, Boolean notesonly, String hashOut, Int hashOut_sz) = RPR_MIDI_GetTrackHash(track, notesonly, hashOut, hashOut_sz)

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

bool MIDI_InsertCC(MediaItem_Take* take, bool selected, bool muted, double ppqpos, int chanmsg, int chan, int msg2, int msg3)
bool MIDI_InsertCC(MediaItem_Take take, bool selected, bool muted, ppqpos, int chanmsg, int chan, int msg2, int msg3)
boolean reaper.MIDI_InsertCC(MediaItem_Take take, boolean selected, boolean muted, number ppqpos, integer chanmsg, integer chan, integer msg2, integer msg3)
Boolean RPR_MIDI_InsertCC(MediaItem_Take take, Boolean selected, Boolean muted, Float ppqpos, Int chanmsg, Int chan, Int msg2, Int msg3)

Insert a new MIDI CC event.

bool MIDI_InsertEvt(MediaItem_Take* take, bool selected, bool muted, double ppqpos, const char* bytestr, int bytestr_sz)
bool MIDI_InsertEvt(MediaItem_Take take, bool selected, bool muted, ppqpos, "bytestr")
boolean reaper.MIDI_InsertEvt(MediaItem_Take take, boolean selected, boolean muted, number ppqpos, string bytestr)
Boolean RPR_MIDI_InsertEvt(MediaItem_Take take, Boolean selected, Boolean muted, Float ppqpos, String bytestr, Int bytestr_sz)

Insert a new MIDI event.

bool MIDI_InsertNote(MediaItem_Take* take, bool selected, bool muted, double startppqpos, double endppqpos, int chan, int pitch, int vel, const bool* noSortInOptional)
bool MIDI_InsertNote(MediaItem_Take take, bool selected, bool muted, startppqpos, endppqpos, int chan, int pitch, int vel, optional bool noSortIn)
boolean reaper.MIDI_InsertNote(MediaItem_Take take, boolean selected, boolean muted, number startppqpos, number endppqpos, integer chan, integer pitch, integer vel, optional boolean noSortIn)
Boolean RPR_MIDI_InsertNote(MediaItem_Take take, Boolean selected, Boolean muted, Float startppqpos, Float endppqpos, Int chan, Int pitch, Int vel, const bool noSortInOptional)

Insert a new MIDI note. Set noSort if inserting multiple events, then call MIDI_Sort when done.

bool MIDI_InsertTextSysexEvt(MediaItem_Take* take, bool selected, bool muted, double ppqpos, int type, const char* bytestr, int bytestr_sz)
bool MIDI_InsertTextSysexEvt(MediaItem_Take take, bool selected, bool muted, ppqpos, int type, "bytestr")
boolean reaper.MIDI_InsertTextSysexEvt(MediaItem_Take take, boolean selected, boolean muted, number ppqpos, integer type, string bytestr)
Boolean RPR_MIDI_InsertTextSysexEvt(MediaItem_Take take, Boolean selected, Boolean muted, Float ppqpos, Int type, String bytestr, Int bytestr_sz)

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.

void midi_reinit()
midi_reinit()
reaper.midi_reinit()
RPR_midi_reinit()

Reset all MIDI devices

void MIDI_SelectAll(MediaItem_Take* take, bool select)
MIDI_SelectAll(MediaItem_Take take, bool select)
reaper.MIDI_SelectAll(MediaItem_Take take, boolean select)
RPR_MIDI_SelectAll(MediaItem_Take take, Boolean select)

Select or deselect all MIDI content.

bool MIDI_SetAllEvts(MediaItem_Take* take, const char* buf, int buf_sz)
bool MIDI_SetAllEvts(MediaItem_Take take, "buf")
boolean reaper.MIDI_SetAllEvts(MediaItem_Take take, string buf)
Boolean RPR_MIDI_SetAllEvts(MediaItem_Take take, String buf, Int buf_sz)

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.

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)
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)
boolean reaper.MIDI_SetCC(MediaItem_Take take, integer ccidx, optional boolean selectedIn, optional boolean mutedIn, optional number ppqposIn, optional integer chanmsgIn, optional integer chanIn, optional integer msg2In, optional integer msg3In, optional boolean noSortIn)
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)

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.

bool MIDI_SetCCShape(MediaItem_Take* take, int ccidx, int shape, double beztension, const bool* noSortInOptional)
bool MIDI_SetCCShape(MediaItem_Take take, int ccidx, int shape, beztension, optional bool noSortIn)
boolean reaper.MIDI_SetCCShape(MediaItem_Take take, integer ccidx, integer shape, number beztension, optional boolean noSortIn)
Boolean RPR_MIDI_SetCCShape(MediaItem_Take take, Int ccidx, Int shape, Float beztension, const bool noSortInOptional)

Set CC shape and bezier tension. set noSort if setting multiple events, then call MIDI_Sort when done. See MIDI_SetCC, MIDI_GetCCShape

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)
bool MIDI_SetEvt(MediaItem_Take take, int evtidx, optional bool selectedIn, optional bool mutedIn, optional ppqposIn, optional "msg", optional bool noSortIn)
boolean reaper.MIDI_SetEvt(MediaItem_Take take, integer evtidx, optional boolean selectedIn, optional boolean mutedIn, optional number ppqposIn, optional string msg, optional boolean noSortIn)
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)

Set MIDI event properties. Properties passed as NULL will not be set. set noSort if setting multiple events, then call MIDI_Sort when done.

bool MIDI_SetItemExtents(MediaItem* item, double startQN, double endQN)
bool MIDI_SetItemExtents(MediaItem item, startQN, endQN)
boolean reaper.MIDI_SetItemExtents(MediaItem item, number startQN, number endQN)
Boolean RPR_MIDI_SetItemExtents(MediaItem item, Float startQN, Float endQN)

Set the start/end positions of a media item that contains a MIDI take.

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)
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)
boolean reaper.MIDI_SetNote(MediaItem_Take take, integer noteidx, optional boolean selectedIn, optional boolean mutedIn, optional number startppqposIn, optional number endppqposIn, optional integer chanIn, optional integer pitchIn, optional integer velIn, optional boolean noSortIn)
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)

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.

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)
bool MIDI_SetTextSysexEvt(MediaItem_Take take, int textsyxevtidx, optional bool selectedIn, optional bool mutedIn, optional ppqposIn, optional int typeIn, optional "msg", optional bool noSortIn)
boolean reaper.MIDI_SetTextSysexEvt(MediaItem_Take take, integer textsyxevtidx, optional boolean selectedIn, optional boolean mutedIn, optional number ppqposIn, optional integer typeIn, optional string msg, optional boolean noSortIn)
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)

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.

void MIDI_Sort(MediaItem_Take* take)
MIDI_Sort(MediaItem_Take take)
reaper.MIDI_Sort(MediaItem_Take take)
RPR_MIDI_Sort(MediaItem_Take take)

Sort MIDI events after multiple calls to MIDI_SetNote, MIDI_SetCC, etc.

MediaItem_Take* MIDIEditor_EnumTakes(HWND midieditor, int takeindex, bool editable_only)
MediaItem_Take MIDIEditor_EnumTakes(HWND midieditor, int takeindex, bool editable_only)
MediaItem_Take reaper.MIDIEditor_EnumTakes(HWND midieditor, integer takeindex, boolean editable_only)
MediaItem_Take RPR_MIDIEditor_EnumTakes(HWND midieditor, Int takeindex, Boolean editable_only)

list the takes that are currently being edited in this MIDI editor, starting with the active take. See MIDIEditor_GetTake

HWND MIDIEditor_GetActive()
HWND MIDIEditor_GetActive()
HWND reaper.MIDIEditor_GetActive()
HWND RPR_MIDIEditor_GetActive()

get a pointer to the focused MIDI editor window
see MIDIEditor_GetMode, MIDIEditor_OnCommand

int MIDIEditor_GetMode(HWND midieditor)
int MIDIEditor_GetMode(HWND midieditor)
integer reaper.MIDIEditor_GetMode(HWND midieditor)
Int RPR_MIDIEditor_GetMode(HWND midieditor)

get the mode of a MIDI editor (0=piano roll, 1=event list, -1=invalid editor)
see MIDIEditor_GetActive, MIDIEditor_OnCommand

int MIDIEditor_GetSetting_int(HWND midieditor, const char* setting_desc)
int MIDIEditor_GetSetting_int(HWND midieditor, "setting_desc")
integer reaper.MIDIEditor_GetSetting_int(HWND midieditor, string setting_desc)
Int RPR_MIDIEditor_GetSetting_int(HWND midieditor, String setting_desc)

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)
list_cnt: if viewing list view, returns event count
if setting_desc is unsupported, the function returns -1.
See MIDIEditor_SetSetting_int, MIDIEditor_GetActive, MIDIEditor_GetSetting_str

bool MIDIEditor_GetSetting_str(HWND midieditor, const char* setting_desc, char* bufOut, int bufOut_sz)
bool MIDIEditor_GetSetting_str(HWND midieditor, "setting_desc", #buf)
boolean retval, string buf = reaper.MIDIEditor_GetSetting_str(HWND midieditor, string setting_desc)
(Boolean retval, HWND midieditor, String setting_desc, String bufOut, Int bufOut_sz) = RPR_MIDIEditor_GetSetting_str(midieditor, setting_desc, bufOut, bufOut_sz)

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
list_X: if viewing list view, returns string describing event at row X (0-based). String will have a list of key=value pairs, e.g. 'pos=4.0 len=4.0 offvel=127 msg=90317F'. pos/len times are in QN, len/offvel may not be present if event is not a note. other keys which may be present include pos_pq/len_pq, sel, mute, ccval14, ccshape, ccbeztension.
if setting_desc is unsupported, the function returns false.
See MIDIEditor_GetActive, MIDIEditor_GetSetting_int

MediaItem_Take* MIDIEditor_GetTake(HWND midieditor)
MediaItem_Take MIDIEditor_GetTake(HWND midieditor)
MediaItem_Take reaper.MIDIEditor_GetTake(HWND midieditor)
MediaItem_Take RPR_MIDIEditor_GetTake(HWND midieditor)

get the take that is currently being edited in this MIDI editor. see MIDIEditor_EnumTakes

bool MIDIEditor_LastFocused_OnCommand(int command_id, bool islistviewcommand)
bool MIDIEditor_LastFocused_OnCommand(int command_id, bool islistviewcommand)
boolean reaper.MIDIEditor_LastFocused_OnCommand(integer command_id, boolean islistviewcommand)
Boolean RPR_MIDIEditor_LastFocused_OnCommand(Int command_id, Boolean islistviewcommand)

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

bool MIDIEditor_OnCommand(HWND midieditor, int command_id)
bool MIDIEditor_OnCommand(HWND midieditor, int command_id)
boolean reaper.MIDIEditor_OnCommand(HWND midieditor, integer command_id)
Boolean RPR_MIDIEditor_OnCommand(HWND midieditor, Int command_id)

Send an action command to a MIDI editor. Returns false if the supplied MIDI editor pointer is not valid (not an open MIDI editor).
see MIDIEditor_GetActive, MIDIEditor_LastFocused_OnCommand

bool MIDIEditor_SetSetting_int(HWND midieditor, const char* setting_desc, int setting)
bool MIDIEditor_SetSetting_int(HWND midieditor, "setting_desc", int setting)
boolean reaper.MIDIEditor_SetSetting_int(HWND midieditor, string setting_desc, integer setting)
Boolean RPR_MIDIEditor_SetSetting_int(HWND midieditor, String setting_desc, Int setting)

Set settings for a MIDI editor. setting_desc can be:
active_note_row: 0-127
See MIDIEditor_GetSetting_int

void mkpanstr(char* strNeed64, double pan)
mkpanstr(#strNeed64, pan)
string strNeed64 = reaper.mkpanstr(string strNeed64, number pan)
(String strNeed64, Float pan) = RPR_mkpanstr(strNeed64, pan)
void mkvolpanstr(char* strNeed64, double vol, double pan)
mkvolpanstr(#strNeed64, vol, pan)
string strNeed64 = reaper.mkvolpanstr(string strNeed64, number vol, number pan)
(String strNeed64, Float vol, Float pan) = RPR_mkvolpanstr(strNeed64, vol, pan)
void mkvolstr(char* strNeed64, double vol)
mkvolstr(#strNeed64, vol)
string strNeed64 = reaper.mkvolstr(string strNeed64, number vol)
(String strNeed64, Float vol) = RPR_mkvolstr(strNeed64, vol)
void MoveEditCursor(double adjamt, bool dosel)
MoveEditCursor(adjamt, bool dosel)
reaper.MoveEditCursor(number adjamt, boolean dosel)
RPR_MoveEditCursor(Float adjamt, Boolean dosel)
bool MoveMediaItemToTrack(MediaItem* item, MediaTrack* desttr)
bool MoveMediaItemToTrack(MediaItem item, MediaTrack desttr)
boolean reaper.MoveMediaItemToTrack(MediaItem item, MediaTrack desttr)
Boolean RPR_MoveMediaItemToTrack(MediaItem item, MediaTrack desttr)

returns TRUE if move succeeded

void MuteAllTracks(bool mute)
MuteAllTracks(bool mute)
reaper.MuteAllTracks(boolean mute)
RPR_MuteAllTracks(Boolean mute)
void my_getViewport(RECT* r, const RECT* sr, bool wantWorkArea)
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)
reaper.my_getViewport(integerr.left, integerr.top, integerr.right, integerr.bot, integer sr.left, integer sr.top, integer sr.right, integer sr.bot, boolean wantWorkArea)
RPR_my_getViewport(RECT r, const RECT sr, Boolean wantWorkArea)
int NamedCommandLookup(const char* command_name)
int NamedCommandLookup("command_name")
integer reaper.NamedCommandLookup(string command_name)
Int RPR_NamedCommandLookup(String command_name)

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.

void OnPauseButton()
OnPauseButton()
reaper.OnPauseButton()
RPR_OnPauseButton()

direct way to simulate pause button hit

void OnPauseButtonEx(ReaProject* proj)
OnPauseButtonEx(ReaProject proj)
reaper.OnPauseButtonEx(ReaProject proj)
RPR_OnPauseButtonEx(ReaProject proj)

direct way to simulate pause button hit

void OnPlayButton()
OnPlayButton()
reaper.OnPlayButton()
RPR_OnPlayButton()

direct way to simulate play button hit

void OnPlayButtonEx(ReaProject* proj)
OnPlayButtonEx(ReaProject proj)
reaper.OnPlayButtonEx(ReaProject proj)
RPR_OnPlayButtonEx(ReaProject proj)

direct way to simulate play button hit

void OnStopButton()
OnStopButton()
reaper.OnStopButton()
RPR_OnStopButton()

direct way to simulate stop button hit

void OnStopButtonEx(ReaProject* proj)
OnStopButtonEx(ReaProject proj)
reaper.OnStopButtonEx(ReaProject proj)
RPR_OnStopButtonEx(ReaProject proj)

direct way to simulate stop button hit

bool OpenColorThemeFile(const char* fn)
bool OpenColorThemeFile("fn")
boolean reaper.OpenColorThemeFile(string fn)
Boolean RPR_OpenColorThemeFile(String fn)
HWND OpenMediaExplorer(const char* mediafn, bool play)
HWND OpenMediaExplorer("mediafn", bool play)
HWND reaper.OpenMediaExplorer(string mediafn, boolean play)
HWND RPR_OpenMediaExplorer(String mediafn, Boolean play)

Opens mediafn in the Media Explorer, play=true will play the file immediately (or toggle playback if mediafn was already open), =false will just select it.

void OscLocalMessageToHost(const char* message, const double* valueInOptional)
OscLocalMessageToHost("message", optional valueIn)
reaper.OscLocalMessageToHost(string message, optional number valueIn)
RPR_OscLocalMessageToHost(String message, const double valueInOptional)

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.

double parse_timestr(const char* buf)
double parse_timestr("buf")
number reaper.parse_timestr(string buf)
Float RPR_parse_timestr(String buf)

Parse hh:mm:ss.sss time string, return time in seconds (or 0.0 on error). See parse_timestr_pos, parse_timestr_len.

double parse_timestr_len(const char* buf, double offset, int modeoverride)
double parse_timestr_len("buf", offset, int modeoverride)
number reaper.parse_timestr_len(string buf, number offset, integer modeoverride)
Float RPR_parse_timestr_len(String buf, Float offset, Int modeoverride)

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

double parse_timestr_pos(const char* buf, int modeoverride)
double parse_timestr_pos("buf", int modeoverride)
number reaper.parse_timestr_pos(string buf, integer modeoverride)
Float RPR_parse_timestr_pos(String buf, Int modeoverride)

Parse time string, 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

double parsepanstr(const char* str)
double parsepanstr("str")
number reaper.parsepanstr(string str)
Float RPR_parsepanstr(String str)
unsigned int PCM_Sink_Enum(int idx, const char** descstrOut)
uint PCM_Sink_Enum(int idx, #descstr)
integer retval, string descstr = reaper.PCM_Sink_Enum(integer idx)
Unknown RPR_PCM_Sink_Enum(Int idx, String descstrOut)
const char* PCM_Sink_GetExtension(const char* data, int data_sz)
bool PCM_Sink_GetExtension(#retval, "data")
string reaper.PCM_Sink_GetExtension(string data)
String RPR_PCM_Sink_GetExtension(String data, Int data_sz)
HWND PCM_Sink_ShowConfig(const char* cfg, int cfg_sz, HWND hwndParent)
HWND PCM_Sink_ShowConfig("cfg", HWND hwndParent)
HWND reaper.PCM_Sink_ShowConfig(string cfg, HWND hwndParent)
HWND RPR_PCM_Sink_ShowConfig(String cfg, Int cfg_sz, HWND hwndParent)
int PCM_Source_BuildPeaks(PCM_source* src, int mode)
int PCM_Source_BuildPeaks(PCM_source src, int mode)
integer reaper.PCM_Source_BuildPeaks(PCM_source src, integer mode)
Int RPR_PCM_Source_BuildPeaks(PCM_source src, Int mode)

Calls and returns PCM_source::PeaksBuild_Begin() if mode=0, PeaksBuild_Run() if mode=1, and PeaksBuild_Finish() if mode=2. Normal use is to call PCM_Source_BuildPeaks(src,0), and if that returns nonzero, call PCM_Source_BuildPeaks(src,1) repeatedly until it returns zero (it will process a block of time each time you call it, and return the percentage of the file remaining), then call PCM_Source_BuildPeaks(src,2) to finalize. If PCM_Source_BuildPeaks(src,0) returns zero, then no further action is necessary.

PCM_source* PCM_Source_CreateFromFile(const char* filename)
PCM_source PCM_Source_CreateFromFile("filename")
PCM_source reaper.PCM_Source_CreateFromFile(string filename)
PCM_source RPR_PCM_Source_CreateFromFile(String filename)

See PCM_Source_CreateFromFileEx.

PCM_source* PCM_Source_CreateFromFileEx(const char* filename, bool forcenoMidiImp)
PCM_source PCM_Source_CreateFromFileEx("filename", bool forcenoMidiImp)
PCM_source reaper.PCM_Source_CreateFromFileEx(string filename, boolean forcenoMidiImp)
PCM_source RPR_PCM_Source_CreateFromFileEx(String filename, Boolean forcenoMidiImp)

Create a PCM_source from filename, and override pref of MIDI files being imported as in-project MIDI events.

PCM_source* PCM_Source_CreateFromType(const char* sourcetype)
PCM_source PCM_Source_CreateFromType("sourcetype")
PCM_source reaper.PCM_Source_CreateFromType(string sourcetype)
PCM_source RPR_PCM_Source_CreateFromType(String sourcetype)

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.

void PCM_Source_Destroy(PCM_source* src)
PCM_Source_Destroy(PCM_source src)
reaper.PCM_Source_Destroy(PCM_source src)
RPR_PCM_Source_Destroy(PCM_source src)

Deletes a PCM_source -- be sure that you remove any project reference before deleting a source

int PCM_Source_GetPeaks(PCM_source* src, double peakrate, double starttime, int numchannels, int numsamplesperchannel, int want_extra_type, double* buf)
int PCM_Source_GetPeaks(PCM_source src, peakrate, starttime, int numchannels, int numsamplesperchannel, int want_extra_type, buffer_ptr buf)
integer reaper.PCM_Source_GetPeaks(PCM_source src, number peakrate, number starttime, integer numchannels, integer numsamplesperchannel, integer want_extra_type, reaper.array buf)
(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)

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.

bool PCM_Source_GetSectionInfo(PCM_source* src, double* offsOut, double* lenOut, bool* revOut)
bool PCM_Source_GetSectionInfo(PCM_source src, &offs, &len, bool &rev)
boolean retval, number offs, number len, boolean rev = reaper.PCM_Source_GetSectionInfo(PCM_source src)
(Boolean retval, PCM_source src, Float offsOut, Float lenOut, Boolean revOut) = RPR_PCM_Source_GetSectionInfo(src, offsOut, lenOut, revOut)

If a section/reverse block, retrieves offset/len/reverse. return true if success

void PluginWantsAlwaysRunFx(int amt)
PluginWantsAlwaysRunFx(int amt)
reaper.PluginWantsAlwaysRunFx(integer amt)
RPR_PluginWantsAlwaysRunFx(Int amt)
void PreventUIRefresh(int prevent_count)
PreventUIRefresh(int prevent_count)
reaper.PreventUIRefresh(integer prevent_count)
RPR_PreventUIRefresh(Int prevent_count)

adds prevent_count to the UI refresh prevention state; always add then remove the same amount, or major disfunction will occur

int PromptForAction(int session_mode, int init_id, int section_id)
int PromptForAction(int session_mode, int init_id, int section_id)
integer reaper.PromptForAction(integer session_mode, integer init_id, integer section_id)
Int RPR_PromptForAction(Int session_mode, Int init_id, Int section_id)

Uses the action list to choose an action. Call with session_mode=1 to create a session (init_id will be the initial action to select, or 0), then poll with session_mode=0, checking return value for user-selected action (will return 0 if no action selected yet, or -1 if the action window is no longer available). When finished, call with session_mode=-1.

void ReaScriptError(const char* errmsg)
ReaScriptError("errmsg")
reaper.ReaScriptError(string errmsg)
RPR_ReaScriptError(String errmsg)

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.

int RecursiveCreateDirectory(const char* path, size_t ignored)
int RecursiveCreateDirectory("path", size_t ignored)
integer reaper.RecursiveCreateDirectory(string path, integer ignored)
Int RPR_RecursiveCreateDirectory(String path, Unknown ignored)

returns positive value on success, 0 on failure.

int reduce_open_files(int flags)
int reduce_open_files(int flags)
integer reaper.reduce_open_files(integer flags)
Int RPR_reduce_open_files(Int flags)

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.

void RefreshToolbar(int command_id)
RefreshToolbar(int command_id)
reaper.RefreshToolbar(integer command_id)
RPR_RefreshToolbar(Int command_id)

See RefreshToolbar2.

void RefreshToolbar2(int section_id, int command_id)
RefreshToolbar2(int section_id, int command_id)
reaper.RefreshToolbar2(integer section_id, integer command_id)
RPR_RefreshToolbar2(Int section_id, Int command_id)

Refresh the toolbar button states of a toggle action.

void relative_fn(const char* in, char* out, int out_sz)
relative_fn("in", #out)
string out = reaper.relative_fn(string in, string out)
(String in, String out, Int out_sz) = RPR_relative_fn(in, out, out_sz)

Makes a filename "in" relative to the current project, if any.

bool RemoveTrackSend(MediaTrack* tr, int category, int sendidx)
bool RemoveTrackSend(MediaTrack tr, int category, int sendidx)
boolean reaper.RemoveTrackSend(MediaTrack tr, integer category, integer sendidx)
Boolean RPR_RemoveTrackSend(MediaTrack tr, Int category, Int sendidx)

Remove a send/receive/hardware output, return true on success. category is <0 for receives, 0=sends, >0 for hardware outputs. See CreateTrackSend, GetSetTrackSendInfo, GetTrackSendInfo_Value, SetTrackSendInfo_Value, GetTrackNumSends.

bool RenderFileSection(const char* source_filename, const char* target_filename, double start_percent, double end_percent, double playrate)
bool RenderFileSection("source_filename", "target_filename", start_percent, end_percent, playrate)
boolean reaper.RenderFileSection(string source_filename, string target_filename, number start_percent, number end_percent, number playrate)
Boolean RPR_RenderFileSection(String source_filename, String target_filename, Float start_percent, Float end_percent, Float playrate)

Not available while playing back.

bool ReorderSelectedTracks(int beforeTrackIdx, int makePrevFolder)
bool ReorderSelectedTracks(int beforeTrackIdx, int makePrevFolder)
boolean reaper.ReorderSelectedTracks(integer beforeTrackIdx, integer makePrevFolder)
Boolean RPR_ReorderSelectedTracks(Int beforeTrackIdx, Int makePrevFolder)

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

const char* Resample_EnumModes(int mode)
bool Resample_EnumModes(#retval, int mode)
string reaper.Resample_EnumModes(integer mode)
String RPR_Resample_EnumModes(Int mode)
void resolve_fn(const char* in, char* out, int out_sz)
resolve_fn("in", #out)
string out = reaper.resolve_fn(string in, string out)
(String in, String out, Int out_sz) = RPR_resolve_fn(in, out, out_sz)

See resolve_fn2.

void resolve_fn2(const char* in, char* out, int out_sz, const char* checkSubDirOptional)
resolve_fn2("in", #out, optional "checkSubDir")
string out = reaper.resolve_fn2(string in, string out, optional string checkSubDir)
(String in, String out, Int out_sz, String checkSubDirOptional) = RPR_resolve_fn2(in, out, out_sz, checkSubDirOptional)

Resolves a filename "in" by using project settings etc. If no file found, out will be a copy of in.

const char* ReverseNamedCommandLookup(int command_id)
bool ReverseNamedCommandLookup(#retval, int command_id)
string reaper.ReverseNamedCommandLookup(integer command_id)
String RPR_ReverseNamedCommandLookup(Int command_id)

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.

double ScaleFromEnvelopeMode(int scaling_mode, double val)
double ScaleFromEnvelopeMode(int scaling_mode, val)
number reaper.ScaleFromEnvelopeMode(integer scaling_mode, number val)
Float RPR_ScaleFromEnvelopeMode(Int scaling_mode, Float val)

See GetEnvelopeScalingMode.

double ScaleToEnvelopeMode(int scaling_mode, double val)
double ScaleToEnvelopeMode(int scaling_mode, val)
number reaper.ScaleToEnvelopeMode(integer scaling_mode, number val)
Float RPR_ScaleToEnvelopeMode(Int scaling_mode, Float val)

See GetEnvelopeScalingMode.

void SelectAllMediaItems(ReaProject* proj, bool selected)
SelectAllMediaItems(ReaProject proj, bool selected)
reaper.SelectAllMediaItems(ReaProject proj, boolean selected)
RPR_SelectAllMediaItems(ReaProject proj, Boolean selected)
void SelectProjectInstance(ReaProject* proj)
SelectProjectInstance(ReaProject proj)
reaper.SelectProjectInstance(ReaProject proj)
RPR_SelectProjectInstance(ReaProject proj)
void SetActiveTake(MediaItem_Take* take)
SetActiveTake(MediaItem_Take take)
reaper.SetActiveTake(MediaItem_Take take)
RPR_SetActiveTake(MediaItem_Take take)

set this take active in this media item

void SetAutomationMode(int mode, bool onlySel)
SetAutomationMode(int mode, bool onlySel)
reaper.SetAutomationMode(integer mode, boolean onlySel)
RPR_SetAutomationMode(Int mode, Boolean onlySel)

sets all or selected tracks to mode.

void SetCurrentBPM(ReaProject* __proj, double bpm, bool wantUndo)
SetCurrentBPM(ReaProject __proj, bpm, bool wantUndo)
reaper.SetCurrentBPM(ReaProject __proj, number bpm, boolean wantUndo)
RPR_SetCurrentBPM(ReaProject __proj, Float bpm, Boolean wantUndo)

set current BPM in project, set wantUndo=true to add undo point

void SetCursorContext(int mode, TrackEnvelope* envInOptional)
SetCursorContext(int mode, TrackEnvelope envIn)
reaper.SetCursorContext(integer mode, TrackEnvelope envIn)
RPR_SetCursorContext(Int mode, TrackEnvelope envInOptional)

You must use this to change the focus programmatically. mode=0 to focus track panels, 1 to focus the arrange window, 2 to focus the arrange window and select env (or env==NULL to clear the current track/take envelope selection)

void SetEditCurPos(double time, bool moveview, bool seekplay)
SetEditCurPos(time, bool moveview, bool seekplay)
reaper.SetEditCurPos(number time, boolean moveview, boolean seekplay)
RPR_SetEditCurPos(Float time, Boolean moveview, Boolean seekplay)
void SetEditCurPos2(ReaProject* proj, double time, bool moveview, bool seekplay)
SetEditCurPos2(ReaProject proj, time, bool moveview, bool seekplay)
reaper.SetEditCurPos2(ReaProject proj, number time, boolean moveview, boolean seekplay)
RPR_SetEditCurPos2(ReaProject proj, Float time, Boolean moveview, Boolean seekplay)
bool SetEnvelopePoint(TrackEnvelope* envelope, int ptidx, double* timeInOptional, double* valueInOptional, int* shapeInOptional, double* tensionInOptional, bool* selectedInOptional, bool* noSortInOptional)
bool SetEnvelopePoint(TrackEnvelope envelope, int ptidx, optional timeIn, optional valueIn, optional int shapeIn, optional tensionIn, optional bool selectedIn, optional bool noSortIn)
boolean reaper.SetEnvelopePoint(TrackEnvelope envelope, integer ptidx, optional number timeIn, optional number valueIn, optional integer shapeIn, optional number tensionIn, optional boolean selectedIn, optional boolean noSortIn)
(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)

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.

bool SetEnvelopePointEx(TrackEnvelope* envelope, int autoitem_idx, int ptidx, double* timeInOptional, double* valueInOptional, int* shapeInOptional, double* tensionInOptional, bool* selectedInOptional, bool* noSortInOptional)
bool SetEnvelopePointEx(TrackEnvelope envelope, int autoitem_idx, int ptidx, optional timeIn, optional valueIn, optional int shapeIn, optional tensionIn, optional bool selectedIn, optional bool noSortIn)
boolean reaper.SetEnvelopePointEx(TrackEnvelope envelope, integer autoitem_idx, integer ptidx, optional number timeIn, optional number valueIn, optional integer shapeIn, optional number tensionIn, optional boolean selectedIn, optional boolean noSortIn)
(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)

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.

bool SetEnvelopeStateChunk(TrackEnvelope* env, const char* str, bool isundoOptional)
bool SetEnvelopeStateChunk(TrackEnvelope env, "str", bool isundo)
boolean reaper.SetEnvelopeStateChunk(TrackEnvelope env, string str, boolean isundo)
Boolean RPR_SetEnvelopeStateChunk(TrackEnvelope env, String str, Boolean isundoOptional)

Sets the RPPXML state of an envelope, returns true if successful. Undo flag is a performance/caching hint.

void SetExtState(const char* section, const char* key, const char* value, bool persist)
SetExtState("section", "key", "value", bool persist)
reaper.SetExtState(string section, string key, string value, boolean persist)
RPR_SetExtState(String section, String key, String value, Boolean persist)

Set the extended state value for a specific section and key. persist=true means the value should be stored and reloaded the next time REAPER is opened. See GetExtState, DeleteExtState, HasExtState.

void SetGlobalAutomationOverride(int mode)
SetGlobalAutomationOverride(int mode)
reaper.SetGlobalAutomationOverride(integer mode)
RPR_SetGlobalAutomationOverride(Int mode)

mode: see GetGlobalAutomationOverride

bool SetItemStateChunk(MediaItem* item, const char* str, bool isundoOptional)
bool SetItemStateChunk(MediaItem item, "str", bool isundo)
boolean reaper.SetItemStateChunk(MediaItem item, string str, boolean isundo)
Boolean RPR_SetItemStateChunk(MediaItem item, String str, Boolean isundoOptional)

Sets the RPPXML state of an item, returns true if successful. Undo flag is a performance/caching hint.

int SetMasterTrackVisibility(int flag)
int SetMasterTrackVisibility(int flag)
integer reaper.SetMasterTrackVisibility(integer flag)
Int RPR_SetMasterTrackVisibility(Int flag)

set &1 to show the master track in the TCP, &2 to HIDE in the mixer. Returns the previous visibility state. See GetMasterTrackVisibility.

bool SetMediaItemInfo_Value(MediaItem* item, const char* parmname, double newvalue)
bool SetMediaItemInfo_Value(MediaItem item, "parmname", newvalue)
boolean reaper.SetMediaItemInfo_Value(MediaItem item, string parmname, number newvalue)
Boolean RPR_SetMediaItemInfo_Value(MediaItem item, String parmname, Float newvalue)

Set media item numerical-value attributes.
B_MUTE : bool * : muted (item solo overrides). setting this value will clear C_MUTE_SOLO.
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
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 (relative to top of track) in pixels (read-only)
I_LASTH : int * : height 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)

bool SetMediaItemLength(MediaItem* item, double length, bool refreshUI)
bool SetMediaItemLength(MediaItem item, length, bool refreshUI)
boolean reaper.SetMediaItemLength(MediaItem item, number length, boolean refreshUI)
Boolean RPR_SetMediaItemLength(MediaItem item, Float length, Boolean refreshUI)

Redraws the screen only if refreshUI == true.
See UpdateArrange().

bool SetMediaItemPosition(MediaItem* item, double position, bool refreshUI)
bool SetMediaItemPosition(MediaItem item, position, bool refreshUI)
boolean reaper.SetMediaItemPosition(MediaItem item, number position, boolean refreshUI)
Boolean RPR_SetMediaItemPosition(MediaItem item, Float position, Boolean refreshUI)

Redraws the screen only if refreshUI == true.
See UpdateArrange().

void SetMediaItemSelected(MediaItem* item, bool selected)
SetMediaItemSelected(MediaItem item, bool selected)
reaper.SetMediaItemSelected(MediaItem item, boolean selected)
RPR_SetMediaItemSelected(MediaItem item, Boolean selected)
bool SetMediaItemTake_Source(MediaItem_Take* take, PCM_source* source)
bool SetMediaItemTake_Source(MediaItem_Take take, PCM_source source)
boolean reaper.SetMediaItemTake_Source(MediaItem_Take take, PCM_source source)
Boolean RPR_SetMediaItemTake_Source(MediaItem_Take take, PCM_source source)

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.

bool SetMediaItemTakeInfo_Value(MediaItem_Take* take, const char* parmname, double newvalue)
bool SetMediaItemTakeInfo_Value(MediaItem_Take take, "parmname", newvalue)
boolean reaper.SetMediaItemTakeInfo_Value(MediaItem_Take take, string parmname, number newvalue)
Boolean RPR_SetMediaItemTakeInfo_Value(MediaItem_Take take, String parmname, Float newvalue)

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_LASTY : int * : Y-position (relative to top of track) in pixels (read-only)
I_LASTH : int * : height in pixels (read-only)
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)

bool SetMediaTrackInfo_Value(MediaTrack* tr, const char* parmname, double newvalue)
bool SetMediaTrackInfo_Value(MediaTrack tr, "parmname", newvalue)
boolean reaper.SetMediaTrackInfo_Value(MediaTrack tr, string parmname, number newvalue)
Boolean RPR_SetMediaTrackInfo_Value(MediaTrack tr, String parmname, Float newvalue)

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
B_SOLO_DEFEAT : bool * : when set, if anything else is soloed and this track is not muted, this track acts soloed
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
B_AUTO_RECARM : bool * : automatically set record arm when selected (does not immediately affect recarm state, script should set directly if desired)
I_VUMODE : int * : track vu mode, &1:disabled, &30==0:stereo peaks, &30==2:multichannel peaks, &30==4:stereo RMS, &30==8:combined RMS, &30==12:LUFS-M, &30==16:LUFS-S (readout=max), &30==20:LUFS-S (readout=current), &32:LUFS calculation on channels 1+2 only
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 (read-only)
I_MCPY : int * : current MCP Y-position in pixels relative to mixer container (read-only)
I_MCPW : int * : current MCP width in pixels (read-only)
I_MCPH : int * : current MCP height in pixels (read-only)
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
C_MAINSEND_NCH : char * : channel count of track send to parent (0=use all child track channels, 1=use one channel only)
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

void SetMIDIEditorGrid(ReaProject* project, double division)
SetMIDIEditorGrid(ReaProject project, division)
reaper.SetMIDIEditorGrid(ReaProject project, number division)
RPR_SetMIDIEditorGrid(ReaProject project, Float division)

Set the MIDI editor grid division. 0.25=quarter note, 1.0/3.0=half note tripet, etc.

MediaTrack* SetMixerScroll(MediaTrack* leftmosttrack)
MediaTrack SetMixerScroll(MediaTrack leftmosttrack)
MediaTrack reaper.SetMixerScroll(MediaTrack leftmosttrack)
MediaTrack RPR_SetMixerScroll(MediaTrack leftmosttrack)

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.

void SetMouseModifier(const char* context, int modifier_flag, const char* action)
SetMouseModifier("context", int modifier_flag, "action")
reaper.SetMouseModifier(string context, integer modifier_flag, string action)
RPR_SetMouseModifier(String context, Int modifier_flag, String action)

Set the mouse modifier assignment for a specific modifier key assignment, in a specific context.
Context is a string like "MM_CTX_ITEM". 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.

void SetOnlyTrackSelected(MediaTrack* track)
SetOnlyTrackSelected(MediaTrack track)
reaper.SetOnlyTrackSelected(MediaTrack track)
RPR_SetOnlyTrackSelected(MediaTrack track)

Set exactly one track selected, deselect all others

void SetProjectGrid(ReaProject* project, double division)
SetProjectGrid(ReaProject project, division)
reaper.SetProjectGrid(ReaProject project, number division)
RPR_SetProjectGrid(ReaProject project, Float division)

Set the arrange view grid division. 0.25=quarter note, 1.0/3.0=half note triplet, etc.

bool SetProjectMarker(int markrgnindexnumber, bool isrgn, double pos, double rgnend, const char* name)
bool SetProjectMarker(int markrgnindexnumber, bool isrgn, pos, rgnend, "name")
boolean reaper.SetProjectMarker(integer markrgnindexnumber, boolean isrgn, number pos, number rgnend, string name)
Boolean RPR_SetProjectMarker(Int markrgnindexnumber, Boolean isrgn, Float pos, Float rgnend, String name)
bool SetProjectMarker2(ReaProject* proj, int markrgnindexnumber, bool isrgn, double pos, double rgnend, const char* name)
bool SetProjectMarker2(ReaProject proj, int markrgnindexnumber, bool isrgn, pos, rgnend, "name")
boolean reaper.SetProjectMarker2(ReaProject proj, integer markrgnindexnumber, boolean isrgn, number pos, number rgnend, string name)
Boolean RPR_SetProjectMarker2(ReaProject proj, Int markrgnindexnumber, Boolean isrgn, Float pos, Float rgnend, String name)
bool SetProjectMarker3(ReaProject* proj, int markrgnindexnumber, bool isrgn, double pos, double rgnend, const char* name, int color)
bool SetProjectMarker3(ReaProject proj, int markrgnindexnumber, bool isrgn, pos, rgnend, "name", int color)
boolean reaper.SetProjectMarker3(ReaProject proj, integer markrgnindexnumber, boolean isrgn, number pos, number rgnend, string name, integer color)
Boolean RPR_SetProjectMarker3(ReaProject proj, Int markrgnindexnumber, Boolean isrgn, Float pos, Float rgnend, String name, Int color)
bool SetProjectMarker4(ReaProject* proj, int markrgnindexnumber, bool isrgn, double pos, double rgnend, const char* name, int color, int flags)
bool SetProjectMarker4(ReaProject proj, int markrgnindexnumber, bool isrgn, pos, rgnend, "name", int color, int flags)
boolean reaper.SetProjectMarker4(ReaProject proj, integer markrgnindexnumber, boolean isrgn, number pos, number rgnend, string name, integer color, integer flags)
Boolean RPR_SetProjectMarker4(ReaProject proj, Int markrgnindexnumber, Boolean isrgn, Float pos, Float rgnend, String name, Int color, Int flags)

color should be 0 to not change, or ColorToNative(r,g,b)|0x1000000, flags&1 to clear name

bool SetProjectMarkerByIndex(ReaProject* proj, int markrgnidx, bool isrgn, double pos, double rgnend, int IDnumber, const char* name, int color)
bool SetProjectMarkerByIndex(ReaProject proj, int markrgnidx, bool isrgn, pos, rgnend, int IDnumber, "name", int color)
boolean reaper.SetProjectMarkerByIndex(ReaProject proj, integer markrgnidx, boolean isrgn, number pos, number rgnend, integer IDnumber, string name, integer color)
Boolean RPR_SetProjectMarkerByIndex(ReaProject proj, Int markrgnidx, Boolean isrgn, Float pos, Float rgnend, Int IDnumber, String name, Int color)

See SetProjectMarkerByIndex2.

bool SetProjectMarkerByIndex2(ReaProject* proj, int markrgnidx, bool isrgn, double pos, double rgnend, int IDnumber, const char* name, int color, int flags)
bool SetProjectMarkerByIndex2(ReaProject proj, int markrgnidx, bool isrgn, pos, rgnend, int IDnumber, "name", int color, int flags)
boolean reaper.SetProjectMarkerByIndex2(ReaProject proj, integer markrgnidx, boolean isrgn, number pos, number rgnend, integer IDnumber, string name, integer color, integer flags)
Boolean RPR_SetProjectMarkerByIndex2(ReaProject proj, Int markrgnidx, Boolean isrgn, Float pos, Float rgnend, Int IDnumber, String name, Int color, Int flags)

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.

int SetProjExtState(ReaProject* proj, const char* extname, const char* key, const char* value)
int SetProjExtState(ReaProject proj, "extname", "key", "value")
integer reaper.SetProjExtState(ReaProject proj, string extname, string key, string value)
Int RPR_SetProjExtState(ReaProject proj, String extname, String key, String value)

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.

void SetRegionRenderMatrix(ReaProject* proj, int regionindex, MediaTrack* track, int addorremove)
SetRegionRenderMatrix(ReaProject proj, int regionindex, MediaTrack track, int addorremove)
reaper.SetRegionRenderMatrix(ReaProject proj, integer regionindex, MediaTrack track, integer addorremove)
RPR_SetRegionRenderMatrix(ReaProject proj, Int regionindex, MediaTrack track, Int addorremove)

Add (addorremove > 0) or remove (addorremove < 0) a track from this region when using the region render matrix.

int SetTakeMarker(MediaItem_Take* take, int idx, const char* nameIn, double* srcposInOptional, int* colorInOptional)
int SetTakeMarker(MediaItem_Take take, int idx, "nameIn", optional srcposIn, optional int colorIn)
integer reaper.SetTakeMarker(MediaItem_Take take, integer idx, string nameIn, optional number srcposIn, optional integer colorIn)
(Int retval, MediaItem_Take take, Int idx, String nameIn, Float srcposInOptional, Int colorInOptional) = RPR_SetTakeMarker(take, idx, nameIn, srcposInOptional, colorInOptional)

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). See GetNumTakeMarkers, GetTakeMarker, DeleteTakeMarker

int SetTakeStretchMarker(MediaItem_Take* take, int idx, double pos, const double* srcposInOptional)
int SetTakeStretchMarker(MediaItem_Take take, int idx, pos, optional srcposIn)
integer reaper.SetTakeStretchMarker(MediaItem_Take take, integer idx, number pos, optional number srcposIn)
Int RPR_SetTakeStretchMarker(MediaItem_Take take, Int idx, Float pos, const double srcposInOptional)

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).

bool SetTakeStretchMarkerSlope(MediaItem_Take* take, int idx, double slope)
bool SetTakeStretchMarkerSlope(MediaItem_Take take, int idx, slope)
boolean reaper.SetTakeStretchMarkerSlope(MediaItem_Take take, integer idx, number slope)
Boolean RPR_SetTakeStretchMarkerSlope(MediaItem_Take take, Int idx, Float slope)

See GetTakeStretchMarkerSlope

bool SetTempoTimeSigMarker(ReaProject* proj, int ptidx, double timepos, int measurepos, double beatpos, double bpm, int timesig_num, int timesig_denom, bool lineartempo)
bool SetTempoTimeSigMarker(ReaProject proj, int ptidx, timepos, int measurepos, beatpos, bpm, int timesig_num, int timesig_denom, bool lineartempo)
boolean reaper.SetTempoTimeSigMarker(ReaProject proj, integer ptidx, number timepos, integer measurepos, number beatpos, number bpm, integer timesig_num, integer timesig_denom, boolean lineartempo)
Boolean RPR_SetTempoTimeSigMarker(ReaProject proj, Int ptidx, Float timepos, Int measurepos, Float beatpos, Float bpm, Int timesig_num, Int timesig_denom, Boolean lineartempo)

Set parameters of a tempo/time signature marker. Provide either timepos (with measurepos=-1, beatpos=-1), or measurepos and beatpos (with timepos=-1). If timesig_num and timesig_denom are zero, the previous time signature will be used. ptidx=-1 will insert a new tempo/time signature marker. See CountTempoTimeSigMarkers, GetTempoTimeSigMarker, AddTempoTimeSigMarker.

int SetThemeColor(const char* ini_key, int color, int flagsOptional)
int SetThemeColor("ini_key", int color, int flags)
integer reaper.SetThemeColor(string ini_key, integer color, integer flags)
Int RPR_SetThemeColor(String ini_key, Int color, Int flagsOptional)

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.
Currently valid ini_keys:

  • col_main_bg2 : Main window/transport background -- current RGB: 51,51,51
  • col_main_text2 : Main window/transport text -- current RGB: 170,170,170
  • col_main_textshadow : Main window text shadow (ignored if too close to text color) -- current RGB: 18,26,29
  • col_main_3dhl : Main window 3D highlight -- current RGB: 70,70,70
  • col_main_3dsh : Main window 3D shadow -- current RGB: 45,45,45
  • col_main_resize2 : Main window pane resize mouseover -- current RGB: 51,51,51
  • col_main_text : Window text -- current RGB: 18,18,18
  • col_main_bg : Window background -- current RGB: 123,123,123
  • col_main_editbk : Window edit background -- current RGB: 170,170,170
  • col_transport_editbk : Transport edit background -- current RGB: 51,51,51
  • col_toolbar_text : Toolbar button text -- current RGB: 159,159,159
  • col_toolbar_text_on : Toolbar button enabled text -- current RGB: 191,251,192
  • col_toolbar_frame : Toolbar frame when floating or docked -- current RGB: 71,78,78
  • toolbararmed_color : Toolbar button armed color -- current RGB: 255,128,0
  • toolbararmed_drawmode : Toolbar button armed fill mode -- blendmode 00028001
  • io_text : I/O window text -- current RGB: 69,69,69
  • io_3dhl : I/O window 3D highlight -- current RGB: 131,131,131
  • io_3dsh : I/O window 3D shadow -- current RGB: 204,204,204
  • genlist_bg : Window list background -- current RGB: 170,170,170
  • genlist_fg : Window list text -- current RGB: 18,18,18
  • genlist_grid : Window list grid lines -- current RGB: 132,132,132
  • genlist_selbg : Window list selected row -- current RGB: 87,87,87
  • genlist_selfg : Window list selected text -- current RGB: 255,255,255
  • genlist_seliabg : Window list selected row (inactive) -- current RGB: 240,240,240
  • genlist_seliafg : Window list selected text (inactive) -- current RGB: 0,0,0
  • genlist_hilite : Window list highlighted text -- current RGB: 0,0,224
  • genlist_hilite_sel : Window list highlighted selected text -- current RGB: 192,192,255
  • col_buttonbg : Button background -- current RGB: 0,0,0
  • col_tcp_text : Track panel text -- current RGB: 18,26,29
  • col_tcp_textsel : Track panel (selected) text -- current RGB: 18,26,29
  • col_seltrack : Selected track control panel background -- current RGB: 210,210,210
  • col_seltrack2 : Unselected track control panel background (enabled with a checkbox above) -- current RGB: 197,197,197
  • tcplocked_color : Locked track control panel overlay color -- current RGB: 51,51,51
  • tcplocked_drawmode : Locked track control panel fill mode -- blendmode 0002c000
  • col_tracklistbg : Empty track list area -- current RGB: 51,51,51
  • col_mixerbg : Empty mixer list area -- current RGB: 51,51,51
  • col_arrangebg : Empty arrange view area -- current RGB: 41,41,41
  • arrange_vgrid : Empty arrange view area vertical grid shading -- current RGB: 41,41,41
  • col_fadearm : Fader background when automation recording -- current RGB: 255,125,125
  • col_fadearm2 : Fader background when automation playing -- current RGB: 125,255,125
  • col_fadearm3 : Fader background when in inactive touch/latch -- current RGB: 255,255,98
  • col_tl_fg : Timeline foreground -- current RGB: 105,107,107
  • col_tl_fg2 : Timeline foreground (secondary markings) -- current RGB: 76,77,77
  • col_tl_bg : Timeline background -- current RGB: 48,48,48
  • col_tl_bgsel : Time selection color -- current RGB: 255,255,255
  • timesel_drawmode : Time selection fill mode -- blendmode 00020f01
  • col_tl_bgsel2 : Timeline background (in loop points) -- current RGB: 192,192,192
  • col_trans_bg : Transport status background -- current RGB: 73,73,73
  • col_trans_fg : Transport status text -- current RGB: 137,139,139
  • playrate_edited : Project play rate control when not 1.0 -- current RGB: 127,63,0
  • col_mi_label : Media item label -- current RGB: 170,170,170
  • col_mi_label_sel : Media item label (selected) -- current RGB: 170,170,170
  • col_mi_label_float : Floating media item label -- current RGB: 170,170,170
  • col_mi_label_float_sel : Floating media item label (selected) -- current RGB: 170,170,170
  • col_mi_bg : Media item background (odd tracks) -- current RGB: 125,125,125
  • col_mi_bg2 : Media item background (even tracks) -- current RGB: 125,125,125
  • col_tr1_itembgsel : Media item background selected (odd tracks) -- current RGB: 106,255,163
  • col_tr2_itembgsel : Media item background selected (even tracks) -- current RGB: 106,255,163
  • itembg_drawmode : Media item background fill mode -- blendmode 00028000
  • col_tr1_peaks : Media item peaks (odd tracks) -- current RGB: 21,21,21
  • col_tr2_peaks : Media item peaks (even tracks) -- current RGB: 21,21,21
  • col_tr1_ps2 : Media item peaks when selected (odd tracks) -- current RGB: 21,21,21
  • col_tr2_ps2 : Media item peaks when selected (even tracks) -- current RGB: 21,21,21
  • col_peaksedge : Media item peaks edge highlight (odd tracks) -- current RGB: 51,51,51
  • col_peaksedge2 : Media item peaks edge highlight (even tracks) -- current RGB: 51,51,51
  • col_peaksedgesel : Media item peaks edge highlight when selected (odd tracks) -- current RGB: 51,51,51
  • col_peaksedgesel2 : Media item peaks edge highlight when selected (even tracks) -- current RGB: 51,51,51
  • cc_chase_drawmode : Media item MIDI CC peaks fill mode -- blendmode 00024000
  • col_peaksfade : Media item peaks when active in crossfade editor (fade-out) -- current RGB: 0,255,0
  • col_peaksfade2 : Media item peaks when active in crossfade editor (fade-in) -- current RGB: 255,0,0
  • col_mi_fades : Media item fade/volume controls -- current RGB: 105,16,16
  • fadezone_color : Media item fade quiet zone fill color -- current RGB: 72,0,0
  • fadezone_drawmode : Media item fade quiet zone fill mode -- blendmode 00030004
  • fadearea_color : Media item fade full area fill color -- current RGB: 0,0,96
  • fadearea_drawmode : Media item fade full area fill mode -- blendmode 00020000
  • col_mi_fade2 : Media item edges of controls -- current RGB: 198,198,198
  • col_mi_fade2_drawmode : Media item edges of controls blend mode -- blendmode 00025901
  • item_grouphl : Media item edge when selected via grouping -- current RGB: 51,184,48
  • col_offlinetext : Media item "offline" text -- current RGB: 48,66,71
  • col_stretchmarker : Media item stretch marker line -- current RGB: 84,124,124
  • col_stretchmarker_h0 : Media item stretch marker handle (1x) -- current RGB: 120,135,135
  • col_stretchmarker_h1 : Media item stretch marker handle (>1x) -- current RGB: 40,141,196
  • col_stretchmarker_h2 : Media item stretch marker handle (<1x) -- current RGB: 159,64,64
  • col_stretchmarker_b : Media item stretch marker handle edge -- current RGB: 192,192,192
  • col_stretchmarkerm : Media item stretch marker blend mode -- blendmode 00030000
  • col_stretchmarker_text : Media item stretch marker text -- current RGB: 126,153,154
  • col_stretchmarker_tm : Media item transient guide handle -- current RGB: 0,234,0
  • take_marker : Media item take marker -- current RGB: 255,255,0
  • selitem_tag : Selected media item bar color -- current RGB: 0,0,0
  • activetake_tag : Active media item take bar color -- current RGB: 0,0,0
  • col_tr1_bg : Track background (odd tracks) -- current RGB: 41,41,41
  • col_tr2_bg : Track background (even tracks) -- current RGB: 41,41,41
  • selcol_tr1_bg : Selected track background (odd tracks) -- current RGB: 41,41,41
  • selcol_tr2_bg : Selected track background (even tracks) -- current RGB: 41,41,41
  • col_tr1_divline : Track divider line (odd tracks) -- current RGB: 67,67,67
  • col_tr2_divline : Track divider line (even tracks) -- current RGB: 67,67,67
  • col_envlane1_divline : Envelope lane divider line (odd tracks) -- current RGB: 0,0,0
  • col_envlane2_divline : Envelope lane divider line (even tracks) -- current RGB: 0,0,0
  • marquee_fill : Marquee fill -- current RGB: 128,128,110
  • marquee_drawmode : Marquee fill mode -- blendmode 000299ff
  • marquee_outline : Marquee outline -- current RGB: 255,255,255
  • marqueezoom_fill : Marquee zoom fill -- current RGB: 255,255,255
  • marqueezoom_drawmode : Marquee zoom fill mode -- blendmode 00024002
  • marqueezoom_outline : Marquee zoom outline -- current RGB: 0,255,0
  • areasel_fill : Razor edit area fill -- current RGB: 31,233,192
  • areasel_drawmode : Razor edit area fill mode -- blendmode 00021c01
  • areasel_outline : Razor edit area outline -- current RGB: 0,251,201
  • areasel_outlinemode : Razor edit area outline mode -- blendmode 0002c000
  • col_cursor : Edit cursor -- current RGB: 220,36,36
  • col_cursor2 : Edit cursor (alternate) -- current RGB: 220,36,36
  • playcursor_color : Play cursor -- current RGB: 0,0,0
  • playcursor_drawmode : Play cursor fill mode -- blendmode 00028003
  • col_gridlines2 : Grid lines (start of measure) -- current RGB: 138,69,0
  • col_gridlines2dm : Grid lines (start of measure) - draw mode -- blendmode 0002c001
  • col_gridlines3 : Grid lines (start of beats) -- current RGB: 73,73,73
  • col_gridlines3dm : Grid lines (start of beats) - draw mode -- blendmode 00028001
  • col_gridlines : Grid lines (in between beats) -- current RGB: 50,50,50
  • col_gridlines1dm : Grid lines (in between beats) - draw mode -- blendmode 00028001
  • guideline_color : Editing guide line color -- current RGB: 95,169,167
  • guideline_drawmode : Editing guide fill mode -- blendmode 00024c01
  • region : Regions -- current RGB: 128,138,138
  • region_lane_bg : Region lane background -- current RGB: 51,51,51
  • region_lane_text : Region lane text -- current RGB: 31,39,37
  • marker : Markers -- current RGB: 75,0,0
  • marker_lane_bg : Marker lane background -- current RGB: 73,73,73
  • marker_lane_text : Marker lane text -- current RGB: 165,165,165
  • col_tsigmark : Time signature change marker -- current RGB: 170,170,170
  • ts_lane_bg : Time signature lane background -- current RGB: 51,51,51
  • ts_lane_text : Time signature lane text -- current RGB: 165,165,165
  • timesig_sel_bg : Time signature marker selected background -- current RGB: 70,0,0
  • col_routinghl1 : Routing matrix row highlight -- current RGB: 255,255,192
  • col_routinghl2 : Routing matrix column highlight -- current RGB: 128,128,255
  • col_vudoint : Theme has interlaced VU meters -- bool 00000000
  • col_vuclip : VU meter clip indicator -- current RGB: 255,0,0
  • col_vutop : VU meter top -- current RGB: 255,128,0
  • col_vumid : VU meter middle -- current RGB: 255,255,0
  • col_vubot : VU meter bottom -- current RGB: 0,191,191
  • col_vuintcol : VU meter interlace/edge color -- current RGB: 32,32,32
  • col_vumidi : VU meter midi activity -- current RGB: 255,0,0
  • col_vuind1 : VU (indicator) - no signal -- current RGB: 32,32,32
  • col_vuind2 : VU (indicator) - low signal -- current RGB: 213,0,0
  • col_vuind3 : VU (indicator) - med signal -- current RGB: 255,128,0
  • col_vuind4 : VU (indicator) - hot signal -- current RGB: 255,255,0
  • mcp_sends_normal : Sends text: normal -- current RGB: 163,163,163
  • mcp_sends_muted : Sends text: muted -- current RGB: 152,134,99
  • mcp_send_midihw : Sends text: MIDI hardware -- current RGB: 40,40,40
  • mcp_sends_levels : Sends level -- current RGB: 48,66,71
  • mcp_fx_normal : FX insert text: normal -- current RGB: 201,164,107
  • mcp_fx_bypassed : FX insert text: bypassed -- current RGB: 140,140,140
  • mcp_fx_offlined : FX insert text: offline -- current RGB: 183,68,68
  • mcp_fxparm_normal : FX parameter text: normal -- current RGB: 163,163,163
  • mcp_fxparm_bypassed : FX parameter text: bypassed -- current RGB: 152,134,99
  • mcp_fxparm_offlined : FX parameter text: offline -- current RGB: 152,99,99
  • tcp_list_scrollbar : List scrollbar (track panel) -- current RGB: 50,50,50
  • tcp_list_scrollbar_mode : List scrollbar (track panel) - draw mode -- blendmode 00028000
  • tcp_list_scrollbar_mouseover : List scrollbar mouseover (track panel) -- current RGB: 30,30,30
  • tcp_list_scrollbar_mouseover_mode : List scrollbar mouseover (track panel) - draw mode -- blendmode 00028000
  • mcp_list_scrollbar : List scrollbar (mixer panel) -- current RGB: 140,140,140
  • mcp_list_scrollbar_mode : List scrollbar (mixer panel) - draw mode -- blendmode 00028000
  • mcp_list_scrollbar_mouseover : List scrollbar mouseover (mixer panel) -- current RGB: 64,191,159
  • mcp_list_scrollbar_mouseover_mode : List scrollbar mouseover (mixer panel) - draw mode -- blendmode 00028000
  • midi_rulerbg : MIDI editor ruler background -- current RGB: 51,51,51
  • midi_rulerfg : MIDI editor ruler text -- current RGB: 127,127,127
  • midi_grid2 : MIDI editor grid line (start of measure) -- current RGB: 138,69,0
  • midi_griddm2 : MIDI editor grid line (start of measure) - draw mode -- blendmode 00030000
  • midi_grid3 : MIDI editor grid line (start of beats) -- current RGB: 91,91,91
  • midi_griddm3 : MIDI editor grid line (start of beats) - draw mode -- blendmode 00028000
  • midi_grid1 : MIDI editor grid line (between beats) -- current RGB: 57,57,57
  • midi_griddm1 : MIDI editor grid line (between beats) - draw mode -- blendmode 00030000
  • midi_trackbg1 : MIDI editor background color (naturals) -- current RGB: 48,48,48
  • midi_trackbg2 : MIDI editor background color (sharps/flats) -- current RGB: 41,41,41
  • midi_trackbg_outer1 : MIDI editor background color, out of bounds (naturals) -- current RGB: 31,31,31
  • midi_trackbg_outer2 : MIDI editor background color, out of bounds (sharps/flats) -- current RGB: 24,24,24
  • midi_selpitch1 : MIDI editor background color, selected pitch (naturals) -- current RGB: 87,57,57
  • midi_selpitch2 : MIDI editor background color, selected pitch (sharps/flats) -- current RGB: 75,52,52
  • midi_selbg : MIDI editor time selection color -- current RGB: 255,255,255
  • midi_selbg_drawmode : MIDI editor time selection fill mode -- blendmode 00020c01
  • midi_gridhc : MIDI editor CC horizontal center line -- current RGB: 157,157,157
  • midi_gridhcdm : MIDI editor CC horizontal center line - draw mode -- blendmode 00030000
  • midi_gridh : MIDI editor CC horizontal line -- current RGB: 91,91,91
  • midi_gridhdm : MIDI editor CC horizontal line - draw mode -- blendmode 00028000
  • midi_ccbut : MIDI editor CC lane add/remove buttons -- current RGB: 123,123,123
  • midi_ccbut_text : MIDI editor CC lane button text -- current RGB: 170,170,170
  • midi_ccbut_arrow : MIDI editor CC lane button arrow -- current RGB: 170,170,170
  • midioct : MIDI editor octave line color -- current RGB: 73,73,73
  • midi_inline_trackbg1 : MIDI inline background color (naturals) -- current RGB: 48,48,48
  • midi_inline_trackbg2 : MIDI inline background color (sharps/flats) -- current RGB: 41,41,41
  • midioct_inline : MIDI inline octave line color -- current RGB: 73,73,73
  • midi_endpt : MIDI editor end marker -- current RGB: 58,58,58
  • midi_notebg : MIDI editor note, unselected (midi_note_colormap overrides) -- current RGB: 91,123,108
  • midi_notefg : MIDI editor note, selected (midi_note_colormap overrides) -- current RGB: 49,49,49
  • midi_notemute : MIDI editor note, muted, unselected (midi_note_colormap overrides) -- current RGB: 53,53,53
  • midi_notemute_sel : MIDI editor note, muted, selected (midi_note_colormap overrides) -- current RGB: 24,24,24
  • midi_itemctl : MIDI editor note controls -- current RGB: 53,53,53
  • midi_ofsn : MIDI editor note (offscreen) -- current RGB: 59,59,59
  • midi_ofsnsel : MIDI editor note (offscreen, selected) -- current RGB: 59,59,59
  • midi_editcurs : MIDI editor cursor -- current RGB: 220,36,36
  • midi_pkey1 : MIDI piano key color (naturals background, sharps/flats text) -- current RGB: 255,255,255
  • midi_pkey2 : MIDI piano key color (sharps/flats background, naturals text) -- current RGB: 0,0,0
  • midi_pkey3 : MIDI piano key color (selected) -- current RGB: 93,93,93
  • midi_noteon_flash : MIDI piano key note-on flash -- current RGB: 64,0,0
  • midi_leftbg : MIDI piano pane background -- current RGB: 53,53,53
  • midifont_col_light_unsel : MIDI editor note text and control color, unselected (light) -- current RGB: 224,224,224
  • midifont_col_dark_unsel : MIDI editor note text and control color, unselected (dark) -- current RGB: 32,32,32
  • midifont_mode_unsel : MIDI editor note text and control mode, unselected -- blendmode 0002c000
  • midifont_col_light : MIDI editor note text and control color (light) -- current RGB: 189,189,189
  • midifont_col_dark : MIDI editor note text and control color (dark) -- current RGB: 64,64,64
  • midifont_mode : MIDI editor note text and control mode -- blendmode 00030000
  • score_bg : MIDI notation editor background -- current RGB: 255,255,255
  • score_fg : MIDI notation editor staff/notation/text -- current RGB: 0,0,0
  • score_sel : MIDI notation editor selected staff/notation/text -- current RGB: 0,0,255
  • score_timesel : MIDI notation editor time selection -- current RGB: 255,255,224
  • score_loop : MIDI notation editor loop points, selected pitch -- current RGB: 255,192,0
  • midieditorlist_bg : MIDI list editor background -- current RGB: 53,53,53
  • midieditorlist_fg : MIDI list editor text -- current RGB: 170,170,170
  • midieditorlist_grid : MIDI list editor grid lines -- current RGB: 53,53,53
  • midieditorlist_selbg : MIDI list editor selected row -- current RGB: 51,153,255
  • midieditorlist_selfg : MIDI list editor selected text -- current RGB: 255,255,255
  • midieditorlist_seliabg : MIDI list editor selected row (inactive) -- current RGB: 240,240,240
  • midieditorlist_seliafg : MIDI list editor selected text (inactive) -- current RGB: 0,0,0
  • midieditorlist_bg2 : MIDI list editor background (secondary) -- current RGB: 53,53,53
  • midieditorlist_fg2 : MIDI list editor text (secondary) -- current RGB: 0,0,0
  • midieditorlist_selbg2 : MIDI list editor selected row (secondary) -- current RGB: 35,135,240
  • midieditorlist_selfg2 : MIDI list editor selected text (secondary) -- current RGB: 255,255,255
  • col_explorer_sel : Media explorer selection -- current RGB: 255,255,255
  • col_explorer_seldm : Media explorer selection mode -- blendmode 00021501
  • col_explorer_seledge : Media explorer selection edge -- current RGB: 255,255,255
  • docker_shadow : Tab control shadow -- current RGB: 18,26,29
  • docker_selface : Tab control selected tab -- current RGB: 74,74,74
  • docker_unselface : Tab control unselected tab -- current RGB: 51,51,51
  • docker_text : Tab control text -- current RGB: 51,51,51
  • docker_text_sel : Tab control text selected tab -- current RGB: 51,51,51
  • docker_bg : Tab control background -- current RGB: 66,66,66
  • windowtab_bg : Tab control background in windows -- current RGB: 120,120,120
  • auto_item_unsel : Envelope: Unselected automation item -- current RGB: 96,96,96
  • col_env1 : Envelope: Volume (pre-FX) -- current RGB: 0,220,128
  • col_env2 : Envelope: Volume -- current RGB: 0,213,27
  • env_trim_vol : Envelope: Trim Volume -- current RGB: 213,0,106
  • col_env3 : Envelope: Pan (pre-FX) -- current RGB: 255,0,0
  • col_env4 : Envelope: Pan -- current RGB: 255,150,0
  • env_track_mute : Envelope: Mute -- current RGB: 213,0,159
  • col_env5 : Envelope: Master playrate -- current RGB: 213,0,106
  • col_env6 : Envelope: Master tempo -- current RGB: 0,255,255
  • col_env7 : Envelope: Send volume -- current RGB: 213,0,0
  • col_env8 : Envelope: Send pan -- current RGB: 0,128,128
  • col_env9 : Envelope: Send volume 2 -- current RGB: 128,0,0
  • col_env10 : Envelope: Send pan 2 -- current RGB: 0,128,128
  • env_sends_mute : Envelope: Send mute -- current RGB: 192,192,0
  • col_env11 : Envelope: Audio hardware output volume -- current RGB: 0,255,255
  • col_env12 : Envelope: Audio hardware output pan -- current RGB: 255,255,0
  • col_env13 : Envelope: FX parameter 1 -- current RGB: 128,0,255
  • col_env14 : Envelope: FX parameter 2 -- current RGB: 64,128,128
  • col_env15 : Envelope: FX parameter 3 -- current RGB: 0,0,255
  • col_env16 : Envelope: FX parameter 4 -- current RGB: 255,0,128
  • env_item_vol : Envelope: Item take volume -- current RGB: 128,0,0
  • env_item_pan : Envelope: Item take pan -- current RGB: 0,128,128
  • env_item_mute : Envelope: Item take mute -- current RGB: 192,192,0
  • env_item_pitch : Envelope: Item take pitch -- current RGB: 0,255,255
  • wiring_grid2 : Wiring: Background -- current RGB: 46,46,46
  • wiring_grid : Wiring: Background grid lines -- current RGB: 51,51,51
  • wiring_border : Wiring: Box border -- current RGB: 153,153,153
  • wiring_tbg : Wiring: Box background -- current RGB: 38,38,38
  • wiring_ticon : Wiring: Box foreground -- current RGB: 204,204,204
  • wiring_recbg : Wiring: Record section background -- current RGB: 101,77,77
  • wiring_recitem : Wiring: Record section foreground -- current RGB: 63,33,33
  • wiring_media : Wiring: Media -- current RGB: 32,64,32
  • wiring_recv : Wiring: Receives -- current RGB: 92,92,92
  • wiring_send : Wiring: Sends -- current RGB: 92,92,92
  • wiring_fader : Wiring: Fader -- current RGB: 128,128,192
  • wiring_parent : Wiring: Master/Parent -- current RGB: 64,128,128
  • wiring_parentwire_border : Wiring: Master/Parent wire border -- current RGB: 100,100,100
  • wiring_parentwire_master : Wiring: Master/Parent to master wire -- current RGB: 192,192,192
  • wiring_parentwire_folder : Wiring: Master/Parent to parent folder wire -- current RGB: 128,128,128
  • wiring_pin_normal : Wiring: Pins normal -- current RGB: 192,192,192
  • wiring_pin_connected : Wiring: Pins connected -- current RGB: 96,144,96
  • wiring_pin_disconnected : Wiring: Pins disconnected -- current RGB: 64,32,32
  • wiring_horz_col : Wiring: Horizontal pin connections -- current RGB: 72,72,72
  • wiring_sendwire : Wiring: Send hanging wire -- current RGB: 128,128,128
  • wiring_hwoutwire : Wiring: Hardware output wire -- current RGB: 128,128,128
  • wiring_recinputwire : Wiring: Record input wire -- current RGB: 255,128,128
  • wiring_hwout : Wiring: System hardware outputs -- current RGB: 64,64,64
  • wiring_recinput : Wiring: System record inputs -- current RGB: 128,64,64
  • group_0 : Group #1 -- current RGB: 255,0,0
  • group_1 : Group #2 -- current RGB: 0,255,0
  • group_2 : Group #3 -- current RGB: 0,0,255
  • group_3 : Group #4 -- current RGB: 255,255,0
  • group_4 : Group #5 -- current RGB: 255,0,255
  • group_5 : Group #6 -- current RGB: 0,255,255
  • group_6 : Group #7 -- current RGB: 192,0,0
  • group_7 : Group #8 -- current RGB: 0,192,0
  • group_8 : Group #9 -- current RGB: 0,0,192
  • group_9 : Group #10 -- current RGB: 192,192,0
  • group_10 : Group #11 -- current RGB: 192,0,192
  • group_11 : Group #12 -- current RGB: 0,192,192
  • group_12 : Group #13 -- current RGB: 128,0,0
  • group_13 : Group #14 -- current RGB: 0,128,0
  • group_14 : Group #15 -- current RGB: 0,0,128
  • group_15 : Group #16 -- current RGB: 128,128,0
  • group_16 : Group #17 -- current RGB: 128,0,128
  • group_17 : Group #18 -- current RGB: 0,128,128
  • group_18 : Group #19 -- current RGB: 192,128,0
  • group_19 : Group #20 -- current RGB: 0,192,128
  • group_20 : Group #21 -- current RGB: 0,128,192
  • group_21 : Group #22 -- current RGB: 192,128,0
  • group_22 : Group #23 -- current RGB: 128,0,192
  • group_23 : Group #24 -- current RGB: 128,192,0
  • group_24 : Group #25 -- current RGB: 64,0,0
  • group_25 : Group #26 -- current RGB: 0,64,0
  • group_26 : Group #27 -- current RGB: 0,0,64
  • group_27 : Group #28 -- current RGB: 64,64,0
  • group_28 : Group #29 -- current RGB: 64,0,64
  • group_29 : Group #30 -- current RGB: 0,64,64
  • group_30 : Group #31 -- current RGB: 64,0,64
  • group_31 : Group #32 -- current RGB: 0,64,64
  • group_32 : Group #33 -- current RGB: 128,255,255
  • group_33 : Group #34 -- current RGB: 128,0,128
  • group_34 : Group #35 -- current RGB: 1,255,128
  • group_35 : Group #36 -- current RGB: 128,0,255
  • group_36 : Group #37 -- current RGB: 1,255,255
  • group_37 : Group #38 -- current RGB: 1,0,128
  • group_38 : Group #39 -- current RGB: 128,255,224
  • group_39 : Group #40 -- current RGB: 128,63,128
  • group_40 : Group #41 -- current RGB: 32,255,128
  • group_41 : Group #42 -- current RGB: 128,63,224
  • group_42 : Group #43 -- current RGB: 32,255,224
  • group_43 : Group #44 -- current RGB: 32,63,128
  • group_44 : Group #45 -- current RGB: 128,255,192
  • group_45 : Group #46 -- current RGB: 128,127,128
  • group_46 : Group #47 -- current RGB: 64,255,128
  • group_47 : Group #48 -- current RGB: 128,127,192
  • group_48 : Group #49 -- current RGB: 64,255,192
  • group_49 : Group #50 -- current RGB: 64,127,128
  • group_50 : Group #51 -- current RGB: 128,127,224
  • group_51 : Group #52 -- current RGB: 64,63,128
  • group_52 : Group #53 -- current RGB: 32,127,128
  • group_53 : Group #54 -- current RGB: 128,127,224
  • group_54 : Group #55 -- current RGB: 32,255,192
  • group_55 : Group #56 -- current RGB: 128,63,192
  • group_56 : Group #57 -- current RGB: 128,255,160
  • group_57 : Group #58 -- current RGB: 128,191,128
  • group_58 : Group #59 -- current RGB: 96,255,128
  • group_59 : Group #60 -- current RGB: 128,191,160
  • group_60 : Group #61 -- current RGB: 96,255,160
  • group_61 : Group #62 -- current RGB: 96,191,128
  • group_62 : Group #63 -- current RGB: 96,255,160
  • group_63 : Group #64 -- current RGB: 96,191,128
bool SetToggleCommandState(int section_id, int command_id, int state)
bool SetToggleCommandState(int section_id, int command_id, int state)
boolean reaper.SetToggleCommandState(integer section_id, integer command_id, integer state)
Boolean RPR_SetToggleCommandState(Int section_id, Int command_id, Int state)

Updates the toggle state of an action, returns true if succeeded. Only ReaScripts can have their toggle states changed programmatically. See RefreshToolbar2.

void SetTrackAutomationMode(MediaTrack* tr, int mode)
SetTrackAutomationMode(MediaTrack tr, int mode)
reaper.SetTrackAutomationMode(MediaTrack tr, integer mode)
RPR_SetTrackAutomationMode(MediaTrack tr, Int mode)
void SetTrackColor(MediaTrack* track, int color)
SetTrackColor(MediaTrack track, int color)
reaper.SetTrackColor(MediaTrack track, integer color)
RPR_SetTrackColor(MediaTrack track, Int color)

Set the custom track color, color is OS dependent (i.e. ColorToNative(r,g,b).

bool SetTrackMIDILyrics(MediaTrack* track, int flag, const char* str)
bool SetTrackMIDILyrics(MediaTrack track, int flag, "str")
boolean reaper.SetTrackMIDILyrics(MediaTrack track, integer flag, string str)
Boolean RPR_SetTrackMIDILyrics(MediaTrack track, Int flag, String str)

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

bool SetTrackMIDINoteName(int track, int pitch, int chan, const char* name)
bool SetTrackMIDINoteName(int track, int pitch, int chan, "name")
boolean reaper.SetTrackMIDINoteName(integer track, integer pitch, integer chan, string name)
Boolean RPR_SetTrackMIDINoteName(Int track, Int pitch, Int chan, String name)

channel < 0 assigns these note names to all channels.

bool SetTrackMIDINoteNameEx(ReaProject* proj, MediaTrack* track, int pitch, int chan, const char* name)
bool SetTrackMIDINoteNameEx(ReaProject proj, MediaTrack track, int pitch, int chan, "name")
boolean reaper.SetTrackMIDINoteNameEx(ReaProject proj, MediaTrack track, integer pitch, integer chan, string name)
Boolean RPR_SetTrackMIDINoteNameEx(ReaProject proj, MediaTrack track, Int pitch, Int chan, String name)

channel < 0 assigns note name to all channels. pitch 128 assigns name for CC0, pitch 129 for CC1, etc.

void SetTrackSelected(MediaTrack* track, bool selected)
SetTrackSelected(MediaTrack track, bool selected)
reaper.SetTrackSelected(MediaTrack track, boolean selected)
RPR_SetTrackSelected(MediaTrack track, Boolean selected)
bool SetTrackSendInfo_Value(MediaTrack* tr, int category, int sendidx, const char* parmname, double newvalue)
bool SetTrackSendInfo_Value(MediaTrack tr, int category, int sendidx, "parmname", newvalue)
boolean reaper.SetTrackSendInfo_Value(MediaTrack tr, integer category, integer sendidx, string parmname, number newvalue)
Boolean RPR_SetTrackSendInfo_Value(MediaTrack tr, Int category, Int sendidx, String parmname, Float newvalue)

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=chan
See CreateTrackSend, RemoveTrackSend, GetTrackNumSends.

bool SetTrackSendUIPan(MediaTrack* track, int send_idx, double pan, int isend)
bool SetTrackSendUIPan(MediaTrack track, int send_idx, pan, int isend)
boolean reaper.SetTrackSendUIPan(MediaTrack track, integer send_idx, number pan, integer isend)
Boolean RPR_SetTrackSendUIPan(MediaTrack track, Int send_idx, Float pan, Int isend)

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.

bool SetTrackSendUIVol(MediaTrack* track, int send_idx, double vol, int isend)
bool SetTrackSendUIVol(MediaTrack track, int send_idx, vol, int isend)
boolean reaper.SetTrackSendUIVol(MediaTrack track, integer send_idx, number vol, integer isend)
Boolean RPR_SetTrackSendUIVol(MediaTrack track, Int send_idx, Float vol, Int isend)

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.

bool SetTrackStateChunk(MediaTrack* track, const char* str, bool isundoOptional)
bool SetTrackStateChunk(MediaTrack track, "str", bool isundo)
boolean reaper.SetTrackStateChunk(MediaTrack track, string str, boolean isundo)
Boolean RPR_SetTrackStateChunk(MediaTrack track, String str, Boolean isundoOptional)

Sets the RPPXML state of a track, returns true if successful. Undo flag is a performance/caching hint.

void ShowActionList(KbdSectionInfo* caller, HWND callerWnd)
ShowActionList(KbdSectionInfo caller, HWND callerWnd)
reaper.ShowActionList(KbdSectionInfo caller, HWND callerWnd)
RPR_ShowActionList(KbdSectionInfo caller, HWND callerWnd)
void ShowConsoleMsg(const char* msg)
ShowConsoleMsg("msg")
reaper.ShowConsoleMsg(string msg)
RPR_ShowConsoleMsg(String msg)

Show a message to the user (also useful for debugging). Send "\n" for newline, "" to clear the console. See ClearConsole

int ShowMessageBox(const char* msg, const char* title, int type)
int ShowMessageBox("msg", "title", int type)
integer reaper.ShowMessageBox(string msg, string title, integer type)
Int RPR_ShowMessageBox(String msg, String title, Int type)

type 0=OK,1=OKCANCEL,2=ABORTRETRYIGNORE,3=YESNOCANCEL,4=YESNO,5=RETRYCANCEL : ret 1=OK,2=CANCEL,3=ABORT,4=RETRY,5=IGNORE,6=YES,7=NO

void ShowPopupMenu(const char* name, int x, int y, HWND hwndParentOptional, void* ctxOptional, int ctx2Optional, int ctx3Optional)
ShowPopupMenu("name", int x, int y, HWND hwndParent, void* ctx, int ctx2, int ctx3)
reaper.ShowPopupMenu(string name, integer x, integer y, HWND hwndParent, identifier ctx, integer ctx2, integer ctx3)
RPR_ShowPopupMenu(String name, Int x, Int y, HWND hwndParentOptional, void ctxOptional, Int ctx2Optional, Int ctx3Optional)

shows a context menu, valid names include: track_input, track_panel, track_area, track_routing, item, ruler, envelope, envelope_point, envelope_item. ctxOptional can be a track pointer for track_*, item pointer for item* (but is optional). for envelope_point, ctx2Optional has point index, ctx3Optional has item index (0=main envelope, 1=first AI). for envelope_item, ctx2Optional has AI index (1=first AI)

double SLIDER2DB(double y)
double SLIDER2DB(y)
number reaper.SLIDER2DB(number y)
Float RPR_SLIDER2DB(Float y)
double SnapToGrid(ReaProject* project, double time_pos)
double SnapToGrid(ReaProject project, time_pos)
number reaper.SnapToGrid(ReaProject project, number time_pos)
Float RPR_SnapToGrid(ReaProject project, Float time_pos)
void SoloAllTracks(int solo)
SoloAllTracks(int solo)
reaper.SoloAllTracks(integer solo)
RPR_SoloAllTracks(Int solo)

solo=2 for SIP

HWND Splash_GetWnd()
HWND Splash_GetWnd()
HWND reaper.Splash_GetWnd()
HWND RPR_Splash_GetWnd()

gets the splash window, in case you want to display a message over it. Returns NULL when the splash window is not displayed.

MediaItem* SplitMediaItem(MediaItem* item, double position)
MediaItem SplitMediaItem(MediaItem item, position)
MediaItem reaper.SplitMediaItem(MediaItem item, number position)
MediaItem RPR_SplitMediaItem(MediaItem item, Float position)

the original item becomes the left-hand split, the function returns the right-hand split (or NULL if the split failed)

void stringToGuid(const char* str, GUID* g)
stringToGuid("str", #gGUID)
string gGUID = reaper.stringToGuid(string str, string gGUID)
RPR_stringToGuid(String str, GUID g)
void StuffMIDIMessage(int mode, int msg1, int msg2, int msg3)
StuffMIDIMessage(int mode, int msg1, int msg2, int msg3)
reaper.StuffMIDIMessage(integer mode, integer msg1, integer msg2, integer msg3)
RPR_StuffMIDIMessage(Int mode, Int msg1, Int msg2, Int msg3)

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.

int TakeFX_AddByName(MediaItem_Take* take, const char* fxname, int instantiate)
int TakeFX_AddByName(MediaItem_Take take, "fxname", int instantiate)
integer reaper.TakeFX_AddByName(MediaItem_Take take, string fxname, integer instantiate)
Int RPR_TakeFX_AddByName(MediaItem_Take take, String fxname, Int instantiate)

Adds or queries the position of a named FX in a take. See TrackFX_AddByName() for information on fxname and instantiate.

void TakeFX_CopyToTake(MediaItem_Take* src_take, int src_fx, MediaItem_Take* dest_take, int dest_fx, bool is_move)
TakeFX_CopyToTake(MediaItem_Take src_take, int src_fx, MediaItem_Take dest_take, int dest_fx, bool is_move)
reaper.TakeFX_CopyToTake(MediaItem_Take src_take, integer src_fx, MediaItem_Take dest_take, integer dest_fx, boolean is_move)
RPR_TakeFX_CopyToTake(MediaItem_Take src_take, Int src_fx, MediaItem_Take dest_take, Int dest_fx, Boolean is_move)

Copies (or moves) FX from src_take to dest_take. Can be used with src_take=dest_take to reorder.

void TakeFX_CopyToTrack(MediaItem_Take* src_take, int src_fx, MediaTrack* dest_track, int dest_fx, bool is_move)
TakeFX_CopyToTrack(MediaItem_Take src_take, int src_fx, MediaTrack dest_track, int dest_fx, bool is_move)
reaper.TakeFX_CopyToTrack(MediaItem_Take src_take, integer src_fx, MediaTrack dest_track, integer dest_fx, boolean is_move)
RPR_TakeFX_CopyToTrack(MediaItem_Take src_take, Int src_fx, MediaTrack dest_track, Int dest_fx, Boolean is_move)

Copies (or moves) FX from src_take to dest_track. dest_fx can have 0x1000000 set to reference input FX.

bool TakeFX_Delete(MediaItem_Take* take, int fx)
bool TakeFX_Delete(MediaItem_Take take, int fx)
boolean reaper.TakeFX_Delete(MediaItem_Take take, integer fx)
Boolean RPR_TakeFX_Delete(MediaItem_Take take, Int fx)

Remove a FX from take chain (returns true on success)

bool TakeFX_EndParamEdit(MediaItem_Take* take, int fx, int param)
bool TakeFX_EndParamEdit(MediaItem_Take take, int fx, int param)
boolean reaper.TakeFX_EndParamEdit(MediaItem_Take take, integer fx, integer param)
Boolean RPR_TakeFX_EndParamEdit(MediaItem_Take take, Int fx, Int param)
bool TakeFX_FormatParamValue(MediaItem_Take* take, int fx, int param, double val, char* bufOut, int bufOut_sz)
bool TakeFX_FormatParamValue(MediaItem_Take take, int fx, int param, val, #buf)
boolean retval, string buf = reaper.TakeFX_FormatParamValue(MediaItem_Take take, integer fx, integer param, number val)
(Boolean retval, MediaItem_Take take, Int fx, Int param, Float val, String bufOut, Int bufOut_sz) = RPR_TakeFX_FormatParamValue(take, fx, param, val, bufOut, bufOut_sz)

Note: only works with FX that support Cockos VST extensions.

bool TakeFX_FormatParamValueNormalized(MediaItem_Take* take, int fx, int param, double value, char* buf, int buf_sz)
bool TakeFX_FormatParamValueNormalized(MediaItem_Take take, int fx, int param, value, #buf)
boolean retval, string buf = reaper.TakeFX_FormatParamValueNormalized(MediaItem_Take take, integer fx, integer param, number value, string buf)
(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)

Note: only works with FX that support Cockos VST extensions.

int TakeFX_GetChainVisible(MediaItem_Take* take)
int TakeFX_GetChainVisible(MediaItem_Take take)
integer reaper.TakeFX_GetChainVisible(MediaItem_Take take)
Int RPR_TakeFX_GetChainVisible(MediaItem_Take take)

returns index of effect visible in chain, or -1 for chain hidden, or -2 for chain visible but no effect selected

int TakeFX_GetCount(MediaItem_Take* take)
int TakeFX_GetCount(MediaItem_Take take)
integer reaper.TakeFX_GetCount(MediaItem_Take take)
Int RPR_TakeFX_GetCount(MediaItem_Take take)
bool TakeFX_GetEnabled(MediaItem_Take* take, int fx)
bool TakeFX_GetEnabled(MediaItem_Take take, int fx)
boolean reaper.TakeFX_GetEnabled(MediaItem_Take take, integer fx)
Boolean RPR_TakeFX_GetEnabled(MediaItem_Take take, Int fx)

See TakeFX_SetEnabled

TrackEnvelope* TakeFX_GetEnvelope(MediaItem_Take* take, int fxindex, int parameterindex, bool create)
TrackEnvelope TakeFX_GetEnvelope(MediaItem_Take take, int fxindex, int parameterindex, bool create)
TrackEnvelope reaper.TakeFX_GetEnvelope(MediaItem_Take take, integer fxindex, integer parameterindex, boolean create)
TrackEnvelope RPR_TakeFX_GetEnvelope(MediaItem_Take take, Int fxindex, Int parameterindex, Boolean create)

Returns the FX parameter envelope. If the envelope does not exist and create=true, the envelope will be created.

HWND TakeFX_GetFloatingWindow(MediaItem_Take* take, int index)
HWND TakeFX_GetFloatingWindow(MediaItem_Take take, int index)
HWND reaper.TakeFX_GetFloatingWindow(MediaItem_Take take, integer index)
HWND RPR_TakeFX_GetFloatingWindow(MediaItem_Take take, Int index)

returns HWND of floating window for effect index, if any

bool TakeFX_GetFormattedParamValue(MediaItem_Take* take, int fx, int param, char* bufOut, int bufOut_sz)
bool TakeFX_GetFormattedParamValue(MediaItem_Take take, int fx, int param, #buf)
boolean retval, string buf = reaper.TakeFX_GetFormattedParamValue(MediaItem_Take take, integer fx, integer param)
(Boolean retval, MediaItem_Take take, Int fx, Int param, String bufOut, Int bufOut_sz) = RPR_TakeFX_GetFormattedParamValue(take, fx, param, bufOut, bufOut_sz)
GUID* TakeFX_GetFXGUID(MediaItem_Take* take, int fx)
bool TakeFX_GetFXGUID(#retguid, MediaItem_Take take, int fx)
string GUID = reaper.TakeFX_GetFXGUID(MediaItem_Take take, integer fx)
GUID RPR_TakeFX_GetFXGUID(MediaItem_Take take, Int fx)
bool TakeFX_GetFXName(MediaItem_Take* take, int fx, char* bufOut, int bufOut_sz)
bool TakeFX_GetFXName(MediaItem_Take take, int fx, #buf)
boolean retval, string buf = reaper.TakeFX_GetFXName(MediaItem_Take take, integer fx)
(Boolean retval, MediaItem_Take take, Int fx, String bufOut, Int bufOut_sz) = RPR_TakeFX_GetFXName(take, fx, bufOut, bufOut_sz)
int TakeFX_GetIOSize(MediaItem_Take* take, int fx, int* inputPinsOutOptional, int* outputPinsOutOptional)
int TakeFX_GetIOSize(MediaItem_Take take, int fx, optional int &inputPins, optional int &outputPins)
integer retval, optional integer inputPins, optional integer outputPins = reaper.TakeFX_GetIOSize(MediaItem_Take take, integer fx)
(Int retval, MediaItem_Take take, Int fx, Int inputPinsOutOptional, Int outputPinsOutOptional) = RPR_TakeFX_GetIOSize(take, fx, inputPinsOutOptional, outputPinsOutOptional)

Gets the number of input/output pins for FX if available, returns plug-in type or -1 on error

bool TakeFX_GetNamedConfigParm(MediaItem_Take* take, int fx, const char* parmname, char* bufOut, int bufOut_sz)
bool TakeFX_GetNamedConfigParm(MediaItem_Take take, int fx, "parmname", #buf)
boolean retval, string buf = reaper.TakeFX_GetNamedConfigParm(MediaItem_Take take, integer fx, string parmname)
(Boolean retval, MediaItem_Take take, Int fx, String parmname, String bufOut, Int bufOut_sz) = RPR_TakeFX_GetNamedConfigParm(take, fx, parmname, bufOut, bufOut_sz)

gets plug-in specific named configuration value (returns true on success). see TrackFX_GetNamedConfigParm

int TakeFX_GetNumParams(MediaItem_Take* take, int fx)
int TakeFX_GetNumParams(MediaItem_Take take, int fx)
integer reaper.TakeFX_GetNumParams(MediaItem_Take take, integer fx)
Int RPR_TakeFX_GetNumParams(MediaItem_Take take, Int fx)
bool TakeFX_GetOffline(MediaItem_Take* take, int fx)
bool TakeFX_GetOffline(MediaItem_Take take, int fx)
boolean reaper.TakeFX_GetOffline(MediaItem_Take take, integer fx)
Boolean RPR_TakeFX_GetOffline(MediaItem_Take take, Int fx)

See TakeFX_SetOffline

bool TakeFX_GetOpen(MediaItem_Take* take, int fx)
bool TakeFX_GetOpen(MediaItem_Take take, int fx)
boolean reaper.TakeFX_GetOpen(MediaItem_Take take, integer fx)
Boolean RPR_TakeFX_GetOpen(MediaItem_Take take, Int fx)

Returns true if this FX UI is open in the FX chain window or a floating window. See TakeFX_SetOpen

double TakeFX_GetParam(MediaItem_Take* take, int fx, int param, double* minvalOut, double* maxvalOut)
double TakeFX_GetParam(MediaItem_Take take, int fx, int param, &minval, &maxval)
number retval, number minval, number maxval = reaper.TakeFX_GetParam(MediaItem_Take take, integer fx, integer param)
(Float retval, MediaItem_Take take, Int fx, Int param, Float minvalOut, Float maxvalOut) = RPR_TakeFX_GetParam(take, fx, param, minvalOut, maxvalOut)
bool TakeFX_GetParameterStepSizes(MediaItem_Take* take, int fx, int param, double* stepOut, double* smallstepOut, double* largestepOut, bool* istoggleOut)
bool TakeFX_GetParameterStepSizes(MediaItem_Take take, int fx, int param, &step, &smallstep, &largestep, bool &istoggle)
boolean retval, number step, number smallstep, number largestep, boolean istoggle = reaper.TakeFX_GetParameterStepSizes(MediaItem_Take take, integer fx, integer param)
(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)
double TakeFX_GetParamEx(MediaItem_Take* take, int fx, int param, double* minvalOut, double* maxvalOut, double* midvalOut)
double TakeFX_GetParamEx(MediaItem_Take take, int fx, int param, &minval, &maxval, &midval)
number retval, number minval, number maxval, number midval = reaper.TakeFX_GetParamEx(MediaItem_Take take, integer fx, integer param)
(Float retval, MediaItem_Take take, Int fx, Int param, Float minvalOut, Float maxvalOut, Float midvalOut) = RPR_TakeFX_GetParamEx(take, fx, param, minvalOut, maxvalOut, midvalOut)
int TakeFX_GetParamFromIdent(MediaItem_Take* take, int fx, const char* ident_str)
int TakeFX_GetParamFromIdent(MediaItem_Take take, int fx, "ident_str")
integer reaper.TakeFX_GetParamFromIdent(MediaItem_Take take, integer fx, string ident_str)
Int RPR_TakeFX_GetParamFromIdent(MediaItem_Take take, Int fx, String ident_str)

gets the parameter index from an identifying string (:wet, :bypass, or a string returned from GetParamIdent), or -1 if unknown.

bool TakeFX_GetParamIdent(MediaItem_Take* take, int fx, int param, char* bufOut, int bufOut_sz)
bool TakeFX_GetParamIdent(MediaItem_Take take, int fx, int param, #buf)
boolean retval, string buf = reaper.TakeFX_GetParamIdent(MediaItem_Take take, integer fx, integer param)
(Boolean retval, MediaItem_Take take, Int fx, Int param, String bufOut, Int bufOut_sz) = RPR_TakeFX_GetParamIdent(take, fx, param, bufOut, bufOut_sz)

gets an identifying string for the parameter

bool TakeFX_GetParamName(MediaItem_Take* take, int fx, int param, char* bufOut, int bufOut_sz)
bool TakeFX_GetParamName(MediaItem_Take take, int fx, int param, #buf)
boolean retval, string buf = reaper.TakeFX_GetParamName(MediaItem_Take take, integer fx, integer param)
(Boolean retval, MediaItem_Take take, Int fx, Int param, String bufOut, Int bufOut_sz) = RPR_TakeFX_GetParamName(take, fx, param, bufOut, bufOut_sz)
double TakeFX_GetParamNormalized(MediaItem_Take* take, int fx, int param)
double TakeFX_GetParamNormalized(MediaItem_Take take, int fx, int param)
number reaper.TakeFX_GetParamNormalized(MediaItem_Take take, integer fx, integer param)
Float RPR_TakeFX_GetParamNormalized(MediaItem_Take take, Int fx, Int param)
int TakeFX_GetPinMappings(MediaItem_Take* take, int fx, int isoutput, int pin, int* high32OutOptional)
int TakeFX_GetPinMappings(MediaItem_Take take, int fx, int isoutput, int pin, optional int &high32)
integer retval, optional integer high32 = reaper.TakeFX_GetPinMappings(MediaItem_Take take, integer fx, integer isoutput, integer pin)
(Int retval, MediaItem_Take take, Int fx, Int isoutput, Int pin, Int high32OutOptional) = RPR_TakeFX_GetPinMappings(take, fx, isoutput, pin, high32OutOptional)

gets the effective channel mapping bitmask for a particular pin. high32OutOptional will be set to the high 32 bits

bool TakeFX_GetPreset(MediaItem_Take* take, int fx, char* presetnameOut, int presetnameOut_sz)
bool TakeFX_GetPreset(MediaItem_Take take, int fx, #presetname)
boolean retval, string presetname = reaper.TakeFX_GetPreset(MediaItem_Take take, integer fx)
(Boolean retval, MediaItem_Take take, Int fx, String presetnameOut, Int presetnameOut_sz) = RPR_TakeFX_GetPreset(take, fx, presetnameOut, presetnameOut_sz)

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.

int TakeFX_GetPresetIndex(MediaItem_Take* take, int fx, int* numberOfPresetsOut)
int TakeFX_GetPresetIndex(MediaItem_Take take, int fx, int &numberOfPresets)
integer retval, integer numberOfPresets = reaper.TakeFX_GetPresetIndex(MediaItem_Take take, integer fx)
(Int retval, MediaItem_Take take, Int fx, Int numberOfPresetsOut) = RPR_TakeFX_GetPresetIndex(take, fx, numberOfPresetsOut)

Returns current preset index, or -1 if error. numberOfPresetsOut will be set to total number of presets available. See TakeFX_SetPresetByIndex

void TakeFX_GetUserPresetFilename(MediaItem_Take* take, int fx, char* fnOut, int fnOut_sz)
TakeFX_GetUserPresetFilename(MediaItem_Take take, int fx, #fn)
string fn = reaper.TakeFX_GetUserPresetFilename(MediaItem_Take take, integer fx)
(MediaItem_Take take, Int fx, String fnOut, Int fnOut_sz) = RPR_TakeFX_GetUserPresetFilename(take, fx, fnOut, fnOut_sz)
bool TakeFX_NavigatePresets(MediaItem_Take* take, int fx, int presetmove)
bool TakeFX_NavigatePresets(MediaItem_Take take, int fx, int presetmove)
boolean reaper.TakeFX_NavigatePresets(MediaItem_Take take, integer fx, integer presetmove)
Boolean RPR_TakeFX_NavigatePresets(MediaItem_Take take, Int fx, Int presetmove)

presetmove==1 activates the next preset, presetmove==-1 activates the previous preset, etc.

void TakeFX_SetEnabled(MediaItem_Take* take, int fx, bool enabled)
TakeFX_SetEnabled(MediaItem_Take take, int fx, bool enabled)
reaper.TakeFX_SetEnabled(MediaItem_Take take, integer fx, boolean enabled)
RPR_TakeFX_SetEnabled(MediaItem_Take take, Int fx, Boolean enabled)

See TakeFX_GetEnabled

bool TakeFX_SetNamedConfigParm(MediaItem_Take* take, int fx, const char* parmname, const char* value)
bool TakeFX_SetNamedConfigParm(MediaItem_Take take, int fx, "parmname", "value")
boolean reaper.TakeFX_SetNamedConfigParm(MediaItem_Take take, integer fx, string parmname, string value)
Boolean RPR_TakeFX_SetNamedConfigParm(MediaItem_Take take, Int fx, String parmname, String value)

gets plug-in specific named configuration value (returns true on success)

void TakeFX_SetOffline(MediaItem_Take* take, int fx, bool offline)
TakeFX_SetOffline(MediaItem_Take take, int fx, bool offline)
reaper.TakeFX_SetOffline(MediaItem_Take take, integer fx, boolean offline)
RPR_TakeFX_SetOffline(MediaItem_Take take, Int fx, Boolean offline)

See TakeFX_GetOffline

void TakeFX_SetOpen(MediaItem_Take* take, int fx, bool open)
TakeFX_SetOpen(MediaItem_Take take, int fx, bool open)
reaper.TakeFX_SetOpen(MediaItem_Take take, integer fx, boolean open)
RPR_TakeFX_SetOpen(MediaItem_Take take, Int fx, Boolean open)

Open this FX UI. See TakeFX_GetOpen

bool TakeFX_SetParam(MediaItem_Take* take, int fx, int param, double val)
bool TakeFX_SetParam(MediaItem_Take take, int fx, int param, val)
boolean reaper.TakeFX_SetParam(MediaItem_Take take, integer fx, integer param, number val)
Boolean RPR_TakeFX_SetParam(MediaItem_Take take, Int fx, Int param, Float val)
bool TakeFX_SetParamNormalized(MediaItem_Take* take, int fx, int param, double value)
bool TakeFX_SetParamNormalized(MediaItem_Take take, int fx, int param, value)
boolean reaper.TakeFX_SetParamNormalized(MediaItem_Take take, integer fx, integer param, number value)
Boolean RPR_TakeFX_SetParamNormalized(MediaItem_Take take, Int fx, Int param, Float value)
bool TakeFX_SetPinMappings(MediaItem_Take* take, int fx, int isoutput, int pin, int low32bits, int hi32bits)
bool TakeFX_SetPinMappings(MediaItem_Take take, int fx, int isoutput, int pin, int low32bits, int hi32bits)
boolean reaper.TakeFX_SetPinMappings(MediaItem_Take take, integer fx, integer isoutput, integer pin, integer low32bits, integer hi32bits)
Boolean RPR_TakeFX_SetPinMappings(MediaItem_Take take, Int fx, Int isoutput, Int pin, Int low32bits, Int hi32bits)

sets the channel mapping bitmask for a particular pin. returns false if unsupported (not all types of plug-ins support this capability)

bool TakeFX_SetPreset(MediaItem_Take* take, int fx, const char* presetname)
bool TakeFX_SetPreset(MediaItem_Take take, int fx, "presetname")
boolean reaper.TakeFX_SetPreset(MediaItem_Take take, integer fx, string presetname)
Boolean RPR_TakeFX_SetPreset(MediaItem_Take take, Int fx, String presetname)

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.

bool TakeFX_SetPresetByIndex(MediaItem_Take* take, int fx, int idx)
bool TakeFX_SetPresetByIndex(MediaItem_Take take, int fx, int idx)
boolean reaper.TakeFX_SetPresetByIndex(MediaItem_Take take, integer fx, integer idx)
Boolean RPR_TakeFX_SetPresetByIndex(MediaItem_Take take, Int fx, Int idx)

Sets the preset idx, or the factory preset (idx==-2), or the default user preset (idx==-1). Returns true on success. See TakeFX_GetPresetIndex.

void TakeFX_Show(MediaItem_Take* take, int index, int showFlag)
TakeFX_Show(MediaItem_Take take, int index, int showFlag)
reaper.TakeFX_Show(MediaItem_Take take, integer index, integer showFlag)
RPR_TakeFX_Show(MediaItem_Take take, Int index, Int showFlag)

showflag=0 for hidechain, =1 for show chain(index valid), =2 for hide floating window(index valid), =3 for show floating window (index valid)

bool TakeIsMIDI(MediaItem_Take* take)
bool TakeIsMIDI(MediaItem_Take take)
boolean reaper.TakeIsMIDI(MediaItem_Take take)
Boolean RPR_TakeIsMIDI(MediaItem_Take take)

Returns true if the active take contains MIDI.

bool ThemeLayout_GetLayout(const char* section, int idx, char* nameOut, int nameOut_sz)
bool ThemeLayout_GetLayout("section", int idx, #name)
boolean retval, string name = reaper.ThemeLayout_GetLayout(string section, integer idx)
(Boolean retval, String section, Int idx, String nameOut, Int nameOut_sz) = RPR_ThemeLayout_GetLayout(section, idx, nameOut, nameOut_sz)

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.

const char* ThemeLayout_GetParameter(int wp, const char** descOutOptional, int* valueOutOptional, int* defValueOutOptional, int* minValueOutOptional, int* maxValueOutOptional)
bool ThemeLayout_GetParameter(#retval, int wp, optional #desc, optional int &value, optional int &defValue, optional int &minValue, optional int &maxValue)
string retval, optional string desc, optional integer value, optional integer defValue, optional integer minValue, optional integer maxValue = reaper.ThemeLayout_GetParameter(integer wp)
(String retval, Int wp, String descOutOptional, Int valueOutOptional, Int defValueOutOptional, Int minValueOutOptional, Int maxValueOutOptional) = RPR_ThemeLayout_GetParameter(wp, descOutOptional, valueOutOptional, defValueOutOptional, minValueOutOptional, maxValueOutOptional)

returns theme layout parameter. return value is cfg-name, or nil/empty if out of range.

void ThemeLayout_RefreshAll()
ThemeLayout_RefreshAll()
reaper.ThemeLayout_RefreshAll()
RPR_ThemeLayout_RefreshAll()

Refreshes all layouts

bool ThemeLayout_SetLayout(const char* section, const char* layout)
bool ThemeLayout_SetLayout("section", " layout")
boolean reaper.ThemeLayout_SetLayout(string section, string layout)
Boolean RPR_ThemeLayout_SetLayout(String section, String layout)

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.

bool ThemeLayout_SetParameter(int wp, int value, bool persist)
bool ThemeLayout_SetParameter(int wp, int value, bool persist)
boolean reaper.ThemeLayout_SetParameter(integer wp, integer value, boolean persist)
Boolean RPR_ThemeLayout_SetParameter(Int wp, Int value, Boolean persist)

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.

double time_precise()
number reaper.time_precise()
Float RPR_time_precise()

Gets a precise system timestamp in seconds

double TimeMap2_beatsToTime(ReaProject* proj, double tpos, const int* measuresInOptional)
double TimeMap2_beatsToTime(ReaProject proj, tpos, optional int measuresIn)
number reaper.TimeMap2_beatsToTime(ReaProject proj, number tpos, optional integer measuresIn)
Float RPR_TimeMap2_beatsToTime(ReaProject proj, Float tpos, const int measuresInOptional)

convert a beat position (or optionally a beats+measures if measures is non-NULL) to time.

double TimeMap2_GetDividedBpmAtTime(ReaProject* proj, double time)
double TimeMap2_GetDividedBpmAtTime(ReaProject proj, time)
number reaper.TimeMap2_GetDividedBpmAtTime(ReaProject proj, number time)
Float RPR_TimeMap2_GetDividedBpmAtTime(ReaProject proj, Float time)

get the effective BPM at the time (seconds) position (i.e. 2x in /8 signatures)

double TimeMap2_GetNextChangeTime(ReaProject* proj, double time)
double TimeMap2_GetNextChangeTime(ReaProject proj, time)
number reaper.TimeMap2_GetNextChangeTime(ReaProject proj, number time)
Float RPR_TimeMap2_GetNextChangeTime(ReaProject proj, Float time)

when does the next time map (tempo or time sig) change occur

double TimeMap2_QNToTime(ReaProject* proj, double qn)
double TimeMap2_QNToTime(ReaProject proj, qn)
number reaper.TimeMap2_QNToTime(ReaProject proj, number qn)
Float RPR_TimeMap2_QNToTime(ReaProject proj, Float qn)

converts project QN position to time.

double TimeMap2_timeToBeats(ReaProject* proj, double tpos, int* measuresOutOptional, int* cmlOutOptional, double* fullbeatsOutOptional, int* cdenomOutOptional)
double TimeMap2_timeToBeats(ReaProject proj, tpos, optional int &measures, optional int &cml, optional &fullbeats, optional int &cdenom)
number retval, optional integer measures, optional integer cml, optional number fullbeats, optional integer cdenom = reaper.TimeMap2_timeToBeats(ReaProject proj, number tpos)
(Float retval, ReaProject proj, Float tpos, Int measuresOutOptional, Int cmlOutOptional, Float fullbeatsOutOptional, Int cdenomOutOptional) = RPR_TimeMap2_timeToBeats(proj, tpos, measuresOutOptional, cmlOutOptional, fullbeatsOutOptional, cdenomOutOptional)

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.

double TimeMap2_timeToQN(ReaProject* proj, double tpos)
double TimeMap2_timeToQN(ReaProject proj, tpos)
number reaper.TimeMap2_timeToQN(ReaProject proj, number tpos)
Float RPR_TimeMap2_timeToQN(ReaProject proj, Float tpos)

converts project time position to QN position.

double TimeMap_curFrameRate(ReaProject* proj, bool* dropFrameOutOptional)
double TimeMap_curFrameRate(ReaProject proj, optional bool &dropFrame)
number retval, optional boolean dropFrame = reaper.TimeMap_curFrameRate(ReaProject proj)
(Float retval, ReaProject proj, Boolean dropFrameOutOptional) = RPR_TimeMap_curFrameRate(proj, dropFrameOutOptional)

Gets project framerate, and optionally whether it is drop-frame timecode

double TimeMap_GetDividedBpmAtTime(double time)
double TimeMap_GetDividedBpmAtTime(time)
number reaper.TimeMap_GetDividedBpmAtTime(number time)
Float RPR_TimeMap_GetDividedBpmAtTime(Float time)

get the effective BPM at the time (seconds) position (i.e. 2x in /8 signatures)

double TimeMap_GetMeasureInfo(ReaProject* proj, int measure, double* qn_startOut, double* qn_endOut, int* timesig_numOut, int* timesig_denomOut, double* tempoOut)
double TimeMap_GetMeasureInfo(ReaProject proj, int measure, &qn_start, &qn_end, int &timesig_num, int &timesig_denom, &tempo)
number retval, number qn_start, number qn_end, integer timesig_num, integer timesig_denom, number tempo = reaper.TimeMap_GetMeasureInfo(ReaProject proj, integer measure)
(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)

Get the QN position and time signature information for the start of a measure. Return the time in seconds of the measure start.

int TimeMap_GetMetronomePattern(ReaProject* proj, double time, char* pattern, int pattern_sz)
int TimeMap_GetMetronomePattern(ReaProject proj, time, #pattern)
integer retval, string pattern = reaper.TimeMap_GetMetronomePattern(ReaProject proj, number time, string pattern)
(Int retval, ReaProject proj, Float time, String pattern, Int pattern_sz) = RPR_TimeMap_GetMetronomePattern(proj, time, pattern, pattern_sz)

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.

void TimeMap_GetTimeSigAtTime(ReaProject* proj, double time, int* timesig_numOut, int* timesig_denomOut, double* tempoOut)
TimeMap_GetTimeSigAtTime(ReaProject proj, time, int &timesig_num, int &timesig_denom, &tempo)
integer timesig_num, integer timesig_denom, number tempo = reaper.TimeMap_GetTimeSigAtTime(ReaProject proj, number time)
(ReaProject proj, Float time, Int timesig_numOut, Int timesig_denomOut, Float tempoOut) = RPR_TimeMap_GetTimeSigAtTime(proj, time, timesig_numOut, timesig_denomOut, tempoOut)

get the effective time signature and tempo

int TimeMap_QNToMeasures(ReaProject* proj, double qn, double* qnMeasureStartOutOptional, double* qnMeasureEndOutOptional)
int TimeMap_QNToMeasures(ReaProject proj, qn, optional &qnMeasureStart, optional &qnMeasureEnd)
integer retval, optional number qnMeasureStart, optional number qnMeasureEnd = reaper.TimeMap_QNToMeasures(ReaProject proj, number qn)
(Int retval, ReaProject proj, Float qn, Float qnMeasureStartOutOptional, Float qnMeasureEndOutOptional) = RPR_TimeMap_QNToMeasures(proj, qn, qnMeasureStartOutOptional, qnMeasureEndOutOptional)

Find which measure the given QN position falls in.

double TimeMap_QNToTime(double qn)
double TimeMap_QNToTime(qn)
number reaper.TimeMap_QNToTime(number qn)
Float RPR_TimeMap_QNToTime(Float qn)

converts project QN position to time.

double TimeMap_QNToTime_abs(ReaProject* proj, double qn)
double TimeMap_QNToTime_abs(ReaProject proj, qn)
number reaper.TimeMap_QNToTime_abs(ReaProject proj, number qn)
Float RPR_TimeMap_QNToTime_abs(ReaProject proj, Float qn)

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

double TimeMap_timeToQN(double tpos)
double TimeMap_timeToQN(tpos)
number reaper.TimeMap_timeToQN(number tpos)
Float RPR_TimeMap_timeToQN(Float tpos)

converts project QN position to time.

double TimeMap_timeToQN_abs(ReaProject* proj, double tpos)
double TimeMap_timeToQN_abs(ReaProject proj, tpos)
number reaper.TimeMap_timeToQN_abs(ReaProject proj, number tpos)
Float RPR_TimeMap_timeToQN_abs(ReaProject proj, Float tpos)

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

bool ToggleTrackSendUIMute(MediaTrack* track, int send_idx)
bool ToggleTrackSendUIMute(MediaTrack track, int send_idx)
boolean reaper.ToggleTrackSendUIMute(MediaTrack track, integer send_idx)
Boolean RPR_ToggleTrackSendUIMute(MediaTrack track, Int send_idx)

send_idx<0 for receives, >=0 for hw ouputs, >=nb_of_hw_ouputs for sends.

double Track_GetPeakHoldDB(MediaTrack* track, int channel, bool clear)
double Track_GetPeakHoldDB(MediaTrack track, int channel, bool clear)
number reaper.Track_GetPeakHoldDB(MediaTrack track, integer channel, boolean clear)
Float RPR_Track_GetPeakHoldDB(MediaTrack track, Int channel, Boolean clear)

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 channel==1024 or channel==1025, returns loudness values if this is the master track or this track's VU meters are set to display loudness.

double Track_GetPeakInfo(MediaTrack* track, int channel)
double Track_GetPeakInfo(MediaTrack track, int channel)
number reaper.Track_GetPeakInfo(MediaTrack track, integer channel)
Float RPR_Track_GetPeakInfo(MediaTrack track, Int channel)

Returns peak meter value (1.0=+0dB, 0.0=-inf) for channel. If channel==1024 or channel==1025, returns loudness values if this is the master track or this track's VU meters are set to display loudness.

void TrackCtl_SetToolTip(const char* fmt, int xpos, int ypos, bool topmost)
TrackCtl_SetToolTip("fmt", int xpos, int ypos, bool topmost)
reaper.TrackCtl_SetToolTip(string fmt, integer xpos, integer ypos, boolean topmost)
RPR_TrackCtl_SetToolTip(String fmt, Int xpos, Int ypos, Boolean topmost)

displays tooltip at location, or removes if empty string

int TrackFX_AddByName(MediaTrack* track, const char* fxname, bool recFX, int instantiate)
int TrackFX_AddByName(MediaTrack track, "fxname", bool recFX, int instantiate)
integer reaper.TrackFX_AddByName(MediaTrack track, string fxname, boolean recFX, integer instantiate)
Int RPR_TrackFX_AddByName(MediaTrack track, String fxname, Boolean recFX, Int instantiate)

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. If instantiate is <= -1000, it is used for the insertion position (-1000 is first item in chain, -1001 is second, etc). fxname can have prefix to specify type: VST3:,VST2:,VST:,AU:,JS:, or DX:, or FXADD: which adds selected items from the currently-open FX browser, FXADD:2 to limit to 2 FX added, or FXADD:2e to only succeed if exactly 2 FX are selected. Returns -1 on failure or the new position in chain on success.

void TrackFX_CopyToTake(MediaTrack* src_track, int src_fx, MediaItem_Take* dest_take, int dest_fx, bool is_move)
TrackFX_CopyToTake(MediaTrack src_track, int src_fx, MediaItem_Take dest_take, int dest_fx, bool is_move)
reaper.TrackFX_CopyToTake(MediaTrack src_track, integer src_fx, MediaItem_Take dest_take, integer dest_fx, boolean is_move)
RPR_TrackFX_CopyToTake(MediaTrack src_track, Int src_fx, MediaItem_Take dest_take, Int dest_fx, Boolean is_move)

Copies (or moves) FX from src_track to dest_take. src_fx can have 0x1000000 set to reference input FX.

void TrackFX_CopyToTrack(MediaTrack* src_track, int src_fx, MediaTrack* dest_track, int dest_fx, bool is_move)
TrackFX_CopyToTrack(MediaTrack src_track, int src_fx, MediaTrack dest_track, int dest_fx, bool is_move)
reaper.TrackFX_CopyToTrack(MediaTrack src_track, integer src_fx, MediaTrack dest_track, integer dest_fx, boolean is_move)
RPR_TrackFX_CopyToTrack(MediaTrack src_track, Int src_fx, MediaTrack dest_track, Int dest_fx, Boolean is_move)

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.

bool TrackFX_Delete(MediaTrack* track, int fx)
bool TrackFX_Delete(MediaTrack track, int fx)
boolean reaper.TrackFX_Delete(MediaTrack track, integer fx)
Boolean RPR_TrackFX_Delete(MediaTrack track, Int fx)

Remove a FX from track chain (returns true on success)

bool TrackFX_EndParamEdit(MediaTrack* track, int fx, int param)
bool TrackFX_EndParamEdit(MediaTrack track, int fx, int param)
boolean reaper.TrackFX_EndParamEdit(MediaTrack track, integer fx, integer param)
Boolean RPR_TrackFX_EndParamEdit(MediaTrack track, Int fx, Int param)
bool TrackFX_FormatParamValue(MediaTrack* track, int fx, int param, double val, char* bufOut, int bufOut_sz)
bool TrackFX_FormatParamValue(MediaTrack track, int fx, int param, val, #buf)
boolean retval, string buf = reaper.TrackFX_FormatParamValue(MediaTrack track, integer fx, integer param, number val)
(Boolean retval, MediaTrack track, Int fx, Int param, Float val, String bufOut, Int bufOut_sz) = RPR_TrackFX_FormatParamValue(track, fx, param, val, bufOut, bufOut_sz)

Note: only works with FX that support Cockos VST extensions.

bool TrackFX_FormatParamValueNormalized(MediaTrack* track, int fx, int param, double value, char* buf, int buf_sz)
bool TrackFX_FormatParamValueNormalized(MediaTrack track, int fx, int param, value, #buf)
boolean retval, string buf = reaper.TrackFX_FormatParamValueNormalized(MediaTrack track, integer fx, integer param, number value, string buf)
(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)

Note: only works with FX that support Cockos VST extensions.

int TrackFX_GetByName(MediaTrack* track, const char* fxname, bool instantiate)
int TrackFX_GetByName(MediaTrack track, "fxname", bool instantiate)
integer reaper.TrackFX_GetByName(MediaTrack track, string fxname, boolean instantiate)
Int RPR_TrackFX_GetByName(MediaTrack track, String fxname, Boolean instantiate)

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.

int TrackFX_GetChainVisible(MediaTrack* track)
int TrackFX_GetChainVisible(MediaTrack track)
integer reaper.TrackFX_GetChainVisible(MediaTrack track)
Int RPR_TrackFX_GetChainVisible(MediaTrack track)

returns index of effect visible in chain, or -1 for chain hidden, or -2 for chain visible but no effect selected

int TrackFX_GetCount(MediaTrack* track)
int TrackFX_GetCount(MediaTrack track)
integer reaper.TrackFX_GetCount(MediaTrack track)
Int RPR_TrackFX_GetCount(MediaTrack track)
bool TrackFX_GetEnabled(MediaTrack* track, int fx)
bool TrackFX_GetEnabled(MediaTrack track, int fx)
boolean reaper.TrackFX_GetEnabled(MediaTrack track, integer fx)
Boolean RPR_TrackFX_GetEnabled(MediaTrack track, Int fx)

See TrackFX_SetEnabled

int TrackFX_GetEQ(MediaTrack* track, bool instantiate)
int TrackFX_GetEQ(MediaTrack track, bool instantiate)
integer reaper.TrackFX_GetEQ(MediaTrack track, boolean instantiate)
Int RPR_TrackFX_GetEQ(MediaTrack track, Boolean instantiate)

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.

bool TrackFX_GetEQBandEnabled(MediaTrack* track, int fxidx, int bandtype, int bandidx)
bool TrackFX_GetEQBandEnabled(MediaTrack track, int fxidx, int bandtype, int bandidx)
boolean reaper.TrackFX_GetEQBandEnabled(MediaTrack track, integer fxidx, integer bandtype, integer bandidx)
Boolean RPR_TrackFX_GetEQBandEnabled(MediaTrack track, Int fxidx, Int bandtype, Int bandidx)

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.
See TrackFX_GetEQ, TrackFX_GetEQParam, TrackFX_SetEQParam, TrackFX_SetEQBandEnabled.

bool TrackFX_GetEQParam(MediaTrack* track, int fxidx, int paramidx, int* bandtypeOut, int* bandidxOut, int* paramtypeOut, double* normvalOut)
bool TrackFX_GetEQParam(MediaTrack track, int fxidx, int paramidx, int &bandtype, int &bandidx, int &paramtype, &normval)
boolean retval, integer bandtype, integer bandidx, integer paramtype, number normval = reaper.TrackFX_GetEQParam(MediaTrack track, integer fxidx, integer paramidx)
(Boolean retval, MediaTrack track, Int fxidx, Int paramidx, Int bandtypeOut, Int bandidxOut, Int paramtypeOut, Float normvalOut) = RPR_TrackFX_GetEQParam(track, fxidx, paramidx, bandtypeOut, bandidxOut, paramtypeOut, normvalOut)

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.
See TrackFX_GetEQ, TrackFX_SetEQParam, TrackFX_GetEQBandEnabled, TrackFX_SetEQBandEnabled.

HWND TrackFX_GetFloatingWindow(MediaTrack* track, int index)
HWND TrackFX_GetFloatingWindow(MediaTrack track, int index)
HWND reaper.TrackFX_GetFloatingWindow(MediaTrack track, integer index)
HWND RPR_TrackFX_GetFloatingWindow(MediaTrack track, Int index)

returns HWND of floating window for effect index, if any

bool TrackFX_GetFormattedParamValue(MediaTrack* track, int fx, int param, char* bufOut, int bufOut_sz)
bool TrackFX_GetFormattedParamValue(MediaTrack track, int fx, int param, #buf)
boolean retval, string buf = reaper.TrackFX_GetFormattedParamValue(MediaTrack track, integer fx, integer param)
(Boolean retval, MediaTrack track, Int fx, Int param, String bufOut, Int bufOut_sz) = RPR_TrackFX_GetFormattedParamValue(track, fx, param, bufOut, bufOut_sz)
GUID* TrackFX_GetFXGUID(MediaTrack* track, int fx)
bool TrackFX_GetFXGUID(#retguid, MediaTrack track, int fx)
string GUID = reaper.TrackFX_GetFXGUID(MediaTrack track, integer fx)
GUID RPR_TrackFX_GetFXGUID(MediaTrack track, Int fx)
bool TrackFX_GetFXName(MediaTrack* track, int fx, char* bufOut, int bufOut_sz)
bool TrackFX_GetFXName(MediaTrack track, int fx, #buf)
boolean retval, string buf = reaper.TrackFX_GetFXName(MediaTrack track, integer fx)
(Boolean retval, MediaTrack track, Int fx, String bufOut, Int bufOut_sz) = RPR_TrackFX_GetFXName(track, fx, bufOut, bufOut_sz)
int TrackFX_GetInstrument(MediaTrack* track)
int TrackFX_GetInstrument(MediaTrack track)
integer reaper.TrackFX_GetInstrument(MediaTrack track)
Int RPR_TrackFX_GetInstrument(MediaTrack track)

Get the index of the first track FX insert that is a virtual instrument, or -1 if none. See TrackFX_GetEQ, TrackFX_GetByName.

int TrackFX_GetIOSize(MediaTrack* track, int fx, int* inputPinsOutOptional, int* outputPinsOutOptional)
int TrackFX_GetIOSize(MediaTrack track, int fx, optional int &inputPins, optional int &outputPins)
integer retval, optional integer inputPins, optional integer outputPins = reaper.TrackFX_GetIOSize(MediaTrack track, integer fx)
(Int retval, MediaTrack track, Int fx, Int inputPinsOutOptional, Int outputPinsOutOptional) = RPR_TrackFX_GetIOSize(track, fx, inputPinsOutOptional, outputPinsOutOptional)

Gets the number of input/output pins for FX if available, returns plug-in type or -1 on error

bool TrackFX_GetNamedConfigParm(MediaTrack* track, int fx, const char* parmname, char* bufOut, int bufOut_sz)
bool TrackFX_GetNamedConfigParm(MediaTrack track, int fx, "parmname", #buf)
boolean retval, string buf = reaper.TrackFX_GetNamedConfigParm(MediaTrack track, integer fx, string parmname)
(Boolean retval, MediaTrack track, Int fx, String parmname, String bufOut, Int bufOut_sz) = RPR_TrackFX_GetNamedConfigParm(track, fx, parmname, bufOut, bufOut_sz)

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. 'fx_type' returns type string, 'fx_ident' returns type-specific identifier, 'fx_name' returns pre-aliased name.

int TrackFX_GetNumParams(MediaTrack* track, int fx)
int TrackFX_GetNumParams(MediaTrack track, int fx)
integer reaper.TrackFX_GetNumParams(MediaTrack track, integer fx)
Int RPR_TrackFX_GetNumParams(MediaTrack track, Int fx)
bool TrackFX_GetOffline(MediaTrack* track, int fx)
bool TrackFX_GetOffline(MediaTrack track, int fx)
boolean reaper.TrackFX_GetOffline(MediaTrack track, integer fx)
Boolean RPR_TrackFX_GetOffline(MediaTrack track, Int fx)

See TrackFX_SetOffline

bool TrackFX_GetOpen(MediaTrack* track, int fx)
bool TrackFX_GetOpen(MediaTrack track, int fx)
boolean reaper.TrackFX_GetOpen(MediaTrack track, integer fx)
Boolean RPR_TrackFX_GetOpen(MediaTrack track, Int fx)

Returns true if this FX UI is open in the FX chain window or a floating window. See TrackFX_SetOpen

double TrackFX_GetParam(MediaTrack* track, int fx, int param, double* minvalOut, double* maxvalOut)
double TrackFX_GetParam(MediaTrack track, int fx, int param, &minval, &maxval)
number retval, number minval, number maxval = reaper.TrackFX_GetParam(MediaTrack track, integer fx, integer param)
(Float retval, MediaTrack track, Int fx, Int param, Float minvalOut, Float maxvalOut) = RPR_TrackFX_GetParam(track, fx, param, minvalOut, maxvalOut)
bool TrackFX_GetParameterStepSizes(MediaTrack* track, int fx, int param, double* stepOut, double* smallstepOut, double* largestepOut, bool* istoggleOut)
bool TrackFX_GetParameterStepSizes(MediaTrack track, int fx, int param, &step, &smallstep, &largestep, bool &istoggle)
boolean retval, number step, number smallstep, number largestep, boolean istoggle = reaper.TrackFX_GetParameterStepSizes(MediaTrack track, integer fx, integer param)
(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)
double TrackFX_GetParamEx(MediaTrack* track, int fx, int param, double* minvalOut, double* maxvalOut, double* midvalOut)
double TrackFX_GetParamEx(MediaTrack track, int fx, int param, &minval, &maxval, &midval)
number retval, number minval, number maxval, number midval = reaper.TrackFX_GetParamEx(MediaTrack track, integer fx, integer param)
(Float retval, MediaTrack track, Int fx, Int param, Float minvalOut, Float maxvalOut, Float midvalOut) = RPR_TrackFX_GetParamEx(track, fx, param, minvalOut, maxvalOut, midvalOut)
int TrackFX_GetParamFromIdent(MediaTrack* track, int fx, const char* ident_str)
int TrackFX_GetParamFromIdent(MediaTrack track, int fx, "ident_str")
integer reaper.TrackFX_GetParamFromIdent(MediaTrack track, integer fx, string ident_str)
Int RPR_TrackFX_GetParamFromIdent(MediaTrack track, Int fx, String ident_str)

gets the parameter index from an identifying string (:wet, :bypass, :delta, or a string returned from GetParamIdent), or -1 if unknown.

bool TrackFX_GetParamIdent(MediaTrack* track, int fx, int param, char* bufOut, int bufOut_sz)
bool TrackFX_GetParamIdent(MediaTrack track, int fx, int param, #buf)
boolean retval, string buf = reaper.TrackFX_GetParamIdent(MediaTrack track, integer fx, integer param)
(Boolean retval, MediaTrack track, Int fx, Int param, String bufOut, Int bufOut_sz) = RPR_TrackFX_GetParamIdent(track, fx, param, bufOut, bufOut_sz)

gets an identifying string for the parameter

bool TrackFX_GetParamName(MediaTrack* track, int fx, int param, char* bufOut, int bufOut_sz)
bool TrackFX_GetParamName(MediaTrack track, int fx, int param, #buf)
boolean retval, string buf = reaper.TrackFX_GetParamName(MediaTrack track, integer fx, integer param)
(Boolean retval, MediaTrack track, Int fx, Int param, String bufOut, Int bufOut_sz) = RPR_TrackFX_GetParamName(track, fx, param, bufOut, bufOut_sz)
double TrackFX_GetParamNormalized(MediaTrack* track, int fx, int param)
double TrackFX_GetParamNormalized(MediaTrack track, int fx, int param)
number reaper.TrackFX_GetParamNormalized(MediaTrack track, integer fx, integer param)
Float RPR_TrackFX_GetParamNormalized(MediaTrack track, Int fx, Int param)
int TrackFX_GetPinMappings(MediaTrack* tr, int fx, int isoutput, int pin, int* high32OutOptional)
int TrackFX_GetPinMappings(MediaTrack tr, int fx, int isoutput, int pin, optional int &high32)
integer retval, optional integer high32 = reaper.TrackFX_GetPinMappings(MediaTrack tr, integer fx, integer isoutput, integer pin)
(Int retval, MediaTrack tr, Int fx, Int isoutput, Int pin, Int high32OutOptional) = RPR_TrackFX_GetPinMappings(tr, fx, isoutput, pin, high32OutOptional)

gets the effective channel mapping bitmask for a particular pin. high32OutOptional will be set to the high 32 bits

bool TrackFX_GetPreset(MediaTrack* track, int fx, char* presetnameOut, int presetnameOut_sz)
bool TrackFX_GetPreset(MediaTrack track, int fx, #presetname)
boolean retval, string presetname = reaper.TrackFX_GetPreset(MediaTrack track, integer fx)
(Boolean retval, MediaTrack track, Int fx, String presetnameOut, Int presetnameOut_sz) = RPR_TrackFX_GetPreset(track, fx, presetnameOut, presetnameOut_sz)

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.

int TrackFX_GetPresetIndex(MediaTrack* track, int fx, int* numberOfPresetsOut)
int TrackFX_GetPresetIndex(MediaTrack track, int fx, int &numberOfPresets)
integer retval, integer numberOfPresets = reaper.TrackFX_GetPresetIndex(MediaTrack track, integer fx)
(Int retval, MediaTrack track, Int fx, Int numberOfPresetsOut) = RPR_TrackFX_GetPresetIndex(track, fx, numberOfPresetsOut)

Returns current preset index, or -1 if error. numberOfPresetsOut will be set to total number of presets available. See TrackFX_SetPresetByIndex

int TrackFX_GetRecChainVisible(MediaTrack* track)
int TrackFX_GetRecChainVisible(MediaTrack track)
integer reaper.TrackFX_GetRecChainVisible(MediaTrack track)
Int RPR_TrackFX_GetRecChainVisible(MediaTrack track)

returns index of effect visible in record input chain, or -1 for chain hidden, or -2 for chain visible but no effect selected

int TrackFX_GetRecCount(MediaTrack* track)
int TrackFX_GetRecCount(MediaTrack track)
integer reaper.TrackFX_GetRecCount(MediaTrack track)
Int RPR_TrackFX_GetRecCount(MediaTrack track)

returns count of record input FX. To access record input FX, use a FX indices [0x1000000..0x1000000+n). On the master track, this accesses monitoring FX rather than record input FX.

void TrackFX_GetUserPresetFilename(MediaTrack* track, int fx, char* fnOut, int fnOut_sz)
TrackFX_GetUserPresetFilename(MediaTrack track, int fx, #fn)
string fn = reaper.TrackFX_GetUserPresetFilename(MediaTrack track, integer fx)
(MediaTrack track, Int fx, String fnOut, Int fnOut_sz) = RPR_TrackFX_GetUserPresetFilename(track, fx, fnOut, fnOut_sz)
bool TrackFX_NavigatePresets(MediaTrack* track, int fx, int presetmove)
bool TrackFX_NavigatePresets(MediaTrack track, int fx, int presetmove)
boolean reaper.TrackFX_NavigatePresets(MediaTrack track, integer fx, integer presetmove)
Boolean RPR_TrackFX_NavigatePresets(MediaTrack track, Int fx, Int presetmove)

presetmove==1 activates the next preset, presetmove==-1 activates the previous preset, etc.

void TrackFX_SetEnabled(MediaTrack* track, int fx, bool enabled)
TrackFX_SetEnabled(MediaTrack track, int fx, bool enabled)
reaper.TrackFX_SetEnabled(MediaTrack track, integer fx, boolean enabled)
RPR_TrackFX_SetEnabled(MediaTrack track, Int fx, Boolean enabled)

See TrackFX_GetEnabled

bool TrackFX_SetEQBandEnabled(MediaTrack* track, int fxidx, int bandtype, int bandidx, bool enable)
bool TrackFX_SetEQBandEnabled(MediaTrack track, int fxidx, int bandtype, int bandidx, bool enable)
boolean reaper.TrackFX_SetEQBandEnabled(MediaTrack track, integer fxidx, integer bandtype, integer bandidx, boolean enable)
Boolean RPR_TrackFX_SetEQBandEnabled(MediaTrack track, Int fxidx, Int bandtype, Int bandidx, Boolean enable)

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.

bool TrackFX_SetEQParam(MediaTrack* track, int fxidx, int bandtype, int bandidx, int paramtype, double val, bool isnorm)
bool TrackFX_SetEQParam(MediaTrack track, int fxidx, int bandtype, int bandidx, int paramtype, val, bool isnorm)
boolean reaper.TrackFX_SetEQParam(MediaTrack track, integer fxidx, integer bandtype, integer bandidx, integer paramtype, number val, boolean isnorm)
Boolean RPR_TrackFX_SetEQParam(MediaTrack track, Int fxidx, Int bandtype, Int bandidx, Int paramtype, Float val, Boolean isnorm)

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.

bool TrackFX_SetNamedConfigParm(MediaTrack* track, int fx, const char* parmname, const char* value)
bool TrackFX_SetNamedConfigParm(MediaTrack track, int fx, "parmname", "value")
boolean reaper.TrackFX_SetNamedConfigParm(MediaTrack track, integer fx, string parmname, string value)
Boolean RPR_TrackFX_SetNamedConfigParm(MediaTrack track, Int fx, String parmname, String value)

sets plug-in specific named configuration value (returns true on success)

void TrackFX_SetOffline(MediaTrack* track, int fx, bool offline)
TrackFX_SetOffline(MediaTrack track, int fx, bool offline)
reaper.TrackFX_SetOffline(MediaTrack track, integer fx, boolean offline)
RPR_TrackFX_SetOffline(MediaTrack track, Int fx, Boolean offline)

See TrackFX_GetOffline

void TrackFX_SetOpen(MediaTrack* track, int fx, bool open)
TrackFX_SetOpen(MediaTrack track, int fx, bool open)
reaper.TrackFX_SetOpen(MediaTrack track, integer fx, boolean open)
RPR_TrackFX_SetOpen(MediaTrack track, Int fx, Boolean open)

Open this FX UI. See TrackFX_GetOpen

bool TrackFX_SetParam(MediaTrack* track, int fx, int param, double val)
bool TrackFX_SetParam(MediaTrack track, int fx, int param, val)
boolean reaper.TrackFX_SetParam(MediaTrack track, integer fx, integer param, number val)
Boolean RPR_TrackFX_SetParam(MediaTrack track, Int fx, Int param, Float val)
bool TrackFX_SetParamNormalized(MediaTrack* track, int fx, int param, double value)
bool TrackFX_SetParamNormalized(MediaTrack track, int fx, int param, value)
boolean reaper.TrackFX_SetParamNormalized(MediaTrack track, integer fx, integer param, number value)
Boolean RPR_TrackFX_SetParamNormalized(MediaTrack track, Int fx, Int param, Float value)
bool TrackFX_SetPinMappings(MediaTrack* tr, int fx, int isoutput, int pin, int low32bits, int hi32bits)
bool TrackFX_SetPinMappings(MediaTrack tr, int fx, int isoutput, int pin, int low32bits, int hi32bits)
boolean reaper.TrackFX_SetPinMappings(MediaTrack tr, integer fx, integer isoutput, integer pin, integer low32bits, integer hi32bits)
Boolean RPR_TrackFX_SetPinMappings(MediaTrack tr, Int fx, Int isoutput, Int pin, Int low32bits, Int hi32bits)

sets the channel mapping bitmask for a particular pin. returns false if unsupported (not all types of plug-ins support this capability)

bool TrackFX_SetPreset(MediaTrack* track, int fx, const char* presetname)
bool TrackFX_SetPreset(MediaTrack track, int fx, "presetname")
boolean reaper.TrackFX_SetPreset(MediaTrack track, integer fx, string presetname)
Boolean RPR_TrackFX_SetPreset(MediaTrack track, Int fx, String presetname)

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.

bool TrackFX_SetPresetByIndex(MediaTrack* track, int fx, int idx)
bool TrackFX_SetPresetByIndex(MediaTrack track, int fx, int idx)
boolean reaper.TrackFX_SetPresetByIndex(MediaTrack track, integer fx, integer idx)
Boolean RPR_TrackFX_SetPresetByIndex(MediaTrack track, Int fx, Int idx)

Sets the preset idx, or the factory preset (idx==-2), or the default user preset (idx==-1). Returns true on success. See TrackFX_GetPresetIndex.

void TrackFX_Show(MediaTrack* track, int index, int showFlag)
TrackFX_Show(MediaTrack track, int index, int showFlag)
reaper.TrackFX_Show(MediaTrack track, integer index, integer showFlag)
RPR_TrackFX_Show(MediaTrack track, Int index, Int showFlag)

showflag=0 for hidechain, =1 for show chain(index valid), =2 for hide floating window(index valid), =3 for show floating window (index valid)

void TrackList_AdjustWindows(bool isMinor)
TrackList_AdjustWindows(bool isMinor)
reaper.TrackList_AdjustWindows(boolean isMinor)
RPR_TrackList_AdjustWindows(Boolean isMinor)
void TrackList_UpdateAllExternalSurfaces()
TrackList_UpdateAllExternalSurfaces()
reaper.TrackList_UpdateAllExternalSurfaces()
RPR_TrackList_UpdateAllExternalSurfaces()
void Undo_BeginBlock()
Undo_BeginBlock()
reaper.Undo_BeginBlock()
RPR_Undo_BeginBlock()

call to start a new block

void Undo_BeginBlock2(ReaProject* proj)
Undo_BeginBlock2(ReaProject proj)
reaper.Undo_BeginBlock2(ReaProject proj)
RPR_Undo_BeginBlock2(ReaProject proj)

call to start a new block

const char* Undo_CanRedo2(ReaProject* proj)
bool Undo_CanRedo2(#retval, ReaProject proj)
string reaper.Undo_CanRedo2(ReaProject proj)
String RPR_Undo_CanRedo2(ReaProject proj)

returns string of next action,if able,NULL if not

const char* Undo_CanUndo2(ReaProject* proj)
bool Undo_CanUndo2(#retval, ReaProject proj)
string reaper.Undo_CanUndo2(ReaProject proj)
String RPR_Undo_CanUndo2(ReaProject proj)

returns string of last action,if able,NULL if not

int Undo_DoRedo2(ReaProject* proj)
int Undo_DoRedo2(ReaProject proj)
integer reaper.Undo_DoRedo2(ReaProject proj)
Int RPR_Undo_DoRedo2(ReaProject proj)

nonzero if success

int Undo_DoUndo2(ReaProject* proj)
int Undo_DoUndo2(ReaProject proj)
integer reaper.Undo_DoUndo2(ReaProject proj)
Int RPR_Undo_DoUndo2(ReaProject proj)

nonzero if success

void Undo_EndBlock(const char* descchange, int extraflags)
Undo_EndBlock("descchange", int extraflags)
reaper.Undo_EndBlock(string descchange, integer extraflags)
RPR_Undo_EndBlock(String descchange, Int extraflags)

call to end the block,with extra flags if any,and a description

void Undo_EndBlock2(ReaProject* proj, const char* descchange, int extraflags)
Undo_EndBlock2(ReaProject proj, "descchange", int extraflags)
reaper.Undo_EndBlock2(ReaProject proj, string descchange, integer extraflags)
RPR_Undo_EndBlock2(ReaProject proj, String descchange, Int extraflags)

call to end the block,with extra flags if any,and a description

void Undo_OnStateChange(const char* descchange)
Undo_OnStateChange("descchange")
reaper.Undo_OnStateChange(string descchange)
RPR_Undo_OnStateChange(String descchange)

limited state change to items

void Undo_OnStateChange2(ReaProject* proj, const char* descchange)
Undo_OnStateChange2(ReaProject proj, "descchange")
reaper.Undo_OnStateChange2(ReaProject proj, string descchange)
RPR_Undo_OnStateChange2(ReaProject proj, String descchange)

limited state change to items

void Undo_OnStateChange_Item(ReaProject* proj, const char* name, MediaItem* item)
Undo_OnStateChange_Item(ReaProject proj, "name", MediaItem item)
reaper.Undo_OnStateChange_Item(ReaProject proj, string name, MediaItem item)
RPR_Undo_OnStateChange_Item(ReaProject proj, String name, MediaItem item)
void Undo_OnStateChangeEx(const char* descchange, int whichStates, int trackparm)
Undo_OnStateChangeEx("descchange", int whichStates, int trackparm)
reaper.Undo_OnStateChangeEx(string descchange, integer whichStates, integer trackparm)
RPR_Undo_OnStateChangeEx(String descchange, Int whichStates, Int trackparm)

trackparm=-1 by default,or if updating one fx chain,you can specify track index

void Undo_OnStateChangeEx2(ReaProject* proj, const char* descchange, int whichStates, int trackparm)
Undo_OnStateChangeEx2(ReaProject proj, "descchange", int whichStates, int trackparm)
reaper.Undo_OnStateChangeEx2(ReaProject proj, string descchange, integer whichStates, integer trackparm)
RPR_Undo_OnStateChangeEx2(ReaProject proj, String descchange, Int whichStates, Int trackparm)

trackparm=-1 by default,or if updating one fx chain,you can specify track index

void UpdateArrange()
UpdateArrange()
reaper.UpdateArrange()
RPR_UpdateArrange()

Redraw the arrange view

void UpdateItemInProject(MediaItem* item)
UpdateItemInProject(MediaItem item)
reaper.UpdateItemInProject(MediaItem item)
RPR_UpdateItemInProject(MediaItem item)
void UpdateTimeline()
UpdateTimeline()
reaper.UpdateTimeline()
RPR_UpdateTimeline()

Redraw the arrange view and ruler

bool ValidatePtr(void* pointer, const char* ctypename)
bool ValidatePtr(void* pointer, "ctypename")
boolean reaper.ValidatePtr(identifier pointer, string ctypename)
Boolean RPR_ValidatePtr(void pointer, String ctypename)

see ValidatePtr2

bool ValidatePtr2(ReaProject* proj, void* pointer, const char* ctypename)
bool ValidatePtr2(ReaProject proj, void* pointer, "ctypename")
boolean reaper.ValidatePtr2(ReaProject proj, identifier pointer, string ctypename)
Boolean RPR_ValidatePtr2(ReaProject proj, void pointer, String ctypename)

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*.

void ViewPrefs(int page, const char* pageByName)
ViewPrefs(int page, "pageByName")
reaper.ViewPrefs(integer page, string pageByName)
RPR_ViewPrefs(Int page, String pageByName)

Opens the prefs to a page, use pageByName if page is 0.

BR_Envelope* BR_EnvAlloc(TrackEnvelope* envelope, bool takeEnvelopesUseProjectTime)
BR_Envelope BR_EnvAlloc(TrackEnvelope envelope, bool takeEnvelopesUseProjectTime) (requires REAPER 6.24 or later)
BR_Envelope extension_api("BR_EnvAlloc", TrackEnvelope envelope, bool takeEnvelopesUseProjectTime) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
BR_Envelope reaper.BR_EnvAlloc(TrackEnvelope envelope, boolean takeEnvelopesUseProjectTime)
BR_Envelope BR_EnvAlloc(TrackEnvelope envelope, Boolean takeEnvelopesUseProjectTime)

[BR] Allocate envelope object from track or take envelope pointer. Always call BR_EnvFree when done to release the object and commit changes if needed.
takeEnvelopesUseProjectTime: take envelope points' positions are counted from take position, not project start time. If you want to work with project time instead, pass this as true.

For further 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.

int BR_EnvCountPoints(BR_Envelope* envelope)
int BR_EnvCountPoints(BR_Envelope envelope) (requires REAPER 6.24 or later)
int extension_api("BR_EnvCountPoints", BR_Envelope envelope) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.BR_EnvCountPoints(BR_Envelope envelope)
Int BR_EnvCountPoints(BR_Envelope envelope)

[BR] Count envelope points in the envelope object allocated with BR_EnvAlloc.

bool BR_EnvDeletePoint(BR_Envelope* envelope, int id)
bool BR_EnvDeletePoint(BR_Envelope envelope, int id) (requires REAPER 6.24 or later)
bool extension_api("BR_EnvDeletePoint", BR_Envelope envelope, int id) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.BR_EnvDeletePoint(BR_Envelope envelope, integer id)
Boolean BR_EnvDeletePoint(BR_Envelope envelope, Int id)

[BR] Delete envelope point by index (zero-based) in the envelope object allocated with BR_EnvAlloc. Returns true on success.

int BR_EnvFind(BR_Envelope* envelope, double position, double delta)
int BR_EnvFind(BR_Envelope envelope, position, delta) (requires REAPER 6.24 or later)
int extension_api("BR_EnvFind", BR_Envelope envelope, position, delta) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.BR_EnvFind(BR_Envelope envelope, number position, number delta)
Int BR_EnvFind(BR_Envelope envelope, Float position, Float delta)

[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.

int BR_EnvFindNext(BR_Envelope* envelope, double position)
int BR_EnvFindNext(BR_Envelope envelope, position) (requires REAPER 6.24 or later)
int extension_api("BR_EnvFindNext", BR_Envelope envelope, position) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.BR_EnvFindNext(BR_Envelope envelope, number position)
Int BR_EnvFindNext(BR_Envelope envelope, Float position)

[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.

int BR_EnvFindPrevious(BR_Envelope* envelope, double position)
int BR_EnvFindPrevious(BR_Envelope envelope, position) (requires REAPER 6.24 or later)
int extension_api("BR_EnvFindPrevious", BR_Envelope envelope, position) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.BR_EnvFindPrevious(BR_Envelope envelope, number position)
Int BR_EnvFindPrevious(BR_Envelope envelope, Float position)

[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.

bool BR_EnvFree(BR_Envelope* envelope, bool commit)
bool BR_EnvFree(BR_Envelope envelope, bool commit) (requires REAPER 6.24 or later)
bool extension_api("BR_EnvFree", BR_Envelope envelope, bool commit) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.BR_EnvFree(BR_Envelope envelope, boolean commit)
Boolean BR_EnvFree(BR_Envelope envelope, Boolean commit)

[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.

MediaItem_Take* BR_EnvGetParentTake(BR_Envelope* envelope)
MediaItem_Take BR_EnvGetParentTake(BR_Envelope envelope) (requires REAPER 6.24 or later)
MediaItem_Take extension_api("BR_EnvGetParentTake", BR_Envelope envelope) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
MediaItem_Take reaper.BR_EnvGetParentTake(BR_Envelope envelope)
MediaItem_Take BR_EnvGetParentTake(BR_Envelope envelope)

[BR] If envelope object allocated with BR_EnvAlloc is take envelope, returns parent media item take, otherwise NULL.

MediaTrack* BR_EnvGetParentTrack(BR_Envelope* envelope)
MediaTrack BR_EnvGetParentTrack(BR_Envelope envelope) (requires REAPER 6.24 or later)
MediaTrack extension_api("BR_EnvGetParentTrack", BR_Envelope envelope) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
MediaTrack reaper.BR_EnvGetParentTrack(BR_Envelope envelope)
MediaTrack BR_EnvGetParentTrack(BR_Envelope envelope)

[BR] Get parent track of envelope object allocated with BR_EnvAlloc. If take envelope, returns NULL.

bool BR_EnvGetPoint(BR_Envelope* envelope, int id, double* positionOut, double* valueOut, int* shapeOut, bool* selectedOut, double* bezierOut)
bool BR_EnvGetPoint(BR_Envelope envelope, int id, &position, &value, int &shape, bool &selected, &bezier) (requires REAPER 6.24 or later)
bool extension_api("BR_EnvGetPoint", BR_Envelope envelope, int id, &position, &value, int &shape, bool &selected, &bezier) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean retval, number position, number value, integer shape, boolean selected, number bezier = reaper.BR_EnvGetPoint(BR_Envelope envelope, integer id)
(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)

[BR] Get envelope point by id (zero-based) from the envelope object allocated with BR_EnvAlloc. Returns true on success.

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)
BR_EnvGetProperties(BR_Envelope envelope, bool &active, bool &visible, bool &armed, bool &inLane, int &laneHeight, int &defaultShape, &minValue, &maxValue, &centerValue, int &type, bool &faderScaling, optional int &automationItemsOptions) (requires REAPER 6.24 or later)
extension_api("BR_EnvGetProperties", BR_Envelope envelope, bool &active, bool &visible, bool &armed, bool &inLane, int &laneHeight, int &defaultShape, &minValue, &maxValue, &centerValue, int &type, bool &faderScaling, optional int &automationItemsOptions) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean active, boolean visible, boolean armed, boolean inLane, integer laneHeight, integer defaultShape, number minValue, number maxValue, number centerValue, integer type, boolean faderScaling, optional integer automationItemsOptions = reaper.BR_EnvGetProperties(BR_Envelope envelope)
(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)

[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.

bool BR_EnvSetPoint(BR_Envelope* envelope, int id, double position, double value, int shape, bool selected, double bezier)
bool BR_EnvSetPoint(BR_Envelope envelope, int id, position, value, int shape, bool selected, bezier) (requires REAPER 6.24 or later)
bool extension_api("BR_EnvSetPoint", BR_Envelope envelope, int id, position, value, int shape, bool selected, bezier) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.BR_EnvSetPoint(BR_Envelope envelope, integer id, number position, number value, integer shape, boolean selected, number bezier)
Boolean BR_EnvSetPoint(BR_Envelope envelope, Int id, Float position, Float value, Int shape, Boolean selected, Float bezier)

[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.

void BR_EnvSetProperties(BR_Envelope* envelope, bool active, bool visible, bool armed, bool inLane, int laneHeight, int defaultShape, bool faderScaling, int* automationItemsOptionsInOptional)
BR_EnvSetProperties(BR_Envelope envelope, bool active, bool visible, bool armed, bool inLane, int laneHeight, int defaultShape, bool faderScaling, optional int automationItemsOptionsIn) (requires REAPER 6.24 or later)
extension_api("BR_EnvSetProperties", BR_Envelope envelope, bool active, bool visible, bool armed, bool inLane, int laneHeight, int defaultShape, bool faderScaling, optional int automationItemsOptionsIn) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
reaper.BR_EnvSetProperties(BR_Envelope envelope, boolean active, boolean visible, boolean armed, boolean inLane, integer laneHeight, integer defaultShape, boolean faderScaling, optional integer automationItemsOptionsIn)
(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)

[BR] Set envelope properties for the envelope object allocated with BR_EnvAlloc. For parameter description see BR_EnvGetProperties.
Setting automationItemsOptions requires REAPER 5.979+.

void BR_EnvSortPoints(BR_Envelope* envelope)
BR_EnvSortPoints(BR_Envelope envelope) (requires REAPER 6.24 or later)
extension_api("BR_EnvSortPoints", BR_Envelope envelope) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
reaper.BR_EnvSortPoints(BR_Envelope envelope)
BR_EnvSortPoints(BR_Envelope envelope)

[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.

double BR_EnvValueAtPos(BR_Envelope* envelope, double position)
double BR_EnvValueAtPos(BR_Envelope envelope, position) (requires REAPER 6.24 or later)
double extension_api("BR_EnvValueAtPos", BR_Envelope envelope, position) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
number reaper.BR_EnvValueAtPos(BR_Envelope envelope, number position)
Float BR_EnvValueAtPos(BR_Envelope envelope, Float position)

[BR] Get envelope value at time position for the envelope object allocated with BR_EnvAlloc.

void BR_GetArrangeView(ReaProject* proj, double* startTimeOut, double* endTimeOut)
BR_GetArrangeView(ReaProject proj, &startTime, &endTime) (requires REAPER 6.24 or later)
extension_api("BR_GetArrangeView", ReaProject proj, &startTime, &endTime) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
number startTime, number endTime = reaper.BR_GetArrangeView(ReaProject proj)
(ReaProject proj, Float startTimeOut, Float endTimeOut) = BR_GetArrangeView(proj, startTimeOut, endTimeOut)

[BR] Deprecated, see GetSet_ArrangeView2 (REAPER v5.12pre4+) -- Get start and end time position of arrange view. To set arrange view instead, see BR_SetArrangeView.

double BR_GetClosestGridDivision(double position)
double BR_GetClosestGridDivision(position) (requires REAPER 6.24 or later)
double extension_api("BR_GetClosestGridDivision", position) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
number reaper.BR_GetClosestGridDivision(number position)
Float BR_GetClosestGridDivision(Float position)

[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.

void BR_GetCurrentTheme(char* themePathOut, int themePathOut_sz, char* themeNameOut, int themeNameOut_sz)
BR_GetCurrentTheme(#themePath, #themeName) (requires REAPER 6.24 or later)
extension_api("BR_GetCurrentTheme", #themePath, #themeName) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
string themePath, string themeName = reaper.BR_GetCurrentTheme()
(String themePathOut, Int themePathOut_sz, String themeNameOut, Int themeNameOut_sz) = BR_GetCurrentTheme(themePathOut, themePathOut_sz, themeNameOut, themeNameOut_sz)

[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

MediaItem* BR_GetMediaItemByGUID(ReaProject* proj, const char* guidStringIn)
MediaItem BR_GetMediaItemByGUID(ReaProject proj, "guidStringIn") (requires REAPER 6.24 or later)
MediaItem extension_api("BR_GetMediaItemByGUID", ReaProject proj, "guidStringIn") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
MediaItem reaper.BR_GetMediaItemByGUID(ReaProject proj, string guidStringIn)
MediaItem BR_GetMediaItemByGUID(ReaProject proj, String guidStringIn)

[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.

void BR_GetMediaItemGUID(MediaItem* item, char* guidStringOut, int guidStringOut_sz)
BR_GetMediaItemGUID(MediaItem item, #guidString) (requires REAPER 6.24 or later)
extension_api("BR_GetMediaItemGUID", MediaItem item, #guidString) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
string guidString = reaper.BR_GetMediaItemGUID(MediaItem item)
(MediaItem item, String guidStringOut, Int guidStringOut_sz) = BR_GetMediaItemGUID(item, guidStringOut, guidStringOut_sz)

[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.

bool BR_GetMediaItemImageResource(MediaItem* item, char* imageOut, int imageOut_sz, int* imageFlagsOut)
bool BR_GetMediaItemImageResource(MediaItem item, #image, int &imageFlags) (requires REAPER 6.24 or later)
bool extension_api("BR_GetMediaItemImageResource", MediaItem item, #image, int &imageFlags) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean retval, string image, integer imageFlags = reaper.BR_GetMediaItemImageResource(MediaItem item)
(Boolean retval, MediaItem item, String imageOut, Int imageOut_sz, Int imageFlagsOut) = BR_GetMediaItemImageResource(item, imageOut, imageOut_sz, imageFlagsOut)

[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.

void BR_GetMediaItemTakeGUID(MediaItem_Take* take, char* guidStringOut, int guidStringOut_sz)
BR_GetMediaItemTakeGUID(MediaItem_Take take, #guidString) (requires REAPER 6.24 or later)
extension_api("BR_GetMediaItemTakeGUID", MediaItem_Take take, #guidString) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
string guidString = reaper.BR_GetMediaItemTakeGUID(MediaItem_Take take)
(MediaItem_Take take, String guidStringOut, Int guidStringOut_sz) = BR_GetMediaItemTakeGUID(take, guidStringOut, guidStringOut_sz)

[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.

bool BR_GetMediaSourceProperties(MediaItem_Take* take, bool* sectionOut, double* startOut, double* lengthOut, double* fadeOut, bool* reverseOut)
bool BR_GetMediaSourceProperties(MediaItem_Take take, bool &section, &start, &length, &fade, bool &reverse) (requires REAPER 6.24 or later)
bool extension_api("BR_GetMediaSourceProperties", MediaItem_Take take, bool &section, &start, &length, &fade, bool &reverse) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean retval, boolean section, number start, number length, number fade, boolean reverse = reaper.BR_GetMediaSourceProperties(MediaItem_Take take)
(Boolean retval, MediaItem_Take take, Boolean sectionOut, Float startOut, Float lengthOut, Float fadeOut, Boolean reverseOut) = BR_GetMediaSourceProperties(take, sectionOut, startOut, lengthOut, fadeOut, reverseOut)

[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.

MediaTrack* BR_GetMediaTrackByGUID(ReaProject* proj, const char* guidStringIn)
MediaTrack BR_GetMediaTrackByGUID(ReaProject proj, "guidStringIn") (requires REAPER 6.24 or later)
MediaTrack extension_api("BR_GetMediaTrackByGUID", ReaProject proj, "guidStringIn") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
MediaTrack reaper.BR_GetMediaTrackByGUID(ReaProject proj, string guidStringIn)
MediaTrack BR_GetMediaTrackByGUID(ReaProject proj, String guidStringIn)

[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.

int BR_GetMediaTrackFreezeCount(MediaTrack* track)
int BR_GetMediaTrackFreezeCount(MediaTrack track) (requires REAPER 6.24 or later)
int extension_api("BR_GetMediaTrackFreezeCount", MediaTrack track) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.BR_GetMediaTrackFreezeCount(MediaTrack track)
Int BR_GetMediaTrackFreezeCount(MediaTrack track)

[BR] Get media track freeze count (if track isn't frozen at all, returns 0).

void BR_GetMediaTrackGUID(MediaTrack* track, char* guidStringOut, int guidStringOut_sz)
BR_GetMediaTrackGUID(MediaTrack track, #guidString) (requires REAPER 6.24 or later)
extension_api("BR_GetMediaTrackGUID", MediaTrack track, #guidString) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
string guidString = reaper.BR_GetMediaTrackGUID(MediaTrack track)
(MediaTrack track, String guidStringOut, Int guidStringOut_sz) = BR_GetMediaTrackGUID(track, guidStringOut, guidStringOut_sz)

[BR] Deprecated, see GetSetMediaTrackInfo_String (v5.95+). Get media track GUID as a string (guidStringOut_sz should be at least 64). To get media track back from GUID string, see BR_GetMediaTrackByGUID.

void BR_GetMediaTrackLayouts(MediaTrack* track, char* mcpLayoutNameOut, int mcpLayoutNameOut_sz, char* tcpLayoutNameOut, int tcpLayoutNameOut_sz)
BR_GetMediaTrackLayouts(MediaTrack track, #mcpLayoutName, #tcpLayoutName) (requires REAPER 6.24 or later)
extension_api("BR_GetMediaTrackLayouts", MediaTrack track, #mcpLayoutName, #tcpLayoutName) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
string mcpLayoutName, string tcpLayoutName = reaper.BR_GetMediaTrackLayouts(MediaTrack track)
(MediaTrack track, String mcpLayoutNameOut, Int mcpLayoutNameOut_sz, String tcpLayoutNameOut, Int tcpLayoutNameOut_sz) = BR_GetMediaTrackLayouts(track, mcpLayoutNameOut, mcpLayoutNameOut_sz, tcpLayoutNameOut, tcpLayoutNameOut_sz)

[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.

TrackEnvelope* BR_GetMediaTrackSendInfo_Envelope(MediaTrack* track, int category, int sendidx, int envelopeType)
TrackEnvelope BR_GetMediaTrackSendInfo_Envelope(MediaTrack track, int category, int sendidx, int envelopeType) (requires REAPER 6.24 or later)
TrackEnvelope extension_api("BR_GetMediaTrackSendInfo_Envelope", MediaTrack track, int category, int sendidx, int envelopeType) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
TrackEnvelope reaper.BR_GetMediaTrackSendInfo_Envelope(MediaTrack track, integer category, integer sendidx, integer envelopeType)
TrackEnvelope BR_GetMediaTrackSendInfo_Envelope(MediaTrack track, Int category, Int sendidx, Int envelopeType)

[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.

MediaTrack* BR_GetMediaTrackSendInfo_Track(MediaTrack* track, int category, int sendidx, int trackType)
MediaTrack BR_GetMediaTrackSendInfo_Track(MediaTrack track, int category, int sendidx, int trackType) (requires REAPER 6.24 or later)
MediaTrack extension_api("BR_GetMediaTrackSendInfo_Track", MediaTrack track, int category, int sendidx, int trackType) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
MediaTrack reaper.BR_GetMediaTrackSendInfo_Track(MediaTrack track, integer category, integer sendidx, integer trackType)
MediaTrack BR_GetMediaTrackSendInfo_Track(MediaTrack track, Int category, Int sendidx, Int trackType)

[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.

double BR_GetMidiSourceLenPPQ(MediaItem_Take* take)
double BR_GetMidiSourceLenPPQ(MediaItem_Take take) (requires REAPER 6.24 or later)
double extension_api("BR_GetMidiSourceLenPPQ", MediaItem_Take take) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
number reaper.BR_GetMidiSourceLenPPQ(MediaItem_Take take)
Float BR_GetMidiSourceLenPPQ(MediaItem_Take take)

[BR] Get MIDI take source length in PPQ. In case the take isn't MIDI, return value will be -1.

bool BR_GetMidiTakePoolGUID(MediaItem_Take* take, char* guidStringOut, int guidStringOut_sz)
bool BR_GetMidiTakePoolGUID(MediaItem_Take take, #guidString) (requires REAPER 6.24 or later)
bool extension_api("BR_GetMidiTakePoolGUID", MediaItem_Take take, #guidString) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean retval, string guidString = reaper.BR_GetMidiTakePoolGUID(MediaItem_Take take)
(Boolean retval, MediaItem_Take take, String guidStringOut, Int guidStringOut_sz) = BR_GetMidiTakePoolGUID(take, guidStringOut, guidStringOut_sz)

[BR] Get MIDI take pool GUID as a string (guidStringOut_sz should be at least 64). Returns true if take is pooled.

bool BR_GetMidiTakeTempoInfo(MediaItem_Take* take, bool* ignoreProjTempoOut, double* bpmOut, int* numOut, int* denOut)
bool BR_GetMidiTakeTempoInfo(MediaItem_Take take, bool &ignoreProjTempo, &bpm, int &num, int &den) (requires REAPER 6.24 or later)
bool extension_api("BR_GetMidiTakeTempoInfo", MediaItem_Take take, bool &ignoreProjTempo, &bpm, int &num, int &den) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean retval, boolean ignoreProjTempo, number bpm, integer num, integer den = reaper.BR_GetMidiTakeTempoInfo(MediaItem_Take take)
(Boolean retval, MediaItem_Take take, Boolean ignoreProjTempoOut, Float bpmOut, Int numOut, Int denOut) = BR_GetMidiTakeTempoInfo(take, ignoreProjTempoOut, bpmOut, numOut, denOut)

[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.

void BR_GetMouseCursorContext(char* windowOut, int windowOut_sz, char* segmentOut, int segmentOut_sz, char* detailsOut, int detailsOut_sz)
BR_GetMouseCursorContext(#window, #segment, #details) (requires REAPER 6.24 or later)
extension_api("BR_GetMouseCursorContext", #window, #segment, #details) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
string window, string segment, string details = reaper.BR_GetMouseCursorContext()
(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)

[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
TrackEnvelope* BR_GetMouseCursorContext_Envelope(bool* takeEnvelopeOut)
TrackEnvelope BR_GetMouseCursorContext_Envelope(bool &takeEnvelope) (requires REAPER 6.24 or later)
TrackEnvelope extension_api("BR_GetMouseCursorContext_Envelope", bool &takeEnvelope) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
TrackEnvelope retval, boolean takeEnvelope = reaper.BR_GetMouseCursorContext_Envelope()
(TrackEnvelope retval, Boolean takeEnvelopeOut) = BR_GetMouseCursorContext_Envelope(takeEnvelopeOut)

[BR] Returns envelope that was captured with the last call to BR_GetMouseCursorContext. In case the envelope belongs to take, takeEnvelope will be true.

MediaItem* BR_GetMouseCursorContext_Item()
MediaItem BR_GetMouseCursorContext_Item() (requires REAPER 6.24 or later)
MediaItem extension_api("BR_GetMouseCursorContext_Item") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
MediaItem reaper.BR_GetMouseCursorContext_Item()
MediaItem BR_GetMouseCursorContext_Item()

[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.

void* BR_GetMouseCursorContext_MIDI(bool* inlineEditorOut, int* noteRowOut, int* ccLaneOut, int* ccLaneValOut, int* ccLaneIdOut)
void* BR_GetMouseCursorContext_MIDI(bool &inlineEditor, int &noteRow, int &ccLane, int &ccLaneVal, int &ccLaneId) (requires REAPER 6.24 or later)
void* extension_api("BR_GetMouseCursorContext_MIDI", bool &inlineEditor, int &noteRow, int &ccLane, int &ccLaneVal, int &ccLaneId) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
identifier retval, boolean inlineEditor, integer noteRow, integer ccLane, integer ccLaneVal, integer ccLaneId = reaper.BR_GetMouseCursorContext_MIDI()
(void retval, Boolean inlineEditorOut, Int noteRowOut, Int ccLaneOut, Int ccLaneValOut, Int ccLaneIdOut) = BR_GetMouseCursorContext_MIDI(inlineEditorOut, noteRowOut, ccLaneOut, ccLaneValOut, ccLaneIdOut)

[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

double BR_GetMouseCursorContext_Position()
double BR_GetMouseCursorContext_Position() (requires REAPER 6.24 or later)
double extension_api("BR_GetMouseCursorContext_Position") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
number reaper.BR_GetMouseCursorContext_Position()
Float BR_GetMouseCursorContext_Position()

[BR] Returns project time position in arrange/ruler/midi editor that was captured with the last call to BR_GetMouseCursorContext.

int BR_GetMouseCursorContext_StretchMarker()
int BR_GetMouseCursorContext_StretchMarker() (requires REAPER 6.24 or later)
int extension_api("BR_GetMouseCursorContext_StretchMarker") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.BR_GetMouseCursorContext_StretchMarker()
Int BR_GetMouseCursorContext_StretchMarker()

[BR] Returns id of a stretch marker under mouse cursor that was captured with the last call to BR_GetMouseCursorContext.

MediaItem_Take* BR_GetMouseCursorContext_Take()
MediaItem_Take BR_GetMouseCursorContext_Take() (requires REAPER 6.24 or later)
MediaItem_Take extension_api("BR_GetMouseCursorContext_Take") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
MediaItem_Take reaper.BR_GetMouseCursorContext_Take()
MediaItem_Take BR_GetMouseCursorContext_Take()

[BR] Returns take under mouse cursor that was captured with the last call to BR_GetMouseCursorContext.

MediaTrack* BR_GetMouseCursorContext_Track()
MediaTrack BR_GetMouseCursorContext_Track() (requires REAPER 6.24 or later)
MediaTrack extension_api("BR_GetMouseCursorContext_Track") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
MediaTrack reaper.BR_GetMouseCursorContext_Track()
MediaTrack BR_GetMouseCursorContext_Track()

[BR] Returns track under mouse cursor that was captured with the last call to BR_GetMouseCursorContext.

double BR_GetNextGridDivision(double position)
double BR_GetNextGridDivision(position) (requires REAPER 6.24 or later)
double extension_api("BR_GetNextGridDivision", position) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
number reaper.BR_GetNextGridDivision(number position)
Float BR_GetNextGridDivision(Float position)

[BR] Get next grid division after the time position. For more grid divisions function, see BR_GetClosestGridDivision and BR_GetPrevGridDivision.

double BR_GetPrevGridDivision(double position)
double BR_GetPrevGridDivision(position) (requires REAPER 6.24 or later)
double extension_api("BR_GetPrevGridDivision", position) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
number reaper.BR_GetPrevGridDivision(number position)
Float BR_GetPrevGridDivision(Float position)

[BR] Get previous grid division before the time position. For more grid division functions, see BR_GetClosestGridDivision and BR_GetNextGridDivision.

double BR_GetSetTrackSendInfo(MediaTrack* track, int category, int sendidx, const char* parmname, bool setNewValue, double newValue)
double BR_GetSetTrackSendInfo(MediaTrack track, int category, int sendidx, "parmname", bool setNewValue, newValue) (requires REAPER 6.24 or later)
double extension_api("BR_GetSetTrackSendInfo", MediaTrack track, int category, int sendidx, "parmname", bool setNewValue, newValue) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
number reaper.BR_GetSetTrackSendInfo(MediaTrack track, integer category, integer sendidx, string parmname, boolean setNewValue, number newValue)
Float BR_GetSetTrackSendInfo(MediaTrack track, Int category, Int sendidx, String parmname, Boolean setNewValue, Float newValue)

[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.

int BR_GetTakeFXCount(MediaItem_Take* take)
int BR_GetTakeFXCount(MediaItem_Take take) (requires REAPER 6.24 or later)
int extension_api("BR_GetTakeFXCount", MediaItem_Take take) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.BR_GetTakeFXCount(MediaItem_Take take)
Int BR_GetTakeFXCount(MediaItem_Take take)

[BR] Returns FX count for supplied take

bool BR_IsMidiOpenInInlineEditor(MediaItem_Take* take)
bool BR_IsMidiOpenInInlineEditor(MediaItem_Take take) (requires REAPER 6.24 or later)
bool extension_api("BR_IsMidiOpenInInlineEditor", MediaItem_Take take) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.BR_IsMidiOpenInInlineEditor(MediaItem_Take take)
Boolean BR_IsMidiOpenInInlineEditor(MediaItem_Take take)

[SWS] Check if take has MIDI inline editor open and returns true or false.

bool BR_IsTakeMidi(MediaItem_Take* take, bool* inProjectMidiOut)
bool BR_IsTakeMidi(MediaItem_Take take, bool &inProjectMidi) (requires REAPER 6.24 or later)
bool extension_api("BR_IsTakeMidi", MediaItem_Take take, bool &inProjectMidi) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean retval, boolean inProjectMidi = reaper.BR_IsTakeMidi(MediaItem_Take take)
(Boolean retval, MediaItem_Take take, Boolean inProjectMidiOut) = BR_IsTakeMidi(take, inProjectMidiOut)

[BR] Check if take is MIDI take, in case MIDI take is in-project MIDI source data, inProjectMidiOut will be true, otherwise false.

MediaItem* BR_ItemAtMouseCursor(double* positionOut)
MediaItem BR_ItemAtMouseCursor(&position) (requires REAPER 6.24 or later)
MediaItem extension_api("BR_ItemAtMouseCursor", &position) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
MediaItem retval, number position = reaper.BR_ItemAtMouseCursor()
(MediaItem retval, Float positionOut) = BR_ItemAtMouseCursor(positionOut)

[BR] Get media item under mouse cursor. Position is mouse cursor position in arrange.

bool BR_MIDI_CCLaneRemove(void* midiEditor, int laneId)
bool BR_MIDI_CCLaneRemove(void* midiEditor, int laneId) (requires REAPER 6.24 or later)
bool extension_api("BR_MIDI_CCLaneRemove", void* midiEditor, int laneId) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.BR_MIDI_CCLaneRemove(identifier midiEditor, integer laneId)
Boolean BR_MIDI_CCLaneRemove(void midiEditor, Int laneId)

[BR] Remove CC lane in midi editor. Top visible CC lane is laneId 0. Returns true on success

bool BR_MIDI_CCLaneReplace(void* midiEditor, int laneId, int newCC)
bool BR_MIDI_CCLaneReplace(void* midiEditor, int laneId, int newCC) (requires REAPER 6.24 or later)
bool extension_api("BR_MIDI_CCLaneReplace", void* midiEditor, int laneId, int newCC) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.BR_MIDI_CCLaneReplace(identifier midiEditor, integer laneId, integer newCC)
Boolean BR_MIDI_CCLaneReplace(void midiEditor, Int laneId, Int newCC)

[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

double BR_PositionAtMouseCursor(bool checkRuler)
double BR_PositionAtMouseCursor(bool checkRuler) (requires REAPER 6.24 or later)
double extension_api("BR_PositionAtMouseCursor", bool checkRuler) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
number reaper.BR_PositionAtMouseCursor(boolean checkRuler)
Float BR_PositionAtMouseCursor(Boolean checkRuler)

[BR] Get position at mouse cursor. To check ruler along with arrange, pass checkRuler=true. Returns -1 if cursor is not over arrange/ruler.

void BR_SetArrangeView(ReaProject* proj, double startTime, double endTime)
BR_SetArrangeView(ReaProject proj, startTime, endTime) (requires REAPER 6.24 or later)
extension_api("BR_SetArrangeView", ReaProject proj, startTime, endTime) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
reaper.BR_SetArrangeView(ReaProject proj, number startTime, number endTime)
BR_SetArrangeView(ReaProject proj, Float startTime, Float endTime)

[BR] Deprecated, see GetSet_ArrangeView2 (REAPER v5.12pre4+) -- Set start and end time position of arrange view. To get arrange view instead, see BR_GetArrangeView.

bool BR_SetItemEdges(MediaItem* item, double startTime, double endTime)
bool BR_SetItemEdges(MediaItem item, startTime, endTime) (requires REAPER 6.24 or later)
bool extension_api("BR_SetItemEdges", MediaItem item, startTime, endTime) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.BR_SetItemEdges(MediaItem item, number startTime, number endTime)
Boolean BR_SetItemEdges(MediaItem item, Float startTime, Float endTime)

[BR] Set item start and end edges' position - returns true in case of any changes

void BR_SetMediaItemImageResource(MediaItem* item, const char* imageIn, int imageFlags)
BR_SetMediaItemImageResource(MediaItem item, "imageIn", int imageFlags) (requires REAPER 6.24 or later)
extension_api("BR_SetMediaItemImageResource", MediaItem item, "imageIn", int imageFlags) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
reaper.BR_SetMediaItemImageResource(MediaItem item, string imageIn, integer imageFlags)
BR_SetMediaItemImageResource(MediaItem item, String imageIn, Int imageFlags)

[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.

bool BR_SetMediaSourceProperties(MediaItem_Take* take, bool section, double start, double length, double fade, bool reverse)
bool BR_SetMediaSourceProperties(MediaItem_Take take, bool section, start, length, fade, bool reverse) (requires REAPER 6.24 or later)
bool extension_api("BR_SetMediaSourceProperties", MediaItem_Take take, bool section, start, length, fade, bool reverse) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.BR_SetMediaSourceProperties(MediaItem_Take take, boolean section, number start, number length, number fade, boolean reverse)
Boolean BR_SetMediaSourceProperties(MediaItem_Take take, Boolean section, Float start, Float length, Float fade, Boolean reverse)

[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.

bool BR_SetMediaTrackLayouts(MediaTrack* track, const char* mcpLayoutNameIn, const char* tcpLayoutNameIn)
bool BR_SetMediaTrackLayouts(MediaTrack track, "mcpLayoutNameIn", "tcpLayoutNameIn") (requires REAPER 6.24 or later)
bool extension_api("BR_SetMediaTrackLayouts", MediaTrack track, "mcpLayoutNameIn", "tcpLayoutNameIn") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.BR_SetMediaTrackLayouts(MediaTrack track, string mcpLayoutNameIn, string tcpLayoutNameIn)
Boolean BR_SetMediaTrackLayouts(MediaTrack track, String mcpLayoutNameIn, String tcpLayoutNameIn)

[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.

bool BR_SetMidiTakeTempoInfo(MediaItem_Take* take, bool ignoreProjTempo, double bpm, int num, int den)
bool BR_SetMidiTakeTempoInfo(MediaItem_Take take, bool ignoreProjTempo, bpm, int num, int den) (requires REAPER 6.24 or later)
bool extension_api("BR_SetMidiTakeTempoInfo", MediaItem_Take take, bool ignoreProjTempo, bpm, int num, int den) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.BR_SetMidiTakeTempoInfo(MediaItem_Take take, boolean ignoreProjTempo, number bpm, integer num, integer den)
Boolean BR_SetMidiTakeTempoInfo(MediaItem_Take take, Boolean ignoreProjTempo, Float bpm, Int num, Int den)

[BR] Set "ignore project tempo" information for MIDI take. Returns true in case the take was successfully updated.

bool BR_SetTakeSourceFromFile(MediaItem_Take* take, const char* filenameIn, bool inProjectData)
bool BR_SetTakeSourceFromFile(MediaItem_Take take, "filenameIn", bool inProjectData) (requires REAPER 6.24 or later)
bool extension_api("BR_SetTakeSourceFromFile", MediaItem_Take take, "filenameIn", bool inProjectData) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.BR_SetTakeSourceFromFile(MediaItem_Take take, string filenameIn, boolean inProjectData)
Boolean BR_SetTakeSourceFromFile(MediaItem_Take take, String filenameIn, Boolean inProjectData)

[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.

bool BR_SetTakeSourceFromFile2(MediaItem_Take* take, const char* filenameIn, bool inProjectData, bool keepSourceProperties)
bool BR_SetTakeSourceFromFile2(MediaItem_Take take, "filenameIn", bool inProjectData, bool keepSourceProperties) (requires REAPER 6.24 or later)
bool extension_api("BR_SetTakeSourceFromFile2", MediaItem_Take take, "filenameIn", bool inProjectData, bool keepSourceProperties) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.BR_SetTakeSourceFromFile2(MediaItem_Take take, string filenameIn, boolean inProjectData, boolean keepSourceProperties)
Boolean BR_SetTakeSourceFromFile2(MediaItem_Take take, String filenameIn, Boolean inProjectData, Boolean keepSourceProperties)

[BR] Differs from BR_SetTakeSourceFromFile only that it can also preserve existing take media source properties.

MediaItem_Take* BR_TakeAtMouseCursor(double* positionOut)
MediaItem_Take BR_TakeAtMouseCursor(&position) (requires REAPER 6.24 or later)
MediaItem_Take extension_api("BR_TakeAtMouseCursor", &position) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
MediaItem_Take retval, number position = reaper.BR_TakeAtMouseCursor()
(MediaItem_Take retval, Float positionOut) = BR_TakeAtMouseCursor(positionOut)

[BR] Get take under mouse cursor. Position is mouse cursor position in arrange.

MediaTrack* BR_TrackAtMouseCursor(int* contextOut, double* positionOut)
MediaTrack BR_TrackAtMouseCursor(int &context, &position) (requires REAPER 6.24 or later)
MediaTrack extension_api("BR_TrackAtMouseCursor", int &context, &position) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
MediaTrack retval, integer context, number position = reaper.BR_TrackAtMouseCursor()
(MediaTrack retval, Int contextOut, Float positionOut) = BR_TrackAtMouseCursor(contextOut, positionOut)

[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.

bool BR_TrackFX_GetFXModuleName(MediaTrack* track, int fx, char* nameOut, int nameOut_sz)
bool BR_TrackFX_GetFXModuleName(MediaTrack track, int fx, #name) (requires REAPER 6.24 or later)
bool extension_api("BR_TrackFX_GetFXModuleName", MediaTrack track, int fx, #name) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean retval, string name = reaper.BR_TrackFX_GetFXModuleName(MediaTrack track, integer fx)
(Boolean retval, MediaTrack track, Int fx, String nameOut, Int nameOut_sz) = BR_TrackFX_GetFXModuleName(track, fx, nameOut, nameOut_sz)

[BR] Get the exact name (like effect.dll, effect.vst3, etc...) of an FX.

int BR_Win32_CB_FindString(void* comboBoxHwnd, int startId, const char* string)
int BR_Win32_CB_FindString(void* comboBoxHwnd, int startId, "string") (requires REAPER 6.24 or later)
int extension_api("BR_Win32_CB_FindString", void* comboBoxHwnd, int startId, "string") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.BR_Win32_CB_FindString(identifier comboBoxHwnd, integer startId, string string)
Int BR_Win32_CB_FindString(void comboBoxHwnd, Int startId, String string)

[BR] Equivalent to win32 API ComboBox_FindString().

int BR_Win32_CB_FindStringExact(void* comboBoxHwnd, int startId, const char* string)
int BR_Win32_CB_FindStringExact(void* comboBoxHwnd, int startId, "string") (requires REAPER 6.24 or later)
int extension_api("BR_Win32_CB_FindStringExact", void* comboBoxHwnd, int startId, "string") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.BR_Win32_CB_FindStringExact(identifier comboBoxHwnd, integer startId, string string)
Int BR_Win32_CB_FindStringExact(void comboBoxHwnd, Int startId, String string)

[BR] Equivalent to win32 API ComboBox_FindStringExact().

void BR_Win32_ClientToScreen(void* hwnd, int xIn, int yIn, int* xOut, int* yOut)
BR_Win32_ClientToScreen(void* hwnd, int xIn, int yIn, int &x, int &y) (requires REAPER 6.24 or later)
extension_api("BR_Win32_ClientToScreen", void* hwnd, int xIn, int yIn, int &x, int &y) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer x, integer y = reaper.BR_Win32_ClientToScreen(identifier hwnd, integer xIn, integer yIn)
(void hwnd, Int xIn, Int yIn, Int xOut, Int yOut) = BR_Win32_ClientToScreen(hwnd, xIn, yIn, xOut, yOut)

[BR] Equivalent to win32 API ClientToScreen().

void* BR_Win32_FindWindowEx(const char* hwndParent, const char* hwndChildAfter, const char* className, const char* windowName, bool searchClass, bool searchName)
void* BR_Win32_FindWindowEx("hwndParent", "hwndChildAfter", "className", "windowName", bool searchClass, bool searchName) (requires REAPER 6.24 or later)
void* extension_api("BR_Win32_FindWindowEx", "hwndParent", "hwndChildAfter", "className", "windowName", bool searchClass, bool searchName) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
identifier reaper.BR_Win32_FindWindowEx(string hwndParent, string hwndChildAfter, string className, string windowName, boolean searchClass, boolean searchName)
void BR_Win32_FindWindowEx(String hwndParent, String hwndChildAfter, String className, String windowName, Boolean searchClass, Boolean searchName)

[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.

int BR_Win32_GET_X_LPARAM(int lParam)
int BR_Win32_GET_X_LPARAM(int lParam) (requires REAPER 6.24 or later)
int extension_api("BR_Win32_GET_X_LPARAM", int lParam) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.BR_Win32_GET_X_LPARAM(integer lParam)
Int BR_Win32_GET_X_LPARAM(Int lParam)

[BR] Equivalent to win32 API GET_X_LPARAM().

int BR_Win32_GET_Y_LPARAM(int lParam)
int BR_Win32_GET_Y_LPARAM(int lParam) (requires REAPER 6.24 or later)
int extension_api("BR_Win32_GET_Y_LPARAM", int lParam) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.BR_Win32_GET_Y_LPARAM(integer lParam)
Int BR_Win32_GET_Y_LPARAM(Int lParam)

[BR] Equivalent to win32 API GET_Y_LPARAM().

int BR_Win32_GetConstant(const char* constantName)
int BR_Win32_GetConstant("constantName") (requires REAPER 6.24 or later)
int extension_api("BR_Win32_GetConstant", "constantName") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.BR_Win32_GetConstant(string constantName)
Int BR_Win32_GetConstant(String constantName)

[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

bool BR_Win32_GetCursorPos(int* xOut, int* yOut)
bool BR_Win32_GetCursorPos(int &x, int &y) (requires REAPER 6.24 or later)
bool extension_api("BR_Win32_GetCursorPos", int &x, int &y) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean retval, integer x, integer y = reaper.BR_Win32_GetCursorPos()
(Boolean retval, Int xOut, Int yOut) = BR_Win32_GetCursorPos(xOut, yOut)

[BR] Equivalent to win32 API GetCursorPos().

void* BR_Win32_GetFocus()
void* BR_Win32_GetFocus() (requires REAPER 6.24 or later)
void* extension_api("BR_Win32_GetFocus") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
identifier reaper.BR_Win32_GetFocus()
void BR_Win32_GetFocus()

[BR] Equivalent to win32 API GetFocus().

void* BR_Win32_GetForegroundWindow()
void* BR_Win32_GetForegroundWindow() (requires REAPER 6.24 or later)
void* extension_api("BR_Win32_GetForegroundWindow") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
identifier reaper.BR_Win32_GetForegroundWindow()
void BR_Win32_GetForegroundWindow()

[BR] Equivalent to win32 API GetForegroundWindow().

void* BR_Win32_GetMainHwnd()
void* BR_Win32_GetMainHwnd() (requires REAPER 6.24 or later)
void* extension_api("BR_Win32_GetMainHwnd") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
identifier reaper.BR_Win32_GetMainHwnd()
void BR_Win32_GetMainHwnd()

[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

void* BR_Win32_GetMixerHwnd(bool* isDockedOut)
void* BR_Win32_GetMixerHwnd(bool &isDocked) (requires REAPER 6.24 or later)
void* extension_api("BR_Win32_GetMixerHwnd", bool &isDocked) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
identifier retval, boolean isDocked = reaper.BR_Win32_GetMixerHwnd()
(void retval, Boolean isDockedOut) = BR_Win32_GetMixerHwnd(isDockedOut)

[BR] Get mixer window HWND. isDockedOut will be set to true if mixer is docked

void BR_Win32_GetMonitorRectFromRect(bool workingAreaOnly, int leftIn, int topIn, int rightIn, int bottomIn, int* leftOut, int* topOut, int* rightOut, int* bottomOut)
BR_Win32_GetMonitorRectFromRect(bool workingAreaOnly, int leftIn, int topIn, int rightIn, int bottomIn, int &left, int &top, int &right, int &bottom) (requires REAPER 6.24 or later)
extension_api("BR_Win32_GetMonitorRectFromRect", bool workingAreaOnly, int leftIn, int topIn, int rightIn, int bottomIn, int &left, int &top, int &right, int &bottom) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer left, integer top, integer right, integer bottom = reaper.BR_Win32_GetMonitorRectFromRect(boolean workingAreaOnly, integer leftIn, integer topIn, integer rightIn, integer bottomIn)
(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)

[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).

void* BR_Win32_GetParent(void* hwnd)
void* BR_Win32_GetParent(void* hwnd) (requires REAPER 6.24 or later)
void* extension_api("BR_Win32_GetParent", void* hwnd) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
identifier reaper.BR_Win32_GetParent(identifier hwnd)
void BR_Win32_GetParent(void hwnd)

[BR] Equivalent to win32 API GetParent().

int BR_Win32_GetPrivateProfileString(const char* sectionName, const char* keyName, const char* defaultString, const char* filePath, char* stringOut, int stringOut_sz)
int BR_Win32_GetPrivateProfileString("sectionName", "keyName", "defaultString", "filePath", #string) (requires REAPER 6.24 or later)
int extension_api("BR_Win32_GetPrivateProfileString", "sectionName", "keyName", "defaultString", "filePath", #string) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer retval, string string = reaper.BR_Win32_GetPrivateProfileString(string sectionName, string keyName, string defaultString, string filePath)
(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)

[BR] Equivalent to win32 API GetPrivateProfileString(). For example, you can use this to get values from REAPER.ini

void* BR_Win32_GetWindow(void* hwnd, int cmd)
void* BR_Win32_GetWindow(void* hwnd, int cmd) (requires REAPER 6.24 or later)
void* extension_api("BR_Win32_GetWindow", void* hwnd, int cmd) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
identifier reaper.BR_Win32_GetWindow(identifier hwnd, integer cmd)
void BR_Win32_GetWindow(void hwnd, Int cmd)

[BR] Equivalent to win32 API GetWindow().

int BR_Win32_GetWindowLong(void* hwnd, int index)
int BR_Win32_GetWindowLong(void* hwnd, int index) (requires REAPER 6.24 or later)
int extension_api("BR_Win32_GetWindowLong", void* hwnd, int index) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.BR_Win32_GetWindowLong(identifier hwnd, integer index)
Int BR_Win32_GetWindowLong(void hwnd, Int index)

[BR] Equivalent to win32 API GetWindowLong().

bool BR_Win32_GetWindowRect(void* hwnd, int* leftOut, int* topOut, int* rightOut, int* bottomOut)
bool BR_Win32_GetWindowRect(void* hwnd, int &left, int &top, int &right, int &bottom) (requires REAPER 6.24 or later)
bool extension_api("BR_Win32_GetWindowRect", void* hwnd, int &left, int &top, int &right, int &bottom) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean retval, integer left, integer top, integer right, integer bottom = reaper.BR_Win32_GetWindowRect(identifier hwnd)
(Boolean retval, void hwnd, Int leftOut, Int topOut, Int rightOut, Int bottomOut) = BR_Win32_GetWindowRect(hwnd, leftOut, topOut, rightOut, bottomOut)

[BR] Equivalent to win32 API GetWindowRect().

int BR_Win32_GetWindowText(void* hwnd, char* textOut, int textOut_sz)
int BR_Win32_GetWindowText(void* hwnd, #text) (requires REAPER 6.24 or later)
int extension_api("BR_Win32_GetWindowText", void* hwnd, #text) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer retval, string text = reaper.BR_Win32_GetWindowText(identifier hwnd)
(Int retval, void hwnd, String textOut, Int textOut_sz) = BR_Win32_GetWindowText(hwnd, textOut, textOut_sz)

[BR] Equivalent to win32 API GetWindowText().

int BR_Win32_HIBYTE(int value)
int BR_Win32_HIBYTE(int value) (requires REAPER 6.24 or later)
int extension_api("BR_Win32_HIBYTE", int value) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.BR_Win32_HIBYTE(integer value)
Int BR_Win32_HIBYTE(Int value)

[BR] Equivalent to win32 API HIBYTE().

int BR_Win32_HIWORD(int value)
int BR_Win32_HIWORD(int value) (requires REAPER 6.24 or later)
int extension_api("BR_Win32_HIWORD", int value) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.BR_Win32_HIWORD(integer value)
Int BR_Win32_HIWORD(Int value)

[BR] Equivalent to win32 API HIWORD().

void BR_Win32_HwndToString(void* hwnd, char* stringOut, int stringOut_sz)
BR_Win32_HwndToString(void* hwnd, #string) (requires REAPER 6.24 or later)
extension_api("BR_Win32_HwndToString", void* hwnd, #string) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
string string = reaper.BR_Win32_HwndToString(identifier hwnd)
(void hwnd, String stringOut, Int stringOut_sz) = BR_Win32_HwndToString(hwnd, stringOut, stringOut_sz)

[BR] Convert HWND to string. To convert string back to HWND, see BR_Win32_StringToHwnd.

bool BR_Win32_IsWindow(void* hwnd)
bool BR_Win32_IsWindow(void* hwnd) (requires REAPER 6.24 or later)
bool extension_api("BR_Win32_IsWindow", void* hwnd) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.BR_Win32_IsWindow(identifier hwnd)
Boolean BR_Win32_IsWindow(void hwnd)

[BR] Equivalent to win32 API IsWindow().

bool BR_Win32_IsWindowVisible(void* hwnd)
bool BR_Win32_IsWindowVisible(void* hwnd) (requires REAPER 6.24 or later)
bool extension_api("BR_Win32_IsWindowVisible", void* hwnd) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.BR_Win32_IsWindowVisible(identifier hwnd)
Boolean BR_Win32_IsWindowVisible(void hwnd)

[BR] Equivalent to win32 API IsWindowVisible().

int BR_Win32_LOBYTE(int value)
int BR_Win32_LOBYTE(int value) (requires REAPER 6.24 or later)
int extension_api("BR_Win32_LOBYTE", int value) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.BR_Win32_LOBYTE(integer value)
Int BR_Win32_LOBYTE(Int value)

[BR] Equivalent to win32 API LOBYTE().

int BR_Win32_LOWORD(int value)
int BR_Win32_LOWORD(int value) (requires REAPER 6.24 or later)
int extension_api("BR_Win32_LOWORD", int value) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.BR_Win32_LOWORD(integer value)
Int BR_Win32_LOWORD(Int value)

[BR] Equivalent to win32 API LOWORD().

int BR_Win32_MAKELONG(int low, int high)
int BR_Win32_MAKELONG(int low, int high) (requires REAPER 6.24 or later)
int extension_api("BR_Win32_MAKELONG", int low, int high) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.BR_Win32_MAKELONG(integer low, integer high)
Int BR_Win32_MAKELONG(Int low, Int high)

[BR] Equivalent to win32 API MAKELONG().

int BR_Win32_MAKELPARAM(int low, int high)
int BR_Win32_MAKELPARAM(int low, int high) (requires REAPER 6.24 or later)
int extension_api("BR_Win32_MAKELPARAM", int low, int high) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.BR_Win32_MAKELPARAM(integer low, integer high)
Int BR_Win32_MAKELPARAM(Int low, Int high)

[BR] Equivalent to win32 API MAKELPARAM().

int BR_Win32_MAKELRESULT(int low, int high)
int BR_Win32_MAKELRESULT(int low, int high) (requires REAPER 6.24 or later)
int extension_api("BR_Win32_MAKELRESULT", int low, int high) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.BR_Win32_MAKELRESULT(integer low, integer high)
Int BR_Win32_MAKELRESULT(Int low, Int high)

[BR] Equivalent to win32 API MAKELRESULT().

int BR_Win32_MAKEWORD(int low, int high)
int BR_Win32_MAKEWORD(int low, int high) (requires REAPER 6.24 or later)
int extension_api("BR_Win32_MAKEWORD", int low, int high) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.BR_Win32_MAKEWORD(integer low, integer high)
Int BR_Win32_MAKEWORD(Int low, Int high)

[BR] Equivalent to win32 API MAKEWORD().

int BR_Win32_MAKEWPARAM(int low, int high)
int BR_Win32_MAKEWPARAM(int low, int high) (requires REAPER 6.24 or later)
int extension_api("BR_Win32_MAKEWPARAM", int low, int high) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.BR_Win32_MAKEWPARAM(integer low, integer high)
Int BR_Win32_MAKEWPARAM(Int low, Int high)

[BR] Equivalent to win32 API MAKEWPARAM().

void* BR_Win32_MIDIEditor_GetActive()
void* BR_Win32_MIDIEditor_GetActive() (requires REAPER 6.24 or later)
void* extension_api("BR_Win32_MIDIEditor_GetActive") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
identifier reaper.BR_Win32_MIDIEditor_GetActive()
void BR_Win32_MIDIEditor_GetActive()

[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.

void BR_Win32_ScreenToClient(void* hwnd, int xIn, int yIn, int* xOut, int* yOut)
BR_Win32_ScreenToClient(void* hwnd, int xIn, int yIn, int &x, int &y) (requires REAPER 6.24 or later)
extension_api("BR_Win32_ScreenToClient", void* hwnd, int xIn, int yIn, int &x, int &y) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer x, integer y = reaper.BR_Win32_ScreenToClient(identifier hwnd, integer xIn, integer yIn)
(void hwnd, Int xIn, Int yIn, Int xOut, Int yOut) = BR_Win32_ScreenToClient(hwnd, xIn, yIn, xOut, yOut)

[BR] Equivalent to win32 API ClientToScreen().

int BR_Win32_SendMessage(void* hwnd, int msg, int lParam, int wParam)
int BR_Win32_SendMessage(void* hwnd, int msg, int lParam, int wParam) (requires REAPER 6.24 or later)
int extension_api("BR_Win32_SendMessage", void* hwnd, int msg, int lParam, int wParam) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.BR_Win32_SendMessage(identifier hwnd, integer msg, integer lParam, integer wParam)
Int BR_Win32_SendMessage(void hwnd, Int msg, Int lParam, Int wParam)

[BR] Equivalent to win32 API SendMessage().

void* BR_Win32_SetFocus(void* hwnd)
void* BR_Win32_SetFocus(void* hwnd) (requires REAPER 6.24 or later)
void* extension_api("BR_Win32_SetFocus", void* hwnd) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
identifier reaper.BR_Win32_SetFocus(identifier hwnd)
void BR_Win32_SetFocus(void hwnd)

[BR] Equivalent to win32 API SetFocus().

int BR_Win32_SetForegroundWindow(void* hwnd)
int BR_Win32_SetForegroundWindow(void* hwnd) (requires REAPER 6.24 or later)
int extension_api("BR_Win32_SetForegroundWindow", void* hwnd) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.BR_Win32_SetForegroundWindow(identifier hwnd)
Int BR_Win32_SetForegroundWindow(void hwnd)

[BR] Equivalent to win32 API SetForegroundWindow().

int BR_Win32_SetWindowLong(void* hwnd, int index, int newLong)
int BR_Win32_SetWindowLong(void* hwnd, int index, int newLong) (requires REAPER 6.24 or later)
int extension_api("BR_Win32_SetWindowLong", void* hwnd, int index, int newLong) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.BR_Win32_SetWindowLong(identifier hwnd, integer index, integer newLong)
Int BR_Win32_SetWindowLong(void hwnd, Int index, Int newLong)

[BR] Equivalent to win32 API SetWindowLong().

bool BR_Win32_SetWindowPos(void* hwnd, const char* hwndInsertAfter, int x, int y, int width, int height, int flags)
bool BR_Win32_SetWindowPos(void* hwnd, "hwndInsertAfter", int x, int y, int width, int height, int flags) (requires REAPER 6.24 or later)
bool extension_api("BR_Win32_SetWindowPos", void* hwnd, "hwndInsertAfter", int x, int y, int width, int height, int flags) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.BR_Win32_SetWindowPos(identifier hwnd, string hwndInsertAfter, integer x, integer y, integer width, integer height, integer flags)
Boolean BR_Win32_SetWindowPos(void hwnd, String hwndInsertAfter, Int x, Int y, Int width, Int height, Int flags)

[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.

int BR_Win32_ShellExecute(const char* operation, const char* file, const char* parameters, const char* directory, int showFlags)
int BR_Win32_ShellExecute("operation", "file", "parameters", "directory", int showFlags) (requires REAPER 6.24 or later)
int extension_api("BR_Win32_ShellExecute", "operation", "file", "parameters", "directory", int showFlags) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.BR_Win32_ShellExecute(string operation, string file, string parameters, string directory, integer showFlags)
Int BR_Win32_ShellExecute(String operation, String file, String parameters, String directory, Int showFlags)

[BR] Equivalent to win32 API ShellExecute() with HWND set to main window

bool BR_Win32_ShowWindow(void* hwnd, int cmdShow)
bool BR_Win32_ShowWindow(void* hwnd, int cmdShow) (requires REAPER 6.24 or later)
bool extension_api("BR_Win32_ShowWindow", void* hwnd, int cmdShow) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.BR_Win32_ShowWindow(identifier hwnd, integer cmdShow)
Boolean BR_Win32_ShowWindow(void hwnd, Int cmdShow)

[BR] Equivalent to win32 API ShowWindow().

void* BR_Win32_StringToHwnd(const char* string)
void* BR_Win32_StringToHwnd("string") (requires REAPER 6.24 or later)
void* extension_api("BR_Win32_StringToHwnd", "string") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
identifier reaper.BR_Win32_StringToHwnd(string string)
void BR_Win32_StringToHwnd(String string)

[BR] Convert string to HWND. To convert HWND back to string, see BR_Win32_HwndToString.

void* BR_Win32_WindowFromPoint(int x, int y)
void* BR_Win32_WindowFromPoint(int x, int y) (requires REAPER 6.24 or later)
void* extension_api("BR_Win32_WindowFromPoint", int x, int y) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
identifier reaper.BR_Win32_WindowFromPoint(integer x, integer y)
void BR_Win32_WindowFromPoint(Int x, Int y)

[BR] Equivalent to win32 API WindowFromPoint().

bool BR_Win32_WritePrivateProfileString(const char* sectionName, const char* keyName, const char* value, const char* filePath)
bool BR_Win32_WritePrivateProfileString("sectionName", "keyName", "value", "filePath") (requires REAPER 6.24 or later)
bool extension_api("BR_Win32_WritePrivateProfileString", "sectionName", "keyName", "value", "filePath") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.BR_Win32_WritePrivateProfileString(string sectionName, string keyName, string value, string filePath)
Boolean BR_Win32_WritePrivateProfileString(String sectionName, String keyName, String value, String filePath)

[BR] Equivalent to win32 API WritePrivateProfileString(). For example, you can use this to write to REAPER.ini

int CF_EnumMediaSourceCues(PCM_source* src, int index, double* timeOut, double* endTimeOut, bool* isRegionOut, char* nameOut, int nameOut_sz)
int CF_EnumMediaSourceCues(PCM_source src, int index, &time, &endTime, bool &isRegion, #name) (requires REAPER 6.24 or later)
int extension_api("CF_EnumMediaSourceCues", PCM_source src, int index, &time, &endTime, bool &isRegion, #name) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer retval, number time, number endTime, boolean isRegion, string name = reaper.CF_EnumMediaSourceCues(PCM_source src, integer index)
(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)

Enumerate the source's media cues. Returns the next index or 0 when finished.

int CF_EnumSelectedFX(FxChain* hwnd, int index)
int CF_EnumSelectedFX(FxChain hwnd, int index) (requires REAPER 6.24 or later)
int extension_api("CF_EnumSelectedFX", FxChain hwnd, int index) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.CF_EnumSelectedFX(FxChain hwnd, integer index)
Int CF_EnumSelectedFX(FxChain hwnd, Int index)

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.

int CF_EnumerateActions(int section, int index, char* nameOut, int nameOut_sz)
int CF_EnumerateActions(int section, int index, #name) (requires REAPER 6.24 or later)
int extension_api("CF_EnumerateActions", int section, int index, #name) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer retval, string name = reaper.CF_EnumerateActions(integer section, integer index)
(Int retval, Int section, Int index, String nameOut, Int nameOut_sz) = CF_EnumerateActions(section, index, nameOut, nameOut_sz)

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

bool CF_ExportMediaSource(PCM_source* src, const char* fn)
bool CF_ExportMediaSource(PCM_source src, "fn") (requires REAPER 6.24 or later)
bool extension_api("CF_ExportMediaSource", PCM_source src, "fn") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.CF_ExportMediaSource(PCM_source src, string fn)
Boolean CF_ExportMediaSource(PCM_source src, String fn)

Export the source to the given file (MIDI only).

void CF_GetClipboard(char* textOutNeedBig, int textOutNeedBig_sz)
CF_GetClipboard(#text) (requires REAPER 6.24 or later)
extension_api("CF_GetClipboard", #text) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
string text = reaper.CF_GetClipboard()
(String textOutNeedBig, Int textOutNeedBig_sz) = CF_GetClipboard(textOutNeedBig, textOutNeedBig_sz)

Read the contents of the system clipboard.

const char* CF_GetClipboardBig(WDL_FastString* output)
bool CF_GetClipboardBig(#retval, WDL_FastString output) (requires REAPER 6.24 or later)
bool extension_api("CF_GetClipboardBig", #retval, WDL_FastString output) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
string reaper.CF_GetClipboardBig(WDL_FastString output)
String CF_GetClipboardBig(WDL_FastString output)

[DEPRECATED: Use CF_GetClipboard] Read the contents of the system clipboard. See SNM_CreateFastString and SNM_DeleteFastString.

const char* CF_GetCommandText(int section, int command)
bool CF_GetCommandText(#retval, int section, int command) (requires REAPER 6.24 or later)
bool extension_api("CF_GetCommandText", #retval, int section, int command) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
string reaper.CF_GetCommandText(integer section, integer command)
String CF_GetCommandText(Int section, Int command)

Wrapper for the unexposed kbd_getTextFromCmd API function. See CF_EnumerateActions for common section IDs.

FxChain* CF_GetFocusedFXChain()
FxChain CF_GetFocusedFXChain() (requires REAPER 6.24 or later)
FxChain extension_api("CF_GetFocusedFXChain") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
FxChain = reaper.CF_GetFocusedFXChain()
FxChain CF_GetFocusedFXChain()

Return a handle to the currently focused FX chain window.

int CF_GetMediaSourceBitDepth(PCM_source* src)
int CF_GetMediaSourceBitDepth(PCM_source src) (requires REAPER 6.24 or later)
int extension_api("CF_GetMediaSourceBitDepth", PCM_source src) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.CF_GetMediaSourceBitDepth(PCM_source src)
Int CF_GetMediaSourceBitDepth(PCM_source src)

Returns the bit depth if available (0 otherwise).

bool CF_GetMediaSourceMetadata(PCM_source* src, const char* name, char* out, int out_sz)
bool CF_GetMediaSourceMetadata(PCM_source src, "name", #out) (requires REAPER 6.24 or later)
bool extension_api("CF_GetMediaSourceMetadata", PCM_source src, "name", #out) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean retval, string out = reaper.CF_GetMediaSourceMetadata(PCM_source src, string name, string out)
(Boolean retval, PCM_source src, String name, String out, Int out_sz) = CF_GetMediaSourceMetadata(src, name, out, out_sz)

Get the value of the given metadata field (eg. DESC, ORIG, ORIGREF, DATE, TIME, UMI, CODINGHISTORY for BWF).

bool CF_GetMediaSourceOnline(PCM_source* src)
bool CF_GetMediaSourceOnline(PCM_source src) (requires REAPER 6.24 or later)
bool extension_api("CF_GetMediaSourceOnline", PCM_source src) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.CF_GetMediaSourceOnline(PCM_source src)
Boolean CF_GetMediaSourceOnline(PCM_source src)

Returns the online/offline status of the given source.

bool CF_GetMediaSourceRPP(PCM_source* src, char* fnOut, int fnOut_sz)
bool CF_GetMediaSourceRPP(PCM_source src, #fn) (requires REAPER 6.24 or later)
bool extension_api("CF_GetMediaSourceRPP", PCM_source src, #fn) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean retval, string fn = reaper.CF_GetMediaSourceRPP(PCM_source src)
(Boolean retval, PCM_source src, String fnOut, Int fnOut_sz) = CF_GetMediaSourceRPP(src, fnOut, fnOut_sz)

Get the project associated with this source (BWF, subproject...).

void CF_GetSWSVersion(char* versionOut, int versionOut_sz)
CF_GetSWSVersion(#version) (requires REAPER 6.24 or later)
extension_api("CF_GetSWSVersion", #version) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
string version = reaper.CF_GetSWSVersion()
(String versionOut, Int versionOut_sz) = CF_GetSWSVersion(versionOut, versionOut_sz)

Return the current SWS version number.

FxChain* CF_GetTakeFXChain(MediaItem_Take* take)
FxChain CF_GetTakeFXChain(MediaItem_Take take) (requires REAPER 6.24 or later)
FxChain extension_api("CF_GetTakeFXChain", MediaItem_Take take) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
FxChain reaper.CF_GetTakeFXChain(MediaItem_Take take)
FxChain CF_GetTakeFXChain(MediaItem_Take take)

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.

FxChain* CF_GetTrackFXChain(MediaTrack* track)
FxChain CF_GetTrackFXChain(MediaTrack track) (requires REAPER 6.24 or later)
FxChain extension_api("CF_GetTrackFXChain", MediaTrack track) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
FxChain reaper.CF_GetTrackFXChain(MediaTrack track)
FxChain CF_GetTrackFXChain(MediaTrack track)

Return a handle to the given track FX chain window.

bool CF_LocateInExplorer(const char* file)
bool CF_LocateInExplorer("file") (requires REAPER 6.24 or later)
bool extension_api("CF_LocateInExplorer", "file") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.CF_LocateInExplorer(string file)
Boolean CF_LocateInExplorer(String file)

Select the given file in explorer/finder.

bool CF_SelectTrackFX(MediaTrack* track, int index)
bool CF_SelectTrackFX(MediaTrack track, int index) (requires REAPER 6.24 or later)
bool extension_api("CF_SelectTrackFX", MediaTrack track, int index) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.CF_SelectTrackFX(MediaTrack track, integer index)
Boolean CF_SelectTrackFX(MediaTrack track, Int index)

Set which track effect is active in the track's FX chain. The FX chain window does not have to be open.

void CF_SetClipboard(const char* str)
CF_SetClipboard("str") (requires REAPER 6.24 or later)
extension_api("CF_SetClipboard", "str") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
reaper.CF_SetClipboard(string str)
CF_SetClipboard(String str)

Write the given string into the system clipboard.

void CF_SetMediaSourceOnline(PCM_source* src, bool set)
CF_SetMediaSourceOnline(PCM_source src, bool set) (requires REAPER 6.24 or later)
extension_api("CF_SetMediaSourceOnline", PCM_source src, bool set) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
reaper.CF_SetMediaSourceOnline(PCM_source src, boolean set)
CF_SetMediaSourceOnline(PCM_source src, Boolean set)

Set the online/offline status of the given source (closes files when set=false).

bool CF_ShellExecute(const char* file)
bool CF_ShellExecute("file") (requires REAPER 6.24 or later)
bool extension_api("CF_ShellExecute", "file") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.CF_ShellExecute(string file)
Boolean CF_ShellExecute(String file)

Open the given file or URL in the default application. See also CF_LocateInExplorer.

RprMidiNote* FNG_AddMidiNote(RprMidiTake* midiTake)
RprMidiNote FNG_AddMidiNote(RprMidiTake midiTake) (requires REAPER 6.24 or later)
RprMidiNote extension_api("FNG_AddMidiNote", RprMidiTake midiTake) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
RprMidiNote reaper.FNG_AddMidiNote(RprMidiTake midiTake)
RprMidiNote FNG_AddMidiNote(RprMidiTake midiTake)

[FNG] Add MIDI note to MIDI take

RprMidiTake* FNG_AllocMidiTake(MediaItem_Take* take)
RprMidiTake FNG_AllocMidiTake(MediaItem_Take take) (requires REAPER 6.24 or later)
RprMidiTake extension_api("FNG_AllocMidiTake", MediaItem_Take take) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
RprMidiTake reaper.FNG_AllocMidiTake(MediaItem_Take take)
RprMidiTake FNG_AllocMidiTake(MediaItem_Take take)

[FNG] Allocate a RprMidiTake from a take pointer. Returns a NULL pointer if the take is not an in-project MIDI take

int FNG_CountMidiNotes(RprMidiTake* midiTake)
int FNG_CountMidiNotes(RprMidiTake midiTake) (requires REAPER 6.24 or later)
int extension_api("FNG_CountMidiNotes", RprMidiTake midiTake) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.FNG_CountMidiNotes(RprMidiTake midiTake)
Int FNG_CountMidiNotes(RprMidiTake midiTake)

[FNG] Count of how many MIDI notes are in the MIDI take

void FNG_FreeMidiTake(RprMidiTake* midiTake)
FNG_FreeMidiTake(RprMidiTake midiTake) (requires REAPER 6.24 or later)
extension_api("FNG_FreeMidiTake", RprMidiTake midiTake) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
reaper.FNG_FreeMidiTake(RprMidiTake midiTake)
FNG_FreeMidiTake(RprMidiTake midiTake)

[FNG] Commit changes to MIDI take and free allocated memory

RprMidiNote* FNG_GetMidiNote(RprMidiTake* midiTake, int index)
RprMidiNote FNG_GetMidiNote(RprMidiTake midiTake, int index) (requires REAPER 6.24 or later)
RprMidiNote extension_api("FNG_GetMidiNote", RprMidiTake midiTake, int index) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
RprMidiNote reaper.FNG_GetMidiNote(RprMidiTake midiTake, integer index)
RprMidiNote FNG_GetMidiNote(RprMidiTake midiTake, Int index)

[FNG] Get a MIDI note from a MIDI take at specified index

int FNG_GetMidiNoteIntProperty(RprMidiNote* midiNote, const char* property)
int FNG_GetMidiNoteIntProperty(RprMidiNote midiNote, "property") (requires REAPER 6.24 or later)
int extension_api("FNG_GetMidiNoteIntProperty", RprMidiNote midiNote, "property") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.FNG_GetMidiNoteIntProperty(RprMidiNote midiNote, string property)
Int FNG_GetMidiNoteIntProperty(RprMidiNote midiNote, String property)

[FNG] Get MIDI note property

void FNG_SetMidiNoteIntProperty(RprMidiNote* midiNote, const char* property, int value)
FNG_SetMidiNoteIntProperty(RprMidiNote midiNote, "property", int value) (requires REAPER 6.24 or later)
extension_api("FNG_SetMidiNoteIntProperty", RprMidiNote midiNote, "property", int value) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
reaper.FNG_SetMidiNoteIntProperty(RprMidiNote midiNote, string property, integer value)
FNG_SetMidiNoteIntProperty(RprMidiNote midiNote, String property, Int value)

[FNG] Set MIDI note property

bool ImGui_AcceptDragDropPayload(ImGui_Context* ctx, const char* type, char* payloadOutNeedBig, int payloadOutNeedBig_sz, int* flagsInOptional)
bool ImGui_AcceptDragDropPayload(ImGui_Context ctx, "type", #payload, optional int flagsIn) (requires REAPER 6.24 or later)
bool extension_api("ImGui_AcceptDragDropPayload", ImGui_Context ctx, "type", #payload, optional int flagsIn) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean retval, string payload = reaper.ImGui_AcceptDragDropPayload(ImGui_Context ctx, string type, string payload, optional integer flagsIn)
(Boolean retval, ImGui_Context ctx, String type, String payloadOutNeedBig, Int payloadOutNeedBig_sz, Int flagsInOptional) = ImGui_AcceptDragDropPayload(ctx, type, payloadOutNeedBig, payloadOutNeedBig_sz, flagsInOptional)

Accept contents of a given type. If ImGui_DragDropFlags_AcceptBeforeDelivery is set you can peek into the payload before the mouse button is released.

Default values: flags = ImGui_DragDropFlags_None

bool ImGui_AcceptDragDropPayloadFiles(ImGui_Context* ctx, int* countOut, int* flagsInOptional)
bool ImGui_AcceptDragDropPayloadFiles(ImGui_Context ctx, int &count, optional int flagsIn) (requires REAPER 6.24 or later)
bool extension_api("ImGui_AcceptDragDropPayloadFiles", ImGui_Context ctx, int &count, optional int flagsIn) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean retval, integer count = reaper.ImGui_AcceptDragDropPayloadFiles(ImGui_Context ctx, integer count, optional integer flagsIn)
(Boolean retval, ImGui_Context ctx, Int countOut, Int flagsInOptional) = ImGui_AcceptDragDropPayloadFiles(ctx, countOut, flagsInOptional)

Accept a list of dropped files. See ImGui_AcceptDragDropPayload and ImGui_GetDragDropPayloadFile.

Default values: flags = ImGui_DragDropFlags_None

bool ImGui_AcceptDragDropPayloadRGB(ImGui_Context* ctx, int* rgbOut, int* flagsInOptional)
bool ImGui_AcceptDragDropPayloadRGB(ImGui_Context ctx, int &rgb, optional int flagsIn) (requires REAPER 6.24 or later)
bool extension_api("ImGui_AcceptDragDropPayloadRGB", ImGui_Context ctx, int &rgb, optional int flagsIn) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean retval, integer rgb = reaper.ImGui_AcceptDragDropPayloadRGB(ImGui_Context ctx, integer rgb, optional integer flagsIn)
(Boolean retval, ImGui_Context ctx, Int rgbOut, Int flagsInOptional) = ImGui_AcceptDragDropPayloadRGB(ctx, rgbOut, flagsInOptional)

Accept a RGB color. See ImGui_AcceptDragDropPayload.

Default values: flags = ImGui_DragDropFlags_None

bool ImGui_AcceptDragDropPayloadRGBA(ImGui_Context* ctx, int* rgbaOut, int* flagsInOptional)
bool ImGui_AcceptDragDropPayloadRGBA(ImGui_Context ctx, int &rgba, optional int flagsIn) (requires REAPER 6.24 or later)
bool extension_api("ImGui_AcceptDragDropPayloadRGBA", ImGui_Context ctx, int &rgba, optional int flagsIn) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean retval, integer rgba = reaper.ImGui_AcceptDragDropPayloadRGBA(ImGui_Context ctx, integer rgba, optional integer flagsIn)
(Boolean retval, ImGui_Context ctx, Int rgbaOut, Int flagsInOptional) = ImGui_AcceptDragDropPayloadRGBA(ctx, rgbaOut, flagsInOptional)

Accept a RGBA color. See ImGui_AcceptDragDropPayload.

Default values: flags = ImGui_DragDropFlags_None

void ImGui_AlignTextToFramePadding(ImGui_Context* ctx)
ImGui_AlignTextToFramePadding(ImGui_Context ctx) (requires REAPER 6.24 or later)
extension_api("ImGui_AlignTextToFramePadding", ImGui_Context ctx) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
reaper.ImGui_AlignTextToFramePadding(ImGui_Context ctx)
ImGui_AlignTextToFramePadding(ImGui_Context ctx)

Vertically align upcoming text baseline to ImGui_StyleVar_FramePadding.y so that it will align properly to regularly framed items (call if you have text on a line before a framed item)

bool ImGui_ArrowButton(ImGui_Context* ctx, const char* str_id, int dir)
bool ImGui_ArrowButton(ImGui_Context ctx, "str_id", int dir) (requires REAPER 6.24 or later)
bool extension_api("ImGui_ArrowButton", ImGui_Context ctx, "str_id", int dir) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.ImGui_ArrowButton(ImGui_Context ctx, string str_id, integer dir)
Boolean ImGui_ArrowButton(ImGui_Context ctx, String str_id, Int dir)

Square button with an arrow shape.

void ImGui_AttachFont(ImGui_Context* ctx, ImGui_Font* font)
ImGui_AttachFont(ImGui_Context ctx, ImGui_Font font) (requires REAPER 6.24 or later)
extension_api("ImGui_AttachFont", ImGui_Context ctx, ImGui_Font font) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
reaper.ImGui_AttachFont(ImGui_Context ctxImGui_Font font)
ImGui_AttachFont(ImGui_Context ctx, ImGui_Font font)

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.

bool ImGui_Begin(ImGui_Context* ctx, const char* name, bool* p_openInOutOptional, int* flagsInOptional)
bool ImGui_Begin(ImGui_Context ctx, "name", optional bool &p_open, optional int flagsIn) (requires REAPER 6.24 or later)
bool extension_api("ImGui_Begin", ImGui_Context ctx, "name", optional bool &p_open, optional int flagsIn) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean retval, optional boolean p_open = reaper.ImGui_Begin(ImGui_Context ctx, string name, optional boolean p_open, optional integer flagsIn)
(Boolean retval, ImGui_Context ctx, String name, Boolean p_openInOutOptional, Int flagsInOptional) = ImGui_Begin(ctx, name, p_openInOutOptional, flagsInOptional)

Push window to the stack and start appending to it. See ImGui_End.

- Passing true to 'p_open' shows a window-closing widget in the upper-right corner of the window, which clicking will set the boolean to false when returned.
- You may append multiple times to the same window during the same frame by calling Begin()/End() pairs multiple times. Some information such as 'flags' or 'open' will only be considered by the first call to Begin().
- Begin() return false to indicate the window is collapsed or fully clipped, so you may early out and omit submitting anything to the window.
- Note that the bottom of window stack always contains a window called "Debug".

Default values: p_open = nil, flags = ImGui_WindowFlags_None

bool ImGui_BeginChild(ImGui_Context* ctx, const char* str_id, double* size_wInOptional, double* size_hInOptional, bool* borderInOptional, int* flagsInOptional)
bool ImGui_BeginChild(ImGui_Context ctx, "str_id", optional size_wIn, optional size_hIn, optional bool borderIn, optional int flagsIn) (requires REAPER 6.24 or later)
bool extension_api("ImGui_BeginChild", ImGui_Context ctx, "str_id", optional size_wIn, optional size_hIn, optional bool borderIn, optional int flagsIn) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.ImGui_BeginChild(ImGui_Context ctx, string str_id, optional number size_wIn, optional number size_hIn, optional boolean borderIn, optional integer flagsIn)
(Boolean retval, ImGui_Context ctx, String str_id, Float size_wInOptional, Float size_hInOptional, Boolean borderInOptional, Int flagsInOptional) = ImGui_BeginChild(ctx, str_id, size_wInOptional, size_hInOptional, borderInOptional, flagsInOptional)

Use child windows to begin into a self-contained independent scrolling/clipping regions within a host window. Child windows can embed their own child.

- For each independent axis of 'size': ==0.0: use remaining host window size / >0.0: fixed size / <0.0: use remaining window size minus abs(size) / Each axis can use a different mode, e.g. size = 0x400.
- BeginChild() returns false to indicate the window is collapsed or fully clipped, so you may early out and omit submitting anything to the window.

See ImGui_EndChild.

Default values: size_w = 0.0, size_h = 0.0, border = false, flags = ImGui_WindowFlags_None

bool ImGui_BeginChildFrame(ImGui_Context* ctx, const char* str_id, double size_w, double size_h, int* flagsInOptional)
bool ImGui_BeginChildFrame(ImGui_Context ctx, "str_id", size_w, size_h, optional int flagsIn) (requires REAPER 6.24 or later)
bool extension_api("ImGui_BeginChildFrame", ImGui_Context ctx, "str_id", size_w, size_h, optional int flagsIn) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.ImGui_BeginChildFrame(ImGui_Context ctx, string str_id, number size_w, number size_h, optional integer flagsIn)
(Boolean retval, ImGui_Context ctx, String str_id, Float size_w, Float size_h, Int flagsInOptional) = ImGui_BeginChildFrame(ctx, str_id, size_w, size_h, flagsInOptional)

Helper to create a child window / scrolling region that looks like a normal widget frame. See ImGui_EndChildFrame.

Default values: flags = ImGui_WindowFlags_None

bool ImGui_BeginCombo(ImGui_Context* ctx, const char* label, const char* preview_value, int* flagsInOptional)
bool ImGui_BeginCombo(ImGui_Context ctx, "label", "preview_value", optional int flagsIn) (requires REAPER 6.24 or later)
bool extension_api("ImGui_BeginCombo", ImGui_Context ctx, "label", "preview_value", optional int flagsIn) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.ImGui_BeginCombo(ImGui_Context ctx, string label, string preview_value, optional integer flagsIn)
(Boolean retval, ImGui_Context ctx, String label, String preview_value, Int flagsInOptional) = ImGui_BeginCombo(ctx, label, preview_value, flagsInOptional)

The ImGui_BeginCombo/ImGui_EndCombo API allows you to manage your contents and selection state however you want it, by creating e.g. ImGui_Selectable items.

Default values: flags = ImGui_ComboFlags_None

void ImGui_BeginDisabled(ImGui_Context* ctx, bool* disabledInOptional)
ImGui_BeginDisabled(ImGui_Context ctx, optional bool disabledIn) (requires REAPER 6.24 or later)
extension_api("ImGui_BeginDisabled", ImGui_Context ctx, optional bool disabledIn) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
reaper.ImGui_BeginDisabled(ImGui_Context ctx, optional boolean disabledIn)
(ImGui_Context ctx, Boolean disabledInOptional) = ImGui_BeginDisabled(ctx, disabledInOptional)

Disable all user interactions and dim items visuals (applying ImGui_StyleVar_DisabledAlpha over current colors).

ImGui_BeginDisabled(false) essentially does nothing useful but is provided to facilitate use of boolean expressions. If you can avoid calling ImGui_BeginDisabled(false)/ImGui_EndDisabled() best to avoid it.

Default values: disabled = true

bool ImGui_BeginDragDropSource(ImGui_Context* ctx, int* flagsInOptional)
bool ImGui_BeginDragDropSource(ImGui_Context ctx, optional int flagsIn) (requires REAPER 6.24 or later)
bool extension_api("ImGui_BeginDragDropSource", ImGui_Context ctx, optional int flagsIn) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.ImGui_BeginDragDropSource(ImGui_Context ctx, optional integer flagsIn)
(Boolean retval, ImGui_Context ctx, Int flagsInOptional) = ImGui_BeginDragDropSource(ctx, flagsInOptional)

Call when the current item is active. If this return true, you can call ImGui_SetDragDropPayload + ImGui_EndDragDropSource.

If you stop calling BeginDragDropSource() the payload is preserved however it won't have a preview tooltip (we currently display a fallback "..." tooltip as replacement).

Default values: flags = ImGui_DragDropFlags_None

bool ImGui_BeginDragDropTarget(ImGui_Context* ctx)
bool ImGui_BeginDragDropTarget(ImGui_Context ctx) (requires REAPER 6.24 or later)
bool extension_api("ImGui_BeginDragDropTarget", ImGui_Context ctx) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.ImGui_BeginDragDropTarget(ImGui_Context ctx)
Boolean ImGui_BeginDragDropTarget(ImGui_Context ctx)

Call after submitting an item that may receive a payload. If this returns true, you can call ImGui_AcceptDragDropPayload + ImGui_EndDragDropTarget.

void ImGui_BeginGroup(ImGui_Context* ctx)
ImGui_BeginGroup(ImGui_Context ctx) (requires REAPER 6.24 or later)
extension_api("ImGui_BeginGroup", ImGui_Context ctx) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
reaper.ImGui_BeginGroup(ImGui_Context ctx)
ImGui_BeginGroup(ImGui_Context ctx)

Lock horizontal starting position. See ImGui_EndGroup.

bool ImGui_BeginListBox(ImGui_Context* ctx, const char* label, double* size_wInOptional, double* size_hInOptional)
bool ImGui_BeginListBox(ImGui_Context ctx, "label", optional size_wIn, optional size_hIn) (requires REAPER 6.24 or later)
bool extension_api("ImGui_BeginListBox", ImGui_Context ctx, "label", optional size_wIn, optional size_hIn) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.ImGui_BeginListBox(ImGui_Context ctx, string label, optional number size_wIn, optional number size_hIn)
(Boolean retval, ImGui_Context ctx, String label, Float size_wInOptional, Float size_hInOptional) = ImGui_BeginListBox(ctx, label, size_wInOptional, size_hInOptional)

Open a framed scrolling region. This is essentially a thin wrapper to using ImGui_BeginChild/ImGui_EndChild with some stylistic changes.

The ImGui_BeginListBox/ImGui_EndListBox API allows you to manage your contents and selection state however you want it, by creating e.g. ImGui_Selectable or any items.

- Choose frame width: width > 0.0: custom / width < 0.0 or -FLT_MIN: right-align / width = 0.0 (default): use current ItemWidth
- Choose frame height: height > 0.0: custom / height < 0.0 or -FLT_MIN: bottom-align / height = 0.0 (default): arbitrary default height which can fit ~7 items

Default values: size_w = 0.0, size_h = 0.0

See ImGui_EndListBox.

bool ImGui_BeginMenu(ImGui_Context* ctx, const char* label, bool* enabledInOptional)
bool ImGui_BeginMenu(ImGui_Context ctx, "label", optional bool enabledIn) (requires REAPER 6.24 or later)
bool extension_api("ImGui_BeginMenu", ImGui_Context ctx, "label", optional bool enabledIn) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.ImGui_BeginMenu(ImGui_Context ctx, string label, optional boolean enabledIn)
(Boolean retval, ImGui_Context ctx, String label, Boolean enabledInOptional) = ImGui_BeginMenu(ctx, label, enabledInOptional)

Create a sub-menu entry. only call ImGui_EndMenu if this returns true!

Default values: enabled = true

bool ImGui_BeginMenuBar(ImGui_Context* ctx)
bool ImGui_BeginMenuBar(ImGui_Context ctx) (requires REAPER 6.24 or later)
bool extension_api("ImGui_BeginMenuBar", ImGui_Context ctx) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.ImGui_BeginMenuBar(ImGui_Context ctx)
Boolean ImGui_BeginMenuBar(ImGui_Context ctx)

Append to menu-bar of current window (requires ImGui_WindowFlags_MenuBar flag set on parent window). See ImGui_EndMenuBar.

bool ImGui_BeginPopup(ImGui_Context* ctx, const char* str_id, int* flagsInOptional)
bool ImGui_BeginPopup(ImGui_Context ctx, "str_id", optional int flagsIn) (requires REAPER 6.24 or later)
bool extension_api("ImGui_BeginPopup", ImGui_Context ctx, "str_id", optional int flagsIn) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.ImGui_BeginPopup(ImGui_Context ctx, string str_id, optional integer flagsIn)
(Boolean retval, ImGui_Context ctx, String str_id, Int flagsInOptional) = ImGui_BeginPopup(ctx, str_id, flagsInOptional)

Popups, Modals

- They block normal mouse hovering detection (and therefore most mouse interactions) behind them.
- If not modal: they can be closed by clicking anywhere outside them, or by pressing ESCAPE.
- Their visibility state (~bool) is held internally instead of being held by the programmer as we are used to with regular Begin*() calls.
- The 3 properties above are related: we need to retain popup visibility state in the library because popups may be closed as any time.
- You can bypass the hovering restriction by using ImGui_HoveredFlags_AllowWhenBlockedByPopup when calling ImGui_IsItemHovered or ImGui_IsWindowHovered.
- IMPORTANT: Popup identifiers are relative to the current ID stack, so ImGui_OpenPopup and BeginPopup generally needs to be at the same level of the stack.

Query popup state, if open start appending into the window. Call ImGui_EndPopup afterwards. ImGui_WindowFlags* are forwarded to the window.

Return true if the popup is open, and you can start outputting to it.

Default values: flags = ImGui_WindowFlags_None

bool ImGui_BeginPopupContextItem(ImGui_Context* ctx, const char* str_idInOptional, int* popup_flagsInOptional)
bool ImGui_BeginPopupContextItem(ImGui_Context ctx, optional "str_idIn", optional int popup_flagsIn) (requires REAPER 6.24 or later)
bool extension_api("ImGui_BeginPopupContextItem", ImGui_Context ctx, optional "str_idIn", optional int popup_flagsIn) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.ImGui_BeginPopupContextItem(ImGui_Context ctx, optional string str_idIn, optional integer popup_flagsIn)
(Boolean retval, ImGui_Context ctx, String str_idInOptional, Int popup_flagsInOptional) = ImGui_BeginPopupContextItem(ctx, str_idInOptional, popup_flagsInOptional)

This is a helper to handle the simplest case of associating one named popup to one given widget. You can pass a NULL str_id to use the identifier of the last item. This is essentially the same as calling ImGui_OpenPopupOnItemClick + ImGui_BeginPopup but written to avoid computing the ID twice because BeginPopupContextXXX functions may be called very frequently.

Open+begin popup when clicked on last item. if you can pass a NULL str_id only if the previous item had an id. If you want to use that on a non-interactive item such as ImGui_Text you need to pass in an explicit ID here.

- IMPORTANT: Notice that BeginPopupContextXXX takes ImGui_PopupFlags just like ImGui_OpenPopup and unlike ImGui_BeginPopup.
- IMPORTANT: We exceptionally default their flags to 1 (== ImGui_PopupFlags_MouseButtonRight) for backward compatibility with older API taking 'int mouse_button = 1' parameter, so if you add other flags remember to re-add the ImGui_PopupFlags_MouseButtonRight.

Default values: str_id = nil, popup_flags = ImGui_PopupFlags_MouseButtonRight

bool ImGui_BeginPopupContextWindow(ImGui_Context* ctx, const char* str_idInOptional, int* popup_flagsInOptional)
bool ImGui_BeginPopupContextWindow(ImGui_Context ctx, optional "str_idIn", optional int popup_flagsIn) (requires REAPER 6.24 or later)
bool extension_api("ImGui_BeginPopupContextWindow", ImGui_Context ctx, optional "str_idIn", optional int popup_flagsIn) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.ImGui_BeginPopupContextWindow(ImGui_Context ctx, optional string str_idIn, optional integer popup_flagsIn)
(Boolean retval, ImGui_Context ctx, String str_idInOptional, Int popup_flagsInOptional) = ImGui_BeginPopupContextWindow(ctx, str_idInOptional, popup_flagsInOptional)

Open+begin popup when clicked on current window.

Default values: str_id = nil, popup_flags = ImGui_PopupFlags_MouseButtonRight

bool ImGui_BeginPopupModal(ImGui_Context* ctx, const char* name, bool* p_openInOutOptional, int* flagsInOptional)
bool ImGui_BeginPopupModal(ImGui_Context ctx, "name", optional bool &p_open, optional int flagsIn) (requires REAPER 6.24 or later)
bool extension_api("ImGui_BeginPopupModal", ImGui_Context ctx, "name", optional bool &p_open, optional int flagsIn) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean retval, optional boolean p_open = reaper.ImGui_BeginPopupModal(ImGui_Context ctx, string name, optional boolean p_open, optional integer flagsIn)
(Boolean retval, ImGui_Context ctx, String name, Boolean p_openInOutOptional, Int flagsInOptional) = ImGui_BeginPopupModal(ctx, name, p_openInOutOptional, flagsInOptional)

Block every interactions behind the window, cannot be closed by user, add a dimming background, has a title bar. Return true if the modal is open, and you can start outputting to it. See ImGui_BeginPopup.

Default values: p_open = nil, flags = ImGui_WindowFlags_None

bool ImGui_BeginTabBar(ImGui_Context* ctx, const char* str_id, int* flagsInOptional)
bool ImGui_BeginTabBar(ImGui_Context ctx, "str_id", optional int flagsIn) (requires REAPER 6.24 or later)
bool extension_api("ImGui_BeginTabBar", ImGui_Context ctx, "str_id", optional int flagsIn) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.ImGui_BeginTabBar(ImGui_Context ctx, string str_id, optional integer flagsIn)
(Boolean retval, ImGui_Context ctx, String str_id, Int flagsInOptional) = ImGui_BeginTabBar(ctx, str_id, flagsInOptional)

Create and append into a TabBar.

Default values: flags = ImGui_TabBarFlags_None

bool ImGui_BeginTabItem(ImGui_Context* ctx, const char* label, bool* p_openInOutOptional, int* flagsInOptional)
bool ImGui_BeginTabItem(ImGui_Context ctx, "label", optional bool &p_open, optional int flagsIn) (requires REAPER 6.24 or later)
bool extension_api("ImGui_BeginTabItem", ImGui_Context ctx, "label", optional bool &p_open, optional int flagsIn) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean retval, optional boolean p_open = reaper.ImGui_BeginTabItem(ImGui_Context ctx, string label, optional boolean p_open, optional integer flagsIn)
(Boolean retval, ImGui_Context ctx, String label, Boolean p_openInOutOptional, Int flagsInOptional) = ImGui_BeginTabItem(ctx, label, p_openInOutOptional, flagsInOptional)

Create a Tab. Returns true if the Tab is selected. Set 'p_open' to true to enable the close button.

Default values: p_open = nil, flags = ImGui_TabItemFlags_None

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)
bool ImGui_BeginTable(ImGui_Context ctx, "str_id", int column, optional int flagsIn, optional outer_size_wIn, optional outer_size_hIn, optional inner_widthIn) (requires REAPER 6.24 or later)
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) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.ImGui_BeginTable(ImGui_Context ctx, string str_id, integer column, optional integer flagsIn, optional number outer_size_wIn, optional number outer_size_hIn, optional number inner_widthIn)
(Boolean retval, ImGui_Context ctx, String str_id, Int column, Int flagsInOptional, Float outer_size_wInOptional, Float outer_size_hInOptional, Float inner_widthInOptional) = ImGui_BeginTable(ctx, str_id, column, flagsInOptional, outer_size_wInOptional, outer_size_hInOptional, inner_widthInOptional)

[BETA API] API may evolve slightly! If you use this, please update to the next version when it comes out!

- See Demo->Tables for demo code.
- See top of imgui_tables.cpp for general commentary.
- See ImGui_TableFlags* and ImGui_TableColumnFlags* enums for a description of available flags.
The typical call flow is:
- 1. Call ImGui_BeginTable.
- 2. Optionally call ImGui_TableSetupColumn to submit column name/flags/defaults.
- 3. Optionally call ImGui_TableSetupScrollFreeze to request scroll freezing of columns/rows.
- 4. Optionally call ImGui_TableHeadersRow to submit a header row. Names are pulled from ImGui_TableSetupColumn data.
- 5. Populate contents:
   - In most situations you can use ImGui_TableNextRow + ImGui_TableSetColumnIndex(N) to start appending into a column.
   - If you are using tables as a sort of grid, where every columns is holding the same type of contents,
     you may prefer using ImGui_TableNextColumn instead of ImGui_TableNextRow + ImGui_TableSetColumnIndex.
     ImGui_TableNextColumn will automatically wrap-around into the next row if needed.
   - Summary of possible call flow:
       --------------------------------------------------------------------------------------------------------
       TableNextRow() -> TableSetColumnIndex(0) -> Text("Hello 0") -> TableSetColumnIndex(1) -> Text("Hello 1")  // OK
       TableNextRow() -> TableNextColumn()      -> Text("Hello 0") -> TableNextColumn()      -> Text("Hello 1")  // OK
                         TableNextColumn()      -> Text("Hello 0") -> TableNextColumn()      -> Text("Hello 1")  // OK: TableNextColumn() automatically gets to next row!
       TableNextRow()                           -> Text("Hello 0")                                               // Not OK! Missing TableSetColumnIndex() or TableNextColumn()! Text will not appear!
       --------------------------------------------------------------------------------------------------------
- 5. Call ImGui_EndTable.

Default values: flags = ImGui_TableFlags_None, outer_size_w = 0.0, outer_size_h = 0.0, inner_width = 0.0

void ImGui_BeginTooltip(ImGui_Context* ctx)
ImGui_BeginTooltip(ImGui_Context ctx) (requires REAPER 6.24 or later)
extension_api("ImGui_BeginTooltip", ImGui_Context ctx) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
reaper.ImGui_BeginTooltip(ImGui_Context ctx)
ImGui_BeginTooltip(ImGui_Context ctx)

Begin/append a tooltip window. To create full-featured tooltip (with any kind of items).

void ImGui_Bullet(ImGui_Context* ctx)
ImGui_Bullet(ImGui_Context ctx) (requires REAPER 6.24 or later)
extension_api("ImGui_Bullet", ImGui_Context ctx) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
reaper.ImGui_Bullet(ImGui_Context ctx)
ImGui_Bullet(ImGui_Context ctx)

Draw a small circle + keep the cursor on the same line. Advance cursor x position by ImGui_GetTreeNodeToLabelSpacing, same distance that ImGui_TreeNode uses.

void ImGui_BulletText(ImGui_Context* ctx, const char* text)
ImGui_BulletText(ImGui_Context ctx, "text") (requires REAPER 6.24 or later)
extension_api("ImGui_BulletText", ImGui_Context ctx, "text") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
reaper.ImGui_BulletText(ImGui_Context ctx, string text)
ImGui_BulletText(ImGui_Context ctx, String text)

Shortcut for ImGui_Bullet + ImGui_Text.

bool ImGui_Button(ImGui_Context* ctx, const char* label, double* size_wInOptional, double* size_hInOptional)
bool ImGui_Button(ImGui_Context ctx, "label", optional size_wIn, optional size_hIn) (requires REAPER 6.24 or later)
bool extension_api("ImGui_Button", ImGui_Context ctx, "label", optional size_wIn, optional size_hIn) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.ImGui_Button(ImGui_Context ctx, string label, optional number size_wIn, optional number size_hIn)
(Boolean retval, ImGui_Context ctx, String label, Float size_wInOptional, Float size_hInOptional) = ImGui_Button(ctx, label, size_wInOptional, size_hInOptional)

Most widgets return true when the value has been changed or when pressed/selected
You may also use one of the many IsItemXXX functions (e.g. ImGui_IsItemActive, ImGui_IsItemHovered, etc.) to query widget state.

Default values: size_w = 0.0, size_h = 0.0

int ImGui_ButtonFlags_MouseButtonLeft()
int ImGui_ButtonFlags_MouseButtonLeft() (requires REAPER 6.24 or later)
int extension_api("ImGui_ButtonFlags_MouseButtonLeft") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ButtonFlags_MouseButtonLeft()
Int ImGui_ButtonFlags_MouseButtonLeft()

React on left mouse button (default).

int ImGui_ButtonFlags_MouseButtonMiddle()
int ImGui_ButtonFlags_MouseButtonMiddle() (requires REAPER 6.24 or later)
int extension_api("ImGui_ButtonFlags_MouseButtonMiddle") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ButtonFlags_MouseButtonMiddle()
Int ImGui_ButtonFlags_MouseButtonMiddle()

React on center mouse button.

int ImGui_ButtonFlags_MouseButtonRight()
int ImGui_ButtonFlags_MouseButtonRight() (requires REAPER 6.24 or later)
int extension_api("ImGui_ButtonFlags_MouseButtonRight") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ButtonFlags_MouseButtonRight()
Int ImGui_ButtonFlags_MouseButtonRight()

React on right mouse button.

int ImGui_ButtonFlags_None()
int ImGui_ButtonFlags_None() (requires REAPER 6.24 or later)
int extension_api("ImGui_ButtonFlags_None") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ButtonFlags_None()
Int ImGui_ButtonFlags_None()

Flags for ImGui_InvisibleButton.

double ImGui_CalcItemWidth(ImGui_Context* ctx)
double ImGui_CalcItemWidth(ImGui_Context ctx) (requires REAPER 6.24 or later)
double extension_api("ImGui_CalcItemWidth", ImGui_Context ctx) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
number reaper.ImGui_CalcItemWidth(ImGui_Context ctx)
Float ImGui_CalcItemWidth(ImGui_Context ctx)

Width of item given pushed settings and current cursor position. NOT necessarily the width of last item unlike most 'Item' functions.

void ImGui_CalcTextSize(ImGui_Context* ctx, const char* text, double* wOut, double* hOut, bool* hide_text_after_double_hashInOptional, double* wrap_widthInOptional)
ImGui_CalcTextSize(ImGui_Context ctx, "text", &w, &h, optional bool hide_text_after_double_hashIn, optional wrap_widthIn) (requires REAPER 6.24 or later)
extension_api("ImGui_CalcTextSize", ImGui_Context ctx, "text", &w, &h, optional bool hide_text_after_double_hashIn, optional wrap_widthIn) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
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)
(ImGui_Context ctx, String text, Float wOut, Float hOut, Boolean hide_text_after_double_hashInOptional, Float wrap_widthInOptional) = ImGui_CalcTextSize(ctx, text, wOut, hOut, hide_text_after_double_hashInOptional, wrap_widthInOptional)

Default values: hide_text_after_double_hash = false, wrap_width = -1.0

void ImGui_CaptureKeyboardFromApp(ImGui_Context* ctx, bool* want_capture_keyboard_valueInOptional)
ImGui_CaptureKeyboardFromApp(ImGui_Context ctx, optional bool want_capture_keyboard_valueIn) (requires REAPER 6.24 or later)
extension_api("ImGui_CaptureKeyboardFromApp", ImGui_Context ctx, optional bool want_capture_keyboard_valueIn) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
reaper.ImGui_CaptureKeyboardFromApp(ImGui_Context ctx, optional boolean want_capture_keyboard_valueIn)
(ImGui_Context ctx, Boolean want_capture_keyboard_valueInOptional) = ImGui_CaptureKeyboardFromApp(ctx, want_capture_keyboard_valueInOptional)

Manually enable or disable capture of keyboard shortcuts in the global scope for the next frame.

Default values: want_capture_keyboard_value = true

bool ImGui_Checkbox(ImGui_Context* ctx, const char* label, bool* vInOut)
bool ImGui_Checkbox(ImGui_Context ctx, "label", bool &v) (requires REAPER 6.24 or later)
bool extension_api("ImGui_Checkbox", ImGui_Context ctx, "label", bool &v) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean retval, boolean v = reaper.ImGui_Checkbox(ImGui_Context ctx, string label, boolean v)
(Boolean retval, ImGui_Context ctx, String label, Boolean vInOut) = ImGui_Checkbox(ctx, label, vInOut)
bool ImGui_CheckboxFlags(ImGui_Context* ctx, const char* label, int* flagsInOut, int flags_value)
bool ImGui_CheckboxFlags(ImGui_Context ctx, "label", int &flags, int flags_value) (requires REAPER 6.24 or later)
bool extension_api("ImGui_CheckboxFlags", ImGui_Context ctx, "label", int &flags, int flags_value) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean retval, integer flags = reaper.ImGui_CheckboxFlags(ImGui_Context ctx, string label, integer flags, integer flags_value)
(Boolean retval, ImGui_Context ctx, String label, Int flagsInOut, Int flags_value) = ImGui_CheckboxFlags(ctx, label, flagsInOut, flags_value)
void ImGui_CloseCurrentPopup(ImGui_Context* ctx)
ImGui_CloseCurrentPopup(ImGui_Context ctx) (requires REAPER 6.24 or later)
extension_api("ImGui_CloseCurrentPopup", ImGui_Context ctx) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
reaper.ImGui_CloseCurrentPopup(ImGui_Context ctx)
ImGui_CloseCurrentPopup(ImGui_Context ctx)

Manually close the popup we have begin-ed into. Use inside the ImGUi_BeginPopup/ImGui_EndPopup scope to close manually.

CloseCurrentPopup() is called by default by ImGui_Selectable/ImGui_MenuItem when activated.

int ImGui_Col_Border()
int ImGui_Col_Border() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_Border") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_Border()
Int ImGui_Col_Border()
int ImGui_Col_BorderShadow()
int ImGui_Col_BorderShadow() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_BorderShadow") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_BorderShadow()
Int ImGui_Col_BorderShadow()
int ImGui_Col_Button()
int ImGui_Col_Button() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_Button") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_Button()
Int ImGui_Col_Button()
int ImGui_Col_ButtonActive()
int ImGui_Col_ButtonActive() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_ButtonActive") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_ButtonActive()
Int ImGui_Col_ButtonActive()
int ImGui_Col_ButtonHovered()
int ImGui_Col_ButtonHovered() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_ButtonHovered") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_ButtonHovered()
Int ImGui_Col_ButtonHovered()
int ImGui_Col_CheckMark()
int ImGui_Col_CheckMark() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_CheckMark") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_CheckMark()
Int ImGui_Col_CheckMark()
int ImGui_Col_ChildBg()
int ImGui_Col_ChildBg() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_ChildBg") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_ChildBg()
Int ImGui_Col_ChildBg()

Background of child windows.

int ImGui_Col_DockingEmptyBg()
int ImGui_Col_DockingEmptyBg() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_DockingEmptyBg") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_DockingEmptyBg()
Int ImGui_Col_DockingEmptyBg()

Background color for empty node (e.g. CentralNode with no window docked into it).

int ImGui_Col_DockingPreview()
int ImGui_Col_DockingPreview() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_DockingPreview") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_DockingPreview()
Int ImGui_Col_DockingPreview()

Preview overlay color when about to docking something.

int ImGui_Col_DragDropTarget()
int ImGui_Col_DragDropTarget() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_DragDropTarget") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_DragDropTarget()
Int ImGui_Col_DragDropTarget()
int ImGui_Col_FrameBg()
int ImGui_Col_FrameBg() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_FrameBg") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_FrameBg()
Int ImGui_Col_FrameBg()

Background of checkbox, radio button, plot, slider, text input.

int ImGui_Col_FrameBgActive()
int ImGui_Col_FrameBgActive() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_FrameBgActive") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_FrameBgActive()
Int ImGui_Col_FrameBgActive()
int ImGui_Col_FrameBgHovered()
int ImGui_Col_FrameBgHovered() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_FrameBgHovered") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_FrameBgHovered()
Int ImGui_Col_FrameBgHovered()
int ImGui_Col_Header()
int ImGui_Col_Header() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_Header") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_Header()
Int ImGui_Col_Header()

Header* colors are used for ImGui_CollapsingHeader, ImGui_TreeNode, ImGui_Selectable, ImGui_MenuItem.

int ImGui_Col_HeaderActive()
int ImGui_Col_HeaderActive() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_HeaderActive") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_HeaderActive()
Int ImGui_Col_HeaderActive()
int ImGui_Col_HeaderHovered()
int ImGui_Col_HeaderHovered() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_HeaderHovered") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_HeaderHovered()
Int ImGui_Col_HeaderHovered()
int ImGui_Col_MenuBarBg()
int ImGui_Col_MenuBarBg() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_MenuBarBg") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_MenuBarBg()
Int ImGui_Col_MenuBarBg()
int ImGui_Col_ModalWindowDimBg()
int ImGui_Col_ModalWindowDimBg() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_ModalWindowDimBg") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_ModalWindowDimBg()
Int ImGui_Col_ModalWindowDimBg()

Darken/colorize entire screen behind a modal window, when one is active.

int ImGui_Col_NavHighlight()
int ImGui_Col_NavHighlight() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_NavHighlight") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_NavHighlight()
Int ImGui_Col_NavHighlight()

Gamepad/keyboard: current highlighted item.

int ImGui_Col_NavWindowingDimBg()
int ImGui_Col_NavWindowingDimBg() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_NavWindowingDimBg") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_NavWindowingDimBg()
Int ImGui_Col_NavWindowingDimBg()

Darken/colorize entire screen behind the CTRL+TAB window list, when active.

int ImGui_Col_NavWindowingHighlight()
int ImGui_Col_NavWindowingHighlight() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_NavWindowingHighlight") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_NavWindowingHighlight()
Int ImGui_Col_NavWindowingHighlight()

Highlight window when using CTRL+TAB.

int ImGui_Col_PlotHistogram()
int ImGui_Col_PlotHistogram() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_PlotHistogram") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_PlotHistogram()
Int ImGui_Col_PlotHistogram()
int ImGui_Col_PlotHistogramHovered()
int ImGui_Col_PlotHistogramHovered() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_PlotHistogramHovered") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_PlotHistogramHovered()
Int ImGui_Col_PlotHistogramHovered()
int ImGui_Col_PlotLines()
int ImGui_Col_PlotLines() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_PlotLines") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_PlotLines()
Int ImGui_Col_PlotLines()
int ImGui_Col_PlotLinesHovered()
int ImGui_Col_PlotLinesHovered() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_PlotLinesHovered") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_PlotLinesHovered()
Int ImGui_Col_PlotLinesHovered()
int ImGui_Col_PopupBg()
int ImGui_Col_PopupBg() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_PopupBg") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_PopupBg()
Int ImGui_Col_PopupBg()

Background of popups, menus, tooltips windows.

int ImGui_Col_ResizeGrip()
int ImGui_Col_ResizeGrip() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_ResizeGrip") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_ResizeGrip()
Int ImGui_Col_ResizeGrip()
int ImGui_Col_ResizeGripActive()
int ImGui_Col_ResizeGripActive() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_ResizeGripActive") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_ResizeGripActive()
Int ImGui_Col_ResizeGripActive()
int ImGui_Col_ResizeGripHovered()
int ImGui_Col_ResizeGripHovered() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_ResizeGripHovered") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_ResizeGripHovered()
Int ImGui_Col_ResizeGripHovered()
int ImGui_Col_ScrollbarBg()
int ImGui_Col_ScrollbarBg() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_ScrollbarBg") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_ScrollbarBg()
Int ImGui_Col_ScrollbarBg()
int ImGui_Col_ScrollbarGrab()
int ImGui_Col_ScrollbarGrab() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_ScrollbarGrab") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_ScrollbarGrab()
Int ImGui_Col_ScrollbarGrab()
int ImGui_Col_ScrollbarGrabActive()
int ImGui_Col_ScrollbarGrabActive() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_ScrollbarGrabActive") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_ScrollbarGrabActive()
Int ImGui_Col_ScrollbarGrabActive()
int ImGui_Col_ScrollbarGrabHovered()
int ImGui_Col_ScrollbarGrabHovered() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_ScrollbarGrabHovered") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_ScrollbarGrabHovered()
Int ImGui_Col_ScrollbarGrabHovered()
int ImGui_Col_Separator()
int ImGui_Col_Separator() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_Separator") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_Separator()
Int ImGui_Col_Separator()
int ImGui_Col_SeparatorActive()
int ImGui_Col_SeparatorActive() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_SeparatorActive") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_SeparatorActive()
Int ImGui_Col_SeparatorActive()
int ImGui_Col_SeparatorHovered()
int ImGui_Col_SeparatorHovered() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_SeparatorHovered") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_SeparatorHovered()
Int ImGui_Col_SeparatorHovered()
int ImGui_Col_SliderGrab()
int ImGui_Col_SliderGrab() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_SliderGrab") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_SliderGrab()
Int ImGui_Col_SliderGrab()
int ImGui_Col_SliderGrabActive()
int ImGui_Col_SliderGrabActive() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_SliderGrabActive") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_SliderGrabActive()
Int ImGui_Col_SliderGrabActive()
int ImGui_Col_Tab()
int ImGui_Col_Tab() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_Tab") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_Tab()
Int ImGui_Col_Tab()
int ImGui_Col_TabActive()
int ImGui_Col_TabActive() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_TabActive") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_TabActive()
Int ImGui_Col_TabActive()
int ImGui_Col_TabHovered()
int ImGui_Col_TabHovered() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_TabHovered") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_TabHovered()
Int ImGui_Col_TabHovered()
int ImGui_Col_TabUnfocused()
int ImGui_Col_TabUnfocused() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_TabUnfocused") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_TabUnfocused()
Int ImGui_Col_TabUnfocused()
int ImGui_Col_TabUnfocusedActive()
int ImGui_Col_TabUnfocusedActive() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_TabUnfocusedActive") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_TabUnfocusedActive()
Int ImGui_Col_TabUnfocusedActive()
int ImGui_Col_TableBorderLight()
int ImGui_Col_TableBorderLight() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_TableBorderLight") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_TableBorderLight()
Int ImGui_Col_TableBorderLight()

Table inner borders (prefer using Alpha=1.0 here).

int ImGui_Col_TableBorderStrong()
int ImGui_Col_TableBorderStrong() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_TableBorderStrong") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_TableBorderStrong()
Int ImGui_Col_TableBorderStrong()

Table outer and header borders (prefer using Alpha=1.0 here).

int ImGui_Col_TableHeaderBg()
int ImGui_Col_TableHeaderBg() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_TableHeaderBg") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_TableHeaderBg()
Int ImGui_Col_TableHeaderBg()

Table header background.

int ImGui_Col_TableRowBg()
int ImGui_Col_TableRowBg() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_TableRowBg") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_TableRowBg()
Int ImGui_Col_TableRowBg()

Table row background (even rows).

int ImGui_Col_TableRowBgAlt()
int ImGui_Col_TableRowBgAlt() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_TableRowBgAlt") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_TableRowBgAlt()
Int ImGui_Col_TableRowBgAlt()

Table row background (odd rows).

int ImGui_Col_Text()
int ImGui_Col_Text() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_Text") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_Text()
Int ImGui_Col_Text()
int ImGui_Col_TextDisabled()
int ImGui_Col_TextDisabled() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_TextDisabled") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_TextDisabled()
Int ImGui_Col_TextDisabled()
int ImGui_Col_TextSelectedBg()
int ImGui_Col_TextSelectedBg() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_TextSelectedBg") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_TextSelectedBg()
Int ImGui_Col_TextSelectedBg()
int ImGui_Col_TitleBg()
int ImGui_Col_TitleBg() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_TitleBg") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_TitleBg()
Int ImGui_Col_TitleBg()
int ImGui_Col_TitleBgActive()
int ImGui_Col_TitleBgActive() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_TitleBgActive") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_TitleBgActive()
Int ImGui_Col_TitleBgActive()
int ImGui_Col_TitleBgCollapsed()
int ImGui_Col_TitleBgCollapsed() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_TitleBgCollapsed") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_TitleBgCollapsed()
Int ImGui_Col_TitleBgCollapsed()
int ImGui_Col_WindowBg()
int ImGui_Col_WindowBg() (requires REAPER 6.24 or later)
int extension_api("ImGui_Col_WindowBg") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Col_WindowBg()
Int ImGui_Col_WindowBg()

Background of normal windows.

bool ImGui_CollapsingHeader(ImGui_Context* ctx, const char* label, bool* p_visibleInOut, int* flagsInOptional)
bool ImGui_CollapsingHeader(ImGui_Context ctx, "label", bool &p_visible, optional int flagsIn) (requires REAPER 6.24 or later)
bool extension_api("ImGui_CollapsingHeader", ImGui_Context ctx, "label", bool &p_visible, optional int flagsIn) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean retval, boolean p_visible = reaper.ImGui_CollapsingHeader(ImGui_Context ctx, string label, boolean p_visible, optional integer flagsIn)
(Boolean retval, ImGui_Context ctx, String label, Boolean p_visibleInOut, Int flagsInOptional) = ImGui_CollapsingHeader(ctx, label, p_visibleInOut, flagsInOptional)

Returns true when opened but do not indent nor push into the ID stack (because of the ImGui_TreeNodeFlags_NoTreePushOnOpen flag).

This is basically the same as calling TreeNode(label, ImGui_TreeNodeFlags_CollapsingHeader). You can remove the _NoTreePushOnOpen flag if you want behavior closer to normal ImGui_TreeNode.

When 'visible' is provided: if 'true' display an additional small close button on upper right of the header which will set the bool to false when clicked, if 'false' don't display the header.

Default values: flags = ImGui_TreeNodeFlags_None

bool ImGui_ColorButton(ImGui_Context* ctx, const char* desc_id, int col_rgba, int* flagsInOptional, double* size_wInOptional, double* size_hInOptional)
bool ImGui_ColorButton(ImGui_Context ctx, "desc_id", int col_rgba, optional int flagsIn, optional size_wIn, optional size_hIn) (requires REAPER 6.24 or later)
bool extension_api("ImGui_ColorButton", ImGui_Context ctx, "desc_id", int col_rgba, optional int flagsIn, optional size_wIn, optional size_hIn) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean reaper.ImGui_ColorButton(ImGui_Context ctx, string desc_id, integer col_rgba, optional integer flagsIn, optional number size_wIn, optional number size_hIn)
(Boolean retval, ImGui_Context ctx, String desc_id, Int col_rgba, Int flagsInOptional, Float size_wInOptional, Float size_hInOptional) = ImGui_ColorButton(ctx, desc_id, col_rgba, flagsInOptional, size_wInOptional, size_hInOptional)

Display a color square/button, hover for details, return true when pressed.

Default values: flags = ImGui_ColorEditFlags_None, size_w = 0.0, size_h = 0.0

int ImGui_ColorConvertHSVtoRGB(double h, double s, double v, double* alphaInOptional, double* rOut, double* gOut, double* bOut)
int ImGui_ColorConvertHSVtoRGB(h, s, v, optional alphaIn, &r, &g, &b) (requires REAPER 6.24 or later)
int extension_api("ImGui_ColorConvertHSVtoRGB", h, s, v, optional alphaIn, &r, &g, &b) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer retval, number r, number g, number b = reaper.ImGui_ColorConvertHSVtoRGB(number h, number s, number v, optional number alphaIn)
(Int retval, Float h, Float s, Float v, Float alphaInOptional, Float rOut, Float gOut, Float bOut) = ImGui_ColorConvertHSVtoRGB(h, s, v, alphaInOptional, rOut, gOut, bOut)

Return 0x00RRGGBB or, if alpha is provided, 0xRRGGBBAA.

Default values: alpha = nil

int ImGui_ColorConvertNative(int rgb)
int ImGui_ColorConvertNative(int rgb) (requires REAPER 6.24 or later)
int extension_api("ImGui_ColorConvertNative", int rgb) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ColorConvertNative(integer rgb)
Int ImGui_ColorConvertNative(Int rgb)

Convert native colors coming from REAPER. This swaps the red and blue channels of the specified 0xRRGGBB color on Windows.

int ImGui_ColorConvertRGBtoHSV(double r, double g, double b, double* alphaInOptional, double* hOut, double* sOut, double* vOut)
int ImGui_ColorConvertRGBtoHSV(r, g, b, optional alphaIn, &h, &s, &v) (requires REAPER 6.24 or later)
int extension_api("ImGui_ColorConvertRGBtoHSV", r, g, b, optional alphaIn, &h, &s, &v) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer retval, number h, number s, number v = reaper.ImGui_ColorConvertRGBtoHSV(number r, number g, number b, optional number alphaIn)
(Int retval, Float r, Float g, Float b, Float alphaInOptional, Float hOut, Float sOut, Float vOut) = ImGui_ColorConvertRGBtoHSV(r, g, b, alphaInOptional, hOut, sOut, vOut)

Return 0x00HHSSVV or, if alpha is provided, 0xHHSSVVAA.

Default values: alpha = nil

bool ImGui_ColorEdit3(ImGui_Context* ctx, const char* label, int* col_rgbInOut, int* flagsInOptional)
bool ImGui_ColorEdit3(ImGui_Context ctx, "label", int &col_rgb, optional int flagsIn) (requires REAPER 6.24 or later)
bool extension_api("ImGui_ColorEdit3", ImGui_Context ctx, "label", int &col_rgb, optional int flagsIn) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean retval, integer col_rgb = reaper.ImGui_ColorEdit3(ImGui_Context ctx, string label, integer col_rgb, optional integer flagsIn)
(Boolean retval, ImGui_Context ctx, String label, Int col_rgbInOut, Int flagsInOptional) = ImGui_ColorEdit3(ctx, label, col_rgbInOut, flagsInOptional)

Color is in 0xXXRRGGBB. XX is ignored and will not be modified.

Tip: the ColorEdit* functions have a little color square that can be left-clicked to open a picker, and right-clicked to open an option menu.

Default values: flags = ImGui_ColorEditFlags_None

bool ImGui_ColorEdit4(ImGui_Context* ctx, const char* label, int* col_rgbaInOut, int* flagsInOptional)
bool ImGui_ColorEdit4(ImGui_Context ctx, "label", int &col_rgba, optional int flagsIn) (requires REAPER 6.24 or later)
bool extension_api("ImGui_ColorEdit4", ImGui_Context ctx, "label", int &col_rgba, optional int flagsIn) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean retval, integer col_rgba = reaper.ImGui_ColorEdit4(ImGui_Context ctx, string label, integer col_rgba, optional integer flagsIn)
(Boolean retval, ImGui_Context ctx, String label, Int col_rgbaInOut, Int flagsInOptional) = ImGui_ColorEdit4(ctx, label, col_rgbaInOut, flagsInOptional)

Color is in 0xRRGGBBAA or, if ImGui_ColorEditFlags_NoAlpha is set, 0xXXRRGGBB (XX is ignored and will not be modified).

Tip: the ColorEdit* functions have a little color square that can be left-clicked to open a picker, and right-clicked to open an option menu.

Default values: flags = ImGui_ColorEditFlags_None

int ImGui_ColorEditFlags_AlphaBar()
int ImGui_ColorEditFlags_AlphaBar() (requires REAPER 6.24 or later)
int extension_api("ImGui_ColorEditFlags_AlphaBar") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ColorEditFlags_AlphaBar()
Int ImGui_ColorEditFlags_AlphaBar()

ColorEdit, ColorPicker: show vertical alpha bar/gradient in picker.

int ImGui_ColorEditFlags_AlphaPreview()
int ImGui_ColorEditFlags_AlphaPreview() (requires REAPER 6.24 or later)
int extension_api("ImGui_ColorEditFlags_AlphaPreview") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ColorEditFlags_AlphaPreview()
Int ImGui_ColorEditFlags_AlphaPreview()

ColorEdit, ColorPicker, ColorButton: display preview as a transparent color over a checkerboard, instead of opaque.

int ImGui_ColorEditFlags_AlphaPreviewHalf()
int ImGui_ColorEditFlags_AlphaPreviewHalf() (requires REAPER 6.24 or later)
int extension_api("ImGui_ColorEditFlags_AlphaPreviewHalf") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ColorEditFlags_AlphaPreviewHalf()
Int ImGui_ColorEditFlags_AlphaPreviewHalf()

ColorEdit, ColorPicker, ColorButton: display half opaque / half checkerboard, instead of opaque.

int ImGui_ColorEditFlags_DisplayHSV()
int ImGui_ColorEditFlags_DisplayHSV() (requires REAPER 6.24 or later)
int extension_api("ImGui_ColorEditFlags_DisplayHSV") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ColorEditFlags_DisplayHSV()
Int ImGui_ColorEditFlags_DisplayHSV()

ColorEdit: override _display_ type to HSV. ColorPicker: select any combination using one or more of RGB/HSV/Hex.

int ImGui_ColorEditFlags_DisplayHex()
int ImGui_ColorEditFlags_DisplayHex() (requires REAPER 6.24 or later)
int extension_api("ImGui_ColorEditFlags_DisplayHex") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ColorEditFlags_DisplayHex()
Int ImGui_ColorEditFlags_DisplayHex()

ColorEdit: override _display_ type to Hex. ColorPicker: select any combination using one or more of RGB/HSV/Hex.

int ImGui_ColorEditFlags_DisplayRGB()
int ImGui_ColorEditFlags_DisplayRGB() (requires REAPER 6.24 or later)
int extension_api("ImGui_ColorEditFlags_DisplayRGB") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ColorEditFlags_DisplayRGB()
Int ImGui_ColorEditFlags_DisplayRGB()

ColorEdit: override _display_ type to RGB. ColorPicker: select any combination using one or more of RGB/HSV/Hex.

int ImGui_ColorEditFlags_Float()
int ImGui_ColorEditFlags_Float() (requires REAPER 6.24 or later)
int extension_api("ImGui_ColorEditFlags_Float") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ColorEditFlags_Float()
Int ImGui_ColorEditFlags_Float()

ColorEdit, ColorPicker, ColorButton: _display_ values formatted as 0.0..1.0 floats instead of 0..255 integers. No round-trip of value via integers.

int ImGui_ColorEditFlags_InputHSV()
int ImGui_ColorEditFlags_InputHSV() (requires REAPER 6.24 or later)
int extension_api("ImGui_ColorEditFlags_InputHSV") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ColorEditFlags_InputHSV()
Int ImGui_ColorEditFlags_InputHSV()

ColorEdit, ColorPicker: input and output data in HSV format.

int ImGui_ColorEditFlags_InputRGB()
int ImGui_ColorEditFlags_InputRGB() (requires REAPER 6.24 or later)
int extension_api("ImGui_ColorEditFlags_InputRGB") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ColorEditFlags_InputRGB()
Int ImGui_ColorEditFlags_InputRGB()

ColorEdit, ColorPicker: input and output data in RGB format.

int ImGui_ColorEditFlags_NoAlpha()
int ImGui_ColorEditFlags_NoAlpha() (requires REAPER 6.24 or later)
int extension_api("ImGui_ColorEditFlags_NoAlpha") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ColorEditFlags_NoAlpha()
Int ImGui_ColorEditFlags_NoAlpha()

ColorEdit, ColorPicker, ColorButton: ignore Alpha component (will only read 3 components from the input pointer).

int ImGui_ColorEditFlags_NoBorder()
int ImGui_ColorEditFlags_NoBorder() (requires REAPER 6.24 or later)
int extension_api("ImGui_ColorEditFlags_NoBorder") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ColorEditFlags_NoBorder()
Int ImGui_ColorEditFlags_NoBorder()

ColorButton: disable border (which is enforced by default).

int ImGui_ColorEditFlags_NoDragDrop()
int ImGui_ColorEditFlags_NoDragDrop() (requires REAPER 6.24 or later)
int extension_api("ImGui_ColorEditFlags_NoDragDrop") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ColorEditFlags_NoDragDrop()
Int ImGui_ColorEditFlags_NoDragDrop()

ColorEdit: disable drag and drop target. ColorButton: disable drag and drop source.

int ImGui_ColorEditFlags_NoInputs()
int ImGui_ColorEditFlags_NoInputs() (requires REAPER 6.24 or later)
int extension_api("ImGui_ColorEditFlags_NoInputs") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ColorEditFlags_NoInputs()
Int ImGui_ColorEditFlags_NoInputs()

ColorEdit, ColorPicker: disable inputs sliders/text widgets (e.g. to show only the small preview color square).

int ImGui_ColorEditFlags_NoLabel()
int ImGui_ColorEditFlags_NoLabel() (requires REAPER 6.24 or later)
int extension_api("ImGui_ColorEditFlags_NoLabel") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ColorEditFlags_NoLabel()
Int ImGui_ColorEditFlags_NoLabel()

ColorEdit, ColorPicker: disable display of inline text label (the label is still forwarded to the tooltip and picker).

int ImGui_ColorEditFlags_NoOptions()
int ImGui_ColorEditFlags_NoOptions() (requires REAPER 6.24 or later)
int extension_api("ImGui_ColorEditFlags_NoOptions") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ColorEditFlags_NoOptions()
Int ImGui_ColorEditFlags_NoOptions()

ColorEdit: disable toggling options menu when right-clicking on inputs/small preview.

int ImGui_ColorEditFlags_NoPicker()
int ImGui_ColorEditFlags_NoPicker() (requires REAPER 6.24 or later)
int extension_api("ImGui_ColorEditFlags_NoPicker") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ColorEditFlags_NoPicker()
Int ImGui_ColorEditFlags_NoPicker()

ColorEdit: disable picker when clicking on color square.

int ImGui_ColorEditFlags_NoSidePreview()
int ImGui_ColorEditFlags_NoSidePreview() (requires REAPER 6.24 or later)
int extension_api("ImGui_ColorEditFlags_NoSidePreview") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ColorEditFlags_NoSidePreview()
Int ImGui_ColorEditFlags_NoSidePreview()

ColorPicker: disable bigger color preview on right side of the picker, use small color square preview instead.

int ImGui_ColorEditFlags_NoSmallPreview()
int ImGui_ColorEditFlags_NoSmallPreview() (requires REAPER 6.24 or later)
int extension_api("ImGui_ColorEditFlags_NoSmallPreview") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ColorEditFlags_NoSmallPreview()
Int ImGui_ColorEditFlags_NoSmallPreview()

ColorEdit, ColorPicker: disable color square preview next to the inputs. (e.g. to show only the inputs).

int ImGui_ColorEditFlags_NoTooltip()
int ImGui_ColorEditFlags_NoTooltip() (requires REAPER 6.24 or later)
int extension_api("ImGui_ColorEditFlags_NoTooltip") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ColorEditFlags_NoTooltip()
Int ImGui_ColorEditFlags_NoTooltip()

ColorEdit, ColorPicker, ColorButton: disable tooltip when hovering the preview.

int ImGui_ColorEditFlags_None()
int ImGui_ColorEditFlags_None() (requires REAPER 6.24 or later)
int extension_api("ImGui_ColorEditFlags_None") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ColorEditFlags_None()
Int ImGui_ColorEditFlags_None()

Flags for ImGui_ColorEdit3 / ImGui_ColorEdit4 / ImGui_ColorPicker3 / ImGui_ColorPicker4 / ImGui_ColorButton.

int ImGui_ColorEditFlags_PickerHueBar()
int ImGui_ColorEditFlags_PickerHueBar() (requires REAPER 6.24 or later)
int extension_api("ImGui_ColorEditFlags_PickerHueBar") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ColorEditFlags_PickerHueBar()
Int ImGui_ColorEditFlags_PickerHueBar()

ColorPicker: bar for Hue, rectangle for Sat/Value.

int ImGui_ColorEditFlags_PickerHueWheel()
int ImGui_ColorEditFlags_PickerHueWheel() (requires REAPER 6.24 or later)
int extension_api("ImGui_ColorEditFlags_PickerHueWheel") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ColorEditFlags_PickerHueWheel()
Int ImGui_ColorEditFlags_PickerHueWheel()

ColorPicker: wheel for Hue, triangle for Sat/Value.

int ImGui_ColorEditFlags_Uint8()
int ImGui_ColorEditFlags_Uint8() (requires REAPER 6.24 or later)
int extension_api("ImGui_ColorEditFlags_Uint8") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ColorEditFlags_Uint8()
Int ImGui_ColorEditFlags_Uint8()

ColorEdit, ColorPicker, ColorButton: _display_ values formatted as 0..255.

bool ImGui_ColorPicker3(ImGui_Context* ctx, const char* label, int* col_rgbInOut, int* flagsInOptional)
bool ImGui_ColorPicker3(ImGui_Context ctx, "label", int &col_rgb, optional int flagsIn) (requires REAPER 6.24 or later)
bool extension_api("ImGui_ColorPicker3", ImGui_Context ctx, "label", int &col_rgb, optional int flagsIn) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean retval, integer col_rgb = reaper.ImGui_ColorPicker3(ImGui_Context ctx, string label, integer col_rgb, optional integer flagsIn)
(Boolean retval, ImGui_Context ctx, String label, Int col_rgbInOut, Int flagsInOptional) = ImGui_ColorPicker3(ctx, label, col_rgbInOut, flagsInOptional)

Color is in 0xXXRRGGBB. XX is ignored and will not be modified.

Default values: flags = ImGui_ColorEditFlags_None

bool ImGui_ColorPicker4(ImGui_Context* ctx, const char* label, int* col_rgbaInOut, int* flagsInOptional, int* ref_colInOptional)
bool ImGui_ColorPicker4(ImGui_Context ctx, "label", int &col_rgba, optional int flagsIn, optional int ref_colIn) (requires REAPER 6.24 or later)
bool extension_api("ImGui_ColorPicker4", ImGui_Context ctx, "label", int &col_rgba, optional int flagsIn, optional int ref_colIn) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean retval, integer col_rgba = reaper.ImGui_ColorPicker4(ImGui_Context ctx, string label, integer col_rgba, optional integer flagsIn, optional integer ref_colIn)
(Boolean retval, ImGui_Context ctx, String label, Int col_rgbaInOut, Int flagsInOptional, Int ref_colInOptional) = ImGui_ColorPicker4(ctx, label, col_rgbaInOut, flagsInOptional, ref_colInOptional)

Default values: flags = ImGui_ColorEditFlags_None, ref_col = nil

bool ImGui_Combo(ImGui_Context* ctx, const char* label, int* current_itemInOut, char* items, int* popup_max_height_in_itemsInOptional)
bool ImGui_Combo(ImGui_Context ctx, "label", int &current_item, #items, optional int popup_max_height_in_itemsIn) (requires REAPER 6.24 or later)
bool extension_api("ImGui_Combo", ImGui_Context ctx, "label", int &current_item, #items, optional int popup_max_height_in_itemsIn) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
boolean retval, integer current_item, string items = reaper.ImGui_Combo(ImGui_Context ctx, string label, integer current_item, string items, optional integer popup_max_height_in_itemsIn)
(Boolean retval, ImGui_Context ctx, String label, Int current_itemInOut, String items, Int popup_max_height_in_itemsInOptional) = ImGui_Combo(ctx, label, current_itemInOut, items, popup_max_height_in_itemsInOptional)

Helper over ImGui_BeginCombo/ImGui_EndCombo for convenience purpose. Use \31 (ASCII Unit Separator) to separate items within the string and to terminate it.

Default values: popup_max_height_in_items = -1

int ImGui_ComboFlags_HeightLarge()
int ImGui_ComboFlags_HeightLarge() (requires REAPER 6.24 or later)
int extension_api("ImGui_ComboFlags_HeightLarge") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ComboFlags_HeightLarge()
Int ImGui_ComboFlags_HeightLarge()

Max ~20 items visible.

int ImGui_ComboFlags_HeightLargest()
int ImGui_ComboFlags_HeightLargest() (requires REAPER 6.24 or later)
int extension_api("ImGui_ComboFlags_HeightLargest") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ComboFlags_HeightLargest()
Int ImGui_ComboFlags_HeightLargest()

As many fitting items as possible.

int ImGui_ComboFlags_HeightRegular()
int ImGui_ComboFlags_HeightRegular() (requires REAPER 6.24 or later)
int extension_api("ImGui_ComboFlags_HeightRegular") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ComboFlags_HeightRegular()
Int ImGui_ComboFlags_HeightRegular()

Max ~8 items visible (default).

int ImGui_ComboFlags_HeightSmall()
int ImGui_ComboFlags_HeightSmall() (requires REAPER 6.24 or later)
int extension_api("ImGui_ComboFlags_HeightSmall") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ComboFlags_HeightSmall()
Int ImGui_ComboFlags_HeightSmall()

Max ~4 items visible. Tip: If you want your combo popup to be a specific size you can use ImGui_SetNextWindowSizeConstraints prior to calling ImGui_BeginCombo.

int ImGui_ComboFlags_NoArrowButton()
int ImGui_ComboFlags_NoArrowButton() (requires REAPER 6.24 or later)
int extension_api("ImGui_ComboFlags_NoArrowButton") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ComboFlags_NoArrowButton()
Int ImGui_ComboFlags_NoArrowButton()

Display on the preview box without the square arrow button.

int ImGui_ComboFlags_NoPreview()
int ImGui_ComboFlags_NoPreview() (requires REAPER 6.24 or later)
int extension_api("ImGui_ComboFlags_NoPreview") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ComboFlags_NoPreview()
Int ImGui_ComboFlags_NoPreview()

Display only a square arrow button.

int ImGui_ComboFlags_None()
int ImGui_ComboFlags_None() (requires REAPER 6.24 or later)
int extension_api("ImGui_ComboFlags_None") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ComboFlags_None()
Int ImGui_ComboFlags_None()

Flags for ImGui_BeginCombo.

int ImGui_ComboFlags_PopupAlignLeft()
int ImGui_ComboFlags_PopupAlignLeft() (requires REAPER 6.24 or later)
int extension_api("ImGui_ComboFlags_PopupAlignLeft") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ComboFlags_PopupAlignLeft()
Int ImGui_ComboFlags_PopupAlignLeft()

Align the popup toward the left by default.

int ImGui_Cond_Always()
int ImGui_Cond_Always() (requires REAPER 6.24 or later)
int extension_api("ImGui_Cond_Always") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Cond_Always()
Int ImGui_Cond_Always()

No condition (always set the variable).

int ImGui_Cond_Appearing()
int ImGui_Cond_Appearing() (requires REAPER 6.24 or later)
int extension_api("ImGui_Cond_Appearing") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Cond_Appearing()
Int ImGui_Cond_Appearing()

Set the variable if the object/window is appearing after being hidden/inactive (or the first time).

int ImGui_Cond_FirstUseEver()
int ImGui_Cond_FirstUseEver() (requires REAPER 6.24 or later)
int extension_api("ImGui_Cond_FirstUseEver") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Cond_FirstUseEver()
Int ImGui_Cond_FirstUseEver()

Set the variable if the object/window has no persistently saved data (no entry in .ini file).

int ImGui_Cond_Once()
int ImGui_Cond_Once() (requires REAPER 6.24 or later)
int extension_api("ImGui_Cond_Once") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Cond_Once()
Int ImGui_Cond_Once()

Set the variable once per runtime session (only the first call will succeed).

int ImGui_ConfigFlags_DockingEnable()
int ImGui_ConfigFlags_DockingEnable() (requires REAPER 6.24 or later)
int extension_api("ImGui_ConfigFlags_DockingEnable") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ConfigFlags_DockingEnable()
Int ImGui_ConfigFlags_DockingEnable()

[BETA] Enable docking functionality.

int ImGui_ConfigFlags_NavEnableKeyboard()
int ImGui_ConfigFlags_NavEnableKeyboard() (requires REAPER 6.24 or later)
int extension_api("ImGui_ConfigFlags_NavEnableKeyboard") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ConfigFlags_NavEnableKeyboard()
Int ImGui_ConfigFlags_NavEnableKeyboard()

Master keyboard navigation enable flag.

int ImGui_ConfigFlags_NavEnableSetMousePos()
int ImGui_ConfigFlags_NavEnableSetMousePos() (requires REAPER 6.24 or later)
int extension_api("ImGui_ConfigFlags_NavEnableSetMousePos") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ConfigFlags_NavEnableSetMousePos()
Int ImGui_ConfigFlags_NavEnableSetMousePos()

Instruct navigation to move the mouse cursor.

int ImGui_ConfigFlags_NoMouse()
int ImGui_ConfigFlags_NoMouse() (requires REAPER 6.24 or later)
int extension_api("ImGui_ConfigFlags_NoMouse") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ConfigFlags_NoMouse()
Int ImGui_ConfigFlags_NoMouse()

Instruct imgui to ignore mouse position/buttons.

int ImGui_ConfigFlags_NoMouseCursorChange()
int ImGui_ConfigFlags_NoMouseCursorChange() (requires REAPER 6.24 or later)
int extension_api("ImGui_ConfigFlags_NoMouseCursorChange") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ConfigFlags_NoMouseCursorChange()
Int ImGui_ConfigFlags_NoMouseCursorChange()

Instruct backend to not alter mouse cursor shape and visibility.

int ImGui_ConfigFlags_NoSavedSettings()
int ImGui_ConfigFlags_NoSavedSettings() (requires REAPER 6.24 or later)
int extension_api("ImGui_ConfigFlags_NoSavedSettings") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ConfigFlags_NoSavedSettings()
Int ImGui_ConfigFlags_NoSavedSettings()

Disable state restoration and persistence for the whole context.

int ImGui_ConfigFlags_None()
int ImGui_ConfigFlags_None() (requires REAPER 6.24 or later)
int extension_api("ImGui_ConfigFlags_None") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_ConfigFlags_None()
Int ImGui_ConfigFlags_None()

Flags for ImGui_SetConfigFlags.

ImGui_Context* ImGui_CreateContext(const char* label, int* config_flagsInOptional)
ImGui_Context ImGui_CreateContext("label", optional int config_flagsIn) (requires REAPER 6.24 or later)
ImGui_Context extension_api("ImGui_CreateContext", "label", optional int config_flagsIn) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
ImGui_Context reaper.ImGui_CreateContext(string label, optional integer config_flagsIn)
(ImGui_Context retval, String label, Int config_flagsInOptional) = ImGui_CreateContext(label, config_flagsInOptional)

Create a new ReaImGui context. The context will remain valid as long as it is used in each defer cycle.

The label is used for the tab text when windows are docked in REAPER and also as a unique identifier for storing settings.

Default values: config_flags = ImGui_ConfigFlags_None

ImGui_Font* ImGui_CreateFont(const char* family_or_file, int size, int* flagsInOptional)
ImGui_Font ImGui_CreateFont("family_or_file", int size, optional int flagsIn) (requires REAPER 6.24 or later)
ImGui_Font extension_api("ImGui_CreateFont", "family_or_file", int size, optional int flagsIn) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
ImGui_Font reaper.ImGui_CreateFont(string family_or_file, integer size, optional integer flagsIn)
(ImGui_Font retval, String family_or_file, Int size, Int flagsInOptional) = ImGui_CreateFont(family_or_file, size, flagsInOptional)

Load a font matching a font family name or from a font file. The font will remain valid while it's attached to a context. See ImGui_AttachFont.

The family name can be an installed font or one of the generic fonts: sans-serif, serif, monospace, cursive, fantasy.

If 'family_or_file' specifies a path to a font file (contains a / or \):
- The first byte of 'flags' is used as the font index within the file
- The font styles in 'flags' are simulated by the font renderer

Default values: flags = ImGui_FontFlags_None

ImGui_ListClipper* ImGui_CreateListClipper(ImGui_Context* ctx)
ImGui_ListClipper ImGui_CreateListClipper(ImGui_Context ctx) (requires REAPER 6.24 or later)
ImGui_ListClipper extension_api("ImGui_CreateListClipper", ImGui_Context ctx) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
ImGui_ListClipper reaper.ImGui_CreateListClipper(ImGui_Context ctx)
ImGui_ListClipper ImGui_CreateListClipper(ImGui_Context ctx)

Helper: Manually clip large list of items.
If you are submitting lots of evenly spaced items and you have a random access to the list, you can perform coarse
clipping based on visibility to save yourself from processing those items at all.
The clipper calculates the range of visible items and advance the cursor to compensate for the non-visible items we have skipped.
(Dear ImGui already clip items based on their bounds but it needs to measure text size to do so, whereas manual coarse clipping before submission makes this cost and your own data fetching/submission cost almost null)

Usage:
  local clipper = reaper.ImGui_CreateListClipper(ctx)
  reaper.ImGui_ListClipper_Begin(clipper, 1000) -- We have 1000 elements, evenly spaced
  while reaper.ImGui_ListClipper_Step(clipper) do
    local display_start, display_end = reaper.ImGui_ListClipper_GetDisplayRange(clipper)
    for row = display_start, display_end - 1 do
      reaper.ImGui_Text(ctx, ("line number %d"):format(i))
    end

Generally what happens is:
- Clipper lets you process the first element (DisplayStart = 0, DisplayEnd = 1) regardless of it being visible or not.
- User code submit one element.
- Clipper can measure the height of the first element
- Clipper calculate the actual range of elements to display based on the current clipping rectangle, position the cursor before the first visible element.
- User code submit visible elements.

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.

ImGui_TextFilter* ImGui_CreateTextFilter(const char* default_filterInOptional)
ImGui_TextFilter ImGui_CreateTextFilter(optional "default_filterIn") (requires REAPER 6.24 or later)
ImGui_TextFilter extension_api("ImGui_CreateTextFilter", optional "default_filterIn") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
ImGui_TextFilter reaper.ImGui_CreateTextFilter(optional string default_filterIn)
ImGui_TextFilter ImGui_CreateTextFilter(String default_filterInOptional)

Parse and apply text filters. In format "aaaaa[,bbbb][,ccccc]". Valid until unused.

Default values: default_filter = ""

void ImGui_DestroyContext(ImGui_Context* ctx)
ImGui_DestroyContext(ImGui_Context ctx) (requires REAPER 6.24 or later)
extension_api("ImGui_DestroyContext", ImGui_Context ctx) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
reaper.ImGui_DestroyContext(ImGui_Context ctx)
ImGui_DestroyContext(ImGui_Context ctx)

Close and free the resources used by a context.

void ImGui_DetachFont(ImGui_Context* ctx, ImGui_Font* font)
ImGui_DetachFont(ImGui_Context ctx, ImGui_Font font) (requires REAPER 6.24 or later)
extension_api("ImGui_DetachFont", ImGui_Context ctx, ImGui_Font font) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
reaper.ImGui_DetachFont(ImGui_Context ctxImGui_Font font)
ImGui_DetachFont(ImGui_Context ctx, ImGui_Font font)

Unload a font from the given context. The font will be destroyed if is not attached to any context.

int ImGui_Dir_Down()
int ImGui_Dir_Down() (requires REAPER 6.24 or later)
int extension_api("ImGui_Dir_Down") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Dir_Down()
Int ImGui_Dir_Down()

A cardinal direction.

int ImGui_Dir_Left()
int ImGui_Dir_Left() (requires REAPER 6.24 or later)
int extension_api("ImGui_Dir_Left") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Dir_Left()
Int ImGui_Dir_Left()

A cardinal direction.

int ImGui_Dir_None()
int ImGui_Dir_None() (requires REAPER 6.24 or later)
int extension_api("ImGui_Dir_None") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Dir_None()
Int ImGui_Dir_None()

A cardinal direction.

int ImGui_Dir_Right()
int ImGui_Dir_Right() (requires REAPER 6.24 or later)
int extension_api("ImGui_Dir_Right") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Dir_Right()
Int ImGui_Dir_Right()

A cardinal direction.

int ImGui_Dir_Up()
int ImGui_Dir_Up() (requires REAPER 6.24 or later)
int extension_api("ImGui_Dir_Up") (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
integer reaper.ImGui_Dir_Up()
Int ImGui_Dir_Up()

A cardinal direction.

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)
bool ImGui_DragDouble(ImGui_Context ctx, "label", &v, optional v_speedIn, optional v_minIn, optional v_maxIn, optional "formatIn", optional int flagsIn) (requires REAPER 6.24 or later)
bool extension_api("ImGui_DragDouble", ImGui_Context ctx, "label", &v, optional v_speedIn, optional v_minIn, optional v_maxIn, optional "formatIn", optional int flagsIn) (legacy syntax, also useful for allowing script to run when third-party extension is not installed)
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 integer flagsIn)
(Boolean retval, ImGui_Context ctx, String label, Float vInOut, Float v_speedInOptional, Float v_minInOptional, Float v_maxInOptional, String formatInOptional, Int flagsInOptional) = ImGui_DragDouble(ctx, label, vInOut, v_speedInOptional, v_minInOptional, v_maxInOptional, formatInOptional, flagsInOptional