Detailed Description
Defines the bandwidth configuration to use for an encoder.
IMPORTANT: in the case of multi-stream encoders the bandwidth configuration is common between the streams. This means that modifying the bandwidth configuration for one video stream (corresponding to an Encoder object in the Decoder SDK) will also modify it for the other video streams (corresponding to other Encoder objects in the Decoder SDK) which are provided by the same physical encoder.
Availability
Available in version 7.4.0 of Decoder SDK. Requires a server version greater than 7.4
#include <BandwidthConfig.h>
Public Member Functions | |
| DB_EDGEVIS_SDK std::vector< std::wstring > | GetConnectionProfileNames () const |
| Get the list of connection profile names available. More... | |
| DB_EDGEVIS_SDK bool | GetConnectionProfile (const std::wstring &name, ConnectionProfile &profile) const |
| Get the specified connection profile. More... | |
| DB_EDGEVIS_SDK bool | GetConnectionProfiles (std::vector< ConnectionProfile > &profiles) const |
| Get the list of available connection profiles. More... | |
| DB_EDGEVIS_SDK bool | SetConnectionProfile (const ConnectionProfile &profile) |
| Set a connection profile. More... | |
| DB_EDGEVIS_SDK bool | SetConnectionProfiles (const std::vector< ConnectionProfile > &profiles) |
| Get the list of available connection profiles. More... | |
| DB_EDGEVIS_SDK int32_t | GetMinBandwidthPercentage () const |
| Get the minimum bandwidth for the all connection profiles as a percentage of the maximum bandwidth for each profile. More... | |
| DB_EDGEVIS_SDK bool | SetMinBandwidthPercentage (const int32_t percentage) |
| Set the minimum bandwidth for the all connection profiles as a percentage of the maximum bandwidth for each profile. More... | |
| DB_EDGEVIS_SDK bool | GetActiveConnectionProfile (ConnectionProfile &profile) const |
| Get the active connection profile. More... | |
Member Function Documentation
| DB_EDGEVIS_SDK std::vector<std::wstring> EdgeVisSDKCore::BandwidthConfig::GetConnectionProfileNames | ( | ) | const |
Get the list of connection profile names available.
- Returns
- A vector containing the names of the connection profiles that bandwidth config is available for.
| DB_EDGEVIS_SDK bool EdgeVisSDKCore::BandwidthConfig::GetConnectionProfile | ( | const std::wstring & | name, |
| ConnectionProfile & | profile | ||
| ) | const |
Get the specified connection profile.
- Parameters
-
name The name of the ConnectionProfile to retrieve. profile A ConnectionProfile object to be populated with the specified connection profile.
- Returns
- True if the specified profile was found, false otherwise.
| DB_EDGEVIS_SDK bool EdgeVisSDKCore::BandwidthConfig::GetConnectionProfiles | ( | std::vector< ConnectionProfile > & | profiles | ) | const |
Get the list of available connection profiles.
- Parameters
-
profiles A vector of ConnectionProfile objects to be populated with the connection profiles that bandwidth config is available for.
- Returns
- True if the specified profile was found, false otherwise.
| DB_EDGEVIS_SDK bool EdgeVisSDKCore::BandwidthConfig::SetConnectionProfile | ( | const ConnectionProfile & | profile | ) |
Set a connection profile.
- Parameters
-
profile The connection profile to apply to the BandwidthConfig
- Returns
- True if the connection profile was set successfully, false otherwise.
| DB_EDGEVIS_SDK bool EdgeVisSDKCore::BandwidthConfig::SetConnectionProfiles | ( | const std::vector< ConnectionProfile > & | profiles | ) |
Get the list of available connection profiles.
- Parameters
-
profiles A vector of ConnectionProfile objects to apply to the BandwidthConfig.
- Returns
- True if the connection profiles were set successfully, false otherwise.
| DB_EDGEVIS_SDK int32_t EdgeVisSDKCore::BandwidthConfig::GetMinBandwidthPercentage | ( | ) | const |
Get the minimum bandwidth for the all connection profiles as a percentage of the maximum bandwidth for each profile.
- Returns
- The percentage of the maximum bandwidth that is currently set as the minimum bandwidth for each connection profile. Note that if the connection profiles have different minimum bandwidth percentage values set then this method will return 0 and the individual ConnectionProfile object should be checked.
| DB_EDGEVIS_SDK bool EdgeVisSDKCore::BandwidthConfig::SetMinBandwidthPercentage | ( | const int32_t | percentage | ) |
Set the minimum bandwidth for the all connection profiles as a percentage of the maximum bandwidth for each profile.
- Parameters
-
percentage The percentage of the maximum bandwidth to set as the minimum bandwidth for each connection profile. NOTE: the permmitted percentage must be in the range of 10%-50% and supplied values will be rounded down to the nearest multiple of 5% in this range
- Returns
- True if the min bandwidth percentage value was accepted, false otherwise.
| DB_EDGEVIS_SDK bool EdgeVisSDKCore::BandwidthConfig::GetActiveConnectionProfile | ( | ConnectionProfile & | profile | ) | const |
Get the active connection profile.
- Parameters
-
profile A ConnectionProfile object to be populated with the active connection profile.
- Returns
- True if the active profile was found, false otherwise.
The documentation for this class was generated from the following file:
- SDKs/EdgeVisSDKCore/BandwidthConfig.h