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
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)
 ~QAudioRingBuffer ()
int write (ConstRegion region)
bool write (T element)
template<typename Functor>
bool produceOne (Functor &&producer)
template<typename Functor>
int produceSome (Functor &&producer, int elements=std::numeric_limits< int >::max())
template<typename Functor>
int consumeAll (Functor &&consumer)
template<typename Functor>
int consume (int elements, Functor &&consumer)
template<typename Functor>
int consumeSome (Functor &&consumer, int elements=std::numeric_limits< int >::max())
int used () const
int free () const
int size () const
void reset ()

Detailed Description

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

Definition at line 34 of file qaudioringbuffer_p.h.

Member Typedef Documentation

◆ ConstRegion

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

Definition at line 41 of file qaudioringbuffer_p.h.

◆ Region

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

Definition at line 40 of file qaudioringbuffer_p.h.

◆ ValueType

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

Definition at line 39 of file qaudioringbuffer_p.h.

Constructor & Destructor Documentation

◆ QAudioRingBuffer()

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

Definition at line 43 of file qaudioringbuffer_p.h.

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

Here is the caller graph for this function:

◆ ~QAudioRingBuffer()

template<typename T>
QtPrivate::QAudioRingBuffer< T >::~QAudioRingBuffer ( )
inline

Definition at line 52 of file qaudioringbuffer_p.h.

Member Function Documentation

◆ consume()

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

Definition at line 138 of file qaudioringbuffer_p.h.

◆ consumeAll()

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

Definition at line 129 of file qaudioringbuffer_p.h.

◆ consumeSome()

template<typename T>
template<typename Functor>
int QtPrivate::QAudioRingBuffer< T >::consumeSome ( Functor && consumer,
int elements = std::numeric_limits<int>::max() )
inline

Definition at line 154 of file qaudioringbuffer_p.h.

◆ free()

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

Definition at line 185 of file qaudioringbuffer_p.h.

◆ produceOne()

template<typename T>
template<typename Functor>
bool QtPrivate::QAudioRingBuffer< T >::produceOne ( Functor && producer)
inline

Definition at line 85 of file qaudioringbuffer_p.h.

◆ produceSome()

template<typename T>
template<typename Functor>
int QtPrivate::QAudioRingBuffer< T >::produceSome ( Functor && producer,
int elements = std::numeric_limits<int>::max() )
inline

Definition at line 101 of file qaudioringbuffer_p.h.

◆ reset()

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

Definition at line 189 of file qaudioringbuffer_p.h.

◆ size()

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

Definition at line 187 of file qaudioringbuffer_p.h.

◆ used()

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

Definition at line 184 of file qaudioringbuffer_p.h.

◆ write() [1/2]

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

Definition at line 62 of file qaudioringbuffer_p.h.

◆ write() [2/2]

template<typename T>
bool QtPrivate::QAudioRingBuffer< T >::write ( T element)
inline

Definition at line 77 of file qaudioringbuffer_p.h.

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