Class ChannelCoarseTuningParameter

Channel Coarse Tuning registered parameter.
Inheritance
object
Parameter
RegisteredParameter
ChannelCoarseTuningParameter
Implements
Inherited Members
Namespace: Melanchall.DryWetMidi.Interaction
Assembly: Melanchall.DryWetMidi.dll
Syntax
public sealed class ChannelCoarseTuningParameter : RegisteredParameter, ITimedObject, INotifyTimeChanged

Constructors

ChannelCoarseTuningParameter()

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

ChannelCoarseTuningParameter(sbyte)

Initializes a new instance of the ChannelCoarseTuningParameter with the specified exact number of half-steps.
Declaration
public ChannelCoarseTuningParameter(sbyte halfSteps)
Parameters
Type Name Description
sbyte halfSteps The number of half-steps to tune by.
Exceptions
Type Condition
ArgumentOutOfRangeException halfSteps is out of [MinHalfSteps; MaxHalfSteps] range.

ChannelCoarseTuningParameter(sbyte, ParameterValueType)

Initializes a new instance of the ChannelCoarseTuningParameter with the specified number of half-steps and type of this number.
Declaration
public ChannelCoarseTuningParameter(sbyte halfSteps, ParameterValueType valueType)
Parameters
Type Name Description
sbyte halfSteps Number of half-steps 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 halfSteps is out of [MinHalfSteps; MaxHalfSteps] range.

Fields

MaxHalfSteps

Represents the largest possible number of half-steps to tune by.
Declaration
public const sbyte MaxHalfSteps = 63
Field Value
Type Description
sbyte

MinHalfSteps

Represents the smallest possible number of half-steps to tune by.
Declaration
public const sbyte MinHalfSteps = -64
Field Value
Type Description
sbyte

Properties

HalfSteps

Gets or sets the number of half-steps to tune by.
Declaration
public sbyte HalfSteps { get; set; }
Property Value
Type Description
sbyte
Exceptions
Type Condition
ArgumentOutOfRangeException value is out of [MinHalfSteps; MaxHalfSteps] range.

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