Classes > SpectrumEnh class > Methods > SpectrumEnh.SettingsWaveSet method

Remarks

Sets new settings for the spectrum wave displayed on the enhanced spectrum analyzer. Current settings can be obtained through the SpectrumEnh.SettingsWaveGet method.

For further details about using the Enhanced Spectrum Analyzer refer to the SpectrumEnh section.

For details about using the Enhanced Spectrum Analyzer refer to the How to use the Enhanced Spectrum Analyzer tutorial.

For details about using other embedded Visual Feedbacks refer to the How to use the embedded Visual Feedbacks section

Syntax

[Visual Basic]

Public Function SettingsWaveSet (

nPlayerIndex as Int16,

settings as SPECTR_ENH_WAVE_SETTINGS

) as enumErrorCodes

[C#]

public enumErrorCodes SettingsWaveSet (

Int16 nPlayerIndex,

SPECTR_ENH_WAVE_SETTINGS settings

);

[C++]

public: enumErrorCodes SettingsWaveSet (

Int16 nPlayerIndex,

SPECTR_ENH_WAVE_SETTINGS settings

);

Parameter	Description

nPlayerIndex	Number representing the zero-based index of the player that will use the spectrum analyzer
settings	The new spectrum wave settings.

Return value

Value	Meaning

Negative value	An error occurred (see the LastError property for further error details)
enumErrorCodes.ERR_NOERROR (0)	The method call was successful.