.. index:: pair: class; P1::CameraSdk::Notifications
.. _doxid-class_p1_1_1_camera_sdk_1_1_notifications:

class P1::CameraSdk::Notifications
==================================

.. toctree::
	:hidden:

Overview
~~~~~~~~




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

	#include <P1CameraNotifications.hpp>
	
	class Notifications
	{
	public:
		// methods
	
		static uint32_t :ref:`RegisterListener<doxid-class_p1_1_1_camera_sdk_1_1_notifications_1adbb30dc2644f4a8a035e9473954170c4>`();
		static void :ref:`DeregisterListener<doxid-class_p1_1_1_camera_sdk_1_1_notifications_1a8286808d325a758a45d5795e8e1d7fb0>`(const uint32_t listenerId);
	
		static void :ref:`Enable<doxid-class_p1_1_1_camera_sdk_1_1_notifications_1ade1dc58ac6363d6ad79290e78b0c6165>`(
			const uint32_t listenerId,
			const :ref:`Camera<doxid-class_p1_1_1_camera_sdk_1_1_camera>`& camera,
			const int propertyId
			);
	
		static void :target:`Enable<doxid-class_p1_1_1_camera_sdk_1_1_notifications_1a729bf1acc768d70c190cf4a4fffbce92>`(
			const uint32_t listenerId,
			const :ref:`Camera<doxid-class_p1_1_1_camera_sdk_1_1_camera>`& cameraId,
			const :ref:`CameraEventId<doxid-namespace_p1_1_1_camera_sdk_1ab2674573a5630cadf0a68b9d09b7944d>` eventId
			);
	
		static void :target:`Disable<doxid-class_p1_1_1_camera_sdk_1_1_notifications_1aed0c5c6cb9c133df8c813fb939e3c20b>`(
			const uint32_t listenerId,
			const :ref:`Camera<doxid-class_p1_1_1_camera_sdk_1_1_camera>`& camera,
			const int propertyId
			);
	
		static void :target:`Disable<doxid-class_p1_1_1_camera_sdk_1_1_notifications_1a4b88543b3eca5d346c015739644d0116>`(
			const uint32_t listenerId,
			const :ref:`Camera<doxid-class_p1_1_1_camera_sdk_1_1_camera>`& cameraId,
			const :ref:`CameraEventId<doxid-namespace_p1_1_1_camera_sdk_1ab2674573a5630cadf0a68b9d09b7944d>` eventId
			);
	
		static void :target:`DisableAll<doxid-class_p1_1_1_camera_sdk_1_1_notifications_1a23da1064ecb070fca1901a43915d4262>`(const uint32_t listenerId);
		static void :ref:`WakeUpWaitingThreads<doxid-class_p1_1_1_camera_sdk_1_1_notifications_1aae793451c7dc8dbf701f1e2d5a4080f9>`(const uint32_t listenerId);
	
		static :ref:`NotificationEvent<doxid-struct_p1_1_1_camera_sdk_1_1_notification_event>` :ref:`WaitForNotification<doxid-class_p1_1_1_camera_sdk_1_1_notifications_1a36c8d852487fb55788e3982fd9f65eeb>`(
			const uint32_t listenerId,
			uint32_t timeoutMs = 0
			);
	
		static bool :ref:`WaitForNotification<doxid-class_p1_1_1_camera_sdk_1_1_notifications_1a785dc95fc33d2992ffa520408ac13b6d>`(
			const uint32_t listenerId,
			:ref:`NotificationEvent<doxid-struct_p1_1_1_camera_sdk_1_1_notification_event>`& event,
			uint32_t timeoutMs = 0
			);
	};
.. _details-class_p1_1_1_camera_sdk_1_1_notifications:

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



Methods
-------

.. index:: pair: function; RegisterListener
.. _doxid-class_p1_1_1_camera_sdk_1_1_notifications_1adbb30dc2644f4a8a035e9473954170c4:

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

	static uint32_t RegisterListener()

Register as listener for receiving events.

The returned token shall be used to identify the listener in all succeeding function calls.

.. index:: pair: function; DeregisterListener
.. _doxid-class_p1_1_1_camera_sdk_1_1_notifications_1a8286808d325a758a45d5795e8e1d7fb0:

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

	static void DeregisterListener(const uint32_t listenerId)

Cleans up everything for the given listener, and render the id useless.

.. index:: pair: function; Enable
.. _doxid-class_p1_1_1_camera_sdk_1_1_notifications_1ade1dc58ac6363d6ad79290e78b0c6165:

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

	static void Enable(
		const uint32_t listenerId,
		const :ref:`Camera<doxid-class_p1_1_1_camera_sdk_1_1_camera>`& camera,
		const int propertyId
		)

Begin listening for a camera property change.

Before any notification will arrive, you must register yourself as a listener. A listener is local to the current thread. This means you must use the same thread to call this function and :ref:`WaitForNotification <doxid-class_p1_1_1_camera_sdk_1_1_notifications_1a36c8d852487fb55788e3982fd9f65eeb>`.



.. rubric:: Parameters:

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

	*
		- userHandle

		- A registered listener-id.

	*
		- camera

		- The camera on which to listen for the property change

	*
		- propertyId

		- The property to listen for changes on

.. index:: pair: function; WakeUpWaitingThreads
.. _doxid-class_p1_1_1_camera_sdk_1_1_notifications_1aae793451c7dc8dbf701f1e2d5a4080f9:

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

	static void WakeUpWaitingThreads(const uint32_t listenerId)

Wake up all pending threads "caught" in the :ref:`WaitForNotification() <doxid-class_p1_1_1_camera_sdk_1_1_notifications_1a36c8d852487fb55788e3982fd9f65eeb>` function.

This function will force all pending thread to exit from :ref:`WaitForNotification <doxid-class_p1_1_1_camera_sdk_1_1_notifications_1a36c8d852487fb55788e3982fd9f65eeb>` as if a timeout has arrived. Even if no timeout was configured!

You should use this function to terminate your threads gracefully, when your app exits.

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

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

	static :ref:`NotificationEvent<doxid-struct_p1_1_1_camera_sdk_1_1_notification_event>` WaitForNotification(
		const uint32_t listenerId,
		uint32_t timeoutMs = 0
		)

Wait for the next arriving vent (property change or camera event)

This call will block until the notification arrives, or until a defined timeout is reached.

If timeout is reached this call throws the :ref:`NotificationTimeoutExc <doxid-class_p1_1_1_camera_sdk_1_1_notification_timeout_exc>` exception.



.. rubric:: Parameters:

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

	*
		- timeoutMs

		- A millisecond timeout for when to give up waiting, or zero to wait forever.



.. rubric:: Returns:

The event that has occurred (if note timed out).

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

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

	static bool WaitForNotification(
		const uint32_t listenerId,
		:ref:`NotificationEvent<doxid-struct_p1_1_1_camera_sdk_1_1_notification_event>`& event,
		uint32_t timeoutMs = 0
		)

Wait for the next arriving vent (property change or camera event)

This call will block until the notification arrives, or until a defined timeout is reached.



.. rubric:: Parameters:

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

	*
		- event

		- The event that has occurred (if note timed out)

	*
		- timeoutMs

		- A millisecond timeout for when to give up waiting, or zero to wait forever.



.. rubric:: Returns:

true is a notification arrived, false if timeout was reached