Epok Engine

EPOK RUNTIME

Instrument Bank

instrument_bank.hpp · the instrument bank module

Module

the instrument bank module.

Header
instrument_bank.hpp
Include
#include "instrument_bank.hpp"
Stability
Epok runtime API

Include this module

C++ include
#include "instrument_bank.hpp"

Types

BankViewStruct declared by the instrument-bank module for the instrument bank module.StructDestinationEnum declared by the instrument-bank module for the instrument bank module.EnumEnvelopeStruct declared by the instrument-bank module for the instrument bank module.StructLfoStruct declared by the instrument-bank module for the instrument bank module.StructModulationStruct declared by the instrument-bank module for the instrument bank module.StructSampleStruct declared by the instrument-bank module for the instrument bank module.StructZoneStruct declared by the instrument-bank module for the instrument bank module.Struct

Functions and methods

modulationPerforms `modulation` as part of the instrument bank module.Methodmodulation_countPerforms `modulation count` as part of the instrument bank module.MethodrangePerforms `range` as part of the instrument bank module.Functionreverb_bytesPerforms `reverb bytes` as part of the instrument bank module.Methodreverb_depthPerforms `reverb depth` as part of the instrument bank module.Methodreverb_presetPerforms `reverb preset` as part of the instrument bank module.MethodsamplePerforms `sample` as part of the instrument bank module.Methodsample_bytesPerforms `sample bytes` as part of the instrument bank module.Methodsample_countPerforms `sample count` as part of the instrument bank module.MethodtimePerforms `time` as part of the instrument bank module.Functionu16Performs `u16` as part of the instrument bank module.Functionu32Performs `u32` as part of the instrument bank module.FunctionvalidAnalysis may inspect an over-budget payload; playback always enforces it.Methodvalid_envelopePerforms `valid envelope` as part of the instrument bank module.Functionvalid_lfoPerforms `valid lfo` as part of the instrument bank module.Functionvalid_sourcePerforms `valid source` as part of the instrument bank module.FunctionzonePerforms `zone` as part of the instrument bank module.Methodzone_countPerforms `zone count` as part of the instrument bank module.Method

Fields, variables and values

amountExposes `amount` on `epok::instrument::Modulation` for the instrument bank module.Fieldamount_sourceExposes `amount_source` on `epok::instrument::Modulation` for the instrument bank module.FieldattackExposes `attack` on `epok::instrument::Envelope` for the instrument bank module.FieldattenuationExposes `attenuation` on `epok::instrument::Zone` for the instrument bank module.FieldAttenuationNamed value `Attenuation` in `epok::instrument::Destination`.Enum valuebankExposes `bank` on `epok::instrument::Zone` for the instrument bank module.FieldChorusNamed value `Chorus` in `epok::instrument::Destination`.Enum valuedataExposes `data` on `epok::instrument::BankView` for the instrument bank module.FielddecayExposes `decay` on `epok::instrument::Envelope` for the instrument bank module.Fielddecay_keyExposes `decay_key` on `epok::instrument::Envelope` for the instrument bank module.FielddelayExposes `delay` on `epok::instrument::Envelope` for the instrument bank module.FielddelayExposes `delay` on `epok::instrument::Lfo` for the instrument bank module.FielddestinationExposes `destination` on `epok::instrument::Modulation` for the instrument bank module.Fieldexclusive_classExposes `exclusive_class` on `epok::instrument::Zone` for the instrument bank module.Fieldfixed_keyExposes `fixed_key` on `epok::instrument::Zone` for the instrument bank module.Fieldfixed_velocityExposes `fixed_velocity` on `epok::instrument::Zone` for the instrument bank module.FieldflagsExposes `flags` on `epok::instrument::Modulation` for the instrument bank module.FieldframesExposes `frames` on `epok::instrument::Sample` for the instrument bank module.FieldfrequencyExposes `frequency` on `epok::instrument::Lfo` for the instrument bank module.FieldholdExposes `hold` on `epok::instrument::Envelope` for the instrument bank module.Fieldhold_keyExposes `hold_key` on `epok::instrument::Envelope` for the instrument bank module.Fieldkey_hiExposes `key_hi` on `epok::instrument::Zone` for the instrument bank module.Fieldkey_loExposes `key_lo` on `epok::instrument::Zone` for the instrument bank module.Fieldloop_endExposes `loop_end` on `epok::instrument::Sample` for the instrument bank module.Fieldloop_modeExposes `loop_mode` on `epok::instrument::Zone` for the instrument bank module.Fieldloop_startExposes `loop_start` on `epok::instrument::Sample` for the instrument bank module.Fieldmod_beginExposes `mod_begin` on `epok::instrument::Zone` for the instrument bank module.Fieldmod_countExposes `mod_count` on `epok::instrument::Zone` for the instrument bank module.Fieldmod_env_pitchExposes `mod_env_pitch` on `epok::instrument::Zone` for the instrument bank module.FieldModEnvAttackNamed value `ModEnvAttack` in `epok::instrument::Destination`.Enum valueModEnvDecayNamed value `ModEnvDecay` in `epok::instrument::Destination`.Enum valueModEnvDecayKeyNamed value `ModEnvDecayKey` in `epok::instrument::Destination`.Enum valueModEnvDelayNamed value `ModEnvDelay` in `epok::instrument::Destination`.Enum valueModEnvHoldNamed value `ModEnvHold` in `epok::instrument::Destination`.Enum valueModEnvHoldKeyNamed value `ModEnvHoldKey` in `epok::instrument::Destination`.Enum valueModEnvPitchNamed value `ModEnvPitch` in `epok::instrument::Destination`.Enum valueModEnvReleaseNamed value `ModEnvRelease` in `epok::instrument::Destination`.Enum valueModEnvSustainNamed value `ModEnvSustain` in `epok::instrument::Destination`.Enum valueModLfoDelayNamed value `ModLfoDelay` in `epok::instrument::Destination`.Enum valueModLfoFrequencyNamed value `ModLfoFrequency` in `epok::instrument::Destination`.Enum valueModLfoPitchNamed value `ModLfoPitch` in `epok::instrument::Destination`.Enum valueModLfoVolumeNamed value `ModLfoVolume` in `epok::instrument::Destination`.Enum valuemodulation_envelopeExposes `modulation_envelope` on `epok::instrument::Zone` for the instrument bank module.Fieldmodulation_lfoExposes `modulation_lfo` on `epok::instrument::Zone` for the instrument bank module.FieldoffsetExposes `offset` on `epok::instrument::Sample` for the instrument bank module.FieldpanExposes `pan` on `epok::instrument::Zone` for the instrument bank module.FieldPanNamed value `Pan` in `epok::instrument::Destination`.Enum valuepercussionExposes `percussion` on `epok::instrument::Zone` for the instrument bank module.FieldpitchExposes `pitch` on `epok::instrument::Lfo` for the instrument bank module.FieldPitchNamed value `Pitch` in `epok::instrument::Destination`.Enum valueprogramExposes `program` on `epok::instrument::Zone` for the instrument bank module.FieldrateExposes `rate` on `epok::instrument::Sample` for the instrument bank module.FieldreleaseExposes `release` on `epok::instrument::Envelope` for the instrument bank module.FieldreservedExposes `reserved` on `epok::instrument::Modulation` for the instrument bank module.FieldreservedExposes `reserved` on `epok::instrument::Zone` for the instrument bank module.FieldreverbExposes `reverb` on `epok::instrument::Zone` for the instrument bank module.FieldReverbNamed value `Reverb` in `epok::instrument::Destination`.Enum valueroot_keyExposes `root_key` on `epok::instrument::Zone` for the instrument bank module.FieldsampleExposes `sample` on `epok::instrument::Zone` for the instrument bank module.FieldscaleExposes `scale` on `epok::instrument::Zone` for the instrument bank module.FieldScaleNamed value `Scale` in `epok::instrument::Destination`.Enum valuesizeExposes `size` on `epok::instrument::BankView` for the instrument bank module.FieldsizeExposes `size` on `epok::instrument::Sample` for the instrument bank module.FieldsourceExposes `source` on `epok::instrument::Modulation` for the instrument bank module.FieldsustainExposes `sustain` on `epok::instrument::Envelope` for the instrument bank module.FieldtuneExposes `tune` on `epok::instrument::Zone` for the instrument bank module.Fieldvelocity_hiExposes `velocity_hi` on `epok::instrument::Zone` for the instrument bank module.Fieldvelocity_loExposes `velocity_lo` on `epok::instrument::Zone` for the instrument bank module.FieldVibLfoDelayNamed value `VibLfoDelay` in `epok::instrument::Destination`.Enum valueVibLfoFrequencyNamed value `VibLfoFrequency` in `epok::instrument::Destination`.Enum valueVibLfoPitchNamed value `VibLfoPitch` in `epok::instrument::Destination`.Enum valuevibrato_lfoExposes `vibrato_lfo` on `epok::instrument::Zone` for the instrument bank module.FieldVolEnvAttackNamed value `VolEnvAttack` in `epok::instrument::Destination`.Enum valueVolEnvDecayNamed value `VolEnvDecay` in `epok::instrument::Destination`.Enum valueVolEnvDecayKeyNamed value `VolEnvDecayKey` in `epok::instrument::Destination`.Enum valueVolEnvDelayNamed value `VolEnvDelay` in `epok::instrument::Destination`.Enum valueVolEnvHoldNamed value `VolEnvHold` in `epok::instrument::Destination`.Enum valueVolEnvHoldKeyNamed value `VolEnvHoldKey` in `epok::instrument::Destination`.Enum valueVolEnvReleaseNamed value `VolEnvRelease` in `epok::instrument::Destination`.Enum valueVolEnvSustainNamed value `VolEnvSustain` in `epok::instrument::Destination`.Enum valuevolumeExposes `volume` on `epok::instrument::Lfo` for the instrument bank module.Fieldvolume_envelopeExposes `volume_envelope` on `epok::instrument::Zone` for the instrument bank module.Field