MBS Plugin Documentation

Search:

Statistics   -   FAQ   -   Plugin Parts (All, Dependencies)   -   Class hierarchie

New in Version 7.0 7.1 7.2 7.3 7.4 7.5 7.6 7.7 7.8 8.0 8.1 8.2 8.3 8.4 8.5 8.6 8.7 9.0

The list of the   themes,   classes,   controls,   modules,   global methods by category,   global methods by name,   screenshots,   licenses   and   examples.

Platforms to show: All Mac Windows Linux Cross-Platform

Next items

ImageCaptureObjectMBS.CaptureNewImage as integer
method, Image Capture, MBS MacOSX Plugin (ImageCapture), class ImageCaptureObjectMBS, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Tells the device to capture a new image.
Notes:
Lasterror is set.
Returns the result from the camera.
Require Mac OS X 10.1 or newer.
ImageCaptureObjectMBS.CheckDevice as integer
method, Image Capture, MBS MacOSX Plugin (ImageCapture), class ImageCaptureObjectMBS, Plugin version: 7.0, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Sends a CheckDevice Message to the device.
Notes:
Lasterror is set.
Returns the result from the camera.
ImageCaptureObjectMBS.ChildByIndex(index as integer) as ImageCaptureObjectMBS
method, Image Capture, MBS MacOSX Plugin (ImageCapture), class ImageCaptureObjectMBS, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Returns the child object with the given index.
Notes:
Lasterror is set.
Index is zero based.
Returns nil on any error.
ImageCaptureObjectMBS.ChildCount as integer
method, Image Capture, MBS MacOSX Plugin (ImageCapture), class ImageCaptureObjectMBS, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Determinates the number of children of the curren object.
Notes:
Lasterror is set.
Returns 0 on any error.
class ImageCaptureObjectMBS
class, Image Capture, MBS MacOSX Plugin (ImageCapture), class ImageCaptureObjectMBS, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: An image capture object.
ImageCaptureObjectMBS.close
method, Image Capture, MBS MacOSX Plugin (ImageCapture), class ImageCaptureObjectMBS, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The destructor.
Notes:
There is no need to call this method except you want to free all resources of this object now without waiting for Realbasic to do it for you.
(e.g. some Realbasic versions crash on Windows if there are plugin objects not closed.)
ImageCaptureObjectMBS.closeScannerSession
method, Image Capture, MBS MacOSX Plugin (ImageCapture), class ImageCaptureObjectMBS, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Closes a scanner session.
Notes: Lasterror is set.
ImageCaptureObjectMBS.DeleteOne as integer
method, Image Capture, MBS MacOSX Plugin (ImageCapture), class ImageCaptureObjectMBS, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Tells the device to delete the current object.
Notes:
Lasterror is set.
Returns the result from the camera.
ImageCaptureObjectMBS.DownloadFile(dir as folderitem, flags as integer, MacType as string, MacCreator as string, angle as integer) as folderitem
method, Image Capture, MBS MacOSX Plugin (ImageCapture), class ImageCaptureObjectMBS, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Downloads a file to a directory.
Notes:
Introduced with Mac OS X 10.1 on Mac OS X, so it doesn't work on Mac OS X 10.0.

Values you can combine for the flags parameter:

kDeleteAfterDownload 0x00000001Delete the file from the device after downloading
kCreateCustomIcon 0x00000002For images and movies: create a custom icon (thumbnail)
kAddMetaDataToFinderComment0x00000004Add some meta-data to the Finder comments for the downloaded file.
kAdjustCreationDate 0x00000008Update the creation date to the image/movie internal date.
kSetFileTypeAndCreator 0x00000010Set the file type and creator for the downloaded file to the values passed in. This could be useful for compatibility with the Classic environment.
kEmbedColorSyncProfile 0x00000020For images: embed the ColorSync profile specified for the current device.
kRotateImage 0x00000040For images: rotated the image by the specified rotationAngle before saving the image.

Lasterror is set.
Returns the folderitem to the download file.
ImageCaptureObjectMBS.GetImageBitDepth as integer
method, Image Capture, MBS MacOSX Plugin (ImageCapture), class ImageCaptureObjectMBS, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Returns the image depth if the object represents an image file.
Notes:
Lasterror is set.
Returns 0 in any error.
ImageCaptureObjectMBS.GetImageData as string
method, Image Capture, MBS MacOSX Plugin (ImageCapture), class ImageCaptureObjectMBS, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Returns the image data for an image file object.
Notes:
Lasterror is set.
Returns "" on any error.
ImageCaptureObjectMBS.GetImageDateDigitized as string
method, Image Capture, MBS MacOSX Plugin (ImageCapture), class ImageCaptureObjectMBS, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Returns a file object's date as a string.
Notes:
Lasterror is set.
Returns "" on any error.
ImageCaptureObjectMBS.GetImageDateOriginal as string
method, Image Capture, MBS MacOSX Plugin (ImageCapture), class ImageCaptureObjectMBS, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Returns a file object's date as a string.
Notes:
Lasterror is set.
Returns "" on any error.
ImageCaptureObjectMBS.GetImageDPI as integer
method, Image Capture, MBS MacOSX Plugin (ImageCapture), class ImageCaptureObjectMBS, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: If the object represents an image file, this function returns the DPI value.
Notes:
Lasterror is set.
Returns 0 on any error.
ImageCaptureObjectMBS.GetImageFilename as string
method, Image Capture, MBS MacOSX Plugin (ImageCapture), class ImageCaptureObjectMBS, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Returns the filename if the object represents an image file on a device.
Notes:
Lasterror is set.
Returns "" on any error.
ImageCaptureObjectMBS.GetImageHeight as integer
method, Image Capture, MBS MacOSX Plugin (ImageCapture), class ImageCaptureObjectMBS, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Returns the image height if the object represents an image file.
Notes:
Lasterror is set.
returns 0 on any error.
ImageCaptureObjectMBS.GetImageThumbnail as picture
method, Image Capture, MBS MacOSX Plugin (ImageCapture), class ImageCaptureObjectMBS, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: If the object is an image file, this returns the thumbnail image.
Notes:
Lasterror is set.
Returns nil on any error.
ImageCaptureObjectMBS.GetImageWidth as integer
method, Image Capture, MBS MacOSX Plugin (ImageCapture), class ImageCaptureObjectMBS, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Returns the image width if the object represents an image file.
Notes:
Lasterror is set.
Returns 0 on any error.
ImageCaptureObjectMBS.GetScannerParameters as object
method, Image Capture, MBS MacOSX Plugin (ImageCapture), class ImageCaptureObjectMBS, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Returns scanner related information in a CFMutableDictionaryMBS object.
Notes:
Lasterror is set.
Returns a CFMutableDictionaryMBS class.
To avoid plugin dependency the object is returned as a "object", so you must cast it to CFMutableDictionaryMBS or CFDictionaryMBS.
Returns nil on any error.

The dictionary that gets returned by the GetScannerParameters may look like this:

<CFDictionary 0x1492500 [0xa01303fc]>
{
type = mutable,
count = 1,
capacity = 3,
pairs =
(2 : <CFString 0x27d860 [0xa01303fc]>
{
contents = "device"} = <CFDictionary 0x147ee90 [0xa01303fc]>
{
type = mutable,
count = 7,
capacity = 11,
pairs =
(
1 : <CFString 0x147afb0 [0xa01303fc]>
{contents = "tabletHeight"} = <CFNumber 0x147b000 [0xa01303fc]>
{value = +28080, type = kCFNumberSInt64Type}
2 : <CFString 0x1639db0 [0xa01303fc]>
{contents = "resolutionMinimum"} = <CFNumber 0x1639e00 [0xa01303fc]>
{value = +25, type = kCFNumberSInt64Type}
5 : <CFString 0x1638e30 [0xa01303fc]>
{contents = "resolutionMaxium"} = <CFNumber 0x1639d90 [0xa01303fc]>
{value = +12800, type = kCFNumberSInt64Type}
6 : <CFString 0x147b020 [0xa01303fc]>
{contents = "tabletWidth"} = <CFNumber 0x160990 [0xa01303fc]>
{value = +20400, type = kCFNumberSInt64Type}
7 : <CFString 0x147aed0 [0xa01303fc]>
{contents = "resolutionX"} = <CFNumber 0x147af20 [0xa01303fc]>
{value = +2400, type = kCFNumberSInt64Type}
8 : <CFString 0x147af40 [0xa01303fc]>
{contents = "resolutionY"} = <CFNumber 0x147af90 [0xa01303fc]>
{value = +2400, type = kCFNumberSInt64Type}
15: <CFString 0x147a620 [0xa01303fc]>
{contents = "deviceMode"} = <CFString 0x276330 [0xa01303fc]>
{contents = "reflective"}
)
}
)
}

In this case, the dictionary contains the following entries:

tabletHeightWidth of the entire scan area (based on native x-resolution).
tabletWidthHeight of the entire scan area (based on native y-resolution).
resolutionXDevice native x-resolution
resolutionYDevice native y-resolution
resolutionMinimum Minimum resolution
resolutionMaximum Maximum resolution
deviceMode Device mode (reflective, transparent, document feeder, …).

The current version of Image Capture supports only the ‘reflective’ mode.
ImageCaptureObjectMBS.Handle as Integer
property, Image Capture, MBS MacOSX Plugin (ImageCapture), class ImageCaptureObjectMBS, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The handle to the image capture object.
Notes: (Read and Write property)
ImageCaptureObjectMBS.InitializeScanner
method, Image Capture, MBS MacOSX Plugin (ImageCapture), class ImageCaptureObjectMBS, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function:
The InitializeScanner method initializes the current scanner module and sets it
back to a default state.
Notes: Lasterror is set.
ImageCaptureObjectMBS.Lasterror as Integer
property, Image Capture, MBS MacOSX Plugin (ImageCapture), class ImageCaptureObjectMBS, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The error code from the last function used.
Notes:
Value is 0 if the function was successfull, -1 if the function is not available, one of the following values or a Mac OS error code:

kICACommunicationErr= -9900
kICADeviceNotFoundErr= -9901
kICADeviceNotOpenErr= -9902
kICAFileCorruptedErr= -9903
kICAIOPendingErr= -9904
kICAInvalidObjectErr= -9905
kICAInvalidPropertyErr= -9906
kICAIndexOutOfRangeErr= -9907
kICAPropertyTypeNotFoundErr= -9908
(Read and Write property)
ImageCaptureObjectMBS.ObjectSubType as String
property, Image Capture, MBS MacOSX Plugin (ImageCapture), class ImageCaptureObjectMBS, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The subtype of the object.
Notes:
Lasterror is set.
(Read only property)
ImageCaptureObjectMBS.ObjectType as String
property, Image Capture, MBS MacOSX Plugin (ImageCapture), class ImageCaptureObjectMBS, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The type of the object.
Notes:
Codes for the type and subtypes:

kICADevice "icdv"Also creator of device library files
kICADeviceCamera "cmra"Also file type of device library files
kICADeviceScanner"scan"Also file type of device library files
kICADeviceMFP "mfp "Also file type of device library files
kICAList "objl"
kICADirectory "dire"
kICAFile "file"
kICAFileImage "imag"
kICAFileMovie "moov"
kICAFileAudio "audo"
kICAFileFirmware "firm"
kICAFileOther "othe"

Lasterror is set.
(Read only property)
ImageCaptureObjectMBS.OpenScannerSession
method, Image Capture, MBS MacOSX Plugin (ImageCapture), class ImageCaptureObjectMBS, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Opens a new scanner session.
Notes:
Lasterror is set.
The ScannerSessionHandle property is set by this function.
ImageCaptureObjectMBS.Parent as ImageCaptureObjectMBS
method, Image Capture, MBS MacOSX Plugin (ImageCapture), class ImageCaptureObjectMBS, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Returns the parent object for the given object.
Notes:
Lasterror is set.
Returns nil on any error.
ImageCaptureObjectMBS.Properties as object
method, Image Capture, MBS MacOSX Plugin (ImageCapture), class ImageCaptureObjectMBS, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Returns a CF Dictionary with information about
Example:
dim i as ImageCaptureObjectMBS
dim c as CFDictionaryMBS
dim o as Object

...

o=i.Properties
if o<>nil then
c=CFDictionaryMBS(o)
end if

Notes:
Lasterror is set.
Returns a CFDictionaryMBS object or nil on any error.
Introduced with Mac OS X 10.1.
To reduce plugin dependence, this function returns an object which you must cast to a CFDictionary.

CFDictionary samples:

Canon Powershot S300
{
capa = (1684368433, 1935895659);
datP = 0;
data = (
{
datP = 1879048197;
file = 1768776039;
icao = 1862270978;
ifil = IMG_0327.JPG;
isiz = 191880;
thuP = 1879048195;
tsiz = 49166;
},
{
datP = 1879048203;
file = 1768776039;
icao = 1862270979;
ifil = IMG_0328.JPG;
isiz = 674980;
thuP = 1879048201;
tsiz = 49166;
},
{
datP = 1879048209;
file = 1768776039;
icao = 1862270980;
ifil = IMG_0329.JPG;
isiz = 674980;
thuP = 1879048207;
tsiz = 49166;
}
);
file = 1668117089;
icao = 1862270977;
ifil = "Canon PowerShot S300";
isiz = 0;
thuP = 1879048193;
tsiz = 9229;
}

First image
{
0100 = 1600;
0101 = 1200;
0102 = 24;
0112 = 1;
011A = 180;
0213 = 1;
616B = Canon;
6179 = "2001:09:13 17:19:51";
6F64 = "Canon PowerShot S300";
7374 = "MacOS 10.1";
829A = 0.01666667;
829D = 8;
9000 = 0210;
9003 = "2001:09:12 19:41:58";
9004 = "2001:09:12 19:41:58";
9102 = 5;
9201 = 5.90625;
9202 = 6;
9204 = 0;
9205 = 2.865906;
9206 = 0.441;
9207 = 5;
9209 = 1;
920A = 5.40625;
927C = <0c000100 .... 00000000 >;
A000 = 0100;
A001 = 1;
A002 = 1600;
A003 = 1200;
A20E = 7766.99;
A20F = 7741.936;
A210 = 2;
A217 = 2;
datP = 1879048197;
file = 1768776039;
icao = 1862270978;
ifil = IMG_0327.JPG;
isiz = 191880;
thuP = 1879048195;
tsiz = 49166;
}

As you can see in the previous sample, the camera dictionary not only contains the
camera specific information such as devicetype (kICADeviceCamera), the camera icon
property (kICAPropertyCameraIcon), but also an array with the basic image information.
For each entry in that array, you’ll get the image name, the image size, the thumbnail and
the image property.

The image dictionary contains all the meta data out of the image itself plus extra
information such as image name, the image size, the thumbnail and the image property.
ImageCaptureObjectMBS.Release as Boolean
property, Image Capture, MBS MacOSX Plugin (ImageCapture), class ImageCaptureObjectMBS, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: whether the object is released by the destructor.
Notes: (Read and Write property)
ImageCaptureObjectMBS.Reset as integer
method, Image Capture, MBS MacOSX Plugin (ImageCapture), class ImageCaptureObjectMBS, Plugin version: 7.0, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Sends a Reset Message to the device.
Notes:
Lasterror is set.
Returns the result from the camera.
ImageCaptureObjectMBS.Root as ImageCaptureObjectMBS
method, Image Capture, MBS MacOSX Plugin (ImageCapture), class ImageCaptureObjectMBS, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Returns the root object for the given object inside the object tree.
Notes:
Lasterror is set.
Returns nil on any error.
ImageCaptureObjectMBS.ScannerSessionHandle as Integer
property, Image Capture, MBS MacOSX Plugin (ImageCapture), class ImageCaptureObjectMBS, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The handle for the scanner session.
Notes: (Read and Write property)
ImageCaptureObjectMBS.ScannerStatus as integer
method, Image Capture, MBS MacOSX Plugin (ImageCapture), class ImageCaptureObjectMBS, Plugin version: 3.1, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Returns the scanner status.
Notes: Lasterror is set.

Previous items

The items on this page are in the following plugins: MBS MacOSX Plugin.