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
QPlatformAudioIOStream Class Reference

#include <qaudiosystem_platform_stream_support_p.h>

Inheritance diagram for QPlatformAudioIOStream:
Collaboration diagram for QPlatformAudioIOStream:

Public Types

enum class  ShutdownPolicy : uint8_t { DrainRingbuffer , DiscardRingbuffer }

Static Public Member Functions

static qsizetype inferRingbufferFrames (const std::optional< int > &ringbufferSize, const std::optional< NativePeriodFrames > &nativePeriodFrames, const QAudioFormat &)
static qsizetype inferRingbufferBytes (const std::optional< int > &ringbufferSize, const std::optional< NativePeriodFrames > &nativePeriodFrames, const QAudioFormat &)

Protected Types

using NativeSampleFormat = QAudioHelperInternal::NativeSampleFormat
using QAutoResetEvent = QtPrivate::QAutoResetEvent

Protected Member Functions

 QPlatformAudioIOStream (QAudioDevice m_audioDevice, QAudioFormat m_format, std::optional< int > ringbufferSize, std::optional< NativePeriodFrames > nativePeriodFrames, float volume)
 ~QPlatformAudioIOStream ()
void setVolume (float)
float volume () const
template<typename Functor>
auto visitRingbuffer (Functor &&f)
template<typename Functor>
auto visitRingbuffer (Functor &&f) const
void prepareRingbuffer (std::optional< int > ringbufferSize)
int ringbufferSizeInBytes ()
void requestStop ()
bool isStopRequested (std::memory_order memory_order=std::memory_order_relaxed) const

Protected Attributes

const QAudioDevice m_audioDevice
const QAudioFormat m_format
const std::optional< NativePeriodFrames > m_nativePeriodFrames

Detailed Description

Definition at line 40 of file qaudiosystem_platform_stream_support_p.h.

Member Typedef Documentation

◆ NativeSampleFormat

using QtMultimediaPrivate::QPlatformAudioIOStream::NativeSampleFormat = QAudioHelperInternal::NativeSampleFormat
protected

Definition at line 57 of file qaudiosystem_platform_stream_support_p.h.

◆ QAutoResetEvent

using QtMultimediaPrivate::QPlatformAudioIOStream::QAutoResetEvent = QtPrivate::QAutoResetEvent
protected

Definition at line 58 of file qaudiosystem_platform_stream_support_p.h.

Member Enumeration Documentation

◆ ShutdownPolicy

enum class QtMultimediaPrivate::QPlatformAudioIOStream::ShutdownPolicy : uint8_t
strong
Enumerator
DrainRingbuffer 
DiscardRingbuffer 

Definition at line 110 of file qaudiosystem_platform_stream_support_p.h.

Constructor & Destructor Documentation

◆ QPlatformAudioIOStream()

QtMultimediaPrivate::QPlatformAudioIOStream::QPlatformAudioIOStream ( QAudioDevice m_audioDevice,
QAudioFormat m_format,
std::optional< int > ringbufferSize,
std::optional< NativePeriodFrames > nativePeriodFrames,
float volume )
protected

Definition at line 16 of file qaudiosystem_platform_stream_support.cpp.

◆ ~QPlatformAudioIOStream()

QtMultimediaPrivate::QPlatformAudioIOStream::~QPlatformAudioIOStream ( )
protected

Definition at line 36 of file qaudiosystem_platform_stream_support.cpp.

Member Function Documentation

◆ inferRingbufferBytes()

qsizetype QtMultimediaPrivate::QPlatformAudioIOStream::inferRingbufferBytes ( const std::optional< int > & ringbufferSize,
const std::optional< NativePeriodFrames > & nativePeriodFrames,
const QAudioFormat & format )
static

Definition at line 91 of file qaudiosystem_platform_stream_support.cpp.

◆ inferRingbufferFrames()

qsizetype QtMultimediaPrivate::QPlatformAudioIOStream::inferRingbufferFrames ( const std::optional< int > & ringbufferSize,
const std::optional< NativePeriodFrames > & nativePeriodFrames,
const QAudioFormat & format )
static

Definition at line 80 of file qaudiosystem_platform_stream_support.cpp.

◆ isStopRequested()

bool QtMultimediaPrivate::QPlatformAudioIOStream::isStopRequested ( std::memory_order memory_order = std::memory_order_relaxed) const
inlineprotected

Definition at line 86 of file qaudiosystem_platform_stream_support_p.h.

◆ prepareRingbuffer()

void QtMultimediaPrivate::QPlatformAudioIOStream::prepareRingbuffer ( std::optional< int > ringbufferSize)
protected

Definition at line 46 of file qaudiosystem_platform_stream_support.cpp.

◆ requestStop()

void QtMultimediaPrivate::QPlatformAudioIOStream::requestStop ( )
protected

Definition at line 74 of file qaudiosystem_platform_stream_support.cpp.

◆ ringbufferSizeInBytes()

int QtMultimediaPrivate::QPlatformAudioIOStream::ringbufferSizeInBytes ( )
protected

Definition at line 109 of file qaudiosystem_platform_stream_support.cpp.

◆ setVolume()

void QtMultimediaPrivate::QPlatformAudioIOStream::setVolume ( float volume)
protected

Definition at line 41 of file qaudiosystem_platform_stream_support.cpp.

◆ visitRingbuffer() [1/2]

template<typename Functor>
auto QtMultimediaPrivate::QPlatformAudioIOStream::visitRingbuffer ( Functor && f)
inlineprotected

Definition at line 70 of file qaudiosystem_platform_stream_support_p.h.

◆ visitRingbuffer() [2/2]

template<typename Functor>
auto QtMultimediaPrivate::QPlatformAudioIOStream::visitRingbuffer ( Functor && f) const
inlineprotected

Definition at line 76 of file qaudiosystem_platform_stream_support_p.h.

◆ volume()

float QtMultimediaPrivate::QPlatformAudioIOStream::volume ( ) const
inlineprotected

Definition at line 67 of file qaudiosystem_platform_stream_support_p.h.

Member Data Documentation

◆ m_audioDevice

const QAudioDevice QtMultimediaPrivate::QPlatformAudioIOStream::m_audioDevice
protected

Definition at line 92 of file qaudiosystem_platform_stream_support_p.h.

◆ m_format

const QAudioFormat QtMultimediaPrivate::QPlatformAudioIOStream::m_format
protected

Definition at line 93 of file qaudiosystem_platform_stream_support_p.h.

◆ m_nativePeriodFrames

const std::optional<NativePeriodFrames> QtMultimediaPrivate::QPlatformAudioIOStream::m_nativePeriodFrames
protected

Definition at line 94 of file qaudiosystem_platform_stream_support_p.h.

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