EdgeVisEncoderSDK::CameraProfile Class Reference
Detailed Description
The camera profiles describe the cameras attached to this encoder.
This information is shown to the viewing user, allowing them to select a camera to stream.
Availability
Available in version 6.5 of Encoder SDK. Requires a server version greater than 6.5
#include <CameraProfile.h>
Public Member Functions | |
| DB_EDGEVIS_SDK | CameraProfile (std::wstring inputName, int8_t inputID, bool enabled, bool ptzEnabled, std::wstring ptzProtocol, int8_t ptzAddress) |
| Constructor for a CameraProfile. More... | |
| DB_EDGEVIS_SDK std::wstring | InputName () const |
| Returns the name of this input. More... | |
| DB_EDGEVIS_SDK int8_t | InputID () const |
| Returns the input number of this camera. More... | |
| DB_EDGEVIS_SDK bool | Enabled () const |
| Returns enabled state of this input. More... | |
| DB_EDGEVIS_SDK bool | PTZEnabled () const |
| Returns PTZ enabled state of this input. More... | |
| DB_EDGEVIS_SDK std::wstring | PTZProtocol () const |
| Returns the name of the PTZ Protocol. More... | |
| DB_EDGEVIS_SDK int8_t | PTZAddress () const |
| Returns the address of the PTZ camera. More... | |
Constructor & Destructor Documentation
| DB_EDGEVIS_SDK EdgeVisEncoderSDK::CameraProfile::CameraProfile | ( | std::wstring | inputName, |
| int8_t | inputID, | ||
| bool | enabled, | ||
| bool | ptzEnabled, | ||
| std::wstring | ptzProtocol, | ||
| int8_t | ptzAddress | ||
| ) |
Constructor for a CameraProfile.
- Parameters
-
inputName A string describing the input. This is displayed in the viewing client inputID The number of the input. This should be a zero based index enabled Is this input enabled. If disabled the user can not select it ptzEnabled Does this input have a PTZ camera attached ptzProtocol What PTZ protocol does this camera support ptzAddress What is the address of the PTZ camera
- Returns
- A CameraProfile object
Member Function Documentation
| DB_EDGEVIS_SDK std::wstring EdgeVisEncoderSDK::CameraProfile::InputName | ( | ) | const |
Returns the name of this input.
- Returns
- The camera input name
| DB_EDGEVIS_SDK int8_t EdgeVisEncoderSDK::CameraProfile::InputID | ( | ) | const |
Returns the input number of this camera.
- Returns
- The camera input id
| DB_EDGEVIS_SDK bool EdgeVisEncoderSDK::CameraProfile::Enabled | ( | ) | const |
Returns enabled state of this input.
- Returns
- True if the camera is enabled
| DB_EDGEVIS_SDK bool EdgeVisEncoderSDK::CameraProfile::PTZEnabled | ( | ) | const |
Returns PTZ enabled state of this input.
- Returns
- True if this camera has PTZ enabled
| DB_EDGEVIS_SDK std::wstring EdgeVisEncoderSDK::CameraProfile::PTZProtocol | ( | ) | const |
Returns the name of the PTZ Protocol.
- Returns
- The name of the camera protocol in use
| DB_EDGEVIS_SDK int8_t EdgeVisEncoderSDK::CameraProfile::PTZAddress | ( | ) | const |
Returns the address of the PTZ camera.
- Returns
- The camera PTZ address
The documentation for this class was generated from the following file:
- SDKs/EdgeVisEncoderSDK/CameraProfile.h