 |
Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
|
|
Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
|
#include <qquickimagecapture_p.h>
Inheritance diagram for QQuickImageCapture: Collaboration diagram for QQuickImageCapture:Public Slots | |
| void | saveToFile (const QUrl &location) const |
| \qmlmethod QtMultimedia::ImageCapture::saveToFile(location) | |
| Public Slots inherited from QImageCapture | |
| int | captureToFile (const QString &location=QString()) |
| Capture the image and save it to file. | |
| int | capture () |
| Capture the image and make it available as a QImage. | |
| Public Slots inherited from QObject | |
| void | deleteLater () |
| \threadsafe | |
Signals | |
| void | previewChanged () |
| Signals inherited from QImageCapture | |
| void | errorChanged () |
| void | errorOccurred (int id, QImageCapture::Error error, const QString &errorString) |
| Signals that the capture request id has failed with an error and errorString description. | |
| void | readyForCaptureChanged (bool ready) |
| Signals that a camera's ready for capture state has changed. | |
| void | metaDataChanged () |
| void | fileFormatChanged () |
| void | qualityChanged () |
| void | resolutionChanged () |
| Signals when the image resolution changes. | |
| void | imageExposed (int id) |
| Signal emitted when the frame with request id was exposed. | |
| void | imageCaptured (int id, const QImage &preview) |
| Signal emitted when the frame with request id was captured, but not processed and saved yet. | |
| void | imageMetadataAvailable (int id, const QMediaMetaData &metaData) |
| Signals that an image identified by id has metaData. | |
| void | imageAvailable (int id, const QVideoFrame &frame) |
| Signal emitted when the frame with request id is available. | |
| void | imageSaved (int id, const QString &fileName) |
| Signal emitted when QImageCapture::CaptureToFile is set and the frame with request id was saved to fileName. | |
| Signals inherited from QObject | |
| void | destroyed (QObject *=nullptr) |
| This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked. | |
| void | objectNameChanged (const QString &objectName, QPrivateSignal) |
| This signal is emitted after the object's name has been changed. | |
Public Member Functions | |
| QQuickImageCapture (QObject *parent=nullptr) | |
| \qmltype ImageCapture \instantiates QQuickImageCapture | |
| ~QQuickImageCapture () | |
| QString | preview () const |
| \qmlproperty bool QtMultimedia::ImageCapture::readyForCapture | |
| Public Member Functions inherited from QImageCapture | |
| QImageCapture (QObject *parent=nullptr) | |
| Constructs a image capture object, from a parent, that can capture individual still images produced by a camera. | |
| ~QImageCapture () | |
| Destroys images capture object. | |
| bool | isAvailable () const |
| Returns true if the images capture service ready to use. | |
| QMediaCaptureSession * | captureSession () const |
| Returns the capture session this camera is connected to, or a nullptr if the camera is not connected to a capture session. | |
| Error | error () const |
| QString | errorString () const |
| bool | isReadyForCapture () const |
| FileFormat | fileFormat () const |
| void | setFileFormat (FileFormat format) |
| Sets the image format. | |
| QSize | resolution () const |
| Returns the resolution of the encoded image. | |
| void | setResolution (const QSize &) |
| Sets the resolution of the encoded image. | |
| void | setResolution (int width, int height) |
| Sets the width and height of the resolution of the encoded image. | |
| Quality | quality () const |
| void | setQuality (Quality quality) |
| Sets the image encoding quality. | |
| QMediaMetaData | metaData () const |
| void | setMetaData (const QMediaMetaData &metaData) |
| Replaces any existing meta data, to be embedded into the captured image, with a set of metaData. | |
| void | addMetaData (const QMediaMetaData &metaData) |
| Adds additional metaData to any existing meta data, that is embedded into the captured image. | |
| Public Member Functions inherited from QObject | |
| Q_INVOKABLE | QObject (QObject *parent=nullptr) |
| Constructs an object with parent object parent. | |
| virtual | ~QObject () |
| Destroys the object, deleting all its child objects. | |
| virtual bool | event (QEvent *event) |
| This virtual function receives events to an object and should return true if the event e was recognized and processed. | |
| virtual bool | eventFilter (QObject *watched, QEvent *event) |
| Filters events if this object has been installed as an event filter for the watched object. | |
| QString | objectName () const |
| Q_WEAK_OVERLOAD void | setObjectName (const QString &name) |
| Sets the object's name to name. | |
| void | setObjectName (QAnyStringView name) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| QBindable< QString > | bindableObjectName () |
| bool | isWidgetType () const |
Returns true if the object is a widget; otherwise returns false. | |
| bool | isWindowType () const |
Returns true if the object is a window; otherwise returns false. | |
| bool | isQuickItemType () const |
Returns true if the object is a QQuickItem; otherwise returns false. | |
| bool | signalsBlocked () const noexcept |
Returns true if signals are blocked; otherwise returns false. | |
| bool | blockSignals (bool b) noexcept |
| If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). | |
| QThread * | thread () const |
| Returns the thread in which the object lives. | |
| bool | moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL) |
Changes the thread affinity for this object and its children and returns true on success. | |
| int | startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer) |
| This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds. | |
| int | startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer) |
| void | killTimer (int id) |
| Kills the timer with timer identifier, id. | |
| void | killTimer (Qt::TimerId id) |
| template<typename T > | |
| T | findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
| Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object. | |
| template<typename T > | |
| QList< T > | findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
| Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. | |
| template<typename T > | |
| T | findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| template<typename T > | |
| QList< T > | findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| const QObjectList & | children () const |
| Returns a list of child objects. | |
| void | setParent (QObject *parent) |
| Makes the object a child of parent. | |
| void | installEventFilter (QObject *filterObj) |
| Installs an event filter filterObj on this object. | |
| void | removeEventFilter (QObject *obj) |
| Removes an event filter object obj from this object. | |
| QMetaObject::Connection | connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const |
| bool | disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const |
| bool | disconnect (const QObject *receiver, const char *member=nullptr) const |
| void | dumpObjectTree () const |
| Dumps a tree of children to the debug output. | |
| void | dumpObjectInfo () const |
| Dumps information about signal connections, etc. | |
| bool | setProperty (const char *name, const QVariant &value) |
| Sets the value of the object's name property to value. | |
| bool | setProperty (const char *name, QVariant &&value) |
| QVariant | property (const char *name) const |
| Returns the value of the object's name property. | |
| QList< QByteArray > | dynamicPropertyNames () const |
| QBindingStorage * | bindingStorage () |
| const QBindingStorage * | bindingStorage () const |
| QObject * | parent () const |
| Returns a pointer to the parent object. | |
| bool | inherits (const char *classname) const |
Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false. | |
Properties | |
| QString | preview |
| Properties inherited from QImageCapture | |
| bool | readyForCapture |
Holds true if the camera is ready to capture an image immediately. | |
| QMediaMetaData | metaData |
| The meta data that will get embedded into the image. | |
| Error | error |
| Returns the current error state. | |
| QString | errorString |
| Returns a string describing the current error state. | |
| FileFormat | fileFormat |
| The image format. | |
| Quality | quality |
| The image encoding quality. | |
| Properties inherited from QObject | |
| QString | objectName |
| the name of this object | |
Additional Inherited Members | |
| Public Types inherited from QImageCapture | |
| enum | Error { NoError , NotReadyError , ResourceError , OutOfSpaceError , NotSupportedFeatureError , FormatError } |
| \value NoError No Errors. More... | |
| enum | Quality { VeryLowQuality , LowQuality , NormalQuality , HighQuality , VeryHighQuality } |
| Enumerates quality encoding levels. More... | |
| enum | FileFormat { UnspecifiedFormat , JPEG , PNG , WebP , Tiff , LastFileFormat = Tiff } |
| Choose one of the following image formats: More... | |
| Static Public Member Functions inherited from QImageCapture | |
| static QList< FileFormat > | supportedFormats () |
| Returns a list of supported file formats. | |
| static QString | fileFormatName (FileFormat c) |
| Returns the name of the given format, f. | |
| static QString | fileFormatDescription (FileFormat c) |
| Returns the description of the given file format, f. | |
| Static Public Member Functions inherited from QObject | |
| static QMetaObject::Connection | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection) |
| \threadsafe | |
| static QMetaObject::Connection | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection) |
| template<typename Func1 , typename Func2 > | |
| static QMetaObject::Connection | connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection) |
| template<typename Func1 , typename Func2 > | |
| static QMetaObject::Connection | connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot) |
| static bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member) |
| \threadsafe | |
| static bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member) |
| static bool | disconnect (const QMetaObject::Connection &) |
| Disconnect a connection. | |
| template<typename Func1 , typename Func2 > | |
| static bool | disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot) |
| template<typename Func1 > | |
| static bool | disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero) |
| Protected Member Functions inherited from QObject | |
| QObject * | sender () const |
| Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr. | |
| int | senderSignalIndex () const |
| int | receivers (const char *signal) const |
| Returns the number of receivers connected to the signal. | |
| bool | isSignalConnected (const QMetaMethod &signal) const |
| virtual void | timerEvent (QTimerEvent *event) |
| This event handler can be reimplemented in a subclass to receive timer events for the object. | |
| virtual void | childEvent (QChildEvent *event) |
| This event handler can be reimplemented in a subclass to receive child events. | |
| virtual void | customEvent (QEvent *event) |
| This event handler can be reimplemented in a subclass to receive custom events. | |
| virtual void | connectNotify (const QMetaMethod &signal) |
| virtual void | disconnectNotify (const QMetaMethod &signal) |
| QObject (QObjectPrivate &dd, QObject *parent=nullptr) | |
| Protected Attributes inherited from QObject | |
| QScopedPointer< QObjectData > | d_ptr |
| Related Symbols inherited from QObject | |
| template< class T > T | qobject_cast (const QObject *object) |
| Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr. | |
| template< typename T > T | qFindChildqFindChildren (const QObject *obj, const QString &name)() |
| template< typename T > QList< T > | qFindChildrenqFindChildren (const QObject *obj, const QString &name)() |
| QObjectList | |
| \macro Q_CLASSINFO(Name, Value) | |
Definition at line 29 of file qquickimagecapture_p.h.
| QT_BEGIN_NAMESPACE QQuickImageCapture::QQuickImageCapture | ( | QObject * | parent = nullptr | ) |
\qmltype ImageCapture \instantiates QQuickImageCapture
An interface for capturing camera images.
\inqmlmodule QtMultimedia
This type allows you to capture still images and be notified when they are available or saved to disk.
\qml Item { width: 640 height: 360
CaptureSession { imageCapture : ImageCapture { id: imageCapture } camera: Camera { id: camera }
videoOutput: videoOutput } VideoOutput { id: videoOutput anchors.fill: parent
MouseArea { anchors.fill: parent; onClicked: imageCapture.capture(); } }
Image { id: photoPreview source: imageCapture.preview // always shows the last captured image } } \endqml
Definition at line 56 of file qquickimagecapture.cpp.
References QObject::connect(), and QImageCapture::imageCaptured().
Here is the call graph for this function:
|
default |
| QString QQuickImageCapture::preview | ( | ) | const |
\qmlproperty bool QtMultimedia::ImageCapture::readyForCapture
This property holds a bool value indicating whether the camera is ready to capture photos or not.
Calling capture() or captureToFile() while ready is false is not permitted and results in an error.
\qmlproperty string QtMultimedia::ImageCapture::preview
This property holds a url to the latest captured image. It can be connected to the source property of an \l Image element to show the last captured image.
\qml CaptureSession { camera: Camera {} imageCapture: ImageCapture { id: capture } } Image { source: capture.preview } \endqml
\qmlmethod QtMultimedia::ImageCapture::capture()
Start image capture. The \l imageCaptured and \l imageSaved signals will be emitted when the capture is complete.
The captured image will be available through the preview property that can be used as the source for a QML Image item. The saveToFile() method can then be used save the image.
Camera saves all the capture parameters like exposure settings or image processing parameters, so changes to camera parameters after capture() is called do not affect previous capture requests.
capture() returns the capture requestId parameter, used with imageExposed(), imageCaptured(), imageMetadataAvailable() and imageSaved() signals.
\qmlmethod QtMultimedia::ImageCapture::captureToFile(location)
Does the same as capture() but additionally automatically saves the captured image to the specified location.
Definition at line 124 of file qquickimagecapture.cpp.
|
signal |
\qmlmethod QtMultimedia::ImageCapture::saveToFile(location)
Saves the last captured image to location.
Definition at line 136 of file qquickimagecapture.cpp.
References QImage::save().
Here is the call graph for this function:
|
read |
Definition at line 32 of file qquickimagecapture_p.h.
1.10.0