.. index:: pair: class; P1::CameraSdk::ILiveView
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_live_view:

class P1::CameraSdk::ILiveView
==============================

.. toctree::
	:hidden:

Overview
~~~~~~~~

A buffer with a LiveView frame. :ref:`More...<details-class_p1_1_1_camera_sdk_1_1_i_live_view>`


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

	#include <C_P1CameraCommonStructs.h>
	
	class ILiveView: public :ref:`P1::CameraSdk::IImageBufferFrame<doxid-class_p1_1_1_camera_sdk_1_1_i_image_buffer_frame>`
	{
	public:
		// methods
	
		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;
	};

	// direct descendants

	class :ref:`LiveViewImpl<doxid-class_p1_1_1_camera_sdk_1_1_live_view_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>`;

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

.. _details-class_p1_1_1_camera_sdk_1_1_i_live_view:

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

A buffer with a LiveView frame.

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

Methods
-------

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

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

	virtual uint32_t CompressionQuality() const = 0

The compression quality as a percentage.

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

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

	virtual bool IsCompressed() const = 0

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

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

.. 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 = 0

The actual crop that was cropped in the sensor.

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

.. 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 = 0

The user requested crop.

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

.. 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 = 0

The full source (sensor) size.