QtCraft API C++ classes QML types Handbook

QcSoundBank Class

All sounds of the content, rendered once. More...

Header: #include <clientcore/sound/QcSoundBank.h>

Public Types

struct Entry

Public Functions

const QcSoundBank::Entry *find(const QString &name) const
int sampleRate() const
qsizetype size() const
const QStringList &skipped() const
qsizetype totalSamples() const

Static Public Members

QcSoundBank build(const QcContentRegistry &content, int sampleRate)
const qsizetype maxSamples

Detailed Description

Built on a worker thread and then shared read-only.

Member Function Documentation

[static] QcSoundBank QcSoundBank::build(const QcContentRegistry &content, int sampleRate)

Returns every sound of content rendered at sampleRate, within maxSamples.

const QcSoundBank::Entry *QcSoundBank::find(const QString &name) const

Returns the sound name; null for unknown sounds and sounds that did not fit the budget.

int QcSoundBank::sampleRate() const

Returns the sample rate the sounds were rendered at.

qsizetype QcSoundBank::size() const

Returns the number of sounds rendered.

const QStringList &QcSoundBank::skipped() const

Returns the sounds left out because of the memory budget.

qsizetype QcSoundBank::totalSamples() const

Returns the samples of all rendered sounds together.

Member Variable Documentation

const qsizetype QcSoundBank::maxSamples

Memory budget for rendered samples (64 MiB of floats); sounds beyond it stay silent.