.. index:: pair: class; P1::CameraSdk::Listener
.. _doxid-class_p1_1_1_camera_sdk_1_1_listener:

class P1::CameraSdk::Listener
=============================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Class that allows you to receive notifications for events. :ref:`More...<details-class_p1_1_1_camera_sdk_1_1_listener>`


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

	#include <P1CameraListener.hpp>
	
	class Listener
	{
	public:
		// methods
	
		:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` void :ref:`EnableNotification<doxid-class_p1_1_1_camera_sdk_1_1_listener_1a00915256be48a4e529206b41f3068dc5>`(
			const :ref:`Camera<doxid-class_p1_1_1_camera_sdk_1_1_camera>`& camera,
			const uint32_t propertyId,
			bool isSpecificationChange = false
			);
	
		:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` void :ref:`EnableNotification<doxid-class_p1_1_1_camera_sdk_1_1_listener_1ac601812693e35adbda9ddbb2743dcdf9>`(
			const :ref:`Camera<doxid-class_p1_1_1_camera_sdk_1_1_camera>`& camera,
			const :ref:`CameraEventId<doxid-namespace_p1_1_1_camera_sdk_1ab2674573a5630cadf0a68b9d09b7944d>` eventId
			);
	
		:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` void :ref:`EnableNotification<doxid-class_p1_1_1_camera_sdk_1_1_listener_1a6cb816e4f9daac72ad2c8e424e50f4ee>`(const :ref:`SdkEventId<doxid-namespace_p1_1_1_camera_sdk_1aecc544c527719387d6a6b0a6c05365d6>` sdkEventId);
	
		:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` void :ref:`DisableNotification<doxid-class_p1_1_1_camera_sdk_1_1_listener_1abb44dbc3bab5c0ff877dd65e4392f9dd>`(
			const :ref:`Camera<doxid-class_p1_1_1_camera_sdk_1_1_camera>`& camera,
			const uint32_t propertyId,
			bool isSpecificationChange = false
			);
	
		:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` void :ref:`DisableNotification<doxid-class_p1_1_1_camera_sdk_1_1_listener_1aacc1b73bcfd9af2b48b3c690626b6949>`(
			const :ref:`Camera<doxid-class_p1_1_1_camera_sdk_1_1_camera>`& camera,
			const :ref:`CameraEventId<doxid-namespace_p1_1_1_camera_sdk_1ab2674573a5630cadf0a68b9d09b7944d>` eventId
			);
	
		:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` void :ref:`DisableNotification<doxid-class_p1_1_1_camera_sdk_1_1_listener_1a05f3436e36eadd995d98740ec6b3c1d8>`(const :ref:`SdkEventId<doxid-namespace_p1_1_1_camera_sdk_1aecc544c527719387d6a6b0a6c05365d6>` sdkEventId);
		:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` void :ref:`EnableCatchAllNotifications<doxid-class_p1_1_1_camera_sdk_1_1_listener_1a643f8408f56191a5479e5e38dbf004f9>`();
		:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` void :ref:`DisableCatchAllNotifications<doxid-class_p1_1_1_camera_sdk_1_1_listener_1af6a0ea544b481ae113db055b270ba5f5>`();
	
		:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` bool :ref:`WaitForNotification<doxid-class_p1_1_1_camera_sdk_1_1_listener_1a4d1d2eed2a7fff9a791d83ed8c55923e>`(
			:ref:`NotificationEvent<doxid-struct_p1_1_1_camera_sdk_1_1_notification_event>`& arrivedNotification,
			uint32_t timeoutMs = 0
			);
	
		:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` void :ref:`WakeUpWaitingThread<doxid-class_p1_1_1_camera_sdk_1_1_listener_1a19d0efb80b4762af7c169fb8eb2fa01b>`();
	};
.. _details-class_p1_1_1_camera_sdk_1_1_listener:

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

Class that allows you to receive notifications for events.

The :ref:`Listener <doxid-class_p1_1_1_camera_sdk_1_1_listener>` is notification subscription and receive context. You enable notifications on a :ref:`Listener <doxid-class_p1_1_1_camera_sdk_1_1_listener>` object, and wait for incoming notifications on the same :ref:`Listener <doxid-class_p1_1_1_camera_sdk_1_1_listener>`.

You can create multiple listener objects, and enable different sets of notifications on them. Each listener will receive only notifications explicitly enable on each one of them.

One exception is if you enable "catch all" notifications on the listener. Then all notification generated by the CameraSDK, will be sent to the listener, even without a single call to EnableNotification(...).

When disable the "catch all" state on the listener, it returns to the normal operating state, delivering only enabled notifications.

Methods
-------

.. index:: pair: function; EnableNotification
.. _doxid-class_p1_1_1_camera_sdk_1_1_listener_1a00915256be48a4e529206b41f3068dc5:

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

	:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` void EnableNotification(
		const :ref:`Camera<doxid-class_p1_1_1_camera_sdk_1_1_camera>`& camera,
		const uint32_t propertyId,
		bool isSpecificationChange = false
		)

Enables receiving a specific property notification.

All properties belongs to a :ref:`Camera <doxid-class_p1_1_1_camera_sdk_1_1_camera>`. Therefore you must provide the camera from which you would like to receive notifications.

Further, there are two kind of property changes that can be enabled: value change and specification changes. Value changes are changes to a property's current value. Specification changes are changes to the :ref:`PropertySpecification <doxid-struct_p1_1_1_camera_sdk_1_1_property_specification>` object, and may changes such as read-only, range and value list state.

The default options is to enable value change notifications.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- camera

		- The camera who's property we wish to receive notifications for

	*
		- propertyId

		- The Id of the property we wish to receive notification for

	*
		- isSpecificationChange

		- Set to ``true`` if you want only specification state change notifications

.. index:: pair: function; EnableNotification
.. _doxid-class_p1_1_1_camera_sdk_1_1_listener_1ac601812693e35adbda9ddbb2743dcdf9:

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

	:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` void EnableNotification(
		const :ref:`Camera<doxid-class_p1_1_1_camera_sdk_1_1_camera>`& camera,
		const :ref:`CameraEventId<doxid-namespace_p1_1_1_camera_sdk_1ab2674573a5630cadf0a68b9d09b7944d>` eventId
		)

Enables receiving notifications for :ref:`Camera <doxid-class_p1_1_1_camera_sdk_1_1_camera>` events.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- camera

		- The camera to enable the camera event notification on

	*
		- eventId

		- The CameraEventId enum for the event type to receive notifications for

.. index:: pair: function; EnableNotification
.. _doxid-class_p1_1_1_camera_sdk_1_1_listener_1a6cb816e4f9daac72ad2c8e424e50f4ee:

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

	:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` void EnableNotification(const :ref:`SdkEventId<doxid-namespace_p1_1_1_camera_sdk_1aecc544c527719387d6a6b0a6c05365d6>` sdkEventId)

Enables receiving notifications for SDK related events.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- sdkEventId

		- The SdkEventId enum for the event type to receive notifications for

.. index:: pair: function; DisableNotification
.. _doxid-class_p1_1_1_camera_sdk_1_1_listener_1abb44dbc3bab5c0ff877dd65e4392f9dd:

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

	:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` void DisableNotification(
		const :ref:`Camera<doxid-class_p1_1_1_camera_sdk_1_1_camera>`& camera,
		const uint32_t propertyId,
		bool isSpecificationChange = false
		)

Disable receiving property change notifications.

This causes the listener to stop receiving new notification for the specific property change event.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- camera

		- The camera who's property to stop receiving notifications for

	*
		- propertyId

		- The Id of the property to stop receiving notification for

	*
		- isSpecificationChange

		- Set to ``true`` to disable specification change notifications, ``false`` for value change

.. index:: pair: function; DisableNotification
.. _doxid-class_p1_1_1_camera_sdk_1_1_listener_1aacc1b73bcfd9af2b48b3c690626b6949:

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

	:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` void DisableNotification(
		const :ref:`Camera<doxid-class_p1_1_1_camera_sdk_1_1_camera>`& camera,
		const :ref:`CameraEventId<doxid-namespace_p1_1_1_camera_sdk_1ab2674573a5630cadf0a68b9d09b7944d>` eventId
		)

Disable receiving camera event notifications.

.. index:: pair: function; DisableNotification
.. _doxid-class_p1_1_1_camera_sdk_1_1_listener_1a05f3436e36eadd995d98740ec6b3c1d8:

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

	:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` void DisableNotification(const :ref:`SdkEventId<doxid-namespace_p1_1_1_camera_sdk_1aecc544c527719387d6a6b0a6c05365d6>` sdkEventId)

Disable receiving SDK event notifications.

.. index:: pair: function; EnableCatchAllNotifications
.. _doxid-class_p1_1_1_camera_sdk_1_1_listener_1a643f8408f56191a5479e5e38dbf004f9:

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

	:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` void EnableCatchAllNotifications()

Enable "catch all" state on this listener.

In "catch all" state, every notification generated by the SDK is delivered to this listener. (Across all opened cameras!)

This also has the effect of enabling notifications for properties that are not currently visible on the cameras. (Due to the cameras state.)

.. index:: pair: function; DisableCatchAllNotifications
.. _doxid-class_p1_1_1_camera_sdk_1_1_listener_1af6a0ea544b481ae113db055b270ba5f5:

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

	:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` void DisableCatchAllNotifications()

Disable "catch all" state on the listener.

This deactivates the delivery of all types of notifications to this listener. The listener state is returned to normal, where only enabled notification will be delivered. (The ones enabled calling :ref:`EnableNotification <doxid-class_p1_1_1_camera_sdk_1_1_listener_1a00915256be48a4e529206b41f3068dc5>`)

Any explicitly enabled notifications will be preserved, and are thus not affected by disabling "catch all" state.

.. index:: pair: function; WaitForNotification
.. _doxid-class_p1_1_1_camera_sdk_1_1_listener_1a4d1d2eed2a7fff9a791d83ed8c55923e:

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

	:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` bool WaitForNotification(
		:ref:`NotificationEvent<doxid-struct_p1_1_1_camera_sdk_1_1_notification_event>`& arrivedNotification,
		uint32_t timeoutMs = 0
		)

Block until the next notification is received.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- arrivedNotification

		- Out-parameter for the notification that is received, if any

	*
		- timeoutMs

		- Time in milliseconds to wait for next notification, before giving up



.. rubric:: Returns:

``true`` if a notification was received, ``false`` if timed out

.. index:: pair: function; WakeUpWaitingThread
.. _doxid-class_p1_1_1_camera_sdk_1_1_listener_1a19d0efb80b4762af7c169fb8eb2fa01b:

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

	:ref:`EXPORT_API<doxid-_c___p1_image_common_linkage_8h_1a3536620a51a6fa45b41e6d9ff6fc4ad3>` void WakeUpWaitingThread()

Wakes up any thread that may be bocked in the WaitForNotification call.