EdgeVisDecoderSDK::AnalyticsRegion Class Reference
Detailed Description
Defines a region within the video frame within which the analytics will be applied.
The region can be inverted to use the rest of the frame to apply the analytics to. The region must have 4 vertices to define the area.
Availability
Available in version 7.3.0 of Decoder SDK. Requires a server version greater than 7.0
#include <AnalyticsRegion.h>
Public Member Functions | |
| DB_EDGEVIS_SDK int32_t | GetRegionID () const |
| Gets the region ID. More... | |
| DB_EDGEVIS_SDK bool | SetRegionID (int32_t id) |
| Sets the region ID. More... | |
| DB_EDGEVIS_SDK bool | GetEnabled () const |
| Gets the enabled state of this region. More... | |
| DB_EDGEVIS_SDK void | SetEnabled (bool enable) |
| Sets the enabled state of this region. More... | |
| DB_EDGEVIS_SDK bool | GetInclusive () const |
| Gets the inclusive state of this region. More... | |
| DB_EDGEVIS_SDK void | SetInclusive (bool inclusive) |
| Sets the inclusive state of this region. More... | |
| DB_EDGEVIS_SDK std::vector< AnalyticsRegionVertex > | GetVertices () const |
| Get the vertices used to define this region. More... | |
| DB_EDGEVIS_SDK bool | SetVertices (std::vector< AnalyticsRegionVertex > vertices) |
| Set the vertices used to define this region. More... | |
Member Function Documentation
| DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::AnalyticsRegion::GetRegionID | ( | ) | const |
Gets the region ID.
- Returns
- The region ID.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::AnalyticsRegion::SetRegionID | ( | int32_t | id | ) |
Sets the region ID.
Note that currently only one region is supported and it must have a region ID of 1.
- Parameters
-
id The region ID.
- Returns
- True if the ID was accepted, false if the ID was rejected.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::AnalyticsRegion::GetEnabled | ( | ) | const |
Gets the enabled state of this region.
- Returns
- The enable state of this region.
| DB_EDGEVIS_SDK void EdgeVisDecoderSDK::AnalyticsRegion::SetEnabled | ( | bool | enable | ) |
Sets the enabled state of this region.
- Parameters
-
enable The enable state to apply to this region.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::AnalyticsRegion::GetInclusive | ( | ) | const |
Gets the inclusive state of this region.
- Returns
- The inclusive state of this region. True indicates that the interior of the region will be used for analytics. False indicates that the area outside of the region will be used for analytics.
| DB_EDGEVIS_SDK void EdgeVisDecoderSDK::AnalyticsRegion::SetInclusive | ( | bool | inclusive | ) |
Sets the inclusive state of this region.
- Parameters
-
inclusive The inclusive state to apply to this region. True indicates that the interior of the region will be used for analytics. False indicates that the area outside of the region will be used for analytics.
| DB_EDGEVIS_SDK std::vector<AnalyticsRegionVertex> EdgeVisDecoderSDK::AnalyticsRegion::GetVertices | ( | ) | const |
Get the vertices used to define this region.
- Returns
- A vector containing 4 AnalyticsRegionVertex elements.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::AnalyticsRegion::SetVertices | ( | std::vector< AnalyticsRegionVertex > | vertices | ) |
Set the vertices used to define this region.
- Parameters
-
vertices A vector containing 4 AnalyticsRegionVertex elements.
- Returns
- True if the vertices were valid, false if the supplied vertices were invalid (eg. not 4 elements in the vector)
The documentation for this class was generated from the following file:
- SDKs/EdgeVisDecoderSDK/AnalyticsRegion.h