propinfo

Property characteristics for image acquisition objects

collapse all in page

Syntax

info = propinfo(obj)
info = propinfo(obj,PropertyName)

Description

info = propinfo(obj) returns the structure info whose field names are the names of all the properties supported by obj.

example

info = propinfo(obj,PropertyName) returns the structure out for the property specified by PropertyName.

example

Examples

collapse all

Create the video input object obj. 

obj = videoinput('winvideo',1);

Capture all property information for all properties.

info = propinfo(obj)
info =
   struct with fields:
       BayerSensorAlignment: [1×1 struct]
                   DeviceID: [1×1 struct]
                 DiskLogger: [1×1 struct]
       DiskLoggerFrameCount: [1×1 struct]
                   ErrorFcn: [1×1 struct]
                   EventLog: [1×1 struct]
          FrameGrabInterval: [1×1 struct]
             FramesAcquired: [1×1 struct]
          FramesAcquiredFcn: [1×1 struct]
     FramesAcquiredFcnCount: [1×1 struct]
            FramesAvailable: [1×1 struct]
           FramesPerTrigger: [1×1 struct]
         InitialTriggerTime: [1×1 struct]
                    Logging: [1×1 struct]
                LoggingMode: [1×1 struct]
                       Name: [1×1 struct]
              NumberOfBands: [1×1 struct]
        PreviewFullBitDepth: [1×1 struct]
                 Previewing: [1×1 struct]
         ReturnedColorSpace: [1×1 struct]
                ROIPosition: [1×1 struct]
                    Running: [1×1 struct]
         SelectedSourceName: [1×1 struct]
                     Source: [1×1 struct]
                   StartFcn: [1×1 struct]
                    StopFcn: [1×1 struct]
                        Tag: [1×1 struct]
                    Timeout: [1×1 struct]
                   TimerFcn: [1×1 struct]
                TimerPeriod: [1×1 struct]
           TriggerCondition: [1×1 struct]
                 TriggerFcn: [1×1 struct]
          TriggerFrameDelay: [1×1 struct]
              TriggerRepeat: [1×1 struct]
           TriggersExecuted: [1×1 struct]
              TriggerSource: [1×1 struct]
                TriggerType: [1×1 struct]
                       Type: [1×1 struct]
                   UserData: [1×1 struct]
                VideoFormat: [1×1 struct]
            VideoResolution: [1×1 struct]

Access property information for a particular property.

info1 = propinfo(obj,'LoggingMode');
info1 =
   struct with fields:
                Type: 'string'
          Constraint: 'enum'
     ConstraintValue: {'memory'  'disk'  'disk&memory'}
        DefaultValue: 'memory'
            ReadOnly: 'whileRunning'
      DeviceSpecific: 0

Input Arguments

collapse all

Video input object, specified as the output of the videoinput function. obj must be a 1-by-1 video input object.

Example: videoinput("matrox")

Name of a property, specified as a string or character vector. If PropertyName is a cell array of character vectors, propinfo returns a structure for each property, stored in a cell array.

Example: "LoggingMode"

Data Types: char | string | cell

Output Arguments

collapse all

Properties of the image object, returned as a structure or cell array of structures with the following fields.

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).

Version History

Introduced before R2006a

See Also

|