`Live.Licensing` (runtime)¶

Live 12 — Live Object Model & framework reference (descriptions and signatures).

Functions¶

`authorization_clock_days_ahead(...)`¶

authorization_clock_days_ahead() -> int : Advances the current date by the number of days specified by _AuthClockDaysAhead

C++ signature :
    int authorization_clock_days_ahead()

`get_authorization_page_url(...)`¶

get_authorization_page_url( (bool)reauthorize, (bool)is_trial) -> str : Retrieves the appopriate URL on ableton.com where the unser can initiate the authorization.

C++ signature :
    TString get_authorization_page_url(bool,bool)

`get_purchase_live_url(...)`¶

get_purchase_live_url() -> str : Returns the environment-aware purchase URL for purchasing Live licenses

C++ signature :
    std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>> get_purchase_live_url()

`get_services_url(...)`¶

get_services_url() -> str : Returns the URL against which service calls (e.g. for authorization) can be performed.

C++ signature :
    std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>> get_services_url()

`get_unlock_dir(...)`¶

get_unlock_dir() -> tuple : Returns a tuple containing the unlock file directory and a flag indicating if the unlock file is in the system domain.

C++ signature :
    boost::python::tuple get_unlock_dir()

`launch_web_browser(...)`¶

launch_web_browser( (str)url) -> None : Opens a web browser at the specified URL on the user's computer.

C++ signature :
    void launch_web_browser(std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>>)

Classes¶

class `ProgressDialog(instance)`¶

A modal dialog showing a message and a progress animation.

Methods¶

`init(...)`¶

Raises an exception This class cannot be instantiated from Python

`end_modal_loop(...)`¶

end_modal_loop( (ProgressDialog)arg1) -> None :

C++ signature :
    void end_modal_loop(AProgressDialog {lvalue})

`run_in_modal_loop(...)`¶

run_in_modal_loop( (ProgressDialog)arg1) -> None :

C++ signature :
    void run_in_modal_loop(AProgressDialog {lvalue})

`set_status_message(...)`¶

set_status_message( (object)arg1, (str)msg) -> None :

C++ signature :
    void set_status_message(TWeakPtr<AProgressDialog>,std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>>)

class `PythonLicensingBridge(instance)`¶

Interface to the internal licensing services.

Properties¶

base_product_id - Returns Live's current base product ID.
in_sassafras_mode
license_must_match_variant - Returns a bool indicating if we require the license information returned by the server to match the variant of Live.
random_number_for_trial_authorization - Returns the integer to send along with the Trial authorization request. This same integer will be checked for in process_trial_response (and then changed).
set_has_unsaved_changes - Returns true if the set has unsaved changes.

Methods¶

`init(...)`¶

Raises an exception This class cannot be instantiated from Python

`authorize_with_sassafras(...)`¶

authorize_with_sassafras( (PythonLicensingBridge)arg1) -> None :

C++ signature :
    void authorize_with_sassafras(APythonLicensingBridge {lvalue})

`create_new_live_set(...)`¶

create_new_live_set( (PythonLicensingBridge)arg1) -> None : Creates a new live set and discards unsaved changes.

C++ signature :
    void create_new_live_set(APythonLicensingBridge {lvalue})

`deauthenticate_user(...)`¶

deauthenticate_user( (PythonLicensingBridge)arg1) -> None : Deletes the current session ID.

C++ signature :
    void deauthenticate_user(APythonLicensingBridge {lvalue})

`get_progress_dialog(...)`¶

get_progress_dialog( (PythonLicensingBridge)arg1) -> ProgressDialog : Retrieves an instance of ProgressDialog.

C++ signature :
    TWeakPtr<AProgressDialog> get_progress_dialog(APythonLicensingBridge {lvalue})

`get_session_id(...)`¶

get_session_id( (PythonLicensingBridge)arg1) -> str : Retrieve stored session ID.

C++ signature :
    std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>> get_session_id(APythonLicensingBridge {lvalue})

`get_startup_dialog(...)`¶

get_startup_dialog( (PythonLicensingBridge)arg1, (object)authorize_callable, (object)authorize_later_callable) -> StartupDialogServes as an entry point for the user to authorize Live on first launch. : Retrieves an instance of the startup dialog with the passed callables connected to its buttons.

C++ signature :
    TWeakPtr<AStartupDialog> get_startup_dialog(APythonLicensingBridge {lvalue},boost::python::api::object,boost::python::api::object)

`get_trial_time_left(...)`¶

get_trial_time_left( (PythonLicensingBridge)arg1) -> str : Returns remaining time on a trial as a formatted string.

C++ signature :
    TString get_trial_time_left(APythonLicensingBridge {lvalue})

`invoke_pack_installation_callback(...)`¶

invoke_pack_installation_callback( (PythonLicensingBridge)arg1) -> None : Call package installation callback.

C++ signature :
    void invoke_pack_installation_callback(APythonLicensingBridge {lvalue})

`load_and_convert_legacy_unlock_cfg(...)`¶

load_and_convert_legacy_unlock_cfg( (PythonLicensingBridge)arg1) -> dict : Loads the Unlock.cfg file and returns either an empty dict or one that can be converted to an UnlockData object.

C++ signature :
    boost::python::dict load_and_convert_legacy_unlock_cfg(APythonLicensingBridge {lvalue})

`process_license_response(...)`¶

process_license_response( (PythonLicensingBridge)arg1, (list)license_response_lines) -> UnlockStatus : Processes a list of strings, each representing a server response to a product authorization.

C++ signature :
    TUnlockStatus process_license_response(APythonLicensingBridge {lvalue},boost::python::list)

`process_trial_response(...)`¶

process_trial_response( (PythonLicensingBridge)arg1, (str)trial_response_line) -> bool : Process the server's response to a Trial authorization.

C++ signature :
    bool process_trial_response(APythonLicensingBridge {lvalue},std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>>)

`request_exit(...)`¶

request_exit( (PythonLicensingBridge)arg1 [, (int)exit_code=0]) -> None :

C++ signature :
    void request_exit(APythonLicensingBridge {lvalue} [,int=0])

`save_current_set(...)`¶

save_current_set( (PythonLicensingBridge)arg1) -> None : Saves the current Live session.

C++ signature :
    void save_current_set(APythonLicensingBridge {lvalue})

`set_network_timer(...)`¶

set_network_timer( (PythonLicensingBridge)arg1, (object)callback, (int)interval_in_ms) -> None : Starts or stops a timer meant for driving network operations. Pass None as callback to stop the timer. If any callback invocation raises an exception, the timer is stopped.

C++ signature :
    void set_network_timer(APythonLicensingBridge {lvalue},boost::python::api::object,int)

`store_session_identifiers(...)`¶

store_session_identifiers( (PythonLicensingBridge)arg1, (str)session_id, (str)external_session_id) -> None : Securely stores the user's session Identifiers (aka credentials).

C++ signature :
    void store_session_identifiers(APythonLicensingBridge {lvalue},std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>>,std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>>)

class `StartupDialogServes as an entry point for the user to authorize Live on first launch.(instance)`¶

Methods¶

`init(...)`¶

Raises an exception This class cannot be instantiated from Python

`end_modal_loop(...)`¶

end_modal_loop( (StartupDialogServes as an entry point for the user to authorize Live on first launch.)arg1) -> None :

C++ signature :
    void end_modal_loop(AStartupDialog {lvalue})

`run_in_modal_loop(...)`¶

run_in_modal_loop( (StartupDialogServes as an entry point for the user to authorize Live on first launch.)arg1, (bool)show_only_offline_auth_instructions) -> None :

C++ signature :
    void run_in_modal_loop(AStartupDialog {lvalue},bool)

`set_notification_message(...)`¶

set_notification_message( (StartupDialogServes as an entry point for the user to authorize Live on first launch.)arg1, (object)notification_text, (bool)show_progress_bar) -> None :

C++ signature :
    void set_notification_message(AStartupDialog {lvalue},TString,bool)

class `TrialContext(enum)`¶

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

Methods¶

`init(self, /, *args, **kwargs)`¶

Initialize self. See help(type(self)) for accurate signature.

`as_integer_ratio(self, /)`¶

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

(10).as_integer_ratio() (10, 1) (-10).as_integer_ratio() (-10, 1) (0).as_integer_ratio() (0, 1)

`bit_count(self, /)`¶

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

bin(13) '0b1101' (13).bit_count() 3

`bit_length(self, /)`¶

Number of bits necessary to represent self in binary.

bin(37) '0b100101' (37).bit_length() 6

`conjugate(...)`¶

Returns self, the complex conjugate of any int.

`from_bytes(bytes, byteorder='big', *, signed=False)`¶

Return the integer represented by the given array of bytes.

bytes Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol. byteorder The byte order used to represent the integer. If byteorder is 'big', the most significant byte is at the beginning of the byte array. If byteorder is 'little', the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder' as the byte order value. Default is to use 'big'. signed Indicates whether two's complement is used to represent the integer.

`to_bytes(self, /, length=1, byteorder='big', *, signed=False)`¶

Return an array of bytes representing an integer.

length Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes. Default is length 1. byteorder The byte order used to represent the integer. If byteorder is 'big', the most significant byte is at the beginning of the byte array. If byteorder is 'little', the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder' as the byte order value. Default is to use 'big'. signed Determines whether two's complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

Attributes¶

FORCE_UPDATE = Licensing.TrialContext.FORCE_UPDATE
SAVE = Licensing.TrialContext.SAVE
STARTUP = Licensing.TrialContext.STARTUP
denominator = <attribute 'denominator' of 'int' objects> - the denominator of a rational number in lowest terms
imag = <attribute 'imag' of 'int' objects> - the imaginary part of a complex number
name = <member 'name' of 'Boost.Python.enum' objects>
names = {'SAVE': Licensing.TrialContext.SAVE, 'FORCE_UPDATE': Licensing.TrialContext.FORCE_UPDATE, 'STARTUP': Licensing.TrialContext.STARTUP} - dict() -> new empty dictionary
numerator = <attribute 'numerator' of 'int' objects> - the numerator of a rational number in lowest terms
real = <attribute 'real' of 'int' objects> - the real part of a complex number
values = {0: Licensing.TrialContext.SAVE, 2: Licensing.TrialContext.FORCE_UPDATE, 3: Licensing.TrialContext.STARTUP} - dict() -> new empty dictionary

class `UnlockStatus(instance)`¶

Returns relevant information after unlock

Properties¶

authorization_deactivated
authorization_expired
has_max_unlock_products
temp_demo_mode
time_limited
unlock_error
unlocked

Methods¶

`init(...)`¶

init( (object)arg1) -> None :

C++ signature :
    void __init__(_object*)

Live.Licensing (runtime)¶

Functions¶

authorization_clock_days_ahead(...)¶

get_authorization_page_url(...)¶

get_purchase_live_url(...)¶

get_services_url(...)¶

get_unlock_dir(...)¶

launch_web_browser(...)¶

Classes¶

class ProgressDialog(instance)¶

Methods¶

__init__(...)¶

end_modal_loop(...)¶

run_in_modal_loop(...)¶

set_status_message(...)¶

class PythonLicensingBridge(instance)¶

Properties¶

Methods¶

__init__(...)¶

authorize_with_sassafras(...)¶

create_new_live_set(...)¶

deauthenticate_user(...)¶

get_progress_dialog(...)¶

get_session_id(...)¶

get_startup_dialog(...)¶

get_trial_time_left(...)¶

invoke_pack_installation_callback(...)¶

load_and_convert_legacy_unlock_cfg(...)¶

process_license_response(...)¶

process_trial_response(...)¶

request_exit(...)¶

save_current_set(...)¶

set_network_timer(...)¶

store_session_identifiers(...)¶

class StartupDialogServes as an entry point for the user to authorize Live on first launch.(instance)¶

Methods¶

__init__(...)¶

end_modal_loop(...)¶

run_in_modal_loop(...)¶

set_notification_message(...)¶

class TrialContext(enum)¶

Methods¶

__init__(self, /, *args, **kwargs)¶

as_integer_ratio(self, /)¶

bit_count(self, /)¶

bit_length(self, /)¶

conjugate(...)¶

from_bytes(bytes, byteorder='big', *, signed=False)¶

to_bytes(self, /, length=1, byteorder='big', *, signed=False)¶

Attributes¶

class UnlockStatus(instance)¶

Properties¶

Methods¶

__init__(...)¶

`Live.Licensing` (runtime)¶

`authorization_clock_days_ahead(...)`¶

`get_authorization_page_url(...)`¶

`get_purchase_live_url(...)`¶

`get_services_url(...)`¶

`get_unlock_dir(...)`¶

`launch_web_browser(...)`¶

class `ProgressDialog(instance)`¶

`init(...)`¶

`end_modal_loop(...)`¶

`run_in_modal_loop(...)`¶

`set_status_message(...)`¶

class `PythonLicensingBridge(instance)`¶

`init(...)`¶

`authorize_with_sassafras(...)`¶

`create_new_live_set(...)`¶

`deauthenticate_user(...)`¶

`get_progress_dialog(...)`¶

`get_session_id(...)`¶

`get_startup_dialog(...)`¶

`get_trial_time_left(...)`¶

`invoke_pack_installation_callback(...)`¶

`load_and_convert_legacy_unlock_cfg(...)`¶

`process_license_response(...)`¶

`process_trial_response(...)`¶

`request_exit(...)`¶

`save_current_set(...)`¶

`set_network_timer(...)`¶

`store_session_identifiers(...)`¶

class `StartupDialogServes as an entry point for the user to authorize Live on first launch.(instance)`¶

`init(...)`¶

`end_modal_loop(...)`¶

`run_in_modal_loop(...)`¶

`set_notification_message(...)`¶

class `TrialContext(enum)`¶

`init(self, /, *args, **kwargs)`¶

`as_integer_ratio(self, /)`¶

`bit_count(self, /)`¶

`bit_length(self, /)`¶

`conjugate(...)`¶

`from_bytes(bytes, byteorder='big', *, signed=False)`¶

`to_bytes(self, /, length=1, byteorder='big', *, signed=False)`¶

class `UnlockStatus(instance)`¶

`init(...)`¶