API reference - Class QCameraImageCapture

CaptureToBuffer

Signature: [static,const] QCameraImageCapture_CaptureDestination CaptureToBuffer

Description: Enum constant QCameraImageCapture::CaptureToBuffer

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

CaptureToFile

Signature: [static,const] QCameraImageCapture_CaptureDestination CaptureToFile

Description: Enum constant QCameraImageCapture::CaptureToFile

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

FormatError

Signature: [static,const] QCameraImageCapture_Error FormatError

Description: Enum constant QCameraImageCapture::FormatError

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

NoError

Signature: [static,const] QCameraImageCapture_Error NoError

Description: Enum constant QCameraImageCapture::NoError

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

NotReadyError

Signature: [static,const] QCameraImageCapture_Error NotReadyError

Description: Enum constant QCameraImageCapture::NotReadyError

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

NotSupportedFeatureError

Signature: [static,const] QCameraImageCapture_Error NotSupportedFeatureError

Description: Enum constant QCameraImageCapture::NotSupportedFeatureError

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

OutOfSpaceError

Signature: [static,const] QCameraImageCapture_Error OutOfSpaceError

Description: Enum constant QCameraImageCapture::OutOfSpaceError

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

ResourceError

Signature: [static,const] QCameraImageCapture_Error ResourceError

Description: Enum constant QCameraImageCapture::ResourceError

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

SingleImageCapture

Signature: [static,const] QCameraImageCapture_DriveMode SingleImageCapture

Description: Enum constant QCameraImageCapture::SingleImageCapture

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

_const_cast

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

asConstQMediaBindableInterface

Signature: [const] const QMediaBindableInterface ptr asConstQMediaBindableInterface

Description: Delivers the base class interface QMediaBindableInterface of QCameraImageCapture

Class QCameraImageCapture is derived from multiple base classes. This method delivers the QMediaBindableInterface base class aspect.

Use this version if you have a const reference.

asConstQObject

Signature: [const] const QObject ptr asConstQObject

Description: Delivers the base class interface QObject of QCameraImageCapture

Class QCameraImageCapture is derived from multiple base classes. This method delivers the QObject base class aspect.

Use this version if you have a const reference.

asQMediaBindableInterface

Signature: QMediaBindableInterface ptr asQMediaBindableInterface

Description: Delivers the base class interface QMediaBindableInterface of QCameraImageCapture

Class QCameraImageCapture is derived from multiple base classes. This method delivers the QMediaBindableInterface base class aspect.

asQObject

Signature: QObject ptr asQObject

Description: Delivers the base class interface QObject of QCameraImageCapture

Class QCameraImageCapture is derived from multiple base classes. This method delivers the QObject base class aspect.

availability

Signature: [const] QMultimedia_AvailabilityStatus availability

Description: Method QMultimedia::AvailabilityStatus QCameraImageCapture::availability()

bufferFormat

Signature: [const] QVideoFrame_PixelFormat bufferFormat

Description: Method QVideoFrame::PixelFormat QCameraImageCapture::bufferFormat()

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

bufferFormat=

Signature: void bufferFormat= (const QVideoFrame_PixelFormat format)

Description: Method void QCameraImageCapture::setBufferFormat(const QVideoFrame::PixelFormat format)

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

bufferFormatChanged

Signature: [signal] void bufferFormatChanged (const QVideoFrame_PixelFormat format)

Description: Signal declaration for QCameraImageCapture::bufferFormatChanged(QVideoFrame::PixelFormat format)

You can bind a procedure to this signal.

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

cancelCapture

Signature: void cancelCapture

Description: Method void QCameraImageCapture::cancelCapture()

capture

Signature: int capture (string location = QString())

Description: Method int QCameraImageCapture::capture(const QString &location)

captureDestination

Signature: [const] QCameraImageCapture_QFlags_CaptureDestination captureDestination

Description: Method QFlags<QCameraImageCapture::CaptureDestination> QCameraImageCapture::captureDestination()

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

captureDestination=

Signature: void captureDestination= (QCameraImageCapture_QFlags_CaptureDestination destination)

Description: Method void QCameraImageCapture::setCaptureDestination(QFlags<QCameraImageCapture::CaptureDestination> destination)

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

captureDestinationChanged

Signature: [signal] void captureDestinationChanged (QCameraImageCapture_QFlags_CaptureDestination destination)

Description: Signal declaration for QCameraImageCapture::captureDestinationChanged(QFlags<QCameraImageCapture::CaptureDestination> destination)

You can bind a procedure to this signal.

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

childEvent

Signature: void childEvent (QChildEvent ptr event)

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

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

destroyed

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

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

This method can be reimplemented in a derived class.

emit_bufferFormatChanged

Signature: void emit_bufferFormatChanged (const QVideoFrame_PixelFormat format)

Description: Emitter for signal void QCameraImageCapture::bufferFormatChanged(QVideoFrame::PixelFormat format)

Call this method to emit this signal.

emit_captureDestinationChanged

Signature: void emit_captureDestinationChanged (QCameraImageCapture_QFlags_CaptureDestination destination)

Description: Emitter for signal void QCameraImageCapture::captureDestinationChanged(QFlags<QCameraImageCapture::CaptureDestination> destination)

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

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

Call this method to emit this signal.

emit_error_sig

Signature: void emit_error_sig (int id, const QCameraImageCapture_Error error, string errorString)

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

Call this method to emit this signal.

emit_imageAvailable

Signature: void emit_imageAvailable (int id, const QVideoFrame frame)

Description: Emitter for signal void QCameraImageCapture::imageAvailable(int id, const QVideoFrame &frame)

Call this method to emit this signal.

emit_imageCaptured

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

Description: Emitter for signal void QCameraImageCapture::imageCaptured(int id, const QImage &preview)

Call this method to emit this signal.

emit_imageExposed

Signature: void emit_imageExposed (int id)

Description: Emitter for signal void QCameraImageCapture::imageExposed(int id)

Call this method to emit this signal.

emit_imageMetadataAvailable

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

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

Call this method to emit this signal.

emit_imageSaved

Signature: void emit_imageSaved (int id, string fileName)

Description: Emitter for signal void QCameraImageCapture::imageSaved(int id, const QString &fileName)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

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

Call this method to emit this signal.

emit_readyForCaptureChanged

Signature: void emit_readyForCaptureChanged (bool ready)

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

Call this method to emit this signal.

encodingSettings

Signature: [const] QImageEncoderSettings encodingSettings

Description: Method QImageEncoderSettings QCameraImageCapture::encodingSettings()

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

encodingSettings=

Signature: void encodingSettings= (const QImageEncoderSettings settings)

Description: Method void QCameraImageCapture::setEncodingSettings(const QImageEncoderSettings &settings)

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

error

Signature: [const] QCameraImageCapture_Error error

Description: Method QCameraImageCapture::Error QCameraImageCapture::error()

errorString

Signature: [const] string errorString

Description: Method QString QCameraImageCapture::errorString()

error_sig

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

Description: Signal declaration for QCameraImageCapture::error(int id, QCameraImageCapture::Error error, const QString &errorString)

You can bind a procedure to this signal.

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

event

Signature: bool event (QEvent ptr event)

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

This method can be reimplemented in a derived class.

imageAvailable

Signature: [signal] void imageAvailable (int id, const QVideoFrame frame)

Description: Signal declaration for QCameraImageCapture::imageAvailable(int id, const QVideoFrame &frame)

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 id, const QImage preview)

Description: Signal declaration for QCameraImageCapture::imageCaptured(int id, 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.

imageCodecDescription

Signature: [const] string imageCodecDescription (string codecName)

Description: Method QString QCameraImageCapture::imageCodecDescription(const QString &codecName)

imageExposed

Signature: [signal] void imageExposed (int id)

Description: Signal declaration for QCameraImageCapture::imageExposed(int id)

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 QCameraImageCapture::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 id, string fileName)

Description: Signal declaration for QCameraImageCapture::imageSaved(int id, 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.

isAvailable?

Signature: [const] bool isAvailable?

Description: Method bool QCameraImageCapture::isAvailable()

isCaptureDestinationSupported?

Signature: [const] bool isCaptureDestinationSupported? (QCameraImageCapture_QFlags_CaptureDestination destination)

Description: Method bool QCameraImageCapture::isCaptureDestinationSupported(QFlags<QCameraImageCapture::CaptureDestination> destination)

isReadyForCapture?

Signature: [const] bool isReadyForCapture?

Description: Method bool QCameraImageCapture::isReadyForCapture()

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

isSignalConnected

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

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

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

mediaObject

Signature: [const] QMediaObject ptr mediaObject

Description: Virtual method QMediaObject *QCameraImageCapture::mediaObject()

This method can be reimplemented in a derived class.

new

Signature: [static] new QCameraImageCapture new (QMediaObject ptr mediaObject, QObject ptr parent = nullptr)

Description: Constructor QCameraImageCapture::QCameraImageCapture(QMediaObject *mediaObject, QObject *parent)

This method creates an object of class QCameraImageCapture.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

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

readyForCapture

Signature: [const] bool readyForCapture

Description: Method bool QCameraImageCapture::isReadyForCapture()

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

readyForCaptureChanged

Signature: [signal] void readyForCaptureChanged (bool ready)

Description: Signal declaration for QCameraImageCapture::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 QCameraImageCapture::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 *QCameraImageCapture::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QCameraImageCapture::senderSignalIndex()

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

setBufferFormat

Signature: void setBufferFormat (const QVideoFrame_PixelFormat format)

Description: Method void QCameraImageCapture::setBufferFormat(const QVideoFrame::PixelFormat format)

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

setCaptureDestination

Signature: void setCaptureDestination (QCameraImageCapture_QFlags_CaptureDestination destination)

Description: Method void QCameraImageCapture::setCaptureDestination(QFlags<QCameraImageCapture::CaptureDestination> destination)

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

setEncodingSettings

Signature: void setEncodingSettings (const QImageEncoderSettings settings)

Description: Method void QCameraImageCapture::setEncodingSettings(const QImageEncoderSettings &settings)

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

setMediaObject

Signature: bool setMediaObject (QMediaObject ptr arg1)

Description: Virtual method bool QCameraImageCapture::setMediaObject(QMediaObject *)

This method can be reimplemented in a derived class.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

supportedBufferFormats

Signature: [const] QVideoFrame_PixelFormat[] supportedBufferFormats

Description: Method QList<QVideoFrame::PixelFormat> QCameraImageCapture::supportedBufferFormats()

supportedImageCodecs

Signature: [const] string[] supportedImageCodecs

Description: Method QStringList QCameraImageCapture::supportedImageCodecs()

supportedResolutions

Signature: [const] QSize[] supportedResolutions (const QImageEncoderSettings settings = QImageEncoderSettings(), bool ptr continuous = nullptr)

Description: Method QList<QSize> QCameraImageCapture::supportedResolutions(const QImageEncoderSettings &settings, bool *continuous)

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

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

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