The CompressionFilter class is a subclass of Filter that performs compression. More...

#include <Filter.hpp>

Inheritance diagram for ob::CompressionFilter:

Public Member Functions
	CompressionFilter ()

void	setCompressionParams (OBCompressionMode mode, void *params)
	Set the compression parameters.

Public Member Functions inherited from ob::Filter
	Filter ()

	Filter (std::shared_ptr< FilterImpl > impl)

virtual	~Filter ()=default

virtual void	reset ()
	ReSet the filter, freeing the internal cache, stopping the processing thread, and clearing the pending buffer frame when asynchronous processing is used.

void	enable (bool enable)
	enable the filter

bool	isEnabled ()
	Return Enable State.

virtual std::shared_ptr< Frame >	process (std::shared_ptr< Frame > frame)
	Processes a frame synchronously.

virtual void	pushFrame (std::shared_ptr< Frame > frame)
	Pushes the pending frame into the cache for asynchronous processing.

virtual void	setCallBack (FilterCallback callback)
	Set the callback function for asynchronous processing.

virtual const char *	type ()
	Get the type of filter.

template<typename T >
bool	is ()
	Check if the runtime type of the filter object is compatible with a given type.

template<typename T >
std::shared_ptr< T >	as ()
	Convert the filter object to a target type.

Additional Inherited Members
Protected Attributes inherited from ob::Filter
std::shared_ptr< FilterImpl >	impl_

std::string	type_

Detailed Description

The CompressionFilter class is a subclass of Filter that performs compression.

Definition at line 180 of file Filter.hpp.

Constructor & Destructor Documentation

ob::CompressionFilter::CompressionFilter ( )

void ob::CompressionFilter::setCompressionParams	(	OBCompressionMode	mode,
		void *	params
	)

Set the compression parameters.

Parameters

mode	The compression mode: OB_COMPRESSION_LOSSLESS or OB_COMPRESSION_LOSSY.
params	The compression parameters. When mode is OB_COMPRESSION_LOSSLESS, params is NULL.

The documentation for this class was generated from the following file:

E:/Projects/Jenkins/workspace/OrbbecSDK/libobsensor/include/libobsensor/hpp/Filter.hpp