Detailed Description
The CameraInfo interface contains the settings for a Camera connected to one of the Encoder's camera inputs.
The camera may be a PTZ (Pan Tilt Zoom) camera, in which case PTZ camera information and PTZ Presets will also be available.
Encoder camera settings include:
- Input ID (input the camera is connected to on the Encoder)
- Enabled (whether the input is enabled or disabled)
- PTZ Enabled (whether the camera supports PTZ or not)
- PTZ Camera Type (The type of PTZ Camera e.g. Pelco-D)
- PTZ Presets
A CameraInfo interface extends the EncoderSetting interface so it can be used to modify the Encoder's camera settings using the IEVSettingsModifier interface. The camera's PTZ Presets are the only camera setting that can be modified.
Availability
Available in version 6.0 of Decoder SDK. Requires a server version greater than 6.0
#include <CameraInfo.h>
Public Types | |
| typedef std::vector< PTZPresetInfo > | PTZPresetsList |
| List of PTZPresetInfo. | |
| typedef std::vector< PTZCustomCommand > | PTZCustomCommandList |
| List of Custom Commands. | |
Public Member Functions | |
| DB_EDGEVIS_SDK int32_t | InputId () const |
| Gets the camera input ID for the camera. More... | |
| DB_EDGEVIS_SDK bool | Enabled () const |
| Gets the Enabled state of the camera input. More... | |
| DB_EDGEVIS_SDK bool | PTZEnabled () const |
| Determines if the camera input supports PTZ. More... | |
| DB_EDGEVIS_SDK std::wstring | PTZCameraType () const |
| Gets the PTZ camera type (e.g. More... | |
| DB_EDGEVIS_SDK int32_t | MaxPTZPresets () const |
| Gets the maximum number of PTZ presets that the camera supports. More... | |
| DB_EDGEVIS_SDK PTZPresetsList | PTZPresets () const |
| Gets a list of PTZ presets for the camera. More... | |
| DB_EDGEVIS_SDK PTZCustomCommandList | PTZCustomCommands () const |
| Gets a list of available PTZ custom commands he camera supports. More... | |
| DB_EDGEVIS_SDK bool | IsVirtualInput () const |
| Determines if the camera input is a virtual input. More... | |
| DB_EDGEVIS_SDK bool | AnalyticsEnabled () const |
| Determines if the camera input has analytics enabled. More... | |
| DB_EDGEVIS_SDK std::wstring | InputName () const |
| Gets the camera input name for the camera. More... | |
| virtual DB_EDGEVIS_SDK std::wstring | Name () const |
| Gets the name of the settings object. More... | |
Member Function Documentation
| DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::CameraInfo::InputId | ( | ) | const |
Gets the camera input ID for the camera.
- Returns
- Input ID for the camera.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::CameraInfo::Enabled | ( | ) | const |
Gets the Enabled state of the camera input.
- Returns
- true if the camera input is enabled, false if it is disabled.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::CameraInfo::PTZEnabled | ( | ) | const |
Determines if the camera input supports PTZ.
- Returns
- true if PTZ supported, false if PTZ not supported.
| DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::CameraInfo::PTZCameraType | ( | ) | const |
Gets the PTZ camera type (e.g.
Pelco-D). If the camera is not a PTZ camera then this will be a blank string.
- Returns
- The PTZ camera type. Blank string if the camera is not a PTZ camera.
| DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::CameraInfo::MaxPTZPresets | ( | ) | const |
Gets the maximum number of PTZ presets that the camera supports.
If the camera is not a PTZ camera then this will return 0.
- Returns
- The maximum number of PTZ presets that the camera supports. 0 if the camera is not a PTZ camera.
| DB_EDGEVIS_SDK PTZPresetsList EdgeVisDecoderSDK::CameraInfo::PTZPresets | ( | ) | const |
Gets a list of PTZ presets for the camera.
- Returns
- List of PTZ presets for the camera. If the camera is not a PTZ camera then this list will be empty.
| DB_EDGEVIS_SDK PTZCustomCommandList EdgeVisDecoderSDK::CameraInfo::PTZCustomCommands | ( | ) | const |
Gets a list of available PTZ custom commands he camera supports.
- Returns
- List of PTZ custom commands the camera supports
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::CameraInfo::IsVirtualInput | ( | ) | const |
Determines if the camera input is a virtual input.
- Returns
- true if this input is a quad or PIP input, false if it is a physical input.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::CameraInfo::AnalyticsEnabled | ( | ) | const |
Determines if the camera input has analytics enabled.
- Returns
- true if this input has analytics enabled, false if it does not.
| DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::CameraInfo::InputName | ( | ) | const |
Gets the camera input name for the camera.
- Returns
- Input name for the camera.
|
virtual |
Gets the name of the settings object.
The settings object will have a unique name.
- Returns
- The name of the settings object..
Implements EdgeVisDecoderSDK::ISettings.
The documentation for this class was generated from the following file:
- SDKs/EdgeVisDecoderSDK/CameraInfo.h