Image Acquisition Toolbox

propinfo

Return property characteristics for image acquisition objects

Syntax

• out = propinfo(obj)
  out = propinfo(obj,'PropertyName')
  

Description

out = propinfo(obj) returns the structure out whose field names are the names of all the properties supported by obj. obj must be a 1-by-1 image acquisition object. The value of each field is a structure containing the fields shown below.

Field Name	Description
Type	Data type of the property. Possible values are 'any', 'callback', 'double', 'string', and 'struct'
Constraint	Type of constraint on the property value. Possible values are 'bounded', 'callback', 'enum', and 'none'
ConstraintValue	List of valid string values or a range of valid values
DefaultValue	Default value for the property
ReadOnly	Condition under which a property is read only: 'always'-- property cannot be configured. 'whileRunning'-- property cannot be configured while Running is set to on. 'never'-- property can be configured at any time.
DeviceSpecific	1 if the property is device specific; otherwise, 0 (zero)

out = propinfo(obj,'PropertyName') returns the structure out for the property specified by PropertyName. If PropertyName is a cell array of strings, propinfo returns a structure for each property, stored in a cell array.

Example

Create the video input object vid.

• vid = videoinput('winvideo',1);
  

Capture all property information for all properties.

• out = propinfo(vid);
  

Access property information for a particular property.

• out1 = propinfo(vid,'LoggingMode');
  

See Also

imaqhelp

preview

save