Epok Engine

EPOK RUNTIME

epok::instrument::synth::State::hardware_parameters

Method · 1 overload

Method

Performs `hardware parameters` as part of the instrument synth module.

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

Declaration

const
Declaration
HardwareParameters hardware_parameters() const

Performs `hardware parameters` as part of the instrument synth module.

This overload takes no parameters.

Returns: HardwareParameters. Check the value before continuing when it represents success, availability or a resource handle.

Example

C++ example
#include "instrument_synth.hpp"

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

auto result = object.hardware_parameters();

Why use it

The method is `const`, so it does not mutate the object through this API surface.

Trade-offs and warnings

Call it only in the lifecycle phase described by the module. Validate indices, capacities and object state before use.

Declared in runtime/instrument_synth.hpp:88

Related members

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.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`bank.data` must outlive this state.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