camera_sdk.idl

// camera_sdk.idl : IDL source for camera_sdk
//

// This file will be processed by the MIDL tool to
// produce the type library (camera_sdk.tlb) and marshalling code.

import "oaidl.idl";
import "ocidl.idl";

//====================================================================
typedef
[
    uuid(E7FAF7A2-1F7A-4DC9-9D29-31222B98AD99),
    version(1.0),

    helpstring("FrameTypeInfo structure")
]
struct FrameTypeInfo {
    [helpstring("Raw video format")] long format; 
    [helpstring("Width of the image")] long width; 
    [helpstring("Height of the image")] long height; 
    [helpstring("Frame rate of the continuous image stream")] long frame_rate; 
} FrameTypeInfo;
//====================================================================


[
    object,
    uuid(B76B3BD4-FAB0-4006-A97B-EF6878D6AE18),
    dual,
    nonextensible,
    pointer_default(unique)
]
interface ICamera : IDispatch{

    [id(1)] HRESULT EnumerateDevices([out] SAFEARRAY(VARIANT)* device_ids);
    
    [id(2), helpstring("method Open")] HRESULT Open([in] BSTR deviceID);
    
    [id(3), helpstring("method Close")] HRESULT Close();

    [id(4), helpstring("method SetVideoMode")]  HRESULT SetVideoMode([in] INT value);

    [id(5), helpstring("method GetVideoMode")]  HRESULT GetVideoMode([out] INT* value);

    [id(6), helpstring("method SetIlluminationMode")]  HRESULT SetIlluminationMode([in] INT value);

    [id(7), helpstring("method GetIlluminationMode")]  HRESULT GetIlluminationMode([out] INT* value);


    [id(8), helpstring("method SetFrameType")]  HRESULT SetFrameType([in] FrameTypeInfo* value);

    [id(9), helpstring("method GetSupportedFrameTypes")]  HRESULT GetSupportedFrameTypes([out] SAFEARRAY(FrameTypeInfo)* value);

    [id(10), helpstring("method GetBrightness")]  HRESULT GetBrightness([out] INT* value, [out] BOOL* isAutoEnabled);
    
    [id(11), helpstring("method SetBrightness")]  HRESULT SetBrightness([in] INT value, [in] BOOL isAutoEnabled);
    
    [id(12), helpstring("method GetBrightnessInfo")]  HRESULT GetBrightnessInfo([out] INT* min, [out] INT* max, [out] INT* defaultValue, [out] INT* step, [out] BOOL* isAutoSupported);

    [id(13), helpstring("method GetContrast")]  HRESULT GetContrast([out] INT* value, [out] BOOL* isAutoEnabled);
    
    [id(14), helpstring("method SetContrast")]  HRESULT SetContrast([in] INT value, [in] BOOL isAutoEnabled);
    
    [id(15), helpstring("method GetContrastInfo")]  HRESULT GetContrastInfo([out] INT* min, [out] INT* max, [out] INT* defaultValue, [out] INT* step, [out] BOOL* isAutoSupported);

    [id(16), helpstring("method GetSaturation")]  HRESULT GetSaturation([out] INT* value, [out] BOOL* isAutoEnabled);
    
    [id(17), helpstring("method SetSaturation")]  HRESULT SetSaturation([in] INT value, [in] BOOL isAutoEnabled);
    
    [id(18), helpstring("method GetSaturationInfo")]  HRESULT GetSaturationInfo([out] INT* min, [out] INT* max, [out] INT* defaultValue, [out] INT* step, [out] BOOL* isAutoSupported);

    [id(19), helpstring("method GetSharpness")]  HRESULT GetSharpness([out] INT* value, [out] BOOL* isAutoEnabled);
    
    [id(20), helpstring("method SetSharpness")]  HRESULT SetSharpness([in] INT value, [in] BOOL isAutoEnabled);
    
    [id(21), helpstring("method GetSharpnessInfo")]  HRESULT GetSharpnessInfo([out] INT* min, [out] INT* max, [out] INT* defaultValue, [out] INT* step, [out] BOOL* isAutoSupported);

    [id(22), helpstring("method GetGamma")]  HRESULT GetGamma([out] INT* value, [out] BOOL* isAutoEnabled);

    [id(23), helpstring("method SetGamma")]  HRESULT SetGamma([in] INT value, [in] BOOL isAutoEnabled);

    [id(24), helpstring("method GetGammaInfo")]  HRESULT GetGammaInfo([out] INT* min, [out] INT* max, [out] INT* defaultValue, [out] INT* step, [out] BOOL* isAutoSupported);

    [id(25), helpstring("method GetBacklight")]  HRESULT GetBacklight([out] INT* value, [out] BOOL* isAutoEnabled);
    
    [id(26), helpstring("method SetBacklight")]  HRESULT SetBacklight([in] INT value, [in] BOOL isAutoEnabled);
    
    [id(27), helpstring("method GetBacklightInfo")]  HRESULT GetBacklightInfo([out] INT* min, [out] INT* max, [out] INT* defaultValue, [out] INT* step, [out] BOOL* isAutoSupported);

    [id(28), helpstring("method GetGain")]  HRESULT GetGain([out] INT* value, [out] BOOL* isAutoEnabled);
    
    [id(29), helpstring("method SetGain")]  HRESULT SetGain([in] INT value, [in] BOOL isAutoEnabled);
    
    [id(30), helpstring("method GetGainInfo")]  HRESULT GetGainInfo([out] INT* min, [out] INT* max, [out] INT* defaultValue, [out] INT* step, [out] BOOL* isAutoSupported);

    [id(31), helpstring("method GetExposure")]  HRESULT GetExposure([out] INT* value, [out] BOOL* isAutoEnabled);
    
    [id(32), helpstring("method SetExposure")]  HRESULT SetExposure([in] INT value, [in] BOOL isAutoEnabled);
    
    [id(33), helpstring("method GetExposureInfo")]  HRESULT GetExposureInfo([out] INT* min, [out] INT* max, [out] INT* defaultValue, [out] INT* step, [out] BOOL* isAutoSupported);

    [id(34), helpstring("method GetWhiteBalance")]  HRESULT GetWhiteBalance([out] INT* value, [out] BOOL* isAutoEnabled);
    
    [id(35), helpstring("method SetWhiteBalance")]  HRESULT SetWhiteBalance([in] INT value, [in] BOOL isAutoEnabled);
    
    [id(36), helpstring("method GetWhiteBalanceInfo")]  HRESULT GetWhiteBalanceInfo([out] INT* min, [out] INT* max, [out] INT* defaultValue, [out] INT* step, [out] BOOL* isAutoSupported);

    [id(37), helpstring("method CancelFirmwareDownload")] HRESULT CancelFirmwareDownload();
    
    [id(38), helpstring("method GetCurrentFrameType)")]  HRESULT GetCurrentFrameType([out] FrameTypeInfo* value);

    [id(40), helpstring("method SetImageType)")]  HRESULT SetImageType([in] INT imageStreamType);

    [id(41), helpstring("method GetImageType)")]  HRESULT GetImageType([out] INT* imageStreamType);

    [id(42), helpstring("method RebootCamera)")]  HRESULT RebootCamera([in] INT timeout);

    [id(43), helpstring("method SetDefaults)")]  HRESULT SetDefaults();

    [id(45), helpstring("method WriteToFlash)")]  HRESULT WriteToFlash();

    [id(46), helpstring("method CaptureSnapshot)")]  HRESULT CaptureSnapshot([in, out] SAFEARRAY(BYTE)* imageBuffer, [out] LONG* length, [out] LONG* width, [out] LONG* height, [out] LONG* imageType);


    [id(47), helpstring("method RegisterForContinuousImageEvent)")]  HRESULT RegisterForContinuousImageEvent([in] BOOL bReg);
    
    [id(48), helpstring("method RegisterForSnapshotImageEvent)")]  HRESULT RegisterForSnapshotImageEvent([in] BOOL bReg);
    
    [id(49), helpstring("method RegisterForProduceImageEvent)")]  HRESULT RegisterForProduceImageEvent([in] BOOL bReg);

    [id(50), helpstring("method RegisterForDecodeImageEvent)")]  HRESULT RegisterForDecodeImageEvent([in] BOOL bReg);
    
    [id(51), helpstring("method RegisterForDecodeSessionStatusChangeEvent)")]  HRESULT RegisterForDecodeSessionStatusChangeEvent([in] BOOL bReg);

    // Properties ----------------------------------------------------------------------------

    [propget, id(52), helpstring("property SerialNumber")] HRESULT SerialNumber([out, retval] BSTR* pVal);
    
    [propget, id(53), helpstring("property ModelNumber")] HRESULT ModelNumber([out, retval] BSTR* pVal);
    
    [propget, id(54), helpstring("property DateOfManufacture")] HRESULT DateOfManufacture([out, retval] BSTR* pVal);
    
    [propget, id(55), helpstring("property DateOfService")] HRESULT DateOfService([out, retval] BSTR* pVal);
    
    [propget, id(56), helpstring("property DateOfFirstProgram")] HRESULT DateOfFirstProgram([out, retval] BSTR* pVal);
    

    [propget, id(57), helpstring("property FirmwareVersion")] HRESULT FirmwareVersion([out, retval] BSTR* pVal);


    [propget, id(58), helpstring("property HardwareVersion")] HRESULT HardwareVersion([out, retval] BSTR* pVal);

    [propget, id(59), helpstring("property last_error")] HRESULT LastError([out, retval] BSTR* pVal);

    [id(60), helpstring("method DownloadFirmware)")]  HRESULT DownloadFirmware([in] BSTR val);

    [id(61), helpstring("method InstallFirmware)")]  HRESULT InstallFirmware();

    [id(62), helpstring("method RegisterForFirmwareDownloadProgressEvents)")]  HRESULT RegisterForFirmwareDownloadProgressEvents([in] BOOL bReg);

    [id(63), helpstring("method GetPowerUserMode")]  HRESULT GetPowerUserMode([out] INT* value);

    [id(64), helpstring("method SetPowerUserMode")]  HRESULT SetPowerUserMode([in] INT value);

    [id(65), helpstring("method LoadConfiguration")] HRESULT LoadConfiguration([in] BSTR configuration_xml);

    [id(66), helpstring("method LoadConfigurationFromFile")] HRESULT LoadConfigurationFromFile([in] BSTR configuration_file_path);

    [id(67), helpstring("method RetrieveConfiguration")] HRESULT RetrieveConfiguration([out] BSTR* configuration_xml);

    [id(68), helpstring("method RetrieveConfigurationToFile")] HRESULT RetrieveConfigurationToFile([in] BSTR configuration_file_path);

    [id(69), helpstring("method GetVersion")] HRESULT GetVersion([out] INT* version_major, [out] INT* version_minor, [out] INT* version_patch, [out] INT* version_build);

    

};
[
    uuid(A5E7F904-D85D-4D3E-A032-98243268B0F4),
    helpstring("Bioptic Color Camera 1.0 Type Library"),
    version(1.0),
]
library BiopticColorCamera
{
    importlib("stdole2.tlb");
    [
        uuid(96C73DAA-525C-44B2-BBB9-3E273980690A)      
    ]
    dispinterface _ICameraEvents
    {
        properties:
        methods:
        
            [id(1), helpstring("method OnContinuousImageEvent")] HRESULT OnContinuousImageEvent([in,out] VARIANT* imageBuffer, LONG length, LONG width, LONG height, LONG imageType);
            
            [id(2), helpstring("method OnSnapshotImageEvent")] HRESULT OnSnapshotImageEvent([in] VARIANT* imageBuffer, LONG length, LONG width, LONG height, LONG imageType);
            
            [id(3), helpstring("method OnProduceImageEvent")] HRESULT OnProduceImageEvent([in] VARIANT* imageBuffer, LONG length, LONG width, LONG height, LONG imageType);

            [id(6), helpstring("method OnDecodeImageEvent")] HRESULT OnDecodeImageEvent([in] VARIANT* imageBuffer, LONG length, LONG width, LONG height, LONG imageType, BSTR decodeData);
            
            [id(8), helpstring("method OnDecodeSessionStatusChangeEvent")] HRESULT OnDecodeSessionStatusChangeEvent(INT session_status);

            [id(4), helpstring("method OnDeviceAddedEvent")] HRESULT OnDeviceAddedEvent(BSTR deviceID);

            [id(5), helpstring("method OnDeviceRemovedEvent")] HRESULT OnDeviceRemovedEvent(BSTR deviceID);
                        
            [id(7), helpstring("method OnFirmwareDownloadProgressEvent")] HRESULT OnFirmwareDownloadProgressEvent(BSTR serial, BSTR model, LONG total_records, LONG current_record, LONG operation_code, LONG status);

    };
    [
        uuid(85FC1DF1-D1CC-4290-934C-07D72ED5B740)      
    ]
    coclass Camera
    {
        [default] interface ICamera;
        [default, source] dispinterface _ICameraEvents;
    };
};