pnp.h

Go to the documentation of this file.

/* SPDX-License-Identifier: MIT */
#ifndef AJA_PNP_H
#define AJA_PNP_H
 
#include "ajabase/common/public.h"
 
 
typedef enum 
{
    AJA_Pnp_PciVideoDevices     = (1 << 0),
    AJA_Pnp_UsbSerialDevices    = (1 << 1),
    AJA_Pnp_FireWireDevices     = (1 << 2)
} AJAPnpDevice;
 
 
typedef enum 
{
    AJA_Pnp_DeviceAdded,
    AJA_Pnp_DeviceRemoved,
    AJA_Pnp_DeviceOnline,
    AJA_Pnp_DeviceOffline,
    AJA_Pnp_DeviceGoingToSleep,
    AJA_Pnp_DeviceWakingUp
} AJAPnpMessage;
 
 
typedef void (*AJAPnpCallback)(AJAPnpMessage inMessage, void * inRefCon);
 
 
// forward declarations.
class AJAPnpImpl;
 
class AJA_EXPORT AJAPnp
{
public: //  CLASS METHODS
 
    static std::string MessageToString (const AJAPnpMessage inMsg);
 
public: //  INSTANCE METHODS
 
    AJAPnp();
 
    virtual ~AJAPnp();
 
    virtual AJAStatus Install (AJAPnpCallback pInCallback, void * inRefCon = NULL, uint32_t inDeviceMask = 0xFFFFFFFF);
 
    virtual AJAPnpCallback GetCallback() const;
 
    virtual AJAStatus Uninstall();
 
    virtual void* GetRefCon() const;
 
    virtual uint32_t GetPnpDevices() const;
 
 
private:    //  INSTANCE METHODS
    AJAPnp (const AJAPnp & inObjToCopy);
 
 
    virtual AJAPnp &    operator= (const AJAPnp & inObjToCopy);
 
 
private:    //  INSTANCE DATA
    AJAPnpImpl *    mpImpl;     
 
};  //  AJAPnp
 
#endif  //  AJA_PNP_H