Skip to content

Live.Application (runtime)

Live 9, Live Object Model & framework reference (descriptions and signatures).

Live Object Model, from the Live 9 API XML documentation.

Functions

combine_apcs()

Returns true if multiple APCs should be combined.

encrypt_challenge(dongle1,dongle2[,key_index=0])

Returns an encrypted challenge based on the TEA algortithm

encrypt_challenge2(arg1)

Returns the UMAC hash for the given challenge.

get_application()

Returns the application instance.

get_random_int(arg1,arg2)

Returns a random integer from the given range.

Classes

class Application

This class represents the Live application.

Properties

  • _live_ptr
  • browser - Returns an interface to the browser.
  • canonical_parent - Returns the canonical parent of the application.
  • current_dialog_button_count - Number of buttons on the current dialog.
  • current_dialog_message - Text of the last dialog that appeared; Empty if all dialogs just disappeared.
  • open_dialog_count - The number of open dialogs in Live. 0 if not dialog is open.
  • view - Returns the applications view component.

Methods

add_open_dialog_count_listener(arg1,arg2)

Add a listener function or method, which will be called as soon as the property "open_dialog_count" has changed.

get_bugfix_version(arg1)

Returns an integer representing the bugfix version of Live.

get_document(arg1)

Returns the current Live Set.

get_major_version(arg1)

Returns an integer representing the major version of Live.

get_minor_version(arg1)

Returns an integer representing the minor version of Live.

open_dialog_count_has_listener(arg1,arg2)

Returns true, if the given listener function or method is connected to the property "open_dialog_count".

press_current_dialog_button(arg1,arg2)

Press a button, by index, on the current message box.

remove_open_dialog_count_listener(arg1,arg2)

Remove a previously set listener function or method from property "open_dialog_count".

class Application.View

This class represents the view aspects of the Live application.

Properties

  • _live_ptr
  • browse_mode - Return true if HotSwap mode is active for any target.
  • canonical_parent - Get the canonical parent of the application view.

Methods

add_browse_mode_listener(arg1,arg2)

Add a listener function or method, which will be called as soon as the property "browse_mode" has changed.

add_is_view_visible_listener(arg1,arg2,arg3)

Add a listener function or method, which will be called as soon as the property "is_view_visible" has changed.

add_view_focus_changed_listener(arg1,arg2)

Add a listener function or method, which will be called as soon as the property "view_focus_changed" has changed.

available_main_views(arg1)

Return a list of strings with the available subcomponent views, which is to be specified, when using the rest of this classes functions. A 'subcomponent view' is a main view component of a document view, like the Session view, the Arranger or Detailview and so on...

browse_mode_has_listener(arg1,arg2)

Returns true, if the given listener function or method is connected to the property "browse_mode".

focus_view(arg1,arg2)

Show and focus one through the identifier string specified view.

hide_view(arg1,arg2)

Hide one through the identifier string specified view.

is_view_visible(arg1,identifier[,main_window_only=True])

Return true if the through the identifier string specified view is currently visible. If main_window_only is set to False, this will also check in second window. Notifications from the second window are not yet supported.

is_view_visible_has_listener(arg1,arg2,arg3)

Returns true, if the given listener function or method is connected to the property "is_view_visible".

remove_browse_mode_listener(arg1,arg2)

Remove a previously set listener function or method from property "browse_mode".

remove_is_view_visible_listener(arg1,arg2,arg3)

Remove a previously set listener function or method from property "is_view_visible".

remove_view_focus_changed_listener(arg1,arg2)

Remove a previously set listener function or method from property "view_focus_changed".

scroll_view(arg1,arg2,arg3,arg4)

Scroll through the identifier string specified view into the given direction, if possible. Will silently return if the specified view can not perform the requested action.

show_view(arg1,arg2)

Show one through the identifier string specified view. Will throw a runtime error if this is called in Live's initialization scope.

toggle_browse(arg1)

Reveals the device chain, the browser and starts hot swap for the selected device. Calling this function again stops hot swap.

view_focus_changed_has_listener(arg1,arg2)

Returns true, if the given listener function or method is connected to the property "view_focus_changed".

zoom_view(arg1,arg2,arg3,arg4)

Zoom through the identifier string specified view into the given direction, if possible. Will silently return if the specified view can not perform the requested action.