Epok Engine

EPOK RUNTIME

epok::AudioComponent::volume

Method · 1 overload

Method

Performs `volume` as part of the object model module.

Belongs to
epok::AudioComponent
Header
object_model.hpp
Overloads
1

Declaration

const
Declaration
Fixed volume() const

Performs `volume` as part of the object model module.

This overload takes no parameters.

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

Example

C++ example
#include "object_model.hpp"

epok::AudioComponent& object = /* obtain a valid instance */;

auto result = object.volume();

Why use it

The method is `const`, so it does not mutate the object through this API surface. The API exposes the hardware service without hiding latency or bounded memory.

Trade-offs and warnings

Treat device absence, busy state and I/O failure as expected outcomes; do not block the frame loop waiting for hardware.

Declared in runtime/object_model.hpp:618

Related members

begin_playplay_on_start policy.Methodbind_localPerforms `bind local` as part of the object model module.Methodbind_slotBind to the legacy slot's AudioSource, or to component-owned storage.Methodclass_idPerforms `class id` as part of the object model module.MethodclipPerforms `clip` as part of the object model module.MethodenabledPerforms `enabled` as part of the object model module.Methodend_playEnds play as part of the object model module.Methodentity_slotPerforms `entity slot` as part of the object model module.Methodis_playingReports whether playing as part of the object model module.Methodon_disableDeactivation and teardown stop both kinds: lifecycle.hpp::set_active stops a legacy slot's audio through the slot table, and stopping an already stopped source is a no-op, so the two paths are idempotent rather than conflicting.Methodowns_sourceTrue only for component-owned storage.MethodpitchPerforms `pitch` as part of the object model module.Method