Running

Indicate whether video input object is ready to acquire data

Description

The Running property indicates if the video input object is ready to acquire data.

Along with the Logging property, Running reflects the state of a video input object. The Running property indicates that the object is ready to acquire data, while the Logging property indicates that the object is acquiring data.

The object sets the Running property to 'on' when you issue the start command. When Running is 'on', you can acquire data from a video source.

The object sets the Running property to 'off' when any of the following conditions is met:

  • The specified number of frames has been acquired.

  • A run-time error occurs.

  • You issue the stop command.

When Running is 'off', you cannot acquire image data. However, you can acquire one image frame with the getsnapshot function.

Characteristics

Default value is enclosed in braces ({}).

Access

Read only

Data type

String

Values

[ {'off'} | 'on' ]

See Also

Properties

getsnapshot, start, stop

Properties

Logging

Was this topic helpful?