createFrameQueueBuffer Method

Creates a single or multiple FrameQueueBuffer objects, matching the passed in FrameTypeInfo or the frame type of the passed sink.

Syntax:

Error createFrameQueueBuffer( tFrameQueueBufferPtr& rval, const FrameTypeInfo& type, void* userPtr = nullptr );
Error createFrameQueueBuffer( tFrameQueueBufferList& rval, const FrameTypeInfo& type, size_t count, void* userPtr = nullptr );
Error createFrameQueueBuffer( tFrameQueueBufferPtr& rval, const FrameTypeInfo& type, BYTE* dataPointer, size_t dataSize, void* userPtr = nullptr );

Error createFrameQueueBuffer( tFrameQueueBufferPtr& rval, const FrameSnapSink& sink, void* userPtr = nullptr );
Error createFrameQueueBuffer( tFrameQueueBufferList& rval, const FrameSnapSink& sink, size_t count, void* userPtr = nullptr );
Error createFrameQueueBuffer( tFrameQueueBufferPtr& rval, const FrameSnapSink& sink, BYTE* dataPointer, size_t dataSize, void* userPtr = nullptr );

Error createFrameQueueBuffer( tFrameQueueBufferPtr& rval, const FrameQueueSink& sink, void* userPtr = nullptr );
Error createFrameQueueBuffer( tFrameQueueBufferList& rval, const FrameQueueSink& sink, size_t count, void* userPtr = nullptr );
Error createFrameQueueBuffer( tFrameQueueBufferPtr& rval, const FrameQueueSink& sink, BYTE* dataPointer, size_t dataSize, void* userPtr = nullptr );

Parameter		Description


rval		Receives a single tFrameQueueBufferPtr or a list of tFrameQueueBufferPtr in a tFrameQueueBufferList.
type		Specifies the type of the FrameQueueBuffer to create.
sink		Specifies a sink for whose current frame type the FrameQueueBuffer is to be created.
count		The number of buffers to create.
userPtr		A pointer that is associated with the buffer. It is not used internally, but can be retrieved by calling FrameQueueBuffer::getUserPointer.
dataPointer		A pointer to a user-allocated block of memory that the FrameQueueBuffer shall use for storing its data. The FrameQueueBuffer does not take ownership of this memory block.
dataSize		Size of the user-allocated block of memory pointer to by dataPointer.

Return value:

This method returns an error object. If successful, it is set to eNOERROR. If the system cannot allocate enough memory, it is set to eOUT_OF_MEMORY.

Information:

Namespace: DShowLib
Introduced in version 3.5

<< Functions