Class ModulationDepthRangeParameter

Modulation Depth Range (Vibrato Depth Range) registered parameter.
Inheritance
object
Parameter
RegisteredParameter
ModulationDepthRangeParameter
Implements
Inherited Members
Namespace: Melanchall.DryWetMidi.Interaction
Assembly: Melanchall.DryWetMidi.dll
Syntax
public sealed class ModulationDepthRangeParameter : RegisteredParameter, ITimedObject, INotifyTimeChanged

Constructors

ModulationDepthRangeParameter()

Initializes a new instance of the ModulationDepthRangeParameter.
Declaration
public ModulationDepthRangeParameter()

ModulationDepthRangeParameter(SevenBitNumber, float)

Initializes a new instance of the ModulationDepthRangeParameter with the specified exact number of half-steps and cents.
Declaration
public ModulationDepthRangeParameter(SevenBitNumber halfSteps, float cents)
Parameters
Type Name Description
SevenBitNumber halfSteps The number of half-steps to tune by.
float cents The number of cents to tune by.
Exceptions
Type Condition
ArgumentOutOfRangeException cents is out of [MinCents; MaxCents] range.

ModulationDepthRangeParameter(SevenBitNumber, float, ParameterValueType)

Initializes a new instance of the ModulationDepthRangeParameter with the specified number of half-steps and cents and type of the data.
Declaration
public ModulationDepthRangeParameter(SevenBitNumber halfSteps, float cents, ParameterValueType valueType)
Parameters
Type Name Description
SevenBitNumber halfSteps The number of half-steps to tune by.
float cents the number of cents to tune by.
ParameterValueType valueType The type of parameter's data which defines whether it represents exact value, increment or decrement.
Exceptions
Type Condition
InvalidEnumArgumentException valueType specified an invalid value.
ArgumentOutOfRangeException cents is out of [MinCents; MaxCents] range.

Fields

DefaultCents

Represents the default number of cents to tune by.
Declaration
public static readonly float DefaultCents
Field Value
Type Description
float

DefaultHalfSteps

Represents the default number of half-steps to tune by.
Declaration
public static readonly SevenBitNumber DefaultHalfSteps
Field Value
Type Description
SevenBitNumber

MaxCents

Represents the largest possible number of cents to tune by.
Declaration
public const float MaxCents = 100
Field Value
Type Description
float

MinCents

Represents the smallest possible number of cents to tune by.
Declaration
public const float MinCents = 0
Field Value
Type Description
float

Properties

Cents

Gets or sets the number of cents to tune by.
Declaration
public float Cents { get; set; }
Property Value
Type Description
float
Exceptions
Type Condition
ArgumentOutOfRangeException value is out of [MinCents; MaxCents] range.

HalfSteps

Gets or sets the number of half-steps to tune by.
Declaration
public SevenBitNumber HalfSteps { get; set; }
Property Value
Type Description
SevenBitNumber

Methods

Clone()

Clones object by creating a copy of it.
Declaration
public override ITimedObject Clone()
Returns
Type Description
ITimedObject Copy of the object.
Overrides

GetData(out SevenBitNumber, out SevenBitNumber?)

Returns MSB and LSB that represent data of the current parameter.
Declaration
protected override void GetData(out SevenBitNumber msb, out SevenBitNumber? lsb)
Parameters
Type Name Description
SevenBitNumber msb MSB of parameter's data.
SevenBitNumber? lsb LSB of parameter's data.
Overrides

GetIncrementStepsCount()

Returns the number of increment/decrement steps based on the value of the current parameter.
Declaration
protected override int GetIncrementStepsCount()
Returns
Type Description
int The number of increment/decrement steps based on the value of the current parameter.
Overrides

ToString()

Returns a string that represents the current object.
Declaration
public override string ToString()
Returns
Type Description
string A string that represents the current object.
Overrides

Implements

Extension Methods