IKsVideoProcessing::GetPreferredAllocatorProperties method

A plug-in's implementation of IKsVideoProcessing::GetPreferredAllocatorProperties should return the allocator properties of the plug-in's input and output. Allocator properties specify the buffer count and size that are required by the plug-in.

Syntax

HRESULT GetPreferredAllocatorProperties(
  BOOL *pbInplaceTransform,
  ALLOCATOR_PROPERTIES *pInputAllocatorProperties,
  ALLOCATOR_PROPERTIES *pOutputAllocatorProperties
);

Parameters

  • pbInplaceTransform
    A pointer to a Boolean value in which the plug-in indicates if it prefers inplace transform. If the transform is inplace, the IKsVideoProcessing::ProcessInput function is not called.

  • pInputAllocatorProperties
    A pointer to an ALLOCATOR_PROPERTIES structure in which the plug-in should place input allocator properties. ALLOCATOR_PROPERTIES is defined in Baseplgin.h.

  • pOutputAllocatorProperties
    A pointer to an ALLOCATOR_PROPERTIES structure in which the plug-in should place output allocator properties.

Return value

This method returns one of the following values:

Return code Description
S_OK

Successfully filled in preferred allocator properties.

E_FAIL

Failed to specify preferred allocator properties, probably because the media type has not yet been fixed.

 

Remarks

IKsVideoProcessing is defined in Ksvidprocplugin.h. The contents of this header file are provided in Providing a Video Post-Processing Plug-in.

Although the buffer size can be inferred from image size for uncompressed video streams, note that this number is different from the image size for temporally compressed formats.

This method is a pure virtual method that is implemented by the vendor-supplied plug-in.

 

 

Send comments about this topic to Microsoft

Build date: 1/23/2012