ReaScript API

From CockosWiki

(Difference between revisions)
Jump to: navigation, search
m
Line 21: Line 21:
''Anything you see that's wrong or incomplete - and there's certainly plenty incomplete - please add a brief note saying what needs to be done. Someone will be along in a while with the time to make the change look good if you don't have the time.
''Anything you see that's wrong or incomplete - and there's certainly plenty incomplete - please add a brief note saying what needs to be done. Someone will be along in a while with the time to make the change look good if you don't have the time.
-
{|"class=wikitable"
+
{|class="wikitable"
| [[RPR_AddMediaItemToTrack|AddMediaItemToTrack]]
| [[RPR_AddMediaItemToTrack|AddMediaItemToTrack]]
 +
| [[RPR_AddProjectMarker|AddProjectMarker]]
| [[RPR_AddTakeToMediaItem|AddTakeToMediaItem]]
| [[RPR_AddTakeToMediaItem|AddTakeToMediaItem]]
| [[RPR_adjustZoom|adjustZoom]]
| [[RPR_adjustZoom|adjustZoom]]
-
| [[RPR_APITest|APITest]]
 
|-
|-
 +
| [[RPR_APITest|APITest]]
| [[RPR_Audio_IsPreBuffer|Audio_IsPreBuffer]]
| [[RPR_Audio_IsPreBuffer|Audio_IsPreBuffer]]
| [[RPR_Audio_IsRunning|Audio_IsRunning]]
| [[RPR_Audio_IsRunning|Audio_IsRunning]]
| [[RPR_Audio_RegHardwareHook|Audio_RegHardwareHook]]
| [[RPR_Audio_RegHardwareHook|Audio_RegHardwareHook]]
-
| [[RPR_BypassFxAllTracks|BypassFxAllTracks]]
 
|-
|-
 +
| [[RPR_BypassFxAllTracks|BypassFxAllTracks]]
| [[RPR_CalculatePeaks|CalculatePeaks]]
| [[RPR_CalculatePeaks|CalculatePeaks]]
| [[RPR_ClearAllRecArmed|ClearAllRecArmed]]
| [[RPR_ClearAllRecArmed|ClearAllRecArmed]]
| [[RPR_ClearPeakCache|ClearPeakCache]]
| [[RPR_ClearPeakCache|ClearPeakCache]]
-
| [[RPR_CountMediaItems|CountMediaItems]]
 
|-
|-
 +
| [[RPR_CountMediaItems|CountMediaItems]]
| [[RPR_CountSelectedMediaItems|CountSelectedMediaItems]]
| [[RPR_CountSelectedMediaItems|CountSelectedMediaItems]]
| [[RPR_CountSelectedTracks|CountSelectedTracks]]
| [[RPR_CountSelectedTracks|CountSelectedTracks]]
| [[RPR_CountTakes|CountTakes]]
| [[RPR_CountTakes|CountTakes]]
-
| [[RPR_CountTracks|CountTracks]]
 
|-
|-
 +
| [[RPR_CountTrackEnvelopes|CountTrackEnvelopes]]
| [[RPR_CountTrackMediaItems|CountTrackMediaItems]]
| [[RPR_CountTrackMediaItems|CountTrackMediaItems]]
 +
| [[RPR_CountTracks|CountTracks]]
| [[RPR_CreateMIDIInput|CreateMIDIInput]]
| [[RPR_CreateMIDIInput|CreateMIDIInput]]
 +
|-
| [[RPR_CreateMIDIOutput|CreateMIDIOutput]]
| [[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_DeleteTrack|DeleteTrack]]
 +
| [[RPR_DeleteTrackMediaItem|DeleteTrackMediaItem]]
|-
|-
-
| [[RPR_DeleteTrackMediaItem|DeleteTrackMediaItem]]
 
| [[RPR_DockWindowActivate|DockWindowActivate]]
| [[RPR_DockWindowActivate|DockWindowActivate]]
| [[RPR_DockWindowAdd|DockWindowAdd]]
| [[RPR_DockWindowAdd|DockWindowAdd]]
| [[RPR_DockWindowRemove|DockWindowRemove]]
| [[RPR_DockWindowRemove|DockWindowRemove]]
 +
| [[RPR_EnsureNotCompletelyOffscreen|EnsureNotCompletelyOffscreen]]
|-
|-
-
| [[RPR_EnsureNotCompletelyOffscreen|EnsureNotCompletelyOffscreen]]
 
| [[RPR_EnumPitchShiftModes|EnumPitchShiftModes]]
| [[RPR_EnumPitchShiftModes|EnumPitchShiftModes]]
| [[RPR_EnumPitchShiftSubModes|EnumPitchShiftSubModes]]
| [[RPR_EnumPitchShiftSubModes|EnumPitchShiftSubModes]]
-
| [[RPR_EnumProjectMarkers2|EnumProjectMarkers]]
+
| [[RPR_EnumProjectMarkers|EnumProjectMarkers]]
 +
| [[RPR_EnumProjectMarkers2|EnumProjectMarkers2]]
|-
|-
-
| [[RPR_EnumProjectMarkers2|EnumProjectMarkers2]]
 
| [[RPR_EnumProjects|EnumProjects]]
| [[RPR_EnumProjects|EnumProjects]]
-
| [[RPR_EnumTrackMIDIProgramNamesEx|EnumTrackMIDIProgramNames]]
+
| [[RPR_EnumTrackMIDIProgramNames|EnumTrackMIDIProgramNames]]
| [[RPR_EnumTrackMIDIProgramNamesEx|EnumTrackMIDIProgramNamesEx]]
| [[RPR_EnumTrackMIDIProgramNamesEx|EnumTrackMIDIProgramNamesEx]]
 +
| [[RPR_format_timestr|format_timestr]]
|-
|-
-
| [[RPR_format_timestr|format_timestr]]
 
| [[RPR_format_timestr_len|format_timestr_len]]
| [[RPR_format_timestr_len|format_timestr_len]]
| [[RPR_format_timestr_pos|format_timestr_pos]]
| [[RPR_format_timestr_pos|format_timestr_pos]]
| [[RPR_genGuid|genGuid]]
| [[RPR_genGuid|genGuid]]
-
|-
 
| [[RPR_get_config_var|get_config_var]]
| [[RPR_get_config_var|get_config_var]]
 +
|-
| [[RPR_get_ini_file|get_ini_file]]
| [[RPR_get_ini_file|get_ini_file]]
| [[RPR_GetActiveTake|GetActiveTake]]
| [[RPR_GetActiveTake|GetActiveTake]]
| [[RPR_GetColorThemeStruct|GetColorThemeStruct]]
| [[RPR_GetColorThemeStruct|GetColorThemeStruct]]
 +
| [[RPR_GetCursorPosition|GetCursorPosition]]
|-
|-
-
| [[RPR_GetCursorPositionEx|GetCursorPosition]]
 
| [[RPR_GetCursorPositionEx|GetCursorPositionEx]]
| [[RPR_GetCursorPositionEx|GetCursorPositionEx]]
 +
| [[RPR_GetEnvelopeName|GetEnvelopeName]]
| [[RPR_GetExePath|GetExePath]]
| [[RPR_GetExePath|GetExePath]]
| [[RPR_GetHZoomLevel|GetHZoomLevel]]
| [[RPR_GetHZoomLevel|GetHZoomLevel]]
Line 85: Line 135:
| [[RPR_GetMainHwnd|GetMainHwnd]]
| [[RPR_GetMainHwnd|GetMainHwnd]]
| [[RPR_GetMasterMuteSoloFlags|GetMasterMuteSoloFlags]]
| [[RPR_GetMasterMuteSoloFlags|GetMasterMuteSoloFlags]]
-
| [[RPR_GetMaxMidiInputs|GetMaxMidiInputs]]
 
-
|-
 
-
| [[RPR_GetMaxMidiOutputs|GetMaxMidiOutputs]]
 
-
| [[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_GetMaxMidiInputs|GetMaxMidiInputs]]
| [[RPR_GetMaxMidiInputs|GetMaxMidiInputs]]
|-
|-
Line 130: Line 165:
| [[RPR_GetPeaksBitmap|GetPeaksBitmap]]
| [[RPR_GetPeaksBitmap|GetPeaksBitmap]]
| [[RPR_GetPlayPosition|GetPlayPosition]]
| [[RPR_GetPlayPosition|GetPlayPosition]]
-
| [[RPR_GetPlayPositionEx|GetPlayPositionEx]]
+
| [[RPR_GetPlayPosition2|GetPlayPosition2]]
|-
|-
-
| [[RPR_GetPlayPosition2|GetPlayPosition2]]
 
| [[RPR_GetPlayPosition2Ex|GetPlayPosition2Ex]]
| [[RPR_GetPlayPosition2Ex|GetPlayPosition2Ex]]
 +
| [[RPR_GetPlayPositionEx|GetPlayPositionEx]]
| [[RPR_GetPlayState|GetPlayState]]
| [[RPR_GetPlayState|GetPlayState]]
| [[RPR_GetPlayStateEx|GetPlayStateEx]]
| [[RPR_GetPlayStateEx|GetPlayStateEx]]
Line 148: Line 183:
|-
|-
| [[RPR_GetSet_LoopTimeRange|GetSet_LoopTimeRange]]
| [[RPR_GetSet_LoopTimeRange|GetSet_LoopTimeRange]]
 +
| [[RPR_GetSet_LoopTimeRange2|GetSet_LoopTimeRange2]]
| [[RPR_GetSetEnvelopeState|GetSetEnvelopeState]]
| [[RPR_GetSetEnvelopeState|GetSetEnvelopeState]]
| [[RPR_GetSetItemState|GetSetItemState]]
| [[RPR_GetSetItemState|GetSetItemState]]
-
| [[RPR_GetSetMediaItemTakeInfo_String|GetSetMediaItemTakeInfo_String]]
 
|-
|-
 +
| [[RPR_GetSetMediaItemTakeInfo_String|GetSetMediaItemTakeInfo_String]]
| [[RPR_GetSetMediaTrackInfo_String|GetSetMediaTrackInfo_String]]
| [[RPR_GetSetMediaTrackInfo_String|GetSetMediaTrackInfo_String]]
| [[RPR_GetSetRepeat|GetSetRepeat]]
| [[RPR_GetSetRepeat|GetSetRepeat]]
| [[RPR_GetSetRepeatEx|GetSetRepeatEx]]
| [[RPR_GetSetRepeatEx|GetSetRepeatEx]]
-
| [[RPR_GetSetTrackState|GetSetTrackState]]
 
|-
|-
 +
| [[RPR_GetSetTrackState|GetSetTrackState]]
| [[RPR_GetTake|GetTake]]
| [[RPR_GetTake|GetTake]]
 +
| [[RPR_GetTakeEnvelopeByName|GetTakeEnvelopeByName]]
| [[RPR_GetTooltipWindow|GetTooltipWindow]]
| [[RPR_GetTooltipWindow|GetTooltipWindow]]
 +
|-
| [[RPR_GetTrack|GetTrack]]
| [[RPR_GetTrack|GetTrack]]
| [[RPR_GetTrackAutomationMode|GetTrackAutomationMode]]
| [[RPR_GetTrackAutomationMode|GetTrackAutomationMode]]
-
|-
 
| [[RPR_GetTrackEnvelope|GetTrackEnvelope]]
| [[RPR_GetTrackEnvelope|GetTrackEnvelope]]
| [[RPR_GetTrackEnvelopeByName|GetTrackEnvelopeByName]]
| [[RPR_GetTrackEnvelopeByName|GetTrackEnvelopeByName]]
 +
|-
| [[RPR_GetTrackGUID|GetTrackGUID]]
| [[RPR_GetTrackGUID|GetTrackGUID]]
| [[RPR_GetTrackMediaItem|GetTrackMediaItem]]
| [[RPR_GetTrackMediaItem|GetTrackMediaItem]]
-
|-
 
| [[RPR_GetTrackMIDINoteName|GetTrackMIDINoteName]]
| [[RPR_GetTrackMIDINoteName|GetTrackMIDINoteName]]
| [[RPR_GetTrackMIDINoteNameEx|GetTrackMIDINoteNameEx]]
| [[RPR_GetTrackMIDINoteNameEx|GetTrackMIDINoteNameEx]]
-
| [[RPR_GetTrackNumMediaItems|GetTrackNumMediaItems]]
 
-
| [[RPR_GetTrackUIVolPan|GetTrackUIVolPan]]
 
|-
|-
 +
| [[RPR_GetTrackNumMediaItems|GetTrackNumMediaItems]]
| [[RPR_GetTrackState|GetTrackState]]
| [[RPR_GetTrackState|GetTrackState]]
 +
| [[RPR_GetTrackUIVolPan|GetTrackUIVolPan]]
| [[RPR_GetUserInputs|GetUserInputs]]
| [[RPR_GetUserInputs|GetUserInputs]]
 +
|-
| [[RPR_GSC_mainwnd|GSC_mainwnd]]
| [[RPR_GSC_mainwnd|GSC_mainwnd]]
| [[RPR_guidToString|guidToString]]
| [[RPR_guidToString|guidToString]]
-
|-
 
| [[RPR_HasTrackMIDIPrograms|HasTrackMIDIPrograms]]
| [[RPR_HasTrackMIDIPrograms|HasTrackMIDIPrograms]]
| [[RPR_HasTrackMIDIProgramsEx|HasTrackMIDIProgramsEx]]
| [[RPR_HasTrackMIDIProgramsEx|HasTrackMIDIProgramsEx]]
 +
|-
| [[RPR_HiresPeaksFromSource|HiresPeaksFromSource]]
| [[RPR_HiresPeaksFromSource|HiresPeaksFromSource]]
| [[RPR_InsertMedia|InsertMedia]]
| [[RPR_InsertMedia|InsertMedia]]
-
|-
 
| [[RPR_InsertTrackAtIndex|InsertTrackAtIndex]]
| [[RPR_InsertTrackAtIndex|InsertTrackAtIndex]]
| [[RPR_IsInRealTimeAudio|IsInRealTimeAudio]]
| [[RPR_IsInRealTimeAudio|IsInRealTimeAudio]]
 +
|-
| [[RPR_IsMediaExtension|IsMediaExtension]]
| [[RPR_IsMediaExtension|IsMediaExtension]]
| [[RPR_kbd_OnMidiEvent|kbd_OnMidiEvent]]
| [[RPR_kbd_OnMidiEvent|kbd_OnMidiEvent]]
-
|-
 
| [[RPR_kbd_OnMidiList|kbd_OnMidiList]]
| [[RPR_kbd_OnMidiList|kbd_OnMidiList]]
| [[RPR_LICE_Blit|LICE_Blit]]
| [[RPR_LICE_Blit|LICE_Blit]]
 +
|-
| [[RPR_LICE_ClipLine|LICE_ClipLine]]
| [[RPR_LICE_ClipLine|LICE_ClipLine]]
| [[RPR_LICE_Line|LICE_Line]]
| [[RPR_LICE_Line|LICE_Line]]
-
|-
 
| [[RPR_LICE_LineInt|LICE_LineInt]]
| [[RPR_LICE_LineInt|LICE_LineInt]]
| [[RPR_Main_OnCommand|Main_OnCommand]]
| [[RPR_Main_OnCommand|Main_OnCommand]]
-
| [[RPR_Main_OnCommandEx|Main_OnCommandEx]]
 
-
| [[RPR_Main_openProject|''Main_openProject]]
 
|-
|-
 +
| [[RPR_Main_OnCommandEx|Main_OnCommandEx]]
 +
| [[RPR_Main_openProject|Main_openProject]]
| [[RPR_Main_UpdateLoopInfo|Main_UpdateLoopInfo]]
| [[RPR_Main_UpdateLoopInfo|Main_UpdateLoopInfo]]
| [[RPR_Master_GetPlayRateAtTime|Master_GetPlayRateAtTime]]
| [[RPR_Master_GetPlayRateAtTime|Master_GetPlayRateAtTime]]
-
| [[RPR_ShowMessageBox|MB]]
 
-
| [[RPR_MIDIEditor_GetActive|MIDIEditor_GetActive]]
 
|-
|-
-
| [[RPR_MIDIEditor_GetMode|MIDIEditor_GetMode]]
+
| [[RPR_MB|MB]]
-
| [[RPR_MIDIEditor_OnCommand|MIDIEditor_OnCommand]]
+
| [[RPR_MIDI_eventlist_Create|MIDI_eventlist_Create]]
| [[RPR_MIDI_eventlist_Create|MIDI_eventlist_Create]]
| [[RPR_MIDI_eventlist_Destroy|MIDI_eventlist_Destroy]]
| [[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_mkpanstr|mkpanstr]]
| [[RPR_mkvolpanstr|mkvolpanstr]]
| [[RPR_mkvolpanstr|mkvolpanstr]]
 +
|-
| [[RPR_mkvolstr|mkvolstr]]
| [[RPR_mkvolstr|mkvolstr]]
| [[RPR_MoveEditCursor|MoveEditCursor]]
| [[RPR_MoveEditCursor|MoveEditCursor]]
-
|-
 
| [[RPR_MoveMediaItemToTrack|MoveMediaItemToTrack]]
| [[RPR_MoveMediaItemToTrack|MoveMediaItemToTrack]]
| [[RPR_MuteAllTracks|MuteAllTracks]]
| [[RPR_MuteAllTracks|MuteAllTracks]]
 +
|-
 +
| [[RPR_my_getViewport|my_getViewport]]
| [[RPR_OnPauseButton|OnPauseButton]]
| [[RPR_OnPauseButton|OnPauseButton]]
| [[RPR_OnPauseButtonEx|OnPauseButtonEx]]
| [[RPR_OnPauseButtonEx|OnPauseButtonEx]]
-
|-
 
| [[RPR_OnPlayButton|OnPlayButton]]
| [[RPR_OnPlayButton|OnPlayButton]]
 +
|-
| [[RPR_OnPlayButtonEx|OnPlayButtonEx]]
| [[RPR_OnPlayButtonEx|OnPlayButtonEx]]
| [[RPR_OnStopButton|OnStopButton]]
| [[RPR_OnStopButton|OnStopButton]]
| [[RPR_OnStopButtonEx|OnStopButtonEx]]
| [[RPR_OnStopButtonEx|OnStopButtonEx]]
-
|-
 
| [[RPR_parse_timestr|parse_timestr]]
| [[RPR_parse_timestr|parse_timestr]]
 +
|-
| [[RPR_parse_timestr_len|parse_timestr_len]]
| [[RPR_parse_timestr_len|parse_timestr_len]]
| [[RPR_parse_timestr_pos|parse_timestr_pos]]
| [[RPR_parse_timestr_pos|parse_timestr_pos]]
| [[RPR_parsepanstr|parsepanstr]]
| [[RPR_parsepanstr|parsepanstr]]
-
|-
 
| [[RPR_PCM_Sink_Create|PCM_Sink_Create]]
| [[RPR_PCM_Sink_Create|PCM_Sink_Create]]
 +
|-
| [[RPR_PCM_Sink_CreateEx|PCM_Sink_CreateEx]]
| [[RPR_PCM_Sink_CreateEx|PCM_Sink_CreateEx]]
| [[RPR_PCM_Sink_CreateMIDIFile|PCM_Sink_CreateMIDIFile]]
| [[RPR_PCM_Sink_CreateMIDIFile|PCM_Sink_CreateMIDIFile]]
| [[RPR_PCM_Sink_CreateMIDIFileEx|PCM_Sink_CreateMIDIFileEx]]
| [[RPR_PCM_Sink_CreateMIDIFileEx|PCM_Sink_CreateMIDIFileEx]]
-
|-
 
| [[RPR_PCM_Sink_Enum|PCM_Sink_Enum]]
| [[RPR_PCM_Sink_Enum|PCM_Sink_Enum]]
 +
|-
| [[RPR_PCM_Sink_GetExtension|PCM_Sink_GetExtension]]
| [[RPR_PCM_Sink_GetExtension|PCM_Sink_GetExtension]]
| [[RPR_PCM_Sink_ShowConfig|PCM_Sink_ShowConfig]]
| [[RPR_PCM_Sink_ShowConfig|PCM_Sink_ShowConfig]]
| [[RPR_PCM_Source_CreateFromFile|PCM_Source_CreateFromFile]]
| [[RPR_PCM_Source_CreateFromFile|PCM_Source_CreateFromFile]]
-
|-
 
| [[RPR_PCM_Source_CreateFromFileEx|PCM_Source_CreateFromFileEx]]
| [[RPR_PCM_Source_CreateFromFileEx|PCM_Source_CreateFromFileEx]]
 +
|-
| [[RPR_PCM_Source_CreateFromSimple|PCM_Source_CreateFromSimple]]
| [[RPR_PCM_Source_CreateFromSimple|PCM_Source_CreateFromSimple]]
| [[RPR_PCM_Source_CreateFromType|PCM_Source_CreateFromType]]
| [[RPR_PCM_Source_CreateFromType|PCM_Source_CreateFromType]]
| [[RPR_PeakBuild_Create|PeakBuild_Create]]
| [[RPR_PeakBuild_Create|PeakBuild_Create]]
-
|-
 
| [[RPR_PeakGet_Create|PeakGet_Create]]
| [[RPR_PeakGet_Create|PeakGet_Create]]
 +
|-
| [[RPR_PlayPreview|PlayPreview]]
| [[RPR_PlayPreview|PlayPreview]]
| [[RPR_PlayTrackPreview|PlayTrackPreview]]
| [[RPR_PlayTrackPreview|PlayTrackPreview]]
| [[RPR_PlayTrackPreview2|PlayTrackPreview2]]
| [[RPR_PlayTrackPreview2|PlayTrackPreview2]]
-
|-
 
| [[RPR_plugin_getFilterList|plugin_getFilterList]]
| [[RPR_plugin_getFilterList|plugin_getFilterList]]
 +
|-
| [[RPR_plugin_getImportableProjectFilterList|plugin_getImportableProjectFilterList]]
| [[RPR_plugin_getImportableProjectFilterList|plugin_getImportableProjectFilterList]]
| [[RPR_PluginWantsAlwaysRunFx|PluginWantsAlwaysRunFx]]
| [[RPR_PluginWantsAlwaysRunFx|PluginWantsAlwaysRunFx]]
| [[RPR_projectconfig_var_addr|projectconfig_var_addr]]
| [[RPR_projectconfig_var_addr|projectconfig_var_addr]]
 +
| [[RPR_projectconfig_var_getoffs|projectconfig_var_getoffs]]
|-
|-
-
| [[RPR_projectconfig_var_getoffs|projectconfig_var_getoffs]]
 
| [[RPR_ReaperGetPitchShiftAPI|ReaperGetPitchShiftAPI]]
| [[RPR_ReaperGetPitchShiftAPI|ReaperGetPitchShiftAPI]]
| [[RPR_relative_fn|relative_fn]]
| [[RPR_relative_fn|relative_fn]]
| [[RPR_Resample_EnumModes|Resample_EnumModes]]
| [[RPR_Resample_EnumModes|Resample_EnumModes]]
 +
| [[RPR_Resampler_Create|Resampler_Create]]
|-
|-
-
| [[RPR_Resampler_Create|Resampler_Create]]
 
| [[RPR_resolve_fn|resolve_fn]]
| [[RPR_resolve_fn|resolve_fn]]
| [[RPR_screenset_register|screenset_register]]
| [[RPR_screenset_register|screenset_register]]
| [[RPR_screenset_unregister|screenset_unregister]]
| [[RPR_screenset_unregister|screenset_unregister]]
-
|-
 
| [[RPR_screenset_unregisterByParam|screenset_unregisterByParam]]
| [[RPR_screenset_unregisterByParam|screenset_unregisterByParam]]
 +
|-
| [[RPR_SelectProjectInstance|SelectProjectInstance]]
| [[RPR_SelectProjectInstance|SelectProjectInstance]]
| [[RPR_SetAutomationMode|SetAutomationMode]]
| [[RPR_SetAutomationMode|SetAutomationMode]]
| [[RPR_SetEditCurPos|SetEditCurPos]]
| [[RPR_SetEditCurPos|SetEditCurPos]]
 +
| [[RPR_SetEditCurPos2|SetEditCurPos2]]
|-
|-
-
| [[RPR_SetEditCurPos2|SetEditCurPos2]]
 
| [[RPR_SetMediaItemInfo_Value|SetMediaItemInfo_Value]]
| [[RPR_SetMediaItemInfo_Value|SetMediaItemInfo_Value]]
| [[RPR_SetMediaItemTakeInfo_Value|SetMediaItemTakeInfo_Value]]
| [[RPR_SetMediaItemTakeInfo_Value|SetMediaItemTakeInfo_Value]]
| [[RPR_SetMediaTrackInfo_Value|SetMediaTrackInfo_Value]]
| [[RPR_SetMediaTrackInfo_Value|SetMediaTrackInfo_Value]]
 +
| [[RPR_SetProjectMarker|SetProjectMarker]]
|-
|-
-
| [[RPR_SetProjectMarker|SetProjectMarker]]
 
| [[RPR_SetProjectMarker2|SetProjectMarker2]]
| [[RPR_SetProjectMarker2|SetProjectMarker2]]
| [[RPR_SetTrackAutomationMode|SetTrackAutomationMode]]
| [[RPR_SetTrackAutomationMode|SetTrackAutomationMode]]
| [[RPR_SetTrackMIDINoteName|SetTrackMIDINoteName]]
| [[RPR_SetTrackMIDINoteName|SetTrackMIDINoteName]]
-
|-
 
| [[RPR_SetTrackMIDINoteNameEx|SetTrackMIDINoteNameEx]]
| [[RPR_SetTrackMIDINoteNameEx|SetTrackMIDINoteNameEx]]
 +
|-
| [[RPR_SetTrackSelected|SetTrackSelected]]
| [[RPR_SetTrackSelected|SetTrackSelected]]
| [[RPR_ShowActionList|ShowActionList]]
| [[RPR_ShowActionList|ShowActionList]]
| [[RPR_ShowConsoleMsg|ShowConsoleMsg]]
| [[RPR_ShowConsoleMsg|ShowConsoleMsg]]
-
|-
 
| [[RPR_ShowMessageBox|ShowMessageBox]]
| [[RPR_ShowMessageBox|ShowMessageBox]]
 +
|-
 +
| [[RPR_SLIDER2DB|SLIDER2DB]]
| [[RPR_SoloAllTracks|SoloAllTracks]]
| [[RPR_SoloAllTracks|SoloAllTracks]]
| [[RPR_SplitMediaItem|SplitMediaItem]]
| [[RPR_SplitMediaItem|SplitMediaItem]]
Line 324: Line 364:
| [[RPR_Undo_EndBlock|Undo_EndBlock]]
| [[RPR_Undo_EndBlock|Undo_EndBlock]]
| [[RPR_Undo_EndBlock2|Undo_EndBlock2]]
| [[RPR_Undo_EndBlock2|Undo_EndBlock2]]
-
| [[RPR_Undo_OnStateChangeEx|Undo_OnStateChange]]
+
| [[RPR_Undo_OnStateChange|Undo_OnStateChange]]
-
| [[RPR_Undo_OnStateChangeEx2|Undo_OnStateChange2]]
+
| [[RPR_Undo_OnStateChange2|Undo_OnStateChange2]]
|-
|-
| [[RPR_Undo_OnStateChange_Item|Undo_OnStateChange_Item]]
| [[RPR_Undo_OnStateChange_Item|Undo_OnStateChange_Item]]
Line 336: Line 376:
| [[RPR_WDL_VirtualWnd_ScaledBlitBG|WDL_VirtualWnd_ScaledBlitBG]]
| [[RPR_WDL_VirtualWnd_ScaledBlitBG|WDL_VirtualWnd_ScaledBlitBG]]
|}
|}
 +
[[Category:ReaScript]]
[[Category:ReaScript]]
[[Category:API]]
[[Category:API]]

Revision as of 09:43, 9 November 2009

Back to main ReaScript page

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

Anything in the API documentation that is marked with a '?' is an assumption or something I'm just not sure about. If you happen to know whatever it is for certain - please correct or confirm the entry.

Anything you see that's wrong or incomplete - and there's certainly plenty incomplete - please add a brief note saying what needs to be done. Someone will be along in a while with the time to make the change look good if you don't have the time.

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