Bases: object
Bindings that allow FoxDot code to control Ardour Audio Workstation
Ardour website
Control of all the commands found in the GUI.
Based on Quark ArdourOSC
Init connection
from .Extensions.Ardour import Ardour
a = Ardour()
Puts transport in play mode
Stops a rolling transport
Toggles between play and stop
Stop transport and delete/forget last take
Move playhead to start of session
Move playhead to end of session
a.end()
a.add_marker()
a.next_marker()
a.rev_marker()
a.cancel_all_solos()
a.rec_enable_toggle()
a.save_state()
dB is a float indicating the desired gain in dB:
position is a float between 0 and 1 setting the desired position of the fader
where gain is a float ranging from -193 to 6 representing the desired gain of the track in dB.
etc…
-
add_marker()[source]
Adds marker to the current transport position.
-
bank_down()[source]
Change bank to the next lower bank.
-
bank_up()[source]
Change bank to the next higher bank.
-
cancel_all_solos()[source]
-
common_add_location_from_playhead()[source]
Add Mark from Playhead.
-
common_addexistingaudiofiles()[source]
Import.
-
common_alt_finish_range()[source]
Finish Range.
-
common_alt_start_range()[source]
Start Range.
-
common_alternate_add_location_from_playhead()[source]
Add Mark from Playhead.
-
common_alternate_jump_backward_to_mark()[source]
Jump to Previous Mark.
-
common_alternate_jump_forward_to_mark()[source]
Jump to Next Mark.
-
common_alternate_remove_location_from_playhead()[source]
Remove Mark at Playhead.
-
common_attach_editor()[source]
Attach.
-
common_attach_mixer()[source]
Attach.
-
common_attach_preferences()[source]
Attach.
-
common_change_editor_visibility()[source]
Change.
-
common_change_mixer_visibility()[source]
Change.
-
common_change_preferences_visibility()[source]
Change.
-
common_chat()[source]
Chat.
-
common_cheat_sheet()[source]
Cheat Sheet.
-
common_detach_editor()[source]
Detach.
-
common_detach_mixer()[source]
Detach.
-
common_detach_preferences()[source]
Detach.
-
common_finish_loop_range()[source]
Finish Loop Range.
-
common_finish_punch_range()[source]
Finish Punch Range.
-
common_finish_range()[source]
Finish Range.
-
common_finish_range_from_playhead()[source]
Finish Range from Playhead.
-
common_forums()[source]
User Forums.
-
common_hide()[source]
Hide.
-
common_hide_editor()[source]
Hide.
-
common_hide_mixer()[source]
Hide.
-
common_hide_preferences()[source]
Hide.
-
common_howto_report()[source]
How to Report a Bug.
-
common_jump_backward_to_mark()[source]
Jump to Previous Mark.
-
common_jump_forward_to_mark()[source]
Jump to Next Mark.
-
common_key_change_editor_visibility()[source]
Change.
-
common_key_change_mixer_visibility()[source]
Change.
-
common_key_change_preferences_visibility()[source]
Change.
-
common_manual()[source]
Help|Manual.
Preferences.
-
common_newmiditracer()[source]
MIDI Tracer.
-
common_next_tab()[source]
Next Tab.
-
common_nudge_next_backward()[source]
Nudge Next Earlier.
-
common_nudge_next_forward()[source]
Nudge Next Later.
-
common_nudge_playhead_backward()[source]
Nudge Playhead Backward.
-
common_nudge_playhead_forward()[source]
Nudge Playhead Forward.
-
common_playhead_backward_to_grid()[source]
Playhead to Previous Grid.
-
common_playhead_forward_to_grid()[source]
Playhead to Next Grid.
-
common_previous_tab()[source]
Previous Tab.
-
common_quit()[source]
Quit.
-
common_reference()[source]
Manual|Reference.
-
common_remove_location_from_playhead()[source]
Remove Mark at Playhead.
-
common_save()[source]
Save.
-
common_set_session_end_from_playhead()[source]
Set Session End from Playhead.
-
common_set_session_start_from_playhead()[source]
Set Session Start from Playhead.
-
common_show_editor()[source]
Show.
-
common_show_mixer()[source]
Show.
-
common_show_preferences()[source]
Show.
-
common_start_loop_range()[source]
Start Loop Range.
-
common_start_punch_range()[source]
Start Punch Range.
-
common_start_range()[source]
Start Range.
-
common_start_range_from_playhead()[source]
Start Range from Playhead.
-
common_toggle_editor_and_mixer()[source]
Toggle Editor & Mixer.
-
common_toggle_location_at_playhead()[source]
Toggle Mark at Playhead.
-
common_toggle_luawindow()[source]
Window|Scripting.
-
common_toggle_meterbridge()[source]
Window|Meterbridge.
-
common_togglemaximaleditor()[source]
Maximise Editor Space.
-
common_togglemaximalmixer()[source]
Maximise Mixer Space.
-
common_togglemixerlist()[source]
Toggle Mixer List.
-
common_togglemonitorsection()[source]
Toggle Monitor Section Visibility.
-
common_togglerecordenabletrack1()[source]
Toggle Record Enable Track 1.
-
common_togglerecordenabletrack10()[source]
Toggle Record Enable Track 10.
-
common_togglerecordenabletrack11()[source]
Toggle Record Enable Track 11.
-
common_togglerecordenabletrack12()[source]
Toggle Record Enable Track 12.
-
common_togglerecordenabletrack13()[source]
Toggle Record Enable Track 13.
-
common_togglerecordenabletrack14()[source]
Toggle Record Enable Track 14.
-
common_togglerecordenabletrack15()[source]
Toggle Record Enable Track 15.
-
common_togglerecordenabletrack16()[source]
Toggle Record Enable Track 16.
-
common_togglerecordenabletrack17()[source]
Toggle Record Enable Track 17.
-
common_togglerecordenabletrack18()[source]
Toggle Record Enable Track 18.
-
common_togglerecordenabletrack19()[source]
Toggle Record Enable Track 19.
-
common_togglerecordenabletrack2()[source]
Toggle Record Enable Track 2.
-
common_togglerecordenabletrack20()[source]
Toggle Record Enable Track 20.
-
common_togglerecordenabletrack21()[source]
Toggle Record Enable Track 21.
-
common_togglerecordenabletrack22()[source]
Toggle Record Enable Track 22.
-
common_togglerecordenabletrack23()[source]
Toggle Record Enable Track 23.
-
common_togglerecordenabletrack24()[source]
Toggle Record Enable Track 24.
-
common_togglerecordenabletrack25()[source]
Toggle Record Enable Track 25.
-
common_togglerecordenabletrack26()[source]
Toggle Record Enable Track 26.
-
common_togglerecordenabletrack27()[source]
Toggle Record Enable Track 27.
-
common_togglerecordenabletrack28()[source]
Toggle Record Enable Track 28.
-
common_togglerecordenabletrack29()[source]
Toggle Record Enable Track 29.
-
common_togglerecordenabletrack3()[source]
Toggle Record Enable Track 3.
-
common_togglerecordenabletrack30()[source]
Toggle Record Enable Track 30.
-
common_togglerecordenabletrack31()[source]
Toggle Record Enable Track 31.
-
common_togglerecordenabletrack32()[source]
Toggle Record Enable Track 32.
-
common_togglerecordenabletrack4()[source]
Toggle Record Enable Track 4.
-
common_togglerecordenabletrack5()[source]
Toggle Record Enable Track 5.
-
common_togglerecordenabletrack6()[source]
Toggle Record Enable Track 6.
-
common_togglerecordenabletrack7()[source]
Toggle Record Enable Track 7.
-
common_togglerecordenabletrack8()[source]
Toggle Record Enable Track 8.
-
common_togglerecordenabletrack9()[source]
Toggle Record Enable Track 9.
-
common_tracker()[source]
Report a Bug.
-
common_website()[source]
Ardour Website.
-
common_website_dev()[source]
Ardour Development.
-
disconnect()[source]
Stop the server thread and close the socket.
-
editor_addexistingptfiles()[source]
Import PT session.
-
editor_addexternalaudiotoregionlist()[source]
Import to Region List….
-
editor_alternate_alternate_redo()[source]
Redo.
-
editor_alternate_editor_delete()[source]
Delete.
-
editor_alternate_redo()[source]
Redo.
-
editor_alternate_select_all_after_edit_cursor()[source]
Select All After Edit Point.
-
editor_alternate_select_all_before_edit_cursor()[source]
Select All Before Edit Point.
-
editor_alternate_tab_to_transient_backwards()[source]
Move to Previous Transient.
-
editor_alternate_tab_to_transient_forwards()[source]
Move to Next Transient.
-
editor_bring_into_session()[source]
Bring all media into session folder.
-
editor_center_edit_cursor()[source]
Center Edit Point.
-
editor_center_playhead()[source]
Center Playhead.
-
editor_crop()[source]
Crop.
-
editor_cycle_edit_mode()[source]
Cycle Edit Mode.
-
editor_cycle_edit_point()[source]
Change Edit Point.
-
editor_cycle_edit_point_with_marker()[source]
Change Edit Point Including Marker.
-
editor_cycle_snap_mode()[source]
Next Snap Mode.
-
editor_cycle_zoom_focus()[source]
Next Zoom Focus.
-
editor_deselect_all()[source]
Deselect All.
-
editor_duplicate()[source]
Duplicate.
-
editor_edit_at_mouse()[source]
Mouse.
-
editor_edit_at_playhead()[source]
Playhead.
-
editor_edit_at_selected_marker()[source]
Marker.
-
editor_edit_current_meter()[source]
Edit Current Meter.
-
editor_edit_current_tempo()[source]
Edit Current Tempo.
-
editor_edit_cursor_to_next_region_end()[source]
To Next Region End.
-
editor_edit_cursor_to_next_region_start()[source]
To Next Region Start.
-
editor_edit_cursor_to_next_region_sync()[source]
To Next Region Sync.
-
editor_edit_cursor_to_previous_region_end()[source]
To Previous Region End.
-
editor_edit_cursor_to_previous_region_start()[source]
To Previous Region Start.
-
editor_edit_cursor_to_previous_region_sync()[source]
To Previous Region Sync.
-
editor_edit_cursor_to_range_end()[source]
To Range End.
-
editor_edit_cursor_to_range_start()[source]
To Range Start.
-
editor_edit_to_playhead()[source]
Active Mark to Playhead.
-
editor_editor_copy()[source]
Copy.
-
editor_editor_crop()[source]
Crop.
-
editor_editor_cut()[source]
Cut.
-
editor_editor_delete()[source]
Delete.
-
editor_editor_fade_range()[source]
Fade Range Selection.
-
editor_editor_paste()[source]
Paste.
-
editor_editor_separate()[source]
Separate.
-
editor_expand_tracks()[source]
Expand Track Height.
-
editor_export_audio()[source]
Export Audio.
-
editor_export_range()[source]
Export Range.
-
editor_fit_16_tracks()[source]
Fit 16 Tracks.
-
editor_fit_1_track()[source]
Fit 1 Track.
-
editor_fit_2_tracks()[source]
Fit 2 Tracks.
-
editor_fit_32_tracks()[source]
Fit 32 Tracks.
-
editor_fit_4_tracks()[source]
Fit 4 Tracks.
-
editor_fit_8_tracks()[source]
Fit 8 Tracks.
-
editor_fit_all_tracks()[source]
Fit All Tracks.
-
editor_fit_selection()[source]
Fit Selection (Vertical).
-
editor_goto_mark_1()[source]
Locate to Mark 1.
-
editor_goto_mark_2()[source]
Locate to Mark 2.
-
editor_goto_mark_3()[source]
Locate to Mark 3.
-
editor_goto_mark_4()[source]
Locate to Mark 4.
-
editor_goto_mark_5()[source]
Locate to Mark 5.
-
editor_goto_mark_6()[source]
Locate to Mark 6.
-
editor_goto_mark_7()[source]
Locate to Mark 7.
-
editor_goto_mark_8()[source]
Locate to Mark 8.
-
editor_goto_mark_9()[source]
Locate to Mark 9.
-
editor_goto_visual_state_1()[source]
Go to View 1.
-
editor_goto_visual_state_10()[source]
Go to View 10.
-
editor_goto_visual_state_11()[source]
Go to View 11.
-
editor_goto_visual_state_12()[source]
Go to View 12.
-
editor_goto_visual_state_2()[source]
Go to View 2.
-
editor_goto_visual_state_3()[source]
Go to View 3.
-
editor_goto_visual_state_4()[source]
Go to View 4.
-
editor_goto_visual_state_5()[source]
Go to View 5.
-
editor_goto_visual_state_6()[source]
Go to View 6.
-
editor_goto_visual_state_7()[source]
Go to View 7.
-
editor_goto_visual_state_8()[source]
Go to View 8.
-
editor_goto_visual_state_9()[source]
Go to View 9.
-
editor_importfromsession()[source]
Import from Session.
-
editor_insert_time()[source]
Insert Time.
-
editor_invert_selection()[source]
Invert Selection.
-
editor_lock()[source]
Session|Lock.
-
editor_main_menu_play_selected_regions()[source]
Play Selected Regions.
-
editor_move_range_end_to_next_region_boundary()[source]
Move Range End to Next Region Boundary.
-
editor_move_range_end_to_previous_region_boundary()[source]
Move Range End to Previous Region Boundary.
-
editor_move_range_start_to_next_region_boundary()[source]
Move Range Start to Next Region Boundary.
-
editor_move_range_start_to_previous_region_boundary()[source]
Move Range Start to Previous Region Boundary.
-
editor_move_selected_tracks_down()[source]
Move Selected Tracks Down.
-
editor_move_selected_tracks_up()[source]
Move Selected Tracks Up.
-
editor_multi_duplicate()[source]
Multi-Duplicate….
-
editor_next_snap_choice()[source]
Next Snap Choice.
-
editor_next_snap_choice_music_only()[source]
Next Musical Snap Choice.
-
editor_play_edit_range()[source]
Play Edit Range.
-
editor_play_from_edit_point()[source]
Play from Edit Point.
-
editor_play_from_edit_point_and_return()[source]
Play from Edit Point and Return.
-
editor_playhead_to_edit()[source]
Playhead to Active Mark.
-
editor_playhead_to_next_region_boundary()[source]
Playhead to Next Region Boundary.
-
editor_playhead_to_next_region_boundary_noselection()[source]
Playhead to Next Region Boundary (No Track Selection).
-
editor_playhead_to_next_region_end()[source]
Playhead to Next Region End.
-
editor_playhead_to_next_region_start()[source]
Playhead to Next Region Start.
-
editor_playhead_to_next_region_sync()[source]
Playhead to Next Region Sync.
-
editor_playhead_to_previous_region_boundary()[source]
Playhead to Previous Region Boundary.
-
editor_playhead_to_previous_region_boundary_noselection()[source]
Playhead to Previous Region Boundary (No Track Selection).
-
editor_playhead_to_previous_region_end()[source]
Playhead to Previous Region End.
-
editor_playhead_to_previous_region_start()[source]
Playhead to Previous Region Start.
-
editor_playhead_to_previous_region_sync()[source]
Playhead to Previous Region Sync.
-
editor_playhead_to_range_end()[source]
Playhead to Range End.
-
editor_playhead_to_range_start()[source]
Playhead to Range Start.
-
editor_prev_snap_choice()[source]
Previous Snap Choice.
-
editor_prev_snap_choice_music_only()[source]
Previous Musical Snap Choice.
-
editor_quantize()[source]
Quantize.
-
editor_redo()[source]
Redo.
-
editor_redo_last_selection_op()[source]
Redo Selection Change.
-
editor_remove_last_capture()[source]
Remove Last Capture.
-
editor_remove_time()[source]
Remove Time.
-
editor_remove_track()[source]
Remove.
-
editor_save_visual_state_1()[source]
Save View 1.
-
editor_save_visual_state_10()[source]
Save View 10.
-
editor_save_visual_state_11()[source]
Save View 11.
-
editor_save_visual_state_12()[source]
Save View 12.
-
editor_save_visual_state_2()[source]
Save View 2.
-
editor_save_visual_state_3()[source]
Save View 3.
-
editor_save_visual_state_4()[source]
Save View 4.
-
editor_save_visual_state_5()[source]
Save View 5.
-
editor_save_visual_state_6()[source]
Save View 6.
-
editor_save_visual_state_7()[source]
Save View 7.
-
editor_save_visual_state_8()[source]
Save View 8.
-
editor_save_visual_state_9()[source]
Save View 9.
-
editor_script_action_1()[source]
Custom Action #1.
-
editor_script_action_2()[source]
Custom Action #2.
-
editor_script_action_3()[source]
Custom Action #3.
-
editor_script_action_4()[source]
Custom Action #4.
-
editor_script_action_5()[source]
Custom Action #5.
-
editor_script_action_6()[source]
Custom Action #6.
-
editor_script_action_7()[source]
Custom Action #7.
-
editor_script_action_8()[source]
Custom Action #8.
-
editor_script_action_9()[source]
Custom Action #9.
-
editor_scroll_backward()[source]
Scroll Backward.
-
editor_scroll_forward()[source]
Scroll Forward.
-
editor_scroll_playhead_backward()[source]
Playhead Backward.
-
editor_scroll_playhead_forward()[source]
Playhead Forward.
-
editor_scroll_tracks_down()[source]
Scroll Tracks Down.
-
editor_scroll_tracks_up()[source]
Scroll Tracks Up.
-
editor_select_all_after_edit_cursor()[source]
Select All After Edit Point.
-
editor_select_all_before_edit_cursor()[source]
Select All Before Edit Point.
-
editor_select_all_between_cursors()[source]
Select All Overlapping Edit Range.
-
editor_select_all_in_loop_range()[source]
Select All in Loop Range.
-
editor_select_all_in_punch_range()[source]
Select All in Punch Range.
-
editor_select_all_objects()[source]
Select All Objects.
-
editor_select_all_tracks()[source]
Select All Tracks.
-
editor_select_all_within_cursors()[source]
Select All Inside Edit Range.
-
editor_select_from_regions()[source]
Set Range to Selected Regions.
-
editor_select_loop_range()[source]
Set Range to Loop Range.
-
editor_select_next_route()[source]
Select Next Track or Bus.
-
editor_select_prev_route()[source]
Select Previous Track or Bus.
-
editor_select_punch_range()[source]
Set Range to Punch Range.
-
editor_select_range_between_cursors()[source]
Select Edit Range.
-
editor_selected_marker_to_next_region_boundary()[source]
To Next Region Boundary.
-
editor_selected_marker_to_next_region_boundary_noselection()[source]
To Next Region Boundary (No Track Selection).
-
editor_selected_marker_to_previous_region_boundary()[source]
To Previous Region Boundary.
-
editor_selected_marker_to_previous_region_boundary_noselection()[source]
To Previous Region Boundary (No Track Selection).
-
editor_separate_from_loop()[source]
Separate Using Loop Range.
-
editor_separate_from_punch()[source]
Separate Using Punch Range.
-
editor_set_auto_punch_range()[source]
Set Auto Punch In/Out from Playhead.
-
editor_set_edit_lock()[source]
EditMode|Lock.
-
editor_set_edit_point()[source]
Active Marker to Mouse.
-
editor_set_edit_ripple()[source]
Ripple.
-
editor_set_edit_slide()[source]
Slide.
-
editor_set_loop_from_edit_range()[source]
Set Loop from Selection.
-
editor_set_playhead()[source]
Playhead to Mouse.
-
editor_set_punch_from_edit_range()[source]
Set Punch from Selection.
-
editor_set_session_from_edit_range()[source]
Set Session Start/End from Selection.
-
editor_set_tempo_from_edit_range()[source]
Set Tempo from Edit Range = Bar.
-
editor_show_editor_list()[source]
Show Editor List.
-
editor_show_editor_mixer()[source]
Show Editor Mixer.
-
editor_show_marker_lines()[source]
Show Marker Lines.
-
editor_shrink_tracks()[source]
Shrink Track Height.
-
editor_snap_magnetic()[source]
Magnetic.
-
editor_snap_normal()[source]
Grid.
-
editor_snap_off()[source]
No Grid.
-
editor_snapmode()[source]
Snap Mode.
-
editor_snapto()[source]
Snap to.
-
editor_sound_midi_notes()[source]
Sound Selected MIDI Notes.
-
editor_split_region()[source]
Split/Separate.
-
editor_step_mouse_mode()[source]
Step Mouse Mode.
-
editor_step_tracks_down()[source]
Step Tracks Down.
-
editor_step_tracks_up()[source]
Step Tracks Up.
-
editor_tab_to_transient_backwards()[source]
Move to Previous Transient.
-
editor_tab_to_transient_forwards()[source]
Move to Next Transient.
-
editor_temporal_zoom_in()[source]
Zoom In.
-
editor_temporal_zoom_out()[source]
Zoom Out.
-
editor_toggle_follow_playhead()[source]
Follow Playhead.
-
editor_toggle_log_window()[source]
Log.
-
editor_toggle_midi_input_active()[source]
Toggle MIDI Input Active for Editor-Selected Tracks/Busses.
-
editor_toggle_skip_playback()[source]
Use Skip Ranges.
-
editor_toggle_stationary_playhead()[source]
Stationary Playhead.
-
editor_toggle_track_active()[source]
Toggle Active.
-
editor_toggle_vmon_frame()[source]
Frame number.
-
editor_toggle_vmon_fullscreen()[source]
Fullscreen.
-
editor_toggle_vmon_letterbox()[source]
Letterbox.
-
editor_toggle_vmon_ontop()[source]
Always on Top.
-
editor_toggle_vmon_osdbg()[source]
Timecode Background.
-
editor_toggle_vmon_timecode()[source]
Timecode.
-
editor_toggle_zoom()[source]
Toggle Zoom State.
-
editor_togglegrouptabs()[source]
Show Group Tabs.
-
editor_togglejadeo()[source]
Video Monitor.
-
editor_togglemeasurevisibility()[source]
Show Measure Lines.
-
editor_togglesummary()[source]
Show Summary.
-
editor_track_height_large()[source]
Large.
-
editor_track_height_larger()[source]
Larger.
-
editor_track_height_largest()[source]
Largest.
-
editor_track_height_normal()[source]
Normal.
-
editor_track_height_small()[source]
Small.
-
editor_track_mute_toggle()[source]
Toggle Mute.
-
editor_track_record_enable_toggle()[source]
Toggle Record Enable.
-
editor_track_solo_isolate_toggle()[source]
Toggle Solo Isolate.
-
editor_track_solo_toggle()[source]
Toggle Solo.
-
editor_undo()[source]
Command|Undo.
-
editor_undo_last_selection_op()[source]
Undo Selection Change.
-
editor_zoom_100_ms()[source]
Zoom to 100 ms.
-
editor_zoom_10_min()[source]
Zoom to 10 min.
-
editor_zoom_10_ms()[source]
Zoom to 10 ms.
-
editor_zoom_10_sec()[source]
Zoom to 10 sec.
-
editor_zoom_1_min()[source]
Zoom to 1 min.
-
editor_zoom_1_sec()[source]
Zoom to 1 sec.
-
editor_zoom_5_min()[source]
Zoom to 5 min.
-
editor_zoom_to_selection()[source]
Zoom to Selection.
-
editor_zoom_to_selection_horiz()[source]
Zoom to Selection (Horizontal).
-
editor_zoom_to_session()[source]
Zoom to Session.
-
editor_zoom_vmon_100()[source]
Original Size.
Align.
Autoconnect.
Crossfades.
Edit.
Move Selected Marker.
Edit Point.
Select Range Operations.
Select Regions.
Fade.
Latch.
Link.
Locate to Markers.
Lua Scripts.
Markers.
Meter falloff.
Meter hold.
MIDI Options.
Misc Options.
Monitoring.
Active Mark.
Playhead.
Play.
Primary Clock.
Pullup / Pulldown.
Region operations.
Gain.
Region.
Duplicate.
Edit.
Fades.
Gain.
Layering.
MIDI.
Position.
Ranges.
Trim.
Rulers.
Views.
Scroll.
Secondary Clock.
Select.
Select.
Separate.
Loop.
Punch.
Solo.
Subframes.
Sync.
Tempo.
Timecode fps.
Tools.
Height.
Track.
Video Monitor.
View.
Zoom Focus.
Zoom Focus.
Zoom.
-
end()[source]
Move playhead to end of session.
-
ffwd()[source]
Adds 1.5 times to transport speed to maximum +8 times normal speed.
-
goto_end()
Move playhead to end of session.
-
goto_start()
Move playhead to start of session.
-
jump_bars(bars=1)[source]
Where bars is a float (+/-) of the number of bars to jump.
-
jump_seconds(seconds=1)[source]
Where seconds is a float (+/-) of the number of seconds to jump.
-
locate(spos, roll)[source]
where spos is the target position in samples and roll is a bool/integer
defining whether you want transport to be kept rolling or not
/locate spos roll
-
loop_location(start, end)[source]
start is the beginning of a loop and end is the end
of a loop both are integer frame positions.
-
loop_toggle()[source]
Toggle loop mode on and off.
-
main_addtrackbus()[source]
Add Track, Bus or VCA…
-
main_archive()[source]
Archive….
-
main_cancel_solo()[source]
Cancel Solo.
-
main_cleanuppeakfiles()[source]
Reset Peak Files.
-
main_cleanupunused()[source]
Clean-up Unused Sources…
-
main_close()[source]
Close.
-
main_close_current_dialog()[source]
Close Current Dialog.
-
main_closevideo()[source]
Remove Video.
-
main_duplicate_routes()[source]
Duplicate Tracks/Busses….
-
main_editmetadata()[source]
Edit Metadata….
-
main_escape()[source]
Escape (deselect all).
-
main_export()[source]
Export.
-
main_exportaudio()[source]
Export to Audio File(s)…
-
main_exportvideo()[source]
Export to Video File…
-
main_flushwastebasket()[source]
Flush Wastebasket.
-
main_importmetadata()[source]
Import Metadata….
-
main_menu_audiofileformat()[source]
Audio File Format.
-
main_menu_audiofileformatdata()[source]
Sample Format.
-
main_menu_audiofileformatheader()[source]
File Type.
-
main_menu_cleanup()[source]
Clean-up.
-
main_menu_controlsurfaces()[source]
Control Surfaces.
-
main_menu_denormals()[source]
Denormal Handling.
-
main_menu_detachmenu()[source]
Detach.
-
main_menu_editormenu()[source]
Editor.
-
main_menu_help()[source]
Help.
-
main_menu_keymouseactions()[source]
Misc. Shortcuts.
-
main_menu_metering()[source]
Metering.
-
main_menu_meteringfalloffrate()[source]
Fall Off Rate.
-
main_menu_meteringholdtime()[source]
Hold Time.
-
main_menu_mixermenu()[source]
Mixer.
-
main_menu_plugins()[source]
Plugins.
-
main_menu_prefsmenu()[source]
Preferences.
-
main_menu_session()[source]
Session.
-
main_menu_sync()[source]
Sync.
-
main_menu_transportoptions()[source]
Options.
-
main_menu_windowmenu()[source]
Window.
-
main_metadata()[source]
Metadata.
-
main_new()[source]
New….
-
main_open()[source]
Open….
-
main_openvideo()[source]
Open Video….
-
main_quicksnapshotstay()[source]
Quick Snapshot (& keep working on current version) …
-
main_quicksnapshotswitch()[source]
Quick Snapshot (& switch to new version) …
-
main_recent()[source]
Recent….
-
main_rename()[source]
Rename….
-
main_saveas()[source]
Save As….
-
main_savetemplate()[source]
Save Template….
-
main_scripting()[source]
Session|Scripting.
-
main_snapshotstay()[source]
Snapshot (& keep working on current version) …
-
main_snapshotswitch()[source]
Snapshot (& switch to new version) …
-
main_stemexport()[source]
Stem export….
-
master_fader(position: float | int = 0.8)[source]
position is a float between 0 and 1 setting the desired position of the fader.
-
master_gain(dB: float | int)[source]
dB is a float indicating the desired gain in dB.
-
master_mute(state: bool | int = True)[source]
state is an int of o or 1 representing the desired mute state.
-
master_pan_stereo_position(position)[source]
position is a float from 0 to 1 representing the desired pan position.
-
master_trimdB(dB)[source]
dB is a float from -20 to +20 representing the desired trim gain in dB.
-
midi_panic()[source]
-
mixer_ab_plugins()[source]
Toggle Selected Plugins.
-
mixer_copy_processors()[source]
Copy Selected Processors.
-
mixer_cut_processors()[source]
Cut Selected Processors.
-
mixer_decrement_gain()[source]
Increase Gain on Mixer-Selected Tracks/Busses.
-
mixer_delete_processors()[source]
Delete Selected Processors.
-
mixer_increment_gain()[source]
Decrease Gain on Mixer-Selected Tracks/Busses.
-
mixer_mute()[source]
Toggle Mute on Mixer-Selected Tracks/Busses.
-
mixer_paste_processors()[source]
Paste Selected Processors.
-
mixer_recenable()[source]
Toggle Rec-enable on Mixer-Selected Tracks/Busses.
-
mixer_scroll_left()[source]
Scroll Mixer Window to the left.
-
mixer_scroll_right()[source]
Scroll Mixer Window to the right.
-
mixer_select_all_processors()[source]
Select All (visible) Processors.
-
mixer_select_none()[source]
Deselect all strips and processors.
-
mixer_solo()[source]
Toggle Solo on Mixer-Selected Tracks/Busses.
-
mixer_toggle_midi_input_active()[source]
Toggle MIDI Input Active for Editor-Selected Tracks/Busses.
-
mixer_toggle_processors()[source]
Toggle Selected Processors.
-
mixer_unity_gain()[source]
Set Gain to 0dB on Mixer-Selected Tracks/Busses.
-
monitor_dim(state)[source]
state is an int of 0 or 1 where 1 is dimmed.
-
monitor_fader(position)[source]
position is a float between 0 and 1 setting the desired position of the fader.
-
monitor_gain(dB)[source]
dB is a float indicating the desired gain in dB.
-
monitor_mono(state)[source]
state is an int of 0 or 1 where 1 is mono mode.
-
monitor_mute(state)[source]
state is an int of 0 or 1 where 1 is muted.
-
mousemode_set_mouse_mode_audition()[source]
Audition Tool.
-
mousemode_set_mouse_mode_content()[source]
Content Tool.
-
mousemode_set_mouse_mode_cut()[source]
Cut Tool.
-
mousemode_set_mouse_mode_draw()[source]
Note Drawing Tool.
-
mousemode_set_mouse_mode_object()[source]
Object Tool.
-
mousemode_set_mouse_mode_object_range()[source]
Smart Object Mode.
-
mousemode_set_mouse_mode_range()[source]
Range Tool.
-
mousemode_set_mouse_mode_timefx()[source]
Time FX Tool.
-
next_marker()[source]
Move playhead to next marker.
-
options_sendmidiclock()[source]
Send MIDI Clock.
-
options_sendmmc()[source]
Send MMC.
-
options_sendmtc()[source]
Send MTC.
-
options_usemmc()[source]
Use MMC.
-
play()[source]
Puts transport in play mode.
-
prev_marker()[source]
Move playhead to previous marker.
A/B Plugins.
Activate All.
Delete.
Clear (all)
Clear (post-fader).
Clear (pre-fader).
Controls.
Copy
Cut.
Deactivate All.
Delete.
Deselect All.
Edit…
Edit with generic controls…
Pin Connections…
New Aux Send …
New Insert.
New Plugin.
New External Send …
Paste.
Rename.
Select All.
Send Options.
-
rec_enable_toggle()[source]
Toggles master record enable.
-
record_enabled()[source]
Ardour sends /record_enabled recordenable_status.
-
redo()[source]
-
region_add_range_marker_from_region()[source]
Add Single Range Marker.
-
region_add_range_markers_from_region()[source]
Add Range Marker Per Region.
-
region_align_regions_end()[source]
Align End.
-
region_align_regions_end_relative()[source]
Align End Relative.
-
region_align_regions_start()[source]
Align Start.
-
region_align_regions_start_relative()[source]
Align Start Relative.
-
region_align_regions_sync()[source]
Align Sync.
-
region_align_regions_sync_relative()[source]
Align Sync Relative.
-
region_alternate_nudge_backward()[source]
Nudge Earlier.
-
region_alternate_nudge_forward()[source]
Nudge Later.
-
region_alternate_set_fade_in_length()[source]
Set Fade In Length.
-
region_alternate_set_fade_out_length()[source]
Set Fade Out Length.
-
region_boost_region_gain()[source]
Boost Gain.
-
region_bounce_regions_processed()[source]
Bounce (with processing).
-
region_bounce_regions_unprocessed()[source]
Bounce (without processing).
-
region_choose_top_region()[source]
Choose Top….
Choose Top….
-
region_close_region_gaps()[source]
Close Gaps.
-
region_combine_regions()[source]
Combine.
-
region_cut_region_gain()[source]
Cut Gain.
-
region_duplicate_region()[source]
Duplicate.
-
region_export_region()[source]
Export….
-
region_fork_region()[source]
Unlink from other copies.
-
region_insert_patch_change()[source]
Insert Patch Change….
-
region_insert_patch_change_context()[source]
Insert Patch Change….
-
region_insert_region_from_region_list()[source]
Insert Region from Region List.
-
region_legatize_region()[source]
Legatize.
-
region_loop_region()[source]
Loop.
-
region_loudness_analyze_region()[source]
Loudness Analysis….
-
region_lower_region()[source]
Lower.
-
region_lower_region_to_bottom()[source]
Lower to Bottom.
-
region_multi_duplicate_region()[source]
Multi-Duplicate….
-
region_naturalize_region()[source]
Move to Original Position.
-
region_normalize_region()[source]
Normalize….
-
region_nudge_backward()[source]
Nudge Earlier.
-
region_nudge_backward_by_capture_offset()[source]
Nudge Earlier by Capture Offset.
-
region_nudge_forward()[source]
Nudge Later.
-
region_nudge_forward_by_capture_offset()[source]
Nudge Later by Capture Offset.
-
region_pitch_shift_region()[source]
Pitch Shift….
-
region_place_transient()[source]
Place Transient.
-
region_play_selected_regions()[source]
Play selected Regions.
-
region_quantize_region()[source]
Quantize….
-
region_raise_region()[source]
Raise.
-
region_raise_region_to_top()[source]
Raise to Top.
-
region_region_fill_track()[source]
Fill Track.
-
region_remove_overlap()[source]
Remove Overlap.
-
region_remove_region()[source]
Remove.
-
region_remove_region_sync()[source]
Remove Sync.
-
region_rename_region()[source]
Rename….
-
region_reset_region_gain()[source]
Reset Gain.
-
region_reset_region_gain_envelopes()[source]
Reset Envelope.
-
region_reset_region_scale_amplitude()[source]
Reset Gain.
-
region_reverse_region()[source]
Reverse.
-
region_separate_under_region()[source]
Separate Under.
-
region_sequence_regions()[source]
Sequence Regions.
-
region_set_fade_in_length()[source]
Set Fade In Length.
-
region_set_fade_out_length()[source]
Set Fade Out Length.
-
region_set_loop_from_region()[source]
Set Loop Range.
-
region_set_punch_from_region()[source]
Set Punch.
-
region_set_region_sync_position()[source]
Set Sync Position.
-
region_set_selection_from_region()[source]
Set Range Selection.
-
region_set_tempo_from_region()[source]
Set Tempo from Region = Bar.
-
region_show_region_list_editor()[source]
List Editor….
-
region_show_region_properties()[source]
Properties….
-
region_show_rhythm_ferret()[source]
Rhythm Ferret….
-
region_snap_regions_to_grid()[source]
Snap Position to Grid.
-
region_spectral_analyze_region()[source]
Spectral Analysis….
-
region_split_multichannel_region()[source]
Make Mono Regions.
-
region_split_region_at_transients()[source]
Split at Percussion Onsets.
-
region_strip_region_silence()[source]
Strip Silence….
-
region_toggle_opaque_region()[source]
Opaque.
-
region_toggle_region_fade_in()[source]
Fade In.
-
region_toggle_region_fade_out()[source]
Fade Out.
-
region_toggle_region_fades()[source]
Fades.
-
region_toggle_region_gain_envelope_active()[source]
Envelope Active.
-
region_toggle_region_lock()[source]
Lock.
-
region_toggle_region_lock_style()[source]
Glue to Bars and Beats.
-
region_toggle_region_mute()[source]
Mute.
-
region_toggle_region_video_lock()[source]
Lock to Video.
-
region_transform_region()[source]
Transform….
-
region_transpose_region()[source]
Transpose….
-
region_trim_back()[source]
Trim End at Edit Point.
-
region_trim_front()[source]
Trim Start at Edit Point.
-
region_trim_region_to_loop()[source]
Trim to Loop.
-
region_trim_region_to_punch()[source]
Trim to Punch.
-
region_trim_to_next_region()[source]
Trim to Next.
-
region_trim_to_previous_region()[source]
Trim to Previous.
-
region_uncombine_regions()[source]
Uncombine.
-
regionlist_regionlistsort()[source]
Sort.
-
regionlist_removeunusedregions()[source]
Remove Unused.
-
regionlist_rlaudition()[source]
Audition.
-
regionlist_rlhide()[source]
Hide.
-
regionlist_rlshow()[source]
Show.
-
regionlist_rlshowall()[source]
Show All.
-
regionlist_rlshowauto()[source]
Show Automatic Regions.
-
regionlist_sortascending()[source]
Ascending.
-
regionlist_sortbyregionendinfile()[source]
By Region End in File.
-
regionlist_sortbyregionlength()[source]
By Region Length.
-
regionlist_sortbyregionname()[source]
By Region Name.
-
regionlist_sortbyregionposition()[source]
By Region Position.
-
regionlist_sortbyregionstartinfile()[source]
By Region Start in File.
-
regionlist_sortbyregiontimestamp()[source]
By Region Timestamp.
-
regionlist_sortbysourcefilecreationdate()[source]
By Source File Creation Date.
-
regionlist_sortbysourcefilelength()[source]
By Source File Length.
-
regionlist_sortbysourcefilename()[source]
By Source File Name.
-
regionlist_sortbysourcefilesystem()[source]
By Source Filesystem.
-
regionlist_sortdescending()[source]
Descending.
-
remove_marker()[source]
Removes marker at the current transport position (if there is one).
-
rewind()[source]
Adds -1.5 times to transport speed to maximum -8 times normal speed.
-
rulers_toggle_bbt_ruler()[source]
Bars & Beats.
-
rulers_toggle_cd_marker_ruler()[source]
CD Markers.
-
rulers_toggle_loop_punch_ruler()[source]
Loop/Punch.
-
rulers_toggle_marker_ruler()[source]
Markers.
-
rulers_toggle_meter_ruler()[source]
Meter.
-
rulers_toggle_minsec_ruler()[source]
Min:Sec.
-
rulers_toggle_range_ruler()[source]
Ranges.
-
rulers_toggle_samples_ruler()[source]
Samples.
-
rulers_toggle_tempo_ruler()[source]
Tempo.
-
rulers_toggle_timecode_ruler()[source]
Timecode.
-
rulers_toggle_video_ruler()[source]
Video.
-
save_state()[source]
-
send(address, *args)[source]
-
sendMsg(address, *args)
-
set_transport_speed(speed)[source]
where s is a float ranging from -8.0f to 8.0f:.
-
snap_snap_to_asixteenthbeat()[source]
Snap to Sixteenths.
-
snap_snap_to_bar()[source]
Snap to Bar.
-
snap_snap_to_beat()[source]
Snap to Beat.
-
snap_snap_to_cd_frame()[source]
Snap to CD Frame.
-
snap_snap_to_eighths()[source]
Snap to Eighths.
-
snap_snap_to_fifths()[source]
Snap to Fifths.
-
snap_snap_to_fourteenths()[source]
Snap to Fourteenths.
-
snap_snap_to_halves()[source]
Snap to Halves.
-
snap_snap_to_mark()[source]
Snap to Mark.
-
snap_snap_to_minutes()[source]
Snap to Minutes.
-
snap_snap_to_onetwentyeighths()[source]
Snap to One Twenty Eighths.
-
snap_snap_to_quarters()[source]
Snap to Quarters.
-
snap_snap_to_region_boundary()[source]
Snap to Region Boundary.
-
snap_snap_to_region_end()[source]
Snap to Region End.
-
snap_snap_to_region_start()[source]
Snap to Region Start.
-
snap_snap_to_region_sync()[source]
Snap to Region Sync.
-
snap_snap_to_seconds()[source]
Snap to Seconds.
-
snap_snap_to_sevenths()[source]
Snap to Sevenths.
-
snap_snap_to_sixths()[source]
Snap to Sixths.
-
snap_snap_to_sixtyfourths()[source]
Snap to Sixty Fourths.
-
snap_snap_to_tenths()[source]
Snap to Tenths.
-
snap_snap_to_thirds()[source]
Snap to Thirds.
-
snap_snap_to_thirtyseconds()[source]
Snap to Thirty Seconds.
-
snap_snap_to_timecode_frame()[source]
Snap to Timecode Frame.
-
snap_snap_to_timecode_minutes()[source]
Snap to Timecode Minutes.
-
snap_snap_to_timecode_seconds()[source]
Snap to Timecode Seconds.
-
snap_snap_to_twelfths()[source]
Snap to Twelfths.
-
snap_snap_to_twentieths()[source]
Snap to Twentieths.
-
snap_snap_to_twentyeighths()[source]
Snap to Twenty Eighths.
-
snap_snap_to_twentyfourths()[source]
Snap to Twenty Fourths.
-
start()[source]
Move playhead to start of session.
-
stop()[source]
Stops a rolling transport.
-
stop_forget()[source]
Stop transport and delete/forget last take.
-
strip_fader(ssid, position)[source]
Where position is a float ranging from 0 to 1 representing the fader
control position.
-
strip_gain(ssid, gain)[source]
Where gain is a float ranging from -193 to 6 representing the desired
gain of the track in dB.
-
strip_list()[source]
-
strip_monitor_disk(ssid, monitor_st)[source]
where monitor_st is a bool/int where 1 is forced disk monitoring.
When input and disk are both off, Auto monitoring is enabled.
-
strip_monitor_input(ssid, monitor_st)[source]
Where monitor_st is a bool/int where 1 is forced input monitoring.
-
strip_mute(ssid, mute_st)[source]
Where mute_st is a bool/int representing the desired mute state of the
track.
-
strip_pan_stereo_position(ssid, position)[source]
Where position is a float ranging from 0 to 1 representing the desired pan position of the track.
-
strip_pan_stereo_width(ssid, width)[source]
Where width is a float ranging from 0 to 1 representing the desired pan
width of the track.
-
strip_plugin_activate(ssid, piid)[source]
Wherepiid = nth Plugin, will set the plugin’s state to active.
-
strip_plugin_descriptor(ssid)[source]
-
strip_plugin_list(ssid)[source]
-
strip_plugin_reset(ssid, piid)[source]
Where piid = nth Plugin, will reset all values to the plugin’s original values.
-
strip_polarity(ssid, invert)[source]
Where invert is a bool/int representing the desired polarity of the track.
-
strip_receives(ssid)[source]
-
strip_recenable(ssid, rec_st)[source]
Where rec_st is a bool/int representing the desired rec state of the
track.
-
strip_record_safe(ssid, rec_st)[source]
Where rec_st is a bool/int representing the desired record safe state of
the track.
-
strip_send_enable(ssid, sendid, state)[source]
-
strip_send_fader(ssid, sendid, send_gain)[source]
Where sendid = nth_send, send_gain is a float ranging from 0 to 1
representing the desired position for the send as a fader.
-
strip_send_gain(ssid, sendid, send_gain)[source]
Where sendid = nth_send, send_gain is a float ranging from -193 to +6
representing the desired gain in dB for the send.
-
strip_sends(ssid)[source]
-
strip_solo(ssid, solo_st)[source]
Where solo_st is a bool/int representing the desired solo state of the
track.
-
strip_solo_iso(ssid, solo_st)[source]
Where state is a bool/int representing the desired solo isolate state of
the track.
-
strip_solo_safe(ssid, solo_st)[source]
Where state is a bool/int representing the desired
solo safe/lock state of the track.
-
strip_trimdB(ssid, trim_db)[source]
Where trim_db is a float ranging from -20 to 20 representing the desired
trim of the track in dB.
-
toggle()[source]
Toggles between play and stop.
-
toggle_click()[source]
Toggle metronome click on and off.
-
toggle_punch_in()[source]
-
toggle_punch_out()[source]
-
toggle_roll()
Toggles between play and stop.
-
transport_alternate_gotostart()[source]
Go to Start.
-
transport_alternate_numpad_decimal()[source]
Numpad Decimal.
-
transport_alternate_record_roll()[source]
Start Recording.
-
transport_alternate_toggleroll()[source]
Start/Stop.
-
transport_focus_on_clock()[source]
Focus On Clock.
-
transport_forward()[source]
Forward.
-
transport_forwardfast()[source]
Forward (Fast).
-
transport_forwardslow()[source]
Forward (Slow).
-
transport_frame()[source]
Ardour sends /transport_frame current_frame.
-
transport_gotoend()[source]
Go to End.
-
transport_gotostart()[source]
Go to Start.
-
transport_gotowallclock()[source]
Go to Wall Clock.
-
transport_gotozero()[source]
Go to Zero.
-
transport_loop()[source]
Play Loop Range.
-
transport_numpad_0()[source]
Numpad 0.
-
transport_numpad_1()[source]
Numpad 1.
-
transport_numpad_2()[source]
Numpad 2.
-
transport_numpad_3()[source]
Numpad 3.
-
transport_numpad_4()[source]
Numpad 4.
-
transport_numpad_5()[source]
Numpad 5.
-
transport_numpad_6()[source]
Numpad 6.
-
transport_numpad_7()[source]
Numpad 7.
-
transport_numpad_8()[source]
Numpad 8.
-
transport_numpad_9()[source]
Numpad 9.
-
transport_numpad_decimal()[source]
Numpad Decimal.
-
transport_playpreroll()[source]
Play w/Preroll.
-
transport_playselection()[source]
Play Selection.
-
transport_primary_clock_bbt()[source]
Bars & Beats.
-
transport_primary_clock_minsec()[source]
Minutes & Seconds.
-
transport_primary_clock_samples()[source]
Samples.
-
transport_primary_clock_timecode()[source]
Timecode.
-
transport_record()[source]
Enable Record.
-
transport_record_roll()[source]
Start Recording.
-
transport_recordcountin()[source]
Record w/Count-In.
-
transport_recordpreroll()[source]
Record w/Preroll.
-
transport_rewind()[source]
Rewind.
-
transport_rewindfast()[source]
Rewind (Fast).
-
transport_rewindslow()[source]
Rewind (Slow).
-
transport_roll()[source]
Roll.
-
transport_secondary_clock_bbt()[source]
Bars & Beats.
-
transport_secondary_clock_minsec()[source]
Minutes & Seconds.
-
transport_secondary_clock_samples()[source]
Samples.
-
transport_secondary_clock_timecode()[source]
Timecode.
-
transport_sessionmonitordisk()[source]
All Disk.
-
transport_sessionmonitorin()[source]
All Input.
-
transport_speed(speed)[source]
Ardour sends.
-
transport_stop()[source]
Stop.
-
transport_toggleautoinput()[source]
Auto Input.
-
transport_toggleautoplay()[source]
Auto Play.
-
transport_toggleautoreturn()[source]
Auto Return.
-
transport_toggleclick()[source]
Click.
-
transport_toggleexternalsync()[source]
Use External Positional Sync Source.
-
transport_togglefollowedits()[source]
Follow Range.
-
transport_togglepunch()[source]
Punch In/Out.
-
transport_togglepunchin()[source]
Punch In.
-
transport_togglepunchout()[source]
Punch Out.
-
transport_toggleroll()[source]
Start/Stop.
-
transport_togglerollforgetcapture()[source]
Stop and Forget Capture.
-
transport_togglerollmaybe()[source]
Start/Continue/Stop.
-
transport_toggletimemaster()[source]
Time Master.
-
transport_togglevideosync()[source]
Sync Startup to Video.
-
transport_transitiontoreverse()[source]
Transition to Reverse.
-
transport_transitiontoroll()[source]
Transition to Roll.
-
transport_transport()[source]
Transport.
-
undo()[source]
-
window_toggle_about()[source]
-
window_toggle_add_routes()[source]
-
window_toggle_add_video()[source]
-
window_toggle_audio_connection_manager()[source]
-
window_toggle_audio_midi_setup()[source]
-
window_toggle_big_clock()[source]
-
window_toggle_bundle_manager()[source]
-
window_toggle_inspector()[source]
-
window_toggle_key_editor()[source]
-
window_toggle_locations()[source]
-
window_toggle_midi_connection_manager()[source]
-
window_toggle_script_manager()[source]
-
window_toggle_session_options_editor()[source]
-
window_toggle_speaker_config()[source]
-
window_toggle_video_export()[source]
-
zoom_zoom_focus_center()[source]
Zoom Focus Center.
-
zoom_zoom_focus_edit()[source]
Zoom Focus Edit Point.
-
zoom_zoom_focus_left()[source]
Zoom Focus Left.
-
zoom_zoom_focus_mouse()[source]
Zoom Focus Mouse.
-
zoom_zoom_focus_playhead()[source]
Zoom Focus Playhead.
-
zoom_zoom_focus_right()[source]
Zoom Focus Right.