ILMAChorus Interface

Show in webframe

Data types:

CHORUS_ATTRIBUTES

typedef struct
{
   long lDryMix;
   long lWetMix;
   long lDelay;
   long lFeedback;
   long lStereo;
   BOOL bEnabled;
   long lDDryMix;
   long lDWetMix;
   long lDDelay;
   long lDFeedback;
   long lDStereo;
   BOOL bDEnabled;
} CHORUS_ATTRIBUTES;

Describes chorus attributes.

Member	Description
lDryMix	Controls the level of unprocessed signals. Adjust to control the pass-through volume of the unprocessed signal.
lWetMix	Controls the level of processed signals. Adjust to control the pass-through volume of the processed signal.
lDelay	Controls the level of the chorus effect. Larger values result in greater delay times.
lFeedback	Feedback of the repeated signal, by default from -100 to 100. Zero feedback will result in only a single repeat, while nonzero feedback settings will generate numerous repeats.
lStereo	Stereo represents the phase difference between the left and right channel.
bEnabled	Indicates whether the chorus effect is enabled (TRUE) or not (FALSE).
lDDryMix	Default Dry Mix value. Original default value is 70.
lDWetMix	Default Wet Mix value. Original default value is 50.
LDDelay	Default delay value. Original default value is 500.
LDFeedback	Default feedback value Original default value is 25.
lDStereo	Default stereo value Original default value is 90.
bDEnabled	Default for bEnabled value Original default value is TRUE.

Interface methods:

HRESULT GetNumChannels (int * pnChannels)

Parameters

pnChannels

valid pointer to an integer variable to be updated with the number of channels.

Description

Gets number of channels per sample of the current connected media format.

Return

S_OK if successful, S_FALSE otherwise.

HRESULT SetChorusAttributes(CHORUS_ATTRIBUTES ChorusAttributes)

Parameters

ChorusAttributes

CHORUS_ATTRIBUTES structure that contains the attributes to set.

Description

Sets the properties for the chorus effect.

Returns

S_OK if successful, S_FALSE otherwise.

HRESULT GetChorusAttributes(CHORUS_ATTRIBUTES* pChorusAttributes)

Parameters

pChorusAttributes

valid pointer to a CHORUS_ATTRIBUTES structure to be updated with the current chorus attributes.

Description

Retrieves the current chorus attributes.

Returns

S_OK if successful, S_FALSE otherwise.