CsoundServer

Inherits: Object

Csound Server

Description

Csound Server is server interface to control Csound instances.

Properties

int

csound_count

0

Methods

void	add_csound(at_position: int = -1)
void	add_csound_instrument(csound_idx: int, instrument: CsoundInstrument, at_position: int = -1)
void	csound_ready(csound_name: String)
CsoundLayout	generate_csound_layout() const
String	get_build()
CsoundGodot	get_csound(csound_name: String)
int	get_csound_channel_count(csound_idx: int) const
float	get_csound_channel_peak_volume_db(csound_idx: int, channel: int) const
int	get_csound_index(csound_name: StringName) const
CsoundInstrument	get_csound_instrument(csound_idx: int, instrument_idx: int)
int	get_csound_instrument_count(csound_idx: int)
String	get_csound_name(csound_idx: int) const
String	get_csound_name_options() const
int	get_csound_named_channel_count(csound_idx: int) const
String	get_csound_named_channel_name(csound_idx: int, channel: int) const
float	get_csound_named_channel_peak_volume_db(csound_idx: int, channel: int) const
CsoundFileReader	get_csound_script(csound_idx: int) const
int	get_csound_tab(csound_idx: int) const
float	get_csound_volume_db(csound_idx: int) const
bool	get_edited()
String	get_version()
void	initialize()
bool	is_csound_bypassing(csound_idx: int) const
bool	is_csound_channel_active(csound_idx: int, channel: int) const
bool	is_csound_mute(csound_idx: int) const
bool	is_csound_named_channel_active(csound_idx: int, channel: int) const
bool	is_csound_solo(csound_idx: int) const
void	lock()
void	move_csound(index: int, to_index: int)
void	open_web_midi_inputs()
void	remove_csound(index: int)
void	remove_csound_instrument(csound_idx: int, instrument_idx: int)
void	set_csound_bypass(csound_idx: int, enable: bool)
void	set_csound_layout(csound_layout: CsoundLayout)
void	set_csound_mute(csound_idx: int, enable: bool)
void	set_csound_name(csound_idx: int, name: String)
void	set_csound_script(csound_idx: int, script: CsoundFileReader)
void	set_csound_solo(csound_idx: int, enable: bool)
void	set_csound_tab(csound_idx: int, tab: float)
void	set_csound_volume_db(csound_idx: int, volume_db: float)
void	set_edited(edited: bool)
void	swap_csound_instruments(csound_idx: int, instrument_idx: int, by_instrument_idx: int)
void	unlock()

---

Signals

csound_layout_changed() 🔗

Signal to notify when Csound layout has changed.

---

csound_ready(csound_name: String) 🔗

Signal to notify when Godot Csound instance is ready.

---

Property Descriptions

int csound_count = 0 🔗

• void set_csound_count(value: int)

• int get_csound_count()

Number of Csound instances.

---

Method Descriptions

void add_csound(at_position: int = -1) 🔗

Method to create a new Godot Csound instance.

---

void add_csound_instrument(csound_idx: int, instrument: CsoundInstrument, at_position: int = -1) 🔗

Not implemented yet.

---

void csound_ready(csound_name: String) 🔗

Method to allow Godot Csound instance to signal when it is ready.

---

CsoundLayout generate_csound_layout() const 🔗

Method to generate a new Csound laytout.

---

String get_build() 🔗

Method to get the git sha used for this build.

---

CsoundGodot get_csound(csound_name: String) 🔗

Method used to retrieve a Godot Csound instance by csound_name.

---

int get_csound_channel_count(csound_idx: int) const 🔗

Method used to retrieve the number of channels for a Csound instance by csound_idx.

---

float get_csound_channel_peak_volume_db(csound_idx: int, channel: int) const 🔗

Method used to retrieve the peak volume of a channel for a Csound instance by csound_idx and channel.

---

int get_csound_index(csound_name: StringName) const 🔗

Method used to retrieve the index of a Csound instance by csound_name.

---

CsoundInstrument get_csound_instrument(csound_idx: int, instrument_idx: int) 🔗

Not implemented yet.

---

int get_csound_instrument_count(csound_idx: int) 🔗

Not implemented yet.

---

String get_csound_name(csound_idx: int) const 🔗

Method used to retrieve the Csound instance name by csound_idx.

---

String get_csound_name_options() const 🔗

Method used to retrieve the Csound name options. Used to allow editor Csound instance selection.

---

int get_csound_named_channel_count(csound_idx: int) const 🔗

Method used to retrieve the number of named channels for a Csound instance by csound_idx.

---

String get_csound_named_channel_name(csound_idx: int, channel: int) const 🔗

Method used to retrieve the name of a channel for a Csound instance by csound_idx and channel.

---

float get_csound_named_channel_peak_volume_db(csound_idx: int, channel: int) const 🔗

Method used to retrieve the peak volume of a channel for a Csound instance by csound_idx and channel.

---

CsoundFileReader get_csound_script(csound_idx: int) const 🔗

Method used to get the script for a Csound instance by csound_idx.

---

int get_csound_tab(csound_idx: int) const 🔗

Method used to get the active tab for a Csound instance by csound_idx.

---

float get_csound_volume_db(csound_idx: int) const 🔗

Method used to get the volume for a Csound instance by csound_idx.

---

bool get_edited() 🔗

Method used to get if a Csound instances have been edited.

---

String get_version() 🔗

Method used to retrieve the build version.

---

void initialize() 🔗

Method used to initialize Csound Server.

---

bool is_csound_bypassing(csound_idx: int) const 🔗

Method to retrieve bypass audio status of Csound instance by csound_idx.

---

bool is_csound_channel_active(csound_idx: int, channel: int) const 🔗

Method to retrieve channel active status of Csound instance by csound_idx and channel.

---

bool is_csound_mute(csound_idx: int) const 🔗

Method to retrieve mute status of Csound instance by csound_idx.

---

bool is_csound_named_channel_active(csound_idx: int, channel: int) const 🔗

Method to retrieve named channel active status of Csound instance by csound_idx and channel.

---

bool is_csound_solo(csound_idx: int) const 🔗

Method to retrieve solo status of Csound instance by csound_idx.

---

void lock() 🔗

Method used to lock the Csound Server.

---

void move_csound(index: int, to_index: int) 🔗

Method used to move Csound instance from index to to_index.

---

void open_web_midi_inputs() 🔗

Method used to open web midi inputs.

---

void remove_csound(index: int) 🔗

Method to remove Csound instance from index position.

---

void remove_csound_instrument(csound_idx: int, instrument_idx: int) 🔗

Not implemented yet.

---

void set_csound_bypass(csound_idx: int, enable: bool) 🔗

Method to set enable audio status of Csound instance by csound_idx.

---

void set_csound_layout(csound_layout: CsoundLayout) 🔗

Method to set the current active layout.

---

void set_csound_mute(csound_idx: int, enable: bool) 🔗

Method to set enable mute status of Csound instance by csound_idx.

---

void set_csound_name(csound_idx: int, name: String) 🔗

Method used to set the Csound instance name by csound_idx.

---

void set_csound_script(csound_idx: int, script: CsoundFileReader) 🔗

Method used to set the script for a Csound instance by csound_idx.

---

void set_csound_solo(csound_idx: int, enable: bool) 🔗

Method to set enable solo status of Csound instance by csound_idx.

---

void set_csound_tab(csound_idx: int, tab: float) 🔗

Method used to set the active tab for a Csound instance by csound_idx.

---

void set_csound_volume_db(csound_idx: int, volume_db: float) 🔗

Method used to set the volume_db of a channel for a Csound instance by csound_idx.

---

void set_edited(edited: bool) 🔗

Method used to set edited status of Csound instances.

---

void swap_csound_instruments(csound_idx: int, instrument_idx: int, by_instrument_idx: int) 🔗

Not implemented yet.

---

void unlock() 🔗

Method used to unlock the Csound Server.