Epok Engine

EPOK RUNTIME

epok::music_prepare

Function · 1 overload

Function

Performs `music prepare` as part of XA music streaming and playback state.

Belongs to
epok
Header
music.hpp
Overloads
1

Declaration

Declaration
inline void music_prepare(bool require_data = false)

Performs `music prepare` as part of XA music streaming and playback state.

ParameterTypeMeaning
require_databoolValue supplied for require_data. Keep referenced or pointed-to data valid for the complete call.

Returns: Nothing (void).

Example

C++ example
#include "music.hpp"

// Assume these named values have been initialized with valid data:
// bool require_data

epok::music_prepare(require_data);

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.

Declared in runtime/music.hpp:143

Related members