Classes > Spectrum class > Methods > Spectrum.SetNumberOfBands method

Remarks

Sets the number of bands used to display the spectrum: by default the spectrum will create 64 bands covering all of the needed frequencies; when number of bands is reduced, frequencies will be redistributed into available bands.

For further details about using the embedded Spectrum refer to the Spectrum class section.

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

Syntax

[Visual Basic]

Public Function SetNumberOfBands (

nPlayerIndex as Int16,

nBands as Int16

) as enumErrorCodes

[C#]

public enumErrorCodes SetNumberOfBands (

Int16 nPlayerIndex,

Int16 nBands

);

[C++]

public: enumErrorCodes SetNumberOfBands (

Int16 nPlayerIndex,

Int16 nBands

);

Parameter	Description

nPlayerIndex	Number representing the zero-based index of the player that will use the Spectrum
nBands	Number of bands used to display the spectrum. Its value can range from 8 to 64 (default).

Return value

Value	Meaning

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