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

The IViewManager interface manages the views streamed from the service application. Most calls may only be made in the UI thread unless otherwise specified.

Public Functions

virtual EncoderConfiguration DefaultEncoderConfiguration () const =0
 
virtual void RefreshViews ()=0
 
virtual void RegisterView (String const &viewName, IRenderedView *pView)=0
 
virtual void RenderViewDeferred (String const &viewName)=0
 
virtual void RenderViewImmediate (String const &viewName)=0
 
virtual void SetDefaultEncoderConfiguration (EncoderConfiguration const &encoder)=0
 
virtual void SetViewImageFormat (String const &viewName, CSI::PureWeb::Server::ViewImageFormat const &format)=0
 
virtual void SetViewInteracting (String const &viewName, bool isInteracting)=0
 
virtual bool UnregisterView (String const &viewName)=0
 
virtual CSI::PureWeb::Server::ViewImageFormat ViewImageFormat (String const &viewName) const =0
 
Constructors and Destructors
virtual ~IViewManager ()
 
Deprecated
virtual int MaxImageQuality () const =0
 
virtual void SetMaxImageQuality (int value)=0
 
virtual int MinImageQuality () const =0
 
virtual void SetMinImageQuality (int value)=0
 
virtual int FullImageQuality () const =0
 
virtual void SetFullImageQuality (int value)=0
 
virtual int InteractiveImageQuality () const =0
 
virtual void SetInteractiveImageQuality (int value)=0
 

Usage Description

virtual EncoderConfiguration DefaultEncoderConfiguration ( ) const
pure virtual

Returns the encoder configuration currently set as the default. This default is set by the client-side API when the client first connects.

Implemented in ViewManager.

virtual int FullImageQuality ( ) const
pure virtual
Note
This method is deprecated, as image encoding and quality is now set using the client-side APIs.

Returns the value currently set as the full (non-interactive) image quality. Can be accessed from any thread.

Implemented in ViewManager.

virtual int InteractiveImageQuality ( ) const
pure virtual
Note
This method is deprecated, as image encoding and quality is now set using the client-side APIs.

Returns the value currently set as the interactive image quality. Can be accessed from any thread.

Implemented in ViewManager.

virtual int MaxImageQuality ( ) const
pure virtual
Note
This method is deprecated, as image encoding and quality is now set using the client-side APIs.

Returns the value currently set as the maximum image quality.

Implemented in ViewManager.

virtual int MinImageQuality ( ) const
pure virtual
Note
This method is deprecated, as image encoding and quality is now set using the client-side APIs.

Returns the value currently set as the minimum image quality.

Implemented in ViewManager.

virtual void RefreshViews ( )
pure virtual

Causes all views to be re-rendered. This method is called automatically when a client calls refresh on a view.

Implemented in ViewManager.

virtual void RegisterView ( String const &  viewName,
IRenderedView pView 
)
pure virtual

Registers the specified view with StateManager.

Parameters
viewNameThe name that you want to give to the view. This name will act as a unique ID, and both the service and the client must use this name when referring to the view.
pViewThe view that you are registering.

Implemented in ViewManager.

virtual void RenderViewDeferred ( String const &  viewName)
pure virtualinherited

Notifies StateManager that the image in the specified view has been updated and needs to be rendered. The view image bits will be acquired later via the view's IRenderedView interface (the timing of the call to RenderView is not configurable; this is handled automatically by PureWeb).

Implemented in ViewManager.

virtual void RenderViewImmediate ( String const &  viewName)
pure virtualinherited

Notifies StateManager that the image in the specified view has been updated needs to be rendered. The view image bits will be acquired immediately via the view's IRenderedView interface. This must be called on the UI thread.

Implemented in ViewManager.

virtual void SetDefaultEncoderConfiguration ( EncoderConfiguration const &  encoder)
pure virtual

Sets the default encoder configuration; this is called automatically when a client initializes a view.

Parameters
encoderThe encoder configuration that you want clients to receive as default when they first connect.

Implemented in ViewManager.

virtual void SetFullImageQuality ( int  value)
pure virtual
Note
This method is deprecated, as image encoding and quality is now set using the client-side APIs.

Sets the value for the full image quality. This represents the quality of the images that the service will send to the clients when the end user is not interacting with the images

Implemented in ViewManager.

virtual void SetInteractiveImageQuality ( int  value)
pure virtual
Note
This method is deprecated, as image encoding and quality is now set using the client-side APIs.

Sets the value for the interactive image quality. This represents the quality of the images that the service will send to the clients when the end user is interacting with the images.

Implemented in ViewManager.

virtual void SetMaxImageQuality ( int  value)
pure virtual
Note
This method is deprecated, as image encoding and quality is now set using the client-side APIs.

Sets the value for the maximum image quality. Changing this value will automatically adjust dependent properties FullImageQuality and InteractiveImageQuality if necessary.

Implemented in ViewManager.

virtual void SetMinImageQuality ( int  value)
pure virtual
Note
This method is deprecated, as image encoding and quality is now set using the client-side APIs.

Sets the value for the minimum image quality. Changing this value will automatically adjust dependent properties FullImageQuality and InteractiveImageQuality if necessary.

Implemented in ViewManager.

virtual void SetViewImageFormat ( String const &  viewName,
CSI::PureWeb::Server::ViewImageFormat const &  format 
)
pure virtualinherited

Sets the view image format (pixel format, scan line order and alignment) for the specified view.

The main purpose of this method is to overwrite framework defaults when needed. For example, the default pixel format of images in a PureWeb C++ service is BGR 24, but the default pixel format of a QImage in Qt is RGB 24. When using the PureWeb C++ API in Qt, therefore, you would use SetViewImageFormat to overwrite the default C++ image format to that expected by Qt. You would call this method before using RenderView to stream the image.

Implemented in ViewManager.

virtual void SetViewInteracting ( String const &  viewName,
bool  isInteracting 
)
pure virtualinherited

Sets the interactive mode for the specified view to either true or false.

The SetViewInteracting method is used to notify StateManager when user interaction begins and when it stops. For example, you could set the interactive mode to true on a mouse down event, and set it back to false on a mouse up event. Once this is in place, you can configure the image quality values for the interactive and non-interactive modes using the client-side APIs.

Implemented in ViewManager.

virtual bool UnregisterView ( String const &  viewName)
pure virtual

Unregisters the specified view.

Implemented in ViewManager.

virtual CSI::PureWeb::Server::ViewImageFormat ViewImageFormat ( String const &  viewName) const
pure virtualinherited

Returns the current view image format (pixel format, scan line order and alignment) for the specified view.

Implemented in ViewManager.