EdgeVisDecoderSDK::OnvifTopic Class Reference
Detailed Description
Contains information relating to Onvif Event Topics.
Produces ONVIF XML
Availability
Available in version 8.3.0 of Decoder SDK. Requires a server version greater than 6.5
#include <OnvifTopic.h>
Public Member Functions | |
| DB_EDGEVIS_SDK std::wstring | GetTopic () const |
| Returns the ONVIF event topic. More... | |
| DB_EDGEVIS_SDK std::vector< std::pair< std::wstring, std::wstring > > | GetSourceDescriptions () const |
| Returns the list of source descriptions associated with this topic. More... | |
| DB_EDGEVIS_SDK std::vector< std::pair< std::wstring, std::wstring > > | GetKeyDescriptions () const |
| Returns the list of key descriptions associated with this topic. More... | |
| DB_EDGEVIS_SDK std::vector< std::pair< std::wstring, std::wstring > > | GetDataDescriptions () const |
| Returns the list of data descriptions associated with this topic. More... | |
| DB_EDGEVIS_SDK bool | IsProperty () const |
| Is this topic a property. More... | |
Static Public Member Functions | |
| static DB_EDGEVIS_SDK std::vector< OnvifTopic > | GetOnvifEventTopics () |
| Returns the ONVIF event topic. More... | |
| static DB_EDGEVIS_SDK std::wstring | GetEventPropertiesResponseXML (const std::vector< OnvifTopic > &topics) |
| Build an ONVIF GetEventProperties XML response for the list of topics supplied. More... | |
Member Function Documentation
| DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::OnvifTopic::GetTopic | ( | ) | const |
Returns the ONVIF event topic.
- Returns
- The string representation of the topic.
|
static |
Returns the ONVIF event topic.
- Returns
- The string representation of the topic.
| DB_EDGEVIS_SDK std::vector<std::pair<std::wstring, std::wstring> > EdgeVisDecoderSDK::OnvifTopic::GetSourceDescriptions | ( | ) | const |
Returns the list of source descriptions associated with this topic.
- Returns
- The list of name value pair source descriptions for this topic.
| DB_EDGEVIS_SDK std::vector<std::pair<std::wstring, std::wstring> > EdgeVisDecoderSDK::OnvifTopic::GetKeyDescriptions | ( | ) | const |
Returns the list of key descriptions associated with this topic.
- Returns
- The list of name value pair key descriptions for this topic.
| DB_EDGEVIS_SDK std::vector<std::pair<std::wstring, std::wstring> > EdgeVisDecoderSDK::OnvifTopic::GetDataDescriptions | ( | ) | const |
Returns the list of data descriptions associated with this topic.
- Returns
- The list of name value pair data descriptions for this topic.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::OnvifTopic::IsProperty | ( | ) | const |
Is this topic a property.
- Returns
- true if the topic is a property.
|
static |
Build an ONVIF GetEventProperties XML response for the list of topics supplied.
- Parameters
-
topics The list of ONVIF topics to include in the generated XML
- Returns
- An XML string representing a suitable reponse for an ONVIF GetEventProperties request.
The documentation for this class was generated from the following file:
- SDKs/EdgeVisDecoderSDK/OnvifTopic.h
