SOUND4 IMPACT FM.CL Library [2.0.0]
Loading...
Searching...
No Matches
Classes | Functions
Auxiliary outputs

Classes

struct  SOUND4_AuxiliaryOutputInfos
 

Functions

struct SOUND4_AuxiliaryOutputInfos ** impactfm_GetAuxiliaryAudioOutputInfos (struct impactfm_CInstance *instance)
 
void impactfm_FreeAuxiliaryAudioInfos (struct SOUND4_AuxiliaryOutputInfos **infos)
 
int impactfm_ActivateAuxiliaryAudioID (struct impactfm_CInstance *instance, const char *id)
 
unsigned int impactfm_GetAuxiliaryAudioEstimatedDelay (struct impactfm_CInstance *instance, const char *id)
 

Detailed Description

For advanced processing with multiple simultaneous outputs.

Auxiliary outputs are filled at each call to impactfm_ProcessAudio or impactfm_ProcessAudio_Planar.

You can use their buffer to retreive their output.

Function Documentation

◆ impactfm_ActivateAuxiliaryAudioID()

int impactfm_ActivateAuxiliaryAudioID ( struct impactfm_CInstance *  instance,
const char *  id 
)

Activate an auxiliary output.

This is required to activate the output generation

Parameters
instancethe processing instance
idthe auxiliary output ID to activate
Returns
0 is success

◆ impactfm_FreeAuxiliaryAudioInfos()

void impactfm_FreeAuxiliaryAudioInfos ( struct SOUND4_AuxiliaryOutputInfos **  infos)

Frees the information returned by impactfm_GetAuxiliaryAudioOutputInfos.

Parameters
infosthe infos to free

◆ impactfm_GetAuxiliaryAudioEstimatedDelay()

unsigned int impactfm_GetAuxiliaryAudioEstimatedDelay ( struct impactfm_CInstance *  instance,
const char *  id 
)

Get the delay (estimated) of current processing algorithm for a specific auxiliary output

Remarks
This is not very accurate, it does not take into account group delays.
But it is sufficient for file processing adjustements.
Changing the preset and parameters may change the returned value.
Parameters
instancethe processing instance
idthe auxiliary output ID. Use NULL or empty string for main output delay.
Returns
Estimated delay in frames, or 0 if unknown id.

◆ impactfm_GetAuxiliaryAudioOutputInfos()

struct SOUND4_AuxiliaryOutputInfos ** impactfm_GetAuxiliaryAudioOutputInfos ( struct impactfm_CInstance *  instance)

Get the list of possible auxiliary outputs.

Parameters
instancethe processing instance
Returns
a list of SOUND4_AuxiliaryOutputInfos, null terminated, of auxiliary outputs. May be null. Should be freed with impactfm_FreeAuxiliaryAudioInfos