ReaScript API

From CockosWiki

(Difference between revisions)
Jump to: navigation, search
(Undo revision 13212 by Ucokane (Talk) - spam/vandalism)
 
(17 intermediate revisions not shown)
Line 1: Line 1:
 +
__NOTOC__
[[ReaScript|Back to main ReaScript page]]<br>
[[ReaScript|Back to main ReaScript page]]<br>
[[REAPER API|Back to main REAPER API page]]
[[REAPER API|Back to main REAPER API page]]
-
'''ReaScript API Documentation'''
+
=ReaScript API Documentation=
-
Don't forget - Call API functions using RPR_functionname() - Don't forget the RPR_
+
This page documents the ReaScript API functions.
-
Functions that cannot return information in the parameter list will return a single value, functions that '''can''' return information in the parameter list will return a list of values.
+
ReaScript uses a large part of The API (available in CC++).
-
'''Using these functions.'''
+
=Using these functions=
These functions each map onto a C++ function. C++ allows "pass by reference", which lets you pass a variable to a function in the parameter list and have the function change that parameter, so after this function call:
These functions each map onto a C++ function. C++ allows "pass by reference", which lets you pass a variable to a function in the parameter list and have the function change that parameter, so after this function call:
Line 14: Line 15:
x = MyFunc(&var);
x = MyFunc(&var);
</pre>
</pre>
-
the var variable might have a different value...
+
the var variable might well have a different value to the one it started with...
-
Perl and Python don't have compatible pass by reference mechanisms so when ReaScript sees a modifiable variable in the parameter list it returns '''all''' the values in the parameter list '''''and''''' the return value (if there is one) in an array, as in this example.
+
Perl and Python don't have compatible pass by reference mechanisms so when ReaScript sees a modifiable variable in the parameter list it returns '''all''' the values in the parameter list '''''and''''' the return value (if there is one) in an array, as in [[RPR_GetUserInputs|GetUserInputs()]] Go and look at it now if you haven't already done so. It will bite you if you don't understand it.
-
 
+
-
[[RPR_GetUserInputs|GetUserInputs()]]
+
Specific REAPER type pointers, like MediaItem*, are '''not''' considered modifiable by ReaScript when deciding whether to return a scalar or array from a particular function.
Specific REAPER type pointers, like MediaItem*, are '''not''' considered modifiable by ReaScript when deciding whether to return a scalar or array from a particular function.
-
''Anything in the API documentation that is marked with a '?' is an assumption or something the writer just isn't sure about. If you happen to know whatever it is for certain - please correct or confirm the entry.
+
=Who is Allowed to Add to and Edit this Documentation?=
 +
You.
-
''Please add a brief note or correction if you see anything that's wrong or incomplete . Don't worry about making it look good if you don't have the time; someone will be along in a while with the time. Of course, don't hesitate to make it look cool if you *do* have the time... :o)''
+
No, really - you are. Don't hesitate to get stuck in if you think you know something that even '''''might''''' be of help to some poor muso feeling his or her way around the API.
 +
''Anything in the API documentation that is marked with a '?' is an assumption - or something the writer just isn't sure about. If you happen to know whatever it is for certain - please correct or confirm the entry. If you're not sure either but you have different ideas to the author - then use the "discussion" tab at the top of each page and start a conversation with the author or authors of that page.''
 +
 +
''Please add a brief note or correction if you see anything that's wrong or incomplete or if you've used the function and know something that might be of use to the next user.''
 +
 +
''Don't worry about making it look good if you're hurried; someone will be along in a while with the time. (Don't hesitate to make it look good if you *do* have the time... :o)''
 +
 +
=The ReaScript API Functions=
 +
 +
==ReaScript directives==
{|class="wikitable"
{|class="wikitable"
-
| [[RPR GetUserInputs|GetUserInputs()]]
+
! Directive!!Description
-
| [[RPR AddMediaItemToTrack|AddMediaItemToTrack]]
+
-
| [[RPR AddProjectMarker|AddProjectMarker]]
+
-
| [[RPR AddTakeToMediaItem|AddTakeToMediaItem]]
+
|-
|-
-
| [[RPR adjustZoom|adjustZoom]]
+
| [[RPR_include|include]]||Include another file in a script; it works in the same way as the #include directive in the C programming language.
-
| [[RPR APITest|APITest]]
+
|}
-
| [[RPR Audio IsPreBuffer|Audio_IsPreBuffer]]
+
 
-
| [[RPR Audio IsRunning|Audio_IsRunning]]
+
==Functions==
 +
Generated from REAPER v3.21 by [[mkReaScriptAPITable.pl]]
 +
 
 +
{|class="wikitable"
 +
| [[RPR_AddMediaItemToTrack|AddMediaItemToTrack]]
 +
| [[RPR_format_timestr|format_timestr]]
 +
| [[RPR_GetTrackEnvelopeByName|GetTrackEnvelopeByName]]
 +
| [[RPR_plugin_getImportableProjectFilterList|plugin_getImportableProjectFilterList]]
|-
|-
-
| [[RPR Audio RegHardwareHook|Audio_RegHardwareHook]]
+
| [[RPR_AddProjectMarker|AddProjectMarker]]
-
| [[RPR BypassFxAllTracks|BypassFxAllTracks]]
+
| [[RPR_format_timestr_len|format_timestr_len]]
-
| [[RPR CalculatePeaks|CalculatePeaks]]
+
| [[RPR_GetTrackGUID|GetTrackGUID]]
-
| [[RPR ClearAllRecArmed|ClearAllRecArmed]]
+
| [[RPR_PluginWantsAlwaysRunFx|PluginWantsAlwaysRunFx]]
|-
|-
-
| [[RPR ClearPeakCache|ClearPeakCache]]
+
| [[RPR_AddTakeToMediaItem|AddTakeToMediaItem]]
-
| [[RPR CountMediaItems|CountMediaItems]]
+
| [[RPR_format_timestr_pos|format_timestr_pos]]
-
| [[RPR CountSelectedMediaItems|CountSelectedMediaItems]]
+
| [[RPR_GetTrackMediaItem|GetTrackMediaItem]]
-
| [[RPR CountSelectedTracks|CountSelectedTracks]]
+
| [[RPR_projectconfig_var_addr|projectconfig_var_addr]]
|-
|-
-
| [[RPR CountTakes|CountTakes]]
+
| [[RPR_adjustZoom|adjustZoom]]
-
| [[RPR CountTrackEnvelopes|CountTrackEnvelopes]]
+
| [[RPR_get_config_var|get_config_var]]
-
| [[RPR CountTrackMediaItems|CountTrackMediaItems]]
+
| [[RPR_GetTrackMIDINoteName|GetTrackMIDINoteName]]
-
| [[RPR CountTracks|CountTracks]]
+
| [[RPR_projectconfig_var_getoffs|projectconfig_var_getoffs]]
|-
|-
-
| [[RPR CreateMIDIInput|CreateMIDIInput]]
+
| [[RPR_APITest|APITest]]
-
| [[RPR CreateMIDIOutput|CreateMIDIOutput]]
+
| [[RPR_get_ini_file|get_ini_file]]
-
| [[RPR CSurf FlushUndo|CSurf_FlushUndo]]
+
| [[RPR_GetTrackMIDINoteNameEx|GetTrackMIDINoteNameEx]]
-
| [[RPR CSurf GetTouchState|CSurf_GetTouchState]]
+
| [[RPR_ReaperGetPitchShiftAPI|ReaperGetPitchShiftAPI]]
|-
|-
-
| [[RPR CSurf GoEnd|CSurf_GoEnd]]
+
| [[RPR_Audio_IsPreBuffer|Audio_IsPreBuffer]]
-
| [[RPR CSurf GoStart|CSurf_GoStart]]
+
| [[RPR_GetActiveTake|GetActiveTake]]
-
| [[RPR CSurf NumTracks|CSurf_NumTracks]]
+
| [[RPR_GetTrackNumMediaItems|GetTrackNumMediaItems]]
-
| [[RPR CSurf OnArrow|CSurf_OnArrow]]
+
| [[RPR_relative_fn|relative_fn]]
|-
|-
-
| [[RPR CSurf OnFwd|CSurf_OnFwd]]
+
| [[RPR_Audio_IsRunning|Audio_IsRunning]]
-
| [[RPR CSurf OnFXChange|CSurf_OnFXChange]]
+
| [[RPR_GetColorThemeStruct|GetColorThemeStruct]]
-
| [[RPR CSurf OnMuteChange|CSurf_OnMuteChange]]
+
| [[RPR_GetTrackState|GetTrackState]]
-
| [[RPR CSurf OnPanChange|CSurf_OnPanChange]]
+
| [[RPR_Resample_EnumModes|Resample_EnumModes]]
|-
|-
-
| [[RPR CSurf OnPanChangeEx|CSurf_OnPanChangeEx]]
+
| [[RPR_Audio_RegHardwareHook|Audio_RegHardwareHook]]
-
| [[RPR CSurf OnPlay|CSurf_OnPlay]]
+
| [[RPR_GetCursorPosition|GetCursorPosition]]
-
| [[RPR CSurf OnRecArmChange|CSurf_OnRecArmChange]]
+
| [[RPR_GetTrackUIVolPan|GetTrackUIVolPan]]
-
| [[RPR CSurf OnRecord|CSurf_OnRecord]]
+
| [[RPR_Resampler_Create|Resampler_Create]]
|-
|-
-
| [[RPR CSurf OnRew|CSurf_OnRew]]
+
| [[RPR_BypassFxAllTracks|BypassFxAllTracks]]
-
| [[RPR CSurf OnSelectedChange|CSurf_OnSelectedChange]]
+
| [[RPR_GetCursorPositionEx|GetCursorPositionEx]]
-
| [[RPR CSurf OnSoloChange|CSurf_OnSoloChange]]
+
| [[RPR_GetUserFileNameForRead|GetUserFileNameForRead]]
-
| [[RPR CSurf OnStop|CSurf_OnStop]]
+
| [[RPR_resolve_fn|resolve_fn]]
|-
|-
-
| [[RPR CSurf OnTrackSelection|CSurf_OnTrackSelection]]
+
| [[RPR_CalculatePeaks|CalculatePeaks]]
-
| [[RPR CSurf OnVolumeChange|CSurf_OnVolumeChange]]
+
| [[RPR_GetEnvelopeName|GetEnvelopeName]]
-
| [[RPR CSurf OnVolumeChangeEx|CSurf_OnVolumeChangeEx]]
+
| [[RPR_GetUserInputs|GetUserInputs]]
-
| [[RPR CSurf ResetAllCachedVolPanStates|CSurf_ResetAllCachedVolPanStates]]
+
| [[RPR_screenset_register|screenset_register]]
|-
|-
-
| [[RPR CSurf ScrubAmt|CSurf_ScrubAmt]]
+
| [[RPR_ClearAllRecArmed|ClearAllRecArmed]]
-
| [[RPR CSurf SetAutoMode|CSurf_SetAutoMode]]
+
| [[RPR_GetExePath|GetExePath]]
-
| [[RPR CSurf SetPlayState|CSurf_SetPlayState]]
+
| [[RPR_GSC_mainwnd|GSC_mainwnd]]
-
| [[RPR CSurf SetRepeatState|CSurf_SetRepeatState]]
+
| [[RPR_screenset_unregister|screenset_unregister]]
|-
|-
-
| [[RPR CSurf SetSurfaceMute|CSurf_SetSurfaceMute]]
+
| [[RPR_ClearPeakCache|ClearPeakCache]]
-
| [[RPR CSurf SetSurfacePan|CSurf_SetSurfacePan]]
+
| [[RPR_GetHZoomLevel|GetHZoomLevel]]
-
| [[RPR CSurf SetSurfaceRecArm|CSurf_SetSurfaceRecArm]]
+
| [[RPR_guidToString|guidToString]]
-
| [[RPR CSurf SetSurfaceSelected|CSurf_SetSurfaceSelected]]
+
| [[RPR_screenset_unregisterByParam|screenset_unregisterByParam]]
|-
|-
-
| [[RPR CSurf SetSurfaceSolo|CSurf_SetSurfaceSolo]]
+
| [[RPR_CountMediaItems|CountMediaItems]]
-
| [[RPR CSurf SetSurfaceVolume|CSurf_SetSurfaceVolume]]
+
| [[RPR_GetIconThemePointer|GetIconThemePointer]]
-
| [[RPR CSurf SetTrackListChange|CSurf_SetTrackListChange]]
+
| [[RPR_HasTrackMIDIPrograms|HasTrackMIDIPrograms]]
-
| [[RPR CSurf TrackFromID|CSurf_TrackFromID]]
+
| [[RPR_SelectProjectInstance|SelectProjectInstance]]
|-
|-
-
| [[RPR CSurf TrackToID|CSurf_TrackToID]]
+
| [[RPR_CountSelectedMediaItems|CountSelectedMediaItems]]
-
| [[RPR DB2SLIDER|DB2SLIDER]]
+
| [[RPR_GetIconThemeStruct|GetIconThemeStruct]]
-
| [[RPR DeleteProjectMarker|DeleteProjectMarker]]
+
| [[RPR_HasTrackMIDIProgramsEx|HasTrackMIDIProgramsEx]]
-
| [[RPR DeleteTrack|DeleteTrack]]
+
| [[RPR_SetAutomationMode|SetAutomationMode]]
|-
|-
-
| [[RPR DeleteTrackMediaItem|DeleteTrackMediaItem]]
+
| [[RPR_CountSelectedTracks|CountSelectedTracks]]
-
| [[RPR DockWindowActivate|DockWindowActivate]]
+
| [[RPR_GetInputChannelName|GetInputChannelName]]
-
| [[RPR DockWindowAdd|DockWindowAdd]]
+
| [[RPR_HiresPeaksFromSource|HiresPeaksFromSource]]
-
| [[RPR DockWindowRemove|DockWindowRemove]]
+
| [[RPR_SetEditCurPos|SetEditCurPos]]
|-
|-
-
| [[RPR EnsureNotCompletelyOffscreen|EnsureNotCompletelyOffscreen]]
+
| [[RPR_CountTakes|CountTakes]]
-
| [[RPR EnumPitchShiftModes|EnumPitchShiftModes]]
+
| [[RPR_GetItemProjectContext|GetItemProjectContext]]
-
| [[RPR EnumPitchShiftSubModes|EnumPitchShiftSubModes]]
+
| [[RPR_InsertMedia|InsertMedia]]
-
| [[RPR EnumProjectMarkers|EnumProjectMarkers]]
+
| [[RPR_SetEditCurPos2|SetEditCurPos2]]
|-
|-
-
| [[RPR EnumProjectMarkers2|EnumProjectMarkers2]]
+
| [[RPR_CountTrackEnvelopes|CountTrackEnvelopes]]
-
| [[RPR EnumProjects|EnumProjects]]
+
| [[RPR_GetLastTouchedTrack|GetLastTouchedTrack]]
-
| [[RPR EnumTrackMIDIProgramNames|EnumTrackMIDIProgramNames]]
+
| [[RPR_InsertTrackAtIndex|InsertTrackAtIndex]]
-
| [[RPR EnumTrackMIDIProgramNamesEx|EnumTrackMIDIProgramNamesEx]]
+
| [[RPR_SetMediaItemInfo_Value|SetMediaItemInfo_Value]]
|-
|-
-
| [[RPR format timestr|format_timestr]]
+
| [[RPR_CountTrackMediaItems|CountTrackMediaItems]]
-
| [[RPR format timestr len|format_timestr_len]]
+
| [[RPR_GetMainHwnd|GetMainHwnd]]
-
| [[RPR format timestr pos|format_timestr_pos]]
+
| [[RPR_IsInRealTimeAudio|IsInRealTimeAudio]]
-
| [[RPR genGuid|genGuid]]
+
| [[RPR_SetMediaItemTakeInfo_Value|SetMediaItemTakeInfo_Value]]
|-
|-
-
| [[RPR get config var|get_config_var]]
+
| [[RPR_CountTracks|CountTracks]]
-
| [[RPR get ini file|get_ini_file]]
+
| [[RPR_GetMasterMuteSoloFlags|GetMasterMuteSoloFlags]]
-
| [[RPR GetActiveTake|GetActiveTake]]
+
| [[RPR_IsMediaExtension|IsMediaExtension]]
-
| [[RPR GetColorThemeStruct|GetColorThemeStruct]]
+
| [[RPR_SetMediaTrackInfo_Value|SetMediaTrackInfo_Value]]
|-
|-
-
| [[RPR GetCursorPosition|GetCursorPosition]]
+
| [[RPR_CreateMIDIInput|CreateMIDIInput]]
-
| [[RPR GetCursorPositionEx|GetCursorPositionEx]]
+
| [[RPR_GetMaxMidiInputs|GetMaxMidiInputs]]
-
| [[RPR GetEnvelopeName|GetEnvelopeName]]
+
| [[RPR_kbd_OnMidiEvent|kbd_OnMidiEvent]]
-
| [[RPR GetExePath|GetExePath]]
+
| [[RPR_SetProjectMarker|SetProjectMarker]]
|-
|-
-
| [[RPR GetHZoomLevel|GetHZoomLevel]]
+
| [[RPR_CreateMIDIOutput|CreateMIDIOutput]]
-
| [[RPR GetIconThemePointer|GetIconThemePointer]]
+
| [[RPR_GetMaxMidiOutputs|GetMaxMidiOutputs]]
-
| [[RPR GetIconThemeStruct|GetIconThemeStruct]]
+
| [[RPR_kbd_OnMidiList|kbd_OnMidiList]]
-
| [[RPR GetInputChannelName|GetInputChannelName]]
+
| [[RPR_SetProjectMarker2|SetProjectMarker2]]
|-
|-
-
| [[RPR GetItemProjectContext|GetItemProjectContext]]
+
| [[RPR_CSurf_FlushUndo|CSurf_FlushUndo]]
-
| [[RPR GetLastTouchedTrack|GetLastTouchedTrack]]
+
| [[RPR_GetMediaItem|GetMediaItem]]
-
| [[RPR GetMainHwnd|GetMainHwnd]]
+
| [[RPR_LICE_Blit|LICE_Blit]]
-
| [[RPR GetMasterMuteSoloFlags|GetMasterMuteSoloFlags]]
+
| [[RPR_SetTrackAutomationMode|SetTrackAutomationMode]]
|-
|-
-
| [[RPR GetMaxMidiInputs|GetMaxMidiInputs]]
+
| [[RPR_CSurf_GetTouchState|CSurf_GetTouchState]]
-
| [[RPR GetMaxMidiOutputs|GetMaxMidiOutputs]]
+
| [[RPR_GetMediaItem_Track|GetMediaItem_Track]]
-
| [[RPR GetMediaItem|GetMediaItem]]
+
| [[RPR_LICE_ClipLine|LICE_ClipLine]]
-
| [[RPR GetMediaItem Track|GetMediaItem_Track]]
+
| [[RPR_SetTrackMIDINoteName|SetTrackMIDINoteName]]
|-
|-
-
| [[RPR GetMediaItemInfo Value|GetMediaItemInfo_Value]]
+
| [[RPR_CSurf_GoEnd|CSurf_GoEnd]]
-
| [[RPR GetMediaItemNumTakes|GetMediaItemNumTakes]]
+
| [[RPR_GetMediaItemInfo_Value|GetMediaItemInfo_Value]]
-
| [[RPR GetMediaItemTake|GetMediaItemTake]]
+
| [[RPR_LICE_Line|LICE_Line]]
-
| [[RPR GetMediaItemTake Item|GetMediaItemTake_Item]]
+
| [[RPR_SetTrackMIDINoteNameEx|SetTrackMIDINoteNameEx]]
|-
|-
-
| [[RPR GetMediaItemTake Source|GetMediaItemTake_Source]]
+
| [[RPR_CSurf_GoStart|CSurf_GoStart]]
-
| [[RPR GetMediaItemTake Track|GetMediaItemTake_Track]]
+
| [[RPR_GetMediaItemNumTakes|GetMediaItemNumTakes]]
-
| [[RPR GetMediaItemTakeInfo Value|GetMediaItemTakeInfo_Value]]
+
| [[RPR_LICE_LineInt|LICE_LineInt]]
-
| [[RPR GetMediaTrackInfo Value|GetMediaTrackInfo_Value]]
+
| [[RPR_SetTrackSelected|SetTrackSelected]]
|-
|-
-
| [[RPR GetMidiInput|GetMidiInput]]
+
| [[RPR_CSurf_NumTracks|CSurf_NumTracks]]
-
| [[RPR GetMIDIInputName|GetMIDIInputName]]
+
| [[RPR_GetMediaItemTake|GetMediaItemTake]]
-
| [[RPR GetMidiOutput|GetMidiOutput]]
+
| [[RPR_Main_OnCommand|Main_OnCommand]]
-
| [[RPR GetMIDIOutputName|GetMIDIOutputName]]
+
| [[RPR_ShowActionList|ShowActionList]]
|-
|-
-
| [[RPR GetNumMIDIInputs|GetNumMIDIInputs]]
+
| [[RPR_CSurf_OnArrow|CSurf_OnArrow]]
-
| [[RPR GetNumMIDIOutputs|GetNumMIDIOutputs]]
+
| [[RPR_GetMediaItemTake_Item|GetMediaItemTake_Item]]
-
| [[RPR GetNumTracks|GetNumTracks]]
+
| [[RPR_Main_OnCommandEx|Main_OnCommandEx]]
-
| [[RPR GetOutputChannelName|GetOutputChannelName]]
+
| [[RPR_ShowConsoleMsg|ShowConsoleMsg]]
|-
|-
-
| [[RPR GetOutputLatency|GetOutputLatency]]
+
| [[RPR_CSurf_OnFwd|CSurf_OnFwd]]
-
| [[RPR GetPeakFileName|GetPeakFileName]]
+
| [[RPR_GetMediaItemTake_Source|GetMediaItemTake_Source]]
-
| [[RPR GetPeaksBitmap|GetPeaksBitmap]]
+
| [[RPR_Main_openProject|Main_openProject]]
-
| [[RPR GetPlayPosition|GetPlayPosition]]
+
| [[RPR_ShowMessageBox|ShowMessageBox]]
|-
|-
-
| [[RPR GetPlayPosition2|GetPlayPosition2]]
+
| [[RPR_CSurf_OnFXChange|CSurf_OnFXChange]]
-
| [[RPR GetPlayPosition2Ex|GetPlayPosition2Ex]]
+
| [[RPR_GetMediaItemTake_Track|GetMediaItemTake_Track]]
-
| [[RPR GetPlayPositionEx|GetPlayPositionEx]]
+
| [[RPR_Main_UpdateLoopInfo|Main_UpdateLoopInfo]]
-
| [[RPR GetPlayState|GetPlayState]]
+
| [[RPR_SLIDER2DB|SLIDER2DB]]
|-
|-
-
| [[RPR GetPlayStateEx|GetPlayStateEx]]
+
| [[RPR_CSurf_OnMuteChange|CSurf_OnMuteChange]]
-
| [[RPR GetProjectPath|GetProjectPath]]
+
| [[RPR_GetMediaItemTakeInfo_Value|GetMediaItemTakeInfo_Value]]
-
| [[RPR GetProjectPathEx|GetProjectPathEx]]
+
| [[RPR_Master_GetPlayRateAtTime|Master_GetPlayRateAtTime]]
-
| [[RPR GetProjectTimeSignature|GetProjectTimeSignature]]
+
| [[RPR_SoloAllTracks|SoloAllTracks]]
|-
|-
-
| [[RPR GetProjectTimeSignature2|GetProjectTimeSignature2]]
+
| [[RPR_CSurf_OnPanChange|CSurf_OnPanChange]]
-
| [[RPR GetSelectedMediaItem|GetSelectedMediaItem]]
+
| [[RPR_GetMediaTrackInfo_Value|GetMediaTrackInfo_Value]]
-
| [[RPR GetSelectedTrack|GetSelectedTrack]]
+
| [[RPR_MB|MB]]
-
| [[RPR GetSelectedTrackEnvelope|GetSelectedTrackEnvelope]]
+
| [[RPR_SplitMediaItem|SplitMediaItem]]
|-
|-
-
| [[RPR GetSet ArrangeView2|GetSet_ArrangeView2]]
+
| [[RPR_CSurf_OnPanChangeEx|CSurf_OnPanChangeEx]]
-
| [[RPR GetSet LoopTimeRange|GetSet_LoopTimeRange]]
+
| [[RPR_GetMidiInput|GetMidiInput]]
-
| [[RPR GetSet LoopTimeRange2|GetSet_LoopTimeRange2]]
+
| [[RPR_MIDI_eventlist_Create|MIDI_eventlist_Create]]
-
| [[RPR GetSetEnvelopeState|GetSetEnvelopeState]]
+
| [[RPR_StopPreview|StopPreview]]
|-
|-
-
| [[RPR GetSetItemState|GetSetItemState]]
+
| [[RPR_CSurf_OnPlay|CSurf_OnPlay]]
-
| [[RPR GetSetMediaItemTakeInfo String|GetSetMediaItemTakeInfo_String]]
+
| [[RPR_GetMIDIInputName|GetMIDIInputName]]
-
| [[RPR GetSetMediaTrackInfo String|GetSetMediaTrackInfo_String]]
+
| [[RPR_MIDI_eventlist_Destroy|MIDI_eventlist_Destroy]]
-
| [[RPR GetSetRepeat|GetSetRepeat]]
+
| [[RPR_StopTrackPreview|StopTrackPreview]]
|-
|-
-
| [[RPR GetSetRepeatEx|GetSetRepeatEx]]
+
| [[RPR_CSurf_OnRecArmChange|CSurf_OnRecArmChange]]
-
| [[RPR GetSetTrackState|'''''GetSetTrackState''''']]
+
| [[RPR_GetMidiOutput|GetMidiOutput]]
-
| [[RPR GetTake|GetTake]]
+
| [[RPR_MIDIEditor_GetActive|MIDIEditor_GetActive]]
-
| [[RPR GetTakeEnvelopeByName|GetTakeEnvelopeByName]]
+
| [[RPR_StopTrackPreview2|StopTrackPreview2]]
|-
|-
-
| [[RPR GetTooltipWindow|GetTooltipWindow]]
+
| [[RPR_CSurf_OnRecord|CSurf_OnRecord]]
-
| [[RPR GetTrack|GetTrack]]
+
| [[RPR_GetMIDIOutputName|GetMIDIOutputName]]
-
| [[RPR GetTrackAutomationMode|GetTrackAutomationMode]]
+
| [[RPR_MIDIEditor_GetMode|MIDIEditor_GetMode]]
-
| [[RPR GetTrackEnvelope|GetTrackEnvelope]]
+
| [[RPR_stringToGuid|stringToGuid]]
|-
|-
-
| [[RPR GetTrackEnvelopeByName|GetTrackEnvelopeByName]]
+
| [[RPR_CSurf_OnRew|CSurf_OnRew]]
-
| [[RPR GetTrackGUID|GetTrackGUID]]
+
| [[RPR_GetNumMIDIInputs|GetNumMIDIInputs]]
-
| [[RPR GetTrackMediaItem|GetTrackMediaItem]]
+
| [[RPR_MIDIEditor_OnCommand|MIDIEditor_OnCommand]]
-
| [[RPR GetTrackMIDINoteName|GetTrackMIDINoteName]]
+
| [[RPR_TimeMap2_beatsToTime|TimeMap2_beatsToTime]]
|-
|-
-
| [[RPR GetTrackMIDINoteNameEx|GetTrackMIDINoteNameEx]]
+
| [[RPR_CSurf_OnSelectedChange|CSurf_OnSelectedChange]]
-
| [[RPR GetTrackNumMediaItems|GetTrackNumMediaItems]]
+
| [[RPR_GetNumMIDIOutputs|GetNumMIDIOutputs]]
-
| [[RPR GetTrackState|GetTrackState]]
+
| [[RPR_mkpanstr|mkpanstr]]
-
| [[RPR GetTrackUIVolPan|GetTrackUIVolPan]]
+
| [[RPR_TimeMap2_GetDividedBpmAtTime|TimeMap2_GetDividedBpmAtTime]]
|-
|-
-
| [[RPR GetUserInputs|GetUserInputs]]
+
| [[RPR_CSurf_OnSoloChange|CSurf_OnSoloChange]]
-
| [[RPR GSC mainwnd|GSC_mainwnd]]
+
| [[RPR_GetNumTracks|GetNumTracks]]
-
| [[RPR guidToString|guidToString]]
+
| [[RPR_mkvolpanstr|mkvolpanstr]]
-
| [[RPR HasTrackMIDIPrograms|HasTrackMIDIPrograms]]
+
| [[RPR_TimeMap2_GetNextChangeTime|TimeMap2_GetNextChangeTime]]
|-
|-
-
| [[RPR HasTrackMIDIProgramsEx|HasTrackMIDIProgramsEx]]
+
| [[RPR_CSurf_OnStop|CSurf_OnStop]]
-
| [[RPR HiresPeaksFromSource|HiresPeaksFromSource]]
+
| [[RPR_GetOutputChannelName|GetOutputChannelName]]
-
| [[RPR InsertMedia|InsertMedia]]
+
| [[RPR_mkvolstr|mkvolstr]]
-
| [[RPR InsertTrackAtIndex|InsertTrackAtIndex]]
+
| [[RPR_TimeMap2_QNToTime|TimeMap2_QNToTime]]
|-
|-
-
| [[RPR IsInRealTimeAudio|IsInRealTimeAudio]]
+
| [[RPR_CSurf_OnTrackSelection|CSurf_OnTrackSelection]]
-
| [[RPR IsMediaExtension|IsMediaExtension]]
+
| [[RPR_GetOutputLatency|GetOutputLatency]]
-
| [[RPR kbd OnMidiEvent|kbd_OnMidiEvent]]
+
| [[RPR_MoveEditCursor|MoveEditCursor]]
-
| [[RPR kbd OnMidiList|kbd_OnMidiList]]
+
| [[RPR_TimeMap2_timeToBeats|TimeMap2_timeToBeats]]
|-
|-
-
| [[RPR LICE Blit|LICE_Blit]]
+
| [[RPR_CSurf_OnVolumeChange|CSurf_OnVolumeChange]]
-
| [[RPR LICE ClipLine|LICE_ClipLine]]
+
| [[RPR_GetPeakFileName|GetPeakFileName]]
-
| [[RPR LICE Line|LICE_Line]]
+
| [[RPR_MoveMediaItemToTrack|MoveMediaItemToTrack]]
-
| [[RPR LICE LineInt|LICE_LineInt]]
+
| [[RPR_TimeMap2_timeToQN|TimeMap2_timeToQN]]
|-
|-
-
| [[RPR Main OnCommand|Main_OnCommand]]
+
| [[RPR_CSurf_OnVolumeChangeEx|CSurf_OnVolumeChangeEx]]
-
| [[RPR Main OnCommandEx|Main_OnCommandEx]]
+
| [[RPR_GetPeaksBitmap|GetPeaksBitmap]]
-
| [[RPR Main openProject|Main_openProject]]
+
| [[RPR_MuteAllTracks|MuteAllTracks]]
-
| [[RPR Main UpdateLoopInfo|Main_UpdateLoopInfo]]
+
| [[RPR_TimeMap_GetDividedBpmAtTime|TimeMap_GetDividedBpmAtTime]]
|-
|-
-
| [[RPR Master GetPlayRateAtTime|Master_GetPlayRateAtTime]]
+
| [[RPR_CSurf_ResetAllCachedVolPanStates|CSurf_ResetAllCachedVolPanStates]]
-
| [[RPR MB|MB]]
+
| [[RPR_GetPlayPosition|GetPlayPosition]]
-
| [[RPR MIDI eventlist Create|MIDI_eventlist_Create]]
+
| [[RPR_my_getViewport|my_getViewport]]
-
| [[RPR MIDI eventlist Destroy|MIDI_eventlist_Destroy]]
+
| [[RPR_TimeMap_QNToTime|TimeMap_QNToTime]]
|-
|-
-
| [[RPR MIDIEditor GetActive|MIDIEditor_GetActive]]
+
| [[RPR_CSurf_ScrubAmt|CSurf_ScrubAmt]]
-
| [[RPR MIDIEditor GetMode|MIDIEditor_GetMode]]
+
| [[RPR_GetPlayPosition2|GetPlayPosition2]]
-
| [[RPR MIDIEditor OnCommand|MIDIEditor_OnCommand]]
+
| [[RPR_NamedCommandLookup|NamedCommandLookup]]
-
| [[RPR mkpanstr|mkpanstr]]
+
| [[RPR_TimeMap_timeToQN|TimeMap_timeToQN]]
|-
|-
-
| [[RPR mkvolpanstr|mkvolpanstr]]
+
| [[RPR_CSurf_SetAutoMode|CSurf_SetAutoMode]]
-
| [[RPR mkvolstr|mkvolstr]]
+
| [[RPR_GetPlayPosition2Ex|GetPlayPosition2Ex]]
-
| [[RPR MoveEditCursor|MoveEditCursor]]
+
| [[RPR_OnPauseButton|OnPauseButton]]
-
| [[RPR MoveMediaItemToTrack|MoveMediaItemToTrack]]
+
| [[RPR_Track_GetPeakInfo|Track_GetPeakInfo]]
|-
|-
-
| [[RPR MuteAllTracks|MuteAllTracks]]
+
| [[RPR_CSurf_SetPlayState|CSurf_SetPlayState]]
-
| [[RPR my getViewport|my_getViewport]]
+
| [[RPR_GetPlayPositionEx|GetPlayPositionEx]]
-
| [[RPR OnPauseButton|OnPauseButton]]
+
| [[RPR_OnPauseButtonEx|OnPauseButtonEx]]
-
| [[RPR OnPauseButtonEx|OnPauseButtonEx]]
+
| [[RPR_TrackFX_FormatParamValue|TrackFX_FormatParamValue]]
|-
|-
-
| [[RPR OnPlayButton|OnPlayButton]]
+
| [[RPR_CSurf_SetRepeatState|CSurf_SetRepeatState]]
-
| [[RPR OnPlayButtonEx|OnPlayButtonEx]]
+
| [[RPR_GetPlayState|GetPlayState]]
-
| [[RPR OnStopButton|OnStopButton]]
+
| [[RPR_OnPlayButton|OnPlayButton]]
-
| [[RPR OnStopButtonEx|OnStopButtonEx]]
+
| [[RPR_TrackFX_GetCount|TrackFX_GetCount]]
|-
|-
-
| [[RPR parse timestr|parse_timestr]]
+
| [[RPR_CSurf_SetSurfaceMute|CSurf_SetSurfaceMute]]
-
| [[RPR parse timestr len|parse_timestr_len]]
+
| [[RPR_GetPlayStateEx|GetPlayStateEx]]
-
| [[RPR parse timestr pos|parse_timestr_pos]]
+
| [[RPR_OnPlayButtonEx|OnPlayButtonEx]]
-
| [[RPR parsepanstr|parsepanstr]]
+
| [[RPR_TrackFX_GetFXName|TrackFX_GetFXName]]
|-
|-
-
| [[RPR PCM Sink Create|PCM_Sink_Create]]
+
| [[RPR_CSurf_SetSurfacePan|CSurf_SetSurfacePan]]
-
| [[RPR PCM Sink CreateEx|PCM_Sink_CreateEx]]
+
| [[RPR_GetProjectPath|GetProjectPath]]
-
| [[RPR PCM Sink CreateMIDIFile|PCM_Sink_CreateMIDIFile]]
+
| [[RPR_OnStopButton|OnStopButton]]
-
| [[RPR PCM Sink CreateMIDIFileEx|PCM_Sink_CreateMIDIFileEx]]
+
| [[RPR_TrackFX_GetNumParams|TrackFX_GetNumParams]]
|-
|-
-
| [[RPR PCM Sink Enum|PCM_Sink_Enum]]
+
| [[RPR_CSurf_SetSurfaceRecArm|CSurf_SetSurfaceRecArm]]
-
| [[RPR PCM Sink GetExtension|PCM_Sink_GetExtension]]
+
| [[RPR_GetProjectPathEx|GetProjectPathEx]]
-
| [[RPR PCM Sink ShowConfig|PCM_Sink_ShowConfig]]
+
| [[RPR_OnStopButtonEx|OnStopButtonEx]]
-
| [[RPR PCM Source CreateFromFile|PCM_Source_CreateFromFile]]
+
| [[RPR_TrackFX_GetParam|TrackFX_GetParam]]
|-
|-
-
| [[RPR PCM Source CreateFromFileEx|PCM_Source_CreateFromFileEx]]
+
| [[RPR_CSurf_SetSurfaceSelected|CSurf_SetSurfaceSelected]]
-
| [[RPR PCM Source CreateFromSimple|PCM_Source_CreateFromSimple]]
+
| [[RPR_GetProjectTimeSignature|GetProjectTimeSignature]]
-
| [[RPR PCM Source CreateFromType|PCM_Source_CreateFromType]]
+
| [[RPR_parse_timestr|parse_timestr]]
-
| [[RPR PeakBuild Create|PeakBuild_Create]]
+
| [[RPR_TrackFX_GetParamName|TrackFX_GetParamName]]
|-
|-
-
| [[RPR PeakGet Create|PeakGet_Create]]
+
| [[RPR_CSurf_SetSurfaceSolo|CSurf_SetSurfaceSolo]]
-
| [[RPR PlayPreview|PlayPreview]]
+
| [[RPR_GetProjectTimeSignature2|GetProjectTimeSignature2]]
-
| [[RPR PlayTrackPreview|PlayTrackPreview]]
+
| [[RPR_parse_timestr_len|parse_timestr_len]]
-
| [[RPR PlayTrackPreview2|PlayTrackPreview2]]
+
| [[RPR_TrackFX_SetParam|TrackFX_SetParam]]
|-
|-
-
| [[RPR plugin getFilterList|plugin_getFilterList]]
+
| [[RPR_CSurf_SetSurfaceVolume|CSurf_SetSurfaceVolume]]
-
| [[RPR plugin getImportableProjectFilterList|plugin_getImportableProjectFilterList]]
+
| [[RPR_GetSelectedMediaItem|GetSelectedMediaItem]]
-
| [[RPR PluginWantsAlwaysRunFx|PluginWantsAlwaysRunFx]]
+
| [[RPR_parse_timestr_pos|parse_timestr_pos]]
-
| [[RPR projectconfig var addr|projectconfig_var_addr]]
+
| [[RPR_TrackList_AdjustWindows|TrackList_AdjustWindows]]
|-
|-
-
| [[RPR projectconfig var getoffs|projectconfig_var_getoffs]]
+
| [[RPR_CSurf_SetTrackListChange|CSurf_SetTrackListChange]]
-
| [[RPR ReaperGetPitchShiftAPI|ReaperGetPitchShiftAPI]]
+
| [[RPR_GetSelectedTrack|GetSelectedTrack]]
-
| [[RPR relative fn|relative_fn]]
+
| [[RPR_parsepanstr|parsepanstr]]
-
| [[RPR Resample EnumModes|Resample_EnumModes]]
+
| [[RPR_TrackList_UpdateAllExternalSurfaces|TrackList_UpdateAllExternalSurfaces]]
|-
|-
-
| [[RPR Resampler Create|Resampler_Create]]
+
| [[RPR_CSurf_TrackFromID|CSurf_TrackFromID]]
-
| [[RPR resolve fn|resolve_fn]]
+
| [[RPR_GetSelectedTrackEnvelope|GetSelectedTrackEnvelope]]
-
| [[RPR screenset register|screenset_register]]
+
| [[RPR_PCM_Sink_Create|PCM_Sink_Create]]
-
| [[RPR screenset unregister|screenset_unregister]]
+
| [[RPR_Undo_BeginBlock|Undo_BeginBlock]]
|-
|-
-
| [[RPR screenset unregisterByParam|screenset_unregisterByParam]]
+
| [[RPR_CSurf_TrackToID|CSurf_TrackToID]]
-
| [[RPR SelectProjectInstance|SelectProjectInstance]]
+
| [[RPR_GetSet_ArrangeView2|GetSet_ArrangeView2]]
-
| [[RPR SetAutomationMode|SetAutomationMode]]
+
| [[RPR_PCM_Sink_CreateEx|PCM_Sink_CreateEx]]
-
| [[RPR SetEditCurPos|SetEditCurPos]]
+
| [[RPR_Undo_BeginBlock2|Undo_BeginBlock2]]
|-
|-
-
| [[RPR SetEditCurPos2|SetEditCurPos2]]
+
| [[RPR_DB2SLIDER|DB2SLIDER]]
-
| [[RPR SetMediaItemInfo Value|SetMediaItemInfo_Value]]
+
| [[RPR_GetSet_LoopTimeRange|GetSet_LoopTimeRange]]
-
| [[RPR SetMediaItemTakeInfo Value|SetMediaItemTakeInfo_Value]]
+
| [[RPR_PCM_Sink_CreateMIDIFile|PCM_Sink_CreateMIDIFile]]
-
| [[RPR SetMediaTrackInfo Value|SetMediaTrackInfo_Value]]
+
| [[RPR_Undo_CanRedo2|Undo_CanRedo2]]
|-
|-
-
| [[RPR SetProjectMarker|SetProjectMarker]]
+
| [[RPR_DeleteProjectMarker|DeleteProjectMarker]]
-
| [[RPR SetProjectMarker2|SetProjectMarker2]]
+
| [[RPR_GetSet_LoopTimeRange2|GetSet_LoopTimeRange2]]
-
| [[RPR SetTrackAutomationMode|SetTrackAutomationMode]]
+
| [[RPR_PCM_Sink_CreateMIDIFileEx|PCM_Sink_CreateMIDIFileEx]]
-
| [[RPR SetTrackMIDINoteName|SetTrackMIDINoteName]]
+
| [[RPR_Undo_CanUndo2|Undo_CanUndo2]]
|-
|-
-
| [[RPR SetTrackMIDINoteNameEx|SetTrackMIDINoteNameEx]]
+
| [[RPR_DeleteTrack|DeleteTrack]]
-
| [[RPR SetTrackSelected|SetTrackSelected]]
+
| [[RPR_GetSetEnvelopeState|GetSetEnvelopeState]]
-
| [[RPR ShowActionList|ShowActionList]]
+
| [[RPR_PCM_Sink_Enum|PCM_Sink_Enum]]
-
| [[RPR ShowConsoleMsg|ShowConsoleMsg]]
+
| [[RPR_Undo_DoRedo2|Undo_DoRedo2]]
|-
|-
-
| [[RPR ShowMessageBox|ShowMessageBox]]
+
| [[RPR_DeleteTrackMediaItem|DeleteTrackMediaItem]]
-
| [[RPR SLIDER2DB|SLIDER2DB]]
+
| [[RPR_GetSetItemState|GetSetItemState]]
-
| [[RPR SoloAllTracks|SoloAllTracks]]
+
| [[RPR_PCM_Sink_GetExtension|PCM_Sink_GetExtension]]
-
| [[RPR SplitMediaItem|SplitMediaItem]]
+
| [[RPR_Undo_DoUndo2|Undo_DoUndo2]]
|-
|-
-
| [[RPR StopPreview|StopPreview]]
+
| [[RPR_DockWindowActivate|DockWindowActivate]]
-
| [[RPR StopTrackPreview|StopTrackPreview]]
+
| [[RPR_GetSetMediaItemTakeInfo_String|GetSetMediaItemTakeInfo_String]]
-
| [[RPR StopTrackPreview2|StopTrackPreview2]]
+
| [[RPR_PCM_Sink_ShowConfig|PCM_Sink_ShowConfig]]
-
| [[RPR stringToGuid|stringToGuid]]
+
| [[RPR_Undo_EndBlock|Undo_EndBlock]]
|-
|-
-
| [[RPR TimeMap2 beatsToTime|TimeMap2_beatsToTime]]
+
| [[RPR_DockWindowAdd|DockWindowAdd]]
-
| [[RPR TimeMap2 GetDividedBpmAtTime|'''''TimeMap2_GetDividedBpmAtTime''''']]
+
| [[RPR_GetSetMediaTrackInfo_String|GetSetMediaTrackInfo_String]]
-
| [[RPR TimeMap2 GetNextChangeTime|TimeMap2_GetNextChangeTime]]
+
| [[RPR_PCM_Source_CreateFromFile|PCM_Source_CreateFromFile]]
-
| [[RPR TimeMap2 QNToTime|TimeMap2_QNToTime]]
+
| [[RPR_Undo_EndBlock2|Undo_EndBlock2]]
|-
|-
-
| [[RPR TimeMap2 timeToBeats|TimeMap2_timeToBeats]]
+
| [[RPR_DockWindowRemove|DockWindowRemove]]
-
| [[RPR TimeMap2 timeToQN|TimeMap2_timeToQN]]
+
| [[RPR_GetSetRepeat|GetSetRepeat]]
-
| [[RPR TimeMap GetDividedBpmAtTime|TimeMap_GetDividedBpmAtTime]]
+
| [[RPR_PCM_Source_CreateFromFileEx|PCM_Source_CreateFromFileEx]]
-
| [[RPR TimeMap QNToTime|TimeMap_QNToTime]]
+
| [[RPR_Undo_OnStateChange|Undo_OnStateChange]]
|-
|-
-
| [[RPR TimeMap timeToQN|TimeMap_timeToQN]]
+
| [[RPR_EnsureNotCompletelyOffscreen|EnsureNotCompletelyOffscreen]]
-
| [[RPR Track GetPeakInfo|Track_GetPeakInfo]]
+
| [[RPR_GetSetRepeatEx|GetSetRepeatEx]]
-
| [[RPR TrackFX FormatParamValue|TrackFX_FormatParamValue]]
+
| [[RPR_PCM_Source_CreateFromSimple|PCM_Source_CreateFromSimple]]
-
| [[RPR TrackFX GetCount|TrackFX_GetCount]]
+
| [[RPR_Undo_OnStateChange2|Undo_OnStateChange2]]
|-
|-
-
| [[RPR TrackFX GetFXName|TrackFX_GetFXName]]
+
| [[RPR_EnumPitchShiftModes|EnumPitchShiftModes]]
-
| [[RPR TrackFX GetNumParams|TrackFX_GetNumParams]]
+
| [[RPR_GetSetTrackState|GetSetTrackState]]
-
| [[RPR TrackFX GetParam|TrackFX_GetParam]]
+
| [[RPR_PCM_Source_CreateFromType|PCM_Source_CreateFromType]]
-
| [[RPR TrackFX GetParamName|TrackFX_GetParamName]]
+
| [[RPR_Undo_OnStateChange_Item|Undo_OnStateChange_Item]]
|-
|-
-
| [[RPR TrackFX SetParam|TrackFX_SetParam]]
+
| [[RPR_EnumPitchShiftSubModes|EnumPitchShiftSubModes]]
-
| [[RPR TrackList AdjustWindows|TrackList_AdjustWindows]]
+
| [[RPR_GetTake|GetTake]]
-
| [[RPR TrackList UpdateAllExternalSurfaces|TrackList_UpdateAllExternalSurfaces]]
+
| [[RPR_PeakBuild_Create|PeakBuild_Create]]
-
| [[RPR Undo BeginBlock|Undo_BeginBlock]]
+
| [[RPR_Undo_OnStateChangeEx|Undo_OnStateChangeEx]]
|-
|-
-
| [[RPR Undo BeginBlock2|Undo_BeginBlock2]]
+
| [[RPR_EnumProjectMarkers|EnumProjectMarkers]]
-
| [[RPR Undo CanRedo2|Undo_CanRedo2]]
+
| [[RPR_GetTakeEnvelopeByName|GetTakeEnvelopeByName]]
-
| [[RPR Undo CanUndo2|Undo_CanUndo2]]
+
| [[RPR_PeakGet_Create|PeakGet_Create]]
-
| [[RPR Undo DoRedo2|Undo_DoRedo2]]
+
| [[RPR_Undo_OnStateChangeEx2|Undo_OnStateChangeEx2]]
|-
|-
-
| [[RPR Undo DoUndo2|Undo_DoUndo2]]
+
| [[RPR_EnumProjectMarkers2|EnumProjectMarkers2]]
-
| [[RPR Undo EndBlock|Undo_EndBlock]]
+
| [[RPR_GetTooltipWindow|GetTooltipWindow]]
-
| [[RPR Undo EndBlock2|Undo_EndBlock2]]
+
| [[RPR_PlayPreview|PlayPreview]]
-
| [[RPR Undo OnStateChange|Undo_OnStateChange]]
+
| [[RPR_UpdateItemInProject|UpdateItemInProject]]
|-
|-
-
| [[RPR Undo OnStateChange2|Undo_OnStateChange2]]
+
| [[RPR_EnumProjects|EnumProjects]]
-
| [[RPR Undo OnStateChange Item|Undo_OnStateChange_Item]]
+
| [[RPR_GetTrack|GetTrack]]
-
| [[RPR Undo OnStateChangeEx|Undo_OnStateChangeEx]]
+
| [[RPR_PlayTrackPreview|PlayTrackPreview]]
-
| [[RPR Undo OnStateChangeEx2|Undo_OnStateChangeEx2]]
+
| [[RPR_UpdateTimeline|UpdateTimeline]]
|-
|-
-
| [[RPR UpdateItemInProject|UpdateItemInProject]]
+
| [[RPR_EnumTrackMIDIProgramNames|EnumTrackMIDIProgramNames]]
-
| [[RPR UpdateTimeline|UpdateTimeline]]
+
| [[RPR_GetTrackAutomationMode|GetTrackAutomationMode]]
-
| [[RPR ValidatePtr|ValidatePtr]]
+
| [[RPR_PlayTrackPreview2|PlayTrackPreview2]]
-
| [[RPR WDL VirtualWnd ScaledBlitBG|WDL_VirtualWnd_ScaledBlitBG]]
+
| [[RPR_ValidatePtr|ValidatePtr]]
 +
|-
 +
| [[RPR_EnumTrackMIDIProgramNamesEx|EnumTrackMIDIProgramNamesEx]]
 +
| [[RPR_GetTrackEnvelope|GetTrackEnvelope]]
 +
| [[RPR_plugin_getFilterList|plugin_getFilterList]]
 +
| [[RPR_WDL_VirtualWnd_ScaledBlitBG|WDL_VirtualWnd_ScaledBlitBG]]
|-
|-
|}
|}
-
 
[[Category:ReaScript]]
[[Category:ReaScript]]
[[Category:API]]
[[Category:API]]

Latest revision as of 21:13, 2 January 2011

Back to main ReaScript page
Back to main REAPER API page

ReaScript API Documentation

This page documents the ReaScript API functions.

ReaScript uses a large part of The API (available in CC++).

Using these functions

These functions each map onto a C++ function. C++ allows "pass by reference", which lets you pass a variable to a function in the parameter list and have the function change that parameter, so after this function call: 

x = MyFunc(&var);

the var variable might well have a different value to the one it started with...

Perl and Python don't have compatible pass by reference mechanisms so when ReaScript sees a modifiable variable in the parameter list it returns all the values in the parameter list and the return value (if there is one) in an array, as in GetUserInputs() Go and look at it now if you haven't already done so. It will bite you if you don't understand it.

Specific REAPER type pointers, like MediaItem*, are not considered modifiable by ReaScript when deciding whether to return a scalar or array from a particular function.

Who is Allowed to Add to and Edit this Documentation?

You.

No, really - you are. Don't hesitate to get stuck in if you think you know something that even might be of help to some poor muso feeling his or her way around the API.

Anything in the API documentation that is marked with a '?' is an assumption - or something the writer just isn't sure about. If you happen to know whatever it is for certain - please correct or confirm the entry. If you're not sure either but you have different ideas to the author - then use the "discussion" tab at the top of each page and start a conversation with the author or authors of that page.

Please add a brief note or correction if you see anything that's wrong or incomplete or if you've used the function and know something that might be of use to the next user.

Don't worry about making it look good if you're hurried; someone will be along in a while with the time. (Don't hesitate to make it look good if you *do* have the time... :o)

The ReaScript API Functions

ReaScript directives

DirectiveDescription
includeInclude another file in a script; it works in the same way as the #include directive in the C programming language.

Functions

Generated from REAPER v3.21 by mkReaScriptAPITable.pl

AddMediaItemToTrack format_timestr GetTrackEnvelopeByName plugin_getImportableProjectFilterList
AddProjectMarker format_timestr_len GetTrackGUID PluginWantsAlwaysRunFx
AddTakeToMediaItem format_timestr_pos GetTrackMediaItem projectconfig_var_addr
adjustZoom get_config_var GetTrackMIDINoteName projectconfig_var_getoffs
APITest get_ini_file GetTrackMIDINoteNameEx ReaperGetPitchShiftAPI
Audio_IsPreBuffer GetActiveTake GetTrackNumMediaItems relative_fn
Audio_IsRunning GetColorThemeStruct GetTrackState Resample_EnumModes
Audio_RegHardwareHook GetCursorPosition GetTrackUIVolPan Resampler_Create
BypassFxAllTracks GetCursorPositionEx GetUserFileNameForRead resolve_fn
CalculatePeaks GetEnvelopeName GetUserInputs screenset_register
ClearAllRecArmed GetExePath GSC_mainwnd screenset_unregister
ClearPeakCache GetHZoomLevel guidToString screenset_unregisterByParam
CountMediaItems GetIconThemePointer HasTrackMIDIPrograms SelectProjectInstance
CountSelectedMediaItems GetIconThemeStruct HasTrackMIDIProgramsEx SetAutomationMode
CountSelectedTracks GetInputChannelName HiresPeaksFromSource SetEditCurPos
CountTakes GetItemProjectContext InsertMedia SetEditCurPos2
CountTrackEnvelopes GetLastTouchedTrack InsertTrackAtIndex SetMediaItemInfo_Value
CountTrackMediaItems GetMainHwnd IsInRealTimeAudio SetMediaItemTakeInfo_Value
CountTracks GetMasterMuteSoloFlags IsMediaExtension SetMediaTrackInfo_Value
CreateMIDIInput GetMaxMidiInputs kbd_OnMidiEvent SetProjectMarker
CreateMIDIOutput GetMaxMidiOutputs kbd_OnMidiList SetProjectMarker2
CSurf_FlushUndo GetMediaItem LICE_Blit SetTrackAutomationMode
CSurf_GetTouchState GetMediaItem_Track LICE_ClipLine SetTrackMIDINoteName
CSurf_GoEnd GetMediaItemInfo_Value LICE_Line SetTrackMIDINoteNameEx
CSurf_GoStart GetMediaItemNumTakes LICE_LineInt SetTrackSelected
CSurf_NumTracks GetMediaItemTake Main_OnCommand ShowActionList
CSurf_OnArrow GetMediaItemTake_Item Main_OnCommandEx ShowConsoleMsg
CSurf_OnFwd GetMediaItemTake_Source Main_openProject ShowMessageBox
CSurf_OnFXChange GetMediaItemTake_Track Main_UpdateLoopInfo SLIDER2DB
CSurf_OnMuteChange GetMediaItemTakeInfo_Value Master_GetPlayRateAtTime SoloAllTracks
CSurf_OnPanChange GetMediaTrackInfo_Value MB SplitMediaItem
CSurf_OnPanChangeEx GetMidiInput MIDI_eventlist_Create StopPreview
CSurf_OnPlay GetMIDIInputName MIDI_eventlist_Destroy StopTrackPreview
CSurf_OnRecArmChange GetMidiOutput MIDIEditor_GetActive StopTrackPreview2
CSurf_OnRecord GetMIDIOutputName MIDIEditor_GetMode stringToGuid
CSurf_OnRew GetNumMIDIInputs MIDIEditor_OnCommand TimeMap2_beatsToTime
CSurf_OnSelectedChange GetNumMIDIOutputs mkpanstr TimeMap2_GetDividedBpmAtTime
CSurf_OnSoloChange GetNumTracks mkvolpanstr TimeMap2_GetNextChangeTime
CSurf_OnStop GetOutputChannelName mkvolstr TimeMap2_QNToTime
CSurf_OnTrackSelection GetOutputLatency MoveEditCursor TimeMap2_timeToBeats
CSurf_OnVolumeChange GetPeakFileName MoveMediaItemToTrack TimeMap2_timeToQN
CSurf_OnVolumeChangeEx GetPeaksBitmap MuteAllTracks TimeMap_GetDividedBpmAtTime
CSurf_ResetAllCachedVolPanStates GetPlayPosition my_getViewport TimeMap_QNToTime
CSurf_ScrubAmt GetPlayPosition2 NamedCommandLookup TimeMap_timeToQN
CSurf_SetAutoMode GetPlayPosition2Ex OnPauseButton Track_GetPeakInfo
CSurf_SetPlayState GetPlayPositionEx OnPauseButtonEx TrackFX_FormatParamValue
CSurf_SetRepeatState GetPlayState OnPlayButton TrackFX_GetCount
CSurf_SetSurfaceMute GetPlayStateEx OnPlayButtonEx TrackFX_GetFXName
CSurf_SetSurfacePan GetProjectPath OnStopButton TrackFX_GetNumParams
CSurf_SetSurfaceRecArm GetProjectPathEx OnStopButtonEx TrackFX_GetParam
CSurf_SetSurfaceSelected GetProjectTimeSignature parse_timestr TrackFX_GetParamName
CSurf_SetSurfaceSolo GetProjectTimeSignature2 parse_timestr_len TrackFX_SetParam
CSurf_SetSurfaceVolume GetSelectedMediaItem parse_timestr_pos TrackList_AdjustWindows
CSurf_SetTrackListChange GetSelectedTrack parsepanstr TrackList_UpdateAllExternalSurfaces
CSurf_TrackFromID GetSelectedTrackEnvelope PCM_Sink_Create Undo_BeginBlock
CSurf_TrackToID GetSet_ArrangeView2 PCM_Sink_CreateEx Undo_BeginBlock2
DB2SLIDER GetSet_LoopTimeRange PCM_Sink_CreateMIDIFile Undo_CanRedo2
DeleteProjectMarker GetSet_LoopTimeRange2 PCM_Sink_CreateMIDIFileEx Undo_CanUndo2
DeleteTrack GetSetEnvelopeState PCM_Sink_Enum Undo_DoRedo2
DeleteTrackMediaItem GetSetItemState PCM_Sink_GetExtension Undo_DoUndo2
DockWindowActivate GetSetMediaItemTakeInfo_String PCM_Sink_ShowConfig Undo_EndBlock
DockWindowAdd GetSetMediaTrackInfo_String PCM_Source_CreateFromFile Undo_EndBlock2
DockWindowRemove GetSetRepeat PCM_Source_CreateFromFileEx Undo_OnStateChange
EnsureNotCompletelyOffscreen GetSetRepeatEx PCM_Source_CreateFromSimple Undo_OnStateChange2
EnumPitchShiftModes GetSetTrackState PCM_Source_CreateFromType Undo_OnStateChange_Item
EnumPitchShiftSubModes GetTake PeakBuild_Create Undo_OnStateChangeEx
EnumProjectMarkers GetTakeEnvelopeByName PeakGet_Create Undo_OnStateChangeEx2
EnumProjectMarkers2 GetTooltipWindow PlayPreview UpdateItemInProject
EnumProjects GetTrack PlayTrackPreview UpdateTimeline
EnumTrackMIDIProgramNames GetTrackAutomationMode PlayTrackPreview2 ValidatePtr
EnumTrackMIDIProgramNamesEx GetTrackEnvelope plugin_getFilterList WDL_VirtualWnd_ScaledBlitBG
Retrieved from "https://wiki.cockos.com/wiki/index.php/ReaScript_API"
Personal tools