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
QPulseAudioInternal::QPulseAudioSinkStream Struct Referencefinal

#include <qpulseaudiosink_p.h>

Inheritance diagram for QPulseAudioInternal::QPulseAudioSinkStream:
Collaboration diagram for QPulseAudioInternal::QPulseAudioSinkStream:

Public Types

using SinkType = QPulseAudioSink
Public Types inherited from QtMultimediaPrivate::QPlatformAudioSinkStream
using AudioCallback = QPlatformAudioSink::AudioCallback
enum class  ShutdownPolicy

Public Member Functions

 QPulseAudioSinkStream (QAudioDevice, const QAudioFormat &format, std::optional< qsizetype > ringbufferSize, QPulseAudioSink *parent, float volume, std::optional< int32_t > hardwareBufferSize, AudioEndpointRole)
 ~QPulseAudioSinkStream ()
bool start (QIODevice *device)
bool start (AudioCallback &&)
QIODevice * start ()
void stop (ShutdownPolicy)
void stop ()
void reset ()
void suspend ()
void resume ()
bool open () const
quint64 bytesFree () const
std::chrono::microseconds processedDuration () const

Private Member Functions

void updateStreamIdle (bool) override

Additional Inherited Members

Protected Types inherited from QtMultimediaPrivate::QPlatformAudioIOStream
using NativeSampleFormat = QAudioHelperInternal::NativeSampleFormat
using QAutoResetEvent = QtPrivate::QAutoResetEvent
enum class  ShutdownPolicy : uint8_t { DrainRingbuffer , DiscardRingbuffer }
Protected Member Functions inherited from QtMultimediaPrivate::QPlatformAudioSinkStream
 QPlatformAudioSinkStream (QAudioDevice, const QAudioFormat &, std::optional< int > ringbufferSize, std::optional< int32_t > hardwareBufferFrames, float volume)
 ~QPlatformAudioSinkStream ()
uint64_t process (QSpan< std::byte > hostBuffer, qsizetype totalNumberOfFrames, std::optional< NativeSampleFormat >={}) noexcept QT_MM_NONBLOCKING
quint64 bytesFree () const
std::chrono::microseconds processedDuration () const
QIODevice * createRingbufferWriterDevice ()
void setQIODevice (QIODevice *device)
void createQIODeviceConnections (QIODevice *device)
void disconnectQIODeviceConnections ()
void pullFromQIODevice ()
void setIdleState (bool)
bool isIdle (std::memory_order order=std::memory_order_relaxed) const
void stopIdleDetection ()
template<typename Functor>
auto connectIdleHandler (Functor &&f)
template<typename ParentType>
void handleIOError (ParentType *parent)
QThread * thread () const
template<typename Functor>
void invokeOnAppThread (Functor &&f)
Protected Member Functions inherited from QtMultimediaPrivate::QPlatformAudioIOStream
 QPlatformAudioIOStream (QAudioDevice m_audioDevice, QAudioFormat m_format, std::optional< int > ringbufferSize, std::optional< int32_t > hardwareBufferFrames, 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
Static Protected Member Functions inherited from QtMultimediaPrivate::QPlatformAudioIOStream
static qsizetype inferRingbufferFrames (const std::optional< int > &ringbufferSize, const std::optional< int32_t > &hardwareBufferFrames, const QAudioFormat &)
static qsizetype inferRingbufferBytes (const std::optional< int > &ringbufferSize, const std::optional< int32_t > &hardwareBufferFrames, const QAudioFormat &)
Protected Attributes inherited from QtMultimediaPrivate::QPlatformAudioIOStream
const QAudioDevice m_audioDevice
const QAudioFormat m_format
const std::optional< int32_t > m_hardwareBufferFrames
Static Protected Attributes inherited from QtMultimediaPrivate::QPlatformAudioSinkStream
static constexpr int notificationThresholdBytes = 0

Detailed Description

Definition at line 33 of file qpulseaudiosink_p.h.

Member Typedef Documentation

◆ SinkType

using QPulseAudioInternal::QPulseAudioSinkStream::SinkType = QPulseAudioSink

Definition at line 35 of file qpulseaudiosink_p.h.

Constructor & Destructor Documentation

◆ QPulseAudioSinkStream()

QPulseAudioInternal::QPulseAudioSinkStream::QPulseAudioSinkStream ( QAudioDevice device,
const QAudioFormat & format,
std::optional< qsizetype > ringbufferSize,
QPulseAudioSink * parent,
float volume,
std::optional< int32_t > hardwareBufferSize,
AudioEndpointRole role )

Definition at line 19 of file qpulseaudiosink.cpp.

References QPulseAudioSinkStream().

Referenced by QPulseAudioSinkStream().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ~QPulseAudioSinkStream()

QPulseAudioInternal::QPulseAudioSinkStream::~QPulseAudioSinkStream ( )
default

Member Function Documentation

◆ bytesFree()

quint64 QtMultimediaPrivate::QPlatformAudioSinkStream::bytesFree ( ) const

Definition at line 136 of file qaudiosystem_platform_stream_support.cpp.

◆ open()

bool QPulseAudioInternal::QPulseAudioSinkStream::open ( ) const

Definition at line 181 of file qpulseaudiosink.cpp.

◆ processedDuration()

std::chrono::microseconds QtMultimediaPrivate::QPlatformAudioSinkStream::processedDuration ( ) const

Definition at line 137 of file qaudiosystem_platform_stream_support.cpp.

◆ reset()

void QPulseAudioInternal::QPulseAudioSinkStream::reset ( )
inline

Definition at line 53 of file qpulseaudiosink_p.h.

◆ resume()

void QPulseAudioInternal::QPulseAudioSinkStream::resume ( )

Definition at line 173 of file qpulseaudiosink.cpp.

◆ start() [1/3]

QIODevice * QPulseAudioInternal::QPulseAudioSinkStream::start ( )

Definition at line 103 of file qpulseaudiosink.cpp.

◆ start() [2/3]

bool QPulseAudioInternal::QPulseAudioSinkStream::start ( AudioCallback && callback)

Definition at line 95 of file qpulseaudiosink.cpp.

◆ start() [3/3]

bool QPulseAudioInternal::QPulseAudioSinkStream::start ( QIODevice * device)

Definition at line 84 of file qpulseaudiosink.cpp.

◆ stop() [1/2]

void QPulseAudioInternal::QPulseAudioSinkStream::stop ( )
inline

Definition at line 52 of file qpulseaudiosink_p.h.

◆ stop() [2/2]

void QPulseAudioInternal::QPulseAudioSinkStream::stop ( ShutdownPolicy policy)

Definition at line 115 of file qpulseaudiosink.cpp.

◆ suspend()

void QPulseAudioInternal::QPulseAudioSinkStream::suspend ( )

Definition at line 165 of file qpulseaudiosink.cpp.

◆ updateStreamIdle()

void QPulseAudioInternal::QPulseAudioSinkStream::updateStreamIdle ( bool idle)
overrideprivatevirtual

Implements QtMultimediaPrivate::QPlatformAudioSinkStream.

Definition at line 273 of file qpulseaudiosink.cpp.

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