.. index:: pair: class; P1::CameraSdk::IImageFileBasicInfo
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info:

class P1::CameraSdk::IImageFileBasicInfo
========================================

.. toctree::
	:hidden:

	enum_P1_CameraSdk_IImageFileBasicInfo_CompressionSetting.rst
	enum_P1_CameraSdk_IImageFileBasicInfo_OrientationModeSetting.rst
	enum_P1_CameraSdk_IImageFileBasicInfo_StarRating.rst
	enum_P1_CameraSdk_IImageFileBasicInfo_WhiteBalanceSetting.rst

Overview
~~~~~~~~

Interface that defines a basic set of properties for image files stored on the camera. :ref:`More...<details-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info>`


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

	#include <C_P1CameraCommonStructs.h>
	
	class IImageFileBasicInfo: public :ref:`P1::CameraSdk::IImageFileCommon<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_common>`
	{
	public:
		// enums
	
		enum :ref:`CompressionSetting<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1a1b4d85ed6b237ccd054835c1c9af7b40>`;
		enum :ref:`OrientationModeSetting<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1a591c5ae2c1762fe1b1f7ac1d1fbc1ed8>`;
		enum :ref:`StarRating<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1a5f32e22c34d1e4fb52ca16d6dfde40ed>`;
		enum :ref:`WhiteBalanceSetting<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1a5b5a7eb27c989a520979b9f45756ba4c>`;

		// methods
	
		virtual float :ref:`ApertureApex<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1ac43aa6786ecd10e7389f7824124299e0>`() const = 0;
		virtual float :ref:`ShutterSpeedApex<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1a76be5fc36ce85a5ce01bcce13415a18c>`() const = 0;
		virtual float :ref:`FocusPointX<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1ad012978632484fecefeaceb5adb6f36a>`() const = 0;
		virtual float :ref:`FocusPointY<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1a352460ce7aab55d3d7fc9727d9484157>`() const = 0;
		virtual float :ref:`FocalLengthMm<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1a64519c4887d38133b1bdef95b568495a>`() const = 0;
		virtual :ref:`WhiteBalanceSetting<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1a5b5a7eb27c989a520979b9f45756ba4c>` :ref:`WhiteBalance<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1abd290fc0d82976b9ff5badc03e866eee>`() const = 0;
		virtual :ref:`CompressionSetting<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1a1b4d85ed6b237ccd054835c1c9af7b40>` :ref:`IIQCompressionSetting<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1a746dfa23db875a3bcbf68ea6c8670de3>`() const = 0;
		virtual :ref:`OrientationModeSetting<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1a591c5ae2c1762fe1b1f7ac1d1fbc1ed8>` :ref:`Orientation<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1aa2a04a46354dcb350d20c8bbda57d72e>`() const = 0;
		virtual int32_t :ref:`ImagePixelWidth<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1af7cb925eeb18558809809a89f04c5f0e>`() const = 0;
		virtual int32_t :ref:`ImagePixelHeight<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1a22933d1cdb736c9e7ad57ca1dd696724>`() const = 0;
		virtual uint32_t :ref:`Iso<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1afff4c5e570feb22d75965ce8c0d41f0c>`() const = 0;
		virtual :ref:`StarRating<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1a5f32e22c34d1e4fb52ca16d6dfde40ed>` :ref:`Rating<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1a5d6b4a21bfe799539254b2594d5e83fc>`() const = 0;
		virtual uint32_t :ref:`UnixTimeStamp<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1a5a6c3204183e32127058d68e5c2dbe82>`() const = 0;
		virtual uint32_t :ref:`ImageByteSize<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1acb1f65df5b4bef637e9085a6e32c71a0>`() const = 0;
		virtual std::string :ref:`FileName<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1aa93ab594397b18ab27a48002ab3d4e07>`() const = 0;
		virtual std::string :ref:`ToString<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1a214ed5610653d5c086d3c67536b1443e>`() const = 0;
	};

	// direct descendants

	class :ref:`ImageFileBasicInfoImpl<doxid-class_p1_1_1_camera_sdk_1_1_image_file_basic_info_impl>`;

Inherited Members
-----------------

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

	public:
		// enums
	
		enum :ref:`Errors<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_common_1a5415589ad16ed744046e184d686d60ff>`;

		// methods
	
		virtual uint32_t :ref:`ImageId<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_common_1aa54da65815c373545187a60f0d1c1659>`() const = 0;
		virtual bool :ref:`AnyErrors<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_common_1a7a338a7fd5c4097e9035e7e7ebbf268b>`() const = 0;
		virtual :ref:`Errors<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_common_1a5415589ad16ed744046e184d686d60ff>` :ref:`ImageFileErrors<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_common_1ab55e830b1aeb244af2e27978100690d5>`() const = 0;
		virtual std::string :ref:`ErrorsString<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_common_1a3ed0f53f31808c058f0378bd66c25ce0>`() const = 0;

.. _details-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info:

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

Interface that defines a basic set of properties for image files stored on the camera.

This class (interface) defines a curated set of common image metadata, that can retrieved from files on the camera.

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



.. rubric:: See also:

P1::CameraSdk::Camera::BasicImageInfo

Methods
-------

.. index:: pair: function; ApertureApex
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1ac43aa6786ecd10e7389f7824124299e0:

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

	virtual float ApertureApex() const = 0

The Aperture of the capture, as Exif APEX value.

.. index:: pair: function; ShutterSpeedApex
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1a76be5fc36ce85a5ce01bcce13415a18c:

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

	virtual float ShutterSpeedApex() const = 0

The ShutterSpeedValue of the capture, as Exif APEX value.

.. index:: pair: function; FocusPointX
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1ad012978632484fecefeaceb5adb6f36a:

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

	virtual float FocusPointX() const = 0

The horizantal (X) coordinate of the AFr focus point. 0.0 to 1.0, left to right. (-1.0 means invalid)

.. index:: pair: function; FocusPointY
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1a352460ce7aab55d3d7fc9727d9484157:

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

	virtual float FocusPointY() const = 0

The vertical (Y) coordinate of the AFr focus point. 0.0 to 1.0, top to bottom. (-1.0 means invalid)

.. index:: pair: function; FocalLengthMm
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1a64519c4887d38133b1bdef95b568495a:

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

	virtual float FocalLengthMm() const = 0

The focal length in mm of the lens used in capture.

.. index:: pair: function; WhiteBalance
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1abd290fc0d82976b9ff5badc03e866eee:

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

	virtual :ref:`WhiteBalanceSetting<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1a5b5a7eb27c989a520979b9f45756ba4c>` WhiteBalance() const = 0

The cameras white balance setting during the capture.

.. index:: pair: function; IIQCompressionSetting
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1a746dfa23db875a3bcbf68ea6c8670de3:

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

	virtual :ref:`CompressionSetting<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1a1b4d85ed6b237ccd054835c1c9af7b40>` IIQCompressionSetting() const = 0

The compression format used in the capture's IIQ file.

.. index:: pair: function; Orientation
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1aa2a04a46354dcb350d20c8bbda57d72e:

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

	virtual :ref:`OrientationModeSetting<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1a591c5ae2c1762fe1b1f7ac1d1fbc1ed8>` Orientation() const = 0

The cameras orientation (is image rotated)

.. index:: pair: function; ImagePixelWidth
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1af7cb925eeb18558809809a89f04c5f0e:

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

	virtual int32_t ImagePixelWidth() const = 0

The valid width of the image in pixels. This is the width of the exposed sensor area.

.. index:: pair: function; ImagePixelHeight
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1a22933d1cdb736c9e7ad57ca1dd696724:

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

	virtual int32_t ImagePixelHeight() const = 0

The valid height of the image in pixels. This is the height of the exposed sensor area.

.. index:: pair: function; Iso
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1afff4c5e570feb22d75965ce8c0d41f0c:

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

	virtual uint32_t Iso() const = 0

The ISO value of the capture. (Sensor sensitivity.)

.. index:: pair: function; Rating
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1a5d6b4a21bfe799539254b2594d5e83fc:

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

	virtual :ref:`StarRating<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1a5f32e22c34d1e4fb52ca16d6dfde40ed>` Rating() const = 0

Users rating of the image (1-5 stars)

.. index:: pair: function; UnixTimeStamp
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1a5a6c3204183e32127058d68e5c2dbe82:

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

	virtual uint32_t UnixTimeStamp() const = 0

Get the time the capture was triggered, as a UNIX timestamp. (Seconds since epoch)

.. index:: pair: function; ImageByteSize
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1acb1f65df5b4bef637e9085a6e32c71a0:

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

	virtual uint32_t ImageByteSize() const = 0

Get the total size of the IIQ image file , in bytes.

.. index:: pair: function; FileName
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1aa93ab594397b18ab27a48002ab3d4e07:

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

	virtual std::string FileName() const = 0

Get the IIQ filename as it has been named on the cameras storages media.

.. index:: pair: function; ToString
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info_1a214ed5610653d5c086d3c67536b1443e:

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

	virtual std::string ToString() const = 0

Get all the information formatted as a string.