libfluidsynth  2.3.5
Command Interface

Control and configuration interface. More...

Modules

 Command Handler
 Handles text commands and reading of configuration files.
 
 Command Server
 TCP socket server for a command handler.
 
 Command Shell
 Interactive shell to control and configure a synthesizer instance.
 

Functions

fluid_istream_t fluid_get_stdin (void)
 Get standard in stream handle. More...
 
fluid_ostream_t fluid_get_stdout (void)
 Get standard output stream handle. More...
 
char * fluid_get_sysconf (char *buf, int len)
 Get the system FluidSynth command file name. More...
 
char * fluid_get_userconf (char *buf, int len)
 Get the user specific FluidSynth command file name. More...
 

Detailed Description

Control and configuration interface.

The command interface allows you to send textual commands to the synthesizer, to parse a command file, or to read commands from the stdin or other input streams (like a TCP socket).

For a full list of available commands, type help in the Command Shell or send the same command via a command handler. Further documentation can be found at https://github.com/FluidSynth/fluidsynth/wiki/UserManual#shell-commands

Function Documentation

◆ fluid_get_stdin()

fluid_istream_t fluid_get_stdin ( void  )

Get standard in stream handle.

Returns
Standard in stream.

◆ fluid_get_stdout()

fluid_ostream_t fluid_get_stdout ( void  )

Get standard output stream handle.

Returns
Standard out stream.

◆ fluid_get_sysconf()

char* fluid_get_sysconf ( char *  buf,
int  len 
)

Get the system FluidSynth command file name.

Parameters
bufCaller supplied string buffer to store file name to.
lenLength of buf
Returns
Returns buf pointer or NULL if no system command file for this system type.

MACOS does not have a system-wide config file currently. Since fluidsynth 2.2.9, the config on Windows is "%PROGRAMDATA%\fluidsynth\fluidsynth.cfg". For anything else it returns "/etc/fluidsynth.conf".

◆ fluid_get_userconf()

char* fluid_get_userconf ( char *  buf,
int  len 
)

Get the user specific FluidSynth command file name.

Parameters
bufCaller supplied string buffer to store file name to.
lenLength of buf
Returns
Returns buf pointer or NULL if no user command file for this system type.

On Windows this is currently "%USERPROFILE%\fluidsynth.cfg". For anything else (except MACOS9) "$HOME/.fluidsynth".