Clarify documentation for QImageCapture's 'ready' property.
Unlike what was described in the documentation, it's not permissible to call capture() while 'ready' or isReadyForCapture() is false. All backends emit an error in that case. Updated the documentation to reflect that behavior. Change-Id: Icb326e65376b65eadd4c68b67e0ee30beddf1a04 Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com> Reviewed-by: Christian Stromme <christian.stromme@theqtcompany.com>
This commit is contained in:
@@ -123,9 +123,8 @@ QDeclarativeCameraCapture::~QDeclarativeCameraCapture()
|
|||||||
This property holds a bool value indicating whether the camera
|
This property holds a bool value indicating whether the camera
|
||||||
is ready to capture photos or not.
|
is ready to capture photos or not.
|
||||||
|
|
||||||
If camera is not ready to capture image immediately,
|
Calling capture() while \e ready is \c false is not permitted and
|
||||||
the capture request is queued with all the related camera settings,
|
results in an error.
|
||||||
and the request will be executed as soon as possible.
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
@@ -134,11 +133,8 @@ QDeclarativeCameraCapture::~QDeclarativeCameraCapture()
|
|||||||
This property holds a bool value indicating whether the camera
|
This property holds a bool value indicating whether the camera
|
||||||
is ready to capture photos or not.
|
is ready to capture photos or not.
|
||||||
|
|
||||||
It's permissible to call capture() while the camera is active
|
Calling capture() while \e ready is \c false is not permitted and
|
||||||
regardless of the \e ready property value.
|
results in an error.
|
||||||
If camera is not ready to capture image immediately,
|
|
||||||
the capture request is queued with all the related camera settings,
|
|
||||||
and the request will be executed as soon as possible.
|
|
||||||
*/
|
*/
|
||||||
bool QDeclarativeCameraCapture::isReadyForCapture() const
|
bool QDeclarativeCameraCapture::isReadyForCapture() const
|
||||||
{
|
{
|
||||||
@@ -160,8 +156,10 @@ bool QDeclarativeCameraCapture::isReadyForCapture() const
|
|||||||
image processing parameters, so changes to camera paramaters after
|
image processing parameters, so changes to camera paramaters after
|
||||||
capture() is called do not affect previous capture requests.
|
capture() is called do not affect previous capture requests.
|
||||||
|
|
||||||
CameraCapture::capture returns the capture requestId parameter, used with
|
capture() returns the capture requestId parameter, used with
|
||||||
imageExposed(), imageCaptured(), imageMetadataAvailable() and imageSaved() signals.
|
imageExposed(), imageCaptured(), imageMetadataAvailable() and imageSaved() signals.
|
||||||
|
|
||||||
|
\sa ready
|
||||||
*/
|
*/
|
||||||
int QDeclarativeCameraCapture::capture()
|
int QDeclarativeCameraCapture::capture()
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -488,11 +488,8 @@ void QCameraImageCapture::setCaptureDestination(QCameraImageCapture::CaptureDest
|
|||||||
\property QCameraImageCapture::readyForCapture
|
\property QCameraImageCapture::readyForCapture
|
||||||
\brief whether the service is ready to capture a an image immediately.
|
\brief whether the service is ready to capture a an image immediately.
|
||||||
|
|
||||||
It's permissible to call capture() while the camera status is QCamera::ActiveStatus
|
Calling capture() while \e readyForCapture is \c false is not permitted and
|
||||||
regardless of isReadyForCapture property value.
|
results in an error.
|
||||||
If camera is not ready to capture image immediately,
|
|
||||||
the capture request is queued with all the related camera settings
|
|
||||||
to be executed as soon as possible.
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
bool QCameraImageCapture::isReadyForCapture() const
|
bool QCameraImageCapture::isReadyForCapture() const
|
||||||
@@ -528,6 +525,8 @@ bool QCameraImageCapture::isReadyForCapture() const
|
|||||||
|
|
||||||
QCameraImageCapture::capture returns the capture Id parameter, used with
|
QCameraImageCapture::capture returns the capture Id parameter, used with
|
||||||
imageExposed(), imageCaptured() and imageSaved() signals.
|
imageExposed(), imageCaptured() and imageSaved() signals.
|
||||||
|
|
||||||
|
\sa isReadyForCapture()
|
||||||
*/
|
*/
|
||||||
int QCameraImageCapture::capture(const QString &file)
|
int QCameraImageCapture::capture(const QString &file)
|
||||||
{
|
{
|
||||||
|
|||||||
Reference in New Issue
Block a user