API reference - Class QAudioDecoder

AccessDeniedError

Signature: [static,const] QAudioDecoder_Error AccessDeniedError

Description: Enum constant QAudioDecoder::AccessDeniedError

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

DecodingState

Signature: [static,const] QAudioDecoder_State DecodingState

Description: Enum constant QAudioDecoder::DecodingState

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

FormatError

Signature: [static,const] QAudioDecoder_Error FormatError

Description: Enum constant QAudioDecoder::FormatError

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

NoError

Signature: [static,const] QAudioDecoder_Error NoError

Description: Enum constant QAudioDecoder::NoError

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

ResourceError

Signature: [static,const] QAudioDecoder_Error ResourceError

Description: Enum constant QAudioDecoder::ResourceError

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

ServiceMissingError

Signature: [static,const] QAudioDecoder_Error ServiceMissingError

Description: Enum constant QAudioDecoder::ServiceMissingError

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

StoppedState

Signature: [static,const] QAudioDecoder_State StoppedState

Description: Enum constant QAudioDecoder::StoppedState

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

_const_cast

Signature: [const] QAudioDecoder 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 QAudioDecoder::addPropertyWatch(const QByteArray &name)

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

audioFormat

Signature: [const] QAudioFormat audioFormat

Description: Method QAudioFormat QAudioDecoder::audioFormat()

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

audioFormat=

Signature: void audioFormat= (const QAudioFormat format)

Description: Method void QAudioDecoder::setAudioFormat(const QAudioFormat &format)

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

availability

Signature: [const] QMultimedia_AvailabilityStatus availability

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

This method can be reimplemented in a derived class.

availabilityChanged_bool

Signature: [signal] void availabilityChanged_bool (bool available)

Description: Signal declaration for QAudioDecoder::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 QAudioDecoder::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.

bind

Signature: bool bind (QObject ptr arg1)

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

This method can be reimplemented in a derived class.

bufferAvailable

Signature: [const] bool bufferAvailable

Description: Method bool QAudioDecoder::bufferAvailable()

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

bufferAvailableChanged

Signature: [signal] void bufferAvailableChanged (bool arg1)

Description: Signal declaration for QAudioDecoder::bufferAvailableChanged(bool)

You can bind a procedure to this signal.

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

bufferReady

Signature: [signal] void bufferReady

Description: Signal declaration for QAudioDecoder::bufferReady()

You can bind a procedure to this signal.

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

childEvent

Signature: void childEvent (QChildEvent ptr event)

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

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

destroyed

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

Description: Signal declaration for QAudioDecoder::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 QAudioDecoder::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

duration

Signature: [const] long long duration

Description: Method qint64 QAudioDecoder::duration()

durationChanged

Signature: [signal] void durationChanged (long long duration)

Description: Signal declaration for QAudioDecoder::durationChanged(qint64 duration)

You can bind a procedure to this signal.

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

emit_availabilityChanged_bool

Signature: void emit_availabilityChanged_bool (bool available)

Description: Emitter for signal void QAudioDecoder::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 QAudioDecoder::availabilityChanged(QMultimedia::AvailabilityStatus availability)

Call this method to emit this signal.

emit_bufferAvailableChanged

Signature: void emit_bufferAvailableChanged (bool arg1)

Description: Emitter for signal void QAudioDecoder::bufferAvailableChanged(bool)

Call this method to emit this signal.

emit_bufferReady

Signature: void emit_bufferReady

Description: Emitter for signal void QAudioDecoder::bufferReady()

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

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

Call this method to emit this signal.

emit_durationChanged

Signature: void emit_durationChanged (long long duration)

Description: Emitter for signal void QAudioDecoder::durationChanged(qint64 duration)

Call this method to emit this signal.

emit_error_sig

Signature: void emit_error_sig (const QAudioDecoder_Error error)

Description: Emitter for signal void QAudioDecoder::error(QAudioDecoder::Error error)

Call this method to emit this signal.

emit_finished

Signature: void emit_finished

Description: Emitter for signal void QAudioDecoder::finished()

Call this method to emit this signal.

emit_formatChanged

Signature: void emit_formatChanged (const QAudioFormat format)

Description: Emitter for signal void QAudioDecoder::formatChanged(const QAudioFormat &format)

Call this method to emit this signal.

emit_metaDataAvailableChanged

Signature: void emit_metaDataAvailableChanged (bool available)

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

Call this method to emit this signal.

emit_metaDataChanged

Signature: void emit_metaDataChanged

Description: Emitter for signal void QAudioDecoder::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 QAudioDecoder::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 QAudioDecoder::notifyIntervalChanged(int milliSeconds)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

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

Call this method to emit this signal.

emit_positionChanged

Signature: void emit_positionChanged (long long position)

Description: Emitter for signal void QAudioDecoder::positionChanged(qint64 position)

Call this method to emit this signal.

emit_sourceChanged

Signature: void emit_sourceChanged

Description: Emitter for signal void QAudioDecoder::sourceChanged()

Call this method to emit this signal.

emit_stateChanged

Signature: void emit_stateChanged (const QAudioDecoder_State newState)

Description: Emitter for signal void QAudioDecoder::stateChanged(QAudioDecoder::State newState)

Call this method to emit this signal.

error

Signature: [const] QAudioDecoder_Error error

Description: Method QAudioDecoder::Error QAudioDecoder::error()

errorString

Signature: [const] string errorString

Description: Method QString QAudioDecoder::errorString()

error_sig

Signature: [signal] void error_sig (const QAudioDecoder_Error error)

Description: Signal declaration for QAudioDecoder::error(QAudioDecoder::Error error)

You can bind a procedure to this signal.

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

event

Signature: bool event (QEvent ptr event)

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

This method can be reimplemented in a derived class.

finished

Signature: [signal] void finished

Description: Signal declaration for QAudioDecoder::finished()

You can bind a procedure to this signal.

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

formatChanged

Signature: [signal] void formatChanged (const QAudioFormat format)

Description: Signal declaration for QAudioDecoder::formatChanged(const QAudioFormat &format)

You can bind a procedure to this signal.

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

hasSupport

Signature: [static] QMultimedia_SupportEstimate hasSupport (string mimeType, string[] codecs = QStringList())

Description: Static method QMultimedia::SupportEstimate QAudioDecoder::hasSupport(const QString &mimeType, const QStringList &codecs)

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

isAvailable

Signature: [const] bool isAvailable

Description: Virtual method bool QAudioDecoder::isAvailable()

This method can be reimplemented in a derived class.

isSignalConnected

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

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

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

metaDataAvailableChanged

Signature: [signal] void metaDataAvailableChanged (bool available)

Description: Signal declaration for QAudioDecoder::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 QAudioDecoder::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 QAudioDecoder::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.

new

Signature: [static] new QAudioDecoder new (QObject ptr parent = nullptr)

Description: Constructor QAudioDecoder::QAudioDecoder(QObject *parent)

This method creates an object of class QAudioDecoder.

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

notifyIntervalChanged

Signature: [signal] void notifyIntervalChanged (int milliSeconds)

Description: Signal declaration for QAudioDecoder::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 QAudioDecoder::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.

position

Signature: [const] long long position

Description: Method qint64 QAudioDecoder::position()

positionChanged

Signature: [signal] void positionChanged (long long position)

Description: Signal declaration for QAudioDecoder::positionChanged(qint64 position)

You can bind a procedure to this signal.

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

read

Signature: [const] QAudioBuffer read

Description: Method QAudioBuffer QAudioDecoder::read()

receivers

Signature: [const] int receivers (string signal)

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

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QAudioDecoder::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 *QAudioDecoder::service()

This method can be reimplemented in a derived class.

setAudioFormat

Signature: void setAudioFormat (const QAudioFormat format)

Description: Method void QAudioDecoder::setAudioFormat(const QAudioFormat &format)

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

setSourceDevice

Signature: void setSourceDevice (QIODevice ptr device)

Description: Method void QAudioDecoder::setSourceDevice(QIODevice *device)

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

setSourceFilename

Signature: void setSourceFilename (string fileName)

Description: Method void QAudioDecoder::setSourceFilename(const QString &fileName)

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

sourceChanged

Signature: [signal] void sourceChanged

Description: Signal declaration for QAudioDecoder::sourceChanged()

You can bind a procedure to this signal.

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

sourceDevice

Signature: [const] QIODevice ptr sourceDevice

Description: Method QIODevice *QAudioDecoder::sourceDevice()

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

sourceDevice=

Signature: void sourceDevice= (QIODevice ptr device)

Description: Method void QAudioDecoder::setSourceDevice(QIODevice *device)

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

sourceFilename

Signature: [const] string sourceFilename

Description: Method QString QAudioDecoder::sourceFilename()

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

sourceFilename=

Signature: void sourceFilename= (string fileName)

Description: Method void QAudioDecoder::setSourceFilename(const QString &fileName)

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

start

Signature: void start

Description: Method void QAudioDecoder::start()

state

Signature: [const] QAudioDecoder_State state

Description: Method QAudioDecoder::State QAudioDecoder::state()

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

stateChanged

Signature: [signal] void stateChanged (const QAudioDecoder_State newState)

Description: Signal declaration for QAudioDecoder::stateChanged(QAudioDecoder::State newState)

You can bind a procedure to this signal.

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

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

stop

Signature: void stop

Description: Method void QAudioDecoder::stop()

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QAudioDecoder::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 QAudioDecoder::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 QAudioDecoder::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 QAudioDecoder::unbind(QObject *)

This method can be reimplemented in a derived class.