KLayout 0.29.8 (2024-10-28 63dd591e5) [master]

API reference - Class QCameraImageCaptureControl

Notation used in Ruby API documentation

Module: QtMultimedia

Description: Binding of QCameraImageCaptureControl

Class hierarchy: QCameraImageCaptureControl » QMediaControl » QObject

Public constructors

new QCameraImageCaptureControlnewConstructor QCameraImageCaptureControl::QCameraImageCaptureControl()

Public methods

[const]QCameraImageCaptureControl 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.
voidcancelCaptureVirtual method void QCameraImageCaptureControl::cancelCapture()
intcapture(string fileName)Virtual method int QCameraImageCaptureControl::capture(const QString &fileName)
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QCameraImageCaptureControl::destroyed(QObject *)
[const]QCameraImageCapture_DriveModedriveModeVirtual method QCameraImageCapture::DriveMode QCameraImageCaptureControl::driveMode()
voiddriveMode=(const QCameraImageCapture_DriveMode mode)Method void QCameraImageCaptureControl::setDriveMode(QCameraImageCapture::DriveMode mode)
voidemit_destroyed(QObject ptr arg1 = nullptr)Emitter for signal void QCameraImageCaptureControl::destroyed(QObject *)
voidemit_error(int id,
int error,
string errorString)
Emitter for signal void QCameraImageCaptureControl::error(int id, int error, const QString &errorString)
voidemit_imageAvailable(int requestId,
const QVideoFrame buffer)
Emitter for signal void QCameraImageCaptureControl::imageAvailable(int requestId, const QVideoFrame &buffer)
voidemit_imageCaptured(int requestId,
const QImage preview)
Emitter for signal void QCameraImageCaptureControl::imageCaptured(int requestId, const QImage &preview)
voidemit_imageExposed(int requestId)Emitter for signal void QCameraImageCaptureControl::imageExposed(int requestId)
voidemit_imageMetadataAvailable(int id,
string key,
variant value)
Emitter for signal void QCameraImageCaptureControl::imageMetadataAvailable(int id, const QString &key, const QVariant &value)
voidemit_imageSaved(int requestId,
string fileName)
Emitter for signal void QCameraImageCaptureControl::imageSaved(int requestId, const QString &fileName)
voidemit_objectNameChanged(string objectName)Emitter for signal void QCameraImageCaptureControl::objectNameChanged(const QString &objectName)
voidemit_readyForCaptureChanged(bool ready)Emitter for signal void QCameraImageCaptureControl::readyForCaptureChanged(bool ready)
[signal]voiderror(int id,
int error,
string errorString)
Signal declaration for QCameraImageCaptureControl::error(int id, int error, const QString &errorString)
boolevent(QEvent ptr event)Virtual method bool QCameraImageCaptureControl::event(QEvent *event)
booleventFilter(QObject ptr watched,
QEvent ptr event)
Virtual method bool QCameraImageCaptureControl::eventFilter(QObject *watched, QEvent *event)
[signal]voidimageAvailable(int requestId,
const QVideoFrame buffer)
Signal declaration for QCameraImageCaptureControl::imageAvailable(int requestId, const QVideoFrame &buffer)
[signal]voidimageCaptured(int requestId,
const QImage preview)
Signal declaration for QCameraImageCaptureControl::imageCaptured(int requestId, const QImage &preview)
[signal]voidimageExposed(int requestId)Signal declaration for QCameraImageCaptureControl::imageExposed(int requestId)
[signal]voidimageMetadataAvailable(int id,
string key,
variant value)
Signal declaration for QCameraImageCaptureControl::imageMetadataAvailable(int id, const QString &key, const QVariant &value)
[signal]voidimageSaved(int requestId,
string fileName)
Signal declaration for QCameraImageCaptureControl::imageSaved(int requestId, const QString &fileName)
[const]boolisReadyForCaptureVirtual method bool QCameraImageCaptureControl::isReadyForCapture()
[const]boolisReadyForCapture?Method bool QCameraImageCaptureControl::isReadyForCapture()
[signal]voidobjectNameChanged(string objectName)Signal declaration for QCameraImageCaptureControl::objectNameChanged(const QString &objectName)
[signal]voidreadyForCaptureChanged(bool ready)Signal declaration for QCameraImageCaptureControl::readyForCaptureChanged(bool ready)
voidsetDriveMode(const QCameraImageCapture_DriveMode mode)Virtual method void QCameraImageCaptureControl::setDriveMode(QCameraImageCapture::DriveMode mode)

Public static methods and constants

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

Protected methods (static, non-static and constructors)

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

Detailed description

_const_cast

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

cancelCapture

Signature: void cancelCapture

Description: Virtual method void QCameraImageCaptureControl::cancelCapture()

This method can be reimplemented in a derived class.

capture

Signature: int capture (string fileName)

Description: Virtual method int QCameraImageCaptureControl::capture(const QString &fileName)

This method can be reimplemented in a derived class.

childEvent

Signature: void childEvent (QChildEvent ptr event)

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

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

destroyed

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

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

This method can be reimplemented in a derived class.

driveMode

Signature: [const] QCameraImageCapture_DriveMode driveMode

Description: Virtual method QCameraImageCapture::DriveMode QCameraImageCaptureControl::driveMode()

This method can be reimplemented in a derived class.

driveMode=

Signature: void driveMode= (const QCameraImageCapture_DriveMode mode)

Description: Method void QCameraImageCaptureControl::setDriveMode(QCameraImageCapture::DriveMode mode)

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

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

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

Call this method to emit this signal.

emit_error

Signature: void emit_error (int id, int error, string errorString)

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

Call this method to emit this signal.

emit_imageAvailable

Signature: void emit_imageAvailable (int requestId, const QVideoFrame buffer)

Description: Emitter for signal void QCameraImageCaptureControl::imageAvailable(int requestId, const QVideoFrame &buffer)

Call this method to emit this signal.

emit_imageCaptured

Signature: void emit_imageCaptured (int requestId, const QImage preview)

Description: Emitter for signal void QCameraImageCaptureControl::imageCaptured(int requestId, const QImage &preview)

Call this method to emit this signal.

emit_imageExposed

Signature: void emit_imageExposed (int requestId)

Description: Emitter for signal void QCameraImageCaptureControl::imageExposed(int requestId)

Call this method to emit this signal.

emit_imageMetadataAvailable

Signature: void emit_imageMetadataAvailable (int id, string key, variant value)

Description: Emitter for signal void QCameraImageCaptureControl::imageMetadataAvailable(int id, const QString &key, const QVariant &value)

Call this method to emit this signal.

emit_imageSaved

Signature: void emit_imageSaved (int requestId, string fileName)

Description: Emitter for signal void QCameraImageCaptureControl::imageSaved(int requestId, const QString &fileName)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

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

Call this method to emit this signal.

emit_readyForCaptureChanged

Signature: void emit_readyForCaptureChanged (bool ready)

Description: Emitter for signal void QCameraImageCaptureControl::readyForCaptureChanged(bool ready)

Call this method to emit this signal.

error

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

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

This method can be reimplemented in a derived class.

imageAvailable

Signature: [signal] void imageAvailable (int requestId, const QVideoFrame buffer)

Description: Signal declaration for QCameraImageCaptureControl::imageAvailable(int requestId, const QVideoFrame &buffer)

You can bind a procedure to this signal.

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

imageCaptured

Signature: [signal] void imageCaptured (int requestId, const QImage preview)

Description: Signal declaration for QCameraImageCaptureControl::imageCaptured(int requestId, const QImage &preview)

You can bind a procedure to this signal.

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

imageExposed

Signature: [signal] void imageExposed (int requestId)

Description: Signal declaration for QCameraImageCaptureControl::imageExposed(int requestId)

You can bind a procedure to this signal.

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

imageMetadataAvailable

Signature: [signal] void imageMetadataAvailable (int id, string key, variant value)

Description: Signal declaration for QCameraImageCaptureControl::imageMetadataAvailable(int id, const QString &key, const QVariant &value)

You can bind a procedure to this signal.

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

imageSaved

Signature: [signal] void imageSaved (int requestId, string fileName)

Description: Signal declaration for QCameraImageCaptureControl::imageSaved(int requestId, const QString &fileName)

You can bind a procedure to this signal.

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

isReadyForCapture

Signature: [const] bool isReadyForCapture

Description: Virtual method bool QCameraImageCaptureControl::isReadyForCapture()

This method can be reimplemented in a derived class.

isReadyForCapture?

Signature: [const] bool isReadyForCapture?

Description: Method bool QCameraImageCaptureControl::isReadyForCapture()

isSignalConnected

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

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

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

new

Signature: [static] new QCameraImageCaptureControl new

Description: Constructor QCameraImageCaptureControl::QCameraImageCaptureControl()

This method creates an object of class QCameraImageCaptureControl.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

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

readyForCaptureChanged

Signature: [signal] void readyForCaptureChanged (bool ready)

Description: Signal declaration for QCameraImageCaptureControl::readyForCaptureChanged(bool ready)

You can bind a procedure to this signal.

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

receivers

Signature: [const] int receivers (string signal)

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

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QCameraImageCaptureControl::senderSignalIndex()

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

setDriveMode

Signature: void setDriveMode (const QCameraImageCapture_DriveMode mode)

Description: Virtual method void QCameraImageCaptureControl::setDriveMode(QCameraImageCapture::DriveMode mode)

This method can be reimplemented in a derived class.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

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

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