Skip to content

Live.DeviceParameter (runtime)

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

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

Classes

class AutomationState

class DeviceParameter

This class represents a (automatable) parameter within a MIDI orAudio DSP-Device.

Properties

  • _live_ptr
  • automation_state - Returns state of type AutomationState.
  • canonical_parent - Get the canonical parent of the device parameter.
  • default_value - Return the default value for this parameter. A Default value is onlyavailable for non-quantized parameter types (see 'is_quantized').
  • is_enabled - Returns false if the parameter has been macro mapped or disabled by Max.
  • is_quantized - Returns True, if this value is a boolean or integer like switch.Non quantized values are continues float values.
  • max - Returns const access to the upper value of the allowed range forthis parameter
  • min - Returns const access to the lower value of the allowed range forthis parameter
  • name - Returns const access the name of this parameter, as visible in Livesautomation choosers.
  • original_name - Returns const access the original name of this parameter, unaffected ofany renamings.
  • state - Returns the state of the parameter:- enabled - the parameter's value can be changed,- irrelevant - the parameter is enabled, but value changes will not take any effect until it gets enabled,- disabled - the parameter's value cannot be changed.
  • value - Get/Set the current value (as visible in the GUI) this parameter.The value must be inside the min/max properties of this device.
  • value_items - Return the list of possible values for this parameter. Raises an error if 'is_quantized' is False.

Methods

add_automation_state_listener(arg1,arg2)

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

add_name_listener(arg1,arg2)

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

add_state_listener(arg1,arg2)

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

add_value_listener(arg1,arg2)

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

automation_state_has_listener(arg1,arg2)

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

begin_gesture(arg1)

Notify the begin of a modification of the parameter, when a sequence of modifications have to be consider a consistent group -- for Sexample, when recording automation.

end_gesture(arg1)

Notify the end of a modification of the parameter. See begin_gesture.

name_has_listener(arg1,arg2)

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

re_enable_automation(arg1)

Reenable automation for this parameter.

remove_automation_state_listener(arg1,arg2)

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

remove_name_listener(arg1,arg2)

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

remove_state_listener(arg1,arg2)

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

remove_value_listener(arg1,arg2)

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

state_has_listener(arg1,arg2)

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

str_for_value(arg1,arg2)

Return a string representation of the given value. To be used for display purposes only. This value can include characters like 'db' or 'hz', depending on the type of the parameter.

value_has_listener(arg1,arg2)

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

class ParameterState