Skip to content

Ableton Live MIDI Remote Scripts — Unofficial Docs & Tools

Push2.timeline_navigation

`Push2.timeline_navigation`¶

Module constants¶

logger
FocusMarker

Classes¶

class `Region(namedtuple)`¶

Bases: namedtuple

`eq(self, region)`¶

`ne(self, region)`¶

`hash(self)`¶

`length(self)`¶

`inside(self, outer)`¶

`clamp_position(self, position)`¶

`clamp_to_region(self, region)`¶

class `RegionOfInterest(object)`¶

Bases: object

`init(self, start_identifier, end_identifier, getter, add_margin, *a, **k)`¶

`bound_by(self, object_identifier)`¶

`region(self)`¶

`region_with_margin(self)`¶

class `ObjectDescription(object)`¶

Bases: object

`init(self, regions, focus_name_or_getter, *a, **k)`¶

`regions(self)`¶

`focus_name(self)`¶

class `MarginType(object)`¶

Bases: object

Attributes¶

NONE
START
END

class `TimelineNavigation(EventObject)`¶

Bases: EventObject

Attributes¶

visible_region
animate_visible_region
focus_marker
show_focus
ZOOM_SENSITIVITY = 1.5
TIMELINE_WIDTH_IN_PX = 933
MARGIN_IN_PX = 121
RELATIVE_FOCUS_MARGIN
UNSNAPPING_THRESHOLD = 0.6
CHANGE_OBJECT_TIME = 0.1

`init(self, external_regions_of_interest_creator, external_focusable_object_descriptions, *a, **k)`¶

`disconnect(self)`¶

`get_object_identifier(self, obj)`¶

`get_zoom_object(self)`¶

`get_min_visible_length(self)`¶

`timeline_region(self)`¶

`timeline_region(self, region)`¶

`make_region_of_interest(self, start_identifier, end_identifier, getter, with_margin)`¶

`regions_of_interest(self)`¶

`additional_regions_of_interest(self)`¶

`get_name_for_roi(self, roi)`¶

`focusable_object_descriptions(self)`¶

`additional_focusable_object_descriptions(self)`¶

`get_object_description(self, identifier)`¶

`visible_proportion(self)`¶

`set_visible_region(self, region, source_action, force_animate)`¶

`set_visible_length(self, length)`¶

`zoom(self, value)`¶

`_get_zoom_info_for_focused_object(self)`¶

`_add_margin_to_zoomed_region(self, zoom_region, focused_region, margin_type)`¶

`_add_margin_to_zoomed_region_start(self, region, focused_position)`¶

`_add_margin_to_zoomed_region_end(self, region, focused_position)`¶

`_process_unsnapping(self, value)`¶

`_try_lock_region(self)`¶

`is_snapped(self)`¶

`focus_object(self, obj)`¶

`object_changed(self, identifier1, identifier2)`¶

`_get_roi_for_object_identifier(self, identifier)`¶

`_get_position_for_identifier(self, identifier)`¶

`_zoom_out_or_move_region(self, source_region, target_region)`¶

`_show_all_objects(self, identifiers)`¶

`_focus_object_by_identifier(self, identifier, animate)`¶

`touch_object(self, obj)`¶

`release_object(self, obj)`¶

`_remove_changed_object(self, identifier)`¶

`_remove_changed_object_delayed(self, identifier)`¶

`change_object(self, obj)`¶

`focus_region_of_interest(self, roi_identifier, focused_object)`¶

`try_hide_focus(self)`¶

`try_hide_focus_delayed(self)`¶

`_should_hide_focus(self)`¶

`reset_focus_and_animation(self)`¶

`copy_state(self, navigation)`¶

`_tasks(self, parent_task_group)`¶

`_hide_focus_task(self)`¶

`_add_margin_to_region(self, region)`¶

`_make_region_from_position_identifier(self, identifier)`¶

`_make_region_for_focused_object(self)`¶

`_get_roi_for_focused_identifier(self)`¶

`_get_unique_regions_of_interest(self)`¶

`_select_region_around_visible_region(self)`¶

`_select_reached_region(self, zoom_in)`¶

`_select_region(self, zoom_in)`¶

`_set_source_and_target_roi(self, source_roi, target_roi)`¶

`_report_current_source_and_target_roi(self)`¶

class `WaveformNavigation(EventObject)`¶

Bases: EventObject

Attributes¶

visible_region_in_samples
MIN_VISIBLE_SAMPLES = 49

`get_region_in_samples(self, region)`¶

class `SimplerWaveformNavigation(TimelineNavigation, WaveformNavigation)`¶

Bases: TimelineNavigation, WaveformNavigation

Attributes¶

selected_slice_focus = 'selected_slice'
_SimplerWaveformNavigation__on_playback_mode_changed
_SimplerWaveformNavigation__on_parameter_value_changed
_SimplerWaveformNavigation__on_selected_slice_changed
_SimplerWaveformNavigation__on_playing_position_enabled_changed
_SimplerWaveformNavigation__on_use_beat_time_changed
_SimplerWaveformNavigation__on_warp_markers_changed
_SimplerWaveformNavigation__on_before_update_all
_SimplerWaveformNavigation__on_after_update_all

`init(self, simpler, *a, **k)`¶

`set_visible_region(self, region, source_action, force_animate)`¶

`get_region_in_samples(self, region)`¶

`get_min_visible_length(self)`¶

`additional_regions_of_interest(self)`¶

`additional_focusable_object_descriptions(self)`¶

`get_object_identifier(self, obj)`¶

`get_zoom_object(self)`¶

`get_next_slice_position(self)`¶

`object_changed(self, identifier1, identifier2)`¶

`focus_object(self, obj)`¶

`__on_playback_mode_changed(self)`¶

`__on_parameter_value_changed(self, parameter)`¶

`__on_selected_slice_changed(self, _)`¶

`__on_playing_position_enabled_changed(self)`¶

`__on_use_beat_time_changed(self, use_beat_time)`¶

`__on_warp_markers_changed(self)`¶

`__on_before_update_all(self)`¶

`__on_after_update_all(self)`¶

`_update_waveform_region_and_preserve_visible_region(self)`¶

`_update_waveform_region(self)`¶

`_focus_selected_slice(self)`¶

`_focus_start_end_roi(self)`¶

`_get_selected_slice_index(self)`¶

class `ClipTimelineNavigation(TimelineNavigation)`¶

Bases: TimelineNavigation

Attributes¶

MIN_VISIBLE_BEATS = 1
zoom_focus = 'zoom'
start_marker_focus = 'start_marker'
loop_start_focus = 'loop_start'
loop_end_focus = 'loop_end'
_ClipTimelineNavigation__on_is_recording_changed
_ClipTimelineNavigation__on_before_update_all
_ClipTimelineNavigation__on_after_update_all

`init(self, clip, *a, **k)`¶

`_connect_positions_property(self, property_name, focus_object)`¶

`additional_regions_of_interest(self)`¶

`additional_focusable_object_descriptions(self)`¶

`get_object_identifier(self, obj)`¶

`get_zoom_object(self)`¶

`object_changed(self, identfier1, identifier2)`¶

`change_object(self, obj)`¶

`get_region_in_samples(self, region)`¶

`get_min_visible_length(self)`¶

`set_focus_marker_without_updating_visible_region(self, identifier)`¶

`_get_start_end_region(self)`¶

`__on_is_recording_changed(self)`¶

`__on_before_update_all(self)`¶

`__on_after_update_all(self)`¶

`_update_timeline_region(self)`¶

class `MidiClipTimelineNavigation(ClipTimelineNavigation)`¶

Bases: ClipTimelineNavigation

Attributes¶

_MidiClipTimelineNavigation__on_clip_end_changed

`init(self, clip, *a, **k)`¶

`__on_clip_end_changed(self, _)`¶

class `AudioClipTimelineNavigation(ClipTimelineNavigation, WaveformNavigation)`¶

Bases: ClipTimelineNavigation, WaveformNavigation

Attributes¶

_AudioClipTimelineNavigation__on_warp_markers_changed
_AudioClipTimelineNavigation__on_use_beat_time_changed

`init(self, *a, **k)`¶

`set_visible_region(self, region, source_action, force_animate)`¶

`__on_warp_markers_changed(self)`¶

`__on_use_beat_time_changed(self, use_beat_time)`¶

`get_min_visible_length(self)`¶

`_update_waveform_region_and_preserve_visible_region(self)`¶

Functions¶

`ease_out(t, degree)`¶

`inverse_ease_out(t, degree)`¶

`interpolate(from_value, to_value, t, ease_out_degree)`¶

`interpolate_inverse(from_value, to_value, current_value, ease_out_degree)`¶

`calc_easing_degree_for_proportion(proportion)`¶

`interpolate_region(from_region, to_region, t, ease_out_degree)`¶

`inverse_interpolate_region(from_region, to_region, current_region, ease_out_degree, prefer_end)`¶