*
* @since 2.1
*
- * The %QrCodeRecognizer class provides methods to generate a QR code image.
+ * The %QrCodeRecognizer class provides methods to recognize a QR code image.
*
* The following example demonstrates how to use the %QrCodeRecognizer class.
*
* @code
- *
- * // Initializes recognition engine
- *
- * void
- * Tracker::Initialize()
- *
+ * #include <FBase.h>
+ * #include <FUix.h>
+ * #include <FGraphics.h>
+ * #include <FIo.h>
+ * #include <FMedia.h>
+ *
+ * using namespace Tizen::Base;
+ * using namespace Tizen::Media;
+ * using namespace Tizen::Graphics;
+ * using namespace Tizen::Io;
+ * using namespace Tizen::Uix::Vision;
+ *
+ * class MyClass
+ * : ICameraEventListener
+ * {
+ * public:
+ * MyClass();
+ * ~MyClass();
+ * result Initialize(void);
+ *
+ * // Called when camera auto focus occurred
+ * void OnCameraAutoFocused(bool completeCondition);
+ * // Called when camera preview occurred
+ * void OnCameraPreviewed(Tizen::Base::ByteBuffer& previewedData, result r);
+ * // Called when camera captured image
+ * void OnCameraCaptured(Tizen::Base::ByteBuffer& capturedData, result r);
+ * // Called when camera error occurred
+ * void OnCameraErrorOccurred(Tizen::Media::CameraErrorReason r);
+ *
+ * private:
+ * QrCodeRecognizer* __pQrRecognizer;
+ * };
+ *
+ * result
+ * MyClass::Initialize(void)
* {
- * __pQrRecognizer = new Tizen::Uix::Vision::QrCodeRecognizer();
- * __pQrRecognizer->Construct();
- * __pQrRecognizer->SetFrameSize(CAMERA_WIDTH, CAMERA_HEIGHT);
+ * result r;
+ *
+ * // Creates and initializes recognition engine
+ * __pQrRecognizer = new Tizen::Uix::Vision::QrCodeRecognizer();
+ * r = __pQrRecognizer->Construct();
+ *
+ * //Image size must be same as camera preview size
+ * r = __pQrRecognizer->SetImageSize(640, 480);
+ *
+ * return r;
* }
- *
+ *
* // We suppose camera to be initialized with Tizen::Graphics::PIXEL_FORMAT_YCbCr420_PLANAR format
- *
* void
- * Tracker::OnCameraPreviewed(Tizen::Base::ByteBuffer& previewedData, result r)
+ * MyClass::OnCameraPreviewed(Tizen::Base::ByteBuffer& previewedData, result r)
* {
- * // Processing of the camera image follows
- * __pQrRecognizer->ProcessFrame(previewedData);
- *
- * // Loops through all recognized QRs
- * for (int i = 0; i < __pQrRecognizer->GetRecognizedObjectCount(); i++)
- * {
- *
- * const Tizen::Uix::Vision::QrCodeObject *o = __pQrRecognizer->GetQrCodeObject(i);
- * Tizen::Base::String qrText = o->GetText();
- *
- * }
- * }
+ * // Processing of the camera image follows
+ * __pQrRecognizer->ProcessImage(previewedData);
+ *
+ * // Loops through all recognized QRs
+ * for (int i = 0; i < __pQrRecognizer->GetRecognizedObjectCount(); i++)
+ * {
+ * const QrCodeObject *o = __pQrRecognizer->GetRecognizedObject(i);
+ * String qrText = o->GetText();
+ * }
* }
*
* @endcode
/**
* Initializes this instance of %QrCodeRecognizer. @n
- * Every application must call %Construct() before calling any other methods of %QrCodeRecognizer.
+ * Every application must call the %Construct() method before calling any other method of %QrCodeRecognizer.
*
* @since 2.1
*
* @feature %http://tizen.org/feature/vision.qrcode_recognition
*
- * @exception E_SUCCESS The method is successful.
+ * @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
- * @remarks Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue() methods.
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @remarks Before calling this method, check whether the feature is supported by Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
*/
result Construct(void);
/**
- * Sets the width and height of an input image.
+ * Sets the width and the height of the input image.
*
* @since 2.1
*
* @param[in] height The height of the frame in pixels
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @remarks This method must be called once before calling ProcessImage().
+ * @remarks This method must be called once before calling the ProcessImage() method.
*/
result SetImageSize(int width, int height);
/**
- * Processes an input image for recognition.
+ * Processes the input image for recognition.
*
* @since 2.1
*
* @return An error code
*
* @param[in] imageBuffer The input image buffer @n
- * It must be allocated outside and have size of (width*height) set by SetImageSize().
+ * It must be allocated externally and have a size of (width*height) set by SetImageSize().
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c imageBuffer is not allocated or the size of @c imageBuffer is not equal to the input image size set by SetImageSize().
+ * @exception E_INVALID_ARG Either of the following conditions has occurred;
+ * - The specified @c imageBuffer is not allocated
+ * - The size of the specified @c imageBuffer is not equal to the input image size set by SetImageSize().
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @see SetImageSize(int, int)
*/
result ProcessImage(const Tizen::Base::ByteBuffer& imageBuffer);
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
*
- * @remarks The ROI is used to reset camera focus to get better image and it can be obtained after calling ProcessImage() at least once.
+ * @remarks The ROI is used to reset the camera focus to get a better image and it can be obtained after calling the ProcessImage() method at least once.
*/
result GetFocusRoi(Tizen::Graphics::Rectangle& roi);
/**
- * Gets a count of the recognized QR code object.
+ * Gets the count of the recognized QR code object.
*
* @since 2.1
*
- * @return A count of the recognized QR code object
+ * @return The count of the recognized QR code object
*
- * @remarks The recognized QR code object has index value from @c 0 to (count of the recognized QR code objects - 1)
- * @see GetRecognizedObject(int)
+ * @remarks The recognized QR code object has an index value that ranges from @c 0 to (count of the recognized QR code objects) @c - 1.
+ * @see GetRecognizedObject()
*/
int GetRecognizedObjectCount(void);
/**
- * Gets the recognized QR code object to get information.
+ * Gets the recognized QR code object that contains the information.
*
* @since 2.1
*
- * @return A pointer to QrCodeObject that includes all information about the recognized QR code object
+ * @return A pointer to the QrCodeObject that includes all the information about the recognized QR code object
* @param[in] index The index of the recognized QR code object @n
- * Valid range of this parameter is @c 0 to (count of the recognized QR code objects - 1).
+ * The valid range for this parameter is @c 0 to (count of the recognized QR code objects) @c - 1.
* @exception E_SUCCESS The method is successful.
*
* @see GetRecognizedObjectCount()
projects / framework / osp / vision.git / blobdiff