.. index:: pair: class; P1::CameraSdk::LiveViewImpl
.. _doxid-class_p1_1_1_camera_sdk_1_1_live_view_impl:

class P1::CameraSdk::LiveViewImpl
=================================

.. toctree::
	:hidden:

Overview
~~~~~~~~




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

	#include <C_P1CameraPrivStructs.hpp>
	
	class LiveViewImpl: public :ref:`P1::CameraSdk::ILiveView<doxid-class_p1_1_1_camera_sdk_1_1_i_live_view>`
	{
	public:
		// typedefs
	
		typedef P1::IQP::LiveView::LiveViewImage const :target:`PrivStructType<doxid-class_p1_1_1_camera_sdk_1_1_live_view_impl_1a7fe103644633f928af1edb7d265f6200>`;

		// construction
	
		:target:`LiveViewImpl<doxid-class_p1_1_1_camera_sdk_1_1_live_view_impl_1acc7c366f4b18501d32eb694932689b30>`(:ref:`PrivStructType<doxid-class_p1_1_1_camera_sdk_1_1_live_view_impl_1a7fe103644633f928af1edb7d265f6200>`*const dataStruct);

		// methods
	
		virtual std::shared_ptr<uint8_t const> :ref:`Data<doxid-class_p1_1_1_camera_sdk_1_1_live_view_impl_1a75e026dd6c105ae7dc8254774fda0517>`() const;
		virtual size_t :ref:`DataSizeBytes<doxid-class_p1_1_1_camera_sdk_1_1_live_view_impl_1ae4479326b37dd13dd8ba9f7117a4fc67>`() const;
		virtual :ref:`ImageFormat<doxid-namespace_p1_1_1_camera_sdk_1a56985d71dffbf0cd6359e82b0ad7778d>` :ref:`Format<doxid-class_p1_1_1_camera_sdk_1_1_live_view_impl_1ae5fa014f0b7b98ecfb4d57621faf2b11>`() const;
		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_live_view_impl_1a2d397105d25c4581eab2dc2e339fed07>`() const;
		virtual char const* :ref:`BufferTypeStr<doxid-class_p1_1_1_camera_sdk_1_1_live_view_impl_1a63b091c1395d7288381ba3ad6c8aa595>`() const;
		virtual char const* :ref:`FormatStr<doxid-class_p1_1_1_camera_sdk_1_1_live_view_impl_1a19e097852bfcd9e5b5bb641775f4fea9>`() const;
		virtual uint32_t :ref:`DestinationWidth<doxid-class_p1_1_1_camera_sdk_1_1_live_view_impl_1ac481792d22056e47ba571573f1612c67>`() const;
		virtual uint32_t :ref:`DestinationHeight<doxid-class_p1_1_1_camera_sdk_1_1_live_view_impl_1a62ded8e592afc748b2b7f1e259a1bafe>`() const;
		virtual uint32_t :ref:`CompressionQuality<doxid-class_p1_1_1_camera_sdk_1_1_live_view_impl_1a0cf785b623d359b923ebd7cb80ecbe11>`() const;
		virtual bool :ref:`IsCompressed<doxid-class_p1_1_1_camera_sdk_1_1_live_view_impl_1a0d65fa13a2ebf99fecc39e355e7ce90b>`() const;
		virtual :ref:`ValueRect<doxid-struct_p1_1_1_camera_sdk_1_1_value_rect>` :ref:`SourceCrop<doxid-class_p1_1_1_camera_sdk_1_1_live_view_impl_1ad64e736a9edaf88beae26d8c5c4c332b>`() const;
		virtual :ref:`ValueRect<doxid-struct_p1_1_1_camera_sdk_1_1_value_rect>` :ref:`RequestedCrop<doxid-class_p1_1_1_camera_sdk_1_1_live_view_impl_1af0c68e22dd6938cfbd083327d8b49faa>`() const;
		virtual :ref:`ValueArea<doxid-struct_p1_1_1_camera_sdk_1_1_value_area>` :ref:`SourceFullImageSize<doxid-class_p1_1_1_camera_sdk_1_1_live_view_impl_1a821e9370138b4e429f2601f07585b6b3>`() const;
	};

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>`;

		// 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:`CompressionQuality<doxid-class_p1_1_1_camera_sdk_1_1_i_live_view_1ac8622d320983848e0d7198b5efdfef44>`() const = 0;
		virtual bool :ref:`IsCompressed<doxid-class_p1_1_1_camera_sdk_1_1_i_live_view_1a06a53d20fe38f0a66e6dfe5392d155a9>`() const = 0;
		virtual :ref:`ValueRect<doxid-struct_p1_1_1_camera_sdk_1_1_value_rect>` :ref:`SourceCrop<doxid-class_p1_1_1_camera_sdk_1_1_i_live_view_1a498072c83bec8572c214cfd7615cd1f4>`() const = 0;
		virtual :ref:`ValueRect<doxid-struct_p1_1_1_camera_sdk_1_1_value_rect>` :ref:`RequestedCrop<doxid-class_p1_1_1_camera_sdk_1_1_i_live_view_1a597a365ad0d4675718dd952e2f5c990b>`() const = 0;
		virtual :ref:`ValueArea<doxid-struct_p1_1_1_camera_sdk_1_1_value_area>` :ref:`SourceFullImageSize<doxid-class_p1_1_1_camera_sdk_1_1_i_live_view_1a06ab423c2490acd423a0865592aeadb3>`() const = 0;

.. _details-class_p1_1_1_camera_sdk_1_1_live_view_impl:

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



Methods
-------

.. index:: pair: function; Data
.. _doxid-class_p1_1_1_camera_sdk_1_1_live_view_impl_1a75e026dd6c105ae7dc8254774fda0517:

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

	virtual std::shared_ptr<uint8_t const> Data() const

Returns a pointer to the pixel buffer data.

.. index:: pair: function; DataSizeBytes
.. _doxid-class_p1_1_1_camera_sdk_1_1_live_view_impl_1ae4479326b37dd13dd8ba9f7117a4fc67:

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

	virtual size_t DataSizeBytes() const

Returns the size of the pixel buffer in bytes.

.. index:: pair: function; Format
.. _doxid-class_p1_1_1_camera_sdk_1_1_live_view_impl_1ae5fa014f0b7b98ecfb4d57621faf2b11:

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

	virtual :ref:`ImageFormat<doxid-namespace_p1_1_1_camera_sdk_1a56985d71dffbf0cd6359e82b0ad7778d>` Format() const

Returns the image encoding type of this buffer (bitmap, jpeg)

.. index:: pair: function; BufferType
.. _doxid-class_p1_1_1_camera_sdk_1_1_live_view_impl_1a2d397105d25c4581eab2dc2e339fed07:

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

	virtual :ref:`Type<doxid-class_p1_1_1_camera_sdk_1_1_i_image_buffer_1a353ab2d01f8a9012d90d0fcf50c6aa29>` BufferType() const

Returns the type of this buffer.

.. index:: pair: function; BufferTypeStr
.. _doxid-class_p1_1_1_camera_sdk_1_1_live_view_impl_1a63b091c1395d7288381ba3ad6c8aa595:

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

	virtual char const* BufferTypeStr() const

Returns a string of the type this buffer.

.. index:: pair: function; FormatStr
.. _doxid-class_p1_1_1_camera_sdk_1_1_live_view_impl_1a19e097852bfcd9e5b5bb641775f4fea9:

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

	virtual char const* FormatStr() const

Returns a string of the type kind of this buffer, (RGB, JPEG, etc.)

.. index:: pair: function; DestinationWidth
.. _doxid-class_p1_1_1_camera_sdk_1_1_live_view_impl_1ac481792d22056e47ba571573f1612c67:

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

	virtual uint32_t DestinationWidth() const

Return the buffers width in pixels.

.. index:: pair: function; DestinationHeight
.. _doxid-class_p1_1_1_camera_sdk_1_1_live_view_impl_1a62ded8e592afc748b2b7f1e259a1bafe:

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

	virtual uint32_t DestinationHeight() const

Returns the buffers height in pixels.

.. index:: pair: function; CompressionQuality
.. _doxid-class_p1_1_1_camera_sdk_1_1_live_view_impl_1a0cf785b623d359b923ebd7cb80ecbe11:

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

	virtual uint32_t CompressionQuality() const

The compression quality as a percentage.

.. index:: pair: function; IsCompressed
.. _doxid-class_p1_1_1_camera_sdk_1_1_live_view_impl_1a0d65fa13a2ebf99fecc39e355e7ce90b:

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

	virtual bool IsCompressed() const

Returns whether the image has been compressed (e.g., by JPEG).

.. index:: pair: function; SourceCrop
.. _doxid-class_p1_1_1_camera_sdk_1_1_live_view_impl_1ad64e736a9edaf88beae26d8c5c4c332b:

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

	virtual :ref:`ValueRect<doxid-struct_p1_1_1_camera_sdk_1_1_value_rect>` SourceCrop() const

The actual crop that was cropped in the sensor.

.. index:: pair: function; RequestedCrop
.. _doxid-class_p1_1_1_camera_sdk_1_1_live_view_impl_1af0c68e22dd6938cfbd083327d8b49faa:

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

	virtual :ref:`ValueRect<doxid-struct_p1_1_1_camera_sdk_1_1_value_rect>` RequestedCrop() const

The user requested crop.

.. index:: pair: function; SourceFullImageSize
.. _doxid-class_p1_1_1_camera_sdk_1_1_live_view_impl_1a821e9370138b4e429f2601f07585b6b3:

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

	virtual :ref:`ValueArea<doxid-struct_p1_1_1_camera_sdk_1_1_value_area>` SourceFullImageSize() const

The full source (sensor) size.