File ISpinnakerRelay.h¶

File List > include > Interface > ISpinnakerRelay.h
//=============================================================================
// Copyright (c) 2026 FLIR Integrated Imaging Solutions, Inc. All Rights Reserved.
//
// This software is the confidential and proprietary information of FLIR
// Integrated Imaging Solutions, Inc. ("Confidential Information"). You
// shall not disclose such Confidential Information and shall use it only in
// accordance with the terms of the license agreement you entered into
// with FLIR Integrated Imaging Solutions, Inc. (FLIR).
//
// FLIR MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF THE
// SOFTWARE, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
// PURPOSE, OR NON-INFRINGEMENT. FLIR SHALL NOT BE LIABLE FOR ANY DAMAGES
// SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING
// THIS SOFTWARE OR ITS DERIVATIVES.
//=============================================================================

#ifndef FLIR_SPINNAKER_ISPINNAKER_RELAY_H
#define FLIR_SPINNAKER_ISPINNAKER_RELAY_H

#include "SpinnakerPlatform.h"
#include "SpinnakerDefs.h"
#include "SpinnakerRelayDefs.h"

namespace Spinnaker
{
    class CameraPtr;
    class EventHandler;
    class ImagePtr;

    namespace Relay
    {
        class SPINNAKER_API ISpinnakerRelay
        {
          public:
            virtual ~ISpinnakerRelay(void){};
            virtual void SetConnectParameters(const ConnectParameters connectParam) = 0;
            virtual void SetNumBuffers(uint64_t numBuffers) = 0;
            virtual void AddSource(CameraPtr pCamera) = 0;
            virtual void RemoveSource(CameraPtr pCamera) = 0;
            virtual void Connect() = 0;
            virtual void Disconnect() = 0;
            virtual bool IsConnected() = 0;

            virtual void RegisterEventHandler(EventHandler& eventHandler) = 0;
            virtual void UnregisterEventHandler(EventHandler& eventHandler) = 0;
            virtual ImagePtr GetNextImage() = 0;
            virtual void GetStatistics(RelayStatistics* statistics) = 0;

          protected:
            struct SpinnakerRelayData; // Forward declaration
            SpinnakerRelayData* m_pSpinnakerRelayData;
            ISpinnakerRelay(){};
            ISpinnakerRelay(const ISpinnakerRelay&){};
            ISpinnakerRelay& operator=(const ISpinnakerRelay&);
        };

    } // namespace Relay
} // namespace Spinnaker

#endif // FLIR_SPINNAKER_ISPINNAKER_RELAY_H