Client API: Effect handler information. More...

#include <sox.h>

Public Attributes
char const *	name
	Effect name.

char const *	usage
	Short explanation of parameters accepted by effect.

unsigned int	flags
	Combination of SOX_EFF_* flags.

sox_effect_handler_getopts	getopts
	Called to parse command-line arguments (called once per effect).

sox_effect_handler_start	start
	Called to initialize effect (called once per flow).

sox_effect_handler_flow	flow
	Called to process samples.

sox_effect_handler_drain	drain
	Called to finish getting output after input is complete.

sox_effect_handler_stop	stop
	Called to shut down effect (called once per flow).

sox_effect_handler_kill	kill
	Called to shut down effect (called once per effect).

size_t	priv_size
	Size of private data SoX should pre-allocate for effect.

Detailed Description

Client API: Effect handler information.

The documentation for this struct was generated from the following file:

Public Attributes