Package org.jjazz.rhythm.api.rhythmparameters

Class RP_SYS_Mute

java.lang.Object

org.jjazz.rhythm.api.RP_StringSet

org.jjazz.rhythm.api.rhythmparameters.RP_SYS_Mute

All Implemented Interfaces:

RhythmParameter<Set<String>>, RpEnumerable<Set<String>>

public class RP_SYS_Mute
extends RP_StringSet

System RhythmParameter: mute one or more instruments.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ID

Fields inherited from class org.jjazz.rhythm.api.RP_StringSet

MAX_SET_SIZE

Method Summary

Modifier and Type	Method	Description
static RP_SYS_Mute	createMuteRp(Rhythm r, boolean isPrimary)	A factory method to build a RhythmParameter for a specified rhythm.
static List<RhythmVoice>	getMutedRhythmVoices(Rhythm r, Set<String> value)	Retrieve the muted RhythmVoices from the specified rp value.
static RP_SYS_Mute	getMuteRp(Rhythm rhythm)	Find the first RP_SYS_Mute instance in the rhythm parameters of r.

Methods inherited from class org.jjazz.rhythm.api.RP_StringSet

calculatePercentage, calculateValue, convertValue, equals, getDefaultValue, getDescription, getDisplayName, getDisplayValue, getId, getMaxValue, getMinValue, getNextValue, getPossibleValues, getPreviousValue, getValueDescription, hashCode, isCompatibleWith, isPrimary, isValidValue, loadFromString, saveAsString, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jjazz.rhythm.api.RhythmParameter

cloneValue

Field Details

ID

public static String ID

Method Details

createMuteRp

public static RP_SYS_Mute createMuteRp(Rhythm r,
 boolean isPrimary)

A factory method to build a RhythmParameter for a specified rhythm.

Use the rhythmVoice's names to create the possible values of RP_SYS_Mute. If a RhythmVoice is a RhythmVoiceDelegate, use the name of its source RhythmVoice instead.

Parameters:

r -

isPrimary -

Returns:

getMutedRhythmVoices

public static List<RhythmVoice> getMutedRhythmVoices(Rhythm r,
 Set<String> value)

Retrieve the muted RhythmVoices from the specified rp value.

Works for a RP_SYS_Mute created using createMuteRp(r).

Parameters:

r -

value -

Returns:

getMuteRp

public static RP_SYS_Mute getMuteRp(Rhythm rhythm)

Find the first RP_SYS_Mute instance in the rhythm parameters of r.

Parameters:

rhythm -

Returns:

Can be null if not found