Interface ILoopModuleHandle
This module repeats a fragment of the incoming sound a specified number of times.
public interface ILoopModuleHandle : ITypedModuleHandle, IGenericSynthModuleHandle
- Inherited Members
Methods
GetChannels()
Original name: 2 'Channels'
ChannelsInverted GetChannels()
Returns
GetLength(ValueScalingMode)
Value range: displayed: 0 to 256, real: 0 to 256 Original name: 1 'Length'
int GetLength(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueScalingModeValueScalingMode
Returns
- int
GetLengthUnit()
Original name: 5 'Length unit'
LoopTimeUnit GetLengthUnit()
Returns
GetMaxBufferSize(ValueScalingMode)
Max buffer size in seconds
Original name: 6 'Max buffer size'
int GetMaxBufferSize(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueScalingModeValueScalingMode
Returns
- int
GetMode()
Original name: 4 'Mode'
LoopMode GetMode()
Returns
GetOnNoteon()
Original name: 7 'On NoteON'
LoopOnNoteOn GetOnNoteon()
Returns
GetRepeatEndless128(ValueScalingMode)
Original name: 3 'Repeat (128=endless)'
int GetRepeatEndless128(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueScalingModeValueScalingMode
Returns
- int
GetVolume(ValueScalingMode)
Value range: displayed: 0 to 256, real: 0 to 256 Original name: 0 'Volume'
int GetVolume(ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueScalingModeValueScalingMode
Returns
- int
MakeChannelsEvent(ChannelsInverted)
This is a helper method to automatically handle turning target controller values into column values.
For this controller the input value is taken as is, only clamped to column value range.
PatternEvent MakeChannelsEvent(ChannelsInverted value)
Parameters
valueChannelsInverted
Returns
MakeLengthEvent(int)
This is a helper method to automatically handle turning target controller values into column values.
For this controller the input value is mapped from displayed range (0 to 256) to column range (0 to 0x8000). Out of range values are clamped.
PatternEvent MakeLengthEvent(int value)
Parameters
valueint
Returns
MakeLengthUnitEvent(LoopTimeUnit)
This is a helper method to automatically handle turning target controller values into column values.
For this controller the input value is taken as is, only clamped to column value range.
PatternEvent MakeLengthUnitEvent(LoopTimeUnit value)
Parameters
valueLoopTimeUnit
Returns
MakeMaxBufferSizeEvent(int)
Max buffer size in seconds
This is a helper method to automatically handle turning target controller values into column values.
For this controller the input value is taken as is, only clamped to column value range.
PatternEvent MakeMaxBufferSizeEvent(int value)
Parameters
valueint
Returns
MakeModeEvent(LoopMode)
This is a helper method to automatically handle turning target controller values into column values.
For this controller the input value is taken as is, only clamped to column value range.
PatternEvent MakeModeEvent(LoopMode value)
Parameters
valueLoopMode
Returns
MakeOnNoteonEvent(LoopOnNoteOn)
This is a helper method to automatically handle turning target controller values into column values.
For this controller the input value is taken as is, only clamped to column value range.
PatternEvent MakeOnNoteonEvent(LoopOnNoteOn value)
Parameters
valueLoopOnNoteOn
Returns
MakeRepeatEndless128Event(int)
This is a helper method to automatically handle turning target controller values into column values.
For this controller the input value is taken as is, only clamped to column value range.
PatternEvent MakeRepeatEndless128Event(int value)
Parameters
valueint
Returns
MakeVolumeEvent(int)
This is a helper method to automatically handle turning target controller values into column values.
For this controller the input value is mapped from displayed range (0 to 256) to column range (0 to 0x8000). Out of range values are clamped.
PatternEvent MakeVolumeEvent(int value)
Parameters
valueint
Returns
SetChannels(ChannelsInverted)
Original name: 2 'Channels' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.
void SetChannels(ChannelsInverted value)
Parameters
valueChannelsInverted
SetLength(int, ValueScalingMode)
Value range: displayed: 0 to 256, real: 0 to 256 Original name: 1 'Length' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.
void SetLength(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueintvalueScalingModeValueScalingMode
SetLengthUnit(LoopTimeUnit)
Original name: 5 'Length unit' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.
void SetLengthUnit(LoopTimeUnit value)
Parameters
valueLoopTimeUnit
SetMaxBufferSize(int, ValueScalingMode)
Max buffer size in seconds
Original name: 6 'Max buffer size'
Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.
void SetMaxBufferSize(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueintvalueScalingModeValueScalingMode
SetMode(LoopMode)
Original name: 4 'Mode' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.
void SetMode(LoopMode value)
Parameters
valueLoopMode
SetOnNoteon(LoopOnNoteOn)
Original name: 7 'On NoteON' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.
void SetOnNoteon(LoopOnNoteOn value)
Parameters
valueLoopOnNoteOn
SetRepeatEndless128(int, ValueScalingMode)
Original name: 3 'Repeat (128=endless)' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.
void SetRepeatEndless128(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueintvalueScalingModeValueScalingMode
SetVolume(int, ValueScalingMode)
Value range: displayed: 0 to 256, real: 0 to 256 Original name: 0 'Volume' Note: equivalent SendEvent(int, PatternEvent) will be used internally, which may introduce latency. It will also be affected by the event timestamp set.
void SetVolume(int value, ValueScalingMode valueScalingMode = ValueScalingMode.Displayed)
Parameters
valueintvalueScalingModeValueScalingMode