FindDeviceById ()

FindDeviceById (in's'device_id,
out'o'object_path)

Gets a device path for the device ID.
This method is required as device ID's may have to be mangled
to conform with the DBus path specification.
For instance, a device ID of "cups$34:dev' would have a object
path of "/org/freedesktop/ColorManager/cups_34_dev".

device_id:

A device ID.

object_path:

A device path.

FindSensorById ()

FindSensorById (in's'sensor_id,
out'o'object_path)

Gets a sensor path for the sensor ID.

sensor_id:

A sensor ID.

object_path:

A sensor path.

FindDeviceByProperty ()

FindDeviceByProperty (in's'key,
in's'value,
out'o'object_path)

Gets a device path for the device with the specified property.

key:

A property key, e.g. XRANDR_name.

value:

A property value, e.g. lvds.

object_path:

A device path.

FindProfileById ()

FindProfileById (in's'profile_id,
out'o'object_path)

Gets a profile path for the profile ID.

profile_id:

A profile ID.

object_path:

A profile path.

FindProfileByProperty ()

FindProfileByProperty (in's'key,
in's'value,
out'o'object_path)

Gets a profile path for the profile with the specified property.

key:

A property key, e.g. FILE_checksum.

value:

A property value, e.g. 5b3855e8630c9d8a48177cc70680da93.

object_path:

A profile path.

FindProfileByFilename ()

FindProfileByFilename (in's'filename,
out'o'object_path)

Gets a profile path for the profile filename, either a fully-qualified
filename with path or just the basename of the profile.

filename:

A profile filename.

object_path:

A profile path.

GetStandardSpace ()

GetStandardSpace (in's'standard_space,
out'o'object_path)

Gets a profile path for a defined profile space.
The defined space is set from the profile metadata,
specifically in the STANDARD_space entry.

NOTE: only system wide profiles are able to define
themselves as standard spaces.

CreateProfileWithFd ()

If the profile has been added to a device in the past, and
that device exists already, then the new profile will be
automatically added to the device.
To prevent this from happening, remove the assignment by
doing RemoveProfiledoc:tt> on the relevant
device object.

An optional file descriptor can be sent out of band for the
ICC profile file.

Using a file descriptor in addition to the filename allows
the daemon to parse the ICC profile without re-opening it,
which allows the daemon to read files inside the users
home directory in a SELinux environment.

profile_id:

A unique profile ID that is used to map to the profile.
This is normally the MD5 hash of the disk profile.

scope:

Options for creating the profile. This allows the session
color management component to have per-user profiles
stored in the home directory that would not be valid if
the user logged off, or no users are logged in.

handle:

An index into the array of file descriptors that may have
been sent with the DBus message.

properties:

Properties to be used when constructing the profile.

This optional value allows the profile to be created with
the latency of one bus round-trip, rather than doing
a few SetProperty methods indervidually.

Any properties not interstood by colord will be added as
dictionary values to the Metadata
property.

CreateDevice ()

If the device has profiles added to it in the past, and
that profiles exists already, then the new device will be
automatically have profiles added to the device.
To prevent this from happening, remove the assignment by
doing RemoveProfile on the relevant
device object.

device_id:

A device ID that is used to map to the device path.

scope:

Options for creating the device. This allows the session
color management component to have per-session virtual
devices cleaned up automatically or devices that are
re-created on each boot.

properties:

Properties to be used when constructing the device.

This optional value allows the device to be created with
the latency of one bus round-trip, rather than doing
a few SetProperty methods indervidually.

Any properties not interstood by colord will be added as
dictionary values to the Metadata
property.

object_path:

A device path.

DeleteDevice ()

DeleteDevice (in'o'object_path)

Deletes a device.

object_path:

A device path.

DeleteProfile ()

DeleteProfile (in'o'object_path)

Deletes a profile.

object_path:

A profile path.

Signal Details

The Changed signal

Changed ()

Some value on the interface or the number of devices or
profiles has changed.