Epok Engine

EPOK RUNTIME

epok::instrument::synth::State::start_voice

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.

Method

Host source-preview adapters may construct the same neutral wire structs without fabricating an EPSB container.

Belongs to
epok::instrument::synth::State
Header
instrument_synth.hpp
Overloads
1

Declaration

Declaration
Error start_voice(const Zone& zone, const Modulation* modulations, uint16_t modulation_count, uint8_t key, uint8_t velocity, const Controls& controls)

Host source-preview adapters may construct the same neutral wire structs without fabricating an EPSB container.

ParameterTypeMeaning
zoneconst Zone &Not documented; consult the linked header.
modulationsconst Modulation *Not documented; consult the linked header.
modulation_countuint16_tNot documented; consult the linked header.
keyuint8_tNot documented; consult the linked header.
velocityuint8_tNot documented; consult the linked header.
controlsconst Controls &Not documented; consult the linked header.

Returns: Error. Consult the linked header for its meaning.

Example sketch

C++ example
#include "instrument_synth.hpp"

// Assume these named values have been initialized with valid data:
// const Zone & zone
// const Modulation * modulations
// uint16_t modulation_count
// uint8_t key
// uint8_t velocity
// const Controls & controls

epok::instrument::synth::State& object = /* obtain a valid instance */;

auto result = object.start_voice(zone, modulations, modulation_count, key, velocity, controls);

Trade-offs and warnings

Consult the linked header for this operation’s ownership, lifetime and failure behavior.

Declared in runtime/instrument_synth.hpp:73

Related members