class
FAudioSampleRing
- Module
- Audio
- Header
#include "Audio/FAudioSampleRing.h"- Namespace
Mowo
Constructors
| Signature | Name | Description |
|---|---|---|
FAudioSampleRing() = default | FAudioSampleRing |
Public functions
| Returns | Name | Description |
|---|---|---|
void | Resize | |
void | Clear | |
uint32_t | GetCapacity | |
uint32_t | GetAvailable | |
uint32_t | GetFree | |
bool | Write | Producer side. |
bool | Read | Consumer side. |
uint32_t | ReadOrSilence | Consumer side, tolerant variant: reads what is there and zero-fills the rest. |
uint64_t | GetDroppedSamples |
Function details
FAudioSampleRing
C++
FAudioSampleRing() = defaultResize
C++
void Resize(uint32_t capacitySamples)Clear
C++
void Clear()GetCapacity
C++
uint32_t GetCapacity() constGetAvailable
C++
uint32_t GetAvailable() constGetFree
C++
uint32_t GetFree() constWrite
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() constGenerated from Audio/FAudioSampleRing.h via audio.json · Oct 26, 2026Version 1.0.0