Auxiliary outputs

Classes
struct	SOUND4_AuxiliaryOutputInfos

Functions
struct SOUND4_AuxiliaryOutputInfos **	cloudx1_GetAuxiliaryAudioOutputInfos (struct cloudx1_CInstance *instance)
void	cloudx1_FreeAuxiliaryAudioInfos (struct SOUND4_AuxiliaryOutputInfos **infos)
int	cloudx1_ActivateAuxiliaryAudioID (struct cloudx1_CInstance *instance, const char *id)
unsigned int	cloudx1_GetAuxiliaryAudioEstimatedDelay (struct cloudx1_CInstance *instance, const char *id)

Detailed Description

For advanced processing with multiple simultaneous outputs.

Auxiliary outputs are filled at each call to cloudx1_ProcessAudio or cloudx1_ProcessAudio_Planar.

You can use their buffer to retreive their output.

Function Documentation

cloudx1_ActivateAuxiliaryAudioID()

int cloudx1_ActivateAuxiliaryAudioID	(	struct cloudx1_CInstance *	instance,
		const char *	id
	)

Activate an auxiliary output.

This is required to activate the output generation

Parameters

instance	the processing instance
id	the auxiliary output ID to activate

Returns

0 is success

cloudx1_FreeAuxiliaryAudioInfos()

void cloudx1_FreeAuxiliaryAudioInfos

(

struct SOUND4_AuxiliaryOutputInfos **

infos

)

Frees the information returned by cloudx1_GetAuxiliaryAudioOutputInfos.

Parameters

infos

the infos to free

cloudx1_GetAuxiliaryAudioEstimatedDelay()

unsigned int cloudx1_GetAuxiliaryAudioEstimatedDelay	(	struct cloudx1_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

instance	the processing instance
id	the auxiliary output ID. Use NULL or empty string for main output delay.

Returns

Estimated delay in frames, or 0 if unknown id.

cloudx1_GetAuxiliaryAudioOutputInfos()

struct SOUND4_AuxiliaryOutputInfos ** cloudx1_GetAuxiliaryAudioOutputInfos

(

struct cloudx1_CInstance *

instance

)

Get the list of possible auxiliary outputs.

Parameters

instance

the processing instance

Returns

a list of SOUND4_AuxiliaryOutputInfos, null terminated, of auxiliary outputs. May be null. Should be freed with cloudx1_FreeAuxiliaryAudioInfos