elkpy.AudioGraphController

class elkpy.audiographcontroller.AudioGraphController(parent, address='localhost:51051', sushi_proto_def='/usr/share/sushi/sushi_rpc.proto')

Bases: object

A class to control the audio graph in sushi via gRPC. It has functions to create, move, delete and get info about audio graph object like tracks and processors.

Attributes:

_stub (AudioGraphControllerStub): Connection stubs to the gRPC audio graph interface implemented in sushi.

create_multibus_track(name: str, buses: int) → TrackCreationEvent

Create a new multibus track in sushi.

Parameters:

name (str): The name of the new track. buses (int): The number of audio buses in the new track.

create_post_track(name: str) → None

Create a new post track in sushi.

Parameters:

name (str): The name of the new track.

create_pre_track(name: str) → None

Create a new pre track in sushi.

Parameters:

name (str): The name of the new track.

create_processor_on_track(name: str, uid: str, path: str, processor_type: PluginType, track_id: int, before_processor: int, add_to_back: bool) → ProcessorCreationEvent

Create a new processor on an existing track.

Parameters:

name (str): The name to assign the processor. Must be unique. uid (str): The uid of an internal Sushi processor. Not applicable for vst2, vst3 and lv2. path (str): The path to the processor library (for vst2 or vst3 processors) or the URI of an installed lv2 plugin. processor_type (info_type.PluginType): The type of processor to create. track_id (int): The id of the track to add the processor to. before_processor (int): Which existing processor to create the new processor in front of. add_to_back (bool): Set to true to add the processor to the back of the processing chain on the track.

create_track(name: str, channels: int) → TrackCreationEvent

Create a new track in sushi.

Parameters:

name (str): The name of the new track. channels (int): The number of channels to assign the new track.

delete_processor_from_track(processor: int, track: int) → ProcessorDeletionEvent

Delete an existing processor from a track.

Parameters:

processor (int): The id of the processor to delete. track (int): The id of the track that contains the processor.

delete_track(track_id: int) → TrackDeletionEvent

Delet a track.

Parameters:

track_id (int): The id of the track to delete.

get_all_processors() → List[ProcessorInfo]

Gets a list of all available processors.

Returns:

List[info_types.ProcessorInfo]: A list with the info of all the available processors.

get_all_tracks() → List[TrackInfo]

Gets a list of all available tracks.

Returns:

List[info_types.TrackInfo]: A list with the info of all the available tracks.

get_processor_bypass_state(processor_identifier: int) → bool

Get the bypass state of the specified processor.

Parameters:

processor_identifier (int): The id of processor to get the bypass state from.

Returns:

bool: The bypass state of the processor matching the id.

get_processor_id(processor_name: str) → int

Get the id of a processor from its name.

Parameters:

processor_name (str): The name of the processor to get the id from.

Returns:

int: The id of the processor matching the name.

get_processor_info(processor_identifier: int) → ProcessorInfo

Get the info of a processor from its id.

Parameters:

track_identifier (int): The id of the processor to get the info from.

Returns:

info_types.ProcessorInfo: The info of the processor matching the id.

get_processor_state(processor_identifier: int) → ProcessorState

Get the full state of the specified processor.

Parameters:

processor_identifier (int): The id of processor to get the full state from.

Returns:

ProcessorState: An object describing the full the processor matching the id.

get_track_id(track_name: str) → int

Get the id of a track from its name.

Parameters:

track_name (str): The name of the track.

Returns:

int: The id of the track matching the name.

get_track_info(track_identifier: int) → TrackInfo

Get the info of a track from its id.

Parameters:

track_identifier (int): The id of the track to get the info from.

Returns:

info_types.TrackInfo: The info of the track matching the id.

get_track_processors(track_identifier: int) → List[ProcessorInfo]

Get a list of processors assigned on the specified track.

Parameters:

track_identifier (int): The id of the track to get the processor list from.

Returns:

List[info_types.ProcessorInfo]: A list of the info of the processors assigned to the track matching the id.

move_processor_on_track(processor: int, source_track: int, destination_track: int, before_processor: int, add_to_back: bool) → None

Move an existing processor.

Parameters:

processor (int): The id of the processor to move. source_track (int): The id of the track to move the processor from. destination_track (int): The id of the track to move the processor to. before_processor (int): The id of another processor to move this processor in front of. add_to_back (bool): Set to true to add the processor to the back of the processing chain on the track.

set_discrete_processor_state(processor_identifier: int, program_id: int | None = None, bypassed: bool | None = False, property_values: list[tuple[int, str]] = [], parameter_values: list[tuple[int, float]] = []) → None

Set the full or partial state of the specified processor.

Parameters:

program_id (int): The id of the program to set. bypassed (bool): Whether the processor should be bypassed or not. properties ((int, str)): A list of tuples (id, value) of string properties to set. parameters ((int, float)): A list of tuples (id, value) of parameter values to set.

set_processor_bypass_state(processor_identifier: int, bypass_state: bool) → None

Set the bypass state of the specified processor.

Parameters:

processor_identifier (int): The id of the processor to set the bypass state of. bypass_sate (bool): The bypass state of the processor matching the id.

set_processor_state(processor_identifier: int, state: ProcessorState) → None

Set the full or partial state of the specified processor from an existing state object.

Parameters:

state (info_types.ProcessorState): a state object either populated manually or received from a call to get_processor_state.