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

FX Management

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

Item Management

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

MIDI Management

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

Pitch Shifting

ReaScript API function reapy API function
EnumPitchShiftModes  
EnumPitchShiftSubModes  

Track Management

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

Transport Management

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