EPOK RUNTIME
epok::AudioComponent
Class
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.
Class
Shared audio without a transform.
Basic usage
This generated sketch illustrates syntax for reaching the type; adapt it to the actual API contract. Open a member below for an operation-specific example.
C++ example
#include "object_model.hpp"
epok::AudioComponent& value = /* obtain a valid instance from your game */;Fields and constants
Public methods
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.MethodplayStarts play as part of the object model module.Methodplay_on_startStarts on start as part of the object model module.MethodpriorityPerforms `priority` as part of the object model module.MethodreleasableComponent-owned storage stays quarantined while an asynchronous consumer (the XA music service) still points at it, mirroring allocate_actor_data's legacy-slot rule.Methodset_clipSets clip as part of the object model module.Methodset_enabledSets enabled as part of the object model module.Methodset_pitchSets pitch as part of the object model module.Methodset_play_on_startSets play on start as part of the object model module.Methodset_prioritySets priority as part of the object model module.Methodset_volumeSets volume as part of the object model module.MethodstopStops stop as part of the object model module.MethodvolumePerforms `volume` as part of the object model module.Method