Documentation Center

  • Trial Software
  • Product Updates

Contents

Specifying Format Information

To specify the video formats supported by a particular device in an IMDF file, use the VideoFormat element. VideoFormat nodes must be children of Device nodes. In the VideoFormat node, you specify the name of the format as the value of an attribute of the element.

You can also specify format-specific property and trigger information, if necessary. A VideoFormat node can have Property and TriggerInfo nodes as children. (VideoFormat nodes can also have a Section node as a child — see Defining and Including Sections.)

The following example outlines how to use the VideoFormat node. The words in italics represent text that you define.

<ImageAcquisitionInfo>
	<Device device=devicename>
		<VideoFormat name=formatname>
			<Property constraint=constraint_value
					 deviceSpecific=true_or_false
					 name=property_name
					 readOnly=always_never_or_whileRunning
					 type=cell_double_int_or_string
					 min=minimum_value
					 max=maximum_value
					 optional=on_or_off
					 default=default_value>
			</Property>

			<TriggerInfo>
			</TriggerInfo>
		</VideoFormat>
	</Device>
	.
	.
	.
</ImageAcquisitionInfo>

The following table lists the tags used to specify video format information.

Element

Description

Attributes

<Include>

Include one or more nodes grouped into a Section node. This is an optional element. A VideoFormat node can contain multiple Include nodes.

tag=sectionname, where sectionname is a text string that identifies a particular Section node

<Section>

Groups one or more nodes into a Section node. This is an optional element. A VideoFormat node can contain multiple Section nodes.

name=sectionname, where sectionname is the name you want to assign to a particular Section node

<Property>

Describes the properties of a video format. This is an optional element. A VideoFormat node can contain multiple Property nodes.

See Specifying Property Information.

<Source>

Defines the source of video data. This is an optional element.

See Specifying Video Sources

<TriggerInfo>

Trigger information specific to a particular video format. This is an optional element. A VideoFormat node can only contain one TriggerInfo node.

See Specifying Hardware Trigger Information.

Was this topic helpful?