Skip to content

EPOK RUNTIME

epok::AudioComponent

Class

Class

Shared audio without a transform.

Namespace: epok
Header: object_model.hpp
Include: #include "object_model.hpp"
Module: object-model
Source: runtime/object_model.hpp:527

Inherits from: ActorComponent

Basic usage

This minimal snippet shows the normal syntax for reaching the type. 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

localExposes `local` on `epok::AudioComponent` for the object model module.Field sourceExposes `source` on `epok::AudioComponent` for the object model module.Field static_class_idExposes `static_class_id` on `epok::AudioComponent` for the object model module.Variable

Public methods

begin_playplay_on_start policy.Method bind_localPerforms `bind local` as part of the object model module.Method bind_slotBind to the legacy slot's AudioSource, or to component-owned storage.Method class_idPerforms `class id` as part of the object model module.Method end_playEnds play as part of the object model module.Method entity_slotPerforms `entity slot` as part of the object model module.Method is_playingReports whether playing as part of the object model module.Method on_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.Method owns_sourceTrue only for component-owned storage.Method playStarts play as part of the object model module.Method releasableComponent-owned storage stays quarantined while an asynchronous consumer (the XA music service) still points at it, mirroring allocate_actor_data's legacy-slot rule.Method stopStops stop as part of the object model module.Method