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
QtOHAudio::QOhosAudioSinkStream Class Referencefinal

#include <qohosaudiosink_p.h>

Inheritance diagram for QtOHAudio::QOhosAudioSinkStream:
Collaboration diagram for QtOHAudio::QOhosAudioSinkStream:

Public Member Functions

 QOhosAudioSinkStream (QAudioDevice device, const QAudioFormat &formatformat, std::optional< qsizetype > ringbufferSize, QOhosAudioSink *parent, float volume, std::optional< QtMultimediaPrivate::NativePeriodFrames > hardwareBufferFrames, AudioEndpointRole role)
bool open ()
bool start (QIODevice *device)
QIODevice * start ()
bool start (AudioCallback cb)
void suspend ()
void resume ()
void stop (ShutdownPolicy policy)
quint64 bytesFree () const
std::chrono::microseconds processedDuration () const
Public Member Functions inherited from QtMultimediaPrivate::QPlatformAudioSinkStream
void requestStop ()

Private Member Functions

void updateStreamIdle (bool arg) override

Additional Inherited Members

Public Types inherited from QtMultimediaPrivate::QPlatformAudioSinkStream
using AudioCallback = QPlatformAudioSink::AudioCallback
enum class  ShutdownPolicy
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< NativePeriodFrames > nativePeriodFrames, float volume)
 ~QPlatformAudioSinkStream ()
uint64_t process (QSpan< std::byte > hostBuffer, qsizetype totalNumberOfFrames, std::optional< NativeSampleFormat >={}) noexcept Q_DECL_NONBLOCKING_FUNCTION
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 orderorder=std::memory_order_relaxed) const
void stopIdleDetection ()
template<typename Functor>
auto connectIdleHandler (Functor &&ff)
template<typename ParentType>
void handleIOError (ParentType *parent)
QThread * thread () const
template<typename Functor>
void invokeOnAppThread (Functor &&ff)
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 &&ff)
template<typename Functor>
auto visitRingbuffer (Functor &&ff) 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
Static Protected Attributes inherited from QtMultimediaPrivate::QPlatformAudioSinkStream
static constexpr int notificationThresholdBytes = 0

Detailed Description

Definition at line 30 of file qohosaudiosink_p.h.

Constructor & Destructor Documentation

◆ QOhosAudioSinkStream()

QtOHAudio::QOhosAudioSinkStream::QOhosAudioSinkStream ( QAudioDevice device,
const QAudioFormat & format,
std::optional< qsizetype > ringbufferSize,
QOhosAudioSink * parent,
float volume,
std::optional< QtMultimediaPrivate::NativePeriodFrames > hardwareBufferFrames,
AudioEndpointRole role )
explicit

Definition at line 16 of file qohosaudiosink.cpp.

Member Function Documentation

◆ bytesFree()

quint64 QtMultimediaPrivate::QPlatformAudioSinkStream::bytesFree ( ) const

Definition at line 137 of file qaudiosystem_platform_stream_support.cpp.

◆ open()

bool QtOHAudio::QOhosAudioSinkStream::open ( )

Definition at line 66 of file qohosaudiosink.cpp.

◆ processedDuration()

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

Definition at line 138 of file qaudiosystem_platform_stream_support.cpp.

◆ resume()

void QtOHAudio::QOhosAudioSinkStream::resume ( )

Definition at line 114 of file qohosaudiosink.cpp.

◆ start() [1/3]

QIODevice * QtOHAudio::QOhosAudioSinkStream::start ( )

Definition at line 90 of file qohosaudiosink.cpp.

◆ start() [2/3]

bool QtOHAudio::QOhosAudioSinkStream::start ( AudioCallback cb)

Definition at line 96 of file qohosaudiosink.cpp.

◆ start() [3/3]

bool QtOHAudio::QOhosAudioSinkStream::start ( QIODevice * device)

Definition at line 76 of file qohosaudiosink.cpp.

◆ stop()

void QtOHAudio::QOhosAudioSinkStream::stop ( ShutdownPolicy policy)

Definition at line 120 of file qohosaudiosink.cpp.

◆ suspend()

void QtOHAudio::QOhosAudioSinkStream::suspend ( )

Definition at line 108 of file qohosaudiosink.cpp.

◆ updateStreamIdle()

void QtOHAudio::QOhosAudioSinkStream::updateStreamIdle ( bool arg)
overrideprivatevirtual

Implements QtMultimediaPrivate::QPlatformAudioSinkStream.

Definition at line 165 of file qohosaudiosink.cpp.

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