class P1::CameraSdk::IImageFileBasicInfo

Overview

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

#include <C_P1CameraCommonStructs.h>

class IImageFileBasicInfo: public P1::CameraSdk::IImageFileCommon
{
public:
    // enums

    enum CompressionSetting;
    enum OrientationModeSetting;
    enum StarRating;
    enum WhiteBalanceSetting;

    // methods

    virtual float ApertureApex() const = 0;
    virtual float ShutterSpeedApex() const = 0;
    virtual float FocusPointX() const = 0;
    virtual float FocusPointY() const = 0;
    virtual float FocalLengthMm() const = 0;
    virtual WhiteBalanceSetting WhiteBalance() const = 0;
    virtual CompressionSetting IIQCompressionSetting() const = 0;
    virtual OrientationModeSetting Orientation() const = 0;
    virtual int32_t ImagePixelWidth() const = 0;
    virtual int32_t ImagePixelHeight() const = 0;
    virtual uint32_t Iso() const = 0;
    virtual StarRating Rating() const = 0;
    virtual uint32_t UnixTimeStamp() const = 0;
    virtual uint32_t ImageByteSize() const = 0;
    virtual std::string FileName() const = 0;
    virtual std::string ToString() const = 0;
};

// direct descendants

class ImageFileBasicInfoImpl;

Inherited Members

public:
    // enums

    enum Errors;

    // methods

    virtual uint32_t ImageId() const = 0;
    virtual bool AnyErrors() const = 0;
    virtual Errors ImageFileErrors() const = 0;
    virtual std::string ErrorsString() const = 0;

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.

Version 3.0

See also:

P1::CameraSdk::Camera::BasicImageInfo

Methods

virtual float ApertureApex() const = 0

The Aperture of the capture, as Exif APEX value.

virtual float ShutterSpeedApex() const = 0

The ShutterSpeedValue of the capture, as Exif APEX value.

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)

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)

virtual float FocalLengthMm() const = 0

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

virtual WhiteBalanceSetting WhiteBalance() const = 0

The cameras white balance setting during the capture.

virtual CompressionSetting IIQCompressionSetting() const = 0

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

virtual OrientationModeSetting Orientation() const = 0

The cameras orientation (is image rotated)

virtual int32_t ImagePixelWidth() const = 0

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

virtual int32_t ImagePixelHeight() const = 0

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

virtual uint32_t Iso() const = 0

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

virtual StarRating Rating() const = 0

Users rating of the image (1-5 stars)

virtual uint32_t UnixTimeStamp() const = 0

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

virtual uint32_t ImageByteSize() const = 0

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

virtual std::string FileName() const = 0

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

virtual std::string ToString() const = 0

Get all the information formatted as a string.