Pleora Technologies Inc. eBUS SDK v6.5.1.6797 API



Public Member Functions | List of all members
PvCompressionFilter Class Reference

#include <PvCompressionFilter.h>

Public Member Functions

 PvCompressionFilter ()
 Constructor.
 
virtual ~PvCompressionFilter ()
 Destructor.
 
PvResult Execute (const PvBuffer *aIn, PvBuffer *aOut)
 Compresses aIn into aOut. More...
 
PvResult SetThreadCount (uint32_t aCount)
 Sets the maximum of threads to use for compression. Not supported for compression. More...
 
uint32_t GetThreadCount () const
 Returns how many threads are used for compression. More...
 
PvResult GetThreadsPriority (uint32_t &aPriority) const
 Gets the thread priority of the filter's worker threads. More...
 
PvResult SetThreadsPriority (uint32_t aPriority)
 Sets the thread priority of the filter's worker threads. More...
 
PvResult SetEncoding (PvEncodingEnum aValue)
 Sets the encoding used when compressing the image. More...
 
PvEncodingEnum GetEncoding () const
 Returns the encoding used when compressing the image.
 
- Public Member Functions inherited from IPvFilter
 IPvFilter ()
 Constructor.
 
virtual ~IPvFilter ()
 Destructor.
 

Detailed Description

Filter used for image compression.

Member Function Documentation

◆ Execute()

PvResult PvCompressionFilter::Execute ( const PvBuffer *  aIn,
PvBuffer *  aOut 
)
virtual

Compresses aIn into aOut.

Parameters
aIn[in] Input buffer.
aOut[in] Output buffer.
Returns
Includes:

Implements IPvFilter.

◆ GetThreadCount()

uint32_t PvCompressionFilter::GetThreadCount ( ) const
virtual

Returns how many threads are used for compression.

Returns
How many threads are used for compression.

Implements IPvFilter.

◆ GetThreadsPriority()

PvResult PvCompressionFilter::GetThreadsPriority ( uint32_t &  aPriority) const
virtual

Gets the thread priority of the filter's worker threads.

Parameters
aPriority[out] Output reference to the worker threads priority.
Returns
Includes:

Implements IPvFilter.

◆ SetEncoding()

PvResult PvCompressionFilter::SetEncoding ( PvEncodingEnum  aValue)

Sets the encoding used when compressing the image.

Parameters
aValue[in] Encoding to be used by the filter.
Returns
Includes:

◆ SetThreadCount()

PvResult PvCompressionFilter::SetThreadCount ( uint32_t  aCount)
virtual

Sets the maximum of threads to use for compression. Not supported for compression.

Parameters
aCount[in] How many threads to use for compression.
Returns
Includes:

Implements IPvFilter.

◆ SetThreadsPriority()

PvResult PvCompressionFilter::SetThreadsPriority ( uint32_t  aPriority)
virtual

Sets the thread priority of the filter's worker threads.

Only one worker thread is created. Setting thread priority isn't supported.

Returns
Includes:

Implements IPvFilter.

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

Copyright (c) 2002-2024 Pleora Technologies Inc.
www.pleora.com