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
QtMultimediaPrivate::QPlatformAudioSinkImplementation< STREAM_TYPE_ARG, DerivedType > Class Template Reference

#include <qaudio_platform_implementation_support_p.h>

Inheritance diagram for QtMultimediaPrivate::QPlatformAudioSinkImplementation< STREAM_TYPE_ARG, DerivedType >:
Collaboration diagram for QtMultimediaPrivate::QPlatformAudioSinkImplementation< STREAM_TYPE_ARG, DerivedType >:

Public Member Functions

 QPlatformAudioSinkImplementation (QAudioDevice device, const QAudioFormat &format, QObject *parent)
 ~QPlatformAudioSinkImplementation () override
void start (QIODevice *device) override
void start (AudioCallback &&) override
QIODevicestart () override
void stop () override final
void reset () override
void suspend () override
void resume () override
qsizetype bytesFree () const override
void setBufferSize (qsizetype value) override
qsizetype bufferSize () const override
void setHardwareBufferFrames (int32_t) override
int32_t hardwareBufferFrames () override
qint64 processedUSecs () const override
void setVolume (float volume) override
bool hasCallbackAPI () override
void setRole (AudioEndpointRole role) override
Public Member Functions inherited from QPlatformAudioSink
 QPlatformAudioSink (QAudioDevice, const QAudioFormat &, QObject *parent)
Public Member Functions inherited from QPlatformAudioEndpointBase
 QPlatformAudioEndpointBase (QAudioDevice, const QAudioFormat &, QObject *parent)
QAudio::Error error () const
virtual QAudio::State state () const
virtual void setError (QAudio::Error)
virtual bool isFormatSupported (const QAudioFormat &format) const
QAudioFormat format () const
float 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 isQmlObjectType () const
 Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
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.

Protected Types

using ShutdownPolicy = QPlatformAudioIOStream::ShutdownPolicy
using ConcreteSinkType
Protected Types inherited from QPlatformAudioEndpointBase
enum class  EmitStateSignal : uint8_t { True , False }

Protected Attributes

friend StreamType
std::optional< int > m_internalBufferSize
std::optional< int32_t > m_hardwareBufferFrames
AudioEndpointRole m_role = AudioEndpointRole::Other
std::shared_ptr< StreamTypem_stream
Protected Attributes inherited from QPlatformAudioEndpointBase
const QAudioDevice m_audioDevice
const QAudioFormat m_format
Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr

Friends

class QtMultimediaPrivate::QPlatformAudioSinkStream

Additional Inherited Members

Public Types inherited from QPlatformAudioSink
using AudioCallback = QtMultimediaPrivate::AudioSinkCallback
using AudioEndpointRole = QtMultimediaPrivate::AudioEndpointRole
Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
Signals inherited from QPlatformAudioEndpointBase
void stateChanged (QtAudio::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 QPlatformAudioSink
static QPlatformAudioSinkget (const QAudioSink &)
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 Member Functions inherited from QPlatformAudioEndpointBase
void updateStreamState (QAudio::State)
void updateStreamIdle (bool idle, EmitStateSignal=EmitStateSignal::True)
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)
Properties inherited from QObject
QString objectName
 the name of this object

Detailed Description

template<STREAM_TYPE_ARG, typename DerivedType = void>
class QtMultimediaPrivate::QPlatformAudioSinkImplementation< STREAM_TYPE_ARG, DerivedType >

Definition at line 70 of file qaudio_platform_implementation_support_p.h.

Member Typedef Documentation

◆ ConcreteSinkType

template<STREAM_TYPE_ARG, typename DerivedType = void>
using QtMultimediaPrivate::QPlatformAudioSinkImplementation< STREAM_TYPE_ARG, DerivedType >::ConcreteSinkType
protected
Initial value:
std::conditional_t<std::is_same_v<DerivedType, void>,
QPlatformAudioSinkImplementation(QAudioDevice device, const QAudioFormat &format, QObject *parent)

Definition at line 109 of file qaudio_platform_implementation_support_p.h.

◆ ShutdownPolicy

template<STREAM_TYPE_ARG, typename DerivedType = void>
using QtMultimediaPrivate::QPlatformAudioSinkImplementation< STREAM_TYPE_ARG, DerivedType >::ShutdownPolicy = QPlatformAudioIOStream::ShutdownPolicy
protected

Definition at line 101 of file qaudio_platform_implementation_support_p.h.

Constructor & Destructor Documentation

◆ QPlatformAudioSinkImplementation()

template<STREAM_TYPE_ARG, typename DerivedType>
QtMultimediaPrivate::QPlatformAudioSinkImplementation< STREAM_TYPE_ARG, DerivedType >::QPlatformAudioSinkImplementation ( QAudioDevice device,
const QAudioFormat & format,
QObject * parent )

Definition at line 114 of file qaudio_platform_implementation_support_p.h.

References QPlatformAudioSinkImplementation().

Referenced by QPlatformAudioSinkImplementation().

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

◆ ~QPlatformAudioSinkImplementation()

Definition at line 121 of file qaudio_platform_implementation_support_p.h.

References stop().

Here is the call graph for this function:

Member Function Documentation

◆ bufferSize()

template<STREAM_TYPE_ARG, typename DerivedType>
qsizetype QtMultimediaPrivate::QPlatformAudioSinkImplementation< STREAM_TYPE_ARG, DerivedType >::bufferSize ( ) const
overridevirtual

Implements QPlatformAudioSink.

Definition at line 267 of file qaudio_platform_implementation_support_p.h.

◆ bytesFree()

template<STREAM_TYPE_ARG, typename DerivedType>
qsizetype QtMultimediaPrivate::QPlatformAudioSinkImplementation< STREAM_TYPE_ARG, DerivedType >::bytesFree ( ) const
overridevirtual

Implements QPlatformAudioSink.

Definition at line 253 of file qaudio_platform_implementation_support_p.h.

◆ hardwareBufferFrames()

template<STREAM_TYPE_ARG, typename DerivedType>
int32_t QtMultimediaPrivate::QPlatformAudioSinkImplementation< STREAM_TYPE_ARG, DerivedType >::hardwareBufferFrames ( )
overridevirtual

Reimplemented from QPlatformAudioSink.

Definition at line 286 of file qaudio_platform_implementation_support_p.h.

◆ hasCallbackAPI()

template<STREAM_TYPE_ARG, typename DerivedType>
bool QtMultimediaPrivate::QPlatformAudioSinkImplementation< STREAM_TYPE_ARG, DerivedType >::hasCallbackAPI ( )
overridevirtual

Reimplemented from QPlatformAudioSink.

Definition at line 309 of file qaudio_platform_implementation_support_p.h.

◆ processedUSecs()

template<STREAM_TYPE_ARG, typename DerivedType>
qint64 QtMultimediaPrivate::QPlatformAudioSinkImplementation< STREAM_TYPE_ARG, DerivedType >::processedUSecs ( ) const
overridevirtual

Implements QPlatformAudioSink.

Definition at line 292 of file qaudio_platform_implementation_support_p.h.

◆ reset()

template<STREAM_TYPE_ARG, typename DerivedType>
void QtMultimediaPrivate::QPlatformAudioSinkImplementation< STREAM_TYPE_ARG, DerivedType >::reset ( )
overridevirtual

Implements QPlatformAudioSink.

Definition at line 225 of file qaudio_platform_implementation_support_p.h.

◆ resume()

template<STREAM_TYPE_ARG, typename DerivedType>
void QtMultimediaPrivate::QPlatformAudioSinkImplementation< STREAM_TYPE_ARG, DerivedType >::resume ( )
overridevirtual

Implements QPlatformAudioSink.

Definition at line 244 of file qaudio_platform_implementation_support_p.h.

◆ setBufferSize()

template<STREAM_TYPE_ARG, typename DerivedType>
void QtMultimediaPrivate::QPlatformAudioSinkImplementation< STREAM_TYPE_ARG, DerivedType >::setBufferSize ( qsizetype value)
overridevirtual

Implements QPlatformAudioSink.

Definition at line 261 of file qaudio_platform_implementation_support_p.h.

◆ setHardwareBufferFrames()

template<STREAM_TYPE_ARG, typename DerivedType>
void QtMultimediaPrivate::QPlatformAudioSinkImplementation< STREAM_TYPE_ARG, DerivedType >::setHardwareBufferFrames ( int32_t arg)
overridevirtual

Reimplemented from QPlatformAudioSink.

Definition at line 277 of file qaudio_platform_implementation_support_p.h.

◆ setRole()

template<STREAM_TYPE_ARG, typename DerivedType>
void QtMultimediaPrivate::QPlatformAudioSinkImplementation< STREAM_TYPE_ARG, DerivedType >::setRole ( AudioEndpointRole role)
overridevirtual

Reimplemented from QPlatformAudioSink.

Definition at line 315 of file qaudio_platform_implementation_support_p.h.

◆ setVolume()

template<STREAM_TYPE_ARG, typename DerivedType>
void QtMultimediaPrivate::QPlatformAudioSinkImplementation< STREAM_TYPE_ARG, DerivedType >::setVolume ( float volume)
overridevirtual

Reimplemented from QPlatformAudioEndpointBase.

Definition at line 301 of file qaudio_platform_implementation_support_p.h.

◆ start() [1/3]

template<STREAM_TYPE_ARG, typename DerivedType>
QIODevice * QtMultimediaPrivate::QPlatformAudioSinkImplementation< STREAM_TYPE_ARG, DerivedType >::start ( )
overridevirtual

◆ start() [2/3]

template<STREAM_TYPE_ARG, typename DerivedType>
void QtMultimediaPrivate::QPlatformAudioSinkImplementation< STREAM_TYPE_ARG, DerivedType >::start ( AudioCallback && audioCallback)
overridevirtual

Reimplemented from QPlatformAudioSink.

Reimplemented in QPulseAudioInternal::QPulseAudioSink.

Definition at line 154 of file qaudio_platform_implementation_support_p.h.

◆ start() [3/3]

template<STREAM_TYPE_ARG, typename DerivedType>
void QtMultimediaPrivate::QPlatformAudioSinkImplementation< STREAM_TYPE_ARG, DerivedType >::start ( QIODevice * device)
overridevirtual

◆ stop()

template<STREAM_TYPE_ARG, typename DerivedType>
void QtMultimediaPrivate::QPlatformAudioSinkImplementation< STREAM_TYPE_ARG, DerivedType >::stop ( )
finaloverridevirtual

Implements QPlatformAudioSink.

Definition at line 215 of file qaudio_platform_implementation_support_p.h.

Referenced by ~QPlatformAudioSinkImplementation().

Here is the caller graph for this function:

◆ suspend()

template<STREAM_TYPE_ARG, typename DerivedType>
void QtMultimediaPrivate::QPlatformAudioSinkImplementation< STREAM_TYPE_ARG, DerivedType >::suspend ( )
overridevirtual

Implements QPlatformAudioSink.

Definition at line 235 of file qaudio_platform_implementation_support_p.h.

◆ QtMultimediaPrivate::QPlatformAudioSinkStream

template<STREAM_TYPE_ARG, typename DerivedType = void>
friend class QtMultimediaPrivate::QPlatformAudioSinkStream
friend

Definition at line 99 of file qaudio_platform_implementation_support_p.h.

Member Data Documentation

◆ m_hardwareBufferFrames

template<STREAM_TYPE_ARG, typename DerivedType = void>
std::optional<int32_t> QtMultimediaPrivate::QPlatformAudioSinkImplementation< STREAM_TYPE_ARG, DerivedType >::m_hardwareBufferFrames
protected

Definition at line 104 of file qaudio_platform_implementation_support_p.h.

◆ m_internalBufferSize

template<STREAM_TYPE_ARG, typename DerivedType = void>
std::optional<int> QtMultimediaPrivate::QPlatformAudioSinkImplementation< STREAM_TYPE_ARG, DerivedType >::m_internalBufferSize
protected

Definition at line 103 of file qaudio_platform_implementation_support_p.h.

◆ m_role

◆ m_stream

template<STREAM_TYPE_ARG, typename DerivedType = void>
std::shared_ptr<StreamType> QtMultimediaPrivate::QPlatformAudioSinkImplementation< STREAM_TYPE_ARG, DerivedType >::m_stream
protected

Definition at line 107 of file qaudio_platform_implementation_support_p.h.

◆ StreamType

template<STREAM_TYPE_ARG, typename DerivedType = void>
friend QtMultimediaPrivate::QPlatformAudioSinkImplementation< STREAM_TYPE_ARG, DerivedType >::StreamType
protected

Definition at line 100 of file qaudio_platform_implementation_support_p.h.


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