Search Results

Go to the documentation of this file.
1 // Copyright (c) 2018 Digital Barriers
4 
18 #pragma once
19 
20 #include "EdgeVisSDK.h"
21 #include "Pimpl.h"
22 #include <string>
23 
24 namespace EdgeVisDecoderSDK
25 {
26  class FrameConfigImpl;
27 
28  class FrameConfig : public EdgeVisSDKPimpl<FrameConfigImpl>
29  {
30  public:
31 
32  enum class Type
33  {
34  H264,
35  JPEG,
36  RGB,
37  YCBCR,
38  UNKNOWN
39  };
40 
41  DB_EDGEVIS_SDK FrameConfig();
42  EdgeVisSDKPimplWeakConstructor(FrameConfig);
43 
44  DB_EDGEVIS_SDK virtual ~FrameConfig();
45 
51  DB_EDGEVIS_SDK virtual std::wstring FrameType() const;
52 
53  DB_EDGEVIS_SDK virtual FrameConfig::Type GetFrameType() const;
54 
60  DB_EDGEVIS_SDK int32_t GetFrameHeight() const;
61 
72  DB_EDGEVIS_SDK void SetFrameHeight(int32_t height);
73 
81  DB_EDGEVIS_SDK int32_t GetMaxFPS() const;
82 
92  DB_EDGEVIS_SDK void SetMaxFPS(int32_t max_fps);
93 
102  DB_EDGEVIS_SDK int32_t GetFrameWidth() const;
103 
114  DB_EDGEVIS_SDK void SetFrameWidth(int32_t width);
115 
121  DB_EDGEVIS_SDK bool HasOverlayTimeStamp() const;
122 
129  DB_EDGEVIS_SDK void SetHasOverlayTimeStamp(bool enableOverlay, bool use_ms);
130 
136  DB_EDGEVIS_SDK bool HasOverlayTimeStampMS() const;
137 
144  DB_EDGEVIS_SDK bool HasOverlayEncoderName() const;
145 
151  DB_EDGEVIS_SDK void SetHasOverlayEncoderName(bool enableOverlay);
152 
159  DB_EDGEVIS_SDK bool HasOverlayInputName() const;
160 
166  DB_EDGEVIS_SDK void SetHasOverlayInputName(bool enableOverlay);
167  };
168 }
DB_EDGEVIS_SDK void SetHasOverlayTimeStamp(bool enableOverlay, bool use_ms)
Sets if the frame should have its timestamp drawn on top.
DB_EDGEVIS_SDK bool HasOverlayTimeStamp() const
Returns if the frame should have its timestamp drawn on top.
DB_EDGEVIS_SDK void SetHasOverlayInputName(bool enableOverlay)
Sets if the frame should have the name of the encoder input it was captured from drawn on top...
DB_EDGEVIS_SDK void SetFrameHeight(int32_t height)
Sets the desired height of video frames.
DB_EDGEVIS_SDK void SetHasOverlayEncoderName(bool enableOverlay)
Sets if the frame should have the name of the encoder it was captured from drawn on top...
DB_EDGEVIS_SDK void SetFrameWidth(int32_t width)
Sets the desired width of video frames.
DB_EDGEVIS_SDK bool HasOverlayEncoderName() const
Returns if the frame should have the name of the encoder it was captured from drawn on top...
DB_EDGEVIS_SDK void SetMaxFPS(int32_t max_fps)
Sets the desired maximum number of video frames per second.
DB_EDGEVIS_SDK int32_t GetFrameWidth() const
Returns the desired width of video frames.
This is the base class for the FrameConfig objects.
Definition: FrameConfig.h:28
virtual DB_EDGEVIS_SDK std::wstring FrameType() const
Returns the type of FrameConfig this is.
The EdgeVis Decoder SDK namespace.
DB_EDGEVIS_SDK int32_t GetMaxFPS() const
Returns the desired maximum number of video frames per second.
DB_EDGEVIS_SDK int32_t GetFrameHeight() const
Returns the desired height of video frames.
DB_EDGEVIS_SDK bool HasOverlayInputName() const
Returns if the frame should have the name of the encoder input it was captured from drawn on top If t...
DB_EDGEVIS_SDK bool HasOverlayTimeStampMS() const
Returns if the frame should have its timestamp drawn on top with milliseconds included.