Platforms to show: All Mac Windows Linux Cross-Platform

Next items

CSDeviceMBS.DeviceInfo(deviceClass as string, deviceID as CFUUIDMBS) as dictionary
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ColorSync MBS MacCF Plugin 10.5 Yes No No Yes, macOS only No
Function: Queries information on the device.
Notes:
Returns a dictionary with the following keys and values resolved for the current host and current user.

kColorSyncDeviceClass: camera, display, printer, scanner
kColorSyncDeviceID: CFUUIDRef registered with ColorSync
kColorSyncDeviceDescription: localized device description
kColorSyncDeviceUserScope: kCFPreferencesAnyUser or kCFPreferencesCurrentUser
kColorSyncDeviceHostScope: kCFPreferencesAnyHost or kCFPreferencesCurrentHost
kColorSyncFactoryProfiles: dictionary with ProfileID and kColorSyncCustomProfiles keys.
kColorSyncCustomProfiles: dictionary with keys ProfileID and values CFURLMBS or nil.

ProfileID is a dictionary with the following keys:

kColorSyncDeviceProfileURL: CFURLMBS or kCFNull
kColorSyncDeviceModeDescription: localized mode description

Feedback, Comments & Corrections

CSDeviceMBS.DeviceProfiles as dictionary()
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ColorSync MBS MacCF Plugin 10.5 Yes No No Yes, macOS only No
Function: Queris the device profiles.
Notes:
The dictionaries contain the following keys:

kColorSyncDeviceClasscamera, display, printer, scanner
kColorSyncDeviceIDCFUUIDRef registered with ColorSync
kColorSyncDeviceDescriptionlocalized device description
kColorSyncDeviceModeDescriptionlocalized device mode description
kColorSyncDeviceProfileIDProfileID registered with ColorSync
kColorSyncDeviceProfileURLCFURLMBS registered with ColorSync
kColorSyncDeviceProfileIsFactoryBoolean
kColorSyncDeviceProfileIsDefaultBoolean
kColorSyncDeviceProfileIsCurrentBoolean

Feedback, Comments & Corrections

CSDeviceMBS.kColorSyncCameraDeviceClass as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ColorSync MBS MacCF Plugin 10.5 Yes No No Yes, macOS only No
Function: A constant for a possible value for the device class.

Feedback, Comments & Corrections

CSDeviceMBS.kColorSyncCustomProfiles as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ColorSync MBS MacCF Plugin 10.5 Yes No No Yes, macOS only No
Function: One of the key constants for the info/options dictionaries.
Notes: Dictionary containing custom profile info.

Feedback, Comments & Corrections

CSDeviceMBS.kColorSyncDeviceClass as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ColorSync MBS MacCF Plugin 10.5 Yes No No Yes, macOS only No
Function: One of the key constants for the info/options dictionaries.

Feedback, Comments & Corrections

CSDeviceMBS.kColorSyncDeviceDefaultProfileID as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ColorSync MBS MacCF Plugin 10.5 Yes No No Yes, macOS only No
Function: One of the key constants for the info/options dictionaries.

Feedback, Comments & Corrections

CSDeviceMBS.kColorSyncDeviceDescription as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ColorSync MBS MacCF Plugin 10.5 Yes No No Yes, macOS only No
Function: One of the key constants for the info/options dictionaries.
Notes: String with a name in current locale.

Feedback, Comments & Corrections

CSDeviceMBS.kColorSyncDeviceDescriptions as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ColorSync MBS MacCF Plugin 10.5 Yes No No Yes, macOS only No
Function: One of the key constants for the info/options dictionaries.
Notes: Dictionary with localized names.

Feedback, Comments & Corrections

CSDeviceMBS.kColorSyncDeviceHostScope as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ColorSync MBS MacCF Plugin 10.5 Yes No No Yes, macOS only No
Function: One of the key constants for the info/options dictionaries.

Feedback, Comments & Corrections

CSDeviceMBS.kColorSyncDeviceID as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ColorSync MBS MacCF Plugin 10.5 Yes No No Yes, macOS only No
Function: One of the key constants for the info/options dictionaries.
Notes: Value is a CFUUIDMBS for this key.

Feedback, Comments & Corrections

CSDeviceMBS.kColorSyncDeviceModeDescription as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ColorSync MBS MacCF Plugin 10.5 Yes No No Yes, macOS only No
Function: One of the key constants for the info/options dictionaries.
Notes: String, e.g. Glossy, Best Quality.

Feedback, Comments & Corrections

CSDeviceMBS.kColorSyncDeviceModeDescriptions as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ColorSync MBS MacCF Plugin 10.5 Yes No No Yes, macOS only No
Function: One of the key constants for the info/options dictionaries.
Notes: Dictionary with localized mode names.

Feedback, Comments & Corrections

CSDeviceMBS.kColorSyncDeviceProfileID as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ColorSync MBS MacCF Plugin 10.5 Yes No No Yes, macOS only No
Function: One of the key constants for the info/options dictionaries.

Feedback, Comments & Corrections

CSDeviceMBS.kColorSyncDeviceProfileIsCurrent as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ColorSync MBS MacCF Plugin 10.5 Yes No No Yes, macOS only No
Function: One of the key constants for the info/options dictionaries.

Feedback, Comments & Corrections

CSDeviceMBS.kColorSyncDeviceProfileIsDefault as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ColorSync MBS MacCF Plugin 10.5 Yes No No Yes, macOS only No
Function: One of the key constants for the info/options dictionaries.

Feedback, Comments & Corrections

CSDeviceMBS.kColorSyncDeviceProfileIsFactory as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ColorSync MBS MacCF Plugin 10.5 Yes No No Yes, macOS only No
Function: One of the key constants for the info/options dictionaries.

Feedback, Comments & Corrections

CSDeviceMBS.kColorSyncDeviceProfilesNotification as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ColorSync MBS MacCF Plugin 10.5 Yes No No Yes, macOS only No
Function: One of the key constants for the info/options dictionaries.

Feedback, Comments & Corrections

CSDeviceMBS.kColorSyncDeviceProfileURL as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ColorSync MBS MacCF Plugin 10.5 Yes No No Yes, macOS only No
Function: One of the key constants for the info/options dictionaries.

Feedback, Comments & Corrections

CSDeviceMBS.kColorSyncDeviceRegisteredNotification as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ColorSync MBS MacCF Plugin 10.5 Yes No No Yes, macOS only No
Function: One of the key constants for the info/options dictionaries.

Feedback, Comments & Corrections

CSDeviceMBS.kColorSyncDeviceUnregisteredNotification as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ColorSync MBS MacCF Plugin 10.5 Yes No No Yes, macOS only No
Function: One of the key constants for the info/options dictionaries.

Feedback, Comments & Corrections

CSDeviceMBS.kColorSyncDeviceUserScope as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ColorSync MBS MacCF Plugin 10.5 Yes No No Yes, macOS only No
Function: One of the key constants for the info/options dictionaries.

Feedback, Comments & Corrections

CSDeviceMBS.kColorSyncDisplayDeviceClass as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ColorSync MBS MacCF Plugin 10.5 Yes No No Yes, macOS only No
Function: A constant for a possible value for the device class.

Feedback, Comments & Corrections

CSDeviceMBS.kColorSyncDisplayDeviceProfilesNotification as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ColorSync MBS MacCF Plugin 10.5 Yes No No Yes, macOS only No
Function: One of the key constants for the info/options dictionaries.

Feedback, Comments & Corrections

CSDeviceMBS.kColorSyncFactoryProfiles as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ColorSync MBS MacCF Plugin 10.5 Yes No No Yes, macOS only No
Function: One of the key constants for the info/options dictionaries.
Notes: Dictionary containing factory profile info.

Feedback, Comments & Corrections

CSDeviceMBS.kColorSyncPrinterDeviceClass as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ColorSync MBS MacCF Plugin 10.5 Yes No No Yes, macOS only No
Function: A constant for a possible value for the device class.

Feedback, Comments & Corrections

CSDeviceMBS.kColorSyncProfileHostScope as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ColorSync MBS MacCF Plugin 10.5 Yes No No Yes, macOS only No
Function: One of the key constants for the info/options dictionaries.

Feedback, Comments & Corrections

CSDeviceMBS.kColorSyncProfileUserScope as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ColorSync MBS MacCF Plugin 10.5 Yes No No Yes, macOS only No
Function: One of the key constants for the info/options dictionaries.

Feedback, Comments & Corrections

CSDeviceMBS.kColorSyncScannerDeviceClass as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ColorSync MBS MacCF Plugin 10.5 Yes No No Yes, macOS only No
Function: A constant for a possible value for the device class.

Feedback, Comments & Corrections

CSDeviceMBS.RegisterDevice(deviceClass as string, deviceID as CFUUIDMBS, deviceInfo as dictionary) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ColorSync MBS MacCF Plugin 10.5 Yes No No Yes, macOS only No
Function: Registeres a device.
Notes:
deviceInfo: A dictionary containing information needed to register a device.

Required keys:

kColorSyncDeviceDescriptions: Dictionary with localized names of the device. Localization keys must be five character strings containing language code and region code in the lc_RG format and it must contain (at least) the "en_US" locale.
kColorSyncFactoryProfiles: Dictionary with factory profile info Dictionaries The keys are the profile IDs and the values are the profile info dictionaries.

Optional keys:

kColorSyncDeviceHostScope: host scope of the device; one of kCFPreferences{Current,Any}Host; if unspecified kCFPreferencesCurrentHost is assumed.
kColorSyncDeviceUserScope: user scope of the device; one of kCFPreferences{Current,Any}User; if unspecified kCFPreferencesCurrentUser is assumed.

factory profiles dictionary - value for the key kColorSyncFactoryProfiles in deviceInfo

Required keys and values:

Each profile is identified by a ProfileID (of String type) which used as the key. Value associated with the key is a profile info dictionary that describes an individual device profile.

kColorSyncDeviceDefaultProfileID: the associated value must be one of the ProfileID present in the dictionary. Presence of this key is not required if there is only one factory profile.

profile info Dictionary

Required keys:

kColorSyncDeviceProfileURL: CFURLMBS of the profile to be registered
kColorSyncDeviceModeDescriptions: Dictionary with localized device mode names for the profile. Localization keys must be five character strings containing language code and region code in the lc_RG format and it must contain (at least) the "en_US" locale. E.g. "en_US" "Glossy Paper with best quality"

Example of deviceInfo dictionary:

kColorSyncDeviceDescriptions:
en_US My Little Printer
de_DE Mein Kleiner Drucker
fr_FR Mon petit immprimeur
...

kColorSyncFactoryProfiles: "Profile 1"
kColorSyncDeviceProfileURL: CFURLMBS
kColorSyncDeviceModeDescriptions:
en_US Glossy Paper
de_DE Glanzpapier
fr_FR Papier glace
...

kColorSyncDeviceDefaultProfileID: "Profile 1"
kColorSyncDeviceUserScope: kCFPreferencesAnyUser
kColorSyncDeviceHostScope: kCFPreferencesCurrentHost

Notes:
1. Scope for factory profiles is exactly the same as the device scope.
2. Pass CFNullRef in lieu of the profile URL or no URl key/value pair at all if factory profile is not available. This will enable setting custom profile.
3. For the reasons of compatibility with legacy API, it is recommended that the profile keys are created as CFStrings from uint32 numbers as follows: key = encodings.UTF32.chr(value)

Returns true on success and false in case of failure

Feedback, Comments & Corrections

Next items

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

The biggest plugin in space...




Links
MBS Xojo PDF Plugins