Class RP_SYS_Mute

java.lang.Object

org.jjazz.rhythm.api.RP_StringSet

org.jjazz.rhythmmusicgeneration.api.RP_SYS_Mute

All Implemented Interfaces:

Cloneable, 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
static UserRhythmVoice	RV_MUTE_USER_TRACK_1	Special UserRhythmVoice instance to indicate that the "1st" user track of the MidiMix should be muted.
static UserRhythmVoice	RV_MUTE_USER_TRACK_2	Special UserRhythmVoice instance to indicate that the "2nd" user track of the MidiMix should be muted.
static UserRhythmVoice	RV_MUTE_USER_TRACK_3	Special UserRhythmVoice instance to indicate that the "3rd" user track of the MidiMix should be muted.

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, MidiMix midiMix, 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, getCopy, 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

RV_MUTE_USER_TRACK_1

public static UserRhythmVoice RV_MUTE_USER_TRACK_1

Special UserRhythmVoice instance to indicate that the "1st" user track of the MidiMix should be muted.

See Also:

• getMutedRhythmVoices(org.jjazz.rhythm.api.Rhythm, org.jjazz.midimix.api.MidiMix, java.util.Set)

RV_MUTE_USER_TRACK_2

public static UserRhythmVoice RV_MUTE_USER_TRACK_2

Special UserRhythmVoice instance to indicate that the "2nd" user track of the MidiMix should be muted.

See Also:

• getMutedRhythmVoices(org.jjazz.rhythm.api.Rhythm, org.jjazz.midimix.api.MidiMix, java.util.Set)

RV_MUTE_USER_TRACK_3

public static UserRhythmVoice RV_MUTE_USER_TRACK_3

Special UserRhythmVoice instance to indicate that the "3rd" user track of the MidiMix should be muted.

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. Add also the names of the 3 special UserRhythmVoices RV_MUTE_USER_TRACK_1/2/3.

Parameters:

r -

isPrimary -

Returns:

getMutedRhythmVoices

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

Retrieve the muted RhythmVoices from the specified rp value.

Works for a RP_SYS_Mute created using createMuteRp(r).

Parameters:

r -

midiMix - Needed in order to retrieve the corresponding UserRhythmVoice if value contains some of the RV_MUTE_USER_TRACK_1/2/3 names.

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