Section Instruments
Harmony's Instruments utility functions
- See
- Instrument
- MusicalInstrument An abstraction level above Harmony's Instrument.
- MusicalInstruments
Summary
| Return type | Function and summary |
|---|---|
| boolean | InstrumentIsUsed(Score score, Instrument instr, boolean excludeMutedStaves) Is instr Instrument used in score ? |
| SetInstrumentFXProcessor(Instrument instr, FXProcessor fxproc) Set the default FX Processor for an instrument. |
Functions
SetInstrumentFXProcessor(Instrument instr, FXProcessor fxproc)
Set the default FX Processor for an instrument.
The instrument's FXProcessor is not visible on the score. It's the one you edit from the instrument dialog's "FX" button.
| Parameter | Type | Default | Description |
|---|---|---|---|
| instr | Instrument | The instrument | |
| fxproc | FXProcessor | The FXProcessor which properties will be copied in the instrument's FX Processor |
InstrumentIsUsed(Score score, Instrument instr, boolean excludeMutedStaves)
Is instr Instrument used in score ?
Instument.IsUsed returns true even if applide to rule that is never used, or used by a staff that has Virtual Singer voice active. This function handles these cases.
| Parameter | Type | Default | Description |
|---|---|---|---|
| score | Score | score | |
| instr | Instrument | instr | |
| excludeMutedStaves | boolean | false |
- Return
- boolean: boolean