API reference - Class QSound

Notation used in Ruby API documentation

Module: QtMultimedia

Description: Binding of QSound

Class hierarchy: QSound » QObject

Public constructors

new QSoundnew(string filename,
QObject ptr parent = 0)
Constructor QSound::QSound(const QString &filename, QObject *parent)

Public methods

void_createEnsures the C++ object is created
void_destroyExplicitly 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_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
boolevent(QEvent ptr arg1)Virtual method bool QSound::event(QEvent *)
booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QSound::eventFilter(QObject *, QEvent *)
[const]stringfileNameMethod QString QSound::fileName()
[const]boolisFinished?Method bool QSound::isFinished()
[const]intloopsMethod int QSound::loops()
voidloops=(int arg1)Method void QSound::setLoops(int)
[const]intloopsRemainingMethod int QSound::loopsRemaining()
voidplayMethod void QSound::play()
voidsetLoops(int arg1)Method void QSound::setLoops(int)
voidstopMethod void QSound::stop()

Public static methods and constants

voidplay(string filename)Static method void QSound::play(const QString &filename)
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = nullptr,
int n = -1)
Static method QString QSound::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = nullptr,
int n = -1)
Static method QString QSound::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

voidchildEvent(QChildEvent ptr arg1)Virtual method void QSound::childEvent(QChildEvent *)
voidcustomEvent(QEvent ptr arg1)Virtual method void QSound::customEvent(QEvent *)
voiddisconnectNotify(const QMetaMethod signal)Virtual method void QSound::disconnectNotify(const QMetaMethod &signal)
[const]boolisSignalConnected(const QMetaMethod signal)Method bool QSound::isSignalConnected(const QMetaMethod &signal)
[const]intreceivers(string signal)Method int QSound::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QSound::sender()
[const]intsenderSignalIndexMethod int QSound::senderSignalIndex()
voidtimerEvent(QTimerEvent ptr arg1)Virtual method void QSound::timerEvent(QTimerEvent *)

Detailed description

_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.

childEvent

Signature: void childEvent (QChildEvent ptr arg1)

Description: Virtual method void QSound::childEvent(QChildEvent *)

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr arg1)

Description: Virtual method void QSound::customEvent(QEvent *)

This method can be reimplemented in a derived class.

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QSound::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

event

Signature: bool event (QEvent ptr arg1)

Description: Virtual method bool QSound::event(QEvent *)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr arg1, QEvent ptr arg2)

Description: Virtual method bool QSound::eventFilter(QObject *, QEvent *)

This method can be reimplemented in a derived class.

fileName

Signature: [const] string fileName

Description: Method QString QSound::fileName()

isFinished?

Signature: [const] bool isFinished?

Description: Method bool QSound::isFinished()

isSignalConnected

Signature: [const] bool isSignalConnected (const QMetaMethod signal)

Description: Method bool QSound::isSignalConnected(const QMetaMethod &signal)

This method is protected and can only be called from inside a derived class.

loops

Signature: [const] int loops

Description: Method int QSound::loops()

Python specific notes:
The object exposes a readable attribute 'loops'. This is the getter.

loops=

Signature: void loops= (int arg1)

Description: Method void QSound::setLoops(int)

Python specific notes:
The object exposes a writable attribute 'loops'. This is the setter.

loopsRemaining

Signature: [const] int loopsRemaining

Description: Method int QSound::loopsRemaining()

new

Signature: [static] new QSound new (string filename, QObject ptr parent = 0)

Description: Constructor QSound::QSound(const QString &filename, QObject *parent)

This method creates an object of class QSound.

Python specific notes:
This method is the default initializer of the object.

play

(1) Signature: void play

Description: Method void QSound::play()

Python specific notes:
This instance method is available as '_inst_play' in Python.

(2) Signature: [static] void play (string filename)

Description: Static method void QSound::play(const QString &filename)

This method is static and can be called without an instance.

Python specific notes:
This class method is available as '_class_play' in Python.

receivers

Signature: [const] int receivers (string signal)

Description: Method int QSound::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 *QSound::sender()

This method is protected and can only be called from inside a derived class.

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QSound::senderSignalIndex()

This method is protected and can only be called from inside a derived class.

setLoops

Signature: void setLoops (int arg1)

Description: Method void QSound::setLoops(int)

Python specific notes:
The object exposes a writable attribute 'loops'. This is the setter.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

stop

Signature: void stop

Description: Method void QSound::stop()

timerEvent

Signature: void timerEvent (QTimerEvent ptr arg1)

Description: Virtual method void QSound::timerEvent(QTimerEvent *)

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 QSound::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 QSound::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.