pureweb.client. EncoderConfiguration

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

The purpose of the view interactivity modes is to make it possible to send images of lower quality when the end user is interacting with a view, and to restore full quality when interaction stops. This way, the size of the view updates during interaction can be smaller, which provides a better trade-off between frame rate when interacting, and image quality when not interacting. The interactivity mode is set on the service using the SetViewInteracting method in the ViewManager class.

To set an EncoderConfiguration object as the default configuration for a view, use the setEncoderConfiguration method provided by the View class.

Method Summary

getFullQualityFormat
Returns the EncoderFormat object that defines the parameters (mime type, quality, etc.
getInteractiveFormat
Returns the EncoderFormat object that defines the parameters (mime type, quality, etc.

Constructor

new EncoderConfiguration(interactiveQuality, fullQuality)

Initializes a new instance of EncoderConfiguration.
Parameters:
Name Type Description
interactiveQuality pureweb.client.EncoderFormat The encoder format for the interactive quality.
fullQuality pureweb.client.EncoderFormat The encoder format for the full (non-interactive) quality.
Throws:
pureweb.NullArgumentException

Extends

  • pureweb.events.EventTarget

Method Detail

getFullQualityFormat() → {pureweb.client.EncoderFormat}

Returns the EncoderFormat object that defines the parameters (mime type, quality, etc.) to be used by the service application when sending images in full quality (non-interactive) mode.

getInteractiveFormat() → {pureweb.client.EncoderFormat}

Returns the EncoderFormat object that defines the parameters (mime type, quality, etc.) to be used by the service application when sending images in interactive mode.