triggerinfo

Provide information about available trigger configurations

Syntax

triggerinfo(obj)
triggerinfo(obj,type)
config = triggerinfo(...)


Description

triggerinfo(obj) displays all available trigger configurations for the video input object obj. obj can only be a 1-by-1 video input object.

triggerinfo(obj,type) displays the available trigger configurations for the specified TriggerType, type, for the video input object obj. To get a list of valid type values for a particular image acquisition object, use triggerinfo(obj).

config = triggerinfo(...) returns config, an array of MATLAB^® structures, containing all the valid trigger configurations for the video input object obj. Each structure in the array contains these fields:

Field	Description
TriggerType	Name of the trigger type
TriggerCondition	Condition that must be met before executing a trigger
TriggerSource	Hardware source used for triggering

You can pass one of the structures in config to the triggerconfig function to specify the trigger configuration.

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

This example illustrates how to use the triggerinfo function to retrieve valid configurations of the TriggerType, TriggerSource, and TriggerCondition properties.

1. Create a video input object.

   vid = videoinput('winvideo');

2. Get information about the available trigger configurations for this object.

   config = triggerinfo(vid)
   
   config = 
   
   1x2 struct array with fields:
       TriggerType
       TriggerCondition
       TriggerSource

3. View one of the trigger configurations returned by triggerinfo.

   config(1)
   
   ans = 
   
            TriggerType: 'immediate'
       TriggerCondition: 'none'
          TriggerSource: 'none'

Version History

Introduced before R2006a