Epok Engine

EPOK RUNTIME

epok::music_stop

Function · 1 overload

Function

Performs `music stop` as part of SPU sound playback and voice ownership.

Belongs to
epok
Header
audio.hpp
Overloads
1

Declaration

Declaration
void music_stop(AudioSource*)

Performs `music stop` as part of SPU sound playback and voice ownership.

ParameterTypeMeaning
arg1AudioSource *Value supplied for arg1. Keep referenced or pointed-to data valid for the complete call.

Returns: Nothing (void).

Example

C++ example
#include "audio.hpp"

// Assume these named values have been initialized with valid data:
// AudioSource * arg1

epok::music_stop(arg1);

Why use it

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. Pointer/reference arguments are borrowed unless the source contract says otherwise; keep them valid for the complete operation and never assume null is accepted.

Declared in runtime/audio.hpp:13

Related members