Detailed Description
Defines the area of interest configuration to use for a video input.
Defining an area of interest allows the encoder to encode the specified areas of the frame using more bandwidth to give greater detail. This can be useful on low-bandwidth links to encode only specific areas of the frame.
Availability
Available in version 7.4.0 of Decoder SDK. Requires a server version greater than 7.0
#include <AreaOfInterestConfig.h>
Public Member Functions | |
| DB_EDGEVIS_SDK int32_t | GetInput () const |
| Gets the input that this area of interest configuration applies to. More... | |
| DB_EDGEVIS_SDK bool | SetInput (const int32_t input) |
| Sets the input that this area of interest configuration will apply to. More... | |
| DB_EDGEVIS_SDK bool | GetEnabled () const |
| Gets the enabled state of area of interest on this input. More... | |
| DB_EDGEVIS_SDK bool | SetEnabled (const bool enable) |
| Sets the enabled state for area of interest on this input. More... | |
| DB_EDGEVIS_SDK int32_t | GetRows () const |
| Gets the number of rows for area of interest on this input. More... | |
| DB_EDGEVIS_SDK bool | SetRows (const int32_t rows) |
| Sets the number of rows for area of interest on this input. More... | |
| DB_EDGEVIS_SDK int32_t | GetColumns () const |
| Gets the number of columns for area of interest on this input. More... | |
| DB_EDGEVIS_SDK bool | SetColumns (const int32_t columns) |
| Sets the number of columns for area of interest on this input. More... | |
| DB_EDGEVIS_SDK int32_t | GetBias () const |
| Gets the bandwidth bias for area of interest on this input. More... | |
| DB_EDGEVIS_SDK bool | SetBias (const int32_t bias) |
| Sets the number of columns for area of interest on this input. More... | |
| DB_EDGEVIS_SDK bool | GetBlur () const |
| Area of interest can operate in Blur mode or Bit Allocation mode. More... | |
| DB_EDGEVIS_SDK bool | SetBlur (const bool blur) |
| Sets mode of operation of area of interest. More... | |
| DB_EDGEVIS_SDK std::vector< int8_t > | GetRegionMap () const |
| Gets the selected region map for area of interest on this input. More... | |
| DB_EDGEVIS_SDK bool | SetRegionMap (const std::vector< int8_t > ®ion_map) |
| Sets the selected region map for area of interest on this input. More... | |
Member Function Documentation
| DB_EDGEVIS_SDK int32_t EdgeVisSDKCore::AreaOfInterestConfig::GetInput | ( | ) | const |
Gets the input that this area of interest configuration applies to.
- Returns
- The zero-based input index that this area of interest config is associated with. A value of -1 indicates that the area of interest config is global and not per-input.
| DB_EDGEVIS_SDK bool EdgeVisSDKCore::AreaOfInterestConfig::SetInput | ( | const int32_t | input | ) |
Sets the input that this area of interest configuration will apply to.
- Parameters
-
input The zero-based input index that this analytics config shall be associated with. This value is ignored if the encoder is using a global area of interest config.
- Returns
- True if the input was accepted, false if the input was rejected.
| DB_EDGEVIS_SDK bool EdgeVisSDKCore::AreaOfInterestConfig::GetEnabled | ( | ) | const |
Gets the enabled state of area of interest on this input.
- Returns
- The enable state of area of interest on this input.
| DB_EDGEVIS_SDK bool EdgeVisSDKCore::AreaOfInterestConfig::SetEnabled | ( | const bool | enable | ) |
Sets the enabled state for area of interest on this input.
- Parameters
-
enable True to enable area of interest for this input, false to disable area of interest for this input.
| DB_EDGEVIS_SDK int32_t EdgeVisSDKCore::AreaOfInterestConfig::GetRows | ( | ) | const |
Gets the number of rows for area of interest on this input.
- Returns
- The number of rows used for area of interest for this input.
| DB_EDGEVIS_SDK bool EdgeVisSDKCore::AreaOfInterestConfig::SetRows | ( | const int32_t | rows | ) |
Sets the number of rows for area of interest on this input.
- Parameters
-
rows The number of rows to use for area of interest for this input.
- Returns
- True if the number of rows was accepted, false if it was rejected.
| DB_EDGEVIS_SDK int32_t EdgeVisSDKCore::AreaOfInterestConfig::GetColumns | ( | ) | const |
Gets the number of columns for area of interest on this input.
- Returns
- The number of columns used for area of interest for this input.
| DB_EDGEVIS_SDK bool EdgeVisSDKCore::AreaOfInterestConfig::SetColumns | ( | const int32_t | columns | ) |
Sets the number of columns for area of interest on this input.
- Parameters
-
columns The number of columns to use for area of interest for this input.
- Returns
- True if the number of columns was accepted, false if it was rejected.
| DB_EDGEVIS_SDK int32_t EdgeVisSDKCore::AreaOfInterestConfig::GetBias | ( | ) | const |
Gets the bandwidth bias for area of interest on this input.
- Returns
- The bandwidth bias figure in use when encoding the area of interest for this input.
| DB_EDGEVIS_SDK bool EdgeVisSDKCore::AreaOfInterestConfig::SetBias | ( | const int32_t | bias | ) |
Sets the number of columns for area of interest on this input.
- Parameters
-
bias The bandwidth bias figure to use when encoding the area of interest for this input. A value of 0 results in no bandwidth bias for the selected region. A value of 32 results in all available bandwidth being used to code the area of interest only. Values outwith the range 0-32 are invalid and will be rejected.
- Returns
- True if the bias was accepted, false if it was rejected.
| DB_EDGEVIS_SDK bool EdgeVisSDKCore::AreaOfInterestConfig::GetBlur | ( | ) | const |
Area of interest can operate in Blur mode or Bit Allocation mode.
This function returns the currently configured mode.
- Returns
- The current mode of operation of area of interest. True for blur, false for bit allocation
| DB_EDGEVIS_SDK bool EdgeVisSDKCore::AreaOfInterestConfig::SetBlur | ( | const bool | blur | ) |
Sets mode of operation of area of interest.
- Parameters
-
blur The mode to use when applying area of interest. True specifies to use a blur operation, false specifies a bit allocation operation.
- Returns
- True if the value was accepted, false if it was rejected.
| DB_EDGEVIS_SDK std::vector<int8_t> EdgeVisSDKCore::AreaOfInterestConfig::GetRegionMap | ( | ) | const |
Gets the selected region map for area of interest on this input.
The region map contains a 1 if the corresponding block is within the area of interest or a 0 if it is not included in the area of interest.
The first entry in the regionMap corresponds to the top left corner of the frame and the last entry corresponds to the bottom right corner, with the entries in between moving from left to right across the frame.
- Returns
- A vector of size rows x columns representing the selected region grid. Each element in the vector contains either a 0 to indicate that it is not included in the area of interest, or a 1 to indicate that it is within the area of interest.
| DB_EDGEVIS_SDK bool EdgeVisSDKCore::AreaOfInterestConfig::SetRegionMap | ( | const std::vector< int8_t > & | region_map | ) |
Sets the selected region map for area of interest on this input.
- Parameters
-
region_map The region map contains a 1 if the corresponding block is within the area of interest or a 0 if it is not included in the area of interest.
The first entry in the regionMap corresponds to the top left corner of the frame and the last entry corresponds to the bottom right corner, with the entries in between moving from left to right across the frame.
The supplied vector must be of size rows x columns.
- Returns
- True if the region map was accepted, false if it was rejected.
The documentation for this class was generated from the following file:
- SDKs/EdgeVisSDKCore/AreaOfInterestConfig.h