IC4_PROPERTY Struct Reference

Represents a property of a component, usually of a video capture device. More...

Detailed Description

Represents a property of a component, usually of a video capture device.

All property types are referred to by pointers to IC4_PROPERTY, there are no specialized types for different property types.

IC4_PROPERTY also represents enumeration entries, even though they are not actually property that is part of the category tree. Nevertheless, enumeration entries support all standard property operations.

Property objects are created in multiple ways:

• By calling ic4_propmap_find() or one of its typed sibling functions like ic4_propmap_find_integer().
• By calling ic4_proplist_at() to retrieve a property out of a property list, that was previously obtained:
  • By calling ic4_prop_category_get_features() to get all properties from a category.
  • By calling ic4_prop_enum_get_entries() to get the enumeration entries of an enumeration property.
  • By calling ic4_prop_get_selected_props() to get the properties selected by a property.
  • By calling ic4_propmap_get_all() to get all properties in a property map's category tree.

Property objects obtained in any of these ways that refer to the same device property will always have the same pointer value.

Calling a function expecting a property with a certain property type on a property with a different type will fail and the error value will be set to IC4_ERROR_GENICAM_TYPE_MISMATCH.