Class ModulationDepthRangeParameter
Modulation Depth Range (Vibrato Depth Range) registered parameter.
Inheritance
ModulationDepthRangeParameter
Assembly: Melanchall.DryWetMidi.dll
Syntax
public sealed class ModulationDepthRangeParameter : RegisteredParameter, ITimedObject, INotifyTimeChanged
Constructors
ModulationDepthRangeParameter()
Declaration
public ModulationDepthRangeParameter()
ModulationDepthRangeParameter(SevenBitNumber, Single)
Declaration
public ModulationDepthRangeParameter(SevenBitNumber halfSteps, float cents)
Parameters
Type |
Name |
Description |
SevenBitNumber |
halfSteps |
The number of half-steps to tune by. |
Single |
cents |
The number of cents to tune by. |
Exceptions
ModulationDepthRangeParameter(SevenBitNumber, Single, ParameterValueType)
Declaration
public ModulationDepthRangeParameter(SevenBitNumber halfSteps, float cents, ParameterValueType valueType)
Parameters
Type |
Name |
Description |
SevenBitNumber |
halfSteps |
The number of half-steps to tune by. |
Single |
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
Fields
DefaultCents
Represents the default number of cents to tune by.
Declaration
public static readonly float DefaultCents
Field Value
DefaultHalfSteps
Represents the default number of half-steps to tune by.
Declaration
public static readonly SevenBitNumber DefaultHalfSteps
Field Value
MaxCents
Represents the largest possible number of cents to tune by.
Declaration
public const float MaxCents = 100F
Field Value
MinCents
Represents the smallest possible number of cents to tune by.
Declaration
public const float MinCents = 0F
Field Value
Properties
Cents
Gets or sets the number of cents to tune by.
Declaration
public float Cents { get; set; }
Property Value
Exceptions
HalfSteps
Gets or sets the number of half-steps to tune by.
Declaration
public SevenBitNumber HalfSteps { get; set; }
Property Value
Methods
Clone()
Clones object by creating a copy of it.
Declaration
public override ITimedObject Clone()
Returns
Overrides
GetData(out SevenBitNumber, out Nullable<SevenBitNumber>)
Returns MSB and LSB that represent data of the current parameter.
Declaration
protected override void GetData(out SevenBitNumber msb, out SevenBitNumber? lsb)
Parameters
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 |
Int32 |
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