Skip to content
AutumnSky1010 edited this page Dec 10, 2022 · 3 revisions

Class Rest

Definition

Namespace: SoundMaker.Sounds.Score
Assembly: SoundMaker.dll

The rest.

public class Rest : BasicSoundComponentBase

Inheritance

Object -> BasicSoundComponentBase -> Rest

Implements

Constructors

Rest(LengthType, bool)

Declaration

public Rest(LengthType length, bool isDotted = false)

Parameters

Type Desctiption
LengthType Length (ex. "quarter" note)
bool Is note/rest dotted.

Methods

GenerateWave(SoundFormat, int, int, WaveTypeBase)

Declaration

public abstract ushort[] GenerateWave(SoundFormat format, int tempo, int length, WaveTypeBase waveType);

Parameters

Type Desctiption
SoundFormat The format of the sound.
int Quarter note/rest per minute.
int Length of the array.
WaveTypeBase Type of wave.

Returns

Type Desctiption
ushort[] The array of wave data.

Exceptions

Exception Desctiption
ArgumentOutOfRangeException Tempo must be non-negative and greater than 0.
ArgumentOutOfRangeException Length must be non-negative.

GenerateWave(SoundFormat, int, WaveTypeBase)

Declaration

public abstract ushort[] GenerateWave(SoundFormat format, int tempo, WaveTypeBase waveType);

Parameters

Type Desctiption
SoundFormat The format of the sound.
int Quarter note/rest per minute.
WaveTypeBase Type of wave.

Returns

Type Desctiption
ushort[] The array of wave data.

Exceptions

Exception Desctiption
ArgumentOutOfRangeException Tempo must be non-negative and greater than 0.
Clone this wiki locally