API reference - Class QMediaObject

_const_cast

Signature: [const] QMediaObject 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.

addPropertyWatch

Signature: void addPropertyWatch (bytes name)

Description: Method void QMediaObject::addPropertyWatch(const QByteArray &name)

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

availability

Signature: [const] QMultimedia_AvailabilityStatus availability

Description: Virtual method QMultimedia::AvailabilityStatus QMediaObject::availability()

This method can be reimplemented in a derived class.

availabilityChanged_bool

Signature: [signal] void availabilityChanged_bool (bool available)

Description: Signal declaration for QMediaObject::availabilityChanged(bool available)

You can bind a procedure to this signal.

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

availabilityChanged_status

Signature: [signal] void availabilityChanged_status (const QMultimedia_AvailabilityStatus availability)

Description: Signal declaration for QMediaObject::availabilityChanged(QMultimedia::AvailabilityStatus availability)

You can bind a procedure to this signal.

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

availableMetaData

Signature: [const] string[] availableMetaData

Description: Method QStringList QMediaObject::availableMetaData()

bind

Signature: bool bind (QObject ptr arg1)

Description: Virtual method bool QMediaObject::bind(QObject *)

This method can be reimplemented in a derived class.

childEvent

Signature: void childEvent (QChildEvent ptr event)

Description: Virtual method void QMediaObject::childEvent(QChildEvent *event)

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr event)

Description: Virtual method void QMediaObject::customEvent(QEvent *event)

This method can be reimplemented in a derived class.

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QMediaObject::destroyed(QObject *)

You can bind a procedure to this signal.

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

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

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

This method can be reimplemented in a derived class.

emit_availabilityChanged_bool

Signature: void emit_availabilityChanged_bool (bool available)

Description: Emitter for signal void QMediaObject::availabilityChanged(bool available)

Call this method to emit this signal.

emit_availabilityChanged_status

Signature: void emit_availabilityChanged_status (const QMultimedia_AvailabilityStatus availability)

Description: Emitter for signal void QMediaObject::availabilityChanged(QMultimedia::AvailabilityStatus availability)

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

Description: Emitter for signal void QMediaObject::destroyed(QObject *)

Call this method to emit this signal.

emit_metaDataAvailableChanged

Signature: void emit_metaDataAvailableChanged (bool available)

Description: Emitter for signal void QMediaObject::metaDataAvailableChanged(bool available)

Call this method to emit this signal.

emit_metaDataChanged

Signature: void emit_metaDataChanged

Description: Emitter for signal void QMediaObject::metaDataChanged()

Call this method to emit this signal.

emit_metaDataChanged_kv

Signature: void emit_metaDataChanged_kv (string key, variant value)

Description: Emitter for signal void QMediaObject::metaDataChanged(const QString &key, const QVariant &value)

Call this method to emit this signal.

emit_notifyIntervalChanged

Signature: void emit_notifyIntervalChanged (int milliSeconds)

Description: Emitter for signal void QMediaObject::notifyIntervalChanged(int milliSeconds)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QMediaObject::objectNameChanged(const QString &objectName)

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QMediaObject::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 QMediaObject::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

isAvailable

Signature: [const] bool isAvailable

Description: Virtual method bool QMediaObject::isAvailable()

This method can be reimplemented in a derived class.

isAvailable?

Signature: [const] bool isAvailable?

Description: Method bool QMediaObject::isAvailable()

isMetaDataAvailable?

Signature: [const] bool isMetaDataAvailable?

Description: Method bool QMediaObject::isMetaDataAvailable()

isSignalConnected

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

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

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

metaData

Signature: [const] variant metaData (string key)

Description: Method QVariant QMediaObject::metaData(const QString &key)

metaDataAvailableChanged

Signature: [signal] void metaDataAvailableChanged (bool available)

Description: Signal declaration for QMediaObject::metaDataAvailableChanged(bool available)

You can bind a procedure to this signal.

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

metaDataChanged

Signature: [signal] void metaDataChanged

Description: Signal declaration for QMediaObject::metaDataChanged()

You can bind a procedure to this signal.

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

metaDataChanged_kv

Signature: [signal] void metaDataChanged_kv (string key, variant value)

Description: Signal declaration for QMediaObject::metaDataChanged(const QString &key, const QVariant &value)

You can bind a procedure to this signal.

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

notifyInterval

Signature: [const] int notifyInterval

Description: Method int QMediaObject::notifyInterval()

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

notifyInterval=

Signature: void notifyInterval= (int milliSeconds)

Description: Method void QMediaObject::setNotifyInterval(int milliSeconds)

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

notifyIntervalChanged

Signature: [signal] void notifyIntervalChanged (int milliSeconds)

Description: Signal declaration for QMediaObject::notifyIntervalChanged(int milliSeconds)

You can bind a procedure to this signal.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QMediaObject::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

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

receivers

Signature: [const] int receivers (string signal)

Description: Method int QMediaObject::receivers(const char *signal)

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

removePropertyWatch

Signature: void removePropertyWatch (bytes name)

Description: Method void QMediaObject::removePropertyWatch(const QByteArray &name)

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

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QMediaObject::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QMediaObject::senderSignalIndex()

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

service

Signature: [const] QMediaService ptr service

Description: Virtual method QMediaService *QMediaObject::service()

This method can be reimplemented in a derived class.

setNotifyInterval

Signature: void setNotifyInterval (int milliSeconds)

Description: Method void QMediaObject::setNotifyInterval(int milliSeconds)

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

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QMediaObject::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 QMediaObject::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 QMediaObject::trUtf8(const char *s, const char *c, int n)

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

unbind

Signature: void unbind (QObject ptr arg1)

Description: Virtual method void QMediaObject::unbind(QObject *)

This method can be reimplemented in a derived class.