.. _doxcsid-interface_p1_1_1_camera_sdk_1_1_i_stored_image_handle:

IStoredImageHandle Interface
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Definition
^^^^^^^^^^

*Namespace:* ``P1.CameraSdk``

Lightweight representation of an image file in the camera :ref:`More...<csdetails-interface_p1_1_1_camera_sdk_1_1_i_stored_image_handle>`

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

	public interface IStoredImageHandle :  IDisposable


.. _csdetails-interface_p1_1_1_camera_sdk_1_1_i_stored_image_handle:

Remarks
^^^^^^^

Lightweight representation of an image file in the camera

This class is the interface to image files returned by the camera. It is lightweight and contains only a limited set of image metadata.It has no actual image bitmap data.

You use this *image item* 's *id* to query for extra info about an image or the fetch preview or tiles of the image.You can also request the entire IIQ file!



.. rubric:: See also:

:ref:`Camera.AllImages <doxcsid-class_p1_1_1_camera_sdk_1_1_camera_1acad4682871c159391d1b0c62a52c13f5>`, :ref:`INotificationEvent.StoredImageHandle <doxcsid-interface_p1_1_1_camera_sdk_1_1_i_notification_event_1a669091051f7ac207328cab72633d7929>`


Properties
^^^^^^^^^^

.. toctree::
	:hidden:

	Id <property_P1_CameraSdk_IStoredImageHandle_Id.rst>
	Date <property_P1_CameraSdk_IStoredImageHandle_Date.rst>
	Filename <property_P1_CameraSdk_IStoredImageHandle_Filename.rst>
	Device <property_P1_CameraSdk_IStoredImageHandle_Device.rst>

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

	*
		- :ref:`Id <doxcsid-interface_p1_1_1_camera_sdk_1_1_i_stored_image_handle_1a57ecdbba5d713941afe42c9288d44fef>`
		- Gets the *id* of this image. Can change after a camera reboot or a storage swap.
	*
		- :ref:`Date <doxcsid-interface_p1_1_1_camera_sdk_1_1_i_stored_image_handle_1a731d0fb70bb8f59aceb3d307f96dba0d>`
		- The capture date & time for this image. As a Unix Epoch timestamp.
	*
		- :ref:`Filename <doxcsid-interface_p1_1_1_camera_sdk_1_1_i_stored_image_handle_1ab12928c87f60f1ac8400dcd6d80bfd85>`
		- The filename of the image's IIQ file
	*
		- :ref:`Device <doxcsid-interface_p1_1_1_camera_sdk_1_1_i_stored_image_handle_1a421b75c4ab3f8f37cbca510b191b5106>`
		- A bitmask defining on what devices (XQS/SD), the image is stored.

Methods
^^^^^^^

.. toctree::
	:hidden:

	RequestBasicImageInfoAsync <function_P1_CameraSdk_IStoredImageHandle_RequestBasicImageInfoAsync.rst>
	BasicImageInfo <function_P1_CameraSdk_IStoredImageHandle_BasicImageInfo.rst>
	RequestImageAsync <function_P1_CameraSdk_IStoredImageHandle_RequestImageAsync.rst>
	RequestPreviewAsync <function_P1_CameraSdk_IStoredImageHandle_RequestPreviewAsync.rst>
	Preview <function_P1_CameraSdk_IStoredImageHandle_Preview.rst>
	RequestTileAsync <function_P1_CameraSdk_IStoredImageHandle_RequestTileAsync.rst>
	Tile <function_P1_CameraSdk_IStoredImageHandle_Tile.rst>
	DeleteImage <function_P1_CameraSdk_IStoredImageHandle_DeleteImage.rst>
	RateImage <function_P1_CameraSdk_IStoredImageHandle_RateImage.rst>

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

	* 
		- :ref:`RequestBasicImageInfoAsync() <doxcsid-interface_p1_1_1_camera_sdk_1_1_i_stored_image_handle_1aa777d52098547dd1ef87f7f9b768fe02>`
		- Requests a set of commonly used meta data about the image.
	* 
		- :ref:`BasicImageInfo(UInt32 timeoutMs=0) <doxcsid-interface_p1_1_1_camera_sdk_1_1_i_stored_image_handle_1a7c49ceacdb9d76cb780570fd8ca33f8e>`
		- A blocking (synchronous) version of :ref:`RequestBasicImageInfoAsync <doxcsid-interface_p1_1_1_camera_sdk_1_1_i_stored_image_handle_1aa777d52098547dd1ef87f7f9b768fe02>`
	* 
		- :ref:`RequestImageAsync() <doxcsid-interface_p1_1_1_camera_sdk_1_1_i_stored_image_handle_1a51ed368708558fc7b38c9867d2b082bb>`
		- Request a full IIQ file of the image
	* 
		- :ref:`RequestPreviewAsync(ImageFormat format=ImageFormat.RGB24) <doxcsid-interface_p1_1_1_camera_sdk_1_1_i_stored_image_handle_1a3e0b063cbfc935126303890b2cf93c40>`
		- Request the preview (thumbnail) for an image.
	* 
		- :ref:`Preview(ImageFormat format, UInt32 timeoutMs=0) <doxcsid-interface_p1_1_1_camera_sdk_1_1_i_stored_image_handle_1aa954cd2a20eebec4b32f0e6b0a355867>`
		- A blocking (synchronous) version of :ref:`RequestPreviewAsync <doxcsid-interface_p1_1_1_camera_sdk_1_1_i_stored_image_handle_1a3e0b063cbfc935126303890b2cf93c40>`.
	* 
		- :ref:`RequestTileAsync(TileRequest tileArguments) <doxcsid-interface_p1_1_1_camera_sdk_1_1_i_stored_image_handle_1a739c0e51c4c0ce198c7260871c51ac5a>`
		- Request a *tile* : a (scaled) crop of the full image
	* 
		- :ref:`Tile(TileRequest tileArguments, UInt32 timeoutMs=0) <doxcsid-interface_p1_1_1_camera_sdk_1_1_i_stored_image_handle_1a45f279d0c310ec96e4c59d395ecaeee4>`
		- A blocking (synchronous) version of :ref:`RequestTileAsync <doxcsid-interface_p1_1_1_camera_sdk_1_1_i_stored_image_handle_1a739c0e51c4c0ce198c7260871c51ac5a>`
	* 
		- :ref:`DeleteImage() <doxcsid-interface_p1_1_1_camera_sdk_1_1_i_stored_image_handle_1a7c4395a3b33aa07283a1b7756aaa40fe>`
		- Delete an image from the camera storage.
	* 
		- :ref:`RateImage(StarRating rating) <doxcsid-interface_p1_1_1_camera_sdk_1_1_i_stored_image_handle_1a8c9e0ee898f39e99c29bc8b1f0174a2f>`
		- Change the star-rating of an image.