Open Inventor Release 2023.2.2
 
Loading...
Searching...
No Matches
EncodedFrame.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-2023 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#include <string>
25#include <memory>
26
27namespace RemoteViz
28{
29 namespace Rendering
30 {
31 class EncodedFrameImpl;
32
44 class RENDERSERVICE_API EncodedFrame
45 {
46
48 friend class ConnectionImpl;
51 public:
52
62
67
72
77
82
87 size_t getBufferSize() const;
88
94
99 size_t getId() const;
100
105 bool isLossless() const;
106
113 bool isInteractive() const;
114
119 std::string getMessage() const;
120
121 private:
124 std::shared_ptr<EncodedFrameImpl> getImpl() const;
127 private:
128
130 std::shared_ptr<EncodedFrameImpl> pImpl;
131
132 };
133 }
134}
<a href="IconLegend.html"><img src="extRV.gif" alt="RemoteViz" border="0"></a>
bool isLossless() const
Returns if the frame is lossless.
EncodedFrame(const EncodedFrame &obj)
Copy constructor.
std::string getMessage() const
Gets the frame message.
EncodingFormat getEncodingFormat() const
Gets the frame encoding format.
size_t getId() const
Gets the frame id.
bool isInteractive() const
Returns if an user interaction is in progress when the frame has been encoded.
size_t getBufferSize() const
Gets the frame buffer size in bytes.
EncodedFrame & operator=(const EncodedFrame &obj)
Copy assignment operator.