Detailed Description
Holds the current status of the server.
Availability
Available in version 6.0 of Decoder SDK. Requires a server version greater than 6.0
#include <ServerInfo.h>
Public Member Functions | |
| DB_EDGEVIS_SDK std::wstring | Address () const |
| Returns the address of the server. More... | |
| DB_EDGEVIS_SDK std::wstring | Name () const |
| Returns the name of the server. More... | |
| DB_EDGEVIS_SDK std::wstring | Version () const |
| The version number of the server. More... | |
| DB_EDGEVIS_SDK std::wstring | UniqueID () const |
| The unique ID of the server. More... | |
| DB_EDGEVIS_SDK OpResult | GetResult () const |
| Gets the result that was set when the info was populated. More... | |
| DB_EDGEVIS_SDK bool | HasClientCamsFeature () const |
| Check if this server supports CAMS rule builder in client applications. More... | |
| DB_EDGEVIS_SDK bool | HasDevicePasswordFeature () const |
| Check if this server supports the device password feature. More... | |
| DB_EDGEVIS_SDK std::wstring | GetServerBaseURL () const |
| Retrieve the base URL for the server's web pages. More... | |
| DB_EDGEVIS_SDK std::vector< int32_t > | SupportedStreamProfileAPILevels () const |
| Check the stream profile API levels supported on this server. More... | |
Member Function Documentation
| DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::ServerInfo::Address | ( | ) | const |
Returns the address of the server.
- Returns
- The server address.
| DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::ServerInfo::Name | ( | ) | const |
Returns the name of the server.
- Returns
- The server name
| DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::ServerInfo::Version | ( | ) | const |
The version number of the server.
- Returns
- The server version
| DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::ServerInfo::UniqueID | ( | ) | const |
The unique ID of the server.
This is a UUID that will not change on the server
- Returns
- The server UUID
| DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::ServerInfo::GetResult | ( | ) | const |
Gets the result that was set when the info was populated.
This can be used to determine if the information was obtained successfully or not.
- Returns
- OpResult containing the result of querying the information from the server. This will be set to OR_Success if the information was successfully populated. If it's OR_InvalidService, m_pimpl is nil. Programmer error.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::ServerInfo::HasClientCamsFeature | ( | ) | const |
Check if this server supports CAMS rule builder in client applications.
Supported by server version 7.2.0 and later.
- Returns
- True if the server has reported that it has the client CAMS feature, false otherwise.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::ServerInfo::HasDevicePasswordFeature | ( | ) | const |
Check if this server supports the device password feature.
- Returns
- True if the server has reported that it has the device password feature, false otherwise.
| DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::ServerInfo::GetServerBaseURL | ( | ) | const |
Retrieve the base URL for the server's web pages.
- Returns
- A string containing the base URL for the server's web pages.
| DB_EDGEVIS_SDK std::vector<int32_t> EdgeVisDecoderSDK::ServerInfo::SupportedStreamProfileAPILevels | ( | ) | const |
Check the stream profile API levels supported on this server.
- Returns
- A list of supported stream API levels. The following values may be present in the list: 1 - indicates that the original stream config API is supported (EncoderProfile) 2 - indicates that the multi-stream config API is supported (StreamConfig)
The documentation for this class was generated from the following file:
- SDKs/EdgeVisDecoderSDK/ServerInfo.h