API reference - Class QAudioInput

_const_cast

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

bufferSize

Signature: [const] int bufferSize

Description: Method int QAudioInput::bufferSize()

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

bufferSize=

Signature: void bufferSize= (int bytes)

Description: Method void QAudioInput::setBufferSize(int bytes)

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

bytesReady

Signature: [const] int bytesReady

Description: Method int QAudioInput::bytesReady()

childEvent

Signature: void childEvent (QChildEvent ptr event)

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

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

destroyed

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

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

This method can be reimplemented in a derived class.

elapsedUSecs

Signature: [const] long long elapsedUSecs

Description: Method qint64 QAudioInput::elapsedUSecs()

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

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

Call this method to emit this signal.

emit_notify

Signature: void emit_notify

Description: Emitter for signal void QAudioInput::notify()

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

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

Call this method to emit this signal.

emit_stateChanged

Signature: void emit_stateChanged (const QAudio_State state)

Description: Emitter for signal void QAudioInput::stateChanged(QAudio::State state)

Call this method to emit this signal.

error

Signature: [const] QAudio_Error error

Description: Method QAudio::Error QAudioInput::error()

event

Signature: bool event (QEvent ptr event)

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

This method can be reimplemented in a derived class.

format

Signature: [const] QAudioFormat format

Description: Method QAudioFormat QAudioInput::format()

isSignalConnected

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

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

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

new

(1) Signature: [static] new QAudioInput new (const QAudioFormat format = QAudioFormat(), QObject ptr parent = nullptr)

Description: Constructor QAudioInput::QAudioInput(const QAudioFormat &format, QObject *parent)

This method creates an object of class QAudioInput.

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

(2) Signature: [static] new QAudioInput new (const QAudioDeviceInfo audioDeviceInfo, const QAudioFormat format = QAudioFormat(), QObject ptr parent = nullptr)

Description: Constructor QAudioInput::QAudioInput(const QAudioDeviceInfo &audioDeviceInfo, const QAudioFormat &format, QObject *parent)

This method creates an object of class QAudioInput.

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

notify

Signature: [signal] void notify

Description: Signal declaration for QAudioInput::notify()

You can bind a procedure to this signal.

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

notifyInterval

Signature: [const] int notifyInterval

Description: Method int QAudioInput::notifyInterval()

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

notifyInterval=

Signature: void notifyInterval= (int milliSeconds)

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

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

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

periodSize

Signature: [const] int periodSize

Description: Method int QAudioInput::periodSize()

processedUSecs

Signature: [const] long long processedUSecs

Description: Method qint64 QAudioInput::processedUSecs()

receivers

Signature: [const] int receivers (string signal)

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

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

reset

Signature: void reset

Description: Method void QAudioInput::reset()

resume

Signature: void resume

Description: Method void QAudioInput::resume()

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QAudioInput::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QAudioInput::senderSignalIndex()

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

setBufferSize

Signature: void setBufferSize (int bytes)

Description: Method void QAudioInput::setBufferSize(int bytes)

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

setNotifyInterval

Signature: void setNotifyInterval (int milliSeconds)

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

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

setVolume

Signature: void setVolume (double volume)

Description: Method void QAudioInput::setVolume(double volume)

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

start

(1) Signature: void start (QIODevice ptr device)

Description: Method void QAudioInput::start(QIODevice *device)

(2) Signature: QIODevice ptr start

Description: Method QIODevice *QAudioInput::start()

state

Signature: [const] QAudio_State state

Description: Method QAudio::State QAudioInput::state()

stateChanged

Signature: [signal] void stateChanged (const QAudio_State state)

Description: Signal declaration for QAudioInput::stateChanged(QAudio::State state)

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 QAudioInput::stop()

suspend

Signature: void suspend

Description: Method void QAudioInput::suspend()

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

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

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

volume

Signature: [const] double volume

Description: Method double QAudioInput::volume()

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

volume=

Signature: void volume= (double volume)

Description: Method void QAudioInput::setVolume(double volume)

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