Public Member Functions | Static Public Member Functions | List of all members
JPEGConverter Class Reference

A JPEG converter object. More...

#include <cvb/webstreaming/jpeg_converter.hpp>

Inherits Converter.

Public Member Functions

int Scale () const
 Get the scale of the JPEG conversion. More...
 
void SetScale (int scale)
 Set the scale of the JPEG conversion. More...
 
int Quality () const
 Get the quality of the JPEG conversion. More...
 
void SetQuality (int quality)
 Set the quality of the JPEG conversion. More...
 
- Public Member Functions inherited from Converter
void * Handle () const noexcept
 Returns C-API style handle to Converter Object. More...
 

Static Public Member Functions

static JPEGConverterPtr Create ()
 Creates a new JPEG converter. More...
 

Detailed Description

A JPEG converter object.

Converter for sending JEPG converted image data.

Member Function Documentation

◆ Create()

static JPEGConverterPtr Create ( )
inlinestatic

Creates a new JPEG converter.

Returns
The converter.
Exceptions
Anyexception derived from std::exception including CvbException.

◆ Quality()

int Quality ( ) const
inline

Get the quality of the JPEG conversion.

Returns
The quality (default 95).
Exceptions
Anyexception derived from std::exception including CvbException.

◆ Scale()

int Scale ( ) const
inline

Get the scale of the JPEG conversion.

Returns
The scale (default 8).
Exceptions
Anyexception derived from std::exception including CvbException.

◆ SetQuality()

void SetQuality ( int  quality)
inline

Set the quality of the JPEG conversion.

Parameters
[in]qualityThe quality.
Exceptions
Anyexception derived from std::exception including CvbException.

The quality must be in range 1...100.

◆ SetScale()

void SetScale ( int  scale)
inline

Set the scale of the JPEG conversion.

Parameters
[in]scaleThe scale.
Exceptions
Anyexception derived from std::exception including CvbException.

The scale must be in range 1...16.