Notation used in Ruby API documentation
Module: QtMultimedia
Description: Binding of QSoundEffect
Class hierarchy: QSoundEffect » QObject
Sub-classes: Status, QFlags_Status
new QSoundEffect | new | (QObject ptr parent = nullptr) | Constructor QSoundEffect::QSoundEffect(QObject *parent) |
[const] | QSoundEffect ptr | _const_cast | Returns a non-const reference to self. | |
void | _create | Ensures the C++ object is created | ||
void | _destroy | Explicitly destroys the object | ||
[const] | bool | _destroyed? | Returns a value indicating whether the object was already destroyed | |
[const] | bool | _is_const_object? | Returns a value indicating whether the reference is a const reference | |
void | _manage | Marks the object as managed by the script side. | ||
void | _unmanage | Marks the object as no longer owned by the script side. | ||
[const] | string | category | Method QString QSoundEffect::category() | |
void | category= | (string category) | Method void QSoundEffect::setCategory(const QString &category) | |
[signal] | void | categoryChanged | Signal declaration for QSoundEffect::categoryChanged() | |
[signal] | void | destroyed | (QObject ptr arg1) | Signal declaration for QSoundEffect::destroyed(QObject *) |
void | emit_categoryChanged | Emitter for signal void QSoundEffect::categoryChanged() | ||
void | emit_destroyed | (QObject ptr arg1 = nullptr) | Emitter for signal void QSoundEffect::destroyed(QObject *) | |
void | emit_loadedChanged | Emitter for signal void QSoundEffect::loadedChanged() | ||
void | emit_loopCountChanged | Emitter for signal void QSoundEffect::loopCountChanged() | ||
void | emit_loopsRemainingChanged | Emitter for signal void QSoundEffect::loopsRemainingChanged() | ||
void | emit_mutedChanged | Emitter for signal void QSoundEffect::mutedChanged() | ||
void | emit_objectNameChanged | (string objectName) | Emitter for signal void QSoundEffect::objectNameChanged(const QString &objectName) | |
void | emit_playingChanged | Emitter for signal void QSoundEffect::playingChanged() | ||
void | emit_sourceChanged | Emitter for signal void QSoundEffect::sourceChanged() | ||
void | emit_statusChanged | Emitter for signal void QSoundEffect::statusChanged() | ||
void | emit_volumeChanged | Emitter for signal void QSoundEffect::volumeChanged() | ||
bool | event | (QEvent ptr event) | Virtual method bool QSoundEffect::event(QEvent *event) | |
bool | eventFilter | (QObject ptr watched, QEvent ptr event) | Virtual method bool QSoundEffect::eventFilter(QObject *watched, QEvent *event) | |
[const] | bool | isLoaded? | Method bool QSoundEffect::isLoaded() | |
[const] | bool | isMuted? | Method bool QSoundEffect::isMuted() | |
[const] | bool | isPlaying? | Method bool QSoundEffect::isPlaying() | |
[signal] | void | loadedChanged | Signal declaration for QSoundEffect::loadedChanged() | |
[const] | int | loopCount | Method int QSoundEffect::loopCount() | |
void | loopCount= | (int loopCount) | Method void QSoundEffect::setLoopCount(int loopCount) | |
[signal] | void | loopCountChanged | Signal declaration for QSoundEffect::loopCountChanged() | |
[const] | int | loopsRemaining | Method int QSoundEffect::loopsRemaining() | |
[signal] | void | loopsRemainingChanged | Signal declaration for QSoundEffect::loopsRemainingChanged() | |
[const] | bool | muted | Method bool QSoundEffect::isMuted() | |
void | muted= | (bool muted) | Method void QSoundEffect::setMuted(bool muted) | |
[signal] | void | mutedChanged | Signal declaration for QSoundEffect::mutedChanged() | |
[signal] | void | objectNameChanged | (string objectName) | Signal declaration for QSoundEffect::objectNameChanged(const QString &objectName) |
void | play | Method void QSoundEffect::play() | ||
[const] | bool | playing | Method bool QSoundEffect::isPlaying() | |
[signal] | void | playingChanged | Signal declaration for QSoundEffect::playingChanged() | |
void | setCategory | (string category) | Method void QSoundEffect::setCategory(const QString &category) | |
void | setLoopCount | (int loopCount) | Method void QSoundEffect::setLoopCount(int loopCount) | |
void | setMuted | (bool muted) | Method void QSoundEffect::setMuted(bool muted) | |
void | setSource | (const QUrl url) | Method void QSoundEffect::setSource(const QUrl &url) | |
void | setVolume | (double volume) | Method void QSoundEffect::setVolume(double volume) | |
[const] | QUrl | source | Method QUrl QSoundEffect::source() | |
void | source= | (const QUrl url) | Method void QSoundEffect::setSource(const QUrl &url) | |
[signal] | void | sourceChanged | Signal declaration for QSoundEffect::sourceChanged() | |
[const] | QSoundEffect_Status | status | Method QSoundEffect::Status QSoundEffect::status() | |
[signal] | void | statusChanged | Signal declaration for QSoundEffect::statusChanged() | |
void | stop | Method void QSoundEffect::stop() | ||
[const] | double | volume | Method double QSoundEffect::volume() | |
void | volume= | (double volume) | Method void QSoundEffect::setVolume(double volume) | |
[signal] | void | volumeChanged | Signal declaration for QSoundEffect::volumeChanged() |
[static,const] | QSoundEffect_Status | Error | Enum constant QSoundEffect::Error | |
[static,const] | QSoundEffect_Status | Loading | Enum constant QSoundEffect::Loading | |
[static,const] | QSoundEffect_Status | Null | Enum constant QSoundEffect::Null | |
[static,const] | QSoundEffect_Status | Ready | Enum constant QSoundEffect::Ready | |
QMetaObject | staticMetaObject | Obtains the static MetaObject for this class. | ||
string[] | supportedMimeTypes | Static method QStringList QSoundEffect::supportedMimeTypes() | ||
string | tr | (string s, string c = nullptr, int n = -1) | Static method QString QSoundEffect::tr(const char *s, const char *c, int n) | |
string | trUtf8 | (string s, string c = nullptr, int n = -1) | Static method QString QSoundEffect::trUtf8(const char *s, const char *c, int n) |
void | childEvent | (QChildEvent ptr event) | Virtual method void QSoundEffect::childEvent(QChildEvent *event) | ||
void | customEvent | (QEvent ptr event) | Virtual method void QSoundEffect::customEvent(QEvent *event) | ||
void | disconnectNotify | (const QMetaMethod signal) | Virtual method void QSoundEffect::disconnectNotify(const QMetaMethod &signal) | ||
[const] | bool | isSignalConnected | (const QMetaMethod signal) | Method bool QSoundEffect::isSignalConnected(const QMetaMethod &signal) | |
[const] | int | receivers | (string signal) | Method int QSoundEffect::receivers(const char *signal) | |
[const] | QObject ptr | sender | Method QObject *QSoundEffect::sender() | ||
[const] | int | senderSignalIndex | Method int QSoundEffect::senderSignalIndex() | ||
void | timerEvent | (QTimerEvent ptr event) | Virtual method void QSoundEffect::timerEvent(QTimerEvent *event) |
Error | Signature: [static,const] QSoundEffect_Status Error Description: Enum constant QSoundEffect::Error Python specific notes: |
Loading | Signature: [static,const] QSoundEffect_Status Loading Description: Enum constant QSoundEffect::Loading Python specific notes: |
Null | Signature: [static,const] QSoundEffect_Status Null Description: Enum constant QSoundEffect::Null Python specific notes: |
Ready | Signature: [static,const] QSoundEffect_Status Ready Description: Enum constant QSoundEffect::Ready Python specific notes: |
_const_cast | Signature: [const] QSoundEffect ptr _const_cast Description: Returns a non-const reference to self. Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects. This method has been introduced in version 0.29.6. |
_create | Signature: void _create Description: Ensures the C++ object is created Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created. |
_destroy | Signature: void _destroy Description: Explicitly destroys the object Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing. |
_destroyed? | Signature: [const] bool _destroyed? Description: Returns a value indicating whether the object was already destroyed This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself. |
_is_const_object? | Signature: [const] bool _is_const_object? Description: Returns a value indicating whether the reference is a const reference This method returns true, if self is a const reference. In that case, only const methods may be called on self. |
_manage | Signature: void _manage Description: Marks the object as managed by the script side. After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required. Usually it's not required to call this method. It has been introduced in version 0.24. |
_unmanage | Signature: void _unmanage Description: Marks the object as no longer owned by the script side. Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur. Usually it's not required to call this method. It has been introduced in version 0.24. |
category | Signature: [const] string category Description: Method QString QSoundEffect::category() Python specific notes: |
category= | Signature: void category= (string category) Description: Method void QSoundEffect::setCategory(const QString &category) Python specific notes: |
categoryChanged | Signature: [signal] void categoryChanged Description: Signal declaration for QSoundEffect::categoryChanged() You can bind a procedure to this signal. Python specific notes: |
childEvent | Signature: void childEvent (QChildEvent ptr event) Description: Virtual method void QSoundEffect::childEvent(QChildEvent *event) This method can be reimplemented in a derived class. |
customEvent | Signature: void customEvent (QEvent ptr event) Description: Virtual method void QSoundEffect::customEvent(QEvent *event) This method can be reimplemented in a derived class. |
destroyed | Signature: [signal] void destroyed (QObject ptr arg1) Description: Signal declaration for QSoundEffect::destroyed(QObject *) You can bind a procedure to this signal. Python specific notes: |
disconnectNotify | Signature: void disconnectNotify (const QMetaMethod signal) Description: Virtual method void QSoundEffect::disconnectNotify(const QMetaMethod &signal) This method can be reimplemented in a derived class. |
emit_categoryChanged | Signature: void emit_categoryChanged Description: Emitter for signal void QSoundEffect::categoryChanged() Call this method to emit this signal. |
emit_destroyed | Signature: void emit_destroyed (QObject ptr arg1 = nullptr) Description: Emitter for signal void QSoundEffect::destroyed(QObject *) Call this method to emit this signal. |
emit_loadedChanged | Signature: void emit_loadedChanged Description: Emitter for signal void QSoundEffect::loadedChanged() Call this method to emit this signal. |
emit_loopCountChanged | Signature: void emit_loopCountChanged Description: Emitter for signal void QSoundEffect::loopCountChanged() Call this method to emit this signal. |
emit_loopsRemainingChanged | Signature: void emit_loopsRemainingChanged Description: Emitter for signal void QSoundEffect::loopsRemainingChanged() Call this method to emit this signal. |
emit_mutedChanged | Signature: void emit_mutedChanged Description: Emitter for signal void QSoundEffect::mutedChanged() Call this method to emit this signal. |
emit_objectNameChanged | Signature: void emit_objectNameChanged (string objectName) Description: Emitter for signal void QSoundEffect::objectNameChanged(const QString &objectName) Call this method to emit this signal. |
emit_playingChanged | Signature: void emit_playingChanged Description: Emitter for signal void QSoundEffect::playingChanged() Call this method to emit this signal. |
emit_sourceChanged | Signature: void emit_sourceChanged Description: Emitter for signal void QSoundEffect::sourceChanged() Call this method to emit this signal. |
emit_statusChanged | Signature: void emit_statusChanged Description: Emitter for signal void QSoundEffect::statusChanged() Call this method to emit this signal. |
emit_volumeChanged | Signature: void emit_volumeChanged Description: Emitter for signal void QSoundEffect::volumeChanged() Call this method to emit this signal. |
event | Signature: bool event (QEvent ptr event) Description: Virtual method bool QSoundEffect::event(QEvent *event) This method can be reimplemented in a derived class. |
eventFilter | Signature: bool eventFilter (QObject ptr watched, QEvent ptr event) Description: Virtual method bool QSoundEffect::eventFilter(QObject *watched, QEvent *event) This method can be reimplemented in a derived class. |
isLoaded? | Signature: [const] bool isLoaded? Description: Method bool QSoundEffect::isLoaded() |
isMuted? | Signature: [const] bool isMuted? Description: Method bool QSoundEffect::isMuted() Python specific notes: |
isPlaying? | Signature: [const] bool isPlaying? Description: Method bool QSoundEffect::isPlaying() Python specific notes: |
isSignalConnected | Signature: [const] bool isSignalConnected (const QMetaMethod signal) Description: Method bool QSoundEffect::isSignalConnected(const QMetaMethod &signal) This method is protected and can only be called from inside a derived class. |
loadedChanged | Signature: [signal] void loadedChanged Description: Signal declaration for QSoundEffect::loadedChanged() You can bind a procedure to this signal. Python specific notes: |
loopCount | Signature: [const] int loopCount Description: Method int QSoundEffect::loopCount() Python specific notes: |
loopCount= | Signature: void loopCount= (int loopCount) Description: Method void QSoundEffect::setLoopCount(int loopCount) Python specific notes: |
loopCountChanged | Signature: [signal] void loopCountChanged Description: Signal declaration for QSoundEffect::loopCountChanged() You can bind a procedure to this signal. Python specific notes: |
loopsRemaining | Signature: [const] int loopsRemaining Description: Method int QSoundEffect::loopsRemaining() Python specific notes: |
loopsRemainingChanged | Signature: [signal] void loopsRemainingChanged Description: Signal declaration for QSoundEffect::loopsRemainingChanged() You can bind a procedure to this signal. Python specific notes: |
muted | Signature: [const] bool muted Description: Method bool QSoundEffect::isMuted() Python specific notes: |
muted= | Signature: void muted= (bool muted) Description: Method void QSoundEffect::setMuted(bool muted) Python specific notes: |
mutedChanged | Signature: [signal] void mutedChanged Description: Signal declaration for QSoundEffect::mutedChanged() You can bind a procedure to this signal. Python specific notes: |
new | Signature: [static] new QSoundEffect new (QObject ptr parent = nullptr) Description: Constructor QSoundEffect::QSoundEffect(QObject *parent) This method creates an object of class QSoundEffect. Python specific notes: |
objectNameChanged | Signature: [signal] void objectNameChanged (string objectName) Description: Signal declaration for QSoundEffect::objectNameChanged(const QString &objectName) You can bind a procedure to this signal. Python specific notes: |
play | Signature: void play Description: Method void QSoundEffect::play() |
playing | Signature: [const] bool playing Description: Method bool QSoundEffect::isPlaying() Python specific notes: |
playingChanged | Signature: [signal] void playingChanged Description: Signal declaration for QSoundEffect::playingChanged() You can bind a procedure to this signal. Python specific notes: |
receivers | Signature: [const] int receivers (string signal) Description: Method int QSoundEffect::receivers(const char *signal) This method is protected and can only be called from inside a derived class. |
sender | Signature: [const] QObject ptr sender Description: Method QObject *QSoundEffect::sender() This method is protected and can only be called from inside a derived class. |
senderSignalIndex | Signature: [const] int senderSignalIndex Description: Method int QSoundEffect::senderSignalIndex() This method is protected and can only be called from inside a derived class. |
setCategory | Signature: void setCategory (string category) Description: Method void QSoundEffect::setCategory(const QString &category) Python specific notes: |
setLoopCount | Signature: void setLoopCount (int loopCount) Description: Method void QSoundEffect::setLoopCount(int loopCount) Python specific notes: |
setMuted | Signature: void setMuted (bool muted) Description: Method void QSoundEffect::setMuted(bool muted) Python specific notes: |
setSource | Signature: void setSource (const QUrl url) Description: Method void QSoundEffect::setSource(const QUrl &url) Python specific notes: |
setVolume | Signature: void setVolume (double volume) Description: Method void QSoundEffect::setVolume(double volume) Python specific notes: |
source | Signature: [const] QUrl source Description: Method QUrl QSoundEffect::source() Python specific notes: |
source= | Signature: void source= (const QUrl url) Description: Method void QSoundEffect::setSource(const QUrl &url) Python specific notes: |
sourceChanged | Signature: [signal] void sourceChanged Description: Signal declaration for QSoundEffect::sourceChanged() You can bind a procedure to this signal. Python specific notes: |
staticMetaObject | Signature: [static] QMetaObject staticMetaObject Description: Obtains the static MetaObject for this class. |
status | Signature: [const] QSoundEffect_Status status Description: Method QSoundEffect::Status QSoundEffect::status() Python specific notes: |
statusChanged | Signature: [signal] void statusChanged Description: Signal declaration for QSoundEffect::statusChanged() You can bind a procedure to this signal. Python specific notes: |
stop | Signature: void stop Description: Method void QSoundEffect::stop() |
supportedMimeTypes | Signature: [static] string[] supportedMimeTypes Description: Static method QStringList QSoundEffect::supportedMimeTypes() This method is static and can be called without an instance. |
timerEvent | Signature: void timerEvent (QTimerEvent ptr event) Description: Virtual method void QSoundEffect::timerEvent(QTimerEvent *event) This method can be reimplemented in a derived class. |
tr | Signature: [static] string tr (string s, string c = nullptr, int n = -1) Description: Static method QString QSoundEffect::tr(const char *s, const char *c, int n) This method is static and can be called without an instance. |
trUtf8 | Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1) Description: Static method QString QSoundEffect::trUtf8(const char *s, const char *c, int n) This method is static and can be called without an instance. |
volume | Signature: [const] double volume Description: Method double QSoundEffect::volume() Python specific notes: |
volume= | Signature: void volume= (double volume) Description: Method void QSoundEffect::setVolume(double volume) Python specific notes: |
volumeChanged | Signature: [signal] void volumeChanged Description: Signal declaration for QSoundEffect::volumeChanged() You can bind a procedure to this signal. Python specific notes: |