API reference - Class QAbstractAudioDeviceInfo

Notation used in Ruby API documentation

Module: QtMultimedia

Description: Binding of QAbstractAudioDeviceInfo

Class hierarchy: QAbstractAudioDeviceInfo » QObject

Public constructors

new QAbstractAudioDeviceInfonewConstructor QAbstractAudioDeviceInfo::QAbstractAudioDeviceInfo()

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]stringdeviceNameVirtual method QString QAbstractAudioDeviceInfo::deviceName()
boolevent(QEvent ptr arg1)Virtual method bool QAbstractAudioDeviceInfo::event(QEvent *)
booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QAbstractAudioDeviceInfo::eventFilter(QObject *, QEvent *)
[const]boolisFormatSupported(const QAudioFormat format)Virtual method bool QAbstractAudioDeviceInfo::isFormatSupported(const QAudioFormat &format)
[const]boolisFormatSupported?(const QAudioFormat format)Method bool QAbstractAudioDeviceInfo::isFormatSupported(const QAudioFormat &format)
[const]QAudioFormatpreferredFormatVirtual method QAudioFormat QAbstractAudioDeviceInfo::preferredFormat()
QAudioFormat_Endian[]supportedByteOrdersVirtual method QList<QAudioFormat::Endian> QAbstractAudioDeviceInfo::supportedByteOrders()
int[]supportedChannelCountsVirtual method QList<int> QAbstractAudioDeviceInfo::supportedChannelCounts()
string[]supportedCodecsVirtual method QStringList QAbstractAudioDeviceInfo::supportedCodecs()
int[]supportedSampleRatesVirtual method QList<int> QAbstractAudioDeviceInfo::supportedSampleRates()
int[]supportedSampleSizesVirtual method QList<int> QAbstractAudioDeviceInfo::supportedSampleSizes()
QAudioFormat_SampleType[]supportedSampleTypesVirtual method QList<QAudioFormat::SampleType> QAbstractAudioDeviceInfo::supportedSampleTypes()

Public static methods and constants

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

Protected methods (static, non-static and constructors)

voidchildEvent(QChildEvent ptr arg1)Virtual method void QAbstractAudioDeviceInfo::childEvent(QChildEvent *)
voidcustomEvent(QEvent ptr arg1)Virtual method void QAbstractAudioDeviceInfo::customEvent(QEvent *)
voiddisconnectNotify(const QMetaMethod signal)Virtual method void QAbstractAudioDeviceInfo::disconnectNotify(const QMetaMethod &signal)
[const]boolisSignalConnected(const QMetaMethod signal)Method bool QAbstractAudioDeviceInfo::isSignalConnected(const QMetaMethod &signal)
[const]intreceivers(string signal)Method int QAbstractAudioDeviceInfo::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QAbstractAudioDeviceInfo::sender()
[const]intsenderSignalIndexMethod int QAbstractAudioDeviceInfo::senderSignalIndex()
voidtimerEvent(QTimerEvent ptr arg1)Virtual method void QAbstractAudioDeviceInfo::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 QAbstractAudioDeviceInfo::childEvent(QChildEvent *)

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

deviceName

Signature: [const] string deviceName

Description: Virtual method QString QAbstractAudioDeviceInfo::deviceName()

This method can be reimplemented in a derived class.

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

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

This method can be reimplemented in a derived class.

event

Signature: bool event (QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

isFormatSupported

Signature: [const] bool isFormatSupported (const QAudioFormat format)

Description: Virtual method bool QAbstractAudioDeviceInfo::isFormatSupported(const QAudioFormat &format)

This method can be reimplemented in a derived class.

isFormatSupported?

Signature: [const] bool isFormatSupported? (const QAudioFormat format)

Description: Method bool QAbstractAudioDeviceInfo::isFormatSupported(const QAudioFormat &format)

isSignalConnected

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

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

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

new

Signature: [static] new QAbstractAudioDeviceInfo new

Description: Constructor QAbstractAudioDeviceInfo::QAbstractAudioDeviceInfo()

This method creates an object of class QAbstractAudioDeviceInfo.

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

preferredFormat

Signature: [const] QAudioFormat preferredFormat

Description: Virtual method QAudioFormat QAbstractAudioDeviceInfo::preferredFormat()

This method can be reimplemented in a derived class.

receivers

Signature: [const] int receivers (string signal)

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

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QAbstractAudioDeviceInfo::senderSignalIndex()

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

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

supportedByteOrders

Signature: QAudioFormat_Endian[] supportedByteOrders

Description: Virtual method QList<QAudioFormat::Endian> QAbstractAudioDeviceInfo::supportedByteOrders()

This method can be reimplemented in a derived class.

supportedChannelCounts

Signature: int[] supportedChannelCounts

Description: Virtual method QList<int> QAbstractAudioDeviceInfo::supportedChannelCounts()

This method can be reimplemented in a derived class.

supportedCodecs

Signature: string[] supportedCodecs

Description: Virtual method QStringList QAbstractAudioDeviceInfo::supportedCodecs()

This method can be reimplemented in a derived class.

supportedSampleRates

Signature: int[] supportedSampleRates

Description: Virtual method QList<int> QAbstractAudioDeviceInfo::supportedSampleRates()

This method can be reimplemented in a derived class.

supportedSampleSizes

Signature: int[] supportedSampleSizes

Description: Virtual method QList<int> QAbstractAudioDeviceInfo::supportedSampleSizes()

This method can be reimplemented in a derived class.

supportedSampleTypes

Signature: QAudioFormat_SampleType[] supportedSampleTypes

Description: Virtual method QList<QAudioFormat::SampleType> QAbstractAudioDeviceInfo::supportedSampleTypes()

This method can be reimplemented in a derived class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr arg1)

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

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