ReaScript API
From CockosWiki
Line 15: | Line 15: | ||
e.g [[RPR_GetUserInputs|GetUserInputs()]] | e.g [[RPR_GetUserInputs|GetUserInputs()]] | ||
- | Specific Reaper type pointers like MediaItem* are '''not''' considered modifiable by ReaScript when deciding whether to return a scalar or | + | 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. | ''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. | ||
Line 22: | Line 22: | ||
{|class="wikitable" | {|class="wikitable" | ||
- | | [[ | + | | [[ReaScript|Back to main ReaScript page]] |
- | | [[ | + | | [[RPR GetUserInputs|GetUserInputs()]] |
- | | [[ | + | | [[RPR AddMediaItemToTrack|AddMediaItemToTrack]] |
- | | [[ | + | | [[RPR AddProjectMarker|AddProjectMarker]] |
|- | |- | ||
- | | [[ | + | | [[RPR AddTakeToMediaItem|AddTakeToMediaItem]] |
- | | [[ | + | | [[RPR adjustZoom|adjustZoom]] |
- | | [[ | + | | [[RPR APITest|APITest]] |
- | | [[ | + | | [[RPR Audio IsPreBuffer|Audio_IsPreBuffer]] |
|- | |- | ||
- | | [[ | + | | [[RPR Audio IsRunning|Audio_IsRunning]] |
- | | [[ | + | | [[RPR Audio RegHardwareHook|Audio_RegHardwareHook]] |
- | | [[ | + | | [[RPR BypassFxAllTracks|BypassFxAllTracks]] |
- | | [[ | + | | [[RPR CalculatePeaks|CalculatePeaks]] |
|- | |- | ||
- | | [[ | + | | [[RPR ClearAllRecArmed|ClearAllRecArmed]] |
- | | [[ | + | | [[RPR ClearPeakCache|ClearPeakCache]] |
- | | [[ | + | | [[RPR CountMediaItems|CountMediaItems]] |
- | | [[ | + | | [[RPR CountSelectedMediaItems|CountSelectedMediaItems]] |
|- | |- | ||
- | | [[ | + | | [[RPR CountSelectedTracks|CountSelectedTracks]] |
- | | [[ | + | | [[RPR CountTakes|CountTakes]] |
- | | [[ | + | | [[RPR CountTrackEnvelopes|CountTrackEnvelopes]] |
- | | [[ | + | | [[RPR CountTrackMediaItems|CountTrackMediaItems]] |
|- | |- | ||
- | | [[ | + | | [[RPR CountTracks|CountTracks]] |
- | | [[ | + | | [[RPR CreateMIDIInput|CreateMIDIInput]] |
- | | [[ | + | | [[RPR CreateMIDIOutput|CreateMIDIOutput]] |
- | | [[ | + | | [[RPR CSurf FlushUndo|CSurf_FlushUndo]] |
|- | |- | ||
- | | [[ | + | | [[RPR CSurf GetTouchState|CSurf_GetTouchState]] |
- | | [[ | + | | [[RPR CSurf GoEnd|CSurf_GoEnd]] |
- | | [[ | + | | [[RPR CSurf GoStart|CSurf_GoStart]] |
- | | [[ | + | | [[RPR CSurf NumTracks|CSurf_NumTracks]] |
|- | |- | ||
- | | [[ | + | | [[RPR CSurf OnArrow|CSurf_OnArrow]] |
- | | [[ | + | | [[RPR CSurf OnFwd|CSurf_OnFwd]] |
- | | [[ | + | | [[RPR CSurf OnFXChange|CSurf_OnFXChange]] |
- | | [[ | + | | [[RPR CSurf OnMuteChange|CSurf_OnMuteChange]] |
|- | |- | ||
- | | [[ | + | | [[RPR CSurf OnPanChange|CSurf_OnPanChange]] |
- | | [[ | + | | [[RPR CSurf OnPanChangeEx|CSurf_OnPanChangeEx]] |
- | | [[ | + | | [[RPR CSurf OnPlay|CSurf_OnPlay]] |
- | | [[ | + | | [[RPR CSurf OnRecArmChange|CSurf_OnRecArmChange]] |
|- | |- | ||
- | | [[ | + | | [[RPR CSurf OnRecord|CSurf_OnRecord]] |
- | | [[ | + | | [[RPR CSurf OnRew|CSurf_OnRew]] |
- | | [[ | + | | [[RPR CSurf OnSelectedChange|CSurf_OnSelectedChange]] |
- | | [[ | + | | [[RPR CSurf OnSoloChange|CSurf_OnSoloChange]] |
|- | |- | ||
- | | [[ | + | | [[RPR CSurf OnStop|CSurf_OnStop]] |
- | | [[ | + | | [[RPR CSurf OnTrackSelection|CSurf_OnTrackSelection]] |
- | | [[ | + | | [[RPR CSurf OnVolumeChange|CSurf_OnVolumeChange]] |
- | | [[ | + | | [[RPR CSurf OnVolumeChangeEx|CSurf_OnVolumeChangeEx]] |
|- | |- | ||
- | | [[ | + | | [[RPR CSurf ResetAllCachedVolPanStates|CSurf_ResetAllCachedVolPanStates]] |
- | | [[ | + | | [[RPR CSurf ScrubAmt|CSurf_ScrubAmt]] |
- | | [[ | + | | [[RPR CSurf SetAutoMode|CSurf_SetAutoMode]] |
- | | [[ | + | | [[RPR CSurf SetPlayState|CSurf_SetPlayState]] |
|- | |- | ||
- | | [[ | + | | [[RPR CSurf SetRepeatState|CSurf_SetRepeatState]] |
- | | [[ | + | | [[RPR CSurf SetSurfaceMute|CSurf_SetSurfaceMute]] |
- | | [[ | + | | [[RPR CSurf SetSurfacePan|CSurf_SetSurfacePan]] |
- | | [[ | + | | [[RPR CSurf SetSurfaceRecArm|CSurf_SetSurfaceRecArm]] |
|- | |- | ||
- | | [[ | + | | [[RPR CSurf SetSurfaceSelected|CSurf_SetSurfaceSelected]] |
- | | [[ | + | | [[RPR CSurf SetSurfaceSolo|CSurf_SetSurfaceSolo]] |
- | | [[ | + | | [[RPR CSurf SetSurfaceVolume|CSurf_SetSurfaceVolume]] |
- | | [[ | + | | [[RPR CSurf SetTrackListChange|CSurf_SetTrackListChange]] |
|- | |- | ||
- | | [[ | + | | [[RPR CSurf TrackFromID|CSurf_TrackFromID]] |
- | | [[ | + | | [[RPR CSurf TrackToID|CSurf_TrackToID]] |
- | | [[ | + | | [[RPR DB2SLIDER|DB2SLIDER]] |
- | | [[ | + | | [[RPR DeleteProjectMarker|DeleteProjectMarker]] |
|- | |- | ||
- | | [[ | + | | [[RPR DeleteTrack|DeleteTrack]] |
- | | [[ | + | | [[RPR DeleteTrackMediaItem|DeleteTrackMediaItem]] |
- | | [[ | + | | [[RPR DockWindowActivate|DockWindowActivate]] |
- | | [[ | + | | [[RPR DockWindowAdd|DockWindowAdd]] |
|- | |- | ||
- | | [[ | + | | [[RPR DockWindowRemove|DockWindowRemove]] |
- | | [[ | + | | [[RPR EnsureNotCompletelyOffscreen|EnsureNotCompletelyOffscreen]] |
- | | [[ | + | | [[RPR EnumPitchShiftModes|EnumPitchShiftModes]] |
- | | [[ | + | | [[RPR EnumPitchShiftSubModes|EnumPitchShiftSubModes]] |
|- | |- | ||
- | | [[ | + | | [[RPR EnumProjectMarkers|EnumProjectMarkers]] |
- | | [[ | + | | [[RPR EnumProjectMarkers2|EnumProjectMarkers2]] |
- | | [[ | + | | [[RPR EnumProjects|EnumProjects]] |
- | | [[ | + | | [[RPR EnumTrackMIDIProgramNames|EnumTrackMIDIProgramNames]] |
|- | |- | ||
- | | [[ | + | | [[RPR EnumTrackMIDIProgramNamesEx|EnumTrackMIDIProgramNamesEx]] |
- | | [[ | + | | [[RPR format timestr|format_timestr]] |
- | | [[ | + | | [[RPR format timestr len|format_timestr_len]] |
- | | [[ | + | | [[RPR format timestr pos|format_timestr_pos]] |
|- | |- | ||
- | | [[ | + | | [[RPR genGuid|genGuid]] |
- | | [[ | + | | [[RPR get config var|get_config_var]] |
- | | [[ | + | | [[RPR get ini file|get_ini_file]] |
- | | [[ | + | | [[RPR GetActiveTake|GetActiveTake]] |
|- | |- | ||
- | | [[ | + | | [[RPR GetColorThemeStruct|GetColorThemeStruct]] |
- | | [[ | + | | [[RPR GetCursorPosition|GetCursorPosition]] |
- | | [[ | + | | [[RPR GetCursorPositionEx|GetCursorPositionEx]] |
- | | [[ | + | | [[RPR GetEnvelopeName|GetEnvelopeName]] |
|- | |- | ||
- | | [[ | + | | [[RPR GetExePath|GetExePath]] |
- | | [[ | + | | [[RPR GetHZoomLevel|GetHZoomLevel]] |
- | | [[ | + | | [[RPR GetIconThemePointer|GetIconThemePointer]] |
- | | [[ | + | | [[RPR GetIconThemeStruct|GetIconThemeStruct]] |
|- | |- | ||
- | | [[ | + | | [[RPR GetInputChannelName|GetInputChannelName]] |
- | | [[ | + | | [[RPR GetItemProjectContext|GetItemProjectContext]] |
- | | [[ | + | | [[RPR GetLastTouchedTrack|GetLastTouchedTrack]] |
- | | [[ | + | | [[RPR GetMainHwnd|GetMainHwnd]] |
|- | |- | ||
- | | [[ | + | | [[RPR GetMasterMuteSoloFlags|GetMasterMuteSoloFlags]] |
- | | [[ | + | | [[RPR GetMaxMidiInputs|GetMaxMidiInputs]] |
- | | [[ | + | | [[RPR GetMaxMidiOutputs|GetMaxMidiOutputs]] |
- | | [[ | + | | [[RPR GetMediaItem|GetMediaItem]] |
|- | |- | ||
- | | [[ | + | | [[RPR GetMediaItem Track|GetMediaItem_Track]] |
- | | [[ | + | | [[RPR GetMediaItemInfo Value|GetMediaItemInfo_Value]] |
- | | [[ | + | | [[RPR GetMediaItemNumTakes|GetMediaItemNumTakes]] |
- | | [[ | + | | [[RPR GetMediaItemTake|GetMediaItemTake]] |
|- | |- | ||
- | | [[ | + | | [[RPR GetMediaItemTake Item|GetMediaItemTake_Item]] |
- | | [[ | + | | [[RPR GetMediaItemTake Source|GetMediaItemTake_Source]] |
- | | [[ | + | | [[RPR GetMediaItemTake Track|GetMediaItemTake_Track]] |
- | | [[ | + | | [[RPR GetMediaItemTakeInfo Value|GetMediaItemTakeInfo_Value]] |
|- | |- | ||
- | | [[ | + | | [[RPR GetMediaTrackInfo Value|GetMediaTrackInfo_Value]] |
- | | [[ | + | | [[RPR GetMidiInput|GetMidiInput]] |
- | | [[ | + | | [[RPR GetMIDIInputName|GetMIDIInputName]] |
- | | [[ | + | | [[RPR GetMidiOutput|GetMidiOutput]] |
|- | |- | ||
- | | [[ | + | | [[RPR GetMIDIOutputName|GetMIDIOutputName]] |
- | | [[ | + | | [[RPR GetNumMIDIInputs|GetNumMIDIInputs]] |
- | | [[ | + | | [[RPR GetNumMIDIOutputs|GetNumMIDIOutputs]] |
- | | [[ | + | | [[RPR GetNumTracks|GetNumTracks]] |
|- | |- | ||
- | | [[ | + | | [[RPR GetOutputChannelName|GetOutputChannelName]] |
- | | [[ | + | | [[RPR GetOutputLatency|GetOutputLatency]] |
- | | [[ | + | | [[RPR GetPeakFileName|GetPeakFileName]] |
- | | [[ | + | | [[RPR GetPeaksBitmap|GetPeaksBitmap]] |
|- | |- | ||
- | | [[ | + | | [[RPR GetPlayPosition|GetPlayPosition]] |
- | | [[ | + | | [[RPR GetPlayPosition2|GetPlayPosition2]] |
- | | [[ | + | | [[RPR GetPlayPosition2Ex|GetPlayPosition2Ex]] |
- | | [[ | + | | [[RPR GetPlayPositionEx|GetPlayPositionEx]] |
|- | |- | ||
- | | [[ | + | | [[RPR GetPlayState|GetPlayState]] |
- | | [[ | + | | [[RPR GetPlayStateEx|GetPlayStateEx]] |
- | | [[ | + | | [[RPR GetProjectPath|GetProjectPath]] |
- | | [[ | + | | [[RPR GetProjectPathEx|GetProjectPathEx]] |
|- | |- | ||
- | | [[ | + | | [[RPR GetProjectTimeSignature|GetProjectTimeSignature]] |
- | | [[ | + | | [[RPR GetProjectTimeSignature2|GetProjectTimeSignature2]] |
- | | [[ | + | | [[RPR GetSelectedMediaItem|GetSelectedMediaItem]] |
- | | [[ | + | | [[RPR GetSelectedTrack|GetSelectedTrack]] |
|- | |- | ||
- | | [[ | + | | [[RPR GetSelectedTrackEnvelope|GetSelectedTrackEnvelope]] |
- | | [[ | + | | [[RPR GetSet ArrangeView2|GetSet_ArrangeView2]] |
- | | [[ | + | | [[RPR GetSet LoopTimeRange|GetSet_LoopTimeRange]] |
- | | [[ | + | | [[RPR GetSet LoopTimeRange2|GetSet_LoopTimeRange2]] |
|- | |- | ||
- | | [[ | + | | [[RPR GetSetEnvelopeState|GetSetEnvelopeState]] |
- | | [[ | + | | [[RPR GetSetItemState|GetSetItemState]] |
- | | [[ | + | | [[RPR GetSetMediaItemTakeInfo String|GetSetMediaItemTakeInfo_String]] |
- | | [[ | + | | [[RPR GetSetMediaTrackInfo String|GetSetMediaTrackInfo_String]] |
|- | |- | ||
- | | [[ | + | | [[RPR GetSetRepeat|GetSetRepeat]] |
- | | [[ | + | | [[RPR GetSetRepeatEx|GetSetRepeatEx]] |
- | | [[ | + | | [[RPR GetSetTrackState|GetSetTrackState]] |
- | | [[ | + | | [[RPR GetTake|GetTake]] |
|- | |- | ||
- | | [[ | + | | [[RPR GetTakeEnvelopeByName|GetTakeEnvelopeByName]] |
- | | [[ | + | | [[RPR GetTooltipWindow|GetTooltipWindow]] |
- | | [[ | + | | [[RPR GetTrack|GetTrack]] |
- | | [[ | + | | [[RPR GetTrackAutomationMode|GetTrackAutomationMode]] |
|- | |- | ||
- | | [[ | + | | [[RPR GetTrackEnvelope|GetTrackEnvelope]] |
- | | [[ | + | | [[RPR GetTrackEnvelopeByName|GetTrackEnvelopeByName]] |
- | | [[ | + | | [[RPR GetTrackGUID|GetTrackGUID]] |
- | | [[ | + | | [[RPR GetTrackMediaItem|GetTrackMediaItem]] |
|- | |- | ||
- | | [[ | + | | [[RPR GetTrackMIDINoteName|GetTrackMIDINoteName]] |
- | | [[ | + | | [[RPR GetTrackMIDINoteNameEx|GetTrackMIDINoteNameEx]] |
- | | [[ | + | | [[RPR GetTrackNumMediaItems|GetTrackNumMediaItems]] |
- | | [[ | + | | [[RPR GetTrackState|GetTrackState]] |
|- | |- | ||
- | | [[ | + | | [[RPR GetTrackUIVolPan|GetTrackUIVolPan]] |
- | | [[ | + | | [[RPR GetUserInputs|GetUserInputs]] |
- | | [[ | + | | [[RPR GSC mainwnd|GSC_mainwnd]] |
- | | [[ | + | | [[RPR guidToString|guidToString]] |
|- | |- | ||
- | | [[ | + | | [[RPR HasTrackMIDIPrograms|HasTrackMIDIPrograms]] |
- | | [[ | + | | [[RPR HasTrackMIDIProgramsEx|HasTrackMIDIProgramsEx]] |
- | | [[ | + | | [[RPR HiresPeaksFromSource|HiresPeaksFromSource]] |
- | | [[ | + | | [[RPR InsertMedia|InsertMedia]] |
|- | |- | ||
- | | [[ | + | | [[RPR InsertTrackAtIndex|InsertTrackAtIndex]] |
- | | [[ | + | | [[RPR IsInRealTimeAudio|IsInRealTimeAudio]] |
- | | [[ | + | | [[RPR IsMediaExtension|IsMediaExtension]] |
- | | [[ | + | | [[RPR kbd OnMidiEvent|kbd_OnMidiEvent]] |
|- | |- | ||
- | | [[ | + | | [[RPR kbd OnMidiList|kbd_OnMidiList]] |
- | | [[ | + | | [[RPR LICE Blit|LICE_Blit]] |
- | | [[ | + | | [[RPR LICE ClipLine|LICE_ClipLine]] |
- | | [[ | + | | [[RPR LICE Line|LICE_Line]] |
|- | |- | ||
- | | [[ | + | | [[RPR LICE LineInt|LICE_LineInt]] |
- | | [[ | + | | [[RPR Main OnCommand|Main_OnCommand]] |
- | | [[ | + | | [[RPR Main OnCommandEx|Main_OnCommandEx]] |
- | | [[ | + | | [[RPR Main openProject|Main_openProject]] |
|- | |- | ||
- | | [[ | + | | [[RPR Main UpdateLoopInfo|Main_UpdateLoopInfo]] |
- | | [[ | + | | [[RPR Master GetPlayRateAtTime|Master_GetPlayRateAtTime]] |
- | | [[ | + | | [[RPR MB|MB]] |
- | | [[ | + | | [[RPR MIDI eventlist Create|MIDI_eventlist_Create]] |
|- | |- | ||
- | | [[ | + | | [[RPR MIDI eventlist Destroy|MIDI_eventlist_Destroy]] |
- | | [[ | + | | [[RPR MIDIEditor GetActive|MIDIEditor_GetActive]] |
- | | [[ | + | | [[RPR MIDIEditor GetMode|MIDIEditor_GetMode]] |
- | | [[ | + | | [[RPR MIDIEditor OnCommand|MIDIEditor_OnCommand]] |
|- | |- | ||
- | | [[ | + | | [[RPR mkpanstr|mkpanstr]] |
- | | [[ | + | | [[RPR mkvolpanstr|mkvolpanstr]] |
- | | [[ | + | | [[RPR mkvolstr|mkvolstr]] |
- | | [[ | + | | [[RPR MoveEditCursor|MoveEditCursor]] |
|- | |- | ||
- | | [[ | + | | [[RPR MoveMediaItemToTrack|MoveMediaItemToTrack]] |
- | | [[ | + | | [[RPR MuteAllTracks|MuteAllTracks]] |
- | | [[ | + | | [[RPR my getViewport|my_getViewport]] |
- | | [[ | + | | [[RPR OnPauseButton|OnPauseButton]] |
|- | |- | ||
- | | [[ | + | | [[RPR OnPauseButtonEx|OnPauseButtonEx]] |
- | | [[ | + | | [[RPR OnPlayButton|OnPlayButton]] |
- | | [[ | + | | [[RPR OnPlayButtonEx|OnPlayButtonEx]] |
- | | [[ | + | | [[RPR OnStopButton|OnStopButton]] |
|- | |- | ||
- | | [[ | + | | [[RPR OnStopButtonEx|OnStopButtonEx]] |
- | | [[ | + | | [[RPR parse timestr|parse_timestr]] |
- | | [[ | + | | [[RPR parse timestr len|parse_timestr_len]] |
- | | [[ | + | | [[RPR parse timestr pos|parse_timestr_pos]] |
|- | |- | ||
- | | [[ | + | | [[RPR parsepanstr|parsepanstr]] |
- | | [[ | + | | [[RPR PCM Sink Create|PCM_Sink_Create]] |
- | | [[ | + | | [[RPR PCM Sink CreateEx|PCM_Sink_CreateEx]] |
- | | [[ | + | | [[RPR PCM Sink CreateMIDIFile|PCM_Sink_CreateMIDIFile]] |
|- | |- | ||
- | | [[ | + | | [[RPR PCM Sink CreateMIDIFileEx|PCM_Sink_CreateMIDIFileEx]] |
- | | [[ | + | | [[RPR PCM Sink Enum|PCM_Sink_Enum]] |
- | | [[ | + | | [[RPR PCM Sink GetExtension|PCM_Sink_GetExtension]] |
- | | [[ | + | | [[RPR PCM Sink ShowConfig|PCM_Sink_ShowConfig]] |
|- | |- | ||
- | | [[ | + | | [[RPR PCM Source CreateFromFile|PCM_Source_CreateFromFile]] |
- | | [[ | + | | [[RPR PCM Source CreateFromFileEx|PCM_Source_CreateFromFileEx]] |
- | | [[ | + | | [[RPR PCM Source CreateFromSimple|PCM_Source_CreateFromSimple]] |
- | | [[ | + | | [[RPR PCM Source CreateFromType|PCM_Source_CreateFromType]] |
|- | |- | ||
- | | [[ | + | | [[RPR PeakBuild Create|PeakBuild_Create]] |
- | | [[ | + | | [[RPR PeakGet Create|PeakGet_Create]] |
- | | [[ | + | | [[RPR PlayPreview|PlayPreview]] |
- | | [[ | + | | [[RPR PlayTrackPreview|PlayTrackPreview]] |
|- | |- | ||
- | | [[ | + | | [[RPR PlayTrackPreview2|PlayTrackPreview2]] |
- | | [[ | + | | [[RPR plugin getFilterList|plugin_getFilterList]] |
- | | [[ | + | | [[RPR plugin getImportableProjectFilterList|plugin_getImportableProjectFilterList]] |
- | | [[ | + | | [[RPR PluginWantsAlwaysRunFx|PluginWantsAlwaysRunFx]] |
|- | |- | ||
- | | [[ | + | | [[RPR projectconfig var addr|projectconfig_var_addr]] |
- | | [[ | + | | [[RPR projectconfig var getoffs|projectconfig_var_getoffs]] |
- | | [[ | + | | [[RPR ReaperGetPitchShiftAPI|ReaperGetPitchShiftAPI]] |
- | | [[ | + | | [[RPR relative fn|relative_fn]] |
|- | |- | ||
- | | [[ | + | | [[RPR Resample EnumModes|Resample_EnumModes]] |
- | | [[ | + | | [[RPR Resampler Create|Resampler_Create]] |
- | | [[ | + | | [[RPR resolve fn|resolve_fn]] |
- | | [[ | + | | [[RPR screenset register|screenset_register]] |
|- | |- | ||
- | | [[ | + | | [[RPR screenset unregister|screenset_unregister]] |
- | | [[ | + | | [[RPR screenset unregisterByParam|screenset_unregisterByParam]] |
- | | [[ | + | | [[RPR SelectProjectInstance|SelectProjectInstance]] |
- | | [[ | + | | [[RPR SetAutomationMode|SetAutomationMode]] |
|- | |- | ||
- | | [[ | + | | [[RPR SetEditCurPos|SetEditCurPos]] |
- | | [[ | + | | [[RPR SetEditCurPos2|SetEditCurPos2]] |
- | | [[ | + | | [[RPR SetMediaItemInfo Value|SetMediaItemInfo_Value]] |
- | | [[ | + | | [[RPR SetMediaItemTakeInfo Value|SetMediaItemTakeInfo_Value]] |
|- | |- | ||
- | | [[ | + | | [[RPR SetMediaTrackInfo Value|SetMediaTrackInfo_Value]] |
- | | [[ | + | | [[RPR SetProjectMarker|SetProjectMarker]] |
- | | [[ | + | | [[RPR SetProjectMarker2|SetProjectMarker2]] |
- | | [[ | + | | [[RPR SetTrackAutomationMode|SetTrackAutomationMode]] |
|- | |- | ||
- | | [[ | + | | [[RPR SetTrackMIDINoteName|SetTrackMIDINoteName]] |
- | | [[ | + | | [[RPR SetTrackMIDINoteNameEx|SetTrackMIDINoteNameEx]] |
- | | [[ | + | | [[RPR SetTrackSelected|SetTrackSelected]] |
- | | [[ | + | | [[RPR ShowActionList|ShowActionList]] |
|- | |- | ||
- | | [[ | + | | [[RPR ShowConsoleMsg|ShowConsoleMsg]] |
- | | [[ | + | | [[RPR ShowMessageBox|ShowMessageBox]] |
- | | [[ | + | | [[RPR SLIDER2DB|SLIDER2DB]] |
- | | [[ | + | | [[RPR SoloAllTracks|SoloAllTracks]] |
|- | |- | ||
- | | [[ | + | | [[RPR SplitMediaItem|SplitMediaItem]] |
- | | [[ | + | | [[RPR StopPreview|StopPreview]] |
- | | [[ | + | | [[RPR StopTrackPreview|StopTrackPreview]] |
- | | [[ | + | | [[RPR StopTrackPreview2|StopTrackPreview2]] |
|- | |- | ||
- | | [[ | + | | [[RPR stringToGuid|stringToGuid]] |
- | | [[ | + | | [[RPR TimeMap2 beatsToTime|TimeMap2_beatsToTime]] |
- | | [[ | + | | [[RPR TimeMap2 GetDividedBpmAtTime|TimeMap2_GetDividedBpmAtTime]] |
- | | [[ | + | | [[RPR TimeMap2 GetNextChangeTime|TimeMap2_GetNextChangeTime]] |
|- | |- | ||
- | | [[ | + | | [[RPR TimeMap2 QNToTime|TimeMap2_QNToTime]] |
- | | [[ | + | | [[RPR TimeMap2 timeToBeats|TimeMap2_timeToBeats]] |
- | | [[ | + | | [[RPR TimeMap2 timeToQN|TimeMap2_timeToQN]] |
- | | [[ | + | | [[RPR TimeMap GetDividedBpmAtTime|TimeMap_GetDividedBpmAtTime]] |
|- | |- | ||
- | | [[ | + | | [[RPR TimeMap QNToTime|TimeMap_QNToTime]] |
- | | [[ | + | | [[RPR TimeMap timeToQN|TimeMap_timeToQN]] |
- | | [[ | + | | [[RPR Track GetPeakInfo|Track_GetPeakInfo]] |
- | | [[ | + | | [[RPR TrackFX FormatParamValue|TrackFX_FormatParamValue]] |
|- | |- | ||
- | | [[ | + | | [[RPR TrackFX GetCount|TrackFX_GetCount]] |
- | | [[ | + | | [[RPR TrackFX GetFXName|TrackFX_GetFXName]] |
- | | [[ | + | | [[RPR TrackFX GetNumParams|TrackFX_GetNumParams]] |
- | | [[ | + | | [[RPR TrackFX GetParam|TrackFX_GetParam]] |
|- | |- | ||
- | | [[ | + | | [[RPR TrackFX GetParamName|TrackFX_GetParamName]] |
- | | [[ | + | | [[RPR TrackFX SetParam|TrackFX_SetParam]] |
- | | [[ | + | | [[RPR TrackList AdjustWindows|TrackList_AdjustWindows]] |
- | | [[ | + | | [[RPR TrackList UpdateAllExternalSurfaces|TrackList_UpdateAllExternalSurfaces]] |
|- | |- | ||
- | | [[ | + | | [[RPR Undo BeginBlock|Undo_BeginBlock]] |
- | | [[ | + | | [[RPR Undo BeginBlock2|Undo_BeginBlock2]] |
- | | [[ | + | | [[RPR Undo CanRedo2|Undo_CanRedo2]] |
- | | [[ | + | | [[RPR Undo CanUndo2|Undo_CanUndo2]] |
|- | |- | ||
- | | [[ | + | | [[RPR Undo DoRedo2|Undo_DoRedo2]] |
- | | [[ | + | | [[RPR Undo DoUndo2|Undo_DoUndo2]] |
- | | [[ | + | | [[RPR Undo EndBlock|Undo_EndBlock]] |
- | | [[ | + | | [[RPR Undo EndBlock2|Undo_EndBlock2]] |
|- | |- | ||
- | | [[ | + | | [[RPR Undo OnStateChange|Undo_OnStateChange]] |
- | | [[ | + | | [[RPR Undo OnStateChange2|Undo_OnStateChange2]] |
- | | [[ | + | | [[RPR Undo OnStateChange Item|Undo_OnStateChange_Item]] |
- | | [[ | + | | [[RPR Undo OnStateChangeEx|Undo_OnStateChangeEx]] |
|- | |- | ||
- | | [[ | + | | [[RPR Undo OnStateChangeEx2|Undo_OnStateChangeEx2]] |
- | | [[ | + | | [[RPR UpdateItemInProject|UpdateItemInProject]] |
- | | [[ | + | | [[RPR UpdateTimeline|UpdateTimeline]] |
+ | | [[RPR ValidatePtr|ValidatePtr]] | ||
+ | |- | ||
+ | | [[RPR WDL VirtualWnd ScaledBlitBG|WDL_VirtualWnd_ScaledBlitBG]] | ||
|} | |} | ||
Revision as of 11:36, 11 November 2009
ReaScript API Documentation
Don't forget - Call API functions using RPR_functionname() - Don't forget the RPR_
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.
Using these functions.
If a function takes a void* argument in the parameter list, which ReaScript thinks (correctly) is a modifiable variable, or any other modifiable variables in the parameter list, the function will return an array (return, parm1, parm2, ...).
This is a little counter-intuitive to Perl programmers but stick with me and read the example please.
e.g 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.
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.
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)