Trade-offs and warnings
Consult the linked header for this operation’s ownership, lifetime and failure behavior.
EPOK RUNTIME
Method · 1 overload
Declarations are extracted from the pinned headers. Examples and general guidance are generated sketches, not verified complete programs; consult the linked source and guides for the actual contract.
`bank.data` must outlive this state.
Error start(const BankView& bank, uint16_t zone_index, uint8_t key, uint8_t velocity, const Controls& controls)`bank.data` must outlive this state.
| Parameter | Type | Meaning |
|---|---|---|
bank | const BankView & | Not documented; consult the linked header. |
zone_index | uint16_t | Not documented; consult the linked header. |
key | uint8_t | Not documented; consult the linked header. |
velocity | uint8_t | Not documented; consult the linked header. |
controls | const Controls & | Not documented; consult the linked header. |
Returns: Error. Consult the linked header for its meaning.
#include "instrument_synth.hpp"
// Assume these named values have been initialized with valid data:
// const BankView & bank
// uint16_t zone_index
// uint8_t key
// uint8_t velocity
// const Controls & controls
epok::instrument::synth::State& object = /* obtain a valid instance */;
auto result = object.start(bank, zone_index, key, velocity, controls);Consult the linked header for this operation’s ownership, lifetime and failure behavior.
Declared in runtime/instrument_synth.hpp:63
activePerforms `active` as part of the instrument synth module.MethodadvancePerforms `advance` as part of the instrument synth module.Methodcopy_initialThe immutable prepared source must outlive this voice, like its bank.MethoderrorPerforms `error` as part of the instrument synth module.Methodhardware_outputPerforms `hardware output` as part of the instrument synth module.Methodhardware_parametersPerforms `hardware parameters` as part of the instrument synth module.MethodoutputPerforms `output` as part of the instrument synth module.MethodreleasePerforms `release` as part of the instrument synth module.MethodresetResets reset as part of the instrument synth module.Methodstart_validatedPSX loader has validated the immutable bank and the kernel has validated controls/note data.Methodstart_voiceHost source-preview adapters may construct the same neutral wire structs without fabricating an EPSB container.MethodStateConstructs `epok::instrument::synth::State` for the instrument synth module.constructor