API reference - Class QCameraImageCapture

Notation used in Ruby API documentation

Module: QtMultimedia

Description: Binding of QCameraImageCapture

Class hierarchy: QCameraImageCapture » QObject

Sub-classes: , CaptureDestination, QFlags_CaptureDestination, DriveMode, QFlags_DriveMode, Error, QFlags_Error

Public constructors

new QCameraImageCapturenew(QMediaObject ptr mediaObject,
QObject ptr parent = 0)
Constructor QCameraImageCapture::QCameraImageCapture(QMediaObject *mediaObject, QObject *parent)

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.
[const]const QMediaBindableInterface ptrasConstQMediaBindableInterfaceDelivers the base class interface QMediaBindableInterface of QCameraImageCapture
[const]const QObject ptrasConstQObjectDelivers the base class interface QObject of QCameraImageCapture
QMediaBindableInterface ptrasQMediaBindableInterfaceDelivers the base class interface QMediaBindableInterface of QCameraImageCapture
QObject ptrasQObjectDelivers the base class interface QObject of QCameraImageCapture
[const]QMultimedia_AvailabilityStatusavailabilityMethod QMultimedia::AvailabilityStatus QCameraImageCapture::availability()
[const]QVideoFrame_PixelFormatbufferFormatMethod QVideoFrame::PixelFormat QCameraImageCapture::bufferFormat()
voidbufferFormat=(const QVideoFrame_PixelFormat format)Method void QCameraImageCapture::setBufferFormat(const QVideoFrame::PixelFormat format)
voidbufferFormatChanged(const QVideoFrame_PixelFormat arg1)Method void QCameraImageCapture::bufferFormatChanged(QVideoFrame::PixelFormat)
voidcancelCaptureMethod void QCameraImageCapture::cancelCapture()
intcapture(string location = QString())Method int QCameraImageCapture::capture(const QString &location)
[const]QCameraImageCapture_QFlags_CaptureDestinationcaptureDestinationMethod QFlags<QCameraImageCapture::CaptureDestination> QCameraImageCapture::captureDestination()
voidcaptureDestination=(QCameraImageCapture_QFlags_CaptureDestination destination)Method void QCameraImageCapture::setCaptureDestination(QFlags<QCameraImageCapture::CaptureDestination> destination)
voidcaptureDestinationChanged(QCameraImageCapture_QFlags_CaptureDestination arg1)Method void QCameraImageCapture::captureDestinationChanged(QFlags<QCameraImageCapture::CaptureDestination>)
[const]QImageEncoderSettingsencodingSettingsMethod QImageEncoderSettings QCameraImageCapture::encodingSettings()
voidencodingSettings=(const QImageEncoderSettings settings)Method void QCameraImageCapture::setEncodingSettings(const QImageEncoderSettings &settings)
[const]QCameraImageCapture_ErrorerrorMethod QCameraImageCapture::Error QCameraImageCapture::error()
[const]stringerrorStringMethod QString QCameraImageCapture::errorString()
voiderror_sig(int id,
const QCameraImageCapture_Error error,
string errorString)
Method void QCameraImageCapture::error(int id, QCameraImageCapture::Error error, const QString &errorString)
boolevent(QEvent ptr arg1)Virtual method bool QCameraImageCapture::event(QEvent *)
booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QCameraImageCapture::eventFilter(QObject *, QEvent *)
voidimageAvailable(int id,
const QVideoFrame image)
Method void QCameraImageCapture::imageAvailable(int id, const QVideoFrame &image)
voidimageCaptured(int id,
const QImage preview)
Method void QCameraImageCapture::imageCaptured(int id, const QImage &preview)
[const]stringimageCodecDescription(string codecName)Method QString QCameraImageCapture::imageCodecDescription(const QString &codecName)
voidimageExposed(int id)Method void QCameraImageCapture::imageExposed(int id)
voidimageMetadataAvailable(int id,
string key,
variant value)
Method void QCameraImageCapture::imageMetadataAvailable(int id, const QString &key, const QVariant &value)
voidimageSaved(int id,
string fileName)
Method void QCameraImageCapture::imageSaved(int id, const QString &fileName)
[const]boolisAvailable?Method bool QCameraImageCapture::isAvailable()
[const]boolisCaptureDestinationSupported?(QCameraImageCapture_QFlags_CaptureDestination destination)Method bool QCameraImageCapture::isCaptureDestinationSupported(QFlags<QCameraImageCapture::CaptureDestination> destination)
[const]boolisReadyForCapture?Method bool QCameraImageCapture::isReadyForCapture()
[const]QMediaObject ptrmediaObjectVirtual method QMediaObject *QCameraImageCapture::mediaObject()
[const]boolreadyForCaptureMethod bool QCameraImageCapture::isReadyForCapture()
voidreadyForCaptureChanged(bool arg1)Method void QCameraImageCapture::readyForCaptureChanged(bool)
voidsetBufferFormat(const QVideoFrame_PixelFormat format)Method void QCameraImageCapture::setBufferFormat(const QVideoFrame::PixelFormat format)
voidsetCaptureDestination(QCameraImageCapture_QFlags_CaptureDestination destination)Method void QCameraImageCapture::setCaptureDestination(QFlags<QCameraImageCapture::CaptureDestination> destination)
voidsetEncodingSettings(const QImageEncoderSettings settings)Method void QCameraImageCapture::setEncodingSettings(const QImageEncoderSettings &settings)
[const]QVideoFrame_PixelFormat[]supportedBufferFormatsMethod QList<QVideoFrame::PixelFormat> QCameraImageCapture::supportedBufferFormats()
[const]string[]supportedImageCodecsMethod QStringList QCameraImageCapture::supportedImageCodecs()
[const]QSize[]supportedResolutions(const QImageEncoderSettings settings = QImageEncoderSettings(),
bool ptr continuous = 0)
Method QList<QSize> QCameraImageCapture::supportedResolutions(const QImageEncoderSettings &settings, bool *continuous)

Public static methods and constants

[static,const]QCameraImageCapture_CaptureDestinationCaptureToBufferEnum constant QCameraImageCapture::CaptureToBuffer
[static,const]QCameraImageCapture_CaptureDestinationCaptureToFileEnum constant QCameraImageCapture::CaptureToFile
[static,const]QCameraImageCapture_ErrorFormatErrorEnum constant QCameraImageCapture::FormatError
[static,const]QCameraImageCapture_ErrorNoErrorEnum constant QCameraImageCapture::NoError
[static,const]QCameraImageCapture_ErrorNotReadyErrorEnum constant QCameraImageCapture::NotReadyError
[static,const]QCameraImageCapture_ErrorNotSupportedFeatureErrorEnum constant QCameraImageCapture::NotSupportedFeatureError
[static,const]QCameraImageCapture_ErrorOutOfSpaceErrorEnum constant QCameraImageCapture::OutOfSpaceError
[static,const]QCameraImageCapture_ErrorResourceErrorEnum constant QCameraImageCapture::ResourceError
[static,const]QCameraImageCapture_DriveModeSingleImageCaptureEnum constant QCameraImageCapture::SingleImageCapture
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = nullptr,
int n = -1)
Static method QString QCameraImageCapture::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = nullptr,
int n = -1)
Static method QString QCameraImageCapture::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

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

Detailed description

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.

_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: void bufferFormatChanged (const QVideoFrame_PixelFormat arg1)

Description: Method void QCameraImageCapture::bufferFormatChanged(QVideoFrame::PixelFormat)

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: void captureDestinationChanged (QCameraImageCapture_QFlags_CaptureDestination arg1)

Description: Method void QCameraImageCapture::captureDestinationChanged(QFlags<QCameraImageCapture::CaptureDestination>)

childEvent

Signature: void childEvent (QChildEvent ptr arg1)

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

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

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.

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: void error_sig (int id, const QCameraImageCapture_Error error, string errorString)

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

event

Signature: bool event (QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

imageAvailable

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

Description: Method void QCameraImageCapture::imageAvailable(int id, const QVideoFrame &image)

imageCaptured

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

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

imageCodecDescription

Signature: [const] string imageCodecDescription (string codecName)

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

imageExposed

Signature: void imageExposed (int id)

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

imageMetadataAvailable

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

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

imageSaved

Signature: void imageSaved (int id, string fileName)

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

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 = 0)

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.

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: void readyForCaptureChanged (bool arg1)

Description: Method void QCameraImageCapture::readyForCaptureChanged(bool)

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 = 0)

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

timerEvent

Signature: void timerEvent (QTimerEvent ptr arg1)

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