shell.h File Reference

Go to the source code of this file.

Data Structures

struct  fluid_cmd_t

Typedefs

typedef int(*) fluid_cmd_func_t (void *data, int ac, char **av, fluid_ostream_t out)
 The command structure.
typedef fluid_cmd_handler_t *(*) fluid_server_newclient_func_t (void *data, char *addr)
 TCP/IP server.

Functions

FLUIDSYNTH_API fluid_istream_t fluid_get_stdin (void)
FLUIDSYNTH_API fluid_ostream_t fluid_get_stdout (void)
FLUIDSYNTH_API char * fluid_get_userconf (char *buf, int len)
FLUIDSYNTH_API char * fluid_get_sysconf (char *buf, int len)
FLUIDSYNTH_API fluid_cmd_handler_tnew_fluid_cmd_handler (fluid_synth_t *synth)
 Create a new command handler.
FLUIDSYNTH_API void delete_fluid_cmd_handler (fluid_cmd_handler_t *handler)
FLUIDSYNTH_API void fluid_cmd_handler_set_synth (fluid_cmd_handler_t *handler, fluid_synth_t *synth)
FLUIDSYNTH_API int fluid_cmd_handler_register (fluid_cmd_handler_t *handler, fluid_cmd_t *cmd)
 Register a new command to the handler.
FLUIDSYNTH_API int fluid_cmd_handler_unregister (fluid_cmd_handler_t *handler, char *cmd)
FLUIDSYNTH_API int fluid_command (fluid_cmd_handler_t *handler, char *cmd, fluid_ostream_t out)
 Command function.
FLUIDSYNTH_API int fluid_source (fluid_cmd_handler_t *handler, char *filename)
FLUIDSYNTH_API void fluid_usershell (fluid_settings_t *settings, fluid_cmd_handler_t *handler)
FLUIDSYNTH_API fluid_shell_tnew_fluid_shell (fluid_settings_t *settings, fluid_cmd_handler_t *handler, fluid_istream_t in, fluid_ostream_t out, int thread)
 Shell.
FLUIDSYNTH_API void delete_fluid_shell (fluid_shell_t *shell)
FLUIDSYNTH_API fluid_server_tnew_fluid_server (fluid_settings_t *settings, fluid_server_newclient_func_t func, void *data)
FLUIDSYNTH_API void delete_fluid_server (fluid_server_t *server)
FLUIDSYNTH_API int fluid_server_join (fluid_server_t *server)


Typedef Documentation

typedef int(*) fluid_cmd_func_t(void *data, int ac, char **av, fluid_ostream_t out)

The command structure.

Definition at line 52 of file shell.h.

typedef fluid_cmd_handler_t*(*) fluid_server_newclient_func_t(void *data, char *addr)

TCP/IP server.

Definition at line 121 of file shell.h.


Function Documentation

FLUIDSYNTH_API void delete_fluid_cmd_handler ( fluid_cmd_handler_t handler  ) 

FLUIDSYNTH_API void delete_fluid_server ( fluid_server_t server  ) 

FLUIDSYNTH_API void delete_fluid_shell ( fluid_shell_t shell  ) 

FLUIDSYNTH_API int fluid_cmd_handler_register ( fluid_cmd_handler_t handler,
fluid_cmd_t cmd 
)

Register a new command to the handler.

The handler makes a private copy of the 'cmd' structure passed as argument.

Parameters:
handler A pointer to the command handler
cmd A pointer to the command structure
Returns:
0 if the command was inserted, non-zero if error

FLUIDSYNTH_API void fluid_cmd_handler_set_synth ( fluid_cmd_handler_t handler,
fluid_synth_t synth 
)

FLUIDSYNTH_API int fluid_cmd_handler_unregister ( fluid_cmd_handler_t handler,
char *  cmd 
)

FLUIDSYNTH_API int fluid_command ( fluid_cmd_handler_t handler,
char *  cmd,
fluid_ostream_t  out 
)

Command function.

FLUIDSYNTH_API fluid_istream_t fluid_get_stdin ( void   ) 

FLUIDSYNTH_API fluid_ostream_t fluid_get_stdout ( void   ) 

FLUIDSYNTH_API char* fluid_get_sysconf ( char *  buf,
int  len 
)

FLUIDSYNTH_API char* fluid_get_userconf ( char *  buf,
int  len 
)

FLUIDSYNTH_API int fluid_server_join ( fluid_server_t server  ) 

FLUIDSYNTH_API int fluid_source ( fluid_cmd_handler_t handler,
char *  filename 
)

FLUIDSYNTH_API void fluid_usershell ( fluid_settings_t settings,
fluid_cmd_handler_t handler 
)

FLUIDSYNTH_API fluid_cmd_handler_t* new_fluid_cmd_handler ( fluid_synth_t synth  ) 

Create a new command handler.

If the synth object passed as argument is not NULL, the handler will add all the default synthesizer commands to the command list.

Parameters:
synth The synthesizer object
Returns:
A new command handler

FLUIDSYNTH_API fluid_server_t* new_fluid_server ( fluid_settings_t settings,
fluid_server_newclient_func_t  func,
void *  data 
)

FLUIDSYNTH_API 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 
)

Shell.


Generated on Mon Jul 3 23:36:49 2006 for libfluidsynth by  doxygen 1.4.7