QueueSink::Config Struct Reference

The QueueSink configuration structure. More...

Public Attributes
size_t	maxOutputBuffers = 0
	Defines the maximum number of buffers that are stored in the sink's output queue.
std::shared_ptr< BufferAllocator >	bufferAllocator
	A std::shared_ptr to a BufferAllocator that replaces sink's default allocator.
std::vector< PixelFormat >	acceptedPixelFormats
	An array of possible pixel formats that the sink can receive.

Detailed Description

The QueueSink configuration structure.

Passed to QueueSink::create(QueueSinkListener&, const Config&, Error&), QueueSink::create(const std::shared_ptr<QueueSinkListener>&, const Config&, Error&) or QueueSink::create(std::function<void(ic4::QueueSink&)>, const Config&, Error&) to configure the sink's behavior.

Member Data Documentation

acceptedPixelFormats

std::vector<PixelFormat> acceptedPixelFormats

An array of possible pixel formats that the sink can receive.

If the vector is empty, all pixel formats are accepted.

bufferAllocator

std::shared_ptr<BufferAllocator> bufferAllocator

A std::shared_ptr to a BufferAllocator that replaces sink's default allocator.

If this is nullptr, a default allocator is used.

maxOutputBuffers

size_t maxOutputBuffers = 0

Defines the maximum number of buffers that are stored in the sink's output queue.

If set to 0, the number of buffers is unlimited. If a new frame arrives at the sink, and the output queue size would exceed maxOutputBuffers, the oldest image is discarded and its buffer is added to the free queue.