KLayout 0.29.8 (2024-11-26 926dac96c) [master]

API reference - Class QMediaRecorderControl

Notation used in Ruby API documentation

Module: QtMultimedia

Description: Binding of QMediaRecorderControl

Class hierarchy: QMediaRecorderControl » QMediaControl » QObject

Public constructors

new QMediaRecorderControlnewConstructor QMediaRecorderControl::QMediaRecorderControl()

Public methods

[const]QMediaRecorderControl ptr_const_castReturns a non-const reference to self.
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.
[signal]voidactualLocationChanged(const QUrl location)Signal declaration for QMediaRecorderControl::actualLocationChanged(const QUrl &location)
voidapplySettingsVirtual method void QMediaRecorderControl::applySettings()
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QMediaRecorderControl::destroyed(QObject *)
[const]long longdurationVirtual method qint64 QMediaRecorderControl::duration()
[signal]voiddurationChanged(long long position)Signal declaration for QMediaRecorderControl::durationChanged(qint64 position)
voidemit_actualLocationChanged(const QUrl location)Emitter for signal void QMediaRecorderControl::actualLocationChanged(const QUrl &location)
voidemit_destroyed(QObject ptr arg1 = nullptr)Emitter for signal void QMediaRecorderControl::destroyed(QObject *)
voidemit_durationChanged(long long position)Emitter for signal void QMediaRecorderControl::durationChanged(qint64 position)
voidemit_error(int error,
string errorString)
Emitter for signal void QMediaRecorderControl::error(int error, const QString &errorString)
voidemit_mutedChanged(bool muted)Emitter for signal void QMediaRecorderControl::mutedChanged(bool muted)
voidemit_objectNameChanged(string objectName)Emitter for signal void QMediaRecorderControl::objectNameChanged(const QString &objectName)
voidemit_stateChanged(const QMediaRecorder_State state)Emitter for signal void QMediaRecorderControl::stateChanged(QMediaRecorder::State state)
voidemit_statusChanged(const QMediaRecorder_Status status)Emitter for signal void QMediaRecorderControl::statusChanged(QMediaRecorder::Status status)
voidemit_volumeChanged(double volume)Emitter for signal void QMediaRecorderControl::volumeChanged(double volume)
[signal]voiderror(int error,
string errorString)
Signal declaration for QMediaRecorderControl::error(int error, const QString &errorString)
boolevent(QEvent ptr event)Virtual method bool QMediaRecorderControl::event(QEvent *event)
booleventFilter(QObject ptr watched,
QEvent ptr event)
Virtual method bool QMediaRecorderControl::eventFilter(QObject *watched, QEvent *event)
[const]boolisMutedVirtual method bool QMediaRecorderControl::isMuted()
[const]boolisMuted?Method bool QMediaRecorderControl::isMuted()
[const]boolmutedMethod bool QMediaRecorderControl::isMuted()
voidmuted=(bool muted)Method void QMediaRecorderControl::setMuted(bool muted)
[signal]voidmutedChanged(bool muted)Signal declaration for QMediaRecorderControl::mutedChanged(bool muted)
[signal]voidobjectNameChanged(string objectName)Signal declaration for QMediaRecorderControl::objectNameChanged(const QString &objectName)
[const]QUrloutputLocationVirtual method QUrl QMediaRecorderControl::outputLocation()
voidsetMuted(bool muted)Virtual method void QMediaRecorderControl::setMuted(bool muted)
boolsetOutputLocation(const QUrl location)Virtual method bool QMediaRecorderControl::setOutputLocation(const QUrl &location)
voidsetState(const QMediaRecorder_State state)Virtual method void QMediaRecorderControl::setState(QMediaRecorder::State state)
voidsetVolume(double volume)Virtual method void QMediaRecorderControl::setVolume(double volume)
[const]QMediaRecorder_StatestateVirtual method QMediaRecorder::State QMediaRecorderControl::state()
voidstate=(const QMediaRecorder_State state)Method void QMediaRecorderControl::setState(QMediaRecorder::State state)
[signal]voidstateChanged(const QMediaRecorder_State state)Signal declaration for QMediaRecorderControl::stateChanged(QMediaRecorder::State state)
[const]QMediaRecorder_StatusstatusVirtual method QMediaRecorder::Status QMediaRecorderControl::status()
[signal]voidstatusChanged(const QMediaRecorder_Status status)Signal declaration for QMediaRecorderControl::statusChanged(QMediaRecorder::Status status)
[const]doublevolumeVirtual method double QMediaRecorderControl::volume()
voidvolume=(double volume)Method void QMediaRecorderControl::setVolume(double volume)
[signal]voidvolumeChanged(double volume)Signal declaration for QMediaRecorderControl::volumeChanged(double volume)

Public static methods and constants

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

Protected methods (static, non-static and constructors)

voidchildEvent(QChildEvent ptr event)Virtual method void QMediaRecorderControl::childEvent(QChildEvent *event)
voidcustomEvent(QEvent ptr event)Virtual method void QMediaRecorderControl::customEvent(QEvent *event)
voiddisconnectNotify(const QMetaMethod signal)Virtual method void QMediaRecorderControl::disconnectNotify(const QMetaMethod &signal)
[const]boolisSignalConnected(const QMetaMethod signal)Method bool QMediaRecorderControl::isSignalConnected(const QMetaMethod &signal)
[const]intreceivers(string signal)Method int QMediaRecorderControl::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QMediaRecorderControl::sender()
[const]intsenderSignalIndexMethod int QMediaRecorderControl::senderSignalIndex()
voidtimerEvent(QTimerEvent ptr event)Virtual method void QMediaRecorderControl::timerEvent(QTimerEvent *event)

Detailed description

_const_cast

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

actualLocationChanged

Signature: [signal] void actualLocationChanged (const QUrl location)

Description: Signal declaration for QMediaRecorderControl::actualLocationChanged(const QUrl &location)

You can bind a procedure to this signal.

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

applySettings

Signature: void applySettings

Description: Virtual method void QMediaRecorderControl::applySettings()

This method can be reimplemented in a derived class.

childEvent

Signature: void childEvent (QChildEvent ptr event)

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

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

destroyed

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

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

This method can be reimplemented in a derived class.

duration

Signature: [const] long long duration

Description: Virtual method qint64 QMediaRecorderControl::duration()

This method can be reimplemented in a derived class.

durationChanged

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

Description: Signal declaration for QMediaRecorderControl::durationChanged(qint64 position)

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_actualLocationChanged

Signature: void emit_actualLocationChanged (const QUrl location)

Description: Emitter for signal void QMediaRecorderControl::actualLocationChanged(const QUrl &location)

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

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

Call this method to emit this signal.

emit_durationChanged

Signature: void emit_durationChanged (long long position)

Description: Emitter for signal void QMediaRecorderControl::durationChanged(qint64 position)

Call this method to emit this signal.

emit_error

Signature: void emit_error (int error, string errorString)

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

Call this method to emit this signal.

emit_mutedChanged

Signature: void emit_mutedChanged (bool muted)

Description: Emitter for signal void QMediaRecorderControl::mutedChanged(bool muted)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

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

Call this method to emit this signal.

emit_stateChanged

Signature: void emit_stateChanged (const QMediaRecorder_State state)

Description: Emitter for signal void QMediaRecorderControl::stateChanged(QMediaRecorder::State state)

Call this method to emit this signal.

emit_statusChanged

Signature: void emit_statusChanged (const QMediaRecorder_Status status)

Description: Emitter for signal void QMediaRecorderControl::statusChanged(QMediaRecorder::Status status)

Call this method to emit this signal.

emit_volumeChanged

Signature: void emit_volumeChanged (double volume)

Description: Emitter for signal void QMediaRecorderControl::volumeChanged(double volume)

Call this method to emit this signal.

error

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

Description: Signal declaration for QMediaRecorderControl::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 QMediaRecorderControl::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 QMediaRecorderControl::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

isMuted

Signature: [const] bool isMuted

Description: Virtual method bool QMediaRecorderControl::isMuted()

This method can be reimplemented in a derived class.

isMuted?

Signature: [const] bool isMuted?

Description: Method bool QMediaRecorderControl::isMuted()

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

isSignalConnected

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

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

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

muted

Signature: [const] bool muted

Description: Method bool QMediaRecorderControl::isMuted()

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

muted=

Signature: void muted= (bool muted)

Description: Method void QMediaRecorderControl::setMuted(bool muted)

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

mutedChanged

Signature: [signal] void mutedChanged (bool muted)

Description: Signal declaration for QMediaRecorderControl::mutedChanged(bool muted)

You can bind a procedure to this signal.

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

new

Signature: [static] new QMediaRecorderControl new

Description: Constructor QMediaRecorderControl::QMediaRecorderControl()

This method creates an object of class QMediaRecorderControl.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

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

outputLocation

Signature: [const] QUrl outputLocation

Description: Virtual method QUrl QMediaRecorderControl::outputLocation()

This method can be reimplemented in a derived class.

receivers

Signature: [const] int receivers (string signal)

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

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QMediaRecorderControl::senderSignalIndex()

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

setMuted

Signature: void setMuted (bool muted)

Description: Virtual method void QMediaRecorderControl::setMuted(bool muted)

This method can be reimplemented in a derived class.

setOutputLocation

Signature: bool setOutputLocation (const QUrl location)

Description: Virtual method bool QMediaRecorderControl::setOutputLocation(const QUrl &location)

This method can be reimplemented in a derived class.

setState

Signature: void setState (const QMediaRecorder_State state)

Description: Virtual method void QMediaRecorderControl::setState(QMediaRecorder::State state)

This method can be reimplemented in a derived class.

setVolume

Signature: void setVolume (double volume)

Description: Virtual method void QMediaRecorderControl::setVolume(double volume)

This method can be reimplemented in a derived class.

state

Signature: [const] QMediaRecorder_State state

Description: Virtual method QMediaRecorder::State QMediaRecorderControl::state()

This method can be reimplemented in a derived class.

state=

Signature: void state= (const QMediaRecorder_State state)

Description: Method void QMediaRecorderControl::setState(QMediaRecorder::State state)

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

stateChanged

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

Description: Signal declaration for QMediaRecorderControl::stateChanged(QMediaRecorder::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.

status

Signature: [const] QMediaRecorder_Status status

Description: Virtual method QMediaRecorder::Status QMediaRecorderControl::status()

This method can be reimplemented in a derived class.

statusChanged

Signature: [signal] void statusChanged (const QMediaRecorder_Status status)

Description: Signal declaration for QMediaRecorderControl::statusChanged(QMediaRecorder::Status status)

You can bind a procedure to this signal.

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

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QMediaRecorderControl::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 QMediaRecorderControl::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 QMediaRecorderControl::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: Virtual method double QMediaRecorderControl::volume()

This method can be reimplemented in a derived class.

volume=

Signature: void volume= (double volume)

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

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

volumeChanged

Signature: [signal] void volumeChanged (double volume)

Description: Signal declaration for QMediaRecorderControl::volumeChanged(double volume)

You can bind a procedure to this signal.

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