Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QPulseAudioSource Class Reference

#include <qpulseaudiosource_p.h>

+ Inheritance diagram for QPulseAudioSource:
+ Collaboration diagram for QPulseAudioSource:

Public Member Functions

 QPulseAudioSource (const QByteArray &device, QObject *parent)
 
 ~QPulseAudioSource ()
 
qint64 read (char *data, qint64 len)
 
void start (QIODevice *device) override
 
QIODevicestart () override
 
void stop () override
 
void reset () override
 
void suspend () override
 
void resume () override
 
qsizetype bytesReady () 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
 
- Public Member Functions inherited from QPlatformAudioSource
 QPlatformAudioSource (QObject *parent)
 
- Public Member Functions inherited from QAudioStateChangeNotifier
 QAudioStateChangeNotifier (QObject *parent=nullptr)
 
- 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.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
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::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
findChild (QAnyStringView aName, 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 (QAnyStringView 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 >
findChild (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.
 
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.
 

Public Attributes

qint64 m_totalTimeValue
 
QIODevicem_audioSource
 
QAudioFormat m_format
 
qreal m_volume
 
- Public Attributes inherited from QPlatformAudioSource
QElapsedTimer elapsedTime
 

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 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)
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Signals inherited from QAudioStateChangeNotifier
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)
 
- 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 qpulseaudiosource_p.h.

Constructor & Destructor Documentation

◆ QPulseAudioSource()

QPulseAudioSource::QPulseAudioSource ( const QByteArray & device,
QObject * parent )

Definition at line 94 of file qpulseaudiosource.cpp.

◆ ~QPulseAudioSource()

QPulseAudioSource::~QPulseAudioSource ( )

Definition at line 110 of file qpulseaudiosource.cpp.

References notifier, and QAudioStateMachine::stop().

+ Here is the call graph for this function:

Member Function Documentation

◆ bufferSize()

qsizetype QPulseAudioSource::bufferSize ( ) const
overridevirtual

Implements QPlatformAudioSource.

Definition at line 470 of file qpulseaudiosource.cpp.

◆ bytesReady()

qsizetype QPulseAudioSource::bytesReady ( ) const
overridevirtual

Implements QPlatformAudioSource.

Definition at line 314 of file qpulseaudiosource.cpp.

References QPulseAudioEngine::instance(), QAudioStateMachine::isActiveOrIdle(), lock, and qWarning.

+ Here is the call graph for this function:

◆ error()

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

Implements QPlatformAudioSource.

Definition at line 117 of file qpulseaudiosource.cpp.

References QAudioStateMachine::error().

+ Here is the call graph for this function:

◆ format()

QAudioFormat QPulseAudioSource::format ( ) const
overridevirtual

Implements QPlatformAudioSource.

Definition at line 133 of file qpulseaudiosource.cpp.

References m_format.

Referenced by inputStreamStateCallback(), and setFormat().

+ Here is the caller graph for this function:

◆ processedUSecs()

qint64 QPulseAudioSource::processedUSecs ( ) const
overridevirtual

Implements QPlatformAudioSource.

Definition at line 475 of file qpulseaudiosource.cpp.

References Q_UNUSED.

◆ read()

qint64 QPulseAudioSource::read ( char * data,
qint64 len )

Definition at line 332 of file qpulseaudiosource.cpp.

References QByteArray::clear(), QByteArray::constData(), QByteArray::data(), QPulseAudioEngine::instance(), QMetaObject::invokeMethod(), QByteArray::isEmpty(), QPulseAudioEngine::lock(), m_audioSource, m_totalTimeValue, QAudio::NoError, Q_ASSERT, Q_UNLIKELY, qCDebug, qMin(), QtDebugMsg, Qt::QueuedConnection, qWarning, QByteArray::remove(), QByteArray::resize(), QByteArray::size(), QAudio::UnderrunError, Qt::Uninitialized, QPulseAudioEngine::unlock(), QAudioStateMachine::updateActiveOrIdle(), and QIODevice::write().

Referenced by PulseInputPrivate::readData().

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

◆ reset()

void QPulseAudioSource::reset ( )
overridevirtual

Implements QPlatformAudioSource.

Definition at line 530 of file qpulseaudiosource.cpp.

References notifier, and QAudioStateMachine::stopOrUpdateError().

Referenced by start(), and start().

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

◆ resume()

void QPulseAudioSource::resume ( )
overridevirtual

Implements QPlatformAudioSource.

Definition at line 435 of file qpulseaudiosource.cpp.

References inputStreamSuccessCallback(), QPulseAudioEngine::instance(), lock, notifier, QAudioStateMachine::resume(), QBasicTimer::start(), and QPulseAudioEngine::wait().

+ Here is the call graph for this function:

◆ setBufferSize()

void QPulseAudioSource::setBufferSize ( qsizetype value)
overridevirtual

Implements QPlatformAudioSource.

Definition at line 465 of file qpulseaudiosource.cpp.

◆ setFormat()

void QPulseAudioSource::setFormat ( const QAudioFormat & format)
overridevirtual

Implements QPlatformAudioSource.

Definition at line 127 of file qpulseaudiosource.cpp.

References format(), QAudioStateMachine::isActiveOrIdle(), and m_format.

+ Here is the call graph for this function:

◆ setVolume()

void QPulseAudioSource::setVolume ( qreal volume)
overridevirtual

Implements QPlatformAudioSource.

Definition at line 452 of file qpulseaudiosource.cpp.

References m_volume, qBound(), and qFuzzyCompare().

+ Here is the call graph for this function:

◆ start() [1/2]

QIODevice * QPulseAudioSource::start ( )
overridevirtual

Implements QPlatformAudioSource.

Definition at line 151 of file qpulseaudiosource.cpp.

References m_audioSource, QIODevice::open(), QIODeviceBase::ReadOnly, reset(), QAudioStateMachine::start(), and QIODeviceBase::Unbuffered.

+ Here is the call graph for this function:

◆ start() [2/2]

void QPulseAudioSource::start ( QIODevice * device)
overridevirtual

Implements QPlatformAudioSource.

Definition at line 138 of file qpulseaudiosource.cpp.

References device, m_audioSource, reset(), and QAudioStateMachine::start().

+ Here is the call graph for this function:

◆ state()

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

Implements QPlatformAudioSource.

Definition at line 122 of file qpulseaudiosource.cpp.

References QAudioStateMachine::state().

+ Here is the call graph for this function:

◆ stop()

void QPulseAudioSource::stop ( )
overridevirtual

Implements QPlatformAudioSource.

Definition at line 167 of file qpulseaudiosource.cpp.

References notifier, and QAudioStateMachine::stop().

+ Here is the call graph for this function:

◆ suspend()

void QPulseAudioSource::suspend ( )
overridevirtual

Implements QPlatformAudioSource.

Definition at line 488 of file qpulseaudiosource.cpp.

References inputStreamSuccessCallback(), QPulseAudioEngine::instance(), lock, notifier, QBasicTimer::stop(), QAudioStateMachine::suspend(), and QPulseAudioEngine::wait().

+ Here is the call graph for this function:

◆ timerEvent()

void QPulseAudioSource::timerEvent ( QTimerEvent * event)
overrideprotectedvirtual

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

QChronoTimer provides higher-level interfaces 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 502 of file qpulseaudiosource.cpp.

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

+ Here is the call graph for this function:

◆ volume()

qreal QPulseAudioSource::volume ( ) const
overridevirtual

Implements QPlatformAudioSource.

Definition at line 460 of file qpulseaudiosource.cpp.

References m_volume.

Member Data Documentation

◆ m_audioSource

QIODevice* QPulseAudioSource::m_audioSource

Definition at line 65 of file qpulseaudiosource_p.h.

Referenced by read(), start(), and start().

◆ m_format

QAudioFormat QPulseAudioSource::m_format

Definition at line 66 of file qpulseaudiosource_p.h.

Referenced by format(), and setFormat().

◆ m_totalTimeValue

qint64 QPulseAudioSource::m_totalTimeValue

Definition at line 64 of file qpulseaudiosource_p.h.

Referenced by read().

◆ m_volume

qreal QPulseAudioSource::m_volume

Definition at line 67 of file qpulseaudiosource_p.h.

Referenced by setVolume(), and volume().


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