.. index:: pair: struct; P1::CameraSdk::ISubscription
.. _doxid-struct_p1_1_1_camera_sdk_1_1_i_subscription:

struct P1::CameraSdk::ISubscription
===================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Interface common to all subscriptions. :ref:`More...<details-struct_p1_1_1_camera_sdk_1_1_i_subscription>`


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

	#include <C_P1CameraCommonSubscriptions.h>
	
	struct ISubscription
	{
		// 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;
	};

	// direct descendants

	class :ref:`IFullImageSubscription<doxid-class_p1_1_1_camera_sdk_1_1_i_full_image_subscription>`;
	class :ref:`ILiveViewSubscription<doxid-class_p1_1_1_camera_sdk_1_1_i_live_view_subscription>`;
	class :ref:`IPreviewSubscription<doxid-class_p1_1_1_camera_sdk_1_1_i_preview_subscription>`;
.. _details-struct_p1_1_1_camera_sdk_1_1_i_subscription:

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

Interface common to all subscriptions.

A subscription allows the camera to send you notifications in response to events in the camera. Suscribing just means that you enable this event delivery.

To receive the notifications from the subscribed events, you *must* still enable notifications for the actual events, related to the subscription.

Further, when activating a subscription (by subscribing), you might change state in the camera or enable certain hardware.

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

Methods
-------

.. index:: pair: function; IsSupported
.. _doxid-struct_p1_1_1_camera_sdk_1_1_i_subscription_1add4718a06f54323ba2e98f3615333d63:

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

	virtual bool IsSupported() const = 0

Check if the camera supports this subscription

.. index:: pair: function; IsSubscribed
.. _doxid-struct_p1_1_1_camera_sdk_1_1_i_subscription_1a0858169df6758a9357b33d0cce1c80de:

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

	virtual bool IsSubscribed() const = 0

Check if we are currently subscribed

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

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

	virtual void Subscribe() = 0

Begin subscribing and receive notifications for the related events.

.. index:: pair: function; Unsubscribe
.. _doxid-struct_p1_1_1_camera_sdk_1_1_i_subscription_1a052c6e4d651389f0d889984cfd6ed3c8:

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

	virtual void Unsubscribe() = 0

Cancel the subscription, no new notifications will be posted.

Note that there might still be a backlog of pending notifications from previous posted events. Unsubscribing does *not* clear that queue.