CsoundGodot

Inherits: Object

Godot Csound

Description

Godot Csound class used to integrate Godot with Csound.

Properties

String	csound_name	`""`
MidiFileReader	midi_file
SoundFontFileReader	soundfont

Methods

void	compile_csd(csd: String)
void	compile_orchestra(orchestra: String)
float	evaluate_code(message: String)
void	event_string(message: String)
void	finish()
float	get_control_channel(channel: String)
CsoundFileReader	get_csound_script()
void	initialize()
void	note_off(chan: int, key: int)
void	note_on(chan: int, key: int, vel: int)
void	pitch_bend(chan: int, vel: int)
void	play_midi(midi_file: MidiFileReader)
void	program_select(chan: int, bank_num: int, preset_num: int)
void	send_control_channel(channel: String, value: float)
void	set_csound_script(script: CsoundFileReader)

Signals

csound_ready(csound_name: String) 🔗

Signal to notify when Godot Csound instance is ready.

Property Descriptions

String csound_name = "" 🔗

void set_csound_name(value: String)
String get_csound_name()

The name of the Csound instance.

MidiFileReader midi_file 🔗

void set_midi_file(value: MidiFileReader)
MidiFileReader get_midi_file()

The midi file resource.

SoundFontFileReader soundfont 🔗

void set_soundfont(value: SoundFontFileReader)
SoundFontFileReader get_soundfont()

The soundfont file resource.

Method Descriptions

void compile_csd(csd: String) 🔗

Method used to compile a Csound input file (.csd file) or a text string.

void compile_orchestra(orchestra: String) 🔗

Method used to parse and compile the given orchestra from a string.

float evaluate_code(message: String) 🔗

Method used to evaluate Csound message.

void event_string(message: String) 🔗

Method used to send a new event message as a string.

void finish() 🔗

Method used to finish and stop Csound processing.

float get_control_channel(channel: String) 🔗

Method used to retrieve Csound control channel value by channel name.

CsoundFileReader get_csound_script() 🔗

Method used to retrieve Godot Csound script resource.

void initialize() 🔗

Method used to initialize Godot Csound.

void note_off(chan: int, key: int) 🔗

Method used to send a note off midi event to Csound instance.

void note_on(chan: int, key: int, vel: int) 🔗

Method used to send a note on midi event to Csound instance.

void pitch_bend(chan: int, vel: int) 🔗

Not implemented yet.

void play_midi(midi_file: MidiFileReader) 🔗

Not implemented yet.

void program_select(chan: int, bank_num: int, preset_num: int) 🔗

Not implemented yet.

void send_control_channel(channel: String, value: float) 🔗

Method used to set Csound control channel value.

void set_csound_script(script: CsoundFileReader) 🔗

Method used to set Godot Csound script resource.