class P1::CameraSdk::IPreviewSubscription

Overview

Subscribe / unsubscribe to preview transfers. More…

#include <C_P1CameraCommonSubscriptions.h>

class IPreviewSubscription: public P1::CameraSdk::ISubscription
{
public:
    // typedefs

    typedef std::vector<ImageFormat> SupportedFormats;

    // methods

    virtual void Subscribe(ImageFormat format) = 0;
    virtual void Subscribe() = 0;
    virtual SupportedFormats ImageFormatsSupported() const = 0;
    virtual ImageFormat Format() const = 0;
    virtual void SetFormat(ImageFormat format) = 0;
};

Inherited Members

public:
    // methods

    virtual bool IsSupported() const = 0;
    virtual bool IsSubscribed() const = 0;
    virtual void Subscribe() = 0;
    virtual void Unsubscribe() = 0;

Detailed Documentation

Subscribe / unsubscribe to preview transfers.

Subscribing to this tells the camera that we want to receive previews of newly captured images. The previews arrive via the notification EventType::CameraPreviewReady.

Version 3.0

See also:

ISubscriptionManager

Methods

virtual void Subscribe(ImageFormat format) = 0

Subscribe to previews in the desired format.

See ImageFormatsSupported for supported formats

virtual void Subscribe() = 0

Subscribe to previews using the format defined by Format.

See ImageFormatsSupported for supported formats for the camera

virtual SupportedFormats ImageFormatsSupported() const = 0

Formats supported for previews by the camera.

virtual ImageFormat Format() const = 0

Get current format in use.

virtual void SetFormat(ImageFormat format) = 0

Change the preview format.