EdgeVisSDKCore::ConnectionProfile Class Reference
Detailed Description
Availability
Available in version 7.4.0 of Decoder SDK. Requires a server version greater than 7.4
#include <ConnectionProfile.h>
Public Member Functions | |
| DB_EDGEVIS_SDK std::wstring | GetName () const |
| Get the name of the connection profile. More... | |
| DB_EDGEVIS_SDK int32_t | GetMinBandwidth () const |
| Get the minimum bandwidth for the connection profile. More... | |
| DB_EDGEVIS_SDK int32_t | GetMaxBandwidth () const |
| Get the maximum bandwidth for the connection profile. More... | |
| DB_EDGEVIS_SDK int32_t | GetChannelCapacity () const |
| Get the channel bandwidth capacity for the connection profile. More... | |
| DB_EDGEVIS_SDK int32_t | GetMinBandwidthPercentage () const |
| Get the minimum bandwidth for the connection profile as a percentage of the maximum bandwidth. More... | |
| DB_EDGEVIS_SDK bool | SetMaxBandwidth (const int32_t max_bw) |
| Set the maximum bandwidth for the connection profile. More... | |
| DB_EDGEVIS_SDK bool | SetMinBandwidthPercentage (const int32_t percentage) |
| Set the minimum bandwidth for the connection profile as a percentage of the maximum bandwidth. More... | |
| DB_EDGEVIS_SDK bool | SetChannelCapacity (const int32_t capacity) |
| Set the channel bandwidth capacity for the connection profile. More... | |
| DB_EDGEVIS_SDK bool | IsPrimaryConnectionProfile () const |
| Determine if this connection profile is the primary connection profile for the encoder. More... | |
| DB_EDGEVIS_SDK bool | IsBackupConnectionProfile () const |
| Determine if this connection profile is the backup connection profile for the encoder. More... | |
| DB_EDGEVIS_SDK bool | IsActiveConnectionProfile () const |
| Determine if this connection profile is the active connection profile for the encoder. More... | |
| DB_EDGEVIS_SDK std::wstring | GetActiveConnectionTechnology () const |
| Determine the active connection technology for this connection profile. More... | |
| DB_EDGEVIS_SDK std::wstring | GetActiveConnectionMethod () const |
| Determine the active connection method for this connection profile. More... | |
Member Function Documentation
| DB_EDGEVIS_SDK std::wstring EdgeVisSDKCore::ConnectionProfile::GetName | ( | ) | const |
Get the name of the connection profile.
- Returns
- The name for this connection profile. This may be LAN, Wi-fi or Mobile.
| DB_EDGEVIS_SDK int32_t EdgeVisSDKCore::ConnectionProfile::GetMinBandwidth | ( | ) | const |
Get the minimum bandwidth for the connection profile.
- Returns
- The minimum bandwidth for the given profile in bps.
| DB_EDGEVIS_SDK int32_t EdgeVisSDKCore::ConnectionProfile::GetMaxBandwidth | ( | ) | const |
Get the maximum bandwidth for the connection profile.
- Returns
- The maximum bandwidth for the given profile in bps.
| DB_EDGEVIS_SDK int32_t EdgeVisSDKCore::ConnectionProfile::GetChannelCapacity | ( | ) | const |
Get the channel bandwidth capacity for the connection profile.
- Returns
- The bandwidth capacity for the given profile in bps.
| DB_EDGEVIS_SDK int32_t EdgeVisSDKCore::ConnectionProfile::GetMinBandwidthPercentage | ( | ) | const |
Get the minimum bandwidth for the connection profile as a percentage of the maximum bandwidth.
- Returns
- The minimum bandwidth for the given profile as a percentage of the maximum bandwidth.
| DB_EDGEVIS_SDK bool EdgeVisSDKCore::ConnectionProfile::SetMaxBandwidth | ( | const int32_t | max_bw | ) |
Set the maximum bandwidth for the connection profile.
- Parameters
-
max_bw The new maximum bandwidth in bps.
- Returns
- True if the max bandwidth value was accepted, false otherwise.
| DB_EDGEVIS_SDK bool EdgeVisSDKCore::ConnectionProfile::SetMinBandwidthPercentage | ( | const int32_t | percentage | ) |
Set the minimum bandwidth for the connection profile as a percentage of the maximum bandwidth.
- Parameters
-
percentage The percentage of the maximum bandwidth to set as the minimum bandwidth for the specified 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::ConnectionProfile::SetChannelCapacity | ( | const int32_t | capacity | ) |
Set the channel bandwidth capacity for the connection profile.
- Returns
- The bandwidth capacity for the given profile in bps.
| DB_EDGEVIS_SDK bool EdgeVisSDKCore::ConnectionProfile::IsPrimaryConnectionProfile | ( | ) | const |
Determine if this connection profile is the primary connection profile for the encoder.
- Returns
- True if this connection profile is the primary connection profile for the encoder, false otherwise.
| DB_EDGEVIS_SDK bool EdgeVisSDKCore::ConnectionProfile::IsBackupConnectionProfile | ( | ) | const |
Determine if this connection profile is the backup connection profile for the encoder.
- Returns
- True if this connection profile is the backup connection profile for the encoder, false otherwise.
| DB_EDGEVIS_SDK bool EdgeVisSDKCore::ConnectionProfile::IsActiveConnectionProfile | ( | ) | const |
Determine if this connection profile is the active connection profile for the encoder.
- Returns
- True if this connection profile is the active connection profile for the encoder, false otherwise.
| DB_EDGEVIS_SDK std::wstring EdgeVisSDKCore::ConnectionProfile::GetActiveConnectionTechnology | ( | ) | const |
Determine the active connection technology for this connection profile.
- Returns
- The technology in use for this connection profile. If this connection profile is not active an empty string will be returned.
| DB_EDGEVIS_SDK std::wstring EdgeVisSDKCore::ConnectionProfile::GetActiveConnectionMethod | ( | ) | const |
Determine the active connection method for this connection profile.
- Returns
- The method in use for this connection profile. If this connection profile is not active an empty string will be returned.
The documentation for this class was generated from the following file:
- SDKs/EdgeVisSDKCore/ConnectionProfile.h