.. index:: pair: class; P1::CameraSdk::LiveViewConfiguration
.. _doxid-class_p1_1_1_camera_sdk_1_1_live_view_configuration:

class P1::CameraSdk::LiveViewConfiguration
==========================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Representation of a cameras curretn LiveView config (setup) :ref:`More...<details-class_p1_1_1_camera_sdk_1_1_live_view_configuration>`


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

	#include <P1CameraLiveViewConfiguration.hpp>
	
	class LiveViewConfiguration
	{
	public:
		// construction
	
		:target:`LiveViewConfiguration<doxid-class_p1_1_1_camera_sdk_1_1_live_view_configuration_1ab2a0914fe3d20210f5676befe6b233b2>`(LiveViewConfigurationPimpl* pimpl);
		:target:`LiveViewConfiguration<doxid-class_p1_1_1_camera_sdk_1_1_live_view_configuration_1a8633d5e4fe0164dcd6c28f17328cce87>`(const LiveViewConfiguration& other);
		:target:`LiveViewConfiguration<doxid-class_p1_1_1_camera_sdk_1_1_live_view_configuration_1a2c1436072c77fe8aa16b9d5e648ce571>`(LiveViewConfiguration&& other);

		// methods
	
		:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` LiveViewConfiguration& :target:`operator =<doxid-class_p1_1_1_camera_sdk_1_1_live_view_configuration_1a212ac63beac4d21b6aedc7c74acc4538>` (const LiveViewConfiguration& other);
		:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` :ref:`LiveViewBitmapFormat<doxid-namespace_p1_1_1_camera_sdk_1ad0ef85171facf0b8886cc4fcdd9af47a>` :ref:`Format<doxid-class_p1_1_1_camera_sdk_1_1_live_view_configuration_1a820fa55259c4a86c02e8752d9cff1cfe>`() const;
		:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` :ref:`ValueRect<doxid-struct_p1_1_1_camera_sdk_1_1_value_rect>` :ref:`Crop<doxid-class_p1_1_1_camera_sdk_1_1_live_view_configuration_1ae7eff0ea7daf892bef010241e8f32b88>`() const;
		:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` uint32_t :ref:`PreferredMaxDimension<doxid-class_p1_1_1_camera_sdk_1_1_live_view_configuration_1aeacfc8a6ef58efae0ba90b8fe51ea3c2>`() const;
		:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` :ref:`ValueArea<doxid-struct_p1_1_1_camera_sdk_1_1_value_area>` :ref:`FullImageSize<doxid-class_p1_1_1_camera_sdk_1_1_live_view_configuration_1a65a0d4d05755f7b14d3965630563615e>`() const;
		:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` float :ref:`Lightness<doxid-class_p1_1_1_camera_sdk_1_1_live_view_configuration_1af0fd05d3269c59e396a013bd26428582>`() const;
		:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` void :ref:`SetFormat<doxid-class_p1_1_1_camera_sdk_1_1_live_view_configuration_1a8374d331560001a27cdec741dc81fba7>`(const :ref:`LiveViewBitmapFormat<doxid-namespace_p1_1_1_camera_sdk_1ad0ef85171facf0b8886cc4fcdd9af47a>` format);
		:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` void :ref:`SetCrop<doxid-class_p1_1_1_camera_sdk_1_1_live_view_configuration_1a01877afbf317339946f2d05769dd165d>`(const :ref:`ValueRect<doxid-struct_p1_1_1_camera_sdk_1_1_value_rect>`& cropRect);
		:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` void :ref:`SetPreferredMaxDimension<doxid-class_p1_1_1_camera_sdk_1_1_live_view_configuration_1a0cc9c94a9a732d832cd6ceddd3c306ab>`(const uint32_t maxDimensionValue);
		:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` void :ref:`SetWhiteBalancePoint<doxid-class_p1_1_1_camera_sdk_1_1_live_view_configuration_1ae17388763ae2fb4250755084a8c62ba8>`(const :ref:`ValuePoint<doxid-struct_p1_1_1_camera_sdk_1_1_value_point>`& whitePoint);
		:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` void :ref:`SetLightness<doxid-class_p1_1_1_camera_sdk_1_1_live_view_configuration_1a7475cd2d66fce3021f0a9c5f19de2094>`(const float lightness);
		:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` std::string :target:`ToString<doxid-class_p1_1_1_camera_sdk_1_1_live_view_configuration_1ac7c67159e34a74f19b2f0df894ea76f9>`() const;
	};
.. _details-class_p1_1_1_camera_sdk_1_1_live_view_configuration:

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

Representation of a cameras curretn LiveView config (setup)

This class allows you to configure the LiveView properties of a camera.

You obtain an object of this class using the :ref:`Camera::GetLiveViewConfiguration <doxid-class_p1_1_1_camera_sdk_1_1_camera_1abac7289095ba36016cd8d01568bd7677>` on the :ref:`Camera <doxid-class_p1_1_1_camera_sdk_1_1_camera>`. As you edit the parameters on the class, the corrospanding values are changed in the camera.

**Note** : Changing the LiveView configuration is an exspensive operation, and requires a lot of work to be done in the camera. Also, the LiveView image feed is heavily pipelined, so changes will occur after a some delay.

The :ref:`LiveViewImage <doxid-struct_p1_1_1_camera_sdk_1_1_live_view_image>` class helps you account of this, by including the current LiveView image's *crop* parameters.

This LiveVIew output image size is independent from the applied crop. It is only influenced by the :ref:`PreferredMaxDimension <doxid-class_p1_1_1_camera_sdk_1_1_live_view_configuration_1aeacfc8a6ef58efae0ba90b8fe51ea3c2>` setting. This defines the length of the biggest of the image dimensions, which is most likely the width.

The default LiveView image width is 1024 pixels, but you can change it to other common resolutions; like 640, 800, etc. You cannot set it to an arbitrary integer. The desired dimension value will snap the supported image resolutions.

Methods
-------

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

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

	:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` :ref:`LiveViewBitmapFormat<doxid-namespace_p1_1_1_camera_sdk_1ad0ef85171facf0b8886cc4fcdd9af47a>` Format() const

Get the current bitmap format setting of LiveView.

.. index:: pair: function; Crop
.. _doxid-class_p1_1_1_camera_sdk_1_1_live_view_configuration_1ae7eff0ea7daf892bef010241e8f32b88:

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

	:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` :ref:`ValueRect<doxid-struct_p1_1_1_camera_sdk_1_1_value_rect>` Crop() const

Get the current crop applied to the LiveView.

.. index:: pair: function; PreferredMaxDimension
.. _doxid-class_p1_1_1_camera_sdk_1_1_live_view_configuration_1aeacfc8a6ef58efae0ba90b8fe51ea3c2:

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

	:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` uint32_t PreferredMaxDimension() const

Get the current desired max output dimension of the LiveView.

.. index:: pair: function; FullImageSize
.. _doxid-class_p1_1_1_camera_sdk_1_1_live_view_configuration_1a65a0d4d05755f7b14d3965630563615e:

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

	:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` :ref:`ValueArea<doxid-struct_p1_1_1_camera_sdk_1_1_value_area>` FullImageSize() const

Get the Helper method to reset the crop to "no crop".

.. index:: pair: function; Lightness
.. _doxid-class_p1_1_1_camera_sdk_1_1_live_view_configuration_1af0fd05d3269c59e396a013bd26428582:

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

	:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` float Lightness() const

An abstract value for exposure compensation.

This values maps to the exposure compensation, but does not use the same EV values. Instead it uses an opaque float point value.



.. rubric:: Returns:

float The current lightness

.. index:: pair: function; SetFormat
.. _doxid-class_p1_1_1_camera_sdk_1_1_live_view_configuration_1a8374d331560001a27cdec741dc81fba7:

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

	:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` void SetFormat(const :ref:`LiveViewBitmapFormat<doxid-namespace_p1_1_1_camera_sdk_1ad0ef85171facf0b8886cc4fcdd9af47a>` format)

Set the LiveView image's bitmap format.

.. index:: pair: function; SetCrop
.. _doxid-class_p1_1_1_camera_sdk_1_1_live_view_configuration_1a01877afbf317339946f2d05769dd165d:

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

	:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` void SetCrop(const :ref:`ValueRect<doxid-struct_p1_1_1_camera_sdk_1_1_value_rect>`& cropRect)

Set a new crop on the LiveView.

.. index:: pair: function; SetPreferredMaxDimension
.. _doxid-class_p1_1_1_camera_sdk_1_1_live_view_configuration_1a0cc9c94a9a732d832cd6ceddd3c306ab:

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

	:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` void SetPreferredMaxDimension(const uint32_t maxDimensionValue)

Set the desired maximum dimension (width) of the LiveView's output images.

.. index:: pair: function; SetWhiteBalancePoint
.. _doxid-class_p1_1_1_camera_sdk_1_1_live_view_configuration_1ae17388763ae2fb4250755084a8c62ba8:

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

	:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` void SetWhiteBalancePoint(const :ref:`ValuePoint<doxid-struct_p1_1_1_camera_sdk_1_1_value_point>`& whitePoint)

Set the *Custom C1* white balance, by the sampling a position in full image coordinates.

This method changes the cameras white balance property to *Custom C1* setting. And the white balance vector for *Custom C1* is changed to reflect the sample position provided by this method. **This means the cameras white balance setting is changed!**

Use the *white balance* property, to change white balance back to *Auto* or *Daylight*, etc.

.. index:: pair: function; SetLightness
.. _doxid-class_p1_1_1_camera_sdk_1_1_live_view_configuration_1a7475cd2d66fce3021f0a9c5f19de2094:

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

	:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` void SetLightness(const float lightness)

Set a *exposure compensation* -like value applied to the live view.