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

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)
[const]QCameraImageCapture_DriveModedriveModeVirtual method QCameraImageCapture::DriveMode QCameraImageCaptureControl::driveMode()
voiddriveMode=(const QCameraImageCapture_DriveMode mode)Method void QCameraImageCaptureControl::setDriveMode(QCameraImageCapture::DriveMode mode)
voiderror(int id,
int error,
string errorString)
Method void QCameraImageCaptureControl::error(int id, int error, const QString &errorString)
boolevent(QEvent ptr arg1)Virtual method bool QCameraImageCaptureControl::event(QEvent *)
booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QCameraImageCaptureControl::eventFilter(QObject *, QEvent *)
voidimageAvailable(int id,
const QVideoFrame buffer)
Method void QCameraImageCaptureControl::imageAvailable(int id, const QVideoFrame &buffer)
voidimageCaptured(int id,
const QImage preview)
Method void QCameraImageCaptureControl::imageCaptured(int id, const QImage &preview)
voidimageExposed(int id)Method void QCameraImageCaptureControl::imageExposed(int id)
voidimageMetadataAvailable(int id,
string key,
variant value)
Method void QCameraImageCaptureControl::imageMetadataAvailable(int id, const QString &key, const QVariant &value)
voidimageSaved(int id,
string fileName)
Method void QCameraImageCaptureControl::imageSaved(int id, const QString &fileName)
[const]boolisReadyForCaptureVirtual method bool QCameraImageCaptureControl::isReadyForCapture()
[const]boolisReadyForCapture?Method bool QCameraImageCaptureControl::isReadyForCapture()
voidreadyForCaptureChanged(bool arg1)Method void QCameraImageCaptureControl::readyForCaptureChanged(bool)
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 arg1)Virtual method void QCameraImageCaptureControl::childEvent(QChildEvent *)
voidcustomEvent(QEvent ptr arg1)Virtual method void QCameraImageCaptureControl::customEvent(QEvent *)
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 arg1)Virtual method void QCameraImageCaptureControl::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.

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

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

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

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.

error

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

Description: Method void QCameraImageCaptureControl::error(int id, int error, const QString &errorString)

event

Signature: bool event (QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

imageAvailable

Signature: void imageAvailable (int id, const QVideoFrame buffer)

Description: Method void QCameraImageCaptureControl::imageAvailable(int id, const QVideoFrame &buffer)

imageCaptured

Signature: void imageCaptured (int id, const QImage preview)

Description: Method void QCameraImageCaptureControl::imageCaptured(int id, const QImage &preview)

imageExposed

Signature: void imageExposed (int id)

Description: Method void QCameraImageCaptureControl::imageExposed(int id)

imageMetadataAvailable

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

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

imageSaved

Signature: void imageSaved (int id, string fileName)

Description: Method void QCameraImageCaptureControl::imageSaved(int id, const QString &fileName)

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.

readyForCaptureChanged

Signature: void readyForCaptureChanged (bool arg1)

Description: Method void QCameraImageCaptureControl::readyForCaptureChanged(bool)

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

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