HikoGUI
A low latency retained GUI
Loading...
Searching...
No Matches
Data Fields
tt::AudioBlock Struct Reference

Data Fields

uint64_t samplePosition
 
hires_utc_clock::time_point timestamp
 
size_t numberOfSamples
 
double wordClockSampleRate
 
double deviceSampleRate
 
size_t numberOfBitsPerSample
 
size_t stridePerSample
 
SampleFormat sampleFormat
 
bool containsGlitch
 
bool badTimestamp
 
bool silent
 
std::vector< AudioBufferbuffers
 

Field Documentation

◆ badTimestamp

bool tt::AudioBlock::badTimestamp

The timestamp in this block is bad.

◆ buffers

std::vector<AudioBuffer> tt::AudioBlock::buffers

A list of sample data buffers. Each buffer contains a set of interleaved channels.

Some devices create a single buffer with all channels interleaved. Some devices create one non-interleaved buffer for each channel. Some devices have different sets of inputs, each interleaved, for example 8 digital inputs interleaved in one buffer, and 10 analogue inputs interleaved in the second buffer.

◆ containsGlitch

bool tt::AudioBlock::containsGlitch

The data in the buffer contains a glitch. Examples of how glitches could happen:

  • CRC error caused by a bad USB/Firewire/Ethernet cable.
  • Sample rate of the word clock or digital audio input and the sample rate of the audio device is too far off.

◆ deviceSampleRate

double tt::AudioBlock::deviceSampleRate

Sample rate to what the audio device is configured to.

◆ numberOfBitsPerSample

size_t tt::AudioBlock::numberOfBitsPerSample

Number of bits in each sample.

◆ numberOfSamples

size_t tt::AudioBlock::numberOfSamples

Number of samples in this audio block.

◆ sampleFormat

SampleFormat tt::AudioBlock::sampleFormat

Format of the samples in this block.

◆ samplePosition

uint64_t tt::AudioBlock::samplePosition

The sample position of the first sample in this block since the start of the capture/render session.

◆ silent

bool tt::AudioBlock::silent

This block of audio is silent.

◆ stridePerSample

size_t tt::AudioBlock::stridePerSample

Number of bytes to jump to the next sample.

◆ timestamp

hires_utc_clock::time_point tt::AudioBlock::timestamp

Timestamp when the sample first sample in this block was captured at the audio device input or when the first sample in this block will appear at the audio device output.

◆ wordClockSampleRate

double tt::AudioBlock::wordClockSampleRate

Sample rate of the word clock attached to the audio interface For example in some situation on film sets the audio interface sample rate is overdriven to 48048 Hz.


The documentation for this struct was generated from the following file: