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
QQuickSoundEffect Class Reference

#include <qquicksoundeffect_p.h>

+ Inheritance diagram for QQuickSoundEffect:
+ Collaboration diagram for QQuickSoundEffect:

Signals

void sourceChanged (const QUrl &source)
 
- Signals inherited from QSoundEffect
void sourceChanged ()
 The sourceChanged signal is emitted when the source has been changed.
 
void loopCountChanged ()
 \qmlsignal QtMultimedia::SoundEffect::loadedChanged()
 
void loopsRemainingChanged ()
 \qmlsignal QtMultimedia::SoundEffect::loopCountChanged()
 
void volumeChanged ()
 \qmlsignal QtMultimedia::SoundEffect::loopsRemainingChanged()
 
void mutedChanged ()
 \qmlsignal QtMultimedia::SoundEffect::volumeChanged()
 
void loadedChanged ()
 \qmlsignal QtMultimedia::SoundEffect::sourceChanged()
 
void playingChanged ()
 \qmlsignal QtMultimedia::SoundEffect::mutedChanged()
 
void statusChanged ()
 \qmlsignal QtMultimedia::SoundEffect::playingChanged()
 
void audioDeviceChanged ()
 
- 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.
 

Public Member Functions

 QQuickSoundEffect (QObject *parent=nullptr)
 
void qmlSetSource (const QUrl &source)
 
QUrl qmlSource () const
 
- Public Member Functions inherited from QSoundEffect
 QSoundEffect (QObject *parent=nullptr)
 \qmltype SoundEffect \instantiates QSoundEffect
 
 QSoundEffect (const QAudioDevice &audioDevice, QObject *parent=nullptr)
 Creates a QSoundEffect with the given audioDevice and parent.
 
 ~QSoundEffect ()
 Destroys this sound effect.
 
QUrl source () const
 Returns the URL of the current source to play.
 
void setSource (const QUrl &url)
 Set the current URL to play to url.
 
int loopCount () const
 Returns the total number of times that this sound effect will be played before stopping.
 
int loopsRemaining () const
 
void setLoopCount (int loopCount)
 Set the total number of times to play this sound effect to loopCount.
 
QAudioDevice audioDevice ()
 
void setAudioDevice (const QAudioDevice &device)
 
float volume () const
 Returns the current volume of this sound effect, from 0.0 (silent) to 1.0 (maximum volume).
 
void setVolume (float volume)
 Sets the sound effect volume to volume.
 
bool isMuted () const
 Returns whether this sound effect is muted.
 
void setMuted (bool muted)
 Sets whether to mute this sound effect's playback.
 
bool isLoaded () const
 Returns whether the sound effect has finished loading the \l source().
 
bool isPlaying () const
 Returns true if the sound effect is currently playing, or false otherwise.
 
Status status () const
 Returns the current status of this sound effect.
 
- 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.
 

Properties

QUrl source
 
- Properties inherited from QSoundEffect
QUrl source
 \qmlproperty url QtMultimedia::SoundEffect::source
 
int loops
 \qmlproperty int QtMultimedia::SoundEffect::loops
 
int loopsRemaining
 \qmlproperty int QtMultimedia::SoundEffect::loopsRemaining
 
float volume
 \qmlproperty qreal QtMultimedia::SoundEffect::volume
 
bool muted
 \qmlproperty bool QtMultimedia::SoundEffect::muted
 
bool playing
 \qmlproperty bool QtMultimedia::SoundEffect::playing
 
Status status
 \qmlproperty enumeration QtMultimedia::SoundEffect::status
 
QAudioDevice audioDevice
 Returns the QAudioDevice instance.
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Additional Inherited Members

- Public Types inherited from QSoundEffect
enum  Loop { Infinite = -2 }
 \value Infinite Used as a parameter to \l setLoopCount() for infinite looping More...
 
enum  Status { Null , Loading , Ready , Error }
 \value Null No source has been set or the source is null. More...
 
- Public Slots inherited from QSoundEffect
void play ()
 \qmlmethod QtMultimedia::SoundEffect::play()
 
void stop ()
 \qmlmethod QtMultimedia::SoundEffect::stop()
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Static Public Member Functions inherited from QSoundEffect
static QStringList supportedMimeTypes ()
 Returns a list of the supported mime types for this platform.
 
- 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 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)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 

Detailed Description

Definition at line 25 of file qquicksoundeffect_p.h.

Constructor & Destructor Documentation

◆ QQuickSoundEffect()

QT_BEGIN_NAMESPACE QQuickSoundEffect::QQuickSoundEffect ( QObject * parent = nullptr)

Definition at line 9 of file qquicksoundeffect.cpp.

Member Function Documentation

◆ qmlSetSource()

void QQuickSoundEffect::qmlSetSource ( const QUrl & source)

Definition at line 11 of file qquicksoundeffect.cpp.

References context, emit, qmlContext(), QSoundEffect::setSource(), source, and QSoundEffect::sourceChanged().

+ Here is the call graph for this function:

◆ qmlSource()

QUrl QQuickSoundEffect::qmlSource ( ) const

Definition at line 22 of file qquicksoundeffect.cpp.

◆ sourceChanged

void QQuickSoundEffect::sourceChanged ( const QUrl & source)
signal

Property Documentation

◆ source

QUrl QQuickSoundEffect::source
readwrite

Definition at line 28 of file qquicksoundeffect_p.h.

Referenced by qmlSetSource().


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