API reference - Class QAudioDecoder

Notation used in Ruby API documentation

Module: QtMultimedia

Description: Binding of QAudioDecoder

Class hierarchy: QAudioDecoder » QMediaObject » QObject

Sub-classes: Error, QFlags_Error, State, QFlags_State

Public constructors

new QAudioDecodernew(QObject ptr parent = 0)Constructor QAudioDecoder::QAudioDecoder(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.
[const]QAudioFormataudioFormatMethod QAudioFormat QAudioDecoder::audioFormat()
voidaudioFormat=(const QAudioFormat format)Method void QAudioDecoder::setAudioFormat(const QAudioFormat &format)
[const]QMultimedia_AvailabilityStatusavailabilityVirtual method QMultimedia::AvailabilityStatus QAudioDecoder::availability()
boolbind(QObject ptr arg1)Virtual method bool QAudioDecoder::bind(QObject *)
[const]boolbufferAvailableMethod bool QAudioDecoder::bufferAvailable()
voidbufferAvailableChanged(bool arg1)Method void QAudioDecoder::bufferAvailableChanged(bool)
voidbufferReadyMethod void QAudioDecoder::bufferReady()
[const]long longdurationMethod qint64 QAudioDecoder::duration()
voiddurationChanged(long long duration)Method void QAudioDecoder::durationChanged(qint64 duration)
[const]QAudioDecoder_ErrorerrorMethod QAudioDecoder::Error QAudioDecoder::error()
[const]stringerrorStringMethod QString QAudioDecoder::errorString()
voiderror_sig(const QAudioDecoder_Error error)Method void QAudioDecoder::error(QAudioDecoder::Error error)
boolevent(QEvent ptr arg1)Virtual method bool QAudioDecoder::event(QEvent *)
booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QAudioDecoder::eventFilter(QObject *, QEvent *)
voidfinishedMethod void QAudioDecoder::finished()
voidformatChanged(const QAudioFormat format)Method void QAudioDecoder::formatChanged(const QAudioFormat &format)
[const]boolisAvailableVirtual method bool QAudioDecoder::isAvailable()
[const]long longpositionMethod qint64 QAudioDecoder::position()
voidpositionChanged(long long position)Method void QAudioDecoder::positionChanged(qint64 position)
[const]QAudioBufferreadMethod QAudioBuffer QAudioDecoder::read()
[const]QMediaService ptrserviceVirtual method QMediaService *QAudioDecoder::service()
voidsetAudioFormat(const QAudioFormat format)Method void QAudioDecoder::setAudioFormat(const QAudioFormat &format)
voidsetSourceDevice(QIODevice ptr device)Method void QAudioDecoder::setSourceDevice(QIODevice *device)
voidsetSourceFilename(string fileName)Method void QAudioDecoder::setSourceFilename(const QString &fileName)
voidsourceChangedMethod void QAudioDecoder::sourceChanged()
[const]QIODevice ptrsourceDeviceMethod QIODevice *QAudioDecoder::sourceDevice()
voidsourceDevice=(QIODevice ptr device)Method void QAudioDecoder::setSourceDevice(QIODevice *device)
[const]stringsourceFilenameMethod QString QAudioDecoder::sourceFilename()
voidsourceFilename=(string fileName)Method void QAudioDecoder::setSourceFilename(const QString &fileName)
voidstartMethod void QAudioDecoder::start()
[const]QAudioDecoder_StatestateMethod QAudioDecoder::State QAudioDecoder::state()
voidstateChanged(const QAudioDecoder_State newState)Method void QAudioDecoder::stateChanged(QAudioDecoder::State newState)
voidstopMethod void QAudioDecoder::stop()
voidunbind(QObject ptr arg1)Virtual method void QAudioDecoder::unbind(QObject *)

Public static methods and constants

[static,const]QAudioDecoder_ErrorAccessDeniedErrorEnum constant QAudioDecoder::AccessDeniedError
[static,const]QAudioDecoder_StateDecodingStateEnum constant QAudioDecoder::DecodingState
[static,const]QAudioDecoder_ErrorFormatErrorEnum constant QAudioDecoder::FormatError
[static,const]QAudioDecoder_ErrorNoErrorEnum constant QAudioDecoder::NoError
[static,const]QAudioDecoder_ErrorResourceErrorEnum constant QAudioDecoder::ResourceError
[static,const]QAudioDecoder_ErrorServiceMissingErrorEnum constant QAudioDecoder::ServiceMissingError
[static,const]QAudioDecoder_StateStoppedStateEnum constant QAudioDecoder::StoppedState
QMultimedia_SupportEstimatehasSupport(string mimeType,
string[] codecs = QStringList())
Static method QMultimedia::SupportEstimate QAudioDecoder::hasSupport(const QString &mimeType, const QStringList &codecs)
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = nullptr,
int n = -1)
Static method QString QAudioDecoder::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = nullptr,
int n = -1)
Static method QString QAudioDecoder::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

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

Detailed description

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.

_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(QByteArray const &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.

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: void bufferAvailableChanged (bool arg1)

Description: Method void QAudioDecoder::bufferAvailableChanged(bool)

bufferReady

Signature: void bufferReady

Description: Method void QAudioDecoder::bufferReady()

childEvent

Signature: void childEvent (QChildEvent ptr arg1)

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

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

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: void durationChanged (long long duration)

Description: Method void QAudioDecoder::durationChanged(qint64 duration)

error

Signature: [const] QAudioDecoder_Error error

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

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

errorString

Signature: [const] string errorString

Description: Method QString QAudioDecoder::errorString()

error_sig

Signature: void error_sig (const QAudioDecoder_Error error)

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

event

Signature: bool event (QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

finished

Signature: void finished

Description: Method void QAudioDecoder::finished()

formatChanged

Signature: void formatChanged (const QAudioFormat format)

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

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.

new

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

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.

position

Signature: [const] long long position

Description: Method qint64 QAudioDecoder::position()

positionChanged

Signature: void positionChanged (long long position)

Description: Method void QAudioDecoder::positionChanged(qint64 position)

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(QByteArray const &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: void sourceChanged

Description: Method void QAudioDecoder::sourceChanged()

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: void stateChanged (const QAudioDecoder_State newState)

Description: Method void QAudioDecoder::stateChanged(QAudioDecoder::State newState)

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 arg1)

Description: Virtual method void QAudioDecoder::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 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.