Translation Table

On this page you can find the list of all ReaScript API functions with their reapy counterparts (when they exist).

Categories are based on Mespotine’s ReaScript documentation.

Deferring Function Calls

ReaScript API function reapy API function
atexit at_exit
defer defer

Envelope Management

ReaScript API function reapy API function
CSurf_SetAutoMode  
CountEnvelopePoints Envelope.n_points
CountEnvelopePointsEx AutomationItem.n_points
CountTrackEnvelopes Track.n_envelopes
DeleteEnvelopePointRange Envelope.delete_points_in_range
DeleteEnvelopePointRangeEx AutomationItem.delete_points_in_range
Envelope_Evaluate Envelope.get_value; Envelope.get_derivatives
Envelope_FormatValue Envelope.get_value; Envelope.get_derivatives
Envelope_GetParentTake Envelope.parent
Envelope_GetParentTrack Envelope.parent
Envelope_SortPoints  
Envelope_SortPointsEx  
GetEnvelopeName Envelope.name
GetEnvelopePoint  
GetEnvelopePointByTime  
GetEnvelopePointByTimeEx  
GetEnvelopePointEx  
GetEnvelopeScalingMode  
GetEnvelopeStateChunk  
GetFXEnvelope FXParam.envelope; FXParam.add_envelope
GetGlobalAutomationOverride get_global_automation_mode
GetSelectedEnvelope Project.selected_envelope
GetSelectedTrackEnvelope Project.selected_envelope
GetSetEnvelopeState DEPRECATED
GetSetEnvelopeState2 DEPRECATED
GetTakeEnvelope Take.envelopes
GetTakeEnvelopeByName Take.envelopes
GetTrackAutomationMode Track.automation_mode
GetTrackEnvelope Track.envelopes
GetTrackEnvelopeByChunkName Track.envelopes
GetTrackEnvelopeByName Track.envelopes
InsertEnvelopePoint  
InsertEnvelopePointEx  
ScaleFromEnvelopeMode  
ScaleToEnvelopeMode  
SetAutomationMode  
SetEnvelopePoint  
SetEnvelopePointEx  
SetEnvelopeStateChunk  
SetGlobalAutomationOverride set_global_automation_mode
SetTrackAutomationMode Track.automation_mode

FX Management

ReaScript API function reapy API function
GetFocusedFX Project.focused_fx
GetLastTouchedFX Project.last_touched_fx
GetTCPFXParm  
PluginWantsAlwaysRunFx  
TakeFX_AddByName Take.add_fx
TakeFX_CopyToTake FX.copy_to_take; FX.move_to_take
TakeFX_CopyToTrack FX.copy_to_track; FX.move_to_track
TakeFX_Delete FX.delete
TakeFX_EndParamEdit  
TakeFX_FormatParamValue FXParam.format_value
TakeFX_FormatParamValueNormalized NormalizedFXParam.format_value
TakeFX_GetChainVisible Take.visible_fx
TakeFX_GetCount Take.n_fxs
TakeFX_GetEnabled FX.is_enabled
TakeFX_GetEnvelope FXParam.envelope; FXParam.add_envelope
TakeFX_GetFXGUID  
TakeFX_GetFXName FX.name
TakeFX_GetFloatingWindow FX.window
TakeFX_GetFormattedParamValue FXParam.formatted
TakeFX_GetIOSize FX.n_inputs; FX.n_outputs
TakeFX_GetNamedConfigParm  
TakeFX_GetNumParams FX.n_params
TakeFX_GetOffline FX.is_online
TakeFX_GetOpen FX.is_ui_open
TakeFX_GetParam FX.params
TakeFX_GetParamEx FX.params
TakeFX_GetParamName FXParam.name
TakeFX_GetParamNormalized FXParam.normalized
TakeFX_GetParameterStepSizes  
TakeFX_GetPinMappings  
TakeFX_GetPreset FX.preset
TakeFX_GetPresetIndex FX.preset_index
TakeFX_GetUserPresetFilename FX.preset_file
TakeFX_NavigatePresets FX.use_next_preset; FX.use_previous_preset
TakeFX_SetEnabled FX.enable; FX.disable
TakeFX_SetNamedConfigParm  
TakeFX_SetOffline FX.make_online; FX.make_offline
TakeFX_SetOpen FX.open_ui; FX.close_ui
TakeFX_SetParam FX.params
TakeFX_SetParamNormalized FXParam.normalized
TakeFX_SetPinMappings  
TakeFX_SetPreset FX.preset
TakeFX_SetPresetByIndex FX.preset
TakeFX_Show FX.open_chain; FX.open_floating_window; FX.close_chain; FX.close_floating_window
TrackFX_AddByName Track.add_fx
TrackFX_CopyToTake FX.copy_to_take; FX.move_to_take
TrackFX_CopyToTrack FX.copy_to_track; FX.move_to_track
TrackFX_Delete FX.delete
TrackFX_EndParamEdit  
TrackFX_FormatParamValue FXParam.format_value
TrackFX_FormatParamValueNormalized NormalizedFXParam.format_value
TrackFX_GetByName  
TrackFX_GetChainVisible Track.visible_fx
TrackFX_GetCount Track.n_fxs
TrackFX_GetEQ  
TrackFX_GetEQBandEnabled  
TrackFX_GetEQParam  
TrackFX_GetEnabled FX.is_enabled
TrackFX_GetFXGUID  
TrackFX_GetFXName FX.name
TrackFX_GetFloatingWindow FX.window
TrackFX_GetFormattedParamValue FXParam.formatted
TrackFX_GetIOSize FX.n_inputs; FX.n_outputs
TrackFX_GetInstrument Track.instrument
TrackFX_GetNamedConfigParm  
TrackFX_GetNumParams FX.n_params
TrackFX_GetOffline FX.is_online
TrackFX_GetParam FX.params
TrackFX_GetParamEx  
TrackFX_GetParamName FXParam.name
TrackFX_GetParamNormalized FXParam.normalized
TrackFX_GetParameterStepSizes  
TrackFX_GetPinMappings  
TrackFX_GetPreset FX.preset
TrackFX_GetPresetIndex FX.preset_index
TrackFX_GetRecChainVisible  
TrackFX_GetRecCount  
TrackFX_GetUserPresetFilename FX.preset_file
TrackFX_NavigatePresets FX.use_next_preset; FX.use_previous_preset
TrackFX_SetEQBandEnabled  
TrackFX_SetEQParam  
TrackFX_SetEnabled FX.enable; FX.disable
TrackFX_SetNamedConfigParm  
TrackFX_SetOffline FX.make_online; FX.make_offline
TrackFX_SetParam FX.params
TrackFX_SetParamNormalized FXParam.normalized
TrackFX_SetPinMappings  
TrackFX_SetPreset FX.preset
TrackFX_SetPresetByIndex FX.preset
TrackList_AdjustWindows  

Item Management

ReaScript API function reapy API function
AddMediaItemToTrack Track.add_item
AddTakeToMediaItem Item.add_take
ApplyNudge  
CountMediaItems Project.n_items
CountSelectedMediaItems Project.n_selected_items
CountTakeEnvelopes Take.n_envelopes
CountTakes Item.n_takes
CountTrackMediaItems Track.n_items
CreateNewMIDIItemInProj Track.add_midi_item
DeleteTrackMediaItem Item.delete
GetActiveTake Item.active_take
GetDisplayedMediaItemColor  
GetDisplayedMediaItemColor2  
GetItemProjectContext Item.project
GetItemStateChunk  
GetMediaItem Project.items
GetMediaItemInfo_Value Item.get_info_value
GetMediaItemNumTakes Item.n_takes
GetMediaItemTake Item.takes; Item.get_take
GetMediaItemTakeByGUID  
GetMediaItemTakeInfo_Value Take.get_info_value
GetMediaItemTake_Item Take.item
GetMediaItemTake_Peaks  
GetMediaItemTake_Source Take.source
GetMediaItemTake_Track Take.track
GetSelectedMediaItem Project.selected_items; Project.get_selected_item
GetSetItemState DEPRECATED
GetSetItemState2 DEPRECATED
GetSetMediaItemInfo_String  
GetSetMediaItemTakeInfo_String  
GetTake Item.takes
GetTakeName Take.name
GetTrackMediaItem Track.items
IsMediaItemSelected Item.is_selected
MoveMediaItemToTrack Item.track
SelectAllMediaItems Project.select_all_items
SetActiveTake Take.make_active_take
SetItemStateChunk  
SetMediaItemInfo_Value  
SetMediaItemLength Item.length
SetMediaItemPosition Item.position
SetMediaItemSelected  
SetMediaItemTakeInfo_Value  
SetMediaItemTake_Source  
SplitMediaItem Item.split
UpdateItemInProject Item.update

MIDI Management

ReaScript API function reapy API function
EnumTrackMIDIProgramNames  
EnumTrackMIDIProgramNamesEx  
GetTrackMIDILyrics  
GetTrackMIDINoteName  
GetTrackMIDINoteNameEx  
GetTrackMIDINoteRange  
HasTrackMIDIPrograms  
HasTrackMIDIProgramsEx  
MIDIEditor_GetActive midi.get_active_editor
MIDIEditor_GetMode MIDIEditor.mode
MIDIEditor_GetSetting_int MIDIEditor
MIDIEditor_GetSetting_str MIDIEditor
MIDIEditor_GetTake MIDIEditor.take
MIDIEditor_LastFocused_OnCommand midi.get_active_editor; MIDIEditor.perform_action
MIDIEditor_OnCommand MIDIEditor.perform_action
MIDI_CountEvts Take.n_cc; Take.n_notes; Take.n_text_sysex
MIDI_DeleteCC  
MIDI_DeleteEvt  
MIDI_DeleteNote  
MIDI_DeleteTextSysexEvt  
MIDI_EnumSelCC  
MIDI_EnumSelEvts  
MIDI_EnumSelNotes  
MIDI_EnumSelTextSysexEvts  
MIDI_GetAllEvts  
MIDI_GetCC  
MIDI_GetEvt  
MIDI_GetGrid  
MIDI_GetHash  
MIDI_GetNote Take.notes; Note
MIDI_GetPPQPosFromProjQN Take.beat_to_ppq
MIDI_GetPPQPosFromProjTime Take.time_to_ppq
MIDI_GetPPQPos_EndOfMeasure  
MIDI_GetPPQPos_StartOfMeasure  
MIDI_GetProjQNFromPPQPos Take.ppq_to_beat
MIDI_GetProjTimeFromPPQPos Take.ppq_to_time
MIDI_GetScale  
MIDI_GetTextSysexEvt  
MIDI_GetTrackHash  
MIDI_InsertCC  
MIDI_InsertEvt  
MIDI_InsertNote Take.add_note
MIDI_InsertTextSysexEvt  
MIDI_SelectAll Take.select_all_midi_events; Take.unselect_all_midi_events
MIDI_SetAllEvts  
MIDI_SetCC  
MIDI_SetEvt  
MIDI_SetItemExtents  
MIDI_SetNote  
MIDI_SetTextSysexEvt  
MIDI_Sort Take.sort_events
SetMIDIEditorGrid  
SetTrackMIDILyrics  
SetTrackMIDINoteName  
SetTrackMIDINoteNameEx  
StuffMIDIMessage  
TakeIsMIDI Take.is_midi
midi_reinit midi.reinit

Pitch Shifting

ReaScript API function reapy API function
EnumPitchShiftModes  
EnumPitchShiftSubModes  

Track Management

ReaScript API function reapy API function
AnyTrackSolo Project.any_track_solo
BypassFxAllTracks Project.bypass_fx_on_all_tracks
CSurf_GetTouchState  
CSurf_NumTracks  
CSurf_OnFXChange  
CSurf_OnInputMonitorChange  
CSurf_OnInputMonitorChangeEx  
CSurf_OnMuteChange  
CSurf_OnMuteChangeEx  
CSurf_OnPanChange  
CSurf_OnPanChangeEx  
CSurf_OnRecArmChange  
CSurf_OnRecArmChangeEx  
CSurf_OnRecvPanChange  
CSurf_OnRecvVolumeChange  
CSurf_OnSelectedChange  
CSurf_OnSendPanChange  
CSurf_OnSendVolumeChange  
CSurf_OnSoloChange  
CSurf_OnSoloChangeEx  
CSurf_OnStop  
CSurf_OnTrackSelection  
CSurf_OnVolumeChange  
CSurf_OnVolumeChangeEx  
CSurf_OnWidthChange  
CSurf_OnWidthChangeEx  
CSurf_ResetAllCachedVolPanStates  
CSurf_SetSurfaceMute  
CSurf_SetSurfacePan  
CSurf_SetSurfaceRecArm  
CSurf_SetSurfaceSelected  
CSurf_SetSurfaceSolo  
CSurf_SetSurfaceVolume  
CSurf_TrackFromID  
CSurf_TrackToID  
ClearAllRecArmed Project.disarm_rec_on_all_tracks
CountSelectedTracks Project.n_selected_tracks
CountSelectedTracks2 Project.n_selected_tracks
CountTCPFXParms  
CountTracks Project.n_tracks
CreateTrackSend Track.add_send
DeleteTrack Track.delete
GetLastTouchedTrack get_last_touched_track
GetMasterMuteSoloFlags DEPRECATED
GetMasterTrack Project.master_track
GetMasterTrackVisibility  
GetMediaItemTrack Item.track
GetMediaItem_Track Item.track
GetMediaTrackInfo_Value Track.get_info_value
GetNumTracks Project.n_tracks
GetParentTrack Track.parent_track
GetSelectedTrack Project.selected_tracks; Project.get_selected_track
GetSelectedTrack2 Project.selected_tracks; Project.get_selected_track
GetSetMediaTrackInfo_String Track.get_info_string; Track.set_info_string; Track.GUID; Track.icon; Track.name
GetSetTrackGroupMembership  
GetSetTrackGroupMembershipHigh  
GetSetTrackState DEPRECATED
GetSetTrackState2 DEPRECATED
GetTrack Project.tracks
GetTrackColor Track.color
GetTrackDepth Track.depth
GetTrackGUID Track.GUID
GetTrackName Track.name
GetTrackNumMediaItems Track.n_items
GetTrackNumSends Track.n_sends; Track.n_receives
GetTrackReceiveName  
GetTrackReceiveUIMute  
GetTrackReceiveUIVolPan  
GetTrackSendInfo_Value Send
GetTrackSendName  
GetTrackSendUIMute  
GetTrackSendUIVolPan  
GetTrackState  
GetTrackStateChunk  
GetTrackUIMute  
GetTrackUIPan  
GetTrackUIVolPan  
InsertTrackAtIndex Project.add_track
IsTrackSelected Track.is_selected
IsTrackVisible  
RemoveTrackSend Send.delete
ReorderSelectedTracks  
SetMasterTrackVisibility  
SetMediaTrackInfo_Value  
SetOnlyTrackSelected Track.make_only_selected_track
SetTrackColor Track.color
SetTrackSelected Track.is_selected; Track.select; Track.unselect
SetTrackSendInfo_Value Send
SetTrackSendUIPan  
SetTrackSendUIVol  
SetTrackStateChunk  
SoloAllTracks Project.solo_all_tracks; Project.unsolo_all_tracks
TrackFX_GetOpen FX.is_ui_open
TrackFX_SetOpen FX.open_ui; FX.close_ui
TrackFX_Show FX.open_chain; FX.open_floating_window; FX.close_chain; FX.close_floating_window
Track_GetPeakHoldDB  
Track_GetPeakInfo  

Transport Management

ReaScript API function reapy API function
CSurf_GoEnd  
CSurf_GoStart  
CSurf_OnFwd  
CSurf_OnPause  
CSurf_OnPlay  
CSurf_OnPlayRateChange  
CSurf_OnRecord  
CSurf_OnRew  
CSurf_OnRewFwd  
CSurf_ScrubAmt  
CSurf_SetPlayState  
CSurf_SetRepeatState  
GetAllProjectPlayStates get_projects; Project.play_state
GetCursorPosition Project.cursor_position
GetCursorPositionEx Project.cursor_position
GetPlayPosition Project.play_position
GetPlayPosition2 Project.buffer_position
GetPlayPosition2Ex Project.buffer_position
GetPlayPositionEx Project.play_position
GetPlayState Project.is_playing; Project.is_paused; Project.is_stopped; Project.is_recording
GetPlayStateEx Project.play_state
GetSetRepeat TimeSelection.is_looping; TimeSelection.loop; TimeSelection.unloop
GetSetRepeatEx TimeSelection.looping; TimeSelection.loop; TimeSelection.unloop
GetSet_LoopTimeRange Project.time_selection
GetSet_LoopTimeRange2 Project.time_selection
GoToMarker  
GoToRegion  
Loop_OnArrow TimeSelection.shift
Master_GetPlayRate Project.play_rate
Master_GetPlayRateAtTime Project.get_play_rate
Master_GetTempo Project.bpm
Master_NormalizePlayRate  
Master_NormalizeTempo  
MoveEditCursor  
MuteAllTracks Project.mute_all_tracks; Project.unmute_all_tracks
OnPauseButton Project.pause
OnPauseButtonEx Project.pause
OnPlayButton Project.play
OnPlayButtonEx Project.play
OnStopButton Project.stop
OnStopButtonEx Project.stop
SetEditCurPos Project.cursor_position
SetEditCurPos2 Project.cursor_position