ultraschall.ini settings

Ultraschall.ini settings as of Ultraschall 4.0 - (current state: 6th of July 2020)

The ultraschall.ini is stored in the resources-folder of an Ultraschall-installation.

[ultraschall_clock]
settings for the Ultraschall Clock

used by: 
    __startup.lua
    ultraschall_set_view_edit.lua
    ultraschall_set_view_record.lua
    ultraschall_set_view_setup.lua
    ultraschall_set_view_story.lua
    ultraschall_ultraclock.lua

settings:
    docked - the docked-state, the last time the clock was closed/the last 
             time the user changed dockstate IN the contextmenu
                  true, the clock was docked
                  false, the clock was undocked
    
    preset - the selected views in the clock; it is an integer bitfield
                0 - all displays off
                &1 - Show Realtime
                &2 - Show Timecode
                &4 - Show Date
                &8 - Show Remaining Projecttime
                &16 - Show Time Selection
                &32 - Show Project Length
                &64 - Show remaining time until next Marker/Region/Projectend

[ultraschall_envelope]
settings for the envelope-height-toggle

used by:
    ultraschall_toggle_envelope_height.lua

settings:
    EnvelopeMaxHeight   - the maximum envelope-height in pixels (24-291)
    EnvelopeMinHeight   - the minimum envelope-height in pixels (24-291)
    EnvelopeToggleState - the heightstate currently toggled
                              true, the height-state is maximum-height(EnvelopeMaxHeight)
                              false, the height-state is minimum-height(EnvelopeMinHeight)

[ultraschall_follow]
settings for the Ultraschall-follow-mode

used by:
    __startup.lua
    testscript.lua
    ultraschall_center_arrangeview_to_cursor.lua
    Ultraschall_Force_Playcursor_To_Center_In_Follow.lua
    ultraschall_helper_functions.lua
    ultraschall_safemode_start_stop.lua
    ultraschall_set_edit.lua
    ultraschall_set_marker.lua
    ultraschall_set_marker_with_timestamp.lua
    ultraschall_set_namedmarker.lua
    ultraschall_set_next_planned_marker.lua
    Ultraschall-Inspector.ini
    ultraschall_toggle_follow.lua
    ultraschall_zoom_out_limiter.lua
    ultraschall_zoomlimiter.lua

settings:
    state - the followmode-on/off state
                0, followmode is off
                1, followmode is on

[ultraschall_gui]
settings for the view

used by:
    __startup.lua
    ultraschall_colorpicker.lua
    ultraschall_export_assistant.lua
    ultraschall_marker_dashboard.lua
    ultraschall_prepare_for_editing.lua
    ultraschall_routing_snapshots.lua
    ultraschall_routing_snapshots_functions.lua
    ultraschall_set_view_edit.lua
    ultraschall_set_view_record.lua
    ultraschall_set_view_setup.lua
    ultraschall_set_view_story.lua
    ultraschall_settings.lua
    slideshow_test.lua
    slideshow_welcome.lua
    ultraschall_soundcheck_gui2.lua
    ultraschall_soundcheck_startgui.lua
    ultraschall_startscreen.lua
    Ultraschall-Inspector.ini
    ultraschall_timer.lua
    ultraschall_ultraclock.lua

settings:
    view              - the currently set view
                            setup, record, edit, story
    views - deprecated
    sec   - deprecated

[Ultraschall_Jump_To_ItemEdge]
settings for jumping from itemedge to itemedge

used by:
    ultraschall_jump_left_to_next_itemedge.lua
    ultraschall_jump_right_to_next_itemedge.lua
    
settings:
    PrerollTime_Left - the number of seconds to jump left of the next left item-edge
                          0, default(jumps directly to the next left itemedge)
                          negative, jump x seconds left of the previous itemedge
                          positive, jump x seconds right if the previous itemedge
                
    PrerollTime_Right  - the number of seconds to jump right of the next right item-edge
                          0, default(jumps directly to the next right itemedge)
                          negative, jump x seconds left of the next itemedge
                          positive, jump x seconds right if the next itemedge

[Ultraschall_Jump_To_Selected_ItemEdge]
settings for jumping from the first selected itemedge to the last selected itemedge in the project

used by:
    ultraschall_jump_to_end_of_last_selected_itemedge.lua
    ultraschall_jump_to_start_of_first_selected_itemedge.lua
    
settings:
    SelItem_PrerollTime_End - the number of seconds to jump left of the next selected left item-edge
                                0, default(jumps directly to the next left selected itemedge)
                                negative, jump x seconds left of the previous selected itemedge
                                positive, jump x seconds right if the previous selected itemedge
                
    SelItem_PrerollTime_Start  - the number of seconds to jump right of the next selected right item-edge
                                0, default(jumps directly to the next right selected itemedge)
                                negative, jump x seconds left of the next selected itemedge
                                positive, jump x seconds right if the next selected itemedge

[ultraschall_magicrouting]
settings for the Ultraschall Soundcheck/Autorouting

used by:
    __startup.lua
    ultraschall_interface_monitoring_off.lua
    ultraschall_interface_monitoring_on.lua
    ultraschall_set_matrix_editing.lua
    ultraschall_set_matrix_preshow.lua
    ultraschall_set_matrix_recording.lua
    ultraschall_settings.lua
    ultraschall_soundcheck_functions.lua
    ultraschall_toggle_magicrouting.lua
    
settings:
    state - the on/off-toggle-state of the Ultraschall-Magicrouting
                0, Ultraschall-Magicrouting is off
                1, Ultraschall-Magicrouting is on

[ultraschall_mouse]
settings for the mouse-selection-action

used by:
    __startup.lua
    ultraschall_toggle_mouse_selection.lua

settings:
    state - the mouse-selection-toggle-state
                0, state is toggled on
                1, state is toggled off

[ultraschall_playrate]
settings for the alternative playrate-setting

used by:
    ultraschall_toggle_playrate.lua

settings:
    AlternativeRate - the alternative playrate of the project(0.25 to 4; default is 1.5)

[ultraschall_start]
settings for the first start of ultraschall, after (re-)installation

used by:
    __startup.lua
    ultraschall_reset_firststart.lua
    ultraschall_startscreen.lua

settings:
    firststart - is this the first start of a newly/updated Ultraschall?
                        true, yes it is the first start
                        false, no it is not the first start
                        
    startscreen - shall the startscreen be shown at startup?
                        0, don't show startscreen
                        1, show startscreen

[Ultraschall_Transport]
settings for toggling SafeMode for recording on and off

used by:
    ultraschall_safemode_start_pause.lua
    ultraschall_safemode_start_stop.lua
    ultraschall_toggle_safemode_recording.lua
    ultraschall_toggle_safemode_recording_message.lua
    
settings:
    Safemode_Toggle - the toggle-state, if the safe-mode shall be applied to rec/pause, rec/stop or not
                            OFF, safe-mode is off
                            On, safe-mode is on

[ultraschall_update]
settings for checking for new updates at startup

used by:
    ultraschall_startscreen.lua
    ultraschall-plugin

settings
    update_check - the state, if Ultraschall shall check for updates
                        0, don't check for updates(checkbox unchecked)
                        1, check for updates(checkbox checked)

[ultraschall_view]
settings for quick-zoom-script(z-key)

used by:
    ultraschall_toggle_arrange_zoom.lua

settings:
    zoom_toggle_state - the current toggle state of the toggle-arrange-zoom
                            false, the zoom-level is the normal level
                            true, the zoom-level is the zoomed-in-level(zoomin_level)
    old_zoomfactor    - the old zoomfactor, before zoomed in was toggled
    zoomin_level      - the zoomed in-factor, that is set, when toggle-arrange-view was toggled
                        This setting is NOT linear, but rather some kind of exponential!
                            400.0, default
                            1000000.0, maximum zoom-in
                            0.28815693524397 - maximum zoom-out