Mac Dev Center Mac OS X Reference Library Graphics & Animation Image Capture Applications Reference

Overview

ICAApplication.h defines structures and functions that are used by clients of Image Capture framework.

Functions

ICACloseSession

Use this API to close a session on a camera device. For a scanner device use the ICAScannerCloseSession API.

ICACopyObjectData

Use this API to get a copy of data associated with a file object.

ICACopyObjectPropertyDictionary

Use this API to get a CFDictionaryRef containing all the properties for an object specified in the object field of the ICACopyObjectPropertyDictionaryPB struct.

ICACopyObjectThumbnail

Use this API to get a thumbnail associated with an object.

ICADownloadFile

Use this API to download a file to disk.

ICAGetDeviceList

Fetches the object at the top of the object heirarchy.

ICAImportImage

This API displays a Common User Interface panel similar to the user interface of Image Capture Application. This allows the user to work a camera or a scanner.

ICALoadDeviceModule

Use this API to load a device module.

ICAObjectSendMessage

Use this API to send a message to a device object.

ICAOpenSession

Use this API to open a session on a camera device. For a scanner device use the ICAScannerOpenSession API.

ICARegisterForEventNotification

Use this API to register with Image Capture framework to receive notification about events of interest.

ICAScannerCloseSession

Use this API to close a session on a scanner device. For a camera device use the ICACloseSession API.

ICAScannerGetParameters

Use this API to get information about the scanner such as resolution, scanning area, etc.

ICAScannerInitialize

Use this API to initialize a scanner device.

ICAScannerOpenSession

Use this API to open a session on a scanner device. For a camera device use the ICAOpenSession API.

ICAScannerSetParameters

Use this API to specify scan parameters that will be used when a scan is initiated via an ICAScannerStart.

ICAScannerStart

Use this API start a scan based on the parameters that were specified in a previous ICAScannerSetParameters call.

ICAScannerStatus

Use this API to get information about the current status of the scanner.

ICAShowDeviceBrowser

Use this API to display a device browser user interface from any Image Capture client application.

ICAUnloadDeviceModule

Uset this API to unload a device module.

ICAUploadFile

Use this API to upload a file to a device that supports this capability.

Use this API to close a session on a camera device. For a scanner device use the ICAScannerCloseSession API.

extern ICAError ICACloseSession( 
    ICACloseSessionPB *pb, 
    ICACompletion completion );  

Parameters

Return Value

Returns an error code defined in ICAApplication.h

Discussion

This API closes an open session on a camera device. If the camera does not have any open sessions, the device module controlling the camera is free to give it up during fast-user-switching.

Availability

Introduced in Mac OS X v10.4.

Use this API to get a copy of data associated with a file object.

extern ICAError ICACopyObjectData( 
    ICACopyObjectDataPB *params, 
    ICACompletion completionProc );  

Parameters

Return Value

Returns an error code defined in ICAApplication.h

Discussion

Use this API to get a copy of data associated with a file object. This API should be used in place of ICAGetPropertyData.

Availability

Introduced in Mac OS X v10.5.

Use this API to get a CFDictionaryRef containing all the properties for an object specified in the object field of the ICACopyObjectPropertyDictionaryPB struct.

extern ICAError ICACopyObjectPropertyDictionary( 
    ICACopyObjectPropertyDictionaryPB *pb, 
    ICACompletion completion );  

Parameters

Return Value

Returns an error code defined in ICAApplication.h

Discussion

This API is the preferred way to get to any ICAObject related property data.

        Example:
        
        void  CopyObjectPropertyDictionary()
        {
            OSErr                             err;
            ICACopyObjectPropertyDictionaryPB pb = {};

            pb.object = <#ICAObject object#>;
            err = ICACopyObjectPropertyDictionary( &pb, NULL );

            if ( noErr != err)
            {
                // handle error
            }
            else
            {
                // Make sure to release the returned dictionary
                // pb.theDict   // CFDictionaryRef *
            }
        }
        

Availability

Introduced in Mac OS X v10.1.

Use this API to get a thumbnail associated with an object.

extern ICAError ICACopyObjectThumbnail( 
    ICACopyObjectThumbnailPB *pb, 
    ICACompletion completion );  

Parameters

Return Value

Returns an error code defined in ICAApplication.h

Discussion

This is the recommended way to get the thumbnail of an object. Getting the thumbnail using ICAGetPropertyData is deprecaed in 10.5.

        Example:
        
        void CopyObjectThumbnail()
        {
            OSErr                     err;
            ICACopyObjectThumbnailPB  pb = {};

            pb.object          = <#ICAObject object#>;
            pb.thumbnailFormat = <#OSType thumbnailFormat#>;
            
            err = ICACopyObjectThumbnail( &pb, NULL );

            if ( noErr != err )
            {
                // handle error
            }
            else
            {
                // Make sure to release the thumbnailData
                // pb.thumbnailData   // CFDataRef *
            }
        }

Availability

Introduced in Mac OS X v10.3.

Use this API to download a file to disk.

extern ICAError ICADownloadFile( 
    ICADownloadFilePB *pb, 
    ICACompletion completion );  

Parameters

Return Value

Returns an error code defined in ICAApplication.h

Discussion

This API is a convenient way to download a file to disk. To receive the image data in memory use ICACopyObjectData. Using ICAGetPropertyData is not recommend for this purpose since ICAGetPropertyData is Deprecated in 10.5.

        Example:
        
        void DownloadFile()
        {
            OSErr             err;
            ICADownloadFilePB pb = {};

            pb.flags         = <#UInt32 flags#>;
            pb.rotationAngle = <#Fixed rotationAngle#>;
            pb.object        = <#ICAObject object#>;
            pb.fileCreator   = <#OSType fileCreator#>;
            pb.dirFSRef      = <#FSRef * dirFSRef#>;
            pb.fileType      = <#OSType fileType#>;
            
            err = ICADownloadFile( &pb, NULL );

            if ( noErr != err )
            {
                // handle error
            }
            else
            {
                // pb.fileFSRef   // FSRef *
            }
        }

Availability

Introduced in Mac OS X v10.1.

Fetches the object at the top of the object heirarchy.

extern ICAError ICAGetDeviceList( 
    ICAGetDeviceListPB *pb, 
    ICACompletion completion );  

Parameters

Return Value

Returns an error code defined in ICAApplication.h

Discussion

Image Capture framework presents cameras and scanners, their contents and their capabilities as a heirarchy of objects and their properties. The device list object is at the top of the heirarchy of objects. The ICAGetDeviceList function fetches this object in the object field of parameter pb. Children of the device list object can be accessed by passing the device list object to functions ICAGetChildCount() and ICAGetNthChild().

        Example:
        
        ICAObject GetDeviceList()
        {
            ICAGetDeviceListPB getDeviceListPB  = {};
            ICAObject          deviceList       = 0;
            OSErr              err;
            
            err = ICAGetDeviceList( &getDeviceListPB, nil );
            
            if ( noErr == err )
            {
                deviceList = getDeviceListPB.object;
            }
            
            return deviceList;
        }

Availability

Introduced in Mac OS X v10.0.

This API displays a Common User Interface panel similar to the user interface of Image Capture Application. This allows the user to work a camera or a scanner.

extern ICAError ICAImportImage( 
    ICAImportImagePB *pb, 
    ICACompletion completion );  

Parameters

Return Value

Returns an error code defined in ICAApplication.h

Discussion

Use this API to add Image Capture support to an application.

        Example:
        
        void ImportImage()
        {
            OSErr             err;
            CFArrayRef        imagesArray = NULL;
            ICAImportImagePB  pb = {};

            pb.deviceObject       = 0;
            pb.flags              = 0;
            pb.supportedFileTypes = (CFArrayRef)[NSArray arrayWithObjects: @"tif", @"tiff", @"jpg", NULL];
            pb.importedImages     = &imagesArray;
            
            err = ICAImportImage(&pb, NULL);

            if ( noErr != err )
            {
                // handle error
            }
            else
            {
                // Process the importedImages array
                // pb.importedImages   // CFArrayRef *
            }
        }

Availability

Introduced in Mac OS X v10.3.

Use this API to load a device module.

extern ICAError ICALoadDeviceModule( 
    ICALoadDeviceModulePB *pb, 
    ICACompletion completion );  

Parameters

Return Value

Returns an error code defined in ICAApplication.h

Discussion

Typically, connecting a FireWire or an USB device will automatically load an appropriate device module. This API is needed only for loading a device module manually for devices that do not use a hot-plug interface, such as Bluetooth, SCSI, or TCP/IP.

Availability

Introduced in Mac OS X v10.4.

Use this API to send a message to a device object.

extern ICAError ICAObjectSendMessage( 
    ICAObjectSendMessagePB *pb, 
    ICACompletion completion );  

Parameters

Return Value

Returns an error code defined in ICAApplication.h

Discussion

Use this API to send a message to a device object. All devices do not respond to all the messages defined above.

Availability

Introduced in Mac OS X v10.0.

Use this API to open a session on a camera device. For a scanner device use the ICAScannerOpenSession API.

extern ICAError ICAOpenSession( 
    ICAOpenSessionPB *pb, 
    ICACompletion completion );  

Parameters

Return Value

Returns an error code defined in ICAApplication.h

Discussion

This API gets a session ID for a open session on a camera device. Since access to cameras is generally not be session-based, this API generall will not fail. If the camera has open session, the device module controlling the camera will continue to control it during fast-user-switching.

Availability

Introduced in Mac OS X v10.4.

Use this API to register with Image Capture framework to receive notification about events of interest.

extern ICAError ICARegisterForEventNotification( 
    ICARegisterForEventNotificationPB *params, 
    ICACompletion completionProc );  

Parameters

Return Value

Returns an error code defined in ICAApplication.h

Availability

Introduced in Mac OS X v10.5.

Use this API to close a session on a scanner device. For a camera device use the ICACloseSession API.

extern ICAError ICAScannerCloseSession( 
    ICAScannerCloseSessionPB *pb, 
    ICACompletion completion );  

Parameters

Return Value

Returns an error code defined in ICAApplication.h

Discussion

This API closes an open session, allowing other clients to work with the scanner.

Availability

Introduced in Mac OS X v10.2

Use this API to get information about the scanner such as resolution, scanning area, etc.

extern ICAError ICAScannerGetParameters( 
    ICAScannerGetParametersPB *pb, 
    ICACompletion completion );  

Parameters

Return Value

Returns an error code defined in ICAApplication.h

Discussion

Use this API to get information about the scanner such as resolution, scanning area, etc.

Availability

Introduced in Mac OS X v10.2

Use this API to initialize a scanner device.

extern ICAError ICAScannerInitialize( 
    ICAScannerInitializePB *pb, 
    ICACompletion completion );  

Parameters

Return Value

Returns an error code defined in ICAApplication.h

Discussion

After opening a session on a scanner device, use this API to set an initial state for the scanner.

Availability

Introduced in Mac OS X v10.2

Use this API to open a session on a scanner device. For a camera device use the ICAOpenSession API.

extern ICAError ICAScannerOpenSession( 
    ICAScannerOpenSessionPB *pb, 
    ICACompletion completion );  

Parameters

Return Value

Returns an error code defined in ICAApplication.h

Discussion

For a given scanner, this API returns a unique session ID that allows you to work with the device. This API will fail, if a session is already open.

Availability

Introduced in Mac OS X v10.2

Use this API to specify scan parameters that will be used when a scan is initiated via an ICAScannerStart.

extern ICAError ICAScannerSetParameters( 
    ICAScannerSetParametersPB *pb, 
    ICACompletion completion );  

Parameters

Return Value

Returns an error code defined in ICAApplication.h

Discussion

Use this API to specify scan parameters that will be used when a scan is initiated via an ICAScannerStart.

Availability

Introduced in Mac OS X v10.2

Use this API start a scan based on the parameters that were specified in a previous ICAScannerSetParameters call.

extern ICAError ICAScannerStart( 
    ICAScannerStartPB *pb, 
    ICACompletion completion );  

Parameters

Return Value

Returns an error code defined in ICAApplication.h

Discussion

Use this API start a scan based on the parameters that were specified in a previous ICAScannerSetParameters call.

Availability

Introduced in Mac OS X v10.2

Use this API to get information about the current status of the scanner.

extern ICAError ICAScannerStatus( 
    ICAScannerStatusPB *pb, 
    ICACompletion completion );  

Parameters

Return Value

Returns an error code defined in ICAApplication.h

Discussion

Use this API to get information about the current status of the scanner.

Availability

Introduced in Mac OS X v10.2

Use this API to display a device browser user interface from any Image Capture client application.

extern ICAError ICAShowDeviceBrowser( 
    CFDictionaryRef options );  

Parameters

Return Value

Returns an error code defined in ICAApplication.h

Discussion

The device browser user interface allows the user to do the following: - enable and disable sharing of locally connected cameras and scanners. - connect to or disconnect from cameras and scanners shared by other computers. - configure WiFi capable cameras for use over the WiFi network.

Availability

Introduced in Mac OS X v10.5.

Uset this API to unload a device module.

extern ICAError ICAUnloadDeviceModule( 
    ICAUnloadDeviceModulePB *pb, 
    ICACompletion completion );  

Parameters

Return Value

Returns an error code defined in ICAApplication.h

Discussion

The device module providing this object will be unloaded, if this is the last device object provided by the device module.

Availability

Introduced in Mac OS X v10.4.

Use this API to upload a file to a device that supports this capability.

extern ICAError ICAUploadFile( 
    ICAUploadFilePB *pb, 
    ICACompletion completion );  

Parameters

Return Value

Returns an error code defined in ICAApplication.h

Discussion

The device choses an appropriate destination location for the uploaded image and sends a kICANotificationTypeObjectAdded notification.

        Example:
        
        void  UploadFile()
        {
            OSErr           err;
            ICAUploadFilePB pb = {};

            pb.fileFSRef    = <#FSRef * fileFSRef#>;
            pb.flags        = <#UInt32 flags#>;
            pb.parentObject = <#ICAObject parentObject#>;
            
            err = ICAUploadFile( &pb, NULL );

            if ( noErr != err )
            {
                // handle error
            }
            else
            {
                // no return value(s)
            }
        }

Availability

Introduced in Mac OS X v10.4.

Constants

kICAUserAssignedDeviceNameKey

This key may be present in the property dictionary of a device if the device has a user-assigned name.

This key may be present in the property dictionary of a device if the device has a user-assigned name.

extern const CFStringRef kICAUserAssignedDeviceNameKey;  

Discussion

Value is of type CFStringRef.

Availability

Introduced in Mac OS X v10.5.

Typedefs

ICACloseSessionPB

ICACopyObjectDataPB

ICACopyObjectPropertyDictionaryPB

ICACopyObjectThumbnailPB

ICADownloadFilePB

ICAGetDeviceListPB

ICAHeader

ICAImportImagePB

ICALoadDeviceModulePB

ICAMessage

ICAObjectInfo

ICAObjectSendMessagePB

ICAOpenSessionPB

ICAPTPEventDataset

ICAPTPPassThroughPB

ICARegisterForEventNotificationPB

ICAScannerCloseSessionPB

ICAScannerGetParametersPB

ICAScannerInitializePB

ICAScannerOpenSessionPB

ICAScannerSetParametersPB

ICAScannerStartPB

ICAScannerStatusPB

ICAUnloadDeviceModulePB

ICAUploadFilePB

typedef struct ICACloseSessionPB { 
    ICAHeader header; 
    ICASessionID sessionID; 
} ICACloseSessionPB;  

Fields

typedef struct ICACopyObjectDataPB { 
    ICAHeader header; 
    ICAObject object; 
    size_t startByte; 
    size_t requestedSize; 
    CFDataRef *data; 
} ICACopyObjectDataPB;  

Fields

typedef struct ICACopyObjectPropertyDictionaryPB { 
    ICAHeader header; 
    ICAObject object; 
    CFDictionaryRef *theDict; 
} ICACopyObjectPropertyDictionaryPB;  

Fields

typedef struct ICACopyObjectThumbnailPB { 
    ICAHeader header; 
    ICAObject object; 
    OSType thumbnailFormat; 
    CFDataRef *thumbnailData; 
} ICACopyObjectThumbnailPB;  

Fields

typedef struct ICADownloadFilePB { 
    ICAHeader header; 
    ICAObject object; 
    FSRef *dirFSRef; 
    UInt32 flags; 
    OSType fileType; 
    OSType fileCreator; 
    Fixed rotationAngle; 
    FSRef *fileFSRef; 
} ICADownloadFilePB;  

Fields

typedef struct ICAGetDeviceListPB { 
    ICAHeader header; 
    ICAObject object; 
} ICAGetDeviceListPB;  

Fields

typedef struct ICAHeader { 
    ICAError err; 
    unsigned long refcon; 
} ICAHeader;  

Fields

Discussion

This is the first field in all parameter blocks used by APIs defined in ICAApplication.h. Type of parameter passed to a callback function used by APIs defined in ICAApplication.h. The parameter for the completion proc should to be casted to an appropriate type such as ICAGetChildCountPB* for it to be useful.

typedef struct ICAImportImagePB { 
    ICAHeader header; 
    ICAObject deviceObject; 
    UInt32 flags; 
    CFArrayRef supportedFileTypes; 
    ICAImportFilterProc filterProc; 
    CFArrayRef *importedImages; 
} ICAImportImagePB;  

Fields

typedef struct ICALoadDeviceModulePB { 
    ICAHeader header; 
    CFDictionaryRef paramDictionary; 
} ICALoadDeviceModulePB;  

Fields

typedef struct ICAMessage { 
    OSType messageType; 
    UInt32 startByte; 
    void *dataPtr; 
    UInt32 dataSize; 
    OSType dataType; 
} ICAMessage;  

Fields

typedef struct ICAObjectInfo { 
    OSType objectType; 
    OSType objectSubtype; 
} ICAObjectInfo;  

Fields

typedef struct ICAObjectSendMessagePB { 
    ICAHeader header; 
    ICAObject object; 
    ICAMessage message; 
    UInt32 result; 
} ICAObjectSendMessagePB;  

Fields

typedef struct ICAOpenSessionPB { 
    ICAHeader header; 
    ICAObject deviceObject; 
    ICASessionID sessionID; 
} ICAOpenSessionPB;  

Fields

typedef struct ICAPTPEventDataset { 
    UInt32 dataLength; 
    UInt16 containerType; // should be 0x0004 for event 
    UInt16 eventCode; 
    UInt32 transactionID; 
    UInt32 params[3]; // up to 3 params. # of params = (dataLength - 12)/4 
} ICAPTPEventDataset;  

Fields

typedef struct ICAPTPPassThroughPB { 
    UInt32 commandCode; 
    UInt32 resultCode; 
    UInt32 numOfInputParams; 
    UInt32 numOfOutputParams; 
    UInt32 params[4]; 
    UInt32 dataUsageMode; 
    UInt32 flags; 
    UInt32 dataSize; 
    UInt8 data[1]; 
} ICAPTPPassThroughPB;  

Fields

typedef struct ICARegisterForEventNotificationPB { 
    ICAHeader header; 
    ICAObject objectOfInterest; 
    CFArrayRef eventsOfInterest; 
    ICANotification notificationProc; 
    CFDictionaryRef options; 
} ICARegisterForEventNotificationPB;  

Fields

Discussion

Use this parameter structure to specify a set of events associated with an object about which notifications should be sent to the specified notification function.

typedef struct ICAScannerCloseSessionPB { 
    ICAHeader header; 
    ICAScannerSessionID sessionID; 
} ICAScannerCloseSessionPB;  

Fields

typedef struct ICAScannerGetParametersPB { 
    ICAHeader header; 
    ICAScannerSessionID sessionID; 
    CFMutableDictionaryRef theDict; 
} ICAScannerGetParametersPB;  

Fields

typedef struct ICAScannerInitializePB { 
    ICAHeader header; 
    ICAScannerSessionID sessionID; 
} ICAScannerInitializePB;  

Fields

typedef struct ICAScannerOpenSessionPB { 
    ICAHeader header; 
    ICAObject object; 
    ICAScannerSessionID sessionID; 
} ICAScannerOpenSessionPB;  

Fields

typedef struct ICAScannerSetParametersPB { 
    ICAHeader header; 
    ICAScannerSessionID sessionID; 
    CFMutableDictionaryRef theDict; 
} ICAScannerSetParametersPB;  

Fields

typedef struct ICAScannerStartPB { 
    ICAHeader header; 
    ICAScannerSessionID sessionID; 
} ICAScannerStartPB;  

Fields

typedef struct ICAScannerStatusPB { 
    ICAHeader header; 
    ICAScannerSessionID sessionID; 
    UInt32 status; 
} ICAScannerStatusPB;  

Fields

typedef struct ICAUnloadDeviceModulePB { 
    ICAHeader header; 
    ICAObject deviceObject; 
} ICAUnloadDeviceModulePB;  

Fields

typedef struct ICAUploadFilePB { 
    ICAHeader header; 
    ICAObject parentObject; 
    FSRef *fileFSRef; 
    UInt32 flags; 
} ICAUploadFilePB;  

Fields

Enumerated Types

Button types

Data types

Error codes

Flag to use with ICADownloadFile

Flags associated with Image Capture PassThru commands.

ICAMessage types

ICAObject types and subtypes

ICAProperty types

ImportImage flags.

Parameter block version

PropertyInfo flag values

Thumbnail formats.

Upload file option flags.

enum { 
    kICAButtonScan = 'scan', 
    kICAButtonCopy = 'copy', 
    kICAButtonEMail = 'mail', 
    kICAButtonWeb = 'web ' 
};  

Constants

Discussion

Buttons types associated with buttons on a scanner.

enum { 
    kICATypeUInt8 = 'ui08', 
    kICATypeUInt16 = 'ui16', 
    kICATypeUInt32 = 'ui32', 
    kICATypeUInt64 = 'ui64', 
    kICATypeSInt16 = 'si16', 
    kICATypeSInt32 = 'si32', 
    kICATypeSInt64 = 'si64', 
    kICATypeFloat = 'floa', 
    kICATypeFixed = 'sing', 
    kICATypeBoolean = 'bool', 
    kICATypeString = 'TEXT', 
    kICATypeData = 'data', 
    kICATypeThumbnail = 'thum' 
};  

Constants

Discussion

Definition of data types; these are mapped to AppleEvent types.

enum { 
    kICACommunicationErr = -9900, 
    kICADeviceNotFoundErr = -9901, 
    kICADeviceNotOpenErr = -9902, 
    kICAFileCorruptedErr = -9903, 
    kICAIOPendingErr = -9904, 
    kICAInvalidObjectErr = -9905, 
    kICAInvalidPropertyErr = -9906, 
    kICAIndexOutOfRangeErr = -9907, 
    kICAPropertyTypeNotFoundErr = -9908, 
    kICACannotYieldDevice = -9909, 
    kICADataTypeNotFoundErr = -9910, 
    kICADeviceMemoryAllocationErr = -9911, 
    kICADeviceInternalErr = -9912, 
    kICADeviceInvalidParamErr = -9913, 
    kICADeviceAlreadyOpenErr = -9914, 
    kICADeviceLocationIDNotFoundErr = -9915, 
    kICADeviceGUIDNotFoundErr = -9916, 
    kICADeviceIOServicePathNotFoundErr = -9917, 
    kICADeviceUnsupportedErr = -9918, 
    kICAFrameworkInternalErr = -9919, 
    kICAExtensionInternalErr = -9920, 
    kICAInvalidSessionErr = -9921 
};  

Constants

Discussion

Definition of error codes returned by Image Capture framework

enum { 
    kDeleteAfterDownload = 0x00000001, 
    kCreateCustomIcon = 0x00000002, 
    kAddMetaDataToFinderComment = 0x00000004, 
    kAdjustCreationDate = 0x00000008, 
    kSetFileTypeAndCreator = 0x00000010, 
    //kEmbedColorSyncProfile              = 0x00000020, 
    kRotateImage = 0x00000040, 
    kDontEmbedColorSyncProfile = 0x00000080 
};  

Constants

Discussion

Use any combination of these values when downloading a file.

enum { 
    kICACameraPassThruSend = 0, 
    kICACameraPassThruReceive = 1, 
    kICACameraPassThruNotUsed = 2 
};  

Constants

Discussion

Flag values that can be used in ICAUploadFilePB parameter block.

enum { 
    kICAMessageConnect = 'open', 
    kICAMessageDisconnect = 'clos', 
    kICAMessageReset = 'rese', 
    kICAMessageCheckDevice = 'chkd', 
    kICAMessageCameraReadClock = 'rclk', 
    kICAMessageGetLastButtonPressed = 'btn?', 
    kICAMessageGetEventData = 'mged', 
    kICAMessageDeviceYield = 'yiel', 
    kICAMessageCameraPassThrough = 'pass', 
    kICAMessageScannerOverviewSelectionChanged = 'area' 
};  

Constants

Discussion

Definition of ICAMessage types.

enum { 
    kICADevice = 'icdv', 
    kICADeviceCamera = 'cmra', 
    kICADeviceScanner = 'scan', 
    kICADeviceMFP = 'mfp ', 
    kICADevicePhone = 'phon', 
    kICADevicePDA = 'pda ', 
    kICADeviceOther = 'doth', 
    kICAList = 'objl', 
    kICADirectory = 'dire', 
    kICAFile = 'file', 
    kICAFileImage = 'imag', 
    kICAFileMovie = 'moov', 
    kICAFileAudio = 'audo', 
    kICAFileFirmware = 'firm', 
    kICAFileOther = 'othe' 
};  

Constants

Discussion

Definition of ICAObject types and subtypes

enum { 
    kICAProperty = 'prop', 
    kICAPropertyImageWidth = '0100', 
    kICAPropertyImageHeight = '0101', 
    kICAPropertyImageBitDepth = '0102', 
    kICAPropertyImageDPI = '011A', 
    kICAPropertyImageExposureTime = '829A', 
    kICAPropertyImageFNumber = '829D', 
    kICAPropertyImageDateOriginal = '9003', 
    kICAPropertyImageDateDigitized = '9004', 
    kICAPropertyImageShutterSpeed = '9201', 
    kICAPropertyImageAperture = '9202', 
    kICAPropertyImageFlash = '9209', 
    kICAPropertyColorSpace = 'A001', 
    kICAPropertyImageFilename = 'ifil', 
    kICAPropertyImageSize = 'isiz', 
    kICAPropertyImageData = 'idat', 
    kICAPropertyImageThumbnail = 'thum', 
    kICAPropertyColorSyncProfile = 'prof' 
};  

Constants

Discussion

Definition of ICAProperties

enum { 
    kICAAllowMultipleImages = 0x00000001, 
    kICADownloadAndReturnPathArray = 0x00000002 
};  

Constants

Discussion

Flag values that can be used in ICAImportImagePB parameter block.

enum { 
    kICAPBVersion = 0x00010000 
};  

Constants

Discussion

Parameter block version.

enum { 
    kICAFlagReadWriteAccess = 1L << 0, 
    kICAFlagReadAccess = 1L << 1 
};  

Constants

Discussion

Values for PropertyInfo flag.

enum { 
    kICAThumbnailFormatJPEG = 'jpeg', 
    kICAThumbnailFormatTIFF = 'tiff', 
    kICAThumbnailFormatPNG = 'png ' 
};  

Constants

Discussion

Format alues that can be used in ICACopyObjectThumbnailPB parameter block.

enum { 
    kICAUploadFileAsIs = 0x00000000, 
    kICAUploadFileScaleToFit = 0x00000001 
};  

Constants

Discussion

Flag values that can be used in ICAUploadFilePB parameter block.