StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
StormByte::Multimedia::AudioPresentation Struct Reference

Device clock feedback in media seconds for the requested epoch. More...

#include <StormByte/multimedia/display.hxx>

Public Member Functions

 AudioPresentation ()=default
 Construct unavailable clock feedback.
 AudioPresentation (const AudioPresentation &other)=default
 Copy clock feedback.
 AudioPresentation (AudioPresentation &&other) noexcept=default
 Move clock feedback.
 ~AudioPresentation () noexcept=default
 Destroy clock feedback.
AudioPresentation & operator= (const AudioPresentation &other)=default
 Copy clock feedback.
AudioPresentation & operator= (AudioPresentation &&other) noexcept=default
 Move clock feedback.

Public Attributes

bool m_valid = false
 Whether device feedback is available.
bool m_drained = false
 Whether all submitted audio samples have been heard (not GUI drain).
double m_position = 0
 Device playback cursor in media seconds.
double m_latency = 0
 Unheard device latency in seconds, nonnegative.

Detailed Description

Device clock feedback in media seconds for the requested epoch.

Audible position is m_position minus m_latency. m_valid becomes true after audio starts; the clock must advance through the last submitted sample, freeze during pause and never describe another epoch.

Constructor & Destructor Documentation

◆ AudioPresentation() [1/3]

StormByte::Multimedia::AudioPresentation::AudioPresentation ( )
default

Construct unavailable clock feedback.

◆ AudioPresentation() [2/3]

StormByte::Multimedia::AudioPresentation::AudioPresentation ( const AudioPresentation & other)
default

Copy clock feedback.

Parameters
otherSource.

◆ AudioPresentation() [3/3]

StormByte::Multimedia::AudioPresentation::AudioPresentation ( AudioPresentation && other)
defaultnoexcept

Move clock feedback.

Parameters
otherSource.

◆ ~AudioPresentation()

StormByte::Multimedia::AudioPresentation::~AudioPresentation ( )
defaultnoexcept

Destroy clock feedback.

Member Function Documentation

◆ operator=() [1/2]

AudioPresentation & StormByte::Multimedia::AudioPresentation::operator= ( AudioPresentation && other)
defaultnoexcept

Move clock feedback.

Parameters
otherSource.
Returns
This feedback.

◆ operator=() [2/2]

AudioPresentation & StormByte::Multimedia::AudioPresentation::operator= ( const AudioPresentation & other)
default

Copy clock feedback.

Parameters
otherSource.
Returns
This feedback.

Member Data Documentation

◆ m_drained

bool StormByte::Multimedia::AudioPresentation::m_drained = false

Whether all submitted audio samples have been heard (not GUI drain).

◆ m_latency

double StormByte::Multimedia::AudioPresentation::m_latency = 0

Unheard device latency in seconds, nonnegative.

◆ m_position

double StormByte::Multimedia::AudioPresentation::m_position = 0

Device playback cursor in media seconds.

◆ m_valid

bool StormByte::Multimedia::AudioPresentation::m_valid = false

Whether device feedback is available.


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