From fca6ab9b23d646d9cd3c8e2ead47b983ef0e10bf Mon Sep 17 00:00:00 2001 From: Maddy Guthridge Date: Wed, 7 Aug 2024 14:40:41 +1000 Subject: [PATCH] Add proposed API for interacting with FX plugin mix levels --- .../mixer/__events.py | 37 +++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/src/midi_controller_scripting/mixer/__events.py b/src/midi_controller_scripting/mixer/__events.py index a11d8d8..84ed00b 100644 --- a/src/midi_controller_scripting/mixer/__events.py +++ b/src/midi_controller_scripting/mixer/__events.py @@ -55,6 +55,43 @@ def isTrackPluginValid(index: int, plugIndex: int) -> bool: return False +def getPluginMixLevel(index: int, plugIndex: int) -> float: + """ + Returns the mix level of a plugin on the mixer. + + ## Args + + * `index` (`int`): mixer track index. + + * `plugIndex` (`int`): slot index on the given track. + + ## Returns + + * `float`: mix level. + + Included since API Version `TODO`. + """ + return 0.0 + + +def setPluginMixLevel(index: int, plugIndex: int, value: float, pickupMode: int = 0) -> None: + """ + Sets the mix level of a plugin on the mixer. + + ## Args + + * `index` (`int`): mixer track index. + + * `plugIndex` (`int`): slot index on the given track. + + * `value` (`float`): new mix level (between 0 and 1). + + * `pickupMode` (`int`, optional): pickup mode. Defaults to `0`. + + Included since API Version `TODO`. + """ + + def getEventValue( index: int, value: int = midi.MaxInt,