Open Inventor Release 2024.2.1
 
Loading...
Searching...
No Matches
ConnectionSettings.h
1/*=======================================================================
2 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.), ***
3 *** AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT. ***
4 *** ***
5 *** REPRODUCTION, DISCLOSURE, OR USE, IN WHOLE OR IN PART, OTHER THAN AS ***
6 *** SPECIFIED IN THE LICENSE ARE NOT TO BE UNDERTAKEN EXCEPT WITH PRIOR ***
7 *** WRITTEN AUTHORIZATION OF FEI S.A.S. ***
8 *** ***
9 *** RESTRICTED RIGHTS LEGEND ***
10 *** USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS ***
11 *** WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN ***
12 *** SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT ***
13 *** CLAUSE AT FAR 52.227-19 OR SUBPARAGRAPH (C)(1)(II) OF THE RIGHTS IN ***
14 *** TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013. ***
15 *** ***
16 *** COPYRIGHT (C) 1996-2022 BY FEI S.A.S, ***
17 *** BORDEAUX, FRANCE ***
18 *** ALL RIGHTS RESERVED ***
19**=======================================================================*/
20
21#pragma once
22
23#include <Inventor/sys/port.h>
24
25#include <RemoteViz/Rendering/FrameEncoders.h>
26#include <SoDeprecationRules.h>
27
28#include <memory>
29
30namespace RemoteViz
31{
32 namespace Rendering
33 {
34
35 class IFrameEncodingPolicy;
36 class ConnectionSettingsImpl;
51 class RENDERSERVICE_API ConnectionSettings
52 {
53
55 friend class ConnectionImpl;
58 public:
59
60#if 1 SoDEPRECATED
73 void setMaxFPS(unsigned int value);SoDEPRECATED
82 unsigned int getMaxFPS() const;
84
85#endif
96 void setKeepAliveTimeOut(unsigned int value);
105 unsigned int getKeepAliveTimeOut() const;
107
109
115 std::shared_ptr<const FrameEncoders> getFrameEncoders() const;
116
124 bool isSupportedEncoders(std::shared_ptr<const FrameEncoders> frameEncoders) const;
126
128
138 void setFrameEncodingPolicy(std::shared_ptr<IFrameEncodingPolicy> policy);
140
141
142 private:
145 std::shared_ptr<ConnectionSettingsImpl> getImpl() const;
148 private:
151
153 ConnectionSettings(const ConnectionSettings&) = delete;
154 ConnectionSettings& operator= (const ConnectionSettings&) = delete;
155
157 std::shared_ptr<ConnectionSettingsImpl> pImpl;
158 };
159
160 }
161}
<a href="IconLegend.html"><img src="extRV.gif" alt="RemoteViz" border="0"></a>
std::shared_ptr< const FrameEncoders > getFrameEncoders() const
Gets the frame encoders used by the connection.
unsigned int getKeepAliveTimeOut() const
Gets the keepalive timeout (ms).
SoDEPRECATED unsigned int getMaxFPS() const
Gets the maximum number of frames per second sent to the client.
void setFrameEncodingPolicy(std::shared_ptr< IFrameEncodingPolicy > policy)
Sets the frame encoding policy used by the Connection.
void setKeepAliveTimeOut(unsigned int value)
Sets the keepalive timeout (ms).
SoDEPRECATED void setMaxFPS(unsigned int value)
Sets the frame encoding policy to KeepFrameQualityPolicy (see setFrameEncodingPolicy) and the FPS tar...
bool isSupportedEncoders(std::shared_ptr< const FrameEncoders > frameEncoders) const
Returns if encoders are supported by the host.