Qt 6.x
The Qt SDK
Loading...
Searching...
No Matches
QPulseAudioSink Class Reference

#include <qpulseaudiosink_p.h>

+ Inheritance diagram for QPulseAudioSink:
+ Collaboration diagram for QPulseAudioSink:

Public Member Functions

 QPulseAudioSink (const QByteArray &device, QObject *parent)
 
 ~QPulseAudioSink ()
 
void start (QIODevice *device) override
 
QIODevicestart () override
 
void stop () override
 
void reset () override
 
void suspend () override
 
void resume () override
 
qsizetype bytesFree () const override
 
void setBufferSize (qsizetype value) override
 
qsizetype bufferSize () const override
 
qint64 processedUSecs () const override
 
QAudio::Error error () const override
 
QAudio::State state () const override
 
void setFormat (const QAudioFormat &format) override
 
QAudioFormat format () const override
 
void setVolume (qreal volume) override
 
qreal volume () const override
 
void streamUnderflowCallback ()
 
void streamDrainedCallback ()
 
- Public Member Functions inherited from QPlatformAudioSink
 QPlatformAudioSink (QObject *parent)
 
virtual void start (QIODevice *device)=0
 
virtual QIODevicestart ()=0
 
virtual void stop ()=0
 
virtual void reset ()=0
 
virtual void suspend ()=0
 
virtual void resume ()=0
 
virtual qsizetype bytesFree () const =0
 
virtual void setBufferSize (qsizetype value)=0
 
virtual qsizetype bufferSize () const =0
 
virtual qint64 processedUSecs () const =0
 
virtual QAudio::Error error () const =0
 
virtual QAudio::State state () const =0
 
virtual void setFormat (const QAudioFormat &fmt)=0
 
virtual QAudioFormat format () const =0
 
virtual void setVolume (qreal)
 
virtual qreal volume () const
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QStringbindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThreadthread () const
 Returns the thread in which the object lives.
 
void moveToThread (QThread *thread)
 Changes the thread affinity for this object and its children.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
template<typename T >
findChild (const QString &aName=QString(), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (const QString &aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectListchildren () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 

Protected Member Functions

void timerEvent (QTimerEvent *event) override
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
- Protected Member Functions inherited from QObject
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 

Friends

class PulseOutputPrivate
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Signals inherited from QPlatformAudioSink
void errorChanged (QAudio::Error error)
 
void stateChanged (QAudio::State state)
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 
- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 
- Public Attributes inherited from QPlatformAudioSink
QElapsedTimer elapsedTime
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Detailed Description

Definition at line 36 of file qpulseaudiosink_p.h.

Constructor & Destructor Documentation

◆ QPulseAudioSink()

QPulseAudioSink::QPulseAudioSink ( const QByteArray device,
QObject parent 
)

Definition at line 115 of file qpulseaudiosink.cpp.

◆ ~QPulseAudioSink()

QPulseAudioSink::~QPulseAudioSink ( )

Definition at line 121 of file qpulseaudiosink.cpp.

References QCoreApplication::processEvents().

+ Here is the call graph for this function:

Member Function Documentation

◆ bufferSize()

qsizetype QPulseAudioSink::bufferSize ( ) const
overridevirtual

Implements QPlatformAudioSink.

Definition at line 526 of file qpulseaudiosink.cpp.

◆ bytesFree()

qsizetype QPulseAudioSink::bytesFree ( ) const
overridevirtual

Implements QPlatformAudioSink.

Definition at line 511 of file qpulseaudiosink.cpp.

References QAudio::ActiveState, QAudio::IdleState, QPulseAudioEngine::instance(), lock, and state().

+ Here is the call graph for this function:

◆ error()

QAudio::Error QPulseAudioSink::error ( ) const
overridevirtual

Implements QPlatformAudioSink.

Definition at line 127 of file qpulseaudiosink.cpp.

◆ format()

QAudioFormat QPulseAudioSink::format ( ) const
overridevirtual

Implements QPlatformAudioSink.

Definition at line 627 of file qpulseaudiosink.cpp.

Referenced by setFormat().

+ Here is the caller graph for this function:

◆ processedUSecs()

qint64 QPulseAudioSink::processedUSecs ( ) const
overridevirtual

Implements QPlatformAudioSink.

Definition at line 537 of file qpulseaudiosink.cpp.

References QList< T >::append(), info, QList< T >::pop_front(), QList< T >::size(), state(), QAudio::StoppedState, and QAudio::SuspendedState.

+ Here is the call graph for this function:

◆ reset()

void QPulseAudioSink::reset ( )
overridevirtual

Implements QPlatformAudioSink.

Definition at line 651 of file qpulseaudiosink.cpp.

References stop().

+ Here is the call graph for this function:

◆ resume()

void QPulseAudioSink::resume ( )
overridevirtual

Implements QPlatformAudioSink.

Definition at line 598 of file qpulseaudiosink.cpp.

References QPulseAudioEngine::instance(), lock, QAudio::NoError, outputStreamSuccessCallback(), QBasicTimer::start(), QAudio::SuspendedState, and QPulseAudioEngine::wait().

+ Here is the call graph for this function:

◆ setBufferSize()

void QPulseAudioSink::setBufferSize ( qsizetype  value)
overridevirtual

Implements QPlatformAudioSink.

Definition at line 521 of file qpulseaudiosink.cpp.

◆ setFormat()

void QPulseAudioSink::setFormat ( const QAudioFormat format)
overridevirtual

Implements QPlatformAudioSink.

Definition at line 622 of file qpulseaudiosink.cpp.

References format().

+ Here is the call graph for this function:

◆ setVolume()

void QPulseAudioSink::setVolume ( qreal  volume)
overridevirtual

Reimplemented from QPlatformAudioSink.

Definition at line 686 of file qpulseaudiosink.cpp.

References qBound(), and qFuzzyCompare().

+ Here is the call graph for this function:

◆ start() [1/2]

QIODevice * QPulseAudioSink::start ( )
overridevirtual

Implements QPlatformAudioSink.

Definition at line 199 of file qpulseaudiosink.cpp.

References QAudio::IdleState, QAudio::NoError, QIODevice::open(), PulseOutputPrivate, QAudio::StoppedState, QIODeviceBase::Unbuffered, and QIODeviceBase::WriteOnly.

+ Here is the call graph for this function:

◆ start() [2/2]

void QPulseAudioSink::start ( QIODevice device)
overridevirtual

Implements QPlatformAudioSink.

Definition at line 171 of file qpulseaudiosink.cpp.

References QAudio::ActiveState, QObject::connect(), device, QAudio::NoError, QIODevice::readyRead(), and QAudio::StoppedState.

+ Here is the call graph for this function:

◆ state()

QAudio::State QPulseAudioSink::state ( ) const
overridevirtual

Implements QPlatformAudioSink.

Definition at line 147 of file qpulseaudiosink.cpp.

Referenced by bytesFree(), processedUSecs(), suspend(), and PulseOutputPrivate::writeData().

+ Here is the caller graph for this function:

◆ stop()

void QPulseAudioSink::stop ( )
overridevirtual

Implements QPlatformAudioSink.

Definition at line 501 of file qpulseaudiosink.cpp.

References QAudio::NoError, and QAudio::StoppedState.

Referenced by reset().

+ Here is the caller graph for this function:

◆ streamDrainedCallback()

void QPulseAudioSink::streamDrainedCallback ( )

Definition at line 163 of file qpulseaudiosink.cpp.

References QAudio::IdleState, and QAudio::NoError.

◆ streamUnderflowCallback()

void QPulseAudioSink::streamUnderflowCallback ( )

Definition at line 152 of file qpulseaudiosink.cpp.

References QIODevice::atEnd(), QAudio::IdleState, outputStreamDrainComplete(), qCDebug, and QAudio::UnderrunError.

+ Here is the call graph for this function:

◆ suspend()

void QPulseAudioSink::suspend ( )
overridevirtual

Implements QPlatformAudioSink.

Definition at line 632 of file qpulseaudiosink.cpp.

References QAudio::ActiveState, QAudio::IdleState, QPulseAudioEngine::instance(), lock, QAudio::NoError, outputStreamSuccessCallback(), state(), QBasicTimer::stop(), QAudio::SuspendedState, and QPulseAudioEngine::wait().

+ Here is the call graph for this function:

◆ timerEvent()

void QPulseAudioSink::timerEvent ( QTimerEvent event)
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive timer events for the object.

QTimer provides a higher-level interface to the timer functionality, and also more general information about timers. The timer event is passed in the event parameter.

See also
startTimer(), killTimer(), event()

Reimplemented from QObject.

Definition at line 400 of file qpulseaudiosink.cpp.

References QObject::timerEvent(), and QBasicTimer::timerId().

+ Here is the call graph for this function:

◆ volume()

qreal QPulseAudioSink::volume ( ) const
overridevirtual

Reimplemented from QPlatformAudioSink.

Definition at line 694 of file qpulseaudiosink.cpp.

Friends And Related Symbol Documentation

◆ PulseOutputPrivate

friend class PulseOutputPrivate
friend

Definition at line 38 of file qpulseaudiosink_p.h.

Referenced by start().


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