.. index:: pair: class; P1::CameraSdk::IPreview
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_preview:

class P1::CameraSdk::IPreview
=============================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Contains a preview of an image, as returned from the camera. :ref:`More...<details-class_p1_1_1_camera_sdk_1_1_i_preview>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <C_P1CameraCommonStructs.h>
	
	class IPreview:
	    public :ref:`P1::CameraSdk::IImageBufferFrame<doxid-class_p1_1_1_camera_sdk_1_1_i_image_buffer_frame>`,
	    public :ref:`P1::CameraSdk::IImageFileCommon<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_common>`
	{
	};

	// direct descendants

	class :ref:`PreviewImpl<doxid-class_p1_1_1_camera_sdk_1_1_preview_impl>`;

Inherited Members
-----------------

.. ref-code-block:: cpp
	:class: doxyrest-overview-inherited-code-block

	public:
		// enums
	
		enum :ref:`Type<doxid-class_p1_1_1_camera_sdk_1_1_i_image_buffer_1a353ab2d01f8a9012d90d0fcf50c6aa29>`;
		enum :ref:`Errors<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_common_1a5415589ad16ed744046e184d686d60ff>`;

		// methods
	
		virtual std::shared_ptr<uint8_t const> :ref:`Data<doxid-class_p1_1_1_camera_sdk_1_1_i_image_buffer_1aa6f7953c78c76ac4000809bb52ae19c8>`() const = 0;
		virtual size_t :ref:`DataSizeBytes<doxid-class_p1_1_1_camera_sdk_1_1_i_image_buffer_1a085c3678f2263750b6c9523916de429d>`() const = 0;
		virtual :ref:`ImageFormat<doxid-namespace_p1_1_1_camera_sdk_1a56985d71dffbf0cd6359e82b0ad7778d>` :ref:`Format<doxid-class_p1_1_1_camera_sdk_1_1_i_image_buffer_1aa5aaae45266322f219a69ab542a9733b>`() const = 0;
		virtual :ref:`Type<doxid-class_p1_1_1_camera_sdk_1_1_i_image_buffer_1a353ab2d01f8a9012d90d0fcf50c6aa29>` :ref:`BufferType<doxid-class_p1_1_1_camera_sdk_1_1_i_image_buffer_1a8b95966fd34efe064ca1272869306fc8>`() const = 0;
		virtual char const* :ref:`BufferTypeStr<doxid-class_p1_1_1_camera_sdk_1_1_i_image_buffer_1a203a4b12c6b346f470a65d4622e4fd2c>`() const = 0;
		virtual char const* :ref:`FormatStr<doxid-class_p1_1_1_camera_sdk_1_1_i_image_buffer_1ad2680af8228eb0b09a546dfdc5cfbc17>`() const = 0;
		virtual uint32_t :ref:`DestinationWidth<doxid-class_p1_1_1_camera_sdk_1_1_i_image_buffer_frame_1a7d7303020a0e523dc9228b179b2e59e9>`() const = 0;
		virtual uint32_t :ref:`DestinationHeight<doxid-class_p1_1_1_camera_sdk_1_1_i_image_buffer_frame_1ac96fe2387659581c21876a08aaf315a9>`() const = 0;
		virtual uint32_t :ref:`ImageId<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_common_1aa54da65815c373545187a60f0d1c1659>`() const = 0;
		virtual bool :ref:`AnyErrors<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_common_1a7a338a7fd5c4097e9035e7e7ebbf268b>`() const = 0;
		virtual :ref:`Errors<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_common_1a5415589ad16ed744046e184d686d60ff>` :ref:`ImageFileErrors<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_common_1ab55e830b1aeb244af2e27978100690d5>`() const = 0;
		virtual std::string :ref:`ErrorsString<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_common_1a3ed0f53f31808c058f0378bd66c25ce0>`() const = 0;

.. _details-class_p1_1_1_camera_sdk_1_1_i_preview:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

Contains a preview of an image, as returned from the camera.

Either through subscriptions, or using *image browsing* you can get a preview (aka. thumbnail) of an image.

The camera normally creates a scaled RGB preview of the full image, right after the capturing process. When such previews are send the SDK host, they will come as implementations of this interface class.

:ref:`Version <doxid-struct_p1_1_1_camera_sdk_1_1_version>` 3.0