class P1::CameraSdk::IPreview

Overview

Contains a preview of an image, as returned from the camera. More…

#include <C_P1CameraCommonStructs.h>

class IPreview:
    public P1::CameraSdk::IImageBufferFrame,
    public P1::CameraSdk::IImageFileCommon
{
};

// direct descendants

class PreviewImpl;

Inherited Members

public:
    // enums

    enum Type;
    enum Errors;

    // methods

    virtual std::shared_ptr<uint8_t const> Data() const = 0;
    virtual size_t DataSizeBytes() const = 0;
    virtual ImageFormat Format() const = 0;
    virtual Type BufferType() const = 0;
    virtual char const* BufferTypeStr() const = 0;
    virtual char const* FormatStr() const = 0;
    virtual uint32_t DestinationWidth() const = 0;
    virtual uint32_t DestinationHeight() const = 0;
    virtual uint32_t ImageId() const = 0;
    virtual bool AnyErrors() const = 0;
    virtual Errors ImageFileErrors() const = 0;
    virtual std::string ErrorsString() const = 0;

Detailed Documentation

Contains a preview of an image, as returned from the camera.

Either through subscriptions, or using image browsing you can get a preview (aka. thumbnail) of an image.

The camera normally creates a scaled RGB preview of the full image, right after the capturing process. When such previews are send the SDK host, they will come as implementations of this interface class.

Version 3.0