.. index:: pair: class; P1::CameraSdk::IPreviewSubscription
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_preview_subscription:

class P1::CameraSdk::IPreviewSubscription
=========================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Subscribe / unsubscribe to preview transfers. :ref:`More...<details-class_p1_1_1_camera_sdk_1_1_i_preview_subscription>`


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

	#include <C_P1CameraCommonSubscriptions.h>
	
	class IPreviewSubscription: public :ref:`P1::CameraSdk::ISubscription<doxid-struct_p1_1_1_camera_sdk_1_1_i_subscription>`
	{
	public:
		// typedefs
	
		typedef std::vector<:ref:`ImageFormat<doxid-namespace_p1_1_1_camera_sdk_1a56985d71dffbf0cd6359e82b0ad7778d>`> :target:`SupportedFormats<doxid-class_p1_1_1_camera_sdk_1_1_i_preview_subscription_1a160bec31b6169476d9cb076df7e7f12e>`;

		// methods
	
		virtual void :ref:`Subscribe<doxid-class_p1_1_1_camera_sdk_1_1_i_preview_subscription_1ab63b12bed4d888f27ecfa121976d2014>`(:ref:`ImageFormat<doxid-namespace_p1_1_1_camera_sdk_1a56985d71dffbf0cd6359e82b0ad7778d>` format) = 0;
		virtual void :ref:`Subscribe<doxid-class_p1_1_1_camera_sdk_1_1_i_preview_subscription_1a91a544b1fbe44ce220e87ba525b9363f>`() = 0;
		virtual :ref:`SupportedFormats<doxid-class_p1_1_1_camera_sdk_1_1_i_preview_subscription_1a160bec31b6169476d9cb076df7e7f12e>` :ref:`ImageFormatsSupported<doxid-class_p1_1_1_camera_sdk_1_1_i_preview_subscription_1ad39103a09810871655ee294de921e508>`() 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_preview_subscription_1a5f200e997180b8131acb1ecb1d9c67ae>`() const = 0;
		virtual void :ref:`SetFormat<doxid-class_p1_1_1_camera_sdk_1_1_i_preview_subscription_1a86b55504d25d97465219cd1287d7377b>`(:ref:`ImageFormat<doxid-namespace_p1_1_1_camera_sdk_1a56985d71dffbf0cd6359e82b0ad7778d>` format) = 0;
	};

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

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

	public:
		// methods
	
		virtual bool :ref:`IsSupported<doxid-struct_p1_1_1_camera_sdk_1_1_i_subscription_1add4718a06f54323ba2e98f3615333d63>`() const = 0;
		virtual bool :ref:`IsSubscribed<doxid-struct_p1_1_1_camera_sdk_1_1_i_subscription_1a0858169df6758a9357b33d0cce1c80de>`() const = 0;
		virtual void :ref:`Subscribe<doxid-struct_p1_1_1_camera_sdk_1_1_i_subscription_1aa0fbd355d9ada8e9b42881d84eaec00c>`() = 0;
		virtual void :ref:`Unsubscribe<doxid-struct_p1_1_1_camera_sdk_1_1_i_subscription_1a052c6e4d651389f0d889984cfd6ed3c8>`() = 0;

.. _details-class_p1_1_1_camera_sdk_1_1_i_preview_subscription:

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

Subscribe / unsubscribe to preview transfers.

Subscribing to this tells the camera that we want to receive previews of newly captured images. The previews arrive via the notification :ref:`EventType::CameraPreviewReady <doxid-class_p1_1_1_camera_sdk_1_1_event_type_1aed9834b5dee521d3a6912345454632d0>`.

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



.. rubric:: See also:

:ref:`ISubscriptionManager <doxid-class_p1_1_1_camera_sdk_1_1_i_subscription_manager>`

Methods
-------

.. index:: pair: function; Subscribe
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_preview_subscription_1ab63b12bed4d888f27ecfa121976d2014:

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

	virtual void Subscribe(:ref:`ImageFormat<doxid-namespace_p1_1_1_camera_sdk_1a56985d71dffbf0cd6359e82b0ad7778d>` format) = 0

Subscribe to previews in the desired format.

See :ref:`ImageFormatsSupported <doxid-class_p1_1_1_camera_sdk_1_1_i_preview_subscription_1ad39103a09810871655ee294de921e508>` for supported formats

.. index:: pair: function; Subscribe
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_preview_subscription_1a91a544b1fbe44ce220e87ba525b9363f:

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

	virtual void Subscribe() = 0

Subscribe to previews using the format defined by :ref:`Format <doxid-class_p1_1_1_camera_sdk_1_1_i_preview_subscription_1a5f200e997180b8131acb1ecb1d9c67ae>`.

See :ref:`ImageFormatsSupported <doxid-class_p1_1_1_camera_sdk_1_1_i_preview_subscription_1ad39103a09810871655ee294de921e508>` for supported formats for the camera

.. index:: pair: function; ImageFormatsSupported
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_preview_subscription_1ad39103a09810871655ee294de921e508:

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

	virtual :ref:`SupportedFormats<doxid-class_p1_1_1_camera_sdk_1_1_i_preview_subscription_1a160bec31b6169476d9cb076df7e7f12e>` ImageFormatsSupported() const = 0

Formats supported for previews by the camera.

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

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

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

Get current format in use.

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

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

	virtual void SetFormat(:ref:`ImageFormat<doxid-namespace_p1_1_1_camera_sdk_1a56985d71dffbf0cd6359e82b0ad7778d>` format) = 0

Change the preview format.