Defines
#define	MODIPULATE_OK(err) (err == MODIPULATE_ERROR_NONE)
Typedefs
typedef unsigned	ModipulateErr
Functions
ModipulateErr	modipulate_global_init (void)
ModipulateErr	modipulate_global_deinit (void)
char *	modipulate_global_get_last_error_string (void)
ModipulateErr	modipulate_global_update (void)
float	modipulate_global_get_volume (void)
void	modipulate_global_set_volume (float vol)

Define Documentation

#define MODIPULATE_OK ( err ) (err == MODIPULATE_ERROR_NONE)

Error checking macro. Returns 0 for error, 1 for no error.

Typedef Documentation

typedef unsigned ModipulateErr

Error result from Modipulate.

ModipulateErr modipulate_global_deinit ( void )

De-init Modipulate.

Lets Modipulate tidy up after itself.

char* modipulate_global_get_last_error_string ( void )

Gets the most recent error string.

Use this to get more information on an error. Can be useful for logging and diagnostics.

Returns:: English string with details on the last error. Do not free this string.

float modipulate_global_get_volume ( void )

Gets the current global volume.

ModipulateErr modipulate_global_init ( void )

Initialize Modipulate.

Call this function when you're ready to start audio processing so Modipulate can get set up.

void modipulate_global_set_volume ( float vol )

Sets the current global volume.

vol the global volume from 0.0 to 1.0

ModipulateErr modipulate_global_update ( void )

Update function (must be called frequently)

Issues all pending callbacks. Call this in your update loop.