C++ API Library Reference  4.3.2-74-ge1d4cca
Classes | Public Functions | List of all members
EncoderConfiguration Class Reference

The EncoderConfiguration class is used to define the encoding format (mime type) and encoding quality for each view in the application. It provides two EncoderFormat objects: one for full quality mode, and one for interactive quality mode (refer to the ViewManager class for more information on interactivity modes).

PureWeb comes with a default service-side encoder configuration, which gets passed to the client applications; therefore, you would only use this class if you wanted to overwrite the default encoder configuration by providing your own EncoderFormat objects. If you do create a new encoder configuration, use the SetDefaultEncoderConfiguration method in the ViewManager class to set it as the default.

Classes

struct  SupportedEncoderMimeTypes
 

Public Functions

EncoderFormat const & FullQualityFormat () const
 
EncoderFormat const & InteractiveFormat () const
 
Constructors and Destructors
 EncoderConfiguration ()
 
 EncoderConfiguration (EncoderFormat const &interactiveQuality, EncoderFormat const &fullQuality)
 
 ~EncoderConfiguration ()
 

Usage Description

EncoderFormat const & FullQualityFormat ( ) const

Gets a constant reference to the EncoderFormat object that defines the parameters (mime type, quality, etc.) to be used when sending images in full quality (non-interactive) mode.

EncoderFormat const & InteractiveFormat ( ) const

Gets a constant reference to the EncoderFormat object that defines the parameters (mime type, quality, etc.) to be used when sending images in interactive mode.