API reference - Class QAudioDecoderControl

_const_cast

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

audioFormat

Signature: [const] QAudioFormat audioFormat

Description: Virtual method QAudioFormat QAudioDecoderControl::audioFormat()

This method can be reimplemented in a derived class.

audioFormat=

Signature: void audioFormat= (const QAudioFormat format)

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

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

bufferAvailable

Signature: [const] bool bufferAvailable

Description: Virtual method bool QAudioDecoderControl::bufferAvailable()

This method can be reimplemented in a derived class.

bufferAvailableChanged

Signature: [signal] void bufferAvailableChanged (bool available)

Description: Signal declaration for QAudioDecoderControl::bufferAvailableChanged(bool available)

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 QAudioDecoderControl::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 QAudioDecoderControl::childEvent(QChildEvent *event)

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

destroyed

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

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

This method can be reimplemented in a derived class.

duration

Signature: [const] long long duration

Description: Virtual method qint64 QAudioDecoderControl::duration()

This method can be reimplemented in a derived class.

durationChanged

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

Description: Signal declaration for QAudioDecoderControl::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_bufferAvailableChanged

Signature: void emit_bufferAvailableChanged (bool available)

Description: Emitter for signal void QAudioDecoderControl::bufferAvailableChanged(bool available)

Call this method to emit this signal.

emit_bufferReady

Signature: void emit_bufferReady

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

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

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

Call this method to emit this signal.

emit_durationChanged

Signature: void emit_durationChanged (long long duration)

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

Call this method to emit this signal.

emit_error

Signature: void emit_error (int error, string errorString)

Description: Emitter for signal void QAudioDecoderControl::error(int error, const QString &errorString)

Call this method to emit this signal.

emit_finished

Signature: void emit_finished

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

Call this method to emit this signal.

emit_formatChanged

Signature: void emit_formatChanged (const QAudioFormat format)

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

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QAudioDecoderControl::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 QAudioDecoderControl::positionChanged(qint64 position)

Call this method to emit this signal.

emit_sourceChanged

Signature: void emit_sourceChanged

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

Call this method to emit this signal.

emit_stateChanged

Signature: void emit_stateChanged (const QAudioDecoder_State newState)

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

Call this method to emit this signal.

error

Signature: [signal] void error (int error, string errorString)

Description: Signal declaration for QAudioDecoderControl::error(int error, const QString &errorString)

You can bind a procedure to this signal.

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

event

Signature: bool event (QEvent ptr event)

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

This method can be reimplemented in a derived class.

finished

Signature: [signal] void finished

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

isSignalConnected

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

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

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

new

Signature: [static] new QAudioDecoderControl new

Description: Constructor QAudioDecoderControl::QAudioDecoderControl()

This method creates an object of class QAudioDecoderControl.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QAudioDecoderControl::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: Virtual method qint64 QAudioDecoderControl::position()

This method can be reimplemented in a derived class.

positionChanged

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

Description: Signal declaration for QAudioDecoderControl::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: QAudioBuffer read

Description: Virtual method QAudioBuffer QAudioDecoderControl::read()

This method can be reimplemented in a derived class.

receivers

Signature: [const] int receivers (string signal)

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

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QAudioDecoderControl::senderSignalIndex()

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

setAudioFormat

Signature: void setAudioFormat (const QAudioFormat format)

Description: Virtual method void QAudioDecoderControl::setAudioFormat(const QAudioFormat &format)

This method can be reimplemented in a derived class.

setSourceDevice

Signature: void setSourceDevice (QIODevice ptr device)

Description: Virtual method void QAudioDecoderControl::setSourceDevice(QIODevice *device)

This method can be reimplemented in a derived class.

setSourceFilename

Signature: void setSourceFilename (string fileName)

Description: Virtual method void QAudioDecoderControl::setSourceFilename(const QString &fileName)

This method can be reimplemented in a derived class.

sourceChanged

Signature: [signal] void sourceChanged

Description: Signal declaration for QAudioDecoderControl::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: Virtual method QIODevice *QAudioDecoderControl::sourceDevice()

This method can be reimplemented in a derived class.

sourceDevice=

Signature: void sourceDevice= (QIODevice ptr device)

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

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

sourceFilename

Signature: [const] string sourceFilename

Description: Virtual method QString QAudioDecoderControl::sourceFilename()

This method can be reimplemented in a derived class.

sourceFilename=

Signature: void sourceFilename= (string fileName)

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

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

start

Signature: void start

Description: Virtual method void QAudioDecoderControl::start()

This method can be reimplemented in a derived class.

state

Signature: [const] QAudioDecoder_State state

Description: Virtual method QAudioDecoder::State QAudioDecoderControl::state()

This method can be reimplemented in a derived class.

stateChanged

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

Description: Signal declaration for QAudioDecoderControl::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: Virtual method void QAudioDecoderControl::stop()

This method can be reimplemented in a derived class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

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

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