commands.h File Reference

#include "defs.h"
#include "client.h"
#include "interface.h"
#include <stdarg.h>

Go to the source code of this file.

Functions
int	cmd_command (struct _application *app, const char *fmt,...)
char *	cmd_command_str (struct _application *app, const char *fmt,...)
int	cmd_command_v (struct _application *app, const char *fmt,...)
int	cmd_cs_select (struct _application *app, const char *csname)
int	cmd_cs_add (struct _application *app, const char *csname)
int	cmd_c_add (struct _application *app, const char *cname)
char *	cmd_c_selected (struct _application *app)
int	cmd_c_select (struct _application *app, const char *cname)
int	cmd_c_select_all (struct _application *app)
int	cmd_ai_add (struct _application *app, const char *iname)
int	cmd_ao_add (struct _application *app, const char *arg)
int	cmd_c_rename (struct _application *app, const char *_old, const char *_new)
int	cmd_cop_add (struct _application *app, const char *cop, const char *params)
int	cmd_c_muting (struct _application *app)
char *	cmd_engine_status (struct _application *app)
char *	cmd_ai_get_length (struct _application *app)
int	cmd_ai_index_select (struct _application *app, int index)
int	cmd_cs_is_valid (struct _application *app)
char *	cmd_cop_list (struct _application *app)
int	cmd_quit (struct _application *app, const char *arg)
int	cmd_start (struct _application *app, const char *arg)
int	cmd_stop (struct _application *app, const char *arg)
int	cmd_run (struct _application *app, const char *arg)
int	cmd_debug (struct _application *app, const char *arg)
int	cmd_resource_file (struct _application *app, const char *arg)
int	cmd_engine_launch (struct _application *app, const char *arg)
int	cmd_engine_halt (struct _application *app, const char *arg)
int	cmd_cs_remove (struct _application *app, const char *arg)
int	cmd_cs_list (struct _application *app, const char *arg)
int	cmd_cs_selected (struct _application *app, const char *arg)
int	cmd_cs_index_select (struct _application *app, const char *arg)
int	cmd_cs_load (struct _application *app, const char *arg)
int	cmd_cs_save (struct _application *app, const char *arg)
int	cmd_cs_save_as (struct _application *app, const char *arg)
int	cmd_cs_edit (struct _application *app, const char *arg)
int	cmd_cs_connect (struct _application *app, const char *arg)
int	cmd_cs_disconnect (struct _application *app, const char *arg)
int	cmd_cs_connected (struct _application *app, const char *arg)
int	cmd_cs_rewind (struct _application *app, const char *arg)
int	cmd_cs_forward (struct _application *app, const char *arg)
int	cmd_cs_set_position (struct _application *app, const char *arg)
int	cmd_cs_set_position_samples (struct _application *app, const char *arg)
int	cmd_cs_get_position (struct _application *app, const char *arg)
int	cmd_cs_get_position_samples (struct _application *app, const char *arg)
int	cmd_cs_get_length (struct _application *app, const char *arg)
int	cmd_cs_get_length_samples (struct _application *app, const char *arg)
int	cmd_cs_set_length (struct _application *app, const char *arg)
int	cmd_cs_set_length_samples (struct _application *app, const char *arg)
int	cmd_cs_toggle_loop (struct _application *app, const char *arg)
int	cmd_cs_set_param (struct _application *app, const char *arg)
int	cmd_cs_set_audio_format (struct _application *app, const char *arg)
int	cmd_cs_status (struct _application *app, const char *arg)
int	cmd_cs_option (struct _application *app, const char *arg)
int	cmd_c_list (struct _application *app, const char *arg)
int	cmd_c_index_select (struct _application *app, const char *arg)
int	cmd_c_select_add (struct _application *app, const char *arg)
int	cmd_c_deselect (struct _application *app, const char *arg)
int	cmd_c_clear (struct _application *app, const char *arg)
int	cmd_c_bypass (struct _application *app, const char *arg)
int	cmd_c_status (struct _application *app, const char *arg)
int	cmd_ao_add_default (struct _application *app, const char *arg)
int	cmd_ai_describe (struct _application *app, const char *arg)
int	cmd_ai_select (struct _application *app, const char *arg)
int	cmd_ai_selected (struct _application *app, const char *arg)
int	cmd_ai_attach (struct _application *app, const char *arg)
int	cmd_ai_remove (struct _application *app, const char *arg)
int	cmd_ai_forward (struct _application *app, const char *arg)
int	cmd_ai_rewind (struct _application *app, const char *arg)
int	cmd_ai_setpos (struct _application *app, const char *arg)
int	cmd_ai_set_position_samples (struct _application *app, const char *arg)
int	cmd_ai_getpos (struct _application *app, const char *arg)
int	cmd_ai_get_position_samples (struct _application *app, const char *arg)
int	cmd_ai_get_length_samples (struct _application *app, const char *arg)
int	cmd_ai_get_format (struct _application *app, const char *arg)
int	cmd_ai_list (struct _application *app, const char *arg)
int	cmd_aio_register (struct _application *app, const char *arg)
int	cmd_aio_status (struct _application *app, const char *arg)
int	cmd_cop_describe (struct _application *app, const char *arg)
int	cmd_cop_remove (struct _application *app, const char *arg)
int	cmd_cop_select (struct _application *app, const char *arg)
int	cmd_cop_selected (struct _application *app, const char *arg)
int	cmd_cop_set (struct _application *app, const char *arg)
int	cmd_cop_status (struct _application *app, const char *arg)
int	cmd_copp_list (struct _application *app, const char *arg)
int	cmd_copp_select (struct _application *app, const char *arg)
int	cmd_copp_selected (struct _application *app, const char *arg)
int	cmd_copp_set (struct _application *app, const char *arg)
int	cmd_copp_get (struct _application *app, const char *arg)
int	cmd_cop_register (struct _application *app, const char *arg)
int	cmd_preset_register (struct _application *app, const char *arg)
int	cmd_ladspa_register (struct _application *app, const char *arg)
int	cmd_ctrl_add (struct _application *app, const char *arg)
int	cmd_ctrl_describe (struct _application *app, const char *arg)
int	cmd_ctrl_remove (struct _application *app, const char *arg)
int	cmd_ctrl_list (struct _application *app, const char *arg)
int	cmd_ctrl_select (struct _application *app, const char *arg)
int	cmd_ctrl_selected (struct _application *app, const char *arg)
int	cmd_ctrl_status (struct _application *app, const char *arg)
int	cmd_ctrl_register (struct _application *app, const char *arg)
int	cmd_ctrl_get_target (struct _application *app, const char *arg)
int	cmd_ctrlp_list (struct _application *app, const char *arg)
int	cmd_ctrlp_select (struct _application *app, const char *arg)
int	cmd_ctrlp_selected (struct _application *app, const char *arg)
int	cmd_ctrlp_get (struct _application *app, const char *arg)
int	cmd_ctrlp_set (struct _application *app, const char *arg)
int	cmd_jack_connect (struct _application *app, const char *arg)
int	cmd_jack_disconnect (struct _application *app, const char *arg)
int	cmd_jack_list_connections (struct _application *app, const char *arg)
int	cmd_int_cmd_list (struct _application *app, const char *arg)
int	cmd_int_log_history (struct _application *app, const char *arg)
int	cmd_int_output_mode_wellformed (struct _application *app, const char *arg)
int	cmd_int_set_float_to_string_precision (struct _application *app, const char *arg)
int	cmd_int_set_log_history_length (struct _application *app, const char *arg)
int	cmd_int_cmd_version_string (struct _application *app, const char *arg)
int	cmd_int_cmd_version_lib_current (struct _application *app, const char *arg)
int	cmd_int_cmd_version_lib_revision (struct _application *app, const char *arg)
int	cmd_int_cmd_version_lib_age (struct _application *app, const char *arg)
int	cmd_map_cop_list (struct _application *app, const char *arg)
int	cmd_map_preset_list (struct _application *app, const char *arg)
int	cmd_map_ladspa_list (struct _application *app, const char *arg)
int	cmd_map_ladspa_id_list (struct _application *app, const char *arg)
int	cmd_map_ctrl_list (struct _application *app, const char *arg)
int	cmd_dump_target (struct _application *app, const char *arg)
int	cmd_dump_status (struct _application *app, const char *arg)
int	cmd_dump_position (struct _application *app, const char *arg)
int	cmd_dump_length (struct _application *app, const char *arg)
int	cmd_dump_cs_status (struct _application *app, const char *arg)
int	cmd_dump_c_selected (struct _application *app, const char *arg)
int	cmd_dump_ai_selected (struct _application *app, const char *arg)
int	cmd_dump_ai_position (struct _application *app, const char *arg)
int	cmd_dump_ai_length (struct _application *app, const char *arg)
int	cmd_dump_ai_open_state (struct _application *app, const char *arg)
int	cmd_dump_ao_selected (struct _application *app, const char *arg)
int	cmd_dump_ao_position (struct _application *app, const char *arg)
int	cmd_dump_ao_length (struct _application *app, const char *arg)
int	cmd_dump_ao_open_state (struct _application *app, const char *arg)
int	cmd_dump_cop_value (struct _application *app, const char *arg)
int	cmd_ea_add (struct _application *app)
int	cmd_chcopy_add (struct _application *app)
int	cmd_epp_add (struct _application *app)

---

Function Documentation

int cmd_ai_add	(	struct _application *	app,
		const char *	iname
	)

Adds the audio input iname to the current selected chain

int cmd_ai_attach	(	struct _application *	app,
		const char *	arg
	)

int cmd_ai_describe	(	struct _application *	app,
		const char *	arg
	)

int cmd_ai_forward	(	struct _application *	app,
		const char *	arg
	)

int cmd_ai_get_format	(	struct _application *	app,
		const char *	arg
	)

char* cmd_ai_get_length

(

struct _application *

app

)

get the length in secs of the current selected audio input

int cmd_ai_get_length_samples	(	struct _application *	app,
		const char *	arg
	)

int cmd_ai_get_position_samples	(	struct _application *	app,
		const char *	arg
	)

int cmd_ai_getpos	(	struct _application *	app,
		const char *	arg
	)

int cmd_ai_index_select	(	struct _application *	app,
		int	index
	)

Selects an audio input by index (beginning from 1)

int cmd_ai_list	(	struct _application *	app,
		const char *	arg
	)

int cmd_ai_remove	(	struct _application *	app,
		const char *	arg
	)

int cmd_ai_rewind	(	struct _application *	app,
		const char *	arg
	)

int cmd_ai_select	(	struct _application *	app,
		const char *	arg
	)

int cmd_ai_selected	(	struct _application *	app,
		const char *	arg
	)

int cmd_ai_set_position_samples	(	struct _application *	app,
		const char *	arg
	)

int cmd_ai_setpos	(	struct _application *	app,
		const char *	arg
	)

int cmd_aio_register	(	struct _application *	app,
		const char *	arg
	)

int cmd_aio_status	(	struct _application *	app,
		const char *	arg
	)

int cmd_ao_add	(	struct _application *	app,
		const char *	arg
	)

Adds the audio output to the current selected chain

int cmd_ao_add_default	(	struct _application *	app,
		const char *	arg
	)

int cmd_c_add	(	struct _application *	app,
		const char *	cname
	)

Add a new chain to the current selected chainset. Note, that in nchains, by convention, there will only be a single chain set per session.

int cmd_c_bypass	(	struct _application *	app,
		const char *	arg
	)

int cmd_c_clear	(	struct _application *	app,
		const char *	arg
	)

int cmd_c_deselect	(	struct _application *	app,
		const char *	arg
	)

int cmd_c_index_select	(	struct _application *	app,
		const char *	arg
	)

int cmd_c_list	(	struct _application *	app,
		const char *	arg
	)

int cmd_c_muting

(

struct _application *

app

)

Changes the current selected chain's muting state

int cmd_c_rename	(	struct _application *	app,
		const char *	_old,
		const char *	_new
	)

Selects old chain, renames it to new chain and selects new chain

Parameters:

	old	the old chain name
	new	the new chain name

int cmd_c_select	(	struct _application *	app,
		const char *	cname
	)

Selects chain named cname

Returns:

If the server request failes -1 is returned and an error message is i printed to the status window. Otherwise a value greater than or equal to 0 is returned.

int cmd_c_select_add	(	struct _application *	app,
		const char *	arg
	)

int cmd_c_select_all

(

struct _application *

app

)

Selects all chains. Previously selected chains become unselected

char* cmd_c_selected

(

struct _application *

app

)

Requests the current selected chain

Returns:

The name of the current selected chain or NULL

int cmd_c_status	(	struct _application *	app,
		const char *	arg
	)

int cmd_chcopy_add

(

struct _application *

app

)

Adds chcopy cop to the current selected chain using the values chcopy:1,2

int cmd_command	(	struct _application *	app,
		const char *	fmt,
			...
	)

char* cmd_command_str	(	struct _application *	app,
		const char *	fmt,
			...
	)

int cmd_command_v	(	struct _application *	app,
		const char *	fmt,
			...
	)

int cmd_cop_add	(	struct _application *	app,
		const char *	cop,
		const char *	params
	)

Adds Chain operator (cop) cop to the selected chain using cop-parameter list params

int cmd_cop_describe	(	struct _application *	app,
		const char *	arg
	)

char* cmd_cop_list

(

struct _application *

app

)

Returns the result string of the ecasound-iam command cop-list

int cmd_cop_register	(	struct _application *	app,
		const char *	arg
	)

int cmd_cop_remove	(	struct _application *	app,
		const char *	arg
	)

int cmd_cop_select	(	struct _application *	app,
		const char *	arg
	)

int cmd_cop_selected	(	struct _application *	app,
		const char *	arg
	)

int cmd_cop_set	(	struct _application *	app,
		const char *	arg
	)

int cmd_cop_status	(	struct _application *	app,
		const char *	arg
	)

int cmd_copp_get	(	struct _application *	app,
		const char *	arg
	)

int cmd_copp_list	(	struct _application *	app,
		const char *	arg
	)

int cmd_copp_select	(	struct _application *	app,
		const char *	arg
	)

int cmd_copp_selected	(	struct _application *	app,
		const char *	arg
	)

int cmd_copp_set	(	struct _application *	app,
		const char *	arg
	)

int cmd_cs_add	(	struct _application *	app,
		const char *	csname
	)

Add a new chain set of name csname

int cmd_cs_connect	(	struct _application *	app,
		const char *	arg
	)

int cmd_cs_connected	(	struct _application *	app,
		const char *	arg
	)

int cmd_cs_disconnect	(	struct _application *	app,
		const char *	arg
	)

int cmd_cs_edit	(	struct _application *	app,
		const char *	arg
	)

int cmd_cs_forward	(	struct _application *	app,
		const char *	arg
	)

int cmd_cs_get_length	(	struct _application *	app,
		const char *	arg
	)

int cmd_cs_get_length_samples	(	struct _application *	app,
		const char *	arg
	)

int cmd_cs_get_position	(	struct _application *	app,
		const char *	arg
	)

int cmd_cs_get_position_samples	(	struct _application *	app,
		const char *	arg
	)

int cmd_cs_index_select	(	struct _application *	app,
		const char *	arg
	)

int cmd_cs_is_valid

(

struct _application *

app

)

Returns 1 if the chain setup is valid for being connected or 0 if not

int cmd_cs_list	(	struct _application *	app,
		const char *	arg
	)

int cmd_cs_load	(	struct _application *	app,
		const char *	arg
	)

int cmd_cs_option	(	struct _application *	app,
		const char *	arg
	)

int cmd_cs_remove	(	struct _application *	app,
		const char *	arg
	)

int cmd_cs_rewind	(	struct _application *	app,
		const char *	arg
	)

int cmd_cs_save	(	struct _application *	app,
		const char *	arg
	)

int cmd_cs_save_as	(	struct _application *	app,
		const char *	arg
	)

int cmd_cs_select	(	struct _application *	app,
		const char *	csname
	)

Selects chain setup csname

int cmd_cs_selected	(	struct _application *	app,
		const char *	arg
	)

int cmd_cs_set_audio_format	(	struct _application *	app,
		const char *	arg
	)

int cmd_cs_set_length	(	struct _application *	app,
		const char *	arg
	)

int cmd_cs_set_length_samples	(	struct _application *	app,
		const char *	arg
	)

int cmd_cs_set_param	(	struct _application *	app,
		const char *	arg
	)

int cmd_cs_set_position	(	struct _application *	app,
		const char *	arg
	)

int cmd_cs_set_position_samples	(	struct _application *	app,
		const char *	arg
	)

int cmd_cs_status	(	struct _application *	app,
		const char *	arg
	)

int cmd_cs_toggle_loop	(	struct _application *	app,
		const char *	arg
	)

int cmd_ctrl_add	(	struct _application *	app,
		const char *	arg
	)

int cmd_ctrl_describe	(	struct _application *	app,
		const char *	arg
	)

int cmd_ctrl_get_target	(	struct _application *	app,
		const char *	arg
	)

int cmd_ctrl_list	(	struct _application *	app,
		const char *	arg
	)

int cmd_ctrl_register	(	struct _application *	app,
		const char *	arg
	)

int cmd_ctrl_remove	(	struct _application *	app,
		const char *	arg
	)

int cmd_ctrl_select	(	struct _application *	app,
		const char *	arg
	)

int cmd_ctrl_selected	(	struct _application *	app,
		const char *	arg
	)

int cmd_ctrl_status	(	struct _application *	app,
		const char *	arg
	)

int cmd_ctrlp_get	(	struct _application *	app,
		const char *	arg
	)

int cmd_ctrlp_list	(	struct _application *	app,
		const char *	arg
	)

int cmd_ctrlp_select	(	struct _application *	app,
		const char *	arg
	)

int cmd_ctrlp_selected	(	struct _application *	app,
		const char *	arg
	)

int cmd_ctrlp_set	(	struct _application *	app,
		const char *	arg
	)

int cmd_debug	(	struct _application *	app,
		const char *	arg
	)

int cmd_dump_ai_length	(	struct _application *	app,
		const char *	arg
	)

int cmd_dump_ai_open_state	(	struct _application *	app,
		const char *	arg
	)

int cmd_dump_ai_position	(	struct _application *	app,
		const char *	arg
	)

int cmd_dump_ai_selected	(	struct _application *	app,
		const char *	arg
	)

int cmd_dump_ao_length	(	struct _application *	app,
		const char *	arg
	)

int cmd_dump_ao_open_state	(	struct _application *	app,
		const char *	arg
	)

int cmd_dump_ao_position	(	struct _application *	app,
		const char *	arg
	)

int cmd_dump_ao_selected	(	struct _application *	app,
		const char *	arg
	)

int cmd_dump_c_selected	(	struct _application *	app,
		const char *	arg
	)

int cmd_dump_cop_value	(	struct _application *	app,
		const char *	arg
	)

int cmd_dump_cs_status	(	struct _application *	app,
		const char *	arg
	)

int cmd_dump_length	(	struct _application *	app,
		const char *	arg
	)

int cmd_dump_position	(	struct _application *	app,
		const char *	arg
	)

int cmd_dump_status	(	struct _application *	app,
		const char *	arg
	)

int cmd_dump_target	(	struct _application *	app,
		const char *	arg
	)

int cmd_ea_add

(

struct _application *

app

)

cop ea, defaults to 100

int cmd_engine_halt	(	struct _application *	app,
		const char *	arg
	)

int cmd_engine_launch	(	struct _application *	app,
		const char *	arg
	)

char* cmd_engine_status

(

struct _application *

app

)

Get the current engine status

int cmd_epp_add

(

struct _application *

app

)

Adds panning cop to the current selected chain using the value epp:50

int cmd_int_cmd_list	(	struct _application *	app,
		const char *	arg
	)

int cmd_int_cmd_version_lib_age	(	struct _application *	app,
		const char *	arg
	)

int cmd_int_cmd_version_lib_current	(	struct _application *	app,
		const char *	arg
	)

int cmd_int_cmd_version_lib_revision	(	struct _application *	app,
		const char *	arg
	)

int cmd_int_cmd_version_string	(	struct _application *	app,
		const char *	arg
	)

int cmd_int_log_history	(	struct _application *	app,
		const char *	arg
	)

int cmd_int_output_mode_wellformed	(	struct _application *	app,
		const char *	arg
	)

int cmd_int_set_float_to_string_precision	(	struct _application *	app,
		const char *	arg
	)

int cmd_int_set_log_history_length	(	struct _application *	app,
		const char *	arg
	)

int cmd_jack_connect	(	struct _application *	app,
		const char *	arg
	)

int cmd_jack_disconnect	(	struct _application *	app,
		const char *	arg
	)

int cmd_jack_list_connections	(	struct _application *	app,
		const char *	arg
	)

int cmd_ladspa_register	(	struct _application *	app,
		const char *	arg
	)

int cmd_map_cop_list	(	struct _application *	app,
		const char *	arg
	)

int cmd_map_ctrl_list	(	struct _application *	app,
		const char *	arg
	)

int cmd_map_ladspa_id_list	(	struct _application *	app,
		const char *	arg
	)

int cmd_map_ladspa_list	(	struct _application *	app,
		const char *	arg
	)

int cmd_map_preset_list	(	struct _application *	app,
		const char *	arg
	)

int cmd_preset_register	(	struct _application *	app,
		const char *	arg
	)

int cmd_quit	(	struct _application *	app,
		const char *	arg
	)

int cmd_resource_file	(	struct _application *	app,
		const char *	arg
	)

int cmd_run	(	struct _application *	app,
		const char *	arg
	)

int cmd_start	(	struct _application *	app,
		const char *	arg
	)

int cmd_stop	(	struct _application *	app,
		const char *	arg
	)