dmPMSetupAudioFilter(3dm)

NAME
     dmPMSetupAudioFilter, dmPMExecuteAudioFilter, dmPMCleanupAudioFilter -
     sets up, executes, and cleanups audio filters


SYNOPSIS
     #include <dmedia/fx_plugin_mgr.h>

     DMstatus dmPMSetupAudioFilter
           ( DMeffect* effect,
             unsigned char *src,
             DMparams *srcParams,
             int firstByte,
             int size,
             int total )

     DMstatus dmPMExecuteAudioFilter
           ( DMeffect* effect,
             void *src,
             DMparams *srcParams,
             void *dst,
             DMparams *dstParams,
             int firstByte,
             int size,
             int total )

     DMstatus dmPMCleanupAudioFilter
           ( DMeffect* effect )


PARAMETERS
     effect      A pointer to a DMeffect, which was returned from
                 dmPMCreateEffect.

     src         A pointer to the source audio samples.

     srcParams   The source parameter/value list, a pointer to DMparams, can
                 be created with dmParamsCreate.

     firstByte   The first sample byte offset.

     size        The size of src in bytes.

     total       The total byte size of the audio clip.

     dst         A pointer to the destination audio samples.

     dstParams   The destination parameter/value list, a pointer to DMparams,
                 can be created with dmParamsCreate.
DESCRIPTION
     Audio filters may have user customizable settings in the form of a dialog
     box.  Calling dmPMSetupAudioFilter allows the audio filter plugin to post
     the dialog and query values from the user.  Because all plugins must have
     default values, calling dmPMSetupAudioFilter is optional.  Calling
     dmPMExecuteAudioFilter will cause the audio filter to be executed on your
     audio clip.  dmPMCleanupAudioFilter does not normally need to be called
     directly from your application.


RETURN VALUES
     dmPMSetupAudioFilter will return DM_SUCCESS if successful, or will return
     DM_FAILURE if it fails.  dmPMExecuteAudioFilter will return DM_SUCCESS if
     successful, or will return DM_FAILURE if it fails.
     dmPMCleanupAudioFilter will return DM_SUCCESS if successful, or will
     return DM_FAILURE if it fails.


SEE ALSO
     dmPMCreateManager(3dm), dmPMCreateEffect(3dm), dmGetError(3dm).