.. _doxcsid-interface_p1_1_1_camera_sdk_1_1_i_live_view_subscription:

ILiveViewSubscription Interface
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Definition
^^^^^^^^^^

*Namespace:* ``P1.CameraSdk``

Subscribe / unsubscribe to a LiveView stream of images. :ref:`More...<csdetails-interface_p1_1_1_camera_sdk_1_1_i_live_view_subscription>`

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

	public interface ILiveViewSubscription :  :ref:`P1::CameraSdk::ISubscription<doxcsid-interface_p1_1_1_camera_sdk_1_1_i_subscription>`


.. _csdetails-interface_p1_1_1_camera_sdk_1_1_i_live_view_subscription:

Remarks
^^^^^^^

Subscribe / unsubscribe to a LiveView stream of images.

Subscribing to this tells the camera that we would like a video stream of images from the camera. Also using this class interface, LiveView subscriptions can be configured for format and size.

Subscribing to this subscription will activate LiveView the camera, and stream image frames to your host, as long as the subscription is active.



.. rubric:: See also:

:ref:`SubscriptionManager <doxcsid-class_p1_1_1_camera_sdk_1_1_subscription_manager>`


Properties
^^^^^^^^^^

.. toctree::
	:hidden:

	ImageFormatsSupported <property_P1_CameraSdk_ILiveViewSubscription_ImageFormatsSupported.rst>
	Format <property_P1_CameraSdk_ILiveViewSubscription_Format.rst>
	Crop <property_P1_CameraSdk_ILiveViewSubscription_Crop.rst>
	PreferredMaxDimension <property_P1_CameraSdk_ILiveViewSubscription_PreferredMaxDimension.rst>
	FullImageSize <property_P1_CameraSdk_ILiveViewSubscription_FullImageSize.rst>
	Lightness <property_P1_CameraSdk_ILiveViewSubscription_Lightness.rst>

.. list-table::
	:widths: 30 70

	*
		- :ref:`ImageFormatsSupported <doxcsid-interface_p1_1_1_camera_sdk_1_1_i_live_view_subscription_1a99d9785fb0d173f4b3e3801d0579b54a>`
		- List the formats supported for LiveView by the camera
	*
		- :ref:`Format <doxcsid-interface_p1_1_1_camera_sdk_1_1_i_live_view_subscription_1ae52e573ff2c77af8f8e13cce574a1ef6>`
		- The current LiveView format in use
	*
		- :ref:`Crop <doxcsid-interface_p1_1_1_camera_sdk_1_1_i_live_view_subscription_1af784734b4bee93c4c36cd18cf545ab3e>`
		- The current crop applied to the LiveView
	*
		- :ref:`PreferredMaxDimension <doxcsid-interface_p1_1_1_camera_sdk_1_1_i_live_view_subscription_1a73a2a91653a552866a0039e808fd2f2c>`
		- The current desired max output dimension of the LiveView
	*
		- :ref:`FullImageSize <doxcsid-interface_p1_1_1_camera_sdk_1_1_i_live_view_subscription_1a41b85bb0ffdf109f07d948f5245b4a52>`
		- Helper method to reset a current crop, back to "no crop"
	*
		- :ref:`Lightness <doxcsid-interface_p1_1_1_camera_sdk_1_1_i_live_view_subscription_1a2b494634948fbf80facfceca2b20f9a9>`
		- An abstract value for exposure compensation

Methods
^^^^^^^

.. toctree::
	:hidden:

	Subscribe <function_P1_CameraSdk_ILiveViewSubscription_Subscribe.rst>
	ResetCrop <function_P1_CameraSdk_ILiveViewSubscription_ResetCrop.rst>
	SetWhiteBalancePoint <function_P1_CameraSdk_ILiveViewSubscription_SetWhiteBalancePoint.rst>

.. list-table::
	:widths: 33 67

	* 
		- :ref:`Subscribe(ImageFormat imageFormat) <doxcsid-interface_p1_1_1_camera_sdk_1_1_i_live_view_subscription_1a2b9cf10ef6a49cdea753cc78d631ca6c>`
		- Subscribe to LiveView in the desired format.
	* 
		- :ref:`ResetCrop() <doxcsid-interface_p1_1_1_camera_sdk_1_1_i_live_view_subscription_1a068c4e43b592231f1f921d9f7283bea2>`
		- Reset the crop (to no crop), showing the entire image in the LiveView
	* 
		- :ref:`SetWhiteBalancePoint(ValuePoint whitePoint) <doxcsid-interface_p1_1_1_camera_sdk_1_1_i_live_view_subscription_1adaffbf6b65580ed62995d83c5c8b581c>`
		- Set the *Custom C1* white balance, by the sampling a position in full image coordinates