mpi_iva_rms.h File Reference

MPI for IVA RMS (regional motion sensor) More...

#include "mpi_index.h"

Data Structures
struct	MPI_IVA_RMS_PARAM_S
	Structure for the parameters of RMS. More...
struct	MPI_IVA_RMS_REG_ATTR_S
	Struct for region attributes. More...
struct	MPI_IVA_RMS_REG_LIST_S
	Struct for region list. More...

Macros
#define	MPI_IVA_RMS_MAX_REG_NUM   50
#define	MPI_IVA_RMS_MIN_REG_NUM   1
#define	MPI_IVA_RMS_MAX_SEN   255
#define	MPI_IVA_RMS_MIN_SEN   0

Typedefs
typedef UINT32	MPI_RMS_CONF_BF

Functions
INT32	MPI_IVA_enableRegMotSens (MPI_WIN idx)
	Enable RMS (regional motion sensor) on specified video window. More...
INT32	MPI_IVA_disableRegMotSens (MPI_WIN idx)
	Disable RMS on specified video window. More...
INT32	MPI_IVA_setRegMotSensParam (MPI_WIN idx, const MPI_IVA_RMS_PARAM_S *param)
	Set RMS (regional motion sensor) parameters. More...
INT32	MPI_IVA_getRegMotSensParam (MPI_WIN idx, MPI_IVA_RMS_PARAM_S *param)
	Get RMS parameters. More...
INT32	MPI_IVA_getRegMotSens (MPI_WIN idx, MPI_IVA_RMS_REG_LIST_S *list)
	Get RMS result. More...

Detailed Description

MPI for IVA RMS (regional motion sensor)

Macro Definition Documentation

#define MPI_IVA_RMS_MAX_REG_NUM   50

Max RMS region number.

#define MPI_IVA_RMS_MAX_SEN   255

Max RMS sensitivity.

#define MPI_IVA_RMS_MIN_REG_NUM   1

Min RMS region number.

#define MPI_IVA_RMS_MIN_SEN   0

Min RMS sensitivity.

Typedef Documentation

typedef UINT32 MPI_RMS_CONF_BF

Bit-filed of confidence.

Function Documentation

INT32 MPI_IVA_disableRegMotSens

(

MPI_WIN

idx

)

Disable RMS on specified video window.

Parameters

[in]

idx

Index of the video window that is to be configured.

Returns

The execution result.

Return values

MPI_SUCCESS	success.
MPI_ERR_DEV_INVALID_WIN	invalid video window index.
MPI_ERR_DEV_INVALID_CHN	invalid video channel index.
MPI_ERR_DEV_INVALID_DEV	invalid device index.
MPI_ERR_DEV_NOT_EXIST	device/channel not exist.
MPI_ERR_DEV_NOT_PERM	object detection hasn't been enabled.
MPI_ERR_DEV_CONFLICT	object detection run on another video window.
MPI_FAILURE	unexpected fail.

See also

MPI_IVA_enableRegMotSens()

INT32 MPI_IVA_enableRegMotSens

(

MPI_WIN

idx

)

Enable RMS (regional motion sensor) on specified video window.

Parameters

[in]

idx

Index of the video window that is to be configured.

Returns

The execution result.

Return values

MPI_SUCCESS	success.
MPI_ERR_DEV_INVALID_WIN	invalid video window index.
MPI_ERR_DEV_INVALID_CHN	invalid video channel index.
MPI_ERR_DEV_INVALID_DEV	invalid device index.
MPI_ERR_DEV_NOT_EXIST	device/channel not exist.
MPI_ERR_DEV_BUSY	object detection has been enabled.
MPI_FAILURE	unexpected fail.

See also

MPI_IVA_disableRegMotSens()

INT32 MPI_IVA_getRegMotSens	(	MPI_WIN	idx,
		MPI_IVA_RMS_REG_LIST_S *	rms_list
	)

Get RMS result.

Parameters

[in]	idx	Index of the video window that is to retrieve RMS result.
[out]	list	RMS result.

Returns

The execution result.

Return values

MPI_SUCCESS	success.
MPI_ERR_DEV_NULL_POINTER	input pointer is NULL.
MPI_ERR_DEV_INVALID_WIN	invalid video window index.
MPI_ERR_DEV_INVALID_CHN	invalid video channel index.
MPI_ERR_DEV_INVALID_DEV	invalid device index.
MPI_ERR_DEV_NOT_EXIST	device/channel not exist.
MPI_FAILURE	unexpected fail.

See also

MPI_IVA_enableRegMotSens()

INT32 MPI_IVA_getRegMotSensParam	(	MPI_WIN	idx,
		MPI_IVA_RMS_PARAM_S *	rms_param
	)

Get RMS parameters.

Parameters

[in]	idx	Index of the video window that is to retrieve attributes.
[out]	param	RMS parameters.

Returns

The execution result.

Return values

MPI_SUCCESS	success.
MPI_ERR_DEV_NULL_POINTER	input pointer is NULL.
MPI_ERR_DEV_INVALID_WIN	invalid video window index.
MPI_ERR_DEV_INVALID_CHN	invalid video channel index.
MPI_ERR_DEV_INVALID_DEV	invalid device index.
MPI_ERR_DEV_NOT_EXIST	device/channel not exist.
MPI_FAILURE	unexpected fail.

See also

MPI_IVA_setRegMotSensParam()

INT32 MPI_IVA_setRegMotSensParam	(	MPI_WIN	idx,
		const MPI_IVA_RMS_PARAM_S *	rms_param
	)

Set RMS (regional motion sensor) parameters.

Parameters

[in]	idx	Index of the video window that is to be configured.
[in]	param	RMS parameters.

Returns

The execution result.

Return values

MPI_SUCCESS	success.
MPI_ERR_DEV_NULL_POINTER	input pointer is NULL.
MPI_ERR_DEV_INVALID_WIN	invalid video window index.
MPI_ERR_DEV_INVALID_CHN	invalid video channel index.
MPI_ERR_DEV_INVALID_DEV	invalid device index.
MPI_ERR_DEV_INVALID_PARAM	invalid parameters.
MPI_ERR_DEV_NOT_EXIST	device/channel not exist.
MPI_FAILURE	unexpected fail.

See also

MPI_IVA_getRegMotSensParam()