Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
QtPrivate::QAudioRingBuffer< T > Class Template Reference

#include <qaudioringbuffer_p.h>

+ Collaboration diagram for QtPrivate::QAudioRingBuffer< T >:

Public Types

using ValueType = T
 
using Region = QSpan<T>
 
using ConstRegion = QSpan<const T>
 

Public Member Functions

 QAudioRingBuffer (int bufferSize)
 
int write (ConstRegion region)
 
template<typename Functor>
int consume (int elements, Functor &&consumer)
 
template<typename Functor>
int consumeAll (Functor &&consumer)
 
int used () const
 
int free () const
 
int size () const
 
void reset ()
 
Region acquireWriteRegion (int size)
 
void releaseWriteRegion (int elementsRead)
 
ConstRegion acquireReadRegion (int size)
 
void releaseReadRegion (int elementsWritten)
 

Detailed Description

template<typename T>
class QtPrivate::QAudioRingBuffer< T >

Definition at line 31 of file qaudioringbuffer_p.h.

Member Typedef Documentation

◆ ConstRegion

template<typename T>
using QtPrivate::QAudioRingBuffer< T >::ConstRegion = QSpan<const T>

Definition at line 36 of file qaudioringbuffer_p.h.

◆ Region

template<typename T>
using QtPrivate::QAudioRingBuffer< T >::Region = QSpan<T>

Definition at line 35 of file qaudioringbuffer_p.h.

◆ ValueType

template<typename T>
using QtPrivate::QAudioRingBuffer< T >::ValueType = T

Definition at line 34 of file qaudioringbuffer_p.h.

Constructor & Destructor Documentation

◆ QAudioRingBuffer()

template<typename T>
QtPrivate::QAudioRingBuffer< T >::QAudioRingBuffer ( int bufferSize)
inlineexplicit

Definition at line 38 of file qaudioringbuffer_p.h.

Member Function Documentation

◆ acquireReadRegion()

template<typename T>
ConstRegion QtPrivate::QAudioRingBuffer< T >::acquireReadRegion ( int size)
inline

Definition at line 120 of file qaudioringbuffer_p.h.

◆ acquireWriteRegion()

template<typename T>
Region QtPrivate::QAudioRingBuffer< T >::acquireWriteRegion ( int size)
inline

Definition at line 100 of file qaudioringbuffer_p.h.

◆ consume()

template<typename T>
template<typename Functor>
int QtPrivate::QAudioRingBuffer< T >::consume ( int elements,
Functor && consumer )
inline

Definition at line 64 of file qaudioringbuffer_p.h.

◆ consumeAll()

template<typename T>
template<typename Functor>
int QtPrivate::QAudioRingBuffer< T >::consumeAll ( Functor && consumer)
inline

Definition at line 82 of file qaudioringbuffer_p.h.

◆ free()

template<typename T>
int QtPrivate::QAudioRingBuffer< T >::free ( ) const
inline

Definition at line 89 of file qaudioringbuffer_p.h.

◆ releaseReadRegion()

template<typename T>
void QtPrivate::QAudioRingBuffer< T >::releaseReadRegion ( int elementsWritten)
inline

Definition at line 132 of file qaudioringbuffer_p.h.

Referenced by QtPrivate::QAudioRingBuffer< SampleType >::consume().

+ Here is the caller graph for this function:

◆ releaseWriteRegion()

template<typename T>
void QtPrivate::QAudioRingBuffer< T >::releaseWriteRegion ( int elementsRead)
inline

Definition at line 114 of file qaudioringbuffer_p.h.

Referenced by QtPrivate::QAudioRingBuffer< SampleType >::write().

+ Here is the caller graph for this function:

◆ reset()

template<typename T>
void QtPrivate::QAudioRingBuffer< T >::reset ( )
inline

Definition at line 93 of file qaudioringbuffer_p.h.

◆ size()

template<typename T>
int QtPrivate::QAudioRingBuffer< T >::size ( ) const
inline

Definition at line 91 of file qaudioringbuffer_p.h.

◆ used()

template<typename T>
int QtPrivate::QAudioRingBuffer< T >::used ( ) const
inline

Definition at line 88 of file qaudioringbuffer_p.h.

◆ write()

template<typename T>
int QtPrivate::QAudioRingBuffer< T >::write ( ConstRegion region)
inline

Definition at line 44 of file qaudioringbuffer_p.h.

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