ILMVMosaic Interface

Data types

MOSAIC_ATTRIBUTES:

typedef struct 
{ 
   long lSquareSize; 
   BOOL bEnabled; 
   long lDSquareSize; 
   BOOL bDEnabled; 
} MOSAIC_ATTRIBUTES;

Describes the mosaic effect properties.

Member	Description
lSquareSize	Size of the mosaic square, 1 to 64.
bEnabled	Indicates weather Mosaic effect is enabled (TRUE) or not (FALSE).
lDSquareSize	Default square size. Original default value is 1.
bDEnabled	Default mosaic Enable value. Original default value is TRUE.

CROP_ATTRIBUTES:

typedef struct 
{ 
   long lLeft; 
   long lTop; 
   long lRight; 
   long lBottom; 
   BOOL bEnabled; 
   long lDLeft; 
   long lDTop; 
   long lDRight; 
   long lDBottom; 
   BOOL bDEnabled; 
} CROP_ATTRIBUTES;

Describes the area exposed to the mosaic effect.

Member	Description
lLeft	The left coordinate of the effect area rectangle.
lTop	The top coordinate of the effect area rectangle.
lRight	The right coordinate of the effect area rectangle.
lBottom	The bottom coordinate of the effect area rectangle.
bEnabled	Enables (TRUE) or disables (FALSE) the effect area.
lDLeft	Default left. Original value is 0.
lDTop	Default top. Original value is 0.
lDRight	Default right. Original value is 1.
lDBottom	Default bottom. Original value is 1.
bDEnabled	Default effect area enable status.

Interface Methods:

HRESULT IsLEADInputPinConnected()

Parameters

None.

Description

Determines whether the filter input pin is currently connected.

Returns

S_OK if connected, S_FALSE otherwise.

HRESULT IsLEADOutputPinConnected()

Parameters

None.

Description

Determines whether the filter output pin is currently connected.

Returns

S_OK if connected, S_FALSE otherwise.

HRESULT SetMosaicAttributes(MOSAIC_ATTRIBUTES mosaic_attributes)

Parameters

mosaic_attributes

a MOSIAC_ATTRIBUTES structure that contains the mosaic attributes to set.

Description

Sets the properties for the mosaic effect.

Returns

S_OK if successful, S_FALSE otherwise.

HRESULT GetMosaicAttributes(MOSAIC_ATTRIBUTES *mosaic_attributes)

Parameters

mosaic_attributes

a valid pointer to a MOSIAC_ATTRIBUTES structure to be updated with the current mosaic attributes.

Description

Retrieves the current mosaic attributes.

Returns

S_OK if successful, S_FALSE otherwise.

HRESULT SetCropAttributes(CROP_ATTRIBUTES crop_attributes)

Parameters

crop_attributes

a CROP_ATTRIBUTES structure that contains the effect area attributes to set.

Description

Sets the effect area attributes. If successful, effect is applied only to the passed rectangle.

Returns

S_OK if successful, S_FALSE otherwise.

HRESULT GetCropAttributes(CROP_ATTRIBUTES *crop_attributes)

Parameters

crop_attributes

a valid pointer to a CROP_ATTRIBUTES structure to be updated with the current effect area attributes.

Description

Retrieves the current effect area attributes.

Returns

S_OK if successful, S_FALSE otherwise.

HRESULT GetIODimensions(long plInWidth, long plInHeight, long plOutWidth, long plOutHeight)

Parameters

plInWidth	A valid pointer to a long variable to be updated with the input media width. NULL can be passed if this value is not needed.
plInHeight	A valid pointer to a long variable to be updated with the input media height. NULL can be passed if this value is not needed.
plOutWidth	A valid pointer to a long variable to be updated with the output media width. NULL can be passed if this value is not needed.
plOutHeight	A valid pointer to a long variable to be updated with the output media height. NULL can be passed if this value is not needed.

Description

Retrieves the current media dimensions.

Returns

S_OK if successful, S_FALSE otherwise.

HRESULT GetIOBitCount(int pInBitCount, int pOutBitCount)

Parameters

pInBitCount	A valid pointer to an integer to be updated with the input media bits per pixel value. NULL can be passed if this value is not needed.
pPBitCount	A valid pointer to an integer to be updated with the output media bits per pixel value. NULL can be passed if this value is not needed.