elkpy.SushiInfoTypes

class elkpy.sushi_info_types.AudioConnection(grpc_AudioConnection=None)

Bases: object

Class to represent an audio connection info received from Sushi in a cleaner way.

Attributes:

track (TrackIdentifier): an int track_channel (int): engine_channel (int):

class elkpy.sushi_info_types.CvConnection(grpc_CvConnection=None)

Bases: object

Class to represent a CV connection in Sushi in a cleaner way

Attributes:

parameter (int): The id of the connected parameter cv_port_id (int): The id of the connected CV port

class elkpy.sushi_info_types.GateConnection(grpc_CvConnection=None)

Bases: object

Class to represent a Gate connection in Sushi in a cleaner way

Attributes:

processor (int): The id of the connected processor gate_port_id (int): The id of the connected Gate port channel (int): The connected midi channel number note_no (int): The midi note number to trigger

class elkpy.sushi_info_types.MidiCCConnection(grpc_MidiCCConnection=None)

Bases: object

Class to represent a MIDI Continious Controller connection in Sushi in a cleaner way.

Attributes:

parameter (_sushi_proto.ParameterIdentifier): channel (MidiChannel) port (int) cc_number (int) min_range (float) max_range (float) relative_mode (bool)

class elkpy.sushi_info_types.MidiKbdConnection(grpc_MidiKbdConnection=None)

Bases: object

Class to represent a MIDI keyboard connection in Sushi in a cleaner way.

Attributes:

track (_sushi_proto.TrackIdentifier): a track id channel (_sushi_proto.MidiChannel): a MIDI channel port (int): a MIDI port number raw_midi (bool): is this track a raw MIDI track or not.

class elkpy.sushi_info_types.MidiPCConnection(grpc_MidiPCConnection=None)

Bases: object

Class to represent a MIDI Program Change connection in Sushi in a cleaner way.

Attributes:

processor (_sushi_proto.ProcessorIdentifier): a processor id channel (_sushi_proto.MidiChannel): a MIDI channel port (int): a MIDI port number

class elkpy.sushi_info_types.ParameterInfo(grpc_ParameterInfo=None)

Bases: object

Class to represent the parameter info received from sushi in a clear way.

Attributes:

id (int): The id of the parameter. type (str): The type of the parameter. label (str): The label of the parameter. name (str): The name of the parameter. unit (str): The unit of the parameter. automatable (bool): If the parameter is automatable or not. min_domain_value (float): The minimum value of the parameter. max_domain_value (float): The maximum value of the parameter.

class elkpy.sushi_info_types.ParameterType(value)

Bases: IntEnum

Enum class to hold the values matching the different parameter types.

Attributes:

BOOL, INT, FLOAT, STRING_PROPERTY, DATA_PROPERTY

BOOL = 1

DATA_PROPERTY = 5

FLOAT = 3

INT = 2

STRING_PROPERTY = 4

class elkpy.sushi_info_types.PlayingMode(value)

Bases: IntEnum

Enum class to hold the values matching the different playing modes.

Attributes:

STOPPED, PLAYING, RECORDING

PLAYING = 2

RECORDING = 3

STOPPED = 1

class elkpy.sushi_info_types.PluginType(value)

Bases: IntEnum

Enum class to hold the values matching the different plugin types.

Attributes:

INTERNAL, VST2X, VST3X, LV2

INTERNAL = 1

LV2 = 4

VST2X = 2

VST3X = 3

class elkpy.sushi_info_types.ProcessorInfo(grpc_ProcessorInfo=None)

Bases: object

Class to represent the processor info received from sushi in a clear way.

Attributes:

id (int): The id of the processor. label (str): The label of the processor. name (str): The name of the processor. parameter_count (int): The number of parameters available to the processor. program_count (int): The number of programs available to the processor.

class elkpy.sushi_info_types.ProcessorState(grpc_ProcessorState=None)

Bases: object

Class to represent the processor state info received from sushi in a clear way.

Attributes:

program_id (int): The id of the current program. bypassed (bool): Whether the processor is currently bypassed or not. properties ((int, str)): All property values of the processor. parameters ((int, float)): All parameter values of the processor. binary_data (bytes): Opaque binary data saved by the plugin.

class elkpy.sushi_info_types.ProgramInfo(grpc_ProgramInfo=None)

Bases: object

Class to represent the program info received from sushi in a clear way.

Attributes:

id (int): The id of the program. name (str): The name of the program.

class elkpy.sushi_info_types.PropertyInfo(grpc_PropertyInfo=None)

Bases: object

Class to represent the property info received from sushi in a clear way.

Attributes:

id (int): The id of the property. label (str): The label of the property. name (str): The name of the property.

class elkpy.sushi_info_types.SushiBuildInfo(grpc_SushiBuildInfo=None)

Bases: object

Class to represent build info from sushi in a clear way

Attributes:

version (str): The sushi version build_options (List[str]) : A list of build options audio_buffer_size (int) : The buffer size used when building sushi commit_hash (str) : Commit hash of the build build_date (str) : The date sushi was built

class elkpy.sushi_info_types.SyncMode(value)

Bases: IntEnum

Enum class to hold the values matching the different sync modes.

Attributes:

INTERNAL, MIDI, LINK

INTERNAL = 1

LINK = 3

MIDI = 2

class elkpy.sushi_info_types.TrackInfo(grpc_TrackInfo=None)

Bases: object

Class to represent the track info received from sushi in a clear way.

Attributes:

id (int): The id of the track. label (str): The label of the track. name (str): The name of the track. channels (int): The number of input channels available to the track. buses (int): The number input buses available to the track. type (TrackType): The type of track

class elkpy.sushi_info_types.TrackType(value)

Bases: IntEnum

Enum class to hold the type of track

Attributes:

REGULAR, PRE, POST

POST = 3

PRE = 2

REGULAR = 1