MseqInquire

See also

User Guide:

Compressing and decompressing a sequence of images

Reference:

MseqAlloc MseqControl MseqDefine

Availability

Available in MIL-Lite

Available in MIL

Available on Windows

Not available on Linux

Not supported on:

Not supported on Matrox Indio (Update 53 or Update 68) (w)

Not supported on Matrox Concord PoE with ToE (Update 82) (z)

Partially supported on:

Partially supported on Host system (a)

Partially supported on Matrox GigE Vision driver (MIL 10, Update 25, Update 54, or Update 85)* (c)

Partially supported on Matrox Morphis (g)

Partially supported on Matrox Morphis QxT (h)

Partially supported on Matrox Orion HD (i)

Partially supported on Matrox Radient eCL (j)

Partially supported on Matrox Radient eV-CXP (MIL 10 or Update 29)* (k)

Partially supported on Matrox Solios eA/XA (l)

Partially supported on Matrox Solios ecl/xcl/ev-cl (m)

Partially supported on Matrox USB3 Vision driver (Update 19) (o)

Partially supported on Matrox RadientPro-CL (Update 7) (p)

Partially supported on Matrox Radient eV-CL (Update 27 or 74) (r)

Partially supported on Matrox Iris GTR (Update 28 or Update 68) (t)

Partially supported on Matrox GenTL driver (Update 34) (v)

Partially supported on Matrox Rapixo CXP (Update 75 or Update 84) (y)

Partially supported on Matrox Rapixo CL Pro (Update 96) (aa)

Fully supported on:

Fully supported on Matrox Clarity UHD (Update 36 or 76) (u)

* Refer to the MIL system-specific information
in the MIL Reference for the minimum update required.

For any information regarding a MIL system added during a MIL Update, see the MIL system’s release note

Available on Non-Matrox computer

Available on Matrox 4Sight-X

Available on Matrox 4Sight GP/GPm

Available on Matrox Supersight

Function map

Examples

mseqprocess.cpp
mseqprocess.cs
mseqprocess.vb

Function Map

Table:	For specifying a context, or an individual source or destination
+ combination:	For specifying the index of the destination of the output to inquire

- InquireType

- UserVarPtr

Parameter Associations

Table:	For retrieving information about the H.264 compression operation settings
+ combination:	For inquiring the actual values used
Table:	For retrieving information about general individual source or destination settings
Table:	For retrieving information about individual file (M_FILE) source or destination settings
+ combination:	For getting the string size

Return value

Compilation information

Synopsis

Inquire information about a sequence context or an individual source or destination setting.

Syntax

MIL_INT MseqInquire(

MIL_ID ContextSeqId,	//in
MIL_INT SequenceIndex,	//in
MIL_INT64 InquireType,	//in
void *UserVarPtr	//out

)

Description

This function inquires information about a sequence context or an individual source or destination setting.

Note that this function reference has not been updated for a MIL system added during a MIL update. Refer to the MIL system's release note to see which MIL system’s documentation you should use in its place and any possible differences.

Parameters

This function is not supported on the selected boards.

This function reference has not been updated for the selected MIL system. To show the content of this page, choose a second MIL system; refer to the MIL system's release note to see which MIL system’s documentation to choose and any possible differences.

Parameters

ContextSeqId

Specifies the sequence context about which to inquire information. The sequence context must have been previously allocated using MseqAlloc().

SequenceIndex

Specifies that the sequence context, the source of an input, or a destination of an output is inquired. Set this parameter to one of the following values:

For specifying a context, or an individual source or destination
Value	Description
M_DEFAULT	Same as M_CONTEXT.
M_SEQ_INPUT( MIL_INT Index )	Specifies an input of the sequence operation, whose source must be inquired. (summarize) Specifies an input of the sequence operation, whose source must be inquired. (more details...)
		Parameters
		Index Specifies the index of the input. The index must be 0.
M_SEQ_OUTPUT( MIL_INT Index )	Specifies an output of the sequence operation, whose destination must be inquired. An output can have multiple destinations. You must specify a combination value from the following table: To specify the index of the destination of the output to inquire (summarize) Specifies an output of the sequence operation, whose destination must be inquired. (more details...)
		Parameters
		Index Specifies the index of the output. The index must be set to 0.
M_CONTEXT	Inquires information about the specified sequence context.

Combination value for M_SEQ_OUTPUT.

You must add the following value to the above-mentioned value to specify the index of the destination of the output to inquire.

For specifying the index of the destination of the output to inquire
Combination value	Description
M_SEQ_DEST( MIL_INT Index )	Specifies the destination of the output to inquire. (summarize) Specifies the destination of the output to inquire. (more details...)
		Parameters
		Index Specifies the index of the destination. The index must be between 0 and 31.

InquireType

Specifies the type of setting about which to inquire.

See the Parameter associations section for possible values that can be specified.

UserVarPtr

Accepts the address of one of the following (see the Parameter associations section for specifics on which is expected):

array of type MIL_TEXT_CHAR [optionally, in C++: a reference to a MIL_STRING]
MIL_DOUBLE
MIL_INT

Specifies the address in which to write the requested information. Since the MseqInquire() function also returns the requested information, you can set this parameter to M_NULL, except when the specified InquireType requires the UserVarPtr parameter to be set to the address of a MIL_INT, MIL_DOUBLE, or MIL_TEXT_CHAR. In this case, you must set this parameter to the address of a MIL_INT, MIL_DOUBLE, or MIL_TEXT_CHAR, respectively.

See the Parameter associations section for possible values that can be returned.

Parameter associations

The tables below list possible values for the InquireType parameter and possible values returned to the UserVarPtr parameter.

For retrieving information about the H.264 compression operation settings
For retrieving information about general individual source or destination settings
For retrieving information about individual file (M_FILE) source or destination settings

The following inquire types allow you to inquire the H.264 compression settings for the sequence context (M_CONTEXT).

For retrieving information about the H.264 compression operation settings
InquireType		Description	MIL system-specific tooltip (‡)
	UserVarPtr - Possible values returned	Description
M_CODEC_TYPE		Inquires the type of codec used for the compression or decompression operation. SET (summarize) Inquires the type of codec used for the compression or decompression operation. SET (more details...)																			‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	M_QSV + M_HARDWARE	Specifies to perform the operation using hardware acceleration.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	M_QSV + M_SOFTWARE	Specifies to perform the operation in software.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
M_SETTING_AUTO_ADJUSTMENT		Inquires whether incompatible operation settings are automatically adjusted. SET (summarize) Inquires whether incompatible operation settings are automatically adjusted. SET (more details...)	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	M_DISABLE	Specifies to not automatically adjust incompatible settings. INFO	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	M_ENABLE	Specifies to automatically adjust incompatible settings. INFO	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
M_SIZE_X		Inquires the width of the elementary video stream. SET (summarize) Inquires the width of the elementary video stream. SET (more details...)	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	Value	Specifies the width, in pixels.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
M_SIZE_Y		Inquires the height of the elementary video stream. SET (summarize) Inquires the height of the elementary video stream. SET (more details...)	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	Value	Specifies the height, in pixels.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
M_STREAM_BIT_RATE +		Inquires the elementary video stream bit rate. SET (summarize) Inquires the elementary video stream bit rate. SET (more details...)	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	Value > 0	Specifies the bit rate, in Kbits/sec.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
M_STREAM_BIT_RATE_MAX +		Inquires the maximum bit rate that the elementary video stream can have. SET (summarize) Inquires the maximum bit rate that the elementary video stream can have. SET (more details...)	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	Value > 0	Specifies the maximum bit rate, in Kbits/sec.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
M_STREAM_BIT_RATE_MODE		Inquires the type of bit rate the elementary video stream will have. SET (summarize) Inquires the type of bit rate the elementary video stream will have. SET (more details...)	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	M_CONSTANT	Specifies that the bit rate will remain constant throughout the duration of the elementary video stream. INFO	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	M_VARIABLE	Specifies that the bit rate will fluctuate depending on how compressible sections of the elementary video stream are. INFO	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
M_STREAM_FRAME_RATE		Inquires the frame rate of the elementary video stream. SET (summarize) Inquires the frame rate of the elementary video stream. SET (more details...)	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	UserVarPtr extra info	Data type info: Data type: address of a MIL_DOUBLE Data type: address of a MIL_DOUBLE Data type info: Data type: address of a MIL_DOUBLE Data type: address of a MIL_DOUBLE	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	Value > 0.0	Specifies the elementary video stream's frame rate, in frames/sec.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
M_STREAM_FRAME_RATE_MODE		Inquires how the decoding frame rate, written in the header of M_FILE destination types, is established. SET (summarize) Inquires how the decoding frame rate, written in the header of M_FILE destination types, is established. SET (more details...)	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	M_CONSTANT	Specifies that the decoding frame rate written in the header of M_FILE destination types is the same as the frame rate specified with M_STREAM_FRAME_RATE.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	M_VARIABLE	Specifies that the decoding frame rate written in the header of M_FILE destination types is the average encoding frame rate, if the processor could not encode at the specified frame rate; otherwise, the frame rate specified with M_STREAM_FRAME_RATE will be written. INFO	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
M_STREAM_GROUP_OF_PICTURE_SIZE +		Inquires the group-of-pictures size. SET (summarize) Inquires the group-of-pictures size. SET (more details...)	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	Value	Specifies the group-of-pictures size, in number of frames/group. INFO	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
M_STREAM_LEVEL +		Inquires the H.264 compression level used by the compression operation. SET (summarize) Inquires the H.264 compression level used by the compression operation. SET (more details...)	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	M_LEVEL_1	Specifies the 1 compression level.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	M_LEVEL_1_1	Specifies the 1.1 compression level.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	M_LEVEL_1_2	Specifies the 1.2 compression level.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	M_LEVEL_1_3	Specifies the 1.3 compression level.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	M_LEVEL_1B	Specifies the 1B compression level.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	M_LEVEL_2	Specifies the 2 compression level.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	M_LEVEL_2_1	Specifies the 2.1 compression level.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	M_LEVEL_2_2	Specifies the 2.2 compression level.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	M_LEVEL_3	Specifies the 3 compression level.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	M_LEVEL_3_1	Specifies the 3.1 compression level.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	M_LEVEL_3_2	Specifies the 3.2 compression level.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	M_LEVEL_4	Specifies the 4 compression level.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	M_LEVEL_4_1	Specifies the 4.1 compression level.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	M_LEVEL_4_2	Specifies the 4.2 compression level.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	M_LEVEL_5	Specifies the 5 compression level.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	M_LEVEL_5_1	Specifies the 5.1 compression level.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	M_LEVEL_5_2	Specifies the 5.2 compression level.	‡														u U36
M_STREAM_PROFILE +		Inquires the H.264 compression profile. SET (summarize) Inquires the H.264 compression profile. SET (more details...)	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	M_PROFILE_BASELINE	Specifies to use the baseline profile. INFO	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	M_PROFILE_HIGH	Specifies to use the high profile. INFO	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	M_PROFILE_MAIN	Specifies to use the main profile. INFO	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
M_STREAM_QUALITY +		Inquires the H.264 compression operation priority. SET (summarize) Inquires the H.264 compression operation priority. SET (more details...)	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
	0 <= Value <= 100	Specifies the speed/quality priority. INFO	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa

Combination value for M_STREAM_BIT_RATE; M_STREAM_BIT_RATE_MAX; M_STREAM_GROUP_OF_PICTURE_SIZE; M_STREAM_LEVEL; M_STREAM_PROFILE; M_STREAM_QUALITY.

You can add the following value to the above-mentioned values to get the actual values used if MseqControl() with M_SETTING_AUTO_ADJUSTMENT was set to M_ENABLE.

For inquiring the actual values used
Combination value	Description
M_EFFECTIVE_VALUE	Inquires the actual value used by the compression operation.

You can inquire information about the following settings for any type of individual source (M_SEQ_INPUT()) or destination (M_SEQ_OUTPUT() + M_SEQ_DEST()).

For retrieving information about general individual source or destination settings
InquireType		Description
	UserVarPtr - Possible values returned	Description
M_TYPE		Inquires the type of source or destination at the specified index. SET (summarize) Inquires the type of source or destination at the specified index. SET (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	M_BUFFER_LIST	Specifies the source of the input, or destination of the output, of the sequence operation is a buffer list. INFO
	M_FILE	Specifies the source of the input, or destination of the output, of the sequence operation is a file.
	M_USER_FEED	Specifies the source of the input of the sequence operation is a manual image feed, where the images are passed individually to the sequence operation. INFO
	M_USER_HOOK	Specifies the destination of the output is the internal output buffer of the operation; if this is the only destination, you should use a user-defined hook function to retrieve the data before it is overwritten by the next frame of resulting data (MseqHookFunction() with M_FRAME_END). INFO

You can inquire information about the following settings for individual file sources or destinations (M_SEQ_INPUT() or M_SEQ_OUTPUT() + M_SEQ_DEST() defined as M_FILE).

For retrieving information about individual file (M_FILE) source or destination settings
InquireType		Description
	UserVarPtr - Possible values returned	Description
M_FILE_FORMAT		Inquires the format of the file at the specified index. SET (summarize) Inquires the format of the file at the specified index. SET (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT
	M_FILE_FORMAT_AVI	Specifies that the file is in AVI format.
	M_FILE_FORMAT_H264	Specifies that the file is in H.264 elementary video data format.
	M_FILE_FORMAT_MP4	Specifies that the file is in MP4 format.
M_STREAM_FILE_NAME +		Inquires the name of the file at the specified index. SET (summarize) Inquires the name of the file at the specified index. SET (more details...)
	UserVarPtr extra info	Data type info: Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] MORE Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] Required array size: MseqInquire ( M_STREAM_FILE_NAME + M_STRING_SIZE ) Note: When using C++, you can pass a reference to a MIL_STRING instead. In this case, the function will automatically determine the correct string size. Data type info: Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] MORE Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] Required array size: MseqInquire ( M_STREAM_FILE_NAME + M_STRING_SIZE ) Note: When using C++, you can pass a reference to a MIL_STRING instead. In this case, the function will automatically determine the correct string size.
	Value	Specifies the file name.

Combination value for M_STREAM_FILE_NAME.

You can add the following value to the above-mentioned value to get the string's length.

For getting the string size
InquireType		Description
	UserVarPtr - Possible values returned	Description
M_STRING_SIZE		Retrieves the length of the string, including the terminating null character ("\0"). (summarize) Retrieves the length of the string, including the terminating null character ("\0"). (more details...)
	UserVarPtr extra info	Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT Data type info: Data type: address of a MIL_INT Data type: address of a MIL_INT

Return value

The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information.

Compilation information

Header	Include mil.h.
Library	Use mil.lib.
DLL	Requires mil.dll.