Skip to content

Live.DrumChain (runtime)

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

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

Classes

class DrumChain

This class represents a drum group device chain in Live.

Properties

  • _live_ptr
  • canonical_parent - Get the canonical parent of the chain.
  • choke_group - Access to the chain's choke group setting.
  • color - Access the color index of the Chain.
  • color_index - Access the color index of the Chain.
  • devices - Return const access to all available Devices that are present in the chains
  • has_audio_input - return True, if this Chain can be feed with an Audio signal. This istrue for all Audio Chains.
  • has_audio_output - return True, if this Chain sends out an Audio signal. This istrue for all Audio Chains, and MIDI chains with an Instrument.
  • has_midi_input - return True, if this Chain can be feed with an Audio signal. This istrue for all MIDI Chains.
  • has_midi_output - return True, if this Chain sends out MIDI events. This istrue for all MIDI Chains with no Instruments.
  • is_auto_colored - Get/set access to the auto color flag of the Chain.If True, the Chain will always have the same color as the containingTrack or Chain.
  • mixer_device - Return access to the mixer device that holds the chain's mixer parameters:the Volume, Pan, and Sendamounts.
  • mute - Mute/unmute the chain.
  • muted_via_solo - Return const access to whether this chain is muted due to some other chainbeing soloed.
  • name - Read/write access to the name of the Chain, as visible in the track header.
  • out_note - Access to the MIDI note sent to the devices in the chain.
  • solo - Get/Set the solo status of the chain. Note that this will not disable thesolo state of any other Chain in the same rack. If you want exclusive solo, you have to disable the solo state of the other Chains manually.

Methods

add_choke_group_listener(arg1,arg2)

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

add_color_index_listener(arg1,arg2)

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

add_color_listener(arg1,arg2)

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

add_devices_listener(arg1,arg2)

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

add_is_auto_colored_listener(arg1,arg2)

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

add_mute_listener(arg1,arg2)

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

add_muted_via_solo_listener(arg1,arg2)

Add a listener function or method, which will be called as soon as the property "muted_via_solo" 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_out_note_listener(arg1,arg2)

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

add_solo_listener(arg1,arg2)

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

choke_group_has_listener(arg1,arg2)

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

color_has_listener(arg1,arg2)

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

color_index_has_listener(arg1,arg2)

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

delete_device(arg1,arg2)

Remove a device identified by its index from the chain. Throws runtime error if bad index.

devices_has_listener(arg1,arg2)

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

is_auto_colored_has_listener(arg1,arg2)

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

mute_has_listener(arg1,arg2)

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

muted_via_solo_has_listener(arg1,arg2)

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

name_has_listener(arg1,arg2)

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

out_note_has_listener(arg1,arg2)

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

remove_choke_group_listener(arg1,arg2)

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

remove_color_index_listener(arg1,arg2)

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

remove_color_listener(arg1,arg2)

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

remove_devices_listener(arg1,arg2)

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

remove_is_auto_colored_listener(arg1,arg2)

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

remove_mute_listener(arg1,arg2)

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

remove_muted_via_solo_listener(arg1,arg2)

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

remove_name_listener(arg1,arg2)

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

remove_out_note_listener(arg1,arg2)

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

remove_solo_listener(arg1,arg2)

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

solo_has_listener(arg1,arg2)

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