Section FXProcessors
FXProcessor handling utility functions.
- See
- FXProcessor
Summary
| Return type | Function and summary |
|---|---|
| CopyFXProcessor(FXProcessor source, FXProcessor dest) Copy all parameters from a FXProcessor to another one. | |
| boolean | EnsureObjectInStaffArea(Score score, Staff staff, obj) Ensure an object is in the Staff area, move it vertically if needed. |
| SetInstrumentFXProcessor(Instrument instr, FXProcessor fxproc) Set the default FX Processor for an instrument. |
Functions
CopyFXProcessor(FXProcessor source, FXProcessor dest)
Copy all parameters from a FXProcessor to another one.
| Parameter | Type | Default | Description |
|---|---|---|---|
| source | FXProcessor | The FXProcessor to copy | |
| dest | FXProcessor | The destination FXProcessor that will receive source settings. |
- Error
- if source or dest are nil
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 |
EnsureObjectInStaffArea(Score score, Staff staff, obj)
Ensure an object is in the Staff area, move it vertically if needed.
| Parameter | Type | Default | Description |
|---|---|---|---|
| score | Score | score | |
| staff | Staff | staff | |
| obj | Object: Dynamic, StaffText, FXProcessor, Picture |
- Return
- boolean:
trueif object has been moved vertically,falseotherwise.