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
QtWASAPI::QWASAPIAudioSourceStream Struct Referencefinal

#include <qwindowsaudiosource_p.h>

Inheritance diagram for QtWASAPI::QWASAPIAudioSourceStream:
Collaboration diagram for QtWASAPI::QWASAPIAudioSourceStream:

Public Types

using SampleFormat = QAudioFormat::SampleFormat
using SourceType = QWindowsAudioSource
Public Types inherited from QtMultimediaPrivate::QPlatformAudioSourceStream
using AudioCallback = QPlatformAudioSource::AudioCallback
enum class  ShutdownPolicy

Public Member Functions

 QWASAPIAudioSourceStream (QAudioDevice, const QAudioFormat &, std::optional< qsizetype > ringbufferSize, QWindowsAudioSource *parent, float volume, std::optional< NativePeriodFrames > nativePeriodFrames)
 ~QWASAPIAudioSourceStream ()
bool open ()
bool start (QIODevice *)
QIODevice * start ()
bool start (AudioCallback &&)
void suspend ()
void resume ()
void stop (ShutdownPolicy)
void updateStreamIdle (bool) override
qsizetype bytesReady () const
bool deviceIsRingbufferReader () const
std::chrono::microseconds processedDuration () const
Public Member Functions inherited from QtMultimediaPrivate::QPlatformAudioSourceStream
void requestStop ()

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::QPlatformAudioSourceStream
 QPlatformAudioSourceStream (QAudioDevice, const QAudioFormat &, std::optional< int > ringbufferSize, std::optional< NativePeriodFrames > nativePeriodFrames, float volume)
 ~QPlatformAudioSourceStream ()
uint64_t process (QSpan< const std::byte > hostBuffer, qsizetype numberOfFrames, std::optional< NativeSampleFormat >={}) noexcept QT_MM_NONBLOCKING
qsizetype bytesReady () const
std::chrono::microseconds processedDuration () const
void setQIODevice (QIODevice *device)
void createQIODeviceConnections (QIODevice *device)
void disconnectQIODeviceConnections ()
QIODevice * createRingbufferReaderDevice ()
void pushToIODevice ()
bool deviceIsRingbufferReader () const
void finalizeQIODevice (ShutdownPolicy)
void emptyRingbuffer ()
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< 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
Static Protected Member Functions inherited from QtMultimediaPrivate::QPlatformAudioIOStream
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 Attributes inherited from QtMultimediaPrivate::QPlatformAudioIOStream
const QAudioDevice m_audioDevice
const QAudioFormat m_format
const std::optional< NativePeriodFrames > m_nativePeriodFrames

Detailed Description

Definition at line 41 of file qwindowsaudiosource_p.h.

Member Typedef Documentation

◆ SampleFormat

using QtWASAPI::QWASAPIAudioSourceStream::SampleFormat = QAudioFormat::SampleFormat

Definition at line 44 of file qwindowsaudiosource_p.h.

◆ SourceType

using QtWASAPI::QWASAPIAudioSourceStream::SourceType = QWindowsAudioSource

Definition at line 45 of file qwindowsaudiosource_p.h.

Constructor & Destructor Documentation

◆ QWASAPIAudioSourceStream()

QtWASAPI::QWASAPIAudioSourceStream::QWASAPIAudioSourceStream ( QAudioDevice device,
const QAudioFormat & format,
std::optional< qsizetype > ringbufferSize,
QWindowsAudioSource * parent,
float volume,
std::optional< NativePeriodFrames > nativePeriodFrames )

Definition at line 68 of file qwindowsaudiosource.cpp.

References QWASAPIAudioSourceStream().

Referenced by QWASAPIAudioSourceStream().

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

◆ ~QWASAPIAudioSourceStream()

QtWASAPI::QWASAPIAudioSourceStream::~QWASAPIAudioSourceStream ( )
default

Member Function Documentation

◆ bytesReady()

qsizetype QtMultimediaPrivate::QPlatformAudioSourceStream::bytesReady ( ) const

Definition at line 257 of file qaudiosystem_platform_stream_support.cpp.

◆ deviceIsRingbufferReader()

bool QtMultimediaPrivate::QPlatformAudioSourceStream::deviceIsRingbufferReader ( ) const

Definition at line 266 of file qaudiosystem_platform_stream_support.cpp.

◆ open()

bool QtWASAPI::QWASAPIAudioSourceStream::open ( )
inline

Definition at line 59 of file qwindowsaudiosource_p.h.

◆ processedDuration()

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

Definition at line 258 of file qaudiosystem_platform_stream_support.cpp.

◆ resume()

void QtWASAPI::QWASAPIAudioSourceStream::resume ( )

Definition at line 152 of file qwindowsaudiosource.cpp.

◆ start() [1/3]

QIODevice * QtWASAPI::QWASAPIAudioSourceStream::start ( )

Definition at line 110 of file qwindowsaudiosource.cpp.

◆ start() [2/3]

bool QtWASAPI::QWASAPIAudioSourceStream::start ( AudioCallback && cb)

Definition at line 131 of file qwindowsaudiosource.cpp.

◆ start() [3/3]

bool QtWASAPI::QWASAPIAudioSourceStream::start ( QIODevice * ioDevice)

Definition at line 94 of file qwindowsaudiosource.cpp.

◆ stop()

void QtWASAPI::QWASAPIAudioSourceStream::stop ( ShutdownPolicy shutdownPolicy)

Definition at line 158 of file qwindowsaudiosource.cpp.

◆ suspend()

void QtWASAPI::QWASAPIAudioSourceStream::suspend ( )

Definition at line 146 of file qwindowsaudiosource.cpp.

◆ updateStreamIdle()

void QtWASAPI::QWASAPIAudioSourceStream::updateStreamIdle ( bool streamIsIdle)
overridevirtual

Implements QtMultimediaPrivate::QPlatformAudioSourceStream.

Definition at line 175 of file qwindowsaudiosource.cpp.

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