class

FAudioSampleRing

Module
Audio
Header
#include "Audio/FAudioSampleRing.h"
Namespace
Mowo

Constructors

SignatureNameDescription
FAudioSampleRing() = defaultFAudioSampleRing

Public functions

ReturnsNameDescription
voidResize
voidClear
uint32_tGetCapacity
uint32_tGetAvailable
uint32_tGetFree
boolWriteProducer side.
boolReadConsumer side.
uint32_tReadOrSilenceConsumer side, tolerant variant: reads what is there and zero-fills the rest.
uint64_tGetDroppedSamples

Function details

FAudioSampleRing

C++
FAudioSampleRing() = default

Resize

C++
void Resize(uint32_t capacitySamples)

Clear

C++
void Clear()

GetCapacity

C++
uint32_t GetCapacity() const

GetAvailable

C++
uint32_t GetAvailable() const

GetFree

C++
uint32_t GetFree() const

Write

C++
bool Write(const int16_t* samples, uint32_t count)

Producer side. All-or-nothing, so a reader never sees a torn frame.

Read

C++
bool Read(int16_t* out, uint32_t count)

Consumer side. All-or-nothing for the same reason.

ReadOrSilence

C++
uint32_t ReadOrSilence(int16_t* out, uint32_t count)

Consumer side, tolerant variant: reads what is there and zero-fills the rest. Returns the number of real samples delivered.

GetDroppedSamples

C++
uint64_t GetDroppedSamples() const
Generated from Audio/FAudioSampleRing.h via audio.json · Oct 26, 2026Version 1.0.0