propinfo

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', 'character vector', and 'struct'.
Constraint	Type of constraint on the property value. Possible values are 'bounded', 'callback', 'enum', and 'none'.
ConstraintValue	List of valid character vector 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 character vectors, propinfo returns a structure for each property, stored in a cell array.

Note

To get a list of options you can use on a function, press the Tab key after entering a function on the MATLAB^® command line. The list expands, and you can scroll to choose a property or value. For information about using this advanced tab completion feature, see Using Tab Completion for Functions.

Examples

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');

Version History

Introduced before R2006a