DeviceParameter
Represents a single automatable parameter on a device or mixer in Live. The
DeviceParameter class exposes the parameter’s current value, range,
display string, automation state, and MIDI/key mapping target.
DeviceParameter
Section titled “DeviceParameter”This class represents a (automatable) parameter within a MIDI or Audio DSP-Device. From Live’s runtime docstring.
Properties
Section titled “Properties”Inherited from LomObject
_live_ptr: int
Section titled “_live_ptr: int”canonical_parent: Device
Section titled “canonical_parent: Device”Get the canonical parent of the device parameter. From Live’s runtime docstring.
automation_state: AutomationStateProbed asinthigh confidence- sister method
AutomationState enum in same module. Property name matches the enum snake-case; raw_doc describes automation states (none / playing / overridden) which match AutomationState members.
Section titled “automation_state: AutomationStateProbed asinthigh confidencesister method AutomationState enum in same module. Property name matches the enum snake-case; raw_doc describes automation states (none / playing / overridden) which match AutomationState members.”AutomationState enum in same module. Property name matches the enum snake-case; raw_doc describes automation states (none / playing / overridden) which match AutomationState members.Returns state of type AutomationState. From Live’s runtime docstring.
default_value: float
Section titled “default_value: float”Return the default value for this parameter. A Default value is only available for non-quantized parameter types (see ‘is_quantized’). From Live’s runtime docstring.
display_value: float
Section titled “display_value: float”Get/Set the current value (as visible in the GUI) this parameter. The value must be inside the min/max properties of this device. From Live’s runtime docstring.
is_enabled: bool
Section titled “is_enabled: bool”Returns false if the parameter has been macro mapped or disabled by Max. From Live’s runtime docstring.
is_quantized: bool
Section titled “is_quantized: bool”Returns True, if this value is a boolean or integer like switch. Non quantized values are continues float values. From Live’s runtime docstring.
max: float
Section titled “max: float”Returns const access to the upper value of the allowed range for this parameter From Live’s runtime docstring.
min: float
Section titled “min: float”Returns const access to the lower value of the allowed range for this parameter From Live’s runtime docstring.
name: str
Section titled “name: str”Returns const access the name of this parameter, as visible in Lives automation choosers. From Live’s runtime docstring.
original_name: str
Section titled “original_name: str”Returns const access the original name of this parameter, unaffected of any renamings. From Live’s runtime docstring.
short_value_items: StringVector
Section titled “short_value_items: StringVector”Return the list of possible values for this parameter. Like value_items, but prefers short value names if available. Raises an error if ‘is_quantized’ is False. From Live’s runtime docstring.
state: ParameterStateProbed asinthigh confidence- sister method two enums in same module overlap on the name
state: AutomationState and ParameterState. - docstring “Returns the state of the parameter: enabled, irrelevant, …” — those are exactly
ParameterState member names (enabled / irrelevant / disabled). AutomationState’s members (none / playing / overridden) describe a different concept.
Section titled “state: ParameterStateProbed asinthigh confidencesister method two enums in same module overlap on the name state: AutomationState and ParameterState.docstring “Returns the state of the parameter: enabled, irrelevant, …” — those are exactly ParameterState member names (enabled / irrelevant / disabled). AutomationState’s members (none / playing / overridden) describe a different concept.”state: AutomationState and ParameterState.ParameterState member names (enabled / irrelevant / disabled). AutomationState’s members (none / playing / overridden) describe a different concept.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. From Live’s runtime docstring.
value: float
Section titled “value: float”Get/Set the current internal value of this parameter. The value must be inside the min/max properties of this device. From Live’s runtime docstring.
Return the list of possible values for this parameter. Raises an error if ‘is_quantized’ is False. From Live’s runtime docstring.
Methods
Section titled “Methods”begin_gesture()
Section titled “begin_gesture()”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. From Live’s runtime docstring.
end_gesture()
Section titled “end_gesture()”Notify the end of a modification of the parameter. See begin_gesture. From Live’s runtime docstring.
re_enable_automation()
Section titled “re_enable_automation()”Reenable automation for this parameter. From Live’s runtime docstring.
str_for_value()
Section titled “str_for_value()”- value: float
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. From Live’s runtime docstring.
Returned by 14 members elsewhere in the LOM
AutomationState
Section titled “AutomationState”Members
Section titled “Members”none | 0 |
playing | 1 |
overridden | 2 |
ParameterState
Section titled “ParameterState”Members
Section titled “Members”enabled | 0 |
irrelevant | 1 |
disabled | 2 |
This is an independent reference site. Not affiliated with, endorsed by, or sponsored by Ableton AG. “Ableton”, “Live”, “Push”, and related marks are trademarks of Ableton AG.