Command Shell

Interactive shell to control and configure a synthesizer instance. More...

Lifecycle Functions for Command Shell_linebr@{
fluid_shell_t *	new_fluid_shell (fluid_settings_t *settings, fluid_cmd_handler_t *handler, fluid_istream_t in, fluid_ostream_t out, int thread)
	Create a new FluidSynth command shell. More...
void	fluid_usershell (fluid_settings_t *settings, fluid_cmd_handler_t *handler)
	A convenience function to create a shell interfacing to standard input/output console streams. More...
void	delete_fluid_shell (fluid_shell_t *shell)
	Delete a FluidSynth command shell. More...

Detailed Description

Interactive shell to control and configure a synthesizer instance.

If you need a platform independent way to get the standard input and output streams, use fluid_get_stdin() and fluid_get_stdout().

For a full list of available commands, type help in the shell.

Function Documentation

delete_fluid_shell()

void delete_fluid_shell

(

fluid_shell_t *

shell

)

Delete a FluidSynth command shell.

Parameters

shell

Command shell instance

fluid_usershell()

void fluid_usershell	(	fluid_settings_t *	settings,
		fluid_cmd_handler_t *	handler
	)

A convenience function to create a shell interfacing to standard input/output console streams.

Parameters

settings	Settings instance for the shell
handler	Command handler callback

The shell is run in the current thread, this function will only return after the quit command has been issued.

new_fluid_shell()

fluid_shell_t* new_fluid_shell	(	fluid_settings_t *	settings,
		fluid_cmd_handler_t *	handler,
		fluid_istream_t	in,
		fluid_ostream_t	out,
		int	thread
	)

Create a new FluidSynth command shell.

Parameters

settings	Setting parameters to use with the shell
handler	Command handler
in	Input stream
out	Output stream
thread	TRUE if shell should be run in a separate thread, FALSE to run it in the current thread (function blocks until "quit")

Returns

New shell instance or NULL on error