Interface XGEffectBlock

This is the base for all Yamaha XG effect interfaces.

It represents a single effect block.

There are 4 effect blocks types in XG:

Reverb
Chorus
Variation
Insertion

interface XGEffectBlock {
    applySnapshot(snapshot: XGEffectBlockSnapshot): void;
    getSnapshot(): XGEffectBlockSnapshot;
    getType(): number;
    reset(): void;
    setParameter(param: number, value: number): void;
    setType(type: number): void;
}

Hierarchy (View Summary)

XGEffectBlock
- XGInsertionBlock
- XGSystemEffectBlock

Implemented by

DefaultXGEffect

Index

Methods

applySnapshot getSnapshot getType reset setParameter setType

Methods

applySnapshot

applySnapshot(snapshot: XGEffectBlockSnapshot): void
Restores this XG effect block from a snapshot.
Parameters
- snapshot: XGEffectBlockSnapshot
  The snapshot to restore.
Returns void
- Defined in src/synthesizer/audio_engine/effects/xg/interface/xg_effect_block.ts:74

getSnapshot

getSnapshot(): XGEffectBlockSnapshot
Gets a snapshot of this XG effect block.

Returns XGEffectBlockSnapshot
- Defined in src/synthesizer/audio_engine/effects/xg/interface/xg_effect_block.ts:68

getType

getType(): number
Gets the current 16-bit type of the processor.

Returns number
The 16-bit ((MSB << 8) | LSB) type of the processor used.
- Defined in src/synthesizer/audio_engine/effects/xg/interface/xg_effect_block.ts:51

reset

reset(): void
Resets this block to default values, including the processor type.

Returns void
- Defined in src/synthesizer/audio_engine/effects/xg/interface/xg_effect_block.ts:56

setParameter

setParameter(param: number, value: number): void
Sets the given effect parameter to the given value.
Parameters
- param: number
  The parameter number (0-based).
- value: number
  The value: 14-bit for two-byte params, 7-bit for single-byte params.
Returns void
- Defined in src/synthesizer/audio_engine/effects/xg/interface/xg_effect_block.ts:63

setType

setType(type: number): void
Sets the type of the processor. Per XG spec, BASIC EFFECT (LSB = 0) should be used if the exact match is missing.

Type change should reset the parameters. Fallback behavior (no BASIC EFFECT) is up to the implementation.
Parameters
- type: number
  The 16-bit type value to use.
Returns void
- Defined in src/synthesizer/audio_engine/effects/xg/interface/xg_effect_block.ts:45