Pleora Technologies Inc. eBUS SDK v6.5.1.6797 API



PvSessionInfoSDP.h
1 // *****************************************************************************
2 //
3 // Copyright (c) 2007, Pleora Technologies Inc., All rights reserved.
4 //
5 // *****************************************************************************
6 
7 #ifndef __PV_SESSIONINFOSDP_H__
8 #define __PV_SESSIONINFOSDP_H__
9 
10 #include <PvSystemLib.h>
11 #include <PvSystemEnums.h>
12 
13 
14 class PvInterface;
15 
21 class PV_SYSTEM_API PvSessionInfoSDP
22 {
23 public:
24 
28  virtual ~PvSessionInfoSDP();
29 
35  PvSessionInfoSDP *Copy() const;
36 
42  uint32_t GetSessionID() const;
43 
50  uint32_t GetSessionVersion() const;
51 
57  std::string GetSessionName() const;
58 
64  std::string GetSessionInfo() const;
65 
71  PvString GetConnectionIP() const;
72 
78  PvString GetMediaType() const;
79 
85  uint16_t GetMediaTransportPort() const;
86 
92  PvString GetMediaSampling() const;
93 
99  uint16_t GetMediaDepth() const;
100 
106  PvString GetMediaColorimetry() const;
107 
113  uint32_t GetMediaWidth() const;
114 
120  uint32_t GetMediaHeight() const;
121 
127  uint32_t GetMediaFramerate() const;
128 
134  bool GetMediaInterlaced() const;
135 
141  PvString GetContent() const;
142 
148  PvString GetLicenseMessage() const;
149 
155  PvString GetDisplayID() const;
156 
162  PvString GetUniqueID() const;
163 
169  PvString GetConnectionID() const;
170 
176  bool IsConfigurationValid() const;
177 
183  bool IsLicenseValid() const;
184 
190  const PvInterface *GetInterface() const;
191 
192 protected:
193 
194 #ifndef PV_GENERATING_DOXYGEN_DOC
195 
199  const PvSessionInfoSDP &operator=( const PvSessionInfoSDP &aFrom );
200 
204  void Init();
205 
211  void SetLicenseValid( bool aValue ) { mLicenseValid = aValue; }
212 
218  void SetConnectionID( const std::string &aValue ) { *mConnectionID = aValue; }
219 
225  void SetDisplayID( const std::string &aValue ) { *mDisplayID = aValue; }
226 
232  void SetUniqueID( const std::string &aValue ) { *mUniqueID = aValue; }
233 
239  void SetCompareID( const std::string &aValue ) { *mCompareID = aValue; }
240 
246  void SetLicenseMessage( const std::string &aValue ) { *mLicenseMessage = aValue; }
247 
253  std::string *GetCompareID() { return mCompareID; }
254 
255 #endif // PV_GENERATING_DOXYGEN_DOC
256 
257 private:
258 
259  bool mLicenseValid;
260  std::string *mConnectionID;
261  std::string *mDisplayID;
262  std::string *mUniqueID;
263  std::string *mCompareID;
264  std::string *mLicenseMessage;
265  std::string *mContent;
266 
267  const PvInterface *mInterface;
268 
269  // Not implemented
270  PvSessionInfoSDP();
271  PvSessionInfoSDP( const PvSessionInfoSDP & );
272 
273 };
274 
275 
276 #endif // __PV_SESSIONINFOSDP_H__
277 
PvSystemEnums.h
PvSystem library enumerations.
PvInterface
Represents one interface (network adapter or USB host controller) on a system (the PC)
Definition: PvInterface.h:33
PvSessionInfoSDP
A class to read every SDP attribute for a given session.
Definition: PvSessionInfoSDP.h:22
PvSessionInfoSDP::GetMediaType
PvString GetMediaType() const
Gets the media type (typically video).
PvSessionInfoSDP::GetMediaDepth
uint16_t GetMediaDepth() const
Gets the depth of each sample (e.g. 8 bits).
PvSessionInfoSDP::GetConnectionID
PvString GetConnectionID() const
Gets the connection ID.
PvSessionInfoSDP::GetMediaFramerate
uint32_t GetMediaFramerate() const
Gets the frame rate.
PvSessionInfoSDP::IsConfigurationValid
bool IsConfigurationValid() const
Checks if the configuration is valid.
PvSessionInfoSDP::GetMediaTransportPort
uint16_t GetMediaTransportPort() const
Gets the port to which the media is sent.
PvSessionInfoSDP::IsLicenseValid
bool IsLicenseValid() const
Checks if the license is valid.
PvSessionInfoSDP::GetMediaSampling
PvString GetMediaSampling() const
Gets the sampling (e.g. RGB).
PvSessionInfoSDP::~PvSessionInfoSDP
virtual ~PvSessionInfoSDP()
Virtual destructor.
PvSessionInfoSDP::GetMediaColorimetry
PvString GetMediaColorimetry() const
Gets the colorimetry.
PvSessionInfoSDP::GetInterface
const PvInterface * GetInterface() const
Gets the PvInterface where this session is discovered.
PvSessionInfoSDP::GetMediaHeight
uint32_t GetMediaHeight() const
Gets the height.
PvSessionInfoSDP::GetContent
PvString GetContent() const
Gets the content of the session (e.g. h264)
PvSessionInfoSDP::GetUniqueID
PvString GetUniqueID() const
Gets the unique ID.
PvSessionInfoSDP::GetSessionID
uint32_t GetSessionID() const
Gets the session identifier.
PvSessionInfoSDP::GetMediaInterlaced
bool GetMediaInterlaced() const
Returns if the media is interlaced.
PvSessionInfoSDP::GetMediaWidth
uint32_t GetMediaWidth() const
Gets the width.
PvSessionInfoSDP::GetSessionName
std::string GetSessionName() const
Gets the session name.
PvSessionInfoSDP::GetSessionVersion
uint32_t GetSessionVersion() const
Gets the SDP version (starts at 0).
PvSessionInfoSDP::Copy
PvSessionInfoSDP * Copy() const
Copies the PvSessionInfoSDP.
PvSessionInfoSDP::GetLicenseMessage
PvString GetLicenseMessage() const
Gets a message about the license.
PvSessionInfoSDP::GetSessionInfo
std::string GetSessionInfo() const
Gets all the information about the session.
PvSessionInfoSDP::GetConnectionIP
PvString GetConnectionIP() const
Gets the IP to connect to the session.
PvSessionInfoSDP::GetDisplayID
PvString GetDisplayID() const
Gets the display identifier.
PvString
String class.
Definition: PvString.h:26

Copyright (c) 2002-2024 Pleora Technologies Inc.
www.pleora.com