DeviceParameter (Module)

DeviceParameter (Class)

Live.DeviceParameter.DeviceParameter

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

Live Object: yes

Access via:

• ChainMixerDevice.chain_activator
• ChainMixerDevice.panning
• ChainMixerDevice.volume
• MixerDevice.crossfader
• MixerDevice.cue_volume
• MixerDevice.left_split_stereo
• MixerDevice.panning
• MixerDevice.right_split_stereo
• MixerDevice.song_tempo
• MixerDevice.track_activator
• MixerDevice.volume
• RackDevice.chain_selector

Properties

Property	Type	Supports
automation_state	int	get/listen
canonical_parent	Device	get
default_value	float	get
display_value	float	get/set/listen
is_enabled	bool	get
is_quantized	bool	get
max	float	get
min	float	get
name	str	get/listen
original_name	str	get
short_value_items	StringVector	get
state	int	get/listen
value	float	get/set/listen
value_items	StringVector	get

automation_state

• Type: int
• Settable: no
• Listenable: yes

Returns state of type AutomationState.

canonical_parent

• Type: Device
• Settable: no
• Listenable: no

Get the canonical parent of the device parameter.

default_value

• Type: float
• Settable: no
• Listenable: no

Return the default value for this parameter. A Default value is only available for non-quantized parameter types (see 'is_quantized').

display_value

• Type: float
• Settable: yes
• Listenable: yes

Get/Set the current value (as visible in the GUI) this parameter. The value must be inside the min/max properties of this device.

is_enabled

• Type: bool
• Settable: no
• Listenable: no

Returns false if the parameter has been macro mapped or disabled by Max.

is_quantized

• Type: bool
• Settable: no
• Listenable: no

Returns True, if this value is a boolean or integer like switch. Non quantized values are continues float values.

max

• Type: float
• Settable: no
• Listenable: no

Returns const access to the upper value of the allowed range for this parameter

min

• Type: float
• Settable: no
• Listenable: no

Returns const access to the lower value of the allowed range for this parameter

name

• Type: str
• Settable: no
• Listenable: yes

Returns const access the name of this parameter, as visible in Lives automation choosers.

original_name

• Type: str
• Settable: no
• Listenable: no

Returns const access the original name of this parameter, unaffected of any renamings.

short_value_items

• Type: StringVector
• Settable: no
• Listenable: no

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.

state

• Type: int
• Settable: no
• Listenable: yes

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

• Type: float
• Settable: yes
• Listenable: yes

Get/Set the current internal value of this parameter. The value must be inside the min/max properties of this device.

value_items

• Type: StringVector
• Settable: no
• Listenable: no

Return the list of possible values for this parameter. Raises an error if 'is_quantized' is False.

Methods

Method	Returns
begin_gesture()	None
end_gesture()	None
re_enable_automation()	None
str_for_value()	str

begin_gesture()

• Returns: None

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()

• Returns: None

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

re_enable_automation()

• Returns: None

Reenable automation for this parameter.

str_for_value(value: float)

• Returns: str
• Args:
• 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.

Enums

AutomationState

Live.DeviceParameter.AutomationState

Value	Name
0	none
1	playing
2	overridden

ParameterState

Live.DeviceParameter.ParameterState

Value	Name
0	enabled
1	irrelevant
2	disabled