Xojo Conferences
MBSOct2019CologneDE

Platforms to show: All Mac Windows Linux Cross-Platform

ImageCaptureObjectMBS.CloseSession
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Image Capture MBS MacOSX Plugin 10.1 Yes No No No No
Function: Close a session on a camera device.
Notes:
Lasterror is set.
For a scanner device use the ScannerCloseSession.

Feedback, Comments & Corrections

ImageCaptureObjectMBS.Constructor
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Image Capture MBS MacOSX Plugin 10.1 Yes No No No No
Function: Creates a new image capture object.

See also:

Feedback, Comments & Corrections

ImageCaptureObjectMBS.Constructor(handle as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Image Capture MBS MacOSX Plugin 10.1 Yes No No No No
Function: Creates a new image capture object with the given handle.

See also:

Feedback, Comments & Corrections

ImageCaptureObjectMBS.CopyData(startByte as int64, requestedSize as int64) as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Image Capture MBS MacOSX Plugin 10.1 Yes No No No No
Function: Get a copy of data associated with a file object.
Example:
dim o as ImageCaptureObjectMBS // your object pointing to an image file.

dim d2 as Dictionary = o.PropertyDictionary
dim size as Integer = d2.Value(o.kICAPropertyImageSize)

dim data as string = o.CopyData(0, size)

if lenb(data)>0 then
// you got the data, now process it.
end if
Notes:
startByte: Starting byte offset of the data in the file object.
requestedSize: Requested data size in bytes.

If you want to get all bytes of an object, pass startByte = 0 and requestedSize = filesize.
Lasterror is set.

Feedback, Comments & Corrections

ImageCaptureObjectMBS.CopyThumbnail(format as string) as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Image Capture MBS MacOSX Plugin 10.1 Yes No No No No
Function: Get a thumbnail associated with an object.
Notes:
This is the recommended way to get the thumbnail of an object.

Use the constants for the format: kICAThumbnailFormatJPEG, kICAThumbnailFormatTIFF or kICAThumbnailFormatPNG
Lasterror is set.

Feedback, Comments & Corrections

ImageCaptureObjectMBS.DownloadFile(dir as folderitem, flags as Integer, MacType as string, MacCreator as string, angle as Double) as folderitem
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Image Capture MBS MacOSX Plugin 10.1 Yes No No No No
Function: Downloads a file to disk.
Notes:
This API is a convenient way to download a file to disk. To receive the image data in memory use CopyObjectData.

Constants for flags:
kDeleteAfterDownload= 1Delete file after a successful download.
kCreateCustomIcon= 2Create a custom icon for Finder.
kAddMetaDataToFinderComment= 4Add basic metadata to finder comment field.
kAdjustCreationDate= 8Set creation date of the downloaded file same as the creation date for the file as reported by the device.
kSetFileTypeAndCreator= &h10Set 4-char file type and creator code.
kEmbedColorSyncProfile= &h20Embed ColorSync profile to the image if one was not already embedded.
kRotateImage= &h40Rotate the image.
kDontEmbedColorSyncProfile= &h80Do not embed ColorSync profile to the image.

Lasterror is set.

Feedback, Comments & Corrections

ImageCaptureObjectMBS.ImportImage(flags as Integer) as string()
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Image Capture MBS MacOSX Plugin 10.1 Yes No No No No
Function: This method displays a Common User Interface panel similar to the user interface of Image Capture Application.
Notes:
Use this method to allow the user to work a camera or a scanner.
The ImageCaptureObjectMBS object you use for this call, should point to a camera or scanner device.

filetypes: Optional an array of file extension strings such as "jpg", "tif", etc., that are of interest to the calling application. If no array is provided, all files are displayed.

Flag values that can be used in ImportImage:
kICAAllowMultipleImages= 1Use this constant to allow users to select multiple images in the Import Image dialog.
kICADownloadAndReturnPathArray= 2Use this constant to download the images to a temporary location and return an array of paths to the downloaded images.

Returns an array of Strings for the imported images if the kICADownloadAndReturnPathArray flag is not specified. Otherwise returns an array of Strings holding the paths of the images that are downloaded.

See also:

Feedback, Comments & Corrections

ImageCaptureObjectMBS.ImportImage(flags as Integer, filetypes() as string) as string()
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Image Capture MBS MacOSX Plugin 10.1 Yes No No No No
Function: This method displays a Common User Interface panel similar to the user interface of Image Capture Application.
Notes:
Use this method to allow the user to work a camera or a scanner.
The ImageCaptureObjectMBS object you use for this call, should point to a camera or scanner device.

filetypes: Optional an array of file extension strings such as "jpg", "tif", etc., that are of interest to the calling application. If no array is provided, all files are displayed.

Flag values that can be used in ImportImage:
kICAAllowMultipleImages= 1Use this constant to allow users to select multiple images in the Import Image dialog.
kICADownloadAndReturnPathArray= 2Use this constant to download the images to a temporary location and return an array of paths to the downloaded images.

Returns an array of Strings for the imported images if the kICADownloadAndReturnPathArray flag is not specified. Otherwise returns an array of Strings holding the paths of the images that are downloaded.

See also:

Feedback, Comments & Corrections

ImageCaptureObjectMBS.OpenSession(device as ImageCaptureObjectMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Image Capture MBS MacOSX Plugin 10.1 Yes No No No No
Function: Opens a session on a camera device.
Notes:
Lasterror is set.
For a scanner device use the ScannerOpenSession method.

Feedback, Comments & Corrections

ImageCaptureObjectMBS.PropertyDictionary as dictionary
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Image Capture MBS MacOSX Plugin 10.1 Yes No No No No
Function: Get a dictionary containing all the properties for an object specified.
Example:
dim m as new ImageCaptureMBS
dim list as ImageCaptureObjectMBS = m.DeviceList

if List<>Nil then
// look into properties
dim dic as Dictionary = list.PropertyDictionary

// take the devices array there
if dic<>Nil and dic.HasKey(ImageCaptureObjectMBS.kICADevicesArrayKey) then
dim a(-1) as Variant = dic.Value(ImageCaptureObjectMBS.kICADevicesArrayKey)

// display device name
for each properties as Dictionary in a
MsgBox Properties.Value("ifil")
next
end if
end if
Notes: Lasterror is set.

Feedback, Comments & Corrections

ImageCaptureObjectMBS.PropertyDictionaryText as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Image Capture MBS MacOSX Plugin 10.1 Yes No No No No
Function: Get a dictionary containing all the properties for an object specified.
Example:
dim m as new ImageCaptureMBS
dim list as ImageCaptureObjectMBS = m.DeviceList

if List<>Nil then
MsgBox List.PropertyDictionaryText
end if
Notes:
Lasterror is set.
This is for debugging and may be removed soon.
The format of the text is the plist file format.

Feedback, Comments & Corrections

ImageCaptureObjectMBS.ScannerCloseSession
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Image Capture MBS MacOSX Plugin 10.1 Yes No No No No
Function: Closes a session on a scanner device.
Notes:
Lasterror is set.
For a camera device use the CloseSession method.

Feedback, Comments & Corrections

ImageCaptureObjectMBS.ScannerGetParameters as dictionary
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Image Capture MBS MacOSX Plugin 10.1 Yes No No No No
Function: Query scanner parameters.
Notes:
Use this method to get information about the scanner such as resolution, scanning area, etc.
Lasterror is set.

Feedback, Comments & Corrections

ImageCaptureObjectMBS.ScannerInitialize
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Image Capture MBS MacOSX Plugin 10.1 Yes No No No No
Function: Initializes a scanner device.
Notes: Lasterror is set.

Feedback, Comments & Corrections

ImageCaptureObjectMBS.ScannerOpenSession(device as ImageCaptureObjectMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Image Capture MBS MacOSX Plugin 10.1 Yes No No No No
Function: Opens a session on a scanner device.
Notes:
Lasterror is set.
For a camera device use the OpenSession method.

Feedback, Comments & Corrections

ImageCaptureObjectMBS.ScannerSetParameters(dic as dictionary)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Image Capture MBS MacOSX Plugin 10.1 Yes No No No No
Function: Configures a scanner.
Notes:
Use this method to specify scan parameters that will be used when a scan is initiated via ScannerStart.
Lasterror is set.

Feedback, Comments & Corrections

ImageCaptureObjectMBS.ScannerStart
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Image Capture MBS MacOSX Plugin 10.1 Yes No No No No
Function: Starts scanning.
Notes:
Use this method to start a scan based on the parameters that were specified in a previous ScannerSetParameters call.
Lasterror is set.

Feedback, Comments & Corrections

ImageCaptureObjectMBS.ScannerStatus as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Image Capture MBS MacOSX Plugin 10.1 Yes No No No No
Function: Returns the scanner status.
Notes: Lasterror is set.

Feedback, Comments & Corrections

ImageCaptureObjectMBS.SendMessageMemory(messageType as string, startByte as UInt32, data as memoryblock, dataType as string) as UInt32
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Image Capture MBS MacOSX Plugin 10.1 Yes No No No No
Function: Sends a message to a device object.
Notes:
Use this API to send a message to a device object. All devices do not respond to all the messages defined above.

messageType: A message type. e.g., kICAMessageCameraCaptureNewImage.
startByte: Offset in dataPtr from where data access for read/write should occur.
data: The data to send.
dataType: Data type.

Lasterror is set.
Retruns the result from this message.

Feedback, Comments & Corrections

ImageCaptureObjectMBS.SendMessageString(messageType as string, startByte as UInt32, data as string, dataType as string) as UInt32
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Image Capture MBS MacOSX Plugin 10.1 Yes No No No No
Function: Sends a message to a device object.
Notes:
Use this API to send a message to a device object. All devices do not respond to all the messages defined above.

messageType: A message type. e.g., kICAMessageCameraCaptureNewImage.
startByte: Offset in dataPtr from where data access for read/write should occur.
data: The data to send.
dataType: Data type.

Lasterror is set.
Retruns the result from this message.

Feedback, Comments & Corrections

ImageCaptureObjectMBS.UploadFile(file as folderitem, flags as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Image Capture MBS MacOSX Plugin 10.1 Yes No No No No
Function: Uploads a file to a device that supports this capability.
Notes:
The device choses an appropriate destination location for the uploaded image and sends a kICANotificationTypeObjectAdded notification.
Lasterror is set.

Flag values that can be used in UploadFile:
kICAUploadFileAsIsUse this constant to upload a file as is.
kICAUploadFileScaleToFitUse this constant to upload a file after scaling to fit a specified bounding rect.

Feedback, Comments & Corrections

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

The biggest plugin in space...




Links
MBS Xojo Chart Plugins